Add additional plugin API functions to read and write memory and registers
cover Add additional plugin API functions to read and write memory and registers
This patch set follows a previous patch which added the qemu_plugin_read_memory_vaddr function and adds a set of similar functions to read and write registers, virtual memory, and physical memory.
The use case I have in mind is for use of QEMU for program analysis and testing. For example, a fuzzer which uses QEMU for emulation might wish to inject test data into a program at runtime using qemu_plugin_write_memory_vaddr (and likewise if testing an operating system or bare metal application using qemu_plugin_write_memory_hwaddr). It may also wish to read the initial contents of memory using qemu_plugin_read_memory_vaddr/hwaddr.
Similarly, a testing framework may wish to fake register values, perhaps to simulate a device failure, perhaps by using qemu_plugin_write_register to set a register value to an error code.
I think all this functionality works together to make QEMU plugins more powerful and versatile, hopefully removing barriers to using upstream QEMU for these tasks which have historically required maintaining a QEMU fork downstream (like QEMUAFL
https://github.com/AFLplusplus/qemuafl), which is tedious, error prone, and results in users missing out on enhancements to QEMU.
novafacing (2):
Expose gdb_write_register function to consumers of gdbstub Add plugin API functions for register R/W, hwaddr R/W, vaddr W
gdbstub/gdbstub.c | 2 +- include/exec/gdbstub.h | 14 +++++ include/qemu/qemu-plugin.h | 116 +++++++++++++++++++++++++++++++++---- plugins/api.c | 66 ++++++++++++++++++++- 4 files changed, 183 insertions(+), 15 deletions(-)
Signature · 1 line
2.46.1
PATCH 1/2 Expose gdb_write_register function to consumers of gdbstub
From: novafacing <[email protected]>
--- gdbstub/gdbstub.c | 2 +- include/exec/gdbstub.h | 14 ++++++++++++++ 2 files changed, 15 insertions(+), 1 deletion(-)
gdbstub/gdbstub.c +1 -1
@@ -536,7 +536,7 @@ int gdb_read_register(CPUState *cpu, GByteArray *buf, int reg)return 0 ; } -static int gdb_write_register (CPUState *cpu,uint8_t *mem_buf,int reg) +int gdb_write_register (CPUState *cpu,uint8_t *mem_buf,int reg) {CPUClass *cc =CPU_GET_CLASS (cpu);GDBRegisterState *r;
include/exec/gdbstub.h +14 -0
@@ -118,6 +118,20 @@ const GDBFeature *gdb_find_static_feature(const char *xmlname);*/ int gdb_read_register (CPUState *cpu,GByteArray *buf,int reg); +/** +* gdb_write_register() - Write a register associated with a CPU. +* @cpu: The CPU associated with the register. +* @buf: The buffer that the register contents will be set to. +* @reg: The register's number returned by gdb_find_feature_register(). +* +* The size of @buf must be at least the size of the register being +* written. +* +* Return: The number of written bytes, or 0 if an error occurred (for +* example, an unknown register was provided). +*/ +int gdb_write_register (CPUState *cpu,uint8_t *mem_buf,int reg); +/** * typedef GDBRegDesc - a register description from gdbstub */
Signature · 1 line
2.46.1
PATCH 2/2 Add plugin API functions for register R/W, hwaddr R/W, vaddr W
In reply to Rowan HartFrom: novafacing <[email protected]>
--- include/qemu/qemu-plugin.h | 116 +++++++++++++++++++++++++++++++++---- plugins/api.c | 66 ++++++++++++++++++++- 2 files changed, 168 insertions(+), 14 deletions(-)
include/qemu/qemu-plugin.h +104 -12
@@ -65,11 +65,18 @@ typedef uint64_t qemu_plugin_id_t;* * version 4: * - added qemu_plugin_read_memory_vaddr +* +* version 5: +* - added qemu_plugin_write_memory_vaddr +* - added qemu_plugin_read_memory_hwaddr +* - added qemu_plugin_write_memory_hwaddr +* - added qemu_plugin_write_register +* */ extern QEMU_PLUGIN_EXPORT int qemu_plugin_version; -#define QEMU_PLUGIN_VERSION 4 +#define QEMU_PLUGIN_VERSION 5/** * struct qemu_info_t - system information for plugins
@@ -255,8 +262,6 @@ typedef struct {* @QEMU_PLUGIN_CB_R_REGS: callback reads the CPU's regs * @QEMU_PLUGIN_CB_RW_REGS: callback reads and writes the CPU's regs * -* Note: currently QEMU_PLUGIN_CB_RW_REGS is unused, plugins cannot change -* system register state. */ enum qemu_plugin_cb_flags {QEMU_PLUGIN_CB_NO_REGS ,
@@ -893,6 +898,41 @@ typedef struct {QEMU_PLUGIN_API GArray *qemu_plugin_get_registers(void); +/** +* qemu_plugin_read_register() - read register for current vCPU +* +* @handle: a @qemu_plugin_reg_handle handle +* @buf: A GByteArray for the data owned by the plugin +* +* This function is only available in a context that register read access is +* explicitly requested via the QEMU_PLUGIN_CB_R_REGS flag. +* +* Returns the size of the read register. The content of @buf is in target byte +* order. On failure returns -1. +*/ +QEMU_PLUGIN_API +int qemu_plugin_read_register(struct qemu_plugin_register *handle, +GByteArray *buf); + +/** +* qemu_plugin_write_register() - write register for current vCPU +* +* @handle: a @qemu_plugin_reg_handle handle +* @buf: A GByteArray for the data owned by the plugin +* +* This function is only available in a context that register write access is +* explicitly requested via the QEMU_PLUGIN_CB_W_REGS flag. +* +* The size of @buf must be at least the size of the requested register. +* Attempting to write a register with @buf smaller than the register size +* will result in a crash or other undesired behavior. +* +* Returns the number of bytes written. On failure returns 0. +*/ +QEMU_PLUGIN_API +int qemu_plugin_write_register(struct qemu_plugin_register *handle, +GByteArray *buf); +/** * qemu_plugin_read_memory_vaddr() - read from memory using a virtual address *
@@ -916,20 +956,72 @@ bool qemu_plugin_read_memory_vaddr(uint64_t addr, GByteArray *data, size_t len);/** -* qemu_plugin_read_register() - read register for current vCPU +* qemu_plugin_write_memory_vaddr() - write to memory using a virtual address * -* @handle: a @qemu_plugin_reg_handle handle -* @buf: A GByteArray for the data owned by the plugin +* @addr: A virtual address to write to +* @data: A byte array containing the data to write * -* This function is only available in a context that register read access is -* explicitly requested via the QEMU_PLUGIN_CB_R_REGS flag. +* The contents of @data will be written to memory starting at the virtual +* address @addr. * -* Returns the size of the read register. The content of @buf is in target byte -* order. On failure returns -1. +* This function does not guarantee consistency of writes, nor does it ensure +* that pending writes are flushed either before or after the write takes +* place, so callers should take care when calling this function in plugin +* callbacks to avoid depending on the existence of data written using this +* function which may be overwritten afterward. +* +* Returns true on success and false on failure. */ QEMU_PLUGIN_API -int qemu_plugin_read_register(struct qemu_plugin_register *handle, -GByteArray *buf); +bool qemu_plugin_write_memory_vaddr(uint64_t addr, +GByteArray *data); + +/** +* qemu_plugin_read_memory_vaddr() - read from memory using a hardware address +* +* @addr: A virtual address to read from +* @data: A byte array to store data into +* @len: The number of bytes to read, starting from @addr +* +* @len bytes of data is read starting at @addr and stored into @data. If @data +* is not large enough to hold @len bytes, it will be expanded to the necessary +* size, reallocating if necessary. @len must be greater than 0. +* +* This function does not ensure writes are flushed prior to reading, so +* callers should take care when calling this function in plugin callbacks to +* avoid attempting to read data which may not yet be written and should use +* the memory callback API instead. +* +* This function is only valid for softmmu targets. +* +* Returns true on success and false on failure. +*/ +QEMU_PLUGIN_API +bool qemu_plugin_read_memory_hwaddr(uint64_t addr, +GByteArray *data,size_t len); + +/** +* qemu_plugin_write_memory_vaddr() - write to memory using a hardware address +* +* @addr: A virtual address to write to +* @data: A byte array containing the data to write +* +* The contents of @data will be written to memory starting at the hardware +* address @addr. +* +* This function does not guarantee consistency of writes, nor does it ensure +* that pending writes are flushed either before or after the write takes +* place, so callers should take care when calling this function in plugin +* callbacks to avoid depending on the existence of data written using this +* function which may be overwritten afterward. +* +* This function is only valid for softmmu targets. +* +* Returns true on success and false on failure. +*/ +QEMU_PLUGIN_API +bool qemu_plugin_write_memory_hwaddr(uint64_t addr, +GByteArray *data);/** * qemu_plugin_scoreboard_new() - alloc a new scoreboard
plugins/api.c +64 -2
83 lines not on this page · raw message
Signature · 1 line
2.46.1