1 //===-- ObjectFile.cpp ------------------------------------------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #include "lldb/Symbol/ObjectFile.h"
10 #include "lldb/Core/Module.h"
11 #include "lldb/Core/ModuleSpec.h"
12 #include "lldb/Core/PluginManager.h"
13 #include "lldb/Core/Section.h"
14 #include "lldb/Symbol/ObjectContainer.h"
15 #include "lldb/Symbol/SymbolFile.h"
16 #include "lldb/Target/Process.h"
17 #include "lldb/Target/SectionLoadList.h"
18 #include "lldb/Target/Target.h"
19 #include "lldb/Utility/DataBuffer.h"
20 #include "lldb/Utility/DataBufferHeap.h"
21 #include "lldb/Utility/Log.h"
22 #include "lldb/Utility/RegularExpression.h"
23 #include "lldb/Utility/Timer.h"
24 #include "lldb/lldb-private.h"
25 
26 using namespace lldb;
27 using namespace lldb_private;
28 
29 ObjectFileSP
30 ObjectFile::FindPlugin(const lldb::ModuleSP &module_sp, const FileSpec *file,
31                        lldb::offset_t file_offset, lldb::offset_t file_size,
32                        DataBufferSP &data_sp, lldb::offset_t &data_offset) {
33   ObjectFileSP object_file_sp;
34 
35   if (module_sp) {
36     static Timer::Category func_cat(LLVM_PRETTY_FUNCTION);
37     Timer scoped_timer(
38         func_cat,
39         "ObjectFile::FindPlugin (module = %s, file = %p, file_offset = "
40         "0x%8.8" PRIx64 ", file_size = 0x%8.8" PRIx64 ")",
41         module_sp->GetFileSpec().GetPath().c_str(),
42         static_cast<const void *>(file), static_cast<uint64_t>(file_offset),
43         static_cast<uint64_t>(file_size));
44     if (file) {
45       FileSpec archive_file;
46       ObjectContainerCreateInstance create_object_container_callback;
47 
48       const bool file_exists = FileSystem::Instance().Exists(*file);
49       if (!data_sp) {
50         // We have an object name which most likely means we have a .o file in
51         // a static archive (.a file). Try and see if we have a cached archive
52         // first without reading any data first
53         if (file_exists && module_sp->GetObjectName()) {
54           for (uint32_t idx = 0;
55                (create_object_container_callback =
56                     PluginManager::GetObjectContainerCreateCallbackAtIndex(
57                         idx)) != nullptr;
58                ++idx) {
59             std::unique_ptr<ObjectContainer> object_container_ap(
60                 create_object_container_callback(module_sp, data_sp,
61                                                  data_offset, file, file_offset,
62                                                  file_size));
63 
64             if (object_container_ap.get())
65               object_file_sp = object_container_ap->GetObjectFile(file);
66 
67             if (object_file_sp.get())
68               return object_file_sp;
69           }
70         }
71         // Ok, we didn't find any containers that have a named object, now lets
72         // read the first 512 bytes from the file so the object file and object
73         // container plug-ins can use these bytes to see if they can parse this
74         // file.
75         if (file_size > 0) {
76           data_sp = FileSystem::Instance().CreateDataBuffer(file->GetPath(),
77                                                             512, file_offset);
78           data_offset = 0;
79         }
80       }
81 
82       if (!data_sp || data_sp->GetByteSize() == 0) {
83         // Check for archive file with format "/path/to/archive.a(object.o)"
84         char path_with_object[PATH_MAX * 2];
85         module_sp->GetFileSpec().GetPath(path_with_object,
86                                          sizeof(path_with_object));
87 
88         ConstString archive_object;
89         const bool must_exist = true;
90         if (ObjectFile::SplitArchivePathWithObject(
91                 path_with_object, archive_file, archive_object, must_exist)) {
92           file_size = FileSystem::Instance().GetByteSize(archive_file);
93           if (file_size > 0) {
94             file = &archive_file;
95             module_sp->SetFileSpecAndObjectName(archive_file, archive_object);
96             // Check if this is a object container by iterating through all
97             // object container plugin instances and then trying to get an
98             // object file from the container plugins since we had a name.
99             // Also, don't read
100             // ANY data in case there is data cached in the container plug-ins
101             // (like BSD archives caching the contained objects within an
102             // file).
103             for (uint32_t idx = 0;
104                  (create_object_container_callback =
105                       PluginManager::GetObjectContainerCreateCallbackAtIndex(
106                           idx)) != nullptr;
107                  ++idx) {
108               std::unique_ptr<ObjectContainer> object_container_ap(
109                   create_object_container_callback(module_sp, data_sp,
110                                                    data_offset, file,
111                                                    file_offset, file_size));
112 
113               if (object_container_ap.get())
114                 object_file_sp = object_container_ap->GetObjectFile(file);
115 
116               if (object_file_sp.get())
117                 return object_file_sp;
118             }
119             // We failed to find any cached object files in the container plug-
120             // ins, so lets read the first 512 bytes and try again below...
121             data_sp = FileSystem::Instance().CreateDataBuffer(
122                 archive_file.GetPath(), 512, file_offset);
123           }
124         }
125       }
126 
127       if (data_sp && data_sp->GetByteSize() > 0) {
128         // Check if this is a normal object file by iterating through all
129         // object file plugin instances.
130         ObjectFileCreateInstance create_object_file_callback;
131         for (uint32_t idx = 0;
132              (create_object_file_callback =
133                   PluginManager::GetObjectFileCreateCallbackAtIndex(idx)) !=
134              nullptr;
135              ++idx) {
136           object_file_sp.reset(create_object_file_callback(
137               module_sp, data_sp, data_offset, file, file_offset, file_size));
138           if (object_file_sp.get())
139             return object_file_sp;
140         }
141 
142         // Check if this is a object container by iterating through all object
143         // container plugin instances and then trying to get an object file
144         // from the container.
145         for (uint32_t idx = 0;
146              (create_object_container_callback =
147                   PluginManager::GetObjectContainerCreateCallbackAtIndex(
148                       idx)) != nullptr;
149              ++idx) {
150           std::unique_ptr<ObjectContainer> object_container_ap(
151               create_object_container_callback(module_sp, data_sp, data_offset,
152                                                file, file_offset, file_size));
153 
154           if (object_container_ap.get())
155             object_file_sp = object_container_ap->GetObjectFile(file);
156 
157           if (object_file_sp.get())
158             return object_file_sp;
159         }
160       }
161     }
162   }
163   // We didn't find it, so clear our shared pointer in case it contains
164   // anything and return an empty shared pointer
165   object_file_sp.reset();
166   return object_file_sp;
167 }
168 
169 ObjectFileSP ObjectFile::FindPlugin(const lldb::ModuleSP &module_sp,
170                                     const ProcessSP &process_sp,
171                                     lldb::addr_t header_addr,
172                                     DataBufferSP &data_sp) {
173   ObjectFileSP object_file_sp;
174 
175   if (module_sp) {
176     static Timer::Category func_cat(LLVM_PRETTY_FUNCTION);
177     Timer scoped_timer(func_cat,
178                        "ObjectFile::FindPlugin (module = "
179                        "%s, process = %p, header_addr = "
180                        "0x%" PRIx64 ")",
181                        module_sp->GetFileSpec().GetPath().c_str(),
182                        static_cast<void *>(process_sp.get()), header_addr);
183     uint32_t idx;
184 
185     // Check if this is a normal object file by iterating through all object
186     // file plugin instances.
187     ObjectFileCreateMemoryInstance create_callback;
188     for (idx = 0;
189          (create_callback =
190               PluginManager::GetObjectFileCreateMemoryCallbackAtIndex(idx)) !=
191          nullptr;
192          ++idx) {
193       object_file_sp.reset(
194           create_callback(module_sp, data_sp, process_sp, header_addr));
195       if (object_file_sp.get())
196         return object_file_sp;
197     }
198   }
199 
200   // We didn't find it, so clear our shared pointer in case it contains
201   // anything and return an empty shared pointer
202   object_file_sp.reset();
203   return object_file_sp;
204 }
205 
206 size_t ObjectFile::GetModuleSpecifications(const FileSpec &file,
207                                            lldb::offset_t file_offset,
208                                            lldb::offset_t file_size,
209                                            ModuleSpecList &specs) {
210   DataBufferSP data_sp =
211       FileSystem::Instance().CreateDataBuffer(file.GetPath(), 512, file_offset);
212   if (data_sp) {
213     if (file_size == 0) {
214       const lldb::offset_t actual_file_size =
215           FileSystem::Instance().GetByteSize(file);
216       if (actual_file_size > file_offset)
217         file_size = actual_file_size - file_offset;
218     }
219     return ObjectFile::GetModuleSpecifications(file,        // file spec
220                                                data_sp,     // data bytes
221                                                0,           // data offset
222                                                file_offset, // file offset
223                                                file_size,   // file length
224                                                specs);
225   }
226   return 0;
227 }
228 
229 size_t ObjectFile::GetModuleSpecifications(
230     const lldb_private::FileSpec &file, lldb::DataBufferSP &data_sp,
231     lldb::offset_t data_offset, lldb::offset_t file_offset,
232     lldb::offset_t file_size, lldb_private::ModuleSpecList &specs) {
233   const size_t initial_count = specs.GetSize();
234   ObjectFileGetModuleSpecifications callback;
235   uint32_t i;
236   // Try the ObjectFile plug-ins
237   for (i = 0;
238        (callback =
239             PluginManager::GetObjectFileGetModuleSpecificationsCallbackAtIndex(
240                 i)) != nullptr;
241        ++i) {
242     if (callback(file, data_sp, data_offset, file_offset, file_size, specs) > 0)
243       return specs.GetSize() - initial_count;
244   }
245 
246   // Try the ObjectContainer plug-ins
247   for (i = 0;
248        (callback = PluginManager::
249             GetObjectContainerGetModuleSpecificationsCallbackAtIndex(i)) !=
250        nullptr;
251        ++i) {
252     if (callback(file, data_sp, data_offset, file_offset, file_size, specs) > 0)
253       return specs.GetSize() - initial_count;
254   }
255   return 0;
256 }
257 
258 ObjectFile::ObjectFile(const lldb::ModuleSP &module_sp,
259                        const FileSpec *file_spec_ptr,
260                        lldb::offset_t file_offset, lldb::offset_t length,
261                        const lldb::DataBufferSP &data_sp,
262                        lldb::offset_t data_offset)
263     : ModuleChild(module_sp),
264       m_file(), // This file could be different from the original module's file
265       m_type(eTypeInvalid), m_strata(eStrataInvalid),
266       m_file_offset(file_offset), m_length(length), m_data(),
267       m_unwind_table(*this), m_process_wp(),
268       m_memory_addr(LLDB_INVALID_ADDRESS), m_sections_ap(), m_symtab_ap(),
269       m_synthetic_symbol_idx(0) {
270   if (file_spec_ptr)
271     m_file = *file_spec_ptr;
272   if (data_sp)
273     m_data.SetData(data_sp, data_offset, length);
274   Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_OBJECT));
275   if (log)
276     log->Printf("%p ObjectFile::ObjectFile() module = %p (%s), file = %s, "
277                 "file_offset = 0x%8.8" PRIx64 ", size = %" PRIu64,
278                 static_cast<void *>(this), static_cast<void *>(module_sp.get()),
279                 module_sp->GetSpecificationDescription().c_str(),
280                 m_file ? m_file.GetPath().c_str() : "<NULL>", m_file_offset,
281                 m_length);
282 }
283 
284 ObjectFile::ObjectFile(const lldb::ModuleSP &module_sp,
285                        const ProcessSP &process_sp, lldb::addr_t header_addr,
286                        DataBufferSP &header_data_sp)
287     : ModuleChild(module_sp), m_file(), m_type(eTypeInvalid),
288       m_strata(eStrataInvalid), m_file_offset(0), m_length(0), m_data(),
289       m_unwind_table(*this), m_process_wp(process_sp),
290       m_memory_addr(header_addr), m_sections_ap(), m_symtab_ap(),
291       m_synthetic_symbol_idx(0) {
292   if (header_data_sp)
293     m_data.SetData(header_data_sp, 0, header_data_sp->GetByteSize());
294   Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_OBJECT));
295   if (log)
296     log->Printf("%p ObjectFile::ObjectFile() module = %p (%s), process = %p, "
297                 "header_addr = 0x%" PRIx64,
298                 static_cast<void *>(this), static_cast<void *>(module_sp.get()),
299                 module_sp->GetSpecificationDescription().c_str(),
300                 static_cast<void *>(process_sp.get()), m_memory_addr);
301 }
302 
303 ObjectFile::~ObjectFile() {
304   Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_OBJECT));
305   if (log)
306     log->Printf("%p ObjectFile::~ObjectFile ()\n", static_cast<void *>(this));
307 }
308 
309 bool ObjectFile::SetModulesArchitecture(const ArchSpec &new_arch) {
310   ModuleSP module_sp(GetModule());
311   if (module_sp)
312     return module_sp->SetArchitecture(new_arch);
313   return false;
314 }
315 
316 AddressClass ObjectFile::GetAddressClass(addr_t file_addr) {
317   Symtab *symtab = GetSymtab();
318   if (symtab) {
319     Symbol *symbol = symtab->FindSymbolContainingFileAddress(file_addr);
320     if (symbol) {
321       if (symbol->ValueIsAddress()) {
322         const SectionSP section_sp(symbol->GetAddressRef().GetSection());
323         if (section_sp) {
324           const SectionType section_type = section_sp->GetType();
325           switch (section_type) {
326           case eSectionTypeInvalid:
327             return AddressClass::eUnknown;
328           case eSectionTypeCode:
329             return AddressClass::eCode;
330           case eSectionTypeContainer:
331             return AddressClass::eUnknown;
332           case eSectionTypeData:
333           case eSectionTypeDataCString:
334           case eSectionTypeDataCStringPointers:
335           case eSectionTypeDataSymbolAddress:
336           case eSectionTypeData4:
337           case eSectionTypeData8:
338           case eSectionTypeData16:
339           case eSectionTypeDataPointers:
340           case eSectionTypeZeroFill:
341           case eSectionTypeDataObjCMessageRefs:
342           case eSectionTypeDataObjCCFStrings:
343           case eSectionTypeGoSymtab:
344             return AddressClass::eData;
345           case eSectionTypeDebug:
346           case eSectionTypeDWARFDebugAbbrev:
347           case eSectionTypeDWARFDebugAbbrevDwo:
348           case eSectionTypeDWARFDebugAddr:
349           case eSectionTypeDWARFDebugAranges:
350           case eSectionTypeDWARFDebugCuIndex:
351           case eSectionTypeDWARFDebugFrame:
352           case eSectionTypeDWARFDebugInfo:
353           case eSectionTypeDWARFDebugInfoDwo:
354           case eSectionTypeDWARFDebugLine:
355           case eSectionTypeDWARFDebugLineStr:
356           case eSectionTypeDWARFDebugLoc:
357           case eSectionTypeDWARFDebugLocLists:
358           case eSectionTypeDWARFDebugMacInfo:
359           case eSectionTypeDWARFDebugMacro:
360           case eSectionTypeDWARFDebugNames:
361           case eSectionTypeDWARFDebugPubNames:
362           case eSectionTypeDWARFDebugPubTypes:
363           case eSectionTypeDWARFDebugRanges:
364           case eSectionTypeDWARFDebugRngLists:
365           case eSectionTypeDWARFDebugStr:
366           case eSectionTypeDWARFDebugStrDwo:
367           case eSectionTypeDWARFDebugStrOffsets:
368           case eSectionTypeDWARFDebugStrOffsetsDwo:
369           case eSectionTypeDWARFDebugTypes:
370           case eSectionTypeDWARFAppleNames:
371           case eSectionTypeDWARFAppleTypes:
372           case eSectionTypeDWARFAppleNamespaces:
373           case eSectionTypeDWARFAppleObjC:
374           case eSectionTypeDWARFGNUDebugAltLink:
375             return AddressClass::eDebug;
376           case eSectionTypeEHFrame:
377           case eSectionTypeARMexidx:
378           case eSectionTypeARMextab:
379           case eSectionTypeCompactUnwind:
380             return AddressClass::eRuntime;
381           case eSectionTypeELFSymbolTable:
382           case eSectionTypeELFDynamicSymbols:
383           case eSectionTypeELFRelocationEntries:
384           case eSectionTypeELFDynamicLinkInfo:
385           case eSectionTypeOther:
386             return AddressClass::eUnknown;
387           case eSectionTypeAbsoluteAddress:
388             // In case of absolute sections decide the address class based on
389             // the symbol type because the section type isn't specify if it is
390             // a code or a data section.
391             break;
392           }
393         }
394       }
395 
396       const SymbolType symbol_type = symbol->GetType();
397       switch (symbol_type) {
398       case eSymbolTypeAny:
399         return AddressClass::eUnknown;
400       case eSymbolTypeAbsolute:
401         return AddressClass::eUnknown;
402       case eSymbolTypeCode:
403         return AddressClass::eCode;
404       case eSymbolTypeTrampoline:
405         return AddressClass::eCode;
406       case eSymbolTypeResolver:
407         return AddressClass::eCode;
408       case eSymbolTypeData:
409         return AddressClass::eData;
410       case eSymbolTypeRuntime:
411         return AddressClass::eRuntime;
412       case eSymbolTypeException:
413         return AddressClass::eRuntime;
414       case eSymbolTypeSourceFile:
415         return AddressClass::eDebug;
416       case eSymbolTypeHeaderFile:
417         return AddressClass::eDebug;
418       case eSymbolTypeObjectFile:
419         return AddressClass::eDebug;
420       case eSymbolTypeCommonBlock:
421         return AddressClass::eDebug;
422       case eSymbolTypeBlock:
423         return AddressClass::eDebug;
424       case eSymbolTypeLocal:
425         return AddressClass::eData;
426       case eSymbolTypeParam:
427         return AddressClass::eData;
428       case eSymbolTypeVariable:
429         return AddressClass::eData;
430       case eSymbolTypeVariableType:
431         return AddressClass::eDebug;
432       case eSymbolTypeLineEntry:
433         return AddressClass::eDebug;
434       case eSymbolTypeLineHeader:
435         return AddressClass::eDebug;
436       case eSymbolTypeScopeBegin:
437         return AddressClass::eDebug;
438       case eSymbolTypeScopeEnd:
439         return AddressClass::eDebug;
440       case eSymbolTypeAdditional:
441         return AddressClass::eUnknown;
442       case eSymbolTypeCompiler:
443         return AddressClass::eDebug;
444       case eSymbolTypeInstrumentation:
445         return AddressClass::eDebug;
446       case eSymbolTypeUndefined:
447         return AddressClass::eUnknown;
448       case eSymbolTypeObjCClass:
449         return AddressClass::eRuntime;
450       case eSymbolTypeObjCMetaClass:
451         return AddressClass::eRuntime;
452       case eSymbolTypeObjCIVar:
453         return AddressClass::eRuntime;
454       case eSymbolTypeReExported:
455         return AddressClass::eRuntime;
456       }
457     }
458   }
459   return AddressClass::eUnknown;
460 }
461 
462 DataBufferSP ObjectFile::ReadMemory(const ProcessSP &process_sp,
463                                     lldb::addr_t addr, size_t byte_size) {
464   DataBufferSP data_sp;
465   if (process_sp) {
466     std::unique_ptr<DataBufferHeap> data_ap(new DataBufferHeap(byte_size, 0));
467     Status error;
468     const size_t bytes_read = process_sp->ReadMemory(
469         addr, data_ap->GetBytes(), data_ap->GetByteSize(), error);
470     if (bytes_read == byte_size)
471       data_sp.reset(data_ap.release());
472   }
473   return data_sp;
474 }
475 
476 size_t ObjectFile::GetData(lldb::offset_t offset, size_t length,
477                            DataExtractor &data) const {
478   // The entire file has already been mmap'ed into m_data, so just copy from
479   // there as the back mmap buffer will be shared with shared pointers.
480   return data.SetData(m_data, offset, length);
481 }
482 
483 size_t ObjectFile::CopyData(lldb::offset_t offset, size_t length,
484                             void *dst) const {
485   // The entire file has already been mmap'ed into m_data, so just copy from
486   // there Note that the data remains in target byte order.
487   return m_data.CopyData(offset, length, dst);
488 }
489 
490 size_t ObjectFile::ReadSectionData(Section *section,
491                                    lldb::offset_t section_offset, void *dst,
492                                    size_t dst_len) {
493   assert(section);
494   section_offset *= section->GetTargetByteSize();
495 
496   // If some other objectfile owns this data, pass this to them.
497   if (section->GetObjectFile() != this)
498     return section->GetObjectFile()->ReadSectionData(section, section_offset,
499                                                      dst, dst_len);
500 
501   if (IsInMemory()) {
502     ProcessSP process_sp(m_process_wp.lock());
503     if (process_sp) {
504       Status error;
505       const addr_t base_load_addr =
506           section->GetLoadBaseAddress(&process_sp->GetTarget());
507       if (base_load_addr != LLDB_INVALID_ADDRESS)
508         return process_sp->ReadMemory(base_load_addr + section_offset, dst,
509                                       dst_len, error);
510     }
511   } else {
512     if (!section->IsRelocated())
513       RelocateSection(section);
514 
515     const lldb::offset_t section_file_size = section->GetFileSize();
516     if (section_offset < section_file_size) {
517       const size_t section_bytes_left = section_file_size - section_offset;
518       size_t section_dst_len = dst_len;
519       if (section_dst_len > section_bytes_left)
520         section_dst_len = section_bytes_left;
521       return CopyData(section->GetFileOffset() + section_offset,
522                       section_dst_len, dst);
523     } else {
524       if (section->GetType() == eSectionTypeZeroFill) {
525         const uint64_t section_size = section->GetByteSize();
526         const uint64_t section_bytes_left = section_size - section_offset;
527         uint64_t section_dst_len = dst_len;
528         if (section_dst_len > section_bytes_left)
529           section_dst_len = section_bytes_left;
530         memset(dst, 0, section_dst_len);
531         return section_dst_len;
532       }
533     }
534   }
535   return 0;
536 }
537 
538 //----------------------------------------------------------------------
539 // Get the section data the file on disk
540 //----------------------------------------------------------------------
541 size_t ObjectFile::ReadSectionData(Section *section,
542                                    DataExtractor &section_data) {
543   // If some other objectfile owns this data, pass this to them.
544   if (section->GetObjectFile() != this)
545     return section->GetObjectFile()->ReadSectionData(section, section_data);
546 
547   if (IsInMemory()) {
548     ProcessSP process_sp(m_process_wp.lock());
549     if (process_sp) {
550       const addr_t base_load_addr =
551           section->GetLoadBaseAddress(&process_sp->GetTarget());
552       if (base_load_addr != LLDB_INVALID_ADDRESS) {
553         DataBufferSP data_sp(
554             ReadMemory(process_sp, base_load_addr, section->GetByteSize()));
555         if (data_sp) {
556           section_data.SetData(data_sp, 0, data_sp->GetByteSize());
557           section_data.SetByteOrder(process_sp->GetByteOrder());
558           section_data.SetAddressByteSize(process_sp->GetAddressByteSize());
559           return section_data.GetByteSize();
560         }
561       }
562     }
563     return GetData(section->GetFileOffset(), section->GetFileSize(),
564                    section_data);
565   } else {
566     // The object file now contains a full mmap'ed copy of the object file
567     // data, so just use this
568     if (!section->IsRelocated())
569       RelocateSection(section);
570 
571     return GetData(section->GetFileOffset(), section->GetFileSize(),
572                    section_data);
573   }
574 }
575 
576 bool ObjectFile::SplitArchivePathWithObject(const char *path_with_object,
577                                             FileSpec &archive_file,
578                                             ConstString &archive_object,
579                                             bool must_exist) {
580   RegularExpression g_object_regex(llvm::StringRef("(.*)\\(([^\\)]+)\\)$"));
581   RegularExpression::Match regex_match(2);
582   if (g_object_regex.Execute(llvm::StringRef::withNullAsEmpty(path_with_object),
583                              &regex_match)) {
584     std::string path;
585     std::string obj;
586     if (regex_match.GetMatchAtIndex(path_with_object, 1, path) &&
587         regex_match.GetMatchAtIndex(path_with_object, 2, obj)) {
588       archive_file.SetFile(path, FileSpec::Style::native);
589       archive_object.SetCString(obj.c_str());
590       return !(must_exist && !FileSystem::Instance().Exists(archive_file));
591     }
592   }
593   return false;
594 }
595 
596 void ObjectFile::ClearSymtab() {
597   ModuleSP module_sp(GetModule());
598   if (module_sp) {
599     std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
600     Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_OBJECT));
601     if (log)
602       log->Printf("%p ObjectFile::ClearSymtab () symtab = %p",
603                   static_cast<void *>(this),
604                   static_cast<void *>(m_symtab_ap.get()));
605     m_symtab_ap.reset();
606   }
607 }
608 
609 SectionList *ObjectFile::GetSectionList(bool update_module_section_list) {
610   if (m_sections_ap.get() == nullptr) {
611     if (update_module_section_list) {
612       ModuleSP module_sp(GetModule());
613       if (module_sp) {
614         std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
615         CreateSections(*module_sp->GetUnifiedSectionList());
616       }
617     } else {
618       SectionList unified_section_list;
619       CreateSections(unified_section_list);
620     }
621   }
622   return m_sections_ap.get();
623 }
624 
625 lldb::SymbolType
626 ObjectFile::GetSymbolTypeFromName(llvm::StringRef name,
627                                   lldb::SymbolType symbol_type_hint) {
628   if (!name.empty()) {
629     if (name.startswith("_OBJC_")) {
630       // ObjC
631       if (name.startswith("_OBJC_CLASS_$_"))
632         return lldb::eSymbolTypeObjCClass;
633       if (name.startswith("_OBJC_METACLASS_$_"))
634         return lldb::eSymbolTypeObjCMetaClass;
635       if (name.startswith("_OBJC_IVAR_$_"))
636         return lldb::eSymbolTypeObjCIVar;
637     } else if (name.startswith(".objc_class_name_")) {
638       // ObjC v1
639       return lldb::eSymbolTypeObjCClass;
640     }
641   }
642   return symbol_type_hint;
643 }
644 
645 ConstString ObjectFile::GetNextSyntheticSymbolName() {
646   StreamString ss;
647   ConstString file_name = GetModule()->GetFileSpec().GetFilename();
648   ss.Printf("___lldb_unnamed_symbol%u$$%s", ++m_synthetic_symbol_idx,
649             file_name.GetCString());
650   return ConstString(ss.GetString());
651 }
652 
653 std::vector<ObjectFile::LoadableData>
654 ObjectFile::GetLoadableData(Target &target) {
655   std::vector<LoadableData> loadables;
656   SectionList *section_list = GetSectionList();
657   if (!section_list)
658     return loadables;
659   // Create a list of loadable data from loadable sections
660   size_t section_count = section_list->GetNumSections(0);
661   for (size_t i = 0; i < section_count; ++i) {
662     LoadableData loadable;
663     SectionSP section_sp = section_list->GetSectionAtIndex(i);
664     loadable.Dest =
665         target.GetSectionLoadList().GetSectionLoadAddress(section_sp);
666     if (loadable.Dest == LLDB_INVALID_ADDRESS)
667       continue;
668     // We can skip sections like bss
669     if (section_sp->GetFileSize() == 0)
670       continue;
671     DataExtractor section_data;
672     section_sp->GetSectionData(section_data);
673     loadable.Contents = llvm::ArrayRef<uint8_t>(section_data.GetDataStart(),
674                                                 section_data.GetByteSize());
675     loadables.push_back(loadable);
676   }
677   return loadables;
678 }
679 
680 void ObjectFile::RelocateSection(lldb_private::Section *section)
681 {
682 }
683 
684 DataBufferSP ObjectFile::MapFileData(const FileSpec &file, uint64_t Size,
685                                      uint64_t Offset) {
686   return FileSystem::Instance().CreateDataBuffer(file.GetPath(), Size, Offset);
687 }
688 
689 void llvm::format_provider<ObjectFile::Type>::format(
690     const ObjectFile::Type &type, raw_ostream &OS, StringRef Style) {
691   switch (type) {
692   case ObjectFile::eTypeInvalid:
693     OS << "invalid";
694     break;
695   case ObjectFile::eTypeCoreFile:
696     OS << "core file";
697     break;
698   case ObjectFile::eTypeExecutable:
699     OS << "executable";
700     break;
701   case ObjectFile::eTypeDebugInfo:
702     OS << "debug info";
703     break;
704   case ObjectFile::eTypeDynamicLinker:
705     OS << "dynamic linker";
706     break;
707   case ObjectFile::eTypeObjectFile:
708     OS << "object file";
709     break;
710   case ObjectFile::eTypeSharedLibrary:
711     OS << "shared library";
712     break;
713   case ObjectFile::eTypeStubLibrary:
714     OS << "stub library";
715     break;
716   case ObjectFile::eTypeJIT:
717     OS << "jit";
718     break;
719   case ObjectFile::eTypeUnknown:
720     OS << "unknown";
721     break;
722   }
723 }
724 
725 void llvm::format_provider<ObjectFile::Strata>::format(
726     const ObjectFile::Strata &strata, raw_ostream &OS, StringRef Style) {
727   switch (strata) {
728   case ObjectFile::eStrataInvalid:
729     OS << "invalid";
730     break;
731   case ObjectFile::eStrataUnknown:
732     OS << "unknown";
733     break;
734   case ObjectFile::eStrataUser:
735     OS << "user";
736     break;
737   case ObjectFile::eStrataKernel:
738     OS << "kernel";
739     break;
740   case ObjectFile::eStrataRawImage:
741     OS << "raw image";
742     break;
743   case ObjectFile::eStrataJIT:
744     OS << "jit";
745     break;
746   }
747 }
748