Resolve ILLink warnings in Microsoft.Extensions.Logging.EventSource (#…

…52656) * Resolve ILLink warnings in Microsoft.Extensions.Logging.EventSource * Add nullable enable to attribute files
dotnet · May 14, 2021 · 5045334 · 5045334
1 parent 6ddabaf
commit 5045334
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 48 deletions.
diff --git a/src/libraries/Microsoft.Extensions.Logging.EventSource/src/ILLink/ILLink.Suppressions.xml b/src/libraries/Microsoft.Extensions.Logging.EventSource/src/ILLink/ILLink.Suppressions.xml
diff --git a/src/libraries/Microsoft.Extensions.Logging.EventSource/src/LoggingEventSource.cs b/src/libraries/Microsoft.Extensions.Logging.EventSource/src/LoggingEventSource.cs
@@ -4,6 +4,7 @@
 using System;
 using System.Collections.Generic;
 using System.Diagnostics;
+using System.Diagnostics.CodeAnalysis;
 using System.Diagnostics.Tracing;
 using System.Runtime.CompilerServices;
 using System.Threading;
@@ -114,6 +115,8 @@ public static class Keywords
         private LoggerFilterRule[] _filterSpec = Array.Empty<LoggerFilterRule>();
         private CancellationTokenSource _cancellationTokenSource;
         private const string UseAppFilters = "UseAppFilters";
