4 * Copyright IBM, Corp. 2010
9 * This work is licensed under the terms of the GNU GPL, version 2. See
10 * the COPYING file in the top-level directory.
16 #include "qemu_socket.h"
17 #include "virtio-9p.h"
18 #include "fsdev/qemu-fsdev.h"
19 #include "virtio-9p-debug.h"
24 static int v9fs_do_lstat(V9fsState *s, V9fsString *path, struct stat *stbuf)
26 return s->ops->lstat(&s->ctx, path->data, stbuf);
29 static int v9fs_do_setuid(V9fsState *s, uid_t uid)
31 return s->ops->setuid(&s->ctx, uid);
34 static ssize_t v9fs_do_readlink(V9fsState *s, V9fsString *path, V9fsString *buf)
38 buf->data = qemu_malloc(1024);
40 len = s->ops->readlink(&s->ctx, path->data, buf->data, 1024 - 1);
49 static int v9fs_do_close(V9fsState *s, int fd)
51 return s->ops->close(&s->ctx, fd);
54 static int v9fs_do_closedir(V9fsState *s, DIR *dir)
56 return s->ops->closedir(&s->ctx, dir);
59 static void v9fs_string_init(V9fsString *str)
65 static void v9fs_string_free(V9fsString *str)
72 static void v9fs_string_null(V9fsString *str)
74 v9fs_string_free(str);
77 static int number_to_string(void *arg, char type)
83 unsigned int num = *(unsigned int *)arg;
92 printf("Number_to_string: Unknown number format\n");
99 static int v9fs_string_alloc_printf(char **strp, const char *fmt, va_list ap)
102 char *iter = (char *)fmt;
106 unsigned int arg_uint;
108 /* Find the number of %'s that denotes an argument */
109 for (iter = strstr(iter, "%"); iter; iter = strstr(iter, "%")) {
114 len = strlen(fmt) - 2*nr_args;
124 /* Now parse the format string */
125 for (iter = strstr(iter, "%"); iter; iter = strstr(iter, "%")) {
129 arg_uint = va_arg(ap2, unsigned int);
130 len += number_to_string((void *)&arg_uint, 'u');
133 arg_char_ptr = va_arg(ap2, char *);
134 len += strlen(arg_char_ptr);
141 "v9fs_string_alloc_printf:Incorrect format %c", *iter);
148 *strp = qemu_malloc((len + 1) * sizeof(**strp));
150 return vsprintf(*strp, fmt, ap);
153 static void v9fs_string_sprintf(V9fsString *str, const char *fmt, ...)
158 v9fs_string_free(str);
161 err = v9fs_string_alloc_printf(&str->data, fmt, ap);
168 static void v9fs_string_copy(V9fsString *lhs, V9fsString *rhs)
170 v9fs_string_free(lhs);
171 v9fs_string_sprintf(lhs, "%s", rhs->data);
174 static size_t v9fs_string_size(V9fsString *str)
179 static V9fsFidState *lookup_fid(V9fsState *s, int32_t fid)
183 for (f = s->fid_list; f; f = f->next) {
185 v9fs_do_setuid(s, f->uid);
193 static V9fsFidState *alloc_fid(V9fsState *s, int32_t fid)
197 f = lookup_fid(s, fid);
202 f = qemu_mallocz(sizeof(V9fsFidState));
208 f->next = s->fid_list;
214 static int free_fid(V9fsState *s, int32_t fid)
216 V9fsFidState **fidpp, *fidp;
218 for (fidpp = &s->fid_list; *fidpp; fidpp = &(*fidpp)->next) {
219 if ((*fidpp)->fid == fid) {
224 if (*fidpp == NULL) {
231 if (fidp->fd != -1) {
232 v9fs_do_close(s, fidp->fd);
235 v9fs_do_closedir(s, fidp->dir);
237 v9fs_string_free(&fidp->path);
243 #define P9_QID_TYPE_DIR 0x80
244 #define P9_QID_TYPE_SYMLINK 0x02
246 #define P9_STAT_MODE_DIR 0x80000000
247 #define P9_STAT_MODE_APPEND 0x40000000
248 #define P9_STAT_MODE_EXCL 0x20000000
249 #define P9_STAT_MODE_MOUNT 0x10000000
250 #define P9_STAT_MODE_AUTH 0x08000000
251 #define P9_STAT_MODE_TMP 0x04000000
252 #define P9_STAT_MODE_SYMLINK 0x02000000
253 #define P9_STAT_MODE_LINK 0x01000000
254 #define P9_STAT_MODE_DEVICE 0x00800000
255 #define P9_STAT_MODE_NAMED_PIPE 0x00200000
256 #define P9_STAT_MODE_SOCKET 0x00100000
257 #define P9_STAT_MODE_SETUID 0x00080000
258 #define P9_STAT_MODE_SETGID 0x00040000
259 #define P9_STAT_MODE_SETVTX 0x00010000
261 #define P9_STAT_MODE_TYPE_BITS (P9_STAT_MODE_DIR | \
262 P9_STAT_MODE_SYMLINK | \
263 P9_STAT_MODE_LINK | \
264 P9_STAT_MODE_DEVICE | \
265 P9_STAT_MODE_NAMED_PIPE | \
268 /* This is the algorithm from ufs in spfs */
269 static void stat_to_qid(const struct stat *stbuf, V9fsQID *qidp)
273 size = MIN(sizeof(stbuf->st_ino), sizeof(qidp->path));
274 memcpy(&qidp->path, &stbuf->st_ino, size);
275 qidp->version = stbuf->st_mtime ^ (stbuf->st_size << 8);
277 if (S_ISDIR(stbuf->st_mode)) {
278 qidp->type |= P9_QID_TYPE_DIR;
280 if (S_ISLNK(stbuf->st_mode)) {
281 qidp->type |= P9_QID_TYPE_SYMLINK;
285 static int fid_to_qid(V9fsState *s, V9fsFidState *fidp, V9fsQID *qidp)
290 err = v9fs_do_lstat(s, &fidp->path, &stbuf);
295 stat_to_qid(&stbuf, qidp);
299 static V9fsPDU *alloc_pdu(V9fsState *s)
303 if (!QLIST_EMPTY(&s->free_list)) {
304 pdu = QLIST_FIRST(&s->free_list);
305 QLIST_REMOVE(pdu, next);
310 static void free_pdu(V9fsState *s, V9fsPDU *pdu)
313 QLIST_INSERT_HEAD(&s->free_list, pdu, next);
317 size_t pdu_packunpack(void *addr, struct iovec *sg, int sg_count,
318 size_t offset, size_t size, int pack)
323 for (i = 0; size && i < sg_count; i++) {
325 if (offset >= sg[i].iov_len) {
327 offset -= sg[i].iov_len;
330 len = MIN(sg[i].iov_len - offset, size);
332 memcpy(sg[i].iov_base + offset, addr, len);
334 memcpy(addr, sg[i].iov_base + offset, len);
349 static size_t pdu_unpack(void *dst, V9fsPDU *pdu, size_t offset, size_t size)
351 return pdu_packunpack(dst, pdu->elem.out_sg, pdu->elem.out_num,
355 static size_t pdu_pack(V9fsPDU *pdu, size_t offset, const void *src,
358 return pdu_packunpack((void *)src, pdu->elem.in_sg, pdu->elem.in_num,
362 static int pdu_copy_sg(V9fsPDU *pdu, size_t offset, int rx, struct iovec *sg)
366 struct iovec *src_sg;
370 src_sg = pdu->elem.in_sg;
371 num = pdu->elem.in_num;
373 src_sg = pdu->elem.out_sg;
374 num = pdu->elem.out_num;
378 for (i = 0; i < num; i++) {
380 sg[j].iov_base = src_sg[i].iov_base;
381 sg[j].iov_len = src_sg[i].iov_len;
383 } else if (offset < (src_sg[i].iov_len + pos)) {
384 sg[j].iov_base = src_sg[i].iov_base;
385 sg[j].iov_len = src_sg[i].iov_len;
386 sg[j].iov_base += (offset - pos);
387 sg[j].iov_len -= (offset - pos);
390 pos += src_sg[i].iov_len;
396 static size_t pdu_unmarshal(V9fsPDU *pdu, size_t offset, const char *fmt, ...)
398 size_t old_offset = offset;
403 for (i = 0; fmt[i]; i++) {
406 uint8_t *valp = va_arg(ap, uint8_t *);
407 offset += pdu_unpack(valp, pdu, offset, sizeof(*valp));
412 valp = va_arg(ap, uint16_t *);
413 val = le16_to_cpupu(valp);
414 offset += pdu_unpack(&val, pdu, offset, sizeof(val));
420 valp = va_arg(ap, uint32_t *);
421 val = le32_to_cpupu(valp);
422 offset += pdu_unpack(&val, pdu, offset, sizeof(val));
428 valp = va_arg(ap, uint64_t *);
429 val = le64_to_cpup(valp);
430 offset += pdu_unpack(&val, pdu, offset, sizeof(val));
435 struct iovec *iov = va_arg(ap, struct iovec *);
436 int *iovcnt = va_arg(ap, int *);
437 *iovcnt = pdu_copy_sg(pdu, offset, 0, iov);
441 V9fsString *str = va_arg(ap, V9fsString *);
442 offset += pdu_unmarshal(pdu, offset, "w", &str->size);
443 /* FIXME: sanity check str->size */
444 str->data = qemu_malloc(str->size + 1);
445 offset += pdu_unpack(str->data, pdu, offset, str->size);
446 str->data[str->size] = 0;
450 V9fsQID *qidp = va_arg(ap, V9fsQID *);
451 offset += pdu_unmarshal(pdu, offset, "bdq",
452 &qidp->type, &qidp->version, &qidp->path);
456 V9fsStat *statp = va_arg(ap, V9fsStat *);
457 offset += pdu_unmarshal(pdu, offset, "wwdQdddqsssssddd",
458 &statp->size, &statp->type, &statp->dev,
459 &statp->qid, &statp->mode, &statp->atime,
460 &statp->mtime, &statp->length,
461 &statp->name, &statp->uid, &statp->gid,
462 &statp->muid, &statp->extension,
463 &statp->n_uid, &statp->n_gid,
474 return offset - old_offset;
477 static size_t pdu_marshal(V9fsPDU *pdu, size_t offset, const char *fmt, ...)
479 size_t old_offset = offset;
484 for (i = 0; fmt[i]; i++) {
487 uint8_t val = va_arg(ap, int);
488 offset += pdu_pack(pdu, offset, &val, sizeof(val));
493 cpu_to_le16w(&val, va_arg(ap, int));
494 offset += pdu_pack(pdu, offset, &val, sizeof(val));
499 cpu_to_le32w(&val, va_arg(ap, uint32_t));
500 offset += pdu_pack(pdu, offset, &val, sizeof(val));
505 cpu_to_le64w(&val, va_arg(ap, uint64_t));
506 offset += pdu_pack(pdu, offset, &val, sizeof(val));
510 struct iovec *iov = va_arg(ap, struct iovec *);
511 int *iovcnt = va_arg(ap, int *);
512 *iovcnt = pdu_copy_sg(pdu, offset, 1, iov);
516 V9fsString *str = va_arg(ap, V9fsString *);
517 offset += pdu_marshal(pdu, offset, "w", str->size);
518 offset += pdu_pack(pdu, offset, str->data, str->size);
522 V9fsQID *qidp = va_arg(ap, V9fsQID *);
523 offset += pdu_marshal(pdu, offset, "bdq",
524 qidp->type, qidp->version, qidp->path);
528 V9fsStat *statp = va_arg(ap, V9fsStat *);
529 offset += pdu_marshal(pdu, offset, "wwdQdddqsssssddd",
530 statp->size, statp->type, statp->dev,
531 &statp->qid, statp->mode, statp->atime,
532 statp->mtime, statp->length, &statp->name,
533 &statp->uid, &statp->gid, &statp->muid,
534 &statp->extension, statp->n_uid,
535 statp->n_gid, statp->n_muid);
544 return offset - old_offset;
547 static void complete_pdu(V9fsState *s, V9fsPDU *pdu, ssize_t len)
549 int8_t id = pdu->id + 1; /* Response */
555 str.data = strerror(err);
556 str.size = strlen(str.data);
559 len += pdu_marshal(pdu, len, "s", &str);
561 len += pdu_marshal(pdu, len, "d", err);
567 /* fill out the header */
568 pdu_marshal(pdu, 0, "dbw", (int32_t)len, id, pdu->tag);
570 /* keep these in sync */
574 /* push onto queue and notify */
575 virtqueue_push(s->vq, &pdu->elem, len);
577 /* FIXME: we should batch these completions */
578 virtio_notify(&s->vdev, s->vq);
583 static void v9fs_dummy(V9fsState *s, V9fsPDU *pdu)
585 /* Note: The following have been added to prevent GCC from complaining
586 * They will be removed in the subsequent patches */
589 (void) v9fs_string_init;
590 (void) v9fs_string_free;
591 (void) v9fs_string_null;
592 (void) v9fs_string_sprintf;
593 (void) v9fs_string_copy;
594 (void) v9fs_string_size;
595 (void) v9fs_do_lstat;
596 (void) v9fs_do_setuid;
597 (void) v9fs_do_readlink;
598 (void) v9fs_do_close;
599 (void) v9fs_do_closedir;
605 static void v9fs_version(V9fsState *s, V9fsPDU *pdu)
612 static void v9fs_attach(V9fsState *s, V9fsPDU *pdu)
619 static void v9fs_stat(V9fsState *s, V9fsPDU *pdu)
626 static void v9fs_walk(V9fsState *s, V9fsPDU *pdu)
633 static void v9fs_clunk(V9fsState *s, V9fsPDU *pdu)
640 static void v9fs_open(V9fsState *s, V9fsPDU *pdu)
641 { if (debug_9p_pdu) {
646 static void v9fs_read(V9fsState *s, V9fsPDU *pdu)
653 static void v9fs_write(V9fsState *s, V9fsPDU *pdu)
660 static void v9fs_create(V9fsState *s, V9fsPDU *pdu)
667 static void v9fs_flush(V9fsState *s, V9fsPDU *pdu)
675 static void v9fs_remove(V9fsState *s, V9fsPDU *pdu)
682 static void v9fs_wstat(V9fsState *s, V9fsPDU *pdu)
689 typedef void (pdu_handler_t)(V9fsState *s, V9fsPDU *pdu);
691 static pdu_handler_t *pdu_handlers[] = {
692 [P9_TVERSION] = v9fs_version,
693 [P9_TATTACH] = v9fs_attach,
694 [P9_TSTAT] = v9fs_stat,
695 [P9_TWALK] = v9fs_walk,
696 [P9_TCLUNK] = v9fs_clunk,
697 [P9_TOPEN] = v9fs_open,
698 [P9_TREAD] = v9fs_read,
700 [P9_TAUTH] = v9fs_auth,
702 [P9_TFLUSH] = v9fs_flush,
703 [P9_TCREATE] = v9fs_create,
704 [P9_TWRITE] = v9fs_write,
705 [P9_TWSTAT] = v9fs_wstat,
706 [P9_TREMOVE] = v9fs_remove,
709 static void submit_pdu(V9fsState *s, V9fsPDU *pdu)
711 pdu_handler_t *handler;
717 BUG_ON(pdu->id >= ARRAY_SIZE(pdu_handlers));
719 handler = pdu_handlers[pdu->id];
720 BUG_ON(handler == NULL);
725 static void handle_9p_output(VirtIODevice *vdev, VirtQueue *vq)
727 V9fsState *s = (V9fsState *)vdev;
731 while ((pdu = alloc_pdu(s)) &&
732 (len = virtqueue_pop(vq, &pdu->elem)) != 0) {
735 BUG_ON(pdu->elem.out_num == 0 || pdu->elem.in_num == 0);
736 BUG_ON(pdu->elem.out_sg[0].iov_len < 7);
738 ptr = pdu->elem.out_sg[0].iov_base;
740 memcpy(&pdu->size, ptr, 4);
742 memcpy(&pdu->tag, ptr + 5, 2);
750 static uint32_t virtio_9p_get_features(VirtIODevice *vdev, uint32_t features)
752 features |= 1 << VIRTIO_9P_MOUNT_TAG;
756 static V9fsState *to_virtio_9p(VirtIODevice *vdev)
758 return (V9fsState *)vdev;
761 static void virtio_9p_get_config(VirtIODevice *vdev, uint8_t *config)
763 struct virtio_9p_config *cfg;
764 V9fsState *s = to_virtio_9p(vdev);
766 cfg = qemu_mallocz(sizeof(struct virtio_9p_config) +
768 stw_raw(&cfg->tag_len, s->tag_len);
769 memcpy(cfg->tag, s->tag, s->tag_len);
770 memcpy(config, cfg, s->config_size);
774 VirtIODevice *virtio_9p_init(DeviceState *dev, V9fsConf *conf)
782 s = (V9fsState *)virtio_common_init("virtio-9p",
784 sizeof(struct virtio_9p_config)+
788 /* initialize pdu allocator */
789 QLIST_INIT(&s->free_list);
790 for (i = 0; i < (MAX_REQ - 1); i++) {
791 QLIST_INSERT_HEAD(&s->free_list, &s->pdus[i], next);
794 s->vq = virtio_add_queue(&s->vdev, MAX_REQ, handle_9p_output);
796 fse = get_fsdev_fsentry(conf->fsdev_id);
799 /* We don't have a fsdev identified by fsdev_id */
800 fprintf(stderr, "Virtio-9p device couldn't find fsdev "
801 "with the id %s\n", conf->fsdev_id);
805 if (!fse->path || !conf->tag) {
806 /* we haven't specified a mount_tag or the path */
807 fprintf(stderr, "fsdev with id %s needs path "
808 "and Virtio-9p device needs mount_tag arguments\n",
813 if (lstat(fse->path, &stat)) {
814 fprintf(stderr, "share path %s does not exist\n", fse->path);
816 } else if (!S_ISDIR(stat.st_mode)) {
817 fprintf(stderr, "share path %s is not a directory \n", fse->path);
821 s->ctx.fs_root = qemu_strdup(fse->path);
822 len = strlen(conf->tag);
823 if (len > MAX_TAG_LEN) {
826 /* s->tag is non-NULL terminated string */
827 s->tag = qemu_malloc(len);
828 memcpy(s->tag, conf->tag, len);
833 s->vdev.get_features = virtio_9p_get_features;
834 s->config_size = sizeof(struct virtio_9p_config) +
836 s->vdev.get_config = virtio_9p_get_config;