LIEF: Library to Instrument Executable Formats Version 0.17.0
Loading...
Searching...
No Matches
AuxiliarySymbol.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_SYMBOL_H
17#define LIEF_PE_AUXILIARY_SYMBOL_H
18
19#include <ostream>
20#include <memory>
21#include <vector>
22
23#include "LIEF/visibility.h"
24#include "LIEF/span.hpp"
25
26namespace LIEF {
27class BinaryStream;
28
29namespace PE {
30class Symbol;
37 public:
38 AuxiliarySymbol() = default;
39 AuxiliarySymbol(std::vector<uint8_t> payload) :
40 type_(TYPE::UNKNOWN),
41 payload_(std::move(payload))
42 {}
43 AuxiliarySymbol(const AuxiliarySymbol&) = default;
44 AuxiliarySymbol& operator=(const AuxiliarySymbol&) = default;
45
46 AuxiliarySymbol(AuxiliarySymbol&&) = default;
47 AuxiliarySymbol& operator=(AuxiliarySymbol&&) = default;
48
49 LIEF_LOCAL static std::unique_ptr<AuxiliarySymbol>
50 parse(Symbol& sym, std::vector<uint8_t> payload);
51
52 virtual std::unique_ptr<AuxiliarySymbol> clone() const {
53 return std::unique_ptr<AuxiliarySymbol>(new AuxiliarySymbol(*this));
54 }
55 enum class TYPE {
58 UNKNOWN = 0,
59 CLR_TOKEN, FUNC_DEF, BF_AND_EF, WEAK_EXTERNAL, FILE, SEC_DEF,
70 };
71
72 AuxiliarySymbol(TYPE ty) :
73 type_(ty)
74 {}
75
76 static TYPE get_aux_type(const Symbol& sym);
77
78 TYPE type() const {
79 return type_;
80 }
81 span<const uint8_t> payload() const {
84 return payload_;
85 }
86
87 span<uint8_t> payload() {
88 return payload_;
89 }
90
91 virtual std::string to_string() const;
92
93 virtual ~AuxiliarySymbol() = default;
94 template<class T>
97 const T* as() const {
98 static_assert(std::is_base_of<AuxiliarySymbol, T>::value,
99 "Require AuxiliarySymbol inheritance");
100 if (T::classof(this)) {
101 return static_cast<const T*>(this);
102 }
103 return nullptr;
104 }
105
106 LIEF_API friend
107 std::ostream& operator<<(std::ostream& os, const AuxiliarySymbol& aux)
108 {
109 os << aux.to_string();
110 return os;
111 }
112
113 protected:
114 TYPE type_ = TYPE::UNKNOWN;
115 std::vector<uint8_t> payload_;
116};
117
118}
119}
120#endif
LIEF::BinaryStream
Class that is used to a read stream of data from different sources.
Definition BinaryStream.hpp:33
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::AuxiliarySymbol::to_string
virtual std::string to_string() const
LIEF::PE::AuxiliarySymbol::operator=
AuxiliarySymbol & operator=(const AuxiliarySymbol &)=default
LIEF::PE::AuxiliarySymbol::get_aux_type
static TYPE get_aux_type(const Symbol &sym)
LIEF::PE::AuxiliarySymbol::clone
virtual std::unique_ptr< AuxiliarySymbol > clone() const
Definition AuxiliarySymbol.hpp:52
LIEF::PE::AuxiliarySymbol::AuxiliarySymbol
AuxiliarySymbol(AuxiliarySymbol &&)=default
LIEF::PE::AuxiliarySymbol::~AuxiliarySymbol
virtual ~AuxiliarySymbol()=default
LIEF::PE::AuxiliarySymbol::AuxiliarySymbol
AuxiliarySymbol()=default
LIEF::PE::AuxiliarySymbol::operator=
AuxiliarySymbol & operator=(AuxiliarySymbol &&)=default
LIEF::PE::AuxiliarySymbol::operator<<
friend std::ostream & operator<<(std::ostream &os, const AuxiliarySymbol &aux)
Definition AuxiliarySymbol.hpp:107
LIEF::PE::AuxiliarySymbol::AuxiliarySymbol
AuxiliarySymbol(TYPE ty)
Definition AuxiliarySymbol.hpp:72
LIEF::PE::AuxiliarySymbol::AuxiliarySymbol
AuxiliarySymbol(const AuxiliarySymbol &)=default
LIEF::PE::AuxiliarySymbol::parse
static std::unique_ptr< AuxiliarySymbol > parse(Symbol &sym, std::vector< uint8_t > payload)
LIEF::PE::AuxiliarySymbol::AuxiliarySymbol
AuxiliarySymbol(std::vector< uint8_t > payload)
Definition AuxiliarySymbol.hpp:39
LIEF::PE::AuxiliarySymbol::as
const T * as() const
Helper to downcast a AuxiliarySymbol into a concrete implementation.
Definition AuxiliarySymbol.hpp:97
LIEF::PE::AuxiliarySymbol::payload
span< const uint8_t > payload() const
For unknown type only, return the raw representation of this symbol.
Definition AuxiliarySymbol.hpp:83
LIEF::PE::AuxiliarySymbol::payload
span< uint8_t > payload()
Definition AuxiliarySymbol.hpp:87
LIEF::PE::Symbol
Class that represents a PE-COFF symbol.
Definition PE/Symbol.hpp:50
LIEF::PE
Namespace related to the LIEF's PE module.
Definition Abstract/Header.hpp:32
LIEF::PE::ACCELERATOR_CODES::T
@ T
Definition AcceleratorCodes.hpp:97
LIEF
LIEF namespace.
Definition Abstract/Binary.hpp:36
span.hpp
visibility.h
LIEF_API
#define LIEF_API
Definition visibility.h:41
LIEF_LOCAL
#define LIEF_LOCAL
Definition visibility.h:42