summaryrefslogtreecommitdiff
path: root/tests/src/GC/Performance/Framework/Metrics/GCMetrics.cs
blob: fdaa916e18a18db9c7abe9a28b4da0f7dbebe8c3 (plain)
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
// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.

#if WINDOWS

using System.Linq;
using Microsoft.Xunit.Performance.Sdk;
using Microsoft.Diagnostics.Tracing.Parsers.Clr;

/// <summary>
/// This file contains a number of GC-related metrics that are provided to xunit-performance.
/// Each one of these derives from GCMetric, which manages the creation of the GC object model
/// from an ETL trace - these classes are only responsible for using it to produce a meaningful
/// metric.
/// 
/// Each one of these metrics should be fairly self-explanatory.
/// </summary>
namespace GCPerfTestFramework.Metrics
{
    #region Maximum Pause Duration
    internal class GCMaxPauseMetric : GCMetric
    {
        public GCMaxPauseMetric()
            : base("GCMaxPause", "Maximum GC Pause Duraction", PerformanceMetricUnits.Milliseconds)
        {

        }

        public override PerformanceMetricEvaluator CreateEvaluator(PerformanceMetricEvaluationContext context)
        {
            return new GCMaxPauseEvaluator(context);
        }
    }

    internal class GCMaxPauseEvaluator : GCEvaluator
    {
        public GCMaxPauseEvaluator(PerformanceMetricEvaluationContext context)
            : base(context)
        {

        }

        protected override double YieldMetric()
        {
            return ProcessInfo.Total.MaxPauseDurationMSec;
        }
    }
    #endregion

    #region Mean Pause Duration
    internal class GCMeanPauseMetric : GCMetric
    {
        public GCMeanPauseMetric()
            : base("GCMeanPause", "Mean GC Pause Duraction", PerformanceMetricUnits.Milliseconds)
        {

        }

        public override PerformanceMetricEvaluator CreateEvaluator(PerformanceMetricEvaluationContext context)
        {
            return new GCMeanPauseEvaluator(context);
        }
    }

    internal class GCMeanPauseEvaluator : GCEvaluator
    {
        public GCMeanPauseEvaluator(PerformanceMetricEvaluationContext context)
            : base(context)
        {

        }

        protected override double YieldMetric()
        {
            return ProcessInfo.Total.MeanPauseDurationMSec;
        }
    }
    #endregion

    #region Peak Virtual Memory Size
    internal class GCPeakVirtualMemoryMetric : GCMetric
    {
        public GCPeakVirtualMemoryMetric()
            : base("GCPeakVirtualMemory", "Process Peak Virtual Memory", PerformanceMetricUnits.Bytes)
        {

        }

        public override PerformanceMetricEvaluator CreateEvaluator(PerformanceMetricEvaluationContext context)
        {
            return new GCPeakVirtualMemoryMetricEvaluator(context);
        }
    }

    internal class GCPeakVirtualMemoryMetricEvaluator : GCEvaluator
    {
        public GCPeakVirtualMemoryMetricEvaluator(PerformanceMetricEvaluationContext context)
            : base(context)
        {

        }

        protected override double YieldMetric()
        {
            return ProcessInfo.PeakVirtualMB * GCMetric.BytesInMegabyte;
        }
    }
    #endregion

    #region Peak Working Set Size
    internal class GCPeakWorkingSetMetric : GCMetric
    {
        public GCPeakWorkingSetMetric()
            : base("GCPeakWorkingSet", "Process Peak Working Set", PerformanceMetricUnits.Bytes)
        {

        }

        public override PerformanceMetricEvaluator CreateEvaluator(PerformanceMetricEvaluationContext context)
        {
            return new GCPeakWorkingSetMetricEvaluator(context);
        }
    }

    internal class GCPeakWorkingSetMetricEvaluator : GCEvaluator
    {
        public GCPeakWorkingSetMetricEvaluator(PerformanceMetricEvaluationContext context)
            : base(context)
        {

        }

