SDK: OMPT Support part 1: include file and print formatters for OMPT…

… support (#1175) * include file and print formatters for OMPT support * Apply suggestions from code review * Remove rocprofiler_ompt_set_callbacks * Reorder ROCPROFILER_EXTERNAL_CORRELATION_REQUEST_OPENMP --------- Co-authored-by: Jonathan R. Madsen <[email protected]> Co-authored-by: Jonathan R. Madsen <[email protected]>
ROCm · Nov 6, 2024 · 62e0a9c · 62e0a9c
1 parent cc1498b
commit 62e0a9c
Show file tree

Hide file tree

Showing 16 changed files with 2,289 additions and 4 deletions.
diff --git a/source/include/rocprofiler-sdk/CMakeLists.txt b/source/include/rocprofiler-sdk/CMakeLists.txt
@@ -26,6 +26,8 @@ set(ROCPROFILER_HEADER_FILES
     intercept_table.h
     internal_threading.h
     marker.h
+    ompt.h
+    openmp.h
     pc_sampling.h
     profile_config.h
     registration.h
@@ -41,6 +43,7 @@ install(
 add_subdirectory(hip)
 add_subdirectory(hsa)
 add_subdirectory(marker)
+add_subdirectory(openmp)
 add_subdirectory(rccl)
 add_subdirectory(cxx)
 add_subdirectory(amd_detail)
diff --git a/source/include/rocprofiler-sdk/buffer_tracing.h b/source/include/rocprofiler-sdk/buffer_tracing.h
@@ -125,6 +125,63 @@ typedef struct
     /// ::rocprofiler_hip_compiler_api_id_t
 } rocprofiler_buffer_tracing_hip_api_record_t;
 
+/**
+ * @brief Additional trace data for OpenMP target routines
+ */
+
+typedef struct rocprofiler_buffer_tracing_ompt_target_t
+{
+    int32_t     kind;        // ompt_target_t target region kind
+    int32_t     device_num;  // ompt device number for the region
+    uint64_t    task_id;     // Task ID from the task_data argument to the OMPT callback
+    uint64_t    target_id;   // Target identifier from the target_data argument to the callback
+    const void* codeptr_ra;  // pointer to the callsite of the target region
+} rocprofiler_buffer_tracing_ompt_target_t;
+
+typedef struct rocprofiler_buffer_tracing_ompt_target_data_op_t
+{
+    uint64_t    host_op_id;       // from the host_op_id argument to the OMPT callback
+    int32_t     optype;           // ompt_target_data_op_t kind of operation
+    int32_t     src_device_num;   // ompt device number for data source
+    int32_t     dest_device_num;  // ompt device number for data destination
+    int32_t     reserved;         // for padding
+    uint64_t    bytes;            // size in bytes of the operation
+    const void* codeptr_ra;       // pointer to the callsite of the target_data_op
+} rocprofiler_buffer_tracing_ompt_target_data_op_t;
+
+typedef struct rocprofiler_buffer_tracing_ompt_target_kernel_t
+{
+    uint64_t host_op_id;           // from the host_op_id argument to the OMPT callback
+    int32_t  device_num;           // strangely missing from the OpenMP spec,
+    uint32_t requested_num_teams;  // from the compiler
+} rocprofiler_buffer_tracing_ompt_target_kernel_t;
+
+/**
+ * @brief ROCProfiler Buffer OPENMP API Tracer Record.
+ */
+typedef struct rocprofiler_buffer_tracing_ompt_api_record_t
+{
+    uint64_t                          size;  ///< size of this struct
+    rocprofiler_buffer_tracing_kind_t kind;
+    rocprofiler_tracing_operation_t   operation;
+    rocprofiler_correlation_id_t      correlation_id;   ///< correlation ids for record
+    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
+    union
+    {
+        rocprofiler_buffer_tracing_ompt_target_t         target;
+        rocprofiler_buffer_tracing_ompt_target_data_op_t target_data;
+        rocprofiler_buffer_tracing_ompt_target_kernel_t  kernel;
+        uint64_t                                         reserved[5];
+    };
+
+    /// @var kind
+    /// @brief ::ROCPROFILER_CALLBACK_TRACING_OPENMP
+    /// @var operation
+    /// @brief Specification of the API function,::rocprofiler_ompt_operation_t
+} rocprofiler_buffer_tracing_ompt_api_record_t;
+
 /**
  * @brief ROCProfiler Buffer Marker Tracer Record.
  */

diff --git a/source/include/rocprofiler-sdk/callback_tracing.h b/source/include/rocprofiler-sdk/callback_tracing.h
@@ -27,6 +27,7 @@
 #include <rocprofiler-sdk/hip.h>
 #include <rocprofiler-sdk/hsa.h>
 #include <rocprofiler-sdk/marker.h>
+#include <rocprofiler-sdk/openmp.h>
 #include <rocprofiler-sdk/rccl.h>
 
 #include <hsa/hsa.h>
@@ -78,6 +79,15 @@ typedef struct
     rocprofiler_hip_api_retval_t retval;
 } rocprofiler_callback_tracing_hip_api_data_t;
 
+/**
+ * @brief ROCProfiler OPENMP Callback Data
+ */
+typedef struct
+{
+    uint64_t                    size;  ///< size of this struct
+    rocprofiler_ompt_api_args_t args;
+} rocprofiler_callback_tracing_ompt_api_data_t;
+
 /**
  * @brief ROCProfiler Marker Tracer Callback Data.
  */

diff --git a/source/include/rocprofiler-sdk/external_correlation.h b/source/include/rocprofiler-sdk/external_correlation.h
@@ -63,10 +63,11 @@ typedef enum  // NOLINT(performance-enum-size)
     ROCPROFILER_EXTERNAL_CORRELATION_REQUEST_MARKER_CORE_API,       ///<
     ROCPROFILER_EXTERNAL_CORRELATION_REQUEST_MARKER_CONTROL_API,    ///<
     ROCPROFILER_EXTERNAL_CORRELATION_REQUEST_MARKER_NAME_API,       ///<
-    ROCPROFILER_EXTERNAL_CORRELATION_REQUEST_MEMORY_COPY,
-    ROCPROFILER_EXTERNAL_CORRELATION_REQUEST_KERNEL_DISPATCH,
-    ROCPROFILER_EXTERNAL_CORRELATION_REQUEST_SCRATCH_MEMORY,
-    ROCPROFILER_EXTERNAL_CORRELATION_REQUEST_RCCL_API,
+    ROCPROFILER_EXTERNAL_CORRELATION_REQUEST_MEMORY_COPY,           ///<
+    ROCPROFILER_EXTERNAL_CORRELATION_REQUEST_KERNEL_DISPATCH,       ///<
+    ROCPROFILER_EXTERNAL_CORRELATION_REQUEST_SCRATCH_MEMORY,        ///<
+    ROCPROFILER_EXTERNAL_CORRELATION_REQUEST_RCCL_API,              ///<
+    ROCPROFILER_EXTERNAL_CORRELATION_REQUEST_OPENMP,                ///<
     ROCPROFILER_EXTERNAL_CORRELATION_REQUEST_LAST,
 } rocprofiler_external_correlation_id_request_kind_t;
 

