| Message ID | 20180202130336.24719-18-armbru@redhat.com |
|---|---|
| State | New |
| Headers | show |
| Series | Modularize generated QAPI code | expand |
On Fri, Feb 2, 2018 at 2:03 PM, Markus Armbruster <armbru@redhat.com> wrote: > Linking code from multiple separate QAPI schemata into the same > program is possible, but involves some weirdness around built-in > types: > > * We generate code for built-in types into .c only with option > --builtins. The user is responsible to generate code for exactly > one QAPI schema per program with --builtins. > > * We generate code for them it into .h regardless of --builtins, > guarded by #ifndef QAPI_VISIT_BUILTIN. Because the code for > built-in types is exactly the same in all of them, including any > combination of these headers works. > > Replace this contraption by something more conventional: generate code > for built-in types into their very own files: qapi-builtin-types.c, > qapi-builtin-visit.c, qapi-builtin-types.h, qapi-builtin-visit.h, but > only with --builtins. Obey --output-dir, but ignore --prefix for > them. > > Make qapi-types.h include qapi-builtin-types.h. With multiple > schemata you now have multiple qapi-types.[ch], but only one > qapi-builtin-types.[ch]. Same for qapi-visit.[ch] and > qapi-builtin-visit.[ch]. > > Bonus: if all you need is built-in stuff, you can include a much > smaller header. To be exploited shortly. > > Signed-off-by: Markus Armbruster <armbru@redhat.com> Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com> > --- > Makefile | 13 +++++--- > Makefile.objs | 1 + > scripts/qapi/common.py | 18 +++++------ > scripts/qapi/types.py | 82 ++++++++++++++++++++++++++---------------------- > scripts/qapi/visit.py | 84 ++++++++++++++++++++++++++++---------------------- > 5 files changed, 111 insertions(+), 87 deletions(-) > > diff --git a/Makefile b/Makefile > index e02f0c13ef..f9b7900330 100644 > --- a/Makefile > +++ b/Makefile > @@ -88,10 +88,13 @@ endif > include $(SRC_PATH)/rules.mak > > GENERATED_FILES = qemu-version.h config-host.h qemu-options.def > -GENERATED_FILES += qmp-commands.h qapi-types.h qapi-visit.h qapi-event.h > -GENERATED_FILES += qmp-marshal.c qapi-types.c qapi-visit.c qapi-event.c > -GENERATED_FILES += qmp-introspect.h > -GENERATED_FILES += qmp-introspect.c > +GENERATED_FILES += qmp-commands.h qmp-marshal.c > +GENERATED_FILES += qapi-builtin-types.h qapi-builtin-types.c > +GENERATED_FILES += qapi-types.h qapi-types.c > +GENERATED_FILES += qapi-builtin-visit.h qapi-builtin-visit.c > +GENERATED_FILES += qapi-visit.h qapi-visit.c > +GENERATED_FILES += qapi-event.h qapi-event.c > +GENERATED_FILES += qmp-introspect.c qmp-introspect.h > GENERATED_FILES += qapi.texi > > GENERATED_FILES += trace/generated-tcg-tracers.h > @@ -514,7 +517,9 @@ qapi-modules = $(SRC_PATH)/qapi-schema.json $(SRC_PATH)/qapi/common.json \ > $(SRC_PATH)/qapi/transaction.json \ > $(SRC_PATH)/qapi/ui.json > > +qapi-builtin-types.c qapi-builtin-types.h \ > qapi-types.c qapi-types.h \ > +qapi-builtin-visit.c qapi-builtin-visit.h \ > qapi-visit.c qapi-visit.h \ > qmp-commands.h qmp-marshal.c \ > qapi-event.c qapi-event.h \ > diff --git a/Makefile.objs b/Makefile.objs > index 323ef12384..f16cca06e7 100644 > --- a/Makefile.objs > +++ b/Makefile.objs > @@ -2,6 +2,7 @@ > # Common libraries for tools and emulators > stub-obj-y = stubs/ crypto/ > util-obj-y = util/ qobject/ qapi/ > +util-obj-y += qapi-builtin-types.o qapi-builtin-visit.o > util-obj-y += qmp-introspect.o qapi-types.o qapi-visit.o qapi-event.o > > chardev-obj-y = chardev/ > diff --git a/scripts/qapi/common.py b/scripts/qapi/common.py > index f4e9ebbb53..7ffffc78d9 100644 > --- a/scripts/qapi/common.py > +++ b/scripts/qapi/common.py > @@ -1527,11 +1527,10 @@ class QAPISchema(object): > > def _def_builtin_type(self, name, json_type, c_type): > self._def_entity(QAPISchemaBuiltinType(name, json_type, c_type)) > - # TODO As long as we have QAPI_TYPES_BUILTIN to share multiple > - # qapi-types.h from a single .c, all arrays of builtins must be > - # declared in the first file whether or not they are used. Nicer > - # would be to use lazy instantiation, while figuring out how to > - # avoid compilation issues with multiple qapi-types.h. > + # Instantiating only the arrays that are actually used would > + # be nice, but we can't as long as their generated code > + # (qapi-builtin-types.[ch]) may be shared by some other > + # schema. > self._make_array_type(name, None) > > def _def_predefineds(self): > @@ -1985,14 +1984,15 @@ class QAPIGen(object): > return '' > > def write(self, output_dir, fname): > - if output_dir: > + pathname = os.path.join(output_dir, fname) > + dir = os.path.dirname(pathname) > + if dir: > try: > - os.makedirs(output_dir) > + os.makedirs(dir) > except os.error as e: > if e.errno != errno.EEXIST: > raise > - fd = os.open(os.path.join(output_dir, fname), > - os.O_RDWR | os.O_CREAT, 0666) > + fd = os.open(pathname, os.O_RDWR | os.O_CREAT, 0666) > f = os.fdopen(fd, 'r+') > text = (self.top(fname) + self._preamble + self._body > + self.bottom(fname)) > diff --git a/scripts/qapi/types.py b/scripts/qapi/types.py > index eeffcbf32c..f84ed17960 100644 > --- a/scripts/qapi/types.py > +++ b/scripts/qapi/types.py > @@ -171,64 +171,72 @@ class QAPISchemaGenTypeVisitor(QAPISchemaVisitor): > def __init__(self, opt_builtins, prefix): > self._opt_builtins = opt_builtins > self._prefix = prefix > - blurb = ' * Schema-defined QAPI types' > - self._genc = QAPIGenC(blurb, __doc__) > - self._genh = QAPIGenH(blurb, __doc__) > + self._module = {} > + self._add_module(None, ' * Built-in QAPI types') > self._genc.preamble(mcgen(''' > #include "qemu/osdep.h" > #include "qapi/dealloc-visitor.h" > -#include "%(prefix)sqapi-types.h" > -#include "%(prefix)sqapi-visit.h" > -''', > - prefix=prefix)) > +#include "qapi-builtin-types.h" > +#include "qapi-builtin-visit.h" > +''')) > self._genh.preamble(mcgen(''' > #include "qapi/util.h" > ''')) > - self._btin = '\n' + guardstart('QAPI_TYPES_BUILTIN') > + > + def _module_basename(self, name): > + if name is None: > + return 'qapi-builtin-types' > + return self._prefix + 'qapi-types' > + > + def _add_module(self, name, blurb): > + genc = QAPIGenC(blurb, __doc__) > + genh = QAPIGenH(blurb, __doc__) > + self._module[name] = (genc, genh) > + self._set_module(name) > + > + def _set_module(self, name): > + self._genc, self._genh = self._module[name] > > def write(self, output_dir): > - self._genc.write(output_dir, self._prefix + 'qapi-types.c') > - self._genh.write(output_dir, self._prefix + 'qapi-types.h') > + for name in self._module: > + if name is None and not self._opt_builtins: > + continue > + basename = self._module_basename(name) > + (genc, genh) = self._module[name] > + genc.write(output_dir, basename + '.c') > + genh.write(output_dir, basename + '.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 visit_end(self): > - # To avoid header dependency hell, we always generate > - # declarations for built-in types in our header files and > - # simply guard them. See also opt_builtins (command line > - # option -b). > - self._btin += guardend('QAPI_TYPES_BUILTIN') > - self._genh.preamble(self._btin) > - self._btin = None > + def visit_module(self, name): > + if len(self._module) != 1: > + return > + self._add_module(name, ' * Schema-defined QAPI types') > + self._genc.preamble(mcgen(''' > +#include "qemu/osdep.h" > +#include "qapi/dealloc-visitor.h" > +#include "%(prefix)sqapi-types.h" > +#include "%(prefix)sqapi-visit.h" > +''', > + prefix=self._prefix)) > + self._genh.preamble(mcgen(''' > +#include "qapi-builtin-types.h" > +''')) > > def _gen_type_cleanup(self, name): > self._genh.body(gen_type_cleanup_decl(name)) > self._genc.body(gen_type_cleanup(name)) > > def visit_enum_type(self, name, info, values, prefix): > - # Special case for our lone builtin enum type > - # TODO use something cleaner than existence of info > - if not info: > - self._btin += gen_enum(name, values, prefix) > - if self._opt_builtins: > - self._genc.body(gen_enum_lookup(name, values, prefix)) > - else: > - self._genh.preamble(gen_enum(name, values, prefix)) > - self._genc.body(gen_enum_lookup(name, values, prefix)) > + self._genh.preamble(gen_enum(name, values, prefix)) > + self._genc.body(gen_enum_lookup(name, values, prefix)) > > def visit_array_type(self, name, info, element_type): > - if isinstance(element_type, QAPISchemaBuiltinType): > - self._btin += gen_fwd_object_or_array(name) > - self._btin += gen_array(name, element_type) > - self._btin += gen_type_cleanup_decl(name) > - if self._opt_builtins: > - self._genc.body(gen_type_cleanup(name)) > - else: > - self._genh.preamble(gen_fwd_object_or_array(name)) > - self._genh.body(gen_array(name, element_type)) > - self._gen_type_cleanup(name) > + self._genh.preamble(gen_fwd_object_or_array(name)) > + self._genh.body(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 > diff --git a/scripts/qapi/visit.py b/scripts/qapi/visit.py > index ee1a849574..f23e71bb9a 100644 > --- a/scripts/qapi/visit.py > +++ b/scripts/qapi/visit.py > @@ -267,58 +267,68 @@ class QAPISchemaGenVisitVisitor(QAPISchemaVisitor): > def __init__(self, opt_builtins, prefix): > self._opt_builtins = opt_builtins > self._prefix = prefix > - blurb = ' * Schema-defined QAPI visitors' > - self._genc = QAPIGenC(blurb, __doc__) > - self._genh = QAPIGenH(blurb, __doc__) > + self._module = {} > + self._add_module(None, ' * Built-in QAPI visitors') > self._genc.preamble(mcgen(''' > #include "qemu/osdep.h" > #include "qemu-common.h" > #include "qapi/error.h" > -#include "%(prefix)sqapi-visit.h" > -''', > - prefix=prefix)) > +#include "qapi-builtin-visit.h" > +''')) > self._genh.preamble(mcgen(''' > #include "qapi/visitor.h" > #include "qapi/qmp/qerror.h" > -#include "%(prefix)sqapi-types.h" > +#include "qapi-builtin-types.h" > ''', > - prefix=prefix)) > - self._btin = guardstart('QAPI_VISIT_BUILTIN') > + prefix=prefix)) > + > + def _module_basename(self, name): > + if name is None: > + return 'qapi-builtin-visit' > + return self._prefix + 'qapi-visit' > + > + def _add_module(self, name, blurb): > + genc = QAPIGenC(blurb, __doc__) > + genh = QAPIGenH(blurb, __doc__) > + self._module[name] = (genc, genh) > + self._set_module(name) > + > + def _set_module(self, name): > + self._genc, self._genh = self._module[name] > > def write(self, output_dir): > - self._genc.write(output_dir, self._prefix + 'qapi-visit.c') > - self._genh.write(output_dir, self._prefix + 'qapi-visit.h') > + for name in self._module: > + if name is None and not self._opt_builtins: > + continue > + basename = self._module_basename(name) > + (genc, genh) = self._module[name] > + genc.write(output_dir, basename + '.c') > + genh.write(output_dir, basename + '.h') > > - def visit_end(self): > - # To avoid header dependency hell, we always generate > - # declarations for built-in types in our header files and > - # simply guard them. See also opt_builtins (command line > - # option -b). > - self._btin += guardend('QAPI_VISIT_BUILTIN') > - self._genh.preamble(self._btin) > - self._btin = None > + def visit_module(self, name): > + if len(self._module) != 1: > + return > + self._add_module(name, ' * Schema-defined QAPI visitors') > + self._genc.preamble(mcgen(''' > +#include "qemu/osdep.h" > +#include "qemu-common.h" > +#include "qapi/error.h" > +#include "%(prefix)sqapi-visit.h" > +''', > + prefix=self._prefix)) > + self._genh.preamble(mcgen(''' > +#include "qapi-builtin-visit.h" > +#include "%(prefix)sqapi-types.h" > +''', > + prefix=self._prefix)) > > def visit_enum_type(self, name, info, values, prefix): > - # Special case for our lone builtin enum type > - # TODO use something cleaner than existence of info > - if not info: > - self._btin += gen_visit_decl(name, scalar=True) > - if self._opt_builtins: > - self._genc.body(gen_visit_enum(name)) > - else: > - self._genh.body(gen_visit_decl(name, scalar=True)) > - self._genc.body(gen_visit_enum(name)) > + self._genh.body(gen_visit_decl(name, scalar=True)) > + self._genc.body(gen_visit_enum(name)) > > def visit_array_type(self, name, info, element_type): > - decl = gen_visit_decl(name) > - defn = gen_visit_list(name, element_type) > - if isinstance(element_type, QAPISchemaBuiltinType): > - self._btin += decl > - if self._opt_builtins: > - self._genc.body(defn) > - else: > - self._genh.body(decl) > - self._genc.body(defn) > + self._genh.body(gen_visit_decl(name)) > + self._genc.body(gen_visit_list(name, element_type)) > > def visit_object_type(self, name, info, base, members, variants): > # Nothing to do for the special empty builtin > -- > 2.13.6 >
On 02/02/2018 07:03 AM, Markus Armbruster wrote: > Linking code from multiple separate QAPI schemata into the same > program is possible, but involves some weirdness around built-in > types: > > * We generate code for built-in types into .c only with option > --builtins. The user is responsible to generate code for exactly > one QAPI schema per program with --builtins. > > * We generate code for them it into .h regardless of --builtins, s/them it/them/ > guarded by #ifndef QAPI_VISIT_BUILTIN. Because the code for > built-in types is exactly the same in all of them, including any > combination of these headers works. > > Replace this contraption by something more conventional: generate code > for built-in types into their very own files: qapi-builtin-types.c, > qapi-builtin-visit.c, qapi-builtin-types.h, qapi-builtin-visit.h, but > only with --builtins. Obey --output-dir, but ignore --prefix for > them. > > Make qapi-types.h include qapi-builtin-types.h. With multiple > schemata you now have multiple qapi-types.[ch], but only one > qapi-builtin-types.[ch]. Same for qapi-visit.[ch] and > qapi-builtin-visit.[ch]. > > Bonus: if all you need is built-in stuff, you can include a much > smaller header. To be exploited shortly. > > Signed-off-by: Markus Armbruster <armbru@redhat.com> > ---
diff --git a/Makefile b/Makefile index e02f0c13ef..f9b7900330 100644 --- a/Makefile +++ b/Makefile @@ -88,10 +88,13 @@ endif include $(SRC_PATH)/rules.mak GENERATED_FILES = qemu-version.h config-host.h qemu-options.def -GENERATED_FILES += qmp-commands.h qapi-types.h qapi-visit.h qapi-event.h -GENERATED_FILES += qmp-marshal.c qapi-types.c qapi-visit.c qapi-event.c -GENERATED_FILES += qmp-introspect.h -GENERATED_FILES += qmp-introspect.c +GENERATED_FILES += qmp-commands.h qmp-marshal.c +GENERATED_FILES += qapi-builtin-types.h qapi-builtin-types.c +GENERATED_FILES += qapi-types.h qapi-types.c +GENERATED_FILES += qapi-builtin-visit.h qapi-builtin-visit.c +GENERATED_FILES += qapi-visit.h qapi-visit.c +GENERATED_FILES += qapi-event.h qapi-event.c +GENERATED_FILES += qmp-introspect.c qmp-introspect.h GENERATED_FILES += qapi.texi GENERATED_FILES += trace/generated-tcg-tracers.h @@ -514,7 +517,9 @@ qapi-modules = $(SRC_PATH)/qapi-schema.json $(SRC_PATH)/qapi/common.json \ $(SRC_PATH)/qapi/transaction.json \ $(SRC_PATH)/qapi/ui.json +qapi-builtin-types.c qapi-builtin-types.h \ qapi-types.c qapi-types.h \ +qapi-builtin-visit.c qapi-builtin-visit.h \ qapi-visit.c qapi-visit.h \ qmp-commands.h qmp-marshal.c \ qapi-event.c qapi-event.h \ diff --git a/Makefile.objs b/Makefile.objs index 323ef12384..f16cca06e7 100644 --- a/Makefile.objs +++ b/Makefile.objs @@ -2,6 +2,7 @@ # Common libraries for tools and emulators stub-obj-y = stubs/ crypto/ util-obj-y = util/ qobject/ qapi/ +util-obj-y += qapi-builtin-types.o qapi-builtin-visit.o util-obj-y += qmp-introspect.o qapi-types.o qapi-visit.o qapi-event.o chardev-obj-y = chardev/ diff --git a/scripts/qapi/common.py b/scripts/qapi/common.py index f4e9ebbb53..7ffffc78d9 100644 --- a/scripts/qapi/common.py +++ b/scripts/qapi/common.py @@ -1527,11 +1527,10 @@ class QAPISchema(object): def _def_builtin_type(self, name, json_type, c_type): self._def_entity(QAPISchemaBuiltinType(name, json_type, c_type)) - # TODO As long as we have QAPI_TYPES_BUILTIN to share multiple - # qapi-types.h from a single .c, all arrays of builtins must be - # declared in the first file whether or not they are used. Nicer - # would be to use lazy instantiation, while figuring out how to - # avoid compilation issues with multiple qapi-types.h. + # Instantiating only the arrays that are actually used would + # be nice, but we can't as long as their generated code + # (qapi-builtin-types.[ch]) may be shared by some other + # schema. self._make_array_type(name, None) def _def_predefineds(self): @@ -1985,14 +1984,15 @@ class QAPIGen(object): return '' def write(self, output_dir, fname): - if output_dir: + pathname = os.path.join(output_dir, fname) + dir = os.path.dirname(pathname) + if dir: try: - os.makedirs(output_dir) + os.makedirs(dir) except os.error as e: if e.errno != errno.EEXIST: raise - fd = os.open(os.path.join(output_dir, fname), - os.O_RDWR | os.O_CREAT, 0666) + fd = os.open(pathname, os.O_RDWR | os.O_CREAT, 0666) f = os.fdopen(fd, 'r+') text = (self.top(fname) + self._preamble + self._body + self.bottom(fname)) diff --git a/scripts/qapi/types.py b/scripts/qapi/types.py index eeffcbf32c..f84ed17960 100644 --- a/scripts/qapi/types.py +++ b/scripts/qapi/types.py @@ -171,64 +171,72 @@ class QAPISchemaGenTypeVisitor(QAPISchemaVisitor): def __init__(self, opt_builtins, prefix): self._opt_builtins = opt_builtins self._prefix = prefix - blurb = ' * Schema-defined QAPI types' - self._genc = QAPIGenC(blurb, __doc__) - self._genh = QAPIGenH(blurb, __doc__) + self._module = {} + self._add_module(None, ' * Built-in QAPI types') self._genc.preamble(mcgen(''' #include "qemu/osdep.h" #include "qapi/dealloc-visitor.h" -#include "%(prefix)sqapi-types.h" -#include "%(prefix)sqapi-visit.h" -''', - prefix=prefix)) +#include "qapi-builtin-types.h" +#include "qapi-builtin-visit.h" +''')) self._genh.preamble(mcgen(''' #include "qapi/util.h" ''')) - self._btin = '\n' + guardstart('QAPI_TYPES_BUILTIN') + + def _module_basename(self, name): + if name is None: + return 'qapi-builtin-types' + return self._prefix + 'qapi-types' + + def _add_module(self, name, blurb): + genc = QAPIGenC(blurb, __doc__) + genh = QAPIGenH(blurb, __doc__) + self._module[name] = (genc, genh) + self._set_module(name) + + def _set_module(self, name): + self._genc, self._genh = self._module[name] def write(self, output_dir): - self._genc.write(output_dir, self._prefix + 'qapi-types.c') - self._genh.write(output_dir, self._prefix + 'qapi-types.h') + for name in self._module: + if name is None and not self._opt_builtins: + continue + basename = self._module_basename(name) + (genc, genh) = self._module[name] + genc.write(output_dir, basename + '.c') + genh.write(output_dir, basename + '.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 visit_end(self): - # To avoid header dependency hell, we always generate - # declarations for built-in types in our header files and - # simply guard them. See also opt_builtins (command line - # option -b). - self._btin += guardend('QAPI_TYPES_BUILTIN') - self._genh.preamble(self._btin) - self._btin = None + def visit_module(self, name): + if len(self._module) != 1: + return + self._add_module(name, ' * Schema-defined QAPI types') + self._genc.preamble(mcgen(''' +#include "qemu/osdep.h" +#include "qapi/dealloc-visitor.h" +#include "%(prefix)sqapi-types.h" +#include "%(prefix)sqapi-visit.h" +''', + prefix=self._prefix)) + self._genh.preamble(mcgen(''' +#include "qapi-builtin-types.h" +''')) def _gen_type_cleanup(self, name): self._genh.body(gen_type_cleanup_decl(name)) self._genc.body(gen_type_cleanup(name)) def visit_enum_type(self, name, info, values, prefix): - # Special case for our lone builtin enum type - # TODO use something cleaner than existence of info - if not info: - self._btin += gen_enum(name, values, prefix) - if self._opt_builtins: - self._genc.body(gen_enum_lookup(name, values, prefix)) - else: - self._genh.preamble(gen_enum(name, values, prefix)) - self._genc.body(gen_enum_lookup(name, values, prefix)) + self._genh.preamble(gen_enum(name, values, prefix)) + self._genc.body(gen_enum_lookup(name, values, prefix)) def visit_array_type(self, name, info, element_type): - if isinstance(element_type, QAPISchemaBuiltinType): - self._btin += gen_fwd_object_or_array(name) - self._btin += gen_array(name, element_type) - self._btin += gen_type_cleanup_decl(name) - if self._opt_builtins: - self._genc.body(gen_type_cleanup(name)) - else: - self._genh.preamble(gen_fwd_object_or_array(name)) - self._genh.body(gen_array(name, element_type)) - self._gen_type_cleanup(name) + self._genh.preamble(gen_fwd_object_or_array(name)) + self._genh.body(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 diff --git a/scripts/qapi/visit.py b/scripts/qapi/visit.py index ee1a849574..f23e71bb9a 100644 --- a/scripts/qapi/visit.py +++ b/scripts/qapi/visit.py @@ -267,58 +267,68 @@ class QAPISchemaGenVisitVisitor(QAPISchemaVisitor): def __init__(self, opt_builtins, prefix): self._opt_builtins = opt_builtins self._prefix = prefix - blurb = ' * Schema-defined QAPI visitors' - self._genc = QAPIGenC(blurb, __doc__) - self._genh = QAPIGenH(blurb, __doc__) + self._module = {} + self._add_module(None, ' * Built-in QAPI visitors') self._genc.preamble(mcgen(''' #include "qemu/osdep.h" #include "qemu-common.h" #include "qapi/error.h" -#include "%(prefix)sqapi-visit.h" -''', - prefix=prefix)) +#include "qapi-builtin-visit.h" +''')) self._genh.preamble(mcgen(''' #include "qapi/visitor.h" #include "qapi/qmp/qerror.h" -#include "%(prefix)sqapi-types.h" +#include "qapi-builtin-types.h" ''', - prefix=prefix)) - self._btin = guardstart('QAPI_VISIT_BUILTIN') + prefix=prefix)) + + def _module_basename(self, name): + if name is None: + return 'qapi-builtin-visit' + return self._prefix + 'qapi-visit' + + def _add_module(self, name, blurb): + genc = QAPIGenC(blurb, __doc__) + genh = QAPIGenH(blurb, __doc__) + self._module[name] = (genc, genh) + self._set_module(name) + + def _set_module(self, name): + self._genc, self._genh = self._module[name] def write(self, output_dir): - self._genc.write(output_dir, self._prefix + 'qapi-visit.c') - self._genh.write(output_dir, self._prefix + 'qapi-visit.h') + for name in self._module: + if name is None and not self._opt_builtins: + continue + basename = self._module_basename(name) + (genc, genh) = self._module[name] + genc.write(output_dir, basename + '.c') + genh.write(output_dir, basename + '.h') - def visit_end(self): - # To avoid header dependency hell, we always generate - # declarations for built-in types in our header files and - # simply guard them. See also opt_builtins (command line - # option -b). - self._btin += guardend('QAPI_VISIT_BUILTIN') - self._genh.preamble(self._btin) - self._btin = None + def visit_module(self, name): + if len(self._module) != 1: + return + self._add_module(name, ' * Schema-defined QAPI visitors') + self._genc.preamble(mcgen(''' +#include "qemu/osdep.h" +#include "qemu-common.h" +#include "qapi/error.h" +#include "%(prefix)sqapi-visit.h" +''', + prefix=self._prefix)) + self._genh.preamble(mcgen(''' +#include "qapi-builtin-visit.h" +#include "%(prefix)sqapi-types.h" +''', + prefix=self._prefix)) def visit_enum_type(self, name, info, values, prefix): - # Special case for our lone builtin enum type - # TODO use something cleaner than existence of info - if not info: - self._btin += gen_visit_decl(name, scalar=True) - if self._opt_builtins: - self._genc.body(gen_visit_enum(name)) - else: - self._genh.body(gen_visit_decl(name, scalar=True)) - self._genc.body(gen_visit_enum(name)) + self._genh.body(gen_visit_decl(name, scalar=True)) + self._genc.body(gen_visit_enum(name)) def visit_array_type(self, name, info, element_type): - decl = gen_visit_decl(name) - defn = gen_visit_list(name, element_type) - if isinstance(element_type, QAPISchemaBuiltinType): - self._btin += decl - if self._opt_builtins: - self._genc.body(defn) - else: - self._genh.body(decl) - self._genc.body(defn) + self._genh.body(gen_visit_decl(name)) + self._genc.body(gen_visit_list(name, element_type)) def visit_object_type(self, name, info, base, members, variants): # Nothing to do for the special empty builtin
Linking code from multiple separate QAPI schemata into the same program is possible, but involves some weirdness around built-in types: * We generate code for built-in types into .c only with option --builtins. The user is responsible to generate code for exactly one QAPI schema per program with --builtins. * We generate code for them it into .h regardless of --builtins, guarded by #ifndef QAPI_VISIT_BUILTIN. Because the code for built-in types is exactly the same in all of them, including any combination of these headers works. Replace this contraption by something more conventional: generate code for built-in types into their very own files: qapi-builtin-types.c, qapi-builtin-visit.c, qapi-builtin-types.h, qapi-builtin-visit.h, but only with --builtins. Obey --output-dir, but ignore --prefix for them. Make qapi-types.h include qapi-builtin-types.h. With multiple schemata you now have multiple qapi-types.[ch], but only one qapi-builtin-types.[ch]. Same for qapi-visit.[ch] and qapi-builtin-visit.[ch]. Bonus: if all you need is built-in stuff, you can include a much smaller header. To be exploited shortly. Signed-off-by: Markus Armbruster <armbru@redhat.com> --- Makefile | 13 +++++--- Makefile.objs | 1 + scripts/qapi/common.py | 18 +++++------ scripts/qapi/types.py | 82 ++++++++++++++++++++++++++---------------------- scripts/qapi/visit.py | 84 ++++++++++++++++++++++++++++---------------------- 5 files changed, 111 insertions(+), 87 deletions(-)