Skip to contentSkip to conversation

qapi: Add detection for the 'savevm' fix for blockdev

PATCH Superseded Peter Krempa 4 participants 15 messages Sep 20, 2019 – Oct 11, 2019

v2 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

v2 cover qapi: Add detection for the 'savevm' fix for blockdev

Add 'features' field in the schema for commands and add a feature flag to advertise that the fix for savevm [1] is present.

[1] https://lists.gnu.org/archive/html/qemu-devel/2019-09/msg03487.html

v2:
- fixed typos pointed out by Eric
- added 'since' tag
- reworded to describe the fix this allows to detect properly (Kevin)
- verified that this can be rebased on top of Markus' series automatically

Peter Krempa (2):
qapi: Add feature flags to commands in qapi introspection
qapi: Allow introspecting fix for savevm's cooperation with blockdev

 docs/devel/qapi-code-gen.txt   |  4 ++--
 qapi/introspect.json           |  6 ++++-
 qapi/misc.json                 |  9 +++++++-
 scripts/qapi/commands.py       |  3 ++-
 scripts/qapi/common.py         | 40 +++++++++++++++++++++++++++++-----
 scripts/qapi/doc.py            |  3 ++-
 scripts/qapi/introspect.py     |  7 +++++-
 tests/qapi-schema/test-qapi.py |  7 +++++-
 8 files changed, 66 insertions(+), 13 deletions(-)
Signature · 1 line
2.21.0
#1 lore raw

PATCH v2 1/2 qapi: Add feature flags to commands in qapi introspection

Similarly to features for struct types introduce the feature flags also for commands. This will allow notifying management layers of fixes and compatible changes in the behaviour of a command which may not be detectable any other way.

The changes were heavily inspired by commit 6a8c0b51025.

---
 docs/devel/qapi-code-gen.txt   |  4 ++--
 qapi/introspect.json           |  6 ++++-
 scripts/qapi/commands.py       |  3 ++-
 scripts/qapi/common.py         | 40 +++++++++++++++++++++++++++++-----
 scripts/qapi/doc.py            |  3 ++-
 scripts/qapi/introspect.py     |  7 +++++-
 tests/qapi-schema/test-qapi.py |  7 +++++-
 7 files changed, 58 insertions(+), 12 deletions(-)
docs/devel/qapi-code-gen.txt +2 -2
index e8ec8ac1de..d465cc6330 100644
@@ -726,8 +726,8 @@ change in the QMP syntax (usually by allowing values or operations that
 previously resulted in an error). QMP clients may still need to know
 whether the extension is available.
 
-For this purpose, a list of features can be specified for a struct type.
-This is exposed to the client as a list of string, where each string
+For this purpose, a list of features can be specified for a command or struct
+type. This is exposed to the client as a list of strings, where each string
 signals that this build of QEMU shows a certain behaviour.
 
 In the schema, features can be specified as simple strings, for example:
qapi/introspect.json +5 -1
index 1843c1cb17..031a954fa9 100644
@@ -266,13 +266,17 @@
 # @allow-oob: whether the command allows out-of-band execution,
 #             defaults to false (Since: 2.12)
 #
+# @features: names of features associated with the command, in no particular
+#            order. (since 4.2)
+#
 # TODO: @success-response (currently irrelevant, because it's QGA, not QMP)
 #
 # Since: 2.5
 ##
 { 'struct': 'SchemaInfoCommand',
   'data': { 'arg-type': 'str', 'ret-type': 'str',
-            '*allow-oob': 'bool' } }
+            '*allow-oob': 'bool',
+            '*features': [ 'str' ] } }
 
 ##
 # @SchemaInfoEvent:
scripts/qapi/commands.py +2 -1
index b929e07be4..6cfe6cdd9e 100644
@@ -276,7 +276,8 @@ void %(c_prefix)sqmp_init_marshal(QmpCommandList *cmds);
         genc.add(gen_registry(self._regy.get_content(), self._prefix))
 
     def visit_command(self, name, info, ifcond, arg_type, ret_type, gen,
-                      success_response, boxed, allow_oob, allow_preconfig):
+                      success_response, boxed, allow_oob, allow_preconfig,
+                      features):
         if not gen:
             return
         # FIXME: If T is a user-defined type, the user is responsible
scripts/qapi/common.py +35 -5
index d61bfdc526..1502820f46 100644
@@ -838,6 +838,7 @@ def check_type(info, source, value, allow_array=False,
 def check_command(expr, info):
     name = expr['command']
     boxed = expr.get('boxed', False)
+    features = expr.get('features')
 
     args_meta = ['struct']
     if boxed:
@@ -852,6 +853,19 @@ def check_command(expr, info):
                expr.get('returns'), allow_array=True,
                allow_optional=True, allow_metas=returns_meta)
 
+    if features:
+        if not isinstance(features, list):
+            raise QAPISemError(info,
+                               "Command '%s' requires an array for 'features'" %
+                               name)
+        for f in features:
+            assert isinstance(f, dict)
+            check_known_keys(info, "feature of command %s" % name, f,
+                             ['name'], ['if'])
+
+            check_if(f, info)
+            check_name(info, "Feature of command %s" % name, f['name'])
+
 
 def check_event(expr, info):
     name = expr['event']
@@ -1138,8 +1152,10 @@ def check_exprs(exprs):
             meta = 'command'
             check_keys(expr_elem, 'command', [],
                        ['data', 'returns', 'gen', 'success-response',
-                        'boxed', 'allow-oob', 'allow-preconfig', 'if'])
+                        'boxed', 'allow-oob', 'allow-preconfig', 'if',
+                        'features'])
             normalize_members(expr.get('data'))
+            normalize_features(expr.get('features'))
         elif 'event' in expr:
             meta = 'event'
             check_keys(expr_elem, 'event', [], ['data', 'boxed', 'if'])
@@ -1283,7 +1299,8 @@ class QAPISchemaVisitor(object):
         pass
 
     def visit_command(self, name, info, ifcond, arg_type, ret_type, gen,
-                      success_response, boxed, allow_oob, allow_preconfig):
+                      success_response, boxed, allow_oob, allow_preconfig,
+                      features):
         pass
 
     def visit_event(self, name, info, ifcond, arg_type, boxed):
@@ -1697,10 +1714,14 @@ class QAPISchemaAlternateType(QAPISchemaType):
 
 class QAPISchemaCommand(QAPISchemaEntity):
     def __init__(self, name, info, doc, ifcond, arg_type, ret_type,
-                 gen, success_response, boxed, allow_oob, allow_preconfig):
+                 gen, success_response, boxed, allow_oob, allow_preconfig,
+                 features):
         QAPISchemaEntity.__init__(self, name, info, doc, ifcond)
         assert not arg_type or isinstance(arg_type, str)
         assert not ret_type or isinstance(ret_type, str)
+        for f in features:
+            assert isinstance(f, QAPISchemaFeature)
+            f.set_owner(name)
         self._arg_type_name = arg_type
         self.arg_type = None
         self._ret_type_name = ret_type
@@ -1710,6 +1731,7 @@ class QAPISchemaCommand(QAPISchemaEntity):
         self.boxed = boxed
         self.allow_oob = allow_oob
         self.allow_preconfig = allow_preconfig
+        self.features = features
 
     def check(self, schema):
         QAPISchemaEntity.check(self, schema)
@@ -1731,12 +1753,18 @@ class QAPISchemaCommand(QAPISchemaEntity):
             self.ret_type = schema.lookup_type(self._ret_type_name)
             assert isinstance(self.ret_type, QAPISchemaType)
 
+        # Features are in a name space separate from members
+        seen = {}
+        for f in self.features:
+            f.check_clash(self.info, seen)
+
     def visit(self, visitor):
         visitor.visit_command(self.name, self.info, self.ifcond,
                               self.arg_type, self.ret_type,
                               self.gen, self.success_response,
                               self.boxed, self.allow_oob,
-                              self.allow_preconfig)
+                              self.allow_preconfig,
+                              self.features)
 
 
 class QAPISchemaEvent(QAPISchemaEntity):
@@ -1989,6 +2017,7 @@ class QAPISchema(object):
         allow_oob = expr.get('allow-oob', False)
         allow_preconfig = expr.get('allow-preconfig', False)
         ifcond = expr.get('if')
+        features = expr.get('features', [])
         if isinstance(data, OrderedDict):
             data = self._make_implicit_object_type(
                 name, info, doc, ifcond, 'arg', self._make_members(data, info))
