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::string &prefix,
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 if (prefix.size() > 1) {
2047 // Skip the leading '_'
2048 e.entry.name.SetString(llvm::StringRef(prefix).drop_front());
2049 }
2050 if (import_name) {
2051 // Skip the leading '_'
2052 e.entry.import_name.SetCString(import_name + 1);
2053 }
2054 if (Flags(e.entry.flags).Test(EXPORT_SYMBOL_FLAGS_REEXPORT)) {
2055 reexports.push_back(e);
2056 } else {
2057 if (is_arm && (e.entry.address & 1)) {
2060 }
2061 ext_symbols.push_back(e);
2062 }
2063 }
2064 }
2065
2066 const uint8_t childrenCount = data.GetU8(&children_offset);
2067 for (uint8_t i = 0; i < childrenCount; ++i) {
2068 const char *cstr = data.GetCStr(&children_offset);
2069 if (!cstr)
2070 return false; // Corrupt data
2071 const size_t prevSize = prefix.size();
2072 prefix.append(cstr);
2073 lldb::offset_t childNodeOffset = data.GetULEB128(&children_offset);
2074 if (childNodeOffset) {
2075 if (!ParseTrieEntries(data, childNodeOffset, is_arm, text_seg_base_addr,
2076 prefix, resolver_addresses, reexports,
2077 ext_symbols)) {
2078 return false;
2079 }
2080 }
2081 prefix.resize(prevSize);
2082 }
2083 return true;
2084}
2085
2086static bool
2087TryParseV2ObjCMetadataSymbol(const char *&symbol_name,
2088 const char *&symbol_name_non_abi_mangled,
2089 SymbolType &type) {
2090 static constexpr llvm::StringLiteral g_objc_v2_prefix_class("_OBJC_CLASS_$_");
2091 static constexpr llvm::StringLiteral g_objc_v2_prefix_metaclass(
2092 "_OBJC_METACLASS_$_");
2093 static constexpr llvm::StringLiteral g_objc_v2_prefix_ivar("_OBJC_IVAR_$_");
2094
2095 llvm::StringRef symbol_name_ref(symbol_name);
2096 if (symbol_name_ref.empty())
2097 return false;
2098
2099 if (symbol_name_ref.starts_with(g_objc_v2_prefix_class)) {
2100 symbol_name_non_abi_mangled = symbol_name + 1;
2101 symbol_name = symbol_name + g_objc_v2_prefix_class.size();
2102 type = eSymbolTypeObjCClass;
2103 return true;
2104 }
2105
2106 if (symbol_name_ref.starts_with(g_objc_v2_prefix_metaclass)) {
2107 symbol_name_non_abi_mangled = symbol_name + 1;
2108 symbol_name = symbol_name + g_objc_v2_prefix_metaclass.size();
2110 return true;
2111 }
2112
2113 if (symbol_name_ref.starts_with(g_objc_v2_prefix_ivar)) {
2114 symbol_name_non_abi_mangled = symbol_name + 1;
2115 symbol_name = symbol_name + g_objc_v2_prefix_ivar.size();
2116 type = eSymbolTypeObjCIVar;
2117 return true;
2118 }
2119
2120 return false;
2121}
2122
2123static SymbolType GetSymbolType(const char *&symbol_name,
2124 bool &demangled_is_synthesized,
2125 const SectionSP &text_section_sp,
2126 const SectionSP &data_section_sp,
2127 const SectionSP &data_dirty_section_sp,
2128 const SectionSP &data_const_section_sp,
2129 const SectionSP &symbol_section) {
2131
2132 const char *symbol_sect_name = symbol_section->GetName().AsCString(nullptr);
2133 if (symbol_section->IsDescendant(text_section_sp.get())) {
2134 if (symbol_section->IsClear(S_ATTR_PURE_INSTRUCTIONS |
2135 S_ATTR_SELF_MODIFYING_CODE |
2136 S_ATTR_SOME_INSTRUCTIONS))
2137 type = eSymbolTypeData;
2138 else
2139 type = eSymbolTypeCode;
2140 } else if (symbol_section->IsDescendant(data_section_sp.get()) ||
2141 symbol_section->IsDescendant(data_dirty_section_sp.get()) ||
2142 symbol_section->IsDescendant(data_const_section_sp.get())) {
2143 if (symbol_sect_name &&
2144 ::strstr(symbol_sect_name, "__objc") == symbol_sect_name) {
2145 type = eSymbolTypeRuntime;
2146
2147 if (symbol_name) {
2148 llvm::StringRef symbol_name_ref(symbol_name);
2149 if (symbol_name_ref.starts_with("OBJC_")) {
2150 static const llvm::StringRef g_objc_v2_prefix_class("OBJC_CLASS_$_");
2151 static const llvm::StringRef g_objc_v2_prefix_metaclass(
2152 "OBJC_METACLASS_$_");
2153 static const llvm::StringRef g_objc_v2_prefix_ivar("OBJC_IVAR_$_");
2154 if (symbol_name_ref.starts_with(g_objc_v2_prefix_class)) {
2155 symbol_name = symbol_name + g_objc_v2_prefix_class.size();
2156 type = eSymbolTypeObjCClass;
2157 demangled_is_synthesized = true;
2158 } else if (symbol_name_ref.starts_with(g_objc_v2_prefix_metaclass)) {
2159 symbol_name = symbol_name + g_objc_v2_prefix_metaclass.size();
2161 demangled_is_synthesized = true;
2162 } else if (symbol_name_ref.starts_with(g_objc_v2_prefix_ivar)) {
2163 symbol_name = symbol_name + g_objc_v2_prefix_ivar.size();
2164 type = eSymbolTypeObjCIVar;
2165 demangled_is_synthesized = true;
2166 }
2167 }
2168 }
2169 } else if (symbol_sect_name &&
2170 ::strstr(symbol_sect_name, "__gcc_except_tab") ==
2171 symbol_sect_name) {
2172 type = eSymbolTypeException;
2173 } else {
2174 type = eSymbolTypeData;
2175 }
2176 } else if (symbol_sect_name &&
2177 ::strstr(symbol_sect_name, "__IMPORT") == symbol_sect_name) {
2178 type = eSymbolTypeTrampoline;
2179 }
2180 return type;
2181}
2182
2183static std::optional<struct nlist_64>
2184ParseNList(DataExtractor &nlist_data, lldb::offset_t &nlist_data_offset,
2185 size_t nlist_byte_size) {
2186 struct nlist_64 nlist;
2187 if (!nlist_data.ValidOffsetForDataOfSize(nlist_data_offset, nlist_byte_size))
2188 return {};
2189 nlist.n_strx = nlist_data.GetU32_unchecked(&nlist_data_offset);
2190 nlist.n_type = nlist_data.GetU8_unchecked(&nlist_data_offset);
2191 nlist.n_sect = nlist_data.GetU8_unchecked(&nlist_data_offset);
2192 nlist.n_desc = nlist_data.GetU16_unchecked(&nlist_data_offset);
2193 nlist.n_value = nlist_data.GetAddress_unchecked(&nlist_data_offset);
2194 return nlist;
2195}
2196
2197enum { DebugSymbols = true, NonDebugSymbols = false };
2198
2200 ModuleSP module_sp(GetModule());
2201 if (!module_sp)
2202 return;
2203
2204 Log *log = GetLog(LLDBLog::Symbols);
2205
2206 const FileSpec &file = m_file ? m_file : module_sp->GetFileSpec();
2207 const char *file_name = file.GetFilename().AsCString("<Unknown>");
2208 LLDB_SCOPED_TIMERF("ObjectFileMachO::ParseSymtab () module = %s", file_name);
2209 LLDB_LOG(log, "Parsing symbol table for {0}", file_name);
2210 Progress progress("Parsing symbol table", file_name);
2211
2212 LinkeditDataCommandLargeOffsets function_starts_load_command;
2213 LinkeditDataCommandLargeOffsets exports_trie_load_command;
2216 SymtabCommandLargeOffsets symtab_load_command;
2217 // The data element of type bool indicates that this entry is thumb
2218 // code.
2219 typedef AddressDataArray<lldb::addr_t, bool, 100> FunctionStarts;
2220
2221 // Record the address of every function/data that we add to the symtab.
2222 // We add symbols to the table in the order of most information (nlist
2223 // records) to least (function starts), and avoid duplicating symbols
2224 // via this set.
2225 llvm::DenseSet<addr_t> symbols_added;
2226
2227 // We are using a llvm::DenseSet for "symbols_added" so we must be sure we
2228 // do not add the empty key to the set.
2229 auto add_symbol_addr = [&symbols_added](lldb::addr_t file_addr) {
2230 // Don't add the empty key.
2231 if (file_addr == UINT64_MAX)
2232 return;
2233 symbols_added.insert(file_addr);
2234 };
2235 FunctionStarts function_starts;
2237 uint32_t i;
2238 FileSpecList dylib_files;
2239 UUID image_uuid;
2240
2241 for (i = 0; i < m_header.ncmds; ++i) {
2242 const lldb::offset_t cmd_offset = offset;
2243 // Read in the load command and load command size
2244 llvm::MachO::load_command lc;
2245 if (m_data_nsp->GetU32(&offset, &lc, 2) == nullptr)
2246 break;
2247 // Watch for the symbol table load command
2248 switch (lc.cmd) {
2249 case LC_SYMTAB: {
2250 llvm::MachO::symtab_command lc_obj;
2251 if (m_data_nsp->GetU32(&offset, &lc_obj.symoff, 4)) {
2252 lc_obj.cmd = lc.cmd;
2253 lc_obj.cmdsize = lc.cmdsize;
2254 symtab_load_command = lc_obj;
2255 }
2256 } break;
2257
2258 case LC_DYLD_INFO:
2259 case LC_DYLD_INFO_ONLY: {
2260 llvm::MachO::dyld_info_command lc_obj;
2261 if (m_data_nsp->GetU32(&offset, &lc_obj.rebase_off, 10)) {
2262 lc_obj.cmd = lc.cmd;
2263 lc_obj.cmdsize = lc.cmdsize;
2264 dyld_info = lc_obj;
2265 }
2266 } break;
2267
2268 case LC_LOAD_DYLIB:
2269 case LC_LOAD_WEAK_DYLIB:
2270 case LC_REEXPORT_DYLIB:
2271 case LC_LOADFVMLIB:
2272 case LC_LOAD_UPWARD_DYLIB: {
2273 uint32_t name_offset = cmd_offset + m_data_nsp->GetU32(&offset);
2274 const char *path = m_data_nsp->PeekCStr(name_offset);
2275 if (path) {
2276 FileSpec file_spec(path);
2277 // Strip the path if there is @rpath, @executable, etc so we just use
2278 // the basename
2279 if (path[0] == '@')
2280 file_spec.ClearDirectory();
2281
2282 if (lc.cmd == LC_REEXPORT_DYLIB) {
2283 m_reexported_dylibs.AppendIfUnique(file_spec);
2284 }
2285
2286 dylib_files.Append(file_spec);
2287 }
2288 } break;
2289
2290 case LC_DYLD_EXPORTS_TRIE: {
2291 llvm::MachO::linkedit_data_command lc_obj;
2292 lc_obj.cmd = lc.cmd;
2293 lc_obj.cmdsize = lc.cmdsize;
2294 if (m_data_nsp->GetU32(&offset, &lc_obj.dataoff, 2))
2295 exports_trie_load_command = lc_obj;
2296 } break;
2297 case LC_FUNCTION_STARTS: {
2298 llvm::MachO::linkedit_data_command lc_obj;
2299 lc_obj.cmd = lc.cmd;
2300 lc_obj.cmdsize = lc.cmdsize;
2301 if (m_data_nsp->GetU32(&offset, &lc_obj.dataoff, 2))
2302 function_starts_load_command = lc_obj;
2303 } break;
2304
2305 case LC_UUID: {
2306 const uint8_t *uuid_bytes = m_data_nsp->PeekData(offset, 16);
2307
2308 if (uuid_bytes)
2309 image_uuid = UUID(uuid_bytes, 16);
2310 break;
2311 }
2312
2313 default:
2314 break;
2315 }
2316 offset = cmd_offset + lc.cmdsize;
2317 }
2318
2319 if (!symtab_load_command.cmd)
2320 return;
2321
2322 SectionList *section_list = GetSectionList();
2323 if (section_list == nullptr)
2324 return;
2325
2326 const uint32_t addr_byte_size = m_data_nsp->GetAddressByteSize();
2327 const ByteOrder byte_order = m_data_nsp->GetByteOrder();
2328 bool bit_width_32 = addr_byte_size == 4;
2329 const size_t nlist_byte_size =
2330 bit_width_32 ? sizeof(struct nlist) : sizeof(struct nlist_64);
2331
2332 DataExtractor nlist_data(nullptr, 0, byte_order, addr_byte_size);
2333 DataExtractor strtab_data(nullptr, 0, byte_order, addr_byte_size);
2334 DataExtractor function_starts_data(nullptr, 0, byte_order, addr_byte_size);
2335 DataExtractor indirect_symbol_index_data(nullptr, 0, byte_order,
2336 addr_byte_size);
2337 DataExtractor dyld_trie_data(nullptr, 0, byte_order, addr_byte_size);
2338
2339 const addr_t nlist_data_byte_size =
2340 symtab_load_command.nsyms * nlist_byte_size;
2341 const addr_t strtab_data_byte_size = symtab_load_command.strsize;
2342 addr_t strtab_addr = LLDB_INVALID_ADDRESS;
2343
2344 ProcessSP process_sp(m_process_wp.lock());
2345 Process *process = process_sp.get();
2346
2347 uint32_t memory_module_load_level = eMemoryModuleLoadLevelComplete;
2348 bool is_shared_cache_image = IsSharedCacheBinary();
2349 bool is_local_shared_cache_image = is_shared_cache_image && !IsInMemory();
2350
2351 ConstString g_segment_name_TEXT = GetSegmentNameTEXT();
2352 ConstString g_segment_name_DATA = GetSegmentNameDATA();
2353 ConstString g_segment_name_DATA_DIRTY = GetSegmentNameDATA_DIRTY();
2354 ConstString g_segment_name_DATA_CONST = GetSegmentNameDATA_CONST();
2355 ConstString g_segment_name_OBJC = GetSegmentNameOBJC();
2356 ConstString g_section_name_eh_frame = GetSectionNameEHFrame();
2357 ConstString g_section_name_lldb_no_nlist = GetSectionNameLLDBNoNlist();
2358 SectionSP text_section_sp(
2359 section_list->FindSectionByName(g_segment_name_TEXT));
2360 SectionSP data_section_sp(
2361 section_list->FindSectionByName(g_segment_name_DATA));
2362 SectionSP linkedit_section_sp(
2363 section_list->FindSectionByName(GetSegmentNameLINKEDIT()));
2364 SectionSP data_dirty_section_sp(
2365 section_list->FindSectionByName(g_segment_name_DATA_DIRTY));
2366 SectionSP data_const_section_sp(
2367 section_list->FindSectionByName(g_segment_name_DATA_CONST));
2368 SectionSP objc_section_sp(
2369 section_list->FindSectionByName(g_segment_name_OBJC));
2370 SectionSP eh_frame_section_sp;
2371 SectionSP lldb_no_nlist_section_sp;
2372 if (text_section_sp.get()) {
2373 eh_frame_section_sp = text_section_sp->GetChildren().FindSectionByName(
2374 g_section_name_eh_frame);
2375 lldb_no_nlist_section_sp = text_section_sp->GetChildren().FindSectionByName(
2376 g_section_name_lldb_no_nlist);
2377 } else {
2378 eh_frame_section_sp =
2379 section_list->FindSectionByName(g_section_name_eh_frame);
2380 lldb_no_nlist_section_sp =
2381 section_list->FindSectionByName(g_section_name_lldb_no_nlist);
2382 }
2383
2384 if (process && m_header.filetype != llvm::MachO::MH_OBJECT &&
2385 !is_local_shared_cache_image) {
2386 Target &target = process->GetTarget();
2387
2388 memory_module_load_level = target.GetMemoryModuleLoadLevel();
2389
2390 // If __TEXT,__lldb_no_nlist section is present in this binary,
2391 // and we're reading it out of memory, do not read any of the
2392 // nlist entries. They are not needed in lldb and it may be
2393 // expensive to load these. This is to handle a dylib consisting
2394 // of only metadata, no code, but it has many nlist entries.
2395 if (lldb_no_nlist_section_sp)
2396 memory_module_load_level = eMemoryModuleLoadLevelMinimal;
2397
2398 // Reading mach file from memory in a process or core file...
2399
2400 if (linkedit_section_sp) {
2401 addr_t linkedit_load_addr =
2402 linkedit_section_sp->GetLoadBaseAddress(&target);
2403 if (linkedit_load_addr == LLDB_INVALID_ADDRESS) {
2404 // We might be trying to access the symbol table before the
2405 // __LINKEDIT's load address has been set in the target. We can't
2406 // fail to read the symbol table, so calculate the right address
2407 // manually
2408 linkedit_load_addr = CalculateSectionLoadAddressForMemoryImage(
2409 m_memory_addr, GetMachHeaderSection(), linkedit_section_sp.get());
2410 }
2411
2412 const addr_t linkedit_file_offset = linkedit_section_sp->GetFileOffset();
2413 const addr_t symoff_addr = linkedit_load_addr +
2414 symtab_load_command.symoff -
2415 linkedit_file_offset;
2416 strtab_addr = linkedit_load_addr + symtab_load_command.stroff -
2417 linkedit_file_offset;
2418
2419 // Always load dyld - the dynamic linker - from memory if we didn't
2420 // find a binary anywhere else. lldb will not register
2421 // dylib/framework/bundle loads/unloads if we don't have the dyld
2422 // symbols, we force dyld to load from memory despite the user's
2423 // target.memory-module-load-level setting.
2424 if (memory_module_load_level == eMemoryModuleLoadLevelComplete ||
2425 m_header.filetype == llvm::MachO::MH_DYLINKER) {
2426 DataBufferSP nlist_data_sp(
2427 ReadMemory(process_sp, symoff_addr, nlist_data_byte_size));
2428 if (nlist_data_sp)
2429 nlist_data.SetData(nlist_data_sp, 0, nlist_data_sp->GetByteSize());
2430 if (dysymtab.nindirectsyms != 0) {
2431 const addr_t indirect_syms_addr = linkedit_load_addr +
2432 dysymtab.indirectsymoff -
2433 linkedit_file_offset;
2434 DataBufferSP indirect_syms_data_sp(ReadMemory(
2435 process_sp, indirect_syms_addr, dysymtab.nindirectsyms * 4));
2436 if (indirect_syms_data_sp)
2437 indirect_symbol_index_data.SetData(
2438 indirect_syms_data_sp, 0, indirect_syms_data_sp->GetByteSize());
2439 // If this binary is outside the shared cache,
2440 // cache the string table.
2441 // Binaries in the shared cache all share a giant string table,
2442 // and we can't share the string tables across multiple
2443 // ObjectFileMachO's, so we'd end up re-reading this mega-strtab
2444 // for every binary in the shared cache - it would be a big perf
2445 // problem. For binaries outside the shared cache, it's faster to
2446 // read the entire strtab at once instead of piece-by-piece as we
2447 // process the nlist records.
2448 if (!is_shared_cache_image) {
2449 DataBufferSP strtab_data_sp(
2450 ReadMemory(process_sp, strtab_addr, strtab_data_byte_size));
2451 if (strtab_data_sp) {
2452 strtab_data.SetData(strtab_data_sp, 0,
2453 strtab_data_sp->GetByteSize());
2454 }
2455 }
2456 }
2457 if (memory_module_load_level >= eMemoryModuleLoadLevelPartial) {
2458 if (function_starts_load_command.cmd) {
2459 const addr_t func_start_addr =
2460 linkedit_load_addr + function_starts_load_command.dataoff -
2461 linkedit_file_offset;
2462 DataBufferSP func_start_data_sp(
2463 ReadMemory(process_sp, func_start_addr,
2464 function_starts_load_command.datasize));
2465 if (func_start_data_sp)
2466 function_starts_data.SetData(func_start_data_sp, 0,
2467 func_start_data_sp->GetByteSize());
2468 }
2469 }
2470 }
2471 }
2472 } else {
2473 if (is_local_shared_cache_image) {
2474 // The load commands in shared cache images are relative to the
2475 // beginning of the shared cache, not the library image. The
2476 // data we get handed when creating the ObjectFileMachO starts
2477 // at the beginning of a specific library and spans to the end
2478 // of the cache to be able to reach the shared LINKEDIT
2479 // segments. We need to convert the load command offsets to be
2480 // relative to the beginning of our specific image.
2481 lldb::addr_t linkedit_offset = linkedit_section_sp->GetFileOffset();
2482 lldb::offset_t linkedit_slide =
2483 linkedit_offset - m_linkedit_original_offset;
2484 symtab_load_command.symoff += linkedit_slide;
2485 symtab_load_command.stroff += linkedit_slide;
2486 dyld_info.export_off += linkedit_slide;
2487 dysymtab.indirectsymoff += linkedit_slide;
2488 function_starts_load_command.dataoff += linkedit_slide;
2489 exports_trie_load_command.dataoff += linkedit_slide;
2490 }
2491
2492 nlist_data = *m_data_nsp->GetSubsetExtractorSP(symtab_load_command.symoff,
2493 nlist_data_byte_size);
2494 strtab_data = *m_data_nsp->GetSubsetExtractorSP(symtab_load_command.stroff,
2495 strtab_data_byte_size);
2496
2497 // We shouldn't have exports data from both the LC_DYLD_INFO command
2498 // AND the LC_DYLD_EXPORTS_TRIE command in the same binary:
2499 lldbassert(!((dyld_info.export_size > 0)
2500 && (exports_trie_load_command.datasize > 0)));
2501 if (dyld_info.export_size > 0) {
2502 dyld_trie_data = *m_data_nsp->GetSubsetExtractorSP(dyld_info.export_off,
2503 dyld_info.export_size);
2504 } else if (exports_trie_load_command.datasize > 0) {
2505 dyld_trie_data =
2506 *m_data_nsp->GetSubsetExtractorSP(exports_trie_load_command.dataoff,
2507 exports_trie_load_command.datasize);
2508 }
2509
2510 if (dysymtab.nindirectsyms != 0) {
2511 indirect_symbol_index_data = *m_data_nsp->GetSubsetExtractorSP(
2512 dysymtab.indirectsymoff, dysymtab.nindirectsyms * 4);
2513 }
2514 if (function_starts_load_command.cmd) {
2515 function_starts_data = *m_data_nsp->GetSubsetExtractorSP(
2516 function_starts_load_command.dataoff,
2517 function_starts_load_command.datasize);
2518 }
2519 }
2520
2521 const bool have_strtab_data = strtab_data.GetByteSize() > 0;
2522
2523 const bool is_arm = (m_header.cputype == llvm::MachO::CPU_TYPE_ARM);
2524 const bool always_thumb = GetArchitecture().IsAlwaysThumbInstructions();
2525
2526 // lldb works best if it knows the start address of all functions in a
2527 // module. Linker symbols or debug info are normally the best source of
2528 // information for start addr / size but they may be stripped in a released
2529 // binary. Two additional sources of information exist in Mach-O binaries:
2530 // LC_FUNCTION_STARTS - a list of ULEB128 encoded offsets of each
2531 // function's start address in the
2532 // binary, relative to the text section.
2533 // eh_frame - the eh_frame FDEs have the start addr & size of
2534 // each function
2535 // LC_FUNCTION_STARTS is the fastest source to read in, and is present on
2536 // all modern binaries.
2537 // Binaries built to run on older releases may need to use eh_frame
2538 // information.
2539
2540 if (text_section_sp && function_starts_data.GetByteSize()) {
2541 FunctionStarts::Entry function_start_entry;
2542 function_start_entry.data = false;
2543 lldb::offset_t function_start_offset = 0;
2544 function_start_entry.addr = text_section_sp->GetFileAddress();
2545 uint64_t delta;
2546 while ((delta = function_starts_data.GetULEB128(&function_start_offset)) >
2547 0) {
2548 // Now append the current entry
2549 function_start_entry.addr += delta;
2550 if (is_arm) {
2551 if (function_start_entry.addr & 1) {
2552 function_start_entry.addr &= THUMB_ADDRESS_BIT_MASK;
2553 function_start_entry.data = true;
2554 } else if (always_thumb) {
2555 function_start_entry.data = true;
2556 }
2557 }
2558 function_starts.Append(function_start_entry);
2559 }
2560 } else {
2561 // If m_type is eTypeDebugInfo, then this is a dSYM - it will have the
2562 // load command claiming an eh_frame but it doesn't actually have the
2563 // eh_frame content. And if we have a dSYM, we don't need to do any of
2564 // this fill-in-the-missing-symbols works anyway - the debug info should
2565 // give us all the functions in the module.
2566 if (text_section_sp.get() && eh_frame_section_sp.get() &&
2568 DWARFCallFrameInfo eh_frame(*this, eh_frame_section_sp,
2571 eh_frame.GetFunctionAddressAndSizeVector(functions);
2572 addr_t text_base_addr = text_section_sp->GetFileAddress();
2573 size_t count = functions.GetSize();
2574 for (size_t i = 0; i < count; ++i) {
2576 functions.GetEntryAtIndex(i);
2577 if (func) {
2578 FunctionStarts::Entry function_start_entry;
2579 function_start_entry.addr = func->base - text_base_addr;
2580 if (is_arm) {
2581 if (function_start_entry.addr & 1) {
2582 function_start_entry.addr &= THUMB_ADDRESS_BIT_MASK;
2583 function_start_entry.data = true;
2584 } else if (always_thumb) {
2585 function_start_entry.data = true;
2586 }
2587 }
2588 function_starts.Append(function_start_entry);
2589 }
2590 }
2591 }
2592 }
2593
2594 const size_t function_starts_count = function_starts.GetSize();
2595
2596 // For user process binaries (executables, dylibs, frameworks, bundles), if
2597 // we don't have LC_FUNCTION_STARTS/eh_frame section in this binary, we're
2598 // going to assume the binary has been stripped. Don't allow assembly
2599 // language instruction emulation because we don't know proper function
2600 // start boundaries.
2601 //
2602 // For all other types of binaries (kernels, stand-alone bare board
2603 // binaries, kexts), they may not have LC_FUNCTION_STARTS / eh_frame
2604 // sections - we should not make any assumptions about them based on that.
2605 if (function_starts_count == 0 && CalculateStrata() == eStrataUser) {
2607 Log *unwind_or_symbol_log(GetLog(LLDBLog::Symbols | LLDBLog::Unwind));
2608
2609 if (unwind_or_symbol_log)
2610 module_sp->LogMessage(
2611 unwind_or_symbol_log,
2612 "no LC_FUNCTION_STARTS, will not allow assembly profiled unwinds");
2613 }
2614
2615 const user_id_t TEXT_eh_frame_sectID = eh_frame_section_sp.get()
2616 ? eh_frame_section_sp->GetID()
2617 : static_cast<user_id_t>(NO_SECT);
2618
2619 uint32_t N_SO_index = UINT32_MAX;
2620
2621 MachSymtabSectionInfo section_info(section_list);
2622 std::vector<uint32_t> N_FUN_indexes;
2623 std::vector<uint32_t> N_NSYM_indexes;
2624 std::vector<uint32_t> N_INCL_indexes;
2625 std::vector<uint32_t> N_BRAC_indexes;
2626 std::vector<uint32_t> N_COMM_indexes;
2627 typedef std::multimap<uint64_t, uint32_t> ValueToSymbolIndexMap;
2628 typedef llvm::DenseMap<uint32_t, uint32_t> NListIndexToSymbolIndexMap;
2629 typedef llvm::DenseMap<const char *, uint32_t> ConstNameToSymbolIndexMap;
2630 ValueToSymbolIndexMap N_FUN_addr_to_sym_idx;
2631 ValueToSymbolIndexMap N_STSYM_addr_to_sym_idx;
2632 ConstNameToSymbolIndexMap N_GSYM_name_to_sym_idx;
2633 // Any symbols that get merged into another will get an entry in this map
2634 // so we know
2635 NListIndexToSymbolIndexMap m_nlist_idx_to_sym_idx;
2636 uint32_t nlist_idx = 0;
2637 Symbol *symbol_ptr = nullptr;
2638
2639 uint32_t sym_idx = 0;
2640 Symbol *sym = nullptr;
2641 size_t num_syms = 0;
2642 std::string memory_symbol_name;
2643 uint32_t unmapped_local_symbols_found = 0;
2644
2645 std::vector<TrieEntryWithOffset> reexport_trie_entries;
2646 std::vector<TrieEntryWithOffset> external_sym_trie_entries;
2647 std::set<lldb::addr_t> resolver_addresses;
2648
2649 const size_t dyld_trie_data_size = dyld_trie_data.GetByteSize();
2650 if (dyld_trie_data_size > 0) {
2651 LLDB_LOG(log, "Parsing {0} bytes of dyld trie data", dyld_trie_data_size);
2652 SectionSP text_segment_sp =
2654 lldb::addr_t text_segment_file_addr = LLDB_INVALID_ADDRESS;
2655 if (text_segment_sp)
2656 text_segment_file_addr = text_segment_sp->GetFileAddress();
2657 std::string prefix;
2658 ParseTrieEntries(dyld_trie_data, 0, is_arm, text_segment_file_addr, prefix,
2659 resolver_addresses, reexport_trie_entries,
2660 external_sym_trie_entries);
2661 }
2662
2663 typedef std::set<ConstString> IndirectSymbols;
2664 IndirectSymbols indirect_symbol_names;
2665
2666#if TARGET_OS_IPHONE
2667
2668 // Some recent builds of the dyld_shared_cache (hereafter: DSC) have been
2669 // optimized by moving LOCAL symbols out of the memory mapped portion of
2670 // the DSC. The symbol information has all been retained, but it isn't
2671 // available in the normal nlist data. However, there *are* duplicate
2672 // entries of *some*
2673 // LOCAL symbols in the normal nlist data. To handle this situation
2674 // correctly, we must first attempt
2675 // to parse any DSC unmapped symbol information. If we find any, we set a
2676 // flag that tells the normal nlist parser to ignore all LOCAL symbols.
2677
2678 if (IsSharedCacheBinary()) {
2679 // Before we can start mapping the DSC, we need to make certain the
2680 // target process is actually using the cache we can find.
2681
2682 // Next we need to determine the correct path for the dyld shared cache.
2683
2684 ArchSpec header_arch = GetArchitecture();
2685
2686 UUID dsc_uuid;
2687 UUID process_shared_cache_uuid;
2688 addr_t process_shared_cache_base_addr;
2689
2690 if (process) {
2691 GetProcessSharedCacheUUID(process, process_shared_cache_base_addr,
2692 process_shared_cache_uuid);
2693 }
2694
2695 __block bool found_image = false;
2696 __block void *nlist_buffer = nullptr;
2697 __block unsigned nlist_count = 0;
2698 __block char *string_table = nullptr;
2699 __block vm_offset_t vm_nlist_memory = 0;
2700 __block mach_msg_type_number_t vm_nlist_bytes_read = 0;
2701 __block vm_offset_t vm_string_memory = 0;
2702 __block mach_msg_type_number_t vm_string_bytes_read = 0;
2703
2704 llvm::scope_exit _(^{
2705 if (vm_nlist_memory)
2706 vm_deallocate(mach_task_self(), vm_nlist_memory, vm_nlist_bytes_read);
2707 if (vm_string_memory)
2708 vm_deallocate(mach_task_self(), vm_string_memory, vm_string_bytes_read);
2709 });
2710
2711 typedef llvm::DenseMap<ConstString, uint16_t> UndefinedNameToDescMap;
2712 typedef llvm::DenseMap<uint32_t, ConstString> SymbolIndexToName;
2713 UndefinedNameToDescMap undefined_name_to_desc;
2714 SymbolIndexToName reexport_shlib_needs_fixup;
2715
2716 dyld_for_each_installed_shared_cache(^(dyld_shared_cache_t shared_cache) {
2717 uuid_t cache_uuid;
2718 dyld_shared_cache_copy_uuid(shared_cache, &cache_uuid);
2719 if (found_image)
2720 return;
2721
2722 if (process_shared_cache_uuid.IsValid() &&
2723 process_shared_cache_uuid != UUID(&cache_uuid, 16))
2724 return;
2725
2726 dyld_shared_cache_for_each_image(shared_cache, ^(dyld_image_t image) {
2727 uuid_t dsc_image_uuid;
2728 if (found_image)
2729 return;
2730
2731 dyld_image_copy_uuid(image, &dsc_image_uuid);
2732 if (image_uuid != UUID(dsc_image_uuid, 16))
2733 return;
2734
2735 found_image = true;
2736
2737 // Compute the size of the string table. We need to ask dyld for a
2738 // new SPI to avoid this step.
2739 dyld_image_local_nlist_content_4Symbolication(
2740 image, ^(const void *nlistStart, uint64_t nlistCount,
2741 const char *stringTable) {
2742 if (!nlistStart || !nlistCount)
2743 return;
2744
2745 // The buffers passed here are valid only inside the block.
2746 // Use vm_read to make a cheap copy of them available for our
2747 // processing later.
2748 kern_return_t ret =
2749 vm_read(mach_task_self(), (vm_address_t)nlistStart,
2750 nlist_byte_size * nlistCount, &vm_nlist_memory,
2751 &vm_nlist_bytes_read);
2752 if (ret != KERN_SUCCESS)
2753 return;
2754 assert(vm_nlist_bytes_read == nlist_byte_size * nlistCount);
2755
2756 // We don't know the size of the string table. It's cheaper
2757 // to map the whole VM region than to determine the size by
2758 // parsing all the nlist entries.
2759 vm_address_t string_address = (vm_address_t)stringTable;
2760 vm_size_t region_size;
2761 mach_msg_type_number_t info_count = VM_REGION_BASIC_INFO_COUNT_64;
2762 vm_region_basic_info_data_t info;
2763 memory_object_name_t object;
2764 ret = vm_region_64(mach_task_self(), &string_address,
2765 &region_size, VM_REGION_BASIC_INFO_64,
2766 (vm_region_info_t)&info, &info_count, &object);
2767 if (ret != KERN_SUCCESS)
2768 return;
2769
2770 ret = vm_read(mach_task_self(), (vm_address_t)stringTable,
2771 region_size -
2772 ((vm_address_t)stringTable - string_address),
2773 &vm_string_memory, &vm_string_bytes_read);
2774 if (ret != KERN_SUCCESS)
2775 return;
2776
2777 nlist_buffer = (void *)vm_nlist_memory;
2778 string_table = (char *)vm_string_memory;
2779 nlist_count = nlistCount;
2780 });
2781 });
2782 });
2783 if (nlist_buffer) {
2784 DataExtractor dsc_local_symbols_data(nlist_buffer,
2785 nlist_count * nlist_byte_size,
2786 byte_order, addr_byte_size);
2787 unmapped_local_symbols_found = nlist_count;
2788
2789 // The normal nlist code cannot correctly size the Symbols
2790 // array, we need to allocate it here.
2791 sym = symtab.Resize(
2792 symtab_load_command.nsyms + m_dysymtab.nindirectsyms +
2793 unmapped_local_symbols_found - m_dysymtab.nlocalsym);
2794 num_syms = symtab.GetNumSymbols();
2795
2796 lldb::offset_t nlist_data_offset = 0;
2797
2798 for (uint32_t nlist_index = 0;
2799 nlist_index < nlist_count;
2800 nlist_index++) {
2801 /////////////////////////////
2802 {
2803 std::optional<struct nlist_64> nlist_maybe =
2804 ParseNList(dsc_local_symbols_data, nlist_data_offset,
2805 nlist_byte_size);
2806 if (!nlist_maybe)
2807 break;
2808 struct nlist_64 nlist = *nlist_maybe;
2809
2811 const char *symbol_name = string_table + nlist.n_strx;
2812
2813 if (symbol_name == NULL) {
2814 // No symbol should be NULL, even the symbols with no
2815 // string values should have an offset zero which
2816 // points to an empty C-string
2817 Debugger::ReportError(llvm::formatv(
2818 "DSC unmapped local symbol[{0}] has invalid "
2819 "string table offset {1:x} in {2}, ignoring symbol",
2820 nlist_index, nlist.n_strx,
2821 module_sp->GetFileSpec().GetPath()));
2822 continue;
2823 }
2824 if (symbol_name[0] == '\0')
2825 symbol_name = NULL;
2826
2827 const char *symbol_name_non_abi_mangled = NULL;
2828
2829 SectionSP symbol_section;
2830 bool add_nlist = true;
2831 bool is_debug = ((nlist.n_type & N_STAB) != 0);
2832 bool demangled_is_synthesized = false;
2833 bool is_gsym = false;
2834 bool set_value = true;
2835
2836 assert(sym_idx < num_syms);
2837
2838 sym[sym_idx].SetDebug(is_debug);
2839
2840 if (is_debug) {
2841 switch (nlist.n_type) {
2842 case N_GSYM:
2843 // global symbol: name,,NO_SECT,type,0
2844 // Sometimes the N_GSYM value contains the address.
2845
2846 // FIXME: In the .o files, we have a GSYM and a debug
2847 // symbol for all the ObjC data. They
2848 // have the same address, but we want to ensure that
2849 // we always find only the real symbol, 'cause we
2850 // don't currently correctly attribute the
2851 // GSYM one to the ObjCClass/Ivar/MetaClass
2852 // symbol type. This is a temporary hack to make
2853 // sure the ObjectiveC symbols get treated correctly.
2854 // To do this right, we should coalesce all the GSYM
2855 // & global symbols that have the same address.
2856
2857 is_gsym = true;
2858 sym[sym_idx].SetExternal(true);
2859
2861 symbol_name, symbol_name_non_abi_mangled,
2862 type)) {
2863 demangled_is_synthesized = true;
2864 } else {
2865 if (nlist.n_value != 0)
2866 symbol_section = section_info.GetSection(
2867 nlist.n_sect, nlist.n_value);
2868
2869 type = eSymbolTypeData;
2870 }
2871 break;
2872
2873 case N_FNAME:
2874 // procedure name (f77 kludge): name,,NO_SECT,0,0
2875 type = eSymbolTypeCompiler;
2876 break;
2877
2878 case N_FUN:
2879 // procedure: name,,n_sect,linenumber,address
2880 if (symbol_name) {
2881 type = eSymbolTypeCode;
2882 symbol_section = section_info.GetSection(
2883 nlist.n_sect, nlist.n_value);
2884
2885 N_FUN_addr_to_sym_idx.insert(
2886 std::make_pair(nlist.n_value, sym_idx));
2887 // We use the current number of symbols in the
2888 // symbol table in lieu of using nlist_idx in case
2889 // we ever start trimming entries out
2890 N_FUN_indexes.push_back(sym_idx);
2891 } else {
2892 type = eSymbolTypeCompiler;
2893
2894 if (!N_FUN_indexes.empty()) {
2895 // Copy the size of the function into the
2896 // original
2897 // STAB entry so we don't have
2898 // to hunt for it later
2899 symtab.SymbolAtIndex(N_FUN_indexes.back())
2900 ->SetByteSize(nlist.n_value);
2901 N_FUN_indexes.pop_back();
2902 // We don't really need the end function STAB as
2903 // it contains the size which we already placed
2904 // with the original symbol, so don't add it if
2905 // we want a minimal symbol table
2906 add_nlist = false;
2907 }
2908 }
2909 break;
2910
2911 case N_STSYM:
2912 // static symbol: name,,n_sect,type,address
2913 N_STSYM_addr_to_sym_idx.insert(
2914 std::make_pair(nlist.n_value, sym_idx));
2915 symbol_section = section_info.GetSection(nlist.n_sect,
2916 nlist.n_value);
2917 if (symbol_name && symbol_name[0]) {
2919 symbol_name + 1, eSymbolTypeData);
2920 }
2921 break;
2922
2923 case N_LCSYM:
2924 // .lcomm symbol: name,,n_sect,type,address
2925 symbol_section = section_info.GetSection(nlist.n_sect,
2926 nlist.n_value);
2928 break;
2929
2930 case N_BNSYM:
2931 // We use the current number of symbols in the symbol
2932 // table in lieu of using nlist_idx in case we ever
2933 // start trimming entries out Skip these if we want
2934 // minimal symbol tables
2935 add_nlist = false;
2936 break;
2937
2938 case N_ENSYM:
2939 // Set the size of the N_BNSYM to the terminating
2940 // index of this N_ENSYM so that we can always skip
2941 // the entire symbol if we need to navigate more
2942 // quickly at the source level when parsing STABS
2943 // Skip these if we want minimal symbol tables
2944 add_nlist = false;
2945 break;
2946
2947 case N_OPT:
2948 // emitted with gcc2_compiled and in gcc source
2949 type = eSymbolTypeCompiler;
2950 break;
2951
2952 case N_RSYM:
2953 // register sym: name,,NO_SECT,type,register
2954 type = eSymbolTypeVariable;
2955 break;
2956
2957 case N_SLINE:
2958 // src line: 0,,n_sect,linenumber,address
2959 symbol_section = section_info.GetSection(nlist.n_sect,
2960 nlist.n_value);
2961 type = eSymbolTypeLineEntry;
2962 break;
2963
2964 case N_SSYM:
2965 // structure elt: name,,NO_SECT,type,struct_offset
2967 break;
2968
2969 case N_SO:
2970 // source file name
2971 type = eSymbolTypeSourceFile;
2972 if (symbol_name == NULL) {
2973 add_nlist = false;
2974 if (N_SO_index != UINT32_MAX) {
2975 // Set the size of the N_SO to the terminating
2976 // index of this N_SO so that we can always skip
2977 // the entire N_SO if we need to navigate more
2978 // quickly at the source level when parsing STABS
2979 symbol_ptr = symtab.SymbolAtIndex(N_SO_index);
2980 symbol_ptr->SetByteSize(sym_idx);
2981 symbol_ptr->SetSizeIsSibling(true);
2982 }
2983 N_NSYM_indexes.clear();
2984 N_INCL_indexes.clear();
2985 N_BRAC_indexes.clear();
2986 N_COMM_indexes.clear();
2987 N_FUN_indexes.clear();
2988 N_SO_index = UINT32_MAX;
2989 } else {
2990 // We use the current number of symbols in the
2991 // symbol table in lieu of using nlist_idx in case
2992 // we ever start trimming entries out
2993 const bool N_SO_has_full_path = symbol_name[0] == '/';
2994 if (N_SO_has_full_path) {
2995 if ((N_SO_index == sym_idx - 1) &&
2996 ((sym_idx - 1) < num_syms)) {
2997 // We have two consecutive N_SO entries where
2998 // the first contains a directory and the
2999 // second contains a full path.
3000 sym[sym_idx - 1].GetMangled().SetValue(
3001 ConstString(symbol_name));
3002 m_nlist_idx_to_sym_idx[nlist_idx] = sym_idx - 1;
3003 add_nlist = false;
3004 } else {
3005 // This is the first entry in a N_SO that
3006 // contains a directory or
3007 // a full path to the source file
3008 N_SO_index = sym_idx;
3009 }
3010 } else if ((N_SO_index == sym_idx - 1) &&
3011 ((sym_idx - 1) < num_syms)) {
3012 // This is usually the second N_SO entry that
3013 // contains just the filename, so here we combine
3014 // it with the first one if we are minimizing the
3015 // symbol table
3016 const char *so_path = sym[sym_idx - 1]
3017 .GetMangled()
3019 .AsCString();
3020 if (so_path && so_path[0]) {
3021 std::string full_so_path(so_path);
3022 const size_t double_slash_pos =
3023 full_so_path.find("//");
3024 if (double_slash_pos != std::string::npos) {
3025 // The linker has been generating bad N_SO
3026 // entries with doubled up paths
3027 // in the format "%s%s" where the first
3028 // string in the DW_AT_comp_dir, and the
3029 // second is the directory for the source
3030 // file so you end up with a path that looks
3031 // like "/tmp/src//tmp/src/"
3032 FileSpec so_dir(so_path);
3033 if (!FileSystem::Instance().Exists(so_dir)) {
3034 so_dir.SetFile(
3035 &full_so_path[double_slash_pos + 1],
3036 FileSpec::Style::native);
3037 if (FileSystem::Instance().Exists(so_dir)) {
3038 // Trim off the incorrect path
3039 full_so_path.erase(0, double_slash_pos + 1);
3040 }
3041 }
3042 }
3043 if (*full_so_path.rbegin() != '/')
3044 full_so_path += '/';
3045 full_so_path += symbol_name;
3046 sym[sym_idx - 1].GetMangled().SetValue(
3047 ConstString(full_so_path.c_str()));
3048 add_nlist = false;
3049 m_nlist_idx_to_sym_idx[nlist_idx] = sym_idx - 1;
3050 }
3051 } else {
3052 // This could be a relative path to a N_SO
3053 N_SO_index = sym_idx;
3054 }
3055 }
3056 break;
3057
3058 case N_OSO:
3059 // object file name: name,,0,0,st_mtime
3060 type = eSymbolTypeObjectFile;
3061 break;
3062
3063 case N_LSYM:
3064 // local sym: name,,NO_SECT,type,offset
3065 type = eSymbolTypeLocal;
3066 break;
3067
3068 // INCL scopes
3069 case N_BINCL:
3070 // include file beginning: name,,NO_SECT,0,sum We use
3071 // the current number of symbols in the symbol table
3072 // in lieu of using nlist_idx in case we ever start
3073 // trimming entries out
3074 N_INCL_indexes.push_back(sym_idx);
3075 type = eSymbolTypeScopeBegin;
3076 break;
3077
3078 case N_EINCL:
3079 // include file end: name,,NO_SECT,0,0
3080 // Set the size of the N_BINCL to the terminating
3081 // index of this N_EINCL so that we can always skip
3082 // the entire symbol if we need to navigate more
3083 // quickly at the source level when parsing STABS
3084 if (!N_INCL_indexes.empty()) {
3085 symbol_ptr =
3086 symtab.SymbolAtIndex(N_INCL_indexes.back());
3087 symbol_ptr->SetByteSize(sym_idx + 1);
3088 symbol_ptr->SetSizeIsSibling(true);
3089 N_INCL_indexes.pop_back();
3090 }
3091 type = eSymbolTypeScopeEnd;
3092 break;
3093
3094 case N_SOL:
3095 // #included file name: name,,n_sect,0,address
3096 type = eSymbolTypeHeaderFile;
3097
3098 // We currently don't use the header files on darwin
3099 add_nlist = false;
3100 break;
3101
3102 case N_PARAMS:
3103 // compiler parameters: name,,NO_SECT,0,0
3104 type = eSymbolTypeCompiler;
3105 break;
3106
3107 case N_VERSION:
3108 // compiler version: name,,NO_SECT,0,0
3109 type = eSymbolTypeCompiler;
3110 break;
3111
3112 case N_OLEVEL:
3113 // compiler -O level: name,,NO_SECT,0,0
3114 type = eSymbolTypeCompiler;
3115 break;
3116
3117 case N_PSYM:
3118 // parameter: name,,NO_SECT,type,offset
3119 type = eSymbolTypeVariable;
3120 break;
3121
3122 case N_ENTRY:
3123 // alternate entry: name,,n_sect,linenumber,address
3124 symbol_section = section_info.GetSection(nlist.n_sect,
3125 nlist.n_value);
3126 type = eSymbolTypeLineEntry;
3127 break;
3128
3129 // Left and Right Braces
3130 case N_LBRAC:
3131 // left bracket: 0,,NO_SECT,nesting level,address We
3132 // use the current number of symbols in the symbol
3133 // table in lieu of using nlist_idx in case we ever
3134 // start trimming entries out
3135 symbol_section = section_info.GetSection(nlist.n_sect,
3136 nlist.n_value);
3137 N_BRAC_indexes.push_back(sym_idx);
3138 type = eSymbolTypeScopeBegin;
3139 break;
3140
3141 case N_RBRAC:
3142 // right bracket: 0,,NO_SECT,nesting level,address
3143 // Set the size of the N_LBRAC to the terminating
3144 // index of this N_RBRAC so that we can always skip
3145 // the entire symbol if we need to navigate more
3146 // quickly at the source level when parsing STABS
3147 symbol_section = section_info.GetSection(nlist.n_sect,
3148 nlist.n_value);
3149 if (!N_BRAC_indexes.empty()) {
3150 symbol_ptr =
3151 symtab.SymbolAtIndex(N_BRAC_indexes.back());
3152 symbol_ptr->SetByteSize(sym_idx + 1);
3153 symbol_ptr->SetSizeIsSibling(true);
3154 N_BRAC_indexes.pop_back();
3155 }
3156 type = eSymbolTypeScopeEnd;
3157 break;
3158
3159 case N_EXCL:
3160 // deleted include file: name,,NO_SECT,0,sum
3161 type = eSymbolTypeHeaderFile;
3162 break;
3163
3164 // COMM scopes
3165 case N_BCOMM:
3166 // begin common: name,,NO_SECT,0,0
3167 // We use the current number of symbols in the symbol
3168 // table in lieu of using nlist_idx in case we ever
3169 // start trimming entries out
3170 type = eSymbolTypeScopeBegin;
3171 N_COMM_indexes.push_back(sym_idx);
3172 break;
3173
3174 case N_ECOML:
3175 // end common (local name): 0,,n_sect,0,address
3176 symbol_section = section_info.GetSection(nlist.n_sect,
3177 nlist.n_value);
3178 // Fall through
3179
3180 case N_ECOMM:
3181 // end common: name,,n_sect,0,0
3182 // Set the size of the N_BCOMM to the terminating
3183 // index of this N_ECOMM/N_ECOML so that we can
3184 // always skip the entire symbol if we need to
3185 // navigate more quickly at the source level when
3186 // parsing STABS
3187 if (!N_COMM_indexes.empty()) {
3188 symbol_ptr =
3189 symtab.SymbolAtIndex(N_COMM_indexes.back());
3190 symbol_ptr->SetByteSize(sym_idx + 1);
3191 symbol_ptr->SetSizeIsSibling(true);
3192 N_COMM_indexes.pop_back();
3193 }
3194 type = eSymbolTypeScopeEnd;
3195 break;
3196
3197 case N_LENG:
3198 // second stab entry with length information
3199 type = eSymbolTypeAdditional;
3200 break;
3201
3202 default:
3203 break;
3204 }
3205 } else {
3206 // uint8_t n_pext = N_PEXT & nlist.n_type;
3207 uint8_t n_type = N_TYPE & nlist.n_type;
3208 sym[sym_idx].SetExternal((N_EXT & nlist.n_type) != 0);
3209
3210 switch (n_type) {
3211 case N_INDR: {
3212 const char *reexport_name_cstr =
3213 strtab_data.PeekCStr(nlist.n_value);
3214 if (reexport_name_cstr && reexport_name_cstr[0]) {
3215 type = eSymbolTypeReExported;
3216 ConstString reexport_name(
3217 reexport_name_cstr +
3218 ((reexport_name_cstr[0] == '_') ? 1 : 0));
3219 sym[sym_idx].SetReExportedSymbolName(reexport_name);
3220 set_value = false;
3221 reexport_shlib_needs_fixup[sym_idx] = reexport_name;
3222 indirect_symbol_names.insert(ConstString(
3223 symbol_name + ((symbol_name[0] == '_') ? 1 : 0)));
3224 } else
3225 type = eSymbolTypeUndefined;
3226 } break;
3227
3228 case N_UNDF:
3229 if (symbol_name && symbol_name[0]) {
3230 ConstString undefined_name(
3231 symbol_name + ((symbol_name[0] == '_') ? 1 : 0));
3232 undefined_name_to_desc[undefined_name] = nlist.n_desc;
3233 }
3234 // Fall through
3235 case N_PBUD:
3236 type = eSymbolTypeUndefined;
3237 break;
3238
3239 case N_ABS:
3240 type = eSymbolTypeAbsolute;
3241 break;
3242
3243 case N_SECT: {
3244 symbol_section = section_info.GetSection(nlist.n_sect,
3245 nlist.n_value);
3246
3247 if (symbol_section == NULL) {
3248 // TODO: warn about this?
3249 add_nlist = false;
3250 break;
3251 }
3252
3253 if (TEXT_eh_frame_sectID == nlist.n_sect) {
3254 type = eSymbolTypeException;
3255 } else {
3256 uint32_t section_type =
3257 symbol_section->Get() & SECTION_TYPE;
3258
3259 switch (section_type) {
3260 case S_CSTRING_LITERALS:
3261 type = eSymbolTypeData;
3262 break; // section with only literal C strings
3263 case S_4BYTE_LITERALS:
3264 type = eSymbolTypeData;
3265 break; // section with only 4 byte literals
3266 case S_8BYTE_LITERALS:
3267 type = eSymbolTypeData;
3268 break; // section with only 8 byte literals
3269 case S_LITERAL_POINTERS:
3270 type = eSymbolTypeTrampoline;
3271 break; // section with only pointers to literals
3272 case S_NON_LAZY_SYMBOL_POINTERS:
3273 type = eSymbolTypeTrampoline;
3274 break; // section with only non-lazy symbol
3275 // pointers
3276 case S_LAZY_SYMBOL_POINTERS:
3277 type = eSymbolTypeTrampoline;
3278 break; // section with only lazy symbol pointers
3279 case S_SYMBOL_STUBS:
3280 type = eSymbolTypeTrampoline;
3281 break; // section with only symbol stubs, byte
3282 // size of stub in the reserved2 field
3283 case S_MOD_INIT_FUNC_POINTERS:
3284 type = eSymbolTypeCode;
3285 break; // section with only function pointers for
3286 // initialization
3287 case S_MOD_TERM_FUNC_POINTERS:
3288 type = eSymbolTypeCode;
3289 break; // section with only function pointers for
3290 // termination
3291 case S_INTERPOSING:
3292 type = eSymbolTypeTrampoline;
3293 break; // section with only pairs of function
3294 // pointers for interposing
3295 case S_16BYTE_LITERALS:
3296 type = eSymbolTypeData;
3297 break; // section with only 16 byte literals
3298 case S_DTRACE_DOF:
3300 break;
3301 case S_LAZY_DYLIB_SYMBOL_POINTERS:
3302 type = eSymbolTypeTrampoline;
3303 break;
3304 default:
3305 switch (symbol_section->GetType()) {
3307 type = eSymbolTypeCode;
3308 break;
3309 case eSectionTypeData:
3310 case eSectionTypeDataCString: // Inlined C string
3311 // data
3312 case eSectionTypeDataCStringPointers: // Pointers
3313 // to C
3314 // string
3315 // data
3316 case eSectionTypeDataSymbolAddress: // Address of
3317 // a symbol in
3318 // the symbol
3319 // table
3320 case eSectionTypeData4:
3321 case eSectionTypeData8:
3322 case eSectionTypeData16:
3323 type = eSymbolTypeData;
3324 break;
3325 default:
3326 break;
3327 }
3328 break;
3329 }
3330
3331 if (type == eSymbolTypeInvalid) {
3332 const char *symbol_sect_name =
3333 symbol_section->GetName().AsCString(nullptr);
3334 if (symbol_section->IsDescendant(
3335 text_section_sp.get())) {
3336 if (symbol_section->IsClear(
3337 S_ATTR_PURE_INSTRUCTIONS |
3338 S_ATTR_SELF_MODIFYING_CODE |
3339 S_ATTR_SOME_INSTRUCTIONS))
3340 type = eSymbolTypeData;
3341 else
3342 type = eSymbolTypeCode;
3343 } else if (symbol_section->IsDescendant(
3344 data_section_sp.get()) ||
3345 symbol_section->IsDescendant(
3346 data_dirty_section_sp.get()) ||
3347 symbol_section->IsDescendant(
3348 data_const_section_sp.get())) {
3349 if (symbol_sect_name &&
3350 ::strstr(symbol_sect_name, "__objc") ==
3351 symbol_sect_name) {
3352 type = eSymbolTypeRuntime;
3353
3355 symbol_name,
3356 symbol_name_non_abi_mangled, type))
3357 demangled_is_synthesized = true;
3358 } else if (symbol_sect_name &&
3359 ::strstr(symbol_sect_name,
3360 "__gcc_except_tab") ==
3361 symbol_sect_name) {
3362 type = eSymbolTypeException;
3363 } else {
3364 type = eSymbolTypeData;
3365 }
3366 } else if (symbol_sect_name &&
3367 ::strstr(symbol_sect_name, "__IMPORT") ==
3368 symbol_sect_name) {
3369 type = eSymbolTypeTrampoline;
3370 } else if (symbol_section->IsDescendant(
3371 objc_section_sp.get())) {
3372 type = eSymbolTypeRuntime;
3373 if (symbol_name && symbol_name[0] == '.') {
3374 llvm::StringRef symbol_name_ref(symbol_name);
3375 llvm::StringRef
3376 g_objc_v1_prefix_class(".objc_class_name_");
3377 if (symbol_name_ref.starts_with(
3378 g_objc_v1_prefix_class)) {
3379 symbol_name_non_abi_mangled = symbol_name;
3380 symbol_name = symbol_name +
3381 g_objc_v1_prefix_class.size();
3382 type = eSymbolTypeObjCClass;
3383 demangled_is_synthesized = true;
3384 }
3385 }
3386 }
3387 }
3388 }
3389 } break;
3390 }
3391 }
3392
3393 if (add_nlist) {
3394 uint64_t symbol_value = nlist.n_value;
3395 if (symbol_name_non_abi_mangled) {
3396 sym[sym_idx].GetMangled().SetMangledName(
3397 ConstString(symbol_name_non_abi_mangled));
3398 sym[sym_idx].GetMangled().SetDemangledName(
3399 ConstString(symbol_name));
3400 } else {
3401 if (symbol_name && symbol_name[0] == '_') {
3402 symbol_name++; // Skip the leading underscore
3403 }
3404
3405 if (symbol_name) {
3406 ConstString const_symbol_name(symbol_name);
3407 sym[sym_idx].GetMangled().SetValue(const_symbol_name);
3408 if (is_gsym && is_debug) {
3409 const char *gsym_name =
3410 sym[sym_idx]
3411 .GetMangled()
3413 .GetCString();
3414 if (gsym_name)
3415 N_GSYM_name_to_sym_idx[gsym_name] = sym_idx;
3416 }
3417 }
3418 }
3419 if (symbol_section) {
3420 const addr_t section_file_addr =
3421 symbol_section->GetFileAddress();
3422 symbol_value -= section_file_addr;
3423 }
3424
3425 if (is_debug == false) {
3426 if (type == eSymbolTypeCode) {
3427 // See if we can find a N_FUN entry for any code
3428 // symbols. If we do find a match, and the name
3429 // matches, then we can merge the two into just the
3430 // function symbol to avoid duplicate entries in
3431 // the symbol table
3432 auto range =
3433 N_FUN_addr_to_sym_idx.equal_range(nlist.n_value);
3434 if (range.first != range.second) {
3435 bool found_it = false;
3436 for (auto pos = range.first; pos != range.second;
3437 ++pos) {
3438 if (sym[sym_idx].GetMangled().GetName(
3440 sym[pos->second].GetMangled().GetName(
3442 m_nlist_idx_to_sym_idx[nlist_idx] = pos->second;
3443 // We just need the flags from the linker
3444 // symbol, so put these flags
3445 // into the N_FUN flags to avoid duplicate
3446 // symbols in the symbol table
3447 sym[pos->second].SetExternal(
3448 sym[sym_idx].IsExternal());
3449 sym[pos->second].SetFlags(nlist.n_type << 16 |
3450 nlist.n_desc);
3451 if (resolver_addresses.find(nlist.n_value) !=
3452 resolver_addresses.end())
3453 sym[pos->second].SetType(eSymbolTypeResolver);
3454 sym[sym_idx].Clear();
3455 found_it = true;
3456 break;
3457 }
3458 }
3459 if (found_it)
3460 continue;
3461 } else {
3462 if (resolver_addresses.find(nlist.n_value) !=
3463 resolver_addresses.end())
3464 type = eSymbolTypeResolver;
3465 }
3466 } else if (type == eSymbolTypeData ||
3467 type == eSymbolTypeObjCClass ||
3468 type == eSymbolTypeObjCMetaClass ||
3469 type == eSymbolTypeObjCIVar) {
3470 // See if we can find a N_STSYM entry for any data
3471 // symbols. If we do find a match, and the name
3472 // matches, then we can merge the two into just the
3473 // Static symbol to avoid duplicate entries in the
3474 // symbol table
3475 auto range = N_STSYM_addr_to_sym_idx.equal_range(
3476 nlist.n_value);
3477 if (range.first != range.second) {
3478 bool found_it = false;
3479 for (auto pos = range.first; pos != range.second;
3480 ++pos) {
3481 if (sym[sym_idx].GetMangled().GetName(
3483 sym[pos->second].GetMangled().GetName(
3485 m_nlist_idx_to_sym_idx[nlist_idx] = pos->second;
3486 // We just need the flags from the linker
3487 // symbol, so put these flags
3488 // into the N_STSYM flags to avoid duplicate
3489 // symbols in the symbol table
3490 sym[pos->second].SetExternal(
3491 sym[sym_idx].IsExternal());
3492 sym[pos->second].SetFlags(nlist.n_type << 16 |
3493 nlist.n_desc);
3494 sym[sym_idx].Clear();
3495 found_it = true;
3496 break;
3497 }
3498 }
3499 if (found_it)
3500 continue;
3501 } else {
3502 const char *gsym_name =
3503 sym[sym_idx]
3504 .GetMangled()
3506 .GetCString();
3507 if (gsym_name) {
3508 // Combine N_GSYM stab entries with the non
3509 // stab symbol
3510 ConstNameToSymbolIndexMap::const_iterator pos =
3511 N_GSYM_name_to_sym_idx.find(gsym_name);
3512 if (pos != N_GSYM_name_to_sym_idx.end()) {
3513 const uint32_t GSYM_sym_idx = pos->second;
3514 m_nlist_idx_to_sym_idx[nlist_idx] =
3515 GSYM_sym_idx;
3516 // Copy the address, because often the N_GSYM
3517 // address has an invalid address of zero
3518 // when the global is a common symbol
3519 sym[GSYM_sym_idx].GetAddressRef() =
3520 Address(symbol_section, symbol_value);
3521 add_symbol_addr(sym[GSYM_sym_idx]
3522 .GetAddress()
3523 .GetFileAddress());
3524 // We just need the flags from the linker
3525 // symbol, so put these flags
3526 // into the N_GSYM flags to avoid duplicate
3527 // symbols in the symbol table
3528 sym[GSYM_sym_idx].SetFlags(nlist.n_type << 16 |
3529 nlist.n_desc);
3530 sym[sym_idx].Clear();
3531 continue;
3532 }
3533 }
3534 }
3535 }
3536 }
3537
3538 sym[sym_idx].SetID(nlist_idx);
3539 sym[sym_idx].SetType(type);
3540 if (set_value) {
3541 sym[sym_idx].GetAddressRef() =
3542 Address(symbol_section, symbol_value);
3543 add_symbol_addr(
3544 sym[sym_idx].GetAddress().GetFileAddress());
3545 }
3546 sym[sym_idx].SetFlags(nlist.n_type << 16 | nlist.n_desc);
3547
3548 if (demangled_is_synthesized)
3549 sym[sym_idx].SetDemangledNameIsSynthesized(true);
3550 ++sym_idx;
3551 } else {
3552 sym[sym_idx].Clear();
3553 }
3554 }
3555 /////////////////////////////
3556 }
3557 }
3558
3559 for (const auto &pos : reexport_shlib_needs_fixup) {
3560 const auto undef_pos = undefined_name_to_desc.find(pos.second);
3561 if (undef_pos != undefined_name_to_desc.end()) {
3562 const uint8_t dylib_ordinal =
3563 llvm::MachO::GET_LIBRARY_ORDINAL(undef_pos->second);
3564 if (dylib_ordinal > 0 && dylib_ordinal < dylib_files.GetSize())
3565 sym[pos.first].SetReExportedSymbolSharedLibrary(
3566 dylib_files.GetFileSpecAtIndex(dylib_ordinal - 1));
3567 }
3568 }
3569 }
3570
3571#endif
3572 lldb::offset_t nlist_data_offset = 0;
3573
3574 if (nlist_data.GetByteSize() > 0) {
3575
3576 // If the sym array was not created while parsing the DSC unmapped
3577 // symbols, create it now.
3578 if (sym == nullptr) {
3579 sym =
3580 symtab.Resize(symtab_load_command.nsyms + m_dysymtab.nindirectsyms);
3581 num_syms = symtab.GetNumSymbols();
3582 }
3583
3584 if (unmapped_local_symbols_found) {
3585 assert(m_dysymtab.ilocalsym == 0);
3586 nlist_data_offset += (m_dysymtab.nlocalsym * nlist_byte_size);
3587 nlist_idx = m_dysymtab.nlocalsym;
3588 } else {
3589 nlist_idx = 0;
3590 }
3591
3592 typedef llvm::DenseMap<ConstString, uint16_t> UndefinedNameToDescMap;
3593 typedef llvm::DenseMap<uint32_t, ConstString> SymbolIndexToName;
3594 UndefinedNameToDescMap undefined_name_to_desc;
3595 SymbolIndexToName reexport_shlib_needs_fixup;
3596
3597 // Symtab parsing is a huge mess. Everything is entangled and the code
3598 // requires access to a ridiculous amount of variables. LLDB depends
3599 // heavily on the proper merging of symbols and to get that right we need
3600 // to make sure we have parsed all the debug symbols first. Therefore we
3601 // invoke the lambda twice, once to parse only the debug symbols and then
3602 // once more to parse the remaining symbols.
3603 auto ParseSymbolLambda = [&](struct nlist_64 &nlist, uint32_t nlist_idx,
3604 bool debug_only) {
3605 const bool is_debug = ((nlist.n_type & N_STAB) != 0);
3606 if (is_debug != debug_only)
3607 return true;
3608
3609 const char *symbol_name_non_abi_mangled = nullptr;
3610 const char *symbol_name = nullptr;
3611
3612 if (have_strtab_data) {
3613 symbol_name = strtab_data.PeekCStr(nlist.n_strx);
3614
3615 if (symbol_name == nullptr) {
3616 // No symbol should be NULL, even the symbols with no string values
3617 // should have an offset zero which points to an empty C-string
3618 Debugger::ReportError(llvm::formatv(
3619 "symbol[{0}] has invalid string table offset {1:x} in {2}, "
3620 "ignoring symbol",
3621 nlist_idx, nlist.n_strx, module_sp->GetFileSpec().GetPath()));
3622 return true;
3623 }
3624 if (symbol_name[0] == '\0')
3625 symbol_name = nullptr;
3626 } else {
3627 const addr_t str_addr = strtab_addr + nlist.n_strx;
3628 Status str_error;
3629 if (process->ReadCStringFromMemory(str_addr, memory_symbol_name,
3630 str_error))
3631 symbol_name = memory_symbol_name.c_str();
3632 }
3633
3635 SectionSP symbol_section;
3636 bool add_nlist = true;
3637 bool is_gsym = false;
3638 bool demangled_is_synthesized = false;
3639 bool set_value = true;
3640
3641 assert(sym_idx < num_syms);
3642 sym[sym_idx].SetDebug(is_debug);
3643
3644 if (is_debug) {
3645 switch (nlist.n_type) {
3646 case N_GSYM: {
3647 // global symbol: name,,NO_SECT,type,0
3648 // Sometimes the N_GSYM value contains the address.
3649
3650 // FIXME: In the .o files, we have a GSYM and a debug symbol for all
3651 // the ObjC data. They
3652 // have the same address, but we want to ensure that we always find
3653 // only the real symbol, 'cause we don't currently correctly
3654 // attribute the GSYM one to the ObjCClass/Ivar/MetaClass symbol
3655 // type. This is a temporary hack to make sure the ObjectiveC
3656 // symbols get treated correctly. To do this right, we should
3657 // coalesce all the GSYM & global symbols that have the same
3658 // address.
3659 is_gsym = true;
3660 sym[sym_idx].SetExternal(true);
3661
3662 if (TryParseV2ObjCMetadataSymbol(symbol_name,
3663 symbol_name_non_abi_mangled, type)) {
3664 demangled_is_synthesized = true;
3665 } else {
3666 if (nlist.n_value != 0)
3667 symbol_section =
3668 section_info.GetSection(nlist.n_sect, nlist.n_value);
3669
3670 type = eSymbolTypeData;
3671 }
3672 } break;
3673
3674 case N_FNAME:
3675 // procedure name (f77 kludge): name,,NO_SECT,0,0
3676 type = eSymbolTypeCompiler;
3677 break;
3678
3679 case N_FUN:
3680 // procedure: name,,n_sect,linenumber,address
3681 if (symbol_name) {
3682 type = eSymbolTypeCode;
3683 symbol_section =
3684 section_info.GetSection(nlist.n_sect, nlist.n_value);
3685
3686 N_FUN_addr_to_sym_idx.insert(
3687 std::make_pair(nlist.n_value, sym_idx));
3688 // We use the current number of symbols in the symbol table in
3689 // lieu of using nlist_idx in case we ever start trimming entries
3690 // out
3691 N_FUN_indexes.push_back(sym_idx);
3692 } else {
3693 type = eSymbolTypeCompiler;
3694
3695 if (!N_FUN_indexes.empty()) {
3696 // Copy the size of the function into the original STAB entry
3697 // so we don't have to hunt for it later
3698 symtab.SymbolAtIndex(N_FUN_indexes.back())
3699 ->SetByteSize(nlist.n_value);
3700 N_FUN_indexes.pop_back();
3701 // We don't really need the end function STAB as it contains
3702 // the size which we already placed with the original symbol,
3703 // so don't add it if we want a minimal symbol table
3704 add_nlist = false;
3705 }
3706 }
3707 break;
3708
3709 case N_STSYM:
3710 // static symbol: name,,n_sect,type,address
3711 N_STSYM_addr_to_sym_idx.insert(
3712 std::make_pair(nlist.n_value, sym_idx));
3713 symbol_section = section_info.GetSection(nlist.n_sect, nlist.n_value);
3714 if (symbol_name && symbol_name[0]) {
3715 type = ObjectFile::GetSymbolTypeFromName(symbol_name + 1,
3717 }
3718 break;
3719
3720 case N_LCSYM:
3721 // .lcomm symbol: name,,n_sect,type,address
3722 symbol_section = section_info.GetSection(nlist.n_sect, nlist.n_value);
3724 break;
3725
3726 case N_BNSYM:
3727 // We use the current number of symbols in the symbol table in lieu
3728 // of using nlist_idx in case we ever start trimming entries out
3729 // Skip these if we want minimal symbol tables
3730 add_nlist = false;
3731 break;
3732
3733 case N_ENSYM:
3734 // Set the size of the N_BNSYM to the terminating index of this
3735 // N_ENSYM so that we can always skip the entire symbol if we need
3736 // to navigate more quickly at the source level when parsing STABS
3737 // Skip these if we want minimal symbol tables
3738 add_nlist = false;
3739 break;
3740
3741 case N_OPT:
3742 // emitted with gcc2_compiled and in gcc source
3743 type = eSymbolTypeCompiler;
3744 break;
3745
3746 case N_RSYM:
3747 // register sym: name,,NO_SECT,type,register
3748 type = eSymbolTypeVariable;
3749 break;
3750
3751 case N_SLINE:
3752 // src line: 0,,n_sect,linenumber,address
3753 symbol_section = section_info.GetSection(nlist.n_sect, nlist.n_value);
3754 type = eSymbolTypeLineEntry;
3755 break;
3756
3757 case N_SSYM:
3758 // structure elt: name,,NO_SECT,type,struct_offset
3760 break;
3761
3762 case N_SO:
3763 // source file name
3764 type = eSymbolTypeSourceFile;
3765 if (symbol_name == nullptr) {
3766 add_nlist = false;
3767 if (N_SO_index != UINT32_MAX) {
3768 // Set the size of the N_SO to the terminating index of this
3769 // N_SO so that we can always skip the entire N_SO if we need
3770 // to navigate more quickly at the source level when parsing
3771 // STABS
3772 symbol_ptr = symtab.SymbolAtIndex(N_SO_index);
3773 symbol_ptr->SetByteSize(sym_idx);
3774 symbol_ptr->SetSizeIsSibling(true);
3775 }
3776 N_NSYM_indexes.clear();
3777 N_INCL_indexes.clear();
3778 N_BRAC_indexes.clear();
3779 N_COMM_indexes.clear();
3780 N_FUN_indexes.clear();
3781 N_SO_index = UINT32_MAX;
3782 } else {
3783 // We use the current number of symbols in the symbol table in
3784 // lieu of using nlist_idx in case we ever start trimming entries
3785 // out
3786 const bool N_SO_has_full_path = symbol_name[0] == '/';
3787 if (N_SO_has_full_path) {
3788 if ((N_SO_index == sym_idx - 1) && ((sym_idx - 1) < num_syms)) {
3789 // We have two consecutive N_SO entries where the first
3790 // contains a directory and the second contains a full path.
3791 sym[sym_idx - 1].GetMangled().SetValue(
3792 ConstString(symbol_name));
3793 m_nlist_idx_to_sym_idx[nlist_idx] = sym_idx - 1;
3794 add_nlist = false;
3795 } else {
3796 // This is the first entry in a N_SO that contains a
3797 // directory or a full path to the source file
3798 N_SO_index = sym_idx;
3799 }
3800 } else if ((N_SO_index == sym_idx - 1) &&
3801 ((sym_idx - 1) < num_syms)) {
3802 // This is usually the second N_SO entry that contains just the
3803 // filename, so here we combine it with the first one if we are
3804 // minimizing the symbol table
3805 llvm::StringRef so_path = sym[sym_idx - 1]
3806 .GetMangled()
3808 .GetStringRef();
3809 if (!so_path.empty()) {
3810 std::string full_so_path(so_path);
3811 const size_t double_slash_pos = full_so_path.find("//");
3812 if (double_slash_pos != std::string::npos) {
3813 // The linker has been generating bad N_SO entries with
3814 // doubled up paths in the format "%s%s" where the first
3815 // string in the DW_AT_comp_dir, and the second is the
3816 // directory for the source file so you end up with a path
3817 // that looks like "/tmp/src//tmp/src/"
3818 FileSpec so_dir(so_path);
3819 if (!FileSystem::Instance().Exists(so_dir)) {
3820 so_dir.SetFile(&full_so_path[double_slash_pos + 1],
3821 FileSpec::Style::native);
3822 if (FileSystem::Instance().Exists(so_dir)) {
3823 // Trim off the incorrect path
3824 full_so_path.erase(0, double_slash_pos + 1);
3825 }
3826 }
3827 }
3828 if (*full_so_path.rbegin() != '/')
3829 full_so_path += '/';
3830 full_so_path += symbol_name;
3831 sym[sym_idx - 1].GetMangled().SetValue(
3832 ConstString(full_so_path.c_str()));
3833 add_nlist = false;
3834 m_nlist_idx_to_sym_idx[nlist_idx] = sym_idx - 1;
3835 }
3836 } else {
3837 // This could be a relative path to a N_SO
3838 N_SO_index = sym_idx;
3839 }
3840 }
3841 break;
3842
3843 case N_OSO:
3844 // object file name: name,,0,0,st_mtime
3845 type = eSymbolTypeObjectFile;
3846 break;
3847
3848 case N_LSYM:
3849 // local sym: name,,NO_SECT,type,offset
3850 type = eSymbolTypeLocal;
3851 break;
3852
3853 // INCL scopes
3854 case N_BINCL:
3855 // include file beginning: name,,NO_SECT,0,sum We use the current
3856 // number of symbols in the symbol table in lieu of using nlist_idx
3857 // in case we ever start trimming entries out
3858 N_INCL_indexes.push_back(sym_idx);
3859 type = eSymbolTypeScopeBegin;
3860 break;
3861
3862 case N_EINCL:
3863 // include file end: name,,NO_SECT,0,0
3864 // Set the size of the N_BINCL to the terminating index of this
3865 // N_EINCL so that we can always skip the entire symbol if we need
3866 // to navigate more quickly at the source level when parsing STABS
3867 if (!N_INCL_indexes.empty()) {
3868 symbol_ptr = symtab.SymbolAtIndex(N_INCL_indexes.back());
3869 symbol_ptr->SetByteSize(sym_idx + 1);
3870 symbol_ptr->SetSizeIsSibling(true);
3871 N_INCL_indexes.pop_back();
3872 }
3873 type = eSymbolTypeScopeEnd;
3874 break;
3875
3876 case N_SOL:
3877 // #included file name: name,,n_sect,0,address
3878 type = eSymbolTypeHeaderFile;
3879
3880 // We currently don't use the header files on darwin
3881 add_nlist = false;
3882 break;
3883
3884 case N_PARAMS:
3885 // compiler parameters: name,,NO_SECT,0,0
3886 type = eSymbolTypeCompiler;
3887 break;
3888
3889 case N_VERSION:
3890 // compiler version: name,,NO_SECT,0,0
3891 type = eSymbolTypeCompiler;
3892 break;
3893
3894 case N_OLEVEL:
3895 // compiler -O level: name,,NO_SECT,0,0
3896 type = eSymbolTypeCompiler;
3897 break;
3898
3899 case N_PSYM:
3900 // parameter: name,,NO_SECT,type,offset
3901 type = eSymbolTypeVariable;
3902 break;
3903
3904 case N_ENTRY:
3905 // alternate entry: name,,n_sect,linenumber,address
3906 symbol_section = section_info.GetSection(nlist.n_sect, nlist.n_value);
3907 type = eSymbolTypeLineEntry;
3908 break;
3909
3910 // Left and Right Braces
3911 case N_LBRAC:
3912 // left bracket: 0,,NO_SECT,nesting level,address We use the
3913 // current number of symbols in the symbol table in lieu of using
3914 // nlist_idx in case we ever start trimming entries out
3915 symbol_section = section_info.GetSection(nlist.n_sect, nlist.n_value);
3916 N_BRAC_indexes.push_back(sym_idx);
3917 type = eSymbolTypeScopeBegin;
3918 break;
3919
3920 case N_RBRAC:
3921 // right bracket: 0,,NO_SECT,nesting level,address Set the size of
3922 // the N_LBRAC to the terminating index of this N_RBRAC so that we
3923 // can always skip the entire symbol if we need to navigate more
3924 // quickly at the source level when parsing STABS
3925 symbol_section = section_info.GetSection(nlist.n_sect, nlist.n_value);
3926 if (!N_BRAC_indexes.empty()) {
3927 symbol_ptr = symtab.SymbolAtIndex(N_BRAC_indexes.back());
3928 symbol_ptr->SetByteSize(sym_idx + 1);
3929 symbol_ptr->SetSizeIsSibling(true);
3930 N_BRAC_indexes.pop_back();
3931 }
3932 type = eSymbolTypeScopeEnd;
3933 break;
3934
3935 case N_EXCL:
3936 // deleted include file: name,,NO_SECT,0,sum
3937 type = eSymbolTypeHeaderFile;
3938 break;
3939
3940 // COMM scopes
3941 case N_BCOMM:
3942 // begin common: name,,NO_SECT,0,0
3943 // We use the current number of symbols in the symbol table in lieu
3944 // of using nlist_idx in case we ever start trimming entries out
3945 type = eSymbolTypeScopeBegin;
3946 N_COMM_indexes.push_back(sym_idx);
3947 break;
3948
3949 case N_ECOML:
3950 // end common (local name): 0,,n_sect,0,address
3951 symbol_section = section_info.GetSection(nlist.n_sect, nlist.n_value);
3952 [[fallthrough]];
3953
3954 case N_ECOMM:
3955 // end common: name,,n_sect,0,0
3956 // Set the size of the N_BCOMM to the terminating index of this
3957 // N_ECOMM/N_ECOML so that we can always skip the entire symbol if
3958 // we need to navigate more quickly at the source level when
3959 // parsing STABS
3960 if (!N_COMM_indexes.empty()) {
3961 symbol_ptr = symtab.SymbolAtIndex(N_COMM_indexes.back());
3962 symbol_ptr->SetByteSize(sym_idx + 1);
3963 symbol_ptr->SetSizeIsSibling(true);
3964 N_COMM_indexes.pop_back();
3965 }
3966 type = eSymbolTypeScopeEnd;
3967 break;
3968
3969 case N_LENG:
3970 // second stab entry with length information
3971 type = eSymbolTypeAdditional;
3972 break;
3973
3974 default:
3975 break;
3976 }
3977 } else {
3978 uint8_t n_type = N_TYPE & nlist.n_type;
3979 sym[sym_idx].SetExternal((N_EXT & nlist.n_type) != 0);
3980
3981 switch (n_type) {
3982 case N_INDR: {
3983 const char *reexport_name_cstr = strtab_data.PeekCStr(nlist.n_value);
3984 if (reexport_name_cstr && reexport_name_cstr[0] && symbol_name) {
3985 type = eSymbolTypeReExported;
3986 ConstString reexport_name(reexport_name_cstr +
3987 ((reexport_name_cstr[0] == '_') ? 1 : 0));
3988 sym[sym_idx].SetReExportedSymbolName(reexport_name);
3989 set_value = false;
3990 reexport_shlib_needs_fixup[sym_idx] = reexport_name;
3991 indirect_symbol_names.insert(
3992 ConstString(symbol_name + ((symbol_name[0] == '_') ? 1 : 0)));
3993 } else
3994 type = eSymbolTypeUndefined;
3995 } break;
3996
3997 case N_UNDF:
3998 if (symbol_name && symbol_name[0]) {
3999 ConstString undefined_name(symbol_name +
4000 ((symbol_name[0] == '_') ? 1 : 0));
4001 undefined_name_to_desc[undefined_name] = nlist.n_desc;
4002 }
4003 [[fallthrough]];
4004
4005 case N_PBUD:
4006 type = eSymbolTypeUndefined;
4007 break;
4008
4009 case N_ABS:
4010 type = eSymbolTypeAbsolute;
4011 break;
4012
4013 case N_SECT: {
4014 symbol_section = section_info.GetSection(nlist.n_sect, nlist.n_value);
4015
4016 if (!symbol_section) {
4017 // TODO: warn about this?
4018 add_nlist = false;
4019 break;
4020 }
4021
4022 if (TEXT_eh_frame_sectID == nlist.n_sect) {
4023 type = eSymbolTypeException;
4024 } else {
4025 uint32_t section_type = symbol_section->Get() & SECTION_TYPE;
4026
4027 switch (section_type) {
4028 case S_CSTRING_LITERALS:
4029 type = eSymbolTypeData;
4030 break; // section with only literal C strings
4031 case S_4BYTE_LITERALS:
4032 type = eSymbolTypeData;
4033 break; // section with only 4 byte literals
4034 case S_8BYTE_LITERALS:
4035 type = eSymbolTypeData;
4036 break; // section with only 8 byte literals
4037 case S_LITERAL_POINTERS:
4038 type = eSymbolTypeTrampoline;
4039 break; // section with only pointers to literals
4040 case S_NON_LAZY_SYMBOL_POINTERS:
4041 type = eSymbolTypeTrampoline;
4042 break; // section with only non-lazy symbol pointers
4043 case S_LAZY_SYMBOL_POINTERS:
4044 type = eSymbolTypeTrampoline;
4045 break; // section with only lazy symbol pointers
4046 case S_SYMBOL_STUBS:
4047 type = eSymbolTypeTrampoline;
4048 break; // section with only symbol stubs, byte size of stub in
4049 // the reserved2 field
4050 case S_MOD_INIT_FUNC_POINTERS:
4051 type = eSymbolTypeCode;
4052 break; // section with only function pointers for initialization
4053 case S_MOD_TERM_FUNC_POINTERS:
4054 type = eSymbolTypeCode;
4055 break; // section with only function pointers for termination
4056 case S_INTERPOSING:
4057 type = eSymbolTypeTrampoline;
4058 break; // section with only pairs of function pointers for
4059 // interposing
4060 case S_16BYTE_LITERALS:
4061 type = eSymbolTypeData;
4062 break; // section with only 16 byte literals
4063 case S_DTRACE_DOF:
4065 break;
4066 case S_LAZY_DYLIB_SYMBOL_POINTERS:
4067 type = eSymbolTypeTrampoline;
4068 break;
4069 default:
4070 switch (symbol_section->GetType()) {
4072 type = eSymbolTypeCode;
4073 break;
4074 case eSectionTypeData:
4075 case eSectionTypeDataCString: // Inlined C string data
4076 case eSectionTypeDataCStringPointers: // Pointers to C string
4077 // data
4078 case eSectionTypeDataSymbolAddress: // Address of a symbol in
4079 // the symbol table
4080 case eSectionTypeData4:
4081 case eSectionTypeData8:
4082 case eSectionTypeData16:
4083 type = eSymbolTypeData;
4084 break;
4085 default:
4086 break;
4087 }
4088 break;
4089 }
4090
4091 if (type == eSymbolTypeInvalid) {
4092 const char *symbol_sect_name =
4093 symbol_section->GetName().AsCString(nullptr);
4094 if (symbol_section->IsDescendant(text_section_sp.get())) {
4095 if (symbol_section->IsClear(S_ATTR_PURE_INSTRUCTIONS |
4096 S_ATTR_SELF_MODIFYING_CODE |
4097 S_ATTR_SOME_INSTRUCTIONS))
4098 type = eSymbolTypeData;
4099 else
4100 type = eSymbolTypeCode;
4101 } else if (symbol_section->IsDescendant(data_section_sp.get()) ||
4102 symbol_section->IsDescendant(
4103 data_dirty_section_sp.get()) ||
4104 symbol_section->IsDescendant(
4105 data_const_section_sp.get())) {
4106 if (symbol_sect_name &&
4107 ::strstr(symbol_sect_name, "__objc") == symbol_sect_name) {
4108 type = eSymbolTypeRuntime;
4109
4111 symbol_name, symbol_name_non_abi_mangled, type))
4112 demangled_is_synthesized = true;
4113 } else if (symbol_sect_name &&
4114 ::strstr(symbol_sect_name, "__gcc_except_tab") ==
4115 symbol_sect_name) {
4116 type = eSymbolTypeException;
4117 } else {
4118 type = eSymbolTypeData;
4119 }
4120 } else if (symbol_sect_name &&
4121 ::strstr(symbol_sect_name, "__IMPORT") ==
4122 symbol_sect_name) {
4123 type = eSymbolTypeTrampoline;
4124 } else if (symbol_section->IsDescendant(objc_section_sp.get())) {
4125 type = eSymbolTypeRuntime;
4126 if (symbol_name && symbol_name[0] == '.') {
4127 llvm::StringRef symbol_name_ref(symbol_name);
4128 llvm::StringRef g_objc_v1_prefix_class(
4129 ".objc_class_name_");
4130 if (symbol_name_ref.starts_with(g_objc_v1_prefix_class)) {
4131 symbol_name_non_abi_mangled = symbol_name;
4132 symbol_name = symbol_name + g_objc_v1_prefix_class.size();
4133 type = eSymbolTypeObjCClass;
4134 demangled_is_synthesized = true;
4135 }
4136 }
4137 }
4138 }
4139 }
4140 } break;
4141 }
4142 }
4143
4144 if (!add_nlist) {
4145 sym[sym_idx].Clear();
4146 return true;
4147 }
4148
4149 uint64_t symbol_value = nlist.n_value;
4150
4151 if (symbol_name_non_abi_mangled) {
4152 sym[sym_idx].GetMangled().SetMangledName(
4153 ConstString(symbol_name_non_abi_mangled));
4154 sym[sym_idx].GetMangled().SetDemangledName(ConstString(symbol_name));
4155 } else {
4156
4157 if (symbol_name && symbol_name[0] == '_') {
4158 symbol_name++; // Skip the leading underscore
4159 }
4160
4161 if (symbol_name) {
4162 ConstString const_symbol_name(symbol_name);
4163 sym[sym_idx].GetMangled().SetValue(const_symbol_name);
4164 }
4165 }
4166
4167 if (is_gsym) {
4168 const char *gsym_name = sym[sym_idx]
4169 .GetMangled()
4171 .GetCString();
4172 if (gsym_name)
4173 N_GSYM_name_to_sym_idx[gsym_name] = sym_idx;
4174 }
4175
4176 if (symbol_section) {
4177 const addr_t section_file_addr = symbol_section->GetFileAddress();
4178 symbol_value -= section_file_addr;
4179 }
4180
4181 if (!is_debug) {
4182 if (type == eSymbolTypeCode) {
4183 // See if we can find a N_FUN entry for any code symbols. If we do
4184 // find a match, and the name matches, then we can merge the two into
4185 // just the function symbol to avoid duplicate entries in the symbol
4186 // table.
4187 std::pair<ValueToSymbolIndexMap::const_iterator,
4188 ValueToSymbolIndexMap::const_iterator>
4189 range;
4190 range = N_FUN_addr_to_sym_idx.equal_range(nlist.n_value);
4191 if (range.first != range.second) {
4192 for (ValueToSymbolIndexMap::const_iterator pos = range.first;
4193 pos != range.second; ++pos) {
4194 if (sym[sym_idx].GetMangled().GetName(Mangled::ePreferMangled) ==
4195 sym[pos->second].GetMangled().GetName(
4197 m_nlist_idx_to_sym_idx[nlist_idx] = pos->second;
4198 // We just need the flags from the linker symbol, so put these
4199 // flags into the N_FUN flags to avoid duplicate symbols in the
4200 // symbol table.
4201 sym[pos->second].SetExternal(sym[sym_idx].IsExternal());
4202 sym[pos->second].SetFlags(nlist.n_type << 16 | nlist.n_desc);
4203 if (resolver_addresses.find(nlist.n_value) !=
4204 resolver_addresses.end())
4205 sym[pos->second].SetType(eSymbolTypeResolver);
4206 sym[sym_idx].Clear();
4207 return true;
4208 }
4209 }
4210 } else {
4211 if (resolver_addresses.find(nlist.n_value) !=
4212 resolver_addresses.end())
4213 type = eSymbolTypeResolver;
4214 }
4215 } else if (type == eSymbolTypeData || type == eSymbolTypeObjCClass ||
4216 type == eSymbolTypeObjCMetaClass ||
4217 type == eSymbolTypeObjCIVar) {
4218 // See if we can find a N_STSYM entry for any data symbols. If we do
4219 // find a match, and the name matches, then we can merge the two into
4220 // just the Static symbol to avoid duplicate entries in the symbol
4221 // table.
4222 std::pair<ValueToSymbolIndexMap::const_iterator,
4223 ValueToSymbolIndexMap::const_iterator>
4224 range;
4225 range = N_STSYM_addr_to_sym_idx.equal_range(nlist.n_value);
4226 if (range.first != range.second) {
4227 for (ValueToSymbolIndexMap::const_iterator pos = range.first;
4228 pos != range.second; ++pos) {
4229 if (sym[sym_idx].GetMangled().GetName(Mangled::ePreferMangled) ==
4230 sym[pos->second].GetMangled().GetName(
4232 m_nlist_idx_to_sym_idx[nlist_idx] = pos->second;
4233 // We just need the flags from the linker symbol, so put these
4234 // flags into the N_STSYM flags to avoid duplicate symbols in
4235 // the symbol table.
4236 sym[pos->second].SetExternal(sym[sym_idx].IsExternal());
4237 sym[pos->second].SetFlags(nlist.n_type << 16 | nlist.n_desc);
4238 sym[sym_idx].Clear();
4239 return true;
4240 }
4241 }
4242 } else {
4243 // Combine N_GSYM stab entries with the non stab symbol.
4244 const char *gsym_name = sym[sym_idx]
4245 .GetMangled()
4247 .GetCString();
4248 if (gsym_name) {
4249 ConstNameToSymbolIndexMap::const_iterator pos =
4250 N_GSYM_name_to_sym_idx.find(gsym_name);
4251 if (pos != N_GSYM_name_to_sym_idx.end()) {
4252 const uint32_t GSYM_sym_idx = pos->second;
4253 m_nlist_idx_to_sym_idx[nlist_idx] = GSYM_sym_idx;
4254 // Copy the address, because often the N_GSYM address has an
4255 // invalid address of zero when the global is a common symbol.
4256 sym[GSYM_sym_idx].GetAddressRef() =
4257 Address(symbol_section, symbol_value);
4258 add_symbol_addr(
4259 sym[GSYM_sym_idx].GetAddress().GetFileAddress());
4260 // We just need the flags from the linker symbol, so put these
4261 // flags into the N_GSYM flags to avoid duplicate symbols in
4262 // the symbol table.
4263 sym[GSYM_sym_idx].SetFlags(nlist.n_type << 16 | nlist.n_desc);
4264 sym[sym_idx].Clear();
4265 return true;
4266 }
4267 }
4268 }
4269 }
4270 }
4271
4272 sym[sym_idx].SetID(nlist_idx);
4273 sym[sym_idx].SetType(type);
4274 if (set_value) {
4275 sym[sym_idx].GetAddressRef() = Address(symbol_section, symbol_value);
4276 if (symbol_section)
4277 add_symbol_addr(sym[sym_idx].GetAddress().GetFileAddress());
4278 }
4279 sym[sym_idx].SetFlags(nlist.n_type << 16 | nlist.n_desc);
4280 if (nlist.n_desc & N_WEAK_REF)
4281 sym[sym_idx].SetIsWeak(true);
4282
4283 if (demangled_is_synthesized)
4284 sym[sym_idx].SetDemangledNameIsSynthesized(true);
4285
4286 ++sym_idx;
4287 return true;
4288 };
4289
4290 // First parse all the nlists but don't process them yet. See the next
4291 // comment for an explanation why.
4292 std::vector<struct nlist_64> nlists;
4293 nlists.reserve(symtab_load_command.nsyms);
4294 for (; nlist_idx < symtab_load_command.nsyms; ++nlist_idx) {
4295 if (auto nlist =
4296 ParseNList(nlist_data, nlist_data_offset, nlist_byte_size))
4297 nlists.push_back(*nlist);
4298 else
4299 break;
4300 }
4301
4302 // Now parse all the debug symbols. This is needed to merge non-debug
4303 // symbols in the next step. Non-debug symbols are always coalesced into
4304 // the debug symbol. Doing this in one step would mean that some symbols
4305 // won't be merged.
4306 nlist_idx = 0;
4307 for (auto &nlist : nlists) {
4308 if (!ParseSymbolLambda(nlist, nlist_idx++, DebugSymbols))
4309 break;
4310 }
4311
4312 // Finally parse all the non debug symbols.
4313 nlist_idx = 0;
4314 for (auto &nlist : nlists) {
4315 if (!ParseSymbolLambda(nlist, nlist_idx++, NonDebugSymbols))
4316 break;
4317 }
4318
4319 for (const auto &pos : reexport_shlib_needs_fixup) {
4320 const auto undef_pos = undefined_name_to_desc.find(pos.second);
4321 if (undef_pos != undefined_name_to_desc.end()) {
4322 const uint8_t dylib_ordinal =
4323 llvm::MachO::GET_LIBRARY_ORDINAL(undef_pos->second);
4324 if (dylib_ordinal > 0 && dylib_ordinal < dylib_files.GetSize())
4325 sym[pos.first].SetReExportedSymbolSharedLibrary(
4326 dylib_files.GetFileSpecAtIndex(dylib_ordinal - 1));
4327 }
4328 }
4329 }
4330
4331 // Count how many trie symbols we'll add to the symbol table
4332 int trie_symbol_table_augment_count = 0;
4333 for (auto &e : external_sym_trie_entries) {
4334 if (!symbols_added.contains(e.entry.address))
4335 trie_symbol_table_augment_count++;
4336 }
4337
4338 if (num_syms < sym_idx + trie_symbol_table_augment_count) {
4339 num_syms = sym_idx + trie_symbol_table_augment_count;
4340 sym = symtab.Resize(num_syms);
4341 }
4342 uint32_t synthetic_sym_id = symtab_load_command.nsyms;
4343
4344 // Add symbols from the trie to the symbol table.
4345 for (auto &e : external_sym_trie_entries) {
4346 if (symbols_added.contains(e.entry.address))
4347 continue;
4348
4349 // Find the section that this trie address is in, use that to annotate
4350 // symbol type as we add the trie address and name to the symbol table.
4351 Address symbol_addr;
4352 if (module_sp->ResolveFileAddress(e.entry.address, symbol_addr)) {
4353 SectionSP symbol_section(symbol_addr.GetSection());
4354 const char *symbol_name = e.entry.name.GetCString();
4355 bool demangled_is_synthesized = false;
4356 SymbolType type =
4357 GetSymbolType(symbol_name, demangled_is_synthesized, text_section_sp,
4358 data_section_sp, data_dirty_section_sp,
4359 data_const_section_sp, symbol_section);
4360
4361 sym[sym_idx].SetType(type);
4362 if (symbol_section) {
4363 sym[sym_idx].SetID(synthetic_sym_id++);
4364 sym[sym_idx].GetMangled().SetMangledName(ConstString(symbol_name));
4365 if (demangled_is_synthesized)
4366 sym[sym_idx].SetDemangledNameIsSynthesized(true);
4367 sym[sym_idx].SetIsSynthetic(true);
4368 sym[sym_idx].SetExternal(true);
4369 sym[sym_idx].GetAddressRef() = symbol_addr;
4370 add_symbol_addr(symbol_addr.GetFileAddress());
4371 if (e.entry.flags & TRIE_SYMBOL_IS_THUMB)
4373 ++sym_idx;
4374 }
4375 }
4376 }
4377
4378 if (function_starts_count > 0) {
4379 uint32_t num_synthetic_function_symbols = 0;
4380 for (i = 0; i < function_starts_count; ++i) {
4381 if (!symbols_added.contains(function_starts.GetEntryRef(i).addr))
4382 ++num_synthetic_function_symbols;
4383 }
4384
4385 if (num_synthetic_function_symbols > 0) {
4386 if (num_syms < sym_idx + num_synthetic_function_symbols) {
4387 num_syms = sym_idx + num_synthetic_function_symbols;
4388 sym = symtab.Resize(num_syms);
4389 }
4390 for (i = 0; i < function_starts_count; ++i) {
4391 const FunctionStarts::Entry *func_start_entry =
4392 function_starts.GetEntryAtIndex(i);
4393 if (!symbols_added.contains(func_start_entry->addr)) {
4394 addr_t symbol_file_addr = func_start_entry->addr;
4395 uint32_t symbol_flags = 0;
4396 if (func_start_entry->data)
4397 symbol_flags = MACHO_NLIST_ARM_SYMBOL_IS_THUMB;
4398 Address symbol_addr;
4399 if (module_sp->ResolveFileAddress(symbol_file_addr, symbol_addr)) {
4400 SectionSP symbol_section(symbol_addr.GetSection());
4401 if (symbol_section) {
4402 sym[sym_idx].SetID(synthetic_sym_id++);
4403 // Don't set the name for any synthetic symbols, the Symbol
4404 // object will generate one if needed when the name is accessed
4405 // via accessors.
4406 sym[sym_idx].GetMangled().SetDemangledName(ConstString());
4407 sym[sym_idx].SetType(eSymbolTypeCode);
4408 sym[sym_idx].SetIsSynthetic(true);
4409 sym[sym_idx].GetAddressRef() = symbol_addr;
4410 add_symbol_addr(symbol_addr.GetFileAddress());
4411 if (symbol_flags)
4412 sym[sym_idx].SetFlags(symbol_flags);
4413 ++sym_idx;
4414 }
4415 }
4416 }
4417 }
4418 }
4419 }
4420
4421 // Trim our symbols down to just what we ended up with after removing any
4422 // symbols.
4423 if (sym_idx < num_syms) {
4424 num_syms = sym_idx;
4425 sym = symtab.Resize(num_syms);
4426 }
4427
4428 // Now synthesize indirect symbols
4429 if (m_dysymtab.nindirectsyms != 0) {
4430 if (indirect_symbol_index_data.GetByteSize()) {
4431 NListIndexToSymbolIndexMap::const_iterator end_index_pos =
4432 m_nlist_idx_to_sym_idx.end();
4433
4434 for (uint32_t sect_idx = 1; sect_idx < m_mach_sections.size();
4435 ++sect_idx) {
4436 if ((m_mach_sections[sect_idx].flags & SECTION_TYPE) ==
4437 S_SYMBOL_STUBS) {
4438 uint32_t symbol_stub_byte_size = m_mach_sections[sect_idx].reserved2;
4439 if (symbol_stub_byte_size == 0)
4440 continue;
4441
4442 const uint32_t num_symbol_stubs =
4443 m_mach_sections[sect_idx].size / symbol_stub_byte_size;
4444
4445 if (num_symbol_stubs == 0)
4446 continue;
4447
4448 const uint32_t symbol_stub_index_offset =
4449 m_mach_sections[sect_idx].reserved1;
4450 for (uint32_t stub_idx = 0; stub_idx < num_symbol_stubs; ++stub_idx) {
4451 const uint32_t symbol_stub_index =
4452 symbol_stub_index_offset + stub_idx;
4453 const lldb::addr_t symbol_stub_addr =
4454 m_mach_sections[sect_idx].addr +
4455 (stub_idx * symbol_stub_byte_size);
4456 lldb::offset_t symbol_stub_offset = symbol_stub_index * 4;
4457 if (indirect_symbol_index_data.ValidOffsetForDataOfSize(
4458 symbol_stub_offset, 4)) {
4459 const uint32_t stub_sym_id =
4460 indirect_symbol_index_data.GetU32(&symbol_stub_offset);
4461 if (stub_sym_id & (INDIRECT_SYMBOL_ABS | INDIRECT_SYMBOL_LOCAL))
4462 continue;
4463
4464 NListIndexToSymbolIndexMap::const_iterator index_pos =
4465 m_nlist_idx_to_sym_idx.find(stub_sym_id);
4466 Symbol *stub_symbol = nullptr;
4467 if (index_pos != end_index_pos) {
4468 // We have a remapping from the original nlist index to a
4469 // current symbol index, so just look this up by index
4470 stub_symbol = symtab.SymbolAtIndex(index_pos->second);
4471 } else {
4472 // We need to lookup a symbol using the original nlist symbol
4473 // index since this index is coming from the S_SYMBOL_STUBS
4474 stub_symbol = symtab.FindSymbolByID(stub_sym_id);
4475 }
4476
4477 if (stub_symbol) {
4478 Address so_addr(symbol_stub_addr, section_list);
4479
4480 if (stub_symbol->GetType() == eSymbolTypeUndefined) {
4481 // Change the external symbol into a trampoline that makes
4482 // sense These symbols were N_UNDF N_EXT, and are useless
4483 // to us, so we can re-use them so we don't have to make up
4484 // a synthetic symbol for no good reason.
4485 if (resolver_addresses.find(symbol_stub_addr) ==
4486 resolver_addresses.end())
4487 stub_symbol->SetType(eSymbolTypeTrampoline);
4488 else
4489 stub_symbol->SetType(eSymbolTypeResolver);
4490 stub_symbol->SetExternal(false);
4491 stub_symbol->GetAddressRef() = so_addr;
4492 stub_symbol->SetByteSize(symbol_stub_byte_size);
4493 } else {
4494 // Make a synthetic symbol to describe the trampoline stub
4495 Mangled stub_symbol_mangled_name(stub_symbol->GetMangled());
4496 if (sym_idx >= num_syms) {
4497 sym = symtab.Resize(++num_syms);
4498 stub_symbol = nullptr; // this pointer no longer valid
4499 }
4500 sym[sym_idx].SetID(synthetic_sym_id++);
4501 sym[sym_idx].GetMangled() = stub_symbol_mangled_name;
4502 if (resolver_addresses.find(symbol_stub_addr) ==
4503 resolver_addresses.end())
4504 sym[sym_idx].SetType(eSymbolTypeTrampoline);
4505 else
4506 sym[sym_idx].SetType(eSymbolTypeResolver);
4507 sym[sym_idx].SetIsSynthetic(true);
4508 sym[sym_idx].GetAddressRef() = so_addr;
4509 add_symbol_addr(so_addr.GetFileAddress());
4510 sym[sym_idx].SetByteSize(symbol_stub_byte_size);
4511 ++sym_idx;
4512 }
4513 } else {
4514 LLDB_LOGF(log,
4515 "warning: symbol stub referencing symbol table "
4516 "symbol %u that isn't in our minimal symbol table, "
4517 "fix this!!!",
4518 stub_sym_id);
4519 }
4520 }
4521 }
4522 }
4523 }
4524 }
4525 }
4526
4527 if (!reexport_trie_entries.empty()) {
4528 for (const auto &e : reexport_trie_entries) {
4529 if (e.entry.import_name) {
4530 // Only add indirect symbols from the Trie entries if we didn't have
4531 // a N_INDR nlist entry for this already
4532 if (indirect_symbol_names.find(e.entry.name) ==
4533 indirect_symbol_names.end()) {
4534 // Make a synthetic symbol to describe re-exported symbol.
4535 if (sym_idx >= num_syms)
4536 sym = symtab.Resize(++num_syms);
4537 sym[sym_idx].SetID(synthetic_sym_id++);
4538 sym[sym_idx].GetMangled() = Mangled(e.entry.name);
4539 sym[sym_idx].SetType(eSymbolTypeReExported);
4540 sym[sym_idx].SetIsSynthetic(true);
4541 sym[sym_idx].SetReExportedSymbolName(e.entry.import_name);
4542 if (e.entry.other > 0 && e.entry.other <= dylib_files.GetSize()) {
4544 dylib_files.GetFileSpecAtIndex(e.entry.other - 1));
4545 }
4546 ++sym_idx;
4547 }
4548 }
4549 }
4550 }
4551}
4552
4554 ModuleSP module_sp(GetModule());
4555 if (module_sp) {
4556 std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
4557 s->Printf("%p: ", static_cast<void *>(this));
4558 s->Indent();
4559 if (m_header.magic == MH_MAGIC_64 || m_header.magic == MH_CIGAM_64)
4560 s->PutCString("ObjectFileMachO64");
4561 else
4562 s->PutCString("ObjectFileMachO32");
4563
4564 *s << ", file = '" << m_file;
4565 ModuleSpecList all_specs;
4566 ModuleSpec base_spec;
4568 MachHeaderSizeFromMagic(m_header.magic), base_spec,
4569 all_specs);
4570 for (unsigned i = 0, e = all_specs.GetSize(); i != e; ++i) {
4571 *s << "', triple";
4572 if (e)
4573 s->Printf("[%d]", i);
4574 *s << " = ";
4575 *s << all_specs.GetModuleSpecRefAtIndex(i)
4577 .GetTriple()
4578 .getTriple();
4579 }
4580 *s << "\n";
4581 SectionList *sections = GetSectionList();
4582 if (sections)
4583 sections->Dump(s->AsRawOstream(), s->GetIndentLevel(), nullptr, true,
4584 UINT32_MAX);
4585
4586 if (m_symtab_up)
4587 m_symtab_up->Dump(s, nullptr, eSortOrderNone);
4588 }
4589}
4590
4591UUID ObjectFileMachO::GetUUID(const llvm::MachO::mach_header &header,
4592 const lldb_private::DataExtractor &data,
4593 lldb::offset_t lc_offset) {
4594 uint32_t i;
4595 llvm::MachO::uuid_command load_cmd;
4596
4597 lldb::offset_t offset = lc_offset;
4598 for (i = 0; i < header.ncmds; ++i) {
4599 const lldb::offset_t cmd_offset = offset;
4600 if (data.GetU32(&offset, &load_cmd, 2) == nullptr)
4601 break;
4602
4603 if (load_cmd.cmd == LC_UUID) {
4604 const uint8_t *uuid_bytes = data.PeekData(offset, 16);
4605
4606 if (uuid_bytes) {
4607 // OpenCL on Mac OS X uses the same UUID for each of its object files.
4608 // We pretend these object files have no UUID to prevent crashing.
4609
4610 const uint8_t opencl_uuid[] = {0x8c, 0x8e, 0xb3, 0x9b, 0x3b, 0xa8,
4611 0x4b, 0x16, 0xb6, 0xa4, 0x27, 0x63,
4612 0xbb, 0x14, 0xf0, 0x0d};
4613
4614 if (!memcmp(uuid_bytes, opencl_uuid, 16))
4615 return UUID();
4616
4617 return UUID(uuid_bytes, 16);
4618 }
4619 return UUID();
4620 }
4621 offset = cmd_offset + load_cmd.cmdsize;
4622 }
4623 return UUID();
4624}
4625
4626static llvm::StringRef GetOSName(uint32_t cmd) {
4627 switch (cmd) {
4628 case llvm::MachO::LC_VERSION_MIN_IPHONEOS:
4629 return llvm::Triple::getOSTypeName(llvm::Triple::IOS);
4630 case llvm::MachO::LC_VERSION_MIN_MACOSX:
4631 return llvm::Triple::getOSTypeName(llvm::Triple::MacOSX);
4632 case llvm::MachO::LC_VERSION_MIN_TVOS:
4633 return llvm::Triple::getOSTypeName(llvm::Triple::TvOS);
4634 case llvm::MachO::LC_VERSION_MIN_WATCHOS:
4635 return llvm::Triple::getOSTypeName(llvm::Triple::WatchOS);
4636 default:
4637 llvm_unreachable("unexpected LC_VERSION load command");
4638 }
4639}
4640
4641namespace {
4642struct OSEnv {
4643 llvm::StringRef os_type;
4644 llvm::StringRef environment;
4645 OSEnv(uint32_t cmd) {
4646 switch (cmd) {
4647 case llvm::MachO::PLATFORM_MACOS:
4648 os_type = llvm::Triple::getOSTypeName(llvm::Triple::MacOSX);
4649 return;
4650 case llvm::MachO::PLATFORM_IOS:
4651 os_type = llvm::Triple::getOSTypeName(llvm::Triple::IOS);
4652 return;
4653 case llvm::MachO::PLATFORM_TVOS:
4654 os_type = llvm::Triple::getOSTypeName(llvm::Triple::TvOS);
4655 return;
4656 case llvm::MachO::PLATFORM_WATCHOS:
4657 os_type = llvm::Triple::getOSTypeName(llvm::Triple::WatchOS);
4658 return;
4659 case llvm::MachO::PLATFORM_BRIDGEOS:
4660 os_type = llvm::Triple::getOSTypeName(llvm::Triple::BridgeOS);
4661 return;
4662 case llvm::MachO::PLATFORM_DRIVERKIT:
4663 os_type = llvm::Triple::getOSTypeName(llvm::Triple::DriverKit);
4664 return;
4665 case llvm::MachO::PLATFORM_MACCATALYST:
4666 os_type = llvm::Triple::getOSTypeName(llvm::Triple::IOS);
4667 environment = llvm::Triple::getEnvironmentTypeName(llvm::Triple::MacABI);
4668 return;
4669 case llvm::MachO::PLATFORM_IOSSIMULATOR:
4670 os_type = llvm::Triple::getOSTypeName(llvm::Triple::IOS);
4671 environment =
4672 llvm::Triple::getEnvironmentTypeName(llvm::Triple::Simulator);
4673 return;
4674 case llvm::MachO::PLATFORM_TVOSSIMULATOR:
4675 os_type = llvm::Triple::getOSTypeName(llvm::Triple::TvOS);
4676 environment =
4677 llvm::Triple::getEnvironmentTypeName(llvm::Triple::Simulator);
4678 return;
4679 case llvm::MachO::PLATFORM_WATCHOSSIMULATOR:
4680 os_type = llvm::Triple::getOSTypeName(llvm::Triple::WatchOS);
4681 environment =
4682 llvm::Triple::getEnvironmentTypeName(llvm::Triple::Simulator);
4683 return;
4684 case llvm::MachO::PLATFORM_XROS:
4685 os_type = llvm::Triple::getOSTypeName(llvm::Triple::XROS);
4686 return;
4687 case llvm::MachO::PLATFORM_XROS_SIMULATOR:
4688 os_type = llvm::Triple::getOSTypeName(llvm::Triple::XROS);
4689 environment =
4690 llvm::Triple::getEnvironmentTypeName(llvm::Triple::Simulator);
4691 return;
4692 default: {
4693 Log *log(GetLog(LLDBLog::Symbols | LLDBLog::Process));
4694 LLDB_LOGF(log, "unsupported platform in LC_BUILD_VERSION");
4695 }
4696 }
4697 }
4698};
4699
4700struct MinOS {
4701 uint32_t major_version, minor_version, patch_version;
4702 MinOS(uint32_t version)
4703 : major_version(version >> 16), minor_version((version >> 8) & 0xffu),
4704 patch_version(version & 0xffu) {}
4705};
4706} // namespace
4707
4708void ObjectFileMachO::GetAllArchSpecs(const llvm::MachO::mach_header &header,
4709 const lldb_private::DataExtractor &data,
4710 lldb::offset_t lc_offset,
4711 ModuleSpec &base_spec,
4712 lldb_private::ModuleSpecList &all_specs) {
4713 auto &base_arch = base_spec.GetArchitecture();
4714 base_arch.SetArchitecture(eArchTypeMachO, header.cputype, header.cpusubtype);
4715 if (!base_arch.IsValid())
4716 return;
4717
4718 bool found_any = false;
4719 auto add_triple = [&](const llvm::Triple &triple) {
4720 auto spec = base_spec;
4721 spec.GetArchitecture().GetTriple() = triple;
4722 if (spec.GetArchitecture().IsValid()) {
4723 spec.GetUUID() = ObjectFileMachO::GetUUID(header, data, lc_offset);
4724 all_specs.Append(spec);
4725 found_any = true;
4726 }
4727 };
4728
4729 // Set OS to an unspecified unknown or a "*" so it can match any OS
4730 llvm::Triple base_triple = base_arch.GetTriple();
4731 base_triple.setOS(llvm::Triple::UnknownOS);
4732 base_triple.setOSName(llvm::StringRef());
4733
4734 if (header.filetype == MH_PRELOAD) {
4735 if (header.cputype == CPU_TYPE_ARM) {
4736 // If this is a 32-bit arm binary, and it's a standalone binary, force
4737 // the Vendor to Apple so we don't accidentally pick up the generic
4738 // armv7 ABI at runtime. Apple's armv7 ABI always uses r7 for the
4739 // frame pointer register; most other armv7 ABIs use a combination of
4740 // r7 and r11.
4741 base_triple.setVendor(llvm::Triple::Apple);
4742 } else {
4743 // Set vendor to an unspecified unknown or a "*" so it can match any
4744 // vendor This is required for correct behavior of EFI debugging on
4745 // x86_64
4746 base_triple.setVendor(llvm::Triple::UnknownVendor);
4747 base_triple.setVendorName(llvm::StringRef());
4748 }
4749 return add_triple(base_triple);
4750 }
4751
4752 llvm::MachO::load_command load_cmd;
4753
4754 // See if there is an LC_VERSION_MIN_* load command that can give
4755 // us the OS type.
4756 lldb::offset_t offset = lc_offset;
4757 for (uint32_t i = 0; i < header.ncmds; ++i) {
4758 const lldb::offset_t cmd_offset = offset;
4759 if (data.GetU32(&offset, &load_cmd, 2) == nullptr)
4760 break;
4761
4762 llvm::MachO::version_min_command version_min;
4763 switch (load_cmd.cmd) {
4764 case llvm::MachO::LC_VERSION_MIN_MACOSX:
4765 case llvm::MachO::LC_VERSION_MIN_IPHONEOS:
4766 case llvm::MachO::LC_VERSION_MIN_TVOS:
4767 case llvm::MachO::LC_VERSION_MIN_WATCHOS: {
4768 if (load_cmd.cmdsize != sizeof(version_min))
4769 break;
4770 if (data.ExtractBytes(cmd_offset, sizeof(version_min),
4771 data.GetByteOrder(), &version_min) == 0)
4772 break;
4773 MinOS min_os(version_min.version);
4774 llvm::SmallString<32> os_name;
4775 llvm::raw_svector_ostream os(os_name);
4776 os << GetOSName(load_cmd.cmd) << min_os.major_version << '.'
4777 << min_os.minor_version << '.' << min_os.patch_version;
4778
4779 auto triple = base_triple;
4780 triple.setOSName(os.str());
4781
4782 // Disambiguate legacy simulator platforms.
4783 if (load_cmd.cmd != llvm::MachO::LC_VERSION_MIN_MACOSX &&
4784 (base_triple.getArch() == llvm::Triple::x86_64 ||
4785 base_triple.getArch() == llvm::Triple::x86)) {
4786 // The combination of legacy LC_VERSION_MIN load command and
4787 // x86 architecture always indicates a simulator environment.
4788 // The combination of LC_VERSION_MIN and arm architecture only
4789 // appears for native binaries. Back-deploying simulator
4790 // binaries on Apple Silicon Macs use the modern unambigous
4791 // LC_BUILD_VERSION load commands; no special handling required.
4792 triple.setEnvironment(llvm::Triple::Simulator);
4793 }
4794 add_triple(triple);
4795 break;
4796 }
4797 default:
4798 break;
4799 }
4800
4801 offset = cmd_offset + load_cmd.cmdsize;
4802 }
4803
4804 // See if there are LC_BUILD_VERSION load commands that can give
4805 // us the OS type.
4806 offset = lc_offset;
4807 for (uint32_t i = 0; i < header.ncmds; ++i) {
4808 const lldb::offset_t cmd_offset = offset;
4809 if (data.GetU32(&offset, &load_cmd, 2) == nullptr)
4810 break;
4811
4812 do {
4813 if (load_cmd.cmd == llvm::MachO::LC_BUILD_VERSION) {
4814 llvm::MachO::build_version_command build_version;
4815 if (load_cmd.cmdsize < sizeof(build_version)) {
4816 // Malformed load command.
4817 break;
4818 }
4819 if (data.ExtractBytes(cmd_offset, sizeof(build_version),
4820 data.GetByteOrder(), &build_version) == 0)
4821 break;
4822 MinOS min_os(build_version.minos);
4823 OSEnv os_env(build_version.platform);
4824 llvm::SmallString<16> os_name;
4825 llvm::raw_svector_ostream os(os_name);
4826 os << os_env.os_type << min_os.major_version << '.'
4827 << min_os.minor_version << '.' << min_os.patch_version;
4828 auto triple = base_triple;
4829 triple.setOSName(os.str());
4830 os_name.clear();
4831 if (!os_env.environment.empty())
4832 triple.setEnvironmentName(os_env.environment);
4833 add_triple(triple);
4834 }
4835 } while (false);
4836 offset = cmd_offset + load_cmd.cmdsize;
4837 }
4838
4839 if (!found_any) {
4840 add_triple(base_triple);
4841 }
4842}
4843
4845 ModuleSP module_sp, const llvm::MachO::mach_header &header,
4846 const lldb_private::DataExtractor &data, lldb::offset_t lc_offset) {
4847 ModuleSpecList all_specs;
4848 ModuleSpec base_spec;
4849 GetAllArchSpecs(header, data, MachHeaderSizeFromMagic(header.magic),
4850 base_spec, all_specs);
4851
4852 // If the object file offers multiple alternative load commands,
4853 // pick the one that matches the module.
4854 if (module_sp) {
4855 const ArchSpec &module_arch = module_sp->GetArchitecture();
4856 for (unsigned i = 0, e = all_specs.GetSize(); i != e; ++i) {
4857 ArchSpec mach_arch =
4859 if (module_arch.IsCompatibleMatch(mach_arch))
4860 return mach_arch;
4861 }
4862 }
4863
4864 // Return the first arch we found.
4865 if (all_specs.GetSize() == 0)
4866 return {};
4867 return all_specs.GetModuleSpecRefAtIndex(0).GetArchitecture();
4868}
4869
4871 ModuleSP module_sp(GetModule());
4872 if (module_sp) {
4873 std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
4875 return GetUUID(m_header, *m_data_nsp, offset);
4876 }
4877 return UUID();
4878}
4879
4881 ModuleSP module_sp = GetModule();
4882 if (!module_sp)
4883 return 0;
4884
4885 uint32_t count = 0;
4886 std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
4887 llvm::MachO::load_command load_cmd;
4889 std::vector<std::string> rpath_paths;
4890 std::vector<std::string> rpath_relative_paths;
4891 std::vector<std::string> at_exec_relative_paths;
4892 uint32_t i;
4893 for (i = 0; i < m_header.ncmds; ++i) {
4894 const uint32_t cmd_offset = offset;
4895 if (m_data_nsp->GetU32(&offset, &load_cmd, 2) == nullptr)
4896 break;
4897
4898 switch (load_cmd.cmd) {
4899 case LC_RPATH:
4900 case LC_LOAD_DYLIB:
4901 case LC_LOAD_WEAK_DYLIB:
4902 case LC_REEXPORT_DYLIB:
4903 case LC_LOAD_DYLINKER:
4904 case LC_LOADFVMLIB:
4905 case LC_LOAD_UPWARD_DYLIB: {
4906 uint32_t name_offset = cmd_offset + m_data_nsp->GetU32(&offset);
4907 // For LC_LOAD_DYLIB there is an alternate encoding
4908 // which adds a uint32_t `flags` field for `DYLD_USE_*`
4909 // flags. This can be detected by a timestamp field with
4910 // the `DYLIB_USE_MARKER` constant value.
4911 bool is_delayed_init = false;
4912 uint32_t use_command_marker = m_data_nsp->GetU32(&offset);
4913 if (use_command_marker == 0x1a741800 /* DYLIB_USE_MARKER */) {
4914 offset += 4; /* uint32_t current_version */
4915 offset += 4; /* uint32_t compat_version */
4916 uint32_t flags = m_data_nsp->GetU32(&offset);
4917 // If this LC_LOAD_DYLIB is marked delay-init,
4918 // don't report it as a dependent library -- it
4919 // may be loaded in the process at some point,
4920 // but will most likely not be load at launch.
4921 if (flags & 0x08 /* DYLIB_USE_DELAYED_INIT */)
4922 is_delayed_init = true;
4923 }
4924 const char *path = m_data_nsp->PeekCStr(name_offset);
4925 if (path && !is_delayed_init) {
4926 if (load_cmd.cmd == LC_RPATH)
4927 rpath_paths.push_back(path);
4928 else {
4929 if (path[0] == '@') {
4930 if (strncmp(path, "@rpath", strlen("@rpath")) == 0)
4931 rpath_relative_paths.push_back(path + strlen("@rpath"));
4932 else if (strncmp(path, "@executable_path",
4933 strlen("@executable_path")) == 0)
4934 at_exec_relative_paths.push_back(path +
4935 strlen("@executable_path"));
4936 } else {
4937 FileSpec file_spec(path);
4938 if (files.AppendIfUnique(file_spec))
4939 count++;
4940 }
4941 }
4942 }
4943 } break;
4944
4945 default:
4946 break;
4947 }
4948 offset = cmd_offset + load_cmd.cmdsize;
4949 }
4950
4951 FileSpec this_file_spec(m_file);
4952 FileSystem::Instance().Resolve(this_file_spec);
4953
4954 if (!rpath_paths.empty()) {
4955 // Fixup all LC_RPATH values to be absolute paths.
4956 const std::string this_directory =
4957 this_file_spec.GetDirectory().GetString();
4958 for (auto &rpath : rpath_paths) {
4959 if (llvm::StringRef(rpath).starts_with(g_loader_path))
4960 rpath = this_directory + rpath.substr(g_loader_path.size());
4961 else if (llvm::StringRef(rpath).starts_with(g_executable_path))
4962 rpath = this_directory + rpath.substr(g_executable_path.size());
4963 }
4964
4965 for (const auto &rpath_relative_path : rpath_relative_paths) {
4966 for (const auto &rpath : rpath_paths) {
4967 std::string path = rpath;
4968 path += rpath_relative_path;
4969 // It is OK to resolve this path because we must find a file on disk
4970 // for us to accept it anyway if it is rpath relative.
4971 FileSpec file_spec(path);
4972 FileSystem::Instance().Resolve(file_spec);
4973 if (FileSystem::Instance().Exists(file_spec) &&
4974 files.AppendIfUnique(file_spec)) {
4975 count++;
4976 break;
4977 }
4978 }
4979 }
4980 }
4981
4982 // We may have @executable_paths but no RPATHS. Figure those out here.
4983 // Only do this if this object file is the executable. We have no way to
4984 // get back to the actual executable otherwise, so we won't get the right
4985 // path.
4986 if (!at_exec_relative_paths.empty() && CalculateType() == eTypeExecutable) {
4987 FileSpec exec_dir = this_file_spec.CopyByRemovingLastPathComponent();
4988 for (const auto &at_exec_relative_path : at_exec_relative_paths) {
4989 FileSpec file_spec =
4990 exec_dir.CopyByAppendingPathComponent(at_exec_relative_path);
4991 if (FileSystem::Instance().Exists(file_spec) &&
4992 files.AppendIfUnique(file_spec))
4993 count++;
4994 }
4995 }
4996 return count;
4997}
4998
5000 // If the object file is not an executable it can't hold the entry point.
5001 // m_entry_point_address is initialized to an invalid address, so we can just
5002 // return that. If m_entry_point_address is valid it means we've found it
5003 // already, so return the cached value.
5004
5005 if ((!IsExecutable() && !IsDynamicLoader()) ||
5006 m_entry_point_address.IsValid()) {
5007 return m_entry_point_address;
5008 }
5009
5010 // Otherwise, look for the UnixThread or Thread command. The data for the
5011 // Thread command is given in /usr/include/mach-o.h, but it is basically:
5012 //
5013 // uint32_t flavor - this is the flavor argument you would pass to
5014 // thread_get_state
5015 // uint32_t count - this is the count of longs in the thread state data
5016 // struct XXX_thread_state state - this is the structure from
5017 // <machine/thread_status.h> corresponding to the flavor.
5018 // <repeat this trio>
5019 //
5020 // So we just keep reading the various register flavors till we find the GPR
5021 // one, then read the PC out of there.
5022 // FIXME: We will need to have a "RegisterContext data provider" class at some
5023 // point that can get all the registers
5024 // out of data in this form & attach them to a given thread. That should
5025 // underlie the MacOS X User process plugin, and we'll also need it for the
5026 // MacOS X Core File process plugin. When we have that we can also use it
5027 // here.
5028 //
5029 // For now we hard-code the offsets and flavors we need:
5030 //
5031 //
5032
5033 ModuleSP module_sp(GetModule());
5034 if (module_sp) {
5035 std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
5036 llvm::MachO::load_command load_cmd;
5038 uint32_t i;
5039 lldb::addr_t start_address = LLDB_INVALID_ADDRESS;
5040 bool done = false;
5041
5042 for (i = 0; i < m_header.ncmds; ++i) {
5043 const lldb::offset_t cmd_offset = offset;
5044 if (m_data_nsp->GetU32(&offset, &load_cmd, 2) == nullptr)
5045 break;
5046
5047 switch (load_cmd.cmd) {
5048 case LC_UNIXTHREAD:
5049 case LC_THREAD: {
5050 while (offset < cmd_offset + load_cmd.cmdsize) {
5051 uint32_t flavor = m_data_nsp->GetU32(&offset);
5052 uint32_t count = m_data_nsp->GetU32(&offset);
5053 if (count == 0) {
5054 // We've gotten off somehow, log and exit;
5055 return m_entry_point_address;
5056 }
5057
5058 switch (m_header.cputype) {
5059 case llvm::MachO::CPU_TYPE_ARM:
5060 if (flavor == 1 ||
5061 flavor == 9) // ARM_THREAD_STATE/ARM_THREAD_STATE32
5062 // from mach/arm/thread_status.h
5063 {
5064 offset += 60; // This is the offset of pc in the GPR thread state
5065 // data structure.
5066 start_address = m_data_nsp->GetU32(&offset);
5067 done = true;
5068 }
5069 break;
5070 case llvm::MachO::CPU_TYPE_ARM64:
5071 case llvm::MachO::CPU_TYPE_ARM64_32:
5072 if (flavor == 6) // ARM_THREAD_STATE64 from mach/arm/thread_status.h
5073 {
5074 offset += 256; // This is the offset of pc in the GPR thread state
5075 // data structure.
5076 start_address = m_data_nsp->GetU64(&offset);
5077 done = true;
5078 }
5079 break;
5080 case llvm::MachO::CPU_TYPE_X86_64:
5081 if (flavor ==
5082 4) // x86_THREAD_STATE64 from mach/i386/thread_status.h
5083 {
5084 offset += 16 * 8; // This is the offset of rip in the GPR thread
5085 // state data structure.
5086 start_address = m_data_nsp->GetU64(&offset);
5087 done = true;
5088 }
5089 break;
5090 default:
5091 return m_entry_point_address;
5092 }
5093 // Haven't found the GPR flavor yet, skip over the data for this
5094 // flavor:
5095 if (done)
5096 break;
5097 offset += count * 4;
5098 }
5099 } break;
5100 case LC_MAIN: {
5101 uint64_t entryoffset = m_data_nsp->GetU64(&offset);
5102 SectionSP text_segment_sp =
5104 if (text_segment_sp) {
5105 done = true;
5106 start_address = text_segment_sp->GetFileAddress() + entryoffset;
5107 }
5108 } break;
5109
5110 default:
5111 break;
5112 }
5113 if (done)
5114 break;
5115
5116 // Go to the next load command:
5117 offset = cmd_offset + load_cmd.cmdsize;
5118 }
5119
5120 if (start_address == LLDB_INVALID_ADDRESS && IsDynamicLoader()) {
5121 if (GetSymtab()) {
5122 const Symbol *dyld_start_sym =
5126 if (dyld_start_sym && dyld_start_sym->GetAddress().IsValid()) {
5127 start_address = dyld_start_sym->GetAddress().GetFileAddress();
5128 }
5129 }
5130 }
5131
5132 if (start_address != LLDB_INVALID_ADDRESS) {
5133 // We got the start address from the load commands, so now resolve that
5134 // address in the sections of this ObjectFile:
5135 if (!m_entry_point_address.ResolveAddressUsingFileSections(
5136 start_address, GetSectionList())) {
5137 m_entry_point_address.Clear();
5138 }
5139 } else {
5140 // We couldn't read the UnixThread load command - maybe it wasn't there.
5141 // As a fallback look for the "start" symbol in the main executable.
5142
5143 ModuleSP module_sp(GetModule());
5144
5145 if (module_sp) {
5146 SymbolContextList contexts;
5147 SymbolContext context;
5148 module_sp->FindSymbolsWithNameAndType(ConstString("start"),
5149 eSymbolTypeCode, contexts);
5150 if (contexts.GetSize()) {
5151 if (contexts.GetContextAtIndex(0, context))
5153 }
5154 }
5155 }
5156 }
5157
5158 return m_entry_point_address;
5159}
5160
5162 lldb_private::Address header_addr;
5163 SectionList *section_list = GetSectionList();
5164 if (section_list) {
5165 SectionSP text_segment_sp(
5166 section_list->FindSectionByName(GetSegmentNameTEXT()));
5167 if (text_segment_sp)
5168 header_addr = Address(text_segment_sp, /*offset=*/0);
5169 }
5170 return header_addr;
5171}
5172
5174 ModuleSP module_sp(GetModule());
5175 if (module_sp) {
5176 std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
5180 FileRangeArray::Entry file_range;
5181 llvm::MachO::thread_command thread_cmd;
5182 for (uint32_t i = 0; i < m_header.ncmds; ++i) {
5183 const uint32_t cmd_offset = offset;
5184 if (m_data_nsp->GetU32(&offset, &thread_cmd, 2) == nullptr)
5185 break;
5186
5187 if (thread_cmd.cmd == LC_THREAD) {
5188 file_range.SetRangeBase(offset);
5189 file_range.SetByteSize(thread_cmd.cmdsize - 8);
5190 m_thread_context_offsets.Append(file_range);
5191 }
5192 offset = cmd_offset + thread_cmd.cmdsize;
5193 }
5194 }
5195 }
5196 return m_thread_context_offsets.GetSize();
5197}
5198
5199std::vector<std::tuple<offset_t, offset_t>>
5201 std::vector<std::tuple<offset_t, offset_t>> results;
5202 ModuleSP module_sp(GetModule());
5203 if (module_sp) {
5204 std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
5205
5207 for (uint32_t i = 0; i < m_header.ncmds; ++i) {
5208 const uint32_t cmd_offset = offset;
5209 llvm::MachO::load_command lc = {};
5210 if (m_data_nsp->GetU32(&offset, &lc.cmd, 2) == nullptr)
5211 break;
5212 if (lc.cmd == LC_NOTE) {
5213 char data_owner[17];
5214 m_data_nsp->CopyData(offset, 16, data_owner);
5215 data_owner[16] = '\0';
5216 offset += 16;
5217
5218 if (name == data_owner) {
5219 offset_t payload_offset = m_data_nsp->GetU64_unchecked(&offset);
5220 offset_t payload_size = m_data_nsp->GetU64_unchecked(&offset);
5221 results.push_back({payload_offset, payload_size});
5222 }
5223 }
5224 offset = cmd_offset + lc.cmdsize;
5225 }
5226 }
5227 return results;
5228}
5229
5231 Log *log(
5233 ModuleSP module_sp(GetModule());
5234 if (module_sp) {
5235 std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
5236
5237 auto lc_notes = FindLC_NOTEByName("kern ver str");
5238 for (auto lc_note : lc_notes) {
5239 offset_t payload_offset = std::get<0>(lc_note);
5240 offset_t payload_size = std::get<1>(lc_note);
5241 uint32_t version;
5242 if (m_data_nsp->GetU32(&payload_offset, &version, 1) != nullptr) {
5243 if (version == 1) {
5244 uint32_t strsize = payload_size - sizeof(uint32_t);
5245 std::string result(strsize, '\0');
5246 m_data_nsp->CopyData(payload_offset, strsize, result.data());
5247 LLDB_LOGF(log, "LC_NOTE 'kern ver str' found with text '%s'",
5248 result.c_str());
5249 return result;
5250 }
5251 }
5252 }
5253
5254 // Second, make a pass over the load commands looking for an obsolete
5255 // LC_IDENT load command.
5257 for (uint32_t i = 0; i < m_header.ncmds; ++i) {
5258 const uint32_t cmd_offset = offset;
5259 llvm::MachO::ident_command ident_command;
5260 if (m_data_nsp->GetU32(&offset, &ident_command, 2) == nullptr)
5261 break;
5262 if (ident_command.cmd == LC_IDENT && ident_command.cmdsize != 0) {
5263 std::string result(ident_command.cmdsize, '\0');
5264 if (m_data_nsp->CopyData(offset, ident_command.cmdsize,
5265 result.data()) == ident_command.cmdsize) {
5266 LLDB_LOGF(log, "LC_IDENT found with text '%s'", result.c_str());
5267 return result;
5268 }
5269 }
5270 offset = cmd_offset + ident_command.cmdsize;
5271 }
5272 }
5273 return {};
5274}
5275
5277 AddressableBits addressable_bits;
5278
5280 ModuleSP module_sp(GetModule());
5281 if (module_sp) {
5282 std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
5283 auto lc_notes = FindLC_NOTEByName("addrable bits");
5284 for (auto lc_note : lc_notes) {
5285 offset_t payload_offset = std::get<0>(lc_note);
5286 uint32_t version;
5287 if (m_data_nsp->GetU32(&payload_offset, &version, 1) != nullptr) {
5288 if (version == 3) {
5289 uint32_t num_addr_bits =
5290 m_data_nsp->GetU32_unchecked(&payload_offset);
5291 addressable_bits.SetAddressableBits(num_addr_bits);
5292 LLDB_LOGF(log,
5293 "LC_NOTE 'addrable bits' v3 found, value %d "
5294 "bits",
5295 num_addr_bits);
5296 }
5297 if (version == 4) {
5298 uint32_t lo_addr_bits = m_data_nsp->GetU32_unchecked(&payload_offset);
5299 uint32_t hi_addr_bits = m_data_nsp->GetU32_unchecked(&payload_offset);
5300
5301 if (lo_addr_bits == hi_addr_bits)
5302 addressable_bits.SetAddressableBits(lo_addr_bits);
5303 else
5304 addressable_bits.SetAddressableBits(lo_addr_bits, hi_addr_bits);
5305 LLDB_LOGF(log, "LC_NOTE 'addrable bits' v4 found, value %d & %d bits",
5306 lo_addr_bits, hi_addr_bits);
5307 }
5308 }
5309 }
5310 }
5311 return addressable_bits;
5312}
5313
5315 bool &value_is_offset,
5316 UUID &uuid,
5317 ObjectFile::BinaryType &type) {
5318 Log *log(
5320 value = LLDB_INVALID_ADDRESS;
5321 value_is_offset = false;
5322 uuid.Clear();
5323 uint32_t log2_pagesize = 0; // not currently passed up to caller
5324 uint32_t platform = 0; // not currently passed up to caller
5325 ModuleSP module_sp(GetModule());
5326 if (module_sp) {
5327 std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
5328
5329 auto lc_notes = FindLC_NOTEByName("main bin spec");
5330 for (auto lc_note : lc_notes) {
5331 offset_t payload_offset = std::get<0>(lc_note);
5332
5333 // struct main_bin_spec
5334 // {
5335 // uint32_t version; // currently 2
5336 // uint32_t type; // 0 == unspecified,
5337 // // 1 == kernel
5338 // // 2 == user process,
5339 // dyld mach-o binary addr
5340 // // 3 == standalone binary
5341 // // 4 == user process,
5342 // // dyld_all_image_infos addr
5343 // uint64_t address; // UINT64_MAX if address not specified
5344 // uint64_t slide; // slide, UINT64_MAX if unspecified
5345 // // 0 if no slide needs to be applied to
5346 // // file address
5347 // uuid_t uuid; // all zero's if uuid not specified
5348 // uint32_t log2_pagesize; // process page size in log base 2,
5349 // // e.g. 4k pages are 12.
5350 // // 0 for unspecified
5351 // uint32_t platform; // The Mach-O platform for this corefile.
5352 // // 0 for unspecified.
5353 // // The values are defined in
5354 // // <mach-o/loader.h>, PLATFORM_*.
5355 // } __attribute((packed));
5356
5357 // "main bin spec" (main binary specification) data payload is
5358 // formatted:
5359 // uint32_t version [currently 1]
5360 // uint32_t type [0 == unspecified, 1 == kernel,
5361 // 2 == user process, 3 == firmware ]
5362 // uint64_t address [ UINT64_MAX if address not specified ]
5363 // uuid_t uuid [ all zero's if uuid not specified ]
5364 // uint32_t log2_pagesize [ process page size in log base
5365 // 2, e.g. 4k pages are 12.
5366 // 0 for unspecified ]
5367 // uint32_t unused [ for alignment ]
5368
5369 uint32_t version;
5370 if (m_data_nsp->GetU32(&payload_offset, &version, 1) != nullptr &&
5371 version <= 2) {
5372 uint32_t binspec_type = 0;
5373 uuid_t raw_uuid;
5374 memset(raw_uuid, 0, sizeof(uuid_t));
5375
5376 if (!m_data_nsp->GetU32(&payload_offset, &binspec_type, 1))
5377 return false;
5378 if (!m_data_nsp->GetU64(&payload_offset, &value, 1))
5379 return false;
5380 uint64_t slide = LLDB_INVALID_ADDRESS;
5381 if (version > 1 && !m_data_nsp->GetU64(&payload_offset, &slide, 1))
5382 return false;
5383 if (value == LLDB_INVALID_ADDRESS && slide != LLDB_INVALID_ADDRESS) {
5384 value = slide;
5385 value_is_offset = true;
5386 }
5387
5388 if (m_data_nsp->CopyData(payload_offset, sizeof(uuid_t), raw_uuid) !=
5389 0) {
5390 uuid = UUID(raw_uuid, sizeof(uuid_t));
5391 // convert the "main bin spec" type into our
5392 // ObjectFile::BinaryType enum
5393 const char *typestr = "unrecognized type";
5394 type = eBinaryTypeInvalid;
5395 switch (binspec_type) {
5396 case 0:
5397 type = eBinaryTypeUnknown;
5398 typestr = "uknown";
5399 break;
5400 case 1:
5401 type = eBinaryTypeKernel;
5402 typestr = "xnu kernel";
5403 break;
5404 case 2:
5405 type = eBinaryTypeUser;
5406 typestr = "userland dyld";
5407 break;
5408 case 3:
5409 type = eBinaryTypeStandalone;
5410 typestr = "standalone";
5411 break;
5412 case 4:
5414 typestr = "userland dyld_all_image_infos";
5415 break;
5416 }
5417 LLDB_LOGF(log,
5418 "LC_NOTE 'main bin spec' found, version %d type %d "
5419 "(%s), value 0x%" PRIx64 " value-is-slide==%s uuid %s",
5420 version, type, typestr, value,
5421 value_is_offset ? "true" : "false",
5422 uuid.GetAsString().c_str());
5423 if (!m_data_nsp->GetU32(&payload_offset, &log2_pagesize, 1))
5424 return false;
5425 if (version > 1 && !m_data_nsp->GetU32(&payload_offset, &platform, 1))
5426 return false;
5427 return true;
5428 }
5429 }
5430 }
5431 }
5432 return false;
5433}
5434
5436 std::vector<lldb::tid_t> &tids) {
5437 tids.clear();
5438 ModuleSP module_sp(GetModule());
5439 if (module_sp) {
5440 std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
5441
5444 StructuredData::Dictionary *dict = object_sp->GetAsDictionary();
5445 StructuredData::Array *threads;
5446 if (!dict->GetValueForKeyAsArray("threads", threads) || !threads) {
5447 LLDB_LOGF(log,
5448 "'process metadata' LC_NOTE does not have a 'threads' key");
5449 return false;
5450 }
5451 if (threads->GetSize() != GetNumThreadContexts()) {
5452 LLDB_LOGF(log, "Unable to read 'process metadata' LC_NOTE, number of "
5453 "threads does not match number of LC_THREADS.");
5454 return false;
5455 }
5456 const size_t num_threads = threads->GetSize();
5457 for (size_t i = 0; i < num_threads; i++) {
5458 std::optional<StructuredData::Dictionary *> maybe_thread =
5459 threads->GetItemAtIndexAsDictionary(i);
5460 if (!maybe_thread) {
5461 LLDB_LOGF(log,
5462 "Unable to read 'process metadata' LC_NOTE, threads "
5463 "array does not have a dictionary at index %zu.",
5464 i);
5465 return false;
5466 }
5467 StructuredData::Dictionary *thread = *maybe_thread;
5469 if (thread->GetValueForKeyAsInteger<lldb::tid_t>("thread_id", tid))
5470 if (tid == 0)
5472 tids.push_back(tid);
5473 }
5474
5475 if (log) {
5476 StreamString logmsg;
5477 logmsg.Printf("LC_NOTE 'process metadata' found: ");
5478 dict->Dump(logmsg, /* pretty_print */ false);
5479 LLDB_LOGF(log, "%s", logmsg.GetData());
5480 }
5481 return true;
5482 }
5483 }
5484 return false;
5485}
5486
5488 ModuleSP module_sp(GetModule());
5489 if (!module_sp)
5490 return {};
5491
5493 std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
5494 auto lc_notes = FindLC_NOTEByName("process metadata");
5495 if (lc_notes.size() == 0)
5496 return {};
5497
5498 if (lc_notes.size() > 1)
5499 LLDB_LOGF(
5500 log,
5501 "Multiple 'process metadata' LC_NOTEs found, only using the first.");
5502
5503 auto [payload_offset, strsize] = lc_notes[0];
5504 std::string buf(strsize, '\0');
5505 if (m_data_nsp->CopyData(payload_offset, strsize, buf.data()) != strsize) {
5506 LLDB_LOGF(log,
5507 "Unable to read %" PRIu64
5508 " bytes of 'process metadata' LC_NOTE JSON contents",
5509 strsize);
5510 return {};
5511 }
5512 while (buf.back() == '\0')
5513 buf.resize(buf.size() - 1);
5515 if (!object_sp) {
5516 LLDB_LOGF(log, "Unable to read 'process metadata' LC_NOTE, did not "
5517 "parse as valid JSON.");
5518 return {};
5519 }
5520 StructuredData::Dictionary *dict = object_sp->GetAsDictionary();
5521 if (!dict) {
5522 LLDB_LOGF(log, "Unable to read 'process metadata' LC_NOTE, did not "
5523 "get a dictionary.");
5524 return {};
5525 }
5526
5527 return object_sp;
5528}
5529
5532 lldb_private::Thread &thread) {
5533 lldb::RegisterContextSP reg_ctx_sp;
5534
5535 ModuleSP module_sp(GetModule());
5536 if (module_sp) {
5537 std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
5540
5541 const FileRangeArray::Entry *thread_context_file_range =
5542 m_thread_context_offsets.GetEntryAtIndex(idx);
5543 if (thread_context_file_range) {
5544
5545 DataExtractor data(*m_data_nsp, thread_context_file_range->GetRangeBase(),
5546 thread_context_file_range->GetByteSize());
5547
5548 switch (m_header.cputype) {
5549 case llvm::MachO::CPU_TYPE_ARM64:
5550 case llvm::MachO::CPU_TYPE_ARM64_32:
5551 reg_ctx_sp =
5552 std::make_shared<RegisterContextDarwin_arm64_Mach>(thread, data);
5553 break;
5554
5555 case llvm::MachO::CPU_TYPE_ARM:
5556 reg_ctx_sp =
5557 std::make_shared<RegisterContextDarwin_arm_Mach>(thread, data);
5558 break;
5559
5560 case llvm::MachO::CPU_TYPE_X86_64:
5561 reg_ctx_sp =
5562 std::make_shared<RegisterContextDarwin_x86_64_Mach>(thread, data);
5563 break;
5564
5565 case llvm::MachO::CPU_TYPE_RISCV:
5566 reg_ctx_sp =
5567 std::make_shared<RegisterContextDarwin_riscv32_Mach>(thread, data);
5568 break;
5569 }
5570 }
5571 }
5572 return reg_ctx_sp;
5573}
5574
5576 switch (m_header.filetype) {
5577 case MH_OBJECT: // 0x1u
5578 if (GetAddressByteSize() == 4) {
5579 // 32 bit kexts are just object files, but they do have a valid
5580 // UUID load command.
5581 if (GetUUID()) {
5582 // this checking for the UUID load command is not enough we could
5583 // eventually look for the symbol named "OSKextGetCurrentIdentifier" as
5584 // this is required of kexts
5585 if (m_strata == eStrataInvalid)
5587 return eTypeSharedLibrary;
5588 }
5589 }
5590 return eTypeObjectFile;
5591
5592 case MH_EXECUTE:
5593 return eTypeExecutable; // 0x2u
5594 case MH_FVMLIB:
5595 return eTypeSharedLibrary; // 0x3u
5596 case MH_CORE:
5597 return eTypeCoreFile; // 0x4u
5598 case MH_PRELOAD:
5599 return eTypeSharedLibrary; // 0x5u
5600 case MH_DYLIB:
5601 return eTypeSharedLibrary; // 0x6u
5602 case MH_DYLINKER:
5603 return eTypeDynamicLinker; // 0x7u
5604 case MH_BUNDLE:
5605 return eTypeSharedLibrary; // 0x8u
5606 case MH_DYLIB_STUB:
5607 return eTypeStubLibrary; // 0x9u
5608 case MH_DSYM:
5609 return eTypeDebugInfo; // 0xAu
5610 case MH_KEXT_BUNDLE:
5611 return eTypeSharedLibrary; // 0xBu
5612 default:
5613 break;
5614 }
5615 return eTypeUnknown;
5616}
5617
5619 switch (m_header.filetype) {
5620 case MH_OBJECT: // 0x1u
5621 {
5622 // 32 bit kexts are just object files, but they do have a valid
5623 // UUID load command.
5624 if (GetUUID()) {
5625 // this checking for the UUID load command is not enough we could
5626 // eventually look for the symbol named "OSKextGetCurrentIdentifier" as
5627 // this is required of kexts
5628 if (m_type == eTypeInvalid)
5630
5631 return eStrataKernel;
5632 }
5633 }
5634 return eStrataUnknown;
5635
5636 case MH_EXECUTE: // 0x2u
5637 // Check for the MH_DYLDLINK bit in the flags
5638 if (m_header.flags & MH_DYLDLINK) {
5639 return eStrataUser;
5640 } else {
5641 SectionList *section_list = GetSectionList();
5642 if (section_list) {
5643 static ConstString g_kld_section_name("__KLD");
5644 if (section_list->FindSectionByName(g_kld_section_name))
5645 return eStrataKernel;
5646 }
5647 }
5648 return eStrataRawImage;
5649
5650 case MH_FVMLIB:
5651 return eStrataUser; // 0x3u
5652 case MH_CORE:
5653 return eStrataUnknown; // 0x4u
5654 case MH_PRELOAD:
5655 return eStrataRawImage; // 0x5u
5656 case MH_DYLIB:
5657 return eStrataUser; // 0x6u
5658 case MH_DYLINKER:
5659 return eStrataUser; // 0x7u
5660 case MH_BUNDLE:
5661 return eStrataUser; // 0x8u
5662 case MH_DYLIB_STUB:
5663 return eStrataUser; // 0x9u
5664 case MH_DSYM:
5665 return eStrataUnknown; // 0xAu
5666 case MH_KEXT_BUNDLE:
5667 return eStrataKernel; // 0xBu
5668 default:
5669 break;
5670 }
5671 return eStrataUnknown;
5672}
5673
5674llvm::VersionTuple ObjectFileMachO::GetVersion() {
5675 ModuleSP module_sp(GetModule());
5676 if (module_sp) {
5677 std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
5678 llvm::MachO::dylib_command load_cmd;
5680 uint32_t version_cmd = 0;
5681 uint64_t version = 0;
5682 uint32_t i;
5683 for (i = 0; i < m_header.ncmds; ++i) {
5684 const lldb::offset_t cmd_offset = offset;
5685 if (m_data_nsp->GetU32(&offset, &load_cmd, 2) == nullptr)
5686 break;
5687
5688 if (load_cmd.cmd == LC_ID_DYLIB) {
5689 if (version_cmd == 0) {
5690 version_cmd = load_cmd.cmd;
5691 if (m_data_nsp->GetU32(&offset, &load_cmd.dylib, 4) == nullptr)
5692 break;
5693 version = load_cmd.dylib.current_version;
5694 }
5695 break; // Break for now unless there is another more complete version
5696 // number load command in the future.
5697 }
5698 offset = cmd_offset + load_cmd.cmdsize;
5699 }
5700
5701 if (version_cmd == LC_ID_DYLIB) {
5702 unsigned major = (version & 0xFFFF0000ull) >> 16;
5703 unsigned minor = (version & 0x0000FF00ull) >> 8;
5704 unsigned subminor = (version & 0x000000FFull);
5705 return llvm::VersionTuple(major, minor, subminor);
5706 }
5707 }
5708 return llvm::VersionTuple();
5709}
5710
5712 ModuleSP module_sp(GetModule());
5713 ArchSpec arch;
5714 if (module_sp) {
5715 std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
5716
5717 return GetArchitecture(module_sp, m_header, *m_data_nsp,
5719 }
5720 return arch;
5721}
5722
5724 addr_t &base_addr, UUID &uuid) {
5725 uuid.Clear();
5726 base_addr = LLDB_INVALID_ADDRESS;
5727 if (process && process->GetDynamicLoader()) {
5728 DynamicLoader *dl = process->GetDynamicLoader();
5729 LazyBool using_shared_cache;
5730 LazyBool private_shared_cache;
5731 FileSpec sc_filepath;
5732 std::optional<uint64_t> size;
5733 dl->GetSharedCacheInformation(base_addr, uuid, using_shared_cache,
5734 private_shared_cache, sc_filepath, size);
5735 }
5737 LLDB_LOGF(
5738 log,
5739 "inferior process shared cache has a UUID of %s, base address 0x%" PRIx64,
5740 uuid.GetAsString().c_str(), base_addr);
5741}
5742
5743// From dyld SPI header dyld_process_info.h
5744typedef void *dyld_process_info;
5746 uuid_t cacheUUID; // UUID of cache used by process
5747 uint64_t cacheBaseAddress; // load address of dyld shared cache
5748 bool noCache; // process is running without a dyld cache
5749 bool privateCache; // process is using a private copy of its dyld cache
5750};
5751
5752// #including mach/mach.h pulls in machine.h & CPU_TYPE_ARM etc conflicts with
5753// llvm enum definitions llvm::MachO::CPU_TYPE_ARM turning them into compile
5754// errors. So we need to use the actual underlying types of task_t and
5755// kern_return_t below.
5756extern "C" unsigned int /*task_t*/ mach_task_self();
5757
5759 uuid.Clear();
5760 base_addr = LLDB_INVALID_ADDRESS;
5761
5762#if defined(__APPLE__)
5763 uint8_t *(*dyld_get_all_image_infos)(void);
5764 dyld_get_all_image_infos =
5765 (uint8_t * (*)()) dlsym(RTLD_DEFAULT, "_dyld_get_all_image_infos");
5766 if (dyld_get_all_image_infos) {
5767 uint8_t *dyld_all_image_infos_address = dyld_get_all_image_infos();
5768 if (dyld_all_image_infos_address) {
5769 uint32_t *version = (uint32_t *)
5770 dyld_all_image_infos_address; // version <mach-o/dyld_images.h>
5771 if (*version >= 13) {
5772 uuid_t *sharedCacheUUID_address = 0;
5773 int wordsize = sizeof(uint8_t *);
5774 if (wordsize == 8) {
5775 sharedCacheUUID_address =
5776 (uuid_t *)((uint8_t *)dyld_all_image_infos_address +
5777 160); // sharedCacheUUID <mach-o/dyld_images.h>
5778 if (*version >= 15)
5779 base_addr =
5780 *(uint64_t
5781 *)((uint8_t *)dyld_all_image_infos_address +
5782 176); // sharedCacheBaseAddress <mach-o/dyld_images.h>
5783 } else {
5784 sharedCacheUUID_address =
5785 (uuid_t *)((uint8_t *)dyld_all_image_infos_address +
5786 84); // sharedCacheUUID <mach-o/dyld_images.h>
5787 if (*version >= 15) {
5788 base_addr = 0;
5789 base_addr =
5790 *(uint32_t
5791 *)((uint8_t *)dyld_all_image_infos_address +
5792 100); // sharedCacheBaseAddress <mach-o/dyld_images.h>
5793 }
5794 }
5795 uuid = UUID(sharedCacheUUID_address, sizeof(uuid_t));
5796 }
5797 }
5798 } else {
5799 // Exists in macOS 10.12 and later, iOS 10.0 and later - dyld SPI
5800 dyld_process_info (*dyld_process_info_create)(
5801 unsigned int /* task_t */ task, uint64_t timestamp,
5802 unsigned int /*kern_return_t*/ *kernelError);
5803 void (*dyld_process_info_get_cache)(void *info, void *cacheInfo);
5804 void (*dyld_process_info_release)(dyld_process_info info);
5805
5806 dyld_process_info_create = (void *(*)(unsigned int /* task_t */, uint64_t,
5807 unsigned int /*kern_return_t*/ *))
5808 dlsym(RTLD_DEFAULT, "_dyld_process_info_create");
5809 dyld_process_info_get_cache = (void (*)(void *, void *))dlsym(
5810 RTLD_DEFAULT, "_dyld_process_info_get_cache");
5811 dyld_process_info_release =
5812 (void (*)(void *))dlsym(RTLD_DEFAULT, "_dyld_process_info_release");
5813
5814 if (dyld_process_info_create && dyld_process_info_get_cache) {
5815 unsigned int /*kern_return_t */ kern_ret;
5816 dyld_process_info process_info =
5817 dyld_process_info_create(::mach_task_self(), 0, &kern_ret);
5818 if (process_info) {
5820 memset(&sc_info, 0, sizeof(struct lldb_copy__dyld_process_cache_info));
5821 dyld_process_info_get_cache(process_info, &sc_info);
5822 if (sc_info.cacheBaseAddress != 0) {
5823 base_addr = sc_info.cacheBaseAddress;
5824 uuid = UUID(sc_info.cacheUUID, sizeof(uuid_t));
5825 }
5826 dyld_process_info_release(process_info);
5827 }
5828 }
5829 }
5831 if (log && uuid.IsValid())
5832 LLDB_LOGF(log,
5833 "lldb's in-memory shared cache has a UUID of %s base address of "
5834 "0x%" PRIx64,
5835 uuid.GetAsString().c_str(), base_addr);
5836#endif
5837}
5838
5839static llvm::VersionTuple FindMinimumVersionInfo(DataExtractor &data,
5840 lldb::offset_t offset,
5841 size_t ncmds) {
5842 for (size_t i = 0; i < ncmds; i++) {
5843 const lldb::offset_t load_cmd_offset = offset;
5844 llvm::MachO::load_command lc = {};
5845 if (data.GetU32(&offset, &lc.cmd, 2) == nullptr)
5846 break;
5847
5848 uint32_t version = 0;
5849 if (lc.cmd == llvm::MachO::LC_VERSION_MIN_MACOSX ||
5850 lc.cmd == llvm::MachO::LC_VERSION_MIN_IPHONEOS ||
5851 lc.cmd == llvm::MachO::LC_VERSION_MIN_TVOS ||
5852 lc.cmd == llvm::MachO::LC_VERSION_MIN_WATCHOS) {
5853 // struct version_min_command {
5854 // uint32_t cmd; // LC_VERSION_MIN_*
5855 // uint32_t cmdsize;
5856 // uint32_t version; // X.Y.Z encoded in nibbles xxxx.yy.zz
5857 // uint32_t sdk;
5858 // };
5859 // We want to read version.
5860 version = data.GetU32(&offset);
5861 } else if (lc.cmd == llvm::MachO::LC_BUILD_VERSION) {
5862 // struct build_version_command {
5863 // uint32_t cmd; // LC_BUILD_VERSION
5864 // uint32_t cmdsize;
5865 // uint32_t platform;
5866 // uint32_t minos; // X.Y.Z encoded in nibbles xxxx.yy.zz
5867 // uint32_t sdk;
5868 // uint32_t ntools;
5869 // };
5870 // We want to read minos.
5871 offset += sizeof(uint32_t); // Skip over platform
5872 version = data.GetU32(&offset); // Extract minos
5873 }
5874
5875 if (version) {
5876 const uint32_t xxxx = version >> 16;
5877 const uint32_t yy = (version >> 8) & 0xffu;
5878 const uint32_t zz = version & 0xffu;
5879 if (xxxx)
5880 return llvm::VersionTuple(xxxx, yy, zz);
5881 }
5882 offset = load_cmd_offset + lc.cmdsize;
5883 }
5884 return llvm::VersionTuple();
5885}
5886
5893
5900
5902 return m_header.filetype == llvm::MachO::MH_DYLINKER;
5903}
5904
5906 // Dsymutil guarantees that the .debug_aranges accelerator is complete and can
5907 // be trusted by LLDB.
5908 return m_header.filetype == llvm::MachO::MH_DSYM;
5909}
5910
5914
5916 // Find the first address of the mach header which is the first non-zero file
5917 // sized section whose file offset is zero. This is the base file address of
5918 // the mach-o file which can be subtracted from the vmaddr of the other
5919 // segments found in memory and added to the load address
5920 ModuleSP module_sp = GetModule();
5921 if (!module_sp)
5922 return nullptr;
5923 SectionList *section_list = GetSectionList();
5924 if (!section_list)
5925 return nullptr;
5926
5927 // Some binaries can have a TEXT segment with a non-zero file offset.
5928 // Binaries in the shared cache are one example. Some hand-generated
5929 // binaries may not be laid out in the normal TEXT,DATA,LC_SYMTAB order
5930 // in the file, even though they're laid out correctly in vmaddr terms.
5931 SectionSP text_segment_sp =
5932 section_list->FindSectionByName(GetSegmentNameTEXT());
5933 if (text_segment_sp.get() && SectionIsLoadable(text_segment_sp.get()))
5934 return text_segment_sp.get();
5935
5936 const size_t num_sections = section_list->GetSize();
5937 for (size_t sect_idx = 0; sect_idx < num_sections; ++sect_idx) {
5938 Section *section = section_list->GetSectionAtIndex(sect_idx).get();
5939 if (section->GetFileOffset() == 0 && SectionIsLoadable(section))
5940 return section;
5941 }
5942
5943 return nullptr;
5944}
5945
5947 assert(section.GetObjectFile() == this && "Wrong object file!");
5948 SectionSP segment = section.GetParent();
5949 if (!segment)
5950 return false;
5951
5952 const bool is_data_const_got =
5953 segment->GetName() == "__DATA_CONST" && section.GetName() == "__got";
5954 const bool is_auth_const_ptr =
5955 segment->GetName() == "__AUTH_CONST" &&
5956 (section.GetName() == "__auth_got" || section.GetName() == "__auth_ptr");
5957 return is_data_const_got || is_auth_const_ptr;
5958}
5959
5961 if (!section)
5962 return false;
5963 if (section->IsThreadSpecific())
5964 return false;
5965 if (GetModule().get() != section->GetModule().get())
5966 return false;
5967 // firmware style binaries with llvm gcov segment do
5968 // not have that segment mapped into memory.
5969 if (section->GetName() == GetSegmentNameLLVM_COV()) {
5970 const Strata strata = GetStrata();
5971 if (strata == eStrataKernel || strata == eStrataRawImage)
5972 return false;
5973 }
5974 // Be careful with __LINKEDIT and __DWARF segments
5975 if (section->GetName() == GetSegmentNameLINKEDIT() ||
5976 section->GetName() == GetSegmentNameDWARF()) {
5977 // Only map __LINKEDIT and __DWARF if we have an in memory image and
5978 // this isn't a kernel binary like a kext or mach_kernel.
5979 const bool is_memory_image = (bool)m_process_wp.lock();
5980 const Strata strata = GetStrata();
5981 if (is_memory_image == false || strata == eStrataKernel)
5982 return false;
5983 }
5984 return true;
5985}
5986
5988 lldb::addr_t header_load_address, const Section *header_section,
5989 const Section *section) {
5990 ModuleSP module_sp = GetModule();
5991 if (module_sp && header_section && section &&
5992 header_load_address != LLDB_INVALID_ADDRESS) {
5993 lldb::addr_t file_addr = header_section->GetFileAddress();
5994 if (file_addr != LLDB_INVALID_ADDRESS && SectionIsLoadable(section))
5995 return section->GetFileAddress() - file_addr + header_load_address;
5996 }
5997 return LLDB_INVALID_ADDRESS;
5998}
5999
6001 bool value_is_offset) {
6003 ModuleSP module_sp = GetModule();
6004 if (!module_sp)
6005 return false;
6006
6007 SectionList *section_list = GetSectionList();
6008 if (!section_list)
6009 return false;
6010
6011 size_t num_loaded_sections = 0;
6012 const size_t num_sections = section_list->GetSize();
6013
6014 // Warn if some top-level segments map to the same address. The binary may be
6015 // malformed.
6016 const bool warn_multiple = true;
6017
6018 if (log) {
6019 StreamString logmsg;
6020 logmsg << "ObjectFileMachO::SetLoadAddress ";
6021 if (GetFileSpec())
6022 logmsg << "path='" << GetFileSpec().GetPath() << "' ";
6023 if (GetUUID()) {
6024 logmsg << "uuid=" << GetUUID().GetAsString();
6025 }
6026 LLDB_LOGF(log, "%s", logmsg.GetData());
6027 }
6028 if (value_is_offset) {
6029 // "value" is an offset to apply to each top level segment
6030 for (size_t sect_idx = 0; sect_idx < num_sections; ++sect_idx) {
6031 // Iterate through the object file sections to find all of the
6032 // sections that size on disk (to avoid __PAGEZERO) and load them
6033 SectionSP section_sp(section_list->GetSectionAtIndex(sect_idx));
6034 if (SectionIsLoadable(section_sp.get())) {
6035 LLDB_LOG(
6036 log,
6037 "ObjectFileMachO::SetLoadAddress segment '{0}' load addr is {1:x}",
6038 section_sp->GetName(), section_sp->GetFileAddress() + value);
6039 if (target.SetSectionLoadAddress(section_sp,
6040 section_sp->GetFileAddress() + value,
6041 warn_multiple))
6042 ++num_loaded_sections;
6043 }
6044 }
6045 } else {
6046 // "value" is the new base address of the mach_header, adjust each
6047 // section accordingly
6048
6049 Section *mach_header_section = GetMachHeaderSection();
6050 if (mach_header_section) {
6051 for (size_t sect_idx = 0; sect_idx < num_sections; ++sect_idx) {
6052 SectionSP section_sp(section_list->GetSectionAtIndex(sect_idx));
6053
6054 lldb::addr_t section_load_addr =
6056 value, mach_header_section, section_sp.get());
6057 if (section_load_addr != LLDB_INVALID_ADDRESS) {
6058 LLDB_LOG(log,
6059 "ObjectFileMachO::SetLoadAddress segment '{0}' load addr is "
6060 "{1:x}",
6061 section_sp->GetName(), section_load_addr);
6062 if (target.SetSectionLoadAddress(section_sp, section_load_addr,
6063 warn_multiple))
6064 ++num_loaded_sections;
6065 }
6066 }
6067 }
6068 }
6069 return num_loaded_sections > 0;
6070}
6071
6073 uint32_t version; // currently 1
6074 uint32_t imgcount; // number of binary images
6075 uint64_t entries_fileoff; // file offset in the corefile of where the array of
6076 // struct entry's begin.
6077 uint32_t entries_size; // size of 'struct entry'.
6078 uint32_t unused;
6079};
6080
6082 uint64_t filepath_offset; // offset in corefile to c-string of the file path,
6083 // UINT64_MAX if unavailable.
6084 uuid_t uuid; // uint8_t[16]. should be set to all zeroes if
6085 // uuid is unknown.
6086 uint64_t load_address; // UINT64_MAX if unknown.
6087 uint64_t seg_addrs_offset; // offset to the array of struct segment_vmaddr's.
6088 uint32_t segment_count; // The number of segments for this binary.
6089 uint32_t unused;
6090
6093 memset(&uuid, 0, sizeof(uuid_t));
6094 segment_count = 0;
6097 unused = 0;
6098 }
6101 memcpy(&uuid, &rhs.uuid, sizeof(uuid_t));
6105 unused = rhs.unused;
6106 }
6107};
6108
6110 char segname[16];
6111 uint64_t vmaddr;
6112 uint64_t unused;
6113
6115 memset(&segname, 0, 16);
6117 unused = 0;
6118 }
6120 memcpy(&segname, &rhs.segname, 16);
6121 vmaddr = rhs.vmaddr;
6122 unused = rhs.unused;
6123 }
6124};
6125
6126// Write the payload for the "all image infos" LC_NOTE into
6127// the supplied all_image_infos_payload, assuming that this
6128// will be written into the corefile starting at
6129// initial_file_offset.
6130//
6131// The placement of this payload is a little tricky. We're
6132// laying this out as
6133//
6134// 1. header (struct all_image_info_header)
6135// 2. Array of fixed-size (struct image_entry)'s, one
6136// per binary image present in the process.
6137// 3. Arrays of (struct segment_vmaddr)'s, a varying number
6138// for each binary image.
6139// 4. Variable length c-strings of binary image filepaths,
6140// one per binary.
6141//
6142// To compute where everything will be laid out in the
6143// payload, we need to iterate over the images and calculate
6144// how many segment_vmaddr structures each image will need,
6145// and how long each image's filepath c-string is. There
6146// are some multiple passes over the image list while calculating
6147// everything.
6148
6149static offset_t
6151 offset_t initial_file_offset,
6152 StreamString &all_image_infos_payload,
6154 Target &target = process_sp->GetTarget();
6155 ModuleList modules = target.GetImages();
6156
6157 // stack-only corefiles have no reason to include binaries that
6158 // are not executing; we're trying to make the smallest corefile
6159 // we can, so leave the rest out.
6161 modules.Clear();
6162
6163 std::set<std::string> executing_uuids;
6164 std::vector<ThreadSP> thread_list =
6165 process_sp->CalculateCoreFileThreadList(options);
6166 for (const ThreadSP &thread_sp : thread_list) {
6167 uint32_t stack_frame_count = thread_sp->GetStackFrameCount();
6168 for (uint32_t j = 0; j < stack_frame_count; j++) {
6169 StackFrameSP stack_frame_sp = thread_sp->GetStackFrameAtIndex(j);
6170 Address pc = stack_frame_sp->GetFrameCodeAddress();
6171 ModuleSP module_sp = pc.GetModule();
6172 if (module_sp) {
6173 UUID uuid = module_sp->GetUUID();
6174 if (uuid.IsValid()) {
6175 executing_uuids.insert(uuid.GetAsString());
6176 modules.AppendIfNeeded(module_sp);
6177 }
6178 }
6179 }
6180 }
6181 size_t modules_count = modules.GetSize();
6182
6183 struct all_image_infos_header infos;
6184 infos.version = 1;
6185 infos.imgcount = modules_count;
6186 infos.entries_size = sizeof(image_entry);
6187 infos.entries_fileoff = initial_file_offset + sizeof(all_image_infos_header);
6188 infos.unused = 0;
6189
6190 all_image_infos_payload.PutHex32(infos.version);
6191 all_image_infos_payload.PutHex32(infos.imgcount);
6192 all_image_infos_payload.PutHex64(infos.entries_fileoff);
6193 all_image_infos_payload.PutHex32(infos.entries_size);
6194 all_image_infos_payload.PutHex32(infos.unused);
6195
6196 // First create the structures for all of the segment name+vmaddr vectors
6197 // for each module, so we will know the size of them as we add the
6198 // module entries.
6199 std::vector<std::vector<segment_vmaddr>> modules_segment_vmaddrs;
6200 for (size_t i = 0; i < modules_count; i++) {
6201 ModuleSP module = modules.GetModuleAtIndex(i);
6202
6203 SectionList *sections = module->GetSectionList();
6204 size_t sections_count = sections->GetSize();
6205 std::vector<segment_vmaddr> segment_vmaddrs;
6206 for (size_t j = 0; j < sections_count; j++) {
6207 SectionSP section = sections->GetSectionAtIndex(j);
6208 if (!section->GetParent().get()) {
6209 addr_t vmaddr = section->GetLoadBaseAddress(&target);
6210 if (vmaddr == LLDB_INVALID_ADDRESS)
6211 continue;
6212 ConstString name = section->GetName();
6213 segment_vmaddr seg_vmaddr;
6214 // This is the uncommon case where strncpy is exactly
6215 // the right one, doesn't need to be nul terminated.
6216 // The segment name in a Mach-O LC_SEGMENT/LC_SEGMENT_64 is char[16] and
6217 // is not guaranteed to be nul-terminated if all 16 characters are
6218 // used.
6219 // coverity[buffer_size_warning]
6220 strncpy(seg_vmaddr.segname, name.AsCString(nullptr),
6221 sizeof(seg_vmaddr.segname));
6222 seg_vmaddr.vmaddr = vmaddr;
6223 seg_vmaddr.unused = 0;
6224 segment_vmaddrs.push_back(seg_vmaddr);
6225 }
6226 }
6227 modules_segment_vmaddrs.push_back(segment_vmaddrs);
6228 }
6229
6230 offset_t size_of_vmaddr_structs = 0;
6231 for (size_t i = 0; i < modules_segment_vmaddrs.size(); i++) {
6232 size_of_vmaddr_structs +=
6233 modules_segment_vmaddrs[i].size() * sizeof(segment_vmaddr);
6234 }
6235
6236 offset_t size_of_filepath_cstrings = 0;
6237 for (size_t i = 0; i < modules_count; i++) {
6238 ModuleSP module_sp = modules.GetModuleAtIndex(i);
6239 size_of_filepath_cstrings += module_sp->GetFileSpec().GetPath().size() + 1;
6240 }
6241
6242 // Calculate the file offsets of our "all image infos" payload in the
6243 // corefile. initial_file_offset the original value passed in to this method.
6244
6245 offset_t start_of_entries =
6246 initial_file_offset + sizeof(all_image_infos_header);
6247 offset_t start_of_seg_vmaddrs =
6248 start_of_entries + sizeof(image_entry) * modules_count;
6249 offset_t start_of_filenames = start_of_seg_vmaddrs + size_of_vmaddr_structs;
6250
6251 offset_t final_file_offset = start_of_filenames + size_of_filepath_cstrings;
6252
6253 // Now write the one-per-module 'struct image_entry' into the
6254 // StringStream; keep track of where the struct segment_vmaddr
6255 // entries for each module will end up in the corefile.
6256
6257 offset_t current_string_offset = start_of_filenames;
6258 offset_t current_segaddrs_offset = start_of_seg_vmaddrs;
6259 for (size_t i = 0; i < modules_count; i++) {
6260 ModuleSP module_sp = modules.GetModuleAtIndex(i);
6261
6262 struct image_entry ent;
6263 memcpy(&ent.uuid, module_sp->GetUUID().GetBytes().data(), sizeof(ent.uuid));
6264 if (modules_segment_vmaddrs[i].size() > 0) {
6265 ent.segment_count = modules_segment_vmaddrs[i].size();
6266 ent.seg_addrs_offset = current_segaddrs_offset;
6267 }
6268 ent.filepath_offset = current_string_offset;
6269 ObjectFile *objfile = module_sp->GetObjectFile();
6270 if (objfile) {
6271 Address base_addr(objfile->GetBaseAddress());
6272 if (base_addr.IsValid()) {
6273 ent.load_address = base_addr.GetLoadAddress(&target);
6274 }
6275 }
6276
6277 all_image_infos_payload.PutHex64(ent.filepath_offset);
6278 all_image_infos_payload.PutRawBytes(ent.uuid, sizeof(ent.uuid));
6279 all_image_infos_payload.PutHex64(ent.load_address);
6280 all_image_infos_payload.PutHex64(ent.seg_addrs_offset);
6281 all_image_infos_payload.PutHex32(ent.segment_count);
6282
6283 if (executing_uuids.find(module_sp->GetUUID().GetAsString()) !=
6284 executing_uuids.end())
6285 all_image_infos_payload.PutHex32(1);
6286 else
6287 all_image_infos_payload.PutHex32(0);
6288
6289 current_segaddrs_offset += ent.segment_count * sizeof(segment_vmaddr);
6290 current_string_offset += module_sp->GetFileSpec().GetPath().size() + 1;
6291 }
6292
6293 // Now write the struct segment_vmaddr entries into the StringStream.
6294
6295 for (size_t i = 0; i < modules_segment_vmaddrs.size(); i++) {
6296 if (modules_segment_vmaddrs[i].size() == 0)
6297 continue;
6298 for (struct segment_vmaddr segvm : modules_segment_vmaddrs[i]) {
6299 all_image_infos_payload.PutRawBytes(segvm.segname, sizeof(segvm.segname));
6300 all_image_infos_payload.PutHex64(segvm.vmaddr);
6301 all_image_infos_payload.PutHex64(segvm.unused);
6302 }
6303 }
6304
6305 for (size_t i = 0; i < modules_count; i++) {
6306 ModuleSP module_sp = modules.GetModuleAtIndex(i);
6307 std::string filepath = module_sp->GetFileSpec().GetPath();
6308 all_image_infos_payload.PutRawBytes(filepath.data(), filepath.size() + 1);
6309 }
6310
6311 return final_file_offset;
6312}
6313
6314// Temp struct used to combine contiguous memory regions with
6315// identical permissions.
6321
6324 Status &error) {
6325 // The FileSpec and Process are already checked in PluginManager::SaveCore.
6326 assert(options.GetOutputFile().has_value());
6327 assert(process_sp);
6328 const FileSpec outfile = options.GetOutputFile().value();
6329
6330 // MachO defaults to dirty pages
6333
6334 Target &target = process_sp->GetTarget();
6335 const ArchSpec target_arch = target.GetArchitecture();
6336 const llvm::Triple &target_triple = target_arch.GetTriple();
6337 if (target_triple.getVendor() == llvm::Triple::Apple &&
6338 (target_triple.getOS() == llvm::Triple::MacOSX ||
6339 target_triple.getOS() == llvm::Triple::IOS ||
6340 target_triple.getOS() == llvm::Triple::WatchOS ||
6341 target_triple.getOS() == llvm::Triple::TvOS ||
6342 target_triple.getOS() == llvm::Triple::BridgeOS ||
6343 target_triple.getOS() == llvm::Triple::XROS)) {
6344 bool make_core = false;
6345 switch (target_arch.GetMachine()) {
6346 case llvm::Triple::aarch64:
6347 case llvm::Triple::aarch64_32:
6348 case llvm::Triple::arm:
6349 case llvm::Triple::thumb:
6350 case llvm::Triple::x86:
6351 case llvm::Triple::x86_64:
6352 make_core = true;
6353 break;
6354 default:
6356 "unsupported core architecture: %s", target_triple.str().c_str());
6357 break;
6358 }
6359
6360 if (make_core) {
6361 CoreFileMemoryRanges core_ranges;
6362 error = process_sp->CalculateCoreFileSaveRanges(options, core_ranges);
6363 if (error.Success()) {
6364 const uint32_t addr_byte_size = target_arch.GetAddressByteSize();
6365 const ByteOrder byte_order = target_arch.GetByteOrder();
6366 std::vector<llvm::MachO::segment_command_64> segment_load_commands;
6367 for (const auto &core_range_info : core_ranges) {
6368 // TODO: Refactor RangeDataVector to have a data iterator.
6369 const auto &core_range = core_range_info.data;
6370 uint32_t cmd_type = LC_SEGMENT_64;
6371 uint32_t segment_size = sizeof(llvm::MachO::segment_command_64);
6372 if (addr_byte_size == 4) {
6373 cmd_type = LC_SEGMENT;
6374 segment_size = sizeof(llvm::MachO::segment_command);
6375 }
6376 // Skip any ranges with no read/write/execute permissions and empty
6377 // ranges.
6378 if (core_range.lldb_permissions == 0 || core_range.range.size() == 0)
6379 continue;
6380 uint32_t vm_prot = 0;
6381 if (core_range.lldb_permissions & ePermissionsReadable)
6382 vm_prot |= VM_PROT_READ;
6383 if (core_range.lldb_permissions & ePermissionsWritable)
6384 vm_prot |= VM_PROT_WRITE;
6385 if (core_range.lldb_permissions & ePermissionsExecutable)
6386 vm_prot |= VM_PROT_EXECUTE;
6387 const addr_t vm_addr = core_range.range.start();
6388 const addr_t vm_size = core_range.range.size();
6389 llvm::MachO::segment_command_64 segment = {
6390 cmd_type, // uint32_t cmd;
6391 segment_size, // uint32_t cmdsize;
6392 {0}, // char segname[16];
6393 vm_addr, // uint64_t vmaddr; // uint32_t for 32-bit Mach-O
6394 vm_size, // uint64_t vmsize; // uint32_t for 32-bit Mach-O
6395 0, // uint64_t fileoff; // uint32_t for 32-bit Mach-O
6396 vm_size, // uint64_t filesize; // uint32_t for 32-bit Mach-O
6397 vm_prot, // uint32_t maxprot;
6398 vm_prot, // uint32_t initprot;
6399 0, // uint32_t nsects;
6400 0}; // uint32_t flags;
6401 segment_load_commands.push_back(segment);
6402 }
6403
6404 StreamString buffer(Stream::eBinary, byte_order);
6405
6406 llvm::MachO::mach_header_64 mach_header;
6407 mach_header.magic = addr_byte_size == 8 ? MH_MAGIC_64 : MH_MAGIC;
6408 mach_header.cputype = target_arch.GetMachOCPUType();
6409 mach_header.cpusubtype = target_arch.GetMachOCPUSubType();
6410 mach_header.filetype = MH_CORE;
6411 mach_header.ncmds = segment_load_commands.size();
6412 mach_header.flags = 0;
6413 mach_header.reserved = 0;
6414 ThreadList &thread_list = process_sp->GetThreadList();
6415 const uint32_t num_threads = thread_list.GetSize();
6416
6417 // Make an array of LC_THREAD data items. Each one contains the
6418 // contents of the LC_THREAD load command. The data doesn't contain
6419 // the load command + load command size, we will add the load command
6420 // and load command size as we emit the data.
6421 std::vector<StreamString> LC_THREAD_datas(num_threads);
6422 for (auto &LC_THREAD_data : LC_THREAD_datas) {
6423 LC_THREAD_data.GetFlags().Set(Stream::eBinary);
6424 LC_THREAD_data.SetByteOrder(byte_order);
6425 }
6426 for (uint32_t thread_idx = 0; thread_idx < num_threads; ++thread_idx) {
6427 ThreadSP thread_sp(thread_list.GetThreadAtIndex(thread_idx));
6428 if (thread_sp) {
6429 switch (mach_header.cputype) {
6430 case llvm::MachO::CPU_TYPE_ARM64:
6431 case llvm::MachO::CPU_TYPE_ARM64_32:
6433 thread_sp.get(), LC_THREAD_datas[thread_idx]);
6434 break;
6435
6436 case llvm::MachO::CPU_TYPE_ARM:
6438 thread_sp.get(), LC_THREAD_datas[thread_idx]);
6439 break;
6440
6441 case llvm::MachO::CPU_TYPE_X86_64:
6443 thread_sp.get(), LC_THREAD_datas[thread_idx]);
6444 break;
6445
6446 case llvm::MachO::CPU_TYPE_RISCV:
6448 thread_sp.get(), LC_THREAD_datas[thread_idx]);
6449 break;
6450 }
6451 }
6452 }
6453
6454 // The size of the load command is the size of the segments...
6455 if (addr_byte_size == 8) {
6456 mach_header.sizeofcmds = segment_load_commands.size() *
6457 sizeof(llvm::MachO::segment_command_64);
6458 } else {
6459 mach_header.sizeofcmds = segment_load_commands.size() *
6460 sizeof(llvm::MachO::segment_command);
6461 }
6462
6463 // and the size of all LC_THREAD load command
6464 for (const auto &LC_THREAD_data : LC_THREAD_datas) {
6465 ++mach_header.ncmds;
6466 mach_header.sizeofcmds += 8 + LC_THREAD_data.GetSize();
6467 }
6468
6469 // Bits will be set to indicate which bits are NOT used in
6470 // addressing in this process or 0 for unknown.
6471 uint64_t address_mask = process_sp->GetCodeAddressMask();
6472 if (address_mask != LLDB_INVALID_ADDRESS_MASK) {
6473 // LC_NOTE "addrable bits"
6474 mach_header.ncmds++;
6475 mach_header.sizeofcmds += sizeof(llvm::MachO::note_command);
6476 }
6477
6478 // LC_NOTE "process metadata"
6479 mach_header.ncmds++;
6480 mach_header.sizeofcmds += sizeof(llvm::MachO::note_command);
6481
6482 // LC_NOTE "all image infos"
6483 mach_header.ncmds++;
6484 mach_header.sizeofcmds += sizeof(llvm::MachO::note_command);
6485
6486 // Write the mach header
6487 buffer.PutHex32(mach_header.magic);
6488 buffer.PutHex32(mach_header.cputype);
6489 buffer.PutHex32(mach_header.cpusubtype);
6490 buffer.PutHex32(mach_header.filetype);
6491 buffer.PutHex32(mach_header.ncmds);
6492 buffer.PutHex32(mach_header.sizeofcmds);
6493 buffer.PutHex32(mach_header.flags);
6494 if (addr_byte_size == 8) {
6495 buffer.PutHex32(mach_header.reserved);
6496 }
6497
6498 // Skip the mach header and all load commands and align to the next
6499 // 0x1000 byte boundary
6500 addr_t file_offset = buffer.GetSize() + mach_header.sizeofcmds;
6501
6502 file_offset = llvm::alignTo(file_offset, 16);
6503 std::vector<std::unique_ptr<LCNoteEntry>> lc_notes;
6504
6505 // Add "addrable bits" LC_NOTE when an address mask is available
6506 if (address_mask != LLDB_INVALID_ADDRESS_MASK) {
6507 std::unique_ptr<LCNoteEntry> addrable_bits_lcnote_up(
6508 new LCNoteEntry(byte_order));
6509 addrable_bits_lcnote_up->name = "addrable bits";
6510 addrable_bits_lcnote_up->payload_file_offset = file_offset;
6511 int bits = std::bitset<64>(~address_mask).count();
6512 addrable_bits_lcnote_up->payload.PutHex32(4); // version
6513 addrable_bits_lcnote_up->payload.PutHex32(
6514 bits); // # of bits used for low addresses
6515 addrable_bits_lcnote_up->payload.PutHex32(
6516 bits); // # of bits used for high addresses
6517 addrable_bits_lcnote_up->payload.PutHex32(0); // reserved
6518
6519 file_offset += addrable_bits_lcnote_up->payload.GetSize();
6520
6521 lc_notes.push_back(std::move(addrable_bits_lcnote_up));
6522 }
6523
6524 // Add "process metadata" LC_NOTE
6525 std::unique_ptr<LCNoteEntry> thread_extrainfo_lcnote_up(
6526 new LCNoteEntry(byte_order));
6527 thread_extrainfo_lcnote_up->name = "process metadata";
6528 thread_extrainfo_lcnote_up->payload_file_offset = file_offset;
6529
6531 std::make_shared<StructuredData::Dictionary>());
6533 std::make_shared<StructuredData::Array>());
6534 for (const ThreadSP &thread_sp :
6535 process_sp->CalculateCoreFileThreadList(options)) {
6537 std::make_shared<StructuredData::Dictionary>());
6538 thread->AddIntegerItem("thread_id", thread_sp->GetID());
6539 threads->AddItem(thread);
6540 }
6541 dict->AddItem("threads", threads);
6542 StreamString strm;
6543 dict->Dump(strm, /* pretty */ false);
6544 thread_extrainfo_lcnote_up->payload.PutRawBytes(strm.GetData(),
6545 strm.GetSize());
6546
6547 file_offset += thread_extrainfo_lcnote_up->payload.GetSize();
6548 file_offset = llvm::alignTo(file_offset, 16);
6549 lc_notes.push_back(std::move(thread_extrainfo_lcnote_up));
6550
6551 // Add "all image infos" LC_NOTE
6552 std::unique_ptr<LCNoteEntry> all_image_infos_lcnote_up(
6553 new LCNoteEntry(byte_order));
6554 all_image_infos_lcnote_up->name = "all image infos";
6555 all_image_infos_lcnote_up->payload_file_offset = file_offset;
6556 file_offset = CreateAllImageInfosPayload(
6557 process_sp, file_offset, all_image_infos_lcnote_up->payload,
6558 options);
6559 lc_notes.push_back(std::move(all_image_infos_lcnote_up));
6560
6561 // Add LC_NOTE load commands
6562 for (auto &lcnote : lc_notes) {
6563 // Add the LC_NOTE load command to the file.
6564 buffer.PutHex32(LC_NOTE);
6565 buffer.PutHex32(sizeof(llvm::MachO::note_command));
6566 char namebuf[16];
6567 memset(namebuf, 0, sizeof(namebuf));
6568 // This is the uncommon case where strncpy is exactly
6569 // the right one, doesn't need to be nul terminated.
6570 // LC_NOTE name field is char[16] and is not guaranteed to be
6571 // nul-terminated.
6572 // coverity[buffer_size_warning]
6573 strncpy(namebuf, lcnote->name.c_str(), sizeof(namebuf));
6574 buffer.PutRawBytes(namebuf, sizeof(namebuf));
6575 buffer.PutHex64(lcnote->payload_file_offset);
6576 buffer.PutHex64(lcnote->payload.GetSize());
6577 }
6578
6579 // Align to 4096-byte page boundary for the LC_SEGMENTs.
6580 file_offset = llvm::alignTo(file_offset, 4096);
6581
6582 for (auto &segment : segment_load_commands) {
6583 segment.fileoff = file_offset;
6584 file_offset += segment.filesize;
6585 }
6586
6587 // Write out all of the LC_THREAD load commands
6588 for (const auto &LC_THREAD_data : LC_THREAD_datas) {
6589 const size_t LC_THREAD_data_size = LC_THREAD_data.GetSize();
6590 buffer.PutHex32(LC_THREAD);
6591 buffer.PutHex32(8 + LC_THREAD_data_size); // cmd + cmdsize + data
6592 buffer.Write(LC_THREAD_data.GetString().data(), LC_THREAD_data_size);
6593 }
6594
6595 // Write out all of the segment load commands
6596 for (const auto &segment : segment_load_commands) {
6597 buffer.PutHex32(segment.cmd);
6598 buffer.PutHex32(segment.cmdsize);
6599 buffer.PutRawBytes(segment.segname, sizeof(segment.segname));
6600 if (addr_byte_size == 8) {
6601 buffer.PutHex64(segment.vmaddr);
6602 buffer.PutHex64(segment.vmsize);
6603 buffer.PutHex64(segment.fileoff);
6604 buffer.PutHex64(segment.filesize);
6605 } else {
6606 buffer.PutHex32(static_cast<uint32_t>(segment.vmaddr));
6607 buffer.PutHex32(static_cast<uint32_t>(segment.vmsize));
6608 buffer.PutHex32(static_cast<uint32_t>(segment.fileoff));
6609 buffer.PutHex32(static_cast<uint32_t>(segment.filesize));
6610 }
6611 buffer.PutHex32(segment.maxprot);
6612 buffer.PutHex32(segment.initprot);
6613 buffer.PutHex32(segment.nsects);
6614 buffer.PutHex32(segment.flags);
6615 }
6616
6617 std::string core_file_path(outfile.GetPath());
6618 auto core_file = FileSystem::Instance().Open(
6621 if (!core_file) {
6622 error = Status::FromError(core_file.takeError());
6623 } else {
6624 // Read 1 page at a time
6625 uint8_t bytes[0x1000];
6626 // Write the mach header and load commands out to the core file
6627 size_t bytes_written = buffer.GetString().size();
6628 error =
6629 core_file.get()->Write(buffer.GetString().data(), bytes_written);
6630 if (error.Success()) {
6631
6632 for (auto &lcnote : lc_notes) {
6633 if (core_file.get()->SeekFromStart(lcnote->payload_file_offset) ==
6634 -1) {
6636 "Unable to seek to corefile pos "
6637 "to write '%s' LC_NOTE payload",
6638 lcnote->name.c_str());
6639 return false;
6640 }
6641 bytes_written = lcnote->payload.GetSize();
6642 error = core_file.get()->Write(lcnote->payload.GetData(),
6643 bytes_written);
6644 if (!error.Success())
6645 return false;
6646 }
6647
6648 // Now write the file data for all memory segments in the process
6649 for (const auto &segment : segment_load_commands) {
6650 if (core_file.get()->SeekFromStart(segment.fileoff) == -1) {
6652 "unable to seek to offset 0x%" PRIx64 " in '%s'",
6653 segment.fileoff, core_file_path.c_str());
6654 break;
6655 }
6656
6657 target.GetDebugger().GetAsyncOutputStream()->Printf(
6658 "Saving %" PRId64
6659 " bytes of data for memory region at 0x%" PRIx64 "\n",
6661 addr_t bytes_left = segment.vmsize;
6662 addr_t addr = segment.vmaddr;
6664 while (bytes_left > 0 && error.Success()) {
6665 const size_t bytes_to_read =
6666 bytes_left > sizeof(bytes) ? sizeof(bytes) : bytes_left;
6667
6668 // In a savecore setting, we don't really care about caching,
6669 // as the data is dumped and very likely never read again,
6670 // so we call ReadMemoryFromInferior to bypass it.
6671 const size_t bytes_read = process_sp->ReadMemoryFromInferior(
6672 addr, bytes, bytes_to_read, memory_read_error);
6673
6674 if (bytes_read == bytes_to_read) {
6675 size_t bytes_written = bytes_read;
6676 error = core_file.get()->Write(bytes, bytes_written);
6677 bytes_left -= bytes_read;
6678 addr += bytes_read;
6679 } else {
6680 // Some pages within regions are not readable, those should
6681 // be zero filled
6682 memset(bytes, 0, bytes_to_read);
6683 size_t bytes_written = bytes_to_read;
6684 error = core_file.get()->Write(bytes, bytes_written);
6685 bytes_left -= bytes_to_read;
6686 addr += bytes_to_read;
6687 }
6688 }
6689 }
6690 }
6691 }
6692 }
6693 }
6694 return true; // This is the right plug to handle saving core files for
6695 // this process
6696 }
6697 return false;
6698}
6699
6702 MachOCorefileAllImageInfos image_infos;
6705
6706 auto lc_notes = FindLC_NOTEByName("all image infos");
6707 for (auto lc_note : lc_notes) {
6708 offset_t payload_offset = std::get<0>(lc_note);
6709 // Read the struct all_image_infos_header.
6710 uint32_t version = m_data_nsp->GetU32(&payload_offset);
6711 if (version != 1) {
6712 return image_infos;
6713 }
6714 uint32_t imgcount = m_data_nsp->GetU32(&payload_offset);
6715 uint64_t entries_fileoff = m_data_nsp->GetU64(&payload_offset);
6716 // 'entries_size' is not used, nor is the 'unused' entry.
6717 // offset += 4; // uint32_t entries_size;
6718 // offset += 4; // uint32_t unused;
6719
6720 LLDB_LOGF(log, "LC_NOTE 'all image infos' found version %d with %d images",
6721 version, imgcount);
6722 payload_offset = entries_fileoff;
6723 for (uint32_t i = 0; i < imgcount; i++) {
6724 // Read the struct image_entry.
6725 offset_t filepath_offset = m_data_nsp->GetU64(&payload_offset);
6726 uuid_t uuid;
6727 memcpy(&uuid, m_data_nsp->GetData(&payload_offset, sizeof(uuid_t)),
6728 sizeof(uuid_t));
6729 uint64_t load_address = m_data_nsp->GetU64(&payload_offset);
6730 offset_t seg_addrs_offset = m_data_nsp->GetU64(&payload_offset);
6731 uint32_t segment_count = m_data_nsp->GetU32(&payload_offset);
6732 uint32_t currently_executing = m_data_nsp->GetU32(&payload_offset);
6733
6735 image_entry.filename =
6736 (const char *)m_data_nsp->GetCStr(&filepath_offset);
6737 image_entry.uuid = UUID(uuid, sizeof(uuid_t));
6738 image_entry.load_address = load_address;
6739 image_entry.currently_executing = currently_executing;
6740
6741 offset_t seg_vmaddrs_offset = seg_addrs_offset;
6742 for (uint32_t j = 0; j < segment_count; j++) {
6743 char segname[17];
6744 m_data_nsp->CopyData(seg_vmaddrs_offset, 16, segname);
6745 segname[16] = '\0';
6746 seg_vmaddrs_offset += 16;
6747 uint64_t vmaddr = m_data_nsp->GetU64(&seg_vmaddrs_offset);
6748 seg_vmaddrs_offset += 8; /* unused */
6749
6750 std::tuple<ConstString, addr_t> new_seg{ConstString(segname), vmaddr};
6751 image_entry.segment_load_addresses.push_back(new_seg);
6752 }
6753 LLDB_LOGF(log, " image entry: %s %s 0x%" PRIx64 " %s",
6754 image_entry.filename.c_str(),
6755 image_entry.uuid.GetAsString().c_str(),
6757 image_entry.currently_executing ? "currently executing"
6758 : "not currently executing");
6759 image_infos.all_image_infos.push_back(image_entry);
6760 }
6761 }
6762
6763 lc_notes = FindLC_NOTEByName("load binary");
6764 for (auto lc_note : lc_notes) {
6765 offset_t payload_offset = std::get<0>(lc_note);
6766 uint32_t version = m_data_nsp->GetU32(&payload_offset);
6767 if (version == 1) {
6768 uuid_t uuid;
6769 memcpy(&uuid, m_data_nsp->GetData(&payload_offset, sizeof(uuid_t)),
6770 sizeof(uuid_t));
6771 uint64_t load_address = m_data_nsp->GetU64(&payload_offset);
6772 uint64_t slide = m_data_nsp->GetU64(&payload_offset);
6773 std::string filename = m_data_nsp->GetCStr(&payload_offset);
6774
6776 image_entry.filename = filename;
6777 image_entry.uuid = UUID(uuid, sizeof(uuid_t));
6778 image_entry.load_address = load_address;
6779 image_entry.slide = slide;
6780 image_entry.currently_executing = true;
6781 image_infos.all_image_infos.push_back(image_entry);
6782 LLDB_LOGF(log,
6783 "LC_NOTE 'load binary' found, filename %s uuid %s load "
6784 "address 0x%" PRIx64 " slide 0x%" PRIx64,
6785 filename.c_str(),
6786 image_entry.uuid.IsValid()
6787 ? image_entry.uuid.GetAsString().c_str()
6788 : "00000000-0000-0000-0000-000000000000",
6789 load_address, slide);
6790 }
6791 }
6792
6793 return image_infos;
6794}
6795
6799 Status error;
6800
6801 bool found_platform_binary = false;
6802 ModuleList added_modules;
6803 for (MachOCorefileImageEntry &image : image_infos.all_image_infos) {
6804 ModuleSP module_sp, local_filesystem_module_sp;
6805
6806 // If this is a platform binary, it has been loaded (or registered with
6807 // the DynamicLoader to be loaded), we don't need to do any further
6808 // processing. We're not going to call ModulesDidLoad on this in this
6809 // method, so notify==true.
6810 if (process.GetTarget()
6811 .GetDebugger()
6814 true /* notify */)) {
6815 LLDB_LOGF(log,
6816 "ObjectFileMachO::%s binary at 0x%" PRIx64
6817 " is a platform binary, has been handled by a Platform plugin.",
6818 __FUNCTION__, image.load_address);
6819 continue;
6820 }
6821
6822 bool value_is_offset = image.load_address == LLDB_INVALID_ADDRESS;
6823 uint64_t value = value_is_offset ? image.slide : image.load_address;
6824 if (value_is_offset && value == LLDB_INVALID_ADDRESS) {
6825 // We have neither address nor slide; so we will find the binary
6826 // by UUID and load it at slide/offset 0.
6827 value = 0;
6828 }
6829
6830 // We have either a UUID, or we have a load address which
6831 // and can try to read load commands and find a UUID.
6832 if (image.uuid.IsValid() ||
6833 (!value_is_offset && value != LLDB_INVALID_ADDRESS)) {
6834 const bool set_load_address = image.segment_load_addresses.size() == 0;
6835 const bool notify = false;
6836 // Userland Darwin binaries will have segment load addresses via
6837 // the `all image infos` LC_NOTE.
6838 const bool allow_memory_image_last_resort =
6839 image.segment_load_addresses.size();
6841 &process, image.filename, image.uuid, value, value_is_offset,
6842 image.currently_executing, notify, set_load_address,
6843 allow_memory_image_last_resort);
6844 }
6845
6846 // We have a ModuleSP to load in the Target. Load it at the
6847 // correct address/slide and notify/load scripting resources.
6848 if (module_sp) {
6849 added_modules.Append(module_sp, false /* notify */);
6850
6851 // We have a list of segment load address
6852 if (image.segment_load_addresses.size() > 0) {
6853 if (log) {
6854 std::string uuidstr = image.uuid.GetAsString();
6855 log->Printf("ObjectFileMachO::LoadCoreFileImages adding binary '%s' "
6856 "UUID %s with section load addresses",
6857 module_sp->GetFileSpec().GetPath().c_str(),
6858 uuidstr.c_str());
6859 }
6860 for (auto name_vmaddr_tuple : image.segment_load_addresses) {
6861 SectionList *sectlist = module_sp->GetObjectFile()->GetSectionList();
6862 if (sectlist) {
6863 SectionSP sect_sp =
6864 sectlist->FindSectionByName(std::get<0>(name_vmaddr_tuple));
6865 if (sect_sp) {
6867 sect_sp, std::get<1>(name_vmaddr_tuple));
6868 }
6869 }
6870 }
6871 } else {
6872 if (log) {
6873 std::string uuidstr = image.uuid.GetAsString();
6874 log->Printf("ObjectFileMachO::LoadCoreFileImages adding binary '%s' "
6875 "UUID %s with %s 0x%" PRIx64,
6876 module_sp->GetFileSpec().GetPath().c_str(),
6877 uuidstr.c_str(),
6878 value_is_offset ? "slide" : "load address", value);
6879 }
6880 bool changed;
6881 module_sp->SetLoadAddress(process.GetTarget(), value, value_is_offset,
6882 changed);
6883 }
6884 }
6885 }
6886 if (added_modules.GetSize() > 0) {
6887 process.GetTarget().ModulesDidLoad(added_modules);
6888 process.Flush();
6889 return true;
6890 }
6891 // Return true if the only binary we found was the platform binary,
6892 // and it was loaded outside the scope of this method.
6893 if (found_platform_binary)
6894 return true;
6895
6896 // No binaries.
6897 return false;
6898}
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 bool ParseTrieEntries(DataExtractor &data, lldb::offset_t offset, const bool is_arm, addr_t text_seg_base_addr, std::string &prefix, std::set< lldb::addr_t > &resolver_addresses, std::vector< TrieEntryWithOffset > &reexports, std::vector< TrieEntryWithOffset > &ext_symbols)
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
#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:690
bool IsValid() const
Tests if this ArchSpec is valid.
Definition ArchSpec.h:370
llvm::Triple & GetTriple()
Architecture triple accessor.
Definition ArchSpec.h:460
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:852
uint32_t GetMachOCPUSubType() const
Definition ArchSpec.cpp:670
bool IsCompatibleMatch(const ArchSpec &rhs) const
Shorthand for IsMatch(rhs, CompatibleMatch).
Definition ArchSpec.h:512
uint32_t GetMachOCPUType() const
Definition ArchSpec.cpp:658
lldb::ByteOrder GetByteOrder() const
Returns the byte order for the architecture specification.
Definition ArchSpec.cpp:739
llvm::Triple::ArchType GetMachine() const
Returns a machine family for the current architecture.
Definition ArchSpec.cpp:682
A uniqued constant string class.
Definition ConstString.h:40
std::string GetString() const
Get the string value as a std::string.
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 SetString(llvm::StringRef s)
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:222
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.
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:160
ConstString GetDemangledName() const
Demangled name get accessor.
Definition Mangled.cpp:284
void SetMangledName(ConstString name)
Definition Mangled.h:165
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:779
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:782
const lldb::addr_t m_memory_addr
Set if the object file only exists in memory.
Definition ObjectFile.h:777
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:771
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:766
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:775
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:768
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:357
void Flush()
Flush all data in the process.
Definition Process.cpp:6305
virtual DynamicLoader * GetDynamicLoader()
Get the dynamic loader plug-in for this process.
Definition Process.cpp:3090
Target & GetTarget()
Get the target object pointer for this module.
Definition Process.h:1255
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:111
llvm::raw_ostream & AsRawOstream()
Returns a raw_ostream that forwards the data to this Stream object.
Definition Stream.h:405
size_t Indent(llvm::StringRef s="")
Indent the current line in the stream.
Definition Stream.cpp:157
size_t PutHex64(uint64_t uvalue, lldb::ByteOrder byte_order=lldb::eByteOrderInvalid)
Definition Stream.cpp:307
size_t Printf(const char *format,...) __attribute__((format(printf
Output printf formatted output to the stream.
Definition Stream.cpp:134
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:291
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:364
unsigned GetIndentLevel() const
Get the current indentation level.
Definition Stream.cpp:193
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:5699
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:1909
Debugger & GetDebugger() const
Definition Target.h:1324
const ModuleList & GetImages() const
Get accessor for the images for this process.
Definition Target.h:1241
const ArchSpec & GetArchitecture() const
Definition Target.h:1283
bool SetSectionLoadAddress(const lldb::SectionSP &section, lldb::addr_t load_addr, bool warn_multiple=false)
Definition Target.cpp:3459
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