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 8F48CC25B75 for ; Wed, 29 May 2024 14:50:41 +0000 (UTC) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1sCKdI-0001vI-17; Wed, 29 May 2024 10:50:28 -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 1sCKdH-0001t5-0N for qemu-devel@nongnu.org; Wed, 29 May 2024 10:50:27 -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 1sCKdF-0004e8-3t for qemu-devel@nongnu.org; Wed, 29 May 2024 10:50:26 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1716994224; 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=L+GT1cq/vJQizd/i7B/UZE8uooQZETmVlvwaw7/zKWU=; b=QBwdyXEmrhcuBaEnTfHza/BG0r8AsGYusehA/fBOQrF3czpUH1/wf7hR7xlQzSrsS5trYn 7sbr/5305m/b1iHMCeNiutSeXckWbH746V7qerbhgWiflG+D/7iikiUrwvtKN2g7fHnrT6 hk/UH8MIQqur47w2RgyaRQEyKWWSuoU= Received: from mimecast-mx02.redhat.com (mx-ext.redhat.com [66.187.233.73]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-86-bYT1snBVNe2Rj5qd-J6hLQ-1; Wed, 29 May 2024 10:50:22 -0400 X-MC-Unique: bYT1snBVNe2Rj5qd-J6hLQ-1 Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.rdu2.redhat.com [10.11.54.6]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id B5D2829AA384; Wed, 29 May 2024 14:50:21 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.193.21]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 5B948200A35C; Wed, 29 May 2024 14:50:21 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 4023C21E681D; Wed, 29 May 2024 16:50:20 +0200 (CEST) From: Markus Armbruster To: Stefano Garzarella Cc: qemu-devel@nongnu.org, Hanna Reitz , Eric Blake , =?utf-8?Q?Marc-Andr=C3=A9?= Lureau , Daniel P. =?utf-8?Q?Berrang=C3=A9?= , Gerd Hoffmann , gmaglione@redhat.com, Raphael Norwitz , Laurent Vivier , Brad Smith , slp@redhat.com, stefanha@redhat.com, Igor Mammedov , Eduardo Habkost , David Hildenbrand , qemu-block@nongnu.org, Kevin Wolf , Thomas Huth , Coiby Xu , Philippe =?utf-8?Q?Mathieu-Daud=C3=A9?= , Jason Wang , Paolo Bonzini , "Michael S. Tsirkin" Subject: Re: [PATCH v6 10/12] hostmem: add a new memory backend based on POSIX shm_open() In-Reply-To: <20240528103823.146231-1-sgarzare@redhat.com> (Stefano Garzarella's message of "Tue, 28 May 2024 12:38:23 +0200") References: <20240528103543.145412-1-sgarzare@redhat.com> <20240528103823.146231-1-sgarzare@redhat.com> Date: Wed, 29 May 2024 16:50:20 +0200 Message-ID: <87sey0k6z7.fsf@pond.sub.org> User-Agent: Gnus/5.13 (Gnus v5.13) MIME-Version: 1.0 Content-Type: text/plain X-Scanned-By: MIMEDefang 3.4.1 on 10.11.54.6 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: -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.036, 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_H4=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 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 Stefano Garzarella writes: > shm_open() creates and opens a new POSIX shared memory object. > A POSIX shared memory object allows creating memory backend with an > associated file descriptor that can be shared with external processes > (e.g. vhost-user). > > The new `memory-backend-shm` can be used as an alternative when > `memory-backend-memfd` is not available (Linux only), since shm_open() > should be provided by any POSIX-compliant operating system. > > This backend mimics memfd, allocating memory that is practically > anonymous. In theory shm_open() requires a name, but this is allocated > for a short time interval and shm_unlink() is called right after > shm_open(). After that, only fd is shared with external processes > (e.g., vhost-user) as if it were associated with anonymous memory. > > In the future we may also allow the user to specify the name to be > passed to shm_open(), but for now we keep the backend simple, mimicking > anonymous memory such as memfd. > > Acked-by: David Hildenbrand > Acked-by: Stefan Hajnoczi > Signed-off-by: Stefano Garzarella > --- > v5 > - fixed documentation in qapi/qom.json and qemu-options.hx [Markus] > v4 > - fail if we find "share=off" in shm_backend_memory_alloc() [David] > v3 > - enriched commit message and documentation to highlight that we > want to mimic memfd (David) > --- > docs/system/devices/vhost-user.rst | 5 +- > qapi/qom.json | 19 +++++ > backends/hostmem-shm.c | 123 +++++++++++++++++++++++++++++ > backends/meson.build | 1 + > qemu-options.hx | 16 ++++ > 5 files changed, 162 insertions(+), 2 deletions(-) > create mode 100644 backends/hostmem-shm.c > > diff --git a/docs/system/devices/vhost-user.rst b/docs/system/devices/vhost-user.rst > index 9b2da106ce..35259d8ec7 100644 > --- a/docs/system/devices/vhost-user.rst > +++ b/docs/system/devices/vhost-user.rst > @@ -98,8 +98,9 @@ Shared memory object > > In order for the daemon to access the VirtIO queues to process the > requests it needs access to the guest's address space. This is > -achieved via the ``memory-backend-file`` or ``memory-backend-memfd`` > -objects. A reference to a file-descriptor which can access this object > +achieved via the ``memory-backend-file``, ``memory-backend-memfd``, or > +``memory-backend-shm`` objects. > +A reference to a file-descriptor which can access this object > will be passed via the socket as part of the protocol negotiation. > > Currently the shared memory object needs to match the size of the main > diff --git a/qapi/qom.json b/qapi/qom.json > index 38dde6d785..d40592d863 100644 > --- a/qapi/qom.json > +++ b/qapi/qom.json > @@ -721,6 +721,21 @@ > '*hugetlbsize': 'size', > '*seal': 'bool' } } > > +## > +# @MemoryBackendShmProperties: > +# > +# Properties for memory-backend-shm objects. > +# > +# The @share boolean option is true by default with shm. Setting it to false > +# will cause a failure during allocation because it is not supported by this > +# backend. docs/devel/qapi-code-gen.rst: For legibility, wrap text paragraphs so every line is at most 70 characters long. Separate sentences with two spaces. Result: # Properties for memory-backend-shm objects. # # The @share boolean option is true by default with shm. Setting it # to false will cause a failure during allocation because it is not # supported by this backend. However, this contradicts the doc comment for @share: # @share: if false, the memory is private to QEMU; if true, it is # shared (default: false) Your intention is to override that text. But that's less than clear. Moreover, the documentation of @share is pretty far from this override. John Snow is working on patches that'll pull it closer. Hmm, MemoryBackendMemfdProperties has the same override. I think we should change the doc comment for @share to something like # @share: if false, the memory is private to QEMU; if true, it is # shared (default depends on the backend type) and then document the actual default with each backend type. > +# > +# Since: 9.1 > +## > +{ 'struct': 'MemoryBackendShmProperties', > + 'base': 'MemoryBackendProperties', > + 'data': { } } Let's add 'if': 'CONFIG_POSIX' here. > + > ## > # @MemoryBackendEpcProperties: > # > @@ -985,6 +1000,8 @@ > { 'name': 'memory-backend-memfd', > 'if': 'CONFIG_LINUX' }, > 'memory-backend-ram', > + { 'name': 'memory-backend-shm', > + 'if': 'CONFIG_POSIX' }, > 'pef-guest', > { 'name': 'pr-manager-helper', > 'if': 'CONFIG_LINUX' }, > @@ -1056,6 +1073,8 @@ > 'memory-backend-memfd': { 'type': 'MemoryBackendMemfdProperties', > 'if': 'CONFIG_LINUX' }, > 'memory-backend-ram': 'MemoryBackendProperties', > + 'memory-backend-shm': { 'type': 'MemoryBackendShmProperties', > + 'if': 'CONFIG_POSIX' }, > 'pr-manager-helper': { 'type': 'PrManagerHelperProperties', > 'if': 'CONFIG_LINUX' }, > 'qtest': 'QtestProperties', [...] > diff --git a/qemu-options.hx b/qemu-options.hx > index 8ca7f34ef0..ad6521ef5e 100644 > --- a/qemu-options.hx > +++ b/qemu-options.hx > @@ -5240,6 +5240,22 @@ SRST > > The ``share`` boolean option is on by default with memfd. > > + ``-object memory-backend-shm,id=id,merge=on|off,dump=on|off,share=on|off,prealloc=on|off,size=size,host-nodes=host-nodes,policy=default|preferred|bind|interleave`` > + Creates a POSIX shared memory backend object, which allows > + QEMU to share the memory with an external process (e.g. when > + using vhost-user). > + > + ``memory-backend-shm`` is a more portable and less featureful version > + of ``memory-backend-memfd``. It can then be used in any POSIX system, > + especially when memfd is not supported. This actually explains the purpose, unlike the doc comment in qom.json. Same for the existing memory backends; can't fault you for doing your new one the same way. We ought to fix them all. I'm not demanding you do it. > + > + Please refer to ``memory-backend-file`` for a description of the > + options. > + > + The ``share`` boolean option is on by default with shm. Setting it to > + off will cause a failure during allocation because it is not supported > + by this backend. > + Not this patch's fault: documentation for -object memory-backend-epc is missing. > ``-object iommufd,id=id[,fd=fd]`` > Creates an iommufd backend which allows control of DMA mapping > through the ``/dev/iommu`` device.