rename PlacerContext to PlacerState

Author: soheilshahrouz

vpr/src/base/read_place.h

@@ -6,7 +6,7 @@
 #include <string>
 
 
-class PlacerContext;
+class PlacerState;
 class ClusterBlockId;
 struct t_block_loc;
 

vpr/src/place/RL_agent_util.cpp

@@ -2,7 +2,7 @@
 #include "static_move_generator.h"
 #include "manual_move_generator.h"
 
-std::pair<std::unique_ptr<MoveGenerator>, std::unique_ptr<MoveGenerator>> create_move_generators(PlacerContext& placer_ctx,
+std::pair<std::unique_ptr<MoveGenerator>, std::unique_ptr<MoveGenerator>> create_move_generators(PlacerState& placer_state,
                                                                                                  const t_placer_opts& placer_opts,
                                                                                                  int move_lim,
                                                                                                  double noc_attraction_weight) {
@@ -20,8 +20,8 @@ std::pair<std::unique_ptr<MoveGenerator>, std::unique_ptr<MoveGenerator>> create
                     move_name.c_str(),
                     placer_opts.place_static_move_prob[move_type]);
         }
-        move_generators.first = std::make_unique<StaticMoveGenerator>(placer_ctx, placer_opts.place_static_move_prob);
-        move_generators.second = std::make_unique<StaticMoveGenerator>(placer_ctx, placer_opts.place_static_move_prob);
+        move_generators.first = std::make_unique<StaticMoveGenerator>(placer_state, placer_opts.place_static_move_prob);
+        move_generators.second = std::make_unique<StaticMoveGenerator>(placer_state, placer_opts.place_static_move_prob);
     } else { //RL based placement
         /* For the non timing driven placement: the agent has a single state   *
          *     - Available moves are (Uniform / Median / Centroid)             *
@@ -73,7 +73,7 @@ std::pair<std::unique_ptr<MoveGenerator>, std::unique_ptr<MoveGenerator>> create
                                                                             placer_opts.place_agent_epsilon);
             }
             karmed_bandit_agent1->set_step(placer_opts.place_agent_gamma, move_lim);
-            move_generators.first = std::make_unique<SimpleRLMoveGenerator>(placer_ctx,
+            move_generators.first = std::make_unique<SimpleRLMoveGenerator>(placer_state,
                                                                             karmed_bandit_agent1,
                                                                             noc_attraction_weight,
                                                                             placer_opts.place_high_fanout_net);
@@ -82,7 +82,7 @@ std::pair<std::unique_ptr<MoveGenerator>, std::unique_ptr<MoveGenerator>> create
                                                                         e_agent_space::MOVE_TYPE,
                                                                         placer_opts.place_agent_epsilon);
             karmed_bandit_agent2->set_step(placer_opts.place_agent_gamma, move_lim);
-            move_generators.second = std::make_unique<SimpleRLMoveGenerator>(placer_ctx,
+            move_generators.second = std::make_unique<SimpleRLMoveGenerator>(placer_state,
                                                                              karmed_bandit_agent2,
                                                                              noc_attraction_weight,
                                                                              placer_opts.place_high_fanout_net);
@@ -99,15 +99,15 @@ std::pair<std::unique_ptr<MoveGenerator>, std::unique_ptr<MoveGenerator>> create
                                                                       e_agent_space::MOVE_TYPE);
             }
             karmed_bandit_agent1->set_step(placer_opts.place_agent_gamma, move_lim);
-            move_generators.first = std::make_unique<SimpleRLMoveGenerator>(placer_ctx,
+            move_generators.first = std::make_unique<SimpleRLMoveGenerator>(placer_state,
                                                                             karmed_bandit_agent1,
                                                                             noc_attraction_weight,
                                                                             placer_opts.place_high_fanout_net);
             //agent's 2nd state
             karmed_bandit_agent2 = std::make_unique<SoftmaxAgent>(second_state_avail_moves,
                                                                   e_agent_space::MOVE_TYPE);
             karmed_bandit_agent2->set_step(placer_opts.place_agent_gamma, move_lim);
-            move_generators.second = std::make_unique<SimpleRLMoveGenerator>(placer_ctx,
+            move_generators.second = std::make_unique<SimpleRLMoveGenerator>(placer_state,
                                                                              karmed_bandit_agent2,
                                                                              noc_attraction_weight,
                                                                              placer_opts.place_high_fanout_net);

vpr/src/place/RL_agent_util.h

@@ -16,7 +16,7 @@ enum class e_agent_state {
  * type selected in placer_opts.
  * It returns a unique pointer for each move generator in move_generator and move_generator2
  *
- * @param placer_ctx Move generators store a reference to the placer context to avoid global state access.
+ * @param placer_state Move generators store a reference to the placer context to avoid global state access.
  * @param placer_opts Contains information about the placement algorithm and its parameters.
  * @param move_lim represents the num of moves per temp.
  * @param noc_attraction_weight The attraction weight by which the NoC-biased centroid move adjust the computed location
@@ -26,7 +26,7 @@ enum class e_agent_state {
  * in the first and second states of the agent.
  *
  */
-std::pair<std::unique_ptr<MoveGenerator>, std::unique_ptr<MoveGenerator>> create_move_generators(PlacerContext& placer_ctx,
+std::pair<std::unique_ptr<MoveGenerator>, std::unique_ptr<MoveGenerator>> create_move_generators(PlacerState& placer_state,
                                                                                                  const t_placer_opts& placer_opts,
                                                                                                  int move_lim,
                                                                                                  double noc_attraction_weight);

vpr/src/place/centroid_move_generator.cpp

@@ -16,15 +16,15 @@ vtr::vector<ClusterBlockId, NocGroupId> CentroidMoveGenerator::cluster_to_noc_gr
 std::map<ClusterBlockId, NocGroupId> CentroidMoveGenerator::noc_router_to_noc_group_;
 
 
-CentroidMoveGenerator::CentroidMoveGenerator(PlacerContext& placer_ctx)
-    : MoveGenerator(placer_ctx)
+CentroidMoveGenerator::CentroidMoveGenerator(PlacerState& placer_state)
+    : MoveGenerator(placer_state)
     , noc_attraction_w_(0.0f)
     , noc_attraction_enabled_(false) {}
 
-CentroidMoveGenerator::CentroidMoveGenerator(PlacerContext& placer_ctx,
+CentroidMoveGenerator::CentroidMoveGenerator(PlacerState& placer_state,
                                              float noc_attraction_weight,
                                              size_t high_fanout_net)
-    : MoveGenerator(placer_ctx)
+    : MoveGenerator(placer_state)
     , noc_attraction_w_(noc_attraction_weight)
     , noc_attraction_enabled_(true) {
     VTR_ASSERT(noc_attraction_weight > 0.0 && noc_attraction_weight <= 1.0);
@@ -44,20 +44,20 @@ e_create_move CentroidMoveGenerator::propose_move(t_pl_blocks_to_be_moved& block
                                                   float rlim,
                                                   const t_placer_opts& placer_opts,
                                                   const PlacerCriticalities* /*criticalities*/) {
-    auto& placer_ctx = placer_ctx_.get();
-    const auto& block_locs = placer_ctx.block_locs();
+    auto& placer_state = placer_state_.get();
+    const auto& block_locs = placer_state.block_locs();
     const auto& device_ctx = g_vpr_ctx.device();
     const auto& cluster_ctx = g_vpr_ctx.clustering();
-    const auto& place_move_ctx = placer_ctx.move();
-    const auto& blk_loc_registry = placer_ctx.blk_loc_registry();
+    const auto& place_move_ctx = placer_state.move();
+    const auto& blk_loc_registry = placer_state.blk_loc_registry();
 
     // Find a movable block based on blk_type
     ClusterBlockId b_from = propose_block_to_move(placer_opts,
                                                   proposed_action.logical_blk_type_index,
                                                   /*highly_crit_block=*/false,
                                                   /*net_from=*/nullptr,
                                                   /*pin_from=*/nullptr,
-                                                  placer_ctx);
+                                                  placer_state);
 
     VTR_LOGV_DEBUG(g_vpr_ctx.placement().f_placer_debug,
                    "Centroid Move Choose Block %d - rlim %f\n",

vpr/src/place/centroid_move_generator.h

@@ -24,7 +24,7 @@ class CentroidMoveGenerator : public MoveGenerator {
      * The move generator created by calling this constructor only consider
      * netlist connectivity for computing the centroid location.
      */
-    explicit CentroidMoveGenerator(PlacerContext& placer_ctx);
+    explicit CentroidMoveGenerator(PlacerState& placer_state);
 
     /**
      * The move generator created by calling this constructor considers both
@@ -39,7 +39,7 @@ class CentroidMoveGenerator : public MoveGenerator {
      * @param high_fanout_net All nets with a fanout larger than this number are
      * ignored when forming NoC groups.
      */
-    CentroidMoveGenerator(PlacerContext& placer_ctx,
+    CentroidMoveGenerator(PlacerState& placer_state,
                           float noc_attraction_weight,
                           size_t high_fanout_net);
 

vpr/src/place/critical_uniform_move_generator.cpp

@@ -4,18 +4,18 @@
 #include "placer_state.h"
 #include "move_utils.h"
 
-CriticalUniformMoveGenerator::CriticalUniformMoveGenerator(PlacerContext& placer_ctx)
-    : MoveGenerator(placer_ctx) {}
+CriticalUniformMoveGenerator::CriticalUniformMoveGenerator(PlacerState& placer_state)
+    : MoveGenerator(placer_state) {}
 
 e_create_move CriticalUniformMoveGenerator::propose_move(t_pl_blocks_to_be_moved& blocks_affected,
                                                          t_propose_action& proposed_action,
                                                          float rlim,
                                                          const t_placer_opts& placer_opts,
                                                          const PlacerCriticalities* /*criticalities*/) {
     auto& cluster_ctx = g_vpr_ctx.clustering();
-    const auto& placer_ctx = placer_ctx_.get();
-    const auto& block_locs = placer_ctx.block_locs();
-    const auto& blk_loc_registry = placer_ctx.blk_loc_registry();
+    const auto& placer_state = placer_state_.get();
+    const auto& block_locs = placer_state.block_locs();
+    const auto& blk_loc_registry = placer_state.blk_loc_registry();
 
     ClusterNetId net_from;
     int pin_from;
@@ -25,7 +25,7 @@ e_create_move CriticalUniformMoveGenerator::propose_move(t_pl_blocks_to_be_moved
                                                   /*highly_crit_block=*/true,
                                                   &net_from,
                                                   &pin_from,
-                                                  placer_ctx);
+                                                  placer_state);
 
     VTR_LOGV_DEBUG(g_vpr_ctx.placement().f_placer_debug, "Critical Uniform Move Choose Block %d - rlim %f\n", size_t(b_from), rlim);
 

vpr/src/place/critical_uniform_move_generator.h

@@ -17,7 +17,7 @@
 class CriticalUniformMoveGenerator : public MoveGenerator {
   public:
     CriticalUniformMoveGenerator() = delete;
-    explicit CriticalUniformMoveGenerator(PlacerContext& placer_ctx);
+    explicit CriticalUniformMoveGenerator(PlacerState& placer_state);
 
   private:
     e_create_move propose_move(t_pl_blocks_to_be_moved& blocks_affected,

vpr/src/place/feasible_region_move_generator.cpp

@@ -8,19 +8,19 @@
 #include <algorithm>
 #include <cmath>
 
-FeasibleRegionMoveGenerator::FeasibleRegionMoveGenerator(PlacerContext& placer_ctx)
-    : MoveGenerator(placer_ctx) {}
+FeasibleRegionMoveGenerator::FeasibleRegionMoveGenerator(PlacerState& placer_state)
+    : MoveGenerator(placer_state) {}
 
 e_create_move FeasibleRegionMoveGenerator::propose_move(t_pl_blocks_to_be_moved& blocks_affected,
                                                         t_propose_action& proposed_action,
                                                         float rlim,
                                                         const t_placer_opts& placer_opts,
                                                         const PlacerCriticalities* criticalities) {
     const auto& cluster_ctx = g_vpr_ctx.clustering();
-    auto& placer_ctx = placer_ctx_.get();
-    auto& place_move_ctx = placer_ctx.mutable_move();
-    const auto& block_locs = placer_ctx.block_locs();
-    const auto& blk_loc_registry = placer_ctx.blk_loc_registry();
+    auto& placer_state = placer_state_.get();
+    auto& place_move_ctx = placer_state.mutable_move();
+    const auto& block_locs = placer_state.block_locs();
+    const auto& blk_loc_registry = placer_state.blk_loc_registry();
 
     ClusterNetId net_from;
     int pin_from;
@@ -30,7 +30,7 @@ e_create_move FeasibleRegionMoveGenerator::propose_move(t_pl_blocks_to_be_moved&
                                                   /*highly_crit_block=*/true,
                                                   &net_from,
                                                   &pin_from,
-                                                  placer_ctx);
+                                                  placer_state);
 
     VTR_LOGV_DEBUG(g_vpr_ctx.placement().f_placer_debug, "Feasible Region Move Choose Block %di - rlim %f\n", size_t(b_from), rlim);
 

vpr/src/place/feasible_region_move_generator.h

@@ -21,7 +21,7 @@
 class FeasibleRegionMoveGenerator : public MoveGenerator {
   public:
     FeasibleRegionMoveGenerator() = delete;
-    explicit FeasibleRegionMoveGenerator(PlacerContext& placer_ctx);
+    explicit FeasibleRegionMoveGenerator(PlacerState& placer_state);
 
   private:
     e_create_move propose_move(t_pl_blocks_to_be_moved& blocks_affected,

vpr/src/place/manual_move_generator.cpp

@@ -18,8 +18,8 @@
 #    include "draw.h"
 #endif //NO_GRAPHICS
 
-ManualMoveGenerator::ManualMoveGenerator(PlacerContext& placer_ctx)
-    : MoveGenerator(placer_ctx) {}
+ManualMoveGenerator::ManualMoveGenerator(PlacerState& placer_state)
+    : MoveGenerator(placer_state) {}
 
 //Manual Move Generator function
 e_create_move ManualMoveGenerator::propose_move(t_pl_blocks_to_be_moved& blocks_affected,
@@ -30,7 +30,7 @@ e_create_move ManualMoveGenerator::propose_move(t_pl_blocks_to_be_moved& blocks_
     auto& place_ctx = g_vpr_ctx.placement();
     auto& cluster_ctx = g_vpr_ctx.clustering();
     auto& device_ctx = g_vpr_ctx.device();
-    auto& block_locs = placer_ctx_.get().block_locs();
+    auto& block_locs = placer_state_.get().block_locs();
 
     int block_id = -1;
     t_pl_loc to;

vpr/src/place/manual_move_generator.h

@@ -27,7 +27,7 @@
 class ManualMoveGenerator : public MoveGenerator {
   public:
     ManualMoveGenerator() = delete;
-    explicit ManualMoveGenerator(PlacerContext& placer_ctx);
+    explicit ManualMoveGenerator(PlacerState& placer_state);
 
     //Evaluates if move is successful and legal or unable to do.
     e_create_move propose_move(t_pl_blocks_to_be_moved& blocks_affected,

vpr/src/place/median_move_generator.cpp

@@ -7,8 +7,8 @@
 
 #include <algorithm>
 
-MedianMoveGenerator::MedianMoveGenerator(PlacerContext& placer_ctx)
-    : MoveGenerator(placer_ctx) {}
+MedianMoveGenerator::MedianMoveGenerator(PlacerState& placer_state)
+    : MoveGenerator(placer_state) {}
 
 e_create_move MedianMoveGenerator::propose_move(t_pl_blocks_to_be_moved& blocks_affected,
                                                 t_propose_action& proposed_action,
@@ -17,18 +17,18 @@ e_create_move MedianMoveGenerator::propose_move(t_pl_blocks_to_be_moved& blocks_
                                                 const PlacerCriticalities* /*criticalities*/) {
     const auto& cluster_ctx = g_vpr_ctx.clustering();
     const auto& device_ctx = g_vpr_ctx.device();
-    auto& placer_ctx = placer_ctx_.get();
-    auto& place_move_ctx = placer_ctx.mutable_move();
-    const auto& block_locs = placer_ctx.block_locs();
-    const auto& blk_loc_registry = placer_ctx.blk_loc_registry();
+    auto& placer_state = placer_state_.get();
+    auto& place_move_ctx = placer_state.mutable_move();
+    const auto& block_locs = placer_state.block_locs();
+    const auto& blk_loc_registry = placer_state.blk_loc_registry();
 
     //Find a movable block based on blk_type
     ClusterBlockId b_from = propose_block_to_move(placer_opts,
                                                   proposed_action.logical_blk_type_index,
                                                   /*highly_crit_block=*/false,
                                                   /*net_from=*/nullptr,
                                                   /*pin_from=*/nullptr,
-                                                  placer_ctx);
+                                                  placer_state);
 
     VTR_LOGV_DEBUG(g_vpr_ctx.placement().f_placer_debug, "Median Move Choose Block %d - rlim %f\n", size_t(b_from), rlim);
 
@@ -201,8 +201,8 @@ void MedianMoveGenerator::get_bb_from_scratch_excluding_block(ClusterNetId net_i
                                                               ClusterBlockId block_id,
                                                               bool& skip_net) {
     //TODO: account for multiple physical pin instances per logical pin
-    const auto& placer_ctx = placer_ctx_.get();
-    const auto& block_locs = placer_ctx.block_locs();
+    const auto& placer_state = placer_state_.get();
+    const auto& block_locs = placer_state.block_locs();
 
     skip_net = true;
 
@@ -224,7 +224,7 @@ void MedianMoveGenerator::get_bb_from_scratch_excluding_block(ClusterNetId net_i
 
     if (bnum != block_id) {
         skip_net = false;
-        pnum = placer_ctx.blk_loc_registry().net_pin_to_tile_pin_index(net_id, 0);
+        pnum = placer_state.blk_loc_registry().net_pin_to_tile_pin_index(net_id, 0);
         const t_pl_loc& block_loc = block_locs[bnum].loc;
         int src_x = block_loc.x + physical_tile_type(block_loc)->pin_width_offset[pnum];
         int src_y = block_loc.y + physical_tile_type(block_loc)->pin_height_offset[pnum];
@@ -241,7 +241,7 @@ void MedianMoveGenerator::get_bb_from_scratch_excluding_block(ClusterNetId net_i
 
     for (ClusterPinId pin_id : cluster_ctx.clb_nlist.net_sinks(net_id)) {
         bnum = cluster_ctx.clb_nlist.pin_block(pin_id);
-        pnum = placer_ctx.blk_loc_registry().tile_pin_index(pin_id);
+        pnum = placer_state.blk_loc_registry().tile_pin_index(pin_id);
         if (bnum == block_id)
             continue;
         skip_net = false;
@@ -318,7 +318,7 @@ bool MedianMoveGenerator::get_bb_incrementally(ClusterNetId net_id,
     //TODO: account for multiple physical pin instances per logical pin
 
     auto& device_ctx = g_vpr_ctx.device();
-    auto& place_move_ctx = placer_ctx_.get().move();
+    auto& place_move_ctx = placer_state_.get().move();
 
     xnew = std::max(std::min<int>(xnew, device_ctx.grid.width() - 2), 1);  //-2 for no perim channels
     ynew = std::max(std::min<int>(ynew, device_ctx.grid.height() - 2), 1); //-2 for no perim channels

vpr/src/place/median_move_generator.h

@@ -18,7 +18,7 @@
 class MedianMoveGenerator : public MoveGenerator {
   public:
     MedianMoveGenerator() = delete;
-    explicit MedianMoveGenerator(PlacerContext& placer_ctx);
+    explicit MedianMoveGenerator(PlacerState& placer_state);
 
   private:
     e_create_move propose_move(t_pl_blocks_to_be_moved& blocks_affected,