Keep the command line on the heap to avoid stack overflow.
[make.git] / make.h
blob87d7bdbb7a2c37c84367d46469730aeeac2a8bda
1 /* Miscellaneous global declarations and portability cruft for GNU Make.
2 Copyright (C) 1988-2012 Free Software Foundation, Inc.
3 This file is part of GNU Make.
5 GNU Make is free software; you can redistribute it and/or modify it under the
6 terms of the GNU General Public License as published by the Free Software
7 Foundation; either version 3 of the License, or (at your option) any later
8 version.
10 GNU Make is distributed in the hope that it will be useful, but WITHOUT ANY
11 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
12 A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License along with
15 this program. If not, see <http://www.gnu.org/licenses/>. */
17 /* We use <config.h> instead of "config.h" so that a compilation
18 using -I. -I$srcdir will use ./config.h rather than $srcdir/config.h
19 (which it would do because make.h was found in $srcdir). */
20 #include <config.h>
21 #undef HAVE_CONFIG_H
22 #define HAVE_CONFIG_H 1
24 /* Specify we want GNU source code. This must be defined before any
25 system headers are included. */
27 #define _GNU_SOURCE 1
29 /* AIX requires this to be the first thing in the file. */
30 #if HAVE_ALLOCA_H
31 # include <alloca.h>
32 #else
33 # ifdef _AIX
34 #pragma alloca
35 # else
36 # if !defined(__GNUC__) && !defined(WINDOWS32)
37 # ifndef alloca /* predefined by HP cc +Olibcalls */
38 char *alloca ();
39 # endif
40 # endif
41 # endif
42 #endif
44 /* Disable assert() unless we're a maintainer.
45 Some asserts are compute-intensive. */
46 #ifndef MAKE_MAINTAINER_MODE
47 # define NDEBUG 1
48 #endif
51 #ifdef CRAY
52 /* This must happen before #include <signal.h> so
53 that the declaration therein is changed. */
54 # define signal bsdsignal
55 #endif
57 /* If we're compiling for the dmalloc debugger, turn off string inlining. */
58 #if defined(HAVE_DMALLOC_H) && defined(__GNUC__)
59 # define __NO_STRING_INLINES
60 #endif
62 #include <sys/types.h>
63 #include <sys/stat.h>
64 #include <signal.h>
65 #include <stdio.h>
66 #include <ctype.h>
68 #ifdef HAVE_SYS_TIMEB_H
69 /* SCO 3.2 "devsys 4.2" has a prototype for 'ftime' in <time.h> that bombs
70 unless <sys/timeb.h> has been included first. */
71 # include <sys/timeb.h>
72 #endif
73 #if TIME_WITH_SYS_TIME
74 # include <sys/time.h>
75 # include <time.h>
76 #else
77 # if HAVE_SYS_TIME_H
78 # include <sys/time.h>
79 # else
80 # include <time.h>
81 # endif
82 #endif
84 #include <errno.h>
86 #ifndef errno
87 extern int errno;
88 #endif
90 #ifndef isblank
91 # define isblank(c) ((c) == ' ' || (c) == '\t')
92 #endif
94 #ifdef HAVE_UNISTD_H
95 # include <unistd.h>
96 /* Ultrix's unistd.h always defines _POSIX_VERSION, but you only get
97 POSIX.1 behavior with 'cc -YPOSIX', which predefines POSIX itself! */
98 # if defined (_POSIX_VERSION) && !defined (ultrix) && !defined (VMS)
99 # define POSIX 1
100 # endif
101 #endif
103 /* Some systems define _POSIX_VERSION but are not really POSIX.1. */
104 #if (defined (butterfly) || defined (__arm) || (defined (__mips) && defined (_SYSTYPE_SVR3)) || (defined (sequent) && defined (i386)))
105 # undef POSIX
106 #endif
108 #if !defined (POSIX) && defined (_AIX) && defined (_POSIX_SOURCE)
109 # define POSIX 1
110 #endif
112 #ifndef RETSIGTYPE
113 # define RETSIGTYPE void
114 #endif
116 #ifndef sigmask
117 # define sigmask(sig) (1 << ((sig) - 1))
118 #endif
120 #ifndef HAVE_SA_RESTART
121 # define SA_RESTART 0
122 #endif
124 #ifdef HAVE_LIMITS_H
125 # include <limits.h>
126 #endif
127 #ifdef HAVE_SYS_PARAM_H
128 # include <sys/param.h>
129 #endif
131 #ifndef PATH_MAX
132 # ifndef POSIX
133 # define PATH_MAX MAXPATHLEN
134 # endif
135 #endif
136 #ifndef MAXPATHLEN
137 # define MAXPATHLEN 1024
138 #endif
140 #ifdef PATH_MAX
141 # define GET_PATH_MAX PATH_MAX
142 # define PATH_VAR(var) char var[PATH_MAX]
143 #else
144 # define NEED_GET_PATH_MAX 1
145 # define GET_PATH_MAX (get_path_max ())
146 # define PATH_VAR(var) char *var = alloca (GET_PATH_MAX)
147 unsigned int get_path_max (void);
148 #endif
150 #ifndef CHAR_BIT
151 # define CHAR_BIT 8
152 #endif
154 #ifndef USHRT_MAX
155 # define USHRT_MAX 65535
156 #endif
158 /* Nonzero if the integer type T is signed.
159 Use <= to avoid GCC warnings about always-false expressions. */
160 #define INTEGER_TYPE_SIGNED(t) ((t) -1 <= 0)
162 /* The minimum and maximum values for the integer type T.
163 Use ~ (t) 0, not -1, for portability to 1's complement hosts. */
164 #define INTEGER_TYPE_MINIMUM(t) \
165 (! INTEGER_TYPE_SIGNED (t) ? (t) 0 : ~ (t) 0 << (sizeof (t) * CHAR_BIT - 1))
166 #define INTEGER_TYPE_MAXIMUM(t) (~ (t) 0 - INTEGER_TYPE_MINIMUM (t))
168 #ifndef CHAR_MAX
169 # define CHAR_MAX INTEGER_TYPE_MAXIMUM (char)
170 #endif
172 #ifdef STAT_MACROS_BROKEN
173 # ifdef S_ISREG
174 # undef S_ISREG
175 # endif
176 # ifdef S_ISDIR
177 # undef S_ISDIR
178 # endif
179 #endif /* STAT_MACROS_BROKEN. */
181 #ifndef S_ISREG
182 # define S_ISREG(mode) (((mode) & S_IFMT) == S_IFREG)
183 #endif
184 #ifndef S_ISDIR
185 # define S_ISDIR(mode) (((mode) & S_IFMT) == S_IFDIR)
186 #endif
188 #ifdef VMS
189 # include <types.h>
190 # include <unixlib.h>
191 # include <unixio.h>
192 # include <perror.h>
193 /* Needed to use alloca on VMS. */
194 # include <builtins.h>
195 #endif
197 #ifndef __attribute__
198 /* This feature is available in gcc versions 2.5 and later. */
199 # if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 5) || __STRICT_ANSI__
200 # define __attribute__(x)
201 # endif
202 /* The __-protected variants of 'format' and 'printf' attributes
203 are accepted by gcc versions 2.6.4 (effectively 2.7) and later. */
204 # if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 7)
205 # define __format__ format
206 # define __printf__ printf
207 # endif
208 #endif
209 #define UNUSED __attribute__ ((unused))
211 #if defined (STDC_HEADERS) || defined (__GNU_LIBRARY__)
212 # include <stdlib.h>
213 # include <string.h>
214 # define ANSI_STRING 1
215 #else /* No standard headers. */
216 # ifdef HAVE_STRING_H
217 # include <string.h>
218 # define ANSI_STRING 1
219 # else
220 # include <strings.h>
221 # endif
222 # ifdef HAVE_MEMORY_H
223 # include <memory.h>
224 # endif
225 # ifdef HAVE_STDLIB_H
226 # include <stdlib.h>
227 # else
228 void *malloc (int);
229 void *realloc (void *, int);
230 void free (void *);
232 void abort (void) __attribute__ ((noreturn));
233 void exit (int) __attribute__ ((noreturn));
234 # endif /* HAVE_STDLIB_H. */
236 #endif /* Standard headers. */
238 /* These should be in stdlib.h. Make sure we have them. */
239 #ifndef EXIT_SUCCESS
240 # define EXIT_SUCCESS 0
241 #endif
242 #ifndef EXIT_FAILURE
243 # define EXIT_FAILURE 1
244 #endif
246 #ifndef ANSI_STRING
248 /* SCO Xenix has a buggy macro definition in <string.h>. */
249 #undef strerror
250 #if !defined(__DECC)
251 char *strerror (int errnum);
252 #endif
254 #endif /* !ANSI_STRING. */
255 #undef ANSI_STRING
257 #if HAVE_INTTYPES_H
258 # include <inttypes.h>
259 #endif
260 #if HAVE_STDINT_H
261 # include <stdint.h>
262 #endif
263 #define FILE_TIMESTAMP uintmax_t
265 #if !defined(HAVE_STRSIGNAL)
266 char *strsignal (int signum);
267 #endif
269 /* ISDIGIT offers the following features:
270 - Its arg may be any int or unsigned int; it need not be an unsigned char.
271 - It's guaranteed to evaluate its argument exactly once.
272 NOTE! Make relies on this behavior, don't change it!
273 - It's typically faster.
274 POSIX 1003.2-1992 section 2.5.2.1 page 50 lines 1556-1558 says that
275 only '0' through '9' are digits. Prefer ISDIGIT to isdigit() unless
276 it's important to use the locale's definition of 'digit' even when the
277 host does not conform to POSIX. */
278 #define ISDIGIT(c) ((unsigned) (c) - '0' <= 9)
280 /* Test if two strings are equal. Is this worthwhile? Should be profiled. */
281 #define streq(a, b) \
282 ((a) == (b) || \
283 (*(a) == *(b) && (*(a) == '\0' || !strcmp ((a) + 1, (b) + 1))))
285 /* Test if two strings are equal, but match case-insensitively on systems
286 which have case-insensitive filesystems. Should only be used for
287 filenames! */
288 #ifdef HAVE_CASE_INSENSITIVE_FS
289 # define patheq(a, b) \
290 ((a) == (b) \
291 || (tolower((unsigned char)*(a)) == tolower((unsigned char)*(b)) \
292 && (*(a) == '\0' || !strcasecmp ((a) + 1, (b) + 1))))
293 #else
294 # define patheq(a, b) streq(a, b)
295 #endif
297 #define strneq(a, b, l) (strncmp ((a), (b), (l)) == 0)
299 #if defined(__GNUC__) || defined(ENUM_BITFIELDS)
300 # define ENUM_BITFIELD(bits) :bits
301 #else
302 # define ENUM_BITFIELD(bits)
303 #endif
305 /* Handle gettext and locales. */
307 #if HAVE_LOCALE_H
308 # include <locale.h>
309 #else
310 # define setlocale(category, locale)
311 #endif
313 #include <gettext.h>
315 #define _(msgid) gettext (msgid)
316 #define N_(msgid) gettext_noop (msgid)
317 #define S_(msg1,msg2,num) ngettext (msg1,msg2,num)
319 /* Handle other OSs.
320 To overcome an issue parsing paths in a DOS/Windows environment when
321 built in a unix based environment, override the PATH_SEPARATOR_CHAR
322 definition unless being built for Cygwin. */
323 #if defined(HAVE_DOS_PATHS) && !defined(__CYGWIN__)
324 # undef PATH_SEPARATOR_CHAR
325 # define PATH_SEPARATOR_CHAR ';'
326 #elif !defined(PATH_SEPARATOR_CHAR)
327 # if defined (VMS)
328 # define PATH_SEPARATOR_CHAR ','
329 # else
330 # define PATH_SEPARATOR_CHAR ':'
331 # endif
332 #endif
334 /* This is needed for getcwd() and chdir(), on some W32 systems. */
335 #if defined(HAVE_DIRECT_H)
336 # include <direct.h>
337 #endif
339 #ifdef WINDOWS32
340 # include <fcntl.h>
341 # include <malloc.h>
342 # define pipe(_p) _pipe((_p), 512, O_BINARY)
343 # define kill(_pid,_sig) w32_kill((_pid),(_sig))
345 void sync_Path_environment (void);
346 int w32_kill (pid_t pid, int sig);
347 char *end_of_token_w32 (const char *s, char stopchar);
348 int find_and_set_default_shell (const char *token);
350 /* indicates whether or not we have Bourne shell */
351 extern int no_default_sh_exe;
353 /* is default_shell unixy? */
354 extern int unixy_shell;
355 #endif /* WINDOWS32 */
357 #if defined(HAVE_SYS_RESOURCE_H) && defined(HAVE_GETRLIMIT) && defined(HAVE_SETRLIMIT)
358 # define SET_STACK_SIZE
359 #endif
360 #ifdef SET_STACK_SIZE
361 # include <sys/resource.h>
362 extern struct rlimit stack_limit;
363 #endif
365 struct floc
367 const char *filenm;
368 unsigned long lineno;
370 #define NILF ((struct floc *)0)
372 #define CSTRLEN(_s) (sizeof (_s)-1)
373 #define STRING_SIZE_TUPLE(_s) (_s), CSTRLEN(_s)
376 /* We have to have stdarg.h or varargs.h AND v*printf or doprnt to use
377 variadic versions of these functions. */
379 #if HAVE_STDARG_H || HAVE_VARARGS_H
380 # if HAVE_VPRINTF || HAVE_DOPRNT
381 # define USE_VARIADIC 1
382 # endif
383 #endif
385 #if HAVE_ANSI_COMPILER && USE_VARIADIC && HAVE_STDARG_H
386 const char *concat (unsigned int, ...);
387 void message (int prefix, const char *fmt, ...)
388 __attribute__ ((__format__ (__printf__, 2, 3)));
389 void error (const struct floc *flocp, const char *fmt, ...)
390 __attribute__ ((__format__ (__printf__, 2, 3)));
391 void fatal (const struct floc *flocp, const char *fmt, ...)
392 __attribute__ ((noreturn, __format__ (__printf__, 2, 3)));
393 #else
394 const char *concat ();
395 void message ();
396 void error ();
397 void fatal ();
398 #endif
400 void die (int) __attribute__ ((noreturn));
401 void log_working_directory (int);
402 void pfatal_with_name (const char *) __attribute__ ((noreturn));
403 void perror_with_name (const char *, const char *);
404 void *xmalloc (unsigned int);
405 void *xcalloc (unsigned int);
406 void *xrealloc (void *, unsigned int);
407 char *xstrdup (const char *);
408 char *xstrndup (const char *, unsigned int);
409 char *find_next_token (const char **, unsigned int *);
410 char *next_token (const char *);
411 char *end_of_token (const char *);
412 void collapse_continuations (char *);
413 char *lindex (const char *, const char *, int);
414 int alpha_compare (const void *, const void *);
415 void print_spaces (unsigned int);
416 char *find_percent (char *);
417 const char *find_percent_cached (const char **);
418 FILE *open_tmpfile (char **, const char *);
420 #ifndef NO_ARCHIVES
421 int ar_name (const char *);
422 void ar_parse_name (const char *, char **, char **);
423 int ar_touch (const char *);
424 time_t ar_member_date (const char *);
426 typedef long int (*ar_member_func_t) (int desc, const char *mem, int truncated,
427 long int hdrpos, long int datapos,
428 long int size, long int date, int uid,
429 int gid, int mode, const void *arg);
431 long int ar_scan (const char *archive, ar_member_func_t function, const void *arg);
432 int ar_name_equal (const char *name, const char *mem, int truncated);
433 #ifndef VMS
434 int ar_member_touch (const char *arname, const char *memname);
435 #endif
436 #endif
438 int dir_file_exists_p (const char *, const char *);
439 int file_exists_p (const char *);
440 int file_impossible_p (const char *);
441 void file_impossible (const char *);
442 const char *dir_name (const char *);
443 void hash_init_directories (void);
445 void define_default_variables (void);
446 void set_default_suffixes (void);
447 void install_default_suffix_rules (void);
448 void install_default_implicit_rules (void);
450 void build_vpath_lists (void);
451 void construct_vpath_list (char *pattern, char *dirpath);
452 const char *vpath_search (const char *file, FILE_TIMESTAMP *mtime_ptr,
453 unsigned int* vpath_index, unsigned int* path_index);
454 int gpath_search (const char *file, unsigned int len);
456 void construct_include_path (const char **arg_dirs);
458 void user_access (void);
459 void make_access (void);
460 void child_access (void);
462 void close_stdout (void);
464 char *strip_whitespace (const char **begpp, const char **endpp);
466 /* String caching */
467 void strcache_init (void);
468 void strcache_print_stats (const char *prefix);
469 int strcache_iscached (const char *str);
470 const char *strcache_add (const char *str);
471 const char *strcache_add_len (const char *str, unsigned int len);
472 int strcache_setbufsize (unsigned int size);
474 /* Guile support */
475 int setup_guile (void);
478 #ifdef HAVE_VFORK_H
479 # include <vfork.h>
480 #endif
482 /* We omit these declarations on non-POSIX systems which define _POSIX_VERSION,
483 because such systems often declare them in header files anyway. */
485 #if !defined (__GNU_LIBRARY__) && !defined (POSIX) && !defined (_POSIX_VERSION) && !defined(WINDOWS32)
487 long int atol ();
488 # ifndef VMS
489 long int lseek ();
490 # endif
492 #endif /* Not GNU C library or POSIX. */
494 #ifdef HAVE_GETCWD
495 # if !defined(VMS) && !defined(__DECC)
496 char *getcwd ();
497 # endif
498 #else
499 char *getwd ();
500 # define getcwd(buf, len) getwd (buf)
501 #endif
503 #if !HAVE_STRCASECMP
504 # if HAVE_STRICMP
505 # define strcasecmp stricmp
506 # elif HAVE_STRCMPI
507 # define strcasecmp strcmpi
508 # else
509 /* Create our own, in misc.c */
510 int strcasecmp (const char *s1, const char *s2);
511 # endif
512 #endif
514 #if !HAVE_STRNCASECMP
515 # if HAVE_STRNICMP
516 # define strncasecmp strnicmp
517 # elif HAVE_STRNCMPI
518 # define strncasecmp strncmpi
519 # else
520 /* Create our own, in misc.c */
521 int strncasecmp (const char *s1, const char *s2, int n);
522 # endif
523 #endif
525 extern const struct floc *reading_file;
526 extern const struct floc **expanding_var;
528 extern char **environ;
530 extern int just_print_flag, silent_flag, ignore_errors_flag, keep_going_flag;
531 extern int print_data_base_flag, question_flag, touch_flag, always_make_flag;
532 extern int env_overrides, no_builtin_rules_flag, no_builtin_variables_flag;
533 extern int print_version_flag, print_directory_flag, check_symlink_flag;
534 extern int warn_undefined_variables_flag, trace_flag, posix_pedantic;
535 extern int not_parallel, second_expansion, clock_skew_detected;
536 extern int rebuilding_makefiles, one_shell;
538 /* can we run commands via 'sh -c xxx' or must we use batch files? */
539 extern int batch_mode_shell;
541 /* Resetting the command script introduction prefix character. */
542 #define RECIPEPREFIX_NAME ".RECIPEPREFIX"
543 #define RECIPEPREFIX_DEFAULT '\t'
544 extern char cmd_prefix;
546 extern unsigned int job_slots;
547 extern int job_fds[2];
548 extern int job_rfd;
549 #ifndef NO_FLOAT
550 extern double max_load_average;
551 #else
552 extern int max_load_average;
553 #endif
555 extern char *program;
556 extern char *starting_directory;
557 extern unsigned int makelevel;
558 extern char *version_string, *remote_description, *make_host;
560 extern unsigned int commands_started;
562 extern int handling_fatal_signal;
565 #ifndef MIN
566 #define MIN(_a,_b) ((_a)<(_b)?(_a):(_b))
567 #endif
568 #ifndef MAX
569 #define MAX(_a,_b) ((_a)>(_b)?(_a):(_b))
570 #endif
572 #ifdef VMS
573 # define MAKE_SUCCESS 1
574 # define MAKE_TROUBLE 2
575 # define MAKE_FAILURE 3
576 #else
577 # define MAKE_SUCCESS 0
578 # define MAKE_TROUBLE 1
579 # define MAKE_FAILURE 2
580 #endif
582 /* Set up heap debugging library dmalloc. */
584 #ifdef HAVE_DMALLOC_H
585 #include <dmalloc.h>
586 #endif
588 #ifndef initialize_main
589 # ifdef __EMX__
590 # define initialize_main(pargc, pargv) \
591 { _wildcard(pargc, pargv); _response(pargc, pargv); }
592 # else
593 # define initialize_main(pargc, pargv)
594 # endif
595 #endif
597 #ifdef __EMX__
598 # if !defined chdir
599 # define chdir _chdir2
600 # endif
601 # if !defined getcwd
602 # define getcwd _getcwd2
603 # endif
605 /* NO_CHDIR2 causes make not to use _chdir2() and _getcwd2() instead of
606 chdir() and getcwd(). This avoids some error messages for the
607 make testsuite but restricts the drive letter support. */
608 # ifdef NO_CHDIR2
609 # warning NO_CHDIR2: usage of drive letters restricted
610 # undef chdir
611 # undef getcwd
612 # endif
613 #endif
615 #ifndef initialize_main
616 # define initialize_main(pargc, pargv)
617 #endif
620 /* Some systems (like Solaris, PTX, etc.) do not support the SA_RESTART flag
621 properly according to POSIX. So, we try to wrap common system calls with
622 checks for EINTR. Note that there are still plenty of system calls that
623 can fail with EINTR but this, reportedly, gets the vast majority of
624 failure cases. If you still experience failures you'll need to either get
625 a system where SA_RESTART works, or you need to avoid -j. */
627 #define EINTRLOOP(_v,_c) while (((_v)=_c)==-1 && errno==EINTR)
629 /* While system calls that return integers are pretty consistent about
630 returning -1 on failure and setting errno in that case, functions that
631 return pointers are not always so well behaved. Sometimes they return
632 NULL for expected behavior: one good example is readdir() which returns
633 NULL at the end of the directory--and _doesn't_ reset errno. So, we have
634 to do it ourselves here. */
636 #define ENULLLOOP(_v,_c) do { errno = 0; (_v) = _c; } \
637 while((_v)==0 && errno==EINTR)