Add 'projects/rocprofiler-sdk/' from commit 'bf0fad1d5406fbc51403ba1aa9621a9d4a9bce2b'
git-subtree-dir: projects/rocprofiler-sdk git-subtree-mainline:50a90550e9git-subtree-split:bf0fad1d54
This commit is contained in:
systems-assistant[bot]
@@ -0,0 +1,18 @@
|
||||
#
|
||||
#
|
||||
# Installation of public headers
|
||||
#
|
||||
#
|
||||
configure_file(${CMAKE_CURRENT_LIST_DIR}/version.h.in
|
||||
${CMAKE_CURRENT_BINARY_DIR}/version.h @ONLY)
|
||||
|
||||
set(ROCTX_HEADER_FILES
|
||||
# core headers
|
||||
roctx.h
|
||||
# secondary headers
|
||||
api_trace.h defines.h types.h ${CMAKE_CURRENT_BINARY_DIR}/version.h)
|
||||
|
||||
install(
|
||||
FILES ${ROCTX_HEADER_FILES}
|
||||
DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/rocprofiler-sdk-roctx
|
||||
COMPONENT roctx)
|
||||
@@ -0,0 +1,88 @@
|
||||
// MIT License
|
||||
//
|
||||
// Copyright (c) 2023-2025 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-roctx/defines.h"
|
||||
#include "rocprofiler-sdk-roctx/types.h"
|
||||
#include "rocprofiler-sdk-roctx/version.h"
|
||||
|
||||
#include <sched.h>
|
||||
#include <stddef.h>
|
||||
#include <stdint.h>
|
||||
|
||||
ROCTX_EXTERN_C_INIT
|
||||
|
||||
#define ROCTX_API_TABLE_VERSION_MAJOR 0
|
||||
#define ROCTX_API_TABLE_VERSION_STEP 0
|
||||
|
||||
#define ROCTX_CORE_API_TABLE_VERSION_MAJOR 0
|
||||
#define ROCTX_CORE_API_TABLE_VERSION_STEP 0
|
||||
|
||||
#define ROCTX_CONTROL_API_TABLE_VERSION_MAJOR 0
|
||||
#define ROCTX_CONTROL_API_TABLE_VERSION_STEP 0
|
||||
|
||||
#define ROCTX_RESOURCE_API_TABLE_VERSION_MAJOR 0
|
||||
#define ROCTX_RESOURCE_API_TABLE_VERSION_STEP 0
|
||||
|
||||
typedef uint64_t roctx_range_id_t;
|
||||
typedef void (*roctxMarkA_fn_t)(const char* message);
|
||||
typedef int (*roctxRangePushA_fn_t)(const char* message);
|
||||
typedef int (*roctxRangePop_fn_t)(void);
|
||||
typedef roctx_range_id_t (*roctxRangeStartA_fn_t)(const char* message);
|
||||
typedef void (*roctxRangeStop_fn_t)(roctx_range_id_t id);
|
||||
typedef int (*roctxProfilerPause_fn_t)(roctx_thread_id_t tid);
|
||||
typedef int (*roctxProfilerResume_fn_t)(roctx_thread_id_t tid);
|
||||
typedef int (*roctxNameOsThread_fn_t)(const char* name);
|
||||
typedef int (*roctxNameHsaAgent_fn_t)(const char* name, const struct hsa_agent_s* agent);
|
||||
typedef int (*roctxNameHipDevice_fn_t)(const char* name, int device_id);
|
||||
typedef int (*roctxNameHipStream_fn_t)(const char* name, const struct ihipStream_t* stream);
|
||||
typedef int (*roctxGetThreadId_fn_t)(roctx_thread_id_t* tid);
|
||||
|
||||
typedef struct roctxCoreApiTable_t
|
||||
{
|
||||
uint64_t size;
|
||||
roctxMarkA_fn_t roctxMarkA_fn;
|
||||
roctxRangePushA_fn_t roctxRangePushA_fn;
|
||||
roctxRangePop_fn_t roctxRangePop_fn;
|
||||
roctxRangeStartA_fn_t roctxRangeStartA_fn;
|
||||
roctxRangeStop_fn_t roctxRangeStop_fn;
|
||||
roctxGetThreadId_fn_t roctxGetThreadId_fn;
|
||||
} roctxCoreApiTable_t;
|
||||
|
||||
typedef struct roctxControlApiTable_t
|
||||
{
|
||||
uint64_t size;
|
||||
roctxProfilerPause_fn_t roctxProfilerPause_fn;
|
||||
roctxProfilerResume_fn_t roctxProfilerResume_fn;
|
||||
} roctxControlApiTable_t;
|
||||
|
||||
typedef struct roctxNameApiTable_t
|
||||
{
|
||||
uint64_t size;
|
||||
roctxNameOsThread_fn_t roctxNameOsThread_fn;
|
||||
roctxNameHsaAgent_fn_t roctxNameHsaAgent_fn;
|
||||
roctxNameHipDevice_fn_t roctxNameHipDevice_fn;
|
||||
roctxNameHipStream_fn_t roctxNameHipStream_fn;
|
||||
} roctxNameApiTable_t;
|
||||
|
||||
ROCTX_EXTERN_C_FINI
|
||||
@@ -0,0 +1,116 @@
|
||||
// MIT License
|
||||
//
|
||||
// Copyright (c) 2023-2025 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
|
||||
|
||||
/**
|
||||
* @defgroup SYMBOL_VERSIONING_GROUP Symbol Versions
|
||||
*
|
||||
* @brief The names used for the shared library versioned symbols.
|
||||
*
|
||||
* Every function is annotated with one of the version macros defined in this
|
||||
* section. Each macro specifies a corresponding symbol version string. After
|
||||
* dynamically loading the shared library with @p dlopen, the address of each
|
||||
* function can be obtained using @p dlsym with the name of the function and
|
||||
* its corresponding symbol version string. An error will be reported by @p
|
||||
* dlsym if the installed library does not support the version for the
|
||||
* function specified in this version of the interface.
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**
|
||||
* @brief The function was introduced in version 0.0 of the interface and has the
|
||||
* symbol version string of ``"ROCPROFILER_SDK_ROCTX_0.0"``.
|
||||
*/
|
||||
#define ROCPROFILER_SDK_ROCTX_VERSION_0_0
|
||||
|
||||
/** @} */
|
||||
|
||||
#if !defined(ROCTX_ATTRIBUTE)
|
||||
# if defined(_MSC_VER)
|
||||
# define ROCTX_ATTRIBUTE(...) __declspec(__VA_ARGS__)
|
||||
# else
|
||||
# define ROCTX_ATTRIBUTE(...) __attribute__((__VA_ARGS__))
|
||||
# endif
|
||||
#endif
|
||||
|
||||
#if !defined(ROCTX_PUBLIC_API)
|
||||
# if defined(_MSC_VER)
|
||||
# define ROCTX_PUBLIC_API ROCTX_ATTRIBUTE(dllexport)
|
||||
# else
|
||||
# define ROCTX_PUBLIC_API ROCTX_ATTRIBUTE(visibility("default"))
|
||||
# endif
|
||||
#endif
|
||||
|
||||
#if !defined(ROCTX_HIDDEN_API)
|
||||
# if defined(_MSC_VER)
|
||||
# define ROCTX_HIDDEN_API
|
||||
# else
|
||||
# define ROCTX_HIDDEN_API ROCTX_ATTRIBUTE(visibility("hidden"))
|
||||
# endif
|
||||
#endif
|
||||
|
||||
#if !defined(ROCTX_EXPORT_DECORATOR)
|
||||
# define ROCTX_EXPORT_DECORATOR ROCTX_PUBLIC_API
|
||||
#endif
|
||||
|
||||
#if !defined(ROCTX_IMPORT_DECORATOR)
|
||||
# if defined(_MSC_VER)
|
||||
# define ROCTX_IMPORT_DECORATOR ROCTX_ATTRIBUTE(dllimport)
|
||||
# else
|
||||
# define ROCTX_IMPORT_DECORATOR
|
||||
# endif
|
||||
#endif
|
||||
|
||||
#define ROCTX_EXPORT ROCTX_EXPORT_DECORATOR
|
||||
#define ROCTX_IMPORT ROCTX_IMPORT_DECORATOR
|
||||
|
||||
#if !defined(ROCTX_API)
|
||||
# if defined(roctx_EXPORTS)
|
||||
# define ROCTX_API ROCTX_EXPORT
|
||||
# else
|
||||
# define ROCTX_API ROCTX_IMPORT
|
||||
# endif
|
||||
#endif
|
||||
|
||||
#if defined(__has_attribute)
|
||||
# if __has_attribute(nonnull)
|
||||
# define ROCTX_NONNULL(...) __attribute__((nonnull(__VA_ARGS__)))
|
||||
# else
|
||||
# define ROCTX_NONNULL(...)
|
||||
# endif
|
||||
#else
|
||||
# if defined(__GNUC__)
|
||||
# define ROCTX_NONNULL(...) __attribute__((nonnull(__VA_ARGS__)))
|
||||
# else
|
||||
# define ROCTX_NONNULL(...)
|
||||
# endif
|
||||
#endif
|
||||
|
||||
#ifdef __cplusplus
|
||||
# define ROCTX_EXTERN_C_INIT extern "C" {
|
||||
# define ROCTX_EXTERN_C_FINI }
|
||||
#else
|
||||
# define ROCTX_EXTERN_C_INIT
|
||||
# define ROCTX_EXTERN_C_FINI
|
||||
#endif
|
||||
@@ -0,0 +1,310 @@
|
||||
// MIT License
|
||||
//
|
||||
// Copyright (c) 2023-2025 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
|
||||
|
||||
/**
|
||||
* @file roctx.h
|
||||
* @brief ROCTx API interface for AMD code annotation and profiling
|
||||
*
|
||||
* @mainpage ROCTx API Specification
|
||||
*
|
||||
* @section introduction Introduction
|
||||
* ROCTx is a comprehensive library that implements the AMD code annotation API. It provides
|
||||
* essential functionality for:
|
||||
* - Event annotation and marking
|
||||
* - Code range tracking and management
|
||||
* - Profiler control and customization
|
||||
* - Thread and device naming capabilities
|
||||
*
|
||||
* Key features:
|
||||
* - Nested range tracking with push/pop functionality
|
||||
* - Process-wide range management
|
||||
* - Thread-specific and global profiler control
|
||||
* - Device and stream naming support
|
||||
* - HSA agent and HIP device management
|
||||
*
|
||||
* The API is divided into several main components:
|
||||
* 1. Markers - For single event annotations
|
||||
* 2. Ranges - For tracking code execution spans
|
||||
* 3. Profiler Control - For managing profiling tool behavior
|
||||
* 4. Naming Utilities - For labeling threads, devices, and streams
|
||||
*
|
||||
* Thread Safety:
|
||||
* - Range operations are thread-local and thread-safe
|
||||
* - Marking operations are thread-safe
|
||||
* - Profiler control operations are process-wide
|
||||
*
|
||||
* Integration:
|
||||
* - Compatible with HIP runtime
|
||||
* - Supports HSA (Heterogeneous System Architecture)
|
||||
* - Provides both C and C++ interfaces
|
||||
*
|
||||
* Performance Considerations:
|
||||
* - Minimal overhead for marking and range operations
|
||||
* - Thread-local storage for efficient range stacking
|
||||
* - Lightweight profiler control mechanisms
|
||||
*
|
||||
* @note All string parameters must be null-terminated
|
||||
* @warning Proper nesting of range push/pop operations is user's responsibility
|
||||
*/
|
||||
|
||||
#include <stddef.h>
|
||||
#include <stdint.h>
|
||||
|
||||
#include "rocprofiler-sdk-roctx/defines.h"
|
||||
#include "rocprofiler-sdk-roctx/types.h"
|
||||
#include "rocprofiler-sdk-roctx/version.h"
|
||||
|
||||
ROCTX_EXTERN_C_INIT
|
||||
|
||||
/** @defgroup marker_group ROCTx Markers
|
||||
*
|
||||
* @brief Markers are used to annotate specific events in the code execution.
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**
|
||||
* Mark an event.
|
||||
*
|
||||
* @param[in] message The message associated with the event.
|
||||
*/
|
||||
void
|
||||
roctxMarkA(const char* message) ROCTX_API ROCTX_NONNULL(1);
|
||||
|
||||
/** @} */
|
||||
|
||||
/** @defgroup range_group ROCTx Ranges
|
||||
*
|
||||
* @brief Ranges are used to describe a span of code execution in a ROCm application.
|
||||
*
|
||||
* Ranges can be nested, and the API provides functions to start and stop ranges.
|
||||
* Ranges are thread-local, meaning that each thread can have its own stack of
|
||||
* ranges. The API provides functions to push and pop ranges from the stack.
|
||||
* The API also provides functions to start and stop ranges, which are
|
||||
* process-wide. Each range is assigned a unique ID, which can be used to
|
||||
* identify the range when stopping it.
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**
|
||||
* Start a new nested range.
|
||||
*
|
||||
* Nested ranges are stacked and local to the current CPU thread.
|
||||
*
|
||||
* @param[in] message The message associated with this range.
|
||||
*
|
||||
* @return Returns the level this nested range is started at. Nested range
|
||||
* levels are 0 based.
|
||||
*/
|
||||
int
|
||||
roctxRangePushA(const char* message) ROCTX_API ROCTX_NONNULL(1);
|
||||
|
||||
/**
|
||||
* Stop the current nested range.
|
||||
*
|
||||
* Stop the current nested range, and pop it from the stack. If a nested range
|
||||
* was active before the last one was started, it becomes again the current
|
||||
* nested range.
|
||||
*
|
||||
* @return Returns the level the stopped nested range was started at, or a
|
||||
* negative value if there was no nested range active.
|
||||
*/
|
||||
int
|
||||
roctxRangePop() ROCTX_API;
|
||||
|
||||
/**
|
||||
* @brief Starts a process range.
|
||||
*
|
||||
* Start/stop ranges can be started and stopped in different threads. Each
|
||||
* timespan is assigned a unique range ID.
|
||||
*
|
||||
* @param [in] message The message associated with this range.
|
||||
*
|
||||
* @return Returns the ID of the new range.
|
||||
*/
|
||||
roctx_range_id_t
|
||||
roctxRangeStartA(const char* message) ROCTX_API ROCTX_NONNULL(1);
|
||||
|
||||
/**
|
||||
* Stop a process range.
|
||||
*
|
||||
* @param [in] id ::roctx_range_id_t returned from ::roctxRangeStartA to stop
|
||||
*/
|
||||
void
|
||||
roctxRangeStop(roctx_range_id_t id) ROCTX_API;
|
||||
|
||||
/** @} */
|
||||
|
||||
/** @defgroup PROFILER_COMM ROCTx Application control/customization of profiling tools
|
||||
*
|
||||
* @brief Applications can invoke these functions to control/customize profiling tool behavior.
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**
|
||||
* @brief Request any currently running profiling tool that is should stop collecting data.
|
||||
*
|
||||
* Within a profiling tool, it is recommended that the tool cache all active contexts at the time of
|
||||
* the request and then stop them. By convention, the application should pass zero to indicate a
|
||||
* global pause of the profiler in the current process. If the application wishes to pause only the
|
||||
* current thread, the application should obtain the thread ID via @ref roctxGetThreadId.
|
||||
*
|
||||
* @param [in] tid Zero for all threads in current process or non-zero for a specific thread
|
||||
*
|
||||
* @return int A profiling tool may choose to set this value to a non-zero value to indicate a
|
||||
* failure while executing the request or lack of support. If the profiling tool supports pausing
|
||||
* but is already paused, the tool should ignore the request and return zero.
|
||||
*/
|
||||
int
|
||||
roctxProfilerPause(roctx_thread_id_t tid) ROCTX_API;
|
||||
|
||||
/**
|
||||
* @brief Request any currently running profiling tool that is should resume collecting data.
|
||||
*
|
||||
* Within a profiling tool, it is recommended that the tool re-activated the active contexts which
|
||||
* were cached when the pause request was issued. By convention, the application should pass zero to
|
||||
* indicate a global pause of the profiler in the current process. If the application wishes to
|
||||
* pause only the current thread, the application should obtain the thread ID via @ref
|
||||
* roctxGetThreadId.
|
||||
*
|
||||
* @param [in] tid Zero for all threads in current process or non-zero for a specific thread
|
||||
*
|
||||
* @return int A profiling tool may choose to set this value to a non-zero value to indicate a
|
||||
* failure while executing the request or lack of support. If the profiling tool is supports
|
||||
* resuming but is already active, the tool should ignore the request and return zero.
|
||||
*/
|
||||
int
|
||||
roctxProfilerResume(roctx_thread_id_t tid) ROCTX_API;
|
||||
|
||||
/** @} */
|
||||
|
||||
/** \defgroup UTILITIES ROCTx Utility functions
|
||||
*
|
||||
* @brief Utility functions for profiling tools to customize their behavior.
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**
|
||||
* @brief Indicate to a profiling tool that, where possible, you would like the current CPU OS
|
||||
* thread to be labeled by the provided name in the output of the profiling tool.
|
||||
*
|
||||
* Rocprofiler does not provide explicit support for how profiling tools handle this request:
|
||||
* support for this capability is tool specific. ROCTx does NOT rename the thread via
|
||||
* `pthread_setname_np`.
|
||||
*
|
||||
* @param [in] name Name for the current OS thread
|
||||
*
|
||||
* @return int A profiling tool may choose to set this value to a non-zero value to indicate a
|
||||
* failure while executing the request or lack of support
|
||||
*/
|
||||
int
|
||||
roctxNameOsThread(const char* name) ROCTX_API ROCTX_NONNULL(1);
|
||||
|
||||
/**
|
||||
* @brief Indicate to a profiling tool that, where possible, you would like the given HSA agent
|
||||
* to be labeled by the provided name in the output of the profiling tool.
|
||||
*
|
||||
* Rocprofiler does not provide any explicit support for how profiling tools handle this request:
|
||||
* support for this capability is tool specific.
|
||||
*
|
||||
* @param [in] name Name for the specified agent
|
||||
* @param [in] agent Pointer to a HSA agent identifier
|
||||
*
|
||||
* @return int A profiling tool may choose to set this value to a non-zero value to indicate a
|
||||
* failure while executing the request or lack of support
|
||||
*/
|
||||
int
|
||||
roctxNameHsaAgent(const char* name, const struct hsa_agent_s* agent) ROCTX_API ROCTX_NONNULL(1, 2);
|
||||
|
||||
/**
|
||||
* @brief Indicate to a profiling tool that, where possible, you would like the given HIP device id
|
||||
* to be labeled by the provided name in the output of the profiling tool.
|
||||
*
|
||||
* Rocprofiler does not provide any explicit support for how profiling tools handle this request:
|
||||
* support for this capability is tool specific.
|
||||
*
|
||||
* @param [in] name Name for the specified device
|
||||
* @param [in] device_id HIP device ordinal
|
||||
*
|
||||
* @return int A profiling tool may choose to set this value to a non-zero value to indicate a
|
||||
* failure while executing the request or lack of support
|
||||
*/
|
||||
int
|
||||
roctxNameHipDevice(const char* name, int device_id) ROCTX_API ROCTX_NONNULL(1);
|
||||
|
||||
/**
|
||||
* @brief Indicate to a profiling tool that, where possible, you would like the given HIP stream
|
||||
* to be labeled by the provided name in the output of the profiling tool.
|
||||
*
|
||||
* Rocprofiler does not provide any explicit support for how profiling tools handle this request:
|
||||
* support for this capability is tool specific.
|
||||
*
|
||||
* @param [in] name Name for the specified stream
|
||||
* @param [in] stream A `hipStream_t` value (hipStream_t == ihipStream_t*)
|
||||
*
|
||||
* @return int A profiling tool may choose to set this value to a non-zero value to indicate a
|
||||
* failure while executing the request or lack of support
|
||||
*/
|
||||
int
|
||||
roctxNameHipStream(const char* name, const struct ihipStream_t* stream) ROCTX_API ROCTX_NONNULL(1);
|
||||
|
||||
/** @} */
|
||||
|
||||
/** @defgroup UTILITIES ROCTx Utility functions
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**
|
||||
* @brief Retrieve a id value for the current thread which will be identical to the id value a
|
||||
* profiling tool gets via `rocprofiler_get_thread_id(rocprofiler_thread_id_t*)`
|
||||
*
|
||||
* @param tid [out] Pointer to where the value should be placed
|
||||
*
|
||||
* @return int A profiling tool may choose to set this value to a non-zero value to indicate a
|
||||
* failure while executing the request or lack of support
|
||||
*/
|
||||
int
|
||||
roctxGetThreadId(roctx_thread_id_t* tid) ROCTX_API ROCTX_NONNULL(1);
|
||||
|
||||
/** @} */
|
||||
|
||||
ROCTX_EXTERN_C_FINI
|
||||
|
||||
#if !defined(roctxRangeStart)
|
||||
/** @brief For future compatibility */
|
||||
# define roctxRangeStart(message) roctxRangeStartA(message)
|
||||
#endif
|
||||
|
||||
#if !defined(roctxMark)
|
||||
/** @brief For future compatibility */
|
||||
# define roctxMark(message) roctxMarkA(message)
|
||||
#endif
|
||||
|
||||
#if !defined(roctxRangePush)
|
||||
/** @brief For future compatibility */
|
||||
# define roctxRangePush(message) roctxRangePushA(message)
|
||||
#endif
|
||||
@@ -0,0 +1,56 @@
|
||||
// MIT License
|
||||
//
|
||||
// Copyright (c) 2023-2025 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-roctx/defines.h"
|
||||
|
||||
#include <stdint.h>
|
||||
|
||||
/** \defgroup BASIC_DATA_TYPES ROCTx Data types
|
||||
*
|
||||
* @brief Data types defined or aliased by ROCTx
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**
|
||||
* ROCTx range ID.
|
||||
*
|
||||
* This is the range ID used to identify start/end ranges.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @brief ROCTx range ID.
|
||||
*
|
||||
* This is the range ID used to identify start/end ranges.
|
||||
*/
|
||||
typedef uint64_t roctx_range_id_t;
|
||||
|
||||
/**
|
||||
* @brief ROCTx thread ID.
|
||||
*
|
||||
* This is the thread ID used to identify OS threads
|
||||
*/
|
||||
typedef uint64_t roctx_thread_id_t;
|
||||
|
||||
/** @} */
|
||||
@@ -0,0 +1,115 @@
|
||||
// MIT License
|
||||
//
|
||||
// Copyright (c) 2023-2025 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
|
||||
|
||||
/**
|
||||
* @def ROCTX_IS_ROCPROFILER_SDK
|
||||
* @brief Preprocessor define indicating the roctx header is a rocprofiler-sdk project
|
||||
* @addtogroup VERSIONING_GROUP
|
||||
*
|
||||
* @def ROCTX_VERSION_MAJOR
|
||||
* @brief The major version of the interface as a macro so it can be used
|
||||
* by the preprocessor.
|
||||
* @addtogroup VERSIONING_GROUP
|
||||
*
|
||||
* @def ROCTX_VERSION_MINOR
|
||||
* @brief The minor version of the interface as a macro so it can be used
|
||||
* by the preprocessor.
|
||||
* @addtogroup VERSIONING_GROUP
|
||||
*
|
||||
* @def ROCTX_VERSION_PATCH
|
||||
* @brief The patch version of the interface as a macro so it can be used
|
||||
* by the preprocessor.
|
||||
* @addtogroup VERSIONING_GROUP
|
||||
*
|
||||
* @def ROCTX_VERSION
|
||||
* @brief Numerically increasing version number encoding major, minor, and patch via
|
||||
computing `((10000 * <MAJOR>) + (100 * <MINOR>) + <PATCH>)`.
|
||||
* @addtogroup VERSIONING_GROUP
|
||||
*
|
||||
* @def ROCTX_SOVERSION
|
||||
* @brief Shared object versioning value whose value is at least `(10000 * <MAJOR>)`.
|
||||
* @addtogroup VERSIONING_GROUP
|
||||
*
|
||||
* @def ROCTX_VERSION_STRING
|
||||
* @brief Version string in form: `<MAJOR>.<MINOR>.<PATCH>`.
|
||||
* @addtogroup VERSIONING_GROUP
|
||||
*
|
||||
* @def ROCTX_GIT_DESCRIBE
|
||||
* @brief String encoding of `git describe --tags` when rocprofiler was built.
|
||||
* @addtogroup VERSIONING_GROUP
|
||||
*
|
||||
* @def ROCTX_GIT_REVISION
|
||||
* @brief String encoding of `git rev-parse HEAD` when rocprofiler was built.
|
||||
* @addtogroup VERSIONING_GROUP
|
||||
*
|
||||
* @def ROCTX_LIBRARY_ARCH
|
||||
* @brief Architecture triplet of rocprofiler build.
|
||||
* @addtogroup VERSIONING_GROUP
|
||||
*
|
||||
* @def ROCTX_SYSTEM_NAME
|
||||
* @brief Target operating system for rocprofiler build, e.g. Linux.
|
||||
* @addtogroup VERSIONING_GROUP
|
||||
*
|
||||
* @def ROCTX_SYSTEM_PROCESSOR
|
||||
* @brief Target architecture for rocprofiler build.
|
||||
* @addtogroup VERSIONING_GROUP
|
||||
*
|
||||
* @def ROCTX_SYSTEM_VERSION
|
||||
* @brief Version of the operating system which built rocprofiler
|
||||
* @addtogroup VERSIONING_GROUP
|
||||
*
|
||||
* @def ROCTX_COMPILER_ID
|
||||
* @brief C++ compiler identifier which built rocprofiler, e.g., GNU
|
||||
* @addtogroup VERSIONING_GROUP
|
||||
*
|
||||
* @def ROCTX_COMPILER_VERSION
|
||||
* @brief C++ compiler version which built rocprofiler
|
||||
* @addtogroup VERSIONING_GROUP
|
||||
*/
|
||||
|
||||
#define ROCTX_IS_ROCPROFILER_SDK 1
|
||||
|
||||
// clang-format off
|
||||
#define ROCTX_VERSION_MAJOR @PROJECT_VERSION_MAJOR@
|
||||
#define ROCTX_VERSION_MINOR @PROJECT_VERSION_MINOR@
|
||||
#define ROCTX_VERSION_PATCH @PROJECT_VERSION_PATCH@
|
||||
#define ROCTX_SOVERSION (10000 * @PROJECT_VERSION_MAJOR@)
|
||||
#define ROCTX_VERSION_STRING "@FULL_VERSION_STRING@"
|
||||
#define ROCTX_GIT_DESCRIBE "@ROCPROFILER_SDK_GIT_DESCRIBE@"
|
||||
#define ROCTX_GIT_REVISION "@ROCPROFILER_SDK_GIT_REVISION@"
|
||||
|
||||
// system info during compilation
|
||||
#define ROCTX_LIBRARY_ARCH "@CMAKE_LIBRARY_ARCHITECTURE@"
|
||||
#define ROCTX_SYSTEM_NAME "@CMAKE_SYSTEM_NAME@"
|
||||
#define ROCTX_SYSTEM_PROCESSOR "@CMAKE_SYSTEM_PROCESSOR@"
|
||||
#define ROCTX_SYSTEM_VERSION "@CMAKE_SYSTEM_VERSION@"
|
||||
|
||||
// compiler information
|
||||
#define ROCTX_COMPILER_ID "@CMAKE_CXX_COMPILER_ID@"
|
||||
#define ROCTX_COMPILER_VERSION "@CMAKE_CXX_COMPILER_VERSION@"
|
||||
|
||||
// clang-format on
|
||||
|
||||
#define ROCTX_VERSION \
|
||||
((10000 * ROCTX_VERSION_MAJOR) + (100 * ROCTX_VERSION_MINOR) + ROCTX_VERSION_PATCH)
|
||||
Reference in New Issue
Block a user