LIEF: Library to Instrument Executable Formats Version 0.17.0
Loading...
Searching...
No Matches
AuxiliaryFunctionDefinition.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_PE_AUXILIARY_FUNCTION_DEF_H
17#define LIEF_PE_AUXILIARY_FUNCTION_DEF_H
18
19#include <memory>
20
21#include "LIEF/visibility.h"
23
24namespace LIEF {
25
26namespace PE {
32 public:
33 LIEF_LOCAL static std::unique_ptr<AuxiliaryFunctionDefinition>
34 parse(const std::vector<uint8_t>& payload);
35
37 AuxiliarySymbol(AuxiliarySymbol::TYPE::FUNC_DEF)
38 {}
39
40 AuxiliaryFunctionDefinition(uint32_t tagidx, uint32_t totalsz,
41 uint32_t ptr_line, uint32_t ptr_next_func,
42 uint16_t padding) :
43 AuxiliarySymbol(AuxiliarySymbol::TYPE::FUNC_DEF),
44 tag_index_(tagidx),
45 total_size_(totalsz),
46 ptr_to_linenb_(ptr_line),
47 ptr_to_next_func_(ptr_next_func),
48 padding_(padding)
49 {}
50
51 AuxiliaryFunctionDefinition(const AuxiliaryFunctionDefinition&) = default;
52 AuxiliaryFunctionDefinition& operator=(const AuxiliaryFunctionDefinition&) = default;
53
54 AuxiliaryFunctionDefinition(AuxiliaryFunctionDefinition&&) = default;
55 AuxiliaryFunctionDefinition& operator=(AuxiliaryFunctionDefinition&&) = default;
56
57 std::unique_ptr<AuxiliarySymbol> clone() const override {
58 return std::unique_ptr<AuxiliaryFunctionDefinition>(new AuxiliaryFunctionDefinition{*this});
59 }
60 uint32_t tag_index() const {
64 return tag_index_;
65 }
66 uint32_t total_size() const {
73 return total_size_;
74 }
75 uint32_t ptr_to_line_number() const {
79 return ptr_to_linenb_;
80 }
81 uint32_t ptr_to_next_func() const {
85 return ptr_to_next_func_;
86 }
87 uint16_t padding() const {
90 return padding_;
91 }
92
93 std::string to_string() const override;
94
95 static bool classof(const AuxiliarySymbol* sym) {
96 return sym->type() == AuxiliarySymbol::TYPE::FUNC_DEF;
97 }
98
99 ~AuxiliaryFunctionDefinition() override = default;
100
101 private:
102 uint32_t tag_index_ = 0;
103 uint32_t total_size_ = 0;
104 uint32_t ptr_to_linenb_ = 0;
105 uint32_t ptr_to_next_func_ = 0;
106 uint16_t padding_ = 0;
107};
108
109}
110}
111#endif
AuxiliarySymbol.hpp
LIEF::PE::AuxiliaryFunctionDefinition
This auxiliary symbols marks the beginning of a function definition.
Definition AuxiliaryFunctionDefinition.hpp:31
LIEF::PE::AuxiliaryFunctionDefinition::padding
uint16_t padding() const
Padding value (should be 0)
Definition AuxiliaryFunctionDefinition.hpp:89
LIEF::PE::AuxiliaryFunctionDefinition::tag_index
uint32_t tag_index() const
The symbol-table index of the corresponding .bf (begin function) symbol record.
Definition AuxiliaryFunctionDefinition.hpp:63
LIEF::PE::AuxiliaryFunctionDefinition::AuxiliaryFunctionDefinition
AuxiliaryFunctionDefinition(AuxiliaryFunctionDefinition &&)=default
LIEF::PE::AuxiliaryFunctionDefinition::ptr_to_line_number
uint32_t ptr_to_line_number() const
The file offset of the first COFF line-number entry for the function, or zero if none exists (depreca...
Definition AuxiliaryFunctionDefinition.hpp:78
LIEF::PE::AuxiliaryFunctionDefinition::operator=
AuxiliaryFunctionDefinition & operator=(const AuxiliaryFunctionDefinition &)=default
LIEF::PE::AuxiliaryFunctionDefinition::~AuxiliaryFunctionDefinition
~AuxiliaryFunctionDefinition() override=default
LIEF::PE::AuxiliaryFunctionDefinition::classof
static bool classof(const AuxiliarySymbol *sym)
Definition AuxiliaryFunctionDefinition.hpp:95
LIEF::PE::AuxiliaryFunctionDefinition::clone
std::unique_ptr< AuxiliarySymbol > clone() const override
Definition AuxiliaryFunctionDefinition.hpp:57
LIEF::PE::AuxiliaryFunctionDefinition::to_string
std::string to_string() const override
LIEF::PE::AuxiliaryFunctionDefinition::AuxiliaryFunctionDefinition
AuxiliaryFunctionDefinition(uint32_t tagidx, uint32_t totalsz, uint32_t ptr_line, uint32_t ptr_next_func, uint16_t padding)
Definition AuxiliaryFunctionDefinition.hpp:40
LIEF::PE::AuxiliaryFunctionDefinition::parse
static std::unique_ptr< AuxiliaryFunctionDefinition > parse(const std::vector< uint8_t > &payload)
LIEF::PE::AuxiliaryFunctionDefinition::ptr_to_next_func
uint32_t ptr_to_next_func() const
The symbol-table index of the record for the next function. If the function is the last in the symbol...
Definition AuxiliaryFunctionDefinition.hpp:84
LIEF::PE::AuxiliaryFunctionDefinition::total_size
uint32_t total_size() const
The size of the executable code for the function itself.
Definition AuxiliaryFunctionDefinition.hpp:72
LIEF::PE::AuxiliaryFunctionDefinition::AuxiliaryFunctionDefinition
AuxiliaryFunctionDefinition(const AuxiliaryFunctionDefinition &)=default
LIEF::PE::AuxiliaryFunctionDefinition::AuxiliaryFunctionDefinition
AuxiliaryFunctionDefinition()
Definition AuxiliaryFunctionDefinition.hpp:36
LIEF::PE::AuxiliaryFunctionDefinition::operator=
AuxiliaryFunctionDefinition & operator=(AuxiliaryFunctionDefinition &&)=default
LIEF::PE::AuxiliarySymbol
Class that represents an auxiliary symbol.
Definition AuxiliarySymbol.hpp:36
LIEF::PE::AuxiliarySymbol::type
TYPE type() const
Definition AuxiliarySymbol.hpp:78
LIEF::PE
Namespace related to the LIEF's PE module.
Definition Abstract/Header.hpp:32
LIEF
LIEF namespace.
Definition Abstract/Binary.hpp:36
visibility.h
LIEF_API
#define LIEF_API
Definition visibility.h:41
LIEF_LOCAL
#define LIEF_LOCAL
Definition visibility.h:42