In very obscure situations we may write the free token back to the pipe.
[make.git] / make.h
blobf5fece5ecbb1a32e671d88e2f319a4e3215baf3f
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,
4 2010 Free Software Foundation, Inc.
5 This file is part of GNU Make.
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.
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.
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/>. */
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
26 /* Specify we want GNU source code. This must be defined before any
27 system headers are included. */
29 #define _GNU_SOURCE 1
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
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
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
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
64 #include <sys/types.h>
65 #include <sys/stat.h>
66 #include <signal.h>
67 #include <stdio.h>
68 #include <ctype.h>
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
86 #include <errno.h>
88 #ifndef errno
89 extern int errno;
90 #endif
92 #ifndef isblank
93 # define isblank(c) ((c) == ' ' || (c) == '\t')
94 #endif
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
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
110 #if !defined (POSIX) && defined (_AIX) && defined (_POSIX_SOURCE)
111 # define POSIX 1
112 #endif
114 #ifndef RETSIGTYPE
115 # define RETSIGTYPE void
116 #endif
118 #ifndef sigmask
119 # define sigmask(sig) (1 << ((sig) - 1))
120 #endif
122 #ifndef HAVE_SA_RESTART
123 # define SA_RESTART 0
124 #endif
126 #ifdef HAVE_LIMITS_H
127 # include <limits.h>
128 #endif
129 #ifdef HAVE_SYS_PARAM_H
130 # include <sys/param.h>
131 #endif
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
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
152 #ifndef CHAR_BIT
153 # define CHAR_BIT 8
154 #endif
156 #ifndef USHRT_MAX
157 # define USHRT_MAX 65535
158 #endif
160 /* Nonzero if the integer type T is signed. */
161 #define INTEGER_TYPE_SIGNED(t) ((t) -1 < 0)
163 /* The minimum and maximum values for the integer type T.
164 Use ~ (t) 0, not -1, for portability to 1's complement hosts. */
165 #define INTEGER_TYPE_MINIMUM(t) \
166 (! INTEGER_TYPE_SIGNED (t) ? (t) 0 : ~ (t) 0 << (sizeof (t) * CHAR_BIT - 1))
167 #define INTEGER_TYPE_MAXIMUM(t) (~ (t) 0 - INTEGER_TYPE_MINIMUM (t))
169 #ifndef CHAR_MAX
170 # define CHAR_MAX INTEGER_TYPE_MAXIMUM (char)
171 #endif
173 #ifdef STAT_MACROS_BROKEN
174 # ifdef S_ISREG
175 # undef S_ISREG
176 # endif
177 # ifdef S_ISDIR
178 # undef S_ISDIR
179 # endif
180 #endif /* STAT_MACROS_BROKEN. */
182 #ifndef S_ISREG
183 # define S_ISREG(mode) (((mode) & S_IFMT) == S_IFREG)
184 #endif
185 #ifndef S_ISDIR
186 # define S_ISDIR(mode) (((mode) & S_IFMT) == S_IFDIR)
187 #endif
189 #ifdef VMS
190 # include <types.h>
191 # include <unixlib.h>
192 # include <unixio.h>
193 # include <perror.h>
194 /* Needed to use alloca on VMS. */
195 # include <builtins.h>
196 #endif
198 #ifndef __attribute__
199 /* This feature is available in gcc versions 2.5 and later. */
200 # if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 5) || __STRICT_ANSI__
201 # define __attribute__(x)
202 # endif
203 /* The __-protected variants of `format' and `printf' attributes
204 are accepted by gcc versions 2.6.4 (effectively 2.7) and later. */
205 # if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 7)
206 # define __format__ format
207 # define __printf__ printf
208 # endif
209 #endif
210 #define UNUSED __attribute__ ((unused))
212 #if defined (STDC_HEADERS) || defined (__GNU_LIBRARY__)
213 # include <stdlib.h>
214 # include <string.h>
215 # define ANSI_STRING 1
216 #else /* No standard headers. */
217 # ifdef HAVE_STRING_H
218 # include <string.h>
219 # define ANSI_STRING 1
220 # else
221 # include <strings.h>
222 # endif
223 # ifdef HAVE_MEMORY_H
224 # include <memory.h>
225 # endif
226 # ifdef HAVE_STDLIB_H
227 # include <stdlib.h>
228 # else
229 void *malloc (int);
230 void *realloc (void *, int);
231 void free (void *);
233 void abort (void) __attribute__ ((noreturn));
234 void exit (int) __attribute__ ((noreturn));
235 # endif /* HAVE_STDLIB_H. */
237 #endif /* Standard headers. */
239 /* These should be in stdlib.h. Make sure we have them. */
240 #ifndef EXIT_SUCCESS
241 # define EXIT_SUCCESS 0
242 #endif
243 #ifndef EXIT_FAILURE
244 # define EXIT_FAILURE 1
245 #endif
247 #ifndef ANSI_STRING
249 /* SCO Xenix has a buggy macro definition in <string.h>. */
250 #undef strerror
251 #if !defined(__DECC)
252 char *strerror (int errnum);
253 #endif
255 #endif /* !ANSI_STRING. */
256 #undef ANSI_STRING
258 #if HAVE_INTTYPES_H
259 # include <inttypes.h>
260 #endif
261 #define FILE_TIMESTAMP uintmax_t
263 #if !defined(HAVE_STRSIGNAL)
264 char *strsignal (int signum);
265 #endif
267 /* ISDIGIT offers the following features:
268 - Its arg may be any int or unsigned int; it need not be an unsigned char.
269 - It's guaranteed to evaluate its argument exactly once.
270 NOTE! Make relies on this behavior, don't change it!
271 - It's typically faster.
272 POSIX 1003.2-1992 section 2.5.2.1 page 50 lines 1556-1558 says that
273 only '0' through '9' are digits. Prefer ISDIGIT to isdigit() unless
274 it's important to use the locale's definition of `digit' even when the
275 host does not conform to POSIX. */
276 #define ISDIGIT(c) ((unsigned) (c) - '0' <= 9)
278 /* Test if two strings are equal. Is this worthwhile? Should be profiled. */
279 #define streq(a, b) \
280 ((a) == (b) || \
281 (*(a) == *(b) && (*(a) == '\0' || !strcmp ((a) + 1, (b) + 1))))
283 /* Test if two strings are equal, but match case-insensitively on systems
284 which have case-insensitive filesystems. Should only be used for
285 filenames! */
286 #ifdef HAVE_CASE_INSENSITIVE_FS
287 # define patheq(a, b) \
288 ((a) == (b) \
289 || (tolower((unsigned char)*(a)) == tolower((unsigned char)*(b)) \
290 && (*(a) == '\0' || !strcasecmp ((a) + 1, (b) + 1))))
291 #else
292 # define patheq(a, b) streq(a, b)
293 #endif
295 #define strneq(a, b, l) (strncmp ((a), (b), (l)) == 0)
297 #if defined(__GNUC__) || defined(ENUM_BITFIELDS)
298 # define ENUM_BITFIELD(bits) :bits
299 #else
300 # define ENUM_BITFIELD(bits)
301 #endif
303 /* Handle gettext and locales. */
305 #if HAVE_LOCALE_H
306 # include <locale.h>
307 #else
308 # define setlocale(category, locale)
309 #endif
311 #include <gettext.h>
313 #define _(msgid) gettext (msgid)
314 #define N_(msgid) gettext_noop (msgid)
315 #define S_(msg1,msg2,num) ngettext (msg1,msg2,num)
317 /* Handle other OSs. */
318 #ifndef PATH_SEPARATOR_CHAR
319 # if defined(HAVE_DOS_PATHS)
320 # define PATH_SEPARATOR_CHAR ';'
321 # elif defined(VMS)
322 # define PATH_SEPARATOR_CHAR ','
323 # else
324 # define PATH_SEPARATOR_CHAR ':'
325 # endif
326 #endif
328 /* This is needed for getcwd() and chdir(), on some W32 systems. */
329 #if defined(HAVE_DIRECT_H)
330 # include <direct.h>
331 #endif
333 #ifdef WINDOWS32
334 # include <fcntl.h>
335 # include <malloc.h>
336 # define pipe(_p) _pipe((_p), 512, O_BINARY)
337 # define kill(_pid,_sig) w32_kill((_pid),(_sig))
339 void sync_Path_environment (void);
340 int w32_kill (pid_t pid, int sig);
341 char *end_of_token_w32 (const char *s, char stopchar);
342 int find_and_set_default_shell (const char *token);
344 /* indicates whether or not we have Bourne shell */
345 extern int no_default_sh_exe;
347 /* is default_shell unixy? */
348 extern int unixy_shell;
349 #endif /* WINDOWS32 */
351 #if defined(HAVE_SYS_RESOURCE_H) && defined(HAVE_GETRLIMIT) && defined(HAVE_SETRLIMIT)
352 # define SET_STACK_SIZE
353 #endif
354 #ifdef SET_STACK_SIZE
355 # include <sys/resource.h>
356 extern struct rlimit stack_limit;
357 #endif
359 struct floc
361 const char *filenm;
362 unsigned long lineno;
364 #define NILF ((struct floc *)0)
366 #define STRING_SIZE_TUPLE(_s) (_s), (sizeof (_s)-1)
369 /* We have to have stdarg.h or varargs.h AND v*printf or doprnt to use
370 variadic versions of these functions. */
372 #if HAVE_STDARG_H || HAVE_VARARGS_H
373 # if HAVE_VPRINTF || HAVE_DOPRNT
374 # define USE_VARIADIC 1
375 # endif
376 #endif
378 #if HAVE_ANSI_COMPILER && USE_VARIADIC && HAVE_STDARG_H
379 const char *concat (unsigned int, ...);
380 void message (int prefix, const char *fmt, ...)
381 __attribute__ ((__format__ (__printf__, 2, 3)));
382 void error (const struct floc *flocp, const char *fmt, ...)
383 __attribute__ ((__format__ (__printf__, 2, 3)));
384 void fatal (const struct floc *flocp, const char *fmt, ...)
385 __attribute__ ((noreturn, __format__ (__printf__, 2, 3)));
386 #else
387 const char *concat ();
388 void message ();
389 void error ();
390 void fatal ();
391 #endif
393 void die (int) __attribute__ ((noreturn));
394 void log_working_directory (int);
395 void pfatal_with_name (const char *) __attribute__ ((noreturn));
396 void perror_with_name (const char *, const char *);
397 void *xmalloc (unsigned int);
398 void *xcalloc (unsigned int);
399 void *xrealloc (void *, unsigned int);
400 char *xstrdup (const char *);
401 char *xstrndup (const char *, unsigned int);
402 char *find_next_token (const char **, unsigned int *);
403 char *next_token (const char *);
404 char *end_of_token (const char *);
405 void collapse_continuations (char *);
406 char *lindex (const char *, const char *, int);
407 int alpha_compare (const void *, const void *);
408 void print_spaces (unsigned int);
409 char *find_percent (char *);
410 const char *find_percent_cached (const char **);
411 FILE *open_tmpfile (char **, const char *);
413 #ifndef NO_ARCHIVES
414 int ar_name (const char *);
415 void ar_parse_name (const char *, char **, char **);
416 int ar_touch (const char *);
417 time_t ar_member_date (const char *);
419 typedef long int (*ar_member_func_t) (int desc, const char *mem, int truncated,
420 long int hdrpos, long int datapos,
421 long int size, long int date, int uid,
422 int gid, int mode, const void *arg);
424 long int ar_scan (const char *archive, ar_member_func_t function, const void *arg);
425 int ar_name_equal (const char *name, const char *mem, int truncated);
426 #ifndef VMS
427 int ar_member_touch (const char *arname, const char *memname);
428 #endif
429 #endif
431 int dir_file_exists_p (const char *, const char *);
432 int file_exists_p (const char *);
433 int file_impossible_p (const char *);
434 void file_impossible (const char *);
435 const char *dir_name (const char *);
436 void hash_init_directories (void);
438 void define_default_variables (void);
439 void set_default_suffixes (void);
440 void install_default_suffix_rules (void);
441 void install_default_implicit_rules (void);
443 void build_vpath_lists (void);
444 void construct_vpath_list (char *pattern, char *dirpath);
445 const char *vpath_search (const char *file, FILE_TIMESTAMP *mtime_ptr,
446 unsigned int* vpath_index, unsigned int* path_index);
447 int gpath_search (const char *file, unsigned int len);
449 void construct_include_path (const char **arg_dirs);
451 void user_access (void);
452 void make_access (void);
453 void child_access (void);
455 void close_stdout (void);
457 char *strip_whitespace (const char **begpp, const char **endpp);
459 /* String caching */
460 void strcache_init (void);
461 void strcache_print_stats (const char *prefix);
462 int strcache_iscached (const char *str);
463 const char *strcache_add (const char *str);
464 const char *strcache_add_len (const char *str, unsigned int len);
465 int strcache_setbufsize (unsigned int size);
467 #ifdef HAVE_VFORK_H
468 # include <vfork.h>
469 #endif
471 /* We omit these declarations on non-POSIX systems which define _POSIX_VERSION,
472 because such systems often declare them in header files anyway. */
474 #if !defined (__GNU_LIBRARY__) && !defined (POSIX) && !defined (_POSIX_VERSION) && !defined(WINDOWS32)
476 long int atol ();
477 # ifndef VMS
478 long int lseek ();
479 # endif
481 #endif /* Not GNU C library or POSIX. */
483 #ifdef HAVE_GETCWD
484 # if !defined(VMS) && !defined(__DECC)
485 char *getcwd ();
486 # endif
487 #else
488 char *getwd ();
489 # define getcwd(buf, len) getwd (buf)
490 #endif
492 #if !HAVE_STRCASECMP
493 # if HAVE_STRICMP
494 # define strcasecmp stricmp
495 # elif HAVE_STRCMPI
496 # define strcasecmp strcmpi
497 # else
498 /* Create our own, in misc.c */
499 int strcasecmp (const char *s1, const char *s2);
500 # endif
501 #endif
503 #if !HAVE_STRNCASECMP
504 # if HAVE_STRNICMP
505 # define strncasecmp strnicmp
506 # elif HAVE_STRNCMPI
507 # define strncasecmp strncmpi
508 # else
509 /* Create our own, in misc.c */
510 int strncasecmp (const char *s1, const char *s2, int n);
511 # endif
512 #endif
514 extern const struct floc *reading_file;
515 extern const struct floc **expanding_var;
517 extern char **environ;
519 extern int just_print_flag, silent_flag, ignore_errors_flag, keep_going_flag;
520 extern int print_data_base_flag, question_flag, touch_flag, always_make_flag;
521 extern int env_overrides, no_builtin_rules_flag, no_builtin_variables_flag;
522 extern int print_version_flag, print_directory_flag, check_symlink_flag;
523 extern int warn_undefined_variables_flag, trace_flag, posix_pedantic;
524 extern int not_parallel, second_expansion, clock_skew_detected;
525 extern int rebuilding_makefiles, one_shell;
527 /* can we run commands via 'sh -c xxx' or must we use batch files? */
528 extern int batch_mode_shell;
530 /* Resetting the command script introduction prefix character. */
531 #define RECIPEPREFIX_NAME ".RECIPEPREFIX"
532 #define RECIPEPREFIX_DEFAULT '\t'
533 extern char cmd_prefix;
535 extern unsigned int job_slots;
536 extern int job_fds[2];
537 extern int job_rfd;
538 #ifndef NO_FLOAT
539 extern double max_load_average;
540 #else
541 extern int max_load_average;
542 #endif
544 extern char *program;
545 extern char *starting_directory;
546 extern unsigned int makelevel;
547 extern char *version_string, *remote_description, *make_host;
549 extern unsigned int commands_started;
551 extern int handling_fatal_signal;
554 #ifndef MIN
555 #define MIN(_a,_b) ((_a)<(_b)?(_a):(_b))
556 #endif
557 #ifndef MAX
558 #define MAX(_a,_b) ((_a)>(_b)?(_a):(_b))
559 #endif
561 #ifdef VMS
562 # define MAKE_SUCCESS 1
563 # define MAKE_TROUBLE 2
564 # define MAKE_FAILURE 3
565 #else
566 # define MAKE_SUCCESS 0
567 # define MAKE_TROUBLE 1
568 # define MAKE_FAILURE 2
569 #endif
571 /* Set up heap debugging library dmalloc. */
573 #ifdef HAVE_DMALLOC_H
574 #include <dmalloc.h>
575 #endif
577 #ifndef initialize_main
578 # ifdef __EMX__
579 # define initialize_main(pargc, pargv) \
580 { _wildcard(pargc, pargv); _response(pargc, pargv); }
581 # else
582 # define initialize_main(pargc, pargv)
583 # endif
584 #endif
586 #ifdef __EMX__
587 # if !defined chdir
588 # define chdir _chdir2
589 # endif
590 # if !defined getcwd
591 # define getcwd _getcwd2
592 # endif
594 /* NO_CHDIR2 causes make not to use _chdir2() and _getcwd2() instead of
595 chdir() and getcwd(). This avoids some error messages for the
596 make testsuite but restricts the drive letter support. */
597 # ifdef NO_CHDIR2
598 # warning NO_CHDIR2: usage of drive letters restricted
599 # undef chdir
600 # undef getcwd
601 # endif
602 #endif
604 #ifndef initialize_main
605 # define initialize_main(pargc, pargv)
606 #endif
609 /* Some systems (like Solaris, PTX, etc.) do not support the SA_RESTART flag
610 properly according to POSIX. So, we try to wrap common system calls with
611 checks for EINTR. Note that there are still plenty of system calls that
612 can fail with EINTR but this, reportedly, gets the vast majority of
613 failure cases. If you still experience failures you'll need to either get
614 a system where SA_RESTART works, or you need to avoid -j. */
616 #define EINTRLOOP(_v,_c) while (((_v)=_c)==-1 && errno==EINTR)
618 /* While system calls that return integers are pretty consistent about
619 returning -1 on failure and setting errno in that case, functions that
620 return pointers are not always so well behaved. Sometimes they return
621 NULL for expected behavior: one good example is readdir() which returns
622 NULL at the end of the directory--and _doesn't_ reset errno. So, we have
623 to do it ourselves here. */
625 #define ENULLLOOP(_v,_c) do { errno = 0; (_v) = _c; } \
626 while((_v)==0 && errno==EINTR)