Skip to contentSkip to conversation

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

PATCH Superseded Markus Armbruster 3 participants 11 messages Oct 11, 2019 – Oct 15, 2019

v4 of 5 Superseded Latest is v5 →

lore
Share & tools
lore
#0 lore raw

v4 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

Based-on: <[email protected]>

v4:
- PATCH 1: New
- PATCH 2: Factor out check_features()
- PATCH 3: Factor out _print_features(), drop duplicated test
- PATCH 4: Shorten savevm-blockdev-monitor-nodes to just savevm-monitor-nodes; tweak commit message and documentation

v3:
- added tests
- mentioned commit fixing savevm in the patch adding the new feature
- mentioned actual problem in the patch adding the new feature
- rebased on top of the last batch of Markus' cleanups

Markus Armbruster (1):
tests/qapi-schema: Tidy up test output indentation

Peter Krempa (3):
qapi: Add feature flags to commands in qapi
tests: qapi: Test 'features' of commands
qapi: Allow introspecting fix for savevm's cooperation with blockdev

 docs/devel/qapi-code-gen.txt            |  7 ++-
 qapi/introspect.json                    |  6 +-
 qapi/misc.json                          | 10 +++-
 tests/test-qmp-cmds.c                   | 24 ++++++++
 scripts/qapi/commands.py                |  3 +-
 scripts/qapi/doc.py                     |  3 +-
 scripts/qapi/expr.py                    | 35 +++++++-----
 scripts/qapi/introspect.py              |  7 ++-
 scripts/qapi/schema.py                  | 22 ++++++--
 tests/qapi-schema/doc-good.out          |  4 +-
 tests/qapi-schema/event-case.out        |  2 +-
 tests/qapi-schema/indented-expr.out     |  4 +-
 tests/qapi-schema/qapi-schema-test.json | 22 ++++++++
 tests/qapi-schema/qapi-schema-test.out  | 75 ++++++++++++++++---------
 tests/qapi-schema/test-qapi.py          | 19 ++++---
 15 files changed, 178 insertions(+), 65 deletions(-)
Signature · 1 line
2.21.0
#1 lore raw

PATCH v4 1/4 tests/qapi-schema: Tidy up test output indentation

Command and event details are indented three spaces, everything else four. Messed up in commit 156402e5042. Use four spaces consistently.

---
 tests/qapi-schema/doc-good.out         |  4 +-
 tests/qapi-schema/event-case.out       |  2 +-
 tests/qapi-schema/indented-expr.out    |  4 +-
 tests/qapi-schema/qapi-schema-test.out | 52 +++++++++++++-------------
 tests/qapi-schema/test-qapi.py         |  4 +-
 5 files changed, 33 insertions(+), 33 deletions(-)
tests/qapi-schema/doc-good.out +2 -2
index d3bca343eb..6562e1f412 100644
@@ -46,9 +46,9 @@ object q_obj_cmd-arg
     member arg2: str optional=True
     member arg3: bool optional=False
 command cmd q_obj_cmd-arg -> Object
-   gen=True success_response=True boxed=False oob=False preconfig=False
+    gen=True success_response=True boxed=False oob=False preconfig=False
 command cmd-boxed Object -> None
-   gen=True success_response=True boxed=True oob=False preconfig=False
+    gen=True success_response=True boxed=True oob=False preconfig=False
 doc freeform
     body=
 = Section
tests/qapi-schema/event-case.out +1 -1
index ec8a1406e4..42ae519656 100644
@@ -11,4 +11,4 @@ enum QType
     member qbool
 module event-case.json
 event oops None
-   boxed=False
+    boxed=False
tests/qapi-schema/indented-expr.out +2 -2
index bffdf6756d..04356775cd 100644
@@ -11,6 +11,6 @@ enum QType
     member qbool
 module indented-expr.json
 command eins None -> None
-   gen=True success_response=True boxed=False oob=False preconfig=False
+    gen=True success_response=True boxed=False oob=False preconfig=False
 command zwei None -> None
-   gen=True success_response=True boxed=False oob=False preconfig=False
+    gen=True success_response=True boxed=False oob=False preconfig=False
tests/qapi-schema/qapi-schema-test.out +26 -26

145 lines not on this page · raw message

tests/qapi-schema/test-qapi.py +2 -2
index 664254618a..29d9435bf7 100755
@@ -76,13 +76,13 @@ class QAPISchemaTestVisitor(QAPISchemaVisitor):
         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'
