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
| //===-- ProcessElfCore.cpp --------------------------------------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
#include <stdlib.h>
#include <memory>
#include <mutex>
#include "lldb/Core/Module.h"
#include "lldb/Core/ModuleSpec.h"
#include "lldb/Core/PluginManager.h"
#include "lldb/Core/Section.h"
#include "lldb/Target/DynamicLoader.h"
#include "lldb/Target/MemoryRegionInfo.h"
#include "lldb/Target/Target.h"
#include "lldb/Target/UnixSignals.h"
#include "lldb/Utility/DataBufferHeap.h"
#include "lldb/Utility/Log.h"
#include "lldb/Utility/State.h"
#include "llvm/BinaryFormat/ELF.h"
#include "llvm/Support/Threading.h"
#include "Plugins/DynamicLoader/POSIX-DYLD/DynamicLoaderPOSIXDYLD.h"
#include "Plugins/ObjectFile/ELF/ObjectFileELF.h"
#include "Plugins/Process/elf-core/RegisterUtilities.h"
#include "ProcessElfCore.h"
#include "ThreadElfCore.h"
using namespace lldb_private;
namespace ELF = llvm::ELF;
ConstString ProcessElfCore::GetPluginNameStatic() {
static ConstString g_name("elf-core");
return g_name;
}
const char *ProcessElfCore::GetPluginDescriptionStatic() {
return "ELF core dump plug-in.";
}
void ProcessElfCore::Terminate() {
PluginManager::UnregisterPlugin(ProcessElfCore::CreateInstance);
}
lldb::ProcessSP ProcessElfCore::CreateInstance(lldb::TargetSP target_sp,
lldb::ListenerSP listener_sp,
const FileSpec *crash_file) {
lldb::ProcessSP process_sp;
if (crash_file) {
// Read enough data for a ELF32 header or ELF64 header Note: Here we care
// about e_type field only, so it is safe to ignore possible presence of
// the header extension.
const size_t header_size = sizeof(llvm::ELF::Elf64_Ehdr);
auto data_sp = FileSystem::Instance().CreateDataBuffer(
crash_file->GetPath(), header_size, 0);
if (data_sp && data_sp->GetByteSize() == header_size &&
elf::ELFHeader::MagicBytesMatch(data_sp->GetBytes())) {
elf::ELFHeader elf_header;
DataExtractor data(data_sp, lldb::eByteOrderLittle, 4);
lldb::offset_t data_offset = 0;
if (elf_header.Parse(data, &data_offset)) {
if (elf_header.e_type == llvm::ELF::ET_CORE)
process_sp = std::make_shared<ProcessElfCore>(target_sp, listener_sp,
*crash_file);
}
}
}
return process_sp;
}
bool ProcessElfCore::CanDebug(lldb::TargetSP target_sp,
bool plugin_specified_by_name) {
// For now we are just making sure the file exists for a given module
if (!m_core_module_sp && FileSystem::Instance().Exists(m_core_file)) {
ModuleSpec core_module_spec(m_core_file, target_sp->GetArchitecture());
Status error(ModuleList::GetSharedModule(core_module_spec, m_core_module_sp,
nullptr, nullptr, nullptr));
if (m_core_module_sp) {
ObjectFile *core_objfile = m_core_module_sp->GetObjectFile();
if (core_objfile && core_objfile->GetType() == ObjectFile::eTypeCoreFile)
return true;
}
}
return false;
}
// ProcessElfCore constructor
ProcessElfCore::ProcessElfCore(lldb::TargetSP target_sp,
lldb::ListenerSP listener_sp,
const FileSpec &core_file)
: Process(target_sp, listener_sp), m_core_file(core_file) {}
// Destructor
ProcessElfCore::~ProcessElfCore() {
Clear();
// We need to call finalize on the process before destroying ourselves to
// make sure all of the broadcaster cleanup goes as planned. If we destruct
// this class, then Process::~Process() might have problems trying to fully
// destroy the broadcaster.
Finalize();
}
// PluginInterface
ConstString ProcessElfCore::GetPluginName() { return GetPluginNameStatic(); }
uint32_t ProcessElfCore::GetPluginVersion() { return 1; }
lldb::addr_t ProcessElfCore::AddAddressRangeFromLoadSegment(
const elf::ELFProgramHeader &header) {
const lldb::addr_t addr = header.p_vaddr;
FileRange file_range(header.p_offset, header.p_filesz);
VMRangeToFileOffset::Entry range_entry(addr, header.p_memsz, file_range);
// Only add to m_core_aranges if the file size is non zero. Some core files
// have PT_LOAD segments for all address ranges, but set f_filesz to zero for
// the .text sections since they can be retrieved from the object files.
if (header.p_filesz > 0) {
VMRangeToFileOffset::Entry *last_entry = m_core_aranges.Back();
if (last_entry && last_entry->GetRangeEnd() == range_entry.GetRangeBase() &&
last_entry->data.GetRangeEnd() == range_entry.data.GetRangeBase() &&
last_entry->GetByteSize() == last_entry->data.GetByteSize()) {
last_entry->SetRangeEnd(range_entry.GetRangeEnd());
last_entry->data.SetRangeEnd(range_entry.data.GetRangeEnd());
} else {
m_core_aranges.Append(range_entry);
}
}
// Keep a separate map of permissions that that isn't coalesced so all ranges
// are maintained.
const uint32_t permissions =
((header.p_flags & llvm::ELF::PF_R) ? lldb::ePermissionsReadable : 0u) |
((header.p_flags & llvm::ELF::PF_W) ? lldb::ePermissionsWritable : 0u) |
((header.p_flags & llvm::ELF::PF_X) ? lldb::ePermissionsExecutable : 0u);
m_core_range_infos.Append(
VMRangeToPermissions::Entry(addr, header.p_memsz, permissions));
return addr;
}
// Process Control
Status ProcessElfCore::DoLoadCore() {
Status error;
if (!m_core_module_sp) {
error.SetErrorString("invalid core module");
return error;
}
ObjectFileELF *core = (ObjectFileELF *)(m_core_module_sp->GetObjectFile());
if (core == nullptr) {
error.SetErrorString("invalid core object file");
return error;
}
llvm::ArrayRef<elf::ELFProgramHeader> segments = core->ProgramHeaders();
if (segments.size() == 0) {
error.SetErrorString("core file has no segments");
return error;
}
SetCanJIT(false);
m_thread_data_valid = true;
bool ranges_are_sorted = true;
lldb::addr_t vm_addr = 0;
/// Walk through segments and Thread and Address Map information.
/// PT_NOTE - Contains Thread and Register information
/// PT_LOAD - Contains a contiguous range of Process Address Space
for (const elf::ELFProgramHeader &H : segments) {
DataExtractor data = core->GetSegmentData(H);
// Parse thread contexts and auxv structure
if (H.p_type == llvm::ELF::PT_NOTE) {
if (llvm::Error error = ParseThreadContextsFromNoteSegment(H, data))
return Status(std::move(error));
}
// PT_LOAD segments contains address map
if (H.p_type == llvm::ELF::PT_LOAD) {
lldb::addr_t last_addr = AddAddressRangeFromLoadSegment(H);
if (vm_addr > last_addr)
ranges_are_sorted = false;
vm_addr = last_addr;
}
}
if (!ranges_are_sorted) {
m_core_aranges.Sort();
m_core_range_infos.Sort();
}
// Even if the architecture is set in the target, we need to override it to
// match the core file which is always single arch.
ArchSpec arch(m_core_module_sp->GetArchitecture());
ArchSpec target_arch = GetTarget().GetArchitecture();
ArchSpec core_arch(m_core_module_sp->GetArchitecture());
target_arch.MergeFrom(core_arch);
GetTarget().SetArchitecture(target_arch);
SetUnixSignals(UnixSignals::Create(GetArchitecture()));
// Ensure we found at least one thread that was stopped on a signal.
bool siginfo_signal_found = false;
bool prstatus_signal_found = false;
// Check we found a signal in a SIGINFO note.
for (const auto &thread_data : m_thread_data) {
if (thread_data.signo != 0)
siginfo_signal_found = true;
if (thread_data.prstatus_sig != 0)
prstatus_signal_found = true;
}
if (!siginfo_signal_found) {
// If we don't have signal from SIGINFO use the signal from each threads
// PRSTATUS note.
if (prstatus_signal_found) {
for (auto &thread_data : m_thread_data)
thread_data.signo = thread_data.prstatus_sig;
} else if (m_thread_data.size() > 0) {
// If all else fails force the first thread to be SIGSTOP
m_thread_data.begin()->signo =
GetUnixSignals()->GetSignalNumberFromName("SIGSTOP");
}
}
// Core files are useless without the main executable. See if we can locate
// the main executable using data we found in the core file notes.
lldb::ModuleSP exe_module_sp = GetTarget().GetExecutableModule();
if (!exe_module_sp) {
// The first entry in the NT_FILE might be our executable
if (!m_nt_file_entries.empty()) {
ModuleSpec exe_module_spec;
exe_module_spec.GetArchitecture() = arch;
exe_module_spec.GetFileSpec().SetFile(
m_nt_file_entries[0].path.GetCString(), FileSpec::Style::native);
if (exe_module_spec.GetFileSpec()) {
exe_module_sp = GetTarget().GetOrCreateModule(exe_module_spec,
true /* notify */);
if (exe_module_sp)
GetTarget().SetExecutableModule(exe_module_sp, eLoadDependentsNo);
}
}
}
return error;
}
lldb_private::DynamicLoader *ProcessElfCore::GetDynamicLoader() {
if (m_dyld_up.get() == nullptr)
m_dyld_up.reset(DynamicLoader::FindPlugin(
this, DynamicLoaderPOSIXDYLD::GetPluginNameStatic().GetCString()));
return m_dyld_up.get();
}
bool ProcessElfCore::UpdateThreadList(ThreadList &old_thread_list,
ThreadList &new_thread_list) {
const uint32_t num_threads = GetNumThreadContexts();
if (!m_thread_data_valid)
return false;
for (lldb::tid_t tid = 0; tid < num_threads; ++tid) {
const ThreadData &td = m_thread_data[tid];
lldb::ThreadSP thread_sp(new ThreadElfCore(*this, td));
new_thread_list.AddThread(thread_sp);
}
return new_thread_list.GetSize(false) > 0;
}
void ProcessElfCore::RefreshStateAfterStop() {}
Status ProcessElfCore::DoDestroy() { return Status(); }
// Process Queries
bool ProcessElfCore::IsAlive() { return true; }
// Process Memory
size_t ProcessElfCore::ReadMemory(lldb::addr_t addr, void *buf, size_t size,
Status &error) {
// Don't allow the caching that lldb_private::Process::ReadMemory does since
// in core files we have it all cached our our core file anyway.
return DoReadMemory(addr, buf, size, error);
}
Status ProcessElfCore::GetMemoryRegionInfo(lldb::addr_t load_addr,
MemoryRegionInfo ®ion_info) {
region_info.Clear();
const VMRangeToPermissions::Entry *permission_entry =
m_core_range_infos.FindEntryThatContainsOrFollows(load_addr);
if (permission_entry) {
if (permission_entry->Contains(load_addr)) {
region_info.GetRange().SetRangeBase(permission_entry->GetRangeBase());
region_info.GetRange().SetRangeEnd(permission_entry->GetRangeEnd());
const Flags permissions(permission_entry->data);
region_info.SetReadable(permissions.Test(lldb::ePermissionsReadable)
? MemoryRegionInfo::eYes
: MemoryRegionInfo::eNo);
region_info.SetWritable(permissions.Test(lldb::ePermissionsWritable)
? MemoryRegionInfo::eYes
: MemoryRegionInfo::eNo);
region_info.SetExecutable(permissions.Test(lldb::ePermissionsExecutable)
? MemoryRegionInfo::eYes
: MemoryRegionInfo::eNo);
region_info.SetMapped(MemoryRegionInfo::eYes);
} else if (load_addr < permission_entry->GetRangeBase()) {
region_info.GetRange().SetRangeBase(load_addr);
region_info.GetRange().SetRangeEnd(permission_entry->GetRangeBase());
region_info.SetReadable(MemoryRegionInfo::eNo);
region_info.SetWritable(MemoryRegionInfo::eNo);
region_info.SetExecutable(MemoryRegionInfo::eNo);
region_info.SetMapped(MemoryRegionInfo::eNo);
}
return Status();
}
region_info.GetRange().SetRangeBase(load_addr);
region_info.GetRange().SetRangeEnd(LLDB_INVALID_ADDRESS);
region_info.SetReadable(MemoryRegionInfo::eNo);
region_info.SetWritable(MemoryRegionInfo::eNo);
region_info.SetExecutable(MemoryRegionInfo::eNo);
region_info.SetMapped(MemoryRegionInfo::eNo);
return Status();
}
size_t ProcessElfCore::DoReadMemory(lldb::addr_t addr, void *buf, size_t size,
Status &error) {
ObjectFile *core_objfile = m_core_module_sp->GetObjectFile();
if (core_objfile == nullptr)
return 0;
// Get the address range
const VMRangeToFileOffset::Entry *address_range =
m_core_aranges.FindEntryThatContains(addr);
if (address_range == nullptr || address_range->GetRangeEnd() < addr) {
error.SetErrorStringWithFormat("core file does not contain 0x%" PRIx64,
addr);
return 0;
}
// Convert the address into core file offset
const lldb::addr_t offset = addr - address_range->GetRangeBase();
const lldb::addr_t file_start = address_range->data.GetRangeBase();
const lldb::addr_t file_end = address_range->data.GetRangeEnd();
size_t bytes_to_read = size; // Number of bytes to read from the core file
size_t bytes_copied = 0; // Number of bytes actually read from the core file
size_t zero_fill_size = 0; // Padding
lldb::addr_t bytes_left =
0; // Number of bytes available in the core file from the given address
// Don't proceed if core file doesn't contain the actual data for this
// address range.
if (file_start == file_end)
return 0;
// Figure out how many on-disk bytes remain in this segment starting at the
// given offset
if (file_end > file_start + offset)
bytes_left = file_end - (file_start + offset);
// Figure out how many bytes we need to zero-fill if we are reading more
// bytes than available in the on-disk segment
if (bytes_to_read > bytes_left) {
zero_fill_size = bytes_to_read - bytes_left;
bytes_to_read = bytes_left;
}
// If there is data available on the core file read it
if (bytes_to_read)
bytes_copied =
core_objfile->CopyData(offset + file_start, bytes_to_read, buf);
assert(zero_fill_size <= size);
// Pad remaining bytes
if (zero_fill_size)
memset(((char *)buf) + bytes_copied, 0, zero_fill_size);
return bytes_copied + zero_fill_size;
}
void ProcessElfCore::Clear() {
m_thread_list.Clear();
SetUnixSignals(std::make_shared<UnixSignals>());
}
void ProcessElfCore::Initialize() {
static llvm::once_flag g_once_flag;
llvm::call_once(g_once_flag, []() {
PluginManager::RegisterPlugin(GetPluginNameStatic(),
GetPluginDescriptionStatic(), CreateInstance);
});
}
lldb::addr_t ProcessElfCore::GetImageInfoAddress() {
ObjectFile *obj_file = GetTarget().GetExecutableModule()->GetObjectFile();
Address addr = obj_file->GetImageInfoAddress(&GetTarget());
if (addr.IsValid())
return addr.GetLoadAddress(&GetTarget());
return LLDB_INVALID_ADDRESS;
}
// Parse a FreeBSD NT_PRSTATUS note - see FreeBSD sys/procfs.h for details.
static void ParseFreeBSDPrStatus(ThreadData &thread_data,
const DataExtractor &data,
const ArchSpec &arch) {
lldb::offset_t offset = 0;
bool lp64 = (arch.GetMachine() == llvm::Triple::aarch64 ||
arch.GetMachine() == llvm::Triple::mips64 ||
arch.GetMachine() == llvm::Triple::ppc64 ||
arch.GetMachine() == llvm::Triple::x86_64);
int pr_version = data.GetU32(&offset);
Log *log(GetLogIfAllCategoriesSet(LIBLLDB_LOG_PROCESS));
if (log) {
if (pr_version > 1)
LLDB_LOGF(log, "FreeBSD PRSTATUS unexpected version %d", pr_version);
}
// Skip padding, pr_statussz, pr_gregsetsz, pr_fpregsetsz, pr_osreldate
if (lp64)
offset += 32;
else
offset += 16;
thread_data.signo = data.GetU32(&offset); // pr_cursig
thread_data.tid = data.GetU32(&offset); // pr_pid
if (lp64)
offset += 4;
size_t len = data.GetByteSize() - offset;
thread_data.gpregset = DataExtractor(data, offset, len);
}
static llvm::Error ParseNetBSDProcInfo(const DataExtractor &data,
uint32_t &cpi_nlwps,
uint32_t &cpi_signo,
uint32_t &cpi_siglwp,
uint32_t &cpi_pid) {
lldb::offset_t offset = 0;
uint32_t version = data.GetU32(&offset);
if (version != 1)
return llvm::make_error<llvm::StringError>(
"Error parsing NetBSD core(5) notes: Unsupported procinfo version",
llvm::inconvertibleErrorCode());
uint32_t cpisize = data.GetU32(&offset);
if (cpisize != NETBSD::NT_PROCINFO_SIZE)
return llvm::make_error<llvm::StringError>(
"Error parsing NetBSD core(5) notes: Unsupported procinfo size",
llvm::inconvertibleErrorCode());
cpi_signo = data.GetU32(&offset); /* killing signal */
offset += NETBSD::NT_PROCINFO_CPI_SIGCODE_SIZE;
offset += NETBSD::NT_PROCINFO_CPI_SIGPEND_SIZE;
offset += NETBSD::NT_PROCINFO_CPI_SIGMASK_SIZE;
offset += NETBSD::NT_PROCINFO_CPI_SIGIGNORE_SIZE;
offset += NETBSD::NT_PROCINFO_CPI_SIGCATCH_SIZE;
cpi_pid = data.GetU32(&offset);
offset += NETBSD::NT_PROCINFO_CPI_PPID_SIZE;
offset += NETBSD::NT_PROCINFO_CPI_PGRP_SIZE;
offset += NETBSD::NT_PROCINFO_CPI_SID_SIZE;
offset += NETBSD::NT_PROCINFO_CPI_RUID_SIZE;
offset += NETBSD::NT_PROCINFO_CPI_EUID_SIZE;
offset += NETBSD::NT_PROCINFO_CPI_SVUID_SIZE;
offset += NETBSD::NT_PROCINFO_CPI_RGID_SIZE;
offset += NETBSD::NT_PROCINFO_CPI_EGID_SIZE;
offset += NETBSD::NT_PROCINFO_CPI_SVGID_SIZE;
cpi_nlwps = data.GetU32(&offset); /* number of LWPs */
offset += NETBSD::NT_PROCINFO_CPI_NAME_SIZE;
cpi_siglwp = data.GetU32(&offset); /* LWP target of killing signal */
return llvm::Error::success();
}
static void ParseOpenBSDProcInfo(ThreadData &thread_data,
const DataExtractor &data) {
lldb::offset_t offset = 0;
int version = data.GetU32(&offset);
if (version != 1)
return;
offset += 4;
thread_data.signo = data.GetU32(&offset);
}
llvm::Expected<std::vector<CoreNote>>
ProcessElfCore::parseSegment(const DataExtractor &segment) {
lldb::offset_t offset = 0;
std::vector<CoreNote> result;
while (offset < segment.GetByteSize()) {
ELFNote note = ELFNote();
if (!note.Parse(segment, &offset))
return llvm::make_error<llvm::StringError>(
"Unable to parse note segment", llvm::inconvertibleErrorCode());
size_t note_start = offset;
size_t note_size = llvm::alignTo(note.n_descsz, 4);
DataExtractor note_data(segment, note_start, note_size);
result.push_back({note, note_data});
offset += note_size;
}
return std::move(result);
}
llvm::Error ProcessElfCore::parseFreeBSDNotes(llvm::ArrayRef<CoreNote> notes) {
bool have_prstatus = false;
bool have_prpsinfo = false;
ThreadData thread_data;
for (const auto ¬e : notes) {
if (note.info.n_name != "FreeBSD")
continue;
if ((note.info.n_type == ELF::NT_PRSTATUS && have_prstatus) ||
(note.info.n_type == ELF::NT_PRPSINFO && have_prpsinfo)) {
assert(thread_data.gpregset.GetByteSize() > 0);
// Add the new thread to thread list
m_thread_data.push_back(thread_data);
thread_data = ThreadData();
have_prstatus = false;
have_prpsinfo = false;
}
switch (note.info.n_type) {
case ELF::NT_PRSTATUS:
have_prstatus = true;
ParseFreeBSDPrStatus(thread_data, note.data, GetArchitecture());
break;
case ELF::NT_PRPSINFO:
have_prpsinfo = true;
break;
case ELF::NT_FREEBSD_THRMISC: {
lldb::offset_t offset = 0;
thread_data.name = note.data.GetCStr(&offset, 20);
break;
}
case ELF::NT_FREEBSD_PROCSTAT_AUXV:
// FIXME: FreeBSD sticks an int at the beginning of the note
m_auxv = DataExtractor(note.data, 4, note.data.GetByteSize() - 4);
break;
default:
thread_data.notes.push_back(note);
break;
}
}
if (!have_prstatus) {
return llvm::make_error<llvm::StringError>(
"Could not find NT_PRSTATUS note in core file.",
llvm::inconvertibleErrorCode());
}
m_thread_data.push_back(thread_data);
return llvm::Error::success();
}
/// NetBSD specific Thread context from PT_NOTE segment
///
/// NetBSD ELF core files use notes to provide information about
/// the process's state. The note name is "NetBSD-CORE" for
/// information that is global to the process, and "NetBSD-CORE@nn",
/// where "nn" is the lwpid of the LWP that the information belongs
/// to (such as register state).
///
/// NetBSD uses the following note identifiers:
///
/// ELF_NOTE_NETBSD_CORE_PROCINFO (value 1)
/// Note is a "netbsd_elfcore_procinfo" structure.
/// ELF_NOTE_NETBSD_CORE_AUXV (value 2; since NetBSD 8.0)
/// Note is an array of AuxInfo structures.
///
/// NetBSD also uses ptrace(2) request numbers (the ones that exist in
/// machine-dependent space) to identify register info notes. The
/// info in such notes is in the same format that ptrace(2) would
/// export that information.
///
/// For more information see /usr/include/sys/exec_elf.h
///
llvm::Error ProcessElfCore::parseNetBSDNotes(llvm::ArrayRef<CoreNote> notes) {
ThreadData thread_data;
bool had_nt_regs = false;
// To be extracted from struct netbsd_elfcore_procinfo
// Used to sanity check of the LWPs of the process
uint32_t nlwps = 0;
uint32_t signo; // killing signal
uint32_t siglwp; // LWP target of killing signal
uint32_t pr_pid;
for (const auto ¬e : notes) {
llvm::StringRef name = note.info.n_name;
if (name == "NetBSD-CORE") {
if (note.info.n_type == NETBSD::NT_PROCINFO) {
llvm::Error error = ParseNetBSDProcInfo(note.data, nlwps, signo,
siglwp, pr_pid);
if (error)
return error;
SetID(pr_pid);
} else if (note.info.n_type == NETBSD::NT_AUXV) {
m_auxv = note.data;
}
} else if (name.consume_front("NetBSD-CORE@")) {
lldb::tid_t tid;
if (name.getAsInteger(10, tid))
return llvm::make_error<llvm::StringError>(
"Error parsing NetBSD core(5) notes: Cannot convert LWP ID "
"to integer",
llvm::inconvertibleErrorCode());
switch (GetArchitecture().GetMachine()) {
case llvm::Triple::aarch64: {
// Assume order PT_GETREGS, PT_GETFPREGS
if (note.info.n_type == NETBSD::AARCH64::NT_REGS) {
// If this is the next thread, push the previous one first.
if (had_nt_regs) {
m_thread_data.push_back(thread_data);
thread_data = ThreadData();
had_nt_regs = false;
}
thread_data.gpregset = note.data;
thread_data.tid = tid;
if (thread_data.gpregset.GetByteSize() == 0)
return llvm::make_error<llvm::StringError>(
"Could not find general purpose registers note in core file.",
llvm::inconvertibleErrorCode());
had_nt_regs = true;
} else if (note.info.n_type == NETBSD::AARCH64::NT_FPREGS) {
if (!had_nt_regs || tid != thread_data.tid)
return llvm::make_error<llvm::StringError>(
"Error parsing NetBSD core(5) notes: Unexpected order "
"of NOTEs PT_GETFPREG before PT_GETREG",
llvm::inconvertibleErrorCode());
thread_data.notes.push_back(note);
}
} break;
case llvm::Triple::x86_64: {
// Assume order PT_GETREGS, PT_GETFPREGS
if (note.info.n_type == NETBSD::AMD64::NT_REGS) {
// If this is the next thread, push the previous one first.
if (had_nt_regs) {
m_thread_data.push_back(thread_data);
thread_data = ThreadData();
had_nt_regs = false;
}
thread_data.gpregset = note.data;
thread_data.tid = tid;
if (thread_data.gpregset.GetByteSize() == 0)
return llvm::make_error<llvm::StringError>(
"Could not find general purpose registers note in core file.",
llvm::inconvertibleErrorCode());
had_nt_regs = true;
} else if (note.info.n_type == NETBSD::AMD64::NT_FPREGS) {
if (!had_nt_regs || tid != thread_data.tid)
return llvm::make_error<llvm::StringError>(
"Error parsing NetBSD core(5) notes: Unexpected order "
"of NOTEs PT_GETFPREG before PT_GETREG",
llvm::inconvertibleErrorCode());
thread_data.notes.push_back(note);
}
} break;
default:
break;
}
}
}
// Push the last thread.
if (had_nt_regs)
m_thread_data.push_back(thread_data);
if (m_thread_data.empty())
return llvm::make_error<llvm::StringError>(
"Error parsing NetBSD core(5) notes: No threads information "
"specified in notes",
llvm::inconvertibleErrorCode());
if (m_thread_data.size() != nlwps)
return llvm::make_error<llvm::StringError>(
"Error parsing NetBSD core(5) notes: Mismatch between the number "
"of LWPs in netbsd_elfcore_procinfo and the number of LWPs specified "
"by MD notes",
llvm::inconvertibleErrorCode());
// Signal targeted at the whole process.
if (siglwp == 0) {
for (auto &data : m_thread_data)
data.signo = signo;
}
// Signal destined for a particular LWP.
else {
bool passed = false;
for (auto &data : m_thread_data) {
if (data.tid == siglwp) {
data.signo = signo;
passed = true;
break;
}
}
if (!passed)
return llvm::make_error<llvm::StringError>(
"Error parsing NetBSD core(5) notes: Signal passed to unknown LWP",
llvm::inconvertibleErrorCode());
}
return llvm::Error::success();
}
llvm::Error ProcessElfCore::parseOpenBSDNotes(llvm::ArrayRef<CoreNote> notes) {
ThreadData thread_data;
for (const auto ¬e : notes) {
// OpenBSD per-thread information is stored in notes named "OpenBSD@nnn" so
// match on the initial part of the string.
if (!llvm::StringRef(note.info.n_name).startswith("OpenBSD"))
continue;
switch (note.info.n_type) {
case OPENBSD::NT_PROCINFO:
ParseOpenBSDProcInfo(thread_data, note.data);
break;
case OPENBSD::NT_AUXV:
m_auxv = note.data;
break;
case OPENBSD::NT_REGS:
thread_data.gpregset = note.data;
break;
default:
thread_data.notes.push_back(note);
break;
}
}
if (thread_data.gpregset.GetByteSize() == 0) {
return llvm::make_error<llvm::StringError>(
"Could not find general purpose registers note in core file.",
llvm::inconvertibleErrorCode());
}
m_thread_data.push_back(thread_data);
return llvm::Error::success();
}
/// A description of a linux process usually contains the following NOTE
/// entries:
/// - NT_PRPSINFO - General process information like pid, uid, name, ...
/// - NT_SIGINFO - Information about the signal that terminated the process
/// - NT_AUXV - Process auxiliary vector
/// - NT_FILE - Files mapped into memory
///
/// Additionally, for each thread in the process the core file will contain at
/// least the NT_PRSTATUS note, containing the thread id and general purpose
/// registers. It may include additional notes for other register sets (floating
/// point and vector registers, ...). The tricky part here is that some of these
/// notes have "CORE" in their owner fields, while other set it to "LINUX".
llvm::Error ProcessElfCore::parseLinuxNotes(llvm::ArrayRef<CoreNote> notes) {
const ArchSpec &arch = GetArchitecture();
bool have_prstatus = false;
bool have_prpsinfo = false;
ThreadData thread_data;
for (const auto ¬e : notes) {
if (note.info.n_name != "CORE" && note.info.n_name != "LINUX")
continue;
if ((note.info.n_type == ELF::NT_PRSTATUS && have_prstatus) ||
(note.info.n_type == ELF::NT_PRPSINFO && have_prpsinfo)) {
assert(thread_data.gpregset.GetByteSize() > 0);
// Add the new thread to thread list
m_thread_data.push_back(thread_data);
thread_data = ThreadData();
have_prstatus = false;
have_prpsinfo = false;
}
switch (note.info.n_type) {
case ELF::NT_PRSTATUS: {
have_prstatus = true;
ELFLinuxPrStatus prstatus;
Status status = prstatus.Parse(note.data, arch);
if (status.Fail())
return status.ToError();
thread_data.prstatus_sig = prstatus.pr_cursig;
thread_data.tid = prstatus.pr_pid;
uint32_t header_size = ELFLinuxPrStatus::GetSize(arch);
size_t len = note.data.GetByteSize() - header_size;
thread_data.gpregset = DataExtractor(note.data, header_size, len);
break;
}
case ELF::NT_PRPSINFO: {
have_prpsinfo = true;
ELFLinuxPrPsInfo prpsinfo;
Status status = prpsinfo.Parse(note.data, arch);
if (status.Fail())
return status.ToError();
thread_data.name.assign (prpsinfo.pr_fname, strnlen (prpsinfo.pr_fname, sizeof (prpsinfo.pr_fname)));
SetID(prpsinfo.pr_pid);
break;
}
case ELF::NT_SIGINFO: {
ELFLinuxSigInfo siginfo;
Status status = siginfo.Parse(note.data, arch);
if (status.Fail())
return status.ToError();
thread_data.signo = siginfo.si_signo;
break;
}
case ELF::NT_FILE: {
m_nt_file_entries.clear();
lldb::offset_t offset = 0;
const uint64_t count = note.data.GetAddress(&offset);
note.data.GetAddress(&offset); // Skip page size
for (uint64_t i = 0; i < count; ++i) {
NT_FILE_Entry entry;
entry.start = note.data.GetAddress(&offset);
entry.end = note.data.GetAddress(&offset);
entry.file_ofs = note.data.GetAddress(&offset);
m_nt_file_entries.push_back(entry);
}
for (uint64_t i = 0; i < count; ++i) {
const char *path = note.data.GetCStr(&offset);
if (path && path[0])
m_nt_file_entries[i].path.SetCString(path);
}
break;
}
case ELF::NT_AUXV:
m_auxv = note.data;
break;
default:
thread_data.notes.push_back(note);
break;
}
}
// Add last entry in the note section
if (have_prstatus)
m_thread_data.push_back(thread_data);
return llvm::Error::success();
}
/// Parse Thread context from PT_NOTE segment and store it in the thread list
/// A note segment consists of one or more NOTE entries, but their types and
/// meaning differ depending on the OS.
llvm::Error ProcessElfCore::ParseThreadContextsFromNoteSegment(
const elf::ELFProgramHeader &segment_header, DataExtractor segment_data) {
assert(segment_header.p_type == llvm::ELF::PT_NOTE);
auto notes_or_error = parseSegment(segment_data);
if(!notes_or_error)
return notes_or_error.takeError();
switch (GetArchitecture().GetTriple().getOS()) {
case llvm::Triple::FreeBSD:
return parseFreeBSDNotes(*notes_or_error);
case llvm::Triple::Linux:
return parseLinuxNotes(*notes_or_error);
case llvm::Triple::NetBSD:
return parseNetBSDNotes(*notes_or_error);
case llvm::Triple::OpenBSD:
return parseOpenBSDNotes(*notes_or_error);
default:
return llvm::make_error<llvm::StringError>(
"Don't know how to parse core file. Unsupported OS.",
llvm::inconvertibleErrorCode());
}
}
uint32_t ProcessElfCore::GetNumThreadContexts() {
if (!m_thread_data_valid)
DoLoadCore();
return m_thread_data.size();
}
ArchSpec ProcessElfCore::GetArchitecture() {
ArchSpec arch = m_core_module_sp->GetObjectFile()->GetArchitecture();
ArchSpec target_arch = GetTarget().GetArchitecture();
arch.MergeFrom(target_arch);
// On MIPS there is no way to differentiate betwenn 32bit and 64bit core
// files and this information can't be merged in from the target arch so we
// fail back to unconditionally returning the target arch in this config.
if (target_arch.IsMIPS()) {
return target_arch;
}
return arch;
}
DataExtractor ProcessElfCore::GetAuxvData() {
const uint8_t *start = m_auxv.GetDataStart();
size_t len = m_auxv.GetByteSize();
lldb::DataBufferSP buffer(new lldb_private::DataBufferHeap(start, len));
return DataExtractor(buffer, GetByteOrder(), GetAddressByteSize());
}
bool ProcessElfCore::GetProcessInfo(ProcessInstanceInfo &info) {
info.Clear();
info.SetProcessID(GetID());
info.SetArchitecture(GetArchitecture());
lldb::ModuleSP module_sp = GetTarget().GetExecutableModule();
if (module_sp) {
const bool add_exe_file_as_first_arg = false;
info.SetExecutableFile(GetTarget().GetExecutableModule()->GetFileSpec(),
add_exe_file_as_first_arg);
}
return true;
}
|