        protected override double YieldMetric()
        {
            return ProcessInfo.PeakWorkingSetMB * GCMetric.BytesInMegabyte;
        }
    }
    #endregion

    #region Total Pause Time
    internal class GCTotalPauseTimeMetric : GCMetric
    {
        public GCTotalPauseTimeMetric()
            : base("GCTotalPauseTime", "Total time spent paused due to GC activity", PerformanceMetricUnits.Milliseconds)
        {

        }

        public override PerformanceMetricEvaluator CreateEvaluator(PerformanceMetricEvaluationContext context)
        {
            return new GCTotalPauseTimeMetricEvaluator(context);
        }
    }

    internal class GCTotalPauseTimeMetricEvaluator : GCEvaluator
    {
        public GCTotalPauseTimeMetricEvaluator(PerformanceMetricEvaluationContext context)
            : base(context)
        {

        }

        protected override double YieldMetric()
        {
            return ProcessInfo.Total.TotalPauseTimeMSec;
        }
    }
    #endregion

    #region CPU time in GC
    internal class GCCpuTimeInGCMetric : GCMetric
    {
        public GCCpuTimeInGCMetric()
            : base("GCCpuTimeInGC", "Total CPU time spent in GC activity", PerformanceMetricUnits.Milliseconds)
        {

        }

        public override PerformanceMetricEvaluator CreateEvaluator(PerformanceMetricEvaluationContext context)
        {
            return new GCCpuTimeInGCMetricEvaluator(context);
        }
    }

    internal class GCCpuTimeInGCMetricEvaluator : GCEvaluator
    {
        public GCCpuTimeInGCMetricEvaluator(PerformanceMetricEvaluationContext context)
            : base(context)
        {

        }

        protected override double YieldMetric()
        {
            return ProcessInfo.Total.TotalGCCpuMSec;
        }
    }
    #endregion

    #region Generation Zero Mean Pause Duration
    internal class GCGenZeroMeanPauseDuration : GCMetric
    {
        public GCGenZeroMeanPauseDuration()
            : base("GCGenZeroMeanPauseDuration", "Mean pause duration for Gen0 collections", PerformanceMetricUnits.Count)
        {

        }

        public override PerformanceMetricEvaluator CreateEvaluator(PerformanceMetricEvaluationContext context)
        {
            return new GCGenZeroMeanPauseDurationEvaluator(context);
        }
    }

    internal class GCGenZeroMeanPauseDurationEvaluator : GCEvaluator
    {
        public GCGenZeroMeanPauseDurationEvaluator(PerformanceMetricEvaluationContext context)
            : base(context)
        {

        }

        protected override double YieldMetric()
        {
            return ProcessInfo.Generations[0].MeanPauseDurationMSec;
        }
    }
    #endregion

    #region Generation One Mean Pause Duration
    internal class GCGenOneMeanPauseDuration : GCMetric
    {
        public GCGenOneMeanPauseDuration()
            : base("GCGenOneMeanPauseDuration", "Mean pause duration for Gen1 collections", PerformanceMetricUnits.Count)
        {

        }

        public override PerformanceMetricEvaluator CreateEvaluator(PerformanceMetricEvaluationContext context)
        {
            return new GCGenOneMeanPauseDurationEvaluator(context);
        }
    }

    internal class GCGenOneMeanPauseDurationEvaluator : GCEvaluator
    {
        public GCGenOneMeanPauseDurationEvaluator(PerformanceMetricEvaluationContext context)
            : base(context)
        {

        }

        protected override double YieldMetric()
        {
            return ProcessInfo.Generations[0].MeanPauseDurationMSec;
        }
    }
    #endregion

    #region Generation Two Mean Pause Duration
    internal class GCGenTwoMeanPauseDuration : GCMetric
    {
        public GCGenTwoMeanPauseDuration()
            : base("GCGenTwoMeanPauseDuration", "Mean pause duration for Gen2 collections", PerformanceMetricUnits.Count)
        {

        }

