blob: 603f869f988912231fef86520c98d2744d2a6300 [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
Igor Kudrin3724c272016-09-29 08:11:57 +000018#include <cstdlib> // for malloc, free
Howard Hinnant9071fe32013-06-17 18:10:34 +000019#include <cstring> // for memset
Igor Kudrin3724c272016-09-29 08:11:57 +000020#ifndef _LIBCXXABI_HAS_NO_THREADS
21# 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
Igor Kudrin3724c272016-09-29 08:11:57 +0000107#include "fallback_malloc.ipp"
108
109// Allocate some memory from _somewhere_
110static void *do_malloc(size_t size) {
111 void *ptr = std::malloc(size);
112 if (NULL == ptr) // if malloc fails, fall back to emergency stash
113 ptr = fallback_malloc(size);
114 return ptr;
115}
116
117static void do_free(void *ptr) {
118 is_fallback_ptr(ptr) ? fallback_free(ptr) : std::free(ptr);
119}
120
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.
Saleem Abdulrasool5c0d9642015-12-04 02:14:58 +0000159_LIBCXXABI_FUNC_VIS void *__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);
Igor Kudrin3724c272016-09-29 08:11:57 +0000161 __cxa_exception* exception_header = static_cast<__cxa_exception*>(do_malloc(actual_size));
Howard Hinnant7f476b42012-01-22 19:14:27 +0000162 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.
Saleem Abdulrasool5c0d9642015-12-04 02:14:58 +0000170_LIBCXXABI_FUNC_VIS void __cxa_free_exception(void *thrown_object) throw() {
Igor Kudrin3724c272016-09-29 08:11:57 +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);
Igor Kudrin3724c272016-09-29 08:11:57 +0000180 void *ptr = do_malloc(actual_size);
Marshall Clowfb69a8b2011-08-15 18:06:47 +0000181 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) {
Igor Kudrin3724c272016-09-29 08:11:57 +0000191 do_free(dependent_exception);
Marshall Clowfb69a8b2011-08-15 18:06:47 +0000192}
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*/
Saleem Abdulrasool5c0d9642015-12-04 02:14:58 +0000221_LIBCXXABI_FUNC_VIS LIBCXXABI_NORETURN void
222__cxa_throw(void *thrown_object, std::type_info *tinfo, void (*dest)(void *)) {
Marshall Clowfb69a8b2011-08-15 18:06:47 +0000223 __cxa_eh_globals *globals = __cxa_get_globals();
Howard Hinnant7f476b42012-01-22 19:14:27 +0000224 __cxa_exception* exception_header = cxa_exception_from_thrown_object(thrown_object);
Howard Hinnanta6baba12011-12-08 19:35:18 +0000225
Howard Hinnant7f476b42012-01-22 19:14:27 +0000226 exception_header->unexpectedHandler = std::get_unexpected();
227 exception_header->terminateHandler = std::get_terminate();
228 exception_header->exceptionType = tinfo;
229 exception_header->exceptionDestructor = dest;
230 setExceptionClass(&exception_header->unwindHeader);
231 exception_header->referenceCount = 1; // This is a newly allocated exception, no need for thread safety.
Marshall Clow3c54f1b2011-08-09 15:09:41 +0000232 globals->uncaughtExceptions += 1; // Not atomically, since globals are thread-local
233
Howard Hinnant7f476b42012-01-22 19:14:27 +0000234 exception_header->unwindHeader.exception_cleanup = exception_cleanup_func;
Dan Albert610cde12015-02-05 01:33:15 +0000235#ifdef __USING_SJLJ_EXCEPTIONS__
Howard Hinnant7f476b42012-01-22 19:14:27 +0000236 _Unwind_SjLj_RaiseException(&exception_header->unwindHeader);
Howard Hinnanta6baba12011-12-08 19:35:18 +0000237#else
Howard Hinnant7f476b42012-01-22 19:14:27 +0000238 _Unwind_RaiseException(&exception_header->unwindHeader);
Howard Hinnanta6baba12011-12-08 19:35:18 +0000239#endif
Howard Hinnantcbe4c6d2012-01-28 00:34:46 +0000240 // This only happens when there is no handler, or some unexpected unwinding
241 // error happens.
Howard Hinnant7f476b42012-01-22 19:14:27 +0000242 failed_throw(exception_header);
Marshall Clowfb69a8b2011-08-15 18:06:47 +0000243}
Marshall Clow3c54f1b2011-08-09 15:09:41 +0000244
245
246// 2.5.3 Exception Handlers
Howard Hinnant7f476b42012-01-22 19:14:27 +0000247/*
248The adjusted pointer is computed by the personality routine during phase 1
249 and saved in the exception header (either __cxa_exception or
250 __cxa_dependent_exception).
Howard Hinnantb50cda72012-01-30 16:07:00 +0000251
252 Requires: exception is native
Howard Hinnant7f476b42012-01-22 19:14:27 +0000253*/
Saleem Abdulrasool5c0d9642015-12-04 02:14:58 +0000254_LIBCXXABI_FUNC_VIS
Saleem Abdulrasoole5cf2752015-12-04 02:14:41 +0000255void *__cxa_get_exception_ptr(void *unwind_exception) throw() {
Logan Chien30a5e882014-05-10 00:42:10 +0000256#if LIBCXXABI_ARM_EHABI
257 return reinterpret_cast<void*>(
Dan Albert135a4f82015-02-05 23:48:06 +0000258 static_cast<_Unwind_Control_Block*>(unwind_exception)->barrier_cache.bitpattern[0]);
Logan Chien30a5e882014-05-10 00:42:10 +0000259#else
Dan Albert135a4f82015-02-05 23:48:06 +0000260 return cxa_exception_from_exception_unwind_exception(
261 static_cast<_Unwind_Exception*>(unwind_exception))->adjustedPtr;
Logan Chien30a5e882014-05-10 00:42:10 +0000262#endif
Marshall Clowfb69a8b2011-08-15 18:06:47 +0000263}
Logan Chien30a5e882014-05-10 00:42:10 +0000264
265#if LIBCXXABI_ARM_EHABI
266/*
267The routine to be called before the cleanup. This will save __cxa_exception in
268__cxa_eh_globals, so that __cxa_end_cleanup() can recover later.
269*/
Saleem Abdulrasool5c0d9642015-12-04 02:14:58 +0000270_LIBCXXABI_FUNC_VIS
Saleem Abdulrasoole5cf2752015-12-04 02:14:41 +0000271bool __cxa_begin_cleanup(void *unwind_arg) throw() {
Logan Chien30a5e882014-05-10 00:42:10 +0000272 _Unwind_Exception* unwind_exception = static_cast<_Unwind_Exception*>(unwind_arg);
273 __cxa_eh_globals* globals = __cxa_get_globals();
274 __cxa_exception* exception_header =
275 cxa_exception_from_exception_unwind_exception(unwind_exception);
276
277 if (isOurExceptionClass(unwind_exception))
278 {
279 if (0 == exception_header->propagationCount)
280 {
281 exception_header->nextPropagatingException = globals->propagatingExceptions;
282 globals->propagatingExceptions = exception_header;
283 }
284 ++exception_header->propagationCount;
285 }
286 else
287 {
288 // If the propagatingExceptions stack is not empty, since we can't
289 // chain the foreign exception, terminate it.
290 if (NULL != globals->propagatingExceptions)
291 std::terminate();
292 globals->propagatingExceptions = exception_header;
293 }
294 return true;
295}
296
297/*
298The routine to be called after the cleanup has been performed. It will get the
299propagating __cxa_exception from __cxa_eh_globals, and continue the stack
300unwinding with _Unwind_Resume.
301
302According to ARM EHABI 8.4.1, __cxa_end_cleanup() should not clobber any
303register, thus we have to write this function in assembly so that we can save
304{r1, r2, r3}. We don't have to save r0 because it is the return value and the
305first argument to _Unwind_Resume(). In addition, we are saving r4 in order to
306align the stack to 16 bytes, even though it is a callee-save register.
307*/
308__attribute__((used)) static _Unwind_Exception *
309__cxa_end_cleanup_impl()
310{
311 __cxa_eh_globals* globals = __cxa_get_globals();
312 __cxa_exception* exception_header = globals->propagatingExceptions;
313 if (NULL == exception_header)
314 {
315 // It seems that __cxa_begin_cleanup() is not called properly.
316 // We have no choice but terminate the program now.
317 std::terminate();
318 }
319
320 if (isOurExceptionClass(&exception_header->unwindHeader))
321 {
322 --exception_header->propagationCount;
323 if (0 == exception_header->propagationCount)
324 {
325 globals->propagatingExceptions = exception_header->nextPropagatingException;
326 exception_header->nextPropagatingException = NULL;
327 }
328 }
329 else
330 {
331 globals->propagatingExceptions = NULL;
332 }
333 return &exception_header->unwindHeader;
334}
335
336asm (
Logan Chiene76c4d02015-12-22 14:38:30 +0000337 " .pushsection .text.__cxa_end_cleanup,\"ax\",%progbits\n"
Logan Chien30a5e882014-05-10 00:42:10 +0000338 " .globl __cxa_end_cleanup\n"
339 " .type __cxa_end_cleanup,%function\n"
340 "__cxa_end_cleanup:\n"
341 " push {r1, r2, r3, r4}\n"
342 " bl __cxa_end_cleanup_impl\n"
343 " pop {r1, r2, r3, r4}\n"
344 " bl _Unwind_Resume\n"
345 " bl abort\n"
346 " .popsection"
347);
348#endif // LIBCXXABI_ARM_EHABI
Marshall Clow3c54f1b2011-08-09 15:09:41 +0000349
Marshall Clow3c54f1b2011-08-09 15:09:41 +0000350/*
Howard Hinnantb50cda72012-01-30 16:07:00 +0000351This routine can catch foreign or native exceptions. If native, the exception
352can be a primary or dependent variety. This routine may remain blissfully
353ignorant of whether the native exception is primary or dependent.
354
355If the exception is native:
Marshall Clow3c54f1b2011-08-09 15:09:41 +0000356* Increment's the exception's handler count.
Howard Hinnantb50cda72012-01-30 16:07:00 +0000357* Push the exception on the stack of currently-caught exceptions if it is not
358 already there (from a rethrow).
Marshall Clow3c54f1b2011-08-09 15:09:41 +0000359* Decrements the uncaught_exception count.
Howard Hinnantb50cda72012-01-30 16:07:00 +0000360* Returns the adjusted pointer to the exception object, which is stored in
361 the __cxa_exception by the personality routine.
362
363If the exception is foreign, this means it did not originate from one of throw
364routines. The foreign exception does not necessarily have a __cxa_exception
365header. However we can catch it here with a catch (...), or with a call
366to terminate or unexpected during unwinding.
367* Do not try to increment the exception's handler count, we don't know where
368 it is.
369* Push the exception on the stack of currently-caught exceptions only if the
370 stack is empty. The foreign exception has no way to link to the current
371 top of stack. If the stack is not empty, call terminate. Even with an
372 empty stack, this is hacked in by pushing a pointer to an imaginary
373 __cxa_exception block in front of the foreign exception. It would be better
374 if the __cxa_eh_globals structure had a stack of _Unwind_Exception, but it
375 doesn't. It has a stack of __cxa_exception (which has a next* in it).
376* Do not decrement the uncaught_exception count because we didn't increment it
377 in __cxa_throw (or one of our rethrow functions).
378* If we haven't terminated, assume the exception object is just past the
379 _Unwind_Exception and return a pointer to that.
Marshall Clow3c54f1b2011-08-09 15:09:41 +0000380*/
Howard Hinnant7f476b42012-01-22 19:14:27 +0000381void*
Howard Hinnantb50cda72012-01-30 16:07:00 +0000382__cxa_begin_catch(void* unwind_arg) throw()
Howard Hinnant7f476b42012-01-22 19:14:27 +0000383{
Howard Hinnantb50cda72012-01-30 16:07:00 +0000384 _Unwind_Exception* unwind_exception = static_cast<_Unwind_Exception*>(unwind_arg);
385 bool native_exception = isOurExceptionClass(unwind_exception);
386 __cxa_eh_globals* globals = __cxa_get_globals();
387 // exception_header is a hackish offset from a foreign exception, but it
388 // works as long as we're careful not to try to access any __cxa_exception
389 // parts.
Howard Hinnant7f476b42012-01-22 19:14:27 +0000390 __cxa_exception* exception_header =
391 cxa_exception_from_exception_unwind_exception
392 (
393 static_cast<_Unwind_Exception*>(unwind_exception)
394 );
Howard Hinnantb50cda72012-01-30 16:07:00 +0000395 if (native_exception)
396 {
397 // Increment the handler count, removing the flag about being rethrown
398 exception_header->handlerCount = exception_header->handlerCount < 0 ?
399 -exception_header->handlerCount + 1 : exception_header->handlerCount + 1;
400 // place the exception on the top of the stack if it's not already
401 // there by a previous rethrow
402 if (exception_header != globals->caughtExceptions)
403 {
404 exception_header->nextException = globals->caughtExceptions;
405 globals->caughtExceptions = exception_header;
406 }
407 globals->uncaughtExceptions -= 1; // Not atomically, since globals are thread-local
Logan Chien30a5e882014-05-10 00:42:10 +0000408#if LIBCXXABI_ARM_EHABI
409 return reinterpret_cast<void*>(exception_header->unwindHeader.barrier_cache.bitpattern[0]);
410#else
Howard Hinnantb50cda72012-01-30 16:07:00 +0000411 return exception_header->adjustedPtr;
Logan Chien30a5e882014-05-10 00:42:10 +0000412#endif
Marshall Clowfb69a8b2011-08-15 18:06:47 +0000413 }
Howard Hinnantb50cda72012-01-30 16:07:00 +0000414 // Else this is a foreign exception
415 // If the caughtExceptions stack is not empty, terminate
416 if (globals->caughtExceptions != 0)
417 std::terminate();
418 // Push the foreign exception on to the stack
419 globals->caughtExceptions = exception_header;
420 return unwind_exception + 1;
Marshall Clowfb69a8b2011-08-15 18:06:47 +0000421}
Marshall Clow3c54f1b2011-08-09 15:09:41 +0000422
423
424/*
425Upon exit for any reason, a handler must call:
426 void __cxa_end_catch ();
427
Howard Hinnantb50cda72012-01-30 16:07:00 +0000428This routine can be called for either a native or foreign exception.
429For a native exception:
Marshall Clow3c54f1b2011-08-09 15:09:41 +0000430* Locates the most recently caught exception and decrements its handler count.
431* Removes the exception from the caught exception stack, if the handler count goes to zero.
Howard Hinnanta6baba12011-12-08 19:35:18 +0000432* If the handler count goes down to zero, and the exception was not re-thrown
433 by throw, it locates the primary exception (which may be the same as the one
434 it's handling) and decrements its reference count. If that reference count
435 goes to zero, the function destroys the exception. In any case, if the current
436 exception is a dependent exception, it destroys that.
Howard Hinnantb50cda72012-01-30 16:07:00 +0000437
438For a foreign exception:
439* If it has been rethrown, there is nothing to do.
440* Otherwise delete the exception and pop the catch stack to empty.
Marshall Clow3c54f1b2011-08-09 15:09:41 +0000441*/
Saleem Abdulrasool5c0d9642015-12-04 02:14:58 +0000442_LIBCXXABI_FUNC_VIS void __cxa_end_catch() {
Nico Webercb407bb2014-06-25 23:52:07 +0000443 static_assert(sizeof(__cxa_exception) == sizeof(__cxa_dependent_exception),
444 "sizeof(__cxa_exception) must be equal to "
445 "sizeof(__cxa_dependent_exception)");
Saleem Abdulrasool5c07ac92015-11-18 05:33:38 +0000446 static_assert(__builtin_offsetof(__cxa_exception, referenceCount) ==
447 __builtin_offsetof(__cxa_dependent_exception,
448 primaryException),
449 "the layout of __cxa_exception must match the layout of "
450 "__cxa_dependent_exception");
451 static_assert(__builtin_offsetof(__cxa_exception, handlerCount) ==
452 __builtin_offsetof(__cxa_dependent_exception, handlerCount),
453 "the layout of __cxa_exception must match the layout of "
454 "__cxa_dependent_exception");
Howard Hinnantb50cda72012-01-30 16:07:00 +0000455 __cxa_eh_globals* globals = __cxa_get_globals_fast(); // __cxa_get_globals called in __cxa_begin_catch
456 __cxa_exception* exception_header = globals->caughtExceptions;
457 // If we've rethrown a foreign exception, then globals->caughtExceptions
458 // will have been made an empty stack by __cxa_rethrow() and there is
459 // nothing more to be done. Do nothing!
460 if (NULL != exception_header)
461 {
462 bool native_exception = isOurExceptionClass(&exception_header->unwindHeader);
463 if (native_exception)
464 {
465 // This is a native exception
466 if (exception_header->handlerCount < 0)
467 {
468 // The exception has been rethrown by __cxa_rethrow, so don't delete it
469 if (0 == incrementHandlerCount(exception_header))
470 {
471 // Remove from the chain of uncaught exceptions
472 globals->caughtExceptions = exception_header->nextException;
473 // but don't destroy
Howard Hinnanta6baba12011-12-08 19:35:18 +0000474 }
Howard Hinnantb50cda72012-01-30 16:07:00 +0000475 // Keep handlerCount negative in case there are nested catch's
476 // that need to be told that this exception is rethrown. Don't
477 // erase this rethrow flag until the exception is recaught.
478 }
479 else
480 {
481 // The native exception has not been rethrown
482 if (0 == decrementHandlerCount(exception_header))
483 {
484 // Remove from the chain of uncaught exceptions
485 globals->caughtExceptions = exception_header->nextException;
486 // Destroy this exception, being careful to distinguish
487 // between dependent and primary exceptions
488 if (isDependentException(&exception_header->unwindHeader))
489 {
490 // Reset exception_header to primaryException and deallocate the dependent exception
491 __cxa_dependent_exception* dep_exception_header =
492 reinterpret_cast<__cxa_dependent_exception*>(exception_header);
493 exception_header =
494 cxa_exception_from_thrown_object(dep_exception_header->primaryException);
495 __cxa_free_dependent_exception(dep_exception_header);
496 }
497 // Destroy the primary exception only if its referenceCount goes to 0
498 // (this decrement must be atomic)
499 __cxa_decrement_exception_refcount(thrown_object_from_cxa_exception(exception_header));
500 }
Marshall Clowfb69a8b2011-08-15 18:06:47 +0000501 }
502 }
Howard Hinnantb50cda72012-01-30 16:07:00 +0000503 else
504 {
505 // The foreign exception has not been rethrown. Pop the stack
506 // and delete it. If there are nested catch's and they try
507 // to touch a foreign exception in any way, that is undefined
508 // behavior. They likely can't since the only way to catch
509 // a foreign exception is with catch (...)!
510 _Unwind_DeleteException(&globals->caughtExceptions->unwindHeader);
511 globals->caughtExceptions = 0;
512 }
Marshall Clow3c54f1b2011-08-09 15:09:41 +0000513 }
Marshall Clowfb69a8b2011-08-15 18:06:47 +0000514}
Marshall Clow3c54f1b2011-08-09 15:09:41 +0000515
Howard Hinnant7f476b42012-01-22 19:14:27 +0000516// Note: exception_header may be masquerading as a __cxa_dependent_exception
517// and that's ok. exceptionType is there too.
Howard Hinnantb50cda72012-01-30 16:07:00 +0000518// However watch out for foreign exceptions. Return null for them.
Saleem Abdulrasool5c0d9642015-12-04 02:14:58 +0000519_LIBCXXABI_FUNC_VIS std::type_info *__cxa_current_exception_type() {
Marshall Clow3c54f1b2011-08-09 15:09:41 +0000520// get the current exception
Marshall Clow143cfb02011-12-22 15:45:05 +0000521 __cxa_eh_globals *globals = __cxa_get_globals_fast();
522 if (NULL == globals)
523 return NULL; // If there have never been any exceptions, there are none now.
Howard Hinnant7f476b42012-01-22 19:14:27 +0000524 __cxa_exception *exception_header = globals->caughtExceptions;
525 if (NULL == exception_header)
Marshall Clow3c54f1b2011-08-09 15:09:41 +0000526 return NULL; // No current exception
Howard Hinnantb50cda72012-01-30 16:07:00 +0000527 if (!isOurExceptionClass(&exception_header->unwindHeader))
528 return NULL;
Howard Hinnant7f476b42012-01-22 19:14:27 +0000529 return exception_header->exceptionType;
Marshall Clowfb69a8b2011-08-15 18:06:47 +0000530}
Marshall Clow3c54f1b2011-08-09 15:09:41 +0000531
532// 2.5.4 Rethrowing Exceptions
Howard Hinnantb50cda72012-01-30 16:07:00 +0000533/* This routine can rethrow native or foreign exceptions.
534If the exception is native:
Marshall Clow3c54f1b2011-08-09 15:09:41 +0000535* marks the exception object on top of the caughtExceptions stack
536 (in an implementation-defined way) as being rethrown.
537* If the caughtExceptions stack is empty, it calls terminate()
538 (see [C++FDIS] [except.throw], 15.1.8).
Howard Hinnantb50cda72012-01-30 16:07:00 +0000539* It then calls _Unwind_RaiseException which should not return
Howard Hinnant939daa72011-12-12 19:11:42 +0000540 (terminate if it does).
Howard Hinnant7f476b42012-01-22 19:14:27 +0000541 Note: exception_header may be masquerading as a __cxa_dependent_exception
542 and that's ok.
Marshall Clow3c54f1b2011-08-09 15:09:41 +0000543*/
Saleem Abdulrasool5c0d9642015-12-04 02:14:58 +0000544_LIBCXXABI_FUNC_VIS LIBCXXABI_NORETURN void __cxa_rethrow() {
Howard Hinnantb50cda72012-01-30 16:07:00 +0000545 __cxa_eh_globals* globals = __cxa_get_globals();
Howard Hinnantb50cda72012-01-30 16:07:00 +0000546 __cxa_exception* exception_header = globals->caughtExceptions;
547 if (NULL == exception_header)
548 std::terminate(); // throw; called outside of a exception handler
549 bool native_exception = isOurExceptionClass(&exception_header->unwindHeader);
550 if (native_exception)
551 {
Howard Hinnantb50cda72012-01-30 16:07:00 +0000552 // Mark the exception as being rethrown (reverse the effects of __cxa_begin_catch)
553 exception_header->handlerCount = -exception_header->handlerCount;
554 globals->uncaughtExceptions += 1;
555 // __cxa_end_catch will remove this exception from the caughtExceptions stack if necessary
556 }
557 else // this is a foreign exception
558 {
559 // The only way to communicate to __cxa_end_catch that we've rethrown
560 // a foreign exception, so don't delete us, is to pop the stack here
561 // which must be empty afterwards. Then __cxa_end_catch will do
562 // nothing
563 globals->caughtExceptions = 0;
564 }
Dan Albert610cde12015-02-05 01:33:15 +0000565#ifdef __USING_SJLJ_EXCEPTIONS__
Howard Hinnantb36b2c52012-02-29 22:14:19 +0000566 _Unwind_SjLj_RaiseException(&exception_header->unwindHeader);
Marshall Clow3c54f1b2011-08-09 15:09:41 +0000567#else
Howard Hinnantb36b2c52012-02-29 22:14:19 +0000568 _Unwind_RaiseException(&exception_header->unwindHeader);
Marshall Clow3c54f1b2011-08-09 15:09:41 +0000569#endif
570
Howard Hinnantb50cda72012-01-30 16:07:00 +0000571 // If we get here, some kind of unwinding error has occurred.
572 // There is some weird code generation bug happening with
573 // Apple clang version 4.0 (tags/Apple/clang-418.0.2) (based on LLVM 3.1svn)
574 // If we call failed_throw here. Turns up with -O2 or higher, and -Os.
575 __cxa_begin_catch(&exception_header->unwindHeader);
576 if (native_exception)
577 std::__terminate(exception_header->terminateHandler);
578 // Foreign exception: can't get exception_header->terminateHandler
579 std::terminate();
Marshall Clowfb69a8b2011-08-15 18:06:47 +0000580}
Marshall Clow3c54f1b2011-08-09 15:09:41 +0000581
Howard Hinnantf7b47f72011-12-21 23:32:11 +0000582/*
Howard Hinnantb50cda72012-01-30 16:07:00 +0000583 If thrown_object is not null, atomically increment the referenceCount field
584 of the __cxa_exception header associated with the thrown object referred to
585 by thrown_object.
586
587 Requires: If thrown_object is not NULL, it is a native exception.
Howard Hinnantf7b47f72011-12-21 23:32:11 +0000588*/
Saleem Abdulrasool5c0d9642015-12-04 02:14:58 +0000589_LIBCXXABI_FUNC_VIS void
590__cxa_increment_exception_refcount(void *thrown_object) throw() {
Howard Hinnant7f476b42012-01-22 19:14:27 +0000591 if (thrown_object != NULL )
Howard Hinnantf7b47f72011-12-21 23:32:11 +0000592 {
Howard Hinnant7f476b42012-01-22 19:14:27 +0000593 __cxa_exception* exception_header = cxa_exception_from_thrown_object(thrown_object);
594 __sync_add_and_fetch(&exception_header->referenceCount, 1);
Howard Hinnantf7b47f72011-12-21 23:32:11 +0000595 }
596}
597
598/*
Howard Hinnantb50cda72012-01-30 16:07:00 +0000599 If thrown_object is not null, atomically decrement the referenceCount field
600 of the __cxa_exception header associated with the thrown object referred to
601 by thrown_object. If the referenceCount drops to zero, destroy and
602 deallocate the exception.
603
604 Requires: If thrown_object is not NULL, it is a native exception.
Howard Hinnantf7b47f72011-12-21 23:32:11 +0000605*/
Saleem Abdulrasool5c0d9642015-12-04 02:14:58 +0000606_LIBCXXABI_FUNC_VIS void
607__cxa_decrement_exception_refcount(void *thrown_object) throw() {
Howard Hinnantf7b47f72011-12-21 23:32:11 +0000608 if (thrown_object != NULL )
609 {
Howard Hinnant7f476b42012-01-22 19:14:27 +0000610 __cxa_exception* exception_header = cxa_exception_from_thrown_object(thrown_object);
611 if (__sync_sub_and_fetch(&exception_header->referenceCount, size_t(1)) == 0)
Howard Hinnantf7b47f72011-12-21 23:32:11 +0000612 {
Howard Hinnant7f476b42012-01-22 19:14:27 +0000613 if (NULL != exception_header->exceptionDestructor)
614 exception_header->exceptionDestructor(thrown_object);
Howard Hinnantf7b47f72011-12-21 23:32:11 +0000615 __cxa_free_exception(thrown_object);
616 }
617 }
618}
619
620/*
621 Returns a pointer to the thrown object (if any) at the top of the
Howard Hinnantb7118a72013-02-15 15:48:49 +0000622 caughtExceptions stack. Atomically increment the exception's referenceCount.
Howard Hinnantb50cda72012-01-30 16:07:00 +0000623 If there is no such thrown object or if the thrown object is foreign,
624 returns null.
Marshall Clow15997562012-01-04 22:18:10 +0000625
626 We can use __cxa_get_globals_fast here to get the globals because if there have
627 been no exceptions thrown, ever, on this thread, we can return NULL without
628 the need to allocate the exception-handling globals.
Howard Hinnantf7b47f72011-12-21 23:32:11 +0000629*/
Saleem Abdulrasool5c0d9642015-12-04 02:14:58 +0000630_LIBCXXABI_FUNC_VIS void *__cxa_current_primary_exception() throw() {
Howard Hinnantf7b47f72011-12-21 23:32:11 +0000631// get the current exception
Marshall Clowe80ed7d2012-01-03 23:26:09 +0000632 __cxa_eh_globals* globals = __cxa_get_globals_fast();
Marshall Clow57908522012-01-03 23:10:20 +0000633 if (NULL == globals)
Marshall Clow8989e4e2012-01-04 14:56:09 +0000634 return NULL; // If there are no globals, there is no exception
Howard Hinnant7f476b42012-01-22 19:14:27 +0000635 __cxa_exception* exception_header = globals->caughtExceptions;
636 if (NULL == exception_header)
Howard Hinnantf7b47f72011-12-21 23:32:11 +0000637 return NULL; // No current exception
Howard Hinnantb50cda72012-01-30 16:07:00 +0000638 if (!isOurExceptionClass(&exception_header->unwindHeader))
639 return NULL; // Can't capture a foreign exception (no way to refcount it)
Howard Hinnant7f476b42012-01-22 19:14:27 +0000640 if (isDependentException(&exception_header->unwindHeader)) {
641 __cxa_dependent_exception* dep_exception_header =
642 reinterpret_cast<__cxa_dependent_exception*>(exception_header);
643 exception_header = cxa_exception_from_thrown_object(dep_exception_header->primaryException);
Howard Hinnantf7b47f72011-12-21 23:32:11 +0000644 }
Howard Hinnant7f476b42012-01-22 19:14:27 +0000645 void* thrown_object = thrown_object_from_cxa_exception(exception_header);
Howard Hinnantf7b47f72011-12-21 23:32:11 +0000646 __cxa_increment_exception_refcount(thrown_object);
647 return thrown_object;
648}
649
650/*
651 If reason isn't _URC_FOREIGN_EXCEPTION_CAUGHT, then the terminateHandler
652 stored in exc is called. Otherwise the referenceCount stored in the
653 primary exception is decremented, destroying the primary if necessary.
654 Finally the dependent exception is destroyed.
655*/
656static
657void
Howard Hinnant7f476b42012-01-22 19:14:27 +0000658dependent_exception_cleanup(_Unwind_Reason_Code reason, _Unwind_Exception* unwind_exception)
Howard Hinnantf7b47f72011-12-21 23:32:11 +0000659{
Howard Hinnant7f476b42012-01-22 19:14:27 +0000660 __cxa_dependent_exception* dep_exception_header =
661 reinterpret_cast<__cxa_dependent_exception*>(unwind_exception + 1) - 1;
Howard Hinnantf7b47f72011-12-21 23:32:11 +0000662 if (_URC_FOREIGN_EXCEPTION_CAUGHT != reason)
Howard Hinnant7f476b42012-01-22 19:14:27 +0000663 std::__terminate(dep_exception_header->terminateHandler);
664 __cxa_decrement_exception_refcount(dep_exception_header->primaryException);
665 __cxa_free_dependent_exception(dep_exception_header);
Howard Hinnantf7b47f72011-12-21 23:32:11 +0000666}
667
668/*
Howard Hinnantb7118a72013-02-15 15:48:49 +0000669 If thrown_object is not null, allocate, initialize and throw a dependent
Howard Hinnantf7b47f72011-12-21 23:32:11 +0000670 exception.
671*/
672void
673__cxa_rethrow_primary_exception(void* thrown_object)
674{
675 if ( thrown_object != NULL )
676 {
Howard Hinnantb50cda72012-01-30 16:07:00 +0000677 // thrown_object guaranteed to be native because
678 // __cxa_current_primary_exception returns NULL for foreign exceptions
Howard Hinnant7f476b42012-01-22 19:14:27 +0000679 __cxa_exception* exception_header = cxa_exception_from_thrown_object(thrown_object);
680 __cxa_dependent_exception* dep_exception_header =
681 static_cast<__cxa_dependent_exception*>(__cxa_allocate_dependent_exception());
682 dep_exception_header->primaryException = thrown_object;
Howard Hinnantf7b47f72011-12-21 23:32:11 +0000683 __cxa_increment_exception_refcount(thrown_object);
Howard Hinnant7f476b42012-01-22 19:14:27 +0000684 dep_exception_header->exceptionType = exception_header->exceptionType;
685 dep_exception_header->unexpectedHandler = std::get_unexpected();
686 dep_exception_header->terminateHandler = std::get_terminate();
687 setDependentExceptionClass(&dep_exception_header->unwindHeader);
Howard Hinnantb9bf50b2011-12-21 23:48:05 +0000688 __cxa_get_globals()->uncaughtExceptions += 1;
Howard Hinnant7f476b42012-01-22 19:14:27 +0000689 dep_exception_header->unwindHeader.exception_cleanup = dependent_exception_cleanup;
Dan Albert610cde12015-02-05 01:33:15 +0000690#ifdef __USING_SJLJ_EXCEPTIONS__
Howard Hinnant7f476b42012-01-22 19:14:27 +0000691 _Unwind_SjLj_RaiseException(&dep_exception_header->unwindHeader);
Howard Hinnantf7b47f72011-12-21 23:32:11 +0000692#else
Howard Hinnant7f476b42012-01-22 19:14:27 +0000693 _Unwind_RaiseException(&dep_exception_header->unwindHeader);
Howard Hinnantf7b47f72011-12-21 23:32:11 +0000694#endif
695 // Some sort of unwinding error. Note that terminate is a handler.
Howard Hinnant7f476b42012-01-22 19:14:27 +0000696 __cxa_begin_catch(&dep_exception_header->unwindHeader);
Howard Hinnantf7b47f72011-12-21 23:32:11 +0000697 }
698 // If we return client will call terminate()
699}
700
Howard Hinnantf710f1e2012-01-24 00:01:31 +0000701bool
Marshall Clow701adfd2015-06-02 13:03:17 +0000702__cxa_uncaught_exception() throw() { return __cxa_uncaught_exceptions() != 0; }
703
704unsigned int
705__cxa_uncaught_exceptions() throw()
Howard Hinnantf710f1e2012-01-24 00:01:31 +0000706{
Howard Hinnantb50cda72012-01-30 16:07:00 +0000707 // This does not report foreign exceptions in flight
Howard Hinnantf710f1e2012-01-24 00:01:31 +0000708 __cxa_eh_globals* globals = __cxa_get_globals_fast();
709 if (globals == 0)
Marshall Clow701adfd2015-06-02 13:03:17 +0000710 return 0;
711 return globals->uncaughtExceptions;
Howard Hinnantf710f1e2012-01-24 00:01:31 +0000712}
713
Marshall Clowe0252022011-07-20 15:04:39 +0000714} // extern "C"
715
Howard Hinnant8ee279b2012-02-02 20:47:28 +0000716#pragma GCC visibility pop
717
Marshall Clowe0252022011-07-20 15:04:39 +0000718} // abi