qemu-irix/tests/qapi-schema
Markus Armbruster 39a1815816 qapi: New QMP command query-qmp-schema for QMP introspection
qapi/introspect.json defines the introspection schema.  It's designed
for QMP introspection, but should do for similar uses, such as QGA.

The introspection schema does not reflect all the rules and
restrictions that apply to QAPI schemata.  A valid QAPI schema has an
introspection value conforming to the introspection schema, but the
converse is not true.

Introspection lowers away a number of schema details, and makes
implicit things explicit:

* The built-in types are declared with their JSON type.

  All integer types are mapped to 'int', because how many bits we use
  internally is an implementation detail.  It could be pressed into
  external interface service as very approximate range information,
  but that's a bad idea.  If we need range information, we better do
  it properly.

* Implicit type definitions are made explicit, and given
  auto-generated names:

  - Array types, named by appending "List" to the name of their
    element type, like in generated C.

  - The enumeration types implicitly defined by simple union types,
    named by appending "Kind" to the name of their simple union type,
    like in generated C.

  - Types that don't occur in generated C.  Their names start with ':'
    so they don't clash with the user's names.

* All type references are by name.

* The struct and union types are generalized into an object type.

* Base types are flattened.

* Commands take a single argument and return a single result.

  Dictionary argument or list result is an implicit type definition.

  The empty object type is used when a command takes no arguments or
  produces no results.

  The argument is always of object type, but the introspection schema
  doesn't reflect that.

  The 'gen': false directive is omitted as implementation detail.

  The 'success-response' directive is omitted as well for now, even
  though it's not an implementation detail, because it's not used by
  QMP.

* Events carry a single data value.

  Implicit type definition and empty object type use, just like for
  commands.

  The value is of object type, but the introspection schema doesn't
  reflect that.

* Types not used by commands or events are omitted.

  Indirect use counts as use.

* Optional members have a default, which can only be null right now

  Instead of a mandatory "optional" flag, we have an optional default.
  No default means mandatory, default null means optional without
  default value.  Non-null is available for optional with default
  (possible future extension).

* Clients should *not* look up types by name, because type names are
  not ABI.  Look up the command or event you're interested in, then
  follow the references.

  TODO Should we hide the type names to eliminate the temptation?

New generator scripts/qapi-introspect.py computes an introspection
value for its input, and generates a C variable holding it.

It can generate awfully long lines.  Marked TODO.

A new test-qmp-input-visitor test case feeds its result for both
tests/qapi-schema/qapi-schema-test.json and qapi-schema.json to a
QmpInputVisitor to verify it actually conforms to the schema.

New QMP command query-qmp-schema takes its return value from that
variable.  Its reply is some 85KiBytes for me right now.

If this turns out to be too much, we have a couple of options:

* We can use shorter names in the JSON.  Not the QMP style.

* Optionally return the sub-schema for commands and events given as
  arguments.

  Right now qmp_query_schema() sends the string literal computed by
  qmp-introspect.py.  To compute sub-schema at run time, we'd have to
  duplicate parts of qapi-introspect.py in C.  Unattractive.

* Let clients cache the output of query-qmp-schema.

  It changes only on QEMU upgrades, i.e. rarely.  Provide a command
  query-qmp-schema-hash.  Clients can have a cache indexed by hash,
  and re-query the schema only when they don't have it cached.  Even
  simpler: put the hash in the QMP greeting.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
