OpenFPGA/openfpga/src/fpga_bitstream/build_grid_bitstream.cpp

/********************************************************************
 * This file includes functions that are used for building bitstreams
 * for grids (CLBs, heterogenerous blocks, I/Os, etc.)
 *******************************************************************/
#include <cmath>
#include <string>

/* Headers from vtrutil library */
#include "vtr_log.h"
#include "vtr_assert.h"
#include "vtr_time.h"

/* Headers from vpr library */
#include "vpr_utils.h"

#include "pb_graph_utils.h"
#include "mux_utils.h"

#include "circuit_library_utils.h"

#include "openfpga_interconnect_types.h"
#include "openfpga_reserved_words.h"
#include "openfpga_naming.h"
#include "mux_bitstream_constants.h"
#include "pb_type_utils.h"
#include "lut_utils.h"
#include "module_manager_utils.h"

#include "build_mux_bitstream.h"
#include "build_grid_bitstream.h"

/* begin namespace openfpga */
namespace openfpga {

/********************************************************************
 * Decode mode bits "01..." to a bitstream vector
 *******************************************************************/
static 
std::vector<bool> generate_mode_select_bitstream(const std::vector<size_t>& mode_bits) {
  std::vector<bool> mode_select_bitstream;
 
  for (const size_t& mode_bit : mode_bits) {
    /* Error out for unexpected bits */
    VTR_ASSERT((0 == mode_bit) || (1 == mode_bit));
    mode_select_bitstream.push_back(1 == mode_bit);
  }

  return mode_select_bitstream;
}

/********************************************************************
 * Generate bitstream for a primitive node and add it to bitstream manager
 *******************************************************************/
static 
void build_primitive_bitstream(BitstreamManager& bitstream_manager,
                               const ConfigBlockId& parent_configurable_block,
                               const ModuleManager& module_manager,
                               const CircuitLibrary& circuit_lib,
                               const VprDeviceAnnotation& device_annotation,
                               const PhysicalPb& physical_pb,
                               const PhysicalPbId& primitive_pb_id,
                               t_pb_type* primitive_pb_type) {

  /* Ensure a valid physical pritimive pb */ 
  if (nullptr == primitive_pb_type) {
    VTR_LOGF_ERROR(__FILE__, __LINE__,
                   "Invalid primitive_pb_type!\n");
    exit(1);
  }

  CircuitModelId primitive_model = device_annotation.pb_type_circuit_model(primitive_pb_type);
  VTR_ASSERT(CircuitModelId::INVALID() != primitive_model);
  VTR_ASSERT( (CIRCUIT_MODEL_IOPAD == circuit_lib.model_type(primitive_model))
           || (CIRCUIT_MODEL_HARDLOGIC == circuit_lib.model_type(primitive_model))
           || (CIRCUIT_MODEL_FF == circuit_lib.model_type(primitive_model)) );

  /* Find SRAM ports for mode-selection */
  std::vector<CircuitPortId> primitive_mode_select_ports = find_circuit_mode_select_sram_ports(circuit_lib, primitive_model);

  /* We may have a port for mode select or not. */
  VTR_ASSERT( (0 == primitive_mode_select_ports.size())
           || (1 == primitive_mode_select_ports.size()) );

  /* Generate bitstream for mode-select ports */
  if (0 == primitive_mode_select_ports.size()) {
    return; /* Nothing to do, return directly */
  }

  std::vector<bool> mode_select_bitstream;
  if (true == physical_pb.valid_pb_id(primitive_pb_id)) {
    mode_select_bitstream = generate_mode_select_bitstream(physical_pb.mode_bits(primitive_pb_id));
  } else { /* get default mode_bits */
    mode_select_bitstream = generate_mode_select_bitstream(device_annotation.pb_type_mode_bits(primitive_pb_type));
  }

  /* Ensure the length of bitstream matches the side of memory circuits */
  std::vector<CircuitModelId> sram_models = find_circuit_sram_models(circuit_lib, primitive_model);
  VTR_ASSERT(1 == sram_models.size());
  std::string mem_block_name = generate_memory_module_name(circuit_lib, primitive_model, sram_models[0], std::string(MEMORY_MODULE_POSTFIX));
  ModuleId mem_module = module_manager.find_module(mem_block_name);
  VTR_ASSERT (true == module_manager.valid_module_id(mem_module));
  ModulePortId mem_out_port_id = module_manager.find_module_port(mem_module, generate_configurable_memory_data_out_name());
  VTR_ASSERT(mode_select_bitstream.size() == module_manager.module_port(mem_module, mem_out_port_id).get_width());

  /* Create a block for the bitstream which corresponds to the memory module associated to the LUT */
  ConfigBlockId mem_block = bitstream_manager.add_block(mem_block_name);
  bitstream_manager.add_child_block(parent_configurable_block, mem_block);

  /* Add the bitstream to the bitstream manager */
  bitstream_manager.add_block_bits(mem_block, mode_select_bitstream);
}

/********************************************************************
 * This function generates bitstream for a programmable routing
 * multiplexer which drives an output pin of physical_pb_graph_node and its the input_edges
 *
 *   src_pb_graph_node.[in|out]_pins -----------------> des_pb_graph_node.[in|out]pins
 *                                        /|\
 *                                         |
 *                         input_pins,   edges,       output_pins
 *******************************************************************/
static 
void build_physical_block_pin_interc_bitstream(BitstreamManager& bitstream_manager,
                                               const ConfigBlockId& parent_configurable_block,
                                               const ModuleManager& module_manager,
                                               const CircuitLibrary& circuit_lib,
                                               const MuxLibrary& mux_lib,
                                               const AtomContext& atom_ctx,
                                               const VprDeviceAnnotation& device_annotation,
                                               const PhysicalPb& physical_pb,
                                               t_pb_graph_pin* des_pb_graph_pin,
                                               t_mode* physical_mode) {
  /* Identify the number of fan-in (Consider interconnection edges of only selected mode) */
  t_interconnect* cur_interc = pb_graph_pin_interc(des_pb_graph_pin, physical_mode);
  size_t fan_in = pb_graph_pin_inputs(des_pb_graph_pin, cur_interc).size();

  if ((nullptr == cur_interc) || (0 == fan_in)) { 
    /* No interconnection matched */
    return;
  }

  /* Identify pin interconnection type */
  enum e_interconnect interc_type = device_annotation.interconnect_physical_type(cur_interc);
  switch (interc_type) {
  case DIRECT_INTERC:
    /* Nothing to do, return */
    break;
  case COMPLETE_INTERC:
  case MUX_INTERC: {
    /* Find the circuit model id of the mux, we need its design technology which matters the bitstream generation */
    CircuitModelId mux_model = device_annotation.interconnect_circuit_model(cur_interc);
    VTR_ASSERT(CIRCUIT_MODEL_MUX == circuit_lib.model_type(mux_model));

    /* Find the input size of the implementation of a routing multiplexer */
    size_t datapath_mux_size = fan_in;
    VTR_ASSERT(true == valid_mux_implementation_num_inputs(datapath_mux_size));

    /* Cache input and output nets */
    std::vector<AtomNetId> input_nets;
    AtomNetId output_net = AtomNetId::INVALID();

    /* Find the path id:
     * - if des pb is not valid, this is an unmapped pb, we can set a default path_id
     * - There is no net mapped to des_pb_graph_pin we use default path id
     * - There is a net mapped to des_pin_graph_pin: we find the path id
     */
    const PhysicalPbId& des_pb_id = physical_pb.find_pb(des_pb_graph_pin->parent_node);
    size_t mux_input_pin_id = 0;
    if (true != physical_pb.valid_pb_id(des_pb_id)) {
      mux_input_pin_id = DEFAULT_PATH_ID;
    } else if (AtomNetId::INVALID() == physical_pb.pb_graph_pin_atom_net(des_pb_id, des_pb_graph_pin)) {
      mux_input_pin_id = DEFAULT_PATH_ID;
    } else { 
      output_net = physical_pb.pb_graph_pin_atom_net(des_pb_id, des_pb_graph_pin);

      for (t_pb_graph_pin* src_pb_graph_pin : pb_graph_pin_inputs(des_pb_graph_pin, cur_interc)) {
        const PhysicalPbId& src_pb_id = physical_pb.find_pb(src_pb_graph_pin->parent_node);
        input_nets.push_back(physical_pb.pb_graph_pin_atom_net(src_pb_id, src_pb_graph_pin));
      }

      for (t_pb_graph_pin* src_pb_graph_pin : pb_graph_pin_inputs(des_pb_graph_pin, cur_interc)) {
        const PhysicalPbId& src_pb_id = physical_pb.find_pb(src_pb_graph_pin->parent_node);
        /* If the src pb id is not valid, we bypass it */
        if ( (true == physical_pb.valid_pb_id(src_pb_id))
          && (AtomNetId::INVALID() != output_net)
          && (physical_pb.pb_graph_pin_atom_net(src_pb_id, src_pb_graph_pin) == output_net)) {
          break;
        }
        mux_input_pin_id++;
      }
      VTR_ASSERT (mux_input_pin_id <= fan_in);
      /* Unmapped pin, use default path id */
      if (fan_in == mux_input_pin_id) {
        mux_input_pin_id = DEFAULT_PATH_ID;
      }
    }

    /* Generate bitstream depend on both technology and structure of this MUX */
    std::vector<bool> mux_bitstream = build_mux_bitstream(circuit_lib, mux_model, mux_lib, datapath_mux_size, mux_input_pin_id); 

    /* Create the block denoting the memory instances that drives this node in physical_block */
    std::string mem_block_name = generate_pb_memory_instance_name(GRID_MEM_INSTANCE_PREFIX, des_pb_graph_pin, std::string(""));
    ConfigBlockId mux_mem_block = bitstream_manager.add_block(mem_block_name);
    bitstream_manager.add_child_block(parent_configurable_block, mux_mem_block);
  
    /* Find the module in module manager and ensure the bitstream size matches! */
    std::string mem_module_name = generate_mux_subckt_name(circuit_lib, mux_model, datapath_mux_size, std::string(MEMORY_MODULE_POSTFIX)); 
    ModuleId mux_mem_module = module_manager.find_module(mem_module_name); 
    VTR_ASSERT (true == module_manager.valid_module_id(mux_mem_module));
    ModulePortId mux_mem_out_port_id = module_manager.find_module_port(mux_mem_module, generate_configurable_memory_data_out_name());
    VTR_ASSERT(mux_bitstream.size() == module_manager.module_port(mux_mem_module, mux_mem_out_port_id).get_width());
  
    /* Add the bistream to the bitstream manager */
    bitstream_manager.add_block_bits(mux_mem_block, mux_bitstream);
    /* Record path ids, input and output nets */
    bitstream_manager.add_path_id_to_block(mux_mem_block, mux_input_pin_id);
    bitstream_manager.reserve_block_input_net_ids(mux_mem_block, input_nets.size());
    for (const AtomNetId& input_net : input_nets) {
      if (true == atom_ctx.nlist.valid_net_id(input_net)) {
        bitstream_manager.add_input_net_id_to_block(mux_mem_block, atom_ctx.nlist.net_name(input_net));
      } else {
        bitstream_manager.add_input_net_id_to_block(mux_mem_block, std::string("unmapped"));
      }
    }
    if (true == atom_ctx.nlist.valid_net_id(output_net)) {
    bitstream_manager.reserve_block_output_net_ids(mux_mem_block, 1);
      bitstream_manager.add_output_net_id_to_block(mux_mem_block, atom_ctx.nlist.net_name(output_net));
    } else {
      bitstream_manager.add_output_net_id_to_block(mux_mem_block, std::string("unmapped"));
    }

    break;
  }
  default:
    VTR_LOGF_ERROR(__FILE__, __LINE__,
                   "Invalid interconnection type for %s (Arch[LINE%d])!\n",
                   cur_interc->name, cur_interc->line_num);
    exit(1);
  }
}

/********************************************************************
 * This function generates bitstream for the programmable routing
 * multiplexers in a pb_graph node 
 *******************************************************************/
static 
void build_physical_block_interc_port_bitstream(BitstreamManager& bitstream_manager,
                                                const ConfigBlockId& parent_configurable_block,
                                                const ModuleManager& module_manager,
                                                const CircuitLibrary& circuit_lib,
                                                const MuxLibrary& mux_lib,
                                                const AtomContext& atom_ctx,
                                                const VprDeviceAnnotation& device_annotation,
                                                t_pb_graph_node* physical_pb_graph_node,
                                                const PhysicalPb& physical_pb,
                                                const e_circuit_pb_port_type& pb_port_type,
                                                t_mode* physical_mode) {
  switch (pb_port_type) {
  case CIRCUIT_PB_PORT_INPUT:
    for (int iport = 0; iport < physical_pb_graph_node->num_input_ports; ++iport) {
      for (int ipin = 0; ipin < physical_pb_graph_node->num_input_pins[iport]; ++ipin) {
        build_physical_block_pin_interc_bitstream(bitstream_manager, parent_configurable_block,
                                                  module_manager, circuit_lib, mux_lib,
                                                  atom_ctx, device_annotation,
                                                  physical_pb,
                                                  &(physical_pb_graph_node->input_pins[iport][ipin]),
                                                  physical_mode);
      }
    }
    break;
  case CIRCUIT_PB_PORT_OUTPUT:
    for (int iport = 0; iport < physical_pb_graph_node->num_output_ports; ++iport) {
      for (int ipin = 0; ipin < physical_pb_graph_node->num_output_pins[iport]; ++ipin) {
        build_physical_block_pin_interc_bitstream(bitstream_manager, parent_configurable_block,
                                                  module_manager, circuit_lib, mux_lib,
                                                  atom_ctx, device_annotation,
                                                  physical_pb,
                                                  &(physical_pb_graph_node->output_pins[iport][ipin]),
                                                  physical_mode);
      }
    }
    break;
  case CIRCUIT_PB_PORT_CLOCK:
    for (int iport = 0; iport < physical_pb_graph_node->num_clock_ports; ++iport) {
      for (int ipin = 0; ipin < physical_pb_graph_node->num_clock_pins[iport]; ++ipin) {
        build_physical_block_pin_interc_bitstream(bitstream_manager, parent_configurable_block,
                                                  module_manager, circuit_lib, mux_lib,
                                                  atom_ctx, device_annotation,
                                                  physical_pb,
                                                  &(physical_pb_graph_node->clock_pins[iport][ipin]),
                                                  physical_mode);

      }
    }
    break;
  default:
    VTR_LOGF_ERROR(__FILE__, __LINE__,
                   "Invalid pb port type!\n");
    exit(1);
  }
}

/********************************************************************
 * This function generates bitstream for the programmable routing
 * multiplexers in a pb_graph node 
 *******************************************************************/
static 
void build_physical_block_interc_bitstream(BitstreamManager& bitstream_manager,
                                           const ConfigBlockId& parent_configurable_block,
                                           const ModuleManager& module_manager,
                                           const CircuitLibrary& circuit_lib,
                                           const MuxLibrary& mux_lib,
                                           const AtomContext& atom_ctx,
                                           const VprDeviceAnnotation& device_annotation,
                                           t_pb_graph_node* physical_pb_graph_node,
                                           const PhysicalPb& physical_pb,
                                           t_mode* physical_mode) {
  /* Check if the pb_graph node is valid or not */
  if (nullptr == physical_pb_graph_node) {
    VTR_LOGF_ERROR(__FILE__, __LINE__,
                   "Invalid physical_pb_graph_node.\n"); 
    exit(1);
  }

  /* We check output_pins of physical_pb_graph_node and its the input_edges
   * Iterate over the interconnections between outputs of physical_pb_graph_node 
   * and outputs of child_pb_graph_node
   *   child_pb_graph_node.output_pins -----------------> physical_pb_graph_node.outpins
   *                                        /|\
   *                                         |
   *                         input_pins,   edges,       output_pins
   * Note: it is not applied to primitive pb_type!
   */ 
  build_physical_block_interc_port_bitstream(bitstream_manager, parent_configurable_block,
                                             module_manager, circuit_lib, mux_lib, 
                                             atom_ctx, device_annotation, 
                                             physical_pb_graph_node, physical_pb,  
                                             CIRCUIT_PB_PORT_OUTPUT, physical_mode);
 
  /* We check input_pins of child_pb_graph_node and its the input_edges
   * Iterate over the interconnections between inputs of physical_pb_graph_node 
   * and inputs of child_pb_graph_node
   *   physical_pb_graph_node.input_pins -----------------> child_pb_graph_node.input_pins
   *                                        /|\
   *                                         |
   *                         input_pins,   edges,       output_pins
   */ 
  for (int ipb = 0; ipb < physical_mode->num_pb_type_children; ipb++) {
    for (int jpb = 0; jpb < physical_mode->pb_type_children[ipb].num_pb; jpb++) {
      t_pb_graph_node* child_pb_graph_node = &(physical_pb_graph_node->child_pb_graph_nodes[physical_mode->index][ipb][jpb]);

      /* For each child_pb_graph_node input pins*/
      build_physical_block_interc_port_bitstream(bitstream_manager, parent_configurable_block,
                                                 module_manager, circuit_lib, mux_lib, 
                                                 atom_ctx, device_annotation, 
                                                 child_pb_graph_node, physical_pb,  
                                                 CIRCUIT_PB_PORT_INPUT, physical_mode);
      /* For clock pins, we should do the same work */
      build_physical_block_interc_port_bitstream(bitstream_manager, parent_configurable_block,
                                                 module_manager, circuit_lib, mux_lib, 
                                                 atom_ctx, device_annotation, 
                                                 child_pb_graph_node, physical_pb,  
                                                 CIRCUIT_PB_PORT_CLOCK, physical_mode);
    }
  }
}

/********************************************************************
 * Generate bitstream for a LUT and add it to bitstream manager
 * This function supports both single-output and fracturable LUTs
 *******************************************************************/
static 
void build_lut_bitstream(BitstreamManager& bitstream_manager,
                         const ConfigBlockId& parent_configurable_block,
                         const VprDeviceAnnotation& device_annotation,
                         const ModuleManager& module_manager,
                         const CircuitLibrary& circuit_lib,
                         const MuxLibrary& mux_lib,
                         const PhysicalPb& physical_pb,
                         const PhysicalPbId& lut_pb_id,
                         t_pb_type* lut_pb_type) {

  /* Ensure a valid physical pritimive pb */ 
  if (nullptr == lut_pb_type) {
    VTR_LOGF_ERROR(__FILE__, __LINE__,
                   "Invalid lut_pb_type!\n");
    exit(1);
  }

  CircuitModelId lut_model = device_annotation.pb_type_circuit_model(lut_pb_type);
  VTR_ASSERT(CircuitModelId::INVALID() != lut_model);
  VTR_ASSERT(CIRCUIT_MODEL_LUT == circuit_lib.model_type(lut_model));

  /* Find the input ports for LUT size, this is used to decode the LUT memory bits! */
  std::vector<CircuitPortId> model_input_ports = circuit_lib.model_ports_by_type(lut_model, CIRCUIT_MODEL_PORT_INPUT, true);
  VTR_ASSERT(1 == model_input_ports.size());
  size_t lut_size = circuit_lib.port_size(model_input_ports[0]);

  /* Find SRAM ports for truth tables and mode-selection */
  std::vector<CircuitPortId> lut_regular_sram_ports = find_circuit_regular_sram_ports(circuit_lib, lut_model);
  std::vector<CircuitPortId> lut_mode_select_ports = find_circuit_mode_select_sram_ports(circuit_lib, lut_model);
  /* We should always 1 regular sram port, where truth table is loaded to */
  VTR_ASSERT(1 == lut_regular_sram_ports.size());
  /* We may have a port for mode select or not. This depends on if the LUT is fracturable or not */
  VTR_ASSERT( (0 == lut_mode_select_ports.size())
           || (1 == lut_mode_select_ports.size()) );

  std::vector<bool> lut_bitstream;
  /* Generate bitstream for the LUT */ 
  if (false == physical_pb.valid_pb_id(lut_pb_id)) {
    /* An empty pb means that this is an unused LUT, 
     * we give an empty truth table, which are full of default values (defined by users) 
     */
    for (size_t i = 0; i < circuit_lib.port_size(lut_regular_sram_ports[0]); ++i) {
      VTR_ASSERT( (0 == circuit_lib.port_default_value(lut_regular_sram_ports[0]))
               || (1 == circuit_lib.port_default_value(lut_regular_sram_ports[0])) );
      lut_bitstream.push_back(1 == circuit_lib.port_default_value(lut_regular_sram_ports[0]));
    }
  } else { 
    VTR_ASSERT(true == physical_pb.valid_pb_id(lut_pb_id));

    /* Find MUX graph correlated to the LUT */
    MuxId lut_mux_id = mux_lib.mux_graph(lut_model, (size_t)pow(2., lut_size)); 
    const MuxGraph& mux_graph = mux_lib.mux_graph(lut_mux_id);
    /* Ensure the LUT MUX has the expected input and SRAM port sizes */
    VTR_ASSERT(mux_graph.num_memory_bits() == lut_size);
    VTR_ASSERT(mux_graph.num_inputs() == (size_t)pow(2., lut_size));
    /* Generate LUT bitstream */
    lut_bitstream = build_frac_lut_bitstream(circuit_lib, mux_graph,
                                             device_annotation,
                                             physical_pb.truth_tables(lut_pb_id),
                                             circuit_lib.port_default_value(lut_regular_sram_ports[0]));
  }
  
  /* Generate bitstream for mode-select ports */
  if (0 != lut_mode_select_ports.size()) {
    std::vector<bool> mode_select_bitstream;
    if (true == physical_pb.valid_pb_id(lut_pb_id)) {
      mode_select_bitstream = generate_mode_select_bitstream(physical_pb.mode_bits(lut_pb_id));
    } else { /* get default mode_bits */
      mode_select_bitstream = generate_mode_select_bitstream(device_annotation.pb_type_mode_bits(lut_pb_type));
    }
    /* Conjunct the mode-select bitstream to the lut bitstream */
    for (const bool& bit : mode_select_bitstream) {
      lut_bitstream.push_back(bit);
    }
  }

  /* Ensure the length of bitstream matches the side of memory circuits */
  std::vector<CircuitModelId> sram_models = find_circuit_sram_models(circuit_lib, lut_model);
  VTR_ASSERT(1 == sram_models.size());
  std::string mem_block_name = generate_memory_module_name(circuit_lib, lut_model, sram_models[0], std::string(MEMORY_MODULE_POSTFIX));
  ModuleId mem_module = module_manager.find_module(mem_block_name);
  VTR_ASSERT (true == module_manager.valid_module_id(mem_module));
  ModulePortId mem_out_port_id = module_manager.find_module_port(mem_module, generate_configurable_memory_data_out_name());
  VTR_ASSERT(lut_bitstream.size() == module_manager.module_port(mem_module, mem_out_port_id).get_width());

  /* Create a block for the bitstream which corresponds to the memory module associated to the LUT */
  ConfigBlockId mem_block = bitstream_manager.add_block(mem_block_name);
  bitstream_manager.add_child_block(parent_configurable_block, mem_block);

  /* Add the bitstream to the bitstream manager */
  bitstream_manager.add_block_bits(mem_block, lut_bitstream);
}

/********************************************************************
 * This function generates bitstream for a physical block, which is 
 * a child block of a grid 
 * This function will follow a recursive way in generating bitstreams
 * It will follow the same sequence in visiting all the sub blocks
 * in a physical as we did during module generation
 *
 * Note: if you want to bind your bitstream with a FPGA fabric generated by FPGA-X2P
 * Please follow the same sequence in visiting pb_graph nodes!!!
 * For more details, you may refer to function rec_build_physical_block_modules()
 *******************************************************************/
static 
void rec_build_physical_block_bitstream(BitstreamManager& bitstream_manager,
                                        const ConfigBlockId& parent_configurable_block,
                                        const ModuleManager& module_manager,
                                        const CircuitLibrary& circuit_lib,
                                        const MuxLibrary& mux_lib,
                                        const AtomContext& atom_ctx,
                                        const VprDeviceAnnotation& device_annotation,
                                        const e_side& border_side,
                                        const PhysicalPb& physical_pb, 
                                        const PhysicalPbId& pb_id, 
                                        t_pb_graph_node* physical_pb_graph_node,
                                        const size_t& pb_graph_node_index) {
  /* Get the physical pb_type that is linked to the pb_graph node */
  t_pb_type* physical_pb_type = physical_pb_graph_node->pb_type;

  /* Find the mode that define_idle_mode*/
  t_mode* physical_mode = device_annotation.physical_mode(physical_pb_type);

  /* Early exit if this parent module has no configurable child modules */
  std::string pb_module_name = generate_physical_block_module_name(physical_pb_type);
  ModuleId pb_module = module_manager.find_module(pb_module_name);
  VTR_ASSERT(true == module_manager.valid_module_id(pb_module));
 
  /* Skip module with no configurable children */
  if (0 == module_manager.configurable_children(pb_module).size()) {
    return;
  }

  /* Create a block for the physical block under the grid block in bitstream manager */
  std::string pb_block_name = generate_physical_block_instance_name(physical_pb_type, pb_graph_node_index);
  ConfigBlockId pb_configurable_block = bitstream_manager.add_block(pb_block_name);
  bitstream_manager.add_child_block(parent_configurable_block, pb_configurable_block);

  /* Reserve child blocks for new created block */
  bitstream_manager.reserve_child_blocks(parent_configurable_block,
                                         count_module_manager_module_configurable_children(module_manager, pb_module)); 

  /* Recursively finish all the child pb_types*/
  if (false == is_primitive_pb_type(physical_pb_type)) { 
    for (int ipb = 0; ipb < physical_mode->num_pb_type_children; ++ipb) {
      for (int jpb = 0; jpb < physical_mode->pb_type_children[ipb].num_pb; ++jpb) {
        PhysicalPbId child_pb = PhysicalPbId::INVALID();
        /* Find the child pb that is mapped, and the mapping info is not stored in the physical mode ! */
        if (true == physical_pb.valid_pb_id(pb_id)) {
          child_pb = physical_pb.child(pb_id, &(physical_mode->pb_type_children[ipb]), jpb);
          VTR_ASSERT(true == physical_pb.valid_pb_id(child_pb));
        }
        /* Go recursively */
        rec_build_physical_block_bitstream(bitstream_manager, pb_configurable_block,
                                           module_manager, circuit_lib, mux_lib, 
                                           atom_ctx,
                                           device_annotation, 
                                           border_side, 
                                           physical_pb, child_pb,
                                           &(physical_pb_graph_node->child_pb_graph_nodes[physical_mode->index][ipb][jpb]),
                                           jpb);
      }
    }
  }

  /* Check if this has defined a circuit_model*/
  if (true == is_primitive_pb_type(physical_pb_type)) { 
    CircuitModelId primitive_circuit_model = device_annotation.pb_type_circuit_model(physical_pb_type);
    VTR_ASSERT(CircuitModelId::INVALID() != primitive_circuit_model);
    switch (circuit_lib.model_type(primitive_circuit_model)) {
    case CIRCUIT_MODEL_LUT: 
      /* Special case for LUT !!!
       * Mapped logical block information is stored in child_pbs of this pb!!!
       */
      build_lut_bitstream(bitstream_manager, pb_configurable_block,
                          device_annotation, 
                          module_manager, circuit_lib, mux_lib, 
                          physical_pb, pb_id, physical_pb_type);
      break;
    case CIRCUIT_MODEL_FF:
    case CIRCUIT_MODEL_HARDLOGIC:
    case CIRCUIT_MODEL_IOPAD:
      /* For other types of blocks, we can apply a generic therapy */
      build_primitive_bitstream(bitstream_manager, pb_configurable_block,
                                module_manager, circuit_lib, device_annotation, 
                                physical_pb, pb_id, physical_pb_type);
      break;  
    default:
      VTR_LOGF_ERROR(__FILE__, __LINE__, 
                     "Unknown circuit model type of pb_type '%s'!\n",
                     physical_pb_type->name);
      exit(1);
    }
    /* Finish for primitive node, return */
    return;
  }

  /* Generate the bitstream for the interconnection in this physical block */
  build_physical_block_interc_bitstream(bitstream_manager, pb_configurable_block,
                                        module_manager, circuit_lib, mux_lib,
                                        atom_ctx,
                                        device_annotation,
                                        physical_pb_graph_node, physical_pb,
                                        physical_mode);
}

/********************************************************************
 * This function generates bitstream for a grid, which could be a
 * CLB, a heterogenerous block, an I/O, etc.
 * Note that each grid may contain a number of physical blocks,
 * this function will iterate over them
 *******************************************************************/
static 
void build_physical_block_bitstream(BitstreamManager& bitstream_manager,
                                    const ConfigBlockId& top_block,
                                    const ModuleManager& module_manager,
                                    const CircuitLibrary& circuit_lib,
                                    const MuxLibrary& mux_lib,
                                    const AtomContext& atom_ctx,
                                    const VprDeviceAnnotation& device_annotation,
                                    const VprClusteringAnnotation& cluster_annotation,
                                    const VprPlacementAnnotation& place_annotation,
                                    const DeviceGrid& grids,
                                    const vtr::Point<size_t>& grid_coord,
                                    const e_side& border_side) {
  /* Create a block for the grid in bitstream manager */
  t_physical_tile_type_ptr grid_type = grids[grid_coord.x()][grid_coord.y()].type;
  std::string grid_module_name_prefix(GRID_MODULE_NAME_PREFIX);

  /* Early exit if this parent module has no configurable child modules */
  std::string grid_module_name = generate_grid_block_module_name(grid_module_name_prefix, std::string(grid_type->name), 
                                                                 is_io_type(grid_type), border_side);
  ModuleId grid_module = module_manager.find_module(grid_module_name);
  VTR_ASSERT(true == module_manager.valid_module_id(grid_module));
 
  /* Skip module with no configurable children */
  if (0 == module_manager.configurable_children(grid_module).size()) {
    return;
  }

  std::string grid_block_name = generate_grid_block_instance_name(grid_module_name_prefix, std::string(grid_type->name), 
                                                                  is_io_type(grid_type), border_side, grid_coord);
  ConfigBlockId grid_configurable_block = bitstream_manager.add_block(grid_block_name);
  bitstream_manager.add_child_block(top_block, grid_configurable_block);

  /* Reserve child blocks for new created block */
  bitstream_manager.reserve_child_blocks(grid_configurable_block,
                                         count_module_manager_module_configurable_children(module_manager, grid_module)); 

  /* Iterate over the capacity of the grid
   * Now each physical tile may have a number of logical blocks
   * OpenFPGA only considers the physical implementation of the tiles.
   * So, we do not allow multiple equivalent sites to be defined 
   * under a physical tile type. 
   * If you need different equivalent sites, you can always define 
   * it as a mode under a <pb_type>
   */
  for (size_t z = 0; z < place_annotation.grid_blocks(grid_coord).size(); ++z) {
    VTR_ASSERT(1 == grid_type->equivalent_sites.size());
    for (t_logical_block_type_ptr lb_type : grid_type->equivalent_sites) {
      /* Bypass empty pb_graph */
      if (nullptr == lb_type->pb_graph_head) {
        continue;
      }

      if (ClusterBlockId::INVALID() == place_annotation.grid_blocks(grid_coord)[z]) {
        /* Recursively traverse the pb_graph and generate bitstream */
        rec_build_physical_block_bitstream(bitstream_manager, grid_configurable_block, 
                                           module_manager, circuit_lib, mux_lib, 
                                           atom_ctx,
                                           device_annotation, border_side, 
                                           PhysicalPb(), PhysicalPbId::INVALID(),
                                           lb_type->pb_graph_head, z);
      } else {
        const PhysicalPb& phy_pb = cluster_annotation.physical_pb(place_annotation.grid_blocks(grid_coord)[z]);

        /* Get the top-level node of the pb_graph */
        t_pb_graph_node* pb_graph_head = lb_type->pb_graph_head;
        VTR_ASSERT(nullptr != pb_graph_head);
        const PhysicalPbId& top_pb_id = phy_pb.find_pb(pb_graph_head);

        /* Recursively traverse the pb_graph and generate bitstream */
        rec_build_physical_block_bitstream(bitstream_manager, grid_configurable_block, 
                                           module_manager, circuit_lib, mux_lib, 
                                           atom_ctx,
                                           device_annotation, border_side, 
                                           phy_pb, top_pb_id, pb_graph_head, z);
      }
    }
  } 
}


/********************************************************************
 * Top-level function of this file: 
 * Generate bitstreams for all the grids, including 
 * 1. core grids that sit in the center of the fabric
 * 2. side grids (I/O grids) that sit in the borders for the fabric
 *******************************************************************/
void build_grid_bitstream(BitstreamManager& bitstream_manager,
                          const ConfigBlockId& top_block,
                          const ModuleManager& module_manager,
                          const CircuitLibrary& circuit_lib,
                          const MuxLibrary& mux_lib,
                          const DeviceGrid& grids,
                          const AtomContext& atom_ctx,
                          const VprDeviceAnnotation& device_annotation,
                          const VprClusteringAnnotation& cluster_annotation,
                          const VprPlacementAnnotation& place_annotation,
                          const bool& verbose) {

  VTR_LOGV(verbose, "Generating bitstream for core grids...");

  /* Generate bitstream for the core logic block one by one */
  for (size_t ix = 1; ix < grids.width() - 1; ++ix) {
    for (size_t iy = 1; iy < grids.height() - 1; ++iy) {
      /* Bypass EMPTY grid */
      if (true == is_empty_type(grids[ix][iy].type)) {
        continue;
      } 
      /* Skip width > 1 or height > 1 tiles (mostly heterogeneous blocks) */
      if ( (0 < grids[ix][iy].width_offset)
        || (0 < grids[ix][iy].height_offset) ) {
        continue;
      }
      /* We should not meet any I/O grid */
      VTR_ASSERT(true != is_io_type(grids[ix][iy].type));
      /* Add a grid module to top_module*/
      vtr::Point<size_t> grid_coord(ix, iy);
      build_physical_block_bitstream(bitstream_manager, top_block, module_manager,
                                     circuit_lib, mux_lib,
                                     atom_ctx,
                                     device_annotation, cluster_annotation,
                                     place_annotation,
                                     grids, grid_coord, NUM_SIDES);
    }
  }
  VTR_LOGV(verbose, "Done\n");

  VTR_LOGV(verbose, "Generating bitstream for I/O grids...");

  /* Create the coordinate range for each side of FPGA fabric */
  std::vector<e_side> io_sides{TOP, RIGHT, BOTTOM, LEFT};
  std::map<e_side, std::vector<vtr::Point<size_t>>> io_coordinates;

  /* TOP side*/
  for (size_t ix = 1; ix < grids.width() - 1; ++ix) { 
    io_coordinates[TOP].push_back(vtr::Point<size_t>(ix, grids.height() - 1));
  } 

  /* RIGHT side */
  for (size_t iy = 1; iy < grids.height() - 1; ++iy) { 
    io_coordinates[RIGHT].push_back(vtr::Point<size_t>(grids.width() - 1, iy));
  } 

  /* BOTTOM side*/
  for (size_t ix = 1; ix < grids.width() - 1; ++ix) { 
    io_coordinates[BOTTOM].push_back(vtr::Point<size_t>(ix, 0));
  } 

  /* LEFT side */
  for (size_t iy = 1; iy < grids.height() - 1; ++iy) { 
    io_coordinates[LEFT].push_back(vtr::Point<size_t>(0, iy));
  }

  /* Add instances of I/O grids to top_module */
  for (const e_side& io_side : io_sides) {
    for (const vtr::Point<size_t>& io_coordinate : io_coordinates[io_side]) {
      /* Bypass EMPTY grid */
      if (true == is_empty_type(grids[io_coordinate.x()][io_coordinate.y()].type)) {
        continue;
      } 
      /* Skip height > 1 tiles (mostly heterogeneous blocks) */
      if ( (0 < grids[io_coordinate.x()][io_coordinate.y()].width_offset)
        || (0 < grids[io_coordinate.x()][io_coordinate.y()].height_offset) ) {
        continue;
      }
      build_physical_block_bitstream(bitstream_manager, top_block, module_manager,
                                     circuit_lib, mux_lib,
                                     atom_ctx,
                                     device_annotation, cluster_annotation, 
                                     place_annotation,
                                     grids, io_coordinate, io_side);
    }
  }
  VTR_LOGV(verbose, "Done\n");
}

} /* end namespace openfpga */