debug.hpp

/* VecMem project, part of the ACTS project (R&D line)
 *
 * (c) 2021-2025 CERN for the benefit of the ACTS project
 *
 * Mozilla Public License Version 2.0
 */
#pragma once
 
// System include(s).
#include <cstdio>
 
#ifndef VECMEM_PRINTF
#if defined(SYCL_LANGUAGE_VERSION) || defined(CL_SYCL_LANGUAGE_VERSION)
#define VECMEM_PRINTF VECMEM_SYCL_PRINTF_FUNCTION
#else
#define VECMEM_PRINTF printf
#endif
#endif  // not VECMEM_PRINTF
 
// Attribute(s) to use on the printed message character string variables
#ifndef VECMEM_MSG_ATTRIBUTES
#ifdef __SYCL_DEVICE_ONLY__
#define VECMEM_MSG_ATTRIBUTES __attribute__((opencl_constant))
#else
#define VECMEM_MSG_ATTRIBUTES
#endif
#endif  // not VECMEM_MSG_ATTRIBUTES
 
#ifndef VECMEM_DEBUG_MSG_LVL
#define VECMEM_DEBUG_MSG_LVL 0
#endif  // not VECMEM_DEBUG_MSG_LVL
 
#ifndef VECMEM_SOURCE_DIR_LENGTH
#define VECMEM_SOURCE_DIR_LENGTH 0
#endif  // not VECMEM_SOURCE_DIR_LENGTH
 
#define __VECMEM_PRINT_MSG(MSG, ...)                    \
    do {                                                \
        const VECMEM_MSG_ATTRIBUTES char __msg[] = MSG; \
        VECMEM_PRINTF(__msg, __VA_ARGS__);              \
    } while (false)
 
#define __VECMEM_PRINT_MSG_EMPTY \
    do {                         \
    } while (false)
 
#if VECMEM_DEBUG_MSG_LVL >= 1
#define __VECMEM_PRINT_1(MSG, ...) __VECMEM_PRINT_MSG(MSG, __VA_ARGS__)
#else
#define __VECMEM_PRINT_1(MSG, ...) __VECMEM_PRINT_MSG_EMPTY
#endif
 
#if VECMEM_DEBUG_MSG_LVL >= 2
#define __VECMEM_PRINT_2(MSG, ...) __VECMEM_PRINT_MSG(MSG, __VA_ARGS__)
#else
#define __VECMEM_PRINT_2(MSG, ...) __VECMEM_PRINT_MSG_EMPTY
#endif
 
#if VECMEM_DEBUG_MSG_LVL >= 3
#define __VECMEM_PRINT_3(MSG, ...) __VECMEM_PRINT_MSG(MSG, __VA_ARGS__)
#else
#define __VECMEM_PRINT_3(MSG, ...) __VECMEM_PRINT_MSG_EMPTY
#endif
 
#if VECMEM_DEBUG_MSG_LVL >= 4
#define __VECMEM_PRINT_4(MSG, ...) __VECMEM_PRINT_MSG(MSG, __VA_ARGS__)
#else
#define __VECMEM_PRINT_4(MSG, ...) __VECMEM_PRINT_MSG_EMPTY
#endif
 
#if VECMEM_DEBUG_MSG_LVL >= 5
#define __VECMEM_PRINT_5(MSG, ...) __VECMEM_PRINT_MSG(MSG, __VA_ARGS__)
#else
#define __VECMEM_PRINT_5(MSG, ...) __VECMEM_PRINT_MSG_EMPTY
#endif
 
// Implement the main macro(s) a little differently for MSVC and all other
// compilers/preprocessors. Since the "trick" used for GCC/Clang to allow
// the macro to receive 0 or more arguments just confuses MSVC. And the MSVC
// variadic macro handling can deal with 0 or more arguments out of the box
// anyway.
#if defined(_MSC_VER) && (!defined(__clang__))
 
#define VECMEM_DEBUG_MSG(LVL, MSG, ...)                                  \
    __VECMEM_PRINT_##LVL(                                                \
        "[vecmem] %s:%i " MSG "\n",                                      \
        (static_cast<const char*>(__FILE__) + VECMEM_SOURCE_DIR_LENGTH), \
        __LINE__, __VA_ARGS__)
 
#else
 
#define __VECMEM_DEBUG_MSG(LVL, MSG, ...)                                \
    __VECMEM_PRINT_##LVL(                                                \
        "[vecmem] %s:%i " MSG "\n%s",                                    \
        (static_cast<const char*>(__FILE__) + VECMEM_SOURCE_DIR_LENGTH), \
        __LINE__, __VA_ARGS__)
 
#define VECMEM_DEBUG_MSG(LVL, ...) __VECMEM_DEBUG_MSG(LVL, __VA_ARGS__, "")
 
#endif  // MSC