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