// Copyright 2014 The Bazel Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package com.google.devtools.build.lib.rules.cpp;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Predicate;
import com.google.common.collect.ImmutableCollection;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Iterables;
import com.google.common.collect.Sets;
import com.google.devtools.build.lib.actions.AbstractAction;
import com.google.devtools.build.lib.actions.ActionExecutionContext;
import com.google.devtools.build.lib.actions.ActionExecutionException;
import com.google.devtools.build.lib.actions.ActionLookupValue;
import com.google.devtools.build.lib.actions.ActionLookupValue.ActionLookupKey;
import com.google.devtools.build.lib.actions.ActionOwner;
import com.google.devtools.build.lib.actions.ActionStatusMessage;
import com.google.devtools.build.lib.actions.Artifact;
import com.google.devtools.build.lib.actions.Artifact.ArtifactExpander;
import com.google.devtools.build.lib.actions.ArtifactResolver;
import com.google.devtools.build.lib.actions.CommandAction;
import com.google.devtools.build.lib.actions.ExecException;
import com.google.devtools.build.lib.actions.ExecutionInfoSpecifier;
import com.google.devtools.build.lib.actions.Executor;
import com.google.devtools.build.lib.actions.ResourceSet;
import com.google.devtools.build.lib.actions.extra.CppCompileInfo;
import com.google.devtools.build.lib.actions.extra.EnvironmentVariable;
import com.google.devtools.build.lib.actions.extra.ExtraActionInfo;
import com.google.devtools.build.lib.analysis.actions.ExecutionRequirements;
import com.google.devtools.build.lib.cmdline.Label;
import com.google.devtools.build.lib.collect.CollectionUtils;
import com.google.devtools.build.lib.collect.nestedset.NestedSet;
import com.google.devtools.build.lib.collect.nestedset.NestedSetBuilder;
import com.google.devtools.build.lib.collect.nestedset.Order;
import com.google.devtools.build.lib.concurrent.ThreadSafety.ThreadCompatible;
import com.google.devtools.build.lib.events.Event;
import com.google.devtools.build.lib.events.EventHandler;
import com.google.devtools.build.lib.profiler.Profiler;
import com.google.devtools.build.lib.profiler.ProfilerTask;
import com.google.devtools.build.lib.rules.cpp.CcToolchainFeatures.FeatureConfiguration;
import com.google.devtools.build.lib.rules.cpp.CppCompileActionContext.Reply;
import com.google.devtools.build.lib.rules.cpp.CppConfiguration.Tool;
import com.google.devtools.build.lib.util.DependencySet;
import com.google.devtools.build.lib.util.Fingerprint;
import com.google.devtools.build.lib.util.Pair;
import com.google.devtools.build.lib.util.Preconditions;
import com.google.devtools.build.lib.util.ShellEscaper;
import com.google.devtools.build.lib.vfs.FileSystemUtils;
import com.google.devtools.build.lib.vfs.Path;
import com.google.devtools.build.lib.vfs.PathFragment;
import com.google.devtools.build.skyframe.SkyFunction;
import com.google.devtools.build.skyframe.SkyKey;
import com.google.devtools.build.skyframe.SkyValue;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
import java.util.UUID;
import javax.annotation.Nullable;
/** Action that represents some kind of C++ compilation step. */
@ThreadCompatible
public class CppCompileAction extends AbstractAction
implements IncludeScannable, ExecutionInfoSpecifier, CommandAction {
/**
* Represents logic that determines if an artifact is a special input, meaning that it may require
* additional inputs when it is compiled or may not be available to other actions.
*/
public interface SpecialInputsHandler {
/** Returns if {@code includedFile} is special, so may not be available to other actions. */
boolean isSpecialFile(Artifact includedFile);
/** Returns the set of files to be added for an included file (as returned in the .d file). */
Collection<Artifact> getInputsForIncludedFile(
Artifact includedFile, ArtifactResolver artifactResolver);
}
static final SpecialInputsHandler VOID_SPECIAL_INPUTS_HANDLER =
new SpecialInputsHandler() {
@Override
public boolean isSpecialFile(Artifact includedFile) {
return false;
}
@Override
public Collection<Artifact> getInputsForIncludedFile(
Artifact includedFile, ArtifactResolver artifactResolver) {
return ImmutableList.of();
}
};
private static final PathFragment BUILD_PATH_FRAGMENT = PathFragment.create("BUILD");
private static final int VALIDATION_DEBUG = 0; // 0==none, 1==warns/errors, 2==all
private static final boolean VALIDATION_DEBUG_WARN = VALIDATION_DEBUG >= 1;
/**
* A string constant for the c compilation action.
*/
public static final String C_COMPILE = "c-compile";
/**
* A string constant for the c++ compilation action.
*/
public static final String CPP_COMPILE = "c++-compile";
/** A string constant for the c++ module compile action. */
public static final String CPP_MODULE_CODEGEN = "c++-module-codegen";
/**
* A string constant for the objc compilation action.
*/
public static final String OBJC_COMPILE = "objc-compile";
/**
* A string constant for the objc++ compile action.
*/
public static final String OBJCPP_COMPILE = "objc++-compile";
/**
* A string constant for the c++ header parsing.
*/
public static final String CPP_HEADER_PARSING = "c++-header-parsing";
/**
* A string constant for the c++ header preprocessing.
*/
public static final String CPP_HEADER_PREPROCESSING = "c++-header-preprocessing";
/**
* A string constant for the c++ module compilation action.
* Note: currently we don't support C module compilation.
*/
public static final String CPP_MODULE_COMPILE = "c++-module-compile";
/**
* A string constant for the assembler actions.
*/
public static final String ASSEMBLE = "assemble";
public static final String PREPROCESS_ASSEMBLE = "preprocess-assemble";
/**
* A string constant for the clif actions. Bazel enables different features of the toolchain based
* on the name of the action. This name enables the clif_matcher feature, which switches the
* "compiler" to the clif_matcher and adds some additional arguments as described in the CROSSTOOL
* file.
*/
public static final String CLIF_MATCH = "clif-match";
private final ImmutableMap<String, String> localShellEnvironment;
protected final Artifact outputFile;
private final Artifact sourceFile;
private final Artifact optionalSourceFile;
private final NestedSet<Artifact> mandatoryInputs;
/**
* The set of input files that we add to the set of input artifacts of the action if we don't use
* input discovery. They may be pruned after execution.
*
* <p>This is necessary because the inputs that can be pruned by .d file parsing must be returned
* from {@link #discoverInputs(ActionExecutionContext)} and they cannot be in
* {@link #mandatoryInputs}. Thus, even with include scanning turned off, we pretend that we
* "discover" these headers.
*/
private final NestedSet<Artifact> prunableInputs;
private final boolean shouldScanIncludes;
private final boolean shouldPruneModules;
private final boolean usePic;
private final boolean useHeaderModules;
private final CppCompilationContext context;
private final Iterable<IncludeScannable> lipoScannables;
private final ImmutableList<Artifact> builtinIncludeFiles;
// A list of files to include scan that are not source files, pcm files, lipo scannables, or
// included via a command-line "-include file.h". Actions that use non C++ files as source
// files--such as Clif--may use this mechanism.
private final ImmutableList<Artifact> additionalIncludeScannables;
@VisibleForTesting public final CompileCommandLine compileCommandLine;
private final ImmutableMap<String, String> executionInfo;
private final ImmutableMap<String, String> environment;
@VisibleForTesting final CppConfiguration cppConfiguration;
private final FeatureConfiguration featureConfiguration;
protected final Class<? extends CppCompileActionContext> actionContext;
protected final SpecialInputsHandler specialInputsHandler;
protected final CppSemantics cppSemantics;
/**
* Identifier for the actual execution time behavior of the action.
*
* <p>Required because the behavior of this class can be modified by injecting code in the
* constructor or by inheritance, and we want to have different cache keys for those.
*/
private final UUID actionClassId;
/** Whether this action needs to discover inputs. */
private final boolean discoversInputs;
private final ImmutableList<PathFragment> builtInIncludeDirectories;
/**
* Set when the action prepares for execution. Used to preserve state between preparation and
* execution.
*/
private Iterable<Artifact> additionalInputs = null;
/** Set when a two-stage input discovery is used. */
private Collection<Artifact> usedModules = null;
/** Used modules that are not transitively used through other topLevelModules. */
private Iterable<Artifact> topLevelModules = null;
private CcToolchainFeatures.Variables overwrittenVariables = null;
private ImmutableList<Artifact> resolvedInputs = ImmutableList.<Artifact>of();
/**
* Creates a new action to compile C/C++ source files.
*
* @param owner the owner of the action, usually the configured target that emitted it
* @param allInputs the list of all action inputs.
* @param features TODO(bazel-team): Add parameter description.
* @param featureConfiguration TODO(bazel-team): Add parameter description.
* @param variables TODO(bazel-team): Add parameter description.
* @param sourceFile the source file that should be compiled. {@code mandatoryInputs} must contain
* this file
* @param shouldScanIncludes a boolean indicating whether scanning of {@code sourceFile} is to be
* performed looking for inclusions.
* @param usePic TODO(bazel-team): Add parameter description.
* @param sourceLabel the label of the rule the source file is generated by
* @param mandatoryInputs any additional files that need to be present for the compilation to
* succeed, can be empty but not null, for example, extra sources for FDO.
* @param outputFile the object file that is written as result of the compilation, or the fake
* object for {@link FakeCppCompileAction}s
* @param dotdFile the .d file that is generated as a side-effect of compilation
* @param gcnoFile the coverage notes that are written in coverage mode, can be null
* @param dwoFile the .dwo output file where debug information is stored for Fission builds (null
* if Fission mode is disabled)
* @param optionalSourceFile an additional optional source file (null if unneeded)
* @param cppConfiguration TODO(bazel-team): Add parameter description.
* @param context the compilation context
* @param actionContext TODO(bazel-team): Add parameter description.
* @param copts options for the compiler
* @param coptsFilter regular expression to remove options from {@code copts}
* @param specialInputsHandler TODO(bazel-team): Add parameter description.
* @param lipoScannables List of artifacts to include-scan when this action is a lipo action
* @param additionalIncludeScannables list of additional artifacts to include-scan
* @param actionClassId TODO(bazel-team): Add parameter description
* @param environment TODO(bazel-team): Add parameter description
* @param actionName a string giving the name of this action for the purpose of toolchain
* evaluation
* @param cppSemantics C++ compilation semantics
* @param cppProvider - CcToolchainProvider with configuration-dependent information.
*/
protected CppCompileAction(
ActionOwner owner,
NestedSet<Artifact> allInputs,
// TODO(bazel-team): Eventually we will remove 'features'; all functionality in 'features'
// will be provided by 'featureConfiguration'.
ImmutableList<String> features,
FeatureConfiguration featureConfiguration,
CcToolchainFeatures.Variables variables,
Artifact sourceFile,
boolean shouldScanIncludes,
boolean shouldPruneModules,
boolean usePic,
boolean useHeaderModules,
Label sourceLabel,
NestedSet<Artifact> mandatoryInputs,
NestedSet<Artifact> prunableInputs,
Artifact outputFile,
DotdFile dotdFile,
@Nullable Artifact gcnoFile,
@Nullable Artifact dwoFile,
@Nullable Artifact ltoIndexingFile,
Artifact optionalSourceFile,
ImmutableMap<String, String> localShellEnvironment,
CppConfiguration cppConfiguration,
CppCompilationContext context,
Class<? extends CppCompileActionContext> actionContext,
ImmutableList<String> copts,
Predicate<String> coptsFilter,
SpecialInputsHandler specialInputsHandler,
Iterable<IncludeScannable> lipoScannables,
ImmutableList<Artifact> additionalIncludeScannables,
UUID actionClassId,
ImmutableMap<String, String> executionInfo,
ImmutableMap<String, String> environment,
String actionName,
CppSemantics cppSemantics,
CcToolchainProvider cppProvider) {
super(
owner,
allInputs,
CollectionUtils.asListWithoutNulls(
outputFile,
(dotdFile == null ? null : dotdFile.artifact()),
gcnoFile,
dwoFile,
ltoIndexingFile));
this.localShellEnvironment = localShellEnvironment;
this.sourceFile = sourceFile;
this.outputFile = Preconditions.checkNotNull(outputFile);
this.optionalSourceFile = optionalSourceFile;
this.context = context;
this.specialInputsHandler = specialInputsHandler;
this.cppConfiguration = cppConfiguration;
this.featureConfiguration = featureConfiguration;
// inputsKnown begins as the logical negation of shouldScanIncludes.
// When scanning includes, the inputs begin as not known, and become
// known after inclusion scanning. When *not* scanning includes,
// the inputs are as declared, hence known, and remain so.
this.shouldScanIncludes = shouldScanIncludes;
this.shouldPruneModules = shouldPruneModules;
// We can only prune modules if include scanning is enabled.
Preconditions.checkArgument(!shouldPruneModules || shouldScanIncludes, this);
this.usePic = usePic;
this.useHeaderModules = useHeaderModules;
this.discoversInputs = shouldScanIncludes || cppSemantics.needsDotdInputPruning();
this.compileCommandLine =
new CompileCommandLine(
sourceFile,
outputFile,
sourceLabel,
copts,
coptsFilter,
features,
featureConfiguration,
cppConfiguration,
variables,
actionName,
dotdFile,
cppProvider);
this.actionContext = actionContext;
this.lipoScannables = lipoScannables;
this.actionClassId = actionClassId;
this.executionInfo = executionInfo;
this.environment = environment;
// We do not need to include the middleman artifact since it is a generated
// artifact and will definitely exist prior to this action execution.
this.mandatoryInputs = mandatoryInputs;
this.prunableInputs = prunableInputs;
this.builtinIncludeFiles = ImmutableList.copyOf(cppProvider.getBuiltinIncludeFiles());
this.cppSemantics = cppSemantics;
this.additionalIncludeScannables = ImmutableList.copyOf(additionalIncludeScannables);
this.builtInIncludeDirectories =
ImmutableList.copyOf(cppProvider.getBuiltInIncludeDirectories());
}
/**
* Whether we should do "include scanning". Note that this does *not* mean whether we should parse
* the .d files to determine which include files were used during compilation. Instead, this means
* whether we should a) run the pre-execution include scanner (see {@code IncludeScanningContext})
* if one exists and b) whether the action inputs should be modified to match the results of that
* pre-execution scanning and (if enabled) again after execution to match the results of the .d
* file parsing.
*
* <p>This does *not* have anything to do with "hdrs_check".
*/
public boolean shouldScanIncludes() {
return shouldScanIncludes;
}
@Override
public List<PathFragment> getBuiltInIncludeDirectories() {
return builtInIncludeDirectories;
}
@Nullable
@Override
public List<Artifact> getBuiltInIncludeFiles() {
return builtinIncludeFiles;
}
@Override
public NestedSet<Artifact> getMandatoryInputs() {
return mandatoryInputs;
}
@Override
public ImmutableSet<Artifact> getMandatoryOutputs() {
// Never prune orphaned modules files. To cut down critical paths, CppCompileActions do not
// add modules files as inputs. Instead they rely on input discovery to recognize the needed
// ones. However, orphan detection runs before input discovery and thus module files would be
// discarded as orphans.
// This is strictly better than marking all transitive modules as inputs, which would also
// effectively disable orphan detection for .pcm files.
if (CppFileTypes.CPP_MODULE.matches(outputFile.getFilename())) {
return ImmutableSet.of(outputFile);
}
return super.getMandatoryOutputs();
}
/**
* Returns the list of additional inputs found by dependency discovery, during action preparation,
* and clears the stored list. {@link #prepare} must be called before this method is called, on
* each action execution.
*/
public Iterable<Artifact> getAdditionalInputs() {
Iterable<Artifact> result = Preconditions.checkNotNull(additionalInputs);
additionalInputs = null;
return result;
}
@VisibleForTesting
public void setResolvedInputsForTesting(ImmutableList<Artifact> resolvedInputs) {
this.resolvedInputs = resolvedInputs;
}
@Override
public boolean discoversInputs() {
return discoversInputs;
}
@VisibleForTesting // productionVisibility = Visibility.PRIVATE
public Iterable<Artifact> getPossibleInputsForTesting() {
return Iterables.concat(getInputs(), prunableInputs);
}
@Nullable
@Override
public Iterable<Artifact> discoverInputs(ActionExecutionContext actionExecutionContext)
throws ActionExecutionException, InterruptedException {
Executor executor = actionExecutionContext.getExecutor();
Iterable<Artifact> initialResult;
actionExecutionContext
.getExecutor()
.getEventBus()
.post(ActionStatusMessage.analysisStrategy(this));
try {
initialResult =
executor
.getContext(actionContext)
.findAdditionalInputs(
this, actionExecutionContext, cppSemantics.getIncludeProcessing());
} catch (ExecException e) {
throw e.toActionExecutionException(
"Include scanning of rule '" + getOwner().getLabel() + "'",
executor.getVerboseFailures(),
this);
}
if (initialResult == null) {
NestedSetBuilder<Artifact> result = NestedSetBuilder.stableOrder();
if (useHeaderModules) {
// Here, we cannot really know what the top-level modules are, so we just mark all
// transitive modules as "top level".
topLevelModules = Sets.newLinkedHashSet(context.getTransitiveModules(usePic)
.toCollection());
result.addTransitive(context.getTransitiveModules(usePic));
}
result.addTransitive(prunableInputs);
additionalInputs = result.build();
return result.build();
}
Set<Artifact> initialResultSet = Sets.newLinkedHashSet(initialResult);
if (shouldPruneModules) {
if (CppFileTypes.CPP_MODULE.matches(sourceFile.getFilename())) {
usedModules = ImmutableSet.of(sourceFile);
initialResultSet.add(sourceFile);
} else {
usedModules = Sets.newLinkedHashSet();
topLevelModules = null;
for (CppCompilationContext.TransitiveModuleHeaders usedModule :
context.getUsedModules(usePic, initialResultSet)) {
usedModules.add(usedModule.getModule());
}
initialResultSet.addAll(usedModules);
}
}
initialResult = initialResultSet;
this.additionalInputs = initialResult;
// In some cases, execution backends need extra files for each included file. Add them
// to the set of inputs the caller may need to be aware of.
Collection<Artifact> result = new HashSet<>();
ArtifactResolver artifactResolver =
executor.getContext(IncludeScanningContext.class).getArtifactResolver();
for (Artifact artifact : initialResult) {
result.addAll(specialInputsHandler.getInputsForIncludedFile(artifact, artifactResolver));
}
for (Artifact artifact : getInputs()) {
result.addAll(specialInputsHandler.getInputsForIncludedFile(artifact, artifactResolver));
}
// TODO(ulfjack): This only works if include scanning is enabled; the cleanup is in progress,
// and this needs to be fixed before we can even consider disabling it.
resolvedInputs = ImmutableList.copyOf(result);
Iterables.addAll(result, initialResult);
return Preconditions.checkNotNull(result);
}
@Override
public Iterable<Artifact> discoverInputsStage2(SkyFunction.Environment env)
throws ActionExecutionException, InterruptedException {
if (this.usedModules == null) {
return null;
}
Map<Artifact, SkyKey> skyKeys = new HashMap<>();
for (Artifact artifact : this.usedModules) {
skyKeys.put(artifact, ActionLookupValue.key((ActionLookupKey) artifact.getArtifactOwner()));
}
Map<SkyKey, SkyValue> skyValues = env.getValues(skyKeys.values());
Set<Artifact> additionalModules = Sets.newLinkedHashSet();
for (Artifact artifact : this.usedModules) {
SkyKey skyKey = skyKeys.get(artifact);
ActionLookupValue value = (ActionLookupValue) skyValues.get(skyKey);
Preconditions.checkNotNull(
value, "Owner %s of %s not in graph %s", artifact.getArtifactOwner(), artifact, skyKey);
// We can get the generating action here because #canRemoveAfterExecution is overridden.
Preconditions.checkState(
CppFileTypes.CPP_MODULE.matches(artifact.getFilename()),
"Non-module? %s (%s %s)",
artifact,
this,
value);
CppCompileAction action =
(CppCompileAction) value.getGeneratingActionDangerousReadJavadoc(artifact);
for (Artifact input : action.getInputs()) {
if (CppFileTypes.CPP_MODULE.matches(input.getFilename())) {
additionalModules.add(input);
}
}
}
ImmutableSet.Builder<Artifact> topLevelModules = ImmutableSet.builder();
for (Artifact artifact : this.usedModules) {
if (!additionalModules.contains(artifact)) {
topLevelModules.add(artifact);
}
}
this.topLevelModules = topLevelModules.build();
this.additionalInputs =
new ImmutableList.Builder<Artifact>()
.addAll(this.additionalInputs)
.addAll(additionalModules)
.build();
this.usedModules = null;
return additionalModules;
}
@Override
public Artifact getPrimaryInput() {
return getSourceFile();
}
@Override
public Artifact getPrimaryOutput() {
return getOutputFile();
}
/**
* Returns the path of the c/cc source for gcc.
*/
public final Artifact getSourceFile() {
return compileCommandLine.getSourceFile();
}
/**
* Returns the path where gcc should put its result.
*/
public Artifact getOutputFile() {
return outputFile;
}
protected PathFragment getInternalOutputFile() {
return outputFile.getExecPath();
}
@Override
public Map<Artifact, Artifact> getLegalGeneratedScannerFileMap() {
Map<Artifact, Artifact> legalOuts = new HashMap<>();
for (Artifact a : context.getDeclaredIncludeSrcs()) {
if (!a.isSourceArtifact()) {
legalOuts.put(a, null);
}
}
for (Pair<Artifact, Artifact> pregreppedSrcs : context.getPregreppedHeaders()) {
Artifact hdr = pregreppedSrcs.getFirst();
Preconditions.checkState(!hdr.isSourceArtifact(), hdr);
legalOuts.put(hdr, pregreppedSrcs.getSecond());
}
return Collections.unmodifiableMap(legalOuts);
}
/**
* Returns the path where gcc should put the discovered dependency
* information.
*/
public DotdFile getDotdFile() {
return compileCommandLine.getDotdFile();
}
@VisibleForTesting
public CppCompilationContext getContext() {
return context;
}
@Override
public List<PathFragment> getQuoteIncludeDirs() {
return context.getQuoteIncludeDirs();
}
@Override
public List<PathFragment> getIncludeDirs() {
ImmutableList.Builder<PathFragment> result = ImmutableList.builder();
result.addAll(context.getIncludeDirs());
for (String opt : compileCommandLine.getCopts()) {
if (opt.startsWith("-I") && opt.length() > 2) {
// We insist on the combined form "-Idir".
result.add(PathFragment.create(opt.substring(2)));
}
}
return result.build();
}
@Override
public List<PathFragment> getSystemIncludeDirs() {
// TODO(bazel-team): parsing the command line flags here couples us to gcc-style compiler
// command lines; use a different way to specify system includes (for example through a
// system_includes attribute in cc_toolchain); note that that would disallow users from
// specifying system include paths via the copts attribute.
// Currently, this works together with the include_paths features because getCommandLine() will
// get the system include paths from the CppCompilationContext instead.
ImmutableList.Builder<PathFragment> result = ImmutableList.builder();
List<String> compilerOptions = getCompilerOptions();
for (int i = 0; i < compilerOptions.size(); i++) {
String opt = compilerOptions.get(i);
if (opt.startsWith("-isystem")) {
if (opt.length() > 8) {
result.add(PathFragment.create(opt.substring(8).trim()));
} else if (i + 1 < compilerOptions.size()) {
i++;
result.add(PathFragment.create(compilerOptions.get(i)));
} else {
System.err.println("WARNING: dangling -isystem flag in options for " + prettyPrint());
}
}
}
return result.build();
}
@Override
public List<String> getCmdlineIncludes() {
ImmutableList.Builder<String> cmdlineIncludes = ImmutableList.builder();
List<String> args = getArgv();
for (Iterator<String> argi = args.iterator(); argi.hasNext();) {
String arg = argi.next();
if (arg.equals("-include") && argi.hasNext()) {
cmdlineIncludes.add(argi.next());
}
}
return cmdlineIncludes.build();
}
@Override
public Artifact getMainIncludeScannerSource() {
return CppFileTypes.CPP_MODULE_MAP.matches(getSourceFile().getPath())
? Iterables.getFirst(context.getHeaderModuleSrcs(), null)
: getSourceFile();
}
@Override
public Collection<Artifact> getIncludeScannerSources() {
NestedSetBuilder<Artifact> builder = NestedSetBuilder.stableOrder();
if (CppFileTypes.CPP_MODULE_MAP.matches(getSourceFile().getPath())) {
// If this is an action that compiles the header module itself, the source we build is the
// module map, and we need to include-scan all headers that are referenced in the module map.
// We need to do include scanning as long as we want to support building code bases that are
// not fully strict layering clean.
builder.addAll(context.getHeaderModuleSrcs());
} else {
builder.add(getSourceFile());
builder.addAll(additionalIncludeScannables);
}
return builder.build().toCollection();
}
@Override
public Iterable<IncludeScannable> getAuxiliaryScannables() {
return lipoScannables;
}
/**
* Returns the list of "-D" arguments that should be used by this gcc
* invocation. Only used for testing.
*/
@VisibleForTesting
public ImmutableCollection<String> getDefines() {
return context.getDefines();
}
@Override
public ImmutableMap<String, String> getEnvironment() {
Map<String, String> environment = new LinkedHashMap<>(localShellEnvironment);
if (!getExecutionInfo().containsKey(ExecutionRequirements.REQUIRES_DARWIN)) {
// Linux: this prevents gcc/clang from writing the unpredictable (and often irrelevant) value
// of getcwd() into the debug info. Not applicable to Darwin or Windows, which have no /proc.
environment.put("PWD", "/proc/self/cwd");
}
environment.putAll(this.environment);
environment.putAll(compileCommandLine.getEnvironment());
return ImmutableMap.copyOf(environment);
}
/**
* Returns a new, mutable list of command and arguments (argv) to be passed
* to the gcc subprocess.
*/
public final List<String> getArgv() {
return getArgv(getInternalOutputFile());
}
@Override
public List<String> getArguments() {
return getArgv();
}
protected final List<String> getArgv(PathFragment outputFile) {
return compileCommandLine.getArgv(outputFile, overwrittenVariables);
}
@Override
public boolean canRemoveAfterExecution() {
// Module-generating actions are needed because the action may be retrieved in
// #discoverInputsStage2.
return !CppFileTypes.CPP_MODULE.matches(getPrimaryOutput().getFilename());
}
@Override
public boolean extraActionCanAttach() {
return cppConfiguration.alwaysAttachExtraActions()
|| !specialInputsHandler.isSpecialFile(getPrimaryInput());
}
@Override
public ExtraActionInfo.Builder getExtraActionInfo() {
CppCompileInfo.Builder info = CppCompileInfo.newBuilder();
info.setTool(cppConfiguration.getToolPathFragment(Tool.GCC).getPathString());
for (String option : getCompilerOptions()) {
info.addCompilerOption(option);
}
info.setOutputFile(outputFile.getExecPathString());
info.setSourceFile(getSourceFile().getExecPathString());
if (inputsDiscovered()) {
info.addAllSourcesAndHeaders(Artifact.toExecPaths(getInputs()));
} else {
info.addSourcesAndHeaders(getSourceFile().getExecPathString());
info.addAllSourcesAndHeaders(
Artifact.toExecPaths(context.getDeclaredIncludeSrcs()));
}
for (Entry<String, String> envVariable : getEnvironment().entrySet()) {
info.addVariable(
EnvironmentVariable.newBuilder()
.setName(envVariable.getKey())
.setValue(envVariable.getValue())
.build());
}
return super.getExtraActionInfo()
.setExtension(CppCompileInfo.cppCompileInfo, info.build());
}
/**
* Returns the compiler options.
*/
@VisibleForTesting
public List<String> getCompilerOptions() {
return compileCommandLine.getCompilerOptions(/*updatedVariables=*/ null);
}
@Override
public ImmutableMap<String, String> getExecutionInfo() {
return executionInfo;
}
/**
* Enforce that the includes actually visited during the compile were properly
* declared in the rules.
*
* <p>The technique is to walk through all of the reported includes that gcc
* emits into the .d file, and verify that they came from acceptable
* relative include directories. This is done in two steps:
*
* <p>First, each included file is stripped of any include path prefix from
* {@code quoteIncludeDirs} to produce an effective relative include dir+name.
*
* <p>Second, the remaining directory is looked up in {@code declaredIncludeDirs},
* a list of acceptable dirs. This list contains a set of dir fragments that
* have been calculated by the configured target to be allowable for inclusion
* by this source. If no match is found, an error is reported and an exception
* is thrown.
*
* @throws ActionExecutionException iff there was an undeclared dependency
*/
@VisibleForTesting
public void validateInclusions(
Iterable<Artifact> inputsForValidation,
ArtifactExpander artifactExpander,
EventHandler eventHandler)
throws ActionExecutionException {
IncludeProblems errors = new IncludeProblems();
IncludeProblems warnings = new IncludeProblems();
Set<Artifact> allowedIncludes = new HashSet<>();
for (Artifact input : Iterables.concat(mandatoryInputs, prunableInputs)) {
if (input.isMiddlemanArtifact() || input.isTreeArtifact()) {
artifactExpander.expand(input, allowedIncludes);
}
allowedIncludes.add(input);
}
allowedIncludes.addAll(resolvedInputs);
if (optionalSourceFile != null) {
allowedIncludes.add(optionalSourceFile);
}
Iterable<PathFragment> ignoreDirs =
cppConfiguration.isStrictSystemIncludes()
? getBuiltInIncludeDirectories()
: getValidationIgnoredDirs();
// Copy the sets to hash sets for fast contains checking.
// Avoid immutable sets here to limit memory churn.
Set<PathFragment> declaredIncludeDirs = Sets.newHashSet(context.getDeclaredIncludeDirs());
Set<PathFragment> warnIncludeDirs = Sets.newHashSet(context.getDeclaredIncludeWarnDirs());
Set<Artifact> declaredIncludeSrcs = Sets.newHashSet(getDeclaredIncludeSrcs());
Set<Artifact> transitiveModules = Sets.newHashSet(context.getTransitiveModules(usePic));
for (Artifact input : inputsForValidation) {
if (context.getTransitiveCompilationPrerequisites().contains(input)
|| transitiveModules.contains(input)
|| allowedIncludes.contains(input)) {
continue; // ignore our fixed source in mandatoryInput: we just want includes
}
// Ignore headers from built-in include directories.
if (FileSystemUtils.startsWithAny(input.getExecPath(), ignoreDirs)) {
continue;
}
if (!isDeclaredIn(input, declaredIncludeDirs, declaredIncludeSrcs)) {
// This call can never match the declared include sources (they would be matched above).
// There are no declared include sources we need to warn about, so use an empty set here.
if (isDeclaredIn(input, warnIncludeDirs, ImmutableSet.<Artifact>of())) {
warnings.add(input.getPath().toString());
} else {
errors.add(input.getPath().toString());
}
}
}
if (VALIDATION_DEBUG_WARN) {
synchronized (System.err) {
if (VALIDATION_DEBUG >= 2 || errors.hasProblems() || warnings.hasProblems()) {
if (errors.hasProblems()) {
System.err.println("ERROR: Include(s) were not in declared srcs:");
} else if (warnings.hasProblems()) {
System.err.println("WARN: Include(s) were not in declared srcs:");
} else {
System.err.println("INFO: Include(s) were OK for '" + getSourceFile()
+ "', declared srcs:");
}
for (Artifact a : context.getDeclaredIncludeSrcs()) {
System.err.println(" '" + a.toDetailString() + "'");
}
System.err.println(" or under declared dirs:");
for (PathFragment f : Sets.newTreeSet(context.getDeclaredIncludeDirs())) {
System.err.println(" '" + f + "'");
}
System.err.println(" or under declared warn dirs:");
for (PathFragment f : Sets.newTreeSet(context.getDeclaredIncludeWarnDirs())) {
System.err.println(" '" + f + "'");
}
System.err.println(" with prefixes:");
for (PathFragment dirpath : context.getQuoteIncludeDirs()) {
System.err.println(" '" + dirpath + "'");
}
}
}
}
if (warnings.hasProblems()) {
eventHandler.handle(
Event.warn(
getOwner().getLocation(),
warnings.getMessage(this, getSourceFile()))
.withTag(Label.print(getOwner().getLabel())));
}
errors.assertProblemFree(this, getSourceFile());
}
Iterable<PathFragment> getValidationIgnoredDirs() {
List<PathFragment> cxxSystemIncludeDirs = getBuiltInIncludeDirectories();
return Iterables.concat(
cxxSystemIncludeDirs, context.getSystemIncludeDirs());
}
/**
* Returns true if an included artifact is declared in a set of allowed
* include directories. The simple case is that the artifact's parent
* directory is contained in the set, or is empty.
*
* <p>This check also supports a wildcard suffix of '**' for the cases where the
* calculations are inexact.
*
* <p>It also handles unseen non-nested-package subdirs by walking up the path looking
* for matches.
*/
private static boolean isDeclaredIn(
Artifact input, Set<PathFragment> declaredIncludeDirs, Set<Artifact> declaredIncludeSrcs) {
// First check if it's listed in "srcs". If so, then its declared & OK.
if (declaredIncludeSrcs.contains(input)) {
return true;
}
// If it's a derived artifact, then it MUST be listed in "srcs" as checked above.
// We define derived here as being not source and not under the include link tree.
if (!input.isSourceArtifact()
&& !input.getRoot().getExecPath().getBaseName().equals("include")) {
return false;
}
// Need to do dir/package matching: first try a quick exact lookup.
PathFragment includeDir = input.getRootRelativePath().getParentDirectory();
if (includeDir.segmentCount() == 0 || declaredIncludeDirs.contains(includeDir)) {
return true; // OK: quick exact match.
}
// Not found in the quick lookup: try the wildcards.
for (PathFragment declared : declaredIncludeDirs) {
if (declared.getBaseName().equals("**")) {
if (includeDir.startsWith(declared.getParentDirectory())) {
return true; // OK: under a wildcard dir.
}
}
}
// Still not found: see if it is in a subdir of a declared package.
Path root = input.getRoot().getPath();
for (Path dir = input.getPath().getParentDirectory();;) {
if (dir.getRelative(BUILD_PATH_FRAGMENT).exists()) {
return false; // Bad: this is a sub-package, not a subdir of a declared package.
}
dir = dir.getParentDirectory();
if (dir.equals(root)) {
return false; // Bad: at the top, give up.
}
if (declaredIncludeDirs.contains(dir.relativeTo(root))) {
return true; // OK: found under a declared dir.
}
}
}
/**
* Recalculates this action's live input collection, including sources, middlemen.
*
* @throws ActionExecutionException iff any errors happen during update.
*/
@VisibleForTesting // productionVisibility = Visibility.PRIVATE
@ThreadCompatible
public final void updateActionInputs(NestedSet<Artifact> discoveredInputs)
throws ActionExecutionException {
NestedSetBuilder<Artifact> inputs = NestedSetBuilder.stableOrder();
Profiler.instance().startTask(ProfilerTask.ACTION_UPDATE, this);
try {
inputs.addTransitive(mandatoryInputs);
if (optionalSourceFile != null) {
inputs.add(optionalSourceFile);
}
inputs.addTransitive(discoveredInputs);
updateInputs(inputs.build());
} finally {
Profiler.instance().completeTask(ProfilerTask.ACTION_UPDATE);
}
}
/** Sets module file flags based on the action's inputs. */
protected void setModuleFileFlags() {
if (useHeaderModules) {
// If modules pruning is used, modules will be supplied via topLevelModules, otherwise they
// are regular inputs.
if (shouldPruneModules) {
Preconditions.checkNotNull(this.topLevelModules);
overwrittenVariables = getOverwrittenVariables(topLevelModules);
} else {
overwrittenVariables = getOverwrittenVariables(getInputs());
}
}
}
/**
* Extracts all module (.pcm) files from potentialModules and returns a Variables object where
* their exec paths are added to the value "module_files".
*/
private static CcToolchainFeatures.Variables getOverwrittenVariables(
Iterable<Artifact> potentialModules) {
ImmutableList.Builder<String> usedModulePaths = ImmutableList.builder();
for (Artifact input : potentialModules) {
if (CppFileTypes.CPP_MODULE.matches(input.getFilename())) {
usedModulePaths.add(input.getExecPathString());
}
}
CcToolchainFeatures.Variables.Builder variableBuilder =
new CcToolchainFeatures.Variables.Builder();
variableBuilder.addStringSequenceVariable("module_files", usedModulePaths.build());
return variableBuilder.build();
}
@Override
public Iterable<Artifact> getAllowedDerivedInputs() {
return getAllowedDerivedInputsMap().values();
}
protected Map<PathFragment, Artifact> getAllowedDerivedInputsMap() {
Map<PathFragment, Artifact> allowedDerivedInputMap = new HashMap<>();
addToMap(allowedDerivedInputMap, mandatoryInputs);
addToMap(allowedDerivedInputMap, prunableInputs);
addToMap(allowedDerivedInputMap, getDeclaredIncludeSrcs());
addToMap(allowedDerivedInputMap, context.getTransitiveCompilationPrerequisites());
addToMap(allowedDerivedInputMap, context.getTransitiveModules(usePic));
Artifact artifact = getSourceFile();
if (!artifact.isSourceArtifact()) {
allowedDerivedInputMap.put(artifact.getExecPath(), artifact);
}
return allowedDerivedInputMap;
}
private void addToMap(Map<PathFragment, Artifact> map, Iterable<Artifact> artifacts) {
for (Artifact artifact : artifacts) {
if (!artifact.isSourceArtifact()) {
map.put(artifact.getExecPath(), artifact);
}
}
}
@Override
protected String getRawProgressMessage() {
return "Compiling " + getSourceFile().prettyPrint();
}
/**
* Return the directories in which to look for headers (pertains to headers
* not specifically listed in {@code declaredIncludeSrcs}). The return value
* may contain duplicate elements.
*/
public NestedSet<PathFragment> getDeclaredIncludeDirs() {
return context.getDeclaredIncludeDirs();
}
/**
* Return the directories in which to look for headers and issue a warning.
* (pertains to headers not specifically listed in {@code
* declaredIncludeSrcs}). The return value may contain duplicate elements.
*/
public NestedSet<PathFragment> getDeclaredIncludeWarnDirs() {
return context.getDeclaredIncludeWarnDirs();
}
/**
* Return explicit header files (i.e., header files explicitly listed). The
* return value may contain duplicate elements.
*/
@Override
public NestedSet<Artifact> getDeclaredIncludeSrcs() {
if (lipoScannables != null && lipoScannables.iterator().hasNext()) {
NestedSetBuilder<Artifact> srcs = NestedSetBuilder.stableOrder();
srcs.addTransitive(context.getDeclaredIncludeSrcs());
for (IncludeScannable lipoScannable : lipoScannables) {
srcs.addTransitive(lipoScannable.getDeclaredIncludeSrcs());
}
return srcs.build();
}
return context.getDeclaredIncludeSrcs();
}
@VisibleForTesting
public Class<? extends CppCompileActionContext> getActionContext() {
return actionContext;
}
/**
* Estimate resource consumption when this action is executed locally.
*/
public ResourceSet estimateResourceConsumptionLocal() {
// We use a local compile, so much of the time is spent waiting for IO,
// but there is still significant CPU; hence we estimate 50% cpu usage.
return ResourceSet.createWithRamCpuIo(/*memoryMb=*/200, /*cpuUsage=*/0.5, /*ioUsage=*/0.0);
}
@Override
public String computeKey() {
Fingerprint f = new Fingerprint();
f.addUUID(actionClassId);
f.addStringMap(getEnvironment());
f.addStringMap(executionInfo);
// For the argv part of the cache key, ignore all compiler flags that explicitly denote module
// file (.pcm) inputs. Depending on input discovery, some of the unused ones are removed from
// the command line. However, these actually don't have an influence on the compile itself and
// so ignoring them for the cache key calculation does not affect correctness. The compile
// itself is fully determined by the input source files and module maps.
// A better long-term solution would be to make the compiler to find them automatically and
// never hand in the .pcm files explicitly on the command line in the first place.
f.addStrings(compileCommandLine.getArgv(getInternalOutputFile(), null));
/*
* getArgv() above captures all changes which affect the compilation
* command and hence the contents of the object file. But we need to
* also make sure that we reexecute the action if any of the fields
* that affect whether validateIncludes() will report an error or warning
* have changed, otherwise we might miss some errors.
*/
f.addPaths(context.getDeclaredIncludeDirs());
f.addPaths(context.getDeclaredIncludeWarnDirs());
for (Artifact declaredIncludeSrc : context.getDeclaredIncludeSrcs()) {
f.addPath(declaredIncludeSrc.getExecPath());
}
f.addInt(0); // mark the boundary between input types
for (Artifact input : getMandatoryInputs()) {
f.addPath(input.getExecPath());
}
f.addInt(0);
for (Artifact input : prunableInputs) {
f.addPath(input.getExecPath());
}
return f.hexDigestAndReset();
}
@Override
@ThreadCompatible
public void execute(
ActionExecutionContext actionExecutionContext)
throws ActionExecutionException, InterruptedException {
setModuleFileFlags();
Executor executor = actionExecutionContext.getExecutor();
CppCompileActionContext.Reply reply;
ShowIncludesFilter showIncludesFilter = null;
// If parse_showincludes feature is enabled, instead of parsing dotD file we parse the output of
// cl.exe caused by /showIncludes option.
if (featureConfiguration.isEnabled(CppRuleClasses.PARSE_SHOWINCLUDES)) {
showIncludesFilter = new ShowIncludesFilter(getSourceFile().getFilename());
actionExecutionContext.getFileOutErr().setOutputFilter(showIncludesFilter);
}
try {
reply = executor.getContext(actionContext).execWithReply(this, actionExecutionContext);
} catch (ExecException e) {
throw e.toActionExecutionException("C++ compilation of rule '" + getOwner().getLabel() + "'",
executor.getVerboseFailures(), this);
}
ensureCoverageNotesFilesExist();
// This is the .d file scanning part.
IncludeScanningContext scanningContext = executor.getContext(IncludeScanningContext.class);
Path execRoot = executor.getExecRoot();
NestedSet<Artifact> discoveredInputs;
if (showIncludesFilter != null) {
discoveredInputs =
discoverInputsFromShowIncludesFilter(
execRoot, scanningContext.getArtifactResolver(), showIncludesFilter);
} else {
discoveredInputs =
discoverInputsFromDotdFiles(execRoot, scanningContext.getArtifactResolver(), reply);
}
reply = null; // Clear in-memory .d files early.
// Post-execute "include scanning", which modifies the action inputs to match what the compile
// action actually used by incorporating the results of .d file parsing.
updateActionInputs(discoveredInputs);
// hdrs_check: This cannot be switched off for C++ build actions,
// because doing so would allow for incorrect builds.
// HeadersCheckingMode.NONE should only be used for ObjC build actions.
if (cppSemantics.needsIncludeValidation()) {
validateInclusions(
discoveredInputs,
actionExecutionContext.getArtifactExpander(),
executor.getEventHandler());
}
}
@VisibleForTesting
public NestedSet<Artifact> discoverInputsFromShowIncludesFilter(
Path execRoot, ArtifactResolver artifactResolver, ShowIncludesFilter showIncludesFilter)
throws ActionExecutionException {
if (!cppSemantics.needsDotdInputPruning()) {
return NestedSetBuilder.emptySet(Order.STABLE_ORDER);
}
HeaderDiscovery.Builder discoveryBuilder =
new HeaderDiscovery.Builder()
.setAction(this)
.setSourceFile(getSourceFile())
.setSpecialInputsHandler(specialInputsHandler)
.setDependencies(showIncludesFilter.getDependencies(execRoot))
.setPermittedSystemIncludePrefixes(getPermittedSystemIncludePrefixes(execRoot))
.setAllowedDerivedinputsMap(getAllowedDerivedInputsMap());
if (cppSemantics.needsIncludeValidation()) {
discoveryBuilder.shouldValidateInclusions();
}
return discoveryBuilder.build().discoverInputsFromDependencies(execRoot, artifactResolver);
}
@VisibleForTesting
public NestedSet<Artifact> discoverInputsFromDotdFiles(
Path execRoot, ArtifactResolver artifactResolver, Reply reply)
throws ActionExecutionException {
if (!cppSemantics.needsDotdInputPruning() || getDotdFile() == null) {
return NestedSetBuilder.emptySet(Order.STABLE_ORDER);
}
HeaderDiscovery.Builder discoveryBuilder =
new HeaderDiscovery.Builder()
.setAction(this)
.setSourceFile(getSourceFile())
.setSpecialInputsHandler(specialInputsHandler)
.setDependencies(processDepset(execRoot, reply).getDependencies())
.setPermittedSystemIncludePrefixes(getPermittedSystemIncludePrefixes(execRoot))
.setAllowedDerivedinputsMap(getAllowedDerivedInputsMap());
if (cppSemantics.needsIncludeValidation()) {
discoveryBuilder.shouldValidateInclusions();
}
return discoveryBuilder.build().discoverInputsFromDependencies(execRoot, artifactResolver);
}
public DependencySet processDepset(Path execRoot, Reply reply) throws ActionExecutionException {
try {
DotdFile dotdFile = getDotdFile();
Preconditions.checkNotNull(dotdFile);
DependencySet depSet = new DependencySet(execRoot);
// artifact() is null if we are using in-memory .d files. We also want to prepare for the
// case where we expected an in-memory .d file, but we did not get an appropriate response.
// Perhaps we produced the file locally.
if (dotdFile.artifact() != null || reply == null) {
return depSet.read(dotdFile.getPath());
} else {
// This is an in-memory .d file.
return depSet.process(reply.getContents());
}
} catch (IOException e) {
// Some kind of IO or parse exception--wrap & rethrow it to stop the build.
throw new ActionExecutionException("error while parsing .d file", e, this, false);
}
}
public List<Path> getPermittedSystemIncludePrefixes(Path execRoot) {
List<Path> systemIncludePrefixes = new ArrayList<>();
for (PathFragment includePath : getBuiltInIncludeDirectories()) {
if (includePath.isAbsolute()) {
systemIncludePrefixes.add(execRoot.getFileSystem().getPath(includePath));
}
}
return systemIncludePrefixes;
}
/**
* Gcc only creates ".gcno" files if the compilation unit is non-empty.
* To ensure that the set of outputs for a CppCompileAction remains consistent
* and doesn't vary dynamically depending on the _contents_ of the input files,
* we create empty ".gcno" files if gcc didn't create them.
*/
private void ensureCoverageNotesFilesExist() throws ActionExecutionException {
for (Artifact output : getOutputs()) {
if (CppFileTypes.COVERAGE_NOTES.matches(output.getFilename()) // ".gcno"
&& !output.getPath().exists()) {
try {
FileSystemUtils.createEmptyFile(output.getPath());
} catch (IOException e) {
throw new ActionExecutionException(
"Error creating file '" + output.getPath() + "': " + e.getMessage(), e, this, false);
}
}
}
}
/**
* When compiling with modules, the C++ compile action only has the {@code .pcm} files on its
* inputs, which is not enough for extra actions that parse header files. Thus, re-run include
* scanning and add headers to the inputs of the extra action, too.
*/
@Override
public Iterable<Artifact> getInputFilesForExtraAction(
ActionExecutionContext actionExecutionContext)
throws ActionExecutionException, InterruptedException {
Iterable<Artifact> scannedIncludes;
try {
scannedIncludes = actionExecutionContext.getExecutor().getContext(actionContext)
.findAdditionalInputs(this, actionExecutionContext, cppSemantics.getIncludeProcessing());
} catch (ExecException e) {
throw e.toActionExecutionException(this);
}
if (scannedIncludes == null) {
return ImmutableList.of();
}
return Sets.<Artifact>difference(
ImmutableSet.<Artifact>copyOf(scannedIncludes), ImmutableSet.<Artifact>copyOf(getInputs()));
}
@Override
public String getMnemonic() {
if (CppFileTypes.OBJC_SOURCE.matches(sourceFile.getExecPath())
|| CppFileTypes.OBJCPP_SOURCE.matches(sourceFile.getExecPath())) {
return "ObjcCompile";
} else {
return "CppCompile";
}
}
@Override
public String describeKey() {
StringBuilder message = new StringBuilder();
message.append(getProgressMessage());
message.append('\n');
// Outputting one argument per line makes it easier to diff the results.
// The first element in getArgv() is actually the command to execute.
String legend = " Command: ";
for (String argument : ShellEscaper.escapeAll(getArgv())) {
message.append(legend);
message.append(argument);
message.append('\n');
legend = " Argument: ";
}
for (PathFragment path : context.getDeclaredIncludeDirs()) {
message.append(" Declared include directory: ");
message.append(ShellEscaper.escapeString(path.getPathString()));
message.append('\n');
}
for (Artifact src : getDeclaredIncludeSrcs()) {
message.append(" Declared include source: ");
message.append(ShellEscaper.escapeString(src.getExecPathString()));
message.append('\n');
}
return message.toString();
}
/**
* A reference to a .d file. There are two modes:
* <ol>
* <li>an Artifact that represents a real on-disk file
* <li>just an execPath that refers to a virtual .d file that is not written to disk
* </ol>
*/
public static class DotdFile {
private final Artifact artifact;
private final PathFragment execPath;
public DotdFile(Artifact artifact) {
this.artifact = artifact;
this.execPath = null;
}
public DotdFile(PathFragment execPath) {
this.artifact = null;
this.execPath = execPath;
}
/**
* @return the Artifact or null
*/
public Artifact artifact() {
return artifact;
}
/**
* @return Gets the execPath regardless of whether this is a real Artifact
*/
public PathFragment getSafeExecPath() {
return execPath == null ? artifact.getExecPath() : execPath;
}
/**
* @return the on-disk location of the .d file or null
*/
public Path getPath() {
return artifact.getPath();
}
}
}