xref: /openbmc/qemu/hw/9pfs/9p.h (revision af8b38b0d1878950d27156fd350e5457fd8a15a1)
1 #ifndef _QEMU_9P_H
2 #define _QEMU_9P_H
3 
4 #include <dirent.h>
5 #include <utime.h>
6 #include <sys/resource.h>
7 #include <glib.h>
8 #include "fsdev/file-op-9p.h"
9 #include "fsdev/9p-iov-marshal.h"
10 #include "qemu/thread.h"
11 #include "qemu/coroutine.h"
12 
13 enum {
14     P9_TLERROR = 6,
15     P9_RLERROR,
16     P9_TSTATFS = 8,
17     P9_RSTATFS,
18     P9_TLOPEN = 12,
19     P9_RLOPEN,
20     P9_TLCREATE = 14,
21     P9_RLCREATE,
22     P9_TSYMLINK = 16,
23     P9_RSYMLINK,
24     P9_TMKNOD = 18,
25     P9_RMKNOD,
26     P9_TRENAME = 20,
27     P9_RRENAME,
28     P9_TREADLINK = 22,
29     P9_RREADLINK,
30     P9_TGETATTR = 24,
31     P9_RGETATTR,
32     P9_TSETATTR = 26,
33     P9_RSETATTR,
34     P9_TXATTRWALK = 30,
35     P9_RXATTRWALK,
36     P9_TXATTRCREATE = 32,
37     P9_RXATTRCREATE,
38     P9_TREADDIR = 40,
39     P9_RREADDIR,
40     P9_TFSYNC = 50,
41     P9_RFSYNC,
42     P9_TLOCK = 52,
43     P9_RLOCK,
44     P9_TGETLOCK = 54,
45     P9_RGETLOCK,
46     P9_TLINK = 70,
47     P9_RLINK,
48     P9_TMKDIR = 72,
49     P9_RMKDIR,
50     P9_TRENAMEAT = 74,
51     P9_RRENAMEAT,
52     P9_TUNLINKAT = 76,
53     P9_RUNLINKAT,
54     P9_TVERSION = 100,
55     P9_RVERSION,
56     P9_TAUTH = 102,
57     P9_RAUTH,
58     P9_TATTACH = 104,
59     P9_RATTACH,
60     P9_TERROR = 106,
61     P9_RERROR,
62     P9_TFLUSH = 108,
63     P9_RFLUSH,
64     P9_TWALK = 110,
65     P9_RWALK,
66     P9_TOPEN = 112,
67     P9_ROPEN,
68     P9_TCREATE = 114,
69     P9_RCREATE,
70     P9_TREAD = 116,
71     P9_RREAD,
72     P9_TWRITE = 118,
73     P9_RWRITE,
74     P9_TCLUNK = 120,
75     P9_RCLUNK,
76     P9_TREMOVE = 122,
77     P9_RREMOVE,
78     P9_TSTAT = 124,
79     P9_RSTAT,
80     P9_TWSTAT = 126,
81     P9_RWSTAT,
82 };
83 
84 
85 /* qid.types */
86 enum {
87     P9_QTDIR = 0x80,
88     P9_QTAPPEND = 0x40,
89     P9_QTEXCL = 0x20,
90     P9_QTMOUNT = 0x10,
91     P9_QTAUTH = 0x08,
92     P9_QTTMP = 0x04,
93     P9_QTSYMLINK = 0x02,
94     P9_QTLINK = 0x01,
95     P9_QTFILE = 0x00,
96 };
97 
98 enum p9_proto_version {
99     V9FS_PROTO_2000U = 0x01,
100     V9FS_PROTO_2000L = 0x02,
101 };
102 
103 #define P9_NOTAG    (u16)(~0)
104 #define P9_NOFID    (u32)(~0)
105 #define P9_MAXWELEM 16
106 
107 #define FID_REFERENCED          0x1
108 #define FID_NON_RECLAIMABLE     0x2
109 static inline char *rpath(FsContext *ctx, const char *path)
110 {
111     return g_strdup_printf("%s/%s", ctx->fs_root, path);
112 }
113 
114 /*
115  * ample room for Twrite/Rread header
116  * size[4] Tread/Twrite tag[2] fid[4] offset[8] count[4]
117  */
118 #define P9_IOHDRSZ 24
119 
120 typedef struct V9fsPDU V9fsPDU;
121 struct V9fsState;
122 
123 struct V9fsPDU
124 {
125     uint32_t size;
126     uint16_t tag;
127     uint8_t id;
128     uint8_t cancelled;
129     CoQueue complete;
130     struct V9fsState *s;
131     QLIST_ENTRY(V9fsPDU) next;
132     uint32_t idx;
133 };
134 
135 
136 /* FIXME
137  * 1) change user needs to set groups and stuff
138  */
139 
140 #define MAX_REQ         128
141 #define MAX_TAG_LEN     32
142 
143 #define BUG_ON(cond) assert(!(cond))
144 
145 typedef struct V9fsFidState V9fsFidState;
146 
147 enum {
148     P9_FID_NONE = 0,
149     P9_FID_FILE,
150     P9_FID_DIR,
151     P9_FID_XATTR,
152 };
153 
154 typedef struct V9fsConf
155 {
156     /* tag name for the device */
157     char *tag;
158     char *fsdev_id;
159 } V9fsConf;
160 
161 typedef struct V9fsXattr
162 {
163     int64_t copied_len;
164     int64_t len;
165     void *value;
166     V9fsString name;
167     int flags;
168 } V9fsXattr;
169 
170 /*
171  * Filled by fs driver on open and other
172  * calls.
173  */
174 union V9fsFidOpenState {
175     int fd;
176     DIR *dir;
177     V9fsXattr xattr;
178     /*
179      * private pointer for fs drivers, that
180      * have its own internal representation of
181      * open files.
182      */
183     void *private;
184 };
185 
186 struct V9fsFidState
187 {
188     int fid_type;
189     int32_t fid;
190     V9fsPath path;
191     V9fsFidOpenState fs;
192     V9fsFidOpenState fs_reclaim;
193     int flags;
194     int open_flags;
195     uid_t uid;
196     int ref;
197     int clunked;
198     V9fsFidState *next;
199     V9fsFidState *rclm_lst;
200 };
201 
202 typedef struct V9fsState
203 {
204     QLIST_HEAD(, V9fsPDU) free_list;
205     QLIST_HEAD(, V9fsPDU) active_list;
206     V9fsFidState *fid_list;
207     FileOperations *ops;
208     FsContext ctx;
209     char *tag;
210     enum p9_proto_version proto_version;
211     int32_t msize;
212     /*
213      * lock ensuring atomic path update
214      * on rename.
215      */
216     CoRwlock rename_lock;
217     int32_t root_fid;
218     Error *migration_blocker;
219     V9fsConf fsconf;
220 } V9fsState;
221 
222 /* 9p2000.L open flags */
223 #define P9_DOTL_RDONLY        00000000
224 #define P9_DOTL_WRONLY        00000001
225 #define P9_DOTL_RDWR          00000002
226 #define P9_DOTL_NOACCESS      00000003
227 #define P9_DOTL_CREATE        00000100
228 #define P9_DOTL_EXCL          00000200
229 #define P9_DOTL_NOCTTY        00000400
230 #define P9_DOTL_TRUNC         00001000
231 #define P9_DOTL_APPEND        00002000
232 #define P9_DOTL_NONBLOCK      00004000
233 #define P9_DOTL_DSYNC         00010000
234 #define P9_DOTL_FASYNC        00020000
235 #define P9_DOTL_DIRECT        00040000
236 #define P9_DOTL_LARGEFILE     00100000
237 #define P9_DOTL_DIRECTORY     00200000
238 #define P9_DOTL_NOFOLLOW      00400000
239 #define P9_DOTL_NOATIME       01000000
240 #define P9_DOTL_CLOEXEC       02000000
241 #define P9_DOTL_SYNC          04000000
242 
243 /* 9p2000.L at flags */
244 #define P9_DOTL_AT_REMOVEDIR         0x200
245 
246 /* 9P2000.L lock type */
247 #define P9_LOCK_TYPE_RDLCK 0
248 #define P9_LOCK_TYPE_WRLCK 1
249 #define P9_LOCK_TYPE_UNLCK 2
250 
251 #define P9_LOCK_SUCCESS 0
252 #define P9_LOCK_BLOCKED 1
253 #define P9_LOCK_ERROR 2
254 #define P9_LOCK_GRACE 3
255 
256 #define P9_LOCK_FLAGS_BLOCK 1
257 #define P9_LOCK_FLAGS_RECLAIM 2
258 
259 typedef struct V9fsFlock
260 {
261     uint8_t type;
262     uint32_t flags;
263     uint64_t start; /* absolute offset */
264     uint64_t length;
265     uint32_t proc_id;
266     V9fsString client_id;
267 } V9fsFlock;
268 
269 typedef struct V9fsGetlock
270 {
271     uint8_t type;
272     uint64_t start; /* absolute offset */
273     uint64_t length;
274     uint32_t proc_id;
275     V9fsString client_id;
276 } V9fsGetlock;
277 
278 extern int open_fd_hw;
279 extern int total_open_fd;
280 
281 static inline void v9fs_path_write_lock(V9fsState *s)
282 {
283     if (s->ctx.export_flags & V9FS_PATHNAME_FSCONTEXT) {
284         qemu_co_rwlock_wrlock(&s->rename_lock);
285     }
286 }
287 
288 static inline void v9fs_path_read_lock(V9fsState *s)
289 {
290     if (s->ctx.export_flags & V9FS_PATHNAME_FSCONTEXT) {
291         qemu_co_rwlock_rdlock(&s->rename_lock);
292     }
293 }
294 
295 static inline void v9fs_path_unlock(V9fsState *s)
296 {
297     if (s->ctx.export_flags & V9FS_PATHNAME_FSCONTEXT) {
298         qemu_co_rwlock_unlock(&s->rename_lock);
299     }
300 }
301 
302 static inline uint8_t v9fs_request_cancelled(V9fsPDU *pdu)
303 {
304     return pdu->cancelled;
305 }
306 
307 extern void v9fs_reclaim_fd(V9fsPDU *pdu);
308 extern void v9fs_path_init(V9fsPath *path);
309 extern void v9fs_path_free(V9fsPath *path);
310 extern void v9fs_path_copy(V9fsPath *lhs, V9fsPath *rhs);
311 extern int v9fs_name_to_path(V9fsState *s, V9fsPath *dirpath,
312                              const char *name, V9fsPath *path);
313 extern int v9fs_device_realize_common(V9fsState *s, Error **errp);
314 extern void v9fs_device_unrealize_common(V9fsState *s, Error **errp);
315 
316 ssize_t pdu_marshal(V9fsPDU *pdu, size_t offset, const char *fmt, ...);
317 ssize_t pdu_unmarshal(V9fsPDU *pdu, size_t offset, const char *fmt, ...);
318 V9fsPDU *pdu_alloc(V9fsState *s);
319 void pdu_free(V9fsPDU *pdu);
320 void pdu_submit(V9fsPDU *pdu);
321 
322 #endif
323