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.
13 from qapi
.common
import *
14 from qapi
.gen
import QAPISchemaMonolithicCVisitor
15 from qapi
.schema
import (QAPISchemaArrayType
, QAPISchemaBuiltinType
,
19 def to_qlit(obj
, level
=0, suppress_first_indent
=False):
22 return level
* 4 * ' '
24 if isinstance(obj
, tuple):
26 ifcond
= extra
.get('if')
27 comment
= extra
.get('comment')
30 ret
+= indent(level
) + '/* %s */\n' % comment
33 ret
+= to_qlit(ifobj
, level
)
35 ret
+= '\n' + gen_endif(ifcond
)
39 if not suppress_first_indent
:
43 elif isinstance(obj
, str):
44 ret
+= 'QLIT_QSTR(' + to_c_string(obj
) + ')'
45 elif isinstance(obj
, list):
46 elts
= [to_qlit(elt
, level
+ 1).strip('\n')
48 elts
.append(indent(level
+ 1) + "{}")
49 ret
+= 'QLIT_QLIST(((QLitObject[]) {\n'
50 ret
+= '\n'.join(elts
) + '\n'
51 ret
+= indent(level
) + '}))'
52 elif isinstance(obj
, dict):
54 for key
, value
in sorted(obj
.items()):
55 elts
.append(indent(level
+ 1) + '{ %s, %s }' %
56 (to_c_string(key
), to_qlit(value
, level
+ 1, True)))
57 elts
.append(indent(level
+ 1) + '{}')
58 ret
+= 'QLIT_QDICT(((QLitDictEntry[]) {\n'
59 ret
+= ',\n'.join(elts
) + '\n'
60 ret
+= indent(level
) + '}))'
61 elif isinstance(obj
, bool):
62 ret
+= 'QLIT_QBOOL(%s)' % ('true' if obj
else 'false')
64 assert False # not implemented
70 def to_c_string(string
):
71 return '"' + string
.replace('\\', r
'\\').replace('"', r
'\"') + '"'
74 class QAPISchemaGenIntrospectVisitor(QAPISchemaMonolithicCVisitor
):
76 def __init__(self
, prefix
, unmask
):
78 prefix
, 'qapi-introspect',
79 ' * QAPI/QMP schema introspection', __doc__
)
85 self
._genc
.add(mcgen('''
86 #include "qemu/osdep.h"
87 #include "%(prefix)sqapi-introspect.h"
92 def visit_begin(self
, schema
):
96 # visit the types that are actually used
97 for typ
in self
._used
_types
:
100 name
= c_name(self
._prefix
, protect
=False) + 'qmp_schema_qlit'
101 self
._genh
.add(mcgen('''
102 #include "qapi/qmp/qlit.h"
104 extern const QLitObject %(c_name)s;
106 c_name
=c_name(name
)))
107 self
._genc
.add(mcgen('''
108 const QLitObject %(c_name)s = %(c_string)s;
111 c_string
=to_qlit(self
._qlits
)))
114 self
._used
_types
= []
117 def visit_needed(self
, entity
):
118 # Ignore types on first pass; visit_end() will pick up used types
119 return not isinstance(entity
, QAPISchemaType
)
121 def _name(self
, name
):
124 if name
not in self
._name
_map
:
125 self
._name
_map
[name
] = '%d' % len(self
._name
_map
)
126 return self
._name
_map
[name
]
128 def _use_type(self
, typ
):
129 # Map the various integer types to plain int
130 if typ
.json_type() == 'int':
131 typ
= self
._schema
.lookup_type('int')
132 elif (isinstance(typ
, QAPISchemaArrayType
) and
133 typ
.element_type
.json_type() == 'int'):
134 typ
= self
._schema
.lookup_type('intList')
135 # Add type to work queue if new
136 if typ
not in self
._used
_types
:
137 self
._used
_types
.append(typ
)
138 # Clients should examine commands and events, not types. Hide
139 # type names as integers to reduce the temptation. Also, it
140 # saves a few characters on the wire.
141 if isinstance(typ
, QAPISchemaBuiltinType
):
143 if isinstance(typ
, QAPISchemaArrayType
):
144 return '[' + self
._use
_type
(typ
.element_type
) + ']'
145 return self
._name
(typ
.name
)
147 def _gen_qlit(self
, name
, mtype
, obj
, ifcond
):
149 if mtype
not in ('command', 'event', 'builtin', 'array'):
151 # Output a comment to make it easy to map masked names
152 # back to the source when reading the generated output.
153 extra
['comment'] = '"%s" = %s' % (self
._name
(name
), name
)
154 name
= self
._name
(name
)
156 obj
['meta-type'] = mtype
160 self
._qlits
.append((obj
, extra
))
162 self
._qlits
.append(obj
)
164 def _gen_member(self
, member
):
165 ret
= {'name': member
.name
, 'type': self
._use
_type
(member
.type)}
167 ret
['default'] = None
169 ret
= (ret
, {'if': member
.ifcond
})
172 def _gen_variants(self
, tag_name
, variants
):
173 return {'tag': tag_name
,
174 'variants': [self
._gen
_variant
(v
) for v
in variants
]}
176 def _gen_variant(self
, variant
):
177 return ({'case': variant
.name
, 'type': self
._use
_type
(variant
.type)},
178 {'if': variant
.ifcond
})
180 def visit_builtin_type(self
, name
, info
, json_type
):
181 self
._gen
_qlit
(name
, 'builtin', {'json-type': json_type
}, [])
183 def visit_enum_type(self
, name
, info
, ifcond
, members
, prefix
):
184 self
._gen
_qlit
(name
, 'enum',
186 [(m
.name
, {'if': m
.ifcond
}) for m
in members
]},
189 def visit_array_type(self
, name
, info
, ifcond
, element_type
):
190 element
= self
._use
_type
(element_type
)
191 self
._gen
_qlit
('[' + element
+ ']', 'array', {'element-type': element
},
194 def visit_object_type_flat(self
, name
, info
, ifcond
, members
, variants
,
196 obj
= {'members': [self
._gen
_member
(m
) for m
in members
]}
198 obj
.update(self
._gen
_variants
(variants
.tag_member
.name
,
201 obj
['features'] = [(f
.name
, {'if': f
.ifcond
}) for f
in features
]
203 self
._gen
_qlit
(name
, 'object', obj
, ifcond
)
205 def visit_alternate_type(self
, name
, info
, ifcond
, variants
):
206 self
._gen
_qlit
(name
, 'alternate',
208 ({'type': self
._use
_type
(m
.type)}, {'if': m
.ifcond
})
209 for m
in variants
.variants
]}, ifcond
)
211 def visit_command(self
, name
, info
, ifcond
, arg_type
, ret_type
, gen
,
212 success_response
, boxed
, allow_oob
, allow_preconfig
,
214 arg_type
= arg_type
or self
._schema
.the_empty_object_type
215 ret_type
= ret_type
or self
._schema
.the_empty_object_type
216 obj
= {'arg-type': self
._use
_type
(arg_type
),
217 'ret-type': self
._use
_type
(ret_type
)}
219 obj
['allow-oob'] = allow_oob
222 obj
['features'] = [(f
.name
, {'if': f
.ifcond
}) for f
in features
]
224 self
._gen
_qlit
(name
, 'command', obj
, ifcond
)
226 def visit_event(self
, name
, info
, ifcond
, arg_type
, boxed
):
227 arg_type
= arg_type
or self
._schema
.the_empty_object_type
228 self
._gen
_qlit
(name
, 'event', {'arg-type': self
._use
_type
(arg_type
)},
232 def gen_introspect(schema
, output_dir
, prefix
, opt_unmask
):
233 vis
= QAPISchemaGenIntrospectVisitor(prefix
, opt_unmask
)
235 vis
.write(output_dir
)