LIEF: Library to Instrument Executable Formats Version 0.17.0
Loading...
Searching...
No Matches
ELF/Parser.hpp
Go to the documentation of this file.
1/* Copyright 2017 - 2025 R. Thomas
2 * Copyright 2017 - 2025 Quarkslab
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16#ifndef LIEF_ELF_PARSER_H
17#define LIEF_ELF_PARSER_H
18#include <unordered_map>
19
20#include "LIEF/visibility.h"
21#include "LIEF/utils.hpp"
22
24#include "LIEF/errors.hpp"
25#include "LIEF/ELF/enums.hpp"
26
28
29namespace LIEF {
30class BinaryStream;
31
32namespace OAT {
33class Parser;
34}
35namespace ELF {
36
37class Section;
38class Binary;
39class Segment;
40class Symbol;
41class Note;
42class Relocation;
43
46 friend class OAT::Parser;
47 public:
48 static constexpr uint32_t NB_MAX_SYMBOLS = 1000000;
49 static constexpr uint32_t DELTA_NB_SYMBOLS = 3000;
50 static constexpr uint32_t NB_MAX_BUCKETS = NB_MAX_SYMBOLS;
51 static constexpr uint32_t NB_MAX_CHAINS = 1000000;
52 static constexpr uint32_t NB_MAX_SEGMENTS = 10000;
53 static constexpr uint32_t NB_MAX_RELOCATIONS = 3000000;
54 static constexpr uint32_t NB_MAX_DYNAMIC_ENTRIES = 1000;
55 static constexpr uint32_t MAX_SEGMENT_SIZE = 3_GB;
56
61
70 static std::unique_ptr<Binary> parse(const std::string& file,
71 const ParserConfig& conf = ParserConfig::all());
72
81 static std::unique_ptr<Binary> parse(const std::vector<uint8_t>& data,
82 const ParserConfig& conf = ParserConfig::all());
83
92 static std::unique_ptr<Binary> parse(std::unique_ptr<BinaryStream> stream,
93 const ParserConfig& conf = ParserConfig::all());
94
95 Parser& operator=(const Parser&) = delete;
96 Parser(const Parser&) = delete;
97
98 ~Parser() override;
99
100 protected:
102 LIEF_LOCAL Parser(std::unique_ptr<BinaryStream> stream, ParserConfig config);
103 LIEF_LOCAL Parser(const std::string& file, ParserConfig config);
104 LIEF_LOCAL Parser(const std::vector<uint8_t>& data, ParserConfig config);
105
106 LIEF_LOCAL ok_error_t init();
107
108 LIEF_LOCAL bool should_swap() const;
109
110 // map, dynamic_symbol.version <----> symbol_version
111 // symbol_version comes from symbol_version table
112 LIEF_LOCAL void link_symbol_version();
113
114 LIEF_LOCAL ok_error_t link_symbol_section(Symbol& sym);
115
116 template<typename ELF_T>
117 LIEF_LOCAL ok_error_t parse_binary();
118
119 template<typename ELF_T>
120 LIEF_LOCAL ok_error_t parse_header();
121
122 template<typename ELF_T>
123 LIEF_LOCAL ok_error_t parse_sections();
124
125 template<typename ELF_T>
126 LIEF_LOCAL ok_error_t parse_segments();
127
128 LIEF_LOCAL uint64_t get_dynamic_string_table(BinaryStream* stream = nullptr) const;
129
130 LIEF_LOCAL result<uint64_t> get_dynamic_string_table_from_segments(BinaryStream* stream = nullptr) const;
131
132 LIEF_LOCAL uint64_t get_dynamic_string_table_from_sections() const;
133
135 template<typename ELF_T>
137 get_numberof_dynamic_symbols(ParserConfig::DYNSYM_COUNT mtd) const;
138
140 template<typename ELF_T>
141 LIEF_LOCAL result<uint32_t> nb_dynsym_hash() const;
142
144 template<typename ELF_T>
145 LIEF_LOCAL result<uint32_t> nb_dynsym_sysv_hash() const;
146
148 template<typename ELF_T>
149 LIEF_LOCAL result<uint32_t> nb_dynsym_gnu_hash() const;
150
152 template<typename ELF_T>
153 LIEF_LOCAL result<uint32_t> nb_dynsym_section() const;
154
156 template<typename ELF_T>
157 LIEF_LOCAL result<uint32_t> nb_dynsym_relocations() const;
158
159 template<typename ELF_T>
160 LIEF_LOCAL ok_error_t parse_dynamic_entries(BinaryStream& stream);
161
162 template<typename ELF_T>
163 LIEF_LOCAL ok_error_t parse_dynamic_symbols(uint64_t offset);
164
173 template<typename ELF_T>
175 parse_symtab_symbols(uint64_t offset, uint32_t nb_symbols,
176 const Section& string_section);
177
181 template<typename ELF_T, typename REL_T>
183 parse_dynamic_relocations(uint64_t relocations_offset, uint64_t size);
184
190 template<typename ELF_T, typename REL_T>
191 LIEF_LOCAL ok_error_t parse_pltgot_relocations(uint64_t offset, uint64_t size);
192
193
195 template<typename ELF_T>
196 LIEF_LOCAL ok_error_t parse_relative_relocations(uint64_t offset, uint64_t size);
197
199 template<typename ELF_T>
200 LIEF_LOCAL ok_error_t parse_packed_relocations(uint64_t offset, uint64_t size);
201
202 template<typename ELF_T>
203 LIEF_LOCAL ok_error_t process_dynamic_table();
204
207 template<typename ELF_T, typename REL_T>
209 parse_section_relocations(const Section& section);
210
216 template<typename ELF_T>
218 parse_symbol_version_requirement(uint64_t offset, uint32_t nb_entries);
219
220
226 template<typename ELF_T>
228 parse_symbol_version_definition(uint64_t offset, uint32_t nb_entries);
229
230
237 LIEF_LOCAL ok_error_t parse_symbol_version(uint64_t symbol_version_offset);
238
242 template<typename ELF_T>
243 LIEF_LOCAL ok_error_t parse_symbol_gnu_hash(uint64_t offset);
244
246 LIEF_LOCAL ok_error_t parse_notes(uint64_t offset, uint64_t size);
247
248 LIEF_LOCAL std::unique_ptr<Note>
249 get_note(uint32_t type, std::string name, std::vector<uint8_t> desc_bytes);
250
252 LIEF_LOCAL ok_error_t parse_symbol_sysv_hash(uint64_t offset);
253
254 LIEF_LOCAL ok_error_t parse_overlay();
255
256 template<typename ELF_T, typename REL_T>
257 LIEF_LOCAL uint32_t max_relocation_index(uint64_t relocations_offset, uint64_t size) const;
258
260 LIEF_LOCAL static bool check_section_in_segment(const Section& section, const Segment& segment);
261
262 LIEF_LOCAL bool bind_symbol(Relocation& R);
263 LIEF_LOCAL Relocation& insert_relocation(std::unique_ptr<Relocation> R);
264
265 template<class ELF_T>
266 LIEF_LOCAL ok_error_t parse_dyn_table(Segment& pt_dyn);
267
268 std::unique_ptr<BinaryStream> stream_;
269 std::unique_ptr<Binary> binary_;
270 ParserConfig config_;
271 /*
272 * parse_sections() may skip some sections so that
273 * binary_->sections_ is not contiguous based on the index of the sections.
274 *
275 * On the other hand, we need these indexes to bind symbols that
276 * reference sections. That's why we have this unordered_map.
277 */
278 std::unordered_map<size_t, Section*> sections_idx_;
279};
280
281} // namespace ELF
282} // namespace LIEF
283#endif
Class that is used to a read stream of data from different sources.
Definition BinaryStream.hpp:33
Generic interface representing a binary executable.
Definition Abstract/Binary.hpp:59
static constexpr uint32_t NB_MAX_BUCKETS
Definition ELF/Parser.hpp:50
friend class OAT::Parser
Definition ELF/Parser.hpp:46
static constexpr uint32_t NB_MAX_SYMBOLS
Definition ELF/Parser.hpp:48
static std::unique_ptr< Binary > parse(std::unique_ptr< BinaryStream > stream, const ParserConfig &conf=ParserConfig::all())
Parse the ELF binary from the given stream and return a LIEF::ELF::Binary object.
static constexpr uint32_t DELTA_NB_SYMBOLS
Definition ELF/Parser.hpp:49
static constexpr uint32_t NB_MAX_RELOCATIONS
Definition ELF/Parser.hpp:53
static std::unique_ptr< Binary > parse(const std::vector< uint8_t > &data, const ParserConfig &conf=ParserConfig::all())
Parse the given raw data as an ELF binary and return a LIEF::ELF::Binary object.
static std::unique_ptr< Binary > parse(const std::string &file, const ParserConfig &conf=ParserConfig::all())
Parse an ELF file and return a LIEF::ELF::Binary object.
static constexpr uint32_t NB_MAX_CHAINS
Definition ELF/Parser.hpp:51
~Parser() override
ELF_TYPE
Definition ELF/Parser.hpp:57
@ ELF64
Definition ELF/Parser.hpp:59
@ ELF_UNKNOWN
Definition ELF/Parser.hpp:58
@ ELF32
Definition ELF/Parser.hpp:59
static constexpr uint32_t MAX_SEGMENT_SIZE
Definition ELF/Parser.hpp:55
Parser(const Parser &)=delete
Parser & operator=(const Parser &)=delete
static constexpr uint32_t NB_MAX_SEGMENTS
Definition ELF/Parser.hpp:52
static constexpr uint32_t NB_MAX_DYNAMIC_ENTRIES
Definition ELF/Parser.hpp:54
Class that represents an ELF relocation.
Definition ELF/Relocation.hpp:40
Class which represents an ELF Section.
Definition ELF/Section.hpp:48
Class which represents the ELF segments.
Definition Segment.hpp:48
Class which represents an ELF symbol.
Definition ELF/Symbol.hpp:35
Class to parse an OAT file to produce an OAT::Binary.
Definition OAT/Parser.hpp:38
Main interface to parse an executable regardless of its format.
Definition Abstract/Parser.hpp:30
Class which represents an abstracted Relocation.
Definition Abstract/Relocation.hpp:27
Class which represents an abstracted section.
Definition Abstract/Section.hpp:29
This class represents a symbol in an executable format.
Definition Abstract/Symbol.hpp:28
Opaque structure that is used by LIEF to avoid writing result<void> f(...). Instead,...
Definition errors.hpp:112
Wrapper that contains an Object (T) or an error.
Definition errors.hpp:75
Namespace related to the LIEF's ELF module.
Definition Abstract/Header.hpp:28
Definition ELF/Parser.hpp:32
LIEF namespace.
Definition Abstract/Binary.hpp:40
This structure is used to tweak the ELF Parser (ELF::Parser).
Definition ELF/ParserConfig.hpp:25
DYNSYM_COUNT
Definition ELF/ParserConfig.hpp:28
static ParserConfig all()
This returns a ParserConfig object configured to process all the ELF elements.
Definition ELF/ParserConfig.hpp:37
#define LIEF_API
Definition visibility.h:41
#define LIEF_LOCAL
Definition visibility.h:42