xref: /freebsd-src/contrib/llvm-project/lldb/source/Symbol/ObjectFile.cpp (revision 0b57cec536236d46e3dba9bd041533462f33dbb7)
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_up(
60                 create_object_container_callback(module_sp, data_sp,
61                                                  data_offset, file, file_offset,
62                                                  file_size));
63 
64             if (object_container_up)
65               object_file_sp = object_container_up->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_up(
109                   create_object_container_callback(module_sp, data_sp,
110                                                    data_offset, file,
111                                                    file_offset, file_size));
112 
113               if (object_container_up)
114                 object_file_sp = object_container_up->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_up(
151               create_object_container_callback(module_sp, data_sp, data_offset,
152                                                file, file_offset, file_size));
153 
154           if (object_container_up)
155             object_file_sp = object_container_up->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(), m_process_wp(),
267       m_memory_addr(LLDB_INVALID_ADDRESS), m_sections_up(), m_symtab_up(),
268       m_synthetic_symbol_idx(0) {
269   if (file_spec_ptr)
270     m_file = *file_spec_ptr;
271   if (data_sp)
272     m_data.SetData(data_sp, data_offset, length);
273   Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_OBJECT));
274   if (log)
275     log->Printf("%p ObjectFile::ObjectFile() module = %p (%s), file = %s, "
276                 "file_offset = 0x%8.8" PRIx64 ", size = %" PRIu64,
277                 static_cast<void *>(this), static_cast<void *>(module_sp.get()),
278                 module_sp->GetSpecificationDescription().c_str(),
279                 m_file ? m_file.GetPath().c_str() : "<NULL>", m_file_offset,
280                 m_length);
281 }
282 
283 ObjectFile::ObjectFile(const lldb::ModuleSP &module_sp,
284                        const ProcessSP &process_sp, lldb::addr_t header_addr,
285                        DataBufferSP &header_data_sp)
286     : ModuleChild(module_sp), m_file(), m_type(eTypeInvalid),
287       m_strata(eStrataInvalid), m_file_offset(0), m_length(0), m_data(),
288       m_process_wp(process_sp), m_memory_addr(header_addr), m_sections_up(),
289       m_symtab_up(), m_synthetic_symbol_idx(0) {
290   if (header_data_sp)
291     m_data.SetData(header_data_sp, 0, header_data_sp->GetByteSize());
292   Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_OBJECT));
293   if (log)
294     log->Printf("%p ObjectFile::ObjectFile() module = %p (%s), process = %p, "
295                 "header_addr = 0x%" PRIx64,
296                 static_cast<void *>(this), static_cast<void *>(module_sp.get()),
297                 module_sp->GetSpecificationDescription().c_str(),
298                 static_cast<void *>(process_sp.get()), m_memory_addr);
299 }
300 
301 ObjectFile::~ObjectFile() {
302   Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_OBJECT));
303   if (log)
304     log->Printf("%p ObjectFile::~ObjectFile ()\n", static_cast<void *>(this));
305 }
306 
307 bool ObjectFile::SetModulesArchitecture(const ArchSpec &new_arch) {
308   ModuleSP module_sp(GetModule());
309   if (module_sp)
310     return module_sp->SetArchitecture(new_arch);
311   return false;
312 }
313 
314 AddressClass ObjectFile::GetAddressClass(addr_t file_addr) {
315   Symtab *symtab = GetSymtab();
316   if (symtab) {
317     Symbol *symbol = symtab->FindSymbolContainingFileAddress(file_addr);
318     if (symbol) {
319       if (symbol->ValueIsAddress()) {
320         const SectionSP section_sp(symbol->GetAddressRef().GetSection());
321         if (section_sp) {
322           const SectionType section_type = section_sp->GetType();
323           switch (section_type) {
324           case eSectionTypeInvalid:
325             return AddressClass::eUnknown;
326           case eSectionTypeCode:
327             return AddressClass::eCode;
328           case eSectionTypeContainer:
329             return AddressClass::eUnknown;
330           case eSectionTypeData:
331           case eSectionTypeDataCString:
332           case eSectionTypeDataCStringPointers:
333           case eSectionTypeDataSymbolAddress:
334           case eSectionTypeData4:
335           case eSectionTypeData8:
336           case eSectionTypeData16:
337           case eSectionTypeDataPointers:
338           case eSectionTypeZeroFill:
339           case eSectionTypeDataObjCMessageRefs:
340           case eSectionTypeDataObjCCFStrings:
341           case eSectionTypeGoSymtab:
342             return AddressClass::eData;
343           case eSectionTypeDebug:
344           case eSectionTypeDWARFDebugAbbrev:
345           case eSectionTypeDWARFDebugAbbrevDwo:
346           case eSectionTypeDWARFDebugAddr:
347           case eSectionTypeDWARFDebugAranges:
348           case eSectionTypeDWARFDebugCuIndex:
349           case eSectionTypeDWARFDebugFrame:
350           case eSectionTypeDWARFDebugInfo:
351           case eSectionTypeDWARFDebugInfoDwo:
352           case eSectionTypeDWARFDebugLine:
353           case eSectionTypeDWARFDebugLineStr:
354           case eSectionTypeDWARFDebugLoc:
355           case eSectionTypeDWARFDebugLocLists:
356           case eSectionTypeDWARFDebugMacInfo:
357           case eSectionTypeDWARFDebugMacro:
358           case eSectionTypeDWARFDebugNames:
359           case eSectionTypeDWARFDebugPubNames:
360           case eSectionTypeDWARFDebugPubTypes:
361           case eSectionTypeDWARFDebugRanges:
362           case eSectionTypeDWARFDebugRngLists:
363           case eSectionTypeDWARFDebugStr:
364           case eSectionTypeDWARFDebugStrDwo:
365           case eSectionTypeDWARFDebugStrOffsets:
366           case eSectionTypeDWARFDebugStrOffsetsDwo:
367           case eSectionTypeDWARFDebugTypes:
368           case eSectionTypeDWARFDebugTypesDwo:
369           case eSectionTypeDWARFAppleNames:
370           case eSectionTypeDWARFAppleTypes:
371           case eSectionTypeDWARFAppleNamespaces:
372           case eSectionTypeDWARFAppleObjC:
373           case eSectionTypeDWARFGNUDebugAltLink:
374             return AddressClass::eDebug;
375           case eSectionTypeEHFrame:
376           case eSectionTypeARMexidx:
377           case eSectionTypeARMextab:
378           case eSectionTypeCompactUnwind:
379             return AddressClass::eRuntime;
380           case eSectionTypeELFSymbolTable:
381           case eSectionTypeELFDynamicSymbols:
382           case eSectionTypeELFRelocationEntries:
383           case eSectionTypeELFDynamicLinkInfo:
384           case eSectionTypeOther:
385             return AddressClass::eUnknown;
386           case eSectionTypeAbsoluteAddress:
387             // In case of absolute sections decide the address class based on
388             // the symbol type because the section type isn't specify if it is
389             // a code or a data section.
390             break;
391           }
392         }
393       }
394 
395       const SymbolType symbol_type = symbol->GetType();
396       switch (symbol_type) {
397       case eSymbolTypeAny:
398         return AddressClass::eUnknown;
399       case eSymbolTypeAbsolute:
400         return AddressClass::eUnknown;
401       case eSymbolTypeCode:
402         return AddressClass::eCode;
403       case eSymbolTypeTrampoline:
404         return AddressClass::eCode;
405       case eSymbolTypeResolver:
406         return AddressClass::eCode;
407       case eSymbolTypeData:
408         return AddressClass::eData;
409       case eSymbolTypeRuntime:
410         return AddressClass::eRuntime;
411       case eSymbolTypeException:
412         return AddressClass::eRuntime;
413       case eSymbolTypeSourceFile:
414         return AddressClass::eDebug;
415       case eSymbolTypeHeaderFile:
416         return AddressClass::eDebug;
417       case eSymbolTypeObjectFile:
418         return AddressClass::eDebug;
419       case eSymbolTypeCommonBlock:
420         return AddressClass::eDebug;
421       case eSymbolTypeBlock:
422         return AddressClass::eDebug;
423       case eSymbolTypeLocal:
424         return AddressClass::eData;
425       case eSymbolTypeParam:
426         return AddressClass::eData;
427       case eSymbolTypeVariable:
428         return AddressClass::eData;
429       case eSymbolTypeVariableType:
430         return AddressClass::eDebug;
431       case eSymbolTypeLineEntry:
432         return AddressClass::eDebug;
433       case eSymbolTypeLineHeader:
434         return AddressClass::eDebug;
435       case eSymbolTypeScopeBegin:
436         return AddressClass::eDebug;
437       case eSymbolTypeScopeEnd:
438         return AddressClass::eDebug;
439       case eSymbolTypeAdditional:
440         return AddressClass::eUnknown;
441       case eSymbolTypeCompiler:
442         return AddressClass::eDebug;
443       case eSymbolTypeInstrumentation:
444         return AddressClass::eDebug;
445       case eSymbolTypeUndefined:
446         return AddressClass::eUnknown;
447       case eSymbolTypeObjCClass:
448         return AddressClass::eRuntime;
449       case eSymbolTypeObjCMetaClass:
450         return AddressClass::eRuntime;
451       case eSymbolTypeObjCIVar:
452         return AddressClass::eRuntime;
453       case eSymbolTypeReExported:
454         return AddressClass::eRuntime;
455       }
456     }
457   }
458   return AddressClass::eUnknown;
459 }
460 
461 DataBufferSP ObjectFile::ReadMemory(const ProcessSP &process_sp,
462                                     lldb::addr_t addr, size_t byte_size) {
463   DataBufferSP data_sp;
464   if (process_sp) {
465     std::unique_ptr<DataBufferHeap> data_up(new DataBufferHeap(byte_size, 0));
466     Status error;
467     const size_t bytes_read = process_sp->ReadMemory(
468         addr, data_up->GetBytes(), data_up->GetByteSize(), error);
469     if (bytes_read == byte_size)
470       data_sp.reset(data_up.release());
471   }
472   return data_sp;
473 }
474 
475 size_t ObjectFile::GetData(lldb::offset_t offset, size_t length,
476                            DataExtractor &data) const {
477   // The entire file has already been mmap'ed into m_data, so just copy from
478   // there as the back mmap buffer will be shared with shared pointers.
479   return data.SetData(m_data, offset, length);
480 }
481 
482 size_t ObjectFile::CopyData(lldb::offset_t offset, size_t length,
483                             void *dst) const {
484   // The entire file has already been mmap'ed into m_data, so just copy from
485   // there Note that the data remains in target byte order.
486   return m_data.CopyData(offset, length, dst);
487 }
488 
489 size_t ObjectFile::ReadSectionData(Section *section,
490                                    lldb::offset_t section_offset, void *dst,
491                                    size_t dst_len) {
492   assert(section);
493   section_offset *= section->GetTargetByteSize();
494 
495   // If some other objectfile owns this data, pass this to them.
496   if (section->GetObjectFile() != this)
497     return section->GetObjectFile()->ReadSectionData(section, section_offset,
498                                                      dst, dst_len);
499 
500   if (IsInMemory()) {
501     ProcessSP process_sp(m_process_wp.lock());
502     if (process_sp) {
503       Status error;
504       const addr_t base_load_addr =
505           section->GetLoadBaseAddress(&process_sp->GetTarget());
506       if (base_load_addr != LLDB_INVALID_ADDRESS)
507         return process_sp->ReadMemory(base_load_addr + section_offset, dst,
508                                       dst_len, error);
509     }
510   } else {
511     if (!section->IsRelocated())
512       RelocateSection(section);
513 
514     const lldb::offset_t section_file_size = section->GetFileSize();
515     if (section_offset < section_file_size) {
516       const size_t section_bytes_left = section_file_size - section_offset;
517       size_t section_dst_len = dst_len;
518       if (section_dst_len > section_bytes_left)
519         section_dst_len = section_bytes_left;
520       return CopyData(section->GetFileOffset() + section_offset,
521                       section_dst_len, dst);
522     } else {
523       if (section->GetType() == eSectionTypeZeroFill) {
524         const uint64_t section_size = section->GetByteSize();
525         const uint64_t section_bytes_left = section_size - section_offset;
526         uint64_t section_dst_len = dst_len;
527         if (section_dst_len > section_bytes_left)
528           section_dst_len = section_bytes_left;
529         memset(dst, 0, section_dst_len);
530         return section_dst_len;
531       }
532     }
533   }
534   return 0;
535 }
536 
537 // Get the section data the file on disk
538 size_t ObjectFile::ReadSectionData(Section *section,
539                                    DataExtractor &section_data) {
540   // If some other objectfile owns this data, pass this to them.
541   if (section->GetObjectFile() != this)
542     return section->GetObjectFile()->ReadSectionData(section, section_data);
543 
544   if (IsInMemory()) {
545     ProcessSP process_sp(m_process_wp.lock());
546     if (process_sp) {
547       const addr_t base_load_addr =
548           section->GetLoadBaseAddress(&process_sp->GetTarget());
549       if (base_load_addr != LLDB_INVALID_ADDRESS) {
550         DataBufferSP data_sp(
551             ReadMemory(process_sp, base_load_addr, section->GetByteSize()));
552         if (data_sp) {
553           section_data.SetData(data_sp, 0, data_sp->GetByteSize());
554           section_data.SetByteOrder(process_sp->GetByteOrder());
555           section_data.SetAddressByteSize(process_sp->GetAddressByteSize());
556           return section_data.GetByteSize();
557         }
558       }
559     }
560     return GetData(section->GetFileOffset(), section->GetFileSize(),
561                    section_data);
562   } else {
563     // The object file now contains a full mmap'ed copy of the object file
564     // data, so just use this
565     if (!section->IsRelocated())
566       RelocateSection(section);
567 
568     return GetData(section->GetFileOffset(), section->GetFileSize(),
569                    section_data);
570   }
571 }
572 
573 bool ObjectFile::SplitArchivePathWithObject(const char *path_with_object,
574                                             FileSpec &archive_file,
575                                             ConstString &archive_object,
576                                             bool must_exist) {
577   RegularExpression g_object_regex(llvm::StringRef("(.*)\\(([^\\)]+)\\)$"));
578   RegularExpression::Match regex_match(2);
579   if (g_object_regex.Execute(llvm::StringRef::withNullAsEmpty(path_with_object),
580                              &regex_match)) {
581     std::string path;
582     std::string obj;
583     if (regex_match.GetMatchAtIndex(path_with_object, 1, path) &&
584         regex_match.GetMatchAtIndex(path_with_object, 2, obj)) {
585       archive_file.SetFile(path, FileSpec::Style::native);
586       archive_object.SetCString(obj.c_str());
587       return !(must_exist && !FileSystem::Instance().Exists(archive_file));
588     }
589   }
590   return false;
591 }
592 
593 void ObjectFile::ClearSymtab() {
594   ModuleSP module_sp(GetModule());
595   if (module_sp) {
596     std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
597     Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_OBJECT));
598     if (log)
599       log->Printf("%p ObjectFile::ClearSymtab () symtab = %p",
600                   static_cast<void *>(this),
601                   static_cast<void *>(m_symtab_up.get()));
602     m_symtab_up.reset();
603   }
604 }
605 
606 SectionList *ObjectFile::GetSectionList(bool update_module_section_list) {
607   if (m_sections_up == nullptr) {
608     if (update_module_section_list) {
609       ModuleSP module_sp(GetModule());
610       if (module_sp) {
611         std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
612         CreateSections(*module_sp->GetUnifiedSectionList());
613       }
614     } else {
615       SectionList unified_section_list;
616       CreateSections(unified_section_list);
617     }
618   }
619   return m_sections_up.get();
620 }
621 
622 lldb::SymbolType
623 ObjectFile::GetSymbolTypeFromName(llvm::StringRef name,
624                                   lldb::SymbolType symbol_type_hint) {
625   if (!name.empty()) {
626     if (name.startswith("_OBJC_")) {
627       // ObjC
628       if (name.startswith("_OBJC_CLASS_$_"))
629         return lldb::eSymbolTypeObjCClass;
630       if (name.startswith("_OBJC_METACLASS_$_"))
631         return lldb::eSymbolTypeObjCMetaClass;
632       if (name.startswith("_OBJC_IVAR_$_"))
633         return lldb::eSymbolTypeObjCIVar;
634     } else if (name.startswith(".objc_class_name_")) {
635       // ObjC v1
636       return lldb::eSymbolTypeObjCClass;
637     }
638   }
639   return symbol_type_hint;
640 }
641 
642 ConstString ObjectFile::GetNextSyntheticSymbolName() {
643   StreamString ss;
644   ConstString file_name = GetModule()->GetFileSpec().GetFilename();
645   ss.Printf("___lldb_unnamed_symbol%u$$%s", ++m_synthetic_symbol_idx,
646             file_name.GetCString());
647   return ConstString(ss.GetString());
648 }
649 
650 std::vector<ObjectFile::LoadableData>
651 ObjectFile::GetLoadableData(Target &target) {
652   std::vector<LoadableData> loadables;
653   SectionList *section_list = GetSectionList();
654   if (!section_list)
655     return loadables;
656   // Create a list of loadable data from loadable sections
657   size_t section_count = section_list->GetNumSections(0);
658   for (size_t i = 0; i < section_count; ++i) {
659     LoadableData loadable;
660     SectionSP section_sp = section_list->GetSectionAtIndex(i);
661     loadable.Dest =
662         target.GetSectionLoadList().GetSectionLoadAddress(section_sp);
663     if (loadable.Dest == LLDB_INVALID_ADDRESS)
664       continue;
665     // We can skip sections like bss
666     if (section_sp->GetFileSize() == 0)
667       continue;
668     DataExtractor section_data;
669     section_sp->GetSectionData(section_data);
670     loadable.Contents = llvm::ArrayRef<uint8_t>(section_data.GetDataStart(),
671                                                 section_data.GetByteSize());
672     loadables.push_back(loadable);
673   }
674   return loadables;
675 }
676 
677 void ObjectFile::RelocateSection(lldb_private::Section *section)
678 {
679 }
680 
681 DataBufferSP ObjectFile::MapFileData(const FileSpec &file, uint64_t Size,
682                                      uint64_t Offset) {
683   return FileSystem::Instance().CreateDataBuffer(file.GetPath(), Size, Offset);
684 }
685 
686 void llvm::format_provider<ObjectFile::Type>::format(
687     const ObjectFile::Type &type, raw_ostream &OS, StringRef Style) {
688   switch (type) {
689   case ObjectFile::eTypeInvalid:
690     OS << "invalid";
691     break;
692   case ObjectFile::eTypeCoreFile:
693     OS << "core file";
694     break;
695   case ObjectFile::eTypeExecutable:
696     OS << "executable";
697     break;
698   case ObjectFile::eTypeDebugInfo:
699     OS << "debug info";
700     break;
701   case ObjectFile::eTypeDynamicLinker:
702     OS << "dynamic linker";
703     break;
704   case ObjectFile::eTypeObjectFile:
705     OS << "object file";
706     break;
707   case ObjectFile::eTypeSharedLibrary:
708     OS << "shared library";
709     break;
710   case ObjectFile::eTypeStubLibrary:
711     OS << "stub library";
712     break;
713   case ObjectFile::eTypeJIT:
714     OS << "jit";
715     break;
716   case ObjectFile::eTypeUnknown:
717     OS << "unknown";
718     break;
719   }
720 }
721 
722 void llvm::format_provider<ObjectFile::Strata>::format(
723     const ObjectFile::Strata &strata, raw_ostream &OS, StringRef Style) {
724   switch (strata) {
725   case ObjectFile::eStrataInvalid:
726     OS << "invalid";
727     break;
728   case ObjectFile::eStrataUnknown:
729     OS << "unknown";
730     break;
731   case ObjectFile::eStrataUser:
732     OS << "user";
733     break;
734   case ObjectFile::eStrataKernel:
735     OS << "kernel";
736     break;
737   case ObjectFile::eStrataRawImage:
738     OS << "raw image";
739     break;
740   case ObjectFile::eStrataJIT:
741     OS << "jit";
742     break;
743   }
744 }
745