File size: 15,863 Bytes
8c763fb | 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 | // Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
#if !UNIX
using System.Collections.Generic;
using System.Diagnostics.Eventing;
using System.Diagnostics;
using System.Diagnostics.CodeAnalysis;
namespace System.Management.Automation.Tracing
{
/// <summary>
/// Attribute to represent an EtwEvent.
/// </summary>
[AttributeUsage(AttributeTargets.Method)]
[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly")]
[SuppressMessage("Microsoft.Naming", "CA1710:IdentifiersShouldHaveCorrectSuffix")]
public sealed class EtwEvent : Attribute
{
/// <summary>
/// Constructor.
/// </summary>
/// <param name="eventId"></param>
public EtwEvent(long eventId)
{
this.EventId = eventId;
}
/// <summary>
/// EventId.
/// </summary>
public long EventId { get; }
}
/// <summary>
/// Delegates that defines a call back with no parameter.
/// </summary>
public delegate void CallbackNoParameter();
/// <summary>
/// Delegates that defines a call back with one parameter (state)
/// </summary>
public delegate void CallbackWithState(object state);
/// <summary>
/// Delegates that defines a call back with two parameters; state and ElapsedEventArgs.
/// It will be used in System.Timers.Timer scenarios.
/// </summary>
public delegate void CallbackWithStateAndArgs(object state, System.Timers.ElapsedEventArgs args);
/// <summary>
/// ETW events argument class.
/// </summary>
[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly")]
public class EtwEventArgs : EventArgs
{
/// <summary> Gets Event descriptor </summary>
public EventDescriptor Descriptor
{
get;
private set;
}
/// <summary> Gets whether the event is successfully written </summary>
public bool Success { get; }
/// <summary> Gets payload in the event </summary>
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
public object[] Payload { get; }
/// <summary>
/// Creates a new instance of EtwEventArgs class.
/// </summary>
/// <param name="descriptor">Event descriptor.</param>
/// <param name="success">Indicate whether the event is successfully written.</param>
/// <param name="payload">Event payload.</param>
public EtwEventArgs(EventDescriptor descriptor, bool success, object[] payload)
{
this.Descriptor = descriptor;
this.Payload = payload;
this.Success = success;
}
}
/// <summary>
/// This the abstract base class of all activity classes that represent an end-to-end scenario.
/// </summary>
[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly")]
public abstract class EtwActivity
{
/// <summary>
/// This is a helper class that is used to wrap many multi-threading scenarios
/// and makes correlation event to be logged easily.
/// </summary>
private sealed class CorrelatedCallback
{
private readonly CallbackNoParameter callbackNoParam;
private readonly CallbackWithState callbackWithState;
private readonly AsyncCallback asyncCallback;
/// <summary>
/// ParentActivityId.
/// </summary>
private readonly Guid parentActivityId;
private readonly EtwActivity tracer;
/// <summary>
/// EtwCorrelator Constructor.
/// </summary>
/// <param name="tracer"></param>
/// <param name="callback"></param>
public CorrelatedCallback(EtwActivity tracer, CallbackNoParameter callback)
{
ArgumentNullException.ThrowIfNull(callback);
ArgumentNullException.ThrowIfNull(tracer);
this.tracer = tracer;
this.parentActivityId = EtwActivity.GetActivityId();
this.callbackNoParam = callback;
}
/// <summary>
/// EtwCorrelator Constructor.
/// </summary>
/// <param name="tracer"></param>
/// <param name="callback"></param>
public CorrelatedCallback(EtwActivity tracer, CallbackWithState callback)
{
ArgumentNullException.ThrowIfNull(callback);
ArgumentNullException.ThrowIfNull(tracer);
this.tracer = tracer;
this.parentActivityId = EtwActivity.GetActivityId();
this.callbackWithState = callback;
}
/// <summary>
/// EtwCorrelator Constructor.
/// </summary>
/// <param name="tracer"></param>
/// <param name="callback"></param>
public CorrelatedCallback(EtwActivity tracer, AsyncCallback callback)
{
ArgumentNullException.ThrowIfNull(callback);
ArgumentNullException.ThrowIfNull(tracer);
this.tracer = tracer;
this.parentActivityId = EtwActivity.GetActivityId();
this.asyncCallback = callback;
}
/// <summary>
/// It is to be used in System.Timers.Timer scenarios.
/// </summary>
private readonly CallbackWithStateAndArgs callbackWithStateAndArgs;
/// <summary>
/// EtwCorrelator Constructor.
/// </summary>
/// <param name="tracer"></param>
/// <param name="callback"></param>
public CorrelatedCallback(EtwActivity tracer, CallbackWithStateAndArgs callback)
{
ArgumentNullException.ThrowIfNull(callback);
ArgumentNullException.ThrowIfNull(tracer);
this.tracer = tracer;
this.parentActivityId = EtwActivity.GetActivityId();
this.callbackWithStateAndArgs = callback;
}
/// <summary>
/// This is the wrapper on the actual callback.
/// </summary>
public void Callback(object state, System.Timers.ElapsedEventArgs args)
{
Debug.Assert(callbackWithStateAndArgs != null, "callback is NULL. There MUST always ba a valid callback!");
Correlate();
this.callbackWithStateAndArgs(state, args);
}
/// <summary>
/// Correlate.
/// </summary>
private void Correlate()
{
tracer.CorrelateWithActivity(this.parentActivityId);
}
/// <summary>
/// This is the wrapper on the actual callback.
/// </summary>
public void Callback()
{
Debug.Assert(callbackNoParam != null, "callback is NULL. There MUST always ba a valid callback");
Correlate();
this.callbackNoParam();
}
/// <summary>
/// This is the wrapper on the actual callback.
/// </summary>
public void Callback(object state)
{
Debug.Assert(callbackWithState != null, "callback is NULL. There MUST always ba a valid callback!");
Correlate();
this.callbackWithState(state);
}
/// <summary>
/// This is the wrapper on the actual callback.
/// </summary>
public void Callback(IAsyncResult asyncResult)
{
Debug.Assert(asyncCallback != null, "callback is NULL. There MUST always ba a valid callback!");
Correlate();
this.asyncCallback(asyncResult);
}
}
private static readonly Dictionary<Guid, EventProvider> providers = new Dictionary<Guid, EventProvider>();
private static readonly object syncLock = new object();
private static readonly EventDescriptor _WriteTransferEvent = new EventDescriptor(0x1f05, 0x1, 0x11, 0x5, 0x14, 0x0, (long)0x4000000000000000);
private EventProvider currentProvider;
/// <summary>
/// Event handler for the class.
/// </summary>
public static event EventHandler<EtwEventArgs> EventWritten;
/// <summary>
/// Sets the activityId provided in the current thread.
/// If current thread already has the same activityId it does
/// nothing.
/// </summary>
/// <param name="activityId"></param>
/// <returns>True when provided activity was set, false if current activity
/// was found to be same and set was not needed.</returns>
public static bool SetActivityId(Guid activityId)
{
if (GetActivityId() != activityId)
{
EventProvider.SetActivityId(ref activityId);
return true;
}
return false;
}
/// <summary>
/// Creates a new ActivityId that can be used to set in the thread's context.
/// </summary>
/// <returns></returns>
public static Guid CreateActivityId()
{
return EventProvider.CreateActivityId();
}
/// <summary>
/// Returns the ActivityId set in current thread.
/// </summary>
/// <returns></returns>
[SuppressMessage("Microsoft.Usage", "CA1806:DoNotIgnoreMethodResults")]
public static Guid GetActivityId()
{
Guid activityId = Guid.Empty;
Interop.Windows.GetEventActivityIdControl(ref activityId);
return activityId;
}
/// <summary>
/// Constructor.
/// </summary>
protected EtwActivity()
{
}
/// <summary>
/// CorrelateWithActivity (EventId: 0x1f05/7941)
/// This method also sets a new activity id in current thread.
/// And then correlates the new id with parentActivityId.
/// </summary>
public void CorrelateWithActivity(Guid parentActivityId)
{
EventProvider provider = GetProvider();
if (!provider.IsEnabled())
return;
Guid activityId = CreateActivityId();
SetActivityId(activityId);
if (parentActivityId != Guid.Empty)
{
EventDescriptor transferEvent = TransferEvent;
provider.WriteTransferEvent(in transferEvent, parentActivityId, activityId, parentActivityId);
}
}
/// <summary>
/// IsEnabled.
/// </summary>
public bool IsEnabled
{
get
{
return GetProvider().IsEnabled();
}
}
/// <summary>
/// Checks whether a provider matching certain levels and keyword is enabled.
/// </summary>
/// <param name="levels">Levels to check.</param>
/// <param name="keywords">Keywords to check.</param>
/// <returns>True, if any ETW listener is enabled else false.</returns>
public bool IsProviderEnabled(byte levels, long keywords)
{
return GetProvider().IsEnabled(levels, keywords);
}
/// <summary>
/// Correlates parent activity id set in the thread with a new activity id
/// If parent activity id is not, it just sets a new activity in the current thread. And does not write the Transfer event.
/// </summary>
public void Correlate()
{
Guid parentActivity = GetActivityId();
CorrelateWithActivity(parentActivity);
}
/// <summary>
/// Wraps a callback with no params.
/// </summary>
/// <param name="callback"></param>
/// <returns></returns>
public CallbackNoParameter Correlate(CallbackNoParameter callback)
{
ArgumentNullException.ThrowIfNull(callback);
return new CorrelatedCallback(this, callback).Callback;
}
/// <summary>
/// Wraps a callback with one object param.
/// </summary>
/// <param name="callback"></param>
/// <returns></returns>
public CallbackWithState Correlate(CallbackWithState callback)
{
ArgumentNullException.ThrowIfNull(callback);
return new CorrelatedCallback(this, callback).Callback;
}
/// <summary>
/// Wraps a AsyncCallback with IAsyncResult param.
/// </summary>
/// <param name="callback"></param>
/// <returns></returns>
public AsyncCallback Correlate(AsyncCallback callback)
{
ArgumentNullException.ThrowIfNull(callback);
return new CorrelatedCallback(this, callback).Callback;
}
/// <summary>
/// Wraps a callback with one object param and one ElapsedEventArgs object
/// This is menat to be used in System.Timers.Timer scenarios.
/// </summary>
/// <param name="callback"></param>
/// <returns></returns>
public CallbackWithStateAndArgs Correlate(CallbackWithStateAndArgs callback)
{
ArgumentNullException.ThrowIfNull(callback);
return new CorrelatedCallback(this, callback).Callback;
}
/// <summary>
/// The provider where the tracing messages will be written to.
/// </summary>
protected virtual Guid ProviderId
{
get
{
return PSEtwLogProvider.ProviderGuid;
}
}
/// <summary>
/// The event that is defined to be used to log transfer event.
/// The derived class must override this property if they don't
/// want to use the PowerShell's transfer event.
/// </summary>
protected virtual EventDescriptor TransferEvent
{
get
{
return _WriteTransferEvent;
}
}
/// <summary>
/// This is the main method that write the messages to the trace.
/// All derived classes must use this method to write to the provider log.
/// </summary>
/// <param name="ed">EventDescriptor.</param>
/// <param name="payload">Payload.</param>
protected void WriteEvent(EventDescriptor ed, params object[] payload)
{
EventProvider provider = GetProvider();
if (!provider.IsEnabled())
return;
if (payload != null)
{
for (int i = 0; i < payload.Length; i++)
{
if (payload[i] == null)
{
payload[i] = string.Empty;
}
}
}
bool success = provider.WriteEvent(in ed, payload);
EventWritten?.Invoke(this, new EtwEventArgs(ed, success, payload));
}
private EventProvider GetProvider()
{
if (currentProvider != null)
return currentProvider;
lock (syncLock)
{
if (currentProvider != null)
return currentProvider;
if (!providers.TryGetValue(ProviderId, out currentProvider))
{
currentProvider = new EventProvider(ProviderId);
providers[ProviderId] = currentProvider;
}
}
return currentProvider;
}
}
}
#endif
|