2011-08-19 Andrew Stubbs <ams@codesourcery.com>
[official-gcc.git] / gcc / system.h
blob9698c613f3506216b4f47c0808b7af5939a17cea
1 /* Get common system includes and various definitions and declarations based
2 on autoconf macros.
3 Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2007, 2008,
4 2009, 2010, 2011
5 Free Software Foundation, Inc.
7 This file is part of GCC.
9 GCC is free software; you can redistribute it and/or modify it under
10 the terms of the GNU General Public License as published by the Free
11 Software Foundation; either version 3, or (at your option) any later
12 version.
14 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
15 WARRANTY; without even the implied warranty of MERCHANTABILITY or
16 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
17 for more details.
19 You should have received a copy of the GNU General Public License
20 along with GCC; see the file COPYING3. If not see
21 <http://www.gnu.org/licenses/>. */
24 #ifndef GCC_SYSTEM_H
25 #define GCC_SYSTEM_H
27 /* We must include stdarg.h before stdio.h. */
28 #include <stdarg.h>
30 #ifndef va_copy
31 # ifdef __va_copy
32 # define va_copy(d,s) __va_copy((d),(s))
33 # else
34 # define va_copy(d,s) ((d) = (s))
35 # endif
36 #endif
38 #ifdef HAVE_STDDEF_H
39 # include <stddef.h>
40 #endif
42 #include <stdio.h>
44 /* Define a generic NULL if one hasn't already been defined. */
45 #ifndef NULL
46 #define NULL 0
47 #endif
49 /* Use the unlocked open routines from libiberty. */
50 #ifdef fopen /* fopen is a #define on VMS. */
51 #undef fopen
52 #endif
53 #define fopen(PATH,MODE) fopen_unlocked(PATH,MODE)
54 #define fdopen(FILDES,MODE) fdopen_unlocked(FILDES,MODE)
55 #define freopen(PATH,MODE,STREAM) freopen_unlocked(PATH,MODE,STREAM)
57 /* The compiler is not a multi-threaded application and therefore we
58 do not have to use the locking functions. In fact, using the locking
59 functions can cause the compiler to be significantly slower under
60 I/O bound conditions (such as -g -O0 on very large source files).
62 HAVE_DECL_PUTC_UNLOCKED actually indicates whether or not the stdio
63 code is multi-thread safe by default. If it is set to 0, then do
64 not worry about using the _unlocked functions.
66 fputs_unlocked, fwrite_unlocked, and fprintf_unlocked are
67 extensions and need to be prototyped by hand (since we do not
68 define _GNU_SOURCE). */
70 #if defined HAVE_DECL_PUTC_UNLOCKED && HAVE_DECL_PUTC_UNLOCKED
72 # ifdef HAVE_PUTC_UNLOCKED
73 # undef putc
74 # define putc(C, Stream) putc_unlocked (C, Stream)
75 # endif
76 # ifdef HAVE_PUTCHAR_UNLOCKED
77 # undef putchar
78 # define putchar(C) putchar_unlocked (C)
79 # endif
80 # ifdef HAVE_GETC_UNLOCKED
81 # undef getc
82 # define getc(Stream) getc_unlocked (Stream)
83 # endif
84 # ifdef HAVE_GETCHAR_UNLOCKED
85 # undef getchar
86 # define getchar() getchar_unlocked ()
87 # endif
88 # ifdef HAVE_FPUTC_UNLOCKED
89 # undef fputc
90 # define fputc(C, Stream) fputc_unlocked (C, Stream)
91 # endif
93 #ifdef __cplusplus
94 extern "C" {
95 #endif
97 # ifdef HAVE_CLEARERR_UNLOCKED
98 # undef clearerr
99 # define clearerr(Stream) clearerr_unlocked (Stream)
100 # if defined (HAVE_DECL_CLEARERR_UNLOCKED) && !HAVE_DECL_CLEARERR_UNLOCKED
101 extern void clearerr_unlocked (FILE *);
102 # endif
103 # endif
104 # ifdef HAVE_FEOF_UNLOCKED
105 # undef feof
106 # define feof(Stream) feof_unlocked (Stream)
107 # if defined (HAVE_DECL_FEOF_UNLOCKED) && !HAVE_DECL_FEOF_UNLOCKED
108 extern int feof_unlocked (FILE *);
109 # endif
110 # endif
111 # ifdef HAVE_FILENO_UNLOCKED
112 # undef fileno
113 # define fileno(Stream) fileno_unlocked (Stream)
114 # if defined (HAVE_DECL_FILENO_UNLOCKED) && !HAVE_DECL_FILENO_UNLOCKED
115 extern int fileno_unlocked (FILE *);
116 # endif
117 # endif
118 # ifdef HAVE_FFLUSH_UNLOCKED
119 # undef fflush
120 # define fflush(Stream) fflush_unlocked (Stream)
121 # if defined (HAVE_DECL_FFLUSH_UNLOCKED) && !HAVE_DECL_FFLUSH_UNLOCKED
122 extern int fflush_unlocked (FILE *);
123 # endif
124 # endif
125 # ifdef HAVE_FGETC_UNLOCKED
126 # undef fgetc
127 # define fgetc(Stream) fgetc_unlocked (Stream)
128 # if defined (HAVE_DECL_FGETC_UNLOCKED) && !HAVE_DECL_FGETC_UNLOCKED
129 extern int fgetc_unlocked (FILE *);
130 # endif
131 # endif
132 # ifdef HAVE_FGETS_UNLOCKED
133 # undef fgets
134 # define fgets(S, n, Stream) fgets_unlocked (S, n, Stream)
135 # if defined (HAVE_DECL_FGETS_UNLOCKED) && !HAVE_DECL_FGETS_UNLOCKED
136 extern char *fgets_unlocked (char *, int, FILE *);
137 # endif
138 # endif
139 # ifdef HAVE_FPUTS_UNLOCKED
140 # undef fputs
141 # define fputs(String, Stream) fputs_unlocked (String, Stream)
142 # if defined (HAVE_DECL_FPUTS_UNLOCKED) && !HAVE_DECL_FPUTS_UNLOCKED
143 extern int fputs_unlocked (const char *, FILE *);
144 # endif
145 # endif
146 # ifdef HAVE_FERROR_UNLOCKED
147 # undef ferror
148 # define ferror(Stream) ferror_unlocked (Stream)
149 # if defined (HAVE_DECL_FERROR_UNLOCKED) && !HAVE_DECL_FERROR_UNLOCKED
150 extern int ferror_unlocked (FILE *);
151 # endif
152 # endif
153 # ifdef HAVE_FREAD_UNLOCKED
154 # undef fread
155 # define fread(Ptr, Size, N, Stream) fread_unlocked (Ptr, Size, N, Stream)
156 # if defined (HAVE_DECL_FREAD_UNLOCKED) && !HAVE_DECL_FREAD_UNLOCKED
157 extern size_t fread_unlocked (void *, size_t, size_t, FILE *);
158 # endif
159 # endif
160 # ifdef HAVE_FWRITE_UNLOCKED
161 # undef fwrite
162 # define fwrite(Ptr, Size, N, Stream) fwrite_unlocked (Ptr, Size, N, Stream)
163 # if defined (HAVE_DECL_FWRITE_UNLOCKED) && !HAVE_DECL_FWRITE_UNLOCKED
164 extern size_t fwrite_unlocked (const void *, size_t, size_t, FILE *);
165 # endif
166 # endif
167 # ifdef HAVE_FPRINTF_UNLOCKED
168 # undef fprintf
169 /* We can't use a function-like macro here because we don't know if
170 we have varargs macros. */
171 # define fprintf fprintf_unlocked
172 # if defined (HAVE_DECL_FPRINTF_UNLOCKED) && !HAVE_DECL_FPRINTF_UNLOCKED
173 extern int fprintf_unlocked (FILE *, const char *, ...);
174 # endif
175 # endif
177 #ifdef __cplusplus
179 #endif
181 #endif
183 /* ??? Glibc's fwrite/fread_unlocked macros cause
184 "warning: signed and unsigned type in conditional expression". */
185 #undef fread_unlocked
186 #undef fwrite_unlocked
188 /* There are an extraordinary number of issues with <ctype.h>.
189 The last straw is that it varies with the locale. Use libiberty's
190 replacement instead. */
191 #include "safe-ctype.h"
193 #include <sys/types.h>
195 #include <errno.h>
197 #if !defined (errno) && defined (HAVE_DECL_ERRNO) && !HAVE_DECL_ERRNO
198 extern int errno;
199 #endif
201 #ifdef __cplusplus
202 # include <cstring>
203 #endif
205 /* Some of glibc's string inlines cause warnings. Plus we'd rather
206 rely on (and therefore test) GCC's string builtins. */
207 #define __NO_STRING_INLINES
209 #ifdef STRING_WITH_STRINGS
210 # include <string.h>
211 # include <strings.h>
212 #else
213 # ifdef HAVE_STRING_H
214 # include <string.h>
215 # else
216 # ifdef HAVE_STRINGS_H
217 # include <strings.h>
218 # endif
219 # endif
220 #endif
222 #ifdef HAVE_STDLIB_H
223 # include <stdlib.h>
224 #endif
226 /* If we don't have an overriding definition, set SUCCESS_EXIT_CODE and
227 FATAL_EXIT_CODE to EXIT_SUCCESS and EXIT_FAILURE respectively,
228 or 0 and 1 if those macros are not defined. */
229 #ifndef SUCCESS_EXIT_CODE
230 # ifdef EXIT_SUCCESS
231 # define SUCCESS_EXIT_CODE EXIT_SUCCESS
232 # else
233 # define SUCCESS_EXIT_CODE 0
234 # endif
235 #endif
237 #ifndef FATAL_EXIT_CODE
238 # ifdef EXIT_FAILURE
239 # define FATAL_EXIT_CODE EXIT_FAILURE
240 # else
241 # define FATAL_EXIT_CODE 1
242 # endif
243 #endif
245 #define ICE_EXIT_CODE 4
247 #ifdef HAVE_UNISTD_H
248 # include <unistd.h>
249 #endif
251 #ifdef HAVE_SYS_PARAM_H
252 # include <sys/param.h>
253 /* We use this identifier later and it appears in some vendor param.h's. */
254 # undef PREFETCH
255 #endif
257 #if HAVE_LIMITS_H
258 # include <limits.h>
259 #endif
261 /* Get definitions of HOST_WIDE_INT and HOST_WIDEST_INT. */
262 #include "hwint.h"
264 /* A macro to determine whether a VALUE lies inclusively within a
265 certain range without evaluating the VALUE more than once. This
266 macro won't warn if the VALUE is unsigned and the LOWER bound is
267 zero, as it would e.g. with "VALUE >= 0 && ...". Note the LOWER
268 bound *is* evaluated twice, and LOWER must not be greater than
269 UPPER. However the bounds themselves can be either positive or
270 negative. */
271 #define IN_RANGE(VALUE, LOWER, UPPER) \
272 ((unsigned HOST_WIDE_INT) (VALUE) - (unsigned HOST_WIDE_INT) (LOWER) \
273 <= (unsigned HOST_WIDE_INT) (UPPER) - (unsigned HOST_WIDE_INT) (LOWER))
275 /* Infrastructure for defining missing _MAX and _MIN macros. Note that
276 macros defined with these cannot be used in #if. */
278 /* The extra casts work around common compiler bugs. */
279 #define INTTYPE_SIGNED(t) (! ((t) 0 < (t) -1))
280 /* The outer cast is needed to work around a bug in Cray C 5.0.3.0.
281 It is necessary at least when t == time_t. */
282 #define INTTYPE_MINIMUM(t) ((t) (INTTYPE_SIGNED (t) \
283 ? ~ (t) 0 << (sizeof(t) * CHAR_BIT - 1) : (t) 0))
284 #define INTTYPE_MAXIMUM(t) ((t) (~ (t) 0 - INTTYPE_MINIMUM (t)))
286 /* Use that infrastructure to provide a few constants. */
287 #ifndef UCHAR_MAX
288 # define UCHAR_MAX INTTYPE_MAXIMUM (unsigned char)
289 #endif
291 #ifdef TIME_WITH_SYS_TIME
292 # include <sys/time.h>
293 # include <time.h>
294 #else
295 # if HAVE_SYS_TIME_H
296 # include <sys/time.h>
297 # else
298 # ifdef HAVE_TIME_H
299 # include <time.h>
300 # endif
301 # endif
302 #endif
304 #ifdef HAVE_FCNTL_H
305 # include <fcntl.h>
306 #else
307 # ifdef HAVE_SYS_FILE_H
308 # include <sys/file.h>
309 # endif
310 #endif
312 #ifndef SEEK_SET
313 # define SEEK_SET 0
314 # define SEEK_CUR 1
315 # define SEEK_END 2
316 #endif
317 #ifndef F_OK
318 # define F_OK 0
319 # define X_OK 1
320 # define W_OK 2
321 # define R_OK 4
322 #endif
323 #ifndef O_RDONLY
324 # define O_RDONLY 0
325 #endif
326 #ifndef O_WRONLY
327 # define O_WRONLY 1
328 #endif
329 #ifndef O_BINARY
330 # define O_BINARY 0
331 #endif
333 /* Some systems define these in, e.g., param.h. We undefine these names
334 here to avoid the warnings. We prefer to use our definitions since we
335 know they are correct. */
337 #undef MIN
338 #undef MAX
339 #define MIN(X,Y) ((X) < (Y) ? (X) : (Y))
340 #define MAX(X,Y) ((X) > (Y) ? (X) : (Y))
342 /* Returns the least number N such that N * Y >= X. */
343 #define CEIL(x,y) (((x) + (y) - 1) / (y))
345 #ifdef HAVE_SYS_WAIT_H
346 #include <sys/wait.h>
347 #endif
349 #ifndef WIFSIGNALED
350 #define WIFSIGNALED(S) (((S) & 0xff) != 0 && ((S) & 0xff) != 0x7f)
351 #endif
352 #ifndef WTERMSIG
353 #define WTERMSIG(S) ((S) & 0x7f)
354 #endif
355 #ifndef WIFEXITED
356 #define WIFEXITED(S) (((S) & 0xff) == 0)
357 #endif
358 #ifndef WEXITSTATUS
359 #define WEXITSTATUS(S) (((S) & 0xff00) >> 8)
360 #endif
361 #ifndef WSTOPSIG
362 #define WSTOPSIG WEXITSTATUS
363 #endif
364 #ifndef WCOREDUMP
365 #define WCOREDUMP(S) ((S) & WCOREFLG)
366 #endif
367 #ifndef WCOREFLG
368 #define WCOREFLG 0200
369 #endif
371 #include <signal.h>
372 #if !defined (SIGCHLD) && defined (SIGCLD)
373 # define SIGCHLD SIGCLD
374 #endif
376 #ifdef HAVE_SYS_MMAN_H
377 # include <sys/mman.h>
378 #endif
380 #ifndef MAP_FAILED
381 # define MAP_FAILED ((void *)-1)
382 #endif
384 #if !defined (MAP_ANONYMOUS) && defined (MAP_ANON)
385 # define MAP_ANONYMOUS MAP_ANON
386 #endif
388 #ifdef HAVE_SYS_RESOURCE_H
389 # include <sys/resource.h>
390 #endif
392 #ifdef HAVE_SYS_TIMES_H
393 # include <sys/times.h>
394 #endif
396 /* The HAVE_DECL_* macros are three-state, undefined, 0 or 1. If they
397 are defined to 0 then we must provide the relevant declaration
398 here. These checks will be in the undefined state while configure
399 is running so be careful to test "defined (HAVE_DECL_*)". */
401 #ifdef __cplusplus
402 extern "C" {
403 #endif
405 #if defined (HAVE_DECL_ATOF) && !HAVE_DECL_ATOF
406 extern double atof (const char *);
407 #endif
409 #if defined (HAVE_DECL_ATOL) && !HAVE_DECL_ATOL
410 extern long atol (const char *);
411 #endif
413 #if defined (HAVE_DECL_FREE) && !HAVE_DECL_FREE
414 extern void free (void *);
415 #endif
417 #if defined (HAVE_DECL_GETCWD) && !HAVE_DECL_GETCWD
418 extern char *getcwd (char *, size_t);
419 #endif
421 #if defined (HAVE_DECL_GETENV) && !HAVE_DECL_GETENV
422 extern char *getenv (const char *);
423 #endif
425 #if defined (HAVE_DECL_GETOPT) && !HAVE_DECL_GETOPT
426 extern int getopt (int, char * const *, const char *);
427 #endif
429 #if defined (HAVE_DECL_GETPAGESIZE) && !HAVE_DECL_GETPAGESIZE
430 extern int getpagesize (void);
431 #endif
433 #if defined (HAVE_DECL_GETWD) && !HAVE_DECL_GETWD
434 extern char *getwd (char *);
435 #endif
437 #if defined (HAVE_DECL_SBRK) && !HAVE_DECL_SBRK
438 extern void *sbrk (int);
439 #endif
441 #if defined (HAVE_DECL_STRSTR) && !HAVE_DECL_STRSTR
442 extern char *strstr (const char *, const char *);
443 #endif
445 #ifdef __cplusplus
447 #endif
449 #ifdef HAVE_MALLOC_H
450 #include <malloc.h>
451 #endif
453 #ifdef __cplusplus
454 extern "C" {
455 #endif
457 #if defined (HAVE_DECL_MALLOC) && !HAVE_DECL_MALLOC
458 extern void *malloc (size_t);
459 #endif
461 #if defined (HAVE_DECL_CALLOC) && !HAVE_DECL_CALLOC
462 extern void *calloc (size_t, size_t);
463 #endif
465 #if defined (HAVE_DECL_REALLOC) && !HAVE_DECL_REALLOC
466 extern void *realloc (void *, size_t);
467 #endif
469 #ifdef __cplusplus
471 #endif
473 #ifdef HAVE_STDINT_H
474 #include <stdint.h>
475 #endif
477 #ifdef HAVE_INTTYPES_H
478 #include <inttypes.h>
479 #endif
481 #ifdef __cplusplus
482 extern "C" {
483 #endif
485 /* If the system doesn't provide strsignal, we get it defined in
486 libiberty but no declaration is supplied. */
487 #if !defined (HAVE_STRSIGNAL) \
488 || (defined (HAVE_DECL_STRSIGNAL) && !HAVE_DECL_STRSIGNAL)
489 # ifndef strsignal
490 extern const char *strsignal (int);
491 # endif
492 #endif
494 #ifdef HAVE_GETRLIMIT
495 # if defined (HAVE_DECL_GETRLIMIT) && !HAVE_DECL_GETRLIMIT
496 # ifndef getrlimit
497 struct rlimit;
498 extern int getrlimit (int, struct rlimit *);
499 # endif
500 # endif
501 #endif
503 #ifdef HAVE_SETRLIMIT
504 # if defined (HAVE_DECL_SETRLIMIT) && !HAVE_DECL_SETRLIMIT
505 # ifndef setrlimit
506 struct rlimit;
507 extern int setrlimit (int, const struct rlimit *);
508 # endif
509 # endif
510 #endif
512 #if defined (HAVE_DECL_ABORT) && !HAVE_DECL_ABORT
513 extern void abort (void);
514 #endif
516 #if defined (HAVE_DECL_SNPRINTF) && !HAVE_DECL_SNPRINTF
517 extern int snprintf (char *, size_t, const char *, ...);
518 #endif
520 #if defined (HAVE_DECL_VSNPRINTF) && !HAVE_DECL_VSNPRINTF
521 extern int vsnprintf(char *, size_t, const char *, va_list);
522 #endif
524 #ifdef __cplusplus
526 #endif
528 /* 1 if we have C99 designated initializers. */
529 #if !defined(HAVE_DESIGNATED_INITIALIZERS)
530 #define HAVE_DESIGNATED_INITIALIZERS \
531 (((GCC_VERSION >= 2007) || (__STDC_VERSION__ >= 199901L)) \
532 && !defined(__cplusplus))
533 #endif
535 #if !defined(HAVE_DESIGNATED_UNION_INITIALIZERS)
536 #define HAVE_DESIGNATED_UNION_INITIALIZERS \
537 (((GCC_VERSION >= 2007) || (__STDC_VERSION__ >= 199901L)) \
538 && (!defined(__cplusplus) || (GCC_VERSION >= 4007)))
539 #endif
541 #if HAVE_SYS_STAT_H
542 # include <sys/stat.h>
543 #endif
545 /* Test if something is a normal file. */
546 #ifndef S_ISREG
547 #define S_ISREG(m) (((m) & S_IFMT) == S_IFREG)
548 #endif
550 /* Test if something is a directory. */
551 #ifndef S_ISDIR
552 #define S_ISDIR(m) (((m) & S_IFMT) == S_IFDIR)
553 #endif
555 /* Test if something is a character special file. */
556 #ifndef S_ISCHR
557 #define S_ISCHR(m) (((m) & S_IFMT) == S_IFCHR)
558 #endif
560 /* Test if something is a block special file. */
561 #ifndef S_ISBLK
562 #define S_ISBLK(m) (((m) & S_IFMT) == S_IFBLK)
563 #endif
565 /* Test if something is a socket. */
566 #ifndef S_ISSOCK
567 # ifdef S_IFSOCK
568 # define S_ISSOCK(m) (((m) & S_IFMT) == S_IFSOCK)
569 # else
570 # define S_ISSOCK(m) 0
571 # endif
572 #endif
574 /* Test if something is a FIFO. */
575 #ifndef S_ISFIFO
576 # ifdef S_IFIFO
577 # define S_ISFIFO(m) (((m) & S_IFMT) == S_IFIFO)
578 # else
579 # define S_ISFIFO(m) 0
580 # endif
581 #endif
583 /* Define well known filenos if the system does not define them. */
584 #ifndef STDIN_FILENO
585 # define STDIN_FILENO 0
586 #endif
587 #ifndef STDOUT_FILENO
588 # define STDOUT_FILENO 1
589 #endif
590 #ifndef STDERR_FILENO
591 # define STDERR_FILENO 2
592 #endif
594 /* Some systems have mkdir that takes a single argument. */
595 #ifdef MKDIR_TAKES_ONE_ARG
596 # define mkdir(a,b) mkdir(a)
597 #endif
599 #ifndef HAVE_KILL
600 # define kill(p,s) raise(s)
601 #endif
603 /* Provide a way to print an address via printf. */
604 #ifndef HOST_PTR_PRINTF
605 #define HOST_PTR_PRINTF "%p"
606 #endif /* ! HOST_PTR_PRINTF */
608 /* By default, colon separates directories in a path. */
609 #ifndef PATH_SEPARATOR
610 #define PATH_SEPARATOR ':'
611 #endif
613 /* Filename handling macros. */
614 #include "filenames.h"
616 /* These should be phased out in favor of IS_DIR_SEPARATOR, where possible. */
617 #ifndef DIR_SEPARATOR
618 # define DIR_SEPARATOR '/'
619 # ifdef HAVE_DOS_BASED_FILE_SYSTEM
620 # define DIR_SEPARATOR_2 '\\'
621 # endif
622 #endif
624 #if defined (ENABLE_PLUGIN) && defined (HAVE_DLFCN_H)
625 /* If plugin support is enabled, we could use libdl. */
626 #include <dlfcn.h>
627 #endif
629 /* Get libiberty declarations. */
630 #include "libiberty.h"
632 /* Provide a default for the HOST_BIT_BUCKET.
633 This suffices for POSIX-like hosts. */
635 #ifndef HOST_BIT_BUCKET
636 #define HOST_BIT_BUCKET "/dev/null"
637 #endif
639 #ifndef offsetof
640 #define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *) 0)->MEMBER)
641 #endif
643 /* Various error reporting routines want to use __FUNCTION__. */
644 #if (GCC_VERSION < 2007)
645 #ifndef __FUNCTION__
646 #define __FUNCTION__ "?"
647 #endif /* ! __FUNCTION__ */
648 #endif
650 /* __builtin_expect(A, B) evaluates to A, but notifies the compiler that
651 the most likely value of A is B. This feature was added at some point
652 between 2.95 and 3.0. Let's use 3.0 as the lower bound for now. */
653 #if (GCC_VERSION < 3000)
654 #define __builtin_expect(a, b) (a)
655 #endif
657 /* Redefine abort to report an internal error w/o coredump, and
658 reporting the location of the error in the source file. */
659 extern void fancy_abort (const char *, int, const char *) ATTRIBUTE_NORETURN;
660 #define abort() fancy_abort (__FILE__, __LINE__, __FUNCTION__)
662 /* Use gcc_assert(EXPR) to test invariants. */
663 #if ENABLE_ASSERT_CHECKING
664 #define gcc_assert(EXPR) \
665 ((void)(!(EXPR) ? fancy_abort (__FILE__, __LINE__, __FUNCTION__), 0 : 0))
666 #elif (GCC_VERSION >= 4005)
667 #define gcc_assert(EXPR) \
668 ((void)(__builtin_expect(!(EXPR), 0) ? __builtin_unreachable(), 0 : 0))
669 #else
670 /* Include EXPR, so that unused variable warnings do not occur. */
671 #define gcc_assert(EXPR) ((void)(0 && (EXPR)))
672 #endif
674 #ifdef ENABLE_CHECKING
675 #define gcc_checking_assert(EXPR) gcc_assert (EXPR)
676 #else
677 #define gcc_checking_assert(EXPR) ((void)(0 && (EXPR)))
678 #endif
680 /* Use gcc_unreachable() to mark unreachable locations (like an
681 unreachable default case of a switch. Do not use gcc_assert(0). */
682 #if (GCC_VERSION >= 4005) && !ENABLE_ASSERT_CHECKING
683 #define gcc_unreachable() __builtin_unreachable()
684 #else
685 #define gcc_unreachable() (fancy_abort (__FILE__, __LINE__, __FUNCTION__))
686 #endif
688 /* Provide a fake boolean type. We make no attempt to use the
689 C99 _Bool, as it may not be available in the bootstrap compiler,
690 and even if it is, it is liable to be buggy.
691 This must be after all inclusion of system headers, as some of
692 them will mess us up. */
694 #undef TRUE
695 #undef FALSE
697 #ifdef __cplusplus
698 /* Obsolete. */
699 # define TRUE true
700 # define FALSE false
701 #else /* !__cplusplus */
702 # undef bool
703 # undef true
704 # undef false
706 # define bool unsigned char
707 # define true 1
708 # define false 0
710 /* Obsolete. */
711 # define TRUE true
712 # define FALSE false
713 #endif /* !__cplusplus */
715 /* Some compilers do not allow the use of unsigned char in bitfields. */
716 #define BOOL_BITFIELD unsigned int
718 /* As the last action in this file, we poison the identifiers that
719 shouldn't be used. Note, luckily gcc-3.0's token-based integrated
720 preprocessor won't trip on poisoned identifiers that arrive from
721 the expansion of macros. E.g. #define strrchr rindex, won't error
722 if rindex is poisoned after this directive is issued and later on
723 strrchr is called.
725 Note: We define bypass macros for the few cases where we really
726 want to use the libc memory allocation routines. Otherwise we
727 insist you use the "x" versions from libiberty. */
729 #define really_call_malloc malloc
730 #define really_call_calloc calloc
731 #define really_call_realloc realloc
733 #if defined(FLEX_SCANNER) || defined(YYBISON) || defined(YYBYACC)
734 /* Flex and bison use malloc and realloc. Yuk. Note that this means
735 really_call_* cannot be used in a .l or .y file. */
736 #define malloc xmalloc
737 #define realloc xrealloc
738 #endif
740 #if (GCC_VERSION >= 3000)
742 /* Note autoconf checks for prototype declarations and includes
743 system.h while doing so. Only poison these tokens if actually
744 compiling gcc, so that the autoconf declaration tests for malloc
745 etc don't spuriously fail. */
746 #ifdef IN_GCC
747 #undef calloc
748 #undef strdup
749 #pragma GCC poison calloc strdup
751 #if !defined(FLEX_SCANNER) && !defined(YYBISON)
752 #undef malloc
753 #undef realloc
754 #pragma GCC poison malloc realloc
755 #endif
757 /* The %m format should be used when GCC's main diagnostic functions
758 supporting %m are available, and xstrerror from libiberty
759 otherwise. */
760 #undef strerror
761 #pragma GCC poison strerror
763 /* Old target macros that have moved to the target hooks structure. */
764 #pragma GCC poison ASM_OPEN_PAREN ASM_CLOSE_PAREN \
765 FUNCTION_PROLOGUE FUNCTION_EPILOGUE \
766 FUNCTION_END_PROLOGUE FUNCTION_BEGIN_EPILOGUE \
767 DECL_MACHINE_ATTRIBUTES COMP_TYPE_ATTRIBUTES INSERT_ATTRIBUTES \
768 VALID_MACHINE_DECL_ATTRIBUTE VALID_MACHINE_TYPE_ATTRIBUTE \
769 SET_DEFAULT_TYPE_ATTRIBUTES SET_DEFAULT_DECL_ATTRIBUTES \
770 MERGE_MACHINE_TYPE_ATTRIBUTES MERGE_MACHINE_DECL_ATTRIBUTES \
771 MD_INIT_BUILTINS MD_EXPAND_BUILTIN ASM_OUTPUT_CONSTRUCTOR \
772 ASM_OUTPUT_DESTRUCTOR SIGNED_CHAR_SPEC MAX_CHAR_TYPE_SIZE \
773 WCHAR_UNSIGNED UNIQUE_SECTION SELECT_SECTION SELECT_RTX_SECTION \
774 ENCODE_SECTION_INFO STRIP_NAME_ENCODING ASM_GLOBALIZE_LABEL \
775 ASM_OUTPUT_MI_THUNK CONST_COSTS RTX_COSTS DEFAULT_RTX_COSTS \
776 ADDRESS_COST MACHINE_DEPENDENT_REORG ASM_FILE_START ASM_FILE_END \
777 ASM_SIMPLIFY_DWARF_ADDR INIT_TARGET_OPTABS INIT_SUBTARGET_OPTABS \
778 INIT_GOFAST_OPTABS MULSI3_LIBCALL MULDI3_LIBCALL DIVSI3_LIBCALL \
779 DIVDI3_LIBCALL UDIVSI3_LIBCALL UDIVDI3_LIBCALL MODSI3_LIBCALL \
780 MODDI3_LIBCALL UMODSI3_LIBCALL UMODDI3_LIBCALL BUILD_VA_LIST_TYPE \
781 PRETEND_OUTGOING_VARARGS_NAMED STRUCT_VALUE_INCOMING_REGNUM \
782 ASM_OUTPUT_SECTION_NAME PROMOTE_FUNCTION_ARGS PROMOTE_FUNCTION_MODE \
783 STRUCT_VALUE_INCOMING STRICT_ARGUMENT_NAMING \
784 PROMOTE_FUNCTION_RETURN PROMOTE_PROTOTYPES STRUCT_VALUE_REGNUM \
785 SETUP_INCOMING_VARARGS EXPAND_BUILTIN_SAVEREGS \
786 DEFAULT_SHORT_ENUMS SPLIT_COMPLEX_ARGS MD_ASM_CLOBBERS \
787 HANDLE_PRAGMA_REDEFINE_EXTNAME HANDLE_PRAGMA_EXTERN_PREFIX \
788 MUST_PASS_IN_STACK FUNCTION_ARG_PASS_BY_REFERENCE \
789 VECTOR_MODE_SUPPORTED_P TARGET_SUPPORTS_HIDDEN \
790 FUNCTION_ARG_PARTIAL_NREGS ASM_OUTPUT_DWARF_DTPREL \
791 ALLOCATE_INITIAL_VALUE LEGITIMIZE_ADDRESS FRAME_POINTER_REQUIRED \
792 CAN_ELIMINATE TRAMPOLINE_TEMPLATE INITIALIZE_TRAMPOLINE \
793 TRAMPOLINE_ADJUST_ADDRESS STATIC_CHAIN STATIC_CHAIN_INCOMING \
794 RETURN_POPS_ARGS UNITS_PER_SIMD_WORD OVERRIDE_OPTIONS \
795 OPTIMIZATION_OPTIONS CLASS_LIKELY_SPILLED_P \
796 USING_SJLJ_EXCEPTIONS TARGET_UNWIND_INFO \
797 LABEL_ALIGN_MAX_SKIP LOOP_ALIGN_MAX_SKIP \
798 LABEL_ALIGN_AFTER_BARRIER_MAX_SKIP JUMP_ALIGN_MAX_SKIP \
799 CAN_DEBUG_WITHOUT_FP UNLIKELY_EXECUTED_TEXT_SECTION_NAME \
800 HOT_TEXT_SECTION_NAME LEGITIMATE_CONSTANT_P ALWAYS_STRIP_DOTDOT
802 /* Target macros only used for code built for the target, that have
803 moved to libgcc-tm.h or have never been present elsewhere. */
804 #pragma GCC poison DECLARE_LIBRARY_RENAMES LIBGCC2_GNU_PREFIX \
805 MD_UNWIND_SUPPORT MD_FROB_UPDATE_CONTEXT ENABLE_EXECUTE_STACK \
806 REG_VALUE_IN_UNWIND_CONTEXT ASSUME_EXTENDED_UNWIND_CONTEXT
808 /* Other obsolete target macros, or macros that used to be in target
809 headers and were not used, and may be obsolete or may never have
810 been used. */
811 #pragma GCC poison INT_ASM_OP ASM_OUTPUT_EH_REGION_BEG CPP_PREDEFINES \
812 ASM_OUTPUT_EH_REGION_END ASM_OUTPUT_LABELREF_AS_INT SMALL_STACK \
813 DOESNT_NEED_UNWINDER EH_TABLE_LOOKUP OBJC_SELECTORS_WITHOUT_LABELS \
814 OMIT_EH_TABLE EASY_DIV_EXPR IMPLICIT_FIX_EXPR \
815 LONGJMP_RESTORE_FROM_STACK MAX_INT_TYPE_SIZE ASM_IDENTIFY_GCC \
816 STDC_VALUE TRAMPOLINE_ALIGN ASM_IDENTIFY_GCC_AFTER_SOURCE \
817 SLOW_ZERO_EXTEND SUBREG_REGNO_OFFSET DWARF_LINE_MIN_INSTR_LENGTH \
818 TRADITIONAL_RETURN_FLOAT NO_BUILTIN_SIZE_TYPE \
819 NO_BUILTIN_PTRDIFF_TYPE NO_BUILTIN_WCHAR_TYPE NO_BUILTIN_WINT_TYPE \
820 BLOCK_PROFILER BLOCK_PROFILER_CODE FUNCTION_BLOCK_PROFILER \
821 FUNCTION_BLOCK_PROFILER_EXIT MACHINE_STATE_SAVE \
822 MACHINE_STATE_RESTORE SCCS_DIRECTIVE SECTION_ASM_OP BYTEORDER \
823 ASM_OUTPUT_DEFINE_LABEL_DIFFERENCE_SYMBOL HOST_WORDS_BIG_ENDIAN \
824 OBJC_PROLOGUE ALLOCATE_TRAMPOLINE HANDLE_PRAGMA ROUND_TYPE_SIZE \
825 ROUND_TYPE_SIZE_UNIT CONST_SECTION_ASM_OP CRT_GET_RFIB_TEXT \
826 DBX_LBRAC_FIRST DBX_OUTPUT_ENUM DBX_OUTPUT_SOURCE_FILENAME \
827 DBX_WORKING_DIRECTORY INSN_CACHE_DEPTH INSN_CACHE_SIZE \
828 INSN_CACHE_LINE_WIDTH INIT_SECTION_PREAMBLE NEED_ATEXIT ON_EXIT \
829 EXIT_BODY OBJECT_FORMAT_ROSE MULTIBYTE_CHARS MAP_CHARACTER \
830 LIBGCC_NEEDS_DOUBLE FINAL_PRESCAN_LABEL DEFAULT_CALLER_SAVES \
831 LOAD_ARGS_REVERSED MAX_INTEGER_COMPUTATION_MODE \
832 CONVERT_HARD_REGISTER_TO_SSA_P ASM_OUTPUT_MAIN_SOURCE_FILENAME \
833 FIRST_INSN_ADDRESS TEXT_SECTION SHARED_BSS_SECTION_ASM_OP \
834 PROMOTED_MODE EXPAND_BUILTIN_VA_END \
835 LINKER_DOES_NOT_WORK_WITH_DWARF2 FUNCTION_ARG_KEEP_AS_REFERENCE \
836 GIV_SORT_CRITERION MAX_LONG_TYPE_SIZE MAX_LONG_DOUBLE_TYPE_SIZE \
837 MAX_WCHAR_TYPE_SIZE SHARED_SECTION_ASM_OP INTEGRATE_THRESHOLD \
838 FINAL_REG_PARM_STACK_SPACE MAYBE_REG_PARM_STACK_SPACE \
839 TRADITIONAL_PIPELINE_INTERFACE DFA_PIPELINE_INTERFACE \
840 DBX_OUTPUT_STANDARD_TYPES BUILTIN_SETJMP_FRAME_VALUE \
841 SUNOS4_SHARED_LIBRARIES PROMOTE_FOR_CALL_ONLY \
842 SPACE_AFTER_L_OPTION NO_RECURSIVE_FUNCTION_CSE \
843 DEFAULT_MAIN_RETURN TARGET_MEM_FUNCTIONS EXPAND_BUILTIN_VA_ARG \
844 COLLECT_PARSE_FLAG DWARF2_GENERATE_TEXT_SECTION_LABEL WINNING_GDB \
845 ASM_OUTPUT_FILENAME ASM_OUTPUT_SOURCE_LINE FILE_NAME_JOINER \
846 GDB_INV_REF_REGPARM_STABS_LETTER DBX_MEMPARM_STABS_LETTER \
847 PUT_SDB_SRC_FILE STABS_GCC_MARKER DBX_OUTPUT_FUNCTION_END \
848 DBX_OUTPUT_GCC_MARKER DBX_FINISH_SYMBOL SDB_GENERATE_FAKE \
849 NON_SAVING_SETJMP TARGET_LATE_RTL_PROLOGUE_EPILOGUE \
850 CASE_DROPS_THROUGH TARGET_BELL TARGET_BS TARGET_CR TARGET_DIGIT0 \
851 TARGET_ESC TARGET_FF TARGET_NEWLINE TARGET_TAB TARGET_VT \
852 LINK_LIBGCC_SPECIAL DONT_ACCESS_GBLS_AFTER_EPILOGUE \
853 TARGET_OPTIONS TARGET_SWITCHES EXTRA_CC_MODES FINALIZE_PIC \
854 PREDICATE_CODES SPECIAL_MODE_PREDICATES UNALIGNED_WORD_ASM_OP \
855 EXTRA_SECTIONS EXTRA_SECTION_FUNCTIONS READONLY_DATA_SECTION \
856 TARGET_ASM_EXCEPTION_SECTION TARGET_ASM_EH_FRAME_SECTION \
857 SMALL_ARG_MAX ASM_OUTPUT_SHARED_BSS ASM_OUTPUT_SHARED_COMMON \
858 ASM_OUTPUT_SHARED_LOCAL ASM_MAKE_LABEL_LINKONCE \
859 STACK_CHECK_PROBE_INTERVAL STACK_CHECK_PROBE_LOAD \
860 ORDER_REGS_FOR_LOCAL_ALLOC FUNCTION_OUTGOING_VALUE \
861 ASM_DECLARE_CONSTANT_NAME MODIFY_TARGET_NAME SWITCHES_NEED_SPACES \
862 SWITCH_CURTAILS_COMPILATION SWITCH_TAKES_ARG WORD_SWITCH_TAKES_ARG \
863 TARGET_OPTION_TRANSLATE_TABLE HANDLE_PRAGMA_PACK_PUSH_POP \
864 HANDLE_SYSV_PRAGMA HANDLE_PRAGMA_WEAK CONDITIONAL_REGISTER_USAGE \
865 FUNCTION_ARG_BOUNDARY MUST_USE_SJLJ_EXCEPTIONS US_SOFTWARE_GOFAST \
866 USING_SVR4_H SVR4_ASM_SPEC FUNCTION_ARG FUNCTION_ARG_ADVANCE \
867 FUNCTION_INCOMING_ARG IRA_COVER_CLASSES TARGET_VERSION \
868 MACHINE_TYPE TARGET_HAS_TARGETCM ASM_OUTPUT_BSS \
869 SETJMP_VIA_SAVE_AREA FORBIDDEN_INC_DEC_CLASSES
871 /* Hooks that are no longer used. */
872 #pragma GCC poison LANG_HOOKS_FUNCTION_MARK LANG_HOOKS_FUNCTION_FREE \
873 LANG_HOOKS_MARK_TREE LANG_HOOKS_INSERT_DEFAULT_ATTRIBUTES \
874 LANG_HOOKS_TREE_INLINING_ESTIMATE_NUM_INSNS \
875 LANG_HOOKS_PUSHLEVEL LANG_HOOKS_SET_BLOCK \
876 LANG_HOOKS_MAYBE_BUILD_CLEANUP LANG_HOOKS_UPDATE_DECL_AFTER_SAVING \
877 LANG_HOOKS_POPLEVEL LANG_HOOKS_TRUTHVALUE_CONVERSION \
878 TARGET_PROMOTE_FUNCTION_ARGS TARGET_PROMOTE_FUNCTION_RETURN \
879 LANG_HOOKS_MISSING_ARGUMENT LANG_HOOKS_HASH_TYPES \
880 TARGET_HANDLE_OFAST TARGET_OPTION_OPTIMIZATION \
881 TARGET_IRA_COVER_CLASSES TARGET_HELP
883 /* Hooks into libgcc2. */
884 #pragma GCC poison LIBGCC2_DOUBLE_TYPE_SIZE LIBGCC2_WORDS_BIG_ENDIAN \
885 LIBGCC2_FLOAT_WORDS_BIG_ENDIAN
887 /* Miscellaneous macros that are no longer used. */
888 #pragma GCC poison USE_MAPPED_LOCATION GET_ENVIRONMENT
890 /* Libiberty macros that are no longer used in GCC. */
891 #undef ANSI_PROTOTYPES
892 #undef PTR_CONST
893 #undef LONG_DOUBLE
894 #undef VPARAMS
895 #undef VA_OPEN
896 #undef VA_FIXEDARG
897 #undef VA_CLOSE
898 #undef VA_START
899 #pragma GCC poison ANSI_PROTOTYPES PTR_CONST LONG_DOUBLE VPARAMS VA_OPEN \
900 VA_FIXEDARG VA_CLOSE VA_START
901 #endif /* IN_GCC */
903 /* Front ends should never have to include middle-end headers. Enforce
904 this by poisoning the header double-include protection defines. */
905 #ifdef IN_GCC_FRONTEND
906 #pragma GCC poison GCC_RTL_H GCC_EXCEPT_H GCC_EXPR_H
907 #endif
909 /* Note: not all uses of the `index' token (e.g. variable names and
910 structure members) have been eliminated. */
911 #undef bcopy
912 #undef bzero
913 #undef bcmp
914 #undef rindex
915 #pragma GCC poison bcopy bzero bcmp rindex
917 #endif /* GCC >= 3.0 */
919 /* This macro allows casting away const-ness to pass -Wcast-qual
920 warnings. DO NOT USE THIS UNLESS YOU REALLY HAVE TO! It should
921 only be used in certain specific cases. One valid case is where
922 the C standard definitions or prototypes force you to. E.g. if you
923 need to free a const object, or if you pass a const string to
924 execv, et al. Another valid use would be in an allocation function
925 that creates const objects that need to be initialized. In some
926 cases we have non-const functions that return the argument
927 (e.g. next_nonnote_insn). Rather than create const shadow
928 functions, we can cast away const-ness in calling these interfaces
929 if we're careful to verify that the called function does indeed not
930 modify its argument and the return value is only used in a const
931 context. (This can be somewhat dangerous as these assumptions can
932 change after the fact). Beyond these uses, most other cases of
933 using this macro should be viewed with extreme caution. */
935 #ifdef __cplusplus
936 #define CONST_CAST2(TOTYPE,FROMTYPE,X) (const_cast<TOTYPE> (X))
937 #else
938 #if defined(__GNUC__) && GCC_VERSION > 4000
939 /* GCC 4.0.x has a bug where it may ICE on this expression,
940 so does GCC 3.4.x (PR17436). */
941 #define CONST_CAST2(TOTYPE,FROMTYPE,X) ((__extension__(union {FROMTYPE _q; TOTYPE _nq;})(X))._nq)
942 #elif defined(__GNUC__)
943 static inline char *
944 helper_const_non_const_cast (const char *p)
946 union {
947 const char *const_c;
948 char *c;
949 } val;
950 val.const_c = p;
951 return val.c;
954 #define CONST_CAST2(TOTYPE,FROMTYPE,X) \
955 ((TOTYPE) helper_const_non_const_cast ((const char *) (FROMTYPE) (X)))
956 #else
957 #define CONST_CAST2(TOTYPE,FROMTYPE,X) ((TOTYPE)(FROMTYPE)(X))
958 #endif
959 #endif
960 #define CONST_CAST(TYPE,X) CONST_CAST2(TYPE, const TYPE, (X))
961 #define CONST_CAST_TREE(X) CONST_CAST(union tree_node *, (X))
962 #define CONST_CAST_RTX(X) CONST_CAST(struct rtx_def *, (X))
963 #define CONST_CAST_BB(X) CONST_CAST(struct basic_block_def *, (X))
964 #define CONST_CAST_GIMPLE(X) CONST_CAST(union gimple_statement_d *, (X))
966 /* Activate certain diagnostics as warnings (not errors via the
967 -Werror flag). */
968 #if GCC_VERSION >= 4003
969 /* If asserts are disabled, activate -Wuninitialized as a warning (not
970 an error/-Werror). */
971 #ifndef ENABLE_ASSERT_CHECKING
972 #pragma GCC diagnostic warning "-Wuninitialized"
973 #endif
974 #endif
976 #ifdef ENABLE_VALGRIND_CHECKING
977 # ifdef HAVE_VALGRIND_MEMCHECK_H
978 # include <valgrind/memcheck.h>
979 # elif defined HAVE_MEMCHECK_H
980 # include <memcheck.h>
981 # else
982 # include <valgrind.h>
983 # endif
984 /* Compatibility macros to let valgrind 3.1 work. */
985 # ifndef VALGRIND_MAKE_MEM_NOACCESS
986 # define VALGRIND_MAKE_MEM_NOACCESS VALGRIND_MAKE_NOACCESS
987 # endif
988 # ifndef VALGRIND_MAKE_MEM_DEFINED
989 # define VALGRIND_MAKE_MEM_DEFINED VALGRIND_MAKE_READABLE
990 # endif
991 # ifndef VALGRIND_MAKE_MEM_UNDEFINED
992 # define VALGRIND_MAKE_MEM_UNDEFINED VALGRIND_MAKE_WRITABLE
993 # endif
994 #else
995 /* Avoid #ifdef:s when we can help it. */
996 #define VALGRIND_DISCARD(x)
997 #define VALGRIND_MALLOCLIKE_BLOCK(w,x,y,z)
998 #define VALGRIND_FREELIKE_BLOCK(x,y)
999 #endif
1001 /* In LTO -fwhole-program build we still want to keep the debug functions available
1002 for debugger. Mark them as used to prevent removal. */
1003 #if (GCC_VERSION > 4000)
1004 #define DEBUG_FUNCTION __attribute__ ((__used__))
1005 #define DEBUG_VARIABLE __attribute__ ((__used__))
1006 #else
1007 #define DEBUG_FUNCTION
1008 #define DEBUG_VARIABLE
1009 #endif
1011 #endif /* ! GCC_SYSTEM_H */