libcxx/include/__verbose_abort

   1 // -*- C++ -*-
   2 //===----------------------------------------------------------------------===//
   3 //
   4 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
   5 // See https://llvm.org/LICENSE.txt for license information.
   6 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
   7 //
   8 //===----------------------------------------------------------------------===//
   9
  10 #ifndef _LIBCPP___VERBOSE_ABORT
  11 #define _LIBCPP___VERBOSE_ABORT
  12
  13 #include <__config>
  14
  15 #if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
  16 #  pragma GCC system_header
  17 #endif
  18
  19 _LIBCPP_BEGIN_NAMESPACE_STD
  20
  21 #if defined(_LIBCPP_VERBOSE_ABORT_NOT_NOEXCEPT)
  22 #  define _LIBCPP_VERBOSE_ABORT_NOEXCEPT
  23 #else
  24 #  define _LIBCPP_VERBOSE_ABORT_NOEXCEPT _NOEXCEPT
  25 #endif
  26
  27 // This function should never be called directly from the code -- it should only be called through
  28 // the _LIBCPP_VERBOSE_ABORT macro.
  29 [[__noreturn__]] _LIBCPP_AVAILABILITY_VERBOSE_ABORT _LIBCPP_OVERRIDABLE_FUNC_VIS _LIBCPP_ATTRIBUTE_FORMAT(
  30     __printf__, 1, 2) void __libcpp_verbose_abort(const char* __format, ...) _LIBCPP_VERBOSE_ABORT_NOEXCEPT;
  31
  32 // _LIBCPP_VERBOSE_ABORT(format, args...)
  33 //
  34 // This macro is used to abort the program abnormally while providing additional diagnostic information.
  35 //
  36 // The first argument is a printf-style format string, and the remaining arguments are values to format
  37 // into the format-string. This macro can be customized by users to provide fine-grained control over
  38 // how verbose termination is triggered.
  39 //
  40 // If the user does not supply their own version of the _LIBCPP_VERBOSE_ABORT macro, we pick the default
  41 // behavior based on whether we know the built library we're running against provides support for the
  42 // verbose termination handler or not. If it does, we call it. If it doesn't, we call __builtin_abort to
  43 // make sure that the program terminates but without taking any complex dependencies in this header.
  44 #if !defined(_LIBCPP_VERBOSE_ABORT)
  45
  46 #  if !_LIBCPP_AVAILABILITY_HAS_VERBOSE_ABORT
  47 // The decltype is there to suppress -Wunused warnings in this configuration.
  48 void __use(const char*, ...);
  49 #    define _LIBCPP_VERBOSE_ABORT(...) (decltype(::std::__use(__VA_ARGS__))(), __builtin_abort())
  50 #  else
  51 #    define _LIBCPP_VERBOSE_ABORT(...) ::std::__libcpp_verbose_abort(__VA_ARGS__)
  52 #  endif
  53
  54 #endif // !defined(_LIBCPP_VERBOSE_ABORT)
  55
  56 _LIBCPP_END_NAMESPACE_STD
  57
  58 #endif // _LIBCPP___VERBOSE_ABORT