LIEF: Library to Instrument Executable Formats Version 2.0.0
Loading...
Searching...
No Matches
AuxiliaryFunctionDefinition.hpp
Go to the documentation of this file.
1/* Copyright 2017 - 2026 R. Thomas
2 *
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15#ifndef LIEF_COFF_AUXILIARY_FUNCTION_DEF_H
16#define LIEF_COFF_AUXILIARY_FUNCTION_DEF_H
17
18#include <memory>
19
21#include "LIEF/visibility.h"
22
23
24namespace LIEF::COFF {
25
31 public:
32 LIEF_LOCAL static std::unique_ptr<AuxiliaryFunctionDefinition>
33 parse(const std::vector<uint8_t>& payload);
34
37
38 AuxiliaryFunctionDefinition(uint32_t tagidx, uint32_t totalsz, uint32_t ptr_line,
39 uint32_t ptr_next_func, uint16_t padding) :
41 tag_index_(tagidx),
42 total_size_(totalsz),
43 ptr_to_linenb_(ptr_line),
44 ptr_to_next_func_(ptr_next_func),
45 padding_(padding) {}
46
50
53
54 std::unique_ptr<AuxiliarySymbol> clone() const override {
55 return std::make_unique<AuxiliaryFunctionDefinition>(*this);
56 }
57
60 uint32_t tag_index() const {
61 return tag_index_;
62 }
63
69 uint32_t total_size() const {
70 return total_size_;
71 }
72
75 uint32_t ptr_to_line_number() const {
76 return ptr_to_linenb_;
77 }
78
81 uint32_t ptr_to_next_func() const {
82 return ptr_to_next_func_;
83 }
84
86 uint16_t padding() const {
87 return padding_;
88 }
89
90 std::string to_string() const override;
91
92 static bool classof(const AuxiliarySymbol* sym) {
94 }
95
96 ~AuxiliaryFunctionDefinition() override = default;
97
98 private:
99 uint32_t tag_index_ = 0;
100 uint32_t total_size_ = 0;
101 uint32_t ptr_to_linenb_ = 0;
102 uint32_t ptr_to_next_func_ = 0;
103 uint16_t padding_ = 0;
104};
105
106}
107
108#endif
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:81
AuxiliaryFunctionDefinition(uint32_t tagidx, uint32_t totalsz, uint32_t ptr_line, uint32_t ptr_next_func, uint16_t padding)
Definition AuxiliaryFunctionDefinition.hpp:38
AuxiliaryFunctionDefinition(const AuxiliaryFunctionDefinition &)=default
AuxiliaryFunctionDefinition(AuxiliaryFunctionDefinition &&)=default
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:75
AuxiliaryFunctionDefinition & operator=(AuxiliaryFunctionDefinition &&)=default
static std::unique_ptr< AuxiliaryFunctionDefinition > parse(const std::vector< uint8_t > &payload)
AuxiliaryFunctionDefinition()
Definition AuxiliaryFunctionDefinition.hpp:35
uint16_t padding() const
Padding value (should be 0).
Definition AuxiliaryFunctionDefinition.hpp:86
~AuxiliaryFunctionDefinition() override=default
std::string to_string() const override
static bool classof(const AuxiliarySymbol *sym)
Definition AuxiliaryFunctionDefinition.hpp:92
uint32_t total_size() const
The size of the executable code for the function itself.
Definition AuxiliaryFunctionDefinition.hpp:69
std::unique_ptr< AuxiliarySymbol > clone() const override
Definition AuxiliaryFunctionDefinition.hpp:54
AuxiliaryFunctionDefinition & operator=(const AuxiliaryFunctionDefinition &)=default
uint32_t tag_index() const
The symbol-table index of the corresponding .bf (begin function) symbol record.
Definition AuxiliaryFunctionDefinition.hpp:60
span< const uint8_t > payload() const
For unknown type only, return the raw representation of this symbol.
Definition AuxiliarySymbol.hpp:84
TYPE type() const
Definition AuxiliarySymbol.hpp:79
TYPE
Type discriminator for the subclasses.
Definition AuxiliarySymbol.hpp:55
@ FUNC_DEF
Auxiliary Format 1 from the PE-COFF documentation.
Definition AuxiliarySymbol.hpp:59
Definition AuxiliarySymbol.hpp:29
#define LIEF_API
Definition visibility.h:44
#define LIEF_LOCAL
Definition visibility.h:45