From 711e612d04f3f8290b9febebdad5b679c9586de9 Mon Sep 17 00:00:00 2001 From: John Salem Date: Tue, 15 Jun 2021 16:23:46 -0700 Subject: [PATCH] [release/3.1] Handle Counter Polling Interval of 0 (#28180) * Backport dotnet/runtime#53836 * Fix test build * update test --- .../Diagnostics/Tracing/CounterGroup.cs | 7 +- tests/src/tracing/eventcounter/gh53564.cs | 109 ++++++++++++++++++ tests/src/tracing/eventcounter/gh53564.csproj | 31 +++++ 3 files changed, 143 insertions(+), 4 deletions(-) create mode 100644 tests/src/tracing/eventcounter/gh53564.cs create mode 100644 tests/src/tracing/eventcounter/gh53564.csproj diff --git a/src/System.Private.CoreLib/shared/System/Diagnostics/Tracing/CounterGroup.cs b/src/System.Private.CoreLib/shared/System/Diagnostics/Tracing/CounterGroup.cs index bbfba16a7f2c..908a59f1f21b 100644 --- a/src/System.Private.CoreLib/shared/System/Diagnostics/Tracing/CounterGroup.cs +++ b/src/System.Private.CoreLib/shared/System/Diagnostics/Tracing/CounterGroup.cs @@ -240,10 +240,9 @@ private void OnTimer() lock (s_counterGroupLock) { _timeStampSinceCollectionStarted = now; - do - { - _nextPollingTimeStamp += new TimeSpan(0, 0, 0, 0, _pollingIntervalInMilliseconds); - } while (_nextPollingTimeStamp <= now); + TimeSpan delta = now - _nextPollingTimeStamp; + if (delta > TimeSpan.Zero && _pollingIntervalInMilliseconds > 0) + _nextPollingTimeStamp += TimeSpan.FromMilliseconds(_pollingIntervalInMilliseconds * Math.Ceiling(delta.TotalMilliseconds / _pollingIntervalInMilliseconds)); } } } diff --git a/tests/src/tracing/eventcounter/gh53564.cs b/tests/src/tracing/eventcounter/gh53564.cs new file mode 100644 index 000000000000..4b2b5907abbe --- /dev/null +++ b/tests/src/tracing/eventcounter/gh53564.cs @@ -0,0 +1,109 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +#if USE_MDT_EVENTSOURCE +using Microsoft.Diagnostics.Tracing; +#else +using System.Diagnostics.Tracing; +#endif +using System; +using System.Collections.Generic; +using System.Threading; +using System.Threading.Tasks; +using System.Diagnostics; + +namespace gh53564Tests +{ + public class RuntimeCounterListener : EventListener + { + public RuntimeCounterListener(){} + + private DateTime? setToZeroTimestamp = null; + private DateTime? mostRecentTimestamp = null; + private ManualResetEvent setToZero = new ManualResetEvent(initialState: false); + public ManualResetEvent ReadyToVerify { get; } = new ManualResetEvent(initialState: false); + + protected override void OnEventSourceCreated(EventSource source) + { + if (source.Name.Equals("System.Runtime")) + { + Dictionary refreshInterval = new Dictionary(); + + Console.WriteLine($"[{DateTime.UtcNow:hh:mm:ss.fff}] OnEventSourceCreated :: Setting interval to 1"); + // first set interval to 1 seconds + refreshInterval["EventCounterIntervalSec"] = "1"; + EnableEvents(source, EventLevel.Informational, (EventKeywords)(-1), refreshInterval); + + // wait a moment to get some events + Thread.Sleep(TimeSpan.FromSeconds(3)); + + // then set interval to 0 + Console.WriteLine($"[{DateTime.UtcNow:hh:mm:ss.fff}] OnEventSourceCreated :: Setting interval to 0"); + refreshInterval["EventCounterIntervalSec"] = "0"; + EnableEvents(source, EventLevel.Informational, (EventKeywords)(-1), refreshInterval); + setToZeroTimestamp = DateTime.UtcNow + TimeSpan.FromSeconds(1); // Stash timestamp 1 second after setting to 0 + setToZero.Set(); + + // then attempt to set interval back to 1 + Thread.Sleep(TimeSpan.FromSeconds(3)); + Console.WriteLine($"[{DateTime.UtcNow:hh:mm:ss.fff}] OnEventSourceCreated :: Setting interval to 1"); + refreshInterval["EventCounterIntervalSec"] = "1"; + EnableEvents(source, EventLevel.Informational, (EventKeywords)(-1), refreshInterval); + } + } + + protected override void OnEventWritten(EventWrittenEventArgs eventData) + { + if (!ReadyToVerify.WaitOne(0)) + { + mostRecentTimestamp = eventData.TimeStamp; + if (setToZero.WaitOne(0) && mostRecentTimestamp > setToZeroTimestamp) + { + Console.WriteLine($"[{DateTime.UtcNow:hh:mm:ss.fff}] OnEventWritten :: Setting ReadyToVerify"); + ReadyToVerify.Set(); + } + } + } + + public bool Verify() + { + if (!ReadyToVerify.WaitOne(0)) + return false; + + Console.WriteLine($"[{DateTime.UtcNow:hh:mm:ss.fff}] Verify :: Verifying"); + Console.WriteLine($"[{DateTime.UtcNow:hh:mm:ss.fff}] setToZeroTimestamp = {setToZeroTimestamp?.ToString("hh:mm:ss.fff") ?? "NULL"}"); + Console.WriteLine($"[{DateTime.UtcNow:hh:mm:ss.fff}] mostRecentTimestamp = {mostRecentTimestamp?.ToString("hh:mm:ss.fff") ?? "NULL"}"); + + return (setToZeroTimestamp is null || mostRecentTimestamp is null) ? false : setToZeroTimestamp < mostRecentTimestamp; + } + } + + public partial class TestRuntimeEventCounter + { + public static int Main(string[] args) + { + // Create an EventListener. + using (RuntimeCounterListener myListener = new RuntimeCounterListener()) + { + if (myListener.ReadyToVerify.WaitOne(TimeSpan.FromSeconds(30))) + { + if (myListener.Verify()) + { + Console.WriteLine("Test passed"); + return 100; + } + else + { + Console.WriteLine($"Test Failed - did not see one or more of the expected runtime counters."); + return 1; + } + } + else + { + Console.WriteLine("Test Failed - timed out waiting for reset"); + return 1; + } + } + } + } +} diff --git a/tests/src/tracing/eventcounter/gh53564.csproj b/tests/src/tracing/eventcounter/gh53564.csproj new file mode 100644 index 000000000000..ff0986cd788f --- /dev/null +++ b/tests/src/tracing/eventcounter/gh53564.csproj @@ -0,0 +1,31 @@ + + + + + Debug + AnyCPU + 2.0 + {8E3244CB-407F-4142-BAAB-E7A55901A5FA} + Exe + {786C830F-07A1-408B-BD7F-6EE04809D6DB};{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC} + ..\..\ + BuildAndRun + $(DefineConstants);STATIC + true + 0 + true + + true + + + + + + + + + + + + +