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 <jrmadsen@users.noreply.github.com>
Co-authored-by: Jonathan R. Madsen <jonathanrmadsen@gmail.com>
Cette révision appartient à :
Larry Meadows
2024-11-05 21:57:11 -08:00
révisé par GitHub
Parent cc1498bb3b
révision 62e0a9c1a3
16 fichiers modifiés avec 2289 ajouts et 4 suppressions
+3
Voir le fichier
@@ -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)
+57
Voir le fichier
@@ -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.
*/
+10
Voir le fichier
@@ -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.
*/
+5 -4
Voir le fichier
@@ -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;
+2
Voir le fichier
@@ -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;
+55
Voir le fichier
@@ -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
/** @} */
+26
Voir le fichier
@@ -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>
+11
Voir le fichier
@@ -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)
+340
Voir le fichier
@@ -0,0 +1,340 @@
// 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/version.h>
#include <rocprofiler-sdk/openmp/omp-tools.h>
#include <stdint.h>
ROCPROFILER_EXTERN_C_INIT
// all the available callback interface runtime entry points
typedef struct rocprofiler_ompt_callback_functions_t
{
ompt_enumerate_states_t ompt_enumerate_states;
ompt_enumerate_mutex_impls_t ompt_enumerate_mutex_impls;
ompt_get_thread_data_t ompt_get_thread_data;
ompt_get_num_places_t ompt_get_num_places;
ompt_get_place_proc_ids_t ompt_get_place_proc_ids;
ompt_get_place_num_t ompt_get_place_num;
ompt_get_partition_place_nums_t ompt_get_partition_place_nums;
ompt_get_proc_id_t ompt_get_proc_id;
ompt_get_state_t ompt_get_state;
ompt_get_parallel_info_t ompt_get_parallel_info;
ompt_get_task_info_t ompt_get_task_info;
ompt_get_task_memory_t ompt_get_task_memory;
ompt_get_num_devices_t ompt_get_num_devices;
ompt_get_num_procs_t ompt_get_num_procs;
ompt_get_target_info_t ompt_get_target_info;
ompt_get_unique_id_t ompt_get_unique_id;
} rocprofiler_ompt_callback_functions_t;
// Empty struct has a size of 0 in C but size of 1 in C++.
// This struct is added to the union members which represent
// functions with no arguments to ensure ABI compatibility
typedef struct rocprofiler_ompt_no_args
{
char empty;
} rocprofiler_ompt_no_args;
typedef union rocprofiler_ompt_api_args_t
{
// The ompt_data_t* values passed to the client tool are proxies.
// This allows the client tool to use them as it would in their own
// OMPT tool.
// We keepa a map from the address of the ompt_data_t passed to the SDK's
// callback to the proxy object and keep it in sync when a callback is done
// to the client tool.
struct
{
ompt_thread_t thread_type;
ompt_data_t* thread_data;
} thread_begin;
struct
{
ompt_data_t* thread_data;
} thread_end;
struct
{
ompt_data_t* encountering_task_data;
const ompt_frame_t* encountering_task_frame;
ompt_data_t* parallel_data;
unsigned int requested_parallelism;
int flags;
const void* codeptr_ra;
} parallel_begin;
struct
{
ompt_data_t* parallel_data;
ompt_data_t* encountering_task_data;
int flags;
const void* codeptr_ra;
} parallel_end;
struct
{
ompt_data_t* encountering_task_data;
const ompt_frame_t* encountering_task_frame;
ompt_data_t* new_task_data;
int flags;
int has_dependences;
const void* codeptr_ra;
} task_create;
struct
{
ompt_data_t* prior_task_data;
ompt_task_status_t prior_task_status;
ompt_data_t* next_task_data;
} task_schedule;
struct
{
ompt_scope_endpoint_t endpoint;
ompt_data_t* parallel_data;
ompt_data_t* task_data;
unsigned int actual_parallelism;
unsigned int index;
int flags;
} implicit_task;
struct
{
int device_num;
const char* type;
ompt_device_t* device;
ompt_function_lookup_t lookup;
const char* documentation;
} device_initialize;
struct
{
int device_num;
} device_finalize;
struct
{
int device_num;
const char* filename;
int64_t offset_in_file;
void* vma_in_file;
size_t bytes;
void* host_addr;
void* device_addr;
uint64_t module_id;
} device_load;
struct
{
int device_num;
uint64_t module_id;
} device_unload;
struct
{
ompt_sync_region_t kind;
ompt_scope_endpoint_t endpoint;
ompt_data_t* parallel_data;
ompt_data_t* task_data;
const void* codeptr_ra;
} sync_region_wait;
struct
{
ompt_mutex_t kind;
ompt_wait_id_t wait_id;
const void* codeptr_ra;
} mutex_released;
struct
{
ompt_data_t* task_data;
const ompt_dependence_t* deps;
int ndeps;
} dependences;
struct
{
ompt_data_t* src_task_data;
ompt_data_t* sink_task_data;
} task_dependence;
struct
{
ompt_work_t work_type;
ompt_scope_endpoint_t endpoint;
ompt_data_t* parallel_data;
ompt_data_t* task_data;
uint64_t count;
const void* codeptr_ra;
} work;
struct
{
ompt_scope_endpoint_t endpoint;
ompt_data_t* parallel_data;
ompt_data_t* task_data;
const void* codeptr_ra;
} masked;
struct
{
ompt_sync_region_t kind;
ompt_scope_endpoint_t endpoint;
ompt_data_t* parallel_data;
ompt_data_t* task_data;
const void* codeptr_ra;
} sync_region;
struct
{
ompt_mutex_t kind;
unsigned int hint;
unsigned int impl;
ompt_wait_id_t wait_id;
const void* codeptr_ra;
} lock_init;
struct
{
ompt_mutex_t kind;
ompt_wait_id_t wait_id;
const void* codeptr_ra;
} lock_destroy;
struct
{
ompt_mutex_t kind;
unsigned int hint;
unsigned int impl;
ompt_wait_id_t wait_id;
const void* codeptr_ra;
} mutex_acquire;
struct
{
ompt_mutex_t kind;
ompt_wait_id_t wait_id;
const void* codeptr_ra;
} mutex_acquired;
struct
{
ompt_scope_endpoint_t endpoint;
ompt_wait_id_t wait_id;
const void* codeptr_ra;
} nest_lock;
struct
{
ompt_data_t* thread_data;
const void* codeptr_ra;
} flush;
struct
{
ompt_data_t* task_data;
int flags;
const void* codeptr_ra;
} cancel;
struct
{
ompt_sync_region_t kind;
ompt_scope_endpoint_t endpoint;
ompt_data_t* parallel_data;
ompt_data_t* task_data;
const void* codeptr_ra;
} reduction;
struct
{
ompt_data_t* parallel_data;
ompt_data_t* task_data;
ompt_dispatch_t kind;
ompt_data_t instance;
} dispatch;
struct
{
ompt_target_t kind;
ompt_scope_endpoint_t endpoint;
int device_num;
ompt_data_t* task_data;
ompt_data_t* target_task_data;
ompt_data_t* target_data;
const void* codeptr_ra;
} target_emi;
struct
{
ompt_scope_endpoint_t endpoint;
ompt_data_t* target_task_data;
ompt_data_t* target_data;
ompt_data_t* host_op_id;
ompt_target_data_op_t optype;
void* src_addr;
int src_device_num;
void* dest_addr;
int dest_device_num;
size_t bytes;
const void* codeptr_ra;
} target_data_op_emi;
struct
{
ompt_scope_endpoint_t endpoint;
ompt_data_t* target_data;
ompt_data_t* host_op_id;
unsigned int requested_num_teams;
} target_submit_emi;
struct
{
unsigned int nitems;
void** host_addr;
void** device_addr;
size_t* bytes;
unsigned int* mapping_flags;
const void* codeptr_ra;
} target_map_emi;
struct
{
ompt_severity_t severity;
const char* message;
size_t length;
const void* codeptr_ra;
} error;
rocprofiler_ompt_callback_functions_t callback_functions;
} rocprofiler_ompt_api_args_t;
ROCPROFILER_EXTERN_C_FINI
+67
Voir le fichier
@@ -0,0 +1,67 @@
// 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
/**
* @brief ROCProfiler enumeration of OPENMP (OpenMP tools) tracing operations
* NOTE: These are callbacks into the ROCProfiler SDK from the vendor-provided OMPT implementation
*/
typedef enum // NOLINT(performance-enum-size)
{
ROCPROFILER_OPENMP_ID_NONE = -1,
ROCPROFILER_OPENMP_ID_thread_begin = 0,
ROCPROFILER_OPENMP_ID_thread_end,
ROCPROFILER_OPENMP_ID_parallel_begin,
ROCPROFILER_OPENMP_ID_parallel_end,
ROCPROFILER_OPENMP_ID_task_create,
ROCPROFILER_OPENMP_ID_task_schedule,
ROCPROFILER_OPENMP_ID_implicit_task,
ROCPROFILER_OPENMP_ID_device_initialize,
ROCPROFILER_OPENMP_ID_device_finalize,
ROCPROFILER_OPENMP_ID_device_load,
ROCPROFILER_OPENMP_ID_device_unload,
ROCPROFILER_OPENMP_ID_sync_region_wait,
ROCPROFILER_OPENMP_ID_mutex_released,
ROCPROFILER_OPENMP_ID_dependences,
ROCPROFILER_OPENMP_ID_task_dependence,
ROCPROFILER_OPENMP_ID_work,
ROCPROFILER_OPENMP_ID_masked,
ROCPROFILER_OPENMP_ID_sync_region,
ROCPROFILER_OPENMP_ID_lock_init,
ROCPROFILER_OPENMP_ID_lock_destroy,
ROCPROFILER_OPENMP_ID_mutex_acquire,
ROCPROFILER_OPENMP_ID_mutex_acquired,
ROCPROFILER_OPENMP_ID_nest_lock,
ROCPROFILER_OPENMP_ID_flush,
ROCPROFILER_OPENMP_ID_cancel,
ROCPROFILER_OPENMP_ID_reduction,
ROCPROFILER_OPENMP_ID_dispatch,
ROCPROFILER_OPENMP_ID_target_emi,
ROCPROFILER_OPENMP_ID_target_data_op_emi,
ROCPROFILER_OPENMP_ID_target_submit_emi,
ROCPROFILER_OPENMP_ID_target_map_emi,
ROCPROFILER_OPENMP_ID_error,
ROCPROFILER_OPENMP_ID_callback_functions, // fake to return struct of ompt callback function
// pointers
ROCPROFILER_OPENMP_ID_LAST
} rocprofiler_ompt_operation_t;
Fichier diff supprimé car celui-ci est trop grand Voir la Diff