Merge branch 'master' of https://github.com/verilog-to-routing/vtr-verilog-to-routing into subtile_pin_loc

Author: amin1377

doc/src/vpr/command_line_usage.rst

@@ -1324,6 +1324,14 @@ Analytical Placement is generally split into three stages:
 
     **Default:** ``auto``
 
+.. option:: --ap_high_fanout_threshold <int>
+
+    Defines the threshold for high fanout nets within AP flow.
+
+    Ignores the nets that have higher fanouts than the threshold for the analytical solver.
+
+    **Default:** ``256``
+
 .. option:: --ap_verbosity <int>
 
     Controls the verbosity of the AP flow output.

doc/src/vtr/run_vtr_flow.rst

@@ -90,6 +90,13 @@ Enable Synlig tool with the ``-DSYNLIG_SYSTEMVERILOG=ON`` compile flag for the P
 
 Will run the VTR flow (default configuration) with Yosys frontend using Parmys plugin as partial mapper. To utilize the Parmys plugin, the ``-DYOSYS_PARMYS_PLUGIN=ON`` compile flag should be passed while building the VTR project with Yosys as a frontend.
 
+.. code-block:: bash
+
+    # Using the Parmys (Partial Mapper for Yosys) plugin as partial mapper with include files
+    ./run_vtr_flow <path/to/Verilog/File> <path/to/arch/file> -include <path/to/include/directory>/*.v*
+
+Will run the VTR flow (default configuration) with Yosys frontend using Parmys plugin as partial mapper. In addition to the main circuit passed in with the architecture, it will also pass in every HDL file with the specified file type within the include directory.
+
 Detailed Command-line Options
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -123,6 +130,15 @@ Detailed Command-line Options
       * ``vpr``
 
     **Default:** ``vpr``
+    
+.. option:: -include <path_to_file(s)>/*.<file_type(s)>
+
+    List of include files to a benchmark circuit 
+    (pass to VTR frontends as a benchmark design set).
+    
+    Include files can be any file supported by yosys+parmys (normally .v or .vh files).
+    
+    The include directory should not contain the circuit passed in with the architecture.
 
 .. option:: -power
 

libs/libvtrutil/src/vtr_util.cpp

@@ -375,67 +375,6 @@ char* fgets(char* buf, int max_size, FILE* fp) {
     return nullptr;
 }
 
-/**
- * @brief to get an arbitrary long input line and cut off any
- * comment part 
- * 
- * the getline function is exaly like the __get_delim function 
- * in GNU with '\n' delimiter. As a result, to make the function 
- * behaviour identical for Windows (\r\n) and Linux (\n) compiler 
- * macros for checking operating systems have been used.
- * 
- * @note user need to take care of the given pointer,
- * which will be dynamically allocated by getdelim
- */
-char* getline(char*& _lineptr, FILE* _stream) {
-    int i;
-    int ch;
-    size_t _n = 0;
-    ssize_t nread;
-
-#if defined(__unix__)
-    nread = getdelim(&_lineptr, &_n, '\n', _stream);
-#elif defined(_WIN32)
-#define __WIN_NLTK "\r\n"
-    nread = getdelim(&_lineptr, &_n, __WIN_NLTK, _stream);
-#endif
-
-    if (nread == -1) {
-        int errsv = errno;
-        std::string error_msg;
-
-        if (errsv == EINVAL)
-            error_msg = string_fmt("[%s] Bad arguments (_lineptr is NULL, or _stream is not valid).", strerror(errsv));
-        else if (errsv == ENOMEM)
-            error_msg = string_fmt("[%s] Allocation or reallocation of the line buffer failed.", strerror(errsv));
-        else
-            /* end of file so it will return null */
-            return nullptr;
-
-        /* getline was unsuccessful, so error */
-        throw VtrError(string_fmt("Error -- %s\n",
-                                  error_msg.c_str()),
-                       __FILE__, __LINE__);
-        return nullptr;
-    }
-
-    cont = 0;           /* line continued? */
-    file_line_number++; /* global variable */
-
-    for (i = 0; i < nread; i++) { /* Keep going until the line finishes */
-
-        ch = _lineptr[i];
-
-        if (ch == '#') { /* comment */
-            _lineptr[i] = '\0';
-            /* skip the rest of the line */
-            break;
-        }
-    }
-
-    return (_lineptr);
-}
-
 ///@brief Returns line number of last opened and read file
 int get_file_line_number_of_last_opened_file() {
     return file_line_number;

vpr/src/analytical_place/analytical_placement_flow.cpp

@@ -170,6 +170,7 @@ void run_analytical_placement_flow(t_vpr_setup& vpr_setup) {
     const AtomNetlist& atom_nlist = g_vpr_ctx.atom().netlist();
     const DeviceContext& device_ctx = g_vpr_ctx.device();
     const UserPlaceConstraints& constraints = g_vpr_ctx.floorplanning().constraints;
+    const t_ap_opts& ap_opts = vpr_setup.APOpts;
 
     // Run the prepacker
     const Prepacker prepacker(atom_nlist, device_ctx.arch->models, device_ctx.logical_block_types);
@@ -178,7 +179,8 @@ void run_analytical_placement_flow(t_vpr_setup& vpr_setup) {
     // prepacker.
     APNetlist ap_netlist = gen_ap_netlist_from_atoms(atom_nlist,
                                                      prepacker,
-                                                     constraints);
+                                                     constraints,
+                                                     ap_opts.ap_high_fanout_threshold);
     print_ap_netlist_stats(ap_netlist);
 
     // Pre-compute the pre-clustering timing delays. This object will be passed
@@ -208,7 +210,6 @@ void run_analytical_placement_flow(t_vpr_setup& vpr_setup) {
     }
 
     // Run the Global Placer.
-    const t_ap_opts& ap_opts = vpr_setup.APOpts;
     PartialPlacement p_placement = run_global_placer(ap_opts,
                                                      atom_nlist,
                                                      ap_netlist,

vpr/src/analytical_place/gen_ap_netlist_from_atoms.cpp

@@ -24,7 +24,8 @@
 
 APNetlist gen_ap_netlist_from_atoms(const AtomNetlist& atom_netlist,
                                     const Prepacker& prepacker,
-                                    const UserPlaceConstraints& constraints) {
+                                    const UserPlaceConstraints& constraints,
+                                    int high_fanout_threshold) {
     // Create a scoped timer for reading the atom netlist.
     vtr::ScopedStartFinishTimer timer("Read Atom Netlist to AP Netlist");
 
@@ -115,6 +116,7 @@ APNetlist gen_ap_netlist_from_atoms(const AtomNetlist& atom_netlist,
     //  - a global net
     //  - connected to 1 or fewer unique blocks
     //  - connected to only fixed blocks
+    //  - having fanout higher than threshold
     for (APNetId ap_net_id : ap_netlist.nets()) {
         // Is the net ignored for placement, if so mark as ignored for AP.
         const std::string& net_name = ap_netlist.net_name(ap_net_id);
@@ -153,6 +155,13 @@ APNetlist gen_ap_netlist_from_atoms(const AtomNetlist& atom_netlist,
             ap_netlist.set_net_is_ignored(ap_net_id, true);
             continue;
         }
+        // If fanout number of the net is higher than the threshold, mark as ignored for AP.
+        size_t num_pins = ap_netlist.net_pins(ap_net_id).size();
+        VTR_ASSERT_DEBUG(num_pins > 1);
+        if (num_pins - 1 > static_cast<size_t>(high_fanout_threshold)) {
+            ap_netlist.set_net_is_ignored(ap_net_id, true);
+            continue;
+        }
     }
     ap_netlist.compress();
 

vpr/src/analytical_place/gen_ap_netlist_from_atoms.h

@@ -16,13 +16,16 @@ class UserPlaceConstraints;
 /**
  * @brief Use the results from prepacking the atom netlist to generate an APNetlist.
  *
- *  @param atom_netlist The atom netlist for the input design.
- *  @param prepacker    The prepacker, initialized on the provided atom netlist.
- *  @param constraints  The placement constraints on the Atom blocks, provided
- *                      by the user.
+ *  @param atom_netlist          The atom netlist for the input design.
+ *  @param prepacker             The prepacker, initialized on the provided atom netlist.
+ *  @param constraints           The placement constraints on the Atom blocks, provided
+ *                               by the user.
+ *  @param high_fanout_threshold The threshold above which nets with higher fanout will
+ *                               be ignored.
  *
  *  @return             An APNetlist object, generated from the prepacker results.
  */
 APNetlist gen_ap_netlist_from_atoms(const AtomNetlist& atom_netlist,
                                     const Prepacker& prepacker,
-                                    const UserPlaceConstraints& constraints);
+                                    const UserPlaceConstraints& constraints,
+                                    int high_fanout_threshold);

vpr/src/analytical_place/global_placer.cpp

@@ -124,10 +124,19 @@ SimPLGlobalPlacer::SimPLGlobalPlacer(e_ap_analytical_solver analytical_solver_ty
  */
 static void print_placement_stats(const PartialPlacement& p_placement,
                                   const APNetlist& ap_netlist,
-                                  FlatPlacementDensityManager& density_manager) {
+                                  FlatPlacementDensityManager& density_manager,
+                                  const PreClusterTimingManager& pre_cluster_timing_manager) {
     // Print the placement HPWL
     VTR_LOG("\tPlacement HPWL: %f\n", p_placement.get_hpwl(ap_netlist));
 
+    // Print the timing information.
+    if (pre_cluster_timing_manager.is_valid()) {
+        float cpd_ns = pre_cluster_timing_manager.get_timing_info().least_slack_critical_path().delay() * 1e9;
+        float stns_ns = pre_cluster_timing_manager.get_timing_info().setup_total_negative_slack() * 1e9;
+        VTR_LOG("\tPlacement estimated CPD: %f ns\n", cpd_ns);
+        VTR_LOG("\tPlacement estimated sTNS: %f ns\n", stns_ns);
+    }
+
     // Print density information. Need to reset the density manager to ensure
     // the data is valid.
     density_manager.import_placement_into_bins(p_placement);
@@ -424,7 +433,8 @@ PartialPlacement SimPLGlobalPlacer::place() {
     VTR_LOG("Placement after Global Placement:\n");
     print_placement_stats(best_p_placement,
                           ap_netlist_,
-                          *density_manager_);
+                          *density_manager_,
+                          pre_cluster_timing_manager_);
 
     // Return the placement from the final iteration.
     return best_p_placement;

vpr/src/base/CheckSetup.cpp

@@ -88,6 +88,12 @@ void CheckSetup(const t_packer_opts& packer_opts,
                             "ap_timing_tradeoff expects a value between 0.0 and 1.0");
         }
 
+        // Make sure that the high fanout threshold for solver is valid.
+        if (ap_opts.ap_high_fanout_threshold <= 1) {
+            VPR_FATAL_ERROR(VPR_ERROR_OTHER,
+                            "ap_high_fanout_threshold should be greater than 1");
+        }
+
         // TODO: Should we enforce that the size of the device is fixed. This
         //       goes with ensuring that some blocks are fixed.
     }

vpr/src/base/SetupVPR.cpp

@@ -558,6 +558,7 @@ void SetupAPOpts(const t_options& options,
     apOpts.full_legalizer_type = options.ap_full_legalizer.value();
     apOpts.detailed_placer_type = options.ap_detailed_placer.value();
     apOpts.ap_timing_tradeoff = options.ap_timing_tradeoff.value();
+    apOpts.ap_high_fanout_threshold = options.ap_high_fanout_threshold.value();
     apOpts.appack_max_dist_th = options.appack_max_dist_th.value();
     apOpts.num_threads = options.num_workers.value();
     apOpts.log_verbosity = options.ap_verbosity.value();
@@ -720,6 +721,7 @@ static void SetupAnalysisOpts(const t_options& Options, t_analysis_opts& analysi
 
     analysis_opts.timing_update_type = Options.timing_update_type;
     analysis_opts.write_timing_summary = Options.write_timing_summary;
+    analysis_opts.skip_sync_clustering_and_routing_results = Options.skip_sync_clustering_and_routing_results;
     analysis_opts.generate_net_timing_report = Options.generate_net_timing_report;
 }
 

vpr/src/base/ShowSetup.cpp

@@ -656,6 +656,7 @@ static void ShowAnalyticalPlacerOpts(const t_ap_opts& APOpts) {
     }
 
     VTR_LOG("AnalyticalPlacerOpts.ap_timing_tradeoff: %f\n", APOpts.ap_timing_tradeoff);
+    VTR_LOG("AnalyticalPlacerOpts.ap_high_fanout_threshold: %d\n", APOpts.ap_high_fanout_threshold);
     VTR_LOG("AnalyticalPlacerOpts.log_verbosity: %d\n", APOpts.log_verbosity);
 }