Merge remote-tracking branch 'remotes/ericb/tags/pull-qapi-2018-03-01-v4' into staging

qapi patches for 2018-03-01

- Markus Armbruster: Modularize generated QAPI code

# gpg: Signature made Fri 02 Mar 2018 19:50:16 GMT
# gpg:                using RSA key A7A16B4A2527436A
# gpg: Good signature from "Eric Blake <eblake@redhat.com>"
# gpg:                 aka "Eric Blake (Free Software Programmer) <ebb9@byu.net>"
# gpg:                 aka "[jpeg image of size 6874]"
# Primary key fingerprint: 71C2 CC22 B1C4 6029 27D2  F3AA A7A1 6B4A 2527 436A

* remotes/ericb/tags/pull-qapi-2018-03-01-v4: (30 commits)
  qapi: Don't create useless directory qapi-generated
  Fix up dangling references to qmp-commands.* in comment and doc
  qapi: Move qapi-schema.json to qapi/, rename generated files
  docs: Correct outdated information on QAPI
  docs/devel/writing-qmp-commands: Update for modular QAPI
  qapi: Empty out qapi-schema.json
  Include less of the generated modular QAPI headers
  qapi: Generate separate .h, .c for each module
  watchdog: Consolidate QAPI into single file
  qapi/common: Fix guardname() for funny filenames
  qapi/types qapi/visit: Generate built-in stuff into separate files
  qapi: Make code-generating visitors use QAPIGen more
  qapi: Rename generated qmp-marshal.c to qmp-commands.c
  qapi: Record 'include' directives in intermediate representation
  qapi: Generate in source order
  qapi: Record 'include' directives in parse tree
  qapi: Concentrate QAPISchemaParser.exprs updates in .__init__()
  qapi: Lift error reporting from QAPISchema.__init__() to callers
  qapi/common: Eliminate QAPISchema.exprs
  qapi: Improve include file name reporting in error messages
  ...

Signed-off-by: Peter Maydell <peter.maydell@linaro.org>

1 files changed, 242 insertions, 0 deletions

