1fb0bc835SMarkus Armbruster""" 2fb0bc835SMarkus ArmbrusterQAPI command marshaller generator 3fb0bc835SMarkus Armbruster 4fb0bc835SMarkus ArmbrusterCopyright IBM, Corp. 2011 5fb0bc835SMarkus ArmbrusterCopyright (C) 2014-2018 Red Hat, Inc. 6fb0bc835SMarkus Armbruster 7fb0bc835SMarkus ArmbrusterAuthors: 8fb0bc835SMarkus Armbruster Anthony Liguori <aliguori@us.ibm.com> 9fb0bc835SMarkus Armbruster Michael Roth <mdroth@linux.vnet.ibm.com> 10fb0bc835SMarkus Armbruster Markus Armbruster <armbru@redhat.com> 11fb0bc835SMarkus Armbruster 12fb0bc835SMarkus ArmbrusterThis work is licensed under the terms of the GNU GPL, version 2. 13fb0bc835SMarkus ArmbrusterSee the COPYING file in the top-level directory. 14fb0bc835SMarkus Armbruster""" 15fb0bc835SMarkus Armbruster 167304721fSJohn Snowfrom typing import ( 177304721fSJohn Snow Dict, 187304721fSJohn Snow List, 197304721fSJohn Snow Optional, 207304721fSJohn Snow Set, 217304721fSJohn Snow) 227304721fSJohn Snow 23e6a34cd7SJohn Snowfrom .common import c_name, mcgen 24e6a34cd7SJohn Snowfrom .gen import ( 257304721fSJohn Snow QAPIGenC, 26e6a34cd7SJohn Snow QAPISchemaModularCVisitor, 27e6a34cd7SJohn Snow build_params, 28e6a34cd7SJohn Snow ifcontext, 29*6604e475SMarkus Armbruster gen_special_features, 30e6a34cd7SJohn Snow) 317304721fSJohn Snowfrom .schema import ( 327304721fSJohn Snow QAPISchema, 337304721fSJohn Snow QAPISchemaFeature, 34f17539c8SMarc-André Lureau QAPISchemaIfCond, 357304721fSJohn Snow QAPISchemaObjectType, 367304721fSJohn Snow QAPISchemaType, 377304721fSJohn Snow) 387304721fSJohn Snowfrom .source import QAPISourceInfo 39fb0bc835SMarkus Armbruster 40fb0bc835SMarkus Armbruster 417304721fSJohn Snowdef gen_command_decl(name: str, 427304721fSJohn Snow arg_type: Optional[QAPISchemaObjectType], 437304721fSJohn Snow boxed: bool, 447304721fSJohn Snow ret_type: Optional[QAPISchemaType]) -> str: 45fb0bc835SMarkus Armbruster return mcgen(''' 46fb0bc835SMarkus Armbruster%(c_type)s qmp_%(c_name)s(%(params)s); 47fb0bc835SMarkus Armbruster''', 48fb0bc835SMarkus Armbruster c_type=(ret_type and ret_type.c_type()) or 'void', 49fb0bc835SMarkus Armbruster c_name=c_name(name), 50fb0bc835SMarkus Armbruster params=build_params(arg_type, boxed, 'Error **errp')) 51fb0bc835SMarkus Armbruster 52fb0bc835SMarkus Armbruster 537304721fSJohn Snowdef gen_call(name: str, 547304721fSJohn Snow arg_type: Optional[QAPISchemaObjectType], 557304721fSJohn Snow boxed: bool, 567304721fSJohn Snow ret_type: Optional[QAPISchemaType]) -> str: 57fb0bc835SMarkus Armbruster ret = '' 58fb0bc835SMarkus Armbruster 59fb0bc835SMarkus Armbruster argstr = '' 60fb0bc835SMarkus Armbruster if boxed: 61675b214bSMarkus Armbruster assert arg_type 62fb0bc835SMarkus Armbruster argstr = '&arg, ' 63fb0bc835SMarkus Armbruster elif arg_type: 64fb0bc835SMarkus Armbruster assert not arg_type.variants 65fb0bc835SMarkus Armbruster for memb in arg_type.members: 66fb0bc835SMarkus Armbruster if memb.optional: 67fb0bc835SMarkus Armbruster argstr += 'arg.has_%s, ' % c_name(memb.name) 68fb0bc835SMarkus Armbruster argstr += 'arg.%s, ' % c_name(memb.name) 69fb0bc835SMarkus Armbruster 70fb0bc835SMarkus Armbruster lhs = '' 71fb0bc835SMarkus Armbruster if ret_type: 72fb0bc835SMarkus Armbruster lhs = 'retval = ' 73fb0bc835SMarkus Armbruster 74fb0bc835SMarkus Armbruster ret = mcgen(''' 75fb0bc835SMarkus Armbruster 76fb0bc835SMarkus Armbruster %(lhs)sqmp_%(c_name)s(%(args)s&err); 77cdd2b228SMarkus Armbruster error_propagate(errp, err); 78fb0bc835SMarkus Armbruster''', 79fb0bc835SMarkus Armbruster c_name=c_name(name), args=argstr, lhs=lhs) 80fb0bc835SMarkus Armbruster if ret_type: 81fb0bc835SMarkus Armbruster ret += mcgen(''' 82fb0bc835SMarkus Armbruster if (err) { 83fb0bc835SMarkus Armbruster goto out; 84fb0bc835SMarkus Armbruster } 85fb0bc835SMarkus Armbruster 86cdd2b228SMarkus Armbruster qmp_marshal_output_%(c_name)s(retval, ret, errp); 87fb0bc835SMarkus Armbruster''', 88fb0bc835SMarkus Armbruster c_name=ret_type.c_name()) 89fb0bc835SMarkus Armbruster return ret 90fb0bc835SMarkus Armbruster 91fb0bc835SMarkus Armbruster 927304721fSJohn Snowdef gen_marshal_output(ret_type: QAPISchemaType) -> str: 93fb0bc835SMarkus Armbruster return mcgen(''' 94fb0bc835SMarkus Armbruster 9542c0dd12SJohn Snowstatic void qmp_marshal_output_%(c_name)s(%(c_type)s ret_in, 9642c0dd12SJohn Snow QObject **ret_out, Error **errp) 97fb0bc835SMarkus Armbruster{ 98fb0bc835SMarkus Armbruster Visitor *v; 99fb0bc835SMarkus Armbruster 10091fa93e5SMarkus Armbruster v = qobject_output_visitor_new_qmp(ret_out); 101cdd2b228SMarkus Armbruster if (visit_type_%(c_name)s(v, "unused", &ret_in, errp)) { 102fb0bc835SMarkus Armbruster visit_complete(v, ret_out); 103fb0bc835SMarkus Armbruster } 104fb0bc835SMarkus Armbruster visit_free(v); 105fb0bc835SMarkus Armbruster v = qapi_dealloc_visitor_new(); 106fb0bc835SMarkus Armbruster visit_type_%(c_name)s(v, "unused", &ret_in, NULL); 107fb0bc835SMarkus Armbruster visit_free(v); 108fb0bc835SMarkus Armbruster} 109fb0bc835SMarkus Armbruster''', 110fb0bc835SMarkus Armbruster c_type=ret_type.c_type(), c_name=ret_type.c_name()) 111fb0bc835SMarkus Armbruster 112fb0bc835SMarkus Armbruster 1137304721fSJohn Snowdef build_marshal_proto(name: str) -> str: 114fb0bc835SMarkus Armbruster return ('void qmp_marshal_%s(QDict *args, QObject **ret, Error **errp)' 115fb0bc835SMarkus Armbruster % c_name(name)) 116fb0bc835SMarkus Armbruster 117fb0bc835SMarkus Armbruster 1187304721fSJohn Snowdef gen_marshal_decl(name: str) -> str: 119fb0bc835SMarkus Armbruster return mcgen(''' 120fb0bc835SMarkus Armbruster%(proto)s; 121fb0bc835SMarkus Armbruster''', 122fb0bc835SMarkus Armbruster proto=build_marshal_proto(name)) 123fb0bc835SMarkus Armbruster 124fb0bc835SMarkus Armbruster 1257304721fSJohn Snowdef gen_marshal(name: str, 1267304721fSJohn Snow arg_type: Optional[QAPISchemaObjectType], 1277304721fSJohn Snow boxed: bool, 1287304721fSJohn Snow ret_type: Optional[QAPISchemaType]) -> str: 129675b214bSMarkus Armbruster have_args = boxed or (arg_type and not arg_type.is_empty()) 130ec9697abSJohn Snow if have_args: 131ec9697abSJohn Snow assert arg_type is not None 132ec9697abSJohn Snow arg_type_c_name = arg_type.c_name() 133fb0bc835SMarkus Armbruster 134fb0bc835SMarkus Armbruster ret = mcgen(''' 135fb0bc835SMarkus Armbruster 136fb0bc835SMarkus Armbruster%(proto)s 137fb0bc835SMarkus Armbruster{ 138fb0bc835SMarkus Armbruster Error *err = NULL; 139cdd2b228SMarkus Armbruster bool ok = false; 1402061487bSMarkus Armbruster Visitor *v; 141fb0bc835SMarkus Armbruster''', 142fb0bc835SMarkus Armbruster proto=build_marshal_proto(name)) 143fb0bc835SMarkus Armbruster 144fb0bc835SMarkus Armbruster if ret_type: 145fb0bc835SMarkus Armbruster ret += mcgen(''' 146fb0bc835SMarkus Armbruster %(c_type)s retval; 147fb0bc835SMarkus Armbruster''', 148fb0bc835SMarkus Armbruster c_type=ret_type.c_type()) 149fb0bc835SMarkus Armbruster 150fb0bc835SMarkus Armbruster if have_args: 151fb0bc835SMarkus Armbruster ret += mcgen(''' 152fb0bc835SMarkus Armbruster %(c_name)s arg = {0}; 153fb0bc835SMarkus Armbruster''', 154ec9697abSJohn Snow c_name=arg_type_c_name) 155fb0bc835SMarkus Armbruster 156fb0bc835SMarkus Armbruster ret += mcgen(''' 1572061487bSMarkus Armbruster 158db291641SMarkus Armbruster v = qobject_input_visitor_new_qmp(QOBJECT(args)); 159cdd2b228SMarkus Armbruster if (!visit_start_struct(v, NULL, NULL, 0, errp)) { 160fb0bc835SMarkus Armbruster goto out; 161fb0bc835SMarkus Armbruster } 16289bf68f9SMarkus Armbruster''') 16389bf68f9SMarkus Armbruster 16489bf68f9SMarkus Armbruster if have_args: 16589bf68f9SMarkus Armbruster ret += mcgen(''' 166cdd2b228SMarkus Armbruster if (visit_type_%(c_arg_type)s_members(v, &arg, errp)) { 167cdd2b228SMarkus Armbruster ok = visit_check_struct(v, errp); 168fb0bc835SMarkus Armbruster } 16989bf68f9SMarkus Armbruster''', 170ec9697abSJohn Snow c_arg_type=arg_type_c_name) 17189bf68f9SMarkus Armbruster else: 17289bf68f9SMarkus Armbruster ret += mcgen(''' 173cdd2b228SMarkus Armbruster ok = visit_check_struct(v, errp); 17489bf68f9SMarkus Armbruster''') 17589bf68f9SMarkus Armbruster 17689bf68f9SMarkus Armbruster ret += mcgen(''' 177fb0bc835SMarkus Armbruster visit_end_struct(v, NULL); 178cdd2b228SMarkus Armbruster if (!ok) { 179fb0bc835SMarkus Armbruster goto out; 180fb0bc835SMarkus Armbruster } 18189bf68f9SMarkus Armbruster''') 182fb0bc835SMarkus Armbruster 183fb0bc835SMarkus Armbruster ret += gen_call(name, arg_type, boxed, ret_type) 184fb0bc835SMarkus Armbruster 185fb0bc835SMarkus Armbruster ret += mcgen(''' 186fb0bc835SMarkus Armbruster 187fb0bc835SMarkus Armbrusterout: 188fb0bc835SMarkus Armbruster visit_free(v); 189fb0bc835SMarkus Armbruster''') 190fb0bc835SMarkus Armbruster 191fb0bc835SMarkus Armbruster ret += mcgen(''' 192fb0bc835SMarkus Armbruster v = qapi_dealloc_visitor_new(); 193fb0bc835SMarkus Armbruster visit_start_struct(v, NULL, NULL, 0, NULL); 19489bf68f9SMarkus Armbruster''') 19589bf68f9SMarkus Armbruster 19689bf68f9SMarkus Armbruster if have_args: 19789bf68f9SMarkus Armbruster ret += mcgen(''' 19889bf68f9SMarkus Armbruster visit_type_%(c_arg_type)s_members(v, &arg, NULL); 19989bf68f9SMarkus Armbruster''', 200ec9697abSJohn Snow c_arg_type=arg_type_c_name) 20189bf68f9SMarkus Armbruster 20289bf68f9SMarkus Armbruster ret += mcgen(''' 203fb0bc835SMarkus Armbruster visit_end_struct(v, NULL); 204fb0bc835SMarkus Armbruster visit_free(v); 20589bf68f9SMarkus Armbruster''') 206fb0bc835SMarkus Armbruster 207fb0bc835SMarkus Armbruster ret += mcgen(''' 208fb0bc835SMarkus Armbruster} 209fb0bc835SMarkus Armbruster''') 210fb0bc835SMarkus Armbruster return ret 211fb0bc835SMarkus Armbruster 212fb0bc835SMarkus Armbruster 2137304721fSJohn Snowdef gen_register_command(name: str, 214d2032598SMarkus Armbruster features: List[QAPISchemaFeature], 2157304721fSJohn Snow success_response: bool, 2167304721fSJohn Snow allow_oob: bool, 2177304721fSJohn Snow allow_preconfig: bool, 2187304721fSJohn Snow coroutine: bool) -> str: 219876c6751SPeter Xu options = [] 220876c6751SPeter Xu 221fb0bc835SMarkus Armbruster if not success_response: 222876c6751SPeter Xu options += ['QCO_NO_SUCCESS_RESP'] 223876c6751SPeter Xu if allow_oob: 224876c6751SPeter Xu options += ['QCO_ALLOW_OOB'] 225d6fe3d02SIgor Mammedov if allow_preconfig: 226d6fe3d02SIgor Mammedov options += ['QCO_ALLOW_PRECONFIG'] 22704f22362SKevin Wolf if coroutine: 22804f22362SKevin Wolf options += ['QCO_COROUTINE'] 229876c6751SPeter Xu 230fb0bc835SMarkus Armbruster ret = mcgen(''' 231fb0bc835SMarkus Armbruster qmp_register_command(cmds, "%(name)s", 232*6604e475SMarkus Armbruster qmp_marshal_%(c_name)s, %(opts)s, %(feats)s); 233fb0bc835SMarkus Armbruster''', 234fb0bc835SMarkus Armbruster name=name, c_name=c_name(name), 235*6604e475SMarkus Armbruster opts=' | '.join(options) or 0, 236*6604e475SMarkus Armbruster feats=gen_special_features(features)) 237fb0bc835SMarkus Armbruster return ret 238fb0bc835SMarkus Armbruster 239fb0bc835SMarkus Armbruster 240252dc310SMarkus Armbrusterclass QAPISchemaGenCommandVisitor(QAPISchemaModularCVisitor): 2417304721fSJohn Snow def __init__(self, prefix: str): 2422cae67bcSMarkus Armbruster super().__init__( 2432cae67bcSMarkus Armbruster prefix, 'qapi-commands', 2443bef3aaeSMarkus Armbruster ' * Schema-defined QAPI/QMP commands', None, __doc__) 2457304721fSJohn Snow self._visited_ret_types: Dict[QAPIGenC, Set[QAPISchemaType]] = {} 246252dc310SMarkus Armbruster 2477304721fSJohn Snow def _begin_user_module(self, name: str) -> None: 248252dc310SMarkus Armbruster self._visited_ret_types[self._genc] = set() 2499af23989SMarkus Armbruster commands = self._module_basename('qapi-commands', name) 2509af23989SMarkus Armbruster types = self._module_basename('qapi-types', name) 2519af23989SMarkus Armbruster visit = self._module_basename('qapi-visit', name) 25271b3f045SMarkus Armbruster self._genc.add(mcgen(''' 253fb0bc835SMarkus Armbruster#include "qemu/osdep.h" 25491fa93e5SMarkus Armbruster#include "qapi/compat-policy.h" 255fb0bc835SMarkus Armbruster#include "qapi/visitor.h" 256fb0bc835SMarkus Armbruster#include "qapi/qmp/qdict.h" 257fb0bc835SMarkus Armbruster#include "qapi/dealloc-visitor.h" 258fb0bc835SMarkus Armbruster#include "qapi/error.h" 2599af23989SMarkus Armbruster#include "%(visit)s.h" 2609af23989SMarkus Armbruster#include "%(commands)s.h" 261fb0bc835SMarkus Armbruster 262fb0bc835SMarkus Armbruster''', 2639af23989SMarkus Armbruster commands=commands, visit=visit)) 26471b3f045SMarkus Armbruster self._genh.add(mcgen(''' 2659af23989SMarkus Armbruster#include "%(types)s.h" 266fb0bc835SMarkus Armbruster 267fb0bc835SMarkus Armbruster''', 2689af23989SMarkus Armbruster types=types)) 269fb0bc835SMarkus Armbruster 270c6cd7e41SMarkus Armbruster def visit_begin(self, schema: QAPISchema) -> None: 2714ab0ff6dSMarkus Armbruster self._add_module('./init', ' * QAPI Commands initialization') 27200ca24ffSMarkus Armbruster self._genh.add(mcgen(''' 27300ca24ffSMarkus Armbruster#include "qapi/qmp/dispatch.h" 27400ca24ffSMarkus Armbruster 275252dc310SMarkus Armbrustervoid %(c_prefix)sqmp_init_marshal(QmpCommandList *cmds); 276252dc310SMarkus Armbruster''', 277252dc310SMarkus Armbruster c_prefix=c_name(self._prefix, protect=False))) 278c6cd7e41SMarkus Armbruster self._genc.add(mcgen(''' 27900ca24ffSMarkus Armbruster#include "qemu/osdep.h" 28000ca24ffSMarkus Armbruster#include "%(prefix)sqapi-commands.h" 28100ca24ffSMarkus Armbruster#include "%(prefix)sqapi-init-commands.h" 282c6cd7e41SMarkus Armbruster 283c6cd7e41SMarkus Armbrustervoid %(c_prefix)sqmp_init_marshal(QmpCommandList *cmds) 284c6cd7e41SMarkus Armbruster{ 285c6cd7e41SMarkus Armbruster QTAILQ_INIT(cmds); 286c6cd7e41SMarkus Armbruster 28700ca24ffSMarkus Armbruster''', 288c6cd7e41SMarkus Armbruster prefix=self._prefix, 289c6cd7e41SMarkus Armbruster c_prefix=c_name(self._prefix, protect=False))) 290c6cd7e41SMarkus Armbruster 291c6cd7e41SMarkus Armbruster def visit_end(self) -> None: 292c6cd7e41SMarkus Armbruster with self._temp_module('./init'): 293c6cd7e41SMarkus Armbruster self._genc.add(mcgen(''' 294c6cd7e41SMarkus Armbruster} 295c6cd7e41SMarkus Armbruster''')) 29671b3f045SMarkus Armbruster 2977304721fSJohn Snow def visit_command(self, 2987304721fSJohn Snow name: str, 2994a82e468SJohn Snow info: Optional[QAPISourceInfo], 300f17539c8SMarc-André Lureau ifcond: QAPISchemaIfCond, 3017304721fSJohn Snow features: List[QAPISchemaFeature], 3027304721fSJohn Snow arg_type: Optional[QAPISchemaObjectType], 3037304721fSJohn Snow ret_type: Optional[QAPISchemaType], 3047304721fSJohn Snow gen: bool, 3057304721fSJohn Snow success_response: bool, 3067304721fSJohn Snow boxed: bool, 3077304721fSJohn Snow allow_oob: bool, 3087304721fSJohn Snow allow_preconfig: bool, 3097304721fSJohn Snow coroutine: bool) -> None: 31071b3f045SMarkus Armbruster if not gen: 31171b3f045SMarkus Armbruster return 3121f7b9f31SMarc-André Lureau # FIXME: If T is a user-defined type, the user is responsible 3131f7b9f31SMarc-André Lureau # for making this work, i.e. to make T's condition the 3141f7b9f31SMarc-André Lureau # conjunction of the T-returning commands' conditions. If T 3151f7b9f31SMarc-André Lureau # is a built-in type, this isn't possible: the 3161f7b9f31SMarc-André Lureau # qmp_marshal_output_T() will be generated unconditionally. 317252dc310SMarkus Armbruster if ret_type and ret_type not in self._visited_ret_types[self._genc]: 318252dc310SMarkus Armbruster self._visited_ret_types[self._genc].add(ret_type) 3191f7b9f31SMarc-André Lureau with ifcontext(ret_type.ifcond, 320c6cd7e41SMarkus Armbruster self._genh, self._genc): 32171b3f045SMarkus Armbruster self._genc.add(gen_marshal_output(ret_type)) 322c6cd7e41SMarkus Armbruster with ifcontext(ifcond, self._genh, self._genc): 3231f7b9f31SMarc-André Lureau self._genh.add(gen_command_decl(name, arg_type, boxed, ret_type)) 32471b3f045SMarkus Armbruster self._genh.add(gen_marshal_decl(name)) 32571b3f045SMarkus Armbruster self._genc.add(gen_marshal(name, arg_type, boxed, ret_type)) 326c6cd7e41SMarkus Armbruster with self._temp_module('./init'): 327c6cd7e41SMarkus Armbruster with ifcontext(ifcond, self._genh, self._genc): 328d2032598SMarkus Armbruster self._genc.add(gen_register_command( 329d2032598SMarkus Armbruster name, features, success_response, allow_oob, 330d2032598SMarkus Armbruster allow_preconfig, coroutine)) 33171b3f045SMarkus Armbruster 33271b3f045SMarkus Armbruster 3337304721fSJohn Snowdef gen_commands(schema: QAPISchema, 3347304721fSJohn Snow output_dir: str, 3357304721fSJohn Snow prefix: str) -> None: 336fb0bc835SMarkus Armbruster vis = QAPISchemaGenCommandVisitor(prefix) 337fb0bc835SMarkus Armbruster schema.visit(vis) 33871b3f045SMarkus Armbruster vis.write(output_dir) 339