From nobody Wed Nov 27 16:34:56 2024 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1730754358; cv=none; d=zohomail.com; s=zohoarc; b=BaVGHAsN6qeBv1vaHeFPIe0TWq+CMCwfvEndGFQdWymQ0/YbnSlYP72XRgYmnSjNTXrNPHGyFGc39f6kVuam7HmSHmaAblpNojI1ACd5rq4Sy9t7PCk9zhVe6fDolT0sUXyZgcBZWi7s0LkNQaibjHlNHmPaOgJE5SEDa6EhLj8= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1730754358; h=Content-Type:Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:Subject:To:To:Message-Id:Reply-To; bh=pO6/xC2LQ7SXQPgMt07W6ylNJnGRBeackbjMBgbgr2Q=; b=EVkoWODCrJmPpNMz242ickMJAUe7v9k9pkQYAEzgMr5/U7PNWarhoDkZE+wL4uAJYZw54JqEWwlYmEPvTg0lgM3xC8cY8of5AlX2PyyUYnnxWoETdn/R8tfoT/HUL5wiK5Jsj3BZZhVDSbzvtMJPUwzDxhxKq0Bi1wOs8SxsXXc= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1730754358178871.4574030897198; Mon, 4 Nov 2024 13:05:58 -0800 (PST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1t84Ge-0003IX-FP; Mon, 04 Nov 2024 16:05:44 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1t84Ga-0003I3-Iu for qemu-devel@nongnu.org; Mon, 04 Nov 2024 16:05:40 -0500 Received: from us-smtp-delivery-124.mimecast.com ([170.10.129.124]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1t84GY-0005G3-Q5 for qemu-devel@nongnu.org; Mon, 04 Nov 2024 16:05:40 -0500 Received: from mail-wm1-f70.google.com (mail-wm1-f70.google.com [209.85.128.70]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-541-oOFO74lmO2aVHRkwi4xSwQ-1; Mon, 04 Nov 2024 16:05:34 -0500 Received: by mail-wm1-f70.google.com with SMTP id 5b1f17b1804b1-4315eaa3189so39500425e9.1 for ; Mon, 04 Nov 2024 13:05:34 -0800 (PST) Received: from redhat.com ([2.52.14.134]) by smtp.gmail.com with ESMTPSA id ffacd0b85a97d-381c10b7d15sm14338176f8f.8.2024.11.04.13.05.30 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 04 Nov 2024 13:05:31 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1730754338; 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: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=pO6/xC2LQ7SXQPgMt07W6ylNJnGRBeackbjMBgbgr2Q=; b=MaB2oUb0SQdUj/hMUPnh+RnJt6WX+M2fEzpKZYNooP8wYYKz/HePOyXLygurfm6WRJ5Mkh 7QjkKMC/fh3ZLqSeAUX3Ch6ddugDO5ujW0zzQvYXf5S+2u79jbYQEuzl6p7oD3R1pEHGZI AiefKSJe0bJsmg64A+M0GIG4vsBCoHI= X-MC-Unique: oOFO74lmO2aVHRkwi4xSwQ-1 X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1730754333; x=1731359133; h=in-reply-to:content-transfer-encoding:content-disposition :mime-version:references:message-id:subject:cc:to:from:date :x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=pO6/xC2LQ7SXQPgMt07W6ylNJnGRBeackbjMBgbgr2Q=; b=vj1gHMRAulRUYq707K8dK7VtmHSqMciHOiyopXZzRGurzFTSvvuISIAo6NrWYaMJCY 7YEnGegQrBmaLfikVFxeHTVjEhVl49Q/P61L/eiXBdR/3hPOb8Ja6LsaNqINF4Au/Cg2 mb0w5vvYe2lFNENggfWk1q/Vl7a4bucU+hPr7uPXsh7OXaUmRZrWFRMO4scQDFbROybH rdA4Hn/70hsNe2ZxDV5idDasBcf0mBAil6YpkRFW9roRjvID+hEYQyjF3nNP11tMYCJO SVy/nZShwkrVJWYww+Mk393vquaB9+2oFXGiol/7hhRBLVSavXNl93k16iarQOPCKQ7H 5WtQ== X-Gm-Message-State: AOJu0YzBG2lnIVbI8tvksTAC1tNzyWh2HNSygfBsEO2qZdwAH9eXQaQL 8xyUcGD+QrY6JE7GBtSzfRsL8a+HnsDOqTXA/jfmJAQrrry68UHhgggqSfg+Qb7UaX+fqwNHn9/ VGr4JTcxxm+dO4M3Ndr/4bpBJLwDcSm3hLJrSFXgEY+5xpNuNy10ZLOjUgqLQ+s4beIq2DvDu1G xauXl34yhKMsPQHg5NXMZTazxpMe6WKw== X-Received: by 2002:a05:600c:3507:b0:426:59fe:ac27 with SMTP id 5b1f17b1804b1-4328327c3d5mr156658635e9.26.1730754332956; Mon, 04 Nov 2024 13:05:32 -0800 (PST) X-Google-Smtp-Source: AGHT+IGRY98VI1e4LNpdEUOQ4xrvZTCDqiXNSkMpTVbzWEBYqZySB5e1KqhoeNo6HmbQYElDRF1yTw== X-Received: by 2002:a05:600c:3507:b0:426:59fe:ac27 with SMTP id 5b1f17b1804b1-4328327c3d5mr156658345e9.26.1730754332426; Mon, 04 Nov 2024 13:05:32 -0800 (PST) Date: Mon, 4 Nov 2024 16:05:29 -0500 From: "Michael S. Tsirkin" To: qemu-devel@nongnu.org Cc: Peter Maydell , luzhixing12345 , Stefano Garzarella Subject: [PULL 02/65] docs: fix vhost-user protocol doc Message-ID: References: MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Disposition: inline Content-Transfer-Encoding: quoted-printable In-Reply-To: X-Mailer: git-send-email 2.27.0.106.g8ac3dc51b1 X-Mutt-Fcc: =sent Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=170.10.129.124; envelope-from=mst@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -23 X-Spam_score: -2.4 X-Spam_bar: -- X-Spam_report: (-2.4 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.34, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H2=-0.001, RCVD_IN_VALIDITY_CERTIFIED_BLOCKED=0.001, RCVD_IN_VALIDITY_RPBL_BLOCKED=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: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1730754358836116600 From: luzhixing12345 Some editorial tweaks to the doc: Add a ref link to Memory region description and Multiple Memory region description. Descriptions about memory regions are merged into one line. Add extra type(64 bits) to Log description structure fields Fix =E2=80=99s to 's Signed-off-by: luzhixing12345 Message-Id: <20240911060400.3472-1-luzhixing12345@gmail.com> Reviewed-by: Michael S. Tsirkin Signed-off-by: Michael S. Tsirkin --- docs/interop/vhost-user.rst | 24 +++++++++++++----------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/docs/interop/vhost-user.rst b/docs/interop/vhost-user.rst index d8419fd2f1..2e50f2ddfa 100644 --- a/docs/interop/vhost-user.rst +++ b/docs/interop/vhost-user.rst @@ -167,6 +167,8 @@ A vring address description Note that a ring address is an IOVA if ``VIRTIO_F_IOMMU_PLATFORM`` has been negotiated. Otherwise it is a user address. =20 +.. _memory_region_description: + Memory region description ^^^^^^^^^^^^^^^^^^^^^^^^^ =20 @@ -180,7 +182,7 @@ Memory region description =20 :user address: a 64-bit user address =20 -:mmap offset: 64-bit offset where region starts in the mapped memory +:mmap offset: a 64-bit offset where region starts in the mapped memory =20 When the ``VHOST_USER_PROTOCOL_F_XEN_MMAP`` protocol feature has been successfully negotiated, the memory region description contains two extra @@ -190,7 +192,7 @@ fields at the end. | guest address | size | user address | mmap offset | xen mmap flags | dom= id | +---------------+------+--------------+-------------+----------------+----= ---+ =20 -:xen mmap flags: 32-bit bit field +:xen mmap flags: a 32-bit bit field =20 - Bit 0 is set for Xen foreign memory mapping. - Bit 1 is set for Xen grant memory mapping. @@ -211,7 +213,7 @@ Single memory region description =20 :padding: 64-bit =20 -A region is represented by Memory region description. +:region: region is represented by :ref:`Memory region description `. =20 Multiple Memory regions description ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -224,7 +226,7 @@ Multiple Memory regions description =20 :padding: 32-bit =20 -A region is represented by Memory region description. +:regions: regions field contains 8 regions of type :ref:`Memory region des= cription `. =20 Log description ^^^^^^^^^^^^^^^ @@ -233,9 +235,9 @@ Log description | log size | log offset | +----------+------------+ =20 -:log size: size of area used for logging +:log size: a 64-bit size of area used for logging =20 -:log offset: offset from start of supplied file descriptor where +:log offset: a 64-bit offset from start of supplied file descriptor where logging starts (i.e. where guest address 0 would be logged) =20 @@ -382,7 +384,7 @@ the kernel implementation. =20 The communication consists of the *front-end* sending message requests and the *back-end* sending message replies. Most of the requests don't require -replies. Here is a list of the ones that do: +replies, except for the following requests: =20 * ``VHOST_USER_GET_FEATURES`` * ``VHOST_USER_GET_PROTOCOL_FEATURES`` @@ -1239,11 +1241,11 @@ Front-end message types (*a vring descriptor index for split virtqueues* vs. *vring descriptor indices for packed virtqueues*). =20 - When and as long as all of a device=E2=80=99s vrings are stopped, it is + When and as long as all of a device's vrings are stopped, it is *suspended*, see :ref:`Suspended device state `. =20 - The request payload=E2=80=99s *num* field is currently reserved and must= be + The request payload's *num* field is currently reserved and must be set to 0. =20 ``VHOST_USER_SET_VRING_KICK`` @@ -1662,7 +1664,7 @@ Front-end message types :reply payload: ``u64`` =20 Front-end and back-end negotiate a channel over which to transfer the - back-end=E2=80=99s internal state during migration. Either side (front-= end or + back-end's internal state during migration. Either side (front-end or back-end) may create the channel. The nature of this channel is not restricted or defined in this document, but whichever side creates it must create a file descriptor that is provided to the respectively @@ -1714,7 +1716,7 @@ Front-end message types :request payload: N/A :reply payload: ``u64`` =20 - After transferring the back-end=E2=80=99s internal state during migratio= n (see + After transferring the back-end's internal state during migration (see the :ref:`Migrating back-end state ` section), check whether the back-end was able to successfully fully process the state. --=20 MST