omnitrace-run executable - required for running binary writes (#257)

* omnitrace-run exe

- ensure LD_PRELOAD for libomnitrace-dl.so
- convert config options into command-line options

* Update timemory submodule

- updates to tsettings
- updates to argparser

* common environment update

- throw error if get_env<bool> has empty string

* config updates

- minor tweaks to categories of settings

* core lib update

- add argparse for common handling of argument parsers

* omnitrace-sample update

- fix handling of --trace-file (OMNITRACE_PERFETTO_FILE)

* omnitrace-run update

- updated to use omnitrace::argparse functions

* Tests for omnitrace-run

* argparse core update

- remove choices for --cpu-events and --gpu-events

* remove some debugging prints

* fix timemory include in argparse.cpp

* always provide --hsa-interrupt option

* Update source/lib/core/argparse.cpp

- fix pedantic warning

* Update testing

- remove testing args that may not be there in some builds

* roctracer/pthread_create fix

- disable roctracer_data when roctracer not enabled

* omnitrace-causal tweak

* omnitrace-instrument: module_function tweak

- allow DEFAULT_MODULE and LIBRARY_MODULE

* common environment update

- support get_env for enums

* core: config update

- Add "mode" category to OMNITRACE_MODE

* Update timemory submodule

- remove debug print statement

* omnitrace-sample tweak

- change var init

* omnitrace-run testing update

- use --help instead of -?

* core: common.hpp

- tweak header include style

* core: argparser update

- add_ld_preload func
- launcher and command member variables in parser_data
- support launcher

* omnitrace-run update

- clean up and reworked

* libomnitrace-dl updates

- require LD_PRELOAD with binary rewrite
- dl::InstrumentMode
- dl::get_instrumented()
- verify_instrumented_preloaded()
- omnitrace_set_instrumented(int)
- relocated omnitrace_main from main.c to dl.cpp
- omnitrace_set_env does not dlopen libomnitrace
- omnitrace_set_main(func_ptr) [internal API]
- OMNITRACE_HIDDEN_API -> OMNITRACE_INTERNAL_API

* Update testing to new LD_PRELOAD requirements

* omnitrace-instrument updates

- adhere to LD_PRELOAD requirementsa
- invoke omnitrace_set_instrumented
- binary rewrite does not instrument main
- binary rewrite does not instrument call to omnitrace_init
- runtime instr does not instrument main
- runtime instr does not instrument call to omnitrace_init

* Bump to v1.9.0

- LD_PRELOAD requirement necessitates minor version increment

* common: environment

- fix ambiguous get_env calls

* omnitrace-instrument update

- fix issue with temporaries

* omnitrace-instrument and libomnitrace-dl updates

- runtime instrumentation does not work if libomnitrace-dl is preloaded

* libomnitrace-dl and libpyomnitrace updates

- define dl::InstrumentMode in dl.hpp
- handle instrumentation via setprofile libpyomnitrace
  - do not push trace in omnitrace_init

* omnitrace-instrument and libomnitrace-dl updates

- move header to dl subdirectory
- omnitrace::omnitrace-headers include omnitrace-dl folder
- use InstrumentMode in omnitrace-instrument

* Update workflows and scripts

- Use omnitrace-run on instrumented exes

* Update docs

- add omnitrace-run to examples of running binary rewritten exes

source/lib/core/CMakeLists.txt

@@ -3,6 +3,7 @@ configure_file(${CMAKE_CURRENT_SOURCE_DIR}/defines.hpp.in
                ${CMAKE_CURRENT_BINARY_DIR}/defines.hpp @ONLY)
 
 set(core_sources
+    ${CMAKE_CURRENT_LIST_DIR}/argparse.cpp
     ${CMAKE_CURRENT_LIST_DIR}/categories.cpp
     ${CMAKE_CURRENT_LIST_DIR}/config.cpp
     ${CMAKE_CURRENT_LIST_DIR}/constraint.cpp
@@ -16,6 +17,7 @@ set(core_sources
     ${CMAKE_CURRENT_LIST_DIR}/timemory.cpp)
 
 set(core_headers
+    ${CMAKE_CURRENT_LIST_DIR}/argparse.hpp
     ${CMAKE_CURRENT_LIST_DIR}/categories.hpp
     ${CMAKE_CURRENT_LIST_DIR}/common.hpp
     ${CMAKE_CURRENT_LIST_DIR}/concepts.hpp

source/lib/core/argparse.hpp

@@ -0,0 +1,93 @@
+// MIT License
+//
+// Copyright (c) 2022 Advanced Micro Devices, Inc. All Rights Reserved.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+
+#pragma once
+
+#include "defines.hpp"
+
+#include <timemory/settings/vsettings.hpp>
+#include <timemory/utility/argparse.hpp>
+
+#include <functional>
+#include <set>
+#include <vector>
+
+namespace omnitrace
+{
+namespace argparse
+{
+struct parser_data;
+
+using parser_t          = ::tim::argparse::argument_parser;
+using vsetting_t        = ::tim::vsettings;
+using vsettings_set_t   = std::set<vsetting_t*>;
+using strset_t          = std::set<std::string>;
+using strvec_t          = std::vector<std::string>;
+using setting_filter_t  = std::function<bool(vsetting_t*, const parser_data&)>;
+using environ_filter_t  = std::function<bool(std::string_view, const parser_data&)>;
+using grouping_filter_t = std::function<bool(std::string_view, const parser_data&)>;
+
+bool
+default_setting_filter(vsetting_t*, const parser_data&);
+
+bool
+default_environ_filter(std::string_view, const parser_data&);
+
+bool
+default_grouping_filter(std::string_view, const parser_data&);
+
+struct parser_data
+{
+    bool                       monochrome         = false;
+    bool                       debug              = false;
+    int                        verbose            = 0;
+    std::string                dl_libpath         = {};
+    std::string                omni_libpath       = {};
+    std::string                launcher           = {};
+    vsettings_set_t            processed_settings = {};
+    std::set<std::string>      processed_environs = {};
+    std::set<std::string>      processed_groups   = {};
+    std::vector<char*>         current            = {};
+    std::vector<char*>         command            = {};
+    std::set<std::string_view> updated            = {};
+    std::set<std::string>      initial            = {};
+    grouping_filter_t          grouping_filter    = default_grouping_filter;
+    setting_filter_t           setting_filter     = default_setting_filter;
+    environ_filter_t           environ_filter     = default_environ_filter;
+};
+
+parser_data&
+init_parser(parser_data&);
+
+parser_data&
+add_ld_preload(parser_data&);
+
+parser_data&
+add_core_arguments(parser_t&, parser_data&);
+
+parser_data&
+add_group_arguments(parser_t&, const std::string&, parser_data&, bool _add_group = false);
+
+parser_data&
+add_extended_arguments(parser_t&, parser_data&);
+}  // namespace argparse
+}  // namespace omnitrace

source/lib/core/common.hpp

@@ -22,10 +22,10 @@
 
 #pragma once
 
-#include "categories.hpp"
 #include "common/join.hpp"
-#include "concepts.hpp"
-#include "defines.hpp"
+#include "core/categories.hpp"
+#include "core/concepts.hpp"
+#include "core/defines.hpp"
 
 #include <timemory/api.hpp>
 #include <timemory/api/macros.hpp>

source/lib/core/config.cpp

@@ -281,7 +281,7 @@ configure_settings(bool _init)
         std::string, "OMNITRACE_MODE",
         "Data collection mode. Used to set default values for OMNITRACE_USE_* options. "
         "Typically set by omnitrace binary instrumenter.",
-        std::string{ "trace" }, "backend", "advanced")
+        std::string{ "trace" }, "backend", "advanced", "mode")
         ->set_choices({ "trace", "sampling", "causal", "coverage" });
 
     OMNITRACE_CONFIG_SETTING(bool, "OMNITRACE_CI",
@@ -308,7 +308,7 @@ configure_settings(bool _init)
         "threads that get sampled, omnitrace can start all the background threads during "
         "initialization",
         get_env<size_t>("OMNITRACE_NUM_THREADS", 1), "threading", "performance",
-        "sampling", "debugging", "advanced");
+        "sampling", "parallelism", "advanced");
 
     OMNITRACE_CONFIG_SETTING(bool, "OMNITRACE_USE_PERFETTO", "Enable perfetto backend",
                              _default_perfetto_v, "backend", "perfetto");
