EBGeometry_Macros.hpp

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 Robert Marskar <robert.marskar@sintef.no>
//
// SPDX-License-Identifier: GPL-3.0-or-later
 
#ifndef EBGEOMETRY_MACROS_HPP
#define EBGEOMETRY_MACROS_HPP
 
#include <cstdio>
#include <cstdlib>
 
#include "EBGeometry_GPU.hpp"
 
#if defined(EBGEOMETRY_HIP)
// Declares the device printf used below. It must be visible before the first header that uses the
// macros: in a template, a call that does not depend on a template parameter binds at the point of
// definition, and would otherwise bind to the host printf.
#include <hip/hip_runtime.h>
#endif
#if defined(EBGEOMETRY_DEVICE_COMPILE)
// Device compilation pass (CUDA/HIP): std::fprintf/std::abort are host-only. assert() is not an
// option either: NDEBUG, which CMake's Release configurations define, would silently remove every
// device check while the host checks stayed. Print with the device printf and trap instead.
#if defined(EBGEOMETRY_CUDA)
#define EBGEOMETRY_DEVICE_TRAP() __trap()
#else
#define EBGEOMETRY_DEVICE_TRAP() __builtin_trap()
#endif
namespace EBGeometry {
namespace MacrosDetail {
// Out of line, like the backends' own assert: the device printf expands to a lot of code, and an
// inline copy at every check site makes device compiles of large files take many minutes.
__device__ __noinline__ inline void
deviceAssertionFailed(const char* a_cond, const char* a_file, const int a_line)
{
  printf("EBGeometry device assertion failed: (%s)\n  file: %s\n  line: %d\n", a_cond, a_file, a_line);
  EBGEOMETRY_DEVICE_TRAP();
}
} // namespace MacrosDetail
} // namespace EBGeometry
#endif
 
#if defined(EBGEOMETRY_DEVICE_COMPILE)
#define EBGEOMETRY_REQUIRE(cond, ...)                                               \
  do {                                                                              \
    if (!(cond)) {                                                                  \
      ::EBGeometry::MacrosDetail::deviceAssertionFailed(#cond, __FILE__, __LINE__); \
    }                                                                               \
  } while (0)
#else
#define EBGEOMETRY_REQUIRE(cond, ...)                                                               \
  do {                                                                                              \
    if (!(cond)) {                                                                                  \
      std::fprintf(stderr, "EBGeometry::" __VA_ARGS__);                                             \
      std::fprintf(stderr, "\n  check: (%s)\n  file: %s\n  line: %d\n", #cond, __FILE__, __LINE__); \
      std::abort();                                                                                 \
    }                                                                                               \
  } while (0)
#endif
 
#if defined(EBGEOMETRY_ENABLE_ASSERTIONS)
#if defined(EBGEOMETRY_DEVICE_COMPILE)
#define EBGEOMETRY_EXPECT(cond)                                                     \
  do {                                                                              \
    if (!(cond)) {                                                                  \
      ::EBGeometry::MacrosDetail::deviceAssertionFailed(#cond, __FILE__, __LINE__); \
    }                                                                               \
  } while (0)
#else
#define EBGEOMETRY_EXPECT(cond)                                                                   \
  do {                                                                                            \
    if (!(cond)) {                                                                                \
      std::fprintf(stderr,                                                                        \
                   "EBGeometry assertion failed: (%s)\n  file: %s\n  line: %d\n  function: %s\n", \
                   #cond,                                                                         \
                   __FILE__,                                                                      \
                   __LINE__,                                                                      \
                   static_cast<const char*>(__func__));                                           \
      std::abort();                                                                               \
    }                                                                                             \
  } while (0)
#endif
#else
// Assertions off: expand to a no-op that does NOT evaluate cond -- an assertion costs exactly
// nothing in release, including not running its predicate. A local computed solely to be asserted
// therefore becomes unused; mark such a declaration [[maybe_unused]] at its site.
#define EBGEOMETRY_EXPECT(cond) ((void)0)
#endif
 
#endif // EBGEOMETRY_MACROS_HPP