gnu/make/make.h

   1 /* Miscellaneous global declarations and portability cruft for GNU Make.
   2 Copyright (C) 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1999,
   3 2002 Free Software Foundation, Inc.
   4 This file is part of GNU Make.
   5
   6 GNU Make is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Make is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Make; see the file COPYING.  If not, write to
  18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  19 Boston, MA 02111-1307, USA.  */
  20
  21 /* We use <config.h> instead of "config.h" so that a compilation
  22    using -I. -I$srcdir will use ./config.h rather than $srcdir/config.h
  23    (which it would do because make.h was found in $srcdir).  */
  24 #include <config.h>
  25 #undef  HAVE_CONFIG_H
  26 #define HAVE_CONFIG_H 1
  27
  28 /* AIX requires this to be the first thing in the file.  */
  29 #ifndef __GNUC__
  30 # if HAVE_ALLOCA_H
  31 #  include <alloca.h>
  32 # else
  33 #  ifdef _AIX
  34  #pragma alloca
  35 #  else
  36 #   ifndef alloca /* predefined by HP cc +Olibcalls */
  37 char *alloca ();
  38 #   endif
  39 #  endif
  40 # endif
  41 #endif
  42
  43
  44 /* Use prototypes if available.  */
  45 #if defined (__cplusplus) || (defined (__STDC__) && __STDC__)
  46 # undef  PARAMS
  47 # define PARAMS(protos)  protos
  48 #else /* Not C++ or ANSI C.  */
  49 # undef  PARAMS
  50 # define PARAMS(protos)  ()
  51 #endif /* C++ or ANSI C.  */
  52
  53 /* Specify we want GNU source code.  This must be defined before any
  54    system headers are included.  */
  55
  56 #define _GNU_SOURCE 1
  57
  58
  59 #ifdef  CRAY
  60 /* This must happen before #include <signal.h> so
  61    that the declaration therein is changed.  */
  62 # define signal bsdsignal
  63 #endif
  64
  65 /* If we're compiling for the dmalloc debugger, turn off string inlining.  */
  66 #if defined(HAVE_DMALLOC_H) && defined(__GNUC__)
  67 # define __NO_STRING_INLINES
  68 #endif
  69
  70 #include <sys/types.h>
  71 #include <sys/stat.h>
  72 #include <signal.h>
  73 #include <stdio.h>
  74 #include <ctype.h>
  75 #ifdef HAVE_SYS_TIMEB_H
  76 /* SCO 3.2 "devsys 4.2" has a prototype for `ftime' in <time.h> that bombs
  77    unless <sys/timeb.h> has been included first.  Does every system have a
  78    <sys/timeb.h>?  If any does not, configure should check for it.  */
  79 # include <sys/timeb.h>
  80 #endif
  81
  82 #if TIME_WITH_SYS_TIME
  83 # include <sys/time.h>
  84 # include <time.h>
  85 #else
  86 # if HAVE_SYS_TIME_H
  87 #  include <sys/time.h>
  88 # else
  89 #  include <time.h>
  90 # endif
  91 #endif
  92
  93 #include <errno.h>
  94
  95 #ifndef errno
  96 extern int errno;
  97 #endif
  98
  99 #ifndef isblank
 100 # define isblank(c)     ((c) == ' ' || (c) == '\t')
 101 #endif
 102
 103 #ifdef  HAVE_UNISTD_H
 104 # include <unistd.h>
 105 /* Ultrix's unistd.h always defines _POSIX_VERSION, but you only get
 106    POSIX.1 behavior with `cc -YPOSIX', which predefines POSIX itself!  */
 107 # if defined (_POSIX_VERSION) && !defined (ultrix) && !defined (VMS)
 108 #  define POSIX 1
 109 # endif
 110 #endif
 111
 112 /* Some systems define _POSIX_VERSION but are not really POSIX.1.  */
 113 #if (defined (butterfly) || defined (__arm) || (defined (__mips) && defined (_SYSTYPE_SVR3)) || (defined (sequent) && defined (i386)))
 114 # undef POSIX
 115 #endif
 116
 117 #if !defined (POSIX) && defined (_AIX) && defined (_POSIX_SOURCE)
 118 # define POSIX 1
 119 #endif
 120
 121 #ifndef RETSIGTYPE
 122 # define RETSIGTYPE     void
 123 #endif
 124
 125 #ifndef sigmask
 126 # define sigmask(sig)   (1 << ((sig) - 1))
 127 #endif
 128
 129 #ifndef HAVE_SA_RESTART
 130 # define SA_RESTART 0
 131 #endif
 132
 133 #ifdef  HAVE_LIMITS_H
 134 # include <limits.h>
 135 #endif
 136 #ifdef  HAVE_SYS_PARAM_H
 137 # include <sys/param.h>
 138 #endif
 139
 140 #ifndef PATH_MAX
 141 # ifndef POSIX
 142 #  define PATH_MAX      MAXPATHLEN
 143 # endif
 144 #endif
 145 #ifndef MAXPATHLEN
 146 # define MAXPATHLEN 1024
 147 #endif
 148
 149 #ifdef  PATH_MAX
 150 # define GET_PATH_MAX   PATH_MAX
 151 # define PATH_VAR(var)  char var[PATH_MAX]
 152 #else
 153 # define NEED_GET_PATH_MAX 1
 154 # define GET_PATH_MAX   (get_path_max ())
 155 # define PATH_VAR(var)  char *var = (char *) alloca (GET_PATH_MAX)
 156 extern unsigned int get_path_max PARAMS ((void));
 157 #endif
 158
 159 #ifndef CHAR_BIT
 160 # define CHAR_BIT 8
 161 #endif
 162
 163 /* Nonzero if the integer type T is signed.  */
 164 #define INTEGER_TYPE_SIGNED(t) ((t) -1 < 0)
 165
 166 /* The minimum and maximum values for the integer type T.
 167    Use ~ (t) 0, not -1, for portability to 1's complement hosts.  */
 168 #define INTEGER_TYPE_MINIMUM(t) \
 169   (! INTEGER_TYPE_SIGNED (t) ? (t) 0 : ~ (t) 0 << (sizeof (t) * CHAR_BIT - 1))
 170 #define INTEGER_TYPE_MAXIMUM(t) (~ (t) 0 - INTEGER_TYPE_MINIMUM (t))
 171
 172 #ifndef CHAR_MAX
 173 # define CHAR_MAX INTEGER_TYPE_MAXIMUM (char)
 174 #endif
 175
 176 #ifdef STAT_MACROS_BROKEN
 177 # ifdef S_ISREG
 178 #  undef S_ISREG
 179 # endif
 180 # ifdef S_ISDIR
 181 #  undef S_ISDIR
 182 # endif
 183 #endif  /* STAT_MACROS_BROKEN.  */
 184
 185 #ifndef S_ISREG
 186 # define S_ISREG(mode)  (((mode) & S_IFMT) == S_IFREG)
 187 #endif
 188 #ifndef S_ISDIR
 189 # define S_ISDIR(mode)  (((mode) & S_IFMT) == S_IFDIR)
 190 #endif
 191
 192 #ifdef VMS
 193 # include <types.h>
 194 # include <unixlib.h>
 195 # include <unixio.h>
 196 # include <perror.h>
 197 /* Needed to use alloca on VMS.  */
 198 # include <builtins.h>
 199 #endif
 200
 201 #ifndef __attribute__
 202 /* This feature is available in gcc versions 2.5 and later.  */
 203 # if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 5) || __STRICT_ANSI__
 204 #  define __attribute__(x)
 205 # endif
 206 /* The __-protected variants of `format' and `printf' attributes
 207    are accepted by gcc versions 2.6.4 (effectively 2.7) and later.  */
 208 # if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 7)
 209 #  define __format__ format
 210 #  define __printf__ printf
 211 # endif
 212 #endif
 213 #define UNUSED  __attribute__ ((unused))
 214
 215 #if defined (STDC_HEADERS) || defined (__GNU_LIBRARY__)
 216 # include <stdlib.h>
 217 # include <string.h>
 218 # define ANSI_STRING 1
 219 #else   /* No standard headers.  */
 220 # ifdef HAVE_STRING_H
 221 #  include <string.h>
 222 #  define ANSI_STRING 1
 223 # else
 224 #  include <strings.h>
 225 # endif
 226 # ifdef HAVE_MEMORY_H
 227 #  include <memory.h>
 228 # endif
 229 # ifdef HAVE_STDLIB_H
 230 #  include <stdlib.h>
 231 # else
 232 extern char *malloc PARAMS ((int));
 233 extern char *realloc PARAMS ((char *, int));
 234 extern void free PARAMS ((char *));
 235
 236 extern void abort PARAMS ((void)) __attribute__ ((noreturn));
 237 extern void exit PARAMS ((int)) __attribute__ ((noreturn));
 238 # endif /* HAVE_STDLIB_H.  */
 239
 240 #endif /* Standard headers.  */
 241
 242 /* These should be in stdlib.h.  Make sure we have them.  */
 243 #ifndef EXIT_SUCCESS
 244 # define EXIT_SUCCESS 0
 245 #endif
 246 #ifndef EXIT_FAILURE
 247 # define EXIT_FAILURE 0
 248 #endif
 249
 250 #ifdef  ANSI_STRING
 251
 252 # ifndef bcmp
 253 #  define bcmp(s1, s2, n)   memcmp ((s1), (s2), (n))
 254 # endif
 255 # ifndef bzero
 256 #  define bzero(s, n)       memset ((s), 0, (n))
 257 # endif
 258 # if defined(HAVE_MEMMOVE) && !defined(bcopy)
 259 #  define bcopy(s, d, n)    memmove ((d), (s), (n))
 260 # endif
 261
 262 #else   /* Not ANSI_STRING.  */
 263
 264 # ifndef HAVE_STRCHR
 265 #  define strchr(s, c)      index((s), (c))
 266 #  define strrchr(s, c)     rindex((s), (c))
 267 # endif
 268
 269 # ifndef bcmp
 270 extern int bcmp PARAMS ((const char *, const char *, int));
 271 # endif
 272 # ifndef bzero
 273 extern void bzero PARAMS ((char *, int));
 274 #endif
 275 # ifndef bcopy
 276 extern void bcopy PARAMS ((const char *b1, char *b2, int));
 277 # endif
 278
 279 #endif  /* ANSI_STRING.  */
 280 #undef  ANSI_STRING
 281
 282 /* SCO Xenix has a buggy macro definition in <string.h>.  */
 283 #undef  strerror
 284
 285 #if !defined(ANSI_STRING) && !defined(__DECC) && !defined(__AROS__)
 286 extern char *strerror PARAMS ((int errnum));
 287 #endif
 288
 289 #if HAVE_INTTYPES_H
 290 # include <inttypes.h>
 291 #endif
 292 #define FILE_TIMESTAMP uintmax_t
 293
 294 #if !defined(HAVE_STRSIGNAL)
 295 extern char *strsignal PARAMS ((int signum));
 296 #endif
 297
 298 /* ISDIGIT offers the following features:
 299    - Its arg may be any int or unsigned int; it need not be an unsigned char.
 300    - It's guaranteed to evaluate its argument exactly once.
 301       NOTE!  Make relies on this behavior, don't change it!
 302    - It's typically faster.
 303    POSIX 1003.2-1992 section 2.5.2.1 page 50 lines 1556-1558 says that
 304    only '0' through '9' are digits.  Prefer ISDIGIT to isdigit() unless
 305    it's important to use the locale's definition of `digit' even when the
 306    host does not conform to POSIX.  */
 307 #define ISDIGIT(c) ((unsigned) (c) - '0' <= 9)
 308
 309 #ifndef iAPX286
 310 # define streq(a, b) \
 311    ((a) == (b) || \
 312     (*(a) == *(b) && (*(a) == '\0' || !strcmp ((a) + 1, (b) + 1))))
 313 # ifdef HAVE_CASE_INSENSITIVE_FS
 314 /* This is only used on Windows/DOS platforms, so we assume strcmpi().  */
 315 #  define strieq(a, b) \
 316     ((a) == (b) \
 317      || (tolower((unsigned char)*(a)) == tolower((unsigned char)*(b)) \
 318          && (*(a) == '\0' || !strcmpi ((a) + 1, (b) + 1))))
 319 # else
 320 #  define strieq(a, b) streq(a, b)
 321 # endif
 322 #else
 323 /* Buggy compiler can't handle this.  */
 324 # define streq(a, b) (strcmp ((a), (b)) == 0)
 325 # define strieq(a, b) (strcmp ((a), (b)) == 0)
 326 #endif
 327 #define strneq(a, b, l) (strncmp ((a), (b), (l)) == 0)
 328 #ifdef  VMS
 329 extern int strcmpi (const char *,const char *);
 330 #endif
 331
 332 #if defined(__GNUC__) || defined(ENUM_BITFIELDS)
 333 # define ENUM_BITFIELD(bits)    :bits
 334 #else
 335 # define ENUM_BITFIELD(bits)
 336 #endif
 337
 338 /* Handle gettext and locales.  */
 339
 340 #if HAVE_LOCALE_H
 341 # include <locale.h>
 342 #else
 343 # define setlocale(category, locale)
 344 #endif
 345
 346 #include <gettext.h>
 347
 348 #define _(msgid)            gettext (msgid)
 349 #define N_(msgid)           gettext_noop (msgid)
 350 #define S_(msg1,msg2,num)   ngettext (msg1,msg2,num)
 351
 352 /* Handle other OSs.  */
 353 #if defined(HAVE_DOS_PATHS)
 354 # define PATH_SEPARATOR_CHAR ';'
 355 #elif defined(VMS)
 356 # define PATH_SEPARATOR_CHAR ','
 357 #else
 358 # define PATH_SEPARATOR_CHAR ':'
 359 #endif
 360
 361 #ifdef WINDOWS32
 362 # include <fcntl.h>
 363 # include <malloc.h>
 364 # define pipe(p) _pipe(p, 512, O_BINARY)
 365 # define kill(pid,sig) w32_kill(pid,sig)
 366
 367 extern void sync_Path_environment(void);
 368 extern int kill(int pid, int sig);
 369 extern int safe_stat(char *file, struct stat *sb);
 370 extern char *end_of_token_w32(char *s, char stopchar);
 371 extern int find_and_set_default_shell(char *token);
 372
 373 /* indicates whether or not we have Bourne shell */
 374 extern int no_default_sh_exe;
 375
 376 /* is default_shell unixy? */
 377 extern int unixy_shell;
 378 #endif  /* WINDOWS32 */
 379
 380 struct floc
 381   {
 382     char *filenm;
 383     unsigned long lineno;
 384   };
 385 #define NILF ((struct floc *)0)
 386
 387 #define STRING_SIZE_TUPLE(_s) (_s), (sizeof (_s)-1)
 388
 389 \f
 390 /* We have to have stdarg.h or varargs.h AND v*printf or doprnt to use
 391    variadic versions of these functions.  */
 392
 393 #if HAVE_STDARG_H || HAVE_VARARGS_H
 394 # if HAVE_VPRINTF || HAVE_DOPRNT
 395 #  define USE_VARIADIC 1
 396 # endif
 397 #endif
 398
 399 #if HAVE_ANSI_COMPILER && USE_VARIADIC && HAVE_STDARG_H
 400 extern void message (int prefix, const char *fmt, ...)
 401                      __attribute__ ((__format__ (__printf__, 2, 3)));
 402 extern void error (const struct floc *flocp, const char *fmt, ...)
 403                    __attribute__ ((__format__ (__printf__, 2, 3)));
 404 extern void fatal (const struct floc *flocp, const char *fmt, ...)
 405                    __attribute__ ((noreturn, __format__ (__printf__, 2, 3)));
 406 #else
 407 extern void message ();
 408 extern void error ();
 409 extern void fatal ();
 410 #endif
 411
 412 extern void die PARAMS ((int)) __attribute__ ((noreturn));
 413 extern void log_working_directory PARAMS ((int));
 414 extern void pfatal_with_name PARAMS ((const char *)) __attribute__ ((noreturn));
 415 extern void perror_with_name PARAMS ((const char *, const char *));
 416 extern char *savestring PARAMS ((const char *, unsigned int));
 417 extern char *concat PARAMS ((const char *, const char *, const char *));
 418 extern char *xmalloc PARAMS ((unsigned int));
 419 extern char *xrealloc PARAMS ((char *, unsigned int));
 420 extern char *xstrdup PARAMS ((const char *));
 421 extern char *find_next_token PARAMS ((char **, unsigned int *));
 422 extern char *next_token PARAMS ((const char *));
 423 extern char *end_of_token PARAMS ((char *));
 424 extern void collapse_continuations PARAMS ((char *));
 425 extern void remove_comments PARAMS((char *));
 426 extern char *sindex PARAMS ((const char *, unsigned int, \
 427                              const char *, unsigned int));
 428 extern char *lindex PARAMS ((const char *, const char *, int));
 429 extern int alpha_compare PARAMS ((const void *, const void *));
 430 extern void print_spaces PARAMS ((unsigned int));
 431 extern char *find_char_unquote PARAMS ((char *, int, int, int));
 432 extern char *find_percent PARAMS ((char *));
 433 extern FILE *open_tmpfile PARAMS ((char **, const char *));
 434
 435 #ifndef NO_ARCHIVES
 436 extern int ar_name PARAMS ((char *));
 437 extern void ar_parse_name PARAMS ((char *, char **, char **));
 438 extern int ar_touch PARAMS ((char *));
 439 extern time_t ar_member_date PARAMS ((char *));
 440 #endif
 441
 442 extern int dir_file_exists_p PARAMS ((char *, char *));
 443 extern int file_exists_p PARAMS ((char *));
 444 extern int file_impossible_p PARAMS ((char *));
 445 extern void file_impossible PARAMS ((char *));
 446 extern char *dir_name PARAMS ((char *));
 447 extern void hash_init_directories PARAMS ((void));
 448
 449 extern void define_default_variables PARAMS ((void));
 450 extern void set_default_suffixes PARAMS ((void));
 451 extern void install_default_suffix_rules PARAMS ((void));
 452 extern void install_default_implicit_rules PARAMS ((void));
 453
 454 extern void build_vpath_lists PARAMS ((void));
 455 extern void construct_vpath_list PARAMS ((char *pattern, char *dirpath));
 456 extern int vpath_search PARAMS ((char **file, FILE_TIMESTAMP *mtime_ptr));
 457 extern int gpath_search PARAMS ((char *file, unsigned int len));
 458
 459 extern void construct_include_path PARAMS ((char **arg_dirs));
 460
 461 extern void user_access PARAMS ((void));
 462 extern void make_access PARAMS ((void));
 463 extern void child_access PARAMS ((void));
 464
 465 #ifdef  HAVE_VFORK_H
 466 # include <vfork.h>
 467 #endif
 468
 469 /* We omit these declarations on non-POSIX systems which define _POSIX_VERSION,
 470    because such systems often declare them in header files anyway.  */
 471
 472 #if !defined (__GNU_LIBRARY__) && !defined (POSIX) && !defined (_POSIX_VERSION) && !defined(WINDOWS32)
 473
 474 extern long int atol ();
 475 # ifndef VMS
 476 // extern long int lseek ();
 477 # endif
 478
 479 #endif  /* Not GNU C library or POSIX.  */
 480
 481 #ifdef  HAVE_GETCWD
 482 # if !defined(VMS) && !defined(__DECC)
 483 extern char *getcwd ();
 484 #endif
 485 #else
 486 extern char *getwd ();
 487 # define getcwd(buf, len)       getwd (buf)
 488 #endif
 489
 490 extern const struct floc *reading_file;
 491
 492 extern char **environ;
 493
 494 extern int just_print_flag, silent_flag, ignore_errors_flag, keep_going_flag;
 495 extern int print_data_base_flag, question_flag, touch_flag, always_make_flag;
 496 extern int env_overrides, no_builtin_rules_flag, no_builtin_variables_flag;
 497 extern int print_version_flag, print_directory_flag;
 498 extern int warn_undefined_variables_flag, posix_pedantic, not_parallel;
 499 extern int clock_skew_detected, rebuilding_makefiles;
 500
 501 /* can we run commands via 'sh -c xxx' or must we use batch files? */
 502 extern int batch_mode_shell;
 503
 504 extern unsigned int job_slots;
 505 extern int job_fds[2];
 506 extern int job_rfd;
 507 #ifndef NO_FLOAT
 508 extern double max_load_average;
 509 #else
 510 extern int max_load_average;
 511 #endif
 512
 513 extern char *program;
 514 extern char *starting_directory;
 515 extern unsigned int makelevel;
 516 extern char *version_string, *remote_description, *make_host;
 517
 518 extern unsigned int commands_started;
 519
 520 extern int handling_fatal_signal;
 521
 522
 523 #ifndef MIN
 524 #define MIN(_a,_b) ((_a)<(_b)?(_a):(_b))
 525 #endif
 526 #ifndef MAX
 527 #define MAX(_a,_b) ((_a)>(_b)?(_a):(_b))
 528 #endif
 529
 530 #ifdef VMS
 531 #  define MAKE_SUCCESS 1
 532 #  define MAKE_TROUBLE 2
 533 #  define MAKE_FAILURE 3
 534 #else
 535 #  define MAKE_SUCCESS 0
 536 #  define MAKE_TROUBLE 1
 537 #  define MAKE_FAILURE 2
 538 #endif
 539
 540 /* Set up heap debugging library dmalloc.  */
 541
 542 #ifdef HAVE_DMALLOC_H
 543 #include <dmalloc.h>
 544 #endif
 545
 546 #ifndef initialize_main
 547 # ifdef __EMX__
 548 #  define initialize_main(pargc, pargv) \
 549                           { _wildcard(pargc, pargv); _response(pargc, pargv); }
 550 # else
 551 #  define initialize_main(pargc, pargv)
 552 # endif
 553 #endif
 554
 555
 556 #ifdef __EMX__
 557 # if !HAVE_STRCASECMP
 558 #  define strcasecmp stricmp
 559 # endif
 560
 561 # if !defined chdir
 562 #  define chdir _chdir2
 563 # endif
 564 # if !defined getcwd
 565 #  define getcwd _getcwd2
 566 # endif
 567
 568 /* NO_CHDIR2 causes make not to use _chdir2() and _getcwd2() instead of
 569    chdir() and getcwd(). This avoids some error messages for the
 570    make testsuite but restricts the drive letter support. */
 571 # ifdef NO_CHDIR2
 572 #  warning NO_CHDIR2: usage of drive letters restricted
 573 #  undef chdir
 574 #  undef getcwd
 575 # endif
 576 #endif
 577
 578 #ifndef initialize_main
 579 # define initialize_main(pargc, pargv)
 580 #endif
 581
 582
 583 /* Some systems (like Solaris, PTX, etc.) do not support the SA_RESTART flag
 584    properly according to POSIX.  So, we try to wrap common system calls with
 585    checks for EINTR.  Note that there are still plenty of system calls that
 586    can fail with EINTR but this, reportedly, gets the vast majority of
 587    failure cases.  If you still experience failures you'll need to either get
 588    a system where SA_RESTART works, or you need to avoid -j.  */
 589
 590 #define EINTRLOOP(_v,_c)   while (((_v)=_c)==-1 && errno==EINTR)
 591
 592 /* While system calls that return integers are pretty consistent about
 593    returning -1 on failure and setting errno in that case, functions that
 594    return pointers are not always so well behaved.  Sometimes they return
 595    NULL for expected behavior: one good example is readdir() which returns
 596    NULL at the end of the directory--and _doesn't_ reset errno.  So, we have
 597    to do it ourselves here.  */
 598
 599 #define ENULLLOOP(_v,_c)   do{ errno = 0; \
 600                                while (((_v)=_c)==0 && errno==EINTR); }while(0)
 601