+        private const string WriteEventCoreSuppressionJustification = "WriteEventCore is safe when eventData object is a primitive type which is in this case.";
+        private const string WriteEventDynamicDependencySuppressionJustification = "DynamicDependency attribute will ensure that the required properties are not trimmed.";
 
         private LoggingEventSource() : base(EventSourceSettings.EtwSelfDescribingEventFormat)
         {
@@ -124,6 +127,8 @@ private LoggingEventSource() : base(EventSourceSettings.EtwSelfDescribingEventFo
         /// This only gives you the human readable formatted message.
         /// </summary>
         [Event(1, Keywords = Keywords.FormattedMessage, Level = EventLevel.LogAlways)]
+        [UnconditionalSuppressMessage("ReflectionAnalysis", "IL2026:RequiresUnreferencedCode",
+            Justification = WriteEventCoreSuppressionJustification)]
         internal unsafe void FormattedMessage(LogLevel Level, int FactoryID, string LoggerName, int EventId, string EventName, string FormattedMessage)
         {
             if (IsEnabled())
@@ -156,6 +161,9 @@ internal unsafe void FormattedMessage(LogLevel Level, int FactoryID, string Logg
         /// This gives you the logged information in a programmatic format (arguments are key-value pairs)
         /// </summary>
         [Event(2, Keywords = Keywords.Message, Level = EventLevel.LogAlways)]
+        [DynamicDependency(DynamicallyAccessedMemberTypes.PublicProperties, typeof(KeyValuePair<string, string>))]
+        [UnconditionalSuppressMessage("ReflectionAnalysis", "IL2026:RequiresUnreferencedCode",
+            Justification = WriteEventDynamicDependencySuppressionJustification)]
         internal void Message(LogLevel Level, int FactoryID, string LoggerName, int EventId, string EventName, ExceptionInfo Exception, IEnumerable<KeyValuePair<string, string>> Arguments)
         {
             if (IsEnabled())
@@ -168,6 +176,9 @@ internal void Message(LogLevel Level, int FactoryID, string LoggerName, int Even
         /// ActivityStart is called when ILogger.BeginScope() is called
         /// </summary>
         [Event(3, Keywords = Keywords.Message | Keywords.FormattedMessage, Level = EventLevel.LogAlways, ActivityOptions = EventActivityOptions.Recursive)]
+        [DynamicDependency(DynamicallyAccessedMemberTypes.PublicProperties, typeof(KeyValuePair<string, string>))]
+        [UnconditionalSuppressMessage("ReflectionAnalysis", "IL2026:RequiresUnreferencedCode",
+            Justification = WriteEventDynamicDependencySuppressionJustification)]
         internal void ActivityStart(int ID, int FactoryID, string LoggerName, IEnumerable<KeyValuePair<string, string>> Arguments)
         {
             if (IsEnabled())
@@ -177,6 +188,8 @@ internal void ActivityStart(int ID, int FactoryID, string LoggerName, IEnumerabl
         }
 
         [Event(4, Keywords = Keywords.Message | Keywords.FormattedMessage, Level = EventLevel.LogAlways)]
+        [UnconditionalSuppressMessage("ReflectionAnalysis", "IL2026:RequiresUnreferencedCode",
+            Justification = WriteEventCoreSuppressionJustification)]
         internal unsafe void ActivityStop(int ID, int FactoryID, string LoggerName)
         {
             if (IsEnabled())
@@ -198,6 +211,8 @@ internal unsafe void ActivityStop(int ID, int FactoryID, string LoggerName)
         }
 
         [Event(5, Keywords = Keywords.JsonMessage, Level = EventLevel.LogAlways)]
+        [UnconditionalSuppressMessage("ReflectionAnalysis", "IL2026:RequiresUnreferencedCode",
+            Justification = WriteEventCoreSuppressionJustification)]
         internal unsafe void MessageJson(LogLevel Level, int FactoryID, string LoggerName, int EventId, string EventName, string ExceptionJson, string ArgumentsJson, string FormattedMessage)
         {
             if (IsEnabled())
@@ -232,6 +247,8 @@ internal unsafe void MessageJson(LogLevel Level, int FactoryID, string LoggerNam
         }
 
         [Event(6, Keywords = Keywords.JsonMessage | Keywords.FormattedMessage, Level = EventLevel.LogAlways, ActivityOptions = EventActivityOptions.Recursive)]
+        [UnconditionalSuppressMessage("ReflectionAnalysis", "IL2026:RequiresUnreferencedCode",
+            Justification = WriteEventCoreSuppressionJustification)]
         internal unsafe void ActivityJsonStart(int ID, int FactoryID, string LoggerName, string ArgumentsJson)
         {
             if (IsEnabled())
@@ -256,6 +273,8 @@ internal unsafe void ActivityJsonStart(int ID, int FactoryID, string LoggerName,
         }
 
         [Event(7, Keywords = Keywords.JsonMessage | Keywords.FormattedMessage, Level = EventLevel.LogAlways)]
+        [UnconditionalSuppressMessage("ReflectionAnalysis", "IL2026:RequiresUnreferencedCode",
+            Justification = WriteEventCoreSuppressionJustification)]
         internal unsafe void ActivityJsonStop(int ID, int FactoryID, string LoggerName)
         {
             if (IsEnabled())

diff --git a/...rosoft.Extensions.Logging.EventSource/src/Microsoft.Extensions.Logging.EventSource.csproj b/...rosoft.Extensions.Logging.EventSource/src/Microsoft.Extensions.Logging.EventSource.csproj
@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <TargetFrameworks>$(NetCoreAppCurrent);netcoreapp3.0;netstandard2.0;net461</TargetFrameworks>
@@ -25,6 +25,12 @@
     <ProjectReference Include="$(LibrariesProjectRoot)Microsoft.Extensions.Primitives\src\Microsoft.Extensions.Primitives.csproj" />
   </ItemGroup>
 
+  <ItemGroup Condition="'$(TargetFramework)' != '$(NetCoreAppCurrent)'">
+    <Compile Include="$(CoreLibSharedDir)System\Diagnostics\CodeAnalysis\DynamicDependencyAttribute.cs" />
+    <Compile Include="$(CoreLibSharedDir)System\Diagnostics\CodeAnalysis\DynamicallyAccessedMemberTypes.cs" />
+    <Compile Include="$(CoreLibSharedDir)System\Diagnostics\CodeAnalysis\UnconditionalSuppressMessageAttribute.cs" />
+  </ItemGroup>
+
   <ItemGroup Condition="'$(TargetFramework)' == 'netstandard2.0' or
                         $(TargetFramework.StartsWith('net4'))">
     <PackageReference Include="System.Memory" Version="$(SystemMemoryVersion)" />

diff --git a/.../System.Private.CoreLib/src/System/Diagnostics/CodeAnalysis/DynamicDependencyAttribute.cs b/.../System.Private.CoreLib/src/System/Diagnostics/CodeAnalysis/DynamicDependencyAttribute.cs
@@ -1,6 +1,8 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
+#nullable enable
+
 namespace System.Diagnostics.CodeAnalysis
 {
     /// <summary>

diff --git a/...vate.CoreLib/src/System/Diagnostics/CodeAnalysis/UnconditionalSuppressMessageAttribute.cs b/...vate.CoreLib/src/System/Diagnostics/CodeAnalysis/UnconditionalSuppressMessageAttribute.cs
@@ -1,6 +1,8 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
+#nullable enable
+
 namespace System.Diagnostics.CodeAnalysis
 {
     /// <summary>