Merge branch 'disable-graphics'

Author: kmurray

CMakeLists.txt

@@ -28,6 +28,10 @@ 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
+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(WITH_BLIFEXPLORER "Enable build with blifexplorer" OFF)
 option(WITH_LIBRTLNUMBER "Enable build with librtlnumber" OFF)
 
@@ -296,6 +300,26 @@ enable_testing()
 #       For now just disable readline.
 set(READLINE_FOUND FALSE)
 
+
+# set VPR_USE_EZGL in the root of VTR to decide whether to add 
+# subdirectory of graphics library, which prevents users 
+# without gtk/x11 libraries installed to build. VPR_USE_EZGL is 
+# being used in both the vpr CMakeLists and libs/EXTERNAL CMakeLists.
+#
+# check if GTK and X11 are installed and turn on/off graphics
+if (VPR_USE_EZGL STREQUAL "auto")
+    find_package(PkgConfig REQUIRED)
+    pkg_check_modules(GTK3 QUIET gtk+-3.0)
+    pkg_check_modules(X11 QUIET x11)
+
+    if(GTK3_FOUND AND X11_FOUND)
+        set(VPR_USE_EZGL "on")
+    else()
+        set(VPR_USE_EZGL "off")
+    endif()
+endif()
+
+
 #Add the various sub-projects
 add_subdirectory(libs)
 add_subdirectory(vpr)

libs/EXTERNAL/CMakeLists.txt

@@ -7,4 +7,9 @@ add_subdirectory(libargparse)
 add_subdirectory(libsdcparse)
 add_subdirectory(libblifparse)
 add_subdirectory(libtatum)
-add_subdirectory(libezgl)
+
+#VPR_USE_EZGL is initialized in the root CMakeLists. 
+#compile libezgl only if the user asks for or has its dependencies installed.
+if(VPR_USE_EZGL STREQUAL "on")
+    add_subdirectory(libezgl)
+endif()

vpr/CMakeLists.txt

