xref: /openbmc/qemu/fsdev/file-op-9p.h (revision e6e03dcf)
1 /*
2  * 9p
3  *
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  */
13 
14 #ifndef FILE_OP_9P_H
15 #define FILE_OP_9P_H
16 
17 #include <dirent.h>
18 #include <utime.h>
19 #include <sys/vfs.h>
20 #include "qemu-fsdev-throttle.h"
21 
22 #define SM_LOCAL_MODE_BITS    0600
23 #define SM_LOCAL_DIR_MODE_BITS    0700
24 
25 typedef struct FsCred {
26     uid_t   fc_uid;
27     gid_t   fc_gid;
28     mode_t  fc_mode;
29     dev_t   fc_rdev;
30 } FsCred;
31 
32 typedef struct FsContext FsContext;
33 typedef struct V9fsPath V9fsPath;
34 
35 typedef struct ExtendedOps {
36     int (*get_st_gen)(FsContext *, V9fsPath *, mode_t, uint64_t *);
37 } ExtendedOps;
38 
39 /* export flags */
40 #define V9FS_IMMEDIATE_WRITEOUT     0x00000001
41 #define V9FS_PATHNAME_FSCONTEXT     0x00000002
42 /*
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
55 /*
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
62 /*
63  * multidevs option (either one of the two applies exclusively)
64  */
65 #define V9FS_REMAP_INODES           0x00000200
66 #define V9FS_FORBID_MULTIDEVS       0x00000400
67 
68 #define V9FS_SEC_MASK               0x0000003C
69 
70 
71 typedef struct FileOperations FileOperations;
72 typedef struct XattrOperations XattrOperations;
73 
74 /*
75  * Structure to store the various fsdev's passed through command line.
76  */
77 typedef struct FsDriverEntry {
78     char *fsdev_id;
79     char *path;
80     int export_flags;
81     FileOperations *ops;
82     FsThrottle fst;
83     mode_t fmode;
84     mode_t dmode;
85 } FsDriverEntry;
86 
87 struct FsContext {
88     uid_t uid;
89     char *fs_root;
90     int export_flags;
91     XattrOperations **xops;
92     ExtendedOps exops;
93     FsThrottle *fst;
94     /* fs driver specific data */
95     void *private;
96     mode_t fmode;
97     mode_t dmode;
98 };
99 
100 struct V9fsPath {
101     uint16_t size;
102     char *data;
103 };
104 
105 typedef union V9fsFidOpenState V9fsFidOpenState;
106 
107 void cred_init(FsCred *);
108 
109 struct FileOperations
110 {
111     int (*parse_opts)(QemuOpts *, FsDriverEntry *, Error **errp);
112     int (*init)(FsContext *, Error **errp);
113     void (*cleanup)(FsContext *);
114     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 *);
120     int (*remove)(FsContext *, const char *);
121     int (*symlink)(FsContext *, const char *, V9fsPath *,
122                    const char *, FsCred *);
123     int (*link)(FsContext *, V9fsPath *, V9fsPath *, const char *);
124     int (*setuid)(FsContext *, uid_t);
125     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 *);
133     struct dirent * (*readdir)(FsContext *, V9fsFidOpenState *);
134     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);
139     int (*mkdir)(FsContext *, V9fsPath *, const char *, FsCred *);
140     int (*fstat)(FsContext *, int, V9fsFidOpenState *, struct stat *);
141     int (*rename)(FsContext *, const char *, const char *);
142     int (*truncate)(FsContext *, V9fsPath *, off_t);
143     int (*fsync)(FsContext *, int, V9fsFidOpenState *, int);
144     int (*statfs)(FsContext *s, V9fsPath *path, struct statfs *stbuf);
145     ssize_t (*lgetxattr)(FsContext *, V9fsPath *,
146                          const char *, void *, size_t);
147     ssize_t (*llistxattr)(FsContext *, V9fsPath *, void *, size_t);
148     int (*lsetxattr)(FsContext *, V9fsPath *,
149                      const char *, void *, size_t, int);
150     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);
155 };
156 
157 #endif
158