From aa04924cad70737cc74fd1950aa20d1246443421 Mon Sep 17 00:00:00 2001 From: Jeff Kluge Date: Mon, 28 Mar 2022 10:39:13 -0500 Subject: [PATCH] Set EventSource version for all events --- src/Framework/MSBuildEventSource.cs | 167 ++++++++++++++-------------- 1 file changed, 86 insertions(+), 81 deletions(-) diff --git a/src/Framework/MSBuildEventSource.cs b/src/Framework/MSBuildEventSource.cs index b4e335f7849..a585c8626da 100644 --- a/src/Framework/MSBuildEventSource.cs +++ b/src/Framework/MSBuildEventSource.cs @@ -8,11 +8,16 @@ namespace Microsoft.Build.Eventing /// This captures information of how various key methods of building with MSBuild ran. /// /// - /// Changes to existing event method signatures will not be reflected unless you update the property or assign a new event ID. + /// Changes to existing event method signatures will not be reflected unless you update the constant or assign a new event ID. /// [EventSource(Name = "Microsoft-Build")] internal sealed class MSBuildEventSource : EventSource { + /// + /// Represents the version of the events. Be sure to increment this any time you modify an existing event method. + /// + public const int EventVersion = 100; + public static class Keywords { /// @@ -47,14 +52,14 @@ private MSBuildEventSource() { } /// Call this method to notify listeners of information relevant to collecting a set of items, mutating them in a specified way, and saving the results. /// /// The type of the item being mutated. - [Event(1, Keywords = Keywords.All)] + [Event(1, Keywords = Keywords.All, Version = EventVersion)] public void ApplyLazyItemOperationsStart(string itemType) { WriteEvent(1, itemType); } /// The type of the item being mutated. - [Event(2, Keywords = Keywords.All)] + [Event(2, Keywords = Keywords.All, Version = EventVersion)] public void ApplyLazyItemOperationsStop(string itemType) { WriteEvent(2, itemType); @@ -63,13 +68,13 @@ public void ApplyLazyItemOperationsStop(string itemType) /// /// Call this method to notify listeners of information relevant to the setup for a BuildManager to receive build requests. /// - [Event(3, Keywords = Keywords.All | Keywords.PerformanceLog)] + [Event(3, Keywords = Keywords.All | Keywords.PerformanceLog, Version = EventVersion)] public void BuildStart() { WriteEvent(3); } - [Event(4, Keywords = Keywords.All | Keywords.PerformanceLog)] + [Event(4, Keywords = Keywords.All | Keywords.PerformanceLog, Version = EventVersion)] public void BuildStop() { WriteEvent(4); @@ -79,7 +84,7 @@ public void BuildStop() /// Call this method to notify listeners of information of how a project file built. /// Filename of the project being built. /// - [Event(5, Keywords = Keywords.All | Keywords.PerformanceLog)] + [Event(5, Keywords = Keywords.All | Keywords.PerformanceLog, Version = EventVersion)] public void BuildProjectStart(string projectPath) { WriteEvent(5, projectPath); @@ -87,26 +92,26 @@ public void BuildProjectStart(string projectPath) /// Filename of the project being built. /// Names of the targets that built. - [Event(6, Keywords = Keywords.All | Keywords.PerformanceLog)] + [Event(6, Keywords = Keywords.All | Keywords.PerformanceLog, Version = EventVersion)] public void BuildProjectStop(string projectPath, string targets) { WriteEvent(6, projectPath, targets); } - [Event(7, Keywords = Keywords.All)] + [Event(7, Keywords = Keywords.All, Version = EventVersion)] public void RarComputeClosureStart() { WriteEvent(7); } - [Event(8, Keywords = Keywords.All)] + [Event(8, Keywords = Keywords.All, Version = EventVersion)] public void RarComputeClosureStop() { WriteEvent(8); } /// The condition being evaluated. - [Event(9, Keywords = Keywords.All)] + [Event(9, Keywords = Keywords.All, Version = EventVersion)] public void EvaluateConditionStart(string condition) { WriteEvent(9, condition); @@ -114,7 +119,7 @@ public void EvaluateConditionStart(string condition) /// The condition being evaluated. /// The result of evaluating the condition. - [Event(10, Keywords = Keywords.All)] + [Event(10, Keywords = Keywords.All, Version = EventVersion)] public void EvaluateConditionStop(string condition, bool result) { WriteEvent(10, condition, result); @@ -124,122 +129,122 @@ public void EvaluateConditionStop(string condition, bool result) /// Call this method to notify listeners of how the project data was evaluated. /// /// Filename of the project being evaluated. - [Event(11, Keywords = Keywords.All | Keywords.PerformanceLog)] + [Event(11, Keywords = Keywords.All | Keywords.PerformanceLog, Version = EventVersion)] public void EvaluateStart(string projectFile) { WriteEvent(11, projectFile); } /// Filename of the project being evaluated. - [Event(12, Keywords = Keywords.All | Keywords.PerformanceLog)] + [Event(12, Keywords = Keywords.All | Keywords.PerformanceLog, Version = EventVersion)] public void EvaluateStop(string projectFile) { WriteEvent(12, projectFile); } /// Filename of the project being evaluated. - [Event(13, Keywords = Keywords.All)] + [Event(13, Keywords = Keywords.All, Version = EventVersion)] public void EvaluatePass0Start(string projectFile) { WriteEvent(13, projectFile); } /// Filename of the project being evaluated. - [Event(14, Keywords = Keywords.All)] + [Event(14, Keywords = Keywords.All, Version = EventVersion)] public void EvaluatePass0Stop(string projectFile) { WriteEvent(14, projectFile); } /// Filename of the project being evaluated. - [Event(15, Keywords = Keywords.All)] + [Event(15, Keywords = Keywords.All, Version = EventVersion)] public void EvaluatePass1Start(string projectFile) { WriteEvent(15, projectFile); } /// Filename of the project being evaluated. - [Event(16, Keywords = Keywords.All)] + [Event(16, Keywords = Keywords.All, Version = EventVersion)] public void EvaluatePass1Stop(string projectFile) { WriteEvent(16, projectFile); } /// Filename of the project being evaluated. - [Event(17, Keywords = Keywords.All)] + [Event(17, Keywords = Keywords.All, Version = EventVersion)] public void EvaluatePass2Start(string projectFile) { WriteEvent(17, projectFile); } /// Filename of the project being evaluated. - [Event(18, Keywords = Keywords.All)] + [Event(18, Keywords = Keywords.All, Version = EventVersion)] public void EvaluatePass2Stop(string projectFile) { WriteEvent(18, projectFile); } /// Filename of the project being evaluated. - [Event(19, Keywords = Keywords.All)] + [Event(19, Keywords = Keywords.All, Version = EventVersion)] public void EvaluatePass3Start(string projectFile) { WriteEvent(19, projectFile); } /// Filename of the project being evaluated. - [Event(20, Keywords = Keywords.All)] + [Event(20, Keywords = Keywords.All, Version = EventVersion)] public void EvaluatePass3Stop(string projectFile) { WriteEvent(20, projectFile); } /// Filename of the project being evaluated. - [Event(21, Keywords = Keywords.All)] + [Event(21, Keywords = Keywords.All, Version = EventVersion)] public void EvaluatePass4Start(string projectFile) { WriteEvent(21, projectFile); } /// Filename of the project being evaluated. - [Event(22, Keywords = Keywords.All)] + [Event(22, Keywords = Keywords.All, Version = EventVersion)] public void EvaluatePass4Stop(string projectFile) { WriteEvent(22, projectFile); } /// Filename of the project being evaluated. - [Event(23, Keywords = Keywords.All)] + [Event(23, Keywords = Keywords.All, Version = EventVersion)] public void EvaluatePass5Start(string projectFile) { WriteEvent(23, projectFile); } /// Filename of the project being evaluated. - [Event(24, Keywords = Keywords.All)] + [Event(24, Keywords = Keywords.All, Version = EventVersion)] public void EvaluatePass5Stop(string projectFile) { WriteEvent(24, projectFile); } - [Event(25, Keywords = Keywords.All)] + [Event(25, Keywords = Keywords.All, Version = EventVersion)] public void GenerateResourceOverallStart() { WriteEvent(25); } - [Event(26, Keywords = Keywords.All)] + [Event(26, Keywords = Keywords.All, Version = EventVersion)] public void GenerateResourceOverallStop() { WriteEvent(26); } - [Event(27, Keywords = Keywords.All | Keywords.PerformanceLog)] + [Event(27, Keywords = Keywords.All | Keywords.PerformanceLog, Version = EventVersion)] public void RarOverallStart() { WriteEvent(27); } - [Event(28, Keywords = Keywords.All | Keywords.PerformanceLog)] + [Event(28, Keywords = Keywords.All | Keywords.PerformanceLog, Version = EventVersion)] public void RarOverallStop(int assembliesCount, int assemblyFilesCount, int resolvedFilesCount, int resolvedDependencyFilesCount, int copyLocalFilesCount, bool findDependencies) { WriteEvent(28, assembliesCount, assemblyFilesCount, resolvedFilesCount, resolvedDependencyFilesCount, copyLocalFilesCount, findDependencies); @@ -251,7 +256,7 @@ public void RarOverallStop(int assembliesCount, int assemblyFilesCount, int reso /// Source of files to glob. /// Pattern, possibly with wildcard(s) to be expanded. /// Patterns not to expand. - [Event(41, Keywords = Keywords.All)] + [Event(41, Keywords = Keywords.All, Version = EventVersion)] public void ExpandGlobStart(string rootDirectory, string glob, string excludedPatterns) { WriteEvent(41, rootDirectory, glob, excludedPatterns); @@ -260,7 +265,7 @@ public void ExpandGlobStart(string rootDirectory, string glob, string excludedPa /// Source of files to glob. /// Pattern, possibly with wildcard(s) to be expanded. /// Patterns not to expand. - [Event(42, Keywords = Keywords.All)] + [Event(42, Keywords = Keywords.All, Version = EventVersion)] public void ExpandGlobStop(string rootDirectory, string glob, string excludedPatterns) { WriteEvent(42, rootDirectory, glob, excludedPatterns); @@ -270,26 +275,26 @@ public void ExpandGlobStop(string rootDirectory, string glob, string excludedPat /// Call this method to notify listeners of timing related to loading an XmlDocumentWithLocation from a path. /// Path to the document to load. /// - [Event(29, Keywords = Keywords.All | Keywords.PerformanceLog)] + [Event(29, Keywords = Keywords.All | Keywords.PerformanceLog, Version = EventVersion)] public void LoadDocumentStart(string fullPath) { WriteEvent(29, fullPath); } /// Path to the document to load. - [Event(30, Keywords = Keywords.All | Keywords.PerformanceLog)] + [Event(30, Keywords = Keywords.All | Keywords.PerformanceLog, Version = EventVersion)] public void LoadDocumentStop(string fullPath) { WriteEvent(30, fullPath); } - [Event(31, Keywords = Keywords.All)] + [Event(31, Keywords = Keywords.All, Version = EventVersion)] public void RarLogResultsStart() { WriteEvent(31); } - [Event(32, Keywords = Keywords.All)] + [Event(32, Keywords = Keywords.All, Version = EventVersion)] public void RarLogResultsStop() { WriteEvent(32); @@ -299,14 +304,14 @@ public void RarLogResultsStop() /// Call this method to notify listeners of profiling for the function that parses an XML document into a ProjectRootElement. /// /// Filename of the project being evaluated. - [Event(33, Keywords = Keywords.All)] + [Event(33, Keywords = Keywords.All, Version = EventVersion)] public void ParseStart(string projectFileName) { WriteEvent(33, projectFileName); } /// Filename of the project being evaluated. - [Event(34, Keywords = Keywords.All)] + [Event(34, Keywords = Keywords.All, Version = EventVersion)] public void ParseStop(string projectFileName) { WriteEvent(34, projectFileName); @@ -315,53 +320,53 @@ public void ParseStop(string projectFileName) /// /// Call this method to notify listeners of profiling for the method that removes blacklisted references from the reference table. It puts primary and dependency references in invalid file lists. /// - [Event(35, Keywords = Keywords.All)] + [Event(35, Keywords = Keywords.All, Version = EventVersion)] public void RarRemoveReferencesMarkedForExclusionStart() { WriteEvent(35); } - [Event(36, Keywords = Keywords.All)] + [Event(36, Keywords = Keywords.All, Version = EventVersion)] public void RarRemoveReferencesMarkedForExclusionStop() { WriteEvent(36); } - [Event(37, Keywords = Keywords.All | Keywords.PerformanceLog)] + [Event(37, Keywords = Keywords.All | Keywords.PerformanceLog, Version = EventVersion)] public void RequestThreadProcStart() { WriteEvent(37); } - [Event(38, Keywords = Keywords.All | Keywords.PerformanceLog)] + [Event(38, Keywords = Keywords.All | Keywords.PerformanceLog, Version = EventVersion)] public void RequestThreadProcStop() { WriteEvent(38); } /// Project file's location. - [Event(39, Keywords = Keywords.All)] + [Event(39, Keywords = Keywords.All, Version = EventVersion)] public void SaveStart(string fileLocation) { WriteEvent(39, fileLocation); } /// Project file's location. - [Event(40, Keywords = Keywords.All)] + [Event(40, Keywords = Keywords.All, Version = EventVersion)] public void SaveStop(string fileLocation) { WriteEvent(40, fileLocation); } /// The name of the target being executed. - [Event(43, Keywords = Keywords.All | Keywords.PerformanceLog)] + [Event(43, Keywords = Keywords.All | Keywords.PerformanceLog, Version = EventVersion)] public void TargetStart(string targetName) { WriteEvent(43, targetName); } /// The name of the target being executed. - [Event(44, Keywords = Keywords.All | Keywords.PerformanceLog)] + [Event(44, Keywords = Keywords.All | Keywords.PerformanceLog, Version = EventVersion)] public void TargetStop(string targetName) { WriteEvent(44, targetName); @@ -371,140 +376,140 @@ public void TargetStop(string targetName) /// Call this method to notify listeners of the start of a build as called from the command line. /// /// The command line used to run MSBuild. - [Event(45, Keywords = Keywords.All | Keywords.PerformanceLog)] + [Event(45, Keywords = Keywords.All | Keywords.PerformanceLog, Version = EventVersion)] public void MSBuildExeStart(string commandLine) { WriteEvent(45, commandLine); } /// The command line used to run MSBuild. - [Event(46, Keywords = Keywords.All | Keywords.PerformanceLog)] + [Event(46, Keywords = Keywords.All | Keywords.PerformanceLog, Version = EventVersion)] public void MSBuildExeStop(string commandLine) { WriteEvent(46, commandLine); } - [Event(47, Keywords = Keywords.All)] + [Event(47, Keywords = Keywords.All, Version = EventVersion)] public void ExecuteTaskStart(string taskName, int taskID) { WriteEvent(47, taskName, taskID); } - [Event(48, Keywords = Keywords.All)] + [Event(48, Keywords = Keywords.All, Version = EventVersion)] public void ExecuteTaskStop(string taskName, int taskID) { WriteEvent(48, taskName, taskID); } - [Event(49, Keywords = Keywords.All)] + [Event(49, Keywords = Keywords.All, Version = EventVersion)] public void ExecuteTaskYieldStart(string taskName, int taskID) { WriteEvent(49, taskName, taskID); } - [Event(50, Keywords = Keywords.All)] + [Event(50, Keywords = Keywords.All, Version = EventVersion)] public void ExecuteTaskYieldStop(string taskName, int taskID) { WriteEvent(50, taskName, taskID); } - [Event(51, Keywords = Keywords.All)] + [Event(51, Keywords = Keywords.All, Version = EventVersion)] public void ExecuteTaskReacquireStart(string taskName, int taskID) { WriteEvent(51, taskName, taskID); } - [Event(52, Keywords = Keywords.All)] + [Event(52, Keywords = Keywords.All, Version = EventVersion)] public void ExecuteTaskReacquireStop(string taskName, int taskID) { WriteEvent(52, taskName, taskID); } - [Event(53, Keywords = Keywords.All)] + [Event(53, Keywords = Keywords.All, Version = EventVersion)] public void ProjectGraphConstructionStart(string graphEntryPoints) { WriteEvent(53, graphEntryPoints); } - [Event(54, Keywords = Keywords.All)] + [Event(54, Keywords = Keywords.All, Version = EventVersion)] public void ProjectGraphConstructionStop(string graphEntryPoints) { WriteEvent(54, graphEntryPoints); } - [Event(55, Keywords = Keywords.All)] + [Event(55, Keywords = Keywords.All, Version = EventVersion)] public void PacketReadSize(int size) { WriteEvent(55, size); } - [Event(56, Keywords = Keywords.All)] + [Event(56, Keywords = Keywords.All, Version = EventVersion)] public void TargetUpToDateStart() { WriteEvent(56); } - [Event(57, Keywords = Keywords.All)] + [Event(57, Keywords = Keywords.All, Version = EventVersion)] public void TargetUpToDateStop(int result) { WriteEvent(57, result); } - [Event(58, Keywords = Keywords.All)] + [Event(58, Keywords = Keywords.All, Version = EventVersion)] public void CopyUpToDateStart(string path) { WriteEvent(58, path); } - [Event(59, Keywords = Keywords.All)] + [Event(59, Keywords = Keywords.All, Version = EventVersion)] public void CopyUpToDateStop(string path, bool wasUpToDate) { WriteEvent(59, path, wasUpToDate); } - [Event(60, Keywords = Keywords.All)] + [Event(60, Keywords = Keywords.All, Version = EventVersion)] public void WriteLinesToFileUpToDateStart() { WriteEvent(60); } - [Event(61, Keywords = Keywords.All)] + [Event(61, Keywords = Keywords.All, Version = EventVersion)] public void WriteLinesToFileUpToDateStop(string fileItemSpec, bool wasUpToDate) { WriteEvent(61, fileItemSpec, wasUpToDate); } - [Event(62, Keywords = Keywords.All)] + [Event(62, Keywords = Keywords.All, Version = EventVersion)] public void SdkResolverServiceInitializeStart() { WriteEvent(62); } - [Event(63, Keywords = Keywords.All)] + [Event(63, Keywords = Keywords.All, Version = EventVersion)] public void SdkResolverServiceInitializeStop(int resolverCount) { WriteEvent(63, resolverCount); } - [Event(64, Keywords = Keywords.All)] + [Event(64, Keywords = Keywords.All, Version = EventVersion)] public void SdkResolverResolveSdkStart() { WriteEvent(64); } - [Event(65, Keywords = Keywords.All)] + [Event(65, Keywords = Keywords.All, Version = EventVersion)] public void SdkResolverResolveSdkStop(string resolverName, string sdkName, string solutionPath, string projectPath, string sdkPath, bool success) { WriteEvent(65, resolverName, sdkName, solutionPath, projectPath, sdkPath, success); } - [Event(66, Keywords = Keywords.All)] + [Event(66, Keywords = Keywords.All, Version = EventVersion)] public void CachedSdkResolverServiceResolveSdkStart(string sdkName, string solutionPath, string projectPath) { WriteEvent(66, sdkName, solutionPath, projectPath); } - [Event(67, Keywords = Keywords.All, Version = 2)] + [Event(67, Keywords = Keywords.All, Version = EventVersion)] public void CachedSdkResolverServiceResolveSdkStop(string sdkName, string solutionPath, string projectPath, bool success, bool wasResultCached) { WriteEvent(67, sdkName, solutionPath, projectPath, success, wasResultCached); @@ -513,7 +518,7 @@ public void CachedSdkResolverServiceResolveSdkStop(string sdkName, string soluti /// /// This events are quite frequent so they are collected by Debug binaries only. /// - [Event(68, Keywords = Keywords.All)] + [Event(68, Keywords = Keywords.All, Version = EventVersion)] public void ReusableStringBuilderFactoryStart(int hash, int newCapacity, int oldCapacity, string type) { WriteEvent(68, hash, newCapacity, oldCapacity, type); @@ -522,7 +527,7 @@ public void ReusableStringBuilderFactoryStart(int hash, int newCapacity, int old /// /// This events are quite frequent so they are collected by Debug binaries only. /// - [Event(69, Keywords = Keywords.All)] + [Event(69, Keywords = Keywords.All, Version = EventVersion)] public void ReusableStringBuilderFactoryStop(int hash, int returningCapacity, int returningLength, string type) { WriteEvent(69, hash, returningCapacity, returningLength, type); @@ -533,67 +538,67 @@ public void ReusableStringBuilderFactoryStop(int hash, int returningCapacity, in /// and if it is seen more than 100x per build it might indicates wrong usage patterns resulting into degrading /// efficiency of ReusableStringBuilderFactory. Hence it is collected in release build as well. /// - [Event(70, Keywords = Keywords.All)] + [Event(70, Keywords = Keywords.All, Version = EventVersion)] public void ReusableStringBuilderFactoryUnbalanced(int oldHash, int newHash) { WriteEvent(70, oldHash, newHash); } - [Event(71, Keywords = Keywords.All)] + [Event(71, Keywords = Keywords.All, Version = EventVersion)] public void ProjectCacheCreatePluginInstanceStart(string pluginAssemblyPath) { WriteEvent(71, pluginAssemblyPath); } - [Event(72, Keywords = Keywords.All)] + [Event(72, Keywords = Keywords.All, Version = EventVersion)] public void ProjectCacheCreatePluginInstanceStop(string pluginAssemblyPath, string pluginTypeName) { WriteEvent(72, pluginAssemblyPath, pluginTypeName); } - [Event(73, Keywords = Keywords.All)] + [Event(73, Keywords = Keywords.All, Version = EventVersion)] public void ProjectCacheBeginBuildStart(string pluginTypeName) { WriteEvent(73, pluginTypeName); } - [Event(74, Keywords = Keywords.All)] + [Event(74, Keywords = Keywords.All, Version = EventVersion)] public void ProjectCacheBeginBuildStop(string pluginTypeName) { WriteEvent(74, pluginTypeName); } - [Event(75, Keywords = Keywords.All)] + [Event(75, Keywords = Keywords.All, Version = EventVersion)] public void ProjectCacheGetCacheResultStart(string pluginTypeName, string projectPath, string targets) { WriteEvent(75, pluginTypeName, projectPath, targets); } - [Event(76, Keywords = Keywords.All)] + [Event(76, Keywords = Keywords.All, Version = EventVersion)] public void ProjectCacheGetCacheResultStop(string pluginTypeName, string projectPath, string targets, string cacheResultType) { WriteEvent(76, pluginTypeName, projectPath, targets, cacheResultType); } - [Event(77, Keywords = Keywords.All)] + [Event(77, Keywords = Keywords.All, Version = EventVersion)] public void ProjectCacheEndBuildStart(string pluginTypeName) { WriteEvent(77, pluginTypeName); } - [Event(78, Keywords = Keywords.All)] + [Event(78, Keywords = Keywords.All, Version = EventVersion)] public void ProjectCacheEndBuildStop(string pluginTypeName) { WriteEvent(78, pluginTypeName); } - [Event(79, Keywords = Keywords.All)] + [Event(79, Keywords = Keywords.All, Version = EventVersion)] public void OutOfProcSdkResolverServiceRequestSdkPathFromMainNodeStart(int submissionId, string sdkName, string solutionPath, string projectPath) { WriteEvent(79, submissionId, sdkName, solutionPath, projectPath); } - [Event(80, Keywords = Keywords.All)] + [Event(80, Keywords = Keywords.All, Version = EventVersion)] public void OutOfProcSdkResolverServiceRequestSdkPathFromMainNodeStop(int submissionId, string sdkName, string solutionPath, string projectPath, bool success, bool wasResultCached) { WriteEvent(80, submissionId, sdkName, solutionPath, projectPath, success, wasResultCached);