1 // new abi support -*- C++ -*-
3 // Copyright (C) 2000, 2002, 2003, 2004, 2006 Free Software Foundation, Inc.
5 // This file is part of GCC.
7 // GCC is free software; you can redistribute it and/or modify
8 // it under the terms of the GNU General Public License as published by
9 // the Free Software Foundation; either version 2, or (at your option)
12 // GCC is distributed in the hope that it will be useful,
13 // but WITHOUT ANY WARRANTY; without even the implied warranty of
14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 // GNU General Public License for more details.
17 // You should have received a copy of the GNU General Public License
18 // along with GCC; see the file COPYING. If not, write to
19 // the Free Software Foundation, 51 Franklin Street, Fifth Floor,
20 // Boston, MA 02110-1301, USA.
22 // As a special exception, you may use this file as part of a free software
23 // library without restriction. Specifically, if other files instantiate
24 // templates or use macros or inline functions from this file, or you compile
25 // this file and link it with other files to produce an executable, this
26 // file does not by itself cause the resulting executable to be covered by
27 // the GNU General Public License. This exception does not however
28 // invalidate any other reasons why the executable file might be covered by
29 // the GNU General Public License.
31 // Written by Nathan Sidwell, Codesourcery LLC, <nathan@codesourcery.com>
33 /* This file declares the new abi entry points into the runtime. It is not
34 normally necessary for user programs to include this header, or use the
35 entry points directly. However, this header is available should that be
38 Some of the entry points are intended for both C and C++, thus this header
39 is includable from both C and C++. Though the C++ specific parts are not
40 available in C, naturally enough. */
43 * The header provides an interface to the C++ ABI.
46 #ifndef _CXXABI_INTERNAL_H
47 #define _CXXABI_INTERNAL_H 1
49 #pragma GCC visibility push(default)
52 #include <bits/cxxabi_tweaks.h>
61 typedef __cxa_cdtor_return_type (*__cxa_cdtor_type
)(void *);
65 __cxa_vec_new(size_t __element_count
, size_t __element_size
,
66 size_t __padding_size
, __cxa_cdtor_type constructor
,
67 __cxa_cdtor_type destructor
);
70 __cxa_vec_new2(size_t __element_count
, size_t __element_size
,
71 size_t __padding_size
, __cxa_cdtor_type constructor
,
72 __cxa_cdtor_type destructor
, void *(*__alloc
) (size_t),
73 void (*__dealloc
) (void*));
76 __cxa_vec_new3(size_t __element_count
, size_t __element_size
,
77 size_t __padding_size
, __cxa_cdtor_type constructor
,
78 __cxa_cdtor_type destructor
, void *(*__alloc
) (size_t),
79 void (*__dealloc
) (void*, size_t));
82 __cxa_vec_ctor_return_type
83 __cxa_vec_ctor(void* __array_address
, size_t __element_count
,
84 size_t __element_size
, __cxa_cdtor_type constructor
,
85 __cxa_cdtor_type destructor
);
87 __cxa_vec_ctor_return_type
88 __cxa_vec_cctor(void* dest_array
, void* src_array
, size_t element_count
,
90 __cxa_cdtor_return_type (*constructor
) (void*, void*),
91 __cxa_cdtor_type destructor
);
95 __cxa_vec_dtor(void* __array_address
, size_t __element_count
,
96 size_t __element_size
, __cxa_cdtor_type destructor
);
99 __cxa_vec_cleanup(void* __array_address
, size_t __element_count
,
100 size_t __element_size
, __cxa_cdtor_type destructor
);
102 // Destruct and release array.
104 __cxa_vec_delete(void* __array_address
, size_t __element_size
,
105 size_t __padding_size
, __cxa_cdtor_type destructor
);
108 __cxa_vec_delete2(void* __array_address
, size_t __element_size
,
109 size_t __padding_size
, __cxa_cdtor_type destructor
,
110 void (*__dealloc
) (void*));
113 __cxa_vec_delete3(void* __array_address
, size_t __element_size
,
114 size_t __padding_size
, __cxa_cdtor_type destructor
,
115 void (*__dealloc
) (void*, size_t));
118 __cxa_guard_acquire(__guard
*);
121 __cxa_guard_release(__guard
*);
124 __cxa_guard_abort(__guard
*);
126 // Pure virtual functions.
128 __cxa_pure_virtual(void);
130 // Exception handling.
139 __cxa_atexit(void (*)(void*), void*, void*)
146 __cxa_finalize(void*);
148 // Demangling routines.
150 __cxa_demangle(const char* __mangled_name
, char* __output_buffer
,
151 size_t* __length
, int* __status
);
154 } // namespace __cxxabiv1
163 // Type information for int, float etc.
164 class __fundamental_type_info
: public std::type_info
168 __fundamental_type_info(const char* __n
) : std::type_info(__n
) { }
171 ~__fundamental_type_info();
174 // Type information for array objects.
175 class __array_type_info
: public std::type_info
179 __array_type_info(const char* __n
) : std::type_info(__n
) { }
182 ~__array_type_info();
185 // Type information for functions (both member and non-member).
186 class __function_type_info
: public std::type_info
190 __function_type_info(const char* __n
) : std::type_info(__n
) { }
193 ~__function_type_info();
196 // Implementation defined member function.
198 __is_function_p() const;
201 // Type information for enumerations.
202 class __enum_type_info
: public std::type_info
206 __enum_type_info(const char* __n
) : std::type_info(__n
) { }
212 // Common type information for simple pointers and pointers to member.
213 class __pbase_type_info
: public std::type_info
216 unsigned int __flags
; // Qualification of the target object.
217 const std::type_info
* __pointee
; // Type of pointed to object.
220 __pbase_type_info(const char* __n
, int __quals
,
221 const std::type_info
* __type
)
222 : std::type_info(__n
), __flags(__quals
), __pointee(__type
)
226 ~__pbase_type_info();
228 // Implementation defined type.
232 __volatile_mask
= 0x2,
233 __restrict_mask
= 0x4,
234 __incomplete_mask
= 0x8,
235 __incomplete_class_mask
= 0x10
239 __pbase_type_info(const __pbase_type_info
&);
242 operator=(const __pbase_type_info
&);
244 // Implementation defined member functions.
246 __do_catch(const std::type_info
* __thr_type
, void** __thr_obj
,
247 unsigned int __outer
) const;
250 __pointer_catch(const __pbase_type_info
* __thr_type
, void** __thr_obj
,
251 unsigned __outer
) const;
254 // Type information for simple pointers.
255 class __pointer_type_info
: public __pbase_type_info
259 __pointer_type_info(const char* __n
, int __quals
,
260 const std::type_info
* __type
)
261 : __pbase_type_info (__n
, __quals
, __type
) { }
265 ~__pointer_type_info();
268 // Implementation defined member functions.
270 __is_pointer_p() const;
273 __pointer_catch(const __pbase_type_info
* __thr_type
, void** __thr_obj
,
274 unsigned __outer
) const;
277 class __class_type_info
;
279 // Type information for a pointer to member variable.
280 class __pointer_to_member_type_info
: public __pbase_type_info
283 __class_type_info
* __context
; // Class of the member.
286 __pointer_to_member_type_info(const char* __n
, int __quals
,
287 const std::type_info
* __type
,
288 __class_type_info
* __klass
)
289 : __pbase_type_info(__n
, __quals
, __type
), __context(__klass
) { }
292 ~__pointer_to_member_type_info();
295 __pointer_to_member_type_info(const __pointer_to_member_type_info
&);
297 __pointer_to_member_type_info
&
298 operator=(const __pointer_to_member_type_info
&);
300 // Implementation defined member function.
302 __pointer_catch(const __pbase_type_info
* __thr_type
, void** __thr_obj
,
303 unsigned __outer
) const;
306 // Helper class for __vmi_class_type.
307 class __base_class_type_info
310 const __class_type_info
* __base_type
; // Base class type.
311 long __offset_flags
; // Offset and info.
313 enum __offset_flags_masks
315 __virtual_mask
= 0x1,
318 __offset_shift
= 8 // Bits to shift offset.
321 // Implementation defined member functions.
323 __is_virtual_p() const
324 { return __offset_flags
& __virtual_mask
; }
327 __is_public_p() const
328 { return __offset_flags
& __public_mask
; }
333 // This shift, being of a signed type, is implementation
334 // defined. GCC implements such shifts as arithmetic, which is
336 return static_cast<ptrdiff_t>(__offset_flags
) >> __offset_shift
;
340 // Type information for a class.
341 class __class_type_info
: public std::type_info
345 __class_type_info (const char *__n
) : type_info(__n
) { }
348 ~__class_type_info ();
350 // Implementation defined types.
351 // The type sub_kind tells us about how a base object is contained
352 // within a derived object. We often do this lazily, hence the
353 // UNKNOWN value. At other times we may use NOT_CONTAINED to mean
354 // not publicly contained.
360 // Not contained within us (in some circumstances this might
361 // mean not contained publicly)
364 // Contained ambiguously.
367 // Via a virtual path.
368 __contained_virtual_mask
= __base_class_type_info::__virtual_mask
,
370 // Via a public path.
371 __contained_public_mask
= __base_class_type_info::__public_mask
,
373 // Contained within us.
374 __contained_mask
= 1 << __base_class_type_info::__hwm_bit
,
376 __contained_private
= __contained_mask
,
377 __contained_public
= __contained_mask
| __contained_public_mask
380 struct __upcast_result
;
381 struct __dyncast_result
;
384 // Implementation defined member functions.
386 __do_upcast(const __class_type_info
* __dst_type
, void**__obj_ptr
) const;
389 __do_catch(const type_info
* __thr_type
, void** __thr_obj
,
390 unsigned __outer
) const;
393 // Helper for upcast. See if DST is us, or one of our bases.
394 // Return false if not found, true if found.
396 __do_upcast(const __class_type_info
* __dst
, const void* __obj
,
397 __upcast_result
& __restrict __result
) const;
399 // Indicate whether SRC_PTR of type SRC_TYPE is contained publicly
400 // within OBJ_PTR. OBJ_PTR points to a base object of our type,
401 // which is the destination type. SRC2DST indicates how SRC
402 // objects might be contained within this type. If SRC_PTR is one
403 // of our SRC_TYPE bases, indicate the virtuality. Returns
404 // not_contained for non containment or private containment.
406 __find_public_src(ptrdiff_t __src2dst
, const void* __obj_ptr
,
407 const __class_type_info
* __src_type
,
408 const void* __src_ptr
) const;
410 // Helper for dynamic cast. ACCESS_PATH gives the access from the
411 // most derived object to this base. DST_TYPE indicates the
412 // desired type we want. OBJ_PTR points to a base of our type
413 // within the complete object. SRC_TYPE indicates the static type
414 // started from and SRC_PTR points to that base within the most
415 // derived object. Fill in RESULT with what we find. Return true
416 // if we have located an ambiguous match.
418 __do_dyncast(ptrdiff_t __src2dst
, __sub_kind __access_path
,
419 const __class_type_info
* __dst_type
, const void* __obj_ptr
,
420 const __class_type_info
* __src_type
, const void* __src_ptr
,
421 __dyncast_result
& __result
) const;
423 // Helper for find_public_subobj. SRC2DST indicates how SRC_TYPE
424 // bases are inherited by the type started from -- which is not
425 // necessarily the current type. The current type will be a base
426 // of the destination type. OBJ_PTR points to the current base.
428 __do_find_public_src(ptrdiff_t __src2dst
, const void* __obj_ptr
,
429 const __class_type_info
* __src_type
,
430 const void* __src_ptr
) const;
433 // Type information for a class with a single non-virtual base.
434 class __si_class_type_info
: public __class_type_info
437 const __class_type_info
* __base_type
;
440 __si_class_type_info(const char *__n
, const __class_type_info
*__base
)
441 : __class_type_info(__n
), __base_type(__base
) { }
444 ~__si_class_type_info();
447 __si_class_type_info(const __si_class_type_info
&);
449 __si_class_type_info
&
450 operator=(const __si_class_type_info
&);
452 // Implementation defined member functions.
454 __do_dyncast(ptrdiff_t __src2dst
, __sub_kind __access_path
,
455 const __class_type_info
* __dst_type
, const void* __obj_ptr
,
456 const __class_type_info
* __src_type
, const void* __src_ptr
,
457 __dyncast_result
& __result
) const;
460 __do_find_public_src(ptrdiff_t __src2dst
, const void* __obj_ptr
,
461 const __class_type_info
* __src_type
,
462 const void* __sub_ptr
) const;
465 __do_upcast(const __class_type_info
*__dst
, const void*__obj
,
466 __upcast_result
& __restrict __result
) const;
469 // Type information for a class with multiple and/or virtual bases.
470 class __vmi_class_type_info
: public __class_type_info
473 unsigned int __flags
; // Details about the class hierarchy.
474 unsigned int __base_count
; // Number of direct bases.
476 // The array of bases uses the trailing array struct hack so this
477 // class is not constructable with a normal constructor. It is
478 // internally generated by the compiler.
479 __base_class_type_info __base_info
[1]; // Array of bases.
482 __vmi_class_type_info(const char* __n
, int ___flags
)
483 : __class_type_info(__n
), __flags(___flags
), __base_count(0) { }
486 ~__vmi_class_type_info();
488 // Implementation defined types.
491 __non_diamond_repeat_mask
= 0x1, // Distinct instance of repeated base.
492 __diamond_shaped_mask
= 0x2, // Diamond shaped multiple inheritance.
493 __flags_unknown_mask
= 0x10
497 // Implementation defined member functions.
499 __do_dyncast(ptrdiff_t __src2dst
, __sub_kind __access_path
,
500 const __class_type_info
* __dst_type
, const void* __obj_ptr
,
501 const __class_type_info
* __src_type
, const void* __src_ptr
,
502 __dyncast_result
& __result
) const;
505 __do_find_public_src(ptrdiff_t __src2dst
, const void* __obj_ptr
,
506 const __class_type_info
* __src_type
,
507 const void* __src_ptr
) const;
510 __do_upcast(const __class_type_info
* __dst
, const void* __obj
,
511 __upcast_result
& __restrict __result
) const;
514 // Dynamic cast runtime.
515 // src2dst has the following possible values
516 // >-1: src_type is a unique public non-virtual base of dst_type
517 // dst_ptr + src2dst == src_ptr
518 // -1: unspecified relationship
519 // -2: src_type is not a public base of dst_type
520 // -3: src_type is a multiple public non-virtual base of dst_type
522 __dynamic_cast(const void* __src_ptr
, // Starting object.
523 const __class_type_info
* __src_type
, // Static type of object.
524 const __class_type_info
* __dst_type
, // Desired target type.
525 ptrdiff_t __src2dst
); // How src and dst are related.
528 // Returns the type_info for the currently handled exception [15.3/8], or
529 // null if there is none.
530 extern "C" std::type_info
*
531 __cxa_current_exception_type();
533 // A magic placeholder class that can be caught by reference
534 // to recognize forced unwinding.
535 class __forced_unwind
537 virtual ~__forced_unwind() throw();
538 virtual void __pure() = 0; // prevent catch by value
541 // A magic placeholder class that can be caught by reference
542 // to recognize foreign exceptions.
543 class __foreign_exception
545 virtual ~__foreign_exception() throw();
546 virtual void __pure() = 0; // prevent catch by value
549 } // namespace __cxxabiv1
551 #endif // __cplusplus
553 #pragma GCC visibility pop
555 #endif // __CXXABI_INTERNAL_H