2015-09-21 09:56:49 +02:00
..
include
alternate-array.err
alternate-array.exit
alternate-array.json
alternate-array.out
alternate-base.err
alternate-base.exit
alternate-base.json
alternate-base.out
alternate-clash.err
alternate-clash.exit
alternate-clash.json
alternate-clash.out
alternate-conflict-dict.err
alternate-conflict-dict.exit
alternate-conflict-dict.json
alternate-conflict-dict.out
alternate-conflict-string.err
alternate-conflict-string.exit
alternate-conflict-string.json
alternate-conflict-string.out
alternate-good.err
alternate-good.exit
alternate-good.json
alternate-good.out qapi: New QMP command query-qmp-schema for QMP introspection 2015-09-21 09:56:49 +02:00
alternate-nested.err
alternate-nested.exit
alternate-nested.json
alternate-nested.out
alternate-unknown.err
alternate-unknown.exit
alternate-unknown.json
alternate-unknown.out
args-alternate.err qapi-tests: New tests for union, alternate command arguments 2015-09-04 15:47:15 +02:00
args-alternate.exit qapi-tests: New tests for union, alternate command arguments 2015-09-04 15:47:15 +02:00
args-alternate.json qapi-tests: New tests for union, alternate command arguments 2015-09-04 15:47:15 +02:00
args-alternate.out qapi-tests: New tests for union, alternate command arguments 2015-09-04 15:47:15 +02:00
args-any.err qapi: Introduce a first class 'any' type 2015-09-21 09:56:49 +02:00
args-any.exit qapi: Introduce a first class 'any' type 2015-09-21 09:56:49 +02:00
args-any.json qapi: Introduce a first class 'any' type 2015-09-21 09:56:49 +02:00
args-any.out qapi: Introduce a first class 'any' type 2015-09-21 09:56:49 +02:00
args-array-empty.err tests/qapi-schema: Rename tests from data- to args- 2015-09-04 15:47:15 +02:00
args-array-empty.exit tests/qapi-schema: Rename tests from data- to args- 2015-09-04 15:47:15 +02:00
args-array-empty.json tests/qapi-schema: Rename tests from data- to args- 2015-09-04 15:47:15 +02:00
args-array-empty.out tests/qapi-schema: Rename tests from data- to args- 2015-09-04 15:47:15 +02:00
args-array-unknown.err qapi: Simplify error reporting for array types 2015-09-04 15:47:16 +02:00
args-array-unknown.exit tests/qapi-schema: Rename tests from data- to args- 2015-09-04 15:47:15 +02:00
args-array-unknown.json tests/qapi-schema: Rename tests from data- to args- 2015-09-04 15:47:15 +02:00
args-array-unknown.out tests/qapi-schema: Rename tests from data- to args- 2015-09-04 15:47:15 +02:00
args-int.err tests/qapi-schema: Rename tests from data- to args- 2015-09-04 15:47:15 +02:00
args-int.exit tests/qapi-schema: Rename tests from data- to args- 2015-09-04 15:47:15 +02:00
args-int.json tests/qapi-schema: Rename tests from data- to args- 2015-09-04 15:47:15 +02:00
args-int.out tests/qapi-schema: Rename tests from data- to args- 2015-09-04 15:47:15 +02:00
args-invalid.err qapi: Fix errors for non-string, non-dictionary members 2015-09-04 15:47:16 +02:00
args-invalid.exit tests/qapi-schema: Cover non-string, non-dictionary members 2015-09-04 15:47:16 +02:00
args-invalid.json qapi: Fix errors for non-string, non-dictionary members 2015-09-04 15:47:16 +02:00
args-invalid.out tests/qapi-schema: Cover non-string, non-dictionary members 2015-09-04 15:47:16 +02:00
args-member-array-bad.err tests/qapi-schema: Rename tests from data- to args- 2015-09-04 15:47:15 +02:00
args-member-array-bad.exit tests/qapi-schema: Rename tests from data- to args- 2015-09-04 15:47:15 +02:00
args-member-array-bad.json tests/qapi-schema: Rename tests from data- to args- 2015-09-04 15:47:15 +02:00
args-member-array-bad.out tests/qapi-schema: Rename tests from data- to args- 2015-09-04 15:47:15 +02:00
args-member-array.err tests/qapi-schema: Rename tests from data- to args- 2015-09-04 15:47:15 +02:00
args-member-array.exit tests/qapi-schema: Rename tests from data- to args- 2015-09-04 15:47:15 +02:00
args-member-array.json tests/qapi-schema: Rename tests from data- to args- 2015-09-04 15:47:15 +02:00
args-member-array.out qapi: New QMP command query-qmp-schema for QMP introspection 2015-09-21 09:56:49 +02:00
args-member-unknown.err tests/qapi-schema: Rename tests from data- to args- 2015-09-04 15:47:15 +02:00
args-member-unknown.exit tests/qapi-schema: Rename tests from data- to args- 2015-09-04 15:47:15 +02:00
args-member-unknown.json tests/qapi-schema: Rename tests from data- to args- 2015-09-04 15:47:15 +02:00
args-member-unknown.out tests/qapi-schema: Rename tests from data- to args- 2015-09-04 15:47:15 +02:00
args-union.err qapi: Fix to reject union command and event arguments 2015-09-04 15:47:15 +02:00
args-union.exit qapi: Fix to reject union command and event arguments 2015-09-04 15:47:15 +02:00
args-union.json qapi: Fix to reject union command and event arguments 2015-09-04 15:47:15 +02:00
args-union.out qapi: Fix to reject union command and event arguments 2015-09-04 15:47:15 +02:00
args-unknown.err tests/qapi-schema: Rename tests from data- to args- 2015-09-04 15:47:15 +02:00
args-unknown.exit tests/qapi-schema: Rename tests from data- to args- 2015-09-04 15:47:15 +02:00
args-unknown.json tests/qapi-schema: Rename tests from data- to args- 2015-09-04 15:47:15 +02:00
args-unknown.out tests/qapi-schema: Rename tests from data- to args- 2015-09-04 15:47:15 +02:00
bad-base.err
bad-base.exit
bad-base.json
bad-base.out
bad-data.err
bad-data.exit
bad-data.json
bad-data.out
bad-ident.err
bad-ident.exit
bad-ident.json
bad-ident.out
bad-type-bool.err
bad-type-bool.exit
bad-type-bool.json
bad-type-bool.out
bad-type-dict.err
bad-type-dict.exit
bad-type-dict.json
bad-type-dict.out
bad-type-int.err
bad-type-int.exit
bad-type-int.json
bad-type-int.out
command-int.err
command-int.exit
command-int.json qapi: Command returning anonymous type doesn't work, outlaw 2015-09-04 15:47:15 +02:00
command-int.out
comments.err
comments.exit
comments.json
comments.out qapi: New QMP command query-qmp-schema for QMP introspection 2015-09-21 09:56:49 +02:00
double-data.err
double-data.exit
double-data.json
double-data.out
double-type.err
double-type.exit
double-type.json
double-type.out
duplicate-key.err
duplicate-key.exit
duplicate-key.json
duplicate-key.out
empty.err
empty.exit
empty.json
empty.out qapi: New QMP command query-qmp-schema for QMP introspection 2015-09-21 09:56:49 +02:00
enum-bad-name.err
enum-bad-name.exit
enum-bad-name.json
enum-bad-name.out
enum-bad-prefix.err qapi: allow override of default enum prefix naming 2015-09-15 10:59:28 +01:00
enum-bad-prefix.exit qapi: allow override of default enum prefix naming 2015-09-15 10:59:28 +01:00
enum-bad-prefix.json qapi: allow override of default enum prefix naming 2015-09-15 10:59:28 +01:00
enum-bad-prefix.out qapi: allow override of default enum prefix naming 2015-09-15 10:59:28 +01:00
enum-clash-member.err
enum-clash-member.exit
enum-clash-member.json
enum-clash-member.out
enum-dict-member.err
enum-dict-member.exit
enum-dict-member.json
enum-dict-member.out
enum-empty.err
enum-empty.exit
enum-empty.json
enum-empty.out qapi: New QMP command query-qmp-schema for QMP introspection 2015-09-21 09:56:49 +02:00
enum-int-member.err
enum-int-member.exit
enum-int-member.json
enum-int-member.out
enum-max-member.err
enum-max-member.exit
enum-max-member.json
enum-max-member.out
enum-missing-data.err
enum-missing-data.exit
enum-missing-data.json
enum-missing-data.out
enum-union-clash.err
enum-union-clash.exit
enum-union-clash.json
enum-union-clash.out
enum-wrong-data.err
enum-wrong-data.exit
enum-wrong-data.json
enum-wrong-data.out
escape-outside-string.err
escape-outside-string.exit
escape-outside-string.json
escape-outside-string.out
escape-too-big.err
escape-too-big.exit
escape-too-big.json
escape-too-big.out
escape-too-short.err
escape-too-short.exit
escape-too-short.json
escape-too-short.out
event-case.err
event-case.exit
event-case.json
event-case.out qapi: New QMP command query-qmp-schema for QMP introspection 2015-09-21 09:56:49 +02:00
event-max.err
event-max.exit
event-max.json
event-max.out
event-nest-struct.err
event-nest-struct.exit
event-nest-struct.json
event-nest-struct.out
flat-union-array-branch.err qapi: Catch and reject flat union branch of array type 2015-06-18 14:19:47 +02:00
flat-union-array-branch.exit tests/qapi-schema: New flat union array branch test case 2015-06-18 14:19:47 +02:00
flat-union-array-branch.json tests/qapi-schema: New flat union array branch test case 2015-06-18 14:19:47 +02:00
flat-union-array-branch.out tests/qapi-schema: New flat union array branch test case 2015-06-18 14:19:47 +02:00
flat-union-bad-base.err
flat-union-bad-base.exit
flat-union-bad-base.json
flat-union-bad-base.out
flat-union-bad-discriminator.err
flat-union-bad-discriminator.exit
flat-union-bad-discriminator.json
flat-union-bad-discriminator.out
flat-union-base-any.err qapi: Introduce a first class 'any' type 2015-09-21 09:56:49 +02:00
flat-union-base-any.exit qapi: Introduce a first class 'any' type 2015-09-21 09:56:49 +02:00
flat-union-base-any.json qapi: Introduce a first class 'any' type 2015-09-21 09:56:49 +02:00
flat-union-base-any.out qapi: Introduce a first class 'any' type 2015-09-21 09:56:49 +02:00
flat-union-base-union.err
flat-union-base-union.exit
flat-union-base-union.json
flat-union-base-union.out
flat-union-branch-clash.err qapi: Check for member name conflicts with a base class 2015-05-05 18:39:02 +02:00
flat-union-branch-clash.exit qapi: Check for member name conflicts with a base class 2015-05-05 18:39:02 +02:00
flat-union-branch-clash.json qapi: Check for member name conflicts with a base class 2015-05-05 18:39:02 +02:00
flat-union-branch-clash.out qapi: Check for member name conflicts with a base class 2015-05-05 18:39:02 +02:00
flat-union-inline.err
flat-union-inline.exit
flat-union-inline.json
flat-union-inline.out
flat-union-int-branch.err
flat-union-int-branch.exit
flat-union-int-branch.json
flat-union-int-branch.out
flat-union-invalid-branch-key.err
flat-union-invalid-branch-key.exit
flat-union-invalid-branch-key.json
flat-union-invalid-branch-key.out
flat-union-invalid-discriminator.err
flat-union-invalid-discriminator.exit
flat-union-invalid-discriminator.json
flat-union-invalid-discriminator.out
flat-union-no-base.err
flat-union-no-base.exit
flat-union-no-base.json
flat-union-no-base.out
flat-union-optional-discriminator.err
flat-union-optional-discriminator.exit
flat-union-optional-discriminator.json
flat-union-optional-discriminator.out
flat-union-reverse-define.err
flat-union-reverse-define.exit
flat-union-reverse-define.json
flat-union-reverse-define.out qapi: New QMP command query-qmp-schema for QMP introspection 2015-09-21 09:56:49 +02:00
flat-union-string-discriminator.err
flat-union-string-discriminator.exit
flat-union-string-discriminator.json
flat-union-string-discriminator.out
funny-char.err
funny-char.exit
funny-char.json
funny-char.out
ident-with-escape.err
ident-with-escape.exit
ident-with-escape.json
ident-with-escape.out qapi: New QMP command query-qmp-schema for QMP introspection 2015-09-21 09:56:49 +02:00
include-before-err.err
include-before-err.exit
include-before-err.json
include-before-err.out
include-cycle-b.json
include-cycle-c.json
include-cycle.err qapi: Fix file name in error messages for included files 2015-06-18 14:12:34 +02:00
include-cycle.exit
include-cycle.json
include-cycle.out
include-format-err.err
include-format-err.exit
include-format-err.json
include-format-err.out
include-nested-err.err qapi: Fix file name in error messages for included files 2015-06-18 14:12:34 +02:00
include-nested-err.exit
include-nested-err.json
include-nested-err.out
include-no-file.err
include-no-file.exit
include-no-file.json
include-no-file.out
include-non-file.err
include-non-file.exit
include-non-file.json
include-non-file.out
include-relpath-sub.json
include-relpath.err
include-relpath.exit
include-relpath.json
include-relpath.out qapi: New QMP command query-qmp-schema for QMP introspection 2015-09-21 09:56:49 +02:00
include-repetition-sub.json
include-repetition.err
include-repetition.exit
include-repetition.json
include-repetition.out qapi: New QMP command query-qmp-schema for QMP introspection 2015-09-21 09:56:49 +02:00
include-self-cycle.err
include-self-cycle.exit
include-self-cycle.json
include-self-cycle.out
include-simple-sub.json
include-simple.err
include-simple.exit
include-simple.json
include-simple.out qapi: New QMP command query-qmp-schema for QMP introspection 2015-09-21 09:56:49 +02:00
indented-expr.err
indented-expr.exit
indented-expr.json
indented-expr.out qapi: New QMP command query-qmp-schema for QMP introspection 2015-09-21 09:56:49 +02:00
leading-comma-list.err tests/qapi-schema: Cover two more syntax errors 2015-09-04 15:47:16 +02:00
leading-comma-list.exit tests/qapi-schema: Cover two more syntax errors 2015-09-04 15:47:16 +02:00
leading-comma-list.json tests/qapi-schema: Cover two more syntax errors 2015-09-04 15:47:16 +02:00
leading-comma-list.out tests/qapi-schema: Cover two more syntax errors 2015-09-04 15:47:16 +02:00
leading-comma-object.err tests/qapi-schema: Cover two more syntax errors 2015-09-04 15:47:16 +02:00
leading-comma-object.exit tests/qapi-schema: Cover two more syntax errors 2015-09-04 15:47:16 +02:00
leading-comma-object.json tests/qapi-schema: Cover two more syntax errors 2015-09-04 15:47:16 +02:00
leading-comma-object.out tests/qapi-schema: Cover two more syntax errors 2015-09-04 15:47:16 +02:00
missing-colon.err
missing-colon.exit
missing-colon.json
missing-colon.out
missing-comma-list.err
missing-comma-list.exit
missing-comma-list.json
missing-comma-list.out
missing-comma-object.err
missing-comma-object.exit
missing-comma-object.json
missing-comma-object.out
missing-type.err
missing-type.exit
missing-type.json
missing-type.out
nested-struct-data.err
nested-struct-data.exit
nested-struct-data.json qapi: Command returning anonymous type doesn't work, outlaw 2015-09-04 15:47:15 +02:00
nested-struct-data.out
non-objects.err
non-objects.exit
non-objects.json
non-objects.out
qapi-schema-test.err
qapi-schema-test.exit
qapi-schema-test.json qapi: Introduce a first class 'any' type 2015-09-21 09:56:49 +02:00
qapi-schema-test.out qapi: New QMP command query-qmp-schema for QMP introspection 2015-09-21 09:56:49 +02:00
quoted-structural-chars.err
quoted-structural-chars.exit
quoted-structural-chars.json
quoted-structural-chars.out
redefined-builtin.err
redefined-builtin.exit
redefined-builtin.json
redefined-builtin.out
redefined-command.err
redefined-command.exit
redefined-command.json
redefined-command.out
redefined-event.err
redefined-event.exit
redefined-event.json
redefined-event.out
redefined-type.err
redefined-type.exit
redefined-type.json
redefined-type.out
returns-alternate.err
returns-alternate.exit
returns-alternate.json
returns-alternate.out
returns-array-bad.err
returns-array-bad.exit
returns-array-bad.json
returns-array-bad.out
returns-dict.err qapi: Command returning anonymous type doesn't work, outlaw 2015-09-04 15:47:15 +02:00
returns-dict.exit qapi: Command returning anonymous type doesn't work, outlaw 2015-09-04 15:47:15 +02:00
returns-dict.json qapi: Command returning anonymous type doesn't work, outlaw 2015-09-04 15:47:15 +02:00
returns-dict.out qapi: Command returning anonymous type doesn't work, outlaw 2015-09-04 15:47:15 +02:00
returns-int.err
returns-int.exit
returns-int.json
returns-int.out qapi: New QMP command query-qmp-schema for QMP introspection 2015-09-21 09:56:49 +02:00
returns-unknown.err
returns-unknown.exit
returns-unknown.json
returns-unknown.out
returns-whitelist.err qapi: Simplify error reporting for array types 2015-09-04 15:47:16 +02:00
returns-whitelist.exit
returns-whitelist.json
returns-whitelist.out
struct-base-clash-deep.err qapi: Check for member name conflicts with a base class 2015-05-05 18:39:02 +02:00
struct-base-clash-deep.exit qapi: Check for member name conflicts with a base class 2015-05-05 18:39:02 +02:00
struct-base-clash-deep.json qapi: Check for member name conflicts with a base class 2015-05-05 18:39:02 +02:00
struct-base-clash-deep.out qapi: Check for member name conflicts with a base class 2015-05-05 18:39:02 +02:00
struct-base-clash.err qapi: Check for member name conflicts with a base class 2015-05-05 18:39:02 +02:00
struct-base-clash.exit qapi: Check for member name conflicts with a base class 2015-05-05 18:39:02 +02:00
struct-base-clash.json qapi: Check for member name conflicts with a base class 2015-05-05 18:39:02 +02:00
struct-base-clash.out qapi: Check for member name conflicts with a base class 2015-05-05 18:39:02 +02:00
struct-data-invalid.err qapi: Fix errors for non-string, non-dictionary members 2015-09-04 15:47:16 +02:00
struct-data-invalid.exit tests/qapi-schema: Cover non-string, non-dictionary members 2015-09-04 15:47:16 +02:00
struct-data-invalid.json qapi: Fix errors for non-string, non-dictionary members 2015-09-04 15:47:16 +02:00
struct-data-invalid.out tests/qapi-schema: Cover non-string, non-dictionary members 2015-09-04 15:47:16 +02:00
struct-member-invalid.err qapi: Fix errors for non-string, non-dictionary members 2015-09-04 15:47:16 +02:00
struct-member-invalid.exit tests/qapi-schema: Cover non-string, non-dictionary members 2015-09-04 15:47:16 +02:00
struct-member-invalid.json qapi: Fix errors for non-string, non-dictionary members 2015-09-04 15:47:16 +02:00
struct-member-invalid.out tests/qapi-schema: Cover non-string, non-dictionary members 2015-09-04 15:47:16 +02:00
test-qapi.py tests/qapi-schema: Convert test harness to QAPISchemaVisitor 2015-09-21 09:32:50 +02:00
trailing-comma-list.err
trailing-comma-list.exit
trailing-comma-list.json
trailing-comma-list.out
trailing-comma-object.err
trailing-comma-object.exit
trailing-comma-object.json
trailing-comma-object.out
type-bypass-bad-gen.err
type-bypass-bad-gen.exit
type-bypass-bad-gen.json
type-bypass-bad-gen.out
unclosed-list.err
unclosed-list.exit
unclosed-list.json
unclosed-list.out
unclosed-object.err
unclosed-object.exit
unclosed-object.json
unclosed-object.out
unclosed-string.err
unclosed-string.exit
unclosed-string.json
unclosed-string.out
unicode-str.err
unicode-str.exit
unicode-str.json
unicode-str.out
union-bad-branch.err
union-bad-branch.exit
union-bad-branch.json
union-bad-branch.out
union-base-no-discriminator.err qapi: Drop one of two "simple union must not have base" checks 2015-09-04 15:47:16 +02:00
union-base-no-discriminator.exit
union-base-no-discriminator.json
union-base-no-discriminator.out
union-invalid-base.err
union-invalid-base.exit
union-invalid-base.json
union-invalid-base.out
union-max.err
union-max.exit
union-max.json
union-max.out
union-optional-branch.err
union-optional-branch.exit
union-optional-branch.json
union-optional-branch.out
union-unknown.err
union-unknown.exit
union-unknown.json
union-unknown.out
unknown-escape.err
unknown-escape.exit
unknown-escape.json
unknown-escape.out
unknown-expr-key.err
unknown-expr-key.exit
unknown-expr-key.json
unknown-expr-key.out