Rename OMNITRACE_USE_TIMEMORY to OMNITRACE_PROFILE

.github/workflows/ubuntu-focal.yml

@@ -278,7 +278,7 @@ jobs:
         echo "CMAKE_PREFIX_PATH=/opt/dyninst:${CMAKE_PREFIX_PATH}" >> $GITHUB_ENV
         echo "LD_LIBRARY_PATH=/opt/rocm/lib:/usr/local/lib:${LD_LIBRARY_PATH}" >> $GITHUB_ENV
         cat << EOF > test-install.cfg
-        OMNITRACE_USE_TIMEMORY          = ON
+        OMNITRACE_PROFILE               = ON
         OMNITRACE_TRACE                 = ON
         OMNITRACE_USE_PID               = OFF
         OMNITRACE_USE_SAMPLING          = OFF

README.md

@@ -147,7 +147,7 @@ and tweak some sampling default values:
 ```console
 # ...
 OMNITRACE_TRACE                = true
-OMNITRACE_USE_TIMEMORY         = true
+OMNITRACE_PROFILE              = true
 OMNITRACE_USE_SAMPLING         = true
 OMNITRACE_USE_PROCESS_SAMPLING = true
 # ...

scripts/test-install.sh

@@ -60,7 +60,7 @@ usage()
 
 cat << EOF > ${CONFIG_DIR}/omnitrace.cfg
 OMNITRACE_VERBOSE               = 2
-OMNITRACE_USE_TIMEMORY          = ON
+OMNITRACE_PROFILE               = ON
 OMNITRACE_TRACE                 = ON
 OMNITRACE_USE_SAMPLING          = ON
 OMNITRACE_USE_PROCESS_SAMPLING  = ON

source/bin/omnitrace-avail/generate_config.cpp

@@ -338,7 +338,7 @@ generate_config(std::string _config_file, const std::set<std::string>& _config_f
                 if(_romni && !_lomni) return false;
                 for(const auto* itr :
                     { "OMNITRACE_CONFIG", "OMNITRACE_MODE", "OMNITRACE_TRACE",
-                      "OMNITRACE_USE_TIMEMORY", "OMNITRACE_USE_SAMPLING",
+                      "OMNITRACE_PROFILE", "OMNITRACE_USE_SAMPLING",
                       "OMNITRACE_USE_PROCESS_SAMPLING", "OMNITRACE_USE_ROCTRACER",
                       "OMNITRACE_USE_ROCM_SMI", "OMNITRACE_USE_KOKKOSP",
                       "OMNITRACE_USE_OMPT", "OMNITRACE_USE", "OMNITRACE_OUTPUT" })

source/bin/omnitrace-causal/impl.cpp

@@ -198,7 +198,7 @@ get_initial_environment()
     update_env(_env, "OMNITRACE_USE_CAUSAL", true);
     update_env(_env, "OMNITRACE_USE_SAMPLING", false);
     update_env(_env, "OMNITRACE_TRACE", false);
-    update_env(_env, "OMNITRACE_USE_TIMEMORY", false);
+    update_env(_env, "OMNITRACE_PROFILE", false);
     update_env(_env, "OMNITRACE_USE_PROCESS_SAMPLING", false);
     update_env(_env, "OMNITRACE_CRITICAL_TRACE", false);
     update_env(_env, "OMNITRACE_THREAD_POOL_SIZE",

source/bin/omnitrace-instrument/omnitrace-instrument.cpp

@@ -876,7 +876,7 @@ main(int argc, char** argv)
                      "defaults in the executable");
     parser.add_argument({ "--env" },
                         "Environment variables to add to the runtime in form "
-                        "VARIABLE=VALUE. E.g. use '--env OMNITRACE_USE_TIMEMORY=ON' to "
+                        "VARIABLE=VALUE. E.g. use '--env OMNITRACE_PROFILE=ON' to "
                         "default to using timemory instead of perfetto");
     parser
         .add_argument({ "--mpi" },

source/bin/omnitrace-sample/impl.cpp

@@ -434,15 +434,15 @@ parse_args(int argc, char** argv, std::vector<char*>& _env)
         .max_count(1)
         .conflicts({ "flat-profile" })
         .action([&](parser_t& p) {
-            update_env(_env, "OMNITRACE_USE_TIMEMORY", p.get<bool>("profile"));
+            update_env(_env, "OMNITRACE_PROFILE", p.get<bool>("profile"));
         });
     parser
         .add_argument({ "-F", "--flat-profile" },
                       "Generate a flat profile (conflicts with --profile)")
         .max_count(1)
         .conflicts({ "profile" })
         .action([&](parser_t& p) {
-            update_env(_env, "OMNITRACE_USE_TIMEMORY", p.get<bool>("flat-profile"));
+            update_env(_env, "OMNITRACE_PROFILE", p.get<bool>("flat-profile"));
             update_env(_env, "OMNITRACE_FLAT_PROFILE", p.get<bool>("flat-profile"));
         });
     parser
@@ -572,7 +572,7 @@ parse_args(int argc, char** argv, std::vector<char*>& _env)
         .choices({ "text", "json", "console" })
         .action([&](parser_t& p) {
             auto _v = p.get<std::set<std::string>>("profile");
-            update_env(_env, "OMNITRACE_USE_TIMEMORY", true);
+            update_env(_env, "OMNITRACE_PROFILE", true);
             if(!_v.empty())
             {
                 update_env(_env, "OMNITRACE_TEXT_OUTPUT", _v.count("text") != 0);

source/bin/tests/CMakeLists.txt

@@ -29,7 +29,7 @@ function(OMNITRACE_ADD_BIN_TEST)
     if(NOT TEST_ENVIRONMENT)
         set(TEST_ENVIRONMENT
             "OMNITRACE_TRACE=ON"
-            "OMNITRACE_USE_TIMEMORY=ON"
+            "OMNITRACE_PROFILE=ON"
             "OMNITRACE_USE_SAMPLING=ON"
             "OMNITRACE_TIME_OUTPUT=OFF"
             "LD_LIBRARY_PATH=${PROJECT_BINARY_DIR}/${CMAKE_INSTALL_LIBDIR}:${OMNITRACE_DYNINST_API_RT_DIR}:$ENV{LD_LIBRARY_PATH}"
@@ -344,7 +344,7 @@ omnitrace_add_bin_test(
          json xml --force
     TIMEOUT 45
     LABELS "omnitrace-avail"
-    ENVIRONMENT "OMNITRACE_TRACE=OFF;OMNITRACE_USE_TIMEMORY=ON"
+    ENVIRONMENT "OMNITRACE_TRACE=OFF;OMNITRACE_PROFILE=ON"
     PASS_REGEX
         "Outputting JSON configuration file '${_AVAIL_CFG_PATH}tweak\\\.json'(.*)Outputting XML configuration file '${_AVAIL_CFG_PATH}tweak\\\.xml'(.*)Outputting text configuration file '${_AVAIL_CFG_PATH}tweak\\\.cfg'(.*)"
     )

source/docs/instrumenting.md

@@ -249,7 +249,7 @@ Options:
     -d, --default-components       Default components to instrument (only useful when timemory is enabled in omnitrace
                                    library)
     --env                          Environment variables to add to the runtime in form VARIABLE=VALUE. E.g. use '--env
-                                   OMNITRACE_USE_TIMEMORY=ON' to default to using timemory instead of perfetto
+                                   OMNITRACE_PROFILE=ON' to default to using timemory instead of perfetto
     --mpi                          Enable MPI support (requires omnitrace built w/ full or partial MPI support). NOTE: this
                                    will automatically be activated if MPI_Init, MPI_Init_thread, MPI_Finalize,
                                    MPI_Comm_rank, or MPI_Comm_size are found in the symbol table of target

source/docs/output.md

@@ -16,7 +16,7 @@ E.g. with the base configuration:
 export OMNITRACE_OUTPUT_PATH=omnitrace-example-output
 export OMNITRACE_TIME_OUTPUT=ON
 export OMNITRACE_USE_PID=OFF
-export OMNITRACE_USE_TIMEMORY=ON
+export OMNITRACE_PROFILE=ON
 export OMNITRACE_TRACE=ON
 ```
 

