blob: 412e02af38227ee9904cf7151d7f90c4ad4573e7 [file] [log] [blame]
Howard Hinnantc51e1022010-05-11 19:42:16 +00001// -*- C++ -*-
Louis Dionne9bd93882021-11-17 16:25:01 -05002//===----------------------------------------------------------------------===//
Howard Hinnantc51e1022010-05-11 19:42:16 +00003//
Chandler Carruthd2012102019-01-19 10:56:40 +00004// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
5// See https://llvm.org/LICENSE.txt for license information.
6// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
Howard Hinnantc51e1022010-05-11 19:42:16 +00007//
8//===----------------------------------------------------------------------===//
9
10#ifndef _LIBCPP_EXCEPTION
11#define _LIBCPP_EXCEPTION
12
13/*
14 exception synopsis
15
16namespace std
17{
18
19class exception
20{
21public:
Howard Hinnant1bc52cf2011-05-26 18:23:59 +000022 exception() noexcept;
23 exception(const exception&) noexcept;
24 exception& operator=(const exception&) noexcept;
25 virtual ~exception() noexcept;
26 virtual const char* what() const noexcept;
Howard Hinnantc51e1022010-05-11 19:42:16 +000027};
28
29class bad_exception
30 : public exception
31{
32public:
Howard Hinnant1bc52cf2011-05-26 18:23:59 +000033 bad_exception() noexcept;
34 bad_exception(const bad_exception&) noexcept;
35 bad_exception& operator=(const bad_exception&) noexcept;
36 virtual ~bad_exception() noexcept;
37 virtual const char* what() const noexcept;
Howard Hinnantc51e1022010-05-11 19:42:16 +000038};
39
40typedef void (*unexpected_handler)();
Howard Hinnant1bc52cf2011-05-26 18:23:59 +000041unexpected_handler set_unexpected(unexpected_handler f ) noexcept;
42unexpected_handler get_unexpected() noexcept;
43[[noreturn]] void unexpected();
Howard Hinnantc51e1022010-05-11 19:42:16 +000044
45typedef void (*terminate_handler)();
Howard Hinnant1bc52cf2011-05-26 18:23:59 +000046terminate_handler set_terminate(terminate_handler f ) noexcept;
47terminate_handler get_terminate() noexcept;
48[[noreturn]] void terminate() noexcept;
Howard Hinnantc51e1022010-05-11 19:42:16 +000049
Marshall Clow209dacc2015-06-02 15:33:38 +000050bool uncaught_exception() noexcept;
51int uncaught_exceptions() noexcept; // C++17
Howard Hinnantc51e1022010-05-11 19:42:16 +000052
53typedef unspecified exception_ptr;
54
Howard Hinnant1bc52cf2011-05-26 18:23:59 +000055exception_ptr current_exception() noexcept;
Howard Hinnantc51e1022010-05-11 19:42:16 +000056void rethrow_exception [[noreturn]] (exception_ptr p);
Howard Hinnant1bc52cf2011-05-26 18:23:59 +000057template<class E> exception_ptr make_exception_ptr(E e) noexcept;
Howard Hinnantc51e1022010-05-11 19:42:16 +000058
59class nested_exception
60{
61public:
Howard Hinnant1bc52cf2011-05-26 18:23:59 +000062 nested_exception() noexcept;
63 nested_exception(const nested_exception&) noexcept = default;
64 nested_exception& operator=(const nested_exception&) noexcept = default;
Howard Hinnantc51e1022010-05-11 19:42:16 +000065 virtual ~nested_exception() = default;
66
67 // access functions
Howard Hinnant1bc52cf2011-05-26 18:23:59 +000068 [[noreturn]] void rethrow_nested() const;
69 exception_ptr nested_ptr() const noexcept;
Howard Hinnantc51e1022010-05-11 19:42:16 +000070};
71
Howard Hinnant1bc52cf2011-05-26 18:23:59 +000072template <class T> [[noreturn]] void throw_with_nested(T&& t);
Howard Hinnantc51e1022010-05-11 19:42:16 +000073template <class E> void rethrow_if_nested(const E& e);
74
75} // std
76
77*/
78
Louis Dionneb4fce352022-03-25 12:55:36 -040079#include <__assert> // all public C++ headers provide the assertion handler
Louis Dionne73912b22020-11-04 15:01:25 -050080#include <__availability>
Arthur O'Dwyeref181602021-05-19 11:57:04 -040081#include <__config>
Louis Dionne735bc462021-04-14 13:59:03 -040082#include <__memory/addressof.h>
Howard Hinnantc51e1022010-05-11 19:42:16 +000083#include <cstddef>
Eric Fiselieraae1ccf2016-12-03 03:22:11 +000084#include <cstdlib>
Howard Hinnante4f92722010-05-27 17:06:52 +000085#include <type_traits>
Marshall Clow0a1e7502018-09-12 19:41:40 +000086#include <version>
Howard Hinnantc51e1022010-05-11 19:42:16 +000087
Eric Fiselier85f66332019-03-05 01:57:01 +000088#if defined(_LIBCPP_ABI_VCRUNTIME)
Eric Fiselierec3a1672017-02-10 08:57:35 +000089#include <vcruntime_exception.h>
90#endif
91
Howard Hinnantaaaa52b2011-10-17 20:05:10 +000092#if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
Arthur O'Dwyer6eeaa002022-02-01 20:16:40 -050093# pragma GCC system_header
Howard Hinnantaaaa52b2011-10-17 20:05:10 +000094#endif
Howard Hinnantc51e1022010-05-11 19:42:16 +000095
96namespace std // purposefully not using versioning namespace
97{
98
Eric Fiselier85f66332019-03-05 01:57:01 +000099#if !defined(_LIBCPP_ABI_VCRUNTIME)
Howard Hinnantc51e1022010-05-11 19:42:16 +0000100class _LIBCPP_EXCEPTION_ABI exception
101{
102public:
Howard Hinnant1bc52cf2011-05-26 18:23:59 +0000103 _LIBCPP_INLINE_VISIBILITY exception() _NOEXCEPT {}
Dimitry Andric47269ce2020-03-13 19:36:26 +0100104 _LIBCPP_INLINE_VISIBILITY exception(const exception&) _NOEXCEPT = default;
105
Howard Hinnant1bc52cf2011-05-26 18:23:59 +0000106 virtual ~exception() _NOEXCEPT;
107 virtual const char* what() const _NOEXCEPT;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000108};
109
110class _LIBCPP_EXCEPTION_ABI bad_exception
111 : public exception
112{
113public:
Howard Hinnant1bc52cf2011-05-26 18:23:59 +0000114 _LIBCPP_INLINE_VISIBILITY bad_exception() _NOEXCEPT {}
115 virtual ~bad_exception() _NOEXCEPT;
116 virtual const char* what() const _NOEXCEPT;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000117};
Eric Fiselier85f66332019-03-05 01:57:01 +0000118#endif // !_LIBCPP_ABI_VCRUNTIME
Howard Hinnantc51e1022010-05-11 19:42:16 +0000119
Eric Fiselierddd77792017-02-17 03:25:08 +0000120#if _LIBCPP_STD_VER <= 14 \
121 || defined(_LIBCPP_ENABLE_CXX17_REMOVED_UNEXPECTED_FUNCTIONS) \
122 || defined(_LIBCPP_BUILDING_LIBRARY)
Howard Hinnantc51e1022010-05-11 19:42:16 +0000123typedef void (*unexpected_handler)();
Howard Hinnant8331b762013-03-06 23:30:19 +0000124_LIBCPP_FUNC_VIS unexpected_handler set_unexpected(unexpected_handler) _NOEXCEPT;
125_LIBCPP_FUNC_VIS unexpected_handler get_unexpected() _NOEXCEPT;
126_LIBCPP_NORETURN _LIBCPP_FUNC_VIS void unexpected();
Eric Fiselierddd77792017-02-17 03:25:08 +0000127#endif
Howard Hinnantc51e1022010-05-11 19:42:16 +0000128
129typedef void (*terminate_handler)();
Howard Hinnant8331b762013-03-06 23:30:19 +0000130_LIBCPP_FUNC_VIS terminate_handler set_terminate(terminate_handler) _NOEXCEPT;
131_LIBCPP_FUNC_VIS terminate_handler get_terminate() _NOEXCEPT;
132_LIBCPP_NORETURN _LIBCPP_FUNC_VIS void terminate() _NOEXCEPT;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000133
Howard Hinnant8331b762013-03-06 23:30:19 +0000134_LIBCPP_FUNC_VIS bool uncaught_exception() _NOEXCEPT;
Mehdi Amini228053d2017-05-04 17:08:54 +0000135_LIBCPP_FUNC_VIS _LIBCPP_AVAILABILITY_UNCAUGHT_EXCEPTIONS int uncaught_exceptions() _NOEXCEPT;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000136
Howard Hinnant8331b762013-03-06 23:30:19 +0000137class _LIBCPP_TYPE_VIS exception_ptr;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000138
Howard Hinnanta37d3cf2013-08-12 18:38:34 +0000139_LIBCPP_FUNC_VIS exception_ptr current_exception() _NOEXCEPT;
140_LIBCPP_NORETURN _LIBCPP_FUNC_VIS void rethrow_exception(exception_ptr);
Howard Hinnantc51e1022010-05-11 19:42:16 +0000141
Eric Fiselier94ef6cc2017-05-08 01:17:50 +0000142#ifndef _LIBCPP_ABI_MICROSOFT
143
Howard Hinnant8331b762013-03-06 23:30:19 +0000144class _LIBCPP_TYPE_VIS exception_ptr
Howard Hinnantc51e1022010-05-11 19:42:16 +0000145{
146 void* __ptr_;
147public:
Howard Hinnant1bc52cf2011-05-26 18:23:59 +0000148 _LIBCPP_INLINE_VISIBILITY exception_ptr() _NOEXCEPT : __ptr_() {}
149 _LIBCPP_INLINE_VISIBILITY exception_ptr(nullptr_t) _NOEXCEPT : __ptr_() {}
Eric Fiselier94ef6cc2017-05-08 01:17:50 +0000150
Howard Hinnant1bc52cf2011-05-26 18:23:59 +0000151 exception_ptr(const exception_ptr&) _NOEXCEPT;
152 exception_ptr& operator=(const exception_ptr&) _NOEXCEPT;
153 ~exception_ptr() _NOEXCEPT;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000154
Arthur O'Dwyer6c9c9a72021-06-15 12:57:54 -0400155 _LIBCPP_INLINE_VISIBILITY explicit operator bool() const _NOEXCEPT
Eric Fiselier94ef6cc2017-05-08 01:17:50 +0000156 {return __ptr_ != nullptr;}
Howard Hinnantc51e1022010-05-11 19:42:16 +0000157
Howard Hinnant874ad9a2010-09-21 21:28:23 +0000158 friend _LIBCPP_INLINE_VISIBILITY
Howard Hinnant1bc52cf2011-05-26 18:23:59 +0000159 bool operator==(const exception_ptr& __x, const exception_ptr& __y) _NOEXCEPT
Howard Hinnantc51e1022010-05-11 19:42:16 +0000160 {return __x.__ptr_ == __y.__ptr_;}
Eric Fiselier94ef6cc2017-05-08 01:17:50 +0000161
Howard Hinnant874ad9a2010-09-21 21:28:23 +0000162 friend _LIBCPP_INLINE_VISIBILITY
Howard Hinnant1bc52cf2011-05-26 18:23:59 +0000163 bool operator!=(const exception_ptr& __x, const exception_ptr& __y) _NOEXCEPT
Howard Hinnantc51e1022010-05-11 19:42:16 +0000164 {return !(__x == __y);}
165
Howard Hinnanta37d3cf2013-08-12 18:38:34 +0000166 friend _LIBCPP_FUNC_VIS exception_ptr current_exception() _NOEXCEPT;
167 friend _LIBCPP_FUNC_VIS void rethrow_exception(exception_ptr);
Howard Hinnantc51e1022010-05-11 19:42:16 +0000168};
169
Howard Hinnantc834c512011-11-29 18:15:50 +0000170template<class _Ep>
Louis Dionnecdc41112018-11-21 17:00:52 +0000171_LIBCPP_INLINE_VISIBILITY exception_ptr
Howard Hinnantc834c512011-11-29 18:15:50 +0000172make_exception_ptr(_Ep __e) _NOEXCEPT
Howard Hinnantc51e1022010-05-11 19:42:16 +0000173{
Howard Hinnant72f73582010-08-11 17:04:31 +0000174#ifndef _LIBCPP_NO_EXCEPTIONS
Howard Hinnantc51e1022010-05-11 19:42:16 +0000175 try
176 {
177 throw __e;
178 }
179 catch (...)
180 {
181 return current_exception();
182 }
Eric Fiselieraae1ccf2016-12-03 03:22:11 +0000183#else
Eric Fiselier6003c772016-12-23 23:37:52 +0000184 ((void)__e);
Eric Fiselieraae1ccf2016-12-03 03:22:11 +0000185 _VSTD::abort();
186#endif
Howard Hinnantc51e1022010-05-11 19:42:16 +0000187}
188
Eric Fiselier94ef6cc2017-05-08 01:17:50 +0000189#else // _LIBCPP_ABI_MICROSOFT
190
191class _LIBCPP_TYPE_VIS exception_ptr
192{
Nikolas Klauser41c59762022-02-14 18:52:28 +0100193_LIBCPP_DIAGNOSTIC_PUSH
194_LIBCPP_CLANG_DIAGNOSTIC_IGNORED("-Wunused-private-field")
Eric Fiselier94ef6cc2017-05-08 01:17:50 +0000195 void* __ptr1_;
196 void* __ptr2_;
Nikolas Klauser41c59762022-02-14 18:52:28 +0100197_LIBCPP_DIAGNOSTIC_POP
Eric Fiselier94ef6cc2017-05-08 01:17:50 +0000198public:
199 exception_ptr() _NOEXCEPT;
200 exception_ptr(nullptr_t) _NOEXCEPT;
201 exception_ptr(const exception_ptr& __other) _NOEXCEPT;
202 exception_ptr& operator=(const exception_ptr& __other) _NOEXCEPT;
203 exception_ptr& operator=(nullptr_t) _NOEXCEPT;
204 ~exception_ptr() _NOEXCEPT;
Arthur O'Dwyer6c9c9a72021-06-15 12:57:54 -0400205 explicit operator bool() const _NOEXCEPT;
Eric Fiselier94ef6cc2017-05-08 01:17:50 +0000206};
207
208_LIBCPP_FUNC_VIS
209bool operator==(const exception_ptr& __x, const exception_ptr& __y) _NOEXCEPT;
210
211inline _LIBCPP_INLINE_VISIBILITY
212bool operator!=(const exception_ptr& __x, const exception_ptr& __y) _NOEXCEPT
213 {return !(__x == __y);}
214
215_LIBCPP_FUNC_VIS void swap(exception_ptr&, exception_ptr&) _NOEXCEPT;
216
217_LIBCPP_FUNC_VIS exception_ptr __copy_exception_ptr(void *__except, const void* __ptr);
218_LIBCPP_FUNC_VIS exception_ptr current_exception() _NOEXCEPT;
219_LIBCPP_NORETURN _LIBCPP_FUNC_VIS void rethrow_exception(exception_ptr p);
220
221// This is a built-in template function which automagically extracts the required
222// information.
223template <class _E> void *__GetExceptionInfo(_E);
224
225template<class _Ep>
Louis Dionnecdc41112018-11-21 17:00:52 +0000226_LIBCPP_INLINE_VISIBILITY exception_ptr
Eric Fiselier94ef6cc2017-05-08 01:17:50 +0000227make_exception_ptr(_Ep __e) _NOEXCEPT
228{
229 return __copy_exception_ptr(_VSTD::addressof(__e), __GetExceptionInfo(__e));
230}
231
232#endif // _LIBCPP_ABI_MICROSOFT
Howard Hinnante4f92722010-05-27 17:06:52 +0000233// nested_exception
234
235class _LIBCPP_EXCEPTION_ABI nested_exception
236{
237 exception_ptr __ptr_;
238public:
Howard Hinnant1bc52cf2011-05-26 18:23:59 +0000239 nested_exception() _NOEXCEPT;
240// nested_exception(const nested_exception&) noexcept = default;
241// nested_exception& operator=(const nested_exception&) noexcept = default;
242 virtual ~nested_exception() _NOEXCEPT;
Howard Hinnante4f92722010-05-27 17:06:52 +0000243
244 // access functions
Richard Smithcabd3922012-07-26 02:04:22 +0000245 _LIBCPP_NORETURN void rethrow_nested() const;
Howard Hinnant1bc52cf2011-05-26 18:23:59 +0000246 _LIBCPP_INLINE_VISIBILITY exception_ptr nested_ptr() const _NOEXCEPT {return __ptr_;}
Howard Hinnante4f92722010-05-27 17:06:52 +0000247};
248
249template <class _Tp>
250struct __nested
251 : public _Tp,
252 public nested_exception
253{
Howard Hinnant874ad9a2010-09-21 21:28:23 +0000254 _LIBCPP_INLINE_VISIBILITY explicit __nested(const _Tp& __t) : _Tp(__t) {}
Howard Hinnante4f92722010-05-27 17:06:52 +0000255};
256
Howard Hinnant72f73582010-08-11 17:04:31 +0000257#ifndef _LIBCPP_NO_EXCEPTIONS
Marshall Clowb1cf5a92017-04-13 14:41:45 +0000258template <class _Tp, class _Up, bool>
259struct __throw_with_nested;
260
261template <class _Tp, class _Up>
262struct __throw_with_nested<_Tp, _Up, true> {
Louis Dionne16fe2952018-07-11 23:14:33 +0000263 _LIBCPP_NORETURN static inline _LIBCPP_INLINE_VISIBILITY void
Marshall Clowb1cf5a92017-04-13 14:41:45 +0000264 __do_throw(_Tp&& __t)
Marshall Clowb1cf5a92017-04-13 14:41:45 +0000265 {
Christopher Di Bella41f26e82021-06-05 02:47:47 +0000266 throw __nested<_Up>(static_cast<_Tp&&>(__t));
Marshall Clowb1cf5a92017-04-13 14:41:45 +0000267 }
268};
269
270template <class _Tp, class _Up>
271struct __throw_with_nested<_Tp, _Up, false> {
Louis Dionne16fe2952018-07-11 23:14:33 +0000272 _LIBCPP_NORETURN static inline _LIBCPP_INLINE_VISIBILITY void
Eric Fiselier58e1c912017-04-19 01:35:58 +0000273#ifndef _LIBCPP_CXX03_LANG
Marshall Clowb1cf5a92017-04-13 14:41:45 +0000274 __do_throw(_Tp&& __t)
Eric Fiselier58e1c912017-04-19 01:35:58 +0000275#else
Marshall Clowb1cf5a92017-04-13 14:41:45 +0000276 __do_throw (_Tp& __t)
Louis Dionne2b1ceaa2021-04-20 12:03:32 -0400277#endif // _LIBCPP_CXX03_LANG
Marshall Clowb1cf5a92017-04-13 14:41:45 +0000278 {
Christopher Di Bella41f26e82021-06-05 02:47:47 +0000279 throw static_cast<_Tp&&>(__t);
Marshall Clowb1cf5a92017-04-13 14:41:45 +0000280 }
281};
Howard Hinnant72f73582010-08-11 17:04:31 +0000282#endif
Howard Hinnante4f92722010-05-27 17:06:52 +0000283
284template <class _Tp>
Richard Smithcabd3922012-07-26 02:04:22 +0000285_LIBCPP_NORETURN
Howard Hinnant3b6579a2010-08-22 00:02:43 +0000286void
Marshall Clowb1cf5a92017-04-13 14:41:45 +0000287throw_with_nested(_Tp&& __t)
Howard Hinnante4f92722010-05-27 17:06:52 +0000288{
Howard Hinnant72f73582010-08-11 17:04:31 +0000289#ifndef _LIBCPP_NO_EXCEPTIONS
Marshall Clow94a38502017-04-13 16:57:42 +0000290 typedef typename decay<_Tp>::type _Up;
291 static_assert( is_copy_constructible<_Up>::value, "type thrown must be CopyConstructible");
Marshall Clowb1cf5a92017-04-13 14:41:45 +0000292 __throw_with_nested<_Tp, _Up,
293 is_class<_Up>::value &&
294 !is_base_of<nested_exception, _Up>::value &&
295 !__libcpp_is_final<_Up>::value>::
Christopher Di Bella41f26e82021-06-05 02:47:47 +0000296 __do_throw(static_cast<_Tp&&>(__t));
Eric Fiselier6003c772016-12-23 23:37:52 +0000297#else
298 ((void)__t);
299 // FIXME: Make this abort
Howard Hinnant72f73582010-08-11 17:04:31 +0000300#endif
Howard Hinnante4f92722010-05-27 17:06:52 +0000301}
302
Marshall Clowb75c89c2017-03-14 17:08:47 +0000303template <class _From, class _To>
Louis Dionne5083aef2022-03-23 17:02:07 -0400304struct __can_dynamic_cast : _BoolConstant<
Marshall Clowb75c89c2017-03-14 17:08:47 +0000305 is_polymorphic<_From>::value &&
306 (!is_base_of<_To, _From>::value ||
Louis Dionne5083aef2022-03-23 17:02:07 -0400307 is_convertible<const _From*, const _To*>::value)> {};
Marshall Clowb75c89c2017-03-14 17:08:47 +0000308
Howard Hinnantc834c512011-11-29 18:15:50 +0000309template <class _Ep>
Howard Hinnant874ad9a2010-09-21 21:28:23 +0000310inline _LIBCPP_INLINE_VISIBILITY
Howard Hinnante4f92722010-05-27 17:06:52 +0000311void
Marshall Clowb75c89c2017-03-14 17:08:47 +0000312rethrow_if_nested(const _Ep& __e,
313 typename enable_if< __can_dynamic_cast<_Ep, nested_exception>::value>::type* = 0)
Howard Hinnante4f92722010-05-27 17:06:52 +0000314{
Marshall Clowe993abe2015-12-14 18:01:56 +0000315 const nested_exception* __nep = dynamic_cast<const nested_exception*>(_VSTD::addressof(__e));
Howard Hinnant3615a192010-05-28 13:35:41 +0000316 if (__nep)
317 __nep->rethrow_nested();
Howard Hinnante4f92722010-05-27 17:06:52 +0000318}
319
Howard Hinnantc834c512011-11-29 18:15:50 +0000320template <class _Ep>
Howard Hinnant874ad9a2010-09-21 21:28:23 +0000321inline _LIBCPP_INLINE_VISIBILITY
Howard Hinnante4f92722010-05-27 17:06:52 +0000322void
Marshall Clowb75c89c2017-03-14 17:08:47 +0000323rethrow_if_nested(const _Ep&,
324 typename enable_if<!__can_dynamic_cast<_Ep, nested_exception>::value>::type* = 0)
Howard Hinnante4f92722010-05-27 17:06:52 +0000325{
326}
327
Nikolas Klauserd26407a2021-12-02 14:12:51 +0100328} // namespace std
Howard Hinnantc51e1022010-05-11 19:42:16 +0000329
Louis Dionne2b1ceaa2021-04-20 12:03:32 -0400330#endif // _LIBCPP_EXCEPTION