@@ -1997,7 +2026,8 @@ class QAPISchema(object):
             rets = self._make_array_type(rets[0], info)
         self._def_entity(QAPISchemaCommand(name, info, doc, ifcond, data, rets,
                                            gen, success_response,
-                                           boxed, allow_oob, allow_preconfig))
+                                           boxed, allow_oob, allow_preconfig,
+                                           self._make_features(features)))
 
     def _def_event(self, expr, info, doc):
         name = expr['event']
scripts/qapi/doc.py +2 -1
index 5fc0fc7e06..aa4c557244 100755
@@ -249,7 +249,8 @@ class QAPISchemaGenDocVisitor(qapi.common.QAPISchemaVisitor):
                                body=texi_entity(doc, 'Members', ifcond)))
 
     def visit_command(self, name, info, ifcond, arg_type, ret_type, gen,
-                      success_response, boxed, allow_oob, allow_preconfig):
+                      success_response, boxed, allow_oob, allow_preconfig,
+                      features):
         doc = self.cur_doc
         if boxed:
             body = texi_body(doc)
scripts/qapi/introspect.py +6 -1
index f62cf0a2e1..36a5b195e5 100644
@@ -206,13 +206,18 @@ const QLitObject %(c_name)s = %(c_string)s;
                            for m in variants.variants]}, ifcond)
 
     def visit_command(self, name, info, ifcond, arg_type, ret_type, gen,
-                      success_response, boxed, allow_oob, allow_preconfig):
+                      success_response, boxed, allow_oob, allow_preconfig,
+                      features):
         arg_type = arg_type or self._schema.the_empty_object_type
         ret_type = ret_type or self._schema.the_empty_object_type
         obj = {'arg-type': self._use_type(arg_type),
                'ret-type': self._use_type(ret_type)}
         if allow_oob:
             obj['allow-oob'] = allow_oob
+
+        if features:
+            obj['features'] = [(f.name, {'if': f.ifcond}) for f in features]
+
         self._gen_qlit(name, 'command', obj, ifcond)
 
     def visit_event(self, name, info, ifcond, arg_type, boxed):
tests/qapi-schema/test-qapi.py +6 -1
index b0f770b9bd..def34aa489 100644
@@ -60,13 +60,18 @@ class QAPISchemaTestVisitor(QAPISchemaVisitor):
         self._print_if(ifcond)
 
     def visit_command(self, name, info, ifcond, arg_type, ret_type, gen,
-                      success_response, boxed, allow_oob, allow_preconfig):
+                      success_response, boxed, allow_oob, allow_preconfig,
+                      features):
         print('command %s %s -> %s'
               % (name, arg_type and arg_type.name,
                  ret_type and ret_type.name))
         print('   gen=%s success_response=%s boxed=%s oob=%s preconfig=%s'
               % (gen, success_response, boxed, allow_oob, allow_preconfig))
         self._print_if(ifcond)
+        if features:
+            for f in features:
+                print('    feature %s' % f.name)
+                self._print_if(f.ifcond, 8)
 
     def visit_event(self, name, info, ifcond, arg_type, boxed):
         print('event %s %s' % (name, arg_type and arg_type.name))
Signature · 1 line
2.21.0
#2 lore raw

Re: [PATCH v2 1/2] qapi: Add feature flags to commands in qapi introspection

Quoted 8 lines · Peter Krempa

Similarly to features for struct types introduce the feature flags also for commands. This will allow notifying management layers of fixes and compatible changes in the behaviour of a command which may not be detectable any other way.

The changes were heavily inspired by commit 6a8c0b51025.

+1 on adding features to commands.

Patch conflicts with the technical debt payback work I posted before and after this series, although not nearly as badly as I expected. It'll conflict some more with the parts I haven't flushed. The funny bit: I went on that rampage in preparation of QAPI language extensions including "features everywhere, not just structs".

I'll look into how to best fit your work into mine.

#3 lore raw

Re: [PATCH v2 1/2] qapi: Add feature flags to commands in qapi introspection

Quoted 13 lines · Markus Armbruster
Quoted 8 lines · Peter Krempa

Similarly to features for struct types introduce the feature flags also for commands. This will allow notifying management layers of fixes and compatible changes in the behaviour of a command which may not be detectable any other way.

The changes were heavily inspired by commit 6a8c0b51025.

+1 on adding features to commands.

Quoted 7 lines

Patch conflicts with the technical debt payback work I posted before and after this series, although not nearly as badly as I expected. It'll conflict some more with the parts I haven't flushed. The funny bit: I went on that rampage in preparation of QAPI language extensions including "features everywhere, not just structs".

I'll look into how to best fit your work into mine.

Thanks. I have patches ready which depend on this to enable blockdev so please let me know if the design changes somehow.

#4 lore raw

Re: [PATCH v2 1/2] qapi: Add feature flags to commands in qapi introspection

In reply to Peter Krempa
Quoted 23 lines · Peter Krempa

Similarly to features for struct types introduce the feature flags also for commands. This will allow notifying management layers of fixes and compatible changes in the behaviour of a command which may not be detectable any other way.

The changes were heavily inspired by commit 6a8c0b51025.

---
 docs/devel/qapi-code-gen.txt   |  4 ++--
 qapi/introspect.json           |  6 ++++-
 scripts/qapi/commands.py       |  3 ++-
 scripts/qapi/common.py         | 40 +++++++++++++++++++++++++++++-----
 scripts/qapi/doc.py            |  3 ++-
 scripts/qapi/introspect.py     |  7 +++++-
 tests/qapi-schema/test-qapi.py |  7 +++++-
 7 files changed, 58 insertions(+), 12 deletions(-)
docs/devel/qapi-code-gen.txt +0 -0
index e8ec8ac1de..d465cc6330 100644

docs/devel/qapi-code-gen.txt change in the QMP syntax (usually by allowing values or operations that · line 731

Quoted 8 lines
docs/devel/qapi-code-gen.txt +2 -2
@@ -726,8 +726,8 @@ change in the QMP syntax (usually by allowing values or operations that
 previously resulted in an error). QMP clients may still need to know
 whether the extension is available.
 
-For this purpose, a list of features can be specified for a struct type.
-This is exposed to the client as a list of string, where each string
+For this purpose, a list of features can be specified for a command or struct
+type. This is exposed to the client as a list of strings, where each string
 signals that this build of QEMU shows a certain behaviour.

Limit line length to 70 characters, and double space after sentence-ending period, please.

scripts/qapi/common.py

Quoted 43 lines
docs/devel/qapi-code-gen.txt +0 -0
 In the schema, features can be specified as simple strings, for example:
qapi/introspect.json +5 -1
index 1843c1cb17..031a954fa9 100644
@@ -266,13 +266,17 @@
 # @allow-oob: whether the command allows out-of-band execution,
 #             defaults to false (Since: 2.12)
 #
+# @features: names of features associated with the command, in no particular
+#            order. (since 4.2)
+#
 # TODO: @success-response (currently irrelevant, because it's QGA, not QMP)
 #
 # Since: 2.5
 ##
 { 'struct': 'SchemaInfoCommand',
   'data': { 'arg-type': 'str', 'ret-type': 'str',
-            '*allow-oob': 'bool' } }
+            '*allow-oob': 'bool',
+            '*features': [ 'str' ] } }
 
 ##
 # @SchemaInfoEvent:
scripts/qapi/commands.py +2 -1
index b929e07be4..6cfe6cdd9e 100644
@@ -276,7 +276,8 @@ void %(c_prefix)sqmp_init_marshal(QmpCommandList *cmds);
         genc.add(gen_registry(self._regy.get_content(), self._prefix))
 
     def visit_command(self, name, info, ifcond, arg_type, ret_type, gen,
-                      success_response, boxed, allow_oob, allow_preconfig):
+                      success_response, boxed, allow_oob, allow_preconfig,
+                      features):
         if not gen:
             return
         # FIXME: If T is a user-defined type, the user is responsible
scripts/qapi/common.py +0 -0
index d61bfdc526..1502820f46 100644

Conflicts with my "[PATCH 6/7] qapi: Split up scripts/qapi/common.py" and also with work that has already landed in master. Untested rebase appended for your convenience.

