Changed comments and created new golden result for one of the nightly reg tests

Author: sfkhalid

vpr/src/base/read_place.cpp

@@ -32,15 +32,16 @@ void read_place(
     const char* net_file,
     const char* place_file,
     bool verify_file_digests,
-    const DeviceGrid& grid,
-    bool is_place_file) {
+    const DeviceGrid& grid) {
     std::ifstream fstream(place_file);
     if (!fstream) {
         VPR_FATAL_ERROR(VPR_ERROR_PLACE_F,
                         "'%s' - Cannot open place file.\n",
                         place_file);
     }
 
+    bool is_place_file = true;
+
     VTR_LOG("Reading %s.\n", place_file);
     VTR_LOG("\n");
 
@@ -51,15 +52,16 @@ void read_place(
     VTR_LOG("\n");
 }
 
-void read_constraints(const char* constraints_file,
-                      bool is_place_file) {
+void read_constraints(const char* constraints_file) {
     std::ifstream fstream(constraints_file);
     if (!fstream) {
         VPR_FATAL_ERROR(VPR_ERROR_PLACE_F,
                         "'%s' - Cannot open constraints file.\n",
                         constraints_file);
     }
 
+    bool is_place_file = false;
+
     VTR_LOG("Reading %s.\n", constraints_file);
     VTR_LOG("\n");
 
@@ -226,13 +228,16 @@ void read_place_body(std::ifstream& placement_file,
                 if (atom_blk_id == AtomBlockId::INVALID()) {
                     VPR_THROW(VPR_ERROR_PLACE, "Block %s has an invalid name.\n", c_block_name);
                 } else {
-                    blk_id = atom_ctx.lookup.atom_clb(atom_blk_id);
+                    blk_id = atom_ctx.lookup.atom_clb(atom_blk_id); //getting the ClusterBlockId of the cluster that the atom is in
                 }
             }
 
-            //Check if block is listed twice in constraints file
-            if (seen_blocks[blk_id] != 0) {
-                VPR_THROW(VPR_ERROR_PLACE, "Block %s with ID %d is listed twice in the constraints file.\n", c_block_name, blk_id);
+            //Check if block is listed multiple times with conflicting locations in constraints file
+            if (seen_blocks[blk_id] > 0) {
+            	if (block_x != place_ctx.block_locs[blk_id].loc.x || block_y != place_ctx.block_locs[blk_id].loc.y || sub_tile_index != place_ctx.block_locs[blk_id].loc.sub_tile) {
+            		VPR_THROW(VPR_ERROR_PLACE, "The location of cluster %d is specified %d times in the constraints file with conflicting locations. \n"
+            				"Its location was last specified with block %s. \n", blk_id, seen_blocks[blk_id] + 1, c_block_name);
+            	}
             }
 
             //Check if block location is out of range of grid dimensions
@@ -260,14 +265,17 @@ void read_place_body(std::ifstream& placement_file,
             }
 
             //need to lock down blocks  and mark grid block usage if it is a constraints file
+            //for a place file, grid usage is marked during initial placement instead
             if (!is_place_file) {
                 place_ctx.block_locs[blk_id].is_fixed = true;
                 place_ctx.grid_blocks[block_x][block_y].blocks[sub_tile_index] = blk_id;
-                place_ctx.grid_blocks[block_x][block_y].usage++;
+                if (seen_blocks[blk_id] == 0) {
+                	place_ctx.grid_blocks[block_x][block_y].usage++;
+                }
             }
 
             //mark the block as seen
-            seen_blocks[blk_id] = 1;
+            seen_blocks[blk_id]++;
 
         } else {
             //Unrecognized
@@ -278,6 +286,7 @@ void read_place_body(std::ifstream& placement_file,
     }
 
     //For place files, check that all blocks have been read
+    //For constraints files, not all blocks need to be read
     if (is_place_file) {
         for (auto block_id : cluster_ctx.clb_nlist.blocks()) {
             if (seen_blocks[block_id] == 0) {
@@ -286,6 +295,7 @@ void read_place_body(std::ifstream& placement_file,
         }
     }
 
+    //Want to make a hash for place file to be used during routing for error checking
     if (is_place_file) {
         place_ctx.placement_id = vtr::secure_digest_file(place_file);
     }

vpr/src/base/read_place.h

@@ -2,21 +2,20 @@
 #define READ_PLACE_H
 
 /**
- * This function is used to read a placement file.
+ * This function is for reading a place file when placement is skipped.
+ * It takes in the current netlist file and grid dimensions to check that they match those that were used when placement was generated.
+ * The verify_file_hashes bool is used to decide whether to give a warning or an error if the netlist files do not match.
  */
 void read_place(
     const char* net_file,
     const char* place_file,
     bool verify_file_hashes,
-    const DeviceGrid& grid,
-    bool is_place_file);
+    const DeviceGrid& grid);
 
 /**
  * This function is used to read a constraints file that specifies the desired locations of blocks.
  */
-void read_constraints(
-    const char* constraints_file,
-    bool is_place_file);
+void read_constraints(const char* constraints_file);
 
 void print_place(const char* net_file,
                  const char* net_id,

vpr/src/base/vpr_api.cpp

@@ -661,10 +661,9 @@ void vpr_load_placement(t_vpr_setup& vpr_setup, const t_arch& arch) {
     const auto& device_ctx = g_vpr_ctx.device();
     auto& place_ctx = g_vpr_ctx.mutable_placement();
     const auto& filename_opts = vpr_setup.FileNameOpts;
-    bool is_a_placement_file = true;
 
     //Load an existing placement from a file
-    read_place(filename_opts.NetFile.c_str(), filename_opts.PlaceFile.c_str(), filename_opts.verify_file_digests, device_ctx.grid, is_a_placement_file);
+    read_place(filename_opts.NetFile.c_str(), filename_opts.PlaceFile.c_str(), filename_opts.verify_file_digests, device_ctx.grid);
 
     //Ensure placement macros are loaded so that they can be drawn after placement (e.g. during routing)
     place_ctx.pl_macros = alloc_and_load_placement_macros(arch.Directs, arch.num_directs);

vpr/src/place/initial_placement.cpp

@@ -451,8 +451,7 @@ void initial_placement(enum e_pad_loc_type pad_loc_type, const char* constraints
 
     /*Check whether the constraint file is NULL, if not, read in the block locations from the constraints file here*/
     if (strlen(constraints_file) != 0) {
-        bool is_a_place_file = false; //specifies that this is a constraints file, not a place file and should be read as such
-        read_constraints(constraints_file, is_a_place_file);
+        read_constraints(constraints_file);
     }
 
     initial_placement_pl_macros(MAX_NUM_TRIES_TO_PLACE_MACROS_RANDOMLY, free_locations);