xref: /netbsd/usr.bin/make/compat.c (revision bf9ec67e)
1 /*	$NetBSD: compat.c,v 1.43 2002/04/27 15:14:30 bjh21 Exp $	*/
2 
3 /*
4  * Copyright (c) 1988, 1989, 1990 The Regents of the University of California.
5  * Copyright (c) 1988, 1989 by Adam de Boor
6  * Copyright (c) 1989 by Berkeley Softworks
7  * All rights reserved.
8  *
9  * This code is derived from software contributed to Berkeley by
10  * Adam de Boor.
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions
14  * are met:
15  * 1. Redistributions of source code must retain the above copyright
16  *    notice, this list of conditions and the following disclaimer.
17  * 2. Redistributions in binary form must reproduce the above copyright
18  *    notice, this list of conditions and the following disclaimer in the
19  *    documentation and/or other materials provided with the distribution.
20  * 3. All advertising materials mentioning features or use of this software
21  *    must display the following acknowledgement:
22  *	This product includes software developed by the University of
23  *	California, Berkeley and its contributors.
24  * 4. Neither the name of the University nor the names of its contributors
25  *    may be used to endorse or promote products derived from this software
26  *    without specific prior written permission.
27  *
28  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
29  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
30  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
31  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
32  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
33  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
34  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
35  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
36  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
37  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
38  * SUCH DAMAGE.
39  */
40 
41 #ifdef MAKE_BOOTSTRAP
42 static char rcsid[] = "$NetBSD: compat.c,v 1.43 2002/04/27 15:14:30 bjh21 Exp $";
43 #else
44 #include <sys/cdefs.h>
45 #ifndef lint
46 #if 0
47 static char sccsid[] = "@(#)compat.c	8.2 (Berkeley) 3/19/94";
48 #else
49 __RCSID("$NetBSD: compat.c,v 1.43 2002/04/27 15:14:30 bjh21 Exp $");
50 #endif
51 #endif /* not lint */
52 #endif
53 
54 /*-
55  * compat.c --
56  *	The routines in this file implement the full-compatibility
57  *	mode of PMake. Most of the special functionality of PMake
58  *	is available in this mode. Things not supported:
59  *	    - different shells.
60  *	    - friendly variable substitution.
61  *
62  * Interface:
63  *	Compat_Run	    Initialize things for this module and recreate
64  *	    	  	    thems as need creatin'
65  */
66 
67 #include    <stdio.h>
68 #include    <sys/types.h>
69 #include    <sys/stat.h>
70 #include    <sys/wait.h>
71 #include    <ctype.h>
72 #include    <errno.h>
73 #include    <signal.h>
74 #include    "make.h"
75 #include    "hash.h"
76 #include    "dir.h"
77 #include    "job.h"
78 #include    "pathnames.h"
79 
80 /*
81  * The following array is used to make a fast determination of which
82  * characters are interpreted specially by the shell.  If a command
83  * contains any of these characters, it is executed by the shell, not
84  * directly by us.
85  */
86 
87 static char 	    meta[256];
88 
89 static GNode	    *curTarg = NILGNODE;
90 static GNode	    *ENDNode;
91 static void CompatInterrupt __P((int));
92 static int CompatRunCommand __P((ClientData, ClientData));
93 static int CompatMake __P((ClientData, ClientData));
94 
95 /*-
96  *-----------------------------------------------------------------------
97  * CompatInterrupt --
98  *	Interrupt the creation of the current target and remove it if
99  *	it ain't precious.
100  *
101  * Results:
102  *	None.
103  *
104  * Side Effects:
105  *	The target is removed and the process exits. If .INTERRUPT exists,
106  *	its commands are run first WITH INTERRUPTS IGNORED..
107  *
108  *-----------------------------------------------------------------------
109  */
110 static void
111 CompatInterrupt (signo)
112     int	    signo;
113 {
114     GNode   *gn;
115 
116     if ((curTarg != NILGNODE) && !Targ_Precious (curTarg)) {
117 	char	  *p1;
118 	char 	  *file = Var_Value (TARGET, curTarg, &p1);
119 
120 	if (!noExecute && eunlink(file) != -1) {
121 	    Error("*** %s removed", file);
122 	}
123 	if (p1)
124 	    free(p1);
125 
126 	/*
127 	 * Run .INTERRUPT only if hit with interrupt signal
128 	 */
129 	if (signo == SIGINT) {
130 	    gn = Targ_FindNode(".INTERRUPT", TARG_NOCREATE);
131 	    if (gn != NILGNODE) {
132 		Lst_ForEach(gn->commands, CompatRunCommand, (ClientData)gn);
133 	    }
134 	}
135 
136     }
137     exit (signo);
138 }
139 
140 /*-
141  *-----------------------------------------------------------------------
142  * CompatRunCommand --
143  *	Execute the next command for a target. If the command returns an
144  *	error, the node's made field is set to ERROR and creation stops.
145  *
146  * Results:
147  *	0 if the command succeeded, 1 if an error occurred.
148  *
149  * Side Effects:
150  *	The node's 'made' field may be set to ERROR.
151  *
152  *-----------------------------------------------------------------------
153  */
154 static int
155 CompatRunCommand (cmdp, gnp)
156     ClientData    cmdp;	    	/* Command to execute */
157     ClientData    gnp;    	/* Node from which the command came */
158 {
159     char    	  *cmdStart;	/* Start of expanded command */
160     char 	  *cp, *bp;
161     Boolean 	  silent,   	/* Don't print command */
162 		  errCheck; 	/* Check errors */
163     int 	  reason;   	/* Reason for child's death */
164     int	    	  status;   	/* Description of child's death */
165     int	    	  cpid;	    	/* Child actually found */
166     ReturnStatus  retstat;    	/* Status of fork */
167     LstNode 	  cmdNode;  	/* Node where current command is located */
168     char    	  **av;	    	/* Argument vector for thing to exec */
169     int	    	  argc;	    	/* Number of arguments in av or 0 if not
170 				 * dynamically allocated */
171     Boolean 	  local;    	/* TRUE if command should be executed
172 				 * locally */
173     char	  *cmd = (char *) cmdp;
174     GNode	  *gn = (GNode *) gnp;
175 
176     /*
177      * Avoid clobbered variable warnings by forcing the compiler
178      * to ``unregister'' variables
179      */
180 #if __GNUC__
181     (void) &av;
182     (void) &errCheck;
183 #endif
184     silent = gn->type & OP_SILENT;
185     errCheck = !(gn->type & OP_IGNORE);
186 
187     cmdNode = Lst_Member (gn->commands, (ClientData)cmd);
188     cmdStart = Var_Subst (NULL, cmd, gn, FALSE);
189 
190     /*
191      * brk_string will return an argv with a NULL in av[0], thus causing
192      * execvp to choke and die horribly. Besides, how can we execute a null
193      * command? In any case, we warn the user that the command expanded to
194      * nothing (is this the right thing to do?).
195      */
196 
197     if (*cmdStart == '\0') {
198 	free(cmdStart);
199 	Error("%s expands to empty string", cmd);
200 	return(0);
201     } else {
202 	cmd = cmdStart;
203     }
204     Lst_Replace (cmdNode, (ClientData)cmdStart);
205 
206     if ((gn->type & OP_SAVE_CMDS) && (gn != ENDNode)) {
207 	(void)Lst_AtEnd(ENDNode->commands, (ClientData)cmdStart);
208 	return(0);
209     } else if (strcmp(cmdStart, "...") == 0) {
210 	gn->type |= OP_SAVE_CMDS;
211 	return(0);
212     }
213 
214     while ((*cmd == '@') || (*cmd == '-')) {
215 	if (*cmd == '@') {
216 	    silent = TRUE;
217 	} else {
218 	    errCheck = FALSE;
219 	}
220 	cmd++;
221     }
222 
223     while (isspace((unsigned char)*cmd))
224 	cmd++;
225 
226     /*
227      * Search for meta characters in the command. If there are no meta
228      * characters, there's no need to execute a shell to execute the
229      * command.
230      */
231     for (cp = cmd; !meta[(unsigned char)*cp]; cp++) {
232 	continue;
233     }
234 
235     /*
236      * Print the command before echoing if we're not supposed to be quiet for
237      * this one. We also print the command if -n given.
238      */
239     if (!silent || NoExecute(gn)) {
240 	printf ("%s\n", cmd);
241 	fflush(stdout);
242     }
243 
244     /*
245      * If we're not supposed to execute any commands, this is as far as
246      * we go...
247      */
248     if (NoExecute(gn)) {
249 	return (0);
250     }
251 
252     if (*cp != '\0') {
253 	/*
254 	 * If *cp isn't the null character, we hit a "meta" character and
255 	 * need to pass the command off to the shell. We give the shell the
256 	 * -e flag as well as -c if it's supposed to exit when it hits an
257 	 * error.
258 	 */
259 	static char	*shargv[4] = { _PATH_BSHELL };
260 
261 	if (DEBUG(SHELL))
262 		shargv[1] = (errCheck ? "-exc" : "-xc");
263 	else
264 		shargv[1] = (errCheck ? "-ec" : "-c");
265 	shargv[2] = cmd;
266 	shargv[3] = (char *)NULL;
267 	av = shargv;
268 	argc = 0;
269 	bp = NULL;
270     } else {
271 	/*
272 	 * No meta-characters, so no need to exec a shell. Break the command
273 	 * into words to form an argument vector we can execute.
274 	 */
275 	av = brk_string(cmd, &argc, TRUE, &bp);
276     }
277 
278     local = TRUE;
279 
280     /*
281      * Fork and execute the single command. If the fork fails, we abort.
282      */
283     cpid = vfork();
284     if (cpid < 0) {
285 	Fatal("Could not fork");
286     }
287     if (cpid == 0) {
288 	Check_Cwd(av);
289 	if (local)
290 	    (void)execvp(av[0], av);
291 	else
292 	    (void)execv(av[0], av);
293 	execError("exec", av[0]);
294 	_exit(1);
295     }
296     if (bp) {
297 	free(av);
298 	free(bp);
299     }
300     free(cmdStart);
301     Lst_Replace (cmdNode, (ClientData) NULL);
302 
303     /*
304      * The child is off and running. Now all we can do is wait...
305      */
306     while (1) {
307 
308 	while ((retstat = wait(&reason)) != cpid) {
309 	    if (retstat == -1 && errno != EINTR) {
310 		break;
311 	    }
312 	}
313 
314 	if (retstat > -1) {
315 	    if (WIFSTOPPED(reason)) {
316 		status = WSTOPSIG(reason);		/* stopped */
317 	    } else if (WIFEXITED(reason)) {
318 		status = WEXITSTATUS(reason);		/* exited */
319 		if (status != 0) {
320 		    printf ("*** Error code %d", status);
321 		}
322 	    } else {
323 		status = WTERMSIG(reason);		/* signaled */
324 		printf ("*** Signal %d", status);
325 	    }
326 
327 
328 	    if (!WIFEXITED(reason) || (status != 0)) {
329 		if (errCheck) {
330 		    gn->made = ERROR;
331 		    if (keepgoing) {
332 			/*
333 			 * Abort the current target, but let others
334 			 * continue.
335 			 */
336 			printf (" (continuing)\n");
337 		    }
338 		} else {
339 		    /*
340 		     * Continue executing commands for this target.
341 		     * If we return 0, this will happen...
342 		     */
343 		    printf (" (ignored)\n");
344 		    status = 0;
345 		}
346 	    }
347 	    break;
348 	} else {
349 	    Fatal ("error in wait: %d: %s", retstat, strerror(errno));
350 	    /*NOTREACHED*/
351 	}
352     }
353 
354     return (status);
355 }
356 
357 /*-
358  *-----------------------------------------------------------------------
359  * CompatMake --
360  *	Make a target.
361  *
362  * Results:
363  *	0
364  *
365  * Side Effects:
366  *	If an error is detected and not being ignored, the process exits.
367  *
368  *-----------------------------------------------------------------------
369  */
370 static int
371 CompatMake (gnp, pgnp)
372     ClientData	gnp;	    /* The node to make */
373     ClientData  pgnp;	    /* Parent to abort if necessary */
374 {
375     GNode *gn = (GNode *) gnp;
376     GNode *pgn = (GNode *) pgnp;
377 
378     if (gn->made == UNMADE && (gn == pgn || (pgn->type & OP_MADE) == 0)) {
379 	/*
380 	 * First mark ourselves to be made, then apply whatever transformations
381 	 * the suffix module thinks are necessary. Once that's done, we can
382 	 * descend and make all our children. If any of them has an error
383 	 * but the -k flag was given, our 'make' field will be set FALSE again.
384 	 * This is our signal to not attempt to do anything but abort our
385 	 * parent as well.
386 	 */
387 	gn->flags |= REMAKE;
388 	gn->made = BEINGMADE;
389 	if ((gn->type & OP_MADE) == 0)
390 	    Suff_FindDeps (gn);
391 	Lst_ForEach (gn->children, CompatMake, (ClientData)gn);
392 	if ((gn->flags & REMAKE) == 0) {
393 	    gn->made = ABORTED;
394 	    pgn->flags &= ~REMAKE;
395 	    goto cohorts;
396 	}
397 
398 	if (Lst_Member (gn->iParents, pgn) != NILLNODE) {
399 	    char *p1;
400 	    Var_Set (IMPSRC, Var_Value(TARGET, gn, &p1), pgn, 0);
401 	    if (p1)
402 		free(p1);
403 	}
404 
405 	/*
406 	 * All the children were made ok. Now cmtime contains the modification
407 	 * time of the newest child, we need to find out if we exist and when
408 	 * we were modified last. The criteria for datedness are defined by the
409 	 * Make_OODate function.
410 	 */
411 	if (DEBUG(MAKE)) {
412 	    printf("Examining %s...", gn->name);
413 	}
414 	if (! Make_OODate(gn)) {
415 	    gn->made = UPTODATE;
416 	    if (DEBUG(MAKE)) {
417 		printf("up-to-date.\n");
418 	    }
419 	    goto cohorts;
420 	} else if (DEBUG(MAKE)) {
421 	    printf("out-of-date.\n");
422 	}
423 
424 	/*
425 	 * If the user is just seeing if something is out-of-date, exit now
426 	 * to tell him/her "yes".
427 	 */
428 	if (queryFlag) {
429 	    exit (1);
430 	}
431 
432 	/*
433 	 * We need to be re-made. We also have to make sure we've got a $?
434 	 * variable. To be nice, we also define the $> variable using
435 	 * Make_DoAllVar().
436 	 */
437 	Make_DoAllVar(gn);
438 
439 	/*
440 	 * Alter our type to tell if errors should be ignored or things
441 	 * should not be printed so CompatRunCommand knows what to do.
442 	 */
443 	if (Targ_Ignore (gn)) {
444 	    gn->type |= OP_IGNORE;
445 	}
446 	if (Targ_Silent (gn)) {
447 	    gn->type |= OP_SILENT;
448 	}
449 
450 	if (Job_CheckCommands (gn, Fatal)) {
451 	    /*
452 	     * Our commands are ok, but we still have to worry about the -t
453 	     * flag...
454 	     */
455 	    if (!touchFlag || (gn->type & OP_MAKE)) {
456 		curTarg = gn;
457 		Lst_ForEach (gn->commands, CompatRunCommand, (ClientData)gn);
458 		curTarg = NILGNODE;
459 	    } else {
460 		Job_Touch (gn, gn->type & OP_SILENT);
461 	    }
462 	} else {
463 	    gn->made = ERROR;
464 	}
465 
466 	if (gn->made != ERROR) {
467 	    /*
468 	     * If the node was made successfully, mark it so, update
469 	     * its modification time and timestamp all its parents. Note
470 	     * that for .ZEROTIME targets, the timestamping isn't done.
471 	     * This is to keep its state from affecting that of its parent.
472 	     */
473 	    gn->made = MADE;
474 	    pgn->flags |= Make_Recheck(gn) == 0 ? FORCE : 0;
475 	    if (!(gn->type & OP_EXEC)) {
476 		pgn->flags |= CHILDMADE;
477 		Make_TimeStamp(pgn, gn);
478 	    }
479 	} else if (keepgoing) {
480 	    pgn->flags &= ~REMAKE;
481 	} else {
482 	    PrintOnError("\n\nStop.");
483 	    exit (1);
484 	}
485     } else if (gn->made == ERROR) {
486 	/*
487 	 * Already had an error when making this beastie. Tell the parent
488 	 * to abort.
489 	 */
490 	pgn->flags &= ~REMAKE;
491     } else {
492 	if (Lst_Member (gn->iParents, pgn) != NILLNODE) {
493 	    char *p1;
494 	    Var_Set (IMPSRC, Var_Value(TARGET, gn, &p1), pgn, 0);
495 	    if (p1)
496 		free(p1);
497 	}
498 	switch(gn->made) {
499 	    case BEINGMADE:
500 		Error("Graph cycles through %s", gn->name);
501 		gn->made = ERROR;
502 		pgn->flags &= ~REMAKE;
503 		break;
504 	    case MADE:
505 		if ((gn->type & OP_EXEC) == 0) {
506 		    pgn->flags |= CHILDMADE;
507 		    Make_TimeStamp(pgn, gn);
508 		}
509 		break;
510 	    case UPTODATE:
511 		if ((gn->type & OP_EXEC) == 0) {
512 		    Make_TimeStamp(pgn, gn);
513 		}
514 		break;
515 	    default:
516 		break;
517 	}
518     }
519 
520 cohorts:
521     Lst_ForEach (gn->cohorts, CompatMake, pgnp);
522     return (0);
523 }
524 
525 /*-
526  *-----------------------------------------------------------------------
527  * Compat_Run --
528  *	Initialize this mode and start making.
529  *
530  * Results:
531  *	None.
532  *
533  * Side Effects:
534  *	Guess what?
535  *
536  *-----------------------------------------------------------------------
537  */
538 void
539 Compat_Run(targs)
540     Lst	    	  targs;    /* List of target nodes to re-create */
541 {
542     char    	  *cp;	    /* Pointer to string of shell meta-characters */
543     GNode   	  *gn = NULL;/* Current root target */
544     int	    	  errors;   /* Number of targets not remade due to errors */
545 
546     if (signal(SIGINT, SIG_IGN) != SIG_IGN) {
547 	signal(SIGINT, CompatInterrupt);
548     }
549     if (signal(SIGTERM, SIG_IGN) != SIG_IGN) {
550 	signal(SIGTERM, CompatInterrupt);
551     }
552     if (signal(SIGHUP, SIG_IGN) != SIG_IGN) {
553 	signal(SIGHUP, CompatInterrupt);
554     }
555     if (signal(SIGQUIT, SIG_IGN) != SIG_IGN) {
556 	signal(SIGQUIT, CompatInterrupt);
557     }
558 
559     for (cp = "#=|^(){};&<>*?[]:$`\\\n"; *cp != '\0'; cp++) {
560 	meta[(unsigned char) *cp] = 1;
561     }
562     /*
563      * The null character serves as a sentinel in the string.
564      */
565     meta[0] = 1;
566 
567     ENDNode = Targ_FindNode(".END", TARG_CREATE);
568     /*
569      * If the user has defined a .BEGIN target, execute the commands attached
570      * to it.
571      */
572     if (!queryFlag) {
573 	gn = Targ_FindNode(".BEGIN", TARG_NOCREATE);
574 	if (gn != NILGNODE) {
575 	    Lst_ForEach(gn->commands, CompatRunCommand, (ClientData)gn);
576             if (gn->made == ERROR) {
577                 PrintOnError("\n\nStop.");
578                 exit(1);
579             }
580 	}
581     }
582 
583     /*
584      * Expand .USE nodes right now, because they can modify the structure
585      * of the tree.
586      */
587     Lst_Destroy(Make_ExpandUse(targs), NOFREE);
588 
589     /*
590      * For each entry in the list of targets to create, call CompatMake on
591      * it to create the thing. CompatMake will leave the 'made' field of gn
592      * in one of several states:
593      *	    UPTODATE	    gn was already up-to-date
594      *	    MADE  	    gn was recreated successfully
595      *	    ERROR 	    An error occurred while gn was being created
596      *	    ABORTED	    gn was not remade because one of its inferiors
597      *	    	  	    could not be made due to errors.
598      */
599     errors = 0;
600     while (!Lst_IsEmpty (targs)) {
601 	gn = (GNode *) Lst_DeQueue (targs);
602 	CompatMake (gn, gn);
603 
604 	if (gn->made == UPTODATE) {
605 	    printf ("`%s' is up to date.\n", gn->name);
606 	} else if (gn->made == ABORTED) {
607 	    printf ("`%s' not remade because of errors.\n", gn->name);
608 	    errors += 1;
609 	}
610     }
611 
612     /*
613      * If the user has defined a .END target, run its commands.
614      */
615     if (errors == 0) {
616 	Lst_ForEach(ENDNode->commands, CompatRunCommand, (ClientData)gn);
617 	if (gn->made == ERROR) {
618 	    PrintOnError("\n\nStop.");
619 	    exit(1);
620 	}
621     }
622 }
623