/*
* Copyright (c) 1988, 1989, 1990, 1993
* The Regents of the University of California. All rights reserved.
*
* This code is derived from software contributed to Berkeley by
* Adam de Boor.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of the University nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
/*
* 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, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. All advertising materials mentioning features or use of this software
* must display the following acknowledgement:
* This product includes software developed by the University of
* California, Berkeley and its contributors.
* 4. Neither the name of the University nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
/*
* Parsing of makefiles.
*
* Parse_File is the main entry point and controls most of the other
* functions in this module.
*
* Interface:
* Parse_Init Initialize the module
*
* Parse_End Clean up the module
*
* Parse_File Parse a top-level makefile. Included files are
* handled by IncludeFile instead.
*
* Parse_VarAssign
* Try to parse the given line as a variable assignment.
* Used by MainParseArgs to determine if an argument is
* a target or a variable assignment. Used internally
* for pretty much the same thing.
*
* Parse_Error Report a parse error, a warning or an informational
* message.
*
* Parse_MainName Populate the list of targets to create.
*/
/* Detects a multiple-inclusion guard in a makefile. */
typedef enum {
GS_START, /* at the beginning of the file */
GS_COND, /* after the guard condition */
GS_DONE, /* after the closing .endif */
GS_NO /* the file is not guarded */
} GuardState;
/* A file being parsed. */
typedef struct IncludedFile {
FStr name; /* absolute or relative to the cwd */
unsigned lineno; /* 1-based */
unsigned readLines; /* the number of physical lines that have
* been read from the file */
unsigned forHeadLineno; /* 1-based */
unsigned forBodyReadLines; /* the number of physical lines that have
* been read from the file above the body of
* the .for loop */
unsigned condMinDepth; /* depth of nested 'if' directives, at the
* beginning of the file */
bool depending; /* state of doing_depend on EOF */
Buffer buf; /* the file's content or the body of the .for
* loop; either empty or ends with '\n' */
char *buf_ptr; /* next char to be read from buf */
char *buf_end; /* buf_end[-1] == '\n' */
GuardState guardState;
Guard *guard;
struct ForLoop *forLoop;
} IncludedFile;
/* Special attributes for target nodes. */
typedef enum ParseSpecial {
SP_ATTRIBUTE, /* Generic attribute */
SP_BEGIN, /* .BEGIN */
SP_DEFAULT, /* .DEFAULT */
SP_DELETE_ON_ERROR, /* .DELETE_ON_ERROR */
SP_END, /* .END */
SP_ERROR, /* .ERROR */
SP_IGNORE, /* .IGNORE */
SP_INCLUDES, /* .INCLUDES; not mentioned in the manual page */
SP_INTERRUPT, /* .INTERRUPT */
SP_LIBS, /* .LIBS; not mentioned in the manual page */
SP_MAIN, /* .MAIN and no user-specified targets to make */
SP_META, /* .META */
SP_MFLAGS, /* .MFLAGS or .MAKEFLAGS */
SP_NOMETA, /* .NOMETA */
SP_NOMETA_CMP, /* .NOMETA_CMP */
SP_NOPATH, /* .NOPATH */
SP_NOREADONLY, /* .NOREADONLY */
SP_NOT, /* Not special */
SP_NOTPARALLEL, /* .NOTPARALLEL or .NO_PARALLEL */
SP_NULL, /* .NULL; not mentioned in the manual page */
SP_OBJDIR, /* .OBJDIR */
SP_ORDER, /* .ORDER */
SP_PARALLEL, /* .PARALLEL; not mentioned in the manual page */
SP_PATH, /* .PATH or .PATH.suffix */
SP_PHONY, /* .PHONY */
SP_POSIX, /* .POSIX; not mentioned in the manual page */
SP_PRECIOUS, /* .PRECIOUS */
SP_READONLY, /* .READONLY */
SP_SHELL, /* .SHELL */
SP_SILENT, /* .SILENT */
SP_SINGLESHELL, /* .SINGLESHELL; not mentioned in the manual page */
SP_STALE, /* .STALE */
SP_SUFFIXES, /* .SUFFIXES */
SP_SYSPATH, /* .SYSPATH */
SP_WAIT /* .WAIT */
} ParseSpecial;
typedef List SearchPathList;
typedef ListNode SearchPathListNode;
/*
* The target to be made if no targets are specified in the command line.
* This is the first target defined in any of the makefiles.
*/
GNode *mainNode;
/*
* During parsing, the targets from the left-hand side of the currently
* active dependency line, or NULL if the current line does not belong to a
* dependency line, for example because it is a variable assignment.
*
* See unit-tests/deptgt.mk, keyword "parse.c:targets".
*/
static GNodeList *targets;
#ifdef CLEANUP
/*
* All shell commands for all targets, in no particular order and possibly
* with duplicate values. Kept in a separate list since the commands from
* .USE or .USEBEFORE nodes are shared with other GNodes, thereby giving up
* the easily understandable ownership over the allocated strings.
*/
static StringList targCmds = LST_INIT;
#endif
/*
* Predecessor node for handling .ORDER. Initialized to NULL when .ORDER
* is seen, then set to each successive source on the line.
*/
static GNode *order_pred;
int parseErrors;
/*
* The include chain of makefiles. At index 0 is the top-level makefile from
* the command line, followed by the included files or .for loops, up to and
* including the current file.
*
* See PrintStackTrace for how to interpret the data.
*/
static Vector /* of IncludedFile */ includes;
SearchPath *parseIncPath; /* directories for "..." includes */
SearchPath *sysIncPath; /* directories for <...> includes */
SearchPath *defSysIncPath; /* default for sysIncPath */
/* The makefile or the body of a .for loop that is currently being read. */
static IncludedFile *
CurFile(void)
{
return GetInclude(includes.len - 1);
}
/*
* Print the current chain of .include and .for directives. In Parse_Fatal
* or other functions that already print the location, includingInnermost
* would be redundant, but in other cases like Error or Fatal it needs to be
* included.
*/
char *
GetStackTrace(bool includingInnermost)
{
const char *parentStackTrace;
Buffer buffer, *buf = &buffer;
const IncludedFile *entries;
size_t i, n;
bool hasDetails;
Buf_Init(buf);
hasDetails = EvalStack_Details(buf);
n = includes.len;
if (n == 0)
goto add_parent_stack_trace;
entries = GetInclude(0);
if (!includingInnermost && !(hasDetails && n > 1)
&& entries[n - 1].forLoop == NULL)
n--; /* already in the diagnostic */
/* Check if the current character is escaped on the current line. */
static bool
IsEscaped(const char *line, const char *p)
{
bool escaped = false;
while (p > line && *--p == '\\')
escaped = !escaped;
return escaped;
}
/*
* Remember the location (filename and lineno) where the last command was
* added or where the node was mentioned in a .depend file.
*/
static void
RememberLocation(GNode *gn)
{
IncludedFile *curFile = CurFile();
gn->fname = Str_Intern(curFile->name.str);
gn->lineno = curFile->lineno;
}
/*
* Look in the table of keywords for one matching the given string.
* Return the index of the keyword, or -1 if it isn't there.
*/
static int
FindKeyword(const char *str)
{
int start = 0;
int end = sizeof parseKeywords / sizeof parseKeywords[0] - 1;
while (start <= end) {
int curr = start + (end - start) / 2;
int diff = strcmp(str, parseKeywords[curr].name);
if (diff == 0)
return curr;
if (diff < 0)
end = curr - 1;
else
start = curr + 1;
}
/*
* Print a message, including location information.
*
* If the level is PARSE_FATAL, continue parsing until the end of the
* current top-level makefile, then exit (see Parse_File).
*
* Fmt is given without a trailing newline.
*/
void
Parse_Error(ParseErrorLevel level, const char *fmt, ...)
{
va_list ap;
static bool
TryApplyDependencyOperator(GNode *gn, GNodeType op)
{
/*
* If the node occurred on the left-hand side of a dependency and the
* operator also defines a dependency, they must match.
*/
if ((op & OP_OPMASK) && (gn->type & OP_OPMASK) &&
((op & OP_OPMASK) != (gn->type & OP_OPMASK))) {
Parse_Error(PARSE_FATAL, "Inconsistent operator for %s",
gn->name);
return false;
}
if (op == OP_DOUBLEDEP && (gn->type & OP_OPMASK) == OP_DOUBLEDEP) {
/*
* If the node was on the left-hand side of a '::' operator,
* create a new node for the children and commands on this
* dependency line, since each of these dependency groups has
* its own attributes and commands, separate from the others.
*
* The new instance is placed on the 'cohorts' list of the
* initial one (note the initial one is not on its own
* cohorts list) and the new instance is linked to all
* parents of the initial instance.
*/
GNode *cohort;
/*
* Propagate copied bits to the initial node. They'll be
* propagated back to the rest of the cohorts later.
*/
gn->type |= op & (unsigned)~OP_OPMASK;
cohort = Targ_NewInternalNode(gn->name);
if (doing_depend)
RememberLocation(cohort);
/*
* Make the cohort invisible to avoid duplicating it
* into other variables. True, parents of this target won't
* tend to do anything with their local variables, but better
* safe than sorry.
*
* (I think this is pointless now, since the relevant list
* traversals will no longer see this node anyway. -mycroft)
*/
cohort->type = op | OP_INVISIBLE;
Lst_Append(&gn->cohorts, cohort);
cohort->centurion = gn;
gn->unmade_cohorts++;
snprintf(cohort->cohort_num, sizeof cohort->cohort_num, "#%d",
(unsigned)gn->unmade_cohorts % 1000000);
} else {
gn->type |= op; /* preserve any previous flags */
}
for (ln = targets->first; ln != NULL; ln = ln->next)
if (!TryApplyDependencyOperator(ln->datum, op))
break;
}
/*
* Add a .WAIT node in the dependency list. After any dynamic dependencies
* (and filename globbing) have happened, it is given a dependency on each
* previous child, back until the previous .WAIT node. The next child won't
* be scheduled until the .WAIT node is built.
*
* Give each .WAIT node a unique name (mainly for diagnostics).
*/
static void
ApplyDependencySourceWait(bool isSpecial)
{
static unsigned wait_number = 0;
char name[6 + 10 + 1];
GNode *gn;
/*
* In a line like ".MAIN: source1 source2", add all sources to the list of
* things to create, but only if the user didn't specify a target on the
* command line and .MAIN occurs for the first time.
*
* See HandleDependencyTargetSpecial, branch SP_MAIN.
* See unit-tests/cond-func-make-main.mk.
*/
static void
ApplyDependencySourceMain(const char *src)
{
Lst_Append(&opts.create, bmake_strdup(src));
/*
* Add the name to the .TARGETS variable as well, so the user can
* employ that, if desired.
*/
Global_Append(".TARGETS", src);
}
/*
* For the sources of a .ORDER target, create predecessor/successor links
* between the previous source and the current one.
*/
static void
ApplyDependencySourceOrder(const char *src)
{
GNode *gn;
gn = Targ_GetNode(src);
if (doing_depend)
RememberLocation(gn);
if (order_pred != NULL) {
Lst_Append(&order_pred->order_succ, gn);
Lst_Append(&gn->order_pred, order_pred);
if (DEBUG(PARSE)) {
debug_printf(
"# .ORDER forces '%s' to be made before '%s'\n",
order_pred->name, gn->name);
Targ_PrintNode(order_pred, 0);
Targ_PrintNode(gn, 0);
}
}
/* The current source now becomes the predecessor for the next one. */
order_pred = gn;
}
/* The source is not an attribute, so find/create a node for it. */
static void
ApplyDependencySourceOther(const char *src, GNodeType targetAttr,
ParseSpecial special)
{
GNode *gn;
gn = Targ_GetNode(src);
if (doing_depend)
RememberLocation(gn);
if (targetAttr != OP_NONE)
gn->type |= targetAttr;
else
LinkToTargets(gn, special != SP_NOT);
}
/*
* Given the name of a source in a dependency line, figure out if it is an
* attribute (such as .SILENT) and if so, apply it to all targets. Otherwise
* decide if there is some attribute which should be applied *to* the source
* because of some special target (such as .PHONY) and apply it if so.
* Otherwise, make the source a child of the targets.
*/
static void
ApplyDependencySource(GNodeType targetAttr, const char *src,
ParseSpecial special)
{
if (ApplyDependencySourceKeyword(src, special))
return;
if (special == SP_MAIN)
ApplyDependencySourceMain(src);
else if (special == SP_ORDER)
ApplyDependencySourceOrder(src);
else
ApplyDependencySourceOther(src, targetAttr, special);
}
/*
* If we have yet to decide on a main target to make, in the absence of any
* user input, we want the first target on the first dependency line that is
* actually a real target (i.e. isn't a .USE or .EXEC rule) to be made.
*/
static void
MaybeUpdateMainTarget(void)
{
GNodeListNode *ln;
if (mainNode != NULL)
return;
for (ln = targets->first; ln != NULL; ln = ln->next) {
GNode *gn = ln->datum;
if (GNode_IsMainCandidate(gn)) {
DEBUG1(MAKE, "Setting main node to \"%s\"\n",
gn->name);
mainNode = gn;
return;
}
}
}
/*
* Handle special targets like .PATH, .DEFAULT, .BEGIN, .ORDER.
*
* See the tests deptgt-*.mk.
*/
static void
HandleDependencyTargetSpecial(const char *targetName,
ParseSpecial *inout_special,
SearchPathList **inout_paths)
{
switch (*inout_special) {
case SP_PATH:
if (*inout_paths == NULL)
*inout_paths = Lst_New();
Lst_Append(*inout_paths, &dirSearchPath);
break;
case SP_SYSPATH:
if (*inout_paths == NULL)
*inout_paths = Lst_New();
Lst_Append(*inout_paths, sysIncPath);
break;
case SP_MAIN:
/*
* Allow targets from the command line to override the
* .MAIN node.
*/
if (!Lst_IsEmpty(&opts.create))
*inout_special = SP_NOT;
break;
case SP_BEGIN:
case SP_END:
case SP_STALE:
case SP_ERROR:
case SP_INTERRUPT: {
GNode *gn = Targ_GetNode(targetName);
if (doing_depend)
RememberLocation(gn);
gn->type |= OP_NOTMAIN | OP_SPECIAL;
Lst_Append(targets, gn);
break;
}
case SP_DEFAULT: {
/*
* Need to create a node to hang commands on, but we don't
* want it in the graph, nor do we want it to be the Main
* Target. We claim the node is a transformation rule to make
* life easier later, when we'll use Make_HandleUse to
* actually apply the .DEFAULT commands.
*/
GNode *gn = GNode_New(".DEFAULT");
gn->type |= OP_NOTMAIN | OP_TRANSFORM;
Lst_Append(targets, gn);
defaultNode = gn;
break;
}
case SP_DELETE_ON_ERROR:
deleteOnError = true;
break;
case SP_NOTPARALLEL:
opts.maxJobs = 1;
break;
case SP_SINGLESHELL:
opts.compatMake = true;
break;
case SP_ORDER:
order_pred = NULL;
break;
default:
break;
}
}
path = Suff_GetPath(suffixName);
if (path == NULL) {
Parse_Error(PARSE_FATAL,
"Suffix '%s' not defined (yet)", suffixName);
return false;
}
if (*inout_paths == NULL)
*inout_paths = Lst_New();
Lst_Append(*inout_paths, path);
return true;
}
/* See if it's a special target and if so set inout_special to match it. */
static bool
HandleDependencyTarget(const char *targetName,
ParseSpecial *inout_special,
GNodeType *inout_targetAttr,
SearchPathList **inout_paths)
{
int keywd;
if (!(targetName[0] == '.' && ch_isupper(targetName[1])))
return true;
/*
* See if the target is a special target that must have it
* or its sources handled specially.
*/
keywd = FindKeyword(targetName);
if (keywd != -1) {
if (*inout_special == SP_PATH &&
parseKeywords[keywd].special != SP_PATH) {
Parse_Error(PARSE_FATAL, "Mismatched special targets");
return false;
}
static void
CheckSpecialMundaneMixture(ParseSpecial special)
{
switch (special) {
case SP_DEFAULT:
case SP_STALE:
case SP_BEGIN:
case SP_END:
case SP_ERROR:
case SP_INTERRUPT:
/*
* These create nodes on which to hang commands, so targets
* shouldn't be empty.
*/
case SP_NOT:
/* Nothing special here -- targets may be empty. */
break;
default:
Parse_Error(PARSE_WARNING,
"Special and mundane targets don't mix. "
"Mundane ones ignored");
break;
}
}
/*
* In a dependency line like 'targets: sources' or 'targets! sources', parse
* the operator ':', '::' or '!' from between the targets and the sources.
*/
static GNodeType
ParseDependencyOp(char **pp)
{
if (**pp == '!')
return (*pp)++, OP_FORCE;
if (**pp == ':' && (*pp)[1] == ':')
return *pp += 2, OP_DOUBLEDEP;
else if (**pp == ':')
return (*pp)++, OP_DEPENDS;
else
return OP_NONE;
}
skip:
DEBUG2(PARSE, "Skipping '%s' because '%s' is defined\n",
fullname, guard->name);
return true;
}
/*
* Handle one of the .[-ds]include directives by remembering the current file
* and pushing the included file on the stack. After the included file has
* finished, parsing continues with the including file; see Parse_PushInput
* and ParseEOF.
*
* System includes are looked up in sysIncPath, any other includes are looked
* up in the parsedir and then in the directories specified by the -I command
* line options.
*/
static void
IncludeFile(const char *file, bool isSystem, bool depinc, bool silent)
{
Buffer buf;
char *fullname; /* full pathname of file */
int fd;
if (fullname == NULL) {
if (!silent)
Parse_Error(PARSE_FATAL, "Could not find %s", file);
return;
}
if (SkipGuarded(fullname))
goto done;
if ((fd = open(fullname, O_RDONLY)) == -1) {
if (!silent)
Parse_Error(PARSE_FATAL, "Cannot open %s", fullname);
goto done;
}
buf = LoadFile(fullname, fd);
(void)close(fd);
Parse_PushInput(fullname, 1, 0, buf, NULL);
if (depinc)
doing_depend = depinc; /* only turn it on */
done:
free(fullname);
}
/* Handle a "dependency" line like '.SPECIAL:' without any sources. */
static void
HandleDependencySourcesEmpty(ParseSpecial special, SearchPathList *paths)
{
switch (special) {
case SP_SUFFIXES:
Suff_ClearSuffixes();
break;
case SP_PRECIOUS:
allPrecious = true;
break;
case SP_IGNORE:
opts.ignoreErrors = true;
break;
case SP_SILENT:
opts.silent = true;
break;
case SP_PATH:
case SP_SYSPATH:
ClearPaths(special, paths);
break;
case SP_POSIX:
if (posix_state == PS_NOW_OR_NEVER) {
/*
* With '-r', 'posix.mk' (if it exists)
* can effectively substitute for 'sys.mk',
* otherwise it is an extension.
*/
Global_Set("%POSIX", "1003.2");
posix_state = PS_SET;
IncludeFile("posix.mk", true, false, true);
}
break;
default:
break;
}
}
/*
* If the target was one that doesn't take files as its sources but takes
* something like suffixes, we take each space-separated word on the line as
* a something and deal with it accordingly.
*/
static void
ParseDependencySourceSpecial(ParseSpecial special, const char *word,
SearchPathList *paths)
{
switch (special) {
case SP_SUFFIXES:
Suff_AddSuffix(word);
break;
case SP_PATH:
case SP_SYSPATH:
AddToPaths(word, paths);
break;
case SP_INCLUDES:
Suff_AddInclude(word);
break;
case SP_LIBS:
Suff_AddLib(word);
break;
case SP_NOREADONLY:
Var_ReadOnly(word, false);
break;
case SP_NULL:
Suff_SetNull(word);
break;
case SP_OBJDIR:
Main_SetObjdir(false, "%s", word);
break;
case SP_READONLY:
Var_ReadOnly(word, true);
break;
default:
break;
}
}
/*
* If the word is followed by a left parenthesis, it's the
* name of one or more files inside an archive.
*/
if (!IsEscaped(lstart, p) && *p == '(') {
p = tgt;
if (!Arch_ParseArchive(&p, targets, SCOPE_CMDLINE)) {
Parse_Error(PARSE_FATAL,
"Error in archive specification: \"%s\"",
tgt);
return false;
}
continue;
}
if (*p == '\0') {
InvalidLineType(lstart, unexpanded_line);
return false;
}
if (!ApplyDependencyTarget(tgt, p, inout_special,
inout_targetAttr, inout_paths))
return false;
/*
* Check for local variable assignment,
* rest of the line is the value.
*/
if (Parse_IsVar(start, &var)) {
bool targetVarsEnabled = GetBooleanExpr(
"${.MAKE.TARGET_LOCAL_VARIABLES}", true);
if (targetVarsEnabled)
LinkVarToTargets(&var);
free(var.varname);
if (targetVarsEnabled)
return true;
}
/*
* The targets take real sources, so we must beware of archive
* specifications (i.e. things with left parentheses in them)
* and handle them accordingly.
*/
for (; *end != '\0' && !ch_isspace(*end); end++) {
if (*end == '(' && end > start && end[-1] != '$') {
/*
* Only stop for a left parenthesis if it
* isn't at the start of a word (that'll be
* for variable changes later) and isn't
* preceded by a dollar sign (a dynamic
* source).
*/
break;
}
}
if (*end == '(') {
GNodeList sources = LST_INIT;
if (!Arch_ParseArchive(&start, &sources,
SCOPE_CMDLINE)) {
Parse_Error(PARSE_FATAL,
"Error in source archive spec \"%s\"",
start);
return false;
}
while (!Lst_IsEmpty(&sources)) {
GNode *gn = Lst_Dequeue(&sources);
ApplyDependencySource(targetAttr, gn->name,
special);
}
Lst_Done(&sources);
end = start;
} else {
if (*end != '\0') {
*end = '\0';
end++;
}
/*
* From a dependency line like 'targets: sources', parse the sources.
*
* See the tests depsrc-*.mk.
*/
static void
ParseDependencySources(char *p, GNodeType targetAttr,
ParseSpecial special, SearchPathList **inout_paths)
{
if (*p == '\0') {
HandleDependencySourcesEmpty(special, *inout_paths);
} else if (special == SP_MFLAGS) {
Main_ParseArgLine(p);
return;
} else if (special == SP_SHELL) {
if (!Job_ParseShell(p)) {
Parse_Error(PARSE_FATAL,
"improper shell specification");
return;
}
return;
} else if (special == SP_NOTPARALLEL || special == SP_SINGLESHELL ||
special == SP_DELETE_ON_ERROR) {
return;
}
switch (special) {
case SP_INCLUDES:
case SP_LIBS:
case SP_NOREADONLY:
case SP_NULL:
case SP_OBJDIR:
case SP_PATH:
case SP_READONLY:
case SP_SUFFIXES:
case SP_SYSPATH:
ParseDependencySourcesSpecial(p, special, *inout_paths);
if (*inout_paths != NULL) {
Lst_Free(*inout_paths);
*inout_paths = NULL;
}
if (special == SP_PATH)
Dir_SetPATH();
if (special == SP_SYSPATH)
Dir_SetSYSPATH();
break;
default:
assert(*inout_paths == NULL);
if (!ParseDependencySourcesMundane(p, special, targetAttr))
return;
break;
}
MaybeUpdateMainTarget();
}
/*
* Parse a dependency line consisting of targets, followed by a dependency
* operator, optionally followed by sources.
*
* The nodes of the sources are linked as children to the nodes of the
* targets. Nodes are created as necessary.
*
* The operator is applied to each node in the global 'targets' list,
* which is where the nodes found for the targets are kept.
*
* The sources are parsed in much the same way as the targets, except
* that they are expanded using the wildcarding scheme of the C-Shell,
* and a target is created for each expanded word. Each of the resulting
* nodes is then linked to each of the targets as one of its children.
*
* Certain targets and sources such as .PHONY or .PRECIOUS are handled
* specially, see ParseSpecial.
*
* Transformation rules such as '.c.o' are also handled here, see
* Suff_AddTransform.
*
* Upon return, the value of expandedLine is unspecified.
*/
static void
ParseDependency(char *expandedLine, const char *unexpandedLine)
{
char *p;
SearchPathList *paths; /* search paths to alter when parsing a list
* of .PATH targets */
GNodeType targetAttr; /* from special sources */
ParseSpecial special; /* in special targets, the children are
* linked as children of the parent but not
* vice versa */
GNodeType op;
DEBUG1(PARSE, "ParseDependency(%s)\n", expandedLine);
p = expandedLine;
paths = NULL;
targetAttr = OP_NONE;
special = SP_NOT;
if (!ParseDependencyTargets(&p, expandedLine, &special, &targetAttr,
&paths, unexpandedLine))
goto out;
if (!Lst_IsEmpty(targets))
CheckSpecialMundaneMixture(special);
op = ParseDependencyOp(&p);
if (op == OP_NONE) {
InvalidLineType(expandedLine, unexpandedLine);
goto out;
}
ApplyDependencyOperator(op);
/*
* Parse a variable assignment, consisting of a single-word variable name,
* optional whitespace, an assignment operator, optional whitespace and the
* variable value.
*
* Note: There is a lexical ambiguity with assignment modifier characters
* in variable names. This routine interprets the character before the =
* as a modifier. Therefore, an assignment like
* C++=/usr/bin/CC
* is interpreted as "C+ +=" instead of "C++ =".
*
* Used for both lines in a file and command line arguments.
*/
static bool
Parse_IsVar(const char *p, VarAssign *out_var)
{
const char *nameStart, *nameEnd, *firstSpace, *eq;
int level = 0;
cpp_skip_hspace(&p); /* Skip to variable name */
/*
* During parsing, the '+' of the operator '+=' is initially parsed
* as part of the variable name. It is later corrected, as is the
* ':sh' modifier. Of these two (nameEnd and eq), the earlier one
* determines the actual end of the variable name.
*/
nameStart = p;
firstSpace = NULL;
/* Scan for one of the assignment operators outside an expression. */
while (*p != '\0') {
char ch = *p++;
if (ch == '(' || ch == '{') {
level++;
continue;
}
if (ch == ')' || ch == '}') {
level--;
continue;
}
if (level != 0)
continue;
if ((ch == ' ' || ch == '\t') && firstSpace == NULL)
firstSpace = p - 1;
while (ch == ' ' || ch == '\t')
ch = *p++;
if (ch == '\0')
return false;
if (ch == ':' && p[0] == 's' && p[1] == 'h') {
p += 2;
continue;
}
if (ch == '=')
eq = p - 1;
else if (*p == '=' &&
(ch == '+' || ch == ':' || ch == '?' || ch == '!'))
eq = p;
else if (firstSpace != NULL)
return false;
else
continue;
/*
* Check for syntax errors such as unclosed expressions or unknown modifiers.
*/
static void
VarCheckSyntax(VarAssignOp op, const char *uvalue, GNode *scope)
{
if (opts.strict) {
if (op != VAR_SUBST && strchr(uvalue, '$') != NULL) {
char *parsedValue = Var_Subst(uvalue,
scope, VARE_PARSE);
/* TODO: handle errors */
free(parsedValue);
}
}
}
/* Perform a variable assignment that uses the operator ':='. */
static void
VarAssign_EvalSubst(GNode *scope, const char *name, const char *uvalue,
FStr *out_avalue)
{
char *evalue;
/*
* Make sure that we set the variable the first time to nothing
* so that it gets substituted.
*
* TODO: Add a test that demonstrates why this code is needed,
* apart from making the debug log longer.
*
* XXX: The variable name is expanded up to 3 times.
*/
if (!Var_ExistsExpand(scope, name))
Var_SetExpand(scope, name, "");
/*
* Perform a variable assignment.
*
* The actual value of the variable is returned in *out_true_avalue.
* Especially for VAR_SUBST and VAR_SHELL this can differ from the literal
* value.
*
* Return whether the assignment was actually performed, which is usually
* the case. It is only skipped if the operator is '?=' and the variable
* already exists.
*/
static bool
VarAssign_Eval(const char *name, VarAssignOp op, const char *uvalue,
GNode *scope, FStr *out_true_avalue)
{
FStr avalue = FStr_InitRefer(uvalue);
if (op == VAR_APPEND)
Var_AppendExpand(scope, name, uvalue);
else if (op == VAR_SUBST)
VarAssign_EvalSubst(scope, name, uvalue, &avalue);
else if (op == VAR_SHELL)
VarAssign_EvalShell(name, uvalue, scope, &avalue);
else {
/* XXX: The variable name is expanded up to 2 times. */
if (op == VAR_DEFAULT && Var_ExistsExpand(scope, name))
return false;
/* Normal assignment -- just do it. */
Var_SetExpand(scope, name, uvalue);
}
*out_true_avalue = avalue;
return true;
}
static void
VarAssignSpecial(const char *name, const char *avalue)
{
if (strcmp(name, ".MAKEOVERRIDES") == 0)
Main_ExportMAKEFLAGS(false); /* re-export MAKEFLAGS */
else if (strcmp(name, ".CURDIR") == 0) {
/*
* Someone is being (too?) clever...
* Let's pretend they know what they are doing and
* re-initialize the 'cur' CachedDir.
*/
Dir_InitCur(avalue);
Dir_SetPATH();
} else if (strcmp(name, ".MAKE.JOB.PREFIX") == 0)
Job_SetPrefix();
else if (strcmp(name, ".MAKE.EXPORTED") == 0)
Var_ExportVars(avalue);
}
/* Perform the variable assignment in the given scope. */
static void
Parse_Var(VarAssign *var, GNode *scope)
{
FStr avalue; /* actual value (maybe expanded) */
/*
* See if the command possibly calls a sub-make by using the
* expressions ${.MAKE}, ${MAKE} or the plain word "make".
*/
static bool
MaybeSubMake(const char *cmd)
{
const char *start;
/*
* Return the immediately including file.
*
* This is made complicated since the .for loop is implemented as a special
* kind of .include; see For_Run.
*/
static const char *
GetActuallyIncludingFile(void)
{
size_t i;
const IncludedFile *incs = GetInclude(0);
for (i = includes.len; i >= 2; i--)
if (incs[i - 1].forLoop == NULL)
return incs[i - 2].name.str;
return NULL;
}
/* Set .PARSEDIR, .PARSEFILE, .INCLUDEDFROMDIR and .INCLUDEDFROMFILE. */
static void
SetParseFile(const char *filename)
{
const char *including;
/*
* XXX: Searching through a set of words with this linear search is
* inefficient for variables that contain thousands of words.
*
* XXX: The paths in this list don't seem to be normalized in any way.
*/
static bool
VarContainsWord(const char *varname, const char *word)
{
FStr val = Var_Value(SCOPE_GLOBAL, varname);
bool found = val.str != NULL && StrContainsWord(val.str, word);
FStr_Done(&val);
return found;
}
/*
* Track the makefiles we read - so makefiles can set dependencies on them.
* Avoid adding anything more than once.
*
* Time complexity: O(n) per call, in total O(n^2), where n is the number
* of makefiles that have been loaded.
*/
static void
TrackInput(const char *name)
{
if (!VarContainsWord(".MAKE.MAKEFILES", name))
Global_Append(".MAKE.MAKEFILES", name);
}
/* Parse from the given buffer, later return to the current file. */
void
Parse_PushInput(const char *name, unsigned lineno, unsigned readLines,
Buffer buf, struct ForLoop *forLoop)
{
IncludedFile *curFile;
if (forLoop != NULL)
name = CurFile()->name.str;
else
TrackInput(name);
/* Check if the directive is an include directive. */
static bool
IsInclude(const char *dir, bool sysv)
{
if (dir[0] == 's' || dir[0] == '-' || (dir[0] == 'd' && !sysv))
dir++;
if (strncmp(dir, "include", 7) != 0)
return false;
/* Space is not mandatory for BSD .include */
return !sysv || ch_isspace(dir[7]);
}
/* Check if the line is a SYSV include directive. */
static bool
IsSysVInclude(const char *line)
{
const char *p;
if (!IsInclude(line, true))
return false;
/* Avoid interpreting a dependency line as an include */
for (p = line; (p = strchr(p, ':')) != NULL;) {
/* end of line -> it's a dependency */
if (*++p == '\0')
return false;
/* '::' operator or ': ' -> it's a dependency */
if (*p == ':' || ch_isspace(*p))
return false;
}
return true;
}
/* Push to another file. The line points to the word "include". */
static void
ParseTraditionalInclude(char *line)
{
char *p; /* current position in file spec */
bool done = false;
bool silent = line[0] != 'i';
char *file = line + (silent ? 8 : 7);
char *all_files;
for (file = all_files; !done; file = p + 1) {
/* Skip to end of line or next whitespace */
for (p = file; *p != '\0' && !ch_isspace(*p); p++)
continue;
if (*p != '\0')
*p = '\0';
else
done = true;
IncludeFile(file, false, false, silent);
}
free(all_files);
}
/* Parse "export <variable>=<value>", and actually export it. */
static void
ParseGmakeExport(char *line)
{
char *variable = line + 6;
char *value;
if (*value != '=') {
Parse_Error(PARSE_FATAL,
"Variable/Value missing from \"export\"");
return;
}
*value++ = '\0'; /* terminate variable */
/*
* Expand the value before putting it in the environment.
*/
value = Var_Subst(value, SCOPE_CMDLINE, VARE_EVAL);
/* TODO: handle errors */
setenv(variable, value, 1);
free(value);
}
/*
* When the end of the current file or .for loop is reached, continue reading
* the previous file at the previous location.
*
* Results:
* true to continue parsing, i.e. it had only reached the end of an
* included file, false if the main file has been parsed completely.
*/
static bool
ParseEOF(void)
{
IncludedFile *curFile = CurFile();
FStr_Done(&curFile->name);
Buf_Done(&curFile->buf);
if (curFile->forLoop != NULL)
ForLoop_Free(curFile->forLoop);
Vector_Pop(&includes);
if (includes.len == 0) {
/* We've run out of input */
Global_Delete(".PARSEDIR");
Global_Delete(".PARSEFILE");
Global_Delete(".INCLUDEDFROMDIR");
Global_Delete(".INCLUDEDFROMFILE");
return false;
}
/*
* Parse until the end of a line, taking into account lines that end with
* backslash-newline. The resulting line goes from out_line to out_line_end;
* the line is not null-terminated.
*/
static ParseRawLineResult
ParseRawLine(IncludedFile *curFile, char **out_line, char **out_line_end,
char **out_firstBackslash, char **out_commentLineEnd)
{
char *line = curFile->buf_ptr;
char *buf_end = curFile->buf_end;
char *p = line;
char *line_end = line;
char *firstBackslash = NULL;
char *commentLineEnd = NULL;
ParseRawLineResult res = PRLR_LINE;
/* Treat next character after '\' as literal. */
if (ch == '\\') {
if (firstBackslash == NULL)
firstBackslash = p;
if (p[1] == '\n') {
curFile->readLines++;
if (p + 2 == buf_end) {
line_end = p;
*line_end = '\n';
p += 2;
continue;
}
}
p += 2;
line_end = p;
assert(p <= buf_end);
continue;
}
/*
* Remember the first '#' for comment stripping, unless
* the previous char was '[', as in the modifier ':[#]'.
*/
if (ch == '#' && commentLineEnd == NULL &&
!(p > line && p[-1] == '['))
commentLineEnd = line_end;
p++;
if (ch == '\n')
break;
/* We are not interested in trailing whitespace. */
if (!ch_isspace(ch))
line_end = p;
}
/*
* Beginning at start, unescape '\#' to '#' and replace backslash-newline
* with a single space.
*/
static void
UnescapeBackslash(char *line, char *start)
{
const char *src = start;
char *dst = start;
char *spaceStart = line;
for (;;) {
char ch = *src++;
if (ch != '\\') {
if (ch == '\0')
break;
*dst++ = ch;
continue;
}
ch = *src++;
if (ch == '\0') {
/* Delete '\\' at the end of the buffer. */
dst--;
break;
}
/* Delete '\\' from before '#' on non-command lines. */
if (ch == '#' && line[0] != '\t')
*dst++ = ch;
else if (ch == '\n') {
cpp_skip_hspace(&src);
*dst++ = ' ';
} else {
/* Leave '\\' in the buffer for later. */
*dst++ = '\\';
*dst++ = ch;
/* Keep an escaped ' ' at the line end. */
spaceStart = dst;
}
}
/* Delete any trailing spaces - eg from empty continuations */
while (dst > spaceStart && ch_isspace(dst[-1]))
dst--;
*dst = '\0';
}
typedef enum LineKind {
/*
* Return the next line that is neither empty nor a comment.
* Backslash line continuations are folded into a single space.
* A trailing comment, if any, is discarded.
*/
LK_NONEMPTY,
/*
* Return the next line, even if it is empty or a comment.
* Preserve backslash-newline to keep the line numbers correct.
*
* Used in .for loops to collect the body of the loop while waiting
* for the corresponding .endfor.
*/
LK_FOR_BODY,
/*
* Return the next line that starts with a dot.
* Backslash line continuations are folded into a single space.
* A trailing comment, if any, is discarded.
*
* Used in .if directives to skip over irrelevant branches while
* waiting for the corresponding .endif.
*/
LK_DOT
} LineKind;
/*
* Return the next "interesting" logical line from the current file. The
* returned string will be freed at the end of including the file.
*/
static char *
ReadLowLevelLine(LineKind kind)
{
IncludedFile *curFile = CurFile();
ParseRawLineResult res;
char *line;
char *line_end;
char *firstBackslash;
char *commentLineEnd;
for (;;) {
curFile->lineno = curFile->readLines + 1;
res = ParseRawLine(curFile,
&line, &line_end, &firstBackslash, &commentLineEnd);
if (res == PRLR_ERROR)
return NULL;
if (line == line_end || line == commentLineEnd) {
if (res == PRLR_EOF)
return NULL;
if (kind != LK_FOR_BODY)
continue;
}
/* We now have a line of data */
assert(ch_isspace(*line_end));
*line_end = '\0';
if (kind == LK_FOR_BODY)
return line; /* Don't join the physical lines. */
/* Accumulate the loop body until the matching '.endfor'. */
forLevel = 1;
do {
line = ReadLowLevelLine(LK_FOR_BODY);
if (line == NULL) {
Parse_Error(PARSE_FATAL,
"Unexpected end of file in .for loop");
break;
}
} while (For_Accum(line, &forLevel));
/*
* Read an entire line from the input file.
*
* Empty lines, .if and .for are handled by this function, while variable
* assignments, other directives, dependency lines and shell commands are
* handled by the caller.
*
* Return a line without trailing whitespace, or NULL for EOF. The returned
* string will be freed at the end of including the file.
*/
static char *
ReadHighLevelLine(void)
{
char *line;
CondResult condResult;
for (;;) {
IncludedFile *curFile = CurFile();
line = ReadLowLevelLine(LK_NONEMPTY);
if (posix_state == PS_MAYBE_NEXT_LINE)
posix_state = PS_NOW_OR_NEVER;
else if (posix_state != PS_SET)
posix_state = PS_TOO_LATE;
if (line == NULL)
return NULL;
/*
* Mark the target as already having commands if it does, to
* keep from having shell commands on multiple dependency
* lines.
*/
if (!Lst_IsEmpty(&gn->commands))
gn->type |= OP_HAS_COMMANDS;
}
/* Add the command to each target from the current dependency spec. */
static void
ParseLine_ShellCommand(const char *p)
{
cpp_skip_whitespace(&p);
if (*p == '\0')
return; /* skip empty commands */
if (arg[0] != '\0')
Parse_Error(PARSE_FATAL,
"The .break directive does not take arguments");
if (curFile->forLoop != NULL) {
/* pretend we reached EOF */
For_Break(curFile->forLoop);
cond_depth = CurFile_CondMinDepth();
ParseEOF();
} else
Parse_Error(PARSE_FATAL, "break outside of for loop");
}
/*
* See if the line starts with one of the known directives, and if so, handle
* the directive.
*/
static bool
ParseDirective(char *line)
{
char *p = line + 1;
const char *arg;
Substring dir;
pp_skip_whitespace(&p);
if (IsInclude(p, false)) {
ParseInclude(p);
return true;
}
/* Populate the list with the single main target to create, or error out. */
void
Parse_MainName(GNodeList *mainList)
{
if (mainNode == NULL)
Punt("no target to make.");
Lst_Append(mainList, mainNode);
if (mainNode->type & OP_DOUBLEDEP)
Lst_AppendAll(mainList, &mainNode->cohorts);
