blob: 44b40a4f123fb393130fb7beb6dd45b10a651665 [file] [log] [blame]
Stephen Wilsonf325ba92010-07-13 23:07:23 +00001//===-- ObjectFileELF.h --------------------------------------- -*- C++ -*-===//
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9
10#ifndef liblldb_ObjectFileELF_h_
11#define liblldb_ObjectFileELF_h_
12
13#include <stdint.h>
14#include <vector>
15
16#include "lldb/lldb-private.h"
Greg Clayton53239f02011-02-08 05:05:52 +000017#include "lldb/Host/FileSpec.h"
Chris Lattner30fdc8d2010-06-08 16:52:24 +000018#include "lldb/Symbol/ObjectFile.h"
Michael Sartainc836ae72013-05-23 20:57:03 +000019#include "lldb/Core/UUID.h"
Chris Lattner30fdc8d2010-06-08 16:52:24 +000020
Stephen Wilsonf325ba92010-07-13 23:07:23 +000021#include "ELFHeader.h"
Chris Lattner30fdc8d2010-06-08 16:52:24 +000022
Ed Mastec113ff82013-12-02 17:49:13 +000023struct ELFNote
24{
25 elf::elf_word n_namesz;
26 elf::elf_word n_descsz;
27 elf::elf_word n_type;
28
29 std::string n_name;
30
31 ELFNote() : n_namesz(0), n_descsz(0), n_type(0)
32 {
33 }
34
35 /// Parse an ELFNote entry from the given DataExtractor starting at position
36 /// \p offset.
37 ///
38 /// @param[in] data
39 /// The DataExtractor to read from.
40 ///
41 /// @param[in,out] offset
42 /// Pointer to an offset in the data. On return the offset will be
43 /// advanced by the number of bytes read.
44 ///
45 /// @return
46 /// True if the ELFRel entry was successfully read and false otherwise.
47 bool
48 Parse(const lldb_private::DataExtractor &data, lldb::offset_t *offset);
49};
50
Stephen Wilsonf325ba92010-07-13 23:07:23 +000051//------------------------------------------------------------------------------
52/// @class ObjectFileELF
53/// @brief Generic ELF object file reader.
54///
55/// This class provides a generic ELF (32/64 bit) reader plugin implementing the
56/// ObjectFile protocol.
Chris Lattner30fdc8d2010-06-08 16:52:24 +000057class ObjectFileELF :
58 public lldb_private::ObjectFile
59{
60public:
61 //------------------------------------------------------------------
62 // Static Functions
63 //------------------------------------------------------------------
64 static void
65 Initialize();
66
67 static void
68 Terminate();
69
Greg Clayton57abc5d2013-05-10 21:47:16 +000070 static lldb_private::ConstString
Chris Lattner30fdc8d2010-06-08 16:52:24 +000071 GetPluginNameStatic();
72
73 static const char *
74 GetPluginDescriptionStatic();
75
76 static lldb_private::ObjectFile *
Greg Claytone72dfb32012-02-24 01:59:29 +000077 CreateInstance(const lldb::ModuleSP &module_sp,
Greg Clayton5ce9c562013-02-06 17:22:03 +000078 lldb::DataBufferSP& data_sp,
79 lldb::offset_t data_offset,
Chris Lattner30fdc8d2010-06-08 16:52:24 +000080 const lldb_private::FileSpec* file,
Greg Clayton5ce9c562013-02-06 17:22:03 +000081 lldb::offset_t file_offset,
82 lldb::offset_t length);
Chris Lattner30fdc8d2010-06-08 16:52:24 +000083
Greg Claytonc9660542012-02-05 02:38:54 +000084 static lldb_private::ObjectFile *
Greg Claytone72dfb32012-02-24 01:59:29 +000085 CreateMemoryInstance (const lldb::ModuleSP &module_sp,
Greg Claytonc9660542012-02-05 02:38:54 +000086 lldb::DataBufferSP& data_sp,
87 const lldb::ProcessSP &process_sp,
88 lldb::addr_t header_addr);
89
Greg Claytonf4d6de62013-04-24 22:29:28 +000090 static size_t
91 GetModuleSpecifications (const lldb_private::FileSpec& file,
92 lldb::DataBufferSP& data_sp,
93 lldb::offset_t data_offset,
94 lldb::offset_t file_offset,
95 lldb::offset_t length,
96 lldb_private::ModuleSpecList &specs);
Michael Sartain9f0013d2013-05-17 00:20:21 +000097
98 static bool
99 MagicBytesMatch (lldb::DataBufferSP& data_sp,
100 lldb::addr_t offset,
101 lldb::addr_t length);
102
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000103 //------------------------------------------------------------------
104 // PluginInterface protocol
105 //------------------------------------------------------------------
Greg Clayton57abc5d2013-05-10 21:47:16 +0000106 virtual lldb_private::ConstString
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000107 GetPluginName();
108
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000109 virtual uint32_t
110 GetPluginVersion();
111
Stephen Wilsonf325ba92010-07-13 23:07:23 +0000112 //------------------------------------------------------------------
113 // ObjectFile Protocol.
114 //------------------------------------------------------------------
115 virtual
116 ~ObjectFileELF();
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000117
Stephen Wilsonf325ba92010-07-13 23:07:23 +0000118 virtual bool
119 ParseHeader();
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000120
Steve Pucci9e02dac2014-02-06 19:02:19 +0000121 virtual bool
Greg Clayton751caf62014-02-07 22:54:47 +0000122 SetLoadAddress (lldb_private::Target &target,
123 lldb::addr_t value,
124 bool value_is_offset);
Steve Pucci9e02dac2014-02-06 19:02:19 +0000125
Stephen Wilsonf325ba92010-07-13 23:07:23 +0000126 virtual lldb::ByteOrder
127 GetByteOrder() const;
128
Jim Ingham5aee1622010-08-09 23:31:02 +0000129 virtual bool
130 IsExecutable () const;
131
Greg Claytonc7bece562013-01-25 18:06:21 +0000132 virtual uint32_t
Stephen Wilsonf325ba92010-07-13 23:07:23 +0000133 GetAddressByteSize() const;
134
135 virtual lldb_private::Symtab *
Greg Clayton3046e662013-07-10 01:23:25 +0000136 GetSymtab();
Stephen Wilsonf325ba92010-07-13 23:07:23 +0000137
Ashok Thirumurthi35729bb2013-09-24 15:34:13 +0000138 virtual lldb_private::Symbol *
139 ResolveSymbolForAddress(const lldb_private::Address& so_addr, bool verify_unique);
140
Greg Clayton3046e662013-07-10 01:23:25 +0000141 virtual bool
142 IsStripped ();
143
144 virtual void
145 CreateSections (lldb_private::SectionList &unified_section_list);
Stephen Wilsonf325ba92010-07-13 23:07:23 +0000146
147 virtual void
148 Dump(lldb_private::Stream *s);
149
150 virtual bool
Greg Clayton514487e2011-02-15 21:59:32 +0000151 GetArchitecture (lldb_private::ArchSpec &arch);
Stephen Wilsonf325ba92010-07-13 23:07:23 +0000152
153 virtual bool
154 GetUUID(lldb_private::UUID* uuid);
155
Michael Sartaina7499c92013-07-01 19:45:50 +0000156 virtual lldb_private::FileSpecList
157 GetDebugSymbolFilePaths();
158
Stephen Wilsonf325ba92010-07-13 23:07:23 +0000159 virtual uint32_t
160 GetDependentModules(lldb_private::FileSpecList& files);
161
Stephen Wilson2ab0a582011-01-15 00:08:44 +0000162 virtual lldb_private::Address
Ed Maste54803652013-10-11 17:39:07 +0000163 GetImageInfoAddress(lldb_private::Target *target);
Jim Ingham672e6f52011-03-07 23:44:08 +0000164
165 virtual lldb_private::Address
166 GetEntryPointAddress ();
Greg Clayton9e00b6a652011-07-09 00:41:34 +0000167
168 virtual ObjectFile::Type
169 CalculateType();
170
171 virtual ObjectFile::Strata
172 CalculateStrata();
Stephen Wilson2ab0a582011-01-15 00:08:44 +0000173
Ashok Thirumurthi4822d922013-07-11 20:39:00 +0000174 // Returns number of program headers found in the ELF file.
175 size_t
176 GetProgramHeaderCount();
177
178 // Returns the program header with the given index.
179 const elf::ELFProgramHeader *
180 GetProgramHeaderByIndex(lldb::user_id_t id);
181
182 // Returns segment data for the given index.
183 lldb_private::DataExtractor
184 GetSegmentDataByIndex(lldb::user_id_t id);
185
Stephen Wilsonf325ba92010-07-13 23:07:23 +0000186private:
Greg Claytone72dfb32012-02-24 01:59:29 +0000187 ObjectFileELF(const lldb::ModuleSP &module_sp,
Greg Clayton5ce9c562013-02-06 17:22:03 +0000188 lldb::DataBufferSP& data_sp,
189 lldb::offset_t data_offset,
Stephen Wilsonf325ba92010-07-13 23:07:23 +0000190 const lldb_private::FileSpec* file,
Greg Clayton5ce9c562013-02-06 17:22:03 +0000191 lldb::offset_t offset,
192 lldb::offset_t length);
Stephen Wilsonf325ba92010-07-13 23:07:23 +0000193
Andrew MacPherson17220c12014-03-05 10:12:43 +0000194 ObjectFileELF (const lldb::ModuleSP &module_sp,
195 lldb::DataBufferSP& data_sp,
196 const lldb::ProcessSP &process_sp,
197 lldb::addr_t header_addr);
198
Stephen Wilsonf325ba92010-07-13 23:07:23 +0000199 typedef std::vector<elf::ELFProgramHeader> ProgramHeaderColl;
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000200 typedef ProgramHeaderColl::iterator ProgramHeaderCollIter;
201 typedef ProgramHeaderColl::const_iterator ProgramHeaderCollConstIter;
202
Michael Sartaina7499c92013-07-01 19:45:50 +0000203 struct ELFSectionHeaderInfo : public elf::ELFSectionHeader
204 {
205 lldb_private::ConstString section_name;
206 };
207 typedef std::vector<ELFSectionHeaderInfo> SectionHeaderColl;
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000208 typedef SectionHeaderColl::iterator SectionHeaderCollIter;
209 typedef SectionHeaderColl::const_iterator SectionHeaderCollConstIter;
210
Stephen Wilson499b40e2011-03-30 16:07:05 +0000211 typedef std::vector<elf::ELFDynamic> DynamicSymbolColl;
212 typedef DynamicSymbolColl::iterator DynamicSymbolCollIter;
213 typedef DynamicSymbolColl::const_iterator DynamicSymbolCollConstIter;
214
Stephen Wilsonf325ba92010-07-13 23:07:23 +0000215 /// Version of this reader common to all plugins based on this class.
216 static const uint32_t m_plugin_version = 1;
217
218 /// ELF file header.
219 elf::ELFHeader m_header;
220
Michael Sartaina7499c92013-07-01 19:45:50 +0000221 /// ELF build ID.
Michael Sartainc836ae72013-05-23 20:57:03 +0000222 lldb_private::UUID m_uuid;
223
Michael Sartaina7499c92013-07-01 19:45:50 +0000224 /// ELF .gnu_debuglink file and crc data if available.
225 std::string m_gnu_debuglink_file;
226 uint32_t m_gnu_debuglink_crc;
227
Stephen Wilsonf325ba92010-07-13 23:07:23 +0000228 /// Collection of program headers.
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000229 ProgramHeaderColl m_program_headers;
Stephen Wilsonf325ba92010-07-13 23:07:23 +0000230
231 /// Collection of section headers.
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000232 SectionHeaderColl m_section_headers;
Stephen Wilsonf325ba92010-07-13 23:07:23 +0000233
Stephen Wilson499b40e2011-03-30 16:07:05 +0000234 /// Collection of symbols from the dynamic table.
235 DynamicSymbolColl m_dynamic_symbols;
236
Stephen Wilsonf325ba92010-07-13 23:07:23 +0000237 /// List of file specifications corresponding to the modules (shared
238 /// libraries) on which this object file depends.
Greg Clayton7b0992d2013-04-18 22:45:39 +0000239 mutable std::unique_ptr<lldb_private::FileSpecList> m_filespec_ap;
Stephen Wilsonf325ba92010-07-13 23:07:23 +0000240
Jim Ingham672e6f52011-03-07 23:44:08 +0000241 /// Cached value of the entry point for this module.
242 lldb_private::Address m_entry_point_address;
Stephen Wilson499b40e2011-03-30 16:07:05 +0000243
Stephen Wilsonf325ba92010-07-13 23:07:23 +0000244 /// Returns a 1 based index of the given section header.
Greg Claytonc7bece562013-01-25 18:06:21 +0000245 size_t
Stephen Wilsonf325ba92010-07-13 23:07:23 +0000246 SectionIndex(const SectionHeaderCollIter &I);
247
248 /// Returns a 1 based index of the given section header.
Greg Claytonc7bece562013-01-25 18:06:21 +0000249 size_t
Stephen Wilsonf325ba92010-07-13 23:07:23 +0000250 SectionIndex(const SectionHeaderCollConstIter &I) const;
251
252 /// Parses all section headers present in this object file and populates
253 /// m_program_headers. This method will compute the header list only once.
254 /// Returns the number of headers parsed.
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000255 size_t
Stephen Wilsonf325ba92010-07-13 23:07:23 +0000256 ParseProgramHeaders();
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000257
Stephen Wilsonf325ba92010-07-13 23:07:23 +0000258 /// Parses all section headers present in this object file and populates
259 /// m_section_headers. This method will compute the header list only once.
260 /// Returns the number of headers parsed.
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000261 size_t
Stephen Wilsonf325ba92010-07-13 23:07:23 +0000262 ParseSectionHeaders();
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000263
Michael Sartaina7499c92013-07-01 19:45:50 +0000264 /// Parses the elf section headers and returns the uuid, debug link name, crc.
265 static size_t
266 GetSectionHeaderInfo(SectionHeaderColl &section_headers,
267 lldb_private::DataExtractor &data,
268 const elf::ELFHeader &header,
269 lldb_private::UUID &uuid,
270 std::string &gnu_debuglink_file,
271 uint32_t &gnu_debuglink_crc);
272
Stephen Wilsonf325ba92010-07-13 23:07:23 +0000273 /// Scans the dynamic section and locates all dependent modules (shared
Greg Clayton710dd5a2011-01-08 20:28:42 +0000274 /// libraries) populating m_filespec_ap. This method will compute the
Stephen Wilsonf325ba92010-07-13 23:07:23 +0000275 /// dependent module list only once. Returns the number of dependent
276 /// modules parsed.
277 size_t
278 ParseDependentModules();
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000279
Stephen Wilson499b40e2011-03-30 16:07:05 +0000280 /// Parses the dynamic symbol table and populates m_dynamic_symbols. The
281 /// vector retains the order as found in the object file. Returns the
282 /// number of dynamic symbols parsed.
283 size_t
284 ParseDynamicSymbols();
285
Stephen Wilsonf325ba92010-07-13 23:07:23 +0000286 /// Populates m_symtab_ap will all non-dynamic linker symbols. This method
287 /// will parse the symbols only once. Returns the number of symbols parsed.
Stephen Wilson499b40e2011-03-30 16:07:05 +0000288 unsigned
Stephen Wilsonf325ba92010-07-13 23:07:23 +0000289 ParseSymbolTable(lldb_private::Symtab *symbol_table,
Stephen Wilson499b40e2011-03-30 16:07:05 +0000290 lldb::user_id_t start_id,
Greg Clayton3046e662013-07-10 01:23:25 +0000291 lldb_private::Section *symtab);
Stephen Wilsonf325ba92010-07-13 23:07:23 +0000292
Michael Sartaina7499c92013-07-01 19:45:50 +0000293 /// Helper routine for ParseSymbolTable().
294 unsigned
295 ParseSymbols(lldb_private::Symtab *symbol_table,
296 lldb::user_id_t start_id,
297 lldb_private::SectionList *section_list,
Greg Clayton3046e662013-07-10 01:23:25 +0000298 const size_t num_symbols,
Michael Sartaina7499c92013-07-01 19:45:50 +0000299 const lldb_private::DataExtractor &symtab_data,
300 const lldb_private::DataExtractor &strtab_data);
301
Stephen Wilson499b40e2011-03-30 16:07:05 +0000302 /// Scans the relocation entries and adds a set of artificial symbols to the
303 /// given symbol table for each PLT slot. Returns the number of symbols
304 /// added.
305 unsigned
306 ParseTrampolineSymbols(lldb_private::Symtab *symbol_table,
307 lldb::user_id_t start_id,
Michael Sartaina7499c92013-07-01 19:45:50 +0000308 const ELFSectionHeaderInfo *rela_hdr,
Stephen Wilson499b40e2011-03-30 16:07:05 +0000309 lldb::user_id_t section_id);
310
Andrew MacPherson17220c12014-03-05 10:12:43 +0000311 /// Relocates debug sections
312 unsigned
313 RelocateDebugSections(const elf::ELFSectionHeader *rel_hdr, lldb::user_id_t rel_id);
314
315 unsigned
316 RelocateSection(lldb_private::Symtab* symtab, const elf::ELFHeader *hdr, const elf::ELFSectionHeader *rel_hdr,
317 const elf::ELFSectionHeader *symtab_hdr, const elf::ELFSectionHeader *debug_hdr,
318 lldb_private::DataExtractor &rel_data, lldb_private::DataExtractor &symtab_data,
319 lldb_private::DataExtractor &debug_data, lldb_private::Section* rel_section);
320
321 /// Loads the section name string table into m_shstr_data. Returns the
322 /// number of bytes constituting the table.
323 size_t
324 GetSectionHeaderStringTable();
325
326 /// Utility method for looking up a section given its name. Returns the
327 /// index of the corresponding section or zero if no section with the given
328 /// name can be found (note that section indices are always 1 based, and so
329 /// section index 0 is never valid).
330 lldb::user_id_t
331 GetSectionIndexByName(const char *name);
332
333 // Returns the ID of the first section that has the given type.
334 lldb::user_id_t
335 GetSectionIndexByType(unsigned type);
336
Stephen Wilson499b40e2011-03-30 16:07:05 +0000337 /// Returns the section header with the given id or NULL.
Michael Sartaina7499c92013-07-01 19:45:50 +0000338 const ELFSectionHeaderInfo *
Stephen Wilson499b40e2011-03-30 16:07:05 +0000339 GetSectionHeaderByIndex(lldb::user_id_t id);
340
Stephen Wilsonf325ba92010-07-13 23:07:23 +0000341 /// @name ELF header dump routines
342 //@{
343 static void
344 DumpELFHeader(lldb_private::Stream *s, const elf::ELFHeader& header);
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000345
346 static void
Stephen Wilsonf325ba92010-07-13 23:07:23 +0000347 DumpELFHeader_e_ident_EI_DATA(lldb_private::Stream *s,
348 unsigned char ei_data);
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000349
350 static void
Stephen Wilsonf325ba92010-07-13 23:07:23 +0000351 DumpELFHeader_e_type(lldb_private::Stream *s, elf::elf_half e_type);
352 //@}
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000353
Stephen Wilsonf325ba92010-07-13 23:07:23 +0000354 /// @name ELF program header dump routines
355 //@{
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000356 void
Stephen Wilsonf325ba92010-07-13 23:07:23 +0000357 DumpELFProgramHeaders(lldb_private::Stream *s);
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000358
359 static void
Stephen Wilsonf325ba92010-07-13 23:07:23 +0000360 DumpELFProgramHeader(lldb_private::Stream *s,
361 const elf::ELFProgramHeader &ph);
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000362
363 static void
Stephen Wilsonf325ba92010-07-13 23:07:23 +0000364 DumpELFProgramHeader_p_type(lldb_private::Stream *s, elf::elf_word p_type);
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000365
366 static void
Stephen Wilsonf325ba92010-07-13 23:07:23 +0000367 DumpELFProgramHeader_p_flags(lldb_private::Stream *s,
368 elf::elf_word p_flags);
369 //@}
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000370
Stephen Wilsonf325ba92010-07-13 23:07:23 +0000371 /// @name ELF section header dump routines
372 //@{
373 void
374 DumpELFSectionHeaders(lldb_private::Stream *s);
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000375
Stephen Wilsonf325ba92010-07-13 23:07:23 +0000376 static void
377 DumpELFSectionHeader(lldb_private::Stream *s,
Michael Sartaina7499c92013-07-01 19:45:50 +0000378 const ELFSectionHeaderInfo& sh);
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000379
Stephen Wilsonf325ba92010-07-13 23:07:23 +0000380 static void
381 DumpELFSectionHeader_sh_type(lldb_private::Stream *s,
382 elf::elf_word sh_type);
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000383
Stephen Wilsonf325ba92010-07-13 23:07:23 +0000384 static void
385 DumpELFSectionHeader_sh_flags(lldb_private::Stream *s,
Greg Claytonc7bece562013-01-25 18:06:21 +0000386 elf::elf_xword sh_flags);
Stephen Wilsonf325ba92010-07-13 23:07:23 +0000387 //@}
388
389 /// ELF dependent module dump routine.
390 void
391 DumpDependentModules(lldb_private::Stream *s);
392
Stephen Wilson499b40e2011-03-30 16:07:05 +0000393 const elf::ELFDynamic *
394 FindDynamicSymbol(unsigned tag);
395
Stephen Wilson499b40e2011-03-30 16:07:05 +0000396 unsigned
397 PLTRelocationType();
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000398};
399
400#endif // #ifndef liblldb_ObjectFileELF_h_