rocprofiler-sdk/defines.h Source File

rocprofiler-sdk/defines.h Source File#

Rocprofiler SDK Developer API: rocprofiler-sdk/defines.h Source File
Rocprofiler SDK Developer API 0.4.0
ROCm Profiling API and tools
rocprofiler-sdk
// MIT License
//
// Copyright (c) 2023 Advanced Micro Devices, Inc. All rights reserved.
//
// 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 <stdint.h>
 
/**
 * @defgroup SYMBOL_VERSIONING_GROUP Symbol Versions
 *
 * @brief The names used for the shared library versioned symbols.
 *
 * Every function is annotated with one of the version macros defined in this
 * section.  Each macro specifies a corresponding symbol version string.  After
 * dynamically loading the shared library with @p dlopen, the address of each
 * function can be obtained using @p dlsym with the name of the function and
 * its corresponding symbol version string.  An error will be reported by @p
 * dlvsym if the installed library does not support the version for the
 * function specified in this version of the interface.
 *
 * @{
 */
 
/**
 * @brief The function was introduced in version 0.0 of the interface and has the
 * symbol version string of ``"ROCPROFILER_SDK_0.0"``.
 */
#define ROCPROFILER_SDK_VERSION_0_0
 
/** @} */
 
#if !defined(ROCPROFILER_ATTRIBUTE)
#    if defined(_MSC_VER)
#        define ROCPROFILER_ATTRIBUTE(...) __declspec(__VA_ARGS__)
#    else
#        define ROCPROFILER_ATTRIBUTE(...) __attribute__((__VA_ARGS__))
#    endif
#endif
 
#if !defined(ROCPROFILER_PUBLIC_API)
#    if defined(_MSC_VER)
#        define ROCPROFILER_PUBLIC_API ROCPROFILER_ATTRIBUTE(dllexport)
#    else
#        define ROCPROFILER_PUBLIC_API ROCPROFILER_ATTRIBUTE(visibility("default"))
#    endif
#endif
 
#if !defined(ROCPROFILER_HIDDEN_API)
#    if defined(_MSC_VER)
#        define ROCPROFILER_HIDDEN_API
#    else
#        define ROCPROFILER_HIDDEN_API ROCPROFILER_ATTRIBUTE(visibility("hidden"))
#    endif
#endif
 
#if !defined(ROCPROFILER_EXPORT_DECORATOR)
#    define ROCPROFILER_EXPORT_DECORATOR ROCPROFILER_PUBLIC_API
#endif
 
#if !defined(ROCPROFILER_IMPORT_DECORATOR)
#    if defined(_MSC_VER)
#        define ROCPROFILER_IMPORT_DECORATOR ROCPROFILER_ATTRIBUTE(dllimport)
#    else
#        define ROCPROFILER_IMPORT_DECORATOR
#    endif
#endif
 
#define ROCPROFILER_EXPORT ROCPROFILER_EXPORT_DECORATOR
#define ROCPROFILER_IMPORT ROCPROFILER_IMPORT_DECORATOR
 
#if !defined(ROCPROFILER_API)
#    if defined(rocprofiler_EXPORTS)
#        define ROCPROFILER_API ROCPROFILER_EXPORT
#    else
#        define ROCPROFILER_API ROCPROFILER_IMPORT
#    endif
#endif
 
#if defined(__has_attribute)
#    if __has_attribute(nonnull)
#        define ROCPROFILER_NONNULL(...) __attribute__((nonnull(__VA_ARGS__)))
#    else
#        define ROCPROFILER_NONNULL(...)
#    endif
#else
#    if defined(__GNUC__)
#        define ROCPROFILER_NONNULL(...) __attribute__((nonnull(__VA_ARGS__)))
#    else
#        define ROCPROFILER_NONNULL(...)
#    endif
#endif
 
#if __cplusplus >= 201103L  // C++11
/* c++11 allows extended initializer lists.  */
#    define ROCPROFILER_HANDLE_LITERAL(type, value) (type{value})
#elif __STDC_VERSION__ >= 199901L
/* c99 allows compound literals.  */
#    define ROCPROFILER_HANDLE_LITERAL(type, value) ((type){value})
#else
#    define ROCPROFILER_HANDLE_LITERAL(type, value)                                                \
        {                                                                                          \
            value                                                                                  \
        }
#endif
 
#ifdef __cplusplus
#    define ROCPROFILER_EXTERN_C_INIT extern "C" {
#    define ROCPROFILER_EXTERN_C_FINI }
#    define ROCPROFILER_CXX_CODE(...) __VA_ARGS__
#else
#    define ROCPROFILER_EXTERN_C_INIT
#    define ROCPROFILER_EXTERN_C_FINI
#    define ROCPROFILER_CXX_CODE(...)
#endif
 
#if __cplusplus
#    define ROCPROFILER_UINT64_C(value) uint64_t(value)
#else
#    define ROCPROFILER_UINT64_C(value) UINT64_C(value)
#endif