2 * virtio-fs glue for FUSE
3 * Copyright (C) 2018 Red Hat, Inc. and/or its affiliates
6 * Dave Gilbert <dgilbert@redhat.com>
8 * Implements the glue between libfuse and libvhost-user
10 * This program can be distributed under the terms of the GNU LGPLv2.
11 * See the file COPYING.LIB
14 #include "qemu/osdep.h"
16 #include "qapi/error.h"
18 #include "standard-headers/linux/fuse.h"
19 #include "fuse_misc.h"
21 #include "fuse_virtio.h"
23 #include <sys/eventfd.h>
24 #include <sys/socket.h>
28 #include "libvhost-user.h"
34 * This lock protects the VuVirtq preventing races between
35 * fv_queue_thread() and fv_queue_worker().
37 pthread_mutex_t vq_lock
;
39 struct fv_VuDev
*virtio_dev
;
41 /* Our queue index, corresponds to array position */
44 int kill_fd
; /* For killing the thread */
52 /* Used to complete requests that involve no reply */
57 * We pass the dev element into libvhost-user
58 * and then use it to get back to the outer
59 * container for other data.
63 struct fuse_session
*se
;
66 * Either handle virtqueues or vhost-user protocol messages. Don't do
67 * both at the same time since that could lead to race conditions if
68 * virtqueues or memory tables change while another thread is accessing
71 * The assumptions are:
72 * 1. fv_queue_thread() reads/writes to virtqueues and only reads VuDev.
73 * 2. virtio_loop() reads/writes virtqueues and VuDev.
75 pthread_rwlock_t vu_dispatch_rwlock
;
78 * The following pair of fields are only accessed in the main
82 struct fv_QueueInfo
**qi
;
86 struct virtio_fs_config
{
91 /* Callback from libvhost-user */
92 static uint64_t fv_get_features(VuDev
*dev
)
94 return 1ULL << VIRTIO_F_VERSION_1
;
97 /* Callback from libvhost-user */
98 static void fv_set_features(VuDev
*dev
, uint64_t features
)
103 * Callback from libvhost-user if there's a new fd we're supposed to listen
104 * to, typically a queue kick?
106 static void fv_set_watch(VuDev
*dev
, int fd
, int condition
, vu_watch_cb cb
,
109 fuse_log(FUSE_LOG_WARNING
, "%s: TODO! fd=%d\n", __func__
, fd
);
113 * Callback from libvhost-user if we're no longer supposed to listen on an fd
115 static void fv_remove_watch(VuDev
*dev
, int fd
)
117 fuse_log(FUSE_LOG_WARNING
, "%s: TODO! fd=%d\n", __func__
, fd
);
120 /* Callback from libvhost-user to panic */
121 static void fv_panic(VuDev
*dev
, const char *err
)
123 fuse_log(FUSE_LOG_ERR
, "%s: libvhost-user: %s\n", __func__
, err
);
124 /* TODO: Allow reconnects?? */
129 * Copy from an iovec into a fuse_buf (memory only)
130 * Caller must ensure there is space
132 static void copy_from_iov(struct fuse_buf
*buf
, size_t out_num
,
133 const struct iovec
*out_sg
)
135 void *dest
= buf
->mem
;
138 size_t onelen
= out_sg
->iov_len
;
139 memcpy(dest
, out_sg
->iov_base
, onelen
);
147 * Copy from one iov to another, the given number of bytes
148 * The caller must have checked sizes.
150 static void copy_iov(struct iovec
*src_iov
, int src_count
,
151 struct iovec
*dst_iov
, int dst_count
, size_t to_copy
)
153 size_t dst_offset
= 0;
154 /* Outer loop copies 'src' elements */
157 size_t src_len
= src_iov
[0].iov_len
;
158 size_t src_offset
= 0;
160 if (src_len
> to_copy
) {
163 /* Inner loop copies contents of one 'src' to maybe multiple dst. */
166 size_t dst_len
= dst_iov
[0].iov_len
- dst_offset
;
167 if (dst_len
> src_len
) {
171 memcpy(dst_iov
[0].iov_base
+ dst_offset
,
172 src_iov
[0].iov_base
+ src_offset
, dst_len
);
175 src_offset
+= dst_len
;
176 dst_offset
+= dst_len
;
178 assert(dst_offset
<= dst_iov
[0].iov_len
);
179 if (dst_offset
== dst_iov
[0].iov_len
) {
191 * Called back by ll whenever it wants to send a reply/message back
192 * The 1st element of the iov starts with the fuse_out_header
193 * 'unique'==0 means it's a notify message.
195 int virtio_send_msg(struct fuse_session
*se
, struct fuse_chan
*ch
,
196 struct iovec
*iov
, int count
)
198 FVRequest
*req
= container_of(ch
, FVRequest
, ch
);
199 struct fv_QueueInfo
*qi
= ch
->qi
;
200 VuDev
*dev
= &se
->virtio_dev
->dev
;
201 VuVirtq
*q
= vu_get_queue(dev
, qi
->qidx
);
202 VuVirtqElement
*elem
= &req
->elem
;
206 assert(iov
[0].iov_len
>= sizeof(struct fuse_out_header
));
208 struct fuse_out_header
*out
= iov
[0].iov_base
;
209 /* TODO: Endianness! */
211 size_t tosend_len
= iov_size(iov
, count
);
213 /* unique == 0 is notification, which we don't support */
215 assert(!req
->reply_sent
);
217 /* The 'in' part of the elem is to qemu */
218 unsigned int in_num
= elem
->in_num
;
219 struct iovec
*in_sg
= elem
->in_sg
;
220 size_t in_len
= iov_size(in_sg
, in_num
);
221 fuse_log(FUSE_LOG_DEBUG
, "%s: elem %d: with %d in desc of length %zd\n",
222 __func__
, elem
->index
, in_num
, in_len
);
225 * The elem should have room for a 'fuse_out_header' (out from fuse)
226 * plus the data based on the len in the header.
228 if (in_len
< sizeof(struct fuse_out_header
)) {
229 fuse_log(FUSE_LOG_ERR
, "%s: elem %d too short for out_header\n",
230 __func__
, elem
->index
);
234 if (in_len
< tosend_len
) {
235 fuse_log(FUSE_LOG_ERR
, "%s: elem %d too small for data len %zd\n",
236 __func__
, elem
->index
, tosend_len
);
241 copy_iov(iov
, count
, in_sg
, in_num
, tosend_len
);
243 pthread_rwlock_rdlock(&qi
->virtio_dev
->vu_dispatch_rwlock
);
244 pthread_mutex_lock(&qi
->vq_lock
);
245 vu_queue_push(dev
, q
, elem
, tosend_len
);
246 vu_queue_notify(dev
, q
);
247 pthread_mutex_unlock(&qi
->vq_lock
);
248 pthread_rwlock_unlock(&qi
->virtio_dev
->vu_dispatch_rwlock
);
250 req
->reply_sent
= true;
257 * Callback from fuse_send_data_iov_* when it's virtio and the buffer
258 * is a single FD with FUSE_BUF_IS_FD | FUSE_BUF_FD_SEEK
259 * We need send the iov and then the buffer.
260 * Return 0 on success
262 int virtio_send_data_iov(struct fuse_session
*se
, struct fuse_chan
*ch
,
263 struct iovec
*iov
, int count
, struct fuse_bufvec
*buf
,
266 FVRequest
*req
= container_of(ch
, FVRequest
, ch
);
267 struct fv_QueueInfo
*qi
= ch
->qi
;
268 VuDev
*dev
= &se
->virtio_dev
->dev
;
269 VuVirtq
*q
= vu_get_queue(dev
, qi
->qidx
);
270 VuVirtqElement
*elem
= &req
->elem
;
274 assert(iov
[0].iov_len
>= sizeof(struct fuse_out_header
));
276 struct fuse_out_header
*out
= iov
[0].iov_base
;
277 /* TODO: Endianness! */
279 size_t iov_len
= iov_size(iov
, count
);
280 size_t tosend_len
= iov_len
+ len
;
282 out
->len
= tosend_len
;
284 fuse_log(FUSE_LOG_DEBUG
, "%s: count=%d len=%zd iov_len=%zd\n", __func__
,
285 count
, len
, iov_len
);
287 /* unique == 0 is notification which we don't support */
290 assert(!req
->reply_sent
);
292 /* The 'in' part of the elem is to qemu */
293 unsigned int in_num
= elem
->in_num
;
294 struct iovec
*in_sg
= elem
->in_sg
;
295 size_t in_len
= iov_size(in_sg
, in_num
);
296 fuse_log(FUSE_LOG_DEBUG
, "%s: elem %d: with %d in desc of length %zd\n",
297 __func__
, elem
->index
, in_num
, in_len
);
300 * The elem should have room for a 'fuse_out_header' (out from fuse)
301 * plus the data based on the len in the header.
303 if (in_len
< sizeof(struct fuse_out_header
)) {
304 fuse_log(FUSE_LOG_ERR
, "%s: elem %d too short for out_header\n",
305 __func__
, elem
->index
);
309 if (in_len
< tosend_len
) {
310 fuse_log(FUSE_LOG_ERR
, "%s: elem %d too small for data len %zd\n",
311 __func__
, elem
->index
, tosend_len
);
316 /* TODO: Limit to 'len' */
318 /* First copy the header data from iov->in_sg */
319 copy_iov(iov
, count
, in_sg
, in_num
, iov_len
);
322 * Build a copy of the the in_sg iov so we can skip bits in it,
323 * including changing the offsets
325 struct iovec
*in_sg_cpy
= calloc(sizeof(struct iovec
), in_num
);
327 memcpy(in_sg_cpy
, in_sg
, sizeof(struct iovec
) * in_num
);
328 /* These get updated as we skip */
329 struct iovec
*in_sg_ptr
= in_sg_cpy
;
330 int in_sg_cpy_count
= in_num
;
332 /* skip over parts of in_sg that contained the header iov */
333 size_t skip_size
= iov_len
;
335 size_t in_sg_left
= 0;
337 while (skip_size
!= 0 && in_sg_cpy_count
) {
338 if (skip_size
>= in_sg_ptr
[0].iov_len
) {
339 skip_size
-= in_sg_ptr
[0].iov_len
;
343 in_sg_ptr
[0].iov_len
-= skip_size
;
344 in_sg_ptr
[0].iov_base
+= skip_size
;
350 for (i
= 0, in_sg_left
= 0; i
< in_sg_cpy_count
; i
++) {
351 in_sg_left
+= in_sg_ptr
[i
].iov_len
;
353 fuse_log(FUSE_LOG_DEBUG
,
354 "%s: after skip skip_size=%zd in_sg_cpy_count=%d "
356 __func__
, skip_size
, in_sg_cpy_count
, in_sg_left
);
357 ret
= preadv(buf
->buf
[0].fd
, in_sg_ptr
, in_sg_cpy_count
,
362 fuse_log(FUSE_LOG_DEBUG
, "%s: preadv failed (%m) len=%zd\n",
367 fuse_log(FUSE_LOG_DEBUG
, "%s: preadv ret=%d len=%zd\n", __func__
,
369 if (ret
< len
&& ret
) {
370 fuse_log(FUSE_LOG_DEBUG
, "%s: ret < len\n", __func__
);
371 /* Skip over this much next time around */
373 buf
->buf
[0].pos
+= ret
;
376 /* Lets do another read */
381 fuse_log(FUSE_LOG_DEBUG
, "%s: !ret in_sg_left=%zd\n", __func__
,
386 fuse_log(FUSE_LOG_DEBUG
, "%s: ret!=len\n", __func__
);
393 } while (in_sg_left
);
396 /* Need to fix out->len on EOF */
398 struct fuse_out_header
*out_sg
= in_sg
[0].iov_base
;
401 out_sg
->len
= tosend_len
;
406 pthread_rwlock_rdlock(&qi
->virtio_dev
->vu_dispatch_rwlock
);
407 pthread_mutex_lock(&qi
->vq_lock
);
408 vu_queue_push(dev
, q
, elem
, tosend_len
);
409 vu_queue_notify(dev
, q
);
410 pthread_mutex_unlock(&qi
->vq_lock
);
411 pthread_rwlock_unlock(&qi
->virtio_dev
->vu_dispatch_rwlock
);
415 req
->reply_sent
= true;
421 static __thread
bool clone_fs_called
;
423 /* Process one FVRequest in a thread pool */
424 static void fv_queue_worker(gpointer data
, gpointer user_data
)
426 struct fv_QueueInfo
*qi
= user_data
;
427 struct fuse_session
*se
= qi
->virtio_dev
->se
;
428 struct VuDev
*dev
= &qi
->virtio_dev
->dev
;
429 FVRequest
*req
= data
;
430 VuVirtqElement
*elem
= &req
->elem
;
431 struct fuse_buf fbuf
= {};
432 bool allocated_bufv
= false;
433 struct fuse_bufvec bufv
;
434 struct fuse_bufvec
*pbufv
;
436 assert(se
->bufsize
> sizeof(struct fuse_in_header
));
438 if (!clone_fs_called
) {
441 /* unshare FS for xattr operation */
442 ret
= unshare(CLONE_FS
);
443 /* should not fail */
446 clone_fs_called
= true;
450 * An element contains one request and the space to send our response
451 * They're spread over multiple descriptors in a scatter/gather set
452 * and we can't trust the guest to keep them still; so copy in/out.
454 fbuf
.mem
= malloc(se
->bufsize
);
457 fuse_mutex_init(&req
->ch
.lock
);
461 /* The 'out' part of the elem is from qemu */
462 unsigned int out_num
= elem
->out_num
;
463 struct iovec
*out_sg
= elem
->out_sg
;
464 size_t out_len
= iov_size(out_sg
, out_num
);
465 fuse_log(FUSE_LOG_DEBUG
,
466 "%s: elem %d: with %d out desc of length %zd\n",
467 __func__
, elem
->index
, out_num
, out_len
);
470 * The elem should contain a 'fuse_in_header' (in to fuse)
471 * plus the data based on the len in the header.
473 if (out_len
< sizeof(struct fuse_in_header
)) {
474 fuse_log(FUSE_LOG_ERR
, "%s: elem %d too short for in_header\n",
475 __func__
, elem
->index
);
476 assert(0); /* TODO */
478 if (out_len
> se
->bufsize
) {
479 fuse_log(FUSE_LOG_ERR
, "%s: elem %d too large for buffer\n", __func__
,
481 assert(0); /* TODO */
483 /* Copy just the first element and look at it */
484 copy_from_iov(&fbuf
, 1, out_sg
);
486 pbufv
= NULL
; /* Compiler thinks an unitialised path */
488 out_sg
[0].iov_len
== sizeof(struct fuse_in_header
) &&
489 ((struct fuse_in_header
*)fbuf
.mem
)->opcode
== FUSE_WRITE
&&
490 out_sg
[1].iov_len
== sizeof(struct fuse_write_in
)) {
492 * For a write we don't actually need to copy the
493 * data, we can just do it straight out of guest memory
494 * but we must still copy the headers in case the guest
495 * was nasty and changed them while we were using them.
497 fuse_log(FUSE_LOG_DEBUG
, "%s: Write special case\n", __func__
);
499 /* copy the fuse_write_in header afte rthe fuse_in_header */
500 fbuf
.mem
+= out_sg
->iov_len
;
501 copy_from_iov(&fbuf
, 1, out_sg
+ 1);
502 fbuf
.mem
-= out_sg
->iov_len
;
503 fbuf
.size
= out_sg
[0].iov_len
+ out_sg
[1].iov_len
;
505 /* Allocate the bufv, with space for the rest of the iov */
506 pbufv
= malloc(sizeof(struct fuse_bufvec
) +
507 sizeof(struct fuse_buf
) * (out_num
- 2));
509 fuse_log(FUSE_LOG_ERR
, "%s: pbufv malloc failed\n",
514 allocated_bufv
= true;
516 pbufv
->buf
[0] = fbuf
;
518 size_t iovindex
, pbufvindex
;
519 iovindex
= 2; /* 2 headers, separate iovs */
520 pbufvindex
= 1; /* 2 headers, 1 fusebuf */
522 for (; iovindex
< out_num
; iovindex
++, pbufvindex
++) {
524 pbufv
->buf
[pbufvindex
].pos
= ~0; /* Dummy */
525 pbufv
->buf
[pbufvindex
].flags
= 0;
526 pbufv
->buf
[pbufvindex
].mem
= out_sg
[iovindex
].iov_base
;
527 pbufv
->buf
[pbufvindex
].size
= out_sg
[iovindex
].iov_len
;
530 /* Normal (non fast write) path */
532 /* Copy the rest of the buffer */
533 fbuf
.mem
+= out_sg
->iov_len
;
534 copy_from_iov(&fbuf
, out_num
- 1, out_sg
+ 1);
535 fbuf
.mem
-= out_sg
->iov_len
;
538 /* TODO! Endianness of header */
540 /* TODO: Add checks for fuse_session_exited */
547 fuse_session_process_buf_int(se
, pbufv
, &req
->ch
);
550 if (allocated_bufv
) {
554 /* If the request has no reply, still recycle the virtqueue element */
555 if (!req
->reply_sent
) {
556 struct VuVirtq
*q
= vu_get_queue(dev
, qi
->qidx
);
558 fuse_log(FUSE_LOG_DEBUG
, "%s: elem %d no reply sent\n", __func__
,
561 pthread_rwlock_rdlock(&qi
->virtio_dev
->vu_dispatch_rwlock
);
562 pthread_mutex_lock(&qi
->vq_lock
);
563 vu_queue_push(dev
, q
, elem
, 0);
564 vu_queue_notify(dev
, q
);
565 pthread_mutex_unlock(&qi
->vq_lock
);
566 pthread_rwlock_unlock(&qi
->virtio_dev
->vu_dispatch_rwlock
);
569 pthread_mutex_destroy(&req
->ch
.lock
);
574 /* Thread function for individual queues, created when a queue is 'started' */
575 static void *fv_queue_thread(void *opaque
)
577 struct fv_QueueInfo
*qi
= opaque
;
578 struct VuDev
*dev
= &qi
->virtio_dev
->dev
;
579 struct VuVirtq
*q
= vu_get_queue(dev
, qi
->qidx
);
580 struct fuse_session
*se
= qi
->virtio_dev
->se
;
583 pool
= g_thread_pool_new(fv_queue_worker
, qi
, se
->thread_pool_size
, FALSE
,
586 fuse_log(FUSE_LOG_ERR
, "%s: g_thread_pool_new failed\n", __func__
);
590 fuse_log(FUSE_LOG_INFO
, "%s: Start for queue %d kick_fd %d\n", __func__
,
591 qi
->qidx
, qi
->kick_fd
);
596 pf
[0].fd
= qi
->kick_fd
;
597 pf
[0].events
= POLLIN
;
599 pf
[1].fd
= qi
->kill_fd
;
600 pf
[1].events
= POLLIN
;
603 fuse_log(FUSE_LOG_DEBUG
, "%s: Waiting for Queue %d event\n", __func__
,
605 int poll_res
= ppoll(pf
, 2, NULL
, NULL
);
607 if (poll_res
== -1) {
608 if (errno
== EINTR
) {
609 fuse_log(FUSE_LOG_INFO
, "%s: ppoll interrupted, going around\n",
613 fuse_log(FUSE_LOG_ERR
, "fv_queue_thread ppoll: %m\n");
616 assert(poll_res
>= 1);
617 if (pf
[0].revents
& (POLLERR
| POLLHUP
| POLLNVAL
)) {
618 fuse_log(FUSE_LOG_ERR
, "%s: Unexpected poll revents %x Queue %d\n",
619 __func__
, pf
[0].revents
, qi
->qidx
);
622 if (pf
[1].revents
& (POLLERR
| POLLHUP
| POLLNVAL
)) {
623 fuse_log(FUSE_LOG_ERR
,
624 "%s: Unexpected poll revents %x Queue %d killfd\n",
625 __func__
, pf
[1].revents
, qi
->qidx
);
629 fuse_log(FUSE_LOG_INFO
, "%s: kill event on queue %d - quitting\n",
633 assert(pf
[0].revents
& POLLIN
);
634 fuse_log(FUSE_LOG_DEBUG
, "%s: Got queue event on Queue %d\n", __func__
,
638 if (eventfd_read(qi
->kick_fd
, &evalue
)) {
639 fuse_log(FUSE_LOG_ERR
, "Eventfd_read for queue: %m\n");
642 /* Mutual exclusion with virtio_loop() */
643 ret
= pthread_rwlock_rdlock(&qi
->virtio_dev
->vu_dispatch_rwlock
);
644 assert(ret
== 0); /* there is no possible error case */
645 pthread_mutex_lock(&qi
->vq_lock
);
646 /* out is from guest, in is too guest */
647 unsigned int in_bytes
, out_bytes
;
648 vu_queue_get_avail_bytes(dev
, q
, &in_bytes
, &out_bytes
, ~0, ~0);
650 fuse_log(FUSE_LOG_DEBUG
,
651 "%s: Queue %d gave evalue: %zx available: in: %u out: %u\n",
652 __func__
, qi
->qidx
, (size_t)evalue
, in_bytes
, out_bytes
);
655 FVRequest
*req
= vu_queue_pop(dev
, q
, sizeof(FVRequest
));
660 req
->reply_sent
= false;
662 g_thread_pool_push(pool
, req
, NULL
);
665 pthread_mutex_unlock(&qi
->vq_lock
);
666 pthread_rwlock_unlock(&qi
->virtio_dev
->vu_dispatch_rwlock
);
669 g_thread_pool_free(pool
, FALSE
, TRUE
);
674 static void fv_queue_cleanup_thread(struct fv_VuDev
*vud
, int qidx
)
677 struct fv_QueueInfo
*ourqi
;
679 assert(qidx
< vud
->nqueues
);
680 ourqi
= vud
->qi
[qidx
];
682 /* Kill the thread */
683 if (eventfd_write(ourqi
->kill_fd
, 1)) {
684 fuse_log(FUSE_LOG_ERR
, "Eventfd_write for queue %d: %s\n",
685 qidx
, strerror(errno
));
687 ret
= pthread_join(ourqi
->thread
, NULL
);
689 fuse_log(FUSE_LOG_ERR
, "%s: Failed to join thread idx %d err %d\n",
690 __func__
, qidx
, ret
);
692 pthread_mutex_destroy(&ourqi
->vq_lock
);
693 close(ourqi
->kill_fd
);
696 vud
->qi
[qidx
] = NULL
;
699 /* Callback from libvhost-user on start or stop of a queue */
700 static void fv_queue_set_started(VuDev
*dev
, int qidx
, bool started
)
702 struct fv_VuDev
*vud
= container_of(dev
, struct fv_VuDev
, dev
);
703 struct fv_QueueInfo
*ourqi
;
705 fuse_log(FUSE_LOG_INFO
, "%s: qidx=%d started=%d\n", __func__
, qidx
,
710 * Ignore additional request queues for now. passthrough_ll.c must be
711 * audited for thread-safety issues first. It was written with a
712 * well-behaved client in mind and may not protect against all types of
716 fuse_log(FUSE_LOG_ERR
,
717 "%s: multiple request queues not yet implemented, please only "
718 "configure 1 request queue\n",
724 /* Fire up a thread to watch this queue */
725 if (qidx
>= vud
->nqueues
) {
726 vud
->qi
= realloc(vud
->qi
, (qidx
+ 1) * sizeof(vud
->qi
[0]));
728 memset(vud
->qi
+ vud
->nqueues
, 0,
729 sizeof(vud
->qi
[0]) * (1 + (qidx
- vud
->nqueues
)));
730 vud
->nqueues
= qidx
+ 1;
732 if (!vud
->qi
[qidx
]) {
733 vud
->qi
[qidx
] = calloc(sizeof(struct fv_QueueInfo
), 1);
734 assert(vud
->qi
[qidx
]);
735 vud
->qi
[qidx
]->virtio_dev
= vud
;
736 vud
->qi
[qidx
]->qidx
= qidx
;
738 /* Shouldn't have been started */
739 assert(vud
->qi
[qidx
]->kick_fd
== -1);
741 ourqi
= vud
->qi
[qidx
];
742 ourqi
->kick_fd
= dev
->vq
[qidx
].kick_fd
;
744 ourqi
->kill_fd
= eventfd(0, EFD_CLOEXEC
| EFD_SEMAPHORE
);
745 assert(ourqi
->kill_fd
!= -1);
746 pthread_mutex_init(&ourqi
->vq_lock
, NULL
);
748 if (pthread_create(&ourqi
->thread
, NULL
, fv_queue_thread
, ourqi
)) {
749 fuse_log(FUSE_LOG_ERR
, "%s: Failed to create thread for queue %d\n",
754 fv_queue_cleanup_thread(vud
, qidx
);
758 static bool fv_queue_order(VuDev
*dev
, int qidx
)
763 static const VuDevIface fv_iface
= {
764 .get_features
= fv_get_features
,
765 .set_features
= fv_set_features
,
767 /* Don't need process message, we've not got any at vhost-user level */
768 .queue_set_started
= fv_queue_set_started
,
770 .queue_is_processed_in_order
= fv_queue_order
,
774 * Main loop; this mostly deals with events on the vhost-user
775 * socket itself, and not actual fuse data.
777 int virtio_loop(struct fuse_session
*se
)
779 fuse_log(FUSE_LOG_INFO
, "%s: Entry\n", __func__
);
781 while (!fuse_session_exited(se
)) {
785 pf
[0].fd
= se
->vu_socketfd
;
786 pf
[0].events
= POLLIN
;
789 fuse_log(FUSE_LOG_DEBUG
, "%s: Waiting for VU event\n", __func__
);
790 int poll_res
= ppoll(pf
, 1, NULL
, NULL
);
792 if (poll_res
== -1) {
793 if (errno
== EINTR
) {
794 fuse_log(FUSE_LOG_INFO
, "%s: ppoll interrupted, going around\n",
798 fuse_log(FUSE_LOG_ERR
, "virtio_loop ppoll: %m\n");
801 assert(poll_res
== 1);
802 if (pf
[0].revents
& (POLLERR
| POLLHUP
| POLLNVAL
)) {
803 fuse_log(FUSE_LOG_ERR
, "%s: Unexpected poll revents %x\n", __func__
,
807 assert(pf
[0].revents
& POLLIN
);
808 fuse_log(FUSE_LOG_DEBUG
, "%s: Got VU event\n", __func__
);
809 /* Mutual exclusion with fv_queue_thread() */
810 ret
= pthread_rwlock_wrlock(&se
->virtio_dev
->vu_dispatch_rwlock
);
811 assert(ret
== 0); /* there is no possible error case */
813 ok
= vu_dispatch(&se
->virtio_dev
->dev
);
815 pthread_rwlock_unlock(&se
->virtio_dev
->vu_dispatch_rwlock
);
818 fuse_log(FUSE_LOG_ERR
, "%s: vu_dispatch failed\n", __func__
);
824 * Make sure all fv_queue_thread()s quit on exit, as we're about to
825 * free virtio dev and fuse session, no one should access them anymore.
827 for (int i
= 0; i
< se
->virtio_dev
->nqueues
; i
++) {
828 if (!se
->virtio_dev
->qi
[i
]) {
832 fuse_log(FUSE_LOG_INFO
, "%s: Stopping queue %d thread\n", __func__
, i
);
833 fv_queue_cleanup_thread(se
->virtio_dev
, i
);
836 fuse_log(FUSE_LOG_INFO
, "%s: Exit\n", __func__
);
841 static void strreplace(char *s
, char old
, char new)
850 static bool fv_socket_lock(struct fuse_session
*se
)
852 g_autofree gchar
*sk_name
= NULL
;
853 g_autofree gchar
*pidfile
= NULL
;
854 g_autofree gchar
*dir
= NULL
;
855 Error
*local_err
= NULL
;
857 dir
= qemu_get_local_state_pathname("run/virtiofsd");
859 if (g_mkdir_with_parents(dir
, S_IRWXU
) < 0) {
860 fuse_log(FUSE_LOG_ERR
, "%s: Failed to create directory %s: %s",
861 __func__
, dir
, strerror(errno
));
865 sk_name
= g_strdup(se
->vu_socket_path
);
866 strreplace(sk_name
, '/', '.');
867 pidfile
= g_strdup_printf("%s/%s.pid", dir
, sk_name
);
869 if (!qemu_write_pidfile(pidfile
, &local_err
)) {
870 error_report_err(local_err
);
877 static int fv_create_listen_socket(struct fuse_session
*se
)
879 struct sockaddr_un un
;
882 /* Nothing to do if fd is already initialized */
883 if (se
->vu_listen_fd
>= 0) {
887 if (strlen(se
->vu_socket_path
) >= sizeof(un
.sun_path
)) {
888 fuse_log(FUSE_LOG_ERR
, "Socket path too long\n");
892 if (!strlen(se
->vu_socket_path
)) {
893 fuse_log(FUSE_LOG_ERR
, "Socket path is empty\n");
897 /* Check the vu_socket_path is already used */
898 if (!fv_socket_lock(se
)) {
903 * Create the Unix socket to communicate with qemu
904 * based on QEMU's vhost-user-bridge
906 unlink(se
->vu_socket_path
);
907 strcpy(un
.sun_path
, se
->vu_socket_path
);
908 size_t addr_len
= sizeof(un
);
910 int listen_sock
= socket(AF_UNIX
, SOCK_STREAM
, 0);
911 if (listen_sock
== -1) {
912 fuse_log(FUSE_LOG_ERR
, "vhost socket creation: %m\n");
915 un
.sun_family
= AF_UNIX
;
918 * Unfortunately bind doesn't let you set the mask on the socket,
919 * so set umask appropriately and restore it later.
921 if (se
->vu_socket_group
) {
922 old_umask
= umask(S_IROTH
| S_IWOTH
| S_IXOTH
);
924 old_umask
= umask(S_IRGRP
| S_IWGRP
| S_IXGRP
|
925 S_IROTH
| S_IWOTH
| S_IXOTH
);
927 if (bind(listen_sock
, (struct sockaddr
*)&un
, addr_len
) == -1) {
928 fuse_log(FUSE_LOG_ERR
, "vhost socket bind: %m\n");
933 if (se
->vu_socket_group
) {
934 struct group
*g
= getgrnam(se
->vu_socket_group
);
936 if (!chown(se
->vu_socket_path
, -1, g
->gr_gid
)) {
937 fuse_log(FUSE_LOG_WARNING
,
938 "vhost socket failed to set group to %s (%d)\n",
939 se
->vu_socket_group
, g
->gr_gid
);
945 if (listen(listen_sock
, 1) == -1) {
946 fuse_log(FUSE_LOG_ERR
, "vhost socket listen: %m\n");
951 se
->vu_listen_fd
= listen_sock
;
955 int virtio_session_mount(struct fuse_session
*se
)
960 * Test that unshare(CLONE_FS) works. fv_queue_worker() will need it. It's
961 * an unprivileged system call but some Docker/Moby versions are known to
962 * reject it via seccomp when CAP_SYS_ADMIN is not given.
964 * Note that the program is single-threaded here so this syscall has no
965 * visible effect and is safe to make.
967 ret
= unshare(CLONE_FS
);
968 if (ret
== -1 && errno
== EPERM
) {
969 fuse_log(FUSE_LOG_ERR
, "unshare(CLONE_FS) failed with EPERM. If "
970 "running in a container please check that the container "
971 "runtime seccomp policy allows unshare.\n");
975 ret
= fv_create_listen_socket(se
);
982 fuse_log(FUSE_LOG_INFO
, "%s: Waiting for vhost-user socket connection...\n",
984 int data_sock
= accept(se
->vu_listen_fd
, NULL
, NULL
);
985 if (data_sock
== -1) {
986 fuse_log(FUSE_LOG_ERR
, "vhost socket accept: %m\n");
987 close(se
->vu_listen_fd
);
990 close(se
->vu_listen_fd
);
991 se
->vu_listen_fd
= -1;
992 fuse_log(FUSE_LOG_INFO
, "%s: Received vhost-user socket connection\n",
995 /* TODO: Some cleanup/deallocation! */
996 se
->virtio_dev
= calloc(sizeof(struct fv_VuDev
), 1);
997 if (!se
->virtio_dev
) {
998 fuse_log(FUSE_LOG_ERR
, "%s: virtio_dev calloc failed\n", __func__
);
1003 se
->vu_socketfd
= data_sock
;
1004 se
->virtio_dev
->se
= se
;
1005 pthread_rwlock_init(&se
->virtio_dev
->vu_dispatch_rwlock
, NULL
);
1006 if (!vu_init(&se
->virtio_dev
->dev
, 2, se
->vu_socketfd
, fv_panic
, NULL
,
1007 fv_set_watch
, fv_remove_watch
, &fv_iface
)) {
1008 fuse_log(FUSE_LOG_ERR
, "%s: vu_init failed\n", __func__
);
1015 void virtio_session_close(struct fuse_session
*se
)
1017 close(se
->vu_socketfd
);
1019 if (!se
->virtio_dev
) {
1023 free(se
->virtio_dev
->qi
);
1024 pthread_rwlock_destroy(&se
->virtio_dev
->vu_dispatch_rwlock
);
1025 free(se
->virtio_dev
);
1026 se
->virtio_dev
= NULL
;