source/docs/python.md

@@ -115,7 +115,7 @@ if __name__ == "__main__":
     run(20)
 ```
 
-Using `omnitrace-python ./example.py` with `OMNITRACE_USE_TIMEMORY=ON` and `OMNITRACE_TIMEMORY_COMPONENTS=trip_count` would produce:
+Using `omnitrace-python ./example.py` with `OMNITRACE_PROFILE=ON` and `OMNITRACE_TIMEMORY_COMPONENTS=trip_count` would produce:
 
 ```console
 |-------------------------------------------------------------------------------------------|

source/docs/runtime.md

@@ -25,7 +25,7 @@ and tweak some sampling default values:
 ```console
 # ...
 OMNITRACE_TRACE                = true
-OMNITRACE_USE_TIMEMORY         = true
+OMNITRACE_PROFILE              = true
 OMNITRACE_USE_SAMPLING         = true
 OMNITRACE_USE_PROCESS_SAMPLING = true
 # ...
@@ -50,7 +50,7 @@ match to nearly all common expressions for boolean logic: ON, OFF, YES, NO, TRUE
 ### Exploring Components
 
 [OmniTrace](https://github.com/AMDResearch/omnitrace) uses [timemory](https://github.com/NERSC/timemory) extensively to provide various capabilities and manage
-data and resources. By default, when `OMNITRACE_USE_TIMEMORY=ON`, omnitrace will only collect wall-clock
+data and resources. By default, when `OMNITRACE_PROFILE=ON`, omnitrace will only collect wall-clock
 timing values; however, by modifying the `OMNITRACE_TIMEMORY_COMPONENTS` setting, omnitrace can be configured to
 collect hardware counters, CPU-clock timers, memory usage, context-switches, page-faults, network statistics,
 and many more. In fact, omnitrace can actually be used as a dynamic instrumentation vehicle for other 3rd-party profiling
@@ -180,7 +180,7 @@ $ cat ~/.omnitrace.cfg
 OMNITRACE_CONFIG_FILE                              =
 OMNITRACE_MODE                                     = trace
 OMNITRACE_TRACE                                    = true
-OMNITRACE_USE_TIMEMORY                             = false
+OMNITRACE_PROFILE                                  = false
 OMNITRACE_USE_SAMPLING                             = false
 OMNITRACE_USE_PROCESS_SAMPLING                     = true
 OMNITRACE_USE_ROCTRACER                            = true
@@ -358,7 +358,7 @@ $ omnitrace-avail -S -bd
 | OMNITRACE_USE_ROCTRACER                 | Enable ROCM tracing                     |
 | OMNITRACE_USE_SAMPLING                  | Enable statistical sampling of call-... |
 | OMNITRACE_USE_PROCESS_SAMPLING          | Enable a background thread which sam... |
-| OMNITRACE_USE_TIMEMORY                  | Enable timemory backend                 |
+| OMNITRACE_PROFILE                       | Enable timemory backend                 |
 | OMNITRACE_VERBOSE                       | Verbosity level                         |
 | OMNITRACE_WIDTH                         | Set the global output width for comp... |
 |-----------------------------------------|-----------------------------------------|
@@ -1193,7 +1193,7 @@ $SAMPLE                         = OFF
 
 # use fields
 OMNITRACE_TRACE                 = $ENABLE
-OMNITRACE_USE_TIMEMORY          = $ENABLE
+OMNITRACE_PROFILE               = $ENABLE
 OMNITRACE_USE_SAMPLING          = $SAMPLE
 OMNITRACE_USE_PROCESS_SAMPLING  = $SAMPLE
 

source/docs/sampling.md

@@ -243,7 +243,7 @@ OMNITRACE_USE_ROCPROFILER=true
 OMNITRACE_USE_ROCTRACER=true
 OMNITRACE_USE_ROCTX=true
 OMNITRACE_USE_SAMPLING=true
-OMNITRACE_USE_TIMEMORY=true
+OMNITRACE_PROFILE=true
 OMP_TOOL_LIBRARIES=/opt/omnitrace/lib/libomnitrace-dl.so.1.7.1
 ROCP_TOOL_LIB=/opt/omnitrace/lib/libomnitrace.so.1.7.1
 
@@ -275,7 +275,7 @@ OMNITRACE_USE_ROCPROFILER=false
 OMNITRACE_USE_ROCTRACER=false
 OMNITRACE_USE_ROCTX=false
 OMNITRACE_USE_SAMPLING=true
-OMNITRACE_USE_TIMEMORY=true
+OMNITRACE_PROFILE=true
 
 ...
 ```
