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