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 before stdio.h. */
31 # define va_copy(d,s) __va_copy((d),(s))
33 # define va_copy(d,s) ((d) = (s))
43 /* Define a generic NULL if one hasn't already been defined. */
48 /* The compiler is not a multi-threaded application and therefore we
49 do not have to use the locking functions. In fact, using the locking
50 functions can cause the compiler to be significantly slower under
51 I/O bound conditions (such as -g -O0 on very large source files).
53 HAVE_DECL_PUTC_UNLOCKED actually indicates whether or not the stdio
54 code is multi-thread safe by default. If it is set to 0, then do
55 not worry about using the _unlocked functions.
57 fputs_unlocked, fwrite_unlocked, and fprintf_unlocked are
58 extensions and need to be prototyped by hand (since we do not
59 define _GNU_SOURCE). */
61 #if defined HAVE_DECL_PUTC_UNLOCKED && HAVE_DECL_PUTC_UNLOCKED
63 # ifdef HAVE_PUTC_UNLOCKED
65 # define putc(C, Stream) putc_unlocked (C, Stream)
67 # ifdef HAVE_FPUTC_UNLOCKED
69 # define fputc(C, Stream) fputc_unlocked (C, Stream)
72 # ifdef HAVE_FPUTS_UNLOCKED
74 # define fputs(String, Stream) fputs_unlocked (String, Stream)
75 # if defined (HAVE_DECL_FPUTS_UNLOCKED) && !HAVE_DECL_FPUTS_UNLOCKED
76 extern int fputs_unlocked (const char *, FILE *);
79 # ifdef HAVE_FWRITE_UNLOCKED
81 # define fwrite(Ptr, Size, N, Stream) fwrite_unlocked (Ptr, Size, N, Stream)
82 # if defined (HAVE_DECL_FWRITE_UNLOCKED) && !HAVE_DECL_FWRITE_UNLOCKED
83 extern int fwrite_unlocked (const void *, size_t, size_t, FILE *);
86 # ifdef HAVE_FPRINTF_UNLOCKED
88 /* We can't use a function-like macro here because we don't know if
89 we have varargs macros. */
90 # define fprintf fprintf_unlocked
91 # if defined (HAVE_DECL_FPRINTF_UNLOCKED) && !HAVE_DECL_FPRINTF_UNLOCKED
92 extern int fprintf_unlocked (FILE *, const char *, ...);
98 /* ??? Glibc's fwrite/fread_unlocked macros cause
99 "warning: signed and unsigned type in conditional expression". */
100 #undef fread_unlocked
101 #undef fwrite_unlocked
103 /* There are an extraordinary number of issues with <ctype.h>.
104 The last straw is that it varies with the locale. Use libiberty's
105 replacement instead. */
106 #include <safe-ctype.h>
108 #include <sys/types.h>
112 #if !defined (errno) && defined (HAVE_DECL_ERRNO) && !HAVE_DECL_ERRNO
116 /* Some of glibc's string inlines cause warnings. Plus we'd rather
117 rely on (and therefore test) GCC's string builtins. */
118 #define __NO_STRING_INLINES
120 #ifdef STRING_WITH_STRINGS
122 # include <strings.h>
124 # ifdef HAVE_STRING_H
127 # ifdef HAVE_STRINGS_H
128 # include <strings.h>
137 /* If we don't have an overriding definition, set SUCCESS_EXIT_CODE and
138 FATAL_EXIT_CODE to EXIT_SUCCESS and EXIT_FAILURE respectively,
139 or 0 and 1 if those macros are not defined. */
140 #ifndef SUCCESS_EXIT_CODE
142 # define SUCCESS_EXIT_CODE EXIT_SUCCESS
144 # define SUCCESS_EXIT_CODE 0
148 #ifndef FATAL_EXIT_CODE
150 # define FATAL_EXIT_CODE EXIT_FAILURE
152 # define FATAL_EXIT_CODE 1
160 #ifdef HAVE_SYS_PARAM_H
161 # include <sys/param.h>
162 /* We use this identifier later and it appears in some vendor param.h's. */
170 /* Get definitions of HOST_WIDE_INT and HOST_WIDEST_INT. */
173 /* A macro to determine whether a VALUE lies inclusively within a
174 certain range without evaluating the VALUE more than once. This
175 macro won't warn if the VALUE is unsigned and the LOWER bound is
176 zero, as it would e.g. with "VALUE >= 0 && ...". Note the LOWER
177 bound *is* evaluated twice, and LOWER must not be greater than
178 UPPER. However the bounds themselves can be either positive or
180 #define IN_RANGE(VALUE, LOWER, UPPER) \
181 ((unsigned HOST_WIDE_INT) ((VALUE) - (LOWER)) <= ((UPPER) - (LOWER)))
183 /* Infrastructure for defining missing _MAX and _MIN macros. Note that
184 macros defined with these cannot be used in #if. */
186 /* The extra casts work around common compiler bugs. */
187 #define INTTYPE_SIGNED(t) (! ((t) 0 < (t) -1))
188 /* The outer cast is needed to work around a bug in Cray C 5.0.3.0.
189 It is necessary at least when t == time_t. */
190 #define INTTYPE_MINIMUM(t) ((t) (INTTYPE_SIGNED (t) \
191 ? ~ (t) 0 << (sizeof(t) * CHAR_BIT - 1) : (t) 0))
192 #define INTTYPE_MAXIMUM(t) ((t) (~ (t) 0 - INTTYPE_MINIMUM (t)))
194 /* Use that infrastructure to provide a few constants. */
196 # define UCHAR_MAX INTTYPE_MAXIMUM (unsigned char)
199 #ifdef TIME_WITH_SYS_TIME
200 # include <sys/time.h>
204 # include <sys/time.h>
215 # ifdef HAVE_SYS_FILE_H
216 # include <sys/file.h>
238 /* Some systems define these in, e.g., param.h. We undefine these names
239 here to avoid the warnings. We prefer to use our definitions since we
240 know they are correct. */
244 #define MIN(X,Y) ((X) < (Y) ? (X) : (Y))
245 #define MAX(X,Y) ((X) > (Y) ? (X) : (Y))
247 /* Returns the least number N such that N * Y >= X. */
248 #define CEIL(x,y) (((x) + (y) - 1) / (y))
250 #ifdef HAVE_SYS_WAIT_H
251 #include <sys/wait.h>
255 #define WIFSIGNALED(S) (((S) & 0xff) != 0 && ((S) & 0xff) != 0x7f)
258 #define WTERMSIG(S) ((S) & 0x7f)
261 #define WIFEXITED(S) (((S) & 0xff) == 0)
264 #define WEXITSTATUS(S) (((S) & 0xff00) >> 8)
267 #define WSTOPSIG WEXITSTATUS
270 #define WCOREDUMP(S) ((S) & WCOREFLG)
273 #define WCOREFLG 0200
276 /* The HAVE_DECL_* macros are three-state, undefined, 0 or 1. If they
277 are defined to 0 then we must provide the relevant declaration
278 here. These checks will be in the undefined state while configure
279 is running so be careful to test "defined (HAVE_DECL_*)". */
281 #if defined (HAVE_DECL_ATOF) && !HAVE_DECL_ATOF
282 extern double atof (const char *);
285 #if defined (HAVE_DECL_ATOL) && !HAVE_DECL_ATOL
286 extern long atol (const char *);
289 #if defined (HAVE_DECL_FREE) && !HAVE_DECL_FREE
290 extern void free (void *);
293 #if defined (HAVE_DECL_GETCWD) && !HAVE_DECL_GETCWD
294 extern char *getcwd (char *, size_t);
297 #if defined (HAVE_DECL_GETENV) && !HAVE_DECL_GETENV
298 extern char *getenv (const char *);
301 #if defined (HAVE_DECL_GETOPT) && !HAVE_DECL_GETOPT
302 extern int getopt (int, char * const *, const char *);
305 #if defined (HAVE_DECL_GETWD) && !HAVE_DECL_GETWD
306 extern char *getwd (char *);
309 #if defined (HAVE_DECL_SBRK) && !HAVE_DECL_SBRK
310 extern void *sbrk (int);
313 #if defined (HAVE_DECL_STRSTR) && !HAVE_DECL_STRSTR
314 extern char *strstr (const char *, const char *);
321 #if defined (HAVE_DECL_MALLOC) && !HAVE_DECL_MALLOC
322 extern void *malloc (size_t);
325 #if defined (HAVE_DECL_CALLOC) && !HAVE_DECL_CALLOC
326 extern void *calloc (size_t, size_t);
329 #if defined (HAVE_DECL_REALLOC) && !HAVE_DECL_REALLOC
330 extern void *realloc (void *, size_t);
333 /* If the system doesn't provide strsignal, we get it defined in
334 libiberty but no declaration is supplied. */
335 #if !defined (HAVE_STRSIGNAL) \
336 || (defined (HAVE_DECL_STRSIGNAL) && !HAVE_DECL_STRSIGNAL)
338 extern const char *strsignal (int);
342 #ifdef HAVE_GETRLIMIT
343 # if defined (HAVE_DECL_GETRLIMIT) && !HAVE_DECL_GETRLIMIT
346 extern int getrlimit (int, struct rlimit
*);
351 #ifdef HAVE_SETRLIMIT
352 # if defined (HAVE_DECL_SETRLIMIT) && !HAVE_DECL_SETRLIMIT
355 extern int setrlimit (int, const struct rlimit
*);
360 #if defined (HAVE_DECL_ABORT) && !HAVE_DECL_ABORT
361 extern void abort (void);
364 #if defined (HAVE_DECL_SNPRINTF) && !HAVE_DECL_SNPRINTF
365 extern int snprintf (char *, size_t, const char *, ...);
368 /* 1 if we have C99 designated initializers. */
369 #if !defined(HAVE_DESIGNATED_INITIALIZERS)
370 #define HAVE_DESIGNATED_INITIALIZERS \
371 ((GCC_VERSION >= 2007) || (__STDC_VERSION__ >= 199901L))
374 /* 1 if we have _Bool. */
376 # define HAVE__BOOL \
377 ((GCC_VERSION >= 3000) || (__STDC_VERSION__ >= 199901L))
382 # include <sys/stat.h>
385 /* Test if something is a normal file. */
387 #define S_ISREG(m) (((m) & S_IFMT) == S_IFREG)
390 /* Test if something is a directory. */
392 #define S_ISDIR(m) (((m) & S_IFMT) == S_IFDIR)
395 /* Test if something is a character special file. */
397 #define S_ISCHR(m) (((m) & S_IFMT) == S_IFCHR)
400 /* Test if something is a block special file. */
402 #define S_ISBLK(m) (((m) & S_IFMT) == S_IFBLK)
405 /* Test if something is a socket. */
408 # define S_ISSOCK(m) (((m) & S_IFMT) == S_IFSOCK)
410 # define S_ISSOCK(m) 0
414 /* Test if something is a FIFO. */
417 # define S_ISFIFO(m) (((m) & S_IFMT) == S_IFIFO)
419 # define S_ISFIFO(m) 0
423 /* Approximate O_NONBLOCK. */
425 #define O_NONBLOCK O_NDELAY
428 /* Approximate O_NOCTTY. */
433 /* Define well known filenos if the system does not define them. */
435 # define STDIN_FILENO 0
437 #ifndef STDOUT_FILENO
438 # define STDOUT_FILENO 1
440 #ifndef STDERR_FILENO
441 # define STDERR_FILENO 2
444 /* Some systems have mkdir that takes a single argument. */
445 #ifdef MKDIR_TAKES_ONE_ARG
446 # define mkdir(a,b) mkdir(a)
449 /* Provide a way to print an address via printf. */
450 #ifndef HOST_PTR_PRINTF
451 # ifdef HAVE_PRINTF_PTR
452 # define HOST_PTR_PRINTF "%p"
453 # elif SIZEOF_INT == SIZEOF_VOID_P
454 # define HOST_PTR_PRINTF "%x"
455 # elif SIZEOF_LONG == SIZEOF_VOID_P
456 # define HOST_PTR_PRINTF "%lx"
458 # define HOST_PTR_PRINTF "%llx"
460 #endif /* ! HOST_PTR_PRINTF */
462 /* By default, colon separates directories in a path. */
463 #ifndef PATH_SEPARATOR
464 #define PATH_SEPARATOR ':'
467 /* Filename handling macros. */
468 #include "filenames.h"
470 /* These should be phased out in favor of IS_DIR_SEPARATOR, where possible. */
471 #ifndef DIR_SEPARATOR
472 # define DIR_SEPARATOR '/'
473 # ifdef HAVE_DOS_BASED_FILE_SYSTEM
474 # define DIR_SEPARATOR_2 '\\'
478 /* Get libiberty declarations. */
479 #include "libiberty.h"
481 /* Provide a default for the HOST_BIT_BUCKET.
482 This suffices for POSIX-like hosts. */
484 #ifndef HOST_BIT_BUCKET
485 #define HOST_BIT_BUCKET "/dev/null"
488 /* Be conservative and only use enum bitfields with GCC. Likewise for
490 FIXME: provide a complete autoconf test for buggy enum bitfields. */
492 #if (GCC_VERSION > 2000)
493 #define ENUM_BITFIELD(TYPE) __extension__ enum TYPE
494 #define CHAR_BITFIELD __extension__ unsigned char
496 #define ENUM_BITFIELD(TYPE) unsigned int
497 #define CHAR_BITFIELD unsigned int
501 #define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *) 0)->MEMBER)
504 /* Various error reporting routines want to use __FUNCTION__. */
505 #if (GCC_VERSION < 2007)
507 #define __FUNCTION__ "?"
508 #endif /* ! __FUNCTION__ */
511 /* __builtin_expect(A, B) evaluates to A, but notifies the compiler that
512 the most likely value of A is B. This feature was added at some point
513 between 2.95 and 3.0. Let's use 3.0 as the lower bound for now. */
514 #if (GCC_VERSION < 3000)
515 #define __builtin_expect(a, b) (a)
518 /* Provide some sort of boolean type. We use stdbool.h if it's
519 available. This must be after all inclusion of system headers,
520 as some of them will mess us up. */
527 #ifdef HAVE_STDBOOL_H
528 # include <stdbool.h>
541 /* As the last action in this file, we poison the identifiers that
542 shouldn't be used. Note, luckily gcc-3.0's token-based integrated
543 preprocessor won't trip on poisoned identifiers that arrive from
544 the expansion of macros. E.g. #define strrchr rindex, won't error
545 if rindex is poisoned after this directive is issued and later on
548 Note: We define bypass macros for the few cases where we really
549 want to use the libc memory allocation routines. Otherwise we
550 insist you use the "x" versions from libiberty. */
552 #define really_call_malloc malloc
553 #define really_call_calloc calloc
554 #define really_call_realloc realloc
556 #if defined(FLEX_SCANNER) || defined(YYBISON) || defined(YYBYACC)
557 /* Flex and bison use malloc and realloc. Yuk. Note that this means
558 really_call_* cannot be used in a .l or .y file. */
559 #define malloc xmalloc
560 #define realloc xrealloc
563 #if (GCC_VERSION >= 3000)
565 /* Note autoconf checks for prototype declarations and includes
566 system.h while doing so. Only poison these tokens if actually
567 compiling gcc, so that the autoconf declaration tests for malloc
568 etc don't spuriously fail. */
572 #pragma GCC poison calloc strdup
574 #if !defined(FLEX_SCANNER) && !defined(YYBISON)
577 #pragma GCC poison malloc realloc
580 /* Old target macros that have moved to the target hooks structure. */
581 #pragma GCC poison ASM_OPEN_PAREN ASM_CLOSE_PAREN \
582 FUNCTION_PROLOGUE FUNCTION_EPILOGUE \
583 FUNCTION_END_PROLOGUE FUNCTION_BEGIN_EPILOGUE \
584 DECL_MACHINE_ATTRIBUTES COMP_TYPE_ATTRIBUTES INSERT_ATTRIBUTES \
585 VALID_MACHINE_DECL_ATTRIBUTE VALID_MACHINE_TYPE_ATTRIBUTE \
586 SET_DEFAULT_TYPE_ATTRIBUTES SET_DEFAULT_DECL_ATTRIBUTES \
587 MERGE_MACHINE_TYPE_ATTRIBUTES MERGE_MACHINE_DECL_ATTRIBUTES \
588 MD_INIT_BUILTINS MD_EXPAND_BUILTIN ASM_OUTPUT_CONSTRUCTOR \
589 ASM_OUTPUT_DESTRUCTOR SIGNED_CHAR_SPEC MAX_CHAR_TYPE_SIZE \
590 WCHAR_UNSIGNED UNIQUE_SECTION SELECT_SECTION SELECT_RTX_SECTION \
591 ENCODE_SECTION_INFO STRIP_NAME_ENCODING ASM_GLOBALIZE_LABEL \
592 ASM_OUTPUT_MI_THUNK CONST_COSTS RTX_COSTS DEFAULT_RTX_COSTS \
593 ADDRESS_COST MACHINE_DEPENDENT_REORG ASM_FILE_START ASM_FILE_END \
594 ASM_SIMPLIFY_DWARF_ADDR INIT_TARGET_OPTABS INIT_SUBTARGET_OPTABS \
595 INIT_GOFAST_OPTABS MULSI3_LIBCALL MULDI3_LIBCALL DIVSI3_LIBCALL \
596 DIVDI3_LIBCALL UDIVSI3_LIBCALL UDIVDI3_LIBCALL MODSI3_LIBCALL \
597 MODDI3_LIBCALL UMODSI3_LIBCALL UMODDI3_LIBCALL BUILD_VA_LIST_TYPE \
598 PRETEND_OUTGOING_VARARGS_NAMED STRUCT_VALUE_INCOMING_REGNUM \
599 ASM_OUTPUT_SECTION_NAME
601 /* Other obsolete target macros, or macros that used to be in target
602 headers and were not used, and may be obsolete or may never have
604 #pragma GCC poison INT_ASM_OP ASM_OUTPUT_EH_REGION_BEG CPP_PREDEFINES \
605 ASM_OUTPUT_EH_REGION_END ASM_OUTPUT_LABELREF_AS_INT SMALL_STACK \
606 DOESNT_NEED_UNWINDER EH_TABLE_LOOKUP OBJC_SELECTORS_WITHOUT_LABELS \
607 OMIT_EH_TABLE EASY_DIV_EXPR IMPLICIT_FIX_EXPR \
608 LONGJMP_RESTORE_FROM_STACK MAX_INT_TYPE_SIZE ASM_IDENTIFY_GCC \
609 STDC_VALUE TRAMPOLINE_ALIGN ASM_IDENTIFY_GCC_AFTER_SOURCE \
610 SLOW_ZERO_EXTEND SUBREG_REGNO_OFFSET DWARF_LINE_MIN_INSTR_LENGTH \
611 TRADITIONAL_RETURN_FLOAT NO_BUILTIN_SIZE_TYPE \
612 NO_BUILTIN_PTRDIFF_TYPE NO_BUILTIN_WCHAR_TYPE NO_BUILTIN_WINT_TYPE \
613 BLOCK_PROFILER BLOCK_PROFILER_CODE FUNCTION_BLOCK_PROFILER \
614 FUNCTION_BLOCK_PROFILER_EXIT MACHINE_STATE_SAVE \
615 MACHINE_STATE_RESTORE SCCS_DIRECTIVE SECTION_ASM_OP \
616 ASM_OUTPUT_DEFINE_LABEL_DIFFERENCE_SYMBOL ASM_OUTPUT_INTERNAL_LABEL \
617 OBJC_PROLOGUE ALLOCATE_TRAMPOLINE HANDLE_PRAGMA ROUND_TYPE_SIZE \
618 ROUND_TYPE_SIZE_UNIT CONST_SECTION_ASM_OP CRT_GET_RFIB_TEXT \
619 DBX_LBRAC_FIRST DBX_OUTPUT_ENUM DBX_OUTPUT_SOURCE_FILENAME \
620 DBX_WORKING_DIRECTORY INSN_CACHE_DEPTH INSN_CACHE_SIZE \
621 INSN_CACHE_LINE_WIDTH INIT_SECTION_PREAMBLE NEED_ATEXIT ON_EXIT \
622 EXIT_BODY OBJECT_FORMAT_ROSE MULTIBYTE_CHARS MAP_CHARACTER \
623 LIBGCC_NEEDS_DOUBLE FINAL_PRESCAN_LABEL DEFAULT_CALLER_SAVES \
624 LOAD_ARGS_REVERSED MAX_INTEGER_COMPUTATION_MODE \
625 CONVERT_HARD_REGISTER_TO_SSA_P ASM_OUTPUT_MAIN_SOURCE_FILENAME \
626 FIRST_INSN_ADDRESS TEXT_SECTION SHARED_BSS_SECTION_ASM_OP \
627 PROMOTED_MODE EXPAND_BUILTIN_VA_END \
628 LINKER_DOES_NOT_WORK_WITH_DWARF2
630 /* Hooks that are no longer used. */
631 #pragma GCC poison LANG_HOOKS_FUNCTION_MARK LANG_HOOKS_FUNCTION_FREE \
632 LANG_HOOKS_MARK_TREE LANG_HOOKS_INSERT_DEFAULT_ATTRIBUTES
634 /* Libiberty macros that are no longer used in GCC. */
635 #undef ANSI_PROTOTYPES
643 #pragma GCC poison ANSI_PROTOTYPES PTR_CONST LONG_DOUBLE VPARAMS VA_OPEN \
644 VA_FIXEDARG VA_CLOSE VA_START
647 /* Note: not all uses of the `index' token (e.g. variable names and
648 structure members) have been eliminated. */
653 #pragma GCC poison bcopy bzero bcmp rindex
655 #endif /* GCC >= 3.0 */
657 #endif /* ! GCC_SYSTEM_H */