OpenFPGA/libopenfpga/libfabrickey/src/read_xml_fabric_key.cpp

/********************************************************************
 * This file includes the top-level function of this library
 * which reads an XML of a fabric key to the associated
 * data structures
 *******************************************************************/
#include <string>

/* Headers from pugi XML library */
#include "pugixml.hpp"
#include "pugixml_util.hpp"

/* Headers from vtr util library */
#include "vtr_assert.h"
#include "vtr_time.h"

/* Headers from libarchfpga */
#include "arch_error.h"
#include "read_xml_util.h"

#include "read_xml_fabric_key.h"

/********************************************************************
 * Parse XML codes of a <key> to an object of FabricKey
 *******************************************************************/
static 
void read_xml_region_key(pugi::xml_node& xml_component_key,
                         const pugiutil::loc_data& loc_data,
                         FabricKey& fabric_key,
                         const FabricRegionId& fabric_region) {

  /* Find the id of component key */
  const size_t& id = get_attribute(xml_component_key, "id", loc_data).as_int();

  if (false == fabric_key.valid_key_id(FabricKeyId(id))) {
    archfpga_throw(loc_data.filename_c_str(), loc_data.line(xml_component_key),
                   "Invalid 'id' attribute '%d' (in total %lu keys)!\n",
                   id,
                   fabric_key.keys().size());
  }

  VTR_ASSERT_SAFE(true == fabric_key.valid_key_id(FabricKeyId(id)));

  /* If we have an alias, set the value as well */
  const std::string& alias = get_attribute(xml_component_key, "alias", loc_data, pugiutil::ReqOpt::OPTIONAL).as_string();
  if (!alias.empty()) {
    fabric_key.set_key_alias(FabricKeyId(id), alias);
  }

  /* If we have the alias set, name and valus are optional then 
   * Otherwise, they are mandatory attributes 
   */
  pugiutil::ReqOpt required_name_value = pugiutil::ReqOpt::OPTIONAL; 
  if (true == alias.empty()) {
    required_name_value = pugiutil::ReqOpt::REQUIRED;
  }

  const std::string& name = get_attribute(xml_component_key, "name", loc_data, required_name_value).as_string();
  const size_t& value = get_attribute(xml_component_key, "value", loc_data, required_name_value).as_int();
  
  fabric_key.set_key_name(FabricKeyId(id), name);
  fabric_key.set_key_value(FabricKeyId(id), value);
  fabric_key.add_key_to_region(fabric_region, FabricKeyId(id));

  /* Parse coordinates */
  vtr::Point<int> coord;
  coord.set_x(get_attribute(xml_component_key, "column", loc_data, pugiutil::ReqOpt::OPTIONAL).as_int(-1));
  coord.set_y(get_attribute(xml_component_key, "row", loc_data, pugiutil::ReqOpt::OPTIONAL).as_int(-1));
  /* Require positive coordinate all the time */
  if (!fabric_key.valid_key_coordinate(coord)) {
    archfpga_throw(loc_data.filename_c_str(), loc_data.line(xml_component_key),
                   "Invalid coordinate '(%d, %d)' which contain negative numbers\n",
                   coord.x(), coord.y());
  } else {
    fabric_key.set_key_coordinate(FabricKeyId(id), coord);
  }
}

/********************************************************************
 * Parse XML codes of a <key> to an object of FabricKey
 *******************************************************************/
static 
void read_xml_fabric_region(pugi::xml_node& xml_region,
                            const pugiutil::loc_data& loc_data,
                            FabricKey& fabric_key) {
  /* Find the unique id for the region */
  const FabricRegionId& region_id = FabricRegionId(get_attribute(xml_region, "id", loc_data).as_int());
  if (false == fabric_key.valid_region_id(region_id)) {
    archfpga_throw(loc_data.filename_c_str(), loc_data.line(xml_region),
                   "Invalid region id '%lu' (in total %lu regions)!\n",
                   size_t(region_id),
                   fabric_key.regions().size());
  }
  VTR_ASSERT_SAFE(true == fabric_key.valid_region_id(region_id));

  /* Reserve memory space for the keys in the region */
  size_t num_keys = std::distance(xml_region.children().begin(), xml_region.children().end());
  fabric_key.reserve_region_keys(region_id, num_keys);

  for (pugi::xml_node xml_key : xml_region.children()) {
    /* Error out if the XML child has an invalid name! */
    if (xml_key.name() != std::string("key")) {
      archfpga_throw(loc_data.filename_c_str(), loc_data.line(xml_region),
                     "Unexpected child '%s' in region '%lu', Region XML node can only contain keys!\n",
                     xml_key.name(),
                     size_t(region_id));
    }
    /* Parse the key for this region */
    read_xml_region_key(xml_key, loc_data, fabric_key, region_id);
  }
}

/********************************************************************
 * Parse XML codes about <fabric> to an object of FabricKey
 *******************************************************************/
FabricKey read_xml_fabric_key(const char* key_fname) {

  vtr::ScopedStartFinishTimer timer("Read Fabric Key");

  FabricKey fabric_key;

  /* Parse the file */
  pugi::xml_document doc;
  pugiutil::loc_data loc_data;

  try {
    loc_data = pugiutil::load_xml(doc, key_fname);

    pugi::xml_node xml_root = get_single_child(doc, "fabric_key", loc_data);

    size_t num_regions = std::distance(xml_root.children().begin(), xml_root.children().end());
    /* Reserve memory space for the region */
    fabric_key.reserve_regions(num_regions);
    for (size_t iregion = 0; iregion < num_regions; ++iregion) {
      fabric_key.create_region();
    }

    /* Reserve memory space for the keys */
    size_t num_keys = 0;

    for (pugi::xml_node xml_region : xml_root.children()) {
      /* Error out if the XML child has an invalid name! */
      if (xml_region.name() != std::string("region")) {
        bad_tag(xml_region, loc_data, xml_root, {"region"});
      }
      num_keys += std::distance(xml_region.children().begin(), xml_region.children().end());
    }

    fabric_key.reserve_keys(num_keys);
    for (size_t ikey = 0; ikey < num_keys; ++ikey) {
      fabric_key.create_key();
    }

    /* Iterate over the children under this node,
     * each child should be named after circuit_model
     */
    for (pugi::xml_node xml_region : xml_root.children()) {
      /* Error out if the XML child has an invalid name! */
      if (xml_region.name() != std::string("region")) {
        bad_tag(xml_region, loc_data, xml_root, {"region"});
      }
      read_xml_fabric_region(xml_region, loc_data, fabric_key);
    } 
  } catch (pugiutil::XmlError& e) {
    archfpga_throw(key_fname, e.line(),
                   "%s", e.what());
  }

  return fabric_key; 
}