+        print('    gen=%s success_response=%s boxed=%s oob=%s preconfig=%s'
               % (gen, success_response, boxed, allow_oob, allow_preconfig))
         self._print_if(ifcond)
 
     def visit_event(self, name, info, ifcond, arg_type, boxed):
         print('event %s %s' % (name, arg_type and arg_type.name))
-        print('   boxed=%s' % boxed)
+        print('    boxed=%s' % boxed)
         self._print_if(ifcond)
 
     @staticmethod
Signature · 1 line
2.21.0
Reviewed-by on v4 1/4
#2 lore raw

Re: [PATCH v4 1/4] tests/qapi-schema: Tidy up test output indentation

Quoted 11 lines · Markus Armbruster

Command and event details are indented three spaces, everything else four. Messed up in commit 156402e5042. Use four spaces consistently.

---
 tests/qapi-schema/doc-good.out         |  4 +-
 tests/qapi-schema/event-case.out       |  2 +-
 tests/qapi-schema/indented-expr.out    |  4 +-
 tests/qapi-schema/qapi-schema-test.out | 52 +++++++++++++-------------
 tests/qapi-schema/test-qapi.py         |  4 +-
 5 files changed, 33 insertions(+), 33 deletions(-)
#3 lore raw

PATCH v4 2/4 qapi: Add feature flags to commands in qapi

In reply to Markus Armbruster

From: Peter Krempa <[email protected]>

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           | 35 +++++++++++++++++++---------------
 scripts/qapi/introspect.py     |  7 ++++++-
 scripts/qapi/schema.py         | 22 +++++++++++++++++----
 tests/qapi-schema/test-qapi.py |  3 ++-
 8 files changed, 59 insertions(+), 27 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 +20 -15
index da23063f57..5a7e548899 100644
@@ -184,6 +184,22 @@ def normalize_features(features):
                        for f in features]
 
 
+def check_features(features, info):
+    if features is None:
+        return
+    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 normalize_enum(expr):
     if isinstance(expr['data'], list):
         expr['data'] = [m if isinstance(m, dict) else {'name': m}
@@ -216,23 +232,10 @@ def check_enum(expr, info):
 def check_struct(expr, info):
     name = expr['struct']
     members = expr['data']
-    features = expr.get('features')
 
     check_type(members, info, "'data'", allow_dict=name)
     check_type(expr.get('base'), info, "'base'")
-
-    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)
+    check_features(expr.get('features'), info)
 
 
 def check_union(expr, info):
@@ -282,6 +285,7 @@ def check_command(expr, info):
         raise QAPISemError(info, "'boxed': true requires 'data'")
     check_type(args, info, "'data'", allow_dict=not boxed)
     check_type(rets, info, "'returns'", allow_array=True)
+    check_features(expr.get('features'), info)
 
 
 def check_event(expr, info):
@@ -357,10 +361,11 @@ 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'))
+            normalize_features(expr.get('features'))
             check_command(expr, info)
         elif meta == 'event':
             check_keys(expr, info, meta,
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 +2 -1
index 29d9435bf7..d31ac4bbb7 100755
@@ -72,7 +72,8 @@ 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))
Signature · 1 line
2.21.0
#4 lore raw

Re: [PATCH v4 2/4] qapi: Add feature flags to commands in qapi

Quoted 31 lines · Markus Armbruster

From: Peter Krempa <[email protected]>

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           | 35 +++++++++++++++++++---------------
 scripts/qapi/introspect.py     |  7 ++++++-
 scripts/qapi/schema.py         | 22 +++++++++++++++++----
 tests/qapi-schema/test-qapi.py |  3 ++-
 8 files changed, 59 insertions(+), 27 deletions(-)
docs/devel/qapi-code-gen.txt +0 -0
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.
 

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

Quoted 10 lines
docs/devel/qapi-code-gen.txt +4 -3
-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

Squashing in missing syntax update:

docs/devel/qapi-code-gen.txt +2 -1
index 637fa49977..45c93a43cc 100644
@@ -457,7 +457,8 @@ Syntax:
                 '*gen': false,
                 '*allow-oob': true,
                 '*allow-preconfig': true,
-                '*if': COND }
+                '*if': COND,
+                '*features': FEATURES }
 
 Member 'command' names the command.
 

[...]

#5 lore raw

PATCH v4 3/4 tests: qapi: Test 'features' of commands

In reply to Markus Armbruster

From: Peter Krempa <[email protected]>

