qapi-commands.py 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470
  1. #
  2. # QAPI command marshaller generator
  3. #
  4. # Copyright IBM, Corp. 2011
  5. #
  6. # Authors:
  7. # Anthony Liguori <aliguori@us.ibm.com>
  8. # Michael Roth <mdroth@linux.vnet.ibm.com>
  9. #
  10. # This work is licensed under the terms of the GNU GPLv2.
  11. # See the COPYING.LIB file in the top-level directory.
  12. from ordereddict import OrderedDict
  13. from qapi import *
  14. import sys
  15. import os
  16. import getopt
  17. import errno
  18. def type_visitor(name):
  19. if type(name) == list:
  20. return 'visit_type_%sList' % name[0]
  21. else:
  22. return 'visit_type_%s' % name
  23. def generate_decl_enum(name, members, genlist=True):
  24. return mcgen('''
  25. void %(visitor)s(Visitor *m, %(name)s * obj, const char *name, Error **errp);
  26. ''',
  27. visitor=type_visitor(name))
  28. def generate_command_decl(name, args, ret_type):
  29. arglist=""
  30. for argname, argtype, optional, structured in parse_args(args):
  31. argtype = c_type(argtype)
  32. if argtype == "char *":
  33. argtype = "const char *"
  34. if optional:
  35. arglist += "bool has_%s, " % c_var(argname)
  36. arglist += "%s %s, " % (argtype, c_var(argname))
  37. return mcgen('''
  38. %(ret_type)s qmp_%(name)s(%(args)sError **errp);
  39. ''',
  40. ret_type=c_type(ret_type), name=c_var(name), args=arglist).strip()
  41. def gen_sync_call(name, args, ret_type, indent=0):
  42. ret = ""
  43. arglist=""
  44. retval=""
  45. if ret_type:
  46. retval = "retval = "
  47. for argname, argtype, optional, structured in parse_args(args):
  48. if optional:
  49. arglist += "has_%s, " % c_var(argname)
  50. arglist += "%s, " % (c_var(argname))
  51. push_indent(indent)
  52. ret = mcgen('''
  53. %(retval)sqmp_%(name)s(%(args)serrp);
  54. ''',
  55. name=c_var(name), args=arglist, retval=retval).rstrip()
  56. if ret_type:
  57. ret += "\n" + mcgen(''''
  58. if (!error_is_set(errp)) {
  59. %(marshal_output_call)s
  60. }
  61. ''',
  62. marshal_output_call=gen_marshal_output_call(name, ret_type)).rstrip()
  63. pop_indent(indent)
  64. return ret.rstrip()
  65. def gen_marshal_output_call(name, ret_type):
  66. if not ret_type:
  67. return ""
  68. return "qmp_marshal_output_%s(retval, ret, errp);" % c_var(name)
  69. def gen_visitor_output_containers_decl(ret_type):
  70. ret = ""
  71. push_indent()
  72. if ret_type:
  73. ret += mcgen('''
  74. QmpOutputVisitor *mo;
  75. QapiDeallocVisitor *md;
  76. Visitor *v;
  77. ''')
  78. pop_indent()
  79. return ret
  80. def gen_visitor_input_containers_decl(args):
  81. ret = ""
  82. push_indent()
  83. if len(args) > 0:
  84. ret += mcgen('''
  85. QmpInputVisitor *mi;
  86. QapiDeallocVisitor *md;
  87. Visitor *v;
  88. ''')
  89. pop_indent()
  90. return ret.rstrip()
  91. def gen_visitor_input_vars_decl(args):
  92. ret = ""
  93. push_indent()
  94. for argname, argtype, optional, structured in parse_args(args):
  95. if optional:
  96. ret += mcgen('''
  97. bool has_%(argname)s = false;
  98. ''',
  99. argname=c_var(argname))
  100. if c_type(argtype).endswith("*"):
  101. ret += mcgen('''
  102. %(argtype)s %(argname)s = NULL;
  103. ''',
  104. argname=c_var(argname), argtype=c_type(argtype))
  105. else:
  106. ret += mcgen('''
  107. %(argtype)s %(argname)s;
  108. ''',
  109. argname=c_var(argname), argtype=c_type(argtype))
  110. pop_indent()
  111. return ret.rstrip()
  112. def gen_visitor_input_block(args, obj, dealloc=False):
  113. ret = ""
  114. if len(args) == 0:
  115. return ret
  116. push_indent()
  117. if dealloc:
  118. ret += mcgen('''
  119. md = qapi_dealloc_visitor_new();
  120. v = qapi_dealloc_get_visitor(md);
  121. ''')
  122. else:
  123. ret += mcgen('''
  124. mi = qmp_input_visitor_new(%(obj)s);
  125. v = qmp_input_get_visitor(mi);
  126. ''',
  127. obj=obj)
  128. for argname, argtype, optional, structured in parse_args(args):
  129. if optional:
  130. ret += mcgen('''
  131. visit_start_optional(v, &has_%(c_name)s, "%(name)s", errp);
  132. if (has_%(c_name)s) {
  133. ''',
  134. c_name=c_var(argname), name=argname)
  135. push_indent()
  136. ret += mcgen('''
  137. %(visitor)s(v, &%(c_name)s, "%(name)s", errp);
  138. ''',
  139. c_name=c_var(argname), name=argname, argtype=argtype,
  140. visitor=type_visitor(argtype))
  141. if optional:
  142. pop_indent()
  143. ret += mcgen('''
  144. }
  145. visit_end_optional(v, errp);
  146. ''')
  147. if dealloc:
  148. ret += mcgen('''
  149. qapi_dealloc_visitor_cleanup(md);
  150. ''')
  151. else:
  152. ret += mcgen('''
  153. qmp_input_visitor_cleanup(mi);
  154. ''')
  155. pop_indent()
  156. return ret.rstrip()
  157. def gen_marshal_output(name, args, ret_type, middle_mode):
  158. if not ret_type:
  159. return ""
  160. ret = mcgen('''
  161. static void qmp_marshal_output_%(c_name)s(%(c_ret_type)s ret_in, QObject **ret_out, Error **errp)
  162. {
  163. QapiDeallocVisitor *md = qapi_dealloc_visitor_new();
  164. QmpOutputVisitor *mo = qmp_output_visitor_new();
  165. Visitor *v;
  166. v = qmp_output_get_visitor(mo);
  167. %(visitor)s(v, &ret_in, "unused", errp);
  168. if (!error_is_set(errp)) {
  169. *ret_out = qmp_output_get_qobject(mo);
  170. }
  171. qmp_output_visitor_cleanup(mo);
  172. v = qapi_dealloc_get_visitor(md);
  173. %(visitor)s(v, &ret_in, "unused", errp);
  174. qapi_dealloc_visitor_cleanup(md);
  175. }
  176. ''',
  177. c_ret_type=c_type(ret_type), c_name=c_var(name),
  178. visitor=type_visitor(ret_type))
  179. return ret
  180. def gen_marshal_input_decl(name, args, ret_type, middle_mode):
  181. if middle_mode:
  182. return 'int qmp_marshal_input_%s(Monitor *mon, const QDict *qdict, QObject **ret)' % c_var(name)
  183. else:
  184. return 'static void qmp_marshal_input_%s(QDict *args, QObject **ret, Error **errp)' % c_var(name)
  185. def gen_marshal_input(name, args, ret_type, middle_mode):
  186. hdr = gen_marshal_input_decl(name, args, ret_type, middle_mode)
  187. ret = mcgen('''
  188. %(header)s
  189. {
  190. ''',
  191. header=hdr)
  192. if middle_mode:
  193. ret += mcgen('''
  194. Error *local_err = NULL;
  195. Error **errp = &local_err;
  196. QDict *args = (QDict *)qdict;
  197. ''')
  198. if ret_type:
  199. if c_type(ret_type).endswith("*"):
  200. retval = " %s retval = NULL;" % c_type(ret_type)
  201. else:
  202. retval = " %s retval;" % c_type(ret_type)
  203. ret += mcgen('''
  204. %(retval)s
  205. ''',
  206. retval=retval)
  207. if len(args) > 0:
  208. ret += mcgen('''
  209. %(visitor_input_containers_decl)s
  210. %(visitor_input_vars_decl)s
  211. %(visitor_input_block)s
  212. ''',
  213. visitor_input_containers_decl=gen_visitor_input_containers_decl(args),
  214. visitor_input_vars_decl=gen_visitor_input_vars_decl(args),
  215. visitor_input_block=gen_visitor_input_block(args, "QOBJECT(args)"))
  216. else:
  217. ret += mcgen('''
  218. (void)args;
  219. ''')
  220. ret += mcgen('''
  221. if (error_is_set(errp)) {
  222. goto out;
  223. }
  224. %(sync_call)s
  225. ''',
  226. sync_call=gen_sync_call(name, args, ret_type, indent=4))
  227. ret += mcgen('''
  228. out:
  229. ''')
  230. ret += mcgen('''
  231. %(visitor_input_block_cleanup)s
  232. ''',
  233. visitor_input_block_cleanup=gen_visitor_input_block(args, None,
  234. dealloc=True))
  235. if middle_mode:
  236. ret += mcgen('''
  237. if (local_err) {
  238. qerror_report_err(local_err);
  239. error_free(local_err);
  240. return -1;
  241. }
  242. return 0;
  243. ''')
  244. else:
  245. ret += mcgen('''
  246. return;
  247. ''')
  248. ret += mcgen('''
  249. }
  250. ''')
  251. return ret
  252. def gen_registry(commands):
  253. registry=""
  254. push_indent()
  255. for cmd in commands:
  256. registry += mcgen('''
  257. qmp_register_command("%(name)s", qmp_marshal_input_%(c_name)s);
  258. ''',
  259. name=cmd['command'], c_name=c_var(cmd['command']))
  260. pop_indent()
  261. ret = mcgen('''
  262. static void qmp_init_marshal(void)
  263. {
  264. %(registry)s
  265. }
  266. qapi_init(qmp_init_marshal);
  267. ''',
  268. registry=registry.rstrip())
  269. return ret
  270. def gen_command_decl_prologue(header, guard, prefix=""):
  271. ret = mcgen('''
  272. /* THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY */
  273. /*
  274. * schema-defined QAPI function prototypes
  275. *
  276. * Copyright IBM, Corp. 2011
  277. *
  278. * Authors:
  279. * Anthony Liguori <aliguori@us.ibm.com>
  280. *
  281. * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
  282. * See the COPYING.LIB file in the top-level directory.
  283. *
  284. */
  285. #ifndef %(guard)s
  286. #define %(guard)s
  287. #include "%(prefix)sqapi-types.h"
  288. #include "error.h"
  289. ''',
  290. header=basename(header), guard=guardname(header), prefix=prefix)
  291. return ret
  292. def gen_command_def_prologue(prefix="", proxy=False):
  293. ret = mcgen('''
  294. /* THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY */
  295. /*
  296. * schema-defined QMP->QAPI command dispatch
  297. *
  298. * Copyright IBM, Corp. 2011
  299. *
  300. * Authors:
  301. * Anthony Liguori <aliguori@us.ibm.com>
  302. *
  303. * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
  304. * See the COPYING.LIB file in the top-level directory.
  305. *
  306. */
  307. #include "qemu-objects.h"
  308. #include "qapi/qmp-core.h"
  309. #include "qapi/qapi-visit-core.h"
  310. #include "qapi/qmp-output-visitor.h"
  311. #include "qapi/qmp-input-visitor.h"
  312. #include "qapi/qapi-dealloc-visitor.h"
  313. #include "%(prefix)sqapi-types.h"
  314. #include "%(prefix)sqapi-visit.h"
  315. ''',
  316. prefix=prefix)
  317. if not proxy:
  318. ret += '#include "%sqmp-commands.h"' % prefix
  319. return ret + "\n\n"
  320. try:
  321. opts, args = getopt.gnu_getopt(sys.argv[1:], "chp:o:m",
  322. ["source", "header", "prefix=",
  323. "output-dir=", "type=", "middle"])
  324. except getopt.GetoptError, err:
  325. print str(err)
  326. sys.exit(1)
  327. output_dir = ""
  328. prefix = ""
  329. dispatch_type = "sync"
  330. c_file = 'qmp-marshal.c'
  331. h_file = 'qmp-commands.h'
  332. middle_mode = False
  333. do_c = False
  334. do_h = False
  335. for o, a in opts:
  336. if o in ("-p", "--prefix"):
  337. prefix = a
  338. elif o in ("-o", "--output-dir"):
  339. output_dir = a + "/"
  340. elif o in ("-t", "--type"):
  341. dispatch_type = a
  342. elif o in ("-m", "--middle"):
  343. middle_mode = True
  344. elif o in ("-c", "--source"):
  345. do_h = True
  346. elif o in ("-h", "--header"):
  347. do_c = True
  348. if not do_c and not do_h:
  349. do_c = True
  350. do_h = True
  351. c_file = output_dir + prefix + c_file
  352. h_file = output_dir + prefix + h_file
  353. def maybe_open(really, name, opt):
  354. class Null(object):
  355. def write(self, str):
  356. pass
  357. def read(self):
  358. return ''
  359. if really:
  360. return open(name, opt)
  361. else:
  362. return Null()
  363. try:
  364. os.makedirs(output_dir)
  365. except os.error, e:
  366. if e.errno != errno.EEXIST:
  367. raise
  368. exprs = parse_schema(sys.stdin)
  369. commands = filter(lambda expr: expr.has_key('command'), exprs)
  370. commands = filter(lambda expr: not expr.has_key('gen'), commands)
  371. if dispatch_type == "sync":
  372. fdecl = maybe_open(do_h, h_file, 'w')
  373. fdef = maybe_open(do_c, c_file, 'w')
  374. ret = gen_command_decl_prologue(header=basename(h_file), guard=guardname(h_file), prefix=prefix)
  375. fdecl.write(ret)
  376. ret = gen_command_def_prologue(prefix=prefix)
  377. fdef.write(ret)
  378. for cmd in commands:
  379. arglist = []
  380. ret_type = None
  381. if cmd.has_key('data'):
  382. arglist = cmd['data']
  383. if cmd.has_key('returns'):
  384. ret_type = cmd['returns']
  385. ret = generate_command_decl(cmd['command'], arglist, ret_type) + "\n"
  386. fdecl.write(ret)
  387. if ret_type:
  388. ret = gen_marshal_output(cmd['command'], arglist, ret_type, middle_mode) + "\n"
  389. fdef.write(ret)
  390. if middle_mode:
  391. fdecl.write('%s;\n' % gen_marshal_input_decl(cmd['command'], arglist, ret_type, middle_mode))
  392. ret = gen_marshal_input(cmd['command'], arglist, ret_type, middle_mode) + "\n"
  393. fdef.write(ret)
  394. fdecl.write("\n#endif\n");
  395. if not middle_mode:
  396. ret = gen_registry(commands)
  397. fdef.write(ret)
  398. fdef.flush()
  399. fdef.close()
  400. fdecl.flush()
  401. fdecl.close()