Introduce a new internal EventSourceGenerator and use it for all ES implementations

Directory.Build.props

@@ -319,6 +319,8 @@
     <NoWarn>$(NoWarn);CS8625</NoWarn>
     <!-- We dont need to add null annotation within the ref for explicit interface methods. -->
     <NoWarn>$(NoWarn);CS8617</NoWarn>
+    <!-- don't warn about explicit ctors in classes with [EventSource] -->
+    <NoWarn>$(NoWarn);ESGEN001;ESGEN002</NoWarn>
     <!-- No symbols are produced for ref assemblies, but some parts of the SDK still expect pdbs, so we explicitly tell it there are none. -->
     <!-- Must be set after importing Arcade to override its defaults. -->
     <DebugType>none</DebugType>
@@ -360,6 +362,8 @@
     <NoWarn>$(NoWarn);SYSLIB0011;SYSLIB0050;SYSLIB0051</NoWarn>
     <!-- don't warn about unnecessary trim warning suppressions. can be removed with preview 6. -->
     <NoWarn>$(NoWarn);IL2121</NoWarn>
+    <!-- don't warn about explicit ctors in classes with [EventSource] -->
+    <NoWarn>$(NoWarn);ESGEN001;ESGEN002</NoWarn>
     <!-- allow nullable annotated files to be incorporated into tests without warning -->
     <Nullable Condition="'$(Nullable)' == '' and '$(Language)' == 'C#'">annotations</Nullable>
   </PropertyGroup>

eng/generators.targets

@@ -40,6 +40,12 @@
                                      '$(DisableImplicitFrameworkReferences)' == 'true' and
                                      '@(ProjectReference->AnyHaveMetadataValue('Filename', 'System.Runtime.InteropServices'))' == 'true'
                                  )" />
+
+    <EnabledGenerators Include="EventSourceGenerator"
+                       Condition="'$(IsSourceProject)' == 'true' and
+                                 '$(MSBuildProjectExtension)' == '.csproj' and
+                                 '$(DisableImplicitFrameworkReferences)' == 'true'
+                                 " />
   </ItemGroup>
 
   <ItemGroup Condition="'@(EnabledGenerators)' != '' and
@@ -70,6 +76,11 @@
                       OutputItemType="Analyzer"
                       SetConfiguration="Configuration=$(LibrariesConfiguration)"
                       Condition="@(EnabledGenerators->AnyHaveMetadataValue('Identity', 'ComInterfaceGenerator'))" />
+    <ProjectReference Include="$(LibrariesProjectRoot)System.Private.CoreLib\gen\EventSourceGenerator.csproj"
+                      ReferenceOutputAssembly="false"
+                      OutputItemType="Analyzer"
+                      SetConfiguration="Configuration=$(LibrariesConfiguration)"
+                      Condition="@(EnabledGenerators->AnyHaveMetadataValue('Identity', 'EventSourceGenerator'))" />
   </ItemGroup>
 
   <Target Name="ConfigureGenerators"

src/coreclr/tools/aot/ILCompiler.DependencyAnalysisFramework/PerfEventSource.cs

