* extend.texi: Improve documentation of volatile asms.
[official-gcc.git] / gcc / libgcc2.h
blobdeaa777edb9d973af0b5845bfee240a16d32f1d5
1 /* Header file for libgcc2.c. */
2 /* Copyright (C) 2000, 2001
3 Free Software Foundation, Inc.
5 This file is part of GNU CC.
7 GNU CC 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)
10 any later version.
12 GNU CC 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 GNU CC; see the file COPYING. If not, write to
19 the Free Software Foundation, 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
22 #ifndef __LIBGCC2_H__
23 #define __LIBGCC2_H__
25 typedef void (*__terminate_func_ptr)(void) __attribute__ ((__noreturn__));
27 extern int __gcc_bcmp (const unsigned char *, const unsigned char *, size_t);
28 extern void __clear_cache (char *, char *);
29 extern void __pure_virtual (void) __attribute__ ((__noreturn__));
30 extern void __terminate (void) __attribute__ ((__noreturn__));
31 extern __terminate_func_ptr __terminate_set_func (__terminate_func_ptr);
32 extern void __default_terminate (void) __attribute__ ((__noreturn__));
33 extern void *__throw_type_match (void *, void *, void *);
34 extern void *__get_eh_context (void);
35 extern void **__get_eh_info (void);
36 extern void ***__get_dynamic_handler_chain (void);
37 extern int __eh_rtime_match (void *);
38 extern void __unwinding_cleanup (void);
39 extern void __rethrow (void *);
40 extern void __throw (void);
41 extern void __sjthrow (void) __attribute__ ((__noreturn__));
42 extern void __sjpopnthrow (void) __attribute__ ((__noreturn__));
43 extern void __eprintf (const char *, const char *, unsigned int, const char *)
44 __attribute__ ((__noreturn__));
45 extern void *__eh_alloc (size_t);
46 extern void __eh_free (void *);
48 struct bb;
49 extern void __bb_exit_func (void);
50 extern void __bb_init_func (struct bb *);
51 extern void __bb_fork_func (void);
52 extern void __bb_trace_func (void);
53 extern void __bb_trace_ret (void);
54 extern void __bb_init_trace_func (struct bb *, unsigned long);
56 struct exception_descriptor;
57 extern short int __get_eh_table_language (struct exception_descriptor *);
58 extern short int __get_eh_table_version (struct exception_descriptor *);
60 /* Permit the tm.h file to select the endianness to use just for this
61 file. This is used when the endianness is determined when the
62 compiler is run. */
64 #ifndef LIBGCC2_WORDS_BIG_ENDIAN
65 #define LIBGCC2_WORDS_BIG_ENDIAN WORDS_BIG_ENDIAN
66 #endif
68 #ifndef LIBGCC2_LONG_DOUBLE_TYPE_SIZE
69 #define LIBGCC2_LONG_DOUBLE_TYPE_SIZE LONG_DOUBLE_TYPE_SIZE
70 #endif
72 #ifndef MIN_UNITS_PER_WORD
73 #define MIN_UNITS_PER_WORD UNITS_PER_WORD
74 #endif
76 /* In the first part of this file, we are interfacing to calls generated
77 by the compiler itself. These calls pass values into these routines
78 which have very specific modes (rather than very specific types), and
79 these compiler-generated calls also expect any return values to have
80 very specific modes (rather than very specific types). Thus, we need
81 to avoid using regular C language type names in this part of the file
82 because the sizes for those types can be configured to be anything.
83 Instead we use the following special type names. */
85 typedef int QItype __attribute__ ((mode (QI)));
86 typedef unsigned int UQItype __attribute__ ((mode (QI)));
87 typedef int HItype __attribute__ ((mode (HI)));
88 typedef unsigned int UHItype __attribute__ ((mode (HI)));
89 #if MIN_UNITS_PER_WORD > 1
90 /* These typedefs are usually forbidden on dsp's with UNITS_PER_WORD 1 */
91 typedef int SItype __attribute__ ((mode (SI)));
92 typedef unsigned int USItype __attribute__ ((mode (SI)));
93 #if LONG_LONG_TYPE_SIZE > 32
94 /* These typedefs are usually forbidden on archs with UNITS_PER_WORD 2 */
95 typedef int DItype __attribute__ ((mode (DI)));
96 typedef unsigned int UDItype __attribute__ ((mode (DI)));
97 #if MIN_UNITS_PER_WORD > 4
98 /* These typedefs are usually forbidden on archs with UNITS_PER_WORD 4 */
99 typedef int TItype __attribute__ ((mode (TI)));
100 typedef unsigned int UTItype __attribute__ ((mode (TI)));
101 #endif
102 #endif
103 #endif
105 #if BITS_PER_UNIT == 8
107 typedef float SFtype __attribute__ ((mode (SF)));
108 typedef float DFtype __attribute__ ((mode (DF)));
110 #if LIBGCC2_LONG_DOUBLE_TYPE_SIZE == 96
111 typedef float XFtype __attribute__ ((mode (XF)));
112 #endif
113 #if LIBGCC2_LONG_DOUBLE_TYPE_SIZE == 128
114 typedef float TFtype __attribute__ ((mode (TF)));
115 #endif
117 #else /* BITS_PER_UNIT != 8 */
119 /* On dsp's there are usually qf/hf/tqf modes used instead of the above.
120 For now we don't support them in libgcc2.c. */
122 #undef L_fixdfdi
123 #undef L_fixsfdi
124 #undef L_fixtfdi
125 #undef L_fixunsdfdi
126 #undef L_fixunsdfsi
127 #undef L_fixunssfdi
128 #undef L_fixunssfsi
129 #undef L_fixunstfdi
130 #undef L_fixunsxfdi
131 #undef L_fixunsxfsi
132 #undef L_fixxfdi
133 #undef L_floatdidf
134 #undef L_floatdisf
135 #undef L_floatditf
136 #undef L_floatdixf
138 #endif /* BITS_PER_UNIT != 8 */
140 typedef int word_type __attribute__ ((mode (__word__)));
142 /* Make sure that we don't accidentally use any normal C language built-in
143 type names in the first part of this file. Instead we want to use *only*
144 the type names defined above. The following macro definitions insure
145 that if we *do* accidentally use some normal C language built-in type name,
146 we will get a syntax error. */
148 #define char bogus_type
149 #define short bogus_type
150 #define int bogus_type
151 #define long bogus_type
152 #define unsigned bogus_type
153 #define float bogus_type
154 #define double bogus_type
156 #if MIN_UNITS_PER_WORD > 4
157 #define W_TYPE_SIZE (8 * BITS_PER_UNIT)
158 #define Wtype DItype
159 #define UWtype UDItype
160 #define HWtype DItype
161 #define UHWtype UDItype
162 #define DWtype TItype
163 #define UDWtype UTItype
164 #define __NW(a,b) __ ## a ## di ## b
165 #define __NDW(a,b) __ ## a ## ti ## b
166 #elif MIN_UNITS_PER_WORD > 2 \
167 || (MIN_UNITS_PER_WORD > 1 && LONG_LONG_TYPE_SIZE > 32)
168 #define W_TYPE_SIZE (4 * BITS_PER_UNIT)
169 #define Wtype SItype
170 #define UWtype USItype
171 #define HWtype SItype
172 #define UHWtype USItype
173 #define DWtype DItype
174 #define UDWtype UDItype
175 #define __NW(a,b) __ ## a ## si ## b
176 #define __NDW(a,b) __ ## a ## di ## b
177 #elif MIN_UNITS_PER_WORD > 1
178 #define W_TYPE_SIZE (2 * BITS_PER_UNIT)
179 #define Wtype HItype
180 #define UWtype UHItype
181 #define HWtype HItype
182 #define UHWtype UHItype
183 #define DWtype SItype
184 #define UDWtype USItype
185 #define __NW(a,b) __ ## a ## hi ## b
186 #define __NDW(a,b) __ ## a ## si ## b
187 #else
188 #define W_TYPE_SIZE BITS_PER_UNIT
189 #define Wtype QItype
190 #define UWtype UQItype
191 #define HWtype QItype
192 #define UHWtype UQItype
193 #define DWtype HItype
194 #define UDWtype UHItype
195 #define __NW(a,b) __ ## a ## qi ## b
196 #define __NDW(a,b) __ ## a ## hi ## b
197 #endif
199 #define Wtype_MAX ((Wtype)(((UWtype)1 << (W_TYPE_SIZE - 1)) - 1))
200 #define Wtype_MIN (- Wtype_MAX - 1)
202 #define __muldi3 __NDW(mul,3)
203 #define __divdi3 __NDW(div,3)
204 #define __udivdi3 __NDW(udiv,3)
205 #define __moddi3 __NDW(mod,3)
206 #define __umoddi3 __NDW(umod,3)
207 #define __negdi2 __NDW(neg,2)
208 #define __lshrdi3 __NDW(lshr,3)
209 #define __ashldi3 __NDW(ashl,3)
210 #define __ashrdi3 __NDW(ashr,3)
211 #define __ffsdi2 __NDW(ffs,2)
212 #define __cmpdi2 __NDW(cmp,2)
213 #define __ucmpdi2 __NDW(ucmp,2)
214 #define __udivmoddi4 __NDW(udivmod,4)
215 #define __fixunstfDI __NDW(fixunstf,)
216 #define __fixtfdi __NDW(fixtf,)
217 #define __fixunsxfDI __NDW(fixunsxf,)
218 #define __fixxfdi __NDW(fixxf,)
219 #define __fixunsdfDI __NDW(fixunsdf,)
220 #define __fixdfdi __NDW(fixdf,)
221 #define __fixunssfDI __NDW(fixunssf,)
222 #define __fixsfdi __NDW(fixsf,)
223 #define __floatdixf __NDW(float,xf)
224 #define __floatditf __NDW(float,tf)
225 #define __floatdidf __NDW(float,df)
226 #define __floatdisf __NDW(float,sf)
227 #define __fixunsxfSI __NW(fixunsxf,)
228 #define __fixunstfSI __NW(fixunstf,)
229 #define __fixunsdfSI __NW(fixunsdf,)
230 #define __fixunssfSI __NW(fixunssf,)
232 extern DWtype __muldi3 (DWtype, DWtype);
233 extern DWtype __divdi3 (DWtype, DWtype);
234 extern UDWtype __udivdi3 (UDWtype, UDWtype);
235 extern UDWtype __umoddi3 (UDWtype, UDWtype);
236 extern DWtype __moddi3 (DWtype, DWtype);
238 /* __udivmoddi4 is static inline when building other libgcc2 portions. */
239 #if (!defined (L_udivdi3) && !defined (L_divdi3) && \
240 !defined (L_umoddi3) && !defined (L_moddi3))
241 extern UDWtype __udivmoddi4 (UDWtype, UDWtype, UDWtype *);
242 #endif
244 /* __negdi2 is static inline when building other libgcc2 portions. */
245 #if !defined(L_divdi3) && !defined(L_moddi3)
246 extern DWtype __negdi2 (DWtype);
247 #endif
249 extern DWtype __lshrdi3 (DWtype, word_type);
250 extern DWtype __ashldi3 (DWtype, word_type);
251 extern DWtype __ashrdi3 (DWtype, word_type);
252 extern DWtype __ffsdi2 (DWtype);
254 /* __udiv_w_sdiv is static inline when building other libgcc2 portions. */
255 #if (!defined(L_udivdi3) && !defined(L_divdi3) && \
256 !defined(L_umoddi3) && !defined(L_moddi3))
257 extern UWtype __udiv_w_sdiv (UWtype *, UWtype, UWtype, UWtype);
258 #endif
260 extern word_type __cmpdi2 (DWtype, DWtype);
261 extern word_type __ucmpdi2 (DWtype, DWtype);
263 extern Wtype __absvsi2 (Wtype);
264 extern DWtype __absvdi2 (DWtype);
265 extern Wtype __addvsi3 (Wtype, Wtype);
266 extern DWtype __addvdi3 (DWtype, DWtype);
267 extern Wtype __subvsi3 (Wtype, Wtype);
268 extern DWtype __subvdi3 (DWtype, DWtype);
269 extern Wtype __mulvsi3 (Wtype, Wtype);
270 extern DWtype __mulvdi3 (DWtype, DWtype);
271 extern Wtype __negvsi2 (Wtype);
272 extern DWtype __negvdi2 (DWtype);
274 #if BITS_PER_UNIT == 8
275 extern DWtype __fixdfdi (DFtype);
276 extern DWtype __fixsfdi (SFtype);
277 extern DFtype __floatdidf (DWtype);
278 extern SFtype __floatdisf (DWtype);
279 extern UWtype __fixunsdfSI (DFtype);
280 extern UWtype __fixunssfSI (SFtype);
281 extern DWtype __fixunsdfDI (DFtype);
282 extern DWtype __fixunssfDI (SFtype);
284 #if LIBGCC2_LONG_DOUBLE_TYPE_SIZE == 96
285 extern DWtype __fixxfdi (XFtype);
286 extern DWtype __fixunsxfDI (XFtype);
287 extern XFtype __floatdixf (DWtype);
288 extern UWtype __fixunsxfSI (XFtype);
289 #endif
291 #if LIBGCC2_LONG_DOUBLE_TYPE_SIZE == 128
292 extern DWtype __fixunstfDI (TFtype);
293 extern DWtype __fixtfdi (TFtype);
294 extern TFtype __floatditf (DWtype);
295 #endif
296 #endif /* BITS_PER_UNIT == 8 */
298 /* DWstructs are pairs of Wtype values in the order determined by
299 LIBGCC2_WORDS_BIG_ENDIAN. */
301 #if LIBGCC2_WORDS_BIG_ENDIAN
302 struct DWstruct {Wtype high, low;};
303 #else
304 struct DWstruct {Wtype low, high;};
305 #endif
307 /* We need this union to unpack/pack DImode values, since we don't have
308 any arithmetic yet. Incoming DImode parameters are stored into the
309 `ll' field, and the unpacked result is read from the struct `s'. */
311 typedef union
313 struct DWstruct s;
314 DWtype ll;
315 } DWunion;
317 #include "longlong.h"
319 #endif /* __LIBGCC2_H__ */