diff --git a/scripts/qapi/types.py b/scripts/qapi/types.py
new file mode 100644
index 0000000000..64d9c0fb37
--- /dev/null
+++ b/scripts/qapi/types.py
@@ -0,0 +1,242 @@
+"""
+QAPI types generator
+
+Copyright IBM, Corp. 2011
+Copyright (c) 2013-2018 Red Hat Inc.
+
+Authors:
+ Anthony Liguori <aliguori@us.ibm.com>
+ Michael Roth <mdroth@linux.vnet.ibm.com>
+ Markus Armbruster <armbru@redhat.com>
+
+This work is licensed under the terms of the GNU GPL, version 2.
+# See the COPYING file in the top-level directory.
+"""
+
+from qapi.common import *
+
+
+# variants must be emitted before their container; track what has already
+# been output
+objects_seen = set()
+
+
+def gen_fwd_object_or_array(name):
+    return mcgen('''
+
+typedef struct %(c_name)s %(c_name)s;
+''',
+                 c_name=c_name(name))
+
+
+def gen_array(name, element_type):
+    return mcgen('''
+
+struct %(c_name)s {
+    %(c_name)s *next;
+    %(c_type)s value;
+};
+''',
+                 c_name=c_name(name), c_type=element_type.c_type())
+
+
+def gen_struct_members(members):
+    ret = ''
+    for memb in members:
+        if memb.optional:
+            ret += mcgen('''
+    bool has_%(c_name)s;
+''',
+                         c_name=c_name(memb.name))
+        ret += mcgen('''
+    %(c_type)s %(c_name)s;
+''',
+                     c_type=memb.type.c_type(), c_name=c_name(memb.name))
+    return ret
+
+
+def gen_object(name, base, members, variants):
+    if name in objects_seen:
+        return ''
+    objects_seen.add(name)
+
+    ret = ''
+    if variants:
+        for v in variants.variants:
+            if isinstance(v.type, QAPISchemaObjectType):
+                ret += gen_object(v.type.name, v.type.base,
+                                  v.type.local_members, v.type.variants)
+
+    ret += mcgen('''
+
+struct %(c_name)s {
+''',
+                 c_name=c_name(name))
+
+    if base:
+        if not base.is_implicit():
+            ret += mcgen('''
+    /* Members inherited from %(c_name)s: */
+''',
+                         c_name=base.c_name())
+        ret += gen_struct_members(base.members)
+        if not base.is_implicit():
+            ret += mcgen('''
+    /* Own members: */
+''')
+    ret += gen_struct_members(members)
+
+    if variants:
+        ret += gen_variants(variants)
+
+    # Make sure that all structs have at least one member; this avoids
+    # potential issues with attempting to malloc space for zero-length
+    # structs in C, and also incompatibility with C++ (where an empty
+    # struct is size 1).
+    if (not base or base.is_empty()) and not members and not variants:
+        ret += mcgen('''
+    char qapi_dummy_for_empty_struct;
+''')
+
+    ret += mcgen('''
+};
+''')
+
+    return ret
+
+
+def gen_upcast(name, base):
+    # C makes const-correctness ugly.  We have to cast away const to let
+    # this function work for both const and non-const obj.
+    return mcgen('''
+
+static inline %(base)s *qapi_%(c_name)s_base(const %(c_name)s *obj)
+{
+    return (%(base)s *)obj;
+}
+''',
+                 c_name=c_name(name), base=base.c_name())
+
+
+def gen_variants(variants):
+    ret = mcgen('''
+    union { /* union tag is @%(c_name)s */
+''',
+                c_name=c_name(variants.tag_member.name))
+
+    for var in variants.variants:
+        ret += mcgen('''
+        %(c_type)s %(c_name)s;
+''',
+                     c_type=var.type.c_unboxed_type(),
+                     c_name=c_name(var.name))
+
+    ret += mcgen('''
+    } u;
+''')
+
+    return ret
+
+
+def gen_type_cleanup_decl(name):
+    ret = mcgen('''
+
+void qapi_free_%(c_name)s(%(c_name)s *obj);
+''',
+                c_name=c_name(name))
+    return ret
+
+
+def gen_type_cleanup(name):
+    ret = mcgen('''
+
+void qapi_free_%(c_name)s(%(c_name)s *obj)
+{
+    Visitor *v;
+
+    if (!obj) {
+        return;
+    }
+
+    v = qapi_dealloc_visitor_new();
+    visit_type_%(c_name)s(v, NULL, &obj, NULL);
+    visit_free(v);
+}
+''',
+                c_name=c_name(name))
+    return ret
+
+
+class QAPISchemaGenTypeVisitor(QAPISchemaModularCVisitor):
+
+    def __init__(self, prefix):
+        QAPISchemaModularCVisitor.__init__(
+            self, prefix, 'qapi-types', ' * Schema-defined QAPI types',
+            __doc__)
+        self._add_module(None, ' * Built-in QAPI types')
+        self._genc.preamble_add(mcgen('''
+#include "qemu/osdep.h"
+#include "qapi/dealloc-visitor.h"
+#include "qapi/qapi-builtin-types.h"
+#include "qapi/qapi-builtin-visit.h"
+'''))
+        self._genh.preamble_add(mcgen('''
+#include "qapi/util.h"
+'''))
+
+    def _begin_module(self, name):
+        types = self._module_basename('qapi-types', name)
+        visit = self._module_basename('qapi-visit', name)
+        self._genc.preamble_add(mcgen('''
+#include "qemu/osdep.h"
+#include "qapi/dealloc-visitor.h"
+#include "%(types)s.h"
+#include "%(visit)s.h"
+''',
+                                      types=types, visit=visit))
+        self._genh.preamble_add(mcgen('''
+#include "qapi/qapi-builtin-types.h"
+'''))
+
+    def visit_begin(self, schema):
+        # gen_object() is recursive, ensure it doesn't visit the empty type
+        objects_seen.add(schema.the_empty_object_type.name)
+
+    def _gen_type_cleanup(self, name):
+        self._genh.add(gen_type_cleanup_decl(name))
+        self._genc.add(gen_type_cleanup(name))
+
+    def visit_enum_type(self, name, info, values, prefix):
+        self._genh.preamble_add(gen_enum(name, values, prefix))
+        self._genc.add(gen_enum_lookup(name, values, prefix))
+
+    def visit_array_type(self, name, info, element_type):
+        self._genh.preamble_add(gen_fwd_object_or_array(name))
+        self._genh.add(gen_array(name, element_type))
+        self._gen_type_cleanup(name)
+
+    def visit_object_type(self, name, info, base, members, variants):
+        # Nothing to do for the special empty builtin
+        if name == 'q_empty':
+            return
+        self._genh.preamble_add(gen_fwd_object_or_array(name))
+        self._genh.add(gen_object(name, base, members, variants))
+        if base and not base.is_implicit():
+            self._genh.add(gen_upcast(name, base))
+        # TODO Worth changing the visitor signature, so we could
+        # directly use rather than repeat type.is_implicit()?
+        if not name.startswith('q_'):
+            # implicit types won't be directly allocated/freed
+            self._gen_type_cleanup(name)
+
+    def visit_alternate_type(self, name, info, variants):
+        self._genh.preamble_add(gen_fwd_object_or_array(name))
+        self._genh.add(gen_object(name, None,
+                                  [variants.tag_member], variants))
+        self._gen_type_cleanup(name)
+
+
+def gen_types(schema, output_dir, prefix, opt_builtins):
+    vis = QAPISchemaGenTypeVisitor(prefix)
+    schema.visit(vis)
+    vis.write(output_dir, opt_builtins)