LLDB mainline
ObjectFileMachO.cpp
Go to the documentation of this file.
1//===-- ObjectFileMachO.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 "llvm/ADT/ScopeExit.h"
10#include "llvm/ADT/StringRef.h"
11
16#include "lldb/Core/Debugger.h"
17#include "lldb/Core/Module.h"
20#include "lldb/Core/Progress.h"
21#include "lldb/Core/Section.h"
22#include "lldb/Host/Host.h"
28#include "lldb/Target/Process.h"
30#include "lldb/Target/Target.h"
31#include "lldb/Target/Thread.h"
38#include "lldb/Utility/Log.h"
41#include "lldb/Utility/Status.h"
43#include "lldb/Utility/Timer.h"
44#include "lldb/Utility/UUID.h"
45
46#include "lldb/Host/SafeMachO.h"
47
48#include "llvm/ADT/DenseSet.h"
49#include "llvm/Support/FormatVariadic.h"
50#include "llvm/Support/MemoryBuffer.h"
51
52#include "ObjectFileMachO.h"
53
54#if defined(__APPLE__)
55#include <TargetConditionals.h>
56// GetLLDBSharedCacheUUID() needs to call dlsym()
57#include <dlfcn.h>
58#include <mach/mach_init.h>
59#include <mach/vm_map.h>
60#include <lldb/Host/SafeMachO.h>
61#endif
62
63#ifndef __APPLE__
65#else
66#include <uuid/uuid.h>
67#endif
68
69#include <bitset>
70#include <memory>
71#include <optional>
72
73// Unfortunately the signpost header pulls in the system MachO header, too.
74#ifdef CPU_TYPE_ARM
75#undef CPU_TYPE_ARM
76#endif
77#ifdef CPU_TYPE_ARM64
78#undef CPU_TYPE_ARM64
79#endif
80#ifdef CPU_TYPE_ARM64_32
81#undef CPU_TYPE_ARM64_32
82#endif
83#ifdef CPU_TYPE_X86_64
84#undef CPU_TYPE_X86_64
85#endif
86#ifdef MH_DYLINKER
87#undef MH_DYLINKER
88#endif
89#ifdef MH_OBJECT
90#undef MH_OBJECT
91#endif
92#ifdef LC_VERSION_MIN_MACOSX
93#undef LC_VERSION_MIN_MACOSX
94#endif
95#ifdef LC_VERSION_MIN_IPHONEOS
96#undef LC_VERSION_MIN_IPHONEOS
97#endif
98#ifdef LC_VERSION_MIN_TVOS
99#undef LC_VERSION_MIN_TVOS
100#endif
101#ifdef LC_VERSION_MIN_WATCHOS
102#undef LC_VERSION_MIN_WATCHOS
103#endif
104#ifdef LC_BUILD_VERSION
105#undef LC_BUILD_VERSION
106#endif
107#ifdef PLATFORM_MACOS
108#undef PLATFORM_MACOS
109#endif
110#ifdef PLATFORM_MACCATALYST
111#undef PLATFORM_MACCATALYST
112#endif
113#ifdef PLATFORM_IOS
114#undef PLATFORM_IOS
115#endif
116#ifdef PLATFORM_IOSSIMULATOR
117#undef PLATFORM_IOSSIMULATOR
118#endif
119#ifdef PLATFORM_TVOS
120#undef PLATFORM_TVOS
121#endif
122#ifdef PLATFORM_TVOSSIMULATOR
123#undef PLATFORM_TVOSSIMULATOR
124#endif
125#ifdef PLATFORM_WATCHOS
126#undef PLATFORM_WATCHOS
127#endif
128#ifdef PLATFORM_WATCHOSSIMULATOR
129#undef PLATFORM_WATCHOSSIMULATOR
130#endif
131
132#define THUMB_ADDRESS_BIT_MASK 0xfffffffffffffffeull
133using namespace lldb;
134using namespace lldb_private;
135using namespace llvm::MachO;
136
137static constexpr llvm::StringLiteral g_loader_path = "@loader_path";
138static constexpr llvm::StringLiteral g_executable_path = "@executable_path";
139
141
142static void PrintRegisterValue(RegisterContext *reg_ctx, const char *name,
143 const char *alt_name, size_t reg_byte_size,
144 Stream &data) {
145 const RegisterInfo *reg_info = reg_ctx->GetRegisterInfoByName(name);
146 if (reg_info == nullptr)
147 reg_info = reg_ctx->GetRegisterInfoByName(alt_name);
148 if (reg_info) {
150 if (reg_ctx->ReadRegister(reg_info, reg_value)) {
151 if (reg_info->byte_size >= reg_byte_size)
152 data.Write(reg_value.GetBytes(), reg_byte_size);
153 else {
154 data.Write(reg_value.GetBytes(), reg_info->byte_size);
155 for (size_t i = 0, n = reg_byte_size - reg_info->byte_size; i < n; ++i)
156 data.PutChar(0);
157 }
158 return;
159 }
160 }
161 // Just write zeros if all else fails
162 for (size_t i = 0; i < reg_byte_size; ++i)
163 data.PutChar(0);
164}
165
167public:
173
174 void InvalidateAllRegisters() override {
175 // Do nothing... registers are always valid...
176 }
177
179 lldb::offset_t offset = 0;
180 SetError(GPRRegSet, Read, -1);
181 SetError(FPURegSet, Read, -1);
182 SetError(EXCRegSet, Read, -1);
183
184 while (offset < data.GetByteSize()) {
185 int flavor = data.GetU32(&offset);
186 if (flavor == 0)
187 break;
188 uint32_t count = data.GetU32(&offset);
189 switch (flavor) {
190 case GPRRegSet: {
191 uint32_t *gpr_data = reinterpret_cast<uint32_t *>(&gpr.rax);
192 for (uint32_t i = 0; i < count && offset < data.GetByteSize(); ++i)
193 gpr_data[i] = data.GetU32(&offset);
195 } break;
196 case FPURegSet:
197 // TODO: fill in FPU regs....
198 SetError(FPURegSet, Read, -1);
199 break;
200 case EXCRegSet:
201 exc.trapno = data.GetU32(&offset);
202 exc.err = data.GetU32(&offset);
203 exc.faultvaddr = data.GetU64(&offset);
205 break;
206 default:
207 offset += count * 4;
208 break;
209 }
210 }
211 }
212
213 static bool Create_LC_THREAD(Thread *thread, Stream &data) {
214 RegisterContextSP reg_ctx_sp(thread->GetRegisterContext());
215 if (reg_ctx_sp) {
216 RegisterContext *reg_ctx = reg_ctx_sp.get();
217
218 data.PutHex32(GPRRegSet); // Flavor
220 PrintRegisterValue(reg_ctx, "rax", nullptr, 8, data);
221 PrintRegisterValue(reg_ctx, "rbx", nullptr, 8, data);
222 PrintRegisterValue(reg_ctx, "rcx", nullptr, 8, data);
223 PrintRegisterValue(reg_ctx, "rdx", nullptr, 8, data);
224 PrintRegisterValue(reg_ctx, "rdi", nullptr, 8, data);
225 PrintRegisterValue(reg_ctx, "rsi", nullptr, 8, data);
226 PrintRegisterValue(reg_ctx, "rbp", nullptr, 8, data);
227 PrintRegisterValue(reg_ctx, "rsp", nullptr, 8, data);
228 PrintRegisterValue(reg_ctx, "r8", nullptr, 8, data);
229 PrintRegisterValue(reg_ctx, "r9", nullptr, 8, data);
230 PrintRegisterValue(reg_ctx, "r10", nullptr, 8, data);
231 PrintRegisterValue(reg_ctx, "r11", nullptr, 8, data);
232 PrintRegisterValue(reg_ctx, "r12", nullptr, 8, data);
233 PrintRegisterValue(reg_ctx, "r13", nullptr, 8, data);
234 PrintRegisterValue(reg_ctx, "r14", nullptr, 8, data);
235 PrintRegisterValue(reg_ctx, "r15", nullptr, 8, data);
236 PrintRegisterValue(reg_ctx, "rip", nullptr, 8, data);
237 PrintRegisterValue(reg_ctx, "rflags", nullptr, 8, data);
238 PrintRegisterValue(reg_ctx, "cs", nullptr, 8, data);
239 PrintRegisterValue(reg_ctx, "fs", nullptr, 8, data);
240 PrintRegisterValue(reg_ctx, "gs", nullptr, 8, data);
241
242 // // Write out the FPU registers
243 // const size_t fpu_byte_size = sizeof(FPU);
244 // size_t bytes_written = 0;
245 // data.PutHex32 (FPURegSet);
246 // data.PutHex32 (fpu_byte_size/sizeof(uint64_t));
247 // bytes_written += data.PutHex32(0); // uint32_t pad[0]
248 // bytes_written += data.PutHex32(0); // uint32_t pad[1]
249 // bytes_written += WriteRegister (reg_ctx, "fcw", "fctrl", 2,
250 // data); // uint16_t fcw; // "fctrl"
251 // bytes_written += WriteRegister (reg_ctx, "fsw" , "fstat", 2,
252 // data); // uint16_t fsw; // "fstat"
253 // bytes_written += WriteRegister (reg_ctx, "ftw" , "ftag", 1,
254 // data); // uint8_t ftw; // "ftag"
255 // bytes_written += data.PutHex8 (0); // uint8_t pad1;
256 // bytes_written += WriteRegister (reg_ctx, "fop" , NULL, 2,
257 // data); // uint16_t fop; // "fop"
258 // bytes_written += WriteRegister (reg_ctx, "fioff", "ip", 4,
259 // data); // uint32_t ip; // "fioff"
260 // bytes_written += WriteRegister (reg_ctx, "fiseg", NULL, 2,
261 // data); // uint16_t cs; // "fiseg"
262 // bytes_written += data.PutHex16 (0); // uint16_t pad2;
263 // bytes_written += WriteRegister (reg_ctx, "dp", "fooff" , 4,
264 // data); // uint32_t dp; // "fooff"
265 // bytes_written += WriteRegister (reg_ctx, "foseg", NULL, 2,
266 // data); // uint16_t ds; // "foseg"
267 // bytes_written += data.PutHex16 (0); // uint16_t pad3;
268 // bytes_written += WriteRegister (reg_ctx, "mxcsr", NULL, 4,
269 // data); // uint32_t mxcsr;
270 // bytes_written += WriteRegister (reg_ctx, "mxcsrmask", NULL,
271 // 4, data);// uint32_t mxcsrmask;
272 // bytes_written += WriteRegister (reg_ctx, "stmm0", NULL,
273 // sizeof(MMSReg), data);
274 // bytes_written += WriteRegister (reg_ctx, "stmm1", NULL,
275 // sizeof(MMSReg), data);
276 // bytes_written += WriteRegister (reg_ctx, "stmm2", NULL,
277 // sizeof(MMSReg), data);
278 // bytes_written += WriteRegister (reg_ctx, "stmm3", NULL,
279 // sizeof(MMSReg), data);
280 // bytes_written += WriteRegister (reg_ctx, "stmm4", NULL,
281 // sizeof(MMSReg), data);
282 // bytes_written += WriteRegister (reg_ctx, "stmm5", NULL,
283 // sizeof(MMSReg), data);
284 // bytes_written += WriteRegister (reg_ctx, "stmm6", NULL,
285 // sizeof(MMSReg), data);
286 // bytes_written += WriteRegister (reg_ctx, "stmm7", NULL,
287 // sizeof(MMSReg), data);
288 // bytes_written += WriteRegister (reg_ctx, "xmm0" , NULL,
289 // sizeof(XMMReg), data);
290 // bytes_written += WriteRegister (reg_ctx, "xmm1" , NULL,
291 // sizeof(XMMReg), data);
292 // bytes_written += WriteRegister (reg_ctx, "xmm2" , NULL,
293 // sizeof(XMMReg), data);
294 // bytes_written += WriteRegister (reg_ctx, "xmm3" , NULL,
295 // sizeof(XMMReg), data);
296 // bytes_written += WriteRegister (reg_ctx, "xmm4" , NULL,
297 // sizeof(XMMReg), data);
298 // bytes_written += WriteRegister (reg_ctx, "xmm5" , NULL,
299 // sizeof(XMMReg), data);
300 // bytes_written += WriteRegister (reg_ctx, "xmm6" , NULL,
301 // sizeof(XMMReg), data);
302 // bytes_written += WriteRegister (reg_ctx, "xmm7" , NULL,
303 // sizeof(XMMReg), data);
304 // bytes_written += WriteRegister (reg_ctx, "xmm8" , NULL,
305 // sizeof(XMMReg), data);
306 // bytes_written += WriteRegister (reg_ctx, "xmm9" , NULL,
307 // sizeof(XMMReg), data);
308 // bytes_written += WriteRegister (reg_ctx, "xmm10", NULL,
309 // sizeof(XMMReg), data);
310 // bytes_written += WriteRegister (reg_ctx, "xmm11", NULL,
311 // sizeof(XMMReg), data);
312 // bytes_written += WriteRegister (reg_ctx, "xmm12", NULL,
313 // sizeof(XMMReg), data);
314 // bytes_written += WriteRegister (reg_ctx, "xmm13", NULL,
315 // sizeof(XMMReg), data);
316 // bytes_written += WriteRegister (reg_ctx, "xmm14", NULL,
317 // sizeof(XMMReg), data);
318 // bytes_written += WriteRegister (reg_ctx, "xmm15", NULL,
319 // sizeof(XMMReg), data);
320 //
321 // // Fill rest with zeros
322 // for (size_t i=0, n = fpu_byte_size - bytes_written; i<n; ++
323 // i)
324 // data.PutChar(0);
325
326 // Write out the EXC registers
327 data.PutHex32(EXCRegSet);
329 PrintRegisterValue(reg_ctx, "trapno", nullptr, 4, data);
330 PrintRegisterValue(reg_ctx, "err", nullptr, 4, data);
331 PrintRegisterValue(reg_ctx, "faultvaddr", nullptr, 8, data);
332 return true;
333 }
334 return false;
335 }
336
337protected:
338 int DoReadGPR(lldb::tid_t tid, int flavor, GPR &gpr) override { return -1; }
339
340 int DoReadFPU(lldb::tid_t tid, int flavor, FPU &fpu) override { return -1; }
341
342 int DoReadEXC(lldb::tid_t tid, int flavor, EXC &exc) override { return -1; }
343
344 int DoWriteGPR(lldb::tid_t tid, int flavor, const GPR &gpr) override {
345 return 0;
346 }
347
348 int DoWriteFPU(lldb::tid_t tid, int flavor, const FPU &fpu) override {
349 return 0;
350 }
351
352 int DoWriteEXC(lldb::tid_t tid, int flavor, const EXC &exc) override {
353 return 0;
354 }
355};
356
358public:
364
365 void InvalidateAllRegisters() override {
366 // Do nothing... registers are always valid...
367 }
368
370 lldb::offset_t offset = 0;
371 SetError(GPRRegSet, Read, -1);
372 SetError(FPURegSet, Read, -1);
373 SetError(EXCRegSet, Read, -1);
374
375 while (offset < data.GetByteSize()) {
376 int flavor = data.GetU32(&offset);
377 uint32_t count = data.GetU32(&offset);
378 offset_t next_thread_state = offset + (count * 4);
379 switch (flavor) {
380 case GPRAltRegSet:
381 case GPRRegSet: {
382 // r0-r15, plus CPSR
383 uint32_t gpr_buf_count = (sizeof(gpr.r) / sizeof(gpr.r[0])) + 1;
384 if (count == gpr_buf_count) {
385 for (uint32_t i = 0; i < (count - 1); ++i) {
386 gpr.r[i] = data.GetU32(&offset);
387 }
388 gpr.cpsr = data.GetU32(&offset);
389
391 }
392 } break;
393
394 case FPURegSet: {
395 uint8_t *fpu_reg_buf = (uint8_t *)&fpu.floats;
396 const int fpu_reg_buf_size = sizeof(fpu.floats);
397 if (data.ExtractBytes(offset, fpu_reg_buf_size, eByteOrderLittle,
398 fpu_reg_buf) == fpu_reg_buf_size) {
399 offset += fpu_reg_buf_size;
400 fpu.fpscr = data.GetU32(&offset);
402 }
403 } break;
404
405 case EXCRegSet:
406 if (count == 3) {
407 exc.exception = data.GetU32(&offset);
408 exc.fsr = data.GetU32(&offset);
409 exc.far = data.GetU32(&offset);
411 }
412 break;
413 }
414 offset = next_thread_state;
415 }
416 }
417
418 static bool Create_LC_THREAD(Thread *thread, Stream &data) {
419 RegisterContextSP reg_ctx_sp(thread->GetRegisterContext());
420 if (reg_ctx_sp) {
421 RegisterContext *reg_ctx = reg_ctx_sp.get();
422
423 data.PutHex32(GPRRegSet); // Flavor
425 PrintRegisterValue(reg_ctx, "r0", nullptr, 4, data);
426 PrintRegisterValue(reg_ctx, "r1", nullptr, 4, data);
427 PrintRegisterValue(reg_ctx, "r2", nullptr, 4, data);
428 PrintRegisterValue(reg_ctx, "r3", nullptr, 4, data);
429 PrintRegisterValue(reg_ctx, "r4", nullptr, 4, data);
430 PrintRegisterValue(reg_ctx, "r5", nullptr, 4, data);
431 PrintRegisterValue(reg_ctx, "r6", nullptr, 4, data);
432 PrintRegisterValue(reg_ctx, "r7", nullptr, 4, data);
433 PrintRegisterValue(reg_ctx, "r8", nullptr, 4, data);
434 PrintRegisterValue(reg_ctx, "r9", nullptr, 4, data);
435 PrintRegisterValue(reg_ctx, "r10", nullptr, 4, data);
436 PrintRegisterValue(reg_ctx, "r11", nullptr, 4, data);
437 PrintRegisterValue(reg_ctx, "r12", nullptr, 4, data);
438 PrintRegisterValue(reg_ctx, "sp", nullptr, 4, data);
439 PrintRegisterValue(reg_ctx, "lr", nullptr, 4, data);
440 PrintRegisterValue(reg_ctx, "pc", nullptr, 4, data);
441 PrintRegisterValue(reg_ctx, "cpsr", nullptr, 4, data);
442
443 // Write out the EXC registers
444 // data.PutHex32 (EXCRegSet);
445 // data.PutHex32 (EXCWordCount);
446 // WriteRegister (reg_ctx, "exception", NULL, 4, data);
447 // WriteRegister (reg_ctx, "fsr", NULL, 4, data);
448 // WriteRegister (reg_ctx, "far", NULL, 4, data);
449 return true;
450 }
451 return false;
452 }
453
454protected:
455 int DoReadGPR(lldb::tid_t tid, int flavor, GPR &gpr) override { return -1; }
456
457 int DoReadFPU(lldb::tid_t tid, int flavor, FPU &fpu) override { return -1; }
458
459 int DoReadEXC(lldb::tid_t tid, int flavor, EXC &exc) override { return -1; }
460
461 int DoReadDBG(lldb::tid_t tid, int flavor, DBG &dbg) override { return -1; }
462
463 int DoWriteGPR(lldb::tid_t tid, int flavor, const GPR &gpr) override {
464 return 0;
465 }
466
467 int DoWriteFPU(lldb::tid_t tid, int flavor, const FPU &fpu) override {
468 return 0;
469 }
470
471 int DoWriteEXC(lldb::tid_t tid, int flavor, const EXC &exc) override {
472 return 0;
473 }
474
475 int DoWriteDBG(lldb::tid_t tid, int flavor, const DBG &dbg) override {
476 return -1;
477 }
478};
479
481public:
487
488 void InvalidateAllRegisters() override {
489 // Do nothing... registers are always valid...
490 }
491
493 lldb::offset_t offset = 0;
494 SetError(GPRRegSet, Read, -1);
495 SetError(FPURegSet, Read, -1);
496 SetError(EXCRegSet, Read, -1);
497 while (offset < data.GetByteSize()) {
498 int flavor = data.GetU32(&offset);
499 uint32_t count = data.GetU32(&offset);
500 offset_t next_thread_state = offset + (count * 4);
501 switch (flavor) {
502 case GPRRegSet:
503 // x0-x29 + fp + lr + sp + pc (== 33 64-bit registers) plus cpsr (1
504 // 32-bit register)
505 if (count >= (33 * 2) + 1) {
506 for (uint32_t i = 0; i < 29; ++i)
507 gpr.x[i] = data.GetU64(&offset);
508 gpr.fp = data.GetU64(&offset);
509 gpr.lr = data.GetU64(&offset);
510 gpr.sp = data.GetU64(&offset);
511 gpr.pc = data.GetU64(&offset);
512 gpr.cpsr = data.GetU32(&offset);
514 }
515 break;
516 case FPURegSet: {
517 uint8_t *fpu_reg_buf = (uint8_t *)&fpu.v[0];
518 const int fpu_reg_buf_size = sizeof(fpu);
519 if (fpu_reg_buf_size == count * sizeof(uint32_t) &&
520 data.ExtractBytes(offset, fpu_reg_buf_size, eByteOrderLittle,
521 fpu_reg_buf) == fpu_reg_buf_size) {
523 }
524 } break;
525 case EXCRegSet:
526 if (count == 4) {
527 exc.far = data.GetU64(&offset);
528 exc.esr = data.GetU32(&offset);
529 exc.exception = data.GetU32(&offset);
531 }
532 break;
533 }
534 offset = next_thread_state;
535 }
536 }
537
538 static bool Create_LC_THREAD(Thread *thread, Stream &data) {
539 RegisterContextSP reg_ctx_sp(thread->GetRegisterContext());
540 if (reg_ctx_sp) {
541 RegisterContext *reg_ctx = reg_ctx_sp.get();
542
543 data.PutHex32(GPRRegSet); // Flavor
545 PrintRegisterValue(reg_ctx, "x0", nullptr, 8, data);
546 PrintRegisterValue(reg_ctx, "x1", nullptr, 8, data);
547 PrintRegisterValue(reg_ctx, "x2", nullptr, 8, data);
548 PrintRegisterValue(reg_ctx, "x3", nullptr, 8, data);
549 PrintRegisterValue(reg_ctx, "x4", nullptr, 8, data);
550 PrintRegisterValue(reg_ctx, "x5", nullptr, 8, data);
551 PrintRegisterValue(reg_ctx, "x6", nullptr, 8, data);
552 PrintRegisterValue(reg_ctx, "x7", nullptr, 8, data);
553 PrintRegisterValue(reg_ctx, "x8", nullptr, 8, data);
554 PrintRegisterValue(reg_ctx, "x9", nullptr, 8, data);
555 PrintRegisterValue(reg_ctx, "x10", nullptr, 8, data);
556 PrintRegisterValue(reg_ctx, "x11", nullptr, 8, data);
557 PrintRegisterValue(reg_ctx, "x12", nullptr, 8, data);
558 PrintRegisterValue(reg_ctx, "x13", nullptr, 8, data);
559 PrintRegisterValue(reg_ctx, "x14", nullptr, 8, data);
560 PrintRegisterValue(reg_ctx, "x15", nullptr, 8, data);
561 PrintRegisterValue(reg_ctx, "x16", nullptr, 8, data);
562 PrintRegisterValue(reg_ctx, "x17", nullptr, 8, data);
563 PrintRegisterValue(reg_ctx, "x18", nullptr, 8, data);
564 PrintRegisterValue(reg_ctx, "x19", nullptr, 8, data);
565 PrintRegisterValue(reg_ctx, "x20", nullptr, 8, data);
566 PrintRegisterValue(reg_ctx, "x21", nullptr, 8, data);
567 PrintRegisterValue(reg_ctx, "x22", nullptr, 8, data);
568 PrintRegisterValue(reg_ctx, "x23", nullptr, 8, data);
569 PrintRegisterValue(reg_ctx, "x24", nullptr, 8, data);
570 PrintRegisterValue(reg_ctx, "x25", nullptr, 8, data);
571 PrintRegisterValue(reg_ctx, "x26", nullptr, 8, data);
572 PrintRegisterValue(reg_ctx, "x27", nullptr, 8, data);
573 PrintRegisterValue(reg_ctx, "x28", nullptr, 8, data);
574 PrintRegisterValue(reg_ctx, "fp", nullptr, 8, data);
575 PrintRegisterValue(reg_ctx, "lr", nullptr, 8, data);
576 PrintRegisterValue(reg_ctx, "sp", nullptr, 8, data);
577 PrintRegisterValue(reg_ctx, "pc", nullptr, 8, data);
578 PrintRegisterValue(reg_ctx, "cpsr", nullptr, 4, data);
579 data.PutHex32(0); // uint32_t pad at the end
580
581 // Write out the EXC registers
582 data.PutHex32(EXCRegSet);
584 PrintRegisterValue(reg_ctx, "far", nullptr, 8, data);
585 PrintRegisterValue(reg_ctx, "esr", nullptr, 4, data);
586 PrintRegisterValue(reg_ctx, "exception", nullptr, 4, data);
587 return true;
588 }
589 return false;
590 }
591
592protected:
593 int DoReadGPR(lldb::tid_t tid, int flavor, GPR &gpr) override { return -1; }
594
595 int DoReadFPU(lldb::tid_t tid, int flavor, FPU &fpu) override { return -1; }
596
597 int DoReadEXC(lldb::tid_t tid, int flavor, EXC &exc) override { return -1; }
598
599 int DoReadDBG(lldb::tid_t tid, int flavor, DBG &dbg) override { return -1; }
600
601 int DoWriteGPR(lldb::tid_t tid, int flavor, const GPR &gpr) override {
602 return 0;
603 }
604
605 int DoWriteFPU(lldb::tid_t tid, int flavor, const FPU &fpu) override {
606 return 0;
607 }
608
609 int DoWriteEXC(lldb::tid_t tid, int flavor, const EXC &exc) override {
610 return 0;
611 }
612
613 int DoWriteDBG(lldb::tid_t tid, int flavor, const DBG &dbg) override {
614 return -1;
615 }
616};
617
620public:
626
627 void InvalidateAllRegisters() override {
628 // Do nothing... registers are always valid...
629 }
630
632 lldb::offset_t offset = 0;
633 SetError(GPRRegSet, Read, -1);
634 SetError(FPURegSet, Read, -1);
635 SetError(EXCRegSet, Read, -1);
636 SetError(CSRRegSet, Read, -1);
637 while (offset < data.GetByteSize()) {
638 int flavor = data.GetU32(&offset);
639 uint32_t count = data.GetU32(&offset);
640 offset_t next_thread_state = offset + (count * 4);
641 switch (flavor) {
642 case GPRRegSet:
643 // x0-x31 + pc
644 if (count >= 32) {
645 for (uint32_t i = 0; i < 32; ++i)
646 ((uint32_t *)&gpr.x0)[i] = data.GetU32(&offset);
647 gpr.pc = data.GetU32(&offset);
649 }
650 break;
651 case FPURegSet: {
652 // f0-f31 + fcsr
653 if (count >= 32) {
654 for (uint32_t i = 0; i < 32; ++i)
655 ((uint32_t *)&fpr.f0)[i] = data.GetU32(&offset);
656 fpr.fcsr = data.GetU32(&offset);
658 }
659 } break;
660 case EXCRegSet:
661 if (count == 3) {
662 exc.exception = data.GetU32(&offset);
663 exc.fsr = data.GetU32(&offset);
664 exc.far = data.GetU32(&offset);
666 }
667 break;
668 }
669 offset = next_thread_state;
670 }
671 }
672
673 static bool Create_LC_THREAD(Thread *thread, Stream &data) {
674 RegisterContextSP reg_ctx_sp(thread->GetRegisterContext());
675 if (reg_ctx_sp) {
676 RegisterContext *reg_ctx = reg_ctx_sp.get();
677
678 data.PutHex32(GPRRegSet); // Flavor
680 PrintRegisterValue(reg_ctx, "x0", nullptr, 4, data);
681 PrintRegisterValue(reg_ctx, "x1", nullptr, 4, data);
682 PrintRegisterValue(reg_ctx, "x2", nullptr, 4, data);
683 PrintRegisterValue(reg_ctx, "x3", nullptr, 4, data);
684 PrintRegisterValue(reg_ctx, "x4", nullptr, 4, data);
685 PrintRegisterValue(reg_ctx, "x5", nullptr, 4, data);
686 PrintRegisterValue(reg_ctx, "x6", nullptr, 4, data);
687 PrintRegisterValue(reg_ctx, "x7", nullptr, 4, data);
688 PrintRegisterValue(reg_ctx, "x8", nullptr, 4, data);
689 PrintRegisterValue(reg_ctx, "x9", nullptr, 4, data);
690 PrintRegisterValue(reg_ctx, "x10", nullptr, 4, data);
691 PrintRegisterValue(reg_ctx, "x11", nullptr, 4, data);
692 PrintRegisterValue(reg_ctx, "x12", nullptr, 4, data);
693 PrintRegisterValue(reg_ctx, "x13", nullptr, 4, data);
694 PrintRegisterValue(reg_ctx, "x14", nullptr, 4, data);
695 PrintRegisterValue(reg_ctx, "x15", nullptr, 4, data);
696 PrintRegisterValue(reg_ctx, "x16", nullptr, 4, data);
697 PrintRegisterValue(reg_ctx, "x17", nullptr, 4, data);
698 PrintRegisterValue(reg_ctx, "x18", nullptr, 4, data);
699 PrintRegisterValue(reg_ctx, "x19", nullptr, 4, data);
700 PrintRegisterValue(reg_ctx, "x20", nullptr, 4, data);
701 PrintRegisterValue(reg_ctx, "x21", nullptr, 4, data);
702 PrintRegisterValue(reg_ctx, "x22", nullptr, 4, data);
703 PrintRegisterValue(reg_ctx, "x23", nullptr, 4, data);
704 PrintRegisterValue(reg_ctx, "x24", nullptr, 4, data);
705 PrintRegisterValue(reg_ctx, "x25", nullptr, 4, data);
706 PrintRegisterValue(reg_ctx, "x26", nullptr, 4, data);
707 PrintRegisterValue(reg_ctx, "x27", nullptr, 4, data);
708 PrintRegisterValue(reg_ctx, "x28", nullptr, 4, data);
709 PrintRegisterValue(reg_ctx, "x29", nullptr, 4, data);
710 PrintRegisterValue(reg_ctx, "x30", nullptr, 4, data);
711 PrintRegisterValue(reg_ctx, "x31", nullptr, 4, data);
712 PrintRegisterValue(reg_ctx, "pc", nullptr, 4, data);
713 data.PutHex32(0); // uint32_t pad at the end
714
715 // Write out the EXC registers
716 data.PutHex32(EXCRegSet);
718 PrintRegisterValue(reg_ctx, "exception", nullptr, 4, data);
719 PrintRegisterValue(reg_ctx, "fsr", nullptr, 4, data);
720 PrintRegisterValue(reg_ctx, "far", nullptr, 4, data);
721 return true;
722 }
723 return false;
724 }
725
726protected:
727 int DoReadGPR(lldb::tid_t tid, int flavor, GPR &gpr) override { return -1; }
728
729 int DoReadFPU(lldb::tid_t tid, int flavor, FPU &fpu) override { return -1; }
730
731 int DoReadEXC(lldb::tid_t tid, int flavor, EXC &exc) override { return -1; }
732
733 int DoReadCSR(lldb::tid_t tid, int flavor, CSR &csr) override { return -1; }
734
735 int DoWriteGPR(lldb::tid_t tid, int flavor, const GPR &gpr) override {
736 return 0;
737 }
738
739 int DoWriteFPU(lldb::tid_t tid, int flavor, const FPU &fpu) override {
740 return 0;
741 }
742
743 int DoWriteEXC(lldb::tid_t tid, int flavor, const EXC &exc) override {
744 return 0;
745 }
746
747 int DoWriteCSR(lldb::tid_t tid, int flavor, const CSR &csr) override {
748 return 0;
749 }
750};
751
752static uint32_t MachHeaderSizeFromMagic(uint32_t magic) {
753 switch (magic) {
754 case MH_MAGIC:
755 case MH_CIGAM:
756 return sizeof(struct llvm::MachO::mach_header);
757
758 case MH_MAGIC_64:
759 case MH_CIGAM_64:
760 return sizeof(struct llvm::MachO::mach_header_64);
761 break;
762
763 default:
764 break;
765 }
766 return 0;
767}
768
769#define MACHO_NLIST_ARM_SYMBOL_IS_THUMB 0x0008
770
772
778
782
784 DataExtractorSP extractor_sp,
785 lldb::offset_t data_offset,
786 const FileSpec *file,
787 lldb::offset_t file_offset,
788 lldb::offset_t length) {
789 if (!extractor_sp || !extractor_sp->HasData()) {
790 DataBufferSP data_sp = MapFileData(*file, length, file_offset);
791 if (!data_sp)
792 return nullptr;
793 data_offset = 0;
794 extractor_sp = std::make_shared<DataExtractor>(data_sp);
795 }
796
797 if (!ObjectFileMachO::MagicBytesMatch(extractor_sp, data_offset, length))
798 return nullptr;
799
800 // Update the data to contain the entire file if it doesn't already
801 if (extractor_sp->GetByteSize() < length) {
802 DataBufferSP data_sp = MapFileData(*file, length, file_offset);
803 if (!data_sp)
804 return nullptr;
805 data_offset = 0;
806 extractor_sp = std::make_shared<DataExtractor>(data_sp);
807 }
808 auto objfile_up = std::make_unique<ObjectFileMachO>(
809 module_sp, extractor_sp, data_offset, file, file_offset, length);
810 if (!objfile_up || !objfile_up->ParseHeader())
811 return nullptr;
812
813 return objfile_up.release();
814}
815
817 const lldb::ModuleSP &module_sp, WritableDataBufferSP data_sp,
818 const ProcessSP &process_sp, lldb::addr_t header_addr) {
819 DataExtractorSP extractor_sp = std::make_shared<DataExtractor>(data_sp);
820 if (ObjectFileMachO::MagicBytesMatch(extractor_sp, 0,
821 extractor_sp->GetByteSize())) {
822 std::unique_ptr<ObjectFile> objfile_up(
823 new ObjectFileMachO(module_sp, data_sp, process_sp, header_addr));
824 if (objfile_up.get() && objfile_up->ParseHeader())
825 return objfile_up.release();
826 }
827 return nullptr;
828}
829
831 const lldb_private::FileSpec &file, lldb::DataExtractorSP &extractor_sp,
832 lldb::offset_t file_offset, lldb::offset_t length) {
833 if (!extractor_sp || !extractor_sp->HasData())
834 return {};
835
836 ModuleSpecList specs;
837 if (ObjectFileMachO::MagicBytesMatch(extractor_sp, 0,
838 extractor_sp->GetByteSize())) {
839 llvm::MachO::mach_header header;
840 offset_t data_offset = 0;
841 if (ParseHeader(extractor_sp, &data_offset, header)) {
842 size_t header_and_load_cmds =
843 header.sizeofcmds + MachHeaderSizeFromMagic(header.magic);
844 if (header_and_load_cmds >= extractor_sp->GetByteSize()) {
845 DataBufferSP file_data_sp =
846 MapFileData(file, header_and_load_cmds, file_offset);
847 if (file_data_sp)
848 extractor_sp->SetData(file_data_sp);
849 data_offset = MachHeaderSizeFromMagic(header.magic);
850 }
851 if (extractor_sp && extractor_sp->HasData()) {
852 ModuleSpec base_spec;
853 base_spec.GetFileSpec() = file;
854 base_spec.SetObjectOffset(file_offset);
855 base_spec.SetObjectSize(length);
856 GetAllArchSpecs(header, *extractor_sp, data_offset, base_spec, specs);
857 }
858 }
859 }
860 return specs;
861}
862
864 static ConstString g_segment_name_TEXT("__TEXT");
865 return g_segment_name_TEXT;
866}
867
869 static ConstString g_segment_name_DATA("__DATA");
870 return g_segment_name_DATA;
871}
872
874 static ConstString g_segment_name("__DATA_DIRTY");
875 return g_segment_name;
876}
877
879 static ConstString g_segment_name("__DATA_CONST");
880 return g_segment_name;
881}
882
884 static ConstString g_segment_name_OBJC("__OBJC");
885 return g_segment_name_OBJC;
886}
887
889 static ConstString g_section_name_LINKEDIT("__LINKEDIT");
890 return g_section_name_LINKEDIT;
891}
892
894 static ConstString g_section_name("__DWARF");
895 return g_section_name;
896}
897
899 static ConstString g_section_name("__LLVM_COV");
900 return g_section_name;
901}
902
904 static ConstString g_section_name_eh_frame("__eh_frame");
905 return g_section_name_eh_frame;
906}
907
909 static ConstString g_section_name_lldb_no_nlist("__lldb_no_nlist");
910 return g_section_name_lldb_no_nlist;
911}
912
914 lldb::addr_t data_offset,
915 lldb::addr_t data_length) {
916 lldb::offset_t offset = data_offset;
917 uint32_t magic = extractor_sp->GetU32(&offset);
918
919 offset += 4; // cputype
920 offset += 4; // cpusubtype
921 uint32_t filetype = extractor_sp->GetU32(&offset);
922
923 // A fileset has a Mach-O header but is not an
924 // individual file and must be handled via an
925 // ObjectContainer plugin.
926 if (filetype == llvm::MachO::MH_FILESET)
927 return false;
928
929 return MachHeaderSizeFromMagic(magic) != 0;
930}
931
933 DataExtractorSP extractor_sp,
934 lldb::offset_t data_offset,
935 const FileSpec *file,
936 lldb::offset_t file_offset,
937 lldb::offset_t length)
938 : ObjectFile(module_sp, file, file_offset, length, extractor_sp,
939 data_offset),
943 ::memset(&m_header, 0, sizeof(m_header));
944 ::memset(&m_dysymtab, 0, sizeof(m_dysymtab));
945}
946
948 lldb::WritableDataBufferSP header_data_sp,
949 const lldb::ProcessSP &process_sp,
950 lldb::addr_t header_addr)
951 : ObjectFile(module_sp, process_sp, header_addr,
952 std::make_shared<DataExtractor>(header_data_sp)),
956 ::memset(&m_header, 0, sizeof(m_header));
957 ::memset(&m_dysymtab, 0, sizeof(m_dysymtab));
958}
959
961 lldb::offset_t *data_offset_ptr,
962 llvm::MachO::mach_header &header) {
963 extractor_sp->SetByteOrder(endian::InlHostByteOrder());
964 // Leave magic in the original byte order
965 header.magic = extractor_sp->GetU32(data_offset_ptr);
966 bool can_parse = false;
967 bool is_64_bit = false;
968 switch (header.magic) {
969 case MH_MAGIC:
970 extractor_sp->SetByteOrder(endian::InlHostByteOrder());
971 extractor_sp->SetAddressByteSize(4);
972 can_parse = true;
973 break;
974
975 case MH_MAGIC_64:
976 extractor_sp->SetByteOrder(endian::InlHostByteOrder());
977 extractor_sp->SetAddressByteSize(8);
978 can_parse = true;
979 is_64_bit = true;
980 break;
981
982 case MH_CIGAM:
983 extractor_sp->SetByteOrder(endian::InlHostByteOrder() == eByteOrderBig
985 : eByteOrderBig);
986 extractor_sp->SetAddressByteSize(4);
987 can_parse = true;
988 break;
989
990 case MH_CIGAM_64:
991 extractor_sp->SetByteOrder(endian::InlHostByteOrder() == eByteOrderBig
993 : eByteOrderBig);
994 extractor_sp->SetAddressByteSize(8);
995 is_64_bit = true;
996 can_parse = true;
997 break;
998
999 default:
1000 break;
1001 }
1002
1003 if (can_parse) {
1004 extractor_sp->GetU32(data_offset_ptr, &header.cputype, 6);
1005 if (is_64_bit)
1006 *data_offset_ptr += 4;
1007 return true;
1008 } else {
1009 memset(&header, 0, sizeof(header));
1010 }
1011 return false;
1012}
1013
1015 ModuleSP module_sp(GetModule());
1016 if (!module_sp)
1017 return false;
1018
1019 std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
1020 bool can_parse = false;
1021 lldb::offset_t offset = 0;
1022 m_data_nsp->SetByteOrder(endian::InlHostByteOrder());
1023 // Leave magic in the original byte order
1024 m_header.magic = m_data_nsp->GetU32(&offset);
1025 switch (m_header.magic) {
1026 case MH_MAGIC:
1027 m_data_nsp->SetByteOrder(endian::InlHostByteOrder());
1028 m_data_nsp->SetAddressByteSize(4);
1029 can_parse = true;
1030 break;
1031
1032 case MH_MAGIC_64:
1033 m_data_nsp->SetByteOrder(endian::InlHostByteOrder());
1034 m_data_nsp->SetAddressByteSize(8);
1035 can_parse = true;
1036 break;
1037
1038 case MH_CIGAM:
1041 : eByteOrderBig);
1042 m_data_nsp->SetAddressByteSize(4);
1043 can_parse = true;
1044 break;
1045
1046 case MH_CIGAM_64:
1049 : eByteOrderBig);
1050 m_data_nsp->SetAddressByteSize(8);
1051 can_parse = true;
1052 break;
1053
1054 default:
1055 break;
1056 }
1057
1058 if (can_parse) {
1059 m_data_nsp->GetU32(&offset, &m_header.cputype, 6);
1060
1061 ModuleSpecList all_specs;
1062 ModuleSpec base_spec;
1064 MachHeaderSizeFromMagic(m_header.magic), base_spec,
1065 all_specs);
1066
1067 for (unsigned i = 0, e = all_specs.GetSize(); i != e; ++i) {
1068 ArchSpec mach_arch =
1070
1071 // Check if the module has a required architecture
1072 const ArchSpec &module_arch = module_sp->GetArchitecture();
1073 if (module_arch.IsValid() && !module_arch.IsCompatibleMatch(mach_arch))
1074 continue;
1075
1076 if (SetModulesArchitecture(mach_arch)) {
1077 const size_t header_and_lc_size =
1078 m_header.sizeofcmds + MachHeaderSizeFromMagic(m_header.magic);
1079 if (m_data_nsp->GetByteSize() < header_and_lc_size) {
1080 DataBufferSP data_sp;
1081 ProcessSP process_sp(m_process_wp.lock());
1082 if (process_sp) {
1083 data_sp = ReadMemory(process_sp, m_memory_addr, header_and_lc_size);
1084 } else {
1085 // Read in all only the load command data from the file on disk
1086 data_sp = MapFileData(m_file, header_and_lc_size, m_file_offset);
1087 if (data_sp->GetByteSize() != header_and_lc_size)
1088 continue;
1089 }
1090 if (data_sp)
1091 m_data_nsp->SetData(data_sp);
1092 }
1093 }
1094 return true;
1095 }
1096 // None found.
1097 return false;
1098 } else {
1099 memset(&m_header, 0, sizeof(struct llvm::MachO::mach_header));
1100 }
1101 return false;
1102}
1103
1105 return m_data_nsp->GetByteOrder();
1106}
1107
1109 return m_header.filetype == MH_EXECUTE;
1110}
1111
1113 return m_header.filetype == MH_DYLINKER;
1114}
1115
1117 return m_header.flags & MH_DYLIB_IN_CACHE;
1118}
1119
1121 return m_header.filetype == MH_KEXT_BUNDLE;
1122}
1123
1125 return m_data_nsp->GetAddressByteSize();
1126}
1127
1129 Symtab *symtab = GetSymtab();
1130 if (!symtab)
1132
1133 const Symbol *symbol = symtab->FindSymbolContainingFileAddress(file_addr);
1134 if (symbol) {
1135 if (symbol->ValueIsAddress()) {
1136 SectionSP section_sp(symbol->GetAddressRef().GetSection());
1137 if (section_sp) {
1138 const lldb::SectionType section_type = section_sp->GetType();
1139 switch (section_type) {
1142
1143 case eSectionTypeCode:
1144 if (m_header.cputype == llvm::MachO::CPU_TYPE_ARM) {
1145 // For ARM we have a bit in the n_desc field of the symbol that
1146 // tells us ARM/Thumb which is bit 0x0008.
1149 }
1150 return AddressClass::eCode;
1151
1154
1155 case eSectionTypeData:
1159 case eSectionTypeData4:
1160 case eSectionTypeData8:
1161 case eSectionTypeData16:
1168 return AddressClass::eData;
1169
1170 case eSectionTypeDebug:
1205 case eSectionTypeCTF:
1209 return AddressClass::eDebug;
1210
1216
1222 case eSectionTypeOther:
1224 }
1225 }
1226 }
1227
1228 const SymbolType symbol_type = symbol->GetType();
1229 switch (symbol_type) {
1230 case eSymbolTypeAny:
1234
1235 case eSymbolTypeCode:
1238 if (m_header.cputype == llvm::MachO::CPU_TYPE_ARM) {
1239 // For ARM we have a bit in the n_desc field of the symbol that tells
1240 // us ARM/Thumb which is bit 0x0008.
1243 }
1244 return AddressClass::eCode;
1245
1246 case eSymbolTypeData:
1247 return AddressClass::eData;
1248 case eSymbolTypeRuntime:
1253 return AddressClass::eDebug;
1255 return AddressClass::eDebug;
1257 return AddressClass::eDebug;
1259 return AddressClass::eDebug;
1260 case eSymbolTypeBlock:
1261 return AddressClass::eDebug;
1262 case eSymbolTypeLocal:
1263 return AddressClass::eData;
1264 case eSymbolTypeParam:
1265 return AddressClass::eData;
1267 return AddressClass::eData;
1269 return AddressClass::eDebug;
1271 return AddressClass::eDebug;
1273 return AddressClass::eDebug;
1275 return AddressClass::eDebug;
1277 return AddressClass::eDebug;
1281 return AddressClass::eDebug;
1283 return AddressClass::eDebug;
1294 }
1295 }
1297}
1298
1300 if (m_dysymtab.cmd == 0) {
1301 ModuleSP module_sp(GetModule());
1302 if (module_sp) {
1304 for (uint32_t i = 0; i < m_header.ncmds; ++i) {
1305 const lldb::offset_t load_cmd_offset = offset;
1306
1307 llvm::MachO::load_command lc = {};
1308 if (m_data_nsp->GetU32(&offset, &lc.cmd, 2) == nullptr)
1309 break;
1310 if (lc.cmd == LC_DYSYMTAB) {
1311 m_dysymtab.cmd = lc.cmd;
1312 m_dysymtab.cmdsize = lc.cmdsize;
1313 if (m_data_nsp->GetU32(&offset, &m_dysymtab.ilocalsym,
1314 (sizeof(m_dysymtab) / sizeof(uint32_t)) - 2) ==
1315 nullptr) {
1316 // Clear m_dysymtab if we were unable to read all items from the
1317 // load command
1318 ::memset(&m_dysymtab, 0, sizeof(m_dysymtab));
1319 }
1320 }
1321 offset = load_cmd_offset + lc.cmdsize;
1322 }
1323 }
1324 }
1325 if (m_dysymtab.cmd)
1326 return m_dysymtab.nlocalsym <= 1;
1327 return false;
1328}
1329
1331 EncryptedFileRanges result;
1333
1334 llvm::MachO::encryption_info_command encryption_cmd;
1335 for (uint32_t i = 0; i < m_header.ncmds; ++i) {
1336 const lldb::offset_t load_cmd_offset = offset;
1337 if (m_data_nsp->GetU32(&offset, &encryption_cmd, 2) == nullptr)
1338 break;
1339
1340 // LC_ENCRYPTION_INFO and LC_ENCRYPTION_INFO_64 have the same sizes for the
1341 // 3 fields we care about, so treat them the same.
1342 if (encryption_cmd.cmd == LC_ENCRYPTION_INFO ||
1343 encryption_cmd.cmd == LC_ENCRYPTION_INFO_64) {
1344 if (m_data_nsp->GetU32(&offset, &encryption_cmd.cryptoff, 3)) {
1345 if (encryption_cmd.cryptid != 0) {
1347 entry.SetRangeBase(encryption_cmd.cryptoff);
1348 entry.SetByteSize(encryption_cmd.cryptsize);
1349 result.Append(entry);
1350 }
1351 }
1352 }
1353 offset = load_cmd_offset + encryption_cmd.cmdsize;
1354 }
1355
1356 return result;
1357}
1358
1360 llvm::MachO::segment_command_64 &seg_cmd, uint32_t cmd_idx) {
1361 if (m_length == 0 || seg_cmd.filesize == 0)
1362 return;
1363
1364 if (IsSharedCacheBinary() && !IsInMemory()) {
1365 // In shared cache images, the load commands are relative to the
1366 // shared cache file, and not the specific image we are
1367 // examining. Let's fix this up so that it looks like a normal
1368 // image.
1369 if (strncmp(seg_cmd.segname, GetSegmentNameTEXT().GetCString(),
1370 sizeof(seg_cmd.segname)) == 0)
1371 m_text_address = seg_cmd.vmaddr;
1372 if (strncmp(seg_cmd.segname, GetSegmentNameLINKEDIT().GetCString(),
1373 sizeof(seg_cmd.segname)) == 0)
1374 m_linkedit_original_offset = seg_cmd.fileoff;
1375
1376 seg_cmd.fileoff = seg_cmd.vmaddr - m_text_address;
1377 }
1378
1379 if (seg_cmd.fileoff > m_length) {
1380 // We have a load command that says it extends past the end of the file.
1381 // This is likely a corrupt file. We don't have any way to return an error
1382 // condition here (this method was likely invoked from something like
1383 // ObjectFile::GetSectionList()), so we just null out the section contents,
1384 // and dump a message to stdout. The most common case here is core file
1385 // debugging with a truncated file.
1386 const char *lc_segment_name =
1387 seg_cmd.cmd == LC_SEGMENT_64 ? "LC_SEGMENT_64" : "LC_SEGMENT";
1388 GetModule()->ReportWarning(
1389 "load command {0} {1} has a fileoff ({2:x16}) that extends beyond "
1390 "the end of the file ({3:x16}), ignoring this section",
1391 cmd_idx, lc_segment_name, seg_cmd.fileoff, m_length);
1392
1393 seg_cmd.fileoff = 0;
1394 seg_cmd.filesize = 0;
1395 }
1396
1397 if (seg_cmd.fileoff + seg_cmd.filesize > m_length) {
1398 // We have a load command that says it extends past the end of the file.
1399 // This is likely a corrupt file. We don't have any way to return an error
1400 // condition here (this method was likely invoked from something like
1401 // ObjectFile::GetSectionList()), so we just null out the section contents,
1402 // and dump a message to stdout. The most common case here is core file
1403 // debugging with a truncated file.
1404 const char *lc_segment_name =
1405 seg_cmd.cmd == LC_SEGMENT_64 ? "LC_SEGMENT_64" : "LC_SEGMENT";
1406 GetModule()->ReportWarning(
1407 "load command {0} {1} has a fileoff + filesize ({2:x16}) that "
1408 "extends beyond the end of the file ({3:x16}), the segment will be "
1409 "truncated to match",
1410 cmd_idx, lc_segment_name, seg_cmd.fileoff + seg_cmd.filesize, m_length);
1411
1412 // Truncate the length
1413 seg_cmd.filesize = m_length - seg_cmd.fileoff;
1414 }
1415}
1416
1417static uint32_t
1418GetSegmentPermissions(const llvm::MachO::segment_command_64 &seg_cmd) {
1419 uint32_t result = 0;
1420 if (seg_cmd.initprot & VM_PROT_READ)
1421 result |= ePermissionsReadable;
1422 if (seg_cmd.initprot & VM_PROT_WRITE)
1423 result |= ePermissionsWritable;
1424 if (seg_cmd.initprot & VM_PROT_EXECUTE)
1425 result |= ePermissionsExecutable;
1426 return result;
1427}
1428
1429static lldb::SectionType GetSectionType(uint32_t flags,
1430 ConstString section_name) {
1431
1432 if (flags & (S_ATTR_PURE_INSTRUCTIONS | S_ATTR_SOME_INSTRUCTIONS))
1433 return eSectionTypeCode;
1434
1435 uint32_t mach_sect_type = flags & SECTION_TYPE;
1436 static ConstString g_sect_name_objc_data("__objc_data");
1437 static ConstString g_sect_name_objc_msgrefs("__objc_msgrefs");
1438 static ConstString g_sect_name_objc_selrefs("__objc_selrefs");
1439 static ConstString g_sect_name_objc_classrefs("__objc_classrefs");
1440 static ConstString g_sect_name_objc_superrefs("__objc_superrefs");
1441 static ConstString g_sect_name_objc_const("__objc_const");
1442 static ConstString g_sect_name_objc_classlist("__objc_classlist");
1443 static ConstString g_sect_name_cfstring("__cfstring");
1444
1445 static ConstString g_sect_name_dwarf_debug_str_offs("__debug_str_offs");
1446 static ConstString g_sect_name_dwarf_debug_str_offs_dwo("__debug_str_offs.dwo");
1447 static ConstString g_sect_name_dwarf_apple_names("__apple_names");
1448 static ConstString g_sect_name_dwarf_apple_types("__apple_types");
1449 static ConstString g_sect_name_dwarf_apple_namespaces("__apple_namespac");
1450 static ConstString g_sect_name_dwarf_apple_objc("__apple_objc");
1451 static ConstString g_sect_name_eh_frame("__eh_frame");
1452 static ConstString g_sect_name_compact_unwind("__unwind_info");
1453 static ConstString g_sect_name_text("__text");
1454 static ConstString g_sect_name_data("__data");
1455 static ConstString g_sect_name_go_symtab("__gosymtab");
1456 static ConstString g_sect_name_ctf("__ctf");
1457 static ConstString g_sect_name_lldb_summaries("__lldbsummaries");
1458 static ConstString g_sect_name_lldb_formatters("__lldbformatters");
1459 static ConstString g_sect_name_swift_ast("__swift_ast");
1460
1461 if (section_name == g_sect_name_dwarf_debug_str_offs)
1463 if (section_name == g_sect_name_dwarf_debug_str_offs_dwo)
1465
1466 llvm::StringRef stripped_name = section_name.GetStringRef();
1467 if (stripped_name.consume_front("__debug_"))
1468 return ObjectFile::GetDWARFSectionTypeFromName(stripped_name);
1469
1470 if (section_name == g_sect_name_dwarf_apple_names)
1472 if (section_name == g_sect_name_dwarf_apple_types)
1474 if (section_name == g_sect_name_dwarf_apple_namespaces)
1476 if (section_name == g_sect_name_dwarf_apple_objc)
1478 if (section_name == g_sect_name_objc_selrefs)
1480 if (section_name == g_sect_name_objc_msgrefs)
1482 if (section_name == g_sect_name_eh_frame)
1483 return eSectionTypeEHFrame;
1484 if (section_name == g_sect_name_compact_unwind)
1486 if (section_name == g_sect_name_cfstring)
1488 if (section_name == g_sect_name_go_symtab)
1489 return eSectionTypeGoSymtab;
1490 if (section_name == g_sect_name_ctf)
1491 return eSectionTypeCTF;
1492 if (section_name == g_sect_name_lldb_summaries)
1494 if (section_name == g_sect_name_lldb_formatters)
1496 if (section_name == g_sect_name_swift_ast)
1498 if (section_name == g_sect_name_objc_data ||
1499 section_name == g_sect_name_objc_classrefs ||
1500 section_name == g_sect_name_objc_superrefs ||
1501 section_name == g_sect_name_objc_const ||
1502 section_name == g_sect_name_objc_classlist) {
1504 }
1505
1506 switch (mach_sect_type) {
1507 // TODO: categorize sections by other flags for regular sections
1508 case S_REGULAR:
1509 if (section_name == g_sect_name_text)
1510 return eSectionTypeCode;
1511 if (section_name == g_sect_name_data)
1512 return eSectionTypeData;
1513 return eSectionTypeOther;
1514 case S_ZEROFILL:
1515 return eSectionTypeZeroFill;
1516 case S_CSTRING_LITERALS: // section with only literal C strings
1518 case S_4BYTE_LITERALS: // section with only 4 byte literals
1519 return eSectionTypeData4;
1520 case S_8BYTE_LITERALS: // section with only 8 byte literals
1521 return eSectionTypeData8;
1522 case S_LITERAL_POINTERS: // section with only pointers to literals
1524 case S_NON_LAZY_SYMBOL_POINTERS: // section with only non-lazy symbol pointers
1526 case S_LAZY_SYMBOL_POINTERS: // section with only lazy symbol pointers
1528 case S_SYMBOL_STUBS: // section with only symbol stubs, byte size of stub in
1529 // the reserved2 field
1530 return eSectionTypeCode;
1531 case S_MOD_INIT_FUNC_POINTERS: // section with only function pointers for
1532 // initialization
1534 case S_MOD_TERM_FUNC_POINTERS: // section with only function pointers for
1535 // termination
1537 case S_COALESCED:
1538 return eSectionTypeOther;
1539 case S_GB_ZEROFILL:
1540 return eSectionTypeZeroFill;
1541 case S_INTERPOSING: // section with only pairs of function pointers for
1542 // interposing
1543 return eSectionTypeCode;
1544 case S_16BYTE_LITERALS: // section with only 16 byte literals
1545 return eSectionTypeData16;
1546 case S_DTRACE_DOF:
1547 return eSectionTypeDebug;
1548 case S_LAZY_DYLIB_SYMBOL_POINTERS:
1550 default:
1551 return eSectionTypeOther;
1552 }
1553}
1554
1566
1568 const llvm::MachO::load_command &load_cmd_, lldb::offset_t offset,
1569 uint32_t cmd_idx, SegmentParsingContext &context) {
1570 llvm::MachO::segment_command_64 load_cmd;
1571 memcpy(&load_cmd, &load_cmd_, sizeof(load_cmd_));
1572
1573 if (!m_data_nsp->GetU8(&offset, (uint8_t *)load_cmd.segname, 16))
1574 return;
1575
1576 ModuleSP module_sp = GetModule();
1577 const bool is_core = GetType() == eTypeCoreFile;
1578 const bool is_dsym = (m_header.filetype == MH_DSYM);
1579 bool add_section = true;
1580 bool add_to_unified = true;
1581 ConstString const_segname(
1582 load_cmd.segname, strnlen(load_cmd.segname, sizeof(load_cmd.segname)));
1583
1584 SectionSP unified_section_sp(
1585 context.UnifiedList.FindSectionByName(const_segname));
1586 if (is_dsym && unified_section_sp) {
1587 if (const_segname == GetSegmentNameLINKEDIT()) {
1588 // We need to keep the __LINKEDIT segment private to this object file
1589 // only
1590 add_to_unified = false;
1591 } else {
1592 // This is the dSYM file and this section has already been created by the
1593 // object file, no need to create it.
1594 add_section = false;
1595 }
1596 }
1597 load_cmd.vmaddr = m_data_nsp->GetAddress(&offset);
1598 load_cmd.vmsize = m_data_nsp->GetAddress(&offset);
1599 load_cmd.fileoff = m_data_nsp->GetAddress(&offset);
1600 load_cmd.filesize = m_data_nsp->GetAddress(&offset);
1601 if (!m_data_nsp->GetU32(&offset, &load_cmd.maxprot, 4))
1602 return;
1603
1604 SanitizeSegmentCommand(load_cmd, cmd_idx);
1605
1606 const uint32_t segment_permissions = GetSegmentPermissions(load_cmd);
1607 const bool segment_is_encrypted =
1608 (load_cmd.flags & SG_PROTECTED_VERSION_1) != 0;
1609
1610 // Use a segment ID of the segment index shifted left by 8 so they never
1611 // conflict with any of the sections.
1612 SectionSP segment_sp;
1613 if (add_section && (const_segname || is_core)) {
1614 segment_sp = std::make_shared<Section>(
1615 module_sp, // Module to which this section belongs
1616 this, // Object file to which this sections belongs
1617 ++context.NextSegmentIdx
1618 << 8, // Section ID is the 1 based segment index
1619 // shifted right by 8 bits as not to collide with any of the 256
1620 // section IDs that are possible
1621 const_segname, // Name of this section
1622 eSectionTypeContainer, // This section is a container of other
1623 // sections.
1624 load_cmd.vmaddr, // File VM address == addresses as they are
1625 // found in the object file
1626 load_cmd.vmsize, // VM size in bytes of this section
1627 load_cmd.fileoff, // Offset to the data for this section in
1628 // the file
1629 load_cmd.filesize, // Size in bytes of this section as found
1630 // in the file
1631 0, // Segments have no alignment information
1632 load_cmd.flags); // Flags for this section
1633
1634 segment_sp->SetIsEncrypted(segment_is_encrypted);
1635 m_sections_up->AddSection(segment_sp);
1636 segment_sp->SetPermissions(segment_permissions);
1637 if (add_to_unified)
1638 context.UnifiedList.AddSection(segment_sp);
1639 } else if (unified_section_sp) {
1640 // If this is a dSYM and the file addresses in the dSYM differ from the
1641 // file addresses in the ObjectFile, we must use the file base address for
1642 // the Section from the dSYM for the DWARF to resolve correctly.
1643 // This only happens with binaries in the shared cache in practice;
1644 // normally a mismatch like this would give a binary & dSYM that do not
1645 // match UUIDs. When a binary is included in the shared cache, its
1646 // segments are rearranged to optimize the shared cache, so its file
1647 // addresses will differ from what the ObjectFile had originally,
1648 // and what the dSYM has.
1649 if (is_dsym && unified_section_sp->GetFileAddress() != load_cmd.vmaddr) {
1650 Log *log = GetLog(LLDBLog::Symbols);
1651 if (log) {
1652 log->Printf(
1653 "Installing dSYM's %s segment file address over ObjectFile's "
1654 "so symbol table/debug info resolves correctly for %s",
1655 const_segname.AsCString(""),
1656 module_sp->GetFileSpec().GetFilename().AsCString(""));
1657 }
1658
1659 // Make sure we've parsed the symbol table from the ObjectFile before
1660 // we go around changing its Sections.
1661 module_sp->GetObjectFile()->GetSymtab();
1662 // eh_frame would present the same problems but we parse that on a per-
1663 // function basis as-needed so it's more difficult to remove its use of
1664 // the Sections. Realistically, the environments where this code path
1665 // will be taken will not have eh_frame sections.
1666
1667 unified_section_sp->SetFileAddress(load_cmd.vmaddr);
1668
1669 // Notify the module that the section addresses have been changed once
1670 // we're done so any file-address caches can be updated.
1671 context.FileAddressesChanged = true;
1672 }
1673 m_sections_up->AddSection(unified_section_sp);
1674 }
1675
1676 llvm::MachO::section_64 sect64;
1677 ::memset(&sect64, 0, sizeof(sect64));
1678 // Push a section into our mach sections for the section at index zero
1679 // (NO_SECT) if we don't have any mach sections yet...
1680 if (m_mach_sections.empty())
1681 m_mach_sections.push_back(sect64);
1682 uint32_t segment_sect_idx;
1683 const lldb::user_id_t first_segment_sectID = context.NextSectionIdx + 1;
1684
1685 // 64 bit mach-o files have sections with 32 bit file offsets. If any section
1686 // data end will exceed UINT32_MAX, then we need to do some bookkeeping to
1687 // ensure we can access this data correctly.
1688 uint64_t section_offset_adjust = 0;
1689 const uint32_t num_u32s = load_cmd.cmd == LC_SEGMENT ? 7 : 8;
1690 for (segment_sect_idx = 0; segment_sect_idx < load_cmd.nsects;
1691 ++segment_sect_idx) {
1692 if (m_data_nsp->GetU8(&offset, (uint8_t *)sect64.sectname,
1693 sizeof(sect64.sectname)) == nullptr)
1694 break;
1695 if (m_data_nsp->GetU8(&offset, (uint8_t *)sect64.segname,
1696 sizeof(sect64.segname)) == nullptr)
1697 break;
1698 sect64.addr = m_data_nsp->GetAddress(&offset);
1699 sect64.size = m_data_nsp->GetAddress(&offset);
1700
1701 if (m_data_nsp->GetU32(&offset, &sect64.offset, num_u32s) == nullptr)
1702 break;
1703
1704 if (IsSharedCacheBinary() && !IsInMemory()) {
1705 sect64.offset = sect64.addr - m_text_address;
1706 }
1707
1708 // Keep a list of mach sections around in case we need to get at data that
1709 // isn't stored in the abstracted Sections.
1710 m_mach_sections.push_back(sect64);
1711
1712 // Make sure we can load sections in mach-o files where some sections cross
1713 // a 4GB boundary. llvm::MachO::section_64 have only 32 bit file offsets
1714 // for the file offset of the section contents, so we need to track and
1715 // sections that overflow and adjust the offsets accordingly.
1716 const uint64_t section_file_offset =
1717 (uint64_t)sect64.offset + section_offset_adjust;
1718 const uint64_t end_section_offset = (uint64_t)sect64.offset + sect64.size;
1719 if (end_section_offset >= UINT32_MAX)
1720 section_offset_adjust += end_section_offset & 0xFFFFFFFF00000000ull;
1721
1722 if (add_section) {
1723 ConstString section_name(
1724 sect64.sectname, strnlen(sect64.sectname, sizeof(sect64.sectname)));
1725 if (!const_segname) {
1726 // We have a segment with no name so we need to conjure up segments
1727 // that correspond to the section's segname if there isn't already such
1728 // a section. If there is such a section, we resize the section so that
1729 // it spans all sections. We also mark these sections as fake so
1730 // address matches don't hit if they land in the gaps between the child
1731 // sections.
1732 const_segname.SetTrimmedCStringWithLength(sect64.segname,
1733 sizeof(sect64.segname));
1734 segment_sp = context.UnifiedList.FindSectionByName(const_segname);
1735 if (segment_sp.get()) {
1736 Section *segment = segment_sp.get();
1737 // Grow the section size as needed.
1738 const lldb::addr_t sect64_min_addr = sect64.addr;
1739 const lldb::addr_t sect64_max_addr = sect64_min_addr + sect64.size;
1740 const lldb::addr_t curr_seg_byte_size = segment->GetByteSize();
1741 const lldb::addr_t curr_seg_min_addr = segment->GetFileAddress();
1742 const lldb::addr_t curr_seg_max_addr =
1743 curr_seg_min_addr + curr_seg_byte_size;
1744 if (sect64_min_addr >= curr_seg_min_addr) {
1745 const lldb::addr_t new_seg_byte_size =
1746 sect64_max_addr - curr_seg_min_addr;
1747 // Only grow the section size if needed
1748 if (new_seg_byte_size > curr_seg_byte_size)
1749 segment->SetByteSize(new_seg_byte_size);
1750 } else {
1751 // We need to change the base address of the segment and adjust the
1752 // child section offsets for all existing children.
1753 const lldb::addr_t slide_amount =
1754 sect64_min_addr - curr_seg_min_addr;
1755 segment->Slide(slide_amount, false);
1756 segment->GetChildren().Slide(-slide_amount, false);
1757 segment->SetByteSize(curr_seg_max_addr - sect64_min_addr);
1758 }
1759
1760 // Grow the section size as needed.
1761 if (section_file_offset) {
1762 const lldb::addr_t segment_min_file_offset =
1763 segment->GetFileOffset();
1764 const lldb::addr_t segment_max_file_offset =
1765 segment_min_file_offset + segment->GetFileSize();
1766
1767 const lldb::addr_t section_min_file_offset = section_file_offset;
1768 const lldb::addr_t section_max_file_offset =
1769 section_min_file_offset + sect64.size;
1770 const lldb::addr_t new_file_offset =
1771 std::min(section_min_file_offset, segment_min_file_offset);
1772 const lldb::addr_t new_file_size =
1773 std::max(section_max_file_offset, segment_max_file_offset) -
1774 new_file_offset;
1775 segment->SetFileOffset(new_file_offset);
1776 segment->SetFileSize(new_file_size);
1777 }
1778 } else {
1779 // Create a fake section for the section's named segment
1780 segment_sp = std::make_shared<Section>(
1781 segment_sp, // Parent section
1782 module_sp, // Module to which this section belongs
1783 this, // Object file to which this section belongs
1784 ++context.NextSegmentIdx
1785 << 8, // Section ID is the 1 based segment index
1786 // shifted right by 8 bits as not to
1787 // collide with any of the 256 section IDs
1788 // that are possible
1789 const_segname, // Name of this section
1790 eSectionTypeContainer, // This section is a container of
1791 // other sections.
1792 sect64.addr, // File VM address == addresses as they are
1793 // found in the object file
1794 sect64.size, // VM size in bytes of this section
1795 section_file_offset, // Offset to the data for this section in
1796 // the file
1797 section_file_offset ? sect64.size : 0, // Size in bytes of
1798 // this section as
1799 // found in the file
1800 sect64.align,
1801 load_cmd.flags); // Flags for this section
1802 segment_sp->SetIsFake(true);
1803 segment_sp->SetPermissions(segment_permissions);
1804 m_sections_up->AddSection(segment_sp);
1805 if (add_to_unified)
1806 context.UnifiedList.AddSection(segment_sp);
1807 segment_sp->SetIsEncrypted(segment_is_encrypted);
1808 }
1809 }
1810 assert(segment_sp.get());
1811
1812 lldb::SectionType sect_type = GetSectionType(sect64.flags, section_name);
1813
1814 SectionSP section_sp(new Section(
1815 segment_sp, module_sp, this, ++context.NextSectionIdx, section_name,
1816 sect_type, sect64.addr - segment_sp->GetFileAddress(), sect64.size,
1817 section_file_offset, section_file_offset == 0 ? 0 : sect64.size,
1818 sect64.align, sect64.flags));
1819 // Set the section to be encrypted to match the segment
1820
1821 bool section_is_encrypted = false;
1822 if (!segment_is_encrypted && load_cmd.filesize != 0)
1823 section_is_encrypted = context.EncryptedRanges.FindEntryThatContains(
1824 section_file_offset) != nullptr;
1825
1826 section_sp->SetIsEncrypted(segment_is_encrypted || section_is_encrypted);
1827 section_sp->SetPermissions(segment_permissions);
1828 segment_sp->GetChildren().AddSection(section_sp);
1829
1830 if (segment_sp->IsFake()) {
1831 segment_sp.reset();
1832 const_segname.Clear();
1833 }
1834 }
1835 }
1836 if (segment_sp && is_dsym) {
1837 if (first_segment_sectID <= context.NextSectionIdx) {
1838 lldb::user_id_t sect_uid;
1839 for (sect_uid = first_segment_sectID; sect_uid <= context.NextSectionIdx;
1840 ++sect_uid) {
1841 SectionSP curr_section_sp(
1842 segment_sp->GetChildren().FindSectionByID(sect_uid));
1843 SectionSP next_section_sp;
1844 if (sect_uid + 1 <= context.NextSectionIdx)
1845 next_section_sp =
1846 segment_sp->GetChildren().FindSectionByID(sect_uid + 1);
1847
1848 if (curr_section_sp.get()) {
1849 if (curr_section_sp->GetByteSize() == 0) {
1850 if (next_section_sp.get() != nullptr)
1851 curr_section_sp->SetByteSize(next_section_sp->GetFileAddress() -
1852 curr_section_sp->GetFileAddress());
1853 else
1854 curr_section_sp->SetByteSize(load_cmd.vmsize);
1855 }
1856 }
1857 }
1858 }
1859 }
1860}
1861
1863 const llvm::MachO::load_command &load_cmd, lldb::offset_t offset) {
1864 m_dysymtab.cmd = load_cmd.cmd;
1865 m_dysymtab.cmdsize = load_cmd.cmdsize;
1866 m_data_nsp->GetU32(&offset, &m_dysymtab.ilocalsym,
1867 (sizeof(m_dysymtab) / sizeof(uint32_t)) - 2);
1868}
1869
1871 if (m_sections_up)
1872 return;
1873
1874 m_sections_up = std::make_unique<SectionList>();
1875
1877 // bool dump_sections = false;
1878 ModuleSP module_sp(GetModule());
1879
1880 offset = MachHeaderSizeFromMagic(m_header.magic);
1881
1882 SegmentParsingContext context(GetEncryptedFileRanges(), unified_section_list);
1883 llvm::MachO::load_command load_cmd;
1884 for (uint32_t i = 0; i < m_header.ncmds; ++i) {
1885 const lldb::offset_t load_cmd_offset = offset;
1886 if (m_data_nsp->GetU32(&offset, &load_cmd, 2) == nullptr)
1887 break;
1888
1889 if (load_cmd.cmd == LC_SEGMENT || load_cmd.cmd == LC_SEGMENT_64)
1890 ProcessSegmentCommand(load_cmd, offset, i, context);
1891 else if (load_cmd.cmd == LC_DYSYMTAB)
1892 ProcessDysymtabCommand(load_cmd, offset);
1893
1894 offset = load_cmd_offset + load_cmd.cmdsize;
1895 }
1896
1897 if (context.FileAddressesChanged && module_sp)
1898 module_sp->SectionFileAddressesChanged();
1899}
1900
1902public:
1904 : m_section_list(section_list), m_section_infos() {
1905 // Get the number of sections down to a depth of 1 to include all segments
1906 // and their sections, but no other sections that may be added for debug
1907 // map or
1908 m_section_infos.resize(section_list->GetNumSections(1));
1909 }
1910
1911 SectionSP GetSection(uint8_t n_sect, addr_t file_addr) {
1912 if (n_sect == 0)
1913 return SectionSP();
1914 if (n_sect < m_section_infos.size()) {
1915 if (!m_section_infos[n_sect].section_sp) {
1916 SectionSP section_sp(m_section_list->FindSectionByID(n_sect));
1917 m_section_infos[n_sect].section_sp = section_sp;
1918 if (section_sp) {
1919 m_section_infos[n_sect].vm_range.SetRangeBase(
1920 section_sp->GetFileAddress());
1921 m_section_infos[n_sect].vm_range.SetByteSize(
1922 section_sp->GetByteSize());
1923 } else {
1924 std::string filename = "<unknown>";
1925 SectionSP first_section_sp(m_section_list->GetSectionAtIndex(0));
1926 if (first_section_sp)
1927 filename = first_section_sp->GetObjectFile()->GetFileSpec().GetPath();
1928
1930 llvm::formatv("unable to find section {0} for a symbol in "
1931 "{1}, corrupt file?",
1932 n_sect, filename));
1933 }
1934 }
1935 if (m_section_infos[n_sect].vm_range.Contains(file_addr)) {
1936 // Symbol is in section.
1937 return m_section_infos[n_sect].section_sp;
1938 } else if (m_section_infos[n_sect].vm_range.GetByteSize() == 0 &&
1939 m_section_infos[n_sect].vm_range.GetRangeBase() == file_addr) {
1940 // Symbol is in section with zero size, but has the same start address
1941 // as the section. This can happen with linker symbols (symbols that
1942 // start with the letter 'l' or 'L'.
1943 return m_section_infos[n_sect].section_sp;
1944 }
1945 }
1946 return m_section_list->FindSectionContainingFileAddress(file_addr);
1947 }
1948
1949protected:
1957 std::vector<SectionInfo> m_section_infos;
1958};
1959
1960#define TRIE_SYMBOL_IS_THUMB (1ULL << 63)
1962 void Dump() const {
1963 printf("0x%16.16llx 0x%16.16llx 0x%16.16llx \"%s\"",
1964 static_cast<unsigned long long>(address),
1965 static_cast<unsigned long long>(flags),
1966 static_cast<unsigned long long>(other), name.GetCString());
1967 if (import_name)
1968 printf(" -> \"%s\"\n", import_name.GetCString());
1969 else
1970 printf("\n");
1971 }
1974 uint64_t flags =
1975 0; // EXPORT_SYMBOL_FLAGS_REEXPORT, EXPORT_SYMBOL_FLAGS_STUB_AND_RESOLVER,
1976 // TRIE_SYMBOL_IS_THUMB
1977 uint64_t other = 0;
1979};
1980
1984
1986
1987 void Dump(uint32_t idx) const {
1988 printf("[%3u] 0x%16.16llx: ", idx,
1989 static_cast<unsigned long long>(nodeOffset));
1990 entry.Dump();
1991 }
1992
1993 bool operator<(const TrieEntryWithOffset &other) const {
1994 return (nodeOffset < other.nodeOffset);
1995 }
1996};
1997
1999 const bool is_arm, addr_t text_seg_base_addr,
2000 std::vector<llvm::StringRef> &nameSlices,
2001 std::set<lldb::addr_t> &resolver_addresses,
2002 std::vector<TrieEntryWithOffset> &reexports,
2003 std::vector<TrieEntryWithOffset> &ext_symbols) {
2004 if (!data.ValidOffset(offset))
2005 return true;
2006
2007 // Terminal node -- end of a branch, possibly add this to
2008 // the symbol table or resolver table.
2009 const uint64_t terminalSize = data.GetULEB128(&offset);
2010 lldb::offset_t children_offset = offset + terminalSize;
2011 if (terminalSize != 0) {
2012 TrieEntryWithOffset e(offset);
2013 e.entry.flags = data.GetULEB128(&offset);
2014 const char *import_name = nullptr;
2015 if (e.entry.flags & EXPORT_SYMBOL_FLAGS_REEXPORT) {
2016 e.entry.address = 0;
2017 e.entry.other = data.GetULEB128(&offset); // dylib ordinal
2018 import_name = data.GetCStr(&offset);
2019 } else {
2020 e.entry.address = data.GetULEB128(&offset);
2021 if (text_seg_base_addr != LLDB_INVALID_ADDRESS)
2022 e.entry.address += text_seg_base_addr;
2023 if (e.entry.flags & EXPORT_SYMBOL_FLAGS_STUB_AND_RESOLVER) {
2024 e.entry.other = data.GetULEB128(&offset);
2025 uint64_t resolver_addr = e.entry.other;
2026 if (text_seg_base_addr != LLDB_INVALID_ADDRESS)
2027 resolver_addr += text_seg_base_addr;
2028 if (is_arm)
2029 resolver_addr &= THUMB_ADDRESS_BIT_MASK;
2030 resolver_addresses.insert(resolver_addr);
2031 } else
2032 e.entry.other = 0;
2033 }
2034 bool add_this_entry = false;
2035 if (Flags(e.entry.flags).Test(EXPORT_SYMBOL_FLAGS_REEXPORT) &&
2036 import_name && import_name[0]) {
2037 // add symbols that are reexport symbols with a valid import name.
2038 add_this_entry = true;
2039 } else if (e.entry.flags == 0 &&
2040 (import_name == nullptr || import_name[0] == '\0')) {
2041 // add externally visible symbols, in case the nlist record has
2042 // been stripped/omitted.
2043 add_this_entry = true;
2044 }
2045 if (add_this_entry) {
2046 std::string name;
2047 if (!nameSlices.empty()) {
2048 for (auto name_slice : nameSlices)
2049 name.append(name_slice.data(), name_slice.size());
2050 }
2051 if (name.size() > 1) {
2052 // Skip the leading '_'
2053 e.entry.name.SetCStringWithLength(name.c_str() + 1, name.size() - 1);
2054 }
2055 if (import_name) {
2056 // Skip the leading '_'
2057 e.entry.import_name.SetCString(import_name + 1);
2058 }
2059 if (Flags(e.entry.flags).Test(EXPORT_SYMBOL_FLAGS_REEXPORT)) {
2060 reexports.push_back(e);
2061 } else {
2062 if (is_arm && (e.entry.address & 1)) {
2065 }
2066 ext_symbols.push_back(e);
2067 }
2068 }
2069 }
2070
2071 const uint8_t childrenCount = data.GetU8(&children_offset);
2072 for (uint8_t i = 0; i < childrenCount; ++i) {
2073 const char *cstr = data.GetCStr(&children_offset);
2074 if (cstr)
2075 nameSlices.push_back(llvm::StringRef(cstr));
2076 else
2077 return false; // Corrupt data
2078 lldb::offset_t childNodeOffset = data.GetULEB128(&children_offset);
2079 if (childNodeOffset) {
2080 if (!ParseTrieEntries(data, childNodeOffset, is_arm, text_seg_base_addr,
2081 nameSlices, resolver_addresses, reexports,
2082 ext_symbols)) {
2083 return false;
2084 }
2085 }
2086 nameSlices.pop_back();
2087 }
2088 return true;
2089}
2090
2091static bool
2092TryParseV2ObjCMetadataSymbol(const char *&symbol_name,
2093 const char *&symbol_name_non_abi_mangled,
2094 SymbolType &type) {
2095 static constexpr llvm::StringLiteral g_objc_v2_prefix_class("_OBJC_CLASS_$_");
2096 static constexpr llvm::StringLiteral g_objc_v2_prefix_metaclass(
2097 "_OBJC_METACLASS_$_");
2098 static constexpr llvm::StringLiteral g_objc_v2_prefix_ivar("_OBJC_IVAR_$_");
2099
2100 llvm::StringRef symbol_name_ref(symbol_name);
2101 if (symbol_name_ref.empty())
2102 return false;
2103
2104 if (symbol_name_ref.starts_with(g_objc_v2_prefix_class)) {
2105 symbol_name_non_abi_mangled = symbol_name + 1;
2106 symbol_name = symbol_name + g_objc_v2_prefix_class.size();
2107 type = eSymbolTypeObjCClass;
2108 return true;
2109 }
2110
2111 if (symbol_name_ref.starts_with(g_objc_v2_prefix_metaclass)) {
2112 symbol_name_non_abi_mangled = symbol_name + 1;
2113 symbol_name = symbol_name + g_objc_v2_prefix_metaclass.size();
2115 return true;
2116 }
2117
2118 if (symbol_name_ref.starts_with(g_objc_v2_prefix_ivar)) {
2119 symbol_name_non_abi_mangled = symbol_name + 1;
2120 symbol_name = symbol_name + g_objc_v2_prefix_ivar.size();
2121 type = eSymbolTypeObjCIVar;
2122 return true;
2123 }
2124
2125 return false;
2126}
2127
2128static SymbolType GetSymbolType(const char *&symbol_name,
2129 bool &demangled_is_synthesized,
2130 const SectionSP &text_section_sp,
2131 const SectionSP &data_section_sp,
2132 const SectionSP &data_dirty_section_sp,
2133 const SectionSP &data_const_section_sp,
2134 const SectionSP &symbol_section) {
2136
2137 const char *symbol_sect_name = symbol_section->GetName().AsCString(nullptr);
2138 if (symbol_section->IsDescendant(text_section_sp.get())) {
2139 if (symbol_section->IsClear(S_ATTR_PURE_INSTRUCTIONS |
2140 S_ATTR_SELF_MODIFYING_CODE |
2141 S_ATTR_SOME_INSTRUCTIONS))
2142 type = eSymbolTypeData;
2143 else
2144 type = eSymbolTypeCode;
2145 } else if (symbol_section->IsDescendant(data_section_sp.get()) ||
2146 symbol_section->IsDescendant(data_dirty_section_sp.get()) ||
2147 symbol_section->IsDescendant(data_const_section_sp.get())) {
2148 if (symbol_sect_name &&
2149 ::strstr(symbol_sect_name, "__objc") == symbol_sect_name) {
2150 type = eSymbolTypeRuntime;
2151
2152 if (symbol_name) {
2153 llvm::StringRef symbol_name_ref(symbol_name);
2154 if (symbol_name_ref.starts_with("OBJC_")) {
2155 static const llvm::StringRef g_objc_v2_prefix_class("OBJC_CLASS_$_");
2156 static const llvm::StringRef g_objc_v2_prefix_metaclass(
2157 "OBJC_METACLASS_$_");
2158 static const llvm::StringRef g_objc_v2_prefix_ivar("OBJC_IVAR_$_");
2159 if (symbol_name_ref.starts_with(g_objc_v2_prefix_class)) {
2160 symbol_name = symbol_name + g_objc_v2_prefix_class.size();
2161 type = eSymbolTypeObjCClass;
2162 demangled_is_synthesized = true;
2163 } else if (symbol_name_ref.starts_with(g_objc_v2_prefix_metaclass)) {
2164 symbol_name = symbol_name + g_objc_v2_prefix_metaclass.size();
2166 demangled_is_synthesized = true;
2167 } else if (symbol_name_ref.starts_with(g_objc_v2_prefix_ivar)) {
2168 symbol_name = symbol_name + g_objc_v2_prefix_ivar.size();
2169 type = eSymbolTypeObjCIVar;
2170 demangled_is_synthesized = true;
2171 }
2172 }
2173 }
2174 } else if (symbol_sect_name &&
2175 ::strstr(symbol_sect_name, "__gcc_except_tab") ==
2176 symbol_sect_name) {
2177 type = eSymbolTypeException;
2178 } else {
2179 type = eSymbolTypeData;
2180 }
2181 } else if (symbol_sect_name &&
2182 ::strstr(symbol_sect_name, "__IMPORT") == symbol_sect_name) {
2183 type = eSymbolTypeTrampoline;
2184 }
2185 return type;
2186}
2187
2188static std::optional<struct nlist_64>
2189ParseNList(DataExtractor &nlist_data, lldb::offset_t &nlist_data_offset,
2190 size_t nlist_byte_size) {
2191 struct nlist_64 nlist;
2192 if (!nlist_data.ValidOffsetForDataOfSize(nlist_data_offset, nlist_byte_size))
2193 return {};
2194 nlist.n_strx = nlist_data.GetU32_unchecked(&nlist_data_offset);
2195 nlist.n_type = nlist_data.GetU8_unchecked(&nlist_data_offset);
2196 nlist.n_sect = nlist_data.GetU8_unchecked(&nlist_data_offset);
2197 nlist.n_desc = nlist_data.GetU16_unchecked(&nlist_data_offset);
2198 nlist.n_value = nlist_data.GetAddress_unchecked(&nlist_data_offset);
2199 return nlist;
2200}
2201
2202enum { DebugSymbols = true, NonDebugSymbols = false };
2203
2205 ModuleSP module_sp(GetModule());
2206 if (!module_sp)
2207 return;
2208
2209 Log *log = GetLog(LLDBLog::Symbols);
2210
2211 const FileSpec &file = m_file ? m_file : module_sp->GetFileSpec();
2212 const char *file_name = file.GetFilename().AsCString("<Unknown>");
2213 LLDB_SCOPED_TIMERF("ObjectFileMachO::ParseSymtab () module = %s", file_name);
2214 LLDB_LOG(log, "Parsing symbol table for {0}", file_name);
2215 Progress progress("Parsing symbol table", file_name);
2216
2217 LinkeditDataCommandLargeOffsets function_starts_load_command;
2218 LinkeditDataCommandLargeOffsets exports_trie_load_command;
2221 SymtabCommandLargeOffsets symtab_load_command;
2222 // The data element of type bool indicates that this entry is thumb
2223 // code.
2224 typedef AddressDataArray<lldb::addr_t, bool, 100> FunctionStarts;
2225
2226 // Record the address of every function/data that we add to the symtab.
2227 // We add symbols to the table in the order of most information (nlist
2228 // records) to least (function starts), and avoid duplicating symbols
2229 // via this set.
2230 llvm::DenseSet<addr_t> symbols_added;
2231
2232 // We are using a llvm::DenseSet for "symbols_added" so we must be sure we
2233 // do not add the tombstone or empty keys to the set.
2234 auto add_symbol_addr = [&symbols_added](lldb::addr_t file_addr) {
2235 // Don't add the tombstone or empty keys.
2236 if (file_addr == UINT64_MAX || file_addr == UINT64_MAX - 1)
2237 return;
2238 symbols_added.insert(file_addr);
2239 };
2240 FunctionStarts function_starts;
2242 uint32_t i;
2243 FileSpecList dylib_files;
2244 UUID image_uuid;
2245
2246 for (i = 0; i < m_header.ncmds; ++i) {
2247 const lldb::offset_t cmd_offset = offset;
2248 // Read in the load command and load command size
2249 llvm::MachO::load_command lc;
2250 if (m_data_nsp->GetU32(&offset, &lc, 2) == nullptr)
2251 break;
2252 // Watch for the symbol table load command
2253 switch (lc.cmd) {
2254 case LC_SYMTAB: {
2255 llvm::MachO::symtab_command lc_obj;
2256 if (m_data_nsp->GetU32(&offset, &lc_obj.symoff, 4)) {
2257 lc_obj.cmd = lc.cmd;
2258 lc_obj.cmdsize = lc.cmdsize;
2259 symtab_load_command = lc_obj;
2260 }
2261 } break;
2262
2263 case LC_DYLD_INFO:
2264 case LC_DYLD_INFO_ONLY: {
2265 llvm::MachO::dyld_info_command lc_obj;
2266 if (m_data_nsp->GetU32(&offset, &lc_obj.rebase_off, 10)) {
2267 lc_obj.cmd = lc.cmd;
2268 lc_obj.cmdsize = lc.cmdsize;
2269 dyld_info = lc_obj;
2270 }
2271 } break;
2272
2273 case LC_LOAD_DYLIB:
2274 case LC_LOAD_WEAK_DYLIB:
2275 case LC_REEXPORT_DYLIB:
2276 case LC_LOADFVMLIB:
2277 case LC_LOAD_UPWARD_DYLIB: {
2278 uint32_t name_offset = cmd_offset + m_data_nsp->GetU32(&offset);
2279 const char *path = m_data_nsp->PeekCStr(name_offset);
2280 if (path) {
2281 FileSpec file_spec(path);
2282 // Strip the path if there is @rpath, @executable, etc so we just use
2283 // the basename
2284 if (path[0] == '@')
2285 file_spec.ClearDirectory();
2286
2287 if (lc.cmd == LC_REEXPORT_DYLIB) {
2288 m_reexported_dylibs.AppendIfUnique(file_spec);
2289 }
2290
2291 dylib_files.Append(file_spec);
2292 }
2293 } break;
2294
2295 case LC_DYLD_EXPORTS_TRIE: {
2296 llvm::MachO::linkedit_data_command lc_obj;
2297 lc_obj.cmd = lc.cmd;
2298 lc_obj.cmdsize = lc.cmdsize;
2299 if (m_data_nsp->GetU32(&offset, &lc_obj.dataoff, 2))
2300 exports_trie_load_command = lc_obj;
2301 } break;
2302 case LC_FUNCTION_STARTS: {
2303 llvm::MachO::linkedit_data_command lc_obj;
2304 lc_obj.cmd = lc.cmd;
2305 lc_obj.cmdsize = lc.cmdsize;
2306 if (m_data_nsp->GetU32(&offset, &lc_obj.dataoff, 2))
2307 function_starts_load_command = lc_obj;
2308 } break;
2309
2310 case LC_UUID: {
2311 const uint8_t *uuid_bytes = m_data_nsp->PeekData(offset, 16);
2312
2313 if (uuid_bytes)
2314 image_uuid = UUID(uuid_bytes, 16);
2315 break;
2316 }
2317
2318 default:
2319 break;
2320 }
2321 offset = cmd_offset + lc.cmdsize;
2322 }
2323
2324 if (!symtab_load_command.cmd)
2325 return;
2326
2327 SectionList *section_list = GetSectionList();
2328 if (section_list == nullptr)
2329 return;
2330
2331 const uint32_t addr_byte_size = m_data_nsp->GetAddressByteSize();
2332 const ByteOrder byte_order = m_data_nsp->GetByteOrder();
2333 bool bit_width_32 = addr_byte_size == 4;
2334 const size_t nlist_byte_size =
2335 bit_width_32 ? sizeof(struct nlist) : sizeof(struct nlist_64);
2336
2337 DataExtractor nlist_data(nullptr, 0, byte_order, addr_byte_size);
2338 DataExtractor strtab_data(nullptr, 0, byte_order, addr_byte_size);
2339 DataExtractor function_starts_data(nullptr, 0, byte_order, addr_byte_size);
2340 DataExtractor indirect_symbol_index_data(nullptr, 0, byte_order,
2341 addr_byte_size);
2342 DataExtractor dyld_trie_data(nullptr, 0, byte_order, addr_byte_size);
2343
2344 const addr_t nlist_data_byte_size =
2345 symtab_load_command.nsyms * nlist_byte_size;
2346 const addr_t strtab_data_byte_size = symtab_load_command.strsize;
2347 addr_t strtab_addr = LLDB_INVALID_ADDRESS;
2348
2349 ProcessSP process_sp(m_process_wp.lock());
2350 Process *process = process_sp.get();
2351
2352 uint32_t memory_module_load_level = eMemoryModuleLoadLevelComplete;
2353 bool is_shared_cache_image = IsSharedCacheBinary();
2354 bool is_local_shared_cache_image = is_shared_cache_image && !IsInMemory();
2355
2356 ConstString g_segment_name_TEXT = GetSegmentNameTEXT();
2357 ConstString g_segment_name_DATA = GetSegmentNameDATA();
2358 ConstString g_segment_name_DATA_DIRTY = GetSegmentNameDATA_DIRTY();
2359 ConstString g_segment_name_DATA_CONST = GetSegmentNameDATA_CONST();
2360 ConstString g_segment_name_OBJC = GetSegmentNameOBJC();
2361 ConstString g_section_name_eh_frame = GetSectionNameEHFrame();
2362 ConstString g_section_name_lldb_no_nlist = GetSectionNameLLDBNoNlist();
2363 SectionSP text_section_sp(
2364 section_list->FindSectionByName(g_segment_name_TEXT));
2365 SectionSP data_section_sp(
2366 section_list->FindSectionByName(g_segment_name_DATA));
2367 SectionSP linkedit_section_sp(
2368 section_list->FindSectionByName(GetSegmentNameLINKEDIT()));
2369 SectionSP data_dirty_section_sp(
2370 section_list->FindSectionByName(g_segment_name_DATA_DIRTY));
2371 SectionSP data_const_section_sp(
2372 section_list->FindSectionByName(g_segment_name_DATA_CONST));
2373 SectionSP objc_section_sp(
2374 section_list->FindSectionByName(g_segment_name_OBJC));
2375 SectionSP eh_frame_section_sp;
2376 SectionSP lldb_no_nlist_section_sp;
2377 if (text_section_sp.get()) {
2378 eh_frame_section_sp = text_section_sp->GetChildren().FindSectionByName(
2379 g_section_name_eh_frame);
2380 lldb_no_nlist_section_sp = text_section_sp->GetChildren().FindSectionByName(
2381 g_section_name_lldb_no_nlist);
2382 } else {
2383 eh_frame_section_sp =
2384 section_list->FindSectionByName(g_section_name_eh_frame);
2385 lldb_no_nlist_section_sp =
2386 section_list->FindSectionByName(g_section_name_lldb_no_nlist);
2387 }
2388
2389 if (process && m_header.filetype != llvm::MachO::MH_OBJECT &&
2390 !is_local_shared_cache_image) {
2391 Target &target = process->GetTarget();
2392
2393 memory_module_load_level = target.GetMemoryModuleLoadLevel();
2394
2395 // If __TEXT,__lldb_no_nlist section is present in this binary,
2396 // and we're reading it out of memory, do not read any of the
2397 // nlist entries. They are not needed in lldb and it may be
2398 // expensive to load these. This is to handle a dylib consisting
2399 // of only metadata, no code, but it has many nlist entries.
2400 if (lldb_no_nlist_section_sp)
2401 memory_module_load_level = eMemoryModuleLoadLevelMinimal;
2402
2403 // Reading mach file from memory in a process or core file...
2404
2405 if (linkedit_section_sp) {
2406 addr_t linkedit_load_addr =
2407 linkedit_section_sp->GetLoadBaseAddress(&target);
2408 if (linkedit_load_addr == LLDB_INVALID_ADDRESS) {
2409 // We might be trying to access the symbol table before the
2410 // __LINKEDIT's load address has been set in the target. We can't
2411 // fail to read the symbol table, so calculate the right address
2412 // manually
2413 linkedit_load_addr = CalculateSectionLoadAddressForMemoryImage(
2414 m_memory_addr, GetMachHeaderSection(), linkedit_section_sp.get());
2415 }
2416
2417 const addr_t linkedit_file_offset = linkedit_section_sp->GetFileOffset();
2418 const addr_t symoff_addr = linkedit_load_addr +
2419 symtab_load_command.symoff -
2420 linkedit_file_offset;
2421 strtab_addr = linkedit_load_addr + symtab_load_command.stroff -
2422 linkedit_file_offset;
2423
2424 // Always load dyld - the dynamic linker - from memory if we didn't
2425 // find a binary anywhere else. lldb will not register
2426 // dylib/framework/bundle loads/unloads if we don't have the dyld
2427 // symbols, we force dyld to load from memory despite the user's
2428 // target.memory-module-load-level setting.
2429 if (memory_module_load_level == eMemoryModuleLoadLevelComplete ||
2430 m_header.filetype == llvm::MachO::MH_DYLINKER) {
2431 DataBufferSP nlist_data_sp(
2432 ReadMemory(process_sp, symoff_addr, nlist_data_byte_size));
2433 if (nlist_data_sp)
2434 nlist_data.SetData(nlist_data_sp, 0, nlist_data_sp->GetByteSize());
2435 if (dysymtab.nindirectsyms != 0) {
2436 const addr_t indirect_syms_addr = linkedit_load_addr +
2437 dysymtab.indirectsymoff -
2438 linkedit_file_offset;
2439 DataBufferSP indirect_syms_data_sp(ReadMemory(
2440 process_sp, indirect_syms_addr, dysymtab.nindirectsyms * 4));
2441 if (indirect_syms_data_sp)
2442 indirect_symbol_index_data.SetData(
2443 indirect_syms_data_sp, 0, indirect_syms_data_sp->GetByteSize());
2444 // If this binary is outside the shared cache,
2445 // cache the string table.
2446 // Binaries in the shared cache all share a giant string table,
2447 // and we can't share the string tables across multiple
2448 // ObjectFileMachO's, so we'd end up re-reading this mega-strtab
2449 // for every binary in the shared cache - it would be a big perf
2450 // problem. For binaries outside the shared cache, it's faster to
2451 // read the entire strtab at once instead of piece-by-piece as we
2452 // process the nlist records.
2453 if (!is_shared_cache_image) {
2454 DataBufferSP strtab_data_sp(
2455 ReadMemory(process_sp, strtab_addr, strtab_data_byte_size));
2456 if (strtab_data_sp) {
2457 strtab_data.SetData(strtab_data_sp, 0,
2458 strtab_data_sp->GetByteSize());
2459 }
2460 }
2461 }
2462 if (memory_module_load_level >= eMemoryModuleLoadLevelPartial) {
2463 if (function_starts_load_command.cmd) {
2464 const addr_t func_start_addr =
2465 linkedit_load_addr + function_starts_load_command.dataoff -
2466 linkedit_file_offset;
2467 DataBufferSP func_start_data_sp(
2468 ReadMemory(process_sp, func_start_addr,
2469 function_starts_load_command.datasize));
2470 if (func_start_data_sp)
2471 function_starts_data.SetData(func_start_data_sp, 0,
2472 func_start_data_sp->GetByteSize());
2473 }
2474 }
2475 }
2476 }
2477 } else {
2478 if (is_local_shared_cache_image) {
2479 // The load commands in shared cache images are relative to the
2480 // beginning of the shared cache, not the library image. The
2481 // data we get handed when creating the ObjectFileMachO starts
2482 // at the beginning of a specific library and spans to the end
2483 // of the cache to be able to reach the shared LINKEDIT
2484 // segments. We need to convert the load command offsets to be
2485 // relative to the beginning of our specific image.
2486 lldb::addr_t linkedit_offset = linkedit_section_sp->GetFileOffset();
2487 lldb::offset_t linkedit_slide =
2488 linkedit_offset - m_linkedit_original_offset;
2489 symtab_load_command.symoff += linkedit_slide;
2490 symtab_load_command.stroff += linkedit_slide;
2491 dyld_info.export_off += linkedit_slide;
2492 dysymtab.indirectsymoff += linkedit_slide;
2493 function_starts_load_command.dataoff += linkedit_slide;
2494 exports_trie_load_command.dataoff += linkedit_slide;
2495 }
2496
2497 nlist_data = *m_data_nsp->GetSubsetExtractorSP(symtab_load_command.symoff,
2498 nlist_data_byte_size);
2499 strtab_data = *m_data_nsp->GetSubsetExtractorSP(symtab_load_command.stroff,
2500 strtab_data_byte_size);
2501
2502 // We shouldn't have exports data from both the LC_DYLD_INFO command
2503 // AND the LC_DYLD_EXPORTS_TRIE command in the same binary:
2504 lldbassert(!((dyld_info.export_size > 0)
2505 && (exports_trie_load_command.datasize > 0)));
2506 if (dyld_info.export_size > 0) {
2507 dyld_trie_data = *m_data_nsp->GetSubsetExtractorSP(dyld_info.export_off,
2508 dyld_info.export_size);
2509 } else if (exports_trie_load_command.datasize > 0) {
2510 dyld_trie_data =
2511 *m_data_nsp->GetSubsetExtractorSP(exports_trie_load_command.dataoff,
2512 exports_trie_load_command.datasize);
2513 }
2514
2515 if (dysymtab.nindirectsyms != 0) {
2516 indirect_symbol_index_data = *m_data_nsp->GetSubsetExtractorSP(
2517 dysymtab.indirectsymoff, dysymtab.nindirectsyms * 4);
2518 }
2519 if (function_starts_load_command.cmd) {
2520 function_starts_data = *m_data_nsp->GetSubsetExtractorSP(
2521 function_starts_load_command.dataoff,
2522 function_starts_load_command.datasize);
2523 }
2524 }
2525
2526 const bool have_strtab_data = strtab_data.GetByteSize() > 0;
2527
2528 const bool is_arm = (m_header.cputype == llvm::MachO::CPU_TYPE_ARM);
2529 const bool always_thumb = GetArchitecture().IsAlwaysThumbInstructions();
2530
2531 // lldb works best if it knows the start address of all functions in a
2532 // module. Linker symbols or debug info are normally the best source of
2533 // information for start addr / size but they may be stripped in a released
2534 // binary. Two additional sources of information exist in Mach-O binaries:
2535 // LC_FUNCTION_STARTS - a list of ULEB128 encoded offsets of each
2536 // function's start address in the
2537 // binary, relative to the text section.
2538 // eh_frame - the eh_frame FDEs have the start addr & size of
2539 // each function
2540 // LC_FUNCTION_STARTS is the fastest source to read in, and is present on
2541 // all modern binaries.
2542 // Binaries built to run on older releases may need to use eh_frame
2543 // information.
2544
2545 if (text_section_sp && function_starts_data.GetByteSize()) {
2546 FunctionStarts::Entry function_start_entry;
2547 function_start_entry.data = false;
2548 lldb::offset_t function_start_offset = 0;
2549 function_start_entry.addr = text_section_sp->GetFileAddress();
2550 uint64_t delta;
2551 while ((delta = function_starts_data.GetULEB128(&function_start_offset)) >
2552 0) {
2553 // Now append the current entry
2554 function_start_entry.addr += delta;
2555 if (is_arm) {
2556 if (function_start_entry.addr & 1) {
2557 function_start_entry.addr &= THUMB_ADDRESS_BIT_MASK;
2558 function_start_entry.data = true;
2559 } else if (always_thumb) {
2560 function_start_entry.data = true;
2561 }
2562 }
2563 function_starts.Append(function_start_entry);
2564 }
2565 } else {
2566 // If m_type is eTypeDebugInfo, then this is a dSYM - it will have the
2567 // load command claiming an eh_frame but it doesn't actually have the
2568 // eh_frame content. And if we have a dSYM, we don't need to do any of
2569 // this fill-in-the-missing-symbols works anyway - the debug info should
2570 // give us all the functions in the module.
2571 if (text_section_sp.get() && eh_frame_section_sp.get() &&
2573 DWARFCallFrameInfo eh_frame(*this, eh_frame_section_sp,
2576 eh_frame.GetFunctionAddressAndSizeVector(functions);
2577 addr_t text_base_addr = text_section_sp->GetFileAddress();
2578 size_t count = functions.GetSize();
2579 for (size_t i = 0; i < count; ++i) {
2581 functions.GetEntryAtIndex(i);
2582 if (func) {
2583 FunctionStarts::Entry function_start_entry;
2584 function_start_entry.addr = func->base - text_base_addr;
2585 if (is_arm) {
2586 if (function_start_entry.addr & 1) {
2587 function_start_entry.addr &= THUMB_ADDRESS_BIT_MASK;
2588 function_start_entry.data = true;
2589 } else if (always_thumb) {
2590 function_start_entry.data = true;
2591 }
2592 }
2593 function_starts.Append(function_start_entry);
2594 }
2595 }
2596 }
2597 }
2598
2599 const size_t function_starts_count = function_starts.GetSize();
2600
2601 // For user process binaries (executables, dylibs, frameworks, bundles), if
2602 // we don't have LC_FUNCTION_STARTS/eh_frame section in this binary, we're
2603 // going to assume the binary has been stripped. Don't allow assembly
2604 // language instruction emulation because we don't know proper function
2605 // start boundaries.
2606 //
2607 // For all other types of binaries (kernels, stand-alone bare board
2608 // binaries, kexts), they may not have LC_FUNCTION_STARTS / eh_frame
2609 // sections - we should not make any assumptions about them based on that.
2610 if (function_starts_count == 0 && CalculateStrata() == eStrataUser) {
2612 Log *unwind_or_symbol_log(GetLog(LLDBLog::Symbols | LLDBLog::Unwind));
2613
2614 if (unwind_or_symbol_log)
2615 module_sp->LogMessage(
2616 unwind_or_symbol_log,
2617 "no LC_FUNCTION_STARTS, will not allow assembly profiled unwinds");
2618 }
2619
2620 const user_id_t TEXT_eh_frame_sectID = eh_frame_section_sp.get()
2621 ? eh_frame_section_sp->GetID()
2622 : static_cast<user_id_t>(NO_SECT);
2623
2624 uint32_t N_SO_index = UINT32_MAX;
2625
2626 MachSymtabSectionInfo section_info(section_list);
2627 std::vector<uint32_t> N_FUN_indexes;
2628 std::vector<uint32_t> N_NSYM_indexes;
2629 std::vector<uint32_t> N_INCL_indexes;
2630 std::vector<uint32_t> N_BRAC_indexes;
2631 std::vector<uint32_t> N_COMM_indexes;
2632 typedef std::multimap<uint64_t, uint32_t> ValueToSymbolIndexMap;
2633 typedef llvm::DenseMap<uint32_t, uint32_t> NListIndexToSymbolIndexMap;
2634 typedef llvm::DenseMap<const char *, uint32_t> ConstNameToSymbolIndexMap;
2635 ValueToSymbolIndexMap N_FUN_addr_to_sym_idx;
2636 ValueToSymbolIndexMap N_STSYM_addr_to_sym_idx;
2637 ConstNameToSymbolIndexMap N_GSYM_name_to_sym_idx;
2638 // Any symbols that get merged into another will get an entry in this map
2639 // so we know
2640 NListIndexToSymbolIndexMap m_nlist_idx_to_sym_idx;
2641 uint32_t nlist_idx = 0;
2642 Symbol *symbol_ptr = nullptr;
2643
2644 uint32_t sym_idx = 0;
2645 Symbol *sym = nullptr;
2646 size_t num_syms = 0;
2647 std::string memory_symbol_name;
2648 uint32_t unmapped_local_symbols_found = 0;
2649
2650 std::vector<TrieEntryWithOffset> reexport_trie_entries;
2651 std::vector<TrieEntryWithOffset> external_sym_trie_entries;
2652 std::set<lldb::addr_t> resolver_addresses;
2653
2654 const size_t dyld_trie_data_size = dyld_trie_data.GetByteSize();
2655 if (dyld_trie_data_size > 0) {
2656 LLDB_LOG(log, "Parsing {0} bytes of dyld trie data", dyld_trie_data_size);
2657 SectionSP text_segment_sp =
2659 lldb::addr_t text_segment_file_addr = LLDB_INVALID_ADDRESS;
2660 if (text_segment_sp)
2661 text_segment_file_addr = text_segment_sp->GetFileAddress();
2662 std::vector<llvm::StringRef> nameSlices;
2663 ParseTrieEntries(dyld_trie_data, 0, is_arm, text_segment_file_addr,
2664 nameSlices, resolver_addresses, reexport_trie_entries,
2665 external_sym_trie_entries);
2666 }
2667
2668 typedef std::set<ConstString> IndirectSymbols;
2669 IndirectSymbols indirect_symbol_names;
2670
2671#if TARGET_OS_IPHONE
2672
2673 // Some recent builds of the dyld_shared_cache (hereafter: DSC) have been
2674 // optimized by moving LOCAL symbols out of the memory mapped portion of
2675 // the DSC. The symbol information has all been retained, but it isn't
2676 // available in the normal nlist data. However, there *are* duplicate
2677 // entries of *some*
2678 // LOCAL symbols in the normal nlist data. To handle this situation
2679 // correctly, we must first attempt
2680 // to parse any DSC unmapped symbol information. If we find any, we set a
2681 // flag that tells the normal nlist parser to ignore all LOCAL symbols.
2682
2683 if (IsSharedCacheBinary()) {
2684 // Before we can start mapping the DSC, we need to make certain the
2685 // target process is actually using the cache we can find.
2686
2687 // Next we need to determine the correct path for the dyld shared cache.
2688
2689 ArchSpec header_arch = GetArchitecture();
2690
2691 UUID dsc_uuid;
2692 UUID process_shared_cache_uuid;
2693 addr_t process_shared_cache_base_addr;
2694
2695 if (process) {
2696 GetProcessSharedCacheUUID(process, process_shared_cache_base_addr,
2697 process_shared_cache_uuid);
2698 }
2699
2700 __block bool found_image = false;
2701 __block void *nlist_buffer = nullptr;
2702 __block unsigned nlist_count = 0;
2703 __block char *string_table = nullptr;
2704 __block vm_offset_t vm_nlist_memory = 0;
2705 __block mach_msg_type_number_t vm_nlist_bytes_read = 0;
2706 __block vm_offset_t vm_string_memory = 0;
2707 __block mach_msg_type_number_t vm_string_bytes_read = 0;
2708
2709 llvm::scope_exit _(^{
2710 if (vm_nlist_memory)
2711 vm_deallocate(mach_task_self(), vm_nlist_memory, vm_nlist_bytes_read);
2712 if (vm_string_memory)
2713 vm_deallocate(mach_task_self(), vm_string_memory, vm_string_bytes_read);
2714 });
2715
2716 typedef llvm::DenseMap<ConstString, uint16_t> UndefinedNameToDescMap;
2717 typedef llvm::DenseMap<uint32_t, ConstString> SymbolIndexToName;
2718 UndefinedNameToDescMap undefined_name_to_desc;
2719 SymbolIndexToName reexport_shlib_needs_fixup;
2720
2721 dyld_for_each_installed_shared_cache(^(dyld_shared_cache_t shared_cache) {
2722 uuid_t cache_uuid;
2723 dyld_shared_cache_copy_uuid(shared_cache, &cache_uuid);
2724 if (found_image)
2725 return;
2726
2727 if (process_shared_cache_uuid.IsValid() &&
2728 process_shared_cache_uuid != UUID(&cache_uuid, 16))
2729 return;
2730
2731 dyld_shared_cache_for_each_image(shared_cache, ^(dyld_image_t image) {
2732 uuid_t dsc_image_uuid;
2733 if (found_image)
2734 return;
2735
2736 dyld_image_copy_uuid(image, &dsc_image_uuid);
2737 if (image_uuid != UUID(dsc_image_uuid, 16))
2738 return;
2739
2740 found_image = true;
2741
2742 // Compute the size of the string table. We need to ask dyld for a
2743 // new SPI to avoid this step.
2744 dyld_image_local_nlist_content_4Symbolication(
2745 image, ^(const void *nlistStart, uint64_t nlistCount,
2746 const char *stringTable) {
2747 if (!nlistStart || !nlistCount)
2748 return;
2749
2750 // The buffers passed here are valid only inside the block.
2751 // Use vm_read to make a cheap copy of them available for our
2752 // processing later.
2753 kern_return_t ret =
2754 vm_read(mach_task_self(), (vm_address_t)nlistStart,
2755 nlist_byte_size * nlistCount, &vm_nlist_memory,
2756 &vm_nlist_bytes_read);
2757 if (ret != KERN_SUCCESS)
2758 return;
2759 assert(vm_nlist_bytes_read == nlist_byte_size * nlistCount);
2760
2761 // We don't know the size of the string table. It's cheaper
2762 // to map the whole VM region than to determine the size by
2763 // parsing all the nlist entries.
2764 vm_address_t string_address = (vm_address_t)stringTable;
2765 vm_size_t region_size;
2766 mach_msg_type_number_t info_count = VM_REGION_BASIC_INFO_COUNT_64;
2767 vm_region_basic_info_data_t info;
2768 memory_object_name_t object;
2769 ret = vm_region_64(mach_task_self(), &string_address,
2770 &region_size, VM_REGION_BASIC_INFO_64,
2771 (vm_region_info_t)&info, &info_count, &object);
2772 if (ret != KERN_SUCCESS)
2773 return;
2774
2775 ret = vm_read(mach_task_self(), (vm_address_t)stringTable,
2776 region_size -
2777 ((vm_address_t)stringTable - string_address),
2778 &vm_string_memory, &vm_string_bytes_read);
2779 if (ret != KERN_SUCCESS)
2780 return;
2781
2782 nlist_buffer = (void *)vm_nlist_memory;
2783 string_table = (char *)vm_string_memory;
2784 nlist_count = nlistCount;
2785 });
2786 });
2787 });
2788 if (nlist_buffer) {
2789 DataExtractor dsc_local_symbols_data(nlist_buffer,
2790 nlist_count * nlist_byte_size,
2791 byte_order, addr_byte_size);
2792 unmapped_local_symbols_found = nlist_count;
2793
2794 // The normal nlist code cannot correctly size the Symbols
2795 // array, we need to allocate it here.
2796 sym = symtab.Resize(
2797 symtab_load_command.nsyms + m_dysymtab.nindirectsyms +
2798 unmapped_local_symbols_found - m_dysymtab.nlocalsym);
2799 num_syms = symtab.GetNumSymbols();
2800
2801 lldb::offset_t nlist_data_offset = 0;
2802
2803 for (uint32_t nlist_index = 0;
2804 nlist_index < nlist_count;
2805 nlist_index++) {
2806 /////////////////////////////
2807 {
2808 std::optional<struct nlist_64> nlist_maybe =
2809 ParseNList(dsc_local_symbols_data, nlist_data_offset,
2810 nlist_byte_size);
2811 if (!nlist_maybe)
2812 break;
2813 struct nlist_64 nlist = *nlist_maybe;
2814
2816 const char *symbol_name = string_table + nlist.n_strx;
2817
2818 if (symbol_name == NULL) {
2819 // No symbol should be NULL, even the symbols with no
2820 // string values should have an offset zero which
2821 // points to an empty C-string
2822 Debugger::ReportError(llvm::formatv(
2823 "DSC unmapped local symbol[{0}] has invalid "
2824 "string table offset {1:x} in {2}, ignoring symbol",
2825 nlist_index, nlist.n_strx,
2826 module_sp->GetFileSpec().GetPath()));
2827 continue;
2828 }
2829 if (symbol_name[0] == '\0')
2830 symbol_name = NULL;
2831
2832 const char *symbol_name_non_abi_mangled = NULL;
2833
2834 SectionSP symbol_section;
2835 bool add_nlist = true;
2836 bool is_debug = ((nlist.n_type & N_STAB) != 0);
2837 bool demangled_is_synthesized = false;
2838 bool is_gsym = false;
2839 bool set_value = true;
2840
2841 assert(sym_idx < num_syms);
2842
2843 sym[sym_idx].SetDebug(is_debug);
2844
2845 if (is_debug) {
2846 switch (nlist.n_type) {
2847 case N_GSYM:
2848 // global symbol: name,,NO_SECT,type,0
2849 // Sometimes the N_GSYM value contains the address.
2850
2851 // FIXME: In the .o files, we have a GSYM and a debug
2852 // symbol for all the ObjC data. They
2853 // have the same address, but we want to ensure that
2854 // we always find only the real symbol, 'cause we
2855 // don't currently correctly attribute the
2856 // GSYM one to the ObjCClass/Ivar/MetaClass
2857 // symbol type. This is a temporary hack to make
2858 // sure the ObjectiveC symbols get treated correctly.
2859 // To do this right, we should coalesce all the GSYM
2860 // & global symbols that have the same address.
2861
2862 is_gsym = true;
2863 sym[sym_idx].SetExternal(true);
2864
2866 symbol_name, symbol_name_non_abi_mangled,
2867 type)) {
2868 demangled_is_synthesized = true;
2869 } else {
2870 if (nlist.n_value != 0)
2871 symbol_section = section_info.GetSection(
2872 nlist.n_sect, nlist.n_value);
2873
2874 type = eSymbolTypeData;
2875 }
2876 break;
2877
2878 case N_FNAME:
2879 // procedure name (f77 kludge): name,,NO_SECT,0,0
2880 type = eSymbolTypeCompiler;
2881 break;
2882
2883 case N_FUN:
2884 // procedure: name,,n_sect,linenumber,address
2885 if (symbol_name) {
2886 type = eSymbolTypeCode;
2887 symbol_section = section_info.GetSection(
2888 nlist.n_sect, nlist.n_value);
2889
2890 N_FUN_addr_to_sym_idx.insert(
2891 std::make_pair(nlist.n_value, sym_idx));
2892 // We use the current number of symbols in the
2893 // symbol table in lieu of using nlist_idx in case
2894 // we ever start trimming entries out
2895 N_FUN_indexes.push_back(sym_idx);
2896 } else {
2897 type = eSymbolTypeCompiler;
2898
2899 if (!N_FUN_indexes.empty()) {
2900 // Copy the size of the function into the
2901 // original
2902 // STAB entry so we don't have
2903 // to hunt for it later
2904 symtab.SymbolAtIndex(N_FUN_indexes.back())
2905 ->SetByteSize(nlist.n_value);
2906 N_FUN_indexes.pop_back();
2907 // We don't really need the end function STAB as
2908 // it contains the size which we already placed
2909 // with the original symbol, so don't add it if
2910 // we want a minimal symbol table
2911 add_nlist = false;
2912 }
2913 }
2914 break;
2915
2916 case N_STSYM:
2917 // static symbol: name,,n_sect,type,address
2918 N_STSYM_addr_to_sym_idx.insert(
2919 std::make_pair(nlist.n_value, sym_idx));
2920 symbol_section = section_info.GetSection(nlist.n_sect,
2921 nlist.n_value);
2922 if (symbol_name && symbol_name[0]) {
2924 symbol_name + 1, eSymbolTypeData);
2925 }
2926 break;
2927
2928 case N_LCSYM:
2929 // .lcomm symbol: name,,n_sect,type,address
2930 symbol_section = section_info.GetSection(nlist.n_sect,
2931 nlist.n_value);
2933 break;
2934
2935 case N_BNSYM:
2936 // We use the current number of symbols in the symbol
2937 // table in lieu of using nlist_idx in case we ever
2938 // start trimming entries out Skip these if we want
2939 // minimal symbol tables
2940 add_nlist = false;
2941 break;
2942
2943 case N_ENSYM:
2944 // Set the size of the N_BNSYM to the terminating
2945 // index of this N_ENSYM so that we can always skip
2946 // the entire symbol if we need to navigate more
2947 // quickly at the source level when parsing STABS
2948 // Skip these if we want minimal symbol tables
2949 add_nlist = false;
2950 break;
2951
2952 case N_OPT:
2953 // emitted with gcc2_compiled and in gcc source
2954 type = eSymbolTypeCompiler;
2955 break;
2956
2957 case N_RSYM:
2958 // register sym: name,,NO_SECT,type,register
2959 type = eSymbolTypeVariable;
2960 break;
2961
2962 case N_SLINE:
2963 // src line: 0,,n_sect,linenumber,address
2964 symbol_section = section_info.GetSection(nlist.n_sect,
2965 nlist.n_value);
2966 type = eSymbolTypeLineEntry;
2967 break;
2968
2969 case N_SSYM:
2970 // structure elt: name,,NO_SECT,type,struct_offset
2972 break;
2973
2974 case N_SO:
2975 // source file name
2976 type = eSymbolTypeSourceFile;
2977 if (symbol_name == NULL) {
2978 add_nlist = false;
2979 if (N_SO_index != UINT32_MAX) {
2980 // Set the size of the N_SO to the terminating
2981 // index of this N_SO so that we can always skip
2982 // the entire N_SO if we need to navigate more
2983 // quickly at the source level when parsing STABS
2984 symbol_ptr = symtab.SymbolAtIndex(N_SO_index);
2985 symbol_ptr->SetByteSize(sym_idx);
2986 symbol_ptr->SetSizeIsSibling(true);
2987 }
2988 N_NSYM_indexes.clear();
2989 N_INCL_indexes.clear();
2990 N_BRAC_indexes.clear();
2991 N_COMM_indexes.clear();
2992 N_FUN_indexes.clear();
2993 N_SO_index = UINT32_MAX;
2994 } else {
2995 // We use the current number of symbols in the
2996 // symbol table in lieu of using nlist_idx in case
2997 // we ever start trimming entries out
2998 const bool N_SO_has_full_path = symbol_name[0] == '/';
2999 if (N_SO_has_full_path) {
3000 if ((N_SO_index == sym_idx - 1) &&
3001 ((sym_idx - 1) < num_syms)) {
3002 // We have two consecutive N_SO entries where
3003 // the first contains a directory and the
3004 // second contains a full path.
3005 sym[sym_idx - 1].GetMangled().SetValue(
3006 ConstString(symbol_name));
3007 m_nlist_idx_to_sym_idx[nlist_idx] = sym_idx - 1;
3008 add_nlist = false;
3009 } else {
3010 // This is the first entry in a N_SO that
3011 // contains a directory or
3012 // a full path to the source file
3013 N_SO_index = sym_idx;
3014 }
3015 } else if ((N_SO_index == sym_idx - 1) &&
3016 ((sym_idx - 1) < num_syms)) {
3017 // This is usually the second N_SO entry that
3018 // contains just the filename, so here we combine
3019 // it with the first one if we are minimizing the
3020 // symbol table
3021 const char *so_path = sym[sym_idx - 1]
3022 .GetMangled()
3024 .AsCString();
3025 if (so_path && so_path[0]) {
3026 std::string full_so_path(so_path);
3027 const size_t double_slash_pos =
3028 full_so_path.find("//");
3029 if (double_slash_pos != std::string::npos) {
3030 // The linker has been generating bad N_SO
3031 // entries with doubled up paths
3032 // in the format "%s%s" where the first
3033 // string in the DW_AT_comp_dir, and the
3034 // second is the directory for the source
3035 // file so you end up with a path that looks
3036 // like "/tmp/src//tmp/src/"
3037 FileSpec so_dir(so_path);
3038 if (!FileSystem::Instance().Exists(so_dir)) {
3039 so_dir.SetFile(
3040 &full_so_path[double_slash_pos + 1],
3041 FileSpec::Style::native);
3042 if (FileSystem::Instance().Exists(so_dir)) {
3043 // Trim off the incorrect path
3044 full_so_path.erase(0, double_slash_pos + 1);
3045 }
3046 }
3047 }
3048 if (*full_so_path.rbegin() != '/')
3049 full_so_path += '/';
3050 full_so_path += symbol_name;
3051 sym[sym_idx - 1].GetMangled().SetValue(
3052 ConstString(full_so_path.c_str()));
3053 add_nlist = false;
3054 m_nlist_idx_to_sym_idx[nlist_idx] = sym_idx - 1;
3055 }
3056 } else {
3057 // This could be a relative path to a N_SO
3058 N_SO_index = sym_idx;
3059 }
3060 }
3061 break;
3062
3063 case N_OSO:
3064 // object file name: name,,0,0,st_mtime
3065 type = eSymbolTypeObjectFile;
3066 break;
3067
3068 case N_LSYM:
3069 // local sym: name,,NO_SECT,type,offset
3070 type = eSymbolTypeLocal;
3071 break;
3072
3073 // INCL scopes
3074 case N_BINCL:
3075 // include file beginning: name,,NO_SECT,0,sum We use
3076 // the current number of symbols in the symbol table
3077 // in lieu of using nlist_idx in case we ever start
3078 // trimming entries out
3079 N_INCL_indexes.push_back(sym_idx);
3080 type = eSymbolTypeScopeBegin;
3081 break;
3082
3083 case N_EINCL:
3084 // include file end: name,,NO_SECT,0,0
3085 // Set the size of the N_BINCL to the terminating
3086 // index of this N_EINCL so that we can always skip
3087 // the entire symbol if we need to navigate more
3088 // quickly at the source level when parsing STABS
3089 if (!N_INCL_indexes.empty()) {
3090 symbol_ptr =
3091 symtab.SymbolAtIndex(N_INCL_indexes.back());
3092 symbol_ptr->SetByteSize(sym_idx + 1);
3093 symbol_ptr->SetSizeIsSibling(true);
3094 N_INCL_indexes.pop_back();
3095 }
3096 type = eSymbolTypeScopeEnd;
3097 break;
3098
3099 case N_SOL:
3100 // #included file name: name,,n_sect,0,address
3101 type = eSymbolTypeHeaderFile;
3102
3103 // We currently don't use the header files on darwin
3104 add_nlist = false;
3105 break;
3106
3107 case N_PARAMS:
3108 // compiler parameters: name,,NO_SECT,0,0
3109 type = eSymbolTypeCompiler;
3110 break;
3111
3112 case N_VERSION:
3113 // compiler version: name,,NO_SECT,0,0
3114 type = eSymbolTypeCompiler;
3115 break;
3116
3117 case N_OLEVEL:
3118 // compiler -O level: name,,NO_SECT,0,0
3119 type = eSymbolTypeCompiler;
3120 break;
3121
3122 case N_PSYM:
3123 // parameter: name,,NO_SECT,type,offset
3124 type = eSymbolTypeVariable;
3125 break;
3126
3127 case N_ENTRY:
3128 // alternate entry: name,,n_sect,linenumber,address
3129 symbol_section = section_info.GetSection(nlist.n_sect,
3130 nlist.n_value);
3131 type = eSymbolTypeLineEntry;
3132 break;
3133
3134 // Left and Right Braces
3135 case N_LBRAC:
3136 // left bracket: 0,,NO_SECT,nesting level,address We
3137 // use the current number of symbols in the symbol
3138 // table in lieu of using nlist_idx in case we ever
3139 // start trimming entries out
3140 symbol_section = section_info.GetSection(nlist.n_sect,
3141 nlist.n_value);
3142 N_BRAC_indexes.push_back(sym_idx);
3143 type = eSymbolTypeScopeBegin;
3144 break;
3145
3146 case N_RBRAC:
3147 // right bracket: 0,,NO_SECT,nesting level,address
3148 // Set the size of the N_LBRAC to the terminating
3149 // index of this N_RBRAC so that we can always skip
3150 // the entire symbol if we need to navigate more
3151 // quickly at the source level when parsing STABS
3152 symbol_section = section_info.GetSection(nlist.n_sect,
3153 nlist.n_value);
3154 if (!N_BRAC_indexes.empty()) {
3155 symbol_ptr =
3156 symtab.SymbolAtIndex(N_BRAC_indexes.back());
3157 symbol_ptr->SetByteSize(sym_idx + 1);
3158 symbol_ptr->SetSizeIsSibling(true);
3159 N_BRAC_indexes.pop_back();
3160 }
3161 type = eSymbolTypeScopeEnd;
3162 break;
3163
3164 case N_EXCL:
3165 // deleted include file: name,,NO_SECT,0,sum
3166 type = eSymbolTypeHeaderFile;
3167 break;
3168
3169 // COMM scopes
3170 case N_BCOMM:
3171 // begin common: name,,NO_SECT,0,0
3172 // We use the current number of symbols in the symbol
3173 // table in lieu of using nlist_idx in case we ever
3174 // start trimming entries out
3175 type = eSymbolTypeScopeBegin;
3176 N_COMM_indexes.push_back(sym_idx);
3177 break;
3178
3179 case N_ECOML:
3180 // end common (local name): 0,,n_sect,0,address
3181 symbol_section = section_info.GetSection(nlist.n_sect,
3182 nlist.n_value);
3183 // Fall through
3184
3185 case N_ECOMM:
3186 // end common: name,,n_sect,0,0
3187 // Set the size of the N_BCOMM to the terminating
3188 // index of this N_ECOMM/N_ECOML so that we can
3189 // always skip the entire symbol if we need to
3190 // navigate more quickly at the source level when
3191 // parsing STABS
3192 if (!N_COMM_indexes.empty()) {
3193 symbol_ptr =
3194 symtab.SymbolAtIndex(N_COMM_indexes.back());
3195 symbol_ptr->SetByteSize(sym_idx + 1);
3196 symbol_ptr->SetSizeIsSibling(true);
3197 N_COMM_indexes.pop_back();
3198 }
3199 type = eSymbolTypeScopeEnd;
3200 break;
3201
3202 case N_LENG:
3203 // second stab entry with length information
3204 type = eSymbolTypeAdditional;
3205 break;
3206
3207 default:
3208 break;
3209 }
3210 } else {
3211 // uint8_t n_pext = N_PEXT & nlist.n_type;
3212 uint8_t n_type = N_TYPE & nlist.n_type;
3213 sym[sym_idx].SetExternal((N_EXT & nlist.n_type) != 0);
3214
3215 switch (n_type) {
3216 case N_INDR: {
3217 const char *reexport_name_cstr =
3218 strtab_data.PeekCStr(nlist.n_value);
3219 if (reexport_name_cstr && reexport_name_cstr[0]) {
3220 type = eSymbolTypeReExported;
3221 ConstString reexport_name(
3222 reexport_name_cstr +
3223 ((reexport_name_cstr[0] == '_') ? 1 : 0));
3224 sym[sym_idx].SetReExportedSymbolName(reexport_name);
3225 set_value = false;
3226 reexport_shlib_needs_fixup[sym_idx] = reexport_name;
3227 indirect_symbol_names.insert(ConstString(
3228 symbol_name + ((symbol_name[0] == '_') ? 1 : 0)));
3229 } else
3230 type = eSymbolTypeUndefined;
3231 } break;
3232
3233 case N_UNDF:
3234 if (symbol_name && symbol_name[0]) {
3235 ConstString undefined_name(
3236 symbol_name + ((symbol_name[0] == '_') ? 1 : 0));
3237 undefined_name_to_desc[undefined_name] = nlist.n_desc;
3238 }
3239 // Fall through
3240 case N_PBUD:
3241 type = eSymbolTypeUndefined;
3242 break;
3243
3244 case N_ABS:
3245 type = eSymbolTypeAbsolute;
3246 break;
3247
3248 case N_SECT: {
3249 symbol_section = section_info.GetSection(nlist.n_sect,
3250 nlist.n_value);
3251
3252 if (symbol_section == NULL) {
3253 // TODO: warn about this?
3254 add_nlist = false;
3255 break;
3256 }
3257
3258 if (TEXT_eh_frame_sectID == nlist.n_sect) {
3259 type = eSymbolTypeException;
3260 } else {
3261 uint32_t section_type =
3262 symbol_section->Get() & SECTION_TYPE;
3263
3264 switch (section_type) {
3265 case S_CSTRING_LITERALS:
3266 type = eSymbolTypeData;
3267 break; // section with only literal C strings
3268 case S_4BYTE_LITERALS:
3269 type = eSymbolTypeData;
3270 break; // section with only 4 byte literals
3271 case S_8BYTE_LITERALS:
3272 type = eSymbolTypeData;
3273 break; // section with only 8 byte literals
3274 case S_LITERAL_POINTERS:
3275 type = eSymbolTypeTrampoline;
3276 break; // section with only pointers to literals
3277 case S_NON_LAZY_SYMBOL_POINTERS:
3278 type = eSymbolTypeTrampoline;
3279 break; // section with only non-lazy symbol
3280 // pointers
3281 case S_LAZY_SYMBOL_POINTERS:
3282 type = eSymbolTypeTrampoline;
3283 break; // section with only lazy symbol pointers
3284 case S_SYMBOL_STUBS:
3285 type = eSymbolTypeTrampoline;
3286 break; // section with only symbol stubs, byte
3287 // size of stub in the reserved2 field
3288 case S_MOD_INIT_FUNC_POINTERS:
3289 type = eSymbolTypeCode;
3290 break; // section with only function pointers for
3291 // initialization
3292 case S_MOD_TERM_FUNC_POINTERS:
3293 type = eSymbolTypeCode;
3294 break; // section with only function pointers for
3295 // termination
3296 case S_INTERPOSING:
3297 type = eSymbolTypeTrampoline;
3298 break; // section with only pairs of function
3299 // pointers for interposing
3300 case S_16BYTE_LITERALS:
3301 type = eSymbolTypeData;
3302 break; // section with only 16 byte literals
3303 case S_DTRACE_DOF:
3305 break;
3306 case S_LAZY_DYLIB_SYMBOL_POINTERS:
3307 type = eSymbolTypeTrampoline;
3308 break;
3309 default:
3310 switch (symbol_section->GetType()) {
3312 type = eSymbolTypeCode;
3313 break;
3314 case eSectionTypeData:
3315 case eSectionTypeDataCString: // Inlined C string
3316 // data
3317 case eSectionTypeDataCStringPointers: // Pointers
3318 // to C
3319 // string
3320 // data
3321 case eSectionTypeDataSymbolAddress: // Address of
3322 // a symbol in
3323 // the symbol
3324 // table
3325 case eSectionTypeData4:
3326 case eSectionTypeData8:
3327 case eSectionTypeData16:
3328 type = eSymbolTypeData;
3329 break;
3330 default:
3331 break;
3332 }
3333 break;
3334 }
3335
3336 if (type == eSymbolTypeInvalid) {
3337 const char *symbol_sect_name =
3338 symbol_section->GetName().AsCString(nullptr);
3339 if (symbol_section->IsDescendant(
3340 text_section_sp.get())) {
3341 if (symbol_section->IsClear(
3342 S_ATTR_PURE_INSTRUCTIONS |
3343 S_ATTR_SELF_MODIFYING_CODE |
3344 S_ATTR_SOME_INSTRUCTIONS))
3345 type = eSymbolTypeData;
3346 else
3347 type = eSymbolTypeCode;
3348 } else if (symbol_section->IsDescendant(
3349 data_section_sp.get()) ||
3350 symbol_section->IsDescendant(
3351 data_dirty_section_sp.get()) ||
3352 symbol_section->IsDescendant(
3353 data_const_section_sp.get())) {
3354 if (symbol_sect_name &&
3355 ::strstr(symbol_sect_name, "__objc") ==
3356 symbol_sect_name) {
3357 type = eSymbolTypeRuntime;
3358
3360 symbol_name,
3361 symbol_name_non_abi_mangled, type))
3362 demangled_is_synthesized = true;
3363 } else if (symbol_sect_name &&
3364 ::strstr(symbol_sect_name,
3365 "__gcc_except_tab") ==
3366 symbol_sect_name) {
3367 type = eSymbolTypeException;
3368 } else {
3369 type = eSymbolTypeData;
3370 }
3371 } else if (symbol_sect_name &&
3372 ::strstr(symbol_sect_name, "__IMPORT") ==
3373 symbol_sect_name) {
3374 type = eSymbolTypeTrampoline;
3375 } else if (symbol_section->IsDescendant(
3376 objc_section_sp.get())) {
3377 type = eSymbolTypeRuntime;
3378 if (symbol_name && symbol_name[0] == '.') {
3379 llvm::StringRef symbol_name_ref(symbol_name);
3380 llvm::StringRef
3381 g_objc_v1_prefix_class(".objc_class_name_");
3382 if (symbol_name_ref.starts_with(
3383 g_objc_v1_prefix_class)) {
3384 symbol_name_non_abi_mangled = symbol_name;
3385 symbol_name = symbol_name +
3386 g_objc_v1_prefix_class.size();
3387 type = eSymbolTypeObjCClass;
3388 demangled_is_synthesized = true;
3389 }
3390 }
3391 }
3392 }
3393 }
3394 } break;
3395 }
3396 }
3397
3398 if (add_nlist) {
3399 uint64_t symbol_value = nlist.n_value;
3400 if (symbol_name_non_abi_mangled) {
3401 sym[sym_idx].GetMangled().SetMangledName(
3402 ConstString(symbol_name_non_abi_mangled));
3403 sym[sym_idx].GetMangled().SetDemangledName(
3404 ConstString(symbol_name));
3405 } else {
3406 if (symbol_name && symbol_name[0] == '_') {
3407 symbol_name++; // Skip the leading underscore
3408 }
3409
3410 if (symbol_name) {
3411 ConstString const_symbol_name(symbol_name);
3412 sym[sym_idx].GetMangled().SetValue(const_symbol_name);
3413 if (is_gsym && is_debug) {
3414 const char *gsym_name =
3415 sym[sym_idx]
3416 .GetMangled()
3418 .GetCString();
3419 if (gsym_name)
3420 N_GSYM_name_to_sym_idx[gsym_name] = sym_idx;
3421 }
3422 }
3423 }
3424 if (symbol_section) {
3425 const addr_t section_file_addr =
3426 symbol_section->GetFileAddress();
3427 symbol_value -= section_file_addr;
3428 }
3429
3430 if (is_debug == false) {
3431 if (type == eSymbolTypeCode) {
3432 // See if we can find a N_FUN entry for any code
3433 // symbols. If we do find a match, and the name
3434 // matches, then we can merge the two into just the
3435 // function symbol to avoid duplicate entries in
3436 // the symbol table
3437 auto range =
3438 N_FUN_addr_to_sym_idx.equal_range(nlist.n_value);
3439 if (range.first != range.second) {
3440 bool found_it = false;
3441 for (auto pos = range.first; pos != range.second;
3442 ++pos) {
3443 if (sym[sym_idx].GetMangled().GetName(
3445 sym[pos->second].GetMangled().GetName(
3447 m_nlist_idx_to_sym_idx[nlist_idx] = pos->second;
3448 // We just need the flags from the linker
3449 // symbol, so put these flags
3450 // into the N_FUN flags to avoid duplicate
3451 // symbols in the symbol table
3452 sym[pos->second].SetExternal(
3453 sym[sym_idx].IsExternal());
3454 sym[pos->second].SetFlags(nlist.n_type << 16 |
3455 nlist.n_desc);
3456 if (resolver_addresses.find(nlist.n_value) !=
3457 resolver_addresses.end())
3458 sym[pos->second].SetType(eSymbolTypeResolver);
3459 sym[sym_idx].Clear();
3460 found_it = true;
3461 break;
3462 }
3463 }
3464 if (found_it)
3465 continue;
3466 } else {
3467 if (resolver_addresses.find(nlist.n_value) !=
3468 resolver_addresses.end())
3469 type = eSymbolTypeResolver;
3470 }
3471 } else if (type == eSymbolTypeData ||
3472 type == eSymbolTypeObjCClass ||
3473 type == eSymbolTypeObjCMetaClass ||
3474 type == eSymbolTypeObjCIVar) {
3475 // See if we can find a N_STSYM entry for any data
3476 // symbols. If we do find a match, and the name
3477 // matches, then we can merge the two into just the
3478 // Static symbol to avoid duplicate entries in the
3479 // symbol table
3480 auto range = N_STSYM_addr_to_sym_idx.equal_range(
3481 nlist.n_value);
3482 if (range.first != range.second) {
3483 bool found_it = false;
3484 for (auto pos = range.first; pos != range.second;
3485 ++pos) {
3486 if (sym[sym_idx].GetMangled().GetName(
3488 sym[pos->second].GetMangled().GetName(
3490 m_nlist_idx_to_sym_idx[nlist_idx] = pos->second;
3491 // We just need the flags from the linker
3492 // symbol, so put these flags
3493 // into the N_STSYM flags to avoid duplicate
3494 // symbols in the symbol table
3495 sym[pos->second].SetExternal(
3496 sym[sym_idx].IsExternal());
3497 sym[pos->second].SetFlags(nlist.n_type << 16 |
3498 nlist.n_desc);
3499 sym[sym_idx].Clear();
3500 found_it = true;
3501 break;
3502 }
3503 }
3504 if (found_it)
3505 continue;
3506 } else {
3507 const char *gsym_name =
3508 sym[sym_idx]
3509 .GetMangled()
3511 .GetCString();
3512 if (gsym_name) {
3513 // Combine N_GSYM stab entries with the non
3514 // stab symbol
3515 ConstNameToSymbolIndexMap::const_iterator pos =
3516 N_GSYM_name_to_sym_idx.find(gsym_name);
3517 if (pos != N_GSYM_name_to_sym_idx.end()) {
3518 const uint32_t GSYM_sym_idx = pos->second;
3519 m_nlist_idx_to_sym_idx[nlist_idx] =
3520 GSYM_sym_idx;
3521 // Copy the address, because often the N_GSYM
3522 // address has an invalid address of zero
3523 // when the global is a common symbol
3524 sym[GSYM_sym_idx].GetAddressRef() =
3525 Address(symbol_section, symbol_value);
3526 add_symbol_addr(sym[GSYM_sym_idx]
3527 .GetAddress()
3528 .GetFileAddress());
3529 // We just need the flags from the linker
3530 // symbol, so put these flags
3531 // into the N_GSYM flags to avoid duplicate
3532 // symbols in the symbol table
3533 sym[GSYM_sym_idx].SetFlags(nlist.n_type << 16 |
3534 nlist.n_desc);
3535 sym[sym_idx].Clear();
3536 continue;
3537 }
3538 }
3539 }
3540 }
3541 }
3542
3543 sym[sym_idx].SetID(nlist_idx);
3544 sym[sym_idx].SetType(type);
3545 if (set_value) {
3546 sym[sym_idx].GetAddressRef() =
3547 Address(symbol_section, symbol_value);
3548 add_symbol_addr(
3549 sym[sym_idx].GetAddress().GetFileAddress());
3550 }
3551 sym[sym_idx].SetFlags(nlist.n_type << 16 | nlist.n_desc);
3552
3553 if (demangled_is_synthesized)
3554 sym[sym_idx].SetDemangledNameIsSynthesized(true);
3555 ++sym_idx;
3556 } else {
3557 sym[sym_idx].Clear();
3558 }
3559 }
3560 /////////////////////////////
3561 }
3562 }
3563
3564 for (const auto &pos : reexport_shlib_needs_fixup) {
3565 const auto undef_pos = undefined_name_to_desc.find(pos.second);
3566 if (undef_pos != undefined_name_to_desc.end()) {
3567 const uint8_t dylib_ordinal =
3568 llvm::MachO::GET_LIBRARY_ORDINAL(undef_pos->second);
3569 if (dylib_ordinal > 0 && dylib_ordinal < dylib_files.GetSize())
3570 sym[pos.first].SetReExportedSymbolSharedLibrary(
3571 dylib_files.GetFileSpecAtIndex(dylib_ordinal - 1));
3572 }
3573 }
3574 }
3575
3576#endif
3577 lldb::offset_t nlist_data_offset = 0;
3578
3579 if (nlist_data.GetByteSize() > 0) {
3580
3581 // If the sym array was not created while parsing the DSC unmapped
3582 // symbols, create it now.
3583 if (sym == nullptr) {
3584 sym =
3585 symtab.Resize(symtab_load_command.nsyms + m_dysymtab.nindirectsyms);
3586 num_syms = symtab.GetNumSymbols();
3587 }
3588
3589 if (unmapped_local_symbols_found) {
3590 assert(m_dysymtab.ilocalsym == 0);
3591 nlist_data_offset += (m_dysymtab.nlocalsym * nlist_byte_size);
3592 nlist_idx = m_dysymtab.nlocalsym;
3593 } else {
3594 nlist_idx = 0;
3595 }
3596
3597 typedef llvm::DenseMap<ConstString, uint16_t> UndefinedNameToDescMap;
3598 typedef llvm::DenseMap<uint32_t, ConstString> SymbolIndexToName;
3599 UndefinedNameToDescMap undefined_name_to_desc;
3600 SymbolIndexToName reexport_shlib_needs_fixup;
3601
3602 // Symtab parsing is a huge mess. Everything is entangled and the code
3603 // requires access to a ridiculous amount of variables. LLDB depends
3604 // heavily on the proper merging of symbols and to get that right we need
3605 // to make sure we have parsed all the debug symbols first. Therefore we
3606 // invoke the lambda twice, once to parse only the debug symbols and then
3607 // once more to parse the remaining symbols.
3608 auto ParseSymbolLambda = [&](struct nlist_64 &nlist, uint32_t nlist_idx,
3609 bool debug_only) {
3610 const bool is_debug = ((nlist.n_type & N_STAB) != 0);
3611 if (is_debug != debug_only)
3612 return true;
3613
3614 const char *symbol_name_non_abi_mangled = nullptr;
3615 const char *symbol_name = nullptr;
3616
3617 if (have_strtab_data) {
3618 symbol_name = strtab_data.PeekCStr(nlist.n_strx);
3619
3620 if (symbol_name == nullptr) {
3621 // No symbol should be NULL, even the symbols with no string values
3622 // should have an offset zero which points to an empty C-string
3623 Debugger::ReportError(llvm::formatv(
3624 "symbol[{0}] has invalid string table offset {1:x} in {2}, "
3625 "ignoring symbol",
3626 nlist_idx, nlist.n_strx, module_sp->GetFileSpec().GetPath()));
3627 return true;
3628 }
3629 if (symbol_name[0] == '\0')
3630 symbol_name = nullptr;
3631 } else {
3632 const addr_t str_addr = strtab_addr + nlist.n_strx;
3633 Status str_error;
3634 if (process->ReadCStringFromMemory(str_addr, memory_symbol_name,
3635 str_error))
3636 symbol_name = memory_symbol_name.c_str();
3637 }
3638
3640 SectionSP symbol_section;
3641 bool add_nlist = true;
3642 bool is_gsym = false;
3643 bool demangled_is_synthesized = false;
3644 bool set_value = true;
3645
3646 assert(sym_idx < num_syms);
3647 sym[sym_idx].SetDebug(is_debug);
3648
3649 if (is_debug) {
3650 switch (nlist.n_type) {
3651 case N_GSYM: {
3652 // global symbol: name,,NO_SECT,type,0
3653 // Sometimes the N_GSYM value contains the address.
3654
3655 // FIXME: In the .o files, we have a GSYM and a debug symbol for all
3656 // the ObjC data. They
3657 // have the same address, but we want to ensure that we always find
3658 // only the real symbol, 'cause we don't currently correctly
3659 // attribute the GSYM one to the ObjCClass/Ivar/MetaClass symbol
3660 // type. This is a temporary hack to make sure the ObjectiveC
3661 // symbols get treated correctly. To do this right, we should
3662 // coalesce all the GSYM & global symbols that have the same
3663 // address.
3664 is_gsym = true;
3665 sym[sym_idx].SetExternal(true);
3666
3667 if (TryParseV2ObjCMetadataSymbol(symbol_name,
3668 symbol_name_non_abi_mangled, type)) {
3669 demangled_is_synthesized = true;
3670 } else {
3671 if (nlist.n_value != 0)
3672 symbol_section =
3673 section_info.GetSection(nlist.n_sect, nlist.n_value);
3674
3675 type = eSymbolTypeData;
3676 }
3677 } break;
3678
3679 case N_FNAME:
3680 // procedure name (f77 kludge): name,,NO_SECT,0,0
3681 type = eSymbolTypeCompiler;
3682 break;
3683
3684 case N_FUN:
3685 // procedure: name,,n_sect,linenumber,address
3686 if (symbol_name) {
3687 type = eSymbolTypeCode;
3688 symbol_section =
3689 section_info.GetSection(nlist.n_sect, nlist.n_value);
3690
3691 N_FUN_addr_to_sym_idx.insert(
3692 std::make_pair(nlist.n_value, sym_idx));
3693 // We use the current number of symbols in the symbol table in
3694 // lieu of using nlist_idx in case we ever start trimming entries
3695 // out
3696 N_FUN_indexes.push_back(sym_idx);
3697 } else {
3698 type = eSymbolTypeCompiler;
3699
3700 if (!N_FUN_indexes.empty()) {
3701 // Copy the size of the function into the original STAB entry
3702 // so we don't have to hunt for it later
3703 symtab.SymbolAtIndex(N_FUN_indexes.back())
3704 ->SetByteSize(nlist.n_value);
3705 N_FUN_indexes.pop_back();
3706 // We don't really need the end function STAB as it contains
3707 // the size which we already placed with the original symbol,
3708 // so don't add it if we want a minimal symbol table
3709 add_nlist = false;
3710 }
3711 }
3712 break;
3713
3714 case N_STSYM:
3715 // static symbol: name,,n_sect,type,address
3716 N_STSYM_addr_to_sym_idx.insert(
3717 std::make_pair(nlist.n_value, sym_idx));
3718 symbol_section = section_info.GetSection(nlist.n_sect, nlist.n_value);
3719 if (symbol_name && symbol_name[0]) {
3720 type = ObjectFile::GetSymbolTypeFromName(symbol_name + 1,
3722 }
3723 break;
3724
3725 case N_LCSYM:
3726 // .lcomm symbol: name,,n_sect,type,address
3727 symbol_section = section_info.GetSection(nlist.n_sect, nlist.n_value);
3729 break;
3730
3731 case N_BNSYM:
3732 // We use the current number of symbols in the symbol table in lieu
3733 // of using nlist_idx in case we ever start trimming entries out
3734 // Skip these if we want minimal symbol tables
3735 add_nlist = false;
3736 break;
3737
3738 case N_ENSYM:
3739 // Set the size of the N_BNSYM to the terminating index of this
3740 // N_ENSYM so that we can always skip the entire symbol if we need
3741 // to navigate more quickly at the source level when parsing STABS
3742 // Skip these if we want minimal symbol tables
3743 add_nlist = false;
3744 break;
3745
3746 case N_OPT:
3747 // emitted with gcc2_compiled and in gcc source
3748 type = eSymbolTypeCompiler;
3749 break;
3750
3751 case N_RSYM:
3752 // register sym: name,,NO_SECT,type,register
3753 type = eSymbolTypeVariable;
3754 break;
3755
3756 case N_SLINE:
3757 // src line: 0,,n_sect,linenumber,address
3758 symbol_section = section_info.GetSection(nlist.n_sect, nlist.n_value);
3759 type = eSymbolTypeLineEntry;
3760 break;
3761
3762 case N_SSYM:
3763 // structure elt: name,,NO_SECT,type,struct_offset
3765 break;
3766
3767 case N_SO:
3768 // source file name
3769 type = eSymbolTypeSourceFile;
3770 if (symbol_name == nullptr) {
3771 add_nlist = false;
3772 if (N_SO_index != UINT32_MAX) {
3773 // Set the size of the N_SO to the terminating index of this
3774 // N_SO so that we can always skip the entire N_SO if we need
3775 // to navigate more quickly at the source level when parsing
3776 // STABS
3777 symbol_ptr = symtab.SymbolAtIndex(N_SO_index);
3778 symbol_ptr->SetByteSize(sym_idx);
3779 symbol_ptr->SetSizeIsSibling(true);
3780 }
3781 N_NSYM_indexes.clear();
3782 N_INCL_indexes.clear();
3783 N_BRAC_indexes.clear();
3784 N_COMM_indexes.clear();
3785 N_FUN_indexes.clear();
3786 N_SO_index = UINT32_MAX;
3787 } else {
3788 // We use the current number of symbols in the symbol table in
3789 // lieu of using nlist_idx in case we ever start trimming entries
3790 // out
3791 const bool N_SO_has_full_path = symbol_name[0] == '/';
3792 if (N_SO_has_full_path) {
3793 if ((N_SO_index == sym_idx - 1) && ((sym_idx - 1) < num_syms)) {
3794 // We have two consecutive N_SO entries where the first
3795 // contains a directory and the second contains a full path.
3796 sym[sym_idx - 1].GetMangled().SetValue(
3797 ConstString(symbol_name));
3798 m_nlist_idx_to_sym_idx[nlist_idx] = sym_idx - 1;
3799 add_nlist = false;
3800 } else {
3801 // This is the first entry in a N_SO that contains a
3802 // directory or a full path to the source file
3803 N_SO_index = sym_idx;
3804 }
3805 } else if ((N_SO_index == sym_idx - 1) &&
3806 ((sym_idx - 1) < num_syms)) {
3807 // This is usually the second N_SO entry that contains just the
3808 // filename, so here we combine it with the first one if we are
3809 // minimizing the symbol table
3810 llvm::StringRef so_path = sym[sym_idx - 1]
3811 .GetMangled()
3813 .GetStringRef();
3814 if (!so_path.empty()) {
3815 std::string full_so_path(so_path);
3816 const size_t double_slash_pos = full_so_path.find("//");
3817 if (double_slash_pos != std::string::npos) {
3818 // The linker has been generating bad N_SO entries with
3819 // doubled up paths in the format "%s%s" where the first
3820 // string in the DW_AT_comp_dir, and the second is the
3821 // directory for the source file so you end up with a path
3822 // that looks like "/tmp/src//tmp/src/"
3823 FileSpec so_dir(so_path);
3824 if (!FileSystem::Instance().Exists(so_dir)) {
3825 so_dir.SetFile(&full_so_path[double_slash_pos + 1],
3826 FileSpec::Style::native);
3827 if (FileSystem::Instance().Exists(so_dir)) {
3828 // Trim off the incorrect path
3829 full_so_path.erase(0, double_slash_pos + 1);
3830 }
3831 }
3832 }
3833 if (*full_so_path.rbegin() != '/')
3834 full_so_path += '/';
3835 full_so_path += symbol_name;
3836 sym[sym_idx - 1].GetMangled().SetValue(
3837 ConstString(full_so_path.c_str()));
3838 add_nlist = false;
3839 m_nlist_idx_to_sym_idx[nlist_idx] = sym_idx - 1;
3840 }
3841 } else {
3842 // This could be a relative path to a N_SO
3843 N_SO_index = sym_idx;
3844 }
3845 }
3846 break;
3847
3848 case N_OSO:
3849 // object file name: name,,0,0,st_mtime
3850 type = eSymbolTypeObjectFile;
3851 break;
3852
3853 case N_LSYM:
3854 // local sym: name,,NO_SECT,type,offset
3855 type = eSymbolTypeLocal;
3856 break;
3857
3858 // INCL scopes
3859 case N_BINCL:
3860 // include file beginning: name,,NO_SECT,0,sum We use the current
3861 // number of symbols in the symbol table in lieu of using nlist_idx
3862 // in case we ever start trimming entries out
3863 N_INCL_indexes.push_back(sym_idx);
3864 type = eSymbolTypeScopeBegin;
3865 break;
3866
3867 case N_EINCL:
3868 // include file end: name,,NO_SECT,0,0
3869 // Set the size of the N_BINCL to the terminating index of this
3870 // N_EINCL so that we can always skip the entire symbol if we need
3871 // to navigate more quickly at the source level when parsing STABS
3872 if (!N_INCL_indexes.empty()) {
3873 symbol_ptr = symtab.SymbolAtIndex(N_INCL_indexes.back());
3874 symbol_ptr->SetByteSize(sym_idx + 1);
3875 symbol_ptr->SetSizeIsSibling(true);
3876 N_INCL_indexes.pop_back();
3877 }
3878 type = eSymbolTypeScopeEnd;
3879 break;
3880
3881 case N_SOL:
3882 // #included file name: name,,n_sect,0,address
3883 type = eSymbolTypeHeaderFile;
3884
3885 // We currently don't use the header files on darwin
3886 add_nlist = false;
3887 break;
3888
3889 case N_PARAMS:
3890 // compiler parameters: name,,NO_SECT,0,0
3891 type = eSymbolTypeCompiler;
3892 break;
3893
3894 case N_VERSION:
3895 // compiler version: name,,NO_SECT,0,0
3896 type = eSymbolTypeCompiler;
3897 break;
3898
3899 case N_OLEVEL:
3900 // compiler -O level: name,,NO_SECT,0,0
3901 type = eSymbolTypeCompiler;
3902 break;
3903
3904 case N_PSYM:
3905 // parameter: name,,NO_SECT,type,offset
3906 type = eSymbolTypeVariable;
3907 break;
3908
3909 case N_ENTRY:
3910 // alternate entry: name,,n_sect,linenumber,address
3911 symbol_section = section_info.GetSection(nlist.n_sect, nlist.n_value);
3912 type = eSymbolTypeLineEntry;
3913 break;
3914
3915 // Left and Right Braces
3916 case N_LBRAC:
3917 // left bracket: 0,,NO_SECT,nesting level,address We use the
3918 // current number of symbols in the symbol table in lieu of using
3919 // nlist_idx in case we ever start trimming entries out
3920 symbol_section = section_info.GetSection(nlist.n_sect, nlist.n_value);
3921 N_BRAC_indexes.push_back(sym_idx);
3922 type = eSymbolTypeScopeBegin;
3923 break;
3924
3925 case N_RBRAC:
3926 // right bracket: 0,,NO_SECT,nesting level,address Set the size of
3927 // the N_LBRAC to the terminating index of this N_RBRAC so that we
3928 // can always skip the entire symbol if we need to navigate more
3929 // quickly at the source level when parsing STABS
3930 symbol_section = section_info.GetSection(nlist.n_sect, nlist.n_value);
3931 if (!N_BRAC_indexes.empty()) {
3932 symbol_ptr = symtab.SymbolAtIndex(N_BRAC_indexes.back());
3933 symbol_ptr->SetByteSize(sym_idx + 1);
3934 symbol_ptr->SetSizeIsSibling(true);
3935 N_BRAC_indexes.pop_back();
3936 }
3937 type = eSymbolTypeScopeEnd;
3938 break;
3939
3940 case N_EXCL:
3941 // deleted include file: name,,NO_SECT,0,sum
3942 type = eSymbolTypeHeaderFile;
3943 break;
3944
3945 // COMM scopes
3946 case N_BCOMM:
3947 // begin common: name,,NO_SECT,0,0
3948 // We use the current number of symbols in the symbol table in lieu
3949 // of using nlist_idx in case we ever start trimming entries out
3950 type = eSymbolTypeScopeBegin;
3951 N_COMM_indexes.push_back(sym_idx);
3952 break;
3953
3954 case N_ECOML:
3955 // end common (local name): 0,,n_sect,0,address
3956 symbol_section = section_info.GetSection(nlist.n_sect, nlist.n_value);
3957 [[fallthrough]];
3958
3959 case N_ECOMM:
3960 // end common: name,,n_sect,0,0
3961 // Set the size of the N_BCOMM to the terminating index of this
3962 // N_ECOMM/N_ECOML so that we can always skip the entire symbol if
3963 // we need to navigate more quickly at the source level when
3964 // parsing STABS
3965 if (!N_COMM_indexes.empty()) {
3966 symbol_ptr = symtab.SymbolAtIndex(N_COMM_indexes.back());
3967 symbol_ptr->SetByteSize(sym_idx + 1);
3968 symbol_ptr->SetSizeIsSibling(true);
3969 N_COMM_indexes.pop_back();
3970 }
3971 type = eSymbolTypeScopeEnd;
3972 break;
3973
3974 case N_LENG:
3975 // second stab entry with length information
3976 type = eSymbolTypeAdditional;
3977 break;
3978
3979 default:
3980 break;
3981 }
3982 } else {
3983 uint8_t n_type = N_TYPE & nlist.n_type;
3984 sym[sym_idx].SetExternal((N_EXT & nlist.n_type) != 0);
3985
3986 switch (n_type) {
3987 case N_INDR: {
3988 const char *reexport_name_cstr = strtab_data.PeekCStr(nlist.n_value);
3989 if (reexport_name_cstr && reexport_name_cstr[0] && symbol_name) {
3990 type = eSymbolTypeReExported;
3991 ConstString reexport_name(reexport_name_cstr +
3992 ((reexport_name_cstr[0] == '_') ? 1 : 0));
3993 sym[sym_idx].SetReExportedSymbolName(reexport_name);
3994 set_value = false;
3995 reexport_shlib_needs_fixup[sym_idx] = reexport_name;
3996 indirect_symbol_names.insert(
3997 ConstString(symbol_name + ((symbol_name[0] == '_') ? 1 : 0)));
3998 } else
3999 type = eSymbolTypeUndefined;
4000 } break;
4001
4002 case N_UNDF:
4003 if (symbol_name && symbol_name[0]) {
4004 ConstString undefined_name(symbol_name +
4005 ((symbol_name[0] == '_') ? 1 : 0));
4006 undefined_name_to_desc[undefined_name] = nlist.n_desc;
4007 }
4008 [[fallthrough]];
4009
4010 case N_PBUD:
4011 type = eSymbolTypeUndefined;
4012 break;
4013
4014 case N_ABS:
4015 type = eSymbolTypeAbsolute;
4016 break;
4017
4018 case N_SECT: {
4019 symbol_section = section_info.GetSection(nlist.n_sect, nlist.n_value);
4020
4021 if (!symbol_section) {
4022 // TODO: warn about this?
4023 add_nlist = false;
4024 break;
4025 }
4026
4027 if (TEXT_eh_frame_sectID == nlist.n_sect) {
4028 type = eSymbolTypeException;
4029 } else {
4030 uint32_t section_type = symbol_section->Get() & SECTION_TYPE;
4031
4032 switch (section_type) {
4033 case S_CSTRING_LITERALS:
4034 type = eSymbolTypeData;
4035 break; // section with only literal C strings
4036 case S_4BYTE_LITERALS:
4037 type = eSymbolTypeData;
4038 break; // section with only 4 byte literals
4039 case S_8BYTE_LITERALS:
4040 type = eSymbolTypeData;
4041 break; // section with only 8 byte literals
4042 case S_LITERAL_POINTERS:
4043 type = eSymbolTypeTrampoline;
4044 break; // section with only pointers to literals
4045 case S_NON_LAZY_SYMBOL_POINTERS:
4046 type = eSymbolTypeTrampoline;
4047 break; // section with only non-lazy symbol pointers
4048 case S_LAZY_SYMBOL_POINTERS:
4049 type = eSymbolTypeTrampoline;
4050 break; // section with only lazy symbol pointers
4051 case S_SYMBOL_STUBS:
4052 type = eSymbolTypeTrampoline;
4053 break; // section with only symbol stubs, byte size of stub in
4054 // the reserved2 field
4055 case S_MOD_INIT_FUNC_POINTERS:
4056 type = eSymbolTypeCode;
4057 break; // section with only function pointers for initialization
4058 case S_MOD_TERM_FUNC_POINTERS:
4059 type = eSymbolTypeCode;
4060 break; // section with only function pointers for termination
4061 case S_INTERPOSING:
4062 type = eSymbolTypeTrampoline;
4063 break; // section with only pairs of function pointers for
4064 // interposing
4065 case S_16BYTE_LITERALS:
4066 type = eSymbolTypeData;
4067 break; // section with only 16 byte literals
4068 case S_DTRACE_DOF:
4070 break;
4071 case S_LAZY_DYLIB_SYMBOL_POINTERS:
4072 type = eSymbolTypeTrampoline;
4073 break;
4074 default:
4075 switch (symbol_section->GetType()) {
4077 type = eSymbolTypeCode;
4078 break;
4079 case eSectionTypeData:
4080 case eSectionTypeDataCString: // Inlined C string data
4081 case eSectionTypeDataCStringPointers: // Pointers to C string
4082 // data
4083 case eSectionTypeDataSymbolAddress: // Address of a symbol in
4084 // the symbol table
4085 case eSectionTypeData4:
4086 case eSectionTypeData8:
4087 case eSectionTypeData16:
4088 type = eSymbolTypeData;
4089 break;
4090 default:
4091 break;
4092 }
4093 break;
4094 }
4095
4096 if (type == eSymbolTypeInvalid) {
4097 const char *symbol_sect_name =
4098 symbol_section->GetName().AsCString(nullptr);
4099 if (symbol_section->IsDescendant(text_section_sp.get())) {
4100 if (symbol_section->IsClear(S_ATTR_PURE_INSTRUCTIONS |
4101 S_ATTR_SELF_MODIFYING_CODE |
4102 S_ATTR_SOME_INSTRUCTIONS))
4103 type = eSymbolTypeData;
4104 else
4105 type = eSymbolTypeCode;
4106 } else if (symbol_section->IsDescendant(data_section_sp.get()) ||
4107 symbol_section->IsDescendant(
4108 data_dirty_section_sp.get()) ||
4109 symbol_section->IsDescendant(
4110 data_const_section_sp.get())) {
4111 if (symbol_sect_name &&
4112 ::strstr(symbol_sect_name, "__objc") == symbol_sect_name) {
4113 type = eSymbolTypeRuntime;
4114
4116 symbol_name, symbol_name_non_abi_mangled, type))
4117 demangled_is_synthesized = true;
4118 } else if (symbol_sect_name &&
4119 ::strstr(symbol_sect_name, "__gcc_except_tab") ==
4120 symbol_sect_name) {
4121 type = eSymbolTypeException;
4122 } else {
4123 type = eSymbolTypeData;
4124 }
4125 } else if (symbol_sect_name &&
4126 ::strstr(symbol_sect_name, "__IMPORT") ==
4127 symbol_sect_name) {
4128 type = eSymbolTypeTrampoline;
4129 } else if (symbol_section->IsDescendant(objc_section_sp.get())) {
4130 type = eSymbolTypeRuntime;
4131 if (symbol_name && symbol_name[0] == '.') {
4132 llvm::StringRef symbol_name_ref(symbol_name);
4133 llvm::StringRef g_objc_v1_prefix_class(
4134 ".objc_class_name_");
4135 if (symbol_name_ref.starts_with(g_objc_v1_prefix_class)) {
4136 symbol_name_non_abi_mangled = symbol_name;
4137 symbol_name = symbol_name + g_objc_v1_prefix_class.size();
4138 type = eSymbolTypeObjCClass;
4139 demangled_is_synthesized = true;
4140 }
4141 }
4142 }
4143 }
4144 }
4145 } break;
4146 }
4147 }
4148
4149 if (!add_nlist) {
4150 sym[sym_idx].Clear();
4151 return true;
4152 }
4153
4154 uint64_t symbol_value = nlist.n_value;
4155
4156 if (symbol_name_non_abi_mangled) {
4157 sym[sym_idx].GetMangled().SetMangledName(
4158 ConstString(symbol_name_non_abi_mangled));
4159 sym[sym_idx].GetMangled().SetDemangledName(ConstString(symbol_name));
4160 } else {
4161
4162 if (symbol_name && symbol_name[0] == '_') {
4163 symbol_name++; // Skip the leading underscore
4164 }
4165
4166 if (symbol_name) {
4167 ConstString const_symbol_name(symbol_name);
4168 sym[sym_idx].GetMangled().SetValue(const_symbol_name);
4169 }
4170 }
4171
4172 if (is_gsym) {
4173 const char *gsym_name = sym[sym_idx]
4174 .GetMangled()
4176 .GetCString();
4177 if (gsym_name)
4178 N_GSYM_name_to_sym_idx[gsym_name] = sym_idx;
4179 }
4180
4181 if (symbol_section) {
4182 const addr_t section_file_addr = symbol_section->GetFileAddress();
4183 symbol_value -= section_file_addr;
4184 }
4185
4186 if (!is_debug) {
4187 if (type == eSymbolTypeCode) {
4188 // See if we can find a N_FUN entry for any code symbols. If we do
4189 // find a match, and the name matches, then we can merge the two into
4190 // just the function symbol to avoid duplicate entries in the symbol
4191 // table.
4192 std::pair<ValueToSymbolIndexMap::const_iterator,
4193 ValueToSymbolIndexMap::const_iterator>
4194 range;
4195 range = N_FUN_addr_to_sym_idx.equal_range(nlist.n_value);
4196 if (range.first != range.second) {
4197 for (ValueToSymbolIndexMap::const_iterator pos = range.first;
4198 pos != range.second; ++pos) {
4199 if (sym[sym_idx].GetMangled().GetName(Mangled::ePreferMangled) ==
4200 sym[pos->second].GetMangled().GetName(
4202 m_nlist_idx_to_sym_idx[nlist_idx] = pos->second;
4203 // We just need the flags from the linker symbol, so put these
4204 // flags into the N_FUN flags to avoid duplicate symbols in the
4205 // symbol table.
4206 sym[pos->second].SetExternal(sym[sym_idx].IsExternal());
4207 sym[pos->second].SetFlags(nlist.n_type << 16 | nlist.n_desc);
4208 if (resolver_addresses.find(nlist.n_value) !=
4209 resolver_addresses.end())
4210 sym[pos->second].SetType(eSymbolTypeResolver);
4211 sym[sym_idx].Clear();
4212 return true;
4213 }
4214 }
4215 } else {
4216 if (resolver_addresses.find(nlist.n_value) !=
4217 resolver_addresses.end())
4218 type = eSymbolTypeResolver;
4219 }
4220 } else if (type == eSymbolTypeData || type == eSymbolTypeObjCClass ||
4221 type == eSymbolTypeObjCMetaClass ||
4222 type == eSymbolTypeObjCIVar) {
4223 // See if we can find a N_STSYM entry for any data symbols. If we do
4224 // find a match, and the name matches, then we can merge the two into
4225 // just the Static symbol to avoid duplicate entries in the symbol
4226 // table.
4227 std::pair<ValueToSymbolIndexMap::const_iterator,
4228 ValueToSymbolIndexMap::const_iterator>
4229 range;
4230 range = N_STSYM_addr_to_sym_idx.equal_range(nlist.n_value);
4231 if (range.first != range.second) {
4232 for (ValueToSymbolIndexMap::const_iterator pos = range.first;
4233 pos != range.second; ++pos) {
4234 if (sym[sym_idx].GetMangled().GetName(Mangled::ePreferMangled) ==
4235 sym[pos->second].GetMangled().GetName(
4237 m_nlist_idx_to_sym_idx[nlist_idx] = pos->second;
4238 // We just need the flags from the linker symbol, so put these
4239 // flags into the N_STSYM flags to avoid duplicate symbols in
4240 // the symbol table.
4241 sym[pos->second].SetExternal(sym[sym_idx].IsExternal());
4242 sym[pos->second].SetFlags(nlist.n_type << 16 | nlist.n_desc);
4243 sym[sym_idx].Clear();
4244 return true;
4245 }
4246 }
4247 } else {
4248 // Combine N_GSYM stab entries with the non stab symbol.
4249 const char *gsym_name = sym[sym_idx]
4250 .GetMangled()
4252 .GetCString();
4253 if (gsym_name) {
4254 ConstNameToSymbolIndexMap::const_iterator pos =
4255 N_GSYM_name_to_sym_idx.find(gsym_name);
4256 if (pos != N_GSYM_name_to_sym_idx.end()) {
4257 const uint32_t GSYM_sym_idx = pos->second;
4258 m_nlist_idx_to_sym_idx[nlist_idx] = GSYM_sym_idx;
4259 // Copy the address, because often the N_GSYM address has an
4260 // invalid address of zero when the global is a common symbol.
4261 sym[GSYM_sym_idx].GetAddressRef() =
4262 Address(symbol_section, symbol_value);
4263 add_symbol_addr(
4264 sym[GSYM_sym_idx].GetAddress().GetFileAddress());
4265 // We just need the flags from the linker symbol, so put these
4266 // flags into the N_GSYM flags to avoid duplicate symbols in
4267 // the symbol table.
4268 sym[GSYM_sym_idx].SetFlags(nlist.n_type << 16 | nlist.n_desc);
4269 sym[sym_idx].Clear();
4270 return true;
4271 }
4272 }
4273 }
4274 }
4275 }
4276
4277 sym[sym_idx].SetID(nlist_idx);
4278 sym[sym_idx].SetType(type);
4279 if (set_value) {
4280 sym[sym_idx].GetAddressRef() = Address(symbol_section, symbol_value);
4281 if (symbol_section)
4282 add_symbol_addr(sym[sym_idx].GetAddress().GetFileAddress());
4283 }
4284 sym[sym_idx].SetFlags(nlist.n_type << 16 | nlist.n_desc);
4285 if (nlist.n_desc & N_WEAK_REF)
4286 sym[sym_idx].SetIsWeak(true);
4287
4288 if (demangled_is_synthesized)
4289 sym[sym_idx].SetDemangledNameIsSynthesized(true);
4290
4291 ++sym_idx;
4292 return true;
4293 };
4294
4295 // First parse all the nlists but don't process them yet. See the next
4296 // comment for an explanation why.
4297 std::vector<struct nlist_64> nlists;
4298 nlists.reserve(symtab_load_command.nsyms);
4299 for (; nlist_idx < symtab_load_command.nsyms; ++nlist_idx) {
4300 if (auto nlist =
4301 ParseNList(nlist_data, nlist_data_offset, nlist_byte_size))
4302 nlists.push_back(*nlist);
4303 else
4304 break;
4305 }
4306
4307 // Now parse all the debug symbols. This is needed to merge non-debug
4308 // symbols in the next step. Non-debug symbols are always coalesced into
4309 // the debug symbol. Doing this in one step would mean that some symbols
4310 // won't be merged.
4311 nlist_idx = 0;
4312 for (auto &nlist : nlists) {
4313 if (!ParseSymbolLambda(nlist, nlist_idx++, DebugSymbols))
4314 break;
4315 }
4316
4317 // Finally parse all the non debug symbols.
4318 nlist_idx = 0;
4319 for (auto &nlist : nlists) {
4320 if (!ParseSymbolLambda(nlist, nlist_idx++, NonDebugSymbols))
4321 break;
4322 }
4323
4324 for (const auto &pos : reexport_shlib_needs_fixup) {
4325 const auto undef_pos = undefined_name_to_desc.find(pos.second);
4326 if (undef_pos != undefined_name_to_desc.end()) {
4327 const uint8_t dylib_ordinal =
4328 llvm::MachO::GET_LIBRARY_ORDINAL(undef_pos->second);
4329 if (dylib_ordinal > 0 && dylib_ordinal < dylib_files.GetSize())
4330 sym[pos.first].SetReExportedSymbolSharedLibrary(
4331 dylib_files.GetFileSpecAtIndex(dylib_ordinal - 1));
4332 }
4333 }
4334 }
4335
4336 // Count how many trie symbols we'll add to the symbol table
4337 int trie_symbol_table_augment_count = 0;
4338 for (auto &e : external_sym_trie_entries) {
4339 if (!symbols_added.contains(e.entry.address))
4340 trie_symbol_table_augment_count++;
4341 }
4342
4343 if (num_syms < sym_idx + trie_symbol_table_augment_count) {
4344 num_syms = sym_idx + trie_symbol_table_augment_count;
4345 sym = symtab.Resize(num_syms);
4346 }
4347 uint32_t synthetic_sym_id = symtab_load_command.nsyms;
4348
4349 // Add symbols from the trie to the symbol table.
4350 for (auto &e : external_sym_trie_entries) {
4351 if (symbols_added.contains(e.entry.address))
4352 continue;
4353
4354 // Find the section that this trie address is in, use that to annotate
4355 // symbol type as we add the trie address and name to the symbol table.
4356 Address symbol_addr;
4357 if (module_sp->ResolveFileAddress(e.entry.address, symbol_addr)) {
4358 SectionSP symbol_section(symbol_addr.GetSection());
4359 const char *symbol_name = e.entry.name.GetCString();
4360 bool demangled_is_synthesized = false;
4361 SymbolType type =
4362 GetSymbolType(symbol_name, demangled_is_synthesized, text_section_sp,
4363 data_section_sp, data_dirty_section_sp,
4364 data_const_section_sp, symbol_section);
4365
4366 sym[sym_idx].SetType(type);
4367 if (symbol_section) {
4368 sym[sym_idx].SetID(synthetic_sym_id++);
4369 sym[sym_idx].GetMangled().SetMangledName(ConstString(symbol_name));
4370 if (demangled_is_synthesized)
4371 sym[sym_idx].SetDemangledNameIsSynthesized(true);
4372 sym[sym_idx].SetIsSynthetic(true);
4373 sym[sym_idx].SetExternal(true);
4374 sym[sym_idx].GetAddressRef() = symbol_addr;
4375 add_symbol_addr(symbol_addr.GetFileAddress());
4376 if (e.entry.flags & TRIE_SYMBOL_IS_THUMB)
4378 ++sym_idx;
4379 }
4380 }
4381 }
4382
4383 if (function_starts_count > 0) {
4384 uint32_t num_synthetic_function_symbols = 0;
4385 for (i = 0; i < function_starts_count; ++i) {
4386 if (!symbols_added.contains(function_starts.GetEntryRef(i).addr))
4387 ++num_synthetic_function_symbols;
4388 }
4389
4390 if (num_synthetic_function_symbols > 0) {
4391 if (num_syms < sym_idx + num_synthetic_function_symbols) {
4392 num_syms = sym_idx + num_synthetic_function_symbols;
4393 sym = symtab.Resize(num_syms);
4394 }
4395 for (i = 0; i < function_starts_count; ++i) {
4396 const FunctionStarts::Entry *func_start_entry =
4397 function_starts.GetEntryAtIndex(i);
4398 if (!symbols_added.contains(func_start_entry->addr)) {
4399 addr_t symbol_file_addr = func_start_entry->addr;
4400 uint32_t symbol_flags = 0;
4401 if (func_start_entry->data)
4402 symbol_flags = MACHO_NLIST_ARM_SYMBOL_IS_THUMB;
4403 Address symbol_addr;
4404 if (module_sp->ResolveFileAddress(symbol_file_addr, symbol_addr)) {
4405 SectionSP symbol_section(symbol_addr.GetSection());
4406 if (symbol_section) {
4407 sym[sym_idx].SetID(synthetic_sym_id++);
4408 // Don't set the name for any synthetic symbols, the Symbol
4409 // object will generate one if needed when the name is accessed
4410 // via accessors.
4411 sym[sym_idx].GetMangled().SetDemangledName(ConstString());
4412 sym[sym_idx].SetType(eSymbolTypeCode);
4413 sym[sym_idx].SetIsSynthetic(true);
4414 sym[sym_idx].GetAddressRef() = symbol_addr;
4415 add_symbol_addr(symbol_addr.GetFileAddress());
4416 if (symbol_flags)
4417 sym[sym_idx].SetFlags(symbol_flags);
4418 ++sym_idx;
4419 }
4420 }
4421 }
4422 }
4423 }
4424 }
4425
4426 // Trim our symbols down to just what we ended up with after removing any
4427 // symbols.
4428 if (sym_idx < num_syms) {
4429 num_syms = sym_idx;
4430 sym = symtab.Resize(num_syms);
4431 }
4432
4433 // Now synthesize indirect symbols
4434 if (m_dysymtab.nindirectsyms != 0) {
4435 if (indirect_symbol_index_data.GetByteSize()) {
4436 NListIndexToSymbolIndexMap::const_iterator end_index_pos =
4437 m_nlist_idx_to_sym_idx.end();
4438
4439 for (uint32_t sect_idx = 1; sect_idx < m_mach_sections.size();
4440 ++sect_idx) {
4441 if ((m_mach_sections[sect_idx].flags & SECTION_TYPE) ==
4442 S_SYMBOL_STUBS) {
4443 uint32_t symbol_stub_byte_size = m_mach_sections[sect_idx].reserved2;
4444 if (symbol_stub_byte_size == 0)
4445 continue;
4446
4447 const uint32_t num_symbol_stubs =
4448 m_mach_sections[sect_idx].size / symbol_stub_byte_size;
4449
4450 if (num_symbol_stubs == 0)
4451 continue;
4452
4453 const uint32_t symbol_stub_index_offset =
4454 m_mach_sections[sect_idx].reserved1;
4455 for (uint32_t stub_idx = 0; stub_idx < num_symbol_stubs; ++stub_idx) {
4456 const uint32_t symbol_stub_index =
4457 symbol_stub_index_offset + stub_idx;
4458 const lldb::addr_t symbol_stub_addr =
4459 m_mach_sections[sect_idx].addr +
4460 (stub_idx * symbol_stub_byte_size);
4461 lldb::offset_t symbol_stub_offset = symbol_stub_index * 4;
4462 if (indirect_symbol_index_data.ValidOffsetForDataOfSize(
4463 symbol_stub_offset, 4)) {
4464 const uint32_t stub_sym_id =
4465 indirect_symbol_index_data.GetU32(&symbol_stub_offset);
4466 if (stub_sym_id & (INDIRECT_SYMBOL_ABS | INDIRECT_SYMBOL_LOCAL))
4467 continue;
4468
4469 NListIndexToSymbolIndexMap::const_iterator index_pos =
4470 m_nlist_idx_to_sym_idx.find(stub_sym_id);
4471 Symbol *stub_symbol = nullptr;
4472 if (index_pos != end_index_pos) {
4473 // We have a remapping from the original nlist index to a
4474 // current symbol index, so just look this up by index
4475 stub_symbol = symtab.SymbolAtIndex(index_pos->second);
4476 } else {
4477 // We need to lookup a symbol using the original nlist symbol
4478 // index since this index is coming from the S_SYMBOL_STUBS
4479 stub_symbol = symtab.FindSymbolByID(stub_sym_id);
4480 }
4481
4482 if (stub_symbol) {
4483 Address so_addr(symbol_stub_addr, section_list);
4484
4485 if (stub_symbol->GetType() == eSymbolTypeUndefined) {
4486 // Change the external symbol into a trampoline that makes
4487 // sense These symbols were N_UNDF N_EXT, and are useless
4488 // to us, so we can re-use them so we don't have to make up
4489 // a synthetic symbol for no good reason.
4490 if (resolver_addresses.find(symbol_stub_addr) ==
4491 resolver_addresses.end())
4492 stub_symbol->SetType(eSymbolTypeTrampoline);
4493 else
4494 stub_symbol->SetType(eSymbolTypeResolver);
4495 stub_symbol->SetExternal(false);
4496 stub_symbol->GetAddressRef() = so_addr;
4497 stub_symbol->SetByteSize(symbol_stub_byte_size);
4498 } else {
4499 // Make a synthetic symbol to describe the trampoline stub
4500 Mangled stub_symbol_mangled_name(stub_symbol->GetMangled());
4501 if (sym_idx >= num_syms) {
4502 sym = symtab.Resize(++num_syms);
4503 stub_symbol = nullptr; // this pointer no longer valid
4504 }
4505 sym[sym_idx].SetID(synthetic_sym_id++);
4506 sym[sym_idx].GetMangled() = stub_symbol_mangled_name;
4507 if (resolver_addresses.find(symbol_stub_addr) ==
4508 resolver_addresses.end())
4509 sym[sym_idx].SetType(eSymbolTypeTrampoline);
4510 else
4511 sym[sym_idx].SetType(eSymbolTypeResolver);
4512 sym[sym_idx].SetIsSynthetic(true);
4513 sym[sym_idx].GetAddressRef() = so_addr;
4514 add_symbol_addr(so_addr.GetFileAddress());
4515 sym[sym_idx].SetByteSize(symbol_stub_byte_size);
4516 ++sym_idx;
4517 }
4518 } else {
4519 LLDB_LOGF(log,
4520 "warning: symbol stub referencing symbol table "
4521 "symbol %u that isn't in our minimal symbol table, "
4522 "fix this!!!",
4523 stub_sym_id);
4524 }
4525 }
4526 }
4527 }
4528 }
4529 }
4530 }
4531
4532 if (!reexport_trie_entries.empty()) {
4533 for (const auto &e : reexport_trie_entries) {
4534 if (e.entry.import_name) {
4535 // Only add indirect symbols from the Trie entries if we didn't have
4536 // a N_INDR nlist entry for this already
4537 if (indirect_symbol_names.find(e.entry.name) ==
4538 indirect_symbol_names.end()) {
4539 // Make a synthetic symbol to describe re-exported symbol.
4540 if (sym_idx >= num_syms)
4541 sym = symtab.Resize(++num_syms);
4542 sym[sym_idx].SetID(synthetic_sym_id++);
4543 sym[sym_idx].GetMangled() = Mangled(e.entry.name);
4544 sym[sym_idx].SetType(eSymbolTypeReExported);
4545 sym[sym_idx].SetIsSynthetic(true);
4546 sym[sym_idx].SetReExportedSymbolName(e.entry.import_name);
4547 if (e.entry.other > 0 && e.entry.other <= dylib_files.GetSize()) {
4549 dylib_files.GetFileSpecAtIndex(e.entry.other - 1));
4550 }
4551 ++sym_idx;
4552 }
4553 }
4554 }
4555 }
4556}
4557
4559 ModuleSP module_sp(GetModule());
4560 if (module_sp) {
4561 std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
4562 s->Printf("%p: ", static_cast<void *>(this));
4563 s->Indent();
4564 if (m_header.magic == MH_MAGIC_64 || m_header.magic == MH_CIGAM_64)
4565 s->PutCString("ObjectFileMachO64");
4566 else
4567 s->PutCString("ObjectFileMachO32");
4568
4569 *s << ", file = '" << m_file;
4570 ModuleSpecList all_specs;
4571 ModuleSpec base_spec;
4573 MachHeaderSizeFromMagic(m_header.magic), base_spec,
4574 all_specs);
4575 for (unsigned i = 0, e = all_specs.GetSize(); i != e; ++i) {
4576 *s << "', triple";
4577 if (e)
4578 s->Printf("[%d]", i);
4579 *s << " = ";
4580 *s << all_specs.GetModuleSpecRefAtIndex(i)
4582 .GetTriple()
4583 .getTriple();
4584 }
4585 *s << "\n";
4586 SectionList *sections = GetSectionList();
4587 if (sections)
4588 sections->Dump(s->AsRawOstream(), s->GetIndentLevel(), nullptr, true,
4589 UINT32_MAX);
4590
4591 if (m_symtab_up)
4592 m_symtab_up->Dump(s, nullptr, eSortOrderNone);
4593 }
4594}
4595
4596UUID ObjectFileMachO::GetUUID(const llvm::MachO::mach_header &header,
4597 const lldb_private::DataExtractor &data,
4598 lldb::offset_t lc_offset) {
4599 uint32_t i;
4600 llvm::MachO::uuid_command load_cmd;
4601
4602 lldb::offset_t offset = lc_offset;
4603 for (i = 0; i < header.ncmds; ++i) {
4604 const lldb::offset_t cmd_offset = offset;
4605 if (data.GetU32(&offset, &load_cmd, 2) == nullptr)
4606 break;
4607
4608 if (load_cmd.cmd == LC_UUID) {
4609 const uint8_t *uuid_bytes = data.PeekData(offset, 16);
4610
4611 if (uuid_bytes) {
4612 // OpenCL on Mac OS X uses the same UUID for each of its object files.
4613 // We pretend these object files have no UUID to prevent crashing.
4614
4615 const uint8_t opencl_uuid[] = {0x8c, 0x8e, 0xb3, 0x9b, 0x3b, 0xa8,
4616 0x4b, 0x16, 0xb6, 0xa4, 0x27, 0x63,
4617 0xbb, 0x14, 0xf0, 0x0d};
4618
4619 if (!memcmp(uuid_bytes, opencl_uuid, 16))
4620 return UUID();
4621
4622 return UUID(uuid_bytes, 16);
4623 }
4624 return UUID();
4625 }
4626 offset = cmd_offset + load_cmd.cmdsize;
4627 }
4628 return UUID();
4629}
4630
4631static llvm::StringRef GetOSName(uint32_t cmd) {
4632 switch (cmd) {
4633 case llvm::MachO::LC_VERSION_MIN_IPHONEOS:
4634 return llvm::Triple::getOSTypeName(llvm::Triple::IOS);
4635 case llvm::MachO::LC_VERSION_MIN_MACOSX:
4636 return llvm::Triple::getOSTypeName(llvm::Triple::MacOSX);
4637 case llvm::MachO::LC_VERSION_MIN_TVOS:
4638 return llvm::Triple::getOSTypeName(llvm::Triple::TvOS);
4639 case llvm::MachO::LC_VERSION_MIN_WATCHOS:
4640 return llvm::Triple::getOSTypeName(llvm::Triple::WatchOS);
4641 default:
4642 llvm_unreachable("unexpected LC_VERSION load command");
4643 }
4644}
4645
4646namespace {
4647struct OSEnv {
4648 llvm::StringRef os_type;
4649 llvm::StringRef environment;
4650 OSEnv(uint32_t cmd) {
4651 switch (cmd) {
4652 case llvm::MachO::PLATFORM_MACOS:
4653 os_type = llvm::Triple::getOSTypeName(llvm::Triple::MacOSX);
4654 return;
4655 case llvm::MachO::PLATFORM_IOS:
4656 os_type = llvm::Triple::getOSTypeName(llvm::Triple::IOS);
4657 return;
4658 case llvm::MachO::PLATFORM_TVOS:
4659 os_type = llvm::Triple::getOSTypeName(llvm::Triple::TvOS);
4660 return;
4661 case llvm::MachO::PLATFORM_WATCHOS:
4662 os_type = llvm::Triple::getOSTypeName(llvm::Triple::WatchOS);
4663 return;
4664 case llvm::MachO::PLATFORM_BRIDGEOS:
4665 os_type = llvm::Triple::getOSTypeName(llvm::Triple::BridgeOS);
4666 return;
4667 case llvm::MachO::PLATFORM_DRIVERKIT:
4668 os_type = llvm::Triple::getOSTypeName(llvm::Triple::DriverKit);
4669 return;
4670 case llvm::MachO::PLATFORM_MACCATALYST:
4671 os_type = llvm::Triple::getOSTypeName(llvm::Triple::IOS);
4672 environment = llvm::Triple::getEnvironmentTypeName(llvm::Triple::MacABI);
4673 return;
4674 case llvm::MachO::PLATFORM_IOSSIMULATOR:
4675 os_type = llvm::Triple::getOSTypeName(llvm::Triple::IOS);
4676 environment =
4677 llvm::Triple::getEnvironmentTypeName(llvm::Triple::Simulator);
4678 return;
4679 case llvm::MachO::PLATFORM_TVOSSIMULATOR:
4680 os_type = llvm::Triple::getOSTypeName(llvm::Triple::TvOS);
4681 environment =
4682 llvm::Triple::getEnvironmentTypeName(llvm::Triple::Simulator);
4683 return;
4684 case llvm::MachO::PLATFORM_WATCHOSSIMULATOR:
4685 os_type = llvm::Triple::getOSTypeName(llvm::Triple::WatchOS);
4686 environment =
4687 llvm::Triple::getEnvironmentTypeName(llvm::Triple::Simulator);
4688 return;
4689 case llvm::MachO::PLATFORM_XROS:
4690 os_type = llvm::Triple::getOSTypeName(llvm::Triple::XROS);
4691 return;
4692 case llvm::MachO::PLATFORM_XROS_SIMULATOR:
4693 os_type = llvm::Triple::getOSTypeName(llvm::Triple::XROS);
4694 environment =
4695 llvm::Triple::getEnvironmentTypeName(llvm::Triple::Simulator);
4696 return;
4697 default: {
4698 Log *log(GetLog(LLDBLog::Symbols | LLDBLog::Process));
4699 LLDB_LOGF(log, "unsupported platform in LC_BUILD_VERSION");
4700 }
4701 }
4702 }
4703};
4704
4705struct MinOS {
4706 uint32_t major_version, minor_version, patch_version;
4707 MinOS(uint32_t version)
4708 : major_version(version >> 16), minor_version((version >> 8) & 0xffu),
4709 patch_version(version & 0xffu) {}
4710};
4711} // namespace
4712
4713void ObjectFileMachO::GetAllArchSpecs(const llvm::MachO::mach_header &header,
4714 const lldb_private::DataExtractor &data,
4715 lldb::offset_t lc_offset,
4716 ModuleSpec &base_spec,
4717 lldb_private::ModuleSpecList &all_specs) {
4718 auto &base_arch = base_spec.GetArchitecture();
4719 base_arch.SetArchitecture(eArchTypeMachO, header.cputype, header.cpusubtype);
4720 if (!base_arch.IsValid())
4721 return;
4722
4723 bool found_any = false;
4724 auto add_triple = [&](const llvm::Triple &triple) {
4725 auto spec = base_spec;
4726 spec.GetArchitecture().GetTriple() = triple;
4727 if (spec.GetArchitecture().IsValid()) {
4728 spec.GetUUID() = ObjectFileMachO::GetUUID(header, data, lc_offset);
4729 all_specs.Append(spec);
4730 found_any = true;
4731 }
4732 };
4733
4734 // Set OS to an unspecified unknown or a "*" so it can match any OS
4735 llvm::Triple base_triple = base_arch.GetTriple();
4736 base_triple.setOS(llvm::Triple::UnknownOS);
4737 base_triple.setOSName(llvm::StringRef());
4738
4739 if (header.filetype == MH_PRELOAD) {
4740 if (header.cputype == CPU_TYPE_ARM) {
4741 // If this is a 32-bit arm binary, and it's a standalone binary, force
4742 // the Vendor to Apple so we don't accidentally pick up the generic
4743 // armv7 ABI at runtime. Apple's armv7 ABI always uses r7 for the
4744 // frame pointer register; most other armv7 ABIs use a combination of
4745 // r7 and r11.
4746 base_triple.setVendor(llvm::Triple::Apple);
4747 } else {
4748 // Set vendor to an unspecified unknown or a "*" so it can match any
4749 // vendor This is required for correct behavior of EFI debugging on
4750 // x86_64
4751 base_triple.setVendor(llvm::Triple::UnknownVendor);
4752 base_triple.setVendorName(llvm::StringRef());
4753 }
4754 return add_triple(base_triple);
4755 }
4756
4757 llvm::MachO::load_command load_cmd;
4758
4759 // See if there is an LC_VERSION_MIN_* load command that can give
4760 // us the OS type.
4761 lldb::offset_t offset = lc_offset;
4762 for (uint32_t i = 0; i < header.ncmds; ++i) {
4763 const lldb::offset_t cmd_offset = offset;
4764 if (data.GetU32(&offset, &load_cmd, 2) == nullptr)
4765 break;
4766
4767 llvm::MachO::version_min_command version_min;
4768 switch (load_cmd.cmd) {
4769 case llvm::MachO::LC_VERSION_MIN_MACOSX:
4770 case llvm::MachO::LC_VERSION_MIN_IPHONEOS:
4771 case llvm::MachO::LC_VERSION_MIN_TVOS:
4772 case llvm::MachO::LC_VERSION_MIN_WATCHOS: {
4773 if (load_cmd.cmdsize != sizeof(version_min))
4774 break;
4775 if (data.ExtractBytes(cmd_offset, sizeof(version_min),
4776 data.GetByteOrder(), &version_min) == 0)
4777 break;
4778 MinOS min_os(version_min.version);
4779 llvm::SmallString<32> os_name;
4780 llvm::raw_svector_ostream os(os_name);
4781 os << GetOSName(load_cmd.cmd) << min_os.major_version << '.'
4782 << min_os.minor_version << '.' << min_os.patch_version;
4783
4784 auto triple = base_triple;
4785 triple.setOSName(os.str());
4786
4787 // Disambiguate legacy simulator platforms.
4788 if (load_cmd.cmd != llvm::MachO::LC_VERSION_MIN_MACOSX &&
4789 (base_triple.getArch() == llvm::Triple::x86_64 ||
4790 base_triple.getArch() == llvm::Triple::x86)) {
4791 // The combination of legacy LC_VERSION_MIN load command and
4792 // x86 architecture always indicates a simulator environment.
4793 // The combination of LC_VERSION_MIN and arm architecture only
4794 // appears for native binaries. Back-deploying simulator
4795 // binaries on Apple Silicon Macs use the modern unambigous
4796 // LC_BUILD_VERSION load commands; no special handling required.
4797 triple.setEnvironment(llvm::Triple::Simulator);
4798 }
4799 add_triple(triple);
4800 break;
4801 }
4802 default:
4803 break;
4804 }
4805
4806 offset = cmd_offset + load_cmd.cmdsize;
4807 }
4808
4809 // See if there are LC_BUILD_VERSION load commands that can give
4810 // us the OS type.
4811 offset = lc_offset;
4812 for (uint32_t i = 0; i < header.ncmds; ++i) {
4813 const lldb::offset_t cmd_offset = offset;
4814 if (data.GetU32(&offset, &load_cmd, 2) == nullptr)
4815 break;
4816
4817 do {
4818 if (load_cmd.cmd == llvm::MachO::LC_BUILD_VERSION) {
4819 llvm::MachO::build_version_command build_version;
4820 if (load_cmd.cmdsize < sizeof(build_version)) {
4821 // Malformed load command.
4822 break;
4823 }
4824 if (data.ExtractBytes(cmd_offset, sizeof(build_version),
4825 data.GetByteOrder(), &build_version) == 0)
4826 break;
4827 MinOS min_os(build_version.minos);
4828 OSEnv os_env(build_version.platform);
4829 llvm::SmallString<16> os_name;
4830 llvm::raw_svector_ostream os(os_name);
4831 os << os_env.os_type << min_os.major_version << '.'
4832 << min_os.minor_version << '.' << min_os.patch_version;
4833 auto triple = base_triple;
4834 triple.setOSName(os.str());
4835 os_name.clear();
4836 if (!os_env.environment.empty())
4837 triple.setEnvironmentName(os_env.environment);
4838 add_triple(triple);
4839 }
4840 } while (false);
4841 offset = cmd_offset + load_cmd.cmdsize;
4842 }
4843
4844 if (!found_any) {
4845 add_triple(base_triple);
4846 }
4847}
4848
4850 ModuleSP module_sp, const llvm::MachO::mach_header &header,
4851 const lldb_private::DataExtractor &data, lldb::offset_t lc_offset) {
4852 ModuleSpecList all_specs;
4853 ModuleSpec base_spec;
4854 GetAllArchSpecs(header, data, MachHeaderSizeFromMagic(header.magic),
4855 base_spec, all_specs);
4856
4857 // If the object file offers multiple alternative load commands,
4858 // pick the one that matches the module.
4859 if (module_sp) {
4860 const ArchSpec &module_arch = module_sp->GetArchitecture();
4861 for (unsigned i = 0, e = all_specs.GetSize(); i != e; ++i) {
4862 ArchSpec mach_arch =
4864 if (module_arch.IsCompatibleMatch(mach_arch))
4865 return mach_arch;
4866 }
4867 }
4868
4869 // Return the first arch we found.
4870 if (all_specs.GetSize() == 0)
4871 return {};
4872 return all_specs.GetModuleSpecRefAtIndex(0).GetArchitecture();
4873}
4874
4876 ModuleSP module_sp(GetModule());
4877 if (module_sp) {
4878 std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
4880 return GetUUID(m_header, *m_data_nsp, offset);
4881 }
4882 return UUID();
4883}
4884
4886 ModuleSP module_sp = GetModule();
4887 if (!module_sp)
4888 return 0;
4889
4890 uint32_t count = 0;
4891 std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
4892 llvm::MachO::load_command load_cmd;
4894 std::vector<std::string> rpath_paths;
4895 std::vector<std::string> rpath_relative_paths;
4896 std::vector<std::string> at_exec_relative_paths;
4897 uint32_t i;
4898 for (i = 0; i < m_header.ncmds; ++i) {
4899 const uint32_t cmd_offset = offset;
4900 if (m_data_nsp->GetU32(&offset, &load_cmd, 2) == nullptr)
4901 break;
4902
4903 switch (load_cmd.cmd) {
4904 case LC_RPATH:
4905 case LC_LOAD_DYLIB:
4906 case LC_LOAD_WEAK_DYLIB:
4907 case LC_REEXPORT_DYLIB:
4908 case LC_LOAD_DYLINKER:
4909 case LC_LOADFVMLIB:
4910 case LC_LOAD_UPWARD_DYLIB: {
4911 uint32_t name_offset = cmd_offset + m_data_nsp->GetU32(&offset);
4912 // For LC_LOAD_DYLIB there is an alternate encoding
4913 // which adds a uint32_t `flags` field for `DYLD_USE_*`
4914 // flags. This can be detected by a timestamp field with
4915 // the `DYLIB_USE_MARKER` constant value.
4916 bool is_delayed_init = false;
4917 uint32_t use_command_marker = m_data_nsp->GetU32(&offset);
4918 if (use_command_marker == 0x1a741800 /* DYLIB_USE_MARKER */) {
4919 offset += 4; /* uint32_t current_version */
4920 offset += 4; /* uint32_t compat_version */
4921 uint32_t flags = m_data_nsp->GetU32(&offset);
4922 // If this LC_LOAD_DYLIB is marked delay-init,
4923 // don't report it as a dependent library -- it
4924 // may be loaded in the process at some point,
4925 // but will most likely not be load at launch.
4926 if (flags & 0x08 /* DYLIB_USE_DELAYED_INIT */)
4927 is_delayed_init = true;
4928 }
4929 const char *path = m_data_nsp->PeekCStr(name_offset);
4930 if (path && !is_delayed_init) {
4931 if (load_cmd.cmd == LC_RPATH)
4932 rpath_paths.push_back(path);
4933 else {
4934 if (path[0] == '@') {
4935 if (strncmp(path, "@rpath", strlen("@rpath")) == 0)
4936 rpath_relative_paths.push_back(path + strlen("@rpath"));
4937 else if (strncmp(path, "@executable_path",
4938 strlen("@executable_path")) == 0)
4939 at_exec_relative_paths.push_back(path +
4940 strlen("@executable_path"));
4941 } else {
4942 FileSpec file_spec(path);
4943 if (files.AppendIfUnique(file_spec))
4944 count++;
4945 }
4946 }
4947 }
4948 } break;
4949
4950 default:
4951 break;
4952 }
4953 offset = cmd_offset + load_cmd.cmdsize;
4954 }
4955
4956 FileSpec this_file_spec(m_file);
4957 FileSystem::Instance().Resolve(this_file_spec);
4958
4959 if (!rpath_paths.empty()) {
4960 // Fixup all LC_RPATH values to be absolute paths.
4961 const std::string this_directory =
4962 this_file_spec.GetDirectory().GetString();
4963 for (auto &rpath : rpath_paths) {
4964 if (llvm::StringRef(rpath).starts_with(g_loader_path))
4965 rpath = this_directory + rpath.substr(g_loader_path.size());
4966 else if (llvm::StringRef(rpath).starts_with(g_executable_path))
4967 rpath = this_directory + rpath.substr(g_executable_path.size());
4968 }
4969
4970 for (const auto &rpath_relative_path : rpath_relative_paths) {
4971 for (const auto &rpath : rpath_paths) {
4972 std::string path = rpath;
4973 path += rpath_relative_path;
4974 // It is OK to resolve this path because we must find a file on disk
4975 // for us to accept it anyway if it is rpath relative.
4976 FileSpec file_spec(path);
4977 FileSystem::Instance().Resolve(file_spec);
4978 if (FileSystem::Instance().Exists(file_spec) &&
4979 files.AppendIfUnique(file_spec)) {
4980 count++;
4981 break;
4982 }
4983 }
4984 }
4985 }
4986
4987 // We may have @executable_paths but no RPATHS. Figure those out here.
4988 // Only do this if this object file is the executable. We have no way to
4989 // get back to the actual executable otherwise, so we won't get the right
4990 // path.
4991 if (!at_exec_relative_paths.empty() && CalculateType() == eTypeExecutable) {
4992 FileSpec exec_dir = this_file_spec.CopyByRemovingLastPathComponent();
4993 for (const auto &at_exec_relative_path : at_exec_relative_paths) {
4994 FileSpec file_spec =
4995 exec_dir.CopyByAppendingPathComponent(at_exec_relative_path);
4996 if (FileSystem::Instance().Exists(file_spec) &&
4997 files.AppendIfUnique(file_spec))
4998 count++;
4999 }
5000 }
5001 return count;
5002}
5003
5005 // If the object file is not an executable it can't hold the entry point.
5006 // m_entry_point_address is initialized to an invalid address, so we can just
5007 // return that. If m_entry_point_address is valid it means we've found it
5008 // already, so return the cached value.
5009
5010 if ((!IsExecutable() && !IsDynamicLoader()) ||
5011 m_entry_point_address.IsValid()) {
5012 return m_entry_point_address;
5013 }
5014
5015 // Otherwise, look for the UnixThread or Thread command. The data for the
5016 // Thread command is given in /usr/include/mach-o.h, but it is basically:
5017 //
5018 // uint32_t flavor - this is the flavor argument you would pass to
5019 // thread_get_state
5020 // uint32_t count - this is the count of longs in the thread state data
5021 // struct XXX_thread_state state - this is the structure from
5022 // <machine/thread_status.h> corresponding to the flavor.
5023 // <repeat this trio>
5024 //
5025 // So we just keep reading the various register flavors till we find the GPR
5026 // one, then read the PC out of there.
5027 // FIXME: We will need to have a "RegisterContext data provider" class at some
5028 // point that can get all the registers
5029 // out of data in this form & attach them to a given thread. That should
5030 // underlie the MacOS X User process plugin, and we'll also need it for the
5031 // MacOS X Core File process plugin. When we have that we can also use it
5032 // here.
5033 //
5034 // For now we hard-code the offsets and flavors we need:
5035 //
5036 //
5037
5038 ModuleSP module_sp(GetModule());
5039 if (module_sp) {
5040 std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
5041 llvm::MachO::load_command load_cmd;
5043 uint32_t i;
5044 lldb::addr_t start_address = LLDB_INVALID_ADDRESS;
5045 bool done = false;
5046
5047 for (i = 0; i < m_header.ncmds; ++i) {
5048 const lldb::offset_t cmd_offset = offset;
5049 if (m_data_nsp->GetU32(&offset, &load_cmd, 2) == nullptr)
5050 break;
5051
5052 switch (load_cmd.cmd) {
5053 case LC_UNIXTHREAD:
5054 case LC_THREAD: {
5055 while (offset < cmd_offset + load_cmd.cmdsize) {
5056 uint32_t flavor = m_data_nsp->GetU32(&offset);
5057 uint32_t count = m_data_nsp->GetU32(&offset);
5058 if (count == 0) {
5059 // We've gotten off somehow, log and exit;
5060 return m_entry_point_address;
5061 }
5062
5063 switch (m_header.cputype) {
5064 case llvm::MachO::CPU_TYPE_ARM:
5065 if (flavor == 1 ||
5066 flavor == 9) // ARM_THREAD_STATE/ARM_THREAD_STATE32
5067 // from mach/arm/thread_status.h
5068 {
5069 offset += 60; // This is the offset of pc in the GPR thread state
5070 // data structure.
5071 start_address = m_data_nsp->GetU32(&offset);
5072 done = true;
5073 }
5074 break;
5075 case llvm::MachO::CPU_TYPE_ARM64:
5076 case llvm::MachO::CPU_TYPE_ARM64_32:
5077 if (flavor == 6) // ARM_THREAD_STATE64 from mach/arm/thread_status.h
5078 {
5079 offset += 256; // This is the offset of pc in the GPR thread state
5080 // data structure.
5081 start_address = m_data_nsp->GetU64(&offset);
5082 done = true;
5083 }
5084 break;
5085 case llvm::MachO::CPU_TYPE_X86_64:
5086 if (flavor ==
5087 4) // x86_THREAD_STATE64 from mach/i386/thread_status.h
5088 {
5089 offset += 16 * 8; // This is the offset of rip in the GPR thread
5090 // state data structure.
5091 start_address = m_data_nsp->GetU64(&offset);
5092 done = true;
5093 }
5094 break;
5095 default:
5096 return m_entry_point_address;
5097 }
5098 // Haven't found the GPR flavor yet, skip over the data for this
5099 // flavor:
5100 if (done)
5101 break;
5102 offset += count * 4;
5103 }
5104 } break;
5105 case LC_MAIN: {
5106 uint64_t entryoffset = m_data_nsp->GetU64(&offset);
5107 SectionSP text_segment_sp =
5109 if (text_segment_sp) {
5110 done = true;
5111 start_address = text_segment_sp->GetFileAddress() + entryoffset;
5112 }
5113 } break;
5114
5115 default:
5116 break;
5117 }
5118 if (done)
5119 break;
5120
5121 // Go to the next load command:
5122 offset = cmd_offset + load_cmd.cmdsize;
5123 }
5124
5125 if (start_address == LLDB_INVALID_ADDRESS && IsDynamicLoader()) {
5126 if (GetSymtab()) {
5127 const Symbol *dyld_start_sym =
5131 if (dyld_start_sym && dyld_start_sym->GetAddress().IsValid()) {
5132 start_address = dyld_start_sym->GetAddress().GetFileAddress();
5133 }
5134 }
5135 }
5136
5137 if (start_address != LLDB_INVALID_ADDRESS) {
5138 // We got the start address from the load commands, so now resolve that
5139 // address in the sections of this ObjectFile:
5140 if (!m_entry_point_address.ResolveAddressUsingFileSections(
5141 start_address, GetSectionList())) {
5142 m_entry_point_address.Clear();
5143 }
5144 } else {
5145 // We couldn't read the UnixThread load command - maybe it wasn't there.
5146 // As a fallback look for the "start" symbol in the main executable.
5147
5148 ModuleSP module_sp(GetModule());
5149
5150 if (module_sp) {
5151 SymbolContextList contexts;
5152 SymbolContext context;
5153 module_sp->FindSymbolsWithNameAndType(ConstString("start"),
5154 eSymbolTypeCode, contexts);
5155 if (contexts.GetSize()) {
5156 if (contexts.GetContextAtIndex(0, context))
5158 }
5159 }
5160 }
5161 }
5162
5163 return m_entry_point_address;
5164}
5165
5167 lldb_private::Address header_addr;
5168 SectionList *section_list = GetSectionList();
5169 if (section_list) {
5170 SectionSP text_segment_sp(
5171 section_list->FindSectionByName(GetSegmentNameTEXT()));
5172 if (text_segment_sp)
5173 header_addr = Address(text_segment_sp, /*offset=*/0);
5174 }
5175 return header_addr;
5176}
5177
5179 ModuleSP module_sp(GetModule());
5180 if (module_sp) {
5181 std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
5185 FileRangeArray::Entry file_range;
5186 llvm::MachO::thread_command thread_cmd;
5187 for (uint32_t i = 0; i < m_header.ncmds; ++i) {
5188 const uint32_t cmd_offset = offset;
5189 if (m_data_nsp->GetU32(&offset, &thread_cmd, 2) == nullptr)
5190 break;
5191
5192 if (thread_cmd.cmd == LC_THREAD) {
5193 file_range.SetRangeBase(offset);
5194 file_range.SetByteSize(thread_cmd.cmdsize - 8);
5195 m_thread_context_offsets.Append(file_range);
5196 }
5197 offset = cmd_offset + thread_cmd.cmdsize;
5198 }
5199 }
5200 }
5201 return m_thread_context_offsets.GetSize();
5202}
5203
5204std::vector<std::tuple<offset_t, offset_t>>
5206 std::vector<std::tuple<offset_t, offset_t>> results;
5207 ModuleSP module_sp(GetModule());
5208 if (module_sp) {
5209 std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
5210
5212 for (uint32_t i = 0; i < m_header.ncmds; ++i) {
5213 const uint32_t cmd_offset = offset;
5214 llvm::MachO::load_command lc = {};
5215 if (m_data_nsp->GetU32(&offset, &lc.cmd, 2) == nullptr)
5216 break;
5217 if (lc.cmd == LC_NOTE) {
5218 char data_owner[17];
5219 m_data_nsp->CopyData(offset, 16, data_owner);
5220 data_owner[16] = '\0';
5221 offset += 16;
5222
5223 if (name == data_owner) {
5224 offset_t payload_offset = m_data_nsp->GetU64_unchecked(&offset);
5225 offset_t payload_size = m_data_nsp->GetU64_unchecked(&offset);
5226 results.push_back({payload_offset, payload_size});
5227 }
5228 }
5229 offset = cmd_offset + lc.cmdsize;
5230 }
5231 }
5232 return results;
5233}
5234
5236 Log *log(
5238 ModuleSP module_sp(GetModule());
5239 if (module_sp) {
5240 std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
5241
5242 auto lc_notes = FindLC_NOTEByName("kern ver str");
5243 for (auto lc_note : lc_notes) {
5244 offset_t payload_offset = std::get<0>(lc_note);
5245 offset_t payload_size = std::get<1>(lc_note);
5246 uint32_t version;
5247 if (m_data_nsp->GetU32(&payload_offset, &version, 1) != nullptr) {
5248 if (version == 1) {
5249 uint32_t strsize = payload_size - sizeof(uint32_t);
5250 std::string result(strsize, '\0');
5251 m_data_nsp->CopyData(payload_offset, strsize, result.data());
5252 LLDB_LOGF(log, "LC_NOTE 'kern ver str' found with text '%s'",
5253 result.c_str());
5254 return result;
5255 }
5256 }
5257 }
5258
5259 // Second, make a pass over the load commands looking for an obsolete
5260 // LC_IDENT load command.
5262 for (uint32_t i = 0; i < m_header.ncmds; ++i) {
5263 const uint32_t cmd_offset = offset;
5264 llvm::MachO::ident_command ident_command;
5265 if (m_data_nsp->GetU32(&offset, &ident_command, 2) == nullptr)
5266 break;
5267 if (ident_command.cmd == LC_IDENT && ident_command.cmdsize != 0) {
5268 std::string result(ident_command.cmdsize, '\0');
5269 if (m_data_nsp->CopyData(offset, ident_command.cmdsize,
5270 result.data()) == ident_command.cmdsize) {
5271 LLDB_LOGF(log, "LC_IDENT found with text '%s'", result.c_str());
5272 return result;
5273 }
5274 }
5275 offset = cmd_offset + ident_command.cmdsize;
5276 }
5277 }
5278 return {};
5279}
5280
5282 AddressableBits addressable_bits;
5283
5285 ModuleSP module_sp(GetModule());
5286 if (module_sp) {
5287 std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
5288 auto lc_notes = FindLC_NOTEByName("addrable bits");
5289 for (auto lc_note : lc_notes) {
5290 offset_t payload_offset = std::get<0>(lc_note);
5291 uint32_t version;
5292 if (m_data_nsp->GetU32(&payload_offset, &version, 1) != nullptr) {
5293 if (version == 3) {
5294 uint32_t num_addr_bits =
5295 m_data_nsp->GetU32_unchecked(&payload_offset);
5296 addressable_bits.SetAddressableBits(num_addr_bits);
5297 LLDB_LOGF(log,
5298 "LC_NOTE 'addrable bits' v3 found, value %d "
5299 "bits",
5300 num_addr_bits);
5301 }
5302 if (version == 4) {
5303 uint32_t lo_addr_bits = m_data_nsp->GetU32_unchecked(&payload_offset);
5304 uint32_t hi_addr_bits = m_data_nsp->GetU32_unchecked(&payload_offset);
5305
5306 if (lo_addr_bits == hi_addr_bits)
5307 addressable_bits.SetAddressableBits(lo_addr_bits);
5308 else
5309 addressable_bits.SetAddressableBits(lo_addr_bits, hi_addr_bits);
5310 LLDB_LOGF(log, "LC_NOTE 'addrable bits' v4 found, value %d & %d bits",
5311 lo_addr_bits, hi_addr_bits);
5312 }
5313 }
5314 }
5315 }
5316 return addressable_bits;
5317}
5318
5320 bool &value_is_offset,
5321 UUID &uuid,
5322 ObjectFile::BinaryType &type) {
5323 Log *log(
5325 value = LLDB_INVALID_ADDRESS;
5326 value_is_offset = false;
5327 uuid.Clear();
5328 uint32_t log2_pagesize = 0; // not currently passed up to caller
5329 uint32_t platform = 0; // not currently passed up to caller
5330 ModuleSP module_sp(GetModule());
5331 if (module_sp) {
5332 std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
5333
5334 auto lc_notes = FindLC_NOTEByName("main bin spec");
5335 for (auto lc_note : lc_notes) {
5336 offset_t payload_offset = std::get<0>(lc_note);
5337
5338 // struct main_bin_spec
5339 // {
5340 // uint32_t version; // currently 2
5341 // uint32_t type; // 0 == unspecified,
5342 // // 1 == kernel
5343 // // 2 == user process,
5344 // dyld mach-o binary addr
5345 // // 3 == standalone binary
5346 // // 4 == user process,
5347 // // dyld_all_image_infos addr
5348 // uint64_t address; // UINT64_MAX if address not specified
5349 // uint64_t slide; // slide, UINT64_MAX if unspecified
5350 // // 0 if no slide needs to be applied to
5351 // // file address
5352 // uuid_t uuid; // all zero's if uuid not specified
5353 // uint32_t log2_pagesize; // process page size in log base 2,
5354 // // e.g. 4k pages are 12.
5355 // // 0 for unspecified
5356 // uint32_t platform; // The Mach-O platform for this corefile.
5357 // // 0 for unspecified.
5358 // // The values are defined in
5359 // // <mach-o/loader.h>, PLATFORM_*.
5360 // } __attribute((packed));
5361
5362 // "main bin spec" (main binary specification) data payload is
5363 // formatted:
5364 // uint32_t version [currently 1]
5365 // uint32_t type [0 == unspecified, 1 == kernel,
5366 // 2 == user process, 3 == firmware ]
5367 // uint64_t address [ UINT64_MAX if address not specified ]
5368 // uuid_t uuid [ all zero's if uuid not specified ]
5369 // uint32_t log2_pagesize [ process page size in log base
5370 // 2, e.g. 4k pages are 12.
5371 // 0 for unspecified ]
5372 // uint32_t unused [ for alignment ]
5373
5374 uint32_t version;
5375 if (m_data_nsp->GetU32(&payload_offset, &version, 1) != nullptr &&
5376 version <= 2) {
5377 uint32_t binspec_type = 0;
5378 uuid_t raw_uuid;
5379 memset(raw_uuid, 0, sizeof(uuid_t));
5380
5381 if (!m_data_nsp->GetU32(&payload_offset, &binspec_type, 1))
5382 return false;
5383 if (!m_data_nsp->GetU64(&payload_offset, &value, 1))
5384 return false;
5385 uint64_t slide = LLDB_INVALID_ADDRESS;
5386 if (version > 1 && !m_data_nsp->GetU64(&payload_offset, &slide, 1))
5387 return false;
5388 if (value == LLDB_INVALID_ADDRESS && slide != LLDB_INVALID_ADDRESS) {
5389 value = slide;
5390 value_is_offset = true;
5391 }
5392
5393 if (m_data_nsp->CopyData(payload_offset, sizeof(uuid_t), raw_uuid) !=
5394 0) {
5395 uuid = UUID(raw_uuid, sizeof(uuid_t));
5396 // convert the "main bin spec" type into our
5397 // ObjectFile::BinaryType enum
5398 const char *typestr = "unrecognized type";
5399 type = eBinaryTypeInvalid;
5400 switch (binspec_type) {
5401 case 0:
5402 type = eBinaryTypeUnknown;
5403 typestr = "uknown";
5404 break;
5405 case 1:
5406 type = eBinaryTypeKernel;
5407 typestr = "xnu kernel";
5408 break;
5409 case 2:
5410 type = eBinaryTypeUser;
5411 typestr = "userland dyld";
5412 break;
5413 case 3:
5414 type = eBinaryTypeStandalone;
5415 typestr = "standalone";
5416 break;
5417 case 4:
5419 typestr = "userland dyld_all_image_infos";
5420 break;
5421 }
5422 LLDB_LOGF(log,
5423 "LC_NOTE 'main bin spec' found, version %d type %d "
5424 "(%s), value 0x%" PRIx64 " value-is-slide==%s uuid %s",
5425 version, type, typestr, value,
5426 value_is_offset ? "true" : "false",
5427 uuid.GetAsString().c_str());
5428 if (!m_data_nsp->GetU32(&payload_offset, &log2_pagesize, 1))
5429 return false;
5430 if (version > 1 && !m_data_nsp->GetU32(&payload_offset, &platform, 1))
5431 return false;
5432 return true;
5433 }
5434 }
5435 }
5436 }
5437 return false;
5438}
5439
5441 std::vector<lldb::tid_t> &tids) {
5442 tids.clear();
5443 ModuleSP module_sp(GetModule());
5444 if (module_sp) {
5445 std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
5446
5449 StructuredData::Dictionary *dict = object_sp->GetAsDictionary();
5450 StructuredData::Array *threads;
5451 if (!dict->GetValueForKeyAsArray("threads", threads) || !threads) {
5452 LLDB_LOGF(log,
5453 "'process metadata' LC_NOTE does not have a 'threads' key");
5454 return false;
5455 }
5456 if (threads->GetSize() != GetNumThreadContexts()) {
5457 LLDB_LOGF(log, "Unable to read 'process metadata' LC_NOTE, number of "
5458 "threads does not match number of LC_THREADS.");
5459 return false;
5460 }
5461 const size_t num_threads = threads->GetSize();
5462 for (size_t i = 0; i < num_threads; i++) {
5463 std::optional<StructuredData::Dictionary *> maybe_thread =
5464 threads->GetItemAtIndexAsDictionary(i);
5465 if (!maybe_thread) {
5466 LLDB_LOGF(log,
5467 "Unable to read 'process metadata' LC_NOTE, threads "
5468 "array does not have a dictionary at index %zu.",
5469 i);
5470 return false;
5471 }
5472 StructuredData::Dictionary *thread = *maybe_thread;
5474 if (thread->GetValueForKeyAsInteger<lldb::tid_t>("thread_id", tid))
5475 if (tid == 0)
5477 tids.push_back(tid);
5478 }
5479
5480 if (log) {
5481 StreamString logmsg;
5482 logmsg.Printf("LC_NOTE 'process metadata' found: ");
5483 dict->Dump(logmsg, /* pretty_print */ false);
5484 LLDB_LOGF(log, "%s", logmsg.GetData());
5485 }
5486 return true;
5487 }
5488 }
5489 return false;
5490}
5491
5493 ModuleSP module_sp(GetModule());
5494 if (!module_sp)
5495 return {};
5496
5498 std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
5499 auto lc_notes = FindLC_NOTEByName("process metadata");
5500 if (lc_notes.size() == 0)
5501 return {};
5502
5503 if (lc_notes.size() > 1)
5504 LLDB_LOGF(
5505 log,
5506 "Multiple 'process metadata' LC_NOTEs found, only using the first.");
5507
5508 auto [payload_offset, strsize] = lc_notes[0];
5509 std::string buf(strsize, '\0');
5510 if (m_data_nsp->CopyData(payload_offset, strsize, buf.data()) != strsize) {
5511 LLDB_LOGF(log,
5512 "Unable to read %" PRIu64
5513 " bytes of 'process metadata' LC_NOTE JSON contents",
5514 strsize);
5515 return {};
5516 }
5517 while (buf.back() == '\0')
5518 buf.resize(buf.size() - 1);
5520 if (!object_sp) {
5521 LLDB_LOGF(log, "Unable to read 'process metadata' LC_NOTE, did not "
5522 "parse as valid JSON.");
5523 return {};
5524 }
5525 StructuredData::Dictionary *dict = object_sp->GetAsDictionary();
5526 if (!dict) {
5527 LLDB_LOGF(log, "Unable to read 'process metadata' LC_NOTE, did not "
5528 "get a dictionary.");
5529 return {};
5530 }
5531
5532 return object_sp;
5533}
5534
5537 lldb_private::Thread &thread) {
5538 lldb::RegisterContextSP reg_ctx_sp;
5539
5540 ModuleSP module_sp(GetModule());
5541 if (module_sp) {
5542 std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
5545
5546 const FileRangeArray::Entry *thread_context_file_range =
5547 m_thread_context_offsets.GetEntryAtIndex(idx);
5548 if (thread_context_file_range) {
5549
5550 DataExtractor data(*m_data_nsp, thread_context_file_range->GetRangeBase(),
5551 thread_context_file_range->GetByteSize());
5552
5553 switch (m_header.cputype) {
5554 case llvm::MachO::CPU_TYPE_ARM64:
5555 case llvm::MachO::CPU_TYPE_ARM64_32:
5556 reg_ctx_sp =
5557 std::make_shared<RegisterContextDarwin_arm64_Mach>(thread, data);
5558 break;
5559
5560 case llvm::MachO::CPU_TYPE_ARM:
5561 reg_ctx_sp =
5562 std::make_shared<RegisterContextDarwin_arm_Mach>(thread, data);
5563 break;
5564
5565 case llvm::MachO::CPU_TYPE_X86_64:
5566 reg_ctx_sp =
5567 std::make_shared<RegisterContextDarwin_x86_64_Mach>(thread, data);
5568 break;
5569
5570 case llvm::MachO::CPU_TYPE_RISCV:
5571 reg_ctx_sp =
5572 std::make_shared<RegisterContextDarwin_riscv32_Mach>(thread, data);
5573 break;
5574 }
5575 }
5576 }
5577 return reg_ctx_sp;
5578}
5579
5581 switch (m_header.filetype) {
5582 case MH_OBJECT: // 0x1u
5583 if (GetAddressByteSize() == 4) {
5584 // 32 bit kexts are just object files, but they do have a valid
5585 // UUID load command.
5586 if (GetUUID()) {
5587 // this checking for the UUID load command is not enough we could
5588 // eventually look for the symbol named "OSKextGetCurrentIdentifier" as
5589 // this is required of kexts
5590 if (m_strata == eStrataInvalid)
5592 return eTypeSharedLibrary;
5593 }
5594 }
5595 return eTypeObjectFile;
5596
5597 case MH_EXECUTE:
5598 return eTypeExecutable; // 0x2u
5599 case MH_FVMLIB:
5600 return eTypeSharedLibrary; // 0x3u
5601 case MH_CORE:
5602 return eTypeCoreFile; // 0x4u
5603 case MH_PRELOAD:
5604 return eTypeSharedLibrary; // 0x5u
5605 case MH_DYLIB:
5606 return eTypeSharedLibrary; // 0x6u
5607 case MH_DYLINKER:
5608 return eTypeDynamicLinker; // 0x7u
5609 case MH_BUNDLE:
5610 return eTypeSharedLibrary; // 0x8u
5611 case MH_DYLIB_STUB:
5612 return eTypeStubLibrary; // 0x9u
5613 case MH_DSYM:
5614 return eTypeDebugInfo; // 0xAu
5615 case MH_KEXT_BUNDLE:
5616 return eTypeSharedLibrary; // 0xBu
5617 default:
5618 break;
5619 }
5620 return eTypeUnknown;
5621}
5622
5624 switch (m_header.filetype) {
5625 case MH_OBJECT: // 0x1u
5626 {
5627 // 32 bit kexts are just object files, but they do have a valid
5628 // UUID load command.
5629 if (GetUUID()) {
5630 // this checking for the UUID load command is not enough we could
5631 // eventually look for the symbol named "OSKextGetCurrentIdentifier" as
5632 // this is required of kexts
5633 if (m_type == eTypeInvalid)
5635
5636 return eStrataKernel;
5637 }
5638 }
5639 return eStrataUnknown;
5640
5641 case MH_EXECUTE: // 0x2u
5642 // Check for the MH_DYLDLINK bit in the flags
5643 if (m_header.flags & MH_DYLDLINK) {
5644 return eStrataUser;
5645 } else {
5646 SectionList *section_list = GetSectionList();
5647 if (section_list) {
5648 static ConstString g_kld_section_name("__KLD");
5649 if (section_list->FindSectionByName(g_kld_section_name))
5650 return eStrataKernel;
5651 }
5652 }
5653 return eStrataRawImage;
5654
5655 case MH_FVMLIB:
5656 return eStrataUser; // 0x3u
5657 case MH_CORE:
5658 return eStrataUnknown; // 0x4u
5659 case MH_PRELOAD:
5660 return eStrataRawImage; // 0x5u
5661 case MH_DYLIB:
5662 return eStrataUser; // 0x6u
5663 case MH_DYLINKER:
5664 return eStrataUser; // 0x7u
5665 case MH_BUNDLE:
5666 return eStrataUser; // 0x8u
5667 case MH_DYLIB_STUB:
5668 return eStrataUser; // 0x9u
5669 case MH_DSYM:
5670 return eStrataUnknown; // 0xAu
5671 case MH_KEXT_BUNDLE:
5672 return eStrataKernel; // 0xBu
5673 default:
5674 break;
5675 }
5676 return eStrataUnknown;
5677}
5678
5679llvm::VersionTuple ObjectFileMachO::GetVersion() {
5680 ModuleSP module_sp(GetModule());
5681 if (module_sp) {
5682 std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
5683 llvm::MachO::dylib_command load_cmd;
5685 uint32_t version_cmd = 0;
5686 uint64_t version = 0;
5687 uint32_t i;
5688 for (i = 0; i < m_header.ncmds; ++i) {
5689 const lldb::offset_t cmd_offset = offset;
5690 if (m_data_nsp->GetU32(&offset, &load_cmd, 2) == nullptr)
5691 break;
5692
5693 if (load_cmd.cmd == LC_ID_DYLIB) {
5694 if (version_cmd == 0) {
5695 version_cmd = load_cmd.cmd;
5696 if (m_data_nsp->GetU32(&offset, &load_cmd.dylib, 4) == nullptr)
5697 break;
5698 version = load_cmd.dylib.current_version;
5699 }
5700 break; // Break for now unless there is another more complete version
5701 // number load command in the future.
5702 }
5703 offset = cmd_offset + load_cmd.cmdsize;
5704 }
5705
5706 if (version_cmd == LC_ID_DYLIB) {
5707 unsigned major = (version & 0xFFFF0000ull) >> 16;
5708 unsigned minor = (version & 0x0000FF00ull) >> 8;
5709 unsigned subminor = (version & 0x000000FFull);
5710 return llvm::VersionTuple(major, minor, subminor);
5711 }
5712 }
5713 return llvm::VersionTuple();
5714}
5715
5717 ModuleSP module_sp(GetModule());
5718 ArchSpec arch;
5719 if (module_sp) {
5720 std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
5721
5722 return GetArchitecture(module_sp, m_header, *m_data_nsp,
5724 }
5725 return arch;
5726}
5727
5729 addr_t &base_addr, UUID &uuid) {
5730 uuid.Clear();
5731 base_addr = LLDB_INVALID_ADDRESS;
5732 if (process && process->GetDynamicLoader()) {
5733 DynamicLoader *dl = process->GetDynamicLoader();
5734 LazyBool using_shared_cache;
5735 LazyBool private_shared_cache;
5736 FileSpec sc_filepath;
5737 std::optional<uint64_t> size;
5738 dl->GetSharedCacheInformation(base_addr, uuid, using_shared_cache,
5739 private_shared_cache, sc_filepath, size);
5740 }
5742 LLDB_LOGF(
5743 log,
5744 "inferior process shared cache has a UUID of %s, base address 0x%" PRIx64,
5745 uuid.GetAsString().c_str(), base_addr);
5746}
5747
5748// From dyld SPI header dyld_process_info.h
5749typedef void *dyld_process_info;
5751 uuid_t cacheUUID; // UUID of cache used by process
5752 uint64_t cacheBaseAddress; // load address of dyld shared cache
5753 bool noCache; // process is running without a dyld cache
5754 bool privateCache; // process is using a private copy of its dyld cache
5755};
5756
5757// #including mach/mach.h pulls in machine.h & CPU_TYPE_ARM etc conflicts with
5758// llvm enum definitions llvm::MachO::CPU_TYPE_ARM turning them into compile
5759// errors. So we need to use the actual underlying types of task_t and
5760// kern_return_t below.
5761extern "C" unsigned int /*task_t*/ mach_task_self();
5762
5764 uuid.Clear();
5765 base_addr = LLDB_INVALID_ADDRESS;
5766
5767#if defined(__APPLE__)
5768 uint8_t *(*dyld_get_all_image_infos)(void);
5769 dyld_get_all_image_infos =
5770 (uint8_t * (*)()) dlsym(RTLD_DEFAULT, "_dyld_get_all_image_infos");
5771 if (dyld_get_all_image_infos) {
5772 uint8_t *dyld_all_image_infos_address = dyld_get_all_image_infos();
5773 if (dyld_all_image_infos_address) {
5774 uint32_t *version = (uint32_t *)
5775 dyld_all_image_infos_address; // version <mach-o/dyld_images.h>
5776 if (*version >= 13) {
5777 uuid_t *sharedCacheUUID_address = 0;
5778 int wordsize = sizeof(uint8_t *);
5779 if (wordsize == 8) {
5780 sharedCacheUUID_address =
5781 (uuid_t *)((uint8_t *)dyld_all_image_infos_address +
5782 160); // sharedCacheUUID <mach-o/dyld_images.h>
5783 if (*version >= 15)
5784 base_addr =
5785 *(uint64_t
5786 *)((uint8_t *)dyld_all_image_infos_address +
5787 176); // sharedCacheBaseAddress <mach-o/dyld_images.h>
5788 } else {
5789 sharedCacheUUID_address =
5790 (uuid_t *)((uint8_t *)dyld_all_image_infos_address +
5791 84); // sharedCacheUUID <mach-o/dyld_images.h>
5792 if (*version >= 15) {
5793 base_addr = 0;
5794 base_addr =
5795 *(uint32_t
5796 *)((uint8_t *)dyld_all_image_infos_address +
5797 100); // sharedCacheBaseAddress <mach-o/dyld_images.h>
5798 }
5799 }
5800 uuid = UUID(sharedCacheUUID_address, sizeof(uuid_t));
5801 }
5802 }
5803 } else {
5804 // Exists in macOS 10.12 and later, iOS 10.0 and later - dyld SPI
5805 dyld_process_info (*dyld_process_info_create)(
5806 unsigned int /* task_t */ task, uint64_t timestamp,
5807 unsigned int /*kern_return_t*/ *kernelError);
5808 void (*dyld_process_info_get_cache)(void *info, void *cacheInfo);
5809 void (*dyld_process_info_release)(dyld_process_info info);
5810
5811 dyld_process_info_create = (void *(*)(unsigned int /* task_t */, uint64_t,
5812 unsigned int /*kern_return_t*/ *))
5813 dlsym(RTLD_DEFAULT, "_dyld_process_info_create");
5814 dyld_process_info_get_cache = (void (*)(void *, void *))dlsym(
5815 RTLD_DEFAULT, "_dyld_process_info_get_cache");
5816 dyld_process_info_release =
5817 (void (*)(void *))dlsym(RTLD_DEFAULT, "_dyld_process_info_release");
5818
5819 if (dyld_process_info_create && dyld_process_info_get_cache) {
5820 unsigned int /*kern_return_t */ kern_ret;
5821 dyld_process_info process_info =
5822 dyld_process_info_create(::mach_task_self(), 0, &kern_ret);
5823 if (process_info) {
5825 memset(&sc_info, 0, sizeof(struct lldb_copy__dyld_process_cache_info));
5826 dyld_process_info_get_cache(process_info, &sc_info);
5827 if (sc_info.cacheBaseAddress != 0) {
5828 base_addr = sc_info.cacheBaseAddress;
5829 uuid = UUID(sc_info.cacheUUID, sizeof(uuid_t));
5830 }
5831 dyld_process_info_release(process_info);
5832 }
5833 }
5834 }
5836 if (log && uuid.IsValid())
5837 LLDB_LOGF(log,
5838 "lldb's in-memory shared cache has a UUID of %s base address of "
5839 "0x%" PRIx64,
5840 uuid.GetAsString().c_str(), base_addr);
5841#endif
5842}
5843
5844static llvm::VersionTuple FindMinimumVersionInfo(DataExtractor &data,
5845 lldb::offset_t offset,
5846 size_t ncmds) {
5847 for (size_t i = 0; i < ncmds; i++) {
5848 const lldb::offset_t load_cmd_offset = offset;
5849 llvm::MachO::load_command lc = {};
5850 if (data.GetU32(&offset, &lc.cmd, 2) == nullptr)
5851 break;
5852
5853 uint32_t version = 0;
5854 if (lc.cmd == llvm::MachO::LC_VERSION_MIN_MACOSX ||
5855 lc.cmd == llvm::MachO::LC_VERSION_MIN_IPHONEOS ||
5856 lc.cmd == llvm::MachO::LC_VERSION_MIN_TVOS ||
5857 lc.cmd == llvm::MachO::LC_VERSION_MIN_WATCHOS) {
5858 // struct version_min_command {
5859 // uint32_t cmd; // LC_VERSION_MIN_*
5860 // uint32_t cmdsize;
5861 // uint32_t version; // X.Y.Z encoded in nibbles xxxx.yy.zz
5862 // uint32_t sdk;
5863 // };
5864 // We want to read version.
5865 version = data.GetU32(&offset);
5866 } else if (lc.cmd == llvm::MachO::LC_BUILD_VERSION) {
5867 // struct build_version_command {
5868 // uint32_t cmd; // LC_BUILD_VERSION
5869 // uint32_t cmdsize;
5870 // uint32_t platform;
5871 // uint32_t minos; // X.Y.Z encoded in nibbles xxxx.yy.zz
5872 // uint32_t sdk;
5873 // uint32_t ntools;
5874 // };
5875 // We want to read minos.
5876 offset += sizeof(uint32_t); // Skip over platform
5877 version = data.GetU32(&offset); // Extract minos
5878 }
5879
5880 if (version) {
5881 const uint32_t xxxx = version >> 16;
5882 const uint32_t yy = (version >> 8) & 0xffu;
5883 const uint32_t zz = version & 0xffu;
5884 if (xxxx)
5885 return llvm::VersionTuple(xxxx, yy, zz);
5886 }
5887 offset = load_cmd_offset + lc.cmdsize;
5888 }
5889 return llvm::VersionTuple();
5890}
5891
5898
5905
5907 return m_header.filetype == llvm::MachO::MH_DYLINKER;
5908}
5909
5911 // Dsymutil guarantees that the .debug_aranges accelerator is complete and can
5912 // be trusted by LLDB.
5913 return m_header.filetype == llvm::MachO::MH_DSYM;
5914}
5915
5919
5921 // Find the first address of the mach header which is the first non-zero file
5922 // sized section whose file offset is zero. This is the base file address of
5923 // the mach-o file which can be subtracted from the vmaddr of the other
5924 // segments found in memory and added to the load address
5925 ModuleSP module_sp = GetModule();
5926 if (!module_sp)
5927 return nullptr;
5928 SectionList *section_list = GetSectionList();
5929 if (!section_list)
5930 return nullptr;
5931
5932 // Some binaries can have a TEXT segment with a non-zero file offset.
5933 // Binaries in the shared cache are one example. Some hand-generated
5934 // binaries may not be laid out in the normal TEXT,DATA,LC_SYMTAB order
5935 // in the file, even though they're laid out correctly in vmaddr terms.
5936 SectionSP text_segment_sp =
5937 section_list->FindSectionByName(GetSegmentNameTEXT());
5938 if (text_segment_sp.get() && SectionIsLoadable(text_segment_sp.get()))
5939 return text_segment_sp.get();
5940
5941 const size_t num_sections = section_list->GetSize();
5942 for (size_t sect_idx = 0; sect_idx < num_sections; ++sect_idx) {
5943 Section *section = section_list->GetSectionAtIndex(sect_idx).get();
5944 if (section->GetFileOffset() == 0 && SectionIsLoadable(section))
5945 return section;
5946 }
5947
5948 return nullptr;
5949}
5950
5952 assert(section.GetObjectFile() == this && "Wrong object file!");
5953 SectionSP segment = section.GetParent();
5954 if (!segment)
5955 return false;
5956
5957 const bool is_data_const_got =
5958 segment->GetName() == "__DATA_CONST" && section.GetName() == "__got";
5959 const bool is_auth_const_ptr =
5960 segment->GetName() == "__AUTH_CONST" &&
5961 (section.GetName() == "__auth_got" || section.GetName() == "__auth_ptr");
5962 return is_data_const_got || is_auth_const_ptr;
5963}
5964
5966 if (!section)
5967 return false;
5968 if (section->IsThreadSpecific())
5969 return false;
5970 if (GetModule().get() != section->GetModule().get())
5971 return false;
5972 // firmware style binaries with llvm gcov segment do
5973 // not have that segment mapped into memory.
5974 if (section->GetName() == GetSegmentNameLLVM_COV()) {
5975 const Strata strata = GetStrata();
5976 if (strata == eStrataKernel || strata == eStrataRawImage)
5977 return false;
5978 }
5979 // Be careful with __LINKEDIT and __DWARF segments
5980 if (section->GetName() == GetSegmentNameLINKEDIT() ||
5981 section->GetName() == GetSegmentNameDWARF()) {
5982 // Only map __LINKEDIT and __DWARF if we have an in memory image and
5983 // this isn't a kernel binary like a kext or mach_kernel.
5984 const bool is_memory_image = (bool)m_process_wp.lock();
5985 const Strata strata = GetStrata();
5986 if (is_memory_image == false || strata == eStrataKernel)
5987 return false;
5988 }
5989 return true;
5990}
5991
5993 lldb::addr_t header_load_address, const Section *header_section,
5994 const Section *section) {
5995 ModuleSP module_sp = GetModule();
5996 if (module_sp && header_section && section &&
5997 header_load_address != LLDB_INVALID_ADDRESS) {
5998 lldb::addr_t file_addr = header_section->GetFileAddress();
5999 if (file_addr != LLDB_INVALID_ADDRESS && SectionIsLoadable(section))
6000 return section->GetFileAddress() - file_addr + header_load_address;
6001 }
6002 return LLDB_INVALID_ADDRESS;
6003}
6004
6006 bool value_is_offset) {
6008 ModuleSP module_sp = GetModule();
6009 if (!module_sp)
6010 return false;
6011
6012 SectionList *section_list = GetSectionList();
6013 if (!section_list)
6014 return false;
6015
6016 size_t num_loaded_sections = 0;
6017 const size_t num_sections = section_list->GetSize();
6018
6019 // Warn if some top-level segments map to the same address. The binary may be
6020 // malformed.
6021 const bool warn_multiple = true;
6022
6023 if (log) {
6024 StreamString logmsg;
6025 logmsg << "ObjectFileMachO::SetLoadAddress ";
6026 if (GetFileSpec())
6027 logmsg << "path='" << GetFileSpec().GetPath() << "' ";
6028 if (GetUUID()) {
6029 logmsg << "uuid=" << GetUUID().GetAsString();
6030 }
6031 LLDB_LOGF(log, "%s", logmsg.GetData());
6032 }
6033 if (value_is_offset) {
6034 // "value" is an offset to apply to each top level segment
6035 for (size_t sect_idx = 0; sect_idx < num_sections; ++sect_idx) {
6036 // Iterate through the object file sections to find all of the
6037 // sections that size on disk (to avoid __PAGEZERO) and load them
6038 SectionSP section_sp(section_list->GetSectionAtIndex(sect_idx));
6039 if (SectionIsLoadable(section_sp.get())) {
6040 LLDB_LOG(
6041 log,
6042 "ObjectFileMachO::SetLoadAddress segment '{0}' load addr is {1:x}",
6043 section_sp->GetName(), section_sp->GetFileAddress() + value);
6044 if (target.SetSectionLoadAddress(section_sp,
6045 section_sp->GetFileAddress() + value,
6046 warn_multiple))
6047 ++num_loaded_sections;
6048 }
6049 }
6050 } else {
6051 // "value" is the new base address of the mach_header, adjust each
6052 // section accordingly
6053
6054 Section *mach_header_section = GetMachHeaderSection();
6055 if (mach_header_section) {
6056 for (size_t sect_idx = 0; sect_idx < num_sections; ++sect_idx) {
6057 SectionSP section_sp(section_list->GetSectionAtIndex(sect_idx));
6058
6059 lldb::addr_t section_load_addr =
6061 value, mach_header_section, section_sp.get());
6062 if (section_load_addr != LLDB_INVALID_ADDRESS) {
6063 LLDB_LOG(log,
6064 "ObjectFileMachO::SetLoadAddress segment '{0}' load addr is "
6065 "{1:x}",
6066 section_sp->GetName(), section_load_addr);
6067 if (target.SetSectionLoadAddress(section_sp, section_load_addr,
6068 warn_multiple))
6069 ++num_loaded_sections;
6070 }
6071 }
6072 }
6073 }
6074 return num_loaded_sections > 0;
6075}
6076
6078 uint32_t version; // currently 1
6079 uint32_t imgcount; // number of binary images
6080 uint64_t entries_fileoff; // file offset in the corefile of where the array of
6081 // struct entry's begin.
6082 uint32_t entries_size; // size of 'struct entry'.
6083 uint32_t unused;
6084};
6085
6087 uint64_t filepath_offset; // offset in corefile to c-string of the file path,
6088 // UINT64_MAX if unavailable.
6089 uuid_t uuid; // uint8_t[16]. should be set to all zeroes if
6090 // uuid is unknown.
6091 uint64_t load_address; // UINT64_MAX if unknown.
6092 uint64_t seg_addrs_offset; // offset to the array of struct segment_vmaddr's.
6093 uint32_t segment_count; // The number of segments for this binary.
6094 uint32_t unused;
6095
6098 memset(&uuid, 0, sizeof(uuid_t));
6099 segment_count = 0;
6102 unused = 0;
6103 }
6106 memcpy(&uuid, &rhs.uuid, sizeof(uuid_t));
6110 unused = rhs.unused;
6111 }
6112};
6113
6115 char segname[16];
6116 uint64_t vmaddr;
6117 uint64_t unused;
6118
6120 memset(&segname, 0, 16);
6122 unused = 0;
6123 }
6125 memcpy(&segname, &rhs.segname, 16);
6126 vmaddr = rhs.vmaddr;
6127 unused = rhs.unused;
6128 }
6129};
6130
6131// Write the payload for the "all image infos" LC_NOTE into
6132// the supplied all_image_infos_payload, assuming that this
6133// will be written into the corefile starting at
6134// initial_file_offset.
6135//
6136// The placement of this payload is a little tricky. We're
6137// laying this out as
6138//
6139// 1. header (struct all_image_info_header)
6140// 2. Array of fixed-size (struct image_entry)'s, one
6141// per binary image present in the process.
6142// 3. Arrays of (struct segment_vmaddr)'s, a varying number
6143// for each binary image.
6144// 4. Variable length c-strings of binary image filepaths,
6145// one per binary.
6146//
6147// To compute where everything will be laid out in the
6148// payload, we need to iterate over the images and calculate
6149// how many segment_vmaddr structures each image will need,
6150// and how long each image's filepath c-string is. There
6151// are some multiple passes over the image list while calculating
6152// everything.
6153
6154static offset_t
6156 offset_t initial_file_offset,
6157 StreamString &all_image_infos_payload,
6159 Target &target = process_sp->GetTarget();
6160 ModuleList modules = target.GetImages();
6161
6162 // stack-only corefiles have no reason to include binaries that
6163 // are not executing; we're trying to make the smallest corefile
6164 // we can, so leave the rest out.
6166 modules.Clear();
6167
6168 std::set<std::string> executing_uuids;
6169 std::vector<ThreadSP> thread_list =
6170 process_sp->CalculateCoreFileThreadList(options);
6171 for (const ThreadSP &thread_sp : thread_list) {
6172 uint32_t stack_frame_count = thread_sp->GetStackFrameCount();
6173 for (uint32_t j = 0; j < stack_frame_count; j++) {
6174 StackFrameSP stack_frame_sp = thread_sp->GetStackFrameAtIndex(j);
6175 Address pc = stack_frame_sp->GetFrameCodeAddress();
6176 ModuleSP module_sp = pc.GetModule();
6177 if (module_sp) {
6178 UUID uuid = module_sp->GetUUID();
6179 if (uuid.IsValid()) {
6180 executing_uuids.insert(uuid.GetAsString());
6181 modules.AppendIfNeeded(module_sp);
6182 }
6183 }
6184 }
6185 }
6186 size_t modules_count = modules.GetSize();
6187
6188 struct all_image_infos_header infos;
6189 infos.version = 1;
6190 infos.imgcount = modules_count;
6191 infos.entries_size = sizeof(image_entry);
6192 infos.entries_fileoff = initial_file_offset + sizeof(all_image_infos_header);
6193 infos.unused = 0;
6194
6195 all_image_infos_payload.PutHex32(infos.version);
6196 all_image_infos_payload.PutHex32(infos.imgcount);
6197 all_image_infos_payload.PutHex64(infos.entries_fileoff);
6198 all_image_infos_payload.PutHex32(infos.entries_size);
6199 all_image_infos_payload.PutHex32(infos.unused);
6200
6201 // First create the structures for all of the segment name+vmaddr vectors
6202 // for each module, so we will know the size of them as we add the
6203 // module entries.
6204 std::vector<std::vector<segment_vmaddr>> modules_segment_vmaddrs;
6205 for (size_t i = 0; i < modules_count; i++) {
6206 ModuleSP module = modules.GetModuleAtIndex(i);
6207
6208 SectionList *sections = module->GetSectionList();
6209 size_t sections_count = sections->GetSize();
6210 std::vector<segment_vmaddr> segment_vmaddrs;
6211 for (size_t j = 0; j < sections_count; j++) {
6212 SectionSP section = sections->GetSectionAtIndex(j);
6213 if (!section->GetParent().get()) {
6214 addr_t vmaddr = section->GetLoadBaseAddress(&target);
6215 if (vmaddr == LLDB_INVALID_ADDRESS)
6216 continue;
6217 ConstString name = section->GetName();
6218 segment_vmaddr seg_vmaddr;
6219 // This is the uncommon case where strncpy is exactly
6220 // the right one, doesn't need to be nul terminated.
6221 // The segment name in a Mach-O LC_SEGMENT/LC_SEGMENT_64 is char[16] and
6222 // is not guaranteed to be nul-terminated if all 16 characters are
6223 // used.
6224 // coverity[buffer_size_warning]
6225 strncpy(seg_vmaddr.segname, name.AsCString(nullptr),
6226 sizeof(seg_vmaddr.segname));
6227 seg_vmaddr.vmaddr = vmaddr;
6228 seg_vmaddr.unused = 0;
6229 segment_vmaddrs.push_back(seg_vmaddr);
6230 }
6231 }
6232 modules_segment_vmaddrs.push_back(segment_vmaddrs);
6233 }
6234
6235 offset_t size_of_vmaddr_structs = 0;
6236 for (size_t i = 0; i < modules_segment_vmaddrs.size(); i++) {
6237 size_of_vmaddr_structs +=
6238 modules_segment_vmaddrs[i].size() * sizeof(segment_vmaddr);
6239 }
6240
6241 offset_t size_of_filepath_cstrings = 0;
6242 for (size_t i = 0; i < modules_count; i++) {
6243 ModuleSP module_sp = modules.GetModuleAtIndex(i);
6244 size_of_filepath_cstrings += module_sp->GetFileSpec().GetPath().size() + 1;
6245 }
6246
6247 // Calculate the file offsets of our "all image infos" payload in the
6248 // corefile. initial_file_offset the original value passed in to this method.
6249
6250 offset_t start_of_entries =
6251 initial_file_offset + sizeof(all_image_infos_header);
6252 offset_t start_of_seg_vmaddrs =
6253 start_of_entries + sizeof(image_entry) * modules_count;
6254 offset_t start_of_filenames = start_of_seg_vmaddrs + size_of_vmaddr_structs;
6255
6256 offset_t final_file_offset = start_of_filenames + size_of_filepath_cstrings;
6257
6258 // Now write the one-per-module 'struct image_entry' into the
6259 // StringStream; keep track of where the struct segment_vmaddr
6260 // entries for each module will end up in the corefile.
6261
6262 offset_t current_string_offset = start_of_filenames;
6263 offset_t current_segaddrs_offset = start_of_seg_vmaddrs;
6264 for (size_t i = 0; i < modules_count; i++) {
6265 ModuleSP module_sp = modules.GetModuleAtIndex(i);
6266
6267 struct image_entry ent;
6268 memcpy(&ent.uuid, module_sp->GetUUID().GetBytes().data(), sizeof(ent.uuid));
6269 if (modules_segment_vmaddrs[i].size() > 0) {
6270 ent.segment_count = modules_segment_vmaddrs[i].size();
6271 ent.seg_addrs_offset = current_segaddrs_offset;
6272 }
6273 ent.filepath_offset = current_string_offset;
6274 ObjectFile *objfile = module_sp->GetObjectFile();
6275 if (objfile) {
6276 Address base_addr(objfile->GetBaseAddress());
6277 if (base_addr.IsValid()) {
6278 ent.load_address = base_addr.GetLoadAddress(&target);
6279 }
6280 }
6281
6282 all_image_infos_payload.PutHex64(ent.filepath_offset);
6283 all_image_infos_payload.PutRawBytes(ent.uuid, sizeof(ent.uuid));
6284 all_image_infos_payload.PutHex64(ent.load_address);
6285 all_image_infos_payload.PutHex64(ent.seg_addrs_offset);
6286 all_image_infos_payload.PutHex32(ent.segment_count);
6287
6288 if (executing_uuids.find(module_sp->GetUUID().GetAsString()) !=
6289 executing_uuids.end())
6290 all_image_infos_payload.PutHex32(1);
6291 else
6292 all_image_infos_payload.PutHex32(0);
6293
6294 current_segaddrs_offset += ent.segment_count * sizeof(segment_vmaddr);
6295 current_string_offset += module_sp->GetFileSpec().GetPath().size() + 1;
6296 }
6297
6298 // Now write the struct segment_vmaddr entries into the StringStream.
6299
6300 for (size_t i = 0; i < modules_segment_vmaddrs.size(); i++) {
6301 if (modules_segment_vmaddrs[i].size() == 0)
6302 continue;
6303 for (struct segment_vmaddr segvm : modules_segment_vmaddrs[i]) {
6304 all_image_infos_payload.PutRawBytes(segvm.segname, sizeof(segvm.segname));
6305 all_image_infos_payload.PutHex64(segvm.vmaddr);
6306 all_image_infos_payload.PutHex64(segvm.unused);
6307 }
6308 }
6309
6310 for (size_t i = 0; i < modules_count; i++) {
6311 ModuleSP module_sp = modules.GetModuleAtIndex(i);
6312 std::string filepath = module_sp->GetFileSpec().GetPath();
6313 all_image_infos_payload.PutRawBytes(filepath.data(), filepath.size() + 1);
6314 }
6315
6316 return final_file_offset;
6317}
6318
6319// Temp struct used to combine contiguous memory regions with
6320// identical permissions.
6326
6329 Status &error) {
6330 // The FileSpec and Process are already checked in PluginManager::SaveCore.
6331 assert(options.GetOutputFile().has_value());
6332 assert(process_sp);
6333 const FileSpec outfile = options.GetOutputFile().value();
6334
6335 // MachO defaults to dirty pages
6338
6339 Target &target = process_sp->GetTarget();
6340 const ArchSpec target_arch = target.GetArchitecture();
6341 const llvm::Triple &target_triple = target_arch.GetTriple();
6342 if (target_triple.getVendor() == llvm::Triple::Apple &&
6343 (target_triple.getOS() == llvm::Triple::MacOSX ||
6344 target_triple.getOS() == llvm::Triple::IOS ||
6345 target_triple.getOS() == llvm::Triple::WatchOS ||
6346 target_triple.getOS() == llvm::Triple::TvOS ||
6347 target_triple.getOS() == llvm::Triple::BridgeOS ||
6348 target_triple.getOS() == llvm::Triple::XROS)) {
6349 bool make_core = false;
6350 switch (target_arch.GetMachine()) {
6351 case llvm::Triple::aarch64:
6352 case llvm::Triple::aarch64_32:
6353 case llvm::Triple::arm:
6354 case llvm::Triple::thumb:
6355 case llvm::Triple::x86:
6356 case llvm::Triple::x86_64:
6357 make_core = true;
6358 break;
6359 default:
6361 "unsupported core architecture: %s", target_triple.str().c_str());
6362 break;
6363 }
6364
6365 if (make_core) {
6366 CoreFileMemoryRanges core_ranges;
6367 error = process_sp->CalculateCoreFileSaveRanges(options, core_ranges);
6368 if (error.Success()) {
6369 const uint32_t addr_byte_size = target_arch.GetAddressByteSize();
6370 const ByteOrder byte_order = target_arch.GetByteOrder();
6371 std::vector<llvm::MachO::segment_command_64> segment_load_commands;
6372 for (const auto &core_range_info : core_ranges) {
6373 // TODO: Refactor RangeDataVector to have a data iterator.
6374 const auto &core_range = core_range_info.data;
6375 uint32_t cmd_type = LC_SEGMENT_64;
6376 uint32_t segment_size = sizeof(llvm::MachO::segment_command_64);
6377 if (addr_byte_size == 4) {
6378 cmd_type = LC_SEGMENT;
6379 segment_size = sizeof(llvm::MachO::segment_command);
6380 }
6381 // Skip any ranges with no read/write/execute permissions and empty
6382 // ranges.
6383 if (core_range.lldb_permissions == 0 || core_range.range.size() == 0)
6384 continue;
6385 uint32_t vm_prot = 0;
6386 if (core_range.lldb_permissions & ePermissionsReadable)
6387 vm_prot |= VM_PROT_READ;
6388 if (core_range.lldb_permissions & ePermissionsWritable)
6389 vm_prot |= VM_PROT_WRITE;
6390 if (core_range.lldb_permissions & ePermissionsExecutable)
6391 vm_prot |= VM_PROT_EXECUTE;
6392 const addr_t vm_addr = core_range.range.start();
6393 const addr_t vm_size = core_range.range.size();
6394 llvm::MachO::segment_command_64 segment = {
6395 cmd_type, // uint32_t cmd;
6396 segment_size, // uint32_t cmdsize;
6397 {0}, // char segname[16];
6398 vm_addr, // uint64_t vmaddr; // uint32_t for 32-bit Mach-O
6399 vm_size, // uint64_t vmsize; // uint32_t for 32-bit Mach-O
6400 0, // uint64_t fileoff; // uint32_t for 32-bit Mach-O
6401 vm_size, // uint64_t filesize; // uint32_t for 32-bit Mach-O
6402 vm_prot, // uint32_t maxprot;
6403 vm_prot, // uint32_t initprot;
6404 0, // uint32_t nsects;
6405 0}; // uint32_t flags;
6406 segment_load_commands.push_back(segment);
6407 }
6408
6409 StreamString buffer(Stream::eBinary, byte_order);
6410
6411 llvm::MachO::mach_header_64 mach_header;
6412 mach_header.magic = addr_byte_size == 8 ? MH_MAGIC_64 : MH_MAGIC;
6413 mach_header.cputype = target_arch.GetMachOCPUType();
6414 mach_header.cpusubtype = target_arch.GetMachOCPUSubType();
6415 mach_header.filetype = MH_CORE;
6416 mach_header.ncmds = segment_load_commands.size();
6417 mach_header.flags = 0;
6418 mach_header.reserved = 0;
6419 ThreadList &thread_list = process_sp->GetThreadList();
6420 const uint32_t num_threads = thread_list.GetSize();
6421
6422 // Make an array of LC_THREAD data items. Each one contains the
6423 // contents of the LC_THREAD load command. The data doesn't contain
6424 // the load command + load command size, we will add the load command
6425 // and load command size as we emit the data.
6426 std::vector<StreamString> LC_THREAD_datas(num_threads);
6427 for (auto &LC_THREAD_data : LC_THREAD_datas) {
6428 LC_THREAD_data.GetFlags().Set(Stream::eBinary);
6429 LC_THREAD_data.SetByteOrder(byte_order);
6430 }
6431 for (uint32_t thread_idx = 0; thread_idx < num_threads; ++thread_idx) {
6432 ThreadSP thread_sp(thread_list.GetThreadAtIndex(thread_idx));
6433 if (thread_sp) {
6434 switch (mach_header.cputype) {
6435 case llvm::MachO::CPU_TYPE_ARM64:
6436 case llvm::MachO::CPU_TYPE_ARM64_32:
6438 thread_sp.get(), LC_THREAD_datas[thread_idx]);
6439 break;
6440
6441 case llvm::MachO::CPU_TYPE_ARM:
6443 thread_sp.get(), LC_THREAD_datas[thread_idx]);
6444 break;
6445
6446 case llvm::MachO::CPU_TYPE_X86_64:
6448 thread_sp.get(), LC_THREAD_datas[thread_idx]);
6449 break;
6450
6451 case llvm::MachO::CPU_TYPE_RISCV:
6453 thread_sp.get(), LC_THREAD_datas[thread_idx]);
6454 break;
6455 }
6456 }
6457 }
6458
6459 // The size of the load command is the size of the segments...
6460 if (addr_byte_size == 8) {
6461 mach_header.sizeofcmds = segment_load_commands.size() *
6462 sizeof(llvm::MachO::segment_command_64);
6463 } else {
6464 mach_header.sizeofcmds = segment_load_commands.size() *
6465 sizeof(llvm::MachO::segment_command);
6466 }
6467
6468 // and the size of all LC_THREAD load command
6469 for (const auto &LC_THREAD_data : LC_THREAD_datas) {
6470 ++mach_header.ncmds;
6471 mach_header.sizeofcmds += 8 + LC_THREAD_data.GetSize();
6472 }
6473
6474 // Bits will be set to indicate which bits are NOT used in
6475 // addressing in this process or 0 for unknown.
6476 uint64_t address_mask = process_sp->GetCodeAddressMask();
6477 if (address_mask != LLDB_INVALID_ADDRESS_MASK) {
6478 // LC_NOTE "addrable bits"
6479 mach_header.ncmds++;
6480 mach_header.sizeofcmds += sizeof(llvm::MachO::note_command);
6481 }
6482
6483 // LC_NOTE "process metadata"
6484 mach_header.ncmds++;
6485 mach_header.sizeofcmds += sizeof(llvm::MachO::note_command);
6486
6487 // LC_NOTE "all image infos"
6488 mach_header.ncmds++;
6489 mach_header.sizeofcmds += sizeof(llvm::MachO::note_command);
6490
6491 // Write the mach header
6492 buffer.PutHex32(mach_header.magic);
6493 buffer.PutHex32(mach_header.cputype);
6494 buffer.PutHex32(mach_header.cpusubtype);
6495 buffer.PutHex32(mach_header.filetype);
6496 buffer.PutHex32(mach_header.ncmds);
6497 buffer.PutHex32(mach_header.sizeofcmds);
6498 buffer.PutHex32(mach_header.flags);
6499 if (addr_byte_size == 8) {
6500 buffer.PutHex32(mach_header.reserved);
6501 }
6502
6503 // Skip the mach header and all load commands and align to the next
6504 // 0x1000 byte boundary
6505 addr_t file_offset = buffer.GetSize() + mach_header.sizeofcmds;
6506
6507 file_offset = llvm::alignTo(file_offset, 16);
6508 std::vector<std::unique_ptr<LCNoteEntry>> lc_notes;
6509
6510 // Add "addrable bits" LC_NOTE when an address mask is available
6511 if (address_mask != LLDB_INVALID_ADDRESS_MASK) {
6512 std::unique_ptr<LCNoteEntry> addrable_bits_lcnote_up(
6513 new LCNoteEntry(byte_order));
6514 addrable_bits_lcnote_up->name = "addrable bits";
6515 addrable_bits_lcnote_up->payload_file_offset = file_offset;
6516 int bits = std::bitset<64>(~address_mask).count();
6517 addrable_bits_lcnote_up->payload.PutHex32(4); // version
6518 addrable_bits_lcnote_up->payload.PutHex32(
6519 bits); // # of bits used for low addresses
6520 addrable_bits_lcnote_up->payload.PutHex32(
6521 bits); // # of bits used for high addresses
6522 addrable_bits_lcnote_up->payload.PutHex32(0); // reserved
6523
6524 file_offset += addrable_bits_lcnote_up->payload.GetSize();
6525
6526 lc_notes.push_back(std::move(addrable_bits_lcnote_up));
6527 }
6528
6529 // Add "process metadata" LC_NOTE
6530 std::unique_ptr<LCNoteEntry> thread_extrainfo_lcnote_up(
6531 new LCNoteEntry(byte_order));
6532 thread_extrainfo_lcnote_up->name = "process metadata";
6533 thread_extrainfo_lcnote_up->payload_file_offset = file_offset;
6534
6536 std::make_shared<StructuredData::Dictionary>());
6538 std::make_shared<StructuredData::Array>());
6539 for (const ThreadSP &thread_sp :
6540 process_sp->CalculateCoreFileThreadList(options)) {
6542 std::make_shared<StructuredData::Dictionary>());
6543 thread->AddIntegerItem("thread_id", thread_sp->GetID());
6544 threads->AddItem(thread);
6545 }
6546 dict->AddItem("threads", threads);
6547 StreamString strm;
6548 dict->Dump(strm, /* pretty */ false);
6549 thread_extrainfo_lcnote_up->payload.PutRawBytes(strm.GetData(),
6550 strm.GetSize());
6551
6552 file_offset += thread_extrainfo_lcnote_up->payload.GetSize();
6553 file_offset = llvm::alignTo(file_offset, 16);
6554 lc_notes.push_back(std::move(thread_extrainfo_lcnote_up));
6555
6556 // Add "all image infos" LC_NOTE
6557 std::unique_ptr<LCNoteEntry> all_image_infos_lcnote_up(
6558 new LCNoteEntry(byte_order));
6559 all_image_infos_lcnote_up->name = "all image infos";
6560 all_image_infos_lcnote_up->payload_file_offset = file_offset;
6561 file_offset = CreateAllImageInfosPayload(
6562 process_sp, file_offset, all_image_infos_lcnote_up->payload,
6563 options);
6564 lc_notes.push_back(std::move(all_image_infos_lcnote_up));
6565
6566 // Add LC_NOTE load commands
6567 for (auto &lcnote : lc_notes) {
6568 // Add the LC_NOTE load command to the file.
6569 buffer.PutHex32(LC_NOTE);
6570 buffer.PutHex32(sizeof(llvm::MachO::note_command));
6571 char namebuf[16];
6572 memset(namebuf, 0, sizeof(namebuf));
6573 // This is the uncommon case where strncpy is exactly
6574 // the right one, doesn't need to be nul terminated.
6575 // LC_NOTE name field is char[16] and is not guaranteed to be
6576 // nul-terminated.
6577 // coverity[buffer_size_warning]
6578 strncpy(namebuf, lcnote->name.c_str(), sizeof(namebuf));
6579 buffer.PutRawBytes(namebuf, sizeof(namebuf));
6580 buffer.PutHex64(lcnote->payload_file_offset);
6581 buffer.PutHex64(lcnote->payload.GetSize());
6582 }
6583
6584 // Align to 4096-byte page boundary for the LC_SEGMENTs.
6585 file_offset = llvm::alignTo(file_offset, 4096);
6586
6587 for (auto &segment : segment_load_commands) {
6588 segment.fileoff = file_offset;
6589 file_offset += segment.filesize;
6590 }
6591
6592 // Write out all of the LC_THREAD load commands
6593 for (const auto &LC_THREAD_data : LC_THREAD_datas) {
6594 const size_t LC_THREAD_data_size = LC_THREAD_data.GetSize();
6595 buffer.PutHex32(LC_THREAD);
6596 buffer.PutHex32(8 + LC_THREAD_data_size); // cmd + cmdsize + data
6597 buffer.Write(LC_THREAD_data.GetString().data(), LC_THREAD_data_size);
6598 }
6599
6600 // Write out all of the segment load commands
6601 for (const auto &segment : segment_load_commands) {
6602 buffer.PutHex32(segment.cmd);
6603 buffer.PutHex32(segment.cmdsize);
6604 buffer.PutRawBytes(segment.segname, sizeof(segment.segname));
6605 if (addr_byte_size == 8) {
6606 buffer.PutHex64(segment.vmaddr);
6607 buffer.PutHex64(segment.vmsize);
6608 buffer.PutHex64(segment.fileoff);
6609 buffer.PutHex64(segment.filesize);
6610 } else {
6611 buffer.PutHex32(static_cast<uint32_t>(segment.vmaddr));
6612 buffer.PutHex32(static_cast<uint32_t>(segment.vmsize));
6613 buffer.PutHex32(static_cast<uint32_t>(segment.fileoff));
6614 buffer.PutHex32(static_cast<uint32_t>(segment.filesize));
6615 }
6616 buffer.PutHex32(segment.maxprot);
6617 buffer.PutHex32(segment.initprot);
6618 buffer.PutHex32(segment.nsects);
6619 buffer.PutHex32(segment.flags);
6620 }
6621
6622 std::string core_file_path(outfile.GetPath());
6623 auto core_file = FileSystem::Instance().Open(
6626 if (!core_file) {
6627 error = Status::FromError(core_file.takeError());
6628 } else {
6629 // Read 1 page at a time
6630 uint8_t bytes[0x1000];
6631 // Write the mach header and load commands out to the core file
6632 size_t bytes_written = buffer.GetString().size();
6633 error =
6634 core_file.get()->Write(buffer.GetString().data(), bytes_written);
6635 if (error.Success()) {
6636
6637 for (auto &lcnote : lc_notes) {
6638 if (core_file.get()->SeekFromStart(lcnote->payload_file_offset) ==
6639 -1) {
6641 "Unable to seek to corefile pos "
6642 "to write '%s' LC_NOTE payload",
6643 lcnote->name.c_str());
6644 return false;
6645 }
6646 bytes_written = lcnote->payload.GetSize();
6647 error = core_file.get()->Write(lcnote->payload.GetData(),
6648 bytes_written);
6649 if (!error.Success())
6650 return false;
6651 }
6652
6653 // Now write the file data for all memory segments in the process
6654 for (const auto &segment : segment_load_commands) {
6655 if (core_file.get()->SeekFromStart(segment.fileoff) == -1) {
6657 "unable to seek to offset 0x%" PRIx64 " in '%s'",
6658 segment.fileoff, core_file_path.c_str());
6659 break;
6660 }
6661
6662 target.GetDebugger().GetAsyncOutputStream()->Printf(
6663 "Saving %" PRId64
6664 " bytes of data for memory region at 0x%" PRIx64 "\n",
6666 addr_t bytes_left = segment.vmsize;
6667 addr_t addr = segment.vmaddr;
6669 while (bytes_left > 0 && error.Success()) {
6670 const size_t bytes_to_read =
6671 bytes_left > sizeof(bytes) ? sizeof(bytes) : bytes_left;
6672
6673 // In a savecore setting, we don't really care about caching,
6674 // as the data is dumped and very likely never read again,
6675 // so we call ReadMemoryFromInferior to bypass it.
6676 const size_t bytes_read = process_sp->ReadMemoryFromInferior(
6677 addr, bytes, bytes_to_read, memory_read_error);
6678
6679 if (bytes_read == bytes_to_read) {
6680 size_t bytes_written = bytes_read;
6681 error = core_file.get()->Write(bytes, bytes_written);
6682 bytes_left -= bytes_read;
6683 addr += bytes_read;
6684 } else {
6685 // Some pages within regions are not readable, those should
6686 // be zero filled
6687 memset(bytes, 0, bytes_to_read);
6688 size_t bytes_written = bytes_to_read;
6689 error = core_file.get()->Write(bytes, bytes_written);
6690 bytes_left -= bytes_to_read;
6691 addr += bytes_to_read;
6692 }
6693 }
6694 }
6695 }
6696 }
6697 }
6698 }
6699 return true; // This is the right plug to handle saving core files for
6700 // this process
6701 }
6702 return false;
6703}
6704
6707 MachOCorefileAllImageInfos image_infos;
6710
6711 auto lc_notes = FindLC_NOTEByName("all image infos");
6712 for (auto lc_note : lc_notes) {
6713 offset_t payload_offset = std::get<0>(lc_note);
6714 // Read the struct all_image_infos_header.
6715 uint32_t version = m_data_nsp->GetU32(&payload_offset);
6716 if (version != 1) {
6717 return image_infos;
6718 }
6719 uint32_t imgcount = m_data_nsp->GetU32(&payload_offset);
6720 uint64_t entries_fileoff = m_data_nsp->GetU64(&payload_offset);
6721 // 'entries_size' is not used, nor is the 'unused' entry.
6722 // offset += 4; // uint32_t entries_size;
6723 // offset += 4; // uint32_t unused;
6724
6725 LLDB_LOGF(log, "LC_NOTE 'all image infos' found version %d with %d images",
6726 version, imgcount);
6727 payload_offset = entries_fileoff;
6728 for (uint32_t i = 0; i < imgcount; i++) {
6729 // Read the struct image_entry.
6730 offset_t filepath_offset = m_data_nsp->GetU64(&payload_offset);
6731 uuid_t uuid;
6732 memcpy(&uuid, m_data_nsp->GetData(&payload_offset, sizeof(uuid_t)),
6733 sizeof(uuid_t));
6734 uint64_t load_address = m_data_nsp->GetU64(&payload_offset);
6735 offset_t seg_addrs_offset = m_data_nsp->GetU64(&payload_offset);
6736 uint32_t segment_count = m_data_nsp->GetU32(&payload_offset);
6737 uint32_t currently_executing = m_data_nsp->GetU32(&payload_offset);
6738
6740 image_entry.filename =
6741 (const char *)m_data_nsp->GetCStr(&filepath_offset);
6742 image_entry.uuid = UUID(uuid, sizeof(uuid_t));
6743 image_entry.load_address = load_address;
6744 image_entry.currently_executing = currently_executing;
6745
6746 offset_t seg_vmaddrs_offset = seg_addrs_offset;
6747 for (uint32_t j = 0; j < segment_count; j++) {
6748 char segname[17];
6749 m_data_nsp->CopyData(seg_vmaddrs_offset, 16, segname);
6750 segname[16] = '\0';
6751 seg_vmaddrs_offset += 16;
6752 uint64_t vmaddr = m_data_nsp->GetU64(&seg_vmaddrs_offset);
6753 seg_vmaddrs_offset += 8; /* unused */
6754
6755 std::tuple<ConstString, addr_t> new_seg{ConstString(segname), vmaddr};
6756 image_entry.segment_load_addresses.push_back(new_seg);
6757 }
6758 LLDB_LOGF(log, " image entry: %s %s 0x%" PRIx64 " %s",
6759 image_entry.filename.c_str(),
6760 image_entry.uuid.GetAsString().c_str(),
6762 image_entry.currently_executing ? "currently executing"
6763 : "not currently executing");
6764 image_infos.all_image_infos.push_back(image_entry);
6765 }
6766 }
6767
6768 lc_notes = FindLC_NOTEByName("load binary");
6769 for (auto lc_note : lc_notes) {
6770 offset_t payload_offset = std::get<0>(lc_note);
6771 uint32_t version = m_data_nsp->GetU32(&payload_offset);
6772 if (version == 1) {
6773 uuid_t uuid;
6774 memcpy(&uuid, m_data_nsp->GetData(&payload_offset, sizeof(uuid_t)),
6775 sizeof(uuid_t));
6776 uint64_t load_address = m_data_nsp->GetU64(&payload_offset);
6777 uint64_t slide = m_data_nsp->GetU64(&payload_offset);
6778 std::string filename = m_data_nsp->GetCStr(&payload_offset);
6779
6781 image_entry.filename = filename;
6782 image_entry.uuid = UUID(uuid, sizeof(uuid_t));
6783 image_entry.load_address = load_address;
6784 image_entry.slide = slide;
6785 image_entry.currently_executing = true;
6786 image_infos.all_image_infos.push_back(image_entry);
6787 LLDB_LOGF(log,
6788 "LC_NOTE 'load binary' found, filename %s uuid %s load "
6789 "address 0x%" PRIx64 " slide 0x%" PRIx64,
6790 filename.c_str(),
6791 image_entry.uuid.IsValid()
6792 ? image_entry.uuid.GetAsString().c_str()
6793 : "00000000-0000-0000-0000-000000000000",
6794 load_address, slide);
6795 }
6796 }
6797
6798 return image_infos;
6799}
6800
6804 Status error;
6805
6806 bool found_platform_binary = false;
6807 ModuleList added_modules;
6808 for (MachOCorefileImageEntry &image : image_infos.all_image_infos) {
6809 ModuleSP module_sp, local_filesystem_module_sp;
6810
6811 // If this is a platform binary, it has been loaded (or registered with
6812 // the DynamicLoader to be loaded), we don't need to do any further
6813 // processing. We're not going to call ModulesDidLoad on this in this
6814 // method, so notify==true.
6815 if (process.GetTarget()
6816 .GetDebugger()
6819 true /* notify */)) {
6820 LLDB_LOGF(log,
6821 "ObjectFileMachO::%s binary at 0x%" PRIx64
6822 " is a platform binary, has been handled by a Platform plugin.",
6823 __FUNCTION__, image.load_address);
6824 continue;
6825 }
6826
6827 bool value_is_offset = image.load_address == LLDB_INVALID_ADDRESS;
6828 uint64_t value = value_is_offset ? image.slide : image.load_address;
6829 if (value_is_offset && value == LLDB_INVALID_ADDRESS) {
6830 // We have neither address nor slide; so we will find the binary
6831 // by UUID and load it at slide/offset 0.
6832 value = 0;
6833 }
6834
6835 // We have either a UUID, or we have a load address which
6836 // and can try to read load commands and find a UUID.
6837 if (image.uuid.IsValid() ||
6838 (!value_is_offset && value != LLDB_INVALID_ADDRESS)) {
6839 const bool set_load_address = image.segment_load_addresses.size() == 0;
6840 const bool notify = false;
6841 // Userland Darwin binaries will have segment load addresses via
6842 // the `all image infos` LC_NOTE.
6843 const bool allow_memory_image_last_resort =
6844 image.segment_load_addresses.size();
6846 &process, image.filename, image.uuid, value, value_is_offset,
6847 image.currently_executing, notify, set_load_address,
6848 allow_memory_image_last_resort);
6849 }
6850
6851 // We have a ModuleSP to load in the Target. Load it at the
6852 // correct address/slide and notify/load scripting resources.
6853 if (module_sp) {
6854 added_modules.Append(module_sp, false /* notify */);
6855
6856 // We have a list of segment load address
6857 if (image.segment_load_addresses.size() > 0) {
6858 if (log) {
6859 std::string uuidstr = image.uuid.GetAsString();
6860 log->Printf("ObjectFileMachO::LoadCoreFileImages adding binary '%s' "
6861 "UUID %s with section load addresses",
6862 module_sp->GetFileSpec().GetPath().c_str(),
6863 uuidstr.c_str());
6864 }
6865 for (auto name_vmaddr_tuple : image.segment_load_addresses) {
6866 SectionList *sectlist = module_sp->GetObjectFile()->GetSectionList();
6867 if (sectlist) {
6868 SectionSP sect_sp =
6869 sectlist->FindSectionByName(std::get<0>(name_vmaddr_tuple));
6870 if (sect_sp) {
6872 sect_sp, std::get<1>(name_vmaddr_tuple));
6873 }
6874 }
6875 }
6876 } else {
6877 if (log) {
6878 std::string uuidstr = image.uuid.GetAsString();
6879 log->Printf("ObjectFileMachO::LoadCoreFileImages adding binary '%s' "
6880 "UUID %s with %s 0x%" PRIx64,
6881 module_sp->GetFileSpec().GetPath().c_str(),
6882 uuidstr.c_str(),
6883 value_is_offset ? "slide" : "load address", value);
6884 }
6885 bool changed;
6886 module_sp->SetLoadAddress(process.GetTarget(), value, value_is_offset,
6887 changed);
6888 }
6889 }
6890 }
6891 if (added_modules.GetSize() > 0) {
6892 process.GetTarget().ModulesDidLoad(added_modules);
6893 process.Flush();
6894 return true;
6895 }
6896 // Return true if the only binary we found was the platform binary,
6897 // and it was loaded outside the scope of this method.
6898 if (found_platform_binary)
6899 return true;
6900
6901 // No binaries.
6902 return false;
6903}
unsigned char uuid_t[16]
static llvm::raw_ostream & error(Stream &strm)
void dyld_shared_cache_copy_uuid(dyld_shared_cache_t cache, uuid_t *uuid)
struct dyld_image_s * dyld_image_t
struct dyld_shared_cache_s * dyld_shared_cache_t
bool dyld_image_copy_uuid(dyld_image_t cache, uuid_t *uuid)
void dyld_shared_cache_for_each_image(dyld_shared_cache_t cache, void(^block)(dyld_image_t image))
static const char * memory_read_error
#define lldbassert(x)
Definition LLDBAssert.h:16
#define LLDB_LOG(log,...)
The LLDB_LOG* macros defined below are the way to emit log messages.
Definition Log.h:364
#define LLDB_LOGF(log,...)
Definition Log.h:378
static uint32_t MachHeaderSizeFromMagic(uint32_t magic)
static uint32_t GetSegmentPermissions(const llvm::MachO::segment_command_64 &seg_cmd)
static constexpr llvm::StringLiteral g_loader_path
static std::optional< struct nlist_64 > ParseNList(DataExtractor &nlist_data, lldb::offset_t &nlist_data_offset, size_t nlist_byte_size)
static constexpr llvm::StringLiteral g_executable_path
static void PrintRegisterValue(RegisterContext *reg_ctx, const char *name, const char *alt_name, size_t reg_byte_size, Stream &data)
static llvm::StringRef GetOSName(uint32_t cmd)
static llvm::VersionTuple FindMinimumVersionInfo(DataExtractor &data, lldb::offset_t offset, size_t ncmds)
unsigned int mach_task_self()
static lldb::SectionType GetSectionType(uint32_t flags, ConstString section_name)
#define MACHO_NLIST_ARM_SYMBOL_IS_THUMB
@ NonDebugSymbols
@ DebugSymbols
void * dyld_process_info
static uint32_t MachHeaderSizeFromMagic(uint32_t magic)
static offset_t CreateAllImageInfosPayload(const lldb::ProcessSP &process_sp, offset_t initial_file_offset, StreamString &all_image_infos_payload, lldb_private::SaveCoreOptions &options)
static bool TryParseV2ObjCMetadataSymbol(const char *&symbol_name, const char *&symbol_name_non_abi_mangled, SymbolType &type)
#define TRIE_SYMBOL_IS_THUMB
static bool ParseTrieEntries(DataExtractor &data, lldb::offset_t offset, const bool is_arm, addr_t text_seg_base_addr, std::vector< llvm::StringRef > &nameSlices, std::set< lldb::addr_t > &resolver_addresses, std::vector< TrieEntryWithOffset > &reexports, std::vector< TrieEntryWithOffset > &ext_symbols)
#define THUMB_ADDRESS_BIT_MASK
static SymbolType GetSymbolType(const char *&symbol_name, bool &demangled_is_synthesized, const SectionSP &text_section_sp, const SectionSP &data_section_sp, const SectionSP &data_dirty_section_sp, const SectionSP &data_const_section_sp, const SectionSP &symbol_section)
#define LLDB_PLUGIN_DEFINE(PluginName)
#define KERN_SUCCESS
Constants returned by various RegisterContextDarwin_*** functions.
#define LLDB_SCOPED_TIMERF(...)
Definition Timer.h:86
static llvm::StringRef GetName(XcodeSDK::Type type)
Definition XcodeSDK.cpp:21
std::vector< SectionInfo > m_section_infos
SectionSP GetSection(uint8_t n_sect, addr_t file_addr)
MachSymtabSectionInfo(SectionList *section_list)
bool SectionIsLoadable(const lldb_private::Section *section)
llvm::MachO::mach_header m_header
bool m_allow_assembly_emulation_unwind_plans
std::optional< llvm::VersionTuple > m_min_os_version
lldb_private::AddressableBits GetAddressableBits() override
Some object files may have the number of bits used for addressing embedded in them,...
uint32_t GetDependentModules(lldb_private::FileSpecList &files) override
Extract the dependent modules from an object file.
static lldb_private::ObjectFile * CreateMemoryInstance(const lldb::ModuleSP &module_sp, lldb::WritableDataBufferSP data_sp, const lldb::ProcessSP &process_sp, lldb::addr_t header_addr)
FileRangeArray m_thread_context_offsets
ObjectFile::Type CalculateType() override
The object file should be able to calculate its type by looking at its file header and possibly the s...
lldb_private::RangeVector< uint32_t, uint32_t, 8 > EncryptedFileRanges
static lldb_private::ConstString GetSegmentNameLINKEDIT()
static bool MagicBytesMatch(lldb::DataExtractorSP extractor_sp, lldb::addr_t offset, lldb::addr_t length)
std::vector< std::tuple< lldb::offset_t, lldb::offset_t > > FindLC_NOTEByName(std::string name)
void Dump(lldb_private::Stream *s) override
Dump a description of this object to a Stream.
bool AllowAssemblyEmulationUnwindPlans() override
Returns if the function bounds for symbols in this symbol file are likely accurate.
std::string GetIdentifierString() override
Some object files may have an identifier string embedded in them, e.g.
void ProcessSegmentCommand(const llvm::MachO::load_command &load_cmd, lldb::offset_t offset, uint32_t cmd_idx, SegmentParsingContext &context)
std::vector< llvm::MachO::section_64 > m_mach_sections
bool SetLoadAddress(lldb_private::Target &target, lldb::addr_t value, bool value_is_offset) override
Sets the load address for an entire module, assuming a rigid slide of sections, if possible in the im...
void GetProcessSharedCacheUUID(lldb_private::Process *, lldb::addr_t &base_addr, lldb_private::UUID &uuid)
Intended for same-host arm device debugging where lldb needs to detect libraries in the shared cache ...
bool IsGOTSection(const lldb_private::Section &section) const override
Returns true if the section is a global offset table section.
bool GetIsDynamicLinkEditor() override
Return true if this file is a dynamic link editor (dyld)
lldb::ByteOrder GetByteOrder() const override
Gets whether endian swapping should occur when extracting data from this object file.
bool ParseHeader() override
Attempts to parse the object header.
static lldb_private::ConstString GetSegmentNameDATA_DIRTY()
bool IsStripped() override
Detect if this object file has been stripped of local symbols.
static lldb_private::ConstString GetSegmentNameTEXT()
lldb_private::UUID GetUUID() override
Gets the UUID for this object file.
llvm::VersionTuple GetMinimumOSVersion() override
Get the minimum OS version this object file can run on.
static llvm::StringRef GetPluginDescriptionStatic()
static lldb_private::ConstString GetSegmentNameOBJC()
static llvm::StringRef GetPluginNameStatic()
lldb::RegisterContextSP GetThreadContextAtIndex(uint32_t idx, lldb_private::Thread &thread) override
lldb_private::FileSpecList m_reexported_dylibs
static void GetAllArchSpecs(const llvm::MachO::mach_header &header, const lldb_private::DataExtractor &data, lldb::offset_t lc_offset, lldb_private::ModuleSpec &base_spec, lldb_private::ModuleSpecList &all_specs)
Enumerate all ArchSpecs supported by this Mach-O file.
bool GetCorefileThreadExtraInfos(std::vector< lldb::tid_t > &tids) override
Get metadata about thread ids from the corefile.
bool IsDynamicLoader() const
static lldb_private::ConstString GetSegmentNameDWARF()
static void Terminate()
bool IsExecutable() const override
Tells whether this object file is capable of being the main executable for a process.
lldb_private::Address GetEntryPointAddress() override
Returns the address of the Entry Point in this object file - if the object file doesn't have an entry...
lldb_private::Address m_entry_point_address
static void Initialize()
bool LoadCoreFileImages(lldb_private::Process &process) override
Load binaries listed in a corefile.
bool CanTrustAddressRanges() override
Can we trust the address ranges accelerator associated with this object file to be complete.
void SanitizeSegmentCommand(llvm::MachO::segment_command_64 &seg_cmd, uint32_t cmd_idx)
static lldb_private::ObjectFile * CreateInstance(const lldb::ModuleSP &module_sp, lldb::DataExtractorSP extractor_sp, lldb::offset_t data_offset, const lldb_private::FileSpec *file, lldb::offset_t file_offset, lldb::offset_t length)
bool IsSharedCacheBinary() const
llvm::VersionTuple GetSDKVersion() override
Get the SDK OS version this object file was built with.
lldb_private::ArchSpec GetArchitecture() override
Get the ArchSpec for this object file.
static lldb_private::ConstString GetSegmentNameDATA()
lldb_private::Address GetBaseAddress() override
Returns base address of this object file.
size_t ParseSymtab()
lldb::addr_t m_text_address
uint32_t GetAddressByteSize() const override
Gets the address size in bytes for the current object file.
static lldb_private::ModuleSpecList GetModuleSpecifications(const lldb_private::FileSpec &file, lldb::DataExtractorSP &extractor_sp, lldb::offset_t file_offset, lldb::offset_t length)
llvm::MachO::dysymtab_command m_dysymtab
bool GetCorefileMainBinaryInfo(lldb::addr_t &value, bool &value_is_offset, lldb_private::UUID &uuid, ObjectFile::BinaryType &type) override
static bool SaveCore(const lldb::ProcessSP &process_sp, lldb_private::SaveCoreOptions &options, lldb_private::Status &error)
void ProcessDysymtabCommand(const llvm::MachO::load_command &load_cmd, lldb::offset_t offset)
MachOCorefileAllImageInfos GetCorefileAllImageInfos()
Get the list of binary images that were present in the process when the corefile was produced.
lldb::addr_t CalculateSectionLoadAddressForMemoryImage(lldb::addr_t mach_header_load_address, const lldb_private::Section *mach_header_section, const lldb_private::Section *section)
static lldb_private::ConstString GetSegmentNameLLVM_COV()
bool m_thread_context_offsets_valid
ObjectFile::Strata CalculateStrata() override
The object file should be able to calculate the strata of the object file.
void CreateSections(lldb_private::SectionList &unified_section_list) override
static lldb_private::ConstString GetSegmentNameDATA_CONST()
lldb_private::AddressClass GetAddressClass(lldb::addr_t file_addr) override
Get the address type given a file address in an object file.
lldb_private::StructuredData::ObjectSP GetCorefileProcessMetadata() override
Get process metadata from the corefile in a StructuredData dictionary.
std::optional< llvm::VersionTuple > m_sdk_versions
static lldb_private::ConstString GetSectionNameLLDBNoNlist()
ObjectFileMachO(const lldb::ModuleSP &module_sp, lldb::DataExtractorSP extractor_sp, lldb::offset_t data_offset, const lldb_private::FileSpec *file, lldb::offset_t offset, lldb::offset_t length)
void GetLLDBSharedCacheUUID(lldb::addr_t &base_addir, lldb_private::UUID &uuid)
Intended for same-host arm device debugging where lldb will read shared cache libraries out of its ow...
llvm::VersionTuple GetVersion() override
Get the object file version numbers.
EncryptedFileRanges GetEncryptedFileRanges()
uint32_t GetNumThreadContexts() override
static lldb_private::ConstString GetSectionNameEHFrame()
lldb::offset_t m_linkedit_original_offset
lldb_private::Section * GetMachHeaderSection()
int DoWriteDBG(lldb::tid_t tid, int flavor, const DBG &dbg) override
int DoWriteGPR(lldb::tid_t tid, int flavor, const GPR &gpr) override
int DoWriteFPU(lldb::tid_t tid, int flavor, const FPU &fpu) override
int DoReadGPR(lldb::tid_t tid, int flavor, GPR &gpr) override
int DoWriteEXC(lldb::tid_t tid, int flavor, const EXC &exc) override
RegisterContextDarwin_arm64_Mach(lldb_private::Thread &thread, const DataExtractor &data)
int DoReadEXC(lldb::tid_t tid, int flavor, EXC &exc) override
void SetRegisterDataFrom_LC_THREAD(const DataExtractor &data)
int DoReadDBG(lldb::tid_t tid, int flavor, DBG &dbg) override
int DoReadFPU(lldb::tid_t tid, int flavor, FPU &fpu) override
static bool Create_LC_THREAD(Thread *thread, Stream &data)
bool SetError(int flavor, uint32_t err_idx, int err)
RegisterContextDarwin_arm64(lldb_private::Thread &thread, uint32_t concrete_frame_idx)
RegisterContextDarwin_arm_Mach(lldb_private::Thread &thread, const DataExtractor &data)
int DoWriteDBG(lldb::tid_t tid, int flavor, const DBG &dbg) override
int DoReadFPU(lldb::tid_t tid, int flavor, FPU &fpu) override
int DoWriteFPU(lldb::tid_t tid, int flavor, const FPU &fpu) override
int DoReadDBG(lldb::tid_t tid, int flavor, DBG &dbg) override
int DoWriteEXC(lldb::tid_t tid, int flavor, const EXC &exc) override
int DoReadGPR(lldb::tid_t tid, int flavor, GPR &gpr) override
void SetRegisterDataFrom_LC_THREAD(const DataExtractor &data)
int DoWriteGPR(lldb::tid_t tid, int flavor, const GPR &gpr) override
int DoReadEXC(lldb::tid_t tid, int flavor, EXC &exc) override
static bool Create_LC_THREAD(Thread *thread, Stream &data)
RegisterContextDarwin_arm(lldb_private::Thread &thread, uint32_t concrete_frame_idx)
bool SetError(int flavor, uint32_t err_idx, int err)
int DoWriteEXC(lldb::tid_t tid, int flavor, const EXC &exc) override
int DoReadFPU(lldb::tid_t tid, int flavor, FPU &fpu) override
int DoWriteCSR(lldb::tid_t tid, int flavor, const CSR &csr) override
RegisterContextDarwin_riscv32_Mach(lldb_private::Thread &thread, const DataExtractor &data)
int DoReadGPR(lldb::tid_t tid, int flavor, GPR &gpr) override
int DoWriteFPU(lldb::tid_t tid, int flavor, const FPU &fpu) override
int DoWriteGPR(lldb::tid_t tid, int flavor, const GPR &gpr) override
int DoReadCSR(lldb::tid_t tid, int flavor, CSR &csr) override
static bool Create_LC_THREAD(Thread *thread, Stream &data)
void SetRegisterDataFrom_LC_THREAD(const DataExtractor &data)
int DoReadEXC(lldb::tid_t tid, int flavor, EXC &exc) override
RegisterContextDarwin_riscv32(lldb_private::Thread &thread, uint32_t concrete_frame_idx)
bool SetError(int flavor, uint32_t err_idx, int err)
RegisterContextDarwin_x86_64_Mach(lldb_private::Thread &thread, const DataExtractor &data)
int DoWriteFPU(lldb::tid_t tid, int flavor, const FPU &fpu) override
static bool Create_LC_THREAD(Thread *thread, Stream &data)
void SetRegisterDataFrom_LC_THREAD(const DataExtractor &data)
int DoWriteEXC(lldb::tid_t tid, int flavor, const EXC &exc) override
int DoReadFPU(lldb::tid_t tid, int flavor, FPU &fpu) override
int DoReadGPR(lldb::tid_t tid, int flavor, GPR &gpr) override
int DoWriteGPR(lldb::tid_t tid, int flavor, const GPR &gpr) override
int DoReadEXC(lldb::tid_t tid, int flavor, EXC &exc) override
RegisterContextDarwin_x86_64(lldb_private::Thread &thread, uint32_t concrete_frame_idx)
bool SetError(int flavor, uint32_t err_idx, int err)
A section + offset based address class.
Definition Address.h:62
lldb::addr_t GetLoadAddress(Target *target) const
Get the load address.
Definition Address.cpp:301
lldb::SectionSP GetSection() const
Get const accessor for the section.
Definition Address.h:432
lldb::addr_t GetFileAddress() const
Get the file address.
Definition Address.cpp:281
bool IsValid() const
Check if the object state is valid.
Definition Address.h:355
A class which holds the metadata from a remote stub/corefile note about how many bits are used for ad...
void SetAddressableBits(uint32_t addressing_bits)
When a single value is available for the number of bits.
An architecture specification class.
Definition ArchSpec.h:32
uint32_t GetAddressByteSize() const
Returns the size in bytes of an address of the current architecture.
Definition ArchSpec.cpp:681
bool IsValid() const
Tests if this ArchSpec is valid.
Definition ArchSpec.h:367
llvm::Triple & GetTriple()
Architecture triple accessor.
Definition ArchSpec.h:457
bool IsAlwaysThumbInstructions() const
Detect whether this architecture uses thumb code exclusively.
bool SetArchitecture(ArchitectureType arch_type, uint32_t cpu, uint32_t sub, uint32_t os=0)
Change the architecture object type, CPU type and OS type.
Definition ArchSpec.cpp:843
uint32_t GetMachOCPUSubType() const
Definition ArchSpec.cpp:661
bool IsCompatibleMatch(const ArchSpec &rhs) const
Shorthand for IsMatch(rhs, CompatibleMatch).
Definition ArchSpec.h:509
uint32_t GetMachOCPUType() const
Definition ArchSpec.cpp:649
lldb::ByteOrder GetByteOrder() const
Returns the byte order for the architecture specification.
Definition ArchSpec.cpp:730
llvm::Triple::ArchType GetMachine() const
Returns a machine family for the current architecture.
Definition ArchSpec.cpp:673
A uniqued constant string class.
Definition ConstString.h:40
std::string GetString() const
Get the string value as a std::string.
void SetCStringWithLength(const char *cstr, size_t cstr_len)
Set the C string value with length.
void SetCString(const char *cstr)
Set the C string value.
void SetTrimmedCStringWithLength(const char *cstr, size_t fixed_cstr_len)
Set the C string value with the minimum length between fixed_cstr_len and the actual length of the C ...
llvm::StringRef GetStringRef() const
Get the string value as a llvm::StringRef.
void Clear()
Clear this object's state.
const char * GetCString() const
Get the string value as a C string.
const char * AsCString(const char *value_if_empty) const
Get the string value as a C string.
void GetFunctionAddressAndSizeVector(FunctionAddressAndSizeVector &function_info)
RangeVector< lldb::addr_t, uint32_t > FunctionAddressAndSizeVector
An data extractor class.
uint64_t GetULEB128(lldb::offset_t *offset_ptr) const
Extract a unsigned LEB128 value from *offset_ptr.
virtual uint32_t GetU32_unchecked(lldb::offset_t *offset_ptr) const
const char * GetCStr(lldb::offset_t *offset_ptr) const
Extract a C string from *offset_ptr.
uint64_t GetU64(lldb::offset_t *offset_ptr) const
Extract a uint64_t value from *offset_ptr.
bool ValidOffsetForDataOfSize(lldb::offset_t offset, lldb::offset_t length) const
Test the availability of length bytes of data from offset.
virtual const uint8_t * PeekData(lldb::offset_t offset, lldb::offset_t length) const
Peek at a bytes at offset.
virtual uint64_t GetByteSize() const
Get the number of bytes contained in this object.
uint64_t GetAddress_unchecked(lldb::offset_t *offset_ptr) const
uint32_t GetU32(lldb::offset_t *offset_ptr) const
Extract a uint32_t value from *offset_ptr.
bool ValidOffset(lldb::offset_t offset) const
Test the validity of offset.
virtual uint8_t GetU8_unchecked(lldb::offset_t *offset_ptr) const
lldb::ByteOrder GetByteOrder() const
Get the current byte order value.
virtual uint16_t GetU16_unchecked(lldb::offset_t *offset_ptr) const
uint8_t GetU8(lldb::offset_t *offset_ptr) const
Extract a uint8_t value from *offset_ptr.
size_t ExtractBytes(lldb::offset_t offset, lldb::offset_t length, lldb::ByteOrder dst_byte_order, void *dst) const
Extract an arbitrary number of bytes in the specified byte order.
static void ReportError(std::string message, std::optional< lldb::user_id_t > debugger_id=std::nullopt, std::once_flag *once=nullptr)
Report error events.
PlatformList & GetPlatformList()
Definition Debugger.h:226
lldb::StreamUP GetAsyncOutputStream()
A plug-in interface definition class for dynamic loaders.
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, bool set_address_in_target, bool allow_memory_image_last_resort)
Find/load a binary into lldb given a UUID and the address where it is loaded in memory,...
virtual bool GetSharedCacheInformation(lldb::addr_t &base_address, UUID &uuid, LazyBool &using_shared_cache, LazyBool &private_shared_cache, lldb_private::FileSpec &shared_cache_path, std::optional< uint64_t > &size)
Get information about the shared cache for a process, if possible.
A file collection class.
const FileSpec & GetFileSpecAtIndex(size_t idx) const
Get file at index.
void Append(const FileSpec &file)
Append a FileSpec object to the list.
size_t GetSize() const
Get the number of files in the file list.
bool AppendIfUnique(const FileSpec &file)
Append a FileSpec object if unique.
A file utility class.
Definition FileSpec.h:57
void SetFile(llvm::StringRef path, Style style)
Change the file specified with a new path.
Definition FileSpec.cpp:174
FileSpec CopyByAppendingPathComponent(llvm::StringRef component) const
Definition FileSpec.cpp:425
const ConstString & GetFilename() const
Filename string const get accessor.
Definition FileSpec.h:250
void ClearDirectory()
Clear the directory in this object.
Definition FileSpec.cpp:367
const ConstString & GetDirectory() const
Directory string const get accessor.
Definition FileSpec.h:234
size_t GetPath(char *path, size_t max_path_length, bool denormalize=true) const
Extract the full path to the file.
Definition FileSpec.cpp:374
FileSpec CopyByRemovingLastPathComponent() const
Definition FileSpec.cpp:431
int Open(const char *path, int flags, int mode=0600)
Wraps open in a platform-independent way.
static FileSystem & Instance()
void Resolve(llvm::SmallVectorImpl< char > &path, bool force_make_absolute=false)
Resolve path to make it canonical.
@ eOpenOptionWriteOnly
Definition File.h:52
@ eOpenOptionCanCreate
Definition File.h:56
@ eOpenOptionTruncate
Definition File.h:57
A class to manage flags.
Definition Flags.h:22
bool Test(ValueType bit) const
Test a single flag bit.
Definition Flags.h:96
void void Printf(const char *format,...) __attribute__((format(printf
Prefer using LLDB_LOGF whenever possible.
Definition Log.cpp:156
A class that handles mangled names.
Definition Mangled.h:34
void SetDemangledName(ConstString name)
Definition Mangled.h:138
ConstString GetDemangledName() const
Demangled name get accessor.
Definition Mangled.cpp:284
void SetMangledName(ConstString name)
Definition Mangled.h:143
void SetValue(ConstString name)
Set the string value in this object.
Definition Mangled.cpp:124
ConstString GetName(NamePreference preference=ePreferDemangled) const
Best name get accessor.
Definition Mangled.cpp:369
lldb::ModuleSP GetModule() const
Get const accessor for the module pointer.
A collection class for Module objects.
Definition ModuleList.h:125
void Clear()
Clear the object's state.
bool AppendIfNeeded(const lldb::ModuleSP &new_module, bool notify=true)
Append a module to the module list, if it is not already there.
lldb::ModuleSP GetModuleAtIndex(size_t idx) const
Get the module shared pointer for the module at index idx.
void Append(const lldb::ModuleSP &module_sp, bool notify=true)
Append a module to the module list.
size_t GetSize() const
Gets the size of the module list.
void Append(const ModuleSpec &spec)
Definition ModuleSpec.h:341
ModuleSpec & GetModuleSpecRefAtIndex(size_t i)
Definition ModuleSpec.h:354
void SetObjectSize(uint64_t object_size)
Definition ModuleSpec.h:119
FileSpec & GetFileSpec()
Definition ModuleSpec.h:57
ArchSpec & GetArchitecture()
Definition ModuleSpec.h:93
void SetObjectOffset(uint64_t object_offset)
Definition ModuleSpec.h:113
A plug-in interface definition class for object file parsers.
Definition ObjectFile.h:46
std::unique_ptr< lldb_private::SectionList > m_sections_up
Definition ObjectFile.h:774
static lldb::DataBufferSP MapFileData(const FileSpec &file, uint64_t Size, uint64_t Offset)
std::unique_ptr< lldb_private::Symtab > m_symtab_up
Definition ObjectFile.h:775
const lldb::addr_t m_memory_addr
Set if the object file only exists in memory.
Definition ObjectFile.h:773
static lldb::SectionType GetDWARFSectionTypeFromName(llvm::StringRef name)
Parses the section type from a section name for DWARF sections.
Symtab * GetSymtab(bool can_create=true)
Gets the symbol table for the currently selected architecture (and object for archives).
DataExtractorNSP m_data_nsp
The data for this object file so things can be parsed lazily.
Definition ObjectFile.h:767
static lldb::WritableDataBufferSP ReadMemory(const lldb::ProcessSP &process_sp, lldb::addr_t addr, size_t byte_size)
@ eTypeExecutable
A normal executable.
Definition ObjectFile.h:55
@ eTypeDebugInfo
An object file that contains only debug information.
Definition ObjectFile.h:57
@ eTypeStubLibrary
A library that can be linked against but not used for execution.
Definition ObjectFile.h:65
@ eTypeObjectFile
An intermediate object file.
Definition ObjectFile.h:61
@ eTypeDynamicLinker
The platform's dynamic linker executable.
Definition ObjectFile.h:59
@ eTypeCoreFile
A core file that has a checkpoint of a program's execution state.
Definition ObjectFile.h:53
@ eTypeSharedLibrary
A shared library that can be used during execution.
Definition ObjectFile.h:63
lldb::addr_t m_file_offset
The offset in bytes into the file, or the address in memory.
Definition ObjectFile.h:762
static lldb::SymbolType GetSymbolTypeFromName(llvm::StringRef name, lldb::SymbolType symbol_type_hint=lldb::eSymbolTypeUndefined)
bool SetModulesArchitecture(const ArchSpec &new_arch)
Sets the architecture for a module.
virtual FileSpec & GetFileSpec()
Get accessor to the object file specification.
Definition ObjectFile.h:280
virtual SectionList * GetSectionList(bool update_module_section_list=true)
Gets the section list for the currently selected architecture (and object for archives).
ObjectFile(const lldb::ModuleSP &module_sp, const FileSpec *file_spec_ptr, lldb::offset_t file_offset, lldb::offset_t length, lldb::DataExtractorSP extractor_sp, lldb::offset_t data_offset)
Construct with a parent module, offset, and header data.
bool IsInMemory() const
Returns true if the object file exists only in memory.
Definition ObjectFile.h:685
lldb::ProcessWP m_process_wp
Definition ObjectFile.h:771
lldb::addr_t m_length
The length of this object file if it is known (can be zero if length is unknown or can't be determine...
Definition ObjectFile.h:764
BinaryType
If we have a corefile binary hint, this enum specifies the binary type which we can use to select the...
Definition ObjectFile.h:83
@ eBinaryTypeKernel
kernel binary
Definition ObjectFile.h:87
@ eBinaryTypeUser
user process binary, dyld addr
Definition ObjectFile.h:89
@ eBinaryTypeUserAllImageInfos
user process binary, dyld_all_image_infos addr
Definition ObjectFile.h:91
@ eBinaryTypeStandalone
standalone binary / firmware
Definition ObjectFile.h:93
virtual lldb_private::Address GetBaseAddress()
Returns base address of this object file.
Definition ObjectFile.h:462
bool LoadPlatformBinaryAndSetup(Process *process, lldb::addr_t addr, bool notify)
Detect a binary in memory that will determine which Platform and DynamicLoader should be used in this...
static bool RegisterPlugin(llvm::StringRef name, llvm::StringRef description, ABICreateInstance create_callback)
static bool UnregisterPlugin(ABICreateInstance create_callback)
A plug-in interface definition class for debugging a process.
Definition Process.h:355
void Flush()
Flush all data in the process.
Definition Process.cpp:6092
virtual DynamicLoader * GetDynamicLoader()
Get the dynamic loader plug-in for this process.
Definition Process.cpp:2962
Target & GetTarget()
Get the target object pointer for this module.
Definition Process.h:1251
A Progress indicator helper class.
Definition Progress.h:60
const Entry * FindEntryThatContains(B addr) const
Definition RangeMap.h:338
const Entry * GetEntryAtIndex(size_t i) const
Definition RangeMap.h:297
void Append(const Entry &entry)
Definition RangeMap.h:179
size_t GetSize() const
Definition RangeMap.h:295
const void * GetBytes() const
const std::optional< lldb_private::FileSpec > GetOutputFile() const
lldb::SaveCoreStyle GetStyle() const
void SetStyle(lldb::SaveCoreStyle style)
lldb::SectionSP FindSectionByName(ConstString section_dstr) const
Definition Section.cpp:556
size_t GetNumSections(uint32_t depth) const
Definition Section.cpp:538
size_t GetSize() const
Definition Section.h:77
size_t AddSection(const lldb::SectionSP &section_sp)
Definition Section.cpp:480
void Dump(llvm::raw_ostream &s, unsigned indent, Target *target, bool show_header, uint32_t depth) const
Definition Section.cpp:642
lldb::SectionSP GetSectionAtIndex(size_t idx) const
Definition Section.cpp:549
bool IsThreadSpecific() const
Definition Section.h:221
ConstString GetName() const
Definition Section.h:211
lldb::SectionSP GetParent() const
Definition Section.h:219
lldb::offset_t GetFileOffset() const
Definition Section.h:181
lldb::addr_t GetFileAddress() const
Definition Section.cpp:192
ObjectFile * GetObjectFile()
Definition Section.h:231
An error handling class.
Definition Status.h:118
static Status FromErrorStringWithFormat(const char *format,...) __attribute__((format(printf
Definition Status.cpp:106
static Status FromError(llvm::Error error)
Avoid using this in new code. Migrate APIs to llvm::Expected instead.
Definition Status.cpp:136
const char * GetData() const
llvm::StringRef GetString() const
A stream class that can stream formatted output to a file.
Definition Stream.h:28
size_t Write(const void *src, size_t src_len)
Output character bytes to the stream.
Definition Stream.h:110
llvm::raw_ostream & AsRawOstream()
Returns a raw_ostream that forwards the data to this Stream object.
Definition Stream.h:402
size_t Indent(llvm::StringRef s="")
Indent the current line in the stream.
Definition Stream.cpp:155
size_t PutHex64(uint64_t uvalue, lldb::ByteOrder byte_order=lldb::eByteOrderInvalid)
Definition Stream.cpp:305
size_t Printf(const char *format,...) __attribute__((format(printf
Output printf formatted output to the stream.
Definition Stream.cpp:132
size_t PutCString(llvm::StringRef cstr)
Output a C string to the stream.
Definition Stream.cpp:63
@ eBinary
Get and put data as binary instead of as the default string mode.
Definition Stream.h:32
size_t PutHex32(uint32_t uvalue, lldb::ByteOrder byte_order=lldb::eByteOrderInvalid)
Definition Stream.cpp:289
size_t PutRawBytes(const void *s, size_t src_len, lldb::ByteOrder src_byte_order=lldb::eByteOrderInvalid, lldb::ByteOrder dst_byte_order=lldb::eByteOrderInvalid)
Definition Stream.cpp:362
unsigned GetIndentLevel() const
Get the current indentation level.
Definition Stream.cpp:191
std::optional< Dictionary * > GetItemAtIndexAsDictionary(size_t idx) const
Retrieves the element at index idx from a StructuredData::Array if it is a Dictionary.
bool GetValueForKeyAsArray(llvm::StringRef key, Array *&result) const
void Dump(lldb_private::Stream &s, bool pretty_print=true) const
std::shared_ptr< Dictionary > DictionarySP
std::shared_ptr< Object > ObjectSP
static ObjectSP ParseJSON(llvm::StringRef json_text)
std::shared_ptr< Array > ArraySP
Defines a list of symbol context objects.
bool GetContextAtIndex(size_t idx, SymbolContext &sc) const
Get accessor for a symbol context at index idx.
uint32_t GetSize() const
Get accessor for a symbol context list size.
Defines a symbol context baton that can be handed other debug core functions.
Symbol * symbol
The Symbol for a given query.
bool ValueIsAddress() const
Definition Symbol.cpp:165
void SetReExportedSymbolName(ConstString name)
Definition Symbol.cpp:199
void SetType(lldb::SymbolType type)
Definition Symbol.h:171
void SetSizeIsSibling(bool b)
Definition Symbol.h:220
Mangled & GetMangled()
Definition Symbol.h:147
Address & GetAddressRef()
Definition Symbol.h:73
void SetIsWeak(bool b)
Definition Symbol.h:207
uint32_t GetFlags() const
Definition Symbol.h:175
bool SetReExportedSymbolSharedLibrary(const FileSpec &fspec)
Definition Symbol.cpp:206
lldb::addr_t GetByteSize() const
Definition Symbol.cpp:431
lldb::SymbolType GetType() const
Definition Symbol.h:169
void SetFlags(uint32_t flags)
Definition Symbol.h:177
Address GetAddress() const
Definition Symbol.h:89
void SetIsSynthetic(bool b)
Definition Symbol.h:187
void SetByteSize(lldb::addr_t size)
Definition Symbol.h:213
void SetDemangledNameIsSynthesized(bool b)
Definition Symbol.h:237
void SetExternal(bool b)
Definition Symbol.h:199
void SetDebug(bool b)
Definition Symbol.h:195
void SetID(uint32_t uid)
Definition Symbol.h:145
Symbol * FindSymbolByID(lldb::user_id_t uid) const
Definition Symtab.cpp:216
Symbol * SymbolAtIndex(size_t idx)
Definition Symtab.cpp:225
Symbol * FindFirstSymbolWithNameAndType(ConstString name, lldb::SymbolType symbol_type, Debug symbol_debug_type, Visibility symbol_visibility)
Definition Symtab.cpp:860
Symbol * Resize(size_t count)
Definition Symtab.cpp:54
Symbol * FindSymbolContainingFileAddress(lldb::addr_t file_addr)
Definition Symtab.cpp:1030
size_t GetNumSymbols() const
Definition Symtab.cpp:74
MemoryModuleLoadLevel GetMemoryModuleLoadLevel() const
Definition Target.cpp:5143
void ModulesDidLoad(ModuleList &module_list)
This call may preload module symbols, and may do so in parallel depending on the following target set...
Definition Target.cpp:1841
Debugger & GetDebugger() const
Definition Target.h:1240
const ModuleList & GetImages() const
Get accessor for the images for this process.
Definition Target.h:1157
const ArchSpec & GetArchitecture() const
Definition Target.h:1199
bool SetSectionLoadAddress(const lldb::SectionSP &section, lldb::addr_t load_addr, bool warn_multiple=false)
Definition Target.cpp:3330
uint32_t GetSize(bool can_update=true)
lldb::ThreadSP GetThreadAtIndex(uint32_t idx, bool can_update=true)
Represents UUID's of various sizes.
Definition UUID.h:27
void Clear()
Definition UUID.h:62
std::string GetAsString(llvm::StringRef separator="-") const
Definition UUID.cpp:54
bool IsValid() const
Definition UUID.h:69
#define UINT64_MAX
#define LLDB_INVALID_ADDRESS_MASK
Address Mask Bits not used for addressing are set to 1 in the mask; all mask bits set is an invalid v...
#define LLDB_INVALID_THREAD_ID
#define LLDB_INVALID_ADDRESS
#define UINT32_MAX
lldb::ByteOrder InlHostByteOrder()
Definition Endian.h:25
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:327
static uint32_t bits(const uint32_t val, const uint32_t msbit, const uint32_t lsbit)
Definition ARMUtils.h:265
std::shared_ptr< lldb_private::StackFrame > StackFrameSP
std::shared_ptr< lldb_private::Thread > ThreadSP
uint64_t offset_t
Definition lldb-types.h:85
std::shared_ptr< lldb_private::Process > ProcessSP
SymbolType
Symbol types.
@ eSymbolTypeUndefined
@ eSymbolTypeVariableType
@ eSymbolTypeObjCMetaClass
@ eSymbolTypeReExported
@ eSymbolTypeObjCClass
@ eSymbolTypeObjectFile
@ eSymbolTypeTrampoline
@ eSymbolTypeResolver
@ eSymbolTypeSourceFile
@ eSymbolTypeException
@ eSymbolTypeVariable
@ eSymbolTypeAbsolute
@ eSymbolTypeAdditional
When symbols take more than one entry, the extra entries get this type.
@ eSymbolTypeInstrumentation
@ eSymbolTypeHeaderFile
@ eSymbolTypeCommonBlock
@ eSymbolTypeCompiler
@ eSymbolTypeLineHeader
@ eSymbolTypeObjCIVar
@ eSymbolTypeLineEntry
@ eSymbolTypeScopeBegin
@ eSymbolTypeScopeEnd
ByteOrder
Byte ordering definitions.
uint64_t user_id_t
Definition lldb-types.h:82
std::shared_ptr< lldb_private::DataBuffer > DataBufferSP
std::shared_ptr< lldb_private::Section > SectionSP
std::shared_ptr< lldb_private::WritableDataBuffer > WritableDataBufferSP
uint64_t addr_t
Definition lldb-types.h:80
@ eSectionTypeDWARFDebugStrOffsets
@ eSectionTypeELFDynamicSymbols
Elf SHT_DYNSYM section.
@ eSectionTypeInvalid
@ eSectionTypeDWARFDebugPubNames
@ eSectionTypeDataObjCCFStrings
Objective-C const CFString/NSString objects.
@ eSectionTypeZeroFill
@ eSectionTypeDWARFDebugLocDwo
@ eSectionTypeDWARFDebugFrame
@ eSectionTypeARMextab
@ eSectionTypeContainer
The section contains child sections.
@ eSectionTypeDWARFDebugLocLists
DWARF v5 .debug_loclists.
@ eSectionTypeDWARFDebugTypes
DWARF .debug_types section.
@ eSectionTypeDataSymbolAddress
Address of a symbol in the symbol table.
@ eSectionTypeELFDynamicLinkInfo
Elf SHT_DYNAMIC section.
@ eSectionTypeDWARFDebugMacInfo
@ eSectionTypeAbsoluteAddress
Dummy section for symbols with absolute address.
@ eSectionTypeCompactUnwind
compact unwind section in Mach-O, __TEXT,__unwind_info
@ eSectionTypeELFRelocationEntries
Elf SHT_REL or SHT_REL section.
@ eSectionTypeDWARFAppleNamespaces
@ eSectionTypeLLDBFormatters
@ eSectionTypeDWARFDebugNames
DWARF v5 .debug_names.
@ eSectionTypeDWARFDebugRngLists
DWARF v5 .debug_rnglists.
@ eSectionTypeEHFrame
@ eSectionTypeDWARFDebugStrOffsetsDwo
@ eSectionTypeDWARFDebugMacro
@ eSectionTypeDWARFAppleTypes
@ eSectionTypeDWARFDebugInfo
@ eSectionTypeDWARFDebugTypesDwo
@ eSectionTypeDWARFDebugRanges
@ eSectionTypeDWARFDebugRngListsDwo
@ eSectionTypeLLDBTypeSummaries
@ eSectionTypeGoSymtab
@ eSectionTypeARMexidx
@ eSectionTypeDWARFDebugLine
@ eSectionTypeDWARFDebugPubTypes
@ eSectionTypeDataObjCMessageRefs
Pointer to function pointer + selector.
@ eSectionTypeDWARFDebugTuIndex
@ eSectionTypeDWARFDebugStr
@ eSectionTypeDWARFDebugLineStr
DWARF v5 .debug_line_str.
@ eSectionTypeDWARFDebugLoc
@ eSectionTypeDWARFAppleNames
@ eSectionTypeDataCStringPointers
Pointers to C string data.
@ eSectionTypeDWARFAppleObjC
@ eSectionTypeSwiftModules
@ eSectionTypeDWARFDebugCuIndex
@ eSectionTypeDWARFDebugAranges
@ eSectionTypeDWARFDebugAbbrevDwo
@ eSectionTypeDWARFGNUDebugAltLink
@ eSectionTypeDWARFDebugStrDwo
@ eSectionTypeDWARFDebugAbbrev
@ eSectionTypeDataPointers
@ eSectionTypeDWARFDebugLocListsDwo
@ eSectionTypeDWARFDebugInfoDwo
@ eSectionTypeDWARFDebugAddr
@ eSectionTypeWasmName
@ eSectionTypeDataCString
Inlined C string data.
@ eSectionTypeELFSymbolTable
Elf SHT_SYMTAB section.
std::shared_ptr< lldb_private::RegisterContext > RegisterContextSP
std::shared_ptr< lldb_private::DataExtractor > DataExtractorSP
uint64_t tid_t
Definition lldb-types.h:84
std::shared_ptr< lldb_private::Module > ModuleSP
The LC_DYSYMTAB's dysymtab_command has 32-bit file offsets that we will use as virtual address offset...
std::vector< MachOCorefileImageEntry > all_image_infos
A corefile may include metadata about all of the binaries that were present in the process when the c...
std::vector< std::tuple< lldb_private::ConstString, lldb::addr_t > > segment_load_addresses
lldb_private::SectionList & UnifiedList
SegmentParsingContext(EncryptedFileRanges EncryptedRanges, lldb_private::SectionList &UnifiedList)
TrieEntryWithOffset(lldb::offset_t offset)
void Dump(uint32_t idx) const
bool operator<(const TrieEntryWithOffset &other) const
void Dump() const
ConstString name
ConstString import_name
uint32_t segment_count
uint64_t load_address
uint64_t filepath_offset
image_entry(const image_entry &rhs)
uint32_t unused
uint64_t seg_addrs_offset
uuid_t uuid
image_entry()
BaseType GetRangeBase() const
Definition RangeMap.h:45
SizeType GetByteSize() const
Definition RangeMap.h:87
void SetRangeBase(BaseType b)
Set the start value for the range, and keep the same size.
Definition RangeMap.h:48
void SetByteSize(SizeType s)
Definition RangeMap.h:89
Every register is described in detail including its name, alternate name (optional),...
uint32_t byte_size
Size in bytes of the register.
segment_vmaddr(const segment_vmaddr &rhs)
size_t vmsize
uint64_t vmaddr