Received: from eggs.gnu.org ([208.118.235.92]:56996) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UHqw5-0003CZ-K2 for qemu-devel@nongnu.org; Tue, 19 Mar 2013 03:26:19 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1UHqw4-0008Ln-2q for qemu-devel@nongnu.org; Tue, 19 Mar 2013 03:26:17 -0400 Received: from mx1.redhat.com ([209.132.183.28]:51235) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UHqw3-0008Lf-R1 for qemu-devel@nongnu.org; Tue, 19 Mar 2013 03:26:15 -0400 From: Markus Armbruster References: <1363367835-11306-1-git-send-email-coreyb@linux.vnet.ibm.com> <878v5k65ur.fsf@blackfin.pond.sub.org> <51475310.2060008@linux.vnet.ibm.com> Date: Tue, 19 Mar 2013 08:26:11 +0100 In-Reply-To: <51475310.2060008@linux.vnet.ibm.com> (Stefan Berger's message of "Mon, 18 Mar 2013 13:46:56 -0400") Message-ID: <87d2uvu9yk.fsf@blackfin.pond.sub.org> MIME-Version: 1.0 Content-Type: text/plain Subject: Re: [Qemu-devel] [PATCH] QMP: TPM QMP and man page documentation updates List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: Stefan Berger Cc: Anthony Liguori , Corey Bryant , qemu-devel@nongnu.org, lcapitulino@redhat.com [Note cc: Anthony for QAPI schema expertise] Stefan Berger writes: > On 03/18/2013 12:16 PM, Markus Armbruster wrote: >> Corey Bryant writes: >> >>> Signed-off-by: Corey Bryant >>> --- >>> qemu-options.hx | 3 ++- >>> qmp-commands.hx | 59 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ >>> 2 files changed, 61 insertions(+), 1 deletion(-) >>> >>> diff --git a/qemu-options.hx b/qemu-options.hx >>> index 30fb85d..3b3cd0f 100644 >>> --- a/qemu-options.hx >>> +++ b/qemu-options.hx >>> @@ -2237,7 +2237,8 @@ Backend type must be: >>> @option{passthrough}. >>> The specific backend type will determine the applicable >>> options. >>> -The @code{-tpmdev} option requires a @code{-device} option. >>> +The @code{-tpmdev} option creates the TPM backend and requires a >>> +@code{-device} option that specifies the TPM frontend interface model. >>> Options to each backend are described below. >>> diff --git a/qmp-commands.hx b/qmp-commands.hx >>> index b370060..4eda5ea 100644 >>> --- a/qmp-commands.hx >>> +++ b/qmp-commands.hx >>> @@ -2721,18 +2721,77 @@ EQMP >>> .mhandler.cmd_new = qmp_marshal_input_query_tpm, >>> }, >>> +SQMP >>> +query-tpm >>> +--------- >>> + >>> +Return information about the TPM device. >>> + >>> +Arguments: None >>> + >>> +Example: >>> + >>> +-> { "execute": "query-tpm" } >>> +<- { "return": >>> + [ >>> + { "model": "tpm-tis", >>> + "tpm-options": >>> + { "type": "tpm-passthrough-options", >>> + "data": >>> + { "cancel-path": "/sys/class/misc/tpm0/device/cancel", >>> + "path": "/dev/tpm0" >>> + } >>> + }, >>> + "type": "passthrough", >>> + "id": "tpm0" >>> + } >>> + ] >>> + } >>> + >>> +EQMP >>> + >> "tpm-options" is a discriminated union. How is its discriminator "type" >> (here: "tpm-passthrough-options") related to the outer "type" (here: >> "passthrough")? > > It gives you similar information twice. So there is a direct > relationship between the two types. Awkward and undocumented. Relevant parts of qapi-schema.json: { 'enum': 'TpmType', 'data': [ 'passthrough' ] } { 'union': 'TpmTypeOptions', 'data': { 'tpm-passthrough-options' : 'TPMPassthroughOptions' } } { 'type': 'TPMInfo', 'data': {'id': 'str', 'model': 'TpmModel', 'type': 'TpmType', 'tpm-options': 'TpmTypeOptions' } } Type Netdev solves the same problem more elegantly: { 'union': 'NetClientOptions', 'data': { 'none': 'NetdevNoneOptions', 'nic': 'NetLegacyNicOptions', 'user': 'NetdevUserOptions', 'tap': 'NetdevTapOptions', 'socket': 'NetdevSocketOptions', 'vde': 'NetdevVdeOptions', 'dump': 'NetdevDumpOptions', 'bridge': 'NetdevBridgeOptions', 'hubport': 'NetdevHubPortOptions' } } { 'type': 'Netdev', 'data': { 'id': 'str', 'opts': 'NetClientOptions' } } Uses the union's discriminator. Straightforward. Following Netdev precedence, we get: { 'union': 'TpmTypeOptions', 'data': { 'passthrough' : 'TPMPassthroughOptions' } } { 'type': 'TPMInfo', 'data': {'id': 'str', 'model': 'TpmModel', 'opts': 'TpmTypeOptions' } } Duplication of type is gone. No need for documentation. Since enum TpmType is used elsewhere, it still gets duplicated in the union's discriminator. Anthony, is there a way to name the implicit discriminator enum type for reference elsewhere in the schema?