Automatically generate floorplan test files after placement, and enhancements to cluster attraction groups

vpr/src/base/SetupVPR.cpp

@@ -609,6 +609,7 @@ static void SetupPlacerOpts(const t_options& Options, t_placer_opts* PlacerOpts)
     PlacerOpts->place_agent_algorithm = Options.place_agent_algorithm;
     PlacerOpts->place_constraint_expand = Options.place_constraint_expand;
     PlacerOpts->place_constraint_subtile = Options.place_constraint_subtile;
+    PlacerOpts->floorplan_split = Options.floorplan_split;
 }
 
 static void SetupAnalysisOpts(const t_options& Options, t_analysis_opts& analysis_opts) {

vpr/src/base/read_options.cpp

@@ -491,6 +491,45 @@ struct ParseFixPins {
     }
 };
 
+struct ParseFloorplanSplit {
+    ConvertedValue<constraints_split_factor> from_str(std::string str) {
+        ConvertedValue<constraints_split_factor> conv_value;
+        if (str == "halves")
+            conv_value.set_value(HALVES);
+        else if (str == "quadrants")
+            conv_value.set_value(QUADRANTS);
+        else if (str == "sixteenths")
+            conv_value.set_value(SIXTEENTHS);
+        else if (str == "one_spot")
+            conv_value.set_value(ONE_SPOT);
+        else {
+            std::stringstream msg;
+            msg << "Invalid conversion from '" << str << "' to constraints_split_factor (expected one of: " << argparse::join(default_choices(), ", ") << ")";
+            conv_value.set_error(msg.str());
+        }
+        return conv_value;
+    }
+
+    ConvertedValue<std::string> to_str(constraints_split_factor val) {
+        ConvertedValue<std::string> conv_value;
+        if (val == HALVES)
+            conv_value.set_value("halves");
+        else if (val == QUADRANTS)
+            conv_value.set_value("quadrants");
+        else if (val == SIXTEENTHS)
+            conv_value.set_value("sixteenths");
+        else {
+            VTR_ASSERT(val == ONE_SPOT);
+            conv_value.set_value("one_spot");
+        }
+        return conv_value;
+    }
+
+    std::vector<std::string> default_choices() {
+        return {"halves", "quadrants", "sixteenths", "one_spot"};
+    }
+};
+
 struct ParseClusterSeed {
     ConvertedValue<e_cluster_seed> from_str(std::string str) {
         ConvertedValue<e_cluster_seed> conv_value;
@@ -1950,6 +1989,11 @@ argparse::ArgumentParser create_arg_parser(std::string prog_name, t_options& arg
         .default_value("off")
         .show_in(argparse::ShowIn::HELP_ONLY);
 
+    place_grp.add_argument<constraints_split_factor, ParseFloorplanSplit>(args.floorplan_split, "--floorplan_split")
+        .help("Used to say how many partitions the floorplan constraints file should split the blocks into.")
+        .default_value("halves")
+        .choices({"halves", "quadrants", "sixteenths", "one_spot"})
+        .show_in(argparse::ShowIn::HELP_ONLY);
     /*
      * place_grp.add_argument(args.place_timing_cost_func, "--place_timing_cost_func")
      * .help(

vpr/src/base/read_options.h

@@ -133,6 +133,7 @@ struct t_options {
     argparse::ArgValue<float> place_crit_limit;
     argparse::ArgValue<int> place_constraint_expand;
     argparse::ArgValue<bool> place_constraint_subtile;
+    argparse::ArgValue<constraints_split_factor> floorplan_split;
 
     /* Timing-driven placement options only */
     argparse::ArgValue<float> PlaceTimingTradeoff;

vpr/src/base/region.cpp

@@ -55,6 +55,10 @@ bool Region::is_loc_in_reg(t_pl_loc loc) {
     return is_loc_in_reg;
 }
 
+bool regions_equal(Region r1, Region r2) {
+    return (r1.get_region_rect() == r2.get_region_rect() && r1.get_sub_tile() == r2.get_sub_tile());
+}
+
 bool do_regions_intersect(Region r1, Region r2) {
     bool intersect = true;
 

vpr/src/base/region.h

@@ -85,6 +85,15 @@ bool do_regions_intersect(Region r1, Region r2);
  */
 Region intersection(const Region& r1, const Region& r2);
 
+/**
+ * @brief Returns true if the two regions passed in have the same rectangle coordinates
+ * and subtile values, false otherwise. Used to determine whether two clusters have the
+ * same region after clustering.
+ *
+ *   @param r1, r2     The two regions to be checked for equality
+ */
+bool regions_equal(Region r1, Region r2);
+
 ///@brief Used to print data from a Region
 void print_region(FILE* fp, Region region);
 

vpr/src/base/vpr_api.cpp

@@ -632,7 +632,7 @@ bool vpr_place_flow(t_vpr_setup& vpr_setup, const t_arch& arch) {
 
     //Write out a vpr floorplanning constraints file if the option is specified
     if (!filename_opts.write_vpr_constraints_file.empty()) {
-        write_vpr_floorplan_constraints(filename_opts.write_vpr_constraints_file.c_str(), placer_opts.place_constraint_expand, placer_opts.place_constraint_subtile);
+        write_vpr_floorplan_constraints(filename_opts.write_vpr_constraints_file.c_str(), placer_opts.place_constraint_expand, placer_opts.place_constraint_subtile, placer_opts.floorplan_split);
     }
 
     return true;