---
 tests/test-qmp-cmds.c                   | 24 ++++++++++++++++++++++++
 tests/qapi-schema/qapi-schema-test.json | 22 ++++++++++++++++++++++
 tests/qapi-schema/qapi-schema-test.out  | 23 +++++++++++++++++++++++
 tests/qapi-schema/test-qapi.py          | 12 ++++++++----
 4 files changed, 77 insertions(+), 4 deletions(-)
tests/test-qmp-cmds.c +24 -0
index 36fdf5b115..ba623fda29 100644
@@ -51,6 +51,30 @@ void qmp_test_features(FeatureStruct0 *fs0, FeatureStruct1 *fs1,
 {
 }
 
+void qmp_test_command_features1(Error **errp)
+{
+}
+
+void qmp_test_command_features2(Error **errp)
+{
+}
+
+void qmp_test_command_features3(Error **errp)
+{
+}
+
+void qmp_test_command_features4(Error **errp)
+{
+}
+
+void qmp_test_command_features5(Error **errp)
+{
+}
+
+void qmp_test_command_features6(Error **errp)
+{
+}
+
 UserDefTwo *qmp_user_def_cmd2(UserDefOne *ud1a,
                               bool has_udb1, UserDefOne *ud1b,
                               Error **errp)
tests/qapi-schema/qapi-schema-test.json +22 -0
index 75c42eb0e3..80811dc8f0 100644
@@ -290,3 +290,25 @@
             'cfs1': 'CondFeatureStruct1',
             'cfs2': 'CondFeatureStruct2',
             'cfs3': 'CondFeatureStruct3' } }
+
+# test 'features' for command
+
+{ 'command': 'test-command-features1',
+  'features': [] }
+
+{ 'command': 'test-command-features2',
+  'features': [ 'feature1' ] }
+
+{ 'command': 'test-command-features3',
+  'features': [ 'feature1', 'feature2' ] }
+
+{ 'command': 'test-command-features4',
+  'features': [ { 'name': 'feature1', 'if': 'defined(TEST_IF_FEATURE_1)'} ] }
+
+{ 'command': 'test-command-features5',
+  'features': [ { 'name': 'feature1', 'if': 'defined(TEST_IF_FEATURE_1)'},
+                { 'name': 'feature2', 'if': 'defined(TEST_IF_FEATURE_2)'} ] }
+
+{ 'command': 'test-command-features6',
+  'features': [ { 'name': 'feature1', 'if': [ 'defined(TEST_IF_COND_1)',
+                                              'defined(TEST_IF_COND_2)'] } ] }
tests/qapi-schema/qapi-schema-test.out +23 -0
index aca43186a9..4061152cae 100644
@@ -412,3 +412,26 @@ object q_obj_test-features-arg
     member cfs3: CondFeatureStruct3 optional=False
 command test-features q_obj_test-features-arg -> None
     gen=True success_response=True boxed=False oob=False preconfig=False
+command test-command-features1 None -> None
+    gen=True success_response=True boxed=False oob=False preconfig=False
+command test-command-features2 None -> None
+    gen=True success_response=True boxed=False oob=False preconfig=False
+    feature feature1
+command test-command-features3 None -> None
+    gen=True success_response=True boxed=False oob=False preconfig=False
+    feature feature1
+    feature feature2
+command test-command-features4 None -> None
+    gen=True success_response=True boxed=False oob=False preconfig=False
+    feature feature1
+        if ['defined(TEST_IF_FEATURE_1)']
+command test-command-features5 None -> None
+    gen=True success_response=True boxed=False oob=False preconfig=False
+    feature feature1
+        if ['defined(TEST_IF_FEATURE_1)']
+    feature feature2
+        if ['defined(TEST_IF_FEATURE_2)']
+command test-command-features6 None -> None
+    gen=True success_response=True boxed=False oob=False preconfig=False
+    feature feature1
+        if ['defined(TEST_IF_COND_1)', 'defined(TEST_IF_COND_2)']
tests/qapi-schema/test-qapi.py +8 -4
index d31ac4bbb7..32333d3bf9 100755
@@ -61,10 +61,7 @@ class QAPISchemaTestVisitor(QAPISchemaVisitor):
             self._print_if(m.ifcond, 8)
         self._print_variants(variants)
         self._print_if(ifcond)
-        if features:
-            for f in features:
-                print('    feature %s' % f.name)
-                self._print_if(f.ifcond, 8)
+        self._print_features(features)
 
     def visit_alternate_type(self, name, info, ifcond, variants):
         print('alternate %s' % name)
