1 /*
2  * Copyright 2010-2011 PathScale, Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *
7  * 1. Redistributions of source code must retain the above copyright notice,
8  *    this list of conditions and the following disclaimer.
9  *
10  * 2. Redistributions in binary form must reproduce the above copyright notice,
11  *    this list of conditions and the following disclaimer in the documentation
12  *    and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS
15  * IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
16  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
21  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
22  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
23  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
24  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  */
26 
27 #include <stdlib.h>
28 #include <dlfcn.h>
29 #include <stdio.h>
30 #include <string.h>
31 #include <stdint.h>
32 #include <pthread.h>
33 #include "typeinfo.h"
34 #include "dwarf_eh.h"
35 #include "atomic.h"
36 #include "cxxabi.h"
37 
38 #pragma weak pthread_key_create
39 #pragma weak pthread_setspecific
40 #pragma weak pthread_getspecific
41 #pragma weak pthread_once
42 #ifdef LIBCXXRT_WEAK_LOCKS
43 #pragma weak pthread_mutex_lock
44 #define pthread_mutex_lock(mtx) do {\
45           if (pthread_mutex_lock) pthread_mutex_lock(mtx);\
46           } while(0)
47 #pragma weak pthread_mutex_unlock
48 #define pthread_mutex_unlock(mtx) do {\
49           if (pthread_mutex_unlock) pthread_mutex_unlock(mtx);\
50           } while(0)
51 #pragma weak pthread_cond_signal
52 #define pthread_cond_signal(cv) do {\
53           if (pthread_cond_signal) pthread_cond_signal(cv);\
54           } while(0)
55 #pragma weak pthread_cond_wait
56 #define pthread_cond_wait(cv, mtx) do {\
57           if (pthread_cond_wait) pthread_cond_wait(cv, mtx);\
58           } while(0)
59 #endif
60 
61 using namespace ABI_NAMESPACE;
62 
63 /**
64  * Saves the result of the landing pad that we have found.  For ARM, this is
65  * stored in the generic unwind structure, while on other platforms it is
66  * stored in the C++ exception.
67  */
saveLandingPad(struct _Unwind_Context * context,struct _Unwind_Exception * ucb,struct __cxa_exception * ex,int selector,dw_eh_ptr_t landingPad)68 static void saveLandingPad(struct _Unwind_Context *context,
69                            struct _Unwind_Exception *ucb,
70                            struct __cxa_exception *ex,
71                            int selector,
72                            dw_eh_ptr_t landingPad)
73 {
74 #if defined(__arm__) && !defined(__ARM_DWARF_EH__)
75           // On ARM, we store the saved exception in the generic part of the structure
76           ucb->barrier_cache.sp = _Unwind_GetGR(context, 13);
77           ucb->barrier_cache.bitpattern[1] = static_cast<uint32_t>(selector);
78           ucb->barrier_cache.bitpattern[3] = reinterpret_cast<uint32_t>(landingPad);
79 #endif
80           // Cache the results for the phase 2 unwind, if we found a handler
81           // and this is not a foreign exception.
82           if (ex)
83           {
84                     ex->handlerSwitchValue = selector;
85                     ex->catchTemp = landingPad;
86           }
87 }
88 
89 /**
90  * Loads the saved landing pad.  Returns 1 on success, 0 on failure.
91  */
loadLandingPad(struct _Unwind_Context * context,struct _Unwind_Exception * ucb,struct __cxa_exception * ex,unsigned long * selector,dw_eh_ptr_t * landingPad)92 static int loadLandingPad(struct _Unwind_Context *context,
93                           struct _Unwind_Exception *ucb,
94                           struct __cxa_exception *ex,
95                           unsigned long *selector,
96                           dw_eh_ptr_t *landingPad)
97 {
98 #if defined(__arm__) && !defined(__ARM_DWARF_EH__)
99           *selector = ucb->barrier_cache.bitpattern[1];
100           *landingPad = reinterpret_cast<dw_eh_ptr_t>(ucb->barrier_cache.bitpattern[3]);
101           return 1;
102 #else
103           if (ex)
104           {
105                     *selector = ex->handlerSwitchValue;
106                     *landingPad = reinterpret_cast<dw_eh_ptr_t>(ex->catchTemp);
107                     return 0;
108           }
109           return 0;
110 #endif
111 }
112 
continueUnwinding(struct _Unwind_Exception * ex,struct _Unwind_Context * context)113 static inline _Unwind_Reason_Code continueUnwinding(struct _Unwind_Exception *ex,
114                                                     struct _Unwind_Context *context)
115 {
116 #if defined(__arm__) && !defined(__ARM_DWARF_EH__)
117           if (__gnu_unwind_frame(ex, context) != _URC_OK) { return _URC_FAILURE; }
118 #endif
119           return _URC_CONTINUE_UNWIND;
120 }
121 
122 
123 extern "C" void __cxa_free_exception(void *thrown_exception);
124 extern "C" void __cxa_free_dependent_exception(void *thrown_exception);
125 extern "C" void* __dynamic_cast(const void *sub,
126                                 const __class_type_info *src,
127                                 const __class_type_info *dst,
128                                 ptrdiff_t src2dst_offset);
129 
130 /**
131  * The type of a handler that has been found.
132  */
133 typedef enum
134 {
135           /** No handler. */
136           handler_none,
137           /**
138            * A cleanup - the exception will propagate through this frame, but code
139            * must be run when this happens.
140            */
141           handler_cleanup,
142           /**
143            * A catch statement.  The exception will not propagate past this frame
144            * (without an explicit rethrow).
145            */
146           handler_catch
147 } handler_type;
148 
149 /**
150  * Per-thread info required by the runtime.  We store a single structure
151  * pointer in thread-local storage, because this tends to be a scarce resource
152  * and it's impolite to steal all of it and not leave any for the rest of the
153  * program.
154  *
155  * Instances of this structure are allocated lazily - at most one per thread -
156  * and are destroyed on thread termination.
157  */
158 struct __cxa_thread_info
159 {
160           /** The termination handler for this thread. */
161           terminate_handler terminateHandler;
162           /** The unexpected exception handler for this thread. */
163           unexpected_handler unexpectedHandler;
164           /**
165            * The number of emergency buffers held by this thread.  This is 0 in
166            * normal operation - the emergency buffers are only used when malloc()
167            * fails to return memory for allocating an exception.  Threads are not
168            * permitted to hold more than 4 emergency buffers (as per recommendation
169            * in ABI spec [3.3.1]).
170            */
171           int emergencyBuffersHeld;
172           /**
173            * The exception currently running in a cleanup.
174            */
175           _Unwind_Exception *currentCleanup;
176           /**
177            * Our state with respect to foreign exceptions.  Usually none, set to
178            * caught if we have just caught an exception and rethrown if we are
179            * rethrowing it.
180            */
181           enum
182           {
183                     none,
184                     caught,
185                     rethrown
186           } foreign_exception_state;
187           /**
188            * The public part of this structure, accessible from outside of this
189            * module.
190            */
191           __cxa_eh_globals globals;
192 };
193 /**
194  * Dependent exception.  This
195  */
196 struct __cxa_dependent_exception
197 {
198 #if __LP64__
199           void *primaryException;
200 #endif
201           std::type_info *exceptionType;
202           void (*exceptionDestructor) (void *);
203           unexpected_handler unexpectedHandler;
204           terminate_handler terminateHandler;
205           __cxa_exception *nextException;
206           int handlerCount;
207 #if defined(__arm__) && !defined(__ARM_DWARF_EH__)
208           _Unwind_Exception *nextCleanup;
209           int cleanupCount;
210 #endif
211           int handlerSwitchValue;
212           const char *actionRecord;
213           const char *languageSpecificData;
214           void *catchTemp;
215           void *adjustedPtr;
216 #if !__LP64__
217           void *primaryException;
218 #endif
219           _Unwind_Exception unwindHeader;
220 };
221 
222 
223 namespace std
224 {
225           void unexpected();
226           class exception
227           {
228                     public:
229                               virtual ~exception() throw();
230                               virtual const char* what() const throw();
231           };
232 
233 }
234 
235 /**
236  * Class of exceptions to distinguish between this and other exception types.
237  *
238  * The first four characters are the vendor ID.  Currently, we use GNUC,
239  * because we aim for ABI-compatibility with the GNU implementation, and
240  * various checks may test for equality of the class, which is incorrect.
241  */
242 static const uint64_t exception_class =
243           EXCEPTION_CLASS('G', 'N', 'U', 'C', 'C', '+', '+', '\0');
244 /**
245  * Class used for dependent exceptions.
246  */
247 static const uint64_t dependent_exception_class =
248           EXCEPTION_CLASS('G', 'N', 'U', 'C', 'C', '+', '+', '\x01');
249 /**
250  * The low four bytes of the exception class, indicating that we conform to the
251  * Itanium C++ ABI.  This is currently unused, but should be used in the future
252  * if we change our exception class, to allow this library and libsupc++ to be
253  * linked to the same executable and both to interoperate.
254  */
255 static const uint32_t abi_exception_class =
256           GENERIC_EXCEPTION_CLASS('C', '+', '+', '\0');
257 
isCXXException(uint64_t cls)258 static bool isCXXException(uint64_t cls)
259 {
260           return (cls == exception_class) || (cls == dependent_exception_class);
261 }
262 
isDependentException(uint64_t cls)263 static bool isDependentException(uint64_t cls)
264 {
265           return cls == dependent_exception_class;
266 }
267 
exceptionFromPointer(void * ex)268 static __cxa_exception *exceptionFromPointer(void *ex)
269 {
270           return reinterpret_cast<__cxa_exception*>(static_cast<char*>(ex) -
271                               offsetof(struct __cxa_exception, unwindHeader));
272 }
realExceptionFromException(__cxa_exception * ex)273 static __cxa_exception *realExceptionFromException(__cxa_exception *ex)
274 {
275           if (!isDependentException(ex->unwindHeader.exception_class)) { return ex; }
276           return reinterpret_cast<__cxa_exception*>((reinterpret_cast<__cxa_dependent_exception*>(ex))->primaryException)-1;
277 }
278 
279 
280 namespace std
281 {
282           // Forward declaration of standard library terminate() function used to
283           // abort execution.
284           void terminate(void);
285 }
286 
287 using namespace ABI_NAMESPACE;
288 
289 
290 
291 /** The global termination handler. */
292 static terminate_handler terminateHandler = abort;
293 /** The global unexpected exception handler. */
294 static unexpected_handler unexpectedHandler = std::terminate;
295 
296 /** Key used for thread-local data. */
297 static pthread_key_t eh_key;
298 
299 
300 /**
301  * Cleanup function, allowing foreign exception handlers to correctly destroy
302  * this exception if they catch it.
303  */
exception_cleanup(_Unwind_Reason_Code reason,struct _Unwind_Exception * ex)304 static void exception_cleanup(_Unwind_Reason_Code reason,
305                               struct _Unwind_Exception *ex)
306 {
307           // Exception layout:
308           // [__cxa_exception [_Unwind_Exception]] [exception object]
309           //
310           // __cxa_free_exception expects a pointer to the exception object
311           __cxa_free_exception(static_cast<void*>(ex + 1));
312 }
dependent_exception_cleanup(_Unwind_Reason_Code reason,struct _Unwind_Exception * ex)313 static void dependent_exception_cleanup(_Unwind_Reason_Code reason,
314                               struct _Unwind_Exception *ex)
315 {
316 
317           __cxa_free_dependent_exception(static_cast<void*>(ex + 1));
318 }
319 
320 /**
321  * Recursively walk a list of exceptions and delete them all in post-order.
322  */
free_exception_list(__cxa_exception * ex)323 static void free_exception_list(__cxa_exception *ex)
324 {
325           if (0 != ex->nextException)
326           {
327                     free_exception_list(ex->nextException);
328           }
329           // __cxa_free_exception() expects to be passed the thrown object, which
330           // immediately follows the exception, not the exception itself
331           __cxa_free_exception(ex+1);
332 }
333 
334 /**
335  * Cleanup function called when a thread exists to make certain that all of the
336  * per-thread data is deleted.
337  */
thread_cleanup(void * thread_info)338 static void thread_cleanup(void* thread_info)
339 {
340           __cxa_thread_info *info = static_cast<__cxa_thread_info*>(thread_info);
341           if (info->globals.caughtExceptions)
342           {
343                     // If this is a foreign exception, ask it to clean itself up.
344                     if (info->foreign_exception_state != __cxa_thread_info::none)
345                     {
346                               _Unwind_Exception *e = reinterpret_cast<_Unwind_Exception*>(info->globals.caughtExceptions);
347                               if (e->exception_cleanup)
348                                         e->exception_cleanup(_URC_FOREIGN_EXCEPTION_CAUGHT, e);
349                     }
350                     else
351                     {
352                               free_exception_list(info->globals.caughtExceptions);
353                     }
354           }
355           free(thread_info);
356 }
357 
358 
359 /**
360  * Once control used to protect the key creation.
361  */
362 static pthread_once_t once_control = PTHREAD_ONCE_INIT;
363 
364 /**
365  * We may not be linked against a full pthread implementation.  If we're not,
366  * then we need to fake the thread-local storage by storing 'thread-local'
367  * things in a global.
368  */
369 static bool fakeTLS;
370 /**
371  * Thread-local storage for a single-threaded program.
372  */
373 static __cxa_thread_info singleThreadInfo;
374 /**
375  * Initialise eh_key.
376  */
init_key(void)377 static void init_key(void)
378 {
379           if ((0 == pthread_key_create) ||
380               (0 == pthread_setspecific) ||
381               (0 == pthread_getspecific))
382           {
383                     fakeTLS = true;
384                     return;
385           }
386           pthread_key_create(&eh_key, thread_cleanup);
387           pthread_setspecific(eh_key, reinterpret_cast<void *>(0x42));
388           fakeTLS = (pthread_getspecific(eh_key) != reinterpret_cast<void *>(0x42));
389           pthread_setspecific(eh_key, 0);
390 }
391 
392 /**
393  * Returns the thread info structure, creating it if it is not already created.
394  */
thread_info()395 static __cxa_thread_info *thread_info()
396 {
397           if ((0 == pthread_once) || pthread_once(&once_control, init_key))
398           {
399                     fakeTLS = true;
400           }
401           if (fakeTLS) { return &singleThreadInfo; }
402           __cxa_thread_info *info = static_cast<__cxa_thread_info*>(pthread_getspecific(eh_key));
403           if (0 == info)
404           {
405                     info = static_cast<__cxa_thread_info*>(calloc(1, sizeof(__cxa_thread_info)));
406                     pthread_setspecific(eh_key, info);
407           }
408           return info;
409 }
410 /**
411  * Fast version of thread_info().  May fail if thread_info() is not called on
412  * this thread at least once already.
413  */
thread_info_fast()414 static __cxa_thread_info *thread_info_fast()
415 {
416           if (fakeTLS) { return &singleThreadInfo; }
417           return static_cast<__cxa_thread_info*>(pthread_getspecific(eh_key));
418 }
419 /**
420  * ABI function returning the __cxa_eh_globals structure.
421  */
__cxa_get_globals(void)422 extern "C" __cxa_eh_globals *ABI_NAMESPACE::__cxa_get_globals(void)
423 {
424           return &(thread_info()->globals);
425 }
426 /**
427  * Version of __cxa_get_globals() assuming that __cxa_get_globals() has already
428  * been called at least once by this thread.
429  */
__cxa_get_globals_fast(void)430 extern "C" __cxa_eh_globals *ABI_NAMESPACE::__cxa_get_globals_fast(void)
431 {
432           return &(thread_info_fast()->globals);
433 }
434 
435 /**
436  * An emergency allocation reserved for when malloc fails.  This is treated as
437  * 16 buffers of 1KB each.
438  */
439 static char emergency_buffer[16384];
440 /**
441  * Flag indicating whether each buffer is allocated.
442  */
443 static bool buffer_allocated[16];
444 /**
445  * Lock used to protect emergency allocation.
446  */
447 static pthread_mutex_t emergency_malloc_lock = PTHREAD_MUTEX_INITIALIZER;
448 /**
449  * Condition variable used to wait when two threads are both trying to use the
450  * emergency malloc() buffer at once.
451  */
452 static pthread_cond_t emergency_malloc_wait = PTHREAD_COND_INITIALIZER;
453 
454 /**
455  * Allocates size bytes from the emergency allocation mechanism, if possible.
456  * This function will fail if size is over 1KB or if this thread already has 4
457  * emergency buffers.  If all emergency buffers are allocated, it will sleep
458  * until one becomes available.
459  */
emergency_malloc(size_t size)460 static char *emergency_malloc(size_t size)
461 {
462           if (size > 1024) { return 0; }
463 
464           __cxa_thread_info *info = thread_info();
465           // Only 4 emergency buffers allowed per thread!
466           if (info->emergencyBuffersHeld > 3) { return 0; }
467 
468           pthread_mutex_lock(&emergency_malloc_lock);
469           int buffer = -1;
470           while (buffer < 0)
471           {
472                     // While we were sleeping on the lock, another thread might have free'd
473                     // enough memory for us to use, so try the allocation again - no point
474                     // using the emergency buffer if there is some real memory that we can
475                     // use...
476                     void *m = calloc(1, size);
477                     if (0 != m)
478                     {
479                               pthread_mutex_unlock(&emergency_malloc_lock);
480                               return static_cast<char*>(m);
481                     }
482                     for (int i=0 ; i<16 ; i++)
483                     {
484                               if (!buffer_allocated[i])
485                               {
486                                         buffer = i;
487                                         buffer_allocated[i] = true;
488                                         break;
489                               }
490                     }
491                     // If there still isn't a buffer available, then sleep on the condition
492                     // variable.  This will be signalled when another thread releases one
493                     // of the emergency buffers.
494                     if (buffer < 0)
495                     {
496                               pthread_cond_wait(&emergency_malloc_wait, &emergency_malloc_lock);
497                     }
498           }
499           pthread_mutex_unlock(&emergency_malloc_lock);
500           info->emergencyBuffersHeld++;
501           return emergency_buffer + (1024 * buffer);
502 }
503 
504 /**
505  * Frees a buffer returned by emergency_malloc().
506  *
507  * Note: Neither this nor emergency_malloc() is particularly efficient.  This
508  * should not matter, because neither will be called in normal operation - they
509  * are only used when the program runs out of memory, which should not happen
510  * often.
511  */
emergency_malloc_free(char * ptr)512 static void emergency_malloc_free(char *ptr)
513 {
514           int buffer = -1;
515           // Find the buffer corresponding to this pointer.
516           for (int i=0 ; i<16 ; i++)
517           {
518                     if (ptr == static_cast<void*>(emergency_buffer + (1024 * i)))
519                     {
520                               buffer = i;
521                               break;
522                     }
523           }
524           assert(buffer >= 0 &&
525                  "Trying to free something that is not an emergency buffer!");
526           // emergency_malloc() is expected to return 0-initialized data.  We don't
527           // zero the buffer when allocating it, because the static buffers will
528           // begin life containing 0 values.
529           memset(ptr, 0, 1024);
530           // Signal the condition variable to wake up any threads that are blocking
531           // waiting for some space in the emergency buffer
532           pthread_mutex_lock(&emergency_malloc_lock);
533           // In theory, we don't need to do this with the lock held.  In practice,
534           // our array of bools will probably be updated using 32-bit or 64-bit
535           // memory operations, so this update may clobber adjacent values.
536           buffer_allocated[buffer] = false;
537           pthread_cond_signal(&emergency_malloc_wait);
538           pthread_mutex_unlock(&emergency_malloc_lock);
539 }
540 
alloc_or_die(size_t size)541 static char *alloc_or_die(size_t size)
542 {
543           char *buffer = static_cast<char*>(calloc(1, size));
544 
545           // If calloc() doesn't want to give us any memory, try using an emergency
546           // buffer.
547           if (0 == buffer)
548           {
549                     buffer = emergency_malloc(size);
550                     // This is only reached if the allocation is greater than 1KB, and
551                     // anyone throwing objects that big really should know better.
552                     if (0 == buffer)
553                     {
554                               fprintf(stderr, "Out of memory attempting to allocate exception\n");
555                               std::terminate();
556                     }
557           }
558           return buffer;
559 }
free_exception(char * e)560 static void free_exception(char *e)
561 {
562           // If this allocation is within the address range of the emergency buffer,
563           // don't call free() because it was not allocated with malloc()
564           if ((e >= emergency_buffer) &&
565               (e < (emergency_buffer + sizeof(emergency_buffer))))
566           {
567                     emergency_malloc_free(e);
568           }
569           else
570           {
571                     free(e);
572           }
573 }
574 
575 /**
576  * Allocates an exception structure.  Returns a pointer to the space that can
577  * be used to store an object of thrown_size bytes.  This function will use an
578  * emergency buffer if malloc() fails, and may block if there are no such
579  * buffers available.
580  */
__cxa_allocate_exception(size_t thrown_size)581 extern "C" void *__cxa_allocate_exception(size_t thrown_size)
582 {
583           size_t size = thrown_size + sizeof(__cxa_exception);
584           char *buffer = alloc_or_die(size);
585           return buffer+sizeof(__cxa_exception);
586 }
587 
__cxa_allocate_dependent_exception(void)588 extern "C" void *__cxa_allocate_dependent_exception(void)
589 {
590           size_t size = sizeof(__cxa_dependent_exception);
591           char *buffer = alloc_or_die(size);
592           return buffer+sizeof(__cxa_dependent_exception);
593 }
594 
595 /**
596  * __cxa_free_exception() is called when an exception was thrown in between
597  * calling __cxa_allocate_exception() and actually throwing the exception.
598  * This happens when the object's copy constructor throws an exception.
599  *
600  * In this implementation, it is also called by __cxa_end_catch() and during
601  * thread cleanup.
602  */
__cxa_free_exception(void * thrown_exception)603 extern "C" void __cxa_free_exception(void *thrown_exception)
604 {
605           __cxa_exception *ex = reinterpret_cast<__cxa_exception*>(thrown_exception) - 1;
606           // Free the object that was thrown, calling its destructor
607           if (0 != ex->exceptionDestructor)
608           {
609                     try
610                     {
611                               ex->exceptionDestructor(thrown_exception);
612                     }
613                     catch(...)
614                     {
615                               // FIXME: Check that this is really what the spec says to do.
616                               std::terminate();
617                     }
618           }
619 
620           free_exception(reinterpret_cast<char*>(ex));
621 }
622 
releaseException(__cxa_exception * exception)623 static void releaseException(__cxa_exception *exception)
624 {
625           if (isDependentException(exception->unwindHeader.exception_class))
626           {
627                     __cxa_free_dependent_exception(exception+1);
628                     return;
629           }
630           if (__sync_sub_and_fetch(&exception->referenceCount, 1) == 0)
631           {
632                     // __cxa_free_exception() expects to be passed the thrown object,
633                     // which immediately follows the exception, not the exception
634                     // itself
635                     __cxa_free_exception(exception+1);
636           }
637 }
638 
__cxa_free_dependent_exception(void * thrown_exception)639 void __cxa_free_dependent_exception(void *thrown_exception)
640 {
641           __cxa_dependent_exception *ex = reinterpret_cast<__cxa_dependent_exception*>(thrown_exception) - 1;
642           assert(isDependentException(ex->unwindHeader.exception_class));
643           if (ex->primaryException)
644           {
645                     releaseException(realExceptionFromException(reinterpret_cast<__cxa_exception*>(ex)));
646           }
647           free_exception(reinterpret_cast<char*>(ex));
648 }
649 
650 /**
651  * Callback function used with _Unwind_Backtrace().
652  *
653  * Prints a stack trace.  Used only for debugging help.
654  *
655  * Note: As of FreeBSD 8.1, dladd() still doesn't work properly, so this only
656  * correctly prints function names from public, relocatable, symbols.
657  */
trace(struct _Unwind_Context * context,void * c)658 static _Unwind_Reason_Code trace(struct _Unwind_Context *context, void *c)
659 {
660           Dl_info myinfo;
661           int mylookup =
662                     dladdr(reinterpret_cast<void *>(__cxa_current_exception_type), &myinfo);
663           void *ip = reinterpret_cast<void*>(_Unwind_GetIP(context));
664           Dl_info info;
665           if (dladdr(ip, &info) != 0)
666           {
667                     if (mylookup == 0 || strcmp(info.dli_fname, myinfo.dli_fname) != 0)
668                     {
669                               printf("%p:%s() in %s\n", ip, info.dli_sname, info.dli_fname);
670                     }
671           }
672           return _URC_CONTINUE_UNWIND;
673 }
674 
675 /**
676  * Report a failure that occurred when attempting to throw an exception.
677  *
678  * If the failure happened by falling off the end of the stack without finding
679  * a handler, prints a back trace before aborting.
680  */
681 #if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4)
682 extern "C" void *__cxa_begin_catch(void *e) throw();
683 #else
684 extern "C" void *__cxa_begin_catch(void *e);
685 #endif
report_failure(_Unwind_Reason_Code err,__cxa_exception * thrown_exception)686 static void report_failure(_Unwind_Reason_Code err, __cxa_exception *thrown_exception)
687 {
688           switch (err)
689           {
690                     default: break;
691                     case _URC_FATAL_PHASE1_ERROR:
692                               fprintf(stderr, "Fatal error during phase 1 unwinding\n");
693                               break;
694 #if !defined(__arm__) || defined(__ARM_DWARF_EH__)
695                     case _URC_FATAL_PHASE2_ERROR:
696                               fprintf(stderr, "Fatal error during phase 2 unwinding\n");
697                               break;
698 #endif
699                     case _URC_END_OF_STACK:
700                               __cxa_begin_catch (&(thrown_exception->unwindHeader));
701                               std::terminate();
702                               fprintf(stderr, "Terminating due to uncaught exception %p",
703                                                   static_cast<void*>(thrown_exception));
704                               thrown_exception = realExceptionFromException(thrown_exception);
705                               static const __class_type_info *e_ti =
706                                         static_cast<const __class_type_info*>(&typeid(std::exception));
707                               const __class_type_info *throw_ti =
708                                         dynamic_cast<const __class_type_info*>(thrown_exception->exceptionType);
709                               if (throw_ti)
710                               {
711                                         std::exception *e =
712                                                   static_cast<std::exception*>(e_ti->cast_to(static_cast<void*>(thrown_exception+1),
713                                                                       throw_ti));
714                                         if (e)
715                                         {
716                                                   fprintf(stderr, " '%s'", e->what());
717                                         }
718                               }
719 
720                               size_t bufferSize = 128;
721                               char *demangled = static_cast<char*>(malloc(bufferSize));
722                               const char *mangled = thrown_exception->exceptionType->name();
723                               int status;
724                               demangled = __cxa_demangle(mangled, demangled, &bufferSize, &status);
725                               fprintf(stderr, " of type %s\n",
726                                         status == 0 ? demangled : mangled);
727                               if (status == 0) { free(demangled); }
728                               // Print a back trace if no handler is found.
729                               // TODO: Make this optional
730                               _Unwind_Backtrace(trace, 0);
731 
732                               // Just abort. No need to call std::terminate for the second time
733                               abort();
734                               break;
735           }
736           std::terminate();
737 }
738 
throw_exception(__cxa_exception * ex)739 static void throw_exception(__cxa_exception *ex)
740 {
741           __cxa_thread_info *info = thread_info();
742           ex->unexpectedHandler = info->unexpectedHandler;
743           if (0 == ex->unexpectedHandler)
744           {
745                     ex->unexpectedHandler = unexpectedHandler;
746           }
747           ex->terminateHandler  = info->terminateHandler;
748           if (0 == ex->terminateHandler)
749           {
750                     ex->terminateHandler = terminateHandler;
751           }
752           info->globals.uncaughtExceptions++;
753 
754           _Unwind_Reason_Code err = _Unwind_RaiseException(&ex->unwindHeader);
755           // The _Unwind_RaiseException() function should not return, it should
756           // unwind the stack past this function.  If it does return, then something
757           // has gone wrong.
758           report_failure(err, ex);
759 }
760 
761 
762 /**
763  * ABI function for throwing an exception.  Takes the object to be thrown (the
764  * pointer returned by __cxa_allocate_exception()), the type info for the
765  * pointee, and the destructor (if there is one) as arguments.
766  */
__cxa_throw(void * thrown_exception,std::type_info * tinfo,void (* dest)(void *))767 extern "C" void __cxa_throw(void *thrown_exception,
768                             std::type_info *tinfo,
769                             void(*dest)(void*))
770 {
771           __cxa_exception *ex = reinterpret_cast<__cxa_exception*>(thrown_exception) - 1;
772 
773           ex->referenceCount = 1;
774           ex->exceptionType = tinfo;
775 
776           ex->exceptionDestructor = dest;
777 
778           ex->unwindHeader.exception_class = exception_class;
779           ex->unwindHeader.exception_cleanup = exception_cleanup;
780 
781           throw_exception(ex);
782 }
783 
__cxa_rethrow_primary_exception(void * thrown_exception)784 extern "C" void __cxa_rethrow_primary_exception(void* thrown_exception)
785 {
786           if (NULL == thrown_exception) { return; }
787 
788           __cxa_exception *original = exceptionFromPointer(thrown_exception);
789           __cxa_dependent_exception *ex = reinterpret_cast<__cxa_dependent_exception*>(__cxa_allocate_dependent_exception())-1;
790 
791           ex->primaryException = thrown_exception;
792           __cxa_increment_exception_refcount(thrown_exception);
793 
794           ex->exceptionType = original->exceptionType;
795           ex->unwindHeader.exception_class = dependent_exception_class;
796           ex->unwindHeader.exception_cleanup = dependent_exception_cleanup;
797 
798           throw_exception(reinterpret_cast<__cxa_exception*>(ex));
799 }
800 
__cxa_current_primary_exception(void)801 extern "C" void *__cxa_current_primary_exception(void)
802 {
803           __cxa_eh_globals* globals = __cxa_get_globals();
804           __cxa_exception *ex = globals->caughtExceptions;
805 
806           if (0 == ex) { return NULL; }
807           ex = realExceptionFromException(ex);
808           __sync_fetch_and_add(&ex->referenceCount, 1);
809           return ex + 1;
810 }
811 
__cxa_increment_exception_refcount(void * thrown_exception)812 extern "C" void __cxa_increment_exception_refcount(void* thrown_exception)
813 {
814           if (NULL == thrown_exception) { return; }
815           __cxa_exception *ex = static_cast<__cxa_exception*>(thrown_exception) - 1;
816           if (isDependentException(ex->unwindHeader.exception_class)) { return; }
817           __sync_fetch_and_add(&ex->referenceCount, 1);
818 }
__cxa_decrement_exception_refcount(void * thrown_exception)819 extern "C" void __cxa_decrement_exception_refcount(void* thrown_exception)
820 {
821           if (NULL == thrown_exception) { return; }
822           __cxa_exception *ex = static_cast<__cxa_exception*>(thrown_exception) - 1;
823           releaseException(ex);
824 }
825 
826 /**
827  * ABI function.  Rethrows the current exception.  Does not remove the
828  * exception from the stack or decrement its handler count - the compiler is
829  * expected to set the landing pad for this function to the end of the catch
830  * block, and then call _Unwind_Resume() to continue unwinding once
831  * __cxa_end_catch() has been called and any cleanup code has been run.
832  */
__cxa_rethrow()833 extern "C" void __cxa_rethrow()
834 {
835           __cxa_thread_info *ti = thread_info();
836           __cxa_eh_globals *globals = &ti->globals;
837           // Note: We don't remove this from the caught list here, because
838           // __cxa_end_catch will be called when we unwind out of the try block.  We
839           // could probably make this faster by providing an alternative rethrow
840           // function and ensuring that all cleanup code is run before calling it, so
841           // we can skip the top stack frame when unwinding.
842           __cxa_exception *ex = globals->caughtExceptions;
843 
844           if (0 == ex)
845           {
846                     fprintf(stderr,
847                             "Attempting to rethrow an exception that doesn't exist!\n");
848                     std::terminate();
849           }
850 
851           if (ti->foreign_exception_state != __cxa_thread_info::none)
852           {
853                     ti->foreign_exception_state = __cxa_thread_info::rethrown;
854                     _Unwind_Exception *e = reinterpret_cast<_Unwind_Exception*>(ex);
855                     _Unwind_Reason_Code err = _Unwind_Resume_or_Rethrow(e);
856                     report_failure(err, ex);
857                     return;
858           }
859 
860           assert(ex->handlerCount > 0 && "Rethrowing uncaught exception!");
861 
862           // `globals->uncaughtExceptions` was decremented by `__cxa_begin_catch`.
863           // It's normally incremented by `throw_exception`, but this path invokes
864           // `_Unwind_Resume_or_Rethrow` directly to rethrow the exception.
865           // This path is only reachable if we're rethrowing a C++ exception -
866           // foreign exceptions don't adjust any of this state.
867           globals->uncaughtExceptions++;
868 
869           // ex->handlerCount will be decremented in __cxa_end_catch in enclosing
870           // catch block
871 
872           // Make handler count negative. This will tell __cxa_end_catch that
873           // exception was rethrown and exception object should not be destroyed
874           // when handler count become zero
875           ex->handlerCount = -ex->handlerCount;
876 
877           // Continue unwinding the stack with this exception.  This should unwind to
878           // the place in the caller where __cxa_end_catch() is called.  The caller
879           // will then run cleanup code and bounce the exception back with
880           // _Unwind_Resume().
881           _Unwind_Reason_Code err = _Unwind_Resume_or_Rethrow(&ex->unwindHeader);
882           report_failure(err, ex);
883 }
884 
885 /**
886  * Returns the type_info object corresponding to the filter.
887  */
get_type_info_entry(_Unwind_Context * context,dwarf_eh_lsda * lsda,int filter)888 static std::type_info *get_type_info_entry(_Unwind_Context *context,
889                                            dwarf_eh_lsda *lsda,
890                                            int filter)
891 {
892           // Get the address of the record in the table.
893           dw_eh_ptr_t record = lsda->type_table -
894                     dwarf_size_of_fixed_size_field(lsda->type_table_encoding)*filter;
895           //record -= 4;
896           dw_eh_ptr_t start = record;
897           // Read the value, but it's probably an indirect reference...
898           int64_t offset = read_value(lsda->type_table_encoding, &record);
899 
900           // (If the entry is 0, don't try to dereference it.  That would be bad.)
901           if (offset == 0) { return 0; }
902 
903           // ...so we need to resolve it
904           return reinterpret_cast<std::type_info*>(resolve_indirect_value(context,
905                               lsda->type_table_encoding, offset, start));
906 }
907 
908 
909 
910 /**
911  * Checks the type signature found in a handler against the type of the thrown
912  * object.  If ex is 0 then it is assumed to be a foreign exception and only
913  * matches cleanups.
914  */
check_type_signature(__cxa_exception * ex,const std::type_info * type,void * & adjustedPtr)915 static bool check_type_signature(__cxa_exception *ex,
916                                  const std::type_info *type,
917                                  void *&adjustedPtr)
918 {
919           void *exception_ptr = static_cast<void*>(ex+1);
920           const std::type_info *ex_type = ex ? ex->exceptionType : 0;
921 
922           bool is_ptr = ex ? ex_type->__is_pointer_p() : false;
923           if (is_ptr)
924           {
925                     exception_ptr = *static_cast<void**>(exception_ptr);
926           }
927           // Always match a catchall, even with a foreign exception
928           //
929           // Note: A 0 here is a catchall, not a cleanup, so we return true to
930           // indicate that we found a catch.
931           if (0 == type)
932           {
933                     if (ex)
934                     {
935                               adjustedPtr = exception_ptr;
936                     }
937                     return true;
938           }
939 
940           if (0 == ex) { return false; }
941 
942           // If the types are the same, no casting is needed.
943           if (*type == *ex_type)
944           {
945                     adjustedPtr = exception_ptr;
946                     return true;
947           }
948 
949 
950           if (type->__do_catch(ex_type, &exception_ptr, 1))
951           {
952                     adjustedPtr = exception_ptr;
953                     return true;
954           }
955 
956           return false;
957 }
958 /**
959  * Checks whether the exception matches the type specifiers in this action
960  * record.  If the exception only matches cleanups, then this returns false.
961  * If it matches a catch (including a catchall) then it returns true.
962  *
963  * The selector argument is used to return the selector that is passed in the
964  * second exception register when installing the context.
965  */
check_action_record(_Unwind_Context * context,dwarf_eh_lsda * lsda,dw_eh_ptr_t action_record,__cxa_exception * ex,unsigned long * selector,void * & adjustedPtr)966 static handler_type check_action_record(_Unwind_Context *context,
967                                         dwarf_eh_lsda *lsda,
968                                         dw_eh_ptr_t action_record,
969                                         __cxa_exception *ex,
970                                         unsigned long *selector,
971                                         void *&adjustedPtr)
972 {
973           if (!action_record) { return handler_cleanup; }
974           handler_type found = handler_none;
975           while (action_record)
976           {
977                     int filter = read_sleb128(&action_record);
978                     dw_eh_ptr_t action_record_offset_base = action_record;
979                     int displacement = read_sleb128(&action_record);
980                     action_record = displacement ?
981                               action_record_offset_base + displacement : 0;
982                     // We only check handler types for C++ exceptions - foreign exceptions
983                     // are only allowed for cleanups and catchalls.
984                     if (filter > 0)
985                     {
986                               std::type_info *handler_type = get_type_info_entry(context, lsda, filter);
987                               if (check_type_signature(ex, handler_type, adjustedPtr))
988                               {
989                                         *selector = filter;
990                                         return handler_catch;
991                               }
992                     }
993                     else if (filter < 0 && 0 != ex)
994                     {
995                               bool matched = false;
996                               *selector = filter;
997 #if defined(__arm__) && !defined(__ARM_DWARF_EH__)
998                               filter++;
999                               std::type_info *handler_type = get_type_info_entry(context, lsda, filter--);
1000                               while (handler_type)
1001                               {
1002                                         if (check_type_signature(ex, handler_type, adjustedPtr))
1003                                         {
1004                                                   matched = true;
1005                                                   break;
1006                                         }
1007                                         handler_type = get_type_info_entry(context, lsda, filter--);
1008                               }
1009 #else
1010                               unsigned char *type_index = reinterpret_cast<unsigned char*>(lsda->type_table) - filter - 1;
1011                               while (*type_index)
1012                               {
1013                                         std::type_info *handler_type = get_type_info_entry(context, lsda, *(type_index++));
1014                                         // If the exception spec matches a permitted throw type for
1015                                         // this function, don't report a handler - we are allowed to
1016                                         // propagate this exception out.
1017                                         if (check_type_signature(ex, handler_type, adjustedPtr))
1018                                         {
1019                                                   matched = true;
1020                                                   break;
1021                                         }
1022                               }
1023 #endif
1024                               if (matched) { continue; }
1025                               // If we don't find an allowed exception spec, we need to install
1026                               // the context for this action.  The landing pad will then call the
1027                               // unexpected exception function.  Treat this as a catch
1028                               return handler_catch;
1029                     }
1030                     else if (filter == 0)
1031                     {
1032                               *selector = filter;
1033                               found = handler_cleanup;
1034                     }
1035           }
1036           return found;
1037 }
1038 
pushCleanupException(_Unwind_Exception * exceptionObject,__cxa_exception * ex)1039 static void pushCleanupException(_Unwind_Exception *exceptionObject,
1040                                  __cxa_exception *ex)
1041 {
1042 #if defined(__arm__) && !defined(__ARM_DWARF_EH__)
1043           __cxa_thread_info *info = thread_info_fast();
1044           if (ex)
1045           {
1046                     ex->cleanupCount++;
1047                     if (ex->cleanupCount > 1)
1048                     {
1049                               assert(exceptionObject == info->currentCleanup);
1050                               return;
1051                     }
1052                     ex->nextCleanup = info->currentCleanup;
1053           }
1054           info->currentCleanup = exceptionObject;
1055 #endif
1056 }
1057 
1058 /**
1059  * The exception personality function.  This is referenced in the unwinding
1060  * DWARF metadata and is called by the unwind library for each C++ stack frame
1061  * containing catch or cleanup code.
1062  */
1063 extern "C"
1064 BEGIN_PERSONALITY_FUNCTION(__gxx_personality_v0)
1065           // This personality function is for version 1 of the ABI.  If you use it
1066           // with a future version of the ABI, it won't know what to do, so it
1067           // reports a fatal error and give up before it breaks anything.
1068           if (1 != version)
1069           {
1070                     return _URC_FATAL_PHASE1_ERROR;
1071           }
1072           __cxa_exception *ex = 0;
1073           __cxa_exception *realEx = 0;
1074 
1075           // If this exception is throw by something else then we can't make any
1076           // assumptions about its layout beyond the fields declared in
1077           // _Unwind_Exception.
1078           bool foreignException = !isCXXException(exceptionClass);
1079 
1080           // If this isn't a foreign exception, then we have a C++ exception structure
1081           if (!foreignException)
1082           {
1083                     ex = exceptionFromPointer(exceptionObject);
1084                     realEx = realExceptionFromException(ex);
1085           }
1086 
1087 #if defined(__arm__) && !defined(__ARM_DWARF_EH__)
1088           unsigned char *lsda_addr =
1089                     static_cast<unsigned char*>(_Unwind_GetLanguageSpecificData(context));
1090 #else
1091           unsigned char *lsda_addr =
1092                     reinterpret_cast<unsigned char*>(static_cast<uintptr_t>(_Unwind_GetLanguageSpecificData(context)));
1093 #endif
1094 
1095           // No LSDA implies no landing pads - try the next frame
1096           if (0 == lsda_addr) { return continueUnwinding(exceptionObject, context); }
1097 
1098           // These two variables define how the exception will be handled.
1099           dwarf_eh_action action = {0};
1100           unsigned long selector = 0;
1101 
1102           // During the search phase, we do a complete lookup.  If we return
1103           // _URC_HANDLER_FOUND, then the phase 2 unwind will call this function with
1104           // a _UA_HANDLER_FRAME action, telling us to install the handler frame.  If
1105           // we return _URC_CONTINUE_UNWIND, we may be called again later with a
1106           // _UA_CLEANUP_PHASE action for this frame.
1107           //
1108           // The point of the two-stage unwind allows us to entirely avoid any stack
1109           // unwinding if there is no handler.  If there are just cleanups found,
1110           // then we can just panic call an abort function.
1111           //
1112           // Matching a handler is much more expensive than matching a cleanup,
1113           // because we don't need to bother doing type comparisons (or looking at
1114           // the type table at all) for a cleanup.  This means that there is no need
1115           // to cache the result of finding a cleanup, because it's (quite) quick to
1116           // look it up again from the action table.
1117           if (actions & _UA_SEARCH_PHASE)
1118           {
1119                     struct dwarf_eh_lsda lsda = parse_lsda(context, lsda_addr);
1120 
1121                     if (!dwarf_eh_find_callsite(context, &lsda, &action))
1122                     {
1123                               // EH range not found. This happens if exception is thrown and not
1124                               // caught inside a cleanup (destructor).  We should call
1125                               // terminate() in this case.  The catchTemp (landing pad) field of
1126                               // exception object will contain null when personality function is
1127                               // called with _UA_HANDLER_FRAME action for phase 2 unwinding.
1128                               return _URC_HANDLER_FOUND;
1129                     }
1130 
1131                     handler_type found_handler = check_action_record(context, &lsda,
1132                                         action.action_record, realEx, &selector, ex->adjustedPtr);
1133                     // If there's no action record, we've only found a cleanup, so keep
1134                     // searching for something real
1135                     if (found_handler == handler_catch)
1136                     {
1137                               // Cache the results for the phase 2 unwind, if we found a handler
1138                               // and this is not a foreign exception.
1139                               if (ex)
1140                               {
1141                                         saveLandingPad(context, exceptionObject, ex, selector, action.landing_pad);
1142                                         ex->languageSpecificData = reinterpret_cast<const char*>(lsda_addr);
1143                                         ex->actionRecord = reinterpret_cast<const char*>(action.action_record);
1144                                         // ex->adjustedPtr is set when finding the action record.
1145                               }
1146                               return _URC_HANDLER_FOUND;
1147                     }
1148                     return continueUnwinding(exceptionObject, context);
1149           }
1150 
1151 
1152           // If this is a foreign exception, we didn't have anywhere to cache the
1153           // lookup stuff, so we need to do it again.  If this is either a forced
1154           // unwind, a foreign exception, or a cleanup, then we just install the
1155           // context for a cleanup.
1156           if (!(actions & _UA_HANDLER_FRAME))
1157           {
1158                     // cleanup
1159                     struct dwarf_eh_lsda lsda = parse_lsda(context, lsda_addr);
1160                     dwarf_eh_find_callsite(context, &lsda, &action);
1161                     if (0 == action.landing_pad) { return continueUnwinding(exceptionObject, context); }
1162                     handler_type found_handler = check_action_record(context, &lsda,
1163                                         action.action_record, realEx, &selector, ex->adjustedPtr);
1164                     // Ignore handlers this time.
1165                     if (found_handler != handler_cleanup) { return continueUnwinding(exceptionObject, context); }
1166                     pushCleanupException(exceptionObject, ex);
1167           }
1168           else if (foreignException)
1169           {
1170                     struct dwarf_eh_lsda lsda = parse_lsda(context, lsda_addr);
1171                     dwarf_eh_find_callsite(context, &lsda, &action);
1172                     check_action_record(context, &lsda, action.action_record, realEx,
1173                                         &selector, ex->adjustedPtr);
1174           }
1175           else if (ex->catchTemp == 0)
1176           {
1177                     // Uncaught exception in cleanup, calling terminate
1178                     std::terminate();
1179           }
1180           else
1181           {
1182                     // Restore the saved info if we saved some last time.
1183                     loadLandingPad(context, exceptionObject, ex, &selector, &action.landing_pad);
1184                     ex->catchTemp = 0;
1185                     ex->handlerSwitchValue = 0;
1186           }
1187 
1188 
1189           _Unwind_SetIP(context, reinterpret_cast<unsigned long>(action.landing_pad));
1190           _Unwind_SetGR(context, __builtin_eh_return_data_regno(0),
1191                         reinterpret_cast<unsigned long>(exceptionObject));
1192           _Unwind_SetGR(context, __builtin_eh_return_data_regno(1), selector);
1193 
1194           return _URC_INSTALL_CONTEXT;
1195 }
1196 
1197 /**
1198  * ABI function called when entering a catch statement.  The argument is the
1199  * pointer passed out of the personality function.  This is always the start of
1200  * the _Unwind_Exception object.  The return value for this function is the
1201  * pointer to the caught exception, which is either the adjusted pointer (for
1202  * C++ exceptions) of the unadjusted pointer (for foreign exceptions).
1203  */
1204 #if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4)
1205 extern "C" void *__cxa_begin_catch(void *e) throw()
1206 #else
1207 extern "C" void *__cxa_begin_catch(void *e)
1208 #endif
1209 {
1210           // We can't call the fast version here, because if the first exception that
1211           // we see is a foreign exception then we won't have called it yet.
1212           __cxa_thread_info *ti = thread_info();
1213           __cxa_eh_globals *globals = &ti->globals;
1214           _Unwind_Exception *exceptionObject = static_cast<_Unwind_Exception*>(e);
1215 
1216           if (isCXXException(exceptionObject->exception_class))
1217           {
1218                     // Only exceptions thrown with a C++ exception throwing function will
1219                     // increment this, so don't decrement it here.
1220                     globals->uncaughtExceptions--;
1221                     __cxa_exception *ex =  exceptionFromPointer(exceptionObject);
1222 
1223                     if (ex->handlerCount == 0)
1224                     {
1225                               // Add this to the front of the list of exceptions being handled
1226                               // and increment its handler count so that it won't be deleted
1227                               // prematurely.
1228                               ex->nextException = globals->caughtExceptions;
1229                               globals->caughtExceptions = ex;
1230                     }
1231 
1232                     if (ex->handlerCount < 0)
1233                     {
1234                               // Rethrown exception is catched before end of catch block.
1235                               // Clear the rethrow flag (make value positive) - we are allowed
1236                               // to delete this exception at the end of the catch block, as long
1237                               // as it isn't thrown again later.
1238 
1239                               // Code pattern:
1240                               //
1241                               // try {
1242                               //     throw x;
1243                               // }
1244                               // catch() {
1245                               //     try {
1246                               //         throw;
1247                               //     }
1248                               //     catch() {
1249                               //         __cxa_begin_catch() <- we are here
1250                               //     }
1251                               // }
1252                               ex->handlerCount = -ex->handlerCount + 1;
1253                     }
1254                     else
1255                     {
1256                               ex->handlerCount++;
1257                     }
1258                     ti->foreign_exception_state = __cxa_thread_info::none;
1259 
1260                     return ex->adjustedPtr;
1261           }
1262           else
1263           {
1264                     // If this is a foreign exception, then we need to be able to
1265                     // store it.  We can't chain foreign exceptions, so we give up
1266                     // if there are already some outstanding ones.
1267                     if (globals->caughtExceptions != 0)
1268                     {
1269                               std::terminate();
1270                     }
1271                     globals->caughtExceptions = reinterpret_cast<__cxa_exception*>(exceptionObject);
1272                     ti->foreign_exception_state = __cxa_thread_info::caught;
1273           }
1274           // exceptionObject is the pointer to the _Unwind_Exception within the
1275           // __cxa_exception.  The throw object is after this
1276           return (reinterpret_cast<char*>(exceptionObject) + sizeof(_Unwind_Exception));
1277 }
1278 
1279 
1280 
1281 /**
1282  * ABI function called when exiting a catch block.  This will free the current
1283  * exception if it is no longer referenced in other catch blocks.
1284  */
1285 extern "C" void __cxa_end_catch()
1286 {
1287           // We can call the fast version here because the slow version is called in
1288           // __cxa_throw(), which must have been called before we end a catch block
1289           __cxa_thread_info *ti = thread_info_fast();
1290           __cxa_eh_globals *globals = &ti->globals;
1291           __cxa_exception *ex = globals->caughtExceptions;
1292 
1293           assert(0 != ex && "Ending catch when no exception is on the stack!");
1294 
1295           if (ti->foreign_exception_state != __cxa_thread_info::none)
1296           {
1297                     if (ti->foreign_exception_state != __cxa_thread_info::rethrown)
1298                     {
1299                               _Unwind_Exception *e = reinterpret_cast<_Unwind_Exception*>(ti->globals.caughtExceptions);
1300                               if (e->exception_cleanup)
1301                                         e->exception_cleanup(_URC_FOREIGN_EXCEPTION_CAUGHT, e);
1302                     }
1303                     globals->caughtExceptions = 0;
1304                     ti->foreign_exception_state = __cxa_thread_info::none;
1305                     return;
1306           }
1307 
1308           bool deleteException = true;
1309 
1310           if (ex->handlerCount < 0)
1311           {
1312                     // exception was rethrown. Exception should not be deleted even if
1313                     // handlerCount become zero.
1314                     // Code pattern:
1315                     // try {
1316                     //     throw x;
1317                     // }
1318                     // catch() {
1319                     //     {
1320                     //         throw;
1321                     //     }
1322                     //     cleanup {
1323                     //         __cxa_end_catch();   <- we are here
1324                     //     }
1325                     // }
1326                     //
1327 
1328                     ex->handlerCount++;
1329                     deleteException = false;
1330           }
1331           else
1332           {
1333                     ex->handlerCount--;
1334           }
1335 
1336           if (ex->handlerCount == 0)
1337           {
1338                     globals->caughtExceptions = ex->nextException;
1339                     if (deleteException)
1340                     {
1341                               releaseException(ex);
1342                     }
1343           }
1344 }
1345 
1346 /**
1347  * ABI function.  Returns the type of the current exception.
1348  */
1349 extern "C" std::type_info *__cxa_current_exception_type()
1350 {
1351           __cxa_eh_globals *globals = __cxa_get_globals();
1352           __cxa_exception *ex = globals->caughtExceptions;
1353           return ex ? ex->exceptionType : 0;
1354 }
1355 
1356 /**
1357  * Cleanup, ensures that `__cxa_end_catch` is called to balance an explicit
1358  * `__cxa_begin_catch` call.
1359  */
1360 static void end_catch(char *)
1361 {
1362           __cxa_end_catch();
1363 }
1364 /**
1365  * ABI function, called when an exception specification is violated.
1366  *
1367  * This function does not return.
1368  */
1369 extern "C" void __cxa_call_unexpected(void*exception)
1370 {
1371           _Unwind_Exception *exceptionObject = static_cast<_Unwind_Exception*>(exception);
1372           // Wrap the call to the unexpected handler in calls to `__cxa_begin_catch`
1373           // and `__cxa_end_catch` so that we correctly update exception counts if
1374           // the unexpected handler throws an exception.
1375           __cxa_begin_catch(exceptionObject);
1376           __attribute__((cleanup(end_catch)))
1377           char unused;
1378           if (exceptionObject->exception_class == exception_class)
1379           {
1380                     __cxa_exception *ex =  exceptionFromPointer(exceptionObject);
1381                     if (ex->unexpectedHandler)
1382                     {
1383                               ex->unexpectedHandler();
1384                               // Should not be reached.
1385                               abort();
1386                     }
1387           }
1388           std::unexpected();
1389           // Should not be reached.
1390           abort();
1391 }
1392 
1393 /**
1394  * ABI function, returns the adjusted pointer to the exception object.
1395  */
1396 extern "C" void *__cxa_get_exception_ptr(void *exceptionObject)
1397 {
1398           return exceptionFromPointer(exceptionObject)->adjustedPtr;
1399 }
1400 
1401 /**
1402  * As an extension, we provide the ability for the unexpected and terminate
1403  * handlers to be thread-local.  We default to the standards-compliant
1404  * behaviour where they are global.
1405  */
1406 static bool thread_local_handlers = false;
1407 
1408 
1409 namespace pathscale
1410 {
1411           /**
1412            * Sets whether unexpected and terminate handlers should be thread-local.
1413            */
1414           void set_use_thread_local_handlers(bool flag) throw()
1415           {
1416                     thread_local_handlers = flag;
1417           }
1418           /**
1419            * Sets a thread-local unexpected handler.
1420            */
1421           unexpected_handler set_unexpected(unexpected_handler f) throw()
1422           {
1423                     static __cxa_thread_info *info = thread_info();
1424                     unexpected_handler old = info->unexpectedHandler;
1425                     info->unexpectedHandler = f;
1426                     return old;
1427           }
1428           /**
1429            * Sets a thread-local terminate handler.
1430            */
1431           terminate_handler set_terminate(terminate_handler f) throw()
1432           {
1433                     static __cxa_thread_info *info = thread_info();
1434                     terminate_handler old = info->terminateHandler;
1435                     info->terminateHandler = f;
1436                     return old;
1437           }
1438 }
1439 
1440 namespace std
1441 {
1442           /**
1443            * Sets the function that will be called when an exception specification is
1444            * violated.
1445            */
1446           unexpected_handler set_unexpected(unexpected_handler f) throw()
1447           {
1448                     if (thread_local_handlers) { return pathscale::set_unexpected(f); }
1449 
1450                     return ATOMIC_SWAP(&unexpectedHandler, f);
1451           }
1452           /**
1453            * Sets the function that is called to terminate the program.
1454            */
1455           terminate_handler set_terminate(terminate_handler f) throw()
1456           {
1457                     if (thread_local_handlers) { return pathscale::set_terminate(f); }
1458 
1459                     return ATOMIC_SWAP(&terminateHandler, f);
1460           }
1461           /**
1462            * Terminates the program, calling a custom terminate implementation if
1463            * required.
1464            */
1465           void terminate()
1466           {
1467                     static __cxa_thread_info *info = thread_info();
1468                     if (0 != info && 0 != info->terminateHandler)
1469                     {
1470                               info->terminateHandler();
1471                               // Should not be reached - a terminate handler is not expected to
1472                               // return.
1473                               abort();
1474                     }
1475                     terminateHandler();
1476           }
1477           /**
1478            * Called when an unexpected exception is encountered (i.e. an exception
1479            * violates an exception specification).  This calls abort() unless a
1480            * custom handler has been set..
1481            */
1482           void unexpected()
1483           {
1484                     static __cxa_thread_info *info = thread_info();
1485                     if (0 != info && 0 != info->unexpectedHandler)
1486                     {
1487                               info->unexpectedHandler();
1488                               // Should not be reached - a terminate handler is not expected to
1489                               // return.
1490                               abort();
1491                     }
1492                     unexpectedHandler();
1493           }
1494           /**
1495            * Returns whether there are any exceptions currently being thrown that
1496            * have not been caught.  This can occur inside a nested catch statement.
1497            */
1498           bool uncaught_exception() throw()
1499           {
1500                     __cxa_thread_info *info = thread_info();
1501                     return info->globals.uncaughtExceptions != 0;
1502           }
1503           /**
1504            * Returns the number of exceptions currently being thrown that have not
1505            * been caught.  This can occur inside a nested catch statement.
1506            */
1507           int uncaught_exceptions() throw()
1508           {
1509                     __cxa_thread_info *info = thread_info();
1510                     return info->globals.uncaughtExceptions;
1511           }
1512           /**
1513            * Returns the current unexpected handler.
1514            */
1515           unexpected_handler get_unexpected() throw()
1516           {
1517                     __cxa_thread_info *info = thread_info();
1518                     if (info->unexpectedHandler)
1519                     {
1520                               return info->unexpectedHandler;
1521                     }
1522                     return ATOMIC_LOAD(&unexpectedHandler);
1523           }
1524           /**
1525            * Returns the current terminate handler.
1526            */
1527           terminate_handler get_terminate() throw()
1528           {
1529                     __cxa_thread_info *info = thread_info();
1530                     if (info->terminateHandler)
1531                     {
1532                               return info->terminateHandler;
1533                     }
1534                     return ATOMIC_LOAD(&terminateHandler);
1535           }
1536 }
1537 #if defined(__arm__) && !defined(__ARM_DWARF_EH__)
1538 extern "C" _Unwind_Exception *__cxa_get_cleanup(void)
1539 {
1540           __cxa_thread_info *info = thread_info_fast();
1541           _Unwind_Exception *exceptionObject = info->currentCleanup;
1542           if (isCXXException(exceptionObject->exception_class))
1543           {
1544                     __cxa_exception *ex =  exceptionFromPointer(exceptionObject);
1545                     ex->cleanupCount--;
1546                     if (ex->cleanupCount == 0)
1547                     {
1548                               info->currentCleanup = ex->nextCleanup;
1549                               ex->nextCleanup = 0;
1550                     }
1551           }
1552           else
1553           {
1554                     info->currentCleanup = 0;
1555           }
1556           return exceptionObject;
1557 }
1558 
1559 asm (
1560 ".pushsection .text.__cxa_end_cleanup    \n"
1561 ".global __cxa_end_cleanup               \n"
1562 ".type __cxa_end_cleanup, \"function\"   \n"
1563 "__cxa_end_cleanup:                      \n"
1564 "         push {r1, r2, r3, r4}                \n"
1565 "         bl __cxa_get_cleanup                 \n"
1566 "         push {r1, r2, r3, r4}                \n"
1567 "         b _Unwind_Resume                     \n"
1568 "         bl abort                             \n"
1569 ".popsection                             \n"
1570 );
1571 #endif
1572