commands.py 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420
  1. """
  2. QAPI command marshaller generator
  3. Copyright IBM, Corp. 2011
  4. Copyright (C) 2014-2018 Red Hat, Inc.
  5. Authors:
  6. Anthony Liguori <aliguori@us.ibm.com>
  7. Michael Roth <mdroth@linux.vnet.ibm.com>
  8. 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.
  11. """
  12. from typing import (
  13. Dict,
  14. List,
  15. Optional,
  16. Set,
  17. )
  18. from .common import c_name, mcgen
  19. from .gen import (
  20. QAPIGenC,
  21. QAPISchemaModularCVisitor,
  22. build_params,
  23. gen_features,
  24. ifcontext,
  25. )
  26. from .schema import (
  27. QAPISchema,
  28. QAPISchemaFeature,
  29. QAPISchemaIfCond,
  30. QAPISchemaObjectType,
  31. QAPISchemaType,
  32. )
  33. from .source import QAPISourceInfo
  34. def gen_command_decl(name: str,
  35. arg_type: Optional[QAPISchemaObjectType],
  36. boxed: bool,
  37. ret_type: Optional[QAPISchemaType],
  38. coroutine: bool) -> str:
  39. return mcgen('''
  40. %(c_type)s %(coroutine_fn)sqmp_%(c_name)s(%(params)s);
  41. ''',
  42. c_type=(ret_type and ret_type.c_type()) or 'void',
  43. coroutine_fn='coroutine_fn ' if coroutine else '',
  44. c_name=c_name(name),
  45. params=build_params(arg_type, boxed, 'Error **errp'))
  46. def gen_call(name: str,
  47. arg_type: Optional[QAPISchemaObjectType],
  48. boxed: bool,
  49. ret_type: Optional[QAPISchemaType],
  50. gen_tracing: bool) -> str:
  51. ret = ''
  52. argstr = ''
  53. if boxed:
  54. assert arg_type
  55. argstr = '&arg, '
  56. elif arg_type:
  57. assert not arg_type.branches
  58. for memb in arg_type.members:
  59. assert not memb.ifcond.is_present()
  60. if memb.need_has():
  61. argstr += 'arg.has_%s, ' % c_name(memb.name)
  62. argstr += 'arg.%s, ' % c_name(memb.name)
  63. lhs = ''
  64. if ret_type:
  65. lhs = 'retval = '
  66. name = c_name(name)
  67. upper = name.upper()
  68. if gen_tracing:
  69. ret += mcgen('''
  70. if (trace_event_get_state_backends(TRACE_QMP_ENTER_%(upper)s)) {
  71. g_autoptr(GString) req_json = qobject_to_json(QOBJECT(args));
  72. trace_qmp_enter_%(name)s(req_json->str);
  73. }
  74. ''',
  75. upper=upper, name=name)
  76. ret += mcgen('''
  77. %(lhs)sqmp_%(name)s(%(args)s&err);
  78. ''',
  79. name=name, args=argstr, lhs=lhs)
  80. ret += mcgen('''
  81. if (err) {
  82. ''')
  83. if gen_tracing:
  84. ret += mcgen('''
  85. trace_qmp_exit_%(name)s(error_get_pretty(err), false);
  86. ''',
  87. name=name)
  88. ret += mcgen('''
  89. error_propagate(errp, err);
  90. goto out;
  91. }
  92. ''')
  93. if ret_type:
  94. ret += mcgen('''
  95. qmp_marshal_output_%(c_name)s(retval, ret, errp);
  96. ''',
  97. c_name=ret_type.c_name())
  98. if gen_tracing:
  99. if ret_type:
  100. ret += mcgen('''
  101. if (trace_event_get_state_backends(TRACE_QMP_EXIT_%(upper)s)) {
  102. g_autoptr(GString) ret_json = qobject_to_json(*ret);
  103. trace_qmp_exit_%(name)s(ret_json->str, true);
  104. }
  105. ''',
  106. upper=upper, name=name)
  107. else:
  108. ret += mcgen('''
  109. trace_qmp_exit_%(name)s("{}", true);
  110. ''',
  111. name=name)
  112. return ret
  113. def gen_marshal_output(ret_type: QAPISchemaType) -> str:
  114. return mcgen('''
  115. static void qmp_marshal_output_%(c_name)s(%(c_type)s ret_in,
  116. QObject **ret_out, Error **errp)
  117. {
  118. Visitor *v;
  119. v = qobject_output_visitor_new_qmp(ret_out);
  120. if (visit_type_%(c_name)s(v, "unused", &ret_in, errp)) {
  121. visit_complete(v, ret_out);
  122. }
  123. visit_free(v);
  124. v = qapi_dealloc_visitor_new();
  125. visit_type_%(c_name)s(v, "unused", &ret_in, NULL);
  126. visit_free(v);
  127. }
  128. ''',
  129. c_type=ret_type.c_type(), c_name=ret_type.c_name())
  130. def build_marshal_proto(name: str,
  131. coroutine: bool) -> str:
  132. return ('void %(coroutine_fn)sqmp_marshal_%(c_name)s(%(params)s)' % {
  133. 'coroutine_fn': 'coroutine_fn ' if coroutine else '',
  134. 'c_name': c_name(name),
  135. 'params': 'QDict *args, QObject **ret, Error **errp',
  136. })
  137. def gen_marshal_decl(name: str,
  138. coroutine: bool) -> str:
  139. return mcgen('''
  140. %(proto)s;
  141. ''',
  142. proto=build_marshal_proto(name, coroutine))
  143. def gen_trace(name: str) -> str:
  144. return mcgen('''
  145. qmp_enter_%(name)s(const char *json) "%%s"
  146. qmp_exit_%(name)s(const char *result, bool succeeded) "%%s %%d"
  147. ''',
  148. name=c_name(name))
  149. def gen_marshal(name: str,
  150. arg_type: Optional[QAPISchemaObjectType],
  151. boxed: bool,
  152. ret_type: Optional[QAPISchemaType],
  153. gen_tracing: bool,
  154. coroutine: bool) -> str:
  155. have_args = boxed or (arg_type and not arg_type.is_empty())
  156. if have_args:
  157. assert arg_type is not None
  158. arg_type_c_name = arg_type.c_name()
  159. ret = mcgen('''
  160. %(proto)s
  161. {
  162. Error *err = NULL;
  163. bool ok = false;
  164. Visitor *v;
  165. ''',
  166. proto=build_marshal_proto(name, coroutine))
  167. if ret_type:
  168. ret += mcgen('''
  169. %(c_type)s retval;
  170. ''',
  171. c_type=ret_type.c_type())
  172. if have_args:
  173. ret += mcgen('''
  174. %(c_name)s arg = {0};
  175. ''',
  176. c_name=arg_type_c_name)
  177. ret += mcgen('''
  178. v = qobject_input_visitor_new_qmp(QOBJECT(args));
  179. if (!visit_start_struct(v, NULL, NULL, 0, errp)) {
  180. goto out;
  181. }
  182. ''')
  183. if have_args:
  184. ret += mcgen('''
  185. if (visit_type_%(c_arg_type)s_members(v, &arg, errp)) {
  186. ok = visit_check_struct(v, errp);
  187. }
  188. ''',
  189. c_arg_type=arg_type_c_name)
  190. else:
  191. ret += mcgen('''
  192. ok = visit_check_struct(v, errp);
  193. ''')
  194. ret += mcgen('''
  195. visit_end_struct(v, NULL);
  196. if (!ok) {
  197. goto out;
  198. }
  199. ''')
  200. ret += gen_call(name, arg_type, boxed, ret_type, gen_tracing)
  201. ret += mcgen('''
  202. out:
  203. visit_free(v);
  204. ''')
  205. ret += mcgen('''
  206. v = qapi_dealloc_visitor_new();
  207. visit_start_struct(v, NULL, NULL, 0, NULL);
  208. ''')
  209. if have_args:
  210. ret += mcgen('''
  211. visit_type_%(c_arg_type)s_members(v, &arg, NULL);
  212. ''',
  213. c_arg_type=arg_type_c_name)
  214. ret += mcgen('''
  215. visit_end_struct(v, NULL);
  216. visit_free(v);
  217. ''')
  218. ret += mcgen('''
  219. }
  220. ''')
  221. return ret
  222. def gen_register_command(name: str,
  223. features: List[QAPISchemaFeature],
  224. success_response: bool,
  225. allow_oob: bool,
  226. allow_preconfig: bool,
  227. coroutine: bool) -> str:
  228. options = []
  229. if not success_response:
  230. options += ['QCO_NO_SUCCESS_RESP']
  231. if allow_oob:
  232. options += ['QCO_ALLOW_OOB']
  233. if allow_preconfig:
  234. options += ['QCO_ALLOW_PRECONFIG']
  235. if coroutine:
  236. options += ['QCO_COROUTINE']
  237. ret = mcgen('''
  238. qmp_register_command(cmds, "%(name)s",
  239. qmp_marshal_%(c_name)s, %(opts)s, %(feats)s);
  240. ''',
  241. name=name, c_name=c_name(name),
  242. opts=' | '.join(options) or 0,
  243. feats=gen_features(features))
  244. return ret
  245. class QAPISchemaGenCommandVisitor(QAPISchemaModularCVisitor):
  246. def __init__(self, prefix: str, gen_tracing: bool):
  247. super().__init__(
  248. prefix, 'qapi-commands',
  249. ' * Schema-defined QAPI/QMP commands', None, __doc__,
  250. gen_tracing=gen_tracing)
  251. self._visited_ret_types: Dict[QAPIGenC, Set[QAPISchemaType]] = {}
  252. self._gen_tracing = gen_tracing
  253. def _begin_user_module(self, name: str) -> None:
  254. self._visited_ret_types[self._genc] = set()
  255. commands = self._module_basename('qapi-commands', name)
  256. types = self._module_basename('qapi-types', name)
  257. visit = self._module_basename('qapi-visit', name)
  258. self._genc.add(mcgen('''
  259. #include "qemu/osdep.h"
  260. #include "qapi/compat-policy.h"
  261. #include "qapi/visitor.h"
  262. #include "qobject/qdict.h"
  263. #include "qapi/dealloc-visitor.h"
  264. #include "qapi/error.h"
  265. #include "%(visit)s.h"
  266. #include "%(commands)s.h"
  267. ''',
  268. commands=commands, visit=visit))
  269. if self._gen_tracing and commands != 'qapi-commands':
  270. self._genc.add(mcgen('''
  271. #include "qobject/qjson.h"
  272. #include "trace/trace-%(nm)s_trace_events.h"
  273. ''',
  274. nm=c_name(commands, protect=False)))
  275. # We use c_name(commands, protect=False) to turn '-' into '_', to
  276. # match .underscorify() in trace/meson.build
  277. self._genh.add(mcgen('''
  278. #include "%(types)s.h"
  279. ''',
  280. types=types))
  281. def visit_begin(self, schema: QAPISchema) -> None:
  282. self._add_module('./init', ' * QAPI Commands initialization')
  283. self._genh.add(mcgen('''
  284. #include "qapi/qmp-registry.h"
  285. void %(c_prefix)sqmp_init_marshal(QmpCommandList *cmds);
  286. ''',
  287. c_prefix=c_name(self._prefix, protect=False)))
  288. self._genc.add(mcgen('''
  289. #include "qemu/osdep.h"
  290. #include "%(prefix)sqapi-commands.h"
  291. #include "%(prefix)sqapi-init-commands.h"
  292. #include "%(prefix)sqapi-features.h"
  293. void %(c_prefix)sqmp_init_marshal(QmpCommandList *cmds)
  294. {
  295. QTAILQ_INIT(cmds);
  296. ''',
  297. prefix=self._prefix,
  298. c_prefix=c_name(self._prefix, protect=False)))
  299. def visit_end(self) -> None:
  300. with self._temp_module('./init'):
  301. self._genc.add(mcgen('''
  302. }
  303. '''))
  304. def visit_command(self,
  305. name: str,
  306. info: Optional[QAPISourceInfo],
  307. ifcond: QAPISchemaIfCond,
  308. features: List[QAPISchemaFeature],
  309. arg_type: Optional[QAPISchemaObjectType],
  310. ret_type: Optional[QAPISchemaType],
  311. gen: bool,
  312. success_response: bool,
  313. boxed: bool,
  314. allow_oob: bool,
  315. allow_preconfig: bool,
  316. coroutine: bool) -> None:
  317. if not gen:
  318. return
  319. # FIXME: If T is a user-defined type, the user is responsible
  320. # for making this work, i.e. to make T's condition the
  321. # conjunction of the T-returning commands' conditions. If T
  322. # is a built-in type, this isn't possible: the
  323. # qmp_marshal_output_T() will be generated unconditionally.
  324. if ret_type and ret_type not in self._visited_ret_types[self._genc]:
  325. self._visited_ret_types[self._genc].add(ret_type)
  326. with ifcontext(ret_type.ifcond,
  327. self._genh, self._genc):
  328. self._genc.add(gen_marshal_output(ret_type))
  329. with ifcontext(ifcond, self._genh, self._genc):
  330. self._genh.add(gen_command_decl(name, arg_type, boxed,
  331. ret_type, coroutine))
  332. self._genh.add(gen_marshal_decl(name, coroutine))
  333. self._genc.add(gen_marshal(name, arg_type, boxed, ret_type,
  334. self._gen_tracing, coroutine))
  335. if self._gen_tracing:
  336. self._gen_trace_events.add(gen_trace(name))
  337. with self._temp_module('./init'):
  338. with ifcontext(ifcond, self._genh, self._genc):
  339. self._genc.add(gen_register_command(
  340. name, features, success_response, allow_oob,
  341. allow_preconfig, coroutine))
  342. def gen_commands(schema: QAPISchema,
  343. output_dir: str,
  344. prefix: str,
  345. gen_tracing: bool) -> None:
  346. vis = QAPISchemaGenCommandVisitor(prefix, gen_tracing)
  347. schema.visit(vis)
  348. vis.write(output_dir)