docs/qapi-code-gen: update to cover trace events code generation
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> Message-Id: <20220126161130.3240892-6-vsementsov@virtuozzo.com> Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com> Reviewed-by: Markus Armbruster <armbru@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>staging
parent
b83a80e831
commit
ff8e4827ad
|
@ -1630,6 +1630,9 @@ The following files are generated:
|
||||||
``$(prefix)qapi-commands.h``
|
``$(prefix)qapi-commands.h``
|
||||||
Function prototypes for the QMP commands specified in the schema
|
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``
|
``$(prefix)qapi-init-commands.h``
|
||||||
Command initialization prototype
|
Command initialization prototype
|
||||||
|
|
||||||
|
@ -1650,6 +1653,13 @@ Example::
|
||||||
void qmp_marshal_my_command(QDict *args, QObject **ret, Error **errp);
|
void qmp_marshal_my_command(QDict *args, QObject **ret, Error **errp);
|
||||||
|
|
||||||
#endif /* EXAMPLE_QAPI_COMMANDS_H */
|
#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
|
$ cat qapi-generated/example-qapi-commands.c
|
||||||
[Uninteresting stuff omitted...]
|
[Uninteresting stuff omitted...]
|
||||||
|
|
||||||
|
@ -1689,14 +1699,27 @@ Example::
|
||||||
goto out;
|
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);
|
retval = qmp_my_command(arg.arg1, &err);
|
||||||
if (err) {
|
if (err) {
|
||||||
|
trace_qmp_exit_my_command(error_get_pretty(err), false);
|
||||||
error_propagate(errp, err);
|
error_propagate(errp, err);
|
||||||
goto out;
|
goto out;
|
||||||
}
|
}
|
||||||
|
|
||||||
qmp_marshal_output_UserDefOne(retval, ret, errp);
|
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:
|
out:
|
||||||
visit_free(v);
|
visit_free(v);
|
||||||
v = qapi_dealloc_visitor_new();
|
v = qapi_dealloc_visitor_new();
|
||||||
|
|
|
@ -1,3 +1,5 @@
|
||||||
|
.. _tracing:
|
||||||
|
|
||||||
=======
|
=======
|
||||||
Tracing
|
Tracing
|
||||||
=======
|
=======
|
||||||
|
|
Loading…
Reference in New Issue