libcilkrts/runtime/except-gcc.h

   1 /* except-gcc.h                  -*-C++-*-
   2  *
   3  *************************************************************************
   4  *
   5  *  Copyright (C) 2009-2016, Intel Corporation
   6  *  All rights reserved.
   7  *
   8  *  Redistribution and use in source and binary forms, with or without
   9  *  modification, are permitted provided that the following conditions
  10  *  are met:
  11  *
  12  *    * Redistributions of source code must retain the above copyright
  13  *      notice, this list of conditions and the following disclaimer.
  14  *    * Redistributions in binary form must reproduce the above copyright
  15  *      notice, this list of conditions and the following disclaimer in
  16  *      the documentation and/or other materials provided with the
  17  *      distribution.
  18  *    * Neither the name of Intel Corporation nor the names of its
  19  *      contributors may be used to endorse or promote products derived
  20  *      from this software without specific prior written permission.
  21  *
  22  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  23  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  24  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  25  *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  26  *  HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  27  *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  28  *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
  29  *  OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  30  *  AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  31  *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
  32  *  WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  33  *  POSSIBILITY OF SUCH DAMAGE.
  34  *
  35  *  *********************************************************************
  36  *
  37  *  PLEASE NOTE: This file is a downstream copy of a file mainitained in
  38  *  a repository at cilkplus.org. Changes made to this file that are not
  39  *  submitted through the contribution process detailed at
  40  *  http://www.cilkplus.org/submit-cilk-contribution will be lost the next
  41  *  time that a new version is released. Changes only submitted to the
  42  *  GNU compiler collection or posted to the git repository at
  43  *  https://bitbucket.org/intelcilkruntime/intel-cilk-runtime.git are
  44  *  not tracked.
  45  *
  46  *  We welcome your contributions to this open source project. Thank you
  47  *  for your assistance in helping us improve Cilk Plus.
  48  **************************************************************************/
  49
  50 /**
  51  * @file except-gcc.h
  52  *
  53  * @brief ABI for gcc exception handling.
  54  *
  55  * @par Origin
  56  * The code below is generally copied from the Intel Itanium ABI (Intel
  57  * download 245370).
  58  */
  59
  60 #ifndef INCLUDED_EXCEPT_GCC_DOT_H
  61 #define INCLUDED_EXCEPT_GCC_DOT_H
  62
  63 #ifndef __cplusplus
  64 #   error except-gcc.h should be used in C++ code only.
  65 #endif
  66
  67 #include <cilk/common.h>
  68 #include <exception>
  69 #include <typeinfo>
  70
  71 struct __cxa_exception;
  72
  73 __CILKRTS_BEGIN_EXTERN_C
  74
  75 /** Unwind reason code (Itanium ABI 6.1.2.1) */
  76 typedef enum _Unwind_Reason_Code {
  77     _URC_NO_REASON = 0,
  78     _URC_FOREIGN_EXCEPTION_CAUGHT = 1,
  79     _URC_FATAL_PHASE2_ERROR = 2,
  80     _URC_FATAL_PHASE1_ERROR = 3,
  81     _URC_NORMAL_STOP = 4,
  82     _URC_END_OF_STACK = 5,
  83     _URC_HANDLER_FOUND = 6,
  84     _URC_INSTALL_CONTEXT = 7,
  85     _URC_CONTINUE_UNWIND = 8
  86 } _Unwind_Reason_Code;
  87
  88 typedef struct _Unwind_Exception _Unwind_Exception;
  89
  90 /** Exception cleanup function pointer (Itanium ABI 6.1.2.2) */
  91 typedef void (*_Unwind_Exception_Cleanup_Fn)(_Unwind_Reason_Code reason,
  92                                              _Unwind_Exception *exc);
  93
  94 /**
  95  * @brief Exception undwinding information
  96  *
  97  * This is copied from the Intel Itanium ABI except that the
  98  * private fields are declared unsigned long for binary
  99  * compatibility with gcc/g++ on 32 bit machines.
 100  */
 101 struct _Unwind_Exception
 102 {
 103     uint64_t                     exception_class;
 104     _Unwind_Exception_Cleanup_Fn exception_cleanup;
 105     unsigned long                private_1;
 106     unsigned long                private_2;
 107 };
 108
 109 /** Throw or rethrow an exception */
 110 _Unwind_Reason_Code
 111 _Unwind_RaiseException(_Unwind_Exception *exception_object);
 112
 113 /** Resume an exception other than by rethrowing it. */
 114 void _Unwind_Resume(_Unwind_Exception *exception_object);
 115
 116 /** Delete an exception object */
 117 void _Unwind_DeleteException(_Unwind_Exception *exception_object);
 118
 119 /**
 120  * C++ exception ABI.
 121  *  The following declarations are from
 122  *
 123  * http://www.codesourcery.com/public/cxx-abi/abi-eh.html#cxx-abi
 124  */
 125
 126 struct __cxa_exception {
 127     std::type_info *        exceptionType;
 128     void (*exceptionDestructor)(void *);
 129     std::unexpected_handler unexpectedHandler;
 130     std::terminate_handler  terminateHandler;
 131     __cxa_exception *       nextException;
 132
 133     int                     handlerCount;
 134     int                     handlerSwitchValue;
 135     const char *            actionRecord;
 136     const char *            languageSpecificData;
 137     void *                  catchTemp;
 138     void *                  adjustedPtr;
 139
 140     _Unwind_Exception       unwindHeader;
 141 };
 142
 143 static inline __cxa_exception *to_cxx(_Unwind_Exception *e)
 144 {
 145     return ((__cxa_exception *)(e+1)) - 1;
 146 }
 147
 148 typedef struct __cxa_eh_globals {
 149     __cxa_exception *caughtExceptions;
 150     unsigned int     uncaughtExceptions;
 151 } __cxa_eh_globals;
 152
 153 __cxa_eh_globals*__cxa_get_globals(void) throw();
 154
 155 __CILKRTS_END_EXTERN_C
 156
 157 #endif // ! defined(INCLUDED_EXCEPT_GCC_DOT_H)