]>
Commit | Line | Data |
---|---|---|
2a6a4076 MA |
1 | #ifndef QEMU_9P_H |
2 | #define QEMU_9P_H | |
ebe74f8b | 3 | |
ebe74f8b | 4 | #include <dirent.h> |
ebe74f8b WL |
5 | #include <utime.h> |
6 | #include <sys/resource.h> | |
ebe74f8b WL |
7 | #include "fsdev/file-op-9p.h" |
8 | #include "fsdev/9p-iov-marshal.h" | |
9 | #include "qemu/thread.h" | |
10 | #include "qemu/coroutine.h" | |
11 | ||
12 | enum { | |
13 | P9_TLERROR = 6, | |
14 | P9_RLERROR, | |
15 | P9_TSTATFS = 8, | |
16 | P9_RSTATFS, | |
17 | P9_TLOPEN = 12, | |
18 | P9_RLOPEN, | |
19 | P9_TLCREATE = 14, | |
20 | P9_RLCREATE, | |
21 | P9_TSYMLINK = 16, | |
22 | P9_RSYMLINK, | |
23 | P9_TMKNOD = 18, | |
24 | P9_RMKNOD, | |
25 | P9_TRENAME = 20, | |
26 | P9_RRENAME, | |
27 | P9_TREADLINK = 22, | |
28 | P9_RREADLINK, | |
29 | P9_TGETATTR = 24, | |
30 | P9_RGETATTR, | |
31 | P9_TSETATTR = 26, | |
32 | P9_RSETATTR, | |
33 | P9_TXATTRWALK = 30, | |
34 | P9_RXATTRWALK, | |
35 | P9_TXATTRCREATE = 32, | |
36 | P9_RXATTRCREATE, | |
37 | P9_TREADDIR = 40, | |
38 | P9_RREADDIR, | |
39 | P9_TFSYNC = 50, | |
40 | P9_RFSYNC, | |
41 | P9_TLOCK = 52, | |
42 | P9_RLOCK, | |
43 | P9_TGETLOCK = 54, | |
44 | P9_RGETLOCK, | |
45 | P9_TLINK = 70, | |
46 | P9_RLINK, | |
47 | P9_TMKDIR = 72, | |
48 | P9_RMKDIR, | |
49 | P9_TRENAMEAT = 74, | |
50 | P9_RRENAMEAT, | |
51 | P9_TUNLINKAT = 76, | |
52 | P9_RUNLINKAT, | |
53 | P9_TVERSION = 100, | |
54 | P9_RVERSION, | |
55 | P9_TAUTH = 102, | |
56 | P9_RAUTH, | |
57 | P9_TATTACH = 104, | |
58 | P9_RATTACH, | |
59 | P9_TERROR = 106, | |
60 | P9_RERROR, | |
61 | P9_TFLUSH = 108, | |
62 | P9_RFLUSH, | |
63 | P9_TWALK = 110, | |
64 | P9_RWALK, | |
65 | P9_TOPEN = 112, | |
66 | P9_ROPEN, | |
67 | P9_TCREATE = 114, | |
68 | P9_RCREATE, | |
69 | P9_TREAD = 116, | |
70 | P9_RREAD, | |
71 | P9_TWRITE = 118, | |
72 | P9_RWRITE, | |
73 | P9_TCLUNK = 120, | |
74 | P9_RCLUNK, | |
75 | P9_TREMOVE = 122, | |
76 | P9_RREMOVE, | |
77 | P9_TSTAT = 124, | |
78 | P9_RSTAT, | |
79 | P9_TWSTAT = 126, | |
80 | P9_RWSTAT, | |
81 | }; | |
82 | ||
83 | ||
84 | /* qid.types */ | |
85 | enum { | |
86 | P9_QTDIR = 0x80, | |
87 | P9_QTAPPEND = 0x40, | |
88 | P9_QTEXCL = 0x20, | |
89 | P9_QTMOUNT = 0x10, | |
90 | P9_QTAUTH = 0x08, | |
91 | P9_QTTMP = 0x04, | |
92 | P9_QTSYMLINK = 0x02, | |
93 | P9_QTLINK = 0x01, | |
94 | P9_QTFILE = 0x00, | |
95 | }; | |
96 | ||
8e71b96c | 97 | typedef enum P9ProtoVersion { |
ebe74f8b WL |
98 | V9FS_PROTO_2000U = 0x01, |
99 | V9FS_PROTO_2000L = 0x02, | |
8e71b96c | 100 | } P9ProtoVersion; |
ebe74f8b | 101 | |
baecbde6 GK |
102 | #define P9_NOTAG UINT16_MAX |
103 | #define P9_NOFID UINT32_MAX | |
ebe74f8b WL |
104 | #define P9_MAXWELEM 16 |
105 | ||
106 | #define FID_REFERENCED 0x1 | |
107 | #define FID_NON_RECLAIMABLE 0x2 | |
108 | static inline char *rpath(FsContext *ctx, const char *path) | |
109 | { | |
110 | return g_strdup_printf("%s/%s", ctx->fs_root, path); | |
111 | } | |
112 | ||
113 | /* | |
114 | * ample room for Twrite/Rread header | |
115 | * size[4] Tread/Twrite tag[2] fid[4] offset[8] count[4] | |
116 | */ | |
117 | #define P9_IOHDRSZ 24 | |
118 | ||
119 | typedef struct V9fsPDU V9fsPDU; | |
21cf9edf | 120 | typedef struct V9fsState V9fsState; |
8e71b96c | 121 | typedef struct V9fsTransport V9fsTransport; |
ebe74f8b | 122 | |
c9fb47e7 SS |
123 | typedef struct { |
124 | uint32_t size_le; | |
125 | uint8_t id; | |
126 | uint16_t tag_le; | |
127 | } QEMU_PACKED P9MsgHeader; | |
a4d99854 GK |
128 | /* According to the specification, 9p messages start with a 7-byte header. |
129 | * Since most of the code uses this header size in literal form, we must be | |
130 | * sure this is indeed the case. | |
131 | */ | |
132 | QEMU_BUILD_BUG_ON(sizeof(P9MsgHeader) != 7); | |
c9fb47e7 | 133 | |
ebe74f8b WL |
134 | struct V9fsPDU |
135 | { | |
136 | uint32_t size; | |
137 | uint16_t tag; | |
138 | uint8_t id; | |
139 | uint8_t cancelled; | |
140 | CoQueue complete; | |
21cf9edf | 141 | V9fsState *s; |
ebe74f8b | 142 | QLIST_ENTRY(V9fsPDU) next; |
00588a0a | 143 | uint32_t idx; |
ebe74f8b WL |
144 | }; |
145 | ||
146 | ||
147 | /* FIXME | |
148 | * 1) change user needs to set groups and stuff | |
149 | */ | |
150 | ||
151 | #define MAX_REQ 128 | |
152 | #define MAX_TAG_LEN 32 | |
153 | ||
154 | #define BUG_ON(cond) assert(!(cond)) | |
155 | ||
156 | typedef struct V9fsFidState V9fsFidState; | |
157 | ||
158 | enum { | |
159 | P9_FID_NONE = 0, | |
160 | P9_FID_FILE, | |
161 | P9_FID_DIR, | |
162 | P9_FID_XATTR, | |
163 | }; | |
164 | ||
165 | typedef struct V9fsConf | |
166 | { | |
167 | /* tag name for the device */ | |
168 | char *tag; | |
169 | char *fsdev_id; | |
170 | } V9fsConf; | |
171 | ||
aca6897f KF |
172 | /* 9p2000.L xattr flags (matches Linux values) */ |
173 | #define P9_XATTR_CREATE 1 | |
174 | #define P9_XATTR_REPLACE 2 | |
175 | ||
ebe74f8b WL |
176 | typedef struct V9fsXattr |
177 | { | |
8495f9ad LQ |
178 | uint64_t copied_len; |
179 | uint64_t len; | |
ebe74f8b WL |
180 | void *value; |
181 | V9fsString name; | |
182 | int flags; | |
dd28fbbc | 183 | bool xattrwalk_fid; |
ebe74f8b WL |
184 | } V9fsXattr; |
185 | ||
f314ea4e GK |
186 | typedef struct V9fsDir { |
187 | DIR *stream; | |
7cde47d4 | 188 | QemuMutex readdir_mutex; |
f314ea4e GK |
189 | } V9fsDir; |
190 | ||
7cde47d4 GK |
191 | static inline void v9fs_readdir_lock(V9fsDir *dir) |
192 | { | |
193 | qemu_mutex_lock(&dir->readdir_mutex); | |
194 | } | |
195 | ||
196 | static inline void v9fs_readdir_unlock(V9fsDir *dir) | |
197 | { | |
198 | qemu_mutex_unlock(&dir->readdir_mutex); | |
199 | } | |
200 | ||
201 | static inline void v9fs_readdir_init(V9fsDir *dir) | |
202 | { | |
203 | qemu_mutex_init(&dir->readdir_mutex); | |
204 | } | |
205 | ||
ebe74f8b WL |
206 | /* |
207 | * Filled by fs driver on open and other | |
208 | * calls. | |
209 | */ | |
210 | union V9fsFidOpenState { | |
211 | int fd; | |
f314ea4e | 212 | V9fsDir dir; |
ebe74f8b WL |
213 | V9fsXattr xattr; |
214 | /* | |
215 | * private pointer for fs drivers, that | |
216 | * have its own internal representation of | |
217 | * open files. | |
218 | */ | |
219 | void *private; | |
220 | }; | |
221 | ||
222 | struct V9fsFidState | |
223 | { | |
224 | int fid_type; | |
225 | int32_t fid; | |
226 | V9fsPath path; | |
227 | V9fsFidOpenState fs; | |
228 | V9fsFidOpenState fs_reclaim; | |
229 | int flags; | |
230 | int open_flags; | |
231 | uid_t uid; | |
232 | int ref; | |
233 | int clunked; | |
234 | V9fsFidState *next; | |
235 | V9fsFidState *rclm_lst; | |
236 | }; | |
237 | ||
21cf9edf | 238 | struct V9fsState |
ebe74f8b | 239 | { |
ebe74f8b WL |
240 | QLIST_HEAD(, V9fsPDU) free_list; |
241 | QLIST_HEAD(, V9fsPDU) active_list; | |
242 | V9fsFidState *fid_list; | |
243 | FileOperations *ops; | |
244 | FsContext ctx; | |
245 | char *tag; | |
8e71b96c | 246 | P9ProtoVersion proto_version; |
ebe74f8b | 247 | int32_t msize; |
583f21f8 | 248 | V9fsPDU pdus[MAX_REQ]; |
8e71b96c | 249 | const V9fsTransport *transport; |
ebe74f8b WL |
250 | /* |
251 | * lock ensuring atomic path update | |
252 | * on rename. | |
253 | */ | |
254 | CoRwlock rename_lock; | |
255 | int32_t root_fid; | |
256 | Error *migration_blocker; | |
257 | V9fsConf fsconf; | |
56f101ec | 258 | V9fsQID root_qid; |
21cf9edf | 259 | }; |
ebe74f8b WL |
260 | |
261 | /* 9p2000.L open flags */ | |
262 | #define P9_DOTL_RDONLY 00000000 | |
263 | #define P9_DOTL_WRONLY 00000001 | |
264 | #define P9_DOTL_RDWR 00000002 | |
265 | #define P9_DOTL_NOACCESS 00000003 | |
266 | #define P9_DOTL_CREATE 00000100 | |
267 | #define P9_DOTL_EXCL 00000200 | |
268 | #define P9_DOTL_NOCTTY 00000400 | |
269 | #define P9_DOTL_TRUNC 00001000 | |
270 | #define P9_DOTL_APPEND 00002000 | |
271 | #define P9_DOTL_NONBLOCK 00004000 | |
272 | #define P9_DOTL_DSYNC 00010000 | |
273 | #define P9_DOTL_FASYNC 00020000 | |
274 | #define P9_DOTL_DIRECT 00040000 | |
275 | #define P9_DOTL_LARGEFILE 00100000 | |
276 | #define P9_DOTL_DIRECTORY 00200000 | |
277 | #define P9_DOTL_NOFOLLOW 00400000 | |
278 | #define P9_DOTL_NOATIME 01000000 | |
279 | #define P9_DOTL_CLOEXEC 02000000 | |
280 | #define P9_DOTL_SYNC 04000000 | |
281 | ||
282 | /* 9p2000.L at flags */ | |
283 | #define P9_DOTL_AT_REMOVEDIR 0x200 | |
284 | ||
285 | /* 9P2000.L lock type */ | |
286 | #define P9_LOCK_TYPE_RDLCK 0 | |
287 | #define P9_LOCK_TYPE_WRLCK 1 | |
288 | #define P9_LOCK_TYPE_UNLCK 2 | |
289 | ||
290 | #define P9_LOCK_SUCCESS 0 | |
291 | #define P9_LOCK_BLOCKED 1 | |
292 | #define P9_LOCK_ERROR 2 | |
293 | #define P9_LOCK_GRACE 3 | |
294 | ||
295 | #define P9_LOCK_FLAGS_BLOCK 1 | |
296 | #define P9_LOCK_FLAGS_RECLAIM 2 | |
297 | ||
298 | typedef struct V9fsFlock | |
299 | { | |
300 | uint8_t type; | |
301 | uint32_t flags; | |
302 | uint64_t start; /* absolute offset */ | |
303 | uint64_t length; | |
304 | uint32_t proc_id; | |
305 | V9fsString client_id; | |
306 | } V9fsFlock; | |
307 | ||
308 | typedef struct V9fsGetlock | |
309 | { | |
310 | uint8_t type; | |
311 | uint64_t start; /* absolute offset */ | |
312 | uint64_t length; | |
313 | uint32_t proc_id; | |
314 | V9fsString client_id; | |
315 | } V9fsGetlock; | |
316 | ||
317 | extern int open_fd_hw; | |
318 | extern int total_open_fd; | |
319 | ||
320 | static inline void v9fs_path_write_lock(V9fsState *s) | |
321 | { | |
322 | if (s->ctx.export_flags & V9FS_PATHNAME_FSCONTEXT) { | |
323 | qemu_co_rwlock_wrlock(&s->rename_lock); | |
324 | } | |
325 | } | |
326 | ||
327 | static inline void v9fs_path_read_lock(V9fsState *s) | |
328 | { | |
329 | if (s->ctx.export_flags & V9FS_PATHNAME_FSCONTEXT) { | |
330 | qemu_co_rwlock_rdlock(&s->rename_lock); | |
331 | } | |
332 | } | |
333 | ||
334 | static inline void v9fs_path_unlock(V9fsState *s) | |
335 | { | |
336 | if (s->ctx.export_flags & V9FS_PATHNAME_FSCONTEXT) { | |
337 | qemu_co_rwlock_unlock(&s->rename_lock); | |
338 | } | |
339 | } | |
340 | ||
341 | static inline uint8_t v9fs_request_cancelled(V9fsPDU *pdu) | |
342 | { | |
343 | return pdu->cancelled; | |
344 | } | |
345 | ||
8440e22e | 346 | void coroutine_fn v9fs_reclaim_fd(V9fsPDU *pdu); |
bc70a592 GK |
347 | void v9fs_path_init(V9fsPath *path); |
348 | void v9fs_path_free(V9fsPath *path); | |
349 | void v9fs_path_sprintf(V9fsPath *path, const char *fmt, ...); | |
e446a1eb | 350 | void v9fs_path_copy(V9fsPath *dst, const V9fsPath *src); |
bc70a592 GK |
351 | int v9fs_name_to_path(V9fsState *s, V9fsPath *dirpath, |
352 | const char *name, V9fsPath *path); | |
066eb006 GK |
353 | int v9fs_device_realize_common(V9fsState *s, const V9fsTransport *t, |
354 | Error **errp); | |
bc70a592 | 355 | void v9fs_device_unrealize_common(V9fsState *s, Error **errp); |
ebe74f8b | 356 | |
4b311c5f WL |
357 | V9fsPDU *pdu_alloc(V9fsState *s); |
358 | void pdu_free(V9fsPDU *pdu); | |
506f3275 | 359 | void pdu_submit(V9fsPDU *pdu, P9MsgHeader *hdr); |
0e44a0fd | 360 | void v9fs_reset(V9fsState *s); |
ebe74f8b | 361 | |
ea83441c SS |
362 | struct V9fsTransport { |
363 | ssize_t (*pdu_vmarshal)(V9fsPDU *pdu, size_t offset, const char *fmt, | |
364 | va_list ap); | |
365 | ssize_t (*pdu_vunmarshal)(V9fsPDU *pdu, size_t offset, const char *fmt, | |
366 | va_list ap); | |
88da0b03 SS |
367 | void (*init_in_iov_from_pdu)(V9fsPDU *pdu, struct iovec **piov, |
368 | unsigned int *pniov, size_t size); | |
369 | void (*init_out_iov_from_pdu)(V9fsPDU *pdu, struct iovec **piov, | |
8d37de41 | 370 | unsigned int *pniov, size_t size); |
ea83441c SS |
371 | void (*push_and_notify)(V9fsPDU *pdu); |
372 | }; | |
373 | ||
ebe74f8b | 374 | #endif |