[clang][analyzer][NFC] Remove unnecessary FALLTHROUGH markers
[llvm-project.git] / libcxxabi / src / cxa_exception.cpp
blob9cb2bf888811f1cb8ca869564bf55059252ffed3
1 //===----------------------------------------------------------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //
8 // This file implements the "Exception Handling APIs"
9 // https://itanium-cxx-abi.github.io/cxx-abi/abi-eh.html
11 //===----------------------------------------------------------------------===//
13 #include "cxxabi.h"
15 #include <exception> // for std::terminate
16 #include <string.h> // for memset
17 #include "cxa_exception.h"
18 #include "cxa_handlers.h"
19 #include "fallback_malloc.h"
20 #include "include/atomic_support.h" // from libc++
22 #if __has_feature(address_sanitizer)
23 #include <sanitizer/asan_interface.h>
24 #endif
26 // +---------------------------+-----------------------------+---------------+
27 // | __cxa_exception | _Unwind_Exception CLNGC++\0 | thrown object |
28 // +---------------------------+-----------------------------+---------------+
29 // ^
30 // |
31 // +-------------------------------------------------------+
32 // |
33 // +---------------------------+-----------------------------+
34 // | __cxa_dependent_exception | _Unwind_Exception CLNGC++\1 |
35 // +---------------------------+-----------------------------+
37 namespace __cxxabiv1 {
39 // Utility routines
40 static
41 inline
42 __cxa_exception*
43 cxa_exception_from_thrown_object(void* thrown_object)
45 return static_cast<__cxa_exception*>(thrown_object) - 1;
48 // Note: This is never called when exception_header is masquerading as a
49 // __cxa_dependent_exception.
50 static
51 inline
52 void*
53 thrown_object_from_cxa_exception(__cxa_exception* exception_header)
55 return static_cast<void*>(exception_header + 1);
58 // Get the exception object from the unwind pointer.
59 // Relies on the structure layout, where the unwind pointer is right in
60 // front of the user's exception object
61 static
62 inline
63 __cxa_exception*
64 cxa_exception_from_exception_unwind_exception(_Unwind_Exception* unwind_exception)
66 return cxa_exception_from_thrown_object(unwind_exception + 1 );
69 // Round s up to next multiple of a.
70 static inline
71 size_t aligned_allocation_size(size_t s, size_t a) {
72 return (s + a - 1) & ~(a - 1);
75 static inline
76 size_t cxa_exception_size_from_exception_thrown_size(size_t size) {
77 return aligned_allocation_size(size + sizeof (__cxa_exception),
78 alignof(__cxa_exception));
81 void __setExceptionClass(_Unwind_Exception* unwind_exception, uint64_t newValue) {
82 ::memcpy(&unwind_exception->exception_class, &newValue, sizeof(newValue));
86 static void setOurExceptionClass(_Unwind_Exception* unwind_exception) {
87 __setExceptionClass(unwind_exception, kOurExceptionClass);
90 static void setDependentExceptionClass(_Unwind_Exception* unwind_exception) {
91 __setExceptionClass(unwind_exception, kOurDependentExceptionClass);
94 // Is it one of ours?
95 uint64_t __getExceptionClass(const _Unwind_Exception* unwind_exception) {
96 // On x86 and some ARM unwinders, unwind_exception->exception_class is
97 // a uint64_t. On other ARM unwinders, it is a char[8].
98 // See: http://infocenter.arm.com/help/topic/com.arm.doc.ihi0038b/IHI0038B_ehabi.pdf
99 // So we just copy it into a uint64_t to be sure.
100 uint64_t exClass;
101 ::memcpy(&exClass, &unwind_exception->exception_class, sizeof(exClass));
102 return exClass;
105 bool __isOurExceptionClass(const _Unwind_Exception* unwind_exception) {
106 return (__getExceptionClass(unwind_exception) & get_vendor_and_language) ==
107 (kOurExceptionClass & get_vendor_and_language);
110 static bool isDependentException(_Unwind_Exception* unwind_exception) {
111 return (__getExceptionClass(unwind_exception) & 0xFF) == 0x01;
114 // This does not need to be atomic
115 static inline int incrementHandlerCount(__cxa_exception *exception) {
116 return ++exception->handlerCount;
119 // This does not need to be atomic
120 static inline int decrementHandlerCount(__cxa_exception *exception) {
121 return --exception->handlerCount;
125 If reason isn't _URC_FOREIGN_EXCEPTION_CAUGHT, then the terminateHandler
126 stored in exc is called. Otherwise the exceptionDestructor stored in
127 exc is called, and then the memory for the exception is deallocated.
129 This is never called for a __cxa_dependent_exception.
131 static
132 void
133 exception_cleanup_func(_Unwind_Reason_Code reason, _Unwind_Exception* unwind_exception)
135 __cxa_exception* exception_header = cxa_exception_from_exception_unwind_exception(unwind_exception);
136 if (_URC_FOREIGN_EXCEPTION_CAUGHT != reason)
137 std::__terminate(exception_header->terminateHandler);
138 // Just in case there exists a dependent exception that is pointing to this,
139 // check the reference count and only destroy this if that count goes to zero.
140 __cxa_decrement_exception_refcount(unwind_exception + 1);
143 static _LIBCXXABI_NORETURN void failed_throw(__cxa_exception* exception_header) {
144 // Section 2.5.3 says:
145 // * For purposes of this ABI, several things are considered exception handlers:
146 // ** A terminate() call due to a throw.
147 // and
148 // * Upon entry, Following initialization of the catch parameter,
149 // a handler must call:
150 // * void *__cxa_begin_catch(void *exceptionObject );
151 (void) __cxa_begin_catch(&exception_header->unwindHeader);
152 std::__terminate(exception_header->terminateHandler);
155 // Return the offset of the __cxa_exception header from the start of the
156 // allocated buffer. If __cxa_exception's alignment is smaller than the maximum
157 // useful alignment for the target machine, padding has to be inserted before
158 // the header to ensure the thrown object that follows the header is
159 // sufficiently aligned. This happens if _Unwind_exception isn't double-word
160 // aligned (on Darwin, for example).
161 static size_t get_cxa_exception_offset() {
162 struct S {
163 } __attribute__((aligned));
165 // Compute the maximum alignment for the target machine.
166 constexpr size_t alignment = alignof(S);
167 constexpr size_t excp_size = sizeof(__cxa_exception);
168 constexpr size_t aligned_size =
169 (excp_size + alignment - 1) / alignment * alignment;
170 constexpr size_t offset = aligned_size - excp_size;
171 static_assert((offset == 0 || alignof(_Unwind_Exception) < alignment),
172 "offset is non-zero only if _Unwind_Exception isn't aligned");
173 return offset;
176 extern "C" {
178 // Allocate a __cxa_exception object, and zero-fill it.
179 // Reserve "thrown_size" bytes on the end for the user's exception
180 // object. Zero-fill the object. If memory can't be allocated, call
181 // std::terminate. Return a pointer to the memory to be used for the
182 // user's exception object.
183 void *__cxa_allocate_exception(size_t thrown_size) throw() {
184 size_t actual_size = cxa_exception_size_from_exception_thrown_size(thrown_size);
186 // Allocate extra space before the __cxa_exception header to ensure the
187 // start of the thrown object is sufficiently aligned.
188 size_t header_offset = get_cxa_exception_offset();
189 char *raw_buffer =
190 (char *)__aligned_malloc_with_fallback(header_offset + actual_size);
191 if (NULL == raw_buffer)
192 std::terminate();
193 __cxa_exception *exception_header =
194 static_cast<__cxa_exception *>((void *)(raw_buffer + header_offset));
195 ::memset(exception_header, 0, actual_size);
196 return thrown_object_from_cxa_exception(exception_header);
200 // Free a __cxa_exception object allocated with __cxa_allocate_exception.
201 void __cxa_free_exception(void *thrown_object) throw() {
202 // Compute the size of the padding before the header.
203 size_t header_offset = get_cxa_exception_offset();
204 char *raw_buffer =
205 ((char *)cxa_exception_from_thrown_object(thrown_object)) - header_offset;
206 __aligned_free_with_fallback((void *)raw_buffer);
210 // This function shall allocate a __cxa_dependent_exception and
211 // return a pointer to it. (Really to the object, not past its' end).
212 // Otherwise, it will work like __cxa_allocate_exception.
213 void * __cxa_allocate_dependent_exception () {
214 size_t actual_size = sizeof(__cxa_dependent_exception);
215 void *ptr = __aligned_malloc_with_fallback(actual_size);
216 if (NULL == ptr)
217 std::terminate();
218 ::memset(ptr, 0, actual_size);
219 return ptr;
223 // This function shall free a dependent_exception.
224 // It does not affect the reference count of the primary exception.
225 void __cxa_free_dependent_exception (void * dependent_exception) {
226 __aligned_free_with_fallback(dependent_exception);
230 // 2.4.3 Throwing the Exception Object
232 After constructing the exception object with the throw argument value,
233 the generated code calls the __cxa_throw runtime library routine. This
234 routine never returns.
236 The __cxa_throw routine will do the following:
238 * Obtain the __cxa_exception header from the thrown exception object address,
239 which can be computed as follows:
240 __cxa_exception *header = ((__cxa_exception *) thrown_exception - 1);
241 * Save the current unexpected_handler and terminate_handler in the __cxa_exception header.
242 * Save the tinfo and dest arguments in the __cxa_exception header.
243 * Set the exception_class field in the unwind header. This is a 64-bit value
244 representing the ASCII string "XXXXC++\0", where "XXXX" is a
245 vendor-dependent string. That is, for implementations conforming to this
246 ABI, the low-order 4 bytes of this 64-bit value will be "C++\0".
247 * Increment the uncaught_exception flag.
248 * Call _Unwind_RaiseException in the system unwind library, Its argument is the
249 pointer to the thrown exception, which __cxa_throw itself received as an argument.
250 __Unwind_RaiseException begins the process of stack unwinding, described
251 in Section 2.5. In special cases, such as an inability to find a
252 handler, _Unwind_RaiseException may return. In that case, __cxa_throw
253 will call terminate, assuming that there was no handler for the
254 exception.
256 void
257 __cxa_throw(void *thrown_object, std::type_info *tinfo, void (_LIBCXXABI_DTOR_FUNC *dest)(void *)) {
258 __cxa_eh_globals *globals = __cxa_get_globals();
259 __cxa_exception* exception_header = cxa_exception_from_thrown_object(thrown_object);
261 exception_header->unexpectedHandler = std::get_unexpected();
262 exception_header->terminateHandler = std::get_terminate();
263 exception_header->exceptionType = tinfo;
264 exception_header->exceptionDestructor = dest;
265 setOurExceptionClass(&exception_header->unwindHeader);
266 exception_header->referenceCount = 1; // This is a newly allocated exception, no need for thread safety.
267 globals->uncaughtExceptions += 1; // Not atomically, since globals are thread-local
269 exception_header->unwindHeader.exception_cleanup = exception_cleanup_func;
271 #if __has_feature(address_sanitizer)
272 // Inform the ASan runtime that now might be a good time to clean stuff up.
273 __asan_handle_no_return();
274 #endif
276 #ifdef __USING_SJLJ_EXCEPTIONS__
277 _Unwind_SjLj_RaiseException(&exception_header->unwindHeader);
278 #else
279 _Unwind_RaiseException(&exception_header->unwindHeader);
280 #endif
281 // This only happens when there is no handler, or some unexpected unwinding
282 // error happens.
283 failed_throw(exception_header);
287 // 2.5.3 Exception Handlers
289 The adjusted pointer is computed by the personality routine during phase 1
290 and saved in the exception header (either __cxa_exception or
291 __cxa_dependent_exception).
293 Requires: exception is native
295 void *__cxa_get_exception_ptr(void *unwind_exception) throw() {
296 #if defined(_LIBCXXABI_ARM_EHABI)
297 return reinterpret_cast<void*>(
298 static_cast<_Unwind_Control_Block*>(unwind_exception)->barrier_cache.bitpattern[0]);
299 #else
300 return cxa_exception_from_exception_unwind_exception(
301 static_cast<_Unwind_Exception*>(unwind_exception))->adjustedPtr;
302 #endif
305 #if defined(_LIBCXXABI_ARM_EHABI)
307 The routine to be called before the cleanup. This will save __cxa_exception in
308 __cxa_eh_globals, so that __cxa_end_cleanup() can recover later.
310 bool __cxa_begin_cleanup(void *unwind_arg) throw() {
311 _Unwind_Exception* unwind_exception = static_cast<_Unwind_Exception*>(unwind_arg);
312 __cxa_eh_globals* globals = __cxa_get_globals();
313 __cxa_exception* exception_header =
314 cxa_exception_from_exception_unwind_exception(unwind_exception);
316 if (__isOurExceptionClass(unwind_exception))
318 if (0 == exception_header->propagationCount)
320 exception_header->nextPropagatingException = globals->propagatingExceptions;
321 globals->propagatingExceptions = exception_header;
323 ++exception_header->propagationCount;
325 else
327 // If the propagatingExceptions stack is not empty, since we can't
328 // chain the foreign exception, terminate it.
329 if (NULL != globals->propagatingExceptions)
330 std::terminate();
331 globals->propagatingExceptions = exception_header;
333 return true;
337 The routine to be called after the cleanup has been performed. It will get the
338 propagating __cxa_exception from __cxa_eh_globals, and continue the stack
339 unwinding with _Unwind_Resume.
341 According to ARM EHABI 8.4.1, __cxa_end_cleanup() should not clobber any
342 register, thus we have to write this function in assembly so that we can save
343 {r1, r2, r3}. We don't have to save r0 because it is the return value and the
344 first argument to _Unwind_Resume(). The function also saves/restores r4 to
345 keep the stack aligned and to provide a temp register. _Unwind_Resume never
346 returns and we need to keep the original lr so just branch to it. When
347 targeting bare metal, the function also clobbers ip/r12 to hold the address of
348 _Unwind_Resume, which may be too far away for an ordinary branch.
350 __attribute__((used)) static _Unwind_Exception *
351 __cxa_end_cleanup_impl()
353 __cxa_eh_globals* globals = __cxa_get_globals();
354 __cxa_exception* exception_header = globals->propagatingExceptions;
355 if (NULL == exception_header)
357 // It seems that __cxa_begin_cleanup() is not called properly.
358 // We have no choice but terminate the program now.
359 std::terminate();
362 if (__isOurExceptionClass(&exception_header->unwindHeader))
364 --exception_header->propagationCount;
365 if (0 == exception_header->propagationCount)
367 globals->propagatingExceptions = exception_header->nextPropagatingException;
368 exception_header->nextPropagatingException = NULL;
371 else
373 globals->propagatingExceptions = NULL;
375 return &exception_header->unwindHeader;
378 asm(" .pushsection .text.__cxa_end_cleanup,\"ax\",%progbits\n"
379 " .globl __cxa_end_cleanup\n"
380 " .type __cxa_end_cleanup,%function\n"
381 "__cxa_end_cleanup:\n"
382 #if defined(__ARM_FEATURE_BTI_DEFAULT)
383 " bti\n"
384 #endif
385 " push {r1, r2, r3, r4}\n"
386 " mov r4, lr\n"
387 " bl __cxa_end_cleanup_impl\n"
388 " mov lr, r4\n"
389 #if defined(LIBCXXABI_BAREMETAL)
390 " ldr r4, =_Unwind_Resume\n"
391 " mov ip, r4\n"
392 #endif
393 " pop {r1, r2, r3, r4}\n"
394 #if defined(LIBCXXABI_BAREMETAL)
395 " bx ip\n"
396 #else
397 " b _Unwind_Resume\n"
398 #endif
399 " .popsection");
400 #endif // defined(_LIBCXXABI_ARM_EHABI)
403 This routine can catch foreign or native exceptions. If native, the exception
404 can be a primary or dependent variety. This routine may remain blissfully
405 ignorant of whether the native exception is primary or dependent.
407 If the exception is native:
408 * Increment's the exception's handler count.
409 * Push the exception on the stack of currently-caught exceptions if it is not
410 already there (from a rethrow).
411 * Decrements the uncaught_exception count.
412 * Returns the adjusted pointer to the exception object, which is stored in
413 the __cxa_exception by the personality routine.
415 If the exception is foreign, this means it did not originate from one of throw
416 routines. The foreign exception does not necessarily have a __cxa_exception
417 header. However we can catch it here with a catch (...), or with a call
418 to terminate or unexpected during unwinding.
419 * Do not try to increment the exception's handler count, we don't know where
420 it is.
421 * Push the exception on the stack of currently-caught exceptions only if the
422 stack is empty. The foreign exception has no way to link to the current
423 top of stack. If the stack is not empty, call terminate. Even with an
424 empty stack, this is hacked in by pushing a pointer to an imaginary
425 __cxa_exception block in front of the foreign exception. It would be better
426 if the __cxa_eh_globals structure had a stack of _Unwind_Exception, but it
427 doesn't. It has a stack of __cxa_exception (which has a next* in it).
428 * Do not decrement the uncaught_exception count because we didn't increment it
429 in __cxa_throw (or one of our rethrow functions).
430 * If we haven't terminated, assume the exception object is just past the
431 _Unwind_Exception and return a pointer to that.
433 void*
434 __cxa_begin_catch(void* unwind_arg) throw()
436 _Unwind_Exception* unwind_exception = static_cast<_Unwind_Exception*>(unwind_arg);
437 bool native_exception = __isOurExceptionClass(unwind_exception);
438 __cxa_eh_globals* globals = __cxa_get_globals();
439 // exception_header is a hackish offset from a foreign exception, but it
440 // works as long as we're careful not to try to access any __cxa_exception
441 // parts.
442 __cxa_exception* exception_header =
443 cxa_exception_from_exception_unwind_exception
445 static_cast<_Unwind_Exception*>(unwind_exception)
448 #if defined(__MVS__)
449 // Remove the exception object from the linked list of exceptions that the z/OS unwinder
450 // maintains before adding it to the libc++abi list of caught exceptions.
451 // The libc++abi will manage the lifetime of the exception from this point forward.
452 _UnwindZOS_PopException();
453 #endif
455 if (native_exception)
457 // Increment the handler count, removing the flag about being rethrown
458 exception_header->handlerCount = exception_header->handlerCount < 0 ?
459 -exception_header->handlerCount + 1 : exception_header->handlerCount + 1;
460 // place the exception on the top of the stack if it's not already
461 // there by a previous rethrow
462 if (exception_header != globals->caughtExceptions)
464 exception_header->nextException = globals->caughtExceptions;
465 globals->caughtExceptions = exception_header;
467 globals->uncaughtExceptions -= 1; // Not atomically, since globals are thread-local
468 #if defined(_LIBCXXABI_ARM_EHABI)
469 return reinterpret_cast<void*>(exception_header->unwindHeader.barrier_cache.bitpattern[0]);
470 #else
471 return exception_header->adjustedPtr;
472 #endif
474 // Else this is a foreign exception
475 // If the caughtExceptions stack is not empty, terminate
476 if (globals->caughtExceptions != 0)
477 std::terminate();
478 // Push the foreign exception on to the stack
479 globals->caughtExceptions = exception_header;
480 return unwind_exception + 1;
485 Upon exit for any reason, a handler must call:
486 void __cxa_end_catch ();
488 This routine can be called for either a native or foreign exception.
489 For a native exception:
490 * Locates the most recently caught exception and decrements its handler count.
491 * Removes the exception from the caught exception stack, if the handler count goes to zero.
492 * If the handler count goes down to zero, and the exception was not re-thrown
493 by throw, it locates the primary exception (which may be the same as the one
494 it's handling) and decrements its reference count. If that reference count
495 goes to zero, the function destroys the exception. In any case, if the current
496 exception is a dependent exception, it destroys that.
498 For a foreign exception:
499 * If it has been rethrown, there is nothing to do.
500 * Otherwise delete the exception and pop the catch stack to empty.
502 void __cxa_end_catch() {
503 static_assert(sizeof(__cxa_exception) == sizeof(__cxa_dependent_exception),
504 "sizeof(__cxa_exception) must be equal to "
505 "sizeof(__cxa_dependent_exception)");
506 static_assert(__builtin_offsetof(__cxa_exception, referenceCount) ==
507 __builtin_offsetof(__cxa_dependent_exception,
508 primaryException),
509 "the layout of __cxa_exception must match the layout of "
510 "__cxa_dependent_exception");
511 static_assert(__builtin_offsetof(__cxa_exception, handlerCount) ==
512 __builtin_offsetof(__cxa_dependent_exception, handlerCount),
513 "the layout of __cxa_exception must match the layout of "
514 "__cxa_dependent_exception");
515 __cxa_eh_globals* globals = __cxa_get_globals_fast(); // __cxa_get_globals called in __cxa_begin_catch
516 __cxa_exception* exception_header = globals->caughtExceptions;
517 // If we've rethrown a foreign exception, then globals->caughtExceptions
518 // will have been made an empty stack by __cxa_rethrow() and there is
519 // nothing more to be done. Do nothing!
520 if (NULL != exception_header)
522 bool native_exception = __isOurExceptionClass(&exception_header->unwindHeader);
523 if (native_exception)
525 // This is a native exception
526 if (exception_header->handlerCount < 0)
528 // The exception has been rethrown by __cxa_rethrow, so don't delete it
529 if (0 == incrementHandlerCount(exception_header))
531 // Remove from the chain of uncaught exceptions
532 globals->caughtExceptions = exception_header->nextException;
533 // but don't destroy
535 // Keep handlerCount negative in case there are nested catch's
536 // that need to be told that this exception is rethrown. Don't
537 // erase this rethrow flag until the exception is recaught.
539 else
541 // The native exception has not been rethrown
542 if (0 == decrementHandlerCount(exception_header))
544 // Remove from the chain of uncaught exceptions
545 globals->caughtExceptions = exception_header->nextException;
546 // Destroy this exception, being careful to distinguish
547 // between dependent and primary exceptions
548 if (isDependentException(&exception_header->unwindHeader))
550 // Reset exception_header to primaryException and deallocate the dependent exception
551 __cxa_dependent_exception* dep_exception_header =
552 reinterpret_cast<__cxa_dependent_exception*>(exception_header);
553 exception_header =
554 cxa_exception_from_thrown_object(dep_exception_header->primaryException);
555 __cxa_free_dependent_exception(dep_exception_header);
557 // Destroy the primary exception only if its referenceCount goes to 0
558 // (this decrement must be atomic)
559 __cxa_decrement_exception_refcount(thrown_object_from_cxa_exception(exception_header));
563 else
565 // The foreign exception has not been rethrown. Pop the stack
566 // and delete it. If there are nested catch's and they try
567 // to touch a foreign exception in any way, that is undefined
568 // behavior. They likely can't since the only way to catch
569 // a foreign exception is with catch (...)!
570 _Unwind_DeleteException(&globals->caughtExceptions->unwindHeader);
571 globals->caughtExceptions = 0;
576 // Note: exception_header may be masquerading as a __cxa_dependent_exception
577 // and that's ok. exceptionType is there too.
578 // However watch out for foreign exceptions. Return null for them.
579 std::type_info *__cxa_current_exception_type() {
580 // get the current exception
581 __cxa_eh_globals *globals = __cxa_get_globals_fast();
582 if (NULL == globals)
583 return NULL; // If there have never been any exceptions, there are none now.
584 __cxa_exception *exception_header = globals->caughtExceptions;
585 if (NULL == exception_header)
586 return NULL; // No current exception
587 if (!__isOurExceptionClass(&exception_header->unwindHeader))
588 return NULL;
589 return exception_header->exceptionType;
592 // 2.5.4 Rethrowing Exceptions
593 /* This routine can rethrow native or foreign exceptions.
594 If the exception is native:
595 * marks the exception object on top of the caughtExceptions stack
596 (in an implementation-defined way) as being rethrown.
597 * If the caughtExceptions stack is empty, it calls terminate()
598 (see [C++FDIS] [except.throw], 15.1.8).
599 * It then calls _Unwind_RaiseException which should not return
600 (terminate if it does).
601 Note: exception_header may be masquerading as a __cxa_dependent_exception
602 and that's ok.
604 void __cxa_rethrow() {
605 __cxa_eh_globals* globals = __cxa_get_globals();
606 __cxa_exception* exception_header = globals->caughtExceptions;
607 if (NULL == exception_header)
608 std::terminate(); // throw; called outside of a exception handler
609 bool native_exception = __isOurExceptionClass(&exception_header->unwindHeader);
610 if (native_exception)
612 // Mark the exception as being rethrown (reverse the effects of __cxa_begin_catch)
613 exception_header->handlerCount = -exception_header->handlerCount;
614 globals->uncaughtExceptions += 1;
615 // __cxa_end_catch will remove this exception from the caughtExceptions stack if necessary
617 else // this is a foreign exception
619 // The only way to communicate to __cxa_end_catch that we've rethrown
620 // a foreign exception, so don't delete us, is to pop the stack here
621 // which must be empty afterwards. Then __cxa_end_catch will do
622 // nothing
623 globals->caughtExceptions = 0;
625 #ifdef __USING_SJLJ_EXCEPTIONS__
626 _Unwind_SjLj_RaiseException(&exception_header->unwindHeader);
627 #else
628 _Unwind_RaiseException(&exception_header->unwindHeader);
629 #endif
631 // If we get here, some kind of unwinding error has occurred.
632 // There is some weird code generation bug happening with
633 // Apple clang version 4.0 (tags/Apple/clang-418.0.2) (based on LLVM 3.1svn)
634 // If we call failed_throw here. Turns up with -O2 or higher, and -Os.
635 __cxa_begin_catch(&exception_header->unwindHeader);
636 if (native_exception)
637 std::__terminate(exception_header->terminateHandler);
638 // Foreign exception: can't get exception_header->terminateHandler
639 std::terminate();
643 If thrown_object is not null, atomically increment the referenceCount field
644 of the __cxa_exception header associated with the thrown object referred to
645 by thrown_object.
647 Requires: If thrown_object is not NULL, it is a native exception.
649 void
650 __cxa_increment_exception_refcount(void *thrown_object) throw() {
651 if (thrown_object != NULL )
653 __cxa_exception* exception_header = cxa_exception_from_thrown_object(thrown_object);
654 std::__libcpp_atomic_add(&exception_header->referenceCount, size_t(1));
659 If thrown_object is not null, atomically decrement the referenceCount field
660 of the __cxa_exception header associated with the thrown object referred to
661 by thrown_object. If the referenceCount drops to zero, destroy and
662 deallocate the exception.
664 Requires: If thrown_object is not NULL, it is a native exception.
666 _LIBCXXABI_NO_CFI
667 void __cxa_decrement_exception_refcount(void *thrown_object) throw() {
668 if (thrown_object != NULL )
670 __cxa_exception* exception_header = cxa_exception_from_thrown_object(thrown_object);
671 if (std::__libcpp_atomic_add(&exception_header->referenceCount, size_t(-1)) == 0)
673 if (NULL != exception_header->exceptionDestructor)
674 exception_header->exceptionDestructor(thrown_object);
675 __cxa_free_exception(thrown_object);
681 Returns a pointer to the thrown object (if any) at the top of the
682 caughtExceptions stack. Atomically increment the exception's referenceCount.
683 If there is no such thrown object or if the thrown object is foreign,
684 returns null.
686 We can use __cxa_get_globals_fast here to get the globals because if there have
687 been no exceptions thrown, ever, on this thread, we can return NULL without
688 the need to allocate the exception-handling globals.
690 void *__cxa_current_primary_exception() throw() {
691 // get the current exception
692 __cxa_eh_globals* globals = __cxa_get_globals_fast();
693 if (NULL == globals)
694 return NULL; // If there are no globals, there is no exception
695 __cxa_exception* exception_header = globals->caughtExceptions;
696 if (NULL == exception_header)
697 return NULL; // No current exception
698 if (!__isOurExceptionClass(&exception_header->unwindHeader))
699 return NULL; // Can't capture a foreign exception (no way to refcount it)
700 if (isDependentException(&exception_header->unwindHeader)) {
701 __cxa_dependent_exception* dep_exception_header =
702 reinterpret_cast<__cxa_dependent_exception*>(exception_header);
703 exception_header = cxa_exception_from_thrown_object(dep_exception_header->primaryException);
705 void* thrown_object = thrown_object_from_cxa_exception(exception_header);
706 __cxa_increment_exception_refcount(thrown_object);
707 return thrown_object;
711 If reason isn't _URC_FOREIGN_EXCEPTION_CAUGHT, then the terminateHandler
712 stored in exc is called. Otherwise the referenceCount stored in the
713 primary exception is decremented, destroying the primary if necessary.
714 Finally the dependent exception is destroyed.
716 static
717 void
718 dependent_exception_cleanup(_Unwind_Reason_Code reason, _Unwind_Exception* unwind_exception)
720 __cxa_dependent_exception* dep_exception_header =
721 reinterpret_cast<__cxa_dependent_exception*>(unwind_exception + 1) - 1;
722 if (_URC_FOREIGN_EXCEPTION_CAUGHT != reason)
723 std::__terminate(dep_exception_header->terminateHandler);
724 __cxa_decrement_exception_refcount(dep_exception_header->primaryException);
725 __cxa_free_dependent_exception(dep_exception_header);
729 If thrown_object is not null, allocate, initialize and throw a dependent
730 exception.
732 void
733 __cxa_rethrow_primary_exception(void* thrown_object)
735 if ( thrown_object != NULL )
737 // thrown_object guaranteed to be native because
738 // __cxa_current_primary_exception returns NULL for foreign exceptions
739 __cxa_exception* exception_header = cxa_exception_from_thrown_object(thrown_object);
740 __cxa_dependent_exception* dep_exception_header =
741 static_cast<__cxa_dependent_exception*>(__cxa_allocate_dependent_exception());
742 dep_exception_header->primaryException = thrown_object;
743 __cxa_increment_exception_refcount(thrown_object);
744 dep_exception_header->exceptionType = exception_header->exceptionType;
745 dep_exception_header->unexpectedHandler = std::get_unexpected();
746 dep_exception_header->terminateHandler = std::get_terminate();
747 setDependentExceptionClass(&dep_exception_header->unwindHeader);
748 __cxa_get_globals()->uncaughtExceptions += 1;
749 dep_exception_header->unwindHeader.exception_cleanup = dependent_exception_cleanup;
750 #ifdef __USING_SJLJ_EXCEPTIONS__
751 _Unwind_SjLj_RaiseException(&dep_exception_header->unwindHeader);
752 #else
753 _Unwind_RaiseException(&dep_exception_header->unwindHeader);
754 #endif
755 // Some sort of unwinding error. Note that terminate is a handler.
756 __cxa_begin_catch(&dep_exception_header->unwindHeader);
758 // If we return client will call terminate()
761 bool
762 __cxa_uncaught_exception() throw() { return __cxa_uncaught_exceptions() != 0; }
764 unsigned int
765 __cxa_uncaught_exceptions() throw()
767 // This does not report foreign exceptions in flight
768 __cxa_eh_globals* globals = __cxa_get_globals_fast();
769 if (globals == 0)
770 return 0;
771 return globals->uncaughtExceptions;
774 } // extern "C"
776 } // abi