16#ifndef LIEF_ELF_NOTE_H
17#define LIEF_ELF_NOTE_H
23#include "LIEF/Object.hpp"
24#include "LIEF/visibility.h"
25#include "LIEF/errors.hpp"
26#include "LIEF/span.hpp"
28#include "LIEF/ELF/Header.hpp"
65 GNU_BUILD_ATTRIBUTE_OPEN,
66 GNU_BUILD_ATTRIBUTE_FUNC,
104 CORE_TAGGED_ADDR_CTRL,
105 CORE_PAC_ENABLED_KEYS,
131 const std::string& name);
138 return type_to_section(note.
type());
148 const std::string& name, uint32_t type,
description_t description,
166 Note& operator=(
const Note& copy) =
default;
169 ~Note()
override =
default;
172 virtual std::unique_ptr<Note>
clone()
const {
173 return std::unique_ptr<Note>(
new Note(*
this));
177 const std::string&
name()
const {
190 return original_type_;
198 span<uint8_t> description() {
202 void name(std::string name) {
203 name_ = std::move(name);
208 description_ = std::move(description);
214 virtual void dump(std::ostream& os)
const;
216 void accept(
Visitor& visitor)
const override;
219 std::ostream& operator<<(std::ostream& os,
const Note& note) {
226 Note(std::string name, TYPE type, uint32_t original_type,
227 description_t description) :
228 name_(std::move(name)),
230 original_type_(original_type),
231 description_(std::move(description))
235 LIEF_LOCAL
result<T> read_at(
size_t offset)
const;
238 LIEF_LOCAL
ok_error_t write_at(
size_t offset,
const T& value);
240 LIEF_LOCAL
ok_error_t write_string_at(
size_t offset,
const std::string& value);
243 read_string_at(
size_t offset,
size_t maxsize = 0)
const;
246 TYPE type_ = TYPE::UNKNOWN;
247 uint32_t original_type_ = 0;
248 description_t description_;
251LIEF_API
const char* to_string(
Note::TYPE type);
Class that is used to a read stream of data from different sources.
Definition BinaryStream.hpp:34
Class which represents an ELF binary.
Definition ELF/Binary.hpp:59
Class which takes an ELF::Binary object and reconstructs a valid binary.
Definition ELF/Builder.hpp:48
Class which represents an ELF note. This class can be instantiated using the static Note::create func...
Definition Note.hpp:39
static std::unique_ptr< Note > create(const std::string &name, TYPE type, description_t description, ARCH arch=ARCH::NONE, Header::CLASS cls=Header::CLASS::NONE)
Create a new note from the given parameters. Additional information such as the architecture or the E...
std::vector< uint8_t > description_t
Container used to handle the description data.
Definition Note.hpp:46
TYPE
LIEF representation of the ELF NT_ values.
Definition Note.hpp:49
TYPE type() const
Return the type of the note. This type does not match the NT_ type value. For accessing the original ...
Definition Note.hpp:183
static result< const char * > type_owner(TYPE type)
Try to determine the owner's name of the TYPE provided in parameter.
uint32_t original_type() const
The original NT_xxx integer value. The meaning of this value likely depends on the owner of the note.
Definition Note.hpp:189
static result< const char * > type_to_section(TYPE type)
Try to determine the ELF section name associated with the TYPE provided in parameter.
void description(description_t description)
Change the description of the note.
Definition Note.hpp:207
uint64_t size() const
Size of the raw note which includes padding.
static result< TYPE > convert_type(Header::FILE_TYPE ftype, uint32_t type, const std::string &name)
Convert the raw integer note type into a TYPE according to the owner.
static std::unique_ptr< Note > create(BinaryStream &stream, Header::FILE_TYPE ftype=Header::FILE_TYPE::NONE, ARCH arch=ARCH::NONE, Header::CLASS cls=Header::CLASS::NONE)
Create a new note from the given stream. Additional information such as the architecture or the ELF c...
const std::string & name() const
Return the name of the note (also known as 'owner' )
Definition Note.hpp:177
virtual std::unique_ptr< Note > clone() const
Clone the current note and keep its polymorphic type.
Definition Note.hpp:172
static std::unique_ptr< Note > create(const std::string &name, uint32_t type, description_t description, Header::FILE_TYPE ftype=Header::FILE_TYPE::NONE, ARCH arch=ARCH::NONE, Header::CLASS cls=Header::CLASS::NONE)
Create a new note from the given parameters. Additional information such as the architecture or the E...
span< const uint8_t > description() const
Return the description associated with the note.
Definition Note.hpp:194
Class which parses and transforms an ELF file into a ELF::Binary object.
Definition ELF/Parser.hpp:45
Definition Visitor.hpp:221
ARCH
Machine architectures See current registered ELF machine architectures at: http://www....
Definition ELF/enums.hpp:30
LIEF namespace.
Definition Abstract/Binary.hpp:31
result< ok_t > ok_error_t
Opaque structure that is used by LIEF to avoid writing result<void> f(...). Instead,...
Definition errors.hpp:107
tl::expected< T, lief_errors > result
Wrapper that contains an Object (T) or an error.
Definition errors.hpp:73