Quoted 15 lines
scripts/qapi/common.py +4 -0
@@ -838,6 +838,7 @@ def check_type(info, source, value, allow_array=False,
 def check_command(expr, info):
     name = expr['command']
     boxed = expr.get('boxed', False)
+    features = expr.get('features')
 
     args_meta = ['struct']
     if boxed:
@@ -852,6 +853,19 @@ def check_command(expr, info):
                expr.get('returns'), allow_array=True,
                allow_optional=True, allow_metas=returns_meta)
 
+    if features:
+        if not isinstance(features, list):
+            raise QAPISemError(info,

scripts/qapi/common.py def check_command(expr, info): · line 868

Quoted 10 lines
scripts/qapi/common.py +10 -0
+                               "Command '%s' requires an array for 'features'" %
+                               name)
+        for f in features:
+            assert isinstance(f, dict)
+            check_known_keys(info, "feature of command %s" % name, f,
+                             ['name'], ['if'])
+
+            check_if(f, info)
+            check_name(info, "Feature of command %s" % name, f['name'])
+

Copied from check_struct() with minor edits.

Conflicts semantically with commit eeb57c85da "qapi: Avoid redundant definition references in error messages", which changes the code you copy in a way that makes editing it superfluous. Please factor it into a helper function check_features(features, info).

Quoted 28 lines
scripts/qapi/common.py +5 -2
 def check_event(expr, info):
     name = expr['event']
@@ -1138,8 +1152,10 @@ def check_exprs(exprs):
             meta = 'command'
             check_keys(expr_elem, 'command', [],
                        ['data', 'returns', 'gen', 'success-response',
-                        'boxed', 'allow-oob', 'allow-preconfig', 'if'])
+                        'boxed', 'allow-oob', 'allow-preconfig', 'if',
+                        'features'])
             normalize_members(expr.get('data'))
+            normalize_features(expr.get('features'))
         elif 'event' in expr:
             meta = 'event'
             check_keys(expr_elem, 'event', [], ['data', 'boxed', 'if'])
@@ -1283,7 +1299,8 @@ class QAPISchemaVisitor(object):
         pass
 
     def visit_command(self, name, info, ifcond, arg_type, ret_type, gen,
-                      success_response, boxed, allow_oob, allow_preconfig):
+                      success_response, boxed, allow_oob, allow_preconfig,
+                      features):
         pass
 
     def visit_event(self, name, info, ifcond, arg_type, boxed):
@@ -1697,10 +1714,14 @@ class QAPISchemaAlternateType(QAPISchemaType):
 
 class QAPISchemaCommand(QAPISchemaEntity):

scripts/qapi/common.py class QAPISchemaAlternateType(QAPISchemaType): · line 1724

Quoted 10 lines
scripts/qapi/common.py +5 -1
     def __init__(self, name, info, doc, ifcond, arg_type, ret_type,
-                 gen, success_response, boxed, allow_oob, allow_preconfig):
+                 gen, success_response, boxed, allow_oob, allow_preconfig,
+                 features):
         QAPISchemaEntity.__init__(self, name, info, doc, ifcond)
         assert not arg_type or isinstance(arg_type, str)
         assert not ret_type or isinstance(ret_type, str)
+        for f in features:
+            assert isinstance(f, QAPISchemaFeature)
+            f.set_owner(name)

Copied from QAPISchemaObjectType.__init__(). Acceptable for now.

Quoted 12 lines
scripts/qapi/common.py +1 -0
         self._arg_type_name = arg_type
         self.arg_type = None
         self._ret_type_name = ret_type
@@ -1710,6 +1731,7 @@ class QAPISchemaCommand(QAPISchemaEntity):
         self.boxed = boxed
         self.allow_oob = allow_oob
         self.allow_preconfig = allow_preconfig
+        self.features = features
 
     def check(self, schema):
         QAPISchemaEntity.check(self, schema)

scripts/qapi/common.py class QAPISchemaCommand(QAPISchemaEntity): · line 1760

Quoted 8 lines
scripts/qapi/common.py +5 -0
@@ -1731,12 +1753,18 @@ class QAPISchemaCommand(QAPISchemaEntity):
             self.ret_type = schema.lookup_type(self._ret_type_name)
             assert isinstance(self.ret_type, QAPISchemaType)
 
+        # Features are in a name space separate from members
+        seen = {}
+        for f in self.features:
+            f.check_clash(self.info, seen)
+

Copied from QAPISchemaObjectType.check(). Acceptable for now.

Quoted 54 lines
scripts/qapi/common.py +5 -2
     def visit(self, visitor):
         visitor.visit_command(self.name, self.info, self.ifcond,
                               self.arg_type, self.ret_type,
                               self.gen, self.success_response,
                               self.boxed, self.allow_oob,
-                              self.allow_preconfig)
+                              self.allow_preconfig,
+                              self.features)
 
 
 class QAPISchemaEvent(QAPISchemaEntity):
@@ -1989,6 +2017,7 @@ class QAPISchema(object):
         allow_oob = expr.get('allow-oob', False)
         allow_preconfig = expr.get('allow-preconfig', False)
         ifcond = expr.get('if')
+        features = expr.get('features', [])
         if isinstance(data, OrderedDict):
             data = self._make_implicit_object_type(
                 name, info, doc, ifcond, 'arg', self._make_members(data, info))
@@ -1997,7 +2026,8 @@ class QAPISchema(object):
             rets = self._make_array_type(rets[0], info)
         self._def_entity(QAPISchemaCommand(name, info, doc, ifcond, data, rets,
                                            gen, success_response,
-                                           boxed, allow_oob, allow_preconfig))
+                                           boxed, allow_oob, allow_preconfig,
+                                           self._make_features(features)))
 
     def _def_event(self, expr, info, doc):
         name = expr['event']
scripts/qapi/doc.py +2 -1
index 5fc0fc7e06..aa4c557244 100755
@@ -249,7 +249,8 @@ class QAPISchemaGenDocVisitor(qapi.common.QAPISchemaVisitor):
                                body=texi_entity(doc, 'Members', ifcond)))
 
     def visit_command(self, name, info, ifcond, arg_type, ret_type, gen,
-                      success_response, boxed, allow_oob, allow_preconfig):
+                      success_response, boxed, allow_oob, allow_preconfig,
+                      features):
         doc = self.cur_doc
         if boxed:
             body = texi_body(doc)
scripts/qapi/introspect.py +2 -1
index f62cf0a2e1..36a5b195e5 100644
@@ -206,13 +206,18 @@ const QLitObject %(c_name)s = %(c_string)s;
                            for m in variants.variants]}, ifcond)
 
     def visit_command(self, name, info, ifcond, arg_type, ret_type, gen,
-                      success_response, boxed, allow_oob, allow_preconfig):
+                      success_response, boxed, allow_oob, allow_preconfig,
+                      features):

scripts/qapi/introspect.py const QLitObject %(c_name)s = %(c_string)s; · line 220

Quoted 10 lines
scripts/qapi/introspect.py +4 -0
         arg_type = arg_type or self._schema.the_empty_object_type
         ret_type = ret_type or self._schema.the_empty_object_type
         obj = {'arg-type': self._use_type(arg_type),
                'ret-type': self._use_type(ret_type)}
         if allow_oob:
             obj['allow-oob'] = allow_oob
+
+        if features:
+            obj['features'] = [(f.name, {'if': f.ifcond}) for f in features]
+

Copied from visit_object_type_flat(). Acceptable for now.

Quoted 17 lines
scripts/qapi/introspect.py +0 -0
         self._gen_qlit(name, 'command', obj, ifcond)
 
     def visit_event(self, name, info, ifcond, arg_type, boxed):
tests/qapi-schema/test-qapi.py +2 -1
index b0f770b9bd..def34aa489 100644
@@ -60,13 +60,18 @@ class QAPISchemaTestVisitor(QAPISchemaVisitor):
         self._print_if(ifcond)
 
     def visit_command(self, name, info, ifcond, arg_type, ret_type, gen,
-                      success_response, boxed, allow_oob, allow_preconfig):
+                      success_response, boxed, allow_oob, allow_preconfig,
+                      features):
         print('command %s %s -> %s'
               % (name, arg_type and arg_type.name,
                  ret_type and ret_type.name))

tests/qapi-schema/test-qapi.py class QAPISchemaTestVisitor(QAPISchemaVisitor): · line 77

Quoted 10 lines
tests/qapi-schema/test-qapi.py +4 -0
         print('   gen=%s success_response=%s boxed=%s oob=%s preconfig=%s'
               % (gen, success_response, boxed, allow_oob, allow_preconfig))
         self._print_if(ifcond)
