[mirror_qemu.git] / hw / 9pfs / 9p.h

#ifndef _QEMU_9P_H
#define _QEMU_9P_H

#include <sys/types.h>
#include <dirent.h>
#include <sys/time.h>
#include <utime.h>
#include <sys/resource.h>
#include <glib.h>
#include "standard-headers/linux/virtio_9p.h"
#include "hw/virtio/virtio.h"
#include "fsdev/file-op-9p.h"
#include "fsdev/9p-iov-marshal.h"
#include "qemu/thread.h"
#include "qemu/coroutine.h"

enum {
    P9_TLERROR = 6,
    P9_RLERROR,
    P9_TSTATFS = 8,
    P9_RSTATFS,
    P9_TLOPEN = 12,
    P9_RLOPEN,
    P9_TLCREATE = 14,
    P9_RLCREATE,
    P9_TSYMLINK = 16,
    P9_RSYMLINK,
    P9_TMKNOD = 18,
    P9_RMKNOD,
    P9_TRENAME = 20,
    P9_RRENAME,
    P9_TREADLINK = 22,
    P9_RREADLINK,
    P9_TGETATTR = 24,
    P9_RGETATTR,
    P9_TSETATTR = 26,
    P9_RSETATTR,
    P9_TXATTRWALK = 30,
    P9_RXATTRWALK,
    P9_TXATTRCREATE = 32,
    P9_RXATTRCREATE,
    P9_TREADDIR = 40,
    P9_RREADDIR,
    P9_TFSYNC = 50,
    P9_RFSYNC,
    P9_TLOCK = 52,
    P9_RLOCK,
    P9_TGETLOCK = 54,
    P9_RGETLOCK,
    P9_TLINK = 70,
    P9_RLINK,
    P9_TMKDIR = 72,
    P9_RMKDIR,
    P9_TRENAMEAT = 74,
    P9_RRENAMEAT,
    P9_TUNLINKAT = 76,
    P9_RUNLINKAT,
    P9_TVERSION = 100,
    P9_RVERSION,
    P9_TAUTH = 102,
    P9_RAUTH,
    P9_TATTACH = 104,
    P9_RATTACH,
    P9_TERROR = 106,
    P9_RERROR,
    P9_TFLUSH = 108,
    P9_RFLUSH,
    P9_TWALK = 110,
    P9_RWALK,
    P9_TOPEN = 112,
    P9_ROPEN,
    P9_TCREATE = 114,
    P9_RCREATE,
    P9_TREAD = 116,
    P9_RREAD,
    P9_TWRITE = 118,
    P9_RWRITE,
    P9_TCLUNK = 120,
    P9_RCLUNK,
    P9_TREMOVE = 122,
    P9_RREMOVE,
    P9_TSTAT = 124,
    P9_RSTAT,
    P9_TWSTAT = 126,
    P9_RWSTAT,
};


/* qid.types */
enum {
    P9_QTDIR = 0x80,
    P9_QTAPPEND = 0x40,
    P9_QTEXCL = 0x20,
    P9_QTMOUNT = 0x10,
    P9_QTAUTH = 0x08,
    P9_QTTMP = 0x04,
    P9_QTSYMLINK = 0x02,
    P9_QTLINK = 0x01,
    P9_QTFILE = 0x00,
};

enum p9_proto_version {
    V9FS_PROTO_2000U = 0x01,
    V9FS_PROTO_2000L = 0x02,
};

#define P9_NOTAG    (u16)(~0)
#define P9_NOFID    (u32)(~0)
#define P9_MAXWELEM 16

#define FID_REFERENCED          0x1
#define FID_NON_RECLAIMABLE     0x2
static inline char *rpath(FsContext *ctx, const char *path)
{
    return g_strdup_printf("%s/%s", ctx->fs_root, path);
}

/*
 * ample room for Twrite/Rread header
 * size[4] Tread/Twrite tag[2] fid[4] offset[8] count[4]
 */
#define P9_IOHDRSZ 24

typedef struct V9fsPDU V9fsPDU;
struct V9fsState;

struct V9fsPDU
{
    uint32_t size;
    uint16_t tag;
    uint8_t id;
    uint8_t cancelled;
    CoQueue complete;
    VirtQueueElement elem;
    struct V9fsState *s;
    QLIST_ENTRY(V9fsPDU) next;
};


/* FIXME
 * 1) change user needs to set groups and stuff
 */

#define MAX_REQ         128
#define MAX_TAG_LEN     32

#define BUG_ON(cond) assert(!(cond))

typedef struct V9fsFidState V9fsFidState;

enum {
    P9_FID_NONE = 0,
    P9_FID_FILE,
    P9_FID_DIR,
    P9_FID_XATTR,
};

typedef struct V9fsConf
{
    /* tag name for the device */
    char *tag;
    char *fsdev_id;
} V9fsConf;

typedef struct V9fsXattr
{
    int64_t copied_len;
    int64_t len;
    void *value;
    V9fsString name;
    int flags;
} V9fsXattr;

