4 * Copyright Red Hat, Inc. 2010
7 * Michael S. Tsirkin <mst@redhat.com>
9 * This work is licensed under the terms of the GNU GPL, version 2. See
10 * the COPYING file in the top-level directory.
13 #include <sys/ioctl.h>
17 #include <linux/vhost.h>
19 static void vhost_dev_sync_region(struct vhost_dev
*dev
,
20 uint64_t mfirst
, uint64_t mlast
,
21 uint64_t rfirst
, uint64_t rlast
)
23 uint64_t start
= MAX(mfirst
, rfirst
);
24 uint64_t end
= MIN(mlast
, rlast
);
25 vhost_log_chunk_t
*from
= dev
->log
+ start
/ VHOST_LOG_CHUNK
;
26 vhost_log_chunk_t
*to
= dev
->log
+ end
/ VHOST_LOG_CHUNK
+ 1;
27 uint64_t addr
= (start
/ VHOST_LOG_CHUNK
) * VHOST_LOG_CHUNK
;
29 assert(end
/ VHOST_LOG_CHUNK
< dev
->log_size
);
30 assert(start
/ VHOST_LOG_CHUNK
< dev
->log_size
);
34 for (;from
< to
; ++from
) {
35 vhost_log_chunk_t log
;
37 /* We first check with non-atomic: much cheaper,
38 * and we expect non-dirty to be the common case. */
40 addr
+= VHOST_LOG_CHUNK
;
43 /* Data must be read atomically. We don't really
44 * need the barrier semantics of __sync
45 * builtins, but it's easier to use them than
47 log
= __sync_fetch_and_and(from
, 0);
48 while ((bit
= sizeof(log
) > sizeof(int) ?
49 ffsll(log
) : ffs(log
))) {
52 ram_addr
= cpu_get_physical_page_desc(addr
+ bit
* VHOST_LOG_PAGE
);
53 cpu_physical_memory_set_dirty(ram_addr
);
54 log
&= ~(0x1ull
<< bit
);
56 addr
+= VHOST_LOG_CHUNK
;
60 static int vhost_client_sync_dirty_bitmap(CPUPhysMemoryClient
*client
,
61 target_phys_addr_t start_addr
,
62 target_phys_addr_t end_addr
)
64 struct vhost_dev
*dev
= container_of(client
, struct vhost_dev
, client
);
66 if (!dev
->log_enabled
|| !dev
->started
) {
69 for (i
= 0; i
< dev
->mem
->nregions
; ++i
) {
70 struct vhost_memory_region
*reg
= dev
->mem
->regions
+ i
;
71 vhost_dev_sync_region(dev
, start_addr
, end_addr
,
73 range_get_last(reg
->guest_phys_addr
,
76 for (i
= 0; i
< dev
->nvqs
; ++i
) {
77 struct vhost_virtqueue
*vq
= dev
->vqs
+ i
;
78 vhost_dev_sync_region(dev
, start_addr
, end_addr
, vq
->used_phys
,
79 range_get_last(vq
->used_phys
, vq
->used_size
));
84 /* Assign/unassign. Keep an unsorted array of non-overlapping
85 * memory regions in dev->mem. */
86 static void vhost_dev_unassign_memory(struct vhost_dev
*dev
,
90 int from
, to
, n
= dev
->mem
->nregions
;
91 /* Track overlapping/split regions for sanity checking. */
92 int overlap_start
= 0, overlap_end
= 0, overlap_middle
= 0, split
= 0;
94 for (from
= 0, to
= 0; from
< n
; ++from
, ++to
) {
95 struct vhost_memory_region
*reg
= dev
->mem
->regions
+ to
;
100 /* clone old region */
102 memcpy(reg
, dev
->mem
->regions
+ from
, sizeof *reg
);
105 /* No overlap is simple */
106 if (!ranges_overlap(reg
->guest_phys_addr
, reg
->memory_size
,
111 /* Split only happens if supplied region
112 * is in the middle of an existing one. Thus it can not
113 * overlap with any other existing region. */
116 reglast
= range_get_last(reg
->guest_phys_addr
, reg
->memory_size
);
117 memlast
= range_get_last(start_addr
, size
);
119 /* Remove whole region */
120 if (start_addr
<= reg
->guest_phys_addr
&& memlast
>= reglast
) {
121 --dev
->mem
->nregions
;
129 if (memlast
>= reglast
) {
130 reg
->memory_size
= start_addr
- reg
->guest_phys_addr
;
131 assert(reg
->memory_size
);
132 assert(!overlap_end
);
138 if (start_addr
<= reg
->guest_phys_addr
) {
139 change
= memlast
+ 1 - reg
->guest_phys_addr
;
140 reg
->memory_size
-= change
;
141 reg
->guest_phys_addr
+= change
;
142 reg
->userspace_addr
+= change
;
143 assert(reg
->memory_size
);
144 assert(!overlap_start
);
149 /* This only happens if supplied region
150 * is in the middle of an existing one. Thus it can not
151 * overlap with any other existing region. */
152 assert(!overlap_start
);
153 assert(!overlap_end
);
154 assert(!overlap_middle
);
155 /* Split region: shrink first part, shift second part. */
156 memcpy(dev
->mem
->regions
+ n
, reg
, sizeof *reg
);
157 reg
->memory_size
= start_addr
- reg
->guest_phys_addr
;
158 assert(reg
->memory_size
);
159 change
= memlast
+ 1 - reg
->guest_phys_addr
;
160 reg
= dev
->mem
->regions
+ n
;
161 reg
->memory_size
-= change
;
162 assert(reg
->memory_size
);
163 reg
->guest_phys_addr
+= change
;
164 reg
->userspace_addr
+= change
;
165 /* Never add more than 1 region */
166 assert(dev
->mem
->nregions
== n
);
167 ++dev
->mem
->nregions
;
172 /* Called after unassign, so no regions overlap the given range. */
173 static void vhost_dev_assign_memory(struct vhost_dev
*dev
,
179 struct vhost_memory_region
*merged
= NULL
;
180 for (from
= 0, to
= 0; from
< dev
->mem
->nregions
; ++from
, ++to
) {
181 struct vhost_memory_region
*reg
= dev
->mem
->regions
+ to
;
182 uint64_t prlast
, urlast
;
183 uint64_t pmlast
, umlast
;
186 /* clone old region */
188 memcpy(reg
, dev
->mem
->regions
+ from
, sizeof *reg
);
190 prlast
= range_get_last(reg
->guest_phys_addr
, reg
->memory_size
);
191 pmlast
= range_get_last(start_addr
, size
);
192 urlast
= range_get_last(reg
->userspace_addr
, reg
->memory_size
);
193 umlast
= range_get_last(uaddr
, size
);
195 /* check for overlapping regions: should never happen. */
196 assert(prlast
< start_addr
|| pmlast
< reg
->guest_phys_addr
);
197 /* Not an adjacent or overlapping region - do not merge. */
198 if ((prlast
+ 1 != start_addr
|| urlast
+ 1 != uaddr
) &&
199 (pmlast
+ 1 != reg
->guest_phys_addr
||
200 umlast
+ 1 != reg
->userspace_addr
)) {
210 u
= MIN(uaddr
, reg
->userspace_addr
);
211 s
= MIN(start_addr
, reg
->guest_phys_addr
);
212 e
= MAX(pmlast
, prlast
);
213 uaddr
= merged
->userspace_addr
= u
;
214 start_addr
= merged
->guest_phys_addr
= s
;
215 size
= merged
->memory_size
= e
- s
+ 1;
216 assert(merged
->memory_size
);
220 struct vhost_memory_region
*reg
= dev
->mem
->regions
+ to
;
221 memset(reg
, 0, sizeof *reg
);
222 reg
->memory_size
= size
;
223 assert(reg
->memory_size
);
224 reg
->guest_phys_addr
= start_addr
;
225 reg
->userspace_addr
= uaddr
;
228 assert(to
<= dev
->mem
->nregions
+ 1);
229 dev
->mem
->nregions
= to
;
232 static uint64_t vhost_get_log_size(struct vhost_dev
*dev
)
234 uint64_t log_size
= 0;
236 for (i
= 0; i
< dev
->mem
->nregions
; ++i
) {
237 struct vhost_memory_region
*reg
= dev
->mem
->regions
+ i
;
238 uint64_t last
= range_get_last(reg
->guest_phys_addr
,
240 log_size
= MAX(log_size
, last
/ VHOST_LOG_CHUNK
+ 1);
242 for (i
= 0; i
< dev
->nvqs
; ++i
) {
243 struct vhost_virtqueue
*vq
= dev
->vqs
+ i
;
244 uint64_t last
= vq
->used_phys
+ vq
->used_size
- 1;
245 log_size
= MAX(log_size
, last
/ VHOST_LOG_CHUNK
+ 1);
250 static inline void vhost_dev_log_resize(struct vhost_dev
* dev
, uint64_t size
)
252 vhost_log_chunk_t
*log
;
256 log
= qemu_mallocz(size
* sizeof *log
);
260 log_base
= (uint64_t)(unsigned long)log
;
261 r
= ioctl(dev
->control
, VHOST_SET_LOG_BASE
, &log_base
);
263 vhost_client_sync_dirty_bitmap(&dev
->client
, 0,
264 (target_phys_addr_t
)~0x0ull
);
269 dev
->log_size
= size
;
272 static int vhost_verify_ring_mappings(struct vhost_dev
*dev
,
277 for (i
= 0; i
< dev
->nvqs
; ++i
) {
278 struct vhost_virtqueue
*vq
= dev
->vqs
+ i
;
279 target_phys_addr_t l
;
282 if (!ranges_overlap(start_addr
, size
, vq
->ring_phys
, vq
->ring_size
)) {
286 p
= cpu_physical_memory_map(vq
->ring_phys
, &l
, 1);
287 if (!p
|| l
!= vq
->ring_size
) {
288 fprintf(stderr
, "Unable to map ring buffer for ring %d\n", i
);
292 fprintf(stderr
, "Ring buffer relocated for ring %d\n", i
);
295 cpu_physical_memory_unmap(p
, l
, 0, 0);
300 static void vhost_client_set_memory(CPUPhysMemoryClient
*client
,
301 target_phys_addr_t start_addr
,
303 ram_addr_t phys_offset
)
305 struct vhost_dev
*dev
= container_of(client
, struct vhost_dev
, client
);
306 ram_addr_t flags
= phys_offset
& ~TARGET_PAGE_MASK
;
307 int s
= offsetof(struct vhost_memory
, regions
) +
308 (dev
->mem
->nregions
+ 1) * sizeof dev
->mem
->regions
[0];
311 dev
->mem
= qemu_realloc(dev
->mem
, s
);
315 vhost_dev_unassign_memory(dev
, start_addr
, size
);
316 if (flags
== IO_MEM_RAM
) {
317 /* Add given mapping, merging adjacent regions if any */
318 vhost_dev_assign_memory(dev
, start_addr
, size
,
319 (uintptr_t)qemu_get_ram_ptr(phys_offset
));
321 /* Remove old mapping for this memory, if any. */
322 vhost_dev_unassign_memory(dev
, start_addr
, size
);
330 r
= vhost_verify_ring_mappings(dev
, start_addr
, size
);
334 if (!dev
->log_enabled
) {
335 r
= ioctl(dev
->control
, VHOST_SET_MEM_TABLE
, dev
->mem
);
339 log_size
= vhost_get_log_size(dev
);
340 /* We allocate an extra 4K bytes to log,
341 * to reduce the * number of reallocations. */
342 #define VHOST_LOG_BUFFER (0x1000 / sizeof *dev->log)
343 /* To log more, must increase log size before table update. */
344 if (dev
->log_size
< log_size
) {
345 vhost_dev_log_resize(dev
, log_size
+ VHOST_LOG_BUFFER
);
347 r
= ioctl(dev
->control
, VHOST_SET_MEM_TABLE
, dev
->mem
);
349 /* To log less, can only decrease log size after table update. */
350 if (dev
->log_size
> log_size
+ VHOST_LOG_BUFFER
) {
351 vhost_dev_log_resize(dev
, log_size
);
355 static int vhost_virtqueue_set_addr(struct vhost_dev
*dev
,
356 struct vhost_virtqueue
*vq
,
357 unsigned idx
, bool enable_log
)
359 struct vhost_vring_addr addr
= {
361 .desc_user_addr
= (uint64_t)(unsigned long)vq
->desc
,
362 .avail_user_addr
= (uint64_t)(unsigned long)vq
->avail
,
363 .used_user_addr
= (uint64_t)(unsigned long)vq
->used
,
364 .log_guest_addr
= vq
->used_phys
,
365 .flags
= enable_log
? (1 << VHOST_VRING_F_LOG
) : 0,
367 int r
= ioctl(dev
->control
, VHOST_SET_VRING_ADDR
, &addr
);
374 static int vhost_dev_set_features(struct vhost_dev
*dev
, bool enable_log
)
376 uint64_t features
= dev
->acked_features
;
379 features
|= 0x1 << VHOST_F_LOG_ALL
;
381 r
= ioctl(dev
->control
, VHOST_SET_FEATURES
, &features
);
382 return r
< 0 ? -errno
: 0;
385 static int vhost_dev_set_log(struct vhost_dev
*dev
, bool enable_log
)
388 r
= vhost_dev_set_features(dev
, enable_log
);
392 for (i
= 0; i
< dev
->nvqs
; ++i
) {
393 r
= vhost_virtqueue_set_addr(dev
, dev
->vqs
+ i
, i
,
401 for (; i
>= 0; --i
) {
402 t
= vhost_virtqueue_set_addr(dev
, dev
->vqs
+ i
, i
,
406 t
= vhost_dev_set_features(dev
, dev
->log_enabled
);
412 static int vhost_client_migration_log(CPUPhysMemoryClient
*client
,
415 struct vhost_dev
*dev
= container_of(client
, struct vhost_dev
, client
);
417 if (!!enable
== dev
->log_enabled
) {
421 dev
->log_enabled
= enable
;
425 r
= vhost_dev_set_log(dev
, false);
435 vhost_dev_log_resize(dev
, vhost_get_log_size(dev
));
436 r
= vhost_dev_set_log(dev
, true);
441 dev
->log_enabled
= enable
;
445 static int vhost_virtqueue_init(struct vhost_dev
*dev
,
446 struct VirtIODevice
*vdev
,
447 struct vhost_virtqueue
*vq
,
450 target_phys_addr_t s
, l
, a
;
452 struct vhost_vring_file file
= {
455 struct vhost_vring_state state
= {
458 struct VirtQueue
*vvq
= virtio_get_queue(vdev
, idx
);
460 if (!vdev
->binding
->set_host_notifier
) {
461 fprintf(stderr
, "binding does not support host notifiers\n");
465 vq
->num
= state
.num
= virtio_queue_get_num(vdev
, idx
);
466 r
= ioctl(dev
->control
, VHOST_SET_VRING_NUM
, &state
);
471 state
.num
= virtio_queue_get_last_avail_idx(vdev
, idx
);
472 r
= ioctl(dev
->control
, VHOST_SET_VRING_BASE
, &state
);
477 s
= l
= virtio_queue_get_desc_size(vdev
, idx
);
478 a
= virtio_queue_get_desc_addr(vdev
, idx
);
479 vq
->desc
= cpu_physical_memory_map(a
, &l
, 0);
480 if (!vq
->desc
|| l
!= s
) {
482 goto fail_alloc_desc
;
484 s
= l
= virtio_queue_get_avail_size(vdev
, idx
);
485 a
= virtio_queue_get_avail_addr(vdev
, idx
);
486 vq
->avail
= cpu_physical_memory_map(a
, &l
, 0);
487 if (!vq
->avail
|| l
!= s
) {
489 goto fail_alloc_avail
;
491 vq
->used_size
= s
= l
= virtio_queue_get_used_size(vdev
, idx
);
492 vq
->used_phys
= a
= virtio_queue_get_used_addr(vdev
, idx
);
493 vq
->used
= cpu_physical_memory_map(a
, &l
, 1);
494 if (!vq
->used
|| l
!= s
) {
496 goto fail_alloc_used
;
499 vq
->ring_size
= s
= l
= virtio_queue_get_ring_size(vdev
, idx
);
500 vq
->ring_phys
= a
= virtio_queue_get_ring_addr(vdev
, idx
);
501 vq
->ring
= cpu_physical_memory_map(a
, &l
, 1);
502 if (!vq
->ring
|| l
!= s
) {
504 goto fail_alloc_ring
;
507 r
= vhost_virtqueue_set_addr(dev
, vq
, idx
, dev
->log_enabled
);
512 r
= vdev
->binding
->set_host_notifier(vdev
->binding_opaque
, idx
, true);
514 fprintf(stderr
, "Error binding host notifier: %d\n", -r
);
515 goto fail_host_notifier
;
518 file
.fd
= event_notifier_get_fd(virtio_queue_get_host_notifier(vvq
));
519 r
= ioctl(dev
->control
, VHOST_SET_VRING_KICK
, &file
);
525 file
.fd
= event_notifier_get_fd(virtio_queue_get_guest_notifier(vvq
));
526 r
= ioctl(dev
->control
, VHOST_SET_VRING_CALL
, &file
);
536 vdev
->binding
->set_host_notifier(vdev
->binding_opaque
, idx
, false);
539 cpu_physical_memory_unmap(vq
->ring
, virtio_queue_get_ring_size(vdev
, idx
),
542 cpu_physical_memory_unmap(vq
->used
, virtio_queue_get_used_size(vdev
, idx
),
545 cpu_physical_memory_unmap(vq
->avail
, virtio_queue_get_avail_size(vdev
, idx
),
548 cpu_physical_memory_unmap(vq
->desc
, virtio_queue_get_desc_size(vdev
, idx
),
554 static void vhost_virtqueue_cleanup(struct vhost_dev
*dev
,
555 struct VirtIODevice
*vdev
,
556 struct vhost_virtqueue
*vq
,
559 struct vhost_vring_state state
= {
563 r
= vdev
->binding
->set_host_notifier(vdev
->binding_opaque
, idx
, false);
565 fprintf(stderr
, "vhost VQ %d host cleanup failed: %d\n", idx
, r
);
569 r
= ioctl(dev
->control
, VHOST_GET_VRING_BASE
, &state
);
571 fprintf(stderr
, "vhost VQ %d ring restore failed: %d\n", idx
, r
);
574 virtio_queue_set_last_avail_idx(vdev
, idx
, state
.num
);
576 cpu_physical_memory_unmap(vq
->ring
, virtio_queue_get_ring_size(vdev
, idx
),
577 0, virtio_queue_get_ring_size(vdev
, idx
));
578 cpu_physical_memory_unmap(vq
->used
, virtio_queue_get_used_size(vdev
, idx
),
579 1, virtio_queue_get_used_size(vdev
, idx
));
580 cpu_physical_memory_unmap(vq
->avail
, virtio_queue_get_avail_size(vdev
, idx
),
581 0, virtio_queue_get_avail_size(vdev
, idx
));
582 cpu_physical_memory_unmap(vq
->desc
, virtio_queue_get_desc_size(vdev
, idx
),
583 0, virtio_queue_get_desc_size(vdev
, idx
));
586 int vhost_dev_init(struct vhost_dev
*hdev
, int devfd
, bool force
)
591 hdev
->control
= devfd
;
593 hdev
->control
= open("/dev/vhost-net", O_RDWR
);
594 if (hdev
->control
< 0) {
598 r
= ioctl(hdev
->control
, VHOST_SET_OWNER
, NULL
);
603 r
= ioctl(hdev
->control
, VHOST_GET_FEATURES
, &features
);
607 hdev
->features
= features
;
609 hdev
->client
.set_memory
= vhost_client_set_memory
;
610 hdev
->client
.sync_dirty_bitmap
= vhost_client_sync_dirty_bitmap
;
611 hdev
->client
.migration_log
= vhost_client_migration_log
;
612 hdev
->client
.log_start
= NULL
;
613 hdev
->client
.log_stop
= NULL
;
614 hdev
->mem
= qemu_mallocz(offsetof(struct vhost_memory
, regions
));
617 hdev
->log_enabled
= false;
618 hdev
->started
= false;
619 cpu_register_phys_memory_client(&hdev
->client
);
624 close(hdev
->control
);
628 void vhost_dev_cleanup(struct vhost_dev
*hdev
)
630 cpu_unregister_phys_memory_client(&hdev
->client
);
631 qemu_free(hdev
->mem
);
632 close(hdev
->control
);
635 bool vhost_dev_query(struct vhost_dev
*hdev
, VirtIODevice
*vdev
)
637 return !vdev
->binding
->query_guest_notifiers
||
638 vdev
->binding
->query_guest_notifiers(vdev
->binding_opaque
) ||
642 int vhost_dev_start(struct vhost_dev
*hdev
, VirtIODevice
*vdev
)
645 if (!vdev
->binding
->set_guest_notifiers
) {
646 fprintf(stderr
, "binding does not support guest notifiers\n");
651 r
= vdev
->binding
->set_guest_notifiers(vdev
->binding_opaque
, true);
653 fprintf(stderr
, "Error binding guest notifier: %d\n", -r
);
657 r
= vhost_dev_set_features(hdev
, hdev
->log_enabled
);
661 r
= ioctl(hdev
->control
, VHOST_SET_MEM_TABLE
, hdev
->mem
);
666 for (i
= 0; i
< hdev
->nvqs
; ++i
) {
667 r
= vhost_virtqueue_init(hdev
,
676 if (hdev
->log_enabled
) {
677 hdev
->log_size
= vhost_get_log_size(hdev
);
678 hdev
->log
= hdev
->log_size
?
679 qemu_mallocz(hdev
->log_size
* sizeof *hdev
->log
) : NULL
;
680 r
= ioctl(hdev
->control
, VHOST_SET_LOG_BASE
,
681 (uint64_t)(unsigned long)hdev
->log
);
688 hdev
->started
= true;
694 vhost_virtqueue_cleanup(hdev
,
701 vdev
->binding
->set_guest_notifiers(vdev
->binding_opaque
, false);
707 void vhost_dev_stop(struct vhost_dev
*hdev
, VirtIODevice
*vdev
)
711 for (i
= 0; i
< hdev
->nvqs
; ++i
) {
712 vhost_virtqueue_cleanup(hdev
,
717 vhost_client_sync_dirty_bitmap(&hdev
->client
, 0,
718 (target_phys_addr_t
)~0x0ull
);
719 r
= vdev
->binding
->set_guest_notifiers(vdev
->binding_opaque
, false);
721 fprintf(stderr
, "vhost guest notifier cleanup failed: %d\n", r
);
726 hdev
->started
= false;
727 qemu_free(hdev
->log
);