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
|
// 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 "fastserializer.h"
#include "eventpipefile.h"
#include "eventpipeprotocolhelper.h"
#include "eventpipesession.h"
#include "diagnosticsipc.h"
#include "diagnosticsprotocol.h"
#ifdef FEATURE_PERFTRACING
static bool IsNullOrWhiteSpace(LPCWSTR value)
{
if (value == nullptr)
return true;
while (*value)
{
if (!iswspace(*value))
return false;
++value;
}
return true;
}
static bool TryParseCircularBufferSize(uint8_t*& bufferCursor, uint32_t& bufferLen, uint32_t& circularBufferSizeInMB)
{
const bool CanParse = TryParse(bufferCursor, bufferLen, circularBufferSizeInMB);
return CanParse && (circularBufferSizeInMB > 0);
}
static bool TryParseSerializationFormat(uint8_t*& bufferCursor, uint32_t& bufferLen, EventPipeSerializationFormat& serializationFormat)
{
const bool CanParse = TryParse(bufferCursor, bufferLen, (uint32_t&)serializationFormat);
return CanParse && (0 <= (int)serializationFormat) && ((int)serializationFormat < (int)EventPipeSerializationFormat::Count);
}
const EventPipeCollectTracingCommandPayload* EventPipeCollectTracingCommandPayload::TryParse(BYTE* lpBuffer, uint16_t& BufferSize)
{
CONTRACTL
{
NOTHROW;
GC_TRIGGERS;
MODE_PREEMPTIVE;
PRECONDITION(lpBuffer != nullptr);
}
CONTRACTL_END;
EventPipeCollectTracingCommandPayload *payload = new (nothrow) EventPipeCollectTracingCommandPayload;
if (payload == nullptr)
{
// OOM
return nullptr;
}
payload->incomingBuffer = lpBuffer;
uint8_t* pBufferCursor = payload->incomingBuffer;
uint32_t bufferLen = BufferSize;
if (!TryParseCircularBufferSize(pBufferCursor, bufferLen, payload->circularBufferSizeInMB) ||
!TryParseSerializationFormat(pBufferCursor, bufferLen, payload->serializationFormat) ||
!EventPipeProtocolHelper::TryParseProviderConfiguration(pBufferCursor, bufferLen, payload->providerConfigs))
{
delete payload;
return nullptr;
}
return payload;
}
void EventPipeProtocolHelper::HandleIpcMessage(DiagnosticsIpc::IpcMessage& message, IpcStream* pStream)
{
CONTRACTL
{
THROWS;
GC_TRIGGERS;
MODE_ANY;
PRECONDITION(pStream != nullptr);
}
CONTRACTL_END;
switch ((EventPipeCommandId)message.GetHeader().CommandId)
{
case EventPipeCommandId::CollectTracing:
EventPipeProtocolHelper::CollectTracing(message, pStream);
break;
case EventPipeCommandId::StopTracing:
EventPipeProtocolHelper::StopTracing(message, pStream);
break;
default:
STRESS_LOG1(LF_DIAGNOSTICS_PORT, LL_WARNING, "Received unknown request type (%d)\n", message.GetHeader().CommandSet);
DiagnosticsIpc::IpcMessage::SendErrorMessage(pStream, CORDIAGIPC_E_UNKNOWN_COMMAND);
delete pStream;
break;
}
}
bool EventPipeProtocolHelper::TryParseProviderConfiguration(uint8_t *&bufferCursor, uint32_t &bufferLen, CQuickArray<EventPipeProviderConfiguration> &result)
{
// Picking an arbitrary upper bound,
// This should be larger than any reasonable client request.
const uint32_t MaxCountConfigs = 1000; // TODO: This might be too large.
uint32_t countConfigs = 0;
if (!TryParse(bufferCursor, bufferLen, countConfigs))
return false;
if (countConfigs > MaxCountConfigs)
return false;
EventPipeProviderConfiguration *pConfigs = result.AllocNoThrow(countConfigs);
if (pConfigs == nullptr)
return false;
for (uint32_t i = 0; i < countConfigs; i++)
{
uint64_t keywords = 0;
if (!TryParse(bufferCursor, bufferLen, keywords))
return false;
uint32_t logLevel = 0;
if (!TryParse(bufferCursor, bufferLen, logLevel))
return false;
if (logLevel > 5) // (logLevel > EventPipeEventLevel::Verbose)
return false;
LPCWSTR pProviderName = nullptr;
if (!TryParseString(bufferCursor, bufferLen, pProviderName))
return false;
if (IsNullOrWhiteSpace(pProviderName))
return false;
LPCWSTR pFilterData = nullptr; // This parameter is optional.
TryParseString(bufferCursor, bufferLen, pFilterData);
pConfigs[i] = EventPipeProviderConfiguration(pProviderName, keywords, logLevel, pFilterData);
}
return (countConfigs > 0);
}
void EventPipeProtocolHelper::StopTracing(DiagnosticsIpc::IpcMessage& message, IpcStream *pStream)
{
CONTRACTL
{
THROWS;
GC_TRIGGERS;
MODE_PREEMPTIVE;
PRECONDITION(pStream != nullptr);
}
CONTRACTL_END;
NewHolder<const EventPipeStopTracingCommandPayload> payload = message.TryParsePayload<EventPipeStopTracingCommandPayload>();
if (payload == nullptr)
{
DiagnosticsIpc::IpcMessage::SendErrorMessage(pStream, CORDIAGIPC_E_BAD_ENCODING);
delete pStream;
return;
}
EventPipe::Disable(payload->sessionId);
DiagnosticsIpc::IpcMessage stopTracingResponse;
if (stopTracingResponse.Initialize(DiagnosticsIpc::GenericSuccessHeader, payload->sessionId))
stopTracingResponse.Send(pStream);
bool fSuccess = pStream->Flush();
if (!fSuccess)
{
// TODO: Add error handling.
}
delete pStream;
}
void EventPipeProtocolHelper::CollectTracing(DiagnosticsIpc::IpcMessage& message, IpcStream *pStream)
{
CONTRACTL
{
THROWS;
GC_TRIGGERS;
MODE_PREEMPTIVE;
PRECONDITION(pStream != nullptr);
}
CONTRACTL_END;
const EventPipeCollectTracingCommandPayload* payload = message.TryParsePayload<EventPipeCollectTracingCommandPayload>();
if (payload == nullptr)
{
DiagnosticsIpc::IpcMessage::SendErrorMessage(pStream, CORDIAGIPC_E_BAD_ENCODING);
delete payload;
delete pStream;
return;
}
auto sessionId = EventPipe::Enable(
nullptr, // strOutputPath (ignored in this scenario)
payload->circularBufferSizeInMB, // circularBufferSizeInMB
payload->providerConfigs.Ptr(), // pConfigs
static_cast<uint32_t>(payload->providerConfigs.Size()), // numConfigs
EventPipeSessionType::IpcStream, // EventPipeSessionType
payload->serializationFormat, // EventPipeSerializationFormat
pStream); // IpcStream
if (sessionId == 0)
{
DiagnosticsIpc::IpcMessage::SendErrorMessage(pStream, E_FAIL);
delete payload;
delete pStream;
}
}
#endif // FEATURE_PERFTRACING
|
