std::terminate(3)

πŸ“¦ version 2024.07.05, in nixpkgs unstable, opensuse-leap 16.0

πŸ’– NAME πŸ’–

std::terminate β€” bestie, this is the function the C++ runtime hits you with when the program literally cannot keep going. No cap. It's the "we're done here" button, and it's from the C++ Standard Library (that's the manual we're in, mwah πŸ’…).


✨ SYNOPSIS ✨

Ok so first things first, it lives in this header:

Defined in header <exception>

void terminate();                        (until C++11)
[[noreturn]] void terminate() noexcept;  (since C++11)

Note the glow-up in C++11 β€” it picked up [[noreturn]] and noexcept and honestly? Iconic. πŸ‘‘


🌸 DESCRIPTION 🌸

So std::terminate() gets called by the C++ runtime when the program cannot continue, for any of these reasons (and there are twelve, so buckle up buttercup):

  1. An exception is thrown and not caught (it is implementation-defined whether any stack unwinding is done in this case).
  2. A function directly invoked by the exception handling mechanism while handling an exception that has not yet been caught exits via an exception (e.g. a destructor of some local object, or a copy constructor constructing a catch-clause parameter).
  3. The constructor or the destructor of a static or thread-local (since C++11) object throws an exception.
  4. A function registered with std::atexit or std::at_quick_exit (since C++11) throws an exception.
  5. A dynamic exception specification is violated and the default handler for std::unexpected is executed.
  6. A non-default handler for std::unexpected throws an exception that violates the previously violated dynamic exception specification, if the specification does not include std::bad_exception. β€” this one's until C++17, so it's giving legacy ✨
  7. A noexcept specification is violated (it is implementation-defined whether any stack unwinding is done in this case).
  8. std::nested_exception::rethrow_nested is called for an object that isn't holding a captured exception.
  9. An exception is thrown from the initial function of std::thread. β€” since C++11
  10. A joinable std::thread is destroyed or assigned to.
  11. std::condition_variable::wait, std::condition_variable::wait_until, or std::condition_variable::wait_for fails to reach its postcondition (e.g. if relocking the mutex throws).
  12. A function invoked by a parallel algorithm exits via an uncaught exception and the execution policy specifies termination. β€” since C++17

Ok and heads up, std::terminate() may also be called directly from the program. Like, you can just... call it. Your choice bestie 🫢

When std::terminate is called due to a thrown exception, an implicit try/catch handler is considered active. Thus, calling std::current_exception will return the thrown exception. (Cute lil detail, right?)

In any case, std::terminate calls the currently installed std::terminate_handler. The default std::terminate_handler calls std::abort. That's the whole chain, no detours. πŸ’€


Now the messy part, the until-C++11 vs since-C++11 drama about handlers:

Until C++11: If a destructor reset the terminate handler during stack unwinding and the unwinding later led to terminate being called, the handler that was installed at the end of the throw expression is the one that will be called. (note: it was ambiguous whether re-throwing applied the new handlers)

Since C++11: If a destructor reset the terminate handler during stack unwinding, it is unspecified which handler is called if the unwinding later led to terminate being called.

So yeah β€” unspecified, don't build your whole personality on it. πŸ™ˆ


πŸ¦‹ NOTES πŸ¦‹

If the handler mechanism is not wanted β€” e.g. because it requires atomic operations which may bloat binary size β€” a direct call to std::abort is preferred when terminating the program abnormally.

Some compiler intrinsics, e.g. __builtin_trap (gcc, clang, and icc) or __debugbreak (msvc), can be used to terminate the program as fast as possible. Zoom zoom. πŸ”₯


πŸŽ€ Defect reports πŸŽ€

The following behavior-changing defect reports were applied retroactively to previously published C++ standards. (Yes, they went back and retconned it, main character energy fr fr.)

  • LWG 2111 β€” applied to C++11. Behavior as published: effect of calling std::set_terminate during stack unwinding differs from C++98 and breaks some ABIs. Correct behavior: made unspecified.

⭐ SEE ALSO ⭐

  • terminate_handler β€” the type of the function called by std::terminate (typedef)
  • abort β€” causes abnormal program termination (without cleaning up) (function)

That's the whole page, bestie! 🧚 Source and version: http://cppreference.com, 2024.06.10 β€” and yes, we were on std::terminate(3) the whole time. Go forth and don't accidentally call it. πŸ˜­πŸ’œπŸ“

πŸ“¦ where this page comes from