[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v1 12/14] plugins: expand kernel-doc for memory query and instrum
From: |
Alex Bennée |
Subject: |
[PATCH v1 12/14] plugins: expand kernel-doc for memory query and instrumentation |
Date: |
Fri, 12 Mar 2021 17:28:19 +0000 |
Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
---
include/qemu/qemu-plugin.h | 35 ++++++++++++++++++++++++++++-------
1 file changed, 28 insertions(+), 7 deletions(-)
diff --git a/include/qemu/qemu-plugin.h b/include/qemu/qemu-plugin.h
index d4adce730a..aed868d42a 100644
--- a/include/qemu/qemu-plugin.h
+++ b/include/qemu/qemu-plugin.h
@@ -392,24 +392,45 @@ 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
- *
- * 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.
+/**
+ * typedef qemu_plugin_meminfo_t - opaque memory transaction handle
*/
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: [PATCH v1 08/14] plugins: add qemu_plugin_cb_flags to kernel-doc, (continued)
- [PATCH v1 07/14] plugins: expand the typedef kernel-docs for translation, Alex Bennée, 2021/03/12
- [PATCH v1 10/14] plugins: expand inline exec kernel-doc documentation., Alex Bennée, 2021/03/12
- [PATCH v1 04/14] plugins: expand kernel-doc for qemu_info_t, Alex Bennée, 2021/03/12
- [PATCH v1 06/14] plugins: expand the callback typedef kernel-docs, Alex Bennée, 2021/03/12
- [PATCH v1 12/14] plugins: expand kernel-doc for memory query and instrumentation,
Alex Bennée <=
- [PATCH v1 09/14] plugins: add qemu_plugin_id_t to kernel-doc, Alex Bennée, 2021/03/12
- [PATCH v1 13/14] plugins: getting qemu_plugin_get_hwaddr only expose one function prototype, Alex Bennée, 2021/03/12
- [PATCH v1 11/14] plugins: expand kernel-doc for instruction query and instrumentation, Alex Bennée, 2021/03/12
- [PATCH v1 14/14] plugins: Fixes typo in qemu-plugin.h, Alex Bennée, 2021/03/12