Allow overrides for std::terminate

Open
#270 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
70/100
Issue type
Feature
Clarity
Clearly specified
Activity status
Active
Tech stack
cpp
Domain
embedded-iot

Research direction

Start in include/cetl/cetl.hpp and copy the existing CETL_DEBUG_ASSERT override pattern, then replace the std::terminate() calls in the five listed headers (optional.hpp line 761, variant.hpp line 227, string_view.hpp 137/244/261, unbounded_variant.hpp 70, pmr/function.hpp 78) inside their !defined(__cpp_exceptions) branches with CETL_TERMINATE(). Read CETL_DEBUG_ASSERT and any docs that describe it to match wording, and drop the now-unneeded <exception> includes from headers that only pulled it in for std::terminate. Done looks like: defining CETL_TERMINATE() to a trap before inclusion makes the library build with -fno-exceptions on a target without libsupc++, and the default still resolves to std::terminate().

Written by the indexing model from the issue text.

Description

accepted

With -fno-exceptions, CETL's bad-access paths call std::terminate(). On targets that link no C++ runtime library (no libsupc++; for example NuttX-based flight controllers), std::terminate does not exist, so any code that can reach these paths fails to link. Please provide a way for the user to supply a platform-specific termination routine that CETL calls instead of std::terminate() when exceptions are disabled.

Where (main @ bf1e5f3)

File Line Path
include/cetl/pf17/optional.hpp 761 ensure_engaged() (value())
include/cetl/pf17/variant.hpp 227 bad_access_unless() (get, visit)
include/cetl/pf17/string_view.hpp 137, 244, 261 out-of-range access
include/cetl/unbounded_variant.hpp 70 bad access
include/cetl/pmr/function.hpp 78 bad call

Proposal

A single overridable macro in cetl/cetl.hpp, following the existing CETL_DEBUG_ASSERT pattern:

/// @def CETL_TERMINATE
/// Called instead of throwing when exceptions are disabled. Must not return.
/// Define it before including any CETL header to route to a platform handler,
/// e.g. `#define CETL_TERMINATE() ::abort()` or a board-specific panic.
#ifndef CETL_TERMINATE
#    include <exception>
#    define CETL_TERMINATE() std::terminate()
#endif

All of the sites above would call CETL_TERMINATE() in their !defined(__cpp_exceptions) branches. That also lets the headers include <exception> only when the default is used. Several currently include it unconditionally "for std::terminate", which matters for builds that avoid C++ runtime headers.

Notes:

  • A macro (rather than a weak function) works for header-only use and avoids defining any symbol in namespace std.
  • Documenting that the handler must be [[noreturn]] and must not throw would let CETL keep its noexcept guarantees.
  • The upcoming expected polyfill's bad-access path (value() on an error) would naturally use the same hook.
  • A CI configuration that defines CETL_TERMINATE() as __builtin_trap() and checks that objects reference no std::terminate would catch regressions.
Dominant language
C++
Stars
18
Forks
4
Avg merge
7d 16h
Merged PRs (30d)
7

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from OpenCyphal/CETL

All issues in OpenCyphal/CETL

Similar issues

More C++ issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.