macros.hpp

Go to the documentation of this file.

// MIT License
//
// Copyright (c) 2020, The Regents of the University of California,
// through Lawrence Berkeley National Laboratory (subject to receipt of any
// required approvals from the U.S. Dept. of Energy).  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 "timemory/compat/macros.h"
#include "timemory/macros/compiler.hpp"
 
//======================================================================================//
//
// Define macros for ert
//
//======================================================================================//
//
#if defined(TIMEMORY_USE_EXTERN) && !defined(TIMEMORY_USE_ERT_EXTERN)
#    define TIMEMORY_USE_ERT_EXTERN
#endif
//
#if defined(TIMEMORY_ERT_SOURCE)
#    define TIMEMORY_ERT_LINKAGE(...) __VA_ARGS__
#elif defined(TIMEMORY_USE_ERT_EXTERN)
#    define TIMEMORY_ERT_LINKAGE(...) __VA_ARGS__
#else
#    define TIMEMORY_ERT_LINKAGE(...) inline __VA_ARGS__
#endif
//
//--------------------------------------------------------------------------------------//
//
#if !defined(TIMEMORY_DECLARE_ERT_EXTERN_TEMPLATE)
#    define TIMEMORY_DECLARE_ERT_EXTERN_TEMPLATE(...) extern template __VA_ARGS__;
#endif
//
#if !defined(TIMEMORY_INSTANTIATE_ERT_EXTERN_TEMPLATE)
#    define TIMEMORY_INSTANTIATE_ERT_EXTERN_TEMPLATE(...) template __VA_ARGS__;
#endif
//
#if defined(TIMEMORY_ERT_SOURCE)
#    if !defined(TIMEMORY_ERT_EXTERN_TEMPLATE)
#        define TIMEMORY_ERT_EXTERN_TEMPLATE(...)                                        \
            TIMEMORY_INSTANTIATE_ERT_EXTERN_TEMPLATE(__VA_ARGS__)
#    endif
#elif defined(TIMEMORY_USE_ERT_EXTERN)
#    if !defined(TIMEMORY_ERT_EXTERN_TEMPLATE)
#        define TIMEMORY_ERT_EXTERN_TEMPLATE(...)                                        \
            TIMEMORY_DECLARE_ERT_EXTERN_TEMPLATE(__VA_ARGS__)
#    endif
#else
#    if !defined(TIMEMORY_ERT_EXTERN_TEMPLATE)
#        define TIMEMORY_ERT_EXTERN_TEMPLATE(...)
#    endif
#endif
//
//--------------------------------------------------------------------------------------//
//
#if !defined(TIMEMORY_DECLARE_ERT_EXTERN_TEMPLATE_CPU)
#    if defined(TIMEMORY_USE_ERT_EXTERN) || defined(TIMEMORY_ERT_SOURCE)
#        define TIMEMORY_DECLARE_ERT_EXTERN_TEMPLATE_CPU(...)                            \
            TIMEMORY_DECLARE_ERT_EXTERN_TEMPLATE(__VA_ARGS__)
#    else
#        define TIMEMORY_DECLARE_ERT_EXTERN_TEMPLATE_CPU(...)
#    endif
#endif
 
#if !defined(TIMEMORY_INSTANTIATE_ERT_EXTERN_TEMPLATE_CPU)
#    if defined(TIMEMORY_USE_ERT_EXTERN) || defined(TIMEMORY_ERT_SOURCE)
#        define TIMEMORY_INSTANTIATE_ERT_EXTERN_TEMPLATE_CPU(...)                        \
            TIMEMORY_INSTANTIATE_ERT_EXTERN_TEMPLATE(__VA_ARGS__)
#    else
#        define TIMEMORY_INSTANTIATE_ERT_EXTERN_TEMPLATE_CPU(...)
#    endif
#endif
//
//--------------------------------------------------------------------------------------//
//
#if !defined(TIMEMORY_DECLARE_ERT_EXTERN_TEMPLATE_GPU)
#    if(defined(TIMEMORY_USE_ERT_EXTERN) &&                                              \
        (defined(TIMEMORY_USE_CUDA) || defined(TIMEMORY_USE_HIP))) ||                    \
        (defined(TIMEMORY_ERT_SOURCE) && defined(TIMEMORY_GPUCC))
#        define TIMEMORY_DECLARE_ERT_EXTERN_TEMPLATE_GPU(...)                            \
            TIMEMORY_DECLARE_ERT_EXTERN_TEMPLATE(__VA_ARGS__)
#    else
#        define TIMEMORY_DECLARE_ERT_EXTERN_TEMPLATE_GPU(...)
#    endif
#endif
 
#if !defined(TIMEMORY_INSTANTIATE_ERT_EXTERN_TEMPLATE_GPU)
#    if(defined(TIMEMORY_USE_ERT_EXTERN) &&                                              \
        (defined(TIMEMORY_USE_CUDA) || defined(TIMEMORY_USE_HIP))) ||                    \
        (defined(TIMEMORY_ERT_SOURCE) && defined(TIMEMORY_GPUCC))
#        define TIMEMORY_INSTANTIATE_ERT_EXTERN_TEMPLATE_GPU(...)                        \
            TIMEMORY_INSTANTIATE_ERT_EXTERN_TEMPLATE(__VA_ARGS__)
#    else
#        define TIMEMORY_INSTANTIATE_ERT_EXTERN_TEMPLATE_GPU(...)
#    endif
#endif