* [Qemu-devel] [PATCH 1/9] qapi: Drop check_type()'s redundant parameter @allow_optional
2019-08-28 20:26 [Qemu-devel] [PATCH 0/9] qapi: Schema language cleanups & doc improvements Markus Armbruster
@ 2019-08-28 20:26 ` Markus Armbruster
2019-08-28 20:26 ` [Qemu-devel] [PATCH 2/9] qapi: Drop support for boxed alternate for commands, events Markus Armbruster
` (8 subsequent siblings)
9 siblings, 0 replies; 12+ messages in thread
From: Markus Armbruster @ 2019-08-28 20:26 UTC (permalink / raw)
To: qemu-devel; +Cc: mdroth
check_type() uses @allow_optional only when @value is a dictionary and
@allow_dict is True. All callers that pass allow_dict=True also pass
allow_optional=True.
Therefore, @allow_optional is always True when check_type() uses it.
Drop the redundant parameter.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
scripts/qapi/common.py | 17 ++++++++---------
1 file changed, 8 insertions(+), 9 deletions(-)
diff --git a/scripts/qapi/common.py b/scripts/qapi/common.py
index d61bfdc526..9aefcfe015 100644
--- a/scripts/qapi/common.py
+++ b/scripts/qapi/common.py
@@ -783,9 +783,8 @@ def check_if(expr, info):
check_if_str(ifcond, info)
-def check_type(info, source, value, allow_array=False,
- allow_dict=False, allow_optional=False,
- allow_metas=[]):
+def check_type(info, source, value,
+ allow_array=False, allow_dict=False, allow_metas=[]):
global all_names
if value is None:
@@ -821,7 +820,7 @@ def check_type(info, source, value, allow_array=False,
# value is a dictionary, check that each member is okay
for (key, arg) in value.items():
check_name(info, "Member of %s" % source, key,
- allow_optional=allow_optional)
+ allow_optional=True)
if c_name(key, False) == 'u' or c_name(key, False).startswith('has_'):
raise QAPISemError(info, "Member of %s uses reserved name '%s'"
% (source, key))
@@ -843,14 +842,14 @@ def check_command(expr, info):
if boxed:
args_meta += ['union', 'alternate']
check_type(info, "'data' for command '%s'" % name,
- expr.get('data'), allow_dict=not boxed, allow_optional=True,
+ expr.get('data'), allow_dict=not boxed,
allow_metas=args_meta)
returns_meta = ['union', 'struct']
if name in returns_whitelist:
returns_meta += ['built-in', 'alternate', 'enum']
check_type(info, "'returns' for command '%s'" % name,
expr.get('returns'), allow_array=True,
- allow_optional=True, allow_metas=returns_meta)
+ allow_metas=returns_meta)
def check_event(expr, info):
@@ -861,7 +860,7 @@ def check_event(expr, info):
if boxed:
meta += ['union', 'alternate']
check_type(info, "'data' for event '%s'" % name,
- expr.get('data'), allow_dict=not boxed, allow_optional=True,
+ expr.get('data'), allow_dict=not boxed,
allow_metas=meta)
@@ -889,7 +888,7 @@ def check_union(expr, info):
else:
# The object must have a string or dictionary 'base'.
check_type(info, "'base' for union '%s'" % name,
- base, allow_dict=True, allow_optional=True,
+ base, allow_dict=True,
allow_metas=['struct'])
if not base:
raise QAPISemError(info, "Flat union '%s' must have a base"
@@ -1012,7 +1011,7 @@ def check_struct(expr, info):
features = expr.get('features')
check_type(info, "'data' for struct '%s'" % name, members,
- allow_dict=True, allow_optional=True)
+ allow_dict=True)
check_type(info, "'base' for struct '%s'" % name, expr.get('base'),
allow_metas=['struct'])
--
2.21.0
^ permalink raw reply related [flat|nested] 12+ messages in thread* [Qemu-devel] [PATCH 2/9] qapi: Drop support for boxed alternate for commands, events
2019-08-28 20:26 [Qemu-devel] [PATCH 0/9] qapi: Schema language cleanups & doc improvements Markus Armbruster
2019-08-28 20:26 ` [Qemu-devel] [PATCH 1/9] qapi: Drop check_type()'s redundant parameter @allow_optional Markus Armbruster
@ 2019-08-28 20:26 ` Markus Armbruster
2019-08-30 12:44 ` Markus Armbruster
2019-08-28 20:26 ` [Qemu-devel] [PATCH 3/9] docs/devel/qapi-code-gen: Minor specification fixes Markus Armbruster
` (7 subsequent siblings)
9 siblings, 1 reply; 12+ messages in thread
From: Markus Armbruster @ 2019-08-28 20:26 UTC (permalink / raw)
To: qemu-devel; +Cc: mdroth
Commands and events can define their argument type inline (default) or
by referring to another type ('boxed': true, since commit c818408e44
"qapi: Implement boxed types for commands/events", v2.7.0). The
unboxed inline definition is an (anonymous) struct type. The boxed
type may be a struct, union, or alternate type.
The latter is problematic: docs/interop/qemu-spec.txt requires the
value of the 'data' key to be a json-object, but any non-degenerate
alternate type has at least one branch that isn't.
Fortunately, we haven't made use of alternates in this context outside
tests/. Drop support for them.
QAPISchemaAlternateType.is_empty() is now unused. Drop it, too.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
docs/devel/qapi-code-gen.txt | 12 ++++++------
tests/qapi-schema/qapi-schema-test.json | 2 +-
scripts/qapi/common.py | 7 ++-----
tests/qapi-schema/qapi-schema-test.out | 2 +-
4 files changed, 10 insertions(+), 13 deletions(-)
diff --git a/docs/devel/qapi-code-gen.txt b/docs/devel/qapi-code-gen.txt
index e8ec8ac1de..3d3931fb7a 100644
--- a/docs/devel/qapi-code-gen.txt
+++ b/docs/devel/qapi-code-gen.txt
@@ -612,9 +612,9 @@ the command. Normally, 'data' is a dictionary for an anonymous type,
or names a struct type (possibly empty, but not a union), and its
members are passed as separate arguments to this function. If the
command definition includes a key 'boxed' with the boolean value true,
-then 'data' is instead the name of any non-empty complex type
-(struct, union, or alternate), and a pointer to that QAPI type is
-passed as a single argument.
+then 'data' is instead the name of any non-empty complex type (struct
+or union), and a pointer to that QAPI type is passed as a single
+argument.
The generator also emits a marshalling function that extracts
arguments for the user's function out of an input QDict, calls the
@@ -714,9 +714,9 @@ The generator emits a function to send the event. Normally, 'data' is
a dictionary for an anonymous type, or names a struct type (possibly
empty, but not a union), and its members are passed as separate
arguments to this function. If the event definition includes a key
-'boxed' with the boolean value true, then 'data' is instead the name of
-any non-empty complex type (struct, union, or alternate), and a
-pointer to that QAPI type is passed as a single argument.
+'boxed' with the boolean value true, then 'data' is instead the name
+of any non-empty complex type (struct or union), and a pointer to that
+QAPI type is passed as a single argument.
=== Features ===
diff --git a/tests/qapi-schema/qapi-schema-test.json b/tests/qapi-schema/qapi-schema-test.json
index c6d59acc3e..0fadb4ddd7 100644
--- a/tests/qapi-schema/qapi-schema-test.json
+++ b/tests/qapi-schema/qapi-schema-test.json
@@ -180,7 +180,7 @@
{ 'event': 'EVENT_D',
'data': { 'a' : 'EventStructOne', 'b' : 'str', '*c': 'str', '*enum3': 'EnumOne' } }
{ 'event': 'EVENT_E', 'boxed': true, 'data': 'UserDefZero' }
-{ 'event': 'EVENT_F', 'boxed': true, 'data': 'UserDefAlternate' }
+{ 'event': 'EVENT_F', 'boxed': true, 'data': 'UserDefFlatUnion' }
# test that we correctly compile downstream extensions, as well as munge
# ticklish names
diff --git a/scripts/qapi/common.py b/scripts/qapi/common.py
index 9aefcfe015..c54c148263 100644
--- a/scripts/qapi/common.py
+++ b/scripts/qapi/common.py
@@ -840,7 +840,7 @@ def check_command(expr, info):
args_meta = ['struct']
if boxed:
- args_meta += ['union', 'alternate']
+ args_meta += ['union']
check_type(info, "'data' for command '%s'" % name,
expr.get('data'), allow_dict=not boxed,
allow_metas=args_meta)
@@ -858,7 +858,7 @@ def check_event(expr, info):
meta = ['struct']
if boxed:
- meta += ['union', 'alternate']
+ meta += ['union']
check_type(info, "'data' for event '%s'" % name,
expr.get('data'), allow_dict=not boxed,
allow_metas=meta)
@@ -1690,9 +1690,6 @@ class QAPISchemaAlternateType(QAPISchemaType):
visitor.visit_alternate_type(self.name, self.info, self.ifcond,
self.variants)
- def is_empty(self):
- return False
-
class QAPISchemaCommand(QAPISchemaEntity):
def __init__(self, name, info, doc, ifcond, arg_type, ret_type,
diff --git a/tests/qapi-schema/qapi-schema-test.out b/tests/qapi-schema/qapi-schema-test.out
index 85d510bc00..5470a525f5 100644
--- a/tests/qapi-schema/qapi-schema-test.out
+++ b/tests/qapi-schema/qapi-schema-test.out
@@ -252,7 +252,7 @@ event EVENT_D q_obj_EVENT_D-arg
boxed=False
event EVENT_E UserDefZero
boxed=True
-event EVENT_F UserDefAlternate
+event EVENT_F UserDefFlatUnion
boxed=True
enum __org.qemu_x-Enum
member __org.qemu_x-value
--
2.21.0
^ permalink raw reply related [flat|nested] 12+ messages in thread* Re: [Qemu-devel] [PATCH 2/9] qapi: Drop support for boxed alternate for commands, events
2019-08-28 20:26 ` [Qemu-devel] [PATCH 2/9] qapi: Drop support for boxed alternate for commands, events Markus Armbruster
@ 2019-08-30 12:44 ` Markus Armbruster
0 siblings, 0 replies; 12+ messages in thread
From: Markus Armbruster @ 2019-08-30 12:44 UTC (permalink / raw)
To: qemu-devel; +Cc: mdroth
Markus Armbruster <armbru@redhat.com> writes:
> Commands and events can define their argument type inline (default) or
> by referring to another type ('boxed': true, since commit c818408e44
> "qapi: Implement boxed types for commands/events", v2.7.0). The
> unboxed inline definition is an (anonymous) struct type. The boxed
> type may be a struct, union, or alternate type.
>
> The latter is problematic: docs/interop/qemu-spec.txt requires the
> value of the 'data' key to be a json-object, but any non-degenerate
> alternate type has at least one branch that isn't.
>
> Fortunately, we haven't made use of alternates in this context outside
> tests/. Drop support for them.
>
> QAPISchemaAlternateType.is_empty() is now unused. Drop it, too.
>
> Signed-off-by: Markus Armbruster <armbru@redhat.com>
Need to squash in
diff --git a/scripts/qapi/common.py b/scripts/qapi/common.py
index c54c148263..54d02458b5 100644
--- a/scripts/qapi/common.py
+++ b/scripts/qapi/common.py
@@ -1711,15 +1711,13 @@ class QAPISchemaCommand(QAPISchemaEntity):
QAPISchemaEntity.check(self, schema)
if self._arg_type_name:
self.arg_type = schema.lookup_type(self._arg_type_name)
- assert (isinstance(self.arg_type, QAPISchemaObjectType) or
- isinstance(self.arg_type, QAPISchemaAlternateType))
+ assert isinstance(self.arg_type, QAPISchemaObjectType)
self.arg_type.check(schema)
if self.boxed:
if self.arg_type.is_empty():
raise QAPISemError(self.info,
"Cannot use 'boxed' with empty type")
else:
- assert not isinstance(self.arg_type, QAPISchemaAlternateType)
assert not self.arg_type.variants
elif self.boxed:
raise QAPISemError(self.info, "Use of 'boxed' requires 'data'")
@@ -1747,15 +1745,13 @@ class QAPISchemaEvent(QAPISchemaEntity):
QAPISchemaEntity.check(self, schema)
if self._arg_type_name:
self.arg_type = schema.lookup_type(self._arg_type_name)
- assert (isinstance(self.arg_type, QAPISchemaObjectType) or
- isinstance(self.arg_type, QAPISchemaAlternateType))
+ assert isinstance(self.arg_type, QAPISchemaObjectType)
self.arg_type.check(schema)
if self.boxed:
if self.arg_type.is_empty():
raise QAPISemError(self.info,
"Cannot use 'boxed' with empty type")
else:
- assert not isinstance(self.arg_type, QAPISchemaAlternateType)
assert not self.arg_type.variants
elif self.boxed:
raise QAPISemError(self.info, "Use of 'boxed' requires 'data'")
> ---
> docs/devel/qapi-code-gen.txt | 12 ++++++------
> tests/qapi-schema/qapi-schema-test.json | 2 +-
> scripts/qapi/common.py | 7 ++-----
> tests/qapi-schema/qapi-schema-test.out | 2 +-
> 4 files changed, 10 insertions(+), 13 deletions(-)
>
> diff --git a/docs/devel/qapi-code-gen.txt b/docs/devel/qapi-code-gen.txt
> index e8ec8ac1de..3d3931fb7a 100644
> --- a/docs/devel/qapi-code-gen.txt
> +++ b/docs/devel/qapi-code-gen.txt
> @@ -612,9 +612,9 @@ the command. Normally, 'data' is a dictionary for an anonymous type,
> or names a struct type (possibly empty, but not a union), and its
> members are passed as separate arguments to this function. If the
> command definition includes a key 'boxed' with the boolean value true,
> -then 'data' is instead the name of any non-empty complex type
> -(struct, union, or alternate), and a pointer to that QAPI type is
> -passed as a single argument.
> +then 'data' is instead the name of any non-empty complex type (struct
> +or union), and a pointer to that QAPI type is passed as a single
> +argument.
>
> The generator also emits a marshalling function that extracts
> arguments for the user's function out of an input QDict, calls the
> @@ -714,9 +714,9 @@ The generator emits a function to send the event. Normally, 'data' is
> a dictionary for an anonymous type, or names a struct type (possibly
> empty, but not a union), and its members are passed as separate
> arguments to this function. If the event definition includes a key
> -'boxed' with the boolean value true, then 'data' is instead the name of
> -any non-empty complex type (struct, union, or alternate), and a
> -pointer to that QAPI type is passed as a single argument.
> +'boxed' with the boolean value true, then 'data' is instead the name
> +of any non-empty complex type (struct or union), and a pointer to that
> +QAPI type is passed as a single argument.
>
>
> === Features ===
> diff --git a/tests/qapi-schema/qapi-schema-test.json b/tests/qapi-schema/qapi-schema-test.json
> index c6d59acc3e..0fadb4ddd7 100644
> --- a/tests/qapi-schema/qapi-schema-test.json
> +++ b/tests/qapi-schema/qapi-schema-test.json
> @@ -180,7 +180,7 @@
> { 'event': 'EVENT_D',
> 'data': { 'a' : 'EventStructOne', 'b' : 'str', '*c': 'str', '*enum3': 'EnumOne' } }
> { 'event': 'EVENT_E', 'boxed': true, 'data': 'UserDefZero' }
> -{ 'event': 'EVENT_F', 'boxed': true, 'data': 'UserDefAlternate' }
> +{ 'event': 'EVENT_F', 'boxed': true, 'data': 'UserDefFlatUnion' }
>
> # test that we correctly compile downstream extensions, as well as munge
> # ticklish names
> diff --git a/scripts/qapi/common.py b/scripts/qapi/common.py
> index 9aefcfe015..c54c148263 100644
> --- a/scripts/qapi/common.py
> +++ b/scripts/qapi/common.py
> @@ -840,7 +840,7 @@ def check_command(expr, info):
>
> args_meta = ['struct']
> if boxed:
> - args_meta += ['union', 'alternate']
> + args_meta += ['union']
> check_type(info, "'data' for command '%s'" % name,
> expr.get('data'), allow_dict=not boxed,
> allow_metas=args_meta)
> @@ -858,7 +858,7 @@ def check_event(expr, info):
>
> meta = ['struct']
> if boxed:
> - meta += ['union', 'alternate']
> + meta += ['union']
> check_type(info, "'data' for event '%s'" % name,
> expr.get('data'), allow_dict=not boxed,
> allow_metas=meta)
> @@ -1690,9 +1690,6 @@ class QAPISchemaAlternateType(QAPISchemaType):
> visitor.visit_alternate_type(self.name, self.info, self.ifcond,
> self.variants)
>
> - def is_empty(self):
> - return False
> -
>
> class QAPISchemaCommand(QAPISchemaEntity):
> def __init__(self, name, info, doc, ifcond, arg_type, ret_type,
> diff --git a/tests/qapi-schema/qapi-schema-test.out b/tests/qapi-schema/qapi-schema-test.out
> index 85d510bc00..5470a525f5 100644
> --- a/tests/qapi-schema/qapi-schema-test.out
> +++ b/tests/qapi-schema/qapi-schema-test.out
> @@ -252,7 +252,7 @@ event EVENT_D q_obj_EVENT_D-arg
> boxed=False
> event EVENT_E UserDefZero
> boxed=True
> -event EVENT_F UserDefAlternate
> +event EVENT_F UserDefFlatUnion
> boxed=True
> enum __org.qemu_x-Enum
> member __org.qemu_x-value
^ permalink raw reply related [flat|nested] 12+ messages in thread
* [Qemu-devel] [PATCH 3/9] docs/devel/qapi-code-gen: Minor specification fixes
2019-08-28 20:26 [Qemu-devel] [PATCH 0/9] qapi: Schema language cleanups & doc improvements Markus Armbruster
2019-08-28 20:26 ` [Qemu-devel] [PATCH 1/9] qapi: Drop check_type()'s redundant parameter @allow_optional Markus Armbruster
2019-08-28 20:26 ` [Qemu-devel] [PATCH 2/9] qapi: Drop support for boxed alternate for commands, events Markus Armbruster
@ 2019-08-28 20:26 ` Markus Armbruster
2019-08-28 20:26 ` [Qemu-devel] [PATCH 4/9] qapi: Outlaw control characters in strings Markus Armbruster
` (6 subsequent siblings)
9 siblings, 0 replies; 12+ messages in thread
From: Markus Armbruster @ 2019-08-28 20:26 UTC (permalink / raw)
To: qemu-devel; +Cc: mdroth
The specification claims "Each expression that isn't an include
directive may be preceded by a documentation block", but the code also
rejects them for pragma directives. The code is correct. Fix the
specification.
The specification claims "The string 'max' is not allowed as an enum
value". Untrue. Fix the specification. While there, delete the
naming advice, because it's redundant with the naming rules in section
"Schema overview"
The specification claims "No branch of the union can be named 'max',
as this would collide with the implicit enum". Untrue. Fix the
specification.
The specification claims "It is not allowed to name an event 'MAX',
since the generator also produces a C enumeration of all event names
with a generated _MAX value at the end." Untrue. Fix the
specification.
The specification claims "All branches of the union must be complex
types", but the code permits only struct types. The code is correct.
Fix the specification.
The specification claims a command's return type "must be the string
name of a complex or built-in type, a one-element array containing the
name of a complex or built-in type" unless the command is in pragma
'returns-whitelist'. The code does not permit built-in types. Fix
the specification.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
docs/devel/qapi-code-gen.txt | 35 ++++++++++++++++-------------------
1 file changed, 16 insertions(+), 19 deletions(-)
diff --git a/docs/devel/qapi-code-gen.txt b/docs/devel/qapi-code-gen.txt
index 3d3931fb7a..0373c1322c 100644
--- a/docs/devel/qapi-code-gen.txt
+++ b/docs/devel/qapi-code-gen.txt
@@ -117,9 +117,9 @@ Example:
==== Expression documentation ====
-Each expression that isn't an include directive may be preceded by a
-documentation block. Such blocks are called expression documentation
-blocks.
+Expressions other than include and pragma directives may be preceded
+by a documentation block. Such blocks are called expression
+documentation blocks.
When documentation is required (see pragma 'doc-required'), expression
documentation blocks are mandatory.
@@ -398,10 +398,10 @@ whose value is a list of strings. An example enumeration is:
{ 'enum': 'MyEnum', 'data': [ 'value1', 'value2', 'value3' ] }
+The strings must be distinct.
+
Nothing prevents an empty enumeration, although it is probably not
-useful. The list of strings should be lower case; if an enum name
-represents multiple words, use '-' between words. The string 'max' is
-not allowed as an enum value, and values should not be repeated.
+useful.
The enum constants will be named by using a heuristic to turn the
type name into a set of underscore separated words. For the example
@@ -460,15 +460,14 @@ discriminator value, as in these examples:
The generated C code uses a struct containing a union. Additionally,
an implicit C enum 'NameKind' is created, corresponding to the union
-'Name', for accessing the various branches of the union. No branch of
-the union can be named 'max', as this would collide with the implicit
-enum. The value for each branch can be of any type.
+'Name', for accessing the various branches of the union. The value
+for each branch can be of any type.
A flat union definition avoids nesting on the wire, and specifies a
set of common members that occur in all variants of the union. The
'base' key must specify either a type name (the type must be a
struct, not a union), or a dictionary representing an anonymous type.
-All branches of the union must be complex types, and the top-level
+All branches of the union must be struct types, and the top-level
members of the union dictionary on the wire will be combination of
members from both the base type and the appropriate branch type (when
merging two dictionaries, there must be no keys in common). The
@@ -578,8 +577,8 @@ The 'returns' member describes what will appear in the "return" member
of a Client JSON Protocol reply on successful completion of a command.
The member is optional from the command declaration; if absent, the
"return" member will be an empty dictionary. If 'returns' is present,
-it must be the string name of a complex or built-in type, a
-one-element array containing the name of a complex or built-in type.
+it must be the string name of a complex type, or a
+one-element array containing the name of a complex.
To return anything else, you have to list the command in pragma
'returns-whitelist'. If you do this, the command cannot be extended
to return additional information in the future. Use of
@@ -691,13 +690,11 @@ started with --preconfig.
Usage: { 'event': STRING, '*data': COMPLEX-TYPE-NAME-OR-DICT,
'*boxed': true }
-Events are defined with the keyword 'event'. It is not allowed to
-name an event 'MAX', since the generator also produces a C enumeration
-of all event names with a generated _MAX value at the end. When
-'data' is also specified, additional info will be included in the
-event, with similar semantics to a 'struct' expression. Finally there
-will be C API generated in qapi-events.h; when called by QEMU code, a
-message with timestamp will be emitted on the wire.
+Events are defined with the keyword 'event'. When 'data' is also
+specified, additional info will be included in the event, with similar
+semantics to a 'struct' expression. Finally there will be C API
+generated in qapi-events.h; when called by QEMU code, a message with
+timestamp will be emitted on the wire.
An example event is:
--
2.21.0
^ permalink raw reply related [flat|nested] 12+ messages in thread* [Qemu-devel] [PATCH 4/9] qapi: Outlaw control characters in strings
2019-08-28 20:26 [Qemu-devel] [PATCH 0/9] qapi: Schema language cleanups & doc improvements Markus Armbruster
` (2 preceding siblings ...)
2019-08-28 20:26 ` [Qemu-devel] [PATCH 3/9] docs/devel/qapi-code-gen: Minor specification fixes Markus Armbruster
@ 2019-08-28 20:26 ` Markus Armbruster
2019-08-28 20:26 ` [Qemu-devel] [PATCH 5/9] tests/qapi-schema: Consistently name string tests string-FOO Markus Armbruster
` (5 subsequent siblings)
9 siblings, 0 replies; 12+ messages in thread
From: Markus Armbruster @ 2019-08-28 20:26 UTC (permalink / raw)
To: qemu-devel; +Cc: mdroth
RFC 8259 on string contents:
All Unicode characters may be placed within the quotation marks,
except for the characters that MUST be escaped: quotation mark,
reverse solidus, and the control characters (U+0000 through
U+001F).
The QAPI schema parser accepts both less and more than JSON: it
accepts only ASCII (less), and accepts control characters other than
LF (new line) unescaped.
Make it accept strictly less: require control characters to be
escaped. All of them, even DEL, because treating DEL different than
other control characters feels wrong.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
tests/qapi-schema/string-control.json | 2 ++
scripts/qapi/common.py | 3 +++
tests/Makefile.include | 1 +
tests/qapi-schema/string-control.err | 1 +
tests/qapi-schema/string-control.exit | 1 +
tests/qapi-schema/string-control.out | 0
6 files changed, 8 insertions(+)
create mode 100644 tests/qapi-schema/string-control.json
create mode 100644 tests/qapi-schema/string-control.err
create mode 100644 tests/qapi-schema/string-control.exit
create mode 100644 tests/qapi-schema/string-control.out
diff --git a/tests/qapi-schema/string-control.json b/tests/qapi-schema/string-control.json
new file mode 100644
index 0000000000..a14be4659a
--- /dev/null
+++ b/tests/qapi-schema/string-control.json
@@ -0,0 +1,2 @@
+# control characters in strings
+{ 'command': '\x7f\f' }
diff --git a/scripts/qapi/common.py b/scripts/qapi/common.py
index c54c148263..d8c47ac2ac 100644
--- a/scripts/qapi/common.py
+++ b/scripts/qapi/common.py
@@ -564,6 +564,9 @@ class QAPISchemaParser(object):
elif ch == "'":
self.val = string
return
+ elif ord(ch) < 32 or ch == '\x7f':
+ raise QAPIParseError(self,
+ 'Control character in string')
else:
string += ch
elif self.src.startswith('true', self.pos):
diff --git a/tests/Makefile.include b/tests/Makefile.include
index 49684fd4f4..543bac6f93 100644
--- a/tests/Makefile.include
+++ b/tests/Makefile.include
@@ -452,6 +452,7 @@ qapi-schema += returns-array-bad.json
qapi-schema += returns-dict.json
qapi-schema += returns-unknown.json
qapi-schema += returns-whitelist.json
+qapi-schema += string-control.json
qapi-schema += struct-base-clash-deep.json
qapi-schema += struct-base-clash.json
qapi-schema += struct-data-invalid.json
diff --git a/tests/qapi-schema/string-control.err b/tests/qapi-schema/string-control.err
new file mode 100644
index 0000000000..30a9d57d57
--- /dev/null
+++ b/tests/qapi-schema/string-control.err
@@ -0,0 +1 @@
+tests/qapi-schema/string-control.json:2:14: Control character in string
diff --git a/tests/qapi-schema/string-control.exit b/tests/qapi-schema/string-control.exit
new file mode 100644
index 0000000000..d00491fd7e
--- /dev/null
+++ b/tests/qapi-schema/string-control.exit
@@ -0,0 +1 @@
+1
diff --git a/tests/qapi-schema/string-control.out b/tests/qapi-schema/string-control.out
new file mode 100644
index 0000000000..e69de29bb2
--
2.21.0
^ permalink raw reply related [flat|nested] 12+ messages in thread* [Qemu-devel] [PATCH 5/9] tests/qapi-schema: Consistently name string tests string-FOO
2019-08-28 20:26 [Qemu-devel] [PATCH 0/9] qapi: Schema language cleanups & doc improvements Markus Armbruster
` (3 preceding siblings ...)
2019-08-28 20:26 ` [Qemu-devel] [PATCH 4/9] qapi: Outlaw control characters in strings Markus Armbruster
@ 2019-08-28 20:26 ` Markus Armbruster
2019-08-28 20:26 ` [Qemu-devel] [PATCH 6/9] docs/devel/qapi-code-gen: Reorder sections for readability Markus Armbruster
` (4 subsequent siblings)
9 siblings, 0 replies; 12+ messages in thread
From: Markus Armbruster @ 2019-08-28 20:26 UTC (permalink / raw)
To: qemu-devel; +Cc: mdroth
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
.../{unclosed-string.json => string-unclosed.json} | 0
tests/qapi-schema/{unicode-str.json => string-unicode.json} | 0
tests/Makefile.include | 4 ++--
tests/qapi-schema/string-unclosed.err | 1 +
.../{unclosed-string.exit => string-unclosed.exit} | 0
.../qapi-schema/{unclosed-string.out => string-unclosed.out} | 0
tests/qapi-schema/string-unicode.err | 1 +
tests/qapi-schema/{unicode-str.exit => string-unicode.exit} | 0
tests/qapi-schema/{unicode-str.out => string-unicode.out} | 0
tests/qapi-schema/unclosed-string.err | 1 -
tests/qapi-schema/unicode-str.err | 1 -
11 files changed, 4 insertions(+), 4 deletions(-)
rename tests/qapi-schema/{unclosed-string.json => string-unclosed.json} (100%)
rename tests/qapi-schema/{unicode-str.json => string-unicode.json} (100%)
create mode 100644 tests/qapi-schema/string-unclosed.err
rename tests/qapi-schema/{unclosed-string.exit => string-unclosed.exit} (100%)
rename tests/qapi-schema/{unclosed-string.out => string-unclosed.out} (100%)
create mode 100644 tests/qapi-schema/string-unicode.err
rename tests/qapi-schema/{unicode-str.exit => string-unicode.exit} (100%)
rename tests/qapi-schema/{unicode-str.out => string-unicode.out} (100%)
delete mode 100644 tests/qapi-schema/unclosed-string.err
delete mode 100644 tests/qapi-schema/unicode-str.err
diff --git a/tests/qapi-schema/unclosed-string.json b/tests/qapi-schema/string-unclosed.json
similarity index 100%
rename from tests/qapi-schema/unclosed-string.json
rename to tests/qapi-schema/string-unclosed.json
diff --git a/tests/qapi-schema/unicode-str.json b/tests/qapi-schema/string-unicode.json
similarity index 100%
rename from tests/qapi-schema/unicode-str.json
rename to tests/qapi-schema/string-unicode.json
diff --git a/tests/Makefile.include b/tests/Makefile.include
index 543bac6f93..af1baca936 100644
--- a/tests/Makefile.include
+++ b/tests/Makefile.include
@@ -453,6 +453,8 @@ qapi-schema += returns-dict.json
qapi-schema += returns-unknown.json
qapi-schema += returns-whitelist.json
qapi-schema += string-control.json
+qapi-schema += string-unclosed.json
+qapi-schema += string-unicode.json
qapi-schema += struct-base-clash-deep.json
qapi-schema += struct-base-clash.json
qapi-schema += struct-data-invalid.json
@@ -463,8 +465,6 @@ qapi-schema += trailing-comma-object.json
qapi-schema += type-bypass-bad-gen.json
qapi-schema += unclosed-list.json
qapi-schema += unclosed-object.json
-qapi-schema += unclosed-string.json
-qapi-schema += unicode-str.json
qapi-schema += union-base-empty.json
qapi-schema += union-base-no-discriminator.json
qapi-schema += union-branch-case.json
diff --git a/tests/qapi-schema/string-unclosed.err b/tests/qapi-schema/string-unclosed.err
new file mode 100644
index 0000000000..bc6c00a0ec
--- /dev/null
+++ b/tests/qapi-schema/string-unclosed.err
@@ -0,0 +1 @@
+tests/qapi-schema/string-unclosed.json:1:11: Missing terminating "'"
diff --git a/tests/qapi-schema/unclosed-string.exit b/tests/qapi-schema/string-unclosed.exit
similarity index 100%
rename from tests/qapi-schema/unclosed-string.exit
rename to tests/qapi-schema/string-unclosed.exit
diff --git a/tests/qapi-schema/unclosed-string.out b/tests/qapi-schema/string-unclosed.out
similarity index 100%
rename from tests/qapi-schema/unclosed-string.out
rename to tests/qapi-schema/string-unclosed.out
diff --git a/tests/qapi-schema/string-unicode.err b/tests/qapi-schema/string-unicode.err
new file mode 100644
index 0000000000..9a1bb0bc22
--- /dev/null
+++ b/tests/qapi-schema/string-unicode.err
@@ -0,0 +1 @@
+tests/qapi-schema/string-unicode.json:2: 'command' uses invalid name 'é'
diff --git a/tests/qapi-schema/unicode-str.exit b/tests/qapi-schema/string-unicode.exit
similarity index 100%
rename from tests/qapi-schema/unicode-str.exit
rename to tests/qapi-schema/string-unicode.exit
diff --git a/tests/qapi-schema/unicode-str.out b/tests/qapi-schema/string-unicode.out
similarity index 100%
rename from tests/qapi-schema/unicode-str.out
rename to tests/qapi-schema/string-unicode.out
diff --git a/tests/qapi-schema/unclosed-string.err b/tests/qapi-schema/unclosed-string.err
deleted file mode 100644
index 12b187074e..0000000000
--- a/tests/qapi-schema/unclosed-string.err
+++ /dev/null
@@ -1 +0,0 @@
-tests/qapi-schema/unclosed-string.json:1:11: Missing terminating "'"
diff --git a/tests/qapi-schema/unicode-str.err b/tests/qapi-schema/unicode-str.err
deleted file mode 100644
index f621cd6448..0000000000
--- a/tests/qapi-schema/unicode-str.err
+++ /dev/null
@@ -1 +0,0 @@
-tests/qapi-schema/unicode-str.json:2: 'command' uses invalid name 'é'
--
2.21.0
^ permalink raw reply related [flat|nested] 12+ messages in thread* [Qemu-devel] [PATCH 6/9] docs/devel/qapi-code-gen: Reorder sections for readability
2019-08-28 20:26 [Qemu-devel] [PATCH 0/9] qapi: Schema language cleanups & doc improvements Markus Armbruster
` (4 preceding siblings ...)
2019-08-28 20:26 ` [Qemu-devel] [PATCH 5/9] tests/qapi-schema: Consistently name string tests string-FOO Markus Armbruster
@ 2019-08-28 20:26 ` Markus Armbruster
2019-08-28 20:26 ` [Qemu-devel] [PATCH 7/9] docs/devel/qapi-code-gen: Rewrite compatibility considerations Markus Armbruster
` (3 subsequent siblings)
9 siblings, 0 replies; 12+ messages in thread
From: Markus Armbruster @ 2019-08-28 20:26 UTC (permalink / raw)
To: qemu-devel; +Cc: mdroth
Section "QMP/Guest agent schema" starts with a brief introduction,
then subsection "Comments", then subsection "Schema overview" (more
elaborate introduction), and only then talks about schema entities
like types, commands, and so forth.
Subsection "Comments" is long and tiring: almost 500 words, mostly
about doc comments. Move the doc comment part to its own subsection
"Documentation comments" at the very end of "QMP/Guest agent schema".
Subsection "Schema overview" explains naming rules at considerable
length: 250 words. Move this part to its own subsection "Naming rules
and reserved names" right after the subsections on schema entities.
Subsection "Enumeration types" is wedged between "Struct types" and
"Union types". Move it before "Struct types".
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
docs/devel/qapi-code-gen.txt | 434 ++++++++++++++++++-----------------
1 file changed, 220 insertions(+), 214 deletions(-)
diff --git a/docs/devel/qapi-code-gen.txt b/docs/devel/qapi-code-gen.txt
index 0373c1322c..ca9915e5f0 100644
--- a/docs/devel/qapi-code-gen.txt
+++ b/docs/devel/qapi-code-gen.txt
@@ -50,147 +50,6 @@ schema requires the use of JSON numbers or null.
Comments are allowed; anything between an unquoted # and the following
newline is ignored.
-A multi-line comment that starts and ends with a '##' line is a
-documentation comment. These are parsed by the documentation
-generator, which recognizes certain markup detailed below.
-
-
-==== Documentation markup ====
-
-Comment text starting with '=' is a section title:
-
- # = Section title
-
-Double the '=' for a subsection title:
-
- # == Subsection title
-
-'|' denotes examples:
-
- # | Text of the example, may span
- # | multiple lines
-
-'*' starts an itemized list:
-
- # * First item, may span
- # multiple lines
- # * Second item
-
-You can also use '-' instead of '*'.
-
-A decimal number followed by '.' starts a numbered list:
-
- # 1. First item, may span
- # multiple lines
- # 2. Second item
-
-The actual number doesn't matter. You could even use '*' instead of
-'2.' for the second item.
-
-Lists can't be nested. Blank lines are currently not supported within
-lists.
-
-Additional whitespace between the initial '#' and the comment text is
-permitted.
-
-*foo* and _foo_ are for strong and emphasis styles respectively (they
-do not work over multiple lines). @foo is used to reference a name in
-the schema.
-
-Example:
-
-##
-# = Section
-# == Subsection
-#
-# Some text foo with *strong* and _emphasis_
-# 1. with a list
-# 2. like that
-#
-# And some code:
-# | $ echo foo
-# | -> do this
-# | <- get that
-#
-##
-
-
-==== Expression documentation ====
-
-Expressions other than include and pragma directives may be preceded
-by a documentation block. Such blocks are called expression
-documentation blocks.
-
-When documentation is required (see pragma 'doc-required'), expression
-documentation blocks are mandatory.
-
-The documentation block consists of a first line naming the
-expression, an optional overview, a description of each argument (for
-commands and events) or member (for structs, unions and alternates),
-and optional tagged sections.
-
-FIXME: the parser accepts these things in almost any order.
-
-Extensions added after the expression was first released carry a
-'(since x.y.z)' comment.
-
-A tagged section starts with one of the following words:
-"Note:"/"Notes:", "Since:", "Example"/"Examples", "Returns:", "TODO:".
-The section ends with the start of a new section.
-
-A 'Since: x.y.z' tagged section lists the release that introduced the
-expression.
-
-For example:
-
-##
-# @BlockStats:
-#
-# Statistics of a virtual block device or a block backing device.
-#
-# @device: If the stats are for a virtual block device, the name
-# corresponding to the virtual block device.
-#
-# @node-name: The node name of the device. (since 2.3)
-#
-# ... more members ...
-#
-# Since: 0.14.0
-##
-{ 'struct': 'BlockStats',
- 'data': {'*device': 'str', '*node-name': 'str',
- ... more members ... } }
-
-##
-# @query-blockstats:
-#
-# Query the @BlockStats for all virtual block devices.
-#
-# @query-nodes: If true, the command will query all the
-# block nodes ... explain, explain ... (since 2.3)
-#
-# Returns: A list of @BlockStats for each virtual block devices.
-#
-# Since: 0.14.0
-#
-# Example:
-#
-# -> { "execute": "query-blockstats" }
-# <- {
-# ... lots of output ...
-# }
-#
-##
-{ 'command': 'query-blockstats',
- 'data': { '*query-nodes': 'bool' },
- 'returns': ['BlockStats'] }
-
-==== Free-form documentation ====
-
-A documentation block that isn't an expression documentation block is
-a free-form documentation block. These may be used to provide
-additional text and structuring content.
-
=== Schema overview ===
@@ -217,42 +76,6 @@ refers to a single-dimension array of that type; multi-dimension
arrays are not directly supported (although an array of a complex
struct that contains an array member is possible).
-All names must begin with a letter, and contain only ASCII letters,
-digits, hyphen, and underscore. There are two exceptions: enum values
-may start with a digit, and names that are downstream extensions (see
-section Downstream extensions) start with underscore.
-
-Names beginning with 'q_' are reserved for the generator, which uses
-them for munging QMP names that resemble C keywords or other
-problematic strings. For example, a member named "default" in qapi
-becomes "q_default" in the generated C code.
-
-Types, commands, and events share a common namespace. Therefore,
-generally speaking, type definitions should always use CamelCase for
-user-defined type names, while built-in types are lowercase.
-
-Type names ending with 'Kind' or 'List' are reserved for the
-generator, which uses them for implicit union enums and array types,
-respectively.
-
-Command names, and member names within a type, should be all lower
-case with words separated by a hyphen. However, some existing older
-commands and complex types use underscore; when extending such
-expressions, consistency is preferred over blindly avoiding
-underscore.
-
-Event names should be ALL_CAPS with words separated by underscore.
-
-Member names starting with 'has-' or 'has_' are reserved for the
-generator, which uses them for tracking optional members.
-
-Any name (command, event, type, member, or enum value) beginning with
-"x-" is marked experimental, and may be withdrawn or changed
-incompatibly in a future release.
-
-Pragma 'name-case-whitelist' lets you violate the rules on use of
-upper and lower case. Use for new code is strongly discouraged.
-
In the rest of this document, usage lines are given for each
expression type, with literal strings written in lower case and
placeholders written in capitals. If a literal string includes a
@@ -327,6 +150,43 @@ Pragma 'name-case-whitelist' takes a list of names that may violate
rules on use of upper- vs. lower-case letters. Default is none.
+=== Enumeration types ===
+
+Usage: { 'enum': STRING, 'data': ARRAY-OF-STRING }
+ { 'enum': STRING, '*prefix': STRING, 'data': ARRAY-OF-STRING }
+
+An enumeration type is a dictionary containing a single 'data' key
+whose value is a list of strings. An example enumeration is:
+
+ { 'enum': 'MyEnum', 'data': [ 'value1', 'value2', 'value3' ] }
+
+The strings must be distinct.
+
+Nothing prevents an empty enumeration, although it is probably not
+useful.
+
+The enum constants will be named by using a heuristic to turn the
+type name into a set of underscore separated words. For the example
+above, 'MyEnum' will turn into 'MY_ENUM' giving a constant name
+of 'MY_ENUM_VALUE1' for the first value. If the default heuristic
+does not result in a desirable name, the optional 'prefix' member
+can be used when defining the enum.
+
+The enumeration values are passed as strings over the Client JSON
+Protocol, but are encoded as C enum integral values in generated code.
+While the C code starts numbering at 0, it is better to use explicit
+comparisons to enum values than implicit comparisons to 0; the C code
+will also include a generated enum member ending in _MAX for tracking
+the size of the enum, useful when using common functions for
+converting between strings and enum values. Since the wire format
+always passes by name, it is acceptable to reorder or add new
+enumeration members in any location without breaking clients of Client
+JSON Protocol; however, removing enum values would break
+compatibility. For any struct that has a member that will only contain
+a finite set of string values, using an enum type for that member is
+better than open-coding the member to be type 'str'.
+
+
=== Struct types ===
Usage: { 'struct': STRING, 'data': DICT, '*base': STRUCT-NAME }
@@ -388,43 +248,6 @@ both members like this:
"backing": "/some/place/my-backing-file" }
-=== Enumeration types ===
-
-Usage: { 'enum': STRING, 'data': ARRAY-OF-STRING }
- { 'enum': STRING, '*prefix': STRING, 'data': ARRAY-OF-STRING }
-
-An enumeration type is a dictionary containing a single 'data' key
-whose value is a list of strings. An example enumeration is:
-
- { 'enum': 'MyEnum', 'data': [ 'value1', 'value2', 'value3' ] }
-
-The strings must be distinct.
-
-Nothing prevents an empty enumeration, although it is probably not
-useful.
-
-The enum constants will be named by using a heuristic to turn the
-type name into a set of underscore separated words. For the example
-above, 'MyEnum' will turn into 'MY_ENUM' giving a constant name
-of 'MY_ENUM_VALUE1' for the first value. If the default heuristic
-does not result in a desirable name, the optional 'prefix' member
-can be used when defining the enum.
-
-The enumeration values are passed as strings over the Client JSON
-Protocol, but are encoded as C enum integral values in generated code.
-While the C code starts numbering at 0, it is better to use explicit
-comparisons to enum values than implicit comparisons to 0; the C code
-will also include a generated enum member ending in _MAX for tracking
-the size of the enum, useful when using common functions for
-converting between strings and enum values. Since the wire format
-always passes by name, it is acceptable to reorder or add new
-enumeration members in any location without breaking clients of Client
-JSON Protocol; however, removing enum values would break
-compatibility. For any struct that has a member that will only contain
-a finite set of string values, using an enum type for that member is
-better than open-coding the member to be type 'str'.
-
-
=== Union types ===
Usage: { 'union': STRING, 'data': DICT }
@@ -744,6 +567,45 @@ This expanded form is necessary if you want to make the feature
conditional (see below in "Configuring the schema").
+=== Naming rules and reserved names ===
+
+All names must begin with a letter, and contain only ASCII letters,
+digits, hyphen, and underscore. There are two exceptions: enum values
+may start with a digit, and names that are downstream extensions (see
+section Downstream extensions) start with underscore.
+
+Names beginning with 'q_' are reserved for the generator, which uses
+them for munging QMP names that resemble C keywords or other
+problematic strings. For example, a member named "default" in qapi
+becomes "q_default" in the generated C code.
+
+Types, commands, and events share a common namespace. Therefore,
+generally speaking, type definitions should always use CamelCase for
+user-defined type names, while built-in types are lowercase.
+
+Type names ending with 'Kind' or 'List' are reserved for the
+generator, which uses them for implicit union enums and array types,
+respectively.
+
+Command names, and member names within a type, should be all lower
+case with words separated by a hyphen. However, some existing older
+commands and complex types use underscore; when extending such
+expressions, consistency is preferred over blindly avoiding
+underscore.
+
+Event names should be ALL_CAPS with words separated by underscore.
+
+Member names starting with 'has-' or 'has_' are reserved for the
+generator, which uses them for tracking optional members.
+
+Any name (command, event, type, member, or enum value) beginning with
+"x-" is marked experimental, and may be withdrawn or changed
+incompatibly in a future release.
+
+Pragma 'name-case-whitelist' lets you violate the rules on use of
+upper and lower case. Use for new code is strongly discouraged.
+
+
=== Downstream extensions ===
QAPI schema names that are externally visible, say in the Client JSON
@@ -814,6 +676,150 @@ The presence of 'if' keys in the schema is reflected through to the
introspection output depending on the build configuration.
+=== Documentation comments ===
+
+A multi-line comment that starts and ends with a '##' line is a
+documentation comment. These are parsed by the documentation
+generator, which recognizes certain markup detailed below.
+
+
+==== Documentation markup ====
+
+Comment text starting with '=' is a section title:
+
+ # = Section title
+
+Double the '=' for a subsection title:
+
+ # == Subsection title
+
+'|' denotes examples:
+
+ # | Text of the example, may span
+ # | multiple lines
+
+'*' starts an itemized list:
+
+ # * First item, may span
+ # multiple lines
+ # * Second item
+
+You can also use '-' instead of '*'.
+
+A decimal number followed by '.' starts a numbered list:
+
+ # 1. First item, may span
+ # multiple lines
+ # 2. Second item
+
+The actual number doesn't matter. You could even use '*' instead of
+'2.' for the second item.
+
+Lists can't be nested. Blank lines are currently not supported within
+lists.
+
+Additional whitespace between the initial '#' and the comment text is
+permitted.
+
+*foo* and _foo_ are for strong and emphasis styles respectively (they
+do not work over multiple lines). @foo is used to reference a name in
+the schema.
+
+Example:
+
+##
+# = Section
+# == Subsection
+#
+# Some text foo with *strong* and _emphasis_
+# 1. with a list
+# 2. like that
+#
+# And some code:
+# | $ echo foo
+# | -> do this
+# | <- get that
+#
+##
+
+
+==== Expression documentation ====
+
+Expressions other than include and pragma directives may be preceded
+by a documentation block. Such blocks are called expression
+documentation blocks.
+
+When documentation is required (see pragma 'doc-required'), expression
+documentation blocks are mandatory.
+
+The documentation block consists of a first line naming the
+expression, an optional overview, a description of each argument (for
+commands and events) or member (for structs, unions and alternates),
+and optional tagged sections.
+
+FIXME: the parser accepts these things in almost any order.
+
+Extensions added after the expression was first released carry a
+'(since x.y.z)' comment.
+
+A tagged section starts with one of the following words:
+"Note:"/"Notes:", "Since:", "Example"/"Examples", "Returns:", "TODO:".
+The section ends with the start of a new section.
+
+A 'Since: x.y.z' tagged section lists the release that introduced the
+expression.
+
+For example:
+
+##
+# @BlockStats:
+#
+# Statistics of a virtual block device or a block backing device.
+#
+# @device: If the stats are for a virtual block device, the name
+# corresponding to the virtual block device.
+#
+# @node-name: The node name of the device. (since 2.3)
+#
+# ... more members ...
+#
+# Since: 0.14.0
+##
+{ 'struct': 'BlockStats',
+ 'data': {'*device': 'str', '*node-name': 'str',
+ ... more members ... } }
+
+##
+# @query-blockstats:
+#
+# Query the @BlockStats for all virtual block devices.
+#
+# @query-nodes: If true, the command will query all the
+# block nodes ... explain, explain ... (since 2.3)
+#
+# Returns: A list of @BlockStats for each virtual block devices.
+#
+# Since: 0.14.0
+#
+# Example:
+#
+# -> { "execute": "query-blockstats" }
+# <- {
+# ... lots of output ...
+# }
+#
+##
+{ 'command': 'query-blockstats',
+ 'data': { '*query-nodes': 'bool' },
+ 'returns': ['BlockStats'] }
+
+==== Free-form documentation ====
+
+A documentation block that isn't an expression documentation block is
+a free-form documentation block. These may be used to provide
+additional text and structuring content.
+
+
== Client JSON Protocol introspection ==
Clients of a Client JSON Protocol commonly need to figure out what
--
2.21.0
^ permalink raw reply related [flat|nested] 12+ messages in thread* [Qemu-devel] [PATCH 7/9] docs/devel/qapi-code-gen: Rewrite compatibility considerations
2019-08-28 20:26 [Qemu-devel] [PATCH 0/9] qapi: Schema language cleanups & doc improvements Markus Armbruster
` (5 preceding siblings ...)
2019-08-28 20:26 ` [Qemu-devel] [PATCH 6/9] docs/devel/qapi-code-gen: Reorder sections for readability Markus Armbruster
@ 2019-08-28 20:26 ` Markus Armbruster
2019-08-28 20:26 ` [Qemu-devel] [PATCH 8/9] docs/devel/qapi-code-gen: Rewrite introduction to schema Markus Armbruster
` (2 subsequent siblings)
9 siblings, 0 replies; 12+ messages in thread
From: Markus Armbruster @ 2019-08-28 20:26 UTC (permalink / raw)
To: qemu-devel; +Cc: mdroth
We have some compatibility advice buried in sections "Enumeration
types" and "Struct types". Compatibility is actually about commands
and events. It devolves to the types used there. All kinds of types,
not just enumerations and structs.
Replace the existing advice by a new section "Compatibility
considerations".
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
docs/devel/qapi-code-gen.txt | 95 +++++++++++++++++++++++-------------
1 file changed, 60 insertions(+), 35 deletions(-)
diff --git a/docs/devel/qapi-code-gen.txt b/docs/devel/qapi-code-gen.txt
index ca9915e5f0..5c9146c92e 100644
--- a/docs/devel/qapi-code-gen.txt
+++ b/docs/devel/qapi-code-gen.txt
@@ -178,14 +178,11 @@ While the C code starts numbering at 0, it is better to use explicit
comparisons to enum values than implicit comparisons to 0; the C code
will also include a generated enum member ending in _MAX for tracking
the size of the enum, useful when using common functions for
-converting between strings and enum values. Since the wire format
-always passes by name, it is acceptable to reorder or add new
-enumeration members in any location without breaking clients of Client
-JSON Protocol; however, removing enum values would break
-compatibility. For any struct that has a member that will only contain
-a finite set of string values, using an enum type for that member is
-better than open-coding the member to be type 'str'.
+converting between strings and enum values.
+For any struct that has a member that will only contain a finite set
+of string values, using an enum type for that member is better than
+open-coding the member to be type 'str'.
=== Struct types ===
@@ -203,34 +200,6 @@ name. An example of a struct is:
The use of '*' as a prefix to the name means the member is optional in
the corresponding JSON protocol usage.
-The default initialization value of an optional argument should not be changed
-between versions of QEMU unless the new default maintains backward
-compatibility to the user-visible behavior of the old default.
-
-With proper documentation, this policy still allows some flexibility; for
-example, documenting that a default of 0 picks an optimal buffer size allows
-one release to declare the optimal size at 512 while another release declares
-the optimal size at 4096 - the user-visible behavior is not the bytes used by
-the buffer, but the fact that the buffer was optimal size.
-
-On input structures (only mentioned in the 'data' side of a command), changing
-from mandatory to optional is safe (older clients will supply the option, and
-newer clients can benefit from the default); changing from optional to
-mandatory is backwards incompatible (older clients may be omitting the option,
-and must continue to work).
-
-On output structures (only mentioned in the 'returns' side of a command),
-changing from mandatory to optional is in general unsafe (older clients may be
-expecting the member, and could crash if it is missing), although it
-can be done if the only way that the optional argument will be omitted
-is when it is triggered by the presence of a new input flag to the
-command that older clients don't know to send. Changing from optional
-to mandatory is safe.
-
-A structure that is used in both input and output of various commands
-must consider the backwards compatibility constraints of both directions
-of use.
-
A struct definition can specify another struct as its base.
In this case, the members of the base type are included as top-level members
of the new struct's dictionary in the Client JSON Protocol wire
@@ -1037,6 +1006,62 @@ the names of built-in types. Clients should examine member
"json-type" instead of hard-coding names of built-in types.
+== Compatibility considerations ==
+
+Maintaining backward compatibility at the Client JSON Protocol level
+while evolving the schema requires some care. This section is about
+syntactic compatibility. Necessary, but not sufficient for actual
+compatibility.
+
+Clients send commands with argument data, and receive command
+responses with return data and events with event data.
+
+Adding opt-in functionality to the send direction is backwards
+compatible: adding commands, optional arguments, enumeration values,
+union and alternate branches; turning an argument type into an
+alternate of that type; making mandatory arguments optional. Clients
+oblivious of the new functionality continue to work.
+
+Incompatible changes include removing commands, command arguments,
+enumeration values, union and alternate branches, adding mandatory
+command arguments, and making optional arguments mandatory.
+
+The specified behavior of an absent optional argument should remain
+the same. With proper documentation, this policy still allows some
+flexibility; for example, when an optional 'buffer-size' argument is
+specified to default to a sensible buffer size, the actual default
+value can still be changed. The specified default behavior is not the
+exact size of the buffer, only that the default size is sensible.
+
+Adding functionality to the receive direction is generally backwards
+compatible: adding events, adding return and event data members.
+Clients are expected to ignore the ones they don't know.
+
+Removing "unreachable" stuff like events that can't be triggered
+anymore, optional return or event data members that can't be sent
+anymore, and return or event data member (enumeration) values that
+can't be sent anymore makes no difference to clients, except for
+introspection. The latter can conceivably confuse clients, so tread
+carefully.
+
+Incompatible changes include removing return and event data members.
+
+Any change to a command definition's 'data' or one of the types used
+there (recursively) needs to consider send direction compatibility.
+
+Any change to a command definition's 'return', an event definition's
+'data', or one of the types used there (recursively) needs to consider
+receive direction compatibility.
+
+Any change to types used in both contexts need to consider both.
+
+Members of enumeration types, complex types and alternate types may be
+reordered freely. For enumerations and alternate types, this doesn't
+affect the wire encoding. For complex types, this might make the
+implementation emit JSON object members in a different order, which
+the Client JSON Protocol permits.
+
+
== Code generation ==
The QAPI code generator qapi-gen.py generates code and documentation
--
2.21.0
^ permalink raw reply related [flat|nested] 12+ messages in thread* [Qemu-devel] [PATCH 8/9] docs/devel/qapi-code-gen: Rewrite introduction to schema
2019-08-28 20:26 [Qemu-devel] [PATCH 0/9] qapi: Schema language cleanups & doc improvements Markus Armbruster
` (6 preceding siblings ...)
2019-08-28 20:26 ` [Qemu-devel] [PATCH 7/9] docs/devel/qapi-code-gen: Rewrite compatibility considerations Markus Armbruster
@ 2019-08-28 20:26 ` Markus Armbruster
2019-08-28 20:26 ` [Qemu-devel] [PATCH 9/9] docs/devel/qapi-code-gen: Improve QAPI schema language doc Markus Armbruster
2019-08-28 21:42 ` [Qemu-devel] [PATCH 0/9] qapi: Schema language cleanups & doc improvements no-reply
9 siblings, 0 replies; 12+ messages in thread
From: Markus Armbruster @ 2019-08-28 20:26 UTC (permalink / raw)
To: qemu-devel; +Cc: mdroth
The introduction to the QAPI schema is somewhat rambling. Rewrite for
clarity.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
docs/devel/qapi-code-gen.txt | 106 ++++++++++++++++-------------------
1 file changed, 47 insertions(+), 59 deletions(-)
diff --git a/docs/devel/qapi-code-gen.txt b/docs/devel/qapi-code-gen.txt
index 5c9146c92e..4502502531 100644
--- a/docs/devel/qapi-code-gen.txt
+++ b/docs/devel/qapi-code-gen.txt
@@ -16,65 +16,53 @@ well as the QEMU Guest Agent (QGA) for communicating with the guest.
The remainder of this document uses "Client JSON Protocol" when
referring to the wire contents of a QMP or QGA connection.
-To map Client JSON Protocol interfaces to the native C QAPI
-implementations, a JSON-based schema is used to define types and
-function signatures, and a set of scripts is used to generate types,
-signatures, and marshaling/dispatch code. This document will describe
-how the schemas, scripts, and resulting code are used.
-
-
-== QMP/Guest agent schema ==
-
-A QAPI schema file is designed to be loosely based on JSON
-(http://www.ietf.org/rfc/rfc8259.txt) with changes for quoting style
-and the use of comments; a QAPI schema file is then parsed by a python
-code generation program. A valid QAPI schema consists of a series of
-top-level expressions, with no commas between them. Where
-dictionaries (JSON objects) are used, they are parsed as python
-OrderedDicts so that ordering is preserved (for predictable layout of
-generated C structs and parameter lists). Ordering doesn't matter
-between top-level expressions or the keys within an expression, but
-does matter within dictionary values for 'data' and 'returns' members
-of a single expression. QAPI schema input is written using 'single
-quotes' instead of JSON's "double quotes" (in contrast, Client JSON
-Protocol uses no comments, and while input accepts 'single quotes' as
-an extension, output is strict JSON using only "double quotes"). As
-in JSON, trailing commas are not permitted in arrays or dictionaries.
-Input must be ASCII (although QMP supports full Unicode strings, the
-QAPI parser does not). At present, there is no place where a QAPI
-schema requires the use of JSON numbers or null.
-
-
-=== Comments ===
-
-Comments are allowed; anything between an unquoted # and the following
-newline is ignored.
-
-
-=== Schema overview ===
-
-The schema sets up a series of types, as well as commands and events
-that will use those types. Forward references are allowed: the parser
-scans in two passes, where the first pass learns all type names, and
-the second validates the schema and generates the code. This allows
-the definition of complex structs that can have mutually recursive
-types, and allows for indefinite nesting of Client JSON Protocol that
-satisfies the schema. A type name should not be defined more than
-once. It is permissible for the schema to contain additional types
-not used by any commands or events in the Client JSON Protocol, for
-the side effect of generated C code used internally.
-
-There are eight top-level expressions recognized by the parser:
-'include', 'pragma', 'command', 'struct', 'enum', 'union',
-'alternate', and 'event'. There are several groups of types: simple
-types (a number of built-in types, such as 'int' and 'str'; as well as
-enumerations), complex types (structs and two flavors of unions), and
-alternate types (a choice between other types). The 'command' and
-'event' expressions can refer to existing types by name, or list an
-anonymous type as a dictionary. Listing a type name inside an array
-refers to a single-dimension array of that type; multi-dimension
-arrays are not directly supported (although an array of a complex
-struct that contains an array member is possible).
+To map between Client JSON Protocol interfaces and the native C API,
+we generate C code from a QAPI schema. This document describes the
+QAPI schema language, and how it gets mapped to the Client JSON
+Protocol and to C. It additionally provides guidance on maintaining
+Client JSON Protocol compatibility.
+
+
+== The QAPI schema language ==
+
+The QAPI schema defines the Client JSON Protocol's commands and
+events, as well as types used by them. Forward references are
+allowed.
+
+It is permissible for the schema to contain additional types not used
+by any commands or events, for the side effect of generated C code
+used internally.
+
+There are several kinds of types: simple types (a number of built-in
+types, such as 'int' and 'str'; as well as enumerations), arrays,
+complex types (structs and two flavors of unions), and alternate types
+(a choice between other types).
+
+
+=== Schema syntax ===
+
+Syntax is loosely based on JSON (http://www.ietf.org/rfc/rfc8259.txt).
+Differences:
+
+* Comments: start with a hash character (#) that is not part of a
+ string, and extend to the end of the line.
+
+* Strings are enclosed in 'single quotes', not "double quotes".
+
+* Strings are restricted to ASCII. All control characters must be
+ escaped, even DEL.
+
+* Numbers are not supported.
+
+A QAPI schema consists of a series of top-level expressions (JSON
+objects). Their order does not matter.
+
+The order of keys within JSON objects does not matter unless
+explicitly noted.
+
+There are eight kinds of top-level expressions: 'include', 'pragma',
+'command', 'struct', 'enum', 'union', 'alternate', and 'event'. These
+are discussed in detail below.
In the rest of this document, usage lines are given for each
expression type, with literal strings written in lower case and
--
2.21.0
^ permalink raw reply related [flat|nested] 12+ messages in thread* [Qemu-devel] [PATCH 9/9] docs/devel/qapi-code-gen: Improve QAPI schema language doc
2019-08-28 20:26 [Qemu-devel] [PATCH 0/9] qapi: Schema language cleanups & doc improvements Markus Armbruster
` (7 preceding siblings ...)
2019-08-28 20:26 ` [Qemu-devel] [PATCH 8/9] docs/devel/qapi-code-gen: Rewrite introduction to schema Markus Armbruster
@ 2019-08-28 20:26 ` Markus Armbruster
2019-08-28 21:42 ` [Qemu-devel] [PATCH 0/9] qapi: Schema language cleanups & doc improvements no-reply
9 siblings, 0 replies; 12+ messages in thread
From: Markus Armbruster @ 2019-08-28 20:26 UTC (permalink / raw)
To: qemu-devel; +Cc: mdroth
We document the language by giving patterns of valid JSON objects.
The patterns contain placeholders we don't define anywhere; their
names have to speak for themselves. I guess they do, but I'd prefer a
bit more rigor. Provide a grammar instead, and rework the text
accordingly.
Documentation for QAPI schema conditionals (commit 967c885108,
6cc32b0e14, 87adbbffd4..3e270dcacc) and feature flags (commit
6a8c0b5102) was bolted on. The sections documenting types, commands
and events don't mention them. Section "Features" and "Configuring
the schema" then provide additional syntax for types, commands and
events. I hate that. Fix the sections documenting types, commands
and events to provide accurate syntax, and point to "Features" and
"Configuring the schema" for details.
While there, make spacing more consistent, and avoid the terms
"dictionary" and "key". Stick to JSON terminology "object" and
"member name" instead.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
docs/devel/qapi-code-gen.txt | 528 ++++++++++++++++++++++-------------
1 file changed, 330 insertions(+), 198 deletions(-)
diff --git a/docs/devel/qapi-code-gen.txt b/docs/devel/qapi-code-gen.txt
index 4502502531..495ef15215 100644
--- a/docs/devel/qapi-code-gen.txt
+++ b/docs/devel/qapi-code-gen.txt
@@ -4,12 +4,12 @@ Copyright IBM Corp. 2011
Copyright (C) 2012-2016 Red Hat, Inc.
This work is licensed under the terms of the GNU GPL, version 2 or
-later. See the COPYING file in the top-level directory.
+later. See the COPYING file in the top-level directory.
== Introduction ==
QAPI is a native C API within QEMU which provides management-level
-functionality to internal and external users. For external
+functionality to internal and external users. For external
users/processes, this interface is made available by a JSON-based wire
format for the QEMU Monitor Protocol (QMP) for controlling qemu, as
well as the QEMU Guest Agent (QGA) for communicating with the guest.
@@ -54,23 +54,42 @@ Differences:
* Numbers are not supported.
-A QAPI schema consists of a series of top-level expressions (JSON
-objects). Their order does not matter.
+A second layer of syntax defines the sequences of JSON texts that are
+a correctly structured QAPI schema. We provide a grammar for this
+syntax in an EBNF-like notation:
-The order of keys within JSON objects does not matter unless
+* Production rules look like non-terminal = expression
+* Concatenation: Expression A B matches expression A, then B
+* Alternation: Expression A | B matches expression A or B
+* Repetition: Expression A... matches zero or more occurences of
+ expression A; expression A, ... likewise, but separated by ,
+* JSON's six structural characters are terminals: { } [ ] : ,
+* JSON's three literal names are terminals: false true null
+* String literals enclosed in 'single quotes' are terminal, and match
+ this JSON string, with a leading '*' stripped off
+* When JSON object member's name starts with '*', the member is
+ optional.
+* The symbol STRING is a terminal, and matches any JSON string
+* The symbol BOOL is a terminal, and matches JSON false or true
+* ALL-CAPS words other than STRING are non-terminals
+
+The order of members within JSON objects does not matter unless
explicitly noted.
-There are eight kinds of top-level expressions: 'include', 'pragma',
-'command', 'struct', 'enum', 'union', 'alternate', and 'event'. These
-are discussed in detail below.
-
-In the rest of this document, usage lines are given for each
-expression type, with literal strings written in lower case and
-placeholders written in capitals. If a literal string includes a
-prefix of '*', that key/value pair can be omitted from the expression.
-For example, a usage statement that includes '*base':STRUCT-NAME
-means that an expression has an optional key 'base', which if present
-must have a value that forms a struct name.
+A QAPI schema consists of a series of top-level expressions:
+
+ SCHEMA = EXPRESSION...
+
+The top-level expressions are all JSON objects. Their order does not
+matter.
+
+There are eight kinds of top-level expressions:
+
+ EXPRESSION = INCLUDE | PRAGMA
+ | ENUM | STRUCT | UNION | ALTERNATE
+ | COMMAND | EVENT
+
+These are discussed in detail below.
=== Built-in Types ===
@@ -100,16 +119,17 @@ The following types are predefined, and map to C as follows:
=== Include directives ===
-Usage: { 'include': STRING }
+Syntax:
+ INCLUDE = { 'include': STRING }
The QAPI schema definitions can be modularized using the 'include' directive:
{ 'include': 'path/to/file.json' }
-The directive is evaluated recursively, and include paths are relative to the
-file using the directive. Multiple includes of the same file are
-idempotent. No other keys should appear in the expression, and the include
-value should be a string.
+The directive is evaluated recursively, and include paths are relative
+to the file using the directive. Multiple includes of the same file
+are idempotent. No other members should appear in the expression, and
+the include value should be a string.
As a matter of style, it is a good idea to have all files be
self-contained, but at the moment, nothing prevents an included file
@@ -120,10 +140,12 @@ prevent incomplete include files.
=== Pragma directives ===
-Usage: { 'pragma': DICT }
+Syntax:
+ PRAGMA = { 'pragma': { '*doc-required': BOOL },
+ '*returns-whitelist': [ STRING, ... ],
+ '*name-case-whitelist': [ STRING, ... ] }
The pragma directive lets you control optional generator behavior.
-The dictionary's entries are pragma names and values.
Pragma's scope is currently the complete schema. Setting the same
pragma to different values in parts of the schema doesn't work.
@@ -140,60 +162,95 @@ rules on use of upper- vs. lower-case letters. Default is none.
=== Enumeration types ===
-Usage: { 'enum': STRING, 'data': ARRAY-OF-STRING }
- { 'enum': STRING, '*prefix': STRING, 'data': ARRAY-OF-STRING }
+Syntax:
+ ENUM = { 'enum': STRING,
+ 'data': [ ENUM-VALUE, ... ],
+ '*prefix': STRING,
+ '*if': COND }
+ ENUM-VALUE = STRING
+ | { 'name': STRING, '*if': COND }
-An enumeration type is a dictionary containing a single 'data' key
-whose value is a list of strings. An example enumeration is:
+Member 'enum' names the enum type.
+
+Each member of the 'data' array defines a value of the enumeration
+type. The form STRING is shorthand for { 'name': STRING }. The
+'name' values must be be distinct.
+
+Example:
{ 'enum': 'MyEnum', 'data': [ 'value1', 'value2', 'value3' ] }
-The strings must be distinct.
-
Nothing prevents an empty enumeration, although it is probably not
useful.
-The enum constants will be named by using a heuristic to turn the
-type name into a set of underscore separated words. For the example
-above, 'MyEnum' will turn into 'MY_ENUM' giving a constant name
-of 'MY_ENUM_VALUE1' for the first value. If the default heuristic
-does not result in a desirable name, the optional 'prefix' member
-can be used when defining the enum.
-
-The enumeration values are passed as strings over the Client JSON
-Protocol, but are encoded as C enum integral values in generated code.
-While the C code starts numbering at 0, it is better to use explicit
-comparisons to enum values than implicit comparisons to 0; the C code
-will also include a generated enum member ending in _MAX for tracking
-the size of the enum, useful when using common functions for
-converting between strings and enum values.
-
-For any struct that has a member that will only contain a finite set
-of string values, using an enum type for that member is better than
-open-coding the member to be type 'str'.
+On the wire, an enumeration type's value is represented by its
+(string) name. In C, it's represented by an enumeration constant.
+These are of the form PREFIX_NAME, where PREFIX is derived from the
+enumeration type's name, and NAME from the value's name. For the
+example above, the generator maps 'MyEnum' to MY_ENUM and 'value1' to
+VALUE1, resulting in the enumeration constant MY_ENUM_VALUE1. The
+optional 'prefix' member overrides PREFIX.
+
+The generated C enumeration constants have values 0, 1, ..., N-1 (in
+QAPI schema order), where N is the number of values. There is an
+additional enumeration constant PREFIX__MAX with value N.
+
+Do not use string or an integer type when an enumeration type can do
+the job satisfactorily.
+
+The optional 'if' member specifies a conditional. See "Configuring
+the schema" below for more on this.
+
+
+=== Type references and array types ===
+
+Syntax:
+ TYPE-REF = STRING | ARRAY-TYPE
+ ARRAY-TYPE = [ STRING ]
+
+A string denotes the type named by the string.
+
+A one-element array containing a string denotes an array of the type
+named by the string. Example: ['int'] denotes an array of 'int'.
+
=== Struct types ===
-Usage: { 'struct': STRING, 'data': DICT, '*base': STRUCT-NAME }
+Syntax:
+ STRUCT = { 'struct': STRING,
+ 'data': MEMBERS,
+ '*base': STRING,
+ '*if': COND,
+ '*features': FEATURES }
+ MEMBERS = { MEMBER, ... }
+ MEMBER = STRING : TYPE-REF
+ | STRING : { 'type': TYPE-REF, '*if': COND }
-A struct is a dictionary containing a single 'data' key whose value is
-a dictionary; the dictionary may be empty. This corresponds to a
-struct in C or an Object in JSON. Each value of the 'data' dictionary
-must be the name of a type, or a one-element array containing a type
-name. An example of a struct is:
+Member 'struct' names the struct type.
+
+Each MEMBER of the 'data' object defines a member of the struct type.
+
+The MEMBER's STRING name consists of an optional '*' prefix and the
+struct member name. If '*' is present, the member is optional.
+
+The MEMBER's value defines its properties, in particular its type.
+The form TYPE-REF is shorthand for { 'type': TYPE-REF }.
+
+Example:
{ 'struct': 'MyType',
- 'data': { 'member1': 'str', 'member2': 'int', '*member3': 'str' } }
+ 'data': { 'member1': 'str', 'member2': ['int'], '*member3': 'str' } }
-The use of '*' as a prefix to the name means the member is optional in
-the corresponding JSON protocol usage.
+A struct type corresponds to a struct in C, and an object in JSON.
+The C struct's members are generated in QAPI schema order.
-A struct definition can specify another struct as its base.
-In this case, the members of the base type are included as top-level members
-of the new struct's dictionary in the Client JSON Protocol wire
-format. An example definition is:
+The optional 'base' member names a struct type whose members are to be
+included in this type. They go first in the C struct.
- { 'struct': 'BlockdevOptionsGenericFormat', 'data': { 'file': 'str' } }
+Example:
+
+ { 'struct': 'BlockdevOptionsGenericFormat',
+ 'data': { 'file': 'str' } }
{ 'struct': 'BlockdevOptionsGenericCOWFormat',
'base': 'BlockdevOptionsGenericFormat',
'data': { '*backing': 'str' } }
@@ -204,19 +261,40 @@ both members like this:
{ "file": "/some/place/my-image",
"backing": "/some/place/my-backing-file" }
+The optional 'if' member specifies a conditional. See "Configuring
+the schema" below for more on this.
+
+The optional 'features' member specifies features. See "Features"
+below for more on this.
+
=== Union types ===
-Usage: { 'union': STRING, 'data': DICT }
-or: { 'union': STRING, 'data': DICT, 'base': STRUCT-NAME-OR-DICT,
- 'discriminator': ENUM-MEMBER-OF-BASE }
-
-Union types are used to let the user choose between several different
-variants for an object. There are two flavors: simple (no
-discriminator or base), and flat (both discriminator and base). A union
-type is defined using a data dictionary as explained in the following
-paragraphs. The data dictionary for either type of union must not
-be empty.
+Syntax:
+ UNION = { 'union': STRING,
+ 'data': BRANCHES,
+ '*if': COND }
+ | { 'union': STRING,
+ 'data': BRANCHES,
+ 'base': ( MEMBERS | STRING ),
+ 'discriminator': STRING,
+ '*if': COND }
+ BRANCHES = { BRANCH, ... }
+ BRANCH = STRING : TYPE-REF
+ | STRING : { 'type': TYPE-REF, '*if': COND }
+
+Member 'union' names the union type.
+
+There are two flavors of union types: simple (no discriminator or
+base), and flat (both discriminator and base).
+
+Each BRANCH of the 'data' object defines a branch of the union. A
+union must have at least one branch.
+
+The BRANCH's STRING name is the branch name.
+
+The BRANCH's value defines the branch's properties, in particular its
+type. The form TYPE-REF is shorthand for { 'type': TYPE-REF }.
A simple union type defines a mapping from automatic discriminator
values to data types like in this example:
@@ -229,8 +307,8 @@ values to data types like in this example:
'data': { 'file': 'BlockdevOptionsFile',
'qcow2': 'BlockdevOptionsQcow2' } }
-In the Client JSON Protocol, a simple union is represented by a
-dictionary that contains the 'type' member as a discriminator, and a
+In the Client JSON Protocol, a simple union is represented by an
+object that contains the 'type' member as a discriminator, and a
'data' member that is of the specified data type corresponding to the
discriminator value, as in these examples:
@@ -238,21 +316,27 @@ discriminator value, as in these examples:
{ "type": "qcow2", "data": { "backing": "/some/place/my-image",
"lazy-refcounts": true } }
-The generated C code uses a struct containing a union. Additionally,
+The generated C code uses a struct containing a union. Additionally,
an implicit C enum 'NameKind' is created, corresponding to the union
'Name', for accessing the various branches of the union. The value
for each branch can be of any type.
-A flat union definition avoids nesting on the wire, and specifies a
-set of common members that occur in all variants of the union. The
-'base' key must specify either a type name (the type must be a
-struct, not a union), or a dictionary representing an anonymous type.
-All branches of the union must be struct types, and the top-level
-members of the union dictionary on the wire will be combination of
-members from both the base type and the appropriate branch type (when
-merging two dictionaries, there must be no keys in common). The
-'discriminator' member must be the name of a non-optional enum-typed
-member of the base struct.
+Flat unions permit arbitrary common members that occur in all variants
+of the union, not just a discriminator. Their discriminators need not
+be named 'type'. They also avoid nesting on the wire.
+
+The 'base' member defines the common members. If it is a MEMBERS
+object, it defines common members just like a struct type's 'data'
+member defines struct type members. If it is a STRING, it names a
+struct type whose members are the common members.
+
+All flat union branches must be of struct type.
+
+In the Client JSON Protocol, a flat union is represented by an object
+with the common members (from the base type) and the selected branch's
+members. The two sets of member names must be disjoint. Member
+'discriminator' must name a non-optional enum-typed member of the base
+struct.
The following example enhances the above simple union example by
adding an optional common member 'read-only', renaming the
@@ -276,12 +360,13 @@ Resulting in these JSON objects:
Notice that in a flat union, the discriminator name is controlled by
the user, but because it must map to a base member with enum type, the
code generator ensures that branches match the existing values of the
-enum. The order of the keys need not match the declaration of the enum.
-The keys need not cover all possible enum values. Omitted enum values
-are still valid branches that add no additional members to the data type.
-In the resulting generated C data types, a flat union is
-represented as a struct with the base members included directly, and
-then a union of structures for each branch of the struct.
+enum. The order of branches need not match the order of the enum
+values. The branches need not cover all possible enum values.
+Omitted enum values are still valid branches that add no additional
+members to the data type. In the resulting generated C data types, a
+flat union is represented as a struct with the base members in QAPI
+schema order, and then a union of structures for each branch of the
+struct.
A simple union can always be re-written as a flat union where the base
class has a single member named 'type', and where each branch of the
@@ -297,26 +382,42 @@ is identical on the wire to:
{ 'union': 'Flat': 'base': { 'type': 'Enum' }, 'discriminator': 'type',
'data': { 'one': 'Branch1', 'two': 'Branch2' } }
+The optional 'if' member specifies a conditional. See "Configuring
+the schema" below for more on this.
+
=== Alternate types ===
-Usage: { 'alternate': STRING, 'data': DICT }
+Syntax:
+ ALTERNATE = { 'alternate': STRING,
+ 'data': ALTERNATIVES,
+ '*if': COND }
+ ALTERNATIVES = { ALTERNATIVE, ... }
+ ALTERNATIVE = STRING : TYPE-REF
+ | STRING : { 'type': STRING, '*if': COND }
-An alternate type is one that allows a choice between two or more JSON
-data types (string, integer, number, or object, but currently not
-array) on the wire. The definition is similar to a simple union type,
-where each branch of the union names a QAPI type. For example:
+Member 'alternate' names the alternate type.
+
+Each ALTERNATIVE of the 'data' object defines a branch of the
+alternate. An alternate must have at least one branch.
+
+The ALTERNATIVE's STRING name is the branch name.
+
+The ALTERNATIVE's value defines the branch's properties, in particular
+its type. The form STRING is shorthand for { 'type': STRING }.
+
+Example:
{ 'alternate': 'BlockdevRef',
'data': { 'definition': 'BlockdevOptions',
'reference': 'str' } }
-Unlike a union, the discriminator string is never passed on the wire
-for the Client JSON Protocol. Instead, the value's JSON type serves
-as an implicit discriminator, which in turn means that an alternate
-can only express a choice between types represented differently in
-JSON. If a branch is typed as the 'bool' built-in, the alternate
-accepts true and false; if it is typed as any of the various numeric
+An alternate type is like a union type, except there is no
+discriminator on the wire. Instead, the value's JSON type serves as
+an implicit discriminator, which in turn means that an alternate can
+only express a choice between types represented differently in JSON.
+If a branch is typed as the 'bool' built-in, the alternate accepts
+true and false; if it is typed as any of the various numeric
built-ins, it accepts a JSON number; if it is typed as a 'str'
built-in or named enum type, it accepts a JSON string; if it is typed
as the 'null' built-in, it accepts JSON null; and if it is typed as a
@@ -332,43 +433,49 @@ following example objects:
"read-only": false,
"filename": "/tmp/mydisk.qcow2" } }
+The optional 'if' member specifies a conditional. See "Configuring
+the schema" below for more on this.
+
=== Commands ===
---- General Command Layout ---
+Syntax:
+ COMMAND = { 'command': STRING,
+ '*data': ( MEMBERS | STRING ),
+ '*boxed': true,
+ '*returns': TYPE-REF,
+ '*success-response': false,
+ '*gen': false,
+ '*allow-oob': true,
+ '*allow-preconfig': true,
+ '*if': COND }
-Usage: { 'command': STRING, '*data': COMPLEX-TYPE-NAME-OR-DICT,
- '*returns': TYPE-NAME, '*boxed': true,
- '*gen': false, '*success-response': false,
- '*allow-oob': true, '*allow-preconfig': true }
+Member 'command' names the command.
-Commands are defined by using a dictionary containing several members,
-where three members are most common. The 'command' member is a
-mandatory string, and determines the "execute" value passed in a
-Client JSON Protocol command exchange.
+Member 'data' defines the arguments. It defaults to an empty MEMBERS
+object.
-The 'data' argument maps to the "arguments" dictionary passed in as
-part of a Client JSON Protocol command. The 'data' member is optional
-and defaults to {} (an empty dictionary). If present, it must be the
-string name of a complex type, or a dictionary that declares an
-anonymous type with the same semantics as a 'struct' expression.
+If 'data' is a MEMBERS object, then MEMBERS defines arguments just
+like a struct type's 'data' defines struct type members. Member
+'boxed' must be absent.
-The 'returns' member describes what will appear in the "return" member
-of a Client JSON Protocol reply on successful completion of a command.
-The member is optional from the command declaration; if absent, the
-"return" member will be an empty dictionary. If 'returns' is present,
-it must be the string name of a complex type, or a
-one-element array containing the name of a complex.
-To return anything else, you have to list the command in pragma
-'returns-whitelist'. If you do this, the command cannot be extended
-to return additional information in the future. Use of
+If 'data' is a STRING, then STRING names a complex type whose members
+are the arguments. A union type requires 'boxed': true.
+
+Member 'returns' defines the command's return type. It defaults to an
+empty struct type. It must normally be a complex type or an array of
+a complex type. To return anything else, the command must be listed
+in pragma 'returns-whitelist'. If you do this, extending the command
+to return additional information will be harder. Use of
'returns-whitelist' for new commands is strongly discouraged.
-All commands in Client JSON Protocol use a dictionary to report
-failure, with no way to specify that in QAPI. Where the error return
-is different than the usual GenericError class in order to help the
-client react differently to certain error conditions, it is worth
-documenting this in the comments before the command declaration.
+A command's error responses are not specified in the QAPI schema.
+Error conditions should be documented in comments.
+
+In the Client JSON Protocol, the value of the "execute" or "exec-oob"
+member is the command name. The value of the "arguments" member then
+has to conform to the arguments, and the value of the success
+response's "return" member will conform to the return type.
Some example commands:
@@ -386,23 +493,24 @@ which would validate this Client JSON Protocol transaction:
=> { "execute": "my-second-command" }
<= { "return": [ { "value": "one" }, { } ] }
-The generator emits a prototype for the user's function implementing
-the command. Normally, 'data' is a dictionary for an anonymous type,
-or names a struct type (possibly empty, but not a union), and its
-members are passed as separate arguments to this function. If the
-command definition includes a key 'boxed' with the boolean value true,
-then 'data' is instead the name of any non-empty complex type (struct
-or union), and a pointer to that QAPI type is passed as a single
-argument.
+The generator emits a prototype for the C function implementing the
+command. The function itself needs to be written by hand. See
+section "Code generated for commands" for examples.
+
+The function returns the return type. When member 'boxed' is absent,
+it takes the command arguments as arguments one by one, in QAPI schema
+order. Else it takes them wrapped in the C struct generated for the
+complex argument type. In either case, it takes an additional Error
+** argument.
The generator also emits a marshalling function that extracts
arguments for the user's function out of an input QDict, calls the
user's function, and if it succeeded, builds an output QObject from
-its return value.
+its return value. This is for use by the QMP monitor core.
In rare cases, QAPI cannot express a type-safe representation of a
corresponding Client JSON Protocol command. You then have to suppress
-generation of a marshalling function by including a key 'gen' with
+generation of a marshalling function by including a member 'gen' with
boolean value false, and instead write your own function. For
example:
@@ -416,13 +524,12 @@ use type-safe unions.
Normally, the QAPI schema is used to describe synchronous exchanges,
where a response is expected. But in some cases, the action of a
command is expected to change state in a way that a successful
-response is not possible (although the command will still return a
-normal dictionary error on failure). When a successful reply is not
-possible, the command expression includes the optional key
-'success-response' with boolean value false. So far, only QGA makes
-use of this member.
+response is not possible (although the command will still return an
+error object on failure). When a successful reply is not possible,
+the command expression includes the optional member 'success-response'
+with boolean value false. So far, only QGA makes use of this member.
-Key 'allow-oob' declares whether the command supports out-of-band
+Member 'allow-oob' declares whether the command supports out-of-band
(OOB) execution. It defaults to false. For example:
{ 'command': 'migrate_recover',
@@ -455,8 +562,8 @@ other "slow" lock.
When in doubt, do not implement OOB execution support.
-Key 'allow-preconfig' declares whether the command is available before
-the machine is built. It defaults to false. For example:
+Member 'allow-preconfig' declares whether the command is available
+before the machine is built. It defaults to false. For example:
{ 'command': 'qmp_capabilities',
'data': { '*enable': [ 'QMPCapability' ] },
@@ -465,16 +572,30 @@ the machine is built. It defaults to false. For example:
QMP is available before the machine is built only when QEMU was
started with --preconfig.
+The optional 'if' member specifies a conditional. See "Configuring
+the schema" below for more on this.
+
+
=== Events ===
-Usage: { 'event': STRING, '*data': COMPLEX-TYPE-NAME-OR-DICT,
- '*boxed': true }
-
-Events are defined with the keyword 'event'. When 'data' is also
-specified, additional info will be included in the event, with similar
-semantics to a 'struct' expression. Finally there will be C API
-generated in qapi-events.h; when called by QEMU code, a message with
-timestamp will be emitted on the wire.
+Syntax:
+ EVENT = { 'event': STRING,
+ '*data': ( MEMBERS | STRING ),
+ '*boxed': true,
+ '*if': COND }
+
+Member 'event' names the event. This is the event name used in the
+Client JSON Protocol.
+
+Member 'data' defines the event-specific data. It defaults to an
+empty MEMBERS object.
+
+If 'data' is a MEMBERS object, then MEMBERS defines event-specific
+data just like a struct type's 'data' defines struct type members.
+Member 'boxed' must be absent.
+
+If 'data' is a STRING, then STRING names a complex type whose members
+are the event-specific data. A union type requires 'boxed': true.
An example event is:
@@ -487,42 +608,44 @@ Resulting in this JSON object:
"data": { "b": "test string" },
"timestamp": { "seconds": 1267020223, "microseconds": 435656 } }
-The generator emits a function to send the event. Normally, 'data' is
-a dictionary for an anonymous type, or names a struct type (possibly
-empty, but not a union), and its members are passed as separate
-arguments to this function. If the event definition includes a key
-'boxed' with the boolean value true, then 'data' is instead the name
-of any non-empty complex type (struct or union), and a pointer to that
-QAPI type is passed as a single argument.
+The generator emits a function to send the event. When member 'boxed'
+is absent, it takes event-specific data one by one, in QAPI schema
+order. Else it takes them wrapped in the C struct generated for the
+complex type. See section "Code generated for events" for examples.
+
+The optional 'if' member specifies a conditional. See "Configuring
+the schema" below for more on this.
=== Features ===
+Syntax:
+ FEATURES = [ FEATURE, ... ]
+ FEATURE = STRING
+ | { 'name': STRING, '*if': COND }
+
Sometimes, the behaviour of QEMU changes compatibly, but without a
-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.
+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.
-In the schema, features can be specified as simple strings, for example:
+Each member of the 'features' array defines a feature. It can either
+be { 'name': STRING, '*if': COND }, or STRING, which is shorthand for
+{ 'name': STRING }.
+
+The optional 'if' member specifies a conditional. See "Configuring
+the schema" below for more on this.
+
+Example:
{ 'struct': 'TestType',
'data': { 'number': 'int' },
'features': [ 'allow-negative-numbers' ] }
-Another option is to specify features as dictionaries, where the key
-'name' specifies the feature string to be exposed to clients:
-
-{ 'struct': 'TestType',
- 'data': { 'number': 'int' },
- 'features': [ { 'name': 'allow-negative-numbers' } ] }
-
-This expanded form is necessary if you want to make the feature
-conditional (see below in "Configuring the schema").
-
=== Naming rules and reserved names ===
@@ -577,11 +700,15 @@ downstream command __com.redhat_drive-mirror.
=== Configuring the schema ===
-The 'struct', 'enum', 'union', 'alternate', 'command' and 'event'
-top-level expressions can take an 'if' key. Its value must be a string
-or a list of strings. A string is shorthand for a list containing just
-that string. The code generated for the top-level expression will then
-be guarded by #if COND for each COND in the list.
+Syntax:
+ COND = STRING
+ | [ STRING, ... ]
+
+Top-level expressions other than include and pragma directives take an
+optional 'if' member. Its value must be a string or a list of
+strings. A string is shorthand for a list containing just that
+string. The code generated for the expression will then be guarded by
+#if COND for each COND in the list.
Example: a conditional struct
@@ -596,29 +723,33 @@ gets its generated code guarded like this:
#endif /* defined(HAVE_BAR) */
#endif /* defined(CONFIG_FOO) */
-Where a member can be defined with a single string value for its type,
-it is also possible to supply a dictionary instead with both 'type'
-and 'if' keys.
+Individual members of complex types, commands arguments, and
+event-specific data can also be made conditional. This requires the
+longhand form of MEMBER.
-Example: a conditional 'bar' member
+Example: a struct type with unconditional member 'foo' and conditional
+member 'bar'
{ 'struct': 'IfStruct', 'data':
{ 'foo': 'int',
'bar': { 'type': 'int', 'if': 'defined(IFCOND)'} } }
-An enum value can be replaced by a dictionary with a 'name' and a 'if'
-key.
+A union's discriminator may not be conditional.
-Example: a conditional 'bar' enum member.
+Likewise, individual enumeration values be conditional. This requires
+the longhand form of ENUM-VALUE.
+
+Example: an enum type with unconditional value 'foo' and conditional
+value 'bar'
{ 'enum': 'IfEnum', 'data':
[ 'foo',
{ 'name' : 'bar', 'if': 'defined(IFCOND)' } ] }
-Similarly, features can be specified as a dictionary with a 'name' and
-an 'if' key.
+Likewise, features can be conditional. This requires the longhand
+form of FEATURE.
-Example: a conditional 'allow-negative-numbers' feature
+Example: a struct with conditional feature 'allow-negative-numbers'
{ 'struct': 'TestType',
'data': { 'number': 'int' },
@@ -627,10 +758,11 @@ Example: a conditional 'allow-negative-numbers' feature
Please note that you are responsible to ensure that the C code will
compile with an arbitrary combination of conditions, since the
-generators are unable to check it at this point.
+generator is unable to check it at this point.
-The presence of 'if' keys in the schema is reflected through to the
-introspection output depending on the build configuration.
+The conditions apply to introspection as well, i.e. introspection
+shows a conditional entity only when the condition is satisfied in
+this particular build.
=== Documentation comments ===
@@ -702,8 +834,8 @@ Example:
==== Expression documentation ====
-Expressions other than include and pragma directives may be preceded
-by a documentation block. Such blocks are called expression
+Top-level expressions other than include and pragma directives may be
+preceded by a documentation block. Such blocks are called expression
documentation blocks.
When documentation is required (see pragma 'doc-required'), expression
@@ -861,7 +993,7 @@ If the event carries no additional information, "arg-type" names an
object type without members. The event may not have a data member on
the wire then.
-Each command or event defined with dictionary-valued 'data' in the
+Each command or event defined with 'data' as MEMBERS object in the
QAPI schema implicitly defines an object type.
Example: the SchemaInfo for EVENT_C from section Events
@@ -1043,7 +1175,7 @@ receive direction compatibility.
Any change to types used in both contexts need to consider both.
-Members of enumeration types, complex types and alternate types may be
+Enumeration type values and complex and alternate type members may be
reordered freely. For enumerations and alternate types, this doesn't
affect the wire encoding. For complex types, this might make the
implementation emit JSON object members in a different order, which
--
2.21.0
^ permalink raw reply related [flat|nested] 12+ messages in thread* Re: [Qemu-devel] [PATCH 0/9] qapi: Schema language cleanups & doc improvements
2019-08-28 20:26 [Qemu-devel] [PATCH 0/9] qapi: Schema language cleanups & doc improvements Markus Armbruster
` (8 preceding siblings ...)
2019-08-28 20:26 ` [Qemu-devel] [PATCH 9/9] docs/devel/qapi-code-gen: Improve QAPI schema language doc Markus Armbruster
@ 2019-08-28 21:42 ` no-reply
9 siblings, 0 replies; 12+ messages in thread
From: no-reply @ 2019-08-28 21:42 UTC (permalink / raw)
To: armbru; +Cc: qemu-devel, mdroth
Patchew URL: https://patchew.org/QEMU/20190828202641.24752-1-armbru@redhat.com/
Hi,
This series seems to have some coding style problems. See output below for
more information:
Subject: [Qemu-devel] [PATCH 0/9] qapi: Schema language cleanups & doc improvements
Message-id: 20190828202641.24752-1-armbru@redhat.com
Type: series
=== TEST SCRIPT BEGIN ===
#!/bin/bash
git rev-parse base > /dev/null || exit 0
git config --local diff.renamelimit 0
git config --local diff.renames True
git config --local diff.algorithm histogram
./scripts/checkpatch.pl --mailback base..
=== TEST SCRIPT END ===
Updating 3c8cf5a9c21ff8782164d1def7f44bd888713384
Switched to a new branch 'test'
d27cc29 docs/devel/qapi-code-gen: Improve QAPI schema language doc
72397f6 docs/devel/qapi-code-gen: Rewrite introduction to schema
62b02fb docs/devel/qapi-code-gen: Rewrite compatibility considerations
97bf23f docs/devel/qapi-code-gen: Reorder sections for readability
dfd13e2 tests/qapi-schema: Consistently name string tests string-FOO
5e21c3b qapi: Outlaw control characters in strings
1cd34f8 docs/devel/qapi-code-gen: Minor specification fixes
ab6ab29 qapi: Drop support for boxed alternate for commands, events
29df3a5 qapi: Drop check_type()'s redundant parameter @allow_optional
=== OUTPUT BEGIN ===
1/9 Checking commit 29df3a54e53e (qapi: Drop check_type()'s redundant parameter @allow_optional)
2/9 Checking commit ab6ab29d80e0 (qapi: Drop support for boxed alternate for commands, events)
3/9 Checking commit 1cd34f8cbd0e (docs/devel/qapi-code-gen: Minor specification fixes)
4/9 Checking commit 5e21c3bbc6d3 (qapi: Outlaw control characters in strings)
WARNING: added, moved or deleted file(s), does MAINTAINERS need updating?
#52:
new file mode 100644
ERROR: Invalid UTF-8, patch and commit message should be encoded in UTF-8
#72: FILE: tests/qapi-schema/string-control.json:2:
+{ 'command': '⌦
────────────────────────────────────────────────────────────────────────
' }
^
total: 1 errors, 1 warnings, 20 lines checked
Patch 4/9 has style problems, please review. If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.
5/9 Checking commit dfd13e2b3dec (tests/qapi-schema: Consistently name string tests string-FOO)
WARNING: added, moved or deleted file(s), does MAINTAINERS need updating?
#33:
new file mode 100644
total: 0 errors, 1 warnings, 18 lines checked
Patch 5/9 has style problems, please review. If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.
6/9 Checking commit 97bf23fd9a0d (docs/devel/qapi-code-gen: Reorder sections for readability)
7/9 Checking commit 62b02fb7a675 (docs/devel/qapi-code-gen: Rewrite compatibility considerations)
8/9 Checking commit 72397f6335d8 (docs/devel/qapi-code-gen: Rewrite introduction to schema)
9/9 Checking commit d27cc292826e (docs/devel/qapi-code-gen: Improve QAPI schema language doc)
=== OUTPUT END ===
Test command exited with code: 1
The full log is available at
http://patchew.org/logs/20190828202641.24752-1-armbru@redhat.com/testing.checkpatch/?type=message.
---
Email generated automatically by Patchew [https://patchew.org/].
Please send your feedback to patchew-devel@redhat.com
^ permalink raw reply [flat|nested] 12+ messages in thread