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/common/environment.hpp

@@ -26,8 +26,10 @@
 #include <cstdlib>
 #include <cstring>
 #include <iostream>
+#include <stdexcept>
 #include <string>
 #include <string_view>
+#include <type_traits>
 
 namespace omnitrace
 {
@@ -36,7 +38,7 @@ inline namespace common
 namespace
 {
 inline std::string
-get_env(std::string_view env_id, std::string_view _default)
+get_env_impl(std::string_view env_id, std::string_view _default)
 {
     if(env_id.empty()) return std::string{ _default };
     char* env_var = ::std::getenv(env_id.data());
@@ -45,13 +47,13 @@ get_env(std::string_view env_id, std::string_view _default)
 }
 
 inline std::string
-get_env(std::string_view env_id, const char* _default)
+get_env_impl(std::string_view env_id, const char* _default)
 {
-    return get_env(env_id, std::string_view{ _default });
+    return get_env_impl(env_id, std::string_view{ _default });
 }
 
 inline int
-get_env(std::string_view env_id, int _default)
+get_env_impl(std::string_view env_id, int _default)
 {
     if(env_id.empty()) return _default;
     char* env_var = ::std::getenv(env_id.data());
@@ -73,15 +75,21 @@ get_env(std::string_view env_id, int _default)
 }
 
 inline bool
-get_env(std::string_view env_id, bool _default)
+get_env_impl(std::string_view env_id, bool _default)
 {
     if(env_id.empty()) return _default;
     char* env_var = ::std::getenv(env_id.data());
     if(env_var)
     {
+        if(std::string_view{ env_var }.empty())
+            throw std::runtime_error(std::string{ "No boolean value provided for " } +
+                                     std::string{ env_id });
+
         if(std::string_view{ env_var }.find_first_not_of("0123456789") ==
            std::string_view::npos)
+        {
             return static_cast<bool>(std::stoi(env_var));
+        }
         else
         {
             for(size_t i = 0; i < strlen(env_var); ++i)
@@ -93,6 +101,22 @@ get_env(std::string_view env_id, bool _default)
     }
     return _default;
 }
+
+template <typename Tp>
+inline auto
+get_env(std::string_view env_id, Tp&& _default)
+{
+    if constexpr(std::is_enum<Tp>::value)
+    {
+        using Up = std::underlying_type_t<Tp>;
+        // cast to underlying type -> get_env -> cast to enum type
+        return static_cast<Tp>(get_env_impl(env_id, static_cast<Up>(_default)));
+    }
+    else
+    {
+        return get_env_impl(env_id, std::forward<Tp>(_default));
+    }
+}
 }  // namespace
 }  // namespace common
 }  // namespace omnitrace