| | | 1 | | // Licensed to the .NET Foundation under one or more agreements. |
| | | 2 | | // The .NET Foundation licenses this file to you under the MIT license. |
| | | 3 | | |
| | | 4 | | using System.Collections; |
| | | 5 | | using System.Diagnostics; |
| | | 6 | | using System.Diagnostics.CodeAnalysis; |
| | | 7 | | using System.Diagnostics.Tracing; |
| | | 8 | | using System.Runtime.CompilerServices; |
| | | 9 | | using System.Runtime.InteropServices; |
| | | 10 | | |
| | | 11 | | #pragma warning disable CA1823 // not all IDs are used by all partial providers |
| | | 12 | | |
| | | 13 | | namespace System.Net |
| | | 14 | | { |
| | | 15 | | // Implementation: |
| | | 16 | | // This partial file is meant to be consumed into each System.Net.* assembly that needs to log. Each such assembly |
| | | 17 | | // its own NetEventSource partial class that adds an appropriate [EventSource] attribute, giving it a unique name fo |
| | | 18 | | // Those partials can then also add additional events if needed, starting numbering from the NextAvailableEventId de |
| | | 19 | | |
| | | 20 | | // Usage: |
| | | 21 | | // - Operations that may allocate (e.g. boxing a value type, using string interpolation, etc.) or that may have comp |
| | | 22 | | // at call sites should guard access like: |
| | | 23 | | // if (NetEventSource.Log.IsEnabled()) NetEventSource.Info(null, $"Found certificate: {cert}"); // info loggin |
| | | 24 | | // - Operations that have zero allocations / measurable computations at call sites can use a simpler pattern, callin |
| | | 25 | | // NetEventSource.Info(this, "literal string"); // arbitrary message with a literal string |
| | | 26 | | // Debug.Asserts inside the logging methods will help to flag some misuse if the DEBUG_NETEVENTSOURCE_MISUSE compi |
| | | 27 | | // However, because it can be difficult by observation to understand all of the costs involved, guarding can be do |
| | | 28 | | // - Messages can be strings, formattable strings, or any other object. Objects (including those used in formattabl |
| | | 29 | | // formatting applied, controlled by the Format method. Partial specializations can also override this formatting |
| | | 30 | | // method that takes an object and optionally provides a string representation of it, in case a particular library |
| | | 31 | | |
| | | 32 | | /// <summary>Provides logging facilities for System.Net libraries.</summary> |
| | | 33 | | internal sealed partial class NetEventSource : EventSource |
| | | 34 | | { |
| | | 35 | | private const string EventSourceSuppressMessage = "Parameters to this method are primitive and are trimmer safe" |
| | | 36 | | |
| | | 37 | | /// <summary>The single event source instance to use for all logging.</summary> |
| | 0 | 38 | | public static readonly NetEventSource Log = new NetEventSource(); |
| | | 39 | | |
| | | 40 | | #region Metadata |
| | | 41 | | private const string MissingMember = "(?)"; |
| | | 42 | | private const string NullInstance = "(null)"; |
| | | 43 | | private const string StaticMethodObject = "(static)"; |
| | | 44 | | private const string NoParameters = ""; |
| | | 45 | | |
| | | 46 | | private const int InfoEventId = 1; |
| | | 47 | | private const int ErrorEventId = 2; |
| | | 48 | | // private const int AssociateEventId = 3; // Defined in NetEventSource.Common.Associate.cs |
| | | 49 | | // private const int DumpArrayEventId = 4; // Defined in NetEventSource.Common.DumpBuffer.cs |
| | | 50 | | |
| | | 51 | | private const int NextAvailableEventId = 5; // Update this value whenever new events are added. Derived types s |
| | | 52 | | #endregion |
| | | 53 | | |
| | | 54 | | #region Info |
| | | 55 | | /// <summary>Logs an information message.</summary> |
| | | 56 | | /// <param name="thisOrContextObject">`this`, or another object that serves to provide context for the operation |
| | | 57 | | /// <param name="formattableString">The message to be logged.</param> |
| | | 58 | | /// <param name="memberName">The calling member.</param> |
| | | 59 | | [NonEvent] |
| | | 60 | | public static void Info(object? thisOrContextObject, FormattableString? formattableString = null, [CallerMemberN |
| | 0 | 61 | | Log.Info(IdOf(thisOrContextObject), memberName, formattableString != null ? Format(formattableString) : NoPa |
| | | 62 | | |
| | | 63 | | /// <summary>Logs an information message.</summary> |
| | | 64 | | /// <param name="thisOrContextObject">`this`, or another object that serves to provide context for the operation |
| | | 65 | | /// <param name="message">The message to be logged.</param> |
| | | 66 | | /// <param name="memberName">The calling member.</param> |
| | | 67 | | [NonEvent] |
| | | 68 | | public static void Info(object? thisOrContextObject, object? message, [CallerMemberName] string? memberName = nu |
| | 0 | 69 | | Log.Info(IdOf(thisOrContextObject), memberName, Format(message)); |
| | | 70 | | |
| | | 71 | | [Event(InfoEventId, Level = EventLevel.Informational)] |
| | | 72 | | private void Info(string thisOrContextObject, string? memberName, string? message) |
| | 0 | 73 | | { |
| | 0 | 74 | | Debug.Assert(IsEnabled()); |
| | 0 | 75 | | WriteEvent(InfoEventId, thisOrContextObject, memberName ?? MissingMember, message); |
| | 0 | 76 | | } |
| | | 77 | | #endregion |
| | | 78 | | |
| | | 79 | | #region Error |
| | | 80 | | /// <summary>Logs an error message.</summary> |
| | | 81 | | /// <param name="thisOrContextObject">`this`, or another object that serves to provide context for the operation |
| | | 82 | | /// <param name="formattableString">The message to be logged.</param> |
| | | 83 | | /// <param name="memberName">The calling member.</param> |
| | | 84 | | [NonEvent] |
| | | 85 | | public static void Error(object? thisOrContextObject, FormattableString formattableString, [CallerMemberName] st |
| | | 86 | | Log.ErrorMessage(IdOf(thisOrContextObject), memberName, Format(formattableString)); |
| | | 87 | | |
| | | 88 | | /// <summary>Logs an error message.</summary> |
| | | 89 | | /// <param name="thisOrContextObject">`this`, or another object that serves to provide context for the operation |
| | | 90 | | /// <param name="message">The message to be logged.</param> |
| | | 91 | | /// <param name="memberName">The calling member.</param> |
| | | 92 | | [NonEvent] |
| | | 93 | | public static void Error(object? thisOrContextObject, object message, [CallerMemberName] string? memberName = nu |
| | | 94 | | Log.ErrorMessage(IdOf(thisOrContextObject), memberName, Format(message)); |
| | | 95 | | |
| | | 96 | | [Event(ErrorEventId, Level = EventLevel.Error)] |
| | | 97 | | private void ErrorMessage(string thisOrContextObject, string? memberName, string? message) |
| | | 98 | | { |
| | | 99 | | Debug.Assert(IsEnabled()); |
| | | 100 | | WriteEvent(ErrorEventId, thisOrContextObject, memberName ?? MissingMember, message); |
| | | 101 | | } |
| | | 102 | | #endregion |
| | | 103 | | |
| | | 104 | | #region Helpers |
| | | 105 | | [NonEvent] |
| | 0 | 106 | | public static string IdOf(object? value) => value != null ? value.GetType().Name + "#" + GetHashCode(value) : Nu |
| | | 107 | | |
| | | 108 | | [NonEvent] |
| | 0 | 109 | | public static int GetHashCode(object? value) => value?.GetHashCode() ?? 0; |
| | | 110 | | |
| | | 111 | | [NonEvent] |
| | | 112 | | public static string? Format(object? value) |
| | 0 | 113 | | { |
| | | 114 | | // If it's null, return a known string for null values |
| | 0 | 115 | | if (value == null) |
| | 0 | 116 | | { |
| | 0 | 117 | | return NullInstance; |
| | | 118 | | } |
| | | 119 | | |
| | | 120 | | // Give another partial implementation a chance to provide its own string representation |
| | 0 | 121 | | string? result = null; |
| | | 122 | | AdditionalCustomizedToString(value, ref result); |
| | 0 | 123 | | if (result is not null) |
| | 0 | 124 | | { |
| | 0 | 125 | | return result; |
| | | 126 | | } |
| | | 127 | | |
| | | 128 | | // Format arrays with their element type name and length |
| | 0 | 129 | | if (value is Array arr) |
| | 0 | 130 | | { |
| | 0 | 131 | | return $"{arr.GetType().GetElementType()}[{((Array)value).Length}]"; |
| | | 132 | | } |
| | | 133 | | |
| | | 134 | | // Format ICollections as the name and count |
| | 0 | 135 | | if (value is ICollection c) |
| | 0 | 136 | | { |
| | 0 | 137 | | return $"{c.GetType().Name}({c.Count})"; |
| | | 138 | | } |
| | | 139 | | |
| | | 140 | | // Format SafeHandles as their type, hash code, and pointer value |
| | 0 | 141 | | if (value is SafeHandle handle) |
| | 0 | 142 | | { |
| | 0 | 143 | | return $"{handle.GetType().Name}:{handle.GetHashCode()}(0x{handle.DangerousGetHandle():X})"; |
| | | 144 | | } |
| | | 145 | | |
| | | 146 | | // Format IntPtrs as hex |
| | 0 | 147 | | if (value is IntPtr) |
| | 0 | 148 | | { |
| | 0 | 149 | | return $"0x{value:X}"; |
| | | 150 | | } |
| | | 151 | | |
| | | 152 | | // If the string representation of the instance would just be its type name, |
| | | 153 | | // use its id instead. |
| | 0 | 154 | | string? toString = value.ToString(); |
| | 0 | 155 | | if (toString == null || toString == value.GetType().FullName) |
| | 0 | 156 | | { |
| | 0 | 157 | | return IdOf(value); |
| | | 158 | | } |
| | | 159 | | |
| | | 160 | | // Otherwise, return the original object so that the caller does default formatting. |
| | 0 | 161 | | return value.ToString(); |
| | 0 | 162 | | } |
| | | 163 | | |
| | | 164 | | [NonEvent] |
| | | 165 | | private static string Format(FormattableString s) |
| | 0 | 166 | | { |
| | 0 | 167 | | switch (s.ArgumentCount) |
| | | 168 | | { |
| | 0 | 169 | | case 0: return s.Format; |
| | 0 | 170 | | case 1: return string.Format(s.Format, Format(s.GetArgument(0))); |
| | 0 | 171 | | case 2: return string.Format(s.Format, Format(s.GetArgument(0)), Format(s.GetArgument(1))); |
| | 0 | 172 | | case 3: return string.Format(s.Format, Format(s.GetArgument(0)), Format(s.GetArgument(1)), Format(s.GetA |
| | | 173 | | default: |
| | 0 | 174 | | string?[] formattedArgs = new string?[s.ArgumentCount]; |
| | 0 | 175 | | for (int i = 0; i < formattedArgs.Length; i++) |
| | 0 | 176 | | { |
| | 0 | 177 | | formattedArgs[i] = Format(s.GetArgument(i)); |
| | 0 | 178 | | } |
| | 0 | 179 | | return string.Format(s.Format, formattedArgs); |
| | | 180 | | } |
| | 0 | 181 | | } |
| | | 182 | | |
| | | 183 | | static partial void AdditionalCustomizedToString(object value, ref string? result); |
| | | 184 | | #endregion |
| | | 185 | | |
| | | 186 | | [UnconditionalSuppressMessage("ReflectionAnalysis", "IL2026:UnrecognizedReflectionPattern", |
| | | 187 | | Justification = EventSourceSuppressMessage)] |
| | | 188 | | [NonEvent] |
| | | 189 | | private unsafe void WriteEvent(int eventId, string? arg1, string? arg2, int arg3) |
| | | 190 | | { |
| | | 191 | | arg1 ??= ""; |
| | | 192 | | arg2 ??= ""; |
| | | 193 | | |
| | | 194 | | fixed (char* arg1Ptr = arg1) |
| | | 195 | | fixed (char* arg2Ptr = arg2) |
| | | 196 | | { |
| | | 197 | | const int NumEventDatas = 3; |
| | | 198 | | EventData* descrs = stackalloc EventData[NumEventDatas]; |
| | | 199 | | |
| | | 200 | | descrs[0] = new EventData |
| | | 201 | | { |
| | | 202 | | DataPointer = (IntPtr)(arg1Ptr), |
| | | 203 | | Size = (arg1.Length + 1) * sizeof(char) |
| | | 204 | | }; |
| | | 205 | | descrs[1] = new EventData |
| | | 206 | | { |
| | | 207 | | DataPointer = (IntPtr)(arg2Ptr), |
| | | 208 | | Size = (arg2.Length + 1) * sizeof(char) |
| | | 209 | | }; |
| | | 210 | | descrs[2] = new EventData |
| | | 211 | | { |
| | | 212 | | DataPointer = (IntPtr)(&arg3), |
| | | 213 | | Size = sizeof(int) |
| | | 214 | | }; |
| | | 215 | | |
| | | 216 | | WriteEventCore(eventId, NumEventDatas, descrs); |
| | | 217 | | } |
| | | 218 | | } |
| | | 219 | | } |
| | | 220 | | } |
| | | 221 | | |