scripts/qemu.py: use a more consistent docstring style
[qemu/ar7.git] / hw / 9pfs / 9p-handle.c
blob3465b1ef3063889eb03b97d87b811ff07ffa397f
1 /*
2 * 9p handle callback
4 * Copyright IBM, Corp. 2011
6 * Authors:
7 * Aneesh Kumar K.V <aneesh.kumar@linux.vnet.ibm.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.
14 #include "qemu/osdep.h"
15 #include "9p.h"
16 #include "9p-xattr.h"
17 #include <arpa/inet.h>
18 #include <pwd.h>
19 #include <grp.h>
20 #include <sys/socket.h>
21 #include <sys/un.h>
22 #include "qapi/error.h"
23 #include "qemu/xattr.h"
24 #include "qemu/cutils.h"
25 #include "qemu/error-report.h"
26 #include "qemu/option.h"
27 #include <linux/fs.h>
28 #ifdef CONFIG_LINUX_MAGIC_H
29 #include <linux/magic.h>
30 #endif
31 #include <sys/ioctl.h>
33 #ifndef XFS_SUPER_MAGIC
34 #define XFS_SUPER_MAGIC 0x58465342
35 #endif
36 #ifndef EXT2_SUPER_MAGIC
37 #define EXT2_SUPER_MAGIC 0xEF53
38 #endif
39 #ifndef REISERFS_SUPER_MAGIC
40 #define REISERFS_SUPER_MAGIC 0x52654973
41 #endif
42 #ifndef BTRFS_SUPER_MAGIC
43 #define BTRFS_SUPER_MAGIC 0x9123683E
44 #endif
46 typedef struct HandleData {
47 int mountfd;
48 int handle_bytes;
49 } HandleData;
51 static inline int name_to_handle(int dirfd, const char *name,
52 struct file_handle *fh, int *mnt_id, int flags)
54 return name_to_handle_at(dirfd, name, fh, mnt_id, flags);
57 static inline int open_by_handle(int mountfd, const char *fh, int flags)
59 return open_by_handle_at(mountfd, (struct file_handle *)fh, flags);
62 static int handle_update_file_cred(int dirfd, const char *name, FsCred *credp)
64 int fd, ret;
65 fd = openat(dirfd, name, O_NONBLOCK | O_NOFOLLOW);
66 if (fd < 0) {
67 return fd;
69 ret = fchownat(fd, "", credp->fc_uid, credp->fc_gid, AT_EMPTY_PATH);
70 if (ret < 0) {
71 goto err_out;
73 ret = fchmod(fd, credp->fc_mode & 07777);
74 err_out:
75 close(fd);
76 return ret;
80 static int handle_lstat(FsContext *fs_ctx, V9fsPath *fs_path,
81 struct stat *stbuf)
83 int fd, ret;
84 HandleData *data = (HandleData *) fs_ctx->private;
86 fd = open_by_handle(data->mountfd, fs_path->data, O_PATH);
87 if (fd < 0) {
88 return fd;
90 ret = fstatat(fd, "", stbuf, AT_EMPTY_PATH);
91 close(fd);
92 return ret;
95 static ssize_t handle_readlink(FsContext *fs_ctx, V9fsPath *fs_path,
96 char *buf, size_t bufsz)
98 int fd, ret;
99 HandleData *data = (HandleData *) fs_ctx->private;
101 fd = open_by_handle(data->mountfd, fs_path->data, O_PATH);
102 if (fd < 0) {
103 return fd;
105 ret = readlinkat(fd, "", buf, bufsz);
106 close(fd);
107 return ret;
110 static int handle_close(FsContext *ctx, V9fsFidOpenState *fs)
112 return close(fs->fd);
115 static int handle_closedir(FsContext *ctx, V9fsFidOpenState *fs)
117 return closedir(fs->dir.stream);
120 static int handle_open(FsContext *ctx, V9fsPath *fs_path,
121 int flags, V9fsFidOpenState *fs)
123 HandleData *data = (HandleData *) ctx->private;
125 fs->fd = open_by_handle(data->mountfd, fs_path->data, flags);
126 return fs->fd;
129 static int handle_opendir(FsContext *ctx,
130 V9fsPath *fs_path, V9fsFidOpenState *fs)
132 int ret;
133 ret = handle_open(ctx, fs_path, O_DIRECTORY, fs);
134 if (ret < 0) {
135 return -1;
137 fs->dir.stream = fdopendir(ret);
138 if (!fs->dir.stream) {
139 return -1;
141 return 0;
144 static void handle_rewinddir(FsContext *ctx, V9fsFidOpenState *fs)
146 rewinddir(fs->dir.stream);
149 static off_t handle_telldir(FsContext *ctx, V9fsFidOpenState *fs)
151 return telldir(fs->dir.stream);
154 static struct dirent *handle_readdir(FsContext *ctx, V9fsFidOpenState *fs)
156 return readdir(fs->dir.stream);
159 static void handle_seekdir(FsContext *ctx, V9fsFidOpenState *fs, off_t off)
161 seekdir(fs->dir.stream, off);
164 static ssize_t handle_preadv(FsContext *ctx, V9fsFidOpenState *fs,
165 const struct iovec *iov,
166 int iovcnt, off_t offset)
168 #ifdef CONFIG_PREADV
169 return preadv(fs->fd, iov, iovcnt, offset);
170 #else
171 int err = lseek(fs->fd, offset, SEEK_SET);
172 if (err == -1) {
173 return err;
174 } else {
175 return readv(fs->fd, iov, iovcnt);
177 #endif
180 static ssize_t handle_pwritev(FsContext *ctx, V9fsFidOpenState *fs,
181 const struct iovec *iov,
182 int iovcnt, off_t offset)
184 ssize_t ret;
185 #ifdef CONFIG_PREADV
186 ret = pwritev(fs->fd, iov, iovcnt, offset);
187 #else
188 int err = lseek(fs->fd, offset, SEEK_SET);
189 if (err == -1) {
190 return err;
191 } else {
192 ret = writev(fs->fd, iov, iovcnt);
194 #endif
195 #ifdef CONFIG_SYNC_FILE_RANGE
196 if (ret > 0 && ctx->export_flags & V9FS_IMMEDIATE_WRITEOUT) {
198 * Initiate a writeback. This is not a data integrity sync.
199 * We want to ensure that we don't leave dirty pages in the cache
200 * after write when writeout=immediate is sepcified.
202 sync_file_range(fs->fd, offset, ret,
203 SYNC_FILE_RANGE_WAIT_BEFORE | SYNC_FILE_RANGE_WRITE);
205 #endif
206 return ret;
209 static int handle_chmod(FsContext *fs_ctx, V9fsPath *fs_path, FsCred *credp)
211 int fd, ret;
212 HandleData *data = (HandleData *) fs_ctx->private;
214 fd = open_by_handle(data->mountfd, fs_path->data, O_NONBLOCK);
215 if (fd < 0) {
216 return fd;
218 ret = fchmod(fd, credp->fc_mode);
219 close(fd);
220 return ret;
223 static int handle_mknod(FsContext *fs_ctx, V9fsPath *dir_path,
224 const char *name, FsCred *credp)
226 int dirfd, ret;
227 HandleData *data = (HandleData *) fs_ctx->private;
229 dirfd = open_by_handle(data->mountfd, dir_path->data, O_PATH);
230 if (dirfd < 0) {
231 return dirfd;
233 ret = mknodat(dirfd, name, credp->fc_mode, credp->fc_rdev);
234 if (!ret) {
235 ret = handle_update_file_cred(dirfd, name, credp);
237 close(dirfd);
238 return ret;
241 static int handle_mkdir(FsContext *fs_ctx, V9fsPath *dir_path,
242 const char *name, FsCred *credp)
244 int dirfd, ret;
245 HandleData *data = (HandleData *) fs_ctx->private;
247 dirfd = open_by_handle(data->mountfd, dir_path->data, O_PATH);
248 if (dirfd < 0) {
249 return dirfd;
251 ret = mkdirat(dirfd, name, credp->fc_mode);
252 if (!ret) {
253 ret = handle_update_file_cred(dirfd, name, credp);
255 close(dirfd);
256 return ret;
259 static int handle_fstat(FsContext *fs_ctx, int fid_type,
260 V9fsFidOpenState *fs, struct stat *stbuf)
262 int fd;
264 if (fid_type == P9_FID_DIR) {
265 fd = dirfd(fs->dir.stream);
266 } else {
267 fd = fs->fd;
269 return fstat(fd, stbuf);
272 static int handle_open2(FsContext *fs_ctx, V9fsPath *dir_path, const char *name,
273 int flags, FsCred *credp, V9fsFidOpenState *fs)
275 int ret;
276 int dirfd, fd;
277 HandleData *data = (HandleData *) fs_ctx->private;
279 dirfd = open_by_handle(data->mountfd, dir_path->data, O_PATH);
280 if (dirfd < 0) {
281 return dirfd;
283 fd = openat(dirfd, name, flags | O_NOFOLLOW, credp->fc_mode);
284 if (fd >= 0) {
285 ret = handle_update_file_cred(dirfd, name, credp);
286 if (ret < 0) {
287 close(fd);
288 fd = ret;
289 } else {
290 fs->fd = fd;
293 close(dirfd);
294 return fd;
298 static int handle_symlink(FsContext *fs_ctx, const char *oldpath,
299 V9fsPath *dir_path, const char *name, FsCred *credp)
301 int fd, dirfd, ret;
302 HandleData *data = (HandleData *) fs_ctx->private;
304 dirfd = open_by_handle(data->mountfd, dir_path->data, O_PATH);
305 if (dirfd < 0) {
306 return dirfd;
308 ret = symlinkat(oldpath, dirfd, name);
309 if (!ret) {
310 fd = openat(dirfd, name, O_PATH | O_NOFOLLOW);
311 if (fd < 0) {
312 ret = fd;
313 goto err_out;
315 ret = fchownat(fd, "", credp->fc_uid, credp->fc_gid, AT_EMPTY_PATH);
316 close(fd);
318 err_out:
319 close(dirfd);
320 return ret;
323 static int handle_link(FsContext *ctx, V9fsPath *oldpath,
324 V9fsPath *dirpath, const char *name)
326 int oldfd, newdirfd, ret;
327 HandleData *data = (HandleData *) ctx->private;
329 oldfd = open_by_handle(data->mountfd, oldpath->data, O_PATH);
330 if (oldfd < 0) {
331 return oldfd;
333 newdirfd = open_by_handle(data->mountfd, dirpath->data, O_PATH);
334 if (newdirfd < 0) {
335 close(oldfd);
336 return newdirfd;
338 ret = linkat(oldfd, "", newdirfd, name, AT_EMPTY_PATH);
339 close(newdirfd);
340 close(oldfd);
341 return ret;
344 static int handle_truncate(FsContext *ctx, V9fsPath *fs_path, off_t size)
346 int fd, ret;
347 HandleData *data = (HandleData *) ctx->private;
349 fd = open_by_handle(data->mountfd, fs_path->data, O_NONBLOCK | O_WRONLY);
350 if (fd < 0) {
351 return fd;
353 ret = ftruncate(fd, size);
354 close(fd);
355 return ret;
358 static int handle_rename(FsContext *ctx, const char *oldpath,
359 const char *newpath)
361 errno = EOPNOTSUPP;
362 return -1;
365 static int handle_chown(FsContext *fs_ctx, V9fsPath *fs_path, FsCred *credp)
367 int fd, ret;
368 HandleData *data = (HandleData *) fs_ctx->private;
370 fd = open_by_handle(data->mountfd, fs_path->data, O_PATH);
371 if (fd < 0) {
372 return fd;
374 ret = fchownat(fd, "", credp->fc_uid, credp->fc_gid, AT_EMPTY_PATH);
375 close(fd);
376 return ret;
379 static int handle_utimensat(FsContext *ctx, V9fsPath *fs_path,
380 const struct timespec *buf)
382 int ret;
383 int fd;
384 HandleData *data = (HandleData *) ctx->private;
386 fd = open_by_handle(data->mountfd, fs_path->data, O_NONBLOCK);
387 if (fd < 0) {
388 return fd;
390 ret = futimens(fd, buf);
391 close(fd);
392 return ret;
395 static int handle_remove(FsContext *ctx, const char *path)
397 errno = EOPNOTSUPP;
398 return -1;
401 static int handle_fsync(FsContext *ctx, int fid_type,
402 V9fsFidOpenState *fs, int datasync)
404 int fd;
406 if (fid_type == P9_FID_DIR) {
407 fd = dirfd(fs->dir.stream);
408 } else {
409 fd = fs->fd;
412 if (datasync) {
413 return qemu_fdatasync(fd);
414 } else {
415 return fsync(fd);
419 static int handle_statfs(FsContext *ctx, V9fsPath *fs_path,
420 struct statfs *stbuf)
422 int fd, ret;
423 HandleData *data = (HandleData *) ctx->private;
425 fd = open_by_handle(data->mountfd, fs_path->data, O_NONBLOCK);
426 if (fd < 0) {
427 return fd;
429 ret = fstatfs(fd, stbuf);
430 close(fd);
431 return ret;
434 static ssize_t handle_lgetxattr(FsContext *ctx, V9fsPath *fs_path,
435 const char *name, void *value, size_t size)
437 int fd, ret;
438 HandleData *data = (HandleData *) ctx->private;
440 fd = open_by_handle(data->mountfd, fs_path->data, O_NONBLOCK);
441 if (fd < 0) {
442 return fd;
444 ret = fgetxattr(fd, name, value, size);
445 close(fd);
446 return ret;
449 static ssize_t handle_llistxattr(FsContext *ctx, V9fsPath *fs_path,
450 void *value, size_t size)
452 int fd, ret;
453 HandleData *data = (HandleData *) ctx->private;
455 fd = open_by_handle(data->mountfd, fs_path->data, O_NONBLOCK);
456 if (fd < 0) {
457 return fd;
459 ret = flistxattr(fd, value, size);
460 close(fd);
461 return ret;
464 static int handle_lsetxattr(FsContext *ctx, V9fsPath *fs_path, const char *name,
465 void *value, size_t size, int flags)
467 int fd, ret;
468 HandleData *data = (HandleData *) ctx->private;
470 fd = open_by_handle(data->mountfd, fs_path->data, O_NONBLOCK);
471 if (fd < 0) {
472 return fd;
474 ret = fsetxattr(fd, name, value, size, flags);
475 close(fd);
476 return ret;
479 static int handle_lremovexattr(FsContext *ctx, V9fsPath *fs_path,
480 const char *name)
482 int fd, ret;
483 HandleData *data = (HandleData *) ctx->private;
485 fd = open_by_handle(data->mountfd, fs_path->data, O_NONBLOCK);
486 if (fd < 0) {
487 return fd;
489 ret = fremovexattr(fd, name);
490 close(fd);
491 return ret;
494 static int handle_name_to_path(FsContext *ctx, V9fsPath *dir_path,
495 const char *name, V9fsPath *target)
497 char *buffer;
498 struct file_handle *fh;
499 int dirfd, ret, mnt_id;
500 HandleData *data = (HandleData *) ctx->private;
502 /* "." and ".." are not allowed */
503 if (!strcmp(name, ".") || !strcmp(name, "..")) {
504 errno = EINVAL;
505 return -1;
508 if (dir_path) {
509 dirfd = open_by_handle(data->mountfd, dir_path->data, O_PATH);
510 } else {
511 /* relative to export root */
512 buffer = rpath(ctx, ".");
513 dirfd = open(buffer, O_DIRECTORY);
514 g_free(buffer);
516 if (dirfd < 0) {
517 return dirfd;
519 fh = g_malloc(sizeof(struct file_handle) + data->handle_bytes);
520 fh->handle_bytes = data->handle_bytes;
521 /* add a "./" at the beginning of the path */
522 buffer = g_strdup_printf("./%s", name);
523 /* flag = 0 imply don't follow symlink */
524 ret = name_to_handle(dirfd, buffer, fh, &mnt_id, 0);
525 if (!ret) {
526 target->data = (char *)fh;
527 target->size = sizeof(struct file_handle) + data->handle_bytes;
528 } else {
529 g_free(fh);
531 close(dirfd);
532 g_free(buffer);
533 return ret;
536 static int handle_renameat(FsContext *ctx, V9fsPath *olddir,
537 const char *old_name, V9fsPath *newdir,
538 const char *new_name)
540 int olddirfd, newdirfd, ret;
541 HandleData *data = (HandleData *) ctx->private;
543 olddirfd = open_by_handle(data->mountfd, olddir->data, O_PATH);
544 if (olddirfd < 0) {
545 return olddirfd;
547 newdirfd = open_by_handle(data->mountfd, newdir->data, O_PATH);
548 if (newdirfd < 0) {
549 close(olddirfd);
550 return newdirfd;
552 ret = renameat(olddirfd, old_name, newdirfd, new_name);
553 close(newdirfd);
554 close(olddirfd);
555 return ret;
558 static int handle_unlinkat(FsContext *ctx, V9fsPath *dir,
559 const char *name, int flags)
561 int dirfd, ret;
562 HandleData *data = (HandleData *) ctx->private;
564 dirfd = open_by_handle(data->mountfd, dir->data, O_PATH);
565 if (dirfd < 0) {
566 return dirfd;
569 ret = unlinkat(dirfd, name, flags);
571 close(dirfd);
572 return ret;
575 static int handle_ioc_getversion(FsContext *ctx, V9fsPath *path,
576 mode_t st_mode, uint64_t *st_gen)
578 #ifdef FS_IOC_GETVERSION
579 int err;
580 V9fsFidOpenState fid_open;
583 * Do not try to open special files like device nodes, fifos etc
584 * We can get fd for regular files and directories only
586 if (!S_ISREG(st_mode) && !S_ISDIR(st_mode)) {
587 errno = ENOTTY;
588 return -1;
590 err = handle_open(ctx, path, O_RDONLY, &fid_open);
591 if (err < 0) {
592 return err;
594 err = ioctl(fid_open.fd, FS_IOC_GETVERSION, st_gen);
595 handle_close(ctx, &fid_open);
596 return err;
597 #else
598 errno = ENOTTY;
599 return -1;
600 #endif
603 static int handle_init(FsContext *ctx, Error **errp)
605 int ret, mnt_id;
606 struct statfs stbuf;
607 struct file_handle fh;
608 HandleData *data = g_malloc(sizeof(HandleData));
610 data->mountfd = open(ctx->fs_root, O_DIRECTORY);
611 if (data->mountfd < 0) {
612 ret = data->mountfd;
613 goto err_out;
615 ret = statfs(ctx->fs_root, &stbuf);
616 if (!ret) {
617 switch (stbuf.f_type) {
618 case EXT2_SUPER_MAGIC:
619 case BTRFS_SUPER_MAGIC:
620 case REISERFS_SUPER_MAGIC:
621 case XFS_SUPER_MAGIC:
622 ctx->exops.get_st_gen = handle_ioc_getversion;
623 break;
626 memset(&fh, 0, sizeof(struct file_handle));
627 ret = name_to_handle(data->mountfd, ".", &fh, &mnt_id, 0);
628 if (ret && errno == EOVERFLOW) {
629 data->handle_bytes = fh.handle_bytes;
630 ctx->private = data;
631 ret = 0;
632 goto out;
634 /* we got 0 byte handle ? */
635 ret = -1;
636 close(data->mountfd);
637 err_out:
638 g_free(data);
639 out:
640 return ret;
643 static void handle_cleanup(FsContext *ctx)
645 HandleData *data = ctx->private;
647 close(data->mountfd);
648 g_free(data);
651 static int handle_parse_opts(QemuOpts *opts, FsDriverEntry *fse, Error **errp)
653 const char *sec_model = qemu_opt_get(opts, "security_model");
654 const char *path = qemu_opt_get(opts, "path");
656 warn_report("handle backend is deprecated");
658 if (sec_model) {
659 error_setg(errp,
660 "Invalid argument security_model specified with handle fsdriver");
661 return -1;
664 if (!path) {
665 error_setg(errp, "fsdev: No path specified");
666 return -1;
668 fse->path = g_strdup(path);
669 return 0;
673 FileOperations handle_ops = {
674 .parse_opts = handle_parse_opts,
675 .init = handle_init,
676 .cleanup = handle_cleanup,
677 .lstat = handle_lstat,
678 .readlink = handle_readlink,
679 .close = handle_close,
680 .closedir = handle_closedir,
681 .open = handle_open,
682 .opendir = handle_opendir,
683 .rewinddir = handle_rewinddir,
684 .telldir = handle_telldir,
685 .readdir = handle_readdir,
686 .seekdir = handle_seekdir,
687 .preadv = handle_preadv,
688 .pwritev = handle_pwritev,
689 .chmod = handle_chmod,
690 .mknod = handle_mknod,
691 .mkdir = handle_mkdir,
692 .fstat = handle_fstat,
693 .open2 = handle_open2,
694 .symlink = handle_symlink,
695 .link = handle_link,
696 .truncate = handle_truncate,
697 .rename = handle_rename,
698 .chown = handle_chown,
699 .utimensat = handle_utimensat,
700 .remove = handle_remove,
701 .fsync = handle_fsync,
702 .statfs = handle_statfs,
703 .lgetxattr = handle_lgetxattr,
704 .llistxattr = handle_llistxattr,
705 .lsetxattr = handle_lsetxattr,
706 .lremovexattr = handle_lremovexattr,
707 .name_to_path = handle_name_to_path,
708 .renameat = handle_renameat,
709 .unlinkat = handle_unlinkat,