Merge pull request #2536 from divyaprakash-iitd/feature_tracy

Tracy profiler integration

Author: pcarruscag

Common/include/tracy_structure.hpp

@@ -0,0 +1,42 @@
+/*!
+ * \file tracy_structure.hpp
+ * \brief Tracy profiler interface header.
+ *        Provides compatibility macros if the code is built without
+ *        tracy support. Profiling macros are defined here so that
+ *        they can be completely "disabled" when compiling without tracy.
+ * \note Do not include tracy headers explicitly anywhere, use this header instead.
+ * \note To enable tracy, define the TRACY_ENABLE macro during compilation.
+ * \author Divyaprakash
+ * \version 8.2.0 "Harrier"
+ *
+ * SU2 Project Website: https://su2code.github.io
+ *
+ * The SU2 Project is maintained by the SU2 Foundation
+ * (http://su2foundation.org)
+ *
+ * Copyright 2012-2025, SU2 Contributors (cf. AUTHORS.md)
+ *
+ * SU2 is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * SU2 is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with SU2. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#pragma once
+
+#ifdef HAVE_TRACY
+#include "tracy/Tracy.hpp"
+#define SU2_ZONE_SCOPED ZoneScoped
+#define SU2_ZONE_SCOPED_N(name) ZoneScopedN(name)
+#else
+#define SU2_ZONE_SCOPED
+#define SU2_ZONE_SCOPED_N(name)
+#endif

meson.build

@@ -120,6 +120,19 @@ if get_option('enable-autodiff') and not omp
   endif
 endif
 
+# Add Tracy dependency if enabled
+if get_option('enable-tracy')
+    tracy_dep = dependency('tracy', static: true)
+    su2_deps += tracy_dep
+    su2_cpp_args += '-DHAVE_TRACY'
+
+    # Add build type check
+    if get_option('buildtype') != 'debugoptimized'
+        warning('For optimal Tracy profiling, use --buildtype=debugoptimized')
+    endif
+endif
+
+
 # add cgns library
 if get_option('enable-cgns')
   subdir('externals/cgns')
@@ -364,6 +377,7 @@ message('''---------------------------------------------------------------------
          libROM:         @11@
          CoolProp:       @12@
          MLPCpp:         @13@
+         Tracy Profiler: @14@
 
          Please be sure to add the $SU2_HOME and $SU2_RUN environment variables,
          and update your $PATH (and $PYTHONPATH if applicable) with $SU2_RUN
@@ -375,11 +389,11 @@ message('''---------------------------------------------------------------------
          export PATH=$PATH:$SU2_RUN
          export PYTHONPATH=$PYTHONPATH:$SU2_RUN
 
-         Use './ninja -C @14@ install' to compile and install SU2
+         Use './ninja -C @15@ install' to compile and install SU2
 '''.format(get_option('prefix')+'/bin', meson.project_source_root(), get_option('enable-tecio'), get_option('enable-cgns'),
            get_option('enable-autodiff'), get_option('enable-directdiff'), get_option('enable-pywrapper'), get_option('enable-mkl'),
            get_option('enable-openblas'), get_option('enable-pastix'), get_option('enable-mixedprec'), get_option('enable-librom'), get_option('enable-coolprop'),
-           get_option('enable-mlpcpp'), meson.project_build_root().startswith(meson.project_source_root()) ? meson.project_build_root().split('/')[-1] : meson.project_build_root()))
+           get_option('enable-mlpcpp'), get_option('enable-tracy'), meson.project_build_root().startswith(meson.project_source_root()) ? meson.project_build_root().split('/')[-1] : meson.project_build_root()))
 
 if get_option('enable-mpp')
   if get_option('install-mpp')

meson_options.txt

@@ -29,3 +29,4 @@ option('opdi-shared-read-opt', type : 'boolean', value : true, description : 'Op
 option('librom_root', type : 'string', value : '', description: 'libROM base directory')
 option('enable-librom', type : 'boolean', value : false, description: 'enable LLNL libROM support')
 option('static-cgns-deps', type : 'boolean', value : false, description: 'prefer static or dynamic (default) libraries for CGNS dependencies')
+option('enable-tracy', type: 'boolean', value: false, description: 'Enable Tracy profiling support')

subprojects/tracy.wrap

@@ -0,0 +1,4 @@
+[wrap-git]
+url = https://github.com/wolfpld/tracy.git
+revision = master
+depth = 1