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 18140E7B608 for ; Wed, 4 Oct 2023 12:53:50 +0000 (UTC) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1qo1Nd-0001aX-5O; Wed, 04 Oct 2023 08:53:33 -0400 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 1qo1Na-000197-FP for qemu-devel@nongnu.org; Wed, 04 Oct 2023 08:53:30 -0400 Received: from us-smtp-delivery-124.mimecast.com ([170.10.133.124]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qo1NX-0000Ar-Ki for qemu-devel@nongnu.org; Wed, 04 Oct 2023 08:53:30 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1696424007; 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=1N9wYglfPx3Tqd+PccY3Rd7HFE9IxPI6eMxWhfx+vCw=; b=daNhfJTMMBgfxXPL5DqIa9A0CWoqq7Ptmd9GqVOAcEPMNNseDQTERv8mZ1NhzP4GoxvQCs RgkQ30wOrkty5ydH8IFKAxu0E2m6QB+YUFNYBk5Ux5zfanGlWeoPZwrBz8O0JJaairG+tJ wcQZGQsKya9tOPp9tYtxF3wxwvXsAoM= Received: from mail-wm1-f71.google.com (mail-wm1-f71.google.com [209.85.128.71]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-178-1pUk2Uu6MqaZPWwF6TwDOg-1; Wed, 04 Oct 2023 08:53:20 -0400 X-MC-Unique: 1pUk2Uu6MqaZPWwF6TwDOg-1 Received: by mail-wm1-f71.google.com with SMTP id 5b1f17b1804b1-3f5df65fa35so15427805e9.3 for ; Wed, 04 Oct 2023 05:53:20 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1696423999; x=1697028799; 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=1N9wYglfPx3Tqd+PccY3Rd7HFE9IxPI6eMxWhfx+vCw=; b=s9jncUO9hNuW6oHufsTCZD9ewkPCLab6BgUSrqy2gE6aQJoq1FgM9rHIUDSoxrR62d L9K7owkSuOYhJVfwyTgHfmh2xR1tb0xBokbdUN/+VSc7CSmH/SNPdgihSdHm9KNv9xl6 FrU/6tR9yORR8HSEGxAbB3jMWtaAr/ZF9yUXLinhPxBk6wr6Jp97gZAmQpCrXdBJgEqv mM0SsWLC3QBttHJB3JXjqkpPiuWmBYrzTCDVMyVSHd/hXpo9uVilwai7FtYVc+Jm40lE unrDRZq8Idgey+rJvJy5lgohKBXqGoHVB44CxqhBddVPmfSlsod6z71H0G7k9k052hQV CMQQ== X-Gm-Message-State: AOJu0YyqI8axWIIwsAsDTECjOqE8/FCPzJuIoaL8YaSTb9TGfzJfmznl 2zX4Mdo9S4XooycbbdVtP0K/YgKHqiDJ+L5JEPJOFcqJCHWi/noWZdxbtRGhgX6cyds66n/21kl NdBXylEfuyYjodh4= X-Received: by 2002:a1c:ed02:0:b0:401:38dc:891c with SMTP id l2-20020a1ced02000000b0040138dc891cmr2330775wmh.5.1696423999536; Wed, 04 Oct 2023 05:53:19 -0700 (PDT) X-Google-Smtp-Source: AGHT+IESfUMBe/fLoVxKYOyQaV0KkqSwspqL3m9UT1gAfWKlTtletKZHb4LvEUzqD/6jbMUisHGj5g== X-Received: by 2002:a1c:ed02:0:b0:401:38dc:891c with SMTP id l2-20020a1ced02000000b0040138dc891cmr2330753wmh.5.1696423999125; Wed, 04 Oct 2023 05:53:19 -0700 (PDT) Received: from redhat.com ([2a02:14f:173:37ff:87f3:445a:631e:51a5]) by smtp.gmail.com with ESMTPSA id c5-20020a05600c0ac500b0040586360a36sm1458435wmr.17.2023.10.04.05.53.16 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 04 Oct 2023 05:53:18 -0700 (PDT) Date: Wed, 4 Oct 2023 08:53:14 -0400 From: "Michael S. Tsirkin" To: Laszlo Ersek Cc: qemu-devel@nongnu.org, Peter Maydell , Eugenio Perez Martin , German Maglione , Liu Jiang , Sergio Lopez Pascual , Stefano Garzarella Subject: Re: [PULL 30/63] vhost-user: call VHOST_USER_SET_VRING_ENABLE synchronously Message-ID: <20231004085242-mutt-send-email-mst@kernel.org> References: MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Disposition: inline Content-Transfer-Encoding: 8bit In-Reply-To: Received-SPF: pass client-ip=170.10.133.124; envelope-from=mst@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.001, 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_H3=0.001, RCVD_IN_MSPIKE_WL=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+qemu-devel=archiver.kernel.org@nongnu.org Sender: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org On Wed, Oct 04, 2023 at 12:11:44PM +0200, Laszlo Ersek wrote: > On 10/4/23 10:44, Michael S. Tsirkin wrote: > > From: Laszlo Ersek > > > > (1) The virtio-1.2 specification > > writes: > > > >> 3 General Initialization And Device Operation > >> 3.1 Device Initialization > >> 3.1.1 Driver Requirements: Device Initialization > >> > >> [...] > >> > >> 7. Perform device-specific setup, including discovery of virtqueues for > >> the device, optional per-bus setup, reading and possibly writing the > >> device’s virtio configuration space, and population of virtqueues. > >> > >> 8. Set the DRIVER_OK status bit. At this point the device is “live”. > > > > and > > > >> 4 Virtio Transport Options > >> 4.1 Virtio Over PCI Bus > >> 4.1.4 Virtio Structure PCI Capabilities > >> 4.1.4.3 Common configuration structure layout > >> 4.1.4.3.2 Driver Requirements: Common configuration structure layout > >> > >> [...] > >> > >> The driver MUST configure the other virtqueue fields before enabling the > >> virtqueue with queue_enable. > >> > >> [...] > > > > (The same statements are present in virtio-1.0 identically, at > > .) > > > > These together mean that the following sub-sequence of steps is valid for > > a virtio-1.0 guest driver: > > > > (1.1) set "queue_enable" for the needed queues as the final part of device > > initialization step (7), > > > > (1.2) set DRIVER_OK in step (8), > > > > (1.3) immediately start sending virtio requests to the device. > > > > (2) When vhost-user is enabled, and the VHOST_USER_F_PROTOCOL_FEATURES > > special virtio feature is negotiated, then virtio rings start in disabled > > state, according to > > . > > In this case, explicit VHOST_USER_SET_VRING_ENABLE messages are needed for > > enabling vrings. > > > > Therefore setting "queue_enable" from the guest (1.1) is a *control plane* > > operation, which travels from the guest through QEMU to the vhost-user > > backend, using a unix domain socket. > > > > Whereas sending a virtio request (1.3) is a *data plane* operation, which > > evades QEMU -- it travels from guest to the vhost-user backend via > > eventfd. > > > > This means that steps (1.1) and (1.3) travel through different channels, > > and their relative order can be reversed, as perceived by the vhost-user > > backend. > > > > That's exactly what happens when OVMF's virtiofs driver (VirtioFsDxe) runs > > against the Rust-language virtiofsd version 1.7.2. (Which uses version > > 0.10.1 of the vhost-user-backend crate, and version 0.8.1 of the vhost > > crate.) > > > > Namely, when VirtioFsDxe binds a virtiofs device, it goes through the > > device initialization steps (i.e., control plane operations), and > > immediately sends a FUSE_INIT request too (i.e., performs a data plane > > operation). In the Rust-language virtiofsd, this creates a race between > > two components that run *concurrently*, i.e., in different threads or > > processes: > > > > - Control plane, handling vhost-user protocol messages: > > > > The "VhostUserSlaveReqHandlerMut::set_vring_enable" method > > [crates/vhost-user-backend/src/handler.rs] handles > > VHOST_USER_SET_VRING_ENABLE messages, and updates each vring's "enabled" > > flag according to the message processed. > > > > - Data plane, handling virtio / FUSE requests: > > > > The "VringEpollHandler::handle_event" method > > [crates/vhost-user-backend/src/event_loop.rs] handles the incoming > > virtio / FUSE request, consuming the virtio kick at the same time. If > > the vring's "enabled" flag is set, the virtio / FUSE request is > > processed genuinely. If the vring's "enabled" flag is clear, then the > > virtio / FUSE request is discarded. > > > > Note that OVMF enables the queue *first*, and sends FUSE_INIT *second*. > > However, if the data plane processor in virtiofsd wins the race, then it > > sees the FUSE_INIT *before* the control plane processor took notice of > > VHOST_USER_SET_VRING_ENABLE and green-lit the queue for the data plane > > processor. Therefore the latter drops FUSE_INIT on the floor, and goes > > back to waiting for further virtio / FUSE requests with epoll_wait. > > Meanwhile OVMF is stuck waiting for the FUSET_INIT response -- a deadlock. > > > > The deadlock is not deterministic. OVMF hangs infrequently during first > > boot. However, OVMF hangs almost certainly during reboots from the UEFI > > shell. > > > > The race can be "reliably masked" by inserting a very small delay -- a > > single debug message -- at the top of "VringEpollHandler::handle_event", > > i.e., just before the data plane processor checks the "enabled" field of > > the vring. That delay suffices for the control plane processor to act upon > > VHOST_USER_SET_VRING_ENABLE. > > > > We can deterministically prevent the race in QEMU, by blocking OVMF inside > > step (1.1) -- i.e., in the write to the "queue_enable" register -- until > > VHOST_USER_SET_VRING_ENABLE actually *completes*. That way OVMF's VCPU > > cannot advance to the FUSE_INIT submission before virtiofsd's control > > plane processor takes notice of the queue being enabled. > > > > Wait for VHOST_USER_SET_VRING_ENABLE completion by: > > > > - setting the NEED_REPLY flag on VHOST_USER_SET_VRING_ENABLE, and waiting > > for the reply, if the VHOST_USER_PROTOCOL_F_REPLY_ACK vhost-user feature > > has been negotiated, or > > > > - performing a separate VHOST_USER_GET_FEATURES *exchange*, which requires > > a backend response regardless of VHOST_USER_PROTOCOL_F_REPLY_ACK. > > > > Cc: "Michael S. Tsirkin" (supporter:vhost) > > Cc: Eugenio Perez Martin > > Cc: German Maglione > > Cc: Liu Jiang > > Cc: Sergio Lopez Pascual > > Cc: Stefano Garzarella > > Signed-off-by: Laszlo Ersek > > Reviewed-by: Stefano Garzarella > > Message-Id: <20230830134055.106812-8-lersek@redhat.com> > > Reviewed-by: Michael S. Tsirkin > > Signed-off-by: Michael S. Tsirkin > > Reviewed-by: Eugenio Pérez > > --- > > hw/virtio/vhost-user.c | 16 +++++++++++++++- > > 1 file changed, 15 insertions(+), 1 deletion(-) > > > > diff --git a/hw/virtio/vhost-user.c b/hw/virtio/vhost-user.c > > index ae0734d461..eb983ae295 100644 > > --- a/hw/virtio/vhost-user.c > > +++ b/hw/virtio/vhost-user.c > > @@ -1214,7 +1214,21 @@ static int vhost_user_set_vring_enable(struct vhost_dev *dev, int enable) > > .num = enable, > > }; > > > > - ret = vhost_set_vring(dev, VHOST_USER_SET_VRING_ENABLE, &state, false); > > + /* > > + * SET_VRING_ENABLE travels from guest to QEMU to vhost-user backend / > > + * control plane thread via unix domain socket. Virtio requests travel > > + * from guest to vhost-user backend / data plane thread via eventfd. > > + * Even if the guest enables the ring first, and pushes its first virtio > > + * request second (conforming to the virtio spec), the data plane thread > > + * in the backend may see the virtio request before the control plane > > + * thread sees the queue enablement. This causes (in fact, requires) the > > + * data plane thread to discard the virtio request (it arrived on a > > + * seemingly disabled queue). To prevent this out-of-order delivery, > > + * don't let the guest proceed to pushing the virtio request until the > > + * backend control plane acknowledges enabling the queue -- IOW, pass > > + * wait_for_reply=true below. > > + */ > > + ret = vhost_set_vring(dev, VHOST_USER_SET_VRING_ENABLE, &state, true); > > if (ret < 0) { > > /* > > * Restoring the previous state is likely infeasible, as well as > > This is not the latest version (v3) of this set -- please see > . > > Thanks, > Laszlo Ouch. OK I will drop. Feel free to send v4 tweaking commit message - I think you wanted to do it anyway right?