projects / unix-history / blob
? search:
summary | tags | clone url | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
going to change main, so reformat to KNF
[unix-history] / usr / src / usr.bin / make / main.c
/*
* Copyright (c) 1988, 1989, 1990 The Regents of the University of California.
* Copyright (c) 1988, 1989 by Adam de Boor
* Copyright (c) 1989 by Berkeley Softworks
* All rights reserved.
*
* This code is derived from software contributed to Berkeley by
* Adam de Boor.
*
* Redistribution and use in source and binary forms are permitted
* provided that the above copyright notice and this paragraph are
* duplicated in all such forms and that any documentation,
* advertising materials, and other materials related to such
* distribution and use acknowledge that the software was developed
* by the University of California, Berkeley. The name of the
* University may not be used to endorse or promote products derived
* from this software without specific prior written permission.
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
* IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
*/
#ifndef lint
char copyright[] =
"@(#) Copyright (c) 1989 The Regents of the University of California.\n\
All rights reserved.\n";
#endif /* not lint */
#ifndef lint
static char sccsid[] = "@(#)main.c 5.9 (Berkeley) %G%";
#endif /* not lint */
/*-
* main.c --
* The main file for this entire program. Exit routines etc
* reside here.
*
* Utility functions defined in this file:
* Main_ParseArgLine Takes a line of arguments, breaks them and
* treats them as if they were given when first
* invoked. Used by the parse module to implement
* the .MFLAGS target.
*
* Error Print a tagged error message. The global
* MAKE variable must have been defined. This
* takes a format string and two optional
* arguments for it.
*
* Fatal Print an error message and exit. Also takes
* a format string and two arguments.
*
* Punt Aborts all jobs and exits with a message. Also
* takes a format string and two arguments.
*
* Finish Finish things up by printing the number of
* errors which occured, as passed to it, and
* exiting.
*/
#include <sys/types.h>
#include <sys/signal.h>
#include <sys/stat.h>
#include <sys/errno.h>
#include <fcntl.h>
#include <ctype.h>
#include <stdio.h>
#include "make.h"
extern int errno;
#ifndef DEFMAXLOCAL
#define DEFMAXLOCAL DEFMAXJOBS
#endif DEFMAXLOCAL
#define MAKEFLAGS ".MAKEFLAGS"
static char *progName; /* Our invocation name */
Lst create; /* Targets to be made */
time_t now; /* Time at start of make */
GNode *DEFAULT; /* .DEFAULT node */
Boolean allPrecious; /* .PRECIOUS given on line by itself */
static int printGraph; /* -p flag */
static Boolean noBuiltins; /* -r flag */
static Lst makefiles; /* List of makefiles to read (in
* order) */
int maxJobs; /* -J argument */
static int maxLocal; /* -L argument */
Boolean debug; /* -d flag */
Boolean amMake; /* -M flag */
Boolean noWarnings; /* -W flag */
Boolean noExecute; /* -n flag */
Boolean keepgoing; /* -k flag */
Boolean queryFlag; /* -q flag */
Boolean touchFlag; /* -t flag */
Boolean usePipes; /* !-P flag */
Boolean backwards; /* -B flag */
Boolean ignoreErrors; /* -i flag */
Boolean beSilent; /* -s flag */
Boolean sysVmake; /* -v flag */
Boolean oldVars; /* variable substitution style */
Boolean checkEnvFirst; /* -e flag */
static Boolean jobsRunning; /* TRUE if the jobs might be running */
static Boolean ReadMakefile();
/*
* Initial value for optind when parsing args. Different getopts start it
* differently...
*/
static int initOptInd;
static char *help[] = {
"-B Be as backwards-compatible with make as possible without\n\
being make.",
"-C Cancel any current indications of compatibility.",
"-D<var> Define the variable <var> with value 1.",
"-I<dir> Specify another directory in which to search for included\n\
makefiles.",
"-J<num> Specify maximum overall concurrency.",
"-L<num> Specify maximum local concurrency.",
"-M Be Make as closely as possible.",
"-P Don't use pipes to catch the output of jobs, use files.",
"-S Turn off the -k flag (see below).",
"-W Don't print warning messages.",
"-d<flags> Turn on debugging output.",
"-e Give environment variables precedence over those in the\n\
makefile(s).",
"-f<file> Specify a(nother) makefile to read",
"-i Ignore errors from executed commands.",
"-k On error, continue working on targets that do not depend on\n\
the one for which an error was detected.",
"-n Don't execute commands, just print them.",
"-p<num> Tell when to print the input graph: 1 (before processing),\n\
2 (after processing), or 3 (both).",
"-q See if anything needs to be done. Exits 1 if so.",
"-r Do not read the system makefile for pre-defined rules.",
"-s Don't print commands as they are executed.",
"-t Update targets by \"touching\" them (see touch(1)).",
"-v Be compatible with System V make. Implies -B.",
};
/*-
*----------------------------------------------------------------------
* MainParseArgs --
* Parse a given argument vector. Called from main() and from
* Main_ParseArgLine() when the .MAKEFLAGS target is used.
*
* XXX: Deal with command line overriding .MAKEFLAGS in makefile
*
* Results:
* None
*
* Side Effects:
* Various global and local flags will be set depending on the flags
* given
*----------------------------------------------------------------------
*/
static void
MainParseArgs(argc, argv)
int argc;
char **argv;
{
extern int optind;
extern char *optarg;
register int i;
register char *cp;
char c;
optind = initOptInd;
while((c = getopt(argc, argv,
"BCD:I:J:L:MPSWd:ef:iknp:qrstvh")) != -1) {
switch(c) {
case 'B':
backwards = TRUE;
Var_Append(MAKEFLAGS, "-B", VAR_GLOBAL);
break;
case 'C':
backwards = sysVmake = amMake = FALSE;
Var_Append(MAKEFLAGS, "-C", VAR_GLOBAL);
break;
case 'D':
Var_Set(optarg, "1", VAR_GLOBAL);
Var_Append(MAKEFLAGS, "-D", VAR_GLOBAL);
Var_Append(MAKEFLAGS, optarg, VAR_GLOBAL);
break;
case 'I':
Parse_AddIncludeDir(optarg);
Var_Append(MAKEFLAGS, "-I", VAR_GLOBAL);
Var_Append(MAKEFLAGS, optarg, VAR_GLOBAL);
break;
case 'J':
maxJobs = atoi(optarg);
Var_Append(MAKEFLAGS, "-J", VAR_GLOBAL);
Var_Append(MAKEFLAGS, optarg, VAR_GLOBAL);
break;
case 'L':
maxLocal = atoi(optarg);
Var_Append(MAKEFLAGS, "-L", VAR_GLOBAL);
Var_Append(MAKEFLAGS, optarg, VAR_GLOBAL);
break;
case 'M':
amMake = TRUE;
Var_Append(MAKEFLAGS, "-M", VAR_GLOBAL);
break;
case 'P':
usePipes = FALSE;
Var_Append(MAKEFLAGS, "-P", VAR_GLOBAL);
break;
case 'S':
keepgoing = FALSE;
Var_Append(MAKEFLAGS, "-S", VAR_GLOBAL);
break;
case 'W':
noWarnings = TRUE;
Var_Append(MAKEFLAGS, "-W", VAR_GLOBAL);
break;
case 'd': {
char *modules = optarg;
while (*modules) {
switch (*modules) {
case '*':
debug = ~0;
break;
case 'a':
debug |= DEBUG_ARCH;
break;
case 'c':
debug |= DEBUG_COND;
break;
case 'd':
debug |= DEBUG_DIR;
break;
case 'j':
debug |= DEBUG_JOB;
break;
case 'm':
debug |= DEBUG_MAKE;
break;
case 'p':
debug |= DEBUG_PARSE;
break;
case 'r':
debug |= DEBUG_RMT;
break;
case 's':
debug |= DEBUG_SUFF;
break;
case 't':
debug |= DEBUG_TARG;
break;
case 'v':
debug |= DEBUG_VAR;
break;
}
++modules;
}
Var_Append(MAKEFLAGS, "-d", VAR_GLOBAL);
Var_Append(MAKEFLAGS, optarg, VAR_GLOBAL);
break;
}
case 'e':
checkEnvFirst = TRUE;
Var_Append(MAKEFLAGS, "-e", VAR_GLOBAL);
break;
case 'f':
(void)Lst_AtEnd(makefiles, (ClientData)optarg);
break;
case 'i':
ignoreErrors = TRUE;
Var_Append(MAKEFLAGS, "-i", VAR_GLOBAL);
break;
case 'k':
keepgoing = TRUE;
Var_Append(MAKEFLAGS, "-k", VAR_GLOBAL);
break;
case 'n':
noExecute = TRUE;
Var_Append(MAKEFLAGS, "-n", VAR_GLOBAL);
break;
case 'p':
printGraph = atoi(optarg);
break;
case 'q':
queryFlag = TRUE;
/* Kind of nonsensical, wot? */
Var_Append(MAKEFLAGS, "-q", VAR_GLOBAL);
break;
case 'r':
noBuiltins = TRUE;
Var_Append(MAKEFLAGS, "-r", VAR_GLOBAL);
break;
case 's':
beSilent = TRUE;
Var_Append(MAKEFLAGS, "-s", VAR_GLOBAL);
break;
case 't':
touchFlag = TRUE;
Var_Append(MAKEFLAGS, "-t", VAR_GLOBAL);
break;
case 'v':
sysVmake = backwards = TRUE;
Var_Append(MAKEFLAGS, "-v", VAR_GLOBAL);
break;
case 'h':
case '?': {
int i;
for (i = 0; i < sizeof(help)/sizeof(help[0]); i++)
(void)printf("%s\n", help[i]);
exit(c == '?' ? -1 : 0);
}
}
}
/* Take care of encompassing compatibility levels... */
if (amMake)
backwards = TRUE;
oldVars = TRUE;
/*
* See if the rest of the arguments are variable assignments and
* perform them if so. Else take them to be targets and stuff them
* on the end of the "create" list.
*/
for (i = optind; i < argc; i++) {
if (Parse_IsVar (argv[i])) {
Parse_DoVar(argv[i], VAR_CMD);
} else {
if (argv[i][0] == 0) {
Punt("Bogus argument in MainParseArgs");
}
(void)Lst_AtEnd (create, (ClientData)argv[i]);
}
}
}
/*-
* Main_ParseArgLine --
* Used by the parse module when a .MFLAGS or .MAKEFLAGS target
* is encountered and by main() when reading the .MAKEFLAGS envariable.
* Takes a line of arguments and breaks it into its
* component words and passes those words and the number of them to the
* MainParseArgs function.
* The line should have all its leading whitespace removed.
*
* Results:
* None
*
* Side Effects:
* Only those that come from the various arguments.
*-----------------------------------------------------------------------
*/
void
Main_ParseArgLine(line)
char *line; /* Line to fracture */
{
char **argv; /* Manufactured argument vector */
int argc; /* Number of arguments in argv */
if (line == NULL)
return;
while (*line == ' ')
++line;
argv = Str_BreakString (line, " \t", "\n", &argc);
MainParseArgs(argc, argv);
Str_FreeVec(argc, argv);
}
/*-
* main --
* The main function, for obvious reasons. Initializes variables
* and a few modules, then parses the arguments give it in the
* environment and on the command line. Reads the system makefile
* followed by either Makefile, makefile or the file given by the
* -f argument. Sets the .MAKEFLAGS PMake variable based on all the
* flags it has received by then uses either the Make or the Compat
* module to create the initial list of targets.
*
* Results:
* If -q was given, exits -1 if anything was out-of-date. Else it exits
* 0.
*
* Side Effects:
* The program exits when done. Targets are created. etc. etc. etc.
*
*----------------------------------------------------------------------
*/
main(argc, argv)
int argc;
char **argv;
{
extern int optind;
Lst targs; /* target nodes to create -- passed to Make_Init */
Boolean outOfDate; /* FALSE if all targets up to date */
char *cp;
create = Lst_Init (FALSE);
makefiles = Lst_Init(FALSE);
beSilent = FALSE; /* Print commands as executed */
ignoreErrors = FALSE; /* Pay attention to non-zero returns */
noExecute = FALSE; /* Execute all commands */
keepgoing = FALSE; /* Stop on error */
allPrecious = FALSE; /* Remove targets when interrupted */
queryFlag = FALSE; /* This is not just a check-run */
noBuiltins = FALSE; /* Read the built-in rules */
touchFlag = FALSE; /* Actually update targets */
usePipes = TRUE; /* Catch child output in pipes */
debug = 0; /* No debug verbosity, please. */
noWarnings = FALSE; /* Print warning messages */
sysVmake = FALSE; /* Don't be System V compatible */
jobsRunning = FALSE;
maxJobs = DEFMAXJOBS; /* Set default max concurrency */
maxLocal = DEFMAXLOCAL; /* Set default local max concurrency */
/*
* Deal with disagreement between different getopt's as to what
* the initial value of optind should be by simply saving the
* damn thing.
*/
initOptInd = optind;
/*
* See what the user calls us. If s/he calls us (yuck) "make", then
* act like it. Otherwise act like our normal, cheerful self.
*/
cp = rindex (argv[0], '/');
if (cp != (char *)NULL) {
cp += 1;
} else {
cp = argv[0];
}
progName = cp;
if (strcmp (cp, "make") == 0) {
amMake = TRUE; /* Be like make */
backwards = TRUE; /* Do things the old-fashioned way */
} else if (strcmp(cp, "smake") == 0 || strcmp(cp, "vmake") == 0) {
sysVmake = backwards = TRUE;
} else {
amMake = FALSE;
backwards = FALSE; /* Do things MY way, not MAKE's */
}
/*
* Initialize the parsing, directory and variable modules to prepare
* for the reading of inclusion paths and variable settings on the
* command line
*/
Dir_Init(); /* Initialize directory structures so -I flags
* can be processed correctly */
Parse_Init(); /* Need to initialize the paths of #include
* directories */
Var_Init(); /* As well as the lists of variables for
* parsing arguments */
/*
* Initialize various variables.
* .PMAKE gets how we were executed.
* MAKE also gets this name, for compatibility
* .MAKEFLAGS gets set to the empty string just in case.
* MFLAGS also gets initialized empty, for compatibility.
*/
Var_Set(".PMAKE", argv[0], VAR_GLOBAL);
Var_Set("MAKE", argv[0], VAR_GLOBAL);
Var_Set(MAKEFLAGS, "", VAR_GLOBAL);
Var_Set("MFLAGS", "", VAR_GLOBAL);
/*
* First snag any flags out of the PMAKE environment variable.
* (Note this is *not* MAKEFLAGS since /bin/make uses that and it's
* in a different format).
*/
#ifdef POSIX
Main_ParseArgLine(getenv("MAKEFLAGS"));
#else
Main_ParseArgLine(getenv("PMAKE"));
#endif
MainParseArgs(argc, argv);
/*
* Initialize archive, target and suffix modules in preparation for
* parsing the makefile(s)
*/
Arch_Init();
Targ_Init();
Suff_Init();
DEFAULT = NILGNODE;
(void)time(&now);
/*
* Set up the .TARGETS variable to contain the list of targets to be
* created. If none specified, make the variable empty -- the parser
* will fill the thing in with the default or .MAIN target.
*/
if (!Lst_IsEmpty(create)) {
LstNode ln;
for (ln = Lst_First(create); ln != NILLNODE;
ln = Lst_Succ(ln)) {
char *name = (char *)Lst_Datum(ln);
Var_Append(".TARGETS", name, VAR_GLOBAL);
}
} else
Var_Set(".TARGETS", "", VAR_GLOBAL);
/*
* Read in the built-in rules first, followed by the specified makefile,
* if it was (makefile != (char *) NULL), or the default Makefile and
* makefile, in that order, if it wasn't.
*/
if (!noBuiltins && !ReadMakefile (DEFSYSMK))
Fatal ("Could not open system rules (%s)", DEFSYSMK);
if (!Lst_IsEmpty(makefiles)) {
LstNode ln;
ln = Lst_Find(makefiles, (ClientData)NULL, ReadMakefile);
if (ln != NILLNODE)
Fatal ("Cannot open %s", (char *)Lst_Datum(ln));
} else {
#ifdef POSIX
if (!ReadMakefile("makefile"))
(void)ReadMakefile("Makefile");
#else
if (!ReadMakefile((amMake || sysVmake) ?
"makefile" : "Makefile"))
(void)ReadMakefile((amMake||sysVmake) ?
"Makefile" : "makefile");
#endif
}
Var_Append ("MFLAGS", Var_Value(MAKEFLAGS, VAR_GLOBAL), VAR_GLOBAL);
/* Install all the flags into the PMAKE envariable. */
#ifdef POSIX
setenv("MAKEFLAGS", Var_Value(MAKEFLAGS, VAR_GLOBAL));
#else
setenv("PMAKE", Var_Value(MAKEFLAGS, VAR_GLOBAL));
#endif
/*
* For compatibility, look at the directories in the VPATH variable
* and add them to the search path, if the variable is defined. The
* variable's value is in the same format as the PATH envariable, i.e.
* <directory>:<directory>:<directory>...
*/
if (Var_Exists ("VPATH", VAR_CMD)) {
char *vpath, *path, *cp, savec;
/*
* GCC stores string constants in read-only memory, but
* Var_Subst will want to write this thing, so store it
* in an array
*/
static char VPATH[] = "${VPATH}";
vpath = Var_Subst (VPATH, VAR_CMD, FALSE);
path = vpath;
do {
/* skip to end of directory */
for (cp = path; *cp != ':' && *cp != '\0'; cp++) {
continue;
}
/* Save terminator character so know when to stop */
savec = *cp;
*cp = '\0';
/* Add directory to search path */
Dir_AddDir(dirSearchPath, path);
*cp = savec;
path = cp + 1;
} while (savec == ':');
(void)free((Address)vpath);
}
/*
* Now that all search paths have been read for suffixes et al, it's
* time to add the default search path to their lists...
*/
Suff_DoPaths();
/* Print the initial graph, if the user requested it */
if (printGraph & 1)
Targ_PrintGraph(1);
/*
* Have now read the entire graph and need to make a list of targets
* to create. If none was given on the command line, we consult the
* parsing module to find the main target(s) to create.
*/
if (Lst_IsEmpty(create))
targs = Parse_MainName();
else
targs = Targ_FindList (create, TARG_CREATE);
if (!amMake) {
/*
* Initialize job module before traversing the graph, now that
* any .BEGIN and .END targets have been read. This is done
* only if the -q flag wasn't given (to prevent the .BEGIN from
* being executed should it exist).
*/
if (!queryFlag) {
if (maxLocal == -1)
maxLocal = maxJobs;
Job_Init (maxJobs, maxLocal);
jobsRunning = TRUE;
}
/* Traverse the graph, checking on all the targets */
outOfDate = Make_Run(targs);
} else
/*
* Compat_Init will take care of creating all the targets as
* well as initializing the module.
*/
Compat_Run(targs);
/* Print the graph now it's been processed if the user requested it */
if (printGraph & 2)
Targ_PrintGraph(2);
if (queryFlag && outOfDate)
exit (1);
else
exit(0);
}
/*-
* ReadMakefile --
* Open and parse the given makefile.
*
* Results:
* TRUE if ok. FALSE if couldn't open file.
*
* Side Effects:
* lots
*/
static Boolean
ReadMakefile(fname)
char *fname; /* makefile to read */
{
if (strcmp (fname, "-") == 0) {
Parse_File("(stdin)", stdin);
Var_Set("MAKEFILE", "", VAR_GLOBAL);
} else {
extern Lst parseIncPath, sysIncPath;
FILE *stream;
stream = fopen(fname, "r");
if (stream == (FILE *) NULL) {
/* Look in -I directories... */
char *name;
name = Dir_FindFile(fname, parseIncPath);
if (name == NULL) {
/*
* Last-ditch: look in system include
* directories.
*/
name = Dir_FindFile(fname, sysIncPath);
if (name == NULL)
return(FALSE);
}
stream = fopen(name, "r");
if (stream == (FILE *)NULL)
/* Better safe than sorry... */
return(FALSE);
fname = name;
}
/*
* Set the MAKEFILE variable desired by System V fans -- the
* placement of the setting here means it gets set to the
* last makefile specified, as it is set by SysV make...
*/
Var_Set("MAKEFILE", fname, VAR_GLOBAL);
Parse_File(fname, stream);
(void)fclose(stream);
}
return(TRUE);
}
/*-
* Error --
* Print an error message given its format and 0, 1, 2 or 3 arguments.
*
* Results:
* None.
*
* Side Effects:
* The message is printed.
*/
/*VARARGS1*/
void
Error(fmt, arg1, arg2, arg3)
char *fmt; /* format string */
int arg1, arg2, arg3; /* optional arguments */
{
static char estr[BSIZE]; /* output string */
(void)sprintf(estr, "%s: ", Var_Value(".PMAKE", VAR_GLOBAL));
(void)sprintf(&estr[strlen(estr)], fmt, arg1, arg2, arg3);
(void)strcat(estr, "\n");
(void)fputs(estr, stderr);
(void)fflush(stderr);
}
/*-
* Fatal --
* Produce a Fatal error message. If jobs are running, waits for them
* to finish.
*
* Results:
* None
*
* Side Effects:
* The program exits
*/
/* VARARGS1 */
void
Fatal(fmt, arg1, arg2)
char *fmt; /* format string */
int arg1, arg2; /* optional arguments */
{
if (jobsRunning)
Job_Wait();
Error(fmt, arg1, arg2);
if (printGraph & 2)
Targ_PrintGraph(2);
exit(2); /* Not 1 so -q can distinguish error */
}
/*
* Punt --
* Major exception once jobs are being created. Kills all jobs, prints
* a message and exits.
*
* Results:
* None
*
* Side Effects:
* All children are killed indiscriminately and the program Lib_Exits
*/
/* VARARGS1 */
void
Punt(fmt, arg1, arg2)
char *fmt; /* format string */
int arg1, arg2; /* optional arguments */
{
Error(fmt, arg1, arg2);
DieHorribly();
}
/*-
* DieHorribly --
* Exit without giving a message.
*
* Results:
* None
*
* Side Effects:
* A big one...
*/
void
DieHorribly()
{
if (jobsRunning)
Job_AbortAll();
if (printGraph & 2)
Targ_PrintGraph(2);
exit(2); /* Not 1, so -q can distinguish error */
}
/*
* Finish --
* Called when aborting due to errors in child shell to signal
* abnormal exit.
*
* Results:
* None
*
* Side Effects:
* The program exits
*/
void
Finish(errors)
int errors; /* number of errors encountered in Make_Make */
{
Fatal("%d error%s", errors, errors == 1 ? "" : "s");
}
Continuous source code history from original PDP-7 UNIX to FreeBSD 2, the first fully unencumbered FreeBSD release.