libTriton version 1.0 build 1592
Loading...
Searching...
No Matches
instruction.hpp
Go to the documentation of this file.
1
2/*
3** Copyright (C) - Triton
4**
5** This program is under the terms of the Apache License 2.0.
6*/
7
8#ifndef TRITON_INSTRUCTION_H
9#define TRITON_INSTRUCTION_H
10
11#include <list>
12#include <map>
13#include <ostream>
14#include <set>
15#include <sstream>
16#include <utility>
17#include <vector>
18
19#include <triton/archEnums.hpp>
20#include <triton/ast.hpp>
21#include <triton/dllexport.hpp>
24#include <triton/register.hpp>
27
28
29
31namespace triton {
38 namespace arch {
49 protected:
52
55
58
60 std::stringstream disassembly;
61
64
67
70
73
76
78 std::set<std::pair<triton::arch::MemoryAccess, triton::ast::SharedAbstractNode>> loadAccess;
79
81 std::set<std::pair<triton::arch::MemoryAccess, triton::ast::SharedAbstractNode>> storeAccess;
82
84 std::set<std::pair<triton::arch::Register, triton::ast::SharedAbstractNode>> readRegisters;
85
87 std::set<std::pair<triton::arch::Register, triton::ast::SharedAbstractNode>> writtenRegisters;
88
90 std::set<std::pair<triton::arch::Immediate, triton::ast::SharedAbstractNode>> readImmediates;
91
93 std::set<triton::arch::Register> undefinedRegisters;
94
96 bool branch;
97
100
103
106
109
112
114 bool thumb;
115
116 private:
118 void copy(const Instruction& other);
119
120 public:
122 std::vector<triton::arch::OperandWrapper> operands;
123
125 std::vector<triton::engines::symbolic::SharedSymbolicExpression> symbolicExpressions;
126
128 TRITON_EXPORT Instruction();
129
131 TRITON_EXPORT Instruction(const void* opcode, triton::uint32 opSize);
132
134 TRITON_EXPORT Instruction(triton::uint64 addr, const void* opcode, triton::uint32 opSize);
135
137 TRITON_EXPORT Instruction(const Instruction& other);
138
140 TRITON_EXPORT Instruction& operator=(const Instruction& other);
141
143 TRITON_EXPORT ~Instruction();
144
146 TRITON_EXPORT triton::arch::architecture_e getArchitecture(void) const;
147
149 TRITON_EXPORT triton::uint32 getThreadId(void) const;
150
152 TRITON_EXPORT void setThreadId(triton::uint32 tid);
153
155 TRITON_EXPORT triton::uint64 getAddress(void) const;
156
158 TRITON_EXPORT triton::uint64 getNextAddress(void) const;
159
161 TRITON_EXPORT void setAddress(triton::uint64 addr);
162
164 TRITON_EXPORT std::string getDisassembly(void) const;
165
167 TRITON_EXPORT const triton::uint8* getOpcode(void) const;
168
170 TRITON_EXPORT triton::uint32 getType(void) const;
171
173 TRITON_EXPORT triton::arch::x86::prefix_e getPrefix(void) const;
174
176 TRITON_EXPORT triton::arch::arm::condition_e getCodeCondition(void) const;
177
179 TRITON_EXPORT std::set<std::pair<triton::arch::MemoryAccess, triton::ast::SharedAbstractNode>>& getLoadAccess(void);
180
182 TRITON_EXPORT std::set<std::pair<triton::arch::MemoryAccess, triton::ast::SharedAbstractNode>>& getStoreAccess(void);
183
185 TRITON_EXPORT std::set<std::pair<triton::arch::Register, triton::ast::SharedAbstractNode>>& getReadRegisters(void);
186
188 TRITON_EXPORT std::set<std::pair<triton::arch::Register, triton::ast::SharedAbstractNode>>& getWrittenRegisters(void);
189
191 TRITON_EXPORT std::set<std::pair<triton::arch::Immediate, triton::ast::SharedAbstractNode>>& getReadImmediates(void);
192
194 TRITON_EXPORT std::set<triton::arch::Register>& getUndefinedRegisters(void);
195
197 TRITON_EXPORT void setOpcode(const void* opcode, triton::uint32 size);
198
200 TRITON_EXPORT triton::uint32 getSize(void) const;
201
203 TRITON_EXPORT void setLoadAccess(const triton::arch::MemoryAccess& mem, const triton::ast::SharedAbstractNode& node);
204
206 TRITON_EXPORT void removeLoadAccess(const triton::arch::MemoryAccess& mem);
207
209 TRITON_EXPORT void setStoreAccess(const triton::arch::MemoryAccess& mem, const triton::ast::SharedAbstractNode& node);
210
212 TRITON_EXPORT void removeStoreAccess(const triton::arch::MemoryAccess& mem);
213
215 TRITON_EXPORT void setReadRegister(const triton::arch::Register& reg, const triton::ast::SharedAbstractNode& node);
216
218 TRITON_EXPORT void removeReadRegister(const triton::arch::Register& reg);
219
221 TRITON_EXPORT void setWrittenRegister(const triton::arch::Register& reg, const triton::ast::SharedAbstractNode& node);
222
224 TRITON_EXPORT void removeWrittenRegister(const triton::arch::Register& reg);
225
227 TRITON_EXPORT void setReadImmediate(const triton::arch::Immediate& imm, const triton::ast::SharedAbstractNode& node);
228
230 TRITON_EXPORT void removeReadImmediate(const triton::arch::Immediate& imm);
231
233 TRITON_EXPORT void setUndefinedRegister(const triton::arch::Register& reg);
234
236 TRITON_EXPORT void removeUndefinedRegister(const triton::arch::Register& reg);
237
239 TRITON_EXPORT void setSize(triton::uint32 size);
240
243
245 TRITON_EXPORT void setType(triton::uint32 type);
246
248 TRITON_EXPORT void setPrefix(triton::arch::x86::prefix_e prefix);
249
252
254 TRITON_EXPORT void setDisassembly(const std::string& str);
255
257 TRITON_EXPORT void setTaint(bool state);
258
260 TRITON_EXPORT void setTaint(void);
261
263 TRITON_EXPORT void setWriteBack(bool state);
264
266 TRITON_EXPORT void setUpdateFlag(bool state);
267
269 TRITON_EXPORT void setThumb(bool state);
270
273
275 TRITON_EXPORT bool isBranch(void) const;
276
278 TRITON_EXPORT bool isControlFlow(void) const;
279
281 TRITON_EXPORT bool isConditionTaken(void) const;
282
284 TRITON_EXPORT bool isTainted(void) const;
285
287 TRITON_EXPORT bool isSymbolized(void) const;
288
290 TRITON_EXPORT bool isMemoryRead(void) const;
291
293 TRITON_EXPORT bool isMemoryWrite(void) const;
294
296 TRITON_EXPORT bool isWriteTo(const triton::arch::OperandWrapper& target) const;
297
299 TRITON_EXPORT bool isReadFrom(const triton::arch::OperandWrapper& target) const;
300
302 TRITON_EXPORT bool isPrefixed(void) const;
303
305 TRITON_EXPORT bool isWriteBack(void) const;
306
308 TRITON_EXPORT bool isUpdateFlag(void) const;
309
311 TRITON_EXPORT bool isThumb(void) const;
312
314 TRITON_EXPORT void setBranch(bool flag);
315
317 TRITON_EXPORT void setControlFlow(bool flag);
318
320 TRITON_EXPORT void setConditionTaken(bool flag);
321
323 TRITON_EXPORT void clear(void);
324 };
325
327 TRITON_EXPORT std::ostream& operator<<(std::ostream& stream, const Instruction& inst);
328
330 TRITON_EXPORT std::ostream& operator<<(std::ostream& stream, const Instruction* inst);
331
333 };
335};
336
337#endif /* TRITON_INSTRUCTION_H */
This class is used to represent an immediate.
Definition immediate.hpp:37
This class is used to represent an instruction.
TRITON_EXPORT void setOpcode(const void *opcode, triton::uint32 size)
Sets the opcode of the instruction.
TRITON_EXPORT void setLoadAccess(const triton::arch::MemoryAccess &mem, const triton::ast::SharedAbstractNode &node)
Sets a load access.
TRITON_EXPORT std::set< std::pair< triton::arch::Register, triton::ast::SharedAbstractNode > > & getReadRegisters(void)
Returns the list of all implicit and explicit register (flags includes) inputs (read)
TRITON_EXPORT Instruction & operator=(const Instruction &other)
Copies an Instruction.
TRITON_EXPORT void setUpdateFlag(bool state)
Sets the updateFlag of the instruction.
TRITON_EXPORT triton::arch::architecture_e getArchitecture(void) const
Returns the instruction's architecture.
TRITON_EXPORT triton::uint32 getSize(void) const
Returns the size of the instruction.
TRITON_EXPORT void setDisassembly(const std::string &str)
Sets the disassembly of the instruction.
std::set< std::pair< triton::arch::Immediate, triton::ast::SharedAbstractNode > > readImmediates
Implicit and explicit immediate inputs (read). This field is set at the semantics level.
TRITON_EXPORT bool isWriteBack(void) const
Returns true if the instruction performs a write back. Mainly used for AArch64 instructions like LDR.
TRITON_EXPORT void removeLoadAccess(const triton::arch::MemoryAccess &mem)
Removes a load access.
TRITON_EXPORT void setThumb(bool state)
Sets the Thumb mode of the instruction.
TRITON_EXPORT void setConditionTaken(bool flag)
Sets flag to define if the condition is taken or not.
std::stringstream disassembly
The disassembly of the instruction. This field is set at the disassembly level.
TRITON_EXPORT bool isWriteTo(const triton::arch::OperandWrapper &target) const
Returns whether the instruction writes the specified operand.
TRITON_EXPORT void setWrittenRegister(const triton::arch::Register &reg, const triton::ast::SharedAbstractNode &node)
Sets a written register.
TRITON_EXPORT const triton::uint8 * getOpcode(void) const
Returns the opcode of the instruction.
triton::uint32 size
The size of the instruction.
triton::arch::x86::prefix_e prefix
The prefix of the instruction. This field is set at the disassembly level. Mainly used for X86.
bool thumb
True if this is a Thumb instruction. (Note that isThumb() in Arm32Cpu is used to determine the curren...
triton::uint8 opcode[16]
The opcode of the instruction.
std::set< std::pair< triton::arch::MemoryAccess, triton::ast::SharedAbstractNode > > storeAccess
Implicit and explicit store access (write). This field is set at the semantics level.
triton::arch::arm::condition_e codeCondition
The code condition of the instruction. This field is set at the disassembly level....
TRITON_EXPORT bool isThumb(void) const
Returns true if it is a Thumb instruction.
TRITON_EXPORT std::set< std::pair< triton::arch::MemoryAccess, triton::ast::SharedAbstractNode > > & getStoreAccess(void)
Returns the list of all implicit and explicit store access.
TRITON_EXPORT void setType(triton::uint32 type)
Sets the type of the instruction.
TRITON_EXPORT void setPrefix(triton::arch::x86::prefix_e prefix)
Sets the prefix of the instruction (mainly for X86).
TRITON_EXPORT void setAddress(triton::uint64 addr)
Sets the address of the instruction.
TRITON_EXPORT std::set< std::pair< triton::arch::MemoryAccess, triton::ast::SharedAbstractNode > > & getLoadAccess(void)
Returns the list of all implicit and explicit load access.
TRITON_EXPORT void clear(void)
Clears all instruction information.
TRITON_EXPORT void setTaint(void)
Sets the taint of the instruction based on its expressions.
bool writeBack
True if this instruction performs a write back. Mainly used for AArch64 instruction like LDR.
TRITON_EXPORT void setStoreAccess(const triton::arch::MemoryAccess &mem, const triton::ast::SharedAbstractNode &node)
Sets a store access.
TRITON_EXPORT triton::uint32 getType(void) const
Returns the type of the instruction.
TRITON_EXPORT void removeReadRegister(const triton::arch::Register &reg)
Removes a read register.
TRITON_EXPORT bool isConditionTaken(void) const
Returns true if the condition is taken (e.g x86: jcc, cmovcc, setcc, ...).
TRITON_EXPORT void setArchitecture(triton::arch::architecture_e arch)
Sets the instruction's architecture.
TRITON_EXPORT bool isReadFrom(const triton::arch::OperandWrapper &target) const
Returns whether the instruction reads the specified operand.
TRITON_EXPORT bool isTainted(void) const
Returns true if at least one of its expressions is tainted.
std::set< std::pair< triton::arch::MemoryAccess, triton::ast::SharedAbstractNode > > loadAccess
Implicit and explicit load access (read). This field is set at the semantics level.
triton::uint32 type
The type of the instruction. This field is set at the disassembly level.
TRITON_EXPORT std::set< triton::arch::Register > & getUndefinedRegisters(void)
Returns the list of all implicit and explicit undefined registers.
TRITON_EXPORT void setWriteBack(bool state)
Sets the writeBack flag of the instruction.
TRITON_EXPORT triton::uint64 getAddress(void) const
Returns the address of the instruction.
TRITON_EXPORT bool isSymbolized(void) const
Returns true if at least one of its expressions contains a symbolic variable.
TRITON_EXPORT bool isMemoryRead(void) const
Returns true if the instruction contains an expression which reads the memory.
TRITON_EXPORT void removeUndefinedRegister(const triton::arch::Register &reg)
Removes an undefined register.
bool controlFlow
True if this instruction changes the control flow. This field is set at the disassembly level.
TRITON_EXPORT bool isMemoryWrite(void) const
Returns true if the instruction contains an expression which writes into the memory.
TRITON_EXPORT void setUndefinedRegister(const triton::arch::Register &reg)
Sets an undefined register.
TRITON_EXPORT triton::uint32 getThreadId(void) const
Returns the thread id of the instruction.
TRITON_EXPORT void removeReadImmediate(const triton::arch::Immediate &imm)
Removes a read immediate.
TRITON_EXPORT bool isBranch(void) const
Returns true if this instruction is a branch.
TRITON_EXPORT bool isPrefixed(void) const
Returns true if the instruction has a prefix (mainly for X86).
TRITON_EXPORT void setBranch(bool flag)
Sets flag to define this instruction as branch or not.
TRITON_EXPORT void setSize(triton::uint32 size)
Sets the size of the instruction.
TRITON_EXPORT Instruction()
Constructor.
TRITON_EXPORT void setCodeCondition(triton::arch::arm::condition_e codeCondition)
Sets the code condition of the instruction (mainly for AArch64).
TRITON_EXPORT std::set< std::pair< triton::arch::Register, triton::ast::SharedAbstractNode > > & getWrittenRegisters(void)
Returns the list of all implicit and explicit register (flags includes) outputs (write)
std::vector< triton::arch::OperandWrapper > operands
A list of operands.
bool tainted
True if this instruction is tainted. This field is set at the semantics level.
TRITON_EXPORT void removeWrittenRegister(const triton::arch::Register &reg)
Removes a written register.
TRITON_EXPORT void addSymbolicExpression(const triton::engines::symbolic::SharedSymbolicExpression &expr)
Adds a symbolic expression.
std::set< triton::arch::Register > undefinedRegisters
Implicit and explicit undefined registers. This field is set at the semantics level.
TRITON_EXPORT void setReadImmediate(const triton::arch::Immediate &imm, const triton::ast::SharedAbstractNode &node)
Sets a read immediate.
std::set< std::pair< triton::arch::Register, triton::ast::SharedAbstractNode > > readRegisters
Implicit and explicit register inputs (read). This field is set at the semantics level.
TRITON_EXPORT void setControlFlow(bool flag)
Sets flag to define this instruction changes the control flow or not.
TRITON_EXPORT bool isUpdateFlag(void) const
Returns true if the instruction updates flags. Mainly used for AArch64 instructions like ADDS.
bool updateFlag
True if this instruction updartes flags. Mainly used for AArch64 instruction like ADDS.
TRITON_EXPORT triton::arch::x86::prefix_e getPrefix(void) const
Returns the prefix of the instruction (mainly for X86).
triton::arch::architecture_e arch
The instruction's architecture.
TRITON_EXPORT ~Instruction()
Destructor.
std::set< std::pair< triton::arch::Register, triton::ast::SharedAbstractNode > > writtenRegisters
Implicit and explicit register outputs (write). This field is set at the semantics level.
std::vector< triton::engines::symbolic::SharedSymbolicExpression > symbolicExpressions
The semantics set of the instruction.
TRITON_EXPORT std::set< std::pair< triton::arch::Immediate, triton::ast::SharedAbstractNode > > & getReadImmediates(void)
Returns the list of all implicit and explicit immediate inputs (read)
TRITON_EXPORT void setReadRegister(const triton::arch::Register &reg, const triton::ast::SharedAbstractNode &node)
Sets a read register.
triton::uint64 address
The address of the instruction.
TRITON_EXPORT void removeStoreAccess(const triton::arch::MemoryAccess &mem)
Removes a store access.
TRITON_EXPORT void setThreadId(triton::uint32 tid)
Sets the thread id of the instruction.
bool conditionTaken
True if the condition is taken (i.g x86: jcc, cmocc, setcc, ...). This field is set at the semantics ...
triton::uint32 tid
The thread id of the instruction.
TRITON_EXPORT triton::arch::arm::condition_e getCodeCondition(void) const
Returns the code codition of the instruction (mainly for AArch64).
TRITON_EXPORT std::string getDisassembly(void) const
Returns the disassembly of the instruction.
bool branch
True if this instruction is a branch. This field is set at the disassembly level.
TRITON_EXPORT triton::uint64 getNextAddress(void) const
Returns the next address of the instruction.
TRITON_EXPORT bool isControlFlow(void) const
Returns true if this instruction changes the control flow (e.g x86: JMP, JCC, CALL,...
This class is used to represent a memory access.
This class is used as operand wrapper.
This class is used when an instruction has a register operand.
Definition register.hpp:44
std::ostream & operator<<(std::ostream &stream, BasicBlock &block)
Displays an BasicBlock.
condition_e
Types of condition.
std::shared_ptr< triton::ast::AbstractNode > SharedAbstractNode
Shared Abstract Node.
Definition ast.hpp:59
std::shared_ptr< triton::engines::symbolic::SymbolicExpression > SharedSymbolicExpression
Shared Symbolic Expression.
Definition ast.hpp:40
std::uint64_t uint64
unisgned 64-bits
std::uint32_t uint32
unisgned 32-bits
std::uint8_t uint8
unisgned 8-bits
prefix_e
Types of prefix.
The Triton namespace.