ROCTx Library Tracing (#390)

* Update include/rocprofiler-sdk/marker/* - Update rocprofiler_marker_api_args_t for all API functions - Add ROCPROFILER_MARKER_API_ID_roctxGetThreadId to rocprofiler_marker_api_id_t * Update include/rocprofiler-sdk/marker/api_args.h - fix include * Update lib/common/mpl.hpp - is_pair - is_type_complete_v * Update include/rocprofiler-sdk/marker/* - fix rocprofiler_marker_api_retval_t - add roctxGetThreadId to rocprofiler_marker_api_args_t - fix type in enum: HsaDevice -> HsaAgent - add table_api_id.h * Update include/rocprofiler-sdk/marker.h - include marker/table_api_id.h * Update include/rocprofiler-sdk/buffer_tracing.h - Buffer marker tracer records have begin and end timestamp * Add lib/rocprofiler-sdk/marker - tracing implementation for marker (roctx) library * Update include/rocprofiler-sdk/{buffer_tracing,marker/table_api_id}.h - rocprofiler_buffer_tracing_marker_record_t -> rocprofiler_buffer_tracing_marker_api_record_t * Update lib/rocprofiler-sdk/buffer_tracing.cpp - support for ROCPROFILER_BUFFER_TRACING_MARKER_API * Update lib/rocprofiler-sdk/callback_tracing.cpp - support for ROCPROFILER_CALLBACK_TRACING_MARKER_API * Update lib/rocprofiler-sdk/intercept_table.cpp - template instantiation for notify_runtime_api_registration * Update lib/rocprofiler-sdk/registration.cpp - enable roctx in rocprofiler_set_api_table * Update lib/rocprofiler-sdk/marker/marker.cpp - rocprofiler_buffer_tracing_marker_record_t -> rocprofiler_buffer_tracing_marker_api_record_t * Update lib/rocprofiler/tests for roctx testing - add roctx.cpp - unit tests for roctx callback and buffer tracing - support marker API in get_{buffer,callback}_tracing_names() * Update lib/common/logging.cpp - logging initialized message mentions env variable * Update lib/common/mpl.hpp - NOLINT for misc-definitions-in-headers * Update lib/rocprofiler-sdk/tests/CMakeLists.txt - include LD_LIBRARY_PATH in rocprofiler-lib-tests-shared tests * Update lib/rocprofiler-sdk/registration.cpp - client_library_vec_t is now vector of option<client_library> - enables resetting the client_library after finalization - removed acquiring registration lock when invoke_client_finalizers called via atexit - this was causing some lock-order-inversion warnings (potential deadlock) * Update lib/rocprofiler-sdk/agent.cpp - model name for agent supports spaces * Update tests/common/serialization.hpp - add serialization support for marker tracing data structures * Update tests/apps - Add ROCTx markers into reproducible-runtime and transpose * Update tests/tools/json-tools.cpp - add marker tracing support - remove strdup (no longer necessary) * Update tests/kernel-tracing/validate.py - validate marker API tracing data * Update tests/async-copy-tracing/validate.py - validate marker API tracing data * Update cmake for load path resolution during testing * Update tests/async-copy-tracing/CMakeLists.txt - fix test LD_LIBRARY_PATH * Update cmake/Templates/rocprofiler-sdk-roctx/config.cmake.in - fix constructing rocprofiler-sdk-roctx::rocprofiler-sdk-roctx
2024-01-18 09:48:06 -06:00
@@ -70,11 +70,12 @@ typedef struct
 {
    uint64_t                          size;  ///< size of this struct
    rocprofiler_buffer_tracing_kind_t kind;  ///< ::ROCPROFILER_CALLBACK_TRACING_MARKER_API
-    rocprofiler_correlation_id_t      correlation_id;  ///< correlation ids for record
-    rocprofiler_tracing_operation_t   operation;       ///< ::rocprofiler_marker_api_id_t
-    rocprofiler_timestamp_t           timestamp;       ///< time in nanoseconds
-    rocprofiler_thread_id_t           thread_id;       ///< id for thread generating this record
-    uint64_t                          marker_id;       ///< rocprofiler_marker_id_t
+    rocprofiler_correlation_id_t      correlation_id;   ///< correlation ids for record
+    rocprofiler_tracing_operation_t   operation;        ///< ::rocprofiler_marker_api_id_t
+    rocprofiler_timestamp_t           start_timestamp;  ///< start time in nanoseconds
+    rocprofiler_timestamp_t           end_timestamp;    ///< end time in nanoseconds
+    rocprofiler_thread_id_t           thread_id;        ///< id for thread generating this record
+    uint64_t                          marker_id;        ///< rocprofiler_marker_id_t
    // const char* message; // (Need Review?)
 } rocprofiler_buffer_tracing_marker_api_record_t;

@@ -24,3 +24,4 @@

 #include <rocprofiler-sdk/marker/api_args.h>
 #include <rocprofiler-sdk/marker/api_id.h>
+#include <rocprofiler-sdk/marker/table_api_id.h>
@@ -3,7 +3,7 @@
 #   Installation of public HSA headers
 #
 #
-set(ROCPROFILER_MARKER_HEADER_FILES api_args.h api_id.h)
+set(ROCPROFILER_MARKER_HEADER_FILES api_args.h api_id.h table_api_id.h)

 install(
    FILES ${ROCPROFILER_MARKER_HEADER_FILES}
@@ -22,13 +22,15 @@

 #pragma once

-#include <stdint.h>
+#include <rocprofiler-sdk-roctx/api_trace.h>
+#include <rocprofiler-sdk-roctx/types.h>

-typedef uint64_t roctx_range_id_t;
+#include <stdint.h>

 typedef union rocprofiler_marker_api_retval_u
 {
-    uint32_t uint32_t_retval;
+    int32_t  int32_t_retval;
+    int64_t  int64_t_retval;
    uint64_t uint64_t_retval;
 } rocprofiler_marker_api_retval_t;

@@ -53,4 +55,35 @@ typedef union rocprofiler_marker_api_args_u
    {
        roctx_range_id_t id;
    } roctxRangeStop;
+    struct
+    {
+        roctx_thread_id_t tid;
+    } roctxProfilerPause;
+    struct
+    {
+        roctx_thread_id_t tid;
+    } roctxProfilerResume;
+    struct
+    {
+        const char* name;
+    } roctxNameOsThread;
+    struct
+    {
+        const char*               name;
+        const struct hsa_agent_s* agent;
+    } roctxNameHsaAgent;
+    struct
+    {
+        const char* name;
+        int         device_id;
+    } roctxNameHipDevice;
+    struct
+    {
+        const char*                name;
+        const struct ihipStream_t* stream;
+    } roctxNameHipStream;
+    struct
+    {
+        roctx_thread_id_t* tid;
+    } roctxGetThreadId;
 } rocprofiler_marker_api_args_t;
@@ -36,8 +36,9 @@ typedef enum  // NOLINT(performance-enum-size)
    ROCPROFILER_MARKER_API_ID_roctxProfilerPause,
    ROCPROFILER_MARKER_API_ID_roctxProfilerResume,
    ROCPROFILER_MARKER_API_ID_roctxNameOsThread,
-    ROCPROFILER_MARKER_API_ID_roctxNameHsaDevice,
+    ROCPROFILER_MARKER_API_ID_roctxNameHsaAgent,
    ROCPROFILER_MARKER_API_ID_roctxNameHipDevice,
    ROCPROFILER_MARKER_API_ID_roctxNameHipStream,
+    ROCPROFILER_MARKER_API_ID_roctxGetThreadId,
    ROCPROFILER_MARKER_API_ID_LAST,
 } rocprofiler_marker_api_id_t;
@@ -0,0 +1,30 @@
+// MIT License
+//
+// Copyright (c) 2023 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
+
+// NOLINTNEXTLINE(performance-enum-size)
+typedef enum
+{
+    ROCPROFILER_MARKER_API_TABLE_ID_NONE     = -1,
+    ROCPROFILER_MARKER_API_TABLE_ID_RoctxApi = 0,
+} rocprofiler_marker_table_api_id_t;