1 /* Get common system includes and various definitions and declarations based
3 Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003 Free Software Foundation, Inc.
5 This file is part of GCC.
7 GCC is free software; you can redistribute it and/or modify it under
8 the terms of the GNU General Public License as published by the Free
9 Software Foundation; either version 2, or (at your option) any later
12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
17 You should have received a copy of the GNU General Public License
18 along with GCC; see the file COPYING. If not, write to the Free
19 Software Foundation, 59 Temple Place - Suite 330, Boston, MA
26 /* We must include stdarg.h/varargs.h before stdio.h. */
27 #ifdef ANSI_PROTOTYPES
35 # define va_copy(d,s) __va_copy((d),(s))
37 # define va_copy(d,s) ((d) = (s))
47 /* Define a generic NULL if one hasn't already been defined. */
52 /* The compiler is not a multi-threaded application and therefore we
53 do not have to use the locking functions. In fact, using the locking
54 functions can cause the compiler to be significantly slower under
55 I/O bound conditions (such as -g -O0 on very large source files).
57 HAVE_DECL_PUTC_UNLOCKED actually indicates whether or not the stdio
58 code is multi-thread safe by default. If it is set to 0, then do
59 not worry about using the _unlocked functions.
61 fputs_unlocked, fwrite_unlocked, and fprintf_unlocked are
62 extensions and need to be prototyped by hand (since we do not
63 define _GNU_SOURCE). */
65 #if defined HAVE_DECL_PUTC_UNLOCKED && HAVE_DECL_PUTC_UNLOCKED
67 # ifdef HAVE_PUTC_UNLOCKED
69 # define putc(C, Stream) putc_unlocked (C, Stream)
71 # ifdef HAVE_FPUTC_UNLOCKED
73 # define fputc(C, Stream) fputc_unlocked (C, Stream)
76 # ifdef HAVE_FPUTS_UNLOCKED
78 # define fputs(String, Stream) fputs_unlocked (String, Stream)
79 # if defined (HAVE_DECL_FPUTS_UNLOCKED) && !HAVE_DECL_FPUTS_UNLOCKED
80 extern int fputs_unlocked PARAMS ((const char *, FILE *));
83 # ifdef HAVE_FWRITE_UNLOCKED
85 # define fwrite(Ptr, Size, N, Stream) fwrite_unlocked (Ptr, Size, N, Stream)
86 # if defined (HAVE_DECL_FWRITE_UNLOCKED) && !HAVE_DECL_FWRITE_UNLOCKED
87 extern int fwrite_unlocked PARAMS ((const PTR, size_t, size_t, FILE *));
90 # ifdef HAVE_FPRINTF_UNLOCKED
92 /* We can't use a function-like macro here because we don't know if
93 we have varargs macros. */
94 # define fprintf fprintf_unlocked
95 # if defined (HAVE_DECL_FPRINTF_UNLOCKED) && !HAVE_DECL_FPRINTF_UNLOCKED
96 extern int fprintf_unlocked PARAMS ((FILE *, const char *, ...));
102 /* There are an extraordinary number of issues with <ctype.h>.
103 The last straw is that it varies with the locale. Use libiberty's
104 replacement instead. */
105 #include <safe-ctype.h>
107 #include <sys/types.h>
111 #if !defined (errno) && defined (HAVE_DECL_ERRNO) && !HAVE_DECL_ERRNO
115 /* Some of glibc's string inlines cause warnings. Plus we'd rather
116 rely on (and therefore test) GCC's string builtins. */
117 #define __NO_STRING_INLINES
119 #ifdef STRING_WITH_STRINGS
121 # include <strings.h>
123 # ifdef HAVE_STRING_H
126 # ifdef HAVE_STRINGS_H
127 # include <strings.h>
136 /* If we don't have an overriding definition, set SUCCESS_EXIT_CODE and
137 FATAL_EXIT_CODE to EXIT_SUCCESS and EXIT_FAILURE respectively,
138 or 0 and 1 if those macros are not defined. */
139 #ifndef SUCCESS_EXIT_CODE
141 # define SUCCESS_EXIT_CODE EXIT_SUCCESS
143 # define SUCCESS_EXIT_CODE 0
147 #ifndef FATAL_EXIT_CODE
149 # define FATAL_EXIT_CODE EXIT_FAILURE
151 # define FATAL_EXIT_CODE 1
159 #ifdef HAVE_SYS_PARAM_H
160 # include <sys/param.h>
161 /* We use this identifier later and it appears in some vendor param.h's. */
169 /* Get definitions of HOST_WIDE_INT and HOST_WIDEST_INT. */
172 /* A macro to determine whether a VALUE lies inclusively within a
173 certain range without evaluating the VALUE more than once. This
174 macro won't warn if the VALUE is unsigned and the LOWER bound is
175 zero, as it would e.g. with "VALUE >= 0 && ...". Note the LOWER
176 bound *is* evaluated twice, and LOWER must not be greater than
177 UPPER. However the bounds themselves can be either positive or
179 #define IN_RANGE(VALUE, LOWER, UPPER) \
180 ((unsigned HOST_WIDE_INT) ((VALUE) - (LOWER)) <= ((UPPER) - (LOWER)))
182 /* Infrastructure for defining missing _MAX and _MIN macros. Note that
183 macros defined with these cannot be used in #if. */
185 /* The extra casts work around common compiler bugs. */
186 #define INTTYPE_SIGNED(t) (! ((t) 0 < (t) -1))
187 /* The outer cast is needed to work around a bug in Cray C 5.0.3.0.
188 It is necessary at least when t == time_t. */
189 #define INTTYPE_MINIMUM(t) ((t) (INTTYPE_SIGNED (t) \
190 ? ~ (t) 0 << (sizeof(t) * CHAR_BIT - 1) : (t) 0))
191 #define INTTYPE_MAXIMUM(t) ((t) (~ (t) 0 - INTTYPE_MINIMUM (t)))
193 /* Use that infrastructure to provide a few constants. */
195 # define UCHAR_MAX INTTYPE_MAXIMUM (unsigned char)
198 #ifdef TIME_WITH_SYS_TIME
199 # include <sys/time.h>
203 # include <sys/time.h>
214 # ifdef HAVE_SYS_FILE_H
215 # include <sys/file.h>
237 /* Some systems define these in, e.g., param.h. We undefine these names
238 here to avoid the warnings. We prefer to use our definitions since we
239 know they are correct. */
243 #define MIN(X,Y) ((X) < (Y) ? (X) : (Y))
244 #define MAX(X,Y) ((X) > (Y) ? (X) : (Y))
246 /* Returns the least number N such that N * Y >= X. */
247 #define CEIL(x,y) (((x) + (y) - 1) / (y))
249 #ifdef HAVE_SYS_WAIT_H
250 #include <sys/wait.h>
254 #define WIFSIGNALED(S) (((S) & 0xff) != 0 && ((S) & 0xff) != 0x7f)
257 #define WTERMSIG(S) ((S) & 0x7f)
260 #define WIFEXITED(S) (((S) & 0xff) == 0)
263 #define WEXITSTATUS(S) (((S) & 0xff00) >> 8)
266 #define WSTOPSIG WEXITSTATUS
269 /* The HAVE_DECL_* macros are three-state, undefined, 0 or 1. If they
270 are defined to 0 then we must provide the relevant declaration
271 here. These checks will be in the undefined state while configure
272 is running so be careful to test "defined (HAVE_DECL_*)". */
274 #if defined (HAVE_DECL_ATOF) && !HAVE_DECL_ATOF
275 extern double atof PARAMS ((const char *));
278 #if defined (HAVE_DECL_ATOL) && !HAVE_DECL_ATOL
279 extern long atol PARAMS ((const char *));
282 #if defined (HAVE_DECL_FREE) && !HAVE_DECL_FREE
283 extern void free PARAMS ((PTR));
286 #if defined (HAVE_DECL_GETCWD) && !HAVE_DECL_GETCWD
287 extern char *getcwd PARAMS ((char *, size_t));
290 #if defined (HAVE_DECL_GETENV) && !HAVE_DECL_GETENV
291 extern char *getenv PARAMS ((const char *));
294 #if defined (HAVE_DECL_GETOPT) && !HAVE_DECL_GETOPT
295 extern int getopt PARAMS ((int, char * const *, const char *));
298 #if defined (HAVE_DECL_GETWD) && !HAVE_DECL_GETWD
299 extern char *getwd PARAMS ((char *));
302 #if defined (HAVE_DECL_SBRK) && !HAVE_DECL_SBRK
303 extern PTR sbrk PARAMS ((int));
306 #if defined (HAVE_DECL_STRSTR) && !HAVE_DECL_STRSTR
307 extern char *strstr PARAMS ((const char *, const char *));
314 #if defined (HAVE_DECL_MALLOC) && !HAVE_DECL_MALLOC
315 extern PTR malloc PARAMS ((size_t));
318 #if defined (HAVE_DECL_CALLOC) && !HAVE_DECL_CALLOC
319 extern PTR calloc PARAMS ((size_t, size_t));
322 #if defined (HAVE_DECL_REALLOC) && !HAVE_DECL_REALLOC
323 extern PTR realloc PARAMS ((PTR, size_t));
326 /* If the system doesn't provide strsignal, we get it defined in
327 libiberty but no declaration is supplied. */
328 #if !defined (HAVE_STRSIGNAL) \
329 || (defined (HAVE_DECL_STRSIGNAL) && !HAVE_DECL_STRSIGNAL)
331 extern const char *strsignal PARAMS ((int));
335 #ifdef HAVE_GETRLIMIT
336 # if defined (HAVE_DECL_GETRLIMIT) && !HAVE_DECL_GETRLIMIT
338 # ifdef ANSI_PROTOTYPES
341 extern int getrlimit PARAMS ((int, struct rlimit *));
346 #ifdef HAVE_SETRLIMIT
347 # if defined (HAVE_DECL_SETRLIMIT) && !HAVE_DECL_SETRLIMIT
349 # ifdef ANSI_PROTOTYPES
352 extern int setrlimit PARAMS ((int, const struct rlimit *));
357 /* HAVE_VOLATILE only refers to the stage1 compiler. We also check
358 __STDC__ and assume gcc sets it and has volatile in stage >=2. */
359 #if !defined(HAVE_VOLATILE) && !defined(__STDC__) && !defined(volatile)
363 #if defined (HAVE_DECL_ABORT) && !HAVE_DECL_ABORT
364 extern void abort PARAMS ((void));
367 /* 1 if we have C99 designated initializers. */
368 #if !defined(HAVE_DESIGNATED_INITIALIZERS)
369 #define HAVE_DESIGNATED_INITIALIZERS \
370 ((GCC_VERSION >= 2007) || (__STDC_VERSION__ >= 199901L))
373 /* 1 if we have _Bool. */
375 # define HAVE__BOOL \
376 ((GCC_VERSION >= 3000) || (__STDC_VERSION__ >= 199901L))
381 # include <sys/stat.h>
384 /* Test if something is a normal file. */
386 #define S_ISREG(m) (((m) & S_IFMT) == S_IFREG)
389 /* Test if something is a directory. */
391 #define S_ISDIR(m) (((m) & S_IFMT) == S_IFDIR)
394 /* Test if something is a character special file. */
396 #define S_ISCHR(m) (((m) & S_IFMT) == S_IFCHR)
399 /* Test if something is a block special file. */
401 #define S_ISBLK(m) (((m) & S_IFMT) == S_IFBLK)
404 /* Test if something is a socket. */
407 # define S_ISSOCK(m) (((m) & S_IFMT) == S_IFSOCK)
409 # define S_ISSOCK(m) 0
413 /* Test if something is a FIFO. */
416 # define S_ISFIFO(m) (((m) & S_IFMT) == S_IFIFO)
418 # define S_ISFIFO(m) 0
422 /* Approximate O_NONBLOCK. */
424 #define O_NONBLOCK O_NDELAY
427 /* Approximate O_NOCTTY. */
432 /* Define well known filenos if the system does not define them. */
434 # define STDIN_FILENO 0
436 #ifndef STDOUT_FILENO
437 # define STDOUT_FILENO 1
439 #ifndef STDERR_FILENO
440 # define STDERR_FILENO 2
443 /* Some systems have mkdir that takes a single argument. */
444 #ifdef MKDIR_TAKES_ONE_ARG
445 # define mkdir(a,b) mkdir(a)
448 /* Provide a way to print an address via printf. */
449 #ifndef HOST_PTR_PRINTF
450 # ifdef HAVE_PRINTF_PTR
451 # define HOST_PTR_PRINTF "%p"
453 # define HOST_PTR_PRINTF \
454 (sizeof (int) == sizeof (char *) ? "%x" \
455 : sizeof (long) == sizeof (char *) ? "%lx" : "%llx")
457 #endif /* ! HOST_PTR_PRINTF */
459 /* By default, colon separates directories in a path. */
460 #ifndef PATH_SEPARATOR
461 #define PATH_SEPARATOR ':'
464 #ifndef DIR_SEPARATOR
465 #define DIR_SEPARATOR '/'
468 /* Define IS_DIR_SEPARATOR. */
469 #ifndef DIR_SEPARATOR_2
470 # define IS_DIR_SEPARATOR(CH) ((CH) == DIR_SEPARATOR)
471 #else /* DIR_SEPARATOR_2 */
472 # define IS_DIR_SEPARATOR(CH) \
473 (((CH) == DIR_SEPARATOR) || ((CH) == DIR_SEPARATOR_2))
474 #endif /* DIR_SEPARATOR_2 */
476 /* Say how to test for an absolute pathname. On Unix systems, this is if
477 it starts with a leading slash or a '$', the latter meaning the value of
478 an environment variable is to be used. On machine with DOS-based
479 file systems, it is also absolute if it starts with a drive identifier. */
480 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
481 #define IS_ABSOLUTE_PATHNAME(STR) \
482 (IS_DIR_SEPARATOR ((STR)[0]) || (STR)[0] == '$' \
483 || ((STR)[0] != '\0' && (STR)[1] == ':' && IS_DIR_SEPARATOR ((STR)[2])))
485 #define IS_ABSOLUTE_PATHNAME(STR) \
486 (IS_DIR_SEPARATOR ((STR)[0]) || (STR)[0] == '$')
489 /* Get libiberty declarations. */
490 #include "libiberty.h"
493 /* Provide a default for the HOST_BIT_BUCKET.
494 This suffices for POSIX-like hosts. */
496 #ifndef HOST_BIT_BUCKET
497 #define HOST_BIT_BUCKET "/dev/null"
500 /* Be conservative and only use enum bitfields with GCC.
501 FIXME: provide a complete autoconf test for buggy enum bitfields. */
503 #if (GCC_VERSION > 2000)
504 #define ENUM_BITFIELD(TYPE) enum TYPE
506 #define ENUM_BITFIELD(TYPE) unsigned int
510 #define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *) 0)->MEMBER)
513 /* Traditional C cannot initialize union members of structs. Provide
514 a macro which expands appropriately to handle it. This only works
515 if you intend to initialize the union member to zero since it relies
516 on default initialization to zero in the traditional C case. */
518 #define UNION_INIT_ZERO , {0}
520 #define UNION_INIT_ZERO
523 /* Various error reporting routines want to use __FUNCTION__. */
524 #if (GCC_VERSION < 2007)
526 #define __FUNCTION__ "?"
527 #endif /* ! __FUNCTION__ */
530 /* __builtin_expect(A, B) evaluates to A, but notifies the compiler that
531 the most likely value of A is B. This feature was added at some point
532 between 2.95 and 3.0. Let's use 3.0 as the lower bound for now. */
533 #if (GCC_VERSION < 3000)
534 #define __builtin_expect(a, b) (a)
537 /* Provide some sort of boolean type. We use stdbool.h if it's
538 available. This must be after all inclusion of system headers,
539 as some of them will mess us up. */
546 #ifdef HAVE_STDBOOL_H
547 # include <stdbool.h>
560 /* As the last action in this file, we poison the identifiers that
561 shouldn't be used. Note, luckily gcc-3.0's token-based integrated
562 preprocessor won't trip on poisoned identifiers that arrive from
563 the expansion of macros. E.g. #define strrchr rindex, won't error
564 if rindex is poisoned after this directive is issued and later on
567 Note: We define bypass macros for the few cases where we really
568 want to use the libc memory allocation routines. Otherwise we
569 insist you use the "x" versions from libiberty. */
571 #define really_call_malloc malloc
572 #define really_call_calloc calloc
573 #define really_call_realloc realloc
575 #if defined(FLEX_SCANNER) || defined(YYBISON)
576 /* Flex and bison use malloc and realloc. Yuk. Note that this means
577 really_call_* cannot be used in a .l or .y file. */
578 #define malloc xmalloc
579 #define realloc xrealloc
582 #if (GCC_VERSION >= 3000)
584 /* Note autoconf checks for prototype declarations and includes
585 system.h while doing so. Only poison these tokens if actually
586 compiling gcc, so that the autoconf declaration tests for malloc
587 etc don't spuriously fail. */
591 #pragma GCC poison calloc strdup
593 #if !defined(FLEX_SCANNER) && !defined(YYBISON)
596 #pragma GCC poison malloc realloc
599 /* Old target macros that have moved to the target hooks structure. */
600 #pragma GCC poison ASM_OPEN_PAREN ASM_CLOSE_PAREN \
601 FUNCTION_PROLOGUE FUNCTION_EPILOGUE \
602 FUNCTION_END_PROLOGUE FUNCTION_BEGIN_EPILOGUE \
603 DECL_MACHINE_ATTRIBUTES COMP_TYPE_ATTRIBUTES INSERT_ATTRIBUTES \
604 VALID_MACHINE_DECL_ATTRIBUTE VALID_MACHINE_TYPE_ATTRIBUTE \
605 SET_DEFAULT_TYPE_ATTRIBUTES SET_DEFAULT_DECL_ATTRIBUTES \
606 MERGE_MACHINE_TYPE_ATTRIBUTES MERGE_MACHINE_DECL_ATTRIBUTES \
607 MD_INIT_BUILTINS MD_EXPAND_BUILTIN ASM_OUTPUT_CONSTRUCTOR \
608 ASM_OUTPUT_DESTRUCTOR SIGNED_CHAR_SPEC MAX_CHAR_TYPE_SIZE \
609 WCHAR_UNSIGNED UNIQUE_SECTION SELECT_SECTION SELECT_RTX_SECTION \
610 ENCODE_SECTION_INFO STRIP_NAME_ENCODING ASM_GLOBALIZE_LABEL \
613 /* Other obsolete target macros, or macros that used to be in target
614 headers and were not used, and may be obsolete or may never have
616 #pragma GCC poison INT_ASM_OP ASM_OUTPUT_EH_REGION_BEG \
617 ASM_OUTPUT_EH_REGION_END ASM_OUTPUT_LABELREF_AS_INT \
618 DOESNT_NEED_UNWINDER EH_TABLE_LOOKUP OBJC_SELECTORS_WITHOUT_LABELS \
619 OMIT_EH_TABLE EASY_DIV_EXPR IMPLICIT_FIX_EXPR \
620 LONGJMP_RESTORE_FROM_STACK MAX_INT_TYPE_SIZE ASM_IDENTIFY_GCC \
621 STDC_VALUE TRAMPOLINE_ALIGN ASM_IDENTIFY_GCC_AFTER_SOURCE \
622 SLOW_ZERO_EXTEND SUBREG_REGNO_OFFSET DWARF_LINE_MIN_INSTR_LENGTH \
623 TRADITIONAL_RETURN_FLOAT NO_BUILTIN_SIZE_TYPE \
624 NO_BUILTIN_PTRDIFF_TYPE NO_BUILTIN_WCHAR_TYPE NO_BUILTIN_WINT_TYPE \
625 BLOCK_PROFILER BLOCK_PROFILER_CODE FUNCTION_BLOCK_PROFILER \
626 FUNCTION_BLOCK_PROFILER_EXIT MACHINE_STATE_SAVE \
627 MACHINE_STATE_RESTORE SCCS_DIRECTIVE SECTION_ASM_OP \
628 ASM_OUTPUT_DEFINE_LABEL_DIFFERENCE_SYMBOL ASM_OUTPUT_INTERNAL_LABEL
630 /* Hooks that are no longer used. */
631 #pragma GCC poison LANG_HOOKS_FUNCTION_MARK LANG_HOOKS_FUNCTION_FREE \
636 /* Note: not all uses of the `index' token (e.g. variable names and
637 structure members) have been eliminated. */
642 #pragma GCC poison bcopy bzero bcmp rindex
644 #endif /* GCC >= 3.0 */
646 #endif /* ! GCC_SYSTEM_H */