1dda28197Spatrick //===-- ObjectFile.cpp ----------------------------------------------------===//
2061da546Spatrick //
3061da546Spatrick // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4061da546Spatrick // See https://llvm.org/LICENSE.txt for license information.
5061da546Spatrick // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6061da546Spatrick //
7061da546Spatrick //===----------------------------------------------------------------------===//
8061da546Spatrick
9061da546Spatrick #include "lldb/Symbol/ObjectFile.h"
10061da546Spatrick #include "lldb/Core/Module.h"
11061da546Spatrick #include "lldb/Core/ModuleSpec.h"
12061da546Spatrick #include "lldb/Core/PluginManager.h"
13061da546Spatrick #include "lldb/Core/Section.h"
14061da546Spatrick #include "lldb/Symbol/CallFrameInfo.h"
15061da546Spatrick #include "lldb/Symbol/ObjectContainer.h"
16061da546Spatrick #include "lldb/Symbol/SymbolFile.h"
17061da546Spatrick #include "lldb/Target/Process.h"
18061da546Spatrick #include "lldb/Target/SectionLoadList.h"
19061da546Spatrick #include "lldb/Target/Target.h"
20061da546Spatrick #include "lldb/Utility/DataBuffer.h"
21061da546Spatrick #include "lldb/Utility/DataBufferHeap.h"
22*f6aab3d8Srobert #include "lldb/Utility/LLDBLog.h"
23061da546Spatrick #include "lldb/Utility/Log.h"
24061da546Spatrick #include "lldb/Utility/Timer.h"
25061da546Spatrick #include "lldb/lldb-private.h"
26061da546Spatrick
27*f6aab3d8Srobert #include "llvm/Support/DJB.h"
28*f6aab3d8Srobert
29061da546Spatrick using namespace lldb;
30061da546Spatrick using namespace lldb_private;
31061da546Spatrick
32061da546Spatrick char ObjectFile::ID;
33*f6aab3d8Srobert size_t ObjectFile::g_initial_bytes_to_read = 512;
34061da546Spatrick
35be691f3bSpatrick static ObjectFileSP
CreateObjectFromContainer(const lldb::ModuleSP & module_sp,const FileSpec * file,lldb::offset_t file_offset,lldb::offset_t file_size,DataBufferSP data_sp,lldb::offset_t & data_offset)36be691f3bSpatrick CreateObjectFromContainer(const lldb::ModuleSP &module_sp, const FileSpec *file,
37be691f3bSpatrick lldb::offset_t file_offset, lldb::offset_t file_size,
38*f6aab3d8Srobert DataBufferSP data_sp, lldb::offset_t &data_offset) {
39be691f3bSpatrick ObjectContainerCreateInstance callback;
40be691f3bSpatrick for (uint32_t idx = 0;
41be691f3bSpatrick (callback = PluginManager::GetObjectContainerCreateCallbackAtIndex(
42be691f3bSpatrick idx)) != nullptr;
43be691f3bSpatrick ++idx) {
44be691f3bSpatrick std::unique_ptr<ObjectContainer> object_container_up(callback(
45be691f3bSpatrick module_sp, data_sp, data_offset, file, file_offset, file_size));
46be691f3bSpatrick if (object_container_up)
47be691f3bSpatrick return object_container_up->GetObjectFile(file);
48be691f3bSpatrick }
49be691f3bSpatrick return {};
50be691f3bSpatrick }
51be691f3bSpatrick
52061da546Spatrick ObjectFileSP
FindPlugin(const lldb::ModuleSP & module_sp,const FileSpec * file,lldb::offset_t file_offset,lldb::offset_t file_size,DataBufferSP & data_sp,lldb::offset_t & data_offset)53061da546Spatrick ObjectFile::FindPlugin(const lldb::ModuleSP &module_sp, const FileSpec *file,
54061da546Spatrick lldb::offset_t file_offset, lldb::offset_t file_size,
55061da546Spatrick DataBufferSP &data_sp, lldb::offset_t &data_offset) {
56be691f3bSpatrick LLDB_SCOPED_TIMERF(
57061da546Spatrick "ObjectFile::FindPlugin (module = %s, file = %p, file_offset = "
58061da546Spatrick "0x%8.8" PRIx64 ", file_size = 0x%8.8" PRIx64 ")",
59061da546Spatrick module_sp->GetFileSpec().GetPath().c_str(),
60061da546Spatrick static_cast<const void *>(file), static_cast<uint64_t>(file_offset),
61061da546Spatrick static_cast<uint64_t>(file_size));
62be691f3bSpatrick
63be691f3bSpatrick if (!module_sp)
64be691f3bSpatrick return {};
65be691f3bSpatrick
66be691f3bSpatrick if (!file)
67be691f3bSpatrick return {};
68061da546Spatrick
69061da546Spatrick if (!data_sp) {
70dda28197Spatrick const bool file_exists = FileSystem::Instance().Exists(*file);
71061da546Spatrick // We have an object name which most likely means we have a .o file in
72061da546Spatrick // a static archive (.a file). Try and see if we have a cached archive
73061da546Spatrick // first without reading any data first
74061da546Spatrick if (file_exists && module_sp->GetObjectName()) {
75be691f3bSpatrick ObjectFileSP object_file_sp = CreateObjectFromContainer(
76be691f3bSpatrick module_sp, file, file_offset, file_size, data_sp, data_offset);
77be691f3bSpatrick if (object_file_sp)
78061da546Spatrick return object_file_sp;
79061da546Spatrick }
80061da546Spatrick // Ok, we didn't find any containers that have a named object, now lets
81061da546Spatrick // read the first 512 bytes from the file so the object file and object
82061da546Spatrick // container plug-ins can use these bytes to see if they can parse this
83061da546Spatrick // file.
84061da546Spatrick if (file_size > 0) {
85*f6aab3d8Srobert data_sp = FileSystem::Instance().CreateDataBuffer(
86*f6aab3d8Srobert file->GetPath(), g_initial_bytes_to_read, file_offset);
87061da546Spatrick data_offset = 0;
88061da546Spatrick }
89061da546Spatrick }
90061da546Spatrick
91061da546Spatrick if (!data_sp || data_sp->GetByteSize() == 0) {
92061da546Spatrick // Check for archive file with format "/path/to/archive.a(object.o)"
93061da546Spatrick llvm::SmallString<256> path_with_object;
94061da546Spatrick module_sp->GetFileSpec().GetPath(path_with_object);
95061da546Spatrick
96be691f3bSpatrick FileSpec archive_file;
97061da546Spatrick ConstString archive_object;
98061da546Spatrick const bool must_exist = true;
99be691f3bSpatrick if (ObjectFile::SplitArchivePathWithObject(path_with_object, archive_file,
100be691f3bSpatrick archive_object, must_exist)) {
101061da546Spatrick file_size = FileSystem::Instance().GetByteSize(archive_file);
102061da546Spatrick if (file_size > 0) {
103061da546Spatrick file = &archive_file;
104061da546Spatrick module_sp->SetFileSpecAndObjectName(archive_file, archive_object);
105061da546Spatrick // Check if this is a object container by iterating through all
106061da546Spatrick // object container plugin instances and then trying to get an
107061da546Spatrick // object file from the container plugins since we had a name.
108061da546Spatrick // Also, don't read
109061da546Spatrick // ANY data in case there is data cached in the container plug-ins
110061da546Spatrick // (like BSD archives caching the contained objects within an
111061da546Spatrick // file).
112be691f3bSpatrick ObjectFileSP object_file_sp = CreateObjectFromContainer(
113be691f3bSpatrick module_sp, file, file_offset, file_size, data_sp, data_offset);
114be691f3bSpatrick if (object_file_sp)
115061da546Spatrick return object_file_sp;
116061da546Spatrick // We failed to find any cached object files in the container plug-
117061da546Spatrick // ins, so lets read the first 512 bytes and try again below...
118061da546Spatrick data_sp = FileSystem::Instance().CreateDataBuffer(
119*f6aab3d8Srobert archive_file.GetPath(), g_initial_bytes_to_read, file_offset);
120061da546Spatrick }
121061da546Spatrick }
122061da546Spatrick }
123061da546Spatrick
124061da546Spatrick if (data_sp && data_sp->GetByteSize() > 0) {
125061da546Spatrick // Check if this is a normal object file by iterating through all
126061da546Spatrick // object file plugin instances.
127be691f3bSpatrick ObjectFileCreateInstance callback;
128061da546Spatrick for (uint32_t idx = 0;
129be691f3bSpatrick (callback = PluginManager::GetObjectFileCreateCallbackAtIndex(idx)) !=
130061da546Spatrick nullptr;
131061da546Spatrick ++idx) {
132be691f3bSpatrick ObjectFileSP object_file_sp(callback(module_sp, data_sp, data_offset,
133be691f3bSpatrick file, file_offset, file_size));
134061da546Spatrick if (object_file_sp.get())
135061da546Spatrick return object_file_sp;
136061da546Spatrick }
137061da546Spatrick
138061da546Spatrick // Check if this is a object container by iterating through all object
139061da546Spatrick // container plugin instances and then trying to get an object file
140061da546Spatrick // from the container.
141be691f3bSpatrick ObjectFileSP object_file_sp = CreateObjectFromContainer(
142be691f3bSpatrick module_sp, file, file_offset, file_size, data_sp, data_offset);
143be691f3bSpatrick if (object_file_sp)
144061da546Spatrick return object_file_sp;
145061da546Spatrick }
146be691f3bSpatrick
147061da546Spatrick // We didn't find it, so clear our shared pointer in case it contains
148061da546Spatrick // anything and return an empty shared pointer
149be691f3bSpatrick return {};
150061da546Spatrick }
151061da546Spatrick
FindPlugin(const lldb::ModuleSP & module_sp,const ProcessSP & process_sp,lldb::addr_t header_addr,WritableDataBufferSP data_sp)152061da546Spatrick ObjectFileSP ObjectFile::FindPlugin(const lldb::ModuleSP &module_sp,
153061da546Spatrick const ProcessSP &process_sp,
154061da546Spatrick lldb::addr_t header_addr,
155*f6aab3d8Srobert WritableDataBufferSP data_sp) {
156061da546Spatrick ObjectFileSP object_file_sp;
157061da546Spatrick
158061da546Spatrick if (module_sp) {
159be691f3bSpatrick LLDB_SCOPED_TIMERF("ObjectFile::FindPlugin (module = "
160061da546Spatrick "%s, process = %p, header_addr = "
161061da546Spatrick "0x%" PRIx64 ")",
162061da546Spatrick module_sp->GetFileSpec().GetPath().c_str(),
163061da546Spatrick static_cast<void *>(process_sp.get()), header_addr);
164061da546Spatrick uint32_t idx;
165061da546Spatrick
166061da546Spatrick // Check if this is a normal object file by iterating through all object
167061da546Spatrick // file plugin instances.
168061da546Spatrick ObjectFileCreateMemoryInstance create_callback;
169061da546Spatrick for (idx = 0;
170061da546Spatrick (create_callback =
171061da546Spatrick PluginManager::GetObjectFileCreateMemoryCallbackAtIndex(idx)) !=
172061da546Spatrick nullptr;
173061da546Spatrick ++idx) {
174061da546Spatrick object_file_sp.reset(
175061da546Spatrick create_callback(module_sp, data_sp, process_sp, header_addr));
176061da546Spatrick if (object_file_sp.get())
177061da546Spatrick return object_file_sp;
178061da546Spatrick }
179061da546Spatrick }
180061da546Spatrick
181061da546Spatrick // We didn't find it, so clear our shared pointer in case it contains
182061da546Spatrick // anything and return an empty shared pointer
183061da546Spatrick object_file_sp.reset();
184061da546Spatrick return object_file_sp;
185061da546Spatrick }
186061da546Spatrick
GetModuleSpecifications(const FileSpec & file,lldb::offset_t file_offset,lldb::offset_t file_size,ModuleSpecList & specs,DataBufferSP data_sp)187061da546Spatrick size_t ObjectFile::GetModuleSpecifications(const FileSpec &file,
188061da546Spatrick lldb::offset_t file_offset,
189061da546Spatrick lldb::offset_t file_size,
190dda28197Spatrick ModuleSpecList &specs,
191dda28197Spatrick DataBufferSP data_sp) {
192dda28197Spatrick if (!data_sp)
193*f6aab3d8Srobert data_sp = FileSystem::Instance().CreateDataBuffer(
194*f6aab3d8Srobert file.GetPath(), g_initial_bytes_to_read, file_offset);
195061da546Spatrick if (data_sp) {
196061da546Spatrick if (file_size == 0) {
197061da546Spatrick const lldb::offset_t actual_file_size =
198061da546Spatrick FileSystem::Instance().GetByteSize(file);
199061da546Spatrick if (actual_file_size > file_offset)
200061da546Spatrick file_size = actual_file_size - file_offset;
201061da546Spatrick }
202061da546Spatrick return ObjectFile::GetModuleSpecifications(file, // file spec
203061da546Spatrick data_sp, // data bytes
204061da546Spatrick 0, // data offset
205061da546Spatrick file_offset, // file offset
206061da546Spatrick file_size, // file length
207061da546Spatrick specs);
208061da546Spatrick }
209061da546Spatrick return 0;
210061da546Spatrick }
211061da546Spatrick
GetModuleSpecifications(const lldb_private::FileSpec & file,lldb::DataBufferSP & data_sp,lldb::offset_t data_offset,lldb::offset_t file_offset,lldb::offset_t file_size,lldb_private::ModuleSpecList & specs)212061da546Spatrick size_t ObjectFile::GetModuleSpecifications(
213061da546Spatrick const lldb_private::FileSpec &file, lldb::DataBufferSP &data_sp,
214061da546Spatrick lldb::offset_t data_offset, lldb::offset_t file_offset,
215061da546Spatrick lldb::offset_t file_size, lldb_private::ModuleSpecList &specs) {
216061da546Spatrick const size_t initial_count = specs.GetSize();
217061da546Spatrick ObjectFileGetModuleSpecifications callback;
218061da546Spatrick uint32_t i;
219061da546Spatrick // Try the ObjectFile plug-ins
220061da546Spatrick for (i = 0;
221061da546Spatrick (callback =
222061da546Spatrick PluginManager::GetObjectFileGetModuleSpecificationsCallbackAtIndex(
223061da546Spatrick i)) != nullptr;
224061da546Spatrick ++i) {
225061da546Spatrick if (callback(file, data_sp, data_offset, file_offset, file_size, specs) > 0)
226061da546Spatrick return specs.GetSize() - initial_count;
227061da546Spatrick }
228061da546Spatrick
229061da546Spatrick // Try the ObjectContainer plug-ins
230061da546Spatrick for (i = 0;
231061da546Spatrick (callback = PluginManager::
232061da546Spatrick GetObjectContainerGetModuleSpecificationsCallbackAtIndex(i)) !=
233061da546Spatrick nullptr;
234061da546Spatrick ++i) {
235061da546Spatrick if (callback(file, data_sp, data_offset, file_offset, file_size, specs) > 0)
236061da546Spatrick return specs.GetSize() - initial_count;
237061da546Spatrick }
238061da546Spatrick return 0;
239061da546Spatrick }
240061da546Spatrick
ObjectFile(const lldb::ModuleSP & module_sp,const FileSpec * file_spec_ptr,lldb::offset_t file_offset,lldb::offset_t length,lldb::DataBufferSP data_sp,lldb::offset_t data_offset)241061da546Spatrick ObjectFile::ObjectFile(const lldb::ModuleSP &module_sp,
242061da546Spatrick const FileSpec *file_spec_ptr,
243061da546Spatrick lldb::offset_t file_offset, lldb::offset_t length,
244*f6aab3d8Srobert lldb::DataBufferSP data_sp, lldb::offset_t data_offset)
245061da546Spatrick : ModuleChild(module_sp),
246061da546Spatrick m_file(), // This file could be different from the original module's file
247061da546Spatrick m_type(eTypeInvalid), m_strata(eStrataInvalid),
248061da546Spatrick m_file_offset(file_offset), m_length(length), m_data(), m_process_wp(),
249061da546Spatrick m_memory_addr(LLDB_INVALID_ADDRESS), m_sections_up(), m_symtab_up(),
250*f6aab3d8Srobert m_symtab_once_up(new llvm::once_flag()) {
251061da546Spatrick if (file_spec_ptr)
252061da546Spatrick m_file = *file_spec_ptr;
253061da546Spatrick if (data_sp)
254061da546Spatrick m_data.SetData(data_sp, data_offset, length);
255*f6aab3d8Srobert Log *log = GetLog(LLDBLog::Object);
256061da546Spatrick LLDB_LOGF(log,
257061da546Spatrick "%p ObjectFile::ObjectFile() module = %p (%s), file = %s, "
258061da546Spatrick "file_offset = 0x%8.8" PRIx64 ", size = %" PRIu64,
259061da546Spatrick static_cast<void *>(this), static_cast<void *>(module_sp.get()),
260061da546Spatrick module_sp->GetSpecificationDescription().c_str(),
261061da546Spatrick m_file ? m_file.GetPath().c_str() : "<NULL>", m_file_offset,
262061da546Spatrick m_length);
263061da546Spatrick }
264061da546Spatrick
ObjectFile(const lldb::ModuleSP & module_sp,const ProcessSP & process_sp,lldb::addr_t header_addr,DataBufferSP header_data_sp)265061da546Spatrick ObjectFile::ObjectFile(const lldb::ModuleSP &module_sp,
266061da546Spatrick const ProcessSP &process_sp, lldb::addr_t header_addr,
267*f6aab3d8Srobert DataBufferSP header_data_sp)
268061da546Spatrick : ModuleChild(module_sp), m_file(), m_type(eTypeInvalid),
269061da546Spatrick m_strata(eStrataInvalid), m_file_offset(0), m_length(0), m_data(),
270061da546Spatrick m_process_wp(process_sp), m_memory_addr(header_addr), m_sections_up(),
271*f6aab3d8Srobert m_symtab_up(), m_symtab_once_up(new llvm::once_flag()) {
272061da546Spatrick if (header_data_sp)
273061da546Spatrick m_data.SetData(header_data_sp, 0, header_data_sp->GetByteSize());
274*f6aab3d8Srobert Log *log = GetLog(LLDBLog::Object);
275061da546Spatrick LLDB_LOGF(log,
276061da546Spatrick "%p ObjectFile::ObjectFile() module = %p (%s), process = %p, "
277061da546Spatrick "header_addr = 0x%" PRIx64,
278061da546Spatrick static_cast<void *>(this), static_cast<void *>(module_sp.get()),
279061da546Spatrick module_sp->GetSpecificationDescription().c_str(),
280061da546Spatrick static_cast<void *>(process_sp.get()), m_memory_addr);
281061da546Spatrick }
282061da546Spatrick
~ObjectFile()283061da546Spatrick ObjectFile::~ObjectFile() {
284*f6aab3d8Srobert Log *log = GetLog(LLDBLog::Object);
285061da546Spatrick LLDB_LOGF(log, "%p ObjectFile::~ObjectFile ()\n", static_cast<void *>(this));
286061da546Spatrick }
287061da546Spatrick
SetModulesArchitecture(const ArchSpec & new_arch)288061da546Spatrick bool ObjectFile::SetModulesArchitecture(const ArchSpec &new_arch) {
289061da546Spatrick ModuleSP module_sp(GetModule());
290061da546Spatrick if (module_sp)
291061da546Spatrick return module_sp->SetArchitecture(new_arch);
292061da546Spatrick return false;
293061da546Spatrick }
294061da546Spatrick
GetAddressClass(addr_t file_addr)295061da546Spatrick AddressClass ObjectFile::GetAddressClass(addr_t file_addr) {
296061da546Spatrick Symtab *symtab = GetSymtab();
297061da546Spatrick if (symtab) {
298061da546Spatrick Symbol *symbol = symtab->FindSymbolContainingFileAddress(file_addr);
299061da546Spatrick if (symbol) {
300061da546Spatrick if (symbol->ValueIsAddress()) {
301061da546Spatrick const SectionSP section_sp(symbol->GetAddressRef().GetSection());
302061da546Spatrick if (section_sp) {
303061da546Spatrick const SectionType section_type = section_sp->GetType();
304061da546Spatrick switch (section_type) {
305061da546Spatrick case eSectionTypeInvalid:
306061da546Spatrick return AddressClass::eUnknown;
307061da546Spatrick case eSectionTypeCode:
308061da546Spatrick return AddressClass::eCode;
309061da546Spatrick case eSectionTypeContainer:
310061da546Spatrick return AddressClass::eUnknown;
311061da546Spatrick case eSectionTypeData:
312061da546Spatrick case eSectionTypeDataCString:
313061da546Spatrick case eSectionTypeDataCStringPointers:
314061da546Spatrick case eSectionTypeDataSymbolAddress:
315061da546Spatrick case eSectionTypeData4:
316061da546Spatrick case eSectionTypeData8:
317061da546Spatrick case eSectionTypeData16:
318061da546Spatrick case eSectionTypeDataPointers:
319061da546Spatrick case eSectionTypeZeroFill:
320061da546Spatrick case eSectionTypeDataObjCMessageRefs:
321061da546Spatrick case eSectionTypeDataObjCCFStrings:
322061da546Spatrick case eSectionTypeGoSymtab:
323061da546Spatrick return AddressClass::eData;
324061da546Spatrick case eSectionTypeDebug:
325061da546Spatrick case eSectionTypeDWARFDebugAbbrev:
326061da546Spatrick case eSectionTypeDWARFDebugAbbrevDwo:
327061da546Spatrick case eSectionTypeDWARFDebugAddr:
328061da546Spatrick case eSectionTypeDWARFDebugAranges:
329061da546Spatrick case eSectionTypeDWARFDebugCuIndex:
330061da546Spatrick case eSectionTypeDWARFDebugFrame:
331061da546Spatrick case eSectionTypeDWARFDebugInfo:
332061da546Spatrick case eSectionTypeDWARFDebugInfoDwo:
333061da546Spatrick case eSectionTypeDWARFDebugLine:
334061da546Spatrick case eSectionTypeDWARFDebugLineStr:
335061da546Spatrick case eSectionTypeDWARFDebugLoc:
336061da546Spatrick case eSectionTypeDWARFDebugLocDwo:
337061da546Spatrick case eSectionTypeDWARFDebugLocLists:
338061da546Spatrick case eSectionTypeDWARFDebugLocListsDwo:
339061da546Spatrick case eSectionTypeDWARFDebugMacInfo:
340061da546Spatrick case eSectionTypeDWARFDebugMacro:
341061da546Spatrick case eSectionTypeDWARFDebugNames:
342061da546Spatrick case eSectionTypeDWARFDebugPubNames:
343061da546Spatrick case eSectionTypeDWARFDebugPubTypes:
344061da546Spatrick case eSectionTypeDWARFDebugRanges:
345061da546Spatrick case eSectionTypeDWARFDebugRngLists:
346061da546Spatrick case eSectionTypeDWARFDebugRngListsDwo:
347061da546Spatrick case eSectionTypeDWARFDebugStr:
348061da546Spatrick case eSectionTypeDWARFDebugStrDwo:
349061da546Spatrick case eSectionTypeDWARFDebugStrOffsets:
350061da546Spatrick case eSectionTypeDWARFDebugStrOffsetsDwo:
351dda28197Spatrick case eSectionTypeDWARFDebugTuIndex:
352061da546Spatrick case eSectionTypeDWARFDebugTypes:
353061da546Spatrick case eSectionTypeDWARFDebugTypesDwo:
354061da546Spatrick case eSectionTypeDWARFAppleNames:
355061da546Spatrick case eSectionTypeDWARFAppleTypes:
356061da546Spatrick case eSectionTypeDWARFAppleNamespaces:
357061da546Spatrick case eSectionTypeDWARFAppleObjC:
358061da546Spatrick case eSectionTypeDWARFGNUDebugAltLink:
359061da546Spatrick return AddressClass::eDebug;
360061da546Spatrick case eSectionTypeEHFrame:
361061da546Spatrick case eSectionTypeARMexidx:
362061da546Spatrick case eSectionTypeARMextab:
363061da546Spatrick case eSectionTypeCompactUnwind:
364061da546Spatrick return AddressClass::eRuntime;
365061da546Spatrick case eSectionTypeELFSymbolTable:
366061da546Spatrick case eSectionTypeELFDynamicSymbols:
367061da546Spatrick case eSectionTypeELFRelocationEntries:
368061da546Spatrick case eSectionTypeELFDynamicLinkInfo:
369061da546Spatrick case eSectionTypeOther:
370061da546Spatrick return AddressClass::eUnknown;
371061da546Spatrick case eSectionTypeAbsoluteAddress:
372061da546Spatrick // In case of absolute sections decide the address class based on
373061da546Spatrick // the symbol type because the section type isn't specify if it is
374061da546Spatrick // a code or a data section.
375061da546Spatrick break;
376061da546Spatrick }
377061da546Spatrick }
378061da546Spatrick }
379061da546Spatrick
380061da546Spatrick const SymbolType symbol_type = symbol->GetType();
381061da546Spatrick switch (symbol_type) {
382061da546Spatrick case eSymbolTypeAny:
383061da546Spatrick return AddressClass::eUnknown;
384061da546Spatrick case eSymbolTypeAbsolute:
385061da546Spatrick return AddressClass::eUnknown;
386061da546Spatrick case eSymbolTypeCode:
387061da546Spatrick return AddressClass::eCode;
388061da546Spatrick case eSymbolTypeTrampoline:
389061da546Spatrick return AddressClass::eCode;
390061da546Spatrick case eSymbolTypeResolver:
391061da546Spatrick return AddressClass::eCode;
392061da546Spatrick case eSymbolTypeData:
393061da546Spatrick return AddressClass::eData;
394061da546Spatrick case eSymbolTypeRuntime:
395061da546Spatrick return AddressClass::eRuntime;
396061da546Spatrick case eSymbolTypeException:
397061da546Spatrick return AddressClass::eRuntime;
398061da546Spatrick case eSymbolTypeSourceFile:
399061da546Spatrick return AddressClass::eDebug;
400061da546Spatrick case eSymbolTypeHeaderFile:
401061da546Spatrick return AddressClass::eDebug;
402061da546Spatrick case eSymbolTypeObjectFile:
403061da546Spatrick return AddressClass::eDebug;
404061da546Spatrick case eSymbolTypeCommonBlock:
405061da546Spatrick return AddressClass::eDebug;
406061da546Spatrick case eSymbolTypeBlock:
407061da546Spatrick return AddressClass::eDebug;
408061da546Spatrick case eSymbolTypeLocal:
409061da546Spatrick return AddressClass::eData;
410061da546Spatrick case eSymbolTypeParam:
411061da546Spatrick return AddressClass::eData;
412061da546Spatrick case eSymbolTypeVariable:
413061da546Spatrick return AddressClass::eData;
414061da546Spatrick case eSymbolTypeVariableType:
415061da546Spatrick return AddressClass::eDebug;
416061da546Spatrick case eSymbolTypeLineEntry:
417061da546Spatrick return AddressClass::eDebug;
418061da546Spatrick case eSymbolTypeLineHeader:
419061da546Spatrick return AddressClass::eDebug;
420061da546Spatrick case eSymbolTypeScopeBegin:
421061da546Spatrick return AddressClass::eDebug;
422061da546Spatrick case eSymbolTypeScopeEnd:
423061da546Spatrick return AddressClass::eDebug;
424061da546Spatrick case eSymbolTypeAdditional:
425061da546Spatrick return AddressClass::eUnknown;
426061da546Spatrick case eSymbolTypeCompiler:
427061da546Spatrick return AddressClass::eDebug;
428061da546Spatrick case eSymbolTypeInstrumentation:
429061da546Spatrick return AddressClass::eDebug;
430061da546Spatrick case eSymbolTypeUndefined:
431061da546Spatrick return AddressClass::eUnknown;
432061da546Spatrick case eSymbolTypeObjCClass:
433061da546Spatrick return AddressClass::eRuntime;
434061da546Spatrick case eSymbolTypeObjCMetaClass:
435061da546Spatrick return AddressClass::eRuntime;
436061da546Spatrick case eSymbolTypeObjCIVar:
437061da546Spatrick return AddressClass::eRuntime;
438061da546Spatrick case eSymbolTypeReExported:
439061da546Spatrick return AddressClass::eRuntime;
440061da546Spatrick }
441061da546Spatrick }
442061da546Spatrick }
443061da546Spatrick return AddressClass::eUnknown;
444061da546Spatrick }
445061da546Spatrick
ReadMemory(const ProcessSP & process_sp,lldb::addr_t addr,size_t byte_size)446061da546Spatrick DataBufferSP ObjectFile::ReadMemory(const ProcessSP &process_sp,
447061da546Spatrick lldb::addr_t addr, size_t byte_size) {
448061da546Spatrick DataBufferSP data_sp;
449061da546Spatrick if (process_sp) {
450061da546Spatrick std::unique_ptr<DataBufferHeap> data_up(new DataBufferHeap(byte_size, 0));
451061da546Spatrick Status error;
452061da546Spatrick const size_t bytes_read = process_sp->ReadMemory(
453061da546Spatrick addr, data_up->GetBytes(), data_up->GetByteSize(), error);
454061da546Spatrick if (bytes_read == byte_size)
455061da546Spatrick data_sp.reset(data_up.release());
456061da546Spatrick }
457061da546Spatrick return data_sp;
458061da546Spatrick }
459061da546Spatrick
GetData(lldb::offset_t offset,size_t length,DataExtractor & data) const460061da546Spatrick size_t ObjectFile::GetData(lldb::offset_t offset, size_t length,
461061da546Spatrick DataExtractor &data) const {
462061da546Spatrick // The entire file has already been mmap'ed into m_data, so just copy from
463061da546Spatrick // there as the back mmap buffer will be shared with shared pointers.
464061da546Spatrick return data.SetData(m_data, offset, length);
465061da546Spatrick }
466061da546Spatrick
CopyData(lldb::offset_t offset,size_t length,void * dst) const467061da546Spatrick size_t ObjectFile::CopyData(lldb::offset_t offset, size_t length,
468061da546Spatrick void *dst) const {
469061da546Spatrick // The entire file has already been mmap'ed into m_data, so just copy from
470061da546Spatrick // there Note that the data remains in target byte order.
471061da546Spatrick return m_data.CopyData(offset, length, dst);
472061da546Spatrick }
473061da546Spatrick
ReadSectionData(Section * section,lldb::offset_t section_offset,void * dst,size_t dst_len)474061da546Spatrick size_t ObjectFile::ReadSectionData(Section *section,
475061da546Spatrick lldb::offset_t section_offset, void *dst,
476061da546Spatrick size_t dst_len) {
477061da546Spatrick assert(section);
478061da546Spatrick section_offset *= section->GetTargetByteSize();
479061da546Spatrick
480061da546Spatrick // If some other objectfile owns this data, pass this to them.
481061da546Spatrick if (section->GetObjectFile() != this)
482061da546Spatrick return section->GetObjectFile()->ReadSectionData(section, section_offset,
483061da546Spatrick dst, dst_len);
484061da546Spatrick
485be691f3bSpatrick if (!section->IsRelocated())
486be691f3bSpatrick RelocateSection(section);
487be691f3bSpatrick
488061da546Spatrick if (IsInMemory()) {
489061da546Spatrick ProcessSP process_sp(m_process_wp.lock());
490061da546Spatrick if (process_sp) {
491061da546Spatrick Status error;
492061da546Spatrick const addr_t base_load_addr =
493061da546Spatrick section->GetLoadBaseAddress(&process_sp->GetTarget());
494061da546Spatrick if (base_load_addr != LLDB_INVALID_ADDRESS)
495061da546Spatrick return process_sp->ReadMemory(base_load_addr + section_offset, dst,
496061da546Spatrick dst_len, error);
497061da546Spatrick }
498061da546Spatrick } else {
499061da546Spatrick const lldb::offset_t section_file_size = section->GetFileSize();
500061da546Spatrick if (section_offset < section_file_size) {
501061da546Spatrick const size_t section_bytes_left = section_file_size - section_offset;
502061da546Spatrick size_t section_dst_len = dst_len;
503061da546Spatrick if (section_dst_len > section_bytes_left)
504061da546Spatrick section_dst_len = section_bytes_left;
505061da546Spatrick return CopyData(section->GetFileOffset() + section_offset,
506061da546Spatrick section_dst_len, dst);
507061da546Spatrick } else {
508061da546Spatrick if (section->GetType() == eSectionTypeZeroFill) {
509061da546Spatrick const uint64_t section_size = section->GetByteSize();
510061da546Spatrick const uint64_t section_bytes_left = section_size - section_offset;
511061da546Spatrick uint64_t section_dst_len = dst_len;
512061da546Spatrick if (section_dst_len > section_bytes_left)
513061da546Spatrick section_dst_len = section_bytes_left;
514061da546Spatrick memset(dst, 0, section_dst_len);
515061da546Spatrick return section_dst_len;
516061da546Spatrick }
517061da546Spatrick }
518061da546Spatrick }
519061da546Spatrick return 0;
520061da546Spatrick }
521061da546Spatrick
522061da546Spatrick // Get the section data the file on disk
ReadSectionData(Section * section,DataExtractor & section_data)523061da546Spatrick size_t ObjectFile::ReadSectionData(Section *section,
524061da546Spatrick DataExtractor §ion_data) {
525061da546Spatrick // If some other objectfile owns this data, pass this to them.
526061da546Spatrick if (section->GetObjectFile() != this)
527061da546Spatrick return section->GetObjectFile()->ReadSectionData(section, section_data);
528061da546Spatrick
529be691f3bSpatrick if (!section->IsRelocated())
530be691f3bSpatrick RelocateSection(section);
531be691f3bSpatrick
532061da546Spatrick if (IsInMemory()) {
533061da546Spatrick ProcessSP process_sp(m_process_wp.lock());
534061da546Spatrick if (process_sp) {
535061da546Spatrick const addr_t base_load_addr =
536061da546Spatrick section->GetLoadBaseAddress(&process_sp->GetTarget());
537061da546Spatrick if (base_load_addr != LLDB_INVALID_ADDRESS) {
538061da546Spatrick DataBufferSP data_sp(
539061da546Spatrick ReadMemory(process_sp, base_load_addr, section->GetByteSize()));
540061da546Spatrick if (data_sp) {
541061da546Spatrick section_data.SetData(data_sp, 0, data_sp->GetByteSize());
542061da546Spatrick section_data.SetByteOrder(process_sp->GetByteOrder());
543061da546Spatrick section_data.SetAddressByteSize(process_sp->GetAddressByteSize());
544061da546Spatrick return section_data.GetByteSize();
545061da546Spatrick }
546061da546Spatrick }
547061da546Spatrick }
548be691f3bSpatrick }
549be691f3bSpatrick
550061da546Spatrick // The object file now contains a full mmap'ed copy of the object file
551061da546Spatrick // data, so just use this
552061da546Spatrick return GetData(section->GetFileOffset(), section->GetFileSize(),
553061da546Spatrick section_data);
554061da546Spatrick }
555061da546Spatrick
SplitArchivePathWithObject(llvm::StringRef path_with_object,FileSpec & archive_file,ConstString & archive_object,bool must_exist)556061da546Spatrick bool ObjectFile::SplitArchivePathWithObject(llvm::StringRef path_with_object,
557061da546Spatrick FileSpec &archive_file,
558061da546Spatrick ConstString &archive_object,
559061da546Spatrick bool must_exist) {
560061da546Spatrick size_t len = path_with_object.size();
561061da546Spatrick if (len < 2 || path_with_object.back() != ')')
562061da546Spatrick return false;
563061da546Spatrick llvm::StringRef archive = path_with_object.substr(0, path_with_object.rfind('('));
564061da546Spatrick if (archive.empty())
565061da546Spatrick return false;
566061da546Spatrick llvm::StringRef object = path_with_object.substr(archive.size() + 1).drop_back();
567061da546Spatrick archive_file.SetFile(archive, FileSpec::Style::native);
568061da546Spatrick if (must_exist && !FileSystem::Instance().Exists(archive_file))
569061da546Spatrick return false;
570061da546Spatrick archive_object.SetString(object);
571061da546Spatrick return true;
572061da546Spatrick }
573061da546Spatrick
ClearSymtab()574061da546Spatrick void ObjectFile::ClearSymtab() {
575061da546Spatrick ModuleSP module_sp(GetModule());
576061da546Spatrick if (module_sp) {
577*f6aab3d8Srobert Log *log = GetLog(LLDBLog::Object);
578061da546Spatrick LLDB_LOGF(log, "%p ObjectFile::ClearSymtab () symtab = %p",
579061da546Spatrick static_cast<void *>(this),
580061da546Spatrick static_cast<void *>(m_symtab_up.get()));
581*f6aab3d8Srobert // Since we need to clear the symbol table, we need a new llvm::once_flag
582*f6aab3d8Srobert // instance so we can safely create another symbol table
583*f6aab3d8Srobert m_symtab_once_up.reset(new llvm::once_flag());
584061da546Spatrick m_symtab_up.reset();
585061da546Spatrick }
586061da546Spatrick }
587061da546Spatrick
GetSectionList(bool update_module_section_list)588061da546Spatrick SectionList *ObjectFile::GetSectionList(bool update_module_section_list) {
589061da546Spatrick if (m_sections_up == nullptr) {
590061da546Spatrick if (update_module_section_list) {
591061da546Spatrick ModuleSP module_sp(GetModule());
592061da546Spatrick if (module_sp) {
593061da546Spatrick std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
594061da546Spatrick CreateSections(*module_sp->GetUnifiedSectionList());
595061da546Spatrick }
596061da546Spatrick } else {
597061da546Spatrick SectionList unified_section_list;
598061da546Spatrick CreateSections(unified_section_list);
599061da546Spatrick }
600061da546Spatrick }
601061da546Spatrick return m_sections_up.get();
602061da546Spatrick }
603061da546Spatrick
604061da546Spatrick lldb::SymbolType
GetSymbolTypeFromName(llvm::StringRef name,lldb::SymbolType symbol_type_hint)605061da546Spatrick ObjectFile::GetSymbolTypeFromName(llvm::StringRef name,
606061da546Spatrick lldb::SymbolType symbol_type_hint) {
607061da546Spatrick if (!name.empty()) {
608061da546Spatrick if (name.startswith("_OBJC_")) {
609061da546Spatrick // ObjC
610061da546Spatrick if (name.startswith("_OBJC_CLASS_$_"))
611061da546Spatrick return lldb::eSymbolTypeObjCClass;
612061da546Spatrick if (name.startswith("_OBJC_METACLASS_$_"))
613061da546Spatrick return lldb::eSymbolTypeObjCMetaClass;
614061da546Spatrick if (name.startswith("_OBJC_IVAR_$_"))
615061da546Spatrick return lldb::eSymbolTypeObjCIVar;
616061da546Spatrick } else if (name.startswith(".objc_class_name_")) {
617061da546Spatrick // ObjC v1
618061da546Spatrick return lldb::eSymbolTypeObjCClass;
619061da546Spatrick }
620061da546Spatrick }
621061da546Spatrick return symbol_type_hint;
622061da546Spatrick }
623061da546Spatrick
624061da546Spatrick std::vector<ObjectFile::LoadableData>
GetLoadableData(Target & target)625061da546Spatrick ObjectFile::GetLoadableData(Target &target) {
626061da546Spatrick std::vector<LoadableData> loadables;
627061da546Spatrick SectionList *section_list = GetSectionList();
628061da546Spatrick if (!section_list)
629061da546Spatrick return loadables;
630061da546Spatrick // Create a list of loadable data from loadable sections
631061da546Spatrick size_t section_count = section_list->GetNumSections(0);
632061da546Spatrick for (size_t i = 0; i < section_count; ++i) {
633061da546Spatrick LoadableData loadable;
634061da546Spatrick SectionSP section_sp = section_list->GetSectionAtIndex(i);
635061da546Spatrick loadable.Dest =
636061da546Spatrick target.GetSectionLoadList().GetSectionLoadAddress(section_sp);
637061da546Spatrick if (loadable.Dest == LLDB_INVALID_ADDRESS)
638061da546Spatrick continue;
639061da546Spatrick // We can skip sections like bss
640061da546Spatrick if (section_sp->GetFileSize() == 0)
641061da546Spatrick continue;
642061da546Spatrick DataExtractor section_data;
643061da546Spatrick section_sp->GetSectionData(section_data);
644061da546Spatrick loadable.Contents = llvm::ArrayRef<uint8_t>(section_data.GetDataStart(),
645061da546Spatrick section_data.GetByteSize());
646061da546Spatrick loadables.push_back(loadable);
647061da546Spatrick }
648061da546Spatrick return loadables;
649061da546Spatrick }
650061da546Spatrick
CreateCallFrameInfo()651061da546Spatrick std::unique_ptr<CallFrameInfo> ObjectFile::CreateCallFrameInfo() {
652061da546Spatrick return {};
653061da546Spatrick }
654061da546Spatrick
RelocateSection(lldb_private::Section * section)655061da546Spatrick void ObjectFile::RelocateSection(lldb_private::Section *section)
656061da546Spatrick {
657061da546Spatrick }
658061da546Spatrick
MapFileData(const FileSpec & file,uint64_t Size,uint64_t Offset)659061da546Spatrick DataBufferSP ObjectFile::MapFileData(const FileSpec &file, uint64_t Size,
660061da546Spatrick uint64_t Offset) {
661061da546Spatrick return FileSystem::Instance().CreateDataBuffer(file.GetPath(), Size, Offset);
662061da546Spatrick }
663061da546Spatrick
format(const ObjectFile::Type & type,raw_ostream & OS,StringRef Style)664061da546Spatrick void llvm::format_provider<ObjectFile::Type>::format(
665061da546Spatrick const ObjectFile::Type &type, raw_ostream &OS, StringRef Style) {
666061da546Spatrick switch (type) {
667061da546Spatrick case ObjectFile::eTypeInvalid:
668061da546Spatrick OS << "invalid";
669061da546Spatrick break;
670061da546Spatrick case ObjectFile::eTypeCoreFile:
671061da546Spatrick OS << "core file";
672061da546Spatrick break;
673061da546Spatrick case ObjectFile::eTypeExecutable:
674061da546Spatrick OS << "executable";
675061da546Spatrick break;
676061da546Spatrick case ObjectFile::eTypeDebugInfo:
677061da546Spatrick OS << "debug info";
678061da546Spatrick break;
679061da546Spatrick case ObjectFile::eTypeDynamicLinker:
680061da546Spatrick OS << "dynamic linker";
681061da546Spatrick break;
682061da546Spatrick case ObjectFile::eTypeObjectFile:
683061da546Spatrick OS << "object file";
684061da546Spatrick break;
685061da546Spatrick case ObjectFile::eTypeSharedLibrary:
686061da546Spatrick OS << "shared library";
687061da546Spatrick break;
688061da546Spatrick case ObjectFile::eTypeStubLibrary:
689061da546Spatrick OS << "stub library";
690061da546Spatrick break;
691061da546Spatrick case ObjectFile::eTypeJIT:
692061da546Spatrick OS << "jit";
693061da546Spatrick break;
694061da546Spatrick case ObjectFile::eTypeUnknown:
695061da546Spatrick OS << "unknown";
696061da546Spatrick break;
697061da546Spatrick }
698061da546Spatrick }
699061da546Spatrick
format(const ObjectFile::Strata & strata,raw_ostream & OS,StringRef Style)700061da546Spatrick void llvm::format_provider<ObjectFile::Strata>::format(
701061da546Spatrick const ObjectFile::Strata &strata, raw_ostream &OS, StringRef Style) {
702061da546Spatrick switch (strata) {
703061da546Spatrick case ObjectFile::eStrataInvalid:
704061da546Spatrick OS << "invalid";
705061da546Spatrick break;
706061da546Spatrick case ObjectFile::eStrataUnknown:
707061da546Spatrick OS << "unknown";
708061da546Spatrick break;
709061da546Spatrick case ObjectFile::eStrataUser:
710061da546Spatrick OS << "user";
711061da546Spatrick break;
712061da546Spatrick case ObjectFile::eStrataKernel:
713061da546Spatrick OS << "kernel";
714061da546Spatrick break;
715061da546Spatrick case ObjectFile::eStrataRawImage:
716061da546Spatrick OS << "raw image";
717061da546Spatrick break;
718061da546Spatrick case ObjectFile::eStrataJIT:
719061da546Spatrick OS << "jit";
720061da546Spatrick break;
721061da546Spatrick }
722061da546Spatrick }
723*f6aab3d8Srobert
724*f6aab3d8Srobert
GetSymtab()725*f6aab3d8Srobert Symtab *ObjectFile::GetSymtab() {
726*f6aab3d8Srobert ModuleSP module_sp(GetModule());
727*f6aab3d8Srobert if (module_sp) {
728*f6aab3d8Srobert // We can't take the module lock in ObjectFile::GetSymtab() or we can
729*f6aab3d8Srobert // deadlock in DWARF indexing when any file asks for the symbol table from
730*f6aab3d8Srobert // an object file. This currently happens in the preloading of symbols in
731*f6aab3d8Srobert // SymbolFileDWARF::PreloadSymbols() because the main thread will take the
732*f6aab3d8Srobert // module lock, and then threads will be spun up to index the DWARF and
733*f6aab3d8Srobert // any of those threads might end up trying to relocate items in the DWARF
734*f6aab3d8Srobert // sections which causes ObjectFile::GetSectionData(...) to relocate section
735*f6aab3d8Srobert // data which requires the symbol table.
736*f6aab3d8Srobert //
737*f6aab3d8Srobert // So to work around this, we create the symbol table one time using
738*f6aab3d8Srobert // llvm::once_flag, lock it, and then set the unique pointer. Any other
739*f6aab3d8Srobert // thread that gets ahold of the symbol table before parsing is done, will
740*f6aab3d8Srobert // not be able to access the symbol table contents since all APIs in Symtab
741*f6aab3d8Srobert // are protected by a mutex in the Symtab object itself.
742*f6aab3d8Srobert llvm::call_once(*m_symtab_once_up, [&]() {
743*f6aab3d8Srobert Symtab *symtab = new Symtab(this);
744*f6aab3d8Srobert std::lock_guard<std::recursive_mutex> symtab_guard(symtab->GetMutex());
745*f6aab3d8Srobert m_symtab_up.reset(symtab);
746*f6aab3d8Srobert if (!m_symtab_up->LoadFromCache()) {
747*f6aab3d8Srobert ElapsedTime elapsed(module_sp->GetSymtabParseTime());
748*f6aab3d8Srobert ParseSymtab(*m_symtab_up);
749*f6aab3d8Srobert m_symtab_up->Finalize();
750*f6aab3d8Srobert }
751*f6aab3d8Srobert });
752*f6aab3d8Srobert }
753*f6aab3d8Srobert return m_symtab_up.get();
754*f6aab3d8Srobert }
755*f6aab3d8Srobert
GetCacheHash()756*f6aab3d8Srobert uint32_t ObjectFile::GetCacheHash() {
757*f6aab3d8Srobert if (m_cache_hash)
758*f6aab3d8Srobert return *m_cache_hash;
759*f6aab3d8Srobert StreamString strm;
760*f6aab3d8Srobert strm.Format("{0}-{1}-{2}", m_file, GetType(), GetStrata());
761*f6aab3d8Srobert m_cache_hash = llvm::djbHash(strm.GetString());
762*f6aab3d8Srobert return *m_cache_hash;
763*f6aab3d8Srobert }
764