1 /* Miscellaneous generic support functions for GNU Make.
2 Copyright (C) 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1997,
3 2002 Free Software Foundation, Inc.
4 This file is part of GNU Make.
6 GNU Make is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
11 GNU Make is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Make; see the file COPYING. If not, write to
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA. */
25 /* Variadic functions. We go through contortions to allow proper function
26 prototypes for both ANSI and pre-ANSI C compilers, and also for those
27 which support stdarg.h vs. varargs.h, and finally those which have
28 vfprintf(), etc. and those who have _doprnt... or nothing.
30 This fancy stuff all came from GNU fileutils, except for the VA_PRINTF and
31 VA_END macros used here since we have multiple print functions. */
36 # define VA_START(args, lastarg) va_start(args, lastarg)
39 # define VA_START(args, lastarg) va_start(args)
42 # define VA_PRINTF(fp, lastarg, args) vfprintf((fp), (lastarg), (args))
44 # define VA_PRINTF(fp, lastarg, args) _doprnt((lastarg), (args), (fp))
46 # define VA_END(args) va_end(args)
48 /* We can't use any variadic interface! */
49 # define va_alist a1, a2, a3, a4, a5, a6, a7, a8
50 # define va_dcl char *a1, *a2, *a3, *a4, *a5, *a6, *a7, *a8;
51 # define VA_START(args, lastarg)
52 # define VA_PRINTF(fp, lastarg, args) fprintf((fp), (lastarg), va_alist)
57 /* Compare strings *S1 and *S2.
58 Return negative if the first is less, positive if it is greater,
59 zero if they are equal. */
62 alpha_compare (const void *v1
, const void *v2
)
64 const char *s1
= *((char **)v1
);
65 const char *s2
= *((char **)v2
);
69 return strcmp (s1
, s2
);
72 /* Discard each backslash-newline combination from LINE.
73 Backslash-backslash-newline combinations become backslash-newlines.
74 This is done by copying the text at LINE into itself. */
77 collapse_continuations (char *line
)
79 register char *in
, *out
, *p
;
80 register int backslash
;
81 register unsigned int bs_write
;
83 in
= strchr (line
, '\n');
88 while (out
> line
&& out
[-1] == '\\')
93 /* BS_WRITE gets the number of quoted backslashes at
94 the end just before IN, and BACKSLASH gets nonzero
95 if the next character is quoted. */
98 for (p
= in
- 1; p
>= line
&& *p
== '\\'; --p
)
102 backslash
= !backslash
;
104 /* It should be impossible to go back this far without exiting,
105 but if we do, we can't get the right answer. */
110 /* Output the appropriate number of backslashes. */
111 while (bs_write
-- > 0)
114 /* Skip the newline. */
117 /* If the newline is quoted, discard following whitespace
118 and any preceding whitespace; leave just one space. */
121 in
= next_token (in
);
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 newly-allocated string whose contents
164 concatenate those of s1, s2, s3. */
167 concat (const char *s1
, const char *s2
, const char *s3
)
169 unsigned int len1
, len2
, len3
;
172 len1
= *s1
!= '\0' ? strlen (s1
) : 0;
173 len2
= *s2
!= '\0' ? strlen (s2
) : 0;
174 len3
= *s3
!= '\0' ? strlen (s3
) : 0;
176 result
= (char *) xmalloc (len1
+ len2
+ len3
+ 1);
179 bcopy (s1
, result
, len1
);
181 bcopy (s2
, result
+ len1
, len2
);
183 bcopy (s3
, result
+ len1
+ len2
, len3
);
184 *(result
+ len1
+ len2
+ len3
) = '\0';
189 /* Print a message on stdout. */
192 #if HAVE_ANSI_COMPILER && USE_VARIADIC && HAVE_STDARG_H
193 message (int prefix
, const char *fmt
, ...)
195 message (prefix
, fmt
, va_alist
)
205 log_working_directory (1);
212 printf ("%s: ", program
);
214 printf ("%s[%u]: ", program
, makelevel
);
216 VA_START (args
, fmt
);
217 VA_PRINTF (stdout
, fmt
, args
);
225 /* Print an error message. */
228 #if HAVE_ANSI_COMPILER && USE_VARIADIC && HAVE_STDARG_H
229 error (const struct floc
*flocp
, const char *fmt
, ...)
231 error (flocp
, fmt
, va_alist
)
232 const struct floc
*flocp
;
241 log_working_directory (1);
243 if (flocp
&& flocp
->filenm
)
244 fprintf (stderr
, "%s:%lu: ", flocp
->filenm
, flocp
->lineno
);
245 else if (makelevel
== 0)
246 fprintf (stderr
, "%s: ", program
);
248 fprintf (stderr
, "%s[%u]: ", program
, makelevel
);
251 VA_PRINTF (stderr
, fmt
, args
);
258 /* Print an error message and exit. */
261 #if HAVE_ANSI_COMPILER && USE_VARIADIC && HAVE_STDARG_H
262 fatal (const struct floc
*flocp
, const char *fmt
, ...)
264 fatal (flocp
, fmt
, va_alist
)
265 const struct floc
*flocp
;
274 log_working_directory (1);
276 if (flocp
&& flocp
->filenm
)
277 fprintf (stderr
, "%s:%lu: *** ", flocp
->filenm
, flocp
->lineno
);
278 else if (makelevel
== 0)
279 fprintf (stderr
, "%s: *** ", program
);
281 fprintf (stderr
, "%s[%u]: *** ", program
, makelevel
);
284 VA_PRINTF (stderr
, fmt
, args
);
287 fputs (_(". Stop.\n"), stderr
);
292 #ifndef HAVE_STRERROR
297 strerror (int errnum
)
299 extern int errno
, sys_nerr
;
301 extern char *sys_errlist
[];
303 static char buf
[] = "Unknown error 12345678901234567890";
305 if (errno
< sys_nerr
)
306 return sys_errlist
[errnum
];
308 sprintf (buf
, _("Unknown error %d"), errnum
);
313 /* Print an error message from errno. */
316 perror_with_name (const char *str
, const char *name
)
318 error (NILF
, _("%s%s: %s"), str
, name
, strerror (errno
));
321 /* Print an error message from errno and exit. */
324 pfatal_with_name (const char *name
)
326 fatal (NILF
, _("%s: %s"), name
, strerror (errno
));
331 /* Like malloc but get fatal error if memory is exhausted. */
332 /* Don't bother if we're using dmalloc; it provides these for us. */
334 #ifndef HAVE_DMALLOC_H
341 xmalloc (unsigned int size
)
343 /* Make sure we don't allocate 0, for pre-ANSI libraries. */
344 char *result
= (char *) malloc (size
? size
: 1);
346 fatal (NILF
, _("virtual memory exhausted"));
352 xrealloc (char *ptr
, unsigned int size
)
356 /* Some older implementations of realloc() don't conform to ANSI. */
359 result
= ptr
? realloc (ptr
, size
) : malloc (size
);
361 fatal (NILF
, _("virtual memory exhausted"));
367 xstrdup (const char *ptr
)
372 result
= strdup (ptr
);
374 result
= (char *) malloc (strlen (ptr
) + 1);
378 fatal (NILF
, _("virtual memory exhausted"));
383 return strcpy(result
, ptr
);
387 #endif /* HAVE_DMALLOC_H */
390 savestring (const char *str
, unsigned int length
)
392 register char *out
= (char *) xmalloc (length
+ 1);
394 bcopy (str
, out
, length
);
401 Search through the string STRING, which ends at LIMIT, for the character C.
402 Returns a pointer to the first occurrence, or nil if none is found.
403 Like INDEX except that the string searched ends where specified
404 instead of at the first null. */
407 lindex (const char *s
, const char *limit
, int c
)
411 return (char *)(s
- 1);
416 /* Return the address of the first whitespace or null in the string S. */
419 end_of_token (const char *s
)
421 while (*s
!= '\0' && !isblank ((unsigned char)*s
))
428 * Same as end_of_token, but take into account a stop character
431 end_of_token_w32 (char *s
, char stopchar
)
433 register char *p
= s
;
434 register int backslash
= 0;
436 while (*p
!= '\0' && *p
!= stopchar
437 && (backslash
|| !isblank ((unsigned char)*p
)))
441 backslash
= !backslash
;
444 backslash
= !backslash
;
456 /* Return the address of the first nonwhitespace or null in the string S. */
459 next_token (const char *s
)
461 while (isblank ((unsigned char)*s
))
466 /* Find the next token in PTR; return the address of it, and store the
467 length of the token into *LENGTHPTR if LENGTHPTR is not nil. */
470 find_next_token (char **ptr
, unsigned int *lengthptr
)
472 char *p
= next_token (*ptr
);
478 *ptr
= end
= end_of_token (p
);
480 *lengthptr
= end
- p
;
484 /* Copy a chain of `struct dep', making a new chain
485 with the same contents as the old one. */
488 copy_dep_chain (struct dep
*d
)
490 register struct dep
*c
;
491 struct dep
*firstnew
= 0;
492 struct dep
*lastnew
= 0;
496 c
= (struct dep
*) xmalloc (sizeof (struct dep
));
497 bcopy ((char *) d
, (char *) c
, sizeof (struct dep
));
499 c
->name
= xstrdup (c
->name
);
502 firstnew
= lastnew
= c
;
504 lastnew
= lastnew
->next
= c
;
512 /* Free a chain of `struct nameseq'. Each nameseq->name is freed
513 as well. Can be used on `struct dep' chains.*/
516 free_ns_chain (struct nameseq
*n
)
518 register struct nameseq
*tmp
;
534 /* The losing compiler on this machine can't handle this macro. */
537 dep_name (struct dep
*dep
)
539 return dep
->name
== 0 ? dep
->file
->name
: dep
->name
;
543 #ifdef GETLOADAVG_PRIVILEGED
547 /* Hopefully if a system says it's POSIX.1 and has the setuid and setgid
548 functions, they work as POSIX.1 says. Some systems (Alpha OSF/1 1.2,
549 for example) which claim to be POSIX.1 also have the BSD setreuid and
550 setregid functions, but they don't work as in BSD and only the POSIX.1
556 #else /* Not POSIX. */
558 /* Some POSIX.1 systems have the seteuid and setegid functions. In a
559 POSIX-like system, they are the best thing to use. However, some
560 non-POSIX systems have them too but they do not work in the POSIX style
561 and we must use setreuid and setregid instead. */
568 #ifndef HAVE_UNISTD_H
569 extern int getuid (), getgid (), geteuid (), getegid ();
570 extern int setuid (), setgid ();
572 extern int seteuid ();
575 extern int setreuid ();
576 #endif /* Have setreuid. */
577 #endif /* Have seteuid. */
579 extern int setegid ();
582 extern int setregid ();
583 #endif /* Have setregid. */
584 #endif /* Have setegid. */
585 #endif /* No <unistd.h>. */
587 /* Keep track of the user and group IDs for user- and make- access. */
588 static int user_uid
= -1, user_gid
= -1, make_uid
= -1, make_gid
= -1;
589 #define access_inited (user_uid != -1)
590 static enum { make
, user
} current_access
;
593 /* Under -d, write a message describing the current IDs. */
596 log_access (char *flavor
)
598 if (! ISDB (DB_JOBS
))
601 /* All the other debugging messages go to stdout,
602 but we write this one to stderr because it might be
603 run in a child fork whose stdout is piped. */
605 fprintf (stderr
, _("%s: user %lu (real %lu), group %lu (real %lu)\n"),
606 flavor
, (unsigned long) geteuid (), (unsigned long) getuid (),
607 (unsigned long) getegid (), (unsigned long) getgid ());
616 user_uid
= getuid ();
617 user_gid
= getgid ();
619 make_uid
= geteuid ();
620 make_gid
= getegid ();
622 /* Do these ever fail? */
623 if (user_uid
== -1 || user_gid
== -1 || make_uid
== -1 || make_gid
== -1)
624 pfatal_with_name ("get{e}[gu]id");
626 log_access (_("Initialized access"));
628 current_access
= make
;
632 #endif /* GETLOADAVG_PRIVILEGED */
634 /* Give the process appropriate permissions for access to
635 user data (i.e., to stat files, or to spawn a child process). */
639 #ifdef GETLOADAVG_PRIVILEGED
644 if (current_access
== user
)
647 /* We are in "make access" mode. This means that the effective user and
648 group IDs are those of make (if it was installed setuid or setgid).
649 We now want to set the effective user and group IDs to the real IDs,
650 which are the IDs of the process that exec'd make. */
654 /* Modern systems have the seteuid/setegid calls which set only the
655 effective IDs, which is ideal. */
657 if (seteuid (user_uid
) < 0)
658 pfatal_with_name ("user_access: seteuid");
660 #else /* Not HAVE_SETEUID. */
662 #ifndef HAVE_SETREUID
664 /* System V has only the setuid/setgid calls to set user/group IDs.
665 There is an effective ID, which can be set by setuid/setgid.
666 It can be set (unless you are root) only to either what it already is
667 (returned by geteuid/getegid, now in make_uid/make_gid),
668 the real ID (return by getuid/getgid, now in user_uid/user_gid),
669 or the saved set ID (what the effective ID was before this set-ID
670 executable (make) was exec'd). */
672 if (setuid (user_uid
) < 0)
673 pfatal_with_name ("user_access: setuid");
675 #else /* HAVE_SETREUID. */
677 /* In 4BSD, the setreuid/setregid calls set both the real and effective IDs.
678 They may be set to themselves or each other. So you have two alternatives
679 at any one time. If you use setuid/setgid, the effective will be set to
680 the real, leaving only one alternative. Using setreuid/setregid, however,
681 you can toggle between your two alternatives by swapping the values in a
682 single setreuid or setregid call. */
684 if (setreuid (make_uid
, user_uid
) < 0)
685 pfatal_with_name ("user_access: setreuid");
687 #endif /* Not HAVE_SETREUID. */
688 #endif /* HAVE_SETEUID. */
691 if (setegid (user_gid
) < 0)
692 pfatal_with_name ("user_access: setegid");
694 #ifndef HAVE_SETREGID
695 if (setgid (user_gid
) < 0)
696 pfatal_with_name ("user_access: setgid");
698 if (setregid (make_gid
, user_gid
) < 0)
699 pfatal_with_name ("user_access: setregid");
703 current_access
= user
;
705 log_access (_("User access"));
707 #endif /* GETLOADAVG_PRIVILEGED */
710 /* Give the process appropriate permissions for access to
711 make data (i.e., the load average). */
715 #ifdef GETLOADAVG_PRIVILEGED
720 if (current_access
== make
)
723 /* See comments in user_access, above. */
726 if (seteuid (make_uid
) < 0)
727 pfatal_with_name ("make_access: seteuid");
729 #ifndef HAVE_SETREUID
730 if (setuid (make_uid
) < 0)
731 pfatal_with_name ("make_access: setuid");
733 if (setreuid (user_uid
, make_uid
) < 0)
734 pfatal_with_name ("make_access: setreuid");
739 if (setegid (make_gid
) < 0)
740 pfatal_with_name ("make_access: setegid");
742 #ifndef HAVE_SETREGID
743 if (setgid (make_gid
) < 0)
744 pfatal_with_name ("make_access: setgid");
746 if (setregid (user_gid
, make_gid
) < 0)
747 pfatal_with_name ("make_access: setregid");
751 current_access
= make
;
753 log_access (_("Make access"));
755 #endif /* GETLOADAVG_PRIVILEGED */
758 /* Give the process appropriate permissions for a child process.
759 This is like user_access, but you can't get back to make_access. */
763 #ifdef GETLOADAVG_PRIVILEGED
768 /* Set both the real and effective UID and GID to the user's.
769 They cannot be changed back to make's. */
771 #ifndef HAVE_SETREUID
772 if (setuid (user_uid
) < 0)
773 pfatal_with_name ("child_access: setuid");
775 if (setreuid (user_uid
, user_uid
) < 0)
776 pfatal_with_name ("child_access: setreuid");
779 #ifndef HAVE_SETREGID
780 if (setgid (user_gid
) < 0)
781 pfatal_with_name ("child_access: setgid");
783 if (setregid (user_gid
, user_gid
) < 0)
784 pfatal_with_name ("child_access: setregid");
787 log_access (_("Child access"));
789 #endif /* GETLOADAVG_PRIVILEGED */
792 #ifdef NEED_GET_PATH_MAX
796 static unsigned int value
;
800 long int x
= pathconf ("/", _PC_PATH_MAX
);
812 /* This code is stolen from gnulib.
813 If/when we abandon the requirement to work with K&R compilers, we can
814 remove this (and perhaps other parts of GNU make!) and migrate to using
817 This is called only through atexit(), which means die() has already been
818 invoked. So, call exit() here directly. Apparently that works...?
821 /* Close standard output, exiting with status 'exit_failure' on failure.
822 If a program writes *anything* to stdout, that program should close
823 stdout and make sure that it succeeds before exiting. Otherwise,
824 suppose that you go to the extreme of checking the return status
825 of every function that does an explicit write to stdout. The last
826 printf can succeed in writing to the internal stream buffer, and yet
827 the fclose(stdout) could still fail (due e.g., to a disk full error)
828 when it tries to write out that buffered data. Thus, you would be
829 left with an incomplete output file and the offending program would
830 exit successfully. Even calling fflush is not always sufficient,
831 since some file systems (NFS and CODA) buffer written/flushed data
832 until an actual close call.
834 Besides, it's wasteful to check the return value from every call
835 that writes to stdout -- just let the internal stream state record
836 the failure. That's what the ferror test is checking below.
838 It's important to detect such failures and exit nonzero because many
839 tools (most notably `make' and other build-management systems) depend
840 on being able to detect failure in other tools via their exit status. */
845 int prev_fail
= ferror (stdout
);
846 int fclose_fail
= fclose (stdout
);
848 if (prev_fail
|| fclose_fail
)
851 error (NILF
, _("write error: %s"), strerror (errno
));
853 error (NILF
, _("write error"));