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
|
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
using System;
#if ES_BUILD_STANDALONE
namespace Microsoft.Diagnostics.Tracing
#else
namespace System.Diagnostics.Tracing
#endif
{
/// <summary>
/// TraceLogging: Used when implementing a custom TraceLoggingTypeInfo.
/// These are passed to metadataCollector.Add to specify the low-level
/// type of a field in the event payload. Note that a "formatted"
/// TraceLoggingDataType consists of a core TraceLoggingDataType value
/// (a TraceLoggingDataType with a value less than 32) plus an OutType.
/// Any combination of TraceLoggingDataType + OutType is valid, but not
/// all are useful. In particular, combinations not explicitly listed
/// below are unlikely to be recognized by decoders, and will typically
/// be decoded as the corresponding core type (i.e. the decoder will
/// mask off any unrecognized OutType value).
/// </summary>
internal enum TraceLoggingDataType
{
/// <summary>
/// Core type.
/// Data type with no value (0-length payload).
/// NOTE: arrays of Nil are illegal.
/// NOTE: a fixed-length array of Nil is interpreted by the decoder as
/// a struct (obsolete but retained for backwards-compatibility).
/// </summary>
Nil = 0,
/// <summary>
/// Core type.
/// Encoding assumes null-terminated Char16 string.
/// Decoding treats as UTF-16LE string.
/// </summary>
Utf16String = 1,
/// <summary>
/// Core type.
/// Encoding assumes null-terminated Char8 string.
/// Decoding treats as MBCS string.
/// </summary>
MbcsString = 2,
/// <summary>
/// Core type.
/// Encoding assumes 8-bit value.
/// Decoding treats as signed integer.
/// </summary>
Int8 = 3,
/// <summary>
/// Core type.
/// Encoding assumes 8-bit value.
/// Decoding treats as unsigned integer.
/// </summary>
UInt8 = 4,
/// <summary>
/// Core type.
/// Encoding assumes 16-bit value.
/// Decoding treats as signed integer.
/// </summary>
Int16 = 5,
/// <summary>
/// Core type.
/// Encoding assumes 16-bit value.
/// Decoding treats as unsigned integer.
/// </summary>
UInt16 = 6,
/// <summary>
/// Core type.
/// Encoding assumes 32-bit value.
/// Decoding treats as signed integer.
/// </summary>
Int32 = 7,
/// <summary>
/// Core type.
/// Encoding assumes 32-bit value.
/// Decoding treats as unsigned integer.
/// </summary>
UInt32 = 8,
/// <summary>
/// Core type.
/// Encoding assumes 64-bit value.
/// Decoding treats as signed integer.
/// </summary>
Int64 = 9,
/// <summary>
/// Core type.
/// Encoding assumes 64-bit value.
/// Decoding treats as unsigned integer.
/// </summary>
UInt64 = 10,
/// <summary>
/// Core type.
/// Encoding assumes 32-bit value.
/// Decoding treats as Float.
/// </summary>
Float = 11,
/// <summary>
/// Core type.
/// Encoding assumes 64-bit value.
/// Decoding treats as Double.
/// </summary>
Double = 12,
/// <summary>
/// Core type.
/// Encoding assumes 32-bit value.
/// Decoding treats as Boolean.
/// </summary>
Boolean32 = 13,
/// <summary>
/// Core type.
/// Encoding assumes 16-bit bytecount followed by binary data.
/// Decoding treats as binary data.
/// </summary>
Binary = 14,
/// <summary>
/// Core type.
/// Encoding assumes 16-byte value.
/// Decoding treats as GUID.
/// </summary>
Guid = 15,
/// <summary>
/// Core type.
/// Encoding assumes 64-bit value.
/// Decoding treats as FILETIME.
/// </summary>
FileTime = 17,
/// <summary>
/// Core type.
/// Encoding assumes 16-byte value.
/// Decoding treats as SYSTEMTIME.
/// </summary>
SystemTime = 18,
/// <summary>
/// Core type.
/// Encoding assumes 32-bit value.
/// Decoding treats as hexadecimal unsigned integer.
/// </summary>
HexInt32 = 20,
/// <summary>
/// Core type.
/// Encoding assumes 64-bit value.
/// Decoding treats as hexadecimal unsigned integer.
/// </summary>
HexInt64 = 21,
/// <summary>
/// Core type.
/// Encoding assumes 16-bit bytecount followed by Char16 data.
/// Decoding treats as UTF-16LE string.
/// </summary>
CountedUtf16String = 22,
/// <summary>
/// Core type.
/// Encoding assumes 16-bit bytecount followed by Char8 data.
/// Decoding treats as MBCS string.
/// </summary>
CountedMbcsString = 23,
/// <summary>
/// Core type.
/// Special case: Struct indicates that this field plus the the
/// subsequent N logical fields are to be considered as one logical
/// field (i.e. a nested structure). The OutType is used to encode N.
/// The maximum value for N is 127. This field has no payload by
/// itself, but logically contains the payload of the following N
/// fields. It is legal to have an array of Struct.
/// </summary>
Struct = 24,
/// <summary>
/// Formatted type.
/// Encoding assumes 16-bit value.
/// Decoding treats as UTF-16LE character.
/// </summary>
Char16 = UInt16 + (EventFieldFormat.String << 8),
/// <summary>
/// Formatted type.
/// Encoding assumes 8-bit value.
/// Decoding treats as character.
/// </summary>
Char8 = UInt8 + (EventFieldFormat.String << 8),
/// <summary>
/// Formatted type.
/// Encoding assumes 8-bit value.
/// Decoding treats as Boolean.
/// </summary>
Boolean8 = UInt8 + (EventFieldFormat.Boolean << 8),
/// <summary>
/// Formatted type.
/// Encoding assumes 8-bit value.
/// Decoding treats as hexadecimal unsigned integer.
/// </summary>
HexInt8 = UInt8 + (EventFieldFormat.Hexadecimal << 8),
/// <summary>
/// Formatted type.
/// Encoding assumes 16-bit value.
/// Decoding treats as hexadecimal unsigned integer.
/// </summary>
HexInt16 = UInt16 + (EventFieldFormat.Hexadecimal << 8),
#if false
/// <summary>
/// Formatted type.
/// Encoding assumes 32-bit value.
/// Decoding treats as process identifier.
/// </summary>
ProcessId = UInt32 + (EventSourceFieldFormat.ProcessId << 8),
/// <summary>
/// Formatted type.
/// Encoding assumes 32-bit value.
/// Decoding treats as thread identifier.
/// </summary>
ThreadId = UInt32 + (EventSourceFieldFormat.ThreadId << 8),
/// <summary>
/// Formatted type.
/// Encoding assumes 16-bit value.
/// Decoding treats as IP port.
/// </summary>
Port = UInt16 + (EventSourceFieldFormat.Port << 8),
/// <summary>
/// Formatted type.
/// Encoding assumes 32-bit value.
/// Decoding treats as IPv4 address.
/// </summary>
Ipv4Address = UInt32 + (EventSourceFieldFormat.Ipv4Address << 8),
/// <summary>
/// Formatted type.
/// Encoding assumes 16-bit bytecount followed by binary data.
/// Decoding treats as IPv6 address.
/// </summary>
Ipv6Address = Binary + (EventSourceFieldFormat.Ipv6Address << 8),
/// <summary>
/// Formatted type.
/// Encoding assumes 16-bit bytecount followed by binary data.
/// Decoding treats as SOCKADDR.
/// </summary>
SocketAddress = Binary + (EventSourceFieldFormat.SocketAddress << 8),
#endif
/// <summary>
/// Formatted type.
/// Encoding assumes null-terminated Char16 string.
/// Decoding treats as UTF-16LE XML string.
/// </summary>
Utf16Xml = Utf16String + (EventFieldFormat.Xml << 8),
/// <summary>
/// Formatted type.
/// Encoding assumes null-terminated Char8 string.
/// Decoding treats as MBCS XML string.
/// </summary>
MbcsXml = MbcsString + (EventFieldFormat.Xml << 8),
/// <summary>
/// Formatted type.
/// Encoding assumes 16-bit bytecount followed by Char16 data.
/// Decoding treats as UTF-16LE XML.
/// </summary>
CountedUtf16Xml = CountedUtf16String + (EventFieldFormat.Xml << 8),
/// <summary>
/// Formatted type.
/// Encoding assumes 16-bit bytecount followed by Char8 data.
/// Decoding treats as MBCS XML.
/// </summary>
CountedMbcsXml = CountedMbcsString + (EventFieldFormat.Xml << 8),
/// <summary>
/// Formatted type.
/// Encoding assumes null-terminated Char16 string.
/// Decoding treats as UTF-16LE JSON string.
/// </summary>
Utf16Json = Utf16String + (EventFieldFormat.Json << 8),
/// <summary>
/// Formatted type.
/// Encoding assumes null-terminated Char8 string.
/// Decoding treats as MBCS JSON string.
/// </summary>
MbcsJson = MbcsString + (EventFieldFormat.Json << 8),
/// <summary>
/// Formatted type.
/// Encoding assumes 16-bit bytecount followed by Char16 data.
/// Decoding treats as UTF-16LE JSON.
/// </summary>
CountedUtf16Json = CountedUtf16String + (EventFieldFormat.Json << 8),
/// <summary>
/// Formatted type.
/// Encoding assumes 16-bit bytecount followed by Char8 data.
/// Decoding treats as MBCS JSON.
/// </summary>
CountedMbcsJson = CountedMbcsString + (EventFieldFormat.Json << 8),
#if false
/// <summary>
/// Formatted type.
/// Encoding assumes 32-bit value.
/// Decoding treats as Win32 error.
/// </summary>
Win32Error = UInt32 + (EventSourceFieldFormat.Win32Error << 8),
/// <summary>
/// Formatted type.
/// Encoding assumes 32-bit value.
/// Decoding treats as NTSTATUS.
/// </summary>
NTStatus = UInt32 + (EventSourceFieldFormat.NTStatus << 8),
#endif
/// <summary>
/// Formatted type.
/// Encoding assumes 32-bit value.
/// Decoding treats as HRESULT.
/// </summary>
HResult = Int32 + (EventFieldFormat.HResult << 8)
}
}
|
