summaryrefslogtreecommitdiffstats
path: root/docs/devel/qapi-code-gen.txt
diff options
context:
space:
mode:
authorPeter Maydell2017-09-04 14:28:09 +0200
committerPeter Maydell2017-09-04 14:28:09 +0200
commit98bfaac788be0ca63d7d010c8d4ba100ff1d8278 (patch)
treea6adc21256f54beb05f428440b0ed0e69bdddc45 /docs/devel/qapi-code-gen.txt
parentMerge remote-tracking branch 'remotes/ehabkost/tags/x86-and-machine-pull-requ... (diff)
parentqapi: drop the sentinel in enum array (diff)
downloadqemu-98bfaac788be0ca63d7d010c8d4ba100ff1d8278.tar.gz
qemu-98bfaac788be0ca63d7d010c8d4ba100ff1d8278.tar.xz
qemu-98bfaac788be0ca63d7d010c8d4ba100ff1d8278.zip
Merge remote-tracking branch 'remotes/armbru/tags/pull-qapi-2017-09-01-v3' into staging
QAPI patches for 2017-09-01 # gpg: Signature made Mon 04 Sep 2017 12:30:31 BST # gpg: using RSA key 0x3870B400EB918653 # gpg: Good signature from "Markus Armbruster <armbru@redhat.com>" # gpg: aka "Markus Armbruster <armbru@pond.sub.org>" # Primary key fingerprint: 354B C8B3 D7EB 2A6B 6867 4E5F 3870 B400 EB91 8653 * remotes/armbru/tags/pull-qapi-2017-09-01-v3: (47 commits) qapi: drop the sentinel in enum array qapi: Change data type of the FOO_lookup generated for enum FOO qapi: Convert indirect uses of FOO_lookup[...] to qapi_enum_lookup() qapi: Mechanically convert FOO_lookup[...] to FOO_str(...) qapi: Generate FOO_str() macro for QAPI enum FOO qapi: Avoid unnecessary use of enum lookup table's sentinel qapi: Use qapi_enum_parse() in input_type_enum() crypto: Use qapi_enum_parse() in qcrypto_block_luks_name_lookup() quorum: Use qapi_enum_parse() in quorum_open() block: Use qemu_enum_parse() in blkdebug_debug_breakpoint() hmp: Use qapi_enum_parse() in hmp_migrate_set_parameter() hmp: Use qapi_enum_parse() in hmp_migrate_set_capability() tpm: Clean up model registration & lookup tpm: Clean up driver registration & lookup qapi: Drop superfluous qapi_enum_parse() parameter max qapi: Update qapi-code-gen.txt examples to match current code qapi-schema: Improve section headings qapi-schema: Move queries from common.json to qapi-schema.json qapi-schema: Make block-core.json self-contained qapi-schema: Fold event.json back into qapi-schema.json ... Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Diffstat (limited to 'docs/devel/qapi-code-gen.txt')
-rw-r--r--docs/devel/qapi-code-gen.txt50
1 files changed, 41 insertions, 9 deletions
diff --git a/docs/devel/qapi-code-gen.txt b/docs/devel/qapi-code-gen.txt
index 9903ac4c19..f04c63fe82 100644
--- a/docs/devel/qapi-code-gen.txt
+++ b/docs/devel/qapi-code-gen.txt
@@ -957,6 +957,8 @@ Example:
typedef struct UserDefOneList UserDefOneList;
+ typedef struct q_obj_my_command_arg q_obj_my_command_arg;
+
struct UserDefOne {
int64_t integer;
bool has_string;
@@ -972,6 +974,10 @@ Example:
void qapi_free_UserDefOneList(UserDefOneList *obj);
+ struct q_obj_my_command_arg {
+ UserDefOneList *arg1;
+ };
+
#endif
$ cat qapi-generated/example-qapi-types.c
[Uninteresting stuff omitted...]
@@ -1036,6 +1042,8 @@ Example:
void visit_type_UserDefOne(Visitor *v, const char *name, UserDefOne **obj, Error **errp);
void visit_type_UserDefOneList(Visitor *v, const char *name, UserDefOneList **obj, Error **errp);
+ void visit_type_q_obj_my_command_arg_members(Visitor *v, q_obj_my_command_arg *obj, Error **errp);
+
#endif
$ cat qapi-generated/example-qapi-visit.c
[Uninteresting stuff omitted...]
@@ -1104,6 +1112,9 @@ Example:
}
}
+ if (!err) {
+ visit_check_list(v, &err);
+ }
visit_end_list(v, (void **)obj);
if (err && visit_is_input(v)) {
qapi_free_UserDefOneList(*obj);
@@ -1113,6 +1124,19 @@ Example:
error_propagate(errp, err);
}
+ void visit_type_q_obj_my_command_arg_members(Visitor *v, q_obj_my_command_arg *obj, Error **errp)
+ {
+ Error *err = NULL;
+
+ visit_type_UserDefOneList(v, "arg1", &obj->arg1, &err);
+ if (err) {
+ goto out;
+ }
+
+ out:
+ error_propagate(errp, err);
+ }
+
=== scripts/qapi-commands.py ===
Used to generate the marshaling/dispatch functions for the commands
@@ -1145,9 +1169,12 @@ Example:
#include "example-qapi-types.h"
#include "qapi/qmp/qdict.h"
+ #include "qapi/qmp/dispatch.h"
#include "qapi/error.h"
+ void example_qmp_init_marshal(QmpCommandList *cmds);
UserDefOne *qmp_my_command(UserDefOneList *arg1, Error **errp);
+ void qmp_marshal_my_command(QDict *args, QObject **ret, Error **errp);
#endif
$ cat qapi-generated/example-qmp-marshal.c
@@ -1170,19 +1197,19 @@ Example:
visit_free(v);
}
- static void qmp_marshal_my_command(QDict *args, QObject **ret, Error **errp)
+ void qmp_marshal_my_command(QDict *args, QObject **ret, Error **errp)
{
Error *err = NULL;
UserDefOne *retval;
Visitor *v;
- UserDefOneList *arg1 = NULL;
+ q_obj_my_command_arg arg = {0};
v = qobject_input_visitor_new(QOBJECT(args));
visit_start_struct(v, NULL, NULL, 0, &err);
if (err) {
goto out;
}
- visit_type_UserDefOneList(v, "arg1", &arg1, &err);
+ visit_type_q_obj_my_command_arg_members(v, &arg, &err);
if (!err) {
visit_check_struct(v, &err);
}
@@ -1191,7 +1218,7 @@ Example:
goto out;
}
- retval = qmp_my_command(arg1, &err);
+ retval = qmp_my_command(arg.arg1, &err);
if (err) {
goto out;
}
@@ -1203,17 +1230,18 @@ Example:
visit_free(v);
v = qapi_dealloc_visitor_new();
visit_start_struct(v, NULL, NULL, 0, NULL);
- visit_type_UserDefOneList(v, "arg1", &arg1, NULL);
+ visit_type_q_obj_my_command_arg_members(v, &arg, NULL);
visit_end_struct(v, NULL);
visit_free(v);
}
- static void qmp_init_marshal(void)
+ void example_qmp_init_marshal(QmpCommandList *cmds)
{
- qmp_register_command("my-command", qmp_marshal_my_command, QCO_NO_OPTIONS);
- }
+ QTAILQ_INIT(cmds);
- qapi_init(qmp_init_marshal);
+ qmp_register_command(cmds, "my-command",
+ qmp_marshal_my_command, QCO_NO_OPTIONS);
+ }
=== scripts/qapi-event.py ===
@@ -1247,6 +1275,9 @@ Example:
EXAMPLE_QAPI_EVENT__MAX = 1,
} example_QAPIEvent;
+ #define example_QAPIEvent_str(val) \
+ qapi_enum_lookup(example_QAPIEvent_lookup, (val))
+
extern const char *const example_QAPIEvent_lookup[];
#endif
@@ -1258,6 +1289,7 @@ Example:
QDict *qmp;
Error *err = NULL;
QMPEventFuncEmit emit;
+
emit = qmp_event_get_func_emit();
if (!emit) {
return;