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 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 2, or (at your option) any later version.
11 GNU Make is distributed in the hope that it will be useful, but WITHOUT ANY
12 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13 A PARTICULAR PURPOSE. See the GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License along with
16 GNU Make; see the file COPYING. If not, write to the Free Software
17 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. */
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 quoted, discard following whitespace
116 and any preceding whitespace; leave just one space. */
119 in
= next_token (in
);
120 while (out
> line
&& isblank ((unsigned char)out
[-1]))
125 /* If the newline isn't quoted, put it in the output. */
128 /* Now copy the following line to the output.
129 Stop when we find backslashes followed by a newline. */
151 /* Print N spaces (used in debug for target-depth). */
154 print_spaces (unsigned int n
)
161 /* Return a newly-allocated string whose contents
162 concatenate those of s1, s2, s3. */
165 concat (const char *s1
, const char *s2
, const char *s3
)
167 unsigned int len1
, len2
, len3
;
170 len1
= *s1
!= '\0' ? strlen (s1
) : 0;
171 len2
= *s2
!= '\0' ? strlen (s2
) : 0;
172 len3
= *s3
!= '\0' ? strlen (s3
) : 0;
174 result
= (char *) xmalloc (len1
+ len2
+ len3
+ 1);
177 bcopy (s1
, result
, len1
);
179 bcopy (s2
, result
+ len1
, len2
);
181 bcopy (s3
, result
+ len1
+ len2
, len3
);
182 *(result
+ len1
+ len2
+ len3
) = '\0';
187 /* Print a message on stdout. */
190 #if HAVE_ANSI_COMPILER && USE_VARIADIC && HAVE_STDARG_H
191 message (int prefix
, const char *fmt
, ...)
193 message (prefix
, fmt
, va_alist
)
203 log_working_directory (1);
210 printf ("%s: ", program
);
212 printf ("%s[%u]: ", program
, makelevel
);
214 VA_START (args
, fmt
);
215 VA_PRINTF (stdout
, fmt
, args
);
223 /* Print an error message. */
226 #if HAVE_ANSI_COMPILER && USE_VARIADIC && HAVE_STDARG_H
227 error (const struct floc
*flocp
, const char *fmt
, ...)
229 error (flocp
, fmt
, va_alist
)
230 const struct floc
*flocp
;
239 log_working_directory (1);
241 if (flocp
&& flocp
->filenm
)
242 fprintf (stderr
, "%s:%lu: ", flocp
->filenm
, flocp
->lineno
);
243 else if (makelevel
== 0)
244 fprintf (stderr
, "%s: ", program
);
246 fprintf (stderr
, "%s[%u]: ", program
, makelevel
);
249 VA_PRINTF (stderr
, fmt
, args
);
256 /* Print an error message and exit. */
259 #if HAVE_ANSI_COMPILER && USE_VARIADIC && HAVE_STDARG_H
260 fatal (const struct floc
*flocp
, const char *fmt
, ...)
262 fatal (flocp
, fmt
, va_alist
)
263 const struct floc
*flocp
;
272 log_working_directory (1);
274 if (flocp
&& flocp
->filenm
)
275 fprintf (stderr
, "%s:%lu: *** ", flocp
->filenm
, flocp
->lineno
);
276 else if (makelevel
== 0)
277 fprintf (stderr
, "%s: *** ", program
);
279 fprintf (stderr
, "%s[%u]: *** ", program
, makelevel
);
282 VA_PRINTF (stderr
, fmt
, args
);
285 fputs (_(". Stop.\n"), stderr
);
290 #ifndef HAVE_STRERROR
295 strerror (int errnum
)
297 extern int errno
, sys_nerr
;
299 extern char *sys_errlist
[];
301 static char buf
[] = "Unknown error 12345678901234567890";
303 if (errno
< sys_nerr
)
304 return sys_errlist
[errnum
];
306 sprintf (buf
, _("Unknown error %d"), errnum
);
311 /* Print an error message from errno. */
314 perror_with_name (const char *str
, const char *name
)
316 error (NILF
, _("%s%s: %s"), str
, name
, strerror (errno
));
319 /* Print an error message from errno and exit. */
322 pfatal_with_name (const char *name
)
324 fatal (NILF
, _("%s: %s"), name
, strerror (errno
));
329 /* Like malloc but get fatal error if memory is exhausted. */
330 /* Don't bother if we're using dmalloc; it provides these for us. */
332 #ifndef HAVE_DMALLOC_H
339 xmalloc (unsigned int size
)
341 /* Make sure we don't allocate 0, for pre-ANSI libraries. */
342 char *result
= (char *) malloc (size
? size
: 1);
344 fatal (NILF
, _("virtual memory exhausted"));
350 xrealloc (char *ptr
, unsigned int size
)
354 /* Some older implementations of realloc() don't conform to ANSI. */
357 result
= ptr
? realloc (ptr
, size
) : malloc (size
);
359 fatal (NILF
, _("virtual memory exhausted"));
365 xstrdup (const char *ptr
)
370 result
= strdup (ptr
);
372 result
= (char *) malloc (strlen (ptr
) + 1);
376 fatal (NILF
, _("virtual memory exhausted"));
381 return strcpy(result
, ptr
);
385 #endif /* HAVE_DMALLOC_H */
388 savestring (const char *str
, unsigned int length
)
390 register char *out
= (char *) xmalloc (length
+ 1);
392 bcopy (str
, out
, length
);
399 Search through the string STRING, which ends at LIMIT, for the character C.
400 Returns a pointer to the first occurrence, or nil if none is found.
401 Like INDEX except that the string searched ends where specified
402 instead of at the first null. */
405 lindex (const char *s
, const char *limit
, int c
)
409 return (char *)(s
- 1);
414 /* Return the address of the first whitespace or null in the string S. */
417 end_of_token (const char *s
)
419 while (*s
!= '\0' && !isblank ((unsigned char)*s
))
426 * Same as end_of_token, but take into account a stop character
429 end_of_token_w32 (char *s
, char stopchar
)
431 register char *p
= s
;
432 register int backslash
= 0;
434 while (*p
!= '\0' && *p
!= stopchar
435 && (backslash
|| !isblank ((unsigned char)*p
)))
439 backslash
= !backslash
;
442 backslash
= !backslash
;
454 /* Return the address of the first nonwhitespace or null in the string S. */
457 next_token (const char *s
)
459 while (isblank ((unsigned char)*s
))
464 /* Find the next token in PTR; return the address of it, and store the
465 length of the token into *LENGTHPTR if LENGTHPTR is not nil. */
468 find_next_token (char **ptr
, unsigned int *lengthptr
)
470 char *p
= next_token (*ptr
);
476 *ptr
= end
= end_of_token (p
);
478 *lengthptr
= end
- p
;
483 /* Allocate a new `struct dep' with all fields initialized to 0. */
488 struct dep
*d
= (struct dep
*) xmalloc (sizeof (struct dep
));
489 bzero ((char *) d
, sizeof (struct dep
));
494 /* Free `struct dep' along with `name' and `stem'. */
497 free_dep (struct dep
*d
)
508 /* Copy a chain of `struct dep', making a new chain
509 with the same contents as the old one. */
512 copy_dep_chain (const struct dep
*d
)
514 register struct dep
*c
;
515 struct dep
*firstnew
= 0;
516 struct dep
*lastnew
= 0;
520 c
= (struct dep
*) xmalloc (sizeof (struct dep
));
521 bcopy ((char *) d
, (char *) c
, sizeof (struct dep
));
524 c
->name
= xstrdup (c
->name
);
526 c
->stem
= xstrdup (c
->stem
);
530 firstnew
= lastnew
= c
;
532 lastnew
= lastnew
->next
= c
;
540 /* Free a chain of 'struct dep'. */
543 free_dep_chain (struct dep
*d
)
553 /* Free a chain of `struct nameseq'. Each nameseq->name is freed
554 as well. For `struct dep' chains use free_dep_chain. */
557 free_ns_chain (struct nameseq
*n
)
559 register struct nameseq
*tmp
;
575 /* The losing compiler on this machine can't handle this macro. */
578 dep_name (struct dep
*dep
)
580 return dep
->name
== 0 ? dep
->file
->name
: dep
->name
;
584 #ifdef GETLOADAVG_PRIVILEGED
588 /* Hopefully if a system says it's POSIX.1 and has the setuid and setgid
589 functions, they work as POSIX.1 says. Some systems (Alpha OSF/1 1.2,
590 for example) which claim to be POSIX.1 also have the BSD setreuid and
591 setregid functions, but they don't work as in BSD and only the POSIX.1
597 #else /* Not POSIX. */
599 /* Some POSIX.1 systems have the seteuid and setegid functions. In a
600 POSIX-like system, they are the best thing to use. However, some
601 non-POSIX systems have them too but they do not work in the POSIX style
602 and we must use setreuid and setregid instead. */
609 #ifndef HAVE_UNISTD_H
610 extern int getuid (), getgid (), geteuid (), getegid ();
611 extern int setuid (), setgid ();
613 extern int seteuid ();
616 extern int setreuid ();
617 #endif /* Have setreuid. */
618 #endif /* Have seteuid. */
620 extern int setegid ();
623 extern int setregid ();
624 #endif /* Have setregid. */
625 #endif /* Have setegid. */
626 #endif /* No <unistd.h>. */
628 /* Keep track of the user and group IDs for user- and make- access. */
629 static int user_uid
= -1, user_gid
= -1, make_uid
= -1, make_gid
= -1;
630 #define access_inited (user_uid != -1)
631 static enum { make
, user
} current_access
;
634 /* Under -d, write a message describing the current IDs. */
637 log_access (const char *flavor
)
639 if (! ISDB (DB_JOBS
))
642 /* All the other debugging messages go to stdout,
643 but we write this one to stderr because it might be
644 run in a child fork whose stdout is piped. */
646 fprintf (stderr
, _("%s: user %lu (real %lu), group %lu (real %lu)\n"),
647 flavor
, (unsigned long) geteuid (), (unsigned long) getuid (),
648 (unsigned long) getegid (), (unsigned long) getgid ());
657 user_uid
= getuid ();
658 user_gid
= getgid ();
660 make_uid
= geteuid ();
661 make_gid
= getegid ();
663 /* Do these ever fail? */
664 if (user_uid
== -1 || user_gid
== -1 || make_uid
== -1 || make_gid
== -1)
665 pfatal_with_name ("get{e}[gu]id");
667 log_access (_("Initialized access"));
669 current_access
= make
;
673 #endif /* GETLOADAVG_PRIVILEGED */
675 /* Give the process appropriate permissions for access to
676 user data (i.e., to stat files, or to spawn a child process). */
680 #ifdef GETLOADAVG_PRIVILEGED
685 if (current_access
== user
)
688 /* We are in "make access" mode. This means that the effective user and
689 group IDs are those of make (if it was installed setuid or setgid).
690 We now want to set the effective user and group IDs to the real IDs,
691 which are the IDs of the process that exec'd make. */
695 /* Modern systems have the seteuid/setegid calls which set only the
696 effective IDs, which is ideal. */
698 if (seteuid (user_uid
) < 0)
699 pfatal_with_name ("user_access: seteuid");
701 #else /* Not HAVE_SETEUID. */
703 #ifndef HAVE_SETREUID
705 /* System V has only the setuid/setgid calls to set user/group IDs.
706 There is an effective ID, which can be set by setuid/setgid.
707 It can be set (unless you are root) only to either what it already is
708 (returned by geteuid/getegid, now in make_uid/make_gid),
709 the real ID (return by getuid/getgid, now in user_uid/user_gid),
710 or the saved set ID (what the effective ID was before this set-ID
711 executable (make) was exec'd). */
713 if (setuid (user_uid
) < 0)
714 pfatal_with_name ("user_access: setuid");
716 #else /* HAVE_SETREUID. */
718 /* In 4BSD, the setreuid/setregid calls set both the real and effective IDs.
719 They may be set to themselves or each other. So you have two alternatives
720 at any one time. If you use setuid/setgid, the effective will be set to
721 the real, leaving only one alternative. Using setreuid/setregid, however,
722 you can toggle between your two alternatives by swapping the values in a
723 single setreuid or setregid call. */
725 if (setreuid (make_uid
, user_uid
) < 0)
726 pfatal_with_name ("user_access: setreuid");
728 #endif /* Not HAVE_SETREUID. */
729 #endif /* HAVE_SETEUID. */
732 if (setegid (user_gid
) < 0)
733 pfatal_with_name ("user_access: setegid");
735 #ifndef HAVE_SETREGID
736 if (setgid (user_gid
) < 0)
737 pfatal_with_name ("user_access: setgid");
739 if (setregid (make_gid
, user_gid
) < 0)
740 pfatal_with_name ("user_access: setregid");
744 current_access
= user
;
746 log_access (_("User access"));
748 #endif /* GETLOADAVG_PRIVILEGED */
751 /* Give the process appropriate permissions for access to
752 make data (i.e., the load average). */
756 #ifdef GETLOADAVG_PRIVILEGED
761 if (current_access
== make
)
764 /* See comments in user_access, above. */
767 if (seteuid (make_uid
) < 0)
768 pfatal_with_name ("make_access: seteuid");
770 #ifndef HAVE_SETREUID
771 if (setuid (make_uid
) < 0)
772 pfatal_with_name ("make_access: setuid");
774 if (setreuid (user_uid
, make_uid
) < 0)
775 pfatal_with_name ("make_access: setreuid");
780 if (setegid (make_gid
) < 0)
781 pfatal_with_name ("make_access: setegid");
783 #ifndef HAVE_SETREGID
784 if (setgid (make_gid
) < 0)
785 pfatal_with_name ("make_access: setgid");
787 if (setregid (user_gid
, make_gid
) < 0)
788 pfatal_with_name ("make_access: setregid");
792 current_access
= make
;
794 log_access (_("Make access"));
796 #endif /* GETLOADAVG_PRIVILEGED */
799 /* Give the process appropriate permissions for a child process.
800 This is like user_access, but you can't get back to make_access. */
804 #ifdef GETLOADAVG_PRIVILEGED
809 /* Set both the real and effective UID and GID to the user's.
810 They cannot be changed back to make's. */
812 #ifndef HAVE_SETREUID
813 if (setuid (user_uid
) < 0)
814 pfatal_with_name ("child_access: setuid");
816 if (setreuid (user_uid
, user_uid
) < 0)
817 pfatal_with_name ("child_access: setreuid");
820 #ifndef HAVE_SETREGID
821 if (setgid (user_gid
) < 0)
822 pfatal_with_name ("child_access: setgid");
824 if (setregid (user_gid
, user_gid
) < 0)
825 pfatal_with_name ("child_access: setregid");
828 log_access (_("Child access"));
830 #endif /* GETLOADAVG_PRIVILEGED */
833 #ifdef NEED_GET_PATH_MAX
837 static unsigned int value
;
841 long int x
= pathconf ("/", _PC_PATH_MAX
);
853 /* This code is stolen from gnulib.
854 If/when we abandon the requirement to work with K&R compilers, we can
855 remove this (and perhaps other parts of GNU make!) and migrate to using
858 This is called only through atexit(), which means die() has already been
859 invoked. So, call exit() here directly. Apparently that works...?
862 /* Close standard output, exiting with status 'exit_failure' on failure.
863 If a program writes *anything* to stdout, that program should close
864 stdout and make sure that it succeeds before exiting. Otherwise,
865 suppose that you go to the extreme of checking the return status
866 of every function that does an explicit write to stdout. The last
867 printf can succeed in writing to the internal stream buffer, and yet
868 the fclose(stdout) could still fail (due e.g., to a disk full error)
869 when it tries to write out that buffered data. Thus, you would be
870 left with an incomplete output file and the offending program would
871 exit successfully. Even calling fflush is not always sufficient,
872 since some file systems (NFS and CODA) buffer written/flushed data
873 until an actual close call.
875 Besides, it's wasteful to check the return value from every call
876 that writes to stdout -- just let the internal stream state record
877 the failure. That's what the ferror test is checking below.
879 It's important to detect such failures and exit nonzero because many
880 tools (most notably `make' and other build-management systems) depend
881 on being able to detect failure in other tools via their exit status. */
886 int prev_fail
= ferror (stdout
);
887 int fclose_fail
= fclose (stdout
);
889 if (prev_fail
|| fclose_fail
)
892 error (NILF
, _("write error: %s"), strerror (errno
));
894 error (NILF
, _("write error"));