-
Notifications
You must be signed in to change notification settings - Fork 4.7k
/
crashinfo.cpp
1048 lines (967 loc) · 34.3 KB
/
crashinfo.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
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
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
#include "createdump.h"
typedef BOOL (PALAPI_NOEXPORT *PFN_DLLMAIN)(HINSTANCE, DWORD, LPVOID); /* entry point of module */
typedef HINSTANCE (PALAPI_NOEXPORT *PFN_REGISTER_MODULE)(LPCSTR); /* used to create the HINSTANCE for above DLLMain entry point */
// This is for the PAL_VirtualUnwindOutOfProc read memory adapter.
CrashInfo* g_crashInfo;
// This is the NativeAOT DotNetRuntimeDebugHeader signature
uint8_t g_debugHeaderCookie[4] = { 0x44, 0x4E, 0x44, 0x48 };
static bool ModuleInfoCompare(const ModuleInfo* lhs, const ModuleInfo* rhs) { return lhs->BaseAddress() < rhs->BaseAddress(); }
CrashInfo::CrashInfo(const CreateDumpOptions& options) :
m_ref(1),
m_pid(options.Pid),
m_ppid(-1),
m_dacModule(nullptr),
m_pClrDataEnumRegions(nullptr),
m_pClrDataProcess(nullptr),
m_appModel(options.AppModel),
m_gatherFrames(options.CrashReport),
m_crashThread(options.CrashThread),
m_signal(options.Signal),
m_exceptionRecord(options.ExceptionRecord),
m_moduleInfos(&ModuleInfoCompare),
m_mainModule(nullptr),
m_cbModuleMappings(0),
m_dataTargetPagesAdded(0),
m_enumMemoryPagesAdded(0)
{
g_crashInfo = this;
m_runtimeBaseAddress = 0;
#ifdef __APPLE__
m_task = 0;
#else
m_auxvValues.fill(0);
m_fdMem = -1;
#endif
memset(&m_siginfo, 0, sizeof(m_siginfo));
m_siginfo.si_signo = options.Signal;
m_siginfo.si_code = options.SignalCode;
m_siginfo.si_errno = options.SignalErrno;
m_siginfo.si_addr = (void*)options.SignalAddress;
}
CrashInfo::~CrashInfo()
{
// Clean up the threads
for (ThreadInfo* thread : m_threads)
{
delete thread;
}
m_threads.clear();
// Clean up the modules
for (ModuleInfo* module : m_moduleInfos)
{
delete module;
}
m_moduleInfos.clear();
// Clean up DAC interfaces
if (m_pClrDataEnumRegions != nullptr)
{
m_pClrDataEnumRegions->Release();
}
if (m_pClrDataProcess != nullptr)
{
m_pClrDataProcess->Release();
}
// Unload DAC module
if (m_dacModule != nullptr)
{
dlclose(m_dacModule);
m_dacModule = nullptr;
}
#ifdef __APPLE__
if (m_task != 0)
{
kern_return_t result = ::mach_port_deallocate(mach_task_self(), m_task);
if (result != KERN_SUCCESS)
{
printf_error("Internal error: mach_port_deallocate FAILED %s (%x)\n", mach_error_string(result), result);
}
}
#endif
}
STDMETHODIMP
CrashInfo::QueryInterface(
___in REFIID InterfaceId,
___out PVOID* Interface)
{
if (InterfaceId == IID_IUnknown ||
InterfaceId == IID_ICLRDataEnumMemoryRegionsCallback)
{
*Interface = (ICLRDataEnumMemoryRegionsCallback*)this;
AddRef();
return S_OK;
}
else if (InterfaceId == IID_ICLRDataLoggingCallback)
{
*Interface = (ICLRDataLoggingCallback*)this;
AddRef();
return S_OK;
}
else
{
*Interface = nullptr;
return E_NOINTERFACE;
}
}
STDMETHODIMP_(ULONG)
CrashInfo::AddRef()
{
LONG ref = InterlockedIncrement(&m_ref);
return ref;
}
STDMETHODIMP_(ULONG)
CrashInfo::Release()
{
LONG ref = InterlockedDecrement(&m_ref);
if (ref == 0)
{
delete this;
}
return ref;
}
HRESULT STDMETHODCALLTYPE
CrashInfo::EnumMemoryRegion(
/* [in] */ CLRDATA_ADDRESS address,
/* [in] */ ULONG32 size)
{
address = CONVERT_FROM_SIGN_EXTENDED(address);
m_enumMemoryPagesAdded += InsertMemoryRegion(address, size);
return S_OK;
}
HRESULT STDMETHODCALLTYPE
CrashInfo::LogMessage(
/* [in] */ LPCSTR message)
{
Trace("%s", message);
return S_OK;
}
//
// Gather all the necessary crash dump info.
//
bool
CrashInfo::GatherCrashInfo(DumpType dumpType)
{
// Get the info about the threads (registers, etc.)
for (ThreadInfo* thread : m_threads)
{
if (!thread->Initialize())
{
return false;
}
}
#ifdef __APPLE__
if (!EnumerateMemoryRegions())
{
return false;
}
#else
// Get the auxv data
if (!GetAuxvEntries())
{
return false;
}
// Gather all the module memory mappings (from /dev/$pid/maps)
if (!EnumerateMemoryRegions())
{
return false;
}
// Get shared module debug info
if (!GetDSOInfo())
{
return false;
}
#endif
// Load and initialize DAC interfaces
if (!InitializeDAC(dumpType))
{
return false;
}
// Enumerate all the managed modules. On MacOS only the native modules have been added
// to the module mapping list at this point and adds the managed modules. This needs to
// be done before the other mappings is initialized.
if (!EnumerateManagedModules())
{
return false;
}
// Add the special (fake) memory region for the special diagnostics info
MemoryRegion special(PF_R, SpecialDiagInfoAddress, SpecialDiagInfoAddress + PAGE_SIZE);
m_memoryRegions.insert(special);
#ifdef __APPLE__
InitializeOtherMappings();
#endif
if (!UnwindAllThreads())
{
return false;
}
if (g_diagnosticsVerbose)
{
TRACE("Module addresses:\n");
for (const MemoryRegion& region : m_moduleAddresses)
{
region.Trace();
}
}
// If full memory dump, include everything regardless of permissions
if (dumpType == DumpType::Full)
{
for (const MemoryRegion& region : m_moduleMappings)
{
InsertMemoryRegion(region);
}
for (const MemoryRegion& region : m_otherMappings)
{
// Don't add uncommitted pages to the full dump
if ((region.Permissions() & (PF_R | PF_W | PF_X)) != 0)
{
InsertMemoryRegion(region);
}
}
}
else
{
// Add all the heap read/write memory regions (m_otherMappings contains the heaps). On Alpine
// the heap regions are marked RWX instead of just RW.
if (dumpType == DumpType::Heap)
{
for (const MemoryRegion& region : m_otherMappings)
{
uint32_t permissions = region.Permissions();
#ifdef __APPLE__
if (permissions == (PF_R | PF_W))
#else
if (permissions == (PF_R | PF_W) || permissions == (PF_R | PF_W | PF_X))
#endif
{
InsertMemoryRegion(region);
}
}
}
// Add the thread's stack and some code memory to core
for (ThreadInfo* thread : m_threads)
{
// Add the thread's stack
thread->GetThreadStack();
}
}
return true;
}
static const char*
GetHResultString(HRESULT hr)
{
switch (hr)
{
case E_FAIL:
return "The operation has failed";
case E_INVALIDARG:
return "Invalid argument";
case E_OUTOFMEMORY:
return "Out of memory";
case CORDBG_E_INCOMPATIBLE_PLATFORMS:
return "The operation failed because debuggee and debugger are on incompatible platforms";
case CORDBG_E_MISSING_DEBUGGER_EXPORTS:
return "The debuggee memory space does not have the expected debugging export table";
case CORDBG_E_UNSUPPORTED:
return "The specified action is unsupported by this version of the runtime";
}
return "";
}
//
// Enumerate all the memory regions using the DAC memory region support given a minidump type
//
bool
CrashInfo::InitializeDAC(DumpType dumpType)
{
// Don't attempt to load the DAC if the app model doesn't support it by default. The default for single-file is
// a full dump, but if the dump type requested is a mini, triage or heap and the DAC is next to the single-file
// application the core dump will be generated. For NativeAOT, there is currently no DAC available so never
// attempt to load it.
if ((dumpType == DumpType::Full && m_appModel == AppModelType::SingleFile) || m_appModel == AppModelType::NativeAOT)
{
return true;
}
// Can't load the DAC if the runtime wasn't found
if (m_coreclrPath.empty())
{
printf_error("InitializeDAC: coreclr not found; not using DAC\n");
return true;
}
ReleaseHolder<DumpDataTarget> dataTarget = new DumpDataTarget(*this);
PFN_CLRDataCreateInstance pfnCLRDataCreateInstance = nullptr;
PFN_DLLMAIN pfnDllMain = nullptr;
bool result = false;
HRESULT hr = S_OK;
// We assume that the DAC is in the same location as the libcoreclr.so module
std::string dacPath;
dacPath.append(m_coreclrPath);
dacPath.append(MAKEDLLNAME_A("mscordaccore"));
// Load and initialize the DAC. We don't use the LoadLibraryA here because the PAL may not be
// initialized properly in the forked process for the statically linked single-file scenario.
m_dacModule = dlopen(dacPath.c_str(), RTLD_LAZY);
if (m_dacModule == nullptr)
{
if (m_appModel == AppModelType::SingleFile)
{
printf_error("Only full dumps are supported by single file apps. Change the dump type to full (DOTNET_DbgMiniDumpType=4)\n");
}
else
{
printf_error("InitializeDAC: dlopen(%s) FAILED %s\n", dacPath.c_str(), dlerror());
}
goto exit;
}
pfnDllMain = (PFN_DLLMAIN)dlsym(m_dacModule, "DllMain");
if (pfnDllMain != nullptr)
{
PFN_REGISTER_MODULE registerModule = (PFN_REGISTER_MODULE)dlsym(m_dacModule, "PAL_RegisterModule");
if (registerModule == nullptr)
{
printf_error("InitializeDAC: PAL_RegisterModule FAILED\n");
goto exit;
}
HINSTANCE hModule = registerModule(dacPath.c_str());
if (!pfnDllMain(hModule, DLL_PROCESS_ATTACH, nullptr))
{
printf_error("InitializeDAC: DllMain(DLL_PROCESS_ATTACH) FAILED\n");
goto exit;
}
}
pfnCLRDataCreateInstance = (PFN_CLRDataCreateInstance)dlsym(m_dacModule, "CLRDataCreateInstance");
if (pfnCLRDataCreateInstance == nullptr)
{
printf_error("InitializeDAC: GetProcAddress(CLRDataCreateInstance) FAILED %s\n", dlerror());
goto exit;
}
hr = pfnCLRDataCreateInstance(__uuidof(ICLRDataEnumMemoryRegions), dataTarget, (void**)&m_pClrDataEnumRegions);
if (FAILED(hr))
{
printf_error("InitializeDAC: CLRDataCreateInstance(ICLRDataEnumMemoryRegions) FAILED %s (%08x)\n", GetHResultString(hr), hr);
goto exit;
}
hr = pfnCLRDataCreateInstance(__uuidof(IXCLRDataProcess), dataTarget, (void**)&m_pClrDataProcess);
if (FAILED(hr))
{
printf_error("InitializeDAC: CLRDataCreateInstance(IXCLRDataProcess) FAILED %s (%08x)\n", GetHResultString(hr), hr);
goto exit;
}
result = true;
exit:
return result;
}
//
// Enumerate all the memory regions using the DAC memory region support given a minidump type
//
bool
CrashInfo::EnumerateMemoryRegionsWithDAC(DumpType dumpType)
{
if (m_pClrDataEnumRegions != nullptr && dumpType != DumpType::Full)
{
TRACE("EnumerateMemoryRegionsWithDAC: Memory enumeration STARTED (%d %d)\n", m_enumMemoryPagesAdded, m_dataTargetPagesAdded);
// CLRDATA_ENUM_MEM_HEAP2 skips the expensive (in both time and memory usage) enumeration of the
// low level data structures and adds all the loader allocator heaps instead. The older 'DbgEnableFastHeapDumps'
// env var didn't generate a complete enough heap dump on Linux and this new path does.
CLRDataEnumMemoryFlags flags = CLRDATA_ENUM_MEM_HEAP2;
MINIDUMP_TYPE minidumpType = GetMiniDumpType(dumpType);
if (dumpType == DumpType::Heap)
{
// This is the old fast heap env var for backwards compatibility for VS4Mac.
CLRConfigNoCache fastHeapDumps = CLRConfigNoCache::Get("DbgEnableFastHeapDumps", /*noprefix*/ false, &getenv);
DWORD val = 0;
if (fastHeapDumps.IsSet() && fastHeapDumps.TryAsInteger(10, val) && val == 1)
{
// Since on MacOS all the RW regions will be added for heap dumps by createdump, the
// only thing differentiating a MiniDumpNormal and a MiniDumpWithPrivateReadWriteMemory
// is that the later uses the EnumMemoryRegions APIs. This is kind of expensive on larger
// applications (4 minutes, or even more), and this should already be in RW pages. Change
// the dump type to the faster normal one. This one already ensures necessary DAC globals,
// etc. without the costly assembly, module, class, type runtime data structures enumeration.
minidumpType = MiniDumpNormal;
flags = CLRDATA_ENUM_MEM_DEFAULT;
}
// This env var allows the CLRDATA_ENUM_MEM_HEAP2 fast path to be opt-ed out
fastHeapDumps = CLRConfigNoCache::Get("EnableFastHeapDumps", /*noprefix*/ false, &getenv);
if (fastHeapDumps.IsSet() && fastHeapDumps.TryAsInteger(10, val) && val == 0)
{
flags = CLRDATA_ENUM_MEM_DEFAULT;
}
}
// Calls CrashInfo::EnumMemoryRegion for each memory region found by the DAC
HRESULT hr = m_pClrDataEnumRegions->EnumMemoryRegions(this, minidumpType, flags);
if (FAILED(hr))
{
printf_error("EnumMemoryRegions FAILED %s (%08x)\n", GetHResultString(hr), hr);
return false;
}
TRACE("EnumerateMemoryRegionsWithDAC: Memory enumeration FINISHED (%d %d)\n", m_enumMemoryPagesAdded, m_dataTargetPagesAdded);
}
return true;
}
//
// Enumerate all the managed modules and replace the module mapping with the module name found.
//
bool
CrashInfo::EnumerateManagedModules()
{
CLRDATA_ENUM enumModules = 0;
HRESULT hr = S_OK;
if (m_pClrDataProcess != nullptr)
{
TRACE("EnumerateManagedModules: Module enumeration STARTED (%d)\n", m_dataTargetPagesAdded);
if (FAILED(hr = m_pClrDataProcess->StartEnumModules(&enumModules))) {
printf_error("StartEnumModules FAILED %s (%08x)\n", GetHResultString(hr), hr);
return false;
}
while (true)
{
ReleaseHolder<IXCLRDataModule> pClrDataModule;
if ((hr = m_pClrDataProcess->EnumModule(&enumModules, &pClrDataModule)) != S_OK) {
break;
}
// Skip any dynamic modules. The Request call below on some DACs crashes on dynamic modules.
ULONG32 flags;
if ((hr = pClrDataModule->GetFlags(&flags)) != S_OK) {
TRACE("MODULE: GetFlags FAILED %08x\n", hr);
continue;
}
if (flags & CLRDATA_MODULE_IS_DYNAMIC) {
TRACE("MODULE: Skipping dynamic module\n");
continue;
}
DacpGetModuleData moduleData;
if (SUCCEEDED(hr = moduleData.Request(pClrDataModule.GetPtr())))
{
uint64_t loadedPEAddress = CONVERT_FROM_SIGN_EXTENDED(moduleData.LoadedPEAddress);
TRACE("MODULE: %" PRIA PRIx64 " dyn %d inmem %d file %d pe %" PRIA PRIx64 " pdb %" PRIA PRIx64, loadedPEAddress, moduleData.IsDynamic,
moduleData.IsInMemory, moduleData.IsFileLayout, (uint64_t)moduleData.PEAssembly, (uint64_t)moduleData.InMemoryPdbAddress);
if (!moduleData.IsDynamic && loadedPEAddress != 0)
{
ArrayHolder<WCHAR> wszUnicodeName = new WCHAR[MAX_LONGPATH + 1];
if (SUCCEEDED(hr = pClrDataModule->GetFileName(MAX_LONGPATH, nullptr, wszUnicodeName)))
{
std::string moduleName = ConvertString(wszUnicodeName.GetPtr());
// Change the module mapping name
AddOrReplaceModuleMapping(loadedPEAddress, moduleData.LoadedPESize, moduleName);
// Add managed module info
AddModuleInfo(true, loadedPEAddress, pClrDataModule, moduleName);
}
else {
TRACE("\nModule.GetFileName FAILED %08x\n", hr);
}
}
else {
TRACE("\n");
}
}
else {
TRACE("moduleData.Request FAILED %08x\n", hr);
}
}
if (enumModules != 0) {
m_pClrDataProcess->EndEnumModules(enumModules);
}
TRACE("EnumerateManagedModules: Module enumeration FINISHED (%d) ModuleMappings %06llx\n", m_dataTargetPagesAdded, m_cbModuleMappings / PAGE_SIZE);
}
return true;
}
//
// Unwind all the native threads to ensure that the dwarf unwind info is added to the core dump.
//
bool
CrashInfo::UnwindAllThreads()
{
// Don't unwind any threads if Native AOT since there isn't a DAC to get the remote
// unwinder support and they are full dumps.
if (m_appModel != AppModelType::NativeAOT)
{
TRACE("UnwindAllThreads: STARTED (%d)\n", m_dataTargetPagesAdded);
ReleaseHolder<ISOSDacInterface> pSos = nullptr;
if (m_pClrDataProcess != nullptr) {
m_pClrDataProcess->QueryInterface(__uuidof(ISOSDacInterface), (void**)&pSos);
}
// For each native and managed thread
for (ThreadInfo* thread : m_threads)
{
if (!thread->UnwindThread(m_pClrDataProcess, pSos)) {
return false;
}
}
TRACE("UnwindAllThreads: FINISHED (%d)\n", m_dataTargetPagesAdded);
}
return true;
}
//
// Replace an existing module mapping with one with a different name.
//
void
CrashInfo::AddOrReplaceModuleMapping(uint64_t baseAddress, uint64_t size, const std::string& name)
{
// Round to page boundary (single-file managed assemblies are not page aligned)
uint64_t start = baseAddress & PAGE_MASK;
assert(start > 0);
// Round up to page boundary
uint64_t end = ((baseAddress + size) + (PAGE_SIZE - 1)) & PAGE_MASK;
assert(end > 0);
uint32_t flags = GetMemoryRegionFlags(baseAddress);
// Make sure that the page containing the PE header for the managed assemblies is in the dump
// especially on MacOS where they are added artificially.
ModuleRegion header(flags, start, start + PAGE_SIZE);
InsertMemoryRegion(header);
// Add or change the module mapping for this PE image. The managed assembly images may already
// be in the module mappings list but they may not have the full assembly name (like in .NET 2.0
// they have the name "/dev/zero"). On MacOS, the managed assembly modules have not been added.
const auto& found = m_moduleMappings.find(header);
if (found == m_moduleMappings.end())
{
// On MacOS the assemblies are always added.
ModuleRegion newRegion(flags, start, end, 0, name);
m_moduleMappings.insert(newRegion);
m_cbModuleMappings += newRegion.Size();
if (g_diagnostics) {
newRegion.Trace("MODULE: ADD ");
}
}
else if (found->FileName().compare(name) != 0)
{
// Create the new memory region with the managed assembly name.
ModuleRegion newRegion(*found, name);
// Remove and cleanup the old one
m_moduleMappings.erase(found);
m_cbModuleMappings -= found->Size();
// Add the new memory region.
m_moduleMappings.insert(newRegion);
m_cbModuleMappings += newRegion.Size();
if (g_diagnostics) {
newRegion.Trace("MODULE: REPLACE ");
}
}
}
//
// Returns the module base address for the IP or 0. Used by the thread unwind code.
//
uint64_t
CrashInfo::GetBaseAddressFromAddress(uint64_t address)
{
MemoryRegion search(0, address, address, 0);
const MemoryRegion* found = SearchMemoryRegions(m_moduleAddresses, search);
if (found == nullptr) {
return 0;
}
// The memory region Offset() is the base address of the module
return found->Offset();
}
//
// Returns the module base address for the given module name or 0 if not found.
//
uint64_t
CrashInfo::GetBaseAddressFromName(const char* moduleName)
{
for (const ModuleInfo* moduleInfo : m_moduleInfos)
{
std::string name = GetFileName(moduleInfo->ModuleName());
#ifdef __APPLE__
// Module names are case insensitive on MacOS
if (strcasecmp(name.c_str(), moduleName) == 0)
#else
if (name.compare(moduleName) == 0)
#endif
{
return moduleInfo->BaseAddress();
}
}
return 0;
}
//
// Return the module info for the base address
//
ModuleInfo*
CrashInfo::GetModuleInfoFromBaseAddress(uint64_t baseAddress)
{
ModuleInfo search(baseAddress);
const auto& found = m_moduleInfos.find(&search);
if (found != m_moduleInfos.end())
{
return *found;
}
return nullptr;
}
//
// Adds module address range for IP lookup
//
void
CrashInfo::AddModuleAddressRange(uint64_t startAddress, uint64_t endAddress, uint64_t baseAddress)
{
// Add module segment to base address lookup
MemoryRegion region(0, startAddress, endAddress, baseAddress);
m_moduleAddresses.insert(region);
}
//
// Adds module info (baseAddress, module name, etc)
//
void
CrashInfo::AddModuleInfo(bool isManaged, uint64_t baseAddress, IXCLRDataModule* pClrDataModule, const std::string& moduleName)
{
ModuleInfo moduleInfo(baseAddress);
const auto& found = m_moduleInfos.find(&moduleInfo);
if (found == m_moduleInfos.end())
{
uint32_t timeStamp = 0;
uint32_t imageSize = 0;
bool isMainModule = false;
GUID mvid;
if (isManaged)
{
IMAGE_DOS_HEADER dosHeader;
if (ReadMemory(baseAddress, &dosHeader, sizeof(dosHeader)))
{
WORD magic;
if (ReadMemory(baseAddress + dosHeader.e_lfanew + offsetof(IMAGE_NT_HEADERS, OptionalHeader.Magic), &magic, sizeof(magic)))
{
if (magic == IMAGE_NT_OPTIONAL_HDR32_MAGIC)
{
IMAGE_NT_HEADERS32 header;
if (ReadMemory(baseAddress + dosHeader.e_lfanew, &header, sizeof(header)))
{
imageSize = header.OptionalHeader.SizeOfImage;
timeStamp = header.FileHeader.TimeDateStamp;
}
}
else if (magic == IMAGE_NT_OPTIONAL_HDR64_MAGIC)
{
IMAGE_NT_HEADERS64 header;
if (ReadMemory(baseAddress + dosHeader.e_lfanew, &header, sizeof(header)))
{
imageSize = header.OptionalHeader.SizeOfImage;
timeStamp = header.FileHeader.TimeDateStamp;
}
}
}
}
if (pClrDataModule != nullptr)
{
ULONG32 flags = 0;
pClrDataModule->GetFlags(&flags);
isMainModule = (flags & CLRDATA_MODULE_IS_MAIN_MODULE) != 0;
pClrDataModule->GetVersionId(&mvid);
}
TRACE("MODULE: timestamp %08x size %08x %s %s%s\n", timeStamp, imageSize, FormatGuid(&mvid).c_str(), isMainModule ? "*" : "", moduleName.c_str());
}
ModuleInfo* moduleInfo = new ModuleInfo(isManaged, baseAddress, timeStamp, imageSize, &mvid, moduleName);
if (isMainModule) {
m_mainModule = moduleInfo;
}
m_moduleInfos.insert(moduleInfo);
}
}
//
// ReadMemory from target and add to memory regions list
//
bool
CrashInfo::ReadMemory(uint64_t address, void* buffer, size_t size)
{
size_t read = 0;
if (!ReadProcessMemory(address, buffer, size, &read))
{
return false;
}
assert(read == size);
InsertMemoryRegion(address, read);
return true;
}
//
// Add this memory chunk to the list of regions to be written to the core dump. Returns the number of pages actually added.
//
int
CrashInfo::InsertMemoryRegion(uint64_t address, size_t size)
{
assert(address == CONVERT_FROM_SIGN_EXTENDED(address));
assert(size < UINT_MAX);
// Round to page boundary
uint64_t start = address & PAGE_MASK;
assert(start > 0);
// Round up to page boundary
uint64_t end = ((address + size) + (PAGE_SIZE - 1)) & PAGE_MASK;
assert(end > 0);
return InsertMemoryRegion(MemoryRegion(GetMemoryRegionFlags(start), start, end));
}
//
// Add a memory region to the list. Returns the number of pages actually added.
//
int
CrashInfo::InsertMemoryRegion(const MemoryRegion& region)
{
// Check if the new region overlaps with the previously added ones
const auto& conflictingRegion = m_memoryRegions.find(region);
const bool hasConflict = conflictingRegion != m_memoryRegions.end();
if (hasConflict && conflictingRegion->Contains(region))
{
// The region is contained in the one we added before
// Nothing to do
return 0;
}
// Go page by page and split the region into valid sub-regions
uint64_t pageStart = region.StartAddress();
uint64_t numberPages = region.Size() / PAGE_SIZE;
uint64_t subRegionStart, subRegionEnd;
int pagesAdded = 0;
subRegionStart = subRegionEnd = pageStart;
for (size_t p = 0; p < numberPages; p++, pageStart += PAGE_SIZE)
{
MemoryRegion page(region.Flags(), pageStart, pageStart + PAGE_SIZE);
// avoid searching for conflicts if we know we don't have one
const bool pageHasConflicts = hasConflict && m_memoryRegions.find(page) != m_memoryRegions.end();
// avoid validating the page if it conflicts: we won't add it in any case
const bool pageIsValid = !pageHasConflicts && PageMappedToPhysicalMemory(pageStart) && PageCanBeRead(pageStart);
if (pageIsValid)
{
subRegionEnd = page.EndAddress();
pagesAdded++;
}
else
{
// the next page is not valid thus sub-region is complete
if (subRegionStart != subRegionEnd)
{
m_memoryRegions.insert(MemoryRegion(region.Flags(), subRegionStart, subRegionEnd));
}
subRegionStart = subRegionEnd = page.EndAddress();
}
}
// add the last sub-region if it's not empty
if (subRegionStart != subRegionEnd)
{
m_memoryRegions.insert(MemoryRegion(region.Flags(), subRegionStart, subRegionEnd));
}
return pagesAdded;
}
//
// Check the page is really used by the application before adding it to the dump
// On some kernels reading a region from createdump results in committing this region in the parent application
// That leads to OOM in container environment and unnecesserally increses the size of the dump file
// However this is an optimization: if it fails we still try to add the page to the dump
//
bool
CrashInfo::PageMappedToPhysicalMemory(uint64_t start)
{
#if !defined(__linux__)
// this check has not been implemented yet for other unix systems
return true;
#else
// https://www.kernel.org/doc/Documentation/vm/pagemap.txt
if (m_fdPagemap == -1)
{
// Weren't able to open pagemap file, so don't run this check
// Expected on kernels 4.0 and 4.1 as we need CAP_SYS_ADMIN to open /proc/pid/pagemap
// On kernels after 4.2 we only need PTRACE_MODE_READ_FSCREDS as we are ok with zeroed PFNs
return true;
}
uint64_t pagemapOffset = (start / PAGE_SIZE) * sizeof(uint64_t);
uint64_t seekResult = lseek(m_fdPagemap, (off_t) pagemapOffset, SEEK_SET);
if (seekResult != pagemapOffset)
{
int seekErrno = errno;
TRACE("Seeking in pagemap file FAILED, addr: %" PRIA PRIx ", pagemap offset: %" PRIA PRIx ", ERRNO %d: %s\n", start, pagemapOffset, seekErrno, strerror(seekErrno));
return true;
}
uint64_t value;
size_t readResult = read(m_fdPagemap, (void*)&value, sizeof(value));
if (readResult == (size_t) -1)
{
int readErrno = errno;
TRACE("Reading of pagemap file FAILED, addr: %" PRIA PRIx ", pagemap offset: %" PRIA PRIx ", size: %zu, ERRNO %d: %s\n", start, pagemapOffset, sizeof(value), readErrno, strerror(readErrno));
return true;
}
bool is_page_present = (value & ((uint64_t)1 << 63)) != 0;
bool is_page_swapped = (value & ((uint64_t)1 << 62)) != 0;
TRACE_VERBOSE("Pagemap value for %" PRIA PRIx ", pagemap offset %" PRIA PRIx " is %" PRIA PRIx " -> %s\n", start, pagemapOffset, value, is_page_present ? "in memory" : (is_page_swapped ? "in swap" : "NOT in memory"));
return is_page_present || is_page_swapped;
#endif
}
bool
CrashInfo::PageCanBeRead(uint64_t start)
{
BYTE buffer[1];
size_t read;
return ReadProcessMemory(start, buffer, 1, &read);
}
//
// Combine any adjacent memory regions into one
//
void
CrashInfo::CombineMemoryRegions()
{
TRACE("CombineMemoryRegions: STARTED\n");
assert(!m_memoryRegions.empty());
std::set<MemoryRegion> memoryRegionsNew;
// MEMORY_REGION_FLAG_SHARED and MEMORY_REGION_FLAG_PRIVATE are internal flags that
// don't affect the core dump so ignore them when comparing the flags.
uint32_t flags = m_memoryRegions.begin()->Flags() & MEMORY_REGION_FLAG_PERMISSIONS_MASK;
uint64_t start = m_memoryRegions.begin()->StartAddress();
uint64_t end = start;
for (const MemoryRegion& region : m_memoryRegions)
{
// To combine a region it needs to be contiguous, same permissions and memory backed flag.
if ((end == region.StartAddress()) &&
(flags == (region.Flags() & MEMORY_REGION_FLAG_PERMISSIONS_MASK)))
{
end = region.EndAddress();
}
else
{
MemoryRegion memoryRegion(flags, start, end);
assert(memoryRegionsNew.find(memoryRegion) == memoryRegionsNew.end());
memoryRegionsNew.insert(memoryRegion);
flags = region.Flags() & MEMORY_REGION_FLAG_PERMISSIONS_MASK;
start = region.StartAddress();
end = region.EndAddress();
}
}
assert(start != end);
MemoryRegion memoryRegion(flags, start, end);
assert(memoryRegionsNew.find(memoryRegion) == memoryRegionsNew.end());
memoryRegionsNew.insert(memoryRegion);
m_memoryRegions = memoryRegionsNew;
TRACE("CombineMemoryRegions: FINISHED\n");
if (g_diagnosticsVerbose)
{
TRACE("Final Memory Regions:\n");
for (const MemoryRegion& region : m_memoryRegions)
{
region.Trace();
}
}
}
//
// Searches for a module region for a given address.
//
const ModuleRegion*
CrashInfo::SearchModuleRegions(const ModuleRegion& search)
{
std::set<ModuleRegion>::iterator found = m_moduleMappings.find(search);
for (; found != m_moduleMappings.end(); found++)
{
if (search.StartAddress() >= found->StartAddress() && search.StartAddress() < found->EndAddress())
{
return &*found;
}
}
return nullptr;
}
//
// Searches for a memory region given an address.
//
const MemoryRegion*
CrashInfo::SearchMemoryRegions(const std::set<MemoryRegion>& regions, const MemoryRegion& search)
{
std::set<MemoryRegion>::iterator found = regions.find(search);
for (; found != regions.end(); found++)
{
if (search.StartAddress() >= found->StartAddress() && search.StartAddress() < found->EndAddress())
{
return &*found;
}
}
return nullptr;
}
// Declare the prototype for the Itanium C++ ABI demangler API.
// We may not have the Itanium C++ ABI header available even when we're building against this ABI
// so we'll declare the prototype ourselves.
// See Itanium C++ ABI, March 14, 2017 Revision, Chapter 3, Section 3.4
namespace abi {
extern "C" char* __cxa_demangle (const char* mangled_name,
char* buf,
size_t* n,
int* status);
}
//
// Lookup a symbol in a module. The caller needs to call "free()" on symbol returned.
//
const char*
ModuleInfo::GetSymbolName(uint64_t address)
{
LoadModule();
if (m_localBaseAddress != 0)
{
uint64_t localAddress = m_localBaseAddress + (address - m_baseAddress);
Dl_info info;
if (dladdr((void*)localAddress, &info) != 0)
{
if (info.dli_sname != nullptr)
{
int status = -1;
char *demangled = abi::__cxa_demangle(info.dli_sname, nullptr, 0, &status);
return status == 0 ? demangled : strdup(info.dli_sname);
}
}
}
return nullptr;
}
//
// Returns just the file name portion of a file path
//
const std::string
GetFileName(const std::string& fileName)
{
size_t last = fileName.rfind(DIRECTORY_SEPARATOR_STR_A);
if (last != std::string::npos) {
last++;
}
else {
last = 0;
}
return fileName.substr(last);
}
//
// Returns just the directory portion of a path or empty if none
//
const std::string
GetDirectory(const std::string& fileName)
{
size_t last = fileName.rfind(DIRECTORY_SEPARATOR_STR_A);
if (last != std::string::npos) {
last++;
}
else {
last = 0;