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