make.h

   1 /* Miscellaneous global declarations and portability cruft for GNU Make.
   2 Copyright (C) 1988,89,90,91,92,93,94,95,96,97,99 Free Software Foundation, Inc.
   3 This file is part of GNU Make.
   4
   5 GNU Make is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU General Public License as published by
   7 the Free Software Foundation; either version 2, or (at your option)
   8 any later version.
   9
  10 GNU Make is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU General Public License for more details.
  14
  15 You should have received a copy of the GNU General Public License
  16 along with GNU Make; see the file COPYING.  If not, write to
  17 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18 Boston, MA 02111-1307, USA.  */
  19
  20 /* AIX requires this to be the first thing in the file.  */
  21 #if defined (_AIX) && !defined (__GNUC__)
  22  #pragma alloca
  23 #endif
  24
  25 /* We use <config.h> instead of "config.h" so that a compilation
  26    using -I. -I$srcdir will use ./config.h rather than $srcdir/config.h
  27    (which it would do because make.h was found in $srcdir).  */
  28 #include <config.h>
  29 #undef  HAVE_CONFIG_H
  30 #define HAVE_CONFIG_H 1
  31
  32
  33 /* Use prototypes if available.  */
  34 #if defined (__cplusplus) || (defined (__STDC__) && __STDC__)
  35 # undef  PARAMS
  36 # define PARAMS(protos)  protos
  37 #else /* Not C++ or ANSI C.  */
  38 # undef  PARAMS
  39 # define PARAMS(protos)  ()
  40 #endif /* C++ or ANSI C.  */
  41
  42
  43 /* For now, set gettext macro to a no-op.  */
  44 #undef _
  45 #undef N_
  46 #define _(s)    s
  47 #define N_(s)   s
  48
  49
  50 #ifdef  CRAY
  51 /* This must happen before #include <signal.h> so
  52    that the declaration therein is changed.  */
  53 # define signal bsdsignal
  54 #endif
  55
  56 /* If we're compiling for the dmalloc debugger, turn off string inlining.  */
  57 #if defined(HAVE_DMALLOC_H) && defined(__GNUC__)
  58 # define __NO_STRING_INLINES
  59 #endif
  60
  61 #define _GNU_SOURCE 1
  62 #include <sys/types.h>
  63 #include <sys/stat.h>
  64 #include <signal.h>
  65 #include <stdio.h>
  66 #include <ctype.h>
  67 #ifdef HAVE_SYS_TIMEB_H
  68 /* SCO 3.2 "devsys 4.2" has a prototype for `ftime' in <time.h> that bombs
  69    unless <sys/timeb.h> has been included first.  Does every system have a
  70    <sys/timeb.h>?  If any does not, configure should check for it.  */
  71 # include <sys/timeb.h>
  72 #endif
  73 #include <time.h>
  74 #include <errno.h>
  75
  76 #ifndef errno
  77 extern int errno;
  78 #endif
  79
  80 /* A shortcut for EINTR checking.  Note you should be careful when negating
  81    this!  That might not mean what you want if EINTR is not available.  */
  82 #ifdef EINTR
  83 # define EINTR_SET (errno == EINTR)
  84 #else
  85 # define EINTR_SET (0)
  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 #if defined (HAVE_SYS_SIGLIST) && !defined (SYS_SIGLIST_DECLARED)
 111 extern char *sys_siglist[];
 112 #endif
 113
 114 #if !defined (HAVE_SYS_SIGLIST) || !defined (HAVE_STRSIGNAL)
 115 # include "signame.h"
 116 #endif
 117
 118 /* Some systems do not define NSIG in <signal.h>.  */
 119 #ifndef NSIG
 120 # ifdef _NSIG
 121 #  define NSIG  _NSIG
 122 # else
 123 #  define NSIG  32
 124 # endif
 125 #endif
 126
 127 #ifndef RETSIGTYPE
 128 # define RETSIGTYPE     void
 129 #endif
 130
 131 #ifndef sigmask
 132 # define sigmask(sig)   (1 << ((sig) - 1))
 133 #endif
 134
 135 #ifdef  HAVE_LIMITS_H
 136 # include <limits.h>
 137 #endif
 138 #ifdef  HAVE_SYS_PARAM_H
 139 # include <sys/param.h>
 140 #endif
 141
 142 #ifndef PATH_MAX
 143 # ifndef POSIX
 144 #  define PATH_MAX      MAXPATHLEN
 145 # endif
 146 #endif
 147 #ifndef MAXPATHLEN
 148 # define MAXPATHLEN 1024
 149 #endif
 150
 151 #ifdef  PATH_MAX
 152 # define GET_PATH_MAX   PATH_MAX
 153 # define PATH_VAR(var)  char var[PATH_MAX]
 154 #else
 155 # define NEED_GET_PATH_MAX 1
 156 # define GET_PATH_MAX   (get_path_max ())
 157 # define PATH_VAR(var)  char *var = (char *) alloca (GET_PATH_MAX)
 158 extern unsigned int get_path_max PARAMS ((void));
 159 #endif
 160
 161 #ifndef CHAR_BIT
 162 # define CHAR_BIT 8
 163 #endif
 164
 165 /* Nonzero if the integer type T is signed.  */
 166 #define INTEGER_TYPE_SIGNED(t) ((t) -1 < 0)
 167
 168 /* The minimum and maximum values for the integer type T.
 169    Use ~ (t) 0, not -1, for portability to 1's complement hosts.  */
 170 #define INTEGER_TYPE_MINIMUM(t) \
 171   (! INTEGER_TYPE_SIGNED (t) ? (t) 0 : ~ (t) 0 << (sizeof (t) * CHAR_BIT - 1))
 172 #define INTEGER_TYPE_MAXIMUM(t) (~ (t) 0 - INTEGER_TYPE_MINIMUM (t))
 173
 174 #ifndef CHAR_MAX
 175 # define CHAR_MAX INTEGER_TYPE_MAXIMUM (char)
 176 #endif
 177
 178 #ifdef STAT_MACROS_BROKEN
 179 # ifdef S_ISREG
 180 #  undef S_ISREG
 181 # endif
 182 # ifdef S_ISDIR
 183 #  undef S_ISDIR
 184 # endif
 185 #endif  /* STAT_MACROS_BROKEN.  */
 186
 187 #ifndef S_ISREG
 188 # define S_ISREG(mode)  (((mode) & S_IFMT) == S_IFREG)
 189 #endif
 190 #ifndef S_ISDIR
 191 # define S_ISDIR(mode)  (((mode) & S_IFMT) == S_IFDIR)
 192 #endif
 193
 194 #ifdef VMS
 195 # include <stdio.h>
 196 # include <types.h>
 197 # include <unixlib.h>
 198 # include <unixio.h>
 199 # include <errno.h>
 200 # include <perror.h>
 201 #endif
 202
 203 #ifndef __attribute__
 204 /* This feature is available in gcc versions 2.5 and later.  */
 205 # if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 5) || __STRICT_ANSI__
 206 #  define __attribute__(x)
 207 # endif
 208 /* The __-protected variants of `format' and `printf' attributes
 209    are accepted by gcc versions 2.6.4 (effectively 2.7) and later.  */
 210 # if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 7)
 211 #  define __format__ format
 212 #  define __printf__ printf
 213 # endif
 214 #endif
 215
 216 #if defined (STDC_HEADERS) || defined (__GNU_LIBRARY__)
 217 # include <stdlib.h>
 218 # include <string.h>
 219 # define ANSI_STRING 1
 220 #else   /* No standard headers.  */
 221 # ifdef HAVE_STRING_H
 222 #  include <string.h>
 223 #  define ANSI_STRING 1
 224 # else
 225 #  include <strings.h>
 226 # endif
 227 # ifdef HAVE_MEMORY_H
 228 #  include <memory.h>
 229 # endif
 230 # ifdef HAVE_STDLIB_H
 231 #  include <stdlib.h>
 232 # else
 233 extern char *malloc PARAMS ((int));
 234 extern char *realloc PARAMS ((char *, int));
 235 extern void free PARAMS ((char *));
 236
 237 extern void abort PARAMS ((void)) __attribute__ ((noreturn));
 238 extern void exit PARAMS ((int)) __attribute__ ((noreturn));
 239 # endif /* HAVE_STDLIB_H.  */
 240
 241 #endif /* Standard headers.  */
 242
 243 #if ST_MTIM_NSEC
 244 # if HAVE_INTTYPES_H
 245 #  include <inttypes.h>
 246 # endif
 247 # define FILE_TIMESTAMP uintmax_t
 248 #else
 249 # define FILE_TIMESTAMP time_t
 250 #endif
 251
 252 #ifdef  ANSI_STRING
 253
 254 # ifndef index
 255 #  define index(s, c)       strchr((s), (c))
 256 # endif
 257 # ifndef rindex
 258 #  define rindex(s, c)      strrchr((s), (c))
 259 # endif
 260
 261 # ifndef bcmp
 262 #  define bcmp(s1, s2, n)   memcmp ((s1), (s2), (n))
 263 # endif
 264 # ifndef bzero
 265 #  define bzero(s, n)       memset ((s), 0, (n))
 266 # endif
 267 # if defined(HAVE_MEMMOVE) && !defined(bcopy)
 268 #  define bcopy(s, d, n)    memmove ((d), (s), (n))
 269 # endif
 270
 271 #else   /* Not ANSI_STRING.  */
 272
 273 # ifndef bcmp
 274 extern int bcmp PARAMS ((const char *, const char *, int));
 275 # endif
 276 # ifndef bzero
 277 extern void bzero PARAMS ((char *, int));
 278 #endif
 279 # ifndef bcopy
 280 extern void bcopy PARAMS ((const char *b1, char *b2, int));
 281 # endif
 282
 283 #endif  /* ANSI_STRING.  */
 284 #undef  ANSI_STRING
 285
 286 /* SCO Xenix has a buggy macro definition in <string.h>.  */
 287 #undef  strerror
 288
 289 #if !defined(ANSI_STRING) && !defined(__DECC)
 290 extern char *strerror PARAMS ((int errnum));
 291 #endif
 292
 293 #ifdef __GNUC__
 294 # undef alloca
 295 # define alloca(n)      __builtin_alloca (n)
 296 #else   /* Not GCC.  */
 297 # ifdef HAVE_ALLOCA_H
 298 #  include <alloca.h>
 299 # else /* Not HAVE_ALLOCA_H.  */
 300 #  ifndef _AIX
 301 extern char *alloca ();
 302 #  endif /* Not AIX.  */
 303 # endif /* HAVE_ALLOCA_H.  */
 304 #endif /* GCC.  */
 305
 306 /* ISDIGIT offers the following features:
 307    - Its arg may be any int or unsigned int; it need not be an unsigned char.
 308    - It's guaranteed to evaluate its argument exactly once.
 309       NOTE!  Make relies on this behavior, don't change it!
 310    - It's typically faster.
 311    Posix 1003.2-1992 section 2.5.2.1 page 50 lines 1556-1558 says that
 312    only '0' through '9' are digits.  Prefer ISDIGIT to isdigit() unless
 313    it's important to use the locale's definition of `digit' even when the
 314    host does not conform to Posix.  */
 315 #define ISDIGIT(c) ((unsigned) (c) - '0' <= 9)
 316
 317 #ifndef iAPX286
 318 # define streq(a, b) \
 319    ((a) == (b) || \
 320     (*(a) == *(b) && (*(a) == '\0' || !strcmp ((a) + 1, (b) + 1))))
 321 # ifdef HAVE_CASE_INSENSITIVE_FS
 322 /* This is only used on Windows/DOS platforms, so we assume strcmpi().  */
 323 #  define strieq(a, b) \
 324     ((a) == (b) || \
 325      (tolower(*(a)) == tolower(*(b)) && (*(a) == '\0' || !strcmpi ((a) + 1, (b) + 1))))
 326 # else
 327 #  define strieq(a, b) streq(a, b)
 328 # endif
 329 #else
 330 /* Buggy compiler can't handle this.  */
 331 # define streq(a, b) (strcmp ((a), (b)) == 0)
 332 # define strieq(a, b) (strcmp ((a), (b)) == 0)
 333 #endif
 334 #define strneq(a, b, l) (strncmp ((a), (b), (l)) == 0)
 335
 336 /* Add to VAR the hashing value of C, one character in a name.  */
 337 #define HASH(var, c) \
 338   ((var += (c)), (var = ((var) << 7) + ((var) >> 20)))
 339 #ifdef HAVE_CASE_INSENSITIVE_FS /* Fold filenames */
 340 # define HASHI(var, c) \
 341    ((var += tolower((c))), (var = ((var) << 7) + ((var) >> 20)))
 342 #else
 343 # define HASHI(var, c) HASH(var,c)
 344 #endif
 345
 346 #if defined(__GNUC__) || defined(ENUM_BITFIELDS)
 347 # define ENUM_BITFIELD(bits)    :bits
 348 #else
 349 # define ENUM_BITFIELD(bits)
 350 #endif
 351
 352 #if defined(__MSDOS__) || defined(WINDOWS32)
 353 # define PATH_SEPARATOR_CHAR ';'
 354 #else
 355 # if defined(VMS)
 356 #  define PATH_SEPARATOR_CHAR ','
 357 # else
 358 #  define PATH_SEPARATOR_CHAR ':'
 359 # endif
 360 #endif
 361
 362 #ifdef WINDOWS32
 363 # include <fcntl.h>
 364 # include <malloc.h>
 365 # define pipe(p) _pipe(p, 512, O_BINARY)
 366 # define kill(pid,sig) w32_kill(pid,sig)
 367
 368 extern void sync_Path_environment(void);
 369 extern int kill(int pid, int sig);
 370 extern int safe_stat(char *file, struct stat *sb);
 371 extern char *end_of_token_w32(char *s, char stopchar);
 372 extern int find_and_set_default_shell(char *token);
 373
 374 /* indicates whether or not we have Bourne shell */
 375 extern int no_default_sh_exe;
 376
 377 /* is default_shell unixy? */
 378 extern int unixy_shell;
 379 #endif  /* WINDOWS32 */
 380
 381 struct floc
 382   {
 383     char *filenm;
 384     unsigned long lineno;
 385   };
 386 #define NILF ((struct floc *)0)
 387
 388 \f
 389 /* Fancy processing for variadic functions in both ANSI and pre-ANSI
 390    compilers.  */
 391 #if defined __STDC__ && __STDC__
 392 extern void message (int prefix, const char *fmt, ...)
 393                      __attribute__ ((__format__ (__printf__, 2, 3)));
 394 extern void error (const struct floc *flocp, const char *fmt, ...)
 395                    __attribute__ ((__format__ (__printf__, 2, 3)));
 396 extern void fatal (const struct floc *flocp, const char *fmt, ...)
 397                    __attribute__ ((noreturn, __format__ (__printf__, 2, 3)));
 398 #else
 399 extern void message ();
 400 extern void error ();
 401 extern void fatal ();
 402 #endif
 403
 404 extern void die PARAMS ((int)) __attribute__ ((noreturn));
 405 extern void log_working_directory PARAMS ((int));
 406 extern void pfatal_with_name PARAMS ((char *)) __attribute__ ((noreturn));
 407 extern void perror_with_name PARAMS ((char *, char *));
 408 extern char *savestring PARAMS ((const char *, unsigned int));
 409 extern char *concat PARAMS ((char *, char *, char *));
 410 extern char *xmalloc PARAMS ((unsigned int));
 411 extern char *xrealloc PARAMS ((char *, unsigned int));
 412 extern char *xstrdup PARAMS ((const char *));
 413 extern char *find_next_token PARAMS ((char **, unsigned int *));
 414 extern char *next_token PARAMS ((char *));
 415 extern char *end_of_token PARAMS ((char *));
 416 extern void collapse_continuations PARAMS ((char *));
 417 extern void remove_comments PARAMS((char *));
 418 extern char *sindex PARAMS ((const char *, unsigned int, \
 419                              const char *, unsigned int));
 420 extern char *lindex PARAMS ((const char *, const char *, int));
 421 extern int alpha_compare PARAMS ((const void *, const void *));
 422 extern void print_spaces PARAMS ((unsigned int));
 423 extern char *find_char_unquote PARAMS ((char *, char *, int));
 424 extern char *find_percent PARAMS ((char *));
 425
 426 #ifndef NO_ARCHIVES
 427 extern int ar_name PARAMS ((char *));
 428 extern void ar_parse_name PARAMS ((char *, char **, char **));
 429 extern int ar_touch PARAMS ((char *));
 430 extern time_t ar_member_date PARAMS ((char *));
 431 #endif
 432
 433 extern int dir_file_exists_p PARAMS ((char *, char *));
 434 extern int file_exists_p PARAMS ((char *));
 435 extern int file_impossible_p PARAMS ((char *));
 436 extern void file_impossible PARAMS ((char *));
 437 extern char *dir_name PARAMS ((char *));
 438
 439 extern void define_default_variables PARAMS ((void));
 440 extern void set_default_suffixes PARAMS ((void));
 441 extern void install_default_suffix_rules PARAMS ((void));
 442 extern void install_default_implicit_rules PARAMS ((void));
 443
 444 extern void build_vpath_lists PARAMS ((void));
 445 extern void construct_vpath_list PARAMS ((char *pattern, char *dirpath));
 446 extern int vpath_search PARAMS ((char **file, FILE_TIMESTAMP *mtime_ptr));
 447 extern int gpath_search PARAMS ((char *file, int len));
 448
 449 extern void construct_include_path PARAMS ((char **arg_dirs));
 450
 451 extern void user_access PARAMS ((void));
 452 extern void make_access PARAMS ((void));
 453 extern void child_access PARAMS ((void));
 454
 455 #ifdef  HAVE_VFORK_H
 456 # include <vfork.h>
 457 #endif
 458
 459 /* We omit these declarations on non-POSIX systems which define _POSIX_VERSION,
 460    because such systems often declare them in header files anyway.  */
 461
 462 #if !defined (__GNU_LIBRARY__) && !defined (POSIX) && !defined (_POSIX_VERSION) && !defined(WINDOWS32)
 463
 464 extern long int atol ();
 465 # ifndef VMS
 466 extern long int lseek ();
 467 # endif
 468
 469 #endif  /* Not GNU C library or POSIX.  */
 470
 471 #ifdef  HAVE_GETCWD
 472 extern char *getcwd ();
 473 # ifdef VMS
 474 extern char *getwd PARAMS ((char *));
 475 # endif
 476 #else
 477 extern char *getwd ();
 478 # define getcwd(buf, len)       getwd (buf)
 479 #endif
 480
 481 extern const struct floc *reading_file;
 482
 483 extern char **environ;
 484
 485 extern int just_print_flag, silent_flag, ignore_errors_flag, keep_going_flag;
 486 extern int debug_flag, print_data_base_flag, question_flag, touch_flag;
 487 extern int env_overrides, no_builtin_rules_flag, no_builtin_variables_flag;
 488 extern int print_version_flag, print_directory_flag;
 489 extern int warn_undefined_variables_flag, posix_pedantic;
 490 extern int clock_skew_detected;
 491
 492 /* can we run commands via 'sh -c xxx' or must we use batch files? */
 493 extern int batch_mode_shell;
 494
 495 extern unsigned int job_slots;
 496 extern int job_fds[2];
 497 extern int job_rfd;
 498 #ifndef NO_FLOAT
 499 extern double max_load_average;
 500 #else
 501 extern int max_load_average;
 502 #endif
 503
 504 extern char *program;
 505 extern char *starting_directory;
 506 extern unsigned int makelevel;
 507 extern char *version_string, *remote_description;
 508
 509 extern unsigned int commands_started;
 510
 511 extern int handling_fatal_signal;
 512
 513
 514 #ifndef MIN
 515 #define MIN(_a,_b) ((_a)<(_b)?(_a):(_b))
 516 #endif
 517 #ifndef MAX
 518 #define MAX(_a,_b) ((_a)>(_b)?(_a):(_b))
 519 #endif
 520
 521 #define DEBUGPR(msg) \
 522   do if (debug_flag) { print_spaces (depth); printf (msg, file->name); \
 523                        fflush (stdout); } while (0)
 524
 525 #ifdef VMS
 526 # ifndef EXIT_FAILURE
 527 #  define EXIT_FAILURE 3
 528 # endif
 529 # ifndef EXIT_SUCCESS
 530 #  define EXIT_SUCCESS 1
 531 # endif
 532 # ifndef EXIT_TROUBLE
 533 #  define EXIT_TROUBLE 2
 534 # endif
 535 #else
 536 # ifndef EXIT_FAILURE
 537 #  define EXIT_FAILURE 2
 538 # endif
 539 # ifndef EXIT_SUCCESS
 540 #  define EXIT_SUCCESS 0
 541 # endif
 542 # ifndef EXIT_TROUBLE
 543 #  define EXIT_TROUBLE 1
 544 # endif
 545 #endif
 546
 547 /* Set up heap debugging library dmalloc.  */
 548
 549 #ifdef HAVE_DMALLOC_H
 550 #include <dmalloc.h>
 551 #endif