// -*- C++ -*-
//===----------------------------------------------------------------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//

#ifndef _LIBCPP___LOG_HARDENING_FAILURE
#define _LIBCPP___LOG_HARDENING_FAILURE

#include <__config>

#if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
#  pragma GCC system_header
#endif

// Hardening logging is not available in the C++03 mode; moreover, it is currently only available in the experimental
// library.
#if _LIBCPP_HAS_EXPERIMENTAL_HARDENING_OBSERVE_SEMANTIC && !defined(_LIBCPP_CXX03_LANG)

_LIBCPP_BEGIN_NAMESPACE_STD

// This function should never be called directly from the code -- it should only be called through the
// `_LIBCPP_LOG_HARDENING_FAILURE` macro.
//
// Furthermore, note that we pretend that this is a non-blocking and non-allocating function per Clang's
// function effect attributes. We do that because this function is only called once a function's preconditions
// are violated, at which point function effect analysis can no longer provide any meaningful guarantees
// (e.g., cannot guarantee the caller is non-blocking, regardless of function effect attributes). Failure
// to mark this function with these attributes would render it (and anything calling it, such as span::operator[])
// unusable from a [[nonblocking]] function.
[[__gnu__::__cold__]] _LIBCPP_EXPORTED_FROM_ABI void __log_hardening_failure(const char* __message) noexcept
    [[_Clang::__nonblocking__]];
[[__gnu__::__cold__]] _LIBCPP_EXPORTED_FROM_ABI void __internal_log_hardening_failure(const char* __message) noexcept
    [[_Clang::__nonblocking__]]; // NOT ABI STABLE

// _LIBCPP_LOG_HARDENING_FAILURE(message)
//
// This macro is used to log an error without terminating the program (as is the case for hardening failures if the
// `observe` assertion semantic is used).

#  if !defined(_LIBCPP_LOG_HARDENING_FAILURE)
#    if defined(_LIBCPP_USE_INTERNAL_LOG_HARDENING)
#      define _LIBCPP_LOG_HARDENING_FAILURE(__message) ::std::__internal_log_hardening_failure(__message) // in the dylib, NOT ABI STABLE
#    else
#      define _LIBCPP_LOG_HARDENING_FAILURE(__message) ::std::__log_hardening_failure(__message)
#    endif
#  endif // !defined(_LIBCPP_LOG_HARDENING_FAILURE)

_LIBCPP_END_NAMESPACE_STD

#endif // _LIBCPP_HAS_EXPERIMENTAL_HARDENING_OBSERVE_SEMANTIC && !defined(_LIBCPP_CXX03_LANG)

#endif // _LIBCPP___LOG_HARDENING_FAILURE
