LLDB mainline
ProcessMachCore.cpp
Go to the documentation of this file.
1//===-- ProcessMachCore.cpp -----------------------------------------------===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
9#include <cerrno>
10#include <cstdlib>
11
12#include "llvm/Support/MathExtras.h"
13#include "llvm/Support/Threading.h"
14
15#include "lldb/Core/Debugger.h"
16#include "lldb/Core/Module.h"
19#include "lldb/Core/Section.h"
20#include "lldb/Host/Host.h"
25#include "lldb/Target/Target.h"
26#include "lldb/Target/Thread.h"
29#include "lldb/Utility/Log.h"
30#include "lldb/Utility/State.h"
31
32#include "ProcessMachCore.h"
34#include "ThreadMachCore.h"
35
36// Needed for the plug-in names for the dynamic loaders.
37#include "lldb/Host/SafeMachO.h"
38
44
45#include <memory>
46#include <mutex>
47
48using namespace lldb;
49using namespace lldb_private;
50
52
53llvm::StringRef ProcessMachCore::GetPluginDescriptionStatic() {
54 return "Mach-O core file debugging plug-in.";
55}
56
59}
60
61lldb::ProcessSP ProcessMachCore::CreateInstance(lldb::TargetSP target_sp,
62 ListenerSP listener_sp,
63 const FileSpec *crash_file,
64 bool can_connect) {
65 lldb::ProcessSP process_sp;
66 if (crash_file && !can_connect) {
67 const size_t header_size = sizeof(llvm::MachO::mach_header);
69 crash_file->GetPath(), header_size, 0);
70 if (data_sp && data_sp->GetByteSize() == header_size) {
71 DataExtractor data(data_sp, lldb::eByteOrderLittle, 4);
72
73 lldb::offset_t data_offset = 0;
74 llvm::MachO::mach_header mach_header;
75 if (ObjectFileMachO::ParseHeader(data, &data_offset, mach_header)) {
76 if (mach_header.filetype == llvm::MachO::MH_CORE)
77 process_sp = std::make_shared<ProcessMachCore>(target_sp, listener_sp,
78 *crash_file);
79 }
80 }
81 }
82 return process_sp;
83}
84
85bool ProcessMachCore::CanDebug(lldb::TargetSP target_sp,
86 bool plugin_specified_by_name) {
87 if (plugin_specified_by_name)
88 return true;
89
90 // For now we are just making sure the file exists for a given module
92 // Don't add the Target's architecture to the ModuleSpec - we may be
93 // working with a core file that doesn't have the correct cpusubtype in the
94 // header but we should still try to use it -
95 // ModuleSpecList::FindMatchingModuleSpec enforces a strict arch mach.
96 ModuleSpec core_module_spec(m_core_file);
98 nullptr, nullptr, nullptr));
99
100 if (m_core_module_sp) {
101 ObjectFile *core_objfile = m_core_module_sp->GetObjectFile();
102 if (core_objfile && core_objfile->GetType() == ObjectFile::eTypeCoreFile)
103 return true;
104 }
105 }
106 return false;
107}
108
109// ProcessMachCore constructor
110ProcessMachCore::ProcessMachCore(lldb::TargetSP target_sp,
111 ListenerSP listener_sp,
112 const FileSpec &core_file)
113 : PostMortemProcess(target_sp, listener_sp), m_core_aranges(),
114 m_core_range_infos(), m_core_module_sp(), m_core_file(core_file),
115 m_dyld_addr(LLDB_INVALID_ADDRESS),
116 m_mach_kernel_addr(LLDB_INVALID_ADDRESS) {}
117
118// Destructor
120 Clear();
121 // We need to call finalize on the process before destroying ourselves to
122 // make sure all of the broadcaster cleanup goes as planned. If we destruct
123 // this class, then Process::~Process() might have problems trying to fully
124 // destroy the broadcaster.
125 Finalize();
126}
127
129 addr_t &dyld,
130 addr_t &kernel) {
131 Log *log(GetLog(LLDBLog::DynamicLoader | LLDBLog::Process));
132 llvm::MachO::mach_header header;
134 dyld = kernel = LLDB_INVALID_ADDRESS;
135 if (DoReadMemory(addr, &header, sizeof(header), error) != sizeof(header))
136 return false;
137 if (header.magic == llvm::MachO::MH_CIGAM ||
138 header.magic == llvm::MachO::MH_CIGAM_64) {
139 header.magic = llvm::byteswap<uint32_t>(header.magic);
140 header.cputype = llvm::byteswap<uint32_t>(header.cputype);
141 header.cpusubtype = llvm::byteswap<uint32_t>(header.cpusubtype);
142 header.filetype = llvm::byteswap<uint32_t>(header.filetype);
143 header.ncmds = llvm::byteswap<uint32_t>(header.ncmds);
144 header.sizeofcmds = llvm::byteswap<uint32_t>(header.sizeofcmds);
145 header.flags = llvm::byteswap<uint32_t>(header.flags);
146 }
147
148 if (header.magic == llvm::MachO::MH_MAGIC ||
149 header.magic == llvm::MachO::MH_MAGIC_64) {
150 // Check MH_EXECUTABLE to see if we can find the mach image that contains
151 // the shared library list. The dynamic loader (dyld) is what contains the
152 // list for user applications, and the mach kernel contains a global that
153 // has the list of kexts to load
154 switch (header.filetype) {
155 case llvm::MachO::MH_DYLINKER:
156 LLDB_LOGF(log,
157 "ProcessMachCore::%s found a user "
158 "process dyld binary image at 0x%" PRIx64,
159 __FUNCTION__, addr);
160 dyld = addr;
161 return true;
162
163 case llvm::MachO::MH_EXECUTE:
164 // Check MH_EXECUTABLE file types to see if the dynamic link object flag
165 // is NOT set. If it isn't, then we have a mach_kernel.
166 if ((header.flags & llvm::MachO::MH_DYLDLINK) == 0) {
167 LLDB_LOGF(log,
168 "ProcessMachCore::%s found a mach "
169 "kernel binary image at 0x%" PRIx64,
170 __FUNCTION__, addr);
171 // Address of the mach kernel "struct mach_header" in the core file.
172 kernel = addr;
173 return true;
174 }
175 break;
176 }
177 }
178 return false;
179}
180
182 ObjectFile *core_objfile = m_core_module_sp->GetObjectFile();
183 SectionList *section_list = core_objfile->GetSectionList();
184 const uint32_t num_sections = section_list->GetNumSections(0);
185
186 bool ranges_are_sorted = true;
187 addr_t vm_addr = 0;
188 for (uint32_t i = 0; i < num_sections; ++i) {
189 Section *section = section_list->GetSectionAtIndex(i).get();
190 if (section && section->GetFileSize() > 0) {
191 lldb::addr_t section_vm_addr = section->GetFileAddress();
192 FileRange file_range(section->GetFileOffset(), section->GetFileSize());
193 VMRangeToFileOffset::Entry range_entry(
194 section_vm_addr, section->GetByteSize(), file_range);
195
196 if (vm_addr > section_vm_addr)
197 ranges_are_sorted = false;
198 vm_addr = section->GetFileAddress();
200
201 if (last_entry &&
202 last_entry->GetRangeEnd() == range_entry.GetRangeBase() &&
203 last_entry->data.GetRangeEnd() == range_entry.data.GetRangeBase()) {
204 last_entry->SetRangeEnd(range_entry.GetRangeEnd());
205 last_entry->data.SetRangeEnd(range_entry.data.GetRangeEnd());
206 } else {
207 m_core_aranges.Append(range_entry);
208 }
209 // Some core files don't fill in the permissions correctly. If that is
210 // the case assume read + execute so clients don't think the memory is
211 // not readable, or executable. The memory isn't writable since this
212 // plug-in doesn't implement DoWriteMemory.
213 uint32_t permissions = section->GetPermissions();
214 if (permissions == 0)
215 permissions = lldb::ePermissionsReadable | lldb::ePermissionsExecutable;
217 section_vm_addr, section->GetByteSize(), permissions));
218 }
219 }
220 if (!ranges_are_sorted) {
223 }
224}
225
227 Log *log(GetLog(LLDBLog::DynamicLoader | LLDBLog::Process));
228 ObjectFile *core_objfile = m_core_module_sp->GetObjectFile();
229 bool found_main_binary_definitively = false;
230
231 addr_t objfile_binary_value;
232 bool objfile_binary_value_is_offset;
233 UUID objfile_binary_uuid;
235
236 if (core_objfile->GetCorefileMainBinaryInfo(objfile_binary_value,
237 objfile_binary_value_is_offset,
238 objfile_binary_uuid, type)) {
239 if (log) {
240 log->Printf("ProcessMachCore::LoadBinariesViaMetadata: using binary hint "
241 "from 'main bin spec' "
242 "LC_NOTE with UUID %s value 0x%" PRIx64
243 " value is offset %d and type %d",
244 objfile_binary_uuid.GetAsString().c_str(),
245 objfile_binary_value, objfile_binary_value_is_offset, type);
246 }
247
248 // If this is the xnu kernel, don't load it now. Note the correct
249 // DynamicLoader plugin to use, and the address of the kernel, and
250 // let the DynamicLoader handle the finding & loading of the binary.
251 if (type == ObjectFile::eBinaryTypeKernel) {
252 m_mach_kernel_addr = objfile_binary_value;
254 found_main_binary_definitively = true;
255 } else {
256 const bool force_symbol_search = true;
257 const bool notify = true;
259 this, llvm::StringRef(), objfile_binary_uuid,
260 objfile_binary_value, objfile_binary_value_is_offset,
261 force_symbol_search, notify)) {
262 found_main_binary_definitively = true;
264 }
265 if (type == ObjectFile::eBinaryTypeUser) {
266 m_dyld_addr = objfile_binary_value;
268 }
269 }
270 }
271
272 // This checks for the presence of an LC_IDENT string in a core file;
273 // LC_IDENT is very obsolete and should not be used in new code, but if the
274 // load command is present, let's use the contents.
275 UUID ident_uuid;
276 addr_t ident_binary_addr = LLDB_INVALID_ADDRESS;
277 if (!found_main_binary_definitively) {
278 std::string corefile_identifier = core_objfile->GetIdentifierString();
279
280 // Search for UUID= and stext= strings in the identifier str.
281 if (corefile_identifier.find("UUID=") != std::string::npos) {
282 size_t p = corefile_identifier.find("UUID=") + strlen("UUID=");
283 std::string uuid_str = corefile_identifier.substr(p, 36);
284 ident_uuid.SetFromStringRef(uuid_str);
285 if (log)
286 log->Printf("Got a UUID from LC_IDENT/kern ver str LC_NOTE: %s",
287 ident_uuid.GetAsString().c_str());
288 }
289 if (corefile_identifier.find("stext=") != std::string::npos) {
290 size_t p = corefile_identifier.find("stext=") + strlen("stext=");
291 if (corefile_identifier[p] == '0' && corefile_identifier[p + 1] == 'x') {
292 ident_binary_addr =
293 ::strtoul(corefile_identifier.c_str() + p, nullptr, 16);
294 if (log)
295 log->Printf("Got a load address from LC_IDENT/kern ver str "
296 "LC_NOTE: 0x%" PRIx64,
297 ident_binary_addr);
298 }
299 }
300
301 // Search for a "Darwin Kernel" str indicating kernel; else treat as
302 // standalone
303 if (corefile_identifier.find("Darwin Kernel") != std::string::npos &&
304 ident_uuid.IsValid() && ident_binary_addr != LLDB_INVALID_ADDRESS) {
305 if (log)
306 log->Printf(
307 "ProcessMachCore::LoadBinariesViaMetadata: Found kernel binary via "
308 "LC_IDENT/kern ver str LC_NOTE");
309 m_mach_kernel_addr = ident_binary_addr;
310 found_main_binary_definitively = true;
311 } else if (ident_uuid.IsValid()) {
312 // We have no address specified, only a UUID. Load it at the file
313 // address.
314 const bool value_is_offset = false;
315 const bool force_symbol_search = true;
316 const bool notify = true;
318 this, llvm::StringRef(), ident_uuid, ident_binary_addr,
319 value_is_offset, force_symbol_search, notify)) {
320 found_main_binary_definitively = true;
322 }
323 }
324 }
325
326 // Finally, load any binaries noted by "load binary" LC_NOTEs in the
327 // corefile
328 core_objfile->LoadCoreFileImages(*this);
329
330 // LoadCoreFileImges may have set the dynamic loader, e.g. in
331 // PlatformDarwinKernel::LoadPlatformBinaryAndSetup().
332 // If we now have a dynamic loader, save its name so we don't
333 // un-set it later.
334 if (m_dyld_up)
336}
337
339 Log *log(GetLog(LLDBLog::DynamicLoader | LLDBLog::Process));
340
341 // Search the pages of the corefile for dyld or mach kernel
342 // binaries. There may be multiple things that look like a kernel
343 // in the corefile; disambiguating to the correct one can be difficult.
344
345 std::vector<addr_t> dylds_found;
346 std::vector<addr_t> kernels_found;
347
348 const size_t num_core_aranges = m_core_aranges.GetSize();
349 for (size_t i = 0; i < num_core_aranges; ++i) {
351 lldb::addr_t section_vm_addr_start = entry->GetRangeBase();
352 lldb::addr_t section_vm_addr_end = entry->GetRangeEnd();
353 for (lldb::addr_t section_vm_addr = section_vm_addr_start;
354 section_vm_addr < section_vm_addr_end; section_vm_addr += 0x1000) {
355 addr_t dyld, kernel;
356 if (CheckAddressForDyldOrKernel(section_vm_addr, dyld, kernel)) {
357 if (dyld != LLDB_INVALID_ADDRESS)
358 dylds_found.push_back(dyld);
359 if (kernel != LLDB_INVALID_ADDRESS)
360 kernels_found.push_back(kernel);
361 }
362 }
363 }
364
365 // If we found more than one dyld mach-o header in the corefile,
366 // pick the first one.
367 if (dylds_found.size() > 0)
368 m_dyld_addr = dylds_found[0];
369 if (kernels_found.size() > 0)
370 m_mach_kernel_addr = kernels_found[0];
371
372 // Zero or one kernels found, we're done.
373 if (kernels_found.size() < 2)
374 return;
375
376 // In the case of multiple kernel images found in the core file via
377 // exhaustive search, we may not pick the correct one. See if the
378 // DynamicLoaderDarwinKernel's search heuristics might identify the correct
379 // one.
380
381 // SearchForDarwinKernel will call this class' GetImageInfoAddress method
382 // which will give it the addresses we already have.
383 // Save those aside and set
384 // m_mach_kernel_addr/m_dyld_addr to an invalid address temporarily so
385 // DynamicLoaderDarwinKernel does a real search for the kernel using its
386 // own heuristics.
387
388 addr_t saved_mach_kernel_addr = m_mach_kernel_addr;
389 addr_t saved_user_dyld_addr = m_dyld_addr;
392
393 addr_t better_kernel_address =
395
396 m_mach_kernel_addr = saved_mach_kernel_addr;
397 m_dyld_addr = saved_user_dyld_addr;
398
399 if (better_kernel_address != LLDB_INVALID_ADDRESS) {
400 LLDB_LOGF(log,
401 "ProcessMachCore::%s: Using "
402 "the kernel address "
403 "from DynamicLoaderDarwinKernel",
404 __FUNCTION__);
405 m_mach_kernel_addr = better_kernel_address;
406 }
407}
408
410 Log *log(GetLog(LLDBLog::DynamicLoader | LLDBLog::Process));
411
413 if (m_dyld_plugin_name.empty())
415
416 if (m_dyld_plugin_name.empty()) {
417 // If we found both a user-process dyld and a kernel binary, we need to
418 // decide which to prefer.
421 LLDB_LOGF(log,
422 "ProcessMachCore::%s: Using kernel "
423 "corefile image "
424 "at 0x%" PRIx64,
425 __FUNCTION__, m_mach_kernel_addr);
427 } else if (m_dyld_addr != LLDB_INVALID_ADDRESS) {
428 LLDB_LOGF(log,
429 "ProcessMachCore::%s: Using user process dyld "
430 "image at 0x%" PRIx64,
431 __FUNCTION__, m_dyld_addr);
433 }
434 } else {
436 LLDB_LOGF(log,
437 "ProcessMachCore::%s: Using user process dyld "
438 "image at 0x%" PRIx64,
439 __FUNCTION__, m_dyld_addr);
442 LLDB_LOGF(log,
443 "ProcessMachCore::%s: Using kernel "
444 "corefile image "
445 "at 0x%" PRIx64,
446 __FUNCTION__, m_mach_kernel_addr);
448 }
449 }
450 }
451}
452
455 // For non-user process core files, the permissions on the core file
456 // segments are usually meaningless, they may be just "read", because we're
457 // dealing with kernel coredumps or early startup coredumps and the dumper
458 // is grabbing pages of memory without knowing what they are. If they
459 // aren't marked as "executable", that can break the unwinder which will
460 // check a pc value to see if it is in an executable segment and stop the
461 // backtrace early if it is not ("executable" and "unknown" would both be
462 // fine, but "not executable" will break the unwinder).
463 size_t core_range_infos_size = m_core_range_infos.GetSize();
464 for (size_t i = 0; i < core_range_infos_size; i++) {
467 ent->data = lldb::ePermissionsReadable | lldb::ePermissionsExecutable;
468 }
469 }
470}
471
472// Process Control
475 if (!m_core_module_sp) {
476 error.SetErrorString("invalid core module");
477 return error;
478 }
479
480 ObjectFile *core_objfile = m_core_module_sp->GetObjectFile();
481 if (core_objfile == nullptr) {
482 error.SetErrorString("invalid core object file");
483 return error;
484 }
485
486 SetCanJIT(false);
487
488 // The corefile's architecture is our best starting point.
489 ArchSpec arch(m_core_module_sp->GetArchitecture());
490 if (arch.IsValid())
492
494
496
498
499 addr_t address_mask = core_objfile->GetAddressMask();
500 if (address_mask != 0) {
501 SetCodeAddressMask(address_mask);
502 SetDataAddressMask(address_mask);
503 }
504 return error;
505}
506
508 if (m_dyld_up.get() == nullptr)
510 return m_dyld_up.get();
511}
512
514 ThreadList &new_thread_list) {
515 if (old_thread_list.GetSize(false) == 0) {
516 // Make up the thread the first time this is called so we can setup our one
517 // and only core thread state.
518 ObjectFile *core_objfile = m_core_module_sp->GetObjectFile();
519
520 if (core_objfile) {
521 const uint32_t num_threads = core_objfile->GetNumThreadContexts();
522 for (lldb::tid_t tid = 0; tid < num_threads; ++tid) {
523 ThreadSP thread_sp(new ThreadMachCore(*this, tid));
524 new_thread_list.AddThread(thread_sp);
525 }
526 }
527 } else {
528 const uint32_t num_threads = old_thread_list.GetSize(false);
529 for (uint32_t i = 0; i < num_threads; ++i)
530 new_thread_list.AddThread(old_thread_list.GetThreadAtIndex(i, false));
531 }
532 return new_thread_list.GetSize(false) > 0;
533}
534
536 // Let all threads recover from stopping and do any clean up based on the
537 // previous thread state (if any).
539 // SetThreadStopInfo (m_last_stop_packet);
540}
541
543
544// Process Queries
545
546bool ProcessMachCore::IsAlive() { return true; }
547
548bool ProcessMachCore::WarnBeforeDetach() const { return false; }
549
550// Process Memory
551size_t ProcessMachCore::ReadMemory(addr_t addr, void *buf, size_t size,
552 Status &error) {
553 // Don't allow the caching that lldb_private::Process::ReadMemory does since
554 // in core files we have it all cached our our core file anyway.
555 return DoReadMemory(addr, buf, size, error);
556}
557
558size_t ProcessMachCore::DoReadMemory(addr_t addr, void *buf, size_t size,
559 Status &error) {
560 ObjectFile *core_objfile = m_core_module_sp->GetObjectFile();
561 size_t bytes_read = 0;
562
563 if (core_objfile) {
564 // Segments are not always contiguous in mach-o core files. We have core
565 // files that have segments like:
566 // Address Size File off File size
567 // ---------- ---------- ---------- ----------
568 // LC_SEGMENT 0x000f6000 0x00001000 0x1d509ee8 0x00001000 --- --- 0
569 // 0x00000000 __TEXT LC_SEGMENT 0x0f600000 0x00100000 0x1d50aee8 0x00100000
570 // --- --- 0 0x00000000 __TEXT LC_SEGMENT 0x000f7000 0x00001000
571 // 0x1d60aee8 0x00001000 --- --- 0 0x00000000 __TEXT
572 //
573 // Any if the user executes the following command:
574 //
575 // (lldb) mem read 0xf6ff0
576 //
577 // We would attempt to read 32 bytes from 0xf6ff0 but would only get 16
578 // unless we loop through consecutive memory ranges that are contiguous in
579 // the address space, but not in the file data.
580 while (bytes_read < size) {
581 const addr_t curr_addr = addr + bytes_read;
582 const VMRangeToFileOffset::Entry *core_memory_entry =
584
585 if (core_memory_entry) {
586 const addr_t offset = curr_addr - core_memory_entry->GetRangeBase();
587 const addr_t bytes_left = core_memory_entry->GetRangeEnd() - curr_addr;
588 const size_t bytes_to_read =
589 std::min(size - bytes_read, (size_t)bytes_left);
590 const size_t curr_bytes_read = core_objfile->CopyData(
591 core_memory_entry->data.GetRangeBase() + offset, bytes_to_read,
592 (char *)buf + bytes_read);
593 if (curr_bytes_read == 0)
594 break;
595 bytes_read += curr_bytes_read;
596 } else {
597 // Only set the error if we didn't read any bytes
598 if (bytes_read == 0)
599 error.SetErrorStringWithFormat(
600 "core file does not contain 0x%" PRIx64, curr_addr);
601 break;
602 }
603 }
604 }
605
606 return bytes_read;
607}
608
610 MemoryRegionInfo &region_info) {
611 region_info.Clear();
612 const VMRangeToPermissions::Entry *permission_entry =
614 if (permission_entry) {
615 if (permission_entry->Contains(load_addr)) {
616 region_info.GetRange().SetRangeBase(permission_entry->GetRangeBase());
617 region_info.GetRange().SetRangeEnd(permission_entry->GetRangeEnd());
618 const Flags permissions(permission_entry->data);
619 region_info.SetReadable(permissions.Test(ePermissionsReadable)
622 region_info.SetWritable(permissions.Test(ePermissionsWritable)
625 region_info.SetExecutable(permissions.Test(ePermissionsExecutable)
629 } else if (load_addr < permission_entry->GetRangeBase()) {
630 region_info.GetRange().SetRangeBase(load_addr);
631 region_info.GetRange().SetRangeEnd(permission_entry->GetRangeBase());
635 region_info.SetMapped(MemoryRegionInfo::eNo);
636 }
637 return Status();
638 }
639
640 region_info.GetRange().SetRangeBase(load_addr);
645 region_info.SetMapped(MemoryRegionInfo::eNo);
646 return Status();
647}
648
650
652 static llvm::once_flag g_once_flag;
653
654 llvm::call_once(g_once_flag, []() {
657 });
658}
659
661 // If we found both a user-process dyld and a kernel binary, we need to
662 // decide which to prefer.
665 return m_mach_kernel_addr;
666 }
667 return m_dyld_addr;
668 } else {
670 return m_dyld_addr;
671 }
672 return m_mach_kernel_addr;
673 }
674}
675
677 return m_core_module_sp->GetObjectFile();
678}
static llvm::raw_ostream & error(Stream &strm)
#define LLDB_LOGF(log,...)
Definition: Log.h:344
#define LLDB_PLUGIN_DEFINE(PluginName)
Definition: PluginManager.h:31
static llvm::StringRef GetPluginNameStatic()
static lldb::addr_t SearchForDarwinKernel(lldb_private::Process *process)
static llvm::StringRef GetPluginNameStatic()
static llvm::StringRef GetPluginNameStatic()
bool ParseHeader() override
Attempts to parse the object header.
lldb::addr_t m_dyld_addr
bool WarnBeforeDetach() const override
Before lldb detaches from a process, it warns the user that they are about to lose their debug sessio...
static llvm::StringRef GetPluginDescriptionStatic()
static void Initialize()
size_t ReadMemory(lldb::addr_t addr, void *buf, size_t size, lldb_private::Status &error) override
Read of memory from a process.
VMRangeToFileOffset m_core_aranges
friend class ThreadMachCore
void LoadBinariesViaMetadata()
size_t DoReadMemory(lldb::addr_t addr, void *buf, size_t size, lldb_private::Status &error) override
Actually do the reading of memory from a process.
CorefilePreference GetCorefilePreference()
If a core file can be interpreted multiple ways, this establishes which style wins.
bool CanDebug(lldb::TargetSP target_sp, bool plugin_specified_by_name) override
Check if a plug-in instance can debug the file in module.
void CleanupMemoryRegionPermissions()
lldb_private::ObjectFile * GetCoreObjectFile()
ProcessMachCore(lldb::TargetSP target_sp, lldb::ListenerSP listener, const lldb_private::FileSpec &core_file)
llvm::StringRef m_dyld_plugin_name
lldb_private::DynamicLoader * GetDynamicLoader() override
Get the dynamic loader plug-in for this process.
lldb_private::Status DoDestroy() override
static lldb::ProcessSP CreateInstance(lldb::TargetSP target_sp, lldb::ListenerSP listener, const lldb_private::FileSpec *crash_file_path, bool can_connect)
void RefreshStateAfterStop() override
Currently called as part of ShouldStop.
bool DoUpdateThreadList(lldb_private::ThreadList &old_thread_list, lldb_private::ThreadList &new_thread_list) override
Update the thread list following process plug-in's specific logic.
static llvm::StringRef GetPluginNameStatic()
bool IsAlive() override
Check if a process is still alive.
bool CheckAddressForDyldOrKernel(lldb::addr_t addr, lldb::addr_t &dyld, lldb::addr_t &kernel)
VMRangeToPermissions m_core_range_infos
lldb_private::Status DoLoadCore() override
void LoadBinariesViaExhaustiveSearch()
lldb_private::FileSpec m_core_file
lldb::addr_t m_mach_kernel_addr
lldb::addr_t GetImageInfoAddress() override
Get the image information address for the current process.
~ProcessMachCore() override
lldb::ModuleSP m_core_module_sp
lldb_private::Status DoGetMemoryRegionInfo(lldb::addr_t load_addr, lldb_private::MemoryRegionInfo &region_info) override
DoGetMemoryRegionInfo is called by GetMemoryRegionInfo after it has removed non address bits from loa...
static void Terminate()
An architecture specification class.
Definition: ArchSpec.h:32
bool IsValid() const
Tests if this ArchSpec is valid.
Definition: ArchSpec.h:361
An data extractor class.
Definition: DataExtractor.h:48
A plug-in interface definition class for dynamic loaders.
Definition: DynamicLoader.h:52
static lldb::ModuleSP LoadBinaryWithUUIDAndAddress(Process *process, llvm::StringRef name, UUID uuid, lldb::addr_t value, bool value_is_offset, bool force_symbol_search, bool notify)
Find/load a binary into lldb given a UUID and the address where it is loaded in memory,...
static DynamicLoader * FindPlugin(Process *process, llvm::StringRef plugin_name)
Find a dynamic loader plugin for a given process.
A file utility class.
Definition: FileSpec.h:56
size_t GetPath(char *path, size_t max_path_length, bool denormalize=true) const
Extract the full path to the file.
Definition: FileSpec.cpp:366
static FileSystem & Instance()
std::shared_ptr< DataBuffer > CreateDataBuffer(const llvm::Twine &path, uint64_t size=0, uint64_t offset=0)
Create memory buffer from path.
A class to manage flags.
Definition: Flags.h:22
bool Test(ValueType bit) const
Test a single flag bit.
Definition: Flags.h:96
void Printf(const char *format,...) __attribute__((format(printf
Prefer using LLDB_LOGF whenever possible.
Definition: Log.cpp:138
void SetMapped(OptionalBool val)
void SetReadable(OptionalBool val)
void SetExecutable(OptionalBool val)
void SetWritable(OptionalBool val)
static Status GetSharedModule(const ModuleSpec &module_spec, lldb::ModuleSP &module_sp, const FileSpecList *module_search_paths_ptr, llvm::SmallVectorImpl< lldb::ModuleSP > *old_modules, bool *did_create_ptr, bool always_create=false)
Definition: ModuleList.cpp:786
A plug-in interface definition class for object file parsers.
Definition: ObjectFile.h:62
virtual std::string GetIdentifierString()
Some object files may have an identifier string embedded in them, e.g.
Definition: ObjectFile.h:510
virtual uint32_t GetNumThreadContexts()
Definition: ObjectFile.h:501
virtual bool LoadCoreFileImages(lldb_private::Process &process)
Load binaries listed in a corefile.
Definition: ObjectFile.h:718
@ eTypeCoreFile
A core file that has a checkpoint of a program's execution state.
Definition: ObjectFile.h:69
size_t CopyData(lldb::offset_t offset, size_t length, void *dst) const
Definition: ObjectFile.cpp:467
virtual SectionList * GetSectionList(bool update_module_section_list=true)
Gets the section list for the currently selected architecture (and object for archives).
Definition: ObjectFile.cpp:588
virtual lldb::addr_t GetAddressMask()
Some object files may have the number of bits used for addressing embedded in them,...
Definition: ObjectFile.h:522
virtual bool GetCorefileMainBinaryInfo(lldb::addr_t &value, bool &value_is_offset, UUID &uuid, ObjectFile::BinaryType &type)
When the ObjectFile is a core file, lldb needs to locate the "binary" in the core file.
Definition: ObjectFile.h:550
BinaryType
If we have a corefile binary hint, this enum specifies the binary type which we can use to select the...
Definition: ObjectFile.h:99
@ eBinaryTypeUser
kernel binary
Definition: ObjectFile.h:103
virtual llvm::StringRef GetPluginName()=0
static bool RegisterPlugin(llvm::StringRef name, llvm::StringRef description, ABICreateInstance create_callback)
static bool UnregisterPlugin(ABICreateInstance create_callback)
Base class for all processes that don't represent a live process, such as coredumps or processes trac...
virtual void Finalize()
This object is about to be destroyed, do any necessary cleanup.
Definition: Process.cpp:513
void SetCodeAddressMask(lldb::addr_t code_address_mask)
Definition: Process.h:1371
void SetCanJIT(bool can_jit)
Sets whether executing JIT-compiled code in this process is possible.
Definition: Process.cpp:2329
lldb::DynamicLoaderUP m_dyld_up
Definition: Process.h:2913
void SetDataAddressMask(lldb::addr_t data_address_mask)
Definition: Process.h:1375
ThreadList m_thread_list
The threads for this process as the user will see them.
Definition: Process.h:2889
Target & GetTarget()
Get the target object pointer for this module.
Definition: Process.h:1219
const Entry * GetEntryAtIndex(size_t i) const
Definition: RangeMap.h:528
Entry * GetMutableEntryAtIndex(size_t i)
Definition: RangeMap.h:532
const Entry * FindEntryThatContainsOrFollows(B addr) const
Definition: RangeMap.h:614
void Append(const Entry &entry)
Definition: RangeMap.h:451
Entry * FindEntryThatContains(B addr)
Definition: RangeMap.h:563
size_t GetNumSections(uint32_t depth) const
Definition: Section.cpp:527
lldb::SectionSP GetSectionAtIndex(size_t idx) const
Definition: Section.cpp:538
uint32_t GetPermissions() const
Get the permissions as OR'ed bits from lldb::Permissions.
Definition: Section.cpp:354
lldb::offset_t GetFileOffset() const
Definition: Section.h:146
lldb::addr_t GetFileAddress() const
Definition: Section.cpp:189
lldb::addr_t GetByteSize() const
Definition: Section.h:162
lldb::offset_t GetFileSize() const
Definition: Section.h:152
An error handling class.
Definition: Status.h:44
bool SetArchitecture(const ArchSpec &arch_spec, bool set_platform=false, bool merge=true)
Set the architecture for this target.
Definition: Target.cpp:1488
void AddThread(const lldb::ThreadSP &thread_sp)
uint32_t GetSize(bool can_update=true)
Definition: ThreadList.cpp:83
lldb::ThreadSP GetThreadAtIndex(uint32_t idx, bool can_update=true)
Definition: ThreadList.cpp:91
bool SetFromStringRef(llvm::StringRef str)
Definition: UUID.cpp:97
std::string GetAsString(llvm::StringRef separator="-") const
Definition: UUID.cpp:49
bool IsValid() const
Definition: UUID.h:69
#define LLDB_INVALID_ADDRESS
Definition: lldb-defines.h:74
A class that represents a running process on the host machine.
Log * GetLog(Cat mask)
Retrieve the Log object for the channel associated with the given log enum.
Definition: Log.h:309
Definition: SBAddress.h:15
uint64_t offset_t
Definition: lldb-types.h:87
@ eByteOrderLittle
uint64_t addr_t
Definition: lldb-types.h:83
uint64_t tid_t
Definition: lldb-types.h:86
Definition: Debugger.h:51
bool Contains(BaseType r) const
Definition: RangeMap.h:93
BaseType GetRangeBase() const
Definition: RangeMap.h:46
void SetRangeEnd(BaseType end)
Definition: RangeMap.h:80
void SetRangeBase(BaseType b)
Definition: RangeMap.h:48
BaseType GetRangeEnd() const
Definition: RangeMap.h:78