blob: f2f7772c86d5ae45d1a8bb539a9a023ae8379b3f [file] [log] [blame]
Gautham R Shenoy74db9202010-04-29 17:44:43 +05301/*
Greg Kurzaf8b38b2016-06-06 11:52:34 +02002 * 9p
Gautham R Shenoy74db9202010-04-29 17:44:43 +05303 *
4 * Copyright IBM, Corp. 2010
5 *
6 * Authors:
7 * Aneesh Kumar K.V <aneesh.kumar@linux.vnet.ibm.com>
8 *
9 * This work is licensed under the terms of the GNU GPL, version 2. See
10 * the COPYING file in the top-level directory.
11 *
12 */
Markus Armbruster121d0712016-06-29 10:12:57 +020013
14#ifndef FILE_OP_9P_H
15#define FILE_OP_9P_H
16
Gautham R Shenoy74db9202010-04-29 17:44:43 +053017#include <dirent.h>
Gautham R Shenoy74db9202010-04-29 17:44:43 +053018#include <utime.h>
Venkateswararao Jujjuri (JV)758e8e32010-06-14 13:34:41 -070019#include <sys/vfs.h>
Pradeep Jagadeeshb8bbdb82017-02-28 10:31:46 +010020#include "qemu-fsdev-throttle.h"
Aneesh Kumar K.V0174fe72011-08-02 11:35:54 +053021
Venkateswararao Jujjuri (JV)758e8e32010-06-14 13:34:41 -070022#define SM_LOCAL_MODE_BITS 0600
23#define SM_LOCAL_DIR_MODE_BITS 0700
24
Greg Kurz1a8d0bb2018-01-08 11:18:22 +010025typedef struct FsCred {
Venkateswararao Jujjuri (JV)758e8e32010-06-14 13:34:41 -070026 uid_t fc_uid;
27 gid_t fc_gid;
28 mode_t fc_mode;
29 dev_t fc_rdev;
30} FsCred;
Gautham R Shenoy74db9202010-04-29 17:44:43 +053031
Greg Kurz1a8d0bb2018-01-08 11:18:22 +010032typedef struct FsContext FsContext;
33typedef struct V9fsPath V9fsPath;
Harsh Prateek Borae06a7652011-10-12 19:11:25 +053034
Greg Kurz1a8d0bb2018-01-08 11:18:22 +010035typedef struct ExtendedOps {
36 int (*get_st_gen)(FsContext *, V9fsPath *, mode_t, uint64_t *);
37} ExtendedOps;
Aneesh Kumar K.Vfc221182010-10-18 15:28:16 +053038
Aneesh Kumar K.Vd3ab98e2011-10-12 19:11:23 +053039/* export flags */
Aneesh Kumar K.Vc98f1d42011-10-12 20:59:18 +053040#define V9FS_IMMEDIATE_WRITEOUT 0x00000001
41#define V9FS_PATHNAME_FSCONTEXT 0x00000002
Aneesh Kumar K.Vb97400c2011-10-13 13:21:00 +053042/*
43 * uid/gid set on fileserver files
44 */
45#define V9FS_SM_PASSTHROUGH 0x00000004
46/*
47 * uid/gid part of xattr
48 */
49#define V9FS_SM_MAPPED 0x00000008
50/*
51 * Server will try to set uid/gid.
52 * On failure ignore the error.
53 */
54#define V9FS_SM_NONE 0x00000010
Aneesh Kumar K.V2c30dd72012-01-19 12:21:11 +053055/*
56 * uid/gid part of .virtfs_meatadata namespace
57 */
58#define V9FS_SM_MAPPED_FILE 0x00000020
59#define V9FS_RDONLY 0x00000040
60#define V9FS_PROXY_SOCK_FD 0x00000080
61#define V9FS_PROXY_SOCK_NAME 0x00000100
Antonios Motakis1a6ed332019-10-10 11:36:05 +020062/*
63 * multidevs option (either one of the two applies exclusively)
64 */
65#define V9FS_REMAP_INODES 0x00000200
66#define V9FS_FORBID_MULTIDEVS 0x00000400
Aneesh Kumar K.Vb97400c2011-10-13 13:21:00 +053067
Aneesh Kumar K.V2c30dd72012-01-19 12:21:11 +053068#define V9FS_SEC_MASK 0x0000003C
Aneesh Kumar K.Vd3ab98e2011-10-12 19:11:23 +053069
M. Mohan Kumar2c74c2c2011-10-25 12:10:39 +053070
Aneesh Kumar K.V99519f02011-12-14 13:48:59 +053071typedef struct FileOperations FileOperations;
Greg Kurz01847522018-01-08 11:18:22 +010072typedef struct XattrOperations XattrOperations;
73
Aneesh Kumar K.V99519f02011-12-14 13:48:59 +053074/*
75 * Structure to store the various fsdev's passed through command line.
76 */
77typedef struct FsDriverEntry {
78 char *fsdev_id;
79 char *path;
80 int export_flags;
81 FileOperations *ops;
Pradeep Jagadeeshb8bbdb82017-02-28 10:31:46 +010082 FsThrottle fst;
Tobias Schrammb96feb22017-06-29 15:11:50 +020083 mode_t fmode;
84 mode_t dmode;
Aneesh Kumar K.V99519f02011-12-14 13:48:59 +053085} FsDriverEntry;
M. Mohan Kumar2c74c2c2011-10-25 12:10:39 +053086
Greg Kurz1a8d0bb2018-01-08 11:18:22 +010087struct FsContext {
Gautham R Shenoy74db9202010-04-29 17:44:43 +053088 uid_t uid;
Aneesh Kumar K.Vb97400c2011-10-13 13:21:00 +053089 char *fs_root;
Aneesh Kumar K.Vd3ab98e2011-10-12 19:11:23 +053090 int export_flags;
Greg Kurz01847522018-01-08 11:18:22 +010091 XattrOperations **xops;
Greg Kurz1a8d0bb2018-01-08 11:18:22 +010092 ExtendedOps exops;
Pradeep Jagadeeshb8bbdb82017-02-28 10:31:46 +010093 FsThrottle *fst;
Aneesh Kumar K.V532decb2011-08-02 11:35:54 +053094 /* fs driver specific data */
95 void *private;
Tobias Schrammb96feb22017-06-29 15:11:50 +020096 mode_t fmode;
97 mode_t dmode;
Greg Kurz1a8d0bb2018-01-08 11:18:22 +010098};
Gautham R Shenoy74db9202010-04-29 17:44:43 +053099
Greg Kurz1a8d0bb2018-01-08 11:18:22 +0100100struct V9fsPath {
Aneesh Kumar K.V2f008a82011-12-21 12:37:23 +0530101 uint16_t size;
Aneesh Kumar K.V2289be12011-09-09 15:14:18 +0530102 char *data;
Greg Kurz1a8d0bb2018-01-08 11:18:22 +0100103};
Aneesh Kumar K.V2289be12011-09-09 15:14:18 +0530104
Aneesh Kumar K.Vcc720dd2011-10-25 12:10:40 +0530105typedef union V9fsFidOpenState V9fsFidOpenState;
106
Blue Swirl64b85a82011-01-23 16:21:20 +0000107void cred_init(FsCred *);
Venkateswararao Jujjuri (JV)758e8e32010-06-14 13:34:41 -0700108
Aneesh Kumar K.V99519f02011-12-14 13:48:59 +0530109struct FileOperations
Gautham R Shenoy74db9202010-04-29 17:44:43 +0530110{
Greg Kurz91cda4e2018-01-08 11:18:23 +0100111 int (*parse_opts)(QemuOpts *, FsDriverEntry *, Error **errp);
Greg Kurz65603a82018-01-08 11:18:23 +0100112 int (*init)(FsContext *, Error **errp);
Greg Kurz1a8d0bb2018-01-08 11:18:22 +0100113 void (*cleanup)(FsContext *);
Aneesh Kumar K.V2289be12011-09-09 15:14:18 +0530114 int (*lstat)(FsContext *, V9fsPath *, struct stat *);
115 ssize_t (*readlink)(FsContext *, V9fsPath *, char *, size_t);
116 int (*chmod)(FsContext *, V9fsPath *, FsCred *);
117 int (*chown)(FsContext *, V9fsPath *, FsCred *);
118 int (*mknod)(FsContext *, V9fsPath *, const char *, FsCred *);
119 int (*utimensat)(FsContext *, V9fsPath *, const struct timespec *);
Anthony Liguori5bae1902010-04-29 17:45:01 +0530120 int (*remove)(FsContext *, const char *);
Aneesh Kumar K.V2289be12011-09-09 15:14:18 +0530121 int (*symlink)(FsContext *, const char *, V9fsPath *,
122 const char *, FsCred *);
123 int (*link)(FsContext *, V9fsPath *, V9fsPath *, const char *);
Anthony Liguori131dcb22010-04-29 17:44:47 +0530124 int (*setuid)(FsContext *, uid_t);
Aneesh Kumar K.Vcc720dd2011-10-25 12:10:40 +0530125 int (*close)(FsContext *, V9fsFidOpenState *);
126 int (*closedir)(FsContext *, V9fsFidOpenState *);
127 int (*opendir)(FsContext *, V9fsPath *, V9fsFidOpenState *);
128 int (*open)(FsContext *, V9fsPath *, int, V9fsFidOpenState *);
129 int (*open2)(FsContext *, V9fsPath *, const char *,
130 int, FsCred *, V9fsFidOpenState *);
131 void (*rewinddir)(FsContext *, V9fsFidOpenState *);
132 off_t (*telldir)(FsContext *, V9fsFidOpenState *);
Greg Kurz635324e2016-06-06 11:52:34 +0200133 struct dirent * (*readdir)(FsContext *, V9fsFidOpenState *);
Aneesh Kumar K.Vcc720dd2011-10-25 12:10:40 +0530134 void (*seekdir)(FsContext *, V9fsFidOpenState *, off_t);
135 ssize_t (*preadv)(FsContext *, V9fsFidOpenState *,
136 const struct iovec *, int, off_t);
137 ssize_t (*pwritev)(FsContext *, V9fsFidOpenState *,
138 const struct iovec *, int, off_t);
Aneesh Kumar K.V2289be12011-09-09 15:14:18 +0530139 int (*mkdir)(FsContext *, V9fsPath *, const char *, FsCred *);
Aneesh Kumar K.V8b888272011-12-04 22:35:28 +0530140 int (*fstat)(FsContext *, int, V9fsFidOpenState *, struct stat *);
Anthony Liguori8cf89e02010-04-29 17:45:00 +0530141 int (*rename)(FsContext *, const char *, const char *);
Aneesh Kumar K.V2289be12011-09-09 15:14:18 +0530142 int (*truncate)(FsContext *, V9fsPath *, off_t);
Aneesh Kumar K.V8b888272011-12-04 22:35:28 +0530143 int (*fsync)(FsContext *, int, V9fsFidOpenState *, int);
Aneesh Kumar K.V2289be12011-09-09 15:14:18 +0530144 int (*statfs)(FsContext *s, V9fsPath *path, struct statfs *stbuf);
145 ssize_t (*lgetxattr)(FsContext *, V9fsPath *,
Aneesh Kumar K.Vfa32ef82010-09-02 11:09:06 +0530146 const char *, void *, size_t);
Aneesh Kumar K.V2289be12011-09-09 15:14:18 +0530147 ssize_t (*llistxattr)(FsContext *, V9fsPath *, void *, size_t);
148 int (*lsetxattr)(FsContext *, V9fsPath *,
Aneesh Kumar K.V10b468b2010-09-02 11:09:07 +0530149 const char *, void *, size_t, int);
Aneesh Kumar K.V2289be12011-09-09 15:14:18 +0530150 int (*lremovexattr)(FsContext *, V9fsPath *, const char *);
151 int (*name_to_path)(FsContext *, V9fsPath *, const char *, V9fsPath *);
152 int (*renameat)(FsContext *ctx, V9fsPath *olddir, const char *old_name,
153 V9fsPath *newdir, const char *new_name);
154 int (*unlinkat)(FsContext *ctx, V9fsPath *dir, const char *name, int flags);
Aneesh Kumar K.V99519f02011-12-14 13:48:59 +0530155};
Aneesh Kumar K.Vfc221182010-10-18 15:28:16 +0530156
Gautham R Shenoy74db9202010-04-29 17:44:43 +0530157#endif