/*
 * Filled by fs driver on open and other
 * calls.
 */
union V9fsFidOpenState {
    int fd;
    DIR *dir;
    V9fsXattr xattr;
    /*
     * private pointer for fs drivers, that
     * have its own internal representation of
     * open files.
     */
    void *private;
};

struct V9fsFidState
{
    int fid_type;
    int32_t fid;
    V9fsPath path;
    V9fsFidOpenState fs;
    V9fsFidOpenState fs_reclaim;
    int flags;
    int open_flags;
    uid_t uid;
    int ref;
    int clunked;
    V9fsFidState *next;
    V9fsFidState *rclm_lst;
};

typedef struct V9fsState
{
    VirtIODevice parent_obj;
    VirtQueue *vq;
    V9fsPDU pdus[MAX_REQ];
    QLIST_HEAD(, V9fsPDU) free_list;
    QLIST_HEAD(, V9fsPDU) active_list;
    V9fsFidState *fid_list;
    FileOperations *ops;
    FsContext ctx;
    char *tag;
    size_t config_size;
    enum p9_proto_version proto_version;
    int32_t msize;
    /*
     * lock ensuring atomic path update
     * on rename.
     */
    CoRwlock rename_lock;
    int32_t root_fid;
    Error *migration_blocker;
    V9fsConf fsconf;
} V9fsState;

/* 9p2000.L open flags */
#define P9_DOTL_RDONLY        00000000
#define P9_DOTL_WRONLY        00000001
#define P9_DOTL_RDWR          00000002
#define P9_DOTL_NOACCESS      00000003
#define P9_DOTL_CREATE        00000100
#define P9_DOTL_EXCL          00000200
#define P9_DOTL_NOCTTY        00000400
#define P9_DOTL_TRUNC         00001000
#define P9_DOTL_APPEND        00002000
#define P9_DOTL_NONBLOCK      00004000
#define P9_DOTL_DSYNC         00010000
#define P9_DOTL_FASYNC        00020000
#define P9_DOTL_DIRECT        00040000
#define P9_DOTL_LARGEFILE     00100000
#define P9_DOTL_DIRECTORY     00200000
#define P9_DOTL_NOFOLLOW      00400000
#define P9_DOTL_NOATIME       01000000
#define P9_DOTL_CLOEXEC       02000000
#define P9_DOTL_SYNC          04000000

/* 9p2000.L at flags */
#define P9_DOTL_AT_REMOVEDIR         0x200

/* 9P2000.L lock type */
#define P9_LOCK_TYPE_RDLCK 0
#define P9_LOCK_TYPE_WRLCK 1
#define P9_LOCK_TYPE_UNLCK 2

#define P9_LOCK_SUCCESS 0
#define P9_LOCK_BLOCKED 1
#define P9_LOCK_ERROR 2
#define P9_LOCK_GRACE 3

#define P9_LOCK_FLAGS_BLOCK 1
#define P9_LOCK_FLAGS_RECLAIM 2

typedef struct V9fsFlock
{
    uint8_t type;
    uint32_t flags;
    uint64_t start; /* absolute offset */
    uint64_t length;
    uint32_t proc_id;
    V9fsString client_id;
} V9fsFlock;

typedef struct V9fsGetlock
{
    uint8_t type;
    uint64_t start; /* absolute offset */
    uint64_t length;
    uint32_t proc_id;
    V9fsString client_id;
} V9fsGetlock;

extern int open_fd_hw;
extern int total_open_fd;

static inline void v9fs_path_write_lock(V9fsState *s)
{
    if (s->ctx.export_flags & V9FS_PATHNAME_FSCONTEXT) {
        qemu_co_rwlock_wrlock(&s->rename_lock);
    }
}

static inline void v9fs_path_read_lock(V9fsState *s)
{
    if (s->ctx.export_flags & V9FS_PATHNAME_FSCONTEXT) {
        qemu_co_rwlock_rdlock(&s->rename_lock);
    }
}

static inline void v9fs_path_unlock(V9fsState *s)
{
    if (s->ctx.export_flags & V9FS_PATHNAME_FSCONTEXT) {
        qemu_co_rwlock_unlock(&s->rename_lock);
    }
}

static inline uint8_t v9fs_request_cancelled(V9fsPDU *pdu)
{
    return pdu->cancelled;
}

extern void v9fs_reclaim_fd(V9fsPDU *pdu);
extern void v9fs_path_init(V9fsPath *path);
extern void v9fs_path_free(V9fsPath *path);
extern void v9fs_path_copy(V9fsPath *lhs, V9fsPath *rhs);
extern int v9fs_name_to_path(V9fsState *s, V9fsPath *dirpath,
                             const char *name, V9fsPath *path);

ssize_t pdu_marshal(V9fsPDU *pdu, size_t offset, const char *fmt, ...);
ssize_t pdu_unmarshal(V9fsPDU *pdu, size_t offset, const char *fmt, ...);

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