Made the EmulateInstruction class into a plug-in interface and moved the
source files around into the places they need to go.
git-svn-id: https://llvm.org/svn/llvm-project/llvdb/trunk@124631 91177308-0d34-0410-b5e6-96231b3b80d8
diff --git a/source/Plugins/Process/Utility/EmulateInstruction.cpp b/source/Core/EmulateInstruction.cpp
similarity index 100%
rename from source/Plugins/Process/Utility/EmulateInstruction.cpp
rename to source/Core/EmulateInstruction.cpp
diff --git a/source/Plugins/Process/Utility/EmulateInstructionARM.cpp b/source/Plugins/Instruction/ARM/EmulateInstructionARM.cpp
similarity index 99%
rename from source/Plugins/Process/Utility/EmulateInstructionARM.cpp
rename to source/Plugins/Instruction/ARM/EmulateInstructionARM.cpp
index 541158f..3022a77 100644
--- a/source/Plugins/Process/Utility/EmulateInstructionARM.cpp
+++ b/source/Plugins/Instruction/ARM/EmulateInstructionARM.cpp
@@ -8,9 +8,11 @@
//===----------------------------------------------------------------------===//
#include "EmulateInstructionARM.h"
+#include "lldb/Core/ConstString.h"
+
#include "ARMDefines.h"
#include "ARMUtils.h"
-#include "lldb/Core/ConstString.h"
+#include "ARM_DWARF_Registers.h"
using namespace lldb;
using namespace lldb_private;
diff --git a/source/Plugins/Process/Utility/EmulateInstructionARM.h b/source/Plugins/Instruction/ARM/EmulateInstructionARM.h
similarity index 97%
rename from source/Plugins/Process/Utility/EmulateInstructionARM.h
rename to source/Plugins/Instruction/ARM/EmulateInstructionARM.h
index 3ec5b5e..acb755a 100644
--- a/source/Plugins/Process/Utility/EmulateInstructionARM.h
+++ b/source/Plugins/Instruction/ARM/EmulateInstructionARM.h
@@ -10,9 +10,7 @@
#ifndef lldb_EmulateInstructionARM_h_
#define lldb_EmulateInstructionARM_h_
-#include "EmulateInstruction.h"
-#include "ARM_DWARF_Registers.h"
-
+#include "lldb/Core/EmulateInstruction.h"
#include "lldb/Core/Error.h"
namespace lldb_private {
diff --git a/source/Plugins/Process/Utility/EmulateInstruction.h b/source/Plugins/Process/Utility/EmulateInstruction.h
deleted file mode 100644
index 30cf5f4..0000000
--- a/source/Plugins/Process/Utility/EmulateInstruction.h
+++ /dev/null
@@ -1,280 +0,0 @@
-//===-- EmulateInstruction.h ------------------------------------*- C++ -*-===//
-//
-// The LLVM Compiler Infrastructure
-//
-// This file is distributed under the University of Illinois Open Source
-// License. See LICENSE.TXT for details.
-//
-//===----------------------------------------------------------------------===//
-
-#ifndef lldb_EmulateInstruction_h_
-#define lldb_EmulateInstruction_h_
-
-#include "lldb/lldb-include.h"
-#include "lldb/Core/PluginInterface.h"
-
-//----------------------------------------------------------------------
-/// @class EmulateInstruction EmulateInstruction.h "lldb/Core/EmulateInstruction.h"
-/// @brief A class that allows emulation of CPU opcodes.
-///
-/// This class is a plug-in interface that is accessed through the
-/// standard static FindPlugin function call in the EmulateInstruction
-/// class. The FindPlugin takes a target triple and returns a new object
-/// if there is a plug-in that supports the architecture and OS. Four
-/// callbacks and a baton are provided. The four callbacks are read
-/// register, write register, read memory and write memory.
-///
-/// This class is currently designed for these main use cases:
-/// - Auto generation of Call Frame Information (CFI) from assembly code
-/// - Predicting single step breakpoint locations
-/// - Emulating instructions for breakpoint traps
-///
-/// Objects can be asked to read an instruction which will cause a call
-/// to the read register callback to get the PC, followed by a read
-/// memory call to read the opcode. If ReadInstruction () returns true,
-/// then a call to EmulateInstruction::EvaluateInstruction () can be
-/// made. At this point the EmulateInstruction subclass will use all of
-/// the callbacks to emulate an instruction.
-///
-/// Clients that provide the callbacks can either do the read/write
-/// registers/memory to actually emulate the instruction on a real or
-/// virtual CPU, or watch for the EmulateInstruction::Context which
-/// is context for the read/write register/memory which explains why
-/// the callback is being called. Examples of a context are:
-/// "pushing register 3 onto the stack at offset -12", or "adjusting
-/// stack pointer by -16". This extra context allows the generation of
-/// CFI information from assembly code without having to actually do
-/// the read/write register/memory.
-///
-/// Clients must be prepared that not all instructions for an
-/// Instruction Set Architecture (ISA) will be emulated.
-///
-/// Subclasses at the very least should implement the instructions that
-/// save and restore regiters onto the stack and adjustment to the stack
-/// pointer. By just implementing a few instructions for an ISA that are
-/// the typical prologue opcodes, you can then generate CFI using a
-/// class that will soon be available.
-///
-/// Implmenting all of the instructions that affect the PC can then
-/// allow single step prediction support.
-///
-/// Implmenting all of the instructions allows for emulation of opcodes
-/// for breakpoint traps and will pave the way for "thread centric"
-/// debugging. The current debugging model is "process centric" where
-/// all threads must be stopped when any thread is stopped since when
-/// hitting software breakpoints once must disable the breakpoint by
-/// restoring the original breakpoint opcde, single stepping and
-/// restoring the breakpoint trap. If all threads were allowed to run
-/// then other threads could miss the breakpoint.
-///
-/// This class centralizes the code that usually is done in separate
-/// code paths in a debugger (single step prediction, finding save
-/// restore locations of registers for unwinding stack frame variables,
-/// and emulating the intruction is just a bonus.
-//----------------------------------------------------------------------
-
-namespace lldb_private {
-
-class EmulateInstruction :
- public PluginInterface
-{
-public:
-
- static Disassembler*
- FindPlugin (const ArchSpec &arch);
-
- enum ContextType
- {
- eContextInvalid = 0,
- // Read an instruciton opcode from memory
- eContextReadOpcode,
-
- // Usually used for writing a register value whose source value in an
- // immediate
- eContextImmediate,
-
- // Exclusively used when saving a register to the stack as part of the
- // prologue
- // arg0 = register kind
- // arg1 = register number
- // arg2 = signed offset from current SP value where register is being
- // stored
- eContextPushRegisterOnStack,
-
- // Exclusively used when restoring a register off the stack as part of
- // the epilogue
- // arg0 = register kind
- // arg1 = register number
- // arg2 = signed offset from current SP value where register is being
- // restored
- eContextPopRegisterOffStack,
-
- // Add or subtract a value from the stack
- // arg0 = register kind for SP
- // arg1 = register number for SP
- // arg2 = signed offset being applied to the SP value
- eContextAdjustStackPointer,
-
- // Used in WriteRegister callbacks to indicate where the
- // arg0 = source register kind
- // arg1 = source register number
- // arg2 = source signed offset
- eContextRegisterPlusOffset,
- };
-
- struct Context
- {
- ContextType type;
- lldb::addr_t arg0; // Register kind.
- lldb::addr_t arg1; // Register spec.
- int64_t arg2; // Possible negative value.
- };
-
- union Opcode
- {
- uint8_t inst8;
- uint16_t inst16;
- uint32_t inst32;
- uint64_t inst64;
- union inst
- {
- uint8_t bytes[16];
- uint8_t length;
- };
- };
-
- enum OpcodeType
- {
- eOpcode8,
- eOpcode16,
- eOpcode32,
- eOpcode64,
- eOpcodeBytes,
- };
-
- struct Instruction
- {
- OpcodeType opcode_type;
- Opcode opcode;
- };
-
- typedef size_t (*ReadMemory) (void *baton,
- const Context &context,
- lldb::addr_t addr,
- void *dst,
- size_t length);
-
- typedef size_t (*WriteMemory) (void *baton,
- const Context &context,
- lldb::addr_t addr,
- const void *dst,
- size_t length);
-
- typedef bool (*ReadRegister) (void *baton,
- uint32_t reg_kind,
- uint32_t reg_num,
- uint64_t ®_value);
-
- typedef bool (*WriteRegister) (void *baton,
- const Context &context,
- uint32_t reg_kind,
- uint32_t reg_num,
- uint64_t reg_value);
-
- EmulateInstruction (lldb::ByteOrder byte_order,
- uint32_t addr_byte_size,
- void *baton,
- ReadMemory read_mem_callback,
- WriteMemory write_mem_callback,
- ReadRegister read_reg_callback,
- WriteRegister write_reg_callback);
-
- virtual ~EmulateInstruction()
- {
- }
-
- virtual bool
- SetTargetTriple (const ConstString &triple) = 0;
-
- virtual bool
- ReadInstruction () = 0;
-
- virtual bool
- EvaluateInstruction () = 0;
-
- uint64_t
- ReadRegisterUnsigned (uint32_t reg_kind,
- uint32_t reg_num,
- uint64_t fail_value,
- bool *success_ptr);
-
- bool
- WriteRegisterUnsigned (const Context &context,
- uint32_t reg_kind,
- uint32_t reg_num,
- uint64_t reg_value);
-
- uint64_t
- ReadMemoryUnsigned (const Context &context,
- lldb::addr_t addr,
- size_t byte_size,
- uint64_t fail_value,
- bool *success_ptr);
-
- bool
- WriteMemoryUnsigned (const Context &context,
- lldb::addr_t addr,
- uint64_t uval,
- size_t uval_byte_size);
-
- uint32_t
- GetAddressByteSize () const
- {
- return m_addr_byte_size;
- }
-
- lldb::ByteOrder
- GetByteOrder () const
- {
- return m_byte_order;
- }
-
- uint64_t
- OpcodeAsUnsigned (bool *success_ptr)
- {
- if (success_ptr)
- *success_ptr = true;
- switch (m_inst.opcode_type)
- {
- eOpcode8: return m_inst.opcode.inst8;
- eOpcode16: return m_inst.opcode.inst16;
- eOpcode32: return m_inst.opcode.inst32;
- eOpcode64: return m_inst.opcode.inst64;
- eOpcodeBytes:
- break;
- }
- if (success_ptr)
- *success_ptr = false;
- return 0;
- }
-
-protected:
- lldb::ByteOrder m_byte_order;
- uint32_t m_addr_byte_size;
- void * m_baton;
- ReadMemory m_read_mem_callback;
- WriteMemory m_write_mem_callback;
- ReadRegister m_read_reg_callback;
- WriteRegister m_write_reg_callback;
-
- lldb::addr_t m_inst_pc;
- Instruction m_inst;
- //------------------------------------------------------------------
- // For EmulateInstruction only
- //------------------------------------------------------------------
- DISALLOW_COPY_AND_ASSIGN (EmulateInstruction);
-};
-
-} // namespace lldb_private
-
-#endif // lldb_EmulateInstruction_h_