xref: /openbmc/qemu/fsdev/file-op-9p.h (revision fe7f9b8e)
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 #define V9FS_SEC_MASK               0x0000003C
64 
65 
66 typedef struct FileOperations FileOperations;
67 typedef struct XattrOperations XattrOperations;
68 
69 /*
70  * Structure to store the various fsdev's passed through command line.
71  */
72 typedef struct FsDriverEntry {
73     char *fsdev_id;
74     char *path;
75     int export_flags;
76     FileOperations *ops;
77     FsThrottle fst;
78     mode_t fmode;
79     mode_t dmode;
80 } FsDriverEntry;
81 
82 struct FsContext {
83     uid_t uid;
84     char *fs_root;
85     int export_flags;
86     XattrOperations **xops;
87     ExtendedOps exops;
88     FsThrottle *fst;
89     /* fs driver specific data */
90     void *private;
91     mode_t fmode;
92     mode_t dmode;
93 };
94 
95 struct V9fsPath {
96     uint16_t size;
97     char *data;
98 };
99 
100 typedef union V9fsFidOpenState V9fsFidOpenState;
101 
102 void cred_init(FsCred *);
103 
104 struct FileOperations
105 {
106     int (*parse_opts)(QemuOpts *, FsDriverEntry *, Error **errp);
107     int (*init)(FsContext *, Error **errp);
108     void (*cleanup)(FsContext *);
109     int (*lstat)(FsContext *, V9fsPath *, struct stat *);
110     ssize_t (*readlink)(FsContext *, V9fsPath *, char *, size_t);
111     int (*chmod)(FsContext *, V9fsPath *, FsCred *);
112     int (*chown)(FsContext *, V9fsPath *, FsCred *);
113     int (*mknod)(FsContext *, V9fsPath *, const char *, FsCred *);
114     int (*utimensat)(FsContext *, V9fsPath *, const struct timespec *);
115     int (*remove)(FsContext *, const char *);
116     int (*symlink)(FsContext *, const char *, V9fsPath *,
117                    const char *, FsCred *);
118     int (*link)(FsContext *, V9fsPath *, V9fsPath *, const char *);
119     int (*setuid)(FsContext *, uid_t);
120     int (*close)(FsContext *, V9fsFidOpenState *);
121     int (*closedir)(FsContext *, V9fsFidOpenState *);
122     int (*opendir)(FsContext *, V9fsPath *, V9fsFidOpenState *);
123     int (*open)(FsContext *, V9fsPath *, int, V9fsFidOpenState *);
124     int (*open2)(FsContext *, V9fsPath *, const char *,
125                  int, FsCred *, V9fsFidOpenState *);
126     void (*rewinddir)(FsContext *, V9fsFidOpenState *);
127     off_t (*telldir)(FsContext *, V9fsFidOpenState *);
128     struct dirent * (*readdir)(FsContext *, V9fsFidOpenState *);
129     void (*seekdir)(FsContext *, V9fsFidOpenState *, off_t);
130     ssize_t (*preadv)(FsContext *, V9fsFidOpenState *,
131                       const struct iovec *, int, off_t);
132     ssize_t (*pwritev)(FsContext *, V9fsFidOpenState *,
133                        const struct iovec *, int, off_t);
134     int (*mkdir)(FsContext *, V9fsPath *, const char *, FsCred *);
135     int (*fstat)(FsContext *, int, V9fsFidOpenState *, struct stat *);
136     int (*rename)(FsContext *, const char *, const char *);
137     int (*truncate)(FsContext *, V9fsPath *, off_t);
138     int (*fsync)(FsContext *, int, V9fsFidOpenState *, int);
139     int (*statfs)(FsContext *s, V9fsPath *path, struct statfs *stbuf);
140     ssize_t (*lgetxattr)(FsContext *, V9fsPath *,
141                          const char *, void *, size_t);
142     ssize_t (*llistxattr)(FsContext *, V9fsPath *, void *, size_t);
143     int (*lsetxattr)(FsContext *, V9fsPath *,
144                      const char *, void *, size_t, int);
145     int (*lremovexattr)(FsContext *, V9fsPath *, const char *);
146     int (*name_to_path)(FsContext *, V9fsPath *, const char *, V9fsPath *);
147     int (*renameat)(FsContext *ctx, V9fsPath *olddir, const char *old_name,
148                     V9fsPath *newdir, const char *new_name);
149     int (*unlinkat)(FsContext *ctx, V9fsPath *dir, const char *name, int flags);
150     void *opaque;
151 };
152 
153 #endif
154