std::unreachable

 

C++

Compiler support

Freestanding and hosted

Language

Standard library

Standard library headers

Named requirements

Feature test macros(C++20)

Language support library

Concepts library(C++20)

Diagnostics library

Memory management library

Metaprogramming library(C++11)

General utilities library

Containers library

Iterators library

Ranges library(C++20)

Algorithms library

Strings library

Text processing library

Numerics library

Date and time library

Input/output library

Filesystem library(C++17)

Concurrency support library(C++11)

Execution control library(C++26)

Technical specifications

Symbols index

External libraries

 

Utilities library

Language support Type support (basic types, RTTI) Library feature-test macros(C++20) Program utilities Variadic functions initializer_list (C++11) is_constant_evaluated (C++20) is_within_lifetime (C++26) source_location (C++20) Coroutine support(C++20) Contract support(C++26) Three-way comparison three_way_comparablethree_way_comparable_with (C++20)(C++20) strong_ordering (C++20) weak_ordering (C++20) partial_ordering (C++20) common_comparison_category (C++20) compare_three_way_result (C++20) compare_three_way (C++20) strong_order (C++20) weak_order (C++20) partial_order (C++20) compare_strong_order_fallback (C++20) compare_weak_order_fallback (C++20) compare_partial_order_fallback (C++20)   is_eqis_ltis_lteq (C++20)(C++20)(C++20)   is_neqis_gtis_gteq (C++20)(C++20)(C++20)

General utilities Function objects Bit manipulation(C++20) bitset hash (C++11) Relational operators(deprecated in C++20) rel_ops::operator!=rel_ops::operator>    rel_ops::operator<=rel_ops::operator>= Integer comparison functions cmp_equalcmp_lesscmp_less_than (C++20)(C++20)(C++20)   cmp_not_equalcmp_greatercmp_greater_than (C++20)(C++20)(C++20) in_range (C++20) Swap and type operations swap ranges::swap (C++20) exchange (C++14) declval (C++11) to_underlying (C++23) forward (C++11) forward_like (C++23) move (C++11) move_if_noexcept (C++11) as_const (C++17) Common vocabulary types pair tuple (C++11) optional (C++17) any (C++17) variant (C++17) tuple_size (C++11) tuple_element (C++11) apply (C++17) make_from_tuple (C++17) expected (C++23)

 

Program support utilities

Program termination
abort exit quick_exit (C++11) _Exit (C++11)	atexit at_quick_exit (C++11) EXIT_SUCCESSEXIT_FAILURE
Unreachable control flow
unreachable (C++23)
Communicating with the environment
system	getenv
Signals
signal raise sig_atomic_t	SIG_DFLSIG_IGN SIG_ERR
Signal types
SIGABRTSIGFPESIGILL	SIGINTSIGSEGVSIGTERM
Non-local jumps
setjmp	longjmp
Types
jmp_buf

 

Defined in header <utility>
[[noreturn]]void unreachable();		(since C++23)

Invokes undefined behavior at a given point.

An implementation may use this to optimize impossible code branches away (typically, in optimized builds) or to trap them to prevent further execution (typically, in debug builds).

Notes

Feature-test macro	Value	Std	Feature
__cpp_lib_unreachable	202202L	(C++23)	std::unreachable

Possible implementation

[[noreturn]]inlinevoid unreachable(){// Uses compiler specific extensions if possible.// Even if no extension is used, undefined behavior is still raised by// an empty function body and the noreturn attribute.#if defined(_MSC_VER) && !defined(__clang__) // MSVC __assume(false);#else // GCC, Clang __builtin_unreachable();#endif}

Example

Run this code

#include <cassert>#include <cstddef>#include <cstdint>#include <utility>#include <vector>   struct Color {std::uint8_t r, g, b, a;};   // Assume that only restricted set of texture caps is supported.void generate_texture(std::vector<Color>& tex, std::size_t xy){switch(xy){case128:[[fallthrough]];case256:[[fallthrough]];case512:/* ... */ tex.clear(); tex.resize(xy * xy, Color{0, 0, 0, 0});break;default: std::unreachable();}}   int main(){std::vector<Color> tex; generate_texture(tex, 128);// OKassert(tex.size()==128*128); generate_texture(tex, 32);// Results in undefined behavior}

Possible output:

Segmentation fault

See also

[[assume(expression)]] (C++23)	specifies that the expression will always evaluate to true at a given point (attribute specifier)
assume_aligned (C++20)	informs the compiler that a pointer is aligned (function template)
C documentation for unreachable

External Links

1.	GCC docs: __builtin_unreachable
2.	Clang docs: __builtin_unreachable
3.	MSVC docs: __assume