+        if features:
+            for f in features:
+                print('    feature %s' % f.name)
+                self._print_if(f.ifcond, 8)
 
     def visit_event(self, name, info, ifcond, arg_type, boxed):
         print('event %s %s' % (name, arg_type and arg_type.name))

Copied from visit_object_type(). Would you mind factoring it into a @staticmethod _print_features()?

No tests. Please add at least a positive test case to qapi-schema-test.json.

From c55b056497b79e922d0489cf2dfe4d2a5edb62c8 Mon Sep 17 00:00:00 2001
From: Markus Armbruster <[email protected]>
Date: Tue, 1 Oct 2019 20:47:04 +0200
Subject: [PATCH 1/2] qapi: Add feature flags to commands in qapi

Similarly to features for struct types introduce the feature flags also for commands. This will allow notifying management layers of fixes and compatible changes in the behaviour of a command which may not be detectable any other way.

The changes were heavily inspired by commit 6a8c0b51025.

---
 docs/devel/qapi-code-gen.txt   |  7 ++++---
 qapi/introspect.json           |  6 +++++-
 scripts/qapi/commands.py       |  3 ++-
 scripts/qapi/doc.py            |  3 ++-
 scripts/qapi/expr.py           | 17 ++++++++++++++++-
 scripts/qapi/introspect.py     |  7 ++++++-
 scripts/qapi/schema.py         | 22 ++++++++++++++++++----
 tests/qapi-schema/test-qapi.py |  7 ++++++-
 8 files changed, 59 insertions(+), 13 deletions(-)
docs/devel/qapi-code-gen.txt +4 -3
index 64d9e4c6a9..637fa49977 100644
@@ -640,9 +640,10 @@ change in the QMP syntax (usually by allowing values or operations
 that previously resulted in an error).  QMP clients may still need to
 know whether the extension is available.
 
-For this purpose, a list of features can be specified for a struct type.
-This is exposed to the client as a list of string, where each string
-signals that this build of QEMU shows a certain behaviour.
+For this purpose, a list of features can be specified for a command or
+struct type.  This is exposed to the client as a list of strings,
+where each string signals that this build of QEMU shows a certain
+behaviour.
 
 Each member of the 'features' array defines a feature.  It can either
 be { 'name': STRING, '*if': COND }, or STRING, which is shorthand for
qapi/introspect.json +5 -1
index 1843c1cb17..031a954fa9 100644
@@ -266,13 +266,17 @@
 # @allow-oob: whether the command allows out-of-band execution,
 #             defaults to false (Since: 2.12)
 #
+# @features: names of features associated with the command, in no particular
+#            order. (since 4.2)
+#
 # TODO: @success-response (currently irrelevant, because it's QGA, not QMP)
 #
 # Since: 2.5
 ##
 { 'struct': 'SchemaInfoCommand',
   'data': { 'arg-type': 'str', 'ret-type': 'str',
-            '*allow-oob': 'bool' } }
+            '*allow-oob': 'bool',
+            '*features': [ 'str' ] } }
 
 ##
 # @SchemaInfoEvent:
scripts/qapi/commands.py +2 -1
index 898516b086..ab98e504f3 100644
@@ -277,7 +277,8 @@ void %(c_prefix)sqmp_init_marshal(QmpCommandList *cmds);
         genc.add(gen_registry(self._regy.get_content(), self._prefix))
 
     def visit_command(self, name, info, ifcond, arg_type, ret_type, gen,
-                      success_response, boxed, allow_oob, allow_preconfig):
+                      success_response, boxed, allow_oob, allow_preconfig,
+                      features):
         if not gen:
             return
         # FIXME: If T is a user-defined type, the user is responsible
scripts/qapi/doc.py +2 -1
index dc8919bab7..8278ccbc43 100644
@@ -249,7 +249,8 @@ class QAPISchemaGenDocVisitor(QAPISchemaVisitor):
                                body=texi_entity(doc, 'Members', ifcond)))
 
     def visit_command(self, name, info, ifcond, arg_type, ret_type, gen,
-                      success_response, boxed, allow_oob, allow_preconfig):
+                      success_response, boxed, allow_oob, allow_preconfig,
+                      features):
         doc = self.cur_doc
         if boxed:
             body = texi_body(doc)
scripts/qapi/expr.py +16 -1
index da23063f57..5c98d31941 100644
@@ -277,12 +277,26 @@ def check_command(expr, info):
     args = expr.get('data')
     rets = expr.get('returns')
     boxed = expr.get('boxed', False)
+    features = expr.get('features')
 
     if boxed and args is None:
         raise QAPISemError(info, "'boxed': true requires 'data'")
     check_type(args, info, "'data'", allow_dict=not boxed)
     check_type(rets, info, "'returns'", allow_array=True)
 
+    if features:
+        if not isinstance(features, list):
+            raise QAPISemError(info,
+                               "Command '%s' requires an array for 'features'" %
+                               name)
+        for f in features:
+            assert isinstance(f, dict)
+            check_known_keys(info, "feature of command %s" % name, f,
+                             ['name'], ['if'])
+
+            check_if(f, info)
+            check_name(info, "Feature of command %s" % name, f['name'])
+
 
 def check_event(expr, info):
     args = expr.get('data')
@@ -357,7 +371,7 @@ def check_exprs(exprs):
         elif meta == 'command':
             check_keys(expr, info, meta,
                        ['command'],
-                       ['data', 'returns', 'boxed', 'if',
+                       ['data', 'returns', 'boxed', 'if', 'features',
                         'gen', 'success-response', 'allow-oob',
                         'allow-preconfig'])
             normalize_members(expr.get('data'))
@@ -366,6 +380,7 @@ def check_exprs(exprs):
             check_keys(expr, info, meta,
                        ['event'], ['data', 'boxed', 'if'])
             normalize_members(expr.get('data'))
+            normalize_features(expr.get('features'))
             check_event(expr, info)
         else:
             assert False, 'unexpected meta type'
scripts/qapi/introspect.py +6 -1
index d1c1ad346d..739b35ae8f 100644
@@ -209,13 +209,18 @@ const QLitObject %(c_name)s = %(c_string)s;
                            for m in variants.variants]}, ifcond)
 
     def visit_command(self, name, info, ifcond, arg_type, ret_type, gen,
-                      success_response, boxed, allow_oob, allow_preconfig):
+                      success_response, boxed, allow_oob, allow_preconfig,
+                      features):
         arg_type = arg_type or self._schema.the_empty_object_type
         ret_type = ret_type or self._schema.the_empty_object_type
         obj = {'arg-type': self._use_type(arg_type),
                'ret-type': self._use_type(ret_type)}
         if allow_oob:
             obj['allow-oob'] = allow_oob
+
+        if features:
+            obj['features'] = [(f.name, {'if': f.ifcond}) for f in features]
+
         self._gen_qlit(name, 'command', obj, ifcond)
 
     def visit_event(self, name, info, ifcond, arg_type, boxed):
scripts/qapi/schema.py +18 -4
index 38041098bd..dd0fdc5ced 100644
@@ -109,7 +109,8 @@ class QAPISchemaVisitor(object):
         pass
 
     def visit_command(self, name, info, ifcond, arg_type, ret_type, gen,
-                      success_response, boxed, allow_oob, allow_preconfig):
+                      success_response, boxed, allow_oob, allow_preconfig,
+                      features):
         pass
 
     def visit_event(self, name, info, ifcond, arg_type, boxed):
@@ -658,10 +659,14 @@ class QAPISchemaCommand(QAPISchemaEntity):
     meta = 'command'
 
     def __init__(self, name, info, doc, ifcond, arg_type, ret_type,
-                 gen, success_response, boxed, allow_oob, allow_preconfig):
+                 gen, success_response, boxed, allow_oob, allow_preconfig,
+                 features):
         QAPISchemaEntity.__init__(self, name, info, doc, ifcond)
         assert not arg_type or isinstance(arg_type, str)
         assert not ret_type or isinstance(ret_type, str)
+        for f in features:
+            assert isinstance(f, QAPISchemaFeature)
+            f.set_owner(name)
         self._arg_type_name = arg_type
         self.arg_type = None
         self._ret_type_name = ret_type
@@ -671,6 +676,7 @@ class QAPISchemaCommand(QAPISchemaEntity):
         self.boxed = boxed
         self.allow_oob = allow_oob
         self.allow_preconfig = allow_preconfig