diff --git a/source/include/rocprofiler-sdk/fwd.h b/source/include/rocprofiler-sdk/fwd.h
@@ -172,6 +172,7 @@ typedef enum  // NOLINT(performance-enum-size)
     ROCPROFILER_CALLBACK_TRACING_KERNEL_DISPATCH,  ///< Callbacks for kernel dispatches
     ROCPROFILER_CALLBACK_TRACING_MEMORY_COPY,      ///< @see ::rocprofiler_memory_copy_operation_t
     ROCPROFILER_CALLBACK_TRACING_RCCL_API,         ///< @RCCL tracing
+    ROCPROFILER_CALLBACK_TRACING_OPENMP,           ///< @see ::rocprofiler_ompt_operation_t
     ROCPROFILER_CALLBACK_TRACING_LAST,
 } rocprofiler_callback_tracing_kind_t;
 
@@ -197,6 +198,7 @@ typedef enum  // NOLINT(performance-enum-size)
     ROCPROFILER_BUFFER_TRACING_SCRATCH_MEMORY,      ///< Buffer scratch memory reclaimation info
     ROCPROFILER_BUFFER_TRACING_CORRELATION_ID_RETIREMENT,  ///< Correlation ID in no longer in use
     ROCPROFILER_BUFFER_TRACING_RCCL_API,                   ///< RCCL tracing
+    ROCPROFILER_BUFFER_TRACING_OPENMP,                     ///< @see ::rocprofiler_ompt_operation_t
     ROCPROFILER_BUFFER_TRACING_LAST,
 } rocprofiler_buffer_tracing_kind_t;
 

diff --git a/source/include/rocprofiler-sdk/ompt.h b/source/include/rocprofiler-sdk/ompt.h
@@ -0,0 +1,55 @@
+// 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
+
+#include <rocprofiler-sdk/defines.h>
+#include <rocprofiler-sdk/fwd.h>
+#include <rocprofiler-sdk/openmp/omp-tools.h>
+#include <rocprofiler-sdk/registration.h>
+
+/**
+ * @defgroup OMPT_REGISTRATION Tool registration for OpenMP Tools
+ *
+ * Functions for enabling OpenMP support in tools which provide their own ompt_start_tool symbol but
+ * want to defer to rocprofiler-sdk for OMPT.
+ *
+ * @{
+ */
+
+ROCPROFILER_EXTERN_C_INIT
+
+void
+rocprofiler_ompt_finalize_tool() ROCPROFILER_API;
+
+rocprofiler_status_t
+rocprofiler_ompt_is_initialized(int* status) ROCPROFILER_API ROCPROFILER_NONNULL(1);
+
+rocprofiler_status_t
+rocprofiler_ompt_is_finalized(int* status) ROCPROFILER_API ROCPROFILER_NONNULL(1);
+
+ompt_start_tool_result_t*
+rocprofiler_ompt_start_tool(unsigned int omp_version, const char* runtime_version) ROCPROFILER_API;
+
+ROCPROFILER_EXTERN_C_FINI
+
+/** @} */
diff --git a/source/include/rocprofiler-sdk/openmp.h b/source/include/rocprofiler-sdk/openmp.h
@@ -0,0 +1,26 @@
+// 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
+
+#include <rocprofiler-sdk/openmp/api_args.h>
+#include <rocprofiler-sdk/openmp/api_id.h>
diff --git a/source/include/rocprofiler-sdk/openmp/CMakeLists.txt b/source/include/rocprofiler-sdk/openmp/CMakeLists.txt
@@ -0,0 +1,11 @@
+#
+#
+#   Installation of public OpenMP headers
+#
+#
+set(ROCPROFILER_OPENMP_HEADER_FILES api_args.h api_id.h omp-tools.h)
+
+install(
+    FILES ${ROCPROFILER_OPENMP_HEADER_FILES}
+    DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/rocprofiler-sdk/openmp
+    COMPONENT development)