Skip to content
Navigation Menu
{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 161
Expand file tree
/
Copy pathTraceManager.cpp
More file actions
518 lines (432 loc) · 13.6 KB
/
Copy pathTraceManager.cpp
File metadata and controls
518 lines (432 loc) · 13.6 KB
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
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
#include "pch.h"
#include "TraceManager.h"
#include <TlHelp32.h>
#include "EventData.h"
#include <assert.h>
#include <VersionHelpers.h>
#include <algorithm>
#include "FilterBase.h"
#pragma comment(lib,"tdh")
static bool EnablePrivilege(PCWSTR privilege) {
HANDLE hToken;
if (!::OpenProcessToken(::GetCurrentProcess(), TOKEN_ADJUST_PRIVILEGES, &hToken))
return false;
TOKEN_PRIVILEGES tp;
tp.PrivilegeCount = 1;
tp.Privileges[0].Attributes = SE_PRIVILEGE_ENABLED;
if (!::LookupPrivilegeValue(nullptr, privilege, &tp.Privileges[0].Luid))
return false;
BOOL success = ::AdjustTokenPrivileges(hToken, FALSE, &tp, sizeof(tp), nullptr, nullptr);
::CloseHandle(hToken);
return success && ::GetLastError() == ERROR_SUCCESS;
}
TraceManager::TraceManager() {
EnablePrivilege(SE_DEBUG_NAME);
EnablePrivilege(SE_SYSTEM_PROFILE_NAME);
_filters.reserve(8);
}
TraceManager::~TraceManager() {
Stop();
}
bool TraceManager::AddKernelEventTypes(std::initializer_list<KernelEventTypes> types) {
_kernelEventTypes.insert(types);
return true;
}
bool TraceManager::SetKernelEventTypes(std::initializer_list<KernelEventTypes> types) {
_kernelEventTypes = types;
return true;
}
bool TraceManager::SetKernelEventStacks(std::initializer_list<std::wstring> categories) {
_kernelEventStacks = categories;
return true;
}
bool TraceManager::Start(EventCallback cb) {
if (_handle || _hTrace)
return true;
auto sessionName = KERNEL_LOGGER_NAME;
_callback = cb;
_filteredEvents = 0;
// {A17F6E93-D74C-4662-8AE8-1BDA6B22B0FE}
static const GUID dummyGuid =
{ 0xa17f6e93, 0xd74c, 0x4662, { 0x8a, 0xe8, 0x1b, 0xda, 0x6b, 0x22, 0xb0, 0xfe } };
auto size = sizeof(EVENT_TRACE_PROPERTIES) + sizeof(KERNEL_LOGGER_NAME);
_propertiesBuffer = std::make_unique<BYTE[]>(size);
bool isWin8Plus = ::IsWindows8OrGreater();
ULONG error;
for (;;) {
::memset(_propertiesBuffer.get(), 0, size);
_properties = reinterpret_cast<EVENT_TRACE_PROPERTIES*>(_propertiesBuffer.get());
_properties->EnableFlags = (ULONG)KernelEventTypes::Process;
_properties->Wnode.BufferSize = (ULONG)size;
_properties->Wnode.Guid = isWin8Plus ? dummyGuid : SystemTraceControlGuid;
_properties->Wnode.Flags = WNODE_FLAG_TRACED_GUID;
_properties->Wnode.ClientContext = 1;
_properties->FlushTimer = 1;
_properties->LogFileMode = EVENT_TRACE_REAL_TIME_MODE | EVENT_TRACE_USE_LOCAL_SEQUENCE | EVENT_TRACE_SYSTEM_LOGGER_MODE;
_properties->LoggerNameOffset = sizeof(EVENT_TRACE_PROPERTIES);
error = ::StartTrace(&_handle, sessionName, _properties);
if (error == ERROR_ALREADY_EXISTS) {
error = ::ControlTrace(_hTrace, KERNEL_LOGGER_NAME, _properties, EVENT_TRACE_CONTROL_STOP);
if (error != ERROR_SUCCESS)
return false;
continue;
}
break;
}
if (error != ERROR_SUCCESS)
return false;
error = UpdateEventConfig();
if (error != ERROR_SUCCESS) {
Stop();
return false;
}
_traceLog.Context = this;
_traceLog.LoggerName = (PWSTR)KERNEL_LOGGER_NAME;
_traceLog.ProcessTraceMode = PROCESS_TRACE_MODE_EVENT_RECORD | PROCESS_TRACE_MODE_REAL_TIME;
_traceLog.EventRecordCallback = [](PEVENT_RECORD record) {
((TraceManager*)record->UserContext)->OnEventRecord(record);
};
_hTrace = ::OpenTrace(&_traceLog);
if (!_hTrace)
return false;
// create a dedicted thread to process the trace
_hProcessThread.reset(::CreateThread(nullptr, 0, [](auto param) {
return ((TraceManager*)param)->Run();
},this,0,nullptr));
::SetThreadPriority(_hProcessThread.get(), THREAD_PRIORITY_HIGHEST);
return true;
}
bool TraceManager::Stop() {
if (_handle) {
::ControlTrace(_hTrace, KERNEL_LOGGER_NAME, _properties, EVENT_TRACE_CONTROL_STOP);
_handle = 0;
}
if (_hTrace) {
::CloseTrace(_hTrace);
_hTrace = 0;
}
if (WAIT_TIMEOUT == ::WaitForSingleObject(_hProcessThread.get(), 3000))
::TerminateThread(_hProcessThread.get(), 1);
_hProcessThread.reset();
return true;
}
bool TraceManager::IsRunning() const {
return _hProcessThread != nullptr;
}
std::wstring TraceManager::GetProcessImageById(DWORD pid) const {
std::shared_lock locker(_processesLock);
if (auto it = _processes.find(pid); it != _processes.end())
return it->second;
return L"";
}
void TraceManager::EnumProcesses() {
wil::unique_handle hSnapshot(::CreateToolhelp32Snapshot(TH32CS_SNAPPROCESS, 0));
if (!hSnapshot)
return;
PROCESSENTRY32 pe;
pe.dwSize = sizeof(pe);
if (!::Process32First(hSnapshot.get(), &pe))
return;
_processes.clear();
_processes.reserve(512);
while (::Process32Next(hSnapshot.get(), &pe)) {
_processes.insert({ pe.th32ProcessID,pe.szExeFile });
}
}
void TraceManager::RemoveAllFilters() {
_filters.clear();
}
int TraceManager::GetFilterCount() const {
return (int)_filters.size();
}
bool TraceManager::SwapFilters(int i1, int i2) {
if (i1 < 0 || i2 < 0 || i1 >= _filters.size() || i2 >= _filters.size() || i2 == i1)
return false;
std::swap(_filters[i1], _filters[i2]);
return true;
}
std::shared_ptr<FilterBase> TraceManager::GetFilter(int index) const {
if (index < 0 || index >= _filters.size())
return nullptr;
return _filters[index];
}
bool TraceManager::ParseProcessStartStop(EventData* data) {
if (data->GetEventName().substr(0, 8) != L"Process/")
return false;
switch (data->GetEventDescriptor().Opcode)
{
case 1: // process created
{
auto prop = data->GetProperty(L"ImageFileName");
if (prop) {
auto name = prop->GetAnsiString();
if (name) {
std::wstring pname;
pname.assign(name, name + strlen(name));
AddProcessName(data->GetProperty(L"ProcessId")->GetValue<DWORD>(), pname);
assert(!pname.empty());
}
}
break;
}
case 2: // process end
RemoveProcessName(data->GetProcessId());
break;
}
return true;
}
void TraceManager::ResetIndex(uint32_t index) {
_index = index;
}
int TraceManager::UpdateEventConfig() {
ULONG error = ERROR_SUCCESS;
bool isWin8Plus = ::IsWindows8OrGreater();
typedef struct _PERFINFO_GROUPMASK {
ULONG Masks[8];
}PERINFO_GROUPMASK;
PERFINFO_GROUPMASK gm{};
gm.Masks[0] = EVENT_TRACE_FLAG_PROCESS;
for (auto type : _kernelEventTypes) {
gm.Masks[((uint64_t)type) >> 32] |= (ULONG)type;
}
error = ::TraceSetInformation(_handle, TraceSystemTraceEnableFlagsInfo, &gm, sizeof(gm));
if (error != ERROR_SUCCESS)
return error;
std::vector<CLASSIC_EVENT_ID> stacks;
stacks.reserve(32);
for (auto& name : _kernelEventStacks) {
auto cat = KernelEventCategory::GetCategory(name.c_str());
assert(cat);
for (auto& evt : cat->Events) {
CLASSIC_EVENT_ID id{};
id.EventGuid = *cat->Guid;
id.Type = evt.Opcode;
stacks.push_back(id);
}
}
error = ::TraceSetInformation(_handle, TraceStackTracingInfo, stacks.data(), (ULONG)stacks.size() * sizeof(CLASSIC_EVENT_ID));
return error;
}
void TraceManager::OnEventRecord(PEVENT_RECORD rec) {
if (_handle == 0 || _isPaused)
return;
auto pid = rec->EventHeader.ProcessId;
auto& eventName = GetKernelEventName(rec);
if (eventName.empty() && _dumpUnnamedEvents)
return;
// use the separate heap
std::shared_ptr<EventData> data(new EventData(rec, GetProcessImageById(pid), eventName, ++_index));
// force copying properties
data->GetProperties();
if (rec->EventHeader.ProviderId == StackWalkGuid) {
_index--;
if (_lastEvent) {
if (_lastEvent->GetThreadId() != data->GetProperty(L"StackThread")->GetValue<DWORD>())
return;
_lastEvent->SetStackEventData(data);
_lastEvent.reset();
}
_lastExcluded = nullptr;
return;
}
bool processEvent = ParseProcessStartStop(data.get());
if (!processEvent && data->GetProcessId() == 0 || data->GetProcessId() == (DWORD)-1) {
HandleNoProcessId(data.get());
}
if (!_filters.empty()) {
// evaluate filters
FilterContext context = { data.get() };
auto result = FilterAction::None;
for (auto& filter : _filters) {
if (!filter->IsEnabled())
continue;
auto action = filter->Eval(context);
if (action == FilterAction::Exclude) {
result = action;
break;
}
if (action == FilterAction::Include) {
result = action;
break;
}
}
if (result == FilterAction::Exclude) {
_filteredEvents++;
_lastExcluded = data;
return;
}
}
_lastEvent = data;
if (_callback && (!processEvent || _isTraceProcesses))
_callback(data);
}
DWORD TraceManager::Run() {
EnumProcesses();
FILETIME now;
::GetSystemTimeAsFileTime(&now);
auto error = ::ProcessTrace(&_hTrace, 1, &now, nullptr);
return error;
}
uint32_t TraceManager::GetFilteredEventCount() const {
return _filteredEvents;
}
void TraceManager::HandleNoProcessId(EventData* data) {
DWORD tid = 0;
if (data->GetThreadId() == 0 || data->GetThreadId() == (DWORD)-1) {
auto prop = data->GetProperty(L"ThreadId");
if (!prop)
prop = data->GetProperty(L"TThreadId");
if (prop) {
tid = prop->GetValue<DWORD>();
data->_threadId = tid;
}
prop = data->GetProperty(L"PID");
if (prop == nullptr)
prop = data->GetProperty(L"ProcessId");
if (prop) {
auto pid = prop->GetValue<DWORD>();
data->_processId = pid;
data->SetProcessName(GetProcessImageById(pid));
}
else if (tid) {
wil::unique_handle hThread(::OpenThread(THREAD_QUERY_LIMITED_INFORMATION,FALSE, tid));
if (hThread) {
auto pid = ::GetProcessIdOfThread(hThread.get());
if (pid) {
data->_processId = pid;
data->SetProcessName(GetProcessImageById(pid));
}
}
}
}
}
const std::wstring& TraceManager::GetKernelEventName(EVENT_RECORD* rec) const {
static const std::wstring empty;
auto& desc = rec->EventHeader.EventDescriptor;
auto key = rec->EventHeader.ProviderId.Data1 ^ desc.Opcode;
if (auto it = _kernelEventNames.find(key); it != _kernelEventNames.end())
return it->second;
static BYTE buffer[1 << 11];
ULONG size = sizeof(buffer);
auto info = reinterpret_cast<PTRACE_EVENT_INFO>(buffer);
if (::TdhGetEventInformation(rec, 0, nullptr, info, &size) == STATUS_SUCCESS) {
const auto name = std::wstring((PCWSTR)((PBYTE)info + info->TaskNameOffset)) + L"/" +
std::wstring((PCWSTR)((PBYTE)info + info->OpcodeNameOffset));
_kernelEventNames.insert({ key,name });
return _kernelEventNames[key];
}
return empty;
}
void TraceManager::AddProcessName(DWORD pid, std::wstring name) {
std::lock_guard locker(_processesLock);
_processes.insert({ pid,std::move(name) });
}
void TraceManager::AddFilter(std::shared_ptr<FilterBase> filter) {
_filters.push_back(std::move(filter));
}
bool TraceManager::RemoveProcessName(DWORD pid) {
std::lock_guard locker(_processesLock);
return _processes.erase(pid);
}
bool TraceManager::IsPaused() const {
return _isPaused;
}
bool TraceManager::RemoveFilterAt(int index) {
if (index < 0 || index >= _filters.size())
return false;
_filters.erase(_filters.begin() + index);
return true;
}
std::wstring TraceManager::GetDosNameFromNtName(PCWSTR name) {
static std::vector<std::pair<std::wstring, std::wstring>> deviceNames;
static bool first = true;
if (first) {
auto drives = ::GetLogicalDrives();
int drive = 0;
while (drives) {
if (drives & 1) {
// drive exists
WCHAR driveName[] = L"X:";
driveName[0] = (WCHAR)(drive + 'A');
WCHAR path[MAX_PATH];
if (::QueryDosDevice(driveName, path, MAX_PATH)) {
deviceNames.push_back({ path,driveName });
}
}
drive++;
drives >>= 1;
}
first = false;
}
for (auto& [ntName, dosName] : deviceNames) {
if (::_wcsnicmp(name, ntName.c_str(), ntName.size()) == 0)
return dosName + (name + ntName.size());
}
return L"";
}
bool TraceManager::SetBackupFile(PCWSTR path) {
if (path) {
wil::unique_hfile hFile(::CreateFile(path, GENERIC_WRITE | GENERIC_READ, 0, nullptr, TRUNCATE_EXISTING, 0, nullptr));
if (!hFile)
return false;
_hMemMap.reset(::CreateFileMapping(hFile.get(), nullptr, PAGE_READWRITE | MEM_RESERVE,
32, 0, nullptr));
if (!_hMemMap)
return false;
}
return true;
}
void TraceManager::Pause(bool pause) {
_isPaused = pause;
}
bool TraceManager::Start(EventCallback cb, DWORD flags) {
if (_handle || _hTrace)
return true;
auto sessionName = KERNEL_LOGGER_NAME;
_callback = cb;
_filteredEvents = 0;
auto size = sizeof(EVENT_TRACE_PROPERTIES) + sizeof(KERNEL_LOGGER_NAME);
_propertiesBuffer = std::make_unique<BYTE[]>(size);
bool isWin8Plus = ::IsWindows8OrGreater();
ULONG error;
for (;;) {
::memset(_propertiesBuffer.get(), 0, size);
_properties = reinterpret_cast<EVENT_TRACE_PROPERTIES*>(_propertiesBuffer.get());
_properties->EnableFlags = flags;
_properties->Wnode.BufferSize = (ULONG)size;
_properties->Wnode.Guid = SystemTraceControlGuid;
_properties->Wnode.Flags = WNODE_FLAG_TRACED_GUID;
_properties->Wnode.ClientContext = 1;
_properties->FlushTimer = 1;
_properties->LogFileMode = EVENT_TRACE_REAL_TIME_MODE | EVENT_TRACE_USE_LOCAL_SEQUENCE | EVENT_TRACE_SYSTEM_LOGGER_MODE;
_properties->LoggerNameOffset = sizeof(EVENT_TRACE_PROPERTIES);
error = ::StartTrace(&_handle, sessionName, _properties);
if (error == ERROR_ALREADY_EXISTS) {
error = ::ControlTrace(_hTrace, KERNEL_LOGGER_NAME, _properties, EVENT_TRACE_CONTROL_STOP);
if (error != ERROR_SUCCESS)
return false;
continue;
}
break;
}
if (error != ERROR_SUCCESS)
return false;
_traceLog.Context = this;
_traceLog.LoggerName = (PWSTR)KERNEL_LOGGER_NAME;
_traceLog.ProcessTraceMode = PROCESS_TRACE_MODE_EVENT_RECORD | PROCESS_TRACE_MODE_REAL_TIME;
_traceLog.EventRecordCallback = [](PEVENT_RECORD record) {
((TraceManager*)record->UserContext)->OnEventRecord(record);
};
_hTrace = ::OpenTrace(&_traceLog);
if (!_hTrace)
return false;
// create a dedicted thread to process the trace
_hProcessThread.reset(::CreateThread(nullptr, 0, [](auto param) {
return ((TraceManager*)param)->Run();
}, this, 0, nullptr));
::SetThreadPriority(_hProcessThread.get(), THREAD_PRIORITY_HIGHEST);
return true;
}
std::set<KernelEventTypes> TraceManager::GetKernelEventTypes() const {
return _kernelEventTypes;
}
You can’t perform that action at this time.