+        self.features = features
 
     def check(self, schema):
         QAPISchemaEntity.check(self, schema)
@@ -700,13 +706,19 @@ class QAPISchemaCommand(QAPISchemaEntity):
                         "command's 'returns' cannot take %s"
                         % self.ret_type.describe())
 
+        # Features are in a name space separate from members
+        seen = {}
+        for f in self.features:
+            f.check_clash(self.info, seen)
+
     def visit(self, visitor):
         QAPISchemaEntity.visit(self, visitor)
         visitor.visit_command(self.name, self.info, self.ifcond,
                               self.arg_type, self.ret_type,
                               self.gen, self.success_response,
                               self.boxed, self.allow_oob,
-                              self.allow_preconfig)
+                              self.allow_preconfig,
+                              self.features)
 
 
 class QAPISchemaEvent(QAPISchemaEntity):
@@ -983,6 +995,7 @@ class QAPISchema(object):
         allow_oob = expr.get('allow-oob', False)
         allow_preconfig = expr.get('allow-preconfig', False)
         ifcond = expr.get('if')
+        features = expr.get('features', [])
         if isinstance(data, OrderedDict):
             data = self._make_implicit_object_type(
                 name, info, doc, ifcond, 'arg', self._make_members(data, info))
@@ -991,7 +1004,8 @@ class QAPISchema(object):
             rets = self._make_array_type(rets[0], info)
         self._def_entity(QAPISchemaCommand(name, info, doc, ifcond, data, rets,
                                            gen, success_response,
-                                           boxed, allow_oob, allow_preconfig))
+                                           boxed, allow_oob, allow_preconfig,
+                                           self._make_features(features, info)))
 
     def _def_event(self, expr, info, doc):
         name = expr['event']
tests/qapi-schema/test-qapi.py +6 -1
index 664254618a..fc41d24bb9 100755
@@ -72,13 +72,18 @@ class QAPISchemaTestVisitor(QAPISchemaVisitor):
         self._print_if(ifcond)
 
     def visit_command(self, name, info, ifcond, arg_type, ret_type, gen,
-                      success_response, boxed, allow_oob, allow_preconfig):
+                      success_response, boxed, allow_oob, allow_preconfig,
+                      features):
         print('command %s %s -> %s'
               % (name, arg_type and arg_type.name,
                  ret_type and ret_type.name))
         print('   gen=%s success_response=%s boxed=%s oob=%s preconfig=%s'
               % (gen, success_response, boxed, allow_oob, allow_preconfig))
         self._print_if(ifcond)
+        if features:
+            for f in features:
+                print('    feature %s' % f.name)
+                self._print_if(f.ifcond, 8)
 
     def visit_event(self, name, info, ifcond, arg_type, boxed):
         print('event %s %s' % (name, arg_type and arg_type.name))
Signature · 1 line
2.21.0
#5 lore raw

Re: [PATCH v2 1/2] qapi: Add feature flags to commands in qapi introspection

Quoted 10 lines · Markus Armbruster
Quoted 8 lines · Peter Krempa

Similarly to features for struct types introduce the feature flags also for commands. This will allow notifying management layers of fixes and compatible changes in the behaviour of a command which may not be detectable any other way.

The changes were heavily inspired by commit 6a8c0b51025.

[...]

Quoted 8 lines

scripts/qapi/common.py

Quoted 4 lines
scripts/qapi/common.py +0 -0
index d61bfdc526..1502820f46 100644

Conflicts with my "[PATCH 6/7] qapi: Split up scripts/qapi/common.py" and also with work that has already landed in master. Untested rebase appended for your convenience.

I appended a stale version, sorry. Have a fresh one.

[...]

Quoted 2 lines

No tests. Please add at least a positive test case to qapi-schema-test.json.

Adding a feature to some existing command should suffice.

From 4c216a45764be91b660f26c866352e5cab7b20ee Mon Sep 17 00:00:00 2001
From: Markus Armbruster <[email protected]>
Date: Tue, 1 Oct 2019 20:47:04 +0200
Subject: [PATCH 1/2] qapi: Add feature flags to commands in qapi

Similarly to features for struct types introduce the feature flags also for commands. This will allow notifying management layers of fixes and compatible changes in the behaviour of a command which may not be detectable any other way.

The changes were heavily inspired by commit 6a8c0b51025.

---
 docs/devel/qapi-code-gen.txt   |  7 ++++---
 qapi/introspect.json           |  6 +++++-
 scripts/qapi/commands.py       |  3 ++-
 scripts/qapi/doc.py            |  3 ++-
 scripts/qapi/expr.py           | 17 ++++++++++++++++-
 scripts/qapi/introspect.py     |  7 ++++++-
 scripts/qapi/schema.py         | 22 ++++++++++++++++++----
 tests/qapi-schema/test-qapi.py |  7 ++++++-
 8 files changed, 59 insertions(+), 13 deletions(-)
docs/devel/qapi-code-gen.txt +4 -3
index 64d9e4c6a9..637fa49977 100644
@@ -640,9 +640,10 @@ change in the QMP syntax (usually by allowing values or operations
 that previously resulted in an error).  QMP clients may still need to
 know whether the extension is available.
 
-For this purpose, a list of features can be specified for a struct type.
-This is exposed to the client as a list of string, where each string
-signals that this build of QEMU shows a certain behaviour.
+For this purpose, a list of features can be specified for a command or
+struct type.  This is exposed to the client as a list of strings,
+where each string signals that this build of QEMU shows a certain
+behaviour.
 
 Each member of the 'features' array defines a feature.  It can either
 be { 'name': STRING, '*if': COND }, or STRING, which is shorthand for
qapi/introspect.json +5 -1
index 1843c1cb17..031a954fa9 100644
@@ -266,13 +266,17 @@
 # @allow-oob: whether the command allows out-of-band execution,
 #             defaults to false (Since: 2.12)
 #
+# @features: names of features associated with the command, in no particular
+#            order. (since 4.2)
+#
 # TODO: @success-response (currently irrelevant, because it's QGA, not QMP)
 #
 # Since: 2.5
 ##
 { 'struct': 'SchemaInfoCommand',
   'data': { 'arg-type': 'str', 'ret-type': 'str',
-            '*allow-oob': 'bool' } }
+            '*allow-oob': 'bool',
+            '*features': [ 'str' ] } }
 
 ##
 # @SchemaInfoEvent:
scripts/qapi/commands.py +2 -1
index 898516b086..ab98e504f3 100644
@@ -277,7 +277,8 @@ void %(c_prefix)sqmp_init_marshal(QmpCommandList *cmds);
         genc.add(gen_registry(self._regy.get_content(), self._prefix))
 
     def visit_command(self, name, info, ifcond, arg_type, ret_type, gen,
-                      success_response, boxed, allow_oob, allow_preconfig):
+                      success_response, boxed, allow_oob, allow_preconfig,
+                      features):
         if not gen:
             return
         # FIXME: If T is a user-defined type, the user is responsible
scripts/qapi/doc.py +2 -1
index dc8919bab7..8278ccbc43 100644
@@ -249,7 +249,8 @@ class QAPISchemaGenDocVisitor(QAPISchemaVisitor):
                                body=texi_entity(doc, 'Members', ifcond)))
 
     def visit_command(self, name, info, ifcond, arg_type, ret_type, gen,
-                      success_response, boxed, allow_oob, allow_preconfig):
+                      success_response, boxed, allow_oob, allow_preconfig,
+                      features):
         doc = self.cur_doc
         if boxed:
             body = texi_body(doc)
scripts/qapi/expr.py +16 -1
index da23063f57..3e1a49e9af 100644
@@ -277,12 +277,26 @@ def check_command(expr, info):
     args = expr.get('data')
     rets = expr.get('returns')
     boxed = expr.get('boxed', False)
+    features = expr.get('features')
 
     if boxed and args is None:
         raise QAPISemError(info, "'boxed': true requires 'data'")
     check_type(args, info, "'data'", allow_dict=not boxed)
     check_type(rets, info, "'returns'", allow_array=True)
 
+    if features:
+        if not isinstance(features, list):
+            raise QAPISemError(info, "'features' must be an array")
+        for f in features:
+            source = "'features' member"
+            assert isinstance(f, dict)
+            check_keys(f, info, source, ['name'], ['if'])
+            check_name_is_str(f['name'], info, source)
+            source = "%s '%s'" % (source, f['name'])
+            check_name_str(f['name'], info, source)
+            check_if(f, info, source)
+            normalize_if(f)
+
 
 def check_event(expr, info):
     args = expr.get('data')