@@ -80,6 +77,7 @@ class QAPISchemaTestVisitor(QAPISchemaVisitor):
         print('    gen=%s success_response=%s boxed=%s oob=%s preconfig=%s'
               % (gen, success_response, boxed, allow_oob, allow_preconfig))
         self._print_if(ifcond)
+        self._print_features(features)
 
     def visit_event(self, name, info, ifcond, arg_type, boxed):
         print('event %s %s' % (name, arg_type and arg_type.name))
@@ -99,6 +97,12 @@ class QAPISchemaTestVisitor(QAPISchemaVisitor):
         if ifcond:
             print('%sif %s' % (' ' * indent, ifcond))
 
+    @classmethod
+    def _print_features(cls, features):
+        if features:
+            for f in features:
+                print('    feature %s' % f.name)
+                cls._print_if(f.ifcond, 8)
 
 def test_frontend(fname):
     schema = QAPISchema(fname)
Signature · 1 line
2.21.0
#6 lore raw

Re: [PATCH v4 3/4] tests: qapi: Test 'features' of commands

Quoted 98 lines · Markus Armbruster

From: Peter Krempa <[email protected]>

---
 tests/test-qmp-cmds.c                   | 24 ++++++++++++++++++++++++
 tests/qapi-schema/qapi-schema-test.json | 22 ++++++++++++++++++++++
 tests/qapi-schema/qapi-schema-test.out  | 23 +++++++++++++++++++++++
 tests/qapi-schema/test-qapi.py          | 12 ++++++++----
 4 files changed, 77 insertions(+), 4 deletions(-)
tests/test-qmp-cmds.c +24 -0
index 36fdf5b115..ba623fda29 100644
@@ -51,6 +51,30 @@ void qmp_test_features(FeatureStruct0 *fs0, FeatureStruct1 *fs1,
 {
 }
 
+void qmp_test_command_features1(Error **errp)
+{
+}
+
+void qmp_test_command_features2(Error **errp)
+{
+}
+
+void qmp_test_command_features3(Error **errp)
+{
+}
+
+void qmp_test_command_features4(Error **errp)
+{
+}
+
+void qmp_test_command_features5(Error **errp)
+{
+}
+
+void qmp_test_command_features6(Error **errp)
+{
+}
+
 UserDefTwo *qmp_user_def_cmd2(UserDefOne *ud1a,
                               bool has_udb1, UserDefOne *ud1b,
                               Error **errp)
tests/qapi-schema/qapi-schema-test.json +22 -0
index 75c42eb0e3..80811dc8f0 100644
@@ -290,3 +290,25 @@
             'cfs1': 'CondFeatureStruct1',
             'cfs2': 'CondFeatureStruct2',
             'cfs3': 'CondFeatureStruct3' } }
+
+# test 'features' for command
+
+{ 'command': 'test-command-features1',
+  'features': [] }
+
+{ 'command': 'test-command-features2',
+  'features': [ 'feature1' ] }
+
+{ 'command': 'test-command-features3',
+  'features': [ 'feature1', 'feature2' ] }
+
+{ 'command': 'test-command-features4',
+  'features': [ { 'name': 'feature1', 'if': 'defined(TEST_IF_FEATURE_1)'} ] }
+
+{ 'command': 'test-command-features5',
+  'features': [ { 'name': 'feature1', 'if': 'defined(TEST_IF_FEATURE_1)'},
+                { 'name': 'feature2', 'if': 'defined(TEST_IF_FEATURE_2)'} ] }
+
+{ 'command': 'test-command-features6',
+  'features': [ { 'name': 'feature1', 'if': [ 'defined(TEST_IF_COND_1)',
+                                              'defined(TEST_IF_COND_2)'] } ] }
tests/qapi-schema/qapi-schema-test.out +13 -0
index aca43186a9..4061152cae 100644
@@ -412,3 +412,26 @@ object q_obj_test-features-arg
     member cfs3: CondFeatureStruct3 optional=False
 command test-features q_obj_test-features-arg -> None
     gen=True success_response=True boxed=False oob=False preconfig=False
+command test-command-features1 None -> None
+    gen=True success_response=True boxed=False oob=False preconfig=False
+command test-command-features2 None -> None
+    gen=True success_response=True boxed=False oob=False preconfig=False
+    feature feature1
+command test-command-features3 None -> None
+    gen=True success_response=True boxed=False oob=False preconfig=False
+    feature feature1
+    feature feature2
+command test-command-features4 None -> None
+    gen=True success_response=True boxed=False oob=False preconfig=False
+    feature feature1
+        if ['defined(TEST_IF_FEATURE_1)']

