[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL v2 12/15] plugins: expand kernel-doc for memory query and instrume
From: |
Alex Bennée |
Subject: |
[PULL v2 12/15] plugins: expand kernel-doc for memory query and instrumentation |
Date: |
Wed, 17 Mar 2021 07:22:13 +0000 |
Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
Message-Id: <20210312172821.31647-13-alex.bennee@linaro.org>
diff --git a/include/qemu/qemu-plugin.h b/include/qemu/qemu-plugin.h
index ad9dc4b69d..9e67ab1aa2 100644
--- a/include/qemu/qemu-plugin.h
+++ b/include/qemu/qemu-plugin.h
@@ -393,24 +393,48 @@ uint64_t qemu_plugin_insn_vaddr(const struct
qemu_plugin_insn *insn);
*/
void *qemu_plugin_insn_haddr(const struct qemu_plugin_insn *insn);
-/*
- * Memory Instrumentation
+/**
+ * typedef qemu_plugin_meminfo_t - opaque memory transaction handle
*
- * The anonymous qemu_plugin_meminfo_t and qemu_plugin_hwaddr types
- * can be used in queries to QEMU to get more information about a
- * given memory access.
+ * This can be further queried using the qemu_plugin_mem_* query
+ * functions.
*/
typedef uint32_t qemu_plugin_meminfo_t;
+/** struct qemu_plugin_hwaddr - opaque hw address handle */
struct qemu_plugin_hwaddr;
-/* meminfo queries */
+/**
+ * qemu_plugin_mem_size_shift() - get size of access
+ * @info: opaque memory transaction handle
+ *
+ * Returns: size of access in ^2 (0=byte, 1=16bit, 2=32bit etc...)
+ */
unsigned int qemu_plugin_mem_size_shift(qemu_plugin_meminfo_t info);
+/**
+ * qemu_plugin_mem_is_sign_extended() - was the access sign extended
+ * @info: opaque memory transaction handle
+ *
+ * Returns: true if it was, otherwise false
+ */
bool qemu_plugin_mem_is_sign_extended(qemu_plugin_meminfo_t info);
+/**
+ * qemu_plugin_mem_is_big_endian() - was the access big endian
+ * @info: opaque memory transaction handle
+ *
+ * Returns: true if it was, otherwise false
+ */
bool qemu_plugin_mem_is_big_endian(qemu_plugin_meminfo_t info);
+/**
+ * qemu_plugin_mem_is_store() - was the access a store
+ * @info: opaque memory transaction handle
+ *
+ * Returns: true if it was, otherwise false
+ */
bool qemu_plugin_mem_is_store(qemu_plugin_meminfo_t info);
/**
* qemu_plugin_get_hwaddr() - return handle for memory operation
+ * @info: opaque memory info structure
* @vaddr: the virtual address of the memory operation
*
* For system emulation returns a qemu_plugin_hwaddr handle to query
--
2.20.1
- Re: [PULL v2 01/15] utils: Use fixed-point arithmetic in qemu_strtosz, (continued)
- [PULL v2 03/15] plugins: Expose physical addresses instead of device offsets, Alex Bennée, 2021/03/17
- [PULL v2 04/15] plugins: expand kernel-doc for qemu_info_t, Alex Bennée, 2021/03/17
- [PULL v2 02/15] plugins: new syscalls plugin, Alex Bennée, 2021/03/17
- [PULL v2 08/15] plugins: add qemu_plugin_cb_flags to kernel-doc, Alex Bennée, 2021/03/17
- [PULL v2 07/15] plugins: expand the typedef kernel-docs for translation, Alex Bennée, 2021/03/17
- [PULL v2 05/15] plugins: cleanup kernel-doc for qemu_plugin_install, Alex Bennée, 2021/03/17
- [PULL v2 06/15] plugins: expand the callback typedef kernel-docs, Alex Bennée, 2021/03/17
- [PULL v2 09/15] plugins: add qemu_plugin_id_t to kernel-doc, Alex Bennée, 2021/03/17
- [PULL v2 12/15] plugins: expand kernel-doc for memory query and instrumentation,
Alex Bennée <=
- [PULL v2 10/15] plugins: expand inline exec kernel-doc documentation., Alex Bennée, 2021/03/17
- [PULL v2 11/15] plugins: expand kernel-doc for instruction query and instrumentation, Alex Bennée, 2021/03/17
- [PULL v2 13/15] plugins: getting qemu_plugin_get_hwaddr only expose one function prototype, Alex Bennée, 2021/03/17
- [PULL v2 15/15] hw/core: Only build guest-loader if libfdt is available, Alex Bennée, 2021/03/17
- [PULL v2 14/15] plugins: Fixes typo in qemu-plugin.h, Alex Bennée, 2021/03/17
- Re: [PULL v2 00/15] misc fixes (strtoz, plugins, guest-loader), Peter Maydell, 2021/03/18