@@ -305,7 +305,7 @@ OMNITRACE_USE_ROCPROFILER=false
 OMNITRACE_USE_ROCTRACER=false
 OMNITRACE_USE_ROCTX=false
 OMNITRACE_USE_SAMPLING=true
-OMNITRACE_USE_TIMEMORY=true
+OMNITRACE_PROFILE=true
 
 [omnitrace][omnitrace_init_tooling] Instrumentation mode: Sampling
 

source/lib/core/argparse.cpp

@@ -411,7 +411,7 @@ add_core_arguments(parser_t& _parser, parser_data& _data)
             .max_count(1)
             .conflicts({ "flat-profile" })
             .action([&](parser_t& p) {
-                update_env(_data, "OMNITRACE_USE_TIMEMORY", p.get<bool>("profile"));
+                update_env(_data, "OMNITRACE_PROFILE", p.get<bool>("profile"));
             });
 
         _data.processed_environs.emplace("profile");
@@ -425,7 +425,7 @@ add_core_arguments(parser_t& _parser, parser_data& _data)
             .max_count(1)
             .conflicts({ "profile" })
             .action([&](parser_t& p) {
-                update_env(_data, "OMNITRACE_USE_TIMEMORY", p.get<bool>("flat-profile"));
+                update_env(_data, "OMNITRACE_PROFILE", p.get<bool>("flat-profile"));
                 update_env(_data, "OMNITRACE_FLAT_PROFILE", p.get<bool>("flat-profile"));
             });
 
