[SQUASHME] More code polish

Author: AmirhosseinPoolad

libs/libarchfpga/src/interposer_types.h

@@ -1,33 +1,51 @@
 #pragma once
 
+/**
+ * @file interposer_types.h
+ * @brief This file contains types used for parsing interposer-related tags such as <interposer_cut> and <interdie_wire>
+ * and converting that information into the device architecture-related data structures.
+ * 
+ */
+
 #include <unordered_map>
 #include <vector>
 #include <string>
-#include "vtr_vector.h"
 
+/**
+ * @brief Enum for direction of an interposer cut. X means horizontal cut and Y means vertical cut.
+ * 
+ */
 enum class e_interposer_cut_dim {
     X,
     Y
 };
 
+// Lookup table for converting between a character and an e_interposer_cut_dim
 inline const std::unordered_map<char, e_interposer_cut_dim> CHAR_INTERPOSER_DIM_MAP = {
     {'X', e_interposer_cut_dim::X},
     {'x', e_interposer_cut_dim::X},
     {'Y', e_interposer_cut_dim::Y},
     {'y', e_interposer_cut_dim::Y}};
 
+/**
+ * @brief Struct containing information of interdire wires i.e. connections between the dies on an interposer
+ * 
+ */
 struct t_interdie_wire_inf {
-    std::string sg_name;
-    std::string sg_offset;
-    int offset_start;
-    int offset_end;
-    int offset_incr;
-    int offset_num;
+    std::string sg_name;  ///< Name of the scatter-gather pattern to be used for the interdie connection
+    std::string sg_link;  ///< Name of the scatter-gather link to be used for the interdie connection
+    int offset_start;     ///< Starting point of scatter-gather instantiations
+    int offset_end;       ///< Ending point of scatter-gather instantiations
+    int offset_increment; ///< Increment/distance between scatter-gather instantiations
+    int num;              ///< Number of scatter-gather instantiations per switchblock location
 };
 
+/**
+ * @brief Struct containing information of an interposer cut
+ * 
+ */
 struct t_interposer_cut_inf {
-    e_interposer_cut_dim dim; // find an enum with x and y
-    int loc; // handle expressions
-    std::vector<t_interdie_wire_inf> interdie_wires;
+    e_interposer_cut_dim dim;                        ///< Dimension or axis of interposer cut
+    int loc;                                         ///< Location of the cut on the grid
+    std::vector<t_interdie_wire_inf> interdie_wires; ///< Connectivity specification between the two sides of the cut
 };
-

libs/libarchfpga/src/physical_types.h

@@ -36,6 +36,7 @@
 #include <limits>
 #include <unordered_set>
 
+#include "interposer_types.h"
 #include "vtr_ndmatrix.h"
 #include "vtr_bimap.h"
 #include "vtr_string_interning.h"
@@ -361,13 +362,14 @@ struct t_grid_loc_def {
                                      // that come from a common definition.
 };
 
