2 * Copyright (c) 2002-2007 Apple Inc. All rights reserved.
4 * @APPLE_LICENSE_HEADER_START@
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. Please obtain a copy of the License at
10 * http://www.opensource.apple.com/apsl/ and read it before using this
13 * The Original Code and all software distributed under the License are
14 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
15 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
16 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
18 * Please see the License for the specific language governing rights and
19 * limitations under the License.
21 * @APPLE_LICENSE_HEADER_END@
26 /***********************************************************************
27 * 32-bit implementation
28 **********************************************************************/
30 #include "objc-private.h"
35 #include "objc-exception.h"
37 static objc_exception_functions_t xtab;
39 // forward declaration
40 static void set_default_handlers();
47 // get table; version tells how many
48 void objc_exception_get_functions(objc_exception_functions_t *table) {
49 // only version 0 supported at this point
50 if (table && table->version == 0)
55 void objc_exception_set_functions(objc_exception_functions_t *table) {
56 // only version 0 supported at this point
57 if (table && table->version == 0)
62 * The following functions are
63 * synthesized by the compiler upon encountering language constructs
66 void objc_exception_throw(id exception) {
67 if (!xtab.throw_exc) {
68 set_default_handlers();
71 if (PrintExceptionThrow) {
72 _objc_inform("EXCEPTIONS: throwing %p (%s)",
73 (void*)exception, object_getClassName(exception));
75 int frameCount = backtrace(callstack, 500);
76 backtrace_symbols_fd(callstack, frameCount, fileno(stderr));
79 OBJC_RUNTIME_OBJC_EXCEPTION_THROW(exception); // dtrace probe to log throw activity.
80 xtab.throw_exc(exception);
81 _objc_fatal("objc_exception_throw failed");
84 void objc_exception_try_enter(void *localExceptionData) {
85 if (!xtab.throw_exc) {
86 set_default_handlers();
88 xtab.try_enter(localExceptionData);
92 void objc_exception_try_exit(void *localExceptionData) {
93 if (!xtab.throw_exc) {
94 set_default_handlers();
96 xtab.try_exit(localExceptionData);
100 id objc_exception_extract(void *localExceptionData) {
101 if (!xtab.throw_exc) {
102 set_default_handlers();
104 return xtab.extract(localExceptionData);
108 int objc_exception_match(Class exceptionClass, id exception) {
109 if (!xtab.throw_exc) {
110 set_default_handlers();
112 return xtab.match(exceptionClass, exception);
116 // quick and dirty exception handling code
117 // default implementation - mostly a toy for use outside/before Foundation
118 // provides its implementation
119 // Perhaps the default implementation should just complain loudly and quit
122 extern void _objc_inform(const char *fmt, ...);
124 typedef struct { jmp_buf buf; void *pointers[4]; } LocalData_t;
126 typedef struct _threadChain {
127 LocalData_t *topHandler;
128 objc_thread_t perThreadID;
129 struct _threadChain *next;
133 static ThreadChainLink_t ThreadChainLink;
135 static ThreadChainLink_t *getChainLink() {
136 // follow links until thread_self() found (someday) XXX
137 objc_thread_t self = thread_self();
138 ThreadChainLink_t *walker = &ThreadChainLink;
139 while (walker->perThreadID != self) {
140 if (walker->next != nil) {
141 walker = walker->next;
145 // XXX not thread safe (!)
146 // XXX Also, we don't register to deallocate on thread death
147 walker->next = (ThreadChainLink_t *)malloc(sizeof(ThreadChainLink_t));
148 walker = walker->next;
150 walker->topHandler = nil;
151 walker->perThreadID = self;
156 static void default_try_enter(void *localExceptionData) {
157 LocalData_t *data = (LocalData_t *)localExceptionData;
158 ThreadChainLink_t *chainLink = getChainLink();
159 data->pointers[1] = chainLink->topHandler;
160 chainLink->topHandler = data;
161 if (PrintExceptions) _objc_inform("EXCEPTIONS: entered try block %p\n", chainLink->topHandler);
164 static void default_throw(id value) {
165 ThreadChainLink_t *chainLink = getChainLink();
168 if (PrintExceptions) _objc_inform("EXCEPTIONS: objc_exception_throw with nil value\n");
171 if (chainLink == nil) {
172 if (PrintExceptions) _objc_inform("EXCEPTIONS: No handler in place!\n");
175 if (PrintExceptions) _objc_inform("EXCEPTIONS: exception thrown, going to handler block %p\n", chainLink->topHandler);
176 led = chainLink->topHandler;
177 chainLink->topHandler = (LocalData_t *)
178 led->pointers[1]; // pop top handler
179 led->pointers[0] = value; // store exception that is thrown
181 longjmp(led->buf, 1);
183 _longjmp(led->buf, 1);
187 static void default_try_exit(void *led) {
188 ThreadChainLink_t *chainLink = getChainLink();
189 if (!chainLink || led != chainLink->topHandler) {
190 if (PrintExceptions) _objc_inform("EXCEPTIONS: *** mismatched try block exit handlers\n");
193 if (PrintExceptions) _objc_inform("EXCEPTIONS: removing try block handler %p\n", chainLink->topHandler);
194 chainLink->topHandler = (LocalData_t *)
195 chainLink->topHandler->pointers[1]; // pop top handler
198 static id default_extract(void *localExceptionData) {
199 LocalData_t *led = (LocalData_t *)localExceptionData;
200 return (id)led->pointers[0];
203 static int default_match(Class exceptionClass, id exception) {
204 //return [exception isKindOfClass:exceptionClass];
206 for (cls = exception->getIsa(); nil != cls; cls = cls->superclass)
207 if (cls == exceptionClass) return 1;
211 static void set_default_handlers() {
212 objc_exception_functions_t default_functions = {
213 0, default_throw, default_try_enter, default_try_exit, default_extract, default_match };
215 // should this always print?
216 if (PrintExceptions) _objc_inform("EXCEPTIONS: *** Setting default (non-Foundation) exception mechanism\n");
217 objc_exception_set_functions(&default_functions);
221 void exception_init(void)
226 void _destroyAltHandlerList(struct alt_handler_list *list)
236 /***********************************************************************
237 * 64-bit implementation.
238 **********************************************************************/
240 #include "objc-private.h"
241 #include <objc/objc-abi.h>
242 #include <objc/objc-exception.h>
243 #include <objc/NSObject.h>
244 #include <execinfo.h>
246 // unwind library types and functions
247 // Mostly adapted from Itanium C++ ABI: Exception Handling
248 // http://www.codesourcery.com/cxx-abi/abi-eh.html
250 struct _Unwind_Exception;
251 struct _Unwind_Context;
253 typedef int _Unwind_Action;
254 enum : _Unwind_Action {
255 _UA_SEARCH_PHASE = 1,
256 _UA_CLEANUP_PHASE = 2,
257 _UA_HANDLER_FRAME = 4,
261 typedef int _Unwind_Reason_Code;
262 enum : _Unwind_Reason_Code {
264 _URC_FOREIGN_EXCEPTION_CAUGHT = 1,
265 _URC_FATAL_PHASE2_ERROR = 2,
266 _URC_FATAL_PHASE1_ERROR = 3,
267 _URC_NORMAL_STOP = 4,
268 _URC_END_OF_STACK = 5,
269 _URC_HANDLER_FOUND = 6,
270 _URC_INSTALL_CONTEXT = 7,
271 _URC_CONTINUE_UNWIND = 8
274 struct dwarf_eh_bases
281 OBJC_EXTERN uintptr_t _Unwind_GetIP (struct _Unwind_Context *);
282 OBJC_EXTERN uintptr_t _Unwind_GetCFA (struct _Unwind_Context *);
283 OBJC_EXTERN uintptr_t _Unwind_GetLanguageSpecificData(struct _Unwind_Context *);
286 // C++ runtime types and functions
287 // copied from cxxabi.h
289 OBJC_EXTERN void *__cxa_allocate_exception(size_t thrown_size);
290 OBJC_EXTERN void __cxa_throw(void *exc, void *typeinfo, void (*destructor)(void *)) __attribute__((noreturn));
291 OBJC_EXTERN void *__cxa_begin_catch(void *exc);
292 OBJC_EXTERN void __cxa_end_catch(void);
293 OBJC_EXTERN void __cxa_rethrow(void);
294 OBJC_EXTERN void *__cxa_current_exception_type(void);
296 #if SUPPORT_ZEROCOST_EXCEPTIONS
297 # define CXX_PERSONALITY __gxx_personality_v0
299 # define CXX_PERSONALITY __gxx_personality_sj0
302 OBJC_EXTERN _Unwind_Reason_Code
303 CXX_PERSONALITY(int version,
304 _Unwind_Action actions,
305 uint64_t exceptionClass,
306 struct _Unwind_Exception *exceptionObject,
307 struct _Unwind_Context *context);
310 // objc's internal exception types and data
312 struct objc_typeinfo {
313 // Position of vtable and name fields must match C++ typeinfo object
314 const void ** __ptrauth_cxx_vtable_pointer vtable; // objc_ehtype_vtable+2
315 const char *name; // c++ typeinfo string
317 Class cls_unremapped;
320 struct objc_exception {
322 struct objc_typeinfo tinfo;
326 extern "C" void _objc_exception_noop(void) { }
327 extern "C" bool _objc_exception_false(void) { return 0; }
328 // extern "C" bool _objc_exception_true(void) { return 1; }
329 extern "C" void _objc_exception_abort1(void) {
330 _objc_fatal("unexpected call into objc exception typeinfo vtable %d", 1);
332 extern "C" void _objc_exception_abort2(void) {
333 _objc_fatal("unexpected call into objc exception typeinfo vtable %d", 2);
335 extern "C" void _objc_exception_abort3(void) {
336 _objc_fatal("unexpected call into objc exception typeinfo vtable %d", 3);
338 extern "C" void _objc_exception_abort4(void) {
339 _objc_fatal("unexpected call into objc exception typeinfo vtable %d", 4);
342 extern "C" bool _objc_exception_do_catch(struct objc_typeinfo *catch_tinfo,
343 struct objc_typeinfo *throw_tinfo,
347 // C++ pointers to vtables are signed with no extra data.
348 // C++ vtable entries are signed with a number derived from the function name.
349 // For this fake vtable, we hardcode number as deciphered from the
350 // assembly output during libc++abi's build.
351 #if __has_feature(ptrauth_calls)
352 # define VTABLE_PTR_AUTH "@AUTH(da, 0)"
353 # define VTABLE_ENTRY_AUTH(x) "@AUTH(ia," #x ",addr)"
355 # define VTABLE_PTR_AUTH ""
356 # define VTABLE_ENTRY_AUTH(x) ""
360 # define PTR ".quad "
361 # define TWOPTRSIZE "16"
363 # define PTR ".long "
364 # define TWOPTRSIZE "8"
367 // Hand-built vtable for objc exception typeinfo.
368 // "OLD" is GNU libcpp, "NEW" is libc++abi.
372 "\n l_.id_str: .asciz \"id\""
374 "\n .section __DATA,__const"
375 "\n .globl _OBJC_EHTYPE_id"
376 "\n .globl _objc_ehtype_vtable"
379 "\n _OBJC_EHTYPE_id:"
380 "\n " PTR "(_objc_ehtype_vtable+" TWOPTRSIZE ") " VTABLE_PTR_AUTH
381 "\n " PTR "l_.id_str"
384 "\n _objc_ehtype_vtable:"
386 // typeinfo's typeinfo - fixme hack
387 "\n " PTR "_OBJC_EHTYPE_id"
388 // destructor and in-place destructor
389 "\n " PTR "__objc_exception_noop" VTABLE_ENTRY_AUTH(52634)
390 "\n " PTR "__objc_exception_noop" VTABLE_ENTRY_AUTH(10344)
391 // OLD __is_pointer_p
392 "\n " PTR "__objc_exception_noop" VTABLE_ENTRY_AUTH(6889)
393 // OLD __is_function_p
394 "\n " PTR "__objc_exception_noop" VTABLE_ENTRY_AUTH(23080)
395 // OLD __do_catch, NEW can_catch
396 "\n " PTR "__objc_exception_do_catch" VTABLE_ENTRY_AUTH(27434)
397 // OLD __do_upcast, NEW search_above_dst
398 "\n " PTR "__objc_exception_false" VTABLE_ENTRY_AUTH(48481)
399 // NEW search_below_dst
400 "\n " PTR "__objc_exception_false" VTABLE_ENTRY_AUTH(41165)
401 // NEW has_unambiguous_public_base (fixme need this?)
402 "\n " PTR "__objc_exception_abort1" VTABLE_ENTRY_AUTH(14357)
403 // paranoia: die if libcxxabi adds anything else
404 "\n " PTR "__objc_exception_abort2"
405 "\n " PTR "__objc_exception_abort3"
406 "\n " PTR "__objc_exception_abort4"
411 /***********************************************************************
412 * Foundation customization
413 **********************************************************************/
415 /***********************************************************************
416 * _objc_default_exception_preprocessor
417 * Default exception preprocessor. Expected to be overridden by Foundation.
418 **********************************************************************/
419 static id _objc_default_exception_preprocessor(id exception)
423 static objc_exception_preprocessor exception_preprocessor = _objc_default_exception_preprocessor;
426 /***********************************************************************
427 * _objc_default_exception_matcher
428 * Default exception matcher. Expected to be overridden by Foundation.
429 **********************************************************************/
430 static int _objc_default_exception_matcher(Class catch_cls, id exception)
433 for (cls = exception->getIsa();
435 cls = cls->superclass)
437 if (cls == catch_cls) return 1;
442 static objc_exception_matcher exception_matcher = _objc_default_exception_matcher;
445 /***********************************************************************
446 * _objc_default_uncaught_exception_handler
447 * Default uncaught exception handler. Expected to be overridden by Foundation.
448 **********************************************************************/
449 static void _objc_default_uncaught_exception_handler(id exception)
452 static objc_uncaught_exception_handler uncaught_handler = _objc_default_uncaught_exception_handler;
455 /***********************************************************************
456 * objc_setExceptionPreprocessor
457 * Set a handler for preprocessing Objective-C exceptions.
458 * Returns the previous handler.
459 **********************************************************************/
460 objc_exception_preprocessor
461 objc_setExceptionPreprocessor(objc_exception_preprocessor fn)
463 objc_exception_preprocessor result = exception_preprocessor;
464 exception_preprocessor = fn;
469 /***********************************************************************
470 * objc_setExceptionMatcher
471 * Set a handler for matching Objective-C exceptions.
472 * Returns the previous handler.
473 **********************************************************************/
474 objc_exception_matcher
475 objc_setExceptionMatcher(objc_exception_matcher fn)
477 objc_exception_matcher result = exception_matcher;
478 exception_matcher = fn;
483 /***********************************************************************
484 * objc_setUncaughtExceptionHandler
485 * Set a handler for uncaught Objective-C exceptions.
486 * Returns the previous handler.
487 **********************************************************************/
488 objc_uncaught_exception_handler
489 objc_setUncaughtExceptionHandler(objc_uncaught_exception_handler fn)
491 objc_uncaught_exception_handler result = uncaught_handler;
492 uncaught_handler = fn;
497 /***********************************************************************
498 * Exception personality
499 **********************************************************************/
501 static void call_alt_handlers(struct _Unwind_Context *ctx);
504 __objc_personality_v0(int version,
505 _Unwind_Action actions,
506 uint64_t exceptionClass,
507 struct _Unwind_Exception *exceptionObject,
508 struct _Unwind_Context *context)
510 bool unwinding = ((actions & _UA_CLEANUP_PHASE) ||
511 (actions & _UA_FORCE_UNWIND));
513 if (PrintExceptions) {
514 _objc_inform("EXCEPTIONS: %s through frame [ip=%p sp=%p] "
516 unwinding ? "unwinding" : "searching",
517 (void*)(_Unwind_GetIP(context)-1),
518 (void*)_Unwind_GetCFA(context), exceptionObject);
521 // If we're executing the unwind, call this frame's alt handlers, if any.
523 call_alt_handlers(context);
526 // Let C++ handle the unwind itself.
527 return CXX_PERSONALITY(version, actions, exceptionClass,
528 exceptionObject, context);
532 /***********************************************************************
534 **********************************************************************/
536 static void _objc_exception_destructor(void *exc_gen)
538 // Release the retain from objc_exception_throw().
540 struct objc_exception *exc = (struct objc_exception *)exc_gen;
543 if (PrintExceptions) {
544 _objc_inform("EXCEPTIONS: releasing completed exception %p (object %p, a %s)",
545 exc, obj, object_getClassName(obj));
552 void objc_exception_throw(id obj)
554 struct objc_exception *exc = (struct objc_exception *)
555 __cxa_allocate_exception(sizeof(struct objc_exception));
557 obj = (*exception_preprocessor)(obj);
559 // Retain the exception object during unwinding
560 // because otherwise an autorelease pool pop can cause a crash
564 exc->tinfo.vtable = objc_ehtype_vtable+2;
565 exc->tinfo.name = object_getClassName(obj);
566 exc->tinfo.cls_unremapped = obj ? obj->getIsa() : Nil;
568 if (PrintExceptions) {
569 _objc_inform("EXCEPTIONS: throwing %p (object %p, a %s)",
570 exc, (void*)obj, object_getClassName(obj));
573 if (PrintExceptionThrow) {
574 if (!PrintExceptions)
575 _objc_inform("EXCEPTIONS: throwing %p (object %p, a %s)",
576 exc, (void*)obj, object_getClassName(obj));
577 void* callstack[500];
578 int frameCount = backtrace(callstack, 500);
579 backtrace_symbols_fd(callstack, frameCount, fileno(stderr));
582 OBJC_RUNTIME_OBJC_EXCEPTION_THROW(obj); // dtrace probe to log throw activity
583 __cxa_throw(exc, &exc->tinfo, &_objc_exception_destructor);
588 void objc_exception_rethrow(void)
590 // exception_preprocessor doesn't get another bite of the apple
591 if (PrintExceptions) {
592 _objc_inform("EXCEPTIONS: rethrowing current exception");
595 OBJC_RUNTIME_OBJC_EXCEPTION_RETHROW(); // dtrace probe to log throw activity.
601 id objc_begin_catch(void *exc_gen)
603 if (PrintExceptions) {
604 _objc_inform("EXCEPTIONS: handling exception %p at %p",
605 exc_gen, __builtin_return_address(0));
607 // NOT actually an id in the catch(...) case!
608 return (id)__cxa_begin_catch(exc_gen);
612 void objc_end_catch(void)
614 if (PrintExceptions) {
615 _objc_inform("EXCEPTIONS: finishing handler");
621 // `outer` is not passed by the new libcxxabi
622 bool _objc_exception_do_catch(struct objc_typeinfo *catch_tinfo,
623 struct objc_typeinfo *throw_tinfo,
625 unsigned outer UNAVAILABLE_ATTRIBUTE)
629 if (throw_tinfo->vtable != objc_ehtype_vtable+2) {
630 // Only objc types can be caught here.
631 if (PrintExceptions) _objc_inform("EXCEPTIONS: skipping catch(?)");
635 // Adjust exception pointer.
636 // Old libcppabi: we lied about __is_pointer_p() so we have to do it here
637 // New libcxxabi: we have to do it here regardless
638 *throw_obj_p = **(void***)throw_obj_p;
640 // `catch (id)` always catches objc types.
641 if (catch_tinfo == &OBJC_EHTYPE_id) {
642 if (PrintExceptions) _objc_inform("EXCEPTIONS: catch(id)");
646 exception = *(id *)throw_obj_p;
648 Class handler_cls = _class_remap(catch_tinfo->cls_unremapped);
650 // catch handler's class is weak-linked and missing. Not a match.
652 else if ((*exception_matcher)(handler_cls, exception)) {
653 if (PrintExceptions) _objc_inform("EXCEPTIONS: catch(%s)",
654 handler_cls->nameForLogging());
658 if (PrintExceptions) _objc_inform("EXCEPTIONS: skipping catch(%s)",
659 handler_cls->nameForLogging());
665 /***********************************************************************
667 * Custom std::terminate handler.
669 * The uncaught exception callback is implemented as a std::terminate handler.
670 * 1. Check if there's an active exception
671 * 2. If so, check if it's an Objective-C exception
672 * 3. If so, call our registered callback with the object.
673 * 4. Finally, call the previous terminate handler.
674 **********************************************************************/
675 static void (*old_terminate)(void) = nil;
676 static void _objc_terminate(void)
678 if (PrintExceptions) {
679 _objc_inform("EXCEPTIONS: terminating");
682 if (! __cxa_current_exception_type()) {
683 // No current exception.
687 // There is a current exception. Check if it's an objc exception.
691 // It's an objc object. Call Foundation's handler, if any.
692 (*uncaught_handler)((id)e);
695 // It's not an objc object. Continue to C++ terminate.
702 /***********************************************************************
704 * Calls std::terminate for clients who don't link to C++ themselves.
705 * Called by the compiler if an exception is thrown
706 * from a context where exceptions may not be thrown.
707 **********************************************************************/
708 void objc_terminate(void)
714 /***********************************************************************
715 * alt handler support - zerocost implementation only
716 **********************************************************************/
718 #if !SUPPORT_ALT_HANDLERS
720 void _destroyAltHandlerList(struct alt_handler_list *list)
724 static void call_alt_handlers(struct _Unwind_Context *ctx)
726 // unsupported in sjlj environments
731 #include <libunwind.h>
732 #include <execinfo.h>
733 #include <dispatch/dispatch.h>
735 // Dwarf eh data encodings
736 #define DW_EH_PE_omit 0xff // no data follows
738 #define DW_EH_PE_absptr 0x00
739 #define DW_EH_PE_uleb128 0x01
740 #define DW_EH_PE_udata2 0x02
741 #define DW_EH_PE_udata4 0x03
742 #define DW_EH_PE_udata8 0x04
743 #define DW_EH_PE_sleb128 0x09
744 #define DW_EH_PE_sdata2 0x0A
745 #define DW_EH_PE_sdata4 0x0B
746 #define DW_EH_PE_sdata8 0x0C
748 #define DW_EH_PE_pcrel 0x10
749 #define DW_EH_PE_textrel 0x20
750 #define DW_EH_PE_datarel 0x30
751 #define DW_EH_PE_funcrel 0x40
752 #define DW_EH_PE_aligned 0x50 // fixme
754 #define DW_EH_PE_indirect 0x80 // gcc extension
757 /***********************************************************************
759 * Read a LEB-encoded unsigned integer from the address stored in *pp.
760 * Increments *pp past the bytes read.
761 * Adapted from DWARF Debugging Information Format 1.1, appendix 4
762 **********************************************************************/
763 static uintptr_t read_uleb(uintptr_t *pp)
765 uintptr_t result = 0;
769 byte = *(const unsigned char *)(*pp)++;
770 result |= (byte & 0x7f) << shift;
772 } while (byte & 0x80);
777 /***********************************************************************
779 * Read a LEB-encoded signed integer from the address stored in *pp.
780 * Increments *pp past the bytes read.
781 * Adapted from DWARF Debugging Information Format 1.1, appendix 4
782 **********************************************************************/
783 static intptr_t read_sleb(uintptr_t *pp)
785 uintptr_t result = 0;
789 byte = *(const unsigned char *)(*pp)++;
790 result |= (byte & 0x7f) << shift;
792 } while (byte & 0x80);
793 if ((shift < 8*sizeof(intptr_t)) && (byte & 0x40)) {
794 result |= ((intptr_t)-1) << shift;
800 /***********************************************************************
802 * Reads an encoded address from the address stored in *pp.
803 * Increments *pp past the bytes read.
804 * The data is interpreted according to the given dwarf encoding
805 * and base addresses.
806 **********************************************************************/
807 static uintptr_t read_address(uintptr_t *pp,
808 const struct dwarf_eh_bases *bases,
809 unsigned char encoding)
811 uintptr_t result = 0;
812 uintptr_t oldp = *pp;
814 // fixme need DW_EH_PE_aligned?
817 result = *(type *)(*pp); \
820 if (encoding == DW_EH_PE_omit) return 0;
822 switch (encoding & 0x0f) {
823 case DW_EH_PE_absptr:
826 case DW_EH_PE_uleb128:
827 result = read_uleb(pp);
829 case DW_EH_PE_udata2:
832 case DW_EH_PE_udata4:
836 case DW_EH_PE_udata8:
840 case DW_EH_PE_sleb128:
841 result = read_sleb(pp);
843 case DW_EH_PE_sdata2:
846 case DW_EH_PE_sdata4:
850 case DW_EH_PE_sdata8:
855 _objc_inform("unknown DWARF EH encoding 0x%x at %p",
856 encoding, (void *)*pp);
863 switch (encoding & 0x70) {
866 result += (uintptr_t)oldp;
868 case DW_EH_PE_textrel:
869 result += bases->tbase;
871 case DW_EH_PE_datarel:
872 result += bases->dbase;
874 case DW_EH_PE_funcrel:
875 result += bases->func;
877 case DW_EH_PE_aligned:
878 _objc_inform("unknown DWARF EH encoding 0x%x at %p",
879 encoding, (void *)*pp);
886 if (encoding & DW_EH_PE_indirect) {
887 result = *(uintptr_t *)result;
891 return (uintptr_t)result;
903 // precise ranges within ip_start..ip_end; nil or {0,0} terminated
908 static bool isObjCExceptionCatcher(uintptr_t lsda, uintptr_t ip,
909 const struct dwarf_eh_bases* bases,
910 struct frame_range *frame)
912 unsigned char LPStart_enc = *(const unsigned char *)lsda++;
914 if (LPStart_enc != DW_EH_PE_omit) {
915 read_address(&lsda, bases, LPStart_enc); // LPStart
918 unsigned char TType_enc = *(const unsigned char *)lsda++;
919 if (TType_enc != DW_EH_PE_omit) {
920 read_uleb(&lsda); // TType
923 unsigned char call_site_enc = *(const unsigned char *)lsda++;
924 uintptr_t length = read_uleb(&lsda);
925 uintptr_t call_site_table = lsda;
926 uintptr_t call_site_table_end = call_site_table + length;
927 uintptr_t action_record_table = call_site_table_end;
929 uintptr_t action_record = 0;
930 uintptr_t p = call_site_table;
934 uintptr_t try_landing_pad;
936 while (p < call_site_table_end) {
937 uintptr_t start = read_address(&p, bases, call_site_enc)+bases->func;
938 uintptr_t len = read_address(&p, bases, call_site_enc);
939 uintptr_t pad = read_address(&p, bases, call_site_enc);
940 uintptr_t action = read_uleb(&p);
943 // no more source ranges
946 else if (ip < start + len) {
948 if (!pad) return false; // ...but it has no landing pad
949 // found the landing pad
950 action_record = action ? action_record_table + action - 1 : 0;
952 try_end = start + len;
953 try_landing_pad = pad;
958 if (!action_record) return false; // no catch handlers
960 // has handlers, destructors, and/or throws specifications
961 // Use this frame if it has any handlers
962 bool has_handler = false;
966 intptr_t filter = read_sleb(&p);
968 offset = read_sleb(&temp);
972 // throws specification - ignore
973 } else if (filter == 0) {
974 // destructor - ignore
975 } else /* filter >= 0 */ {
976 // catch handler - use this frame
982 if (!has_handler) return false;
984 // Count the number of source ranges with the same landing pad as our match
985 unsigned int range_count = 0;
987 while (p < call_site_table_end) {
988 /*start*/ read_address(&p, bases, call_site_enc)/*+bases->func*/;
989 /*len*/ read_address(&p, bases, call_site_enc);
990 uintptr_t pad = read_address(&p, bases, call_site_enc);
991 /*action*/ read_uleb(&p);
993 if (pad == try_landing_pad) {
998 if (range_count == 1) {
999 // No other source ranges with the same landing pad. We're done here.
1003 // Record all ranges with the same landing pad as our match.
1004 frame->ips = (frame_ips *)
1005 malloc((range_count + 1) * sizeof(frame->ips[0]));
1007 p = call_site_table;
1008 while (p < call_site_table_end) {
1009 uintptr_t start = read_address(&p, bases, call_site_enc)+bases->func;
1010 uintptr_t len = read_address(&p, bases, call_site_enc);
1011 uintptr_t pad = read_address(&p, bases, call_site_enc);
1012 /*action*/ read_uleb(&p);
1014 if (pad == try_landing_pad) {
1015 if (start < try_start) try_start = start;
1016 if (start+len > try_end) try_end = start+len;
1017 frame->ips[r].start = start;
1018 frame->ips[r].end = start+len;
1023 frame->ips[r].start = 0;
1024 frame->ips[r].end = 0;
1027 frame->ip_start = try_start;
1028 frame->ip_end = try_end;
1034 static struct frame_range findHandler(void)
1036 // walk stack looking for frame with objc catch handler
1038 unw_cursor_t cursor;
1039 unw_proc_info_t info;
1040 unw_getcontext(&uc);
1041 unw_init_local(&cursor, &uc);
1042 while ( (unw_step(&cursor) > 0) && (unw_get_proc_info(&cursor, &info) == UNW_ESUCCESS) ) {
1043 // must use objc personality handler
1044 if ( info.handler != (uintptr_t)__objc_personality_v0 )
1046 // must have landing pad
1047 if ( info.lsda == 0 )
1049 // must have landing pad that catches objc exceptions
1050 struct dwarf_eh_bases bases;
1051 bases.tbase = 0; // from unwind-dw2-fde-darwin.c:examine_objects()
1052 bases.dbase = 0; // from unwind-dw2-fde-darwin.c:examine_objects()
1053 bases.func = info.start_ip;
1055 unw_get_reg(&cursor, UNW_REG_IP, &ip);
1057 struct frame_range try_range = {0, 0, 0, 0};
1058 if ( isObjCExceptionCatcher(info.lsda, ip, &bases, &try_range) ) {
1060 unw_get_reg(&cursor, UNW_REG_SP, &cfa);
1061 try_range.cfa = cfa;
1066 return (struct frame_range){0, 0, 0, 0};
1070 // This data structure assumes the number of
1071 // active alt handlers per frame is small.
1073 // for OBJC_DEBUG_ALT_HANDLERS, record the call to objc_addExceptionHandler.
1074 #define BACKTRACE_COUNT 46
1075 #define THREADNAME_COUNT 64
1076 struct alt_handler_debug {
1079 void *backtrace[BACKTRACE_COUNT];
1080 char thread[THREADNAME_COUNT];
1081 char queue[THREADNAME_COUNT];
1084 struct alt_handler_data {
1085 struct frame_range frame;
1086 objc_exception_handler fn;
1088 struct alt_handler_debug *debug;
1091 struct alt_handler_list {
1092 unsigned int allocated;
1094 struct alt_handler_data *handlers;
1095 struct alt_handler_list *next_DEBUGONLY;
1098 static struct alt_handler_list *DebugLists;
1099 static uintptr_t DebugCounter;
1101 __attribute__((noinline, noreturn))
1102 void alt_handler_error(uintptr_t token);
1104 static struct alt_handler_list *
1105 fetch_handler_list(bool create)
1107 _objc_pthread_data *data = _objc_fetch_pthread_data(create);
1108 if (!data) return nil;
1110 struct alt_handler_list *list = data->handlerList;
1112 if (!create) return nil;
1113 list = (struct alt_handler_list *)calloc(1, sizeof(*list));
1114 data->handlerList = list;
1116 if (DebugAltHandlers) {
1117 // Save this list so the debug code can find it from other threads
1118 mutex_locker_t lock(AltHandlerDebugLock);
1119 list->next_DEBUGONLY = DebugLists;
1128 void _destroyAltHandlerList(struct alt_handler_list *list)
1131 if (DebugAltHandlers) {
1132 // Detach from the list-of-lists.
1133 mutex_locker_t lock(AltHandlerDebugLock);
1134 struct alt_handler_list **listp = &DebugLists;
1135 while (*listp && *listp != list) listp = &(*listp)->next_DEBUGONLY;
1136 if (*listp) *listp = (*listp)->next_DEBUGONLY;
1139 if (list->handlers) {
1140 for (unsigned int i = 0; i < list->allocated; i++) {
1141 if (list->handlers[i].frame.ips) {
1142 free(list->handlers[i].frame.ips);
1145 free(list->handlers);
1152 uintptr_t objc_addExceptionHandler(objc_exception_handler fn, void *context)
1154 // Find the closest enclosing frame with objc catch handlers
1155 struct frame_range target_frame = findHandler();
1156 if (!target_frame.ip_start) {
1157 // No suitable enclosing handler found.
1161 // Record this alt handler for the discovered frame.
1162 struct alt_handler_list *list = fetch_handler_list(YES);
1165 if (list->used == list->allocated) {
1166 list->allocated = list->allocated*2 ?: 4;
1167 list->handlers = (struct alt_handler_data *)
1168 realloc(list->handlers,
1169 list->allocated * sizeof(list->handlers[0]));
1170 bzero(&list->handlers[list->used], (list->allocated - list->used) * sizeof(list->handlers[0]));
1174 for (i = 0; i < list->allocated; i++) {
1175 if (list->handlers[i].frame.ip_start == 0 &&
1176 list->handlers[i].frame.ip_end == 0 &&
1177 list->handlers[i].frame.cfa == 0)
1182 if (i == list->allocated) {
1183 _objc_fatal("alt handlers in objc runtime are buggy!");
1187 struct alt_handler_data *data = &list->handlers[i];
1189 data->frame = target_frame;
1191 data->context = context;
1194 uintptr_t token = i+1;
1196 if (DebugAltHandlers) {
1197 // Record backtrace in case this handler is misused later.
1198 mutex_locker_t lock(AltHandlerDebugLock);
1200 token = DebugCounter++;
1201 if (token == 0) token = DebugCounter++;
1204 data->debug = (struct alt_handler_debug *)
1205 calloc(sizeof(*data->debug), 1);
1207 bzero(data->debug, sizeof(*data->debug));
1210 pthread_getname_np(pthread_self(), data->debug->thread, THREADNAME_COUNT);
1211 strlcpy(data->debug->queue,
1212 dispatch_queue_get_label(dispatch_get_current_queue()),
1214 data->debug->backtraceSize =
1215 backtrace(data->debug->backtrace, BACKTRACE_COUNT);
1216 data->debug->token = token;
1219 if (PrintAltHandlers) {
1220 _objc_inform("ALT HANDLERS: installing alt handler #%lu %p(%p) on "
1221 "frame [ip=%p..%p sp=%p]", (unsigned long)token,
1222 data->fn, data->context, (void *)data->frame.ip_start,
1223 (void *)data->frame.ip_end, (void *)data->frame.cfa);
1224 if (data->frame.ips) {
1227 uintptr_t start = data->frame.ips[r].start;
1228 uintptr_t end = data->frame.ips[r].end;
1230 if (start == 0 && end == 0) break;
1231 _objc_inform("ALT HANDLERS: ip=%p..%p",
1232 (void*)start, (void*)end);
1237 if (list->used > 1000) {
1238 static int warned = 0;
1240 _objc_inform("ALT HANDLERS: *** over 1000 alt handlers installed; "
1241 "this is probably a bug");
1250 void objc_removeExceptionHandler(uintptr_t token)
1253 // objc_addExceptionHandler failed
1257 struct alt_handler_list *list = fetch_handler_list(NO);
1258 if (!list || !list->handlers) {
1259 // no alt handlers active
1260 alt_handler_error(token);
1263 uintptr_t i = token-1;
1265 if (DebugAltHandlers) {
1266 // search for the token instead of using token-1
1267 for (i = 0; i < list->allocated; i++) {
1268 struct alt_handler_data *data = &list->handlers[i];
1269 if (data->debug && data->debug->token == token) break;
1273 if (i >= list->allocated) {
1274 // token out of range
1275 alt_handler_error(token);
1278 struct alt_handler_data *data = &list->handlers[i];
1280 if (data->frame.ip_start == 0 && data->frame.ip_end == 0 && data->frame.cfa == 0) {
1281 // token in range, but invalid
1282 alt_handler_error(token);
1285 if (PrintAltHandlers) {
1286 _objc_inform("ALT HANDLERS: removing alt handler #%lu %p(%p) on "
1287 "frame [ip=%p..%p sp=%p]", (unsigned long)token,
1288 data->fn, data->context, (void *)data->frame.ip_start,
1289 (void *)data->frame.ip_end, (void *)data->frame.cfa);
1292 if (data->debug) free(data->debug);
1293 if (data->frame.ips) free(data->frame.ips);
1294 bzero(data, sizeof(*data));
1299 BREAKPOINT_FUNCTION(
1300 void objc_alt_handler_error(void));
1302 __attribute__((noinline, noreturn))
1303 void alt_handler_error(uintptr_t token)
1306 ("objc_removeExceptionHandler() called with unknown alt handler; "
1307 "this is probably a bug in multithreaded AppKit use. "
1308 "Set environment variable OBJC_DEBUG_ALT_HANDLERS=YES "
1309 "or break in objc_alt_handler_error() to debug.");
1311 if (DebugAltHandlers) {
1312 AltHandlerDebugLock.lock();
1314 // Search other threads' alt handler lists for this handler.
1315 struct alt_handler_list *list;
1316 for (list = DebugLists; list; list = list->next_DEBUGONLY) {
1318 for (h = 0; h < list->allocated; h++) {
1319 struct alt_handler_data *data = &list->handlers[h];
1320 if (data->debug && data->debug->token == token) {
1324 // Build a string from the recorded backtrace
1327 backtrace_symbols(data->debug->backtrace,
1328 data->debug->backtraceSize);
1330 for (i = 0; i < data->debug->backtraceSize; i++){
1331 len += 4 + strlen(symbols[i]) + 1;
1333 symbolString = (char *)calloc(len, 1);
1334 for (i = 0; i < data->debug->backtraceSize; i++){
1335 strcat(symbolString, " ");
1336 strcat(symbolString, symbols[i]);
1337 strcat(symbolString, "\n");
1342 _objc_inform_now_and_on_crash
1343 ("The matching objc_addExceptionHandler() was called "
1344 "by:\nThread '%s': Dispatch queue: '%s': \n%s",
1345 data->debug->thread, data->debug->queue, symbolString);
1352 AltHandlerDebugLock.unlock();
1356 objc_alt_handler_error();
1359 ("objc_removeExceptionHandler() called with unknown alt handler; "
1360 "this is probably a bug in multithreaded AppKit use. ");
1363 // called in order registered, to match 32-bit _NSAddAltHandler2
1364 // fixme reverse registration order matches c++ destructors better
1365 static void call_alt_handlers(struct _Unwind_Context *ctx)
1367 uintptr_t ip = _Unwind_GetIP(ctx) - 1;
1368 uintptr_t cfa = _Unwind_GetCFA(ctx);
1371 struct alt_handler_list *list = fetch_handler_list(NO);
1372 if (!list || list->used == 0) return;
1374 for (i = 0; i < list->allocated; i++) {
1375 struct alt_handler_data *data = &list->handlers[i];
1376 if (ip >= data->frame.ip_start && ip < data->frame.ip_end && data->frame.cfa == cfa)
1378 if (data->frame.ips) {
1382 uintptr_t start = data->frame.ips[r].start;
1383 uintptr_t end = data->frame.ips[r].end;
1385 if (start == 0 && end == 0) {
1389 if (ip >= start && ip < end) {
1394 if (!found) continue;
1397 // Copy and clear before the callback, in case the
1398 // callback manipulates the alt handler list.
1399 struct alt_handler_data copy = *data;
1400 bzero(data, sizeof(*data));
1402 if (PrintExceptions || PrintAltHandlers) {
1403 _objc_inform("EXCEPTIONS: calling alt handler %p(%p) from "
1404 "frame [ip=%p..%p sp=%p]", copy.fn, copy.context,
1405 (void *)copy.frame.ip_start,
1406 (void *)copy.frame.ip_end,
1407 (void *)copy.frame.cfa);
1409 if (copy.fn) (*copy.fn)(nil, copy.context);
1410 if (copy.frame.ips) free(copy.frame.ips);
1415 // SUPPORT_ALT_HANDLERS
1419 /***********************************************************************
1421 * Initialize libobjc's exception handling system.
1422 * Called by map_images().
1423 **********************************************************************/
1424 void exception_init(void)
1426 old_terminate = std::set_terminate(&_objc_terminate);
1433 // Define this everywhere even if it isn't used, to simplify fork() safety code
1434 mutex_t AltHandlerDebugLock;