qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
To: qemu-devel@nongnu.org
Cc: stefanha@redhat.com, michael.roth@amd.com, armbru@redhat.com,
	vsementsov@virtuozzo.com, jsnow@redhat.com, hreitz@redhat.com,
	kwolf@redhat.com, pbonzini@redhat.com
Subject: [PATCH v6 5/7] docs/qapi-code-gen: update to cover trace events code generation
Date: Wed, 26 Jan 2022 17:11:28 +0100	[thread overview]
Message-ID: <20220126161130.3240892-6-vsementsov@virtuozzo.com> (raw)
In-Reply-To: <20220126161130.3240892-1-vsementsov@virtuozzo.com>

Previous commits enabled trace events generation for most of QAPI
generated code (except for tests/ and qga/). Let's update documentation
to illustrate it.

Signed-off-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
---
 docs/devel/qapi-code-gen.rst | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

diff --git a/docs/devel/qapi-code-gen.rst b/docs/devel/qapi-code-gen.rst
index feafed79b5..246709ede8 100644
--- a/docs/devel/qapi-code-gen.rst
+++ b/docs/devel/qapi-code-gen.rst
@@ -1630,6 +1630,9 @@ The following files are generated:
  ``$(prefix)qapi-commands.h``
      Function prototypes for the QMP commands specified in the schema
 
+ ``$(prefix)qapi-commands.trace-events``
+     Trace event declarations, see :ref:`tracing`.
+
  ``$(prefix)qapi-init-commands.h``
      Command initialization prototype
 
@@ -1650,6 +1653,13 @@ Example::
     void qmp_marshal_my_command(QDict *args, QObject **ret, Error **errp);
 
     #endif /* EXAMPLE_QAPI_COMMANDS_H */
+
+    $ cat qapi-generated/example-qapi-commands.trace-events
+    # AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+    qmp_enter_my_command(const char *json) "%s"
+    qmp_exit_my_command(const char *result, bool succeeded) "%s %d"
+
     $ cat qapi-generated/example-qapi-commands.c
     [Uninteresting stuff omitted...]
 
@@ -1689,14 +1699,27 @@ Example::
             goto out;
         }
 
+        if (trace_event_get_state_backends(TRACE_QMP_ENTER_MY_COMMAND)) {
+            g_autoptr(GString) req_json = qobject_to_json(QOBJECT(args));
+
+            trace_qmp_enter_my_command(req_json->str);
+        }
+
         retval = qmp_my_command(arg.arg1, &err);
         if (err) {
+            trace_qmp_exit_my_command(error_get_pretty(err), false);
             error_propagate(errp, err);
             goto out;
         }
 
         qmp_marshal_output_UserDefOne(retval, ret, errp);
 
+        if (trace_event_get_state_backends(TRACE_QMP_EXIT_MY_COMMAND)) {
+            g_autoptr(GString) ret_json = qobject_to_json(*ret);
+
+            trace_qmp_exit_my_command(ret_json->str, true);
+        }
+
     out:
         visit_free(v);
         v = qapi_dealloc_visitor_new();
-- 
2.31.1



  parent reply	other threads:[~2022-01-26 16:21 UTC|newest]

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-01-26 16:11 [PATCH v6 0/7] trace qmp commands Vladimir Sementsov-Ogievskiy
2022-01-26 16:11 ` [PATCH v6 1/7] qapi/gen: Add FOO.trace-events output module Vladimir Sementsov-Ogievskiy
2022-01-26 16:11 ` [PATCH v6 2/7] qapi/commands: refactor error handling code Vladimir Sementsov-Ogievskiy
2022-01-26 16:11 ` [PATCH v6 3/7] qapi/commands: Optionally generate trace for QMP commands Vladimir Sementsov-Ogievskiy
2022-01-27  7:24   ` Markus Armbruster
2022-01-27  9:42     ` Vladimir Sementsov-Ogievskiy
2022-01-26 16:11 ` [PATCH v6 4/7] meson: generate trace events for qmp commands Vladimir Sementsov-Ogievskiy
2022-01-26 16:11 ` Vladimir Sementsov-Ogievskiy [this message]
2022-01-27  8:20   ` [PATCH v6 5/7] docs/qapi-code-gen: update to cover trace events code generation Stefan Hajnoczi
2022-01-26 16:11 ` [PATCH v6 6/7] meson: document, why we don't generate trace events for tests/ and qga/ Vladimir Sementsov-Ogievskiy
2022-01-27  6:50   ` Markus Armbruster
2022-01-27  9:26     ` Vladimir Sementsov-Ogievskiy
2022-01-27  6:51   ` Markus Armbruster
2022-01-27  8:21   ` Stefan Hajnoczi
2022-01-26 16:11 ` [PATCH v6 7/7] qapi: generate trace events by default Vladimir Sementsov-Ogievskiy
2022-01-27  7:32 ` [PATCH v6 0/7] trace qmp commands Markus Armbruster
2022-01-27  9:41   ` Vladimir Sementsov-Ogievskiy
2022-01-27 11:10     ` Markus Armbruster
2022-01-27  8:21 ` Stefan Hajnoczi
2022-01-27  9:41   ` Vladimir Sementsov-Ogievskiy

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20220126161130.3240892-6-vsementsov@virtuozzo.com \
    --to=vsementsov@virtuozzo.com \
    --cc=armbru@redhat.com \
    --cc=hreitz@redhat.com \
    --cc=jsnow@redhat.com \
    --cc=kwolf@redhat.com \
    --cc=michael.roth@amd.com \
    --cc=pbonzini@redhat.com \
    --cc=qemu-devel@nongnu.org \
    --cc=stefanha@redhat.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).