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