]> git.proxmox.com Git - qemu.git/blame - hw/9pfs/virtio-9p.h
hw/9pfs: Abstract open state of fid to V9fsFidOpenState
[qemu.git] / hw / 9pfs / virtio-9p.h
CommitLineData
9f107513
AL
1#ifndef _QEMU_VIRTIO_9P_H
2#define _QEMU_VIRTIO_9P_H
3
4#include <sys/types.h>
5#include <dirent.h>
6#include <sys/time.h>
7#include <utime.h>
7a462745 8#include <sys/resource.h>
ff06030f 9#include "hw/virtio.h"
353ac78d 10#include "fsdev/file-op-9p.h"
02cb7f3a
AK
11#include "qemu-thread.h"
12#include "qemu-coroutine.h"
9f107513
AL
13
14/* The feature bitmap for virtio 9P */
15/* The mount point is specified in a config variable */
16#define VIRTIO_9P_MOUNT_TAG 0
17
18enum {
8f4d1ca5
AB
19 P9_TLERROR = 6,
20 P9_RLERROR,
be940c87
MK
21 P9_TSTATFS = 8,
22 P9_RSTATFS,
771e9d4c
MK
23 P9_TLOPEN = 12,
24 P9_RLOPEN,
c1568af5
VJJ
25 P9_TLCREATE = 14,
26 P9_RLCREATE,
08c60fc9
VJJ
27 P9_TSYMLINK = 16,
28 P9_RSYMLINK,
5268cecc
MK
29 P9_TMKNOD = 18,
30 P9_RMKNOD,
c7b4b0b3
MK
31 P9_TRENAME = 20,
32 P9_RRENAME,
df0973a4
MK
33 P9_TREADLINK = 22,
34 P9_RREADLINK,
00ede4c2
SK
35 P9_TGETATTR = 24,
36 P9_RGETATTR,
c79ce737
SK
37 P9_TSETATTR = 26,
38 P9_RSETATTR,
fa32ef88
AK
39 P9_TXATTRWALK = 30,
40 P9_RXATTRWALK,
10b468bd
AK
41 P9_TXATTRCREATE = 32,
42 P9_RXATTRCREATE,
c18e2f94
SK
43 P9_TREADDIR = 40,
44 P9_RREADDIR,
b41e95d3
VJJ
45 P9_TFSYNC = 50,
46 P9_RFSYNC,
82cc3ee8
MK
47 P9_TLOCK = 52,
48 P9_RLOCK,
8f354003
MK
49 P9_TGETLOCK = 54,
50 P9_RGETLOCK,
b2c224be
VJJ
51 P9_TLINK = 70,
52 P9_RLINK,
b67592ea
MK
53 P9_TMKDIR = 72,
54 P9_RMKDIR,
89bf6593
AK
55 P9_TRENAMEAT = 74,
56 P9_RRENAMEAT,
7834cf77
AK
57 P9_TUNLINKAT = 76,
58 P9_RUNLINKAT,
9f107513
AL
59 P9_TVERSION = 100,
60 P9_RVERSION,
61 P9_TAUTH = 102,
62 P9_RAUTH,
63 P9_TATTACH = 104,
64 P9_RATTACH,
65 P9_TERROR = 106,
66 P9_RERROR,
67 P9_TFLUSH = 108,
68 P9_RFLUSH,
69 P9_TWALK = 110,
70 P9_RWALK,
71 P9_TOPEN = 112,
72 P9_ROPEN,
73 P9_TCREATE = 114,
74 P9_RCREATE,
75 P9_TREAD = 116,
76 P9_RREAD,
77 P9_TWRITE = 118,
78 P9_RWRITE,
79 P9_TCLUNK = 120,
80 P9_RCLUNK,
81 P9_TREMOVE = 122,
82 P9_RREMOVE,
83 P9_TSTAT = 124,
84 P9_RSTAT,
85 P9_TWSTAT = 126,
86 P9_RWSTAT,
87};
88
89
90/* qid.types */
91enum {
92 P9_QTDIR = 0x80,
93 P9_QTAPPEND = 0x40,
94 P9_QTEXCL = 0x20,
95 P9_QTMOUNT = 0x10,
96 P9_QTAUTH = 0x08,
97 P9_QTTMP = 0x04,
98 P9_QTSYMLINK = 0x02,
99 P9_QTLINK = 0x01,
100 P9_QTFILE = 0x00,
101};
102
84151514
MK
103enum p9_proto_version {
104 V9FS_PROTO_2000U = 0x01,
105 V9FS_PROTO_2000L = 0x02,
106};
107
9f107513
AL
108#define P9_NOTAG (u16)(~0)
109#define P9_NOFID (u32)(~0)
110#define P9_MAXWELEM 16
7a462745
AK
111
112#define FID_REFERENCED 0x1
113#define FID_NON_RECLAIMABLE 0x2
faa44e3d
VJJ
114static inline const char *rpath(FsContext *ctx, const char *path, char *buffer)
115{
116 snprintf(buffer, PATH_MAX, "%s/%s", ctx->fs_root, path);
117 return buffer;
118}
9f107513 119
5e94c103
MK
120/*
121 * ample room for Twrite/Rread header
122 * size[4] Tread/Twrite tag[2] fid[4] offset[8] count[4]
123 */
124#define P9_IOHDRSZ 24
125
9f107513 126typedef struct V9fsPDU V9fsPDU;
ff06030f 127struct V9fsState;
9f107513
AL
128
129struct V9fsPDU
130{
131 uint32_t size;
132 uint16_t tag;
133 uint8_t id;
bccacf6c
AK
134 uint8_t cancelled;
135 CoQueue complete;
9f107513 136 VirtQueueElement elem;
ff06030f 137 struct V9fsState *s;
9f107513
AL
138 QLIST_ENTRY(V9fsPDU) next;
139};
140
141
142/* FIXME
143 * 1) change user needs to set groups and stuff
144 */
145
146/* from Linux's linux/virtio_9p.h */
147
148/* The ID for virtio console */
149#define VIRTIO_ID_9P 9
150#define MAX_REQ 128
151#define MAX_TAG_LEN 32
152
153#define BUG_ON(cond) assert(!(cond))
154
155typedef struct V9fsFidState V9fsFidState;
156
157typedef struct V9fsString
158{
159 int16_t size;
160 char *data;
161} V9fsString;
162
163typedef struct V9fsQID
164{
165 int8_t type;
166 int32_t version;
167 int64_t path;
168} V9fsQID;
169
170typedef struct V9fsStat
171{
172 int16_t size;
173 int16_t type;
174 int32_t dev;
175 V9fsQID qid;
176 int32_t mode;
177 int32_t atime;
178 int32_t mtime;
179 int64_t length;
180 V9fsString name;
181 V9fsString uid;
182 V9fsString gid;
183 V9fsString muid;
184 /* 9p2000.u */
185 V9fsString extension;
186 int32_t n_uid;
187 int32_t n_gid;
188 int32_t n_muid;
189} V9fsStat;
190
d62dbb51
AK
191enum {
192 P9_FID_NONE = 0,
193 P9_FID_FILE,
194 P9_FID_DIR,
195 P9_FID_XATTR,
196};
197
198typedef struct V9fsXattr
199{
200 int64_t copied_len;
201 int64_t len;
202 void *value;
203 V9fsString name;
204 int flags;
205} V9fsXattr;
206
cc720ddb
AK
207/*
208 * Filled by fs driver on open and other
209 * calls.
210 */
211union V9fsFidOpenState {
212 int fd;
213 DIR *dir;
214 V9fsXattr xattr;
215};
216
9f107513
AL
217struct V9fsFidState
218{
d62dbb51 219 int fid_type;
9f107513 220 int32_t fid;
2289be19 221 V9fsPath path;
cc720ddb
AK
222 V9fsFidOpenState fs;
223 V9fsFidOpenState fs_reclaim;
7a462745
AK
224 int flags;
225 int open_flags;
9f107513 226 uid_t uid;
84dfb926
AK
227 int ref;
228 int clunked;
9f107513 229 V9fsFidState *next;
7a462745 230 V9fsFidState *rclm_lst;
9f107513
AL
231};
232
233typedef struct V9fsState
234{
235 VirtIODevice vdev;
236 VirtQueue *vq;
237 V9fsPDU pdus[MAX_REQ];
238 QLIST_HEAD(, V9fsPDU) free_list;
bccacf6c 239 QLIST_HEAD(, V9fsPDU) active_list;
9f107513
AL
240 V9fsFidState *fid_list;
241 FileOperations *ops;
242 FsContext ctx;
243 uint16_t tag_len;
244 uint8_t *tag;
245 size_t config_size;
84151514 246 enum p9_proto_version proto_version;
5e94c103 247 int32_t msize;
02cb7f3a
AK
248 /*
249 * lock ensuring atomic path update
250 * on rename.
251 */
252 CoRwlock rename_lock;
9f107513
AL
253} V9fsState;
254
fac4f111
VJJ
255typedef struct V9fsStatState {
256 V9fsPDU *pdu;
257 size_t offset;
258 V9fsStat v9stat;
259 V9fsFidState *fidp;
260 struct stat stbuf;
261} V9fsStatState;
262
00ede4c2
SK
263typedef struct V9fsStatDotl {
264 uint64_t st_result_mask;
265 V9fsQID qid;
266 uint32_t st_mode;
267 uint32_t st_uid;
268 uint32_t st_gid;
269 uint64_t st_nlink;
270 uint64_t st_rdev;
271 uint64_t st_size;
272 uint64_t st_blksize;
273 uint64_t st_blocks;
274 uint64_t st_atime_sec;
275 uint64_t st_atime_nsec;
276 uint64_t st_mtime_sec;
277 uint64_t st_mtime_nsec;
278 uint64_t st_ctime_sec;
279 uint64_t st_ctime_nsec;
280 uint64_t st_btime_sec;
281 uint64_t st_btime_nsec;
282 uint64_t st_gen;
283 uint64_t st_data_version;
284} V9fsStatDotl;
285
fac4f111
VJJ
286typedef struct V9fsOpenState {
287 V9fsPDU *pdu;
288 size_t offset;
771e9d4c 289 int32_t mode;
fac4f111
VJJ
290 V9fsFidState *fidp;
291 V9fsQID qid;
292 struct stat stbuf;
5e94c103 293 int iounit;
fac4f111
VJJ
294} V9fsOpenState;
295
296typedef struct V9fsReadState {
297 V9fsPDU *pdu;
298 size_t offset;
299 int32_t count;
300 int32_t total;
301 int64_t off;
302 V9fsFidState *fidp;
303 struct iovec iov[128]; /* FIXME: bad, bad, bad */
304 struct iovec *sg;
305 off_t dir_pos;
306 struct dirent *dent;
307 struct stat stbuf;
308 V9fsString name;
309 V9fsStat v9stat;
310 int32_t len;
311 int32_t cnt;
312 int32_t max_count;
313} V9fsReadState;
314
315typedef struct V9fsWriteState {
316 V9fsPDU *pdu;
317 size_t offset;
318 int32_t len;
319 int32_t count;
320 int32_t total;
321 int64_t off;
322 V9fsFidState *fidp;
323 struct iovec iov[128]; /* FIXME: bad, bad, bad */
324 struct iovec *sg;
325 int cnt;
326} V9fsWriteState;
327
c79ce737
SK
328typedef struct V9fsIattr
329{
330 int32_t valid;
331 int32_t mode;
332 int32_t uid;
333 int32_t gid;
334 int64_t size;
335 int64_t atime_sec;
336 int64_t atime_nsec;
337 int64_t mtime_sec;
338 int64_t mtime_nsec;
339} V9fsIattr;
340
9f107513
AL
341struct virtio_9p_config
342{
343 /* number of characters in tag */
344 uint16_t tag_len;
345 /* Variable size tag name */
346 uint8_t tag[0];
541dc0d4 347} QEMU_PACKED;
9f107513 348
5268cecc
MK
349typedef struct V9fsMkState {
350 V9fsPDU *pdu;
351 size_t offset;
352 V9fsQID qid;
353 struct stat stbuf;
354 V9fsString name;
355 V9fsString fullname;
356} V9fsMkState;
357
9844081b
MK
358/* 9p2000.L open flags */
359#define P9_DOTL_RDONLY 00000000
360#define P9_DOTL_WRONLY 00000001
361#define P9_DOTL_RDWR 00000002
362#define P9_DOTL_NOACCESS 00000003
363#define P9_DOTL_CREATE 00000100
364#define P9_DOTL_EXCL 00000200
365#define P9_DOTL_NOCTTY 00000400
366#define P9_DOTL_TRUNC 00001000
367#define P9_DOTL_APPEND 00002000
368#define P9_DOTL_NONBLOCK 00004000
369#define P9_DOTL_DSYNC 00010000
370#define P9_DOTL_FASYNC 00020000
371#define P9_DOTL_DIRECT 00040000
372#define P9_DOTL_LARGEFILE 00100000
373#define P9_DOTL_DIRECTORY 00200000
374#define P9_DOTL_NOFOLLOW 00400000
375#define P9_DOTL_NOATIME 01000000
376#define P9_DOTL_CLOEXEC 02000000
377#define P9_DOTL_SYNC 04000000
378
379/* 9p2000.L at flags */
380#define P9_DOTL_AT_REMOVEDIR 0x200
381
ea60f315
MK
382/* 9P2000.L lock type */
383#define P9_LOCK_TYPE_RDLCK 0
384#define P9_LOCK_TYPE_WRLCK 1
385#define P9_LOCK_TYPE_UNLCK 2
386
82cc3ee8
MK
387#define P9_LOCK_SUCCESS 0
388#define P9_LOCK_BLOCKED 1
389#define P9_LOCK_ERROR 2
390#define P9_LOCK_GRACE 3
391
392#define P9_LOCK_FLAGS_BLOCK 1
393#define P9_LOCK_FLAGS_RECLAIM 2
394
395typedef struct V9fsFlock
396{
397 uint8_t type;
398 uint32_t flags;
399 uint64_t start; /* absolute offset */
400 uint64_t length;
401 uint32_t proc_id;
402 V9fsString client_id;
403} V9fsFlock;
404
8f354003
MK
405typedef struct V9fsGetlock
406{
407 uint8_t type;
408 uint64_t start; /* absolute offset */
409 uint64_t length;
410 uint32_t proc_id;
411 V9fsString client_id;
412} V9fsGetlock;
413
7a462745
AK
414extern int open_fd_hw;
415extern int total_open_fd;
416
64b85a8f
BS
417size_t pdu_packunpack(void *addr, struct iovec *sg, int sg_count,
418 size_t offset, size_t size, int pack);
9f107513
AL
419
420static inline size_t do_pdu_unpack(void *dst, struct iovec *sg, int sg_count,
421 size_t offset, size_t size)
422{
423 return pdu_packunpack(dst, sg, sg_count, offset, size, 0);
424}
425
532decb7
AK
426static inline void v9fs_path_write_lock(V9fsState *s)
427{
c98f1d4a 428 if (s->ctx.export_flags & V9FS_PATHNAME_FSCONTEXT) {
532decb7
AK
429 qemu_co_rwlock_wrlock(&s->rename_lock);
430 }
431}
432
433static inline void v9fs_path_read_lock(V9fsState *s)
434{
c98f1d4a 435 if (s->ctx.export_flags & V9FS_PATHNAME_FSCONTEXT) {
532decb7
AK
436 qemu_co_rwlock_rdlock(&s->rename_lock);
437 }
438}
439
440static inline void v9fs_path_unlock(V9fsState *s)
441{
c98f1d4a 442 if (s->ctx.export_flags & V9FS_PATHNAME_FSCONTEXT) {
532decb7
AK
443 qemu_co_rwlock_unlock(&s->rename_lock);
444 }
445}
446
bccacf6c
AK
447static inline uint8_t v9fs_request_cancelled(V9fsPDU *pdu)
448{
449 return pdu->cancelled;
450}
451
f4f61d27 452extern void handle_9p_output(VirtIODevice *vdev, VirtQueue *vq);
7a462745 453extern void virtio_9p_set_fd_limit(void);
bccacf6c 454extern void v9fs_reclaim_fd(V9fsPDU *pdu);
70c18fc0
AK
455extern void v9fs_string_init(V9fsString *str);
456extern void v9fs_string_free(V9fsString *str);
457extern void v9fs_string_null(V9fsString *str);
458extern void v9fs_string_sprintf(V9fsString *str, const char *fmt, ...);
459extern void v9fs_string_copy(V9fsString *lhs, V9fsString *rhs);
2289be19
AK
460extern void v9fs_path_init(V9fsPath *path);
461extern void v9fs_path_free(V9fsPath *path);
462extern void v9fs_path_copy(V9fsPath *lhs, V9fsPath *rhs);
463extern int v9fs_name_to_path(V9fsState *s, V9fsPath *dirpath,
464 const char *name, V9fsPath *path);
9f107513 465#endif