Add netlist ID (SHA256) to .net output and verify when re-loading

Author: kmurray

vpr/SRC/base/atom_netlist.cpp

@@ -165,8 +165,9 @@ Container update_valid_refs(const Container& values, const vtr::vector_map<ValId
  *
  */
 
-AtomNetlist::AtomNetlist(std::string name)
+AtomNetlist::AtomNetlist(std::string name, std::string id)
     : netlist_name_(name)
+    , netlist_id_(id)
     , dirty_(false) {}
 
 /*
@@ -178,6 +179,10 @@ const std::string& AtomNetlist::netlist_name() const {
     return netlist_name_;
 }
 
+const std::string& AtomNetlist::netlist_id() const {
+    return netlist_id_;
+}
+
 bool AtomNetlist::is_dirty() const {
     return dirty_;
 }

vpr/SRC/base/atom_netlist.h

@@ -420,8 +420,9 @@ class AtomNetlist {
     public:
 
         //Constructs a netlist
-        // name - the name of the netlist
-        AtomNetlist(std::string name="");
+        // name: the name of the netlist (e.g. top-level module)
+        // id:   a unique identifier for the netlist (e.g. a secure digest of the input file)
+        AtomNetlist(std::string name="", std::string id="");
 
     public: //Public Accessors
         /*
@@ -430,6 +431,10 @@ class AtomNetlist {
         //Retrieve the name of the netlist
         const std::string&  netlist_name() const;
 
+        //Retrieve the unique identifier for this netlist
+        //This is typically a secure digest of the input file.
+        const std::string&  netlist_id() const;
+
         /*
          * Blocks
          */
@@ -838,6 +843,7 @@ class AtomNetlist {
 
         //Netlist data
         std::string                 netlist_name_;  //Name of the top-level netlist
+        std::string                 netlist_id_;    //Unique identifier for the netlist
         bool                        dirty_;         //Indicates the netlist has invalid entries from remove_*() functions
 
         //Block data

vpr/SRC/base/read_blif.cpp

@@ -32,6 +32,7 @@ using namespace std;
 #include "vtr_log.h"
 #include "vtr_logic.h"
 #include "vtr_time.h"
+#include "vtr_digest.h"
 
 #include "vpr_types.h"
 #include "vpr_error.h"
@@ -59,8 +60,9 @@ vtr::LogicValue to_vtr_logic_value(blifparse::LogicValue);
 
 struct BlifAllocCallback : public blifparse::Callback {
     public:
-        BlifAllocCallback(AtomNetlist& main_netlist, const t_model* user_models, const t_model* library_models)
+        BlifAllocCallback(AtomNetlist& main_netlist, const std::string netlist_id, const t_model* user_models, const t_model* library_models)
             : main_netlist_(main_netlist)
+            , netlist_id_(netlist_id)
             , user_arch_models_(user_models) 
             , library_arch_models_(library_models) {}
 
@@ -80,7 +82,7 @@ struct BlifAllocCallback : public blifparse::Callback {
         void begin_model(std::string model_name) override { 
             //Create a new model, and set it's name
 
-            blif_models_.emplace_back(model_name);
+            blif_models_.emplace_back(model_name, netlist_id_);
             blif_models_black_box_.emplace_back(false);
             ended_ = false;
         }
@@ -614,6 +616,7 @@ struct BlifAllocCallback : public blifparse::Callback {
         std::vector<bool> blif_models_black_box_;
 
         AtomNetlist& main_netlist_; //User object we fill
+        const std::string netlist_id_; //Unique identifier based on the contents of the blif file
         const t_model* user_arch_models_ = nullptr;
         const t_model* library_arch_models_ = nullptr;
 
@@ -637,9 +640,12 @@ vtr::LogicValue to_vtr_logic_value(blifparse::LogicValue val) {
 static AtomNetlist read_blif(const char *blif_file, 
                              const t_model *user_models, 
                              const t_model *library_models) {
+
+
     AtomNetlist netlist;
+    std::string netlist_id = vtr::secure_digest_file(blif_file);
 
-    BlifAllocCallback alloc_callback(netlist, user_models, library_models);
+    BlifAllocCallback alloc_callback(netlist, netlist_id, user_models, library_models);
     blifparse::blif_parse_filename(blif_file, alloc_callback);
 
     netlist.verify();

vpr/SRC/base/read_netlist.cpp

@@ -145,6 +145,23 @@ void read_netlist(const char *net_file, const t_arch* arch,
             }
         }
 
+        auto atom_netlist_id = top.attribute("atom_netlist_id");
+        if (atom_netlist_id) {
+            //Netlist file has an_atom netlist_id, make sure it is 
+            //consistent with the loaded atom netlist.
+            //
+            //Note that we currently don't require that the atom_netlist_id exists, 
+            //to remain compatible with old .net files
+            std::string atom_nl_id = atom_netlist_id.value();
+            if (atom_nl_id != g_atom_nl.netlist_id()) {
+                //TODO: make this configurable as warning or error
+                vpr_throw(VPR_ERROR_NET_F, netlist_file_name, loc_data.line(top),
+                        "Netlist was generated from a different atom netlist file (loaded atom netlist ID: %s, packed netlist atom netlist ID: %s)",
+                        atom_nl_id.c_str(),
+                        g_atom_nl.netlist_id().c_str());
+            }
+        }
+
         //Collect top level I/Os
         auto top_inputs = pugiutil::get_single_child(top, "inputs", loc_data);
         circuit_inputs = vtr::split(top_inputs.text().get());

vpr/SRC/pack/output_clustering.cpp

@@ -604,8 +604,8 @@ void output_clustering(t_block *clb, int num_clusters, const vector < vector <t_
 
 	fpout = fopen(out_fname, "w");
 
-	fprintf(fpout, "<block name=\"%s\" instance=\"FPGA_packed_netlist[0]\" architecture_id=\"%s\">\n",
-			out_fname, architecture_id.c_str());
+	fprintf(fpout, "<block name=\"%s\" instance=\"FPGA_packed_netlist[0]\" architecture_id=\"%s\" atom_netlist_id=\"%s\">\n",
+			out_fname, architecture_id.c_str(), g_atom_nl.netlist_id().c_str());
 	fprintf(fpout, "\t<inputs>\n\t\t");
 
 	column = 2 * TAB_LENGTH; /* Organize whitespace to ident data inside block */