1 /* Get common system includes and various definitions and declarations based
3 Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004
4 Free Software Foundation, Inc.
6 This file is part of GCC.
8 GCC is free software; you can redistribute it and/or modify it under
9 the terms of the GNU General Public License as published by the Free
10 Software Foundation; either version 2, or (at your option) any later
13 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
14 WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
18 You should have received a copy of the GNU General Public License
19 along with GCC; see the file COPYING. If not, write to the Free
20 Software Foundation, 59 Temple Place - Suite 330, Boston, MA
27 /* We must include stdarg.h before stdio.h. */
32 # define va_copy(d,s) __va_copy((d),(s))
34 # define va_copy(d,s) ((d) = (s))
44 /* Define a generic NULL if one hasn't already been defined. */
49 /* The compiler is not a multi-threaded application and therefore we
50 do not have to use the locking functions. In fact, using the locking
51 functions can cause the compiler to be significantly slower under
52 I/O bound conditions (such as -g -O0 on very large source files).
54 HAVE_DECL_PUTC_UNLOCKED actually indicates whether or not the stdio
55 code is multi-thread safe by default. If it is set to 0, then do
56 not worry about using the _unlocked functions.
58 fputs_unlocked, fwrite_unlocked, and fprintf_unlocked are
59 extensions and need to be prototyped by hand (since we do not
60 define _GNU_SOURCE). */
62 #if defined HAVE_DECL_PUTC_UNLOCKED && HAVE_DECL_PUTC_UNLOCKED
64 # ifdef HAVE_PUTC_UNLOCKED
66 # define putc(C, Stream) putc_unlocked (C, Stream)
68 # ifdef HAVE_FPUTC_UNLOCKED
70 # define fputc(C, Stream) fputc_unlocked (C, Stream)
73 # ifdef HAVE_FPUTS_UNLOCKED
75 # define fputs(String, Stream) fputs_unlocked (String, Stream)
76 # if defined (HAVE_DECL_FPUTS_UNLOCKED) && !HAVE_DECL_FPUTS_UNLOCKED
77 extern int fputs_unlocked (const char *, FILE *);
80 # ifdef HAVE_FWRITE_UNLOCKED
82 # define fwrite(Ptr, Size, N, Stream) fwrite_unlocked (Ptr, Size, N, Stream)
83 # if defined (HAVE_DECL_FWRITE_UNLOCKED) && !HAVE_DECL_FWRITE_UNLOCKED
84 extern int fwrite_unlocked (const void *, size_t, size_t, FILE *);
87 # ifdef HAVE_FPRINTF_UNLOCKED
89 /* We can't use a function-like macro here because we don't know if
90 we have varargs macros. */
91 # define fprintf fprintf_unlocked
92 # if defined (HAVE_DECL_FPRINTF_UNLOCKED) && !HAVE_DECL_FPRINTF_UNLOCKED
93 extern int fprintf_unlocked (FILE *, const char *, ...);
99 /* ??? Glibc's fwrite/fread_unlocked macros cause
100 "warning: signed and unsigned type in conditional expression". */
101 #undef fread_unlocked
102 #undef fwrite_unlocked
104 /* There are an extraordinary number of issues with <ctype.h>.
105 The last straw is that it varies with the locale. Use libiberty's
106 replacement instead. */
107 #include <safe-ctype.h>
109 #include <sys/types.h>
113 #if !defined (errno) && defined (HAVE_DECL_ERRNO) && !HAVE_DECL_ERRNO
117 /* Some of glibc's string inlines cause warnings. Plus we'd rather
118 rely on (and therefore test) GCC's string builtins. */
119 #define __NO_STRING_INLINES
121 #ifdef STRING_WITH_STRINGS
123 # include <strings.h>
125 # ifdef HAVE_STRING_H
128 # ifdef HAVE_STRINGS_H
129 # include <strings.h>
138 /* If we don't have an overriding definition, set SUCCESS_EXIT_CODE and
139 FATAL_EXIT_CODE to EXIT_SUCCESS and EXIT_FAILURE respectively,
140 or 0 and 1 if those macros are not defined. */
141 #ifndef SUCCESS_EXIT_CODE
143 # define SUCCESS_EXIT_CODE EXIT_SUCCESS
145 # define SUCCESS_EXIT_CODE 0
149 #ifndef FATAL_EXIT_CODE
151 # define FATAL_EXIT_CODE EXIT_FAILURE
153 # define FATAL_EXIT_CODE 1
161 #ifdef HAVE_SYS_PARAM_H
162 # include <sys/param.h>
163 /* We use this identifier later and it appears in some vendor param.h's. */
171 /* Get definitions of HOST_WIDE_INT and HOST_WIDEST_INT. */
174 /* A macro to determine whether a VALUE lies inclusively within a
175 certain range without evaluating the VALUE more than once. This
176 macro won't warn if the VALUE is unsigned and the LOWER bound is
177 zero, as it would e.g. with "VALUE >= 0 && ...". Note the LOWER
178 bound *is* evaluated twice, and LOWER must not be greater than
179 UPPER. However the bounds themselves can be either positive or
181 #define IN_RANGE(VALUE, LOWER, UPPER) \
182 ((unsigned HOST_WIDE_INT) ((VALUE) - (LOWER)) <= ((UPPER) - (LOWER)))
184 /* Infrastructure for defining missing _MAX and _MIN macros. Note that
185 macros defined with these cannot be used in #if. */
187 /* The extra casts work around common compiler bugs. */
188 #define INTTYPE_SIGNED(t) (! ((t) 0 < (t) -1))
189 /* The outer cast is needed to work around a bug in Cray C 5.0.3.0.
190 It is necessary at least when t == time_t. */
191 #define INTTYPE_MINIMUM(t) ((t) (INTTYPE_SIGNED (t) \
192 ? ~ (t) 0 << (sizeof(t) * CHAR_BIT - 1) : (t) 0))
193 #define INTTYPE_MAXIMUM(t) ((t) (~ (t) 0 - INTTYPE_MINIMUM (t)))
195 /* Use that infrastructure to provide a few constants. */
197 # define UCHAR_MAX INTTYPE_MAXIMUM (unsigned char)
200 #ifdef TIME_WITH_SYS_TIME
201 # include <sys/time.h>
205 # include <sys/time.h>
216 # ifdef HAVE_SYS_FILE_H
217 # include <sys/file.h>
239 /* Some systems define these in, e.g., param.h. We undefine these names
240 here to avoid the warnings. We prefer to use our definitions since we
241 know they are correct. */
245 #define MIN(X,Y) ((X) < (Y) ? (X) : (Y))
246 #define MAX(X,Y) ((X) > (Y) ? (X) : (Y))
248 /* Returns the least number N such that N * Y >= X. */
249 #define CEIL(x,y) (((x) + (y) - 1) / (y))
251 #ifdef HAVE_SYS_WAIT_H
252 #include <sys/wait.h>
256 #define WIFSIGNALED(S) (((S) & 0xff) != 0 && ((S) & 0xff) != 0x7f)
259 #define WTERMSIG(S) ((S) & 0x7f)
262 #define WIFEXITED(S) (((S) & 0xff) == 0)
265 #define WEXITSTATUS(S) (((S) & 0xff00) >> 8)
268 #define WSTOPSIG WEXITSTATUS
271 #define WCOREDUMP(S) ((S) & WCOREFLG)
274 #define WCOREFLG 0200
277 /* The HAVE_DECL_* macros are three-state, undefined, 0 or 1. If they
278 are defined to 0 then we must provide the relevant declaration
279 here. These checks will be in the undefined state while configure
280 is running so be careful to test "defined (HAVE_DECL_*)". */
282 #if defined (HAVE_DECL_ATOF) && !HAVE_DECL_ATOF
283 extern double atof (const char *);
286 #if defined (HAVE_DECL_ATOL) && !HAVE_DECL_ATOL
287 extern long atol (const char *);
290 #if defined (HAVE_DECL_FREE) && !HAVE_DECL_FREE
291 extern void free (void *);
294 #if defined (HAVE_DECL_GETCWD) && !HAVE_DECL_GETCWD
295 extern char *getcwd (char *, size_t);
298 #if defined (HAVE_DECL_GETENV) && !HAVE_DECL_GETENV
299 extern char *getenv (const char *);
302 #if defined (HAVE_DECL_GETOPT) && !HAVE_DECL_GETOPT
303 extern int getopt (int, char * const *, const char *);
306 #if defined (HAVE_DECL_GETWD) && !HAVE_DECL_GETWD
307 extern char *getwd (char *);
310 #if defined (HAVE_DECL_SBRK) && !HAVE_DECL_SBRK
311 extern void *sbrk (int);
314 #if defined (HAVE_DECL_STRSTR) && !HAVE_DECL_STRSTR
315 extern char *strstr (const char *, const char *);
322 #if defined (HAVE_DECL_MALLOC) && !HAVE_DECL_MALLOC
323 extern void *malloc (size_t);
326 #if defined (HAVE_DECL_CALLOC) && !HAVE_DECL_CALLOC
327 extern void *calloc (size_t, size_t);
330 #if defined (HAVE_DECL_REALLOC) && !HAVE_DECL_REALLOC
331 extern void *realloc (void *, size_t);
334 /* If the system doesn't provide strsignal, we get it defined in
335 libiberty but no declaration is supplied. */
336 #if !defined (HAVE_STRSIGNAL) \
337 || (defined (HAVE_DECL_STRSIGNAL) && !HAVE_DECL_STRSIGNAL)
339 extern const char *strsignal (int);
343 #ifdef HAVE_GETRLIMIT
344 # if defined (HAVE_DECL_GETRLIMIT) && !HAVE_DECL_GETRLIMIT
347 extern int getrlimit (int, struct rlimit
*);
352 #ifdef HAVE_SETRLIMIT
353 # if defined (HAVE_DECL_SETRLIMIT) && !HAVE_DECL_SETRLIMIT
356 extern int setrlimit (int, const struct rlimit
*);
361 #if defined (HAVE_DECL_ABORT) && !HAVE_DECL_ABORT
362 extern void abort (void);
365 #if defined (HAVE_DECL_SNPRINTF) && !HAVE_DECL_SNPRINTF
366 extern int snprintf (char *, size_t, const char *, ...);
369 /* 1 if we have C99 designated initializers. */
370 #if !defined(HAVE_DESIGNATED_INITIALIZERS)
371 #define HAVE_DESIGNATED_INITIALIZERS \
372 ((GCC_VERSION >= 2007) || (__STDC_VERSION__ >= 199901L))
375 /* 1 if we have _Bool. */
377 # define HAVE__BOOL \
378 ((GCC_VERSION >= 3000) || (__STDC_VERSION__ >= 199901L))
383 # include <sys/stat.h>
386 /* Test if something is a normal file. */
388 #define S_ISREG(m) (((m) & S_IFMT) == S_IFREG)
391 /* Test if something is a directory. */
393 #define S_ISDIR(m) (((m) & S_IFMT) == S_IFDIR)
396 /* Test if something is a character special file. */
398 #define S_ISCHR(m) (((m) & S_IFMT) == S_IFCHR)
401 /* Test if something is a block special file. */
403 #define S_ISBLK(m) (((m) & S_IFMT) == S_IFBLK)
406 /* Test if something is a socket. */
409 # define S_ISSOCK(m) (((m) & S_IFMT) == S_IFSOCK)
411 # define S_ISSOCK(m) 0
415 /* Test if something is a FIFO. */
418 # define S_ISFIFO(m) (((m) & S_IFMT) == S_IFIFO)
420 # define S_ISFIFO(m) 0
424 /* Approximate O_NONBLOCK. */
426 #define O_NONBLOCK O_NDELAY
429 /* Approximate O_NOCTTY. */
434 /* Define well known filenos if the system does not define them. */
436 # define STDIN_FILENO 0
438 #ifndef STDOUT_FILENO
439 # define STDOUT_FILENO 1
441 #ifndef STDERR_FILENO
442 # define STDERR_FILENO 2
445 /* Some systems have mkdir that takes a single argument. */
446 #ifdef MKDIR_TAKES_ONE_ARG
447 # define mkdir(a,b) mkdir(a)
450 /* Provide a way to print an address via printf. */
451 #ifndef HOST_PTR_PRINTF
452 # ifdef HAVE_PRINTF_PTR
453 # define HOST_PTR_PRINTF "%p"
454 # elif SIZEOF_INT == SIZEOF_VOID_P
455 # define HOST_PTR_PRINTF "%x"
456 # elif SIZEOF_LONG == SIZEOF_VOID_P
457 # define HOST_PTR_PRINTF "%lx"
459 # define HOST_PTR_PRINTF "%llx"
461 #endif /* ! HOST_PTR_PRINTF */
463 /* By default, colon separates directories in a path. */
464 #ifndef PATH_SEPARATOR
465 #define PATH_SEPARATOR ':'
468 /* Filename handling macros. */
469 #include "filenames.h"
471 /* These should be phased out in favor of IS_DIR_SEPARATOR, where possible. */
472 #ifndef DIR_SEPARATOR
473 # define DIR_SEPARATOR '/'
474 # ifdef HAVE_DOS_BASED_FILE_SYSTEM
475 # define DIR_SEPARATOR_2 '\\'
479 /* Get libiberty declarations. */
480 #include "libiberty.h"
482 /* Provide a default for the HOST_BIT_BUCKET.
483 This suffices for POSIX-like hosts. */
485 #ifndef HOST_BIT_BUCKET
486 #define HOST_BIT_BUCKET "/dev/null"
489 /* Be conservative and only use enum bitfields with GCC.
490 FIXME: provide a complete autoconf test for buggy enum bitfields. */
492 #if (GCC_VERSION > 2000)
493 #define ENUM_BITFIELD(TYPE) __extension__ enum TYPE
495 #define ENUM_BITFIELD(TYPE) unsigned int
498 /* We only use bool bitfields with gcc3. Some supposedly C99
499 compilers don't handle them correctly. */
500 #if (GCC_VERSION >= 3000)
501 #define BOOL_BITFIELD _Bool
503 #define BOOL_BITFIELD unsigned int
507 #define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *) 0)->MEMBER)
510 /* Various error reporting routines want to use __FUNCTION__. */
511 #if (GCC_VERSION < 2007)
513 #define __FUNCTION__ "?"
514 #endif /* ! __FUNCTION__ */
517 /* __builtin_expect(A, B) evaluates to A, but notifies the compiler that
518 the most likely value of A is B. This feature was added at some point
519 between 2.95 and 3.0. Let's use 3.0 as the lower bound for now. */
520 #if (GCC_VERSION < 3000)
521 #define __builtin_expect(a, b) (a)
524 /* Provide some sort of boolean type. We use stdbool.h if it's
525 available. This must be after all inclusion of system headers,
526 as some of them will mess us up. */
533 #ifdef HAVE_STDBOOL_H
534 # include <stdbool.h>
547 /* As the last action in this file, we poison the identifiers that
548 shouldn't be used. Note, luckily gcc-3.0's token-based integrated
549 preprocessor won't trip on poisoned identifiers that arrive from
550 the expansion of macros. E.g. #define strrchr rindex, won't error
551 if rindex is poisoned after this directive is issued and later on
554 Note: We define bypass macros for the few cases where we really
555 want to use the libc memory allocation routines. Otherwise we
556 insist you use the "x" versions from libiberty. */
558 #define really_call_malloc malloc
559 #define really_call_calloc calloc
560 #define really_call_realloc realloc
562 #if defined(FLEX_SCANNER) || defined(YYBISON) || defined(YYBYACC)
563 /* Flex and bison use malloc and realloc. Yuk. Note that this means
564 really_call_* cannot be used in a .l or .y file. */
565 #define malloc xmalloc
566 #define realloc xrealloc
569 #if (GCC_VERSION >= 3000)
571 /* Note autoconf checks for prototype declarations and includes
572 system.h while doing so. Only poison these tokens if actually
573 compiling gcc, so that the autoconf declaration tests for malloc
574 etc don't spuriously fail. */
578 #pragma GCC poison calloc strdup
580 #if !defined(FLEX_SCANNER) && !defined(YYBISON)
583 #pragma GCC poison malloc realloc
586 /* Old target macros that have moved to the target hooks structure. */
587 #pragma GCC poison ASM_OPEN_PAREN ASM_CLOSE_PAREN \
588 FUNCTION_PROLOGUE FUNCTION_EPILOGUE \
589 FUNCTION_END_PROLOGUE FUNCTION_BEGIN_EPILOGUE \
590 DECL_MACHINE_ATTRIBUTES COMP_TYPE_ATTRIBUTES INSERT_ATTRIBUTES \
591 VALID_MACHINE_DECL_ATTRIBUTE VALID_MACHINE_TYPE_ATTRIBUTE \
592 SET_DEFAULT_TYPE_ATTRIBUTES SET_DEFAULT_DECL_ATTRIBUTES \
593 MERGE_MACHINE_TYPE_ATTRIBUTES MERGE_MACHINE_DECL_ATTRIBUTES \
594 MD_INIT_BUILTINS MD_EXPAND_BUILTIN ASM_OUTPUT_CONSTRUCTOR \
595 ASM_OUTPUT_DESTRUCTOR SIGNED_CHAR_SPEC MAX_CHAR_TYPE_SIZE \
596 WCHAR_UNSIGNED UNIQUE_SECTION SELECT_SECTION SELECT_RTX_SECTION \
597 ENCODE_SECTION_INFO STRIP_NAME_ENCODING ASM_GLOBALIZE_LABEL \
598 ASM_OUTPUT_MI_THUNK CONST_COSTS RTX_COSTS DEFAULT_RTX_COSTS \
599 ADDRESS_COST MACHINE_DEPENDENT_REORG ASM_FILE_START ASM_FILE_END \
600 ASM_SIMPLIFY_DWARF_ADDR INIT_TARGET_OPTABS INIT_SUBTARGET_OPTABS \
601 INIT_GOFAST_OPTABS MULSI3_LIBCALL MULDI3_LIBCALL DIVSI3_LIBCALL \
602 DIVDI3_LIBCALL UDIVSI3_LIBCALL UDIVDI3_LIBCALL MODSI3_LIBCALL \
603 MODDI3_LIBCALL UMODSI3_LIBCALL UMODDI3_LIBCALL BUILD_VA_LIST_TYPE \
604 PRETEND_OUTGOING_VARARGS_NAMED STRUCT_VALUE_INCOMING_REGNUM \
605 ASM_OUTPUT_SECTION_NAME PROMOTE_FUNCTION_ARGS \
606 STRUCT_VALUE_INCOMING STRICT_ARGUMENT_NAMING \
607 PROMOTE_FUNCTION_RETURN PROMOTE_PROTOTYPES STRUCT_VALUE_REGNUM \
608 SETUP_INCOMING_VARARGS EXPAND_BUILTIN_SAVEREGS \
609 DEFAULT_SHORT_ENUMS SPLIT_COMPLEX_ARGS MD_ASM_CLOBBERS
611 /* Other obsolete target macros, or macros that used to be in target
612 headers and were not used, and may be obsolete or may never have
614 #pragma GCC poison INT_ASM_OP ASM_OUTPUT_EH_REGION_BEG CPP_PREDEFINES \
615 ASM_OUTPUT_EH_REGION_END ASM_OUTPUT_LABELREF_AS_INT SMALL_STACK \
616 DOESNT_NEED_UNWINDER EH_TABLE_LOOKUP OBJC_SELECTORS_WITHOUT_LABELS \
617 OMIT_EH_TABLE EASY_DIV_EXPR IMPLICIT_FIX_EXPR \
618 LONGJMP_RESTORE_FROM_STACK MAX_INT_TYPE_SIZE ASM_IDENTIFY_GCC \
619 STDC_VALUE TRAMPOLINE_ALIGN ASM_IDENTIFY_GCC_AFTER_SOURCE \
620 SLOW_ZERO_EXTEND SUBREG_REGNO_OFFSET DWARF_LINE_MIN_INSTR_LENGTH \
621 TRADITIONAL_RETURN_FLOAT NO_BUILTIN_SIZE_TYPE \
622 NO_BUILTIN_PTRDIFF_TYPE NO_BUILTIN_WCHAR_TYPE NO_BUILTIN_WINT_TYPE \
623 BLOCK_PROFILER BLOCK_PROFILER_CODE FUNCTION_BLOCK_PROFILER \
624 FUNCTION_BLOCK_PROFILER_EXIT MACHINE_STATE_SAVE \
625 MACHINE_STATE_RESTORE SCCS_DIRECTIVE SECTION_ASM_OP \
626 ASM_OUTPUT_DEFINE_LABEL_DIFFERENCE_SYMBOL ASM_OUTPUT_INTERNAL_LABEL \
627 OBJC_PROLOGUE ALLOCATE_TRAMPOLINE HANDLE_PRAGMA ROUND_TYPE_SIZE \
628 ROUND_TYPE_SIZE_UNIT CONST_SECTION_ASM_OP CRT_GET_RFIB_TEXT \
629 DBX_LBRAC_FIRST DBX_OUTPUT_ENUM DBX_OUTPUT_SOURCE_FILENAME \
630 DBX_WORKING_DIRECTORY INSN_CACHE_DEPTH INSN_CACHE_SIZE \
631 INSN_CACHE_LINE_WIDTH INIT_SECTION_PREAMBLE NEED_ATEXIT ON_EXIT \
632 EXIT_BODY OBJECT_FORMAT_ROSE MULTIBYTE_CHARS MAP_CHARACTER \
633 LIBGCC_NEEDS_DOUBLE FINAL_PRESCAN_LABEL DEFAULT_CALLER_SAVES \
634 LOAD_ARGS_REVERSED MAX_INTEGER_COMPUTATION_MODE \
635 CONVERT_HARD_REGISTER_TO_SSA_P ASM_OUTPUT_MAIN_SOURCE_FILENAME \
636 FIRST_INSN_ADDRESS TEXT_SECTION SHARED_BSS_SECTION_ASM_OP \
637 PROMOTED_MODE EXPAND_BUILTIN_VA_END \
638 LINKER_DOES_NOT_WORK_WITH_DWARF2 FUNCTION_ARG_KEEP_AS_REFERENCE \
639 GIV_SORT_CRITERION MAX_LONG_TYPE_SIZE MAX_LONG_DOUBLE_TYPE_SIZE \
640 MAX_WCHAR_TYPE_SIZE GCOV_TYPE_SIZE SHARED_SECTION_ASM_OP \
641 FINAL_REG_PARM_STACK_SPACE MAYBE_REG_PARM_STACK_SPACE \
642 TRADITIONAL_PIPELINE_INTERFACE DFA_PIPELINE_INTERFACE \
643 DBX_OUTPUT_STANDARD_TYPES BUILTIN_SETJMP_FRAME_VALUE \
644 SUNOS4_SHARED_LIBRARIES PROMOTE_FOR_CALL_ONLY
646 /* Hooks that are no longer used. */
647 #pragma GCC poison LANG_HOOKS_FUNCTION_MARK LANG_HOOKS_FUNCTION_FREE \
648 LANG_HOOKS_MARK_TREE LANG_HOOKS_INSERT_DEFAULT_ATTRIBUTES
650 /* Libiberty macros that are no longer used in GCC. */
651 #undef ANSI_PROTOTYPES
659 #pragma GCC poison ANSI_PROTOTYPES PTR_CONST LONG_DOUBLE VPARAMS VA_OPEN \
660 VA_FIXEDARG VA_CLOSE VA_START
663 /* Note: not all uses of the `index' token (e.g. variable names and
664 structure members) have been eliminated. */
669 #pragma GCC poison bcopy bzero bcmp rindex
671 #endif /* GCC >= 3.0 */
673 #endif /* ! GCC_SYSTEM_H */