1 /* Define builtin-in macros for the C family front ends.
2 Copyright (C) 2002, 2003 Free Software Foundation, Inc.
4 This file is part of GCC.
6 GCC is free software; you can redistribute it and/or modify it under
7 the terms of the GNU General Public License as published by the Free
8 Software Foundation; either version 2, or (at your option) any later
11 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
16 You should have received a copy of the GNU General Public License
17 along with GCC; see the file COPYING. If not, write to the Free
18 Software Foundation, 59 Temple Place - Suite 330, Boston, MA
23 #include "coretypes.h"
31 #include "except.h" /* For USING_SJLJ_EXCEPTIONS. */
33 #include "tm_p.h" /* Target prototypes. */
35 #ifndef TARGET_OS_CPP_BUILTINS
36 # define TARGET_OS_CPP_BUILTINS()
39 #ifndef TARGET_OBJFMT_CPP_BUILTINS
40 # define TARGET_OBJFMT_CPP_BUILTINS()
43 #ifndef REGISTER_PREFIX
44 #define REGISTER_PREFIX ""
47 /* Non-static as some targets don't use it. */
48 void builtin_define_std
PARAMS ((const char *)) ATTRIBUTE_UNUSED
;
49 static void builtin_define_with_value_n
PARAMS ((const char *, const char *,
51 static void builtin_define_with_int_value
PARAMS ((const char *,
53 static void builtin_define_with_hex_fp_value
PARAMS ((const char *, tree
,
56 static void builtin_define_type_max
PARAMS ((const char *, tree
, int));
57 static void builtin_define_type_precision
PARAMS ((const char *, tree
));
58 static void builtin_define_float_constants
PARAMS ((const char *,
60 static void define__GNUC__
PARAMS ((void));
62 /* Define NAME with value TYPE precision. */
64 builtin_define_type_precision (name
, type
)
68 builtin_define_with_int_value (name
, TYPE_PRECISION (type
));
71 /* Define the float.h constants for TYPE using NAME_PREFIX and FP_SUFFIX. */
73 builtin_define_float_constants (name_prefix
, fp_suffix
, type
)
74 const char *name_prefix
;
75 const char *fp_suffix
;
78 /* Used to convert radix-based values to base 10 values in several cases.
80 In the max_exp -> max_10_exp conversion for 128-bit IEEE, we need at
81 least 6 significant digits for correct results. Using the fraction
82 formed by (log(2)*1e6)/(log(10)*1e6) overflows a 32-bit integer as an
83 intermediate; perhaps someone can find a better approximation, in the
84 mean time, I suspect using doubles won't harm the bootstrap here. */
86 const double log10_2
= .30102999566398119521;
88 const struct real_format
*fmt
;
90 char name
[64], buf
[128];
91 int dig
, min_10_exp
, max_10_exp
;
94 fmt
= real_format_for_mode
[TYPE_MODE (type
) - QFmode
];
96 /* The radix of the exponent representation. */
97 if (type
== float_type_node
)
98 builtin_define_with_int_value ("__FLT_RADIX__", fmt
->b
);
99 log10_b
= log10_2
* fmt
->log2_b
;
101 /* The number of radix digits, p, in the floating-point significand. */
102 sprintf (name
, "__%s_MANT_DIG__", name_prefix
);
103 builtin_define_with_int_value (name
, fmt
->p
);
105 /* The number of decimal digits, q, such that any floating-point number
106 with q decimal digits can be rounded into a floating-point number with
107 p radix b digits and back again without change to the q decimal digits,
109 p log10 b if b is a power of 10
110 floor((p - 1) log10 b) otherwise
112 dig
= (fmt
->p
- 1) * log10_b
;
113 sprintf (name
, "__%s_DIG__", name_prefix
);
114 builtin_define_with_int_value (name
, dig
);
116 /* The minimum negative int x such that b**(x-1) is a normalized float. */
117 sprintf (name
, "__%s_MIN_EXP__", name_prefix
);
118 sprintf (buf
, "(%d)", fmt
->emin
);
119 builtin_define_with_value (name
, buf
, 0);
121 /* The minimum negative int x such that 10**x is a normalized float,
123 ceil (log10 (b ** (emin - 1)))
124 = ceil (log10 (b) * (emin - 1))
126 Recall that emin is negative, so the integer truncation calculates
127 the ceiling, not the floor, in this case. */
128 min_10_exp
= (fmt
->emin
- 1) * log10_b
;
129 sprintf (name
, "__%s_MIN_10_EXP__", name_prefix
);
130 sprintf (buf
, "(%d)", min_10_exp
);
131 builtin_define_with_value (name
, buf
, 0);
133 /* The maximum int x such that b**(x-1) is a representable float. */
134 sprintf (name
, "__%s_MAX_EXP__", name_prefix
);
135 builtin_define_with_int_value (name
, fmt
->emax
);
137 /* The maximum int x such that 10**x is in the range of representable
138 finite floating-point numbers,
140 floor (log10((1 - b**-p) * b**emax))
141 = floor (log10(1 - b**-p) + log10(b**emax))
142 = floor (log10(1 - b**-p) + log10(b)*emax)
144 The safest thing to do here is to just compute this number. But since
145 we don't link cc1 with libm, we cannot. We could implement log10 here
146 a series expansion, but that seems too much effort because:
148 Note that the first term, for all extant p, is a number exceedingly close
149 to zero, but slightly negative. Note that the second term is an integer
150 scaling an irrational number, and that because of the floor we are only
151 interested in its integral portion.
153 In order for the first term to have any effect on the integral portion
154 of the second term, the second term has to be exceedingly close to an
155 integer itself (e.g. 123.000000000001 or something). Getting a result
156 that close to an integer requires that the irrational multiplicand have
157 a long series of zeros in its expansion, which doesn't occur in the
158 first 20 digits or so of log10(b).
160 Hand-waving aside, crunching all of the sets of constants above by hand
161 does not yield a case for which the first term is significant, which
162 in the end is all that matters. */
163 max_10_exp
= fmt
->emax
* log10_b
;
164 sprintf (name
, "__%s_MAX_10_EXP__", name_prefix
);
165 builtin_define_with_int_value (name
, max_10_exp
);
167 /* The number of decimal digits, n, such that any floating-point number
168 can be rounded to n decimal digits and back again without change to
171 p * log10(b) if b is a power of 10
172 ceil(1 + p * log10(b)) otherwise
174 The only macro we care about is this number for the widest supported
175 floating type, but we want this value for rendering constants below. */
177 double d_decimal_dig
= 1 + fmt
->p
* log10_b
;
178 decimal_dig
= d_decimal_dig
;
179 if (decimal_dig
< d_decimal_dig
)
182 if (type
== long_double_type_node
)
183 builtin_define_with_int_value ("__DECIMAL_DIG__", decimal_dig
);
185 /* Since, for the supported formats, B is always a power of 2, we
186 construct the following numbers directly as a hexadecimal
189 /* The maximum representable finite floating-point number,
190 (1 - b**-p) * b**emax */
195 strcpy (buf
, "0x0.");
196 n
= fmt
->p
* fmt
->log2_b
;
197 for (i
= 0, p
= buf
+ 4; i
+ 3 < n
; i
+= 4)
200 *p
++ = "08ce"[n
- i
];
201 sprintf (p
, "p%d", fmt
->emax
* fmt
->log2_b
);
203 sprintf (name
, "__%s_MAX__", name_prefix
);
204 builtin_define_with_hex_fp_value (name
, type
, decimal_dig
, buf
, fp_suffix
);
206 /* The minimum normalized positive floating-point number,
208 sprintf (name
, "__%s_MIN__", name_prefix
);
209 sprintf (buf
, "0x1p%d", (fmt
->emin
- 1) * fmt
->log2_b
);
210 builtin_define_with_hex_fp_value (name
, type
, decimal_dig
, buf
, fp_suffix
);
212 /* The difference between 1 and the least value greater than 1 that is
213 representable in the given floating point type, b**(1-p). */
214 sprintf (name
, "__%s_EPSILON__", name_prefix
);
215 sprintf (buf
, "0x1p%d", (1 - fmt
->p
) * fmt
->log2_b
);
216 builtin_define_with_hex_fp_value (name
, type
, decimal_dig
, buf
, fp_suffix
);
218 /* For C++ std::numeric_limits<T>::denorm_min. The minimum denormalized
219 positive floating-point number, b**(emin-p). Zero for formats that
220 don't support denormals. */
221 sprintf (name
, "__%s_DENORM_MIN__", name_prefix
);
224 sprintf (buf
, "0x1p%d", (fmt
->emin
- fmt
->p
) * fmt
->log2_b
);
225 builtin_define_with_hex_fp_value (name
, type
, decimal_dig
,
230 sprintf (buf
, "0.0%s", fp_suffix
);
231 builtin_define_with_value (name
, buf
, 0);
234 /* For C++ std::numeric_limits<T>::has_infinity. */
235 sprintf (name
, "__%s_HAS_INFINITY__", name_prefix
);
236 builtin_define_with_int_value (name
,
237 MODE_HAS_INFINITIES (TYPE_MODE (type
)));
238 /* For C++ std::numeric_limits<T>::has_quiet_NaN. We do not have a
239 predicate to distinguish a target that has both quiet and
240 signalling NaNs from a target that has only quiet NaNs or only
241 signalling NaNs, so we assume that a target that has any kind of
242 NaN has quiet NaNs. */
243 sprintf (name
, "__%s_HAS_QUIET_NAN__", name_prefix
);
244 builtin_define_with_int_value (name
, MODE_HAS_NANS (TYPE_MODE (type
)));
247 /* Define __GNUC__, __GNUC_MINOR__ and __GNUC_PATCHLEVEL__. */
251 /* The format of the version string, enforced below, is
252 ([^0-9]*-)?[0-9]+[.][0-9]+([.][0-9]+)?([- ].*)? */
253 const char *q
, *v
= version_string
;
255 while (*v
&& ! ISDIGIT (*v
))
257 if (!*v
|| (v
> version_string
&& v
[-1] != '-'))
263 builtin_define_with_value_n ("__GNUC__", q
, v
- q
);
264 if (c_language
== clk_cplusplus
)
265 builtin_define_with_value_n ("__GNUG__", q
, v
- q
);
267 if (*v
!= '.' || !ISDIGIT (v
[1]))
272 builtin_define_with_value_n ("__GNUC_MINOR__", q
, v
- q
);
281 builtin_define_with_value_n ("__GNUC_PATCHLEVEL__", q
, v
- q
);
284 builtin_define_with_value_n ("__GNUC_PATCHLEVEL__", "0", 1);
286 if (*v
&& *v
!= ' ' && *v
!= '-')
290 /* Hook that registers front end and target-specific built-ins. */
292 c_cpp_builtins (pfile
)
295 /* -undef turns off target-specific built-ins. */
301 /* For stddef.h. They require macros defined in c-common.c. */
302 c_stddef_cpp_builtins ();
304 if (c_language
== clk_cplusplus
)
306 if (SUPPORTS_ONE_ONLY
)
307 cpp_define (pfile
, "__GXX_WEAK__=1");
309 cpp_define (pfile
, "__GXX_WEAK__=0");
311 cpp_define (pfile
, "__DEPRECATED");
313 /* Note that we define this for C as well, so that we know if
314 __attribute__((cleanup)) will interface with EH. */
316 cpp_define (pfile
, "__EXCEPTIONS");
318 /* represents the C++ ABI version, always defined so it can be used while
319 preprocessing C and assembler. */
320 cpp_define (pfile
, "__GXX_ABI_VERSION=102");
322 /* libgcc needs to know this. */
323 if (USING_SJLJ_EXCEPTIONS
)
324 cpp_define (pfile
, "__USING_SJLJ_EXCEPTIONS__");
326 /* limits.h needs to know these. */
327 builtin_define_type_max ("__SCHAR_MAX__", signed_char_type_node
, 0);
328 builtin_define_type_max ("__SHRT_MAX__", short_integer_type_node
, 0);
329 builtin_define_type_max ("__INT_MAX__", integer_type_node
, 0);
330 builtin_define_type_max ("__LONG_MAX__", long_integer_type_node
, 1);
331 builtin_define_type_max ("__LONG_LONG_MAX__", long_long_integer_type_node
, 2);
332 builtin_define_type_max ("__WCHAR_MAX__", wchar_type_node
, 0);
334 builtin_define_type_precision ("__CHAR_BIT__", char_type_node
);
336 /* float.h needs to know these. */
338 builtin_define_with_int_value ("__FLT_EVAL_METHOD__",
339 TARGET_FLT_EVAL_METHOD
);
341 builtin_define_float_constants ("FLT", "F", float_type_node
);
342 builtin_define_float_constants ("DBL", "", double_type_node
);
343 builtin_define_float_constants ("LDBL", "L", long_double_type_node
);
345 /* For use in assembly language. */
346 builtin_define_with_value ("__REGISTER_PREFIX__", REGISTER_PREFIX
, 0);
347 builtin_define_with_value ("__USER_LABEL_PREFIX__", user_label_prefix
, 0);
350 builtin_define_with_value ("__VERSION__", version_string
, 1);
352 /* Definitions for LP64 model. */
353 if (TYPE_PRECISION (long_integer_type_node
) == 64
354 && POINTER_SIZE
== 64
355 && TYPE_PRECISION (integer_type_node
) == 32)
357 cpp_define (pfile
, "_LP64");
358 cpp_define (pfile
, "__LP64__");
361 /* Other target-independent built-ins determined by command-line
364 cpp_define (pfile
, "__OPTIMIZE_SIZE__");
366 cpp_define (pfile
, "__OPTIMIZE__");
368 if (fast_math_flags_set_p ())
369 cpp_define (pfile
, "__FAST_MATH__");
370 if (flag_really_no_inline
)
371 cpp_define (pfile
, "__NO_INLINE__");
372 if (flag_signaling_nans
)
373 cpp_define (pfile
, "__SUPPORT_SNAN__");
374 if (flag_finite_math_only
)
375 cpp_define (pfile
, "__FINITE_MATH_ONLY__=1");
377 cpp_define (pfile
, "__FINITE_MATH_ONLY__=0");
380 cpp_define (pfile
, "__STRICT_ANSI__");
382 if (!flag_signed_char
)
383 cpp_define (pfile
, "__CHAR_UNSIGNED__");
385 if (c_language
== clk_cplusplus
&& TREE_UNSIGNED (wchar_type_node
))
386 cpp_define (pfile
, "__WCHAR_UNSIGNED__");
388 /* Make the choice of ObjC runtime visible to source code. */
389 if (flag_objc
&& flag_next_runtime
)
390 cpp_define (pfile
, "__NEXT_RUNTIME__");
392 /* A straightforward target hook doesn't work, because of problems
393 linking that hook's body when part of non-C front ends. */
394 # define preprocessing_asm_p() (cpp_get_options (pfile)->lang == CLK_ASM)
395 # define preprocessing_trad_p() (cpp_get_options (pfile)->traditional)
396 # define builtin_define(TXT) cpp_define (pfile, TXT)
397 # define builtin_assert(TXT) cpp_assert (pfile, TXT)
398 TARGET_CPU_CPP_BUILTINS ();
399 TARGET_OS_CPP_BUILTINS ();
400 TARGET_OBJFMT_CPP_BUILTINS ();
403 /* Pass an object-like macro. If it doesn't lie in the user's
404 namespace, defines it unconditionally. Otherwise define a version
405 with two leading underscores, and another version with two leading
406 and trailing underscores, and define the original only if an ISO
407 standard was not nominated.
409 e.g. passing "unix" defines "__unix", "__unix__" and possibly
410 "unix". Passing "_mips" defines "__mips", "__mips__" and possibly
413 builtin_define_std (macro
)
416 size_t len
= strlen (macro
);
417 char *buff
= alloca (len
+ 5);
421 /* prepend __ (or maybe just _) if in user's namespace. */
422 memcpy (p
, macro
, len
+ 1);
423 if (!( *p
== '_' && (p
[1] == '_' || ISUPPER (p
[1]))))
430 cpp_define (parse_in
, p
);
432 /* If it was in user's namespace... */
435 /* Define the macro with leading and following __. */
441 cpp_define (parse_in
, p
);
443 /* Finally, define the original macro if permitted. */
445 cpp_define (parse_in
, macro
);
449 /* Pass an object-like macro and a value to define it to. The third
450 parameter says whether or not to turn the value into a string
453 builtin_define_with_value (macro
, expansion
, is_str
)
455 const char *expansion
;
459 size_t mlen
= strlen (macro
);
460 size_t elen
= strlen (expansion
);
461 size_t extra
= 2; /* space for an = and a NUL */
464 extra
+= 2; /* space for two quote marks */
466 buf
= alloca (mlen
+ elen
+ extra
);
468 sprintf (buf
, "%s=\"%s\"", macro
, expansion
);
470 sprintf (buf
, "%s=%s", macro
, expansion
);
472 cpp_define (parse_in
, buf
);
475 /* Pass an object-like macro and a value to define it to. The third
476 parameter is the length of the expansion. */
478 builtin_define_with_value_n (macro
, expansion
, elen
)
480 const char *expansion
;
484 size_t mlen
= strlen (macro
);
486 /* Space for an = and a NUL. */
487 buf
= alloca (mlen
+ elen
+ 2);
488 memcpy (buf
, macro
, mlen
);
490 memcpy (buf
+ mlen
+ 1, expansion
, elen
);
491 buf
[mlen
+ elen
+ 1] = '\0';
493 cpp_define (parse_in
, buf
);
496 /* Pass an object-like macro and an integer value to define it to. */
498 builtin_define_with_int_value (macro
, value
)
503 size_t mlen
= strlen (macro
);
505 size_t extra
= 2; /* space for = and NUL. */
507 buf
= alloca (mlen
+ vlen
+ extra
);
508 memcpy (buf
, macro
, mlen
);
510 sprintf (buf
+ mlen
+ 1, HOST_WIDE_INT_PRINT_DEC
, value
);
512 cpp_define (parse_in
, buf
);
515 /* Pass an object-like macro a hexadecimal floating-point value. */
517 builtin_define_with_hex_fp_value (macro
, type
, digits
, hex_str
, fp_suffix
)
519 tree type ATTRIBUTE_UNUSED
;
522 const char *fp_suffix
;
524 REAL_VALUE_TYPE real
;
525 char dec_str
[64], buf
[256];
527 /* Hex values are really cool and convenient, except that they're
528 not supported in strict ISO C90 mode. First, the "p-" sequence
529 is not valid as part of a preprocessor number. Second, we get a
530 pedwarn from the preprocessor, which has no context, so we can't
531 suppress the warning with __extension__.
533 So instead what we do is construct the number in hex (because
534 it's easy to get the exact correct value), parse it as a real,
535 then print it back out as decimal. */
537 real_from_string (&real
, hex_str
);
538 real_to_decimal (dec_str
, &real
, sizeof (dec_str
), digits
, 0);
540 sprintf (buf
, "%s=%s%s", macro
, dec_str
, fp_suffix
);
541 cpp_define (parse_in
, buf
);
544 /* Define MAX for TYPE based on the precision of the type. IS_LONG is
545 1 for type "long" and 2 for "long long". We have to handle
546 unsigned types, since wchar_t might be unsigned. */
549 builtin_define_type_max (macro
, type
, is_long
)
554 static const char *const values
[]
557 "2147483647", "4294967295",
558 "9223372036854775807", "18446744073709551615",
559 "170141183460469231731687303715884105727",
560 "340282366920938463463374607431768211455" };
561 static const char *const suffixes
[] = { "", "U", "L", "UL", "LL", "ULL" };
563 const char *value
, *suffix
;
567 /* Pre-rendering the values mean we don't have to futz with printing a
568 multi-word decimal value. There are also a very limited number of
569 precisions that we support, so it's really a waste of time. */
570 switch (TYPE_PRECISION (type
))
572 case 8: idx
= 0; break;
573 case 16: idx
= 2; break;
574 case 32: idx
= 4; break;
575 case 64: idx
= 6; break;
576 case 128: idx
= 8; break;
580 value
= values
[idx
+ TREE_UNSIGNED (type
)];
581 suffix
= suffixes
[is_long
* 2 + TREE_UNSIGNED (type
)];
583 buf
= alloca (strlen (macro
) + 1 + strlen (value
) + strlen (suffix
) + 1);
584 sprintf (buf
, "%s=%s%s", macro
, value
, suffix
);
586 cpp_define (parse_in
, buf
);