gcc/system.h

   1 /* Get common system includes and various definitions and declarations based
   2    on autoconf macros.
   3    Copyright (C) 1998, 1999 Free Software Foundation, Inc.
   4
   5 This file is part of GNU CC.
   6
   7 GNU CC is free software; you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License as published by
   9 the Free Software Foundation; either version 2, or (at your option)
  10 any later version.
  11
  12 GNU CC is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 GNU General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with GNU CC; see the file COPYING.  If not, write to
  19 the Free Software Foundation, 59 Temple Place - Suite 330,
  20 Boston, MA 02111-1307, USA.  */
  21
  22
  23 #ifndef __GCC_SYSTEM_H__
  24 #define __GCC_SYSTEM_H__
  25
  26 /* We must include stdarg.h/varargs.h before stdio.h. */
  27 #ifdef ANSI_PROTOTYPES
  28 #include <stdarg.h>
  29 #else
  30 #include <varargs.h>
  31 #endif
  32
  33 #include <stdio.h>
  34
  35 /* Define a generic NULL if one hasn't already been defined.  */
  36 #ifndef NULL
  37 #define NULL 0
  38 #endif
  39
  40 /* The compiler is not a multi-threaded application and therefore we
  41    do not have to use the locking functions.
  42
  43    NEED_DECLARATION_PUTC_UNLOCKED actually indicates whether or not
  44    the IO code is multi-thread safe by default.  If it is not declared,
  45    then do not worry about using the _unlocked functions.
  46
  47    fputs_unlocked is an extension and needs to be prototyped specially.  */
  48
  49 #if defined HAVE_PUTC_UNLOCKED && !defined NEED_DECLARATION_PUTC_UNLOCKED
  50 # undef putc
  51 # define putc(C, Stream) putc_unlocked (C, Stream)
  52 #endif
  53 #if defined HAVE_FPUTC_UNLOCKED && !defined NEED_DECLARATION_PUTC_UNLOCKED
  54 # undef fputc
  55 # define fputc(C, Stream) fputc_unlocked (C, Stream)
  56 #endif
  57 #if defined HAVE_FPUTS_UNLOCKED && !defined NEED_DECLARATION_PUTC_UNLOCKED
  58 # undef fputs
  59 # define fputs(String, Stream) fputs_unlocked (String, Stream)
  60 # ifdef NEED_DECLARATION_FPUTS_UNLOCKED
  61 extern int fputs_unlocked PROTO ((const char *, FILE *));
  62 # endif
  63 #endif
  64
  65 #include <ctype.h>
  66
  67 /* Jim Meyering writes:
  68
  69    "... Some ctype macros are valid only for character codes that
  70    isascii says are ASCII (SGI's IRIX-4.0.5 is one such system --when
  71    using /bin/cc or gcc but without giving an ansi option).  So, all
  72    ctype uses should be through macros like ISPRINT...  If
  73    STDC_HEADERS is defined, then autoconf has verified that the ctype
  74    macros don't need to be guarded with references to isascii. ...
  75    Defining isascii to 1 should let any compiler worth its salt
  76    eliminate the && through constant folding."
  77
  78    Bruno Haible adds:
  79
  80    "... Furthermore, isupper(c) etc. have an undefined result if c is
  81    outside the range -1 <= c <= 255. One is tempted to write isupper(c)
  82    with c being of type `char', but this is wrong if c is an 8-bit
  83    character >= 128 which gets sign-extended to a negative value.
  84    The macro ISUPPER protects against this as well."  */
  85
  86 #if defined (STDC_HEADERS) || (!defined (isascii) && !defined (HAVE_ISASCII))
  87 # define IN_CTYPE_DOMAIN(c) 1
  88 #else
  89 # define IN_CTYPE_DOMAIN(c) isascii(c)
  90 #endif
  91
  92 #ifdef isblank
  93 # define ISBLANK(c) (IN_CTYPE_DOMAIN (c) && isblank (c))
  94 #else
  95 # define ISBLANK(c) ((c) == ' ' || (c) == '\t')
  96 #endif
  97 #ifdef isgraph
  98 # define ISGRAPH(c) (IN_CTYPE_DOMAIN (c) && isgraph (c))
  99 #else
 100 # define ISGRAPH(c) (IN_CTYPE_DOMAIN (c) && isprint (c) && !isspace (c))
 101 #endif
 102
 103 #define ISPRINT(c) (IN_CTYPE_DOMAIN (c) && isprint (c))
 104 #define ISALNUM(c) (IN_CTYPE_DOMAIN (c) && isalnum (c))
 105 #define ISALPHA(c) (IN_CTYPE_DOMAIN (c) && isalpha (c))
 106 #define ISCNTRL(c) (IN_CTYPE_DOMAIN (c) && iscntrl (c))
 107 #define ISLOWER(c) (IN_CTYPE_DOMAIN (c) && islower (c))
 108 #define ISPUNCT(c) (IN_CTYPE_DOMAIN (c) && ispunct (c))
 109 #define ISSPACE(c) (IN_CTYPE_DOMAIN (c) && isspace (c))
 110 #define ISUPPER(c) (IN_CTYPE_DOMAIN (c) && isupper (c))
 111 #define ISXDIGIT(c) (IN_CTYPE_DOMAIN (c) && isxdigit (c))
 112 #define ISDIGIT_LOCALE(c) (IN_CTYPE_DOMAIN (c) && isdigit (c))
 113
 114 /* ISDIGIT differs from ISDIGIT_LOCALE, as follows:
 115    - Its arg may be any int or unsigned int; it need not be an unsigned char.
 116    - It's guaranteed to evaluate its argument exactly once.
 117    - It's typically faster.
 118    Posix 1003.2-1992 section 2.5.2.1 page 50 lines 1556-1558 says that
 119    only '0' through '9' are digits.  Prefer ISDIGIT to ISDIGIT_LOCALE unless
 120    it's important to use the locale's definition of `digit' even when the
 121    host does not conform to Posix.  */
 122 #define ISDIGIT(c) ((unsigned) (c) - '0' <= 9)
 123
 124
 125 #ifdef HAVE_SYS_TYPES_H
 126 #include <sys/types.h>
 127 #endif
 128
 129 #include <errno.h>
 130
 131 #ifndef errno
 132 extern int errno;
 133 #endif
 134
 135 #ifdef STRING_WITH_STRINGS
 136 # include <string.h>
 137 # include <strings.h>
 138 #else
 139 # ifdef HAVE_STRING_H
 140 #  include <string.h>
 141 # else
 142 #  ifdef HAVE_STRINGS_H
 143 #   include <strings.h>
 144 #  endif
 145 # endif
 146 #endif
 147
 148 #ifdef HAVE_STDLIB_H
 149 # include <stdlib.h>
 150 #endif
 151
 152 #ifdef HAVE_UNISTD_H
 153 # include <unistd.h>
 154 #endif
 155
 156 #ifdef HAVE_SYS_PARAM_H
 157 # include <sys/param.h>
 158 #endif
 159
 160 #if HAVE_LIMITS_H
 161 # include <limits.h>
 162 #endif
 163
 164 /* Find HOST_WIDEST_INT and set its bit size, type and print macros.
 165    It will be the largest integer mode supported by the host which may
 166    (or may not) be larger than HOST_WIDE_INT.  This must appear after
 167    <limits.h> since we only use `long long' if its bigger than a
 168    `long' and also if it is supported by macros in limits.h.  For old
 169    hosts which don't have a limits.h (and thus won't include it in
 170    stage2 cause we don't rerun configure) we assume gcc supports long
 171    long.)  Note, you won't get these defined if you don't include
 172    {ht}config.h before this file to set the HOST_BITS_PER_* macros. */
 173
 174 #ifndef HOST_WIDEST_INT
 175 # if defined (HOST_BITS_PER_LONG) && defined (HOST_BITS_PER_LONGLONG)
 176 #  if (HOST_BITS_PER_LONGLONG > HOST_BITS_PER_LONG) && (defined (LONG_LONG_MAX) || defined (LONGLONG_MAX) || defined (LLONG_MAX) || defined (__GNUC__))
 177 #   define HOST_BITS_PER_WIDEST_INT HOST_BITS_PER_LONGLONG
 178 #   define HOST_WIDEST_INT long long
 179 #   define HOST_WIDEST_INT_PRINT_DEC "%lld"
 180 #   define HOST_WIDEST_INT_PRINT_UNSIGNED "%llu"
 181 #   define HOST_WIDEST_INT_PRINT_HEX "0x%llx"
 182 #  else
 183 #   define HOST_BITS_PER_WIDEST_INT HOST_BITS_PER_LONG
 184 #   define HOST_WIDEST_INT long
 185 #   define HOST_WIDEST_INT_PRINT_DEC "%ld"
 186 #   define HOST_WIDEST_INT_PRINT_UNSIGNED "%lu"
 187 #   define HOST_WIDEST_INT_PRINT_HEX "0x%lx"
 188 #  endif /*(long long>long) && (LONG_LONG_MAX||LONGLONG_MAX||LLONG_MAX||GNUC)*/
 189 # endif /* defined(HOST_BITS_PER_LONG) && defined(HOST_BITS_PER_LONGLONG) */
 190 #endif /* ! HOST_WIDEST_INT */
 191
 192 #ifdef TIME_WITH_SYS_TIME
 193 # include <sys/time.h>
 194 # include <time.h>
 195 #else
 196 # if HAVE_SYS_TIME_H
 197 #  include <sys/time.h>
 198 # else
 199 #  ifdef HAVE_TIME_H
 200 #   include <time.h>
 201 #  endif
 202 # endif
 203 #endif
 204
 205 #ifdef HAVE_FCNTL_H
 206 # include <fcntl.h>
 207 #else
 208 # ifdef HAVE_SYS_FILE_H
 209 #  include <sys/file.h>
 210 # endif
 211 #endif
 212
 213 #ifndef SEEK_SET
 214 # define SEEK_SET 0
 215 # define SEEK_CUR 1
 216 # define SEEK_END 2
 217 #endif
 218 #ifndef F_OK
 219 # define F_OK 0
 220 # define X_OK 1
 221 # define W_OK 2
 222 # define R_OK 4
 223 #endif
 224 #ifndef O_RDONLY
 225 # define O_RDONLY 0
 226 #endif
 227 #ifndef O_WRONLY
 228 # define O_WRONLY 1
 229 #endif
 230
 231 /* Some systems define these in, e.g., param.h.  We undefine these names
 232    here to avoid the warnings.  We prefer to use our definitions since we
 233    know they are correct.  */
 234
 235 #undef MIN
 236 #undef MAX
 237 #define MIN(X,Y) ((X) < (Y) ? (X) : (Y))
 238 #define MAX(X,Y) ((X) > (Y) ? (X) : (Y))
 239
 240 #ifdef HAVE_SYS_WAIT_H
 241 #include <sys/wait.h>
 242 #endif
 243
 244 #ifndef WIFSIGNALED
 245 #define WIFSIGNALED(S) (((S) & 0xff) != 0 && ((S) & 0xff) != 0x7f)
 246 #endif
 247 #ifndef WTERMSIG
 248 #define WTERMSIG(S) ((S) & 0x7f)
 249 #endif
 250 #ifndef WIFEXITED
 251 #define WIFEXITED(S) (((S) & 0xff) == 0)
 252 #endif
 253 #ifndef WEXITSTATUS
 254 #define WEXITSTATUS(S) (((S) & 0xff00) >> 8)
 255 #endif
 256 #ifndef WSTOPSIG
 257 #define WSTOPSIG WEXITSTATUS
 258 #endif
 259
 260
 261
 262 #ifndef bcopy
 263 # ifdef HAVE_BCOPY
 264 #  ifdef NEED_DECLARATION_BCOPY
 265 extern void bcopy ();
 266 #  endif
 267 # else /* ! HAVE_BCOPY */
 268 #  define bcopy(src,dst,len) memmove((dst),(src),(len))
 269 # endif
 270 #endif
 271
 272 #ifndef bcmp
 273 # ifdef HAVE_BCMP
 274 #  ifdef NEED_DECLARATION_BCMP
 275 extern int bcmp ();
 276 #  endif
 277 # else /* ! HAVE_BCMP */
 278 #  define bcmp(left,right,len) memcmp ((left),(right),(len))
 279 # endif
 280 #endif
 281
 282 #ifndef bzero
 283 # ifdef HAVE_BZERO
 284 #  ifdef NEED_DECLARATION_BZERO
 285 extern void bzero ();
 286 #  endif
 287 # else /* ! HAVE_BZERO */
 288 #  define bzero(dst,len) memset ((dst),0,(len))
 289 # endif
 290 #endif
 291
 292 #ifndef index
 293 # ifdef HAVE_INDEX
 294 #  ifdef NEED_DECLARATION_INDEX
 295 extern char *index ();
 296 #  endif
 297 # else /* ! HAVE_INDEX */
 298 #  define index strchr
 299 # endif
 300 #endif
 301
 302 #ifndef rindex
 303 # ifdef HAVE_RINDEX
 304 #  ifdef NEED_DECLARATION_RINDEX
 305 extern char *rindex ();
 306 #  endif
 307 # else /* ! HAVE_RINDEX */
 308 #  define rindex strrchr
 309 # endif
 310 #endif
 311
 312 #ifdef NEED_DECLARATION_ATOF
 313 extern double atof ();
 314 #endif
 315
 316 #ifdef NEED_DECLARATION_ATOL
 317 extern long atol();
 318 #endif
 319
 320 #ifdef NEED_DECLARATION_FREE
 321 extern void free ();
 322 #endif
 323
 324 #ifdef NEED_DECLARATION_GETCWD
 325 extern char *getcwd ();
 326 #endif
 327
 328 #ifdef NEED_DECLARATION_GETENV
 329 extern char *getenv ();
 330 #endif
 331
 332 #ifdef NEED_DECLARATION_GETWD
 333 extern char *getwd ();
 334 #endif
 335
 336 #ifdef NEED_DECLARATION_SBRK
 337 extern char *sbrk ();
 338 #endif
 339
 340 #ifdef NEED_DECLARATION_STRSTR
 341 extern char *strstr ();
 342 #endif
 343
 344 #ifdef HAVE_MALLOC_H
 345 #include <malloc.h>
 346 #endif
 347
 348 #ifdef NEED_DECLARATION_MALLOC
 349 extern char *malloc ();
 350 #endif
 351
 352 #ifdef NEED_DECLARATION_CALLOC
 353 extern char *calloc ();
 354 #endif
 355
 356 #ifdef NEED_DECLARATION_REMALLOC
 357 extern char *realloc ();
 358 #endif
 359
 360 #ifdef HAVE_STRERROR
 361 # ifdef NEED_DECLARATION_STRERROR
 362 #  ifndef strerror
 363 extern char *strerror ();
 364 #  endif
 365 # endif
 366 #else /* ! HAVE_STRERROR */
 367 extern int sys_nerr;
 368 extern char *sys_errlist[];
 369 #endif /* HAVE_STRERROR */
 370
 371 #ifdef HAVE_STRSIGNAL
 372 # ifdef NEED_DECLARATION_STRSIGNAL
 373 #  ifndef strsignal
 374 extern char * strsignal ();
 375 #  endif
 376 # endif
 377 #else /* ! HAVE_STRSIGNAL */
 378 # ifndef SYS_SIGLIST_DECLARED
 379 #  ifndef NO_SYS_SIGLIST
 380 extern char * sys_siglist[];
 381 #  endif
 382 # endif
 383 #endif /* HAVE_STRSIGNAL */
 384
 385 #ifdef HAVE_GETRLIMIT
 386 # ifdef NEED_DECLARATION_GETRLIMIT
 387 #  ifndef getrlimit
 388 extern int getrlimit ();
 389 #  endif
 390 # endif
 391 #endif
 392
 393 #ifdef HAVE_SETRLIMIT
 394 # ifdef NEED_DECLARATION_SETRLIMIT
 395 #  ifndef setrlimit
 396 extern int setrlimit ();
 397 #  endif
 398 # endif
 399 #endif
 400
 401 /* HAVE_VOLATILE only refers to the stage1 compiler.  We also check
 402    __STDC__ and assume gcc sets it and has volatile in stage >=2. */
 403 #if !defined(HAVE_VOLATILE) && !defined(__STDC__) && !defined(volatile)
 404 #define volatile
 405 #endif
 406
 407 #ifdef NEED_DECLARATION_ABORT
 408 extern void abort ();
 409 #endif
 410
 411 /* Define a STRINGIFY macro that's right for ANSI or traditional C.
 412    HAVE_CPP_STRINGIFY only refers to the stage1 compiler.  Assume that
 413    (non-traditional) gcc used in stage2 or later has this feature.
 414
 415    Note: if the argument passed to STRINGIFY is itself a macro, eg
 416    #define foo bar, STRINGIFY(foo) will produce "foo", not "bar".
 417    Although the __STDC__ case could be made to expand this via a layer
 418    of indirection, the traditional C case can not do so.  Therefore
 419    this behavior is not supported. */
 420 #ifndef STRINGIFY
 421 # if defined(HAVE_CPP_STRINGIFY) || (defined(__GNUC__) && defined(__STDC__))
 422 #  define STRINGIFY(STRING) #STRING
 423 # else
 424 #  define STRINGIFY(STRING) "STRING"
 425 # endif
 426 #endif /* ! STRINGIFY */
 427
 428 #if HAVE_SYS_STAT_H
 429 # include <sys/stat.h>
 430 #endif
 431
 432 /* Test if something is a normal file.  */
 433 #ifndef S_ISREG
 434 #define S_ISREG(m) (((m) & S_IFMT) == S_IFREG)
 435 #endif
 436
 437 /* Test if something is a directory.  */
 438 #ifndef S_ISDIR
 439 #define S_ISDIR(m) (((m) & S_IFMT) == S_IFDIR)
 440 #endif
 441
 442 /* Test if something is a character special file.  */
 443 #ifndef S_ISCHR
 444 #define S_ISCHR(m) (((m) & S_IFMT) == S_IFCHR)
 445 #endif
 446
 447 /* Test if something is a socket.  */
 448 #ifndef S_ISSOCK
 449 # ifdef S_IFSOCK
 450 #   define S_ISSOCK(m) (((m) & S_IFMT) == S_IFSOCK)
 451 # else
 452 #   define S_ISSOCK(m) 0
 453 # endif
 454 #endif
 455
 456 /* Test if something is a FIFO.  */
 457 #ifndef S_ISFIFO
 458 # ifdef S_IFIFO
 459 #  define S_ISFIFO(m) (((m) & S_IFMT) == S_IFIFO)
 460 # else
 461 #  define S_ISFIFO(m) 0
 462 # endif
 463 #endif
 464
 465 /* Approximate O_NONBLOCK.  */
 466 #ifndef O_NONBLOCK
 467 #define O_NONBLOCK O_NDELAY
 468 #endif
 469
 470 /* Approximate O_NOCTTY.  */
 471 #ifndef O_NOCTTY
 472 #define O_NOCTTY 0
 473 #endif
 474
 475 /* Define well known filenos if the system does not define them.  */
 476 #ifndef STDIN_FILENO
 477 # define STDIN_FILENO   0
 478 #endif
 479 #ifndef STDOUT_FILENO
 480 # define STDOUT_FILENO  1
 481 #endif
 482 #ifndef STDERR_FILENO
 483 # define STDERR_FILENO  2
 484 #endif
 485
 486 /* Some systems have mkdir that takes a single argument. */
 487 #ifdef MKDIR_TAKES_ONE_ARG
 488 # define mkdir(a,b) mkdir(a)
 489 #endif
 490
 491 /* Get libiberty declarations. */
 492 #include "libiberty.h"
 493
 494 #endif /* __GCC_SYSTEM_H__ */