2
0

visit.py 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427
  1. """
  2. QAPI visitor 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 List, Optional
  13. from .common import (
  14. c_enum_const,
  15. c_name,
  16. indent,
  17. mcgen,
  18. )
  19. from .gen import (
  20. QAPISchemaModularCVisitor,
  21. gen_special_features,
  22. ifcontext,
  23. )
  24. from .schema import (
  25. QAPISchema,
  26. QAPISchemaEnumMember,
  27. QAPISchemaEnumType,
  28. QAPISchemaFeature,
  29. QAPISchemaIfCond,
  30. QAPISchemaObjectType,
  31. QAPISchemaObjectTypeMember,
  32. QAPISchemaType,
  33. QAPISchemaVariants,
  34. )
  35. from .source import QAPISourceInfo
  36. def gen_visit_decl(name: str, scalar: bool = False) -> str:
  37. c_type = c_name(name) + ' *'
  38. if not scalar:
  39. c_type += '*'
  40. return mcgen('''
  41. bool visit_type_%(c_name)s(Visitor *v, const char *name,
  42. %(c_type)sobj, Error **errp);
  43. ''',
  44. c_name=c_name(name), c_type=c_type)
  45. def gen_visit_members_decl(name: str) -> str:
  46. return mcgen('''
  47. bool visit_type_%(c_name)s_members(Visitor *v, %(c_name)s *obj, Error **errp);
  48. ''',
  49. c_name=c_name(name))
  50. def gen_visit_object_members(name: str,
  51. base: Optional[QAPISchemaObjectType],
  52. members: List[QAPISchemaObjectTypeMember],
  53. variants: Optional[QAPISchemaVariants]) -> str:
  54. ret = mcgen('''
  55. bool visit_type_%(c_name)s_members(Visitor *v, %(c_name)s *obj, Error **errp)
  56. {
  57. ''',
  58. c_name=c_name(name))
  59. sep = ''
  60. for memb in members:
  61. if memb.optional and not memb.need_has():
  62. ret += mcgen('''
  63. bool has_%(c_name)s = !!obj->%(c_name)s;
  64. ''',
  65. c_name=c_name(memb.name))
  66. sep = '\n'
  67. ret += sep
  68. if base:
  69. ret += mcgen('''
  70. if (!visit_type_%(c_type)s_members(v, (%(c_type)s *)obj, errp)) {
  71. return false;
  72. }
  73. ''',
  74. c_type=base.c_name())
  75. for memb in members:
  76. ret += memb.ifcond.gen_if()
  77. if memb.optional:
  78. has = 'has_' + c_name(memb.name)
  79. if memb.need_has():
  80. has = 'obj->' + has
  81. ret += mcgen('''
  82. if (visit_optional(v, "%(name)s", &%(has)s)) {
  83. ''',
  84. name=memb.name, has=has)
  85. indent.increase()
  86. special_features = gen_special_features(memb.features)
  87. if special_features != '0':
  88. ret += mcgen('''
  89. if (visit_policy_reject(v, "%(name)s", %(special_features)s, errp)) {
  90. return false;
  91. }
  92. if (!visit_policy_skip(v, "%(name)s", %(special_features)s)) {
  93. ''',
  94. name=memb.name, special_features=special_features)
  95. indent.increase()
  96. ret += mcgen('''
  97. if (!visit_type_%(c_type)s(v, "%(name)s", &obj->%(c_name)s, errp)) {
  98. return false;
  99. }
  100. ''',
  101. c_type=memb.type.c_name(), name=memb.name,
  102. c_name=c_name(memb.name))
  103. if special_features != '0':
  104. indent.decrease()
  105. ret += mcgen('''
  106. }
  107. ''')
  108. if memb.optional:
  109. indent.decrease()
  110. ret += mcgen('''
  111. }
  112. ''')
  113. ret += memb.ifcond.gen_endif()
  114. if variants:
  115. tag_member = variants.tag_member
  116. assert isinstance(tag_member.type, QAPISchemaEnumType)
  117. ret += mcgen('''
  118. switch (obj->%(c_name)s) {
  119. ''',
  120. c_name=c_name(tag_member.name))
  121. for var in variants.variants:
  122. case_str = c_enum_const(tag_member.type.name, var.name,
  123. tag_member.type.prefix)
  124. ret += var.ifcond.gen_if()
  125. if var.type.name == 'q_empty':
  126. # valid variant and nothing to do
  127. ret += mcgen('''
  128. case %(case)s:
  129. break;
  130. ''',
  131. case=case_str)
  132. else:
  133. ret += mcgen('''
  134. case %(case)s:
  135. return visit_type_%(c_type)s_members(v, &obj->u.%(c_name)s, errp);
  136. ''',
  137. case=case_str,
  138. c_type=var.type.c_name(), c_name=c_name(var.name))
  139. ret += var.ifcond.gen_endif()
  140. ret += mcgen('''
  141. default:
  142. abort();
  143. }
  144. ''')
  145. ret += mcgen('''
  146. return true;
  147. }
  148. ''')
  149. return ret
  150. def gen_visit_list(name: str, element_type: QAPISchemaType) -> str:
  151. return mcgen('''
  152. bool visit_type_%(c_name)s(Visitor *v, const char *name,
  153. %(c_name)s **obj, Error **errp)
  154. {
  155. bool ok = false;
  156. %(c_name)s *tail;
  157. size_t size = sizeof(**obj);
  158. if (!visit_start_list(v, name, (GenericList **)obj, size, errp)) {
  159. return false;
  160. }
  161. for (tail = *obj; tail;
  162. tail = (%(c_name)s *)visit_next_list(v, (GenericList *)tail, size)) {
  163. if (!visit_type_%(c_elt_type)s(v, NULL, &tail->value, errp)) {
  164. goto out_obj;
  165. }
  166. }
  167. ok = visit_check_list(v, errp);
  168. out_obj:
  169. visit_end_list(v, (void **)obj);
  170. if (!ok && visit_is_input(v)) {
  171. qapi_free_%(c_name)s(*obj);
  172. *obj = NULL;
  173. }
  174. return ok;
  175. }
  176. ''',
  177. c_name=c_name(name), c_elt_type=element_type.c_name())
  178. def gen_visit_enum(name: str) -> str:
  179. return mcgen('''
  180. bool visit_type_%(c_name)s(Visitor *v, const char *name,
  181. %(c_name)s *obj, Error **errp)
  182. {
  183. int value = *obj;
  184. bool ok = visit_type_enum(v, name, &value, &%(c_name)s_lookup, errp);
  185. *obj = value;
  186. return ok;
  187. }
  188. ''',
  189. c_name=c_name(name))
  190. def gen_visit_alternate(name: str, variants: QAPISchemaVariants) -> str:
  191. ret = mcgen('''
  192. bool visit_type_%(c_name)s(Visitor *v, const char *name,
  193. %(c_name)s **obj, Error **errp)
  194. {
  195. bool ok = false;
  196. if (!visit_start_alternate(v, name, (GenericAlternate **)obj,
  197. sizeof(**obj), errp)) {
  198. return false;
  199. }
  200. if (!*obj) {
  201. /* incomplete */
  202. assert(visit_is_dealloc(v));
  203. ok = true;
  204. goto out_obj;
  205. }
  206. switch ((*obj)->type) {
  207. ''',
  208. c_name=c_name(name))
  209. for var in variants.variants:
  210. ret += var.ifcond.gen_if()
  211. ret += mcgen('''
  212. case %(case)s:
  213. ''',
  214. case=var.type.alternate_qtype())
  215. if isinstance(var.type, QAPISchemaObjectType):
  216. ret += mcgen('''
  217. if (!visit_start_struct(v, name, NULL, 0, errp)) {
  218. break;
  219. }
  220. if (visit_type_%(c_type)s_members(v, &(*obj)->u.%(c_name)s, errp)) {
  221. ok = visit_check_struct(v, errp);
  222. }
  223. visit_end_struct(v, NULL);
  224. ''',
  225. c_type=var.type.c_name(),
  226. c_name=c_name(var.name))
  227. else:
  228. ret += mcgen('''
  229. ok = visit_type_%(c_type)s(v, name, &(*obj)->u.%(c_name)s, errp);
  230. ''',
  231. c_type=var.type.c_name(),
  232. c_name=c_name(var.name))
  233. ret += mcgen('''
  234. break;
  235. ''')
  236. ret += var.ifcond.gen_endif()
  237. ret += mcgen('''
  238. case QTYPE_NONE:
  239. abort();
  240. default:
  241. assert(visit_is_input(v));
  242. error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name ? name : "null",
  243. "%(name)s");
  244. /* Avoid passing invalid *obj to qapi_free_%(c_name)s() */
  245. g_free(*obj);
  246. *obj = NULL;
  247. }
  248. out_obj:
  249. visit_end_alternate(v, (void **)obj);
  250. if (!ok && visit_is_input(v)) {
  251. qapi_free_%(c_name)s(*obj);
  252. *obj = NULL;
  253. }
  254. return ok;
  255. }
  256. ''',
  257. name=name, c_name=c_name(name))
  258. return ret
  259. def gen_visit_object(name: str) -> str:
  260. return mcgen('''
  261. bool visit_type_%(c_name)s(Visitor *v, const char *name,
  262. %(c_name)s **obj, Error **errp)
  263. {
  264. bool ok = false;
  265. if (!visit_start_struct(v, name, (void **)obj, sizeof(%(c_name)s), errp)) {
  266. return false;
  267. }
  268. if (!*obj) {
  269. /* incomplete */
  270. assert(visit_is_dealloc(v));
  271. ok = true;
  272. goto out_obj;
  273. }
  274. if (!visit_type_%(c_name)s_members(v, *obj, errp)) {
  275. goto out_obj;
  276. }
  277. ok = visit_check_struct(v, errp);
  278. out_obj:
  279. visit_end_struct(v, (void **)obj);
  280. if (!ok && visit_is_input(v)) {
  281. qapi_free_%(c_name)s(*obj);
  282. *obj = NULL;
  283. }
  284. return ok;
  285. }
  286. ''',
  287. c_name=c_name(name))
  288. class QAPISchemaGenVisitVisitor(QAPISchemaModularCVisitor):
  289. def __init__(self, prefix: str):
  290. super().__init__(
  291. prefix, 'qapi-visit', ' * Schema-defined QAPI visitors',
  292. ' * Built-in QAPI visitors', __doc__)
  293. def _begin_builtin_module(self) -> None:
  294. self._genc.preamble_add(mcgen('''
  295. #include "qemu/osdep.h"
  296. #include "qapi/error.h"
  297. #include "qapi/qapi-builtin-visit.h"
  298. '''))
  299. self._genh.preamble_add(mcgen('''
  300. #include "qapi/visitor.h"
  301. #include "qapi/qapi-builtin-types.h"
  302. '''))
  303. def _begin_user_module(self, name: str) -> None:
  304. types = self._module_basename('qapi-types', name)
  305. visit = self._module_basename('qapi-visit', name)
  306. self._genc.preamble_add(mcgen('''
  307. #include "qemu/osdep.h"
  308. #include "qapi/error.h"
  309. #include "qapi/qmp/qerror.h"
  310. #include "%(visit)s.h"
  311. ''',
  312. visit=visit))
  313. self._genh.preamble_add(mcgen('''
  314. #include "qapi/qapi-builtin-visit.h"
  315. #include "%(types)s.h"
  316. ''',
  317. types=types))
  318. def visit_enum_type(self,
  319. name: str,
  320. info: Optional[QAPISourceInfo],
  321. ifcond: QAPISchemaIfCond,
  322. features: List[QAPISchemaFeature],
  323. members: List[QAPISchemaEnumMember],
  324. prefix: Optional[str]) -> None:
  325. with ifcontext(ifcond, self._genh, self._genc):
  326. self._genh.add(gen_visit_decl(name, scalar=True))
  327. self._genc.add(gen_visit_enum(name))
  328. def visit_array_type(self,
  329. name: str,
  330. info: Optional[QAPISourceInfo],
  331. ifcond: QAPISchemaIfCond,
  332. element_type: QAPISchemaType) -> None:
  333. with ifcontext(ifcond, self._genh, self._genc):
  334. self._genh.add(gen_visit_decl(name))
  335. self._genc.add(gen_visit_list(name, element_type))
  336. def visit_object_type(self,
  337. name: str,
  338. info: Optional[QAPISourceInfo],
  339. ifcond: QAPISchemaIfCond,
  340. features: List[QAPISchemaFeature],
  341. base: Optional[QAPISchemaObjectType],
  342. members: List[QAPISchemaObjectTypeMember],
  343. variants: Optional[QAPISchemaVariants]) -> None:
  344. # Nothing to do for the special empty builtin
  345. if name == 'q_empty':
  346. return
  347. with ifcontext(ifcond, self._genh, self._genc):
  348. self._genh.add(gen_visit_members_decl(name))
  349. self._genc.add(gen_visit_object_members(name, base,
  350. members, variants))
  351. # TODO Worth changing the visitor signature, so we could
  352. # directly use rather than repeat type.is_implicit()?
  353. if not name.startswith('q_'):
  354. # only explicit types need an allocating visit
  355. self._genh.add(gen_visit_decl(name))
  356. self._genc.add(gen_visit_object(name))
  357. def visit_alternate_type(self,
  358. name: str,
  359. info: Optional[QAPISourceInfo],
  360. ifcond: QAPISchemaIfCond,
  361. features: List[QAPISchemaFeature],
  362. variants: QAPISchemaVariants) -> None:
  363. with ifcontext(ifcond, self._genh, self._genc):
  364. self._genh.add(gen_visit_decl(name))
  365. self._genc.add(gen_visit_alternate(name, variants))
  366. def gen_visit(schema: QAPISchema,
  367. output_dir: str,
  368. prefix: str,
  369. opt_builtins: bool) -> None:
  370. vis = QAPISchemaGenVisitVisitor(prefix)
  371. schema.visit(vis)
  372. vis.write(output_dir, opt_builtins)