blob: a668539be89949a37fbfc1a3bec233ddf9a7758c [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>
Louis Dionne73912b22020-11-04 15:01:25 -050080#include <__availability>
Howard Hinnantc51e1022010-05-11 19:42:16 +000081#include <cstddef>
Eric Fiselieraae1ccf2016-12-03 03:22:11 +000082#include <cstdlib>
Howard Hinnante4f92722010-05-27 17:06:52 +000083#include <type_traits>
Marshall Clow0a1e7502018-09-12 19:41:40 +000084#include <version>
Howard Hinnantc51e1022010-05-11 19:42:16 +000085
Eric Fiselier85f66332019-03-05 01:57:01 +000086#if defined(_LIBCPP_ABI_VCRUNTIME)
Eric Fiselierec3a1672017-02-10 08:57:35 +000087#include <vcruntime_exception.h>
88#endif
89
Howard Hinnantaaaa52b2011-10-17 20:05:10 +000090#if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
Howard Hinnantc51e1022010-05-11 19:42:16 +000091#pragma GCC system_header
Howard Hinnantaaaa52b2011-10-17 20:05:10 +000092#endif
Howard Hinnantc51e1022010-05-11 19:42:16 +000093
94namespace std // purposefully not using versioning namespace
95{
96
Eric Fiselier85f66332019-03-05 01:57:01 +000097#if !defined(_LIBCPP_ABI_VCRUNTIME)
Howard Hinnantc51e1022010-05-11 19:42:16 +000098class _LIBCPP_EXCEPTION_ABI exception
99{
100public:
Howard Hinnant1bc52cf2011-05-26 18:23:59 +0000101 _LIBCPP_INLINE_VISIBILITY exception() _NOEXCEPT {}
Dimitry Andric47269ce2020-03-13 19:36:26 +0100102 _LIBCPP_INLINE_VISIBILITY exception(const exception&) _NOEXCEPT = default;
103
Howard Hinnant1bc52cf2011-05-26 18:23:59 +0000104 virtual ~exception() _NOEXCEPT;
105 virtual const char* what() const _NOEXCEPT;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000106};
107
108class _LIBCPP_EXCEPTION_ABI bad_exception
109 : public exception
110{
111public:
Howard Hinnant1bc52cf2011-05-26 18:23:59 +0000112 _LIBCPP_INLINE_VISIBILITY bad_exception() _NOEXCEPT {}
113 virtual ~bad_exception() _NOEXCEPT;
114 virtual const char* what() const _NOEXCEPT;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000115};
Eric Fiselier85f66332019-03-05 01:57:01 +0000116#endif // !_LIBCPP_ABI_VCRUNTIME
Howard Hinnantc51e1022010-05-11 19:42:16 +0000117
Eric Fiselierddd77792017-02-17 03:25:08 +0000118#if _LIBCPP_STD_VER <= 14 \
119 || defined(_LIBCPP_ENABLE_CXX17_REMOVED_UNEXPECTED_FUNCTIONS) \
120 || defined(_LIBCPP_BUILDING_LIBRARY)
Howard Hinnantc51e1022010-05-11 19:42:16 +0000121typedef void (*unexpected_handler)();
Howard Hinnant8331b762013-03-06 23:30:19 +0000122_LIBCPP_FUNC_VIS unexpected_handler set_unexpected(unexpected_handler) _NOEXCEPT;
123_LIBCPP_FUNC_VIS unexpected_handler get_unexpected() _NOEXCEPT;
124_LIBCPP_NORETURN _LIBCPP_FUNC_VIS void unexpected();
Eric Fiselierddd77792017-02-17 03:25:08 +0000125#endif
Howard Hinnantc51e1022010-05-11 19:42:16 +0000126
127typedef void (*terminate_handler)();
Howard Hinnant8331b762013-03-06 23:30:19 +0000128_LIBCPP_FUNC_VIS terminate_handler set_terminate(terminate_handler) _NOEXCEPT;
129_LIBCPP_FUNC_VIS terminate_handler get_terminate() _NOEXCEPT;
130_LIBCPP_NORETURN _LIBCPP_FUNC_VIS void terminate() _NOEXCEPT;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000131
Howard Hinnant8331b762013-03-06 23:30:19 +0000132_LIBCPP_FUNC_VIS bool uncaught_exception() _NOEXCEPT;
Mehdi Amini228053d2017-05-04 17:08:54 +0000133_LIBCPP_FUNC_VIS _LIBCPP_AVAILABILITY_UNCAUGHT_EXCEPTIONS int uncaught_exceptions() _NOEXCEPT;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000134
Howard Hinnant8331b762013-03-06 23:30:19 +0000135class _LIBCPP_TYPE_VIS exception_ptr;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000136
Howard Hinnanta37d3cf2013-08-12 18:38:34 +0000137_LIBCPP_FUNC_VIS exception_ptr current_exception() _NOEXCEPT;
138_LIBCPP_NORETURN _LIBCPP_FUNC_VIS void rethrow_exception(exception_ptr);
Howard Hinnantc51e1022010-05-11 19:42:16 +0000139
Eric Fiselier94ef6cc2017-05-08 01:17:50 +0000140#ifndef _LIBCPP_ABI_MICROSOFT
141
Howard Hinnant8331b762013-03-06 23:30:19 +0000142class _LIBCPP_TYPE_VIS exception_ptr
Howard Hinnantc51e1022010-05-11 19:42:16 +0000143{
144 void* __ptr_;
145public:
Howard Hinnant1bc52cf2011-05-26 18:23:59 +0000146 _LIBCPP_INLINE_VISIBILITY exception_ptr() _NOEXCEPT : __ptr_() {}
147 _LIBCPP_INLINE_VISIBILITY exception_ptr(nullptr_t) _NOEXCEPT : __ptr_() {}
Eric Fiselier94ef6cc2017-05-08 01:17:50 +0000148
Howard Hinnant1bc52cf2011-05-26 18:23:59 +0000149 exception_ptr(const exception_ptr&) _NOEXCEPT;
150 exception_ptr& operator=(const exception_ptr&) _NOEXCEPT;
151 ~exception_ptr() _NOEXCEPT;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000152
Eric Fiselier94ef6cc2017-05-08 01:17:50 +0000153 _LIBCPP_INLINE_VISIBILITY _LIBCPP_EXPLICIT operator bool() const _NOEXCEPT
154 {return __ptr_ != nullptr;}
Howard Hinnantc51e1022010-05-11 19:42:16 +0000155
Howard Hinnant874ad9a2010-09-21 21:28:23 +0000156 friend _LIBCPP_INLINE_VISIBILITY
Howard Hinnant1bc52cf2011-05-26 18:23:59 +0000157 bool operator==(const exception_ptr& __x, const exception_ptr& __y) _NOEXCEPT
Howard Hinnantc51e1022010-05-11 19:42:16 +0000158 {return __x.__ptr_ == __y.__ptr_;}
Eric Fiselier94ef6cc2017-05-08 01:17:50 +0000159
Howard Hinnant874ad9a2010-09-21 21:28:23 +0000160 friend _LIBCPP_INLINE_VISIBILITY
Howard Hinnant1bc52cf2011-05-26 18:23:59 +0000161 bool operator!=(const exception_ptr& __x, const exception_ptr& __y) _NOEXCEPT
Howard Hinnantc51e1022010-05-11 19:42:16 +0000162 {return !(__x == __y);}
163
Howard Hinnanta37d3cf2013-08-12 18:38:34 +0000164 friend _LIBCPP_FUNC_VIS exception_ptr current_exception() _NOEXCEPT;
165 friend _LIBCPP_FUNC_VIS void rethrow_exception(exception_ptr);
Howard Hinnantc51e1022010-05-11 19:42:16 +0000166};
167
Howard Hinnantc834c512011-11-29 18:15:50 +0000168template<class _Ep>
Louis Dionnecdc41112018-11-21 17:00:52 +0000169_LIBCPP_INLINE_VISIBILITY exception_ptr
Howard Hinnantc834c512011-11-29 18:15:50 +0000170make_exception_ptr(_Ep __e) _NOEXCEPT
Howard Hinnantc51e1022010-05-11 19:42:16 +0000171{
Howard Hinnant72f73582010-08-11 17:04:31 +0000172#ifndef _LIBCPP_NO_EXCEPTIONS
Howard Hinnantc51e1022010-05-11 19:42:16 +0000173 try
174 {
175 throw __e;
176 }
177 catch (...)
178 {
179 return current_exception();
180 }
Eric Fiselieraae1ccf2016-12-03 03:22:11 +0000181#else
Eric Fiselier6003c772016-12-23 23:37:52 +0000182 ((void)__e);
Eric Fiselieraae1ccf2016-12-03 03:22:11 +0000183 _VSTD::abort();
184#endif
Howard Hinnantc51e1022010-05-11 19:42:16 +0000185}
186
Eric Fiselier94ef6cc2017-05-08 01:17:50 +0000187#else // _LIBCPP_ABI_MICROSOFT
188
189class _LIBCPP_TYPE_VIS exception_ptr
190{
191#if defined(__clang__)
192#pragma clang diagnostic push
193#pragma clang diagnostic ignored "-Wunused-private-field"
194#endif
195 void* __ptr1_;
196 void* __ptr2_;
197#if defined(__clang__)
198#pragma clang diagnostic pop
199#endif
200public:
201 exception_ptr() _NOEXCEPT;
202 exception_ptr(nullptr_t) _NOEXCEPT;
203 exception_ptr(const exception_ptr& __other) _NOEXCEPT;
204 exception_ptr& operator=(const exception_ptr& __other) _NOEXCEPT;
205 exception_ptr& operator=(nullptr_t) _NOEXCEPT;
206 ~exception_ptr() _NOEXCEPT;
207 _LIBCPP_EXPLICIT operator bool() const _NOEXCEPT;
208};
209
210_LIBCPP_FUNC_VIS
211bool operator==(const exception_ptr& __x, const exception_ptr& __y) _NOEXCEPT;
212
213inline _LIBCPP_INLINE_VISIBILITY
214bool operator!=(const exception_ptr& __x, const exception_ptr& __y) _NOEXCEPT
215 {return !(__x == __y);}
216
217_LIBCPP_FUNC_VIS void swap(exception_ptr&, exception_ptr&) _NOEXCEPT;
218
219_LIBCPP_FUNC_VIS exception_ptr __copy_exception_ptr(void *__except, const void* __ptr);
220_LIBCPP_FUNC_VIS exception_ptr current_exception() _NOEXCEPT;
221_LIBCPP_NORETURN _LIBCPP_FUNC_VIS void rethrow_exception(exception_ptr p);
222
223// This is a built-in template function which automagically extracts the required
224// information.
225template <class _E> void *__GetExceptionInfo(_E);
226
227template<class _Ep>
Louis Dionnecdc41112018-11-21 17:00:52 +0000228_LIBCPP_INLINE_VISIBILITY exception_ptr
Eric Fiselier94ef6cc2017-05-08 01:17:50 +0000229make_exception_ptr(_Ep __e) _NOEXCEPT
230{
231 return __copy_exception_ptr(_VSTD::addressof(__e), __GetExceptionInfo(__e));
232}
233
234#endif // _LIBCPP_ABI_MICROSOFT
Howard Hinnante4f92722010-05-27 17:06:52 +0000235// nested_exception
236
237class _LIBCPP_EXCEPTION_ABI nested_exception
238{
239 exception_ptr __ptr_;
240public:
Howard Hinnant1bc52cf2011-05-26 18:23:59 +0000241 nested_exception() _NOEXCEPT;
242// nested_exception(const nested_exception&) noexcept = default;
243// nested_exception& operator=(const nested_exception&) noexcept = default;
244 virtual ~nested_exception() _NOEXCEPT;
Howard Hinnante4f92722010-05-27 17:06:52 +0000245
246 // access functions
Richard Smithcabd3922012-07-26 02:04:22 +0000247 _LIBCPP_NORETURN void rethrow_nested() const;
Howard Hinnant1bc52cf2011-05-26 18:23:59 +0000248 _LIBCPP_INLINE_VISIBILITY exception_ptr nested_ptr() const _NOEXCEPT {return __ptr_;}
Howard Hinnante4f92722010-05-27 17:06:52 +0000249};
250
251template <class _Tp>
252struct __nested
253 : public _Tp,
254 public nested_exception
255{
Howard Hinnant874ad9a2010-09-21 21:28:23 +0000256 _LIBCPP_INLINE_VISIBILITY explicit __nested(const _Tp& __t) : _Tp(__t) {}
Howard Hinnante4f92722010-05-27 17:06:52 +0000257};
258
Howard Hinnant72f73582010-08-11 17:04:31 +0000259#ifndef _LIBCPP_NO_EXCEPTIONS
Marshall Clowb1cf5a92017-04-13 14:41:45 +0000260template <class _Tp, class _Up, bool>
261struct __throw_with_nested;
262
263template <class _Tp, class _Up>
264struct __throw_with_nested<_Tp, _Up, true> {
Louis Dionne16fe2952018-07-11 23:14:33 +0000265 _LIBCPP_NORETURN static inline _LIBCPP_INLINE_VISIBILITY void
Marshall Clowb1cf5a92017-04-13 14:41:45 +0000266 __do_throw(_Tp&& __t)
Marshall Clowb1cf5a92017-04-13 14:41:45 +0000267 {
268 throw __nested<_Up>(_VSTD::forward<_Tp>(__t));
269 }
270};
271
272template <class _Tp, class _Up>
273struct __throw_with_nested<_Tp, _Up, false> {
Louis Dionne16fe2952018-07-11 23:14:33 +0000274 _LIBCPP_NORETURN static inline _LIBCPP_INLINE_VISIBILITY void
Eric Fiselier58e1c912017-04-19 01:35:58 +0000275#ifndef _LIBCPP_CXX03_LANG
Marshall Clowb1cf5a92017-04-13 14:41:45 +0000276 __do_throw(_Tp&& __t)
Eric Fiselier58e1c912017-04-19 01:35:58 +0000277#else
Marshall Clowb1cf5a92017-04-13 14:41:45 +0000278 __do_throw (_Tp& __t)
Eric Fiselier58e1c912017-04-19 01:35:58 +0000279#endif // _LIBCPP_CXX03_LANG
Marshall Clowb1cf5a92017-04-13 14:41:45 +0000280 {
281 throw _VSTD::forward<_Tp>(__t);
282 }
283};
Howard Hinnant72f73582010-08-11 17:04:31 +0000284#endif
Howard Hinnante4f92722010-05-27 17:06:52 +0000285
286template <class _Tp>
Richard Smithcabd3922012-07-26 02:04:22 +0000287_LIBCPP_NORETURN
Howard Hinnant3b6579a2010-08-22 00:02:43 +0000288void
Marshall Clowb1cf5a92017-04-13 14:41:45 +0000289throw_with_nested(_Tp&& __t)
Howard Hinnante4f92722010-05-27 17:06:52 +0000290{
Howard Hinnant72f73582010-08-11 17:04:31 +0000291#ifndef _LIBCPP_NO_EXCEPTIONS
Marshall Clow94a38502017-04-13 16:57:42 +0000292 typedef typename decay<_Tp>::type _Up;
293 static_assert( is_copy_constructible<_Up>::value, "type thrown must be CopyConstructible");
Marshall Clowb1cf5a92017-04-13 14:41:45 +0000294 __throw_with_nested<_Tp, _Up,
295 is_class<_Up>::value &&
296 !is_base_of<nested_exception, _Up>::value &&
297 !__libcpp_is_final<_Up>::value>::
298 __do_throw(_VSTD::forward<_Tp>(__t));
Eric Fiselier6003c772016-12-23 23:37:52 +0000299#else
300 ((void)__t);
301 // FIXME: Make this abort
Howard Hinnant72f73582010-08-11 17:04:31 +0000302#endif
Howard Hinnante4f92722010-05-27 17:06:52 +0000303}
304
Marshall Clowb75c89c2017-03-14 17:08:47 +0000305template <class _From, class _To>
306struct __can_dynamic_cast : public _LIBCPP_BOOL_CONSTANT(
307 is_polymorphic<_From>::value &&
308 (!is_base_of<_To, _From>::value ||
309 is_convertible<const _From*, const _To*>::value)) {};
310
Howard Hinnantc834c512011-11-29 18:15:50 +0000311template <class _Ep>
Howard Hinnant874ad9a2010-09-21 21:28:23 +0000312inline _LIBCPP_INLINE_VISIBILITY
Howard Hinnante4f92722010-05-27 17:06:52 +0000313void
Marshall Clowb75c89c2017-03-14 17:08:47 +0000314rethrow_if_nested(const _Ep& __e,
315 typename enable_if< __can_dynamic_cast<_Ep, nested_exception>::value>::type* = 0)
Howard Hinnante4f92722010-05-27 17:06:52 +0000316{
Marshall Clowe993abe2015-12-14 18:01:56 +0000317 const nested_exception* __nep = dynamic_cast<const nested_exception*>(_VSTD::addressof(__e));
Howard Hinnant3615a192010-05-28 13:35:41 +0000318 if (__nep)
319 __nep->rethrow_nested();
Howard Hinnante4f92722010-05-27 17:06:52 +0000320}
321
Howard Hinnantc834c512011-11-29 18:15:50 +0000322template <class _Ep>
Howard Hinnant874ad9a2010-09-21 21:28:23 +0000323inline _LIBCPP_INLINE_VISIBILITY
Howard Hinnante4f92722010-05-27 17:06:52 +0000324void
Marshall Clowb75c89c2017-03-14 17:08:47 +0000325rethrow_if_nested(const _Ep&,
326 typename enable_if<!__can_dynamic_cast<_Ep, nested_exception>::value>::type* = 0)
Howard Hinnante4f92722010-05-27 17:06:52 +0000327{
328}
329
Howard Hinnantc51e1022010-05-11 19:42:16 +0000330} // std
331
Howard Hinnantc51e1022010-05-11 19:42:16 +0000332#endif // _LIBCPP_EXCEPTION