scripts/qapi-commands.py

   1 #
   2 # QAPI command marshaller generator
   3 #
   4 # Copyright IBM, Corp. 2011
   5 # Copyright (C) 2014-2016 Red Hat, Inc.
   6 #
   7 # Authors:
   8 #  Anthony Liguori <aliguori@us.ibm.com>
   9 #  Michael Roth    <mdroth@linux.vnet.ibm.com>
  10 #  Markus Armbruster <armbru@redhat.com>
  11 #
  12 # This work is licensed under the terms of the GNU GPL, version 2.
  13 # See the COPYING file in the top-level directory.
  14
  15 from qapi import *
  16 import re
  17
  18
  19 def gen_command_decl(name, arg_type, ret_type):
  20     return mcgen('''
  21 %(c_type)s qmp_%(c_name)s(%(params)s);
  22 ''',
  23                  c_type=(ret_type and ret_type.c_type()) or 'void',
  24                  c_name=c_name(name),
  25                  params=gen_params(arg_type, 'Error **errp'))
  26
  27
  28 def gen_call(name, arg_type, ret_type):
  29     ret = ''
  30
  31     argstr = ''
  32     if arg_type:
  33         assert not arg_type.variants
  34         for memb in arg_type.members:
  35             if memb.optional:
  36                 argstr += 'arg.has_%s, ' % c_name(memb.name)
  37             argstr += 'arg.%s, ' % c_name(memb.name)
  38
  39     lhs = ''
  40     if ret_type:
  41         lhs = 'retval = '
  42
  43     ret = mcgen('''
  44
  45     %(lhs)sqmp_%(c_name)s(%(args)s&err);
  46 ''',
  47                 c_name=c_name(name), args=argstr, lhs=lhs)
  48     if ret_type:
  49         ret += mcgen('''
  50     if (err) {
  51         goto out;
  52     }
  53
  54     qmp_marshal_output_%(c_name)s(retval, ret, &err);
  55 ''',
  56                      c_name=ret_type.c_name())
  57     return ret
  58
  59
  60 def gen_marshal_output(ret_type):
  61     return mcgen('''
  62
  63 static void qmp_marshal_output_%(c_name)s(%(c_type)s ret_in, QObject **ret_out, Error **errp)
  64 {
  65     Error *err = NULL;
  66     Visitor *v;
  67
  68     v = qmp_output_visitor_new(ret_out);
  69     visit_type_%(c_name)s(v, "unused", &ret_in, &err);
  70     if (!err) {
  71         visit_complete(v, ret_out);
  72     }
  73     error_propagate(errp, err);
  74     visit_free(v);
  75     v = qapi_dealloc_visitor_new();
  76     visit_type_%(c_name)s(v, "unused", &ret_in, NULL);
  77     visit_free(v);
  78 }
  79 ''',
  80                  c_type=ret_type.c_type(), c_name=ret_type.c_name())
  81
  82
  83 def gen_marshal_proto(name):
  84     ret = 'void qmp_marshal_%s(QDict *args, QObject **ret, Error **errp)' % c_name(name)
  85     if not middle_mode:
  86         ret = 'static ' + ret
  87     return ret
  88
  89
  90 def gen_marshal_decl(name):
  91     return mcgen('''
  92 %(proto)s;
  93 ''',
  94                  proto=gen_marshal_proto(name))
  95
  96
  97 def gen_marshal(name, arg_type, ret_type):
  98     ret = mcgen('''
  99
 100 %(proto)s
 101 {
 102     Error *err = NULL;
 103 ''',
 104                 proto=gen_marshal_proto(name))
 105
 106     if ret_type:
 107         ret += mcgen('''
 108     %(c_type)s retval;
 109 ''',
 110                      c_type=ret_type.c_type())
 111
 112     if arg_type and not arg_type.is_empty():
 113         ret += mcgen('''
 114     Visitor *v;
 115     %(c_name)s arg = {0};
 116
 117     v = qmp_input_visitor_new(QOBJECT(args), true);
 118     visit_start_struct(v, NULL, NULL, 0, &err);
 119     if (err) {
 120         goto out;
 121     }
 122     visit_type_%(c_name)s_members(v, &arg, &err);
 123     if (!err) {
 124         visit_check_struct(v, &err);
 125     }
 126     visit_end_struct(v, NULL);
 127     if (err) {
 128         goto out;
 129     }
 130 ''',
 131                      c_name=arg_type.c_name())
 132
 133     else:
 134         ret += mcgen('''
 135
 136     (void)args;
 137 ''')
 138
 139     ret += gen_call(name, arg_type, ret_type)
 140
 141     # 'goto out' produced above for arg_type, and by gen_call() for ret_type
 142     if (arg_type and not arg_type.is_empty()) or ret_type:
 143         ret += mcgen('''
 144
 145 out:
 146 ''')
 147     ret += mcgen('''
 148     error_propagate(errp, err);
 149 ''')
 150     if arg_type and not arg_type.is_empty():
 151         ret += mcgen('''
 152     visit_free(v);
 153     v = qapi_dealloc_visitor_new();
 154     visit_start_struct(v, NULL, NULL, 0, NULL);
 155     visit_type_%(c_name)s_members(v, &arg, NULL);
 156     visit_end_struct(v, NULL);
 157     visit_free(v);
 158 ''',
 159                      c_name=arg_type.c_name())
 160
 161     ret += mcgen('''
 162 }
 163 ''')
 164     return ret
 165
 166
 167 def gen_register_command(name, success_response):
 168     options = 'QCO_NO_OPTIONS'
 169     if not success_response:
 170         options = 'QCO_NO_SUCCESS_RESP'
 171
 172     ret = mcgen('''
 173     qmp_register_command("%(name)s", qmp_marshal_%(c_name)s, %(opts)s);
 174 ''',
 175                 name=name, c_name=c_name(name),
 176                 opts=options)
 177     return ret
 178
 179
 180 def gen_registry(registry):
 181     ret = mcgen('''
 182
 183 static void qmp_init_marshal(void)
 184 {
 185 ''')
 186     ret += registry
 187     ret += mcgen('''
 188 }
 189
 190 qapi_init(qmp_init_marshal);
 191 ''')
 192     return ret
 193
 194
 195 class QAPISchemaGenCommandVisitor(QAPISchemaVisitor):
 196     def __init__(self):
 197         self.decl = None
 198         self.defn = None
 199         self._regy = None
 200         self._visited_ret_types = None
 201
 202     def visit_begin(self, schema):
 203         self.decl = ''
 204         self.defn = ''
 205         self._regy = ''
 206         self._visited_ret_types = set()
 207
 208     def visit_end(self):
 209         if not middle_mode:
 210             self.defn += gen_registry(self._regy)
 211         self._regy = None
 212         self._visited_ret_types = None
 213
 214     def visit_command(self, name, info, arg_type, ret_type,
 215                       gen, success_response):
 216         if not gen:
 217             return
 218         self.decl += gen_command_decl(name, arg_type, ret_type)
 219         if ret_type and ret_type not in self._visited_ret_types:
 220             self._visited_ret_types.add(ret_type)
 221             self.defn += gen_marshal_output(ret_type)
 222         if middle_mode:
 223             self.decl += gen_marshal_decl(name)
 224         self.defn += gen_marshal(name, arg_type, ret_type)
 225         if not middle_mode:
 226             self._regy += gen_register_command(name, success_response)
 227
 228
 229 middle_mode = False
 230
 231 (input_file, output_dir, do_c, do_h, prefix, opts) = \
 232     parse_command_line("m", ["middle"])
 233
 234 for o, a in opts:
 235     if o in ("-m", "--middle"):
 236         middle_mode = True
 237
 238 c_comment = '''
 239 /*
 240  * schema-defined QMP->QAPI command dispatch
 241  *
 242  * Copyright IBM, Corp. 2011
 243  *
 244  * Authors:
 245  *  Anthony Liguori   <aliguori@us.ibm.com>
 246  *
 247  * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
 248  * See the COPYING.LIB file in the top-level directory.
 249  *
 250  */
 251 '''
 252 h_comment = '''
 253 /*
 254  * schema-defined QAPI function prototypes
 255  *
 256  * Copyright IBM, Corp. 2011
 257  *
 258  * Authors:
 259  *  Anthony Liguori   <aliguori@us.ibm.com>
 260  *
 261  * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
 262  * See the COPYING.LIB file in the top-level directory.
 263  *
 264  */
 265 '''
 266
 267 (fdef, fdecl) = open_output(output_dir, do_c, do_h, prefix,
 268                             'qmp-marshal.c', 'qmp-commands.h',
 269                             c_comment, h_comment)
 270
 271 fdef.write(mcgen('''
 272 #include "qemu/osdep.h"
 273 #include "qemu-common.h"
 274 #include "qemu/module.h"
 275 #include "qapi/qmp/types.h"
 276 #include "qapi/qmp/dispatch.h"
 277 #include "qapi/visitor.h"
 278 #include "qapi/qmp-output-visitor.h"
 279 #include "qapi/qmp-input-visitor.h"
 280 #include "qapi/dealloc-visitor.h"
 281 #include "%(prefix)sqapi-types.h"
 282 #include "%(prefix)sqapi-visit.h"
 283 #include "%(prefix)sqmp-commands.h"
 284
 285 ''',
 286                  prefix=prefix))
 287
 288 fdecl.write(mcgen('''
 289 #include "%(prefix)sqapi-types.h"
 290 #include "qapi/qmp/qdict.h"
 291 #include "qapi/error.h"
 292
 293 ''',
 294                   prefix=prefix))
 295
 296 schema = QAPISchema(input_file)
 297 gen = QAPISchemaGenCommandVisitor()
 298 schema.visit(gen)
 299 fdef.write(gen.defn)
 300 fdecl.write(gen.decl)
 301
 302 close_output(fdef, fdecl)