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 16fb0bc835SMarkus Armbrusterfrom qapi.common import * 17e6c42b96SMarkus Armbrusterfrom qapi.gen import QAPIGenCCode, QAPISchemaModularCVisitor, ifcontext 18fb0bc835SMarkus Armbruster 19fb0bc835SMarkus Armbruster 20fb0bc835SMarkus Armbrusterdef gen_command_decl(name, arg_type, boxed, ret_type): 21fb0bc835SMarkus Armbruster return mcgen(''' 22fb0bc835SMarkus Armbruster%(c_type)s qmp_%(c_name)s(%(params)s); 23fb0bc835SMarkus Armbruster''', 24fb0bc835SMarkus Armbruster c_type=(ret_type and ret_type.c_type()) or 'void', 25fb0bc835SMarkus Armbruster c_name=c_name(name), 26fb0bc835SMarkus Armbruster params=build_params(arg_type, boxed, 'Error **errp')) 27fb0bc835SMarkus Armbruster 28fb0bc835SMarkus Armbruster 29fb0bc835SMarkus Armbrusterdef gen_call(name, arg_type, boxed, ret_type): 30fb0bc835SMarkus Armbruster ret = '' 31fb0bc835SMarkus Armbruster 32fb0bc835SMarkus Armbruster argstr = '' 33fb0bc835SMarkus Armbruster if boxed: 34675b214bSMarkus Armbruster assert arg_type 35fb0bc835SMarkus Armbruster argstr = '&arg, ' 36fb0bc835SMarkus Armbruster elif arg_type: 37fb0bc835SMarkus Armbruster assert not arg_type.variants 38fb0bc835SMarkus Armbruster for memb in arg_type.members: 39fb0bc835SMarkus Armbruster if memb.optional: 40fb0bc835SMarkus Armbruster argstr += 'arg.has_%s, ' % c_name(memb.name) 41fb0bc835SMarkus Armbruster argstr += 'arg.%s, ' % c_name(memb.name) 42fb0bc835SMarkus Armbruster 43fb0bc835SMarkus Armbruster lhs = '' 44fb0bc835SMarkus Armbruster if ret_type: 45fb0bc835SMarkus Armbruster lhs = 'retval = ' 46fb0bc835SMarkus Armbruster 47fb0bc835SMarkus Armbruster ret = mcgen(''' 48fb0bc835SMarkus Armbruster 49fb0bc835SMarkus Armbruster %(lhs)sqmp_%(c_name)s(%(args)s&err); 50fb0bc835SMarkus Armbruster''', 51fb0bc835SMarkus Armbruster c_name=c_name(name), args=argstr, lhs=lhs) 52fb0bc835SMarkus Armbruster if ret_type: 53fb0bc835SMarkus Armbruster ret += mcgen(''' 54fb0bc835SMarkus Armbruster if (err) { 55fb0bc835SMarkus Armbruster goto out; 56fb0bc835SMarkus Armbruster } 57fb0bc835SMarkus Armbruster 58fb0bc835SMarkus Armbruster qmp_marshal_output_%(c_name)s(retval, ret, &err); 59fb0bc835SMarkus Armbruster''', 60fb0bc835SMarkus Armbruster c_name=ret_type.c_name()) 61fb0bc835SMarkus Armbruster return ret 62fb0bc835SMarkus Armbruster 63fb0bc835SMarkus Armbruster 64fb0bc835SMarkus Armbrusterdef gen_marshal_output(ret_type): 65fb0bc835SMarkus Armbruster return mcgen(''' 66fb0bc835SMarkus Armbruster 67fb0bc835SMarkus Armbrusterstatic void qmp_marshal_output_%(c_name)s(%(c_type)s ret_in, QObject **ret_out, Error **errp) 68fb0bc835SMarkus Armbruster{ 69fb0bc835SMarkus Armbruster Error *err = NULL; 70fb0bc835SMarkus Armbruster Visitor *v; 71fb0bc835SMarkus Armbruster 72fb0bc835SMarkus Armbruster v = qobject_output_visitor_new(ret_out); 73fb0bc835SMarkus Armbruster visit_type_%(c_name)s(v, "unused", &ret_in, &err); 74fb0bc835SMarkus Armbruster if (!err) { 75fb0bc835SMarkus Armbruster visit_complete(v, ret_out); 76fb0bc835SMarkus Armbruster } 77fb0bc835SMarkus Armbruster error_propagate(errp, err); 78fb0bc835SMarkus Armbruster visit_free(v); 79fb0bc835SMarkus Armbruster v = qapi_dealloc_visitor_new(); 80fb0bc835SMarkus Armbruster visit_type_%(c_name)s(v, "unused", &ret_in, NULL); 81fb0bc835SMarkus Armbruster visit_free(v); 82fb0bc835SMarkus Armbruster} 83fb0bc835SMarkus Armbruster''', 84fb0bc835SMarkus Armbruster c_type=ret_type.c_type(), c_name=ret_type.c_name()) 85fb0bc835SMarkus Armbruster 86fb0bc835SMarkus Armbruster 87fb0bc835SMarkus Armbrusterdef build_marshal_proto(name): 88fb0bc835SMarkus Armbruster return ('void qmp_marshal_%s(QDict *args, QObject **ret, Error **errp)' 89fb0bc835SMarkus Armbruster % c_name(name)) 90fb0bc835SMarkus Armbruster 91fb0bc835SMarkus Armbruster 92fb0bc835SMarkus Armbrusterdef gen_marshal_decl(name): 93fb0bc835SMarkus Armbruster return mcgen(''' 94fb0bc835SMarkus Armbruster%(proto)s; 95fb0bc835SMarkus Armbruster''', 96fb0bc835SMarkus Armbruster proto=build_marshal_proto(name)) 97fb0bc835SMarkus Armbruster 98fb0bc835SMarkus Armbruster 99fb0bc835SMarkus Armbrusterdef gen_marshal(name, arg_type, boxed, ret_type): 100675b214bSMarkus Armbruster have_args = boxed or (arg_type and not arg_type.is_empty()) 101fb0bc835SMarkus Armbruster 102fb0bc835SMarkus Armbruster ret = mcgen(''' 103fb0bc835SMarkus Armbruster 104fb0bc835SMarkus Armbruster%(proto)s 105fb0bc835SMarkus Armbruster{ 106fb0bc835SMarkus Armbruster Error *err = NULL; 107fb0bc835SMarkus Armbruster''', 108fb0bc835SMarkus Armbruster proto=build_marshal_proto(name)) 109fb0bc835SMarkus Armbruster 110fb0bc835SMarkus Armbruster if ret_type: 111fb0bc835SMarkus Armbruster ret += mcgen(''' 112fb0bc835SMarkus Armbruster %(c_type)s retval; 113fb0bc835SMarkus Armbruster''', 114fb0bc835SMarkus Armbruster c_type=ret_type.c_type()) 115fb0bc835SMarkus Armbruster 116fb0bc835SMarkus Armbruster if have_args: 117fb0bc835SMarkus Armbruster visit_members = ('visit_type_%s_members(v, &arg, &err);' 118fb0bc835SMarkus Armbruster % arg_type.c_name()) 119fb0bc835SMarkus Armbruster ret += mcgen(''' 120fb0bc835SMarkus Armbruster Visitor *v; 121fb0bc835SMarkus Armbruster %(c_name)s arg = {0}; 122fb0bc835SMarkus Armbruster 123fb0bc835SMarkus Armbruster''', 124fb0bc835SMarkus Armbruster c_name=arg_type.c_name()) 125fb0bc835SMarkus Armbruster else: 126fb0bc835SMarkus Armbruster visit_members = '' 127fb0bc835SMarkus Armbruster ret += mcgen(''' 128fb0bc835SMarkus Armbruster Visitor *v = NULL; 129fb0bc835SMarkus Armbruster 130fb0bc835SMarkus Armbruster if (args) { 131fb0bc835SMarkus Armbruster''') 132fb0bc835SMarkus Armbruster push_indent() 133fb0bc835SMarkus Armbruster 134fb0bc835SMarkus Armbruster ret += mcgen(''' 135fb0bc835SMarkus Armbruster v = qobject_input_visitor_new(QOBJECT(args)); 136fb0bc835SMarkus Armbruster visit_start_struct(v, NULL, NULL, 0, &err); 137fb0bc835SMarkus Armbruster if (err) { 138fb0bc835SMarkus Armbruster goto out; 139fb0bc835SMarkus Armbruster } 140fb0bc835SMarkus Armbruster %(visit_members)s 141fb0bc835SMarkus Armbruster if (!err) { 142fb0bc835SMarkus Armbruster visit_check_struct(v, &err); 143fb0bc835SMarkus Armbruster } 144fb0bc835SMarkus Armbruster visit_end_struct(v, NULL); 145fb0bc835SMarkus Armbruster if (err) { 146fb0bc835SMarkus Armbruster goto out; 147fb0bc835SMarkus Armbruster } 148fb0bc835SMarkus Armbruster''', 149fb0bc835SMarkus Armbruster visit_members=visit_members) 150fb0bc835SMarkus Armbruster 151fb0bc835SMarkus Armbruster if not have_args: 152fb0bc835SMarkus Armbruster pop_indent() 153fb0bc835SMarkus Armbruster ret += mcgen(''' 154fb0bc835SMarkus Armbruster } 155fb0bc835SMarkus Armbruster''') 156fb0bc835SMarkus Armbruster 157fb0bc835SMarkus Armbruster ret += gen_call(name, arg_type, boxed, ret_type) 158fb0bc835SMarkus Armbruster 159fb0bc835SMarkus Armbruster ret += mcgen(''' 160fb0bc835SMarkus Armbruster 161fb0bc835SMarkus Armbrusterout: 162fb0bc835SMarkus Armbruster error_propagate(errp, err); 163fb0bc835SMarkus Armbruster visit_free(v); 164fb0bc835SMarkus Armbruster''') 165fb0bc835SMarkus Armbruster 166fb0bc835SMarkus Armbruster if have_args: 167fb0bc835SMarkus Armbruster visit_members = ('visit_type_%s_members(v, &arg, NULL);' 168fb0bc835SMarkus Armbruster % arg_type.c_name()) 169fb0bc835SMarkus Armbruster else: 170fb0bc835SMarkus Armbruster visit_members = '' 171fb0bc835SMarkus Armbruster ret += mcgen(''' 172fb0bc835SMarkus Armbruster if (args) { 173fb0bc835SMarkus Armbruster''') 174fb0bc835SMarkus Armbruster push_indent() 175fb0bc835SMarkus Armbruster 176fb0bc835SMarkus Armbruster ret += mcgen(''' 177fb0bc835SMarkus Armbruster v = qapi_dealloc_visitor_new(); 178fb0bc835SMarkus Armbruster visit_start_struct(v, NULL, NULL, 0, NULL); 179fb0bc835SMarkus Armbruster %(visit_members)s 180fb0bc835SMarkus Armbruster visit_end_struct(v, NULL); 181fb0bc835SMarkus Armbruster visit_free(v); 182fb0bc835SMarkus Armbruster''', 183fb0bc835SMarkus Armbruster visit_members=visit_members) 184fb0bc835SMarkus Armbruster 185fb0bc835SMarkus Armbruster if not have_args: 186fb0bc835SMarkus Armbruster pop_indent() 187fb0bc835SMarkus Armbruster ret += mcgen(''' 188fb0bc835SMarkus Armbruster } 189fb0bc835SMarkus Armbruster''') 190fb0bc835SMarkus Armbruster 191fb0bc835SMarkus Armbruster ret += mcgen(''' 192fb0bc835SMarkus Armbruster} 193fb0bc835SMarkus Armbruster''') 194fb0bc835SMarkus Armbruster return ret 195fb0bc835SMarkus Armbruster 196fb0bc835SMarkus Armbruster 197d6fe3d02SIgor Mammedovdef gen_register_command(name, success_response, allow_oob, allow_preconfig): 198876c6751SPeter Xu options = [] 199876c6751SPeter Xu 200fb0bc835SMarkus Armbruster if not success_response: 201876c6751SPeter Xu options += ['QCO_NO_SUCCESS_RESP'] 202876c6751SPeter Xu if allow_oob: 203876c6751SPeter Xu options += ['QCO_ALLOW_OOB'] 204d6fe3d02SIgor Mammedov if allow_preconfig: 205d6fe3d02SIgor Mammedov options += ['QCO_ALLOW_PRECONFIG'] 206876c6751SPeter Xu 207876c6751SPeter Xu if not options: 208876c6751SPeter Xu options = ['QCO_NO_OPTIONS'] 209876c6751SPeter Xu 210876c6751SPeter Xu options = " | ".join(options) 211fb0bc835SMarkus Armbruster 212fb0bc835SMarkus Armbruster ret = mcgen(''' 213fb0bc835SMarkus Armbruster qmp_register_command(cmds, "%(name)s", 214fb0bc835SMarkus Armbruster qmp_marshal_%(c_name)s, %(opts)s); 215fb0bc835SMarkus Armbruster''', 216fb0bc835SMarkus Armbruster name=name, c_name=c_name(name), 217fb0bc835SMarkus Armbruster opts=options) 218fb0bc835SMarkus Armbruster return ret 219fb0bc835SMarkus Armbruster 220fb0bc835SMarkus Armbruster 221fb0bc835SMarkus Armbrusterdef gen_registry(registry, prefix): 222fb0bc835SMarkus Armbruster ret = mcgen(''' 223fb0bc835SMarkus Armbruster 224fb0bc835SMarkus Armbrustervoid %(c_prefix)sqmp_init_marshal(QmpCommandList *cmds) 225fb0bc835SMarkus Armbruster{ 226fb0bc835SMarkus Armbruster QTAILQ_INIT(cmds); 227fb0bc835SMarkus Armbruster 228fb0bc835SMarkus Armbruster''', 229fb0bc835SMarkus Armbruster c_prefix=c_name(prefix, protect=False)) 230fb0bc835SMarkus Armbruster ret += registry 231fb0bc835SMarkus Armbruster ret += mcgen(''' 232fb0bc835SMarkus Armbruster} 233fb0bc835SMarkus Armbruster''') 234fb0bc835SMarkus Armbruster return ret 235fb0bc835SMarkus Armbruster 236fb0bc835SMarkus Armbruster 237252dc310SMarkus Armbrusterclass QAPISchemaGenCommandVisitor(QAPISchemaModularCVisitor): 238fb0bc835SMarkus Armbruster 23971b3f045SMarkus Armbruster def __init__(self, prefix): 240252dc310SMarkus Armbruster QAPISchemaModularCVisitor.__init__( 241252dc310SMarkus Armbruster self, prefix, 'qapi-commands', 24271b3f045SMarkus Armbruster ' * Schema-defined QAPI/QMP commands', __doc__) 243dddee4d7SMarkus Armbruster self._regy = QAPIGenCCode(None) 244252dc310SMarkus Armbruster self._visited_ret_types = {} 245252dc310SMarkus Armbruster 246dcac6471SMarkus Armbruster def _begin_user_module(self, name): 247252dc310SMarkus Armbruster self._visited_ret_types[self._genc] = set() 2489af23989SMarkus Armbruster commands = self._module_basename('qapi-commands', name) 2499af23989SMarkus Armbruster types = self._module_basename('qapi-types', name) 2509af23989SMarkus Armbruster visit = self._module_basename('qapi-visit', name) 25171b3f045SMarkus Armbruster self._genc.add(mcgen(''' 252fb0bc835SMarkus Armbruster#include "qemu/osdep.h" 253fb0bc835SMarkus Armbruster#include "qapi/visitor.h" 254fb0bc835SMarkus Armbruster#include "qapi/qmp/qdict.h" 255fb0bc835SMarkus Armbruster#include "qapi/qobject-output-visitor.h" 256fb0bc835SMarkus Armbruster#include "qapi/qobject-input-visitor.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#include "qapi/qmp/dispatch.h" 267fb0bc835SMarkus Armbruster 268fb0bc835SMarkus Armbruster''', 2699af23989SMarkus Armbruster types=types)) 270fb0bc835SMarkus Armbruster 27171b3f045SMarkus Armbruster def visit_end(self): 272252dc310SMarkus Armbruster (genc, genh) = self._module[self._main_module] 273252dc310SMarkus Armbruster genh.add(mcgen(''' 274252dc310SMarkus Armbrustervoid %(c_prefix)sqmp_init_marshal(QmpCommandList *cmds); 275252dc310SMarkus Armbruster''', 276252dc310SMarkus Armbruster c_prefix=c_name(self._prefix, protect=False))) 2771f7b9f31SMarc-André Lureau genc.add(gen_registry(self._regy.get_content(), self._prefix)) 27871b3f045SMarkus Armbruster 279fbf09a2fSMarc-André Lureau def visit_command(self, name, info, ifcond, arg_type, ret_type, gen, 280*23394b4cSPeter Krempa success_response, boxed, allow_oob, allow_preconfig, 281*23394b4cSPeter Krempa features): 28271b3f045SMarkus Armbruster if not gen: 28371b3f045SMarkus Armbruster return 2841f7b9f31SMarc-André Lureau # FIXME: If T is a user-defined type, the user is responsible 2851f7b9f31SMarc-André Lureau # for making this work, i.e. to make T's condition the 2861f7b9f31SMarc-André Lureau # conjunction of the T-returning commands' conditions. If T 2871f7b9f31SMarc-André Lureau # is a built-in type, this isn't possible: the 2881f7b9f31SMarc-André Lureau # qmp_marshal_output_T() will be generated unconditionally. 289252dc310SMarkus Armbruster if ret_type and ret_type not in self._visited_ret_types[self._genc]: 290252dc310SMarkus Armbruster self._visited_ret_types[self._genc].add(ret_type) 2911f7b9f31SMarc-André Lureau with ifcontext(ret_type.ifcond, 2921f7b9f31SMarc-André Lureau self._genh, self._genc, self._regy): 29371b3f045SMarkus Armbruster self._genc.add(gen_marshal_output(ret_type)) 2941f7b9f31SMarc-André Lureau with ifcontext(ifcond, self._genh, self._genc, self._regy): 2951f7b9f31SMarc-André Lureau self._genh.add(gen_command_decl(name, arg_type, boxed, ret_type)) 29671b3f045SMarkus Armbruster self._genh.add(gen_marshal_decl(name)) 29771b3f045SMarkus Armbruster self._genc.add(gen_marshal(name, arg_type, boxed, ret_type)) 2981f7b9f31SMarc-André Lureau self._regy.add(gen_register_command(name, success_response, 2991f7b9f31SMarc-André Lureau allow_oob, allow_preconfig)) 30071b3f045SMarkus Armbruster 30171b3f045SMarkus Armbruster 30271b3f045SMarkus Armbrusterdef gen_commands(schema, output_dir, prefix): 303fb0bc835SMarkus Armbruster vis = QAPISchemaGenCommandVisitor(prefix) 304fb0bc835SMarkus Armbruster schema.visit(vis) 30571b3f045SMarkus Armbruster vis.write(output_dir) 306