blob: 86c18c7beb0b68dc195c5d46c8633087125f66bd [file] [log] [blame]
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001//===-- ObjectFile.cpp ------------------------------------------*- C++ -*-===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9
Kate Stoneb9c1b512016-09-06 20:57:50 +000010#include "lldb/Symbol/ObjectFile.h"
Chris Lattner30fdc8d2010-06-08 16:52:24 +000011#include "lldb/Core/Module.h"
Greg Claytonf4d6de62013-04-24 22:29:28 +000012#include "lldb/Core/ModuleSpec.h"
Chris Lattner30fdc8d2010-06-08 16:52:24 +000013#include "lldb/Core/PluginManager.h"
Greg Clayton1f746072012-08-29 21:13:06 +000014#include "lldb/Core/Section.h"
Chris Lattner30fdc8d2010-06-08 16:52:24 +000015#include "lldb/Symbol/ObjectContainer.h"
16#include "lldb/Symbol/SymbolFile.h"
Zachary Turnerbf9a7732017-02-02 21:39:50 +000017#include "lldb/Target/Process.h"
Hafiz Abid Qadeer4687db02017-01-19 17:32:50 +000018#include "lldb/Target/SectionLoadList.h"
Zachary Turnerbf9a7732017-02-02 21:39:50 +000019#include "lldb/Target/Target.h"
Zachary Turner666cc0b2017-03-04 01:30:05 +000020#include "lldb/Utility/DataBuffer.h"
21#include "lldb/Utility/DataBufferHeap.h"
Zachary Turner6f9e6902017-03-03 20:56:28 +000022#include "lldb/Utility/Log.h"
Zachary Turnerbf9a7732017-02-02 21:39:50 +000023#include "lldb/Utility/RegularExpression.h"
Pavel Labath38d06322017-06-29 14:32:17 +000024#include "lldb/Utility/Timer.h"
Kate Stoneb9c1b512016-09-06 20:57:50 +000025#include "lldb/lldb-private.h"
Chris Lattner30fdc8d2010-06-08 16:52:24 +000026
27using namespace lldb;
28using namespace lldb_private;
29
Greg Clayton762f7132011-09-18 18:59:15 +000030ObjectFileSP
Kate Stoneb9c1b512016-09-06 20:57:50 +000031ObjectFile::FindPlugin(const lldb::ModuleSP &module_sp, const FileSpec *file,
32 lldb::offset_t file_offset, lldb::offset_t file_size,
33 DataBufferSP &data_sp, lldb::offset_t &data_offset) {
34 ObjectFileSP object_file_sp;
Chris Lattner30fdc8d2010-06-08 16:52:24 +000035
Kate Stoneb9c1b512016-09-06 20:57:50 +000036 if (module_sp) {
Pavel Labathf9d16472017-05-15 13:02:37 +000037 static Timer::Category func_cat(LLVM_PRETTY_FUNCTION);
Kate Stoneb9c1b512016-09-06 20:57:50 +000038 Timer scoped_timer(
Pavel Labathf9d16472017-05-15 13:02:37 +000039 func_cat,
Kate Stoneb9c1b512016-09-06 20:57:50 +000040 "ObjectFile::FindPlugin (module = %s, file = %p, file_offset = "
41 "0x%8.8" PRIx64 ", file_size = 0x%8.8" PRIx64 ")",
42 module_sp->GetFileSpec().GetPath().c_str(),
43 static_cast<const void *>(file), static_cast<uint64_t>(file_offset),
44 static_cast<uint64_t>(file_size));
45 if (file) {
46 FileSpec archive_file;
47 ObjectContainerCreateInstance create_object_container_callback;
Greg Clayton5ce9c562013-02-06 17:22:03 +000048
Jonas Devliegheredbd7fab2018-11-01 17:09:25 +000049 const bool file_exists = FileSystem::Instance().Exists(*file);
Kate Stoneb9c1b512016-09-06 20:57:50 +000050 if (!data_sp) {
Adrian Prantl05097242018-04-30 16:49:04 +000051 // We have an object name which most likely means we have a .o file in
52 // a static archive (.a file). Try and see if we have a cached archive
53 // first without reading any data first
Kate Stoneb9c1b512016-09-06 20:57:50 +000054 if (file_exists && module_sp->GetObjectName()) {
55 for (uint32_t idx = 0;
56 (create_object_container_callback =
57 PluginManager::GetObjectContainerCreateCallbackAtIndex(
58 idx)) != nullptr;
59 ++idx) {
60 std::unique_ptr<ObjectContainer> object_container_ap(
61 create_object_container_callback(module_sp, data_sp,
62 data_offset, file, file_offset,
63 file_size));
Saleem Abdulrasool324a1032014-04-04 04:06:10 +000064
Kate Stoneb9c1b512016-09-06 20:57:50 +000065 if (object_container_ap.get())
66 object_file_sp = object_container_ap->GetObjectFile(file);
Saleem Abdulrasool324a1032014-04-04 04:06:10 +000067
Kate Stoneb9c1b512016-09-06 20:57:50 +000068 if (object_file_sp.get())
69 return object_file_sp;
70 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +000071 }
Adrian Prantl05097242018-04-30 16:49:04 +000072 // Ok, we didn't find any containers that have a named object, now lets
73 // read the first 512 bytes from the file so the object file and object
74 // container plug-ins can use these bytes to see if they can parse this
75 // file.
Kate Stoneb9c1b512016-09-06 20:57:50 +000076 if (file_size > 0) {
Jonas Devlieghere87e403a2018-11-12 21:24:50 +000077 data_sp = FileSystem::Instance().CreateDataBuffer(file->GetPath(),
78 512, file_offset);
Kate Stoneb9c1b512016-09-06 20:57:50 +000079 data_offset = 0;
80 }
81 }
Greg Clayton762f7132011-09-18 18:59:15 +000082
Kate Stoneb9c1b512016-09-06 20:57:50 +000083 if (!data_sp || data_sp->GetByteSize() == 0) {
84 // Check for archive file with format "/path/to/archive.a(object.o)"
85 char path_with_object[PATH_MAX * 2];
86 module_sp->GetFileSpec().GetPath(path_with_object,
87 sizeof(path_with_object));
Saleem Abdulrasool324a1032014-04-04 04:06:10 +000088
Kate Stoneb9c1b512016-09-06 20:57:50 +000089 ConstString archive_object;
90 const bool must_exist = true;
91 if (ObjectFile::SplitArchivePathWithObject(
92 path_with_object, archive_file, archive_object, must_exist)) {
Jonas Devlieghere59b78bc2018-11-01 04:45:28 +000093 file_size = FileSystem::Instance().GetByteSize(archive_file);
Kate Stoneb9c1b512016-09-06 20:57:50 +000094 if (file_size > 0) {
95 file = &archive_file;
96 module_sp->SetFileSpecAndObjectName(archive_file, archive_object);
97 // Check if this is a object container by iterating through all
Adrian Prantl05097242018-04-30 16:49:04 +000098 // object container plugin instances and then trying to get an
99 // object file from the container plugins since we had a name.
100 // Also, don't read
Kate Stoneb9c1b512016-09-06 20:57:50 +0000101 // ANY data in case there is data cached in the container plug-ins
Adrian Prantl05097242018-04-30 16:49:04 +0000102 // (like BSD archives caching the contained objects within an
103 // file).
Kate Stoneb9c1b512016-09-06 20:57:50 +0000104 for (uint32_t idx = 0;
105 (create_object_container_callback =
106 PluginManager::GetObjectContainerCreateCallbackAtIndex(
107 idx)) != nullptr;
108 ++idx) {
109 std::unique_ptr<ObjectContainer> object_container_ap(
110 create_object_container_callback(module_sp, data_sp,
111 data_offset, file,
112 file_offset, file_size));
Saleem Abdulrasool324a1032014-04-04 04:06:10 +0000113
Kate Stoneb9c1b512016-09-06 20:57:50 +0000114 if (object_container_ap.get())
115 object_file_sp = object_container_ap->GetObjectFile(file);
116
117 if (object_file_sp.get())
118 return object_file_sp;
119 }
Adrian Prantl05097242018-04-30 16:49:04 +0000120 // We failed to find any cached object files in the container plug-
121 // ins, so lets read the first 512 bytes and try again below...
Jonas Devlieghere87e403a2018-11-12 21:24:50 +0000122 data_sp = FileSystem::Instance().CreateDataBuffer(
123 archive_file.GetPath(), 512, file_offset);
Kate Stoneb9c1b512016-09-06 20:57:50 +0000124 }
125 }
126 }
127
128 if (data_sp && data_sp->GetByteSize() > 0) {
Adrian Prantl05097242018-04-30 16:49:04 +0000129 // Check if this is a normal object file by iterating through all
130 // object file plugin instances.
Kate Stoneb9c1b512016-09-06 20:57:50 +0000131 ObjectFileCreateInstance create_object_file_callback;
132 for (uint32_t idx = 0;
133 (create_object_file_callback =
134 PluginManager::GetObjectFileCreateCallbackAtIndex(idx)) !=
135 nullptr;
136 ++idx) {
137 object_file_sp.reset(create_object_file_callback(
138 module_sp, data_sp, data_offset, file, file_offset, file_size));
139 if (object_file_sp.get())
140 return object_file_sp;
Greg Claytonc9660542012-02-05 02:38:54 +0000141 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +0000142
Adrian Prantl05097242018-04-30 16:49:04 +0000143 // Check if this is a object container by iterating through all object
144 // container plugin instances and then trying to get an object file
145 // from the container.
Kate Stoneb9c1b512016-09-06 20:57:50 +0000146 for (uint32_t idx = 0;
147 (create_object_container_callback =
148 PluginManager::GetObjectContainerCreateCallbackAtIndex(
149 idx)) != nullptr;
150 ++idx) {
151 std::unique_ptr<ObjectContainer> object_container_ap(
152 create_object_container_callback(module_sp, data_sp, data_offset,
153 file, file_offset, file_size));
Greg Claytonc9660542012-02-05 02:38:54 +0000154
Kate Stoneb9c1b512016-09-06 20:57:50 +0000155 if (object_container_ap.get())
156 object_file_sp = object_container_ap->GetObjectFile(file);
157
158 if (object_file_sp.get())
159 return object_file_sp;
Greg Clayton2540a8a2013-07-12 22:07:46 +0000160 }
Kate Stoneb9c1b512016-09-06 20:57:50 +0000161 }
Greg Clayton2540a8a2013-07-12 22:07:46 +0000162 }
Kate Stoneb9c1b512016-09-06 20:57:50 +0000163 }
Adrian Prantl05097242018-04-30 16:49:04 +0000164 // We didn't find it, so clear our shared pointer in case it contains
165 // anything and return an empty shared pointer
Kate Stoneb9c1b512016-09-06 20:57:50 +0000166 object_file_sp.reset();
167 return object_file_sp;
Greg Claytonf4d6de62013-04-24 22:29:28 +0000168}
169
Kate Stoneb9c1b512016-09-06 20:57:50 +0000170ObjectFileSP ObjectFile::FindPlugin(const lldb::ModuleSP &module_sp,
171 const ProcessSP &process_sp,
172 lldb::addr_t header_addr,
173 DataBufferSP &data_sp) {
174 ObjectFileSP object_file_sp;
175
176 if (module_sp) {
Pavel Labathf9d16472017-05-15 13:02:37 +0000177 static Timer::Category func_cat(LLVM_PRETTY_FUNCTION);
178 Timer scoped_timer(func_cat,
179 "ObjectFile::FindPlugin (module = "
180 "%s, process = %p, header_addr = "
181 "0x%" PRIx64 ")",
Kate Stoneb9c1b512016-09-06 20:57:50 +0000182 module_sp->GetFileSpec().GetPath().c_str(),
183 static_cast<void *>(process_sp.get()), header_addr);
184 uint32_t idx;
185
Adrian Prantl05097242018-04-30 16:49:04 +0000186 // Check if this is a normal object file by iterating through all object
187 // file plugin instances.
Kate Stoneb9c1b512016-09-06 20:57:50 +0000188 ObjectFileCreateMemoryInstance create_callback;
189 for (idx = 0;
190 (create_callback =
191 PluginManager::GetObjectFileCreateMemoryCallbackAtIndex(idx)) !=
192 nullptr;
193 ++idx) {
194 object_file_sp.reset(
195 create_callback(module_sp, data_sp, process_sp, header_addr));
196 if (object_file_sp.get())
197 return object_file_sp;
Greg Claytonf4d6de62013-04-24 22:29:28 +0000198 }
Kate Stoneb9c1b512016-09-06 20:57:50 +0000199 }
Greg Claytonf4d6de62013-04-24 22:29:28 +0000200
Adrian Prantl05097242018-04-30 16:49:04 +0000201 // We didn't find it, so clear our shared pointer in case it contains
202 // anything and return an empty shared pointer
Kate Stoneb9c1b512016-09-06 20:57:50 +0000203 object_file_sp.reset();
204 return object_file_sp;
205}
206
207size_t ObjectFile::GetModuleSpecifications(const FileSpec &file,
208 lldb::offset_t file_offset,
209 lldb::offset_t file_size,
210 ModuleSpecList &specs) {
Jonas Devlieghere87e403a2018-11-12 21:24:50 +0000211 DataBufferSP data_sp =
212 FileSystem::Instance().CreateDataBuffer(file.GetPath(), 512, file_offset);
Kate Stoneb9c1b512016-09-06 20:57:50 +0000213 if (data_sp) {
214 if (file_size == 0) {
Jonas Devlieghere59b78bc2018-11-01 04:45:28 +0000215 const lldb::offset_t actual_file_size =
216 FileSystem::Instance().GetByteSize(file);
Kate Stoneb9c1b512016-09-06 20:57:50 +0000217 if (actual_file_size > file_offset)
218 file_size = actual_file_size - file_offset;
Greg Claytonf4d6de62013-04-24 22:29:28 +0000219 }
Kate Stoneb9c1b512016-09-06 20:57:50 +0000220 return ObjectFile::GetModuleSpecifications(file, // file spec
221 data_sp, // data bytes
222 0, // data offset
223 file_offset, // file offset
224 file_size, // file length
225 specs);
226 }
227 return 0;
Greg Claytonf4d6de62013-04-24 22:29:28 +0000228}
229
Kate Stoneb9c1b512016-09-06 20:57:50 +0000230size_t ObjectFile::GetModuleSpecifications(
231 const lldb_private::FileSpec &file, lldb::DataBufferSP &data_sp,
232 lldb::offset_t data_offset, lldb::offset_t file_offset,
233 lldb::offset_t file_size, lldb_private::ModuleSpecList &specs) {
234 const size_t initial_count = specs.GetSize();
235 ObjectFileGetModuleSpecifications callback;
236 uint32_t i;
237 // Try the ObjectFile plug-ins
238 for (i = 0;
239 (callback =
240 PluginManager::GetObjectFileGetModuleSpecificationsCallbackAtIndex(
241 i)) != nullptr;
242 ++i) {
243 if (callback(file, data_sp, data_offset, file_offset, file_size, specs) > 0)
244 return specs.GetSize() - initial_count;
245 }
246
247 // Try the ObjectContainer plug-ins
248 for (i = 0;
249 (callback = PluginManager::
250 GetObjectContainerGetModuleSpecificationsCallbackAtIndex(i)) !=
251 nullptr;
252 ++i) {
253 if (callback(file, data_sp, data_offset, file_offset, file_size, specs) > 0)
254 return specs.GetSize() - initial_count;
255 }
256 return 0;
Greg Clayton762f7132011-09-18 18:59:15 +0000257}
258
Kate Stoneb9c1b512016-09-06 20:57:50 +0000259ObjectFile::ObjectFile(const lldb::ModuleSP &module_sp,
260 const FileSpec *file_spec_ptr,
261 lldb::offset_t file_offset, lldb::offset_t length,
262 const lldb::DataBufferSP &data_sp,
263 lldb::offset_t data_offset)
264 : ModuleChild(module_sp),
265 m_file(), // This file could be different from the original module's file
266 m_type(eTypeInvalid), m_strata(eStrataInvalid),
267 m_file_offset(file_offset), m_length(length), m_data(),
268 m_unwind_table(*this), m_process_wp(),
269 m_memory_addr(LLDB_INVALID_ADDRESS), m_sections_ap(), m_symtab_ap(),
270 m_synthetic_symbol_idx(0) {
271 if (file_spec_ptr)
272 m_file = *file_spec_ptr;
273 if (data_sp)
274 m_data.SetData(data_sp, data_offset, length);
275 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_OBJECT));
276 if (log)
277 log->Printf("%p ObjectFile::ObjectFile() module = %p (%s), file = %s, "
278 "file_offset = 0x%8.8" PRIx64 ", size = %" PRIu64,
279 static_cast<void *>(this), static_cast<void *>(module_sp.get()),
280 module_sp->GetSpecificationDescription().c_str(),
281 m_file ? m_file.GetPath().c_str() : "<NULL>", m_file_offset,
282 m_length);
Greg Claytonc9660542012-02-05 02:38:54 +0000283}
284
Kate Stoneb9c1b512016-09-06 20:57:50 +0000285ObjectFile::ObjectFile(const lldb::ModuleSP &module_sp,
286 const ProcessSP &process_sp, lldb::addr_t header_addr,
287 DataBufferSP &header_data_sp)
288 : ModuleChild(module_sp), m_file(), m_type(eTypeInvalid),
289 m_strata(eStrataInvalid), m_file_offset(0), m_length(0), m_data(),
290 m_unwind_table(*this), m_process_wp(process_sp),
291 m_memory_addr(header_addr), m_sections_ap(), m_symtab_ap(),
292 m_synthetic_symbol_idx(0) {
293 if (header_data_sp)
294 m_data.SetData(header_data_sp, 0, header_data_sp->GetByteSize());
295 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_OBJECT));
296 if (log)
297 log->Printf("%p ObjectFile::ObjectFile() module = %p (%s), process = %p, "
298 "header_addr = 0x%" PRIx64,
299 static_cast<void *>(this), static_cast<void *>(module_sp.get()),
300 module_sp->GetSpecificationDescription().c_str(),
301 static_cast<void *>(process_sp.get()), m_memory_addr);
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000302}
Jim Ingham5aee1622010-08-09 23:31:02 +0000303
Kate Stoneb9c1b512016-09-06 20:57:50 +0000304ObjectFile::~ObjectFile() {
305 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_OBJECT));
306 if (log)
307 log->Printf("%p ObjectFile::~ObjectFile ()\n", static_cast<void *>(this));
Jim Ingham5aee1622010-08-09 23:31:02 +0000308}
309
Kate Stoneb9c1b512016-09-06 20:57:50 +0000310bool ObjectFile::SetModulesArchitecture(const ArchSpec &new_arch) {
311 ModuleSP module_sp(GetModule());
312 if (module_sp)
313 return module_sp->SetArchitecture(new_arch);
314 return false;
315}
Saleem Abdulrasool324a1032014-04-04 04:06:10 +0000316
Kate Stoneb9c1b512016-09-06 20:57:50 +0000317AddressClass ObjectFile::GetAddressClass(addr_t file_addr) {
318 Symtab *symtab = GetSymtab();
319 if (symtab) {
320 Symbol *symbol = symtab->FindSymbolContainingFileAddress(file_addr);
321 if (symbol) {
322 if (symbol->ValueIsAddress()) {
323 const SectionSP section_sp(symbol->GetAddressRef().GetSection());
324 if (section_sp) {
325 const SectionType section_type = section_sp->GetType();
326 switch (section_type) {
327 case eSectionTypeInvalid:
Tatyana Krasnukha04803b32018-06-26 13:06:54 +0000328 return AddressClass::eUnknown;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000329 case eSectionTypeCode:
Tatyana Krasnukha04803b32018-06-26 13:06:54 +0000330 return AddressClass::eCode;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000331 case eSectionTypeContainer:
Tatyana Krasnukha04803b32018-06-26 13:06:54 +0000332 return AddressClass::eUnknown;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000333 case eSectionTypeData:
334 case eSectionTypeDataCString:
335 case eSectionTypeDataCStringPointers:
336 case eSectionTypeDataSymbolAddress:
337 case eSectionTypeData4:
338 case eSectionTypeData8:
339 case eSectionTypeData16:
340 case eSectionTypeDataPointers:
341 case eSectionTypeZeroFill:
342 case eSectionTypeDataObjCMessageRefs:
343 case eSectionTypeDataObjCCFStrings:
344 case eSectionTypeGoSymtab:
Tatyana Krasnukha04803b32018-06-26 13:06:54 +0000345 return AddressClass::eData;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000346 case eSectionTypeDebug:
347 case eSectionTypeDWARFDebugAbbrev:
George Rimar004bcb72018-11-14 13:01:15 +0000348 case eSectionTypeDWARFDebugAbbrevDwo:
Kate Stoneb9c1b512016-09-06 20:57:50 +0000349 case eSectionTypeDWARFDebugAddr:
350 case eSectionTypeDWARFDebugAranges:
Tamas Berghammer963ce482017-08-25 13:56:14 +0000351 case eSectionTypeDWARFDebugCuIndex:
Kate Stoneb9c1b512016-09-06 20:57:50 +0000352 case eSectionTypeDWARFDebugFrame:
353 case eSectionTypeDWARFDebugInfo:
George Rimar004bcb72018-11-14 13:01:15 +0000354 case eSectionTypeDWARFDebugInfoDwo:
Kate Stoneb9c1b512016-09-06 20:57:50 +0000355 case eSectionTypeDWARFDebugLine:
George Rimarc6c7bfc2018-09-13 17:06:47 +0000356 case eSectionTypeDWARFDebugLineStr:
Kate Stoneb9c1b512016-09-06 20:57:50 +0000357 case eSectionTypeDWARFDebugLoc:
George Rimare4dee262018-10-23 09:46:15 +0000358 case eSectionTypeDWARFDebugLocLists:
Kate Stoneb9c1b512016-09-06 20:57:50 +0000359 case eSectionTypeDWARFDebugMacInfo:
360 case eSectionTypeDWARFDebugMacro:
Pavel Labatha041d842018-06-01 12:06:45 +0000361 case eSectionTypeDWARFDebugNames:
Kate Stoneb9c1b512016-09-06 20:57:50 +0000362 case eSectionTypeDWARFDebugPubNames:
363 case eSectionTypeDWARFDebugPubTypes:
364 case eSectionTypeDWARFDebugRanges:
George Rimar6e357122018-10-10 08:11:15 +0000365 case eSectionTypeDWARFDebugRngLists:
Kate Stoneb9c1b512016-09-06 20:57:50 +0000366 case eSectionTypeDWARFDebugStr:
George Rimar004bcb72018-11-14 13:01:15 +0000367 case eSectionTypeDWARFDebugStrDwo:
Kate Stoneb9c1b512016-09-06 20:57:50 +0000368 case eSectionTypeDWARFDebugStrOffsets:
George Rimar004bcb72018-11-14 13:01:15 +0000369 case eSectionTypeDWARFDebugStrOffsetsDwo:
Greg Clayton2550ca12018-05-08 17:19:24 +0000370 case eSectionTypeDWARFDebugTypes:
Kate Stoneb9c1b512016-09-06 20:57:50 +0000371 case eSectionTypeDWARFAppleNames:
372 case eSectionTypeDWARFAppleTypes:
373 case eSectionTypeDWARFAppleNamespaces:
374 case eSectionTypeDWARFAppleObjC:
Jan Kratochvile4777a92018-04-29 19:47:48 +0000375 case eSectionTypeDWARFGNUDebugAltLink:
Tatyana Krasnukha04803b32018-06-26 13:06:54 +0000376 return AddressClass::eDebug;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000377 case eSectionTypeEHFrame:
378 case eSectionTypeARMexidx:
379 case eSectionTypeARMextab:
380 case eSectionTypeCompactUnwind:
Tatyana Krasnukha04803b32018-06-26 13:06:54 +0000381 return AddressClass::eRuntime;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000382 case eSectionTypeELFSymbolTable:
383 case eSectionTypeELFDynamicSymbols:
384 case eSectionTypeELFRelocationEntries:
385 case eSectionTypeELFDynamicLinkInfo:
386 case eSectionTypeOther:
Tatyana Krasnukha04803b32018-06-26 13:06:54 +0000387 return AddressClass::eUnknown;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000388 case eSectionTypeAbsoluteAddress:
389 // In case of absolute sections decide the address class based on
Adrian Prantl05097242018-04-30 16:49:04 +0000390 // the symbol type because the section type isn't specify if it is
391 // a code or a data section.
Kate Stoneb9c1b512016-09-06 20:57:50 +0000392 break;
393 }
Greg Claytonded470d2011-03-19 01:12:21 +0000394 }
Kate Stoneb9c1b512016-09-06 20:57:50 +0000395 }
396
397 const SymbolType symbol_type = symbol->GetType();
398 switch (symbol_type) {
399 case eSymbolTypeAny:
Tatyana Krasnukha04803b32018-06-26 13:06:54 +0000400 return AddressClass::eUnknown;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000401 case eSymbolTypeAbsolute:
Tatyana Krasnukha04803b32018-06-26 13:06:54 +0000402 return AddressClass::eUnknown;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000403 case eSymbolTypeCode:
Tatyana Krasnukha04803b32018-06-26 13:06:54 +0000404 return AddressClass::eCode;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000405 case eSymbolTypeTrampoline:
Tatyana Krasnukha04803b32018-06-26 13:06:54 +0000406 return AddressClass::eCode;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000407 case eSymbolTypeResolver:
Tatyana Krasnukha04803b32018-06-26 13:06:54 +0000408 return AddressClass::eCode;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000409 case eSymbolTypeData:
Tatyana Krasnukha04803b32018-06-26 13:06:54 +0000410 return AddressClass::eData;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000411 case eSymbolTypeRuntime:
Tatyana Krasnukha04803b32018-06-26 13:06:54 +0000412 return AddressClass::eRuntime;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000413 case eSymbolTypeException:
Tatyana Krasnukha04803b32018-06-26 13:06:54 +0000414 return AddressClass::eRuntime;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000415 case eSymbolTypeSourceFile:
Tatyana Krasnukha04803b32018-06-26 13:06:54 +0000416 return AddressClass::eDebug;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000417 case eSymbolTypeHeaderFile:
Tatyana Krasnukha04803b32018-06-26 13:06:54 +0000418 return AddressClass::eDebug;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000419 case eSymbolTypeObjectFile:
Tatyana Krasnukha04803b32018-06-26 13:06:54 +0000420 return AddressClass::eDebug;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000421 case eSymbolTypeCommonBlock:
Tatyana Krasnukha04803b32018-06-26 13:06:54 +0000422 return AddressClass::eDebug;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000423 case eSymbolTypeBlock:
Tatyana Krasnukha04803b32018-06-26 13:06:54 +0000424 return AddressClass::eDebug;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000425 case eSymbolTypeLocal:
Tatyana Krasnukha04803b32018-06-26 13:06:54 +0000426 return AddressClass::eData;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000427 case eSymbolTypeParam:
Tatyana Krasnukha04803b32018-06-26 13:06:54 +0000428 return AddressClass::eData;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000429 case eSymbolTypeVariable:
Tatyana Krasnukha04803b32018-06-26 13:06:54 +0000430 return AddressClass::eData;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000431 case eSymbolTypeVariableType:
Tatyana Krasnukha04803b32018-06-26 13:06:54 +0000432 return AddressClass::eDebug;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000433 case eSymbolTypeLineEntry:
Tatyana Krasnukha04803b32018-06-26 13:06:54 +0000434 return AddressClass::eDebug;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000435 case eSymbolTypeLineHeader:
Tatyana Krasnukha04803b32018-06-26 13:06:54 +0000436 return AddressClass::eDebug;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000437 case eSymbolTypeScopeBegin:
Tatyana Krasnukha04803b32018-06-26 13:06:54 +0000438 return AddressClass::eDebug;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000439 case eSymbolTypeScopeEnd:
Tatyana Krasnukha04803b32018-06-26 13:06:54 +0000440 return AddressClass::eDebug;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000441 case eSymbolTypeAdditional:
Tatyana Krasnukha04803b32018-06-26 13:06:54 +0000442 return AddressClass::eUnknown;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000443 case eSymbolTypeCompiler:
Tatyana Krasnukha04803b32018-06-26 13:06:54 +0000444 return AddressClass::eDebug;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000445 case eSymbolTypeInstrumentation:
Tatyana Krasnukha04803b32018-06-26 13:06:54 +0000446 return AddressClass::eDebug;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000447 case eSymbolTypeUndefined:
Tatyana Krasnukha04803b32018-06-26 13:06:54 +0000448 return AddressClass::eUnknown;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000449 case eSymbolTypeObjCClass:
Tatyana Krasnukha04803b32018-06-26 13:06:54 +0000450 return AddressClass::eRuntime;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000451 case eSymbolTypeObjCMetaClass:
Tatyana Krasnukha04803b32018-06-26 13:06:54 +0000452 return AddressClass::eRuntime;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000453 case eSymbolTypeObjCIVar:
Tatyana Krasnukha04803b32018-06-26 13:06:54 +0000454 return AddressClass::eRuntime;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000455 case eSymbolTypeReExported:
Tatyana Krasnukha04803b32018-06-26 13:06:54 +0000456 return AddressClass::eRuntime;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000457 }
Greg Claytonded470d2011-03-19 01:12:21 +0000458 }
Kate Stoneb9c1b512016-09-06 20:57:50 +0000459 }
Tatyana Krasnukha04803b32018-06-26 13:06:54 +0000460 return AddressClass::eUnknown;
Greg Claytonded470d2011-03-19 01:12:21 +0000461}
462
Kate Stoneb9c1b512016-09-06 20:57:50 +0000463DataBufferSP ObjectFile::ReadMemory(const ProcessSP &process_sp,
464 lldb::addr_t addr, size_t byte_size) {
465 DataBufferSP data_sp;
466 if (process_sp) {
467 std::unique_ptr<DataBufferHeap> data_ap(new DataBufferHeap(byte_size, 0));
Zachary Turner97206d52017-05-12 04:51:55 +0000468 Status error;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000469 const size_t bytes_read = process_sp->ReadMemory(
470 addr, data_ap->GetBytes(), data_ap->GetByteSize(), error);
471 if (bytes_read == byte_size)
472 data_sp.reset(data_ap.release());
473 }
474 return data_sp;
Greg Claytonc9660542012-02-05 02:38:54 +0000475}
476
Kate Stoneb9c1b512016-09-06 20:57:50 +0000477size_t ObjectFile::GetData(lldb::offset_t offset, size_t length,
478 DataExtractor &data) const {
479 // The entire file has already been mmap'ed into m_data, so just copy from
Adrian Prantl05097242018-04-30 16:49:04 +0000480 // there as the back mmap buffer will be shared with shared pointers.
Kate Stoneb9c1b512016-09-06 20:57:50 +0000481 return data.SetData(m_data, offset, length);
Greg Clayton44435ed2012-01-12 05:25:17 +0000482}
483
Kate Stoneb9c1b512016-09-06 20:57:50 +0000484size_t ObjectFile::CopyData(lldb::offset_t offset, size_t length,
485 void *dst) const {
486 // The entire file has already been mmap'ed into m_data, so just copy from
Adrian Prantl05097242018-04-30 16:49:04 +0000487 // there Note that the data remains in target byte order.
Kate Stoneb9c1b512016-09-06 20:57:50 +0000488 return m_data.CopyData(offset, length, dst);
Greg Clayton44435ed2012-01-12 05:25:17 +0000489}
Greg Claytonded470d2011-03-19 01:12:21 +0000490
Ed Masted13f6912017-10-02 14:35:07 +0000491size_t ObjectFile::ReadSectionData(Section *section,
Kate Stoneb9c1b512016-09-06 20:57:50 +0000492 lldb::offset_t section_offset, void *dst,
Ed Masted13f6912017-10-02 14:35:07 +0000493 size_t dst_len) {
Kate Stoneb9c1b512016-09-06 20:57:50 +0000494 assert(section);
495 section_offset *= section->GetTargetByteSize();
Greg Claytonc9660542012-02-05 02:38:54 +0000496
Kate Stoneb9c1b512016-09-06 20:57:50 +0000497 // If some other objectfile owns this data, pass this to them.
498 if (section->GetObjectFile() != this)
499 return section->GetObjectFile()->ReadSectionData(section, section_offset,
500 dst, dst_len);
Matthew Gardinerf03e6d842014-09-29 08:02:24 +0000501
Kate Stoneb9c1b512016-09-06 20:57:50 +0000502 if (IsInMemory()) {
503 ProcessSP process_sp(m_process_wp.lock());
504 if (process_sp) {
Zachary Turner97206d52017-05-12 04:51:55 +0000505 Status error;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000506 const addr_t base_load_addr =
507 section->GetLoadBaseAddress(&process_sp->GetTarget());
508 if (base_load_addr != LLDB_INVALID_ADDRESS)
509 return process_sp->ReadMemory(base_load_addr + section_offset, dst,
510 dst_len, error);
Greg Claytonc9660542012-02-05 02:38:54 +0000511 }
Kate Stoneb9c1b512016-09-06 20:57:50 +0000512 } else {
Ed Masted13f6912017-10-02 14:35:07 +0000513 if (!section->IsRelocated())
514 RelocateSection(section);
515
Kate Stoneb9c1b512016-09-06 20:57:50 +0000516 const lldb::offset_t section_file_size = section->GetFileSize();
517 if (section_offset < section_file_size) {
518 const size_t section_bytes_left = section_file_size - section_offset;
519 size_t section_dst_len = dst_len;
520 if (section_dst_len > section_bytes_left)
521 section_dst_len = section_bytes_left;
522 return CopyData(section->GetFileOffset() + section_offset,
523 section_dst_len, dst);
524 } else {
525 if (section->GetType() == eSectionTypeZeroFill) {
526 const uint64_t section_size = section->GetByteSize();
527 const uint64_t section_bytes_left = section_size - section_offset;
528 uint64_t section_dst_len = dst_len;
529 if (section_dst_len > section_bytes_left)
530 section_dst_len = section_bytes_left;
531 memset(dst, 0, section_dst_len);
532 return section_dst_len;
533 }
Greg Claytonc9660542012-02-05 02:38:54 +0000534 }
Kate Stoneb9c1b512016-09-06 20:57:50 +0000535 }
536 return 0;
Greg Claytonc9660542012-02-05 02:38:54 +0000537}
538
539//----------------------------------------------------------------------
540// Get the section data the file on disk
541//----------------------------------------------------------------------
Ed Masted13f6912017-10-02 14:35:07 +0000542size_t ObjectFile::ReadSectionData(Section *section,
543 DataExtractor &section_data) {
Kate Stoneb9c1b512016-09-06 20:57:50 +0000544 // If some other objectfile owns this data, pass this to them.
545 if (section->GetObjectFile() != this)
546 return section->GetObjectFile()->ReadSectionData(section, section_data);
Michael Sartaina7499c92013-07-01 19:45:50 +0000547
Kate Stoneb9c1b512016-09-06 20:57:50 +0000548 if (IsInMemory()) {
549 ProcessSP process_sp(m_process_wp.lock());
550 if (process_sp) {
551 const addr_t base_load_addr =
552 section->GetLoadBaseAddress(&process_sp->GetTarget());
553 if (base_load_addr != LLDB_INVALID_ADDRESS) {
554 DataBufferSP data_sp(
555 ReadMemory(process_sp, base_load_addr, section->GetByteSize()));
556 if (data_sp) {
557 section_data.SetData(data_sp, 0, data_sp->GetByteSize());
558 section_data.SetByteOrder(process_sp->GetByteOrder());
559 section_data.SetAddressByteSize(process_sp->GetAddressByteSize());
560 return section_data.GetByteSize();
Greg Claytonc9660542012-02-05 02:38:54 +0000561 }
Kate Stoneb9c1b512016-09-06 20:57:50 +0000562 }
Greg Claytonc9660542012-02-05 02:38:54 +0000563 }
Kate Stoneb9c1b512016-09-06 20:57:50 +0000564 return GetData(section->GetFileOffset(), section->GetFileSize(),
565 section_data);
566 } else {
Adrian Prantl05097242018-04-30 16:49:04 +0000567 // The object file now contains a full mmap'ed copy of the object file
568 // data, so just use this
Ed Masted13f6912017-10-02 14:35:07 +0000569 if (!section->IsRelocated())
570 RelocateSection(section);
571
Kate Stoneb9c1b512016-09-06 20:57:50 +0000572 return GetData(section->GetFileOffset(), section->GetFileSize(),
573 section_data);
574 }
Greg Claytonc9660542012-02-05 02:38:54 +0000575}
576
Kate Stoneb9c1b512016-09-06 20:57:50 +0000577bool ObjectFile::SplitArchivePathWithObject(const char *path_with_object,
578 FileSpec &archive_file,
579 ConstString &archive_object,
580 bool must_exist) {
Zachary Turner95eae422016-09-21 16:01:28 +0000581 RegularExpression g_object_regex(llvm::StringRef("(.*)\\(([^\\)]+)\\)$"));
Kate Stoneb9c1b512016-09-06 20:57:50 +0000582 RegularExpression::Match regex_match(2);
Zachary Turner95eae422016-09-21 16:01:28 +0000583 if (g_object_regex.Execute(llvm::StringRef::withNullAsEmpty(path_with_object),
584 &regex_match)) {
Kate Stoneb9c1b512016-09-06 20:57:50 +0000585 std::string path;
586 std::string obj;
587 if (regex_match.GetMatchAtIndex(path_with_object, 1, path) &&
588 regex_match.GetMatchAtIndex(path_with_object, 2, obj)) {
Jonas Devlieghere8f3be7a2018-11-01 21:05:36 +0000589 archive_file.SetFile(path, FileSpec::Style::native);
Kate Stoneb9c1b512016-09-06 20:57:50 +0000590 archive_object.SetCString(obj.c_str());
Jonas Devliegherea6682a42018-12-15 00:15:33 +0000591 return !(must_exist && !FileSystem::Instance().Exists(archive_file));
Greg Clayton1f746072012-08-29 21:13:06 +0000592 }
Kate Stoneb9c1b512016-09-06 20:57:50 +0000593 }
594 return false;
Greg Clayton1f746072012-08-29 21:13:06 +0000595}
596
Kate Stoneb9c1b512016-09-06 20:57:50 +0000597void ObjectFile::ClearSymtab() {
598 ModuleSP module_sp(GetModule());
599 if (module_sp) {
600 std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
601 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_OBJECT));
602 if (log)
603 log->Printf("%p ObjectFile::ClearSymtab () symtab = %p",
604 static_cast<void *>(this),
605 static_cast<void *>(m_symtab_ap.get()));
606 m_symtab_ap.reset();
607 }
608}
609
610SectionList *ObjectFile::GetSectionList(bool update_module_section_list) {
611 if (m_sections_ap.get() == nullptr) {
612 if (update_module_section_list) {
613 ModuleSP module_sp(GetModule());
614 if (module_sp) {
Saleem Abdulrasool16ff8602016-05-18 01:59:10 +0000615 std::lock_guard<std::recursive_mutex> guard(module_sp->GetMutex());
Kate Stoneb9c1b512016-09-06 20:57:50 +0000616 CreateSections(*module_sp->GetUnifiedSectionList());
617 }
618 } else {
619 SectionList unified_section_list;
620 CreateSections(unified_section_list);
Greg Clayton9422dd62013-03-04 21:46:16 +0000621 }
Kate Stoneb9c1b512016-09-06 20:57:50 +0000622 }
623 return m_sections_ap.get();
Greg Clayton3046e662013-07-10 01:23:25 +0000624}
Jason Molenda649a6072015-11-10 05:21:54 +0000625
626lldb::SymbolType
Kate Stoneb9c1b512016-09-06 20:57:50 +0000627ObjectFile::GetSymbolTypeFromName(llvm::StringRef name,
628 lldb::SymbolType symbol_type_hint) {
629 if (!name.empty()) {
630 if (name.startswith("_OBJC_")) {
631 // ObjC
632 if (name.startswith("_OBJC_CLASS_$_"))
633 return lldb::eSymbolTypeObjCClass;
634 if (name.startswith("_OBJC_METACLASS_$_"))
635 return lldb::eSymbolTypeObjCMetaClass;
636 if (name.startswith("_OBJC_IVAR_$_"))
637 return lldb::eSymbolTypeObjCIVar;
638 } else if (name.startswith(".objc_class_name_")) {
639 // ObjC v1
640 return lldb::eSymbolTypeObjCClass;
Jason Molenda649a6072015-11-10 05:21:54 +0000641 }
Kate Stoneb9c1b512016-09-06 20:57:50 +0000642 }
643 return symbol_type_hint;
Jason Molenda649a6072015-11-10 05:21:54 +0000644}
Tamas Berghammer6b63b142016-02-18 11:12:18 +0000645
Kate Stoneb9c1b512016-09-06 20:57:50 +0000646ConstString ObjectFile::GetNextSyntheticSymbolName() {
647 StreamString ss;
648 ConstString file_name = GetModule()->GetFileSpec().GetFilename();
649 ss.Printf("___lldb_unnamed_symbol%u$$%s", ++m_synthetic_symbol_idx,
650 file_name.GetCString());
Zachary Turnerc1564272016-11-16 21:15:24 +0000651 return ConstString(ss.GetString());
Tamas Berghammer6b63b142016-02-18 11:12:18 +0000652}
Hafiz Abid Qadeer4687db02017-01-19 17:32:50 +0000653
Pavel Labath16064d32018-03-20 11:56:24 +0000654std::vector<ObjectFile::LoadableData>
655ObjectFile::GetLoadableData(Target &target) {
656 std::vector<LoadableData> loadables;
Hafiz Abid Qadeer4687db02017-01-19 17:32:50 +0000657 SectionList *section_list = GetSectionList();
658 if (!section_list)
Pavel Labath16064d32018-03-20 11:56:24 +0000659 return loadables;
660 // Create a list of loadable data from loadable sections
Hafiz Abid Qadeer4687db02017-01-19 17:32:50 +0000661 size_t section_count = section_list->GetNumSections(0);
662 for (size_t i = 0; i < section_count; ++i) {
Pavel Labath16064d32018-03-20 11:56:24 +0000663 LoadableData loadable;
Hafiz Abid Qadeer4687db02017-01-19 17:32:50 +0000664 SectionSP section_sp = section_list->GetSectionAtIndex(i);
Pavel Labath16064d32018-03-20 11:56:24 +0000665 loadable.Dest =
666 target.GetSectionLoadList().GetSectionLoadAddress(section_sp);
667 if (loadable.Dest == LLDB_INVALID_ADDRESS)
668 continue;
669 // We can skip sections like bss
670 if (section_sp->GetFileSize() == 0)
671 continue;
672 DataExtractor section_data;
673 section_sp->GetSectionData(section_data);
674 loadable.Contents = llvm::ArrayRef<uint8_t>(section_data.GetDataStart(),
675 section_data.GetByteSize());
676 loadables.push_back(loadable);
Hafiz Abid Qadeer4687db02017-01-19 17:32:50 +0000677 }
Pavel Labath16064d32018-03-20 11:56:24 +0000678 return loadables;
Hafiz Abid Qadeer4687db02017-01-19 17:32:50 +0000679}
Ed Masted13f6912017-10-02 14:35:07 +0000680
681void ObjectFile::RelocateSection(lldb_private::Section *section)
682{
683}
Pavel Labath50251fc2017-12-21 10:54:30 +0000684
685DataBufferSP ObjectFile::MapFileData(const FileSpec &file, uint64_t Size,
686 uint64_t Offset) {
Jonas Devlieghere87e403a2018-11-12 21:24:50 +0000687 return FileSystem::Instance().CreateDataBuffer(file.GetPath(), Size, Offset);
Pavel Labath50251fc2017-12-21 10:54:30 +0000688}
Pavel Labath1f6b2472018-12-10 17:16:38 +0000689
690void llvm::format_provider<ObjectFile::Type>::format(
691 const ObjectFile::Type &type, raw_ostream &OS, StringRef Style) {
692 switch (type) {
693 case ObjectFile::eTypeInvalid:
694 OS << "invalid";
695 break;
696 case ObjectFile::eTypeCoreFile:
697 OS << "core file";
698 break;
699 case ObjectFile::eTypeExecutable:
700 OS << "executable";
701 break;
702 case ObjectFile::eTypeDebugInfo:
703 OS << "debug info";
704 break;
705 case ObjectFile::eTypeDynamicLinker:
706 OS << "dynamic linker";
707 break;
708 case ObjectFile::eTypeObjectFile:
709 OS << "object file";
710 break;
711 case ObjectFile::eTypeSharedLibrary:
712 OS << "shared library";
713 break;
714 case ObjectFile::eTypeStubLibrary:
715 OS << "stub library";
716 break;
717 case ObjectFile::eTypeJIT:
718 OS << "jit";
719 break;
720 case ObjectFile::eTypeUnknown:
721 OS << "unknown";
722 break;
723 }
724}
725
726void llvm::format_provider<ObjectFile::Strata>::format(
727 const ObjectFile::Strata &strata, raw_ostream &OS, StringRef Style) {
728 switch (strata) {
729 case ObjectFile::eStrataInvalid:
730 OS << "invalid";
731 break;
732 case ObjectFile::eStrataUnknown:
733 OS << "unknown";
734 break;
735 case ObjectFile::eStrataUser:
736 OS << "user";
737 break;
738 case ObjectFile::eStrataKernel:
739 OS << "kernel";
740 break;
741 case ObjectFile::eStrataRawImage:
742 OS << "raw image";
743 break;
744 case ObjectFile::eStrataJIT:
745 OS << "jit";
746 break;
747 }
748}