clustered_netlist.h

Go to the documentation of this file.

#ifndef CLUSTERED_NETLIST_H
#define CLUSTERED_NETLIST_H

#include "vpr_types.h"
#include "vpr_utils.h"

#include "vtr_util.h"

#include "netlist.h"
#include "clustered_netlist_fwd.h"

class ClusteredNetlist : public Netlist<ClusterBlockId, ClusterPortId, ClusterPinId, ClusterNetId> {
  public:
    ClusteredNetlist(std::string name = "", std::string id = "");

  public: //Public Accessors

    /*
     * Blocks
     */

    t_pb* block_pb(const ClusterBlockId id) const;

    t_logical_block_type_ptr block_type(const ClusterBlockId id) const;

    ClusterNetId block_net(const ClusterBlockId blk_id, const int pin_index) const;

    int block_pin_net_index(const ClusterBlockId blk_id, const int pin_index) const;

    ClusterPinId block_pin(const ClusterBlockId blk, const int logical_pin_index) const;

    //** @brief Returns true if the specified block contains a primary input (e.g. BLIF .input primitive) */
    bool block_contains_primary_input(const ClusterBlockId blk) const;

    bool block_contains_primary_output(const ClusterBlockId blk) const;

    /*
     * Pins
     */

    int pin_logical_index(const ClusterPinId pin_id) const;

    int net_pin_logical_index(const ClusterNetId net_id, int net_pin_index) const;

    /*
     * Nets
     */

    bool net_is_ignored(const ClusterNetId id) const;

    bool net_is_global(const ClusterNetId id) const;

  public: //Public Mutators

    ClusterBlockId create_block(const char* name, t_pb* pb, t_logical_block_type_ptr type);

    ClusterPortId create_port(const ClusterBlockId blk_id, const std::string name, BitIndex width, PortType type);
    ClusterPinId create_pin(const ClusterPortId port_id, BitIndex port_bit, const ClusterNetId net_id, const PinType pin_type, int pin_index, bool is_const = false);

    ClusterNetId create_net(const std::string name);

    void set_net_is_ignored(ClusterNetId net_id, bool state);

    void set_net_is_global(ClusterNetId net_id, bool state);

  private: //Private Members
    /*
     * Netlist compression/optimization
     */

    void clean_blocks_impl(const vtr::vector_map<ClusterBlockId, ClusterBlockId>& block_id_map) override;
    void clean_ports_impl(const vtr::vector_map<ClusterPortId, ClusterPortId>& port_id_map) override;
    void clean_pins_impl(const vtr::vector_map<ClusterPinId, ClusterPinId>& pin_id_map) override;
    void clean_nets_impl(const vtr::vector_map<ClusterNetId, ClusterNetId>& net_id_map) override;

    void shrink_to_fit_impl() override;

    /*
     * Component removal
     */

    void remove_block_impl(const ClusterBlockId blk_id) override;
    void remove_port_impl(const ClusterPortId port_id) override;
    void remove_pin_impl(const ClusterPinId pin_id) override;
    void remove_net_impl(const ClusterNetId net_id) override;

    void rebuild_block_refs_impl(const vtr::vector_map<ClusterPinId, ClusterPinId>& pin_id_map, const vtr::vector_map<ClusterPortId, ClusterPortId>& port_id_map) override;
    void rebuild_port_refs_impl(const vtr::vector_map<ClusterBlockId, ClusterBlockId>& block_id_map, const vtr::vector_map<ClusterPinId, ClusterPinId>& pin_id_map) override;
    void rebuild_pin_refs_impl(const vtr::vector_map<ClusterPortId, ClusterPortId>& port_id_map, const vtr::vector_map<ClusterNetId, ClusterNetId>& net_id_map) override;
    void rebuild_net_refs_impl(const vtr::vector_map<ClusterPinId, ClusterPinId>& pin_id_map) override;

    /*
     * Sanity Checks
     */

    //Verify the internal data structure sizes match
    bool validate_block_sizes_impl(size_t num_blocks) const override;
    bool validate_port_sizes_impl(size_t num_ports) const override;
    bool validate_pin_sizes_impl(size_t num_pins) const override;
    bool validate_net_sizes_impl(size_t num_nets) const override;

  private: //Private Data
    //Blocks
    vtr::vector_map<ClusterBlockId, t_pb*> block_pbs_;                              
    vtr::vector_map<ClusterBlockId, t_logical_block_type_ptr> block_types_;         
    vtr::vector_map<ClusterBlockId, std::vector<ClusterPinId>> block_logical_pins_; 
    //Pins
    vtr::vector_map<ClusterPinId, int> pin_logical_index_; 
    //Nets
    vtr::vector_map<ClusterNetId, bool> net_is_ignored_; 
    vtr::vector_map<ClusterNetId, bool> net_is_global_;  
};

#endif