xref: /openbmc/qemu/fsdev/file-op-9p.h (revision 8779fccb)
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 
21 #define SM_LOCAL_MODE_BITS    0600
22 #define SM_LOCAL_DIR_MODE_BITS    0700
23 
24 typedef struct FsCred
25 {
26     uid_t   fc_uid;
27     gid_t   fc_gid;
28     mode_t  fc_mode;
29     dev_t   fc_rdev;
30 } FsCred;
31 
32 struct xattr_operations;
33 struct FsContext;
34 struct V9fsPath;
35 
36 typedef struct extended_ops {
37     int (*get_st_gen)(struct FsContext *, struct V9fsPath *,
38                       mode_t, uint64_t *);
39 } extended_ops;
40 
41 /* export flags */
42 #define V9FS_IMMEDIATE_WRITEOUT     0x00000001
43 #define V9FS_PATHNAME_FSCONTEXT     0x00000002
44 /*
45  * uid/gid set on fileserver files
46  */
47 #define V9FS_SM_PASSTHROUGH         0x00000004
48 /*
49  * uid/gid part of xattr
50  */
51 #define V9FS_SM_MAPPED              0x00000008
52 /*
53  * Server will try to set uid/gid.
54  * On failure ignore the error.
55  */
56 #define V9FS_SM_NONE                0x00000010
57 /*
58  * uid/gid part of .virtfs_meatadata namespace
59  */
60 #define V9FS_SM_MAPPED_FILE         0x00000020
61 #define V9FS_RDONLY                 0x00000040
62 #define V9FS_PROXY_SOCK_FD          0x00000080
63 #define V9FS_PROXY_SOCK_NAME        0x00000100
64 
65 #define V9FS_SEC_MASK               0x0000003C
66 
67 
68 typedef struct FileOperations FileOperations;
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 } FsDriverEntry;
78 
79 typedef struct FsContext
80 {
81     uid_t uid;
82     char *fs_root;
83     int export_flags;
84     struct xattr_operations **xops;
85     struct extended_ops exops;
86     /* fs driver specific data */
87     void *private;
88 } FsContext;
89 
90 typedef struct V9fsPath {
91     uint16_t size;
92     char *data;
93 } V9fsPath;
94 
95 typedef union V9fsFidOpenState V9fsFidOpenState;
96 
97 void cred_init(FsCred *);
98 
99 struct FileOperations
100 {
101     int (*parse_opts)(QemuOpts *, struct FsDriverEntry *);
102     int (*init)(struct FsContext *);
103     void (*cleanup)(struct FsContext *);
104     int (*lstat)(FsContext *, V9fsPath *, struct stat *);
105     ssize_t (*readlink)(FsContext *, V9fsPath *, char *, size_t);
106     int (*chmod)(FsContext *, V9fsPath *, FsCred *);
107     int (*chown)(FsContext *, V9fsPath *, FsCred *);
108     int (*mknod)(FsContext *, V9fsPath *, const char *, FsCred *);
109     int (*utimensat)(FsContext *, V9fsPath *, const struct timespec *);
110     int (*remove)(FsContext *, const char *);
111     int (*symlink)(FsContext *, const char *, V9fsPath *,
112                    const char *, FsCred *);
113     int (*link)(FsContext *, V9fsPath *, V9fsPath *, const char *);
114     int (*setuid)(FsContext *, uid_t);
115     int (*close)(FsContext *, V9fsFidOpenState *);
116     int (*closedir)(FsContext *, V9fsFidOpenState *);
117     int (*opendir)(FsContext *, V9fsPath *, V9fsFidOpenState *);
118     int (*open)(FsContext *, V9fsPath *, int, V9fsFidOpenState *);
119     int (*open2)(FsContext *, V9fsPath *, const char *,
120                  int, FsCred *, V9fsFidOpenState *);
121     void (*rewinddir)(FsContext *, V9fsFidOpenState *);
122     off_t (*telldir)(FsContext *, V9fsFidOpenState *);
123     struct dirent * (*readdir)(FsContext *, V9fsFidOpenState *);
124     void (*seekdir)(FsContext *, V9fsFidOpenState *, off_t);
125     ssize_t (*preadv)(FsContext *, V9fsFidOpenState *,
126                       const struct iovec *, int, off_t);
127     ssize_t (*pwritev)(FsContext *, V9fsFidOpenState *,
128                        const struct iovec *, int, off_t);
129     int (*mkdir)(FsContext *, V9fsPath *, const char *, FsCred *);
130     int (*fstat)(FsContext *, int, V9fsFidOpenState *, struct stat *);
131     int (*rename)(FsContext *, const char *, const char *);
132     int (*truncate)(FsContext *, V9fsPath *, off_t);
133     int (*fsync)(FsContext *, int, V9fsFidOpenState *, int);
134     int (*statfs)(FsContext *s, V9fsPath *path, struct statfs *stbuf);
135     ssize_t (*lgetxattr)(FsContext *, V9fsPath *,
136                          const char *, void *, size_t);
137     ssize_t (*llistxattr)(FsContext *, V9fsPath *, void *, size_t);
138     int (*lsetxattr)(FsContext *, V9fsPath *,
139                      const char *, void *, size_t, int);
140     int (*lremovexattr)(FsContext *, V9fsPath *, const char *);
141     int (*name_to_path)(FsContext *, V9fsPath *, const char *, V9fsPath *);
142     int (*renameat)(FsContext *ctx, V9fsPath *olddir, const char *old_name,
143                     V9fsPath *newdir, const char *new_name);
144     int (*unlinkat)(FsContext *ctx, V9fsPath *dir, const char *name, int flags);
145     void *opaque;
146 };
147 
148 #endif
149