GPU: Improve settings handling and make GPUDisplayControl a qconfig GPUSettings struct

Author: davidrohr

GPU/GPUTracking/Base/GPUParam.h

@@ -18,6 +18,7 @@
 #include "GPUCommonDef.h"
 #include "GPUCommonMath.h"
 #include "GPUDef.h"
+#define GPUSETTINGS_PARAM
 #include "GPUSettings.h"
 #include "GPUTPCGMPolynomialField.h"
 #include "DataFormatsTPC/Constants.h"

GPU/GPUTracking/Base/GPUParamRTC.h

@@ -16,6 +16,8 @@
 #define GPUPARAMRTC_H
 
 #include "GPUParam.h"
+#define GPUSETTINGS_ALL
+#include "GPUSettings.h"
 #include <string>
 
 namespace o2::gpu

GPU/GPUTracking/DataTypes/GPUConfigDump.cxx

@@ -14,6 +14,7 @@
 
 #include "GPUConfigDump.h"
 #include "GPUDataTypesIO.h"
+#define GPUSETTINGS_ALL
 #include "GPUSettings.h"
 
 #include <functional>

GPU/GPUTracking/DataTypes/GPUSettings.h

@@ -18,12 +18,13 @@
 #include "GPUCommonDef.h"
 #include "GPUSettingsTypes.h"
 
+#endif // GPUSETTINGS_H
+
+// Outside of header guard, since might run it multiple times for different config structs
 #ifdef GPUCA_GPUCODE_DEVICE
 #define QCONFIG_GPU
 #endif
 // See GPUSettingsList.h for a list of all available settings of GPU Reconstruction
 #ifndef GPUCA_GPUCODE_GENRTC
 #include "utils/qconfig.h"
 #endif
-
-#endif // GPUSETTINGS_H

GPU/GPUTracking/DataTypes/GPUSettingsParam.h

@@ -14,6 +14,8 @@
 
 // clang-format off
 
+// No include guard: included multiple times by qconfig with different macro definitions
+
 // Derrived parameters used in GPUParam
 BeginHiddenConfig(GPUSettingsParam, param)
 AddVariableRTC(continuousTracking, int8_t, 0) // Continuous tracking, estimate bz and errors for abs(z) = 125cm during seeding

GPU/GPUTracking/Definitions/GPUSettingsList.h

@@ -19,9 +19,12 @@
 // Create plain-C struct for GPU code.
 // Create static constexpr with default values for GPU run time compilation
 
-#ifdef BeginConfig // File should not be included without defining the macros, but rootcling will do for dictionary generation
+#include "GPUSettingsTypes.h"
+
+#if (!defined(__CLING__) && !defined(G__DICTIONARY)) || defined(BeginSubConfig) // File should not be included without defining the macros, but rootcling will do for dictionary generation
 
 // clang-format off
+BeginNamespace(o2::gpu)
 
 // Settings concerning the reconstruction, stored as parameters in GPU constant memory
 // There must be no bool in here, use int8_t, as sizeof(bool) is compiler dependent and fails on GPUs!!!!!!
@@ -709,4 +712,6 @@ EndConfig()
 #endif // !GPUCA_STANDALONE
 #endif // !GPUCA_GPUCODE_DEVICE
 
-#endif // #ifndef __CLING__
+EndNamespace() // o2::gpu
+
+#endif // (!defined(__CLING__) && !defined(G__DICTIONARY)) || defined(BeginSubConfig)

GPU/GPUTracking/display/CMakeLists.txt

@@ -132,7 +132,7 @@ set(SRCS_NO_H helpers/GPUDisplayLoader.cxx
               frontend/GPUDisplayHelp.cxx
               frontend/GPUDisplayFrontendConfig.cxx)
 
-set(HDRS_INSTALL helpers/GPUDisplayMagneticFieldConstants.h frontend/GPUDisplayFrontendKeys.h frontend/GPUDisplayControl.h)
+set(HDRS_INSTALL helpers/GPUDisplayMagneticFieldConstants.h frontend/GPUDisplayFrontendKeys.h GPUDisplayControl.h GPUDisplayTypes.h)
 
 if(GPUCA_EVENT_DISPLAY_VULKAN)
   set(SRCS ${SRCS} backend/GPUDisplayBackendVulkan.cxx)

GPU/GPUTracking/display/GPUDisplay.h

@@ -15,11 +15,11 @@
 #ifndef GPUDISPLAY_H
 #define GPUDISPLAY_H
 
+#define GPUSETTINGS_DISPLAYCONTROL
+#include "GPUSettings.h"
 #include "frontend/GPUDisplayFrontend.h"
