TheRock/rocm-systems/projects/rocprofiler-sdk/source/include/rocprofiler-sdk-rocattach/defines.h

// MIT License
//
// Copyright (c) 2025 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

/**
 * @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_ROCATTACH_0.0"``.
 */
#define ROCPROFILER_SDK_ROCATTACH_VERSION_0_0

/** @} */

#if !defined(ROCATTACH_ATTRIBUTE)
#    if defined(_MSC_VER)
#        define ROCATTACH_ATTRIBUTE(...) __declspec(__VA_ARGS__)
#    else
#        define ROCATTACH_ATTRIBUTE(...) __attribute__((__VA_ARGS__))
#    endif
#endif

#if !defined(ROCATTACH_PUBLIC_API)
#    if defined(_MSC_VER)
#        define ROCATTACH_PUBLIC_API ROCATTACH_ATTRIBUTE(dllexport)
#    else
#        define ROCATTACH_PUBLIC_API ROCATTACH_ATTRIBUTE(visibility("default"))
#    endif
#endif

#if !defined(ROCATTACH_HIDDEN_API)
#    if defined(_MSC_VER)
#        define ROCATTACH_HIDDEN_API
#    else
#        define ROCATTACH_HIDDEN_API ROCATTACH_ATTRIBUTE(visibility("hidden"))
#    endif
#endif

#if !defined(ROCATTACH_EXPORT_DECORATOR)
#    define ROCATTACH_EXPORT_DECORATOR ROCATTACH_PUBLIC_API
#endif

#if !defined(ROCATTACH_IMPORT_DECORATOR)
#    if defined(_MSC_VER)
#        define ROCATTACH_IMPORT_DECORATOR ROCATTACH_ATTRIBUTE(dllimport)
#    else
#        define ROCATTACH_IMPORT_DECORATOR
#    endif
#endif

#define ROCATTACH_EXPORT ROCATTACH_EXPORT_DECORATOR
#define ROCATTACH_IMPORT ROCATTACH_IMPORT_DECORATOR

#if !defined(ROCATTACH_API)
#    if defined(ROCATTACH_EXPORTS)
#        define ROCATTACH_API ROCATTACH_EXPORT
#    else
#        define ROCATTACH_API ROCATTACH_IMPORT
#    endif
#endif

#if defined(__has_attribute)
#    if __has_attribute(nonnull)
#        define ROCATTACH_NONNULL(...) __attribute__((nonnull(__VA_ARGS__)))
#    else
#        define ROCATTACH_NONNULL(...)
#    endif
#else
#    if defined(__GNUC__)
#        define ROCATTACH_NONNULL(...) __attribute__((nonnull(__VA_ARGS__)))
#    else
#        define ROCATTACH_NONNULL(...)
#    endif
#endif

#ifdef __cplusplus
#    define ROCATTACH_EXTERN_C_INIT extern "C" {
#    define ROCATTACH_EXTERN_C_FINI }
#else
#    define ROCATTACH_EXTERN_C_INIT
#    define ROCATTACH_EXTERN_C_FINI
#endif