@@ -16,20 +16,24 @@ option(VPR_USE_SIGNAL_HANDLER "Should VPR use a signal handler to intercept sign
 set(VPR_PGO_CONFIG "none" CACHE STRING "Configure VPR Profile-Guided Optimization (PGO). prof_gen: built executable will produce profiling info, prof_use: built executable will be optimized based on generated profiling info, none: disable pgo")
 set_property(CACHE VPR_PGO_CONFIG PROPERTY STRINGS prof_gen prof_use none)
 
-set(
-  RESOURCE_LIST
-  # Strip all the whitespace characters from ui file
-  STRIPBLANKS main.ui
-)
 
-list(APPEND CMAKE_MODULE_PATH
-     ${CMAKE_CURRENT_SOURCE_DIR}/../libs/EXTERNAL/libezgl/gcr-cmake/macros)
+if (VPR_USE_EZGL STREQUAL "on")
+    set(
+        RESOURCE_LIST
+        # Strip all the whitespace characters from ui file
+        STRIPBLANKS main.ui
+    )
+
+    list(APPEND CMAKE_MODULE_PATH
+         ${CMAKE_CURRENT_SOURCE_DIR}/../libs/EXTERNAL/libezgl/gcr-cmake/macros)
+
+    include(GlibCompileResourcesSupport)
+endif()
 
 #
 # Build Configuration
 #
 include(CheckCXXSymbolExists)
-include(GlibCompileResourcesSupport)
 
 #Collect the source files
 file(GLOB_RECURSE EXEC_SOURCES src/main.cpp)
@@ -52,48 +56,59 @@ target_link_libraries(libvpr
                         libarchfpga
                         libsdcparse
                         libblifparse
-                       	ezgl
 			libeasygl
                         libtatum
                         libargparse
                         libpugixml)
 
-#Create the executable
-add_executable(vpr ${EXEC_SOURCES} ${CMAKE_CURRENT_BINARY_DIR}/resources.C)
-target_link_libraries(vpr
-                        libvpr)
+#link graphics library only when graphics set to on
+if (VPR_USE_EZGL STREQUAL "on")
+    target_link_libraries(libvpr 
+			     ezgl)
+
+    compile_gresources(
+      # input: the name of our resources
+      RESOURCE_FILE
+      # output: the filename of the generated XML file
+      XML_OUT
+      # generate C code to be compiled with our program
+      TYPE
+        EMBED_C
+      # specify the name of the C file that is generated
+      TARGET
+        resources.C
+      # specify the resource prefix (used in the code)
+      PREFIX
+        /ezgl
+      # input: specify the list of files to compile into resources
+      RESOURCES
+        ${RESOURCE_LIST}
+    )
+
+
+    add_custom_target(
+      resource ALL
+      DEPENDS
+        ${RESOURCE_FILE}
+    )
+
+    #Create the executable with resources
+    list(APPEND EXEC_SOURCES ${CMAKE_CURRENT_BINARY_DIR}/resources.C)
+
+endif()
+
+add_executable(vpr ${EXEC_SOURCES})
+
+target_link_libraries(vpr libvpr)
+
 
 #Supress IPO link warnings if IPO is enabled
 get_target_property(VPR_USES_IPO vpr INTERPROCEDURAL_OPTIMIZATION)
 if (VPR_USES_IPO)
     set_target_properties(vpr PROPERTIES LINK_FLAGS ${IPO_LINK_WARN_SUPRESS_FLAGS})
 endif()
 
-compile_gresources(
-  # input: the name of our resources
-  RESOURCE_FILE
-  # output: the filename of the generated XML file
-  XML_OUT
-  # generate C code to be compiled with our program
-  TYPE
-    EMBED_C
-  # specify the name of the C file that is generated
-  TARGET
-    resources.C
-  # specify the resource prefix (used in the code)
-  PREFIX
-    /ezgl
-  # input: specify the list of files to compile into resources
-  RESOURCES
-    ${RESOURCE_LIST}
-)
-
 
-add_custom_target(
-  resource ALL
-  DEPENDS
-    ${RESOURCE_FILE}
-)
 
 #
 # VPR compiler options

vpr/src/base/place_and_route.cpp

@@ -356,7 +356,6 @@ int binary_search_place_and_route(t_placer_opts placer_opts,
                     &warnings);
 
     init_draw_coords(final);
-
     restore_routing(best_routing, route_ctx.clb_opins_used_locally, saved_clb_opins_used_locally);
 
     if (Fc_clipped) {

vpr/src/base/vpr_api.cpp

@@ -707,7 +707,6 @@ RouteStatus vpr_route_flow(t_vpr_setup& vpr_setup, const t_arch& arch) {
 
         //Update interactive graphics
         update_screen(ScreenUpdatePriority::MAJOR, graphics_msg.c_str(), ROUTING, timing_info);
-
         free_net_delay(net_delay, &net_delay_ch);
     }
 
@@ -788,7 +787,6 @@ RouteStatus vpr_load_routing(t_vpr_setup& vpr_setup,
 
         timing_info->update();
     }
-
     init_draw_coords(fixed_channel_width);
 
     return RouteStatus(is_legal, fixed_channel_width);
@@ -829,14 +827,12 @@ void vpr_create_rr_graph(t_vpr_setup& vpr_setup, const t_arch& arch, int chan_wi
                     router_opts.lookahead_type,
                     arch.Directs, arch.num_directs,
                     &warnings);
-
     //Initialize drawing, now that we have an RR graph
     init_draw_coords(chan_width_fac);
 }
 
 void vpr_init_graphics(const t_vpr_setup& vpr_setup, const t_arch& arch) {
     /* Startup X graphics */
-
     init_graphics_state(vpr_setup.ShowGraphics, vpr_setup.GraphPause,
                         vpr_setup.RouterOpts.route_type);
     if (vpr_setup.ShowGraphics) {

vpr/src/draw/draw.cpp

@@ -42,6 +42,8 @@ using namespace std;
 #include "hsl.h"
 #include "route_export.h"
 #include "search_bar.h"
+#include "timing_info.h"
+#include "physical_types.h"
 
 #ifdef WIN32 /* For runtime tracking in WIN32. The clock() function defined in time.h will *
               * track CPU runtime.														   */
@@ -53,19 +55,21 @@ using namespace std;
 #    include <sys/time.h>
 #endif
 
+#ifndef NO_GRAPHICS
+
 //To process key presses we need the X11 keysym definitions,
 //which are unavailable when building with MINGW
-#if defined(X11) && !defined(__MINGW32__)
-#    include <X11/keysym.h>
-#endif
+#    if defined(X11) && !defined(__MINGW32__)
+#        include <X11/keysym.h>
+#    endif
 
-#include "rr_graph.h"
-#include "route_util.h"
-#include "place_macro.h"
+#    include "rr_graph.h"
+#    include "route_util.h"
+#    include "place_macro.h"
 
 /****************************** Define Macros *******************************/
 
-#define DEFAULT_RR_NODE_COLOR ezgl::BLACK
+#    define DEFAULT_RR_NODE_COLOR ezgl::BLACK
 //#define TIME_DRAWSCREEN /* Enable if want to track runtime for drawscreen() */
 
 //The arrow head position for turning/straight-thru connections in a switch box
@@ -200,9 +204,12 @@ void initial_setup_NO_PICTURE_to_ROUTING(ezgl::application* app);
 void initial_setup_NO_PICTURE_to_ROUTING_with_crit_path(ezgl::application* app);
 void toggle_window_mode(GtkWidget* /*widget*/, ezgl::application* /*app*/);
 
+#endif // NO_GRAPHICS
+
 /********************** Subroutine definitions ******************************/
 
 void init_graphics_state(bool show_graphics_val, int gr_automode_val, enum e_route_type route_type) {
+#ifndef NO_GRAPHICS
     /* Call accessor functions to retrieve global variables. */
     t_draw_state* draw_state = get_draw_state_vars();
 
@@ -213,8 +220,14 @@ void init_graphics_state(bool show_graphics_val, int gr_automode_val, enum e_rou
     draw_state->show_graphics = show_graphics_val;
     draw_state->gr_automode = gr_automode_val;
     draw_state->draw_route_type = route_type;
+#else
+    (void)show_graphics_val;
+    (void)gr_automode_val;
+    (void)route_type;
+#endif // NO_GRAPHICS
 }
 
+#ifndef NO_GRAPHICS
 void draw_main_canvas(ezgl::renderer& g) {
     t_draw_state* draw_state = get_draw_state_vars();
 
@@ -368,8 +381,11 @@ void initial_setup_NO_PICTURE_to_ROUTING_with_crit_path(ezgl::application* app)
     initial_setup_NO_PICTURE_to_ROUTING(app);
     app->create_button("Crit. Path", 6, toggle_crit_path);
 }
+#endif //NO_GRAPHICS
 
 void update_screen(ScreenUpdatePriority priority, const char* msg, enum pic_type pic_on_screen_val, std::shared_ptr<SetupTimingInfo> setup_timing_info) {
+#ifndef NO_GRAPHICS
+
     /* Updates the screen if the user has requested graphics.  The priority  *
      * value controls whether or not the Proceed button must be clicked to   *
      * continue.  Saves the pic_on_screen_val to allow pan and zoom redraws. */
@@ -438,8 +454,15 @@ void update_screen(ScreenUpdatePriority priority, const char* msg, enum pic_type
     } else {
         application.refresh_drawing();
     }
+#else
+    (void)setup_timing_info;
+    (void)priority;
+    (void)msg;
+    (void)pic_on_screen_val;
+#endif //NO_GRAPHICS
 }
 
+#ifndef NO_GRAPHICS
 void toggle_window_mode(GtkWidget* /*widget*/, ezgl::application* /*app*/) {
     window_mode = true;
 }
@@ -645,7 +668,10 @@ void toggle_router_rr_costs(GtkWidget* /*widget*/, ezgl::application* app) {
     app->refresh_drawing();
 }
 
+#endif // NO_GRAPHICS
+
 void alloc_draw_structs(const t_arch* arch) {
+#ifndef NO_GRAPHICS
     /* Call accessor functions to retrieve global variables. */
     t_draw_coords* draw_coords = get_draw_coords_vars();
     t_draw_state* draw_state = get_draw_state_vars();
@@ -672,9 +698,13 @@ void alloc_draw_structs(const t_arch* arch) {
     draw_state->arch_info = arch;
 
     deselect_all(); /* Set initial colors */
+#else
+    (void)arch;
+#endif // NO_GRAPHICS
 }
 
 void free_draw_structs() {
+#ifndef NO_GRAPHICS
     /* Free everything allocated by alloc_draw_structs. Called after close_graphics() *
      * in vpr_api.c.
      *
@@ -694,9 +724,13 @@ void free_draw_structs() {
         free(draw_state->draw_rr_node);
         draw_state->draw_rr_node = nullptr;
     }
+#else
+    ;
+#endif /* NO_GRAPHICS */
 }
 
 void init_draw_coords(float width_val) {
+#ifndef NO_GRAPHICS
     /* Load the arrays containing the left and bottom coordinates of the clbs   *
      * forming the FPGA.  tile_width_val sets the width and height of a drawn    *
      * clb.                                                                     */
@@ -751,8 +785,13 @@ void init_draw_coords(float width_val) {
     float draw_height = draw_coords->tile_y[device_ctx.grid.height() - 1] + draw_coords->get_tile_width();
 
     initial_world = ezgl::rectangle({-VISIBLE_MARGIN * draw_width, -VISIBLE_MARGIN * draw_height}, {(1. + VISIBLE_MARGIN) * draw_width, (1. + VISIBLE_MARGIN) * draw_height});
+#else
+    (void)width_val;
+#endif /* NO_GRAPHICS */
 }
 
+#ifndef NO_GRAPHICS
+
 /* Draws the blocks placed on the proper clbs.  Occupied blocks are darker colours *
  * while empty ones are lighter colours and have a dashed border.      */
 static void drawplace(ezgl::renderer& g) {
@@ -2354,7 +2393,7 @@ static bool highlight_rr_nodes(float x, float y) {
     return highlight_rr_nodes(hit_node);
 }
 
-#if defined(X11) && !defined(__MINGW32__)
+#    if defined(X11) && !defined(__MINGW32__)
 void act_on_key_press(ezgl::application* app, GdkEventKey* event, char* key_name) {
     //VTR_LOG("Key press %c (%d)\n", key_pressed, keysym);
     std::string key(key_name);
@@ -2366,11 +2405,11 @@ void act_on_key_press(ezgl::application* app, GdkEventKey* event, char* key_name
 
     event = event; // just for hiding warning message
 }
-#else
+#    else
 void act_on_key_press(ezgl::application* app, GdkEventKey* event, char* key_name) {
     //Nothing to do
 }
-#endif
+#    endif
 
 void act_on_mouse_press(ezgl::application* app, GdkEventButton* event, double x, double y) {
     app->update_message("Mouse Clicked");
@@ -3553,3 +3592,5 @@ static void highlight_blocks(double x, double y) {
 
     application.refresh_drawing();
 }
+
+#endif /* NO_GRAPHICS */