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    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) - (unsigned HOST_WIDE_INT) (LOWER) \
 257    <= (unsigned HOST_WIDE_INT) (UPPER) - (unsigned HOST_WIDE_INT) (LOWER))
 258
 259 /* Infrastructure for defining missing _MAX and _MIN macros.  Note that
 260    macros defined with these cannot be used in #if.  */
 261
 262 /* The extra casts work around common compiler bugs.  */
 263 #define INTTYPE_SIGNED(t) (! ((t) 0 < (t) -1))
 264 /* The outer cast is needed to work around a bug in Cray C 5.0.3.0.
 265    It is necessary at least when t == time_t.  */
 266 #define INTTYPE_MINIMUM(t) ((t) (INTTYPE_SIGNED (t) \
 267                              ? ~ (t) 0 << (sizeof(t) * CHAR_BIT - 1) : (t) 0))
 268 #define INTTYPE_MAXIMUM(t) ((t) (~ (t) 0 - INTTYPE_MINIMUM (t)))
 269
 270 /* Use that infrastructure to provide a few constants.  */
 271 #ifndef UCHAR_MAX
 272 # define UCHAR_MAX INTTYPE_MAXIMUM (unsigned char)
 273 #endif
 274
 275 #ifdef TIME_WITH_SYS_TIME
 276 # include <sys/time.h>
 277 # include <time.h>
 278 #else
 279 # if HAVE_SYS_TIME_H
 280 #  include <sys/time.h>
 281 # else
 282 #  ifdef HAVE_TIME_H
 283 #   include <time.h>
 284 #  endif
 285 # endif
 286 #endif
 287
 288 #ifdef HAVE_FCNTL_H
 289 # include <fcntl.h>
 290 #else
 291 # ifdef HAVE_SYS_FILE_H
 292 #  include <sys/file.h>
 293 # endif
 294 #endif
 295
 296 #ifndef SEEK_SET
 297 # define SEEK_SET 0
 298 # define SEEK_CUR 1
 299 # define SEEK_END 2
 300 #endif
 301 #ifndef F_OK
 302 # define F_OK 0
 303 # define X_OK 1
 304 # define W_OK 2
 305 # define R_OK 4
 306 #endif
 307 #ifndef O_RDONLY
 308 # define O_RDONLY 0
 309 #endif
 310 #ifndef O_WRONLY
 311 # define O_WRONLY 1
 312 #endif
 313
 314 /* Some systems define these in, e.g., param.h.  We undefine these names
 315    here to avoid the warnings.  We prefer to use our definitions since we
 316    know they are correct.  */
 317
 318 #undef MIN
 319 #undef MAX
 320 #define MIN(X,Y) ((X) < (Y) ? (X) : (Y))
 321 #define MAX(X,Y) ((X) > (Y) ? (X) : (Y))
 322
 323 /* Returns the least number N such that N * Y >= X.  */
 324 #define CEIL(x,y) (((x) + (y) - 1) / (y))
 325
 326 #ifdef HAVE_SYS_WAIT_H
 327 #include <sys/wait.h>
 328 #endif
 329
 330 #ifndef WIFSIGNALED
 331 #define WIFSIGNALED(S) (((S) & 0xff) != 0 && ((S) & 0xff) != 0x7f)
 332 #endif
 333 #ifndef WTERMSIG
 334 #define WTERMSIG(S) ((S) & 0x7f)
 335 #endif
 336 #ifndef WIFEXITED
 337 #define WIFEXITED(S) (((S) & 0xff) == 0)
 338 #endif
 339 #ifndef WEXITSTATUS
 340 #define WEXITSTATUS(S) (((S) & 0xff00) >> 8)
 341 #endif
 342 #ifndef WSTOPSIG
 343 #define WSTOPSIG WEXITSTATUS
 344 #endif
 345 #ifndef WCOREDUMP
 346 #define WCOREDUMP(S) ((S) & WCOREFLG)
 347 #endif
 348 #ifndef WCOREFLG
 349 #define WCOREFLG 0200
 350 #endif
 351
 352 /* The HAVE_DECL_* macros are three-state, undefined, 0 or 1.  If they
 353    are defined to 0 then we must provide the relevant declaration
 354    here.  These checks will be in the undefined state while configure
 355    is running so be careful to test "defined (HAVE_DECL_*)".  */
 356
 357 #if defined (HAVE_DECL_ATOF) && !HAVE_DECL_ATOF
 358 extern double atof (const char *);
 359 #endif
 360
 361 #if defined (HAVE_DECL_ATOL) && !HAVE_DECL_ATOL
 362 extern long atol (const char *);
 363 #endif
 364
 365 #if defined (HAVE_DECL_FREE) && !HAVE_DECL_FREE
 366 extern void free (void *);
 367 #endif
 368
 369 #if defined (HAVE_DECL_GETCWD) && !HAVE_DECL_GETCWD
 370 extern char *getcwd (char *, size_t);
 371 #endif
 372
 373 #if defined (HAVE_DECL_GETENV) && !HAVE_DECL_GETENV
 374 extern char *getenv (const char *);
 375 #endif
 376
 377 #if defined (HAVE_DECL_GETOPT) && !HAVE_DECL_GETOPT
 378 extern int getopt (int, char * const *, const char *);
 379 #endif
 380
 381 #if defined (HAVE_DECL_GETPAGESIZE) && !HAVE_DECL_GETPAGESIZE
 382 extern int getpagesize (void);
 383 #endif
 384
 385 #if defined (HAVE_DECL_GETWD) && !HAVE_DECL_GETWD
 386 extern char *getwd (char *);
 387 #endif
 388
 389 #if defined (HAVE_DECL_SBRK) && !HAVE_DECL_SBRK
 390 extern void *sbrk (int);
 391 #endif
 392
 393 #if defined (HAVE_DECL_STRSTR) && !HAVE_DECL_STRSTR
 394 extern char *strstr (const char *, const char *);
 395 #endif
 396
 397 #ifdef HAVE_MALLOC_H
 398 #include <malloc.h>
 399 #endif
 400
 401 #if defined (HAVE_DECL_MALLOC) && !HAVE_DECL_MALLOC
 402 extern void *malloc (size_t);
 403 #endif
 404
 405 #if defined (HAVE_DECL_CALLOC) && !HAVE_DECL_CALLOC
 406 extern void *calloc (size_t, size_t);
 407 #endif
 408
 409 #if defined (HAVE_DECL_REALLOC) && !HAVE_DECL_REALLOC
 410 extern void *realloc (void *, size_t);
 411 #endif
 412
 413 /* If the system doesn't provide strsignal, we get it defined in
 414    libiberty but no declaration is supplied.  */
 415 #if !defined (HAVE_STRSIGNAL) \
 416     || (defined (HAVE_DECL_STRSIGNAL) && !HAVE_DECL_STRSIGNAL)
 417 # ifndef strsignal
 418 extern const char *strsignal (int);
 419 # endif
 420 #endif
 421
 422 #ifdef HAVE_GETRLIMIT
 423 # if defined (HAVE_DECL_GETRLIMIT) && !HAVE_DECL_GETRLIMIT
 424 #  ifndef getrlimit
 425 struct rlimit;
 426 extern int getrlimit (int, struct rlimit *);
 427 #  endif
 428 # endif
 429 #endif
 430
 431 #ifdef HAVE_SETRLIMIT
 432 # if defined (HAVE_DECL_SETRLIMIT) && !HAVE_DECL_SETRLIMIT
 433 #  ifndef setrlimit
 434 struct rlimit;
 435 extern int setrlimit (int, const struct rlimit *);
 436 #  endif
 437 # endif
 438 #endif
 439
 440 #if defined (HAVE_DECL_ABORT) && !HAVE_DECL_ABORT
 441 extern void abort (void);
 442 #endif
 443
 444 #if defined (HAVE_DECL_SNPRINTF) && !HAVE_DECL_SNPRINTF
 445 extern int snprintf (char *, size_t, const char *, ...);
 446 #endif
 447
 448 #if defined (HAVE_DECL_VSNPRINTF) && !HAVE_DECL_VSNPRINTF
 449 extern int vsnprintf(char *, size_t, const char *, va_list);
 450 #endif
 451
 452 /* 1 if we have C99 designated initializers.  */
 453 #if !defined(HAVE_DESIGNATED_INITIALIZERS)
 454 #define HAVE_DESIGNATED_INITIALIZERS \
 455   (((GCC_VERSION >= 2007) || (__STDC_VERSION__ >= 199901L)) \
 456    && !defined(__cplusplus))
 457 #endif
 458
 459 #if HAVE_SYS_STAT_H
 460 # include <sys/stat.h>
 461 #endif
 462
 463 /* Test if something is a normal file.  */
 464 #ifndef S_ISREG
 465 #define S_ISREG(m) (((m) & S_IFMT) == S_IFREG)
 466 #endif
 467
 468 /* Test if something is a directory.  */
 469 #ifndef S_ISDIR
 470 #define S_ISDIR(m) (((m) & S_IFMT) == S_IFDIR)
 471 #endif
 472
 473 /* Test if something is a character special file.  */
 474 #ifndef S_ISCHR
 475 #define S_ISCHR(m) (((m) & S_IFMT) == S_IFCHR)
 476 #endif
 477
 478 /* Test if something is a block special file.  */
 479 #ifndef S_ISBLK
 480 #define S_ISBLK(m) (((m) & S_IFMT) == S_IFBLK)
 481 #endif
 482
 483 /* Test if something is a socket.  */
 484 #ifndef S_ISSOCK
 485 # ifdef S_IFSOCK
 486 #   define S_ISSOCK(m) (((m) & S_IFMT) == S_IFSOCK)
 487 # else
 488 #   define S_ISSOCK(m) 0
 489 # endif
 490 #endif
 491
 492 /* Test if something is a FIFO.  */
 493 #ifndef S_ISFIFO
 494 # ifdef S_IFIFO
 495 #  define S_ISFIFO(m) (((m) & S_IFMT) == S_IFIFO)
 496 # else
 497 #  define S_ISFIFO(m) 0
 498 # endif
 499 #endif
 500
 501 /* Define well known filenos if the system does not define them.  */
 502 #ifndef STDIN_FILENO
 503 # define STDIN_FILENO   0
 504 #endif
 505 #ifndef STDOUT_FILENO
 506 # define STDOUT_FILENO  1
 507 #endif
 508 #ifndef STDERR_FILENO
 509 # define STDERR_FILENO  2
 510 #endif
 511
 512 /* Some systems have mkdir that takes a single argument.  */
 513 #ifdef MKDIR_TAKES_ONE_ARG
 514 # define mkdir(a,b) mkdir(a)
 515 #endif
 516
 517 /* By default, colon separates directories in a path.  */
 518 #ifndef PATH_SEPARATOR
 519 #define PATH_SEPARATOR ':'
 520 #endif
 521
 522 /* Filename handling macros.  */
 523 #include "filenames.h"
 524
 525 /* These should be phased out in favor of IS_DIR_SEPARATOR, where possible.  */
 526 #ifndef DIR_SEPARATOR
 527 # define DIR_SEPARATOR '/'
 528 # ifdef HAVE_DOS_BASED_FILE_SYSTEM
 529 #  define DIR_SEPARATOR_2 '\\'
 530 # endif
 531 #endif
 532
 533 /* Get libiberty declarations.  */
 534 #include "libiberty.h"
 535
 536 /* Provide a default for the HOST_BIT_BUCKET.
 537    This suffices for POSIX-like hosts.  */
 538
 539 #ifndef HOST_BIT_BUCKET
 540 #define HOST_BIT_BUCKET "/dev/null"
 541 #endif
 542
 543 /* Be conservative and only use enum bitfields with GCC.
 544    FIXME: provide a complete autoconf test for buggy enum bitfields.  */
 545
 546 #if (GCC_VERSION > 2000)
 547 #define ENUM_BITFIELD(TYPE) __extension__ enum TYPE
 548 #else
 549 #define ENUM_BITFIELD(TYPE) unsigned int
 550 #endif
 551
 552 #ifndef offsetof
 553 #define offsetof(TYPE, MEMBER)  ((size_t) &((TYPE *) 0)->MEMBER)
 554 #endif
 555
 556 /* Various error reporting routines want to use __FUNCTION__.  */
 557 #if (GCC_VERSION < 2007)
 558 #ifndef __FUNCTION__
 559 #define __FUNCTION__ "?"
 560 #endif /* ! __FUNCTION__ */
 561 #endif
 562
 563 /* __builtin_expect(A, B) evaluates to A, but notifies the compiler that
 564    the most likely value of A is B.  This feature was added at some point
 565    between 2.95 and 3.0.  Let's use 3.0 as the lower bound for now.  */
 566 #if (GCC_VERSION < 3000)
 567 #define __builtin_expect(a, b) (a)
 568 #endif
 569
 570 /* Redefine abort to report an internal error w/o coredump, and
 571    reporting the location of the error in the source file.  */
 572 extern void fancy_abort (const char *, int, const char *) ATTRIBUTE_NORETURN;
 573 #define abort() fancy_abort (__FILE__, __LINE__, __FUNCTION__)
 574
 575 /* Use gcc_assert(EXPR) to test invariants.  */
 576 #if ENABLE_ASSERT_CHECKING
 577 #define gcc_assert(EXPR)                                                \
 578    ((void)(!(EXPR) ? fancy_abort (__FILE__, __LINE__, __FUNCTION__), 0 : 0))
 579 #else
 580 /* Include EXPR, so that unused variable warnings do not occur.  */
 581 #define gcc_assert(EXPR) ((void)(0 && (EXPR)))
 582 #endif
 583
 584 /* Use gcc_unreachable() to mark unreachable locations (like an
 585    unreachable default case of a switch.  Do not use gcc_assert(0).  */
 586 #define gcc_unreachable() (fancy_abort (__FILE__, __LINE__, __FUNCTION__))
 587
 588 /* Provide a fake boolean type.  We make no attempt to use the
 589    C99 _Bool, as it may not be available in the bootstrap compiler,
 590    and even if it is, it is liable to be buggy.
 591    This must be after all inclusion of system headers, as some of
 592    them will mess us up.  */
 593
 594 #undef TRUE
 595 #undef FALSE
 596
 597 #ifdef __cplusplus
 598   /* Obsolete.  */
 599 # define TRUE true
 600 # define FALSE false
 601 #else /* !__cplusplus */
 602 # undef bool
 603 # undef true
 604 # undef false
 605
 606 # define bool unsigned char
 607 # define true 1
 608 # define false 0
 609
 610   /* Obsolete.  */
 611 # define TRUE true
 612 # define FALSE false
 613 #endif /* !__cplusplus */
 614
 615 /* Some compilers do not allow the use of unsigned char in bitfields.  */
 616 #define BOOL_BITFIELD unsigned int
 617
 618 /* As the last action in this file, we poison the identifiers that
 619    shouldn't be used.  Note, luckily gcc-3.0's token-based integrated
 620    preprocessor won't trip on poisoned identifiers that arrive from
 621    the expansion of macros.  E.g. #define strrchr rindex, won't error
 622    if rindex is poisoned after this directive is issued and later on
 623    strrchr is called.
 624
 625    Note: We define bypass macros for the few cases where we really
 626    want to use the libc memory allocation routines.  Otherwise we
 627    insist you use the "x" versions from libiberty.  */
 628
 629 #define really_call_malloc malloc
 630 #define really_call_calloc calloc
 631 #define really_call_realloc realloc
 632
 633 #if defined(FLEX_SCANNER) || defined(YYBISON) || defined(YYBYACC)
 634 /* Flex and bison use malloc and realloc.  Yuk.  Note that this means
 635    really_call_* cannot be used in a .l or .y file.  */
 636 #define malloc xmalloc
 637 #define realloc xrealloc
 638 #endif
 639
 640 #if (GCC_VERSION >= 3000)
 641
 642 /* Note autoconf checks for prototype declarations and includes
 643    system.h while doing so.  Only poison these tokens if actually
 644    compiling gcc, so that the autoconf declaration tests for malloc
 645    etc don't spuriously fail.  */
 646 #ifdef IN_GCC
 647 #undef calloc
 648 #undef strdup
 649  #pragma GCC poison calloc strdup
 650
 651 #if !defined(FLEX_SCANNER) && !defined(YYBISON)
 652 #undef malloc
 653 #undef realloc
 654  #pragma GCC poison malloc realloc
 655 #endif
 656
 657 /* Old target macros that have moved to the target hooks structure.  */
 658  #pragma GCC poison ASM_OPEN_PAREN ASM_CLOSE_PAREN                      \
 659         FUNCTION_PROLOGUE FUNCTION_EPILOGUE                             \
 660         FUNCTION_END_PROLOGUE FUNCTION_BEGIN_EPILOGUE                   \
 661         DECL_MACHINE_ATTRIBUTES COMP_TYPE_ATTRIBUTES INSERT_ATTRIBUTES  \
 662         VALID_MACHINE_DECL_ATTRIBUTE VALID_MACHINE_TYPE_ATTRIBUTE       \
 663         SET_DEFAULT_TYPE_ATTRIBUTES SET_DEFAULT_DECL_ATTRIBUTES         \
 664         MERGE_MACHINE_TYPE_ATTRIBUTES MERGE_MACHINE_DECL_ATTRIBUTES     \
 665         MD_INIT_BUILTINS MD_EXPAND_BUILTIN ASM_OUTPUT_CONSTRUCTOR       \
 666         ASM_OUTPUT_DESTRUCTOR SIGNED_CHAR_SPEC MAX_CHAR_TYPE_SIZE       \
 667         WCHAR_UNSIGNED UNIQUE_SECTION SELECT_SECTION SELECT_RTX_SECTION \
 668         ENCODE_SECTION_INFO STRIP_NAME_ENCODING ASM_GLOBALIZE_LABEL     \
 669         ASM_OUTPUT_MI_THUNK CONST_COSTS RTX_COSTS DEFAULT_RTX_COSTS     \
 670         ADDRESS_COST MACHINE_DEPENDENT_REORG ASM_FILE_START ASM_FILE_END \
 671         ASM_SIMPLIFY_DWARF_ADDR INIT_TARGET_OPTABS INIT_SUBTARGET_OPTABS \
 672         INIT_GOFAST_OPTABS MULSI3_LIBCALL MULDI3_LIBCALL DIVSI3_LIBCALL \
 673         DIVDI3_LIBCALL UDIVSI3_LIBCALL UDIVDI3_LIBCALL MODSI3_LIBCALL   \
 674         MODDI3_LIBCALL UMODSI3_LIBCALL UMODDI3_LIBCALL BUILD_VA_LIST_TYPE \
 675         PRETEND_OUTGOING_VARARGS_NAMED STRUCT_VALUE_INCOMING_REGNUM     \
 676         ASM_OUTPUT_SECTION_NAME PROMOTE_FUNCTION_ARGS                   \
 677         STRUCT_VALUE_INCOMING STRICT_ARGUMENT_NAMING                    \
 678         PROMOTE_FUNCTION_RETURN PROMOTE_PROTOTYPES STRUCT_VALUE_REGNUM  \
 679         SETUP_INCOMING_VARARGS EXPAND_BUILTIN_SAVEREGS                  \
 680         DEFAULT_SHORT_ENUMS SPLIT_COMPLEX_ARGS MD_ASM_CLOBBERS          \
 681         HANDLE_PRAGMA_REDEFINE_EXTNAME HANDLE_PRAGMA_EXTERN_PREFIX      \
 682         MUST_PASS_IN_STACK FUNCTION_ARG_PASS_BY_REFERENCE               \
 683         VECTOR_MODE_SUPPORTED_P TARGET_SUPPORTS_HIDDEN                  \
 684         FUNCTION_ARG_PARTIAL_NREGS ASM_OUTPUT_DWARF_DTPREL              \
 685         ALLOCATE_INITIAL_VALUE LEGITIMIZE_ADDRESS
 686
 687 /* Other obsolete target macros, or macros that used to be in target
 688    headers and were not used, and may be obsolete or may never have
 689    been used.  */
 690  #pragma GCC poison INT_ASM_OP ASM_OUTPUT_EH_REGION_BEG CPP_PREDEFINES     \
 691         ASM_OUTPUT_EH_REGION_END ASM_OUTPUT_LABELREF_AS_INT SMALL_STACK    \
 692         DOESNT_NEED_UNWINDER EH_TABLE_LOOKUP OBJC_SELECTORS_WITHOUT_LABELS \
 693         OMIT_EH_TABLE EASY_DIV_EXPR IMPLICIT_FIX_EXPR                      \
 694         LONGJMP_RESTORE_FROM_STACK MAX_INT_TYPE_SIZE ASM_IDENTIFY_GCC      \
 695         STDC_VALUE TRAMPOLINE_ALIGN ASM_IDENTIFY_GCC_AFTER_SOURCE          \
 696         SLOW_ZERO_EXTEND SUBREG_REGNO_OFFSET DWARF_LINE_MIN_INSTR_LENGTH   \
 697         TRADITIONAL_RETURN_FLOAT NO_BUILTIN_SIZE_TYPE                      \
 698         NO_BUILTIN_PTRDIFF_TYPE NO_BUILTIN_WCHAR_TYPE NO_BUILTIN_WINT_TYPE \
 699         BLOCK_PROFILER BLOCK_PROFILER_CODE FUNCTION_BLOCK_PROFILER         \
 700         FUNCTION_BLOCK_PROFILER_EXIT MACHINE_STATE_SAVE                    \
 701         MACHINE_STATE_RESTORE SCCS_DIRECTIVE SECTION_ASM_OP BYTEORDER      \
 702         ASM_OUTPUT_DEFINE_LABEL_DIFFERENCE_SYMBOL HOST_WORDS_BIG_ENDIAN    \
 703         OBJC_PROLOGUE ALLOCATE_TRAMPOLINE HANDLE_PRAGMA ROUND_TYPE_SIZE    \
 704         ROUND_TYPE_SIZE_UNIT CONST_SECTION_ASM_OP CRT_GET_RFIB_TEXT        \
 705         DBX_LBRAC_FIRST DBX_OUTPUT_ENUM DBX_OUTPUT_SOURCE_FILENAME         \
 706         DBX_WORKING_DIRECTORY INSN_CACHE_DEPTH INSN_CACHE_SIZE             \
 707         INSN_CACHE_LINE_WIDTH INIT_SECTION_PREAMBLE NEED_ATEXIT ON_EXIT    \
 708         EXIT_BODY OBJECT_FORMAT_ROSE MULTIBYTE_CHARS MAP_CHARACTER         \
 709         LIBGCC_NEEDS_DOUBLE FINAL_PRESCAN_LABEL DEFAULT_CALLER_SAVES       \
 710         LOAD_ARGS_REVERSED MAX_INTEGER_COMPUTATION_MODE                    \
 711         CONVERT_HARD_REGISTER_TO_SSA_P ASM_OUTPUT_MAIN_SOURCE_FILENAME     \
 712         FIRST_INSN_ADDRESS TEXT_SECTION SHARED_BSS_SECTION_ASM_OP          \
 713         PROMOTED_MODE EXPAND_BUILTIN_VA_END                                \
 714         LINKER_DOES_NOT_WORK_WITH_DWARF2 FUNCTION_ARG_KEEP_AS_REFERENCE    \
 715         GIV_SORT_CRITERION MAX_LONG_TYPE_SIZE MAX_LONG_DOUBLE_TYPE_SIZE    \
 716         MAX_WCHAR_TYPE_SIZE SHARED_SECTION_ASM_OP INTEGRATE_THRESHOLD      \
 717         FINAL_REG_PARM_STACK_SPACE MAYBE_REG_PARM_STACK_SPACE              \
 718         TRADITIONAL_PIPELINE_INTERFACE DFA_PIPELINE_INTERFACE              \
 719         DBX_OUTPUT_STANDARD_TYPES BUILTIN_SETJMP_FRAME_VALUE               \
 720         SUNOS4_SHARED_LIBRARIES PROMOTE_FOR_CALL_ONLY                      \
 721         SPACE_AFTER_L_OPTION NO_RECURSIVE_FUNCTION_CSE                     \
 722         DEFAULT_MAIN_RETURN TARGET_MEM_FUNCTIONS EXPAND_BUILTIN_VA_ARG     \
 723         COLLECT_PARSE_FLAG DWARF2_GENERATE_TEXT_SECTION_LABEL WINNING_GDB  \
 724         ASM_OUTPUT_FILENAME ASM_OUTPUT_SOURCE_LINE FILE_NAME_JOINER        \
 725         GDB_INV_REF_REGPARM_STABS_LETTER DBX_MEMPARM_STABS_LETTER          \
 726         PUT_SDB_SRC_FILE STABS_GCC_MARKER DBX_OUTPUT_FUNCTION_END          \
 727         DBX_OUTPUT_GCC_MARKER DBX_FINISH_SYMBOL SDB_GENERATE_FAKE          \
 728         NON_SAVING_SETJMP TARGET_LATE_RTL_PROLOGUE_EPILOGUE                \
 729         CASE_DROPS_THROUGH TARGET_BELL TARGET_BS TARGET_CR TARGET_DIGIT0   \
 730         TARGET_ESC TARGET_FF TARGET_NEWLINE TARGET_TAB TARGET_VT           \
 731         LINK_LIBGCC_SPECIAL DONT_ACCESS_GBLS_AFTER_EPILOGUE                \
 732         TARGET_OPTIONS TARGET_SWITCHES EXTRA_CC_MODES FINALIZE_PIC         \
 733         PREDICATE_CODES SPECIAL_MODE_PREDICATES HOST_PTR_PRINTF            \
 734         EXTRA_SECTIONS EXTRA_SECTION_FUNCTIONS READONLY_DATA_SECTION       \
 735         TARGET_ASM_EXCEPTION_SECTION TARGET_ASM_EH_FRAME_SECTION           \
 736         SMALL_ARG_MAX ASM_OUTPUT_SHARED_BSS ASM_OUTPUT_SHARED_COMMON       \
 737         ASM_OUTPUT_SHARED_LOCAL UNALIGNED_WORD_ASM_OP                      \
 738         ASM_MAKE_LABEL_LINKONCE
 739
 740 /* Hooks that are no longer used.  */
 741  #pragma GCC poison LANG_HOOKS_FUNCTION_MARK LANG_HOOKS_FUNCTION_FREE   \
 742         LANG_HOOKS_MARK_TREE LANG_HOOKS_INSERT_DEFAULT_ATTRIBUTES \
 743         LANG_HOOKS_TREE_INLINING_ESTIMATE_NUM_INSNS \
 744         LANG_HOOKS_PUSHLEVEL LANG_HOOKS_SET_BLOCK \
 745         LANG_HOOKS_MAYBE_BUILD_CLEANUP LANG_HOOKS_UPDATE_DECL_AFTER_SAVING \
 746         LANG_HOOKS_POPLEVEL LANG_HOOKS_TRUTHVALUE_CONVERSION
 747
 748 /* Miscellaneous macros that are no longer used.  */
 749  #pragma GCC poison USE_MAPPED_LOCATION
 750
 751 /* Libiberty macros that are no longer used in GCC.  */
 752 #undef ANSI_PROTOTYPES
 753 #undef PTR_CONST
 754 #undef LONG_DOUBLE
 755 #undef VPARAMS
 756 #undef VA_OPEN
 757 #undef VA_FIXEDARG
 758 #undef VA_CLOSE
 759 #undef VA_START
 760  #pragma GCC poison ANSI_PROTOTYPES PTR_CONST LONG_DOUBLE VPARAMS VA_OPEN \
 761   VA_FIXEDARG VA_CLOSE VA_START
 762 #endif /* IN_GCC */
 763
 764 /* Note: not all uses of the `index' token (e.g. variable names and
 765    structure members) have been eliminated.  */
 766 #undef bcopy
 767 #undef bzero
 768 #undef bcmp
 769 #undef rindex
 770  #pragma GCC poison bcopy bzero bcmp rindex
 771
 772 #endif /* GCC >= 3.0 */
 773
 774 /* This macro allows casting away const-ness to pass -Wcast-qual
 775    warnings.  DO NOT USE THIS UNLESS YOU REALLY HAVE TO!  It should
 776    only be used in certain specific cases.  One valid case is where
 777    the C standard definitions or prototypes force you to.  E.g. if you
 778    need to free a const object, or if you pass a const string to
 779    execv, et al.  Another valid use would be in an allocation function
 780    that creates const objects that need to be initialized.  In some
 781    cases we have non-const functions that return the argument
 782    (e.g. next_nonnote_insn).  Rather than create const shadow
 783    functions, we can cast away const-ness in calling these interfaces
 784    if we're careful to verify that the called function does indeed not
 785    modify its argument and the return value is only used in a const
 786    context.  (This can be somewhat dangerous as these assumptions can
 787    change after the fact).  Beyond these uses, most other cases of
 788    using this macro should be viewed with extreme caution.  */
 789
 790 #ifdef __cplusplus
 791 #define CONST_CAST2(TOTYPE,FROMTYPE,X) (const_cast<TOTYPE> (X))
 792 #else
 793 #if defined(__GNUC__) && GCC_VERSION > 4000
 794 /* GCC 4.0.x has a bug where it may ICE on this expression,
 795    so does GCC 3.4.x (PR17436).  */
 796 #define CONST_CAST2(TOTYPE,FROMTYPE,X) ((__extension__(union {FROMTYPE _q; TOTYPE _nq;})(X))._nq)
 797 #else
 798 #define CONST_CAST2(TOTYPE,FROMTYPE,X) ((TOTYPE)(FROMTYPE)(X))
 799 #endif
 800 #endif
 801 #define CONST_CAST(TYPE,X) CONST_CAST2(TYPE, const TYPE, (X))
 802 #define CONST_CAST_TREE(X) CONST_CAST(union tree_node *, (X))
 803 #define CONST_CAST_RTX(X) CONST_CAST(struct rtx_def *, (X))
 804 #define CONST_CAST_BB(X) CONST_CAST(struct basic_block_def *, (X))
 805 #define CONST_CAST_GIMPLE(X) CONST_CAST(union gimple_statement_d *, (X))
 806
 807 /* Activate certain diagnostics as warnings (not errors via the
 808    -Werror flag).  */
 809 #if GCC_VERSION >= 4003
 810 /* If asserts are disabled, activate -Wuninitialized as a warning (not
 811    an error/-Werror).  */
 812 #ifndef ENABLE_ASSERT_CHECKING
 813 #pragma GCC diagnostic warning "-Wuninitialized"
 814 #endif
 815 #endif
 816
 817 #ifdef ENABLE_VALGRIND_CHECKING
 818 # ifdef HAVE_VALGRIND_MEMCHECK_H
 819 #  include <valgrind/memcheck.h>
 820 # elif defined HAVE_MEMCHECK_H
 821 #  include <memcheck.h>
 822 # else
 823 #  include <valgrind.h>
 824 # endif
 825 /* Compatibility macros to let valgrind 3.1 work.  */
 826 # ifndef VALGRIND_MAKE_MEM_NOACCESS
 827 #  define VALGRIND_MAKE_MEM_NOACCESS VALGRIND_MAKE_NOACCESS
 828 # endif
 829 # ifndef VALGRIND_MAKE_MEM_DEFINED
 830 #  define VALGRIND_MAKE_MEM_DEFINED VALGRIND_MAKE_READABLE
 831 # endif
 832 # ifndef VALGRIND_MAKE_MEM_UNDEFINED
 833 #  define VALGRIND_MAKE_MEM_UNDEFINED VALGRIND_MAKE_WRITABLE
 834 # endif
 835 #else
 836 /* Avoid #ifdef:s when we can help it.  */
 837 #define VALGRIND_DISCARD(x)
 838 #define VALGRIND_MALLOCLIKE_BLOCK(w,x,y,z)
 839 #define VALGRIND_FREELIKE_BLOCK(x,y)
 840 #endif
 841
 842 #endif /* ! GCC_SYSTEM_H */