tests/qapi-schema/qapi-schema-test.out object q_obj_test-features-arg · line 437

Quoted 10 lines
tests/qapi-schema/qapi-schema-test.out +10 -0
+command test-command-features5 None -> None
+    gen=True success_response=True boxed=False oob=False preconfig=False
+    feature feature1
+        if ['defined(TEST_IF_FEATURE_1)']
+    feature feature2
+        if ['defined(TEST_IF_FEATURE_2)']
+command test-command-features6 None -> None
+    gen=True success_response=True boxed=False oob=False preconfig=False
+    feature feature1
+        if ['defined(TEST_IF_COND_1)', 'defined(TEST_IF_COND_2)']

This might border on OCD... Your new tests for commands are patterned after the existing tests for structs. You omit a few, and that's okay. I'd like the names of corresponding tests to match; see appended incremental patch.

[...]

tests/test-qmp-cmds.c +7 -7
index ba623fda29..27b0afe55a 100644
@@ -51,27 +51,27 @@ void qmp_test_features(FeatureStruct0 *fs0, FeatureStruct1 *fs1,
 {
 }
 
+void qmp_test_command_features0(Error **errp)
+{
+}
+
 void qmp_test_command_features1(Error **errp)
 {
 }
 
-void qmp_test_command_features2(Error **errp)
-{
-}
-
 void qmp_test_command_features3(Error **errp)
 {
 }
 
-void qmp_test_command_features4(Error **errp)
+void qmp_test_command_cond_features1(Error **errp)
 {
 }
 
-void qmp_test_command_features5(Error **errp)
+void qmp_test_command_cond_features2(Error **errp)
 {
 }
 
-void qmp_test_command_features6(Error **errp)
+void qmp_test_command_cond_features3(Error **errp)
 {
 }
 
tests/qapi-schema/qapi-schema-test.json +5 -9
index 80811dc8f0..9abf175fe0 100644
@@ -293,22 +293,18 @@
 
 # test 'features' for command
 
+{ 'command': 'test-command-features0',
+  'features': [] }
 { 'command': 'test-command-features1',
-  'features': [] }
-
-{ 'command': 'test-command-features2',
   'features': [ 'feature1' ] }
-
 { 'command': 'test-command-features3',
   'features': [ 'feature1', 'feature2' ] }
 
-{ 'command': 'test-command-features4',
+{ 'command': 'test-command-cond-features1',
   'features': [ { 'name': 'feature1', 'if': 'defined(TEST_IF_FEATURE_1)'} ] }
-
-{ 'command': 'test-command-features5',
+{ 'command': 'test-command-cond-features2',
   'features': [ { 'name': 'feature1', 'if': 'defined(TEST_IF_FEATURE_1)'},
                 { 'name': 'feature2', 'if': 'defined(TEST_IF_FEATURE_2)'} ] }
-
-{ 'command': 'test-command-features6',
+{ 'command': 'test-command-cond-features3',
   'features': [ { 'name': 'feature1', 'if': [ 'defined(TEST_IF_COND_1)',
                                               'defined(TEST_IF_COND_2)'] } ] }
tests/qapi-schema/qapi-schema-test.out +5 -5
index 4061152cae..3660e75a48 100644
@@ -412,26 +412,26 @@ object q_obj_test-features-arg
     member cfs3: CondFeatureStruct3 optional=False
 command test-features q_obj_test-features-arg -> None
     gen=True success_response=True boxed=False oob=False preconfig=False
+command test-command-features0 None -> None
+    gen=True success_response=True boxed=False oob=False preconfig=False
 command test-command-features1 None -> None
     gen=True success_response=True boxed=False oob=False preconfig=False
-command test-command-features2 None -> None
-    gen=True success_response=True boxed=False oob=False preconfig=False
     feature feature1
 command test-command-features3 None -> None
     gen=True success_response=True boxed=False oob=False preconfig=False
     feature feature1
     feature feature2
-command test-command-features4 None -> None
+command test-command-cond-features1 None -> None
     gen=True success_response=True boxed=False oob=False preconfig=False
     feature feature1
         if ['defined(TEST_IF_FEATURE_1)']
-command test-command-features5 None -> None
+command test-command-cond-features2 None -> None
     gen=True success_response=True boxed=False oob=False preconfig=False
     feature feature1
         if ['defined(TEST_IF_FEATURE_1)']
     feature feature2
         if ['defined(TEST_IF_FEATURE_2)']
-command test-command-features6 None -> None
+command test-command-cond-features3 None -> None
     gen=True success_response=True boxed=False oob=False preconfig=False
     feature feature1
         if ['defined(TEST_IF_COND_1)', 'defined(TEST_IF_COND_2)']
#7 lore raw

PATCH v4 4/4 qapi: Allow introspecting fix for savevm's cooperation with blockdev

In reply to Markus Armbruster

From: Peter Krempa <[email protected]>

'savevm' was buggy as it considered all monitor-owned block device nodes for snapshot. With the introduction of -blockdev, the common usage made all nodes including protocol and backing file nodes be 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.

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

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

Am 11.10.2019 um 10:50 hat Markus Armbruster geschrieben:

Quoted 30 lines

From: Peter Krempa <[email protected]>

'savevm' was buggy as it considered all monitor-owned block device nodes for snapshot. With the introduction of -blockdev, the common usage made all nodes including protocol and backing file nodes be 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.

---
 qapi/misc.json | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)
qapi/misc.json +0 -0
index 6bd11f50e6..35dca86ce7 100644

qapi/misc.json line 1024

Quoted 5 lines
qapi/misc.json +2 -0
@@ -1020,6 +1020,13 @@
 #
 # @cpu-index: The CPU to use for commands that require an implicit CPU
 #
+# Features:
+

I think you want a # in this empty line.

Quoted 9 lines
qapi/misc.json +5 -0
+# @savevm-monitor-nodes: If present, HMP command savevm only snapshots
+#                        monitor-owned nodes if they have no parents.
+#                        This allows the use of 'savevm' with
+#                        -blockdev. (since 4.2)
+#
 # Returns: the output of the command as a string
 #
 # Since: 0.14.0

qapi/misc.json line 1058

Quoted 6 lines
qapi/misc.json +2 -1
@@ -1047,7 +1054,8 @@
 ##
 { 'command': 'human-monitor-command',
   'data': {'command-line': 'str', '*cpu-index': 'int'},
-  'returns': 'str' }
+  'returns': 'str',
+  'features': [ 'savevm-monitor-nodes' ] }

With this fixed:

#9 lore raw

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

Quoted 26 lines · Kevin Wolf

Am 11.10.2019 um 10:50 hat Markus Armbruster geschrieben:

Quoted 25 lines

From: Peter Krempa <[email protected]>

'savevm' was buggy as it considered all monitor-owned block device nodes for snapshot. With the introduction of -blockdev, the common usage made all nodes including protocol and backing file nodes be 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.

---
 qapi/misc.json | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)
Quoted 12 lines

qapi/misc.json line 1024

Quoted 10 lines
qapi/misc.json +2 -0
index 6bd11f50e6..35dca86ce7 100644
@@ -1020,6 +1020,13 @@
 #
 # @cpu-index: The CPU to use for commands that require an implicit CPU
 #
+# Features:
+

I think you want a # in this empty line.

I'll delete the line instead, so the Features part looks like the one we already have in block-core.json.

Quoted 18 lines
Quoted 9 lines
qapi/misc.json +5 -0
+# @savevm-monitor-nodes: If present, HMP command savevm only snapshots
+#                        monitor-owned nodes if they have no parents.
+#                        This allows the use of 'savevm' with
+#                        -blockdev. (since 4.2)
+#
 # Returns: the output of the command as a string
 #
 # Since: 0.14.0

qapi/misc.json line 1058

Quoted 6 lines
qapi/misc.json +2 -1
@@ -1047,7 +1054,8 @@
 ##
 { 'command': 'human-monitor-command',
   'data': {'command-line': 'str', '*cpu-index': 'int'},
-  'returns': 'str' }
+  'returns': 'str',
+  'features': [ 'savevm-monitor-nodes' ] }

With this fixed:

Quoted 1 line

Thanks!

#10 lore raw
In reply to Markus Armbruster
Quoted 7 lines · Markus Armbruster

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

Based-on: <[email protected]>

Quoted 7 lines

v4:
- PATCH 1: New
- PATCH 2: Factor out check_features()
- PATCH 3: Factor out _print_features(), drop duplicated test
- PATCH 4: Shorten savevm-blockdev-monitor-nodes to just savevm-monitor-nodes; tweak commit message and documentation

Thanks for fixing the problems in 2-4, they all look good to me. Adding a reviewed-by in this case would not be appropriate.