LIEF: Library to Instrument Executable Formats Version 1.0.0
Loading...
Searching...
No Matches
DWARF/editor/Function.hpp
Go to the documentation of this file.
1/* Copyright 2022 - 2025 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_DWARF_EDITOR_FUNCTION_H
16#define LIEF_DWARF_EDITOR_FUNCTION_H
17#include <cstdint>
18#include <memory>
19#include <vector>
20#include <string>
21
22#include "LIEF/visibility.h"
23
24namespace LIEF {
25namespace dwarf {
26namespace editor {
27class Type;
28class Variable;
29
30namespace details {
31class Function;
32class FunctionParameter;
33class FunctionLexicalBlock;
34class FunctionLabel;
35}
36
39 public:
41 range_t() = default;
42 range_t(uint64_t start, uint64_t end) :
44 {}
45 uint64_t start = 0;
46 uint64_t end = 0;
47 };
48
51 public:
52 Parameter() = delete;
53 Parameter(std::unique_ptr<details::FunctionParameter> impl);
54
56
58 Parameter& assign_register(const std::string& name);
59
61 Parameter& assign_register(uint64_t reg);
62
63 private:
64 std::unique_ptr<details::FunctionParameter> impl_;
65 };
66
69 public:
70 LexicalBlock() = delete;
71 LexicalBlock(std::unique_ptr<details::FunctionLexicalBlock> impl);
72
74 std::unique_ptr<LexicalBlock> add_block(uint64_t start, uint64_t end);
75
77 std::unique_ptr<LexicalBlock> add_block(const std::vector<range_t>& range);
78
81 LexicalBlock& add_description(const std::string& description);
82
84 LexicalBlock& add_name(const std::string& name);
85
87
88 private:
89 std::unique_ptr<details::FunctionLexicalBlock> impl_;
90 };
91
94 public:
95 Label() = delete;
96 Label(std::unique_ptr<details::FunctionLabel> impl);
97
99 private:
100 std::unique_ptr<details::FunctionLabel> impl_;
101 };
102
103 Function() = delete;
104 Function(std::unique_ptr<details::Function> impl);
105
107 Function& set_address(uint64_t addr);
108
113 Function& set_low_high(uint64_t low, uint64_t high);
114
119 Function& set_ranges(const std::vector<range_t>& ranges);
120
125
128
130 std::unique_ptr<Parameter> add_parameter(const std::string& name, const Type& type);
131
133 std::unique_ptr<Variable> create_stack_variable(const std::string& name);
134
136 std::unique_ptr<LexicalBlock> add_lexical_block(uint64_t start, uint64_t end);
137
139 std::unique_ptr<Label> add_label(uint64_t addr, const std::string& label);
140
143 Function& add_description(const std::string& description);
144
146
147 private:
148 std::unique_ptr<details::Function> impl_;
149};
150
151}
152}
153}
154#endif
Label(std::unique_ptr< details::FunctionLabel > impl)
LexicalBlock & add_name(const std::string &name)
Create a DW_AT_name entry to associate a name to this entry.
std::unique_ptr< LexicalBlock > add_block(const std::vector< range_t > &range)
Create a sub-block with the given range of addresses.
LexicalBlock(std::unique_ptr< details::FunctionLexicalBlock > impl)
LexicalBlock & add_description(const std::string &description)
Create a DW_AT_description entry with the description provided in parameter.
std::unique_ptr< LexicalBlock > add_block(uint64_t start, uint64_t end)
Create a sub-block with the given low/high addresses.
Parameter(std::unique_ptr< details::FunctionParameter > impl)
Parameter & assign_register(const std::string &name)
Assign this parameter to a specific named register.
Parameter & assign_register(uint64_t reg)
Assign this parameter to the given DWARF register id (e.g. DW_OP_reg0).
Function(std::unique_ptr< details::Function > impl)
std::unique_ptr< Label > add_label(uint64_t addr, const std::string &label)
Add a label at the given address.
Function & set_external()
Set the function as external by defining DW_AT_external to true. This means that the function is impo...
Function & set_return_type(const Type &type)
Set the return type of this function.
std::unique_ptr< Variable > create_stack_variable(const std::string &name)
Create a stack-based variable owned by the current function.
Function & set_ranges(const std::vector< range_t > &ranges)
Set the ranges of addresses owned by the implementation of this function by setting the DW_AT_ranges ...
std::unique_ptr< Parameter > add_parameter(const std::string &name, const Type &type)
Add a parameter to the current function.
Function & set_low_high(uint64_t low, uint64_t high)
Set the upper and lower bound addresses for this function. This assumes that the function is contiguo...
Function & set_address(uint64_t addr)
Set the address of this function by defining DW_AT_entry_pc.
std::unique_ptr< LexicalBlock > add_lexical_block(uint64_t start, uint64_t end)
Add a lexical block with the given range.
Function & add_description(const std::string &description)
Create a DW_AT_description entry with the description provided in parameter.
This class is the base class for any types created when editing DWARF debug info.
Definition DWARF/editor/Type.hpp:36
This class represents an editable DWARF variable which can be scoped by a function or a compilation u...
Definition editor/Variable.hpp:34
Definition DWARF/editor/CompilationUnit.hpp:36
Definition Editor.hpp:30
Namespace for the DWARF debug format.
Definition DWARF/CompilationUnit.hpp:28
LIEF namespace.
Definition Abstract/Binary.hpp:40
uint64_t end
Definition DWARF/editor/Function.hpp:46
range_t(uint64_t start, uint64_t end)
Definition DWARF/editor/Function.hpp:42
uint64_t start
Definition DWARF/editor/Function.hpp:45
#define LIEF_API
Definition visibility.h:41