DPL: move GUI to a plugin (#5099)

This moves the whole GUI implementation to an on demand
plugin which will be loaded only if we are not in batch mode.

This will both save memory (30MB PSS, in my tests) and speedup startup
when running in batch mode.

Author: ktf

Framework/CMakeLists.txt

@@ -18,4 +18,6 @@ add_subdirectory(Utils)
 
 add_subdirectory(AnalysisSupport) 
 
+add_subdirectory(GUISupport) 
+
 add_subdirectory(TestWorkflows) 

Framework/Core/CMakeLists.txt

@@ -8,15 +8,6 @@
 # granted to it by virtue of its status as an Intergovernmental Organization or
 # submit itself to any jurisdiction.
 
-if (TARGET AliceO2::DebugGUI)
-  set(GUI_SOURCES src/FrameworkGUIDebugger.cxx src/FrameworkGUIDevicesGraph.cxx
-                  src/FrameworkGUIDeviceInspector.cxx
-                  src/FrameworkGUIDataRelayerUsage.cxx src/PaletteHelpers.cxx)
-  set(DEBUGGUI_TARGET AliceO2::DebugGUI)
-else()
-  set(GUI_SOURCES src/FrameworkDummyDebugger.cxx)
-endif()
-
 # Given GCC 7.3 does not provide std::filesystem we use Boost instead
 # Drop this once we move to GCC 8.2+
 # if (NOT __APPLE__)
@@ -26,7 +17,6 @@ endif()
 o2_add_library(Framework
                SOURCES src/AODReaderHelpers.cxx
                        src/ASoA.cxx
-                       ${GUI_SOURCES}
                        src/AnalysisHelpers.cxx
                        src/AnalysisDataModelHelpers.cxx
                        src/BoostOptionsRetriever.cxx
@@ -108,8 +98,7 @@ o2_add_library(Framework
                        src/StepTHn.cxx
                        test/TestClasses.cxx
                PRIVATE_INCLUDE_DIRECTORIES ${CMAKE_CURRENT_LIST_DIR}/src
-               PUBLIC_LINK_LIBRARIES ${DEBUGGUI_TARGET}
-                                     AliceO2::Common
+               PUBLIC_LINK_LIBRARIES AliceO2::Common
                                      AliceO2::Configuration
                                      AliceO2::InfoLogger
                                      AliceO2::Monitoring
@@ -257,16 +246,6 @@ endforeach()
 
 # #####################################################@
 
-if (TARGET AliceO2::DebugGUI)
-if (NOT APPLE)
-set (DEBUG_GUI_TESTS_WORKFLOW
-     CustomGUIGL
-     CustomGUISokol
-     SimpleTracksED
-     )
-endif()
-endif()
-
 foreach(w
         BoostSerializedProcessing
         CallbackService
@@ -288,7 +267,6 @@ foreach(w
         SingleDataSource
         Task
         ExternalFairMQDeviceWorkflow
-        ${DEBUG_GUI_TESTS_WORKFLOW}
         )
   o2_add_test(${w} NAME test_Framework_test_${w}
               SOURCES test/test_${w}.cxx
@@ -304,18 +282,6 @@ endforeach()
 # part. [WARN] Incoming data is already obsolete, not relaying.
 set_property(TEST test_Framework_test_DanglingInputs PROPERTY DISABLED TRUE)
 
-if (TARGET AliceO2::DebugGUI)
-# TODO: investigate the problem with the two unit tests, maybe setup of the CI
-# environment assertion fired X11: The DISPLAY environment variable is missing
-# glfw-3.2.1/src/window.c:579: glfwGetFramebufferSize: Assertion `window !=
-# ((void *)0)' failed.
-if(NOT APPLE)
-set_property(TEST test_Framework_test_SimpleTracksED PROPERTY DISABLED TRUE)
-set_property(TEST test_Framework_test_CustomGUIGL PROPERTY DISABLED TRUE)
-set_property(TEST test_Framework_test_CustomGUISokol PROPERTY DISABLED TRUE)
-endif()
-endif()
-
 # TODO: investigate the problem and re-enable
 set_property(TEST test_Framework_test_BoostSerializedProcessing
              PROPERTY DISABLED TRUE)

Framework/Core/src/DataProcessorInfo.h …re/include/Framework/DataProcessorInfo.hFramework/Core/src/DataProcessorInfo.h renamed to Framework/Core/include/Framework/DataProcessorInfo.h Framework/Core/src/DataProcessorInfo.h renamed to Framework/Core/include/Framework/DataProcessorInfo.h

@@ -0,0 +1,40 @@
+// Copyright CERN and copyright holders of ALICE O2. This software is
+// distributed under the terms of the GNU General Public License v3 (GPL
+// Version 3), copied verbatim in the file "COPYING".
+//
+// See http://alice-o2.web.cern.ch/license for full licensing information.
+//
+// In applying this license CERN does not waive the privileges and immunities
+// granted to it by virtue of its status as an Intergovernmental Organization
+// or submit itself to any jurisdiction.
+#ifndef O2_FRAMEWORK_DEBUGUIINTERFACE_H_
+#define O2_FRAMEWORK_DEBUGUIINTERFACE_H_
+
+#include "Framework/DeviceInfo.h"
+#include "Framework/DeviceSpec.h"
+#include "Framework/DeviceControl.h"
+#include "Framework/DataProcessorInfo.h"
+#include "Framework/DeviceMetricsInfo.h"
+#include "Framework/DriverInfo.h"
+#include "Framework/DriverControl.h"
+
+#include <functional>
+#include <vector>
+
+namespace o2::framework
+{
+/// Plugin interface for DPL GUIs.
+struct DebugGUI {
+  virtual std::function<void(void)> getGUIDebugger(std::vector<o2::framework::DeviceInfo> const& infos,
+                                                   std::vector<o2::framework::DeviceSpec> const& devices,
+                                                   std::vector<o2::framework::DataProcessorInfo> const& metadata,
+                                                   std::vector<o2::framework::DeviceMetricsInfo> const& metricsInfos,
+                                                   o2::framework::DriverInfo const& driverInfo,
+                                                   std::vector<o2::framework::DeviceControl>& controls,
+                                                   o2::framework::DriverControl& driverControl) = 0;
+  virtual void* initGUI(char const* windowTitle) = 0;
+  virtual bool pollGUI(void* context, std::function<void(void)> guiCallback) = 0;
+  virtual void disposeGUI() = 0;
+};
+} // namespace o2::framework
+#endif // O2_FRAMEWORK_DEBUGUIINTERFACE_H_

Framework/Core/include/Framework/DebugGUI.h

@@ -13,7 +13,7 @@
 #include <functional>
 #include <vector>
 
-#include "DriverInfo.h"
+#include "Framework/DriverInfo.h"
 #include "Framework/DataProcessorSpec.h"
 #include "Framework/DeviceSpec.h"
 #include "Framework/DeviceExecution.h"

Framework/Core/src/DriverControl.h …k/Core/include/Framework/DriverControl.hFramework/Core/src/DriverControl.h renamed to Framework/Core/include/Framework/DriverControl.h Framework/Core/src/DriverControl.h renamed to Framework/Core/include/Framework/DriverControl.h

@@ -19,7 +19,10 @@ namespace o2::framework
 enum struct DplPluginKind : int {
   // A plugin which can customise the workflow. Needs to return
   // an object of kind o2::framework::WorkflowCustomizationService
-  CustomAlgorithm
+  CustomAlgorithm,
+  // A plugin which implements a ImGUI GUI. Needs to return an
+  // object of the kind o2::framework::DebugGUIImpl
+  DebugGUIImpl
 };
 
 } // namespace o2::framework

Framework/Core/src/DriverInfo.h …work/Core/include/Framework/DriverInfo.hFramework/Core/src/DriverInfo.h renamed to Framework/Core/include/Framework/DriverInfo.h Framework/Core/src/DriverInfo.h renamed to Framework/Core/include/Framework/DriverInfo.h

@@ -22,8 +22,8 @@
 #include "Framework/AlgorithmSpec.h"
 #include "Framework/ConfigParamSpec.h"
 #include "Framework/OutputRoute.h"
+#include "Framework/DataProcessorInfo.h"
 #include "ResourceManager.h"
-#include "DataProcessorInfo.h"
 #include "WorkflowHelpers.h"
 #include <boost/program_options.hpp>
 

Framework/Core/include/Framework/Plugins.h

@@ -7,4 +7,4 @@
 // In applying this license CERN does not waive the privileges and immunities
 // granted to it by virtue of its status as an Intergovernmental Organization
 // or submit itself to any jurisdiction.
-#include "DriverControl.h"
+#include "Framework/DriverControl.h"

Framework/Core/src/DeviceSpecHelpers.h

@@ -7,4 +7,4 @@
 // In applying this license CERN does not waive the privileges and immunities
 // granted to it by virtue of its status as an Intergovernmental Organization
 // or submit itself to any jurisdiction.
-#include "DriverInfo.h"
+#include "Framework/DriverInfo.h"