-enum GridDefType {
+enum class GridDefType {
     AUTO,
     FIXED
 };
 
 struct t_layer_def {
-    std::vector<t_grid_loc_def> loc_defs; //The list of block location definitions for this layer specification
+    std::vector<t_grid_loc_def> loc_defs;              ///< List of block location definitions for this layer specification
+    std::vector<t_interposer_cut_inf> interposer_cuts; ///< List of interposer cuts in this layer
 };
 
 struct t_grid_def {

libs/libarchfpga/src/read_xml_arch_file.cpp

@@ -49,6 +49,7 @@
 #include "pugixml.hpp"
 #include "pugixml_util.hpp"
 
+#include "read_xml_arch_file_interposer.h"
 #include "read_xml_arch_file_vib.h"
 #include "vtr_assert.h"
 #include "vtr_log.h"
@@ -2620,7 +2621,7 @@ static t_grid_def process_grid_layout(vtr::string_internment& strings,
     if (has_layer) {
         // TODO ASSERT INTERPOSER
         std::unordered_set<int> seen_die_numbers; //Check that die numbers in the specific layout tag are unique
-        for (auto layer_child : layout_type_tag.children("layer")) {
+        for (pugi::xml_node layer_child : layout_type_tag.children("layer")) {
 
             // More than one layer tag is specified, meaning that multi-die FPGA is specified in the arch file
             // Need to process each <layer> tag children to get block types locations for each grid
@@ -2651,6 +2652,26 @@ static void process_block_type_locs(t_grid_def& grid_def,
     //Process all the block location specifications
     for (pugi::xml_node loc_spec_tag : layout_block_type_tag.children()) {
         const char* loc_type = loc_spec_tag.name();
+
+        // There are multiple attributes that are shared by every other tag that interposer
+        // tags do not have. For this reason we check if loc_spec_tag is an interposer tag
+        // and switch code paths if it is.
+        if (loc_type == std::string("interposer_cut")) {
+            if (grid_def.grid_type == GridDefType::AUTO) {
+                archfpga_throw(loc_data.filename_c_str(), loc_data.line(loc_spec_tag), "Interposers are not currently supported for auto sized devices.");
+            }
+
+            t_interposer_cut_inf interposer_cut = parse_interposer_cut_tag(loc_spec_tag, loc_data);
+            
+            if ((interposer_cut.dim == e_interposer_cut_dim::X && interposer_cut.loc >= grid_def.height) || (interposer_cut.dim == e_interposer_cut_dim::Y && interposer_cut.loc >= grid_def.width)) {
+                archfpga_throw(loc_data.filename_c_str(), loc_data.line(loc_spec_tag), "Interposer cut dimensions are outside of device bounds");
+            }
+            
+            grid_def.layers.at(die_number).interposer_cuts.push_back(interposer_cut);
+            continue;
+        }
+
+        // Continue parsing for non-interposer tags
         const char* type_name = get_attribute(loc_spec_tag, "type", loc_data).value();
         int priority = get_attribute(loc_spec_tag, "priority", loc_data).as_int();
         t_metadata_dict meta = process_meta_data(strings, loc_spec_tag, loc_data);
@@ -2872,42 +2893,6 @@ static void process_block_type_locs(t_grid_def& grid_def,
             region.meta = region.owned_meta.get();
 
             grid_def.layers.at(die_number).loc_defs.emplace_back(std::move(region));
-        } else if (loc_type == std::string("interposer_cut")) {
-            t_interposer_cut_inf interposer;
-            pugiutil::expect_only_attributes(loc_spec_tag, {"dim", "loc"}, loc_data);
-
-            std::string interposer_dim = pugiutil::get_attribute(loc_spec_tag, "dim", loc_data).as_string();
-            if (interposer_dim.size() != 1 || !CHAR_INTERPOSER_DIM_MAP.contains(interposer_dim[0])) {
-                archfpga_throw(loc_data.filename_c_str(), loc_data.line(loc_spec_tag), "Interposer tag dimension must be a single character of either X, x, Y or y.");
-            }
-
-            interposer.dim = CHAR_INTERPOSER_DIM_MAP.at(interposer_dim[0]);
-
-            interposer.loc = pugiutil::get_attribute(loc_spec_tag, "loc", loc_data).as_int();
-            if (interposer.loc < 0) {
-                // TODO: should also check if it's inside device bounds
-                archfpga_throw(loc_data.filename_c_str(), loc_data.line(loc_spec_tag), "Interposer location must be positive.");
-            }
-
-            pugiutil::expect_only_children(loc_spec_tag, {"interdie_wire"}, loc_data);
-
-            for (pugi::xml_node interdie_wire_tag : loc_spec_tag.children()) {
-                pugiutil::expect_only_attributes(interdie_wire_tag, {"sg", "sg_offset"}, loc_data);
-
-                t_interdie_wire_inf interdie_wire;
-
-                interdie_wire.sg_name = pugiutil::get_attribute(interdie_wire_tag, "sg_name", loc_data).as_string();
-                interdie_wire.sg_offset = pugiutil::get_attribute(interdie_wire_tag, "sg_offset", loc_data).as_string();
-                interdie_wire.offset_start = pugiutil::get_attribute(interdie_wire_tag, "offset_start", loc_data).as_int();
-                interdie_wire.offset_end = pugiutil::get_attribute(interdie_wire_tag, "offset_end", loc_data).as_int();
-                interdie_wire.offset_incr = pugiutil::get_attribute(interdie_wire_tag, "offset_incr", loc_data).as_int();
-                interdie_wire.offset_num = pugiutil::get_attribute(interdie_wire_tag, "offset_num", loc_data).as_int();
-
-                interposer.interdie_wires.push_back(interdie_wire);
-            }
-
-            //TODO: save interposer somewhere (need to add *arch to this function's args)
-
         } else {
             archfpga_throw(loc_data.filename_c_str(), loc_data.line(loc_spec_tag),
                            vtr::string_fmt("Unrecognized grid location specification type '%s'\n", loc_type).c_str());

libs/libarchfpga/src/read_xml_arch_file_interposer.cpp

@@ -0,0 +1,44 @@
+#include "read_xml_arch_file_interposer.h"
+#include <vector>
+#include "interposer_types.h"
+#include "read_xml_util.h"
+#include "pugixml_util.hpp"
+#include "arch_error.h"
+
+t_interposer_cut_inf parse_interposer_cut_tag(pugi::xml_node interposer_cut_tag, const pugiutil::loc_data& loc_data) {
+    t_interposer_cut_inf interposer;
+
+    pugiutil::expect_only_attributes(interposer_cut_tag, {"dim", "loc"}, loc_data);
+
+    std::string interposer_dim = pugiutil::get_attribute(interposer_cut_tag, "dim", loc_data).as_string();
+    if (interposer_dim.size() != 1 || !CHAR_INTERPOSER_DIM_MAP.contains(interposer_dim[0])) {
+        archfpga_throw(loc_data.filename_c_str(), loc_data.line(interposer_cut_tag), "Interposer tag dimension must be a single character of either X, x, Y or y.");
+    }
+
+    interposer.dim = CHAR_INTERPOSER_DIM_MAP.at(interposer_dim[0]);
+
+    interposer.loc = pugiutil::get_attribute(interposer_cut_tag, "loc", loc_data).as_int();
+    if (interposer.loc < 0) {
+        archfpga_throw(loc_data.filename_c_str(), loc_data.line(interposer_cut_tag), "Interposer location must be positive.");
+    }
+
+    pugiutil::expect_only_children(interposer_cut_tag, {"interdie_wire"}, loc_data);
+
+    for (pugi::xml_node interdie_wire_tag : interposer_cut_tag.children()) {
+        const std::vector<std::string> interdie_wire_attributes = {{"sg", "sg_link", "offset_start", "offset_end", "offset_increment", "num"}};
+        pugiutil::expect_only_attributes(interdie_wire_tag, interdie_wire_attributes, loc_data);
+
+        t_interdie_wire_inf interdie_wire;
+
+        interdie_wire.sg_name = pugiutil::get_attribute(interdie_wire_tag, "sg_name", loc_data).as_string();
+        interdie_wire.sg_link = pugiutil::get_attribute(interdie_wire_tag, "sg_link", loc_data).as_string();
+        interdie_wire.offset_start = pugiutil::get_attribute(interdie_wire_tag, "offset_start", loc_data).as_int();
+        interdie_wire.offset_end = pugiutil::get_attribute(interdie_wire_tag, "offset_end", loc_data).as_int();
+        interdie_wire.offset_increment = pugiutil::get_attribute(interdie_wire_tag, "offset_increment", loc_data).as_int();
+        interdie_wire.num = pugiutil::get_attribute(interdie_wire_tag, "num", loc_data).as_int();
+
+        interposer.interdie_wires.push_back(interdie_wire);
+    }
+
+    return interposer;
+}

libs/libarchfpga/src/read_xml_arch_file_interposer.h

@@ -0,0 +1,19 @@
+#pragma once
+
+/**
+ * @file read_xml_arch_file_interposer.h
+ * @brief This file contains functions related to parsing and processing interposer tags in the architecture file
+ * 
+ */
+
+#include "interposer_types.h"
+#include "read_xml_util.h"
+
+/**
+ * @brief Parse an <interposer_cut> tag and its children
+ * 
+ * @param interposer_cut_tag xml_node pointing to the <interposer_cut> tag
+ * @param loc_data Points to the location in the architecture file where the parser is reading. Used for priting error messages.
+ * @return t_interposer_cut_inf with parsed information of the <interposer_cut> tag
+ */
+t_interposer_cut_inf parse_interposer_cut_tag(pugi::xml_node interposer_cut_tag, const pugiutil::loc_data& loc_data);