This repository has been archived by the owner on Jan 23, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2.7k
/
diagnosticserver.cpp
226 lines (196 loc) · 7.1 KB
/
diagnosticserver.cpp
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
// 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 "diagnosticserver.h"
#include "eventpipeprotocolhelper.h"
#include "dumpdiagnosticprotocolhelper.h"
#include "profilerdiagnosticprotocolhelper.h"
#include "diagnosticsprotocol.h"
#ifdef FEATURE_PAL
#include "pal.h"
#endif // FEATURE_PAL
#ifdef FEATURE_AUTO_TRACE
#include "autotrace.h"
#endif
#ifdef FEATURE_PERFTRACING
IpcStream::DiagnosticsIpc *DiagnosticServer::s_pIpc = nullptr;
static DWORD WINAPI DiagnosticsServerThread(LPVOID lpThreadParameter)
{
CONTRACTL
{
NOTHROW;
GC_TRIGGERS;
MODE_PREEMPTIVE;
PRECONDITION(lpThreadParameter != nullptr);
}
CONTRACTL_END;
auto pIpc = reinterpret_cast<IpcStream::DiagnosticsIpc *>(lpThreadParameter);
if (pIpc == nullptr)
{
STRESS_LOG0(LF_DIAGNOSTICS_PORT, LL_ERROR, "Diagnostics IPC listener was undefined\n");
return 1;
}
ErrorCallback LoggingCallback = [](const char *szMessage, uint32_t code) {
STRESS_LOG2(LF_DIAGNOSTICS_PORT, LL_WARNING, "warning (%d): %s.\n", code, szMessage);
};
EX_TRY
{
while (true)
{
// FIXME: Ideally this would be something like a std::shared_ptr
IpcStream *pStream = pIpc->Accept(LoggingCallback);
if (pStream == nullptr)
continue;
#ifdef FEATURE_AUTO_TRACE
auto_trace_signal();
#endif
DiagnosticsIpc::IpcMessage message;
if (!message.Initialize(pStream))
{
DiagnosticsIpc::IpcMessage::SendErrorMessage(pStream, CORDIAGIPC_E_BAD_ENCODING);
delete pStream;
continue;
}
if (::strcmp((char *)message.GetHeader().Magic, (char *)DiagnosticsIpc::DotnetIpcMagic_V1.Magic) != 0)
{
DiagnosticsIpc::IpcMessage::SendErrorMessage(pStream, CORDIAGIPC_E_UNKNOWN_MAGIC);
delete pStream;
continue;
}
switch ((DiagnosticsIpc::DiagnosticServerCommandSet)message.GetHeader().CommandSet)
{
case DiagnosticsIpc::DiagnosticServerCommandSet::EventPipe:
EventPipeProtocolHelper::HandleIpcMessage(message, pStream);
break;
#ifdef FEATURE_PAL
case DiagnosticsIpc::DiagnosticServerCommandSet::Dump:
DumpDiagnosticProtocolHelper::HandleIpcMessage(message, pStream);
break;
#endif
#ifdef FEATURE_PROFAPI_ATTACH_DETACH
case DiagnosticsIpc::DiagnosticServerCommandSet::Profiler:
ProfilerDiagnosticProtocolHelper::AttachProfiler(message, pStream);
break;
#endif // FEATURE_PROFAPI_ATTACH_DETACH
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;
}
}
}
EX_CATCH
{
STRESS_LOG0(LF_DIAGNOSTICS_PORT, LL_ERROR, "Exception caught in diagnostic thread. Leaving thread now.\n");
_ASSERTE(!"Hit an error in the diagnostic server thread\n.");
}
EX_END_CATCH(SwallowAllExceptions);
return 0;
}
bool DiagnosticServer::Initialize()
{
CONTRACTL
{
NOTHROW;
GC_TRIGGERS;
MODE_ANY;
}
CONTRACTL_END;
// COMPlus_EnableDiagnostics==0 disables diagnostics so we don't create the diagnostics pipe/socket or diagnostics server thread
if (CLRConfig::GetConfigValue(CLRConfig::EXTERNAL_EnableDiagnostics) == 0)
{
return true;
}
bool fSuccess = false;
EX_TRY
{
auto ErrorCallback = [](const char *szMessage, uint32_t code) {
STRESS_LOG2(
LF_DIAGNOSTICS_PORT, // facility
LL_ERROR, // level
"Failed to create diagnostic IPC: error (%d): %s.\n", // msg
code, // data1
szMessage); // data2
};
// TODO: Should we handle/assert that (s_pIpc == nullptr)?
s_pIpc = IpcStream::DiagnosticsIpc::Create(
"dotnet-diagnostic", ErrorCallback);
if (s_pIpc != nullptr)
{
#ifdef FEATURE_AUTO_TRACE
auto_trace_init();
auto_trace_launch();
#endif
DWORD dwThreadId = 0;
HANDLE hThread = ::CreateThread( // TODO: Is it correct to have this "lower" level call here?
nullptr, // no security attribute
0, // default stack size
DiagnosticsServerThread, // thread proc
(LPVOID)s_pIpc, // thread parameter
0, // not suspended
&dwThreadId); // returns thread ID
if (hThread == nullptr)
{
// Failed to create IPC thread.
STRESS_LOG1(
LF_DIAGNOSTICS_PORT, // facility
LL_ERROR, // level
"Failed to create diagnostic server thread (%d).\n", // msg
::GetLastError()); // data1
}
else
{
#ifdef FEATURE_AUTO_TRACE
auto_trace_wait();
#endif
// FIXME: Maybe hold on to the thread to abort/cleanup at exit?
::CloseHandle(hThread);
// TODO: Add error handling?
fSuccess = true;
}
}
}
EX_CATCH
{
// TODO: Should we log anything here?
}
EX_END_CATCH(SwallowAllExceptions);
return fSuccess;
}
bool DiagnosticServer::Shutdown()
{
CONTRACTL
{
NOTHROW;
GC_TRIGGERS;
MODE_ANY;
}
CONTRACTL_END;
bool fSuccess = false;
EX_TRY
{
if (s_pIpc != nullptr)
{
auto ErrorCallback = [](const char *szMessage, uint32_t code) {
STRESS_LOG2(
LF_DIAGNOSTICS_PORT, // facility
LL_ERROR, // level
"Failed to unlink diagnostic IPC: error (%d): %s.\n", // msg
code, // data1
szMessage); // data2
};
s_pIpc->Unlink(ErrorCallback);
}
fSuccess = true;
}
EX_CATCH
{
fSuccess = false;
// TODO: Should we log anything here?
}
EX_END_CATCH(SwallowAllExceptions);
return fSuccess;
}
#endif // FEATURE_PERFTRACING