1 // ABI Support -*- C++ -*-
3 // Copyright (C) 2000, 2002, 2003, 2004, 2006, 2007, 2009, 2010, 2011
4 // Free Software Foundation, Inc.
6 // This file is part of GCC.
8 // GCC is free software; you can redistribute it and/or modify
9 // it under the terms of the GNU General Public License as published by
10 // the Free Software Foundation; either version 3, or (at your option)
13 // GCC is distributed in the hope that it will be useful,
14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 // GNU General Public License for more details.
18 // Under Section 7 of GPL version 3, you are granted additional
19 // permissions described in the GCC Runtime Library Exception, version
20 // 3.1, as published by the Free Software Foundation.
22 // You should have received a copy of the GNU General Public License and
23 // a copy of the GCC Runtime Library Exception along with this program;
24 // see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
25 // <http://www.gnu.org/licenses/>.
27 // Written by Nathan Sidwell, Codesourcery LLC, <nathan@codesourcery.com>
29 /* This file declares the new abi entry points into the runtime. It is not
30 normally necessary for user programs to include this header, or use the
31 entry points directly. However, this header is available should that be
34 Some of the entry points are intended for both C and C++, thus this header
35 is includable from both C and C++. Though the C++ specific parts are not
36 available in C, naturally enough. */
39 * The header provides an interface to the C++ ABI.
45 #pragma GCC system_header
47 #pragma GCC visibility push(default)
50 #include <bits/c++config.h>
51 #include <bits/cxxabi_tweaks.h>
52 #include <bits/cxxabi_forced.h>
54 #ifndef _GLIBCXX_CDTOR_CALLABI
55 #define _GLIBCXX_CDTOR_CALLABI
65 typedef __cxa_cdtor_return_type (*__cxa_cdtor_type
)(void *);
69 __cxa_vec_new(size_t __element_count
, size_t __element_size
,
70 size_t __padding_size
, __cxa_cdtor_type __constructor
,
71 __cxa_cdtor_type __destructor
);
74 __cxa_vec_new2(size_t __element_count
, size_t __element_size
,
75 size_t __padding_size
, __cxa_cdtor_type __constructor
,
76 __cxa_cdtor_type __destructor
, void *(*__alloc
) (size_t),
77 void (*__dealloc
) (void*));
80 __cxa_vec_new3(size_t __element_count
, size_t __element_size
,
81 size_t __padding_size
, __cxa_cdtor_type __constructor
,
82 __cxa_cdtor_type __destructor
, void *(*__alloc
) (size_t),
83 void (*__dealloc
) (void*, size_t));
86 __cxa_vec_ctor_return_type
87 __cxa_vec_ctor(void* __array_address
, size_t __element_count
,
88 size_t __element_size
, __cxa_cdtor_type __constructor
,
89 __cxa_cdtor_type __destructor
);
91 __cxa_vec_ctor_return_type
92 __cxa_vec_cctor(void* __dest_array
, void* __src_array
,
93 size_t __element_count
, size_t __element_size
,
94 __cxa_cdtor_return_type (*__constructor
) (void*, void*),
95 __cxa_cdtor_type __destructor
);
99 __cxa_vec_dtor(void* __array_address
, size_t __element_count
,
100 size_t __element_size
, __cxa_cdtor_type __destructor
);
103 __cxa_vec_cleanup(void* __array_address
, size_t __element_count
, size_t __s
,
104 __cxa_cdtor_type __destructor
) _GLIBCXX_NOTHROW
;
106 // Destruct and release array.
108 __cxa_vec_delete(void* __array_address
, size_t __element_size
,
109 size_t __padding_size
, __cxa_cdtor_type __destructor
);
112 __cxa_vec_delete2(void* __array_address
, size_t __element_size
,
113 size_t __padding_size
, __cxa_cdtor_type __destructor
,
114 void (*__dealloc
) (void*));
117 __cxa_vec_delete3(void* __array_address
, size_t __element_size
,
118 size_t __padding_size
, __cxa_cdtor_type __destructor
,
119 void (*__dealloc
) (void*, size_t));
122 __cxa_guard_acquire(__guard
*);
125 __cxa_guard_release(__guard
*) _GLIBCXX_NOTHROW
;
128 __cxa_guard_abort(__guard
*) _GLIBCXX_NOTHROW
;
132 __cxa_atexit(void (*)(void*), void*, void*) _GLIBCXX_NOTHROW
;
135 __cxa_finalize(void*);
139 __cxa_thread_atexit(void (*)(void*), void*, void *) _GLIBCXX_NOTHROW
;
141 // Pure virtual functions.
143 __cxa_pure_virtual(void) __attribute__ ((__noreturn__
));
146 __cxa_deleted_virtual(void) __attribute__ ((__noreturn__
));
148 // Exception handling auxillary.
150 __cxa_bad_cast() __attribute__((__noreturn__
));
153 __cxa_bad_typeid() __attribute__((__noreturn__
));
157 * @brief Demangling routine.
158 * ABI-mandated entry point in the C++ runtime library for demangling.
160 * @param __mangled_name A NUL-terminated character string
161 * containing the name to be demangled.
163 * @param __output_buffer A region of memory, allocated with
164 * malloc, of @a *__length bytes, into which the demangled name is
165 * stored. If @a __output_buffer is not long enough, it is
166 * expanded using realloc. @a __output_buffer may instead be NULL;
167 * in that case, the demangled name is placed in a region of memory
168 * allocated with malloc.
170 * @param __length If @a __length is non-NULL, the length of the
171 * buffer containing the demangled name is placed in @a *__length.
173 * @param __status @a *__status is set to one of the following values:
174 * 0: The demangling operation succeeded.
175 * -1: A memory allocation failure occurred.
176 * -2: @a mangled_name is not a valid name under the C++ ABI mangling rules.
177 * -3: One of the arguments is invalid.
179 * @return A pointer to the start of the NUL-terminated demangled
180 * name, or NULL if the demangling fails. The caller is
181 * responsible for deallocating this memory using @c free.
183 * The demangling is performed using the C++ ABI mangling rules,
184 * with GNU extensions. For example, this function is used in
185 * __gnu_cxx::__verbose_terminate_handler.
187 * See http://gcc.gnu.org/onlinedocs/libstdc++/manual/bk01pt12ch39.html
188 * for other examples of use.
190 * @note The same demangling functionality is available via
191 * libiberty (@c <libiberty/demangle.h> and @c libiberty.a) in GCC
192 * 3.1 and later, but that requires explicit installation (@c
193 * --enable-install-libiberty) and uses a different API, although
194 * the ABI is unchanged.
197 __cxa_demangle(const char* __mangled_name
, char* __output_buffer
,
198 size_t* __length
, int* __status
);
202 } // namespace __cxxabiv1
211 // Type information for int, float etc.
212 class __fundamental_type_info
: public std::type_info
216 __fundamental_type_info(const char* __n
) : std::type_info(__n
) { }
219 ~__fundamental_type_info();
222 // Type information for array objects.
223 class __array_type_info
: public std::type_info
227 __array_type_info(const char* __n
) : std::type_info(__n
) { }
230 ~__array_type_info();
233 // Type information for functions (both member and non-member).
234 class __function_type_info
: public std::type_info
238 __function_type_info(const char* __n
) : std::type_info(__n
) { }
241 ~__function_type_info();
244 // Implementation defined member function.
246 __is_function_p() const;
249 // Type information for enumerations.
250 class __enum_type_info
: public std::type_info
254 __enum_type_info(const char* __n
) : std::type_info(__n
) { }
260 // Common type information for simple pointers and pointers to member.
261 class __pbase_type_info
: public std::type_info
264 unsigned int __flags
; // Qualification of the target object.
265 const std::type_info
* __pointee
; // Type of pointed to object.
268 __pbase_type_info(const char* __n
, int __quals
,
269 const std::type_info
* __type
)
270 : std::type_info(__n
), __flags(__quals
), __pointee(__type
)
274 ~__pbase_type_info();
276 // Implementation defined type.
280 __volatile_mask
= 0x2,
281 __restrict_mask
= 0x4,
282 __incomplete_mask
= 0x8,
283 __incomplete_class_mask
= 0x10
287 __pbase_type_info(const __pbase_type_info
&);
290 operator=(const __pbase_type_info
&);
292 // Implementation defined member functions.
294 __do_catch(const std::type_info
* __thr_type
, void** __thr_obj
,
295 unsigned int __outer
) const;
298 __pointer_catch(const __pbase_type_info
* __thr_type
, void** __thr_obj
,
299 unsigned __outer
) const;
302 // Type information for simple pointers.
303 class __pointer_type_info
: public __pbase_type_info
307 __pointer_type_info(const char* __n
, int __quals
,
308 const std::type_info
* __type
)
309 : __pbase_type_info (__n
, __quals
, __type
) { }
313 ~__pointer_type_info();
316 // Implementation defined member functions.
318 __is_pointer_p() const;
321 __pointer_catch(const __pbase_type_info
* __thr_type
, void** __thr_obj
,
322 unsigned __outer
) const;
325 class __class_type_info
;
327 // Type information for a pointer to member variable.
328 class __pointer_to_member_type_info
: public __pbase_type_info
331 __class_type_info
* __context
; // Class of the member.
334 __pointer_to_member_type_info(const char* __n
, int __quals
,
335 const std::type_info
* __type
,
336 __class_type_info
* __klass
)
337 : __pbase_type_info(__n
, __quals
, __type
), __context(__klass
) { }
340 ~__pointer_to_member_type_info();
343 __pointer_to_member_type_info(const __pointer_to_member_type_info
&);
345 __pointer_to_member_type_info
&
346 operator=(const __pointer_to_member_type_info
&);
348 // Implementation defined member function.
350 __pointer_catch(const __pbase_type_info
* __thr_type
, void** __thr_obj
,
351 unsigned __outer
) const;
354 // Helper class for __vmi_class_type.
355 class __base_class_type_info
358 const __class_type_info
* __base_type
; // Base class type.
359 #ifdef _GLIBCXX_LLP64
360 long long __offset_flags
; // Offset and info.
362 long __offset_flags
; // Offset and info.
365 enum __offset_flags_masks
367 __virtual_mask
= 0x1,
370 __offset_shift
= 8 // Bits to shift offset.
373 // Implementation defined member functions.
375 __is_virtual_p() const
376 { return __offset_flags
& __virtual_mask
; }
379 __is_public_p() const
380 { return __offset_flags
& __public_mask
; }
385 // This shift, being of a signed type, is implementation
386 // defined. GCC implements such shifts as arithmetic, which is
388 return static_cast<ptrdiff_t>(__offset_flags
) >> __offset_shift
;
392 // Type information for a class.
393 class __class_type_info
: public std::type_info
397 __class_type_info (const char *__n
) : type_info(__n
) { }
400 ~__class_type_info ();
402 // Implementation defined types.
403 // The type sub_kind tells us about how a base object is contained
404 // within a derived object. We often do this lazily, hence the
405 // UNKNOWN value. At other times we may use NOT_CONTAINED to mean
406 // not publicly contained.
412 // Not contained within us (in some circumstances this might
413 // mean not contained publicly)
416 // Contained ambiguously.
419 // Via a virtual path.
420 __contained_virtual_mask
= __base_class_type_info::__virtual_mask
,
422 // Via a public path.
423 __contained_public_mask
= __base_class_type_info::__public_mask
,
425 // Contained within us.
426 __contained_mask
= 1 << __base_class_type_info::__hwm_bit
,
428 __contained_private
= __contained_mask
,
429 __contained_public
= __contained_mask
| __contained_public_mask
432 struct __upcast_result
;
433 struct __dyncast_result
;
436 // Implementation defined member functions.
438 __do_upcast(const __class_type_info
* __dst_type
, void**__obj_ptr
) const;
441 __do_catch(const type_info
* __thr_type
, void** __thr_obj
,
442 unsigned __outer
) const;
445 // Helper for upcast. See if DST is us, or one of our bases.
446 // Return false if not found, true if found.
448 __do_upcast(const __class_type_info
* __dst
, const void* __obj
,
449 __upcast_result
& __restrict __result
) const;
451 // Indicate whether SRC_PTR of type SRC_TYPE is contained publicly
452 // within OBJ_PTR. OBJ_PTR points to a base object of our type,
453 // which is the destination type. SRC2DST indicates how SRC
454 // objects might be contained within this type. If SRC_PTR is one
455 // of our SRC_TYPE bases, indicate the virtuality. Returns
456 // not_contained for non containment or private containment.
458 __find_public_src(ptrdiff_t __src2dst
, const void* __obj_ptr
,
459 const __class_type_info
* __src_type
,
460 const void* __src_ptr
) const;
462 // Helper for dynamic cast. ACCESS_PATH gives the access from the
463 // most derived object to this base. DST_TYPE indicates the
464 // desired type we want. OBJ_PTR points to a base of our type
465 // within the complete object. SRC_TYPE indicates the static type
466 // started from and SRC_PTR points to that base within the most
467 // derived object. Fill in RESULT with what we find. Return true
468 // if we have located an ambiguous match.
470 __do_dyncast(ptrdiff_t __src2dst
, __sub_kind __access_path
,
471 const __class_type_info
* __dst_type
, const void* __obj_ptr
,
472 const __class_type_info
* __src_type
, const void* __src_ptr
,
473 __dyncast_result
& __result
) const;
475 // Helper for find_public_subobj. SRC2DST indicates how SRC_TYPE
476 // bases are inherited by the type started from -- which is not
477 // necessarily the current type. The current type will be a base
478 // of the destination type. OBJ_PTR points to the current base.
480 __do_find_public_src(ptrdiff_t __src2dst
, const void* __obj_ptr
,
481 const __class_type_info
* __src_type
,
482 const void* __src_ptr
) const;
485 // Type information for a class with a single non-virtual base.
486 class __si_class_type_info
: public __class_type_info
489 const __class_type_info
* __base_type
;
492 __si_class_type_info(const char *__n
, const __class_type_info
*__base
)
493 : __class_type_info(__n
), __base_type(__base
) { }
496 ~__si_class_type_info();
499 __si_class_type_info(const __si_class_type_info
&);
501 __si_class_type_info
&
502 operator=(const __si_class_type_info
&);
504 // Implementation defined member functions.
506 __do_dyncast(ptrdiff_t __src2dst
, __sub_kind __access_path
,
507 const __class_type_info
* __dst_type
, const void* __obj_ptr
,
508 const __class_type_info
* __src_type
, const void* __src_ptr
,
509 __dyncast_result
& __result
) const;
512 __do_find_public_src(ptrdiff_t __src2dst
, const void* __obj_ptr
,
513 const __class_type_info
* __src_type
,
514 const void* __sub_ptr
) const;
517 __do_upcast(const __class_type_info
*__dst
, const void*__obj
,
518 __upcast_result
& __restrict __result
) const;
521 // Type information for a class with multiple and/or virtual bases.
522 class __vmi_class_type_info
: public __class_type_info
525 unsigned int __flags
; // Details about the class hierarchy.
526 unsigned int __base_count
; // Number of direct bases.
528 // The array of bases uses the trailing array struct hack so this
529 // class is not constructable with a normal constructor. It is
530 // internally generated by the compiler.
531 __base_class_type_info __base_info
[1]; // Array of bases.
534 __vmi_class_type_info(const char* __n
, int ___flags
)
535 : __class_type_info(__n
), __flags(___flags
), __base_count(0) { }
538 ~__vmi_class_type_info();
540 // Implementation defined types.
543 __non_diamond_repeat_mask
= 0x1, // Distinct instance of repeated base.
544 __diamond_shaped_mask
= 0x2, // Diamond shaped multiple inheritance.
545 __flags_unknown_mask
= 0x10
549 // Implementation defined member functions.
551 __do_dyncast(ptrdiff_t __src2dst
, __sub_kind __access_path
,
552 const __class_type_info
* __dst_type
, const void* __obj_ptr
,
553 const __class_type_info
* __src_type
, const void* __src_ptr
,
554 __dyncast_result
& __result
) const;
557 __do_find_public_src(ptrdiff_t __src2dst
, const void* __obj_ptr
,
558 const __class_type_info
* __src_type
,
559 const void* __src_ptr
) const;
562 __do_upcast(const __class_type_info
* __dst
, const void* __obj
,
563 __upcast_result
& __restrict __result
) const;
566 // Exception handling forward declarations.
567 struct __cxa_exception
;
568 struct __cxa_refcounted_exception
;
569 struct __cxa_dependent_exception
;
570 struct __cxa_eh_globals
;
574 // Dynamic cast runtime.
576 // src2dst has the following possible values
577 // >-1: src_type is a unique public non-virtual base of dst_type
578 // dst_ptr + src2dst == src_ptr
579 // -1: unspecified relationship
580 // -2: src_type is not a public base of dst_type
581 // -3: src_type is a multiple public non-virtual base of dst_type
583 __dynamic_cast(const void* __src_ptr
, // Starting object.
584 const __class_type_info
* __src_type
, // Static type of object.
585 const __class_type_info
* __dst_type
, // Desired target type.
586 ptrdiff_t __src2dst
); // How src and dst are related.
589 // Exception handling runtime.
591 // The __cxa_eh_globals for the current thread can be obtained by using
592 // either of the following functions. The "fast" version assumes at least
593 // one prior call of __cxa_get_globals has been made from the current
594 // thread, so no initialization is necessary.
596 __cxa_get_globals() _GLIBCXX_NOTHROW
__attribute__ ((__const__
));
599 __cxa_get_globals_fast() _GLIBCXX_NOTHROW
__attribute__ ((__const__
));
601 // Allocate memory for the primary exception plus the thrown object.
603 __cxa_allocate_exception(size_t) _GLIBCXX_NOTHROW
;
605 // Free the space allocated for the primary exception.
607 __cxa_free_exception(void*) _GLIBCXX_NOTHROW
;
609 // Throw the exception.
611 __cxa_throw(void*, std::type_info
*, void (_GLIBCXX_CDTOR_CALLABI
*) (void *))
612 __attribute__((__noreturn__
));
614 // Used to implement exception handlers.
616 __cxa_get_exception_ptr(void*) _GLIBCXX_NOTHROW
__attribute__ ((__pure__
));
619 __cxa_begin_catch(void*) _GLIBCXX_NOTHROW
;
625 __cxa_rethrow() __attribute__((__noreturn__
));
627 // Returns the type_info for the currently handled exception [15.3/8], or
628 // null if there is none.
630 __cxa_current_exception_type() _GLIBCXX_NOTHROW
__attribute__ ((__pure__
));
634 // Allocate memory for a dependent exception.
635 __cxa_dependent_exception
*
636 __cxa_allocate_dependent_exception() _GLIBCXX_NOTHROW
;
638 // Free the space allocated for the dependent exception.
640 __cxa_free_dependent_exception(__cxa_dependent_exception
*) _GLIBCXX_NOTHROW
;
644 // A magic placeholder class that can be caught by reference
645 // to recognize foreign exceptions.
646 class __foreign_exception
648 virtual ~__foreign_exception() throw();
649 virtual void __pure_dummy() = 0; // prevent catch by value
652 } // namespace __cxxabiv1
655 * @brief The cross-vendor C++ Application Binary Interface. A
656 * namespace alias to __cxxabiv1, but user programs should use the
659 * A brief overview of an ABI is given in the libstdc++ FAQ, question
660 * 5.8 (you may have a copy of the FAQ locally, or you can view the online
661 * version at http://gcc.gnu.org/onlinedocs/libstdc++/faq.html#5_8 ).
663 * GCC subscribes to a cross-vendor ABI for C++, sometimes
664 * called the IA64 ABI because it happens to be the native ABI for that
665 * platform. It is summarized at http://www.codesourcery.com/cxx-abi/
666 * along with the current specification.
668 * For users of GCC greater than or equal to 3.x, entry points are
669 * available in <cxxabi.h>, which notes, <em>'It is not normally
670 * necessary for user programs to include this header, or use the
671 * entry points directly. However, this header is available should
672 * that be needed.'</em>
674 namespace abi
= __cxxabiv1
;
679 * @brief Exception thrown by __cxa_guard_acquire.
680 * @ingroup exceptions
682 * 6.7[stmt.dcl]/4: If control re-enters the declaration (recursively)
683 * while the object is being initialized, the behavior is undefined.
685 * Since we already have a library function to handle locking, we might
686 * as well check for this situation and throw an exception.
687 * We use the second byte of the guard variable to remember that we're
688 * in the middle of an initialization.
690 class recursive_init_error
: public std::exception
693 recursive_init_error() throw() { }
694 virtual ~recursive_init_error() throw ();
697 #endif // __cplusplus
699 #pragma GCC visibility pop