Merge pull request #1504 from verilog-to-routing/initial_analytic_placer

Add Analytic Placer to VPR with new option, test, and dependency

Author: vaughnbetz

CMakeLists.txt

@@ -32,11 +32,15 @@ option(VTR_ENABLE_PROFILING "Enable performance profiler (gprof)" OFF)
 option(VTR_ENABLE_COVERAGE "Enable code coverage tracking (gcov)" OFF)
 option(VTR_ENABLE_DEBUG_LOGGING "Enable debug logging" OFF)
 
-#Allow the user to decide weather to compile the graphics library
+#Allow the user to decide whether to compile the graphics library
 set(VPR_USE_EZGL "auto" CACHE STRING "Specify whether vpr uses the graphics library")
 set_property(CACHE VPR_USE_EZGL PROPERTY STRINGS auto off on)
 option(VTR_ENABLE_CAPNPROTO "Enable capnproto binary serialization support in VPR." ON)
 
+#Allow the user to enable/disable VPR analytic placement
+#VPR option --enable_analytic_placer is also required for Analytic Placement
+option(VPR_ANALYTIC_PLACE "Enable analytic placement in VPR." ON)
+
 option(WITH_BLIFEXPLORER "Enable build with blifexplorer" OFF)
 
 option(WITH_ABC "Enable building abc" ON)

libs/libvtrutil/src/vtr_geometry.h

@@ -110,6 +110,9 @@ class Rect {
     //Returns true if the point is coincident with the rectangle (including the top-right edges)
     bool coincident(Point<T> point) const;
 
+    //Returns true if other is contained within the rectangle (including all edges)
+    bool contains(const Rect<T>& other) const;
+
     //Returns true if no points are contained in the rectangle
     //  rect.empty() => not exists p. rect.contains(p)
     //  This also implies either the width or height is 0.

libs/libvtrutil/src/vtr_geometry.tpp

@@ -151,6 +151,13 @@ bool Rect<T>::coincident(Point<T> point) const {
            && point.y() >= ymin() && point.y() <= ymax();
 }
 
+template<class T>
+bool Rect<T>::contains(const Rect<T>& other) const {
+    //Including all edges
+    return other.xmin() >= xmin() && other.xmax() <= xmax()
+           && other.ymin() >= ymin() && other.ymax() <= ymax();
+}
+
 template<class T>
 bool Rect<T>::empty() const {
     return xmax() <= xmin() || ymax() <= ymin();

vpr/CMakeLists.txt

@@ -51,7 +51,25 @@ add_library(libvpr STATIC
              ${LIB_SOURCES}
 )
 
+
 target_include_directories(libvpr PUBLIC ${LIB_INCLUDE_DIRS})
+
+#VPR_ANALYTIC_PLACE is inisitalized in the root CMakeLists
+#Check Eigen dependency
+if(${VPR_ANALYTIC_PLACE})
+	message(STATUS "VPR Analytic Placement: Requested")
+	find_package(Eigen3 3.3 NO_MODULE)
+	if (TARGET Eigen3::Eigen)
+		message(STATUS "VPR Analytic Placement dependency (Eigen3): Found")
+		message(STATUS "VPR Analytic Placement: Enabled")
+		target_link_libraries (libvpr Eigen3::Eigen)
+		target_compile_definitions(libvpr PUBLIC -DENABLE_ANALYTIC_PLACE)
+	else ()
+		message(STATUS "VPR Analytic Placement dependency (Eigen3): Not Found (Download manually with sudo apt install libeigen3-dev, and rebuild)")
+		message(STATUS "VPR Analytic Placement: Disabled")
+	endif(TARGET Eigen3::Eigen)
+endif()
+
 set_target_properties(libvpr PROPERTIES PREFIX "") #Avoid extra 'lib' prefix
 
 #Specify link-time dependancies
@@ -62,7 +80,8 @@ target_link_libraries(libvpr
                         libblifparse
                         libtatum
                         libargparse
-                        libpugixml)
+                        libpugixml
+)
 
 #link graphics library only when graphics set to on
 if (VPR_USE_EZGL STREQUAL "on")

vpr/src/base/SetupVPR.cpp

@@ -574,6 +574,7 @@ static void SetupPlacerOpts(const t_options& Options, t_placer_opts* PlacerOpts)
 
     PlacerOpts->effort_scaling = Options.place_effort_scaling;
     PlacerOpts->timing_update_type = Options.timing_update_type;
+    PlacerOpts->enable_analytic_placer = Options.enable_analytic_placer;
 }
 
 static void SetupAnalysisOpts(const t_options& Options, t_analysis_opts& analysis_opts) {

vpr/src/base/read_options.cpp

@@ -1739,6 +1739,13 @@ argparse::ArgumentParser create_arg_parser(std::string prog_name, t_options& arg
         .default_value("0")
         .show_in(argparse::ShowIn::HELP_ONLY);
 
+    place_grp.add_argument(args.enable_analytic_placer, "--enable_analytic_placer")
+        .help(
+            "Enables the analytic placer. "
+            "Once analytic placement is done, the result is passed through the quench phase of the annealing placer for local improvement")
+        .default_value("false")
+        .show_in(argparse::ShowIn::HELP_ONLY);
+
     auto& place_timing_grp = parser.add_argument_group("timing-driven placement options");
 
     place_timing_grp.add_argument(args.PlaceTimingTradeoff, "--timing_tradeoff")

vpr/src/base/read_options.h

@@ -112,6 +112,7 @@ struct t_options {
     argparse::ArgValue<int> placement_saves_per_temperature;
     argparse::ArgValue<e_place_effort_scaling> place_effort_scaling;
     argparse::ArgValue<e_place_delta_delay_algorithm> place_delta_delay_matrix_calculation_method;
+    argparse::ArgValue<bool> enable_analytic_placer;
 
     /* Timing-driven placement options only */
     argparse::ArgValue<float> PlaceTimingTradeoff;

vpr/src/base/vpr_types.h

@@ -1035,6 +1035,14 @@ struct t_placer_opts {
     std::string allowed_tiles_for_delay_model;
 
     e_place_delta_delay_algorithm place_delta_delay_matrix_calculation_method;
+
+    /*
+     * @brief enables the analytic placer.
+     *
+     * Once analytic placement is done, the result is passed through the quench phase
+     * of the annealing placer for local improvement
+     */
+    bool enable_analytic_placer;
 };
 
 /* All the parameters controlling the router's operation are in this        *