Commit 315932b5 authored by Markus Armbruster's avatar Markus Armbruster
Browse files

qapi: Fix to reject union command and event arguments 



A command's or event's 'data' must be a struct type, given either as a
dictionary, or as struct type name.

Commit dd883c6f tightened the checking there, but not enough: we still
accept 'union'.  Fix to reject it.

We may want to support union types there, but we'll have to extend
qapi-commands.py and qapi-events.py for it.

Signed-off-by: default avatarMarkus Armbruster <armbru@redhat.com>
Reviewed-by: default avatarEric Blake <eblake@redhat.com>
parent d9658d58

docs/qapi-code-gen.txt

+3 −4
Original line number Diff line number Diff line
@@ -405,10 +405,9 @@ Client JSON Protocol command exchange. 
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, a one-element array containing the name

of a complex type, or a dictionary that declares an anonymous type

with the same semantics as a 'struct' expression, with one exception

noted below when 'gen' is used.

string name of a complex type, or a dictionary that declares an

anonymous type with the same semantics as a 'struct' expression, with

one exception noted below when 'gen' is used.



The 'returns' member describes what will appear in the "return" field

of a Client JSON Protocol reply on successful completion of a command.

scripts/qapi.py

+2 −2
Original line number Diff line number Diff line
@@ -499,7 +499,7 @@ def check_command(expr, expr_info): 


    check_type(expr_info, "'data' for command '%s'" % name,

               expr.get('data'), allow_dict=True, allow_optional=True,

               allow_metas=['union', 'struct'], allow_star=allow_star)

               allow_metas=['struct'], allow_star=allow_star)

    returns_meta = ['union', 'struct']

    if name in returns_whitelist:

        returns_meta += ['built-in', 'alternate', 'enum']
@@ -517,7 +517,7 @@ def check_event(expr, expr_info): 
    events.append(name)

    check_type(expr_info, "'data' for event '%s'" % name,

               expr.get('data'), allow_dict=True, allow_optional=True,

               allow_metas=['union', 'struct'])

               allow_metas=['struct'])



def check_union(expr, expr_info):

    name = expr['union']

tests/qapi-schema/args-union.err

+1 −0
Original line number Diff line number Diff line 
tests/qapi-schema/args-union.json:4: 'data' for command 'oops' cannot use union type 'Uni'

tests/qapi-schema/args-union.exit

+1 −1
Original line number Diff line number Diff line 
0
 
1

tests/qapi-schema/args-union.json

+1 −1
Original line number Diff line number Diff line 
# FIXME we should reject union arguments

# we do not allow union arguments

# TODO should we support this?

{ 'union': 'Uni', 'data': { 'case1': 'int', 'case2': 'str' } }

{ 'command': 'oops', 'data': 'Uni' }