-
Notifications
You must be signed in to change notification settings - Fork 4k
/
AnalyzerDriver.cs
2963 lines (2555 loc) · 142 KB
/
AnalyzerDriver.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
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.Collections.Immutable;
using System.Diagnostics;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.CodeAnalysis.Collections;
using Microsoft.CodeAnalysis.Diagnostics.Telemetry;
using Microsoft.CodeAnalysis.Operations;
using Microsoft.CodeAnalysis.PooledObjects;
using Microsoft.CodeAnalysis.Text;
using Roslyn.Utilities;
namespace Microsoft.CodeAnalysis.Diagnostics
{
/// <summary>
/// Driver to execute diagnostic analyzers for a given compilation.
/// It uses a <see cref="AsyncQueue{TElement}"/> of <see cref="CompilationEvent"/>s to drive its analysis.
/// </summary>
internal abstract partial class AnalyzerDriver : IDisposable
{
// Protect against vicious analyzers that provide large values for SymbolKind.
private const int MaxSymbolKind = 100;
// Cache delegates for static methods
// NOTE: These methods are on hot paths and cause large allocation hit if removed.
private static readonly Func<DiagnosticAnalyzer, bool> s_IsCompilerAnalyzerFunc = IsCompilerAnalyzer;
private static readonly Func<ISymbol, SyntaxReference, Compilation, CancellationToken, SyntaxNode> s_getTopmostNodeForAnalysis = GetTopmostNodeForAnalysis;
private readonly Func<SyntaxTree, CancellationToken, bool> _isGeneratedCode;
/// <summary>
/// Set of diagnostic suppressions that are suppressed via analyzer suppression actions.
/// </summary>
private readonly ConcurrentSet<Suppression>? _programmaticSuppressions;
/// <summary>
/// Set of diagnostics that have already been processed for application of programmatic suppressions.
/// </summary>
private readonly ConcurrentSet<Diagnostic>? _diagnosticsProcessedForProgrammaticSuppressions;
/// <summary>
/// Flag indicating if the <see cref="Analyzers"/> include any <see cref="DiagnosticSuppressor"/>
/// which can suppress reported analyzer/compiler diagnostics.
/// </summary>
private readonly bool _hasDiagnosticSuppressors;
/// <summary>
/// Filtered diagnostic severities in the compilation, i.e. diagnostics with effective severity from this set should not be reported.
/// PERF: If all supported diagnostics for an analyzer are from this set, we completely skip executing the analyzer.
/// </summary>
private readonly SeverityFilter _severityFilter;
protected ImmutableArray<DiagnosticAnalyzer> Analyzers { get; }
protected AnalyzerManager AnalyzerManager { get; }
// Lazy fields/properties
private CancellationTokenRegistration? _lazyQueueRegistration;
private AnalyzerExecutor? _lazyAnalyzerExecutor;
protected AnalyzerExecutor AnalyzerExecutor
{
get
{
Debug.Assert(_lazyAnalyzerExecutor != null);
return _lazyAnalyzerExecutor;
}
}
private CompilationData? _lazyCurrentCompilationData;
protected CompilationData CurrentCompilationData
{
get
{
Debug.Assert(_lazyCurrentCompilationData != null);
return _lazyCurrentCompilationData;
}
}
protected CachingSemanticModelProvider SemanticModelProvider => CurrentCompilationData.SemanticModelProvider;
protected ref readonly AnalyzerActions AnalyzerActions => ref _lazyAnalyzerActions;
private ImmutableHashSet<DiagnosticAnalyzer>? _lazyUnsuppressedAnalyzers;
/// <summary>
/// Unsuppressed analyzers that need to be executed.
/// </summary>
protected ImmutableHashSet<DiagnosticAnalyzer> UnsuppressedAnalyzers
{
get
{
Debug.Assert(_lazyUnsuppressedAnalyzers != null);
return _lazyUnsuppressedAnalyzers;
}
}
private ConcurrentDictionary<(INamespaceOrTypeSymbol, DiagnosticAnalyzer), IGroupedAnalyzerActions>? _lazyPerSymbolAnalyzerActionsCache;
/// <summary>
/// Cache of additional analyzer actions to be executed per symbol per analyzer, which are registered in symbol start actions.
/// We cache the tuple:
/// 1. myActions: analyzer actions registered in the symbol start actions of containing namespace/type, which are to be executed for this symbol
/// 2. childActions: analyzer actions registered in this symbol's start actions, which are to be executed for member symbols.
/// </summary>
private ConcurrentDictionary<(INamespaceOrTypeSymbol, DiagnosticAnalyzer), IGroupedAnalyzerActions> PerSymbolAnalyzerActionsCache
{
get
{
Debug.Assert(_lazyPerSymbolAnalyzerActionsCache != null);
return _lazyPerSymbolAnalyzerActionsCache;
}
}
private ImmutableArray<(DiagnosticAnalyzer, ImmutableArray<ImmutableArray<SymbolAnalyzerAction>>)> _lazySymbolActionsByKind;
private ImmutableArray<(DiagnosticAnalyzer, ImmutableArray<SemanticModelAnalyzerAction>)> _lazySemanticModelActions;
private ImmutableArray<(DiagnosticAnalyzer, ImmutableArray<SyntaxTreeAnalyzerAction>)> _lazySyntaxTreeActions;
private ImmutableArray<(DiagnosticAnalyzer, ImmutableArray<AdditionalFileAnalyzerAction>)> _lazyAdditionalFileActions;
// Compilation actions and compilation end actions have separate maps so that it is easy to
// execute the compilation actions before the compilation end actions.
private ImmutableArray<(DiagnosticAnalyzer, ImmutableArray<CompilationAnalyzerAction>)> _lazyCompilationActions;
private ImmutableArray<(DiagnosticAnalyzer, ImmutableArray<CompilationAnalyzerAction>)> _lazyCompilationEndActions;
private ImmutableHashSet<DiagnosticAnalyzer>? _lazyCompilationEndAnalyzers;
private ImmutableHashSet<DiagnosticAnalyzer> CompilationEndAnalyzers
{
get
{
Debug.Assert(_lazyCompilationEndAnalyzers != null);
return _lazyCompilationEndAnalyzers;
}
}
/// <summary>
/// Default analysis mode for generated code.
/// </summary>
/// <remarks>
/// This mode should always guarantee that analyzer action callbacks are enabled for generated code, i.e. <see cref="GeneratedCodeAnalysisFlags.Analyze"/> is set.
/// However, the default diagnostic reporting mode is liable to change in future.
/// </remarks>
internal const GeneratedCodeAnalysisFlags DefaultGeneratedCodeAnalysisFlags = GeneratedCodeAnalysisFlags.Analyze | GeneratedCodeAnalysisFlags.ReportDiagnostics;
/// <summary>
/// Map from non-concurrent analyzers to the gate guarding callback into the analyzer.
/// </summary>
private ImmutableDictionary<DiagnosticAnalyzer, SemaphoreSlim>? _lazyAnalyzerGateMap;
private ImmutableDictionary<DiagnosticAnalyzer, SemaphoreSlim> AnalyzerGateMap
{
get
{
Debug.Assert(_lazyAnalyzerGateMap != null);
return _lazyAnalyzerGateMap;
}
}
private ImmutableSegmentedDictionary<DiagnosticAnalyzer, GeneratedCodeAnalysisFlags> _lazyGeneratedCodeAnalysisFlagsMap;
/// <summary>
/// Map from analyzers to their <see cref="GeneratedCodeAnalysisFlags"/> setting.
/// </summary>
private ImmutableSegmentedDictionary<DiagnosticAnalyzer, GeneratedCodeAnalysisFlags> GeneratedCodeAnalysisFlagsMap
{
get
{
Debug.Assert(!_lazyGeneratedCodeAnalysisFlagsMap.IsDefault);
return _lazyGeneratedCodeAnalysisFlagsMap;
}
}
/// <summary>
/// The set of registered analyzer actions.
/// </summary>
/// <seealso cref="AnalyzerActions"/>
private AnalyzerActions _lazyAnalyzerActions;
private ImmutableHashSet<DiagnosticAnalyzer>? _lazyNonConfigurableAnalyzers;
/// <summary>
/// Set of unsuppressed analyzers that report non-configurable diagnostics that cannot be suppressed with end user configuration.
/// </summary>
private ImmutableHashSet<DiagnosticAnalyzer> NonConfigurableAnalyzers
{
get
{
Debug.Assert(_lazyNonConfigurableAnalyzers != null);
return _lazyNonConfigurableAnalyzers;
}
}
private ImmutableHashSet<DiagnosticAnalyzer>? _lazySymbolStartAnalyzers;
/// <summary>
/// Set of analyzers that have registered symbol start analyzer actions.
/// </summary>
private ImmutableHashSet<DiagnosticAnalyzer> SymbolStartAnalyzers
{
get
{
Debug.Assert(_lazySymbolStartAnalyzers != null);
return _lazySymbolStartAnalyzers;
}
}
private bool? _lazyTreatAllCodeAsNonGeneratedCode;
/// <summary>
/// True if all analyzers need to analyze and report diagnostics in generated code - we can assume all code to be non-generated code.
/// </summary>
private bool TreatAllCodeAsNonGeneratedCode
{
get
{
Debug.Assert(_lazyTreatAllCodeAsNonGeneratedCode.HasValue);
return _lazyTreatAllCodeAsNonGeneratedCode.Value;
}
}
/// <summary>
/// True if no analyzer needs generated code analysis - we can skip all analysis on a generated code symbol/tree.
/// </summary>
private bool? _lazyDoNotAnalyzeGeneratedCode;
private ConcurrentDictionary<SyntaxTree, bool>? _lazyGeneratedCodeFilesMap;
/// <summary>
/// Lazily populated dictionary indicating whether a source file is a generated code file or not - we populate it lazily to avoid realizing all syntax trees in the compilation upfront.
/// </summary>
private ConcurrentDictionary<SyntaxTree, bool> GeneratedCodeFilesMap
{
get
{
Debug.Assert(_lazyGeneratedCodeFilesMap != null);
return _lazyGeneratedCodeFilesMap;
}
}
private Dictionary<SyntaxTree, ImmutableHashSet<ISymbol>>? _lazyGeneratedCodeSymbolsForTreeMap;
/// <summary>
/// Lazily populated dictionary from tree to declared symbols with GeneratedCodeAttribute.
/// </summary>
private Dictionary<SyntaxTree, ImmutableHashSet<ISymbol>> GeneratedCodeSymbolsForTreeMap
{
get
{
Debug.Assert(_lazyGeneratedCodeSymbolsForTreeMap != null);
return _lazyGeneratedCodeSymbolsForTreeMap;
}
}
private ConcurrentDictionary<SyntaxTree, ImmutableHashSet<DiagnosticAnalyzer>>? _lazySuppressedAnalyzersForTreeMap;
/// <summary>
/// Lazily populated dictionary from tree to analyzers that are suppressed on the entire tree.
/// </summary>
private ConcurrentDictionary<SyntaxTree, ImmutableHashSet<DiagnosticAnalyzer>> SuppressedAnalyzersForTreeMap
{
get
{
Debug.Assert(_lazySuppressedAnalyzersForTreeMap != null);
return _lazySuppressedAnalyzersForTreeMap;
}
}
private ConcurrentDictionary<ISymbol, bool>? _lazyIsGeneratedCodeSymbolMap;
/// <summary>
/// Lazily populated dictionary from symbol to a bool indicating if it is a generated code symbol.
/// </summary>
private ConcurrentDictionary<ISymbol, bool> IsGeneratedCodeSymbolMap
{
get
{
Debug.Assert(_lazyIsGeneratedCodeSymbolMap != null);
return _lazyIsGeneratedCodeSymbolMap;
}
}
/// <summary>
/// Lazily populated dictionary indicating whether a source file has any hidden regions - we populate it lazily to avoid realizing all syntax trees in the compilation upfront.
/// </summary>
private ConcurrentDictionary<SyntaxTree, bool>? _lazyTreesWithHiddenRegionsMap;
/// <summary>
/// Symbol for <see cref="System.CodeDom.Compiler.GeneratedCodeAttribute"/>.
/// </summary>
private INamedTypeSymbol? _lazyGeneratedCodeAttribute;
/// <summary>
/// Driver task which initializes all analyzers.
/// This task is initialized and executed only once at start of analysis.
/// </summary>
private Task? _lazyInitializeTask;
/// <summary>
/// Flag to indicate if the <see cref="_lazyInitializeTask"/> was successfully started.
/// </summary>
private bool _initializeSucceeded = false;
/// <summary>
/// Primary driver task which processes all <see cref="CompilationEventQueue"/> events, runs analyzer actions and signals completion of <see cref="DiagnosticQueue"/> at the end.
/// </summary>
private Task? _lazyPrimaryTask;
/// <summary>
/// Number of worker tasks processing compilation events and executing analyzer actions.
/// </summary>
private readonly int _workerCount = Environment.ProcessorCount;
private AsyncQueue<CompilationEvent>? _lazyCompilationEventQueue;
/// <summary>
/// Events queue for analyzer execution.
/// </summary>
public AsyncQueue<CompilationEvent> CompilationEventQueue
{
get
{
Debug.Assert(_lazyCompilationEventQueue != null);
return _lazyCompilationEventQueue;
}
}
private DiagnosticQueue? _lazyDiagnosticQueue;
/// <summary>
/// <see cref="DiagnosticQueue"/> that is fed the diagnostics as they are computed.
/// </summary>
public DiagnosticQueue DiagnosticQueue
{
get
{
Debug.Assert(_lazyDiagnosticQueue != null);
return _lazyDiagnosticQueue;
}
}
/// <summary>
/// Create an analyzer driver.
/// </summary>
/// <param name="analyzers">The set of analyzers to include in the analysis</param>
/// <param name="analyzerManager">AnalyzerManager to manage analyzers for analyzer host's lifetime.</param>
/// <param name="severityFilter">Filtered diagnostic severities in the compilation, i.e. diagnostics with effective severity from this set should not be reported.</param>
/// <param name="isComment">Delegate to identify if the given trivia is a comment.</param>
protected AnalyzerDriver(ImmutableArray<DiagnosticAnalyzer> analyzers, AnalyzerManager analyzerManager, SeverityFilter severityFilter, Func<SyntaxTrivia, bool> isComment)
{
Debug.Assert(!severityFilter.Contains(ReportDiagnostic.Suppress));
Debug.Assert(!severityFilter.Contains(ReportDiagnostic.Default));
this.Analyzers = analyzers;
this.AnalyzerManager = analyzerManager;
_isGeneratedCode = (tree, ct) => GeneratedCodeUtilities.IsGeneratedCode(tree, isComment, ct);
_severityFilter = severityFilter;
_hasDiagnosticSuppressors = this.Analyzers.Any(a => a is DiagnosticSuppressor);
_programmaticSuppressions = _hasDiagnosticSuppressors ? new ConcurrentSet<Suppression>() : null;
_diagnosticsProcessedForProgrammaticSuppressions = _hasDiagnosticSuppressors ? new ConcurrentSet<Diagnostic>(ReferenceEqualityComparer.Instance) : null;
_lazyAnalyzerGateMap = ImmutableDictionary<DiagnosticAnalyzer, SemaphoreSlim>.Empty;
}
/// <summary>
/// Initializes the <see cref="AnalyzerActions"/> and related actions maps for the analyzer driver.
/// It kicks off the <see cref="WhenInitializedTask"/> task for initialization.
/// Note: This method must be invoked exactly once on the driver.
/// </summary>
private void Initialize(AnalyzerExecutor analyzerExecutor, DiagnosticQueue diagnosticQueue, CompilationData compilationData, CancellationToken cancellationToken)
{
try
{
Debug.Assert(_lazyInitializeTask == null);
_lazyAnalyzerExecutor = analyzerExecutor;
_lazyCurrentCompilationData = compilationData;
_lazyDiagnosticQueue = diagnosticQueue;
// Compute the set of effective actions based on suppression, and running the initial analyzers
_lazyInitializeTask = Task.Run(async () =>
{
(_lazyAnalyzerActions, _lazyUnsuppressedAnalyzers) = await GetAnalyzerActionsAsync(Analyzers, AnalyzerManager, analyzerExecutor, _severityFilter).ConfigureAwait(false);
_lazyAnalyzerGateMap = await CreateAnalyzerGateMapAsync(UnsuppressedAnalyzers, AnalyzerManager, analyzerExecutor, _severityFilter).ConfigureAwait(false);
_lazyNonConfigurableAnalyzers = ComputeNonConfigurableAnalyzers(UnsuppressedAnalyzers);
_lazySymbolStartAnalyzers = ComputeSymbolStartAnalyzers(UnsuppressedAnalyzers);
_lazyGeneratedCodeAnalysisFlagsMap = await CreateGeneratedCodeAnalysisFlagsMapAsync(UnsuppressedAnalyzers, AnalyzerManager, analyzerExecutor, _severityFilter).ConfigureAwait(false);
_lazyTreatAllCodeAsNonGeneratedCode = ComputeShouldTreatAllCodeAsNonGeneratedCode(UnsuppressedAnalyzers, GeneratedCodeAnalysisFlagsMap);
_lazyDoNotAnalyzeGeneratedCode = ComputeShouldSkipAnalysisOnGeneratedCode(UnsuppressedAnalyzers, GeneratedCodeAnalysisFlagsMap, TreatAllCodeAsNonGeneratedCode);
_lazyGeneratedCodeFilesMap = TreatAllCodeAsNonGeneratedCode ? null : new ConcurrentDictionary<SyntaxTree, bool>();
_lazyGeneratedCodeSymbolsForTreeMap = TreatAllCodeAsNonGeneratedCode ? null : new Dictionary<SyntaxTree, ImmutableHashSet<ISymbol>>();
_lazyIsGeneratedCodeSymbolMap = TreatAllCodeAsNonGeneratedCode ? null : new ConcurrentDictionary<ISymbol, bool>();
_lazyTreesWithHiddenRegionsMap = TreatAllCodeAsNonGeneratedCode ? null : new ConcurrentDictionary<SyntaxTree, bool>();
_lazySuppressedAnalyzersForTreeMap = new ConcurrentDictionary<SyntaxTree, ImmutableHashSet<DiagnosticAnalyzer>>();
_lazyGeneratedCodeAttribute = analyzerExecutor.Compilation?.GetTypeByMetadataName("System.CodeDom.Compiler.GeneratedCodeAttribute");
_lazySymbolActionsByKind = MakeSymbolActionsByKind(in AnalyzerActions);
_lazySemanticModelActions = MakeActionsByAnalyzer(AnalyzerActions.SemanticModelActions);
_lazySyntaxTreeActions = MakeActionsByAnalyzer(AnalyzerActions.SyntaxTreeActions);
_lazyAdditionalFileActions = MakeActionsByAnalyzer(AnalyzerActions.AdditionalFileActions);
_lazyCompilationActions = MakeActionsByAnalyzer(this.AnalyzerActions.CompilationActions);
_lazyCompilationEndActions = MakeActionsByAnalyzer(this.AnalyzerActions.CompilationEndActions);
_lazyCompilationEndAnalyzers = MakeCompilationEndAnalyzers(_lazyCompilationEndActions);
if (this.AnalyzerActions.SymbolStartActionsCount > 0)
{
_lazyPerSymbolAnalyzerActionsCache = new ConcurrentDictionary<(INamespaceOrTypeSymbol, DiagnosticAnalyzer), IGroupedAnalyzerActions>();
}
}, cancellationToken);
// create the primary driver task.
cancellationToken.ThrowIfCancellationRequested();
_initializeSucceeded = true;
}
finally
{
if (_lazyInitializeTask == null)
{
// Set initializeTask to be a cancelled task.
_lazyInitializeTask = Task.FromCanceled(new CancellationToken(canceled: true));
// Set primaryTask to be a cancelled task.
_lazyPrimaryTask = Task.FromCanceled(new CancellationToken(canceled: true));
// Try to set the DiagnosticQueue to be complete.
this.DiagnosticQueue.TryComplete();
}
}
}
internal void Initialize(
Compilation compilation,
CompilationWithAnalyzersOptions analysisOptions,
CompilationData compilationData,
bool categorizeDiagnostics,
CancellationToken cancellationToken)
{
Debug.Assert(_lazyInitializeTask == null);
Debug.Assert(compilation.SemanticModelProvider != null);
var diagnosticQueue = DiagnosticQueue.Create(categorizeDiagnostics);
Action<Diagnostic>? addNotCategorizedDiagnostic = null;
Action<Diagnostic, DiagnosticAnalyzer, bool>? addCategorizedLocalDiagnostic = null;
Action<Diagnostic, DiagnosticAnalyzer>? addCategorizedNonLocalDiagnostic = null;
if (categorizeDiagnostics)
{
addCategorizedLocalDiagnostic = GetDiagnosticSink(diagnosticQueue.EnqueueLocal, compilation, analysisOptions.Options, _severityFilter, cancellationToken);
addCategorizedNonLocalDiagnostic = GetDiagnosticSink(diagnosticQueue.EnqueueNonLocal, compilation, analysisOptions.Options, _severityFilter, cancellationToken);
}
else
{
addNotCategorizedDiagnostic = GetDiagnosticSink(diagnosticQueue.Enqueue, compilation, analysisOptions.Options, _severityFilter, cancellationToken);
}
// Wrap onAnalyzerException to pass in filtered diagnostic.
Action<Exception, DiagnosticAnalyzer, Diagnostic> newOnAnalyzerException = (ex, analyzer, diagnostic) =>
{
var filteredDiagnostic = GetFilteredDiagnostic(diagnostic, compilation, analysisOptions.Options, _severityFilter, cancellationToken);
if (filteredDiagnostic != null)
{
if (analysisOptions.OnAnalyzerException != null)
{
analysisOptions.OnAnalyzerException(ex, analyzer, filteredDiagnostic);
}
else if (categorizeDiagnostics)
{
addCategorizedNonLocalDiagnostic!(filteredDiagnostic, analyzer);
}
else
{
addNotCategorizedDiagnostic!(filteredDiagnostic);
}
}
};
var analyzerExecutor = AnalyzerExecutor.Create(
compilation, analysisOptions.Options ?? AnalyzerOptions.Empty, addNotCategorizedDiagnostic, newOnAnalyzerException, analysisOptions.AnalyzerExceptionFilter,
IsCompilerAnalyzer, AnalyzerManager, ShouldSkipAnalysisOnGeneratedCode, ShouldSuppressGeneratedCodeDiagnostic, IsGeneratedOrHiddenCodeLocation, IsAnalyzerSuppressedForTree, GetAnalyzerGate,
getSemanticModel: GetOrCreateSemanticModel,
analysisOptions.LogAnalyzerExecutionTime, addCategorizedLocalDiagnostic, addCategorizedNonLocalDiagnostic, s => _programmaticSuppressions!.Add(s), cancellationToken);
Initialize(analyzerExecutor, diagnosticQueue, compilationData, cancellationToken);
}
private SemaphoreSlim? GetAnalyzerGate(DiagnosticAnalyzer analyzer)
{
if (AnalyzerGateMap.TryGetValue(analyzer, out var gate))
{
// Non-concurrent analyzer, needs all the callbacks guarded by a gate.
return gate;
}
// Concurrent analyzer.
return null;
}
private ImmutableHashSet<DiagnosticAnalyzer> ComputeNonConfigurableAnalyzers(ImmutableHashSet<DiagnosticAnalyzer> unsuppressedAnalyzers)
{
var builder = ImmutableHashSet.CreateBuilder<DiagnosticAnalyzer>();
foreach (var analyzer in unsuppressedAnalyzers)
{
var descriptors = AnalyzerManager.GetSupportedDiagnosticDescriptors(analyzer, AnalyzerExecutor);
foreach (var descriptor in descriptors)
{
if (descriptor.IsNotConfigurable())
{
builder.Add(analyzer);
break;
}
}
}
return builder.ToImmutableHashSet();
}
private ImmutableHashSet<DiagnosticAnalyzer> ComputeSymbolStartAnalyzers(ImmutableHashSet<DiagnosticAnalyzer> unsuppressedAnalyzers)
{
var builder = ImmutableHashSet.CreateBuilder<DiagnosticAnalyzer>();
foreach (var action in this.AnalyzerActions.SymbolStartActions)
{
if (unsuppressedAnalyzers.Contains(action.Analyzer))
{
builder.Add(action.Analyzer);
}
}
return builder.ToImmutableHashSet();
}
private static bool ComputeShouldSkipAnalysisOnGeneratedCode(
ImmutableHashSet<DiagnosticAnalyzer> analyzers,
ImmutableSegmentedDictionary<DiagnosticAnalyzer, GeneratedCodeAnalysisFlags> generatedCodeAnalysisFlagsMap,
bool treatAllCodeAsNonGeneratedCode)
{
foreach (var analyzer in analyzers)
{
if (!ShouldSkipAnalysisOnGeneratedCode(analyzer, generatedCodeAnalysisFlagsMap, treatAllCodeAsNonGeneratedCode))
{
return false;
}
}
return true;
}
/// <summary>
/// Returns true if all analyzers need to analyze and report diagnostics in generated code - we can assume all code to be non-generated code.
/// </summary>
private static bool ComputeShouldTreatAllCodeAsNonGeneratedCode(ImmutableHashSet<DiagnosticAnalyzer> analyzers, ImmutableSegmentedDictionary<DiagnosticAnalyzer, GeneratedCodeAnalysisFlags> generatedCodeAnalysisFlagsMap)
{
foreach (var analyzer in analyzers)
{
var flags = generatedCodeAnalysisFlagsMap[analyzer];
var analyze = (flags & GeneratedCodeAnalysisFlags.Analyze) != 0;
var report = (flags & GeneratedCodeAnalysisFlags.ReportDiagnostics) != 0;
if (!analyze || !report)
{
return false;
}
}
return true;
}
private bool ShouldSkipAnalysisOnGeneratedCode(DiagnosticAnalyzer analyzer)
=> ShouldSkipAnalysisOnGeneratedCode(analyzer, GeneratedCodeAnalysisFlagsMap, TreatAllCodeAsNonGeneratedCode);
private static bool ShouldSkipAnalysisOnGeneratedCode(
DiagnosticAnalyzer analyzer,
ImmutableSegmentedDictionary<DiagnosticAnalyzer, GeneratedCodeAnalysisFlags> generatedCodeAnalysisFlagsMap,
bool treatAllCodeAsNonGeneratedCode)
{
if (treatAllCodeAsNonGeneratedCode)
{
return false;
}
var mode = generatedCodeAnalysisFlagsMap[analyzer];
return (mode & GeneratedCodeAnalysisFlags.Analyze) == 0;
}
private bool ShouldSuppressGeneratedCodeDiagnostic(Diagnostic diagnostic, DiagnosticAnalyzer analyzer, Compilation compilation, CancellationToken cancellationToken)
{
if (TreatAllCodeAsNonGeneratedCode)
{
return false;
}
var generatedCodeAnalysisFlags = GeneratedCodeAnalysisFlagsMap[analyzer];
var suppressInGeneratedCode = (generatedCodeAnalysisFlags & GeneratedCodeAnalysisFlags.ReportDiagnostics) == 0;
return suppressInGeneratedCode && IsInGeneratedCode(diagnostic.Location, compilation, cancellationToken);
}
/// <summary>
/// Attaches a pre-populated event queue to the driver and processes all events in the queue.
/// </summary>
/// <param name="eventQueue">Compilation events to analyze.</param>
/// <param name="analysisScope">Scope of analysis.</param>
/// <param name="analysisState">An optional object to track partial analysis state.</param>
/// <param name="cancellationToken">Cancellation token to abort analysis.</param>
/// <remarks>Driver must be initialized before invoking this method, i.e. <see cref="Initialize(AnalyzerExecutor, DiagnosticQueue, CompilationData, CancellationToken)"/> method must have been invoked and <see cref="WhenInitializedTask"/> must be non-null.</remarks>
internal async Task AttachQueueAndProcessAllEventsAsync(AsyncQueue<CompilationEvent> eventQueue, AnalysisScope analysisScope, AnalysisState? analysisState, CancellationToken cancellationToken)
{
try
{
if (_initializeSucceeded)
{
_lazyCompilationEventQueue = eventQueue;
_lazyQueueRegistration = default(CancellationTokenRegistration);
await ExecutePrimaryAnalysisTaskAsync(analysisScope, analysisState, usingPrePopulatedEventQueue: true, cancellationToken: cancellationToken).ConfigureAwait(false);
_lazyPrimaryTask = Task.FromResult(true);
}
}
finally
{
if (_lazyPrimaryTask == null)
{
// Set primaryTask to be a cancelled task.
_lazyPrimaryTask = Task.FromCanceled(new CancellationToken(canceled: true));
}
}
}
/// <summary>
/// Attaches event queue to the driver and start processing all events pertaining to the given analysis scope.
/// </summary>
/// <param name="eventQueue">Compilation events to analyze.</param>
/// <param name="analysisScope">Scope of analysis.</param>
/// <param name="cancellationToken">Cancellation token to abort analysis.</param>
/// <remarks>Driver must be initialized before invoking this method, i.e. <see cref="Initialize(AnalyzerExecutor, DiagnosticQueue, CompilationData, CancellationToken)"/> method must have been invoked and <see cref="WhenInitializedTask"/> must be non-null.</remarks>
internal void AttachQueueAndStartProcessingEvents(AsyncQueue<CompilationEvent> eventQueue, AnalysisScope analysisScope, CancellationToken cancellationToken)
{
try
{
if (_initializeSucceeded)
{
_lazyCompilationEventQueue = eventQueue;
_lazyQueueRegistration = cancellationToken.Register(() =>
{
this.CompilationEventQueue.TryComplete();
this.DiagnosticQueue.TryComplete();
});
_lazyPrimaryTask = ExecutePrimaryAnalysisTaskAsync(analysisScope, analysisState: null, usingPrePopulatedEventQueue: false, cancellationToken: cancellationToken)
.ContinueWith(c => DiagnosticQueue.TryComplete(), cancellationToken, TaskContinuationOptions.ExecuteSynchronously, TaskScheduler.Default);
}
}
finally
{
if (_lazyPrimaryTask == null)
{
// Set primaryTask to be a cancelled task.
_lazyPrimaryTask = Task.FromCanceled(new CancellationToken(canceled: true));
// Try to set the DiagnosticQueue to be complete.
this.DiagnosticQueue.TryComplete();
}
}
}
private async Task ExecutePrimaryAnalysisTaskAsync(AnalysisScope analysisScope, AnalysisState? analysisState, bool usingPrePopulatedEventQueue, CancellationToken cancellationToken)
{
Debug.Assert(analysisScope != null);
await WhenInitializedTask.ConfigureAwait(false);
if (WhenInitializedTask.IsFaulted)
{
OnDriverException(WhenInitializedTask, this.AnalyzerExecutor, analysisScope.Analyzers);
}
else if (!WhenInitializedTask.IsCanceled)
{
_lazyAnalyzerExecutor = this.AnalyzerExecutor.WithCancellationToken(cancellationToken);
await ProcessCompilationEventsAsync(analysisScope, analysisState, usingPrePopulatedEventQueue, cancellationToken).ConfigureAwait(false);
// If not using pre-populated event queue (batch mode), then verify all symbol end actions were processed.
if (!usingPrePopulatedEventQueue)
{
AnalyzerManager.VerifyAllSymbolEndActionsExecuted();
}
}
}
private static void OnDriverException(Task faultedTask, AnalyzerExecutor analyzerExecutor, ImmutableArray<DiagnosticAnalyzer> analyzers)
{
Debug.Assert(faultedTask.IsFaulted);
var innerException = faultedTask.Exception?.InnerException;
if (innerException == null || innerException is OperationCanceledException)
{
return;
}
var diagnostic = AnalyzerExecutor.CreateDriverExceptionDiagnostic(innerException);
// Just pick the first analyzer from the scope for the onAnalyzerException callback.
// The exception diagnostic's message and description will not include the analyzer, but explicitly state its a driver exception.
var analyzer = analyzers[0];
analyzerExecutor.OnAnalyzerException(innerException, analyzer, diagnostic);
}
private void ExecuteSyntaxTreeActions(AnalysisScope analysisScope, AnalysisState? analysisState, CancellationToken cancellationToken)
{
if (analysisScope.IsSingleFileAnalysis && !analysisScope.IsSyntacticSingleFileAnalysis)
{
// For partial analysis, only execute syntax tree actions if performing syntax analysis.
return;
}
foreach (var tree in analysisScope.SyntaxTrees)
{
var isGeneratedCode = IsGeneratedCode(tree);
var file = new SourceOrAdditionalFile(tree);
if (isGeneratedCode && DoNotAnalyzeGeneratedCode)
{
analysisState?.MarkSyntaxAnalysisComplete(file, analysisScope.Analyzers);
continue;
}
var processedAnalyzers = analysisState != null ? PooledHashSet<DiagnosticAnalyzer>.GetInstance() : null;
try
{
foreach (var (analyzer, syntaxTreeActions) in _lazySyntaxTreeActions)
{
if (!analysisScope.Contains(analyzer))
{
continue;
}
cancellationToken.ThrowIfCancellationRequested();
// Execute actions for a given analyzer sequentially.
AnalyzerExecutor.TryExecuteSyntaxTreeActions(syntaxTreeActions, analyzer, file, analysisScope, analysisState, isGeneratedCode);
processedAnalyzers?.Add(analyzer);
}
analysisState?.MarkSyntaxAnalysisCompleteForUnprocessedAnalyzers(file, analysisScope, processedAnalyzers!);
}
finally
{
processedAnalyzers?.Free();
}
}
}
private void ExecuteAdditionalFileActions(AnalysisScope analysisScope, AnalysisState? analysisState, CancellationToken cancellationToken)
{
if (analysisScope.IsSingleFileAnalysis && !analysisScope.IsSyntacticSingleFileAnalysis)
{
// For partial analysis, only execute additional file actions if performing syntactic single file analysis.
return;
}
foreach (var additionalFile in analysisScope.AdditionalFiles)
{
var file = new SourceOrAdditionalFile(additionalFile);
var processedAnalyzers = analysisState != null ? PooledHashSet<DiagnosticAnalyzer>.GetInstance() : null;
try
{
foreach (var (analyzer, additionalFileActions) in _lazyAdditionalFileActions)
{
if (!analysisScope.Contains(analyzer))
{
continue;
}
cancellationToken.ThrowIfCancellationRequested();
// Execute actions for a given analyzer sequentially.
AnalyzerExecutor.TryExecuteAdditionalFileActions(additionalFileActions, analyzer, file, analysisScope, analysisState);
processedAnalyzers?.Add(analyzer);
}
analysisState?.MarkSyntaxAnalysisCompleteForUnprocessedAnalyzers(file, analysisScope, processedAnalyzers!);
}
finally
{
processedAnalyzers?.Free();
}
}
}
/// <summary>
/// Create an <see cref="AnalyzerDriver"/> and attach it to the given compilation.
/// </summary>
/// <param name="compilation">The compilation to which the new driver should be attached.</param>
/// <param name="analyzers">The set of analyzers to include in the analysis.</param>
/// <param name="options">Options that are passed to analyzers.</param>
/// <param name="analyzerManager">AnalyzerManager to manage analyzers for the lifetime of analyzer host.</param>
/// <param name="addExceptionDiagnostic">Delegate to add diagnostics generated for exceptions from third party analyzers.</param>
/// <param name="reportAnalyzer">Report additional information related to analyzers, such as analyzer execution time.</param>
/// <param name="severityFilter">Filtered diagnostic severities in the compilation, i.e. diagnostics with effective severity from this set should not be reported.</param>
/// <param name="newCompilation">The new compilation with the analyzer driver attached.</param>
/// <param name="cancellationToken">A cancellation token that can be used to abort analysis.</param>
/// <returns>A newly created analyzer driver</returns>
/// <remarks>
/// Note that since a compilation is immutable, the act of creating a driver and attaching it produces
/// a new compilation. Any further actions on the compilation should use the new compilation.
/// </remarks>
public static AnalyzerDriver CreateAndAttachToCompilation(
Compilation compilation,
ImmutableArray<DiagnosticAnalyzer> analyzers,
AnalyzerOptions options,
AnalyzerManager analyzerManager,
Action<Diagnostic> addExceptionDiagnostic,
bool reportAnalyzer,
SeverityFilter severityFilter,
out Compilation newCompilation,
CancellationToken cancellationToken)
{
Action<Exception, DiagnosticAnalyzer, Diagnostic> onAnalyzerException =
(ex, analyzer, diagnostic) => addExceptionDiagnostic?.Invoke(diagnostic);
Func<Exception, bool>? nullFilter = null;
return CreateAndAttachToCompilation(compilation, analyzers, options, analyzerManager, onAnalyzerException, nullFilter, reportAnalyzer, severityFilter, out newCompilation, cancellationToken: cancellationToken);
}
// internal for testing purposes
internal static AnalyzerDriver CreateAndAttachToCompilation(
Compilation compilation,
ImmutableArray<DiagnosticAnalyzer> analyzers,
AnalyzerOptions options,
AnalyzerManager analyzerManager,
Action<Exception, DiagnosticAnalyzer, Diagnostic> onAnalyzerException,
Func<Exception, bool>? analyzerExceptionFilter,
bool reportAnalyzer,
SeverityFilter severityFilter,
out Compilation newCompilation,
CancellationToken cancellationToken)
{
AnalyzerDriver analyzerDriver = compilation.CreateAnalyzerDriver(analyzers, analyzerManager, severityFilter);
newCompilation = compilation
.WithSemanticModelProvider(new CachingSemanticModelProvider())
.WithEventQueue(new AsyncQueue<CompilationEvent>());
var categorizeDiagnostics = false;
var analysisOptions = new CompilationWithAnalyzersOptions(options, onAnalyzerException, analyzerExceptionFilter: analyzerExceptionFilter, concurrentAnalysis: true, logAnalyzerExecutionTime: reportAnalyzer, reportSuppressedDiagnostics: false);
analyzerDriver.Initialize(newCompilation, analysisOptions, new CompilationData(newCompilation), categorizeDiagnostics, cancellationToken);
var analysisScope = new AnalysisScope(newCompilation, options, analyzers, hasAllAnalyzers: true, concurrentAnalysis: newCompilation.Options.ConcurrentBuild, categorizeDiagnostics: categorizeDiagnostics);
analyzerDriver.AttachQueueAndStartProcessingEvents(newCompilation.EventQueue!, analysisScope, cancellationToken: cancellationToken);
return analyzerDriver;
}
/// <summary>
/// Returns all diagnostics computed by the analyzers since the last time this was invoked.
/// If <see cref="CompilationEventQueue"/> has been completed with all compilation events, then it waits for
/// <see cref="WhenCompletedTask"/> task for the driver to finish processing all events and generate remaining analyzer diagnostics.
/// </summary>
public async Task<ImmutableArray<Diagnostic>> GetDiagnosticsAsync(Compilation compilation)
{
var allDiagnostics = DiagnosticBag.GetInstance();
if (CompilationEventQueue.IsCompleted)
{
await this.WhenCompletedTask.ConfigureAwait(false);
if (this.WhenCompletedTask.IsFaulted)
{
OnDriverException(this.WhenCompletedTask, this.AnalyzerExecutor, this.Analyzers);
}
}
var suppressMessageState = CurrentCompilationData.SuppressMessageAttributeState;
var reportSuppressedDiagnostics = compilation.Options.ReportSuppressedDiagnostics;
while (DiagnosticQueue.TryDequeue(out var diagnostic))
{
diagnostic = suppressMessageState.ApplySourceSuppressions(diagnostic);
if (reportSuppressedDiagnostics || !diagnostic.IsSuppressed)
{
allDiagnostics.Add(diagnostic);
}
}
return allDiagnostics.ToReadOnlyAndFree();
}
private SemanticModel GetOrCreateSemanticModel(SyntaxTree tree)
=> GetOrCreateSemanticModel(tree, AnalyzerExecutor.Compilation);
private SemanticModel GetOrCreateSemanticModel(SyntaxTree tree, Compilation compilation)
=> SemanticModelProvider.GetSemanticModel(tree, compilation);
public void ApplyProgrammaticSuppressions(DiagnosticBag reportedDiagnostics, Compilation compilation)
{
Debug.Assert(!reportedDiagnostics.IsEmptyWithoutResolution);
if (!_hasDiagnosticSuppressors)
{
return;
}
var newDiagnostics = ApplyProgrammaticSuppressionsCore(reportedDiagnostics.ToReadOnly(), compilation);
reportedDiagnostics.Clear();
reportedDiagnostics.AddRange(newDiagnostics);
}
public ImmutableArray<Diagnostic> ApplyProgrammaticSuppressions(ImmutableArray<Diagnostic> reportedDiagnostics, Compilation compilation)
{
if (reportedDiagnostics.IsEmpty ||
!_hasDiagnosticSuppressors)
{
return reportedDiagnostics;
}
return ApplyProgrammaticSuppressionsCore(reportedDiagnostics, compilation);
}
private ImmutableArray<Diagnostic> ApplyProgrammaticSuppressionsCore(ImmutableArray<Diagnostic> reportedDiagnostics, Compilation compilation)
{
Debug.Assert(_hasDiagnosticSuppressors);
Debug.Assert(!reportedDiagnostics.IsEmpty);
Debug.Assert(_programmaticSuppressions != null);
Debug.Assert(_diagnosticsProcessedForProgrammaticSuppressions != null);
try
{
// We do not allow analyzer based suppressions for following category of diagnostics:
// 1. Diagnostics which are already suppressed in source via pragma/suppress message attribute.
// 2. Diagnostics explicitly tagged as not configurable by analyzer authors - this includes compiler error diagnostics.
// 3. Diagnostics which are marked as error by default by diagnostic authors.
var suppressableDiagnostics = reportedDiagnostics.Where(d => !d.IsSuppressed &&
!d.IsNotConfigurable() &&
d.DefaultSeverity != DiagnosticSeverity.Error &&
!_diagnosticsProcessedForProgrammaticSuppressions.Contains(d));
if (suppressableDiagnostics.IsEmpty())
{
return reportedDiagnostics;
}
executeSuppressionActions(suppressableDiagnostics, concurrent: compilation.Options.ConcurrentBuild);
if (_programmaticSuppressions.IsEmpty)
{
return reportedDiagnostics;
}
var builder = ArrayBuilder<Diagnostic>.GetInstance(reportedDiagnostics.Length);
ImmutableDictionary<Diagnostic, ProgrammaticSuppressionInfo> programmaticSuppressionsByDiagnostic = createProgrammaticSuppressionsByDiagnosticMap(_programmaticSuppressions);
foreach (var diagnostic in reportedDiagnostics)
{
if (programmaticSuppressionsByDiagnostic.TryGetValue(diagnostic, out var programmaticSuppressionInfo))
{
Debug.Assert(suppressableDiagnostics.Contains(diagnostic));
Debug.Assert(!diagnostic.IsSuppressed);
var suppressedDiagnostic = diagnostic.WithProgrammaticSuppression(programmaticSuppressionInfo);
Debug.Assert(suppressedDiagnostic.IsSuppressed);
builder.Add(suppressedDiagnostic);
}
else
{
builder.Add(diagnostic);
}
}
return builder.ToImmutableAndFree();
}
finally
{
// Mark the reported diagnostics as processed for programmatic suppressions to avoid duplicate callbacks to suppressors for same diagnostics.
_diagnosticsProcessedForProgrammaticSuppressions.AddRange(reportedDiagnostics);
}
void executeSuppressionActions(IEnumerable<Diagnostic> reportedDiagnostics, bool concurrent)
{
var suppressors = this.Analyzers.OfType<DiagnosticSuppressor>();
if (concurrent)
{
// Kick off tasks to concurrently execute suppressors.
// Note that we avoid using Parallel.ForEach here to avoid wrapped exceptions.
// See https://github.com/dotnet/roslyn/issues/41713 for details.
var tasks = ArrayBuilder<Task>.GetInstance();
try
{
foreach (var suppressor in suppressors)
{
var task = Task.Run(
() => AnalyzerExecutor.ExecuteSuppressionAction(suppressor, getSuppressableDiagnostics(suppressor)),
AnalyzerExecutor.CancellationToken);
tasks.Add(task);
}
Task.WaitAll(tasks.ToArray(), AnalyzerExecutor.CancellationToken);
}
finally
{
tasks.Free();
}
}
else
{