forked from dotnet/msbuild
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ProjectGraph.cs
785 lines (689 loc) · 35.5 KB
/
ProjectGraph.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.Collections.Immutable;
using System.Diagnostics;
using System.IO;
using System.Linq;
using System.Text;
using System.Threading;
using Microsoft.Build.BackEnd;
using Microsoft.Build.Evaluation;
using Microsoft.Build.Eventing;
using Microsoft.Build.Exceptions;
using Microsoft.Build.Execution;
using Microsoft.Build.Shared;
namespace Microsoft.Build.Graph
{
/// <summary>
/// Represents a graph of evaluated projects.
/// </summary>
[DebuggerDisplay(@"#roots={GraphRoots.Count}, #nodes={ProjectNodes.Count}, #entryPoints={EntryPointNodes.Count}")]
public sealed class ProjectGraph
{
/// <summary>
/// A callback used for constructing a <see cref="ProjectInstance" /> for a specific
/// <see cref="ProjectGraphEntryPoint" /> instance.
/// </summary>
/// <param name="projectPath">The path to the project file to parse.</param>
/// <param name="globalProperties">The global properties to be used for creating the ProjectInstance.</param>
/// <param name="projectCollection">The <see cref="ProjectCollection" /> context for parsing.</param>
/// <returns>A <see cref="ProjectInstance" /> instance. This value must not be null.</returns>
/// <remarks>
/// The default version of this delegate used by ProjectGraph simply calls the
/// ProjectInstance constructor with information from the parameters. This delegate
/// is provided as a hook to allow scenarios like creating a <see cref="Project" />
/// instance before converting it to a ProjectInstance for use by the ProjectGraph.
/// The returned ProjectInstance will be stored and provided with the ProjectGraph.
/// If this callback chooses to generate an immutable ProjectInstance, e.g. by
/// using <see cref="Project.CreateProjectInstance()" /> with the flag
/// <see cref="ProjectInstanceSettings.Immutable" />, the resulting ProjectGraph
/// nodes might not be buildable.
/// To avoid corruption of the graph and subsequent builds based on the graph:
/// - all callback parameters must be utilized for creating the ProjectInstance, without any mutations
/// - the project instance should not be mutated in any way, its state should be a
/// full fidelity representation of the project file
/// </remarks>
public delegate ProjectInstance ProjectInstanceFactoryFunc(
string projectPath,
Dictionary<string, string> globalProperties,
ProjectCollection projectCollection);
private readonly Lazy<IReadOnlyCollection<ProjectGraphNode>> _projectNodesTopologicallySorted;
private GraphBuilder.GraphEdges Edges { get; }
internal GraphBuilder.GraphEdges TestOnly_Edges => Edges;
public GraphConstructionMetrics ConstructionMetrics { get; private set;}
/// <summary>
/// Various metrics on graph construction.
/// </summary>
public readonly struct GraphConstructionMetrics
{
public GraphConstructionMetrics(TimeSpan constructionTime, int nodeCount, int edgeCount)
{
ConstructionTime = constructionTime;
NodeCount = nodeCount;
EdgeCount = edgeCount;
}
public TimeSpan ConstructionTime { get; }
public int NodeCount { get; }
public int EdgeCount { get; }
}
/// <summary>
/// Gets the project nodes representing the entry points.
/// </summary>
public IReadOnlyCollection<ProjectGraphNode> EntryPointNodes { get; }
/// <summary>
/// Get an unordered collection of all project nodes in the graph.
/// </summary>
public IReadOnlyCollection<ProjectGraphNode> ProjectNodes { get; }
/// <summary>
/// Get a topologically sorted collection of all project nodes in the graph.
/// Referenced projects appear before the referencing projects.
/// </summary>
public IReadOnlyCollection<ProjectGraphNode> ProjectNodesTopologicallySorted => _projectNodesTopologicallySorted.Value;
public IReadOnlyCollection<ProjectGraphNode> GraphRoots { get; }
/// <summary>
/// Constructs a graph starting from the given project file, evaluating with the global project collection and no
/// global properties.
/// </summary>
/// <param name="entryProjectFile">The project file to use as the entry point in constructing the graph</param>
/// <exception cref="InvalidProjectFileException">
/// If the evaluation of any project in the graph fails
/// </exception>
public ProjectGraph(string entryProjectFile)
: this(new ProjectGraphEntryPoint(entryProjectFile).AsEnumerable(), ProjectCollection.GlobalProjectCollection, null)
{
}
/// <summary>
/// Constructs a graph starting from the given project files, evaluating with the global project collection and no
/// global properties.
/// </summary>
/// <param name="entryProjectFiles">The project files to use as the entry points in constructing the graph</param>
/// <exception cref="InvalidProjectFileException">
/// If the evaluation of any project in the graph fails
/// </exception>
public ProjectGraph(IEnumerable<string> entryProjectFiles)
: this(ProjectGraphEntryPoint.CreateEnumerable(entryProjectFiles), ProjectCollection.GlobalProjectCollection, null)
{
}
/// <summary>
/// Constructs a graph starting from the given project file, evaluating with the provided project collection and no
/// global properties.
/// </summary>
/// <param name="entryProjectFile">The project file to use as the entry point in constructing the graph</param>
/// <param name="projectCollection">
/// The collection with which all projects in the graph should be associated. May not be
/// null.
/// </param>
/// <exception cref="InvalidProjectFileException">
/// If the evaluation of any project in the graph fails
/// </exception>
public ProjectGraph(string entryProjectFile, ProjectCollection projectCollection)
: this(new ProjectGraphEntryPoint(entryProjectFile).AsEnumerable(), projectCollection, null)
{
}
/// <summary>
/// Constructs a graph starting from the given project files, evaluating with the provided project collection and no
/// global properties.
/// </summary>
/// <param name="entryProjectFiles">The project files to use as the entry points in constructing the graph</param>
/// <param name="projectCollection">
/// The collection with which all projects in the graph should be associated. May not be
/// null.
/// </param>
/// <exception cref="InvalidProjectFileException">
/// If the evaluation of any project in the graph fails
/// </exception>
public ProjectGraph(IEnumerable<string> entryProjectFiles, ProjectCollection projectCollection)
: this(ProjectGraphEntryPoint.CreateEnumerable(entryProjectFiles), projectCollection, null)
{
}
/// <summary>
/// Constructs a graph starting from the given project file, evaluating with the global project collection and no
/// global properties.
/// </summary>
/// <param name="entryProjectFile">The project file to use as the entry point in constructing the graph</param>
/// <param name="projectCollection">
/// The collection with which all projects in the graph should be associated. May not be
/// null.
/// </param>
/// <param name="projectInstanceFactory">
/// A delegate used for constructing a <see cref="ProjectInstance" />, called for each
/// project created during graph creation. This value can be null, which uses
/// a default implementation that calls the ProjectInstance constructor. See the remarks
/// on the <see cref="ProjectInstanceFactoryFunc" /> for other scenarios.
/// </param>
/// <exception cref="AggregateException">
/// If the evaluation of any project in the graph fails, the InnerException contains
/// <see cref="InvalidProjectFileException" />
/// If a null reference is returned from <paramref name="projectInstanceFactory" />, the InnerException contains
/// <see cref="InvalidOperationException" />
/// </exception>
public ProjectGraph(string entryProjectFile, ProjectCollection projectCollection, ProjectInstanceFactoryFunc projectInstanceFactory)
: this(new ProjectGraphEntryPoint(entryProjectFile).AsEnumerable(), projectCollection, projectInstanceFactory)
{
}
/// <summary>
/// Constructs a graph starting from the given project file, evaluating with the provided global properties and the
/// global project collection.
/// </summary>
/// <param name="entryProjectFile">The project file to use as the entry point in constructing the graph</param>
/// <param name="globalProperties">
/// The global properties to use for all projects. May be null, in which case no global
/// properties will be set.
/// </param>
/// <exception cref="InvalidProjectFileException">
/// If the evaluation of any project in the graph fails
/// </exception>
public ProjectGraph(string entryProjectFile, IDictionary<string, string> globalProperties)
: this(new ProjectGraphEntryPoint(entryProjectFile, globalProperties).AsEnumerable(), ProjectCollection.GlobalProjectCollection, null)
{
}
/// <summary>
/// Constructs a graph starting from the given project files, evaluating with the provided global properties and the
/// global project collection.
/// </summary>
/// <param name="entryProjectFiles">The project files to use as the entry points in constructing the graph</param>
/// <param name="globalProperties">
/// The global properties to use for all projects. May be null, in which case no global
/// properties will be set.
/// </param>
/// <exception cref="InvalidProjectFileException">
/// If the evaluation of any project in the graph fails
/// </exception>
public ProjectGraph(IEnumerable<string> entryProjectFiles, IDictionary<string, string> globalProperties)
: this(ProjectGraphEntryPoint.CreateEnumerable(entryProjectFiles, globalProperties), ProjectCollection.GlobalProjectCollection, null)
{
}
/// <summary>
/// Constructs a graph starting from the given project file, evaluating with the provided global properties and the
/// provided project collection.
/// </summary>
/// <param name="entryProjectFile">The project file to use as the entry point in constructing the graph</param>
/// <param name="globalProperties">
/// The global properties to use for all projects. May be null, in which case no global
/// properties will be set.
/// </param>
/// <param name="projectCollection">
/// The collection with which all projects in the graph should be associated. May not be
/// null.
/// </param>
/// <exception cref="InvalidProjectFileException">
/// If the evaluation of any project in the graph fails
/// </exception>
public ProjectGraph(string entryProjectFile, IDictionary<string, string> globalProperties, ProjectCollection projectCollection)
: this(new ProjectGraphEntryPoint(entryProjectFile, globalProperties).AsEnumerable(), projectCollection, null)
{
}
/// <summary>
/// Constructs a graph starting from the given project files, evaluating with the provided global properties and the
/// provided project collection.
/// </summary>
/// <param name="entryProjectFiles">The project files to use as the entry points in constructing the graph</param>
/// <param name="globalProperties">
/// The global properties to use for all projects. May be null, in which case no global
/// properties will be set.
/// </param>
/// <param name="projectCollection">
/// The collection with which all projects in the graph should be associated. May not be
/// null.
/// </param>
/// <exception cref="InvalidProjectFileException">
/// If the evaluation of any project in the graph fails
/// </exception>
public ProjectGraph(IEnumerable<string> entryProjectFiles, IDictionary<string, string> globalProperties, ProjectCollection projectCollection)
: this(ProjectGraphEntryPoint.CreateEnumerable(entryProjectFiles, globalProperties), projectCollection, null)
{
}
/// <summary>
/// Constructs a graph starting from the given graph entry point, evaluating with the global project collection.
/// </summary>
/// <param name="entryPoint">The entry point to use in constructing the graph</param>
/// <exception cref="InvalidProjectFileException">
/// If the evaluation of any project in the graph fails
/// </exception>
public ProjectGraph(ProjectGraphEntryPoint entryPoint)
: this(entryPoint.AsEnumerable(), ProjectCollection.GlobalProjectCollection, null)
{
}
/// <summary>
/// Constructs a graph starting from the given graph entry points, evaluating with the global project collection.
/// </summary>
/// <param name="entryPoints">The entry points to use in constructing the graph</param>
/// <exception cref="InvalidProjectFileException">
/// If the evaluation of any project in the graph fails
/// </exception>
public ProjectGraph(IEnumerable<ProjectGraphEntryPoint> entryPoints)
: this(entryPoints, ProjectCollection.GlobalProjectCollection, null)
{
}
/// <summary>
/// Constructs a graph starting from the given graph entry point, evaluating with the provided project collection.
/// </summary>
/// <param name="entryPoint">The entry point to use in constructing the graph</param>
/// <param name="projectCollection">
/// The collection with which all projects in the graph should be associated. May not be
/// null.
/// </param>
/// <exception cref="InvalidProjectFileException">
/// If the evaluation of any project in the graph fails
/// </exception>
public ProjectGraph(ProjectGraphEntryPoint entryPoint, ProjectCollection projectCollection)
: this(entryPoint.AsEnumerable(), projectCollection, null)
{
}
/// <summary>
/// Constructs a graph starting from the given graph entry points, evaluating with the provided project collection.
/// </summary>
/// <param name="entryPoints">The entry points to use in constructing the graph</param>
/// <param name="projectCollection">
/// The collection with which all projects in the graph should be associated. May not be
/// null.
/// </param>
/// <param name="projectInstanceFactory">
/// A delegate used for constructing a <see cref="ProjectInstance" />, called for each
/// project created during graph creation. This value can be null, which uses
/// a default implementation that calls the ProjectInstance constructor. See the remarks
/// on <see cref="ProjectInstanceFactoryFunc" /> for other scenarios.
/// </param>
/// <exception cref="InvalidProjectFileException">
/// If the evaluation of any project in the graph fails
/// </exception>
/// <exception cref="InvalidOperationException">
/// If a null reference is returned from <paramref name="projectInstanceFactory" />
/// </exception>
/// <exception cref="CircularDependencyException">
/// If the evaluation is successful but the project graph contains a circular
/// dependency
/// </exception>
public ProjectGraph(
IEnumerable<ProjectGraphEntryPoint> entryPoints,
ProjectCollection projectCollection,
ProjectInstanceFactoryFunc projectInstanceFactory)
: this(
entryPoints,
projectCollection,
projectInstanceFactory,
NativeMethodsShared.GetLogicalCoreCount(),
CancellationToken.None)
{
}
/// <summary>
/// Constructs a graph starting from the given graph entry points, evaluating with the provided project collection.
/// </summary>
/// <param name="entryPoints">The entry points to use in constructing the graph</param>
/// <param name="projectCollection">
/// The collection with which all projects in the graph should be associated. May not be
/// null.
/// </param>
/// <param name="projectInstanceFactory">
/// A delegate used for constructing a <see cref="ProjectInstance" />, called for each
/// project created during graph creation. This value can be null, which uses
/// a default implementation that calls the ProjectInstance constructor. See the remarks
/// on <see cref="ProjectInstanceFactoryFunc" /> for other scenarios.
/// </param>
/// <param name="cancellationToken">
/// The <see cref="T:System.Threading.CancellationToken" /> token to observe.
/// </param>
/// <exception cref="InvalidProjectFileException">
/// If the evaluation of any project in the graph fails
/// </exception>
/// <exception cref="InvalidOperationException">
/// If a null reference is returned from <paramref name="projectInstanceFactory" />
/// </exception>
/// <exception cref="CircularDependencyException">
/// If the evaluation is successful but the project graph contains a circular
/// dependency
/// </exception>
public ProjectGraph(
IEnumerable<ProjectGraphEntryPoint> entryPoints,
ProjectCollection projectCollection,
ProjectInstanceFactoryFunc projectInstanceFactory,
CancellationToken cancellationToken)
: this(
entryPoints,
projectCollection,
projectInstanceFactory,
NativeMethodsShared.GetLogicalCoreCount(),
cancellationToken)
{
}
/// <summary>
/// Constructs a graph starting from the given graph entry points, evaluating with the provided project collection.
/// </summary>
/// <param name="entryPoints">The entry points to use in constructing the graph</param>
/// <param name="projectCollection">
/// The collection with which all projects in the graph should be associated. May not be
/// null.
/// </param>
/// <param name="projectInstanceFactory">
/// A delegate used for constructing a <see cref="ProjectInstance" />, called for each
/// project created during graph creation. This value can be null, which uses
/// a default implementation that calls the ProjectInstance constructor. See the remarks
/// on <see cref="ProjectInstanceFactoryFunc" /> for other scenarios.
/// </param>
/// <param name="degreeOfParallelism">
/// Number of threads to participate in building the project graph.
/// </param>
/// <param name="cancellationToken">
/// The <see cref="T:System.Threading.CancellationToken" /> token to observe.
/// </param>
/// <exception cref="InvalidProjectFileException">
/// If the evaluation of any project in the graph fails
/// </exception>
/// <exception cref="InvalidOperationException">
/// If a null reference is returned from <paramref name="projectInstanceFactory" />
/// </exception>
/// <exception cref="CircularDependencyException">
/// If the evaluation is successful but the project graph contains a circular
/// dependency
/// </exception>
public ProjectGraph(
IEnumerable<ProjectGraphEntryPoint> entryPoints,
ProjectCollection projectCollection,
ProjectInstanceFactoryFunc projectInstanceFactory,
int degreeOfParallelism,
CancellationToken cancellationToken)
{
ErrorUtilities.VerifyThrowArgumentNull(projectCollection, nameof(projectCollection));
var measurementInfo = BeginMeasurement();
projectInstanceFactory ??= DefaultProjectInstanceFactory;
var graphBuilder = new GraphBuilder(
entryPoints,
projectCollection,
projectInstanceFactory,
ProjectInterpretation.Instance,
degreeOfParallelism,
cancellationToken);
graphBuilder.BuildGraph();
EntryPointNodes = graphBuilder.EntryPointNodes;
GraphRoots = graphBuilder.RootNodes;
ProjectNodes = graphBuilder.ProjectNodes;
Edges = graphBuilder.Edges;
_projectNodesTopologicallySorted = new Lazy<IReadOnlyCollection<ProjectGraphNode>>(() => TopologicalSort(GraphRoots, ProjectNodes));
ConstructionMetrics = EndMeasurement();
(Stopwatch Timer, string ETWArgs) BeginMeasurement()
{
string etwArgs = null;
if (MSBuildEventSource.Log.IsEnabled())
{
etwArgs = string.Join(";", entryPoints.Select(
e =>
{
var globalPropertyString = e.GlobalProperties == null
? string.Empty
: string.Join(", ", e.GlobalProperties.Select(kvp => $"{kvp.Key} = {kvp.Value}"));
return $"{e.ProjectFile}({globalPropertyString})";
}));
MSBuildEventSource.Log.ProjectGraphConstructionStart(etwArgs);
}
return (Stopwatch.StartNew(), etwArgs);
}
GraphConstructionMetrics EndMeasurement()
{
if (MSBuildEventSource.Log.IsEnabled())
{
MSBuildEventSource.Log.ProjectGraphConstructionStop(measurementInfo.ETWArgs);
}
measurementInfo.Timer.Stop();
return new GraphConstructionMetrics(
measurementInfo.Timer.Elapsed,
ProjectNodes.Count,
Edges.Count);
}
}
internal string ToDot()
{
var nodeCount = 0;
return ToDot(node => nodeCount++.ToString());
}
internal string ToDot(Func<ProjectGraphNode, string> nodeIdProvider)
{
ErrorUtilities.VerifyThrowArgumentNull(nodeIdProvider, nameof(nodeIdProvider));
var nodeIds = new ConcurrentDictionary<ProjectGraphNode, string>();
var sb = new StringBuilder();
sb.Append("digraph g\n{\n\tnode [shape=box]\n");
foreach (var node in ProjectNodes)
{
var nodeId = nodeIds.GetOrAdd(node, (n, idProvider) => idProvider(n), nodeIdProvider);
var nodeName = Path.GetFileNameWithoutExtension(node.ProjectInstance.FullPath);
var globalPropertiesString = string.Join(
"<br/>",
node.ProjectInstance.GlobalProperties.OrderBy(kvp => kvp.Key)
.Select(kvp => $"{kvp.Key}={kvp.Value}"));
sb.Append('\t').Append(nodeId).Append(" [label=<").Append(nodeName).Append("<br/>").Append(globalPropertiesString).AppendLine(">]");
foreach (var reference in node.ProjectReferences)
{
var referenceId = nodeIds.GetOrAdd(reference, (n, idProvider) => idProvider(n), nodeIdProvider);
sb.Append('\t').Append(nodeId).Append(" -> ").AppendLine(referenceId);
}
}
sb.Append("}");
return sb.ToString();
}
private static IReadOnlyCollection<ProjectGraphNode> TopologicalSort(
IReadOnlyCollection<ProjectGraphNode> graphRoots,
IReadOnlyCollection<ProjectGraphNode> graphNodes)
{
var toposort = new List<ProjectGraphNode>(graphNodes.Count);
var partialRoots = new Queue<ProjectGraphNode>(graphNodes.Count);
var inDegree = graphNodes.ToDictionary(n => n, n => n.ReferencingProjects.Count);
foreach (var root in graphRoots)
{
partialRoots.Enqueue(root);
}
while (partialRoots.Count != 0)
{
var partialRoot = partialRoots.Dequeue();
toposort.Add(partialRoot);
foreach (var reference in partialRoot.ProjectReferences)
{
if (--inDegree[reference] == 0)
{
partialRoots.Enqueue(reference);
}
}
}
ErrorUtilities.VerifyThrow(toposort.Count == graphNodes.Count, "sorted node count must be equal to total node count");
toposort.Reverse();
return toposort;
}
/// <summary>
/// Gets the target list to be executed for every project in the graph, given a particular target list for the entry
/// project.
/// </summary>
/// <remarks>
/// This method uses the ProjectReferenceTargets items to determine the targets to run per node. The results can then
/// be used to start building each project individually, assuming a given project is built after its references.
/// </remarks>
/// <param name="entryProjectTargets">
/// The target list for the <see cref="GraphRoots" />. May be null or empty, in which case the entry projects' default
/// targets will be used.
/// </param>
/// <returns>
/// A dictionary containing the target list for each node. If a node's target list is empty, then no targets were
/// inferred for that node and it should get skipped during a graph based build.
/// </returns>
public IReadOnlyDictionary<ProjectGraphNode, ImmutableList<string>> GetTargetLists(ICollection<string> entryProjectTargets)
{
ThrowOnEmptyTargetNames(entryProjectTargets);
// Seed the dictionary with empty lists for every node. In this particular case though an empty list means "build nothing" rather than "default targets".
var targetLists = ProjectNodes.ToDictionary(node => node, node => ImmutableList<string>.Empty);
var encounteredEdges = new HashSet<ProjectGraphBuildRequest>();
var edgesToVisit = new Queue<ProjectGraphBuildRequest>();
// Initial state for the graph roots
foreach (var entryPointNode in GraphRoots)
{
var entryTargets = entryProjectTargets == null || entryProjectTargets.Count == 0
? ImmutableList.CreateRange(entryPointNode.ProjectInstance.DefaultTargets)
: ImmutableList.CreateRange(entryProjectTargets);
var entryEdge = new ProjectGraphBuildRequest(entryPointNode, entryTargets);
encounteredEdges.Add(entryEdge);
edgesToVisit.Enqueue(entryEdge);
}
// Traverse the entire graph, visiting each edge once.
while (edgesToVisit.Count > 0)
{
var buildRequest = edgesToVisit.Dequeue();
var node = buildRequest.Node;
var requestedTargets = buildRequest.RequestedTargets;
targetLists[node] = targetLists[node].AddRange(requestedTargets);
// No need to continue if this node has no project references.
if (node.ProjectReferences.Count == 0)
{
continue;
}
// Based on the entry points of this project, determine which targets to propagate down to project references.
var targetsToPropagate = ProjectInterpretation.TargetsToPropagate.FromProjectAndEntryTargets(node.ProjectInstance, requestedTargets);
// Queue the project references for visitation, if the edge hasn't already been traversed.
foreach (var referenceNode in node.ProjectReferences)
{
var applicableTargets = targetsToPropagate.GetApplicableTargetsForReference(referenceNode.ProjectInstance);
if (applicableTargets.IsEmpty)
{
continue;
}
var expandedTargets = ExpandDefaultTargets(
applicableTargets,
referenceNode.ProjectInstance.DefaultTargets,
Edges[(node, referenceNode)]);
var projectReferenceEdge = new ProjectGraphBuildRequest(
referenceNode,
expandedTargets);
if (encounteredEdges.Add(projectReferenceEdge))
{
edgesToVisit.Enqueue(projectReferenceEdge);
}
}
}
// Dedupe target lists
var entriesToUpdate = new List<KeyValuePair<ProjectGraphNode, ImmutableList<string>>>();
foreach (var pair in targetLists)
{
var targetList = pair.Value;
var seenTargets = new SortedSet<string>(StringComparer.OrdinalIgnoreCase);
var i = 0;
while (i < targetList.Count)
{
if (seenTargets.Add(targetList[i]))
{
i++;
}
else
{
targetList = targetList.RemoveAt(i);
}
}
// Only update if it changed
if (targetList != pair.Value)
{
entriesToUpdate.Add(new KeyValuePair<ProjectGraphNode, ImmutableList<string>>(pair.Key, targetList));
}
}
// Update in a separate pass to avoid modifying a collection while iterating it.
foreach (var pair in entriesToUpdate)
{
targetLists[pair.Key] = pair.Value;
}
return targetLists;
void ThrowOnEmptyTargetNames(ICollection<string> targetNames)
{
if (targetNames == null || targetNames.Count == 0)
{
return;
}
if (targetNames.Any(targetName => string.IsNullOrWhiteSpace(targetName)))
{
throw new ArgumentException(ResourceUtilities.FormatResourceStringIgnoreCodeAndKeyword("OM_TargetNameNullOrEmpty", nameof(GetTargetLists)));
}
}
}
private static ImmutableList<string> ExpandDefaultTargets(ImmutableList<string> targets, List<string> defaultTargets, ProjectItemInstance graphEdge)
{
var i = 0;
while (i < targets.Count)
{
if (targets[i].Equals(MSBuildConstants.DefaultTargetsMarker, StringComparison.OrdinalIgnoreCase))
{
targets = targets
.RemoveAt(i)
.InsertRange(i, defaultTargets);
i += defaultTargets.Count;
}
else if (targets[i].Equals(MSBuildConstants.ProjectReferenceTargetsOrDefaultTargetsMarker, StringComparison.OrdinalIgnoreCase))
{
var targetsString = graphEdge.GetMetadataValue(ItemMetadataNames.ProjectReferenceTargetsMetadataName);
var expandedTargets = string.IsNullOrEmpty(targetsString)
? defaultTargets
: ExpressionShredder.SplitSemiColonSeparatedList(targetsString).ToList();
targets = targets
.RemoveAt(i)
.InsertRange(i, expandedTargets);
i += expandedTargets.Count;
}
else
{
i++;
}
}
return targets;
}
internal static ProjectInstance DefaultProjectInstanceFactory(
string projectPath,
Dictionary<string, string> globalProperties,
ProjectCollection projectCollection)
{
return new ProjectInstance(
projectPath,
globalProperties,
MSBuildConstants.CurrentToolsVersion,
projectCollection);
}
private struct ProjectGraphBuildRequest : IEquatable<ProjectGraphBuildRequest>
{
public ProjectGraphBuildRequest(ProjectGraphNode node, ImmutableList<string> targets)
{
Node = node ?? throw new ArgumentNullException(nameof(node));
RequestedTargets = targets ?? throw new ArgumentNullException(nameof(targets));
}
public ProjectGraphNode Node { get; }
public ImmutableList<string> RequestedTargets { get; }
public bool Equals(ProjectGraphBuildRequest other)
{
if (Node != other.Node
|| RequestedTargets.Count != other.RequestedTargets.Count)
{
return false;
}
// Target order is important
for (var i = 0; i < RequestedTargets.Count; i++)
{
if (!RequestedTargets[i].Equals(other.RequestedTargets[i], StringComparison.OrdinalIgnoreCase))
{
return false;
}
}
return true;
}
public override bool Equals(object obj)
{
return !(obj is null) && obj is ProjectGraphBuildRequest graphNodeWithTargets && Equals(graphNodeWithTargets);
}
public override int GetHashCode()
{
unchecked
{
const int salt = 397;
var hashCode = Node.GetHashCode() * salt;
for (var i = 0; i < RequestedTargets.Count; i++)
{
hashCode *= salt;
hashCode ^= StringComparer.OrdinalIgnoreCase.GetHashCode(RequestedTargets[i]);
}
return hashCode;
}
}
}
}
}