Remove usage of atom to pb lookup from packing

utils/fasm/src/fasm.cpp

@@ -343,9 +343,9 @@ static AtomNetId _find_atom_input_logical_net(const t_pb* atom, const t_pb_route
 
 static LogicVec lut_outputs(const t_pb* atom_pb, size_t num_inputs, const t_pb_routes &pb_route) {
     auto& atom_ctx = g_vpr_ctx.atom();
-    AtomBlockId block_id = atom_ctx.lookup().pb_atom(atom_pb);
+    AtomBlockId block_id = atom_ctx.lookup().atom_pb_bimap().pb_atom(atom_pb);
     const auto& truth_table = atom_ctx.netlist().block_truth_table(block_id);
-    auto ports = atom_ctx.netlist().block_input_ports(atom_ctx.lookup().pb_atom(atom_pb));
+    auto ports = atom_ctx.netlist().block_input_ports(atom_ctx.lookup().atom_pb_bimap().pb_atom(atom_pb));
 
     const t_pb_graph_node* gnode = atom_pb->pb_graph_node;
 
@@ -537,7 +537,7 @@ static const t_pb_routes &find_pb_route(const t_pb* pb) {
 void FasmWriterVisitor::check_for_param(const t_pb *atom) {
     auto& atom_ctx = g_vpr_ctx.atom();
 
-    auto atom_blk_id = atom_ctx.lookup().pb_atom(atom);
+    auto atom_blk_id = atom_ctx.lookup().atom_pb_bimap().pb_atom(atom);
     if (atom_blk_id == AtomBlockId::INVALID()) {
         return;
     }
@@ -592,7 +592,7 @@ void FasmWriterVisitor::check_for_param(const t_pb *atom) {
 void FasmWriterVisitor::check_for_lut(const t_pb* atom) {
     auto& atom_ctx = g_vpr_ctx.atom();
 
-    auto atom_blk_id = atom_ctx.lookup().pb_atom(atom);
+    auto atom_blk_id = atom_ctx.lookup().atom_pb_bimap().pb_atom(atom);
     if (atom_blk_id == AtomBlockId::INVALID()) {
         return;
     }

vpr/src/base/atom_lookup.cpp

@@ -4,51 +4,6 @@
 #include "vtr_optional.h"
 
 #include "atom_lookup.h"
-/*
- * PB
- */
-const t_pb* AtomLookup::atom_pb(const AtomBlockId blk_id) const {
-    auto iter = atom_to_pb_.find(blk_id);
-    if (iter == atom_to_pb_.end()) {
-        //Not found
-        return nullptr;
-    }
-    return iter->second;
-}
-
-AtomBlockId AtomLookup::pb_atom(const t_pb* pb) const {
-    auto iter = atom_to_pb_.find(pb);
-    if (iter == atom_to_pb_.inverse_end()) {
-        //Not found
-        return AtomBlockId::INVALID();
-    }
-    return iter->second;
-}
-
-const t_pb_graph_node* AtomLookup::atom_pb_graph_node(const AtomBlockId blk_id) const {
-    const t_pb* pb = atom_pb(blk_id);
-    if (pb) {
-        //Found
-        return pb->pb_graph_node;
-    }
-    return nullptr;
-}
-
-void AtomLookup::set_atom_pb(const AtomBlockId blk_id, const t_pb* pb) {
-    //If either of blk_id or pb are not valid,
-    //remove any mapping
-
-    if (!blk_id && pb) {
-        //Remove
-        atom_to_pb_.erase(pb);
-    } else if (blk_id && !pb) {
-        //Remove
-        atom_to_pb_.erase(blk_id);
-    } else if (blk_id && pb) {
-        //If both are valid store the mapping
-        atom_to_pb_.update(blk_id, pb);
-    }
-}
 
 /*
  * PB Pins

vpr/src/base/atom_lookup.h

@@ -15,6 +15,8 @@
 
 #include "vtr_optional.h"
 
+#include "atom_pb_bimap.h"
+
 /**
  * @brief The AtomLookup class describes the mapping between components in the AtomNetlist
  *        and other netlists/entities (i.e. atom block <-> t_pb, atom block <-> clb)
@@ -25,29 +27,49 @@ class AtomLookup {
 
     typedef vtr::Range<pin_tnode_iterator> pin_tnode_range;
 
+
+
   public:
     /*
      * PBs
      */
 
+
     /**
-     * @brief Returns the leaf pb associated with the atom blk_id
-     * @note  this is the lowest level pb which corresponds directly to the atom block
+     * @brief Sets the atom to pb bimap access lock to value.
+     * If set to true, access to the bimap is prohibited and will result in failing assertions.
+     * 
+     * @param value Value to set to lock to
      */
-    const t_pb* atom_pb(const AtomBlockId blk_id) const;
+    inline void set_atom_pb_bimap_lock(bool value) {
+        VTR_ASSERT_SAFE_MSG(lock_atom_pb_bimap_ != value, "Double locking or unlocking the atom pb bimap lock");
+        lock_atom_pb_bimap_ = value;
+      }
+
+    /// @brief Gets the current atom to pb bimap lock value.
+    inline bool atom_pb_bimap_islocked() const {return lock_atom_pb_bimap_;}
 
-    ///@brief Returns the atom block id associated with pb
-    AtomBlockId pb_atom(const t_pb* pb) const;
 
-    ///@brief Conveneince wrapper around atom_pb to access the associated graph node
-    const t_pb_graph_node* atom_pb_graph_node(const AtomBlockId blk_id) const;
+    // All accesses, mutable or immutable, to the atom to pb bimap
+    // will result in failing assertions if the lock is set to true.
+    // This is done to make sure there is only a single source of
+    // data in places that are supposed to use a local data structure
+    // instead of the global context.
+
+    /// @brief Returns a mutable reference to the atom to pb bimap, provided that access to it is unlocked. It will result in a crash otherwise.
+    /// @return Mutable reference to the atom pb bimap.
+    inline AtomPBBimap &mutable_atom_pb_bimap() {VTR_ASSERT(!lock_atom_pb_bimap_); return atom_to_pb_bimap_;}
+
+    /// @brief Returns an immutable reference to the atom to pb bimap, provided that access to it is unlocked. It will result in a crash otherwise.
+    /// @return Immutable reference to the atom pb bimap.
+    inline const AtomPBBimap &atom_pb_bimap() const {VTR_ASSERT(!lock_atom_pb_bimap_); return atom_to_pb_bimap_;}
 
     /**
-     * @brief Sets the bidirectional mapping between an atom and pb
-     *
-     * If either blk_id or pb are not valid any, existing mapping is removed
+     * @brief Set atom to pb bimap
+     * 
+     * @param atom_to_pb Reference to AtomPBBimab to be copied from
      */
-    void set_atom_pb(const AtomBlockId blk_id, const t_pb* pb);
+    void set_atom_to_pb_bimap(const AtomPBBimap& atom_to_pb){atom_to_pb_bimap_ = atom_to_pb;}
 
     /*
      * PB Pins
@@ -112,7 +134,13 @@ class AtomLookup {
 
   private: //Types
   private:
-    vtr::bimap<AtomBlockId, const t_pb*, vtr::linear_map, std::unordered_map> atom_to_pb_;
+
+  /**
+   * @brief Allows or disallows access to the AtomPBBimap data.
+   * Useful to make sure global context is not accessed in places you don't want it to.
+   */  
+    bool lock_atom_pb_bimap_ = false;
+    AtomPBBimap atom_to_pb_bimap_;
 
     vtr::vector_map<AtomPinId, const t_pb_graph_pin*> atom_pin_to_pb_graph_pin_;
 

vpr/src/base/clustered_netlist.cpp

@@ -1,5 +1,5 @@
 #include "clustered_netlist.h"
-
+#include "globals.h"
 #include "physical_types_util.h"
 #include "vtr_assert.h"
 
@@ -171,7 +171,7 @@ ClusterNetId ClusteredNetlist::create_net(const std::string& name) {
 
 void ClusteredNetlist::remove_block_impl(const ClusterBlockId blk_id) {
     //Remove & invalidate pointers
-    free_pb(block_pbs_[blk_id]);
+    free_pb(block_pbs_[blk_id], g_vpr_ctx.mutable_atom().mutable_lookup().mutable_atom_pb_bimap());
     delete block_pbs_[blk_id];
     block_pbs_.insert(blk_id, NULL);
     block_types_.insert(blk_id, NULL);

vpr/src/base/load_flat_place.cpp

@@ -71,7 +71,7 @@ static void print_flat_cluster(FILE* fp,
     // Print a line for each atom.
     for (AtomBlockId atom : atoms_lookup[blk_id]) {
         // Get the atom pb graph node.
-        t_pb_graph_node* atom_pbgn = atom_ctx.lookup().atom_pb(atom)->pb_graph_node;
+        t_pb_graph_node* atom_pbgn = atom_ctx.lookup().atom_pb_bimap().atom_pb(atom)->pb_graph_node;
 
         // Print the flat placement information for this atom.
         fprintf(fp, "%s  %d %d %d %d %d #%zu %s\n",

vpr/src/base/netlist_writer.cpp

@@ -859,7 +859,7 @@ class NetlistWriterVisitor : public NetlistVisitor {
     void visit_atom_impl(const t_pb* atom) override {
         auto& atom_ctx = g_vpr_ctx.atom();
 
-        auto atom_pb = atom_ctx.lookup().pb_atom(atom);
+        auto atom_pb = atom_ctx.lookup().atom_pb_bimap().pb_atom(atom);
         if (atom_pb == AtomBlockId::INVALID()) {
             return;
         }
@@ -1787,7 +1787,7 @@ class NetlistWriterVisitor : public NetlistVisitor {
         }
 
         auto& atom_ctx = g_vpr_ctx.atom();
-        AtomBlockId blk_id = atom_ctx.lookup().pb_atom(atom);
+        AtomBlockId blk_id = atom_ctx.lookup().atom_pb_bimap().pb_atom(atom);
         for (auto param : atom_ctx.netlist().block_params(blk_id)) {
             params[param.first] = param.second;
         }
@@ -1809,7 +1809,7 @@ class NetlistWriterVisitor : public NetlistVisitor {
     tatum::NodeId find_tnode(const t_pb* atom, int cluster_pin_idx) {
         auto& atom_ctx = g_vpr_ctx.atom();
 
-        AtomBlockId blk_id = atom_ctx.lookup().pb_atom(atom);
+        AtomBlockId blk_id = atom_ctx.lookup().atom_pb_bimap().pb_atom(atom);
         ClusterBlockId clb_index = atom_ctx.lookup().atom_clb(blk_id);
 
         auto key = std::make_pair(clb_index, cluster_pin_idx);
@@ -1840,7 +1840,7 @@ class NetlistWriterVisitor : public NetlistVisitor {
                            const t_pb* atom) { //LUT primitive
         auto& atom_ctx = g_vpr_ctx.atom();
 
-        const t_model* model = atom_ctx.netlist().block_model(atom_ctx.lookup().pb_atom(atom));
+        const t_model* model = atom_ctx.netlist().block_model(atom_ctx.lookup().atom_pb_bimap().pb_atom(atom));
         VTR_ASSERT(model->name == std::string(MODEL_NAMES));
 
 #ifdef DEBUG_LUT_MASK
@@ -1851,7 +1851,7 @@ class NetlistWriterVisitor : public NetlistVisitor {
         std::vector<int> permute = determine_lut_permutation(num_inputs, atom);
 
         //Retrieve the truth table
-        const auto& truth_table = atom_ctx.netlist().block_truth_table(atom_ctx.lookup().pb_atom(atom));
+        const auto& truth_table = atom_ctx.netlist().block_truth_table(atom_ctx.lookup().atom_pb_bimap().pb_atom(atom));
 
         //Apply the permutation
         auto permuted_truth_table = permute_truth_table(truth_table, num_inputs, permute);
@@ -1896,7 +1896,7 @@ class NetlistWriterVisitor : public NetlistVisitor {
         //
         //We walk through the logical inputs to this atom (i.e. in the original truth table/netlist)
         //and find the corresponding input in the implementation atom (i.e. in the current netlist)
-        auto ports = atom_ctx.netlist().block_input_ports(atom_ctx.lookup().pb_atom(atom_pb));
+        auto ports = atom_ctx.netlist().block_input_ports(atom_ctx.lookup().atom_pb_bimap().pb_atom(atom_pb));
         if (ports.size() == 1) {
             const t_pb_graph_node* gnode = atom_pb->pb_graph_node;
             VTR_ASSERT(gnode->num_input_ports == 1);
@@ -2144,7 +2144,7 @@ class MergedNetlistWriterVisitor : public NetlistWriterVisitor {
     void visit_atom_impl(const t_pb* atom) override {
         auto& atom_ctx = g_vpr_ctx.atom();
 
-        auto atom_pb = atom_ctx.lookup().pb_atom(atom);
+        auto atom_pb = atom_ctx.lookup().atom_pb_bimap().pb_atom(atom);
         if (atom_pb == AtomBlockId::INVALID()) {
             return;
         }

vpr/src/base/read_netlist.cpp

@@ -177,7 +177,7 @@ ClusteredNetlist read_netlist(const char* net_file,
 
         //Reset atom/pb mapping (it is reloaded from the packed netlist file)
         for (auto blk_id : atom_ctx.netlist().blocks())
-            atom_ctx.mutable_lookup().set_atom_pb(blk_id, nullptr);
+            atom_ctx.mutable_lookup().mutable_atom_pb_bimap().set_atom_pb(blk_id, nullptr);
 
         //Count the number of blocks for allocation
         bcount = pugiutil::count_children(top, "block", loc_data, pugiutil::ReqOpt::OPTIONAL);
@@ -197,7 +197,7 @@ ClusteredNetlist read_netlist(const char* net_file,
 
         /* Error check */
         for (auto blk_id : atom_ctx.netlist().blocks()) {
-            if (atom_ctx.lookup().atom_pb(blk_id) == nullptr) {
+            if (atom_ctx.lookup().atom_pb_bimap().atom_pb(blk_id) == nullptr) {
                 VPR_FATAL_ERROR(VPR_ERROR_NET_F,
                                 ".blif file and .net file do not match, .net file missing atom %s.\n",
                                 atom_ctx.netlist().block_name(blk_id).c_str());
@@ -319,7 +319,7 @@ static void processComplexBlock(pugi::xml_node clb_block,
     }
 
     //Parse all pbs and CB internal nets
-    atom_ctx.mutable_lookup().set_atom_pb(AtomBlockId::INVALID(), clb_nlist->block_pb(index));
+    atom_ctx.mutable_lookup().mutable_atom_pb_bimap().set_atom_pb(AtomBlockId::INVALID(), clb_nlist->block_pb(index));
 
     clb_nlist->block_pb(index)->pb_graph_node = clb_nlist->block_type(index)->pb_graph_head;
     clb_nlist->block_pb(index)->pb_route = alloc_pb_route(clb_nlist->block_pb(index)->pb_graph_node);
@@ -474,7 +474,7 @@ static void processPb(pugi::xml_node Parent, const ClusterBlockId index, t_pb* p
 
         //Update atom netlist mapping
         VTR_ASSERT(blk_id);
-        atom_ctx.mutable_lookup().set_atom_pb(blk_id, pb);
+        atom_ctx.mutable_lookup().mutable_atom_pb_bimap().set_atom_pb(blk_id, pb);
         atom_ctx.mutable_lookup().set_atom_clb(blk_id, index);
 
         auto atom_attrs = atom_ctx.netlist().block_attrs(blk_id);
@@ -542,7 +542,7 @@ static void processPb(pugi::xml_node Parent, const ClusterBlockId index, t_pb* p
                 pb->child_pbs[i][pb_index].name = vtr::strdup(name.value());
 
                 /* Parse all pbs and CB internal nets*/
-                atom_ctx.mutable_lookup().set_atom_pb(AtomBlockId::INVALID(), &pb->child_pbs[i][pb_index]);
+                atom_ctx.mutable_lookup().mutable_atom_pb_bimap().set_atom_pb(AtomBlockId::INVALID(), &pb->child_pbs[i][pb_index]);
 
                 auto mode = child.attribute("mode");
                 pb->child_pbs[i][pb_index].mode = 0;
@@ -564,7 +564,7 @@ static void processPb(pugi::xml_node Parent, const ClusterBlockId index, t_pb* p
             } else {
                 /* physical block has no used primitives but it may have used routing */
                 pb->child_pbs[i][pb_index].name = nullptr;
-                atom_ctx.mutable_lookup().set_atom_pb(AtomBlockId::INVALID(), &pb->child_pbs[i][pb_index]);
+                atom_ctx.mutable_lookup().mutable_atom_pb_bimap().set_atom_pb(AtomBlockId::INVALID(), &pb->child_pbs[i][pb_index]);
 
                 auto lookahead1 = pugiutil::get_first_child(child, "outputs", loc_data, pugiutil::OPTIONAL);
                 if (lookahead1) {
@@ -1180,7 +1180,7 @@ static void load_atom_pin_mapping(const ClusteredNetlist& clb_nlist) {
     auto& atom_ctx = g_vpr_ctx.atom();
 
     for (const AtomBlockId blk : atom_ctx.netlist().blocks()) {
-        const t_pb* pb = atom_ctx.lookup().atom_pb(blk);
+        const t_pb* pb = atom_ctx.lookup().atom_pb_bimap().atom_pb(blk);
         VTR_ASSERT_MSG(pb, "Atom block must have a matching PB");
 
         const t_pb_graph_node* gnode = pb->pb_graph_node;
@@ -1250,7 +1250,7 @@ void set_atom_pin_mapping(const ClusteredNetlist& clb_nlist, const AtomBlockId a
         return;
     }
 
-    const t_pb* atom_pb = atom_ctx.lookup().atom_pb(atom_blk);
+    const t_pb* atom_pb = atom_ctx.lookup().atom_pb_bimap().atom_pb(atom_blk);
 
     //This finds the index within the atom port to which the current gpin
     //is mapped. Note that this accounts for any applied pin rotations

vpr/src/draw/draw.cpp

@@ -797,7 +797,7 @@ ezgl::point2d atom_pin_draw_coord(AtomPinId pin) {
 
     AtomBlockId blk = atom_ctx.netlist().pin_block(pin);
     ClusterBlockId clb_index = atom_ctx.lookup().atom_clb(blk);
-    const t_pb_graph_node* pg_gnode = atom_ctx.lookup().atom_pb_graph_node(blk);
+    const t_pb_graph_node* pg_gnode = atom_ctx.lookup().atom_pb_bimap().atom_pb_graph_node(blk);
 
     t_draw_coords* draw_coords = get_draw_coords_vars();
     ezgl::rectangle pb_bbox = draw_coords->get_absolute_pb_bbox(clb_index,

vpr/src/draw/draw_floorplanning.cpp

@@ -149,8 +149,8 @@ void draw_constrained_atoms(ezgl::renderer* g) {
         auto atoms = constraints.get_part_atoms((PartitionId)partitionID);
 
         for (const AtomBlockId atom_id : atoms) {
-            if (atom_ctx.lookup().atom_pb(atom_id) != nullptr) {
-                const t_pb* pb = atom_ctx.lookup().atom_pb(atom_id);
+            if (atom_ctx.lookup().atom_pb_bimap().atom_pb(atom_id) != nullptr) {
+                const t_pb* pb = atom_ctx.lookup().atom_pb_bimap().atom_pb(atom_id);
                 auto color = kelly_max_contrast_colors_no_black[partitionID % (kelly_max_contrast_colors_no_black.size())];
                 ClusterBlockId clb_index = atom_ctx.lookup().atom_clb(atom_id);
                 auto type = cluster_ctx.clb_nlist.block_type(clb_index);
@@ -306,7 +306,7 @@ static GtkTreeModel* create_and_fill_model() {
                            -1);
 
         for (AtomBlockId const_atom : atoms) {
-            std::string atom_name = (atom_ctx.lookup().atom_pb(const_atom))->name;
+            std::string atom_name = (atom_ctx.lookup().atom_pb_bimap().atom_pb(const_atom))->name;
             gtk_tree_store_append(store, &child_iter, &iter);
             gtk_tree_store_set(store, &child_iter,
                                COL_NAME, atom_name.c_str(),