@@ -357,7 +371,7 @@ def check_exprs(exprs):
         elif meta == 'command':
             check_keys(expr, info, meta,
                        ['command'],
-                       ['data', 'returns', 'boxed', 'if',
+                       ['data', 'returns', 'boxed', 'if', 'features',
                         'gen', 'success-response', 'allow-oob',
                         'allow-preconfig'])
             normalize_members(expr.get('data'))
@@ -366,6 +380,7 @@ def check_exprs(exprs):
             check_keys(expr, info, meta,
                        ['event'], ['data', 'boxed', 'if'])
             normalize_members(expr.get('data'))
+            normalize_features(expr.get('features'))
             check_event(expr, info)
         else:
             assert False, 'unexpected meta type'
scripts/qapi/introspect.py +6 -1
index d1c1ad346d..739b35ae8f 100644
@@ -209,13 +209,18 @@ const QLitObject %(c_name)s = %(c_string)s;
                            for m in variants.variants]}, ifcond)
 
     def visit_command(self, name, info, ifcond, arg_type, ret_type, gen,
-                      success_response, boxed, allow_oob, allow_preconfig):
+                      success_response, boxed, allow_oob, allow_preconfig,
+                      features):
         arg_type = arg_type or self._schema.the_empty_object_type
         ret_type = ret_type or self._schema.the_empty_object_type
         obj = {'arg-type': self._use_type(arg_type),
                'ret-type': self._use_type(ret_type)}
         if allow_oob:
             obj['allow-oob'] = allow_oob
+
+        if features:
+            obj['features'] = [(f.name, {'if': f.ifcond}) for f in features]
+
         self._gen_qlit(name, 'command', obj, ifcond)
 
     def visit_event(self, name, info, ifcond, arg_type, boxed):
scripts/qapi/schema.py +18 -4
index 38041098bd..8a48231766 100644
@@ -109,7 +109,8 @@ class QAPISchemaVisitor(object):
         pass
 
     def visit_command(self, name, info, ifcond, arg_type, ret_type, gen,
-                      success_response, boxed, allow_oob, allow_preconfig):
+                      success_response, boxed, allow_oob, allow_preconfig,
+                      features):
         pass
 
     def visit_event(self, name, info, ifcond, arg_type, boxed):
@@ -658,10 +659,14 @@ class QAPISchemaCommand(QAPISchemaEntity):
     meta = 'command'
 
     def __init__(self, name, info, doc, ifcond, arg_type, ret_type,
-                 gen, success_response, boxed, allow_oob, allow_preconfig):
+                 gen, success_response, boxed, allow_oob, allow_preconfig,
+                 features):
         QAPISchemaEntity.__init__(self, name, info, doc, ifcond)
         assert not arg_type or isinstance(arg_type, str)
         assert not ret_type or isinstance(ret_type, str)
+        for f in features:
+            assert isinstance(f, QAPISchemaFeature)
+            f.set_defined_in(name)
         self._arg_type_name = arg_type
         self.arg_type = None
         self._ret_type_name = ret_type
@@ -671,6 +676,7 @@ class QAPISchemaCommand(QAPISchemaEntity):
         self.boxed = boxed
         self.allow_oob = allow_oob
         self.allow_preconfig = allow_preconfig
+        self.features = features
 
     def check(self, schema):
         QAPISchemaEntity.check(self, schema)
@@ -700,13 +706,19 @@ class QAPISchemaCommand(QAPISchemaEntity):
                         "command's 'returns' cannot take %s"
                         % self.ret_type.describe())
 
+        # Features are in a name space separate from members
+        seen = {}
+        for f in self.features:
+            f.check_clash(self.info, seen)
+
     def visit(self, visitor):
         QAPISchemaEntity.visit(self, visitor)
         visitor.visit_command(self.name, self.info, self.ifcond,
                               self.arg_type, self.ret_type,
                               self.gen, self.success_response,
                               self.boxed, self.allow_oob,
-                              self.allow_preconfig)
+                              self.allow_preconfig,
+                              self.features)
 
 
 class QAPISchemaEvent(QAPISchemaEntity):
@@ -983,6 +995,7 @@ class QAPISchema(object):
         allow_oob = expr.get('allow-oob', False)
         allow_preconfig = expr.get('allow-preconfig', False)
         ifcond = expr.get('if')
+        features = expr.get('features', [])
         if isinstance(data, OrderedDict):
             data = self._make_implicit_object_type(
                 name, info, doc, ifcond, 'arg', self._make_members(data, info))
@@ -991,7 +1004,8 @@ class QAPISchema(object):
             rets = self._make_array_type(rets[0], info)
         self._def_entity(QAPISchemaCommand(name, info, doc, ifcond, data, rets,
                                            gen, success_response,
-                                           boxed, allow_oob, allow_preconfig))
+                                           boxed, allow_oob, allow_preconfig,
+                                           self._make_features(features, info)))
 
     def _def_event(self, expr, info, doc):
         name = expr['event']
tests/qapi-schema/test-qapi.py +6 -1
index 664254618a..fc41d24bb9 100755
@@ -72,13 +72,18 @@ class QAPISchemaTestVisitor(QAPISchemaVisitor):
         self._print_if(ifcond)
 
     def visit_command(self, name, info, ifcond, arg_type, ret_type, gen,
-                      success_response, boxed, allow_oob, allow_preconfig):
+                      success_response, boxed, allow_oob, allow_preconfig,
+                      features):
         print('command %s %s -> %s'
               % (name, arg_type and arg_type.name,
                  ret_type and ret_type.name))
         print('   gen=%s success_response=%s boxed=%s oob=%s preconfig=%s'
               % (gen, success_response, boxed, allow_oob, allow_preconfig))
         self._print_if(ifcond)
+        if features:
+            for f in features:
+                print('    feature %s' % f.name)
+                self._print_if(f.ifcond, 8)
 
     def visit_event(self, name, info, ifcond, arg_type, boxed):
         print('event %s %s' % (name, arg_type and arg_type.name))
Signature · 1 line
2.21.0
#6 lore raw

PATCH v2 2/2 qapi: Allow introspecting fix for savevm's cooperation with blockdev

In reply to Peter Krempa

savevm was buggy as it considered all monitor owned block device nodes for snapshot. With introduction of -blockdev the common usage made all nodes including protocol nodes monitor owned and thus considered for snapshot. This was fixed but clients need to be able to detect whether this fix is present.

Since savevm does not have an QMP alternative add the feature for the 'human-monitor-command' backdoor which is used to call this command in modern use.

---
 qapi/misc.json | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)
qapi/misc.json +8 -1
index 6bd11f50e6..673445dfa9 100644
@@ -1020,6 +1020,12 @@
 #
 # @cpu-index: The CPU to use for commands that require an implicit CPU
 #
+# Features:
+# @savevm-blockdev-monitor-nodes: If present, the savevm monitor command only
+#                                 snapshots monitor owned nodes if they have no
+#                                 parents. This allows to use 'savevm' with
+#                                 -blockdev. (since 4.2)
+#
 # Returns: the output of the command as a string
 #
 # Since: 0.14.0
@@ -1047,7 +1053,8 @@
 ##
 { 'command': 'human-monitor-command',
   'data': {'command-line': 'str', '*cpu-index': 'int'},
-  'returns': 'str' }
+  'returns': 'str',
+  'features' : [ { 'name': 'savevm-blockdev-monitor-nodes' } ] }
 
 ##
 # @change:
Signature · 1 line
2.21.0
#7 lore raw

Re: [PATCH v2 2/2] qapi: Allow introspecting fix for savevm's cooperation with blockdev

Quoted 1 line · Peter Krempa

savevm was buggy as it considered all monitor owned block device nodes

Recommend "monitor-owned block device nodes" or "block device nodes owned by a monitor"

Quoted 3 lines

for snapshot. With introduction of -blockdev the common usage made all nodes including protocol nodes monitor owned and thus considered for snapshot.

What exactly is / was the problem?

Quoted 2 lines

This was fixed but clients need to be able to detect whether
this fix is present.

Fixed where? Commit hash, if possible.

Quoted 2 lines

Since savevm does not have an QMP alternative add the feature for the

Comma after alternative.

Quoted 2 lines

'human-monitor-command' backdoor which is used to call this command in modern use.

