// Copyright Epic Games, Inc. All Rights Reserved.
using System;
using System.Collections.Generic;
using System.Text;
using System.IO;
using System.Reflection;
using System.Xml;
using System.Linq;
using System.Diagnostics;
using EpicGames.Core;
using Microsoft.Extensions.Logging;
using System.Diagnostics.CodeAnalysis;
namespace EpicGames.BuildGraph
{
///
/// Options for how the graph should be printed
///
public enum GraphPrintOptions
{
///
/// Includes a list of the graph options
///
ShowCommandLineOptions = 0x1,
///
/// Includes the list of dependencies for each node
///
ShowDependencies = 0x2,
///
/// Includes the list of notifiers for each node
///
ShowNotifications = 0x4,
}
///
/// Diagnostic message from the graph script. These messages are parsed at startup, then culled along with the rest of the graph nodes before output. Doing so
/// allows errors and warnings which are only output if a node is part of the graph being executed.
///
public class BgGraphDiagnostic
{
///
/// Location of the diagnostic
///
public BgScriptLocation Location;
///
/// The diagnostic event type
///
public LogEventType EventType;
///
/// The message to display
///
public string Message;
///
/// The node which this diagnostic is declared in. If the node is culled from the graph, the message will not be displayed.
///
public BgNode? EnclosingNode;
///
/// The agent that this diagnostic is declared in. If the entire agent is culled from the graph, the message will not be displayed.
///
public BgAgent? EnclosingAgent;
///
/// Constructor
///
public BgGraphDiagnostic(BgScriptLocation Location, LogEventType EventType, string Message, BgNode? EnclosingNode, BgAgent? EnclosingAgent)
{
this.Location = Location;
this.EventType = EventType;
this.Message = Message;
this.EnclosingNode = EnclosingNode;
this.EnclosingAgent = EnclosingAgent;
}
}
///
/// Represents a graph option. These are expanded during preprocessing, but are retained in order to display help messages.
///
public class BgScriptOption
{
///
/// Name of this option
///
public string Name;
///
/// Description for this option
///
public string Description;
///
/// Default value for this option
///
public string DefaultValue;
///
/// Constructor
///
/// The name of this option
/// Description of the option, for display on help pages
/// Default value for the option
public BgScriptOption(string Name, string Description, string DefaultValue)
{
this.Name = Name;
this.Description = Description;
this.DefaultValue = DefaultValue;
}
///
/// Returns a name of this option for debugging
///
/// Name of the option
public override string ToString()
{
return Name;
}
}
///
/// Definition of a graph.
///
public class BgGraph
{
///
/// List of options, in the order they were specified
///
public List Options = new List();
///
/// List of agents containing nodes to execute
///
public List Agents = new List();
///
/// Mapping from name to agent
///
public Dictionary NameToAgent = new Dictionary(StringComparer.OrdinalIgnoreCase);
///
/// Mapping of names to the corresponding node.
///
public Dictionary NameToNode = new Dictionary(StringComparer.OrdinalIgnoreCase);
///
/// Mapping of names to the corresponding report.
///
public Dictionary NameToReport = new Dictionary(StringComparer.OrdinalIgnoreCase);
///
/// Mapping of names to their corresponding node output.
///
public Dictionary TagNameToNodeOutput = new Dictionary(StringComparer.OrdinalIgnoreCase);
///
/// Mapping of aggregate names to their respective nodes
///
public Dictionary NameToAggregate = new Dictionary(StringComparer.OrdinalIgnoreCase);
///
/// List of badges that can be displayed for this build
///
public List Badges = new List();
///
/// List of labels that can be displayed for this build
///
public List Labels = new List();
///
/// Diagnostic messages for this graph
///
public List Diagnostics = new List();
///
/// Default constructor
///
public BgGraph()
{
}
///
/// Checks whether a given name already exists
///
/// The name to check.
/// True if the name exists, false otherwise.
public bool ContainsName(string Name)
{
return NameToNode.ContainsKey(Name) || NameToReport.ContainsKey(Name) || NameToAggregate.ContainsKey(Name);
}
///
/// Tries to resolve the given name to one or more nodes. Checks for aggregates, and actual nodes.
///
/// The name to search for
/// If the name is a match, receives an array of nodes and their output names
/// True if the name was found, false otherwise.
public bool TryResolveReference(string Name, [NotNullWhen(true)] out BgNode[]? OutNodes)
{
// Check if it's a tag reference or node reference
if (Name.StartsWith("#"))
{
// Check if it's a regular node or output name
BgNodeOutput? Output;
if (TagNameToNodeOutput.TryGetValue(Name, out Output))
{
OutNodes = new BgNode[] { Output.ProducingNode };
return true;
}
}
else
{
// Check if it's a regular node or output name
BgNode? Node;
if (NameToNode.TryGetValue(Name, out Node))
{
OutNodes = new BgNode[] { Node };
return true;
}
// Check if it's an aggregate name
BgAggregate? Aggregate;
if (NameToAggregate.TryGetValue(Name, out Aggregate))
{
OutNodes = Aggregate.RequiredNodes.ToArray();
return true;
}
// Check if it's a group name
BgAgent? Agent;
if (NameToAgent.TryGetValue(Name, out Agent))
{
OutNodes = Agent.Nodes.ToArray();
return true;
}
}
// Otherwise fail
OutNodes = null;
return false;
}
///
/// Tries to resolve the given name to one or more node outputs. Checks for aggregates, and actual nodes.
///
/// The name to search for
/// If the name is a match, receives an array of nodes and their output names
/// True if the name was found, false otherwise.
public bool TryResolveInputReference(string Name, [NotNullWhen(true)] out BgNodeOutput[]? OutOutputs)
{
// Check if it's a tag reference or node reference
if (Name.StartsWith("#"))
{
// Check if it's a regular node or output name
BgNodeOutput? Output;
if (TagNameToNodeOutput.TryGetValue(Name, out Output))
{
OutOutputs = new BgNodeOutput[] { Output };
return true;
}
}
else
{
// Check if it's a regular node or output name
BgNode? Node;
if (NameToNode.TryGetValue(Name, out Node))
{
OutOutputs = Node.Outputs.Union(Node.Inputs).ToArray();
return true;
}
// Check if it's an aggregate name
BgAggregate? Aggregate;
if (NameToAggregate.TryGetValue(Name, out Aggregate))
{
OutOutputs = Aggregate.RequiredNodes.SelectMany(x => x.Outputs.Union(x.Inputs)).Distinct().ToArray();
return true;
}
}
// Otherwise fail
OutOutputs = null;
return false;
}
///
/// Cull the graph to only include the given nodes and their dependencies
///
/// A set of target nodes to build
public void Select(IEnumerable TargetNodes)
{
// Find this node and all its dependencies
HashSet RetainNodes = new HashSet(TargetNodes);
foreach (BgNode TargetNode in TargetNodes)
{
RetainNodes.UnionWith(TargetNode.InputDependencies);
}
// Remove all the nodes which are not marked to be kept
foreach (BgAgent Agent in Agents)
{
Agent.Nodes = Agent.Nodes.Where(x => RetainNodes.Contains(x)).ToList();
}
// Remove all the empty agents
Agents.RemoveAll(x => x.Nodes.Count == 0);
// Trim down the list of nodes for each report to the ones that are being built
foreach (BgReport Report in NameToReport.Values)
{
Report.Nodes.RemoveWhere(x => !RetainNodes.Contains(x));
}
// Remove all the empty reports
NameToReport = NameToReport.Where(x => x.Value.Nodes.Count > 0).ToDictionary(Pair => Pair.Key, Pair => Pair.Value, StringComparer.InvariantCultureIgnoreCase);
// Remove all the order dependencies which are no longer part of the graph. Since we don't need to build them, we don't need to wait for them
foreach (BgNode Node in RetainNodes)
{
Node.OrderDependencies = Node.OrderDependencies.Where(x => RetainNodes.Contains(x)).ToArray();
}
// Create a new list of aggregates for everything that's left
Dictionary NewNameToAggregate = new Dictionary(NameToAggregate.Comparer);
foreach (BgAggregate Aggregate in NameToAggregate.Values)
{
if (Aggregate.RequiredNodes.All(x => RetainNodes.Contains(x)))
{
NewNameToAggregate[Aggregate.Name] = Aggregate;
}
}
NameToAggregate = NewNameToAggregate;
// Remove any labels that are no longer value
foreach (BgLabel Label in Labels)
{
Label.RequiredNodes.RemoveWhere(x => !RetainNodes.Contains(x));
Label.IncludedNodes.RemoveWhere(x => !RetainNodes.Contains(x));
}
Labels.RemoveAll(x => x.RequiredNodes.Count == 0);
// Remove any badges which do not have all their dependencies
Badges.RemoveAll(x => x.Nodes.Any(y => !RetainNodes.Contains(y)));
// Remove any diagnostics which are no longer part of the graph
Diagnostics.RemoveAll(x => (x.EnclosingNode != null && !RetainNodes.Contains(x.EnclosingNode)) || (x.EnclosingAgent != null && !Agents.Contains(x.EnclosingAgent)));
}
///
/// Writes a preprocessed build graph to a script file
///
/// The file to load
/// Schema file for validation
public void Write(FileReference File, FileReference SchemaFile)
{
XmlWriterSettings Settings = new XmlWriterSettings();
Settings.Indent = true;
Settings.IndentChars = "\t";
using (XmlWriter Writer = XmlWriter.Create(File.FullName, Settings))
{
Writer.WriteStartElement("BuildGraph", "http://www.epicgames.com/BuildGraph");
if (SchemaFile != null)
{
Writer.WriteAttributeString("schemaLocation", "http://www.w3.org/2001/XMLSchema-instance", "http://www.epicgames.com/BuildGraph " + SchemaFile.MakeRelativeTo(File.Directory));
}
foreach (BgAgent Agent in Agents)
{
Agent.Write(Writer);
}
foreach (BgAggregate Aggregate in NameToAggregate.Values)
{
// If the aggregate has no required elements, skip it.
if (Aggregate.RequiredNodes.Count == 0)
{
continue;
}
Writer.WriteStartElement("Aggregate");
Writer.WriteAttributeString("Name", Aggregate.Name);
Writer.WriteAttributeString("Requires", String.Join(";", Aggregate.RequiredNodes.Select(x => x.Name)));
Writer.WriteEndElement();
}
foreach (BgLabel Label in Labels)
{
Writer.WriteStartElement("Label");
if (Label.DashboardCategory != null)
{
Writer.WriteAttributeString("Category", Label.DashboardCategory);
}
Writer.WriteAttributeString("Name", Label.DashboardName);
Writer.WriteAttributeString("Requires", String.Join(";", Label.RequiredNodes.Select(x => x.Name)));
HashSet IncludedNodes = new HashSet(Label.IncludedNodes);
IncludedNodes.ExceptWith(Label.IncludedNodes.SelectMany(x => x.InputDependencies));
IncludedNodes.ExceptWith(Label.RequiredNodes);
if (IncludedNodes.Count > 0)
{
Writer.WriteAttributeString("Include", String.Join(";", IncludedNodes.Select(x => x.Name)));
}
HashSet ExcludedNodes = new HashSet(Label.IncludedNodes);
ExcludedNodes.UnionWith(Label.IncludedNodes.SelectMany(x => x.InputDependencies));
ExcludedNodes.ExceptWith(Label.IncludedNodes);
ExcludedNodes.ExceptWith(ExcludedNodes.ToArray().SelectMany(x => x.InputDependencies));
if (ExcludedNodes.Count > 0)
{
Writer.WriteAttributeString("Exclude", String.Join(";", ExcludedNodes.Select(x => x.Name)));
}
Writer.WriteEndElement();
}
foreach (BgReport Report in NameToReport.Values)
{
Writer.WriteStartElement("Report");
Writer.WriteAttributeString("Name", Report.Name);
Writer.WriteAttributeString("Requires", String.Join(";", Report.Nodes.Select(x => x.Name)));
Writer.WriteEndElement();
}
foreach (BgBadge Badge in Badges)
{
Writer.WriteStartElement("Badge");
Writer.WriteAttributeString("Name", Badge.Name);
if (Badge.Project != null)
{
Writer.WriteAttributeString("Project", Badge.Project);
}
if (Badge.Change != 0)
{
Writer.WriteAttributeString("Change", Badge.Change.ToString());
}
Writer.WriteAttributeString("Requires", String.Join(";", Badge.Nodes.Select(x => x.Name)));
Writer.WriteEndElement();
}
Writer.WriteEndElement();
}
}
///
/// Export the build graph to a Json file, for parallel execution by the build system
///
/// Output file to write
/// Set of nodes which have been completed
public void Export(FileReference File, HashSet CompletedNodes)
{
// Find all the nodes which we're actually going to execute. We'll use this to filter the graph.
HashSet NodesToExecute = new HashSet();
foreach (BgNode Node in Agents.SelectMany(x => x.Nodes))
{
if (!CompletedNodes.Contains(Node))
{
NodesToExecute.Add(Node);
}
}
// Open the output file
using (JsonWriter JsonWriter = new JsonWriter(File.FullName))
{
JsonWriter.WriteObjectStart();
// Write all the agents
JsonWriter.WriteArrayStart("Groups");
foreach (BgAgent Agent in Agents)
{
BgNode[] Nodes = Agent.Nodes.Where(x => NodesToExecute.Contains(x)).ToArray();
if (Nodes.Length > 0)
{
JsonWriter.WriteObjectStart();
JsonWriter.WriteValue("Name", Agent.Name);
JsonWriter.WriteArrayStart("Agent Types");
foreach (string AgentType in Agent.PossibleTypes)
{
JsonWriter.WriteValue(AgentType);
}
JsonWriter.WriteArrayEnd();
JsonWriter.WriteArrayStart("Nodes");
foreach (BgNode Node in Nodes)
{
JsonWriter.WriteObjectStart();
JsonWriter.WriteValue("Name", Node.Name);
JsonWriter.WriteValue("DependsOn", String.Join(";", Node.GetDirectOrderDependencies().Where(x => NodesToExecute.Contains(x))));
JsonWriter.WriteValue("RunEarly", Node.bRunEarly);
JsonWriter.WriteObjectStart("Notify");
JsonWriter.WriteValue("Default", String.Join(";", Node.NotifyUsers));
JsonWriter.WriteValue("Submitters", String.Join(";", Node.NotifySubmitters));
JsonWriter.WriteValue("Warnings", Node.bNotifyOnWarnings);
JsonWriter.WriteObjectEnd();
JsonWriter.WriteObjectEnd();
}
JsonWriter.WriteArrayEnd();
JsonWriter.WriteObjectEnd();
}
}
JsonWriter.WriteArrayEnd();
// Write all the badges
JsonWriter.WriteArrayStart("Badges");
foreach (BgBadge Badge in Badges)
{
BgNode[] Dependencies = Badge.Nodes.Where(x => NodesToExecute.Contains(x)).ToArray();
if (Dependencies.Length > 0)
{
// Reduce that list to the smallest subset of direct dependencies
HashSet DirectDependencies = new HashSet(Dependencies);
foreach (BgNode Dependency in Dependencies)
{
DirectDependencies.ExceptWith(Dependency.OrderDependencies);
}
JsonWriter.WriteObjectStart();
JsonWriter.WriteValue("Name", Badge.Name);
if (!String.IsNullOrEmpty(Badge.Project))
{
JsonWriter.WriteValue("Project", Badge.Project);
}
if (Badge.Change != 0)
{
JsonWriter.WriteValue("Change", Badge.Change);
}
JsonWriter.WriteValue("AllDependencies", String.Join(";", Agents.SelectMany(x => x.Nodes).Where(x => Dependencies.Contains(x)).Select(x => x.Name)));
JsonWriter.WriteValue("DirectDependencies", String.Join(";", DirectDependencies.Select(x => x.Name)));
JsonWriter.WriteObjectEnd();
}
}
JsonWriter.WriteArrayEnd();
// Write all the triggers and reports.
JsonWriter.WriteArrayStart("Reports");
foreach (BgReport Report in NameToReport.Values)
{
BgNode[] Dependencies = Report.Nodes.Where(x => NodesToExecute.Contains(x)).ToArray();
if (Dependencies.Length > 0)
{
// Reduce that list to the smallest subset of direct dependencies
HashSet DirectDependencies = new HashSet(Dependencies);
foreach (BgNode Dependency in Dependencies)
{
DirectDependencies.ExceptWith(Dependency.OrderDependencies);
}
JsonWriter.WriteObjectStart();
JsonWriter.WriteValue("Name", Report.Name);
JsonWriter.WriteValue("AllDependencies", String.Join(";", Agents.SelectMany(x => x.Nodes).Where(x => Dependencies.Contains(x)).Select(x => x.Name)));
JsonWriter.WriteValue("DirectDependencies", String.Join(";", DirectDependencies.Select(x => x.Name)));
JsonWriter.WriteValue("Notify", String.Join(";", Report.NotifyUsers));
JsonWriter.WriteValue("IsTrigger", false);
JsonWriter.WriteObjectEnd();
}
}
JsonWriter.WriteArrayEnd();
JsonWriter.WriteObjectEnd();
}
}
///
/// Export the build graph to a Json file for parsing by Horde
///
/// Output file to write
public void ExportForHorde(FileReference File)
{
DirectoryReference.CreateDirectory(File.Directory);
using (JsonWriter JsonWriter = new JsonWriter(File.FullName))
{
JsonWriter.WriteObjectStart();
JsonWriter.WriteArrayStart("Groups");
foreach (BgAgent Agent in Agents)
{
JsonWriter.WriteObjectStart();
JsonWriter.WriteArrayStart("Types");
foreach (string PossibleType in Agent.PossibleTypes)
{
JsonWriter.WriteValue(PossibleType);
}
JsonWriter.WriteArrayEnd();
JsonWriter.WriteArrayStart("Nodes");
foreach (BgNode Node in Agent.Nodes)
{
JsonWriter.WriteObjectStart();
JsonWriter.WriteValue("Name", Node.Name);
JsonWriter.WriteValue("RunEarly", Node.bRunEarly);
JsonWriter.WriteValue("Warnings", Node.bNotifyOnWarnings);
JsonWriter.WriteArrayStart("InputDependencies");
foreach (string InputDependency in Node.GetDirectInputDependencies().Select(x => x.Name))
{
JsonWriter.WriteValue(InputDependency);
}
JsonWriter.WriteArrayEnd();
JsonWriter.WriteArrayStart("OrderDependencies");
foreach (string OrderDependency in Node.GetDirectOrderDependencies().Select(x => x.Name))
{
JsonWriter.WriteValue(OrderDependency);
}
JsonWriter.WriteArrayEnd();
JsonWriter.WriteObjectEnd();
}
JsonWriter.WriteArrayEnd();
JsonWriter.WriteObjectEnd();
}
JsonWriter.WriteArrayEnd();
JsonWriter.WriteArrayStart("Aggregates");
foreach (BgAggregate Aggregate in NameToAggregate.Values)
{
JsonWriter.WriteObjectStart();
JsonWriter.WriteValue("Name", Aggregate.Name);
JsonWriter.WriteArrayStart("Nodes");
foreach (BgNode RequiredNode in Aggregate.RequiredNodes.OrderBy(x => x.Name))
{
JsonWriter.WriteValue(RequiredNode.Name);
}
JsonWriter.WriteArrayEnd();
JsonWriter.WriteObjectEnd();
}
JsonWriter.WriteArrayEnd();
JsonWriter.WriteArrayStart("Labels");
foreach (BgLabel Label in Labels)
{
JsonWriter.WriteObjectStart();
if (!String.IsNullOrEmpty(Label.DashboardName))
{
JsonWriter.WriteValue("Name", Label.DashboardName);
}
if (!String.IsNullOrEmpty(Label.DashboardCategory))
{
JsonWriter.WriteValue("Category", Label.DashboardCategory);
}
if (!String.IsNullOrEmpty(Label.UgsBadge))
{
JsonWriter.WriteValue("UgsBadge", Label.UgsBadge);
}
if (!String.IsNullOrEmpty(Label.UgsProject))
{
JsonWriter.WriteValue("UgsProject", Label.UgsProject);
}
if (Label.Change != BgLabelChange.Current)
{
JsonWriter.WriteValue("Change", Label.Change.ToString());
}
JsonWriter.WriteArrayStart("RequiredNodes");
foreach (BgNode RequiredNode in Label.RequiredNodes.OrderBy(x => x.Name))
{
JsonWriter.WriteValue(RequiredNode.Name);
}
JsonWriter.WriteArrayEnd();
JsonWriter.WriteArrayStart("IncludedNodes");
foreach (BgNode IncludedNode in Label.IncludedNodes.OrderBy(x => x.Name))
{
JsonWriter.WriteValue(IncludedNode.Name);
}
JsonWriter.WriteArrayEnd();
JsonWriter.WriteObjectEnd();
}
JsonWriter.WriteArrayEnd();
JsonWriter.WriteArrayStart("Badges");
foreach (BgBadge Badge in Badges)
{
HashSet Dependencies = Badge.Nodes;
if (Dependencies.Count > 0)
{
// Reduce that list to the smallest subset of direct dependencies
HashSet DirectDependencies = new HashSet(Dependencies);
foreach (BgNode Dependency in Dependencies)
{
DirectDependencies.ExceptWith(Dependency.OrderDependencies);
}
JsonWriter.WriteObjectStart();
JsonWriter.WriteValue("Name", Badge.Name);
if (!String.IsNullOrEmpty(Badge.Project))
{
JsonWriter.WriteValue("Project", Badge.Project);
}
if (Badge.Change != 0)
{
JsonWriter.WriteValue("Change", Badge.Change);
}
JsonWriter.WriteValue("Dependencies", String.Join(";", DirectDependencies.Select(x => x.Name)));
JsonWriter.WriteObjectEnd();
}
}
JsonWriter.WriteArrayEnd();
JsonWriter.WriteObjectEnd();
}
}
///
/// Print the contents of the graph
///
/// Set of nodes which are already complete
/// Options for how to print the graph
///
public void Print(HashSet CompletedNodes, GraphPrintOptions PrintOptions, ILogger Logger)
{
// Print the options
if ((PrintOptions & GraphPrintOptions.ShowCommandLineOptions) != 0)
{
// Get the list of messages
List> Parameters = new List>();
foreach (BgScriptOption Option in Options)
{
string Name = String.Format("-set:{0}=...", Option.Name);
StringBuilder Description = new StringBuilder(Option.Description);
if (!String.IsNullOrEmpty(Option.DefaultValue))
{
Description.AppendFormat(" (Default: {0})", Option.DefaultValue);
}
Parameters.Add(new KeyValuePair(Name, Description.ToString()));
}
// Format them to the log
if (Parameters.Count > 0)
{
Logger.LogInformation("");
Logger.LogInformation("Options:");
Logger.LogInformation("");
HelpUtils.PrintTable(Parameters, 4, 24, Logger);
}
}
// Output all the triggers in order
Logger.LogInformation("");
Logger.LogInformation("Graph:");
foreach (BgAgent Agent in Agents)
{
Logger.LogInformation(" Agent: {0} ({1})", Agent.Name, String.Join(";", Agent.PossibleTypes));
foreach (BgNode Node in Agent.Nodes)
{
Logger.LogInformation(" Node: {0}{1}", Node.Name, CompletedNodes.Contains(Node) ? " (completed)" : Node.bRunEarly ? " (early)" : "");
if (PrintOptions.HasFlag(GraphPrintOptions.ShowDependencies))
{
HashSet InputDependencies = new HashSet(Node.GetDirectInputDependencies());
foreach (BgNode InputDependency in InputDependencies)
{
Logger.LogInformation(" input> {0}", InputDependency.Name);
}
HashSet OrderDependencies = new HashSet(Node.GetDirectOrderDependencies());
foreach (BgNode OrderDependency in OrderDependencies.Except(InputDependencies))
{
Logger.LogInformation(" after> {0}", OrderDependency.Name);
}
}
if (PrintOptions.HasFlag(GraphPrintOptions.ShowNotifications))
{
string Label = Node.bNotifyOnWarnings ? "warnings" : "errors";
foreach (string User in Node.NotifyUsers)
{
Logger.LogInformation(" {0}> {1}", Label, User);
}
foreach (string Submitter in Node.NotifySubmitters)
{
Logger.LogInformation(" {0}> submitters to {1}", Label, Submitter);
}
}
}
}
Logger.LogInformation("");
// Print out all the non-empty aggregates
BgAggregate[] Aggregates = NameToAggregate.Values.OrderBy(x => x.Name).ToArray();
if (Aggregates.Length > 0)
{
Logger.LogInformation("Aggregates:");
foreach (string AggregateName in Aggregates.Select(x => x.Name))
{
Logger.LogInformation(" {0}", AggregateName);
}
Logger.LogInformation("");
}
}
}
}