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, 2008,
   4    2009, 2010
   5    Free Software Foundation, Inc.
   6
   7 This file is part of GCC.
   8
   9 GCC is free software; you can redistribute it and/or modify it under
  10 the terms of the GNU General Public License as published by the Free
  11 Software Foundation; either version 3, or (at your option) any later
  12 version.
  13
  14 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  15 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  16 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  17 for more details.
  18
  19 You should have received a copy of the GNU General Public License
  20 along with GCC; see the file COPYING3.  If not see
  21 <http://www.gnu.org/licenses/>.  */
  22
  23
  24 #ifndef GCC_SYSTEM_H
  25 #define GCC_SYSTEM_H
  26
  27 /* We must include stdarg.h before stdio.h.  */
  28 #include <stdarg.h>
  29
  30 #ifndef va_copy
  31 # ifdef __va_copy
  32 #   define va_copy(d,s)  __va_copy((d),(s))
  33 # else
  34 #   define va_copy(d,s)  ((d) = (s))
  35 # endif
  36 #endif
  37
  38 #ifdef HAVE_STDDEF_H
  39 # include <stddef.h>
  40 #endif
  41
  42 #include <stdio.h>
  43
  44 /* Define a generic NULL if one hasn't already been defined.  */
  45 #ifndef NULL
  46 #define NULL 0
  47 #endif
  48
  49 /* Use the unlocked open routines from libiberty.  */
  50 #ifdef fopen /* fopen is a #define on VMS.  */
  51 #undef fopen
  52 #endif
  53 #define fopen(PATH,MODE) fopen_unlocked(PATH,MODE)
  54 #define fdopen(FILDES,MODE) fdopen_unlocked(FILDES,MODE)
  55 #define freopen(PATH,MODE,STREAM) freopen_unlocked(PATH,MODE,STREAM)
  56
  57 /* The compiler is not a multi-threaded application and therefore we
  58    do not have to use the locking functions.  In fact, using the locking
  59    functions can cause the compiler to be significantly slower under
  60    I/O bound conditions (such as -g -O0 on very large source files).
  61
  62    HAVE_DECL_PUTC_UNLOCKED actually indicates whether or not the stdio
  63    code is multi-thread safe by default.  If it is set to 0, then do
  64    not worry about using the _unlocked functions.
  65
  66    fputs_unlocked, fwrite_unlocked, and fprintf_unlocked are
  67    extensions and need to be prototyped by hand (since we do not
  68    define _GNU_SOURCE).  */
  69
  70 #if defined HAVE_DECL_PUTC_UNLOCKED && HAVE_DECL_PUTC_UNLOCKED
  71
  72 # ifdef HAVE_PUTC_UNLOCKED
  73 #  undef putc
  74 #  define putc(C, Stream) putc_unlocked (C, Stream)
  75 # endif
  76 # ifdef HAVE_PUTCHAR_UNLOCKED
  77 #  undef putchar
  78 #  define putchar(C) putchar_unlocked (C)
  79 # endif
  80 # ifdef HAVE_GETC_UNLOCKED
  81 #  undef getc
  82 #  define getc(Stream) getc_unlocked (Stream)
  83 # endif
  84 # ifdef HAVE_GETCHAR_UNLOCKED
  85 #  undef getchar
  86 #  define getchar() getchar_unlocked ()
  87 # endif
  88 # ifdef HAVE_FPUTC_UNLOCKED
  89 #  undef fputc
  90 #  define fputc(C, Stream) fputc_unlocked (C, Stream)
  91 # endif
  92
  93 # ifdef HAVE_CLEARERR_UNLOCKED
  94 #  undef clearerr
  95 #  define clearerr(Stream) clearerr_unlocked (Stream)
  96 #  if defined (HAVE_DECL_CLEARERR_UNLOCKED) && !HAVE_DECL_CLEARERR_UNLOCKED
  97 extern void clearerr_unlocked (FILE *);
  98 #  endif
  99 # endif
 100 # ifdef HAVE_FEOF_UNLOCKED
 101 #  undef feof
 102 #  define feof(Stream) feof_unlocked (Stream)
 103 #  if defined (HAVE_DECL_FEOF_UNLOCKED) && !HAVE_DECL_FEOF_UNLOCKED
 104 extern int feof_unlocked (FILE *);
 105 #  endif
 106 # endif
 107 # ifdef HAVE_FILENO_UNLOCKED
 108 #  undef fileno
 109 #  define fileno(Stream) fileno_unlocked (Stream)
 110 #  if defined (HAVE_DECL_FILENO_UNLOCKED) && !HAVE_DECL_FILENO_UNLOCKED
 111 extern int fileno_unlocked (FILE *);
 112 #  endif
 113 # endif
 114 # ifdef HAVE_FFLUSH_UNLOCKED
 115 #  undef fflush
 116 #  define fflush(Stream) fflush_unlocked (Stream)
 117 #  if defined (HAVE_DECL_FFLUSH_UNLOCKED) && !HAVE_DECL_FFLUSH_UNLOCKED
 118 extern int fflush_unlocked (FILE *);
 119 #  endif
 120 # endif
 121 # ifdef HAVE_FGETC_UNLOCKED
 122 #  undef fgetc
 123 #  define fgetc(Stream) fgetc_unlocked (Stream)
 124 #  if defined (HAVE_DECL_FGETC_UNLOCKED) && !HAVE_DECL_FGETC_UNLOCKED
 125 extern int fgetc_unlocked (FILE *);
 126 #  endif
 127 # endif
 128 # ifdef HAVE_FGETS_UNLOCKED
 129 #  undef fgets
 130 #  define fgets(S, n, Stream) fgets_unlocked (S, n, Stream)
 131 #  if defined (HAVE_DECL_FGETS_UNLOCKED) && !HAVE_DECL_FGETS_UNLOCKED
 132 extern char *fgets_unlocked (char *, int, FILE *);
 133 #  endif
 134 # endif
 135 # ifdef HAVE_FPUTS_UNLOCKED
 136 #  undef fputs
 137 #  define fputs(String, Stream) fputs_unlocked (String, Stream)
 138 #  if defined (HAVE_DECL_FPUTS_UNLOCKED) && !HAVE_DECL_FPUTS_UNLOCKED
 139 extern int fputs_unlocked (const char *, FILE *);
 140 #  endif
 141 # endif
 142 # ifdef HAVE_FERROR_UNLOCKED
 143 #  undef ferror
 144 #  define ferror(Stream) ferror_unlocked (Stream)
 145 #  if defined (HAVE_DECL_FERROR_UNLOCKED) && !HAVE_DECL_FERROR_UNLOCKED
 146 extern int ferror_unlocked (FILE *);
 147 #  endif
 148 # endif
 149 # ifdef HAVE_FREAD_UNLOCKED
 150 #  undef fread
 151 #  define fread(Ptr, Size, N, Stream) fread_unlocked (Ptr, Size, N, Stream)
 152 #  if defined (HAVE_DECL_FREAD_UNLOCKED) && !HAVE_DECL_FREAD_UNLOCKED
 153 extern size_t fread_unlocked (void *, size_t, size_t, FILE *);
 154 #  endif
 155 # endif
 156 # ifdef HAVE_FWRITE_UNLOCKED
 157 #  undef fwrite
 158 #  define fwrite(Ptr, Size, N, Stream) fwrite_unlocked (Ptr, Size, N, Stream)
 159 #  if defined (HAVE_DECL_FWRITE_UNLOCKED) && !HAVE_DECL_FWRITE_UNLOCKED
 160 extern size_t fwrite_unlocked (const void *, size_t, size_t, FILE *);
 161 #  endif
 162 # endif
 163 # ifdef HAVE_FPRINTF_UNLOCKED
 164 #  undef fprintf
 165 /* We can't use a function-like macro here because we don't know if
 166    we have varargs macros.  */
 167 #  define fprintf fprintf_unlocked
 168 #  if defined (HAVE_DECL_FPRINTF_UNLOCKED) && !HAVE_DECL_FPRINTF_UNLOCKED
 169 extern int fprintf_unlocked (FILE *, const char *, ...);
 170 #  endif
 171 # endif
 172
 173 #endif
 174
 175 /* ??? Glibc's fwrite/fread_unlocked macros cause
 176    "warning: signed and unsigned type in conditional expression".  */
 177 #undef fread_unlocked
 178 #undef fwrite_unlocked
 179
 180 /* There are an extraordinary number of issues with <ctype.h>.
 181    The last straw is that it varies with the locale.  Use libiberty's
 182    replacement instead.  */
 183 #include <safe-ctype.h>
 184
 185 #include <sys/types.h>
 186
 187 #include <errno.h>
 188
 189 #if !defined (errno) && defined (HAVE_DECL_ERRNO) && !HAVE_DECL_ERRNO
 190 extern int errno;
 191 #endif
 192
 193 /* Some of glibc's string inlines cause warnings.  Plus we'd rather
 194    rely on (and therefore test) GCC's string builtins.  */
 195 #define __NO_STRING_INLINES
 196
 197 #ifdef STRING_WITH_STRINGS
 198 # include <string.h>
 199 # include <strings.h>
 200 #else
 201 # ifdef HAVE_STRING_H
 202 #  include <string.h>
 203 # else
 204 #  ifdef HAVE_STRINGS_H
 205 #   include <strings.h>
 206 #  endif
 207 # endif
 208 #endif
 209
 210 #ifdef HAVE_STDLIB_H
 211 # include <stdlib.h>
 212 #endif
 213
 214 /* If we don't have an overriding definition, set SUCCESS_EXIT_CODE and
 215    FATAL_EXIT_CODE to EXIT_SUCCESS and EXIT_FAILURE respectively,
 216    or 0 and 1 if those macros are not defined.  */
 217 #ifndef SUCCESS_EXIT_CODE
 218 # ifdef EXIT_SUCCESS
 219 #  define SUCCESS_EXIT_CODE EXIT_SUCCESS
 220 # else
 221 #  define SUCCESS_EXIT_CODE 0
 222 # endif
 223 #endif
 224
 225 #ifndef FATAL_EXIT_CODE
 226 # ifdef EXIT_FAILURE
 227 #  define FATAL_EXIT_CODE EXIT_FAILURE
 228 # else
 229 #  define FATAL_EXIT_CODE 1
 230 # endif
 231 #endif
 232
 233 #define ICE_EXIT_CODE 4
 234
 235 #ifdef HAVE_UNISTD_H
 236 # include <unistd.h>
 237 #endif
 238
 239 #ifdef HAVE_SYS_PARAM_H
 240 # include <sys/param.h>
 241 /* We use this identifier later and it appears in some vendor param.h's.  */
 242 # undef PREFETCH
 243 #endif
 244
 245 #if HAVE_LIMITS_H
 246 # include <limits.h>
 247 #endif
 248
 249 /* Get definitions of HOST_WIDE_INT and HOST_WIDEST_INT.  */
 250 #include "hwint.h"
 251
 252 /* A macro to determine whether a VALUE lies inclusively within a
 253    certain range without evaluating the VALUE more than once.  This
 254    macro won't warn if the VALUE is unsigned and the LOWER bound is
 255    zero, as it would e.g. with "VALUE >= 0 && ...".  Note the LOWER
 256    bound *is* evaluated twice, and LOWER must not be greater than
 257    UPPER.  However the bounds themselves can be either positive or
 258    negative.  */
 259 #define IN_RANGE(VALUE, LOWER, UPPER) \
 260   ((unsigned HOST_WIDE_INT) (VALUE) - (unsigned HOST_WIDE_INT) (LOWER) \
 261    <= (unsigned HOST_WIDE_INT) (UPPER) - (unsigned HOST_WIDE_INT) (LOWER))
 262
 263 /* Infrastructure for defining missing _MAX and _MIN macros.  Note that
 264    macros defined with these cannot be used in #if.  */
 265
 266 /* The extra casts work around common compiler bugs.  */
 267 #define INTTYPE_SIGNED(t) (! ((t) 0 < (t) -1))
 268 /* The outer cast is needed to work around a bug in Cray C 5.0.3.0.
 269    It is necessary at least when t == time_t.  */
 270 #define INTTYPE_MINIMUM(t) ((t) (INTTYPE_SIGNED (t) \
 271                              ? ~ (t) 0 << (sizeof(t) * CHAR_BIT - 1) : (t) 0))
 272 #define INTTYPE_MAXIMUM(t) ((t) (~ (t) 0 - INTTYPE_MINIMUM (t)))
 273
 274 /* Use that infrastructure to provide a few constants.  */
 275 #ifndef UCHAR_MAX
 276 # define UCHAR_MAX INTTYPE_MAXIMUM (unsigned char)
 277 #endif
 278
 279 #ifdef TIME_WITH_SYS_TIME
 280 # include <sys/time.h>
 281 # include <time.h>
 282 #else
 283 # if HAVE_SYS_TIME_H
 284 #  include <sys/time.h>
 285 # else
 286 #  ifdef HAVE_TIME_H
 287 #   include <time.h>
 288 #  endif
 289 # endif
 290 #endif
 291
 292 #ifdef HAVE_FCNTL_H
 293 # include <fcntl.h>
 294 #else
 295 # ifdef HAVE_SYS_FILE_H
 296 #  include <sys/file.h>
 297 # endif
 298 #endif
 299
 300 #ifndef SEEK_SET
 301 # define SEEK_SET 0
 302 # define SEEK_CUR 1
 303 # define SEEK_END 2
 304 #endif
 305 #ifndef F_OK
 306 # define F_OK 0
 307 # define X_OK 1
 308 # define W_OK 2
 309 # define R_OK 4
 310 #endif
 311 #ifndef O_RDONLY
 312 # define O_RDONLY 0
 313 #endif
 314 #ifndef O_WRONLY
 315 # define O_WRONLY 1
 316 #endif
 317
 318 /* Some systems define these in, e.g., param.h.  We undefine these names
 319    here to avoid the warnings.  We prefer to use our definitions since we
 320    know they are correct.  */
 321
 322 #undef MIN
 323 #undef MAX
 324 #define MIN(X,Y) ((X) < (Y) ? (X) : (Y))
 325 #define MAX(X,Y) ((X) > (Y) ? (X) : (Y))
 326
 327 /* Returns the least number N such that N * Y >= X.  */
 328 #define CEIL(x,y) (((x) + (y) - 1) / (y))
 329
 330 #ifdef HAVE_SYS_WAIT_H
 331 #include <sys/wait.h>
 332 #endif
 333
 334 #ifndef WIFSIGNALED
 335 #define WIFSIGNALED(S) (((S) & 0xff) != 0 && ((S) & 0xff) != 0x7f)
 336 #endif
 337 #ifndef WTERMSIG
 338 #define WTERMSIG(S) ((S) & 0x7f)
 339 #endif
 340 #ifndef WIFEXITED
 341 #define WIFEXITED(S) (((S) & 0xff) == 0)
 342 #endif
 343 #ifndef WEXITSTATUS
 344 #define WEXITSTATUS(S) (((S) & 0xff00) >> 8)
 345 #endif
 346 #ifndef WSTOPSIG
 347 #define WSTOPSIG WEXITSTATUS
 348 #endif
 349 #ifndef WCOREDUMP
 350 #define WCOREDUMP(S) ((S) & WCOREFLG)
 351 #endif
 352 #ifndef WCOREFLG
 353 #define WCOREFLG 0200
 354 #endif
 355
 356 /* The HAVE_DECL_* macros are three-state, undefined, 0 or 1.  If they
 357    are defined to 0 then we must provide the relevant declaration
 358    here.  These checks will be in the undefined state while configure
 359    is running so be careful to test "defined (HAVE_DECL_*)".  */
 360
 361 #if defined (HAVE_DECL_ATOF) && !HAVE_DECL_ATOF
 362 extern double atof (const char *);
 363 #endif
 364
 365 #if defined (HAVE_DECL_ATOL) && !HAVE_DECL_ATOL
 366 extern long atol (const char *);
 367 #endif
 368
 369 #if defined (HAVE_DECL_FREE) && !HAVE_DECL_FREE
 370 extern void free (void *);
 371 #endif
 372
 373 #if defined (HAVE_DECL_GETCWD) && !HAVE_DECL_GETCWD
 374 extern char *getcwd (char *, size_t);
 375 #endif
 376
 377 #if defined (HAVE_DECL_GETENV) && !HAVE_DECL_GETENV
 378 extern char *getenv (const char *);
 379 #endif
 380
 381 #if defined (HAVE_DECL_GETOPT) && !HAVE_DECL_GETOPT
 382 extern int getopt (int, char * const *, const char *);
 383 #endif
 384
 385 #if defined (HAVE_DECL_GETPAGESIZE) && !HAVE_DECL_GETPAGESIZE
 386 extern int getpagesize (void);
 387 #endif
 388
 389 #if defined (HAVE_DECL_GETWD) && !HAVE_DECL_GETWD
 390 extern char *getwd (char *);
 391 #endif
 392
 393 #if defined (HAVE_DECL_SBRK) && !HAVE_DECL_SBRK
 394 extern void *sbrk (int);
 395 #endif
 396
 397 #if defined (HAVE_DECL_STRSTR) && !HAVE_DECL_STRSTR
 398 extern char *strstr (const char *, const char *);
 399 #endif
 400
 401 #ifdef HAVE_MALLOC_H
 402 #include <malloc.h>
 403 #endif
 404
 405 #if defined (HAVE_DECL_MALLOC) && !HAVE_DECL_MALLOC
 406 extern void *malloc (size_t);
 407 #endif
 408
 409 #if defined (HAVE_DECL_CALLOC) && !HAVE_DECL_CALLOC
 410 extern void *calloc (size_t, size_t);
 411 #endif
 412
 413 #if defined (HAVE_DECL_REALLOC) && !HAVE_DECL_REALLOC
 414 extern void *realloc (void *, size_t);
 415 #endif
 416
 417 #ifdef HAVE_STDINT_H
 418 #include <stdint.h>
 419 #endif
 420
 421 #ifdef HAVE_INTTYPES_H
 422 #include <inttypes.h>
 423 #endif
 424
 425 /* If the system doesn't provide strsignal, we get it defined in
 426    libiberty but no declaration is supplied.  */
 427 #if !defined (HAVE_STRSIGNAL) \
 428     || (defined (HAVE_DECL_STRSIGNAL) && !HAVE_DECL_STRSIGNAL)
 429 # ifndef strsignal
 430 extern const char *strsignal (int);
 431 # endif
 432 #endif
 433
 434 #ifdef HAVE_GETRLIMIT
 435 # if defined (HAVE_DECL_GETRLIMIT) && !HAVE_DECL_GETRLIMIT
 436 #  ifndef getrlimit
 437 struct rlimit;
 438 extern int getrlimit (int, struct rlimit *);
 439 #  endif
 440 # endif
 441 #endif
 442
 443 #ifdef HAVE_SETRLIMIT
 444 # if defined (HAVE_DECL_SETRLIMIT) && !HAVE_DECL_SETRLIMIT
 445 #  ifndef setrlimit
 446 struct rlimit;
 447 extern int setrlimit (int, const struct rlimit *);
 448 #  endif
 449 # endif
 450 #endif
 451
 452 #if defined (HAVE_DECL_ABORT) && !HAVE_DECL_ABORT
 453 extern void abort (void);
 454 #endif
 455
 456 #if defined (HAVE_DECL_SNPRINTF) && !HAVE_DECL_SNPRINTF
 457 extern int snprintf (char *, size_t, const char *, ...);
 458 #endif
 459
 460 #if defined (HAVE_DECL_VSNPRINTF) && !HAVE_DECL_VSNPRINTF
 461 extern int vsnprintf(char *, size_t, const char *, va_list);
 462 #endif
 463
 464 /* 1 if we have C99 designated initializers.  */
 465 #if !defined(HAVE_DESIGNATED_INITIALIZERS)
 466 #define HAVE_DESIGNATED_INITIALIZERS \
 467   (((GCC_VERSION >= 2007) || (__STDC_VERSION__ >= 199901L)) \
 468    && !defined(__cplusplus))
 469 #endif
 470
 471 #if HAVE_SYS_STAT_H
 472 # include <sys/stat.h>
 473 #endif
 474
 475 /* Test if something is a normal file.  */
 476 #ifndef S_ISREG
 477 #define S_ISREG(m) (((m) & S_IFMT) == S_IFREG)
 478 #endif
 479
 480 /* Test if something is a directory.  */
 481 #ifndef S_ISDIR
 482 #define S_ISDIR(m) (((m) & S_IFMT) == S_IFDIR)
 483 #endif
 484
 485 /* Test if something is a character special file.  */
 486 #ifndef S_ISCHR
 487 #define S_ISCHR(m) (((m) & S_IFMT) == S_IFCHR)
 488 #endif
 489
 490 /* Test if something is a block special file.  */
 491 #ifndef S_ISBLK
 492 #define S_ISBLK(m) (((m) & S_IFMT) == S_IFBLK)
 493 #endif
 494
 495 /* Test if something is a socket.  */
 496 #ifndef S_ISSOCK
 497 # ifdef S_IFSOCK
 498 #   define S_ISSOCK(m) (((m) & S_IFMT) == S_IFSOCK)
 499 # else
 500 #   define S_ISSOCK(m) 0
 501 # endif
 502 #endif
 503
 504 /* Test if something is a FIFO.  */
 505 #ifndef S_ISFIFO
 506 # ifdef S_IFIFO
 507 #  define S_ISFIFO(m) (((m) & S_IFMT) == S_IFIFO)
 508 # else
 509 #  define S_ISFIFO(m) 0
 510 # endif
 511 #endif
 512
 513 /* Define well known filenos if the system does not define them.  */
 514 #ifndef STDIN_FILENO
 515 # define STDIN_FILENO   0
 516 #endif
 517 #ifndef STDOUT_FILENO
 518 # define STDOUT_FILENO  1
 519 #endif
 520 #ifndef STDERR_FILENO
 521 # define STDERR_FILENO  2
 522 #endif
 523
 524 /* Some systems have mkdir that takes a single argument.  */
 525 #ifdef MKDIR_TAKES_ONE_ARG
 526 # define mkdir(a,b) mkdir(a)
 527 #endif
 528
 529 /* Provide a way to print an address via printf.  */
 530 #ifndef HOST_PTR_PRINTF
 531 #define HOST_PTR_PRINTF "%p"
 532 #endif /* ! HOST_PTR_PRINTF */
 533
 534 /* By default, colon separates directories in a path.  */
 535 #ifndef PATH_SEPARATOR
 536 #define PATH_SEPARATOR ':'
 537 #endif
 538
 539 /* Filename handling macros.  */
 540 #include "filenames.h"
 541
 542 /* These should be phased out in favor of IS_DIR_SEPARATOR, where possible.  */
 543 #ifndef DIR_SEPARATOR
 544 # define DIR_SEPARATOR '/'
 545 # ifdef HAVE_DOS_BASED_FILE_SYSTEM
 546 #  define DIR_SEPARATOR_2 '\\'
 547 # endif
 548 #endif
 549
 550 /* Get libiberty declarations.  */
 551 #include "libiberty.h"
 552
 553 /* Provide a default for the HOST_BIT_BUCKET.
 554    This suffices for POSIX-like hosts.  */
 555
 556 #ifndef HOST_BIT_BUCKET
 557 #define HOST_BIT_BUCKET "/dev/null"
 558 #endif
 559
 560 /* Be conservative and only use enum bitfields with GCC.
 561    FIXME: provide a complete autoconf test for buggy enum bitfields.  */
 562
 563 #if (GCC_VERSION > 2000)
 564 #define ENUM_BITFIELD(TYPE) __extension__ enum TYPE
 565 #else
 566 #define ENUM_BITFIELD(TYPE) unsigned int
 567 #endif
 568
 569 #ifndef offsetof
 570 #define offsetof(TYPE, MEMBER)  ((size_t) &((TYPE *) 0)->MEMBER)
 571 #endif
 572
 573 /* Various error reporting routines want to use __FUNCTION__.  */
 574 #if (GCC_VERSION < 2007)
 575 #ifndef __FUNCTION__
 576 #define __FUNCTION__ "?"
 577 #endif /* ! __FUNCTION__ */
 578 #endif
 579
 580 /* __builtin_expect(A, B) evaluates to A, but notifies the compiler that
 581    the most likely value of A is B.  This feature was added at some point
 582    between 2.95 and 3.0.  Let's use 3.0 as the lower bound for now.  */
 583 #if (GCC_VERSION < 3000)
 584 #define __builtin_expect(a, b) (a)
 585 #endif
 586
 587 /* Redefine abort to report an internal error w/o coredump, and
 588    reporting the location of the error in the source file.  */
 589 extern void fancy_abort (const char *, int, const char *) ATTRIBUTE_NORETURN;
 590 #define abort() fancy_abort (__FILE__, __LINE__, __FUNCTION__)
 591
 592 /* Use gcc_assert(EXPR) to test invariants.  */
 593 #if ENABLE_ASSERT_CHECKING
 594 #define gcc_assert(EXPR)                                                \
 595    ((void)(!(EXPR) ? fancy_abort (__FILE__, __LINE__, __FUNCTION__), 0 : 0))
 596 #elif (GCC_VERSION >= 4005)
 597 #define gcc_assert(EXPR)                                                \
 598   ((void)(__builtin_expect(!(EXPR), 0) ? __builtin_unreachable(), 0 : 0))
 599 #else
 600 /* Include EXPR, so that unused variable warnings do not occur.  */
 601 #define gcc_assert(EXPR) ((void)(0 && (EXPR)))
 602 #endif
 603
 604 #ifdef ENABLE_CHECKING
 605 #define gcc_checking_assert(EXPR) gcc_assert (EXPR)
 606 #else
 607 #define gcc_checking_assert(EXPR) ((void)(0 && (EXPR)))
 608 #endif
 609
 610 /* Use gcc_unreachable() to mark unreachable locations (like an
 611    unreachable default case of a switch.  Do not use gcc_assert(0).  */
 612 #if (GCC_VERSION >= 4005) && !ENABLE_ASSERT_CHECKING
 613 #define gcc_unreachable() __builtin_unreachable()
 614 #else
 615 #define gcc_unreachable() (fancy_abort (__FILE__, __LINE__, __FUNCTION__))
 616 #endif
 617
 618 /* Provide a fake boolean type.  We make no attempt to use the
 619    C99 _Bool, as it may not be available in the bootstrap compiler,
 620    and even if it is, it is liable to be buggy.
 621    This must be after all inclusion of system headers, as some of
 622    them will mess us up.  */
 623
 624 #undef TRUE
 625 #undef FALSE
 626
 627 #ifdef __cplusplus
 628   /* Obsolete.  */
 629 # define TRUE true
 630 # define FALSE false
 631 #else /* !__cplusplus */
 632 # undef bool
 633 # undef true
 634 # undef false
 635
 636 # define bool unsigned char
 637 # define true 1
 638 # define false 0
 639
 640   /* Obsolete.  */
 641 # define TRUE true
 642 # define FALSE false
 643 #endif /* !__cplusplus */
 644
 645 /* Some compilers do not allow the use of unsigned char in bitfields.  */
 646 #define BOOL_BITFIELD unsigned int
 647
 648 /* As the last action in this file, we poison the identifiers that
 649    shouldn't be used.  Note, luckily gcc-3.0's token-based integrated
 650    preprocessor won't trip on poisoned identifiers that arrive from
 651    the expansion of macros.  E.g. #define strrchr rindex, won't error
 652    if rindex is poisoned after this directive is issued and later on
 653    strrchr is called.
 654
 655    Note: We define bypass macros for the few cases where we really
 656    want to use the libc memory allocation routines.  Otherwise we
 657    insist you use the "x" versions from libiberty.  */
 658
 659 #define really_call_malloc malloc
 660 #define really_call_calloc calloc
 661 #define really_call_realloc realloc
 662
 663 #if defined(FLEX_SCANNER) || defined(YYBISON) || defined(YYBYACC)
 664 /* Flex and bison use malloc and realloc.  Yuk.  Note that this means
 665    really_call_* cannot be used in a .l or .y file.  */
 666 #define malloc xmalloc
 667 #define realloc xrealloc
 668 #endif
 669
 670 #if (GCC_VERSION >= 3000)
 671
 672 /* Note autoconf checks for prototype declarations and includes
 673    system.h while doing so.  Only poison these tokens if actually
 674    compiling gcc, so that the autoconf declaration tests for malloc
 675    etc don't spuriously fail.  */
 676 #ifdef IN_GCC
 677 #undef calloc
 678 #undef strdup
 679  #pragma GCC poison calloc strdup
 680
 681 #if !defined(FLEX_SCANNER) && !defined(YYBISON)
 682 #undef malloc
 683 #undef realloc
 684  #pragma GCC poison malloc realloc
 685 #endif
 686
 687 /* Old target macros that have moved to the target hooks structure.  */
 688  #pragma GCC poison ASM_OPEN_PAREN ASM_CLOSE_PAREN                      \
 689         FUNCTION_PROLOGUE FUNCTION_EPILOGUE                             \
 690         FUNCTION_END_PROLOGUE FUNCTION_BEGIN_EPILOGUE                   \
 691         DECL_MACHINE_ATTRIBUTES COMP_TYPE_ATTRIBUTES INSERT_ATTRIBUTES  \
 692         VALID_MACHINE_DECL_ATTRIBUTE VALID_MACHINE_TYPE_ATTRIBUTE       \
 693         SET_DEFAULT_TYPE_ATTRIBUTES SET_DEFAULT_DECL_ATTRIBUTES         \
 694         MERGE_MACHINE_TYPE_ATTRIBUTES MERGE_MACHINE_DECL_ATTRIBUTES     \
 695         MD_INIT_BUILTINS MD_EXPAND_BUILTIN ASM_OUTPUT_CONSTRUCTOR       \
 696         ASM_OUTPUT_DESTRUCTOR SIGNED_CHAR_SPEC MAX_CHAR_TYPE_SIZE       \
 697         WCHAR_UNSIGNED UNIQUE_SECTION SELECT_SECTION SELECT_RTX_SECTION \
 698         ENCODE_SECTION_INFO STRIP_NAME_ENCODING ASM_GLOBALIZE_LABEL     \
 699         ASM_OUTPUT_MI_THUNK CONST_COSTS RTX_COSTS DEFAULT_RTX_COSTS     \
 700         ADDRESS_COST MACHINE_DEPENDENT_REORG ASM_FILE_START ASM_FILE_END \
 701         ASM_SIMPLIFY_DWARF_ADDR INIT_TARGET_OPTABS INIT_SUBTARGET_OPTABS \
 702         INIT_GOFAST_OPTABS MULSI3_LIBCALL MULDI3_LIBCALL DIVSI3_LIBCALL \
 703         DIVDI3_LIBCALL UDIVSI3_LIBCALL UDIVDI3_LIBCALL MODSI3_LIBCALL   \
 704         MODDI3_LIBCALL UMODSI3_LIBCALL UMODDI3_LIBCALL BUILD_VA_LIST_TYPE \
 705         PRETEND_OUTGOING_VARARGS_NAMED STRUCT_VALUE_INCOMING_REGNUM     \
 706         ASM_OUTPUT_SECTION_NAME PROMOTE_FUNCTION_ARGS PROMOTE_FUNCTION_MODE \
 707         STRUCT_VALUE_INCOMING STRICT_ARGUMENT_NAMING                    \
 708         PROMOTE_FUNCTION_RETURN PROMOTE_PROTOTYPES STRUCT_VALUE_REGNUM  \
 709         SETUP_INCOMING_VARARGS EXPAND_BUILTIN_SAVEREGS                  \
 710         DEFAULT_SHORT_ENUMS SPLIT_COMPLEX_ARGS MD_ASM_CLOBBERS          \
 711         HANDLE_PRAGMA_REDEFINE_EXTNAME HANDLE_PRAGMA_EXTERN_PREFIX      \
 712         MUST_PASS_IN_STACK FUNCTION_ARG_PASS_BY_REFERENCE               \
 713         VECTOR_MODE_SUPPORTED_P TARGET_SUPPORTS_HIDDEN                  \
 714         FUNCTION_ARG_PARTIAL_NREGS ASM_OUTPUT_DWARF_DTPREL              \
 715         ALLOCATE_INITIAL_VALUE LEGITIMIZE_ADDRESS FRAME_POINTER_REQUIRED \
 716         CAN_ELIMINATE TRAMPOLINE_TEMPLATE INITIALIZE_TRAMPOLINE         \
 717         TRAMPOLINE_ADJUST_ADDRESS STATIC_CHAIN STATIC_CHAIN_INCOMING    \
 718         RETURN_POPS_ARGS
 719
 720 /* Other obsolete target macros, or macros that used to be in target
 721    headers and were not used, and may be obsolete or may never have
 722    been used.  */
 723  #pragma GCC poison INT_ASM_OP ASM_OUTPUT_EH_REGION_BEG CPP_PREDEFINES     \
 724         ASM_OUTPUT_EH_REGION_END ASM_OUTPUT_LABELREF_AS_INT SMALL_STACK    \
 725         DOESNT_NEED_UNWINDER EH_TABLE_LOOKUP OBJC_SELECTORS_WITHOUT_LABELS \
 726         OMIT_EH_TABLE EASY_DIV_EXPR IMPLICIT_FIX_EXPR                      \
 727         LONGJMP_RESTORE_FROM_STACK MAX_INT_TYPE_SIZE ASM_IDENTIFY_GCC      \
 728         STDC_VALUE TRAMPOLINE_ALIGN ASM_IDENTIFY_GCC_AFTER_SOURCE          \
 729         SLOW_ZERO_EXTEND SUBREG_REGNO_OFFSET DWARF_LINE_MIN_INSTR_LENGTH   \
 730         TRADITIONAL_RETURN_FLOAT NO_BUILTIN_SIZE_TYPE                      \
 731         NO_BUILTIN_PTRDIFF_TYPE NO_BUILTIN_WCHAR_TYPE NO_BUILTIN_WINT_TYPE \
 732         BLOCK_PROFILER BLOCK_PROFILER_CODE FUNCTION_BLOCK_PROFILER         \
 733         FUNCTION_BLOCK_PROFILER_EXIT MACHINE_STATE_SAVE                    \
 734         MACHINE_STATE_RESTORE SCCS_DIRECTIVE SECTION_ASM_OP BYTEORDER      \
 735         ASM_OUTPUT_DEFINE_LABEL_DIFFERENCE_SYMBOL HOST_WORDS_BIG_ENDIAN    \
 736         OBJC_PROLOGUE ALLOCATE_TRAMPOLINE HANDLE_PRAGMA ROUND_TYPE_SIZE    \
 737         ROUND_TYPE_SIZE_UNIT CONST_SECTION_ASM_OP CRT_GET_RFIB_TEXT        \
 738         DBX_LBRAC_FIRST DBX_OUTPUT_ENUM DBX_OUTPUT_SOURCE_FILENAME         \
 739         DBX_WORKING_DIRECTORY INSN_CACHE_DEPTH INSN_CACHE_SIZE             \
 740         INSN_CACHE_LINE_WIDTH INIT_SECTION_PREAMBLE NEED_ATEXIT ON_EXIT    \
 741         EXIT_BODY OBJECT_FORMAT_ROSE MULTIBYTE_CHARS MAP_CHARACTER         \
 742         LIBGCC_NEEDS_DOUBLE FINAL_PRESCAN_LABEL DEFAULT_CALLER_SAVES       \
 743         LOAD_ARGS_REVERSED MAX_INTEGER_COMPUTATION_MODE                    \
 744         CONVERT_HARD_REGISTER_TO_SSA_P ASM_OUTPUT_MAIN_SOURCE_FILENAME     \
 745         FIRST_INSN_ADDRESS TEXT_SECTION SHARED_BSS_SECTION_ASM_OP          \
 746         PROMOTED_MODE EXPAND_BUILTIN_VA_END                                \
 747         LINKER_DOES_NOT_WORK_WITH_DWARF2 FUNCTION_ARG_KEEP_AS_REFERENCE    \
 748         GIV_SORT_CRITERION MAX_LONG_TYPE_SIZE MAX_LONG_DOUBLE_TYPE_SIZE    \
 749         MAX_WCHAR_TYPE_SIZE SHARED_SECTION_ASM_OP INTEGRATE_THRESHOLD      \
 750         FINAL_REG_PARM_STACK_SPACE MAYBE_REG_PARM_STACK_SPACE              \
 751         TRADITIONAL_PIPELINE_INTERFACE DFA_PIPELINE_INTERFACE              \
 752         DBX_OUTPUT_STANDARD_TYPES BUILTIN_SETJMP_FRAME_VALUE               \
 753         SUNOS4_SHARED_LIBRARIES PROMOTE_FOR_CALL_ONLY                      \
 754         SPACE_AFTER_L_OPTION NO_RECURSIVE_FUNCTION_CSE                     \
 755         DEFAULT_MAIN_RETURN TARGET_MEM_FUNCTIONS EXPAND_BUILTIN_VA_ARG     \
 756         COLLECT_PARSE_FLAG DWARF2_GENERATE_TEXT_SECTION_LABEL WINNING_GDB  \
 757         ASM_OUTPUT_FILENAME ASM_OUTPUT_SOURCE_LINE FILE_NAME_JOINER        \
 758         GDB_INV_REF_REGPARM_STABS_LETTER DBX_MEMPARM_STABS_LETTER          \
 759         PUT_SDB_SRC_FILE STABS_GCC_MARKER DBX_OUTPUT_FUNCTION_END          \
 760         DBX_OUTPUT_GCC_MARKER DBX_FINISH_SYMBOL SDB_GENERATE_FAKE          \
 761         NON_SAVING_SETJMP TARGET_LATE_RTL_PROLOGUE_EPILOGUE                \
 762         CASE_DROPS_THROUGH TARGET_BELL TARGET_BS TARGET_CR TARGET_DIGIT0   \
 763         TARGET_ESC TARGET_FF TARGET_NEWLINE TARGET_TAB TARGET_VT           \
 764         LINK_LIBGCC_SPECIAL DONT_ACCESS_GBLS_AFTER_EPILOGUE                \
 765         TARGET_OPTIONS TARGET_SWITCHES EXTRA_CC_MODES FINALIZE_PIC         \
 766         PREDICATE_CODES SPECIAL_MODE_PREDICATES UNALIGNED_WORD_ASM_OP      \
 767         EXTRA_SECTIONS EXTRA_SECTION_FUNCTIONS READONLY_DATA_SECTION       \
 768         TARGET_ASM_EXCEPTION_SECTION TARGET_ASM_EH_FRAME_SECTION           \
 769         SMALL_ARG_MAX ASM_OUTPUT_SHARED_BSS ASM_OUTPUT_SHARED_COMMON       \
 770         ASM_OUTPUT_SHARED_LOCAL ASM_MAKE_LABEL_LINKONCE                    \
 771         STACK_CHECK_PROBE_INTERVAL STACK_CHECK_PROBE_LOAD                  \
 772         ORDER_REGS_FOR_LOCAL_ALLOC FUNCTION_OUTGOING_VALUE                 \
 773         ASM_DECLARE_CONSTANT_NAME MODIFY_TARGET_NAME SWITCHES_NEED_SPACES
 774
 775 /* Hooks that are no longer used.  */
 776  #pragma GCC poison LANG_HOOKS_FUNCTION_MARK LANG_HOOKS_FUNCTION_FREE   \
 777         LANG_HOOKS_MARK_TREE LANG_HOOKS_INSERT_DEFAULT_ATTRIBUTES \
 778         LANG_HOOKS_TREE_INLINING_ESTIMATE_NUM_INSNS \
 779         LANG_HOOKS_PUSHLEVEL LANG_HOOKS_SET_BLOCK \
 780         LANG_HOOKS_MAYBE_BUILD_CLEANUP LANG_HOOKS_UPDATE_DECL_AFTER_SAVING \
 781         LANG_HOOKS_POPLEVEL LANG_HOOKS_TRUTHVALUE_CONVERSION \
 782         TARGET_PROMOTE_FUNCTION_ARGS TARGET_PROMOTE_FUNCTION_RETURN
 783
 784 /* Miscellaneous macros that are no longer used.  */
 785  #pragma GCC poison USE_MAPPED_LOCATION
 786
 787 /* Libiberty macros that are no longer used in GCC.  */
 788 #undef ANSI_PROTOTYPES
 789 #undef PTR_CONST
 790 #undef LONG_DOUBLE
 791 #undef VPARAMS
 792 #undef VA_OPEN
 793 #undef VA_FIXEDARG
 794 #undef VA_CLOSE
 795 #undef VA_START
 796  #pragma GCC poison ANSI_PROTOTYPES PTR_CONST LONG_DOUBLE VPARAMS VA_OPEN \
 797   VA_FIXEDARG VA_CLOSE VA_START
 798 #endif /* IN_GCC */
 799
 800 /* Front ends should never have to include middle-end headers.  Enforce
 801    this by poisoning the header double-include protection defines.  */
 802 #ifdef IN_GCC_FRONTEND
 803 #pragma GCC poison GCC_RTL_H GCC_EXCEPT_H GCC_EXPR_H
 804 #endif
 805
 806 /* Note: not all uses of the `index' token (e.g. variable names and
 807    structure members) have been eliminated.  */
 808 #undef bcopy
 809 #undef bzero
 810 #undef bcmp
 811 #undef rindex
 812  #pragma GCC poison bcopy bzero bcmp rindex
 813
 814 #endif /* GCC >= 3.0 */
 815
 816 /* This macro allows casting away const-ness to pass -Wcast-qual
 817    warnings.  DO NOT USE THIS UNLESS YOU REALLY HAVE TO!  It should
 818    only be used in certain specific cases.  One valid case is where
 819    the C standard definitions or prototypes force you to.  E.g. if you
 820    need to free a const object, or if you pass a const string to
 821    execv, et al.  Another valid use would be in an allocation function
 822    that creates const objects that need to be initialized.  In some
 823    cases we have non-const functions that return the argument
 824    (e.g. next_nonnote_insn).  Rather than create const shadow
 825    functions, we can cast away const-ness in calling these interfaces
 826    if we're careful to verify that the called function does indeed not
 827    modify its argument and the return value is only used in a const
 828    context.  (This can be somewhat dangerous as these assumptions can
 829    change after the fact).  Beyond these uses, most other cases of
 830    using this macro should be viewed with extreme caution.  */
 831
 832 #ifdef __cplusplus
 833 #define CONST_CAST2(TOTYPE,FROMTYPE,X) (const_cast<TOTYPE> (X))
 834 #else
 835 #if defined(__GNUC__) && GCC_VERSION > 4000
 836 /* GCC 4.0.x has a bug where it may ICE on this expression,
 837    so does GCC 3.4.x (PR17436).  */
 838 #define CONST_CAST2(TOTYPE,FROMTYPE,X) ((__extension__(union {FROMTYPE _q; TOTYPE _nq;})(X))._nq)
 839 #elif defined(__GNUC__)
 840 static inline char *
 841 helper_const_non_const_cast (const char *p)
 842 {
 843   union {
 844     const char *const_c;
 845     char *c;
 846   } val;
 847   val.const_c = p;
 848   return val.c;
 849 }
 850
 851 #define CONST_CAST2(TOTYPE,FROMTYPE,X) \
 852         ((TOTYPE) helper_const_non_const_cast ((const char *) (FROMTYPE) (X)))
 853 #else
 854 #define CONST_CAST2(TOTYPE,FROMTYPE,X) ((TOTYPE)(FROMTYPE)(X))
 855 #endif
 856 #endif
 857 #define CONST_CAST(TYPE,X) CONST_CAST2(TYPE, const TYPE, (X))
 858 #define CONST_CAST_TREE(X) CONST_CAST(union tree_node *, (X))
 859 #define CONST_CAST_RTX(X) CONST_CAST(struct rtx_def *, (X))
 860 #define CONST_CAST_BB(X) CONST_CAST(struct basic_block_def *, (X))
 861 #define CONST_CAST_GIMPLE(X) CONST_CAST(union gimple_statement_d *, (X))
 862
 863 /* Activate certain diagnostics as warnings (not errors via the
 864    -Werror flag).  */
 865 #if GCC_VERSION >= 4003
 866 /* If asserts are disabled, activate -Wuninitialized as a warning (not
 867    an error/-Werror).  */
 868 #ifndef ENABLE_ASSERT_CHECKING
 869 #pragma GCC diagnostic warning "-Wuninitialized"
 870 #endif
 871 #endif
 872
 873 #ifdef ENABLE_VALGRIND_CHECKING
 874 # ifdef HAVE_VALGRIND_MEMCHECK_H
 875 #  include <valgrind/memcheck.h>
 876 # elif defined HAVE_MEMCHECK_H
 877 #  include <memcheck.h>
 878 # else
 879 #  include <valgrind.h>
 880 # endif
 881 /* Compatibility macros to let valgrind 3.1 work.  */
 882 # ifndef VALGRIND_MAKE_MEM_NOACCESS
 883 #  define VALGRIND_MAKE_MEM_NOACCESS VALGRIND_MAKE_NOACCESS
 884 # endif
 885 # ifndef VALGRIND_MAKE_MEM_DEFINED
 886 #  define VALGRIND_MAKE_MEM_DEFINED VALGRIND_MAKE_READABLE
 887 # endif
 888 # ifndef VALGRIND_MAKE_MEM_UNDEFINED
 889 #  define VALGRIND_MAKE_MEM_UNDEFINED VALGRIND_MAKE_WRITABLE
 890 # endif
 891 #else
 892 /* Avoid #ifdef:s when we can help it.  */
 893 #define VALGRIND_DISCARD(x)
 894 #define VALGRIND_MALLOCLIKE_BLOCK(w,x,y,z)
 895 #define VALGRIND_FREELIKE_BLOCK(x,y)
 896 #endif
 897
 898 /* In LTO -fwhole-program build we still want to keep the debug functions available
 899    for debugger.  Mark them as used to prevent removal.  */
 900 #if (GCC_VERSION > 4000)
 901 #define DEBUG_FUNCTION __attribute__ ((__used__))
 902 #define DEBUG_VARIABLE __attribute__ ((__used__))
 903 #else
 904 #define DEBUG_FUNCTION
 905 #define DEBUG_VARIABLE
 906 #endif
 907
 908 #endif /* ! GCC_SYSTEM_H */