Eww. I don't have better ideas short of "design and implement a sane QMP interface to internal snapshots", which is too much work.

Quoted 10 lines
---
 qapi/misc.json | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)
qapi/misc.json +0 -0
index 6bd11f50e6..673445dfa9 100644

qapi/misc.json line 1024

Quoted 5 lines
qapi/misc.json +2 -0
@@ -1020,6 +1020,12 @@
 #
 # @cpu-index: The CPU to use for commands that require an implicit CPU
 #
+# Features:
+# @savevm-blockdev-monitor-nodes: If present, the savevm monitor command only

Maybe s/the savevm monitor command/HMP command savevm/

qapi/misc.json line 1025

Quoted 1 line
qapi/misc.json +1 -0
+#                                 snapshots monitor owned nodes if they have no

monitor-owned or owner by a monitor again.

qapi/misc.json line 1057

Quoted 13 lines
qapi/misc.json +5 -1
+#                                 parents. This allows to use 'savevm' with
+#                                 -blockdev. (since 4.2)
+#
 # Returns: the output of the command as a string
 #
 # Since: 0.14.0
@@ -1047,7 +1053,8 @@
 ##
 { 'command': 'human-monitor-command',
   'data': {'command-line': 'str', '*cpu-index': 'int'},
-  'returns': 'str' }
+  'returns': 'str',
+  'features' : [ { 'name': 'savevm-blockdev-monitor-nodes' } ] }

No space before ':'.

Short form would do:

'features': [ 'savevm-blockdev-monitor-nodes' ]

Quoted 3 lines
qapi/misc.json +0 -0
 ##
 # @change:
#8 lore raw

Re: [PATCH v2 2/2] qapi: Allow introspecting fix for savevm's cooperation with blockdev

Quoted 4 lines · Markus Armbruster
Quoted 1 line · Peter Krempa

savevm was buggy as it considered all monitor owned block device nodes

Quoted 8 lines

Recommend "monitor-owned block device nodes" or "block device nodes owned by a monitor"

Quoted 3 lines

for snapshot. With introduction of -blockdev the common usage made all nodes including protocol nodes monitor owned and thus considered for snapshot.

What exactly is / was the problem?

Old way: using QMP add_device, you create a drive backend with two BDS (format and protocol) assigned to it; the drive backend has your given name, and both BDS have a generated name (beginning with '#'). The two BDS are not monitor-owned, rather, the drive is.

