Revert "fix #2089 Cluster attraction groups for tight floorplan constraints not working"

This reverts commit f1b2391.

Author: zhaisitong

vpr/src/base/vpr_api.cpp

@@ -398,6 +398,12 @@ bool vpr_flow(t_vpr_setup& vpr_setup, t_arch& arch) {
         vpr_analysis_flow(vpr_setup, arch, route_status, is_flat);
     }
 
+    //clean packing-placement data
+    if (vpr_setup.PackerOpts.doPacking == STAGE_DO) {
+        auto& helper_ctx = g_vpr_ctx.mutable_cl_helper();
+        free_cluster_placement_stats(helper_ctx.cluster_placement_stats);
+    }
+
     //close the graphics
     vpr_close_graphics(vpr_setup);
 

vpr/src/base/vpr_context.h

@@ -58,12 +58,34 @@ struct AtomContext : public Context {
     /********************************************************************
      * Atom Netlist
      ********************************************************************/
+    /**
+     * @brief constructor
+     * 
+     * In the constructor initialize the list of pack molecules to nullptr and defines a custom deletor for it
+     */
+    AtomContext()
+        : list_of_pack_molecules(nullptr, free_pack_molecules) {}
 
     ///@brief Atom netlist
     AtomNetlist nlist;
 
     ///@brief Mappings to/from the Atom Netlist to physically described .blif models
     AtomLookup lookup;
+
+    /**
+     * @brief The molecules associated with each atom block.
+     * 
+     * This map is loaded in the pre-packing stage and freed at the very end of vpr flow run.
+     * The pointers in this multimap is shared with list_of_pack_molecules.
+     */
+    std::multimap<AtomBlockId, t_pack_molecule*> atom_molecules;
+
+    /**
+     * @brief A linked list of all the packing molecules that are loaded in pre-packing stage.
+     * 
+     * Is is useful in freeing the pack molecules at the destructor of the Atom context using free_pack_molecules.
+     */
+    std::unique_ptr<t_pack_molecule, decltype(&free_pack_molecules)> list_of_pack_molecules;
 };
 
 /**

vpr/src/base/vpr_types.cpp

@@ -214,3 +214,53 @@ BitIndex t_pb::atom_pin_bit_index(const t_pb_graph_pin* gpin) const {
 void t_pb::set_atom_pin_bit_index(const t_pb_graph_pin* gpin, BitIndex atom_pin_bit_idx) {
     pin_rotations_[gpin] = atom_pin_bit_idx;
 }
+
+void free_pack_molecules(t_pack_molecule* list_of_pack_molecules) {
+    t_pack_molecule* cur_pack_molecule = list_of_pack_molecules;
+    while (cur_pack_molecule != nullptr) {
+        cur_pack_molecule = list_of_pack_molecules->next;
+        delete list_of_pack_molecules;
+        list_of_pack_molecules = cur_pack_molecule;
+    }
+}
+
+/**
+ * Free linked lists found in cluster_placement_stats_list
+ */
+void free_cluster_placement_stats(t_cluster_placement_stats* cluster_placement_stats_list) {
+    t_cluster_placement_primitive *cur, *next;
+    auto& device_ctx = g_vpr_ctx.device();
+
+    for (const auto& type : device_ctx.logical_block_types) {
+        int index = type.index;
+        cur = cluster_placement_stats_list[index].tried;
+        while (cur != nullptr) {
+            next = cur->next_primitive;
+            delete cur;
+            cur = next;
+        }
+        cur = cluster_placement_stats_list[index].in_flight;
+        while (cur != nullptr) {
+            next = cur->next_primitive;
+            delete cur;
+            cur = next;
+        }
+        cur = cluster_placement_stats_list[index].invalid;
+        while (cur != nullptr) {
+            next = cur->next_primitive;
+            delete cur;
+            cur = next;
+        }
+        for (int j = 0; j < cluster_placement_stats_list[index].num_pb_types; j++) {
+            cur = cluster_placement_stats_list[index].valid_primitives[j]->next_primitive;
+            while (cur != nullptr) {
+                next = cur->next_primitive;
+                delete cur;
+                cur = next;
+            }
+            delete cluster_placement_stats_list[index].valid_primitives[j];
+        }
+        delete[] cluster_placement_stats_list[index].valid_primitives;
+    }
+    delete[] cluster_placement_stats_list;
+}

vpr/src/base/vpr_types.h

