From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id A1346C433F5 for ; Tue, 7 Dec 2021 06:55:09 +0000 (UTC) Received: from localhost ([::1]:58828 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1muUNY-0006Ix-Nn for qemu-devel@archiver.kernel.org; Tue, 07 Dec 2021 01:55:08 -0500 Received: from eggs.gnu.org ([209.51.188.92]:46300) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1muULP-0003Rq-6T for qemu-devel@nongnu.org; Tue, 07 Dec 2021 01:52:55 -0500 Received: from us-smtp-delivery-124.mimecast.com ([170.10.133.124]:29344) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1muULM-00043u-3i for qemu-devel@nongnu.org; Tue, 07 Dec 2021 01:52:54 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1638859971; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: in-reply-to:in-reply-to:references:references; bh=O3SyuiwExAYrr2CtFfv962FL4T6pGYaemoM+08N5GD0=; b=eGRDTSUX5jQ8pclv/SAJ1N0xebhScDg/xj1as3uyljeKHIooCneBm8uh88AK3jcSn0QTYl /6M17fgWblOHKlqJ0RhovjyJ2lD8FWC/Zq2AgFraU0RotOfKBvPiJk2ffyy2mu029F3eeB oWC0NkbtYk3fqSu+q3V9pagjwHeQB5k= Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-358-CE41rWW2Pxe1L6L-USfIyQ-1; Tue, 07 Dec 2021 01:52:47 -0500 X-MC-Unique: CE41rWW2Pxe1L6L-USfIyQ-1 Received: from smtp.corp.redhat.com (int-mx08.intmail.prod.int.phx2.redhat.com [10.5.11.23]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 1A6CB81EE60; Tue, 7 Dec 2021 06:52:46 +0000 (UTC) Received: from blackfin.pond.sub.org (ovpn-112-7.ams2.redhat.com [10.36.112.7]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 4BDE0196F2; Tue, 7 Dec 2021 06:52:45 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id B8DF2113865F; Tue, 7 Dec 2021 07:52:43 +0100 (CET) From: Markus Armbruster To: Jonah Palmer Subject: Re: [PATCH v10 4/8] qmp: add QMP command x-query-virtio-status References: <1638794606-19631-1-git-send-email-jonah.palmer@oracle.com> <1638794606-19631-5-git-send-email-jonah.palmer@oracle.com> Date: Tue, 07 Dec 2021 07:52:43 +0100 In-Reply-To: <1638794606-19631-5-git-send-email-jonah.palmer@oracle.com> (Jonah Palmer's message of "Mon, 6 Dec 2021 07:43:22 -0500") Message-ID: <874k7kgb44.fsf@dusky.pond.sub.org> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/27.2 (gnu/linux) MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.84 on 10.5.11.23 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=armbru@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain Received-SPF: pass client-ip=170.10.133.124; envelope-from=armbru@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -33 X-Spam_score: -3.4 X-Spam_bar: --- X-Spam_report: (-3.4 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.619, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H2=-0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: mst@redhat.com, qemu_oss@crudebyte.com, qemu-devel@nongnu.org, kraxel@redhat.com, si-wei.liu@oracle.com, joao.m.martins@oracle.com, eblake@redhat.com, qemu-block@nongnu.org, david@redhat.com, arei.gonglei@huawei.com, marcandre.lureau@redhat.com, lvivier@redhat.com, thuth@redhat.com, michael.roth@amd.com, groug@kaod.org, dgilbert@redhat.com, eric.auger@redhat.com, stefanha@redhat.com, boris.ostrovsky@oracle.com, kwolf@redhat.com, mathieu.poirier@linaro.org, raphael.norwitz@nutanix.com, pbonzini@redhat.com Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" Jonah Palmer writes: > From: Laurent Vivier > > This new command shows the status of a VirtIODevice, including > its corresponding vhost device's status (if active). > > Next patch will improve output by decoding feature bits, including > vhost device's feature bits (backend, protocol, acked, and features). > Also will decode status bits of a VirtIODevice. > > Signed-off-by: Jonah Palmer > --- [...] > diff --git a/qapi/virtio.json b/qapi/virtio.json > index 5372cde..235b8f3 100644 > --- a/qapi/virtio.json > +++ b/qapi/virtio.json > @@ -66,3 +66,223 @@ > { 'command': 'x-query-virtio', > 'returns': [ 'VirtioInfo' ], > 'features': [ 'unstable' ] } > + > +## > +# @VhostStatus: > +# > +# Information about a vhost device. This information will only be > +# displayed if the vhost device is active. > +# > +# @n-mem-sections: vhost_dev n_mem_sections > +# > +# @n-tmp-sections: vhost_dev n_tmp_sections > +# > +# @nvqs: vhost_dev nvqs (number of virtqueues being used) > +# > +# @vq-index: vhost_dev vq_index > +# > +# @features: vhost_dev features > +# > +# @acked-features: vhost_dev acked_features > +# > +# @backend-features: vhost_dev backend_features > +# > +# @protocol-features: vhost_dev protocol_features > +# > +# @max-queues: vhost_dev max_queues > +# > +# @backend-cap: vhost_dev backend_cap > +# > +# @log-enabled: vhost_dev log_enabled flag > +# > +# @log-size: vhost_dev log_size > +# > +# Since: 7.0 > +# > +## > + > +{ 'struct': 'VhostStatus', > + 'data': { 'n-mem-sections': 'int', > + 'n-tmp-sections': 'int', > + 'nvqs': 'uint32', > + 'vq-index': 'int', > + 'features': 'uint64', > + 'acked-features': 'uint64', > + 'backend-features': 'uint64', > + 'protocol-features': 'uint64', > + 'max-queues': 'uint64', > + 'backend-cap': 'uint64', > + 'log-enabled': 'bool', > + 'log-size': 'uint64' } } Extra space before } } > + > +## > +# @VirtioStatus: > +# > +# Full status of the virtio device with most VirtIODevice members. > +# Also includes the full status of the corresponding vhost device > +# if the vhost device is active. > +# > +# @name: VirtIODevice name > +# > +# @device-id: VirtIODevice ID > +# > +# @vhost-started: VirtIODevice vhost_started flag > +# > +# @guest-features: VirtIODevice guest_features > +# > +# @host-features: VirtIODevice host_features > +# > +# @backend-features: VirtIODevice backend_features > +# > +# @device-endian: VirtIODevice device_endian > +# > +# @num-vqs: VirtIODevice virtqueue count. This is the number of active > +# virtqueues being used by the VirtIODevice. > +# > +# @status: VirtIODevice configuration status (VirtioDeviceStatus) > +# > +# @isr: VirtIODevice ISR > +# > +# @queue-sel: VirtIODevice queue_sel > +# > +# @vm-running: VirtIODevice vm_running flag > +# > +# @broken: VirtIODevice broken flag > +# > +# @disabled: VirtIODevice disabled flag > +# > +# @use-started: VirtIODevice use_started flag > +# > +# @started: VirtIODevice started flag > +# > +# @start-on-kick: VirtIODevice start_on_kick flag > +# > +# @disable-legacy-check: VirtIODevice disabled_legacy_check flag > +# > +# @bus-name: VirtIODevice bus_name > +# > +# @use-guest-notifier-mask: VirtIODevice use_guest_notifier_mask flag > +# > +# @vhost-dev: Corresponding vhost device info for a given VirtIODevice Suggest to spell out: "Present if ..." > +# > +# Since: 7.0 > +# > +## > + > +{ 'struct': 'VirtioStatus', > + 'data': { 'name': 'str', > + 'device-id': 'uint16', > + 'vhost-started': 'bool', > + 'device-endian': 'str', > + 'guest-features': 'uint64', > + 'host-features': 'uint64', > + 'backend-features': 'uint64', > + 'num-vqs': 'int', > + 'status': 'uint8', > + 'isr': 'uint8', > + 'queue-sel': 'uint16', > + 'vm-running': 'bool', > + 'broken': 'bool', > + 'disabled': 'bool', > + 'use-started': 'bool', > + 'started': 'bool', > + 'start-on-kick': 'bool', > + 'disable-legacy-check': 'bool', > + 'bus-name': 'str', > + 'use-guest-notifier-mask': 'bool', > + '*vhost-dev': 'VhostStatus' } } > + > +## > +# @x-query-virtio-status: > +# > +# Poll for a comprehensive status of a given virtio device > +# > +# @path: Canonical QOM path of the VirtIODevice > +# > +# Features: > +# @unstable: This command is meant for debugging End with a period for consistency with existing docs, like you did in v9. > +# > +# Returns: VirtioStatus of the virtio device > +# > +# Since: 7.0 > +# > +# Examples: > +# > +# 1. Poll for the status of virtio-crypto (no vhost-crypto active) > +# > +# -> { "execute": "x-query-virtio-status", > +# "arguments": { "path": "/machine/peripheral/crypto0/virtio-backend" } > +# } > +# <- { "return": { > +# "device-endian": "little", > +# "bus-name": "", > +# "disable-legacy-check": false, > +# "name": "virtio-crypto", > +# "started": true, > +# "device-id": 20, > +# "backend-features": 0, > +# "start-on-kick": false, > +# "isr": 1, > +# "broken": false, > +# "status": 15, > +# "num-vqs": 2, > +# "guest-features": 5100273664, > +# "host-features": 6325010432, > +# "use-guest-notifier-mask": true, > +# "vm-running": true, > +# "queue-sel": 1, > +# "disabled": false, > +# "vhost-started": false, > +# "use-started": true > +# } > +# } > +# > +# 2. Poll for the status of virtio-net (vhost-net is active) > +# > +# -> { "execute": "x-query-virtio-status", > +# "arguments": { "path": "/machine/peripheral-anon/device[1]/virtio-backend" } > +# } > +# <- { "return": { > +# "device-endian": "little", > +# "bus-name": "", > +# "disabled-legacy-check": false, > +# "name": "virtio-net", > +# "started": true, > +# "device-id": 1, > +# "vhost-dev": { > +# "n-tmp-sections": 4, > +# "n-mem-sections": 4, > +# "max-queues": 1, > +# "backend-cap": 2, > +# "log-size": 0, > +# "backend-features": 0, > +# "nvqs": 2, > +# "protocol-features": 0, > +# "vq-index": 0, > +# "log-enabled": false, > +# "acked-features": 5100306432, > +# "features": 13908344832 > +# }, > +# "backend-features": 6337593319, > +# "start-on-kick": false, > +# "isr": 1, > +# "broken": false, > +# "status": 15, > +# "num-vqs": 3, > +# "guest-features": 5111807911, > +# "host-features": 6337593319, > +# "use-guest-notifier-mask": true, > +# "vm-running": true, > +# "queue-sel": 2, > +# "disabled": false, > +# "vhost-started": true, > +# "use-started": true > +# } > +# } > +# > +## > + > +{ 'command': 'x-query-virtio-status', > + 'data': { 'path': 'str' }, > + 'returns': 'VirtioStatus', > + 'features': [ 'unstable' ] } With my doc remarks addressed, QAPI schema Acked-by: Markus Armbruster