Merge pull request #2044 from verilog-to-routing/re-cluster-comments

Re-clustering API (follow-up PR to address reviewers' comments)

Author: MohamedElgammal

vpr/src/pack/pack.cpp

@@ -48,9 +48,7 @@ bool try_pack(t_packer_opts* packer_opts,
     std::unordered_map<AtomBlockId, t_pb_graph_node*> expected_lowest_cost_pb_gnode; //The molecules associated with each atom block
     const t_model* cur_model;
     t_clustering_data clustering_data;
-    //int num_models;
     std::vector<t_pack_patterns> list_of_packing_patterns;
-    //std::unique_ptr<t_pack_molecule, decltype(&free_pack_molecules)> list_of_pack_molecules(nullptr, free_pack_molecules);
     VTR_LOG("Begin packing '%s'.\n", packer_opts->circuit_file_name.c_str());
 
     /* determine number of models in the architecture */

vpr/src/pack/prepack.cpp

@@ -931,7 +931,6 @@ static t_pack_molecule* try_create_molecule(t_pack_patterns* list_of_pack_patter
                                             AtomBlockId blk_id) {
     t_pack_molecule* molecule;
 
-    //auto& atom_ctx = g_vpr_ctx.atom();
     auto& atom_mutable_ctx = g_vpr_ctx.mutable_atom();
 
     auto pack_pattern = &list_of_pack_patterns[pack_pattern_index];

vpr/src/pack/prepack.h

@@ -19,6 +19,4 @@ t_pack_molecule* alloc_and_load_pack_molecules(t_pack_patterns* list_of_pack_pat
                                                std::unordered_map<AtomBlockId, t_pb_graph_node*>& expected_lowest_cost_pb_gnode,
                                                const int num_packing_patterns);
 
-//void free_pack_molecules(t_pack_molecule* list_of_pack_molecules);
-
 #endif

vpr/src/pack/re_cluster_util.h

@@ -9,9 +9,12 @@
 #include "cluster_util.h"
 /**
  * @file
- * @brief This files defines some helper functions for the re-clustering
+ * @brief This files defines some helper functions for the re-clustering API
  *
- * API that uses to move atoms between clusters after the cluster is done.
+ * Re-clustering API is used to move atoms between clusters after the cluster is done.
+ * This can be very used in iteratively improve the packed solution after the initial clustering is done.
+ * It can also be used during placement to allow fine-grained moves that can move a BLE or a single FF/LUT.
+ * 
  * Note: Some of the helper functions defined here might be useful in different places in VPR.
  * 
  */

vpr/src/place/place.cpp

@@ -1064,14 +1064,6 @@ static void placement_inner_loop(const t_annealing_state* state,
                                              blocks_affected, delay_model, criticalities, setup_slacks,
                                              placer_opts, move_type_stat, place_algorithm, timing_bb_factor, manual_move_enabled);
 
-        /*
-         * ClusterBlockId cluster = blocks_affected.moved_blocks[0].block_num;
-         * std::vector<AtomBlockId> atoms = cluster_to_atoms(cluster);
-         * ClusterBlockId cluster2 = atom_to_cluster(atoms[0]);
-         * VTR_LOG("### %d, %d \n", cluster, cluster2);
-         * //check_cluster_atoms(blocks_affected.moved_blocks[0].block_num);
-         */
-
         if (swap_result == ACCEPTED) {
             /* Move was accepted.  Update statistics that are useful for the annealing schedule. */
             stats->single_swap_update(*costs);
@@ -1230,14 +1222,6 @@ static float starting_t(const t_annealing_state* state, t_placer_costs* costs, t
                                              placer_opts, move_type_stat, placer_opts.place_algorithm,
                                              REWARD_BB_TIMING_RELATIVE_WEIGHT, manual_move_enabled);
 
-        /******************** Elgammal ************************/
-        /*
-         * auto& atom_ctx = g_vpr_ctx.atom();
-         * std::vector<AtomBlockId> atom_id = cluster_to_atoms(blocks_affected.moved_blocks[0].block_num);
-         * VTR_LOG(" # %zu,%zu, %zu\n", blocks_affected.moved_blocks[0].block_num, atom_id[0], atom_ctx.atom_molecules.find(atom_id[0])->second->num_blocks);
-         */
-        /******************************************************/
-
         if (swap_result == ACCEPTED) {
             num_accepted++;
             av += costs->cost;