kernel/eka/compsupp/symaehabi/unwind_env.h
changeset 0 a41df078684a
child 235 cbd07013118c
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/kernel/eka/compsupp/symaehabi/unwind_env.h	Mon Oct 19 15:55:17 2009 +0100
@@ -0,0 +1,382 @@
+/* unwind_env.h
+ *
+ * Copyright 2003-2005 ARM Limited. All rights reserved.
+ */
+/*
+  Licence
+  
+  1. Subject to the provisions of clause 2, ARM hereby grants to LICENSEE a 
+  perpetual, non-exclusive, nontransferable, royalty free, worldwide licence 
+  to use this Example Implementation of Exception Handling solely for the 
+  purpose of developing, having developed, manufacturing, having 
+  manufactured, offering to sell, selling, supplying or otherwise 
+  distributing products which comply with the Exception Handling ABI for the 
+  ARM Architecture specification. All other rights are reserved to ARM or its 
+  licensors.
+  
+  2. THIS EXAMPLE IMPLEMENTATION OF EXCEPTION HANDLING  IS PROVIDED "AS IS" 
+  WITH NO WARRANTIES EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT LIMITED 
+  TO ANY WARRANTY OF SATISFACTORY QUALITY, MERCHANTABILITY, NONINFRINGEMENT 
+  OR FITNESS FOR A PARTICULAR PURPOSE.
+*/
+
+/* Portions copyright Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies). */
+
+/*
+ * RCS $Revision: 92949 $
+ * Checkin $Date: 2005-10-12 11:07:03 +0100 (Wed, 12 Oct 2005) $
+ * Revising $Author: achapman $
+ */
+
+/* Environment definition - abstractions and requirements - to aid
+ * portability of the ARM exceptions code.
+ */
+
+#ifndef UNWINDENV_H
+#define UNWINDENV_H
+
+/* ---------------------------------------------------------------------- */
+
+/* Source language
+ *
+ * The compiler is expected to define preprocessor symbols as follows:
+ * __cplusplus when compiling in C++ mode.
+ * __thumb when compiling to Thumb code.
+ *
+ * Some use is made of embedded assembly language, introduced by __asm.
+ * This is described in ARM's toolchain documentation. Some edits may be
+ * required for other compilers. The compiler should define one or more of:
+ * __TARGET_ARCH_4T __TARGET_ARCH_4TXM __TARGET_ARCH_5T __TARGET_ARCH_5TXM
+ * __TARGET_ARCH_5TE __TARGET_ARCH_6
+ * so the correct assembly wrappers are generated for certain functions.
+ *
+ * __APCS_INTERWORK should be defined if ARM/Thumb interworking is required.
+ *
+ * For all the above symbols, if your compiler does not provide appropriate
+ * definitions, add them here.
+ *
+ * Some source language extensions are also used.
+ */
+
+/* ---------------------------------------------------------------------- */
+
+/* Library structure
+ *
+ * ARM's private make system contains an automated facility for compiling
+ * source files multiple times to create multiple object files. The source
+ * regions intended to constitute object file xxx.o are delimited by
+ * #ifdef xxx_c / #endif directives. The exact preprocessor symbols used
+ * for this conditionalisation are described in a comment at the start of
+ * each file. When porting to a different system, compilations must be
+ * performed with these preprocessor symbols appropriately defined
+ * (or remove the conditionalisation).
+ *
+ */
+#ifdef __EPOC32__ 
+
+#define ARM_EXCEPTIONS_ENABLED
+
+// turn on the source regions in unwinder.c
+#define unwinder_c
+#define unwind_activity_c
+
+// turn on the source regions in unwind_pr.c
+#define pr0_c
+#define pr1_c
+#define pr2_c
+#define prcommon_c
+
+// turn on the source regions in cppsemantics.cpp
+#define arm_exceptions_globs_c
+#define arm_exceptions_mem_c
+#define arm_exceptions_uncaught_c
+#define arm_exceptions_terminate_c
+#define arm_exceptions_setterminate_c
+#define arm_exceptions_unexpected_c
+#define arm_exceptions_setunexpected_c
+#define arm_exceptions_support_c
+#define arm_exceptions_callterm_c
+#define arm_exceptions_callunex_c
+#define arm_exceptions_currenttype_c
+#define arm_exceptions_alloc_c
+#define arm_exceptions_free_c
+#define arm_exceptions_throw_c
+#define arm_exceptions_rethrow_c
+#define arm_exceptions_foreign_c
+#define arm_exceptions_cleanup_c
+#define arm_exceptions_getexceptionptr_c
+#define arm_exceptions_catchsemantics_c
+#define arm_exceptions_begincatch_c
+#define arm_exceptions_endcatch_c
+#define arm_exceptions_bad_typeid_c
+#define arm_exceptions_bad_cast_c
+#endif
+
+/* ARM declares (or redeclares) some routines as weak in order that
+ * references to them are weak, so that the static linker will not load
+ * unwanted code. This is achieved by decorating routine declarations
+ * with appropriate language extensions. Note that compilers supporting
+ * similar features but via a different syntax may require edits to
+ * the library source.
+ *
+ * Define those decorations here (define as empty if not required):
+ */
+
+#ifndef __EPOC32__
+#define WEAKDECL __weak        /* token in C and C++ */
+#define WEAKASMDECL [WEAK]     /* token in assembler */
+#else
+// The symbian version needs all of these in the DLL, so don't make them weak
+#define WEAKDECL 
+#define WEAKASMDECL 
+#endif
+
+/* ---------------------------------------------------------------------- */
+
+/* Source language support and language extensions */
+
+/* It is possible to compile the C++ semantics code using a compiler
+ * which does not support C++ exceptions; this was useful to ARM whilst
+ * ARM's compiler was being developed, and the facility has not been
+ * removed. C++ exceptions syntax is conditionalised by
+ * #ifdef ARM_EXCEPTIONS_ENABLED / #endif. Define ARM_EXCEPTIONS_ENABLED
+ * by some means here if you want a usable library:
+ */
+
+#ifdef __cplusplus
+extern "C" {
+  /* For conditionalisation, specifically on ARM_EXCEPTIONS_ENABLED */
+#include "basics.h"
+}
+#endif
+
+/* The following definitions of syntax decoration may be empty if the
+ * facility is not required. Note that compilers supporting similar
+ * features but via a different syntax may require edits to the library
+ * source.
+ * 
+ * Define the decorations here (define as empty if not required):
+ */
+  
+/* If the compiler understands noreturn functions: */
+#define NORETURNDECL __declspec(noreturn)
+/* Inlining when compiling C */
+#define INLINE __inline
+/* Stronger encouragement to inline */
+#define FORCEINLINE __forceinline
+
+/* ---------------------------------------------------------------------- */
+
+/* Types */
+
+/* The implementation requires types uint8_t, uint16_t, uint32_t and
+ * uint64_t to be defined as unsigned integers of the appropriate number
+ * of bits.
+ *
+ * Do that here:
+ */
+
+#ifndef __EPOC32__
+#include <stdint.h>
+#else
+#include <e32def.h>
+typedef TUint8 uint8_t;
+typedef TUint16 uint16_t;
+typedef TInt32 int32_t;
+typedef TUint32 uint32_t;
+typedef Uint64 uint64_t;
+#endif
+
+/* The C++ semantics support requires definition of the RTTI object
+ * layout. We use the same structures and names as the generic C++
+ * ABI for Itanium.
+ *
+ * Define those structures here:
+ */
+
+#ifdef __cplusplus
+extern "C" {
+#include "cxxabi.h"
+}
+#endif
+
+/* ---------------------------------------------------------------------- */
+
+/* External requirements */
+
+/* The C++ exception-handling 'globals' should be allocated per-thread.
+ * The Exceptions ABI does not specify how this happens, but it is
+ * intended that the details are localised to __cxa_get_globals.
+ *
+ * In the ARM implementation of __cxa_get_globals, it is assumed that a
+ * zero-initialised location in a known per-thread place is somehow
+ * obtainable, and can be assigned (by __cxa_get_globals) a pointer to
+ * the allocated globals data structure. The macro EH_GLOBALS should be
+ * defined here to yield a suitable address of type void*. This is used
+ * only in __cxa_get_globals.
+ *
+ * Define it here:
+ */
+
+#ifdef __cplusplus
+#ifndef __EPOC32__
+extern "C" {
+  /* for __user_libspace() machinery */
+#include <interns.h>
+#define EH_GLOBALS libspace.eh_globals
+}
+#else
+#include <e32std.h>
+#define EH_GLOBALS (Dll::Tls())
+#endif
+#endif
+
+/* A routine is required for C++ derived class to base class conversion.
+ * This is used once, in __cxa_type_match. It is likely that suitable
+ * code exists as part of the RTTI support code. Therefore access it
+ * via a macro:
+ * DERIVED_TO_BASE_CONVERSION(PTR, P_NEW_PTR, CLASS_INFO, BASE_INFO)
+ *   Convert PTR from a pointer to a derived class (described by
+ *   CLASS_INFO) to a pointer to a base class (described by BASE_INFO)
+ *   and store the resulting pointer in P_NEW_PTR. Return true (or
+ *   non-zero) if the base class was found and the conversion was done,
+ *   otherwise return false (or zero).
+ *
+ * Define the macro here:
+ */
+
+#ifdef __cplusplus
+/* In the ARM implementation, a suitable routine exists elsewhere in the
+ * C++ runtime library, where it is part of the dynamic_cast mechanism.
+ */
+#if !defined(__EPOC32__) || (__ARMCC_VERSION > 310000)
+extern "C" int __derived_to_base_conversion(void** p_ptr, void** p_new_ptr,
+                                            const std::type_info * class_info,
+                                            const std::type_info * base_info,
+                                            char** access_flags, int use_access_flags);
+
+#define DERIVED_TO_BASE_CONVERSION(PTR, P_NEW_PTR, CLASS_INFO, BASE_INFO) \
+  __derived_to_base_conversion(&(PTR), (P_NEW_PTR), (CLASS_INFO), (BASE_INFO), NULL, 0)
+#else
+extern "C" TBool _DoDerivedToBaseConversion(const std::type_info* aDerivedType,
+											const std::type_info* aBaseType,
+			    							TAny** aDerivedObj,
+			    							TAny** aBaseObj);
+
+#define DERIVED_TO_BASE_CONVERSION(PTR, P_NEW_PTR, CLASS_INFO, BASE_INFO) \
+  _DoDerivedToBaseConversion(CLASS_INFO, BASE_INFO, &(PTR), P_NEW_PTR)
+#endif
+
+#endif
+
+/* The effect of R_ARM_TARGET2 relocations is platform-specific. A
+ * routine is required for handling references created via such
+ * relocations.  The routine takes the address of a location that was
+ * relocated by R_ARM_TARGET2, and returns a pointer to the absolute
+ * address of the referenced entity.
+ */
+
+static FORCEINLINE void *__ARM_resolve_target2(void *p)
+{
+#ifdef __APCS_FPIC
+  /* SVr4: R_ARM_TARGET2 is equivalent to R_ARM_GOT_PREL (placerel32 indirect) */
+  return *(void **)(*(uint32_t *)p + (uint32_t)p);
+#else
+  /* Bare metal: R_ARM_TARGET2 is equivalent to R_ARM_ABS32 */
+  return *(void **)p;
+#endif
+}
+
+/* ---------------------------------------------------------------------- */
+
+/* Runtime debug support
+ *
+ * Here we define the interface to a "bottleneck function" to be called
+ * by exception handling code at 'interesting' points during execution,
+ * and breakpointable by a debugger.
+ *
+ * This is not part of the Exceptions ABI but is expected to be
+ * standardised elsewhere, probably in a Debug ABI.
+ *
+ * If you don't want this, define DEBUGGER_BOTTLENECK as a dummy, e.g.
+ * #define DEBUGGER_BOTTLENECK(UCBP,LANG,ACTIVITY,ARG) (void)0
+ */
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+  struct _Unwind_Control_Block;
+
+  typedef enum {
+    _UASUBSYS_CPP      = 0x00,
+    _UASUBSYS_UNWINDER = 0xff
+  } _Unwind_Activity_subsystem;
+
+  typedef enum {
+    _UAACT_STARTING     = 0x0,
+    _UAACT_ENDING       = 0x1,
+    _UAACT_BARRIERFOUND = 0x2,
+    _UAACT_PADENTRY     = 0x3,
+    _UAACT_CPP_TYPEINFO = 0x80
+  } _Unwind_Activity_activity;
+
+  typedef enum {
+    _UAARG_ENDING_UNSPECIFIED           = 0x0,
+    _UAARG_ENDING_TABLECORRUPT          = 0x1,
+    _UAARG_ENDING_NOUNWIND              = 0x2,
+    _UAARG_ENDING_VRSFAILED             = 0x3,
+    /* C++ only: */
+    _UAARG_ENDING_CPP_BADOPCODE         = 0x4,
+    /* Unwinder only: */
+    _UAARG_ENDING_UNWINDER_LOOKUPFAILED = 0x4,
+    _UAARG_ENDING_UNWINDER_BUFFERFAILED = 0x5
+  } _Unwind_Activity_arg;
+
+  void _Unwind_Activity(struct _Unwind_Control_Block *ucbp, uint32_t reason, uint32_t arg);
+#define DEBUGGER_BOTTLENECK(UCBP,LANG,ACTIVITY,ARG) \
+  _Unwind_Activity((UCBP),((((uint32_t)(LANG))<<24)|ACTIVITY),(uint32_t)(ARG))
+
+#ifdef __cplusplus
+}
+#endif
+
+
+/* ---------------------------------------------------------------------- */
+
+/* Printed diagnostics
+ *
+ * These may be useful for debugging purposes during development, provided
+ * the execution environment supports diagnostics via printf.
+ *
+ * #define PR_DIAGNOSTICS for printed diagnostics from the personality routine.
+ * #define VRS_DIAGNOSTICS for printed diagnostics about VRS operations.
+ * #define UNWIND_ACTIVITY_DIAGNOSTICS for printed information from _Unwind_Activity.
+ * #define CPP_DIAGNOSTICS for printed diagnostics from the C++ semantics routines.
+ */
+
+/* ---------------------------------------------------------------------- 
+ * Abstractions added for SymbianOS. A process is contructed from multiple
+ * executables each with their own RO segment and exception data structures. 
+ * SymbianOS caches pointers to two data structures in the UCB which it then 
+ * uses to speed up the retrieval of certain information including values returned
+ * by the functions below.
+ * ---------------------------------------------------------------------- */
+#ifndef __EPOC32__
+#define ADDR_TO_ER_RO_OFFSET(addr, ucbp) addr_to_ER_RO_offset(addr)
+#define ER_RO_OFFSET_TO_ADDR(addr, ucbp)  ER_RO_offset_to_addr(addr)
+#else
+#define ADDR_TO_ER_RO_OFFSET(addr, ucbp) addr_to_ER_RO_offset(addr, ucbp)
+#define ER_RO_OFFSET_TO_ADDR(addr, ucbp)  ER_RO_offset_to_addr(addr, ucbp)
+#endif
+
+
+#endif /* defined UNWINDENV_H */
+
+
+
+
+
+
+
+