1 //===-- ObjectFileMachO.cpp -------------------------------------*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 
10 #include "llvm/ADT/StringRef.h"
11 #include "llvm/Support/MachO.h"
12 
13 #include "ObjectFileMachO.h"
14 
15 #include "lldb/Core/ArchSpec.h"
16 #include "lldb/Core/DataBuffer.h"
17 #include "lldb/Core/FileSpecList.h"
18 #include "lldb/Core/Module.h"
19 #include "lldb/Core/PluginManager.h"
20 #include "lldb/Core/RangeMap.h"
21 #include "lldb/Core/Section.h"
22 #include "lldb/Core/StreamFile.h"
23 #include "lldb/Core/StreamString.h"
24 #include "lldb/Core/Timer.h"
25 #include "lldb/Core/UUID.h"
26 #include "lldb/Host/Host.h"
27 #include "lldb/Host/FileSpec.h"
28 #include "lldb/Symbol/ClangNamespaceDecl.h"
29 #include "lldb/Symbol/ObjectFile.h"
30 #include "lldb/Target/Platform.h"
31 #include "lldb/Target/Process.h"
32 #include "lldb/Target/Target.h"
33 #include "Plugins/Process/Utility/RegisterContextDarwin_arm.h"
34 #include "Plugins/Process/Utility/RegisterContextDarwin_i386.h"
35 #include "Plugins/Process/Utility/RegisterContextDarwin_x86_64.h"
36 
37 
38 using namespace lldb;
39 using namespace lldb_private;
40 using namespace llvm::MachO;
41 
42 class RegisterContextDarwin_x86_64_Mach : public RegisterContextDarwin_x86_64
43 {
44 public:
45     RegisterContextDarwin_x86_64_Mach (lldb_private::Thread &thread, const DataExtractor &data) :
46         RegisterContextDarwin_x86_64 (thread, 0)
47     {
48         SetRegisterDataFrom_LC_THREAD (data);
49     }
50 
51     virtual void
52     InvalidateAllRegisters ()
53     {
54         // Do nothing... registers are always valid...
55     }
56 
57     void
58     SetRegisterDataFrom_LC_THREAD (const DataExtractor &data)
59     {
60         uint32_t offset = 0;
61         SetError (GPRRegSet, Read, -1);
62         SetError (FPURegSet, Read, -1);
63         SetError (EXCRegSet, Read, -1);
64         bool done = false;
65 
66         while (!done)
67         {
68             int flavor = data.GetU32 (&offset);
69             if (flavor == 0)
70                 done = true;
71             else
72             {
73                 uint32_t i;
74                 uint32_t count = data.GetU32 (&offset);
75                 switch (flavor)
76                 {
77                     case GPRRegSet:
78                         for (i=0; i<count; ++i)
79                             (&gpr.rax)[i] = data.GetU64(&offset);
80                         SetError (GPRRegSet, Read, 0);
81                         done = true;
82 
83                         break;
84                     case FPURegSet:
85                         // TODO: fill in FPU regs....
86                         //SetError (FPURegSet, Read, -1);
87                         done = true;
88 
89                         break;
90                     case EXCRegSet:
91                         exc.trapno = data.GetU32(&offset);
92                         exc.err = data.GetU32(&offset);
93                         exc.faultvaddr = data.GetU64(&offset);
94                         SetError (EXCRegSet, Read, 0);
95                         done = true;
96                         break;
97                     case 7:
98                     case 8:
99                     case 9:
100                         // fancy flavors that encapsulate of the the above
101                         // falvors...
102                         break;
103 
104                     default:
105                         done = true;
106                         break;
107                 }
108             }
109         }
110     }
111 protected:
112     virtual int
113     DoReadGPR (lldb::tid_t tid, int flavor, GPR &gpr)
114     {
115         return 0;
116     }
117 
118     virtual int
119     DoReadFPU (lldb::tid_t tid, int flavor, FPU &fpu)
120     {
121         return 0;
122     }
123 
124     virtual int
125     DoReadEXC (lldb::tid_t tid, int flavor, EXC &exc)
126     {
127         return 0;
128     }
129 
130     virtual int
131     DoWriteGPR (lldb::tid_t tid, int flavor, const GPR &gpr)
132     {
133         return 0;
134     }
135 
136     virtual int
137     DoWriteFPU (lldb::tid_t tid, int flavor, const FPU &fpu)
138     {
139         return 0;
140     }
141 
142     virtual int
143     DoWriteEXC (lldb::tid_t tid, int flavor, const EXC &exc)
144     {
145         return 0;
146     }
147 };
148 
149 
150 class RegisterContextDarwin_i386_Mach : public RegisterContextDarwin_i386
151 {
152 public:
153     RegisterContextDarwin_i386_Mach (lldb_private::Thread &thread, const DataExtractor &data) :
154     RegisterContextDarwin_i386 (thread, 0)
155     {
156         SetRegisterDataFrom_LC_THREAD (data);
157     }
158 
159     virtual void
160     InvalidateAllRegisters ()
161     {
162         // Do nothing... registers are always valid...
163     }
164 
165     void
166     SetRegisterDataFrom_LC_THREAD (const DataExtractor &data)
167     {
168         uint32_t offset = 0;
169         SetError (GPRRegSet, Read, -1);
170         SetError (FPURegSet, Read, -1);
171         SetError (EXCRegSet, Read, -1);
172         bool done = false;
173 
174         while (!done)
175         {
176             int flavor = data.GetU32 (&offset);
177             if (flavor == 0)
178                 done = true;
179             else
180             {
181                 uint32_t i;
182                 uint32_t count = data.GetU32 (&offset);
183                 switch (flavor)
184                 {
185                     case GPRRegSet:
186                         for (i=0; i<count; ++i)
187                             (&gpr.eax)[i] = data.GetU32(&offset);
188                         SetError (GPRRegSet, Read, 0);
189                         done = true;
190 
191                         break;
192                     case FPURegSet:
193                         // TODO: fill in FPU regs....
194                         //SetError (FPURegSet, Read, -1);
195                         done = true;
196 
197                         break;
198                     case EXCRegSet:
199                         exc.trapno = data.GetU32(&offset);
200                         exc.err = data.GetU32(&offset);
201                         exc.faultvaddr = data.GetU32(&offset);
202                         SetError (EXCRegSet, Read, 0);
203                         done = true;
204                         break;
205                     case 7:
206                     case 8:
207                     case 9:
208                         // fancy flavors that encapsulate of the the above
209                         // falvors...
210                         break;
211 
212                     default:
213                         done = true;
214                         break;
215                 }
216             }
217         }
218     }
219 protected:
220     virtual int
221     DoReadGPR (lldb::tid_t tid, int flavor, GPR &gpr)
222     {
223         return 0;
224     }
225 
226     virtual int
227     DoReadFPU (lldb::tid_t tid, int flavor, FPU &fpu)
228     {
229         return 0;
230     }
231 
232     virtual int
233     DoReadEXC (lldb::tid_t tid, int flavor, EXC &exc)
234     {
235         return 0;
236     }
237 
238     virtual int
239     DoWriteGPR (lldb::tid_t tid, int flavor, const GPR &gpr)
240     {
241         return 0;
242     }
243 
244     virtual int
245     DoWriteFPU (lldb::tid_t tid, int flavor, const FPU &fpu)
246     {
247         return 0;
248     }
249 
250     virtual int
251     DoWriteEXC (lldb::tid_t tid, int flavor, const EXC &exc)
252     {
253         return 0;
254     }
255 };
256 
257 class RegisterContextDarwin_arm_Mach : public RegisterContextDarwin_arm
258 {
259 public:
260     RegisterContextDarwin_arm_Mach (lldb_private::Thread &thread, const DataExtractor &data) :
261     RegisterContextDarwin_arm (thread, 0)
262     {
263         SetRegisterDataFrom_LC_THREAD (data);
264     }
265 
266     virtual void
267     InvalidateAllRegisters ()
268     {
269         // Do nothing... registers are always valid...
270     }
271 
272     void
273     SetRegisterDataFrom_LC_THREAD (const DataExtractor &data)
274     {
275         uint32_t offset = 0;
276         SetError (GPRRegSet, Read, -1);
277         SetError (FPURegSet, Read, -1);
278         SetError (EXCRegSet, Read, -1);
279         int flavor = data.GetU32 (&offset);
280         uint32_t count = data.GetU32 (&offset);
281         switch (flavor)
282         {
283             case GPRRegSet:
284                 for (uint32_t i=0; i<count; ++i)
285                     gpr.r[i] = data.GetU32(&offset);
286                 SetError (GPRRegSet, Read, 0);
287                 break;
288             case FPURegSet:
289                 // TODO: fill in FPU regs....
290                 //SetError (FPURegSet, Read, -1);
291                 break;
292             case EXCRegSet:
293                 exc.exception = data.GetU32(&offset);
294                 exc.fsr = data.GetU32(&offset);
295                 exc.far = data.GetU32(&offset);
296                 SetError (EXCRegSet, Read, 0);
297                 break;
298         }
299     }
300 protected:
301     virtual int
302     DoReadGPR (lldb::tid_t tid, int flavor, GPR &gpr)
303     {
304         return 0;
305     }
306 
307     virtual int
308     DoReadFPU (lldb::tid_t tid, int flavor, FPU &fpu)
309     {
310         return 0;
311     }
312 
313     virtual int
314     DoReadEXC (lldb::tid_t tid, int flavor, EXC &exc)
315     {
316         return 0;
317     }
318 
319     virtual int
320     DoWriteGPR (lldb::tid_t tid, int flavor, const GPR &gpr)
321     {
322         return 0;
323     }
324 
325     virtual int
326     DoWriteFPU (lldb::tid_t tid, int flavor, const FPU &fpu)
327     {
328         return 0;
329     }
330 
331     virtual int
332     DoWriteEXC (lldb::tid_t tid, int flavor, const EXC &exc)
333     {
334         return 0;
335     }
336 };
337 
338 #define MACHO_NLIST_ARM_SYMBOL_IS_THUMB 0x0008
339 
340 void
341 ObjectFileMachO::Initialize()
342 {
343     PluginManager::RegisterPlugin (GetPluginNameStatic(),
344                                    GetPluginDescriptionStatic(),
345                                    CreateInstance,
346                                    CreateMemoryInstance);
347 }
348 
349 void
350 ObjectFileMachO::Terminate()
351 {
352     PluginManager::UnregisterPlugin (CreateInstance);
353 }
354 
355 
356 const char *
357 ObjectFileMachO::GetPluginNameStatic()
358 {
359     return "object-file.mach-o";
360 }
361 
362 const char *
363 ObjectFileMachO::GetPluginDescriptionStatic()
364 {
365     return "Mach-o object file reader (32 and 64 bit)";
366 }
367 
368 
369 ObjectFile *
370 ObjectFileMachO::CreateInstance (const lldb::ModuleSP &module_sp, DataBufferSP& data_sp, const FileSpec* file, addr_t offset, addr_t length)
371 {
372     if (ObjectFileMachO::MagicBytesMatch(data_sp, offset, length))
373     {
374         std::auto_ptr<ObjectFile> objfile_ap(new ObjectFileMachO (module_sp, data_sp, file, offset, length));
375         if (objfile_ap.get() && objfile_ap->ParseHeader())
376             return objfile_ap.release();
377     }
378     return NULL;
379 }
380 
381 ObjectFile *
382 ObjectFileMachO::CreateMemoryInstance (const lldb::ModuleSP &module_sp,
383                                        DataBufferSP& data_sp,
384                                        const ProcessSP &process_sp,
385                                        lldb::addr_t header_addr)
386 {
387     if (ObjectFileMachO::MagicBytesMatch(data_sp, 0, data_sp->GetByteSize()))
388     {
389         std::auto_ptr<ObjectFile> objfile_ap(new ObjectFileMachO (module_sp, data_sp, process_sp, header_addr));
390         if (objfile_ap.get() && objfile_ap->ParseHeader())
391             return objfile_ap.release();
392     }
393     return NULL;
394 }
395 
396 
397 const ConstString &
398 ObjectFileMachO::GetSegmentNameTEXT()
399 {
400     static ConstString g_segment_name_TEXT ("__TEXT");
401     return g_segment_name_TEXT;
402 }
403 
404 const ConstString &
405 ObjectFileMachO::GetSegmentNameDATA()
406 {
407     static ConstString g_segment_name_DATA ("__DATA");
408     return g_segment_name_DATA;
409 }
410 
411 const ConstString &
412 ObjectFileMachO::GetSegmentNameOBJC()
413 {
414     static ConstString g_segment_name_OBJC ("__OBJC");
415     return g_segment_name_OBJC;
416 }
417 
418 const ConstString &
419 ObjectFileMachO::GetSegmentNameLINKEDIT()
420 {
421     static ConstString g_section_name_LINKEDIT ("__LINKEDIT");
422     return g_section_name_LINKEDIT;
423 }
424 
425 const ConstString &
426 ObjectFileMachO::GetSectionNameEHFrame()
427 {
428     static ConstString g_section_name_eh_frame ("__eh_frame");
429     return g_section_name_eh_frame;
430 }
431 
432 
433 
434 static uint32_t
435 MachHeaderSizeFromMagic(uint32_t magic)
436 {
437     switch (magic)
438     {
439     case HeaderMagic32:
440     case HeaderMagic32Swapped:
441         return sizeof(struct mach_header);
442 
443     case HeaderMagic64:
444     case HeaderMagic64Swapped:
445         return sizeof(struct mach_header_64);
446         break;
447 
448     default:
449         break;
450     }
451     return 0;
452 }
453 
454 
455 bool
456 ObjectFileMachO::MagicBytesMatch (DataBufferSP& data_sp,
457                                   lldb::addr_t data_offset,
458                                   lldb::addr_t data_length)
459 {
460     DataExtractor data;
461     data.SetData (data_sp, data_offset, data_length);
462     uint32_t offset = 0;
463     uint32_t magic = data.GetU32(&offset);
464     return MachHeaderSizeFromMagic(magic) != 0;
465 }
466 
467 
468 ObjectFileMachO::ObjectFileMachO(const lldb::ModuleSP &module_sp, DataBufferSP& data_sp, const FileSpec* file, addr_t offset, addr_t length) :
469     ObjectFile(module_sp, file, offset, length, data_sp),
470     m_sections_ap(),
471     m_symtab_ap(),
472     m_mach_segments(),
473     m_mach_sections(),
474     m_entry_point_address(),
475     m_thread_context_offsets(),
476     m_thread_context_offsets_valid(false)
477 {
478     ::memset (&m_header, 0, sizeof(m_header));
479     ::memset (&m_dysymtab, 0, sizeof(m_dysymtab));
480 }
481 
482 ObjectFileMachO::ObjectFileMachO (const lldb::ModuleSP &module_sp,
483                                   lldb::DataBufferSP& header_data_sp,
484                                   const lldb::ProcessSP &process_sp,
485                                   lldb::addr_t header_addr) :
486     ObjectFile(module_sp, process_sp, header_addr, header_data_sp),
487     m_sections_ap(),
488     m_symtab_ap(),
489     m_mach_segments(),
490     m_mach_sections(),
491     m_entry_point_address(),
492     m_thread_context_offsets(),
493     m_thread_context_offsets_valid(false)
494 {
495     ::memset (&m_header, 0, sizeof(m_header));
496     ::memset (&m_dysymtab, 0, sizeof(m_dysymtab));
497 }
498 
499 ObjectFileMachO::~ObjectFileMachO()
500 {
501 }
502 
503 
504 bool
505 ObjectFileMachO::ParseHeader ()
506 {
507     ModuleSP module_sp(GetModule());
508     if (module_sp)
509     {
510         lldb_private::Mutex::Locker locker(module_sp->GetMutex());
511         bool can_parse = false;
512         uint32_t offset = 0;
513         m_data.SetByteOrder (lldb::endian::InlHostByteOrder());
514         // Leave magic in the original byte order
515         m_header.magic = m_data.GetU32(&offset);
516         switch (m_header.magic)
517         {
518         case HeaderMagic32:
519             m_data.SetByteOrder (lldb::endian::InlHostByteOrder());
520             m_data.SetAddressByteSize(4);
521             can_parse = true;
522             break;
523 
524         case HeaderMagic64:
525             m_data.SetByteOrder (lldb::endian::InlHostByteOrder());
526             m_data.SetAddressByteSize(8);
527             can_parse = true;
528             break;
529 
530         case HeaderMagic32Swapped:
531             m_data.SetByteOrder(lldb::endian::InlHostByteOrder() == eByteOrderBig ? eByteOrderLittle : eByteOrderBig);
532             m_data.SetAddressByteSize(4);
533             can_parse = true;
534             break;
535 
536         case HeaderMagic64Swapped:
537             m_data.SetByteOrder(lldb::endian::InlHostByteOrder() == eByteOrderBig ? eByteOrderLittle : eByteOrderBig);
538             m_data.SetAddressByteSize(8);
539             can_parse = true;
540             break;
541 
542         default:
543             break;
544         }
545 
546         if (can_parse)
547         {
548             m_data.GetU32(&offset, &m_header.cputype, 6);
549 
550             ArchSpec mach_arch(eArchTypeMachO, m_header.cputype, m_header.cpusubtype);
551 
552             if (SetModulesArchitecture (mach_arch))
553             {
554                 const size_t header_and_lc_size = m_header.sizeofcmds + MachHeaderSizeFromMagic(m_header.magic);
555                 if (m_data.GetByteSize() < header_and_lc_size)
556                 {
557                     DataBufferSP data_sp;
558                     ProcessSP process_sp (m_process_wp.lock());
559                     if (process_sp)
560                     {
561                         data_sp = ReadMemory (process_sp, m_offset, header_and_lc_size);
562                     }
563                     else
564                     {
565                         // Read in all only the load command data from the file on disk
566                         data_sp = m_file.ReadFileContents(m_offset, header_and_lc_size);
567                         if (data_sp->GetByteSize() != header_and_lc_size)
568                             return false;
569                     }
570                     if (data_sp)
571                         m_data.SetData (data_sp);
572                 }
573             }
574             return true;
575         }
576         else
577         {
578             memset(&m_header, 0, sizeof(struct mach_header));
579         }
580     }
581     return false;
582 }
583 
584 
585 ByteOrder
586 ObjectFileMachO::GetByteOrder () const
587 {
588     return m_data.GetByteOrder ();
589 }
590 
591 bool
592 ObjectFileMachO::IsExecutable() const
593 {
594     return m_header.filetype == HeaderFileTypeExecutable;
595 }
596 
597 size_t
598 ObjectFileMachO::GetAddressByteSize () const
599 {
600     return m_data.GetAddressByteSize ();
601 }
602 
603 AddressClass
604 ObjectFileMachO::GetAddressClass (lldb::addr_t file_addr)
605 {
606     Symtab *symtab = GetSymtab();
607     if (symtab)
608     {
609         Symbol *symbol = symtab->FindSymbolContainingFileAddress(file_addr);
610         if (symbol)
611         {
612             if (symbol->ValueIsAddress())
613             {
614                 SectionSP section_sp (symbol->GetAddress().GetSection());
615                 if (section_sp)
616                 {
617                     const SectionType section_type = section_sp->GetType();
618                     switch (section_type)
619                     {
620                     case eSectionTypeInvalid:               return eAddressClassUnknown;
621                     case eSectionTypeCode:
622                         if (m_header.cputype == llvm::MachO::CPUTypeARM)
623                         {
624                             // For ARM we have a bit in the n_desc field of the symbol
625                             // that tells us ARM/Thumb which is bit 0x0008.
626                             if (symbol->GetFlags() & MACHO_NLIST_ARM_SYMBOL_IS_THUMB)
627                                 return eAddressClassCodeAlternateISA;
628                         }
629                         return eAddressClassCode;
630 
631                     case eSectionTypeContainer:             return eAddressClassUnknown;
632                     case eSectionTypeData:
633                     case eSectionTypeDataCString:
634                     case eSectionTypeDataCStringPointers:
635                     case eSectionTypeDataSymbolAddress:
636                     case eSectionTypeData4:
637                     case eSectionTypeData8:
638                     case eSectionTypeData16:
639                     case eSectionTypeDataPointers:
640                     case eSectionTypeZeroFill:
641                     case eSectionTypeDataObjCMessageRefs:
642                     case eSectionTypeDataObjCCFStrings:
643                         return eAddressClassData;
644                     case eSectionTypeDebug:
645                     case eSectionTypeDWARFDebugAbbrev:
646                     case eSectionTypeDWARFDebugAranges:
647                     case eSectionTypeDWARFDebugFrame:
648                     case eSectionTypeDWARFDebugInfo:
649                     case eSectionTypeDWARFDebugLine:
650                     case eSectionTypeDWARFDebugLoc:
651                     case eSectionTypeDWARFDebugMacInfo:
652                     case eSectionTypeDWARFDebugPubNames:
653                     case eSectionTypeDWARFDebugPubTypes:
654                     case eSectionTypeDWARFDebugRanges:
655                     case eSectionTypeDWARFDebugStr:
656                     case eSectionTypeDWARFAppleNames:
657                     case eSectionTypeDWARFAppleTypes:
658                     case eSectionTypeDWARFAppleNamespaces:
659                     case eSectionTypeDWARFAppleObjC:
660                         return eAddressClassDebug;
661                     case eSectionTypeEHFrame:               return eAddressClassRuntime;
662                     case eSectionTypeOther:                 return eAddressClassUnknown;
663                     }
664                 }
665             }
666 
667             const SymbolType symbol_type = symbol->GetType();
668             switch (symbol_type)
669             {
670             case eSymbolTypeAny:            return eAddressClassUnknown;
671             case eSymbolTypeAbsolute:       return eAddressClassUnknown;
672 
673             case eSymbolTypeCode:
674             case eSymbolTypeTrampoline:
675                 if (m_header.cputype == llvm::MachO::CPUTypeARM)
676                 {
677                     // For ARM we have a bit in the n_desc field of the symbol
678                     // that tells us ARM/Thumb which is bit 0x0008.
679                     if (symbol->GetFlags() & MACHO_NLIST_ARM_SYMBOL_IS_THUMB)
680                         return eAddressClassCodeAlternateISA;
681                 }
682                 return eAddressClassCode;
683 
684             case eSymbolTypeData:           return eAddressClassData;
685             case eSymbolTypeRuntime:        return eAddressClassRuntime;
686             case eSymbolTypeException:      return eAddressClassRuntime;
687             case eSymbolTypeSourceFile:     return eAddressClassDebug;
688             case eSymbolTypeHeaderFile:     return eAddressClassDebug;
689             case eSymbolTypeObjectFile:     return eAddressClassDebug;
690             case eSymbolTypeCommonBlock:    return eAddressClassDebug;
691             case eSymbolTypeBlock:          return eAddressClassDebug;
692             case eSymbolTypeLocal:          return eAddressClassData;
693             case eSymbolTypeParam:          return eAddressClassData;
694             case eSymbolTypeVariable:       return eAddressClassData;
695             case eSymbolTypeVariableType:   return eAddressClassDebug;
696             case eSymbolTypeLineEntry:      return eAddressClassDebug;
697             case eSymbolTypeLineHeader:     return eAddressClassDebug;
698             case eSymbolTypeScopeBegin:     return eAddressClassDebug;
699             case eSymbolTypeScopeEnd:       return eAddressClassDebug;
700             case eSymbolTypeAdditional:     return eAddressClassUnknown;
701             case eSymbolTypeCompiler:       return eAddressClassDebug;
702             case eSymbolTypeInstrumentation:return eAddressClassDebug;
703             case eSymbolTypeUndefined:      return eAddressClassUnknown;
704             case eSymbolTypeObjCClass:      return eAddressClassRuntime;
705             case eSymbolTypeObjCMetaClass:  return eAddressClassRuntime;
706             case eSymbolTypeObjCIVar:       return eAddressClassRuntime;
707             }
708         }
709     }
710     return eAddressClassUnknown;
711 }
712 
713 Symtab *
714 ObjectFileMachO::GetSymtab()
715 {
716     ModuleSP module_sp(GetModule());
717     if (module_sp)
718     {
719         lldb_private::Mutex::Locker locker(module_sp->GetMutex());
720         if (m_symtab_ap.get() == NULL)
721         {
722             m_symtab_ap.reset(new Symtab(this));
723             Mutex::Locker symtab_locker (m_symtab_ap->GetMutex());
724             ParseSymtab (true);
725             m_symtab_ap->Finalize ();
726         }
727     }
728     return m_symtab_ap.get();
729 }
730 
731 
732 SectionList *
733 ObjectFileMachO::GetSectionList()
734 {
735     ModuleSP module_sp(GetModule());
736     if (module_sp)
737     {
738         lldb_private::Mutex::Locker locker(module_sp->GetMutex());
739         if (m_sections_ap.get() == NULL)
740         {
741             m_sections_ap.reset(new SectionList());
742             ParseSections();
743         }
744     }
745     return m_sections_ap.get();
746 }
747 
748 
749 size_t
750 ObjectFileMachO::ParseSections ()
751 {
752     lldb::user_id_t segID = 0;
753     lldb::user_id_t sectID = 0;
754     uint32_t offset = MachHeaderSizeFromMagic(m_header.magic);
755     uint32_t i;
756     const bool is_core = GetType() == eTypeCoreFile;
757     //bool dump_sections = false;
758     ModuleSP module_sp (GetModule());
759     // First look up any LC_ENCRYPTION_INFO load commands
760     typedef RangeArray<uint32_t, uint32_t, 8> EncryptedFileRanges;
761     EncryptedFileRanges encrypted_file_ranges;
762     encryption_info_command encryption_cmd;
763     for (i=0; i<m_header.ncmds; ++i)
764     {
765         const uint32_t load_cmd_offset = offset;
766         if (m_data.GetU32(&offset, &encryption_cmd, 2) == NULL)
767             break;
768 
769         if (encryption_cmd.cmd == LoadCommandEncryptionInfo)
770         {
771             if (m_data.GetU32(&offset, &encryption_cmd.cryptoff, 3))
772             {
773                 if (encryption_cmd.cryptid != 0)
774                 {
775                     EncryptedFileRanges::Entry entry;
776                     entry.SetRangeBase(encryption_cmd.cryptoff);
777                     entry.SetByteSize(encryption_cmd.cryptsize);
778                     encrypted_file_ranges.Append(entry);
779                 }
780             }
781         }
782         offset = load_cmd_offset + encryption_cmd.cmdsize;
783     }
784 
785     offset = MachHeaderSizeFromMagic(m_header.magic);
786 
787     struct segment_command_64 load_cmd;
788     for (i=0; i<m_header.ncmds; ++i)
789     {
790         const uint32_t load_cmd_offset = offset;
791         if (m_data.GetU32(&offset, &load_cmd, 2) == NULL)
792             break;
793 
794         if (load_cmd.cmd == LoadCommandSegment32 || load_cmd.cmd == LoadCommandSegment64)
795         {
796             if (m_data.GetU8(&offset, (uint8_t*)load_cmd.segname, 16))
797             {
798                 load_cmd.vmaddr = m_data.GetAddress(&offset);
799                 load_cmd.vmsize = m_data.GetAddress(&offset);
800                 load_cmd.fileoff = m_data.GetAddress(&offset);
801                 load_cmd.filesize = m_data.GetAddress(&offset);
802                 if (m_data.GetU32(&offset, &load_cmd.maxprot, 4))
803                 {
804 
805                     const bool segment_is_encrypted = (load_cmd.flags & SegmentCommandFlagBitProtectedVersion1) != 0;
806 
807                     // Keep a list of mach segments around in case we need to
808                     // get at data that isn't stored in the abstracted Sections.
809                     m_mach_segments.push_back (load_cmd);
810 
811                     ConstString segment_name (load_cmd.segname, std::min<int>(strlen(load_cmd.segname), sizeof(load_cmd.segname)));
812                     // Use a segment ID of the segment index shifted left by 8 so they
813                     // never conflict with any of the sections.
814                     SectionSP segment_sp;
815                     if (segment_name || is_core)
816                     {
817                         segment_sp.reset(new Section (module_sp,              // Module to which this section belongs
818                                                       ++segID << 8,           // Section ID is the 1 based segment index shifted right by 8 bits as not to collide with any of the 256 section IDs that are possible
819                                                       segment_name,           // Name of this section
820                                                       eSectionTypeContainer,  // This section is a container of other sections.
821                                                       load_cmd.vmaddr,        // File VM address == addresses as they are found in the object file
822                                                       load_cmd.vmsize,        // VM size in bytes of this section
823                                                       load_cmd.fileoff,       // Offset to the data for this section in the file
824                                                       load_cmd.filesize,      // Size in bytes of this section as found in the the file
825                                                       load_cmd.flags));       // Flags for this section
826 
827                         segment_sp->SetIsEncrypted (segment_is_encrypted);
828                         m_sections_ap->AddSection(segment_sp);
829                     }
830 
831                     struct section_64 sect64;
832                     ::memset (&sect64, 0, sizeof(sect64));
833                     // Push a section into our mach sections for the section at
834                     // index zero (NListSectionNoSection) if we don't have any
835                     // mach sections yet...
836                     if (m_mach_sections.empty())
837                         m_mach_sections.push_back(sect64);
838                     uint32_t segment_sect_idx;
839                     const lldb::user_id_t first_segment_sectID = sectID + 1;
840 
841 
842                     const uint32_t num_u32s = load_cmd.cmd == LoadCommandSegment32 ? 7 : 8;
843                     for (segment_sect_idx=0; segment_sect_idx<load_cmd.nsects; ++segment_sect_idx)
844                     {
845                         if (m_data.GetU8(&offset, (uint8_t*)sect64.sectname, sizeof(sect64.sectname)) == NULL)
846                             break;
847                         if (m_data.GetU8(&offset, (uint8_t*)sect64.segname, sizeof(sect64.segname)) == NULL)
848                             break;
849                         sect64.addr = m_data.GetAddress(&offset);
850                         sect64.size = m_data.GetAddress(&offset);
851 
852                         if (m_data.GetU32(&offset, &sect64.offset, num_u32s) == NULL)
853                             break;
854 
855                         // Keep a list of mach sections around in case we need to
856                         // get at data that isn't stored in the abstracted Sections.
857                         m_mach_sections.push_back (sect64);
858 
859                         ConstString section_name (sect64.sectname, std::min<size_t>(strlen(sect64.sectname), sizeof(sect64.sectname)));
860                         if (!segment_name)
861                         {
862                             // We have a segment with no name so we need to conjure up
863                             // segments that correspond to the section's segname if there
864                             // isn't already such a section. If there is such a section,
865                             // we resize the section so that it spans all sections.
866                             // We also mark these sections as fake so address matches don't
867                             // hit if they land in the gaps between the child sections.
868                             segment_name.SetTrimmedCStringWithLength(sect64.segname, sizeof(sect64.segname));
869                             segment_sp = m_sections_ap->FindSectionByName (segment_name);
870                             if (segment_sp.get())
871                             {
872                                 Section *segment = segment_sp.get();
873                                 // Grow the section size as needed.
874                                 const lldb::addr_t sect64_min_addr = sect64.addr;
875                                 const lldb::addr_t sect64_max_addr = sect64_min_addr + sect64.size;
876                                 const lldb::addr_t curr_seg_byte_size = segment->GetByteSize();
877                                 const lldb::addr_t curr_seg_min_addr = segment->GetFileAddress();
878                                 const lldb::addr_t curr_seg_max_addr = curr_seg_min_addr + curr_seg_byte_size;
879                                 if (sect64_min_addr >= curr_seg_min_addr)
880                                 {
881                                     const lldb::addr_t new_seg_byte_size = sect64_max_addr - curr_seg_min_addr;
882                                     // Only grow the section size if needed
883                                     if (new_seg_byte_size > curr_seg_byte_size)
884                                         segment->SetByteSize (new_seg_byte_size);
885                                 }
886                                 else
887                                 {
888                                     // We need to change the base address of the segment and
889                                     // adjust the child section offsets for all existing children.
890                                     const lldb::addr_t slide_amount = sect64_min_addr - curr_seg_min_addr;
891                                     segment->Slide(slide_amount, false);
892                                     segment->GetChildren().Slide (-slide_amount, false);
893                                     segment->SetByteSize (curr_seg_max_addr - sect64_min_addr);
894                                 }
895 
896                                 // Grow the section size as needed.
897                                 if (sect64.offset)
898                                 {
899                                     const lldb::addr_t segment_min_file_offset = segment->GetFileOffset();
900                                     const lldb::addr_t segment_max_file_offset = segment_min_file_offset + segment->GetFileSize();
901 
902                                     const lldb::addr_t section_min_file_offset = sect64.offset;
903                                     const lldb::addr_t section_max_file_offset = section_min_file_offset + sect64.size;
904                                     const lldb::addr_t new_file_offset = std::min (section_min_file_offset, segment_min_file_offset);
905                                     const lldb::addr_t new_file_size = std::max (section_max_file_offset, segment_max_file_offset) - new_file_offset;
906                                     segment->SetFileOffset (new_file_offset);
907                                     segment->SetFileSize (new_file_size);
908                                 }
909                             }
910                             else
911                             {
912                                 // Create a fake section for the section's named segment
913                                 segment_sp.reset(new Section (segment_sp,            // Parent section
914                                                               module_sp,           // Module to which this section belongs
915                                                               ++segID << 8,          // Section ID is the 1 based segment index shifted right by 8 bits as not to collide with any of the 256 section IDs that are possible
916                                                               segment_name,          // Name of this section
917                                                               eSectionTypeContainer, // This section is a container of other sections.
918                                                               sect64.addr,           // File VM address == addresses as they are found in the object file
919                                                               sect64.size,           // VM size in bytes of this section
920                                                               sect64.offset,         // Offset to the data for this section in the file
921                                                               sect64.offset ? sect64.size : 0,        // Size in bytes of this section as found in the the file
922                                                               load_cmd.flags));      // Flags for this section
923                                 segment_sp->SetIsFake(true);
924                                 m_sections_ap->AddSection(segment_sp);
925                                 segment_sp->SetIsEncrypted (segment_is_encrypted);
926                             }
927                         }
928                         assert (segment_sp.get());
929 
930                         uint32_t mach_sect_type = sect64.flags & SectionFlagMaskSectionType;
931                         static ConstString g_sect_name_objc_data ("__objc_data");
932                         static ConstString g_sect_name_objc_msgrefs ("__objc_msgrefs");
933                         static ConstString g_sect_name_objc_selrefs ("__objc_selrefs");
934                         static ConstString g_sect_name_objc_classrefs ("__objc_classrefs");
935                         static ConstString g_sect_name_objc_superrefs ("__objc_superrefs");
936                         static ConstString g_sect_name_objc_const ("__objc_const");
937                         static ConstString g_sect_name_objc_classlist ("__objc_classlist");
938                         static ConstString g_sect_name_cfstring ("__cfstring");
939 
940                         static ConstString g_sect_name_dwarf_debug_abbrev ("__debug_abbrev");
941                         static ConstString g_sect_name_dwarf_debug_aranges ("__debug_aranges");
942                         static ConstString g_sect_name_dwarf_debug_frame ("__debug_frame");
943                         static ConstString g_sect_name_dwarf_debug_info ("__debug_info");
944                         static ConstString g_sect_name_dwarf_debug_line ("__debug_line");
945                         static ConstString g_sect_name_dwarf_debug_loc ("__debug_loc");
946                         static ConstString g_sect_name_dwarf_debug_macinfo ("__debug_macinfo");
947                         static ConstString g_sect_name_dwarf_debug_pubnames ("__debug_pubnames");
948                         static ConstString g_sect_name_dwarf_debug_pubtypes ("__debug_pubtypes");
949                         static ConstString g_sect_name_dwarf_debug_ranges ("__debug_ranges");
950                         static ConstString g_sect_name_dwarf_debug_str ("__debug_str");
951                         static ConstString g_sect_name_dwarf_apple_names ("__apple_names");
952                         static ConstString g_sect_name_dwarf_apple_types ("__apple_types");
953                         static ConstString g_sect_name_dwarf_apple_namespaces ("__apple_namespac");
954                         static ConstString g_sect_name_dwarf_apple_objc ("__apple_objc");
955                         static ConstString g_sect_name_eh_frame ("__eh_frame");
956                         static ConstString g_sect_name_DATA ("__DATA");
957                         static ConstString g_sect_name_TEXT ("__TEXT");
958 
959                         SectionType sect_type = eSectionTypeOther;
960 
961                         if (section_name == g_sect_name_dwarf_debug_abbrev)
962                             sect_type = eSectionTypeDWARFDebugAbbrev;
963                         else if (section_name == g_sect_name_dwarf_debug_aranges)
964                             sect_type = eSectionTypeDWARFDebugAranges;
965                         else if (section_name == g_sect_name_dwarf_debug_frame)
966                             sect_type = eSectionTypeDWARFDebugFrame;
967                         else if (section_name == g_sect_name_dwarf_debug_info)
968                             sect_type = eSectionTypeDWARFDebugInfo;
969                         else if (section_name == g_sect_name_dwarf_debug_line)
970                             sect_type = eSectionTypeDWARFDebugLine;
971                         else if (section_name == g_sect_name_dwarf_debug_loc)
972                             sect_type = eSectionTypeDWARFDebugLoc;
973                         else if (section_name == g_sect_name_dwarf_debug_macinfo)
974                             sect_type = eSectionTypeDWARFDebugMacInfo;
975                         else if (section_name == g_sect_name_dwarf_debug_pubnames)
976                             sect_type = eSectionTypeDWARFDebugPubNames;
977                         else if (section_name == g_sect_name_dwarf_debug_pubtypes)
978                             sect_type = eSectionTypeDWARFDebugPubTypes;
979                         else if (section_name == g_sect_name_dwarf_debug_ranges)
980                             sect_type = eSectionTypeDWARFDebugRanges;
981                         else if (section_name == g_sect_name_dwarf_debug_str)
982                             sect_type = eSectionTypeDWARFDebugStr;
983                         else if (section_name == g_sect_name_dwarf_apple_names)
984                             sect_type = eSectionTypeDWARFAppleNames;
985                         else if (section_name == g_sect_name_dwarf_apple_types)
986                             sect_type = eSectionTypeDWARFAppleTypes;
987                         else if (section_name == g_sect_name_dwarf_apple_namespaces)
988                             sect_type = eSectionTypeDWARFAppleNamespaces;
989                         else if (section_name == g_sect_name_dwarf_apple_objc)
990                             sect_type = eSectionTypeDWARFAppleObjC;
991                         else if (section_name == g_sect_name_objc_selrefs)
992                             sect_type = eSectionTypeDataCStringPointers;
993                         else if (section_name == g_sect_name_objc_msgrefs)
994                             sect_type = eSectionTypeDataObjCMessageRefs;
995                         else if (section_name == g_sect_name_eh_frame)
996                             sect_type = eSectionTypeEHFrame;
997                         else if (section_name == g_sect_name_cfstring)
998                             sect_type = eSectionTypeDataObjCCFStrings;
999                         else if (section_name == g_sect_name_objc_data ||
1000                                  section_name == g_sect_name_objc_classrefs ||
1001                                  section_name == g_sect_name_objc_superrefs ||
1002                                  section_name == g_sect_name_objc_const ||
1003                                  section_name == g_sect_name_objc_classlist)
1004                         {
1005                             sect_type = eSectionTypeDataPointers;
1006                         }
1007 
1008                         if (sect_type == eSectionTypeOther)
1009                         {
1010                             switch (mach_sect_type)
1011                             {
1012                             // TODO: categorize sections by other flags for regular sections
1013                             case SectionTypeRegular:
1014                                 if (segment_sp->GetName() == g_sect_name_TEXT)
1015                                     sect_type = eSectionTypeCode;
1016                                 else if (segment_sp->GetName() == g_sect_name_DATA)
1017                                     sect_type = eSectionTypeData;
1018                                 else
1019                                     sect_type = eSectionTypeOther;
1020                                 break;
1021                             case SectionTypeZeroFill:                   sect_type = eSectionTypeZeroFill; break;
1022                             case SectionTypeCStringLiterals:            sect_type = eSectionTypeDataCString;    break; // section with only literal C strings
1023                             case SectionType4ByteLiterals:              sect_type = eSectionTypeData4;    break; // section with only 4 byte literals
1024                             case SectionType8ByteLiterals:              sect_type = eSectionTypeData8;    break; // section with only 8 byte literals
1025                             case SectionTypeLiteralPointers:            sect_type = eSectionTypeDataPointers;  break; // section with only pointers to literals
1026                             case SectionTypeNonLazySymbolPointers:      sect_type = eSectionTypeDataPointers;  break; // section with only non-lazy symbol pointers
1027                             case SectionTypeLazySymbolPointers:         sect_type = eSectionTypeDataPointers;  break; // section with only lazy symbol pointers
1028                             case SectionTypeSymbolStubs:                sect_type = eSectionTypeCode;  break; // section with only symbol stubs, byte size of stub in the reserved2 field
1029                             case SectionTypeModuleInitFunctionPointers: sect_type = eSectionTypeDataPointers;    break; // section with only function pointers for initialization
1030                             case SectionTypeModuleTermFunctionPointers: sect_type = eSectionTypeDataPointers; break; // section with only function pointers for termination
1031                             case SectionTypeCoalesced:                  sect_type = eSectionTypeOther; break;
1032                             case SectionTypeZeroFillLarge:              sect_type = eSectionTypeZeroFill; break;
1033                             case SectionTypeInterposing:                sect_type = eSectionTypeCode;  break; // section with only pairs of function pointers for interposing
1034                             case SectionType16ByteLiterals:             sect_type = eSectionTypeData16; break; // section with only 16 byte literals
1035                             case SectionTypeDTraceObjectFormat:         sect_type = eSectionTypeDebug; break;
1036                             case SectionTypeLazyDylibSymbolPointers:    sect_type = eSectionTypeDataPointers;  break;
1037                             default: break;
1038                             }
1039                         }
1040 
1041                         SectionSP section_sp(new Section (segment_sp,
1042                                                           module_sp,
1043                                                           ++sectID,
1044                                                           section_name,
1045                                                           sect_type,
1046                                                           sect64.addr - segment_sp->GetFileAddress(),
1047                                                           sect64.size,
1048                                                           sect64.offset,
1049                                                           sect64.offset == 0 ? 0 : sect64.size,
1050                                                           sect64.flags));
1051                         // Set the section to be encrypted to match the segment
1052 
1053                         bool section_is_encrypted = false;
1054                         if (!segment_is_encrypted && load_cmd.filesize != 0)
1055                             section_is_encrypted = encrypted_file_ranges.FindEntryThatContains(sect64.offset) != NULL;
1056 
1057                         section_sp->SetIsEncrypted (segment_is_encrypted || section_is_encrypted);
1058                         segment_sp->GetChildren().AddSection(section_sp);
1059 
1060                         if (segment_sp->IsFake())
1061                         {
1062                             segment_sp.reset();
1063                             segment_name.Clear();
1064                         }
1065                     }
1066                     if (segment_sp && m_header.filetype == HeaderFileTypeDSYM)
1067                     {
1068                         if (first_segment_sectID <= sectID)
1069                         {
1070                             lldb::user_id_t sect_uid;
1071                             for (sect_uid = first_segment_sectID; sect_uid <= sectID; ++sect_uid)
1072                             {
1073                                 SectionSP curr_section_sp(segment_sp->GetChildren().FindSectionByID (sect_uid));
1074                                 SectionSP next_section_sp;
1075                                 if (sect_uid + 1 <= sectID)
1076                                     next_section_sp = segment_sp->GetChildren().FindSectionByID (sect_uid+1);
1077 
1078                                 if (curr_section_sp.get())
1079                                 {
1080                                     if (curr_section_sp->GetByteSize() == 0)
1081                                     {
1082                                         if (next_section_sp.get() != NULL)
1083                                             curr_section_sp->SetByteSize ( next_section_sp->GetFileAddress() - curr_section_sp->GetFileAddress() );
1084                                         else
1085                                             curr_section_sp->SetByteSize ( load_cmd.vmsize );
1086                                     }
1087                                 }
1088                             }
1089                         }
1090                     }
1091                 }
1092             }
1093         }
1094         else if (load_cmd.cmd == LoadCommandDynamicSymtabInfo)
1095         {
1096             m_dysymtab.cmd = load_cmd.cmd;
1097             m_dysymtab.cmdsize = load_cmd.cmdsize;
1098             m_data.GetU32 (&offset, &m_dysymtab.ilocalsym, (sizeof(m_dysymtab) / sizeof(uint32_t)) - 2);
1099         }
1100 
1101         offset = load_cmd_offset + load_cmd.cmdsize;
1102     }
1103 //    if (dump_sections)
1104 //    {
1105 //        StreamFile s(stdout);
1106 //        m_sections_ap->Dump(&s, true);
1107 //    }
1108     return sectID;  // Return the number of sections we registered with the module
1109 }
1110 
1111 class MachSymtabSectionInfo
1112 {
1113 public:
1114 
1115     MachSymtabSectionInfo (SectionList *section_list) :
1116         m_section_list (section_list),
1117         m_section_infos()
1118     {
1119         // Get the number of sections down to a depth of 1 to include
1120         // all segments and their sections, but no other sections that
1121         // may be added for debug map or
1122         m_section_infos.resize(section_list->GetNumSections(1));
1123     }
1124 
1125 
1126     SectionSP
1127     GetSection (uint8_t n_sect, addr_t file_addr)
1128     {
1129         if (n_sect == 0)
1130             return SectionSP();
1131         if (n_sect < m_section_infos.size())
1132         {
1133             if (!m_section_infos[n_sect].section_sp)
1134             {
1135                 SectionSP section_sp (m_section_list->FindSectionByID (n_sect));
1136                 m_section_infos[n_sect].section_sp = section_sp;
1137                 if (section_sp != NULL)
1138                 {
1139                     m_section_infos[n_sect].vm_range.SetBaseAddress (section_sp->GetFileAddress());
1140                     m_section_infos[n_sect].vm_range.SetByteSize (section_sp->GetByteSize());
1141                 }
1142                 else
1143                 {
1144                     Host::SystemLog (Host::eSystemLogError, "error: unable to find section for section %u\n", n_sect);
1145                 }
1146             }
1147             if (m_section_infos[n_sect].vm_range.Contains(file_addr))
1148             {
1149                 // Symbol is in section.
1150                 return m_section_infos[n_sect].section_sp;
1151             }
1152             else if (m_section_infos[n_sect].vm_range.GetByteSize () == 0 &&
1153                      m_section_infos[n_sect].vm_range.GetBaseAddress() == file_addr)
1154             {
1155                 // Symbol is in section with zero size, but has the same start
1156                 // address as the section. This can happen with linker symbols
1157                 // (symbols that start with the letter 'l' or 'L'.
1158                 return m_section_infos[n_sect].section_sp;
1159             }
1160         }
1161         return m_section_list->FindSectionContainingFileAddress(file_addr);
1162     }
1163 
1164 protected:
1165     struct SectionInfo
1166     {
1167         SectionInfo () :
1168             vm_range(),
1169             section_sp ()
1170         {
1171         }
1172 
1173         VMRange vm_range;
1174         SectionSP section_sp;
1175     };
1176     SectionList *m_section_list;
1177     std::vector<SectionInfo> m_section_infos;
1178 };
1179 
1180 
1181 
1182 size_t
1183 ObjectFileMachO::ParseSymtab (bool minimize)
1184 {
1185     Timer scoped_timer(__PRETTY_FUNCTION__,
1186                        "ObjectFileMachO::ParseSymtab () module = %s",
1187                        m_file.GetFilename().AsCString(""));
1188     ModuleSP module_sp (GetModule());
1189     if (!module_sp)
1190         return 0;
1191 
1192     struct symtab_command symtab_load_command = { 0, 0, 0, 0, 0, 0 };
1193     struct linkedit_data_command function_starts_load_command = { 0, 0, 0, 0 };
1194     typedef AddressDataArray<lldb::addr_t, bool, 100> FunctionStarts;
1195     FunctionStarts function_starts;
1196     uint32_t offset = MachHeaderSizeFromMagic(m_header.magic);
1197     uint32_t i;
1198 
1199     LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_SYMBOLS));
1200 
1201     for (i=0; i<m_header.ncmds; ++i)
1202     {
1203         const uint32_t cmd_offset = offset;
1204         // Read in the load command and load command size
1205         struct load_command lc;
1206         if (m_data.GetU32(&offset, &lc, 2) == NULL)
1207             break;
1208         // Watch for the symbol table load command
1209         switch (lc.cmd)
1210         {
1211         case LoadCommandSymtab:
1212             symtab_load_command.cmd = lc.cmd;
1213             symtab_load_command.cmdsize = lc.cmdsize;
1214             // Read in the rest of the symtab load command
1215             if (m_data.GetU32(&offset, &symtab_load_command.symoff, 4) == 0) // fill in symoff, nsyms, stroff, strsize fields
1216                 return 0;
1217             if (symtab_load_command.symoff == 0)
1218             {
1219                 if (log)
1220                     module_sp->LogMessage(log.get(), "LC_SYMTAB.symoff == 0");
1221                 return 0;
1222             }
1223 
1224             if (symtab_load_command.stroff == 0)
1225             {
1226                 if (log)
1227                     module_sp->LogMessage(log.get(), "LC_SYMTAB.stroff == 0");
1228                 return 0;
1229             }
1230 
1231             if (symtab_load_command.nsyms == 0)
1232             {
1233                 if (log)
1234                     module_sp->LogMessage(log.get(), "LC_SYMTAB.nsyms == 0");
1235                 return 0;
1236             }
1237 
1238             if (symtab_load_command.strsize == 0)
1239             {
1240                 if (log)
1241                     module_sp->LogMessage(log.get(), "LC_SYMTAB.strsize == 0");
1242                 return 0;
1243             }
1244             break;
1245 
1246         case LoadCommandFunctionStarts:
1247             function_starts_load_command.cmd = lc.cmd;
1248             function_starts_load_command.cmdsize = lc.cmdsize;
1249             if (m_data.GetU32(&offset, &function_starts_load_command.dataoff, 2) == NULL) // fill in symoff, nsyms, stroff, strsize fields
1250                 bzero (&function_starts_load_command, sizeof(function_starts_load_command));
1251             break;
1252 
1253         default:
1254             break;
1255         }
1256         offset = cmd_offset + lc.cmdsize;
1257     }
1258 
1259     if (symtab_load_command.cmd)
1260     {
1261         Symtab *symtab = m_symtab_ap.get();
1262         SectionList *section_list = GetSectionList();
1263         if (section_list == NULL)
1264             return 0;
1265 
1266         ProcessSP process_sp (m_process_wp.lock());
1267         Process *process = process_sp.get();
1268 
1269         const size_t addr_byte_size = m_data.GetAddressByteSize();
1270         bool bit_width_32 = addr_byte_size == 4;
1271         const size_t nlist_byte_size = bit_width_32 ? sizeof(struct nlist) : sizeof(struct nlist_64);
1272 
1273         DataExtractor nlist_data (NULL, 0, m_data.GetByteOrder(), m_data.GetAddressByteSize());
1274         DataExtractor strtab_data (NULL, 0, m_data.GetByteOrder(), m_data.GetAddressByteSize());
1275         DataExtractor function_starts_data (NULL, 0, m_data.GetByteOrder(), m_data.GetAddressByteSize());
1276 
1277         const addr_t nlist_data_byte_size = symtab_load_command.nsyms * nlist_byte_size;
1278         const addr_t strtab_data_byte_size = symtab_load_command.strsize;
1279         addr_t strtab_addr = LLDB_INVALID_ADDRESS;
1280         if (process)
1281         {
1282             Target &target = process->GetTarget();
1283             SectionSP linkedit_section_sp(section_list->FindSectionByName(GetSegmentNameLINKEDIT()));
1284             // Reading mach file from memory in a process or core file...
1285 
1286             if (linkedit_section_sp)
1287             {
1288                 const addr_t linkedit_load_addr = linkedit_section_sp->GetLoadBaseAddress(&target);
1289                 const addr_t linkedit_file_offset = linkedit_section_sp->GetFileOffset();
1290                 const addr_t symoff_addr = linkedit_load_addr + symtab_load_command.symoff - linkedit_file_offset;
1291                 strtab_addr = linkedit_load_addr + symtab_load_command.stroff - linkedit_file_offset;
1292 
1293                 bool data_was_read = false;
1294 
1295 #if defined (__APPLE__) && defined (__arm__)
1296                 if (m_header.flags & 0x80000000u)
1297                 {
1298                     // This mach-o memory file is in the dyld shared cache. If this
1299                     // program is not remote and this is iOS, then this process will
1300                     // share the same shared cache as the process we are debugging and
1301                     // we can read the entire __LINKEDIT from the address space in this
1302                     // process. This is a needed optimization that is used for local iOS
1303                     // debugging only since all shared libraries in the shared cache do
1304                     // not have corresponding files that exist in the file system of the
1305                     // device. They have been combined into a single file. This means we
1306                     // always have to load these files from memory. All of the symbol and
1307                     // string tables from all of the __LINKEDIT sections from the shared
1308                     // libraries in the shared cache have been merged into a single large
1309                     // symbol and string table. Reading all of this symbol and string table
1310                     // data across can slow down debug launch times, so we optimize this by
1311                     // reading the memory for the __LINKEDIT section from this process.
1312                     PlatformSP platform_sp (target.GetPlatform());
1313                     if (platform_sp && platform_sp->IsHost())
1314                     {
1315                         data_was_read = true;
1316                         nlist_data.SetData((void *)symoff_addr, nlist_data_byte_size, eByteOrderLittle);
1317                         strtab_data.SetData((void *)strtab_addr, strtab_data_byte_size, eByteOrderLittle);
1318                         if (function_starts_load_command.cmd)
1319                         {
1320                             const addr_t func_start_addr = linkedit_load_addr + function_starts_load_command.dataoff - linkedit_file_offset;
1321                             function_starts_data.SetData ((void *)func_start_addr, function_starts_load_command.datasize, eByteOrderLittle);
1322                         }
1323                     }
1324                 }
1325 #endif
1326 
1327                 if (!data_was_read)
1328                 {
1329                     DataBufferSP nlist_data_sp (ReadMemory (process_sp, symoff_addr, nlist_data_byte_size));
1330                     if (nlist_data_sp)
1331                         nlist_data.SetData (nlist_data_sp, 0, nlist_data_sp->GetByteSize());
1332                     //DataBufferSP strtab_data_sp (ReadMemory (process_sp, strtab_addr, strtab_data_byte_size));
1333                     //if (strtab_data_sp)
1334                     //    strtab_data.SetData (strtab_data_sp, 0, strtab_data_sp->GetByteSize());
1335                     if (function_starts_load_command.cmd)
1336                     {
1337                         const addr_t func_start_addr = linkedit_load_addr + function_starts_load_command.dataoff - linkedit_file_offset;
1338                         DataBufferSP func_start_data_sp (ReadMemory (process_sp, func_start_addr, function_starts_load_command.datasize));
1339                         if (func_start_data_sp)
1340                             function_starts_data.SetData (func_start_data_sp, 0, func_start_data_sp->GetByteSize());
1341                     }
1342                 }
1343             }
1344         }
1345         else
1346         {
1347             nlist_data.SetData (m_data,
1348                                 symtab_load_command.symoff,
1349                                 nlist_data_byte_size);
1350             strtab_data.SetData (m_data,
1351                                  symtab_load_command.stroff,
1352                                  strtab_data_byte_size);
1353             if (function_starts_load_command.cmd)
1354             {
1355                 function_starts_data.SetData (m_data,
1356                                               function_starts_load_command.dataoff,
1357                                               function_starts_load_command.datasize);
1358             }
1359         }
1360 
1361         if (nlist_data.GetByteSize() == 0)
1362         {
1363             if (log)
1364                 module_sp->LogMessage(log.get(), "failed to read nlist data");
1365             return 0;
1366         }
1367 
1368 
1369         const bool have_strtab_data = strtab_data.GetByteSize() > 0;
1370         if (!have_strtab_data)
1371         {
1372             if (process)
1373             {
1374                 if (strtab_addr == LLDB_INVALID_ADDRESS)
1375                 {
1376                     if (log)
1377                         module_sp->LogMessage(log.get(), "failed to locate the strtab in memory");
1378                     return 0;
1379                 }
1380             }
1381             else
1382             {
1383                 if (log)
1384                     module_sp->LogMessage(log.get(), "failed to read strtab data");
1385                 return 0;
1386             }
1387         }
1388 
1389         const ConstString &g_segment_name_TEXT = GetSegmentNameTEXT();
1390         const ConstString &g_segment_name_DATA = GetSegmentNameDATA();
1391         const ConstString &g_segment_name_OBJC = GetSegmentNameOBJC();
1392         const ConstString &g_section_name_eh_frame = GetSectionNameEHFrame();
1393         SectionSP text_section_sp(section_list->FindSectionByName(g_segment_name_TEXT));
1394         SectionSP data_section_sp(section_list->FindSectionByName(g_segment_name_DATA));
1395         SectionSP objc_section_sp(section_list->FindSectionByName(g_segment_name_OBJC));
1396         SectionSP eh_frame_section_sp;
1397         if (text_section_sp.get())
1398             eh_frame_section_sp = text_section_sp->GetChildren().FindSectionByName (g_section_name_eh_frame);
1399         else
1400             eh_frame_section_sp = section_list->FindSectionByName (g_section_name_eh_frame);
1401 
1402         const bool is_arm = (m_header.cputype == llvm::MachO::CPUTypeARM);
1403         if (text_section_sp && function_starts_data.GetByteSize())
1404         {
1405             FunctionStarts::Entry function_start_entry;
1406             function_start_entry.data = false;
1407             uint32_t function_start_offset = 0;
1408             function_start_entry.addr = text_section_sp->GetFileAddress();
1409             uint64_t delta;
1410             while ((delta = function_starts_data.GetULEB128(&function_start_offset)) > 0)
1411             {
1412                 // Now append the current entry
1413                 function_start_entry.addr += delta;
1414                 function_starts.Append(function_start_entry);
1415             }
1416         }
1417 
1418         const uint32_t function_starts_count = function_starts.GetSize();
1419 
1420         uint8_t TEXT_eh_frame_sectID = eh_frame_section_sp.get() ? eh_frame_section_sp->GetID() : NListSectionNoSection;
1421 
1422         uint32_t nlist_data_offset = 0;
1423 
1424         uint32_t N_SO_index = UINT32_MAX;
1425 
1426         MachSymtabSectionInfo section_info (section_list);
1427         std::vector<uint32_t> N_FUN_indexes;
1428         std::vector<uint32_t> N_NSYM_indexes;
1429         std::vector<uint32_t> N_INCL_indexes;
1430         std::vector<uint32_t> N_BRAC_indexes;
1431         std::vector<uint32_t> N_COMM_indexes;
1432         typedef std::map <uint64_t, uint32_t> ValueToSymbolIndexMap;
1433         typedef std::map <uint32_t, uint32_t> NListIndexToSymbolIndexMap;
1434         ValueToSymbolIndexMap N_FUN_addr_to_sym_idx;
1435         ValueToSymbolIndexMap N_STSYM_addr_to_sym_idx;
1436         // Any symbols that get merged into another will get an entry
1437         // in this map so we know
1438         NListIndexToSymbolIndexMap m_nlist_idx_to_sym_idx;
1439         uint32_t nlist_idx = 0;
1440         Symbol *symbol_ptr = NULL;
1441 
1442         uint32_t sym_idx = 0;
1443         Symbol *sym = symtab->Resize (symtab_load_command.nsyms + m_dysymtab.nindirectsyms);
1444         uint32_t num_syms = symtab->GetNumSymbols();
1445         std::string memory_symbol_name;
1446 
1447         //symtab->Reserve (symtab_load_command.nsyms + m_dysymtab.nindirectsyms);
1448         for (nlist_idx = 0; nlist_idx < symtab_load_command.nsyms; ++nlist_idx)
1449         {
1450             struct nlist_64 nlist;
1451             if (!nlist_data.ValidOffsetForDataOfSize(nlist_data_offset, nlist_byte_size))
1452                 break;
1453 
1454             nlist.n_strx  = nlist_data.GetU32_unchecked(&nlist_data_offset);
1455             nlist.n_type  = nlist_data.GetU8_unchecked (&nlist_data_offset);
1456             nlist.n_sect  = nlist_data.GetU8_unchecked (&nlist_data_offset);
1457             nlist.n_desc  = nlist_data.GetU16_unchecked (&nlist_data_offset);
1458             nlist.n_value = nlist_data.GetAddress_unchecked (&nlist_data_offset);
1459 
1460             SymbolType type = eSymbolTypeInvalid;
1461             const char *symbol_name = NULL;
1462 
1463             if (have_strtab_data)
1464             {
1465                 symbol_name = strtab_data.PeekCStr(nlist.n_strx);
1466 
1467                 if (symbol_name == NULL)
1468                 {
1469                     // No symbol should be NULL, even the symbols with no
1470                     // string values should have an offset zero which points
1471                     // to an empty C-string
1472                     Host::SystemLog (Host::eSystemLogError,
1473                                      "error: symbol[%u] has invalid string table offset 0x%x in %s/%s, ignoring symbol\n",
1474                                      nlist_idx,
1475                                      nlist.n_strx,
1476                                      module_sp->GetFileSpec().GetDirectory().GetCString(),
1477                                      module_sp->GetFileSpec().GetFilename().GetCString());
1478                     continue;
1479                 }
1480                 if (symbol_name[0] == '\0')
1481                     symbol_name = NULL;
1482             }
1483             else
1484             {
1485                 const addr_t str_addr = strtab_addr + nlist.n_strx;
1486                 Error str_error;
1487                 if (process->ReadCStringFromMemory(str_addr, memory_symbol_name, str_error))
1488                     symbol_name = memory_symbol_name.c_str();
1489             }
1490             const char *symbol_name_non_abi_mangled = NULL;
1491 
1492             SectionSP symbol_section;
1493             uint32_t symbol_byte_size = 0;
1494             bool add_nlist = true;
1495             bool is_debug = ((nlist.n_type & NlistMaskStab) != 0);
1496 
1497             assert (sym_idx < num_syms);
1498 
1499             sym[sym_idx].SetDebug (is_debug);
1500 
1501             if (is_debug)
1502             {
1503                 switch (nlist.n_type)
1504                 {
1505                 case StabGlobalSymbol:
1506                     // N_GSYM -- global symbol: name,,NO_SECT,type,0
1507                     // Sometimes the N_GSYM value contains the address.
1508 
1509                     // FIXME: In the .o files, we have a GSYM and a debug symbol for all the ObjC data.  They
1510                     // have the same address, but we want to ensure that we always find only the real symbol,
1511                     // 'cause we don't currently correctly attribute the GSYM one to the ObjCClass/Ivar/MetaClass
1512                     // symbol type.  This is a temporary hack to make sure the ObjectiveC symbols get treated
1513                     // correctly.  To do this right, we should coalesce all the GSYM & global symbols that have the
1514                     // same address.
1515 
1516                     if (symbol_name && symbol_name[0] == '_' && symbol_name[1] ==  'O'
1517                         && (strncmp (symbol_name, "_OBJC_IVAR_$_", strlen ("_OBJC_IVAR_$_")) == 0
1518                             || strncmp (symbol_name, "_OBJC_CLASS_$_", strlen ("_OBJC_CLASS_$_")) == 0
1519                             || strncmp (symbol_name, "_OBJC_METACLASS_$_", strlen ("_OBJC_METACLASS_$_")) == 0))
1520                         add_nlist = false;
1521                     else
1522                     {
1523                         sym[sym_idx].SetExternal(true);
1524                         if (nlist.n_value != 0)
1525                             symbol_section = section_info.GetSection (nlist.n_sect, nlist.n_value);
1526                         type = eSymbolTypeData;
1527                     }
1528                     break;
1529 
1530                 case StabFunctionName:
1531                     // N_FNAME -- procedure name (f77 kludge): name,,NO_SECT,0,0
1532                     type = eSymbolTypeCompiler;
1533                     break;
1534 
1535                 case StabFunction:
1536                     // N_FUN -- procedure: name,,n_sect,linenumber,address
1537                     if (symbol_name)
1538                     {
1539                         type = eSymbolTypeCode;
1540                         symbol_section = section_info.GetSection (nlist.n_sect, nlist.n_value);
1541 
1542                         N_FUN_addr_to_sym_idx[nlist.n_value] = sym_idx;
1543                         // We use the current number of symbols in the symbol table in lieu of
1544                         // using nlist_idx in case we ever start trimming entries out
1545                         N_FUN_indexes.push_back(sym_idx);
1546                     }
1547                     else
1548                     {
1549                         type = eSymbolTypeCompiler;
1550 
1551                         if ( !N_FUN_indexes.empty() )
1552                         {
1553                             // Copy the size of the function into the original STAB entry so we don't have
1554                             // to hunt for it later
1555                             symtab->SymbolAtIndex(N_FUN_indexes.back())->SetByteSize(nlist.n_value);
1556                             N_FUN_indexes.pop_back();
1557                             // We don't really need the end function STAB as it contains the size which
1558                             // we already placed with the original symbol, so don't add it if we want a
1559                             // minimal symbol table
1560                             if (minimize)
1561                                 add_nlist = false;
1562                         }
1563                     }
1564                     break;
1565 
1566                 case StabStaticSymbol:
1567                     // N_STSYM -- static symbol: name,,n_sect,type,address
1568                     N_STSYM_addr_to_sym_idx[nlist.n_value] = sym_idx;
1569                     symbol_section = section_info.GetSection (nlist.n_sect, nlist.n_value);
1570                     type = eSymbolTypeData;
1571                     break;
1572 
1573                 case StabLocalCommon:
1574                     // N_LCSYM -- .lcomm symbol: name,,n_sect,type,address
1575                     symbol_section = section_info.GetSection (nlist.n_sect, nlist.n_value);
1576                     type = eSymbolTypeCommonBlock;
1577                     break;
1578 
1579                 case StabBeginSymbol:
1580                     // N_BNSYM
1581                     // We use the current number of symbols in the symbol table in lieu of
1582                     // using nlist_idx in case we ever start trimming entries out
1583                     if (minimize)
1584                     {
1585                         // Skip these if we want minimal symbol tables
1586                         add_nlist = false;
1587                     }
1588                     else
1589                     {
1590                         symbol_section = section_info.GetSection (nlist.n_sect, nlist.n_value);
1591                         N_NSYM_indexes.push_back(sym_idx);
1592                         type = eSymbolTypeScopeBegin;
1593                     }
1594                     break;
1595 
1596                 case StabEndSymbol:
1597                     // N_ENSYM
1598                     // Set the size of the N_BNSYM to the terminating index of this N_ENSYM
1599                     // so that we can always skip the entire symbol if we need to navigate
1600                     // more quickly at the source level when parsing STABS
1601                     if (minimize)
1602                     {
1603                         // Skip these if we want minimal symbol tables
1604                         add_nlist = false;
1605                     }
1606                     else
1607                     {
1608                         if ( !N_NSYM_indexes.empty() )
1609                         {
1610                             symbol_ptr = symtab->SymbolAtIndex(N_NSYM_indexes.back());
1611                             symbol_ptr->SetByteSize(sym_idx + 1);
1612                             symbol_ptr->SetSizeIsSibling(true);
1613                             N_NSYM_indexes.pop_back();
1614                         }
1615                         type = eSymbolTypeScopeEnd;
1616                     }
1617                     break;
1618 
1619 
1620                 case StabSourceFileOptions:
1621                     // N_OPT - emitted with gcc2_compiled and in gcc source
1622                     type = eSymbolTypeCompiler;
1623                     break;
1624 
1625                 case StabRegisterSymbol:
1626                     // N_RSYM - register sym: name,,NO_SECT,type,register
1627                     type = eSymbolTypeVariable;
1628                     break;
1629 
1630                 case StabSourceLine:
1631                     // N_SLINE - src line: 0,,n_sect,linenumber,address
1632                     symbol_section = section_info.GetSection (nlist.n_sect, nlist.n_value);
1633                     type = eSymbolTypeLineEntry;
1634                     break;
1635 
1636                 case StabStructureType:
1637                     // N_SSYM - structure elt: name,,NO_SECT,type,struct_offset
1638                     type = eSymbolTypeVariableType;
1639                     break;
1640 
1641                 case StabSourceFileName:
1642                     // N_SO - source file name
1643                     type = eSymbolTypeSourceFile;
1644                     if (symbol_name == NULL)
1645                     {
1646                         if (minimize)
1647                             add_nlist = false;
1648                         if (N_SO_index != UINT32_MAX)
1649                         {
1650                             // Set the size of the N_SO to the terminating index of this N_SO
1651                             // so that we can always skip the entire N_SO if we need to navigate
1652                             // more quickly at the source level when parsing STABS
1653                             symbol_ptr = symtab->SymbolAtIndex(N_SO_index);
1654                             symbol_ptr->SetByteSize(sym_idx + (minimize ? 0 : 1));
1655                             symbol_ptr->SetSizeIsSibling(true);
1656                         }
1657                         N_NSYM_indexes.clear();
1658                         N_INCL_indexes.clear();
1659                         N_BRAC_indexes.clear();
1660                         N_COMM_indexes.clear();
1661                         N_FUN_indexes.clear();
1662                         N_SO_index = UINT32_MAX;
1663                     }
1664                     else
1665                     {
1666                         // We use the current number of symbols in the symbol table in lieu of
1667                         // using nlist_idx in case we ever start trimming entries out
1668                         if (symbol_name[0] == '/')
1669                             N_SO_index = sym_idx;
1670                         else if (minimize && (N_SO_index == sym_idx - 1) && ((sym_idx - 1) < num_syms))
1671                         {
1672                             const char *so_path = sym[sym_idx - 1].GetMangled().GetDemangledName().AsCString();
1673                             if (so_path && so_path[0])
1674                             {
1675                                 std::string full_so_path (so_path);
1676                                 if (*full_so_path.rbegin() != '/')
1677                                     full_so_path += '/';
1678                                 full_so_path += symbol_name;
1679                                 sym[sym_idx - 1].GetMangled().SetValue(full_so_path.c_str(), false);
1680                                 add_nlist = false;
1681                                 m_nlist_idx_to_sym_idx[nlist_idx] = sym_idx - 1;
1682                             }
1683                         }
1684                     }
1685 
1686                     break;
1687 
1688                 case StabObjectFileName:
1689                     // N_OSO - object file name: name,,0,0,st_mtime
1690                     type = eSymbolTypeObjectFile;
1691                     break;
1692 
1693                 case StabLocalSymbol:
1694                     // N_LSYM - local sym: name,,NO_SECT,type,offset
1695                     type = eSymbolTypeLocal;
1696                     break;
1697 
1698                 //----------------------------------------------------------------------
1699                 // INCL scopes
1700                 //----------------------------------------------------------------------
1701                 case StabBeginIncludeFileName:
1702                     // N_BINCL - include file beginning: name,,NO_SECT,0,sum
1703                     // We use the current number of symbols in the symbol table in lieu of
1704                     // using nlist_idx in case we ever start trimming entries out
1705                     N_INCL_indexes.push_back(sym_idx);
1706                     type = eSymbolTypeScopeBegin;
1707                     break;
1708 
1709                 case StabEndIncludeFile:
1710                     // N_EINCL - include file end: name,,NO_SECT,0,0
1711                     // Set the size of the N_BINCL to the terminating index of this N_EINCL
1712                     // so that we can always skip the entire symbol if we need to navigate
1713                     // more quickly at the source level when parsing STABS
1714                     if ( !N_INCL_indexes.empty() )
1715                     {
1716                         symbol_ptr = symtab->SymbolAtIndex(N_INCL_indexes.back());
1717                         symbol_ptr->SetByteSize(sym_idx + 1);
1718                         symbol_ptr->SetSizeIsSibling(true);
1719                         N_INCL_indexes.pop_back();
1720                     }
1721                     type = eSymbolTypeScopeEnd;
1722                     break;
1723 
1724                 case StabIncludeFileName:
1725                     // N_SOL - #included file name: name,,n_sect,0,address
1726                     type = eSymbolTypeHeaderFile;
1727 
1728                     // We currently don't use the header files on darwin
1729                     if (minimize)
1730                         add_nlist = false;
1731                     break;
1732 
1733                 case StabCompilerParameters:
1734                     // N_PARAMS - compiler parameters: name,,NO_SECT,0,0
1735                     type = eSymbolTypeCompiler;
1736                     break;
1737 
1738                 case StabCompilerVersion:
1739                     // N_VERSION - compiler version: name,,NO_SECT,0,0
1740                     type = eSymbolTypeCompiler;
1741                     break;
1742 
1743                 case StabCompilerOptLevel:
1744                     // N_OLEVEL - compiler -O level: name,,NO_SECT,0,0
1745                     type = eSymbolTypeCompiler;
1746                     break;
1747 
1748                 case StabParameter:
1749                     // N_PSYM - parameter: name,,NO_SECT,type,offset
1750                     type = eSymbolTypeVariable;
1751                     break;
1752 
1753                 case StabAlternateEntry:
1754                     // N_ENTRY - alternate entry: name,,n_sect,linenumber,address
1755                     symbol_section = section_info.GetSection (nlist.n_sect, nlist.n_value);
1756                     type = eSymbolTypeLineEntry;
1757                     break;
1758 
1759                 //----------------------------------------------------------------------
1760                 // Left and Right Braces
1761                 //----------------------------------------------------------------------
1762                 case StabLeftBracket:
1763                     // N_LBRAC - left bracket: 0,,NO_SECT,nesting level,address
1764                     // We use the current number of symbols in the symbol table in lieu of
1765                     // using nlist_idx in case we ever start trimming entries out
1766                     symbol_section = section_info.GetSection (nlist.n_sect, nlist.n_value);
1767                     N_BRAC_indexes.push_back(sym_idx);
1768                     type = eSymbolTypeScopeBegin;
1769                     break;
1770 
1771                 case StabRightBracket:
1772                     // N_RBRAC - right bracket: 0,,NO_SECT,nesting level,address
1773                     // Set the size of the N_LBRAC to the terminating index of this N_RBRAC
1774                     // so that we can always skip the entire symbol if we need to navigate
1775                     // more quickly at the source level when parsing STABS
1776                     symbol_section = section_info.GetSection (nlist.n_sect, nlist.n_value);
1777                     if ( !N_BRAC_indexes.empty() )
1778                     {
1779                         symbol_ptr = symtab->SymbolAtIndex(N_BRAC_indexes.back());
1780                         symbol_ptr->SetByteSize(sym_idx + 1);
1781                         symbol_ptr->SetSizeIsSibling(true);
1782                         N_BRAC_indexes.pop_back();
1783                     }
1784                     type = eSymbolTypeScopeEnd;
1785                     break;
1786 
1787                 case StabDeletedIncludeFile:
1788                     // N_EXCL - deleted include file: name,,NO_SECT,0,sum
1789                     type = eSymbolTypeHeaderFile;
1790                     break;
1791 
1792                 //----------------------------------------------------------------------
1793                 // COMM scopes
1794                 //----------------------------------------------------------------------
1795                 case StabBeginCommon:
1796                     // N_BCOMM - begin common: name,,NO_SECT,0,0
1797                     // We use the current number of symbols in the symbol table in lieu of
1798                     // using nlist_idx in case we ever start trimming entries out
1799                     type = eSymbolTypeScopeBegin;
1800                     N_COMM_indexes.push_back(sym_idx);
1801                     break;
1802 
1803                 case StabEndCommonLocal:
1804                     // N_ECOML - end common (local name): 0,,n_sect,0,address
1805                     symbol_section = section_info.GetSection (nlist.n_sect, nlist.n_value);
1806                     // Fall through
1807 
1808                 case StabEndCommon:
1809                     // N_ECOMM - end common: name,,n_sect,0,0
1810                     // Set the size of the N_BCOMM to the terminating index of this N_ECOMM/N_ECOML
1811                     // so that we can always skip the entire symbol if we need to navigate
1812                     // more quickly at the source level when parsing STABS
1813                     if ( !N_COMM_indexes.empty() )
1814                     {
1815                         symbol_ptr = symtab->SymbolAtIndex(N_COMM_indexes.back());
1816                         symbol_ptr->SetByteSize(sym_idx + 1);
1817                         symbol_ptr->SetSizeIsSibling(true);
1818                         N_COMM_indexes.pop_back();
1819                     }
1820                     type = eSymbolTypeScopeEnd;
1821                     break;
1822 
1823                 case StabLength:
1824                     // N_LENG - second stab entry with length information
1825                     type = eSymbolTypeAdditional;
1826                     break;
1827 
1828                 default: break;
1829                 }
1830             }
1831             else
1832             {
1833                 //uint8_t n_pext    = NlistMaskPrivateExternal & nlist.n_type;
1834                 uint8_t n_type  = NlistMaskType & nlist.n_type;
1835                 sym[sym_idx].SetExternal((NlistMaskExternal & nlist.n_type) != 0);
1836 
1837                 switch (n_type)
1838                 {
1839                 case NListTypeIndirect:         // N_INDR - Fall through
1840                 case NListTypePreboundUndefined:// N_PBUD - Fall through
1841                 case NListTypeUndefined:        // N_UNDF
1842                     type = eSymbolTypeUndefined;
1843                     break;
1844 
1845                 case NListTypeAbsolute:         // N_ABS
1846                     type = eSymbolTypeAbsolute;
1847                     break;
1848 
1849                 case NListTypeSection:          // N_SECT
1850                     {
1851                         symbol_section = section_info.GetSection (nlist.n_sect, nlist.n_value);
1852 
1853                         if (symbol_section == NULL)
1854                         {
1855                             // TODO: warn about this?
1856                             add_nlist = false;
1857                             break;
1858                         }
1859 
1860                         if (TEXT_eh_frame_sectID == nlist.n_sect)
1861                         {
1862                             type = eSymbolTypeException;
1863                         }
1864                         else
1865                         {
1866                             uint32_t section_type = symbol_section->Get() & SectionFlagMaskSectionType;
1867 
1868                             switch (section_type)
1869                             {
1870                             case SectionTypeRegular:                     break; // regular section
1871                             //case SectionTypeZeroFill:                 type = eSymbolTypeData;    break; // zero fill on demand section
1872                             case SectionTypeCStringLiterals:            type = eSymbolTypeData;    break; // section with only literal C strings
1873                             case SectionType4ByteLiterals:              type = eSymbolTypeData;    break; // section with only 4 byte literals
1874                             case SectionType8ByteLiterals:              type = eSymbolTypeData;    break; // section with only 8 byte literals
1875                             case SectionTypeLiteralPointers:            type = eSymbolTypeTrampoline; break; // section with only pointers to literals
1876                             case SectionTypeNonLazySymbolPointers:      type = eSymbolTypeTrampoline; break; // section with only non-lazy symbol pointers
1877                             case SectionTypeLazySymbolPointers:         type = eSymbolTypeTrampoline; break; // section with only lazy symbol pointers
1878                             case SectionTypeSymbolStubs:                type = eSymbolTypeTrampoline; break; // section with only symbol stubs, byte size of stub in the reserved2 field
1879                             case SectionTypeModuleInitFunctionPointers: type = eSymbolTypeCode;    break; // section with only function pointers for initialization
1880                             case SectionTypeModuleTermFunctionPointers: type = eSymbolTypeCode;    break; // section with only function pointers for termination
1881                             //case SectionTypeCoalesced:                type = eSymbolType;    break; // section contains symbols that are to be coalesced
1882                             //case SectionTypeZeroFillLarge:            type = eSymbolTypeData;    break; // zero fill on demand section (that can be larger than 4 gigabytes)
1883                             case SectionTypeInterposing:                type = eSymbolTypeTrampoline;  break; // section with only pairs of function pointers for interposing
1884                             case SectionType16ByteLiterals:             type = eSymbolTypeData;    break; // section with only 16 byte literals
1885                             case SectionTypeDTraceObjectFormat:         type = eSymbolTypeInstrumentation; break;
1886                             case SectionTypeLazyDylibSymbolPointers:    type = eSymbolTypeTrampoline; break;
1887                             default: break;
1888                             }
1889 
1890                             if (type == eSymbolTypeInvalid)
1891                             {
1892                                 const char *symbol_sect_name = symbol_section->GetName().AsCString();
1893                                 if (symbol_section->IsDescendant (text_section_sp.get()))
1894                                 {
1895                                     if (symbol_section->IsClear(SectionAttrUserPureInstructions |
1896                                                                 SectionAttrUserSelfModifyingCode |
1897                                                                 SectionAttrSytemSomeInstructions))
1898                                         type = eSymbolTypeData;
1899                                     else
1900                                         type = eSymbolTypeCode;
1901                                 }
1902                                 else
1903                                 if (symbol_section->IsDescendant(data_section_sp.get()))
1904                                 {
1905                                     if (symbol_sect_name && ::strstr (symbol_sect_name, "__objc") == symbol_sect_name)
1906                                     {
1907                                         type = eSymbolTypeRuntime;
1908 
1909                                         if (symbol_name &&
1910                                             symbol_name[0] == '_' &&
1911                                             symbol_name[1] == 'O' &&
1912                                             symbol_name[2] == 'B')
1913                                         {
1914                                             llvm::StringRef symbol_name_ref(symbol_name);
1915                                             static const llvm::StringRef g_objc_v2_prefix_class ("_OBJC_CLASS_$_");
1916                                             static const llvm::StringRef g_objc_v2_prefix_metaclass ("_OBJC_METACLASS_$_");
1917                                             static const llvm::StringRef g_objc_v2_prefix_ivar ("_OBJC_IVAR_$_");
1918                                             if (symbol_name_ref.startswith(g_objc_v2_prefix_class))
1919                                             {
1920                                                 symbol_name_non_abi_mangled = symbol_name + 1;
1921                                                 symbol_name = symbol_name + g_objc_v2_prefix_class.size();
1922                                                 type = eSymbolTypeObjCClass;
1923                                             }
1924                                             else if (symbol_name_ref.startswith(g_objc_v2_prefix_metaclass))
1925                                             {
1926                                                 symbol_name_non_abi_mangled = symbol_name + 1;
1927                                                 symbol_name = symbol_name + g_objc_v2_prefix_metaclass.size();
1928                                                 type = eSymbolTypeObjCMetaClass;
1929                                             }
1930                                             else if (symbol_name_ref.startswith(g_objc_v2_prefix_ivar))
1931                                             {
1932                                                 symbol_name_non_abi_mangled = symbol_name + 1;
1933                                                 symbol_name = symbol_name + g_objc_v2_prefix_ivar.size();
1934                                                 type = eSymbolTypeObjCIVar;
1935                                             }
1936                                         }
1937                                     }
1938                                     else
1939                                     if (symbol_sect_name && ::strstr (symbol_sect_name, "__gcc_except_tab") == symbol_sect_name)
1940                                     {
1941                                         type = eSymbolTypeException;
1942                                     }
1943                                     else
1944                                     {
1945                                         type = eSymbolTypeData;
1946                                     }
1947                                 }
1948                                 else
1949                                 if (symbol_sect_name && ::strstr (symbol_sect_name, "__IMPORT") == symbol_sect_name)
1950                                 {
1951                                     type = eSymbolTypeTrampoline;
1952                                 }
1953                                 else
1954                                 if (symbol_section->IsDescendant(objc_section_sp.get()))
1955                                 {
1956                                     type = eSymbolTypeRuntime;
1957                                     if (symbol_name && symbol_name[0] == '.')
1958                                     {
1959                                         llvm::StringRef symbol_name_ref(symbol_name);
1960                                         static const llvm::StringRef g_objc_v1_prefix_class (".objc_class_name_");
1961                                         if (symbol_name_ref.startswith(g_objc_v1_prefix_class))
1962                                         {
1963                                             symbol_name_non_abi_mangled = symbol_name;
1964                                             symbol_name = symbol_name + g_objc_v1_prefix_class.size();
1965                                             type = eSymbolTypeObjCClass;
1966                                         }
1967                                     }
1968                                 }
1969                             }
1970                         }
1971                     }
1972                     break;
1973                 }
1974             }
1975 
1976             if (add_nlist)
1977             {
1978                 uint64_t symbol_value = nlist.n_value;
1979                 bool symbol_name_is_mangled = false;
1980 
1981                 if (symbol_name_non_abi_mangled)
1982                 {
1983                     sym[sym_idx].GetMangled().SetMangledName (symbol_name_non_abi_mangled);
1984                     sym[sym_idx].GetMangled().SetDemangledName (symbol_name);
1985                 }
1986                 else
1987                 {
1988                     if (symbol_name && symbol_name[0] == '_')
1989                     {
1990                         symbol_name_is_mangled = symbol_name[1] == '_';
1991                         symbol_name++;  // Skip the leading underscore
1992                     }
1993 
1994                     if (symbol_name)
1995                     {
1996                         sym[sym_idx].GetMangled().SetValue(symbol_name, symbol_name_is_mangled);
1997                     }
1998                 }
1999 
2000                 if (is_debug == false)
2001                 {
2002                     if (type == eSymbolTypeCode)
2003                     {
2004                         // See if we can find a N_FUN entry for any code symbols.
2005                         // If we do find a match, and the name matches, then we
2006                         // can merge the two into just the function symbol to avoid
2007                         // duplicate entries in the symbol table
2008                         ValueToSymbolIndexMap::const_iterator pos = N_FUN_addr_to_sym_idx.find (nlist.n_value);
2009                         if (pos != N_FUN_addr_to_sym_idx.end())
2010                         {
2011                             if ((symbol_name_is_mangled == true && sym[sym_idx].GetMangled().GetMangledName() == sym[pos->second].GetMangled().GetMangledName()) ||
2012                                 (symbol_name_is_mangled == false && sym[sym_idx].GetMangled().GetDemangledName() == sym[pos->second].GetMangled().GetDemangledName()))
2013                             {
2014                                 m_nlist_idx_to_sym_idx[nlist_idx] = pos->second;
2015                                 // We just need the flags from the linker symbol, so put these flags
2016                                 // into the N_FUN flags to avoid duplicate symbols in the symbol table
2017                                 sym[pos->second].SetFlags (nlist.n_type << 16 | nlist.n_desc);
2018                                 sym[sym_idx].Clear();
2019                                 continue;
2020                             }
2021                         }
2022                     }
2023                     else if (type == eSymbolTypeData)
2024                     {
2025                         // See if we can find a N_STSYM entry for any data symbols.
2026                         // If we do find a match, and the name matches, then we
2027                         // can merge the two into just the Static symbol to avoid
2028                         // duplicate entries in the symbol table
2029                         ValueToSymbolIndexMap::const_iterator pos = N_STSYM_addr_to_sym_idx.find (nlist.n_value);
2030                         if (pos != N_STSYM_addr_to_sym_idx.end())
2031                         {
2032                             if ((symbol_name_is_mangled == true && sym[sym_idx].GetMangled().GetMangledName() == sym[pos->second].GetMangled().GetMangledName()) ||
2033                                 (symbol_name_is_mangled == false && sym[sym_idx].GetMangled().GetDemangledName() == sym[pos->second].GetMangled().GetDemangledName()))
2034                             {
2035                                 m_nlist_idx_to_sym_idx[nlist_idx] = pos->second;
2036                                 // We just need the flags from the linker symbol, so put these flags
2037                                 // into the N_STSYM flags to avoid duplicate symbols in the symbol table
2038                                 sym[pos->second].SetFlags (nlist.n_type << 16 | nlist.n_desc);
2039                                 sym[sym_idx].Clear();
2040                                 continue;
2041                             }
2042                         }
2043                     }
2044                 }
2045                 if (symbol_section)
2046                 {
2047                     const addr_t section_file_addr = symbol_section->GetFileAddress();
2048                     if (symbol_byte_size == 0 && function_starts_count > 0)
2049                     {
2050                         addr_t symbol_lookup_file_addr = nlist.n_value;
2051                         // Do an exact address match for non-ARM addresses, else get the closest since
2052                         // the symbol might be a thumb symbol which has an address with bit zero set
2053                         FunctionStarts::Entry *func_start_entry = function_starts.FindEntry (symbol_lookup_file_addr, !is_arm);
2054                         if (is_arm && func_start_entry)
2055                         {
2056                             // Verify that the function start address is the symbol address (ARM)
2057                             // or the symbol address + 1 (thumb)
2058                             if (func_start_entry->addr != symbol_lookup_file_addr &&
2059                                 func_start_entry->addr != (symbol_lookup_file_addr + 1))
2060                             {
2061                                 // Not the right entry, NULL it out...
2062                                 func_start_entry = NULL;
2063                             }
2064                         }
2065                         if (func_start_entry)
2066                         {
2067                             func_start_entry->data = true;
2068 
2069                             addr_t symbol_file_addr = func_start_entry->addr;
2070                             uint32_t symbol_flags = 0;
2071                             if (is_arm)
2072                             {
2073                                 if (symbol_file_addr & 1)
2074                                     symbol_flags = MACHO_NLIST_ARM_SYMBOL_IS_THUMB;
2075                                 symbol_file_addr &= 0xfffffffffffffffeull;
2076                             }
2077 
2078                             const FunctionStarts::Entry *next_func_start_entry = function_starts.FindNextEntry (func_start_entry);
2079                             const addr_t section_end_file_addr = section_file_addr + symbol_section->GetByteSize();
2080                             if (next_func_start_entry)
2081                             {
2082                                 addr_t next_symbol_file_addr = next_func_start_entry->addr;
2083                                 // Be sure the clear the Thumb address bit when we calculate the size
2084                                 // from the current and next address
2085                                 if (is_arm)
2086                                     next_symbol_file_addr &= 0xfffffffffffffffeull;
2087                                 symbol_byte_size = std::min<lldb::addr_t>(next_symbol_file_addr - symbol_file_addr, section_end_file_addr - symbol_file_addr);
2088                             }
2089                             else
2090                             {
2091                                 symbol_byte_size = section_end_file_addr - symbol_file_addr;
2092                             }
2093                         }
2094                     }
2095                     symbol_value -= section_file_addr;
2096                 }
2097 
2098                 sym[sym_idx].SetID (nlist_idx);
2099                 sym[sym_idx].SetType (type);
2100                 sym[sym_idx].GetAddress().SetSection (symbol_section);
2101                 sym[sym_idx].GetAddress().SetOffset (symbol_value);
2102                 sym[sym_idx].SetFlags (nlist.n_type << 16 | nlist.n_desc);
2103 
2104                 if (symbol_byte_size > 0)
2105                     sym[sym_idx].SetByteSize(symbol_byte_size);
2106 
2107                 ++sym_idx;
2108             }
2109             else
2110             {
2111                 sym[sym_idx].Clear();
2112             }
2113 
2114         }
2115 
2116         // STAB N_GSYM entries end up having a symbol type eSymbolTypeGlobal and when the symbol value
2117         // is zero, the address of the global ends up being in a non-STAB entry. Try and fix up all
2118         // such entries by figuring out what the address for the global is by looking up this non-STAB
2119         // entry and copying the value into the debug symbol's value to save us the hassle in the
2120         // debug symbol parser.
2121 
2122         Symbol *global_symbol = NULL;
2123         for (nlist_idx = 0;
2124              nlist_idx < symtab_load_command.nsyms && (global_symbol = symtab->FindSymbolWithType (eSymbolTypeData, Symtab::eDebugYes, Symtab::eVisibilityAny, nlist_idx)) != NULL;
2125              nlist_idx++)
2126         {
2127             if (global_symbol->GetAddress().GetFileAddress() == 0)
2128             {
2129                 std::vector<uint32_t> indexes;
2130                 if (symtab->AppendSymbolIndexesWithName (global_symbol->GetMangled().GetName(), indexes) > 0)
2131                 {
2132                     std::vector<uint32_t>::const_iterator pos;
2133                     std::vector<uint32_t>::const_iterator end = indexes.end();
2134                     for (pos = indexes.begin(); pos != end; ++pos)
2135                     {
2136                         symbol_ptr = symtab->SymbolAtIndex(*pos);
2137                         if (symbol_ptr != global_symbol && symbol_ptr->IsDebug() == false)
2138                         {
2139                             global_symbol->GetAddress() = symbol_ptr->GetAddress();
2140                             break;
2141                         }
2142                     }
2143                 }
2144             }
2145         }
2146 
2147         uint32_t synthetic_sym_id = symtab_load_command.nsyms;
2148 
2149 
2150         if (function_starts_count > 0)
2151         {
2152             char synthetic_function_symbol[PATH_MAX];
2153             uint32_t num_synthetic_function_symbols = 0;
2154             for (i=0; i<function_starts_count; ++i)
2155             {
2156                 if (function_starts.GetEntryRef (i).data == false)
2157                     ++num_synthetic_function_symbols;
2158             }
2159 
2160             if (num_synthetic_function_symbols > 0)
2161             {
2162                 if (num_syms < sym_idx + num_synthetic_function_symbols)
2163                 {
2164                     num_syms = sym_idx + num_synthetic_function_symbols;
2165                     sym = symtab->Resize (num_syms);
2166                 }
2167                 uint32_t synthetic_function_symbol_idx = 0;
2168                 for (i=0; i<function_starts_count; ++i)
2169                 {
2170                     const FunctionStarts::Entry *func_start_entry = function_starts.GetEntryAtIndex (i);
2171                     if (func_start_entry->data == false)
2172                     {
2173                         addr_t symbol_file_addr = func_start_entry->addr;
2174                         uint32_t symbol_flags = 0;
2175                         if (is_arm)
2176                         {
2177                             if (symbol_file_addr & 1)
2178                                 symbol_flags = MACHO_NLIST_ARM_SYMBOL_IS_THUMB;
2179                             symbol_file_addr &= 0xfffffffffffffffeull;
2180                         }
2181                         Address symbol_addr;
2182                         if (module_sp->ResolveFileAddress (symbol_file_addr, symbol_addr))
2183                         {
2184                             SectionSP symbol_section (symbol_addr.GetSection());
2185                             uint32_t symbol_byte_size = 0;
2186                             if (symbol_section)
2187                             {
2188                                 const addr_t section_file_addr = symbol_section->GetFileAddress();
2189                                 const FunctionStarts::Entry *next_func_start_entry = function_starts.FindNextEntry (func_start_entry);
2190                                 const addr_t section_end_file_addr = section_file_addr + symbol_section->GetByteSize();
2191                                 if (next_func_start_entry)
2192                                 {
2193                                     addr_t next_symbol_file_addr = next_func_start_entry->addr;
2194                                     if (is_arm)
2195                                         next_symbol_file_addr &= 0xfffffffffffffffeull;
2196                                     symbol_byte_size = std::min<lldb::addr_t>(next_symbol_file_addr - symbol_file_addr, section_end_file_addr - symbol_file_addr);
2197                                 }
2198                                 else
2199                                 {
2200                                     symbol_byte_size = section_end_file_addr - symbol_file_addr;
2201                                 }
2202                                 snprintf (synthetic_function_symbol,
2203                                           sizeof(synthetic_function_symbol),
2204                                           "___lldb_unnamed_function%u$$%s",
2205                                           ++synthetic_function_symbol_idx,
2206                                           module_sp->GetFileSpec().GetFilename().GetCString());
2207                                 sym[sym_idx].SetID (synthetic_sym_id++);
2208                                 sym[sym_idx].GetMangled().SetDemangledName(synthetic_function_symbol);
2209                                 sym[sym_idx].SetType (eSymbolTypeCode);
2210                                 sym[sym_idx].SetIsSynthetic (true);
2211                                 sym[sym_idx].GetAddress() = symbol_addr;
2212                                 if (symbol_flags)
2213                                     sym[sym_idx].SetFlags (symbol_flags);
2214                                 if (symbol_byte_size)
2215                                     sym[sym_idx].SetByteSize (symbol_byte_size);
2216                                 ++sym_idx;
2217                             }
2218                         }
2219                     }
2220                 }
2221             }
2222         }
2223 
2224         // Trim our symbols down to just what we ended up with after
2225         // removing any symbols.
2226         if (sym_idx < num_syms)
2227         {
2228             num_syms = sym_idx;
2229             sym = symtab->Resize (num_syms);
2230         }
2231 
2232         // Now synthesize indirect symbols
2233         if (m_dysymtab.nindirectsyms != 0)
2234         {
2235             DataExtractor indirect_symbol_index_data (m_data, m_dysymtab.indirectsymoff, m_dysymtab.nindirectsyms * 4);
2236 
2237             if (indirect_symbol_index_data.GetByteSize())
2238             {
2239                 NListIndexToSymbolIndexMap::const_iterator end_index_pos = m_nlist_idx_to_sym_idx.end();
2240 
2241                 for (uint32_t sect_idx = 1; sect_idx < m_mach_sections.size(); ++sect_idx)
2242                 {
2243                     if ((m_mach_sections[sect_idx].flags & SectionFlagMaskSectionType) == SectionTypeSymbolStubs)
2244                     {
2245                         uint32_t symbol_stub_byte_size = m_mach_sections[sect_idx].reserved2;
2246                         if (symbol_stub_byte_size == 0)
2247                             continue;
2248 
2249                         const uint32_t num_symbol_stubs = m_mach_sections[sect_idx].size / symbol_stub_byte_size;
2250 
2251                         if (num_symbol_stubs == 0)
2252                             continue;
2253 
2254                         const uint32_t symbol_stub_index_offset = m_mach_sections[sect_idx].reserved1;
2255                         for (uint32_t stub_idx = 0; stub_idx < num_symbol_stubs; ++stub_idx)
2256                         {
2257                             const uint32_t symbol_stub_index = symbol_stub_index_offset + stub_idx;
2258                             const lldb::addr_t symbol_stub_addr = m_mach_sections[sect_idx].addr + (stub_idx * symbol_stub_byte_size);
2259                             uint32_t symbol_stub_offset = symbol_stub_index * 4;
2260                             if (indirect_symbol_index_data.ValidOffsetForDataOfSize(symbol_stub_offset, 4))
2261                             {
2262                                 const uint32_t stub_sym_id = indirect_symbol_index_data.GetU32 (&symbol_stub_offset);
2263                                 if (stub_sym_id & (IndirectSymbolAbsolute | IndirectSymbolLocal))
2264                                     continue;
2265 
2266                                 NListIndexToSymbolIndexMap::const_iterator index_pos = m_nlist_idx_to_sym_idx.find (stub_sym_id);
2267                                 Symbol *stub_symbol = NULL;
2268                                 if (index_pos != end_index_pos)
2269                                 {
2270                                     // We have a remapping from the original nlist index to
2271                                     // a current symbol index, so just look this up by index
2272                                     stub_symbol = symtab->SymbolAtIndex (index_pos->second);
2273                                 }
2274                                 else
2275                                 {
2276                                     // We need to lookup a symbol using the original nlist
2277                                     // symbol index since this index is coming from the
2278                                     // S_SYMBOL_STUBS
2279                                     stub_symbol = symtab->FindSymbolByID (stub_sym_id);
2280                                 }
2281 
2282                                 assert (stub_symbol);
2283                                 if (stub_symbol)
2284                                 {
2285                                     Address so_addr(symbol_stub_addr, section_list);
2286 
2287                                     if (stub_symbol->GetType() == eSymbolTypeUndefined)
2288                                     {
2289                                         // Change the external symbol into a trampoline that makes sense
2290                                         // These symbols were N_UNDF N_EXT, and are useless to us, so we
2291                                         // can re-use them so we don't have to make up a synthetic symbol
2292                                         // for no good reason.
2293                                         stub_symbol->SetType (eSymbolTypeTrampoline);
2294                                         stub_symbol->SetExternal (false);
2295                                         stub_symbol->GetAddress() = so_addr;
2296                                         stub_symbol->SetByteSize (symbol_stub_byte_size);
2297                                     }
2298                                     else
2299                                     {
2300                                         // Make a synthetic symbol to describe the trampoline stub
2301                                         Mangled stub_symbol_mangled_name(stub_symbol->GetMangled());
2302                                         if (sym_idx >= num_syms)
2303                                         {
2304                                             sym = symtab->Resize (++num_syms);
2305                                             stub_symbol = NULL;  // this pointer no longer valid
2306                                         }
2307                                         sym[sym_idx].SetID (synthetic_sym_id++);
2308                                         sym[sym_idx].GetMangled() = stub_symbol_mangled_name;
2309                                         sym[sym_idx].SetType (eSymbolTypeTrampoline);
2310                                         sym[sym_idx].SetIsSynthetic (true);
2311                                         sym[sym_idx].GetAddress() = so_addr;
2312                                         sym[sym_idx].SetByteSize (symbol_stub_byte_size);
2313                                         ++sym_idx;
2314                                     }
2315                                 }
2316                             }
2317                         }
2318                     }
2319                 }
2320             }
2321         }
2322         return symtab->GetNumSymbols();
2323     }
2324     return 0;
2325 }
2326 
2327 
2328 void
2329 ObjectFileMachO::Dump (Stream *s)
2330 {
2331     ModuleSP module_sp(GetModule());
2332     if (module_sp)
2333     {
2334         lldb_private::Mutex::Locker locker(module_sp->GetMutex());
2335         s->Printf("%p: ", this);
2336         s->Indent();
2337         if (m_header.magic == HeaderMagic64 || m_header.magic == HeaderMagic64Swapped)
2338             s->PutCString("ObjectFileMachO64");
2339         else
2340             s->PutCString("ObjectFileMachO32");
2341 
2342         ArchSpec header_arch(eArchTypeMachO, m_header.cputype, m_header.cpusubtype);
2343 
2344         *s << ", file = '" << m_file << "', arch = " << header_arch.GetArchitectureName() << "\n";
2345 
2346         if (m_sections_ap.get())
2347             m_sections_ap->Dump(s, NULL, true, UINT32_MAX);
2348 
2349         if (m_symtab_ap.get())
2350             m_symtab_ap->Dump(s, NULL, eSortOrderNone);
2351     }
2352 }
2353 
2354 
2355 bool
2356 ObjectFileMachO::GetUUID (lldb_private::UUID* uuid)
2357 {
2358     ModuleSP module_sp(GetModule());
2359     if (module_sp)
2360     {
2361         lldb_private::Mutex::Locker locker(module_sp->GetMutex());
2362         struct uuid_command load_cmd;
2363         uint32_t offset = MachHeaderSizeFromMagic(m_header.magic);
2364         uint32_t i;
2365         for (i=0; i<m_header.ncmds; ++i)
2366         {
2367             const uint32_t cmd_offset = offset;
2368             if (m_data.GetU32(&offset, &load_cmd, 2) == NULL)
2369                 break;
2370 
2371             if (load_cmd.cmd == LoadCommandUUID)
2372             {
2373                 const uint8_t *uuid_bytes = m_data.PeekData(offset, 16);
2374                 if (uuid_bytes)
2375                 {
2376                     uuid->SetBytes (uuid_bytes);
2377                     return true;
2378                 }
2379                 return false;
2380             }
2381             offset = cmd_offset + load_cmd.cmdsize;
2382         }
2383     }
2384     return false;
2385 }
2386 
2387 
2388 uint32_t
2389 ObjectFileMachO::GetDependentModules (FileSpecList& files)
2390 {
2391     uint32_t count = 0;
2392     ModuleSP module_sp(GetModule());
2393     if (module_sp)
2394     {
2395         lldb_private::Mutex::Locker locker(module_sp->GetMutex());
2396         struct load_command load_cmd;
2397         uint32_t offset = MachHeaderSizeFromMagic(m_header.magic);
2398         const bool resolve_path = false; // Don't resolve the dependend file paths since they may not reside on this system
2399         uint32_t i;
2400         for (i=0; i<m_header.ncmds; ++i)
2401         {
2402             const uint32_t cmd_offset = offset;
2403             if (m_data.GetU32(&offset, &load_cmd, 2) == NULL)
2404                 break;
2405 
2406             switch (load_cmd.cmd)
2407             {
2408             case LoadCommandDylibLoad:
2409             case LoadCommandDylibLoadWeak:
2410             case LoadCommandDylibReexport:
2411             case LoadCommandDynamicLinkerLoad:
2412             case LoadCommandFixedVMShlibLoad:
2413             case LoadCommandDylibLoadUpward:
2414                 {
2415                     uint32_t name_offset = cmd_offset + m_data.GetU32(&offset);
2416                     const char *path = m_data.PeekCStr(name_offset);
2417                     // Skip any path that starts with '@' since these are usually:
2418                     // @executable_path/.../file
2419                     // @rpath/.../file
2420                     if (path && path[0] != '@')
2421                     {
2422                         FileSpec file_spec(path, resolve_path);
2423                         if (files.AppendIfUnique(file_spec))
2424                             count++;
2425                     }
2426                 }
2427                 break;
2428 
2429             default:
2430                 break;
2431             }
2432             offset = cmd_offset + load_cmd.cmdsize;
2433         }
2434     }
2435     return count;
2436 }
2437 
2438 lldb_private::Address
2439 ObjectFileMachO::GetEntryPointAddress ()
2440 {
2441     // If the object file is not an executable it can't hold the entry point.  m_entry_point_address
2442     // is initialized to an invalid address, so we can just return that.
2443     // If m_entry_point_address is valid it means we've found it already, so return the cached value.
2444 
2445     if (!IsExecutable() || m_entry_point_address.IsValid())
2446         return m_entry_point_address;
2447 
2448     // Otherwise, look for the UnixThread or Thread command.  The data for the Thread command is given in
2449     // /usr/include/mach-o.h, but it is basically:
2450     //
2451     //  uint32_t flavor  - this is the flavor argument you would pass to thread_get_state
2452     //  uint32_t count   - this is the count of longs in the thread state data
2453     //  struct XXX_thread_state state - this is the structure from <machine/thread_status.h> corresponding to the flavor.
2454     //  <repeat this trio>
2455     //
2456     // So we just keep reading the various register flavors till we find the GPR one, then read the PC out of there.
2457     // FIXME: We will need to have a "RegisterContext data provider" class at some point that can get all the registers
2458     // out of data in this form & attach them to a given thread.  That should underlie the MacOS X User process plugin,
2459     // and we'll also need it for the MacOS X Core File process plugin.  When we have that we can also use it here.
2460     //
2461     // For now we hard-code the offsets and flavors we need:
2462     //
2463     //
2464 
2465     ModuleSP module_sp(GetModule());
2466     if (module_sp)
2467     {
2468         lldb_private::Mutex::Locker locker(module_sp->GetMutex());
2469         struct load_command load_cmd;
2470         uint32_t offset = MachHeaderSizeFromMagic(m_header.magic);
2471         uint32_t i;
2472         lldb::addr_t start_address = LLDB_INVALID_ADDRESS;
2473         bool done = false;
2474 
2475         for (i=0; i<m_header.ncmds; ++i)
2476         {
2477             const uint32_t cmd_offset = offset;
2478             if (m_data.GetU32(&offset, &load_cmd, 2) == NULL)
2479                 break;
2480 
2481             switch (load_cmd.cmd)
2482             {
2483             case LoadCommandUnixThread:
2484             case LoadCommandThread:
2485                 {
2486                     while (offset < cmd_offset + load_cmd.cmdsize)
2487                     {
2488                         uint32_t flavor = m_data.GetU32(&offset);
2489                         uint32_t count = m_data.GetU32(&offset);
2490                         if (count == 0)
2491                         {
2492                             // We've gotten off somehow, log and exit;
2493                             return m_entry_point_address;
2494                         }
2495 
2496                         switch (m_header.cputype)
2497                         {
2498                         case llvm::MachO::CPUTypeARM:
2499                            if (flavor == 1) // ARM_THREAD_STATE from mach/arm/thread_status.h
2500                            {
2501                                offset += 60;  // This is the offset of pc in the GPR thread state data structure.
2502                                start_address = m_data.GetU32(&offset);
2503                                done = true;
2504                             }
2505                         break;
2506                         case llvm::MachO::CPUTypeI386:
2507                            if (flavor == 1) // x86_THREAD_STATE32 from mach/i386/thread_status.h
2508                            {
2509                                offset += 40;  // This is the offset of eip in the GPR thread state data structure.
2510                                start_address = m_data.GetU32(&offset);
2511                                done = true;
2512                             }
2513                         break;
2514                         case llvm::MachO::CPUTypeX86_64:
2515                            if (flavor == 4) // x86_THREAD_STATE64 from mach/i386/thread_status.h
2516                            {
2517                                offset += 16 * 8;  // This is the offset of rip in the GPR thread state data structure.
2518                                start_address = m_data.GetU64(&offset);
2519                                done = true;
2520                             }
2521                         break;
2522                         default:
2523                             return m_entry_point_address;
2524                         }
2525                         // Haven't found the GPR flavor yet, skip over the data for this flavor:
2526                         if (done)
2527                             break;
2528                         offset += count * 4;
2529                     }
2530                 }
2531                 break;
2532             case LoadCommandMain:
2533                 {
2534                     ConstString text_segment_name ("__TEXT");
2535                     uint64_t entryoffset = m_data.GetU64(&offset);
2536                     SectionSP text_segment_sp = GetSectionList()->FindSectionByName(text_segment_name);
2537                     if (text_segment_sp)
2538                     {
2539                         done = true;
2540                         start_address = text_segment_sp->GetFileAddress() + entryoffset;
2541                     }
2542                 }
2543 
2544             default:
2545                 break;
2546             }
2547             if (done)
2548                 break;
2549 
2550             // Go to the next load command:
2551             offset = cmd_offset + load_cmd.cmdsize;
2552         }
2553 
2554         if (start_address != LLDB_INVALID_ADDRESS)
2555         {
2556             // We got the start address from the load commands, so now resolve that address in the sections
2557             // of this ObjectFile:
2558             if (!m_entry_point_address.ResolveAddressUsingFileSections (start_address, GetSectionList()))
2559             {
2560                 m_entry_point_address.Clear();
2561             }
2562         }
2563         else
2564         {
2565             // We couldn't read the UnixThread load command - maybe it wasn't there.  As a fallback look for the
2566             // "start" symbol in the main executable.
2567 
2568             ModuleSP module_sp (GetModule());
2569 
2570             if (module_sp)
2571             {
2572                 SymbolContextList contexts;
2573                 SymbolContext context;
2574                 if (module_sp->FindSymbolsWithNameAndType(ConstString ("start"), eSymbolTypeCode, contexts))
2575                 {
2576                     if (contexts.GetContextAtIndex(0, context))
2577                         m_entry_point_address = context.symbol->GetAddress();
2578                 }
2579             }
2580         }
2581     }
2582 
2583     return m_entry_point_address;
2584 
2585 }
2586 
2587 lldb_private::Address
2588 ObjectFileMachO::GetHeaderAddress ()
2589 {
2590     lldb_private::Address header_addr;
2591     SectionList *section_list = GetSectionList();
2592     if (section_list)
2593     {
2594         SectionSP text_segment_sp (section_list->FindSectionByName (GetSegmentNameTEXT()));
2595         if (text_segment_sp)
2596         {
2597             header_addr.SetSection (text_segment_sp);
2598             header_addr.SetOffset (0);
2599         }
2600     }
2601     return header_addr;
2602 }
2603 
2604 uint32_t
2605 ObjectFileMachO::GetNumThreadContexts ()
2606 {
2607     ModuleSP module_sp(GetModule());
2608     if (module_sp)
2609     {
2610         lldb_private::Mutex::Locker locker(module_sp->GetMutex());
2611         if (!m_thread_context_offsets_valid)
2612         {
2613             m_thread_context_offsets_valid = true;
2614             uint32_t offset = MachHeaderSizeFromMagic(m_header.magic);
2615             FileRangeArray::Entry file_range;
2616             thread_command thread_cmd;
2617             for (uint32_t i=0; i<m_header.ncmds; ++i)
2618             {
2619                 const uint32_t cmd_offset = offset;
2620                 if (m_data.GetU32(&offset, &thread_cmd, 2) == NULL)
2621                     break;
2622 
2623                 if (thread_cmd.cmd == LoadCommandThread)
2624                 {
2625                     file_range.SetRangeBase (offset);
2626                     file_range.SetByteSize (thread_cmd.cmdsize - 8);
2627                     m_thread_context_offsets.Append (file_range);
2628                 }
2629                 offset = cmd_offset + thread_cmd.cmdsize;
2630             }
2631         }
2632     }
2633     return m_thread_context_offsets.GetSize();
2634 }
2635 
2636 lldb::RegisterContextSP
2637 ObjectFileMachO::GetThreadContextAtIndex (uint32_t idx, lldb_private::Thread &thread)
2638 {
2639     lldb::RegisterContextSP reg_ctx_sp;
2640 
2641     ModuleSP module_sp(GetModule());
2642     if (module_sp)
2643     {
2644         lldb_private::Mutex::Locker locker(module_sp->GetMutex());
2645         if (!m_thread_context_offsets_valid)
2646             GetNumThreadContexts ();
2647 
2648         const FileRangeArray::Entry *thread_context_file_range = m_thread_context_offsets.GetEntryAtIndex (idx);
2649 
2650         DataExtractor data (m_data,
2651                             thread_context_file_range->GetRangeBase(),
2652                             thread_context_file_range->GetByteSize());
2653 
2654         switch (m_header.cputype)
2655         {
2656             case llvm::MachO::CPUTypeARM:
2657                 reg_ctx_sp.reset (new RegisterContextDarwin_arm_Mach (thread, data));
2658                 break;
2659 
2660             case llvm::MachO::CPUTypeI386:
2661                 reg_ctx_sp.reset (new RegisterContextDarwin_i386_Mach (thread, data));
2662                 break;
2663 
2664             case llvm::MachO::CPUTypeX86_64:
2665                 reg_ctx_sp.reset (new RegisterContextDarwin_x86_64_Mach (thread, data));
2666                 break;
2667         }
2668     }
2669     return reg_ctx_sp;
2670 }
2671 
2672 
2673 ObjectFile::Type
2674 ObjectFileMachO::CalculateType()
2675 {
2676     switch (m_header.filetype)
2677     {
2678         case HeaderFileTypeObject:                                          // 0x1u MH_OBJECT
2679             if (GetAddressByteSize () == 4)
2680             {
2681                 // 32 bit kexts are just object files, but they do have a valid
2682                 // UUID load command.
2683                 UUID uuid;
2684                 if (GetUUID(&uuid))
2685                 {
2686                     // this checking for the UUID load command is not enough
2687                     // we could eventually look for the symbol named
2688                     // "OSKextGetCurrentIdentifier" as this is required of kexts
2689                     if (m_strata == eStrataInvalid)
2690                         m_strata = eStrataKernel;
2691                     return eTypeSharedLibrary;
2692                 }
2693             }
2694             return eTypeObjectFile;
2695 
2696         case HeaderFileTypeExecutable:          return eTypeExecutable;     // 0x2u MH_EXECUTE
2697         case HeaderFileTypeFixedVMShlib:        return eTypeSharedLibrary;  // 0x3u MH_FVMLIB
2698         case HeaderFileTypeCore:                return eTypeCoreFile;       // 0x4u MH_CORE
2699         case HeaderFileTypePreloadedExecutable: return eTypeSharedLibrary;  // 0x5u MH_PRELOAD
2700         case HeaderFileTypeDynamicShlib:        return eTypeSharedLibrary;  // 0x6u MH_DYLIB
2701         case HeaderFileTypeDynamicLinkEditor:   return eTypeDynamicLinker;  // 0x7u MH_DYLINKER
2702         case HeaderFileTypeBundle:              return eTypeSharedLibrary;  // 0x8u MH_BUNDLE
2703         case HeaderFileTypeDynamicShlibStub:    return eTypeStubLibrary;    // 0x9u MH_DYLIB_STUB
2704         case HeaderFileTypeDSYM:                return eTypeDebugInfo;      // 0xAu MH_DSYM
2705         case HeaderFileTypeKextBundle:          return eTypeSharedLibrary;  // 0xBu MH_KEXT_BUNDLE
2706         default:
2707             break;
2708     }
2709     return eTypeUnknown;
2710 }
2711 
2712 ObjectFile::Strata
2713 ObjectFileMachO::CalculateStrata()
2714 {
2715     switch (m_header.filetype)
2716     {
2717         case HeaderFileTypeObject:      // 0x1u MH_OBJECT
2718             {
2719                 // 32 bit kexts are just object files, but they do have a valid
2720                 // UUID load command.
2721                 UUID uuid;
2722                 if (GetUUID(&uuid))
2723                 {
2724                     // this checking for the UUID load command is not enough
2725                     // we could eventually look for the symbol named
2726                     // "OSKextGetCurrentIdentifier" as this is required of kexts
2727                     if (m_type == eTypeInvalid)
2728                         m_type = eTypeSharedLibrary;
2729 
2730                     return eStrataKernel;
2731                 }
2732             }
2733             return eStrataUnknown;
2734 
2735         case HeaderFileTypeExecutable:                                     // 0x2u MH_EXECUTE
2736             // Check for the MH_DYLDLINK bit in the flags
2737             if (m_header.flags & HeaderFlagBitIsDynamicLinkObject)
2738             {
2739                 return eStrataUser;
2740             }
2741             else
2742             {
2743                 SectionList *section_list = GetSectionList();
2744                 if (section_list)
2745                 {
2746                     static ConstString g_kld_section_name ("__KLD");
2747                     if (section_list->FindSectionByName(g_kld_section_name))
2748                         return eStrataKernel;
2749                 }
2750             }
2751             return eStrataRawImage;
2752 
2753         case HeaderFileTypeFixedVMShlib:        return eStrataUser;         // 0x3u MH_FVMLIB
2754         case HeaderFileTypeCore:                return eStrataUnknown;      // 0x4u MH_CORE
2755         case HeaderFileTypePreloadedExecutable: return eStrataRawImage;     // 0x5u MH_PRELOAD
2756         case HeaderFileTypeDynamicShlib:        return eStrataUser;         // 0x6u MH_DYLIB
2757         case HeaderFileTypeDynamicLinkEditor:   return eStrataUser;         // 0x7u MH_DYLINKER
2758         case HeaderFileTypeBundle:              return eStrataUser;         // 0x8u MH_BUNDLE
2759         case HeaderFileTypeDynamicShlibStub:    return eStrataUser;         // 0x9u MH_DYLIB_STUB
2760         case HeaderFileTypeDSYM:                return eStrataUnknown;      // 0xAu MH_DSYM
2761         case HeaderFileTypeKextBundle:          return eStrataKernel;       // 0xBu MH_KEXT_BUNDLE
2762         default:
2763             break;
2764     }
2765     return eStrataUnknown;
2766 }
2767 
2768 
2769 uint32_t
2770 ObjectFileMachO::GetVersion (uint32_t *versions, uint32_t num_versions)
2771 {
2772     ModuleSP module_sp(GetModule());
2773     if (module_sp)
2774     {
2775         lldb_private::Mutex::Locker locker(module_sp->GetMutex());
2776         struct dylib_command load_cmd;
2777         uint32_t offset = MachHeaderSizeFromMagic(m_header.magic);
2778         uint32_t version_cmd = 0;
2779         uint64_t version = 0;
2780         uint32_t i;
2781         for (i=0; i<m_header.ncmds; ++i)
2782         {
2783             const uint32_t cmd_offset = offset;
2784             if (m_data.GetU32(&offset, &load_cmd, 2) == NULL)
2785                 break;
2786 
2787             if (load_cmd.cmd == LoadCommandDylibIdent)
2788             {
2789                 if (version_cmd == 0)
2790                 {
2791                     version_cmd = load_cmd.cmd;
2792                     if (m_data.GetU32(&offset, &load_cmd.dylib, 4) == NULL)
2793                         break;
2794                     version = load_cmd.dylib.current_version;
2795                 }
2796                 break; // Break for now unless there is another more complete version
2797                        // number load command in the future.
2798             }
2799             offset = cmd_offset + load_cmd.cmdsize;
2800         }
2801 
2802         if (version_cmd == LoadCommandDylibIdent)
2803         {
2804             if (versions != NULL && num_versions > 0)
2805             {
2806                 if (num_versions > 0)
2807                     versions[0] = (version & 0xFFFF0000ull) >> 16;
2808                 if (num_versions > 1)
2809                     versions[1] = (version & 0x0000FF00ull) >> 8;
2810                 if (num_versions > 2)
2811                     versions[2] = (version & 0x000000FFull);
2812                 // Fill in an remaining version numbers with invalid values
2813                 for (i=3; i<num_versions; ++i)
2814                     versions[i] = UINT32_MAX;
2815             }
2816             // The LC_ID_DYLIB load command has a version with 3 version numbers
2817             // in it, so always return 3
2818             return 3;
2819         }
2820     }
2821     return false;
2822 }
2823 
2824 bool
2825 ObjectFileMachO::GetArchitecture (ArchSpec &arch)
2826 {
2827     ModuleSP module_sp(GetModule());
2828     if (module_sp)
2829     {
2830         lldb_private::Mutex::Locker locker(module_sp->GetMutex());
2831         arch.SetArchitecture (eArchTypeMachO, m_header.cputype, m_header.cpusubtype);
2832 
2833         // Files with type MH_PRELOAD are currently used in cases where the image
2834         // debugs at the addresses in the file itself. Below we set the OS to
2835         // unknown to make sure we use the DynamicLoaderStatic()...
2836         if (m_header.filetype == HeaderFileTypePreloadedExecutable)
2837         {
2838             arch.GetTriple().setOS (llvm::Triple::UnknownOS);
2839         }
2840         return true;
2841     }
2842     return false;
2843 }
2844 
2845 
2846 //------------------------------------------------------------------
2847 // PluginInterface protocol
2848 //------------------------------------------------------------------
2849 const char *
2850 ObjectFileMachO::GetPluginName()
2851 {
2852     return "ObjectFileMachO";
2853 }
2854 
2855 const char *
2856 ObjectFileMachO::GetShortPluginName()
2857 {
2858     return GetPluginNameStatic();
2859 }
2860 
2861 uint32_t
2862 ObjectFileMachO::GetPluginVersion()
2863 {
2864     return 1;
2865 }
2866 
2867