* [PATCH v13 0/7] vhost-user: Add SHMEM_MAP/UNMAP requests
@ 2026-02-19 13:03 Albert Esteve
2026-02-19 13:03 ` [PATCH v13 1/7] vhost-user: Add VirtIO Shared Memory map request Albert Esteve
` (7 more replies)
0 siblings, 8 replies; 21+ messages in thread
From: Albert Esteve @ 2026-02-19 13:03 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Xu, Pierrick Bouvier, mst, dbassey,
Philippe Mathieu-Daudé, Alex Bennée, Paolo Bonzini,
Fabiano Rosas, stefanha, manos.pitsidianakis, Stefano Garzarella,
jasowang, Laurent Vivier, slp, hi, stevensd
Hi all,
v12-v13
- SMEM_UNMAP spec update to explicitly state the use of
VHOST_USER_PROTOCOL_F_REPLY_ACK for replies
- Removed confusing remark for 0-sized regions in
GET_SHMEM_CONFIG
v11->v12
- Refined VIRTIO Shared Memory Region configuration mem size
spec description
- Removed unused name in vhost-user-base's vub_device_realize to
avoid build error
- Initialize shmem in vhost_user_backend_handle_shmem_unmap
to avoid compiler being confused
- Added stub for memory_region_init_ram_from_fd in memory.h
for windows builds
- Use memory_region_size for shmem_region handlers instead
of accessing size member directly in shmem mrs
v10->v11
- Rebase to grab commit fde5930cc37175cfcd0f03a089e26f4458a52311
and explicitly unset reply_ack on the SHMEM_MAP/UNMAP msg.
- Mention mapping cleanup on device reset in the spec.
v9->v10
- Fix transaction_commit invoked without transaction_begin
on vhost_user_backend_handle_shmem_map() early errors
- Removed fd tracking on VirtioSharedMemoryMapping, it
is handled by the RAMBlock
- Reject invalid BAR configurations when VIRTIO Shared Memory
Regions are in use by vhost-user-test-device
This patch series implements dynamic fd-backed memory mapping support
for vhost-user backends, enabling backends to dynamically request memory
mappings and unmappings during runtime through the new
VHOST_USER_BACKEND_SHMEM_MAP/UNMAP protocol messages.
This feature benefits various VIRTIO devices that require dynamic shared
memory management, including virtiofs (for DAX mappings), virtio-gpu
(for resource sharing), and the recently standardized virtio-media.
The implementation introduces a QOM-based architecture for managing
shared memory lifecycle:
- VirtioSharedMemoryMapping: an intermediate object that manages
individual memory mappings by acting as generic container for regions
declared in any vhost-user device type
- Dynamic Mapping: backends can request mappings via SHMEM_MAP messages,
with the frontend creating MemoryRegions from the provided file
descriptors and adding them as subregions
When a SHMEM_MAP request is received, the frontend:
1. Creates VirtioSharedMemoryMapping to manage the mapping lifecycle
2. Maps the provided fd with memory_region_init_ram_from_fd()
3. Creates a MemoryRegion backed by the mapped memory
4. Adds it as a subregion of the appropiate VIRTIO Shared Memory Region
The QOM reference counting ensures automatic cleanup when mappings are
removed or the device is destroyed.
This patch also includes:
- VHOST_USER_GET_SHMEM_CONFIG: a new frontend request allowing generic
vhost-user devices to query shared memory configuration from backends
at device initialization, enabling the generic vhost-user-device
frontend to work with any backend regardless of specific shared memory
requirements.
The implementation has been tested with rust-vmm based backends.
Albert Esteve (7):
vhost-user: Add VirtIO Shared Memory map request
vhost_user.rst: Align VhostUserMsg excerpt members
vhost_user.rst: Add SHMEM_MAP/_UNMAP to spec
vhost_user: Add frontend get_shmem_config command
vhost_user.rst: Add GET_SHMEM_CONFIG message
qmp: add shmem feature map
vhost-user-device: Add shared memory BAR
docs/interop/vhost-user.rst | 104 +++++++++
hw/virtio/vhost-user-base.c | 46 +++-
hw/virtio/vhost-user-test-device-pci.c | 38 ++-
hw/virtio/vhost-user.c | 269 ++++++++++++++++++++++
hw/virtio/virtio-qmp.c | 3 +
hw/virtio/virtio.c | 201 ++++++++++++++++
include/hw/virtio/vhost-backend.h | 10 +
include/hw/virtio/vhost-user.h | 1 +
include/hw/virtio/virtio.h | 137 +++++++++++
include/system/memory.h | 13 ++
subprojects/libvhost-user/libvhost-user.c | 70 ++++++
subprojects/libvhost-user/libvhost-user.h | 54 +++++
12 files changed, 941 insertions(+), 5 deletions(-)
--
2.52.0
^ permalink raw reply [flat|nested] 21+ messages in thread
* [PATCH v13 1/7] vhost-user: Add VirtIO Shared Memory map request
2026-02-19 13:03 [PATCH v13 0/7] vhost-user: Add SHMEM_MAP/UNMAP requests Albert Esteve
@ 2026-02-19 13:03 ` Albert Esteve
2026-03-04 13:08 ` Stefano Garzarella
2026-02-19 13:03 ` [PATCH v13 2/7] vhost_user.rst: Align VhostUserMsg excerpt members Albert Esteve
` (6 subsequent siblings)
7 siblings, 1 reply; 21+ messages in thread
From: Albert Esteve @ 2026-02-19 13:03 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Xu, Pierrick Bouvier, mst, dbassey,
Philippe Mathieu-Daudé, Alex Bennée, Paolo Bonzini,
Fabiano Rosas, stefanha, manos.pitsidianakis, Stefano Garzarella,
jasowang, Laurent Vivier, slp, hi, stevensd
Add SHMEM_MAP/UNMAP requests to vhost-user for dynamic management of
VIRTIO Shared Memory mappings.
This implementation introduces VirtioSharedMemoryMapping as a unified
QOM object that manages both the mapping metadata and MemoryRegion
lifecycle. This object provides reference-counted lifecycle management
with automatic cleanup of file descriptors and memory regions
through QOM finalization.
This request allows backends to dynamically map file descriptors into a
VIRTIO Shared Memory Region identified by their shmid. Maps are created
using memory_region_init_ram_from_fd() with configurable read/write
permissions, and the resulting MemoryRegions are added as subregions to
the shmem container region. The mapped memory is then advertised to the
guest VIRTIO drivers as a base address plus offset for reading and
writting according to the requested mmap flags.
The backend can unmap memory ranges within a given VIRTIO Shared Memory
Region to free resources. Upon receiving this message, the frontend
removes the MemoryRegion as a subregion and automatically unreferences
the VirtioSharedMemoryMapping object, triggering cleanup if no other
references exist.
Error handling has been improved to ensure consistent behavior across
handlers that manage their own vhost_user_send_resp() calls. Since
these handlers clear the VHOST_USER_NEED_REPLY_MASK flag, explicit
error checking ensures proper connection closure on failures,
maintaining the expected error flow.
Note the memory region commit for these operations needs to be delayed
until after we reply to the backend to avoid deadlocks. Otherwise,
the MemoryListener would send a VHOST_USER_SET_MEM_TABLE message
before the reply.
Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
Signed-off-by: Albert Esteve <aesteve@redhat.com>
---
hw/virtio/vhost-user.c | 269 ++++++++++++++++++++++
hw/virtio/virtio.c | 201 ++++++++++++++++
include/hw/virtio/virtio.h | 135 +++++++++++
include/system/memory.h | 13 ++
subprojects/libvhost-user/libvhost-user.c | 70 ++++++
subprojects/libvhost-user/libvhost-user.h | 54 +++++
6 files changed, 742 insertions(+)
diff --git a/hw/virtio/vhost-user.c b/hw/virtio/vhost-user.c
index 63fa9a1b4b..5d3841d58b 100644
--- a/hw/virtio/vhost-user.c
+++ b/hw/virtio/vhost-user.c
@@ -104,6 +104,7 @@ typedef enum VhostUserRequest {
VHOST_USER_GET_SHARED_OBJECT = 41,
VHOST_USER_SET_DEVICE_STATE_FD = 42,
VHOST_USER_CHECK_DEVICE_STATE = 43,
+ VHOST_USER_GET_SHMEM_CONFIG = 44,
VHOST_USER_MAX
} VhostUserRequest;
@@ -115,6 +116,8 @@ typedef enum VhostUserBackendRequest {
VHOST_USER_BACKEND_SHARED_OBJECT_ADD = 6,
VHOST_USER_BACKEND_SHARED_OBJECT_REMOVE = 7,
VHOST_USER_BACKEND_SHARED_OBJECT_LOOKUP = 8,
+ VHOST_USER_BACKEND_SHMEM_MAP = 9,
+ VHOST_USER_BACKEND_SHMEM_UNMAP = 10,
VHOST_USER_BACKEND_MAX
} VhostUserBackendRequest;
@@ -136,6 +139,12 @@ typedef struct VhostUserMemRegMsg {
VhostUserMemoryRegion region;
} VhostUserMemRegMsg;
+typedef struct VhostUserShMemConfig {
+ uint32_t nregions;
+ uint32_t padding;
+ uint64_t memory_sizes[VIRTIO_MAX_SHMEM_REGIONS];
+} VhostUserShMemConfig;
+
typedef struct VhostUserLog {
uint64_t mmap_size;
uint64_t mmap_offset;
@@ -192,6 +201,23 @@ typedef struct VhostUserShared {
unsigned char uuid[16];
} VhostUserShared;
+/* For the flags field of VhostUserMMap */
+#define VHOST_USER_FLAG_MAP_RW (1u << 0)
+
+typedef struct {
+ /* VIRTIO Shared Memory Region ID */
+ uint8_t shmid;
+ uint8_t padding[7];
+ /* File offset */
+ uint64_t fd_offset;
+ /* Offset within the VIRTIO Shared Memory Region */
+ uint64_t shm_offset;
+ /* Size of the mapping */
+ uint64_t len;
+ /* Flags for the mmap operation, from VHOST_USER_FLAG_MAP_* */
+ uint64_t flags;
+} VhostUserMMap;
+
typedef struct {
VhostUserRequest request;
@@ -224,6 +250,8 @@ typedef union {
VhostUserInflight inflight;
VhostUserShared object;
VhostUserTransferDeviceState transfer_state;
+ VhostUserMMap mmap;
+ VhostUserShMemConfig shmem;
} VhostUserPayload;
typedef struct VhostUserMsg {
@@ -1771,6 +1799,196 @@ vhost_user_backend_handle_shared_object_lookup(struct vhost_user *u,
return 0;
}
+/**
+ * vhost_user_backend_handle_shmem_map() - Handle SHMEM_MAP backend request
+ * @dev: vhost device
+ * @ioc: QIOChannel for communication
+ * @hdr: vhost-user message header
+ * @payload: message payload containing mapping details
+ * @fd: file descriptor for the shared memory region
+ *
+ * Handles VHOST_USER_BACKEND_SHMEM_MAP requests from the backend. Creates
+ * a VhostUserShmemObject to manage the shared memory mapping and adds it
+ * to the appropriate VirtIO shared memory region. The VhostUserShmemObject
+ * serves as an intermediate parent for the MemoryRegion, ensuring proper
+ * lifecycle management with reference counting.
+ *
+ * Returns: 0 on success, negative errno on failure
+ */
+static int
+vhost_user_backend_handle_shmem_map(struct vhost_dev *dev,
+ QIOChannel *ioc,
+ VhostUserHeader *hdr,
+ VhostUserPayload *payload,
+ int fd)
+{
+ VirtioSharedMemory *shmem;
+ VhostUserMMap *vu_mmap = &payload->mmap;
+ VirtioSharedMemoryMapping *existing;
+ Error *local_err = NULL;
+ int ret = 0;
+
+ if (fd < 0) {
+ error_report("Bad fd for map");
+ ret = -EBADF;
+ goto send_reply;
+ }
+
+ if (QSIMPLEQ_EMPTY(&dev->vdev->shmem_list)) {
+ error_report("Device has no VIRTIO Shared Memory Regions. "
+ "Requested ID: %d", vu_mmap->shmid);
+ ret = -EFAULT;
+ goto send_reply;
+ }
+
+ shmem = virtio_find_shmem_region(dev->vdev, vu_mmap->shmid);
+ if (!shmem) {
+ error_report("VIRTIO Shared Memory Region at "
+ "ID %d not found or uninitialized", vu_mmap->shmid);
+ ret = -EFAULT;
+ goto send_reply;
+ }
+
+ if ((vu_mmap->shm_offset + vu_mmap->len) < vu_mmap->len ||
+ (vu_mmap->shm_offset + vu_mmap->len) > shmem->mr.size) {
+ error_report("Bad offset/len for mmap %" PRIx64 "+%" PRIx64,
+ vu_mmap->shm_offset, vu_mmap->len);
+ ret = -EFAULT;
+ goto send_reply;
+ }
+
+ QTAILQ_FOREACH(existing, &shmem->mmaps, link) {
+ if (ranges_overlap(existing->offset, existing->len,
+ vu_mmap->shm_offset, vu_mmap->len)) {
+ error_report("VIRTIO Shared Memory mapping overlap");
+ ret = -EFAULT;
+ goto send_reply;
+ }
+ }
+
+ memory_region_transaction_begin();
+
+ /* Create VirtioSharedMemoryMapping object */
+ VirtioSharedMemoryMapping *mapping = virtio_shared_memory_mapping_new(
+ vu_mmap->shmid, fd, vu_mmap->fd_offset, vu_mmap->shm_offset,
+ vu_mmap->len, vu_mmap->flags & VHOST_USER_FLAG_MAP_RW);
+
+ if (!mapping) {
+ ret = -EFAULT;
+ goto send_reply_commit;
+ }
+
+ /* Add the mapping to the shared memory region */
+ if (virtio_add_shmem_map(shmem, mapping) != 0) {
+ error_report("Failed to add shared memory mapping");
+ object_unref(OBJECT(mapping));
+ ret = -EFAULT;
+ goto send_reply_commit;
+ }
+
+send_reply_commit:
+ /* Send reply and commit after transaction started */
+ if (hdr->flags & VHOST_USER_NEED_REPLY_MASK) {
+ payload->u64 = !!ret;
+ hdr->size = sizeof(payload->u64);
+ if (!vhost_user_send_resp(ioc, hdr, payload, &local_err)) {
+ error_report_err(local_err);
+ memory_region_transaction_commit();
+ return -EFAULT;
+ }
+ }
+ memory_region_transaction_commit();
+ return 0;
+
+send_reply:
+ if (hdr->flags & VHOST_USER_NEED_REPLY_MASK) {
+ payload->u64 = !!ret;
+ hdr->size = sizeof(payload->u64);
+ if (!vhost_user_send_resp(ioc, hdr, payload, &local_err)) {
+ error_report_err(local_err);
+ return -EFAULT;
+ }
+ }
+ return 0;
+}
+
+/**
+ * vhost_user_backend_handle_shmem_unmap() - Handle SHMEM_UNMAP backend request
+ * @dev: vhost device
+ * @ioc: QIOChannel for communication
+ * @hdr: vhost-user message header
+ * @payload: message payload containing unmapping details
+ *
+ * Handles VHOST_USER_BACKEND_SHMEM_UNMAP requests from the backend. Removes
+ * the specified memory mapping from the VirtIO shared memory region. This
+ * automatically unreferences the associated VhostUserShmemObject, which may
+ * trigger its finalization and cleanup (munmap, close fd) if no other
+ * references exist.
+ *
+ * Returns: 0 on success, negative errno on failure
+ */
+static int
+vhost_user_backend_handle_shmem_unmap(struct vhost_dev *dev,
+ QIOChannel *ioc,
+ VhostUserHeader *hdr,
+ VhostUserPayload *payload)
+{
+ VirtioSharedMemory *shmem = NULL;
+ VirtioSharedMemoryMapping *mmap = NULL;
+ VhostUserMMap *vu_mmap = &payload->mmap;
+ Error *local_err = NULL;
+ int ret = 0;
+
+ if (QSIMPLEQ_EMPTY(&dev->vdev->shmem_list)) {
+ error_report("Device has no VIRTIO Shared Memory Regions. "
+ "Requested ID: %d", vu_mmap->shmid);
+ ret = -EFAULT;
+ goto send_reply;
+ }
+
+ shmem = virtio_find_shmem_region(dev->vdev, vu_mmap->shmid);
+ if (!shmem) {
+ error_report("VIRTIO Shared Memory Region at "
+ "ID %d not found or uninitialized", vu_mmap->shmid);
+ ret = -EFAULT;
+ goto send_reply;
+ }
+
+ if ((vu_mmap->shm_offset + vu_mmap->len) < vu_mmap->len ||
+ (vu_mmap->shm_offset + vu_mmap->len) > shmem->mr.size) {
+ error_report("Bad offset/len for unmmap %" PRIx64 "+%" PRIx64,
+ vu_mmap->shm_offset, vu_mmap->len);
+ ret = -EFAULT;
+ goto send_reply;
+ }
+
+ mmap = virtio_find_shmem_map(shmem, vu_mmap->shm_offset, vu_mmap->len);
+ if (!mmap) {
+ error_report("Shared memory mapping not found at offset %" PRIx64
+ " with length %" PRIx64,
+ vu_mmap->shm_offset, vu_mmap->len);
+ ret = -EFAULT;
+ goto send_reply;
+ }
+
+send_reply:
+ if (hdr->flags & VHOST_USER_NEED_REPLY_MASK) {
+ payload->u64 = !!ret;
+ hdr->size = sizeof(payload->u64);
+ if (!vhost_user_send_resp(ioc, hdr, payload, &local_err)) {
+ error_report_err(local_err);
+ return -EFAULT;
+ }
+ }
+
+ if (!ret && shmem && mmap) {
+ /* Free the MemoryRegion only after reply */
+ virtio_del_shmem_map(shmem, vu_mmap->shm_offset, vu_mmap->len);
+ }
+
+ return 0;
+}
+
static void close_backend_channel(struct vhost_user *u)
{
g_source_destroy(u->backend_src);
@@ -1844,6 +2062,21 @@ static gboolean backend_read(QIOChannel *ioc, GIOCondition condition,
ret = vhost_user_backend_handle_shared_object_lookup(dev->opaque,
&payload.object);
break;
+ case VHOST_USER_BACKEND_SHMEM_MAP:
+ /* Handler manages its own response, check error and close connection */
+ reply_ack = false;
+ if (vhost_user_backend_handle_shmem_map(dev, ioc, &hdr, &payload,
+ fd ? fd[0] : -1) < 0) {
+ goto err;
+ }
+ break;
+ case VHOST_USER_BACKEND_SHMEM_UNMAP:
+ /* Handler manages its own response, check error and close connection */
+ reply_ack = false;
+ if (vhost_user_backend_handle_shmem_unmap(dev, ioc, &hdr, &payload) < 0) {
+ goto err;
+ }
+ break;
default:
error_report("Received unexpected msg type: %d.", hdr.request);
ret = -EINVAL;
@@ -3021,6 +3254,41 @@ static int vhost_user_check_device_state(struct vhost_dev *dev, Error **errp)
return 0;
}
+static int vhost_user_get_shmem_config(struct vhost_dev *dev,
+ int *nregions,
+ uint64_t *memory_sizes,
+ Error **errp)
+{
+ int ret;
+ VhostUserMsg msg = {
+ .hdr.request = VHOST_USER_GET_SHMEM_CONFIG,
+ .hdr.flags = VHOST_USER_VERSION,
+ };
+
+ if (!virtio_has_feature(dev->protocol_features,
+ VHOST_USER_PROTOCOL_F_SHMEM)) {
+ *nregions = 0;
+ return 0;
+ }
+
+ ret = vhost_user_write(dev, &msg, NULL, 0);
+ if (ret < 0) {
+ return ret;
+ }
+
+ ret = vhost_user_read(dev, &msg);
+ if (ret < 0) {
+ return ret;
+ }
+
+ assert(msg.payload.shmem.nregions <= VIRTIO_MAX_SHMEM_REGIONS);
+ *nregions = msg.payload.shmem.nregions;
+ memcpy(memory_sizes,
+ &msg.payload.shmem.memory_sizes,
+ sizeof(uint64_t) * VIRTIO_MAX_SHMEM_REGIONS);
+ return 0;
+}
+
const VhostOps user_ops = {
.backend_type = VHOST_BACKEND_TYPE_USER,
.vhost_backend_init = vhost_user_backend_init,
@@ -3059,4 +3327,5 @@ const VhostOps user_ops = {
.vhost_supports_device_state = vhost_user_supports_device_state,
.vhost_set_device_state_fd = vhost_user_set_device_state_fd,
.vhost_check_device_state = vhost_user_check_device_state,
+ .vhost_get_shmem_config = vhost_user_get_shmem_config,
};
diff --git a/hw/virtio/virtio.c b/hw/virtio/virtio.c
index 3dc9423eae..2f608f33ae 100644
--- a/hw/virtio/virtio.c
+++ b/hw/virtio/virtio.c
@@ -3111,6 +3111,173 @@ int virtio_save(VirtIODevice *vdev, QEMUFile *f)
return ret;
}
+VirtioSharedMemory *virtio_new_shmem_region(VirtIODevice *vdev, uint8_t shmid, uint64_t size)
+{
+ VirtioSharedMemory *elem;
+ g_autofree char *name = NULL;
+
+ elem = g_new0(VirtioSharedMemory, 1);
+ elem->shmid = shmid;
+
+ /* Initialize embedded MemoryRegion as container for shmem mappings */
+ name = g_strdup_printf("virtio-shmem-%d", shmid);
+ memory_region_init(&elem->mr, OBJECT(vdev), name, size);
+ QTAILQ_INIT(&elem->mmaps);
+ QSIMPLEQ_INSERT_TAIL(&vdev->shmem_list, elem, entry);
+ return elem;
+}
+
+VirtioSharedMemory *virtio_find_shmem_region(VirtIODevice *vdev, uint8_t shmid)
+{
+ VirtioSharedMemory *shmem, *next;
+ QSIMPLEQ_FOREACH_SAFE(shmem, &vdev->shmem_list, entry, next) {
+ if (shmem->shmid == shmid) {
+ return shmem;
+ }
+ }
+ return NULL;
+}
+
+static void virtio_shared_memory_mapping_instance_init(Object *obj)
+{
+ VirtioSharedMemoryMapping *mapping = VIRTIO_SHARED_MEMORY_MAPPING(obj);
+
+ mapping->shmid = 0;
+ mapping->offset = 0;
+ mapping->len = 0;
+ mapping->mr = NULL;
+}
+
+static void virtio_shared_memory_mapping_instance_finalize(Object *obj)
+{
+ VirtioSharedMemoryMapping *mapping = VIRTIO_SHARED_MEMORY_MAPPING(obj);
+
+ /* Clean up MemoryRegion if it exists */
+ if (mapping->mr) {
+ /* Unparent the MemoryRegion to trigger cleanup */
+ object_unparent(OBJECT(mapping->mr));
+ mapping->mr = NULL;
+ }
+}
+
+VirtioSharedMemoryMapping *virtio_shared_memory_mapping_new(uint8_t shmid,
+ int fd,
+ uint64_t fd_offset,
+ uint64_t shm_offset,
+ uint64_t len,
+ bool allow_write)
+{
+ VirtioSharedMemoryMapping *mapping;
+ MemoryRegion *mr;
+ g_autoptr(GString) mr_name = g_string_new(NULL);
+ uint32_t ram_flags;
+ Error *local_err = NULL;
+
+ if (len == 0) {
+ error_report("Shared memory mapping size cannot be zero");
+ return NULL;
+ }
+
+ fd = dup(fd);
+ if (fd < 0) {
+ error_report("Failed to duplicate fd: %s", strerror(errno));
+ return NULL;
+ }
+
+ /* Determine RAM flags */
+ ram_flags = RAM_SHARED;
+ if (!allow_write) {
+ ram_flags |= RAM_READONLY_FD;
+ }
+
+ /* Create the VirtioSharedMemoryMapping */
+ mapping = VIRTIO_SHARED_MEMORY_MAPPING(
+ object_new(TYPE_VIRTIO_SHARED_MEMORY_MAPPING));
+
+ /* Set up object properties */
+ mapping->shmid = shmid;
+ mapping->offset = shm_offset;
+ mapping->len = len;
+
+ /* Create MemoryRegion as a child of this object */
+ mr = g_new0(MemoryRegion, 1);
+ g_string_printf(mr_name, "virtio-shmem-%d-%" PRIx64, shmid, shm_offset);
+
+ /* Initialize MemoryRegion with file descriptor */
+ if (!memory_region_init_ram_from_fd(mr, OBJECT(mapping), mr_name->str,
+ len, ram_flags, fd, fd_offset,
+ &local_err)) {
+ error_report_err(local_err);
+ g_free(mr);
+ close(fd);
+ object_unref(OBJECT(mapping));
+ return NULL;
+ }
+
+ mapping->mr = mr;
+ return mapping;
+}
+
+int virtio_add_shmem_map(VirtioSharedMemory *shmem,
+ VirtioSharedMemoryMapping *mapping)
+{
+ if (!mapping) {
+ error_report("VirtioSharedMemoryMapping cannot be NULL");
+ return -1;
+ }
+ if (!mapping->mr) {
+ error_report("VirtioSharedMemoryMapping has no MemoryRegion");
+ return -1;
+ }
+
+ /* Validate boundaries against the VIRTIO shared memory region */
+ if (mapping->offset + mapping->len > memory_region_size(&shmem->mr)) {
+ error_report("Memory exceeds the shared memory boundaries");
+ return -1;
+ }
+
+ /* Add as subregion to the VIRTIO shared memory */
+ memory_region_add_subregion(&shmem->mr, mapping->offset, mapping->mr);
+
+ /* Add to the mapped regions list */
+ QTAILQ_INSERT_TAIL(&shmem->mmaps, mapping, link);
+
+ return 0;
+}
+
+VirtioSharedMemoryMapping *virtio_find_shmem_map(VirtioSharedMemory *shmem,
+ hwaddr offset, uint64_t size)
+{
+ VirtioSharedMemoryMapping *mapping;
+ QTAILQ_FOREACH(mapping, &shmem->mmaps, link) {
+ if (mapping->offset == offset && mapping->len == size) {
+ return mapping;
+ }
+ }
+ return NULL;
+}
+
+void virtio_del_shmem_map(VirtioSharedMemory *shmem, hwaddr offset,
+ uint64_t size)
+{
+ VirtioSharedMemoryMapping *mapping = virtio_find_shmem_map(shmem, offset, size);
+ if (mapping == NULL) {
+ return;
+ }
+
+ /*
+ * Remove from memory region first
+ */
+ memory_region_del_subregion(&shmem->mr, mapping->mr);
+
+ /*
+ * Remove from list and unref the mapping which will trigger automatic cleanup
+ * when the reference count reaches zero.
+ */
+ QTAILQ_REMOVE(&shmem->mmaps, mapping, link);
+ object_unref(OBJECT(mapping));
+}
+
/* A wrapper for use as a VMState .put function */
static int virtio_device_put(QEMUFile *f, void *opaque, size_t size,
const VMStateField *field, JSONWriter *vmdesc)
@@ -3237,6 +3404,7 @@ void virtio_reset(void *opaque)
{
VirtIODevice *vdev = opaque;
VirtioDeviceClass *k = VIRTIO_DEVICE_GET_CLASS(vdev);
+ VirtioSharedMemory *shmem;
uint64_t features[VIRTIO_FEATURES_NU64S];
int i;
@@ -3276,6 +3444,15 @@ void virtio_reset(void *opaque)
for (i = 0; i < VIRTIO_QUEUE_MAX; i++) {
__virtio_queue_reset(vdev, i);
}
+
+ /* Mappings are removed to prevent stale fds from remaining open. */
+ QSIMPLEQ_FOREACH(shmem, &vdev->shmem_list, entry) {
+ while (!QTAILQ_EMPTY(&shmem->mmaps)) {
+ VirtioSharedMemoryMapping *mapping = QTAILQ_FIRST(&shmem->mmaps);
+ virtio_del_shmem_map(shmem, mapping->offset,
+ memory_region_size(mapping->mr));
+ }
+ }
}
static void virtio_device_check_notification_compatibility(VirtIODevice *vdev,
@@ -3599,6 +3776,7 @@ void virtio_init(VirtIODevice *vdev, uint16_t device_id, size_t config_size)
NULL, virtio_vmstate_change, vdev);
vdev->device_endian = virtio_default_endian();
vdev->use_guest_notifier_mask = true;
+ QSIMPLEQ_INIT(&vdev->shmem_list);
}
/*
@@ -4110,11 +4288,25 @@ static void virtio_device_free_virtqueues(VirtIODevice *vdev)
static void virtio_device_instance_finalize(Object *obj)
{
VirtIODevice *vdev = VIRTIO_DEVICE(obj);
+ VirtioSharedMemory *shmem;
virtio_device_free_virtqueues(vdev);
g_free(vdev->config);
g_free(vdev->vector_queues);
+ while (!QSIMPLEQ_EMPTY(&vdev->shmem_list)) {
+ shmem = QSIMPLEQ_FIRST(&vdev->shmem_list);
+ while (!QTAILQ_EMPTY(&shmem->mmaps)) {
+ VirtioSharedMemoryMapping *mapping = QTAILQ_FIRST(&shmem->mmaps);
+ virtio_del_shmem_map(shmem, mapping->offset,
+ memory_region_size(mapping->mr));
+ }
+
+ /* Clean up the embedded MemoryRegion */
+ object_unparent(OBJECT(&shmem->mr));
+ QSIMPLEQ_REMOVE_HEAD(&vdev->shmem_list, entry);
+ g_free(shmem);
+ }
}
static const Property virtio_properties[] = {
@@ -4480,9 +4672,18 @@ static const TypeInfo virtio_device_info = {
.class_size = sizeof(VirtioDeviceClass),
};
+static const TypeInfo virtio_shared_memory_mapping_info = {
+ .name = TYPE_VIRTIO_SHARED_MEMORY_MAPPING,
+ .parent = TYPE_OBJECT,
+ .instance_size = sizeof(VirtioSharedMemoryMapping),
+ .instance_init = virtio_shared_memory_mapping_instance_init,
+ .instance_finalize = virtio_shared_memory_mapping_instance_finalize,
+};
+
static void virtio_register_types(void)
{
type_register_static(&virtio_device_info);
+ type_register_static(&virtio_shared_memory_mapping_info);
}
type_init(virtio_register_types)
diff --git a/include/hw/virtio/virtio.h b/include/hw/virtio/virtio.h
index 27cd98d2fe..40d881ca09 100644
--- a/include/hw/virtio/virtio.h
+++ b/include/hw/virtio/virtio.h
@@ -99,6 +99,45 @@ enum virtio_device_endian {
VIRTIO_DEVICE_ENDIAN_BIG,
};
+#define TYPE_VIRTIO_SHARED_MEMORY_MAPPING "virtio-shared-memory-mapping"
+OBJECT_DECLARE_SIMPLE_TYPE(VirtioSharedMemoryMapping, VIRTIO_SHARED_MEMORY_MAPPING)
+
+/**
+ * VirtioSharedMemoryMapping:
+ * @parent: Parent QOM object
+ * @shmid: VIRTIO Shared Memory Region ID
+ * @fd: File descriptor for the shared memory region
+ * @offset: Offset within the VIRTIO Shared Memory Region
+ * @len: Size of the mapping
+ * @mr: MemoryRegion associated with this shared memory mapping
+ * @link: List entry for the shared memory region's mapping list
+ *
+ * A QOM object that represents an individual file descriptor-based shared
+ * memory mapping within a VIRTIO Shared Memory Region. It manages the
+ * MemoryRegion lifecycle and file descriptor cleanup through QOM reference
+ * counting. When the object is unreferenced and its reference count drops
+ * to zero, it automatically cleans up the MemoryRegion and closes the file
+ * descriptor.
+ */
+struct VirtioSharedMemoryMapping {
+ Object parent;
+
+ uint8_t shmid;
+ hwaddr offset;
+ uint64_t len;
+ MemoryRegion *mr;
+ QTAILQ_ENTRY(VirtioSharedMemoryMapping) link;
+};
+
+struct VirtioSharedMemory {
+ uint8_t shmid;
+ MemoryRegion mr;
+ QTAILQ_HEAD(, VirtioSharedMemoryMapping) mmaps;
+ QSIMPLEQ_ENTRY(VirtioSharedMemory) entry;
+};
+
+typedef struct VirtioSharedMemory VirtioSharedMemory;
+
/**
* struct VirtIODevice - common VirtIO structure
* @name: name of the device
@@ -168,6 +207,8 @@ struct VirtIODevice
*/
EventNotifier config_notifier;
bool device_iotlb_enabled;
+ /* Shared memory region for mappings. */
+ QSIMPLEQ_HEAD(, VirtioSharedMemory) shmem_list;
};
struct VirtioDeviceClass {
@@ -298,6 +339,100 @@ void virtio_notify(VirtIODevice *vdev, VirtQueue *vq);
int virtio_save(VirtIODevice *vdev, QEMUFile *f);
+/**
+ * virtio_new_shmem_region() - Create a new shared memory region
+ * @vdev: VirtIODevice
+ * @shmid: Shared memory ID
+ * @size: Size of the shared memory region
+ *
+ * Creates a new VirtioSharedMemory region for the given device and ID.
+ * The returned VirtioSharedMemory is owned by the VirtIODevice and will
+ * be automatically freed when the device is destroyed. The caller
+ * should not free the returned pointer.
+ *
+ * Returns: Pointer to the new VirtioSharedMemory region, or NULL on failure
+ */
+VirtioSharedMemory *virtio_new_shmem_region(VirtIODevice *vdev, uint8_t shmid, uint64_t size);
+
+/**
+ * virtio_find_shmem_region() - Find an existing shared memory region
+ * @vdev: VirtIODevice
+ * @shmid: Shared memory ID to find
+ *
+ * Finds an existing VirtioSharedMemory region by ID. The returned pointer
+ * is owned by the VirtIODevice and should not be freed by the caller.
+ *
+ * Returns: Pointer to the VirtioSharedMemory region, or NULL if not found
+ */
+VirtioSharedMemory *virtio_find_shmem_region(VirtIODevice *vdev, uint8_t shmid);
+
+/**
+ * virtio_shared_memory_mapping_new() - Create a new VirtioSharedMemoryMapping
+ * @shmid: VIRTIO Shared Memory Region ID
+ * @fd: File descriptor for the shared memory
+ * @fd_offset: Offset within the file descriptor
+ * @shm_offset: Offset within the VIRTIO Shared Memory Region
+ * @len: Size of the mapping
+ * @allow_write: Whether to allow write access to the mapping
+ *
+ * Creates a new VirtioSharedMemoryMapping that manages a shared memory mapping.
+ * The object will create a MemoryRegion using memory_region_init_ram_from_fd()
+ * as a child object. When the object is finalized, it will automatically
+ * clean up the MemoryRegion and close the file descriptor.
+ *
+ * Return: A new VirtioSharedMemoryMapping on success, NULL on error.
+ */
+VirtioSharedMemoryMapping *virtio_shared_memory_mapping_new(uint8_t shmid,
+ int fd,
+ uint64_t fd_offset,
+ uint64_t shm_offset,
+ uint64_t len,
+ bool allow_write);
+
+/**
+ * virtio_add_shmem_map() - Add a memory mapping to a shared region
+ * @shmem: VirtioSharedMemory region
+ * @mapping: VirtioSharedMemoryMapping to add (transfers ownership)
+ *
+ * Adds a memory mapping to the shared memory region. The VirtioSharedMemoryMapping
+ * ownership is transferred to the shared memory region and will be automatically
+ * cleaned up through QOM reference counting when virtio_del_shmem_map() is
+ * called or when the shared memory region is destroyed.
+ *
+ * Returns: 0 on success, negative errno on failure
+ */
+int virtio_add_shmem_map(VirtioSharedMemory *shmem,
+ VirtioSharedMemoryMapping *mapping);
+
+/**
+ * virtio_find_shmem_map() - Find a memory mapping in a shared region
+ * @shmem: VirtioSharedMemory region
+ * @offset: Offset within the shared memory region
+ * @size: Size of the mapping to find
+ *
+ * Finds an existing memory mapping that covers the specified range.
+ * The returned VirtioSharedMemoryMapping is owned by the VirtioSharedMemory
+ * region and should not be freed by the caller.
+ *
+ * Returns: Pointer to the VirtioSharedMemoryMapping, or NULL if not found
+ */
+VirtioSharedMemoryMapping *virtio_find_shmem_map(VirtioSharedMemory *shmem,
+ hwaddr offset, uint64_t size);
+
+/**
+ * virtio_del_shmem_map() - Remove a memory mapping from a shared region
+ * @shmem: VirtioSharedMemory region
+ * @offset: Offset of the mapping to remove
+ * @size: Size of the mapping to remove
+ *
+ * Removes a memory mapping from the shared memory region. This will
+ * automatically unref the associated VhostUserShmemObject, which may
+ * trigger its finalization and cleanup if no other references exist.
+ * The mapping's MemoryRegion will be properly unmapped and cleaned up.
+ */
+void virtio_del_shmem_map(VirtioSharedMemory *shmem, hwaddr offset,
+ uint64_t size);
+
extern const VMStateInfo virtio_vmstate_info;
#define VMSTATE_VIRTIO_DEVICE \
diff --git a/include/system/memory.h b/include/system/memory.h
index 0562af3136..14dd48e525 100644
--- a/include/system/memory.h
+++ b/include/system/memory.h
@@ -1518,6 +1518,19 @@ bool memory_region_init_ram_from_fd(MemoryRegion *mr,
int fd,
ram_addr_t offset,
Error **errp);
+#else
+static inline bool memory_region_init_ram_from_fd(MemoryRegion *mr,
+ Object *owner,
+ const char *name,
+ uint64_t size,
+ uint32_t ram_flags,
+ int fd,
+ ram_addr_t offset,
+ Error **errp)
+{
+ error_setg(errp, "memory_region_init_ram_from_fd is not supported on this platform");
+ return false;
+}
#endif
/**
diff --git a/subprojects/libvhost-user/libvhost-user.c b/subprojects/libvhost-user/libvhost-user.c
index 9c630c2170..034cbfdc3c 100644
--- a/subprojects/libvhost-user/libvhost-user.c
+++ b/subprojects/libvhost-user/libvhost-user.c
@@ -1592,6 +1592,76 @@ vu_rm_shared_object(VuDev *dev, unsigned char uuid[UUID_LEN])
return vu_send_message(dev, &msg);
}
+bool
+vu_shmem_map(VuDev *dev, uint8_t shmid, uint64_t fd_offset,
+ uint64_t shm_offset, uint64_t len, uint64_t flags, int fd)
+{
+ VhostUserMsg vmsg = {
+ .request = VHOST_USER_BACKEND_SHMEM_MAP,
+ .size = sizeof(vmsg.payload.mmap),
+ .flags = VHOST_USER_VERSION,
+ .payload.mmap = {
+ .shmid = shmid,
+ .fd_offset = fd_offset,
+ .shm_offset = shm_offset,
+ .len = len,
+ .flags = flags,
+ },
+ .fd_num = 1,
+ .fds[0] = fd,
+ };
+
+ if (!vu_has_protocol_feature(dev, VHOST_USER_PROTOCOL_F_SHMEM)) {
+ return false;
+ }
+
+ if (vu_has_protocol_feature(dev, VHOST_USER_PROTOCOL_F_REPLY_ACK)) {
+ vmsg.flags |= VHOST_USER_NEED_REPLY_MASK;
+ }
+
+ pthread_mutex_lock(&dev->backend_mutex);
+ if (!vu_message_write(dev, dev->backend_fd, &vmsg)) {
+ pthread_mutex_unlock(&dev->backend_mutex);
+ return false;
+ }
+
+ /* Also unlocks the backend_mutex */
+ return vu_process_message_reply(dev, &vmsg);
+}
+
+bool
+vu_shmem_unmap(VuDev *dev, uint8_t shmid, uint64_t shm_offset, uint64_t len)
+{
+ VhostUserMsg vmsg = {
+ .request = VHOST_USER_BACKEND_SHMEM_UNMAP,
+ .size = sizeof(vmsg.payload.mmap),
+ .flags = VHOST_USER_VERSION,
+ .payload.mmap = {
+ .shmid = shmid,
+ .fd_offset = 0,
+ .shm_offset = shm_offset,
+ .len = len,
+ },
+ };
+
+ if (!vu_has_protocol_feature(dev, VHOST_USER_PROTOCOL_F_SHMEM)) {
+ return false;
+ }
+
+ if (vu_has_protocol_feature(dev, VHOST_USER_PROTOCOL_F_REPLY_ACK)) {
+ vmsg.flags |= VHOST_USER_NEED_REPLY_MASK;
+ }
+
+ pthread_mutex_lock(&dev->backend_mutex);
+ if (!vu_message_write(dev, dev->backend_fd, &vmsg)) {
+ pthread_mutex_unlock(&dev->backend_mutex);
+ return false;
+ }
+
+ /* Also unlocks the backend_mutex */
+ return vu_process_message_reply(dev, &vmsg);
+}
+
static bool
vu_set_vring_call_exec(VuDev *dev, VhostUserMsg *vmsg)
{
diff --git a/subprojects/libvhost-user/libvhost-user.h b/subprojects/libvhost-user/libvhost-user.h
index 2ffc58c11b..6a2d0f9fae 100644
--- a/subprojects/libvhost-user/libvhost-user.h
+++ b/subprojects/libvhost-user/libvhost-user.h
@@ -69,6 +69,8 @@ enum VhostUserProtocolFeature {
/* Feature 16 is reserved for VHOST_USER_PROTOCOL_F_STATUS. */
/* Feature 17 reserved for VHOST_USER_PROTOCOL_F_XEN_MMAP. */
VHOST_USER_PROTOCOL_F_SHARED_OBJECT = 18,
+ /* Feature 19 is reserved for VHOST_USER_PROTOCOL_F_DEVICE_STATE */
+ VHOST_USER_PROTOCOL_F_SHMEM = 20,
VHOST_USER_PROTOCOL_F_MAX
};
@@ -127,6 +129,8 @@ typedef enum VhostUserBackendRequest {
VHOST_USER_BACKEND_SHARED_OBJECT_ADD = 6,
VHOST_USER_BACKEND_SHARED_OBJECT_REMOVE = 7,
VHOST_USER_BACKEND_SHARED_OBJECT_LOOKUP = 8,
+ VHOST_USER_BACKEND_SHMEM_MAP = 9,
+ VHOST_USER_BACKEND_SHMEM_UNMAP = 10,
VHOST_USER_BACKEND_MAX
} VhostUserBackendRequest;
@@ -186,6 +190,23 @@ typedef struct VhostUserShared {
unsigned char uuid[UUID_LEN];
} VhostUserShared;
+/* For the flags field of VhostUserMMap */
+#define VHOST_USER_FLAG_MAP_RW (1u << 0)
+
+typedef struct {
+ /* VIRTIO Shared Memory Region ID */
+ uint8_t shmid;
+ uint8_t padding[7];
+ /* File offset */
+ uint64_t fd_offset;
+ /* Offset within the VIRTIO Shared Memory Region */
+ uint64_t shm_offset;
+ /* Size of the mapping */
+ uint64_t len;
+ /* Flags for the mmap operation, from VHOST_USER_FLAG_MAP_* */
+ uint64_t flags;
+} VhostUserMMap;
+
#define VU_PACKED __attribute__((packed))
typedef struct VhostUserMsg {
@@ -210,6 +231,7 @@ typedef struct VhostUserMsg {
VhostUserVringArea area;
VhostUserInflight inflight;
VhostUserShared object;
+ VhostUserMMap mmap;
} payload;
int fds[VHOST_MEMORY_BASELINE_NREGIONS];
@@ -593,6 +615,38 @@ bool vu_add_shared_object(VuDev *dev, unsigned char uuid[UUID_LEN]);
*/
bool vu_rm_shared_object(VuDev *dev, unsigned char uuid[UUID_LEN]);
+/**
+ * vu_shmem_map:
+ * @dev: a VuDev context
+ * @shmid: VIRTIO Shared Memory Region ID
+ * @fd_offset: File offset
+ * @shm_offset: Offset within the VIRTIO Shared Memory Region
+ * @len: Size of the mapping
+ * @flags: Flags for the mmap operation
+ * @fd: A file descriptor
+ *
+ * Advertises a new mapping to be made in a given VIRTIO Shared Memory Region.
+ *
+ * Returns: TRUE on success, FALSE on failure.
+ */
+bool vu_shmem_map(VuDev *dev, uint8_t shmid, uint64_t fd_offset,
+ uint64_t shm_offset, uint64_t len, uint64_t flags, int fd);
+
+/**
+ * vu_shmem_unmap:
+ * @dev: a VuDev context
+ * @shmid: VIRTIO Shared Memory Region ID
+ * @fd_offset: File offset
+ * @len: Size of the mapping
+ *
+ * The front-end un-mmaps a given range in the VIRTIO Shared Memory Region
+ * with the requested `shmid`.
+ *
+ * Returns: TRUE on success, FALSE on failure.
+ */
+bool vu_shmem_unmap(VuDev *dev, uint8_t shmid, uint64_t shm_offset,
+ uint64_t len);
+
/**
* vu_queue_set_notification:
* @dev: a VuDev context
--
2.52.0
^ permalink raw reply related [flat|nested] 21+ messages in thread
* [PATCH v13 2/7] vhost_user.rst: Align VhostUserMsg excerpt members
2026-02-19 13:03 [PATCH v13 0/7] vhost-user: Add SHMEM_MAP/UNMAP requests Albert Esteve
2026-02-19 13:03 ` [PATCH v13 1/7] vhost-user: Add VirtIO Shared Memory map request Albert Esteve
@ 2026-02-19 13:03 ` Albert Esteve
2026-03-04 13:10 ` Stefano Garzarella
2026-02-19 13:03 ` [PATCH v13 3/7] vhost_user.rst: Add SHMEM_MAP/_UNMAP to spec Albert Esteve
` (5 subsequent siblings)
7 siblings, 1 reply; 21+ messages in thread
From: Albert Esteve @ 2026-02-19 13:03 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Xu, Pierrick Bouvier, mst, dbassey,
Philippe Mathieu-Daudé, Alex Bennée, Paolo Bonzini,
Fabiano Rosas, stefanha, manos.pitsidianakis, Stefano Garzarella,
jasowang, Laurent Vivier, slp, hi, stevensd
Add missing members to the VhostUserMsg excerpt in
the vhost-user spec documentation.
Reviewed-by: David Hildenbrand <david@redhat.com>
Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
Signed-off-by: Albert Esteve <aesteve@redhat.com>
---
docs/interop/vhost-user.rst | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/docs/interop/vhost-user.rst b/docs/interop/vhost-user.rst
index 93a9c8df2b..17a68a62eb 100644
--- a/docs/interop/vhost-user.rst
+++ b/docs/interop/vhost-user.rst
@@ -366,11 +366,15 @@ In QEMU the vhost-user message is implemented with the following struct:
struct vhost_vring_state state;
struct vhost_vring_addr addr;
VhostUserMemory memory;
+ VhostUserMemRegMsg mem_reg;
VhostUserLog log;
struct vhost_iotlb_msg iotlb;
VhostUserConfig config;
+ VhostUserCryptoSession session;
VhostUserVringArea area;
VhostUserInflight inflight;
+ VhostUserShared object;
+ VhostUserTransferDeviceState transfer_state;
};
} QEMU_PACKED VhostUserMsg;
--
2.52.0
^ permalink raw reply related [flat|nested] 21+ messages in thread
* [PATCH v13 3/7] vhost_user.rst: Add SHMEM_MAP/_UNMAP to spec
2026-02-19 13:03 [PATCH v13 0/7] vhost-user: Add SHMEM_MAP/UNMAP requests Albert Esteve
2026-02-19 13:03 ` [PATCH v13 1/7] vhost-user: Add VirtIO Shared Memory map request Albert Esteve
2026-02-19 13:03 ` [PATCH v13 2/7] vhost_user.rst: Align VhostUserMsg excerpt members Albert Esteve
@ 2026-02-19 13:03 ` Albert Esteve
2026-02-21 13:54 ` Alyssa Ross
2026-03-04 9:46 ` Albert Esteve
2026-02-19 13:03 ` [PATCH v13 4/7] vhost_user: Add frontend get_shmem_config command Albert Esteve
` (4 subsequent siblings)
7 siblings, 2 replies; 21+ messages in thread
From: Albert Esteve @ 2026-02-19 13:03 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Xu, Pierrick Bouvier, mst, dbassey,
Philippe Mathieu-Daudé, Alex Bennée, Paolo Bonzini,
Fabiano Rosas, stefanha, manos.pitsidianakis, Stefano Garzarella,
jasowang, Laurent Vivier, slp, hi, stevensd
Add SHMEM_MAP/_UNMAP request to the vhost-user
spec documentation.
Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
Reviewed-by: Manos Pitsidianakis <manos.pitsidianakis@linaro.org>
Signed-off-by: Albert Esteve <aesteve@redhat.com>
---
docs/interop/vhost-user.rst | 61 +++++++++++++++++++++++++++++++++++++
1 file changed, 61 insertions(+)
diff --git a/docs/interop/vhost-user.rst b/docs/interop/vhost-user.rst
index 17a68a62eb..ae4ad6f441 100644
--- a/docs/interop/vhost-user.rst
+++ b/docs/interop/vhost-user.rst
@@ -350,6 +350,27 @@ Device state transfer parameters
In the future, additional phases might be added e.g. to allow
iterative migration while the device is running.
+MMAP request
+^^^^^^^^^^^^
+
++-------+---------+-----------+------------+-----+-------+
+| shmid | padding | fd_offset | shm_offset | len | flags |
++-------+---------+-----------+------------+-----+-------+
+
+:shmid: a 8-bit shared memory region identifier
+
+:fd_offset: a 64-bit offset of this area from the start
+ of the supplied file descriptor
+
+:shm_offset: a 64-bit offset from the start of the
+ pointed shared memory region
+
+:len: a 64-bit size of the memory to map
+
+:flags: a 64-bit value:
+ - 0: Pages are mapped read-only
+ - 1: Pages are mapped read-write
+
C structure
-----------
@@ -375,6 +396,7 @@ In QEMU the vhost-user message is implemented with the following struct:
VhostUserInflight inflight;
VhostUserShared object;
VhostUserTransferDeviceState transfer_state;
+ VhostUserMMap mmap;
};
} QEMU_PACKED VhostUserMsg;
@@ -1064,6 +1086,7 @@ Protocol features
#define VHOST_USER_PROTOCOL_F_XEN_MMAP 17
#define VHOST_USER_PROTOCOL_F_SHARED_OBJECT 18
#define VHOST_USER_PROTOCOL_F_DEVICE_STATE 19
+ #define VHOST_USER_PROTOCOL_F_SHMEM 20
Front-end message types
-----------------------
@@ -1872,6 +1895,44 @@ is sent by the front-end.
when the operation is successful, or non-zero otherwise. Note that if the
operation fails, no fd is sent to the backend.
+``VHOST_USER_BACKEND_SHMEM_MAP``
+ :id: 9
+ :equivalent ioctl: N/A
+ :request payload: fd and ``struct VhostUserMMap``
+ :reply payload: N/A
+
+ When the ``VHOST_USER_PROTOCOL_F_SHMEM`` protocol feature has been
+ successfully negotiated, this message can be submitted by the backends to
+ advertise a new mapping to be made in a given VIRTIO Shared Memory Region.
+ Upon receiving the message, the front-end will mmap the given fd into the
+ VIRTIO Shared Memory Region with the requested ``shmid``.
+ If ``VHOST_USER_PROTOCOL_F_REPLY_ACK`` is negotiated, and
+ back-end set the ``VHOST_USER_NEED_REPLY`` flag, the front-end
+ must respond with zero when operation is successfully completed,
+ or non-zero otherwise.
+
+ Mapping over an already existing map is not allowed and requests shall fail.
+ Therefore, the memory range in the request must correspond with a valid,
+ free region of the VIRTIO Shared Memory Region. Also, note that mappings
+ consume resources and that the request can fail when there are no resources
+ available. Lastly, mappings are automatically unmapped by the front-end
+ across device reset operation.
+
+``VHOST_USER_BACKEND_SHMEM_UNMAP``
+ :id: 10
+ :equivalent ioctl: N/A
+ :request payload: ``struct VhostUserMMap``
+ :reply payload: N/A
+
+ When the ``VHOST_USER_PROTOCOL_F_SHMEM`` protocol feature has been
+ successfully negotiated, this message can be submitted by the backends so
+ that the front-end un-mmaps a given range (``shm_offset``, ``len``) in the
+ VIRTIO Shared Memory Region with the requested ``shmid``. Note that the
+ given range shall correspond to the entirety of a valid mapped region.
+ If ``VHOST_USER_PROTOCOL_F_REPLY_ACK`` is negotiated, and the back-end
+ sets the ``VHOST_USER_NEED_REPLY`` flag, the front-end must respond with
+ zero when operation is successfully completed, or non-zero otherwise.
+
.. _reply_ack:
VHOST_USER_PROTOCOL_F_REPLY_ACK
--
2.52.0
^ permalink raw reply related [flat|nested] 21+ messages in thread
* [PATCH v13 4/7] vhost_user: Add frontend get_shmem_config command
2026-02-19 13:03 [PATCH v13 0/7] vhost-user: Add SHMEM_MAP/UNMAP requests Albert Esteve
` (2 preceding siblings ...)
2026-02-19 13:03 ` [PATCH v13 3/7] vhost_user.rst: Add SHMEM_MAP/_UNMAP to spec Albert Esteve
@ 2026-02-19 13:03 ` Albert Esteve
2026-03-04 13:12 ` Stefano Garzarella
2026-02-19 13:03 ` [PATCH v13 5/7] vhost_user.rst: Add GET_SHMEM_CONFIG message Albert Esteve
` (3 subsequent siblings)
7 siblings, 1 reply; 21+ messages in thread
From: Albert Esteve @ 2026-02-19 13:03 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Xu, Pierrick Bouvier, mst, dbassey,
Philippe Mathieu-Daudé, Alex Bennée, Paolo Bonzini,
Fabiano Rosas, stefanha, manos.pitsidianakis, Stefano Garzarella,
jasowang, Laurent Vivier, slp, hi, stevensd
The frontend can use this command to retrieve
VirtIO Shared Memory Regions configuration from
the backend. The response contains the number of
shared memory regions, their size, and shmid.
This is useful when the frontend is unaware of
specific backend type and configuration,
for example, in the `vhost-user-device` case.
Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
Signed-off-by: Albert Esteve <aesteve@redhat.com>
---
include/hw/virtio/vhost-backend.h | 10 ++++++++++
include/hw/virtio/vhost-user.h | 1 +
include/hw/virtio/virtio.h | 2 ++
3 files changed, 13 insertions(+)
diff --git a/include/hw/virtio/vhost-backend.h b/include/hw/virtio/vhost-backend.h
index ff94fa1734..ce58b4d2d6 100644
--- a/include/hw/virtio/vhost-backend.h
+++ b/include/hw/virtio/vhost-backend.h
@@ -163,6 +163,15 @@ typedef int (*vhost_set_device_state_fd_op)(struct vhost_dev *dev,
int *reply_fd,
Error **errp);
typedef int (*vhost_check_device_state_op)(struct vhost_dev *dev, Error **errp);
+/*
+ * Max regions is VIRTIO_MAX_SHMEM_REGIONS, so that is the maximum
+ * number of memory_sizes that will be accepted.
+ */
+typedef int (*vhost_get_shmem_config_op)(struct vhost_dev *dev,
+ int *nregions,
+ uint64_t *memory_sizes,
+ Error **errp);
+
typedef struct VhostOps {
VhostBackendType backend_type;
@@ -220,6 +229,7 @@ typedef struct VhostOps {
vhost_supports_device_state_op vhost_supports_device_state;
vhost_set_device_state_fd_op vhost_set_device_state_fd;
vhost_check_device_state_op vhost_check_device_state;
+ vhost_get_shmem_config_op vhost_get_shmem_config;
} VhostOps;
int vhost_backend_update_device_iotlb(struct vhost_dev *dev,
diff --git a/include/hw/virtio/vhost-user.h b/include/hw/virtio/vhost-user.h
index 55d5725ef8..8ac2120cfd 100644
--- a/include/hw/virtio/vhost-user.h
+++ b/include/hw/virtio/vhost-user.h
@@ -32,6 +32,7 @@ enum VhostUserProtocolFeature {
/* Feature 17 reserved for VHOST_USER_PROTOCOL_F_XEN_MMAP. */
VHOST_USER_PROTOCOL_F_SHARED_OBJECT = 18,
VHOST_USER_PROTOCOL_F_DEVICE_STATE = 19,
+ VHOST_USER_PROTOCOL_F_SHMEM = 20,
VHOST_USER_PROTOCOL_F_MAX
};
diff --git a/include/hw/virtio/virtio.h b/include/hw/virtio/virtio.h
index 40d881ca09..9aef913af0 100644
--- a/include/hw/virtio/virtio.h
+++ b/include/hw/virtio/virtio.h
@@ -82,6 +82,8 @@ typedef struct VirtQueueElement
#define VIRTIO_NO_VECTOR 0xffff
+#define VIRTIO_MAX_SHMEM_REGIONS 256
+
/* special index value used internally for config irqs */
#define VIRTIO_CONFIG_IRQ_IDX -1
--
2.52.0
^ permalink raw reply related [flat|nested] 21+ messages in thread
* [PATCH v13 5/7] vhost_user.rst: Add GET_SHMEM_CONFIG message
2026-02-19 13:03 [PATCH v13 0/7] vhost-user: Add SHMEM_MAP/UNMAP requests Albert Esteve
` (3 preceding siblings ...)
2026-02-19 13:03 ` [PATCH v13 4/7] vhost_user: Add frontend get_shmem_config command Albert Esteve
@ 2026-02-19 13:03 ` Albert Esteve
2026-03-04 13:12 ` Stefano Garzarella
2026-02-19 13:03 ` [PATCH v13 6/7] qmp: add shmem feature map Albert Esteve
` (2 subsequent siblings)
7 siblings, 1 reply; 21+ messages in thread
From: Albert Esteve @ 2026-02-19 13:03 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Xu, Pierrick Bouvier, mst, dbassey,
Philippe Mathieu-Daudé, Alex Bennée, Paolo Bonzini,
Fabiano Rosas, stefanha, manos.pitsidianakis, Stefano Garzarella,
jasowang, Laurent Vivier, slp, hi, stevensd
Add GET_SHMEM_CONFIG vhost-user frontend
message to the spec documentation.
Reviewed-by: Alyssa Ross <hi@alyssa.is>
Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
Signed-off-by: Albert Esteve <aesteve@redhat.com>
---
docs/interop/vhost-user.rst | 39 +++++++++++++++++++++++++++++++++++++
1 file changed, 39 insertions(+)
diff --git a/docs/interop/vhost-user.rst b/docs/interop/vhost-user.rst
index ae4ad6f441..77a763c7c3 100644
--- a/docs/interop/vhost-user.rst
+++ b/docs/interop/vhost-user.rst
@@ -371,6 +371,22 @@ MMAP request
- 0: Pages are mapped read-only
- 1: Pages are mapped read-write
+VIRTIO Shared Memory Region configuration
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
++-------------+---------+------------+----+--------------+
+| num regions | padding | mem size 0 | .. | mem size 255 |
++-------------+---------+------------+----+--------------+
+
+:num regions: a 32-bit number of regions
+
+:padding: 32-bit
+
+:mem size: an array of 256 64-bit fields representing the size of each
+ VIRTIO Shared Memory Region. ``num regions`` specifies the
+ number of valid regions (non-zero size). The array index
+ corresponds to the shared memory ID (shmid).
+
C structure
-----------
@@ -397,6 +413,7 @@ In QEMU the vhost-user message is implemented with the following struct:
VhostUserShared object;
VhostUserTransferDeviceState transfer_state;
VhostUserMMap mmap;
+ VhostUserShMemConfig shmem;
};
} QEMU_PACKED VhostUserMsg;
@@ -1761,6 +1778,28 @@ Front-end message types
Using this function requires prior negotiation of the
``VHOST_USER_PROTOCOL_F_DEVICE_STATE`` feature.
+``VHOST_USER_GET_SHMEM_CONFIG``
+ :id: 44
+ :equivalent ioctl: N/A
+ :request payload: N/A
+ :reply payload: ``struct VhostUserShMemConfig``
+
+ When the ``VHOST_USER_PROTOCOL_F_SHMEM`` protocol feature has been
+ successfully negotiated, this message can be submitted by the front-end
+ to gather the VIRTIO Shared Memory Region configuration. The back-end will
+ respond with the number of VIRTIO Shared Memory Regions it requires, and
+ each shared memory region size in an array. The shared memory IDs are
+ represented by the array index. The information returned shall comply
+ with the following rules:
+
+ * The shared information will remain valid and unchanged for the entire
+ lifetime of the connection.
+
+ * The Shared Memory Region size must be a multiple of the page size
+ supported by mmap(2).
+
+ * The size may be 0 if the region is unused.
+
Back-end message types
----------------------
--
2.52.0
^ permalink raw reply related [flat|nested] 21+ messages in thread
* [PATCH v13 6/7] qmp: add shmem feature map
2026-02-19 13:03 [PATCH v13 0/7] vhost-user: Add SHMEM_MAP/UNMAP requests Albert Esteve
` (4 preceding siblings ...)
2026-02-19 13:03 ` [PATCH v13 5/7] vhost_user.rst: Add GET_SHMEM_CONFIG message Albert Esteve
@ 2026-02-19 13:03 ` Albert Esteve
2026-03-04 13:13 ` Stefano Garzarella
2026-02-19 13:03 ` [PATCH v13 7/7] vhost-user-device: Add shared memory BAR Albert Esteve
2026-03-04 13:28 ` [PATCH v13 0/7] vhost-user: Add SHMEM_MAP/UNMAP requests Stefano Garzarella
7 siblings, 1 reply; 21+ messages in thread
From: Albert Esteve @ 2026-02-19 13:03 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Xu, Pierrick Bouvier, mst, dbassey,
Philippe Mathieu-Daudé, Alex Bennée, Paolo Bonzini,
Fabiano Rosas, stefanha, manos.pitsidianakis, Stefano Garzarella,
jasowang, Laurent Vivier, slp, hi, stevensd
Add new vhost-user protocol
VHOST_USER_PROTOCOL_F_SHMEM feature to
feature map.
Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
Signed-off-by: Albert Esteve <aesteve@redhat.com>
---
hw/virtio/virtio-qmp.c | 3 +++
1 file changed, 3 insertions(+)
diff --git a/hw/virtio/virtio-qmp.c b/hw/virtio/virtio-qmp.c
index 968299fda0..e3d0a10a59 100644
--- a/hw/virtio/virtio-qmp.c
+++ b/hw/virtio/virtio-qmp.c
@@ -127,6 +127,9 @@ static const qmp_virtio_feature_map_t vhost_user_protocol_map[] = {
FEATURE_ENTRY(VHOST_USER_PROTOCOL_F_DEVICE_STATE, \
"VHOST_USER_PROTOCOL_F_DEVICE_STATE: Backend device state transfer "
"supported"),
+ FEATURE_ENTRY(VHOST_USER_PROTOCOL_F_SHMEM, \
+ "VHOST_USER_PROTOCOL_F_SHMEM: Backend shared memory mapping "
+ "supported"),
{ -1, "" }
};
--
2.52.0
^ permalink raw reply related [flat|nested] 21+ messages in thread
* [PATCH v13 7/7] vhost-user-device: Add shared memory BAR
2026-02-19 13:03 [PATCH v13 0/7] vhost-user: Add SHMEM_MAP/UNMAP requests Albert Esteve
` (5 preceding siblings ...)
2026-02-19 13:03 ` [PATCH v13 6/7] qmp: add shmem feature map Albert Esteve
@ 2026-02-19 13:03 ` Albert Esteve
2026-03-04 13:26 ` Stefano Garzarella
2026-03-04 13:28 ` [PATCH v13 0/7] vhost-user: Add SHMEM_MAP/UNMAP requests Stefano Garzarella
7 siblings, 1 reply; 21+ messages in thread
From: Albert Esteve @ 2026-02-19 13:03 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Xu, Pierrick Bouvier, mst, dbassey,
Philippe Mathieu-Daudé, Alex Bennée, Paolo Bonzini,
Fabiano Rosas, stefanha, manos.pitsidianakis, Stefano Garzarella,
jasowang, Laurent Vivier, slp, hi, stevensd
Add shared memory BAR support to vhost-user-device-pci
to enable direct file mapping for VIRTIO Shared
Memory Regions.
The implementation creates a consolidated shared
memory BAR that contains all VIRTIO Shared
Memory Regions as subregions. Each region is
configured with its proper shmid, size, and
offset within the BAR. The number and size of
regions are retrieved via VHOST_USER_GET_SHMEM_CONFIG
message sent by vhost-user-base during realization
after virtio_init().
Specifiically, it uses BAR 3 to avoid conflicts, as
it is currently unused.
The shared memory BAR is only created when the
backend supports VHOST_USER_PROTOCOL_F_SHMEM and
has configured shared memory regions. This maintains
backward compatibility with backends that do not
support shared memory functionality.
Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
Signed-off-by: Albert Esteve <aesteve@redhat.com>
---
hw/virtio/vhost-user-base.c | 46 ++++++++++++++++++++++++--
hw/virtio/vhost-user-test-device-pci.c | 38 +++++++++++++++++++--
2 files changed, 79 insertions(+), 5 deletions(-)
diff --git a/hw/virtio/vhost-user-base.c b/hw/virtio/vhost-user-base.c
index 01ab9ca56b..e5e8abae96 100644
--- a/hw/virtio/vhost-user-base.c
+++ b/hw/virtio/vhost-user-base.c
@@ -16,6 +16,7 @@
#include "hw/virtio/virtio-bus.h"
#include "hw/virtio/vhost-user-base.h"
#include "qemu/error-report.h"
+#include "migration/blocker.h"
static void vub_start(VirtIODevice *vdev)
{
@@ -276,7 +277,8 @@ static void vub_device_realize(DeviceState *dev, Error **errp)
{
VirtIODevice *vdev = VIRTIO_DEVICE(dev);
VHostUserBase *vub = VHOST_USER_BASE(dev);
- int ret;
+ uint64_t memory_sizes[VIRTIO_MAX_SHMEM_REGIONS];
+ int i, ret, nregions, regions_processed = 0;
if (!vub->chardev.chr) {
error_setg(errp, "vhost-user-base: missing chardev");
@@ -319,7 +321,7 @@ static void vub_device_realize(DeviceState *dev, Error **errp)
/* Allocate queues */
vub->vqs = g_ptr_array_sized_new(vub->num_vqs);
- for (int i = 0; i < vub->num_vqs; i++) {
+ for (i = 0; i < vub->num_vqs; i++) {
g_ptr_array_add(vub->vqs,
virtio_add_queue(vdev, vub->vq_size,
vub_handle_output));
@@ -333,11 +335,49 @@ static void vub_device_realize(DeviceState *dev, Error **errp)
VHOST_BACKEND_TYPE_USER, 0, errp);
if (ret < 0) {
- do_vhost_user_cleanup(vdev, vub);
+ goto err;
+ }
+
+ ret = vub->vhost_dev.vhost_ops->vhost_get_shmem_config(&vub->vhost_dev,
+ &nregions,
+ memory_sizes,
+ errp);
+
+ if (ret < 0) {
+ goto err;
+ }
+
+ for (i = 0; i < VIRTIO_MAX_SHMEM_REGIONS && regions_processed < nregions; i++) {
+ if (memory_sizes[i]) {
+ regions_processed++;
+ if (vub->vhost_dev.migration_blocker == NULL) {
+ error_setg(&vub->vhost_dev.migration_blocker,
+ "Migration disabled: devices with VIRTIO Shared Memory "
+ "Regions do not support migration yet.");
+ ret = migrate_add_blocker_normal(
+ &vub->vhost_dev.migration_blocker,
+ errp);
+
+ if (ret < 0) {
+ goto err;
+ }
+ }
+
+ if (memory_sizes[i] % qemu_real_host_page_size() != 0) {
+ error_setg(errp, "Shared memory %d size must be a power of 2 "
+ "no smaller than the page size", i);
+ goto err;
+ }
+
+ virtio_new_shmem_region(vdev, i, memory_sizes[i]);
+ }
}
qemu_chr_fe_set_handlers(&vub->chardev, NULL, NULL, vub_event, NULL,
dev, NULL, true);
+ return;
+err:
+ do_vhost_user_cleanup(vdev, vub);
}
static void vub_device_unrealize(DeviceState *dev)
diff --git a/hw/virtio/vhost-user-test-device-pci.c b/hw/virtio/vhost-user-test-device-pci.c
index 7f6d751690..22678e3277 100644
--- a/hw/virtio/vhost-user-test-device-pci.c
+++ b/hw/virtio/vhost-user-test-device-pci.c
@@ -12,10 +12,13 @@
#include "hw/virtio/vhost-user-base.h"
#include "hw/virtio/virtio-pci.h"
+#define VIRTIO_DEVICE_PCI_SHMEM_BAR 4
+
struct VHostUserDevicePCI {
VirtIOPCIProxy parent_obj;
VHostUserBase vub;
+ MemoryRegion shmembar;
};
#define TYPE_VHOST_USER_TEST_DEVICE_PCI "vhost-user-test-device-pci-base"
@@ -25,10 +28,41 @@ OBJECT_DECLARE_SIMPLE_TYPE(VHostUserDevicePCI, VHOST_USER_TEST_DEVICE_PCI)
static void vhost_user_device_pci_realize(VirtIOPCIProxy *vpci_dev, Error **errp)
{
VHostUserDevicePCI *dev = VHOST_USER_TEST_DEVICE_PCI(vpci_dev);
- DeviceState *vdev = DEVICE(&dev->vub);
+ DeviceState *dev_state = DEVICE(&dev->vub);
+ VirtIODevice *vdev = VIRTIO_DEVICE(dev_state);
+ VirtioSharedMemory *shmem, *next;
+ uint64_t offset = 0, shmem_size = 0;
+ vpci_dev->modern_mem_bar_idx = 2;
vpci_dev->nvectors = 1;
- qdev_realize(vdev, BUS(&vpci_dev->bus), errp);
+ qdev_realize(dev_state, BUS(&vpci_dev->bus), errp);
+
+ QSIMPLEQ_FOREACH_SAFE(shmem, &vdev->shmem_list, entry, next) {
+ if (shmem->mr.size > UINT64_MAX - shmem_size) {
+ error_setg(errp, "Total shared memory required overflow");
+ return;
+ }
+ shmem_size = shmem_size + shmem->mr.size;
+ }
+ if (shmem_size) {
+ if (vpci_dev->flags & VIRTIO_PCI_FLAG_MODERN_PIO_NOTIFY) {
+ error_setg(errp, "modern-pio-notify is not supported due to PCI BAR layout limitations");
+ return;
+ }
+ memory_region_init(&dev->shmembar, OBJECT(vpci_dev),
+ "vhost-device-pci-shmembar", shmem_size);
+ QSIMPLEQ_FOREACH_SAFE(shmem, &vdev->shmem_list, entry, next) {
+ memory_region_add_subregion(&dev->shmembar, offset, &shmem->mr);
+ virtio_pci_add_shm_cap(vpci_dev, VIRTIO_DEVICE_PCI_SHMEM_BAR,
+ offset, shmem->mr.size, shmem->shmid);
+ offset = offset + shmem->mr.size;
+ }
+ pci_register_bar(&vpci_dev->pci_dev, VIRTIO_DEVICE_PCI_SHMEM_BAR,
+ PCI_BASE_ADDRESS_SPACE_MEMORY |
+ PCI_BASE_ADDRESS_MEM_PREFETCH |
+ PCI_BASE_ADDRESS_MEM_TYPE_64,
+ &dev->shmembar);
+ }
}
static void vhost_user_device_pci_class_init(ObjectClass *klass,
--
2.52.0
^ permalink raw reply related [flat|nested] 21+ messages in thread
* Re: [PATCH v13 3/7] vhost_user.rst: Add SHMEM_MAP/_UNMAP to spec
2026-02-19 13:03 ` [PATCH v13 3/7] vhost_user.rst: Add SHMEM_MAP/_UNMAP to spec Albert Esteve
@ 2026-02-21 13:54 ` Alyssa Ross
2026-03-04 9:46 ` Albert Esteve
1 sibling, 0 replies; 21+ messages in thread
From: Alyssa Ross @ 2026-02-21 13:54 UTC (permalink / raw)
To: Albert Esteve, qemu-devel
Cc: Peter Xu, Pierrick Bouvier, mst, dbassey,
Philippe Mathieu-Daudé, Alex Bennée, Paolo Bonzini,
Fabiano Rosas, stefanha, manos.pitsidianakis, Stefano Garzarella,
jasowang, Laurent Vivier, slp, stevensd
[-- Attachment #1: Type: text/plain, Size: 447 bytes --]
Albert Esteve <aesteve@redhat.com> writes:
> Add SHMEM_MAP/_UNMAP request to the vhost-user
> spec documentation.
>
> Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
> Reviewed-by: Manos Pitsidianakis <manos.pitsidianakis@linaro.org>
> Signed-off-by: Albert Esteve <aesteve@redhat.com>
> ---
> docs/interop/vhost-user.rst | 61 +++++++++++++++++++++++++++++++++++++
> 1 file changed, 61 insertions(+)
Reviewed-by: Alyssa Ross <hi@alyssa.is>
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 227 bytes --]
^ permalink raw reply [flat|nested] 21+ messages in thread
* Re: [PATCH v13 3/7] vhost_user.rst: Add SHMEM_MAP/_UNMAP to spec
2026-02-19 13:03 ` [PATCH v13 3/7] vhost_user.rst: Add SHMEM_MAP/_UNMAP to spec Albert Esteve
2026-02-21 13:54 ` Alyssa Ross
@ 2026-03-04 9:46 ` Albert Esteve
2026-03-04 10:23 ` Albert Esteve
1 sibling, 1 reply; 21+ messages in thread
From: Albert Esteve @ 2026-03-04 9:46 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Xu, Pierrick Bouvier, mst, dbassey,
Philippe Mathieu-Daudé, Alex Bennée, Paolo Bonzini,
Fabiano Rosas, stefanha, manos.pitsidianakis, Stefano Garzarella,
jasowang, Laurent Vivier, slp, hi, stevensd
On Thu, Feb 19, 2026 at 2:04 PM Albert Esteve <aesteve@redhat.com> wrote:
>
> Add SHMEM_MAP/_UNMAP request to the vhost-user
> spec documentation.
>
> Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
> Reviewed-by: Manos Pitsidianakis <manos.pitsidianakis@linaro.org>
> Signed-off-by: Albert Esteve <aesteve@redhat.com>
> ---
> docs/interop/vhost-user.rst | 61 +++++++++++++++++++++++++++++++++++++
> 1 file changed, 61 insertions(+)
>
> diff --git a/docs/interop/vhost-user.rst b/docs/interop/vhost-user.rst
> index 17a68a62eb..ae4ad6f441 100644
> --- a/docs/interop/vhost-user.rst
> +++ b/docs/interop/vhost-user.rst
> @@ -350,6 +350,27 @@ Device state transfer parameters
> In the future, additional phases might be added e.g. to allow
> iterative migration while the device is running.
>
> +MMAP request
> +^^^^^^^^^^^^
> +
> ++-------+---------+-----------+------------+-----+-------+
> +| shmid | padding | fd_offset | shm_offset | len | flags |
> ++-------+---------+-----------+------------+-----+-------+
> +
> +:shmid: a 8-bit shared memory region identifier
> +
> +:fd_offset: a 64-bit offset of this area from the start
> + of the supplied file descriptor
> +
> +:shm_offset: a 64-bit offset from the start of the
> + pointed shared memory region
> +
> +:len: a 64-bit size of the memory to map
> +
> +:flags: a 64-bit value:
> + - 0: Pages are mapped read-only
> + - 1: Pages are mapped read-write
> +
> C structure
> -----------
>
> @@ -375,6 +396,7 @@ In QEMU the vhost-user message is implemented with the following struct:
> VhostUserInflight inflight;
> VhostUserShared object;
> VhostUserTransferDeviceState transfer_state;
> + VhostUserMMap mmap;
> };
> } QEMU_PACKED VhostUserMsg;
>
> @@ -1064,6 +1086,7 @@ Protocol features
> #define VHOST_USER_PROTOCOL_F_XEN_MMAP 17
> #define VHOST_USER_PROTOCOL_F_SHARED_OBJECT 18
> #define VHOST_USER_PROTOCOL_F_DEVICE_STATE 19
> + #define VHOST_USER_PROTOCOL_F_SHMEM 20
Commit cda83adc62b6108afc8a82d0f54d9a9a861e7aa8 got upstream first and
took feature number 20, so this should be 21 now.
@Michael Tsirkin Is it worth sending a new version or will you handle
the change?
>
> Front-end message types
> -----------------------
> @@ -1872,6 +1895,44 @@ is sent by the front-end.
> when the operation is successful, or non-zero otherwise. Note that if the
> operation fails, no fd is sent to the backend.
>
> +``VHOST_USER_BACKEND_SHMEM_MAP``
> + :id: 9
> + :equivalent ioctl: N/A
> + :request payload: fd and ``struct VhostUserMMap``
> + :reply payload: N/A
> +
> + When the ``VHOST_USER_PROTOCOL_F_SHMEM`` protocol feature has been
> + successfully negotiated, this message can be submitted by the backends to
> + advertise a new mapping to be made in a given VIRTIO Shared Memory Region.
> + Upon receiving the message, the front-end will mmap the given fd into the
> + VIRTIO Shared Memory Region with the requested ``shmid``.
> + If ``VHOST_USER_PROTOCOL_F_REPLY_ACK`` is negotiated, and
> + back-end set the ``VHOST_USER_NEED_REPLY`` flag, the front-end
> + must respond with zero when operation is successfully completed,
> + or non-zero otherwise.
> +
> + Mapping over an already existing map is not allowed and requests shall fail.
> + Therefore, the memory range in the request must correspond with a valid,
> + free region of the VIRTIO Shared Memory Region. Also, note that mappings
> + consume resources and that the request can fail when there are no resources
> + available. Lastly, mappings are automatically unmapped by the front-end
> + across device reset operation.
> +
> +``VHOST_USER_BACKEND_SHMEM_UNMAP``
> + :id: 10
> + :equivalent ioctl: N/A
> + :request payload: ``struct VhostUserMMap``
> + :reply payload: N/A
> +
> + When the ``VHOST_USER_PROTOCOL_F_SHMEM`` protocol feature has been
> + successfully negotiated, this message can be submitted by the backends so
> + that the front-end un-mmaps a given range (``shm_offset``, ``len``) in the
> + VIRTIO Shared Memory Region with the requested ``shmid``. Note that the
> + given range shall correspond to the entirety of a valid mapped region.
> + If ``VHOST_USER_PROTOCOL_F_REPLY_ACK`` is negotiated, and the back-end
> + sets the ``VHOST_USER_NEED_REPLY`` flag, the front-end must respond with
> + zero when operation is successfully completed, or non-zero otherwise.
> +
> .. _reply_ack:
>
> VHOST_USER_PROTOCOL_F_REPLY_ACK
> --
> 2.52.0
>
>
^ permalink raw reply [flat|nested] 21+ messages in thread
* Re: [PATCH v13 3/7] vhost_user.rst: Add SHMEM_MAP/_UNMAP to spec
2026-03-04 9:46 ` Albert Esteve
@ 2026-03-04 10:23 ` Albert Esteve
2026-03-04 13:11 ` Stefano Garzarella
0 siblings, 1 reply; 21+ messages in thread
From: Albert Esteve @ 2026-03-04 10:23 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Xu, Pierrick Bouvier, mst, dbassey,
Philippe Mathieu-Daudé, Alex Bennée, Paolo Bonzini,
Fabiano Rosas, stefanha, manos.pitsidianakis, Stefano Garzarella,
jasowang, Laurent Vivier, slp, hi, stevensd
On Wed, Mar 4, 2026 at 10:46 AM Albert Esteve <aesteve@redhat.com> wrote:
>
> On Thu, Feb 19, 2026 at 2:04 PM Albert Esteve <aesteve@redhat.com> wrote:
> >
> > Add SHMEM_MAP/_UNMAP request to the vhost-user
> > spec documentation.
> >
> > Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
> > Reviewed-by: Manos Pitsidianakis <manos.pitsidianakis@linaro.org>
> > Signed-off-by: Albert Esteve <aesteve@redhat.com>
> > ---
> > docs/interop/vhost-user.rst | 61 +++++++++++++++++++++++++++++++++++++
> > 1 file changed, 61 insertions(+)
> >
> > diff --git a/docs/interop/vhost-user.rst b/docs/interop/vhost-user.rst
> > index 17a68a62eb..ae4ad6f441 100644
> > --- a/docs/interop/vhost-user.rst
> > +++ b/docs/interop/vhost-user.rst
> > @@ -350,6 +350,27 @@ Device state transfer parameters
> > In the future, additional phases might be added e.g. to allow
> > iterative migration while the device is running.
> >
> > +MMAP request
> > +^^^^^^^^^^^^
> > +
> > ++-------+---------+-----------+------------+-----+-------+
> > +| shmid | padding | fd_offset | shm_offset | len | flags |
> > ++-------+---------+-----------+------------+-----+-------+
> > +
> > +:shmid: a 8-bit shared memory region identifier
> > +
> > +:fd_offset: a 64-bit offset of this area from the start
> > + of the supplied file descriptor
> > +
> > +:shm_offset: a 64-bit offset from the start of the
> > + pointed shared memory region
> > +
> > +:len: a 64-bit size of the memory to map
> > +
> > +:flags: a 64-bit value:
> > + - 0: Pages are mapped read-only
> > + - 1: Pages are mapped read-write
> > +
> > C structure
> > -----------
> >
> > @@ -375,6 +396,7 @@ In QEMU the vhost-user message is implemented with the following struct:
> > VhostUserInflight inflight;
> > VhostUserShared object;
> > VhostUserTransferDeviceState transfer_state;
> > + VhostUserMMap mmap;
> > };
> > } QEMU_PACKED VhostUserMsg;
> >
> > @@ -1064,6 +1086,7 @@ Protocol features
> > #define VHOST_USER_PROTOCOL_F_XEN_MMAP 17
> > #define VHOST_USER_PROTOCOL_F_SHARED_OBJECT 18
> > #define VHOST_USER_PROTOCOL_F_DEVICE_STATE 19
> > + #define VHOST_USER_PROTOCOL_F_SHMEM 20
>
> Commit cda83adc62b6108afc8a82d0f54d9a9a861e7aa8 got upstream first and
> took feature number 20, so this should be 21 now.
>
> @Michael Tsirkin Is it worth sending a new version or will you handle
> the change?
Sorry, I meant e0822e6085aecc15e2cfb2914d8cd827abae0249 (vhost-user:
introduce protocol feature for skip drain on GET_VRING_BASE).
But the question remains.
>
> >
> > Front-end message types
> > -----------------------
> > @@ -1872,6 +1895,44 @@ is sent by the front-end.
> > when the operation is successful, or non-zero otherwise. Note that if the
> > operation fails, no fd is sent to the backend.
> >
> > +``VHOST_USER_BACKEND_SHMEM_MAP``
> > + :id: 9
> > + :equivalent ioctl: N/A
> > + :request payload: fd and ``struct VhostUserMMap``
> > + :reply payload: N/A
> > +
> > + When the ``VHOST_USER_PROTOCOL_F_SHMEM`` protocol feature has been
> > + successfully negotiated, this message can be submitted by the backends to
> > + advertise a new mapping to be made in a given VIRTIO Shared Memory Region.
> > + Upon receiving the message, the front-end will mmap the given fd into the
> > + VIRTIO Shared Memory Region with the requested ``shmid``.
> > + If ``VHOST_USER_PROTOCOL_F_REPLY_ACK`` is negotiated, and
> > + back-end set the ``VHOST_USER_NEED_REPLY`` flag, the front-end
> > + must respond with zero when operation is successfully completed,
> > + or non-zero otherwise.
> > +
> > + Mapping over an already existing map is not allowed and requests shall fail.
> > + Therefore, the memory range in the request must correspond with a valid,
> > + free region of the VIRTIO Shared Memory Region. Also, note that mappings
> > + consume resources and that the request can fail when there are no resources
> > + available. Lastly, mappings are automatically unmapped by the front-end
> > + across device reset operation.
> > +
> > +``VHOST_USER_BACKEND_SHMEM_UNMAP``
> > + :id: 10
> > + :equivalent ioctl: N/A
> > + :request payload: ``struct VhostUserMMap``
> > + :reply payload: N/A
> > +
> > + When the ``VHOST_USER_PROTOCOL_F_SHMEM`` protocol feature has been
> > + successfully negotiated, this message can be submitted by the backends so
> > + that the front-end un-mmaps a given range (``shm_offset``, ``len``) in the
> > + VIRTIO Shared Memory Region with the requested ``shmid``. Note that the
> > + given range shall correspond to the entirety of a valid mapped region.
> > + If ``VHOST_USER_PROTOCOL_F_REPLY_ACK`` is negotiated, and the back-end
> > + sets the ``VHOST_USER_NEED_REPLY`` flag, the front-end must respond with
> > + zero when operation is successfully completed, or non-zero otherwise.
> > +
> > .. _reply_ack:
> >
> > VHOST_USER_PROTOCOL_F_REPLY_ACK
> > --
> > 2.52.0
> >
> >
^ permalink raw reply [flat|nested] 21+ messages in thread
* Re: [PATCH v13 1/7] vhost-user: Add VirtIO Shared Memory map request
2026-02-19 13:03 ` [PATCH v13 1/7] vhost-user: Add VirtIO Shared Memory map request Albert Esteve
@ 2026-03-04 13:08 ` Stefano Garzarella
2026-03-04 13:31 ` Albert Esteve
0 siblings, 1 reply; 21+ messages in thread
From: Stefano Garzarella @ 2026-03-04 13:08 UTC (permalink / raw)
To: Albert Esteve
Cc: qemu-devel, Peter Xu, Pierrick Bouvier, mst, dbassey,
Philippe Mathieu-Daudé, Alex Bennée, Paolo Bonzini,
Fabiano Rosas, stefanha, manos.pitsidianakis, jasowang,
Laurent Vivier, slp, hi, stevensd
On Thu, Feb 19, 2026 at 02:03:28PM +0100, Albert Esteve wrote:
>Add SHMEM_MAP/UNMAP requests to vhost-user for dynamic management of
>VIRTIO Shared Memory mappings.
>
>This implementation introduces VirtioSharedMemoryMapping as a unified
>QOM object that manages both the mapping metadata and MemoryRegion
>lifecycle. This object provides reference-counted lifecycle management
>with automatic cleanup of file descriptors and memory regions
>through QOM finalization.
>
>This request allows backends to dynamically map file descriptors into a
>VIRTIO Shared Memory Region identified by their shmid. Maps are created
>using memory_region_init_ram_from_fd() with configurable read/write
>permissions, and the resulting MemoryRegions are added as subregions to
>the shmem container region. The mapped memory is then advertised to the
>guest VIRTIO drivers as a base address plus offset for reading and
>writting according to the requested mmap flags.
>
>The backend can unmap memory ranges within a given VIRTIO Shared Memory
>Region to free resources. Upon receiving this message, the frontend
>removes the MemoryRegion as a subregion and automatically unreferences
>the VirtioSharedMemoryMapping object, triggering cleanup if no other
>references exist.
>
>Error handling has been improved to ensure consistent behavior across
>handlers that manage their own vhost_user_send_resp() calls. Since
>these handlers clear the VHOST_USER_NEED_REPLY_MASK flag, explicit
>error checking ensures proper connection closure on failures,
>maintaining the expected error flow.
>
>Note the memory region commit for these operations needs to be delayed
>until after we reply to the backend to avoid deadlocks. Otherwise,
>the MemoryListener would send a VHOST_USER_SET_MEM_TABLE message
>before the reply.
>
>Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
>Signed-off-by: Albert Esteve <aesteve@redhat.com>
>---
> hw/virtio/vhost-user.c | 269 ++++++++++++++++++++++
> hw/virtio/virtio.c | 201 ++++++++++++++++
> include/hw/virtio/virtio.h | 135 +++++++++++
> include/system/memory.h | 13 ++
> subprojects/libvhost-user/libvhost-user.c | 70 ++++++
> subprojects/libvhost-user/libvhost-user.h | 54 +++++
> 6 files changed, 742 insertions(+)
>
>diff --git a/hw/virtio/vhost-user.c b/hw/virtio/vhost-user.c
>index 63fa9a1b4b..5d3841d58b 100644
>--- a/hw/virtio/vhost-user.c
>+++ b/hw/virtio/vhost-user.c
>@@ -104,6 +104,7 @@ typedef enum VhostUserRequest {
> VHOST_USER_GET_SHARED_OBJECT = 41,
> VHOST_USER_SET_DEVICE_STATE_FD = 42,
> VHOST_USER_CHECK_DEVICE_STATE = 43,
>+ VHOST_USER_GET_SHMEM_CONFIG = 44,
> VHOST_USER_MAX
> } VhostUserRequest;
>
>@@ -115,6 +116,8 @@ typedef enum VhostUserBackendRequest {
> VHOST_USER_BACKEND_SHARED_OBJECT_ADD = 6,
> VHOST_USER_BACKEND_SHARED_OBJECT_REMOVE = 7,
> VHOST_USER_BACKEND_SHARED_OBJECT_LOOKUP = 8,
>+ VHOST_USER_BACKEND_SHMEM_MAP = 9,
>+ VHOST_USER_BACKEND_SHMEM_UNMAP = 10,
> VHOST_USER_BACKEND_MAX
> } VhostUserBackendRequest;
>
>@@ -136,6 +139,12 @@ typedef struct VhostUserMemRegMsg {
> VhostUserMemoryRegion region;
> } VhostUserMemRegMsg;
>
>+typedef struct VhostUserShMemConfig {
>+ uint32_t nregions;
>+ uint32_t padding;
>+ uint64_t memory_sizes[VIRTIO_MAX_SHMEM_REGIONS];
>+} VhostUserShMemConfig;
>+
> typedef struct VhostUserLog {
> uint64_t mmap_size;
> uint64_t mmap_offset;
>@@ -192,6 +201,23 @@ typedef struct VhostUserShared {
> unsigned char uuid[16];
> } VhostUserShared;
>
>+/* For the flags field of VhostUserMMap */
>+#define VHOST_USER_FLAG_MAP_RW (1u << 0)
>+
>+typedef struct {
>+ /* VIRTIO Shared Memory Region ID */
>+ uint8_t shmid;
>+ uint8_t padding[7];
>+ /* File offset */
>+ uint64_t fd_offset;
>+ /* Offset within the VIRTIO Shared Memory Region */
>+ uint64_t shm_offset;
>+ /* Size of the mapping */
>+ uint64_t len;
>+ /* Flags for the mmap operation, from VHOST_USER_FLAG_MAP_* */
>+ uint64_t flags;
>+} VhostUserMMap;
>+
> typedef struct {
> VhostUserRequest request;
>
>@@ -224,6 +250,8 @@ typedef union {
> VhostUserInflight inflight;
> VhostUserShared object;
> VhostUserTransferDeviceState transfer_state;
>+ VhostUserMMap mmap;
>+ VhostUserShMemConfig shmem;
> } VhostUserPayload;
>
> typedef struct VhostUserMsg {
>@@ -1771,6 +1799,196 @@ vhost_user_backend_handle_shared_object_lookup(struct vhost_user *u,
> return 0;
> }
>
>+/**
>+ * vhost_user_backend_handle_shmem_map() - Handle SHMEM_MAP backend request
>+ * @dev: vhost device
>+ * @ioc: QIOChannel for communication
>+ * @hdr: vhost-user message header
>+ * @payload: message payload containing mapping details
>+ * @fd: file descriptor for the shared memory region
>+ *
>+ * Handles VHOST_USER_BACKEND_SHMEM_MAP requests from the backend. Creates
>+ * a VhostUserShmemObject to manage the shared memory mapping and adds it
>+ * to the appropriate VirtIO shared memory region. The VhostUserShmemObject
>+ * serves as an intermediate parent for the MemoryRegion, ensuring proper
>+ * lifecycle management with reference counting.
>+ *
>+ * Returns: 0 on success, negative errno on failure
>+ */
>+static int
>+vhost_user_backend_handle_shmem_map(struct vhost_dev *dev,
>+ QIOChannel *ioc,
>+ VhostUserHeader *hdr,
>+ VhostUserPayload *payload,
>+ int fd)
>+{
>+ VirtioSharedMemory *shmem;
>+ VhostUserMMap *vu_mmap = &payload->mmap;
>+ VirtioSharedMemoryMapping *existing;
>+ Error *local_err = NULL;
>+ int ret = 0;
>+
>+ if (fd < 0) {
>+ error_report("Bad fd for map");
>+ ret = -EBADF;
>+ goto send_reply;
>+ }
>+
>+ if (QSIMPLEQ_EMPTY(&dev->vdev->shmem_list)) {
>+ error_report("Device has no VIRTIO Shared Memory Regions. "
>+ "Requested ID: %d", vu_mmap->shmid);
>+ ret = -EFAULT;
>+ goto send_reply;
>+ }
>+
>+ shmem = virtio_find_shmem_region(dev->vdev, vu_mmap->shmid);
>+ if (!shmem) {
>+ error_report("VIRTIO Shared Memory Region at "
>+ "ID %d not found or uninitialized", vu_mmap->shmid);
>+ ret = -EFAULT;
>+ goto send_reply;
>+ }
>+
>+ if ((vu_mmap->shm_offset + vu_mmap->len) < vu_mmap->len ||
>+ (vu_mmap->shm_offset + vu_mmap->len) > shmem->mr.size) {
Any reason about not using `memory_region_size(&shmem->mr)` ?
>+ error_report("Bad offset/len for mmap %" PRIx64 "+%" PRIx64,
>+ vu_mmap->shm_offset, vu_mmap->len);
>+ ret = -EFAULT;
>+ goto send_reply;
>+ }
>+
>+ QTAILQ_FOREACH(existing, &shmem->mmaps, link) {
>+ if (ranges_overlap(existing->offset, existing->len,
>+ vu_mmap->shm_offset, vu_mmap->len)) {
>+ error_report("VIRTIO Shared Memory mapping overlap");
>+ ret = -EFAULT;
>+ goto send_reply;
>+ }
>+ }
>+
>+ memory_region_transaction_begin();
>+
>+ /* Create VirtioSharedMemoryMapping object */
>+ VirtioSharedMemoryMapping *mapping = virtio_shared_memory_mapping_new(
>+ vu_mmap->shmid, fd, vu_mmap->fd_offset, vu_mmap->shm_offset,
>+ vu_mmap->len, vu_mmap->flags & VHOST_USER_FLAG_MAP_RW);
>+
>+ if (!mapping) {
>+ ret = -EFAULT;
>+ goto send_reply_commit;
>+ }
>+
>+ /* Add the mapping to the shared memory region */
>+ if (virtio_add_shmem_map(shmem, mapping) != 0) {
>+ error_report("Failed to add shared memory mapping");
>+ object_unref(OBJECT(mapping));
>+ ret = -EFAULT;
>+ goto send_reply_commit;
>+ }
>+
>+send_reply_commit:
>+ /* Send reply and commit after transaction started */
>+ if (hdr->flags & VHOST_USER_NEED_REPLY_MASK) {
>+ payload->u64 = !!ret;
>+ hdr->size = sizeof(payload->u64);
>+ if (!vhost_user_send_resp(ioc, hdr, payload, &local_err)) {
>+ error_report_err(local_err);
>+ memory_region_transaction_commit();
>+ return -EFAULT;
>+ }
>+ }
>+ memory_region_transaction_commit();
>+ return 0;
>+
>+send_reply:
>+ if (hdr->flags & VHOST_USER_NEED_REPLY_MASK) {
>+ payload->u64 = !!ret;
>+ hdr->size = sizeof(payload->u64);
>+ if (!vhost_user_send_resp(ioc, hdr, payload, &local_err)) {
>+ error_report_err(local_err);
>+ return -EFAULT;
>+ }
>+ }
>+ return 0;
>+}
>+
>+/**
>+ * vhost_user_backend_handle_shmem_unmap() - Handle SHMEM_UNMAP backend request
>+ * @dev: vhost device
>+ * @ioc: QIOChannel for communication
>+ * @hdr: vhost-user message header
>+ * @payload: message payload containing unmapping details
>+ *
>+ * Handles VHOST_USER_BACKEND_SHMEM_UNMAP requests from the backend. Removes
>+ * the specified memory mapping from the VirtIO shared memory region.
>This
>+ * automatically unreferences the associated VhostUserShmemObject, which may
>+ * trigger its finalization and cleanup (munmap, close fd) if no other
>+ * references exist.
>+ *
>+ * Returns: 0 on success, negative errno on failure
>+ */
>+static int
>+vhost_user_backend_handle_shmem_unmap(struct vhost_dev *dev,
>+ QIOChannel *ioc,
>+ VhostUserHeader *hdr,
>+ VhostUserPayload *payload)
>+{
>+ VirtioSharedMemory *shmem = NULL;
>+ VirtioSharedMemoryMapping *mmap = NULL;
>+ VhostUserMMap *vu_mmap = &payload->mmap;
>+ Error *local_err = NULL;
>+ int ret = 0;
>+
>+ if (QSIMPLEQ_EMPTY(&dev->vdev->shmem_list)) {
>+ error_report("Device has no VIRTIO Shared Memory Regions. "
>+ "Requested ID: %d", vu_mmap->shmid);
>+ ret = -EFAULT;
>+ goto send_reply;
>+ }
>+
>+ shmem = virtio_find_shmem_region(dev->vdev, vu_mmap->shmid);
>+ if (!shmem) {
>+ error_report("VIRTIO Shared Memory Region at "
>+ "ID %d not found or uninitialized", vu_mmap->shmid);
>+ ret = -EFAULT;
>+ goto send_reply;
>+ }
>+
>+ if ((vu_mmap->shm_offset + vu_mmap->len) < vu_mmap->len ||
>+ (vu_mmap->shm_offset + vu_mmap->len) > shmem->mr.size) {
>+ error_report("Bad offset/len for unmmap %" PRIx64 "+%" PRIx64,
>+ vu_mmap->shm_offset, vu_mmap->len);
>+ ret = -EFAULT;
>+ goto send_reply;
>+ }
>+
>+ mmap = virtio_find_shmem_map(shmem, vu_mmap->shm_offset, vu_mmap->len);
>+ if (!mmap) {
>+ error_report("Shared memory mapping not found at offset %" PRIx64
>+ " with length %" PRIx64,
>+ vu_mmap->shm_offset, vu_mmap->len);
>+ ret = -EFAULT;
>+ goto send_reply;
>+ }
>+
>+send_reply:
>+ if (hdr->flags & VHOST_USER_NEED_REPLY_MASK) {
>+ payload->u64 = !!ret;
>+ hdr->size = sizeof(payload->u64);
>+ if (!vhost_user_send_resp(ioc, hdr, payload, &local_err)) {
>+ error_report_err(local_err);
>+ return -EFAULT;
>+ }
>+ }
>+
>+ if (!ret && shmem && mmap) {
>+ /* Free the MemoryRegion only after reply */
>+ virtio_del_shmem_map(shmem, vu_mmap->shm_offset, vu_mmap->len);
>+ }
>+
>+ return 0;
>+}
>+
> static void close_backend_channel(struct vhost_user *u)
> {
> g_source_destroy(u->backend_src);
>@@ -1844,6 +2062,21 @@ static gboolean backend_read(QIOChannel *ioc, GIOCondition condition,
> ret = vhost_user_backend_handle_shared_object_lookup(dev->opaque,
> &payload.object);
> break;
>+ case VHOST_USER_BACKEND_SHMEM_MAP:
>+ /* Handler manages its own response, check error and close connection */
>+ reply_ack = false;
>+ if (vhost_user_backend_handle_shmem_map(dev, ioc, &hdr, &payload,
>+ fd ? fd[0] : -1) < 0) {
>+ goto err;
>+ }
>+ break;
>+ case VHOST_USER_BACKEND_SHMEM_UNMAP:
>+ /* Handler manages its own response, check error and close connection */
>+ reply_ack = false;
>+ if (vhost_user_backend_handle_shmem_unmap(dev, ioc, &hdr, &payload) < 0) {
>+ goto err;
>+ }
>+ break;
> default:
> error_report("Received unexpected msg type: %d.", hdr.request);
> ret = -EINVAL;
>@@ -3021,6 +3254,41 @@ static int vhost_user_check_device_state(struct vhost_dev *dev, Error **errp)
> return 0;
> }
>
>+static int vhost_user_get_shmem_config(struct vhost_dev *dev,
>+ int *nregions,
>+ uint64_t *memory_sizes,
>+ Error **errp)
>+{
>+ int ret;
>+ VhostUserMsg msg = {
>+ .hdr.request = VHOST_USER_GET_SHMEM_CONFIG,
>+ .hdr.flags = VHOST_USER_VERSION,
>+ };
>+
>+ if (!virtio_has_feature(dev->protocol_features,
>+ VHOST_USER_PROTOCOL_F_SHMEM)) {
>+ *nregions = 0;
>+ return 0;
>+ }
>+
>+ ret = vhost_user_write(dev, &msg, NULL, 0);
>+ if (ret < 0) {
>+ return ret;
>+ }
>+
>+ ret = vhost_user_read(dev, &msg);
>+ if (ret < 0) {
>+ return ret;
>+ }
>+
>+ assert(msg.payload.shmem.nregions <= VIRTIO_MAX_SHMEM_REGIONS);
Is this `assert()` too much?
This means that a bad vhost-user backend can crash QEMU, so not sure
it's really what we want, I'd return an error.
>+ *nregions = msg.payload.shmem.nregions;
>+ memcpy(memory_sizes,
>+ &msg.payload.shmem.memory_sizes,
>+ sizeof(uint64_t) * VIRTIO_MAX_SHMEM_REGIONS);
>+ return 0;
>+}
>+
> const VhostOps user_ops = {
> .backend_type = VHOST_BACKEND_TYPE_USER,
> .vhost_backend_init = vhost_user_backend_init,
>@@ -3059,4 +3327,5 @@ const VhostOps user_ops = {
> .vhost_supports_device_state = vhost_user_supports_device_state,
> .vhost_set_device_state_fd = vhost_user_set_device_state_fd,
> .vhost_check_device_state = vhost_user_check_device_state,
>+ .vhost_get_shmem_config = vhost_user_get_shmem_config,
> };
>diff --git a/hw/virtio/virtio.c b/hw/virtio/virtio.c
>index 3dc9423eae..2f608f33ae 100644
>--- a/hw/virtio/virtio.c
>+++ b/hw/virtio/virtio.c
>@@ -3111,6 +3111,173 @@ int virtio_save(VirtIODevice *vdev, QEMUFile *f)
> return ret;
> }
>
>+VirtioSharedMemory *virtio_new_shmem_region(VirtIODevice *vdev, uint8_t shmid, uint64_t size)
>+{
>+ VirtioSharedMemory *elem;
>+ g_autofree char *name = NULL;
>+
>+ elem = g_new0(VirtioSharedMemory, 1);
>+ elem->shmid = shmid;
>+
>+ /* Initialize embedded MemoryRegion as container for shmem mappings */
>+ name = g_strdup_printf("virtio-shmem-%d", shmid);
>+ memory_region_init(&elem->mr, OBJECT(vdev), name, size);
>+ QTAILQ_INIT(&elem->mmaps);
>+ QSIMPLEQ_INSERT_TAIL(&vdev->shmem_list, elem, entry);
>+ return elem;
>+}
>+
>+VirtioSharedMemory *virtio_find_shmem_region(VirtIODevice *vdev, uint8_t shmid)
>+{
>+ VirtioSharedMemory *shmem, *next;
>+ QSIMPLEQ_FOREACH_SAFE(shmem, &vdev->shmem_list, entry, next) {
>+ if (shmem->shmid == shmid) {
>+ return shmem;
>+ }
>+ }
>+ return NULL;
>+}
>+
>+static void virtio_shared_memory_mapping_instance_init(Object *obj)
>+{
>+ VirtioSharedMemoryMapping *mapping = VIRTIO_SHARED_MEMORY_MAPPING(obj);
>+
>+ mapping->shmid = 0;
>+ mapping->offset = 0;
>+ mapping->len = 0;
>+ mapping->mr = NULL;
>+}
>+
>+static void virtio_shared_memory_mapping_instance_finalize(Object *obj)
>+{
>+ VirtioSharedMemoryMapping *mapping = VIRTIO_SHARED_MEMORY_MAPPING(obj);
>+
>+ /* Clean up MemoryRegion if it exists */
>+ if (mapping->mr) {
>+ /* Unparent the MemoryRegion to trigger cleanup */
>+ object_unparent(OBJECT(mapping->mr));
>+ mapping->mr = NULL;
>+ }
>+}
>+
>+VirtioSharedMemoryMapping *virtio_shared_memory_mapping_new(uint8_t shmid,
>+ int fd,
>+ uint64_t fd_offset,
>+ uint64_t shm_offset,
>+ uint64_t len,
>+ bool allow_write)
>+{
>+ VirtioSharedMemoryMapping *mapping;
>+ MemoryRegion *mr;
>+ g_autoptr(GString) mr_name = g_string_new(NULL);
>+ uint32_t ram_flags;
>+ Error *local_err = NULL;
>+
>+ if (len == 0) {
>+ error_report("Shared memory mapping size cannot be zero");
>+ return NULL;
>+ }
>+
>+ fd = dup(fd);
>+ if (fd < 0) {
>+ error_report("Failed to duplicate fd: %s", strerror(errno));
>+ return NULL;
>+ }
>+
>+ /* Determine RAM flags */
>+ ram_flags = RAM_SHARED;
>+ if (!allow_write) {
>+ ram_flags |= RAM_READONLY_FD;
>+ }
>+
>+ /* Create the VirtioSharedMemoryMapping */
>+ mapping = VIRTIO_SHARED_MEMORY_MAPPING(
>+ object_new(TYPE_VIRTIO_SHARED_MEMORY_MAPPING));
>+
>+ /* Set up object properties */
>+ mapping->shmid = shmid;
>+ mapping->offset = shm_offset;
>+ mapping->len = len;
>+
>+ /* Create MemoryRegion as a child of this object */
>+ mr = g_new0(MemoryRegion, 1);
>+ g_string_printf(mr_name, "virtio-shmem-%d-%" PRIx64, shmid, shm_offset);
>+
>+ /* Initialize MemoryRegion with file descriptor */
>+ if (!memory_region_init_ram_from_fd(mr, OBJECT(mapping), mr_name->str,
>+ len, ram_flags, fd, fd_offset,
>+ &local_err)) {
>+ error_report_err(local_err);
>+ g_free(mr);
>+ close(fd);
>+ object_unref(OBJECT(mapping));
>+ return NULL;
>+ }
>+
>+ mapping->mr = mr;
>+ return mapping;
>+}
>+
>+int virtio_add_shmem_map(VirtioSharedMemory *shmem,
>+ VirtioSharedMemoryMapping *mapping)
>+{
>+ if (!mapping) {
>+ error_report("VirtioSharedMemoryMapping cannot be NULL");
>+ return -1;
>+ }
>+ if (!mapping->mr) {
>+ error_report("VirtioSharedMemoryMapping has no MemoryRegion");
>+ return -1;
>+ }
>+
>+ /* Validate boundaries against the VIRTIO shared memory region */
>+ if (mapping->offset + mapping->len > memory_region_size(&shmem->mr)) {
>+ error_report("Memory exceeds the shared memory boundaries");
>+ return -1;
>+ }
>+
>+ /* Add as subregion to the VIRTIO shared memory */
>+ memory_region_add_subregion(&shmem->mr, mapping->offset, mapping->mr);
>+
>+ /* Add to the mapped regions list */
>+ QTAILQ_INSERT_TAIL(&shmem->mmaps, mapping, link);
>+
>+ return 0;
>+}
>+
>+VirtioSharedMemoryMapping *virtio_find_shmem_map(VirtioSharedMemory *shmem,
>+ hwaddr offset, uint64_t size)
>+{
>+ VirtioSharedMemoryMapping *mapping;
>+ QTAILQ_FOREACH(mapping, &shmem->mmaps, link) {
>+ if (mapping->offset == offset && mapping->len == size) {
>+ return mapping;
>+ }
>+ }
>+ return NULL;
>+}
>+
>+void virtio_del_shmem_map(VirtioSharedMemory *shmem, hwaddr offset,
>+ uint64_t size)
>+{
>+ VirtioSharedMemoryMapping *mapping = virtio_find_shmem_map(shmem, offset, size);
>+ if (mapping == NULL) {
>+ return;
>+ }
>+
>+ /*
>+ * Remove from memory region first
>+ */
>+ memory_region_del_subregion(&shmem->mr, mapping->mr);
>+
>+ /*
>+ * Remove from list and unref the mapping which will trigger automatic cleanup
>+ * when the reference count reaches zero.
>+ */
>+ QTAILQ_REMOVE(&shmem->mmaps, mapping, link);
>+ object_unref(OBJECT(mapping));
>+}
>+
> /* A wrapper for use as a VMState .put function */
> static int virtio_device_put(QEMUFile *f, void *opaque, size_t size,
> const VMStateField *field, JSONWriter *vmdesc)
>@@ -3237,6 +3404,7 @@ void virtio_reset(void *opaque)
> {
> VirtIODevice *vdev = opaque;
> VirtioDeviceClass *k = VIRTIO_DEVICE_GET_CLASS(vdev);
>+ VirtioSharedMemory *shmem;
> uint64_t features[VIRTIO_FEATURES_NU64S];
> int i;
>
>@@ -3276,6 +3444,15 @@ void virtio_reset(void *opaque)
> for (i = 0; i < VIRTIO_QUEUE_MAX; i++) {
> __virtio_queue_reset(vdev, i);
> }
>+
>+ /* Mappings are removed to prevent stale fds from remaining open. */
>+ QSIMPLEQ_FOREACH(shmem, &vdev->shmem_list, entry) {
>+ while (!QTAILQ_EMPTY(&shmem->mmaps)) {
>+ VirtioSharedMemoryMapping *mapping = QTAILQ_FIRST(&shmem->mmaps);
>+ virtio_del_shmem_map(shmem, mapping->offset,
>+ memory_region_size(mapping->mr));
>+ }
>+ }
> }
>
> static void virtio_device_check_notification_compatibility(VirtIODevice *vdev,
>@@ -3599,6 +3776,7 @@ void virtio_init(VirtIODevice *vdev, uint16_t
>device_id, size_t config_size)
> NULL, virtio_vmstate_change, vdev);
> vdev->device_endian = virtio_default_endian();
> vdev->use_guest_notifier_mask = true;
>+ QSIMPLEQ_INIT(&vdev->shmem_list);
> }
>
> /*
>@@ -4110,11 +4288,25 @@ static void virtio_device_free_virtqueues(VirtIODevice *vdev)
> static void virtio_device_instance_finalize(Object *obj)
> {
> VirtIODevice *vdev = VIRTIO_DEVICE(obj);
>+ VirtioSharedMemory *shmem;
>
> virtio_device_free_virtqueues(vdev);
>
> g_free(vdev->config);
> g_free(vdev->vector_queues);
>+ while (!QSIMPLEQ_EMPTY(&vdev->shmem_list)) {
>+ shmem = QSIMPLEQ_FIRST(&vdev->shmem_list);
>+ while (!QTAILQ_EMPTY(&shmem->mmaps)) {
>+ VirtioSharedMemoryMapping *mapping = QTAILQ_FIRST(&shmem->mmaps);
>+ virtio_del_shmem_map(shmem, mapping->offset,
>+ memory_region_size(mapping->mr));
>+ }
>+
>+ /* Clean up the embedded MemoryRegion */
>+ object_unparent(OBJECT(&shmem->mr));
>+ QSIMPLEQ_REMOVE_HEAD(&vdev->shmem_list, entry);
>+ g_free(shmem);
>+ }
> }
>
> static const Property virtio_properties[] = {
>@@ -4480,9 +4672,18 @@ static const TypeInfo virtio_device_info = {
> .class_size = sizeof(VirtioDeviceClass),
> };
>
>+static const TypeInfo virtio_shared_memory_mapping_info = {
>+ .name = TYPE_VIRTIO_SHARED_MEMORY_MAPPING,
>+ .parent = TYPE_OBJECT,
>+ .instance_size = sizeof(VirtioSharedMemoryMapping),
>+ .instance_init = virtio_shared_memory_mapping_instance_init,
>+ .instance_finalize = virtio_shared_memory_mapping_instance_finalize,
>+};
>+
> static void virtio_register_types(void)
> {
> type_register_static(&virtio_device_info);
>+ type_register_static(&virtio_shared_memory_mapping_info);
> }
>
> type_init(virtio_register_types)
>diff --git a/include/hw/virtio/virtio.h b/include/hw/virtio/virtio.h
>index 27cd98d2fe..40d881ca09 100644
>--- a/include/hw/virtio/virtio.h
>+++ b/include/hw/virtio/virtio.h
>@@ -99,6 +99,45 @@ enum virtio_device_endian {
> VIRTIO_DEVICE_ENDIAN_BIG,
> };
>
>+#define TYPE_VIRTIO_SHARED_MEMORY_MAPPING "virtio-shared-memory-mapping"
>+OBJECT_DECLARE_SIMPLE_TYPE(VirtioSharedMemoryMapping, VIRTIO_SHARED_MEMORY_MAPPING)
>+
>+/**
>+ * VirtioSharedMemoryMapping:
>+ * @parent: Parent QOM object
>+ * @shmid: VIRTIO Shared Memory Region ID
>+ * @fd: File descriptor for the shared memory region
`fd` is not there anymore.
The rest LGTM. I think we can eventually fix them later, so don't want
to block this, but if you need to resend, please fix them.
Reviewed-by: Stefano Garzarella <sgarzare@redhat.com>
^ permalink raw reply [flat|nested] 21+ messages in thread
* Re: [PATCH v13 2/7] vhost_user.rst: Align VhostUserMsg excerpt members
2026-02-19 13:03 ` [PATCH v13 2/7] vhost_user.rst: Align VhostUserMsg excerpt members Albert Esteve
@ 2026-03-04 13:10 ` Stefano Garzarella
0 siblings, 0 replies; 21+ messages in thread
From: Stefano Garzarella @ 2026-03-04 13:10 UTC (permalink / raw)
To: Albert Esteve
Cc: qemu-devel, Peter Xu, Pierrick Bouvier, mst, dbassey,
Philippe Mathieu-Daudé, Alex Bennée, Paolo Bonzini,
Fabiano Rosas, stefanha, manos.pitsidianakis, jasowang,
Laurent Vivier, slp, hi, stevensd
On Thu, Feb 19, 2026 at 02:03:29PM +0100, Albert Esteve wrote:
>Add missing members to the VhostUserMsg excerpt in
>the vhost-user spec documentation.
>
>Reviewed-by: David Hildenbrand <david@redhat.com>
>Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
>Signed-off-by: Albert Esteve <aesteve@redhat.com>
>---
> docs/interop/vhost-user.rst | 4 ++++
> 1 file changed, 4 insertions(+)
Reviewed-by: Stefano Garzarella <sgarzare@redhat.com>
>
>diff --git a/docs/interop/vhost-user.rst b/docs/interop/vhost-user.rst
>index 93a9c8df2b..17a68a62eb 100644
>--- a/docs/interop/vhost-user.rst
>+++ b/docs/interop/vhost-user.rst
>@@ -366,11 +366,15 @@ In QEMU the vhost-user message is implemented with the following struct:
> struct vhost_vring_state state;
> struct vhost_vring_addr addr;
> VhostUserMemory memory;
>+ VhostUserMemRegMsg mem_reg;
> VhostUserLog log;
> struct vhost_iotlb_msg iotlb;
> VhostUserConfig config;
>+ VhostUserCryptoSession session;
> VhostUserVringArea area;
> VhostUserInflight inflight;
>+ VhostUserShared object;
>+ VhostUserTransferDeviceState transfer_state;
> };
> } QEMU_PACKED VhostUserMsg;
>
>--
>2.52.0
>
^ permalink raw reply [flat|nested] 21+ messages in thread
* Re: [PATCH v13 3/7] vhost_user.rst: Add SHMEM_MAP/_UNMAP to spec
2026-03-04 10:23 ` Albert Esteve
@ 2026-03-04 13:11 ` Stefano Garzarella
0 siblings, 0 replies; 21+ messages in thread
From: Stefano Garzarella @ 2026-03-04 13:11 UTC (permalink / raw)
To: Albert Esteve
Cc: qemu-devel, Peter Xu, Pierrick Bouvier, mst, dbassey,
Philippe Mathieu-Daudé, Alex Bennée, Paolo Bonzini,
Fabiano Rosas, stefanha, manos.pitsidianakis, jasowang,
Laurent Vivier, slp, hi, stevensd
On Wed, Mar 04, 2026 at 11:23:42AM +0100, Albert Esteve wrote:
>On Wed, Mar 4, 2026 at 10:46 AM Albert Esteve <aesteve@redhat.com> wrote:
>>
>> On Thu, Feb 19, 2026 at 2:04 PM Albert Esteve <aesteve@redhat.com> wrote:
>> >
>> > Add SHMEM_MAP/_UNMAP request to the vhost-user
>> > spec documentation.
>> >
>> > Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
>> > Reviewed-by: Manos Pitsidianakis <manos.pitsidianakis@linaro.org>
>> > Signed-off-by: Albert Esteve <aesteve@redhat.com>
>> > ---
>> > docs/interop/vhost-user.rst | 61 +++++++++++++++++++++++++++++++++++++
>> > 1 file changed, 61 insertions(+)
>> >
>> > diff --git a/docs/interop/vhost-user.rst b/docs/interop/vhost-user.rst
>> > index 17a68a62eb..ae4ad6f441 100644
>> > --- a/docs/interop/vhost-user.rst
>> > +++ b/docs/interop/vhost-user.rst
>> > @@ -350,6 +350,27 @@ Device state transfer parameters
>> > In the future, additional phases might be added e.g. to allow
>> > iterative migration while the device is running.
>> >
>> > +MMAP request
>> > +^^^^^^^^^^^^
>> > +
>> > ++-------+---------+-----------+------------+-----+-------+
>> > +| shmid | padding | fd_offset | shm_offset | len | flags |
>> > ++-------+---------+-----------+------------+-----+-------+
>> > +
>> > +:shmid: a 8-bit shared memory region identifier
>> > +
>> > +:fd_offset: a 64-bit offset of this area from the start
>> > + of the supplied file descriptor
>> > +
>> > +:shm_offset: a 64-bit offset from the start of the
>> > + pointed shared memory region
>> > +
>> > +:len: a 64-bit size of the memory to map
>> > +
>> > +:flags: a 64-bit value:
>> > + - 0: Pages are mapped read-only
>> > + - 1: Pages are mapped read-write
>> > +
>> > C structure
>> > -----------
>> >
>> > @@ -375,6 +396,7 @@ In QEMU the vhost-user message is implemented with the following struct:
>> > VhostUserInflight inflight;
>> > VhostUserShared object;
>> > VhostUserTransferDeviceState transfer_state;
>> > + VhostUserMMap mmap;
>> > };
>> > } QEMU_PACKED VhostUserMsg;
>> >
>> > @@ -1064,6 +1086,7 @@ Protocol features
>> > #define VHOST_USER_PROTOCOL_F_XEN_MMAP 17
>> > #define VHOST_USER_PROTOCOL_F_SHARED_OBJECT 18
>> > #define VHOST_USER_PROTOCOL_F_DEVICE_STATE 19
>> > + #define VHOST_USER_PROTOCOL_F_SHMEM 20
>>
>> Commit cda83adc62b6108afc8a82d0f54d9a9a861e7aa8 got upstream first and
>> took feature number 20, so this should be 21 now.
>>
>> @Michael Tsirkin Is it worth sending a new version or will you handle
>> the change?
>
>Sorry, I meant e0822e6085aecc15e2cfb2914d8cd827abae0249 (vhost-user:
>introduce protocol feature for skip drain on GET_VRING_BASE).
>
>But the question remains.
Maybe better to rebase to simplify Michael's life.
BTW this pach LGTM:
Reviewed-by: Stefano Garzarella <sgarzare@redhat.com>
^ permalink raw reply [flat|nested] 21+ messages in thread
* Re: [PATCH v13 4/7] vhost_user: Add frontend get_shmem_config command
2026-02-19 13:03 ` [PATCH v13 4/7] vhost_user: Add frontend get_shmem_config command Albert Esteve
@ 2026-03-04 13:12 ` Stefano Garzarella
0 siblings, 0 replies; 21+ messages in thread
From: Stefano Garzarella @ 2026-03-04 13:12 UTC (permalink / raw)
To: Albert Esteve
Cc: qemu-devel, Peter Xu, Pierrick Bouvier, mst, dbassey,
Philippe Mathieu-Daudé, Alex Bennée, Paolo Bonzini,
Fabiano Rosas, stefanha, manos.pitsidianakis, jasowang,
Laurent Vivier, slp, hi, stevensd
On Thu, Feb 19, 2026 at 02:03:31PM +0100, Albert Esteve wrote:
>The frontend can use this command to retrieve
>VirtIO Shared Memory Regions configuration from
>the backend. The response contains the number of
>shared memory regions, their size, and shmid.
>
>This is useful when the frontend is unaware of
>specific backend type and configuration,
>for example, in the `vhost-user-device` case.
>
>Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
>Signed-off-by: Albert Esteve <aesteve@redhat.com>
>---
> include/hw/virtio/vhost-backend.h | 10 ++++++++++
> include/hw/virtio/vhost-user.h | 1 +
> include/hw/virtio/virtio.h | 2 ++
> 3 files changed, 13 insertions(+)
Reviewed-by: Stefano Garzarella <sgarzare@redhat.com>
>
>diff --git a/include/hw/virtio/vhost-backend.h b/include/hw/virtio/vhost-backend.h
>index ff94fa1734..ce58b4d2d6 100644
>--- a/include/hw/virtio/vhost-backend.h
>+++ b/include/hw/virtio/vhost-backend.h
>@@ -163,6 +163,15 @@ typedef int (*vhost_set_device_state_fd_op)(struct vhost_dev *dev,
> int *reply_fd,
> Error **errp);
> typedef int (*vhost_check_device_state_op)(struct vhost_dev *dev, Error **errp);
>+/*
>+ * Max regions is VIRTIO_MAX_SHMEM_REGIONS, so that is the maximum
>+ * number of memory_sizes that will be accepted.
>+ */
>+typedef int (*vhost_get_shmem_config_op)(struct vhost_dev *dev,
>+ int *nregions,
>+ uint64_t *memory_sizes,
>+ Error **errp);
>+
>
> typedef struct VhostOps {
> VhostBackendType backend_type;
>@@ -220,6 +229,7 @@ typedef struct VhostOps {
> vhost_supports_device_state_op vhost_supports_device_state;
> vhost_set_device_state_fd_op vhost_set_device_state_fd;
> vhost_check_device_state_op vhost_check_device_state;
>+ vhost_get_shmem_config_op vhost_get_shmem_config;
> } VhostOps;
>
> int vhost_backend_update_device_iotlb(struct vhost_dev *dev,
>diff --git a/include/hw/virtio/vhost-user.h b/include/hw/virtio/vhost-user.h
>index 55d5725ef8..8ac2120cfd 100644
>--- a/include/hw/virtio/vhost-user.h
>+++ b/include/hw/virtio/vhost-user.h
>@@ -32,6 +32,7 @@ enum VhostUserProtocolFeature {
> /* Feature 17 reserved for VHOST_USER_PROTOCOL_F_XEN_MMAP. */
> VHOST_USER_PROTOCOL_F_SHARED_OBJECT = 18,
> VHOST_USER_PROTOCOL_F_DEVICE_STATE = 19,
>+ VHOST_USER_PROTOCOL_F_SHMEM = 20,
> VHOST_USER_PROTOCOL_F_MAX
> };
>
>diff --git a/include/hw/virtio/virtio.h b/include/hw/virtio/virtio.h
>index 40d881ca09..9aef913af0 100644
>--- a/include/hw/virtio/virtio.h
>+++ b/include/hw/virtio/virtio.h
>@@ -82,6 +82,8 @@ typedef struct VirtQueueElement
>
> #define VIRTIO_NO_VECTOR 0xffff
>
>+#define VIRTIO_MAX_SHMEM_REGIONS 256
>+
> /* special index value used internally for config irqs */
> #define VIRTIO_CONFIG_IRQ_IDX -1
>
>--
>2.52.0
>
^ permalink raw reply [flat|nested] 21+ messages in thread
* Re: [PATCH v13 5/7] vhost_user.rst: Add GET_SHMEM_CONFIG message
2026-02-19 13:03 ` [PATCH v13 5/7] vhost_user.rst: Add GET_SHMEM_CONFIG message Albert Esteve
@ 2026-03-04 13:12 ` Stefano Garzarella
0 siblings, 0 replies; 21+ messages in thread
From: Stefano Garzarella @ 2026-03-04 13:12 UTC (permalink / raw)
To: Albert Esteve
Cc: qemu-devel, Peter Xu, Pierrick Bouvier, mst, dbassey,
Philippe Mathieu-Daudé, Alex Bennée, Paolo Bonzini,
Fabiano Rosas, stefanha, manos.pitsidianakis, jasowang,
Laurent Vivier, slp, hi, stevensd
On Thu, Feb 19, 2026 at 02:03:32PM +0100, Albert Esteve wrote:
>Add GET_SHMEM_CONFIG vhost-user frontend
>message to the spec documentation.
>
>Reviewed-by: Alyssa Ross <hi@alyssa.is>
>Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
>Signed-off-by: Albert Esteve <aesteve@redhat.com>
>---
> docs/interop/vhost-user.rst | 39 +++++++++++++++++++++++++++++++++++++
> 1 file changed, 39 insertions(+)
Reviewed-by: Stefano Garzarella <sgarzare@redhat.com>
>
>diff --git a/docs/interop/vhost-user.rst b/docs/interop/vhost-user.rst
>index ae4ad6f441..77a763c7c3 100644
>--- a/docs/interop/vhost-user.rst
>+++ b/docs/interop/vhost-user.rst
>@@ -371,6 +371,22 @@ MMAP request
> - 0: Pages are mapped read-only
> - 1: Pages are mapped read-write
>
>+VIRTIO Shared Memory Region configuration
>+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>+
>++-------------+---------+------------+----+--------------+
>+| num regions | padding | mem size 0 | .. | mem size 255 |
>++-------------+---------+------------+----+--------------+
>+
>+:num regions: a 32-bit number of regions
>+
>+:padding: 32-bit
>+
>+:mem size: an array of 256 64-bit fields representing the size of each
>+ VIRTIO Shared Memory Region. ``num regions`` specifies the
>+ number of valid regions (non-zero size). The array index
>+ corresponds to the shared memory ID (shmid).
>+
> C structure
> -----------
>
>@@ -397,6 +413,7 @@ In QEMU the vhost-user message is implemented with the following struct:
> VhostUserShared object;
> VhostUserTransferDeviceState transfer_state;
> VhostUserMMap mmap;
>+ VhostUserShMemConfig shmem;
> };
> } QEMU_PACKED VhostUserMsg;
>
>@@ -1761,6 +1778,28 @@ Front-end message types
> Using this function requires prior negotiation of the
> ``VHOST_USER_PROTOCOL_F_DEVICE_STATE`` feature.
>
>+``VHOST_USER_GET_SHMEM_CONFIG``
>+ :id: 44
>+ :equivalent ioctl: N/A
>+ :request payload: N/A
>+ :reply payload: ``struct VhostUserShMemConfig``
>+
>+ When the ``VHOST_USER_PROTOCOL_F_SHMEM`` protocol feature has been
>+ successfully negotiated, this message can be submitted by the front-end
>+ to gather the VIRTIO Shared Memory Region configuration. The back-end will
>+ respond with the number of VIRTIO Shared Memory Regions it requires, and
>+ each shared memory region size in an array. The shared memory IDs are
>+ represented by the array index. The information returned shall comply
>+ with the following rules:
>+
>+ * The shared information will remain valid and unchanged for the entire
>+ lifetime of the connection.
>+
>+ * The Shared Memory Region size must be a multiple of the page size
>+ supported by mmap(2).
>+
>+ * The size may be 0 if the region is unused.
>+
> Back-end message types
> ----------------------
>
>--
>2.52.0
>
^ permalink raw reply [flat|nested] 21+ messages in thread
* Re: [PATCH v13 6/7] qmp: add shmem feature map
2026-02-19 13:03 ` [PATCH v13 6/7] qmp: add shmem feature map Albert Esteve
@ 2026-03-04 13:13 ` Stefano Garzarella
0 siblings, 0 replies; 21+ messages in thread
From: Stefano Garzarella @ 2026-03-04 13:13 UTC (permalink / raw)
To: Albert Esteve
Cc: qemu-devel, Peter Xu, Pierrick Bouvier, mst, dbassey,
Philippe Mathieu-Daudé, Alex Bennée, Paolo Bonzini,
Fabiano Rosas, stefanha, manos.pitsidianakis, jasowang,
Laurent Vivier, slp, hi, stevensd
On Thu, Feb 19, 2026 at 02:03:33PM +0100, Albert Esteve wrote:
>Add new vhost-user protocol
>VHOST_USER_PROTOCOL_F_SHMEM feature to
>feature map.
>
>Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
>Signed-off-by: Albert Esteve <aesteve@redhat.com>
>---
> hw/virtio/virtio-qmp.c | 3 +++
> 1 file changed, 3 insertions(+)
Reviewed-by: Stefano Garzarella <sgarzare@redhat.com>
>
>diff --git a/hw/virtio/virtio-qmp.c b/hw/virtio/virtio-qmp.c
>index 968299fda0..e3d0a10a59 100644
>--- a/hw/virtio/virtio-qmp.c
>+++ b/hw/virtio/virtio-qmp.c
>@@ -127,6 +127,9 @@ static const qmp_virtio_feature_map_t vhost_user_protocol_map[] = {
> FEATURE_ENTRY(VHOST_USER_PROTOCOL_F_DEVICE_STATE, \
> "VHOST_USER_PROTOCOL_F_DEVICE_STATE: Backend device state transfer "
> "supported"),
>+ FEATURE_ENTRY(VHOST_USER_PROTOCOL_F_SHMEM, \
>+ "VHOST_USER_PROTOCOL_F_SHMEM: Backend shared memory mapping "
>+ "supported"),
> { -1, "" }
> };
>
>--
>2.52.0
>
^ permalink raw reply [flat|nested] 21+ messages in thread
* Re: [PATCH v13 7/7] vhost-user-device: Add shared memory BAR
2026-02-19 13:03 ` [PATCH v13 7/7] vhost-user-device: Add shared memory BAR Albert Esteve
@ 2026-03-04 13:26 ` Stefano Garzarella
2026-03-04 14:10 ` Albert Esteve
0 siblings, 1 reply; 21+ messages in thread
From: Stefano Garzarella @ 2026-03-04 13:26 UTC (permalink / raw)
To: Albert Esteve
Cc: qemu-devel, Peter Xu, Pierrick Bouvier, mst, dbassey,
Philippe Mathieu-Daudé, Alex Bennée, Paolo Bonzini,
Fabiano Rosas, stefanha, manos.pitsidianakis, jasowang,
Laurent Vivier, slp, hi, stevensd
On Thu, Feb 19, 2026 at 02:03:34PM +0100, Albert Esteve wrote:
>Add shared memory BAR support to vhost-user-device-pci
>to enable direct file mapping for VIRTIO Shared
>Memory Regions.
>
>The implementation creates a consolidated shared
>memory BAR that contains all VIRTIO Shared
>Memory Regions as subregions. Each region is
>configured with its proper shmid, size, and
>offset within the BAR. The number and size of
>regions are retrieved via VHOST_USER_GET_SHMEM_CONFIG
>message sent by vhost-user-base during realization
>after virtio_init().
>
>Specifiically, it uses BAR 3 to avoid conflicts, as
nit: s/Specifiically/Specifically
Discussed offline, this should be BAR 4 IIUC.
>it is currently unused.
>
>The shared memory BAR is only created when the
>backend supports VHOST_USER_PROTOCOL_F_SHMEM and
>has configured shared memory regions. This maintains
>backward compatibility with backends that do not
>support shared memory functionality.
>
>Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
>Signed-off-by: Albert Esteve <aesteve@redhat.com>
>---
> hw/virtio/vhost-user-base.c | 46 ++++++++++++++++++++++++--
> hw/virtio/vhost-user-test-device-pci.c | 38 +++++++++++++++++++--
> 2 files changed, 79 insertions(+), 5 deletions(-)
>
>diff --git a/hw/virtio/vhost-user-base.c b/hw/virtio/vhost-user-base.c
>index 01ab9ca56b..e5e8abae96 100644
>--- a/hw/virtio/vhost-user-base.c
>+++ b/hw/virtio/vhost-user-base.c
>@@ -16,6 +16,7 @@
> #include "hw/virtio/virtio-bus.h"
> #include "hw/virtio/vhost-user-base.h"
> #include "qemu/error-report.h"
>+#include "migration/blocker.h"
>
> static void vub_start(VirtIODevice *vdev)
>{
>@@ -276,7 +277,8 @@ static void vub_device_realize(DeviceState *dev, Error **errp)
> {
> VirtIODevice *vdev = VIRTIO_DEVICE(dev);
> VHostUserBase *vub = VHOST_USER_BASE(dev);
>- int ret;
>+ uint64_t memory_sizes[VIRTIO_MAX_SHMEM_REGIONS];
>+ int i, ret, nregions, regions_processed = 0;
>
> if (!vub->chardev.chr) {
> error_setg(errp, "vhost-user-base: missing chardev");
>@@ -319,7 +321,7 @@ static void vub_device_realize(DeviceState *dev, Error **errp)
>
> /* Allocate queues */
> vub->vqs = g_ptr_array_sized_new(vub->num_vqs);
>- for (int i = 0; i < vub->num_vqs; i++) {
>+ for (i = 0; i < vub->num_vqs; i++) {
> g_ptr_array_add(vub->vqs,
> virtio_add_queue(vdev, vub->vq_size,
> vub_handle_output));
>@@ -333,11 +335,49 @@ static void vub_device_realize(DeviceState *dev, Error **errp)
> VHOST_BACKEND_TYPE_USER, 0, errp);
>
> if (ret < 0) {
>- do_vhost_user_cleanup(vdev, vub);
>+ goto err;
>+ }
>+
>+ ret = vub->vhost_dev.vhost_ops->vhost_get_shmem_config(&vub->vhost_dev,
>+ &nregions,
>+ memory_sizes,
>+ errp);
>+
>+ if (ret < 0) {
>+ goto err;
>+ }
>+
>+ for (i = 0; i < VIRTIO_MAX_SHMEM_REGIONS && regions_processed < nregions; i++) {
>+ if (memory_sizes[i]) {
>+ regions_processed++;
>+ if (vub->vhost_dev.migration_blocker == NULL) {
>+ error_setg(&vub->vhost_dev.migration_blocker,
>+ "Migration disabled: devices with VIRTIO Shared Memory "
>+ "Regions do not support migration yet.");
>+ ret = migrate_add_blocker_normal(
>+ &vub->vhost_dev.migration_blocker,
>+ errp);
>+
>+ if (ret < 0) {
>+ goto err;
>+ }
>+ }
>+
>+ if (memory_sizes[i] % qemu_real_host_page_size() != 0) {
>+ error_setg(errp, "Shared memory %d size must be a power of 2 "
>+ "no smaller than the page size", i);
Is this error message updated?
>+ goto err;
>+ }
>+
>+ virtio_new_shmem_region(vdev, i, memory_sizes[i]);
>+ }
> }
>
> qemu_chr_fe_set_handlers(&vub->chardev, NULL, NULL, vub_event, NULL,
> dev, NULL, true);
>+ return;
>+err:
>+ do_vhost_user_cleanup(vdev, vub);
> }
>
> static void vub_device_unrealize(DeviceState *dev)
>diff --git a/hw/virtio/vhost-user-test-device-pci.c b/hw/virtio/vhost-user-test-device-pci.c
>index 7f6d751690..22678e3277 100644
>--- a/hw/virtio/vhost-user-test-device-pci.c
>+++ b/hw/virtio/vhost-user-test-device-pci.c
>@@ -12,10 +12,13 @@
> #include "hw/virtio/vhost-user-base.h"
> #include "hw/virtio/virtio-pci.h"
>
>+#define VIRTIO_DEVICE_PCI_SHMEM_BAR 4
>+
> struct VHostUserDevicePCI {
> VirtIOPCIProxy parent_obj;
>
> VHostUserBase vub;
>+ MemoryRegion shmembar;
> };
>
> #define TYPE_VHOST_USER_TEST_DEVICE_PCI "vhost-user-test-device-pci-base"
>@@ -25,10 +28,41 @@ OBJECT_DECLARE_SIMPLE_TYPE(VHostUserDevicePCI, VHOST_USER_TEST_DEVICE_PCI)
> static void vhost_user_device_pci_realize(VirtIOPCIProxy *vpci_dev, Error **errp)
> {
> VHostUserDevicePCI *dev = VHOST_USER_TEST_DEVICE_PCI(vpci_dev);
>- DeviceState *vdev = DEVICE(&dev->vub);
>+ DeviceState *dev_state = DEVICE(&dev->vub);
>+ VirtIODevice *vdev = VIRTIO_DEVICE(dev_state);
>+ VirtioSharedMemory *shmem, *next;
>+ uint64_t offset = 0, shmem_size = 0;
>
I'd add a comment here to explain this since it's not immediately clear
IMHO.
>+ vpci_dev->modern_mem_bar_idx = 2;
> vpci_dev->nvectors = 1;
>- qdev_realize(vdev, BUS(&vpci_dev->bus), errp);
>+ qdev_realize(dev_state, BUS(&vpci_dev->bus), errp);
IIUC before this patch qdev_realize() was the last step in this
function, so we didn't check for any error, but now should we return
earlier if it fails?
>+
>+ QSIMPLEQ_FOREACH_SAFE(shmem, &vdev->shmem_list, entry, next) {
Is QSIMPLEQ_FOREACH_SAFE really needed here? IIUC we are not modifying
the list, so can we use QSIMPLEQ_FOREACH ?
>+ if (shmem->mr.size > UINT64_MAX - shmem_size) {
Same here about using memory_region_size().
>+ error_setg(errp, "Total shared memory required overflow");
>+ return;
>+ }
>+ shmem_size = shmem_size + shmem->mr.size;
Ditto about memory_region_size().
>+ }
>+ if (shmem_size) {
>+ if (vpci_dev->flags & VIRTIO_PCI_FLAG_MODERN_PIO_NOTIFY) {
>+ error_setg(errp, "modern-pio-notify is not supported due to PCI BAR layout limitations");
>+ return;
>+ }
>+ memory_region_init(&dev->shmembar, OBJECT(vpci_dev),
>+ "vhost-device-pci-shmembar", shmem_size);
>+ QSIMPLEQ_FOREACH_SAFE(shmem, &vdev->shmem_list, entry, next) {
Ditto about QSIMPLEQ_FOREACH_SAFE.
BTW my comments can eventually be fixed with a followup, overall LGTM,
but if you need to resend, maybe we can fix them now.
In any case:
Reviewed-by: Stefano Garzarella <sgarzare@redhat.com>
>+ memory_region_add_subregion(&dev->shmembar, offset, &shmem->mr);
>+ virtio_pci_add_shm_cap(vpci_dev, VIRTIO_DEVICE_PCI_SHMEM_BAR,
>+ offset, shmem->mr.size, shmem->shmid);
>+ offset = offset + shmem->mr.size;
>+ }
>+ pci_register_bar(&vpci_dev->pci_dev, VIRTIO_DEVICE_PCI_SHMEM_BAR,
>+ PCI_BASE_ADDRESS_SPACE_MEMORY |
>+ PCI_BASE_ADDRESS_MEM_PREFETCH |
>+ PCI_BASE_ADDRESS_MEM_TYPE_64,
>+ &dev->shmembar);
>+ }
> }
>
> static void vhost_user_device_pci_class_init(ObjectClass *klass,
>--
>2.52.0
>
^ permalink raw reply [flat|nested] 21+ messages in thread
* Re: [PATCH v13 0/7] vhost-user: Add SHMEM_MAP/UNMAP requests
2026-02-19 13:03 [PATCH v13 0/7] vhost-user: Add SHMEM_MAP/UNMAP requests Albert Esteve
` (6 preceding siblings ...)
2026-02-19 13:03 ` [PATCH v13 7/7] vhost-user-device: Add shared memory BAR Albert Esteve
@ 2026-03-04 13:28 ` Stefano Garzarella
7 siblings, 0 replies; 21+ messages in thread
From: Stefano Garzarella @ 2026-03-04 13:28 UTC (permalink / raw)
To: Albert Esteve, mst
Cc: qemu-devel, Peter Xu, Pierrick Bouvier, mst, dbassey,
Philippe Mathieu-Daudé, Alex Bennée, Paolo Bonzini,
Fabiano Rosas, stefanha, manos.pitsidianakis, jasowang,
Laurent Vivier, slp, hi, stevensd
On Thu, Feb 19, 2026 at 02:03:27PM +0100, Albert Esteve wrote:
>Hi all,
Thanks, I fully reviewed this and LGTM! I left some minor comments.
@Michael IIUC this is not applying on master, so I suggested to rebase
and send a new verions. Would be great if we can merge this before rc0.
Thanks,
Stefano
>
>v12-v13
>- SMEM_UNMAP spec update to explicitly state the use of
> VHOST_USER_PROTOCOL_F_REPLY_ACK for replies
>- Removed confusing remark for 0-sized regions in
> GET_SHMEM_CONFIG
>v11->v12
>- Refined VIRTIO Shared Memory Region configuration mem size
> spec description
>- Removed unused name in vhost-user-base's vub_device_realize to
> avoid build error
>- Initialize shmem in vhost_user_backend_handle_shmem_unmap
> to avoid compiler being confused
>- Added stub for memory_region_init_ram_from_fd in memory.h
> for windows builds
>- Use memory_region_size for shmem_region handlers instead
> of accessing size member directly in shmem mrs
>v10->v11
>- Rebase to grab commit fde5930cc37175cfcd0f03a089e26f4458a52311
> and explicitly unset reply_ack on the SHMEM_MAP/UNMAP msg.
>- Mention mapping cleanup on device reset in the spec.
>v9->v10
>- Fix transaction_commit invoked without transaction_begin
> on vhost_user_backend_handle_shmem_map() early errors
>- Removed fd tracking on VirtioSharedMemoryMapping, it
> is handled by the RAMBlock
>- Reject invalid BAR configurations when VIRTIO Shared Memory
> Regions are in use by vhost-user-test-device
>
>This patch series implements dynamic fd-backed memory mapping support
>for vhost-user backends, enabling backends to dynamically request memory
>mappings and unmappings during runtime through the new
>VHOST_USER_BACKEND_SHMEM_MAP/UNMAP protocol messages.
>
>This feature benefits various VIRTIO devices that require dynamic shared
>memory management, including virtiofs (for DAX mappings), virtio-gpu
>(for resource sharing), and the recently standardized virtio-media.
>
>The implementation introduces a QOM-based architecture for managing
>shared memory lifecycle:
>
>- VirtioSharedMemoryMapping: an intermediate object that manages
> individual memory mappings by acting as generic container for regions
> declared in any vhost-user device type
>- Dynamic Mapping: backends can request mappings via SHMEM_MAP messages,
> with the frontend creating MemoryRegions from the provided file
> descriptors and adding them as subregions
>
>When a SHMEM_MAP request is received, the frontend:
>1. Creates VirtioSharedMemoryMapping to manage the mapping lifecycle
>2. Maps the provided fd with memory_region_init_ram_from_fd()
>3. Creates a MemoryRegion backed by the mapped memory
>4. Adds it as a subregion of the appropiate VIRTIO Shared Memory Region
>
>The QOM reference counting ensures automatic cleanup when mappings are
>removed or the device is destroyed.
>
>This patch also includes:
>- VHOST_USER_GET_SHMEM_CONFIG: a new frontend request allowing generic
> vhost-user devices to query shared memory configuration from backends
> at device initialization, enabling the generic vhost-user-device
> frontend to work with any backend regardless of specific shared memory
> requirements.
>
>The implementation has been tested with rust-vmm based backends.
>
>Albert Esteve (7):
> vhost-user: Add VirtIO Shared Memory map request
> vhost_user.rst: Align VhostUserMsg excerpt members
> vhost_user.rst: Add SHMEM_MAP/_UNMAP to spec
> vhost_user: Add frontend get_shmem_config command
> vhost_user.rst: Add GET_SHMEM_CONFIG message
> qmp: add shmem feature map
> vhost-user-device: Add shared memory BAR
>
> docs/interop/vhost-user.rst | 104 +++++++++
> hw/virtio/vhost-user-base.c | 46 +++-
> hw/virtio/vhost-user-test-device-pci.c | 38 ++-
> hw/virtio/vhost-user.c | 269 ++++++++++++++++++++++
> hw/virtio/virtio-qmp.c | 3 +
> hw/virtio/virtio.c | 201 ++++++++++++++++
> include/hw/virtio/vhost-backend.h | 10 +
> include/hw/virtio/vhost-user.h | 1 +
> include/hw/virtio/virtio.h | 137 +++++++++++
> include/system/memory.h | 13 ++
> subprojects/libvhost-user/libvhost-user.c | 70 ++++++
> subprojects/libvhost-user/libvhost-user.h | 54 +++++
> 12 files changed, 941 insertions(+), 5 deletions(-)
>
>--
>2.52.0
>
^ permalink raw reply [flat|nested] 21+ messages in thread
* Re: [PATCH v13 1/7] vhost-user: Add VirtIO Shared Memory map request
2026-03-04 13:08 ` Stefano Garzarella
@ 2026-03-04 13:31 ` Albert Esteve
0 siblings, 0 replies; 21+ messages in thread
From: Albert Esteve @ 2026-03-04 13:31 UTC (permalink / raw)
To: Stefano Garzarella
Cc: qemu-devel, Peter Xu, Pierrick Bouvier, mst, dbassey,
Philippe Mathieu-Daudé, Alex Bennée, Paolo Bonzini,
Fabiano Rosas, stefanha, manos.pitsidianakis, jasowang,
Laurent Vivier, slp, hi, stevensd
On Wed, Mar 4, 2026 at 2:08 PM Stefano Garzarella <sgarzare@redhat.com> wrote:
>
> On Thu, Feb 19, 2026 at 02:03:28PM +0100, Albert Esteve wrote:
> >Add SHMEM_MAP/UNMAP requests to vhost-user for dynamic management of
> >VIRTIO Shared Memory mappings.
> >
> >This implementation introduces VirtioSharedMemoryMapping as a unified
> >QOM object that manages both the mapping metadata and MemoryRegion
> >lifecycle. This object provides reference-counted lifecycle management
> >with automatic cleanup of file descriptors and memory regions
> >through QOM finalization.
> >
> >This request allows backends to dynamically map file descriptors into a
> >VIRTIO Shared Memory Region identified by their shmid. Maps are created
> >using memory_region_init_ram_from_fd() with configurable read/write
> >permissions, and the resulting MemoryRegions are added as subregions to
> >the shmem container region. The mapped memory is then advertised to the
> >guest VIRTIO drivers as a base address plus offset for reading and
> >writting according to the requested mmap flags.
> >
> >The backend can unmap memory ranges within a given VIRTIO Shared Memory
> >Region to free resources. Upon receiving this message, the frontend
> >removes the MemoryRegion as a subregion and automatically unreferences
> >the VirtioSharedMemoryMapping object, triggering cleanup if no other
> >references exist.
> >
> >Error handling has been improved to ensure consistent behavior across
> >handlers that manage their own vhost_user_send_resp() calls. Since
> >these handlers clear the VHOST_USER_NEED_REPLY_MASK flag, explicit
> >error checking ensures proper connection closure on failures,
> >maintaining the expected error flow.
> >
> >Note the memory region commit for these operations needs to be delayed
> >until after we reply to the backend to avoid deadlocks. Otherwise,
> >the MemoryListener would send a VHOST_USER_SET_MEM_TABLE message
> >before the reply.
> >
> >Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
> >Signed-off-by: Albert Esteve <aesteve@redhat.com>
> >---
> > hw/virtio/vhost-user.c | 269 ++++++++++++++++++++++
> > hw/virtio/virtio.c | 201 ++++++++++++++++
> > include/hw/virtio/virtio.h | 135 +++++++++++
> > include/system/memory.h | 13 ++
> > subprojects/libvhost-user/libvhost-user.c | 70 ++++++
> > subprojects/libvhost-user/libvhost-user.h | 54 +++++
> > 6 files changed, 742 insertions(+)
> >
> >diff --git a/hw/virtio/vhost-user.c b/hw/virtio/vhost-user.c
> >index 63fa9a1b4b..5d3841d58b 100644
> >--- a/hw/virtio/vhost-user.c
> >+++ b/hw/virtio/vhost-user.c
> >@@ -104,6 +104,7 @@ typedef enum VhostUserRequest {
> > VHOST_USER_GET_SHARED_OBJECT = 41,
> > VHOST_USER_SET_DEVICE_STATE_FD = 42,
> > VHOST_USER_CHECK_DEVICE_STATE = 43,
> >+ VHOST_USER_GET_SHMEM_CONFIG = 44,
> > VHOST_USER_MAX
> > } VhostUserRequest;
> >
> >@@ -115,6 +116,8 @@ typedef enum VhostUserBackendRequest {
> > VHOST_USER_BACKEND_SHARED_OBJECT_ADD = 6,
> > VHOST_USER_BACKEND_SHARED_OBJECT_REMOVE = 7,
> > VHOST_USER_BACKEND_SHARED_OBJECT_LOOKUP = 8,
> >+ VHOST_USER_BACKEND_SHMEM_MAP = 9,
> >+ VHOST_USER_BACKEND_SHMEM_UNMAP = 10,
> > VHOST_USER_BACKEND_MAX
> > } VhostUserBackendRequest;
> >
> >@@ -136,6 +139,12 @@ typedef struct VhostUserMemRegMsg {
> > VhostUserMemoryRegion region;
> > } VhostUserMemRegMsg;
> >
> >+typedef struct VhostUserShMemConfig {
> >+ uint32_t nregions;
> >+ uint32_t padding;
> >+ uint64_t memory_sizes[VIRTIO_MAX_SHMEM_REGIONS];
> >+} VhostUserShMemConfig;
> >+
> > typedef struct VhostUserLog {
> > uint64_t mmap_size;
> > uint64_t mmap_offset;
> >@@ -192,6 +201,23 @@ typedef struct VhostUserShared {
> > unsigned char uuid[16];
> > } VhostUserShared;
> >
> >+/* For the flags field of VhostUserMMap */
> >+#define VHOST_USER_FLAG_MAP_RW (1u << 0)
> >+
> >+typedef struct {
> >+ /* VIRTIO Shared Memory Region ID */
> >+ uint8_t shmid;
> >+ uint8_t padding[7];
> >+ /* File offset */
> >+ uint64_t fd_offset;
> >+ /* Offset within the VIRTIO Shared Memory Region */
> >+ uint64_t shm_offset;
> >+ /* Size of the mapping */
> >+ uint64_t len;
> >+ /* Flags for the mmap operation, from VHOST_USER_FLAG_MAP_* */
> >+ uint64_t flags;
> >+} VhostUserMMap;
> >+
> > typedef struct {
> > VhostUserRequest request;
> >
> >@@ -224,6 +250,8 @@ typedef union {
> > VhostUserInflight inflight;
> > VhostUserShared object;
> > VhostUserTransferDeviceState transfer_state;
> >+ VhostUserMMap mmap;
> >+ VhostUserShMemConfig shmem;
> > } VhostUserPayload;
> >
> > typedef struct VhostUserMsg {
> >@@ -1771,6 +1799,196 @@ vhost_user_backend_handle_shared_object_lookup(struct vhost_user *u,
> > return 0;
> > }
> >
> >+/**
> >+ * vhost_user_backend_handle_shmem_map() - Handle SHMEM_MAP backend request
> >+ * @dev: vhost device
> >+ * @ioc: QIOChannel for communication
> >+ * @hdr: vhost-user message header
> >+ * @payload: message payload containing mapping details
> >+ * @fd: file descriptor for the shared memory region
> >+ *
> >+ * Handles VHOST_USER_BACKEND_SHMEM_MAP requests from the backend. Creates
> >+ * a VhostUserShmemObject to manage the shared memory mapping and adds it
> >+ * to the appropriate VirtIO shared memory region. The VhostUserShmemObject
> >+ * serves as an intermediate parent for the MemoryRegion, ensuring proper
> >+ * lifecycle management with reference counting.
> >+ *
> >+ * Returns: 0 on success, negative errno on failure
> >+ */
> >+static int
> >+vhost_user_backend_handle_shmem_map(struct vhost_dev *dev,
> >+ QIOChannel *ioc,
> >+ VhostUserHeader *hdr,
> >+ VhostUserPayload *payload,
> >+ int fd)
> >+{
> >+ VirtioSharedMemory *shmem;
> >+ VhostUserMMap *vu_mmap = &payload->mmap;
> >+ VirtioSharedMemoryMapping *existing;
> >+ Error *local_err = NULL;
> >+ int ret = 0;
> >+
> >+ if (fd < 0) {
> >+ error_report("Bad fd for map");
> >+ ret = -EBADF;
> >+ goto send_reply;
> >+ }
> >+
> >+ if (QSIMPLEQ_EMPTY(&dev->vdev->shmem_list)) {
> >+ error_report("Device has no VIRTIO Shared Memory Regions. "
> >+ "Requested ID: %d", vu_mmap->shmid);
> >+ ret = -EFAULT;
> >+ goto send_reply;
> >+ }
> >+
> >+ shmem = virtio_find_shmem_region(dev->vdev, vu_mmap->shmid);
> >+ if (!shmem) {
> >+ error_report("VIRTIO Shared Memory Region at "
> >+ "ID %d not found or uninitialized", vu_mmap->shmid);
> >+ ret = -EFAULT;
> >+ goto send_reply;
> >+ }
> >+
> >+ if ((vu_mmap->shm_offset + vu_mmap->len) < vu_mmap->len ||
> >+ (vu_mmap->shm_offset + vu_mmap->len) > shmem->mr.size) {
>
> Any reason about not using `memory_region_size(&shmem->mr)` ?
Nope, that would be better, I will change it.
>
> >+ error_report("Bad offset/len for mmap %" PRIx64 "+%" PRIx64,
> >+ vu_mmap->shm_offset, vu_mmap->len);
> >+ ret = -EFAULT;
> >+ goto send_reply;
> >+ }
> >+
> >+ QTAILQ_FOREACH(existing, &shmem->mmaps, link) {
> >+ if (ranges_overlap(existing->offset, existing->len,
> >+ vu_mmap->shm_offset, vu_mmap->len)) {
> >+ error_report("VIRTIO Shared Memory mapping overlap");
> >+ ret = -EFAULT;
> >+ goto send_reply;
> >+ }
> >+ }
> >+
> >+ memory_region_transaction_begin();
> >+
> >+ /* Create VirtioSharedMemoryMapping object */
> >+ VirtioSharedMemoryMapping *mapping = virtio_shared_memory_mapping_new(
> >+ vu_mmap->shmid, fd, vu_mmap->fd_offset, vu_mmap->shm_offset,
> >+ vu_mmap->len, vu_mmap->flags & VHOST_USER_FLAG_MAP_RW);
> >+
> >+ if (!mapping) {
> >+ ret = -EFAULT;
> >+ goto send_reply_commit;
> >+ }
> >+
> >+ /* Add the mapping to the shared memory region */
> >+ if (virtio_add_shmem_map(shmem, mapping) != 0) {
> >+ error_report("Failed to add shared memory mapping");
> >+ object_unref(OBJECT(mapping));
> >+ ret = -EFAULT;
> >+ goto send_reply_commit;
> >+ }
> >+
> >+send_reply_commit:
> >+ /* Send reply and commit after transaction started */
> >+ if (hdr->flags & VHOST_USER_NEED_REPLY_MASK) {
> >+ payload->u64 = !!ret;
> >+ hdr->size = sizeof(payload->u64);
> >+ if (!vhost_user_send_resp(ioc, hdr, payload, &local_err)) {
> >+ error_report_err(local_err);
> >+ memory_region_transaction_commit();
> >+ return -EFAULT;
> >+ }
> >+ }
> >+ memory_region_transaction_commit();
> >+ return 0;
> >+
> >+send_reply:
> >+ if (hdr->flags & VHOST_USER_NEED_REPLY_MASK) {
> >+ payload->u64 = !!ret;
> >+ hdr->size = sizeof(payload->u64);
> >+ if (!vhost_user_send_resp(ioc, hdr, payload, &local_err)) {
> >+ error_report_err(local_err);
> >+ return -EFAULT;
> >+ }
> >+ }
> >+ return 0;
> >+}
> >+
> >+/**
> >+ * vhost_user_backend_handle_shmem_unmap() - Handle SHMEM_UNMAP backend request
> >+ * @dev: vhost device
> >+ * @ioc: QIOChannel for communication
> >+ * @hdr: vhost-user message header
> >+ * @payload: message payload containing unmapping details
> >+ *
> >+ * Handles VHOST_USER_BACKEND_SHMEM_UNMAP requests from the backend. Removes
> >+ * the specified memory mapping from the VirtIO shared memory region.
> >This
> >+ * automatically unreferences the associated VhostUserShmemObject, which may
> >+ * trigger its finalization and cleanup (munmap, close fd) if no other
> >+ * references exist.
> >+ *
> >+ * Returns: 0 on success, negative errno on failure
> >+ */
> >+static int
> >+vhost_user_backend_handle_shmem_unmap(struct vhost_dev *dev,
> >+ QIOChannel *ioc,
> >+ VhostUserHeader *hdr,
> >+ VhostUserPayload *payload)
> >+{
> >+ VirtioSharedMemory *shmem = NULL;
> >+ VirtioSharedMemoryMapping *mmap = NULL;
> >+ VhostUserMMap *vu_mmap = &payload->mmap;
> >+ Error *local_err = NULL;
> >+ int ret = 0;
> >+
> >+ if (QSIMPLEQ_EMPTY(&dev->vdev->shmem_list)) {
> >+ error_report("Device has no VIRTIO Shared Memory Regions. "
> >+ "Requested ID: %d", vu_mmap->shmid);
> >+ ret = -EFAULT;
> >+ goto send_reply;
> >+ }
> >+
> >+ shmem = virtio_find_shmem_region(dev->vdev, vu_mmap->shmid);
> >+ if (!shmem) {
> >+ error_report("VIRTIO Shared Memory Region at "
> >+ "ID %d not found or uninitialized", vu_mmap->shmid);
> >+ ret = -EFAULT;
> >+ goto send_reply;
> >+ }
> >+
> >+ if ((vu_mmap->shm_offset + vu_mmap->len) < vu_mmap->len ||
> >+ (vu_mmap->shm_offset + vu_mmap->len) > shmem->mr.size) {
> >+ error_report("Bad offset/len for unmmap %" PRIx64 "+%" PRIx64,
> >+ vu_mmap->shm_offset, vu_mmap->len);
> >+ ret = -EFAULT;
> >+ goto send_reply;
> >+ }
> >+
> >+ mmap = virtio_find_shmem_map(shmem, vu_mmap->shm_offset, vu_mmap->len);
> >+ if (!mmap) {
> >+ error_report("Shared memory mapping not found at offset %" PRIx64
> >+ " with length %" PRIx64,
> >+ vu_mmap->shm_offset, vu_mmap->len);
> >+ ret = -EFAULT;
> >+ goto send_reply;
> >+ }
> >+
> >+send_reply:
> >+ if (hdr->flags & VHOST_USER_NEED_REPLY_MASK) {
> >+ payload->u64 = !!ret;
> >+ hdr->size = sizeof(payload->u64);
> >+ if (!vhost_user_send_resp(ioc, hdr, payload, &local_err)) {
> >+ error_report_err(local_err);
> >+ return -EFAULT;
> >+ }
> >+ }
> >+
> >+ if (!ret && shmem && mmap) {
> >+ /* Free the MemoryRegion only after reply */
> >+ virtio_del_shmem_map(shmem, vu_mmap->shm_offset, vu_mmap->len);
> >+ }
> >+
> >+ return 0;
> >+}
> >+
> > static void close_backend_channel(struct vhost_user *u)
> > {
> > g_source_destroy(u->backend_src);
> >@@ -1844,6 +2062,21 @@ static gboolean backend_read(QIOChannel *ioc, GIOCondition condition,
> > ret = vhost_user_backend_handle_shared_object_lookup(dev->opaque,
> > &payload.object);
> > break;
> >+ case VHOST_USER_BACKEND_SHMEM_MAP:
> >+ /* Handler manages its own response, check error and close connection */
> >+ reply_ack = false;
> >+ if (vhost_user_backend_handle_shmem_map(dev, ioc, &hdr, &payload,
> >+ fd ? fd[0] : -1) < 0) {
> >+ goto err;
> >+ }
> >+ break;
> >+ case VHOST_USER_BACKEND_SHMEM_UNMAP:
> >+ /* Handler manages its own response, check error and close connection */
> >+ reply_ack = false;
> >+ if (vhost_user_backend_handle_shmem_unmap(dev, ioc, &hdr, &payload) < 0) {
> >+ goto err;
> >+ }
> >+ break;
> > default:
> > error_report("Received unexpected msg type: %d.", hdr.request);
> > ret = -EINVAL;
> >@@ -3021,6 +3254,41 @@ static int vhost_user_check_device_state(struct vhost_dev *dev, Error **errp)
> > return 0;
> > }
> >
> >+static int vhost_user_get_shmem_config(struct vhost_dev *dev,
> >+ int *nregions,
> >+ uint64_t *memory_sizes,
> >+ Error **errp)
> >+{
> >+ int ret;
> >+ VhostUserMsg msg = {
> >+ .hdr.request = VHOST_USER_GET_SHMEM_CONFIG,
> >+ .hdr.flags = VHOST_USER_VERSION,
> >+ };
> >+
> >+ if (!virtio_has_feature(dev->protocol_features,
> >+ VHOST_USER_PROTOCOL_F_SHMEM)) {
> >+ *nregions = 0;
> >+ return 0;
> >+ }
> >+
> >+ ret = vhost_user_write(dev, &msg, NULL, 0);
> >+ if (ret < 0) {
> >+ return ret;
> >+ }
> >+
> >+ ret = vhost_user_read(dev, &msg);
> >+ if (ret < 0) {
> >+ return ret;
> >+ }
> >+
> >+ assert(msg.payload.shmem.nregions <= VIRTIO_MAX_SHMEM_REGIONS);
>
> Is this `assert()` too much?
> This means that a bad vhost-user backend can crash QEMU, so not sure
> it's really what we want, I'd return an error.
I guess I was doing the same as in `vhost_user_get_config`, which also
asserts the max size. But I agree, returning an error is reasonable in
this case.
>
> >+ *nregions = msg.payload.shmem.nregions;
> >+ memcpy(memory_sizes,
> >+ &msg.payload.shmem.memory_sizes,
> >+ sizeof(uint64_t) * VIRTIO_MAX_SHMEM_REGIONS);
> >+ return 0;
> >+}
> >+
> > const VhostOps user_ops = {
> > .backend_type = VHOST_BACKEND_TYPE_USER,
> > .vhost_backend_init = vhost_user_backend_init,
> >@@ -3059,4 +3327,5 @@ const VhostOps user_ops = {
> > .vhost_supports_device_state = vhost_user_supports_device_state,
> > .vhost_set_device_state_fd = vhost_user_set_device_state_fd,
> > .vhost_check_device_state = vhost_user_check_device_state,
> >+ .vhost_get_shmem_config = vhost_user_get_shmem_config,
> > };
> >diff --git a/hw/virtio/virtio.c b/hw/virtio/virtio.c
> >index 3dc9423eae..2f608f33ae 100644
> >--- a/hw/virtio/virtio.c
> >+++ b/hw/virtio/virtio.c
> >@@ -3111,6 +3111,173 @@ int virtio_save(VirtIODevice *vdev, QEMUFile *f)
> > return ret;
> > }
> >
> >+VirtioSharedMemory *virtio_new_shmem_region(VirtIODevice *vdev, uint8_t shmid, uint64_t size)
> >+{
> >+ VirtioSharedMemory *elem;
> >+ g_autofree char *name = NULL;
> >+
> >+ elem = g_new0(VirtioSharedMemory, 1);
> >+ elem->shmid = shmid;
> >+
> >+ /* Initialize embedded MemoryRegion as container for shmem mappings */
> >+ name = g_strdup_printf("virtio-shmem-%d", shmid);
> >+ memory_region_init(&elem->mr, OBJECT(vdev), name, size);
> >+ QTAILQ_INIT(&elem->mmaps);
> >+ QSIMPLEQ_INSERT_TAIL(&vdev->shmem_list, elem, entry);
> >+ return elem;
> >+}
> >+
> >+VirtioSharedMemory *virtio_find_shmem_region(VirtIODevice *vdev, uint8_t shmid)
> >+{
> >+ VirtioSharedMemory *shmem, *next;
> >+ QSIMPLEQ_FOREACH_SAFE(shmem, &vdev->shmem_list, entry, next) {
> >+ if (shmem->shmid == shmid) {
> >+ return shmem;
> >+ }
> >+ }
> >+ return NULL;
> >+}
> >+
> >+static void virtio_shared_memory_mapping_instance_init(Object *obj)
> >+{
> >+ VirtioSharedMemoryMapping *mapping = VIRTIO_SHARED_MEMORY_MAPPING(obj);
> >+
> >+ mapping->shmid = 0;
> >+ mapping->offset = 0;
> >+ mapping->len = 0;
> >+ mapping->mr = NULL;
> >+}
> >+
> >+static void virtio_shared_memory_mapping_instance_finalize(Object *obj)
> >+{
> >+ VirtioSharedMemoryMapping *mapping = VIRTIO_SHARED_MEMORY_MAPPING(obj);
> >+
> >+ /* Clean up MemoryRegion if it exists */
> >+ if (mapping->mr) {
> >+ /* Unparent the MemoryRegion to trigger cleanup */
> >+ object_unparent(OBJECT(mapping->mr));
> >+ mapping->mr = NULL;
> >+ }
> >+}
> >+
> >+VirtioSharedMemoryMapping *virtio_shared_memory_mapping_new(uint8_t shmid,
> >+ int fd,
> >+ uint64_t fd_offset,
> >+ uint64_t shm_offset,
> >+ uint64_t len,
> >+ bool allow_write)
> >+{
> >+ VirtioSharedMemoryMapping *mapping;
> >+ MemoryRegion *mr;
> >+ g_autoptr(GString) mr_name = g_string_new(NULL);
> >+ uint32_t ram_flags;
> >+ Error *local_err = NULL;
> >+
> >+ if (len == 0) {
> >+ error_report("Shared memory mapping size cannot be zero");
> >+ return NULL;
> >+ }
> >+
> >+ fd = dup(fd);
> >+ if (fd < 0) {
> >+ error_report("Failed to duplicate fd: %s", strerror(errno));
> >+ return NULL;
> >+ }
> >+
> >+ /* Determine RAM flags */
> >+ ram_flags = RAM_SHARED;
> >+ if (!allow_write) {
> >+ ram_flags |= RAM_READONLY_FD;
> >+ }
> >+
> >+ /* Create the VirtioSharedMemoryMapping */
> >+ mapping = VIRTIO_SHARED_MEMORY_MAPPING(
> >+ object_new(TYPE_VIRTIO_SHARED_MEMORY_MAPPING));
> >+
> >+ /* Set up object properties */
> >+ mapping->shmid = shmid;
> >+ mapping->offset = shm_offset;
> >+ mapping->len = len;
> >+
> >+ /* Create MemoryRegion as a child of this object */
> >+ mr = g_new0(MemoryRegion, 1);
> >+ g_string_printf(mr_name, "virtio-shmem-%d-%" PRIx64, shmid, shm_offset);
> >+
> >+ /* Initialize MemoryRegion with file descriptor */
> >+ if (!memory_region_init_ram_from_fd(mr, OBJECT(mapping), mr_name->str,
> >+ len, ram_flags, fd, fd_offset,
> >+ &local_err)) {
> >+ error_report_err(local_err);
> >+ g_free(mr);
> >+ close(fd);
> >+ object_unref(OBJECT(mapping));
> >+ return NULL;
> >+ }
> >+
> >+ mapping->mr = mr;
> >+ return mapping;
> >+}
> >+
> >+int virtio_add_shmem_map(VirtioSharedMemory *shmem,
> >+ VirtioSharedMemoryMapping *mapping)
> >+{
> >+ if (!mapping) {
> >+ error_report("VirtioSharedMemoryMapping cannot be NULL");
> >+ return -1;
> >+ }
> >+ if (!mapping->mr) {
> >+ error_report("VirtioSharedMemoryMapping has no MemoryRegion");
> >+ return -1;
> >+ }
> >+
> >+ /* Validate boundaries against the VIRTIO shared memory region */
> >+ if (mapping->offset + mapping->len > memory_region_size(&shmem->mr)) {
> >+ error_report("Memory exceeds the shared memory boundaries");
> >+ return -1;
> >+ }
> >+
> >+ /* Add as subregion to the VIRTIO shared memory */
> >+ memory_region_add_subregion(&shmem->mr, mapping->offset, mapping->mr);
> >+
> >+ /* Add to the mapped regions list */
> >+ QTAILQ_INSERT_TAIL(&shmem->mmaps, mapping, link);
> >+
> >+ return 0;
> >+}
> >+
> >+VirtioSharedMemoryMapping *virtio_find_shmem_map(VirtioSharedMemory *shmem,
> >+ hwaddr offset, uint64_t size)
> >+{
> >+ VirtioSharedMemoryMapping *mapping;
> >+ QTAILQ_FOREACH(mapping, &shmem->mmaps, link) {
> >+ if (mapping->offset == offset && mapping->len == size) {
> >+ return mapping;
> >+ }
> >+ }
> >+ return NULL;
> >+}
> >+
> >+void virtio_del_shmem_map(VirtioSharedMemory *shmem, hwaddr offset,
> >+ uint64_t size)
> >+{
> >+ VirtioSharedMemoryMapping *mapping = virtio_find_shmem_map(shmem, offset, size);
> >+ if (mapping == NULL) {
> >+ return;
> >+ }
> >+
> >+ /*
> >+ * Remove from memory region first
> >+ */
> >+ memory_region_del_subregion(&shmem->mr, mapping->mr);
> >+
> >+ /*
> >+ * Remove from list and unref the mapping which will trigger automatic cleanup
> >+ * when the reference count reaches zero.
> >+ */
> >+ QTAILQ_REMOVE(&shmem->mmaps, mapping, link);
> >+ object_unref(OBJECT(mapping));
> >+}
> >+
> > /* A wrapper for use as a VMState .put function */
> > static int virtio_device_put(QEMUFile *f, void *opaque, size_t size,
> > const VMStateField *field, JSONWriter *vmdesc)
> >@@ -3237,6 +3404,7 @@ void virtio_reset(void *opaque)
> > {
> > VirtIODevice *vdev = opaque;
> > VirtioDeviceClass *k = VIRTIO_DEVICE_GET_CLASS(vdev);
> >+ VirtioSharedMemory *shmem;
> > uint64_t features[VIRTIO_FEATURES_NU64S];
> > int i;
> >
> >@@ -3276,6 +3444,15 @@ void virtio_reset(void *opaque)
> > for (i = 0; i < VIRTIO_QUEUE_MAX; i++) {
> > __virtio_queue_reset(vdev, i);
> > }
> >+
> >+ /* Mappings are removed to prevent stale fds from remaining open. */
> >+ QSIMPLEQ_FOREACH(shmem, &vdev->shmem_list, entry) {
> >+ while (!QTAILQ_EMPTY(&shmem->mmaps)) {
> >+ VirtioSharedMemoryMapping *mapping = QTAILQ_FIRST(&shmem->mmaps);
> >+ virtio_del_shmem_map(shmem, mapping->offset,
> >+ memory_region_size(mapping->mr));
> >+ }
> >+ }
> > }
> >
> > static void virtio_device_check_notification_compatibility(VirtIODevice *vdev,
> >@@ -3599,6 +3776,7 @@ void virtio_init(VirtIODevice *vdev, uint16_t
> >device_id, size_t config_size)
> > NULL, virtio_vmstate_change, vdev);
> > vdev->device_endian = virtio_default_endian();
> > vdev->use_guest_notifier_mask = true;
> >+ QSIMPLEQ_INIT(&vdev->shmem_list);
> > }
> >
> > /*
> >@@ -4110,11 +4288,25 @@ static void virtio_device_free_virtqueues(VirtIODevice *vdev)
> > static void virtio_device_instance_finalize(Object *obj)
> > {
> > VirtIODevice *vdev = VIRTIO_DEVICE(obj);
> >+ VirtioSharedMemory *shmem;
> >
> > virtio_device_free_virtqueues(vdev);
> >
> > g_free(vdev->config);
> > g_free(vdev->vector_queues);
> >+ while (!QSIMPLEQ_EMPTY(&vdev->shmem_list)) {
> >+ shmem = QSIMPLEQ_FIRST(&vdev->shmem_list);
> >+ while (!QTAILQ_EMPTY(&shmem->mmaps)) {
> >+ VirtioSharedMemoryMapping *mapping = QTAILQ_FIRST(&shmem->mmaps);
> >+ virtio_del_shmem_map(shmem, mapping->offset,
> >+ memory_region_size(mapping->mr));
> >+ }
> >+
> >+ /* Clean up the embedded MemoryRegion */
> >+ object_unparent(OBJECT(&shmem->mr));
> >+ QSIMPLEQ_REMOVE_HEAD(&vdev->shmem_list, entry);
> >+ g_free(shmem);
> >+ }
> > }
> >
> > static const Property virtio_properties[] = {
> >@@ -4480,9 +4672,18 @@ static const TypeInfo virtio_device_info = {
> > .class_size = sizeof(VirtioDeviceClass),
> > };
> >
> >+static const TypeInfo virtio_shared_memory_mapping_info = {
> >+ .name = TYPE_VIRTIO_SHARED_MEMORY_MAPPING,
> >+ .parent = TYPE_OBJECT,
> >+ .instance_size = sizeof(VirtioSharedMemoryMapping),
> >+ .instance_init = virtio_shared_memory_mapping_instance_init,
> >+ .instance_finalize = virtio_shared_memory_mapping_instance_finalize,
> >+};
> >+
> > static void virtio_register_types(void)
> > {
> > type_register_static(&virtio_device_info);
> >+ type_register_static(&virtio_shared_memory_mapping_info);
> > }
> >
> > type_init(virtio_register_types)
> >diff --git a/include/hw/virtio/virtio.h b/include/hw/virtio/virtio.h
> >index 27cd98d2fe..40d881ca09 100644
> >--- a/include/hw/virtio/virtio.h
> >+++ b/include/hw/virtio/virtio.h
> >@@ -99,6 +99,45 @@ enum virtio_device_endian {
> > VIRTIO_DEVICE_ENDIAN_BIG,
> > };
> >
> >+#define TYPE_VIRTIO_SHARED_MEMORY_MAPPING "virtio-shared-memory-mapping"
> >+OBJECT_DECLARE_SIMPLE_TYPE(VirtioSharedMemoryMapping, VIRTIO_SHARED_MEMORY_MAPPING)
> >+
> >+/**
> >+ * VirtioSharedMemoryMapping:
> >+ * @parent: Parent QOM object
> >+ * @shmid: VIRTIO Shared Memory Region ID
> >+ * @fd: File descriptor for the shared memory region
>
> `fd` is not there anymore.
True. Thanks!
>
> The rest LGTM. I think we can eventually fix them later, so don't want
> to block this, but if you need to resend, please fix them.
Since I will send a follow up to fix the feature ID, I will update
with your comments. Thanks for reviewing!
>
> Reviewed-by: Stefano Garzarella <sgarzare@redhat.com>
>
^ permalink raw reply [flat|nested] 21+ messages in thread
* Re: [PATCH v13 7/7] vhost-user-device: Add shared memory BAR
2026-03-04 13:26 ` Stefano Garzarella
@ 2026-03-04 14:10 ` Albert Esteve
0 siblings, 0 replies; 21+ messages in thread
From: Albert Esteve @ 2026-03-04 14:10 UTC (permalink / raw)
To: Stefano Garzarella
Cc: qemu-devel, Peter Xu, Pierrick Bouvier, mst, dbassey,
Philippe Mathieu-Daudé, Alex Bennée, Paolo Bonzini,
Fabiano Rosas, stefanha, manos.pitsidianakis, jasowang,
Laurent Vivier, slp, hi, stevensd
On Wed, Mar 4, 2026 at 2:26 PM Stefano Garzarella <sgarzare@redhat.com> wrote:
>
> On Thu, Feb 19, 2026 at 02:03:34PM +0100, Albert Esteve wrote:
> >Add shared memory BAR support to vhost-user-device-pci
> >to enable direct file mapping for VIRTIO Shared
> >Memory Regions.
> >
> >The implementation creates a consolidated shared
> >memory BAR that contains all VIRTIO Shared
> >Memory Regions as subregions. Each region is
> >configured with its proper shmid, size, and
> >offset within the BAR. The number and size of
> >regions are retrieved via VHOST_USER_GET_SHMEM_CONFIG
> >message sent by vhost-user-base during realization
> >after virtio_init().
> >
> >Specifiically, it uses BAR 3 to avoid conflicts, as
>
> nit: s/Specifiically/Specifically
>
> Discussed offline, this should be BAR 4 IIUC.
>
> >it is currently unused.
> >
> >The shared memory BAR is only created when the
> >backend supports VHOST_USER_PROTOCOL_F_SHMEM and
> >has configured shared memory regions. This maintains
> >backward compatibility with backends that do not
> >support shared memory functionality.
> >
> >Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
> >Signed-off-by: Albert Esteve <aesteve@redhat.com>
> >---
> > hw/virtio/vhost-user-base.c | 46 ++++++++++++++++++++++++--
> > hw/virtio/vhost-user-test-device-pci.c | 38 +++++++++++++++++++--
> > 2 files changed, 79 insertions(+), 5 deletions(-)
> >
> >diff --git a/hw/virtio/vhost-user-base.c b/hw/virtio/vhost-user-base.c
> >index 01ab9ca56b..e5e8abae96 100644
> >--- a/hw/virtio/vhost-user-base.c
> >+++ b/hw/virtio/vhost-user-base.c
> >@@ -16,6 +16,7 @@
> > #include "hw/virtio/virtio-bus.h"
> > #include "hw/virtio/vhost-user-base.h"
> > #include "qemu/error-report.h"
> >+#include "migration/blocker.h"
> >
> > static void vub_start(VirtIODevice *vdev)
> >{
> >@@ -276,7 +277,8 @@ static void vub_device_realize(DeviceState *dev, Error **errp)
> > {
> > VirtIODevice *vdev = VIRTIO_DEVICE(dev);
> > VHostUserBase *vub = VHOST_USER_BASE(dev);
> >- int ret;
> >+ uint64_t memory_sizes[VIRTIO_MAX_SHMEM_REGIONS];
> >+ int i, ret, nregions, regions_processed = 0;
> >
> > if (!vub->chardev.chr) {
> > error_setg(errp, "vhost-user-base: missing chardev");
> >@@ -319,7 +321,7 @@ static void vub_device_realize(DeviceState *dev, Error **errp)
> >
> > /* Allocate queues */
> > vub->vqs = g_ptr_array_sized_new(vub->num_vqs);
> >- for (int i = 0; i < vub->num_vqs; i++) {
> >+ for (i = 0; i < vub->num_vqs; i++) {
> > g_ptr_array_add(vub->vqs,
> > virtio_add_queue(vdev, vub->vq_size,
> > vub_handle_output));
> >@@ -333,11 +335,49 @@ static void vub_device_realize(DeviceState *dev, Error **errp)
> > VHOST_BACKEND_TYPE_USER, 0, errp);
> >
> > if (ret < 0) {
> >- do_vhost_user_cleanup(vdev, vub);
> >+ goto err;
> >+ }
> >+
> >+ ret = vub->vhost_dev.vhost_ops->vhost_get_shmem_config(&vub->vhost_dev,
> >+ &nregions,
> >+ memory_sizes,
> >+ errp);
> >+
> >+ if (ret < 0) {
> >+ goto err;
> >+ }
> >+
> >+ for (i = 0; i < VIRTIO_MAX_SHMEM_REGIONS && regions_processed < nregions; i++) {
> >+ if (memory_sizes[i]) {
> >+ regions_processed++;
> >+ if (vub->vhost_dev.migration_blocker == NULL) {
> >+ error_setg(&vub->vhost_dev.migration_blocker,
> >+ "Migration disabled: devices with VIRTIO Shared Memory "
> >+ "Regions do not support migration yet.");
> >+ ret = migrate_add_blocker_normal(
> >+ &vub->vhost_dev.migration_blocker,
> >+ errp);
> >+
> >+ if (ret < 0) {
> >+ goto err;
> >+ }
> >+ }
> >+
> >+ if (memory_sizes[i] % qemu_real_host_page_size() != 0) {
> >+ error_setg(errp, "Shared memory %d size must be a power of 2 "
> >+ "no smaller than the page size", i);
>
> Is this error message updated?
It is a bit misleading indeed. I will reword it, the size must be a
multiple of the host page size.
>
> >+ goto err;
> >+ }
> >+
> >+ virtio_new_shmem_region(vdev, i, memory_sizes[i]);
> >+ }
> > }
> >
> > qemu_chr_fe_set_handlers(&vub->chardev, NULL, NULL, vub_event, NULL,
> > dev, NULL, true);
> >+ return;
> >+err:
> >+ do_vhost_user_cleanup(vdev, vub);
> > }
> >
> > static void vub_device_unrealize(DeviceState *dev)
> >diff --git a/hw/virtio/vhost-user-test-device-pci.c b/hw/virtio/vhost-user-test-device-pci.c
> >index 7f6d751690..22678e3277 100644
> >--- a/hw/virtio/vhost-user-test-device-pci.c
> >+++ b/hw/virtio/vhost-user-test-device-pci.c
> >@@ -12,10 +12,13 @@
> > #include "hw/virtio/vhost-user-base.h"
> > #include "hw/virtio/virtio-pci.h"
> >
> >+#define VIRTIO_DEVICE_PCI_SHMEM_BAR 4
> >+
> > struct VHostUserDevicePCI {
> > VirtIOPCIProxy parent_obj;
> >
> > VHostUserBase vub;
> >+ MemoryRegion shmembar;
> > };
> >
> > #define TYPE_VHOST_USER_TEST_DEVICE_PCI "vhost-user-test-device-pci-base"
> >@@ -25,10 +28,41 @@ OBJECT_DECLARE_SIMPLE_TYPE(VHostUserDevicePCI, VHOST_USER_TEST_DEVICE_PCI)
> > static void vhost_user_device_pci_realize(VirtIOPCIProxy *vpci_dev, Error **errp)
> > {
> > VHostUserDevicePCI *dev = VHOST_USER_TEST_DEVICE_PCI(vpci_dev);
> >- DeviceState *vdev = DEVICE(&dev->vub);
> >+ DeviceState *dev_state = DEVICE(&dev->vub);
> >+ VirtIODevice *vdev = VIRTIO_DEVICE(dev_state);
> >+ VirtioSharedMemory *shmem, *next;
> >+ uint64_t offset = 0, shmem_size = 0;
> >
>
> I'd add a comment here to explain this since it's not immediately clear
> IMHO.
>
> >+ vpci_dev->modern_mem_bar_idx = 2;
> > vpci_dev->nvectors = 1;
> >- qdev_realize(vdev, BUS(&vpci_dev->bus), errp);
> >+ qdev_realize(dev_state, BUS(&vpci_dev->bus), errp);
>
> IIUC before this patch qdev_realize() was the last step in this
> function, so we didn't check for any error, but now should we return
> earlier if it fails?
Agreed.
>
> >+
> >+ QSIMPLEQ_FOREACH_SAFE(shmem, &vdev->shmem_list, entry, next) {
>
> Is QSIMPLEQ_FOREACH_SAFE really needed here? IIUC we are not modifying
> the list, so can we use QSIMPLEQ_FOREACH ?
Agreed.
>
> >+ if (shmem->mr.size > UINT64_MAX - shmem_size) {
>
> Same here about using memory_region_size().
>
> >+ error_setg(errp, "Total shared memory required overflow");
> >+ return;
> >+ }
> >+ shmem_size = shmem_size + shmem->mr.size;
>
> Ditto about memory_region_size().
>
> >+ }
> >+ if (shmem_size) {
> >+ if (vpci_dev->flags & VIRTIO_PCI_FLAG_MODERN_PIO_NOTIFY) {
> >+ error_setg(errp, "modern-pio-notify is not supported due to PCI BAR layout limitations");
> >+ return;
> >+ }
> >+ memory_region_init(&dev->shmembar, OBJECT(vpci_dev),
> >+ "vhost-device-pci-shmembar", shmem_size);
> >+ QSIMPLEQ_FOREACH_SAFE(shmem, &vdev->shmem_list, entry, next) {
>
> Ditto about QSIMPLEQ_FOREACH_SAFE.
>
> BTW my comments can eventually be fixed with a followup, overall LGTM,
> but if you need to resend, maybe we can fix them now.
I'm already applying these, I will resend them shortly. Thanks!
>
> In any case:
>
> Reviewed-by: Stefano Garzarella <sgarzare@redhat.com>
>
>
> >+ memory_region_add_subregion(&dev->shmembar, offset, &shmem->mr);
> >+ virtio_pci_add_shm_cap(vpci_dev, VIRTIO_DEVICE_PCI_SHMEM_BAR,
> >+ offset, shmem->mr.size, shmem->shmid);
> >+ offset = offset + shmem->mr.size;
> >+ }
> >+ pci_register_bar(&vpci_dev->pci_dev, VIRTIO_DEVICE_PCI_SHMEM_BAR,
> >+ PCI_BASE_ADDRESS_SPACE_MEMORY |
> >+ PCI_BASE_ADDRESS_MEM_PREFETCH |
> >+ PCI_BASE_ADDRESS_MEM_TYPE_64,
> >+ &dev->shmembar);
> >+ }
> > }
> >
> > static void vhost_user_device_pci_class_init(ObjectClass *klass,
> >--
> >2.52.0
> >
>
^ permalink raw reply [flat|nested] 21+ messages in thread
end of thread, other threads:[~2026-03-04 14:11 UTC | newest]
Thread overview: 21+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-02-19 13:03 [PATCH v13 0/7] vhost-user: Add SHMEM_MAP/UNMAP requests Albert Esteve
2026-02-19 13:03 ` [PATCH v13 1/7] vhost-user: Add VirtIO Shared Memory map request Albert Esteve
2026-03-04 13:08 ` Stefano Garzarella
2026-03-04 13:31 ` Albert Esteve
2026-02-19 13:03 ` [PATCH v13 2/7] vhost_user.rst: Align VhostUserMsg excerpt members Albert Esteve
2026-03-04 13:10 ` Stefano Garzarella
2026-02-19 13:03 ` [PATCH v13 3/7] vhost_user.rst: Add SHMEM_MAP/_UNMAP to spec Albert Esteve
2026-02-21 13:54 ` Alyssa Ross
2026-03-04 9:46 ` Albert Esteve
2026-03-04 10:23 ` Albert Esteve
2026-03-04 13:11 ` Stefano Garzarella
2026-02-19 13:03 ` [PATCH v13 4/7] vhost_user: Add frontend get_shmem_config command Albert Esteve
2026-03-04 13:12 ` Stefano Garzarella
2026-02-19 13:03 ` [PATCH v13 5/7] vhost_user.rst: Add GET_SHMEM_CONFIG message Albert Esteve
2026-03-04 13:12 ` Stefano Garzarella
2026-02-19 13:03 ` [PATCH v13 6/7] qmp: add shmem feature map Albert Esteve
2026-03-04 13:13 ` Stefano Garzarella
2026-02-19 13:03 ` [PATCH v13 7/7] vhost-user-device: Add shared memory BAR Albert Esteve
2026-03-04 13:26 ` Stefano Garzarella
2026-03-04 14:10 ` Albert Esteve
2026-03-04 13:28 ` [PATCH v13 0/7] vhost-user: Add SHMEM_MAP/UNMAP requests Stefano Garzarella
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.