Allow parsing multiple XDC files

Signed-off-by: Krzysztof Boronski <[email protected]>

Author: kboronski-ant

vpr/src/base/SetupVPR.cpp

@@ -97,7 +97,7 @@ void SetupVPR(const t_options* Options,
     FileNameOpts->CmosTechFile = Options->CmosTechFile;
     FileNameOpts->out_file_prefix = Options->out_file_prefix;
     FileNameOpts->read_vpr_constraints_file = Options->read_vpr_constraints_file;
-    FileNameOpts->read_xdc_constraints_file = Options->XDCFile;
+    FileNameOpts->read_xdc_constraints_files = Options->XDCFiles;
     FileNameOpts->write_vpr_constraints_file = Options->write_vpr_constraints_file;
     FileNameOpts->write_block_usage = Options->write_block_usage;
 
@@ -119,7 +119,7 @@ void SetupVPR(const t_options* Options,
                             Arch,
                             device_ctx.physical_tile_types,
                             device_ctx.logical_block_types);
-                VTR_ASSERT_MSG(Options->XDCFile.value() != "", "XDC constraints are not supported for VTR format");
+                VTR_ASSERT_MSG(Options->XDCFiles.value().size() != 0, "XDC constraints are not supported for VTR format");
                 break;
             case e_arch_format::FPGAInterchange:
                 VTR_LOG("Use FPGA Interchange device\n");

vpr/src/base/read_options.cpp

@@ -1517,8 +1517,10 @@ argparse::ArgumentParser create_arg_parser(std::string prog_name, t_options& arg
     file_grp.add_argument(args.SDCFile, "--sdc_file")
         .help("Path to timing constraints file in SDC format")
         .show_in(argparse::ShowIn::HELP_ONLY);
-    
-    file_grp.add_argument(args.XDCFile, "--xdc_file")
+
+    file_grp.add_argument(args.XDCFiles, "--xdc_files")
+        .nargs('+')
+        .default_value({})
         .help("Path to Xilinx's Design Constraints file")
         .show_in(argparse::ShowIn::HELP_ONLY);
 

vpr/src/base/read_options.h

@@ -19,7 +19,7 @@ struct t_options {
     argparse::ArgValue<std::string> PowerFile;
     argparse::ArgValue<std::string> CmosTechFile;
     argparse::ArgValue<std::string> SDCFile;
-    argparse::ArgValue<std::string> XDCFile;
+    argparse::ArgValue<std::vector<std::string>> XDCFiles;
 
     argparse::ArgValue<e_arch_format> arch_format;
     argparse::ArgValue<e_circuit_format> circuit_format;

vpr/src/base/vpr_api.cpp

@@ -170,7 +170,6 @@ void vpr_initialize_logging() {
  * 4. Sanity check all three
  */
 void vpr_init(const int argc, const char** argv, t_options* options, t_vpr_setup* vpr_setup, t_arch* arch) {
-    
     vpr_initialize_logging();
 
     /* Print title message */
@@ -348,9 +347,9 @@ void vpr_init_with_options(const t_options* options, t_vpr_setup* vpr_setup, t_a
     auto& filename_opts = vpr_setup->FileNameOpts;
     if (!filename_opts.read_vpr_constraints_file.empty())
         load_vpr_constraints_file(filename_opts.read_vpr_constraints_file.c_str());
-    if (!filename_opts.read_xdc_constraints_file.empty()) {
+    if (filename_opts.read_xdc_constraints_files.size()) {
         try {
-            load_xdc_constraints_file(filename_opts.read_xdc_constraints_file.c_str(), *arch, atom_ctx.nlist);
+            load_xdc_constraints_files(filename_opts.read_xdc_constraints_files, *arch, atom_ctx.nlist);
         } catch (const TCL_eErroneousTCL& e) {
             vpr_throw(VPR_ERROR_XDC, e.filename.c_str(), e.line, e.message.c_str());
         } catch (const TCL_eException& e) {

vpr/src/base/vpr_types.h

@@ -721,7 +721,7 @@ struct t_file_name_opts {
     std::string CmosTechFile;
     std::string out_file_prefix;
     std::string read_vpr_constraints_file;
-    std::string read_xdc_constraints_file;
+    std::vector<std::string> read_xdc_constraints_files;
     std::string write_vpr_constraints_file;
     std::string write_block_usage;
     bool verify_file_digests;

vpr/src/base/xdc_constraints.cpp

@@ -243,7 +243,7 @@ REGISTER_TCL_TYPE_W_STR_UPDATE(AtomPortId)
 }
 END_REGISTER_TCL_TYPE;
 
-VprConstraints read_xdc_constraints_to_vpr(std::istream& xdc_stream, const t_arch& arch, AtomNetlist& netlist) {
+VprConstraints read_xdc_constraints_to_vpr(std::vector<XDCStream>&& xdc_streams, const t_arch& arch, AtomNetlist& netlist) {
     VprConstraints constraints;
     TclPhysicalConstraintsClient pc_client(constraints, arch, netlist);
 
@@ -269,25 +269,30 @@ VprConstraints read_xdc_constraints_to_vpr(std::istream& xdc_stream, const t_arc
         ctx.add_tcl_type<AtomPortId>();
         ctx.add_tcl_client<TclPhysicalConstraintsClient>(pc_client);
 
-        /* Read and interpret XDC */
-        ctx.read_tcl(xdc_stream);
+        /* Read and interpret XDCs */
+        for (auto& stream : xdc_streams) {
+            try {
+                ctx.read_tcl(*stream.stream);
+            } catch (TCL_eErroneousTCL& e) {
+                e.filename = stream.name;
+                throw e;
+            }
+        }
     });
 
     /* At this point `pc_client` has written the contraints */
     return constraints;
 }
 
-void load_xdc_constraints_file(const char* read_xdc_constraints_name, const t_arch& arch, AtomNetlist& netlist) {
-    VTR_ASSERT(vtr::check_file_name_extension(read_xdc_constraints_name, ".xdc"));
-    VTR_LOG("Reading XDC %s...\n", read_xdc_constraints_name);
+void load_xdc_constraints_files(const std::vector<std::string> xdc_paths, const t_arch& arch, AtomNetlist& netlist) {
+    std::vector<XDCStream> xdc_streams;
+    for (auto&& path : xdc_paths) {
+        VTR_ASSERT(vtr::check_file_name_extension(path.c_str(), ".xdc"));
+        VTR_LOG("Reading XDC %s...\n", path.c_str());
+        auto file = std::unique_ptr<std::istream>(new std::ifstream(path));
+        xdc_streams.push_back(XDCStream(std::move(path), std::move(file)));
+    }
 
-    std::ifstream file(read_xdc_constraints_name);
     FloorplanningContext& floorplanning_ctx = g_vpr_ctx.mutable_floorplanning();
-
-    try {
-        floorplanning_ctx.constraints = read_xdc_constraints_to_vpr(file, arch, netlist);
-    } catch (TCL_eErroneousTCL& e) {
-        e.filename = std::string(read_xdc_constraints_name);
-        throw e;
-    }
+    floorplanning_ctx.constraints = read_xdc_constraints_to_vpr(std::move(xdc_streams), arch, netlist);
 }

vpr/src/base/xdc_constraints.h

@@ -2,11 +2,24 @@
 #define XDC_CONSTRAINTS_H
 
 #include <string>
+#include <vector>
+#include <memory>
+#include <iostream>
 
 #include "atom_netlist.h"
 #include "physical_types.h"
 #include "vpr_constraints.h"
 
+class XDCStream {
+  public:
+    inline XDCStream(std::string name_, std::unique_ptr<std::istream>&& stream_)
+        : name(name_)
+        , stream(std::move(stream_)) {}
+
+    std::string name;
+    std::unique_ptr<std::istream> stream;
+};
+
 /**
  * @brief Creates VprConstraints from input stream in XDC format.
  * @param xdc_stream XDC script
@@ -20,11 +33,11 @@
  * 
  * This function may modify the netlist by changing its blocks' properties.
  */
-VprConstraints read_xdc_constraints_to_vpr(std::istream& xdc_stream, const t_arch& arch, AtomNetlist& netlist);
+VprConstraints read_xdc_constraints_to_vpr(std::vector<XDCStream>& xdc_streams, const t_arch& arch, AtomNetlist& netlist);
 
 /**
  * @brief Parse a file in XDC format and apply it to global FloorplanningContext.
- * @param read_xdc_constraints_name path to an XDC file with constraints
+ * @param xdc_paths paths to XDC files with constraints
  * @param arch reference to loaded device architecture
  * @param netlist loaded AtomNetlist
  * @throws TCL_eException: base class for all exceptions
@@ -35,6 +48,6 @@ VprConstraints read_xdc_constraints_to_vpr(std::istream& xdc_stream, const t_arc
  * This function overwrites global floorplanning constraints (g_vpr.constraints_.constraints)\
  * This function may modify the netlist by changing its blocks' properties.
  */
-void load_xdc_constraints_file(const char* read_xdc_constraints_name, const t_arch& arch, AtomNetlist& netlist);
+void load_xdc_constraints_files(const std::vector<std::string> xdc_paths, const t_arch& arch, AtomNetlist& netlist);
 
 #endif