gcc/system.h

   1 /* Get common system includes and various definitions and declarations based
   2    on autoconf macros.
   3    Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2007
   4    Free Software Foundation, Inc.
   5
   6 This file is part of GCC.
   7
   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 3, or (at your option) any later
  11 version.
  12
  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
  16 for more details.
  17
  18 You should have received a copy of the GNU General Public License
  19 along with GCC; see the file COPYING3.  If not see
  20 <http://www.gnu.org/licenses/>.  */
  21
  22
  23 #ifndef GCC_SYSTEM_H
  24 #define GCC_SYSTEM_H
  25
  26 /* We must include stdarg.h before stdio.h.  */
  27 #include <stdarg.h>
  28
  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
  37 #ifdef HAVE_STDDEF_H
  38 # include <stddef.h>
  39 #endif
  40
  41 #include <stdio.h>
  42
  43 /* Define a generic NULL if one hasn't already been defined.  */
  44 #ifndef NULL
  45 #define NULL 0
  46 #endif
  47
  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
  53 /* The compiler is not a multi-threaded application and therefore we
  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).
  57
  58    HAVE_DECL_PUTC_UNLOCKED actually indicates whether or not the stdio
  59    code is multi-thread safe by default.  If it is set to 0, then do
  60    not worry about using the _unlocked functions.
  61
  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).  */
  65
  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
  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
  84 # ifdef HAVE_FPUTC_UNLOCKED
  85 #  undef fputc
  86 #  define fputc(C, Stream) fputc_unlocked (C, Stream)
  87 # endif
  88
  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
  93 extern 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
 100 extern 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
 107 extern 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
 114 extern 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
 121 extern 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
 128 extern char *fgets_unlocked (char *, int, FILE *);
 129 #  endif
 130 # endif
 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
 135 extern int fputs_unlocked (const char *, FILE *);
 136 #  endif
 137 # endif
 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
 142 extern 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
 149 extern size_t fread_unlocked (void *, size_t, size_t, FILE *);
 150 #  endif
 151 # endif
 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
 156 extern size_t fwrite_unlocked (const void *, size_t, size_t, FILE *);
 157 #  endif
 158 # endif
 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
 165 extern int fprintf_unlocked (FILE *, const char *, ...);
 166 #  endif
 167 # endif
 168
 169 #endif
 170
 171 /* ??? Glibc's fwrite/fread_unlocked macros cause
 172    "warning: signed and unsigned type in conditional expression".  */
 173 #undef fread_unlocked
 174 #undef fwrite_unlocked
 175
 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>
 180
 181 #include <sys/types.h>
 182
 183 #include <errno.h>
 184
 185 #if !defined (errno) && defined (HAVE_DECL_ERRNO) && !HAVE_DECL_ERRNO
 186 extern int errno;
 187 #endif
 188
 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
 193 #ifdef STRING_WITH_STRINGS
 194 # include <string.h>
 195 # include <strings.h>
 196 #else
 197 # ifdef HAVE_STRING_H
 198 #  include <string.h>
 199 # else
 200 #  ifdef HAVE_STRINGS_H
 201 #   include <strings.h>
 202 #  endif
 203 # endif
 204 #endif
 205
 206 #ifdef HAVE_STDLIB_H
 207 # include <stdlib.h>
 208 #endif
 209
 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
 229 #define ICE_EXIT_CODE 4
 230
 231 #ifdef HAVE_UNISTD_H
 232 # include <unistd.h>
 233 #endif
 234
 235 #ifdef HAVE_SYS_PARAM_H
 236 # include <sys/param.h>
 237 /* We use this identifier later and it appears in some vendor param.h's.  */
 238 # undef PREFETCH
 239 #endif
 240
 241 #if HAVE_LIMITS_H
 242 # include <limits.h>
 243 #endif
 244
 245 /* Get definitions of HOST_WIDE_INT and HOST_WIDEST_INT.  */
 246 #include "hwint.h"
 247
 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) \
 256   ((unsigned HOST_WIDE_INT)((VALUE) - (LOWER)) <= ((UPPER) - (LOWER)))
 257
 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
 274 #ifdef TIME_WITH_SYS_TIME
 275 # include <sys/time.h>
 276 # include <time.h>
 277 #else
 278 # if HAVE_SYS_TIME_H
 279 #  include <sys/time.h>
 280 # else
 281 #  ifdef HAVE_TIME_H
 282 #   include <time.h>
 283 #  endif
 284 # endif
 285 #endif
 286
 287 #ifdef HAVE_FCNTL_H
 288 # include <fcntl.h>
 289 #else
 290 # ifdef HAVE_SYS_FILE_H
 291 #  include <sys/file.h>
 292 # endif
 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
 306 #ifndef O_RDONLY
 307 # define O_RDONLY 0
 308 #endif
 309 #ifndef O_WRONLY
 310 # define O_WRONLY 1
 311 #endif
 312
 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
 322 /* Returns the least number N such that N * Y >= X.  */
 323 #define CEIL(x,y) (((x) + (y) - 1) / (y))
 324
 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
 341 #ifndef WSTOPSIG
 342 #define WSTOPSIG WEXITSTATUS
 343 #endif
 344 #ifndef WCOREDUMP
 345 #define WCOREDUMP(S) ((S) & WCOREFLG)
 346 #endif
 347 #ifndef WCOREFLG
 348 #define WCOREFLG 0200
 349 #endif
 350
 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_*)".  */
 355
 356 #if defined (HAVE_DECL_ATOF) && !HAVE_DECL_ATOF
 357 extern double atof (const char *);
 358 #endif
 359
 360 #if defined (HAVE_DECL_ATOL) && !HAVE_DECL_ATOL
 361 extern long atol (const char *);
 362 #endif
 363
 364 #if defined (HAVE_DECL_FREE) && !HAVE_DECL_FREE
 365 extern void free (void *);
 366 #endif
 367
 368 #if defined (HAVE_DECL_GETCWD) && !HAVE_DECL_GETCWD
 369 extern char *getcwd (char *, size_t);
 370 #endif
 371
 372 #if defined (HAVE_DECL_GETENV) && !HAVE_DECL_GETENV
 373 extern char *getenv (const char *);
 374 #endif
 375
 376 #if defined (HAVE_DECL_GETOPT) && !HAVE_DECL_GETOPT
 377 extern int getopt (int, char * const *, const char *);
 378 #endif
 379
 380 #if defined (HAVE_DECL_GETPAGESIZE) && !HAVE_DECL_GETPAGESIZE
 381 extern int getpagesize (void);
 382 #endif
 383
 384 #if defined (HAVE_DECL_GETWD) && !HAVE_DECL_GETWD
 385 extern char *getwd (char *);
 386 #endif
 387
 388 #if defined (HAVE_DECL_SBRK) && !HAVE_DECL_SBRK
 389 extern void *sbrk (int);
 390 #endif
 391
 392 #if defined (HAVE_DECL_STRSTR) && !HAVE_DECL_STRSTR
 393 extern char *strstr (const char *, const char *);
 394 #endif
 395
 396 #ifdef HAVE_MALLOC_H
 397 #include <malloc.h>
 398 #endif
 399
 400 #if defined (HAVE_DECL_MALLOC) && !HAVE_DECL_MALLOC
 401 extern void *malloc (size_t);
 402 #endif
 403
 404 #if defined (HAVE_DECL_CALLOC) && !HAVE_DECL_CALLOC
 405 extern void *calloc (size_t, size_t);
 406 #endif
 407
 408 #if defined (HAVE_DECL_REALLOC) && !HAVE_DECL_REALLOC
 409 extern void *realloc (void *, size_t);
 410 #endif
 411
 412 /* If the system doesn't provide strsignal, we get it defined in
 413    libiberty but no declaration is supplied.  */
 414 #if !defined (HAVE_STRSIGNAL) \
 415     || (defined (HAVE_DECL_STRSIGNAL) && !HAVE_DECL_STRSIGNAL)
 416 # ifndef strsignal
 417 extern const char *strsignal (int);
 418 # endif
 419 #endif
 420
 421 #ifdef HAVE_GETRLIMIT
 422 # if defined (HAVE_DECL_GETRLIMIT) && !HAVE_DECL_GETRLIMIT
 423 #  ifndef getrlimit
 424 struct rlimit;
 425 extern int getrlimit (int, struct rlimit *);
 426 #  endif
 427 # endif
 428 #endif
 429
 430 #ifdef HAVE_SETRLIMIT
 431 # if defined (HAVE_DECL_SETRLIMIT) && !HAVE_DECL_SETRLIMIT
 432 #  ifndef setrlimit
 433 struct rlimit;
 434 extern int setrlimit (int, const struct rlimit *);
 435 #  endif
 436 # endif
 437 #endif
 438
 439 #if defined (HAVE_DECL_ABORT) && !HAVE_DECL_ABORT
 440 extern void abort (void);
 441 #endif
 442
 443 #if defined (HAVE_DECL_SNPRINTF) && !HAVE_DECL_SNPRINTF
 444 extern int snprintf (char *, size_t, const char *, ...);
 445 #endif
 446
 447 #if defined (HAVE_DECL_VSNPRINTF) && !HAVE_DECL_VSNPRINTF
 448 extern int vsnprintf(char *, size_t, const char *, va_list);
 449 #endif
 450
 451 /* 1 if we have C99 designated initializers.  */
 452 #if !defined(HAVE_DESIGNATED_INITIALIZERS)
 453 #define HAVE_DESIGNATED_INITIALIZERS \
 454   ((GCC_VERSION >= 2007) || (__STDC_VERSION__ >= 199901L))
 455 #endif
 456
 457 #if HAVE_SYS_STAT_H
 458 # include <sys/stat.h>
 459 #endif
 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
 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
 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
 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
 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
 506 #ifndef STDERR_FILENO
 507 # define STDERR_FILENO  2
 508 #endif
 509
 510 /* Some systems have mkdir that takes a single argument.  */
 511 #ifdef MKDIR_TAKES_ONE_ARG
 512 # define mkdir(a,b) mkdir(a)
 513 #endif
 514
 515 /* By default, colon separates directories in a path.  */
 516 #ifndef PATH_SEPARATOR
 517 #define PATH_SEPARATOR ':'
 518 #endif
 519
 520 /* Filename handling macros.  */
 521 #include "filenames.h"
 522
 523 /* These should be phased out in favor of IS_DIR_SEPARATOR, where possible.  */
 524 #ifndef DIR_SEPARATOR
 525 # define DIR_SEPARATOR '/'
 526 # ifdef HAVE_DOS_BASED_FILE_SYSTEM
 527 #  define DIR_SEPARATOR_2 '\\'
 528 # endif
 529 #endif
 530
 531 /* Get libiberty declarations.  */
 532 #include "libiberty.h"
 533
 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
 541 /* Be conservative and only use enum bitfields with GCC.
 542    FIXME: provide a complete autoconf test for buggy enum bitfields.  */
 543
 544 #if (GCC_VERSION > 2000)
 545 #define ENUM_BITFIELD(TYPE) __extension__ enum TYPE
 546 #else
 547 #define ENUM_BITFIELD(TYPE) unsigned int
 548 #endif
 549
 550 #ifndef offsetof
 551 #define offsetof(TYPE, MEMBER)  ((size_t) &((TYPE *) 0)->MEMBER)
 552 #endif
 553
 554 /* Various error reporting routines want to use __FUNCTION__.  */
 555 #if (GCC_VERSION < 2007)
 556 #ifndef __FUNCTION__
 557 #define __FUNCTION__ "?"
 558 #endif /* ! __FUNCTION__ */
 559 #endif
 560
 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
 568 /* Redefine abort to report an internal error w/o coredump, and
 569    reporting the location of the error in the source file.  */
 570 extern void fancy_abort (const char *, int, const char *) ATTRIBUTE_NORETURN;
 571 #define abort() fancy_abort (__FILE__, __LINE__, __FUNCTION__)
 572
 573 /* Use gcc_assert(EXPR) to test invariants.  */
 574 #if ENABLE_ASSERT_CHECKING
 575 #define gcc_assert(EXPR)                                                \
 576    ((void)(!(EXPR) ? fancy_abort (__FILE__, __LINE__, __FUNCTION__), 0 : 0))
 577 #else
 578 /* Include EXPR, so that unused variable warnings do not occur.  */
 579 #define gcc_assert(EXPR) ((void)(0 && (EXPR)))
 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
 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,
 588    and even if it is, it is liable to be buggy.
 589    This must be after all inclusion of system headers, as some of
 590    them will mess us up.  */
 591
 592 #undef TRUE
 593 #undef FALSE
 594
 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 */
 612
 613 /* Some compilers do not allow the use of unsigned char in bitfields.  */
 614 #define BOOL_BITFIELD unsigned int
 615
 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
 631 #if defined(FLEX_SCANNER) || defined(YYBISON) || defined(YYBYACC)
 632 /* Flex and bison use malloc and realloc.  Yuk.  Note that this means
 633    really_call_* cannot be used in a .l or .y file.  */
 634 #define malloc xmalloc
 635 #define realloc xrealloc
 636 #endif
 637
 638 #if (GCC_VERSION >= 3000)
 639
 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
 645 #undef calloc
 646 #undef strdup
 647  #pragma GCC poison calloc strdup
 648
 649 #if !defined(FLEX_SCANNER) && !defined(YYBISON)
 650 #undef malloc
 651 #undef realloc
 652  #pragma GCC poison malloc realloc
 653 #endif
 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     \
 663         MD_INIT_BUILTINS MD_EXPAND_BUILTIN ASM_OUTPUT_CONSTRUCTOR       \
 664         ASM_OUTPUT_DESTRUCTOR SIGNED_CHAR_SPEC MAX_CHAR_TYPE_SIZE       \
 665         WCHAR_UNSIGNED UNIQUE_SECTION SELECT_SECTION SELECT_RTX_SECTION \
 666         ENCODE_SECTION_INFO STRIP_NAME_ENCODING ASM_GLOBALIZE_LABEL     \
 667         ASM_OUTPUT_MI_THUNK CONST_COSTS RTX_COSTS DEFAULT_RTX_COSTS     \
 668         ADDRESS_COST MACHINE_DEPENDENT_REORG ASM_FILE_START ASM_FILE_END \
 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   \
 672         MODDI3_LIBCALL UMODSI3_LIBCALL UMODDI3_LIBCALL BUILD_VA_LIST_TYPE \
 673         PRETEND_OUTGOING_VARARGS_NAMED STRUCT_VALUE_INCOMING_REGNUM     \
 674         ASM_OUTPUT_SECTION_NAME PROMOTE_FUNCTION_ARGS                   \
 675         STRUCT_VALUE_INCOMING STRICT_ARGUMENT_NAMING                    \
 676         PROMOTE_FUNCTION_RETURN PROMOTE_PROTOTYPES STRUCT_VALUE_REGNUM  \
 677         SETUP_INCOMING_VARARGS EXPAND_BUILTIN_SAVEREGS                  \
 678         DEFAULT_SHORT_ENUMS SPLIT_COMPLEX_ARGS MD_ASM_CLOBBERS          \
 679         HANDLE_PRAGMA_REDEFINE_EXTNAME HANDLE_PRAGMA_EXTERN_PREFIX      \
 680         MUST_PASS_IN_STACK FUNCTION_ARG_PASS_BY_REFERENCE               \
 681         VECTOR_MODE_SUPPORTED_P TARGET_SUPPORTS_HIDDEN                  \
 682         FUNCTION_ARG_PARTIAL_NREGS ASM_OUTPUT_DWARF_DTPREL              \
 683         ALLOCATE_INITIAL_VALUE
 684
 685 /* Other obsolete target macros, or macros that used to be in target
 686    headers and were not used, and may be obsolete or may never have
 687    been used.  */
 688  #pragma GCC poison INT_ASM_OP ASM_OUTPUT_EH_REGION_BEG CPP_PREDEFINES     \
 689         ASM_OUTPUT_EH_REGION_END ASM_OUTPUT_LABELREF_AS_INT SMALL_STACK    \
 690         DOESNT_NEED_UNWINDER EH_TABLE_LOOKUP OBJC_SELECTORS_WITHOUT_LABELS \
 691         OMIT_EH_TABLE EASY_DIV_EXPR IMPLICIT_FIX_EXPR                      \
 692         LONGJMP_RESTORE_FROM_STACK MAX_INT_TYPE_SIZE ASM_IDENTIFY_GCC      \
 693         STDC_VALUE TRAMPOLINE_ALIGN ASM_IDENTIFY_GCC_AFTER_SOURCE          \
 694         SLOW_ZERO_EXTEND SUBREG_REGNO_OFFSET DWARF_LINE_MIN_INSTR_LENGTH   \
 695         TRADITIONAL_RETURN_FLOAT NO_BUILTIN_SIZE_TYPE                      \
 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                    \
 699         MACHINE_STATE_RESTORE SCCS_DIRECTIVE SECTION_ASM_OP BYTEORDER      \
 700         ASM_OUTPUT_DEFINE_LABEL_DIFFERENCE_SYMBOL HOST_WORDS_BIG_ENDIAN    \
 701         OBJC_PROLOGUE ALLOCATE_TRAMPOLINE HANDLE_PRAGMA ROUND_TYPE_SIZE    \
 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             \
 705         INSN_CACHE_LINE_WIDTH INIT_SECTION_PREAMBLE NEED_ATEXIT ON_EXIT    \
 706         EXIT_BODY OBJECT_FORMAT_ROSE MULTIBYTE_CHARS MAP_CHARACTER         \
 707         LIBGCC_NEEDS_DOUBLE FINAL_PRESCAN_LABEL DEFAULT_CALLER_SAVES       \
 708         LOAD_ARGS_REVERSED MAX_INTEGER_COMPUTATION_MODE                    \
 709         CONVERT_HARD_REGISTER_TO_SSA_P ASM_OUTPUT_MAIN_SOURCE_FILENAME     \
 710         FIRST_INSN_ADDRESS TEXT_SECTION SHARED_BSS_SECTION_ASM_OP          \
 711         PROMOTED_MODE EXPAND_BUILTIN_VA_END                                \
 712         LINKER_DOES_NOT_WORK_WITH_DWARF2 FUNCTION_ARG_KEEP_AS_REFERENCE    \
 713         GIV_SORT_CRITERION MAX_LONG_TYPE_SIZE MAX_LONG_DOUBLE_TYPE_SIZE    \
 714         MAX_WCHAR_TYPE_SIZE SHARED_SECTION_ASM_OP INTEGRATE_THRESHOLD      \
 715         FINAL_REG_PARM_STACK_SPACE MAYBE_REG_PARM_STACK_SPACE              \
 716         TRADITIONAL_PIPELINE_INTERFACE DFA_PIPELINE_INTERFACE              \
 717         DBX_OUTPUT_STANDARD_TYPES BUILTIN_SETJMP_FRAME_VALUE               \
 718         SUNOS4_SHARED_LIBRARIES PROMOTE_FOR_CALL_ONLY                      \
 719         SPACE_AFTER_L_OPTION NO_RECURSIVE_FUNCTION_CSE                     \
 720         DEFAULT_MAIN_RETURN TARGET_MEM_FUNCTIONS EXPAND_BUILTIN_VA_ARG     \
 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          \
 724         PUT_SDB_SRC_FILE STABS_GCC_MARKER DBX_OUTPUT_FUNCTION_END          \
 725         DBX_OUTPUT_GCC_MARKER DBX_FINISH_SYMBOL SDB_GENERATE_FAKE          \
 726         NON_SAVING_SETJMP TARGET_LATE_RTL_PROLOGUE_EPILOGUE                \
 727         CASE_DROPS_THROUGH TARGET_BELL TARGET_BS TARGET_CR TARGET_DIGIT0   \
 728         TARGET_ESC TARGET_FF TARGET_NEWLINE TARGET_TAB TARGET_VT           \
 729         LINK_LIBGCC_SPECIAL DONT_ACCESS_GBLS_AFTER_EPILOGUE                \
 730         TARGET_OPTIONS TARGET_SWITCHES EXTRA_CC_MODES FINALIZE_PIC         \
 731         PREDICATE_CODES SPECIAL_MODE_PREDICATES HOST_PTR_PRINTF            \
 732         EXTRA_SECTIONS EXTRA_SECTION_FUNCTIONS READONLY_DATA_SECTION       \
 733         TARGET_ASM_EXCEPTION_SECTION TARGET_ASM_EH_FRAME_SECTION           \
 734         SMALL_ARG_MAX ASM_OUTPUT_SHARED_BSS ASM_OUTPUT_SHARED_COMMON       \
 735         ASM_OUTPUT_SHARED_LOCAL UNALIGNED_WORD_ASM_OP                      \
 736         ASM_MAKE_LABEL_LINKONCE
 737
 738 /* Hooks that are no longer used.  */
 739  #pragma GCC poison LANG_HOOKS_FUNCTION_MARK LANG_HOOKS_FUNCTION_FREE   \
 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 \
 744         LANG_HOOKS_POPLEVEL LANG_HOOKS_TRUTHVALUE_CONVERSION
 745
 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
 755  #pragma GCC poison ANSI_PROTOTYPES PTR_CONST LONG_DOUBLE VPARAMS VA_OPEN \
 756   VA_FIXEDARG VA_CLOSE VA_START
 757 #endif /* IN_GCC */
 758
 759 /* Note: not all uses of the `index' token (e.g. variable names and
 760    structure members) have been eliminated.  */
 761 #undef bcopy
 762 #undef bzero
 763 #undef bcmp
 764 #undef rindex
 765  #pragma GCC poison bcopy bzero bcmp rindex
 766
 767 #endif /* GCC >= 3.0 */
 768
 769 /* This macro allows casting away const-ness to pass -Wcast-qual
 770    warnings.  DO NOT USE THIS UNLESS YOU REALLY HAVE TO!  It should
 771    only be used in certain specific cases.  One valid case is where
 772    the C standard definitions or prototypes force you to.  E.g. if you
 773    need to free a const object, or if you pass a const string to
 774    execv, et al.  Another valid use would be in an allocation function
 775    that creates const objects that need to be initialized.  In some
 776    cases we have non-const functions that return the argument
 777    (e.g. next_nonnote_insn).  Rather than create const shadow
 778    functions, we can cast away const-ness in calling these interfaces
 779    if we're careful to verify that the called function does indeed not
 780    modify its argument and the return value is only used in a const
 781    context.  (This can be somewhat dangerous as these assumptions can
 782    change after the fact).  Beyond these uses, most other cases of
 783    using this macro should be viewed with extreme caution.  */
 784
 785 #if defined(__GNUC__) && GCC_VERSION != 4000
 786 /* GCC 4.0.x has a bug where it may ICE on this expression.  */
 787 #define CONST_CAST(X) ((__extension__(union {__typeof(X)_q; void *_v;})(X))._v)
 788 #else
 789 #define CONST_CAST(X) ((void*)(X))
 790 #endif
 791
 792 /* Activate -Wcast-qual as a warning (not an error/-Werror).  */
 793 #if GCC_VERSION >= 4003
 794 #pragma GCC diagnostic warning "-Wcast-qual"
 795 #endif
 796
 797 #endif /* ! GCC_SYSTEM_H */