rocprofiler-sdk/spm.h Source File

rocprofiler-sdk/spm.h Source File#

Rocprofiler SDK Developer API: rocprofiler-sdk/spm.h Source File
Rocprofiler SDK Developer API 0.6.0
ROCm Profiling API and tools
spm.h
Go to the documentation of this file.
1// MIT License
2//
3// Copyright (c) 2023 Advanced Micro Devices, Inc. All rights reserved.
4//
5// Permission is hereby granted, free of charge, to any person obtaining a copy
6// of this software and associated documentation files (the "Software"), to deal
7// in the Software without restriction, including without limitation the rights
8// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9// copies of the Software, and to permit persons to whom the Software is
10// furnished to do so, subject to the following conditions:
11//
12// The above copyright notice and this permission notice shall be included in all
13// copies or substantial portions of the Software.
14//
15// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21// SOFTWARE.
22
23#pragma once
24
25#include <rocprofiler-sdk/defines.h>
26#include <rocprofiler-sdk/fwd.h>
27
28ROCPROFILER_EXTERN_C_INIT
29
30/**
31 * @defgroup SPM_SERVICE SPM Service
32 * @brief Streaming Performance Monitoring
33 *
34 * @{
35 */
36
37/**
38 * @brief Configure SPM Service.
39 *
40 * @param [in] context_id
41 * @param [in] buffer_id
42 * @param [in] profile_config
43 * @param [in] interval
44 * @return ::rocprofiler_status_t
45 */
46rocprofiler_status_t
47rocprofiler_configure_spm_service(rocprofiler_context_id_t context_id,
48 rocprofiler_buffer_id_t buffer_id,
49 rocprofiler_profile_config_id_t profile_config,
50 uint64_t interval) ROCPROFILER_API;
51
52/** @} */
53
54ROCPROFILER_EXTERN_C_FINI
rocprofiler_status_t
rocprofiler_status_t
Status codes.
Definition fwd.h:53
rocprofiler_buffer_id_t
Buffer ID.
Definition fwd.h:570
rocprofiler_context_id_t
Context ID.
Definition fwd.h:539
rocprofiler_profile_config_id_t
Profile Configurations.
Definition fwd.h:595
rocprofiler_configure_spm_service
rocprofiler_status_t rocprofiler_configure_spm_service(rocprofiler_context_id_t context_id, rocprofiler_buffer_id_t buffer_id, rocprofiler_profile_config_id_t profile_config, uint64_t interval)
Configure SPM Service.
Generated by doxygen 1.9.8