]>
Commit | Line | Data |
---|---|---|
21cd70df WX |
1 | # |
2 | # QAPI event generator | |
3 | # | |
4 | # Copyright (c) 2014 Wenchao Xia | |
a16e3e5c | 5 | # Copyright (c) 2015-2016 Red Hat Inc. |
21cd70df WX |
6 | # |
7 | # Authors: | |
8 | # Wenchao Xia <wenchaoqemu@gmail.com> | |
05f43a96 | 9 | # Markus Armbruster <armbru@redhat.com> |
21cd70df WX |
10 | # |
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 | ||
21cd70df | 14 | from qapi import * |
21cd70df | 15 | |
e98859a9 | 16 | |
48825ca4 | 17 | def gen_event_send_proto(name, arg_type, boxed): |
03b4367a MA |
18 | return 'void qapi_event_send_%(c_name)s(%(param)s)' % { |
19 | 'c_name': c_name(name.lower()), | |
48825ca4 | 20 | 'param': gen_params(arg_type, boxed, 'Error **errp')} |
21cd70df | 21 | |
21cd70df | 22 | |
48825ca4 | 23 | def gen_event_send_decl(name, arg_type, boxed): |
21cd70df WX |
24 | return mcgen(''' |
25 | ||
e98859a9 | 26 | %(proto)s; |
21cd70df | 27 | ''', |
48825ca4 | 28 | proto=gen_event_send_proto(name, arg_type, boxed)) |
e98859a9 | 29 | |
21cd70df | 30 | |
0949e95b EB |
31 | # Declare and initialize an object 'qapi' using parameters from gen_params() |
32 | def 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 | ''') | |
4d0b268f EB |
52 | if not typ.is_implicit(): |
53 | ret += mcgen(''' | |
54 | %(c_name)s *arg = ¶m; | |
55 | ''', | |
56 | c_name=typ.c_name()) | |
0949e95b EB |
57 | return ret |
58 | ||
59 | ||
48825ca4 | 60 | def gen_event_send(name, arg_type, boxed): |
0949e95b EB |
61 | # 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. | |
e98859a9 | 67 | ret = mcgen(''' |
21cd70df | 68 | |
e98859a9 | 69 | %(proto)s |
21cd70df WX |
70 | { |
71 | QDict *qmp; | |
2a0f50e8 | 72 | Error *err = NULL; |
21cd70df | 73 | QMPEventFuncEmit emit; |
e98859a9 | 74 | ''', |
48825ca4 | 75 | proto=gen_event_send_proto(name, arg_type, boxed)) |
21cd70df | 76 | |
b6167706 | 77 | if arg_type and not arg_type.is_empty(): |
e98859a9 | 78 | ret += mcgen(''' |
3b098d56 | 79 | QObject *obj; |
21cd70df | 80 | Visitor *v; |
e98859a9 | 81 | ''') |
0949e95b | 82 | ret += gen_param_var(arg_type) |
21cd70df | 83 | |
e98859a9 | 84 | ret += mcgen(''' |
0949e95b | 85 | |
21cd70df WX |
86 | emit = qmp_event_get_func_emit(); |
87 | if (!emit) { | |
88 | return; | |
89 | } | |
90 | ||
e98859a9 | 91 | qmp = qmp_event_build_dict("%(name)s"); |
21cd70df | 92 | |
e98859a9 MA |
93 | ''', |
94 | name=name) | |
21cd70df | 95 | |
b6167706 | 96 | if arg_type and not arg_type.is_empty(): |
e98859a9 | 97 | ret += mcgen(''' |
3b098d56 | 98 | v = qmp_output_visitor_new(&obj); |
4d0b268f EB |
99 | ''') |
100 | if not arg_type.is_implicit(): | |
101 | ret += mcgen(''' | |
102 | visit_type_%(c_name)s(v, "%(name)s", &arg, &err); | |
103 | ''', | |
104 | name=name, c_name=arg_type.c_name()) | |
105 | else: | |
106 | ret += mcgen(''' | |
21cd70df | 107 | |
337283df | 108 | visit_start_struct(v, "%(name)s", NULL, 0, &err); |
0949e95b EB |
109 | if (err) { |
110 | goto out; | |
111 | } | |
112 | visit_type_%(c_name)s_members(v, ¶m, &err); | |
15c2f669 EB |
113 | if (!err) { |
114 | visit_check_struct(v, &err); | |
115 | } | |
1158bb2a | 116 | visit_end_struct(v, NULL); |
4d0b268f EB |
117 | ''', |
118 | name=name, c_name=arg_type.c_name()) | |
119 | ret += mcgen(''' | |
2a0f50e8 | 120 | if (err) { |
f782399c | 121 | goto out; |
21cd70df WX |
122 | } |
123 | ||
3b098d56 EB |
124 | visit_complete(v, &obj); |
125 | qdict_put_obj(qmp, "data", obj); | |
4d0b268f | 126 | ''') |
21cd70df | 127 | |
e98859a9 | 128 | ret += mcgen(''' |
2a0f50e8 | 129 | emit(%(c_enum)s, qmp, &err); |
21cd70df | 130 | |
e98859a9 MA |
131 | ''', |
132 | c_enum=c_enum_const(event_enum_name, name)) | |
21cd70df | 133 | |
b6167706 | 134 | if arg_type and not arg_type.is_empty(): |
e98859a9 | 135 | ret += mcgen(''' |
f782399c | 136 | out: |
2c0ef9f4 | 137 | visit_free(v); |
e98859a9 MA |
138 | ''') |
139 | ret += mcgen(''' | |
2a0f50e8 | 140 | error_propagate(errp, err); |
21cd70df WX |
141 | QDECREF(qmp); |
142 | } | |
e98859a9 | 143 | ''') |
21cd70df WX |
144 | return ret |
145 | ||
05f43a96 MA |
146 | |
147 | class QAPISchemaGenEventVisitor(QAPISchemaVisitor): | |
148 | def __init__(self): | |
149 | self.decl = None | |
150 | self.defn = None | |
151 | self._event_names = None | |
152 | ||
153 | def visit_begin(self, schema): | |
154 | self.decl = '' | |
155 | self.defn = '' | |
156 | self._event_names = [] | |
157 | ||
158 | def visit_end(self): | |
e98859a9 MA |
159 | self.decl += gen_enum(event_enum_name, self._event_names) |
160 | self.defn += gen_enum_lookup(event_enum_name, self._event_names) | |
05f43a96 MA |
161 | self._event_names = None |
162 | ||
48825ca4 EB |
163 | def visit_event(self, name, info, arg_type, boxed): |
164 | self.decl += gen_event_send_decl(name, arg_type, boxed) | |
165 | self.defn += gen_event_send(name, arg_type, boxed) | |
05f43a96 MA |
166 | self._event_names.append(name) |
167 | ||
168 | ||
2114f5a9 | 169 | (input_file, output_dir, do_c, do_h, prefix, dummy) = parse_command_line() |
21cd70df | 170 | |
12f8e1b9 | 171 | c_comment = ''' |
21cd70df WX |
172 | /* |
173 | * schema-defined QAPI event functions | |
174 | * | |
175 | * Copyright (c) 2014 Wenchao Xia | |
176 | * | |
177 | * Authors: | |
178 | * Wenchao Xia <wenchaoqemu@gmail.com> | |
179 | * | |
180 | * This work is licensed under the terms of the GNU LGPL, version 2.1 or later. | |
181 | * See the COPYING.LIB file in the top-level directory. | |
182 | * | |
183 | */ | |
12f8e1b9 MA |
184 | ''' |
185 | h_comment = ''' | |
21cd70df WX |
186 | /* |
187 | * schema-defined QAPI event functions | |
188 | * | |
189 | * Copyright (c) 2014 Wenchao Xia | |
190 | * | |
191 | * Authors: | |
192 | * Wenchao Xia <wenchaoqemu@gmail.com> | |
193 | * | |
194 | * This work is licensed under the terms of the GNU LGPL, version 2.1 or later. | |
195 | * See the COPYING.LIB file in the top-level directory. | |
196 | * | |
197 | */ | |
12f8e1b9 | 198 | ''' |
21cd70df | 199 | |
12f8e1b9 MA |
200 | (fdef, fdecl) = open_output(output_dir, do_c, do_h, prefix, |
201 | 'qapi-event.c', 'qapi-event.h', | |
202 | c_comment, h_comment) | |
21cd70df | 203 | |
12f8e1b9 | 204 | fdef.write(mcgen(''' |
9167ebd9 | 205 | #include "qemu/osdep.h" |
12f8e1b9 MA |
206 | #include "qemu-common.h" |
207 | #include "%(prefix)sqapi-event.h" | |
208 | #include "%(prefix)sqapi-visit.h" | |
209 | #include "qapi/qmp-output-visitor.h" | |
210 | #include "qapi/qmp-event.h" | |
211 | ||
212 | ''', | |
213 | prefix=prefix)) | |
214 | ||
215 | fdecl.write(mcgen(''' | |
21cd70df WX |
216 | #include "qapi/error.h" |
217 | #include "qapi/qmp/qdict.h" | |
218 | #include "%(prefix)sqapi-types.h" | |
219 | ||
220 | ''', | |
12f8e1b9 | 221 | prefix=prefix)) |
21cd70df | 222 | |
016a335b | 223 | event_enum_name = c_name(prefix + "QAPIEvent", protect=False) |
05f43a96 MA |
224 | |
225 | schema = QAPISchema(input_file) | |
226 | gen = QAPISchemaGenEventVisitor() | |
227 | schema.visit(gen) | |
228 | fdef.write(gen.defn) | |
229 | fdecl.write(gen.decl) | |
21cd70df | 230 | |
12f8e1b9 | 231 | close_output(fdef, fdecl) |