@@ -680,13 +680,13 @@ configure_settings(bool _init)
                              "Enable collecting profiling and trace data for these "
                              "categories and disable all other categories",
                              "", "trace", "profile", "perfetto", "timemory", "data",
-                             "advanced")
+                             "category", "advanced")
         ->set_choices(get_available_categories<std::vector<std::string>>());
 
     OMNITRACE_CONFIG_SETTING(
         std::string, "OMNITRACE_DISABLE_CATEGORIES",
         "Disable collecting profiling and trace data for these categories", "", "trace",
-        "profile", "perfetto", "timemory", "data", "advanced")
+        "profile", "perfetto", "timemory", "data", "category", "advanced")
         ->set_choices(get_available_categories<std::vector<std::string>>());
 
     OMNITRACE_CONFIG_SETTING(bool, "OMNITRACE_PERFETTO_ANNOTATIONS",
@@ -705,19 +705,18 @@ configure_settings(bool _init)
 
     OMNITRACE_CONFIG_EXT_SETTING(int64_t, "OMNITRACE_CRITICAL_TRACE_COUNT",
                                  "Number of critical trace to export (0 == all)",
-                                 int64_t{ 0 }, "data", "critical_trace",
-                                 "omnitrace-critical-trace", "perfetto", "advanced");
+                                 int64_t{ 0 }, "critical_trace",
+                                 "omnitrace-critical-trace", "advanced");
 
     OMNITRACE_CONFIG_SETTING(uint64_t, "OMNITRACE_CRITICAL_TRACE_BUFFER_COUNT",
                              "Number of critical trace records to store in thread-local "
                              "memory before submitting to shared buffer",
-                             uint64_t{ 2000 }, "data", "critical_trace", "advanced");
+                             uint64_t{ 2000 }, "critical_trace", "advanced");
 
     OMNITRACE_CONFIG_EXT_SETTING(
         int64_t, "OMNITRACE_CRITICAL_TRACE_PER_ROW",
         "How many critical traces per row in perfetto (0 == all in one row)",
-        int64_t{ 0 }, "io", "critical_trace", "omnitrace-critical-trace", "perfetto",
-        "advanced");
+        int64_t{ 0 }, "critical_trace", "omnitrace-critical-trace", "advanced");
 
     OMNITRACE_CONFIG_SETTING(
         std::string, "OMNITRACE_TIMEMORY_COMPONENTS",
@@ -1506,9 +1505,15 @@ print_banner(std::ostream& _os)
     )banner";
     auto               _tag    = std::string_view{ OMNITRACE_GIT_DESCRIBE };
     auto               _rev    = std::string_view{ OMNITRACE_GIT_REVISION };
