1 /* Miscellaneous generic support functions 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
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/>. */
21 /* Variadic functions. We go through contortions to allow proper function
22 prototypes for both ANSI and pre-ANSI C compilers, and also for those
23 which support stdarg.h vs. varargs.h, and finally those which have
24 vfprintf(), etc. and those who have _doprnt... or nothing.
26 This fancy stuff all came from GNU fileutils, except for the VA_PRINTF and
27 VA_END macros used here since we have multiple print functions. */
32 # define VA_START(args, lastarg) va_start(args, lastarg)
35 # define VA_START(args, lastarg) va_start(args)
38 # define VA_PRINTF(fp, lastarg, args) vfprintf((fp), (lastarg), (args))
40 # define VA_PRINTF(fp, lastarg, args) _doprnt((lastarg), (args), (fp))
42 # define VA_END(args) va_end(args)
44 /* We can't use any variadic interface! */
45 # define va_alist a1, a2, a3, a4, a5, a6, a7, a8
46 # define va_dcl char *a1, *a2, *a3, *a4, *a5, *a6, *a7, *a8;
47 # define VA_START(args, lastarg)
48 # define VA_PRINTF(fp, lastarg, args) fprintf((fp), (lastarg), va_alist)
53 /* Compare strings *S1 and *S2.
54 Return negative if the first is less, positive if it is greater,
55 zero if they are equal. */
58 alpha_compare (const void *v1
, const void *v2
)
60 const char *s1
= *((char **)v1
);
61 const char *s2
= *((char **)v2
);
65 return strcmp (s1
, s2
);
68 /* Discard each backslash-newline combination from LINE.
69 Backslash-backslash-newline combinations become backslash-newlines.
70 This is done by copying the text at LINE into itself. */
73 collapse_continuations (char *line
)
75 register char *in
, *out
, *p
;
76 register int backslash
;
77 register unsigned int bs_write
;
79 in
= strchr (line
, '\n');
84 while (out
> line
&& out
[-1] == '\\')
89 /* BS_WRITE gets the number of quoted backslashes at
90 the end just before IN, and BACKSLASH gets nonzero
91 if the next character is quoted. */
94 for (p
= in
- 1; p
>= line
&& *p
== '\\'; --p
)
98 backslash
= !backslash
;
100 /* It should be impossible to go back this far without exiting,
101 but if we do, we can't get the right answer. */
106 /* Output the appropriate number of backslashes. */
107 while (bs_write
-- > 0)
110 /* Skip the newline. */
115 /* Backslash/newline handling:
116 In traditional GNU make all trailing whitespace, consecutive
117 backslash/newlines, and any leading whitespace on the next line
118 is reduced to a single space.
119 In POSIX, each backslash/newline and is replaced by a space. */
120 in
= next_token (in
);
121 if (! posix_pedantic
)
122 while (out
> line
&& isblank ((unsigned char)out
[-1]))
127 /* If the newline isn't quoted, put it in the output. */
130 /* Now copy the following line to the output.
131 Stop when we find backslashes followed by a newline. */
153 /* Print N spaces (used in debug for target-depth). */
156 print_spaces (unsigned int n
)
163 /* Return a string whose contents concatenate the NUM strings provided
164 This string lives in static, re-used memory. */
167 #if HAVE_ANSI_COMPILER && USE_VARIADIC && HAVE_STDARG_H
168 concat (unsigned int num
, ...)
170 concat (num
, va_alist
)
175 static unsigned int rlen
= 0;
176 static char *result
= NULL
;
183 VA_START (args
, num
);
187 const char *s
= va_arg (args
, const char *);
188 unsigned int l
= s
? strlen (s
) : 0;
195 rlen
= ((rlen
? rlen
: 60) + l
) * 2;
196 result
= xrealloc (result
, rlen
);
199 memcpy (result
+ ri
, s
, l
);
205 /* Get some more memory if we don't have enough space for the
209 rlen
= (rlen
? rlen
: 60) * 2;
210 result
= xrealloc (result
, rlen
);
218 /* Print a message on stdout. */
221 #if HAVE_ANSI_COMPILER && USE_VARIADIC && HAVE_STDARG_H
222 message (int prefix
, const char *fmt
, ...)
224 message (prefix
, fmt
, va_alist
)
234 log_working_directory (1);
241 printf ("%s: ", program
);
243 printf ("%s[%u]: ", program
, makelevel
);
245 VA_START (args
, fmt
);
246 VA_PRINTF (stdout
, fmt
, args
);
254 /* Print an error message. */
257 #if HAVE_ANSI_COMPILER && USE_VARIADIC && HAVE_STDARG_H
258 error (const struct floc
*flocp
, const char *fmt
, ...)
260 error (flocp
, fmt
, va_alist
)
261 const struct floc
*flocp
;
270 log_working_directory (1);
272 if (flocp
&& flocp
->filenm
)
273 fprintf (stderr
, "%s:%lu: ", flocp
->filenm
, flocp
->lineno
);
274 else if (makelevel
== 0)
275 fprintf (stderr
, "%s: ", program
);
277 fprintf (stderr
, "%s[%u]: ", program
, makelevel
);
280 VA_PRINTF (stderr
, fmt
, args
);
287 /* Print an error message and exit. */
290 #if HAVE_ANSI_COMPILER && USE_VARIADIC && HAVE_STDARG_H
291 fatal (const struct floc
*flocp
, const char *fmt
, ...)
293 fatal (flocp
, fmt
, va_alist
)
294 const struct floc
*flocp
;
303 log_working_directory (1);
305 if (flocp
&& flocp
->filenm
)
306 fprintf (stderr
, "%s:%lu: *** ", flocp
->filenm
, flocp
->lineno
);
307 else if (makelevel
== 0)
308 fprintf (stderr
, "%s: *** ", program
);
310 fprintf (stderr
, "%s[%u]: *** ", program
, makelevel
);
313 VA_PRINTF (stderr
, fmt
, args
);
316 fputs (_(". Stop.\n"), stderr
);
321 #ifndef HAVE_STRERROR
326 strerror (int errnum
)
328 extern int errno
, sys_nerr
;
330 extern char *sys_errlist
[];
332 static char buf
[] = "Unknown error 12345678901234567890";
334 if (errno
< sys_nerr
)
335 return sys_errlist
[errnum
];
337 sprintf (buf
, _("Unknown error %d"), errnum
);
342 /* Print an error message from errno. */
345 perror_with_name (const char *str
, const char *name
)
347 error (NILF
, _("%s%s: %s"), str
, name
, strerror (errno
));
350 /* Print an error message from errno and exit. */
353 pfatal_with_name (const char *name
)
355 fatal (NILF
, _("%s: %s"), name
, strerror (errno
));
360 /* Like malloc but get fatal error if memory is exhausted. */
361 /* Don't bother if we're using dmalloc; it provides these for us. */
363 #ifndef HAVE_DMALLOC_H
371 xmalloc (unsigned int size
)
373 /* Make sure we don't allocate 0, for pre-ISO implementations. */
374 void *result
= malloc (size
? size
: 1);
376 fatal (NILF
, _("virtual memory exhausted"));
382 xcalloc (unsigned int size
)
384 /* Make sure we don't allocate 0, for pre-ISO implementations. */
385 void *result
= calloc (size
? size
: 1, 1);
387 fatal (NILF
, _("virtual memory exhausted"));
393 xrealloc (void *ptr
, unsigned int size
)
397 /* Some older implementations of realloc() don't conform to ISO. */
400 result
= ptr
? realloc (ptr
, size
) : malloc (size
);
402 fatal (NILF
, _("virtual memory exhausted"));
408 xstrdup (const char *ptr
)
413 result
= strdup (ptr
);
415 result
= malloc (strlen (ptr
) + 1);
419 fatal (NILF
, _("virtual memory exhausted"));
424 return strcpy (result
, ptr
);
428 #endif /* HAVE_DMALLOC_H */
431 xstrndup (const char *str
, unsigned int length
)
436 result
= strndup (str
, length
);
438 fatal (NILF
, _("virtual memory exhausted"));
440 result
= xmalloc (length
+ 1);
442 strncpy (result
, str
, length
);
443 result
[length
] = '\0';
451 Search through the string STRING, which ends at LIMIT, for the character C.
452 Returns a pointer to the first occurrence, or nil if none is found.
453 Like INDEX except that the string searched ends where specified
454 instead of at the first null. */
457 lindex (const char *s
, const char *limit
, int c
)
461 return (char *)(s
- 1);
466 /* Return the address of the first whitespace or null in the string S. */
469 end_of_token (const char *s
)
471 while (*s
!= '\0' && !isblank ((unsigned char)*s
))
478 * Same as end_of_token, but take into account a stop character
481 end_of_token_w32 (const char *s
, char stopchar
)
486 while (*p
!= '\0' && *p
!= stopchar
487 && (backslash
|| !isblank ((unsigned char)*p
)))
491 backslash
= !backslash
;
494 backslash
= !backslash
;
506 /* Return the address of the first nonwhitespace or null in the string S. */
509 next_token (const char *s
)
511 while (isblank ((unsigned char)*s
))
516 /* Find the next token in PTR; return the address of it, and store the length
517 of the token into *LENGTHPTR if LENGTHPTR is not nil. Set *PTR to the end
518 of the token, so this function can be called repeatedly in a loop. */
521 find_next_token (const char **ptr
, unsigned int *lengthptr
)
523 const char *p
= next_token (*ptr
);
528 *ptr
= end_of_token (p
);
530 *lengthptr
= *ptr
- p
;
536 /* Copy a chain of 'struct dep'. For 2nd expansion deps, dup the name. */
539 copy_dep_chain (const struct dep
*d
)
541 struct dep
*firstnew
= 0;
542 struct dep
*lastnew
= 0;
546 struct dep
*c
= xmalloc (sizeof (struct dep
));
547 memcpy (c
, d
, sizeof (struct dep
));
549 if (c
->need_2nd_expansion
)
550 c
->name
= xstrdup (c
->name
);
554 firstnew
= lastnew
= c
;
556 lastnew
= lastnew
->next
= c
;
564 /* Free a chain of 'struct dep'. */
567 free_dep_chain (struct dep
*d
)
577 /* Free a chain of struct nameseq.
578 For struct dep chains use free_dep_chain. */
581 free_ns_chain (struct nameseq
*ns
)
585 struct nameseq
*t
= ns
;
592 #if !HAVE_STRCASECMP && !HAVE_STRICMP && !HAVE_STRCMPI
594 /* If we don't have strcasecmp() (from POSIX), or anything that can substitute
595 for it, define our own version. */
598 strcasecmp (const char *s1
, const char *s2
)
602 int c1
= (int) *(s1
++);
603 int c2
= (int) *(s2
++);
610 if (c1
!= '\0' && c1
== c2
)
618 #if !HAVE_STRNCASECMP && !HAVE_STRNICMP && !HAVE_STRNCMPI
620 /* If we don't have strncasecmp() (from POSIX), or anything that can
621 substitute for it, define our own version. */
624 strncasecmp (const char *s1
, const char *s2
, int n
)
628 int c1
= (int) *(s1
++);
629 int c2
= (int) *(s2
++);
636 if (c1
!= '\0' && c1
== c2
)
646 #ifdef GETLOADAVG_PRIVILEGED
650 /* Hopefully if a system says it's POSIX.1 and has the setuid and setgid
651 functions, they work as POSIX.1 says. Some systems (Alpha OSF/1 1.2,
652 for example) which claim to be POSIX.1 also have the BSD setreuid and
653 setregid functions, but they don't work as in BSD and only the POSIX.1
659 #else /* Not POSIX. */
661 /* Some POSIX.1 systems have the seteuid and setegid functions. In a
662 POSIX-like system, they are the best thing to use. However, some
663 non-POSIX systems have them too but they do not work in the POSIX style
664 and we must use setreuid and setregid instead. */
671 #ifndef HAVE_UNISTD_H
672 extern int getuid (), getgid (), geteuid (), getegid ();
673 extern int setuid (), setgid ();
675 extern int seteuid ();
678 extern int setreuid ();
679 #endif /* Have setreuid. */
680 #endif /* Have seteuid. */
682 extern int setegid ();
685 extern int setregid ();
686 #endif /* Have setregid. */
687 #endif /* Have setegid. */
688 #endif /* No <unistd.h>. */
690 /* Keep track of the user and group IDs for user- and make- access. */
691 static int user_uid
= -1, user_gid
= -1, make_uid
= -1, make_gid
= -1;
692 #define access_inited (user_uid != -1)
693 static enum { make
, user
} current_access
;
696 /* Under -d, write a message describing the current IDs. */
699 log_access (const char *flavor
)
701 if (! ISDB (DB_JOBS
))
704 /* All the other debugging messages go to stdout,
705 but we write this one to stderr because it might be
706 run in a child fork whose stdout is piped. */
708 fprintf (stderr
, _("%s: user %lu (real %lu), group %lu (real %lu)\n"),
709 flavor
, (unsigned long) geteuid (), (unsigned long) getuid (),
710 (unsigned long) getegid (), (unsigned long) getgid ());
719 user_uid
= getuid ();
720 user_gid
= getgid ();
722 make_uid
= geteuid ();
723 make_gid
= getegid ();
725 /* Do these ever fail? */
726 if (user_uid
== -1 || user_gid
== -1 || make_uid
== -1 || make_gid
== -1)
727 pfatal_with_name ("get{e}[gu]id");
729 log_access (_("Initialized access"));
731 current_access
= make
;
735 #endif /* GETLOADAVG_PRIVILEGED */
737 /* Give the process appropriate permissions for access to
738 user data (i.e., to stat files, or to spawn a child process). */
742 #ifdef GETLOADAVG_PRIVILEGED
747 if (current_access
== user
)
750 /* We are in "make access" mode. This means that the effective user and
751 group IDs are those of make (if it was installed setuid or setgid).
752 We now want to set the effective user and group IDs to the real IDs,
753 which are the IDs of the process that exec'd make. */
757 /* Modern systems have the seteuid/setegid calls which set only the
758 effective IDs, which is ideal. */
760 if (seteuid (user_uid
) < 0)
761 pfatal_with_name ("user_access: seteuid");
763 #else /* Not HAVE_SETEUID. */
765 #ifndef HAVE_SETREUID
767 /* System V has only the setuid/setgid calls to set user/group IDs.
768 There is an effective ID, which can be set by setuid/setgid.
769 It can be set (unless you are root) only to either what it already is
770 (returned by geteuid/getegid, now in make_uid/make_gid),
771 the real ID (return by getuid/getgid, now in user_uid/user_gid),
772 or the saved set ID (what the effective ID was before this set-ID
773 executable (make) was exec'd). */
775 if (setuid (user_uid
) < 0)
776 pfatal_with_name ("user_access: setuid");
778 #else /* HAVE_SETREUID. */
780 /* In 4BSD, the setreuid/setregid calls set both the real and effective IDs.
781 They may be set to themselves or each other. So you have two alternatives
782 at any one time. If you use setuid/setgid, the effective will be set to
783 the real, leaving only one alternative. Using setreuid/setregid, however,
784 you can toggle between your two alternatives by swapping the values in a
785 single setreuid or setregid call. */
787 if (setreuid (make_uid
, user_uid
) < 0)
788 pfatal_with_name ("user_access: setreuid");
790 #endif /* Not HAVE_SETREUID. */
791 #endif /* HAVE_SETEUID. */
794 if (setegid (user_gid
) < 0)
795 pfatal_with_name ("user_access: setegid");
797 #ifndef HAVE_SETREGID
798 if (setgid (user_gid
) < 0)
799 pfatal_with_name ("user_access: setgid");
801 if (setregid (make_gid
, user_gid
) < 0)
802 pfatal_with_name ("user_access: setregid");
806 current_access
= user
;
808 log_access (_("User access"));
810 #endif /* GETLOADAVG_PRIVILEGED */
813 /* Give the process appropriate permissions for access to
814 make data (i.e., the load average). */
818 #ifdef GETLOADAVG_PRIVILEGED
823 if (current_access
== make
)
826 /* See comments in user_access, above. */
829 if (seteuid (make_uid
) < 0)
830 pfatal_with_name ("make_access: seteuid");
832 #ifndef HAVE_SETREUID
833 if (setuid (make_uid
) < 0)
834 pfatal_with_name ("make_access: setuid");
836 if (setreuid (user_uid
, make_uid
) < 0)
837 pfatal_with_name ("make_access: setreuid");
842 if (setegid (make_gid
) < 0)
843 pfatal_with_name ("make_access: setegid");
845 #ifndef HAVE_SETREGID
846 if (setgid (make_gid
) < 0)
847 pfatal_with_name ("make_access: setgid");
849 if (setregid (user_gid
, make_gid
) < 0)
850 pfatal_with_name ("make_access: setregid");
854 current_access
= make
;
856 log_access (_("Make access"));
858 #endif /* GETLOADAVG_PRIVILEGED */
861 /* Give the process appropriate permissions for a child process.
862 This is like user_access, but you can't get back to make_access. */
866 #ifdef GETLOADAVG_PRIVILEGED
871 /* Set both the real and effective UID and GID to the user's.
872 They cannot be changed back to make's. */
874 #ifndef HAVE_SETREUID
875 if (setuid (user_uid
) < 0)
876 pfatal_with_name ("child_access: setuid");
878 if (setreuid (user_uid
, user_uid
) < 0)
879 pfatal_with_name ("child_access: setreuid");
882 #ifndef HAVE_SETREGID
883 if (setgid (user_gid
) < 0)
884 pfatal_with_name ("child_access: setgid");
886 if (setregid (user_gid
, user_gid
) < 0)
887 pfatal_with_name ("child_access: setregid");
890 log_access (_("Child access"));
892 #endif /* GETLOADAVG_PRIVILEGED */
895 #ifdef NEED_GET_PATH_MAX
899 static unsigned int value
;
903 long int x
= pathconf ("/", _PC_PATH_MAX
);
915 /* This code is stolen from gnulib.
916 If/when we abandon the requirement to work with K&R compilers, we can
917 remove this (and perhaps other parts of GNU make!) and migrate to using
920 This is called only through atexit(), which means die() has already been
921 invoked. So, call exit() here directly. Apparently that works...?
924 /* Close standard output, exiting with status 'exit_failure' on failure.
925 If a program writes *anything* to stdout, that program should close
926 stdout and make sure that it succeeds before exiting. Otherwise,
927 suppose that you go to the extreme of checking the return status
928 of every function that does an explicit write to stdout. The last
929 printf can succeed in writing to the internal stream buffer, and yet
930 the fclose(stdout) could still fail (due e.g., to a disk full error)
931 when it tries to write out that buffered data. Thus, you would be
932 left with an incomplete output file and the offending program would
933 exit successfully. Even calling fflush is not always sufficient,
934 since some file systems (NFS and CODA) buffer written/flushed data
935 until an actual close call.
937 Besides, it's wasteful to check the return value from every call
938 that writes to stdout -- just let the internal stream state record
939 the failure. That's what the ferror test is checking below.
941 It's important to detect such failures and exit nonzero because many
942 tools (most notably 'make' and other build-management systems) depend
943 on being able to detect failure in other tools via their exit status. */
948 int prev_fail
= ferror (stdout
);
949 int fclose_fail
= fclose (stdout
);
951 if (prev_fail
|| fclose_fail
)
954 error (NILF
, _("write error: %s"), strerror (errno
));
956 error (NILF
, _("write error"));