        public override PerformanceMetricEvaluator CreateEvaluator(PerformanceMetricEvaluationContext context)
        {
            return new GCGenTwoMeanPauseDurationEvaluator(context);
        }
    }

    internal class GCGenTwoMeanPauseDurationEvaluator : GCEvaluator
    {
        public GCGenTwoMeanPauseDurationEvaluator(PerformanceMetricEvaluationContext context)
            : base(context)
        {

        }

        protected override double YieldMetric()
        {
            return ProcessInfo.Generations[2].MeanPauseDurationMSec;
        }
    }
    #endregion

    #region Generation Zero GC Count
    internal class GCGenZeroCount : GCMetric
    {
        public GCGenZeroCount()
            : base("GCGenZeroCount", "Number of Generation 0 GCs", PerformanceMetricUnits.Count)
        {

        }

        public override PerformanceMetricEvaluator CreateEvaluator(PerformanceMetricEvaluationContext context)
        {
            return new GCGenZeroCountEvaluator(context);
        }
    }

    internal class GCGenZeroCountEvaluator : GCEvaluator
    {
        public GCGenZeroCountEvaluator(PerformanceMetricEvaluationContext context)
            : base(context)
        {

        }

        protected override double YieldMetric()
        {
            return ProcessInfo.Generations[0].GCCount;
        }
    }
    #endregion

    #region Generation One GC Count
    internal class GCGenOneCount : GCMetric
    {
        public GCGenOneCount()
            : base("GCGenOneCount", "Number of Generation 1 GCs", PerformanceMetricUnits.Count)
        {

        }

        public override PerformanceMetricEvaluator CreateEvaluator(PerformanceMetricEvaluationContext context)
        {
            return new GCGenOneCountEvaluator(context);
        }
    }

    internal class GCGenOneCountEvaluator : GCEvaluator
    {
        public GCGenOneCountEvaluator(PerformanceMetricEvaluationContext context)
            : base(context)
        {

        }

        protected override double YieldMetric()
        {
            return ProcessInfo.Generations[1].GCCount;
        }
    }
    #endregion

    #region Generation 2 Background GC Count
    internal class GCGenTwoBGCCount : GCMetric
    {
        public GCGenTwoBGCCount()
            : base("GCGenTwoBGCCount", "Number of Generation 2 background GCs", PerformanceMetricUnits.Count)
        {

        }

        public override PerformanceMetricEvaluator CreateEvaluator(PerformanceMetricEvaluationContext context)
        {
            return new GCGenTwoBGCCountEvaluator(context);
        }
    }

    internal class GCGenTwoBGCCountEvaluator : GCEvaluator
    {
        public GCGenTwoBGCCountEvaluator(PerformanceMetricEvaluationContext context)
            : base(context)
        {

        }

        protected override double YieldMetric()
        {
            return ProcessInfo.Events.Count(e => e.Generation == 2 && e.Type == GCType.BackgroundGC);
        }
    }
    #endregion

    #region Generation 2 Blocking GC Count
    internal class GCGenTwoGCCount : GCMetric
    {
        public GCGenTwoGCCount()
            : base("GCGenTwoGCCount", "Number of Generation 2 blocking GCs", PerformanceMetricUnits.Count)
        {

        }

        public override PerformanceMetricEvaluator CreateEvaluator(PerformanceMetricEvaluationContext context)
        {
            return new GCGenTwoGCCountEvaluator(context);
        }
    }

    internal class GCGenTwoGCCountEvaluator : GCEvaluator
    {
        public GCGenTwoGCCountEvaluator(PerformanceMetricEvaluationContext context)
            : base(context)
        {

        }

        protected override double YieldMetric()
        {
            return ProcessInfo.Events.Count(e => e.Generation == 2 && e.Type == GCType.NonConcurrentGC);
        }
    }
    #endregion
}

#endif