/*
* Copyright (c) Facebook, Inc. and its affiliates.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#pragma once
#include <exception>
#include <type_traits>
#include <utility>
#include <folly/CPortability.h>
#include <folly/CppAttributes.h>
#include <folly/Portability.h>
namespace folly {
/// throw_exception
///
/// Throw an exception if exceptions are enabled, or terminate if compiled with
/// -fno-exceptions.
template <typename Ex>
[[noreturn]] FOLLY_NOINLINE FOLLY_COLD void throw_exception(Ex&& ex) {
#if FOLLY_HAS_EXCEPTIONS
throw static_cast<Ex&&>(ex);
#else
(void)ex;
std::terminate();
#endif
}
/// terminate_with
/// Terminates as if by forwarding to throw_exception but in a noexcept context.
[[noreturn]] FOLLY_NOINLINE FOLLY_COLD void terminate_with(Ex&& ex) noexcept {
throw_exception(static_cast<Ex&&>(ex));
// clang-format off
namespace detail {
template <typename T>
FOLLY_ERASE T&& to_exception_arg_(T&& t) {
return static_cast<T&&>(t);
template <std::size_t N>
FOLLY_ERASE char const* to_exception_arg_(
char const (&array)[N]) {
return static_cast<char const*>(array);
template <typename Ex, typename... Args>
[[noreturn]] FOLLY_NOINLINE FOLLY_COLD void throw_exception_(Args&&... args) {
throw_exception(Ex(static_cast<Args&&>(args)...));
[[noreturn]] FOLLY_NOINLINE FOLLY_COLD void terminate_with_(
Args&&... args) noexcept {
} // namespace detail
// clang-format on
/// Construct and throw an exception if exceptions are enabled, or terminate if
/// compiled with -fno-exceptions.
/// Converts any arguments of type `char const[N]` to `char const*`.
[[noreturn]] FOLLY_ERASE void throw_exception(Args&&... args) {
detail::throw_exception_<Ex>(
detail::to_exception_arg_(static_cast<Args&&>(args))...);
[[noreturn]] FOLLY_ERASE void
terminate_with(Args&&... args) noexcept {
detail::terminate_with_<Ex>(
/// invoke_cold
/// Invoke the provided function with the provided arguments.
/// Usage note:
/// Passing extra values as arguments rather than capturing them allows smaller
/// inlined native at the call-site.
/// Example:
/// if (i < 0) {
/// invoke_cold(
/// [](int j) {
/// std::string ret = doStepA();
/// doStepB(ret);
/// doStepC(ret);
/// },
/// i);
/// }
template <typename F, typename... A>
FOLLY_NOINLINE FOLLY_COLD auto invoke_cold(F&& f, A&&... a)
-> decltype(static_cast<F&&>(f)(static_cast<A&&>(a)...)) {
return static_cast<F&&>(f)(static_cast<A&&>(a)...);
/// invoke_noreturn_cold
/// Invoke the provided function with the provided arguments. If the invocation
/// returns, terminate.
/// May be used with throw_exception in cases where construction of the object
/// to be thrown requires more than just invoking its constructor with a given
/// sequence of arguments passed by reference - for example, if a string message
/// must be computed before being passed to the constructor of the object to be
/// thrown.
/// inlined native code at the call-site.
/// invoke_noreturn_cold(
/// throw_exceptions(runtime_error(to<string>("invalid: ", j)));
[[noreturn]] FOLLY_NOINLINE FOLLY_COLD void invoke_noreturn_cold(
F&& f,
A&&... a) {
static_cast<F&&>(f)(static_cast<A&&>(a)...);
/// catch_exception
/// Invokes t; if exceptions are enabled (if not compiled with -fno-exceptions),
/// catches a thrown exception e of type E and invokes c, forwarding e and any
/// trailing arguments.
/// As a general rule, pass Ex const& rather than unqualified Ex as the explicit
/// template argument E. The catch statement catches E without qualifiers so
/// if E is Ex then that translates to catch (Ex), but if E is Ex const& then
/// that translates to catch (Ex const&).
/// int input = // ...
/// int def = 45;
/// auto result = catch_exception<std::runtime_error const&>(
/// [=] {
/// if (input < 0) throw std::runtime_error("foo");
/// return input;
/// [](auto&& e, int num) { return num; },
/// def);
/// assert(result == input < 0 ? def : input);
template <typename E, typename Try, typename Catch, typename... CatchA>
FOLLY_ERASE_TRYCATCH auto catch_exception(Try&& t, Catch&& c, CatchA&&... a) ->
typename std::common_type<
decltype(static_cast<Try&&>(t)()),
decltype(static_cast<Catch&&>(
c)(std::declval<E>(), static_cast<CatchA&&>(a)...))>::type {
try {
return static_cast<Try&&>(t)();
} catch (E e) {
return invoke_cold(static_cast<Catch&&>(c), e, static_cast<CatchA&&>(a)...);
[](auto&&...) {}(c, a...); // ignore
/// catches a thrown exception of any type and invokes c, forwarding any
//
/// auto result = catch_exception(
/// if (input < 0) throw 11;
/// [](int num) { return num; },
template <typename Try, typename Catch, typename... CatchA>
decltype(static_cast<Catch&&>(c)(static_cast<CatchA&&>(a)...))>::type {
} catch (...) {
return invoke_cold(static_cast<Catch&&>(c), static_cast<CatchA&&>(a)...);
} // namespace folly