/// <summary>
/// The FrontEnds that use an out-of-proc tool should sandbox that process and call this method
/// in order to tack the tool's file accesses, enumerations, etc. in order to make graph caching sound
/// </summary>
public static void TrackToolFileAccesses(FrontEndEngineAbstraction engine, FrontEndContext context, string frontEndName, ISet <ReportedFileAccess> fileAccesses, AbsolutePath frontEndFolder)
{
// Compute all parseable paths
// TODO: does it make sense to consider enumerations, or as a result the graph will be too unstable? Does it matter for MsBuild graph construction?
foreach (var access in fileAccesses)
{
string accessPath = access.GetPath(context.PathTable);
if (AbsolutePath.TryCreate(context.PathTable, accessPath, out AbsolutePath path))
{
// Ignore accesses under the frontend folder: these are files used for internal communication between
// BuildXL and the graph builder tool, and they are never files that MSBuild itself interacted with
if (path.IsWithin(context.PathTable, frontEndFolder))
{
continue;
}
if ((access.RequestedAccess & RequestedAccess.Enumerate) != 0)
{
engine.TrackDirectory(path.ToString(context.PathTable));
}
if ((access.RequestedAccess & RequestedAccess.Probe) != 0)
{
engine.FileExists(path);
}
if ((access.RequestedAccess & RequestedAccess.Read) != 0)
{
// Two things are happening here: we want to register if the file is present or absent. Engine.FileExists takes
// care of that. And in the case the file exists, record the content.
// There are apparently some repos that create and delete files during graph construction :(
// So we cannot trust detours and check for IsNonexistent on the access itself. Even though there were read/write accesses on a given file,
// the file may not exist at this point
if (engine.FileExists(path))
{
engine.RecordFrontEndFile(path, frontEndName);
}
}
}
}
}
private static AbsolutePath TryFindConfig(AbsolutePath startDir, FrontEndEngineAbstraction engine, PathTable pathTable)
{
Contract.Requires(startDir.IsValid);
for (; startDir != AbsolutePath.Invalid; startDir = startDir.GetParent(pathTable))
{
var configFilename = startDir.Combine(pathTable, Names.ConfigBc);
var legacyConfigFilename = startDir.Combine(pathTable, Names.ConfigDsc);
if (engine.FileExists(legacyConfigFilename))
{
return(legacyConfigFilename);
}
if (engine.FileExists(configFilename))
{
return(configFilename);
}
}
return(AbsolutePath.Invalid);
}
/// <inheritdoc/>
public override bool Exists(AbsolutePath path)
{
Contract.Requires(path.IsValid);
return(m_engine.FileExists(path));
}