gcc/system.h

   1 /* Get common system includes and various definitions and declarations based
   2    on autoconf macros.
   3    Copyright (C) 1998-2021 Free Software Foundation, Inc.
   4
   5 This file is part of GCC.
   6
   7 GCC is free software; you can redistribute it and/or modify it under
   8 the terms of the GNU General Public License as published by the Free
   9 Software Foundation; either version 3, or (at your option) any later
  10 version.
  11
  12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  15 for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with GCC; see the file COPYING3.  If not see
  19 <http://www.gnu.org/licenses/>.  */
  20
  21
  22 #ifndef GCC_SYSTEM_H
  23 #define GCC_SYSTEM_H
  24
  25 /* Define this so that inttypes.h defines the PRI?64 macros even
  26    when compiling with a C++ compiler.  Define it here so in the
  27    event inttypes.h gets pulled in by another header it is already
  28    defined.  */
  29 #define __STDC_FORMAT_MACROS
  30
  31 /* We must include stdarg.h before stdio.h.  */
  32 #include <stdarg.h>
  33
  34 #ifndef va_copy
  35 # ifdef __va_copy
  36 #   define va_copy(d,s)  __va_copy (d, s)
  37 # else
  38 #   define va_copy(d,s)  ((d) = (s))
  39 # endif
  40 #endif
  41
  42 #ifdef HAVE_STDDEF_H
  43 # include <stddef.h>
  44 #endif
  45
  46 #include <stdio.h>
  47
  48 /* Define a generic NULL if one hasn't already been defined.  */
  49 #ifndef NULL
  50 #define NULL 0
  51 #endif
  52
  53 /* Use the unlocked open routines from libiberty.  */
  54
  55 /* Some of these are #define on some systems, e.g. on AIX to redirect
  56    the names to 64bit capable functions for LARGE_FILES support. These
  57    redefs are pointless here so we can override them.  */
  58
  59 #undef fopen
  60 #undef freopen
  61
  62 #define fopen(PATH, MODE) fopen_unlocked (PATH, MODE)
  63 #define fdopen(FILDES, MODE) fdopen_unlocked (FILDES, MODE)
  64 #define freopen(PATH, MODE, STREAM) freopen_unlocked (PATH, MODE, STREAM)
  65
  66 /* The compiler is not a multi-threaded application and therefore we
  67    do not have to use the locking functions.  In fact, using the locking
  68    functions can cause the compiler to be significantly slower under
  69    I/O bound conditions (such as -g -O0 on very large source files).
  70
  71    HAVE_DECL_PUTC_UNLOCKED actually indicates whether or not the stdio
  72    code is multi-thread safe by default.  If it is set to 0, then do
  73    not worry about using the _unlocked functions.
  74
  75    fputs_unlocked, fwrite_unlocked, and fprintf_unlocked are
  76    extensions and need to be prototyped by hand (since we do not
  77    define _GNU_SOURCE).  */
  78
  79 #if defined HAVE_DECL_PUTC_UNLOCKED && HAVE_DECL_PUTC_UNLOCKED
  80
  81 # ifdef HAVE_PUTC_UNLOCKED
  82 #  undef putc
  83 #  define putc(C, Stream) putc_unlocked (C, Stream)
  84 # endif
  85 # ifdef HAVE_PUTCHAR_UNLOCKED
  86 #  undef putchar
  87 #  define putchar(C) putchar_unlocked (C)
  88 # endif
  89 # ifdef HAVE_GETC_UNLOCKED
  90 #  undef getc
  91 #  define getc(Stream) getc_unlocked (Stream)
  92 # endif
  93 # ifdef HAVE_GETCHAR_UNLOCKED
  94 #  undef getchar
  95 #  define getchar() getchar_unlocked ()
  96 # endif
  97 # ifdef HAVE_FPUTC_UNLOCKED
  98 #  undef fputc
  99 #  define fputc(C, Stream) fputc_unlocked (C, Stream)
 100 # endif
 101
 102 #ifdef __cplusplus
 103 extern "C" {
 104 #endif
 105
 106 # ifdef HAVE_CLEARERR_UNLOCKED
 107 #  undef clearerr
 108 #  define clearerr(Stream) clearerr_unlocked (Stream)
 109 #  if defined (HAVE_DECL_CLEARERR_UNLOCKED) && !HAVE_DECL_CLEARERR_UNLOCKED
 110 extern void clearerr_unlocked (FILE *);
 111 #  endif
 112 # endif
 113 # ifdef HAVE_FEOF_UNLOCKED
 114 #  undef feof
 115 #  define feof(Stream) feof_unlocked (Stream)
 116 #  if defined (HAVE_DECL_FEOF_UNLOCKED) && !HAVE_DECL_FEOF_UNLOCKED
 117 extern int feof_unlocked (FILE *);
 118 #  endif
 119 # endif
 120 # ifdef HAVE_FILENO_UNLOCKED
 121 #  undef fileno
 122 #  define fileno(Stream) fileno_unlocked (Stream)
 123 #  if defined (HAVE_DECL_FILENO_UNLOCKED) && !HAVE_DECL_FILENO_UNLOCKED
 124 extern int fileno_unlocked (FILE *);
 125 #  endif
 126 # endif
 127 # ifdef HAVE_FFLUSH_UNLOCKED
 128 #  undef fflush
 129 #  define fflush(Stream) fflush_unlocked (Stream)
 130 #  if defined (HAVE_DECL_FFLUSH_UNLOCKED) && !HAVE_DECL_FFLUSH_UNLOCKED
 131 extern int fflush_unlocked (FILE *);
 132 #  endif
 133 # endif
 134 # ifdef HAVE_FGETC_UNLOCKED
 135 #  undef fgetc
 136 #  define fgetc(Stream) fgetc_unlocked (Stream)
 137 #  if defined (HAVE_DECL_FGETC_UNLOCKED) && !HAVE_DECL_FGETC_UNLOCKED
 138 extern int fgetc_unlocked (FILE *);
 139 #  endif
 140 # endif
 141 # ifdef HAVE_FGETS_UNLOCKED
 142 #  undef fgets
 143 #  define fgets(S, n, Stream) fgets_unlocked (S, n, Stream)
 144 #  if defined (HAVE_DECL_FGETS_UNLOCKED) && !HAVE_DECL_FGETS_UNLOCKED
 145 extern char *fgets_unlocked (char *, int, FILE *);
 146 #  endif
 147 # endif
 148 # ifdef HAVE_FPUTS_UNLOCKED
 149 #  undef fputs
 150 #  define fputs(String, Stream) fputs_unlocked (String, Stream)
 151 #  if defined (HAVE_DECL_FPUTS_UNLOCKED) && !HAVE_DECL_FPUTS_UNLOCKED
 152 extern int fputs_unlocked (const char *, FILE *);
 153 #  endif
 154 # endif
 155 # ifdef HAVE_FERROR_UNLOCKED
 156 #  undef ferror
 157 #  define ferror(Stream) ferror_unlocked (Stream)
 158 #  if defined (HAVE_DECL_FERROR_UNLOCKED) && !HAVE_DECL_FERROR_UNLOCKED
 159 extern int ferror_unlocked (FILE *);
 160 #  endif
 161 # endif
 162 # ifdef HAVE_FREAD_UNLOCKED
 163 #  undef fread
 164 #  define fread(Ptr, Size, N, Stream) fread_unlocked (Ptr, Size, N, Stream)
 165 #  if defined (HAVE_DECL_FREAD_UNLOCKED) && !HAVE_DECL_FREAD_UNLOCKED
 166 extern size_t fread_unlocked (void *, size_t, size_t, FILE *);
 167 #  endif
 168 # endif
 169 # ifdef HAVE_FWRITE_UNLOCKED
 170 #  undef fwrite
 171 #  define fwrite(Ptr, Size, N, Stream) fwrite_unlocked (Ptr, Size, N, Stream)
 172 #  if defined (HAVE_DECL_FWRITE_UNLOCKED) && !HAVE_DECL_FWRITE_UNLOCKED
 173 extern size_t fwrite_unlocked (const void *, size_t, size_t, FILE *);
 174 #  endif
 175 # endif
 176 # ifdef HAVE_FPRINTF_UNLOCKED
 177 #  undef fprintf
 178 /* We can't use a function-like macro here because we don't know if
 179    we have varargs macros.  */
 180 #  define fprintf fprintf_unlocked
 181 #  if defined (HAVE_DECL_FPRINTF_UNLOCKED) && !HAVE_DECL_FPRINTF_UNLOCKED
 182 extern int fprintf_unlocked (FILE *, const char *, ...);
 183 #  endif
 184 # endif
 185
 186 #ifdef __cplusplus
 187 }
 188 #endif
 189
 190 #endif
 191
 192 /* ??? Glibc's fwrite/fread_unlocked macros cause
 193    "warning: signed and unsigned type in conditional expression".  */
 194 #undef fread_unlocked
 195 #undef fwrite_unlocked
 196
 197 /* Include <string> before "safe-ctype.h" to avoid GCC poisoning
 198    the ctype macros through safe-ctype.h */
 199
 200 #ifdef __cplusplus
 201 #ifdef INCLUDE_STRING
 202 # include <string>
 203 #endif
 204 #endif
 205
 206 /* There are an extraordinary number of issues with <ctype.h>.
 207    The last straw is that it varies with the locale.  Use libiberty's
 208    replacement instead.  */
 209 #include "safe-ctype.h"
 210
 211 #include <sys/types.h>
 212
 213 #include <errno.h>
 214
 215 #if !defined (errno) && defined (HAVE_DECL_ERRNO) && !HAVE_DECL_ERRNO
 216 extern int errno;
 217 #endif
 218
 219 #ifdef __cplusplus
 220 #if defined (INCLUDE_ALGORITHM) || !defined (HAVE_SWAP_IN_UTILITY)
 221 # include <algorithm>
 222 #endif
 223 #ifdef INCLUDE_LIST
 224 # include <list>
 225 #endif
 226 #ifdef INCLUDE_MAP
 227 # include <map>
 228 #endif
 229 #ifdef INCLUDE_SET
 230 # include <set>
 231 #endif
 232 #ifdef INCLUDE_VECTOR
 233 # include <vector>
 234 #endif
 235 #ifdef INCLUDE_ARRAY
 236 # include <array>
 237 #endif
 238 #ifdef INCLUDE_FUNCTIONAL
 239 # include <functional>
 240 #endif
 241 # include <cstring>
 242 # include <new>
 243 # include <utility>
 244 # include <type_traits>
 245 #endif
 246
 247 /* Some of glibc's string inlines cause warnings.  Plus we'd rather
 248    rely on (and therefore test) GCC's string builtins.  */
 249 #define __NO_STRING_INLINES
 250
 251 #ifdef STRING_WITH_STRINGS
 252 # include <string.h>
 253 # include <strings.h>
 254 #else
 255 # ifdef HAVE_STRING_H
 256 #  include <string.h>
 257 # else
 258 #  ifdef HAVE_STRINGS_H
 259 #   include <strings.h>
 260 #  endif
 261 # endif
 262 #endif
 263
 264 #ifdef HAVE_STDLIB_H
 265 # include <stdlib.h>
 266 #endif
 267
 268 /* When compiling C++ we need to include <cstdlib> as well as <stdlib.h> so
 269    that it is processed before we poison "malloc"; otherwise, if a source
 270    file uses a standard library header that includes <cstdlib>, we will get
 271    an error about 'using std::malloc'.  */
 272 #ifdef __cplusplus
 273 #include <cstdlib>
 274 #endif
 275
 276 /* Undef vec_free from AIX stdlib.h header which conflicts with vec.h.  */
 277 #undef vec_free
 278
 279 /* If we don't have an overriding definition, set SUCCESS_EXIT_CODE and
 280    FATAL_EXIT_CODE to EXIT_SUCCESS and EXIT_FAILURE respectively,
 281    or 0 and 1 if those macros are not defined.  */
 282 #ifndef SUCCESS_EXIT_CODE
 283 # ifdef EXIT_SUCCESS
 284 #  define SUCCESS_EXIT_CODE EXIT_SUCCESS
 285 # else
 286 #  define SUCCESS_EXIT_CODE 0
 287 # endif
 288 #endif
 289
 290 #ifndef FATAL_EXIT_CODE
 291 # ifdef EXIT_FAILURE
 292 #  define FATAL_EXIT_CODE EXIT_FAILURE
 293 # else
 294 #  define FATAL_EXIT_CODE 1
 295 # endif
 296 #endif
 297
 298 #define ICE_EXIT_CODE 4
 299
 300 #ifdef HAVE_UNISTD_H
 301 # include <unistd.h>
 302 #endif
 303
 304 #ifdef HAVE_SYS_PARAM_H
 305 # include <sys/param.h>
 306 /* We use these identifiers later and they appear in some vendor param.h's.  */
 307 # undef PREFETCH
 308 # undef m_slot
 309 #endif
 310
 311 #if HAVE_LIMITS_H
 312 # include <limits.h>
 313 #endif
 314
 315 /* A macro to determine whether a VALUE lies inclusively within a
 316    certain range without evaluating the VALUE more than once.  This
 317    macro won't warn if the VALUE is unsigned and the LOWER bound is
 318    zero, as it would e.g. with "VALUE >= 0 && ...".  Note the LOWER
 319    bound *is* evaluated twice, and LOWER must not be greater than
 320    UPPER.  However the bounds themselves can be either positive or
 321    negative.  */
 322 #define IN_RANGE(VALUE, LOWER, UPPER) \
 323   ((unsigned HOST_WIDE_INT) (VALUE) - (unsigned HOST_WIDE_INT) (LOWER) \
 324    <= (unsigned HOST_WIDE_INT) (UPPER) - (unsigned HOST_WIDE_INT) (LOWER))
 325
 326 /* Infrastructure for defining missing _MAX and _MIN macros.  Note that
 327    macros defined with these cannot be used in #if.  */
 328
 329 /* The extra casts work around common compiler bugs.  */
 330 #define INTTYPE_SIGNED(t) (! ((t) 0 < (t) -1))
 331 /* The outer cast is needed to work around a bug in Cray C 5.0.3.0.
 332    It is necessary at least when t == time_t.  */
 333 #define INTTYPE_MINIMUM(t) ((t) (INTTYPE_SIGNED (t) \
 334                             ? (t) 1 << (sizeof (t) * CHAR_BIT - 1) : (t) 0))
 335 #define INTTYPE_MAXIMUM(t) ((t) (~ (t) 0 - INTTYPE_MINIMUM (t)))
 336
 337 /* Use that infrastructure to provide a few constants.  */
 338 #ifndef UCHAR_MAX
 339 # define UCHAR_MAX INTTYPE_MAXIMUM (unsigned char)
 340 #endif
 341
 342 #ifdef TIME_WITH_SYS_TIME
 343 # include <sys/time.h>
 344 # include <time.h>
 345 #else
 346 # if HAVE_SYS_TIME_H
 347 #  include <sys/time.h>
 348 # else
 349 #  ifdef HAVE_TIME_H
 350 #   include <time.h>
 351 #  endif
 352 # endif
 353 #endif
 354
 355 #ifdef HAVE_FCNTL_H
 356 # include <fcntl.h>
 357 #else
 358 # ifdef HAVE_SYS_FILE_H
 359 #  include <sys/file.h>
 360 # endif
 361 #endif
 362
 363 #ifndef SEEK_SET
 364 # define SEEK_SET 0
 365 # define SEEK_CUR 1
 366 # define SEEK_END 2
 367 #endif
 368 #ifndef F_OK
 369 # define F_OK 0
 370 # define X_OK 1
 371 # define W_OK 2
 372 # define R_OK 4
 373 #endif
 374 #ifndef O_RDONLY
 375 # define O_RDONLY 0
 376 #endif
 377 #ifndef O_WRONLY
 378 # define O_WRONLY 1
 379 #endif
 380 #ifndef O_BINARY
 381 # define O_BINARY 0
 382 #endif
 383
 384 /* Some systems define these in, e.g., param.h.  We undefine these names
 385    here to avoid the warnings.  We prefer to use our definitions since we
 386    know they are correct.  */
 387
 388 #undef MIN
 389 #undef MAX
 390 #define MIN(X,Y) ((X) < (Y) ? (X) : (Y))
 391 #define MAX(X,Y) ((X) > (Y) ? (X) : (Y))
 392
 393 /* Returns the least number N such that N * Y >= X.  */
 394 #define CEIL(x,y) (((x) + (y) - 1) / (y))
 395
 396 /* This macro rounds x up to the y boundary.  */
 397 #define ROUND_UP(x,y) (((x) + (y) - 1) & ~((y) - 1))
 398
 399 /* This macro rounds x down to the y boundary.  */
 400 #define ROUND_DOWN(x,y) ((x) & ~((y) - 1))
 401
 402 #ifdef HAVE_SYS_WAIT_H
 403 #include <sys/wait.h>
 404 #endif
 405
 406 #ifndef WIFSIGNALED
 407 #define WIFSIGNALED(S) (((S) & 0xff) != 0 && ((S) & 0xff) != 0x7f)
 408 #endif
 409 #ifndef WTERMSIG
 410 #define WTERMSIG(S) ((S) & 0x7f)
 411 #endif
 412 #ifndef WIFEXITED
 413 #define WIFEXITED(S) (((S) & 0xff) == 0)
 414 #endif
 415 #ifndef WEXITSTATUS
 416 #define WEXITSTATUS(S) (((S) & 0xff00) >> 8)
 417 #endif
 418 #ifndef WSTOPSIG
 419 #define WSTOPSIG WEXITSTATUS
 420 #endif
 421 #ifndef WCOREDUMP
 422 #define WCOREDUMP(S) ((S) & WCOREFLG)
 423 #endif
 424 #ifndef WCOREFLG
 425 #define WCOREFLG 0200
 426 #endif
 427
 428 #include <signal.h>
 429 #if !defined (SIGCHLD) && defined (SIGCLD)
 430 # define SIGCHLD SIGCLD
 431 #endif
 432
 433 #ifdef HAVE_SYS_MMAN_H
 434 # include <sys/mman.h>
 435 #endif
 436
 437 #ifndef MAP_FAILED
 438 # define MAP_FAILED ((void *)-1)
 439 #endif
 440
 441 #if !defined (MAP_ANONYMOUS) && defined (MAP_ANON)
 442 # define MAP_ANONYMOUS MAP_ANON
 443 #endif
 444
 445 #ifdef HAVE_SYS_RESOURCE_H
 446 # include <sys/resource.h>
 447 #endif
 448
 449 #ifdef HAVE_SYS_TIMES_H
 450 # include <sys/times.h>
 451 #endif
 452
 453 /* The HAVE_DECL_* macros are three-state, undefined, 0 or 1.  If they
 454    are defined to 0 then we must provide the relevant declaration
 455    here.  These checks will be in the undefined state while configure
 456    is running so be careful to test "defined (HAVE_DECL_*)".  */
 457
 458 #ifdef __cplusplus
 459 extern "C" {
 460 #endif
 461
 462 #if defined (HAVE_DECL_ATOF) && !HAVE_DECL_ATOF
 463 extern double atof (const char *);
 464 #endif
 465
 466 #if defined (HAVE_DECL_ATOL) && !HAVE_DECL_ATOL
 467 extern long atol (const char *);
 468 #endif
 469
 470 #if defined (HAVE_DECL_FREE) && !HAVE_DECL_FREE
 471 extern void free (void *);
 472 #endif
 473
 474 #if defined (HAVE_DECL_GETCWD) && !HAVE_DECL_GETCWD
 475 extern char *getcwd (char *, size_t);
 476 #endif
 477
 478 #if defined (HAVE_DECL_GETENV) && !HAVE_DECL_GETENV
 479 extern char *getenv (const char *);
 480 #endif
 481
 482 #if defined (HAVE_DECL_GETOPT) && !HAVE_DECL_GETOPT
 483 extern int getopt (int, char * const *, const char *);
 484 #endif
 485
 486 #if defined (HAVE_DECL_GETPAGESIZE) && !HAVE_DECL_GETPAGESIZE
 487 extern int getpagesize (void);
 488 #endif
 489
 490 #if defined (HAVE_DECL_GETWD) && !HAVE_DECL_GETWD
 491 extern char *getwd (char *);
 492 #endif
 493
 494 #if defined (HAVE_DECL_SBRK) && !HAVE_DECL_SBRK
 495 extern void *sbrk (int);
 496 #endif
 497
 498 #if defined (HAVE_DECL_SETENV) && !HAVE_DECL_SETENV
 499 int setenv(const char *, const char *, int);
 500 #endif
 501
 502 #if defined (HAVE_DECL_STRSTR) && !HAVE_DECL_STRSTR
 503 extern char *strstr (const char *, const char *);
 504 #endif
 505
 506 #if defined (HAVE_DECL_STPCPY) && !HAVE_DECL_STPCPY
 507 extern char *stpcpy (char *, const char *);
 508 #endif
 509
 510 #if defined (HAVE_DECL_UNSETENV) && !HAVE_DECL_UNSETENV
 511 int unsetenv(const char *);
 512 #endif
 513
 514 #if defined (HAVE_DECL_MALLOC) && !HAVE_DECL_MALLOC
 515 extern void *malloc (size_t);
 516 #endif
 517
 518 #if defined (HAVE_DECL_CALLOC) && !HAVE_DECL_CALLOC
 519 extern void *calloc (size_t, size_t);
 520 #endif
 521
 522 #if defined (HAVE_DECL_REALLOC) && !HAVE_DECL_REALLOC
 523 extern void *realloc (void *, size_t);
 524 #endif
 525
 526 #ifdef __cplusplus
 527 }
 528 #endif
 529
 530 #ifdef HAVE_STDINT_H
 531 #include <stdint.h>
 532 #endif
 533
 534 #ifdef HAVE_INTTYPES_H
 535 #include <inttypes.h>
 536 #endif
 537
 538 #ifdef __cplusplus
 539 extern "C" {
 540 #endif
 541
 542 /* If the system doesn't provide strsignal, we get it defined in
 543    libiberty but no declaration is supplied.  */
 544 #if !defined (HAVE_STRSIGNAL) \
 545     || (defined (HAVE_DECL_STRSIGNAL) && !HAVE_DECL_STRSIGNAL)
 546 # ifndef strsignal
 547 extern const char *strsignal (int);
 548 # endif
 549 #endif
 550
 551 #ifdef HAVE_GETRLIMIT
 552 # if defined (HAVE_DECL_GETRLIMIT) && !HAVE_DECL_GETRLIMIT
 553 #  ifndef getrlimit
 554 struct rlimit;
 555 extern int getrlimit (int, struct rlimit *);
 556 #  endif
 557 # endif
 558 #endif
 559
 560 #ifdef HAVE_SETRLIMIT
 561 # if defined (HAVE_DECL_SETRLIMIT) && !HAVE_DECL_SETRLIMIT
 562 #  ifndef setrlimit
 563 struct rlimit;
 564 extern int setrlimit (int, const struct rlimit *);
 565 #  endif
 566 # endif
 567 #endif
 568
 569 #if defined (HAVE_DECL_ABORT) && !HAVE_DECL_ABORT
 570 extern void abort (void);
 571 #endif
 572
 573 #if defined (HAVE_DECL_SNPRINTF) && !HAVE_DECL_SNPRINTF
 574 extern int snprintf (char *, size_t, const char *, ...);
 575 #endif
 576
 577 #if defined (HAVE_DECL_VSNPRINTF) && !HAVE_DECL_VSNPRINTF
 578 extern int vsnprintf (char *, size_t, const char *, va_list);
 579 #endif
 580
 581 #ifdef __cplusplus
 582 }
 583 #endif
 584
 585 /* 1 if we have C99 designated initializers.  */
 586 #if !defined(HAVE_DESIGNATED_INITIALIZERS)
 587 #ifdef __cplusplus
 588 #define HAVE_DESIGNATED_INITIALIZERS 0
 589 #else
 590 #define HAVE_DESIGNATED_INITIALIZERS \
 591   ((GCC_VERSION >= 2007) || (__STDC_VERSION__ >= 199901L))
 592 #endif
 593 #endif
 594
 595 #if !defined(HAVE_DESIGNATED_UNION_INITIALIZERS)
 596 #ifdef __cplusplus
 597 #define HAVE_DESIGNATED_UNION_INITIALIZERS (GCC_VERSION >= 4007)
 598 #else
 599 #define HAVE_DESIGNATED_UNION_INITIALIZERS \
 600   ((GCC_VERSION >= 2007) || (__STDC_VERSION__ >= 199901L))
 601 #endif
 602 #endif
 603
 604 #if HAVE_SYS_STAT_H
 605 # include <sys/stat.h>
 606 #endif
 607
 608 /* Test if something is a normal file.  */
 609 #ifndef S_ISREG
 610 #define S_ISREG(m) (((m) & S_IFMT) == S_IFREG)
 611 #endif
 612
 613 /* Test if something is a directory.  */
 614 #ifndef S_ISDIR
 615 #define S_ISDIR(m) (((m) & S_IFMT) == S_IFDIR)
 616 #endif
 617
 618 /* Test if something is a character special file.  */
 619 #ifndef S_ISCHR
 620 #define S_ISCHR(m) (((m) & S_IFMT) == S_IFCHR)
 621 #endif
 622
 623 /* Test if something is a block special file.  */
 624 #ifndef S_ISBLK
 625 #define S_ISBLK(m) (((m) & S_IFMT) == S_IFBLK)
 626 #endif
 627
 628 /* Test if something is a socket.  */
 629 #ifndef S_ISSOCK
 630 # ifdef S_IFSOCK
 631 #   define S_ISSOCK(m) (((m) & S_IFMT) == S_IFSOCK)
 632 # else
 633 #   define S_ISSOCK(m) 0
 634 # endif
 635 #endif
 636
 637 /* Test if something is a FIFO.  */
 638 #ifndef S_ISFIFO
 639 # ifdef S_IFIFO
 640 #  define S_ISFIFO(m) (((m) & S_IFMT) == S_IFIFO)
 641 # else
 642 #  define S_ISFIFO(m) 0
 643 # endif
 644 #endif
 645
 646 /* Define well known filenos if the system does not define them.  */
 647 #ifndef STDIN_FILENO
 648 # define STDIN_FILENO   0
 649 #endif
 650 #ifndef STDOUT_FILENO
 651 # define STDOUT_FILENO  1
 652 #endif
 653 #ifndef STDERR_FILENO
 654 # define STDERR_FILENO  2
 655 #endif
 656
 657 /* Some systems have mkdir that takes a single argument.  */
 658 #ifdef MKDIR_TAKES_ONE_ARG
 659 # define mkdir(a,b) mkdir (a)
 660 #endif
 661
 662 #ifndef HAVE_KILL
 663 # define kill(p,s) raise (s)
 664 #endif
 665
 666 /* Provide a way to print an address via printf.  */
 667 #ifndef HOST_PTR_PRINTF
 668 #define HOST_PTR_PRINTF "%p"
 669 #endif /* ! HOST_PTR_PRINTF */
 670
 671 /* By default, colon separates directories in a path.  */
 672 #ifndef PATH_SEPARATOR
 673 #define PATH_SEPARATOR ':'
 674 #endif
 675
 676 /* Filename handling macros.  */
 677 #include "filenames.h"
 678
 679 /* These should be phased out in favor of IS_DIR_SEPARATOR, where possible.  */
 680 #ifndef DIR_SEPARATOR
 681 # define DIR_SEPARATOR '/'
 682 # ifdef HAVE_DOS_BASED_FILE_SYSTEM
 683 #  define DIR_SEPARATOR_2 '\\'
 684 # endif
 685 #endif
 686
 687 #if defined (ENABLE_PLUGIN) && defined (HAVE_DLFCN_H)
 688 /* If plugin support is enabled, we could use libdl.  */
 689 #include <dlfcn.h>
 690 #endif
 691
 692 /* Do not introduce a gmp.h dependency on the build system.  */
 693 #ifndef GENERATOR_FILE
 694 #include <gmp.h>
 695 #endif
 696
 697 /* Get libiberty declarations.  */
 698 #include "libiberty.h"
 699
 700 #undef FFS  /* Some systems predefine this symbol; don't let it interfere.  */
 701 #undef FLOAT /* Likewise.  */
 702 #undef ABS /* Likewise.  */
 703 #undef PC /* Likewise.  */
 704
 705 /* Provide a default for the HOST_BIT_BUCKET.
 706    This suffices for POSIX-like hosts.  */
 707
 708 #ifndef HOST_BIT_BUCKET
 709 #define HOST_BIT_BUCKET "/dev/null"
 710 #endif
 711
 712 #ifndef offsetof
 713 #define offsetof(TYPE, MEMBER)  ((size_t) &((TYPE *) 0)->MEMBER)
 714 #endif
 715
 716 /* Various error reporting routines want to use __FUNCTION__.  */
 717 #if (GCC_VERSION < 2007)
 718 #ifndef __FUNCTION__
 719 #define __FUNCTION__ "?"
 720 #endif /* ! __FUNCTION__ */
 721 #endif
 722
 723 /* __builtin_expect(A, B) evaluates to A, but notifies the compiler that
 724    the most likely value of A is B.  This feature was added at some point
 725    between 2.95 and 3.0.  Let's use 3.0 as the lower bound for now.  */
 726 #if (GCC_VERSION < 3000)
 727 #define __builtin_expect(a, b) (a)
 728 #endif
 729
 730 /* Some of the headers included by <memory> can use "abort" within a
 731    namespace, e.g. "_VSTD::abort();", which fails after we use the
 732    preprocessor to redefine "abort" as "fancy_abort" below.
 733    Given that unique-ptr.h can use "free", we need to do this after "free"
 734    is declared but before "abort" is overridden.  */
 735
 736 #ifdef INCLUDE_UNIQUE_PTR
 737 # include "unique-ptr.h"
 738 #endif
 739
 740 #ifdef INCLUDE_MALLOC_H
 741 #if defined(HAVE_MALLINFO) || defined(HAVE_MALLINFO2)
 742 #include <malloc.h>
 743 #endif
 744 #endif
 745
 746 #ifdef INCLUDE_ISL
 747 #ifdef HAVE_isl
 748 #include <isl/options.h>
 749 #include <isl/ctx.h>
 750 #include <isl/val.h>
 751 #include <isl/set.h>
 752 #include <isl/union_set.h>
 753 #include <isl/map.h>
 754 #include <isl/union_map.h>
 755 #include <isl/aff.h>
 756 #include <isl/constraint.h>
 757 #include <isl/flow.h>
 758 #include <isl/ilp.h>
 759 #include <isl/schedule.h>
 760 #include <isl/ast_build.h>
 761 #include <isl/schedule_node.h>
 762 #include <isl/id.h>
 763 #include <isl/space.h>
 764 #endif
 765 #endif
 766
 767 /* Redefine abort to report an internal error w/o coredump, and
 768    reporting the location of the error in the source file.  */
 769 extern void fancy_abort (const char *, int, const char *)
 770                                          ATTRIBUTE_NORETURN ATTRIBUTE_COLD;
 771 #define abort() fancy_abort (__FILE__, __LINE__, __FUNCTION__)
 772
 773 /* Use gcc_assert(EXPR) to test invariants.  */
 774 #if ENABLE_ASSERT_CHECKING
 775 #define gcc_assert(EXPR)                                                \
 776    ((void)(!(EXPR) ? fancy_abort (__FILE__, __LINE__, __FUNCTION__), 0 : 0))
 777 #elif (GCC_VERSION >= 4005)
 778 #define gcc_assert(EXPR)                                                \
 779   ((void)(__builtin_expect (!(EXPR), 0) ? __builtin_unreachable (), 0 : 0))
 780 #else
 781 /* Include EXPR, so that unused variable warnings do not occur.  */
 782 #define gcc_assert(EXPR) ((void)(0 && (EXPR)))
 783 #endif
 784
 785 #if CHECKING_P
 786 #define gcc_checking_assert(EXPR) gcc_assert (EXPR)
 787 #else
 788 /* N.B.: in release build EXPR is not evaluated.  */
 789 #define gcc_checking_assert(EXPR) ((void)(0 && (EXPR)))
 790 #endif
 791
 792 #if GCC_VERSION >= 4000
 793 #define ALWAYS_INLINE inline __attribute__ ((always_inline))
 794 #else
 795 #define ALWAYS_INLINE inline
 796 #endif
 797
 798 #if GCC_VERSION >= 3004
 799 #define WARN_UNUSED_RESULT __attribute__ ((__warn_unused_result__))
 800 #else
 801 #define WARN_UNUSED_RESULT
 802 #endif
 803
 804 /* Use gcc_unreachable() to mark unreachable locations (like an
 805    unreachable default case of a switch.  Do not use gcc_assert(0).  */
 806 #if (GCC_VERSION >= 4005) && !ENABLE_ASSERT_CHECKING
 807 #define gcc_unreachable() __builtin_unreachable ()
 808 #else
 809 #define gcc_unreachable() (fancy_abort (__FILE__, __LINE__, __FUNCTION__))
 810 #endif
 811
 812 #if GCC_VERSION >= 7000 && defined(__has_attribute)
 813 # if __has_attribute(fallthrough)
 814 #  define gcc_fallthrough() __attribute__((fallthrough))
 815 # else
 816 #  define gcc_fallthrough()
 817 # endif
 818 #else
 819 # define gcc_fallthrough()
 820 #endif
 821
 822 #if GCC_VERSION >= 3001
 823 #define STATIC_CONSTANT_P(X) (__builtin_constant_p (X) && (X))
 824 #else
 825 #define STATIC_CONSTANT_P(X) (false && (X))
 826 #endif
 827
 828 /* static_assert (COND, MESSAGE) is available in C++11 onwards.  */
 829 #if __cplusplus >= 201103L
 830 #define STATIC_ASSERT(X) \
 831   static_assert ((X), #X)
 832 #else
 833 #define STATIC_ASSERT(X) \
 834   typedef int assertion1[(X) ? 1 : -1] ATTRIBUTE_UNUSED
 835 #endif
 836
 837 /* Provide a fake boolean type.  We make no attempt to use the
 838    C99 _Bool, as it may not be available in the bootstrap compiler,
 839    and even if it is, it is liable to be buggy.
 840    This must be after all inclusion of system headers, as some of
 841    them will mess us up.  */
 842
 843 #undef TRUE
 844 #undef FALSE
 845
 846 #ifdef __cplusplus
 847   /* Obsolete.  */
 848 # define TRUE true
 849 # define FALSE false
 850 #else /* !__cplusplus */
 851 # undef bool
 852 # undef true
 853 # undef false
 854
 855 # define bool unsigned char
 856 # define true 1
 857 # define false 0
 858
 859   /* Obsolete.  */
 860 # define TRUE true
 861 # define FALSE false
 862 #endif /* !__cplusplus */
 863
 864 /* Some compilers do not allow the use of unsigned char in bitfields.  */
 865 #define BOOL_BITFIELD unsigned int
 866
 867 /* GCC older than 4.4 have broken C++ value initialization handling, see
 868    PR11309, PR30111, PR33916, PR82939 and PR84405 for more details.  */
 869 #if GCC_VERSION > 0 && GCC_VERSION < 4004 && !defined(__clang__)
 870 # define BROKEN_VALUE_INITIALIZATION
 871 #endif
 872
 873 /* As the last action in this file, we poison the identifiers that
 874    shouldn't be used.  Note, luckily gcc-3.0's token-based integrated
 875    preprocessor won't trip on poisoned identifiers that arrive from
 876    the expansion of macros.  E.g. #define strrchr rindex, won't error
 877    if rindex is poisoned after this directive is issued and later on
 878    strrchr is called.
 879
 880    Note: We define bypass macros for the few cases where we really
 881    want to use the libc memory allocation routines.  Otherwise we
 882    insist you use the "x" versions from libiberty.  */
 883
 884 #define really_call_malloc malloc
 885 #define really_call_calloc calloc
 886 #define really_call_realloc realloc
 887
 888 #if defined(FLEX_SCANNER) || defined(YYBISON) || defined(YYBYACC)
 889 /* Flex and bison use malloc and realloc.  Yuk.  Note that this means
 890    really_call_* cannot be used in a .l or .y file.  */
 891 #define malloc xmalloc
 892 #define realloc xrealloc
 893 #endif
 894
 895 #if (GCC_VERSION >= 3000)
 896
 897 /* Note autoconf checks for prototype declarations and includes
 898    system.h while doing so.  Only poison these tokens if actually
 899    compiling gcc, so that the autoconf declaration tests for malloc
 900    etc don't spuriously fail.  */
 901 #ifdef IN_GCC
 902
 903 #undef calloc
 904 #undef strdup
 905 #undef strndup
 906  #pragma GCC poison calloc strdup strndup
 907
 908 #if !defined(FLEX_SCANNER) && !defined(YYBISON)
 909 #undef malloc
 910 #undef realloc
 911  #pragma GCC poison malloc realloc
 912 #endif
 913
 914 /* The %m format should be used when GCC's main diagnostic functions
 915    supporting %m are available, and xstrerror from libiberty
 916    otherwise.  */
 917 #undef strerror
 918  #pragma GCC poison strerror
 919
 920 /* loc_t is defined on some systems and too inviting for some
 921    programmers to avoid.  */
 922 #undef loc_t
 923  #pragma GCC poison loc_t
 924
 925 /* Old target macros that have moved to the target hooks structure.  */
 926  #pragma GCC poison ASM_OPEN_PAREN ASM_CLOSE_PAREN                      \
 927         FUNCTION_PROLOGUE FUNCTION_EPILOGUE                             \
 928         FUNCTION_END_PROLOGUE FUNCTION_BEGIN_EPILOGUE                   \
 929         DECL_MACHINE_ATTRIBUTES COMP_TYPE_ATTRIBUTES INSERT_ATTRIBUTES  \
 930         VALID_MACHINE_DECL_ATTRIBUTE VALID_MACHINE_TYPE_ATTRIBUTE       \
 931         SET_DEFAULT_TYPE_ATTRIBUTES SET_DEFAULT_DECL_ATTRIBUTES         \
 932         MERGE_MACHINE_TYPE_ATTRIBUTES MERGE_MACHINE_DECL_ATTRIBUTES     \
 933         MD_INIT_BUILTINS MD_EXPAND_BUILTIN ASM_OUTPUT_CONSTRUCTOR       \
 934         ASM_OUTPUT_DESTRUCTOR SIGNED_CHAR_SPEC MAX_CHAR_TYPE_SIZE       \
 935         WCHAR_UNSIGNED UNIQUE_SECTION SELECT_SECTION SELECT_RTX_SECTION \
 936         ENCODE_SECTION_INFO STRIP_NAME_ENCODING ASM_GLOBALIZE_LABEL     \
 937         ASM_OUTPUT_MI_THUNK CONST_COSTS RTX_COSTS DEFAULT_RTX_COSTS     \
 938         ADDRESS_COST MACHINE_DEPENDENT_REORG ASM_FILE_START ASM_FILE_END \
 939         ASM_SIMPLIFY_DWARF_ADDR INIT_TARGET_OPTABS INIT_SUBTARGET_OPTABS \
 940         INIT_GOFAST_OPTABS MULSI3_LIBCALL MULDI3_LIBCALL DIVSI3_LIBCALL \
 941         DIVDI3_LIBCALL UDIVSI3_LIBCALL UDIVDI3_LIBCALL MODSI3_LIBCALL   \
 942         MODDI3_LIBCALL UMODSI3_LIBCALL UMODDI3_LIBCALL BUILD_VA_LIST_TYPE \
 943         PRETEND_OUTGOING_VARARGS_NAMED STRUCT_VALUE_INCOMING_REGNUM     \
 944         ASM_OUTPUT_SECTION_NAME PROMOTE_FUNCTION_ARGS PROMOTE_FUNCTION_MODE \
 945         STRUCT_VALUE_INCOMING STRICT_ARGUMENT_NAMING                    \
 946         PROMOTE_FUNCTION_RETURN PROMOTE_PROTOTYPES STRUCT_VALUE_REGNUM  \
 947         SETUP_INCOMING_VARARGS EXPAND_BUILTIN_SAVEREGS                  \
 948         DEFAULT_SHORT_ENUMS SPLIT_COMPLEX_ARGS MD_ASM_CLOBBERS          \
 949         HANDLE_PRAGMA_REDEFINE_EXTNAME HANDLE_PRAGMA_EXTERN_PREFIX      \
 950         MUST_PASS_IN_STACK FUNCTION_ARG_PASS_BY_REFERENCE               \
 951         VECTOR_MODE_SUPPORTED_P TARGET_SUPPORTS_HIDDEN                  \
 952         FUNCTION_ARG_PARTIAL_NREGS ASM_OUTPUT_DWARF_DTPREL              \
 953         ALLOCATE_INITIAL_VALUE LEGITIMIZE_ADDRESS FRAME_POINTER_REQUIRED \
 954         CAN_ELIMINATE TRAMPOLINE_TEMPLATE INITIALIZE_TRAMPOLINE         \
 955         TRAMPOLINE_ADJUST_ADDRESS STATIC_CHAIN STATIC_CHAIN_INCOMING    \
 956         RETURN_POPS_ARGS UNITS_PER_SIMD_WORD OVERRIDE_OPTIONS           \
 957         OPTIMIZATION_OPTIONS CLASS_LIKELY_SPILLED_P                     \
 958         USING_SJLJ_EXCEPTIONS TARGET_UNWIND_INFO                        \
 959         CAN_DEBUG_WITHOUT_FP UNLIKELY_EXECUTED_TEXT_SECTION_NAME        \
 960         HOT_TEXT_SECTION_NAME LEGITIMATE_CONSTANT_P ALWAYS_STRIP_DOTDOT \
 961         OUTPUT_ADDR_CONST_EXTRA SMALL_REGISTER_CLASSES ASM_OUTPUT_IDENT \
 962         ASM_BYTE_OP MEMBER_TYPE_FORCES_BLK LIBGCC2_HAS_SF_MODE          \
 963         LIBGCC2_HAS_DF_MODE LIBGCC2_HAS_XF_MODE LIBGCC2_HAS_TF_MODE     \
 964         CLEAR_BY_PIECES_P MOVE_BY_PIECES_P SET_BY_PIECES_P              \
 965         STORE_BY_PIECES_P TARGET_FLT_EVAL_METHOD                        \
 966         HARD_REGNO_CALL_PART_CLOBBERED HARD_REGNO_MODE_OK               \
 967         MODES_TIEABLE_P FUNCTION_ARG_PADDING SLOW_UNALIGNED_ACCESS      \
 968         HARD_REGNO_NREGS SECONDARY_MEMORY_NEEDED_MODE                   \
 969         SECONDARY_MEMORY_NEEDED CANNOT_CHANGE_MODE_CLASS                \
 970         TRULY_NOOP_TRUNCATION FUNCTION_ARG_OFFSET CONSTANT_ALIGNMENT    \
 971         STARTING_FRAME_OFFSET
 972
 973 /* Target macros only used for code built for the target, that have
 974    moved to libgcc-tm.h or have never been present elsewhere.  */
 975  #pragma GCC poison DECLARE_LIBRARY_RENAMES LIBGCC2_GNU_PREFIX          \
 976         MD_UNWIND_SUPPORT MD_FROB_UPDATE_CONTEXT ENABLE_EXECUTE_STACK   \
 977         REG_VALUE_IN_UNWIND_CONTEXT ASSUME_EXTENDED_UNWIND_CONTEXT
 978
 979 /* Other obsolete target macros, or macros that used to be in target
 980    headers and were not used, and may be obsolete or may never have
 981    been used.  */
 982  #pragma GCC poison INT_ASM_OP ASM_OUTPUT_EH_REGION_BEG CPP_PREDEFINES     \
 983         ASM_OUTPUT_EH_REGION_END ASM_OUTPUT_LABELREF_AS_INT SMALL_STACK    \
 984         DOESNT_NEED_UNWINDER EH_TABLE_LOOKUP OBJC_SELECTORS_WITHOUT_LABELS \
 985         OMIT_EH_TABLE EASY_DIV_EXPR IMPLICIT_FIX_EXPR                      \
 986         LONGJMP_RESTORE_FROM_STACK MAX_INT_TYPE_SIZE ASM_IDENTIFY_GCC      \
 987         STDC_VALUE TRAMPOLINE_ALIGN ASM_IDENTIFY_GCC_AFTER_SOURCE          \
 988         SLOW_ZERO_EXTEND SUBREG_REGNO_OFFSET DWARF_LINE_MIN_INSTR_LENGTH   \
 989         TRADITIONAL_RETURN_FLOAT NO_BUILTIN_SIZE_TYPE                      \
 990         NO_BUILTIN_PTRDIFF_TYPE NO_BUILTIN_WCHAR_TYPE NO_BUILTIN_WINT_TYPE \
 991         BLOCK_PROFILER BLOCK_PROFILER_CODE FUNCTION_BLOCK_PROFILER         \
 992         FUNCTION_BLOCK_PROFILER_EXIT MACHINE_STATE_SAVE                    \
 993         MACHINE_STATE_RESTORE SCCS_DIRECTIVE SECTION_ASM_OP BYTEORDER      \
 994         ASM_OUTPUT_DEFINE_LABEL_DIFFERENCE_SYMBOL HOST_WORDS_BIG_ENDIAN    \
 995         OBJC_PROLOGUE ALLOCATE_TRAMPOLINE HANDLE_PRAGMA ROUND_TYPE_SIZE    \
 996         ROUND_TYPE_SIZE_UNIT CONST_SECTION_ASM_OP CRT_GET_RFIB_TEXT        \
 997         DBX_LBRAC_FIRST DBX_OUTPUT_ENUM DBX_OUTPUT_SOURCE_FILENAME         \
 998         DBX_WORKING_DIRECTORY INSN_CACHE_DEPTH INSN_CACHE_SIZE             \
 999         INSN_CACHE_LINE_WIDTH INIT_SECTION_PREAMBLE NEED_ATEXIT ON_EXIT    \
1000         EXIT_BODY OBJECT_FORMAT_ROSE MULTIBYTE_CHARS MAP_CHARACTER         \
1001         LIBGCC_NEEDS_DOUBLE FINAL_PRESCAN_LABEL DEFAULT_CALLER_SAVES       \
1002         LOAD_ARGS_REVERSED MAX_INTEGER_COMPUTATION_MODE                    \
1003         CONVERT_HARD_REGISTER_TO_SSA_P ASM_OUTPUT_MAIN_SOURCE_FILENAME     \
1004         FIRST_INSN_ADDRESS TEXT_SECTION SHARED_BSS_SECTION_ASM_OP          \
1005         PROMOTED_MODE EXPAND_BUILTIN_VA_END                                \
1006         LINKER_DOES_NOT_WORK_WITH_DWARF2 FUNCTION_ARG_KEEP_AS_REFERENCE    \
1007         GIV_SORT_CRITERION MAX_LONG_TYPE_SIZE MAX_LONG_DOUBLE_TYPE_SIZE    \
1008         MAX_WCHAR_TYPE_SIZE SHARED_SECTION_ASM_OP INTEGRATE_THRESHOLD      \
1009         FINAL_REG_PARM_STACK_SPACE MAYBE_REG_PARM_STACK_SPACE              \
1010         TRADITIONAL_PIPELINE_INTERFACE DFA_PIPELINE_INTERFACE              \
1011         DBX_OUTPUT_STANDARD_TYPES BUILTIN_SETJMP_FRAME_VALUE               \
1012         SUNOS4_SHARED_LIBRARIES PROMOTE_FOR_CALL_ONLY                      \
1013         SPACE_AFTER_L_OPTION NO_RECURSIVE_FUNCTION_CSE                     \
1014         DEFAULT_MAIN_RETURN TARGET_MEM_FUNCTIONS EXPAND_BUILTIN_VA_ARG     \
1015         COLLECT_PARSE_FLAG DWARF2_GENERATE_TEXT_SECTION_LABEL WINNING_GDB  \
1016         ASM_OUTPUT_FILENAME ASM_OUTPUT_SOURCE_LINE FILE_NAME_JOINER        \
1017         GDB_INV_REF_REGPARM_STABS_LETTER DBX_MEMPARM_STABS_LETTER          \
1018         PUT_SDB_SRC_FILE STABS_GCC_MARKER DBX_OUTPUT_FUNCTION_END          \
1019         DBX_OUTPUT_GCC_MARKER DBX_FINISH_SYMBOL SDB_GENERATE_FAKE          \
1020         NON_SAVING_SETJMP TARGET_LATE_RTL_PROLOGUE_EPILOGUE                \
1021         CASE_DROPS_THROUGH TARGET_BELL TARGET_BS TARGET_CR TARGET_DIGIT0   \
1022         TARGET_ESC TARGET_FF TARGET_NEWLINE TARGET_TAB TARGET_VT           \
1023         LINK_LIBGCC_SPECIAL DONT_ACCESS_GBLS_AFTER_EPILOGUE                \
1024         TARGET_OPTIONS TARGET_SWITCHES EXTRA_CC_MODES FINALIZE_PIC         \
1025         PREDICATE_CODES SPECIAL_MODE_PREDICATES UNALIGNED_WORD_ASM_OP      \
1026         EXTRA_SECTIONS EXTRA_SECTION_FUNCTIONS READONLY_DATA_SECTION       \
1027         TARGET_ASM_EXCEPTION_SECTION TARGET_ASM_EH_FRAME_SECTION           \
1028         SMALL_ARG_MAX ASM_OUTPUT_SHARED_BSS ASM_OUTPUT_SHARED_COMMON       \
1029         ASM_OUTPUT_SHARED_LOCAL ASM_MAKE_LABEL_LINKONCE                    \
1030         STACK_CHECK_PROBE_INTERVAL STACK_CHECK_PROBE_LOAD                  \
1031         ORDER_REGS_FOR_LOCAL_ALLOC FUNCTION_OUTGOING_VALUE                 \
1032         ASM_DECLARE_CONSTANT_NAME MODIFY_TARGET_NAME SWITCHES_NEED_SPACES  \
1033         SWITCH_CURTAILS_COMPILATION SWITCH_TAKES_ARG WORD_SWITCH_TAKES_ARG \
1034         TARGET_OPTION_TRANSLATE_TABLE HANDLE_PRAGMA_PACK_PUSH_POP          \
1035         HANDLE_SYSV_PRAGMA HANDLE_PRAGMA_WEAK CONDITIONAL_REGISTER_USAGE   \
1036         FUNCTION_ARG_BOUNDARY MUST_USE_SJLJ_EXCEPTIONS US_SOFTWARE_GOFAST  \
1037         USING_SVR4_H SVR4_ASM_SPEC FUNCTION_ARG FUNCTION_ARG_ADVANCE       \
1038         FUNCTION_INCOMING_ARG IRA_COVER_CLASSES TARGET_VERSION             \
1039         MACHINE_TYPE TARGET_HAS_TARGETCM ASM_OUTPUT_BSS                    \
1040         SETJMP_VIA_SAVE_AREA FORBIDDEN_INC_DEC_CLASSES                     \
1041         PREFERRED_OUTPUT_RELOAD_CLASS SYSTEM_INCLUDE_DIR                   \
1042         STANDARD_INCLUDE_DIR STANDARD_INCLUDE_COMPONENT                    \
1043         LINK_ELIMINATE_DUPLICATE_LDIRECTORIES MIPS_DEBUGGING_INFO          \
1044         IDENT_ASM_OP ALL_COP_ADDITIONAL_REGISTER_NAMES DBX_OUTPUT_LBRAC    \
1045         DBX_OUTPUT_NFUN DBX_OUTPUT_RBRAC RANGE_TEST_NON_SHORT_CIRCUIT      \
1046         REAL_VALUE_TRUNCATE REVERSE_CONDEXEC_PREDICATES_P                  \
1047         TARGET_ALIGN_ANON_BITFIELDS TARGET_NARROW_VOLATILE_BITFIELDS       \
1048         IDENT_ASM_OP UNALIGNED_SHORT_ASM_OP UNALIGNED_INT_ASM_OP           \
1049         UNALIGNED_LONG_ASM_OP UNALIGNED_DOUBLE_INT_ASM_OP                  \
1050         USE_COMMON_FOR_ONE_ONLY IFCVT_EXTRA_FIELDS IFCVT_INIT_EXTRA_FIELDS \
1051         CASE_USE_BIT_TESTS FIXUNS_TRUNC_LIKE_FIX_TRUNC                     \
1052         GO_IF_MODE_DEPENDENT_ADDRESS DELAY_SLOTS_FOR_EPILOGUE              \
1053         ELIGIBLE_FOR_EPILOGUE_DELAY TARGET_C99_FUNCTIONS TARGET_HAS_SINCOS \
1054         REG_CLASS_FROM_LETTER CONST_OK_FOR_LETTER_P                        \
1055         CONST_DOUBLE_OK_FOR_LETTER_P EXTRA_CONSTRAINT                      \
1056         REG_CLASS_FROM_CONSTRAINT REG_CLASS_FOR_CONSTRAINT                 \
1057         EXTRA_CONSTRAINT_STR EXTRA_MEMORY_CONSTRAINT                       \
1058         EXTRA_ADDRESS_CONSTRAINT CONST_DOUBLE_OK_FOR_CONSTRAINT_P          \
1059         CALLER_SAVE_PROFITABLE LARGEST_EXPONENT_IS_NORMAL                  \
1060         ROUND_TOWARDS_ZERO SF_SIZE DF_SIZE XF_SIZE TF_SIZE LIBGCC2_TF_CEXT \
1061         LIBGCC2_LONG_DOUBLE_TYPE_SIZE STRUCT_VALUE                         \
1062         EH_FRAME_IN_DATA_SECTION TARGET_FLT_EVAL_METHOD_NON_DEFAULT        \
1063         JCR_SECTION_NAME TARGET_USE_JCR_SECTION SDB_DEBUGGING_INFO         \
1064         SDB_DEBUG NO_IMPLICIT_EXTERN_C
1065
1066 /* Hooks that are no longer used.  */
1067  #pragma GCC poison LANG_HOOKS_FUNCTION_MARK LANG_HOOKS_FUNCTION_FREE   \
1068         LANG_HOOKS_MARK_TREE LANG_HOOKS_INSERT_DEFAULT_ATTRIBUTES \
1069         LANG_HOOKS_TREE_INLINING_ESTIMATE_NUM_INSNS \
1070         LANG_HOOKS_PUSHLEVEL LANG_HOOKS_SET_BLOCK \
1071         LANG_HOOKS_MAYBE_BUILD_CLEANUP LANG_HOOKS_UPDATE_DECL_AFTER_SAVING \
1072         LANG_HOOKS_POPLEVEL LANG_HOOKS_TRUTHVALUE_CONVERSION \
1073         TARGET_PROMOTE_FUNCTION_ARGS TARGET_PROMOTE_FUNCTION_RETURN \
1074         LANG_HOOKS_MISSING_ARGUMENT LANG_HOOKS_HASH_TYPES \
1075         TARGET_HANDLE_OFAST TARGET_OPTION_OPTIMIZATION \
1076         TARGET_IRA_COVER_CLASSES TARGET_HELP \
1077         TARGET_HANDLE_PRAGMA_EXTERN_PREFIX \
1078         TARGET_VECTORIZE_BUILTIN_MUL_WIDEN_EVEN \
1079         TARGET_VECTORIZE_BUILTIN_MUL_WIDEN_ODD \
1080         TARGET_MD_ASM_CLOBBERS TARGET_RELAXED_ORDERING \
1081         EXTENDED_SDB_BASIC_TYPES TARGET_INVALID_PARAMETER_TYPE \
1082         TARGET_INVALID_RETURN_TYPE
1083
1084 /* Arrays that were deleted in favor of a functional interface.  */
1085  #pragma GCC poison built_in_decls implicit_built_in_decls
1086
1087 /* Hooks into libgcc2.  */
1088  #pragma GCC poison LIBGCC2_DOUBLE_TYPE_SIZE LIBGCC2_WORDS_BIG_ENDIAN \
1089    LIBGCC2_FLOAT_WORDS_BIG_ENDIAN
1090
1091 /* Miscellaneous macros that are no longer used.  */
1092  #pragma GCC poison USE_MAPPED_LOCATION GET_ENVIRONMENT
1093
1094 /* Libiberty macros that are no longer used in GCC.  */
1095 #undef ANSI_PROTOTYPES
1096 #undef PTR_CONST
1097 #undef LONG_DOUBLE
1098 #undef VPARAMS
1099 #undef VA_OPEN
1100 #undef VA_FIXEDARG
1101 #undef VA_CLOSE
1102 #undef VA_START
1103  #pragma GCC poison ANSI_PROTOTYPES PTR_CONST LONG_DOUBLE VPARAMS VA_OPEN \
1104   VA_FIXEDARG VA_CLOSE VA_START
1105 #endif /* IN_GCC */
1106
1107 /* Front ends should never have to include middle-end headers.  Enforce
1108    this by poisoning the header double-include protection defines.  */
1109 #ifdef IN_GCC_FRONTEND
1110 #pragma GCC poison GCC_RTL_H GCC_EXCEPT_H GCC_EXPR_H
1111 #endif
1112
1113 /* Note: not all uses of the `index' token (e.g. variable names and
1114    structure members) have been eliminated.  */
1115 #undef bcopy
1116 #undef bzero
1117 #undef bcmp
1118 #undef rindex
1119  #pragma GCC poison bcopy bzero bcmp rindex
1120
1121 /* Poison ENABLE_CHECKING macro that should be replaced with
1122    'if (flag_checking)', or with CHECKING_P macro.  */
1123 #pragma GCC poison ENABLE_CHECKING
1124
1125 #endif /* GCC >= 3.0 */
1126
1127 /* This macro allows casting away const-ness to pass -Wcast-qual
1128    warnings.  DO NOT USE THIS UNLESS YOU REALLY HAVE TO!  It should
1129    only be used in certain specific cases.  One valid case is where
1130    the C standard definitions or prototypes force you to.  E.g. if you
1131    need to free a const object, or if you pass a const string to
1132    execv, et al.  Another valid use would be in an allocation function
1133    that creates const objects that need to be initialized.  In some
1134    cases we have non-const functions that return the argument
1135    (e.g. next_nonnote_insn).  Rather than create const shadow
1136    functions, we can cast away const-ness in calling these interfaces
1137    if we're careful to verify that the called function does indeed not
1138    modify its argument and the return value is only used in a const
1139    context.  (This can be somewhat dangerous as these assumptions can
1140    change after the fact).  Beyond these uses, most other cases of
1141    using this macro should be viewed with extreme caution.  */
1142
1143 #ifdef __cplusplus
1144 #define CONST_CAST2(TOTYPE,FROMTYPE,X) (const_cast<TOTYPE> (X))
1145 #else
1146 #if defined(__GNUC__) && GCC_VERSION > 4000
1147 /* GCC 4.0.x has a bug where it may ICE on this expression,
1148    so does GCC 3.4.x (PR17436).  */
1149 #define CONST_CAST2(TOTYPE,FROMTYPE,X) ((__extension__(union {FROMTYPE _q; TOTYPE _nq;})(X))._nq)
1150 #elif defined(__GNUC__)
1151 static inline char *
1152 helper_const_non_const_cast (const char *p)
1153 {
1154   union {
1155     const char *const_c;
1156     char *c;
1157   } val;
1158   val.const_c = p;
1159   return val.c;
1160 }
1161
1162 #define CONST_CAST2(TOTYPE,FROMTYPE,X) \
1163         ((TOTYPE) helper_const_non_const_cast ((const char *) (FROMTYPE) (X)))
1164 #else
1165 #define CONST_CAST2(TOTYPE,FROMTYPE,X) ((TOTYPE)(FROMTYPE)(X))
1166 #endif
1167 #endif
1168 #define CONST_CAST(TYPE,X) CONST_CAST2 (TYPE, const TYPE, (X))
1169 #define CONST_CAST_TREE(X) CONST_CAST (union tree_node *, (X))
1170 #define CONST_CAST_RTX(X) CONST_CAST (struct rtx_def *, (X))
1171 #define CONST_CAST_RTX_INSN(X) CONST_CAST (struct rtx_insn *, (X))
1172 #define CONST_CAST_BB(X) CONST_CAST (struct basic_block_def *, (X))
1173 #define CONST_CAST_GIMPLE(X) CONST_CAST (gimple *, (X))
1174
1175 /* Activate certain diagnostics as warnings (not errors via the
1176    -Werror flag).  */
1177 #if GCC_VERSION >= 4003
1178 /* If asserts are disabled, activate -Wuninitialized as a warning (not
1179    an error/-Werror).  */
1180 #ifndef ENABLE_ASSERT_CHECKING
1181 #pragma GCC diagnostic warning "-Wuninitialized"
1182 #endif
1183 #endif
1184
1185 #ifdef ENABLE_VALGRIND_ANNOTATIONS
1186 # ifdef HAVE_VALGRIND_MEMCHECK_H
1187 #  include <valgrind/memcheck.h>
1188 # elif defined HAVE_MEMCHECK_H
1189 #  include <memcheck.h>
1190 # else
1191 #  include <valgrind.h>
1192 # endif
1193 /* Compatibility macros to let valgrind 3.1 work.  */
1194 # ifndef VALGRIND_MAKE_MEM_NOACCESS
1195 #  define VALGRIND_MAKE_MEM_NOACCESS VALGRIND_MAKE_NOACCESS
1196 # endif
1197 # ifndef VALGRIND_MAKE_MEM_DEFINED
1198 #  define VALGRIND_MAKE_MEM_DEFINED VALGRIND_MAKE_READABLE
1199 # endif
1200 # ifndef VALGRIND_MAKE_MEM_UNDEFINED
1201 #  define VALGRIND_MAKE_MEM_UNDEFINED VALGRIND_MAKE_WRITABLE
1202 # endif
1203 #else
1204 /* Avoid #ifdef:s when we can help it.  */
1205 #define VALGRIND_DISCARD(x)
1206 #define VALGRIND_MALLOCLIKE_BLOCK(w,x,y,z)
1207 #define VALGRIND_FREELIKE_BLOCK(x,y)
1208 #endif
1209
1210 /* Macros to temporarily ignore some warnings.  */
1211 #if GCC_VERSION >= 6000
1212 #define GCC_DIAGNOSTIC_STRINGIFY(x) #x
1213 #define GCC_DIAGNOSTIC_PUSH_IGNORED(x) \
1214   _Pragma ("GCC diagnostic push") \
1215   _Pragma (GCC_DIAGNOSTIC_STRINGIFY (GCC diagnostic ignored #x))
1216 #define GCC_DIAGNOSTIC_POP _Pragma ("GCC diagnostic pop")
1217 #else
1218 #define GCC_DIAGNOSTIC_PUSH_IGNORED(x)
1219 #define GCC_DIAGNOSTIC_POP
1220 #endif
1221
1222 /* In LTO -fwhole-program build we still want to keep the debug functions available
1223    for debugger.  Mark them as used to prevent removal.  */
1224 #if (GCC_VERSION > 4000)
1225 #define DEBUG_FUNCTION __attribute__ ((__used__))
1226 #define DEBUG_VARIABLE __attribute__ ((__used__))
1227 #else
1228 #define DEBUG_FUNCTION
1229 #define DEBUG_VARIABLE
1230 #endif
1231
1232 /* General macro to extract bit Y of X.  */
1233 #define TEST_BIT(X, Y) (((X) >> (Y)) & 1)
1234
1235 /* Get definitions of HOST_WIDE_INT.  */
1236 #include "hwint.h"
1237
1238 typedef int sort_r_cmp_fn (const void *, const void *, void *);
1239 void qsort_chk (void *, size_t, size_t, sort_r_cmp_fn *, void *);
1240 void gcc_sort_r (void *, size_t, size_t, sort_r_cmp_fn *, void *);
1241 void gcc_qsort (void *, size_t, size_t, int (*)(const void *, const void *));
1242 void gcc_stablesort (void *, size_t, size_t,
1243                      int (*)(const void *, const void *));
1244 /* Redirect four-argument qsort calls to gcc_qsort; one-argument invocations
1245    correspond to vec::qsort, and use C qsort internally.  */
1246 #define PP_5th(a1, a2, a3, a4, a5, ...) a5
1247 #undef qsort
1248 #define qsort(...) PP_5th (__VA_ARGS__, gcc_qsort, 3, 2, qsort, 0) (__VA_ARGS__)
1249
1250 #define ONE_K 1024
1251 #define ONE_M (ONE_K * ONE_K)
1252 #define ONE_G (ONE_K * ONE_M)
1253
1254 /* Display a number as an integer multiple of either:
1255    - 1024, if said integer is >= to 10 K (in base 2)
1256    - 1024 * 1024, if said integer is >= 10 M in (base 2)
1257  */
1258 #define SIZE_SCALE(x) (((x) < 10 * ONE_K \
1259                         ? (x) \
1260                         : ((x) < 10 * ONE_M \
1261                            ? (x) / ONE_K \
1262                            : (x) / ONE_M)))
1263
1264 /* For a given integer, display either:
1265    - the character 'k', if the number is higher than 10 K (in base 2)
1266      but strictly lower than 10 M (in base 2)
1267    - the character 'M' if the number is higher than 10 M (in base2)
1268    - the charcter ' ' if the number is strictly lower  than 10 K  */
1269 #define SIZE_LABEL(x) ((x) < 10 * ONE_K ? ' ' : ((x) < 10 * ONE_M ? 'k' : 'M'))
1270
1271 /* Display an integer amount as multiple of 1K or 1M (in base 2).
1272    Display the correct unit (either k, M, or ' ') after the amount, as
1273    well.  */
1274 #define SIZE_AMOUNT(size) (uint64_t)SIZE_SCALE (size), SIZE_LABEL (size)
1275
1276 /* Format string particle for printing a SIZE_AMOUNT with N being the width
1277    of the number.  */
1278 #define PRsa(n) "%" #n PRIu64 "%c"
1279
1280 /* System headers may define NULL to be an integer (e.g. 0L), which cannot be
1281    used safely in certain contexts (e.g. as sentinels).  Redefine NULL to
1282    nullptr in order to make it safer.  Note that this might confuse system
1283    headers, however, by convention they must not be included after this point.
1284 */
1285 #ifdef __cplusplus
1286 #undef NULL
1287 #define NULL nullptr
1288 #endif
1289
1290 #endif /* ! GCC_SYSTEM_H */