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
|
// 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.
#include "common.h"
#include "eventpipebuffer.h"
#include "eventpipeblock.h"
#include "eventpipeconfiguration.h"
#include "eventpipefile.h"
#include "sampleprofiler.h"
#ifdef FEATURE_PERFTRACING
EventPipeFile::EventPipeFile(
SString &outputFilePath
#ifdef _DEBUG
,
bool lockOnWrite
#endif // _DEBUG
)
{
CONTRACTL
{
THROWS;
GC_TRIGGERS;
MODE_ANY;
}
CONTRACTL_END;
SetObjectVersion(3);
SetMinReaderVersion(0);
m_pBlock = new EventPipeBlock(100 * 1024);
#ifdef _DEBUG
m_lockOnWrite = lockOnWrite;
#endif // _DEBUG
// File start time information.
GetSystemTime(&m_fileOpenSystemTime);
QueryPerformanceCounter(&m_fileOpenTimeStamp);
QueryPerformanceFrequency(&m_timeStampFrequency);
m_pointerSize = TARGET_POINTER_SIZE;
m_currentProcessId = GetCurrentProcessId();
SYSTEM_INFO sysinfo = {};
GetSystemInfo(&sysinfo);
m_numberOfProcessors = sysinfo.dwNumberOfProcessors;
m_samplingRateInNs = SampleProfiler::GetSamplingRate();
// Create the file stream and write the header.
m_pSerializer = new FastSerializer(outputFilePath);
m_serializationLock.Init(LOCK_TYPE_DEFAULT);
m_pMetadataIds = new MapSHashWithRemove<EventPipeEvent*, unsigned int>();
// Start and 0 - The value is always incremented prior to use, so the first ID will be 1.
m_metadataIdCounter = 0;
// Write the first object to the file.
m_pSerializer->WriteObject(this);
}
EventPipeFile::~EventPipeFile()
{
CONTRACTL
{
NOTHROW;
GC_TRIGGERS;
MODE_ANY;
}
CONTRACTL_END;
if (m_pBlock != NULL && m_pSerializer != NULL)
{
WriteEnd();
}
if (m_pBlock != NULL)
{
delete(m_pBlock);
m_pBlock = NULL;
}
if(m_pSerializer != NULL)
{
delete(m_pSerializer);
m_pSerializer = NULL;
}
}
void EventPipeFile::WriteEvent(EventPipeEventInstance &instance)
{
CONTRACTL
{
THROWS;
GC_NOTRIGGER;
MODE_ANY;
}
CONTRACTL_END;
// Check to see if we've seen this event type before.
// If not, then write the event metadata to the event stream first.
unsigned int metadataId = GetMetadataId(*instance.GetEvent());
if(metadataId == 0)
{
metadataId = GenerateMetadataId();
EventPipeEventInstance* pMetadataInstance = EventPipe::GetConfiguration()->BuildEventMetadataEvent(instance, metadataId);
WriteToBlock(*pMetadataInstance, 0); // 0 breaks recursion and represents the metadata event.
SaveMetadataId(*instance.GetEvent(), metadataId);
delete[] (pMetadataInstance->GetData());
delete (pMetadataInstance);
}
WriteToBlock(instance, metadataId);
}
void EventPipeFile::WriteEnd()
{
CONTRACTL
{
NOTHROW;
GC_NOTRIGGER;
MODE_ANY;
}
CONTRACTL_END;
m_pSerializer->WriteObject(m_pBlock); // we write current block to the disk, whether it's full or not
m_pBlock->Clear();
// "After the last EventBlock is emitted, the stream is ended by emitting a NullReference Tag which indicates that there are no more objects in the stream to read."
// see https://github.com/Microsoft/perfview/blob/master/src/TraceEvent/EventPipe/EventPipeFormat.md for more
m_pSerializer->WriteTag(FastSerializerTags::NullReference);
}
void EventPipeFile::WriteToBlock(EventPipeEventInstance &instance, unsigned int metadataId)
{
CONTRACTL
{
THROWS;
GC_NOTRIGGER;
MODE_ANY;
}
CONTRACTL_END;
instance.SetMetadataId(metadataId);
if (m_pBlock->WriteEvent(instance))
{
return; // the block is not full, we added the event and continue
}
#ifdef _DEBUG
if (m_lockOnWrite)
{
// Take the serialization lock.
// This is used for synchronous file writes.
// The circular buffer path only writes from one thread.
SpinLockHolder _slh(&m_serializationLock);
}
#endif // _DEBUG
// we can't write this event to the current block (it's full)
// so we write what we have in the block to the serializer
m_pSerializer->WriteObject(m_pBlock);
m_pBlock->Clear();
bool result = m_pBlock->WriteEvent(instance);
_ASSERTE(result == true); // we should never fail to add event to a clear block (if we do the max size is too small)
}
unsigned int EventPipeFile::GenerateMetadataId()
{
CONTRACTL
{
NOTHROW;
GC_NOTRIGGER;
MODE_ANY;
}
CONTRACTL_END;
// PAL does not support 32 bit InterlockedIncrement, so we are using the LONG version and cast to int
// https://github.com/dotnet/coreclr/blob/master/src/pal/inc/pal.h#L4159
// it's ok because the metadataId will never be bigger than 32 bit
return (unsigned int)InterlockedIncrement(&m_metadataIdCounter);
}
unsigned int EventPipeFile::GetMetadataId(EventPipeEvent &event)
{
CONTRACTL
{
NOTHROW;
GC_NOTRIGGER;
MODE_ANY;
}
CONTRACTL_END;
unsigned int metadataId;
if(m_pMetadataIds->Lookup(&event, &metadataId))
{
_ASSERTE(metadataId != 0);
return metadataId;
}
return 0;
}
void EventPipeFile::SaveMetadataId(EventPipeEvent &event, unsigned int metadataId)
{
CONTRACTL
{
THROWS;
GC_NOTRIGGER;
MODE_ANY;
PRECONDITION(metadataId > 0);
}
CONTRACTL_END;
// If a pre-existing metadata label exists, remove it.
unsigned int oldId;
if(m_pMetadataIds->Lookup(&event, &oldId))
{
m_pMetadataIds->Remove(&event);
}
// Add the metadata label.
m_pMetadataIds->Add(&event, metadataId);
}
#endif // FEATURE_PERFTRACING
|
