From: Markus Armbruster <armbru@redhat.com>
To: Kashyap Chamarthy <kchamart@redhat.com>
Cc: kwolf@redhat.com, pkrempa@redhat.com, berrange@redhat.com,
ehabkost@redhat.com, qemu-block@nongnu.org, quintela@redhat.com,
libvir-list@redhat.com, qemu-devel@nongnu.org,
mdroth@linux.vnet.ibm.com, libguestfs@redhat.com,
marcandre.lureau@redhat.com, pbonzini@redhat.com,
eblake@redhat.com, dgilbert@redhat.com
Subject: Re: [PATCH 1/9] qapi: New special feature flag "unstable"
Date: Tue, 26 Oct 2021 09:15:30 +0200 [thread overview]
Message-ID: <87v91k6yul.fsf@dusky.pond.sub.org> (raw)
In-Reply-To: <YXadbMF3lj5I4+Cd@paraplu> (Kashyap Chamarthy's message of "Mon, 25 Oct 2021 14:05:00 +0200")
Kashyap Chamarthy <kchamart@redhat.com> writes:
> On Mon, Oct 25, 2021 at 07:25:24AM +0200, Markus Armbruster wrote:
>> By convention, names starting with "x-" are experimental. The parts
>> of external interfaces so named may be withdrawn or changed
>> incompatibly in future releases.
>>
>> Drawback: promoting something from experimental to stable involves a
>> name change. Client code needs to be updated.
>>
>> Moreover, the convention is not universally observed:
>>
>> * QOM type "input-barrier" has properties "x-origin", "y-origin".
>> Looks accidental, but it's ABI since 4.2.
>>
>> * QOM types "memory-backend-file", "memory-backend-memfd",
>> "memory-backend-ram", and "memory-backend-epc" have a property
>> "x-use-canonical-path-for-ramblock-id" that is documented to be
>> stable despite its name.
>
> Looks like there's another stable property with an "x-" prefix:
> "x-remote-object", part of QOM type @RemoteObjectProperties.
The union branch 'x-remote-object' isn't flagged 'unstable' (because
union branches can't have feature flags), but the enumeration value
'x-remote-object' is. Sufficient, because you can't use the branch
without using the enumeration value. Admittedly subtle.
I wrote a bit of code (appended) to make sure I don't miss names.
> Given the above "x-" properties are now stable, I take it that they
> cannot be renamed now, as they might break any tools using them? My
> guess is the tedious way is not worth it: deprecate them, and add the
> non-x variants as "synonyms".
"x-use-canonical-path-for-ramblock-id" goes back to commit fa0cb34d22
"hostmem: use object id for memory region name with >= 4.0" (v4.0). It
may have been intended to be internal back then. It wasn't anymore when
commit 8db0b20415 "machine: add missing doc for memory-backend option"
(v6.0) documented it:
And document that x-use-canonical-path-for-ramblock-id,
is considered to be stable to make sure it won't go away by accident.
x- was intended for unstable/iternal properties, and not supposed to
be stable option. However it's too late to rename (drop x-)
it as it would mean that users will have to mantain both
x-use-canonical-path-for-ramblock-id (for QEMU 5.0-5.2) versions
and prefix-less for later versions.
Igor's reasoning still applies.
"x-origin" has always been stable. Same argument.
>> We could document these exceptions, but documentation helps only
>> humans. We want to recognize "unstable" in code, like "deprecated".
>>
>> Replace the convention by a new special feature flag "unstable". It
>> will be recognized by the QAPI generator, like the existing feature
>> flag "deprecated", and unlike regular feature flags.
>
> FWIW, sounds good to me.
Thanks!
>> This commit updates documentation and prepares tests. The next commit
>> updates the QAPI schema. The remaining patches update the QAPI
>> generator and wire up -compat policy checking.
>>
>> Signed-off-by: Markus Armbruster <armbru@redhat.com>
>> ---
>> docs/devel/qapi-code-gen.rst | 9 ++++++---
>> tests/qapi-schema/qapi-schema-test.json | 7 +++++--
>> tests/qapi-schema/qapi-schema-test.out | 5 +++++
>> 3 files changed, 16 insertions(+), 5 deletions(-)
>
> [...]
commit 415b71a9f6e5bc37e84895d2e767cf4cfacd279b (HEAD)
Author: Markus Armbruster <armbru@redhat.com>
Date: Sat Oct 9 09:01:21 2021 +0200
qapi: Find x- without feature unstable DBG
diff --git a/scripts/qapi/schema.py b/scripts/qapi/schema.py
index b7b3fc0ce4..f2af1d7eea 100644
--- a/scripts/qapi/schema.py
+++ b/scripts/qapi/schema.py
@@ -14,6 +14,8 @@
# TODO catching name collisions in generated code would be nice
+import sys
+
from collections import OrderedDict
import os
import re
@@ -118,6 +120,11 @@ def describe(self):
return "%s '%s'" % (self.meta, self.name)
+def check_have_feature_unstable(name, info, features):
+ if name.startswith('x-') and 'unstable' not in (f.name for f in features):
+ print(QAPISemError(info, f"XXX %{name} %{features}"), file=sys.stderr)
+
+
class QAPISchemaVisitor:
def visit_begin(self, schema):
pass
@@ -718,6 +725,7 @@ def __init__(self, name, info, ifcond=None, features=None):
self.features = features or []
def connect_doc(self, doc):
+ check_have_feature_unstable(self.name, self.info, self.features)
super().connect_doc(doc)
if doc:
for f in self.features:
@@ -745,6 +753,7 @@ def __init__(self, name, info, typ, optional, ifcond=None, features=None):
self.features = features or []
def check(self, schema):
+ check_have_feature_unstable(self.name, self.info, self.features)
assert self.defined_in
self.type = schema.resolve_type(self._type_name, self.info,
self.describe)
@@ -789,6 +798,7 @@ def __init__(self, name, info, doc, ifcond, features,
def check(self, schema):
super().check(schema)
+ check_have_feature_unstable(self.name, self.info, self.features)
if self._arg_type_name:
self.arg_type = schema.resolve_type(
self._arg_type_name, self.info, "command's 'data'")
@@ -844,6 +854,7 @@ def __init__(self, name, info, doc, ifcond, features, arg_type, boxed):
def check(self, schema):
super().check(schema)
+ check_have_feature_unstable(self.name, self.info, self.features)
if self._arg_type_name:
self.arg_type = schema.resolve_type(
self._arg_type_name, self.info, "event's 'data'")
next prev parent reply other threads:[~2021-10-26 8:12 UTC|newest]
Thread overview: 58+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-10-25 5:25 [PATCH 0/9] Configurable policy for handling unstable interfaces Markus Armbruster
2021-10-25 5:25 ` [PATCH 1/9] qapi: New special feature flag "unstable" Markus Armbruster
2021-10-25 7:15 ` Juan Quintela
2021-10-25 12:05 ` Kashyap Chamarthy
2021-10-25 12:18 ` Philippe Mathieu-Daudé
2021-10-26 7:15 ` Markus Armbruster [this message]
2021-10-26 8:14 ` Kashyap Chamarthy
2021-10-25 19:01 ` John Snow
2021-10-26 5:35 ` Markus Armbruster
2021-10-26 7:37 ` Kevin Wolf
2021-10-26 8:36 ` [Libguestfs] " Kashyap Chamarthy
2021-10-26 9:22 ` Dr. David Alan Gilbert
2021-10-26 9:28 ` Daniel P. Berrangé
2021-10-26 9:37 ` Markus Armbruster
2021-10-26 11:34 ` Kevin Wolf
2021-10-28 8:36 ` Markus Armbruster
2021-10-26 14:56 ` Daniel P. Berrangé
2021-10-26 15:15 ` Markus Armbruster
2021-10-26 15:22 ` Daniel P. Berrangé
2021-10-27 5:29 ` Markus Armbruster
2021-10-25 5:25 ` [PATCH 2/9] qapi: Mark unstable QMP parts with feature 'unstable' Markus Armbruster
2021-10-25 7:16 ` Juan Quintela
2021-10-25 19:05 ` John Snow
2021-10-26 7:56 ` Markus Armbruster
2021-10-26 16:34 ` John Snow
2021-10-27 5:44 ` Markus Armbruster
2021-10-29 13:07 ` Eric Blake
2021-11-02 9:15 ` Kevin Wolf
2021-10-25 5:25 ` [PATCH 3/9] qapi: Eliminate QCO_NO_OPTIONS for a slight simplification Markus Armbruster
2021-10-25 7:17 ` Juan Quintela
2021-10-25 19:08 ` John Snow
2021-10-26 7:58 ` Markus Armbruster
2021-10-25 5:25 ` [PATCH 4/9] qapi: Tools for sets of special feature flags in generated code Markus Armbruster
2021-10-25 19:21 ` John Snow
2021-10-26 8:48 ` Markus Armbruster
2021-10-25 5:25 ` [PATCH 5/9] qapi: Generalize struct member policy checking Markus Armbruster
2021-10-25 19:28 ` John Snow
2021-10-26 9:14 ` Markus Armbruster
2021-10-26 15:43 ` Philippe Mathieu-Daudé
2021-10-27 5:56 ` Markus Armbruster
2021-10-25 5:25 ` [PATCH 6/9] qapi: Generalize command " Markus Armbruster
2021-10-25 12:04 ` Philippe Mathieu-Daudé
2021-10-26 9:40 ` Markus Armbruster
2021-10-25 19:30 ` John Snow
2021-10-25 5:25 ` [PATCH 7/9] qapi: Generalize enum member " Markus Armbruster
2021-10-25 19:36 ` John Snow
2021-10-26 9:43 ` Markus Armbruster
2021-10-26 16:14 ` John Snow
2021-10-25 5:25 ` [PATCH 8/9] qapi: Factor out compat_policy_input_ok() Markus Armbruster
2021-10-25 12:13 ` Philippe Mathieu-Daudé
2021-10-26 9:46 ` Markus Armbruster
2021-10-26 10:39 ` Philippe Mathieu-Daudé
2021-10-29 14:08 ` Markus Armbruster
2021-10-25 19:38 ` John Snow
2021-10-25 5:25 ` [PATCH 9/9] qapi: Extend -compat to set policy for unstable interfaces Markus Armbruster
2021-10-25 19:40 ` John Snow
2021-10-26 18:45 ` Dr. David Alan Gilbert
2021-10-27 5:59 ` Markus Armbruster
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87v91k6yul.fsf@dusky.pond.sub.org \
--to=armbru@redhat.com \
--cc=berrange@redhat.com \
--cc=dgilbert@redhat.com \
--cc=eblake@redhat.com \
--cc=ehabkost@redhat.com \
--cc=kchamart@redhat.com \
--cc=kwolf@redhat.com \
--cc=libguestfs@redhat.com \
--cc=libvir-list@redhat.com \
--cc=marcandre.lureau@redhat.com \
--cc=mdroth@linux.vnet.ibm.com \
--cc=pbonzini@redhat.com \
--cc=pkrempa@redhat.com \
--cc=qemu-block@nongnu.org \
--cc=qemu-devel@nongnu.org \
--cc=quintela@redhat.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).