rocprofv3: summary reports + more JSON metadata (#1029)

* Move include/rocprofiler-sdk/cxx/details/delimit.hpp to tokenize.hpp

* Update docs/how-to/using-rocprofv3.rst

- fix code block indents
- reorder rocprofv3 options, limit them to important options
- add docs for `--runtime-trace`

* Update rocprofv3.py

- parser argument groups
- new `--runtime-trace` option
- new `--summary` option
- new `--summary-per-domain` option
- new `--summary-groups` option
- new `--summary-output-file` option
- new `--summary-units` option

* Update lib/rocprofiler-sdk/hsa/async_copy.cpp

- fix async copy operation names: add "MEMORY_COPY_" prefix

* lib/rocprofiler-sdk-tool: update statistics.{hpp,cpp}

- statistics<>::get_percent function
- stats_entry_t struct
- stats_formatter struct
- percentage struct
- std::to_string(::rocprofiler::tool::percentage)

* lib/rocprofiler-sdk-tool: update domain_type.{hpp,cpp}

- reorder domain_type enum values

* lib/rocprofiler-sdk-tool: update generateCSV.{hpp,cpp}

- separate writing CSV from accumulating statistics
- a lot of functionality was moved to statistics.{hpp,cpp}

* lib/rocprofiler-sdk-tool: update output_file.{hpp,cpp}

- output_stream_t struct
- get_output_stream(...) returns output_stream_t instance

* lib/rocprofiler-sdk-tool: update generateJSON.cpp

- update get_output_stream usage to output_stream_t

* lib/rocprofiler-sdk-tool: update generateOTF2.cpp

- header include order tweak

* lib/rocprofiler-sdk-tool: update buffered_output.hpp

- stats_data_t was renamed to stats_entry_t

* lib/rocprofiler-sdk-tool: update generatePerfetto.cpp

- header include tweak

* lib/rocprofiler-sdk-tool: update tmp_file_buffer.hpp

- emit warning message if write_ring_buffer fails after offloading instead of aborting
- prefer placement new instead of assignment in write_ring_buffer

* lib/rocprofiler-sdk-tool: add generateStats.{hpp,cpp}

- functions for accumulating statistics

* Update tests/rocprofv3/tracing-hip-in-libraries/CMakeLists.txt

- accommodate tweak to CSV output file name for HIP and HSA traces

* lib/rocprofiler-sdk-tool: update config.{hpp,cpp}

- new config variables
  - stats_summary
  - stats_summary_per_domain
  - summary_output
  - stats_summary_unit_value
  - stats_summary_unit
  - stats_summary_file
  - stats_summary_groups
- support output keys for hostname: %hostname% / %h

* lib/rocprofiler-sdk-tool: update tool.cpp

- support summary output

* Documentation fixes

* Test for summary output

* Update tests/bin/transpose to use more ROCTx

- also support building with the roctracer ROCTx

* Remove roctxMark from OTF2 + fix kernel-rename tests

- following more ROCTx calls in transpose, kernel-rename validation had to be updated

* JSON metadata + JSON summary

- add serialization support for config
- add serialization support for statistics
- additions to json spec
  - rocprofiler-sdk-tool/metadata/config
  - rocprofiler-sdk-tool/metadata/command
  - rocprofiler-sdk-tool/summary
- config output_keys support for NVIDIA %q{<ENV-VAR>} syntax
- config output_keys support keys within keys

* rocprofv3 --summary-groups warning if no domain matches

- emit warning if a regex in for summary groups did not match any domain names

* Compile fix for lib/rocprofiler-sdk-tool/tool.cpp

- get_config().scratch_memory_trace
- pass contributions to write_json

* Update rocprofv3.py to preload rocprofiler-sdk-roctx

- appended to LD_PRELOAD when args.marker_trace is enabled

* Fix ReST link errors about subtitle underline being too short

* Patch tokenization of config::stats_summary_groups

- guard against array values of empty strings

* Tweak rocprofv3 summary test

- input-summary.yaml (used by rocprofv3-test-summary-inp-yaml-execute) only provides one summary group regex

* Disable LD_PRELOAD of librocprofiler-sdk-roctx.so

- this causes problems in the sanitizers, will be addressed in another PR

source/include/rocprofiler-sdk/cxx/details/CMakeLists.txt

@@ -3,7 +3,7 @@
 #   Installation of public C++ headers (implementations)
 #
 #
-set(ROCPROFILER_CXX_DETAILS_HEADER_FILES delimit.hpp join.hpp mpl.hpp name_info.hpp)
+set(ROCPROFILER_CXX_DETAILS_HEADER_FILES tokenize.hpp join.hpp mpl.hpp name_info.hpp)
 
 install(
     FILES ${ROCPROFILER_CXX_DETAILS_HEADER_FILES}

source/include/rocprofiler-sdk/cxx/details/tokenize.hpp

@@ -105,6 +105,64 @@ tokenize(
     return _result;
 }
 
+/// \brief tokenize a string into a set
+///
+template <typename ContainerT = std::vector<std::string>,
+          typename DelimT     = std::string_view,
+          typename ValueT     = typename ContainerT::value_type,
+          typename PredicateT = ValueT (*)(DelimT&&)>
+inline ContainerT
+tokenize(
+    std::string_view           line,
+    const std::vector<DelimT>& delimiters,
+    PredicateT&&               predicate = [](DelimT&& s) -> ValueT { return ValueT{s}; })
+{
+    ContainerT _result = {};
+    size_t     _start  = 0;
+    size_t     _end    = std::string::npos;
+
+    while(_start != std::string::npos)
+    {
+        _end = std::string::npos;
+
+        // Find the earliest occurrence of any delimiter
+        for(const auto& itr : delimiters)
+        {
+            size_t pos = line.find(itr, _start);
+            if(pos != std::string::npos && (_end == std::string::npos || pos < _end))
+            {
+                _end = pos;
+            }
+        }
+
+        // Extract token and update start position
+        if(_end != std::string::npos)
+        {
+            mpl::emplace(_result,
+                         std::forward<PredicateT>(predicate)(line.substr(_start, _end - _start)));
+            _start = _end;
+
+            // Move start past the delimiter
+            for(const auto& delimiter : delimiters)
+            {
+                if(line.compare(_start, delimiter.size(), delimiter) == 0)
+                {
+                    _start += delimiter.size();
+                    break;
+                }
+            }
+        }
+        else
+        {
+            // Last token after the final delimiter
+            mpl::emplace(_result, std::forward<PredicateT>(predicate)(line.substr(_start)));
+            break;
+        }
+    }
+
+    return _result;
+}
+
 ///  \brief apply a string transformation to substring in between a common delimiter.
 ///
 template <typename PredicateT = std::function<std::string(const std::string&)>>