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 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 2, or (at your option) any later version.
  10
  11 GNU Make is distributed in the hope that it will be useful, but WITHOUT ANY
  12 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  13 A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  14
  15 You should have received a copy of the GNU General Public License along with
  16 GNU Make; see the file COPYING.  If not, write to the Free Software
  17 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.  */
  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 /* This is only used on Windows/DOS platforms, so we assume strcmpi().  */
 276 #  define strieq(a, b) \
 277     ((a) == (b) \
 278      || (tolower((unsigned char)*(a)) == tolower((unsigned char)*(b)) \
 279          && (*(a) == '\0' || !strcmpi ((a) + 1, (b) + 1))))
 280 # else
 281 #  define strieq(a, b) streq(a, b)
 282 # endif
 283 #else
 284 /* Buggy compiler can't handle this.  */
 285 # define streq(a, b) (strcmp ((a), (b)) == 0)
 286 # define strieq(a, b) (strcmp ((a), (b)) == 0)
 287 #endif
 288 #define strneq(a, b, l) (strncmp ((a), (b), (l)) == 0)
 289 #ifdef  VMS
 290 int strcmpi (const char *,const char *);
 291 #endif
 292
 293 #if defined(__GNUC__) || defined(ENUM_BITFIELDS)
 294 # define ENUM_BITFIELD(bits)    :bits
 295 #else
 296 # define ENUM_BITFIELD(bits)
 297 #endif
 298
 299 /* Handle gettext and locales.  */
 300
 301 #if HAVE_LOCALE_H
 302 # include <locale.h>
 303 #else
 304 # define setlocale(category, locale)
 305 #endif
 306
 307 #include <gettext.h>
 308
 309 #define _(msgid)            gettext (msgid)
 310 #define N_(msgid)           gettext_noop (msgid)
 311 #define S_(msg1,msg2,num)   ngettext (msg1,msg2,num)
 312
 313 /* Handle other OSs.  */
 314 #ifndef PATH_SEPARATOR_CHAR
 315 # if defined(HAVE_DOS_PATHS)
 316 #  define PATH_SEPARATOR_CHAR ';'
 317 # elif defined(VMS)
 318 #  define PATH_SEPARATOR_CHAR ','
 319 # else
 320 #  define PATH_SEPARATOR_CHAR ':'
 321 # endif
 322 #endif
 323
 324 /* This is needed for getcwd() and chdir(), on some W32 systems.  */
 325 #if defined(HAVE_DIRECT_H)
 326 # include <direct.h>
 327 #endif
 328
 329 #ifdef WINDOWS32
 330 # include <fcntl.h>
 331 # include <malloc.h>
 332 # define pipe(_p)        _pipe((_p), 512, O_BINARY)
 333 # define kill(_pid,_sig) w32_kill((_pid),(_sig))
 334
 335 void sync_Path_environment (void);
 336 int kill (int pid, int sig);
 337 char *end_of_token_w32 (const char *s, char stopchar);
 338 int find_and_set_default_shell (const char *token);
 339
 340 /* indicates whether or not we have Bourne shell */
 341 extern int no_default_sh_exe;
 342
 343 /* is default_shell unixy? */
 344 extern int unixy_shell;
 345 #endif  /* WINDOWS32 */
 346
 347 struct floc
 348   {
 349     const char *filenm;
 350     unsigned long lineno;
 351   };
 352 #define NILF ((struct floc *)0)
 353
 354 #define STRING_SIZE_TUPLE(_s) (_s), (sizeof (_s)-1)
 355
 356 \f
 357 /* We have to have stdarg.h or varargs.h AND v*printf or doprnt to use
 358    variadic versions of these functions.  */
 359
 360 #if HAVE_STDARG_H || HAVE_VARARGS_H
 361 # if HAVE_VPRINTF || HAVE_DOPRNT
 362 #  define USE_VARIADIC 1
 363 # endif
 364 #endif
 365
 366 #if HAVE_ANSI_COMPILER && USE_VARIADIC && HAVE_STDARG_H
 367 void message (int prefix, const char *fmt, ...)
 368               __attribute__ ((__format__ (__printf__, 2, 3)));
 369 void error (const struct floc *flocp, const char *fmt, ...)
 370             __attribute__ ((__format__ (__printf__, 2, 3)));
 371 void fatal (const struct floc *flocp, const char *fmt, ...)
 372                    __attribute__ ((noreturn, __format__ (__printf__, 2, 3)));
 373 #else
 374 void message ();
 375 void error ();
 376 void fatal ();
 377 #endif
 378
 379 void die (int) __attribute__ ((noreturn));
 380 void log_working_directory (int);
 381 void pfatal_with_name (const char *) __attribute__ ((noreturn));
 382 void perror_with_name (const char *, const char *);
 383 char *savestring (const char *, unsigned int);
 384 char *concat (const char *, const char *, const char *);
 385 void *xmalloc (unsigned int);
 386 void *xrealloc (void *, unsigned int);
 387 char *xstrdup (const char *);
 388 char *find_next_token (const char **, unsigned int *);
 389 char *next_token (const char *);
 390 char *end_of_token (const char *);
 391 void collapse_continuations (char *);
 392 char *lindex (const char *, const char *, int);
 393 int alpha_compare (const void *, const void *);
 394 void print_spaces (unsigned int);
 395 char *find_percent (char *);
 396 const char *find_percent_cached (const char **);
 397 FILE *open_tmpfile (char **, const char *);
 398
 399 #ifndef NO_ARCHIVES
 400 int ar_name (const char *);
 401 void ar_parse_name (const char *, char **, char **);
 402 int ar_touch (const char *);
 403 time_t ar_member_date (const char *);
 404
 405 typedef long int (*ar_member_func_t) (int desc, const char *mem, int truncated,
 406                                       long int hdrpos, long int datapos,
 407                                       long int size, long int date, int uid,
 408                                       int gid, int mode, const void *arg);
 409
 410 long int ar_scan (const char *archive, ar_member_func_t function, const void *arg);
 411 int ar_name_equal (const char *name, const char *mem, int truncated);
 412 #ifndef VMS
 413 int ar_member_touch (const char *arname, const char *memname);
 414 #endif
 415 #endif
 416
 417 int dir_file_exists_p (const char *, const char *);
 418 int file_exists_p (const char *);
 419 int file_impossible_p (const char *);
 420 void file_impossible (const char *);
 421 const char *dir_name (const char *);
 422 void hash_init_directories (void);
 423
 424 void define_default_variables (void);
 425 void set_default_suffixes (void);
 426 void install_default_suffix_rules (void);
 427 void install_default_implicit_rules (void);
 428
 429 void build_vpath_lists (void);
 430 void construct_vpath_list (char *pattern, char *dirpath);
 431 const char *vpath_search (const char *file, FILE_TIMESTAMP *mtime_ptr);
 432 int gpath_search (const char *file, unsigned int len);
 433
 434 void construct_include_path (const char **arg_dirs);
 435
 436 void user_access (void);
 437 void make_access (void);
 438 void child_access (void);
 439
 440 void close_stdout (void);
 441
 442 char *strip_whitespace (const char **begpp, const char **endpp);
 443
 444 /* String caching  */
 445 void strcache_init (void);
 446 void strcache_print_stats (const char *prefix);
 447 int strcache_iscached (const char *str);
 448 const char *strcache_add (const char *str);
 449 const char *strcache_add_len (const char *str, int len);
 450 int strcache_setbufsize (int size);
 451
 452 #ifdef  HAVE_VFORK_H
 453 # include <vfork.h>
 454 #endif
 455
 456 /* We omit these declarations on non-POSIX systems which define _POSIX_VERSION,
 457    because such systems often declare them in header files anyway.  */
 458
 459 #if !defined (__GNU_LIBRARY__) && !defined (POSIX) && !defined (_POSIX_VERSION) && !defined(WINDOWS32)
 460
 461 long int atol ();
 462 # ifndef VMS
 463 long int lseek ();
 464 # endif
 465
 466 #endif  /* Not GNU C library or POSIX.  */
 467
 468 #ifdef  HAVE_GETCWD
 469 # if !defined(VMS) && !defined(__DECC)
 470 char *getcwd ();
 471 # endif
 472 #else
 473 char *getwd ();
 474 # define getcwd(buf, len)       getwd (buf)
 475 #endif
 476
 477 extern const struct floc *reading_file;
 478 extern const struct floc **expanding_var;
 479
 480 extern char **environ;
 481
 482 extern int just_print_flag, silent_flag, ignore_errors_flag, keep_going_flag;
 483 extern int print_data_base_flag, question_flag, touch_flag, always_make_flag;
 484 extern int env_overrides, no_builtin_rules_flag, no_builtin_variables_flag;
 485 extern int print_version_flag, print_directory_flag, check_symlink_flag;
 486 extern int warn_undefined_variables_flag, posix_pedantic, not_parallel;
 487 extern int second_expansion, clock_skew_detected, rebuilding_makefiles;
 488
 489 /* can we run commands via 'sh -c xxx' or must we use batch files? */
 490 extern int batch_mode_shell;
 491
 492 extern char cmd_prefix;
 493
 494 extern unsigned int job_slots;
 495 extern int job_fds[2];
 496 extern int job_rfd;
 497 #ifndef NO_FLOAT
 498 extern double max_load_average;
 499 #else
 500 extern int max_load_average;
 501 #endif
 502
 503 extern char *program;
 504 extern char *starting_directory;
 505 extern unsigned int makelevel;
 506 extern char *version_string, *remote_description, *make_host;
 507
 508 extern unsigned int commands_started;
 509
 510 extern int handling_fatal_signal;
 511
 512
 513 #ifndef MIN
 514 #define MIN(_a,_b) ((_a)<(_b)?(_a):(_b))
 515 #endif
 516 #ifndef MAX
 517 #define MAX(_a,_b) ((_a)>(_b)?(_a):(_b))
 518 #endif
 519
 520 #ifdef VMS
 521 #  define MAKE_SUCCESS 1
 522 #  define MAKE_TROUBLE 2
 523 #  define MAKE_FAILURE 3
 524 #else
 525 #  define MAKE_SUCCESS 0
 526 #  define MAKE_TROUBLE 1
 527 #  define MAKE_FAILURE 2
 528 #endif
 529
 530 /* Set up heap debugging library dmalloc.  */
 531
 532 #ifdef HAVE_DMALLOC_H
 533 #include <dmalloc.h>
 534 #endif
 535
 536 #ifndef initialize_main
 537 # ifdef __EMX__
 538 #  define initialize_main(pargc, pargv) \
 539                           { _wildcard(pargc, pargv); _response(pargc, pargv); }
 540 # else
 541 #  define initialize_main(pargc, pargv)
 542 # endif
 543 #endif
 544
 545
 546 #ifdef __EMX__
 547 # if !HAVE_STRCASECMP
 548 #  define strcasecmp stricmp
 549 # endif
 550
 551 # if !defined chdir
 552 #  define chdir _chdir2
 553 # endif
 554 # if !defined getcwd
 555 #  define getcwd _getcwd2
 556 # endif
 557
 558 /* NO_CHDIR2 causes make not to use _chdir2() and _getcwd2() instead of
 559    chdir() and getcwd(). This avoids some error messages for the
 560    make testsuite but restricts the drive letter support. */
 561 # ifdef NO_CHDIR2
 562 #  warning NO_CHDIR2: usage of drive letters restricted
 563 #  undef chdir
 564 #  undef getcwd
 565 # endif
 566 #endif
 567
 568 #ifndef initialize_main
 569 # define initialize_main(pargc, pargv)
 570 #endif
 571
 572
 573 /* Some systems (like Solaris, PTX, etc.) do not support the SA_RESTART flag
 574    properly according to POSIX.  So, we try to wrap common system calls with
 575    checks for EINTR.  Note that there are still plenty of system calls that
 576    can fail with EINTR but this, reportedly, gets the vast majority of
 577    failure cases.  If you still experience failures you'll need to either get
 578    a system where SA_RESTART works, or you need to avoid -j.  */
 579
 580 #define EINTRLOOP(_v,_c)   while (((_v)=_c)==-1 && errno==EINTR)
 581
 582 /* While system calls that return integers are pretty consistent about
 583    returning -1 on failure and setting errno in that case, functions that
 584    return pointers are not always so well behaved.  Sometimes they return
 585    NULL for expected behavior: one good example is readdir() which returns
 586    NULL at the end of the directory--and _doesn't_ reset errno.  So, we have
 587    to do it ourselves here.  */
 588
 589 #define ENULLLOOP(_v,_c)   do { errno = 0; (_v) = _c; } \
 590                            while((_v)==0 && errno==EINTR)