Formerly make.texinfo.~117~
[make.git] / misc.c
blobd841bb2b24c3a423a128d4eb0d3e23990a3e771a
1 /* Copyright (C) 1988, 1989, 1990, 1991, 1992, 1993 Free Software Foundation, Inc.
2 This file is part of GNU Make.
4 GNU Make is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2, or (at your option)
7 any later version.
9 GNU Make is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with GNU Make; see the file COPYING. If not, write to
16 the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
18 #include "make.h"
19 #include "dep.h"
22 /* Compare strings *S1 and *S2.
23 Return negative if the first is less, positive if it is greater,
24 zero if they are equal. */
26 int
27 alpha_compare (s1, s2)
28 char **s1, **s2;
30 if (**s1 != **s2)
31 return **s1 - **s2;
32 return strcmp (*s1, *s2);
35 /* Discard each backslash-newline combination from LINE.
36 Backslash-backslash-newline combinations become backslash-newlines.
37 This is done by copying the text at LINE into itself. */
39 void
40 collapse_continuations (line)
41 char *line;
43 register char *in, *out, *p;
44 register int backslash;
45 register unsigned int bs_write;
47 in = index (line, '\n');
48 if (in == 0)
49 return;
51 out = in;
52 if (out > line)
53 while (out[-1] == '\\')
54 --out;
56 while (*in != '\0')
58 /* BS_WRITE gets the number of quoted backslashes at
59 the end just before IN, and BACKSLASH gets nonzero
60 if the next character is quoted. */
61 backslash = 0;
62 bs_write = 0;
63 for (p = in - 1; p >= line && *p == '\\'; --p)
65 if (backslash)
66 ++bs_write;
67 backslash = !backslash;
69 /* It should be impossible to go back this far without exiting,
70 but if we do, we can't get the right answer. */
71 if (in == out - 1)
72 abort ();
75 /* Output the appropriate number of backslashes. */
76 while (bs_write-- > 0)
77 *out++ = '\\';
79 /* Skip the newline. */
80 ++in;
82 /* If the newline is quoted, discard following whitespace
83 and any preceding whitespace; leave just one space. */
84 if (backslash)
86 in = next_token (in);
87 while (out > line && isblank (out[-1]))
88 --out;
89 *out++ = ' ';
91 else
92 /* If the newline isn't quoted, put it in the output. */
93 *out++ = '\n';
95 /* Now copy the following line to the output.
96 Stop when we find backslashes followed by a newline. */
97 while (*in != '\0')
98 if (*in == '\\')
100 p = in + 1;
101 while (*p == '\\')
102 ++p;
103 if (*p == '\n')
105 in = p;
106 break;
108 while (in < p)
109 *out++ = *in++;
111 else
112 *out++ = *in++;
115 *out = '\0';
119 /* Remove comments from LINE.
120 This is done by copying the text at LINE onto itself. */
122 void
123 remove_comments (line)
124 char *line;
126 register char *p, *p2;
127 register int backslash;
128 register unsigned int bs_write;
130 while (1)
132 p = index (line, '#');
133 if (p == 0)
134 break;
136 backslash = 0;
137 bs_write = 0;
138 for (p2 = p - 1; p2 >= line && *p2 == '\\'; --p2)
140 if (backslash)
141 ++bs_write;
142 backslash = !backslash;
145 if (!backslash)
147 /* Cut off the line at the #. */
148 *p = '\0';
149 break;
152 /* strcpy better copy left to right. */
153 line = p;
154 strcpy (p2 + 1 + bs_write, line);
158 /* Print N spaces (used by DEBUGPR for target-depth). */
160 void
161 print_spaces (n)
162 register unsigned int n;
164 while (n-- > 0)
165 putchar (' ');
169 /* Return a newly-allocated string whose contents
170 concatenate those of s1, s2, s3. */
172 char *
173 concat (s1, s2, s3)
174 register char *s1, *s2, *s3;
176 register unsigned int len1, len2, len3;
177 register char *result;
179 len1 = *s1 != '\0' ? strlen (s1) : 0;
180 len2 = *s2 != '\0' ? strlen (s2) : 0;
181 len3 = *s3 != '\0' ? strlen (s3) : 0;
183 result = (char *) xmalloc (len1 + len2 + len3 + 1);
185 if (*s1 != '\0')
186 bcopy (s1, result, len1);
187 if (*s2 != '\0')
188 bcopy (s2, result + len1, len2);
189 if (*s3 != '\0')
190 bcopy (s3, result + len1 + len2, len3);
191 *(result + len1 + len2 + len3) = '\0';
193 return result;
196 /* Print a message on stdout. */
198 void
199 message (s1, s2, s3, s4, s5, s6)
200 char *s1, *s2, *s3, *s4, *s5, *s6;
202 if (makelevel == 0)
203 printf ("%s: ", program);
204 else
205 printf ("%s[%u]: ", program, makelevel);
206 printf (s1, s2, s3, s4, s5, s6);
207 putchar ('\n');
208 fflush (stdout);
211 /* Print an error message and exit. */
213 /* VARARGS1 */
214 void
215 fatal (s1, s2, s3, s4, s5, s6)
216 char *s1, *s2, *s3, *s4, *s5, *s6;
218 if (makelevel == 0)
219 fprintf (stderr, "%s: *** ", program);
220 else
221 fprintf (stderr, "%s[%u]: *** ", program, makelevel);
222 fprintf (stderr, s1, s2, s3, s4, s5, s6);
223 fputs (". Stop.\n", stderr);
225 die (1);
228 /* Print error message. `s1' is printf control string, `s2' is arg for it. */
230 /* VARARGS1 */
232 void
233 error (s1, s2, s3, s4, s5, s6)
234 char *s1, *s2, *s3, *s4, *s5, *s6;
236 if (makelevel == 0)
237 fprintf (stderr, "%s: ", program);
238 else
239 fprintf (stderr, "%s[%u]: ", program, makelevel);
240 fprintf (stderr, s1, s2, s3, s4, s5, s6);
241 putc ('\n', stderr);
242 fflush (stderr);
245 void
246 makefile_error (file, lineno, s1, s2, s3, s4, s5, s6)
247 char *file;
248 unsigned int lineno;
249 char *s1, *s2, *s3, *s4, *s5, *s6;
251 fprintf (stderr, "%s:%u: ", file, lineno);
252 fprintf (stderr, s1, s2, s3, s4, s5, s6);
253 putc ('\n', stderr);
254 fflush (stderr);
257 void
258 makefile_fatal (file, lineno, s1, s2, s3, s4, s5, s6)
259 char *file;
260 unsigned int lineno;
261 char *s1, *s2, *s3, *s4, *s5, *s6;
263 fprintf (stderr, "%s:%u: *** ", file, lineno);
264 fprintf (stderr, s1, s2, s3, s4, s5, s6);
265 fputs (". Stop.\n", stderr);
267 die (1);
270 /* Print an error message from errno. */
272 void
273 perror_with_name (str, name)
274 char *str, *name;
276 extern int errno, sys_nerr;
277 extern char *sys_errlist[];
279 if (errno < sys_nerr)
280 error ("%s%s: %s", str, name, sys_errlist[errno]);
281 else
282 error ("%s%s: Unknown error %d", str, name, errno);
285 /* Print an error message from errno and exit. */
287 void
288 pfatal_with_name (name)
289 char *name;
291 extern int errno, sys_nerr;
292 extern char *sys_errlist[];
294 if (errno < sys_nerr)
295 fatal ("%s: %s", name, sys_errlist[errno]);
296 else
297 fatal ("%s: Unknown error %d", name, errno);
299 /* NOTREACHED */
302 /* Like malloc but get fatal error if memory is exhausted. */
304 #undef xmalloc
305 #undef xrealloc
307 char *
308 xmalloc (size)
309 unsigned int size;
311 char *result = (char *) malloc (size);
312 if (result == 0)
313 fatal ("virtual memory exhausted");
314 return result;
318 char *
319 xrealloc (ptr, size)
320 char *ptr;
321 unsigned int size;
323 char *result = (char *) realloc (ptr, size);
324 if (result == 0)
325 fatal ("virtual memory exhausted");
326 return result;
329 char *
330 savestring (str, length)
331 char *str;
332 unsigned int length;
334 register char *out = (char *) xmalloc (length + 1);
335 if (length > 0)
336 bcopy (str, out, length);
337 out[length] = '\0';
338 return out;
341 /* Search string BIG (length BLEN) for an occurrence of
342 string SMALL (length SLEN). Return a pointer to the
343 beginning of the first occurrence, or return nil if none found. */
345 char *
346 sindex (big, blen, small, slen)
347 char *big;
348 unsigned int blen;
349 char *small;
350 unsigned int slen;
352 register unsigned int b;
354 if (blen < 1)
355 blen = strlen (big);
356 if (slen < 1)
357 slen = strlen (small);
359 for (b = 0; b < blen; ++b)
360 if (big[b] == *small && !strncmp (&big[b + 1], small + 1, slen - 1))
361 return (&big[b]);
363 return 0;
366 /* Limited INDEX:
367 Search through the string STRING, which ends at LIMIT, for the character C.
368 Returns a pointer to the first occurrence, or nil if none is found.
369 Like INDEX except that the string searched ends where specified
370 instead of at the first null. */
372 char *
373 lindex (s, limit, c)
374 register char *s, *limit;
375 int c;
377 while (s < limit)
378 if (*s++ == c)
379 return s - 1;
381 return 0;
384 /* Return the address of the first whitespace or null in the string S. */
386 char *
387 end_of_token (s)
388 char *s;
390 register char *p = s;
391 register int backslash = 0;
393 while (*p != '\0' && (backslash || !isblank (*p)))
395 if (*p++ == '\\')
397 backslash = !backslash;
398 while (*p == '\\')
400 backslash = !backslash;
401 ++p;
404 else
405 backslash = 0;
408 return p;
411 /* Return the address of the first nonwhitespace or null in the string S. */
413 char *
414 next_token (s)
415 char *s;
417 register char *p = s;
419 while (isblank (*p))
420 ++p;
421 return p;
424 /* Find the next token in PTR; return the address of it, and store the
425 length of the token into *LENGTHPTR if LENGTHPTR is not nil. */
427 char *
428 find_next_token (ptr, lengthptr)
429 char **ptr;
430 unsigned int *lengthptr;
432 char *p = next_token (*ptr);
433 char *end;
435 if (*p == '\0')
436 return 0;
438 *ptr = end = end_of_token (p);
439 if (lengthptr != 0)
440 *lengthptr = end - p;
441 return p;
444 /* Copy a chain of `struct dep', making a new chain
445 with the same contents as the old one. */
447 struct dep *
448 copy_dep_chain (d)
449 register struct dep *d;
451 register struct dep *c;
452 struct dep *firstnew = 0;
453 struct dep *lastnew;
455 while (d != 0)
457 c = (struct dep *) xmalloc (sizeof (struct dep));
458 bcopy ((char *) d, (char *) c, sizeof (struct dep));
459 if (c->name != 0)
460 c->name = savestring (c->name, strlen (c->name));
461 c->next = 0;
462 if (firstnew == 0)
463 firstnew = lastnew = c;
464 else
465 lastnew = lastnew->next = c;
467 d = d->next;
470 return firstnew;
473 #ifdef iAPX286
474 /* The losing compiler on this machine can't handle this macro. */
476 char *
477 dep_name (dep)
478 struct dep *dep;
480 return dep->name == 0 ? dep->file->name : dep->name;
482 #endif
484 #ifdef GETLOADAVG_PRIVILEGED
486 #ifndef HAVE_UNISTD_H
487 extern int getuid (), getgid (), geteuid (), getegid ();
488 extern int setuid (), setgid ();
489 #ifdef HAVE_SETREUID
490 extern int setreuid ();
491 #endif /* Have setreuid. */
492 #ifdef HAVE_SETREGID
493 extern int setregid ();
494 #endif /* Have setregid. */
495 #endif /* No <unistd.h>. */
497 /* Keep track of the user and group IDs for user- and make- access. */
498 static int user_uid = -1, user_gid = -1, make_uid = -1, make_gid = -1;
499 #define access_inited (user_uid != -1)
500 static enum { make, user } current_access;
503 /* Under -d, write a message describing the current IDs. */
505 static void
506 log_access (flavor)
507 char *flavor;
509 if (! debug_flag)
510 return;
512 /* All the other debugging messages go to stdout,
513 but we write this one to stderr because it might be
514 run in a child fork whose stdout is piped. */
516 fprintf (stderr, "%s access: user %d (real %d), group %d (real %d)\n",
517 flavor, geteuid (), getuid (), getegid (), getgid ());
518 fflush (stderr);
522 static void
523 init_access ()
525 user_uid = getuid ();
526 user_gid = getgid ();
528 make_uid = geteuid ();
529 make_gid = getegid ();
531 /* Do these ever fail? */
532 if (user_uid == -1 || user_gid == -1 || make_uid == -1 || make_gid == -1)
533 pfatal_with_name ("get{e}[gu]id");
535 log_access ("Initialized");
537 current_access = make;
540 #endif /* GETLOADAVG_PRIVILEGED */
542 /* Give the process appropriate permissions for access to
543 user data (i.e., to stat files, or to spawn a child process). */
544 void
545 user_access ()
547 #ifdef GETLOADAVG_PRIVILEGED
549 if (!access_inited)
550 init_access ();
552 if (current_access == user)
553 return;
555 /* We are in "make access" mode. This means that the effective user and
556 group IDs are those of make (if it was installed setuid or setgid).
557 We now want to set the effective user and group IDs to the real IDs,
558 which are the IDs of the process that exec'd make. */
560 #ifndef HAVE_SETREUID
562 /* System V has only the setuid/setgid calls to set user/group IDs.
563 There is an effective ID, which can be set by setuid/setgid.
564 It can be set (unless you are root) only to either what it already is
565 (returned by geteuid/getegid, now in make_uid/make_gid),
566 the real ID (return by getuid/getgid, now in user_uid/user_gid),
567 or the saved set ID (what the effective ID was before this set-ID
568 executable (make) was exec'd). */
570 if (setuid (user_uid) < 0)
571 pfatal_with_name ("user_access: setuid");
573 #else
575 /* In 4BSD, the setreuid/setregid calls set both the real and effective IDs.
576 They may be set to themselves or each other. So you have two alternatives
577 at any one time. If you use setuid/setgid, the effective will be set to
578 the real, leaving only one alternative. Using setreuid/setregid, however,
579 you can toggle between your two alternatives by swapping the values in a
580 single setreuid or setregid call. */
582 if (setreuid (make_uid, user_uid) < 0)
583 pfatal_with_name ("user_access: setreuid");
585 #endif
587 #ifndef HAVE_SETREGID
588 if (setgid (user_gid) < 0)
589 pfatal_with_name ("user_access: setgid");
590 #else
591 if (setregid (make_gid, user_gid) < 0)
592 pfatal_with_name ("user_access: setregid");
593 #endif
595 current_access = user;
597 log_access ("User");
599 #endif /* GETLOADAVG_PRIVILEGED */
602 /* Give the process appropriate permissions for access to
603 make data (i.e., the load average). */
604 void
605 make_access ()
607 #ifdef GETLOADAVG_PRIVILEGED
609 if (!access_inited)
610 init_access ();
612 if (current_access == make)
613 return;
615 /* See comments in user_access, above. */
617 #ifndef HAVE_SETREUID
618 if (setuid (make_uid) < 0)
619 pfatal_with_name ("make_access: setuid");
620 #else
621 if (setreuid (user_uid, make_uid) < 0)
622 pfatal_with_name ("make_access: setreuid");
623 #endif
625 #ifndef HAVE_SETREGID
626 if (setgid (make_gid) < 0)
627 pfatal_with_name ("make_access: setgid");
628 #else
629 if (setregid (user_gid, make_gid) < 0)
630 pfatal_with_name ("make_access: setregid");
631 #endif
633 current_access = make;
635 log_access ("Make");
637 #endif /* GETLOADAVG_PRIVILEGED */
640 /* Give the process appropriate permissions for a child process.
641 This is like user_access, but you can't get back to make_access. */
642 void
643 child_access ()
645 #ifdef GETLOADAVG_PRIVILEGED
647 if (!access_inited)
648 abort ();
650 /* Set both the real and effective UID and GID to the user's.
651 They cannot be changed back to make's. */
653 #ifndef HAVE_SETREUID
654 if (setuid (user_uid) < 0)
655 pfatal_with_name ("child_access: setuid");
656 #else
657 if (setreuid (user_uid, user_uid) < 0)
658 pfatal_with_name ("child_access: setreuid");
659 #endif
661 #ifndef HAVE_SETREGID
662 if (setgid (user_gid) < 0)
663 pfatal_with_name ("child_access: setgid");
664 #else
665 if (setregid (user_gid, user_gid) < 0)
666 pfatal_with_name ("child_access: setregid");
667 #endif
669 log_access ("Child");
671 #endif /* GETLOADAVG_PRIVILEGED */
674 #ifdef NEED_GET_PATH_MAX
675 unsigned int
676 get_path_max ()
678 static unsigned int value;
680 if (value == 0)
682 long int x = pathconf ("/", _PC_PATH_MAX);
683 if (x > 0)
684 value = x;
685 else
686 return MAXPATHLEN;
689 return value;
691 #endif