/*
* Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017
* Jonathan Schleifer <js@heap.zone>
*
* All rights reserved.
*
* This file is part of ObjFW. It may be distributed under the terms of the
* Q Public License 1.0, which can be found in the file LICENSE.QPL included in
* the packaging of this file.
*
* Alternatively, it may be distributed under the terms of the GNU General
* Public License, either version 2 or 3, which can be found in the file
* LICENSE.GPLv2 or LICENSE.GPLv3 respectively included in the packaging of this
* file.
*/
#include "config.h"
#include <stdlib.h>
#include <string.h>
#ifdef HAVE_SEH_EXCEPTIONS
# include <windows.h>
#endif
#import "runtime.h"
#import "runtime-private.h"
#import "macros.h"
#if defined(HAVE_DWARF_EXCEPTIONS)
# define PERSONALITY __gnu_objc_personality_v0
# define CXX_PERSONALITY __gxx_personality_v0
#elif defined(HAVE_SJLJ_EXCEPTIONS)
# define PERSONALITY __gnu_objc_personality_sj0
# define CXX_PERSONALITY __gxx_personality_sj0
# define _Unwind_RaiseException _Unwind_SjLj_RaiseException
# define __builtin_eh_return_data_regno(i) (i)
#elif defined(HAVE_SEH_EXCEPTIONS)
# define PERSONALITY gnu_objc_personality
# define CXX_PERSONALITY __gxx_personality_v0
#else
# error Unknown exception type!
#endif
#if defined(OF_ARM) && !defined(__ARM_DWARF_EH__)
# define HAVE_ARM_EHABI_EXCEPTIONS
#endif
#ifndef HAVE_ARM_EHABI_EXCEPTIONS
# define PERSONALITY_FUNC(func) \
_Unwind_Reason_Code \
func(int version, int actions, uint64_t ex_class, \
struct _Unwind_Exception *ex, struct _Unwind_Context *ctx)
# define CALL_PERSONALITY(func) func(version, actions, ex_class, ex, ctx)
#else
# define PERSONALITY_FUNC(func) \
_Unwind_Reason_Code \
func(uint32_t state, struct _Unwind_Exception *ex, \
struct _Unwind_Context *ctx)
# define CALL_PERSONALITY(func) func(state, ex, ctx)
#endif
#define GNUCOBJC_EXCEPTION_CLASS UINT64_C(0x474E55434F424A43) /* GNUCOBJC */
#define GNUCCXX0_EXCEPTION_CLASS UINT64_C(0x474E5543432B2B00) /* GNUCC++\0 */
#define CLNGCXX0_EXCEPTION_CLASS UINT64_C(0x434C4E47432B2B00) /* CLNGC++\0 */
#define _UA_SEARCH_PHASE 0x01
#define _UA_CLEANUP_PHASE 0x02
#define _UA_HANDLER_FRAME 0x04
#define _UA_FORCE_UNWIND 0x08
#define DW_EH_PE_absptr 0x00
#define DW_EH_PE_uleb128 0x01
#define DW_EH_PE_udata2 0x02
#define DW_EH_PE_udata4 0x03
#define DW_EH_PE_udata8 0x04
#define DW_EH_PE_signed 0x08
#define DW_EH_PE_sleb128 (DW_EH_PE_signed | DW_EH_PE_uleb128)
#define DW_EH_PE_sdata2 (DW_EH_PE_signed | DW_EH_PE_udata2)
#define DW_EH_PE_sdata4 (DW_EH_PE_signed | DW_EH_PE_udata4)
#define DW_EH_PE_sdata8 (DW_EH_PE_signed | DW_EH_PE_udata8)
#define DW_EH_PE_pcrel 0x10
#define DW_EH_PE_textrel 0x20
#define DW_EH_PE_datarel 0x30
#define DW_EH_PE_funcrel 0x40
#define DW_EH_PE_aligned 0x50
#define DW_EH_PE_indirect 0x80
#define DW_EH_PE_omit 0xFF
#define CLEANUP_FOUND 0x01
#define HANDLER_FOUND 0x02
struct _Unwind_Context;
typedef enum {
_URC_OK = 0,
_URC_FATAL_PHASE1_ERROR = 3,
_URC_END_OF_STACK = 5,
_URC_HANDLER_FOUND = 6,
_URC_INSTALL_CONTEXT = 7,
_URC_CONTINUE_UNWIND = 8,
_URC_FAILURE = 9
} _Unwind_Reason_Code;
struct objc_exception {
struct _Unwind_Exception {
uint64_t class;
void (*cleanup)(_Unwind_Reason_Code, struct _Unwind_Exception*);
#ifndef HAVE_ARM_EHABI_EXCEPTIONS
# ifndef HAVE_SEH_EXCEPTIONS
/*
* The Itanium Exception ABI says to have those and never touch
* them.
*/
uint64_t private1, private2;
# else
uint64_t private[6];
# endif
#else
/* From "Exception Handling ABI for the ARM(R) Architecture" */
struct {
uint32_t reserved1, reserved2, reserved3, reserved4;
uint32_t reserved;
} unwinder_cache;
struct {
uint32_t sp;
uint32_t bitpattern[5];
} barrier_cache;
struct {
uint32_t bitpattern[4];
} cleanup_cache;
struct {
uint32_t fnstart;
uint32_t *ehtp;
uint32_t additional;
uint32_t reserved1;
} pr_cache;
long long int : 0;
#endif
} exception;
id object;
#ifndef HAVE_ARM_EHABI_EXCEPTIONS
uintptr_t landingpad;
intptr_t filter;
#endif
};
struct lsda {
uintptr_t region_start, landingpads_start;
uint8_t typestable_enc;
const uint8_t *typestable;
uintptr_t typestable_base;
uint8_t callsites_enc;
const uint8_t *callsites, *actiontable;
};
extern _Unwind_Reason_Code _Unwind_RaiseException(struct _Unwind_Exception*);
extern void _Unwind_DeleteException(struct _Unwind_Exception*);
extern void* _Unwind_GetLanguageSpecificData(struct _Unwind_Context*);
extern uintptr_t _Unwind_GetRegionStart(struct _Unwind_Context*);
extern uintptr_t _Unwind_GetDataRelBase(struct _Unwind_Context*);
extern uintptr_t _Unwind_GetTextRelBase(struct _Unwind_Context*);
#ifndef HAVE_ARM_EHABI_EXCEPTIONS
# define CONTINUE_UNWIND return _URC_CONTINUE_UNWIND
extern uintptr_t _Unwind_GetIP(struct _Unwind_Context*);
extern void _Unwind_SetIP(struct _Unwind_Context*, uintptr_t);
extern void _Unwind_SetGR(struct _Unwind_Context*, int, uintptr_t);
#else
extern _Unwind_Reason_Code __gnu_unwind_frame(struct _Unwind_Exception*,
struct _Unwind_Context*);
extern int _Unwind_VRS_Get(struct _Unwind_Context*, int, uint32_t, int, void*);
extern int _Unwind_VRS_Set(struct _Unwind_Context*, int, uint32_t, int, void*);
# define CONTINUE_UNWIND \
{ \
if (__gnu_unwind_frame(ex, ctx) != _URC_OK) \
return _URC_FAILURE; \
\
return _URC_CONTINUE_UNWIND; \
}
static inline uintptr_t
_Unwind_GetGR(struct _Unwind_Context *ctx, int regno)
{
uintptr_t value;
_Unwind_VRS_Get(ctx, 0, regno, 0, &value);
return value;
}
static inline uintptr_t
_Unwind_GetIP(struct _Unwind_Context *ctx)
{
return _Unwind_GetGR(ctx, 15) & ~1;
}
static inline void
_Unwind_SetGR(struct _Unwind_Context *ctx, int regno, uintptr_t value)
{
_Unwind_VRS_Set(ctx, 0, regno, 0, &value);
}
static inline void
_Unwind_SetIP(struct _Unwind_Context *ctx, uintptr_t value)
{
uintptr_t thumb = _Unwind_GetGR(ctx, 15) & 1;
_Unwind_SetGR(ctx, 15, (value | thumb));
}
#endif
extern PERSONALITY_FUNC(CXX_PERSONALITY) __attribute__((__weak__));
#ifdef HAVE_SEH_EXCEPTIONS
extern EXCEPTION_DISPOSITION _GCC_specific_handler(PEXCEPTION_RECORD, void*,
PCONTEXT, PDISPATCHER_CONTEXT, _Unwind_Reason_Code(*)(int, int, uint64_t,
struct _Unwind_Exception*, struct _Unwind_Context*));
#endif
static objc_uncaught_exception_handler uncaught_exception_handler;
static uint64_t
read_uleb128(const uint8_t **ptr)
{
uint64_t value = 0;
uint8_t shift = 0;
do {
value |= (**ptr & 0x7F) << shift;
(*ptr)++;
shift += 7;
} while (*(*ptr - 1) & 0x80);
return value;
}
static int64_t
read_sleb128(const uint8_t **ptr)
{
const uint8_t *oldptr = *ptr;
uint8_t bits;
int64_t value;
value = read_uleb128(ptr);
bits = (*ptr - oldptr) * 7;
if (bits < 64 && value & (1 << (bits - 1)))
value |= -(1 << bits);
return value;
}
static uintptr_t
get_base(struct _Unwind_Context *ctx, uint8_t enc)
{
if (enc == DW_EH_PE_omit)
return 0;
switch (enc & 0x70) {
case DW_EH_PE_absptr:
case DW_EH_PE_pcrel:
case DW_EH_PE_aligned:
return 0;
case DW_EH_PE_funcrel:
return _Unwind_GetRegionStart(ctx);
case DW_EH_PE_datarel:
return _Unwind_GetDataRelBase(ctx);
case DW_EH_PE_textrel:
return _Unwind_GetTextRelBase(ctx);
}
OBJC_ERROR("Unknown encoding!")
}
static size_t
size_for_encoding(uint8_t enc)
{
if (enc == DW_EH_PE_omit)
return 0;
switch (enc & 0x07) {
case DW_EH_PE_absptr:
return sizeof(void*);
case DW_EH_PE_udata2:
return 2;
case DW_EH_PE_udata4:
return 4;
case DW_EH_PE_udata8:
return 8;
}
OBJC_ERROR("Unknown encoding!")
}
static uint64_t
read_value(uint8_t enc, const uint8_t **ptr)
{
uint64_t value;
if (enc == DW_EH_PE_aligned)
OBJC_ERROR("DW_EH_PE_aligned is not implemented!")
#define READ(type) \
{ \
value = *(type*)(void*)*ptr; \
*ptr += size_for_encoding(enc); \
break; \
}
switch (enc & 0x0F) {
case DW_EH_PE_absptr:
READ(uintptr_t)
case DW_EH_PE_uleb128:
value = read_uleb128(ptr);
break;
case DW_EH_PE_udata2:
READ(uint16_t)
case DW_EH_PE_udata4:
READ(uint32_t)
case DW_EH_PE_udata8:
READ(uint64_t)
case DW_EH_PE_sleb128:
value = read_sleb128(ptr);
break;
case DW_EH_PE_sdata2:
READ(int16_t)
case DW_EH_PE_sdata4:
READ(int32_t)
case DW_EH_PE_sdata8:
READ(int64_t)
default:
OBJC_ERROR("Unknown encoding!")
}
#undef READ
return value;
}
#ifndef HAVE_ARM_EHABI_EXCEPTIONS
static uint64_t
resolve_value(uint64_t value, uint8_t enc, const uint8_t *start, uint64_t base)
{
if (value == 0)
return 0;
value += ((enc & 0x70) == DW_EH_PE_pcrel ? (uintptr_t)start : base);
if (enc & DW_EH_PE_indirect)
value = *(uintptr_t*)(uintptr_t)value;
return value;
}
#endif
static void
read_lsda(struct _Unwind_Context *ctx, const uint8_t *ptr, struct lsda *lsda)
{
uint8_t landingpads_start_enc;
uintptr_t callsites_size;
lsda->region_start = _Unwind_GetRegionStart(ctx);
lsda->landingpads_start = lsda->region_start;
lsda->typestable = NULL;
if ((landingpads_start_enc = *ptr++) != DW_EH_PE_omit)
lsda->landingpads_start =
(uintptr_t)read_value(landingpads_start_enc, &ptr);
if ((lsda->typestable_enc = *ptr++) != DW_EH_PE_omit) {
uintptr_t tmp = (uintptr_t)read_uleb128(&ptr);
lsda->typestable = ptr + tmp;
}
lsda->typestable_base = get_base(ctx, lsda->typestable_enc);
lsda->callsites_enc = *ptr++;
callsites_size = (uintptr_t)read_uleb128(&ptr);
lsda->callsites = ptr;
lsda->actiontable = lsda->callsites + callsites_size;
}
static bool
find_callsite(struct _Unwind_Context *ctx, struct lsda *lsda,
uintptr_t *landingpad, const uint8_t **actionrecords)
{
uintptr_t ip = _Unwind_GetIP(ctx);
const uint8_t *ptr = lsda->callsites;
*landingpad = 0;
*actionrecords = NULL;
#ifndef HAVE_SJLJ_EXCEPTIONS
while (ptr < lsda->actiontable) {
uintptr_t callsite_start, callsite_len, callsite_landingpad;
uintptr_t callsite_action;
callsite_start = lsda->region_start +
(uintptr_t)read_value(lsda->callsites_enc, &ptr);
callsite_len = (uintptr_t)read_value(lsda->callsites_enc, &ptr);
callsite_landingpad =
(uintptr_t)read_value(lsda->callsites_enc, &ptr);
callsite_action = (uintptr_t)read_uleb128(&ptr);
/* We can stop if we passed IP, as the table is sorted */
if (callsite_start >= ip)
break;
if (callsite_start + callsite_len >= ip) {
if (callsite_landingpad != 0)
*landingpad = lsda->landingpads_start +
callsite_landingpad;
if (callsite_action != 0)
*actionrecords = lsda->actiontable +
callsite_action - 1;
return true;
}
}
return false;
#else
uintptr_t callsite_landingpad, callsite_action;
if ((uintptr_t)ip < 1)
return false;
do {
callsite_landingpad = (uintptr_t)read_uleb128(&ptr);
callsite_action = (uintptr_t)read_uleb128(&ptr);
} while (--ip > 1);
*landingpad = callsite_landingpad + 1;
if (callsite_action != 0)
*actionrecords = lsda->actiontable + callsite_action - 1;
return true;
#endif
}
static bool
class_matches(Class class, id object)
{
Class iter;
if (class == Nil)
return true;
if (object == nil)
return false;
for (iter = object_getClass(object); iter != Nil;
iter = class_getSuperclass(iter))
if (iter == class)
return true;
return false;
}
static uint8_t
find_actionrecord(const uint8_t *actionrecords, struct lsda *lsda, int actions,
bool foreign, struct objc_exception *e, intptr_t *filtervalue)
{
const uint8_t *ptr;
intptr_t filter, displacement;
do {
ptr = actionrecords;
filter = (intptr_t)read_sleb128(&ptr);
/*
* Get the next action record. Since read_sleb128 modifies ptr,
* we first set the actionrecord to the current ptr and then
* add the displacement.
*/
actionrecords = ptr;
displacement = (intptr_t)read_sleb128(&ptr);
actionrecords += displacement;
if (filter > 0 && !(actions & _UA_FORCE_UNWIND) && !foreign) {
Class class;
const char *className;
uintptr_t c;
const uint8_t *tmp;
#ifndef HAVE_ARM_EHABI_EXCEPTIONS
uintptr_t i;
i = filter * size_for_encoding(lsda->typestable_enc);
tmp = lsda->typestable - i;
c = (uintptr_t)read_value(lsda->typestable_enc, &tmp);
c = (uintptr_t)resolve_value(c, lsda->typestable_enc,
lsda->typestable - i, lsda->typestable_base);
#else
tmp = lsda->typestable - (filter * 4);
c = *(uintptr_t*)(void*)tmp;
if (c != 0) {
c += (uintptr_t)tmp;
# if defined(OF_LINUX) || defined(OF_NETBSD)
c = *(uintptr_t*)c;
# endif
}
#endif
className = (const char*)c;
if (className != NULL && *className != '\0' &&
strcmp(className, "@id") != 0)
class = objc_getRequiredClass(className);
else
class = Nil;
if (class_matches(class, e->object)) {
*filtervalue = filter;
return HANDLER_FOUND;
}
} else if (filter == 0)
return CLEANUP_FOUND;
else if (filter < 0)
OBJC_ERROR("Invalid filter!")
} while (displacement != 0);
return 0;
}
#ifdef HAVE_SEH_EXCEPTIONS
static
#endif
PERSONALITY_FUNC(PERSONALITY)
{
#ifdef HAVE_ARM_EHABI_EXCEPTIONS
int version = 1;
uint64_t ex_class = ex->class;
int actions;
switch (state) {
case 0: /* _US_VIRTUAL_UNWIND_FRAME */
actions = _UA_SEARCH_PHASE;
break;
case 1: /* _US_UNWIND_FRAME_STARTING */
actions = _UA_CLEANUP_PHASE;
if ((ex->barrier_cache.sp == _Unwind_GetGR(ctx, 13)) != 0)
actions |= _UA_HANDLER_FRAME;
break;
case 2: /* _US_UNWIND_FRAME_RESUME */
CONTINUE_UNWIND;
default:
return _URC_FAILURE;
}
_Unwind_SetGR(ctx, 12, (uintptr_t)ex);
#endif
struct objc_exception *e = (struct objc_exception*)ex;
bool foreign = (ex_class != GNUCOBJC_EXCEPTION_CLASS);
const uint8_t *lsda_addr, *actionrecords;
struct lsda lsda;
uintptr_t landingpad = 0;
uint8_t found = 0;
intptr_t filter = 0;
if (foreign) {
switch (ex_class) {
case GNUCCXX0_EXCEPTION_CLASS:
case CLNGCXX0_EXCEPTION_CLASS:
if (CXX_PERSONALITY != NULL)
return CALL_PERSONALITY(CXX_PERSONALITY);
break;
}
/*
* None matched or none available - we'll try to handle it
* anyway, but will most likely fail.
*/
}
if (version != 1 || ctx == NULL)
return _URC_FATAL_PHASE1_ERROR;
/*
* We already cached everything we found in phase 1, so we only need
* to install the context in phase 2.
*/
if (actions & _UA_HANDLER_FRAME && !foreign) {
/*
* For handlers, reg #0 must be the exception's object and reg
* #1 the filter.
*/
_Unwind_SetGR(ctx, __builtin_eh_return_data_regno(0),
(uintptr_t)e->object);
#ifndef HAVE_ARM_EHABI_EXCEPTIONS
_Unwind_SetGR(ctx, __builtin_eh_return_data_regno(1),
e->filter);
_Unwind_SetIP(ctx, e->landingpad);
#else
_Unwind_SetGR(ctx, __builtin_eh_return_data_regno(1),
ex->barrier_cache.bitpattern[1]);
_Unwind_SetIP(ctx, ex->barrier_cache.bitpattern[3]);
#endif
_Unwind_DeleteException(ex);
return _URC_INSTALL_CONTEXT;
}
/* No LSDA -> nothing to handle */
if ((lsda_addr = _Unwind_GetLanguageSpecificData(ctx)) == NULL)
CONTINUE_UNWIND;
read_lsda(ctx, lsda_addr, &lsda);
if (!find_callsite(ctx, &lsda, &landingpad, &actionrecords))
CONTINUE_UNWIND;
if (landingpad != 0 && actionrecords != NULL)
found = find_actionrecord(actionrecords, &lsda, actions,
foreign, e, &filter);
else if (landingpad != 0)
found = CLEANUP_FOUND;
if (found == 0)
CONTINUE_UNWIND;
if (actions & _UA_SEARCH_PHASE) {
if (!(found & HANDLER_FOUND) || foreign)
CONTINUE_UNWIND;
/* Cache it so we don't have to search it again in phase 2 */
#ifndef HAVE_ARM_EHABI_EXCEPTIONS
e->landingpad = landingpad;
e->filter = filter;
#else
ex->barrier_cache.sp = _Unwind_GetGR(ctx, 13);
ex->barrier_cache.bitpattern[1] = filter;
ex->barrier_cache.bitpattern[3] = landingpad;
#endif
return _URC_HANDLER_FOUND;
} else if (actions & _UA_CLEANUP_PHASE) {
if (!(found & CLEANUP_FOUND))
CONTINUE_UNWIND;
_Unwind_SetGR(ctx, __builtin_eh_return_data_regno(0),
(uintptr_t)ex);
_Unwind_SetGR(ctx, __builtin_eh_return_data_regno(1), filter);
_Unwind_SetIP(ctx, landingpad);
return _URC_INSTALL_CONTEXT;
}
OBJC_ERROR("Neither _UA_SEARCH_PHASE nor _UA_CLEANUP_PHASE in actions!")
}
static void
cleanup(_Unwind_Reason_Code reason, struct _Unwind_Exception *ex)
{
free(ex);
}
void
objc_exception_throw(id object)
{
struct objc_exception *e;
if ((e = malloc(sizeof(*e))) == NULL)
OBJC_ERROR("Not enough memory to allocate exception!")
memset(e, 0, sizeof(*e));
e->exception.class = GNUCOBJC_EXCEPTION_CLASS;
e->exception.cleanup = cleanup;
e->object = object;
if (_Unwind_RaiseException(&e->exception) == _URC_END_OF_STACK &&
uncaught_exception_handler != NULL)
uncaught_exception_handler(object);
OBJC_ERROR("_Unwind_RaiseException() returned!")
}
objc_uncaught_exception_handler
objc_setUncaughtExceptionHandler(objc_uncaught_exception_handler handler)
{
objc_uncaught_exception_handler old = uncaught_exception_handler;
uncaught_exception_handler = handler;
return old;
}
#ifdef HAVE_SEH_EXCEPTIONS
EXCEPTION_DISPOSITION
__gnu_objc_personality_seh0(PEXCEPTION_RECORD ms_exc, void *this_frame,
PCONTEXT ms_orig_context, PDISPATCHER_CONTEXT ms_disp)
{
return _GCC_specific_handler(ms_exc, this_frame, ms_orig_context,
ms_disp, PERSONALITY);
}
#endif