Change the printing statements to print based on verbosity

MohamedElgammal · MohamedElgammal · commit 233dc26e9855 · 2022-06-27T13:38:32.000-04:00
diff --git a/vpr/src/pack/re_cluster.cpp b/vpr/src/pack/re_cluster.cpp
@@ -6,7 +6,8 @@
 
 bool move_mol_to_new_cluster(t_pack_molecule* molecule,
                              t_clustering_data& clustering_data,
-                             bool during_packing) {
+                             bool during_packing,
+                             int verbosity) {
     auto& cluster_ctx = g_vpr_ctx.clustering();
     auto& helper_ctx = g_vpr_ctx.mutable_cl_helper();
     auto& device_ctx = g_vpr_ctx.device();
@@ -30,17 +31,23 @@ bool move_mol_to_new_cluster(t_pack_molecule* molecule,
     }
 
     if (helper_ctx.num_used_type_instances[block_type] == num_instances) {
-        VTR_LOG("The utilization of block_type %s is 100%. No space for new clusters\n", block_type->name);
-        VTR_LOG("Atom %d move aborted\n", molecule->atom_block_ids[molecule->root]);
+        VTR_LOGV(verbosity > 4, "The utilization of block_type %s is 100%. No space for new clusters\n", block_type->name);
+        VTR_LOGV(verbosity > 4, "Atom %d move aborted\n", molecule->atom_block_ids[molecule->root]);
         return false;
     }
 
-    //remove the molecule from its current cluster and check the cluster legality after
-    is_removed = remove_mol_from_cluster(molecule, molecule_size, old_clb, old_router_data, clustering_data, during_packing);
+    //remove the molecule from its current cluster
+    remove_mol_from_cluster(molecule, molecule_size, old_clb, old_router_data);
 
-    if (!is_removed) {
-        VTR_LOG("Atom: %zu move failed. Can't remove it from the old cluster\n", molecule->atom_block_ids[molecule->root]);
-        return (is_removed);
+    //check old cluster legality after removing the molecule
+    is_removed = is_cluster_legal(old_router_data);
+
+    //if the cluster is legal, commit the molecule removal. Otherwise, abort the move
+    if (is_removed) {
+        commit_mol_removal(molecule, molecule_size, old_clb, during_packing, old_router_data, clustering_data);
+    } else {
+        VTR_LOGV(verbosity > 4, "Atom: %zu move failed. Can't remove it from the old cluster\n", molecule->atom_block_ids[molecule->root]);
+        return false;
     }
 
     //Create new cluster of the same type and mode.
@@ -52,17 +59,18 @@ bool move_mol_to_new_cluster(t_pack_molecule* molecule,
                                            helper_ctx.enable_pin_feasibility_filter,
                                            new_clb,
                                            during_packing,
+                                           verbosity,
                                            clustering_data,
                                            &router_data,
                                            temp_cluster_pr);
 
     //Commit or revert the move
     if (is_created) {
         commit_mol_move(old_clb, new_clb, during_packing, true);
-        VTR_LOG("Atom:%zu is moved to a new cluster\n", molecule->atom_block_ids[molecule->root]);
+        VTR_LOGV(verbosity > 4, "Atom:%zu is moved to a new cluster\n", molecule->atom_block_ids[molecule->root]);
     } else {
         revert_mol_move(old_clb, molecule, old_router_data, during_packing, clustering_data);
-        VTR_LOG("Atom:%zu move failed. Can't start a new cluster of the same type and mode\n", molecule->atom_block_ids[molecule->root]);
+        VTR_LOGV(verbosity > 4, "Atom:%zu move failed. Can't start a new cluster of the same type and mode\n", molecule->atom_block_ids[molecule->root]);
     }
 
     free_router_data(old_router_data);
@@ -80,6 +88,7 @@ bool move_mol_to_new_cluster(t_pack_molecule* molecule,
 bool move_mol_to_existing_cluster(t_pack_molecule* molecule,
                                   const ClusterBlockId& new_clb,
                                   bool during_packing,
+                                  int verbosity,
                                   t_clustering_data& clustering_data) {
     //define required contexts
     auto& cluster_ctx = g_vpr_ctx.clustering();
@@ -94,36 +103,42 @@ bool move_mol_to_existing_cluster(t_pack_molecule* molecule,
     //Check that the old and new clusters are the same type
     ClusterBlockId old_clb = atom_to_cluster(root_atom_id);
     if (cluster_ctx.clb_nlist.block_type(old_clb) != cluster_ctx.clb_nlist.block_type(new_clb)) {
-        VTR_LOG("Atom:%zu move aborted. New and old cluster blocks are not of the same type",
+        VTR_LOGV(verbosity > 4, "Atom:%zu move aborted. New and old cluster blocks are not of the same type",
                 root_atom_id);
         return false;
     }
 
     //Check that the old and new clusters are the mode
     if (cluster_ctx.clb_nlist.block_pb(old_clb)->mode != cluster_ctx.clb_nlist.block_pb(new_clb)->mode) {
-        VTR_LOG("Atom:%zu move aborted. New and old cluster blocks are not of the same mode",
+        VTR_LOGV(verbosity > 4, "Atom:%zu move aborted. New and old cluster blocks are not of the same mode",
                 root_atom_id);
         return false;
     }
 
-    //remove the molecule from its current cluster and check the cluster legality
-    is_removed = remove_mol_from_cluster(molecule, molecule_size, old_clb, old_router_data, clustering_data, during_packing);
-    if (!is_removed) {
-        VTR_LOG("Atom: %zu move failed. Can't remove it from the old cluster\n", root_atom_id);
+    //remove the molecule from its current cluster
+    remove_mol_from_cluster(molecule, molecule_size, old_clb, old_router_data);
+
+    //check old cluster legality after removing the molecule
+    is_removed = is_cluster_legal(old_router_data);
+
+    //if the cluster is legal, commit the molecule removal. Otherwise, abort the move
+    if (is_removed) {
+        commit_mol_removal(molecule, molecule_size, old_clb, during_packing, old_router_data, clustering_data);
+    } else {
+        VTR_LOGV(verbosity > 4, "Atom: %zu move failed. Can't remove it from the old cluster\n", root_atom_id);
         return false;
     }
 
-    rebuild_cluster_placemet_stats(new_clb, new_clb_atoms, cluster_ctx.clb_nlist.block_type(new_clb)->index, cluster_ctx.clb_nlist.block_pb(new_clb)->mode);
     //Add the atom to the new cluster
     is_added = pack_mol_in_existing_cluster(molecule, new_clb, new_clb_atoms, during_packing, clustering_data);
 
     //Commit or revert the move
     if (is_added) {
         commit_mol_move(old_clb, new_clb, during_packing, false);
-        VTR_LOG("Atom:%zu is moved to a new cluster\n", molecule->atom_block_ids[molecule->root]);
+        VTR_LOGV(verbosity > 4, "Atom:%zu is moved to a new cluster\n", molecule->atom_block_ids[molecule->root]);
     } else {
         revert_mol_move(old_clb, molecule, old_router_data, during_packing, clustering_data);
-        VTR_LOG("Atom:%zu move failed. Can't start a new cluster of the same type and mode\n", molecule->atom_block_ids[molecule->root]);
+        VTR_LOGV(verbosity > 4, "Atom:%zu move failed. Can't start a new cluster of the same type and mode\n", molecule->atom_block_ids[molecule->root]);
     }
 
     free_router_data(old_router_data);
diff --git a/vpr/src/pack/re_cluster.h b/vpr/src/pack/re_cluster.h
@@ -24,7 +24,8 @@
  */
 bool move_mol_to_new_cluster(t_pack_molecule* molecule,
                              t_clustering_data& clustering_data,
-                             bool during_packing);
+                             bool during_packing,
+                             int verbosity);
 
 /**
  * @brief This function moves a molecule out of its cluster to another cluster that already exists.
@@ -37,6 +38,7 @@ bool move_mol_to_new_cluster(t_pack_molecule* molecule,
 bool move_mol_to_existing_cluster(t_pack_molecule* molecule,
                                   const ClusterBlockId& new_clb,
                                   bool during_packing,
+                                  int verbosity,
                                   t_clustering_data& clustering_data);
 
 /**
diff --git a/vpr/src/pack/re_cluster_util.cpp b/vpr/src/pack/re_cluster_util.cpp
@@ -35,6 +35,11 @@ static void fix_cluster_net_after_moving(const t_pack_molecule* molecule,
                                          const ClusterBlockId& old_clb,
                                          const ClusterBlockId& new_clb);
 
+static void rebuild_cluster_placemet_stats(const ClusterBlockId& clb_index,
+                                    const std::vector<AtomBlockId>& clb_atoms,
+                                    int type_idx,
+                                    int mode);
+
 /*****************  API functions ***********************/
 ClusterBlockId atom_to_cluster(const AtomBlockId& atom) {
     auto& atom_ctx = g_vpr_ctx.atom();
@@ -46,18 +51,11 @@ std::vector<AtomBlockId> cluster_to_atoms(const ClusterBlockId& cluster) {
     return (cluster_lookup.atoms_in_cluster(cluster));
 }
 
-bool remove_mol_from_cluster(const t_pack_molecule* molecule,
+void remove_mol_from_cluster(const t_pack_molecule* molecule,
                              int molecule_size,
                              ClusterBlockId& old_clb,
-                             t_lb_router_data*& router_data,
-                             t_clustering_data& clustering_data,
-                             bool during_packing) {
+                             t_lb_router_data*& router_data) {
     auto& helper_ctx = g_vpr_ctx.mutable_cl_helper();
-    auto& atom_ctx = g_vpr_ctx.atom();
-    auto& cluster_ctx = g_vpr_ctx.mutable_clustering();
-
-    t_pb* temp_pb = const_cast<t_pb*>(atom_ctx.lookup.atom_pb(molecule->atom_block_ids[0]));
-    t_pb* next_pb;
 
     //Determine the cluster ID
     old_clb = atom_to_cluster(molecule->atom_block_ids[molecule->root]);
@@ -72,30 +70,6 @@ bool remove_mol_from_cluster(const t_pack_molecule* molecule,
             remove_atom_from_target(router_data, molecule->atom_block_ids[i_atom]);
         }
     }
-
-    //check cluster legality
-    bool is_cluster_legal = check_cluster_legality(0, E_DETAILED_ROUTE_AT_END_ONLY, router_data);
-
-    if (is_cluster_legal) {
-        for (int i_atom = 0; i_atom < molecule_size; i_atom++) {
-            if (molecule->atom_block_ids[i_atom]) {
-                revert_place_atom_block(molecule->atom_block_ids[i_atom], router_data);
-            }
-        }
-
-        cleanup_pb(cluster_ctx.clb_nlist.block_pb(old_clb));
-
-        if (during_packing) {
-            free_intra_lb_nets(clustering_data.intra_lb_routing[old_clb]);
-            clustering_data.intra_lb_routing[old_clb] = router_data->saved_lb_nets;
-            router_data->saved_lb_nets = nullptr;
-        } else {
-            cluster_ctx.clb_nlist.block_pb(old_clb)->pb_route.clear();
-            cluster_ctx.clb_nlist.block_pb(old_clb)->pb_route = alloc_and_load_pb_route(router_data->saved_lb_nets, cluster_ctx.clb_nlist.block_pb(old_clb)->pb_graph_node);
-        }
-    }
-    //return true if succeeded
-    return (is_cluster_legal);
 }
 
 void commit_mol_move(const ClusterBlockId& old_clb,
@@ -133,6 +107,7 @@ bool start_new_cluster_for_mol(t_pack_molecule* molecule,
                                bool enable_pin_feasibility_filter,
                                ClusterBlockId clb_index,
                                bool during_packing,
+                               int verbosity,
                                t_clustering_data& clustering_data,
                                t_lb_router_data** router_data,
                                PartitionRegion& temp_cluster_pr) {
@@ -141,8 +116,6 @@ bool start_new_cluster_for_mol(t_pack_molecule* molecule,
     auto& helper_ctx = g_vpr_ctx.mutable_cl_helper();
     auto& cluster_ctx = g_vpr_ctx.mutable_clustering();
 
-    int verbosity = 0;
-
     /* Cluster's PartitionRegion is empty initially, meaning it has no floorplanning constraints */
     PartitionRegion empty_pr;
     floorplanning_ctx.cluster_constraints.push_back(empty_pr);
@@ -181,7 +154,7 @@ bool start_new_cluster_for_mol(t_pack_molecule* molecule,
 
     // If clustering succeeds, add it to the clb netlist
     if (pack_result == BLK_PASSED) {
-        VTR_LOGV(verbosity > 2, "\tPASSED_SEED: Block Type %s\n", type->name);
+        VTR_LOGV(verbosity > 4, "\tPASSED_SEED: Block Type %s\n", type->name);
         //Once clustering succeeds, add it to the clb netlist
         if (pb->name != nullptr) {
             free(pb->name);
@@ -223,6 +196,10 @@ bool pack_mol_in_existing_cluster(t_pack_molecule* molecule,
     t_logical_block_type_ptr block_type = cluster_ctx.clb_nlist.block_type(new_clb);
     t_pb* temp_pb = cluster_ctx.clb_nlist.block_pb(new_clb);
 
+
+    //re-build cluster placement stats
+    rebuild_cluster_placemet_stats(new_clb, new_clb_atoms, cluster_ctx.clb_nlist.block_type(new_clb)->index, cluster_ctx.clb_nlist.block_pb(new_clb)->mode);
+
     //re-build router_data structure for this cluster
     t_lb_router_data* router_data = lb_load_router_data(helper_ctx.lb_type_rr_graphs, new_clb, new_clb_atoms);
 
@@ -612,8 +589,7 @@ static bool count_children_pbs(const t_pb* pb) {
     return false;
 }
 
-#if 1
-void rebuild_cluster_placemet_stats(const ClusterBlockId& clb_index,
+static void rebuild_cluster_placemet_stats(const ClusterBlockId& clb_index,
                                     const std::vector<AtomBlockId>& clb_atoms,
                                     int type_idx,
                                     int mode) {
@@ -643,4 +619,33 @@ void rebuild_cluster_placemet_stats(const ClusterBlockId& clb_index,
         }
     }
 }
-#endif
+
+bool is_cluster_legal(t_lb_router_data*& router_data) {
+    return (check_cluster_legality(0, E_DETAILED_ROUTE_AT_END_ONLY, router_data));
+}
+
+void commit_mol_removal(const t_pack_molecule* molecule,
+                        const int& molecule_size,
+                        const ClusterBlockId& old_clb,
+                        bool during_packing,
+                        t_lb_router_data*& router_data,
+                        t_clustering_data& clustering_data) {
+    auto& cluster_ctx = g_vpr_ctx.mutable_clustering();
+
+    for (int i_atom = 0; i_atom < molecule_size; i_atom++) {
+        if (molecule->atom_block_ids[i_atom]) {
+            revert_place_atom_block(molecule->atom_block_ids[i_atom], router_data);
+        }
+    }
+
+    cleanup_pb(cluster_ctx.clb_nlist.block_pb(old_clb));
+
+    if (during_packing) {
+        free_intra_lb_nets(clustering_data.intra_lb_routing[old_clb]);
+        clustering_data.intra_lb_routing[old_clb] = router_data->saved_lb_nets;
+        router_data->saved_lb_nets = nullptr;
+    } else {
+        cluster_ctx.clb_nlist.block_pb(old_clb)->pb_route.clear();
+        cluster_ctx.clb_nlist.block_pb(old_clb)->pb_route = alloc_and_load_pb_route(router_data->saved_lb_nets, cluster_ctx.clb_nlist.block_pb(old_clb)->pb_graph_node);
+    }
+}
diff --git a/vpr/src/pack/re_cluster_util.h b/vpr/src/pack/re_cluster_util.h
@@ -47,12 +47,10 @@ t_lb_router_data* lb_load_router_data(std::vector<t_lb_type_rr_node>* lb_type_rr
  * It aborts the removal and returns false if the removal will make the old cluster 
  * illegal
  */
-bool remove_mol_from_cluster(const t_pack_molecule* molecule,
+void remove_mol_from_cluster(const t_pack_molecule* molecule,
                              int molecule_size,
                              ClusterBlockId& old_clb,
-                             t_lb_router_data*& router_data,
-                             t_clustering_data& clustering_data,
-                             bool during_packing);
+                             t_lb_router_data*& router_data);
 
 /**
  * @brief A function that starts a new cluster for one specific molecule
@@ -67,6 +65,7 @@ bool start_new_cluster_for_mol(t_pack_molecule* molecule,
                                bool enable_pin_feasibility_filter,
                                ClusterBlockId clb_index,
                                bool during_packing,
+                               int verbosity,
                                t_clustering_data& clustering_data,
                                t_lb_router_data** router_data,
                                PartitionRegion& temp_cluster_pr);
@@ -107,9 +106,13 @@ bool pack_mol_in_existing_cluster(t_pack_molecule* molecule,
                                   bool during_packing,
                                   t_clustering_data& clustering_data);
 
-void rebuild_cluster_placemet_stats(const ClusterBlockId& clb_index,
-                                    const std::vector<AtomBlockId>& clb_atoms,
-                                    int type_idx,
-                                    int mode);
+bool is_cluster_legal(t_lb_router_data*& router_data);
+
+void commit_mol_removal(const t_pack_molecule* molecule,
+                        const int& molecule_size,
+                        const ClusterBlockId& old_clb,
+                        bool during_packing,
+                        t_lb_router_data*& router_data,
+                        t_clustering_data& clustering_data);
 
 #endif
