[rocprofiler-systems] Update logging to use spdlog library (#2428)

## Motivation

- Structured logging with proper log levels (TRACE, DEBUG, INFO, WARNING, ERROR, CRITICAL)
- Better performance through compile-time formatting
- Consistent formatting using fmt library
- Runtime log level control via arguments and environment variables
- Easier maintenance and debugging capabilities

## Technical Details

- Added spdlog as a submodule and integrated it into CMake build system
- Created new `rocprofiler-systems-logger` library wrapping spdlog functionality
- Replaced custom logging macros (`ROCPROFSYS_VERBOSE`, `ROCPROFSYS_DEBUG`, `ROCPROFSYS_FATAL`, `ROCPROFSYS_REQUIRE`, `ROCPROFSYS_CI_THROW`, etc.) with spdlog equivalents (`LOG_DEBUG`, `LOG_WARNING`, `LOG_CRITICAL`, etc.)
- Implemented log level control through command-line arguments and environment variables
- Converted assertion macros to proper error handling with exceptions and std::abort()

Author: mradosav-amd

.gitmodules

@@ -98,3 +98,7 @@
 [submodule "projects/rocprofiler-systems/external/filesystem"]
 	path = projects/rocprofiler-systems/external/filesystem
 	url = https://github.com/gulrak/filesystem.git
+[submodule "projects/rocprofiler-systems/external/spdlog"]
+	path = projects/rocprofiler-systems/external/spdlog
+	url = https://github.com/gabime/spdlog.git
+	tag = v1.16.0

projects/rocprofiler-systems/CHANGELOG.md

@@ -9,6 +9,9 @@ Full documentation for ROCm Systems Profiler is available at [https://rocm.docs.
 ### Added
 
 - Documentation for `--trace-legacy` / `-L` CLI flag for direct tracing mode.
+- Added dependency to `spdlog` library.
+- Added environment variable `ROCPROFSYS_LOG_LEVEL` which control level of logging.
+  - Available log levels: `critical`, `error`, `warning`, `info`(default), `debug`, `trace` and `off`.
 
 ### Changed
 
@@ -18,6 +21,7 @@ Full documentation for ROCm Systems Profiler is available at [https://rocm.docs.
 - `--trace` / `-T` CLI flag enables tracing with cached mode by default.
 - `--trace-legacy` / `-L` CLI flag enables legacy direct mode for tracing.
 - Changed thread storage allocation from a hard-coded 4096-element array to a compile-time computed size derived from the ROCPROFSYS_MAX_THREADS configuration flag.
+- Changed logging module to use `spdlog` library.
 
 ### Resolved issues
 
@@ -30,6 +34,7 @@ Full documentation for ROCm Systems Profiler is available at [https://rocm.docs.
 ### Deprecated
 
 - `ROCPROFSYS_USE_PERFETTO` environment variable (use `ROCPROFSYS_TRACE`).
+- `ROCPROFSYS_VERBOSE` and `ROCPROFSYS_DEBUG` environment variables (use `ROCPROFSYS_LOG_LEVEL`).
 
 ## ROCm Systems Profiler 1.3.0 for ROCm 7.2.0
 

projects/rocprofiler-systems/CMakeLists.txt

@@ -236,6 +236,11 @@ rocprofiler_systems_add_option(ROCPROFSYS_BUILD_CODECOV "Build for code coverage
 rocprofiler_systems_add_option(ROCPROFSYS_INSTALL_PERFETTO_TOOLS
                                "Install perfetto tools (i.e. traced, perfetto, etc.)" OFF
 )
+
+rocprofiler_systems_add_option(ROCPROFSYS_BUILD_SPDLOG
+                               "Enable building spdlog library internally" ON
+)
+
 rocprofiler_systems_add_option(ROCPROFSYS_BUILD_SQLITE3
                                "Enable building sqlite3 library internally" ON
 )

projects/rocprofiler-systems/cmake/Packages.cmake

@@ -62,6 +62,9 @@ rocprofiler_systems_add_interface_library(rocprofiler-systems-sqlite3
 rocprofiler_systems_add_interface_library(rocprofiler-systems-json
     "Use nlohmann/json for json data handling"
 )
+rocprofiler_systems_add_interface_library(rocprofiler-systems-spdlog
+                                          "Provides spdlog library"
+)
 rocprofiler_systems_add_interface_library(rocprofiler-systems-timemory
     "Provides timemory libraries"
 )
@@ -675,6 +678,14 @@ include(Perfetto)
 
 include(SQLite3)
 
+# ----------------------------------------------------------------------------------------#
+#
+# Spdlog
+#
+# ----------------------------------------------------------------------------------------#
+
+include(Spdlog)
+
 # ----------------------------------------------------------------------------------------#
 #
 # NlohmannJson

projects/rocprofiler-systems/cmake/Spdlog.cmake

@@ -0,0 +1,38 @@
+include_guard(GLOBAL)
+
+if(ROCPROFSYS_BUILD_SPDLOG)
+    message(STATUS "Building spdlog from source!")
+
+    include(FetchContent)
+
+    rocprofiler_systems_checkout_git_submodule(
+        RELATIVE_PATH external/spdlog
+        WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
+        REPO_URL https://github.com/gabime/spdlog.git
+        TEST_FILE CMakeLists.txt
+        REPO_BRANCH "v1.16.0"
+    )
+
+    FetchContent_Declare(spdlog SOURCE_DIR ${PROJECT_SOURCE_DIR}/external/spdlog)
+
+    set(SPDLOG_BUILD_SHARED OFF CACHE BOOL "" FORCE)
+    set(SPDLOG_BUILD_EXAMPLE OFF CACHE BOOL "" FORCE)
+    set(SPDLOG_BUILD_TESTS OFF CACHE BOOL "" FORCE)
+    set(SPDLOG_INSTALL OFF CACHE BOOL "" FORCE)
+    set(SPDLOG_FMT_EXTERNAL OFF CACHE BOOL "" FORCE)
+
+    # Spdlog workaround for building static library
+    set(_ROCPROFSYS_BUILD_SHARED_LIBS_BACKUP ${BUILD_SHARED_LIBS})
+    set(BUILD_SHARED_LIBS OFF)
+
+    FetchContent_MakeAvailable(spdlog)
+
+    set(BUILD_SHARED_LIBS ${_ROCPROFSYS_BUILD_SHARED_LIBS_BACKUP})
+    unset(_ROCPROFSYS_BUILD_SHARED_LIBS_BACKUP)
+
+    target_link_libraries(rocprofiler-systems-spdlog INTERFACE spdlog::spdlog)
+else()
+    message(STATUS "Using system spdlog library")
+    find_package(spdlog REQUIRED)
+    target_link_libraries(rocprofiler-systems-spdlog INTERFACE spdlog::spdlog)
+endif()

projects/rocprofiler-systems/docs/install/install.rst

@@ -100,6 +100,7 @@ Required third-party packages
 
 * `libunwind <https://www.nongnu.org/libunwind/>`_ for call-stack sampling
 * `SQLite <https://github.com/sqlite/sqlite>`_ for database output
+* `spdlog <https://github.com/gabime/spdlog>`_ for logging
 
 Any of the third-party packages required by Dyninst, along with Dyninst itself, can be built and installed
 during the ROCm Systems Profiler build. The following list indicates the package, the version,
@@ -112,6 +113,7 @@ while Dyninst requires TBB), and the CMake option to build the package alongside
    "Dyninst", "13.0", "ROCm Systems Profiler", "``ROCPROFSYS_BUILD_DYNINST`` (default: OFF)"
    "Libunwind", "", "ROCm Systems Profiler", "``ROCPROFSYS_BUILD_LIBUNWIND`` (default: ON)"
    "Nlohmann/JSON", "", "ROCm Systems Profiler", "``ROCPROFSYS_BUILD_NLOHMANN_JSON`` (default: ON)"
+   "spdlog", "", "ROCm Systems Profiler", "``ROCPROFSYS_BUILD_SPDLOG`` (default: ON)"
    "SQLite", "", "ROCm Systems Profiler", "``ROCPROFSYS_BUILD_SQLITE`` (default: OFF)"
    "TBB", "2018.6", "Dyninst", "``ROCPROFSYS_BUILD_TBB`` (default: OFF)"
    "ElfUtils", "0.178", "Dyninst", "``ROCPROFSYS_BUILD_ELFUTILS`` (default: OFF)"

projects/rocprofiler-systems/external/spdlog

@@ -51,7 +51,7 @@ struct component_categories
         };
         (void) _cleanup;  // unused but set if sizeof...(Tp) == 0
 
-        TIMEMORY_FOLD_EXPRESSION(_v.emplace(TIMEMORY_JOIN(
+        ROCPROFSYS_FOLD_EXPRESSION(_v.emplace(TIMEMORY_JOIN(
             "::", "component", _cleanup(rocprofsys::utility::demangle<Tp>(), "tim::"))));
     }
 
@@ -68,7 +68,7 @@ struct component_categories<void>
     template <size_t... Idx>
     void operator()(std::set<std::string>& _v, std::index_sequence<Idx...>) const
     {
-        TIMEMORY_FOLD_EXPRESSION(component_categories<comp::enumerator_t<Idx>>{}(_v));
+        ROCPROFSYS_FOLD_EXPRESSION(component_categories<comp::enumerator_t<Idx>>{}(_v));
     }
 
     void operator()(std::set<std::string>& _v) const

projects/rocprofiler-systems/source/bin/rocprof-sys-avail/component_categories.hpp

@@ -400,6 +400,15 @@ parse_args(int argc, char** argv, std::vector<char*>& _env,
             std::min<int>(_cols - parser.get_help_width() - 8, 120));
 
     parser.start_group("DEBUG OPTIONS", "");
+
+    parser.add_argument({ "--log-level" }, "Log level")
+        .max_count(1)
+        .dtype("string")
+        .choices({ "trace", "debug", "info", "warn", "error", "critical", "off" })
+        .action([&](parser_t& p) {
+            update_env(_env, "ROCPROFSYS_LOG_LEVEL", p.get<std::string>("log-level"));
+        });
+
     parser.add_argument({ "--monochrome" }, "Disable colorized output")
         .max_count(1)
         .dtype("bool")
@@ -410,17 +419,26 @@ parse_args(int argc, char** argv, std::vector<char*>& _env,
             update_env(_env, "ROCPROFSYS_MONOCHROME", (_monochrome) ? "1" : "0");
             update_env(_env, "MONOCHROME", (_monochrome) ? "1" : "0");
         });
-    parser.add_argument({ "--debug" }, "Debug output")
+    parser.add_argument({ "--debug" }, "[DEPRECATED Use --log-level=debug] Debug output")
         .max_count(1)
         .action([&](parser_t& p) {
             update_env(_env, "ROCPROFSYS_DEBUG", p.get<bool>("debug"));
+            update_env(_env, "ROCPROFSYS_LOG_LEVEL", "debug");
         });
-    parser.add_argument({ "-v", "--verbose" }, "Verbose output")
+    parser
+        .add_argument({ "-v", "--verbose" },
+                      "[DEPRECATED Use --log-level=trace] Verbose output")
         .count(1)
         .action([&](parser_t& p) {
             auto _v = p.get<int>("verbose");
             verbose = _v;
             update_env(_env, "ROCPROFSYS_VERBOSE", _v);
+
+            constexpr std::array<const char*, 5> log_levels = { "off", "info", "debug",
+                                                                "debug", "trace" };
+
+            auto index = std::clamp(_v + 1, 0, static_cast<int>(log_levels.size() - 1));
+            update_env(_env, "ROCPROFSYS_LOG_LEVEL", log_levels[index]);
         });
 
     std::string _config_file      = {};

projects/rocprofiler-systems/source/bin/rocprof-sys-causal/impl.cpp

@@ -294,21 +294,47 @@ parse_args(int argc, char** argv, std::vector<char*>& _env)
                                            update_mode::REPLACE, ":", updated_envs,
                                            original_envs);
         });
-    parser.add_argument({ "--debug" }, "Debug output")
+
+    parser.add_argument({ "--log-level" }, "Log level")
+        .max_count(1)
+        .dtype("string")
+        .choices({ "trace", "debug", "info", "warn", "error", "critical", "off" })
+        .action([&](parser_t& p) {
+            rocprofsys::common::update_env(
+                _env, "ROCPROFSYS_LOG_LEVEL", p.get<std::string>("log-level"),
+                update_mode::REPLACE, ":", updated_envs, original_envs);
+        });
+
+    parser.add_argument({ "--debug" }, "[DEPRECATED Use --log-level=debug] Debug output")
         .max_count(1)
         .action([&](parser_t& p) {
             rocprofsys::common::update_env(_env, "ROCPROFSYS_DEBUG", p.get<bool>("debug"),
                                            update_mode::REPLACE, ":", updated_envs,
                                            original_envs);
+
+            rocprofsys::common::update_env(_env, "ROCPROFSYS_LOG_LEVEL", "debug",
+                                           update_mode::REPLACE, ":", updated_envs,
+                                           original_envs);
         });
-    parser.add_argument({ "-v", "--verbose" }, "Verbose output")
+    parser
+        .add_argument({ "-v", "--verbose" },
+                      "[DEPRECATED Use --log-level=trace] Verbose output")
         .count(1)
         .action([&](parser_t& p) {
             auto _v = p.get<int>("verbose");
             verbose = _v;
+
             rocprofsys::common::update_env(_env, "ROCPROFSYS_VERBOSE", _v,
                                            update_mode::REPLACE, ":", updated_envs,
                                            original_envs);
+
+            constexpr std::array<const char*, 5> log_levels = { "off", "info", "debug",
+                                                                "debug", "trace" };
+
+            auto index = std::clamp(_v + 1, 0, static_cast<int>(log_levels.size() - 1));
+            rocprofsys::common::update_env(_env, "ROCPROFSYS_LOG_LEVEL",
+                                           log_levels[index], update_mode::REPLACE, ":",
+                                           updated_envs, original_envs);
         });
 
     parser.start_group("GENERAL OPTIONS",