New way: using QMP blockdev_add, you create the two BDS manually with names of your choice, then plug that blockdev into an unnamed blockbackend (the drive no longer needs a name, because you can get at everything through the BDS name). You _could_ do this in one step (the QAPI allows self-recursion where you can define both the format and protocol in one step), but it is easier to do in two steps (define the protocol BDS first, then define the format BDS using a "string" name of the protocol BDS instead of a { "driver":..., args... } object of the protocol layer. But by making two calls, now both BDS are monitor-owned.

At snapshot-time, the code currently looks for all monitor-owned nodes when deciding what to snapshot. In the old way, this finds the named drive, picks up its associated top-most node, and snapshots the format layer. In the new way, the drive is unnamed so it is skipped, while there are two named BDS, but we don't want a snapshot of the protocol layer.

Quoted 5 lines
Quoted 3 lines

This was fixed but clients need to be able to detect whether
this fix is present.

Fixed where? Commit hash, if possible.

Pull request: https://lists.gnu.org/archive/html/qemu-devel/2019-09/msg04773.html
(assuming it doesn't need a respin before landing, 8ec72832)

Quoted 16 lines
Quoted 3 lines

Since savevm does not have an QMP alternative add the feature for the

Comma after alternative.

Quoted 2 lines

'human-monitor-command' backdoor which is used to call this command in modern use.

Eww. I don't have better ideas short of "design and implement a sane QMP interface to internal snapshots", which is too much work.

Quoted 4 lines
---
  qapi/misc.json | 9 ++++++++-
  1 file changed, 8 insertions(+), 1 deletion(-)
Signature · 3 lines
Eric Blake, Principal Software Engineer
Red Hat, Inc.           +1-919-301-3226
Virtualization:  qemu.org | libvirt.org
#9 lore raw

Re: [PATCH v2 2/2] qapi: Allow introspecting fix for savevm's cooperation with blockdev

Quoted 31 lines · Eric Blake
Quoted 4 lines · Markus Armbruster
Quoted 1 line · Peter Krempa

savevm was buggy as it considered all monitor owned block device nodes

Quoted 8 lines

Recommend "monitor-owned block device nodes" or "block device nodes owned by a monitor"

Quoted 3 lines

for snapshot. With introduction of -blockdev the common usage made all nodes including protocol nodes monitor owned and thus considered for snapshot.

What exactly is / was the problem?

Old way: using QMP add_device, you create a drive backend with two BDS (format and protocol) assigned to it; the drive backend has your given name, and both BDS have a generated name (beginning with '#'). The two BDS are not monitor-owned, rather, the drive is.

New way: using QMP blockdev_add, you create the two BDS manually with names of your choice, then plug that blockdev into an unnamed blockbackend (the drive no longer needs a name, because you can get at everything through the BDS name). You _could_ do this in one step (the QAPI allows self-recursion where you can define both the format and protocol in one step), but it is easier to do in two steps (define the protocol BDS first, then define the format BDS using a "string" name of the protocol BDS instead of a { "driver":..., args... } object of the protocol layer. But by making two calls, now both BDS are monitor-owned.

Quoted 6 lines

At snapshot-time, the code currently looks for all monitor-owned nodes when deciding what to snapshot. In the old way, this finds the named drive, picks up its associated top-most node, and snapshots the format layer. In the new way, the drive is unnamed so it is skipped, while there are two named BDS, but we don't want a snapshot of the protocol layer.

So the problem is certain (common & sane) -blockdev use makes savevm create additional, unwanted snapshots.

Your explanation should be worked into the commit message along with ...

Quoted 8 lines
Quoted 4 lines
Quoted 2 lines

This was fixed but clients need to be able to detect whether
this fix is present.

Fixed where? Commit hash, if possible.

Pull request:
https://lists.gnu.org/archive/html/qemu-devel/2019-09/msg04773.html
(assuming it doesn't need a respin before landing, 8ec72832)

... a pointer to this fix.

Thanks!

[...]

#10 lore raw

Re: [PATCH v2 2/2] qapi: Allow introspecting fix for savevm's cooperation with blockdev

Am 02.10.2019 um 13:57 hat Markus Armbruster geschrieben:

Quoted 40 lines
Quoted 31 lines · Eric Blake
Quoted 4 lines · Markus Armbruster
Quoted 1 line · Peter Krempa

savevm was buggy as it considered all monitor owned block device nodes

Quoted 8 lines

Recommend "monitor-owned block device nodes" or "block device nodes owned by a monitor"

Quoted 3 lines

for snapshot. With introduction of -blockdev the common usage made all nodes including protocol nodes monitor owned and thus considered for snapshot.

What exactly is / was the problem?

Old way: using QMP add_device, you create a drive backend with two BDS (format and protocol) assigned to it; the drive backend has your given name, and both BDS have a generated name (beginning with '#'). The two BDS are not monitor-owned, rather, the drive is.

New way: using QMP blockdev_add, you create the two BDS manually with names of your choice, then plug that blockdev into an unnamed blockbackend (the drive no longer needs a name, because you can get at everything through the BDS name). You _could_ do this in one step (the QAPI allows self-recursion where you can define both the format and protocol in one step), but it is easier to do in two steps (define the protocol BDS first, then define the format BDS using a "string" name of the protocol BDS instead of a { "driver":..., args... } object of the protocol layer. But by making two calls, now both BDS are monitor-owned.

Quoted 6 lines

At snapshot-time, the code currently looks for all monitor-owned nodes when deciding what to snapshot. In the old way, this finds the named drive, picks up its associated top-most node, and snapshots the format layer. In the new way, the drive is unnamed so it is skipped, while there are two named BDS, but we don't want a snapshot of the protocol layer.

Quoted 2 lines

So the problem is certain (common & sane) -blockdev use makes savevm create additional, unwanted snapshots.

Actually, the most common protocol driver is file-posix, which doesn't support snapshots, so usually the result was that savevm just fails because it can't snapshot something that it (incorrectly) thinks it should snapshot.

Kevin

Quoted 16 lines

Your explanation should be worked into the commit message along with ...

Quoted 8 lines
Quoted 4 lines
Quoted 2 lines

This was fixed but clients need to be able to detect whether
this fix is present.

Fixed where? Commit hash, if possible.

Pull request:
https://lists.gnu.org/archive/html/qemu-devel/2019-09/msg04773.html
(assuming it doesn't need a respin before landing, 8ec72832)

... a pointer to this fix.

Thanks!

[...]

#11 lore raw

Re: [PATCH v2 2/2] qapi: Allow introspecting fix for savevm's cooperation with blockdev

Quoted 41 lines · Kevin Wolf

Am 02.10.2019 um 13:57 hat Markus Armbruster geschrieben:

Quoted 40 lines
Quoted 37 lines · Eric Blake
Quoted 4 lines · Markus Armbruster
Quoted 1 line · Peter Krempa

savevm was buggy as it considered all monitor owned block device nodes

Quoted 8 lines

Recommend "monitor-owned block device nodes" or "block device nodes owned by a monitor"

Quoted 3 lines

for snapshot. With introduction of -blockdev the common usage made all nodes including protocol nodes monitor owned and thus considered for snapshot.

What exactly is / was the problem?

Old way: using QMP add_device, you create a drive backend with two BDS (format and protocol) assigned to it; the drive backend has your given name, and both BDS have a generated name (beginning with '#'). The two BDS are not monitor-owned, rather, the drive is.

New way: using QMP blockdev_add, you create the two BDS manually with names of your choice, then plug that blockdev into an unnamed blockbackend (the drive no longer needs a name, because you can get at everything through the BDS name). You _could_ do this in one step (the QAPI allows self-recursion where you can define both the format and protocol in one step), but it is easier to do in two steps (define the protocol BDS first, then define the format BDS using a "string" name of the protocol BDS instead of a { "driver":..., args... } object of the protocol layer. But by making two calls, now both BDS are monitor-owned.

At snapshot-time, the code currently looks for all monitor-owned nodes when deciding what to snapshot. In the old way, this finds the named drive, picks up its associated top-most node, and snapshots the format layer. In the new way, the drive is unnamed so it is skipped, while there are two named BDS, but we don't want a snapshot of the protocol layer.

Quoted 7 lines
Quoted 2 lines

So the problem is certain (common & sane) -blockdev use makes savevm create additional, unwanted snapshots.

Actually, the most common protocol driver is file-posix, which doesn't support snapshots, so usually the result was that savevm just fails because it can't snapshot something that it (incorrectly) thinks it should snapshot.

v3's commit message:

qapi: Allow introspecting fix for savevm's cooperation with blockdev

'savevm' was buggy as it considered all monitor-owned block device nodes for snapshot. With introduction of -blockdev the common usage made all nodes including protocol and backing file nodes monitor-owned and thus considered for snapshot.

This is a problem since the 'file' protocol nodes can't have internal snapshots and it does not make sense to take snapshot of nodes representing backing files.

This was fixed by commit 05f4aced658a02b02 clients need to be able to detect whether this fix is present.

Since savevm does not have an QMP alternative, add the feature for the 'human-monitor-command' backdoor which is used to call this command in modern use.

Kevin, is this explanation sufficiently correct & complete?

#12 lore raw

Re: [PATCH v2 2/2] qapi: Allow introspecting fix for savevm's cooperation with blockdev

Am 11.10.2019 um 08:08 hat Markus Armbruster geschrieben:

Quoted 60 lines
Quoted 41 lines · Kevin Wolf

Am 02.10.2019 um 13:57 hat Markus Armbruster geschrieben:

Quoted 40 lines
Quoted 37 lines · Eric Blake
Quoted 4 lines · Markus Armbruster
Quoted 1 line · Peter Krempa

savevm was buggy as it considered all monitor owned block device nodes

Quoted 8 lines

Recommend "monitor-owned block device nodes" or "block device nodes owned by a monitor"

Quoted 3 lines

for snapshot. With introduction of -blockdev the common usage made all nodes including protocol nodes monitor owned and thus considered for snapshot.

What exactly is / was the problem?

Old way: using QMP add_device, you create a drive backend with two BDS (format and protocol) assigned to it; the drive backend has your given name, and both BDS have a generated name (beginning with '#'). The two BDS are not monitor-owned, rather, the drive is.

New way: using QMP blockdev_add, you create the two BDS manually with names of your choice, then plug that blockdev into an unnamed blockbackend (the drive no longer needs a name, because you can get at everything through the BDS name). You _could_ do this in one step (the QAPI allows self-recursion where you can define both the format and protocol in one step), but it is easier to do in two steps (define the protocol BDS first, then define the format BDS using a "string" name of the protocol BDS instead of a { "driver":..., args... } object of the protocol layer. But by making two calls, now both BDS are monitor-owned.

At snapshot-time, the code currently looks for all monitor-owned nodes when deciding what to snapshot. In the old way, this finds the named drive, picks up its associated top-most node, and snapshots the format layer. In the new way, the drive is unnamed so it is skipped, while there are two named BDS, but we don't want a snapshot of the protocol layer.

Quoted 7 lines
Quoted 2 lines

So the problem is certain (common & sane) -blockdev use makes savevm create additional, unwanted snapshots.

Actually, the most common protocol driver is file-posix, which doesn't support snapshots, so usually the result was that savevm just fails because it can't snapshot something that it (incorrectly) thinks it should snapshot.

v3's commit message:

qapi: Allow introspecting fix for savevm's cooperation with blockdev

'savevm' was buggy as it considered all monitor-owned block device nodes for snapshot. With introduction of -blockdev the common usage made all nodes including protocol and backing file nodes monitor-owned and thus considered for snapshot.

Quoted 6 lines

This is a problem since the 'file' protocol nodes can't have internal snapshots and it does not make sense to take snapshot of nodes representing backing files.

This was fixed by commit 05f4aced658a02b02 clients need to be able to detect whether this fix is present.

Something is missing in this sentence. I think you lost the "but" from the original message.

Quoted 7 lines

Since savevm does not have an QMP alternative, add the feature for the 'human-monitor-command' backdoor which is used to call this command in modern use.

Kevin, is this explanation sufficiently correct & complete?

Looks good to me otherwise.

Kevin

#13 lore raw

Re: [PATCH v2 2/2] qapi: Allow introspecting fix for savevm's cooperation with blockdev

Quoted 4 lines · Kevin Wolf

Am 11.10.2019 um 08:08 hat Markus Armbruster geschrieben:

Quoted 3 lines
Quoted 1 line · Kevin Wolf

Am 02.10.2019 um 13:57 hat Markus Armbruster geschrieben:

[...]

Quoted 21 lines
Quoted 21 lines
Quoted 7 lines
Quoted 2 lines

So the problem is certain (common & sane) -blockdev use makes savevm create additional, unwanted snapshots.

Actually, the most common protocol driver is file-posix, which doesn't support snapshots, so usually the result was that savevm just fails because it can't snapshot something that it (incorrectly) thinks it should snapshot.

v3's commit message:

qapi: Allow introspecting fix for savevm's cooperation with blockdev

'savevm' was buggy as it considered all monitor-owned block device nodes for snapshot. With introduction of -blockdev the common usage made all nodes including protocol and backing file nodes monitor-owned and thus considered for snapshot.

This is a problem since the 'file' protocol nodes can't have internal snapshots and it does not make sense to take snapshot of nodes representing backing files.

Quoted 5 lines
Quoted 2 lines

This was fixed by commit 05f4aced658a02b02 clients need to be able to detect whether this fix is present.

Something is missing in this sentence. I think you lost the "but" from the original message.

I fixed this in v4 by inserting a period. I wasn't aware we had lost a "but".

Quoted 9 lines
Quoted 7 lines

Since savevm does not have an QMP alternative, add the feature for the 'human-monitor-command' backdoor which is used to call this command in modern use.

Kevin, is this explanation sufficiently correct & complete?

Looks good to me otherwise.

Thanks!

#14 lore raw
In reply to Peter Krempa
Quoted 11 lines · Peter Krempa

Add 'features' field in the schema for commands and add a feature flag to advertise that the fix for savevm [1] is present.

[1] https://lists.gnu.org/archive/html/qemu-devel/2019-09/msg03487.html

v2:
- fixed typos pointed out by Eric
- added 'since' tag
- reworded to describe the fix this allows to detect properly (Kevin)
- verified that this can be rebased on top of Markus' series automatically

Ping