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
|
// 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.
#ifndef __EVENTPIPE_H__
#define __EVENTPIPE_H__
#ifdef FEATURE_PERFTRACING
#include "common.h"
#include "eventpipecommontypes.h"
#include "stackcontents.h"
class CrstStatic;
class CrawlFrame;
class EventPipeConfiguration;
class EventPipeEvent;
class EventPipeEventInstance;
class EventPipeFile;
class EventPipeEventSource;
class EventPipeProvider;
class EventPipeSession;
class IpcStream;
enum class EventPipeSessionType;
enum class EventPipeSerializationFormat;
class EventPipeEventPayload;
struct EventData;
typedef uint64_t EventPipeSessionID;
enum class EventPipeState : uint32_t
{
NotInitialized,
Initialized,
ShuttingDown,
};
class EventPipe
{
// Declare friends.
friend class EventPipeConfiguration;
friend class EventPipeFile;
friend class EventPipeProvider;
public:
static const uint32_t MaxNumberOfSessions = 64;
// Initialize the event pipe.
static void Initialize();
// Shutdown the event pipe.
static void Shutdown();
// Enable tracing via the event pipe.
static EventPipeSessionID Enable(
LPCWSTR strOutputPath,
uint32_t circularBufferSizeInMB,
const EventPipeProviderConfiguration *pProviders,
uint32_t numProviders,
EventPipeSessionType sessionType,
EventPipeSerializationFormat format,
const bool rundownRequested,
IpcStream *const pStream);
// Disable tracing via the event pipe.
static void Disable(EventPipeSessionID id);
// Get the session for the specified session ID.
static EventPipeSession *GetSession(EventPipeSessionID id);
// Specifies whether or not the event pipe is enabled.
static bool Enabled()
{
LIMITED_METHOD_CONTRACT;
return (s_state.LoadWithoutBarrier() >= EventPipeState::Initialized) && (s_numberOfSessions.LoadWithoutBarrier() > 0);
}
// Create a provider.
static EventPipeProvider *CreateProvider(
const SString &providerName,
EventPipeCallback pCallbackFunction = nullptr,
void *pCallbackData = nullptr);
static EventPipeProvider *CreateProvider(const SString &providerName, EventPipeCallback pCallbackFunction, void *pCallbackData, EventPipeProviderCallbackDataQueue* pEventPipeProviderCallbackDataQueue);
// Get a provider.
static EventPipeProvider *GetProvider(const SString &providerName);
// Delete a provider.
static void DeleteProvider(EventPipeProvider *pProvider);
// Write out an event from a flat buffer.
// Data is written as a serialized blob matching the ETW serialization conventions.
static void WriteEvent(EventPipeEvent &event, BYTE *pData, unsigned int length, LPCGUID pActivityId = NULL, LPCGUID pRelatedActivityId = NULL);
// Write out an event from an EventData array.
// Data is written as a serialized blob matching the ETW serialization conventions.
static void WriteEvent(EventPipeEvent &event, EventData *pEventData, unsigned int eventDataCount, LPCGUID pActivityId = NULL, LPCGUID pRelatedActivityId = NULL);
// Write out a sample profile event.
static void WriteSampleProfileEvent(Thread *pSamplingThread, EventPipeEvent *pEvent, Thread *pTargetThread, StackContents &stackContents, BYTE *pData = NULL, unsigned int length = 0);
// Get the managed call stack for the current thread.
static bool WalkManagedStackForCurrentThread(StackContents &stackContents);
// Get the managed call stack for the specified thread.
static bool WalkManagedStackForThread(Thread *pThread, StackContents &stackContents);
// Get next event.
static EventPipeEventInstance *GetNextEvent(EventPipeSessionID sessionID);
// Get the event handle that signals when new events are available.
static HANDLE GetWaitHandle(EventPipeSessionID sessionID);
#ifdef DEBUG
static bool IsLockOwnedByCurrentThread();
#endif
template <class T>
static void RunWithCallbackPostponed(T f)
{
EventPipeProviderCallbackDataQueue eventPipeProviderCallbackDataQueue;
EventPipeProviderCallbackData eventPipeProviderCallbackData;
{
CrstHolder _crst(GetLock());
f(&eventPipeProviderCallbackDataQueue);
}
while (eventPipeProviderCallbackDataQueue.TryDequeue(&eventPipeProviderCallbackData))
InvokeCallback(eventPipeProviderCallbackData);
}
// Returns the a number 0...N representing the processor number this thread is currently
// running on. If for any reason we can't tell then return 0xFFFFFFFF.
static unsigned int GetCurrentProcessorNumber()
{
#ifndef FEATURE_PAL
if (s_pProcGroupOffsets)
{
PROCESSOR_NUMBER procNum;
GetCurrentProcessorNumberEx(&procNum);
return s_pProcGroupOffsets[procNum.Group] + procNum.Number;
}
#endif
return 0xFFFFFFFF;
}
private:
static void InvokeCallback(EventPipeProviderCallbackData eventPipeProviderCallbackData);
// Get the event used to write metadata to the event stream.
static EventPipeEventInstance *BuildEventMetadataEvent(EventPipeEventInstance &instance, unsigned int metadataId);
// The counterpart to WriteEvent which after the payload is constructed
static void WriteEventInternal(
EventPipeEvent &event,
EventPipeEventPayload &payload,
LPCGUID pActivityId = nullptr,
LPCGUID pRelatedActivityId = nullptr);
static void WriteEventInternal(
Thread *pThread,
EventPipeEvent &event,
EventPipeEventPayload &payload,
LPCGUID pActivityId,
LPCGUID pRelatedActivityId,
Thread *pEventThread = nullptr,
StackContents *pStack = nullptr);
static void DisableInternal(EventPipeSessionID id, EventPipeProviderCallbackDataQueue* pEventPipeProviderCallbackDataQueue);
// Enable the specified EventPipe session.
static bool EnableInternal(
EventPipeSession *const pSession,
EventPipeProviderCallbackDataQueue *pEventPipeProviderCallbackDataQueue);
// Callback function for the stack walker. For each frame walked, this callback is invoked.
static StackWalkAction StackWalkCallback(CrawlFrame *pCf, StackContents *pData);
//! Helper function used to locate a free index in the range 0 - EventPipe::MaxNumberOfSessions
//! Returns EventPipe::MaxNumberOfSessions if there are no free indexes
static uint32_t GenerateSessionIndex();
static bool IsSessionIdInCollection(EventPipeSessionID id);
template <typename EventPipeSessionHandlerCallback>
static void ForEachSession(EventPipeSessionHandlerCallback callback)
{
LIMITED_METHOD_CONTRACT;
_ASSERTE(IsLockOwnedByCurrentThread());
for (VolatilePtr<EventPipeSession> &session : s_pSessions)
{
// Entering EventPipe lock gave us a barrier, we don't need
// more of them
EventPipeSession *const pSession = session.LoadWithoutBarrier();
if (pSession)
callback(*pSession);
}
}
// Get the event pipe configuration lock.
static CrstStatic *GetLock()
{
LIMITED_METHOD_CONTRACT;
return &s_configCrst;
}
static CrstStatic s_configCrst;
static Volatile<EventPipeState> s_state;
static EventPipeConfiguration s_config;
static VolatilePtr<EventPipeSession> s_pSessions[MaxNumberOfSessions];
static Volatile<uint64_t> s_allowWrite;
static EventPipeEventSource *s_pEventSource;
//! Bitmask tracking EventPipe active sessions.
// in all groups preceding it. For example if there are three groups with sizes:
// 1, 7, 6 the table would be 0, 1, 8
#ifndef FEATURE_PAL
static unsigned int * s_pProcGroupOffsets;
#endif
static Volatile<uint32_t> s_numberOfSessions;
};
static_assert(EventPipe::MaxNumberOfSessions == 64, "Maximum number of EventPipe sessions is not 64.");
#endif // FEATURE_PERFTRACING
#endif // __EVENTPIPE_H__
|
