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 * Copyright 2017 - 2026 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_COFF_AUXILIARY_FUNCTION_DEF_H
17#define LIEF_COFF_AUXILIARY_FUNCTION_DEF_H
18
19#include <memory>
20
22#include "LIEF/visibility.h"
23
24
25namespace LIEF::COFF {
26
32 public:
33 LIEF_LOCAL static std::unique_ptr<AuxiliaryFunctionDefinition>
34 parse(const std::vector<uint8_t>& payload);
35
38
39 AuxiliaryFunctionDefinition(uint32_t tagidx, uint32_t totalsz, uint32_t ptr_line,
40 uint32_t ptr_next_func, uint16_t padding) :
42 tag_index_(tagidx),
43 total_size_(totalsz),
44 ptr_to_linenb_(ptr_line),
45 ptr_to_next_func_(ptr_next_func),
46 padding_(padding) {}
47
51
54
55 std::unique_ptr<AuxiliarySymbol> clone() const override {
56 return std::make_unique<AuxiliaryFunctionDefinition>(*this);
57 }
58
61 uint32_t tag_index() const {
62 return tag_index_;
63 }
64
70 uint32_t total_size() const {
71 return total_size_;
72 }
73
76 uint32_t ptr_to_line_number() const {
77 return ptr_to_linenb_;
78 }
79
82 uint32_t ptr_to_next_func() const {
83 return ptr_to_next_func_;
84 }
85
87 uint16_t padding() const {
88 return padding_;
89 }
90
91 std::string to_string() const override;
92
93 static bool classof(const AuxiliarySymbol* sym) {
95 }
96
97 ~AuxiliaryFunctionDefinition() override = default;
98
99 private:
100 uint32_t tag_index_ = 0;
101 uint32_t total_size_ = 0;
102 uint32_t ptr_to_linenb_ = 0;
103 uint32_t ptr_to_next_func_ = 0;
104 uint16_t padding_ = 0;
105};
106
107}
108
109#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:82
AuxiliaryFunctionDefinition(uint32_t tagidx, uint32_t totalsz, uint32_t ptr_line, uint32_t ptr_next_func, uint16_t padding)
Definition AuxiliaryFunctionDefinition.hpp:39
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:76
AuxiliaryFunctionDefinition & operator=(AuxiliaryFunctionDefinition &&)=default
static std::unique_ptr< AuxiliaryFunctionDefinition > parse(const std::vector< uint8_t > &payload)
AuxiliaryFunctionDefinition()
Definition AuxiliaryFunctionDefinition.hpp:36
uint16_t padding() const
Padding value (should be 0).
Definition AuxiliaryFunctionDefinition.hpp:87
~AuxiliaryFunctionDefinition() override=default
std::string to_string() const override
static bool classof(const AuxiliarySymbol *sym)
Definition AuxiliaryFunctionDefinition.hpp:93
uint32_t total_size() const
The size of the executable code for the function itself.
Definition AuxiliaryFunctionDefinition.hpp:70
std::unique_ptr< AuxiliarySymbol > clone() const override
Definition AuxiliaryFunctionDefinition.hpp:55
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:61
span< const uint8_t > payload() const
For unknown type only, return the raw representation of this symbol.
Definition AuxiliarySymbol.hpp:85
TYPE type() const
Definition AuxiliarySymbol.hpp:80
TYPE
Type discriminator for the subclasses.
Definition AuxiliarySymbol.hpp:56
@ FUNC_DEF
Auxiliary Format 1 from the PE-COFF documentation.
Definition AuxiliarySymbol.hpp:60
Definition AuxiliarySymbol.hpp:30
#define LIEF_API
Definition visibility.h:45
#define LIEF_LOCAL
Definition visibility.h:46