Merge branch 'master' into temp_chanx_place_cost_fac

Author: vaughnbetz

doc/src/arch/reference.rst

@@ -158,6 +158,8 @@ The valid tags within the ``<layout>`` tag are:
 
     .. note:: At most one ``<auto_layout>`` can be specified.
 
+.. _fixed_arch_grid_layout:
+
 .. arch:tag:: <fixed_layout name="string" width="int" height="int">
 
     :req_param name:

doc/src/vpr/command_line_usage.rst

@@ -82,6 +82,23 @@ VPR runs all stages of (pack, place, route, and analysis) if none of :option:`--
 
     **Default:** ``off``
 
+.. option:: --analytical_place
+
+    Run the analytical placement flow.
+    This flows uses an integrated packing and placement algorithm which uses information from the primitive level to improve clustering and placement;
+    as such, the :option:`--pack` and :option:`--place` options should not be set when this option is set.
+    This flow requires that the device has a fixed size and some of the primitive blocks are fixed somewhere on the device grid.
+
+    .. seealso:: See :ref:`Fixed FPGA Grid Layout <fixed_arch_grid_layout>` and :option:`--device` for how to fix the device size.
+
+    .. seealso:: See :ref:`VPR Placement Constraints <placement_constraints>` for how to fix primitive blocks in a design to the device grid.
+
+    .. warning::
+
+        This analytical placement flow is experimental and under active development.
+
+    **Default:** ``off``
+
 .. option:: --route
 
     Run routing stage

libs/libvtrutil/src/vpr_error.h

@@ -14,14 +14,15 @@ enum e_vpr_error {
     VPR_ERROR_ARCH,
     VPR_ERROR_PACK,
     VPR_ERROR_PLACE,
+    VPR_ERROR_AP,
     VPR_ERROR_ROUTE,
     VPR_ERROR_TIMING,
     VPR_ERROR_POWER,
     VPR_ERROR_SDC,
 
     // File parsing errors
     VPR_ERROR_NET_F,        // Error while parsing the packed netlist file
-    VPR_ERROR_PLACE_F,      // Error while parsning the placement file
+    VPR_ERROR_PLACE_F,      // Error while parsing the placement file
     VPR_ERROR_BLIF_F,       // Error while parsing the blif file
     VPR_ERROR_IC_NETLIST_F, // Error while parsing the interchange netlist file
 

libs/libvtrutil/src/vtr_optional.h

@@ -1,6 +1,8 @@
 #pragma once
 
-/** std::optional-like interface with optional references.
+/** 
+ * @file
+ * @brief std::optional-like interface with optional references.
  * currently: import TartanLlama's optional into the vtr namespace
  * documentation at https://tl.tartanllama.xyz/en/latest/api/optional.html
  * there are three main uses of this:

utils/fasm/src/main.cpp

@@ -72,11 +72,12 @@ int main(int argc, const char **argv) {
         /* Read options, architecture, and circuit netlist */
         vpr_init(argc, argv, &Options, &vpr_setup, &Arch);
 
-        vpr_setup.PackerOpts.doPacking    = STAGE_LOAD;
-        vpr_setup.PlacerOpts.doPlacement  = STAGE_LOAD;
-        vpr_setup.RouterOpts.doRouting    = STAGE_LOAD;
+        vpr_setup.PackerOpts.doPacking             = STAGE_LOAD;
+        vpr_setup.PlacerOpts.doPlacement           = STAGE_LOAD;
+        vpr_setup.APOpts.doAP                      = STAGE_SKIP;
+        vpr_setup.RouterOpts.doRouting             = STAGE_LOAD;
         vpr_setup.RouterOpts.read_rr_edge_metadata = true;
-        vpr_setup.AnalysisOpts.doAnalysis = STAGE_SKIP;
+        vpr_setup.AnalysisOpts.doAnalysis          = STAGE_SKIP;
 
         bool flow_succeeded = false;
         flow_succeeded = vpr_flow(vpr_setup, Arch);

utils/fasm/test/test_fasm.cpp

@@ -315,11 +315,12 @@ TEST_CASE("fasm_integration_test", "[fasm]") {
     vpr_init(sizeof(argv)/sizeof(argv[0]), argv,
               &options, &vpr_setup, &arch);
 
-    vpr_setup.PackerOpts.doPacking    = STAGE_LOAD;
-    vpr_setup.PlacerOpts.doPlacement  = STAGE_LOAD;
-    vpr_setup.RouterOpts.doRouting    = STAGE_LOAD;
+    vpr_setup.PackerOpts.doPacking             = STAGE_LOAD;
+    vpr_setup.PlacerOpts.doPlacement           = STAGE_LOAD;
+    vpr_setup.APOpts.doAP                      = STAGE_SKIP;
+    vpr_setup.RouterOpts.doRouting             = STAGE_LOAD;
     vpr_setup.RouterOpts.read_rr_edge_metadata = true;
-    vpr_setup.AnalysisOpts.doAnalysis = STAGE_SKIP;
+    vpr_setup.AnalysisOpts.doAnalysis          = STAGE_SKIP;
 
     bool flow_succeeded = vpr_flow(vpr_setup, arch);
     REQUIRE(flow_succeeded == true);

vpr/src/analytical_place/analytical_placement_flow.cpp

@@ -0,0 +1,35 @@
+/**
+ * @file
+ * @author  Alex Singer
+ * @date    September 2024
+ * @brief   Implementation of the Analytical Placement flow.
+ */
+
+#include "analytical_placement_flow.h"
+#include "atom_netlist.h"
+#include "globals.h"
+#include "prepack.h"
+#include "vpr_context.h"
+#include "vpr_error.h"
+#include "vpr_types.h"
+#include "vtr_time.h"
+
+void run_analytical_placement_flow(t_vpr_setup& vpr_setup) {
+    (void)vpr_setup;
+    // Start an overall timer for the Analytical Placement flow.
+    vtr::ScopedStartFinishTimer timer("Analytical Placement Flow");
+
+    // The global state used/modified by this flow.
+    const AtomNetlist& atom_nlist = g_vpr_ctx.atom().nlist;
+    const DeviceContext& device_ctx = g_vpr_ctx.device();
+
+    // Run the prepacker
+    Prepacker prepacker;
+    prepacker.init(atom_nlist, device_ctx.logical_block_types);
+
+    // AP is currently under-construction. Fail gracefully just in case this
+    // is somehow being called.
+    VPR_FATAL_ERROR(VPR_ERROR_AP,
+                    "Analytical Placement flow not implemented yet");
+}
+

vpr/src/analytical_place/analytical_placement_flow.h

@@ -0,0 +1,19 @@
+/**
+ * @file
+ * @author  Alex Singer
+ * @date    September 2024
+ * @brief   Methods for running the Analytical Placement flow.
+ */
+
+#pragma once
+
+// Forward declarations
+struct t_vpr_setup;
+
+/**
+ * @brief Run the Analaytical Placement flow.
+ *
+ *  @param vpr_setup    The setup options provided by the user.
+ */
+void run_analytical_placement_flow(t_vpr_setup& vpr_setup);
+

vpr/src/base/CheckSetup.cpp

@@ -9,6 +9,7 @@
 
 void CheckSetup(const t_packer_opts& PackerOpts,
                 const t_placer_opts& PlacerOpts,
+                const t_ap_opts& APOpts,
                 const t_router_opts& RouterOpts,
                 const t_server_opts& ServerOpts,
                 const t_det_routing_arch& RoutingArch,
@@ -72,6 +73,28 @@ void CheckSetup(const t_packer_opts& PackerOpts,
                         NUM_PL_MOVE_TYPES);
     }
 
+    // Rules for doing Analytical Placement
+    if (APOpts.doAP) {
+        // Make sure that the --place option was not set.
+        if (PlacerOpts.doPlacement) {
+            VPR_FATAL_ERROR(VPR_ERROR_OTHER,
+                            "Cannot perform both analytical and non-analytical placement.\n");
+        }
+        // Make sure that the --pack option was not set.
+        if (PackerOpts.doPacking) {
+            VPR_FATAL_ERROR(VPR_ERROR_OTHER,
+                            "Analytical placement should skip packing.\n");
+        }
+
+        // TODO: Should check that read_vpr_constraint_file is non-empty or
+        //       check within analytical placement that the floorplanning has
+        //       some fixed blocks somewhere. Maybe we can live without fixed
+        //       blocks.
+
+        // TODO: Should we enforce that the size of the device is fixed. This
+        //       goes with ensuring that some blocks are fixed.
+    }
+
     if (RouterOpts.doRouting) {
         if (!Timing.timing_analysis_enabled
             && (DEMAND_ONLY != RouterOpts.base_cost_type && DEMAND_ONLY_NORMALIZED_LENGTH != RouterOpts.base_cost_type)) {

vpr/src/base/CheckSetup.h

@@ -7,6 +7,7 @@ const int DYNAMIC_PORT_RANGE_MAX = 65535;
 
 void CheckSetup(const t_packer_opts& PackerOpts,
                 const t_placer_opts& PlacerOpts,
+                const t_ap_opts& APOpts,
                 const t_router_opts& RouterOpts,
                 const t_server_opts& ServerOpts,
                 const t_det_routing_arch& RoutingArch,