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
2023-03-14 19:48:29 -05:00
parent ab0e5d9b44
commit abe35de43a
39 changed files with 2872 additions and 236 deletions
@@ -410,3 +410,119 @@ omnitrace_add_bin_test(
    PASS_REGEX
        "OMNITRACE_CONFIG_FILE(.*)OMNITRACE_ENABLED(.*)OMNITRACE_SUPPRESS_CONFIG(.*)OMNITRACE_SUPPRESS_PARSING(.*)OMNITRACE_VERBOSE"
    )
+
+omnitrace_add_bin_test(
+    NAME omnitrace-run-help
+    TARGET omnitrace-run
+    ARGS --help
+    TIMEOUT 45
+    LABELS "omnitrace-run")
+
+file(MAKE_DIRECTORY "${PROJECT_BINARY_DIR}/omnitrace-tests-config")
+file(
+    WRITE "${PROJECT_BINARY_DIR}/omnitrace-tests-config/empty.cfg"
+    "
+#
+# empty config file
+#
+")
+
+add_executable(sleeper ${CMAKE_CURRENT_SOURCE_DIR}/sleeper.cpp)
+set_target_properties(
+    sleeper PROPERTIES BUILD_TYPE RelWithDebInfo RUNTIME_OUTPUT_DIRECTORY
+                                                 ${PROJECT_BINARY_DIR}/bin/testing)
+
+omnitrace_add_bin_test(
+    NAME omnitrace-run-args
+    TARGET omnitrace-run
+    ARGS --monochrome
+         --debug=false
+         -v
+         1
+         -c
+         %env{TWD}%/omnitrace-tests-config/empty.cfg
+         -o
+         omnitrace-tests-output
+         omnitrace-run-args-output/
+         -TPHD
+         -S
+         cputime
+         realtime
+         --trace-wait=1.0e-12
+         --trace-duration=5.0
+         --wait=1.0
+         --duration=3.0
+         --trace-file=perfetto-run-args-trace.proto
+         --trace-buffer-size=100
+         --trace-fill-policy=ring_buffer
+         --profile-format
+         console
+         json
+         text
+         --process-freq
+         1000
+         --process-wait
+         0.0
+         --process-duration
+         10
+         --cpus
+         0-4
+         --gpus
+         0
+         -f
+         1000
+         --sampling-wait
+         1.0
+         --sampling-duration
+         10
+         -t
+         0-3
+         --sample-cputime
+         1000
+         1.0
+         0-3
+         --sample-realtime
+         10
+         0.5
+         0-3
+         -I
+         all
+         -E
+         mutex-locks
+         rw-locks
+         spin-locks
+         -C
+         perf::INSTRUCTIONS
+         --inlines
+         --hsa-interrupt
+         0
+         --use-causal=false
+         --use-kokkosp
+         --num-threads-hint=4
+         --sampling-allocator-size=32
+         --ci
+         --dl-verbose=3
+         --perfetto-annotations=off
+         --kokkosp-kernel-logger
+         --kokkosp-name-length-max=1024
+         --kokkosp-prefix="[kokkos]"
+         --tmpdir
+         ${CMAKE_BINARY_DIR}/omnitrace-tests-config/tmpdir
+         --perfetto-backend
+         inprocess
+         --use-pid
+         false
+         --time-output
+         off
+         --thread-pool-size
+         0
+         --timemory-components
+         wall_clock
+         cpu_clock
+         peak_rss
+         page_rss
+         --
+         $<TARGET_FILE:sleeper>
+         5
+    TIMEOUT 45
+    LABELS "omnitrace-run")
@@ -0,0 +1,28 @@
+
+#include <chrono>
+#include <ratio>
+#include <sstream>
+#include <thread>
+
+using clock_type = std::chrono::steady_clock;
+
+int
+main(int argc, char** argv)
+{
+    double _val = 0.0;
+    if(argc > 0)
+    {
+        auto _ss = std::stringstream{};
+        _ss << argv[1];
+        _ss >> _val;
+    }
+
+    intmax_t _nsec = _val * std::nano::den;
+    auto     _end  = clock_type::now() + std::chrono::nanoseconds{ _nsec };
+    while(clock_type::now() < _end)
+    {
+        std::this_thread::sleep_for(std::chrono::nanoseconds{ _nsec / 10 });
+    }
+
+    return 0;
+}