ReactOS  0.4.15-dev-1201-gb2cf5a4
cppexcept.h
Go to the documentation of this file.
1 /*
2  * msvcrt C++ exception handling
3  *
4  * Copyright 2002 Alexandre Julliard
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
19  */
20 
21 #ifndef __MSVCRT_CPPEXCEPT_H
22 #define __MSVCRT_CPPEXCEPT_H
23 
24 #include <pseh/pseh2.h>
25 
26 #define CXX_FRAME_MAGIC_VC6 0x19930520
27 #define CXX_FRAME_MAGIC_VC7 0x19930521
28 #define CXX_FRAME_MAGIC_VC8 0x19930522
29 #define CXX_EXCEPTION 0xe06d7363
30 
31 /* Macros to define assembler functions somewhat portably */
32 
33 #define EH_NONCONTINUABLE 0x01
34 #define EH_UNWINDING 0x02
35 #define EH_EXIT_UNWIND 0x04
36 #define EH_STACK_INVALID 0x08
37 #define EH_NESTED_CALL 0x10
38 
39 typedef void (*vtable_ptr)();
40 
41 /* type_info object, see cpp.c for inplementation */
42 typedef struct __type_info
43 {
45  char *name; /* Unmangled name, allocated lazily */
46  char mangled[32]; /* Variable length, but we declare it large enough for static RTTI */
47 } type_info;
48 
49 /* exception object */
50 typedef struct __exception
51 {
53  char *name; /* Name of this exception, always a new copy for each object */
54  int do_free; /* Whether to free 'name' in our dtor */
55 } exception;
56 
57 /* the exception frame used by CxxFrameHandler */
58 typedef struct __cxx_exception_frame
59 {
60  EXCEPTION_REGISTRATION_RECORD frame; /* the standard exception frame */
61  int trylevel;
64 
65 /* info about a single catch {} block */
66 typedef struct __catchblock_info
67 {
68  UINT flags; /* flags (see below) */
69  const type_info *type_info; /* C++ type caught by this block */
70  int offset; /* stack offset to copy exception object to */
71  void (*handler)(void);/* catch block handler code */
73 #define TYPE_FLAG_CONST 1
74 #define TYPE_FLAG_VOLATILE 2
75 #define TYPE_FLAG_REFERENCE 8
76 
77 /* info about a single try {} block */
78 typedef struct __tryblock_info
79 {
80  int start_level; /* start trylevel of that block */
81  int end_level; /* end trylevel of that block */
82  int catch_level; /* initial trylevel of the catch block */
83  int catchblock_count; /* count of catch blocks in array */
84  const catchblock_info *catchblock; /* array of catch blocks */
86 
87 /* info about the unwind handler for a given trylevel */
88 typedef struct __unwind_info
89 {
90  int prev; /* prev trylevel unwind handler, to run after this one */
91  void (*handler)(void);/* unwind handler */
92 } unwind_info;
93 
94 /* descriptor of all try blocks of a given function */
95 typedef struct __cxx_function_descr
96 {
97  UINT magic; /* must be CXX_FRAME_MAGIC */
98  UINT unwind_count; /* number of unwind handlers */
99  const unwind_info *unwind_table; /* array of unwind handlers */
100  UINT tryblock_count; /* number of try blocks */
101  const tryblock_info *tryblock; /* array of try blocks */
103  const void *ipmap;
104  const void *expect_list; /* expected exceptions list when magic >= VC7 */
105  UINT flags; /* flags when magic >= VC8 */
107 
108 #define FUNC_DESCR_SYNCHRONOUS 1 /* synchronous exceptions only (built with /EHs) */
109 
110 typedef void (*cxx_copy_ctor)(void);
111 
112 /* offsets for computing the this pointer */
113 typedef struct
114 {
115  int this_offset; /* offset of base class this pointer from start of object */
116  int vbase_descr; /* offset of virtual base class descriptor */
117  int vbase_offset; /* offset of this pointer offset in virtual base class descriptor */
119 
120 /* complete information about a C++ type */
121 typedef struct __cxx_type_info
122 {
123  UINT flags; /* flags (see CLASS_* flags below) */
124  const type_info *type_info; /* C++ type info */
125  this_ptr_offsets offsets; /* offsets for computing the this pointer */
126  unsigned int size; /* object size */
127  cxx_copy_ctor copy_ctor; /* copy constructor */
128 } cxx_type_info;
129 #define CLASS_IS_SIMPLE_TYPE 1
130 #define CLASS_HAS_VIRTUAL_BASE_CLASS 4
131 
132 /* table of C++ types that apply for a given object */
133 typedef struct __cxx_type_info_table
134 {
135  UINT count; /* number of types */
136  const cxx_type_info *info[3]; /* variable length, we declare it large enough for static RTTI */
138 
141  const cxx_function_descr*, int nested_trylevel,
142  EXCEPTION_REGISTRATION_RECORD *nested_frame, DWORD unknown3 );
143 
144 /* type information for an exception object */
145 typedef struct __cxx_exception_type
146 {
147  UINT flags; /* TYPE_FLAG flags */
148  void (*destructor)(void);/* exception object destructor */
149  cxx_exc_custom_handler custom_handler; /* custom handler for this exception */
150  const cxx_type_info_table *type_info_table; /* list of types for this exception object */
152 
156 
157 static inline const char *dbgstr_type_info( const type_info *info )
158 {
159  if (!info) return "{}";
160  return wine_dbg_sprintf( "{vtable=%p name=%s (%s)}",
161  info->vtable, info->mangled, info->name ? info->name : "" );
162 }
163 
164 /* compute the this pointer for a base class of a given type */
165 static inline void *get_this_pointer( const this_ptr_offsets *off, void *object )
166 {
167  if (!object) return NULL;
168 
169  if (off->vbase_descr >= 0)
170  {
171  int *offset_ptr;
172 
173  /* move this ptr to vbase descriptor */
174  object = (char *)object + off->vbase_descr;
175  /* and fetch additional offset from vbase descriptor */
176  offset_ptr = (int *)(*(char **)object + off->vbase_offset);
177  object = (char *)object + *offset_ptr;
178  }
179 
180  object = (char *)object + off->this_offset;
181  return object;
182 }
183 
184 #endif /* __MSVCRT_CPPEXCEPT_H */
struct _EXCEPTION_RECORD * PEXCEPTION_RECORD
void(* handler)(void)
Definition: cppexcept.h:91
void(* cxx_copy_ctor)(void)
Definition: cppexcept.h:110
void WINAPI _CxxThrowException(exception *, const cxx_exception_type *)
Definition: cpp.c:1574
struct png_info_def **typedef void(__cdecl typeof(png_destroy_read_struct))(struct png_struct_def **
Definition: typeof.h:49
const type_info * type_info
Definition: cppexcept.h:124
struct __cxx_function_descr cxx_function_descr
LONG NTSTATUS
Definition: precomp.h:26
const unwind_info * unwind_table
Definition: cppexcept.h:99
int catchblock_count
Definition: cppexcept.h:83
const vtable_ptr * vtable
Definition: cppexcept.h:44
#define DWORD
Definition: nt_native.h:44
const catchblock_info * catchblock
Definition: cppexcept.h:84
struct __cxx_type_info cxx_type_info
const char * wine_dbg_sprintf(const char *format,...)
Definition: compat.c:296
char mangled[16]
Definition: cpp.c:36
struct __tryblock_info tryblock_info
static void * get_this_pointer(const this_ptr_offsets *off, void *object)
Definition: cppexcept.h:165
char * name
Definition: cpp.c:35
this_ptr_offsets offsets
Definition: cppexcept.h:125
smooth NULL
Definition: ftsmooth.c:416
cxx_exc_custom_handler custom_handler
Definition: cppexcept.h:149
int CDECL __CppXcptFilter(NTSTATUS, PEXCEPTION_POINTERS)
const void * expect_list
Definition: cppexcept.h:104
void(* destructor)(void)
Definition: cppexcept.h:148
DWORD(* cxx_exc_custom_handler)(PEXCEPTION_RECORD, cxx_exception_frame *, PCONTEXT, EXCEPTION_REGISTRATION_RECORD **, const cxx_function_descr *, int nested_trylevel, EXCEPTION_REGISTRATION_RECORD *nested_frame, DWORD unknown3)
Definition: cppexcept.h:139
EXCEPTION_REGISTRATION_RECORD frame
Definition: cppexcept.h:60
struct __catchblock_info catchblock_info
#define WINAPI
Definition: msvc.h:6
void(* handler)(void)
Definition: cppexcept.h:71
unsigned long DWORD
Definition: ntddk_ex.h:95
const type_info * type_info
Definition: cppexcept.h:69
void(* vtable_ptr)()
Definition: cppexcept.h:39
unsigned int size
Definition: cppexcept.h:126
cxx_copy_ctor copy_ctor
Definition: cppexcept.h:127
struct __cxx_exception_frame cxx_exception_frame
struct __type_info type_info
struct __unwind_info unwind_info
struct __cxx_exception_type cxx_exception_type
struct __exception exception
static const char * dbgstr_type_info(const type_info *info)
Definition: cppexcept.h:157
char * name
Definition: cpp.c:28
#define CDECL
Definition: compat.h:29
const cxx_type_info_table * type_info_table
Definition: cppexcept.h:150
const void * ipmap
Definition: cppexcept.h:103
int do_free
Definition: cpp.c:29
unsigned int UINT
Definition: ndis.h:50
CONTEXT * PCONTEXT
Definition: compat.h:558
int CDECL _XcptFilter(NTSTATUS, PEXCEPTION_POINTERS)
Definition: except.c:274
const tryblock_info * tryblock
Definition: cppexcept.h:101
const vtable_ptr * vtable
Definition: cppexcept.h:52
struct __cxx_type_info_table cxx_type_info_table
off
Definition: i386-dis.c:3909