rocprofiler-sdk/experimental/counters.h Source File

rocprofiler-sdk/experimental/counters.h Source File#

Rocprofiler SDK Developer API: rocprofiler-sdk/experimental/counters.h Source File
Rocprofiler SDK Developer API 0.6.0
ROCm Profiling API and tools
counters.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/agent.h>
26#include <rocprofiler-sdk/defines.h>
27#include <rocprofiler-sdk/fwd.h>
28
29ROCPROFILER_EXTERN_C_INIT
30
31/**
32 * @brief Apply a custom counter definition (YAML). This function must be called before
33 * counter iteration functions like @ref rocprofiler_iterate_agent_supported_counters
34 * if custom counter definitions are to be used. This function will return an error
35 * if the definition has already been loaded.
36 * @param [in] yaml YAML string containing counter definitions
37 * @param [in] size Size of the YAML string
38 * @param [in] flags Flags to apply to the counter definition
39 * @return ::rocprofiler_status_t
40 * @retval ROCPROFILER_STATUS_SUCCESS if counter definition applied
41 * @retval ROCPROFILER_STATUS_ERROR if counter definition already loaded
42 */
43rocprofiler_status_t
44rocprofiler_load_counter_definition(const char* yaml,
45 size_t size,
46 rocprofiler_counter_flag_t flags) ROCPROFILER_API;
47
48/** @} */
49
50ROCPROFILER_EXTERN_C_FINI
rocprofiler_load_counter_definition
rocprofiler_status_t rocprofiler_load_counter_definition(const char *yaml, unsigned long size, rocprofiler_counter_flag_t flags)
Apply a custom counter definition (YAML). This function must be called before counter iteration funct...
rocprofiler_status_t
rocprofiler_status_t
Status codes.
Definition fwd.h:53
rocprofiler_counter_flag_t
rocprofiler_counter_flag_t
Enumeration of flags that can be used with some counter api calls.
Definition fwd.h:432
Generated by doxygen 1.9.8