Jonathan R. Madsen
6a3f79e626
* Update include/rocprofiler
- remove rocprofiler_external_correlation_id_t
- redefine rocprofiler_correlation_id_t to include internal id and external user data
- associate rocprofiler_push_external_correlation_id and rocprofiler_pop_external_correlation_id with a context
* Update include/rocprofiler/rocprofiler.h
- rocprofiler_get_status_name
- rocprofiler_get_status_string
* Update lib/rocprofiler/rocprofiler.cpp
- implement rocprofiler_get_status_name and rocprofiler_get_status_string
* Update lib/rocprofiler/tests/status.cpp
- unit test for status string and name
* Update lib/rocprofiler/tests/registration.cpp
- update to new rocprofiler_correlation_id_t
* Update samples
- update to new rocprofiler_correlation_id_t
* Add lib/rocprofiler/external_correlation.cpp
- placeholder for external correlation push/pop
* Update lib/rocprofiler/hsa/agent_cache.cpp
- slight tweak to when HSA_AMD_AGENT_INFO_NEAREST_CPU is defined
* Update context implementation and hsa.cpp
- get_active_contexts is array of const context pointers
- update hsa_api_impl<Idx>::functor to new rocprofiler_correlation_id_t
* Update include/rocprofiler/fwd.h
- add ROCPROFILER_STATUS_ERROR_INVALID_ARGUMENT
- reorder enum for consistency
* Update include/rocprofiler/external_correlation.h
- doxygen comments
- thread id parameter
* Update include/rocprofiler/rocprofiler.h
- add rocprofiler_get_thread_id function (needed for external corr id)
* Update lib/common/synchronized.hpp
- explicit LockedType
- define all copy/move ctor and assignment
- update rlock/wlock/ulock to support arguments and return values
- Support additional template parameter for special case of synchronized instance which is the mapped type of a sychronized map
* Update lib/rocprofiler/external_correlation.cpp
- implement rocprofiler_{push,pop}_external_correlation_id
* Update lib/rocprofiler/CMakeLists.txt
- external_correlation.hpp
* Update lib/rocprofiler/rocprofiler.cpp
- status string for ROCPROFILER_STATUS_ERROR_INVALID_ARGUMENT
- implement rocprofiler_get_thread_id
* Update lib/rocprofiler/tests (external correlation)
- add external_correlation unit tests
* Update include/rocprofiler/callback_tracing.h
- doxygen comments
- callback invoked in callback tracing has user_data pointer passed to it
* Update samples/api_callback_tracing/client.cpp
- add rocprofiler_user_data_t* to tool_tracing_callback
* Update lib/rocprofiler/tests/registration.cpp
- add rocprofiler_user_data_t* to tool_tracing_callback
* Update lib/rocprofiler/context/context.{hpp,cpp}
- update correlation_tracing_service
- external_correlation instance
- rename get_unique_record_id to get_unique_internal_id
* Update lib/tests/common/demangling.cpp
- tweak mangled definitions due to changing function get_unique_record_id to get_unique_internal_id
* Update lib/rocprofiler/hsa/hsa.cpp
- handle updates to external correlation id
- handle updates to callback signature in callback tracing
* Update CMakeLists.txt
- CMAKE_BUILD_TYPE=Coverage defines CODECOV=1
* Update samples/api_callback_tracing/client.cpp
129 lines
4.6 KiB
C
129 lines
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/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
|