blob: 0485e39145e2281ce67db2017905d7cbf8789f88 [file] [log] [blame]
Wenchao Xia21cd70d2014-06-18 08:43:28 +02001#
2# QAPI event generator
3#
4# Copyright (c) 2014 Wenchao Xia
Eric Blakea16e3e52016-01-29 06:48:46 -07005# Copyright (c) 2015-2016 Red Hat Inc.
Wenchao Xia21cd70d2014-06-18 08:43:28 +02006#
7# Authors:
8# Wenchao Xia <wenchaoqemu@gmail.com>
Markus Armbruster05f43a92015-09-16 13:06:14 +02009# Markus Armbruster <armbru@redhat.com>
Wenchao Xia21cd70d2014-06-18 08:43:28 +020010#
11# This work is licensed under the terms of the GNU GPL, version 2.
12# See the COPYING file in the top-level directory.
13
Wenchao Xia21cd70d2014-06-18 08:43:28 +020014from qapi import *
Wenchao Xia21cd70d2014-06-18 08:43:28 +020015
Markus Armbrustere98859a2015-09-16 13:06:16 +020016
Eric Blake48825ca2016-07-13 21:50:19 -060017def gen_event_send_proto(name, arg_type, boxed):
Markus Armbruster03b43672015-09-16 13:06:20 +020018 return 'void qapi_event_send_%(c_name)s(%(param)s)' % {
19 'c_name': c_name(name.lower()),
Eric Blake48825ca2016-07-13 21:50:19 -060020 'param': gen_params(arg_type, boxed, 'Error **errp')}
Wenchao Xia21cd70d2014-06-18 08:43:28 +020021
22
Eric Blake48825ca2016-07-13 21:50:19 -060023def gen_event_send_decl(name, arg_type, boxed):
Wenchao Xia21cd70d2014-06-18 08:43:28 +020024 return mcgen('''
25
Markus Armbrustere98859a2015-09-16 13:06:16 +020026%(proto)s;
Wenchao Xia21cd70d2014-06-18 08:43:28 +020027''',
Eric Blake48825ca2016-07-13 21:50:19 -060028 proto=gen_event_send_proto(name, arg_type, boxed))
Wenchao Xia21cd70d2014-06-18 08:43:28 +020029
Wenchao Xia21cd70d2014-06-18 08:43:28 +020030
Eric Blake0949e952016-03-17 16:48:32 -060031# Declare and initialize an object 'qapi' using parameters from gen_params()
32def gen_param_var(typ):
33 assert not typ.variants
34 ret = mcgen('''
35 %(c_name)s param = {
36''',
37 c_name=typ.c_name())
38 sep = ' '
39 for memb in typ.members:
40 ret += sep
41 sep = ', '
42 if memb.optional:
43 ret += 'has_' + c_name(memb.name) + sep
44 if memb.type.name == 'str':
45 # Cast away const added in gen_params()
46 ret += '(char *)'
47 ret += c_name(memb.name)
48 ret += mcgen('''
49
50 };
51''')
Eric Blake4d0b2682016-07-13 21:50:18 -060052 if not typ.is_implicit():
53 ret += mcgen('''
54 %(c_name)s *arg = &param;
55''',
56 c_name=typ.c_name())
Eric Blake0949e952016-03-17 16:48:32 -060057 return ret
58
59
Eric Blake48825ca2016-07-13 21:50:19 -060060def gen_event_send(name, arg_type, boxed):
Eric Blake0949e952016-03-17 16:48:32 -060061 # FIXME: Our declaration of local variables (and of 'errp' in the
62 # parameter list) can collide with exploded members of the event's
63 # data type passed in as parameters. If this collision ever hits in
64 # practice, we can rename our local variables with a leading _ prefix,
65 # or split the code into a wrapper function that creates a boxed
66 # 'param' object then calls another to do the real work.
Markus Armbrustere98859a2015-09-16 13:06:16 +020067 ret = mcgen('''
68
69%(proto)s
Wenchao Xia21cd70d2014-06-18 08:43:28 +020070{
71 QDict *qmp;
Eric Blake2a0f50e2015-09-29 16:21:08 -060072 Error *err = NULL;
Wenchao Xia21cd70d2014-06-18 08:43:28 +020073 QMPEventFuncEmit emit;
Markus Armbrustere98859a2015-09-16 13:06:16 +020074''',
Eric Blake48825ca2016-07-13 21:50:19 -060075 proto=gen_event_send_proto(name, arg_type, boxed))
Wenchao Xia21cd70d2014-06-18 08:43:28 +020076
Eric Blakeb6167702016-07-13 21:50:16 -060077 if arg_type and not arg_type.is_empty():
Markus Armbrustere98859a2015-09-16 13:06:16 +020078 ret += mcgen('''
Eric Blake3b098d52016-06-09 10:48:43 -060079 QObject *obj;
Wenchao Xia21cd70d2014-06-18 08:43:28 +020080 Visitor *v;
Markus Armbrustere98859a2015-09-16 13:06:16 +020081''')
Eric Blakec8184082016-07-13 21:50:20 -060082 if not boxed:
83 ret += gen_param_var(arg_type)
84 else:
85 assert not boxed
Wenchao Xia21cd70d2014-06-18 08:43:28 +020086
Markus Armbrustere98859a2015-09-16 13:06:16 +020087 ret += mcgen('''
Eric Blake0949e952016-03-17 16:48:32 -060088
Wenchao Xia21cd70d2014-06-18 08:43:28 +020089 emit = qmp_event_get_func_emit();
90 if (!emit) {
91 return;
92 }
93
Markus Armbrustere98859a2015-09-16 13:06:16 +020094 qmp = qmp_event_build_dict("%(name)s");
Wenchao Xia21cd70d2014-06-18 08:43:28 +020095
Markus Armbrustere98859a2015-09-16 13:06:16 +020096''',
97 name=name)
Wenchao Xia21cd70d2014-06-18 08:43:28 +020098
Eric Blakeb6167702016-07-13 21:50:16 -060099 if arg_type and not arg_type.is_empty():
Markus Armbrustere98859a2015-09-16 13:06:16 +0200100 ret += mcgen('''
Daniel P. Berrange7d5e1992016-09-30 15:45:28 +0100101 v = qobject_output_visitor_new(&obj);
Eric Blake4d0b2682016-07-13 21:50:18 -0600102''')
103 if not arg_type.is_implicit():
104 ret += mcgen('''
105 visit_type_%(c_name)s(v, "%(name)s", &arg, &err);
106''',
107 name=name, c_name=arg_type.c_name())
108 else:
109 ret += mcgen('''
Wenchao Xia21cd70d2014-06-18 08:43:28 +0200110
Eric Blake337283d2016-01-29 06:48:57 -0700111 visit_start_struct(v, "%(name)s", NULL, 0, &err);
Eric Blake0949e952016-03-17 16:48:32 -0600112 if (err) {
113 goto out;
114 }
115 visit_type_%(c_name)s_members(v, &param, &err);
Eric Blake15c2f662016-04-28 15:45:27 -0600116 if (!err) {
117 visit_check_struct(v, &err);
118 }
Eric Blake1158bb22016-06-09 10:48:34 -0600119 visit_end_struct(v, NULL);
Eric Blake4d0b2682016-07-13 21:50:18 -0600120''',
121 name=name, c_name=arg_type.c_name())
122 ret += mcgen('''
Eric Blake2a0f50e2015-09-29 16:21:08 -0600123 if (err) {
Eric Blakef7823992015-09-29 16:21:10 -0600124 goto out;
Wenchao Xia21cd70d2014-06-18 08:43:28 +0200125 }
126
Eric Blake3b098d52016-06-09 10:48:43 -0600127 visit_complete(v, &obj);
128 qdict_put_obj(qmp, "data", obj);
Eric Blake4d0b2682016-07-13 21:50:18 -0600129''')
Wenchao Xia21cd70d2014-06-18 08:43:28 +0200130
Markus Armbrustere98859a2015-09-16 13:06:16 +0200131 ret += mcgen('''
Eric Blake2a0f50e2015-09-29 16:21:08 -0600132 emit(%(c_enum)s, qmp, &err);
Wenchao Xia21cd70d2014-06-18 08:43:28 +0200133
Markus Armbrustere98859a2015-09-16 13:06:16 +0200134''',
135 c_enum=c_enum_const(event_enum_name, name))
Wenchao Xia21cd70d2014-06-18 08:43:28 +0200136
Eric Blakeb6167702016-07-13 21:50:16 -0600137 if arg_type and not arg_type.is_empty():
Markus Armbrustere98859a2015-09-16 13:06:16 +0200138 ret += mcgen('''
Eric Blakef7823992015-09-29 16:21:10 -0600139out:
Eric Blake2c0ef9f2016-06-09 10:48:35 -0600140 visit_free(v);
Markus Armbrustere98859a2015-09-16 13:06:16 +0200141''')
142 ret += mcgen('''
Eric Blake2a0f50e2015-09-29 16:21:08 -0600143 error_propagate(errp, err);
Wenchao Xia21cd70d2014-06-18 08:43:28 +0200144 QDECREF(qmp);
145}
Markus Armbrustere98859a2015-09-16 13:06:16 +0200146''')
Wenchao Xia21cd70d2014-06-18 08:43:28 +0200147 return ret
148
Markus Armbruster05f43a92015-09-16 13:06:14 +0200149
150class QAPISchemaGenEventVisitor(QAPISchemaVisitor):
151 def __init__(self):
152 self.decl = None
153 self.defn = None
154 self._event_names = None
155
156 def visit_begin(self, schema):
157 self.decl = ''
158 self.defn = ''
159 self._event_names = []
160
161 def visit_end(self):
Markus Armbrustere98859a2015-09-16 13:06:16 +0200162 self.decl += gen_enum(event_enum_name, self._event_names)
163 self.defn += gen_enum_lookup(event_enum_name, self._event_names)
Markus Armbruster05f43a92015-09-16 13:06:14 +0200164 self._event_names = None
165
Eric Blake48825ca2016-07-13 21:50:19 -0600166 def visit_event(self, name, info, arg_type, boxed):
167 self.decl += gen_event_send_decl(name, arg_type, boxed)
168 self.defn += gen_event_send(name, arg_type, boxed)
Markus Armbruster05f43a92015-09-16 13:06:14 +0200169 self._event_names.append(name)
170
171
Markus Armbruster2114f5a2015-04-02 13:12:21 +0200172(input_file, output_dir, do_c, do_h, prefix, dummy) = parse_command_line()
Wenchao Xia21cd70d2014-06-18 08:43:28 +0200173
Markus Armbruster12f8e1b2015-04-02 14:46:39 +0200174c_comment = '''
Wenchao Xia21cd70d2014-06-18 08:43:28 +0200175/*
176 * schema-defined QAPI event functions
177 *
178 * Copyright (c) 2014 Wenchao Xia
179 *
180 * Authors:
181 * Wenchao Xia <wenchaoqemu@gmail.com>
182 *
183 * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
184 * See the COPYING.LIB file in the top-level directory.
185 *
186 */
Markus Armbruster12f8e1b2015-04-02 14:46:39 +0200187'''
188h_comment = '''
Wenchao Xia21cd70d2014-06-18 08:43:28 +0200189/*
190 * schema-defined QAPI event functions
191 *
192 * Copyright (c) 2014 Wenchao Xia
193 *
194 * Authors:
195 * Wenchao Xia <wenchaoqemu@gmail.com>
196 *
197 * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
198 * See the COPYING.LIB file in the top-level directory.
199 *
200 */
Markus Armbruster12f8e1b2015-04-02 14:46:39 +0200201'''
Wenchao Xia21cd70d2014-06-18 08:43:28 +0200202
Markus Armbruster12f8e1b2015-04-02 14:46:39 +0200203(fdef, fdecl) = open_output(output_dir, do_c, do_h, prefix,
204 'qapi-event.c', 'qapi-event.h',
205 c_comment, h_comment)
Wenchao Xia21cd70d2014-06-18 08:43:28 +0200206
Markus Armbruster12f8e1b2015-04-02 14:46:39 +0200207fdef.write(mcgen('''
Eric Blake9167ebd2016-02-08 08:36:46 -0700208#include "qemu/osdep.h"
Markus Armbruster12f8e1b2015-04-02 14:46:39 +0200209#include "qemu-common.h"
210#include "%(prefix)sqapi-event.h"
211#include "%(prefix)sqapi-visit.h"
Daniel P. Berrangeb3db2112016-09-30 15:45:27 +0100212#include "qapi/qobject-output-visitor.h"
Markus Armbruster12f8e1b2015-04-02 14:46:39 +0200213#include "qapi/qmp-event.h"
214
215''',
216 prefix=prefix))
217
218fdecl.write(mcgen('''
Wenchao Xia21cd70d2014-06-18 08:43:28 +0200219#include "qapi/error.h"
220#include "qapi/qmp/qdict.h"
221#include "%(prefix)sqapi-types.h"
222
223''',
Markus Armbruster12f8e1b2015-04-02 14:46:39 +0200224 prefix=prefix))
Wenchao Xia21cd70d2014-06-18 08:43:28 +0200225
Markus Armbrusteref801a92017-03-15 13:57:08 +0100226event_enum_name = c_name(prefix + 'QAPIEvent', protect=False)
Wenchao Xia21cd70d2014-06-18 08:43:28 +0200227
Markus Armbruster05f43a92015-09-16 13:06:14 +0200228schema = QAPISchema(input_file)
229gen = QAPISchemaGenEventVisitor()
230schema.visit(gen)
231fdef.write(gen.defn)
232fdecl.write(gen.decl)
Wenchao Xia21cd70d2014-06-18 08:43:28 +0200233
Markus Armbruster12f8e1b2015-04-02 14:46:39 +0200234close_output(fdef, fdecl)