1 /* Miscellaneous generic support functions 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 Free Software
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
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/>. */
23 /* Variadic functions. We go through contortions to allow proper function
24 prototypes for both ANSI and pre-ANSI C compilers, and also for those
25 which support stdarg.h vs. varargs.h, and finally those which have
26 vfprintf(), etc. and those who have _doprnt... or nothing.
28 This fancy stuff all came from GNU fileutils, except for the VA_PRINTF and
29 VA_END macros used here since we have multiple print functions. */
34 # define VA_START(args, lastarg) va_start(args, lastarg)
37 # define VA_START(args, lastarg) va_start(args)
40 # define VA_PRINTF(fp, lastarg, args) vfprintf((fp), (lastarg), (args))
42 # define VA_PRINTF(fp, lastarg, args) _doprnt((lastarg), (args), (fp))
44 # define VA_END(args) va_end(args)
46 /* We can't use any variadic interface! */
47 # define va_alist a1, a2, a3, a4, a5, a6, a7, a8
48 # define va_dcl char *a1, *a2, *a3, *a4, *a5, *a6, *a7, *a8;
49 # define VA_START(args, lastarg)
50 # define VA_PRINTF(fp, lastarg, args) fprintf((fp), (lastarg), va_alist)
55 /* Compare strings *S1 and *S2.
56 Return negative if the first is less, positive if it is greater,
57 zero if they are equal. */
60 alpha_compare (const void *v1
, const void *v2
)
62 const char *s1
= *((char **)v1
);
63 const char *s2
= *((char **)v2
);
67 return strcmp (s1
, s2
);
70 /* Discard each backslash-newline combination from LINE.
71 Backslash-backslash-newline combinations become backslash-newlines.
72 This is done by copying the text at LINE into itself. */
75 collapse_continuations (char *line
)
77 register char *in
, *out
, *p
;
78 register int backslash
;
79 register unsigned int bs_write
;
81 in
= strchr (line
, '\n');
86 while (out
> line
&& out
[-1] == '\\')
91 /* BS_WRITE gets the number of quoted backslashes at
92 the end just before IN, and BACKSLASH gets nonzero
93 if the next character is quoted. */
96 for (p
= in
- 1; p
>= line
&& *p
== '\\'; --p
)
100 backslash
= !backslash
;
102 /* It should be impossible to go back this far without exiting,
103 but if we do, we can't get the right answer. */
108 /* Output the appropriate number of backslashes. */
109 while (bs_write
-- > 0)
112 /* Skip the newline. */
115 /* If the newline is escaped, discard following whitespace leaving just
116 one space. POSIX requires that each backslash/newline/following
117 whitespace sequence be reduced to a single space. */
120 in
= next_token (in
);
121 /* Removing this loop will fix Savannah bug #16670: do we want to? */
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 those of s1, s2, s3.
164 This string lives in static, re-used memory. */
167 concat (const char *s1
, const char *s2
, const char *s3
)
169 unsigned int len1
, len2
, len3
;
170 static unsigned int rlen
= 0;
171 static char *result
= NULL
;
173 len1
= (s1
&& *s1
!= '\0') ? strlen (s1
) : 0;
174 len2
= (s2
&& *s2
!= '\0') ? strlen (s2
) : 0;
175 len3
= (s3
&& *s3
!= '\0') ? strlen (s3
) : 0;
177 if (len1
+ len2
+ len3
+ 1 > rlen
)
178 result
= xrealloc (result
, (rlen
= len1
+ len2
+ len3
+ 10));
181 memcpy (result
, s1
, len1
);
183 memcpy (result
+ len1
, s2
, len2
);
185 memcpy (result
+ len1
+ len2
, s3
, len3
);
187 result
[len1
+len2
+len3
] = '\0';
192 /* Print a message on stdout. */
195 #if HAVE_ANSI_COMPILER && USE_VARIADIC && HAVE_STDARG_H
196 message (int prefix
, const char *fmt
, ...)
198 message (prefix
, fmt
, va_alist
)
208 log_working_directory (1);
215 printf ("%s: ", program
);
217 printf ("%s[%u]: ", program
, makelevel
);
219 VA_START (args
, fmt
);
220 VA_PRINTF (stdout
, fmt
, args
);
228 /* Print an error message. */
231 #if HAVE_ANSI_COMPILER && USE_VARIADIC && HAVE_STDARG_H
232 error (const struct floc
*flocp
, const char *fmt
, ...)
234 error (flocp
, fmt
, va_alist
)
235 const struct floc
*flocp
;
244 log_working_directory (1);
246 if (flocp
&& flocp
->filenm
)
247 fprintf (stderr
, "%s:%lu: ", flocp
->filenm
, flocp
->lineno
);
248 else if (makelevel
== 0)
249 fprintf (stderr
, "%s: ", program
);
251 fprintf (stderr
, "%s[%u]: ", program
, makelevel
);
254 VA_PRINTF (stderr
, fmt
, args
);
261 /* Print an error message and exit. */
264 #if HAVE_ANSI_COMPILER && USE_VARIADIC && HAVE_STDARG_H
265 fatal (const struct floc
*flocp
, const char *fmt
, ...)
267 fatal (flocp
, fmt
, va_alist
)
268 const struct floc
*flocp
;
277 log_working_directory (1);
279 if (flocp
&& flocp
->filenm
)
280 fprintf (stderr
, "%s:%lu: *** ", flocp
->filenm
, flocp
->lineno
);
281 else if (makelevel
== 0)
282 fprintf (stderr
, "%s: *** ", program
);
284 fprintf (stderr
, "%s[%u]: *** ", program
, makelevel
);
287 VA_PRINTF (stderr
, fmt
, args
);
290 fputs (_(". Stop.\n"), stderr
);
295 #ifndef HAVE_STRERROR
300 strerror (int errnum
)
302 extern int errno
, sys_nerr
;
304 extern char *sys_errlist
[];
306 static char buf
[] = "Unknown error 12345678901234567890";
308 if (errno
< sys_nerr
)
309 return sys_errlist
[errnum
];
311 sprintf (buf
, _("Unknown error %d"), errnum
);
316 /* Print an error message from errno. */
319 perror_with_name (const char *str
, const char *name
)
321 error (NILF
, _("%s%s: %s"), str
, name
, strerror (errno
));
324 /* Print an error message from errno and exit. */
327 pfatal_with_name (const char *name
)
329 fatal (NILF
, _("%s: %s"), name
, strerror (errno
));
334 /* Like malloc but get fatal error if memory is exhausted. */
335 /* Don't bother if we're using dmalloc; it provides these for us. */
337 #ifndef HAVE_DMALLOC_H
344 xmalloc (unsigned int size
)
346 /* Make sure we don't allocate 0, for pre-ANSI libraries. */
347 void *result
= malloc (size
? size
: 1);
349 fatal (NILF
, _("virtual memory exhausted"));
355 xrealloc (void *ptr
, unsigned int size
)
359 /* Some older implementations of realloc() don't conform to ANSI. */
362 result
= ptr
? realloc (ptr
, size
) : malloc (size
);
364 fatal (NILF
, _("virtual memory exhausted"));
370 xstrdup (const char *ptr
)
375 result
= strdup (ptr
);
377 result
= malloc (strlen (ptr
) + 1);
381 fatal (NILF
, _("virtual memory exhausted"));
386 return strcpy (result
, ptr
);
390 #endif /* HAVE_DMALLOC_H */
393 xstrndup (const char *str
, unsigned int length
)
398 result
= strndup (str
, length
);
400 fatal (NILF
, _("virtual memory exhausted"));
402 result
= xmalloc (length
+ 1);
403 strncpy (result
, str
, length
);
404 result
[length
] = '\0';
412 Search through the string STRING, which ends at LIMIT, for the character C.
413 Returns a pointer to the first occurrence, or nil if none is found.
414 Like INDEX except that the string searched ends where specified
415 instead of at the first null. */
418 lindex (const char *s
, const char *limit
, int c
)
422 return (char *)(s
- 1);
427 /* Return the address of the first whitespace or null in the string S. */
430 end_of_token (const char *s
)
432 while (*s
!= '\0' && !isblank ((unsigned char)*s
))
439 * Same as end_of_token, but take into account a stop character
442 end_of_token_w32 (const char *s
, char stopchar
)
447 while (*p
!= '\0' && *p
!= stopchar
448 && (backslash
|| !isblank ((unsigned char)*p
)))
452 backslash
= !backslash
;
455 backslash
= !backslash
;
467 /* Return the address of the first nonwhitespace or null in the string S. */
470 next_token (const char *s
)
472 while (isblank ((unsigned char)*s
))
477 /* Find the next token in PTR; return the address of it, and store the length
478 of the token into *LENGTHPTR if LENGTHPTR is not nil. Set *PTR to the end
479 of the token, so this function can be called repeatedly in a loop. */
482 find_next_token (const char **ptr
, unsigned int *lengthptr
)
484 const char *p
= next_token (*ptr
);
489 *ptr
= end_of_token (p
);
491 *lengthptr
= *ptr
- p
;
497 /* Allocate a new `struct dep' with all fields initialized to 0. */
502 struct dep
*d
= xmalloc (sizeof (struct dep
));
503 memset (d
, '\0', sizeof (struct dep
));
508 /* Free `struct dep' along with `name' and `stem'. */
511 free_dep (struct dep
*d
)
516 /* Copy a chain of `struct dep', making a new chain
517 with the same contents as the old one. */
520 copy_dep_chain (const struct dep
*d
)
522 struct dep
*firstnew
= 0;
523 struct dep
*lastnew
= 0;
527 struct dep
*c
= xmalloc (sizeof (struct dep
));
528 memcpy (c
, d
, sizeof (struct dep
));
532 firstnew
= lastnew
= c
;
534 lastnew
= lastnew
->next
= c
;
542 /* Free a chain of 'struct dep'. */
545 free_dep_chain (struct dep
*d
)
555 /* Free a chain of struct nameseq.
556 For struct dep chains use free_dep_chain. */
559 free_ns_chain (struct nameseq
*ns
)
563 struct nameseq
*t
= ns
;
570 #if !HAVE_STRCASECMP && !HAVE_STRICMP && !HAVE_STRCMPI
572 /* If we don't have strcasecmp() (from POSIX), or anything that can substitute
573 for it, define our own version. */
576 strcasecmp (const char *s1
, const char *s2
)
580 int c1
= (int) *(s1
++);
581 int c2
= (int) *(s2
++);
588 if (c1
!= '\0' && c1
== c2
)
596 #ifdef GETLOADAVG_PRIVILEGED
600 /* Hopefully if a system says it's POSIX.1 and has the setuid and setgid
601 functions, they work as POSIX.1 says. Some systems (Alpha OSF/1 1.2,
602 for example) which claim to be POSIX.1 also have the BSD setreuid and
603 setregid functions, but they don't work as in BSD and only the POSIX.1
609 #else /* Not POSIX. */
611 /* Some POSIX.1 systems have the seteuid and setegid functions. In a
612 POSIX-like system, they are the best thing to use. However, some
613 non-POSIX systems have them too but they do not work in the POSIX style
614 and we must use setreuid and setregid instead. */
621 #ifndef HAVE_UNISTD_H
622 extern int getuid (), getgid (), geteuid (), getegid ();
623 extern int setuid (), setgid ();
625 extern int seteuid ();
628 extern int setreuid ();
629 #endif /* Have setreuid. */
630 #endif /* Have seteuid. */
632 extern int setegid ();
635 extern int setregid ();
636 #endif /* Have setregid. */
637 #endif /* Have setegid. */
638 #endif /* No <unistd.h>. */
640 /* Keep track of the user and group IDs for user- and make- access. */
641 static int user_uid
= -1, user_gid
= -1, make_uid
= -1, make_gid
= -1;
642 #define access_inited (user_uid != -1)
643 static enum { make
, user
} current_access
;
646 /* Under -d, write a message describing the current IDs. */
649 log_access (const char *flavor
)
651 if (! ISDB (DB_JOBS
))
654 /* All the other debugging messages go to stdout,
655 but we write this one to stderr because it might be
656 run in a child fork whose stdout is piped. */
658 fprintf (stderr
, _("%s: user %lu (real %lu), group %lu (real %lu)\n"),
659 flavor
, (unsigned long) geteuid (), (unsigned long) getuid (),
660 (unsigned long) getegid (), (unsigned long) getgid ());
669 user_uid
= getuid ();
670 user_gid
= getgid ();
672 make_uid
= geteuid ();
673 make_gid
= getegid ();
675 /* Do these ever fail? */
676 if (user_uid
== -1 || user_gid
== -1 || make_uid
== -1 || make_gid
== -1)
677 pfatal_with_name ("get{e}[gu]id");
679 log_access (_("Initialized access"));
681 current_access
= make
;
685 #endif /* GETLOADAVG_PRIVILEGED */
687 /* Give the process appropriate permissions for access to
688 user data (i.e., to stat files, or to spawn a child process). */
692 #ifdef GETLOADAVG_PRIVILEGED
697 if (current_access
== user
)
700 /* We are in "make access" mode. This means that the effective user and
701 group IDs are those of make (if it was installed setuid or setgid).
702 We now want to set the effective user and group IDs to the real IDs,
703 which are the IDs of the process that exec'd make. */
707 /* Modern systems have the seteuid/setegid calls which set only the
708 effective IDs, which is ideal. */
710 if (seteuid (user_uid
) < 0)
711 pfatal_with_name ("user_access: seteuid");
713 #else /* Not HAVE_SETEUID. */
715 #ifndef HAVE_SETREUID
717 /* System V has only the setuid/setgid calls to set user/group IDs.
718 There is an effective ID, which can be set by setuid/setgid.
719 It can be set (unless you are root) only to either what it already is
720 (returned by geteuid/getegid, now in make_uid/make_gid),
721 the real ID (return by getuid/getgid, now in user_uid/user_gid),
722 or the saved set ID (what the effective ID was before this set-ID
723 executable (make) was exec'd). */
725 if (setuid (user_uid
) < 0)
726 pfatal_with_name ("user_access: setuid");
728 #else /* HAVE_SETREUID. */
730 /* In 4BSD, the setreuid/setregid calls set both the real and effective IDs.
731 They may be set to themselves or each other. So you have two alternatives
732 at any one time. If you use setuid/setgid, the effective will be set to
733 the real, leaving only one alternative. Using setreuid/setregid, however,
734 you can toggle between your two alternatives by swapping the values in a
735 single setreuid or setregid call. */
737 if (setreuid (make_uid
, user_uid
) < 0)
738 pfatal_with_name ("user_access: setreuid");
740 #endif /* Not HAVE_SETREUID. */
741 #endif /* HAVE_SETEUID. */
744 if (setegid (user_gid
) < 0)
745 pfatal_with_name ("user_access: setegid");
747 #ifndef HAVE_SETREGID
748 if (setgid (user_gid
) < 0)
749 pfatal_with_name ("user_access: setgid");
751 if (setregid (make_gid
, user_gid
) < 0)
752 pfatal_with_name ("user_access: setregid");
756 current_access
= user
;
758 log_access (_("User access"));
760 #endif /* GETLOADAVG_PRIVILEGED */
763 /* Give the process appropriate permissions for access to
764 make data (i.e., the load average). */
768 #ifdef GETLOADAVG_PRIVILEGED
773 if (current_access
== make
)
776 /* See comments in user_access, above. */
779 if (seteuid (make_uid
) < 0)
780 pfatal_with_name ("make_access: seteuid");
782 #ifndef HAVE_SETREUID
783 if (setuid (make_uid
) < 0)
784 pfatal_with_name ("make_access: setuid");
786 if (setreuid (user_uid
, make_uid
) < 0)
787 pfatal_with_name ("make_access: setreuid");
792 if (setegid (make_gid
) < 0)
793 pfatal_with_name ("make_access: setegid");
795 #ifndef HAVE_SETREGID
796 if (setgid (make_gid
) < 0)
797 pfatal_with_name ("make_access: setgid");
799 if (setregid (user_gid
, make_gid
) < 0)
800 pfatal_with_name ("make_access: setregid");
804 current_access
= make
;
806 log_access (_("Make access"));
808 #endif /* GETLOADAVG_PRIVILEGED */
811 /* Give the process appropriate permissions for a child process.
812 This is like user_access, but you can't get back to make_access. */
816 #ifdef GETLOADAVG_PRIVILEGED
821 /* Set both the real and effective UID and GID to the user's.
822 They cannot be changed back to make's. */
824 #ifndef HAVE_SETREUID
825 if (setuid (user_uid
) < 0)
826 pfatal_with_name ("child_access: setuid");
828 if (setreuid (user_uid
, user_uid
) < 0)
829 pfatal_with_name ("child_access: setreuid");
832 #ifndef HAVE_SETREGID
833 if (setgid (user_gid
) < 0)
834 pfatal_with_name ("child_access: setgid");
836 if (setregid (user_gid
, user_gid
) < 0)
837 pfatal_with_name ("child_access: setregid");
840 log_access (_("Child access"));
842 #endif /* GETLOADAVG_PRIVILEGED */
845 #ifdef NEED_GET_PATH_MAX
849 static unsigned int value
;
853 long int x
= pathconf ("/", _PC_PATH_MAX
);
865 /* This code is stolen from gnulib.
866 If/when we abandon the requirement to work with K&R compilers, we can
867 remove this (and perhaps other parts of GNU make!) and migrate to using
870 This is called only through atexit(), which means die() has already been
871 invoked. So, call exit() here directly. Apparently that works...?
874 /* Close standard output, exiting with status 'exit_failure' on failure.
875 If a program writes *anything* to stdout, that program should close
876 stdout and make sure that it succeeds before exiting. Otherwise,
877 suppose that you go to the extreme of checking the return status
878 of every function that does an explicit write to stdout. The last
879 printf can succeed in writing to the internal stream buffer, and yet
880 the fclose(stdout) could still fail (due e.g., to a disk full error)
881 when it tries to write out that buffered data. Thus, you would be
882 left with an incomplete output file and the offending program would
883 exit successfully. Even calling fflush is not always sufficient,
884 since some file systems (NFS and CODA) buffer written/flushed data
885 until an actual close call.
887 Besides, it's wasteful to check the return value from every call
888 that writes to stdout -- just let the internal stream state record
889 the failure. That's what the ferror test is checking below.
891 It's important to detect such failures and exit nonzero because many
892 tools (most notably `make' and other build-management systems) depend
893 on being able to detect failure in other tools via their exit status. */
898 int prev_fail
= ferror (stdout
);
899 int fclose_fail
= fclose (stdout
);
901 if (prev_fail
|| fclose_fail
)
904 error (NILF
, _("write error: %s"), strerror (errno
));
906 error (NILF
, _("write error"));