diff mbox series

[v1,12/14] plugins: expand kernel-doc for memory query and instrumentation

Message ID 20210312172821.31647-13-alex.bennee@linaro.org
State Superseded
Headers show
Series plugins/next (phys addr, syscalls, lots of docs) | expand

Commit Message

Alex Bennée March 12, 2021, 5:28 p.m. UTC
Signed-off-by: Alex Bennée <alex.bennee@linaro.org>

---
 include/qemu/qemu-plugin.h | 35 ++++++++++++++++++++++++++++-------
 1 file changed, 28 insertions(+), 7 deletions(-)

-- 
2.20.1

Comments

Gonglei (Arei)" via March 12, 2021, 6:40 p.m. UTC | #1
On Mar 12 17:28, Alex Bennée wrote:
> Signed-off-by: Alex Bennée <alex.bennee@linaro.org>


Small comment below, but otherwise:

Reviewed-by: Aaron Lindsay <aaron@os.amperecomputing.com>


> ---

>  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


Would it still be useful to include the types of things you can do
with a qemu_plugin_meminfo_t here?
Alex Bennée March 16, 2021, 1:55 p.m. UTC | #2
Aaron Lindsay <aaron@os.amperecomputing.com> writes:

> On Mar 12 17:28, Alex Bennée wrote:

>> Signed-off-by: Alex Bennée <alex.bennee@linaro.org>

>

> Small comment below, but otherwise:

>

> Reviewed-by: Aaron Lindsay <aaron@os.amperecomputing.com>

>

>> ---

>>  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

>

> Would it still be useful to include the types of things you can do

> with a qemu_plugin_meminfo_t here?


I've referenced it can be "..further queried using the qemu_plugin_mem_*
query functions."

-- 
Alex Bennée
diff mbox series

Patch

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