blob: 8e32979f5749ad12d07a5c35cfbf63152cedc09a [file] [log] [blame]
Howard Hinnantc51e1022010-05-11 19:42:16 +00001// -*- C++ -*-
2//===-------------------------- exception ---------------------------------===//
3//
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
79#include <__config>
80#include <cstddef>
Eric Fiselieraae1ccf2016-12-03 03:22:11 +000081#include <cstdlib>
Howard Hinnante4f92722010-05-27 17:06:52 +000082#include <type_traits>
Marshall Clow0a1e7502018-09-12 19:41:40 +000083#include <version>
Howard Hinnantc51e1022010-05-11 19:42:16 +000084
Eric Fiselier85f66332019-03-05 01:57:01 +000085#if defined(_LIBCPP_ABI_VCRUNTIME)
Eric Fiselierec3a1672017-02-10 08:57:35 +000086#include <vcruntime_exception.h>
87#endif
88
Howard Hinnantaaaa52b2011-10-17 20:05:10 +000089#if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
Howard Hinnantc51e1022010-05-11 19:42:16 +000090#pragma GCC system_header
Howard Hinnantaaaa52b2011-10-17 20:05:10 +000091#endif
Howard Hinnantc51e1022010-05-11 19:42:16 +000092
93namespace std // purposefully not using versioning namespace
94{
95
Eric Fiselier85f66332019-03-05 01:57:01 +000096#if !defined(_LIBCPP_ABI_VCRUNTIME)
Howard Hinnantc51e1022010-05-11 19:42:16 +000097class _LIBCPP_EXCEPTION_ABI exception
98{
99public:
Howard Hinnant1bc52cf2011-05-26 18:23:59 +0000100 _LIBCPP_INLINE_VISIBILITY exception() _NOEXCEPT {}
Dimitry Andric47269ce2020-03-13 19:36:26 +0100101 _LIBCPP_INLINE_VISIBILITY exception(const exception&) _NOEXCEPT = default;
102
Howard Hinnant1bc52cf2011-05-26 18:23:59 +0000103 virtual ~exception() _NOEXCEPT;
104 virtual const char* what() const _NOEXCEPT;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000105};
106
107class _LIBCPP_EXCEPTION_ABI bad_exception
108 : public exception
109{
110public:
Howard Hinnant1bc52cf2011-05-26 18:23:59 +0000111 _LIBCPP_INLINE_VISIBILITY bad_exception() _NOEXCEPT {}
112 virtual ~bad_exception() _NOEXCEPT;
113 virtual const char* what() const _NOEXCEPT;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000114};
Eric Fiselier85f66332019-03-05 01:57:01 +0000115#endif // !_LIBCPP_ABI_VCRUNTIME
Howard Hinnantc51e1022010-05-11 19:42:16 +0000116
Eric Fiselierddd77792017-02-17 03:25:08 +0000117#if _LIBCPP_STD_VER <= 14 \
118 || defined(_LIBCPP_ENABLE_CXX17_REMOVED_UNEXPECTED_FUNCTIONS) \
119 || defined(_LIBCPP_BUILDING_LIBRARY)
Howard Hinnantc51e1022010-05-11 19:42:16 +0000120typedef void (*unexpected_handler)();
Howard Hinnant8331b762013-03-06 23:30:19 +0000121_LIBCPP_FUNC_VIS unexpected_handler set_unexpected(unexpected_handler) _NOEXCEPT;
122_LIBCPP_FUNC_VIS unexpected_handler get_unexpected() _NOEXCEPT;
123_LIBCPP_NORETURN _LIBCPP_FUNC_VIS void unexpected();
Eric Fiselierddd77792017-02-17 03:25:08 +0000124#endif
Howard Hinnantc51e1022010-05-11 19:42:16 +0000125
126typedef void (*terminate_handler)();
Howard Hinnant8331b762013-03-06 23:30:19 +0000127_LIBCPP_FUNC_VIS terminate_handler set_terminate(terminate_handler) _NOEXCEPT;
128_LIBCPP_FUNC_VIS terminate_handler get_terminate() _NOEXCEPT;
129_LIBCPP_NORETURN _LIBCPP_FUNC_VIS void terminate() _NOEXCEPT;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000130
Howard Hinnant8331b762013-03-06 23:30:19 +0000131_LIBCPP_FUNC_VIS bool uncaught_exception() _NOEXCEPT;
Mehdi Amini228053d2017-05-04 17:08:54 +0000132_LIBCPP_FUNC_VIS _LIBCPP_AVAILABILITY_UNCAUGHT_EXCEPTIONS int uncaught_exceptions() _NOEXCEPT;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000133
Howard Hinnant8331b762013-03-06 23:30:19 +0000134class _LIBCPP_TYPE_VIS exception_ptr;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000135
Howard Hinnanta37d3cf2013-08-12 18:38:34 +0000136_LIBCPP_FUNC_VIS exception_ptr current_exception() _NOEXCEPT;
137_LIBCPP_NORETURN _LIBCPP_FUNC_VIS void rethrow_exception(exception_ptr);
Howard Hinnantc51e1022010-05-11 19:42:16 +0000138
Eric Fiselier94ef6cc2017-05-08 01:17:50 +0000139#ifndef _LIBCPP_ABI_MICROSOFT
140
Howard Hinnant8331b762013-03-06 23:30:19 +0000141class _LIBCPP_TYPE_VIS exception_ptr
Howard Hinnantc51e1022010-05-11 19:42:16 +0000142{
143 void* __ptr_;
144public:
Howard Hinnant1bc52cf2011-05-26 18:23:59 +0000145 _LIBCPP_INLINE_VISIBILITY exception_ptr() _NOEXCEPT : __ptr_() {}
146 _LIBCPP_INLINE_VISIBILITY exception_ptr(nullptr_t) _NOEXCEPT : __ptr_() {}
Eric Fiselier94ef6cc2017-05-08 01:17:50 +0000147
Howard Hinnant1bc52cf2011-05-26 18:23:59 +0000148 exception_ptr(const exception_ptr&) _NOEXCEPT;
149 exception_ptr& operator=(const exception_ptr&) _NOEXCEPT;
150 ~exception_ptr() _NOEXCEPT;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000151
Eric Fiselier94ef6cc2017-05-08 01:17:50 +0000152 _LIBCPP_INLINE_VISIBILITY _LIBCPP_EXPLICIT operator bool() const _NOEXCEPT
153 {return __ptr_ != nullptr;}
Howard Hinnantc51e1022010-05-11 19:42:16 +0000154
Howard Hinnant874ad9a2010-09-21 21:28:23 +0000155 friend _LIBCPP_INLINE_VISIBILITY
Howard Hinnant1bc52cf2011-05-26 18:23:59 +0000156 bool operator==(const exception_ptr& __x, const exception_ptr& __y) _NOEXCEPT
Howard Hinnantc51e1022010-05-11 19:42:16 +0000157 {return __x.__ptr_ == __y.__ptr_;}
Eric Fiselier94ef6cc2017-05-08 01:17:50 +0000158
Howard Hinnant874ad9a2010-09-21 21:28:23 +0000159 friend _LIBCPP_INLINE_VISIBILITY
Howard Hinnant1bc52cf2011-05-26 18:23:59 +0000160 bool operator!=(const exception_ptr& __x, const exception_ptr& __y) _NOEXCEPT
Howard Hinnantc51e1022010-05-11 19:42:16 +0000161 {return !(__x == __y);}
162
Howard Hinnanta37d3cf2013-08-12 18:38:34 +0000163 friend _LIBCPP_FUNC_VIS exception_ptr current_exception() _NOEXCEPT;
164 friend _LIBCPP_FUNC_VIS void rethrow_exception(exception_ptr);
Howard Hinnantc51e1022010-05-11 19:42:16 +0000165};
166
Howard Hinnantc834c512011-11-29 18:15:50 +0000167template<class _Ep>
Louis Dionnecdc41112018-11-21 17:00:52 +0000168_LIBCPP_INLINE_VISIBILITY exception_ptr
Howard Hinnantc834c512011-11-29 18:15:50 +0000169make_exception_ptr(_Ep __e) _NOEXCEPT
Howard Hinnantc51e1022010-05-11 19:42:16 +0000170{
Howard Hinnant72f73582010-08-11 17:04:31 +0000171#ifndef _LIBCPP_NO_EXCEPTIONS
Howard Hinnantc51e1022010-05-11 19:42:16 +0000172 try
173 {
174 throw __e;
175 }
176 catch (...)
177 {
178 return current_exception();
179 }
Eric Fiselieraae1ccf2016-12-03 03:22:11 +0000180#else
Eric Fiselier6003c772016-12-23 23:37:52 +0000181 ((void)__e);
Eric Fiselieraae1ccf2016-12-03 03:22:11 +0000182 _VSTD::abort();
183#endif
Howard Hinnantc51e1022010-05-11 19:42:16 +0000184}
185
Eric Fiselier94ef6cc2017-05-08 01:17:50 +0000186#else // _LIBCPP_ABI_MICROSOFT
187
188class _LIBCPP_TYPE_VIS exception_ptr
189{
190#if defined(__clang__)
191#pragma clang diagnostic push
192#pragma clang diagnostic ignored "-Wunused-private-field"
193#endif
194 void* __ptr1_;
195 void* __ptr2_;
196#if defined(__clang__)
197#pragma clang diagnostic pop
198#endif
199public:
200 exception_ptr() _NOEXCEPT;
201 exception_ptr(nullptr_t) _NOEXCEPT;
202 exception_ptr(const exception_ptr& __other) _NOEXCEPT;
203 exception_ptr& operator=(const exception_ptr& __other) _NOEXCEPT;
204 exception_ptr& operator=(nullptr_t) _NOEXCEPT;
205 ~exception_ptr() _NOEXCEPT;
206 _LIBCPP_EXPLICIT operator bool() const _NOEXCEPT;
207};
208
209_LIBCPP_FUNC_VIS
210bool operator==(const exception_ptr& __x, const exception_ptr& __y) _NOEXCEPT;
211
212inline _LIBCPP_INLINE_VISIBILITY
213bool operator!=(const exception_ptr& __x, const exception_ptr& __y) _NOEXCEPT
214 {return !(__x == __y);}
215
216_LIBCPP_FUNC_VIS void swap(exception_ptr&, exception_ptr&) _NOEXCEPT;
217
218_LIBCPP_FUNC_VIS exception_ptr __copy_exception_ptr(void *__except, const void* __ptr);
219_LIBCPP_FUNC_VIS exception_ptr current_exception() _NOEXCEPT;
220_LIBCPP_NORETURN _LIBCPP_FUNC_VIS void rethrow_exception(exception_ptr p);
221
222// This is a built-in template function which automagically extracts the required
223// information.
224template <class _E> void *__GetExceptionInfo(_E);
225
226template<class _Ep>
Louis Dionnecdc41112018-11-21 17:00:52 +0000227_LIBCPP_INLINE_VISIBILITY exception_ptr
Eric Fiselier94ef6cc2017-05-08 01:17:50 +0000228make_exception_ptr(_Ep __e) _NOEXCEPT
229{
230 return __copy_exception_ptr(_VSTD::addressof(__e), __GetExceptionInfo(__e));
231}
232
233#endif // _LIBCPP_ABI_MICROSOFT
Howard Hinnante4f92722010-05-27 17:06:52 +0000234// nested_exception
235
236class _LIBCPP_EXCEPTION_ABI nested_exception
237{
238 exception_ptr __ptr_;
239public:
Howard Hinnant1bc52cf2011-05-26 18:23:59 +0000240 nested_exception() _NOEXCEPT;
241// nested_exception(const nested_exception&) noexcept = default;
242// nested_exception& operator=(const nested_exception&) noexcept = default;
243 virtual ~nested_exception() _NOEXCEPT;
Howard Hinnante4f92722010-05-27 17:06:52 +0000244
245 // access functions
Richard Smithcabd3922012-07-26 02:04:22 +0000246 _LIBCPP_NORETURN void rethrow_nested() const;
Howard Hinnant1bc52cf2011-05-26 18:23:59 +0000247 _LIBCPP_INLINE_VISIBILITY exception_ptr nested_ptr() const _NOEXCEPT {return __ptr_;}
Howard Hinnante4f92722010-05-27 17:06:52 +0000248};
249
250template <class _Tp>
251struct __nested
252 : public _Tp,
253 public nested_exception
254{
Howard Hinnant874ad9a2010-09-21 21:28:23 +0000255 _LIBCPP_INLINE_VISIBILITY explicit __nested(const _Tp& __t) : _Tp(__t) {}
Howard Hinnante4f92722010-05-27 17:06:52 +0000256};
257
Howard Hinnant72f73582010-08-11 17:04:31 +0000258#ifndef _LIBCPP_NO_EXCEPTIONS
Marshall Clowb1cf5a92017-04-13 14:41:45 +0000259template <class _Tp, class _Up, bool>
260struct __throw_with_nested;
261
262template <class _Tp, class _Up>
263struct __throw_with_nested<_Tp, _Up, true> {
Louis Dionne16fe2952018-07-11 23:14:33 +0000264 _LIBCPP_NORETURN static inline _LIBCPP_INLINE_VISIBILITY void
Marshall Clowb1cf5a92017-04-13 14:41:45 +0000265 __do_throw(_Tp&& __t)
Marshall Clowb1cf5a92017-04-13 14:41:45 +0000266 {
267 throw __nested<_Up>(_VSTD::forward<_Tp>(__t));
268 }
269};
270
271template <class _Tp, class _Up>
272struct __throw_with_nested<_Tp, _Up, false> {
Louis Dionne16fe2952018-07-11 23:14:33 +0000273 _LIBCPP_NORETURN static inline _LIBCPP_INLINE_VISIBILITY void
Eric Fiselier58e1c912017-04-19 01:35:58 +0000274#ifndef _LIBCPP_CXX03_LANG
Marshall Clowb1cf5a92017-04-13 14:41:45 +0000275 __do_throw(_Tp&& __t)
Eric Fiselier58e1c912017-04-19 01:35:58 +0000276#else
Marshall Clowb1cf5a92017-04-13 14:41:45 +0000277 __do_throw (_Tp& __t)
Eric Fiselier58e1c912017-04-19 01:35:58 +0000278#endif // _LIBCPP_CXX03_LANG
Marshall Clowb1cf5a92017-04-13 14:41:45 +0000279 {
280 throw _VSTD::forward<_Tp>(__t);
281 }
282};
Howard Hinnant72f73582010-08-11 17:04:31 +0000283#endif
Howard Hinnante4f92722010-05-27 17:06:52 +0000284
285template <class _Tp>
Richard Smithcabd3922012-07-26 02:04:22 +0000286_LIBCPP_NORETURN
Howard Hinnant3b6579a2010-08-22 00:02:43 +0000287void
Marshall Clowb1cf5a92017-04-13 14:41:45 +0000288throw_with_nested(_Tp&& __t)
Howard Hinnante4f92722010-05-27 17:06:52 +0000289{
Howard Hinnant72f73582010-08-11 17:04:31 +0000290#ifndef _LIBCPP_NO_EXCEPTIONS
Marshall Clow94a38502017-04-13 16:57:42 +0000291 typedef typename decay<_Tp>::type _Up;
292 static_assert( is_copy_constructible<_Up>::value, "type thrown must be CopyConstructible");
Marshall Clowb1cf5a92017-04-13 14:41:45 +0000293 __throw_with_nested<_Tp, _Up,
294 is_class<_Up>::value &&
295 !is_base_of<nested_exception, _Up>::value &&
296 !__libcpp_is_final<_Up>::value>::
297 __do_throw(_VSTD::forward<_Tp>(__t));
Eric Fiselier6003c772016-12-23 23:37:52 +0000298#else
299 ((void)__t);
300 // FIXME: Make this abort
Howard Hinnant72f73582010-08-11 17:04:31 +0000301#endif
Howard Hinnante4f92722010-05-27 17:06:52 +0000302}
303
Marshall Clowb75c89c2017-03-14 17:08:47 +0000304template <class _From, class _To>
305struct __can_dynamic_cast : public _LIBCPP_BOOL_CONSTANT(
306 is_polymorphic<_From>::value &&
307 (!is_base_of<_To, _From>::value ||
308 is_convertible<const _From*, const _To*>::value)) {};
309
Howard Hinnantc834c512011-11-29 18:15:50 +0000310template <class _Ep>
Howard Hinnant874ad9a2010-09-21 21:28:23 +0000311inline _LIBCPP_INLINE_VISIBILITY
Howard Hinnante4f92722010-05-27 17:06:52 +0000312void
Marshall Clowb75c89c2017-03-14 17:08:47 +0000313rethrow_if_nested(const _Ep& __e,
314 typename enable_if< __can_dynamic_cast<_Ep, nested_exception>::value>::type* = 0)
Howard Hinnante4f92722010-05-27 17:06:52 +0000315{
Marshall Clowe993abe2015-12-14 18:01:56 +0000316 const nested_exception* __nep = dynamic_cast<const nested_exception*>(_VSTD::addressof(__e));
Howard Hinnant3615a192010-05-28 13:35:41 +0000317 if (__nep)
318 __nep->rethrow_nested();
Howard Hinnante4f92722010-05-27 17:06:52 +0000319}
320
Howard Hinnantc834c512011-11-29 18:15:50 +0000321template <class _Ep>
Howard Hinnant874ad9a2010-09-21 21:28:23 +0000322inline _LIBCPP_INLINE_VISIBILITY
Howard Hinnante4f92722010-05-27 17:06:52 +0000323void
Marshall Clowb75c89c2017-03-14 17:08:47 +0000324rethrow_if_nested(const _Ep&,
325 typename enable_if<!__can_dynamic_cast<_Ep, nested_exception>::value>::type* = 0)
Howard Hinnante4f92722010-05-27 17:06:52 +0000326{
327}
328
Howard Hinnantc51e1022010-05-11 19:42:16 +0000329} // std
330
Howard Hinnantc51e1022010-05-11 19:42:16 +0000331#endif // _LIBCPP_EXCEPTION