Jonathan R. Madsen
729c34fb60
* Add doxygen-awesome-css submodule * Basic documentation files - conf.py: run by sphinx - about.md: info about rocprofiler - features.md: overview of features - installation.md: build/test/install instructions - index.md: sets up main page - generate-doxyfile.cmake: generates rocprofiler.dox with rocprofiler-specific info - environment.yml: conda environment - Makefile: sphinx makefile - README.md: build instructions - rocprofiler.dox.in: doxygen template - .gitignore: ignores generated files - .nojekyll: prevents GitHub Pages from using Jekyll for deployment of pages * Documentation scripts - scripts for doing common sequences of commands for building docs - update-docs.sh: builds the docs and installs the docs if /docs directory is present - update-doxygen.sh: quick script for generating doxygen * Workflow for docs - step for building docs - step for deploying docs * Update doxygen comments in include/rocprofiler - rocprofiler.h / rocprofiler_plugins.h - fixed non-existent global references in doxygen comments - fixed parameter names that were incorrect or not updated * Update docs workflow - only deploy docs when on main branch
140 Zeilen
4.9 KiB
C
140 Zeilen
4.9 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.
|
|
|
|
/** \section rocprofiler_plugin_api ROCProfiler Plugin API
|
|
*
|
|
* The ROCProfiler Plugin API is used by the ROCProfiler Tool to output all
|
|
* profiling information. Different implementations of the ROCProfiler Plugin
|
|
* API can be developed that output the data in different formats. The
|
|
* ROCProfiler Tool can be configured to load a specific library that supports
|
|
* the user desired format.
|
|
*
|
|
* The API is not thread safe. It is the responsibility of the ROCProfiler Tool
|
|
* to ensure the operations are synchronized and not called concurrently. There
|
|
* is no requirement for the ROCProfiler Tool to report trace data in any
|
|
* specific order. If the format supported by plugin requires specific
|
|
* ordering, it is the responsibility of the plugin implementation to perform
|
|
* any necessary sorting.
|
|
*/
|
|
|
|
/**
|
|
* \file
|
|
* ROCProfiler Tool Plugin API interface.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include "rocprofiler/rocprofiler.h"
|
|
|
|
#include <stdint.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif /* __cplusplus */
|
|
|
|
/** \defgroup rocprofiler_plugins ROCProfiler Plugin API Specification
|
|
* @{
|
|
*/
|
|
|
|
/** \defgroup initialization_group Initialization and Finalization
|
|
* \ingroup rocprofiler_plugins
|
|
*
|
|
* The ROCProfiler Plugin API must be initialized before using any of the
|
|
* operations to report trace data, and finalized after the last trace data has
|
|
* been reported.
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* Initialize plugin.
|
|
* Must be called before any other operation.
|
|
*
|
|
* @param[in] rocprofiler_major_version The major version of the ROCProfiler API
|
|
* being used by the ROCProfiler Tool. An error is reported if this does not
|
|
* match the major version of the ROCProfiler API used to build the plugin
|
|
* library. This ensures compatibility of the trace data format.
|
|
* @param[in] rocprofiler_minor_version The minor version of the ROCProfiler API
|
|
* being used by the ROCProfiler Tool. An error is reported if the
|
|
* \p rocprofiler_major_version matches and this is greater than the minor
|
|
* version of the ROCProfiler API used to build the plugin library. This ensures
|
|
* compatibility of the trace data format.
|
|
* @param[in] data Pointer to the data passed to the ROCProfiler Plugin by the tool
|
|
* @return Returns 0 on success and -1 on error.
|
|
*/
|
|
ROCPROFILER_EXPORT int
|
|
rocprofiler_plugin_initialize(uint32_t rocprofiler_major_version,
|
|
uint32_t rocprofiler_minor_version,
|
|
void* data);
|
|
|
|
/**
|
|
* Finalize plugin.
|
|
* This must be called after ::rocprofiler_plugin_initialize and after all
|
|
* profiling data has been reported by
|
|
* rocprofiler_plugin_write_kernel_records
|
|
*/
|
|
ROCPROFILER_EXPORT void
|
|
rocprofiler_plugin_finalize();
|
|
|
|
/** @} */
|
|
|
|
/** \defgroup profiling_record_write_functions Profiling data reporting
|
|
* \ingroup rocprofiler_plugins
|
|
* Operations to output profiling data.
|
|
* @{
|
|
*/
|
|
|
|
// TODO(aelwazir): Recheck wording of the description
|
|
|
|
/**
|
|
* Report Buffer Records.
|
|
*
|
|
* @param[in] context_id context ID
|
|
* @param[in] buffer_id Buffer ID
|
|
* @param[in] headers Array of ::rocprofiler_record_header_t
|
|
* @param[in] num_headers Number of ::rocprofiler_record_header_t entries in array
|
|
* @return Returns 0 on success and -1 on error.
|
|
*/
|
|
ROCPROFILER_EXPORT int
|
|
rocprofiler_plugin_write_buffer_records(rocprofiler_context_id_t context_id,
|
|
rocprofiler_buffer_id_t buffer_id,
|
|
rocprofiler_record_header_t** headers,
|
|
size_t num_headers);
|
|
|
|
/**
|
|
* Report Synchronous Record.
|
|
*
|
|
* @param[in] record Synchronous Tracer record.
|
|
* @return Returns 0 on success and -1 on error.
|
|
*/
|
|
|
|
ROCPROFILER_EXPORT int
|
|
rocprofiler_plugin_write_record(rocprofiler_record_tracer_t record);
|
|
|
|
/** @} */
|
|
|
|
/** @} */
|
|
|
|
#ifdef __cplusplus
|
|
} /* extern "C" */
|
|
#endif /* __cplusplus */
|