system.h revision 96489
1/* Get common system includes and various definitions and declarations based 2 on autoconf macros. 3 Copyright (C) 1998, 1999, 2000, 2001, 2002 Free Software Foundation, Inc. 4 5This file is part of GCC. 6 7GCC is free software; you can redistribute it and/or modify it under 8the terms of the GNU General Public License as published by the Free 9Software Foundation; either version 2, or (at your option) any later 10version. 11 12GCC is distributed in the hope that it will be useful, but WITHOUT ANY 13WARRANTY; without even the implied warranty of MERCHANTABILITY or 14FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 15for more details. 16 17You should have received a copy of the GNU General Public License 18along with GCC; see the file COPYING. If not, write to the Free 19Software Foundation, 59 Temple Place - Suite 330, Boston, MA 2002111-1307, USA. */ 21 22 23#ifndef GCC_SYSTEM_H 24#define GCC_SYSTEM_H 25 26/* This is the location of the online document giving information how 27 to report bugs. If you change this string, also check for strings 28 not under control of the preprocessor. */ 29#define GCCBUGURL "<URL:http://www.gnu.org/software/gcc/bugs.html>" 30 31/* We must include stdarg.h/varargs.h before stdio.h. */ 32#ifdef ANSI_PROTOTYPES 33#include <stdarg.h> 34#else 35#include <varargs.h> 36#endif 37 38#ifndef va_copy 39# ifdef __va_copy 40# define va_copy(d,s) __va_copy((d),(s)) 41# else 42# define va_copy(d,s) ((d) = (s)) 43# endif 44#endif 45 46#ifdef HAVE_STDDEF_H 47# include <stddef.h> 48#endif 49 50#include <stdio.h> 51 52/* Define a generic NULL if one hasn't already been defined. */ 53#ifndef NULL 54#define NULL 0 55#endif 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_FPUTC_UNLOCKED 77# undef fputc 78# define fputc(C, Stream) fputc_unlocked (C, Stream) 79# endif 80 81# ifdef HAVE_FPUTS_UNLOCKED 82# undef fputs 83# define fputs(String, Stream) fputs_unlocked (String, Stream) 84# if defined (HAVE_DECL_FPUTS_UNLOCKED) && !HAVE_DECL_FPUTS_UNLOCKED 85extern int fputs_unlocked PARAMS ((const char *, FILE *)); 86# endif 87# endif 88# ifdef HAVE_FWRITE_UNLOCKED 89# undef fwrite 90# define fwrite(Ptr, Size, N, Stream) fwrite_unlocked (Ptr, Size, N, Stream) 91# if defined (HAVE_DECL_FWRITE_UNLOCKED) && !HAVE_DECL_FWRITE_UNLOCKED 92extern int fwrite_unlocked PARAMS ((const PTR, size_t, size_t, FILE *)); 93# endif 94# endif 95# ifdef HAVE_FPRINTF_UNLOCKED 96# undef fprintf 97/* We can't use a function-like macro here because we don't know if 98 we have varargs macros. */ 99# define fprintf fprintf_unlocked 100# if defined (HAVE_DECL_FPRINTF_UNLOCKED) && !HAVE_DECL_FPRINTF_UNLOCKED 101extern int fprintf_unlocked PARAMS ((FILE *, const char *, ...)); 102# endif 103# endif 104 105#endif 106 107/* There are an extraordinary number of issues with <ctype.h>. 108 The last straw is that it varies with the locale. Use libiberty's 109 replacement instead. */ 110#include <safe-ctype.h> 111 112#include <sys/types.h> 113 114#include <errno.h> 115 116#if !defined (errno) && defined (HAVE_DECL_ERRNO) && !HAVE_DECL_ERRNO 117extern int errno; 118#endif 119 120#ifdef STRING_WITH_STRINGS 121# include <string.h> 122# include <strings.h> 123#else 124# ifdef HAVE_STRING_H 125# include <string.h> 126# else 127# ifdef HAVE_STRINGS_H 128# include <strings.h> 129# endif 130# endif 131#endif 132 133#ifdef HAVE_STDLIB_H 134# include <stdlib.h> 135#endif 136 137/* If we don't have an overriding definition, set SUCCESS_EXIT_CODE and 138 FATAL_EXIT_CODE to EXIT_SUCCESS and EXIT_FAILURE respectively, 139 or 0 and 1 if those macros are not defined. */ 140#ifndef SUCCESS_EXIT_CODE 141# ifdef EXIT_SUCCESS 142# define SUCCESS_EXIT_CODE EXIT_SUCCESS 143# else 144# define SUCCESS_EXIT_CODE 0 145# endif 146#endif 147 148#ifndef FATAL_EXIT_CODE 149# ifdef EXIT_FAILURE 150# define FATAL_EXIT_CODE EXIT_FAILURE 151# else 152# define FATAL_EXIT_CODE 1 153# endif 154#endif 155 156#ifdef HAVE_UNISTD_H 157# include <unistd.h> 158#endif 159 160#ifdef HAVE_SYS_PARAM_H 161# include <sys/param.h> 162/* We use this identifier later and it appears in some vendor param.h's. */ 163# undef PREFETCH 164#endif 165 166#if HAVE_LIMITS_H 167# include <limits.h> 168#endif 169 170/* Get definitions of HOST_WIDE_INT and HOST_WIDEST_INT. */ 171#include "hwint.h" 172 173/* A macro to determine whether a VALUE lies inclusively within a 174 certain range without evaluating the VALUE more than once. This 175 macro won't warn if the VALUE is unsigned and the LOWER bound is 176 zero, as it would e.g. with "VALUE >= 0 && ...". Note the LOWER 177 bound *is* evaluated twice, and LOWER must not be greater than 178 UPPER. However the bounds themselves can be either positive or 179 negative. */ 180#define IN_RANGE(VALUE, LOWER, UPPER) \ 181 ((unsigned HOST_WIDE_INT) ((VALUE) - (LOWER)) <= ((UPPER) - (LOWER))) 182 183/* Infrastructure for defining missing _MAX and _MIN macros. Note that 184 macros defined with these cannot be used in #if. */ 185 186/* The extra casts work around common compiler bugs. */ 187#define INTTYPE_SIGNED(t) (! ((t) 0 < (t) -1)) 188/* The outer cast is needed to work around a bug in Cray C 5.0.3.0. 189 It is necessary at least when t == time_t. */ 190#define INTTYPE_MINIMUM(t) ((t) (INTTYPE_SIGNED (t) \ 191 ? ~ (t) 0 << (sizeof(t) * CHAR_BIT - 1) : (t) 0)) 192#define INTTYPE_MAXIMUM(t) ((t) (~ (t) 0 - INTTYPE_MINIMUM (t))) 193 194/* Use that infrastructure to provide a few constants. */ 195#ifndef UCHAR_MAX 196# define UCHAR_MAX INTTYPE_MAXIMUM (unsigned char) 197#endif 198 199#ifdef TIME_WITH_SYS_TIME 200# include <sys/time.h> 201# include <time.h> 202#else 203# if HAVE_SYS_TIME_H 204# include <sys/time.h> 205# else 206# ifdef HAVE_TIME_H 207# include <time.h> 208# endif 209# endif 210#endif 211 212#ifdef HAVE_FCNTL_H 213# include <fcntl.h> 214#else 215# ifdef HAVE_SYS_FILE_H 216# include <sys/file.h> 217# endif 218#endif 219 220#ifndef SEEK_SET 221# define SEEK_SET 0 222# define SEEK_CUR 1 223# define SEEK_END 2 224#endif 225#ifndef F_OK 226# define F_OK 0 227# define X_OK 1 228# define W_OK 2 229# define R_OK 4 230#endif 231#ifndef O_RDONLY 232# define O_RDONLY 0 233#endif 234#ifndef O_WRONLY 235# define O_WRONLY 1 236#endif 237 238/* Some systems define these in, e.g., param.h. We undefine these names 239 here to avoid the warnings. We prefer to use our definitions since we 240 know they are correct. */ 241 242#undef MIN 243#undef MAX 244#define MIN(X,Y) ((X) < (Y) ? (X) : (Y)) 245#define MAX(X,Y) ((X) > (Y) ? (X) : (Y)) 246 247/* Returns the least number N such that N * Y >= X. */ 248#define CEIL(x,y) (((x) + (y) - 1) / (y)) 249 250#ifdef HAVE_SYS_WAIT_H 251#include <sys/wait.h> 252#endif 253 254#ifndef WIFSIGNALED 255#define WIFSIGNALED(S) (((S) & 0xff) != 0 && ((S) & 0xff) != 0x7f) 256#endif 257#ifndef WTERMSIG 258#define WTERMSIG(S) ((S) & 0x7f) 259#endif 260#ifndef WIFEXITED 261#define WIFEXITED(S) (((S) & 0xff) == 0) 262#endif 263#ifndef WEXITSTATUS 264#define WEXITSTATUS(S) (((S) & 0xff00) >> 8) 265#endif 266#ifndef WSTOPSIG 267#define WSTOPSIG WEXITSTATUS 268#endif 269 270/* The HAVE_DECL_* macros are three-state, undefined, 0 or 1. If they 271 are defined to 0 then we must provide the relevant declaration 272 here. These checks will be in the undefined state while configure 273 is running so be careful to test "defined (HAVE_DECL_*)". */ 274 275#if defined (HAVE_DECL_ATOF) && !HAVE_DECL_ATOF 276extern double atof PARAMS ((const char *)); 277#endif 278 279#if defined (HAVE_DECL_ATOL) && !HAVE_DECL_ATOL 280extern long atol PARAMS ((const char *)); 281#endif 282 283#if defined (HAVE_DECL_FREE) && !HAVE_DECL_FREE 284extern void free PARAMS ((PTR)); 285#endif 286 287#if defined (HAVE_DECL_GETCWD) && !HAVE_DECL_GETCWD 288extern char *getcwd PARAMS ((char *, size_t)); 289#endif 290 291#if defined (HAVE_DECL_GETENV) && !HAVE_DECL_GETENV 292extern char *getenv PARAMS ((const char *)); 293#endif 294 295#if defined (HAVE_DECL_GETOPT) && !HAVE_DECL_GETOPT 296extern int getopt PARAMS ((int, char * const *, const char *)); 297#endif 298 299#if defined (HAVE_DECL_GETWD) && !HAVE_DECL_GETWD 300extern char *getwd PARAMS ((char *)); 301#endif 302 303#if defined (HAVE_DECL_SBRK) && !HAVE_DECL_SBRK 304extern PTR sbrk PARAMS ((int)); 305#endif 306 307#if defined (HAVE_DECL_STRSTR) && !HAVE_DECL_STRSTR 308extern char *strstr PARAMS ((const char *, const char *)); 309#endif 310 311#ifdef HAVE_MALLOC_H 312#include <malloc.h> 313#endif 314 315#if defined (HAVE_DECL_MALLOC) && !HAVE_DECL_MALLOC 316extern PTR malloc PARAMS ((size_t)); 317#endif 318 319#if defined (HAVE_DECL_CALLOC) && !HAVE_DECL_CALLOC 320extern PTR calloc PARAMS ((size_t, size_t)); 321#endif 322 323#if defined (HAVE_DECL_REALLOC) && !HAVE_DECL_REALLOC 324extern PTR realloc PARAMS ((PTR, size_t)); 325#endif 326 327/* If the system doesn't provide strsignal, we get it defined in 328 libiberty but no declaration is supplied. */ 329#ifndef HAVE_STRSIGNAL 330# ifndef strsignal 331extern const char *strsignal PARAMS ((int)); 332# endif 333#endif 334 335#ifdef HAVE_GETRLIMIT 336# if defined (HAVE_DECL_GETRLIMIT) && !HAVE_DECL_GETRLIMIT 337# ifndef getrlimit 338# ifdef ANSI_PROTOTYPES 339struct rlimit; 340# endif 341extern int getrlimit PARAMS ((int, struct rlimit *)); 342# endif 343# endif 344#endif 345 346#ifdef HAVE_SETRLIMIT 347# if defined (HAVE_DECL_SETRLIMIT) && !HAVE_DECL_SETRLIMIT 348# ifndef setrlimit 349# ifdef ANSI_PROTOTYPES 350struct rlimit; 351# endif 352extern int setrlimit PARAMS ((int, const struct rlimit *)); 353# endif 354# endif 355#endif 356 357/* HAVE_VOLATILE only refers to the stage1 compiler. We also check 358 __STDC__ and assume gcc sets it and has volatile in stage >=2. */ 359#if !defined(HAVE_VOLATILE) && !defined(__STDC__) && !defined(volatile) 360#define volatile 361#endif 362 363#if defined (HAVE_DECL_ABORT) && !HAVE_DECL_ABORT 364extern void abort PARAMS ((void)); 365#endif 366 367/* 1 if we have C99 designated initializers. */ 368#if !defined(HAVE_DESIGNATED_INITIALIZERS) 369#define HAVE_DESIGNATED_INITIALIZERS \ 370 ((GCC_VERSION >= 2007) || (__STDC_VERSION__ >= 199901L)) 371#endif 372 373/* 1 if we have _Bool. */ 374#ifndef HAVE__BOOL 375# define HAVE__BOOL \ 376 ((GCC_VERSION >= 3000) || (__STDC_VERSION__ >= 199901L)) 377#endif 378 379 380#if HAVE_SYS_STAT_H 381# include <sys/stat.h> 382#endif 383 384/* Test if something is a normal file. */ 385#ifndef S_ISREG 386#define S_ISREG(m) (((m) & S_IFMT) == S_IFREG) 387#endif 388 389/* Test if something is a directory. */ 390#ifndef S_ISDIR 391#define S_ISDIR(m) (((m) & S_IFMT) == S_IFDIR) 392#endif 393 394/* Test if something is a character special file. */ 395#ifndef S_ISCHR 396#define S_ISCHR(m) (((m) & S_IFMT) == S_IFCHR) 397#endif 398 399/* Test if something is a block special file. */ 400#ifndef S_ISBLK 401#define S_ISBLK(m) (((m) & S_IFMT) == S_IFBLK) 402#endif 403 404/* Test if something is a socket. */ 405#ifndef S_ISSOCK 406# ifdef S_IFSOCK 407# define S_ISSOCK(m) (((m) & S_IFMT) == S_IFSOCK) 408# else 409# define S_ISSOCK(m) 0 410# endif 411#endif 412 413/* Test if something is a FIFO. */ 414#ifndef S_ISFIFO 415# ifdef S_IFIFO 416# define S_ISFIFO(m) (((m) & S_IFMT) == S_IFIFO) 417# else 418# define S_ISFIFO(m) 0 419# endif 420#endif 421 422/* Approximate O_NONBLOCK. */ 423#ifndef O_NONBLOCK 424#define O_NONBLOCK O_NDELAY 425#endif 426 427/* Approximate O_NOCTTY. */ 428#ifndef O_NOCTTY 429#define O_NOCTTY 0 430#endif 431 432/* Define well known filenos if the system does not define them. */ 433#ifndef STDIN_FILENO 434# define STDIN_FILENO 0 435#endif 436#ifndef STDOUT_FILENO 437# define STDOUT_FILENO 1 438#endif 439#ifndef STDERR_FILENO 440# define STDERR_FILENO 2 441#endif 442 443/* Some systems have mkdir that takes a single argument. */ 444#ifdef MKDIR_TAKES_ONE_ARG 445# define mkdir(a,b) mkdir(a) 446#endif 447 448/* Provide a way to print an address via printf. */ 449#ifndef HOST_PTR_PRINTF 450# ifdef HAVE_PRINTF_PTR 451# define HOST_PTR_PRINTF "%p" 452# else 453# define HOST_PTR_PRINTF \ 454 (sizeof (int) == sizeof (char *) ? "%x" \ 455 : sizeof (long) == sizeof (char *) ? "%lx" : "%llx") 456# endif 457#endif /* ! HOST_PTR_PRINTF */ 458 459/* By default, colon separates directories in a path. */ 460#ifndef PATH_SEPARATOR 461#define PATH_SEPARATOR ':' 462#endif 463 464#ifndef DIR_SEPARATOR 465#define DIR_SEPARATOR '/' 466#endif 467 468/* Define IS_DIR_SEPARATOR. */ 469#ifndef DIR_SEPARATOR_2 470# define IS_DIR_SEPARATOR(CH) ((CH) == DIR_SEPARATOR) 471#else /* DIR_SEPARATOR_2 */ 472# define IS_DIR_SEPARATOR(CH) \ 473 (((CH) == DIR_SEPARATOR) || ((CH) == DIR_SEPARATOR_2)) 474#endif /* DIR_SEPARATOR_2 */ 475 476/* Say how to test for an absolute pathname. On Unix systems, this is if 477 it starts with a leading slash or a '$', the latter meaning the value of 478 an environment variable is to be used. On machien with DOS-based 479 file systems, it is also absolute if it starts with a drive identifier. */ 480#ifdef HAVE_DOS_BASED_FILE_SYSTEM 481#define IS_ABSOLUTE_PATHNAME(STR) \ 482 (IS_DIR_SEPARATOR ((STR)[0]) || (STR)[0] == '$' \ 483 || ((STR)[0] != '\0' && (STR)[1] == ':' && IS_DIR_SEPARATOR ((STR)[2]))) 484#else 485#define IS_ABSOLUTE_PATHNAME(STR) \ 486 (IS_DIR_SEPARATOR ((STR)[0]) || (STR)[0] == '$') 487#endif 488 489/* Get libiberty declarations. */ 490#include "libiberty.h" 491#include "symcat.h" 492 493/* Provide a default for the HOST_BIT_BUCKET. 494 This suffices for POSIX-like hosts. */ 495 496#ifndef HOST_BIT_BUCKET 497#define HOST_BIT_BUCKET "/dev/null" 498#endif 499 500/* Be conservative and only use enum bitfields with GCC. 501 FIXME: provide a complete autoconf test for buggy enum bitfields. */ 502 503#if (GCC_VERSION > 2000) 504#define ENUM_BITFIELD(TYPE) enum TYPE 505#else 506#define ENUM_BITFIELD(TYPE) unsigned int 507#endif 508 509#ifndef offsetof 510#define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *) 0)->MEMBER) 511#endif 512 513/* Traditional C cannot initialize union members of structs. Provide 514 a macro which expands appropriately to handle it. This only works 515 if you intend to initialize the union member to zero since it relies 516 on default initialization to zero in the traditional C case. */ 517#ifdef __STDC__ 518#define UNION_INIT_ZERO , {0} 519#else 520#define UNION_INIT_ZERO 521#endif 522 523/* Various error reporting routines want to use __FUNCTION__. */ 524#if (GCC_VERSION < 2007) 525#ifndef __FUNCTION__ 526#define __FUNCTION__ "?" 527#endif /* ! __FUNCTION__ */ 528#endif 529 530/* __builtin_expect(A, B) evaluates to A, but notifies the compiler that 531 the most likely value of A is B. This feature was added at some point 532 between 2.95 and 3.0. Let's use 3.0 as the lower bound for now. */ 533#if (GCC_VERSION < 3000) 534#define __builtin_expect(a, b) (a) 535#endif 536 537/* Provide some sort of boolean type. We use stdbool.h if it's 538 available. This must be after all inclusion of system headers, 539 as some of them will mess us up. */ 540#undef bool 541#undef true 542#undef false 543#undef TRUE 544#undef FALSE 545 546#ifdef HAVE_STDBOOL_H 547# include <stdbool.h> 548#else 549# if !HAVE__BOOL 550typedef char _Bool; 551# endif 552# define bool _Bool 553# define true 1 554# define false 0 555#endif 556 557#define TRUE true 558#define FALSE false 559 560/* As the last action in this file, we poison the identifiers that 561 shouldn't be used. Note, luckily gcc-3.0's token-based integrated 562 preprocessor won't trip on poisoned identifiers that arrive from 563 the expansion of macros. E.g. #define strrchr rindex, won't error 564 if rindex is poisoned after this directive is issued and later on 565 strrchr is called. 566 567 Note: We define bypass macros for the few cases where we really 568 want to use the libc memory allocation routines. Otherwise we 569 insist you use the "x" versions from libiberty. */ 570 571#define really_call_malloc malloc 572#define really_call_calloc calloc 573#define really_call_realloc realloc 574 575#if (GCC_VERSION >= 3000) 576 577/* Note autoconf checks for prototype declarations and includes 578 system.h while doing so. Only poison these tokens if actually 579 compiling gcc, so that the autoconf declaration tests for malloc 580 etc don't spuriously fail. */ 581#ifdef IN_GCC 582#undef malloc 583#undef realloc 584#undef calloc 585#undef strdup 586 #pragma GCC poison malloc realloc calloc strdup 587 588/* Old target macros that have moved to the target hooks structure. */ 589 #pragma GCC poison ASM_OPEN_PAREN ASM_CLOSE_PAREN \ 590 FUNCTION_PROLOGUE FUNCTION_EPILOGUE \ 591 FUNCTION_END_PROLOGUE FUNCTION_BEGIN_EPILOGUE \ 592 DECL_MACHINE_ATTRIBUTES COMP_TYPE_ATTRIBUTES INSERT_ATTRIBUTES \ 593 VALID_MACHINE_DECL_ATTRIBUTE VALID_MACHINE_TYPE_ATTRIBUTE \ 594 SET_DEFAULT_TYPE_ATTRIBUTES SET_DEFAULT_DECL_ATTRIBUTES \ 595 MERGE_MACHINE_TYPE_ATTRIBUTES MERGE_MACHINE_DECL_ATTRIBUTES \ 596 MD_INIT_BUILTINS MD_EXPAND_BUILTIN ASM_OUTPUT_CONSTRUCTOR \ 597 ASM_OUTPUT_DESTRUCTOR SIGNED_CHAR_SPEC 598 599/* And other obsolete target macros, or macros that used to be in target 600 headers and were not used, and may be obsolete or may never have 601 been used. */ 602 #pragma GCC poison INT_ASM_OP ASM_OUTPUT_EH_REGION_BEG \ 603 ASM_OUTPUT_EH_REGION_END ASM_OUTPUT_LABELREF_AS_INT \ 604 DOESNT_NEED_UNWINDER EH_TABLE_LOOKUP OBJC_SELECTORS_WITHOUT_LABELS \ 605 OMIT_EH_TABLE EASY_DIV_EXPR IMPLICIT_FIX_EXPR \ 606 LONGJMP_RESTORE_FROM_STACK MAX_INT_TYPE_SIZE ASM_IDENTIFY_GCC \ 607 STDC_VALUE TRAMPOLINE_ALIGN ASM_IDENTIFY_GCC_AFTER_SOURCE \ 608 SLOW_ZERO_EXTEND SUBREG_REGNO_OFFSET DWARF_LINE_MIN_INSTR_LENGTH 609 610#endif /* IN_GCC */ 611 612/* Note: not all uses of the `index' token (e.g. variable names and 613 structure members) have been eliminated. */ 614#undef bcopy 615#undef bzero 616#undef bcmp 617#undef rindex 618 #pragma GCC poison bcopy bzero bcmp rindex 619 620#endif /* GCC >= 3.0 */ 621 622#endif /* ! GCC_SYSTEM_H */ 623