/home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-roctracer-docs/checkouts/docs-6.0.0/inc/roctracer_plugin.h Source File

/home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-roctracer-docs/checkouts/docs-6.0.0/inc/roctracer_plugin.h Source File#

ROC Tracer: /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-roctracer-docs/checkouts/docs-6.0.0/inc/roctracer_plugin.h Source File
roctracer_plugin.h
Go to the documentation of this file.
1 /* Copyright (c) 2022 Advanced Micro Devices, Inc.
2 
3  Permission is hereby granted, free of charge, to any person obtaining a copy
4  of this software and associated documentation files (the "Software"), to deal
5  in the Software without restriction, including without limitation the rights
6  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7  copies of the Software, and to permit persons to whom the Software is
8  furnished to do so, subject to the following conditions:
9 
10  The above copyright notice and this permission notice shall be included in
11  all copies or substantial portions of the Software.
12 
13  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
19  THE SOFTWARE. */
20 
42 #ifndef ROCTRACER_PLUGIN_H_
43 #define ROCTRACER_PLUGIN_H_
44 
45 #include "roctracer.h"
46 
47 #include <stdint.h>
48 
49 #ifdef __cplusplus
50 extern "C" {
51 #endif /* __cplusplus */
52 
80 ROCTRACER_EXPORT int roctracer_plugin_initialize(
81  uint32_t roctracer_major_version, uint32_t roctracer_minor_version);
82 
90 ROCTRACER_EXPORT void roctracer_plugin_finalize();
91 
111 ROCTRACER_EXPORT int roctracer_plugin_write_callback_record(
112  const roctracer_record_t* record, const void* callback_data);
113 
128 ROCTRACER_EXPORT int roctracer_plugin_write_activity_records(
129  const roctracer_record_t* begin, const roctracer_record_t* end);
130 
133 #ifdef __cplusplus
134 } /* extern "C" */
135 #endif /* __cplusplus */
136 
137 #endif /* ROCTRACER_PLUGIN_H_ */
roctracer_record_t
activity_record_t roctracer_record_t
Activity record.
Definition: roctracer.h:439
roctracer_plugin_finalize
ROCTRACER_EXPORT void roctracer_plugin_finalize()
Finalize plugin.
roctracer_plugin_initialize
ROCTRACER_EXPORT int roctracer_plugin_initialize(uint32_t roctracer_major_version, uint32_t roctracer_minor_version)
Initialize plugin.
roctracer_plugin_write_activity_records
ROCTRACER_EXPORT int roctracer_plugin_write_activity_records(const roctracer_record_t *begin, const roctracer_record_t *end)
Report a range of activity trace data.
roctracer_plugin_write_callback_record
ROCTRACER_EXPORT int roctracer_plugin_write_callback_record(const roctracer_record_t *record, const void *callback_data)
Report a single callback trace data.
roctracer.h
ROCtracer API interface.
ROCTRACER_EXPORT
#define ROCTRACER_EXPORT
Definition: roctracer.h:71