blob: b7a33d716c4328a7c6c1eb10960aea0fe1224def [file] [log] [blame]
Marshall Clowe0252022011-07-20 15:04:39 +00001//===------------------------- cxa_exception.cpp --------------------------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is dual licensed under the MIT and the University of Illinois Open
6// Source Licenses. See LICENSE.TXT for details.
7//
8//
9// This file implements the "Exception Handling APIs"
Jonathan Roelofsa49ff1d2014-02-12 04:49:09 +000010// http://mentorembedded.github.io/cxx-abi/abi-eh.html
Marshall Clowe0252022011-07-20 15:04:39 +000011//
12//===----------------------------------------------------------------------===//
13
Jonathan Roelofsf82302a2014-05-06 21:30:56 +000014#include "config.h"
Marshall Clowe0252022011-07-20 15:04:39 +000015#include "cxxabi.h"
16
17#include <exception> // for std::terminate
18#include <cstdlib> // for malloc, free
Howard Hinnant9071fe32013-06-17 18:10:34 +000019#include <cstring> // for memset
Jonathan Roelofsaf6a31c2014-09-05 17:46:40 +000020#if !LIBCXXABI_HAS_NO_THREADS
Jonathan Roelofsf82302a2014-05-06 21:30:56 +000021# include <pthread.h> // for fallback_malloc.ipp's mutexes
22#endif
Marshall Clowe0252022011-07-20 15:04:39 +000023#include "cxa_exception.hpp"
Howard Hinnantb80931e2011-12-07 21:16:40 +000024#include "cxa_handlers.hpp"
Marshall Clowe0252022011-07-20 15:04:39 +000025
Howard Hinnant7f476b42012-01-22 19:14:27 +000026// +---------------------------+-----------------------------+---------------+
27// | __cxa_exception | _Unwind_Exception CLNGC++\0 | thrown object |
28// +---------------------------+-----------------------------+---------------+
29// ^
30// |
31// +-------------------------------------------------------+
32// |
33// +---------------------------+-----------------------------+
34// | __cxa_dependent_exception | _Unwind_Exception CLNGC++\1 |
35// +---------------------------+-----------------------------+
36
Marshall Clowe0252022011-07-20 15:04:39 +000037namespace __cxxabiv1 {
Howard Hinnantb94f2252012-01-24 18:15:20 +000038
Howard Hinnant8ee279b2012-02-02 20:47:28 +000039#pragma GCC visibility push(default)
40
Marshall Clowe0252022011-07-20 15:04:39 +000041// Utility routines
Howard Hinnant7f476b42012-01-22 19:14:27 +000042static
43inline
44__cxa_exception*
Howard Hinnantb50cda72012-01-30 16:07:00 +000045cxa_exception_from_thrown_object(void* thrown_object)
Howard Hinnant7f476b42012-01-22 19:14:27 +000046{
47 return static_cast<__cxa_exception*>(thrown_object) - 1;
Marshall Clowfb69a8b2011-08-15 18:06:47 +000048}
Marshall Clowe0252022011-07-20 15:04:39 +000049
Howard Hinnant7f476b42012-01-22 19:14:27 +000050// Note: This is never called when exception_header is masquerading as a
51// __cxa_dependent_exception.
52static
53inline
54void*
Howard Hinnantb50cda72012-01-30 16:07:00 +000055thrown_object_from_cxa_exception(__cxa_exception* exception_header)
Howard Hinnant7f476b42012-01-22 19:14:27 +000056{
57 return static_cast<void*>(exception_header + 1);
Marshall Clowfb69a8b2011-08-15 18:06:47 +000058}
Marshall Clowe0252022011-07-20 15:04:39 +000059
Marshall Clow3c54f1b2011-08-09 15:09:41 +000060// Get the exception object from the unwind pointer.
61// Relies on the structure layout, where the unwind pointer is right in
62// front of the user's exception object
Howard Hinnant7f476b42012-01-22 19:14:27 +000063static
64inline
65__cxa_exception*
Howard Hinnantb50cda72012-01-30 16:07:00 +000066cxa_exception_from_exception_unwind_exception(_Unwind_Exception* unwind_exception)
Howard Hinnant7f476b42012-01-22 19:14:27 +000067{
68 return cxa_exception_from_thrown_object(unwind_exception + 1 );
Marshall Clowfb69a8b2011-08-15 18:06:47 +000069}
Marshall Clow3c54f1b2011-08-09 15:09:41 +000070
Howard Hinnant7f476b42012-01-22 19:14:27 +000071static
72inline
73size_t
Howard Hinnantb50cda72012-01-30 16:07:00 +000074cxa_exception_size_from_exception_thrown_size(size_t size)
Howard Hinnant7f476b42012-01-22 19:14:27 +000075{
76 return size + sizeof (__cxa_exception);
Marshall Clowfb69a8b2011-08-15 18:06:47 +000077}
Marshall Clow3c54f1b2011-08-09 15:09:41 +000078
Howard Hinnantb50cda72012-01-30 16:07:00 +000079static void setExceptionClass(_Unwind_Exception* unwind_exception) {
Howard Hinnant7f476b42012-01-22 19:14:27 +000080 unwind_exception->exception_class = kOurExceptionClass;
81}
82
Howard Hinnantb50cda72012-01-30 16:07:00 +000083static void setDependentExceptionClass(_Unwind_Exception* unwind_exception) {
Howard Hinnant7f476b42012-01-22 19:14:27 +000084 unwind_exception->exception_class = kOurDependentExceptionClass;
Marshall Clowfb69a8b2011-08-15 18:06:47 +000085}
Marshall Clow3c54f1b2011-08-09 15:09:41 +000086
87// Is it one of ours?
Howard Hinnantb50cda72012-01-30 16:07:00 +000088static bool isOurExceptionClass(const _Unwind_Exception* unwind_exception) {
Howard Hinnant1f5bb2c2012-02-01 18:15:15 +000089 return (unwind_exception->exception_class & get_vendor_and_language) ==
90 (kOurExceptionClass & get_vendor_and_language);
Marshall Clowfb69a8b2011-08-15 18:06:47 +000091}
Marshall Clow3c54f1b2011-08-09 15:09:41 +000092
Howard Hinnantb50cda72012-01-30 16:07:00 +000093static bool isDependentException(_Unwind_Exception* unwind_exception) {
Howard Hinnant7f476b42012-01-22 19:14:27 +000094 return (unwind_exception->exception_class & 0xFF) == 0x01;
Marshall Clowfb69a8b2011-08-15 18:06:47 +000095}
96
Howard Hinnanta6baba12011-12-08 19:35:18 +000097// This does not need to be atomic
Howard Hinnantb50cda72012-01-30 16:07:00 +000098static inline int incrementHandlerCount(__cxa_exception *exception) {
Howard Hinnanta6baba12011-12-08 19:35:18 +000099 return ++exception->handlerCount;
Marshall Clowfb69a8b2011-08-15 18:06:47 +0000100}
101
Howard Hinnanta6baba12011-12-08 19:35:18 +0000102// This does not need to be atomic
Howard Hinnantb50cda72012-01-30 16:07:00 +0000103static inline int decrementHandlerCount(__cxa_exception *exception) {
Howard Hinnanta6baba12011-12-08 19:35:18 +0000104 return --exception->handlerCount;
Marshall Clowfb69a8b2011-08-15 18:06:47 +0000105}
Marshall Clow3c54f1b2011-08-09 15:09:41 +0000106
Howard Hinnantf46a3f82012-01-24 21:41:27 +0000107#include "fallback_malloc.ipp"
Marshall Clowe0252022011-07-20 15:04:39 +0000108
109// Allocate some memory from _somewhere_
Howard Hinnantb50cda72012-01-30 16:07:00 +0000110static void *do_malloc(size_t size) {
Marshall Clowfb69a8b2011-08-15 18:06:47 +0000111 void *ptr = std::malloc(size);
112 if (NULL == ptr) // if malloc fails, fall back to emergency stash
113 ptr = fallback_malloc(size);
Marshall Clowe0252022011-07-20 15:04:39 +0000114 return ptr;
Marshall Clowfb69a8b2011-08-15 18:06:47 +0000115}
Marshall Clowe0252022011-07-20 15:04:39 +0000116
Howard Hinnantb50cda72012-01-30 16:07:00 +0000117static void do_free(void *ptr) {
Howard Hinnant7f476b42012-01-22 19:14:27 +0000118 is_fallback_ptr(ptr) ? fallback_free(ptr) : std::free(ptr);
Marshall Clowfb69a8b2011-08-15 18:06:47 +0000119}
Marshall Clowe0252022011-07-20 15:04:39 +0000120
Howard Hinnantb80931e2011-12-07 21:16:40 +0000121/*
Marshall Clow3c54f1b2011-08-09 15:09:41 +0000122 If reason isn't _URC_FOREIGN_EXCEPTION_CAUGHT, then the terminateHandler
123 stored in exc is called. Otherwise the exceptionDestructor stored in
124 exc is called, and then the memory for the exception is deallocated.
Howard Hinnant7f476b42012-01-22 19:14:27 +0000125
126 This is never called for a __cxa_dependent_exception.
Marshall Clow3c54f1b2011-08-09 15:09:41 +0000127*/
Howard Hinnant7f476b42012-01-22 19:14:27 +0000128static
129void
130exception_cleanup_func(_Unwind_Reason_Code reason, _Unwind_Exception* unwind_exception)
131{
132 __cxa_exception* exception_header = cxa_exception_from_exception_unwind_exception(unwind_exception);
Marshall Clowfb69a8b2011-08-15 18:06:47 +0000133 if (_URC_FOREIGN_EXCEPTION_CAUGHT != reason)
Howard Hinnant7f476b42012-01-22 19:14:27 +0000134 std::__terminate(exception_header->terminateHandler);
Howard Hinnantbe01d952012-02-01 18:44:21 +0000135 // Just in case there exists a dependent exception that is pointing to this,
136 // check the reference count and only destroy this if that count goes to zero.
137 __cxa_decrement_exception_refcount(unwind_exception + 1);
Marshall Clowfb69a8b2011-08-15 18:06:47 +0000138}
Marshall Clow3c54f1b2011-08-09 15:09:41 +0000139
Howard Hinnantb50cda72012-01-30 16:07:00 +0000140static LIBCXXABI_NORETURN void failed_throw(__cxa_exception* exception_header) {
Marshall Clow3c54f1b2011-08-09 15:09:41 +0000141// Section 2.5.3 says:
142// * For purposes of this ABI, several things are considered exception handlers:
143// ** A terminate() call due to a throw.
144// and
145// * Upon entry, Following initialization of the catch parameter,
146// a handler must call:
Marshall Clowfb69a8b2011-08-15 18:06:47 +0000147// * void *__cxa_begin_catch(void *exceptionObject );
Howard Hinnant7f476b42012-01-22 19:14:27 +0000148 (void) __cxa_begin_catch(&exception_header->unwindHeader);
149 std::__terminate(exception_header->terminateHandler);
Marshall Clowfb69a8b2011-08-15 18:06:47 +0000150}
Marshall Clowe0252022011-07-20 15:04:39 +0000151
152extern "C" {
153
154// Allocate a __cxa_exception object, and zero-fill it.
155// Reserve "thrown_size" bytes on the end for the user's exception
156// object. Zero-fill the object. If memory can't be allocated, call
157// std::terminate. Return a pointer to the memory to be used for the
158// user's exception object.
Howard Hinnantb50cda72012-01-30 16:07:00 +0000159void * __cxa_allocate_exception (size_t thrown_size) throw() {
Howard Hinnant7f476b42012-01-22 19:14:27 +0000160 size_t actual_size = cxa_exception_size_from_exception_thrown_size(thrown_size);
161 __cxa_exception* exception_header = static_cast<__cxa_exception*>(do_malloc(actual_size));
162 if (NULL == exception_header)
Marshall Clowfb69a8b2011-08-15 18:06:47 +0000163 std::terminate();
Howard Hinnant7f476b42012-01-22 19:14:27 +0000164 std::memset(exception_header, 0, actual_size);
165 return thrown_object_from_cxa_exception(exception_header);
Marshall Clowfb69a8b2011-08-15 18:06:47 +0000166}
Marshall Clowe0252022011-07-20 15:04:39 +0000167
168
169// Free a __cxa_exception object allocated with __cxa_allocate_exception.
Howard Hinnantb50cda72012-01-30 16:07:00 +0000170void __cxa_free_exception (void * thrown_object) throw() {
Howard Hinnant7f476b42012-01-22 19:14:27 +0000171 do_free(cxa_exception_from_thrown_object(thrown_object));
Marshall Clowfb69a8b2011-08-15 18:06:47 +0000172}
Marshall Clowe0252022011-07-20 15:04:39 +0000173
174
175// This function shall allocate a __cxa_dependent_exception and
176// return a pointer to it. (Really to the object, not past its' end).
177// Otherwise, it will work like __cxa_allocate_exception.
Howard Hinnantb50cda72012-01-30 16:07:00 +0000178void * __cxa_allocate_dependent_exception () {
Marshall Clowfb69a8b2011-08-15 18:06:47 +0000179 size_t actual_size = sizeof(__cxa_dependent_exception);
180 void *ptr = do_malloc(actual_size);
181 if (NULL == ptr)
182 std::terminate();
183 std::memset(ptr, 0, actual_size);
Marshall Clowe0252022011-07-20 15:04:39 +0000184 return ptr;
Marshall Clowfb69a8b2011-08-15 18:06:47 +0000185}
Marshall Clowe0252022011-07-20 15:04:39 +0000186
187
188// This function shall free a dependent_exception.
189// It does not affect the reference count of the primary exception.
Howard Hinnantb50cda72012-01-30 16:07:00 +0000190void __cxa_free_dependent_exception (void * dependent_exception) {
Marshall Clowfb69a8b2011-08-15 18:06:47 +0000191 do_free(dependent_exception);
192}
Marshall Clowe0252022011-07-20 15:04:39 +0000193
Marshall Clow3c54f1b2011-08-09 15:09:41 +0000194
195// 2.4.3 Throwing the Exception Object
196/*
197After constructing the exception object with the throw argument value,
198the generated code calls the __cxa_throw runtime library routine. This
199routine never returns.
200
201The __cxa_throw routine will do the following:
202
203* Obtain the __cxa_exception header from the thrown exception object address,
204which can be computed as follows:
205 __cxa_exception *header = ((__cxa_exception *) thrown_exception - 1);
206* Save the current unexpected_handler and terminate_handler in the __cxa_exception header.
207* Save the tinfo and dest arguments in the __cxa_exception header.
208* Set the exception_class field in the unwind header. This is a 64-bit value
209representing the ASCII string "XXXXC++\0", where "XXXX" is a
210vendor-dependent string. That is, for implementations conforming to this
211ABI, the low-order 4 bytes of this 64-bit value will be "C++\0".
212* Increment the uncaught_exception flag.
213* Call _Unwind_RaiseException in the system unwind library, Its argument is the
214pointer to the thrown exception, which __cxa_throw itself received as an argument.
215__Unwind_RaiseException begins the process of stack unwinding, described
216in Section 2.5. In special cases, such as an inability to find a
217handler, _Unwind_RaiseException may return. In that case, __cxa_throw
218will call terminate, assuming that there was no handler for the
219exception.
220*/
Howard Hinnant7f476b42012-01-22 19:14:27 +0000221LIBCXXABI_NORETURN
222void
223__cxa_throw(void* thrown_object, std::type_info* tinfo, void (*dest)(void*))
224{
Marshall Clowfb69a8b2011-08-15 18:06:47 +0000225 __cxa_eh_globals *globals = __cxa_get_globals();
Howard Hinnant7f476b42012-01-22 19:14:27 +0000226 __cxa_exception* exception_header = cxa_exception_from_thrown_object(thrown_object);
Howard Hinnanta6baba12011-12-08 19:35:18 +0000227
Howard Hinnant7f476b42012-01-22 19:14:27 +0000228 exception_header->unexpectedHandler = std::get_unexpected();
229 exception_header->terminateHandler = std::get_terminate();
230 exception_header->exceptionType = tinfo;
231 exception_header->exceptionDestructor = dest;
232 setExceptionClass(&exception_header->unwindHeader);
233 exception_header->referenceCount = 1; // This is a newly allocated exception, no need for thread safety.
Marshall Clow3c54f1b2011-08-09 15:09:41 +0000234 globals->uncaughtExceptions += 1; // Not atomically, since globals are thread-local
235
Howard Hinnant7f476b42012-01-22 19:14:27 +0000236 exception_header->unwindHeader.exception_cleanup = exception_cleanup_func;
Dan Albert610cde12015-02-05 01:33:15 +0000237#ifdef __USING_SJLJ_EXCEPTIONS__
Howard Hinnant7f476b42012-01-22 19:14:27 +0000238 _Unwind_SjLj_RaiseException(&exception_header->unwindHeader);
Howard Hinnanta6baba12011-12-08 19:35:18 +0000239#else
Howard Hinnant7f476b42012-01-22 19:14:27 +0000240 _Unwind_RaiseException(&exception_header->unwindHeader);
Howard Hinnanta6baba12011-12-08 19:35:18 +0000241#endif
Howard Hinnantcbe4c6d2012-01-28 00:34:46 +0000242 // This only happens when there is no handler, or some unexpected unwinding
243 // error happens.
Howard Hinnant7f476b42012-01-22 19:14:27 +0000244 failed_throw(exception_header);
Marshall Clowfb69a8b2011-08-15 18:06:47 +0000245}
Marshall Clow3c54f1b2011-08-09 15:09:41 +0000246
247
248// 2.5.3 Exception Handlers
Howard Hinnant7f476b42012-01-22 19:14:27 +0000249/*
250The adjusted pointer is computed by the personality routine during phase 1
251 and saved in the exception header (either __cxa_exception or
252 __cxa_dependent_exception).
Howard Hinnantb50cda72012-01-30 16:07:00 +0000253
254 Requires: exception is native
Howard Hinnant7f476b42012-01-22 19:14:27 +0000255*/
256void*
Howard Hinnantb50cda72012-01-30 16:07:00 +0000257__cxa_get_exception_ptr(void* unwind_exception) throw()
Howard Hinnant7f476b42012-01-22 19:14:27 +0000258{
Logan Chien30a5e882014-05-10 00:42:10 +0000259#if LIBCXXABI_ARM_EHABI
260 return reinterpret_cast<void*>(
Dan Albert135a4f82015-02-05 23:48:06 +0000261 static_cast<_Unwind_Control_Block*>(unwind_exception)->barrier_cache.bitpattern[0]);
Logan Chien30a5e882014-05-10 00:42:10 +0000262#else
Dan Albert135a4f82015-02-05 23:48:06 +0000263 return cxa_exception_from_exception_unwind_exception(
264 static_cast<_Unwind_Exception*>(unwind_exception))->adjustedPtr;
Logan Chien30a5e882014-05-10 00:42:10 +0000265#endif
Marshall Clowfb69a8b2011-08-15 18:06:47 +0000266}
Logan Chien30a5e882014-05-10 00:42:10 +0000267
268#if LIBCXXABI_ARM_EHABI
269/*
270The routine to be called before the cleanup. This will save __cxa_exception in
271__cxa_eh_globals, so that __cxa_end_cleanup() can recover later.
272*/
273bool
274__cxa_begin_cleanup(void* unwind_arg) throw ()
275{
276 _Unwind_Exception* unwind_exception = static_cast<_Unwind_Exception*>(unwind_arg);
277 __cxa_eh_globals* globals = __cxa_get_globals();
278 __cxa_exception* exception_header =
279 cxa_exception_from_exception_unwind_exception(unwind_exception);
280
281 if (isOurExceptionClass(unwind_exception))
282 {
283 if (0 == exception_header->propagationCount)
284 {
285 exception_header->nextPropagatingException = globals->propagatingExceptions;
286 globals->propagatingExceptions = exception_header;
287 }
288 ++exception_header->propagationCount;
289 }
290 else
291 {
292 // If the propagatingExceptions stack is not empty, since we can't
293 // chain the foreign exception, terminate it.
294 if (NULL != globals->propagatingExceptions)
295 std::terminate();
296 globals->propagatingExceptions = exception_header;
297 }
298 return true;
299}
300
301/*
302The routine to be called after the cleanup has been performed. It will get the
303propagating __cxa_exception from __cxa_eh_globals, and continue the stack
304unwinding with _Unwind_Resume.
305
306According to ARM EHABI 8.4.1, __cxa_end_cleanup() should not clobber any
307register, thus we have to write this function in assembly so that we can save
308{r1, r2, r3}. We don't have to save r0 because it is the return value and the
309first argument to _Unwind_Resume(). In addition, we are saving r4 in order to
310align the stack to 16 bytes, even though it is a callee-save register.
311*/
312__attribute__((used)) static _Unwind_Exception *
313__cxa_end_cleanup_impl()
314{
315 __cxa_eh_globals* globals = __cxa_get_globals();
316 __cxa_exception* exception_header = globals->propagatingExceptions;
317 if (NULL == exception_header)
318 {
319 // It seems that __cxa_begin_cleanup() is not called properly.
320 // We have no choice but terminate the program now.
321 std::terminate();
322 }
323
324 if (isOurExceptionClass(&exception_header->unwindHeader))
325 {
326 --exception_header->propagationCount;
327 if (0 == exception_header->propagationCount)
328 {
329 globals->propagatingExceptions = exception_header->nextPropagatingException;
330 exception_header->nextPropagatingException = NULL;
331 }
332 }
333 else
334 {
335 globals->propagatingExceptions = NULL;
336 }
337 return &exception_header->unwindHeader;
338}
339
340asm (
341 " .pushsection .text.__cxa_end_cleanup\n"
342 " .globl __cxa_end_cleanup\n"
343 " .type __cxa_end_cleanup,%function\n"
344 "__cxa_end_cleanup:\n"
345 " push {r1, r2, r3, r4}\n"
346 " bl __cxa_end_cleanup_impl\n"
347 " pop {r1, r2, r3, r4}\n"
348 " bl _Unwind_Resume\n"
349 " bl abort\n"
350 " .popsection"
351);
352#endif // LIBCXXABI_ARM_EHABI
Marshall Clow3c54f1b2011-08-09 15:09:41 +0000353
Marshall Clow3c54f1b2011-08-09 15:09:41 +0000354/*
Howard Hinnantb50cda72012-01-30 16:07:00 +0000355This routine can catch foreign or native exceptions. If native, the exception
356can be a primary or dependent variety. This routine may remain blissfully
357ignorant of whether the native exception is primary or dependent.
358
359If the exception is native:
Marshall Clow3c54f1b2011-08-09 15:09:41 +0000360* Increment's the exception's handler count.
Howard Hinnantb50cda72012-01-30 16:07:00 +0000361* Push the exception on the stack of currently-caught exceptions if it is not
362 already there (from a rethrow).
Marshall Clow3c54f1b2011-08-09 15:09:41 +0000363* Decrements the uncaught_exception count.
Howard Hinnantb50cda72012-01-30 16:07:00 +0000364* Returns the adjusted pointer to the exception object, which is stored in
365 the __cxa_exception by the personality routine.
366
367If the exception is foreign, this means it did not originate from one of throw
368routines. The foreign exception does not necessarily have a __cxa_exception
369header. However we can catch it here with a catch (...), or with a call
370to terminate or unexpected during unwinding.
371* Do not try to increment the exception's handler count, we don't know where
372 it is.
373* Push the exception on the stack of currently-caught exceptions only if the
374 stack is empty. The foreign exception has no way to link to the current
375 top of stack. If the stack is not empty, call terminate. Even with an
376 empty stack, this is hacked in by pushing a pointer to an imaginary
377 __cxa_exception block in front of the foreign exception. It would be better
378 if the __cxa_eh_globals structure had a stack of _Unwind_Exception, but it
379 doesn't. It has a stack of __cxa_exception (which has a next* in it).
380* Do not decrement the uncaught_exception count because we didn't increment it
381 in __cxa_throw (or one of our rethrow functions).
382* If we haven't terminated, assume the exception object is just past the
383 _Unwind_Exception and return a pointer to that.
Marshall Clow3c54f1b2011-08-09 15:09:41 +0000384*/
Howard Hinnant7f476b42012-01-22 19:14:27 +0000385void*
Howard Hinnantb50cda72012-01-30 16:07:00 +0000386__cxa_begin_catch(void* unwind_arg) throw()
Howard Hinnant7f476b42012-01-22 19:14:27 +0000387{
Howard Hinnantb50cda72012-01-30 16:07:00 +0000388 _Unwind_Exception* unwind_exception = static_cast<_Unwind_Exception*>(unwind_arg);
389 bool native_exception = isOurExceptionClass(unwind_exception);
390 __cxa_eh_globals* globals = __cxa_get_globals();
391 // exception_header is a hackish offset from a foreign exception, but it
392 // works as long as we're careful not to try to access any __cxa_exception
393 // parts.
Howard Hinnant7f476b42012-01-22 19:14:27 +0000394 __cxa_exception* exception_header =
395 cxa_exception_from_exception_unwind_exception
396 (
397 static_cast<_Unwind_Exception*>(unwind_exception)
398 );
Howard Hinnantb50cda72012-01-30 16:07:00 +0000399 if (native_exception)
400 {
401 // Increment the handler count, removing the flag about being rethrown
402 exception_header->handlerCount = exception_header->handlerCount < 0 ?
403 -exception_header->handlerCount + 1 : exception_header->handlerCount + 1;
404 // place the exception on the top of the stack if it's not already
405 // there by a previous rethrow
406 if (exception_header != globals->caughtExceptions)
407 {
408 exception_header->nextException = globals->caughtExceptions;
409 globals->caughtExceptions = exception_header;
410 }
411 globals->uncaughtExceptions -= 1; // Not atomically, since globals are thread-local
Logan Chien30a5e882014-05-10 00:42:10 +0000412#if LIBCXXABI_ARM_EHABI
413 return reinterpret_cast<void*>(exception_header->unwindHeader.barrier_cache.bitpattern[0]);
414#else
Howard Hinnantb50cda72012-01-30 16:07:00 +0000415 return exception_header->adjustedPtr;
Logan Chien30a5e882014-05-10 00:42:10 +0000416#endif
Marshall Clowfb69a8b2011-08-15 18:06:47 +0000417 }
Howard Hinnantb50cda72012-01-30 16:07:00 +0000418 // Else this is a foreign exception
419 // If the caughtExceptions stack is not empty, terminate
420 if (globals->caughtExceptions != 0)
421 std::terminate();
422 // Push the foreign exception on to the stack
423 globals->caughtExceptions = exception_header;
424 return unwind_exception + 1;
Marshall Clowfb69a8b2011-08-15 18:06:47 +0000425}
Marshall Clow3c54f1b2011-08-09 15:09:41 +0000426
427
428/*
429Upon exit for any reason, a handler must call:
430 void __cxa_end_catch ();
431
Howard Hinnantb50cda72012-01-30 16:07:00 +0000432This routine can be called for either a native or foreign exception.
433For a native exception:
Marshall Clow3c54f1b2011-08-09 15:09:41 +0000434* Locates the most recently caught exception and decrements its handler count.
435* Removes the exception from the caught exception stack, if the handler count goes to zero.
Howard Hinnanta6baba12011-12-08 19:35:18 +0000436* If the handler count goes down to zero, and the exception was not re-thrown
437 by throw, it locates the primary exception (which may be the same as the one
438 it's handling) and decrements its reference count. If that reference count
439 goes to zero, the function destroys the exception. In any case, if the current
440 exception is a dependent exception, it destroys that.
Howard Hinnantb50cda72012-01-30 16:07:00 +0000441
442For a foreign exception:
443* If it has been rethrown, there is nothing to do.
444* Otherwise delete the exception and pop the catch stack to empty.
Marshall Clow3c54f1b2011-08-09 15:09:41 +0000445*/
Howard Hinnantb50cda72012-01-30 16:07:00 +0000446void __cxa_end_catch()
447{
Nico Webercb407bb2014-06-25 23:52:07 +0000448 static_assert(sizeof(__cxa_exception) == sizeof(__cxa_dependent_exception),
449 "sizeof(__cxa_exception) must be equal to "
450 "sizeof(__cxa_dependent_exception)");
451 static_assert(offsetof(__cxa_exception, referenceCount) ==
452 offsetof(__cxa_dependent_exception, primaryException),
453 "the layout of __cxa_exception must match the layout of "
454 "__cxa_dependent_exception");
455 static_assert(offsetof(__cxa_exception, handlerCount) ==
456 offsetof(__cxa_dependent_exception, handlerCount),
457 "the layout of __cxa_exception must match the layout of "
458 "__cxa_dependent_exception");
Howard Hinnantb50cda72012-01-30 16:07:00 +0000459 __cxa_eh_globals* globals = __cxa_get_globals_fast(); // __cxa_get_globals called in __cxa_begin_catch
460 __cxa_exception* exception_header = globals->caughtExceptions;
461 // If we've rethrown a foreign exception, then globals->caughtExceptions
462 // will have been made an empty stack by __cxa_rethrow() and there is
463 // nothing more to be done. Do nothing!
464 if (NULL != exception_header)
465 {
466 bool native_exception = isOurExceptionClass(&exception_header->unwindHeader);
467 if (native_exception)
468 {
469 // This is a native exception
470 if (exception_header->handlerCount < 0)
471 {
472 // The exception has been rethrown by __cxa_rethrow, so don't delete it
473 if (0 == incrementHandlerCount(exception_header))
474 {
475 // Remove from the chain of uncaught exceptions
476 globals->caughtExceptions = exception_header->nextException;
477 // but don't destroy
Howard Hinnanta6baba12011-12-08 19:35:18 +0000478 }
Howard Hinnantb50cda72012-01-30 16:07:00 +0000479 // Keep handlerCount negative in case there are nested catch's
480 // that need to be told that this exception is rethrown. Don't
481 // erase this rethrow flag until the exception is recaught.
482 }
483 else
484 {
485 // The native exception has not been rethrown
486 if (0 == decrementHandlerCount(exception_header))
487 {
488 // Remove from the chain of uncaught exceptions
489 globals->caughtExceptions = exception_header->nextException;
490 // Destroy this exception, being careful to distinguish
491 // between dependent and primary exceptions
492 if (isDependentException(&exception_header->unwindHeader))
493 {
494 // Reset exception_header to primaryException and deallocate the dependent exception
495 __cxa_dependent_exception* dep_exception_header =
496 reinterpret_cast<__cxa_dependent_exception*>(exception_header);
497 exception_header =
498 cxa_exception_from_thrown_object(dep_exception_header->primaryException);
499 __cxa_free_dependent_exception(dep_exception_header);
500 }
501 // Destroy the primary exception only if its referenceCount goes to 0
502 // (this decrement must be atomic)
503 __cxa_decrement_exception_refcount(thrown_object_from_cxa_exception(exception_header));
504 }
Marshall Clowfb69a8b2011-08-15 18:06:47 +0000505 }
506 }
Howard Hinnantb50cda72012-01-30 16:07:00 +0000507 else
508 {
509 // The foreign exception has not been rethrown. Pop the stack
510 // and delete it. If there are nested catch's and they try
511 // to touch a foreign exception in any way, that is undefined
512 // behavior. They likely can't since the only way to catch
513 // a foreign exception is with catch (...)!
514 _Unwind_DeleteException(&globals->caughtExceptions->unwindHeader);
515 globals->caughtExceptions = 0;
516 }
Marshall Clow3c54f1b2011-08-09 15:09:41 +0000517 }
Marshall Clowfb69a8b2011-08-15 18:06:47 +0000518}
Marshall Clow3c54f1b2011-08-09 15:09:41 +0000519
Howard Hinnant7f476b42012-01-22 19:14:27 +0000520// Note: exception_header may be masquerading as a __cxa_dependent_exception
521// and that's ok. exceptionType is there too.
Howard Hinnantb50cda72012-01-30 16:07:00 +0000522// However watch out for foreign exceptions. Return null for them.
Marshall Clow3c54f1b2011-08-09 15:09:41 +0000523std::type_info * __cxa_current_exception_type() {
524// get the current exception
Marshall Clow143cfb02011-12-22 15:45:05 +0000525 __cxa_eh_globals *globals = __cxa_get_globals_fast();
526 if (NULL == globals)
527 return NULL; // If there have never been any exceptions, there are none now.
Howard Hinnant7f476b42012-01-22 19:14:27 +0000528 __cxa_exception *exception_header = globals->caughtExceptions;
529 if (NULL == exception_header)
Marshall Clow3c54f1b2011-08-09 15:09:41 +0000530 return NULL; // No current exception
Howard Hinnantb50cda72012-01-30 16:07:00 +0000531 if (!isOurExceptionClass(&exception_header->unwindHeader))
532 return NULL;
Howard Hinnant7f476b42012-01-22 19:14:27 +0000533 return exception_header->exceptionType;
Marshall Clowfb69a8b2011-08-15 18:06:47 +0000534}
Marshall Clow3c54f1b2011-08-09 15:09:41 +0000535
536// 2.5.4 Rethrowing Exceptions
Howard Hinnantb50cda72012-01-30 16:07:00 +0000537/* This routine can rethrow native or foreign exceptions.
538If the exception is native:
Marshall Clow3c54f1b2011-08-09 15:09:41 +0000539* marks the exception object on top of the caughtExceptions stack
540 (in an implementation-defined way) as being rethrown.
541* If the caughtExceptions stack is empty, it calls terminate()
542 (see [C++FDIS] [except.throw], 15.1.8).
Howard Hinnantb50cda72012-01-30 16:07:00 +0000543* It then calls _Unwind_RaiseException which should not return
Howard Hinnant939daa72011-12-12 19:11:42 +0000544 (terminate if it does).
Howard Hinnant7f476b42012-01-22 19:14:27 +0000545 Note: exception_header may be masquerading as a __cxa_dependent_exception
546 and that's ok.
Marshall Clow3c54f1b2011-08-09 15:09:41 +0000547*/
Howard Hinnantb50cda72012-01-30 16:07:00 +0000548LIBCXXABI_NORETURN
549void
550__cxa_rethrow()
551{
552 __cxa_eh_globals* globals = __cxa_get_globals();
Howard Hinnantb50cda72012-01-30 16:07:00 +0000553 __cxa_exception* exception_header = globals->caughtExceptions;
554 if (NULL == exception_header)
555 std::terminate(); // throw; called outside of a exception handler
556 bool native_exception = isOurExceptionClass(&exception_header->unwindHeader);
557 if (native_exception)
558 {
Howard Hinnantb50cda72012-01-30 16:07:00 +0000559 // Mark the exception as being rethrown (reverse the effects of __cxa_begin_catch)
560 exception_header->handlerCount = -exception_header->handlerCount;
561 globals->uncaughtExceptions += 1;
562 // __cxa_end_catch will remove this exception from the caughtExceptions stack if necessary
563 }
564 else // this is a foreign exception
565 {
566 // The only way to communicate to __cxa_end_catch that we've rethrown
567 // a foreign exception, so don't delete us, is to pop the stack here
568 // which must be empty afterwards. Then __cxa_end_catch will do
569 // nothing
570 globals->caughtExceptions = 0;
571 }
Dan Albert610cde12015-02-05 01:33:15 +0000572#ifdef __USING_SJLJ_EXCEPTIONS__
Howard Hinnantb36b2c52012-02-29 22:14:19 +0000573 _Unwind_SjLj_RaiseException(&exception_header->unwindHeader);
Marshall Clow3c54f1b2011-08-09 15:09:41 +0000574#else
Howard Hinnantb36b2c52012-02-29 22:14:19 +0000575 _Unwind_RaiseException(&exception_header->unwindHeader);
Marshall Clow3c54f1b2011-08-09 15:09:41 +0000576#endif
577
Howard Hinnantb50cda72012-01-30 16:07:00 +0000578 // If we get here, some kind of unwinding error has occurred.
579 // There is some weird code generation bug happening with
580 // Apple clang version 4.0 (tags/Apple/clang-418.0.2) (based on LLVM 3.1svn)
581 // If we call failed_throw here. Turns up with -O2 or higher, and -Os.
582 __cxa_begin_catch(&exception_header->unwindHeader);
583 if (native_exception)
584 std::__terminate(exception_header->terminateHandler);
585 // Foreign exception: can't get exception_header->terminateHandler
586 std::terminate();
Marshall Clowfb69a8b2011-08-15 18:06:47 +0000587}
Marshall Clow3c54f1b2011-08-09 15:09:41 +0000588
Howard Hinnantf7b47f72011-12-21 23:32:11 +0000589/*
Howard Hinnantb50cda72012-01-30 16:07:00 +0000590 If thrown_object is not null, atomically increment the referenceCount field
591 of the __cxa_exception header associated with the thrown object referred to
592 by thrown_object.
593
594 Requires: If thrown_object is not NULL, it is a native exception.
Howard Hinnantf7b47f72011-12-21 23:32:11 +0000595*/
596void
Howard Hinnantb50cda72012-01-30 16:07:00 +0000597__cxa_increment_exception_refcount(void* thrown_object) throw()
Howard Hinnantf7b47f72011-12-21 23:32:11 +0000598{
Howard Hinnant7f476b42012-01-22 19:14:27 +0000599 if (thrown_object != NULL )
Howard Hinnantf7b47f72011-12-21 23:32:11 +0000600 {
Howard Hinnant7f476b42012-01-22 19:14:27 +0000601 __cxa_exception* exception_header = cxa_exception_from_thrown_object(thrown_object);
602 __sync_add_and_fetch(&exception_header->referenceCount, 1);
Howard Hinnantf7b47f72011-12-21 23:32:11 +0000603 }
604}
605
606/*
Howard Hinnantb50cda72012-01-30 16:07:00 +0000607 If thrown_object is not null, atomically decrement the referenceCount field
608 of the __cxa_exception header associated with the thrown object referred to
609 by thrown_object. If the referenceCount drops to zero, destroy and
610 deallocate the exception.
611
612 Requires: If thrown_object is not NULL, it is a native exception.
Howard Hinnantf7b47f72011-12-21 23:32:11 +0000613*/
614void
Howard Hinnantb50cda72012-01-30 16:07:00 +0000615__cxa_decrement_exception_refcount(void* thrown_object) throw()
Howard Hinnantf7b47f72011-12-21 23:32:11 +0000616{
617 if (thrown_object != NULL )
618 {
Howard Hinnant7f476b42012-01-22 19:14:27 +0000619 __cxa_exception* exception_header = cxa_exception_from_thrown_object(thrown_object);
620 if (__sync_sub_and_fetch(&exception_header->referenceCount, size_t(1)) == 0)
Howard Hinnantf7b47f72011-12-21 23:32:11 +0000621 {
Howard Hinnant7f476b42012-01-22 19:14:27 +0000622 if (NULL != exception_header->exceptionDestructor)
623 exception_header->exceptionDestructor(thrown_object);
Howard Hinnantf7b47f72011-12-21 23:32:11 +0000624 __cxa_free_exception(thrown_object);
625 }
626 }
627}
628
629/*
630 Returns a pointer to the thrown object (if any) at the top of the
Howard Hinnantb7118a72013-02-15 15:48:49 +0000631 caughtExceptions stack. Atomically increment the exception's referenceCount.
Howard Hinnantb50cda72012-01-30 16:07:00 +0000632 If there is no such thrown object or if the thrown object is foreign,
633 returns null.
Marshall Clow15997562012-01-04 22:18:10 +0000634
635 We can use __cxa_get_globals_fast here to get the globals because if there have
636 been no exceptions thrown, ever, on this thread, we can return NULL without
637 the need to allocate the exception-handling globals.
Howard Hinnantf7b47f72011-12-21 23:32:11 +0000638*/
639void*
Howard Hinnantb50cda72012-01-30 16:07:00 +0000640__cxa_current_primary_exception() throw()
Howard Hinnantf7b47f72011-12-21 23:32:11 +0000641{
642// get the current exception
Marshall Clowe80ed7d2012-01-03 23:26:09 +0000643 __cxa_eh_globals* globals = __cxa_get_globals_fast();
Marshall Clow57908522012-01-03 23:10:20 +0000644 if (NULL == globals)
Marshall Clow8989e4e2012-01-04 14:56:09 +0000645 return NULL; // If there are no globals, there is no exception
Howard Hinnant7f476b42012-01-22 19:14:27 +0000646 __cxa_exception* exception_header = globals->caughtExceptions;
647 if (NULL == exception_header)
Howard Hinnantf7b47f72011-12-21 23:32:11 +0000648 return NULL; // No current exception
Howard Hinnantb50cda72012-01-30 16:07:00 +0000649 if (!isOurExceptionClass(&exception_header->unwindHeader))
650 return NULL; // Can't capture a foreign exception (no way to refcount it)
Howard Hinnant7f476b42012-01-22 19:14:27 +0000651 if (isDependentException(&exception_header->unwindHeader)) {
652 __cxa_dependent_exception* dep_exception_header =
653 reinterpret_cast<__cxa_dependent_exception*>(exception_header);
654 exception_header = cxa_exception_from_thrown_object(dep_exception_header->primaryException);
Howard Hinnantf7b47f72011-12-21 23:32:11 +0000655 }
Howard Hinnant7f476b42012-01-22 19:14:27 +0000656 void* thrown_object = thrown_object_from_cxa_exception(exception_header);
Howard Hinnantf7b47f72011-12-21 23:32:11 +0000657 __cxa_increment_exception_refcount(thrown_object);
658 return thrown_object;
659}
660
661/*
662 If reason isn't _URC_FOREIGN_EXCEPTION_CAUGHT, then the terminateHandler
663 stored in exc is called. Otherwise the referenceCount stored in the
664 primary exception is decremented, destroying the primary if necessary.
665 Finally the dependent exception is destroyed.
666*/
667static
668void
Howard Hinnant7f476b42012-01-22 19:14:27 +0000669dependent_exception_cleanup(_Unwind_Reason_Code reason, _Unwind_Exception* unwind_exception)
Howard Hinnantf7b47f72011-12-21 23:32:11 +0000670{
Howard Hinnant7f476b42012-01-22 19:14:27 +0000671 __cxa_dependent_exception* dep_exception_header =
672 reinterpret_cast<__cxa_dependent_exception*>(unwind_exception + 1) - 1;
Howard Hinnantf7b47f72011-12-21 23:32:11 +0000673 if (_URC_FOREIGN_EXCEPTION_CAUGHT != reason)
Howard Hinnant7f476b42012-01-22 19:14:27 +0000674 std::__terminate(dep_exception_header->terminateHandler);
675 __cxa_decrement_exception_refcount(dep_exception_header->primaryException);
676 __cxa_free_dependent_exception(dep_exception_header);
Howard Hinnantf7b47f72011-12-21 23:32:11 +0000677}
678
679/*
Howard Hinnantb7118a72013-02-15 15:48:49 +0000680 If thrown_object is not null, allocate, initialize and throw a dependent
Howard Hinnantf7b47f72011-12-21 23:32:11 +0000681 exception.
682*/
683void
684__cxa_rethrow_primary_exception(void* thrown_object)
685{
686 if ( thrown_object != NULL )
687 {
Howard Hinnantb50cda72012-01-30 16:07:00 +0000688 // thrown_object guaranteed to be native because
689 // __cxa_current_primary_exception returns NULL for foreign exceptions
Howard Hinnant7f476b42012-01-22 19:14:27 +0000690 __cxa_exception* exception_header = cxa_exception_from_thrown_object(thrown_object);
691 __cxa_dependent_exception* dep_exception_header =
692 static_cast<__cxa_dependent_exception*>(__cxa_allocate_dependent_exception());
693 dep_exception_header->primaryException = thrown_object;
Howard Hinnantf7b47f72011-12-21 23:32:11 +0000694 __cxa_increment_exception_refcount(thrown_object);
Howard Hinnant7f476b42012-01-22 19:14:27 +0000695 dep_exception_header->exceptionType = exception_header->exceptionType;
696 dep_exception_header->unexpectedHandler = std::get_unexpected();
697 dep_exception_header->terminateHandler = std::get_terminate();
698 setDependentExceptionClass(&dep_exception_header->unwindHeader);
Howard Hinnantb9bf50b2011-12-21 23:48:05 +0000699 __cxa_get_globals()->uncaughtExceptions += 1;
Howard Hinnant7f476b42012-01-22 19:14:27 +0000700 dep_exception_header->unwindHeader.exception_cleanup = dependent_exception_cleanup;
Dan Albert610cde12015-02-05 01:33:15 +0000701#ifdef __USING_SJLJ_EXCEPTIONS__
Howard Hinnant7f476b42012-01-22 19:14:27 +0000702 _Unwind_SjLj_RaiseException(&dep_exception_header->unwindHeader);
Howard Hinnantf7b47f72011-12-21 23:32:11 +0000703#else
Howard Hinnant7f476b42012-01-22 19:14:27 +0000704 _Unwind_RaiseException(&dep_exception_header->unwindHeader);
Howard Hinnantf7b47f72011-12-21 23:32:11 +0000705#endif
706 // Some sort of unwinding error. Note that terminate is a handler.
Howard Hinnant7f476b42012-01-22 19:14:27 +0000707 __cxa_begin_catch(&dep_exception_header->unwindHeader);
Howard Hinnantf7b47f72011-12-21 23:32:11 +0000708 }
709 // If we return client will call terminate()
710}
711
Howard Hinnantf710f1e2012-01-24 00:01:31 +0000712bool
Howard Hinnantb50cda72012-01-30 16:07:00 +0000713__cxa_uncaught_exception() throw()
Howard Hinnantf710f1e2012-01-24 00:01:31 +0000714{
Howard Hinnantb50cda72012-01-30 16:07:00 +0000715 // This does not report foreign exceptions in flight
Howard Hinnantf710f1e2012-01-24 00:01:31 +0000716 __cxa_eh_globals* globals = __cxa_get_globals_fast();
717 if (globals == 0)
718 return false;
719 return globals->uncaughtExceptions != 0;
720}
721
Marshall Clowe0252022011-07-20 15:04:39 +0000722} // extern "C"
723
Howard Hinnant8ee279b2012-02-02 20:47:28 +0000724#pragma GCC visibility pop
725
Marshall Clowe0252022011-07-20 15:04:39 +0000726} // abi