]> git.ipfire.org Git - thirdparty/gcc.git/blame - gcc/system.h
Change copyright header to refer to version 3 of the GNU General Public License and...
[thirdparty/gcc.git] / gcc / system.h
CommitLineData
c5c76735
JL
1/* Get common system includes and various definitions and declarations based
2 on autoconf macros.
9dcd6f09 3 Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2007
d9221e01 4 Free Software Foundation, Inc.
aca69483 5
1322177d 6This file is part of GCC.
1b0c6de6 7
1322177d
LB
8GCC is free software; you can redistribute it and/or modify it under
9the terms of the GNU General Public License as published by the Free
9dcd6f09 10Software Foundation; either version 3, or (at your option) any later
1322177d 11version.
1b0c6de6 12
1322177d
LB
13GCC is distributed in the hope that it will be useful, but WITHOUT ANY
14WARRANTY; without even the implied warranty of MERCHANTABILITY or
15FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
16for more details.
1b0c6de6
JL
17
18You should have received a copy of the GNU General Public License
9dcd6f09
NC
19along with GCC; see the file COPYING3. If not see
20<http://www.gnu.org/licenses/>. */
aca69483 21
c5c76735 22
88657302
RH
23#ifndef GCC_SYSTEM_H
24#define GCC_SYSTEM_H
aca69483 25
2a0621b9 26/* We must include stdarg.h before stdio.h. */
789f983a 27#include <stdarg.h>
789f983a 28
6f81b1ad
RH
29#ifndef va_copy
30# ifdef __va_copy
31# define va_copy(d,s) __va_copy((d),(s))
32# else
33# define va_copy(d,s) ((d) = (s))
34# endif
35#endif
36
d6edb99e
ZW
37#ifdef HAVE_STDDEF_H
38# include <stddef.h>
39#endif
40
aca69483 41#include <stdio.h>
51db713f
KG
42
43/* Define a generic NULL if one hasn't already been defined. */
44#ifndef NULL
45#define NULL 0
46#endif
47
042630ad
KG
48/* Use the unlocked open routines from libiberty. */
49#define fopen(PATH,MODE) fopen_unlocked(PATH,MODE)
50#define fdopen(FILDES,MODE) fdopen_unlocked(FILDES,MODE)
51#define freopen(PATH,MODE,STREAM) freopen_unlocked(PATH,MODE,STREAM)
52
54953b66 53/* The compiler is not a multi-threaded application and therefore we
3b681e9d
ZW
54 do not have to use the locking functions. In fact, using the locking
55 functions can cause the compiler to be significantly slower under
56 I/O bound conditions (such as -g -O0 on very large source files).
9c30c0e7 57
3b681e9d 58 HAVE_DECL_PUTC_UNLOCKED actually indicates whether or not the stdio
f31e826b
KG
59 code is multi-thread safe by default. If it is set to 0, then do
60 not worry about using the _unlocked functions.
0d569849 61
3b681e9d
ZW
62 fputs_unlocked, fwrite_unlocked, and fprintf_unlocked are
63 extensions and need to be prototyped by hand (since we do not
64 define _GNU_SOURCE). */
9c30c0e7 65
3b681e9d
ZW
66#if defined HAVE_DECL_PUTC_UNLOCKED && HAVE_DECL_PUTC_UNLOCKED
67
68# ifdef HAVE_PUTC_UNLOCKED
69# undef putc
70# define putc(C, Stream) putc_unlocked (C, Stream)
71# endif
0d667716
KG
72# ifdef HAVE_PUTCHAR_UNLOCKED
73# undef putchar
74# define putchar(C) putchar_unlocked (C)
75# endif
76# ifdef HAVE_GETC_UNLOCKED
77# undef getc
78# define getc(Stream) getc_unlocked (Stream)
79# endif
80# ifdef HAVE_GETCHAR_UNLOCKED
81# undef getchar
82# define getchar() getchar_unlocked ()
83# endif
3b681e9d
ZW
84# ifdef HAVE_FPUTC_UNLOCKED
85# undef fputc
86# define fputc(C, Stream) fputc_unlocked (C, Stream)
87# endif
88
0d667716
KG
89# ifdef HAVE_CLEARERR_UNLOCKED
90# undef clearerr
91# define clearerr(Stream) clearerr_unlocked (Stream)
92# if defined (HAVE_DECL_CLEARERR_UNLOCKED) && !HAVE_DECL_CLEARERR_UNLOCKED
93extern void clearerr_unlocked (FILE *);
94# endif
95# endif
96# ifdef HAVE_FEOF_UNLOCKED
97# undef feof
98# define feof(Stream) feof_unlocked (Stream)
99# if defined (HAVE_DECL_FEOF_UNLOCKED) && !HAVE_DECL_FEOF_UNLOCKED
100extern int feof_unlocked (FILE *);
101# endif
102# endif
103# ifdef HAVE_FILENO_UNLOCKED
104# undef fileno
105# define fileno(Stream) fileno_unlocked (Stream)
106# if defined (HAVE_DECL_FILENO_UNLOCKED) && !HAVE_DECL_FILENO_UNLOCKED
107extern int fileno_unlocked (FILE *);
108# endif
109# endif
110# ifdef HAVE_FFLUSH_UNLOCKED
111# undef fflush
112# define fflush(Stream) fflush_unlocked (Stream)
113# if defined (HAVE_DECL_FFLUSH_UNLOCKED) && !HAVE_DECL_FFLUSH_UNLOCKED
114extern int fflush_unlocked (FILE *);
115# endif
116# endif
117# ifdef HAVE_FGETC_UNLOCKED
118# undef fgetc
119# define fgetc(Stream) fgetc_unlocked (Stream)
120# if defined (HAVE_DECL_FGETC_UNLOCKED) && !HAVE_DECL_FGETC_UNLOCKED
121extern int fgetc_unlocked (FILE *);
122# endif
123# endif
124# ifdef HAVE_FGETS_UNLOCKED
125# undef fgets
126# define fgets(S, n, Stream) fgets_unlocked (S, n, Stream)
127# if defined (HAVE_DECL_FGETS_UNLOCKED) && !HAVE_DECL_FGETS_UNLOCKED
128extern char *fgets_unlocked (char *, int, FILE *);
129# endif
130# endif
3b681e9d
ZW
131# ifdef HAVE_FPUTS_UNLOCKED
132# undef fputs
133# define fputs(String, Stream) fputs_unlocked (String, Stream)
134# if defined (HAVE_DECL_FPUTS_UNLOCKED) && !HAVE_DECL_FPUTS_UNLOCKED
2a0621b9 135extern int fputs_unlocked (const char *, FILE *);
3b681e9d
ZW
136# endif
137# endif
0d667716
KG
138# ifdef HAVE_FERROR_UNLOCKED
139# undef ferror
140# define ferror(Stream) ferror_unlocked (Stream)
141# if defined (HAVE_DECL_FERROR_UNLOCKED) && !HAVE_DECL_FERROR_UNLOCKED
142extern int ferror_unlocked (FILE *);
143# endif
144# endif
145# ifdef HAVE_FREAD_UNLOCKED
146# undef fread
147# define fread(Ptr, Size, N, Stream) fread_unlocked (Ptr, Size, N, Stream)
148# if defined (HAVE_DECL_FREAD_UNLOCKED) && !HAVE_DECL_FREAD_UNLOCKED
149extern size_t fread_unlocked (void *, size_t, size_t, FILE *);
150# endif
151# endif
3b681e9d
ZW
152# ifdef HAVE_FWRITE_UNLOCKED
153# undef fwrite
154# define fwrite(Ptr, Size, N, Stream) fwrite_unlocked (Ptr, Size, N, Stream)
155# if defined (HAVE_DECL_FWRITE_UNLOCKED) && !HAVE_DECL_FWRITE_UNLOCKED
0d667716 156extern size_t fwrite_unlocked (const void *, size_t, size_t, FILE *);
3b681e9d 157# endif
9c30c0e7 158# endif
3b681e9d
ZW
159# ifdef HAVE_FPRINTF_UNLOCKED
160# undef fprintf
161/* We can't use a function-like macro here because we don't know if
162 we have varargs macros. */
163# define fprintf fprintf_unlocked
164# if defined (HAVE_DECL_FPRINTF_UNLOCKED) && !HAVE_DECL_FPRINTF_UNLOCKED
2a0621b9 165extern int fprintf_unlocked (FILE *, const char *, ...);
3b681e9d
ZW
166# endif
167# endif
168
54953b66
UD
169#endif
170
0d569849 171/* ??? Glibc's fwrite/fread_unlocked macros cause
1c99d804
RH
172 "warning: signed and unsigned type in conditional expression". */
173#undef fread_unlocked
174#undef fwrite_unlocked
175
f6bbde28
ZW
176/* There are an extraordinary number of issues with <ctype.h>.
177 The last straw is that it varies with the locale. Use libiberty's
178 replacement instead. */
179#include <safe-ctype.h>
aca69483 180
aca69483 181#include <sys/types.h>
c5c76735 182
aca69483
KG
183#include <errno.h>
184
6c889b67 185#if !defined (errno) && defined (HAVE_DECL_ERRNO) && !HAVE_DECL_ERRNO
aca69483
KG
186extern int errno;
187#endif
188
87608693
KG
189/* Some of glibc's string inlines cause warnings. Plus we'd rather
190 rely on (and therefore test) GCC's string builtins. */
191#define __NO_STRING_INLINES
192
ccc7d11a 193#ifdef STRING_WITH_STRINGS
aca69483 194# include <string.h>
ccc7d11a 195# include <strings.h>
aca69483 196#else
ccc7d11a
KG
197# ifdef HAVE_STRING_H
198# include <string.h>
199# else
200# ifdef HAVE_STRINGS_H
201# include <strings.h>
202# endif
aca69483
KG
203# endif
204#endif
205
206#ifdef HAVE_STDLIB_H
207# include <stdlib.h>
208#endif
209
eaf4e618
ZW
210/* If we don't have an overriding definition, set SUCCESS_EXIT_CODE and
211 FATAL_EXIT_CODE to EXIT_SUCCESS and EXIT_FAILURE respectively,
212 or 0 and 1 if those macros are not defined. */
213#ifndef SUCCESS_EXIT_CODE
214# ifdef EXIT_SUCCESS
215# define SUCCESS_EXIT_CODE EXIT_SUCCESS
216# else
217# define SUCCESS_EXIT_CODE 0
218# endif
219#endif
220
221#ifndef FATAL_EXIT_CODE
222# ifdef EXIT_FAILURE
223# define FATAL_EXIT_CODE EXIT_FAILURE
224# else
225# define FATAL_EXIT_CODE 1
226# endif
227#endif
228
ddaf3b86
VR
229#define ICE_EXIT_CODE 4
230
aca69483
KG
231#ifdef HAVE_UNISTD_H
232# include <unistd.h>
233#endif
234
235#ifdef HAVE_SYS_PARAM_H
236# include <sys/param.h>
23d1aac4 237/* We use this identifier later and it appears in some vendor param.h's. */
655781b7 238# undef PREFETCH
aca69483
KG
239#endif
240
241#if HAVE_LIMITS_H
242# include <limits.h>
243#endif
244
75e93faa
ZW
245/* Get definitions of HOST_WIDE_INT and HOST_WIDEST_INT. */
246#include "hwint.h"
f80d6fd7 247
5297e085
KG
248/* A macro to determine whether a VALUE lies inclusively within a
249 certain range without evaluating the VALUE more than once. This
250 macro won't warn if the VALUE is unsigned and the LOWER bound is
251 zero, as it would e.g. with "VALUE >= 0 && ...". Note the LOWER
252 bound *is* evaluated twice, and LOWER must not be greater than
253 UPPER. However the bounds themselves can be either positive or
254 negative. */
255#define IN_RANGE(VALUE, LOWER, UPPER) \
93880203 256 ((unsigned HOST_WIDE_INT)((VALUE) - (LOWER)) <= ((UPPER) - (LOWER)))
5297e085 257
f12bc141
ZW
258/* Infrastructure for defining missing _MAX and _MIN macros. Note that
259 macros defined with these cannot be used in #if. */
260
261/* The extra casts work around common compiler bugs. */
262#define INTTYPE_SIGNED(t) (! ((t) 0 < (t) -1))
263/* The outer cast is needed to work around a bug in Cray C 5.0.3.0.
264 It is necessary at least when t == time_t. */
265#define INTTYPE_MINIMUM(t) ((t) (INTTYPE_SIGNED (t) \
266 ? ~ (t) 0 << (sizeof(t) * CHAR_BIT - 1) : (t) 0))
267#define INTTYPE_MAXIMUM(t) ((t) (~ (t) 0 - INTTYPE_MINIMUM (t)))
268
269/* Use that infrastructure to provide a few constants. */
270#ifndef UCHAR_MAX
271# define UCHAR_MAX INTTYPE_MAXIMUM (unsigned char)
272#endif
273
aca69483
KG
274#ifdef TIME_WITH_SYS_TIME
275# include <sys/time.h>
276# include <time.h>
277#else
278# if HAVE_SYS_TIME_H
e572c0c6 279# include <sys/time.h>
aca69483 280# else
e572c0c6
KG
281# ifdef HAVE_TIME_H
282# include <time.h>
283# endif
284# endif
aca69483
KG
285#endif
286
287#ifdef HAVE_FCNTL_H
288# include <fcntl.h>
289#else
e572c0c6
KG
290# ifdef HAVE_SYS_FILE_H
291# include <sys/file.h>
292# endif
aca69483
KG
293#endif
294
295#ifndef SEEK_SET
296# define SEEK_SET 0
297# define SEEK_CUR 1
298# define SEEK_END 2
299#endif
300#ifndef F_OK
301# define F_OK 0
302# define X_OK 1
303# define W_OK 2
304# define R_OK 4
305#endif
e572c0c6
KG
306#ifndef O_RDONLY
307# define O_RDONLY 0
308#endif
309#ifndef O_WRONLY
310# define O_WRONLY 1
311#endif
aca69483 312
36b8337d
KG
313/* Some systems define these in, e.g., param.h. We undefine these names
314 here to avoid the warnings. We prefer to use our definitions since we
315 know they are correct. */
316
317#undef MIN
318#undef MAX
319#define MIN(X,Y) ((X) < (Y) ? (X) : (Y))
320#define MAX(X,Y) ((X) > (Y) ? (X) : (Y))
321
13799af3
MM
322/* Returns the least number N such that N * Y >= X. */
323#define CEIL(x,y) (((x) + (y) - 1) / (y))
324
e9831ca0
KG
325#ifdef HAVE_SYS_WAIT_H
326#include <sys/wait.h>
327#endif
328
329#ifndef WIFSIGNALED
330#define WIFSIGNALED(S) (((S) & 0xff) != 0 && ((S) & 0xff) != 0x7f)
331#endif
332#ifndef WTERMSIG
333#define WTERMSIG(S) ((S) & 0x7f)
334#endif
335#ifndef WIFEXITED
336#define WIFEXITED(S) (((S) & 0xff) == 0)
337#endif
338#ifndef WEXITSTATUS
339#define WEXITSTATUS(S) (((S) & 0xff00) >> 8)
340#endif
8fa213ac
PDM
341#ifndef WSTOPSIG
342#define WSTOPSIG WEXITSTATUS
343#endif
15dda4d3
KG
344#ifndef WCOREDUMP
345#define WCOREDUMP(S) ((S) & WCOREFLG)
346#endif
347#ifndef WCOREFLG
348#define WCOREFLG 0200
349#endif
e9831ca0 350
f31e826b
KG
351/* The HAVE_DECL_* macros are three-state, undefined, 0 or 1. If they
352 are defined to 0 then we must provide the relevant declaration
353 here. These checks will be in the undefined state while configure
354 is running so be careful to test "defined (HAVE_DECL_*)". */
aca69483 355
f31e826b 356#if defined (HAVE_DECL_ATOF) && !HAVE_DECL_ATOF
2a0621b9 357extern double atof (const char *);
8f81384f
KG
358#endif
359
f31e826b 360#if defined (HAVE_DECL_ATOL) && !HAVE_DECL_ATOL
2a0621b9 361extern long atol (const char *);
8f81384f
KG
362#endif
363
f31e826b 364#if defined (HAVE_DECL_FREE) && !HAVE_DECL_FREE
2a0621b9 365extern void free (void *);
aca69483
KG
366#endif
367
f31e826b 368#if defined (HAVE_DECL_GETCWD) && !HAVE_DECL_GETCWD
2a0621b9 369extern char *getcwd (char *, size_t);
6cd5dccd
KG
370#endif
371
f31e826b 372#if defined (HAVE_DECL_GETENV) && !HAVE_DECL_GETENV
2a0621b9 373extern char *getenv (const char *);
79e11844
KG
374#endif
375
ebb13e7e 376#if defined (HAVE_DECL_GETOPT) && !HAVE_DECL_GETOPT
2a0621b9 377extern int getopt (int, char * const *, const char *);
ebb13e7e
RK
378#endif
379
f6260033
EB
380#if defined (HAVE_DECL_GETPAGESIZE) && !HAVE_DECL_GETPAGESIZE
381extern int getpagesize (void);
6a257778
AL
382#endif
383
f31e826b 384#if defined (HAVE_DECL_GETWD) && !HAVE_DECL_GETWD
2a0621b9 385extern char *getwd (char *);
6cd5dccd
KG
386#endif
387
f31e826b 388#if defined (HAVE_DECL_SBRK) && !HAVE_DECL_SBRK
2a0621b9 389extern void *sbrk (int);
8f81384f
KG
390#endif
391
f31e826b 392#if defined (HAVE_DECL_STRSTR) && !HAVE_DECL_STRSTR
2a0621b9 393extern char *strstr (const char *, const char *);
d3d5cc97
JL
394#endif
395
c5c76735
JL
396#ifdef HAVE_MALLOC_H
397#include <malloc.h>
398#endif
399
f31e826b 400#if defined (HAVE_DECL_MALLOC) && !HAVE_DECL_MALLOC
2a0621b9 401extern void *malloc (size_t);
c5c76735
JL
402#endif
403
f31e826b 404#if defined (HAVE_DECL_CALLOC) && !HAVE_DECL_CALLOC
2a0621b9 405extern void *calloc (size_t, size_t);
c5c76735
JL
406#endif
407
f31e826b 408#if defined (HAVE_DECL_REALLOC) && !HAVE_DECL_REALLOC
2a0621b9 409extern void *realloc (void *, size_t);
c5c76735
JL
410#endif
411
759af044 412/* If the system doesn't provide strsignal, we get it defined in
2ba84f36 413 libiberty but no declaration is supplied. */
0a18ddf9
AS
414#if !defined (HAVE_STRSIGNAL) \
415 || (defined (HAVE_DECL_STRSIGNAL) && !HAVE_DECL_STRSIGNAL)
759af044 416# ifndef strsignal
2a0621b9 417extern const char *strsignal (int);
007e8d2a 418# endif
759af044 419#endif
007e8d2a 420
d2cabf16 421#ifdef HAVE_GETRLIMIT
f31e826b 422# if defined (HAVE_DECL_GETRLIMIT) && !HAVE_DECL_GETRLIMIT
d2cabf16 423# ifndef getrlimit
d4d4ae5f 424struct rlimit;
2a0621b9 425extern int getrlimit (int, struct rlimit *);
d2cabf16
KG
426# endif
427# endif
428#endif
429
430#ifdef HAVE_SETRLIMIT
f31e826b 431# if defined (HAVE_DECL_SETRLIMIT) && !HAVE_DECL_SETRLIMIT
d2cabf16 432# ifndef setrlimit
d4d4ae5f 433struct rlimit;
2a0621b9 434extern int setrlimit (int, const struct rlimit *);
d2cabf16
KG
435# endif
436# endif
437#endif
438
f31e826b 439#if defined (HAVE_DECL_ABORT) && !HAVE_DECL_ABORT
2a0621b9 440extern void abort (void);
2a611d21 441#endif
d4ba0ead 442
236ce4b2
ZW
443#if defined (HAVE_DECL_SNPRINTF) && !HAVE_DECL_SNPRINTF
444extern int snprintf (char *, size_t, const char *, ...);
445#endif
446
367e8319
EB
447#if defined (HAVE_DECL_VSNPRINTF) && !HAVE_DECL_VSNPRINTF
448extern int vsnprintf(char *, size_t, const char *, va_list);
449#endif
450
61d0346d 451/* 1 if we have C99 designated initializers. */
18922061 452#if !defined(HAVE_DESIGNATED_INITIALIZERS)
61d0346d
NB
453#define HAVE_DESIGNATED_INITIALIZERS \
454 ((GCC_VERSION >= 2007) || (__STDC_VERSION__ >= 199901L))
18922061 455#endif
61d0346d 456
a05e22b8
RH
457#if HAVE_SYS_STAT_H
458# include <sys/stat.h>
459#endif
9855b854
MN
460
461/* Test if something is a normal file. */
462#ifndef S_ISREG
463#define S_ISREG(m) (((m) & S_IFMT) == S_IFREG)
464#endif
465
466/* Test if something is a directory. */
467#ifndef S_ISDIR
468#define S_ISDIR(m) (((m) & S_IFMT) == S_IFDIR)
469#endif
470
6458033d
ZW
471/* Test if something is a character special file. */
472#ifndef S_ISCHR
473#define S_ISCHR(m) (((m) & S_IFMT) == S_IFCHR)
474#endif
475
be3dad6f
PDM
476/* Test if something is a block special file. */
477#ifndef S_ISBLK
478#define S_ISBLK(m) (((m) & S_IFMT) == S_IFBLK)
479#endif
480
6458033d
ZW
481/* Test if something is a socket. */
482#ifndef S_ISSOCK
483# ifdef S_IFSOCK
484# define S_ISSOCK(m) (((m) & S_IFMT) == S_IFSOCK)
485# else
486# define S_ISSOCK(m) 0
487# endif
488#endif
489
490/* Test if something is a FIFO. */
491#ifndef S_ISFIFO
492# ifdef S_IFIFO
493# define S_ISFIFO(m) (((m) & S_IFMT) == S_IFIFO)
494# else
495# define S_ISFIFO(m) 0
496# endif
497#endif
498
f3692274
ME
499/* Define well known filenos if the system does not define them. */
500#ifndef STDIN_FILENO
501# define STDIN_FILENO 0
502#endif
503#ifndef STDOUT_FILENO
504# define STDOUT_FILENO 1
505#endif
924d8a7c 506#ifndef STDERR_FILENO
f3692274
ME
507# define STDERR_FILENO 2
508#endif
509
2ba84f36 510/* Some systems have mkdir that takes a single argument. */
75923b2f
MK
511#ifdef MKDIR_TAKES_ONE_ARG
512# define mkdir(a,b) mkdir(a)
513#endif
514
d5b6516d
MK
515/* By default, colon separates directories in a path. */
516#ifndef PATH_SEPARATOR
517#define PATH_SEPARATOR ':'
518#endif
519
3dce1408
ZW
520/* Filename handling macros. */
521#include "filenames.h"
522
523/* These should be phased out in favor of IS_DIR_SEPARATOR, where possible. */
d5b6516d 524#ifndef DIR_SEPARATOR
3dce1408
ZW
525# define DIR_SEPARATOR '/'
526# ifdef HAVE_DOS_BASED_FILE_SYSTEM
527# define DIR_SEPARATOR_2 '\\'
528# endif
c5c0b3d9
RK
529#endif
530
2ba84f36 531/* Get libiberty declarations. */
2778b98d
KG
532#include "libiberty.h"
533
49009afd
JL
534/* Provide a default for the HOST_BIT_BUCKET.
535 This suffices for POSIX-like hosts. */
536
537#ifndef HOST_BIT_BUCKET
538#define HOST_BIT_BUCKET "/dev/null"
539#endif
540
1c62e7b2 541/* Be conservative and only use enum bitfields with GCC.
9612ab65 542 FIXME: provide a complete autoconf test for buggy enum bitfields. */
c149cc37 543
9612ab65 544#if (GCC_VERSION > 2000)
a3bf324c 545#define ENUM_BITFIELD(TYPE) __extension__ enum TYPE
c149cc37
RL
546#else
547#define ENUM_BITFIELD(TYPE) unsigned int
1c62e7b2
KG
548#endif
549
e0125cf3 550#ifndef offsetof
cf403648 551#define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *) 0)->MEMBER)
e0125cf3 552#endif
c149cc37 553
fbfc1192
ZW
554/* Various error reporting routines want to use __FUNCTION__. */
555#if (GCC_VERSION < 2007)
791ef777 556#ifndef __FUNCTION__
fbfc1192 557#define __FUNCTION__ "?"
791ef777 558#endif /* ! __FUNCTION__ */
fbfc1192
ZW
559#endif
560
2c3fcba6
ZW
561/* __builtin_expect(A, B) evaluates to A, but notifies the compiler that
562 the most likely value of A is B. This feature was added at some point
563 between 2.95 and 3.0. Let's use 3.0 as the lower bound for now. */
564#if (GCC_VERSION < 3000)
565#define __builtin_expect(a, b) (a)
566#endif
567
b3d1f5b4
NS
568/* Redefine abort to report an internal error w/o coredump, and
569 reporting the location of the error in the source file. */
570extern void fancy_abort (const char *, int, const char *) ATTRIBUTE_NORETURN;
571#define abort() fancy_abort (__FILE__, __LINE__, __FUNCTION__)
572
06c37c96
NS
573/* Use gcc_assert(EXPR) to test invariants. */
574#if ENABLE_ASSERT_CHECKING
575#define gcc_assert(EXPR) \
2c46a62f 576 ((void)(!(EXPR) ? fancy_abort (__FILE__, __LINE__, __FUNCTION__), 0 : 0))
06c37c96 577#else
2c46a62f
NS
578/* Include EXPR, so that unused variable warnings do not occur. */
579#define gcc_assert(EXPR) ((void)(0 && (EXPR)))
06c37c96
NS
580#endif
581
582/* Use gcc_unreachable() to mark unreachable locations (like an
583 unreachable default case of a switch. Do not use gcc_assert(0). */
584#define gcc_unreachable() (fancy_abort (__FILE__, __LINE__, __FUNCTION__))
585
2fac9c01
ZW
586/* Provide a fake boolean type. We make no attempt to use the
587 C99 _Bool, as it may not be available in the bootstrap compiler,
f676971a 588 and even if it is, it is liable to be buggy.
2fac9c01
ZW
589 This must be after all inclusion of system headers, as some of
590 them will mess us up. */
ca79179c 591
d6edb99e
ZW
592#undef TRUE
593#undef FALSE
594
ca79179c
BI
595#ifdef __cplusplus
596 /* Obsolete. */
597# define TRUE true
598# define FALSE false
599#else /* !__cplusplus */
600# undef bool
601# undef true
602# undef false
603
604# define bool unsigned char
605# define true 1
606# define false 0
607
608 /* Obsolete. */
609# define TRUE true
610# define FALSE false
611#endif /* !__cplusplus */
d6edb99e 612
2fac9c01
ZW
613/* Some compilers do not allow the use of unsigned char in bitfields. */
614#define BOOL_BITFIELD unsigned int
615
f4ce9d90
KG
616/* As the last action in this file, we poison the identifiers that
617 shouldn't be used. Note, luckily gcc-3.0's token-based integrated
618 preprocessor won't trip on poisoned identifiers that arrive from
619 the expansion of macros. E.g. #define strrchr rindex, won't error
620 if rindex is poisoned after this directive is issued and later on
621 strrchr is called.
622
623 Note: We define bypass macros for the few cases where we really
624 want to use the libc memory allocation routines. Otherwise we
625 insist you use the "x" versions from libiberty. */
626
627#define really_call_malloc malloc
628#define really_call_calloc calloc
629#define really_call_realloc realloc
630
f92ed976 631#if defined(FLEX_SCANNER) || defined(YYBISON) || defined(YYBYACC)
4977bab6 632/* Flex and bison use malloc and realloc. Yuk. Note that this means
32dd366d 633 really_call_* cannot be used in a .l or .y file. */
4977bab6
ZW
634#define malloc xmalloc
635#define realloc xrealloc
636#endif
637
f4ce9d90
KG
638#if (GCC_VERSION >= 3000)
639
77b84559
KG
640/* Note autoconf checks for prototype declarations and includes
641 system.h while doing so. Only poison these tokens if actually
642 compiling gcc, so that the autoconf declaration tests for malloc
643 etc don't spuriously fail. */
644#ifdef IN_GCC
8a0e5115
KG
645#undef calloc
646#undef strdup
e2500fed
GK
647 #pragma GCC poison calloc strdup
648
4977bab6 649#if !defined(FLEX_SCANNER) && !defined(YYBISON)
e2500fed
GK
650#undef malloc
651#undef realloc
652 #pragma GCC poison malloc realloc
653#endif
41441dc7
NB
654
655/* Old target macros that have moved to the target hooks structure. */
656 #pragma GCC poison ASM_OPEN_PAREN ASM_CLOSE_PAREN \
657 FUNCTION_PROLOGUE FUNCTION_EPILOGUE \
658 FUNCTION_END_PROLOGUE FUNCTION_BEGIN_EPILOGUE \
659 DECL_MACHINE_ATTRIBUTES COMP_TYPE_ATTRIBUTES INSERT_ATTRIBUTES \
660 VALID_MACHINE_DECL_ATTRIBUTE VALID_MACHINE_TYPE_ATTRIBUTE \
661 SET_DEFAULT_TYPE_ATTRIBUTES SET_DEFAULT_DECL_ATTRIBUTES \
662 MERGE_MACHINE_TYPE_ATTRIBUTES MERGE_MACHINE_DECL_ATTRIBUTES \
aa6ad1a6 663 MD_INIT_BUILTINS MD_EXPAND_BUILTIN ASM_OUTPUT_CONSTRUCTOR \
44a147ad 664 ASM_OUTPUT_DESTRUCTOR SIGNED_CHAR_SPEC MAX_CHAR_TYPE_SIZE \
fb49053f 665 WCHAR_UNSIGNED UNIQUE_SECTION SELECT_SECTION SELECT_RTX_SECTION \
3961e8fe 666 ENCODE_SECTION_INFO STRIP_NAME_ENCODING ASM_GLOBALIZE_LABEL \
dcefdf67 667 ASM_OUTPUT_MI_THUNK CONST_COSTS RTX_COSTS DEFAULT_RTX_COSTS \
75c20980 668 ADDRESS_COST MACHINE_DEPENDENT_REORG ASM_FILE_START ASM_FILE_END \
30ee56e1
ZW
669 ASM_SIMPLIFY_DWARF_ADDR INIT_TARGET_OPTABS INIT_SUBTARGET_OPTABS \
670 INIT_GOFAST_OPTABS MULSI3_LIBCALL MULDI3_LIBCALL DIVSI3_LIBCALL \
671 DIVDI3_LIBCALL UDIVSI3_LIBCALL UDIVDI3_LIBCALL MODSI3_LIBCALL \
4ac8340c 672 MODDI3_LIBCALL UMODSI3_LIBCALL UMODDI3_LIBCALL BUILD_VA_LIST_TYPE \
510d1e80 673 PRETEND_OUTGOING_VARARGS_NAMED STRUCT_VALUE_INCOMING_REGNUM \
b602b7b6 674 ASM_OUTPUT_SECTION_NAME PROMOTE_FUNCTION_ARGS \
fefcb65c
KH
675 STRUCT_VALUE_INCOMING STRICT_ARGUMENT_NAMING \
676 PROMOTE_FUNCTION_RETURN PROMOTE_PROTOTYPES STRUCT_VALUE_REGNUM \
221ee7c9 677 SETUP_INCOMING_VARARGS EXPAND_BUILTIN_SAVEREGS \
84b8b0e0 678 DEFAULT_SHORT_ENUMS SPLIT_COMPLEX_ARGS MD_ASM_CLOBBERS \
fe984136 679 HANDLE_PRAGMA_REDEFINE_EXTNAME HANDLE_PRAGMA_EXTERN_PREFIX \
f676971a 680 MUST_PASS_IN_STACK FUNCTION_ARG_PASS_BY_REFERENCE \
78a52f11 681 VECTOR_MODE_SUPPORTED_P TARGET_SUPPORTS_HIDDEN \
b48f503c
KK
682 FUNCTION_ARG_PARTIAL_NREGS ASM_OUTPUT_DWARF_DTPREL \
683 ALLOCATE_INITIAL_VALUE
aa6ad1a6 684
e2500fed 685/* Other obsolete target macros, or macros that used to be in target
006946e4
JM
686 headers and were not used, and may be obsolete or may never have
687 been used. */
c08f71aa 688 #pragma GCC poison INT_ASM_OP ASM_OUTPUT_EH_REGION_BEG CPP_PREDEFINES \
6a6c0154 689 ASM_OUTPUT_EH_REGION_END ASM_OUTPUT_LABELREF_AS_INT SMALL_STACK \
ed722f66 690 DOESNT_NEED_UNWINDER EH_TABLE_LOOKUP OBJC_SELECTORS_WITHOUT_LABELS \
16c484c7 691 OMIT_EH_TABLE EASY_DIV_EXPR IMPLICIT_FIX_EXPR \
006946e4 692 LONGJMP_RESTORE_FROM_STACK MAX_INT_TYPE_SIZE ASM_IDENTIFY_GCC \
c99d986a 693 STDC_VALUE TRAMPOLINE_ALIGN ASM_IDENTIFY_GCC_AFTER_SOURCE \
f458d1d5 694 SLOW_ZERO_EXTEND SUBREG_REGNO_OFFSET DWARF_LINE_MIN_INSTR_LENGTH \
a11eba95 695 TRADITIONAL_RETURN_FLOAT NO_BUILTIN_SIZE_TYPE \
fc881338
RH
696 NO_BUILTIN_PTRDIFF_TYPE NO_BUILTIN_WCHAR_TYPE NO_BUILTIN_WINT_TYPE \
697 BLOCK_PROFILER BLOCK_PROFILER_CODE FUNCTION_BLOCK_PROFILER \
698 FUNCTION_BLOCK_PROFILER_EXIT MACHINE_STATE_SAVE \
68d5a1cd
KC
699 MACHINE_STATE_RESTORE SCCS_DIRECTIVE SECTION_ASM_OP BYTEORDER \
700 ASM_OUTPUT_DEFINE_LABEL_DIFFERENCE_SYMBOL HOST_WORDS_BIG_ENDIAN \
80eaf415 701 OBJC_PROLOGUE ALLOCATE_TRAMPOLINE HANDLE_PRAGMA ROUND_TYPE_SIZE \
f691dc3b
AJ
702 ROUND_TYPE_SIZE_UNIT CONST_SECTION_ASM_OP CRT_GET_RFIB_TEXT \
703 DBX_LBRAC_FIRST DBX_OUTPUT_ENUM DBX_OUTPUT_SOURCE_FILENAME \
704 DBX_WORKING_DIRECTORY INSN_CACHE_DEPTH INSN_CACHE_SIZE \
5145a02e 705 INSN_CACHE_LINE_WIDTH INIT_SECTION_PREAMBLE NEED_ATEXIT ON_EXIT \
edf11bda 706 EXIT_BODY OBJECT_FORMAT_ROSE MULTIBYTE_CHARS MAP_CHARACTER \
ba029213 707 LIBGCC_NEEDS_DOUBLE FINAL_PRESCAN_LABEL DEFAULT_CALLER_SAVES \
c6a515f4 708 LOAD_ARGS_REVERSED MAX_INTEGER_COMPUTATION_MODE \
b816f339 709 CONVERT_HARD_REGISTER_TO_SSA_P ASM_OUTPUT_MAIN_SOURCE_FILENAME \
616f6d84 710 FIRST_INSN_ADDRESS TEXT_SECTION SHARED_BSS_SECTION_ASM_OP \
16201823 711 PROMOTED_MODE EXPAND_BUILTIN_VA_END \
9b2b3375 712 LINKER_DOES_NOT_WORK_WITH_DWARF2 FUNCTION_ARG_KEEP_AS_REFERENCE \
1197924d 713 GIV_SORT_CRITERION MAX_LONG_TYPE_SIZE MAX_LONG_DOUBLE_TYPE_SIZE \
9e9126f3 714 MAX_WCHAR_TYPE_SIZE SHARED_SECTION_ASM_OP INTEGRATE_THRESHOLD \
c1a41c2f 715 FINAL_REG_PARM_STACK_SPACE MAYBE_REG_PARM_STACK_SPACE \
fdf89bf5 716 TRADITIONAL_PIPELINE_INTERFACE DFA_PIPELINE_INTERFACE \
67dfe110 717 DBX_OUTPUT_STANDARD_TYPES BUILTIN_SETJMP_FRAME_VALUE \
082a099c 718 SUNOS4_SHARED_LIBRARIES PROMOTE_FOR_CALL_ONLY \
bb2d400f 719 SPACE_AFTER_L_OPTION NO_RECURSIVE_FUNCTION_CSE \
b89dc911 720 DEFAULT_MAIN_RETURN TARGET_MEM_FUNCTIONS EXPAND_BUILTIN_VA_ARG \
ac746f1d
ZW
721 COLLECT_PARSE_FLAG DWARF2_GENERATE_TEXT_SECTION_LABEL WINNING_GDB \
722 ASM_OUTPUT_FILENAME ASM_OUTPUT_SOURCE_LINE FILE_NAME_JOINER \
723 GDB_INV_REF_REGPARM_STABS_LETTER DBX_MEMPARM_STABS_LETTER \
93a27b7b 724 PUT_SDB_SRC_FILE STABS_GCC_MARKER DBX_OUTPUT_FUNCTION_END \
6e14af16 725 DBX_OUTPUT_GCC_MARKER DBX_FINISH_SYMBOL SDB_GENERATE_FAKE \
6be85b25 726 NON_SAVING_SETJMP TARGET_LATE_RTL_PROLOGUE_EPILOGUE \
c5ff069d 727 CASE_DROPS_THROUGH TARGET_BELL TARGET_BS TARGET_CR TARGET_DIGIT0 \
57642751 728 TARGET_ESC TARGET_FF TARGET_NEWLINE TARGET_TAB TARGET_VT \
bacf5b96 729 LINK_LIBGCC_SPECIAL DONT_ACCESS_GBLS_AFTER_EPILOGUE \
c2acaf06 730 TARGET_OPTIONS TARGET_SWITCHES EXTRA_CC_MODES FINALIZE_PIC \
d6b5193b
RS
731 PREDICATE_CODES SPECIAL_MODE_PREDICATES HOST_PTR_PRINTF \
732 EXTRA_SECTIONS EXTRA_SECTION_FUNCTIONS READONLY_DATA_SECTION \
00dcee0c 733 TARGET_ASM_EXCEPTION_SECTION TARGET_ASM_EH_FRAME_SECTION \
f5e605e5 734 SMALL_ARG_MAX ASM_OUTPUT_SHARED_BSS ASM_OUTPUT_SHARED_COMMON \
67e47f30
SE
735 ASM_OUTPUT_SHARED_LOCAL UNALIGNED_WORD_ASM_OP \
736 ASM_MAKE_LABEL_LINKONCE
aa6ad1a6 737
e2500fed
GK
738/* Hooks that are no longer used. */
739 #pragma GCC poison LANG_HOOKS_FUNCTION_MARK LANG_HOOKS_FUNCTION_FREE \
9dcf6e73
JM
740 LANG_HOOKS_MARK_TREE LANG_HOOKS_INSERT_DEFAULT_ATTRIBUTES \
741 LANG_HOOKS_TREE_INLINING_ESTIMATE_NUM_INSNS \
742 LANG_HOOKS_PUSHLEVEL LANG_HOOKS_SET_BLOCK \
743 LANG_HOOKS_MAYBE_BUILD_CLEANUP LANG_HOOKS_UPDATE_DECL_AFTER_SAVING \
d101034c 744 LANG_HOOKS_POPLEVEL LANG_HOOKS_TRUTHVALUE_CONVERSION
e2500fed 745
b0c231bb
KG
746/* Libiberty macros that are no longer used in GCC. */
747#undef ANSI_PROTOTYPES
748#undef PTR_CONST
749#undef LONG_DOUBLE
750#undef VPARAMS
751#undef VA_OPEN
752#undef VA_FIXEDARG
753#undef VA_CLOSE
754#undef VA_START
627aa08a
KG
755 #pragma GCC poison ANSI_PROTOTYPES PTR_CONST LONG_DOUBLE VPARAMS VA_OPEN \
756 VA_FIXEDARG VA_CLOSE VA_START
77b84559 757#endif /* IN_GCC */
f4ce9d90 758
8e944909
KG
759/* Note: not all uses of the `index' token (e.g. variable names and
760 structure members) have been eliminated. */
761#undef bcopy
8a0e5115
KG
762#undef bzero
763#undef bcmp
764#undef rindex
8e944909 765 #pragma GCC poison bcopy bzero bcmp rindex
f4ce9d90
KG
766
767#endif /* GCC >= 3.0 */
768
88657302 769#endif /* ! GCC_SYSTEM_H */