2 QAPI introspection generator
4 Copyright (C) 2015-2018 Red Hat, Inc.
7 Markus Armbruster <armbru@redhat.com>
9 This work is licensed under the terms of the GNU GPL, version 2.
10 See the COPYING file in the top-level directory.
19 from .gen
import QAPISchemaMonolithicCVisitor
22 QAPISchemaBuiltinType
,
27 def _make_tree(obj
, ifcond
, features
, extra
=None):
33 obj
['features'] = [(f
.name
, {'if': f
.ifcond
}) for f
in features
]
39 def _tree_to_qlit(obj
, level
=0, suppress_first_indent
=False):
42 return level
* 4 * ' '
44 if isinstance(obj
, tuple):
46 ifcond
= extra
.get('if')
47 comment
= extra
.get('comment')
50 ret
+= indent(level
) + '/* %s */\n' % comment
53 ret
+= _tree_to_qlit(ifobj
, level
)
55 ret
+= '\n' + gen_endif(ifcond
)
59 if not suppress_first_indent
:
63 elif isinstance(obj
, str):
64 ret
+= 'QLIT_QSTR(' + to_c_string(obj
) + ')'
65 elif isinstance(obj
, list):
66 elts
= [_tree_to_qlit(elt
, level
+ 1).strip('\n')
68 elts
.append(indent(level
+ 1) + "{}")
69 ret
+= 'QLIT_QLIST(((QLitObject[]) {\n'
70 ret
+= '\n'.join(elts
) + '\n'
71 ret
+= indent(level
) + '}))'
72 elif isinstance(obj
, dict):
74 for key
, value
in sorted(obj
.items()):
75 elts
.append(indent(level
+ 1) + '{ %s, %s }' %
77 _tree_to_qlit(value
, level
+ 1, True)))
78 elts
.append(indent(level
+ 1) + '{}')
79 ret
+= 'QLIT_QDICT(((QLitDictEntry[]) {\n'
80 ret
+= ',\n'.join(elts
) + '\n'
81 ret
+= indent(level
) + '}))'
82 elif isinstance(obj
, bool):
83 ret
+= 'QLIT_QBOOL(%s)' % ('true' if obj
else 'false')
85 assert False # not implemented
91 def to_c_string(string
):
92 return '"' + string
.replace('\\', r
'\\').replace('"', r
'\"') + '"'
95 class QAPISchemaGenIntrospectVisitor(QAPISchemaMonolithicCVisitor
):
97 def __init__(self
, prefix
, unmask
):
99 prefix
, 'qapi-introspect',
100 ' * QAPI/QMP schema introspection', __doc__
)
101 self
._unmask
= unmask
104 self
._used
_types
= []
106 self
._genc
.add(mcgen('''
107 #include "qemu/osdep.h"
108 #include "%(prefix)sqapi-introspect.h"
113 def visit_begin(self
, schema
):
114 self
._schema
= schema
117 # visit the types that are actually used
118 for typ
in self
._used
_types
:
121 name
= c_name(self
._prefix
, protect
=False) + 'qmp_schema_qlit'
122 self
._genh
.add(mcgen('''
123 #include "qapi/qmp/qlit.h"
125 extern const QLitObject %(c_name)s;
127 c_name
=c_name(name
)))
128 self
._genc
.add(mcgen('''
129 const QLitObject %(c_name)s = %(c_string)s;
132 c_string
=_tree_to_qlit(self
._trees
)))
135 self
._used
_types
= []
138 def visit_needed(self
, entity
):
139 # Ignore types on first pass; visit_end() will pick up used types
140 return not isinstance(entity
, QAPISchemaType
)
142 def _name(self
, name
):
145 if name
not in self
._name
_map
:
146 self
._name
_map
[name
] = '%d' % len(self
._name
_map
)
147 return self
._name
_map
[name
]
149 def _use_type(self
, typ
):
150 # Map the various integer types to plain int
151 if typ
.json_type() == 'int':
152 typ
= self
._schema
.lookup_type('int')
153 elif (isinstance(typ
, QAPISchemaArrayType
) and
154 typ
.element_type
.json_type() == 'int'):
155 typ
= self
._schema
.lookup_type('intList')
156 # Add type to work queue if new
157 if typ
not in self
._used
_types
:
158 self
._used
_types
.append(typ
)
159 # Clients should examine commands and events, not types. Hide
160 # type names as integers to reduce the temptation. Also, it
161 # saves a few characters on the wire.
162 if isinstance(typ
, QAPISchemaBuiltinType
):
164 if isinstance(typ
, QAPISchemaArrayType
):
165 return '[' + self
._use
_type
(typ
.element_type
) + ']'
166 return self
._name
(typ
.name
)
168 def _gen_tree(self
, name
, mtype
, obj
, ifcond
, features
):
170 if mtype
not in ('command', 'event', 'builtin', 'array'):
172 # Output a comment to make it easy to map masked names
173 # back to the source when reading the generated output.
174 extra
= {'comment': '"%s" = %s' % (self
._name
(name
), name
)}
175 name
= self
._name
(name
)
177 obj
['meta-type'] = mtype
178 self
._trees
.append(_make_tree(obj
, ifcond
, features
, extra
))
180 def _gen_member(self
, member
):
181 obj
= {'name': member
.name
, 'type': self
._use
_type
(member
.type)}
183 obj
['default'] = None
184 return _make_tree(obj
, member
.ifcond
, member
.features
)
186 def _gen_variants(self
, tag_name
, variants
):
187 return {'tag': tag_name
,
188 'variants': [self
._gen
_variant
(v
) for v
in variants
]}
190 def _gen_variant(self
, variant
):
191 obj
= {'case': variant
.name
, 'type': self
._use
_type
(variant
.type)}
192 return _make_tree(obj
, variant
.ifcond
, None)
194 def visit_builtin_type(self
, name
, info
, json_type
):
195 self
._gen
_tree
(name
, 'builtin', {'json-type': json_type
}, [], None)
197 def visit_enum_type(self
, name
, info
, ifcond
, features
, members
, prefix
):
198 self
._gen
_tree
(name
, 'enum',
199 {'values': [_make_tree(m
.name
, m
.ifcond
, None)
203 def visit_array_type(self
, name
, info
, ifcond
, element_type
):
204 element
= self
._use
_type
(element_type
)
205 self
._gen
_tree
('[' + element
+ ']', 'array', {'element-type': element
},
208 def visit_object_type_flat(self
, name
, info
, ifcond
, features
,
210 obj
= {'members': [self
._gen
_member
(m
) for m
in members
]}
212 obj
.update(self
._gen
_variants
(variants
.tag_member
.name
,
215 self
._gen
_tree
(name
, 'object', obj
, ifcond
, features
)
217 def visit_alternate_type(self
, name
, info
, ifcond
, features
, variants
):
218 self
._gen
_tree
(name
, 'alternate',
220 _make_tree({'type': self
._use
_type
(m
.type)},
222 for m
in variants
.variants
]},
225 def visit_command(self
, name
, info
, ifcond
, features
,
226 arg_type
, ret_type
, gen
, success_response
, boxed
,
227 allow_oob
, allow_preconfig
, coroutine
):
228 arg_type
= arg_type
or self
._schema
.the_empty_object_type
229 ret_type
= ret_type
or self
._schema
.the_empty_object_type
230 obj
= {'arg-type': self
._use
_type
(arg_type
),
231 'ret-type': self
._use
_type
(ret_type
)}
233 obj
['allow-oob'] = allow_oob
234 self
._gen
_tree
(name
, 'command', obj
, ifcond
, features
)
236 def visit_event(self
, name
, info
, ifcond
, features
, arg_type
, boxed
):
237 arg_type
= arg_type
or self
._schema
.the_empty_object_type
238 self
._gen
_tree
(name
, 'event', {'arg-type': self
._use
_type
(arg_type
)},
242 def gen_introspect(schema
, output_dir
, prefix
, opt_unmask
):
243 vis
= QAPISchemaGenIntrospectVisitor(prefix
, opt_unmask
)
245 vis
.write(output_dir
)