public void DoubleWriteMakesPipCacheableWhenOutputsAreIsolated(ContainerIsolationLevel containerIsolationLevel, RewritePolicy doubleWritePolicy, bool expectCacheHit, bool expectViolationIsError)
{
string sharedOpaqueDir = Path.Combine(ObjectRoot, "sharedopaquedir");
AbsolutePath sharedOpaqueDirPath = AbsolutePath.Create(Context.PathTable, sharedOpaqueDir);
FileArtifact doubleWriteArtifact = CreateOutputFileArtifact(sharedOpaqueDir);
ScheduleDoubleWriteProducers(
sharedOpaqueDirPath,
doubleWriteArtifact,
containerIsolationLevel,
doubleWritePolicy,
out ProcessWithOutputs firstProducer,
out ProcessWithOutputs secondProducer);
var firstRunResult = RunScheduler();
if (!expectViolationIsError)
{
firstRunResult.AssertSuccess();
// Run a second time so we can check the caching behavior
var result = RunScheduler().AssertSuccess();
if (expectCacheHit)
{
// In this case, both should be a hit
result.AssertCacheHit(firstProducer.Process.PipId);
result.AssertCacheHit(secondProducer.Process.PipId);
}
else
{
// In this case, the second one should be a miss
result.AssertCacheHit(firstProducer.Process.PipId);
result.AssertCacheMiss(secondProducer.Process.PipId);
AssertWarningEventLogged(LogEventId.ProcessNotStoredToCacheDueToFileMonitoringViolations, 2);
}
// We are expecting a double write as a verbose message (twice, one for each run)
AssertVerboseEventLogged(LogEventId.DependencyViolationDoubleWrite, 2);
}
// The violation is either an error or a warning depending on expectations
if (expectViolationIsError)
{
AssertErrorEventLogged(LogEventId.FileMonitoringError);
AssertErrorEventLogged(ProcessesLogEventId.DisallowedDoubleWriteOnMerge);
}
else
{
AssertWarningEventLogged(LogEventId.FileMonitoringWarning, 2);
}
}
public async Task IsolationLevelControlsWriteRedirection(ContainerIsolationLevel containerIsolationLevel)
{
var context = BuildXLContext.CreateInstanceForTesting();
using (var tempFiles = new TempFileStorage(canGetFileNames: true))
{
var pathTable = context.PathTable;
var outputFile = tempFiles.GetUniqueFileName(@"fileOutputs\");
var opaqueOutputFile = tempFiles.GetUniqueFileName(@"directoryOutputs\");
var outputFilePath = AbsolutePath.Create(pathTable, outputFile);
var opaqueOutputFilePath = AbsolutePath.Create(pathTable, opaqueOutputFile);
var arguments = $"echo hi > {outputFile} && echo bye > {opaqueOutputFile}";
var outputs = ReadOnlyArray <FileArtifactWithAttributes> .FromWithoutCopy(
new[]
{
FileArtifactWithAttributes.Create(FileArtifact.CreateOutputFile(outputFilePath), FileExistence.Required),
});
var opaqueOutputs = ReadOnlyArray <DirectoryArtifact> .FromWithoutCopy(
new[]
{
new DirectoryArtifact(opaqueOutputFilePath.GetParent(pathTable), 1, isSharedOpaque: containerIsolationLevel == ContainerIsolationLevel.IsolateSharedOpaqueOutputDirectories),
}
);
var pip = CreateConsoleProcessInContainer(context, tempFiles, pathTable, arguments, outputs, opaqueOutputs, containerIsolationLevel);
var pipExecutionResult = await RunProcess(context, pip);
XAssert.AreEqual(SandboxedProcessPipExecutionStatus.Succeeded, pipExecutionResult.Status);
var redirectedDirForFiles = pip.UniqueRedirectedDirectoryRoot.Combine(pathTable, "fileOutputs");
var redirectedFile = redirectedDirForFiles.Combine(pathTable, outputFilePath.GetName(pathTable)).ToString(pathTable);
var redirectedDirForDirectories = pip.UniqueRedirectedDirectoryRoot.Combine(pathTable, "directoryOutputs");
var redirectedOpaqueFile = redirectedDirForDirectories.Combine(pathTable, opaqueOutputFilePath.GetName(pathTable)).ToString(pathTable);
// Make sure outputs got redirected based on the configured isolation level
switch (containerIsolationLevel)
{
case ContainerIsolationLevel.IsolateOutputFiles:
XAssert.IsTrue(File.Exists(redirectedFile));
break;
case ContainerIsolationLevel.IsolateExclusiveOpaqueOutputDirectories:
case ContainerIsolationLevel.IsolateSharedOpaqueOutputDirectories:
XAssert.IsTrue(File.Exists(redirectedOpaqueFile));
break;
}
}
}
private ProcessBuilder CreateFileInSharedOpaqueBuilder(ContainerIsolationLevel containerIsolationLevel, RewritePolicy rewritePolicy, FileArtifact writeArtifact, string writeContent, AbsolutePath sharedOpaqueDirPath)
{
ProcessBuilder producerBuilder;
IEnumerable <Operation> producerWrites =
new Operation[]
{
Operation.CreateDir(new DirectoryArtifact(writeArtifact.Path.GetParent(Context.PathTable), 0, isSharedOpaque: false)),
Operation.WriteFile(writeArtifact, writeContent, doNotInfer: true),
Operation.WriteFile(CreateOutputFileArtifact()), // so each builder is unique
};
producerBuilder = CreatePipBuilder(producerWrites);
producerBuilder.AddOutputDirectory(sharedOpaqueDirPath, SealDirectoryKind.SharedOpaque);
producerBuilder.Options |= Process.Options.NeedsToRunInContainer;
producerBuilder.ContainerIsolationLevel = containerIsolationLevel;
producerBuilder.RewritePolicy = rewritePolicy;
return(producerBuilder);
}
private void ScheduleDoubleWriteProducers(
AbsolutePath sharedOpaqueDirPath,
FileArtifact doubleWriteArtifact,
ContainerIsolationLevel containerIsolationLevel,
RewritePolicy doubleWritePolicy,
out ProcessWithOutputs firstProducer,
out ProcessWithOutputs secondProducer)
{
var firstProducerBuilder = CreateFileInSharedOpaqueBuilder(containerIsolationLevel, doubleWritePolicy, doubleWriteArtifact, "first", sharedOpaqueDirPath);
firstProducer = SchedulePipBuilder(firstProducerBuilder);
var secondProducerBuilder = CreateFileInSharedOpaqueBuilder(containerIsolationLevel, doubleWritePolicy, doubleWriteArtifact, "second", sharedOpaqueDirPath);
// Let's order this so who is the violator is deterministic
secondProducerBuilder.AddInputDirectory(firstProducer.Process.DirectoryOutputs.First());
secondProducer = SchedulePipBuilder(secondProducerBuilder);
}
/// <summary>
/// Clone and override select properties.
/// </summary>
public Process Override(
FileArtifact?executable = null,
AbsolutePath?workingDirectory = null,
PipData?arguments = null,
FileArtifact?responseFile = null,
PipData?responseFileData = null,
ReadOnlyArray <EnvironmentVariable>?environmentVariables = null,
StandardInput?standardInput = null,
FileArtifact?standardOutput = null,
FileArtifact?standardError = null,
AbsolutePath?standardDirectory = null,
TimeSpan?warningTimeout = null,
TimeSpan?timeout = null,
ReadOnlyArray <FileArtifact>?dependencies = null,
ReadOnlyArray <FileArtifactWithAttributes>?fileOutputs = null,
ReadOnlyArray <DirectoryArtifact>?directoryDependencies = null,
ReadOnlyArray <DirectoryArtifact>?directoryOutputs = null,
ReadOnlyArray <PipId>?orderDependencies = null,
ReadOnlyArray <AbsolutePath>?untrackedPaths = null,
ReadOnlyArray <AbsolutePath>?untrackedScopes = null,
ReadOnlyArray <StringId>?tags = null,
ReadOnlyArray <int>?successExitCodes = null,
ReadOnlyArray <ProcessSemaphoreInfo>?semaphores = null,
PipProvenance provenance = null,
StringId?toolDescription = null,
ReadOnlyArray <AbsolutePath>?additionalTempDirectories = null,
RegexDescriptor?warningRegex = null,
RegexDescriptor?errorRegex = null,
AbsolutePath?uniqueOutputDirectory = null,
AbsolutePath?redirectedDirectoryRoot = null,
AbsolutePath?tempDirectory = null,
Options?options = null,
bool?testRetries = null,
ServiceInfo serviceInfo = null,
ReadOnlyArray <int>?retryExitCodes = null,
ReadOnlyArray <PathAtom>?allowedSurvivingChildProcessNames = null,
TimeSpan?nestedProcessTerminationTimeout = null,
AbsentPathProbeInUndeclaredOpaquesMode absentPathProbeMode = AbsentPathProbeInUndeclaredOpaquesMode.Unsafe,
DoubleWritePolicy doubleWritePolicy = DoubleWritePolicy.DoubleWritesAreErrors,
ContainerIsolationLevel containerIsolationLevel = ContainerIsolationLevel.None)
{
return(new Process(
executable ?? Executable,
workingDirectory ?? WorkingDirectory,
arguments ?? Arguments,
responseFile ?? ResponseFile,
responseFileData ?? ResponseFileData,
environmentVariables ?? EnvironmentVariables,
standardInput ?? StandardInput,
standardOutput ?? StandardOutput,
standardError ?? StandardError,
standardDirectory ?? StandardDirectory,
warningTimeout ?? WarningTimeout,
timeout ?? Timeout,
dependencies ?? Dependencies,
fileOutputs ?? FileOutputs,
directoryDependencies ?? DirectoryDependencies,
directoryOutputs ?? DirectoryOutputs,
orderDependencies ?? OrderDependencies,
untrackedPaths ?? UntrackedPaths,
untrackedScopes ?? UntrackedScopes,
tags ?? Tags,
successExitCodes ?? SuccessExitCodes,
semaphores ?? Semaphores,
provenance ?? Provenance,
toolDescription ?? ToolDescription,
additionalTempDirectories ?? AdditionalTempDirectories,
warningRegex ?? WarningRegex,
errorRegex ?? ErrorRegex,
uniqueOutputDirectory ?? UniqueOutputDirectory,
redirectedDirectoryRoot ?? UniqueRedirectedDirectoryRoot,
tempDirectory ?? TempDirectory,
options ?? ProcessOptions,
testRetries ?? TestRetries,
serviceInfo ?? ServiceInfo,
retryExitCodes ?? RetryExitCodes,
allowedSurvivingChildProcessNames,
nestedProcessTerminationTimeout,
absentPathProbeMode,
doubleWritePolicy,
containerIsolationLevel));
}
/// <summary>
/// Class constructor
/// </summary>
public Process(
FileArtifact executable,
AbsolutePath workingDirectory,
PipData arguments,
FileArtifact responseFile,
PipData responseFileData,
ReadOnlyArray <EnvironmentVariable> environmentVariables,
StandardInput standardInput,
FileArtifact standardOutput,
FileArtifact standardError,
AbsolutePath standardDirectory,
TimeSpan?warningTimeout,
TimeSpan?timeout,
ReadOnlyArray <FileArtifact> dependencies,
ReadOnlyArray <FileArtifactWithAttributes> outputs,
ReadOnlyArray <DirectoryArtifact> directoryDependencies,
ReadOnlyArray <DirectoryArtifact> directoryOutputs,
ReadOnlyArray <PipId> orderDependencies,
ReadOnlyArray <AbsolutePath> untrackedPaths,
ReadOnlyArray <AbsolutePath> untrackedScopes,
ReadOnlyArray <StringId> tags,
ReadOnlyArray <int> successExitCodes,
ReadOnlyArray <ProcessSemaphoreInfo> semaphores,
PipProvenance provenance,
StringId toolDescription,
ReadOnlyArray <AbsolutePath> additionalTempDirectories,
RegexDescriptor warningRegex = default,
RegexDescriptor errorRegex = default,
AbsolutePath uniqueOutputDirectory = default,
AbsolutePath uniqueRedirectedDirectoryRoot = default,
AbsolutePath tempDirectory = default,
Options options = default,
bool testRetries = false,
ServiceInfo serviceInfo = null,
ReadOnlyArray <int>?retryExitCodes = null,
ReadOnlyArray <PathAtom>?allowedSurvivingChildProcessNames = null,
TimeSpan?nestedProcessTerminationTimeout = null,
AbsentPathProbeInUndeclaredOpaquesMode absentPathProbeMode = AbsentPathProbeInUndeclaredOpaquesMode.Unsafe,
DoubleWritePolicy doubleWritePolicy = DoubleWritePolicy.DoubleWritesAreErrors,
ContainerIsolationLevel containerIsolationLevel = ContainerIsolationLevel.None)
{
Contract.Requires(executable.IsValid);
Contract.Requires(workingDirectory.IsValid);
Contract.Requires(arguments.IsValid);
Contract.RequiresForAll(environmentVariables, environmentVariable => environmentVariable.Name.IsValid);
Contract.RequiresForAll(environmentVariables, environmentVariable => environmentVariable.Value.IsValid ^ environmentVariable.IsPassThrough);
Contract.Requires(dependencies.IsValid);
Contract.RequiresForAll(dependencies, dependency => dependency.IsValid);
Contract.Requires(directoryDependencies.IsValid);
Contract.RequiresForAll(directoryDependencies, directoryDependency => directoryDependency.IsValid);
Contract.Requires(outputs.IsValid);
Contract.RequiresForAll(outputs, output => output.IsValid);
Contract.Requires(directoryOutputs.IsValid);
Contract.RequiresForAll(outputs, output => !output.IsSourceFile);
Contract.RequiresForAll(directoryOutputs, directoryOutput => directoryOutput.IsValid);
Contract.Requires(orderDependencies.IsValid);
Contract.RequiresForAll(orderDependencies, dependency => dependency != PipId.Invalid);
Contract.Requires(untrackedPaths.IsValid);
Contract.RequiresForAll(untrackedPaths, path => path.IsValid);
Contract.Requires(untrackedScopes.IsValid);
Contract.RequiresForAll(untrackedScopes, scope => scope.IsValid);
Contract.Requires(!timeout.HasValue || timeout.Value <= MaxTimeout);
Contract.Requires(standardDirectory.IsValid || (standardOutput.IsValid && standardError.IsValid));
Contract.Requires(provenance != null);
Contract.Requires(additionalTempDirectories.IsValid);
Contract.RequiresForAll(additionalTempDirectories, path => path.IsValid);
Contract.Requires(tags.IsValid);
// If the process needs to run in a container, the redirected directory has to be set
Contract.Requires((options & Options.NeedsToRunInContainer) == Options.None || uniqueRedirectedDirectoryRoot.IsValid);
#if DEBUG // a little too expensive for release builds
Contract.Requires(Contract.Exists(dependencies, d => d == executable), "The executable must be declared as a dependency");
Contract.Requires(
!standardInput.IsFile || Contract.Exists(dependencies, d => d == standardInput.File),
"If provided, the standard-input artifact must be declared as a dependency");
Contract.Requires(
!standardOutput.IsValid || Contract.Exists(outputs, o => o.ToFileArtifact() == standardOutput),
"If provided, the standard-error artifact must be declared as an expected output");
Contract.Requires(
!standardError.IsValid || Contract.Exists(outputs, o => o.ToFileArtifact() == standardError),
"If provided, the standard-error artifact must be declared as an expected output");
Contract.Requires(
!responseFile.IsValid ^ responseFileData.IsValid,
"If provided, the response-file artifact must have a corresponding ResponseFileData");
Contract.Requires(outputs.Length == outputs.Distinct().Count());
Contract.Requires(directoryOutputs.Length == directoryOutputs.Distinct().Count());
Contract.Requires(dependencies.Length == dependencies.Distinct().Count());
Contract.Requires(directoryDependencies.Length == directoryDependencies.Distinct().Count());
Contract.Requires(untrackedPaths.Length == untrackedPaths.Distinct().Count());
Contract.Requires(untrackedScopes.Length == untrackedScopes.Distinct().Count());
Contract.Requires(additionalTempDirectories.Length == additionalTempDirectories.Distinct().Count());
Contract.RequiresForAll(semaphores, s => s.IsValid);
Contract.Requires(semaphores.Length == semaphores.Distinct().Count());
#endif
Provenance = provenance;
Tags = tags;
Executable = executable;
ToolDescription = toolDescription;
WorkingDirectory = workingDirectory;
Arguments = arguments;
ResponseFile = responseFile;
ResponseFileData = responseFileData;
StandardOutput = standardOutput;
StandardError = standardError;
StandardInput = standardInput;
StandardDirectory = standardDirectory;
WarningTimeout = warningTimeout;
Timeout = timeout;
// We allow any IEnumerable for these fields, but perform a copy up-front.
// See the remarks of RemoveDuplicateFileArtifacts for why it is used on the input / output lists.
Dependencies = dependencies;
DirectoryDependencies = directoryDependencies;
FileOutputs = outputs;
DirectoryOutputs = directoryOutputs;
OrderDependencies = orderDependencies;
UntrackedPaths = untrackedPaths;
UntrackedScopes = untrackedScopes;
EnvironmentVariables = environmentVariables;
SuccessExitCodes = successExitCodes;
RetryExitCodes = retryExitCodes ?? ReadOnlyArray <int> .Empty;
WarningRegex = warningRegex;
ErrorRegex = errorRegex;
UniqueOutputDirectory = uniqueOutputDirectory;
UniqueRedirectedDirectoryRoot = uniqueRedirectedDirectoryRoot;
Semaphores = semaphores;
TempDirectory = tempDirectory;
TestRetries = testRetries;
ServiceInfo = serviceInfo;
ProcessOptions = options;
AdditionalTempDirectories = additionalTempDirectories;
AllowedSurvivingChildProcessNames = allowedSurvivingChildProcessNames ?? ReadOnlyArray <PathAtom> .Empty;
NestedProcessTerminationTimeout = nestedProcessTerminationTimeout;
ProcessAbsentPathProbeInUndeclaredOpaquesMode = absentPathProbeMode;
DoubleWritePolicy = doubleWritePolicy;
ContainerIsolationLevel = containerIsolationLevel;
}
private static Process CreateConsoleProcessInContainer(
BuildXLContext context,
TempFileStorage tempFiles,
PathTable pt,
string arguments,
ReadOnlyArray <FileArtifactWithAttributes> outputFiles,
ReadOnlyArray <DirectoryArtifact> directoryOutputs,
ContainerIsolationLevel containerIsolationLevel = ContainerIsolationLevel.IsolateAllOutputs)
{
var executableFileArtifact = FileArtifact.CreateSourceFile(AbsolutePath.Create(context.PathTable, CmdHelper.CmdX64));
var argumentBuilder = new PipDataBuilder(context.PathTable.StringTable);
argumentBuilder.Add("/d");
argumentBuilder.Add("/c");
using (argumentBuilder.StartFragment(PipDataFragmentEscaping.CRuntimeArgumentRules, " "))
{
foreach (var arg in arguments.Split(new[] { ' ' }, System.StringSplitOptions.RemoveEmptyEntries))
{
argumentBuilder.Add(arg);
}
}
string workingDirectory = tempFiles.GetUniqueDirectory();
var workingDirectoryAbsolutePath = AbsolutePath.Create(context.PathTable, workingDirectory);
string uniqueOutputDirectory = tempFiles.GetUniqueDirectory();
var uniqueOutputDirectoryPath = AbsolutePath.Create(context.PathTable, uniqueOutputDirectory);
string uniqueRedirectedOutputDirectory = tempFiles.GetUniqueDirectory("redirected");
var uniqueRedirectedOutputDirectoryPath = AbsolutePath.Create(context.PathTable, uniqueRedirectedOutputDirectory);
var pip = new Process(
executableFileArtifact,
workingDirectoryAbsolutePath,
argumentBuilder.ToPipData(" ", PipDataFragmentEscaping.NoEscaping),
FileArtifact.Invalid,
PipData.Invalid,
ReadOnlyArray <EnvironmentVariable> .FromWithoutCopy(),
FileArtifact.Invalid,
FileArtifact.Invalid,
FileArtifact.Invalid,
tempFiles.GetUniqueDirectory(pt),
null,
null,
dependencies: ReadOnlyArray <FileArtifact> .FromWithoutCopy(new[] { executableFileArtifact }),
outputs: outputFiles,
directoryDependencies: ReadOnlyArray <DirectoryArtifact> .Empty,
directoryOutputs: directoryOutputs,
orderDependencies: ReadOnlyArray <PipId> .Empty,
untrackedPaths: ReadOnlyArray <AbsolutePath> .Empty,
untrackedScopes: ReadOnlyArray <AbsolutePath> .Empty,
tags: ReadOnlyArray <StringId> .Empty,
successExitCodes: ReadOnlyArray <int> .Empty,
semaphores: ReadOnlyArray <ProcessSemaphoreInfo> .Empty,
provenance: PipProvenance.CreateDummy(context),
toolDescription: StringId.Invalid,
additionalTempDirectories: ReadOnlyArray <AbsolutePath> .Empty,
options: Process.Options.NeedsToRunInContainer,
uniqueOutputDirectory: uniqueOutputDirectoryPath,
uniqueRedirectedDirectoryRoot: uniqueRedirectedOutputDirectoryPath,
containerIsolationLevel: containerIsolationLevel);
return(pip);
}
/// <nodoc/> public static bool IsolateAllOutputs(this ContainerIsolationLevel containerIsolationLevel) => (containerIsolationLevel & ContainerIsolationLevel.IsolateAllOutputs) == ContainerIsolationLevel.IsolateAllOutputs;
/// <nodoc/> public static bool IsolateOutputDirectories(this ContainerIsolationLevel containerIsolationLevel) => (containerIsolationLevel & ContainerIsolationLevel.IsolateOutputDirectories) == ContainerIsolationLevel.IsolateOutputDirectories;