@@ -1665,4 +1665,14 @@ typedef vtr::vector<ClusterBlockId, std::vector<std::vector<int>>> t_clb_opins_u
 
 typedef std::vector<std::map<int, int>> t_arch_switch_fanin;
 
+/**
+ * @brief Free the linked list that saves all the packing molecules.
+ */
+void free_pack_molecules(t_pack_molecule* list_of_pack_molecules);
+
+/**
+ * @brief Free the linked lists to placement locations based on status of primitive inside placement stats data structure.
+ */
+void free_cluster_placement_stats(t_cluster_placement_stats* cluster_placement_stats);
+
 #endif

vpr/src/pack/cluster.cpp

@@ -8,22 +8,24 @@
 #include "physical_types.h"
 #include "vpr_types.h"
 #include "atom_netlist_fwd.h"
+#include "attraction_groups.h"
+#include "cluster_util.h"
 
 std::map<t_logical_block_type_ptr, size_t> do_clustering(const t_packer_opts& packer_opts,
                                                          const t_analysis_opts& analysis_opts,
                                                          const t_arch* arch,
                                                          t_pack_molecule* molecule_head,
                                                          int num_models,
                                                          const std::unordered_set<AtomNetId>& is_clock,
-                                                         std::multimap<AtomBlockId, t_pack_molecule*>& atom_molecules,
                                                          const std::unordered_map<AtomBlockId, t_pb_graph_node*>& expected_lowest_cost_pb_gnode,
                                                          bool allow_unrelated_clustering,
                                                          bool balance_block_type_utilization,
                                                          std::vector<t_lb_type_rr_node>* lb_type_rr_graphs,
                                                          const t_ext_pin_util_targets& ext_pin_util_targets,
                                                          const t_pack_high_fanout_thresholds& high_fanout_thresholds,
                                                          AttractionInfo& attraction_groups,
-                                                         bool& floorplan_regions_overfull);
+                                                         bool& floorplan_regions_overfull,
+                                                         t_clustering_data& clustering_data);
 
 int get_cluster_of_block(int blkidx);
 

vpr/src/pack/cluster.h

@@ -219,47 +219,6 @@ void reset_cluster_placement_stats(t_cluster_placement_stats* cluster_placement_
     cluster_placement_stats->has_long_chain = false;
 }
 
-/**
- * Free linked lists found in cluster_placement_stats_list
- */
-void free_cluster_placement_stats(t_cluster_placement_stats* cluster_placement_stats_list) {
-    t_cluster_placement_primitive *cur, *next;
-    auto& device_ctx = g_vpr_ctx.device();
-
-    for (const auto& type : device_ctx.logical_block_types) {
-        int index = type.index;
-        cur = cluster_placement_stats_list[index].tried;
-        while (cur != nullptr) {
-            next = cur->next_primitive;
-            free(cur);
-            cur = next;
-        }
-        cur = cluster_placement_stats_list[index].in_flight;
-        while (cur != nullptr) {
-            next = cur->next_primitive;
-            free(cur);
-            cur = next;
-        }
-        cur = cluster_placement_stats_list[index].invalid;
-        while (cur != nullptr) {
-            next = cur->next_primitive;
-            free(cur);
-            cur = next;
-        }
-        for (int j = 0; j < cluster_placement_stats_list[index].num_pb_types; j++) {
-            cur = cluster_placement_stats_list[index].valid_primitives[j]->next_primitive;
-            while (cur != nullptr) {
-                next = cur->next_primitive;
-                free(cur);
-                cur = next;
-            }
-            free(cluster_placement_stats_list[index].valid_primitives[j]);
-        }
-        free(cluster_placement_stats_list[index].valid_primitives);
-    }
-    free(cluster_placement_stats_list);
-}
-
 /**
  * Put primitive back on queue of valid primitives
  *  Note that valid status is not changed because if the primitive is not valid, it will get properly collected later

vpr/src/pack/cluster_placement.cpp

@@ -18,8 +18,6 @@ void set_mode_cluster_placement_stats(const t_pb_graph_node* complex_block,
                                       int mode);
 void reset_cluster_placement_stats(
     t_cluster_placement_stats* cluster_placement_stats);
-void free_cluster_placement_stats(
-    t_cluster_placement_stats* cluster_placement_stats);
 
 int get_array_size_of_molecule(const t_pack_molecule* molecule);
 bool exists_free_primitive_for_atom_block(