Jonathan R. Madsen
4f2dc896d3
* Update include/rocprofiler - intercept_table.h header - generic rocprofiler_runtime_library_t - rocprofiler_internal_thread_library_t is not typedef for rocprofiler_runtime_library_t - rocprofiler_at_runtime_api_registration * Update lib/rocprofiler - minor tweaks to context.cpp - check if none context early - disallow stop_context when finalizing - add intercept_table.hpp and intercept_table.cpp - implement rocprofiler_at_runtime_api_registration - implement notify_runtime_api_registration - update registration.cpp - invoke notify_runtime_api_registration - tweak to fini status when invoking client finalizer * Update lib/rocprofiler/tests - add tests for intercept table * Add samples/intercept_table - demonstrate how to install custom API function wrappers instead of relying on HSA callback tracing * Update lib/rocprofiler/tests/intercept_table.cpp - remove _SERVICE from ROCPROFILER_SERVICE_ * Update include/rocprofiler/intercept_table.h - Update doxygen comments * Update lib/rocprofiler/intercept_table.cpp - return error config locked if already initialized * Update lib/rocprofiler/intercept_table.cpp - remove unnecessary alias * Apply suggestions from code review Co-authored-by: Tony Tye <Tony.Tye@amd.com> * Update doxygen comments - clarify when rocprofiler_at_runtime_api_registration can be invoked * Use rocprofiler_runtime_library_t for intercept table and internal threading - remove rocprofiler_intercept_library_t alias to rocprofiler_runtime_library_t - remove rocprofiler_internal_thread_library_t alias to rocprofiler_runtime_library_t - move around documentation with regard to rocprofiler_runtime_library_t enumeration - added some extra doxygen documentation to internal threading functions --------- Co-authored-by: Tony Tye <Tony.Tye@amd.com>
130 righe
4.6 KiB
C
130 righe
4.6 KiB
C
// MIT License
|
|
//
|
|
// Copyright (c) 2023 ROCm Developer Tools
|
|
//
|
|
// 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 <stddef.h>
|
|
#include <stdint.h>
|
|
|
|
#include "rocprofiler/defines.h"
|
|
#include "rocprofiler/fwd.h"
|
|
|
|
/**
|
|
* @defgroup VERSIONING_GROUP Library Versioning
|
|
* @brief Version information about the interface and the associated installed library.
|
|
*
|
|
* The semantic version of the interface following semver.org rules. A context
|
|
* that uses this interface is only compatible with the installed library if
|
|
* the major version numbers match and the interface minor version number is
|
|
* less than or equal to the installed library minor version number.
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
#include "rocprofiler/version.h"
|
|
|
|
ROCPROFILER_EXTERN_C_INIT
|
|
|
|
/**
|
|
* @fn rocprofiler_status_t rocprofiler_get_version(uint32_t* major, uint32_t* minor, uint32_t*
|
|
* patch)
|
|
* @brief Query the version of the installed library.
|
|
*
|
|
* Return the version of the installed library. This can be used to check if
|
|
* it is compatible with this interface version. This function can be used
|
|
* even when the library is not initialized.
|
|
*
|
|
* @param [out] major The major version number is stored if non-NULL.
|
|
* @param [out] minor The minor version number is stored if non-NULL.
|
|
* @param [out] patch The patch version number is stored if non-NULL.
|
|
*/
|
|
rocprofiler_status_t
|
|
rocprofiler_get_version(uint32_t* major, uint32_t* minor, uint32_t* patch) ROCPROFILER_API;
|
|
|
|
ROCPROFILER_EXTERN_C_FINI
|
|
|
|
/** @} */
|
|
|
|
#include "rocprofiler/agent.h"
|
|
// #include "rocprofiler/agent_profile.h"
|
|
#include "rocprofiler/buffer.h"
|
|
#include "rocprofiler/buffer_tracing.h"
|
|
#include "rocprofiler/callback_tracing.h"
|
|
#include "rocprofiler/context.h"
|
|
#include "rocprofiler/counters.h"
|
|
#include "rocprofiler/dispatch_profile.h"
|
|
#include "rocprofiler/external_correlation.h"
|
|
#include "rocprofiler/hip.h"
|
|
#include "rocprofiler/hsa.h"
|
|
#include "rocprofiler/intercept_table.h"
|
|
#include "rocprofiler/internal_threading.h"
|
|
// #include "rocprofiler/marker.h"
|
|
#include "rocprofiler/pc_sampling.h"
|
|
#include "rocprofiler/profile_config.h"
|
|
// #include "rocprofiler/spm.h"
|
|
|
|
ROCPROFILER_EXTERN_C_INIT
|
|
|
|
/**
|
|
* @defgroup MISCELLANEOUS_GROUP Miscellaneous Utility Functions
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @fn rocprofiler_status_t rocprofiler_get_timestamp(rocprofiler_timestamp_t* ts)
|
|
* @brief Get the timestamp value that rocprofiler uses
|
|
* @param [out] ts Output address of the rocprofiler timestamp value
|
|
*/
|
|
rocprofiler_status_t
|
|
rocprofiler_get_timestamp(rocprofiler_timestamp_t* ts) ROCPROFILER_API ROCPROFILER_NONNULL(1);
|
|
|
|
/**
|
|
* @fn rocprofiler_status_t rocprofiler_get_thread_id(rocprofiler_thread_id_t* tid)
|
|
* @brief Get the identifier value of the current thread that is used by rocprofiler
|
|
* @param [out] tid Output address of the rocprofiler thread id value
|
|
*/
|
|
rocprofiler_status_t
|
|
rocprofiler_get_thread_id(rocprofiler_thread_id_t* tid) ROCPROFILER_API ROCPROFILER_NONNULL(1);
|
|
|
|
/**
|
|
* @fn const char* rocprofiler_get_status_name(rocprofiler_status_t status)
|
|
* @brief Return the string encoding of @ref rocprofiler_status_t value
|
|
* @param [in] status error code value
|
|
* @return Will return a nullptr if invalid/unsupported @ref rocprofiler_status_t value is provided.
|
|
*/
|
|
const char*
|
|
rocprofiler_get_status_name(rocprofiler_status_t status) ROCPROFILER_API;
|
|
|
|
/**
|
|
* @fn const char* rocprofiler_get_status_string(rocprofiler_status_t status)
|
|
* @brief Return the message associated with @ref rocprofiler_status_t value
|
|
* @param [in] status error code value
|
|
* @return Will return a nullptr if invalid/unsupported @ref rocprofiler_status_t value is provided.
|
|
*/
|
|
const char*
|
|
rocprofiler_get_status_string(rocprofiler_status_t status) ROCPROFILER_API;
|
|
|
|
/** @} */
|
|
|
|
ROCPROFILER_EXTERN_C_FINI
|