-    std::stringstream  _version_info{};
+#if OMNITRACE_HIP_VERSION_MAJOR > 0
+    auto _hip = JOIN('.', OMNITRACE_HIP_VERSION_MAJOR, OMNITRACE_HIP_VERSION_MINOR, "x");
+#else
+    auto _hip                 = std::string_view{};
+#endif
+
+    std::stringstream _version_info{};
     _version_info << "omnitrace v" << OMNITRACE_VERSION_STRING;
-    if(!_tag.empty() || !_rev.empty())
+    if(!_tag.empty() || !_rev.empty() || !_hip.empty())
     {
         _version_info << " (";
         if(!_tag.empty())
@@ -1516,10 +1521,21 @@ print_banner(std::ostream& _os)
             _version_info << "tag: " << OMNITRACE_GIT_DESCRIBE;
             if(!_rev.empty()) _version_info << ", ";
         }
-        if(!_rev.empty()) _version_info << "rev: " << OMNITRACE_GIT_REVISION;
-        _version_info << ")";
+
+        if(!_rev.empty())
+        {
+            _version_info << "rev: " << OMNITRACE_GIT_REVISION;
+            if(!_hip.empty()) _version_info << ", ";
+        }
+
+        if(!_hip.empty())
+        {
+            _version_info << "rocm: " << _hip;
+        }
     }
 
+    if(!_version_info.str().empty()) _version_info << ")";
+
     tim::log::stream(_os, tim::log::color::info()) << _banner << _version_info.str();
     _os << std::endl;
 }