-#include "frontend/GPUDisplayControl.h"
 #include "backend/GPUDisplayBackend.h"
 #include "GPUDisplayInterface.h"
-#include "GPUSettings.h"
 #include "DataFormatsTPC/Constants.h"
 
 #include <atomic>

GPU/GPUTracking/display/GPUDisplayControl.h

@@ -0,0 +1,45 @@
+// Copyright 2019-2026 CERN and copyright holders of ALICE O2.
+// See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
+// All rights not expressly granted are reserved.
+//
+// This software is distributed under the terms of the GNU General Public
+// License v3 (GPL Version 3), copied verbatim in the file "COPYING".
+//
+// 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.
+
+/// \file GPUDisplayControl.h
+/// \author David Rohr
+
+// No include guard: included multiple times by qconfig with different macro definitions
+
+#include <atomic>
+#include <cstdint>
+#include <string>
+#include "GPUDisplayTypes.h"
+
+// clang-format off
+BeginNamespace(o2::gpu)
+BeginHiddenConfig(GPUDisplayControl, control)
+  AddVariable(mDisplayControl, GPUDisplayCopyableAtomic<int32_t>, 0) // Control for next event (=1) or quit (=2)
+  AddVariable(mResetScene, GPUDisplayCopyableAtomic<bool>, false)
+  AddVariable(mPrintInfoText, int32_t, 1)
+  AddVariable(mPrintInfoTextAlways, bool, false)
+  AddVariable(mRequestScreenshot, bool, false)
+  AddVariable(mAnimateScreenshot, int32_t, 0)
+  AddVariable(mAnimationChangeConfig, bool, true)
+  AddVariable(mAnimationDelay, float, 2.f)
+  AddVariable(mPrintInfoTextGUI, bool, true)                     // Send the status and info text to the Qt GUI, shown at its bottom
+  AddVariable(mGuiPrintInfo, bool, false)                        // Show the info of options changed with Qt GUI elements (not for key presses in the GUI)
+  AddVariable(mRotateModel, bool, false)                         // Rotate the model instead of the camera, like holding RCTRL (set in the Qt GUI)
+  AddVariable(mRotateAroundZ, bool, false)                       // Rotate the TPC around the beamline, like holding RALT (set in the Qt GUI)
+  AddVariable(mFilterMacroCustom, std::string, "")               // Code of the custom track filter ROOT macro (trackFilter = filterMacros.size() + 1), set in the Qt GUI
+  AddVariable(mScreenShotname, std::string, "screenshot")        // Name of screenshot and animation frame files, followed by numbers
+  AddVariable(mGLPosFile, std::string, "glpos.tmp")              // File for saving / loading the camera position
+  AddVariable(mGLAnimationFile, std::string, "glanimation.tmp")  // File for saving / loading the animation path
+  AddVariable(mGuiDarkMode, int8_t, -1)                          // Dark mode of the Qt GUI, -1 = not yet set: the GUI reports the system scheme when it starts
+  AddVariable(mGuiScale, float, 1.f)                             // Scale factor of text and elements of the Qt GUI (on top of the system scaling), Ctrl + mouse wheel / Ctrl + 0 in the GUI
+  AddVariable(dummy, bool, false)                                // dummy value to reference for keys that do not change variables
+EndConfig()
+EndNamespace() // o2::gpu

GPU/GPUTracking/display/GPUDisplayTypes.h

@@ -0,0 +1,32 @@
+// Copyright 2019-2026 CERN and copyright holders of ALICE O2.
+// See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
+// All rights not expressly granted are reserved.
+//
+// This software is distributed under the terms of the GNU General Public
+// License v3 (GPL Version 3), copied verbatim in the file "COPYING".
+//
+// 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.
+
+/// \file GPUDisplayTypes.h
+/// \author David Rohr
+
+#ifndef GPUDISPLAYTYPES_H
+#define GPUDISPLAYTYPES_H
+
+namespace o2::gpu
+{
+template <class T>
+struct GPUDisplayCopyableAtomic : std::atomic<T> { // std::atomic deletes the copy, here it copies the value
+  using std::atomic<T>::atomic;
+  GPUDisplayCopyableAtomic(const GPUDisplayCopyableAtomic& o) : std::atomic<T>(o.load()) {}
+  GPUDisplayCopyableAtomic& operator=(const GPUDisplayCopyableAtomic& o)
+  {
+    this->store(o.load());
+    return *this;
+  }
+};
+} // namespace o2::gpu
+
+#endif