LLDB mainline
EmulateInstructionRISCV.h
Go to the documentation of this file.
1//===-- EmulateInstructionRISCV.h -----------------------------------------===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
9#ifndef LLDB_SOURCE_PLUGINS_INSTRUCTION_RISCV_EMULATEINSTRUCTIONRISCV_H
10#define LLDB_SOURCE_PLUGINS_INSTRUCTION_RISCV_EMULATEINSTRUCTIONRISCV_H
11
12#include "RISCVInstructions.h"
13
16#include "lldb/Utility/Log.h"
18#include "lldb/Utility/Status.h"
19#include <optional>
20
21namespace lldb_private {
22
24public:
25 static llvm::StringRef GetPluginNameStatic() { return "riscv"; }
26
27 static llvm::StringRef GetPluginDescriptionStatic() {
28 return "Emulate instructions for the RISC-V architecture.";
29 }
30
32 switch (inst_type) {
35 return true;
38 return false;
39 }
40 llvm_unreachable("Fully covered switch above!");
41 }
42
43 static bool SupportsThisArch(const ArchSpec &arch);
44
47
48 static void Initialize();
49
50 static void Terminate();
51
52public:
54
55 llvm::StringRef GetPluginName() override { return GetPluginNameStatic(); }
56
58 return SupportsThisInstructionType(inst_type);
59 }
60
61 bool SetTargetTriple(const ArchSpec &arch) override;
62 bool ReadInstruction() override;
63 std::optional<uint32_t> GetLastInstrSize() override { return m_last_size; }
64 bool EvaluateInstruction(uint32_t options) override;
65 bool TestEmulation(Stream &out_stream, ArchSpec &arch,
66 OptionValueDictionary *test_data) override;
67 std::optional<RegisterInfo> GetRegisterInfo(lldb::RegisterKind reg_kind,
68 uint32_t reg_num) override;
69
70 std::optional<lldb::addr_t> ReadPC();
72
73 std::optional<DecodeResult> ReadInstructionAt(lldb::addr_t addr);
74 std::optional<DecodeResult> Decode(uint32_t inst);
75 bool Execute(DecodeResult inst, bool ignore_cond);
76
77 template <typename T>
78 std::enable_if_t<std::is_integral_v<T>, std::optional<T>>
79 ReadMem(uint64_t addr) {
82 ctx.SetNoArgs();
83 bool success = false;
84 T result = ReadMemoryUnsigned(ctx, addr, sizeof(T), T(), &success);
85 if (!success)
86 return {}; // aka return false
87 return result;
88 }
89
90 template <typename T> bool WriteMem(uint64_t addr, uint64_t value) {
93 ctx.SetNoArgs();
94 return WriteMemoryUnsigned(ctx, addr, value, sizeof(T));
95 }
96
97 llvm::RoundingMode GetRoundingMode();
98 bool SetAccruedExceptions(llvm::APFloatBase::opStatus);
99
100private:
101 /// Last decoded instruction from m_opcode
103 /// Last decoded instruction size estimate.
104 std::optional<uint32_t> m_last_size;
105};
106
107} // namespace lldb_private
108
109#endif // LLDB_SOURCE_PLUGINS_INSTRUCTION_RISCV_EMULATEINSTRUCTIONRISCV_H
An architecture specification class.
Definition: ArchSpec.h:31
std::optional< DecodeResult > ReadInstructionAt(lldb::addr_t addr)
std::optional< RegisterInfo > GetRegisterInfo(lldb::RegisterKind reg_kind, uint32_t reg_num) override
bool SetTargetTriple(const ArchSpec &arch) override
bool SetAccruedExceptions(llvm::APFloatBase::opStatus)
std::optional< uint32_t > m_last_size
Last decoded instruction size estimate.
bool WriteMem(uint64_t addr, uint64_t value)
bool TestEmulation(Stream &out_stream, ArchSpec &arch, OptionValueDictionary *test_data) override
static bool SupportsThisArch(const ArchSpec &arch)
std::optional< DecodeResult > Decode(uint32_t inst)
static llvm::StringRef GetPluginDescriptionStatic()
bool SupportsEmulatingInstructionsOfType(InstructionType inst_type) override
bool Execute(DecodeResult inst, bool ignore_cond)
std::enable_if_t< std::is_integral_v< T >, std::optional< T > > ReadMem(uint64_t addr)
std::optional< uint32_t > GetLastInstrSize() override
bool EvaluateInstruction(uint32_t options) override
static lldb_private::EmulateInstruction * CreateInstance(const lldb_private::ArchSpec &arch, InstructionType inst_type)
static bool SupportsThisInstructionType(InstructionType inst_type)
DecodeResult m_decoded
Last decoded instruction from m_opcode.
"lldb/Core/EmulateInstruction.h" A class that allows emulation of CPU opcodes.
bool WriteMemoryUnsigned(const Context &context, lldb::addr_t addr, uint64_t uval, size_t uval_byte_size)
uint64_t ReadMemoryUnsigned(const Context &context, lldb::addr_t addr, size_t byte_size, uint64_t fail_value, bool *success_ptr)
A stream class that can stream formatted output to a file.
Definition: Stream.h:28
A class that represents a running process on the host machine.
InstructionType
Instruction types.
uint64_t addr_t
Definition: lldb-types.h:80
RegisterKind
Register numbering types.