@@ -10,10 +10,8 @@
 namespace ILCompiler.DependencyAnalysisFramework
 {
     [EventSource(Name = "Microsoft-ILCompiler-Graph-Perf")]
-    public class PerfEventSource : EventSource
+    public partial class PerfEventSource : EventSource
     {
-        private PerfEventSource() { }
-
         public static PerfEventSource Log = new PerfEventSource();
 
         public struct StartStopEvents : IDisposable

src/coreclr/tools/aot/ILCompiler.ReadyToRun/Compiler/PerfEventSource.cs

@@ -10,10 +10,8 @@
 namespace ILCompiler
 {
     [EventSource(Name = "Microsoft-ILCompiler-Perf")]
-    public class PerfEventSource : EventSource
+    public partial class PerfEventSource : EventSource
     {
-        private PerfEventSource() { }
-
         public static PerfEventSource Log = new PerfEventSource();
 
         public struct StartStopEvents : IDisposable

src/libraries/Microsoft.Extensions.DependencyInjection/src/DependencyInjectionEventSource.cs

@@ -12,8 +12,10 @@
 
 namespace Microsoft.Extensions.DependencyInjection
 {
+#pragma warning disable ESGEN001 // EventSource class is not partial. It's blocked by https://github.com/dotnet/runtime/issues/121205
     [EventSource(Name = "Microsoft-Extensions-DependencyInjection")]
     internal sealed class DependencyInjectionEventSource : EventSource
+#pragma warning restore ESGEN001
     {
         public static readonly DependencyInjectionEventSource Log = new DependencyInjectionEventSource();
 
@@ -27,6 +29,7 @@ public static class Keywords
 
         private readonly List<WeakReference<ServiceProvider>> _providers = new();
 
+        // This event source uses EtwSelfDescribingEventFormat for backward compatibility.
         private DependencyInjectionEventSource() : base(EventSourceSettings.EtwSelfDescribingEventFormat)
         {
         }

src/libraries/Microsoft.Extensions.Logging.EventSource/src/LoggingEventSource.cs

@@ -82,8 +82,10 @@ namespace Microsoft.Extensions.Logging.EventSource
     /// }
     /// </code>
     /// </example>
+#pragma warning disable ESGEN001 // EventSource class is not partial. It's blocked by https://github.com/dotnet/runtime/issues/121205
     [EventSource(Name = "Microsoft-Extensions-Logging")]
     public sealed class LoggingEventSource : System.Diagnostics.Tracing.EventSource
+#pragma warning restore ESGEN001
     {
         /// <summary>
         /// Defines the different ways data can be formatted in an event.
@@ -126,6 +128,7 @@ public static class Keywords
         private static readonly char[] s_semicolon = new[] { ';' };
         private static readonly char[] s_colon = new[] { ':' };
 
+        // This event source uses IEnumerable<T> as an event parameter type which is only supported by EtwSelfDescribingEventFormat.
         private LoggingEventSource() : base(EventSourceSettings.EtwSelfDescribingEventFormat)
         {
         }

src/libraries/NetCoreAppLibrary.props

@@ -181,6 +181,7 @@
     <!-- List .NETCoreApp shared framework generator project names below. -->
     <NetCoreAppLibraryGenerator>
       ComInterfaceGenerator;
+      EventSourceGenerator;
       LibraryImportGenerator;
       JSImportGenerator;
       Microsoft.Interop.SourceGeneration;

src/libraries/System.Collections.Concurrent/src/System/Collections/Concurrent/CDSCollectionETWBCLProvider.cs

@@ -19,15 +19,12 @@ namespace System.Collections.Concurrent
         Name = "System.Collections.Concurrent.ConcurrentCollectionsEventSource",
         Guid = "35167F8E-49B2-4b96-AB86-435B59336B5E"
         )]
-    internal sealed class CDSCollectionETWBCLProvider : EventSource
+    internal sealed partial class CDSCollectionETWBCLProvider : EventSource
     {
         /// <summary>
         /// Defines the singleton instance for the collection ETW provider.
-        /// The collection provider GUID is {35167F8E-49B2-4b96-AB86-435B59336B5E}.
         /// </summary>
         public static readonly CDSCollectionETWBCLProvider Log = new CDSCollectionETWBCLProvider();
-        /// <summary>Prevent external instantiation.  All logging should go through the Log instance.</summary>
-        private CDSCollectionETWBCLProvider() { }
 
         /// <summary>Enabled for all keywords.</summary>
         private const EventKeywords ALL_KEYWORDS = (EventKeywords)(-1);

src/libraries/System.Data.Common/src/System/Data/Common/DataCommonEventSource.cs

@@ -7,7 +7,7 @@
 namespace System.Data
 {
     [EventSource(Name = "System.Data.DataCommonEventSource")]
-    internal sealed class DataCommonEventSource : EventSource
+    internal sealed partial class DataCommonEventSource : EventSource
     {
         internal static readonly DataCommonEventSource Log = new DataCommonEventSource();
         private static long s_nextScopeId;

src/libraries/System.Data.OleDb/src/System/Data/Common/DataCommonEventSource.cs

@@ -7,7 +7,7 @@
 namespace System.Data
 {
     [EventSource(Name = "System.Data.DataCommonEventSource")]
-    internal sealed class DataCommonEventSource : EventSource
+    internal sealed partial class DataCommonEventSource : EventSource
     {
         internal static readonly DataCommonEventSource Log = new DataCommonEventSource();
         private const int TraceEventId = 1;

src/libraries/System.Diagnostics.DiagnosticSource/src/System/Diagnostics/DiagnosticSourceEventSource.cs

@@ -159,8 +159,10 @@ namespace System.Diagnostics
     ///
     /// See the DiagnosticSourceEventSourceBridgeTest.cs for more explicit examples of using this bridge.
     /// </summary>
+#pragma warning disable ESGEN001 // EventSource class is not partial. It's blocked by https://github.com/dotnet/runtime/issues/121205
     [EventSource(Name = DiagnosticSourceEventSourceName)]
     internal sealed class DiagnosticSourceEventSource : EventSource
+#pragma warning restore ESGEN001
     {
         private const string DiagnosticSourceEventSourceName = "Microsoft-Diagnostics-DiagnosticSource";
 
@@ -404,10 +406,8 @@ protected override void OnEventCommand(EventCommandEventArgs command)
         }
 
         #region private
-        private DiagnosticSourceEventSource()
-            // This constructor uses EventSourceSettings which is only available on V4.6 and above
-            // Use the EventSourceSettings to turn on support for complex types, if available (v4.6 and above).
-            : base(DiagnosticSourceEventSourceName, EventSourceSettings.EtwSelfDescribingEventFormat)
+        // This event source uses IEnumerable<T> as an event parameter type which is only supported by EtwSelfDescribingEventFormat.
+        private DiagnosticSourceEventSource() : base(DiagnosticSourceEventSourceName, EventSourceSettings.EtwSelfDescribingEventFormat)
         {
         }
 

src/libraries/System.Diagnostics.DiagnosticSource/src/System/Diagnostics/Metrics/MetricsEventSource.cs

@@ -48,11 +48,9 @@ namespace System.Diagnostics.Metrics
     ///         not counting the special zero bucket. The default value is 160.
     ///       o reportDeltas - If true, the histogram will report deltas instead of whole accumulated values. The default value is false.
     /// </summary>
-    [EventSource(Name = MetricsEventSourceName)]
-    internal sealed class MetricsEventSource : EventSource
+    [EventSource(Name = "System.Diagnostics.Metrics")]
+    internal sealed partial class MetricsEventSource : EventSource
     {
-        private const string MetricsEventSourceName = "System.Diagnostics.Metrics";
-
         public static readonly MetricsEventSource Log = new();
 
         // Although this API isn't public, it is invoked via reflection from System.Private.CoreLib and needs the same back-compat
@@ -98,11 +96,6 @@ private CommandHandler Handler
             }
         }
 
-        private MetricsEventSource()
-            : base(MetricsEventSourceName, EventSourceSettings.EtwManifestEventFormat)
-        {
-        }
-
         /// <summary>
         /// Used to send ad-hoc diagnostics to humans.
         /// </summary>

src/libraries/System.Diagnostics.Tracing/ref/System.Diagnostics.Tracing.cs

@@ -155,6 +155,8 @@ protected EventSource(System.Diagnostics.Tracing.EventSourceSettings settings, p
         public EventSource(string eventSourceName) { }
         public EventSource(string eventSourceName, System.Diagnostics.Tracing.EventSourceSettings config) { }
         public EventSource(string eventSourceName, System.Diagnostics.Tracing.EventSourceSettings config, params string[]? traits) { }
+        public EventSource(string eventSourceName, System.Guid eventSourceGuid) { }
+        public EventSource(string eventSourceName, System.Guid eventSourceGuid, System.Diagnostics.Tracing.EventSourceSettings settings, string[]? traits = null) { }
         public System.Exception? ConstructionException { get { throw null; } }
         public static System.Guid CurrentThreadActivityId { get { throw null; } }
         public System.Guid Guid { get { throw null; } }

src/libraries/System.Linq.Parallel/src/System/Linq/Parallel/Utils/PLINQETWProvider.cs

@@ -22,15 +22,12 @@ namespace System.Linq.Parallel
     [EventSource(
         Name = "System.Linq.Parallel.PlinqEventSource",
         Guid = "159eeeec-4a14-4418-a8fe-faabcd987887")]
-    internal sealed class PlinqEtwProvider : EventSource
+    internal sealed partial class PlinqEtwProvider : EventSource
     {
         /// <summary>
         /// Defines the singleton instance for the PLINQ ETW provider.
-        /// The PLINQ Event provider GUID is {159eeeec-4a14-4418-a8fe-faabcd987887}.
         /// </summary>
         internal static readonly PlinqEtwProvider Log = new PlinqEtwProvider();
-        /// <summary>Prevent external instantiation.  All logging should go through the Log instance.</summary>
-        private PlinqEtwProvider() { }
 
         /// <summary>Cached id for the default scheduler.</summary>
         /// <remarks>If PLINQ ever supports other schedulers, that information will need to be passed into the query events.</remarks>

src/libraries/System.Net.Http.WinHttpHandler/src/System/Net/Http/NetEventSource.WinHttpHandler.cs

@@ -5,11 +5,8 @@
 
 namespace System.Net
 {
-    [EventSource(Name = NetEventSourceName)]
+    [EventSource(Name = "Private.InternalDiagnostics.System.Net.Http.WinHttpHandler")]
     internal sealed partial class NetEventSource
     {
-        private const string NetEventSourceName = "Private.InternalDiagnostics.System.Net.Http.WinHttpHandler";
-
-        public NetEventSource() : base(NetEventSourceName, EventSourceSettings.EtwManifestEventFormat) { }
     }
 }

src/libraries/System.Net.Http/src/System/Net/Http/HttpTelemetry.cs

@@ -9,16 +9,9 @@
 
 namespace System.Net.Http
 {
-    [EventSource(Name = HttpTelemetryName)]
+    [EventSource(Name = "System.Net.Http")]
     internal sealed partial class HttpTelemetry : EventSource
     {
-        private const string HttpTelemetryName = "System.Net.Http";
-
-        public HttpTelemetry()
-            : base(HttpTelemetryName, EventSourceSettings.EtwManifestEventFormat)
-        {
-        }
-
         public static readonly HttpTelemetry Log = new HttpTelemetry();
 
         public static class Keywords

src/libraries/System.Net.Http/src/System/Net/Http/NetEventSource.Http.cs

@@ -7,13 +7,9 @@
 
 namespace System.Net
 {
-    [EventSource(Name = NetEventSourceName)]
+    [EventSource(Name = "Private.InternalDiagnostics.System.Net.Http")]
     internal sealed partial class NetEventSource
     {
-        private const string NetEventSourceName = "Private.InternalDiagnostics.System.Net.Http";
-
-        public NetEventSource() : base(NetEventSourceName, EventSourceSettings.EtwManifestEventFormat) { }
-
         private const int UriBaseAddressId = NextAvailableEventId;
         private const int ContentNullId = UriBaseAddressId + 1;
         private const int HeadersInvalidValueId = ContentNullId + 1;

src/libraries/System.Net.HttpListener/src/System/Net/NetEventSource.HttpListener.cs

@@ -5,11 +5,8 @@
 
 namespace System.Net
 {
-    [EventSource(Name = NetEventSourceName)]
+    [EventSource(Name = "Private.InternalDiagnostics.System.Net.HttpListener")]
     internal sealed partial class NetEventSource
     {
-        private const string NetEventSourceName = "Private.InternalDiagnostics.System.Net.HttpListener";
-
-        public NetEventSource() : base(NetEventSourceName, EventSourceSettings.EtwManifestEventFormat) { }
     }
 }

src/libraries/System.Net.Mail/src/System/Net/Mail/NetEventSource.Mail.cs

@@ -7,11 +7,8 @@
 
 namespace System.Net
 {
-    [EventSource(Name = NetEventSourceName)]
+    [EventSource(Name = "Private.InternalDiagnostics.System.Net.Mail")]
     internal sealed partial class NetEventSource
     {
-        private const string NetEventSourceName = "Private.InternalDiagnostics.System.Net.Mail";
-
-        public NetEventSource() : base(NetEventSourceName, EventSourceSettings.EtwManifestEventFormat) { }
     }
 }

src/libraries/System.Net.NameResolution/src/System/Net/NameResolutionTelemetry.cs

@@ -9,16 +9,9 @@
 
 namespace System.Net
 {
-    [EventSource(Name = NameResolutionTelemetryName)]
-    internal sealed class NameResolutionTelemetry : EventSource
+    [EventSource(Name = "System.Net.NameResolution")]
+    internal sealed partial class NameResolutionTelemetry : EventSource
     {
-        private const string NameResolutionTelemetryName = "System.Net.NameResolution";
-
-        public NameResolutionTelemetry()
-            : base(NameResolutionTelemetryName, EventSourceSettings.EtwManifestEventFormat)
-        {
-        }
-
         public static readonly NameResolutionTelemetry Log = new NameResolutionTelemetry();
 
         private const int ResolutionStartEventId = 1;

src/libraries/System.Net.NameResolution/src/System/Net/NetEventSource.NameResolution.cs

@@ -5,11 +5,8 @@
 
 namespace System.Net
 {
-    [EventSource(Name = NetEventSourceName)]
+    [EventSource(Name = "Private.InternalDiagnostics.System.Net.NameResolution")]
     internal sealed partial class NetEventSource
     {
-        private const string NetEventSourceName = "Private.InternalDiagnostics.System.Net.NameResolution";
-
-        public NetEventSource() : base(NetEventSourceName, EventSourceSettings.EtwManifestEventFormat) { }
     }
 }

src/libraries/System.Net.NetworkInformation/src/System/Net/NetworkInformation/NetEventSource.NetworkInformation.cs

@@ -7,13 +7,9 @@
 
 namespace System.Net
 {
-    [EventSource(Name = NetEventSourceName)]
-    internal sealed class NetEventSource : EventSource
+    [EventSource(Name = "Private.InternalDiagnostics.System.Net.NetworkInformation")]
+    internal sealed partial class NetEventSource : EventSource
     {
-        private const string NetEventSourceName = "Private.InternalDiagnostics.System.Net.NetworkInformation";
-
-        public NetEventSource() : base(NetEventSourceName, EventSourceSettings.EtwManifestEventFormat) { }
-
         public static readonly NetEventSource Log = new NetEventSource();
 
         private const int ErrorEventId = 2;

src/libraries/System.Net.Primitives/src/System/Net/NetEventSource.Primitives.cs

@@ -5,11 +5,8 @@
 
 namespace System.Net
 {
-    [EventSource(Name = NetEventSourceName)]
+    [EventSource(Name = "Private.InternalDiagnostics.System.Net.Primitives")]
     internal sealed partial class NetEventSource
     {
-        private const string NetEventSourceName = "Private.InternalDiagnostics.System.Net.Primitives";
-
-        public NetEventSource() : base(NetEventSourceName, EventSourceSettings.EtwManifestEventFormat) { }
     }
 }

src/libraries/System.Net.Quic/src/System/Net/Quic/NetEventSource.Quic.cs

@@ -6,13 +6,9 @@
 
 namespace System.Net
 {
-    [EventSource(Name = NetEventSourceName)]
+    [EventSource(Name = "Private.InternalDiagnostics.System.Net.Quic")]
     internal sealed partial class NetEventSource
     {
-        private const string NetEventSourceName = "Private.InternalDiagnostics.System.Net.Quic";
-
-        public NetEventSource() : base(NetEventSourceName, EventSourceSettings.EtwManifestEventFormat) { }
-
         static partial void AdditionalCustomizedToString(object value, ref string? result)
         {
             if (value is MsQuicSafeHandle safeHandle)

src/libraries/System.Net.Requests/src/System/Net/NetEventSource.Requests.cs

@@ -5,11 +5,8 @@
 
 namespace System.Net
 {
-    [EventSource(Name = NetEventSourceName)]
+    [EventSource(Name = "Private.InternalDiagnostics.System.Net.Requests")]
     internal sealed partial class NetEventSource
     {
-        private const string NetEventSourceName = "Private.InternalDiagnostics.System.Net.Requests";
-
-        public NetEventSource() : base(NetEventSourceName, EventSourceSettings.EtwManifestEventFormat) { }
     }
 }

src/libraries/System.Net.Security/src/System/Net/Security/NetEventSource.Security.cs

@@ -11,13 +11,9 @@
 
 namespace System.Net
 {
-    [EventSource(Name = NetEventSourceName)]
+    [EventSource(Name = "Private.InternalDiagnostics.System.Net.Security")]
     internal sealed partial class NetEventSource
     {
-        private const string NetEventSourceName = "Private.InternalDiagnostics.System.Net.Security";
-
-        public NetEventSource() : base(NetEventSourceName, EventSourceSettings.EtwManifestEventFormat) { }
-
 #if WINDOWS
         // More events are defined in NetEventSource.Security.Windows.cs
         private const int LocatingPrivateKeyId = OperationReturnedSomethingId + 1;