1 /* Get common system includes and various definitions and declarations based
3 Copyright (C) 1998, 1999, 2000, 2001, 2002 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 #ifdef STRING_WITH_STRINGS
117 # include <strings.h>
119 # ifdef HAVE_STRING_H
122 # ifdef HAVE_STRINGS_H
123 # include <strings.h>
132 /* If we don't have an overriding definition, set SUCCESS_EXIT_CODE and
133 FATAL_EXIT_CODE to EXIT_SUCCESS and EXIT_FAILURE respectively,
134 or 0 and 1 if those macros are not defined. */
135 #ifndef SUCCESS_EXIT_CODE
137 # define SUCCESS_EXIT_CODE EXIT_SUCCESS
139 # define SUCCESS_EXIT_CODE 0
143 #ifndef FATAL_EXIT_CODE
145 # define FATAL_EXIT_CODE EXIT_FAILURE
147 # define FATAL_EXIT_CODE 1
155 #ifdef HAVE_SYS_PARAM_H
156 # include <sys/param.h>
157 /* We use this identifier later and it appears in some vendor param.h's. */
165 /* Get definitions of HOST_WIDE_INT and HOST_WIDEST_INT. */
168 /* A macro to determine whether a VALUE lies inclusively within a
169 certain range without evaluating the VALUE more than once. This
170 macro won't warn if the VALUE is unsigned and the LOWER bound is
171 zero, as it would e.g. with "VALUE >= 0 && ...". Note the LOWER
172 bound *is* evaluated twice, and LOWER must not be greater than
173 UPPER. However the bounds themselves can be either positive or
175 #define IN_RANGE(VALUE, LOWER, UPPER) \
176 ((unsigned HOST_WIDE_INT) ((VALUE) - (LOWER)) <= ((UPPER) - (LOWER)))
178 /* Infrastructure for defining missing _MAX and _MIN macros. Note that
179 macros defined with these cannot be used in #if. */
181 /* The extra casts work around common compiler bugs. */
182 #define INTTYPE_SIGNED(t) (! ((t) 0 < (t) -1))
183 /* The outer cast is needed to work around a bug in Cray C 5.0.3.0.
184 It is necessary at least when t == time_t. */
185 #define INTTYPE_MINIMUM(t) ((t) (INTTYPE_SIGNED (t) \
186 ? ~ (t) 0 << (sizeof(t) * CHAR_BIT - 1) : (t) 0))
187 #define INTTYPE_MAXIMUM(t) ((t) (~ (t) 0 - INTTYPE_MINIMUM (t)))
189 /* Use that infrastructure to provide a few constants. */
191 # define UCHAR_MAX INTTYPE_MAXIMUM (unsigned char)
194 #ifdef TIME_WITH_SYS_TIME
195 # include <sys/time.h>
199 # include <sys/time.h>
210 # ifdef HAVE_SYS_FILE_H
211 # include <sys/file.h>
233 /* Some systems define these in, e.g., param.h. We undefine these names
234 here to avoid the warnings. We prefer to use our definitions since we
235 know they are correct. */
239 #define MIN(X,Y) ((X) < (Y) ? (X) : (Y))
240 #define MAX(X,Y) ((X) > (Y) ? (X) : (Y))
242 /* Returns the least number N such that N * Y >= X. */
243 #define CEIL(x,y) (((x) + (y) - 1) / (y))
245 #ifdef HAVE_SYS_WAIT_H
246 #include <sys/wait.h>
250 #define WIFSIGNALED(S) (((S) & 0xff) != 0 && ((S) & 0xff) != 0x7f)
253 #define WTERMSIG(S) ((S) & 0x7f)
256 #define WIFEXITED(S) (((S) & 0xff) == 0)
259 #define WEXITSTATUS(S) (((S) & 0xff00) >> 8)
262 #define WSTOPSIG WEXITSTATUS
265 /* The HAVE_DECL_* macros are three-state, undefined, 0 or 1. If they
266 are defined to 0 then we must provide the relevant declaration
267 here. These checks will be in the undefined state while configure
268 is running so be careful to test "defined (HAVE_DECL_*)". */
270 #if defined (HAVE_DECL_ATOF) && !HAVE_DECL_ATOF
271 extern double atof
PARAMS ((const char *));
274 #if defined (HAVE_DECL_ATOL) && !HAVE_DECL_ATOL
275 extern long atol
PARAMS ((const char *));
278 #if defined (HAVE_DECL_FREE) && !HAVE_DECL_FREE
279 extern void free
PARAMS ((PTR
));
282 #if defined (HAVE_DECL_GETCWD) && !HAVE_DECL_GETCWD
283 extern char *getcwd
PARAMS ((char *, size_t));
286 #if defined (HAVE_DECL_GETENV) && !HAVE_DECL_GETENV
287 extern char *getenv
PARAMS ((const char *));
290 #if defined (HAVE_DECL_GETOPT) && !HAVE_DECL_GETOPT
291 extern int getopt
PARAMS ((int, char * const *, const char *));
294 #if defined (HAVE_DECL_GETWD) && !HAVE_DECL_GETWD
295 extern char *getwd
PARAMS ((char *));
298 #if defined (HAVE_DECL_SBRK) && !HAVE_DECL_SBRK
299 extern PTR sbrk
PARAMS ((int));
302 #if defined (HAVE_DECL_STRSTR) && !HAVE_DECL_STRSTR
303 extern char *strstr
PARAMS ((const char *, const char *));
310 #if defined (HAVE_DECL_MALLOC) && !HAVE_DECL_MALLOC
311 extern PTR malloc
PARAMS ((size_t));
314 #if defined (HAVE_DECL_CALLOC) && !HAVE_DECL_CALLOC
315 extern PTR calloc
PARAMS ((size_t, size_t));
318 #if defined (HAVE_DECL_REALLOC) && !HAVE_DECL_REALLOC
319 extern PTR realloc
PARAMS ((PTR
, size_t));
322 /* If the system doesn't provide strsignal, we get it defined in
323 libiberty but no declaration is supplied. */
324 #ifndef HAVE_STRSIGNAL
326 extern const char *strsignal
PARAMS ((int));
330 #ifdef HAVE_GETRLIMIT
331 # if defined (HAVE_DECL_GETRLIMIT) && !HAVE_DECL_GETRLIMIT
333 # ifdef ANSI_PROTOTYPES
336 extern int getrlimit
PARAMS ((int, struct rlimit
*));
341 #ifdef HAVE_SETRLIMIT
342 # if defined (HAVE_DECL_SETRLIMIT) && !HAVE_DECL_SETRLIMIT
344 # ifdef ANSI_PROTOTYPES
347 extern int setrlimit
PARAMS ((int, const struct rlimit
*));
352 /* HAVE_VOLATILE only refers to the stage1 compiler. We also check
353 __STDC__ and assume gcc sets it and has volatile in stage >=2. */
354 #if !defined(HAVE_VOLATILE) && !defined(__STDC__) && !defined(volatile)
358 #if defined (HAVE_DECL_ABORT) && !HAVE_DECL_ABORT
359 extern void abort
PARAMS ((void));
362 /* 1 if we have C99 designated initializers. */
363 #if !defined(HAVE_DESIGNATED_INITIALIZERS)
364 #define HAVE_DESIGNATED_INITIALIZERS \
365 ((GCC_VERSION >= 2007) || (__STDC_VERSION__ >= 199901L))
368 /* 1 if we have _Bool. */
370 # define HAVE__BOOL \
371 ((GCC_VERSION >= 3000) || (__STDC_VERSION__ >= 199901L))
376 # include <sys/stat.h>
379 /* Test if something is a normal file. */
381 #define S_ISREG(m) (((m) & S_IFMT) == S_IFREG)
384 /* Test if something is a directory. */
386 #define S_ISDIR(m) (((m) & S_IFMT) == S_IFDIR)
389 /* Test if something is a character special file. */
391 #define S_ISCHR(m) (((m) & S_IFMT) == S_IFCHR)
394 /* Test if something is a block special file. */
396 #define S_ISBLK(m) (((m) & S_IFMT) == S_IFBLK)
399 /* Test if something is a socket. */
402 # define S_ISSOCK(m) (((m) & S_IFMT) == S_IFSOCK)
404 # define S_ISSOCK(m) 0
408 /* Test if something is a FIFO. */
411 # define S_ISFIFO(m) (((m) & S_IFMT) == S_IFIFO)
413 # define S_ISFIFO(m) 0
417 /* Approximate O_NONBLOCK. */
419 #define O_NONBLOCK O_NDELAY
422 /* Approximate O_NOCTTY. */
427 /* Define well known filenos if the system does not define them. */
429 # define STDIN_FILENO 0
431 #ifndef STDOUT_FILENO
432 # define STDOUT_FILENO 1
434 #ifndef STDERR_FILENO
435 # define STDERR_FILENO 2
438 /* Some systems have mkdir that takes a single argument. */
439 #ifdef MKDIR_TAKES_ONE_ARG
440 # define mkdir(a,b) mkdir(a)
443 /* Provide a way to print an address via printf. */
444 #ifndef HOST_PTR_PRINTF
445 # ifdef HAVE_PRINTF_PTR
446 # define HOST_PTR_PRINTF "%p"
448 # define HOST_PTR_PRINTF \
449 (sizeof (int) == sizeof (char *) ? "%x" \
450 : sizeof (long) == sizeof (char *) ? "%lx" : "%llx")
452 #endif /* ! HOST_PTR_PRINTF */
454 /* By default, colon separates directories in a path. */
455 #ifndef PATH_SEPARATOR
456 #define PATH_SEPARATOR ':'
459 #ifndef DIR_SEPARATOR
460 #define DIR_SEPARATOR '/'
463 /* Define IS_DIR_SEPARATOR. */
464 #ifndef DIR_SEPARATOR_2
465 # define IS_DIR_SEPARATOR(CH) ((CH) == DIR_SEPARATOR)
466 #else /* DIR_SEPARATOR_2 */
467 # define IS_DIR_SEPARATOR(CH) \
468 (((CH) == DIR_SEPARATOR) || ((CH) == DIR_SEPARATOR_2))
469 #endif /* DIR_SEPARATOR_2 */
471 /* Say how to test for an absolute pathname. On Unix systems, this is if
472 it starts with a leading slash or a '$', the latter meaning the value of
473 an environment variable is to be used. On machine with DOS-based
474 file systems, it is also absolute if it starts with a drive identifier. */
475 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
476 #define IS_ABSOLUTE_PATHNAME(STR) \
477 (IS_DIR_SEPARATOR ((STR)[0]) || (STR)[0] == '$' \
478 || ((STR)[0] != '\0' && (STR)[1] == ':' && IS_DIR_SEPARATOR ((STR)[2])))
480 #define IS_ABSOLUTE_PATHNAME(STR) \
481 (IS_DIR_SEPARATOR ((STR)[0]) || (STR)[0] == '$')
484 /* Get libiberty declarations. */
485 #include "libiberty.h"
488 /* Provide a default for the HOST_BIT_BUCKET.
489 This suffices for POSIX-like hosts. */
491 #ifndef HOST_BIT_BUCKET
492 #define HOST_BIT_BUCKET "/dev/null"
495 /* Be conservative and only use enum bitfields with GCC.
496 FIXME: provide a complete autoconf test for buggy enum bitfields. */
498 #if (GCC_VERSION > 2000)
499 #define ENUM_BITFIELD(TYPE) enum TYPE
501 #define ENUM_BITFIELD(TYPE) unsigned int
505 #define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *) 0)->MEMBER)
508 /* Traditional C cannot initialize union members of structs. Provide
509 a macro which expands appropriately to handle it. This only works
510 if you intend to initialize the union member to zero since it relies
511 on default initialization to zero in the traditional C case. */
513 #define UNION_INIT_ZERO , {0}
515 #define UNION_INIT_ZERO
518 /* Various error reporting routines want to use __FUNCTION__. */
519 #if (GCC_VERSION < 2007)
521 #define __FUNCTION__ "?"
522 #endif /* ! __FUNCTION__ */
525 /* __builtin_expect(A, B) evaluates to A, but notifies the compiler that
526 the most likely value of A is B. This feature was added at some point
527 between 2.95 and 3.0. Let's use 3.0 as the lower bound for now. */
528 #if (GCC_VERSION < 3000)
529 #define __builtin_expect(a, b) (a)
532 /* Provide some sort of boolean type. We use stdbool.h if it's
533 available. This must be after all inclusion of system headers,
534 as some of them will mess us up. */
541 #ifdef HAVE_STDBOOL_H
542 # include <stdbool.h>
555 /* As the last action in this file, we poison the identifiers that
556 shouldn't be used. Note, luckily gcc-3.0's token-based integrated
557 preprocessor won't trip on poisoned identifiers that arrive from
558 the expansion of macros. E.g. #define strrchr rindex, won't error
559 if rindex is poisoned after this directive is issued and later on
562 Note: We define bypass macros for the few cases where we really
563 want to use the libc memory allocation routines. Otherwise we
564 insist you use the "x" versions from libiberty. */
566 #define really_call_malloc malloc
567 #define really_call_calloc calloc
568 #define really_call_realloc realloc
570 #if defined(FLEX_SCANNER) || defined(YYBISON)
571 /* Flex and bison use malloc and realloc. Yuk. Note that this means
572 really_call_* cannot be used in a .l or .y file. */
573 #define malloc xmalloc
574 #define realloc xrealloc
577 #if (GCC_VERSION >= 3000)
579 /* Note autoconf checks for prototype declarations and includes
580 system.h while doing so. Only poison these tokens if actually
581 compiling gcc, so that the autoconf declaration tests for malloc
582 etc don't spuriously fail. */
586 #pragma GCC poison calloc strdup
588 #if !defined(FLEX_SCANNER) && !defined(YYBISON)
591 #pragma GCC poison malloc realloc
594 /* Old target macros that have moved to the target hooks structure. */
595 #pragma GCC poison ASM_OPEN_PAREN ASM_CLOSE_PAREN \
596 FUNCTION_PROLOGUE FUNCTION_EPILOGUE \
597 FUNCTION_END_PROLOGUE FUNCTION_BEGIN_EPILOGUE \
598 DECL_MACHINE_ATTRIBUTES COMP_TYPE_ATTRIBUTES INSERT_ATTRIBUTES \
599 VALID_MACHINE_DECL_ATTRIBUTE VALID_MACHINE_TYPE_ATTRIBUTE \
600 SET_DEFAULT_TYPE_ATTRIBUTES SET_DEFAULT_DECL_ATTRIBUTES \
601 MERGE_MACHINE_TYPE_ATTRIBUTES MERGE_MACHINE_DECL_ATTRIBUTES \
602 MD_INIT_BUILTINS MD_EXPAND_BUILTIN ASM_OUTPUT_CONSTRUCTOR \
603 ASM_OUTPUT_DESTRUCTOR SIGNED_CHAR_SPEC MAX_CHAR_TYPE_SIZE \
604 WCHAR_UNSIGNED UNIQUE_SECTION SELECT_SECTION SELECT_RTX_SECTION \
605 ENCODE_SECTION_INFO STRIP_NAME_ENCODING ASM_GLOBALIZE_LABEL \
608 /* Other obsolete target macros, or macros that used to be in target
609 headers and were not used, and may be obsolete or may never have
611 #pragma GCC poison INT_ASM_OP ASM_OUTPUT_EH_REGION_BEG \
612 ASM_OUTPUT_EH_REGION_END ASM_OUTPUT_LABELREF_AS_INT \
613 DOESNT_NEED_UNWINDER EH_TABLE_LOOKUP OBJC_SELECTORS_WITHOUT_LABELS \
614 OMIT_EH_TABLE EASY_DIV_EXPR IMPLICIT_FIX_EXPR \
615 LONGJMP_RESTORE_FROM_STACK MAX_INT_TYPE_SIZE ASM_IDENTIFY_GCC \
616 STDC_VALUE TRAMPOLINE_ALIGN ASM_IDENTIFY_GCC_AFTER_SOURCE \
617 SLOW_ZERO_EXTEND SUBREG_REGNO_OFFSET DWARF_LINE_MIN_INSTR_LENGTH \
618 TRADITIONAL_RETURN_FLOAT NO_BUILTIN_SIZE_TYPE \
619 NO_BUILTIN_PTRDIFF_TYPE NO_BUILTIN_WCHAR_TYPE NO_BUILTIN_WINT_TYPE \
620 BLOCK_PROFILER BLOCK_PROFILER_CODE FUNCTION_BLOCK_PROFILER \
621 FUNCTION_BLOCK_PROFILER_EXIT MACHINE_STATE_SAVE \
622 MACHINE_STATE_RESTORE SCCS_DIRECTIVE SECTION_ASM_OP \
623 ASM_OUTPUT_DEFINE_LABEL_DIFFERENCE_SYMBOL ASM_OUTPUT_INTERNAL_LABEL
625 /* Hooks that are no longer used. */
626 #pragma GCC poison LANG_HOOKS_FUNCTION_MARK LANG_HOOKS_FUNCTION_FREE \
631 /* Note: not all uses of the `index' token (e.g. variable names and
632 structure members) have been eliminated. */
637 #pragma GCC poison bcopy bzero bcmp rindex
639 #endif /* GCC >= 3.0 */
641 #endif /* ! GCC_SYSTEM_H */