summaryrefslogtreecommitdiff
path: root/src/mscorlib/src/System/Diagnostics/Eventing/TraceLogging/TraceLoggingDataCollector.cs
blob: 4b8158c0d752510fef07e5463c225f7d72313aa8 (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
// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
using System;
using System.Security;

#if ES_BUILD_STANDALONE
namespace Microsoft.Diagnostics.Tracing
#else
namespace System.Diagnostics.Tracing
#endif
{
    /// <summary>
    /// TraceLogging: Used when implementing a custom TraceLoggingTypeInfo.
    /// The instance of this type is provided to the TypeInfo.WriteData method.
    /// All operations are forwarded to the current thread's DataCollector.
    /// Note that this abstraction would allow us to expose the custom
    /// serialization system to partially-trusted code. If we end up not
    /// making custom serialization public, or if we only expose it to
    /// full-trust code, this abstraction is unnecessary (though it probably
    /// doesn't hurt anything).
    /// </summary>
    [SecuritySafeCritical]
    internal unsafe class TraceLoggingDataCollector
    {
        internal static readonly TraceLoggingDataCollector Instance = new TraceLoggingDataCollector();

        private TraceLoggingDataCollector()
        {
            return;
        }

        /// <summary>
        /// Marks the start of a non-blittable array or enumerable.
        /// </summary>
        /// <returns>Bookmark to be passed to EndBufferedArray.</returns>
        public int BeginBufferedArray()
        {
            return DataCollector.ThreadInstance.BeginBufferedArray();
        }

        /// <summary>
        /// Marks the end of a non-blittable array or enumerable.
        /// </summary>
        /// <param name="bookmark">The value returned by BeginBufferedArray.</param>
        /// <param name="count">The number of items in the array.</param>
        public void EndBufferedArray(int bookmark, int count)
        {
            DataCollector.ThreadInstance.EndBufferedArray(bookmark, count);
        }

        /// <summary>
        /// Adds the start of a group to the event.
        /// This has no effect on the event payload, but is provided to allow
        /// WriteMetadata and WriteData implementations to have similar
        /// sequences of calls, allowing for easier verification of correctness.
        /// </summary>
        public TraceLoggingDataCollector AddGroup()
        {
            return this;
        }

        /// <summary>
        /// Adds a Boolean value to the event payload.
        /// </summary>
        /// <param name="value">Value to be added.</param>
        public void AddScalar(bool value)
        {
            DataCollector.ThreadInstance.AddScalar(&value, sizeof(bool));
        }

        /// <summary>
        /// Adds an SByte value to the event payload.
        /// </summary>
        /// <param name="value">Value to be added.</param>
        //[CLSCompliant(false)]
        public void AddScalar(sbyte value)
        {
            DataCollector.ThreadInstance.AddScalar(&value, sizeof(sbyte));
        }

        /// <summary>
        /// Adds a Byte value to the event payload.
        /// </summary>
        /// <param name="value">Value to be added.</param>
        public void AddScalar(byte value)
        {
            DataCollector.ThreadInstance.AddScalar(&value, sizeof(byte));
        }

        /// <summary>
        /// Adds an Int16 value to the event payload.
        /// </summary>
        /// <param name="value">Value to be added.</param>
        public void AddScalar(short value)
        {
            DataCollector.ThreadInstance.AddScalar(&value, sizeof(short));
        }

        /// <summary>
        /// Adds a UInt16 value to the event payload.
        /// </summary>
        /// <param name="value">Value to be added.</param>
        //[CLSCompliant(false)]
        public void AddScalar(ushort value)
        {
            DataCollector.ThreadInstance.AddScalar(&value, sizeof(ushort));
        }

        /// <summary>
        /// Adds an Int32 value to the event payload.
        /// </summary>
        /// <param name="value">Value to be added.</param>
        public void AddScalar(int value)
        {
            DataCollector.ThreadInstance.AddScalar(&value, sizeof(int));
        }

        /// <summary>
        /// Adds a UInt32 value to the event payload.
        /// </summary>
        /// <param name="value">Value to be added.</param>
        //[CLSCompliant(false)]
        public void AddScalar(uint value)
        {
            DataCollector.ThreadInstance.AddScalar(&value, sizeof(uint));
        }

        /// <summary>
        /// Adds an Int64 value to the event payload.
        /// </summary>
        /// <param name="value">Value to be added.</param>
        public void AddScalar(long value)
        {
            DataCollector.ThreadInstance.AddScalar(&value, sizeof(long));
        }

        /// <summary>
        /// Adds a UInt64 value to the event payload.
        /// </summary>
        /// <param name="value">Value to be added.</param>
        //[CLSCompliant(false)]
        public void AddScalar(ulong value)
        {
            DataCollector.ThreadInstance.AddScalar(&value, sizeof(ulong));
        }

        /// <summary>
        /// Adds an IntPtr value to the event payload.
        /// </summary>
        /// <param name="value">Value to be added.</param>
        public void AddScalar(IntPtr value)
        {
            DataCollector.ThreadInstance.AddScalar(&value, IntPtr.Size);
        }

        /// <summary>
        /// Adds a UIntPtr value to the event payload.
        /// </summary>
        /// <param name="value">Value to be added.</param>
        //[CLSCompliant(false)]
        public void AddScalar(UIntPtr value)
        {
            DataCollector.ThreadInstance.AddScalar(&value, UIntPtr.Size);
        }

        /// <summary>
        /// Adds a Single value to the event payload.
        /// </summary>
        /// <param name="value">Value to be added.</param>
        public void AddScalar(float value)
        {
            DataCollector.ThreadInstance.AddScalar(&value, sizeof(float));
        }

        /// <summary>
        /// Adds a Double value to the event payload.
        /// </summary>
        /// <param name="value">Value to be added.</param>
        public void AddScalar(double value)
        {
            DataCollector.ThreadInstance.AddScalar(&value, sizeof(double));
        }

        /// <summary>
        /// Adds a Char value to the event payload.
        /// </summary>
        /// <param name="value">Value to be added.</param>
        public void AddScalar(char value)
        {
            DataCollector.ThreadInstance.AddScalar(&value, sizeof(char));
        }

        /// <summary>
        /// Adds a Guid value to the event payload.
        /// </summary>
        /// <param name="value">Value to be added.</param>
        public void AddScalar(Guid value)
        {
            DataCollector.ThreadInstance.AddScalar(&value, 16);
        }

        /// <summary>
        /// Adds a counted String value to the event payload.
        /// </summary>
        /// <param name="value">
        /// Value to be added. A null value is treated as a zero-length string.
        /// </param>
        public void AddBinary(string value)
        {
            DataCollector.ThreadInstance.AddBinary(value, value == null ? 0 : value.Length * 2);
        }

        /// <summary>
        /// Adds an array of Byte values to the event payload.
        /// </summary>
        /// <param name="value">
        /// Value to be added. A null value is treated as a zero-length array.
        /// </param>
        public void AddBinary(byte[] value)
        {
            DataCollector.ThreadInstance.AddBinary(value, value == null ? 0 : value.Length);
        }

        /// <summary>
        /// Adds an array of Boolean values to the event payload.
        /// </summary>
        /// <param name="value">
        /// Value to be added. A null value is treated as a zero-length array.
        /// </param>
        public void AddArray(bool[] value)
        {
            DataCollector.ThreadInstance.AddArray(value, value == null ? 0 : value.Length, sizeof(bool));
        }

        /// <summary>
        /// Adds an array of SByte values to the event payload.
        /// </summary>
        /// <param name="value">
        /// Value to be added. A null value is treated as a zero-length array.
        /// </param>
        //[CLSCompliant(false)]
        public void AddArray(sbyte[] value)
        {
            DataCollector.ThreadInstance.AddArray(value, value == null ? 0 : value.Length, sizeof(sbyte));
        }

        /// <summary>
        /// Adds an array of Int16 values to the event payload.
        /// </summary>
        /// <param name="value">
        /// Value to be added. A null value is treated as a zero-length array.
        /// </param>
        public void AddArray(short[] value)
        {
            DataCollector.ThreadInstance.AddArray(value, value == null ? 0 : value.Length, sizeof(short));
        }

        /// <summary>
        /// Adds an array of UInt16 values to the event payload.
        /// </summary>
        /// <param name="value">
        /// Value to be added. A null value is treated as a zero-length array.
        /// </param>
        //[CLSCompliant(false)]
        public void AddArray(ushort[] value)
        {
            DataCollector.ThreadInstance.AddArray(value, value == null ? 0 : value.Length, sizeof(ushort));
        }

        /// <summary>
        /// Adds an array of Int32 values to the event payload.
        /// </summary>
        /// <param name="value">
        /// Value to be added. A null value is treated as a zero-length array.
        /// </param>
        public void AddArray(int[] value)
        {
            DataCollector.ThreadInstance.AddArray(value, value == null ? 0 : value.Length, sizeof(int));
        }

        /// <summary>
        /// Adds an array of UInt32 values to the event payload.
        /// </summary>
        /// <param name="value">
        /// Value to be added. A null value is treated as a zero-length array.
        /// </param>
        //[CLSCompliant(false)]
        public void AddArray(uint[] value)
        {
            DataCollector.ThreadInstance.AddArray(value, value == null ? 0 : value.Length, sizeof(uint));
        }

        /// <summary>
        /// Adds an array of Int64 values to the event payload.
        /// </summary>
        /// <param name="value">
        /// Value to be added. A null value is treated as a zero-length array.
        /// </param>
        public void AddArray(long[] value)
        {
            DataCollector.ThreadInstance.AddArray(value, value == null ? 0 : value.Length, sizeof(long));
        }

        /// <summary>
        /// Adds an array of UInt64 values to the event payload.
        /// </summary>
        /// <param name="value">
        /// Value to be added. A null value is treated as a zero-length array.
        /// </param>
        //[CLSCompliant(false)]
        public void AddArray(ulong[] value)
        {
            DataCollector.ThreadInstance.AddArray(value, value == null ? 0 : value.Length, sizeof(ulong));
        }

        /// <summary>
        /// Adds an array of IntPtr values to the event payload.
        /// </summary>
        /// <param name="value">
        /// Value to be added. A null value is treated as a zero-length array.
        /// </param>
        public void AddArray(IntPtr[] value)
        {
            DataCollector.ThreadInstance.AddArray(value, value == null ? 0 : value.Length, IntPtr.Size);
        }

        /// <summary>
        /// Adds an array of UIntPtr values to the event payload.
        /// </summary>
        /// <param name="value">
        /// Value to be added. A null value is treated as a zero-length array.
        /// </param>
        //[CLSCompliant(false)]
        public void AddArray(UIntPtr[] value)
        {
            DataCollector.ThreadInstance.AddArray(value, value == null ? 0 : value.Length, UIntPtr.Size);
        }

        /// <summary>
        /// Adds an array of Single values to the event payload.
        /// </summary>
        /// <param name="value">
        /// Value to be added. A null value is treated as a zero-length array.
        /// </param>
        public void AddArray(float[] value)
        {
            DataCollector.ThreadInstance.AddArray(value, value == null ? 0 : value.Length, sizeof(float));
        }

        /// <summary>
        /// Adds an array of Double values to the event payload.
        /// </summary>
        /// <param name="value">
        /// Value to be added. A null value is treated as a zero-length array.
        /// </param>
        public void AddArray(double[] value)
        {
            DataCollector.ThreadInstance.AddArray(value, value == null ? 0 : value.Length, sizeof(double));
        }

        /// <summary>
        /// Adds an array of Char values to the event payload.
        /// </summary>
        /// <param name="value">
        /// Value to be added. A null value is treated as a zero-length array.
        /// </param>
        public void AddArray(char[] value)
        {
            DataCollector.ThreadInstance.AddArray(value, value == null ? 0 : value.Length, sizeof(char));
        }

        /// <summary>
        /// Adds an array of Guid values to the event payload.
        /// </summary>
        /// <param name="value">
        /// Value to be added. A null value is treated as a zero-length array.
        /// </param>
        public void AddArray(Guid[] value)
        {
            DataCollector.ThreadInstance.AddArray(value, value == null ? 0 : value.Length, 16);
        }

        /// <summary>
        /// Adds an array of Byte values to the event payload.
        /// </summary>
        /// <param name="value">
        /// Value to be added. A null value is treated as a zero-length array.
        /// </param>
        public void AddCustom(byte[] value)
        {
            DataCollector.ThreadInstance.AddArray(value, value == null ? 0 : value.Length, sizeof(byte));
        }
    }
}