@@ -874,7 +874,7 @@ add_core_arguments(parser_t& _parser, parser_data& _data)
             .choices({ "text", "json", "console" })
             .action([&](parser_t& p) {
                 auto _v = p.get<strset_t>("profile-format");
-                update_env(_data, "OMNITRACE_USE_TIMEMORY", true);
+                update_env(_data, "OMNITRACE_PROFILE", true);
                 if(!_v.empty())
                 {
                     update_env(_data, "OMNITRACE_TEXT_OUTPUT", _v.count("text") != 0);

source/lib/core/config.cpp

@@ -230,7 +230,7 @@ configure_settings(bool _init)
 
     // if using timemory, default to perfetto being off
     auto _default_perfetto_v =
-        !tim::get_env<bool>("OMNITRACE_USE_TIMEMORY", false, false);
+        !tim::get_env<bool>("OMNITRACE_PROFILE", false, false);
 
     auto _system_backend =
         tim::get_env("OMNITRACE_PERFETTO_BACKEND_SYSTEM", false, false);
@@ -278,9 +278,13 @@ configure_settings(bool _init)
                             "[DEPRECATED] Renamed to OMNITRACE_TRACE",
                              _default_perfetto_v, "backend", "perfetto", "deprecated");
 
-    OMNITRACE_CONFIG_SETTING(bool, "OMNITRACE_USE_TIMEMORY", "Enable timemory backend",
+    OMNITRACE_CONFIG_SETTING(bool, "OMNITRACE_PROFILE", "Enable timemory backend",
                              !_config->get<bool>("OMNITRACE_TRACE"), "backend",
                              "timemory");
+
+    OMNITRACE_CONFIG_SETTING(bool, "OMNITRACE_USE_TIMEMORY", "[DEPRECATED] Renamed to OMNITRACE_PROFILE",
+                             !_config->get<bool>("OMNITRACE_TRACE"), "backend",
+                             "timemory", "deprecated");
 
     OMNITRACE_CONFIG_SETTING(bool, "OMNITRACE_USE_CAUSAL",
                              "Enable causal profiling analysis", false, "backend",
@@ -1072,6 +1076,7 @@ configure_settings(bool _init)
                               "OMNITRACE_USE_PROCESS_SAMPLING");
     handle_deprecated_setting("OMNITRACE_OUTPUT_FILE", "OMNITRACE_PERFETTO_FILE");
     handle_deprecated_setting("OMNITRACE_USE_PERFETTO", "OMNITRACE_TRACE");
+    handle_deprecated_setting("OMNITRACE_USE_TIMEMORY", "OMNITRACE_PROFILE");
 
     scope::get_fields()[scope::flat::value]     = _config->get_flat_profile();
     scope::get_fields()[scope::timeline::value] = _config->get_timeline_profile();
@@ -1134,7 +1139,7 @@ configure_mode_settings(const std::shared_ptr<settings>& _config)
     {
         set_default_setting_value("OMNITRACE_USE_CODE_COVERAGE", true);
         _set("OMNITRACE_TRACE", false);
-        _set("OMNITRACE_USE_TIMEMORY", false);
+        _set("OMNITRACE_PROFILE", false);
         _set("OMNITRACE_USE_CAUSAL", false);
         _set("OMNITRACE_USE_ROCM_SMI", false);
         _set("OMNITRACE_USE_ROCTRACER", false);
@@ -1150,7 +1155,7 @@ configure_mode_settings(const std::shared_ptr<settings>& _config)
     {
         _set("OMNITRACE_USE_CAUSAL", true);
         _set("OMNITRACE_TRACE", false);
-        _set("OMNITRACE_USE_TIMEMORY", false);
+        _set("OMNITRACE_PROFILE", false);
         _set("OMNITRACE_CRITICAL_TRACE", false);
         _set("OMNITRACE_USE_SAMPLING", false);
         _set("OMNITRACE_USE_PROCESS_SAMPLING", false);
@@ -1200,7 +1205,7 @@ configure_mode_settings(const std::shared_ptr<settings>& _config)
     if(!_config->get_enabled())
     {
         _set("OMNITRACE_USE_TRACE", false);
-        _set("OMNITRACE_USE_TIMEMORY", false);
+        _set("OMNITRACE_PROFILE", false);
         _set("OMNITRACE_USE_CAUSAL", false);
         _set("OMNITRACE_USE_ROCM_SMI", false);
         _set("OMNITRACE_USE_ROCTRACER", false);
@@ -1386,7 +1391,7 @@ configure_disabled_settings(const std::shared_ptr<settings>& _config)
     _handle_use_option("OMNITRACE_USE_CAUSAL", "causal");
     _handle_use_option("OMNITRACE_USE_KOKKOSP", "kokkos");
     _handle_use_option("OMNITRACE_USE_TRACE", "perfetto");
-    _handle_use_option("OMNITRACE_USE_TIMEMORY", "timemory");
+    _handle_use_option("OMNITRACE_PROFILE", "timemory");
     _handle_use_option("OMNITRACE_USE_OMPT", "ompt");
     _handle_use_option("OMNITRACE_USE_RCCLP", "rcclp");
     _handle_use_option("OMNITRACE_USE_ROCM_SMI", "rocm_smi");
@@ -1858,7 +1863,7 @@ get_use_perfetto()
 bool&
 get_use_timemory()
 {
-    static auto _v = get_config()->find("OMNITRACE_USE_TIMEMORY");
+    static auto _v = get_config()->find("OMNITRACE_PROFILE");
     return static_cast<tim::tsettings<bool>&>(*_v->second).get();
 }
 

tests/omnitrace-instrument-tests.cmake

@@ -50,5 +50,5 @@ omnitrace_add_test(
     REWRITE_ARGS -e -v 2 --min-instructions=8
     RUN_ARGS 10 4 1000
     ENVIRONMENT
-        "${_lock_environment};OMNITRACE_FLAT_PROFILE=ON;OMNITRACE_USE_TIMEMORY=OFF;OMNITRACE_TRACE=ON;OMNITRACE_SAMPLING_KEEP_INTERNAL=OFF"
+        "${_lock_environment};OMNITRACE_FLAT_PROFILE=ON;OMNITRACE_PROFILE=OFF;OMNITRACE_TRACE=ON;OMNITRACE_SAMPLING_KEEP_INTERNAL=OFF"
     )

tests/omnitrace-mpi-tests.cmake

@@ -79,7 +79,7 @@ omnitrace_add_test(
 
 set(_mpip_environment
     "OMNITRACE_TRACE=ON"
-    "OMNITRACE_USE_TIMEMORY=ON"
+    "OMNITRACE_PROFILE=ON"
     "OMNITRACE_USE_SAMPLING=OFF"
     "OMNITRACE_USE_PROCESS_SAMPLING=OFF"
     "OMNITRACE_TIME_OUTPUT=OFF"
@@ -93,7 +93,7 @@ set(_mpip_environment
 
 set(_mpip_all2all_environment
     "OMNITRACE_TRACE=ON"
-    "OMNITRACE_USE_TIMEMORY=ON"
+    "OMNITRACE_PROFILE=ON"
     "OMNITRACE_USE_SAMPLING=OFF"
     "OMNITRACE_USE_PROCESS_SAMPLING=OFF"
     "OMNITRACE_TIME_OUTPUT=OFF"

tests/omnitrace-pthread-tests.cmake

@@ -12,7 +12,7 @@ omnitrace_add_test(
     RUNTIME_ARGS -e -i 256
     RUN_ARGS 30 4 1000
     ENVIRONMENT
-        "${_lock_environment};OMNITRACE_USE_TIMEMORY=ON;OMNITRACE_TRACE=ON;OMNITRACE_COLLAPSE_THREADS=OFF;OMNITRACE_SAMPLING_REALTIME=ON;OMNITRACE_SAMPLING_REALTIME_FREQ=10;OMNITRACE_SAMPLING_REALTIME_TIDS=0;OMNITRACE_SAMPLING_KEEP_INTERNAL=OFF"
+        "${_lock_environment};OMNITRACE_PROFILE=ON;OMNITRACE_TRACE=ON;OMNITRACE_COLLAPSE_THREADS=OFF;OMNITRACE_SAMPLING_REALTIME=ON;OMNITRACE_SAMPLING_REALTIME_FREQ=10;OMNITRACE_SAMPLING_REALTIME_TIDS=0;OMNITRACE_SAMPLING_KEEP_INTERNAL=OFF"
     REWRITE_RUN_PASS_REGEX
         "wall_clock .*\\|_pthread_create .* 4 .*\\|_pthread_mutex_lock .* 1000 .*\\|_pthread_mutex_unlock .* 1000 .*\\|_pthread_mutex_lock .* 1000 .*\\|_pthread_mutex_unlock .* 1000 .*\\|_pthread_mutex_lock .* 1000 .*\\|_pthread_mutex_unlock .* 1000 .*\\|_pthread_mutex_lock .* 1000 .*\\|_pthread_mutex_unlock .* 1000"
     RUNTIME_PASS_REGEX
@@ -28,7 +28,7 @@ omnitrace_add_test(
                  TrampRecursive
     RUN_ARGS 10 4 1000
     ENVIRONMENT
-        "${_lock_environment};OMNITRACE_FLAT_PROFILE=ON;OMNITRACE_USE_TIMEMORY=ON;OMNITRACE_TRACE=OFF;OMNITRACE_SAMPLING_KEEP_INTERNAL=OFF"
+        "${_lock_environment};OMNITRACE_FLAT_PROFILE=ON;OMNITRACE_PROFILE=ON;OMNITRACE_TRACE=OFF;OMNITRACE_SAMPLING_KEEP_INTERNAL=OFF"
     REWRITE_RUN_PASS_REGEX
         "start_thread (.*) 4 (.*) pthread_mutex_lock (.*) 4000 (.*) pthread_mutex_unlock (.*) 4000"
     )