Add documentation to atom_pb_bimap and general cleanup

Author: AmirhosseinPoolad

vpr/src/base/atom_lookup.h

@@ -37,6 +37,13 @@ class AtomLookup {
     inline AtomPBBimap &mutable_atom_pb_bimap() {VTR_ASSERT(!lock_atom_pb_bimap); return atom_to_pb_bimap_;}
     inline const AtomPBBimap &atom_pb_bimap() const {VTR_ASSERT(!lock_atom_pb_bimap); return atom_to_pb_bimap_;}
 
+    /**
+     * @brief Set atom to pb bimap
+     * 
+     * @param atom_to_pb Reference to AtomPBBimab to be copied from
+     */
+    void set_atom_to_pb_bimap(const AtomPBBimap& atom_to_pb){atom_to_pb_bimap_ = atom_to_pb;}
+
     /*
      * PB Pins
      */
@@ -97,11 +104,6 @@ class AtomLookup {
 
     ///@brief Sets the bi-directional mapping between an atom netlist pin and timing graph node
     void set_atom_pin_tnode(const AtomPinId pin, const tatum::NodeId node, BlockTnode block_tnode_type);
-    
-    // Setter function for atom_to_pb_
-    void set_atom_to_pb_bimap(const AtomPBBimap& atom_to_pb){
-      atom_to_pb_bimap_ = atom_to_pb;
-    }
 
   private: //Types
   private:

vpr/src/pack/atom_pb_bimap.h

@@ -5,6 +5,13 @@
 // Forward declaration
 class t_pb_graph_node;
 
+/**
+ * @brief Class that holds a bimap between atoms and pb types.
+ *        This means that you can get a pb from an atom and the
+ *        other way around.
+ *        
+ *        Used in the global AtomLookup context and in ClusterLegalizer
+ */
 class AtomPBBimap {
     public:
     AtomPBBimap() = default;
@@ -30,8 +37,6 @@ class AtomPBBimap {
      */
     void set_atom_pb(const AtomBlockId blk_id, const t_pb* pb);
 
-    const vtr::bimap<AtomBlockId, const t_pb*, vtr::linear_map, std::unordered_map> &atom_to_pb() const {return atom_to_pb_;}
-
     private:
         vtr::bimap<AtomBlockId, const t_pb*, vtr::linear_map, std::unordered_map> atom_to_pb_;
     };

vpr/src/pack/pack.cpp

@@ -63,7 +63,6 @@ bool try_pack(t_packer_opts* packer_opts,
     // device if needed.
     DeviceContext& mutable_device_ctx = g_vpr_ctx.mutable_device();
 
-
     std::unordered_set<AtomNetId> is_clock, is_global;
     VTR_LOG("Begin packing '%s'.\n", packer_opts->circuit_file_name.c_str());
 

vpr/src/util/vpr_utils.cpp

@@ -16,7 +16,6 @@
 #include "globals.h"
 #include "vpr_utils.h"
 #include "cluster_placement.h"
-#include "cluster_legalizer.h"
 #include "device_grid.h"
 #include "user_route_constraints.h"
 #include "grid_block.h"
@@ -978,34 +977,6 @@ AtomPinId find_atom_pin(ClusterBlockId blk_id, const t_pb_graph_pin* pb_gpin) {
     return atom_pin;
 }
 
-// Retrieves the pb_graph_pin associated with an AtomPinId
-//  Currently this function just wraps get_pb_graph_node_pin_from_model_port_pin()
-//  in a more convenient interface.
-const t_pb_graph_pin* find_pb_graph_pin(const AtomNetlist& netlist, const AtomLookup& netlist_lookup, const AtomPinId pin_id) {
-    VTR_ASSERT(pin_id);
-
-    //Get the graph node
-    AtomBlockId blk_id = netlist.pin_block(pin_id);
-    const t_pb_graph_node* pb_gnode = netlist_lookup.atom_pb_bimap().atom_pb_graph_node(blk_id);
-    VTR_ASSERT(pb_gnode);
-
-    //The graph node and pin/block should agree on the model they represent
-    VTR_ASSERT(netlist.block_model(blk_id) == pb_gnode->pb_type->model);
-
-    //Get the pin index
-    AtomPortId port_id = netlist.pin_port(pin_id);
-    int ipin = netlist.pin_port_bit(pin_id);
-
-    //Get the model port
-    const t_model_ports* model_port = netlist.port_model(port_id);
-    VTR_ASSERT(model_port);
-
-    return get_pb_graph_node_pin_from_model_port_pin(model_port, ipin, pb_gnode);
-}
-
-
-// TODO: Code duplication here. Could probably use a better pack-related abstraction
-// to avoid all this, as this function is only used in vpr/src/pack
 // Retrieves the pb_graph_pin associated with an AtomPinId
 const t_pb_graph_pin* find_pb_graph_pin(const AtomNetlist& netlist, const AtomPBBimap& atom_pb_lookup, const AtomPinId pin_id) {
     VTR_ASSERT(pin_id);

vpr/src/util/vpr_utils.h

@@ -189,7 +189,6 @@ int get_max_depth_of_pb_type(t_pb_type* pb_type);
 int get_max_nets_in_pb_type(const t_pb_type* pb_type);
 bool primitive_type_feasible(AtomBlockId blk_id, const t_pb_type* cur_pb_type);
 t_pb_graph_pin* get_pb_graph_node_pin_from_model_port_pin(const t_model_ports* model_port, const int model_pin, const t_pb_graph_node* pb_graph_node);
-const t_pb_graph_pin* find_pb_graph_pin(const AtomNetlist& netlist, const AtomLookup& netlist_lookup, const AtomPinId pin_id);
 /// @brief Gets the pb_graph_node pin at the given pin index for the given
 ///        pb_graph_node.
 t_pb_graph_pin* get_pb_graph_node_pin_from_pb_graph_node(t_pb_graph_node* pb_graph_node, int ipin);