fs/9p: This patch implements TLCREATE for 9p2000.L protocol.
[linux-2.6.git] / include / net / 9p / 9p.h
1 /*
2  * include/net/9p/9p.h
3  *
4  * 9P protocol definitions.
5  *
6  *  Copyright (C) 2005 by Latchesar Ionkov <lucho@ionkov.net>
7  *  Copyright (C) 2004 by Eric Van Hensbergen <ericvh@gmail.com>
8  *  Copyright (C) 2002 by Ron Minnich <rminnich@lanl.gov>
9  *
10  *  This program is free software; you can redistribute it and/or modify
11  *  it under the terms of the GNU General Public License version 2
12  *  as published by the Free Software Foundation.
13  *
14  *  This program is distributed in the hope that it will be useful,
15  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
16  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  *  GNU General Public License for more details.
18  *
19  *  You should have received a copy of the GNU General Public License
20  *  along with this program; if not, write to:
21  *  Free Software Foundation
22  *  51 Franklin Street, Fifth Floor
23  *  Boston, MA  02111-1301  USA
24  *
25  */
26
27 #ifndef NET_9P_H
28 #define NET_9P_H
29
30 /**
31  * enum p9_debug_flags - bits for mount time debug parameter
32  * @P9_DEBUG_ERROR: more verbose error messages including original error string
33  * @P9_DEBUG_9P: 9P protocol tracing
34  * @P9_DEBUG_VFS: VFS API tracing
35  * @P9_DEBUG_CONV: protocol conversion tracing
36  * @P9_DEBUG_MUX: trace management of concurrent transactions
37  * @P9_DEBUG_TRANS: transport tracing
38  * @P9_DEBUG_SLABS: memory management tracing
39  * @P9_DEBUG_FCALL: verbose dump of protocol messages
40  * @P9_DEBUG_FID: fid allocation/deallocation tracking
41  * @P9_DEBUG_PKT: packet marshalling/unmarshalling
42  * @P9_DEBUG_FSC: FS-cache tracing
43  *
44  * These flags are passed at mount time to turn on various levels of
45  * verbosity and tracing which will be output to the system logs.
46  */
47
48 enum p9_debug_flags {
49         P9_DEBUG_ERROR =        (1<<0),
50         P9_DEBUG_9P =           (1<<2),
51         P9_DEBUG_VFS =          (1<<3),
52         P9_DEBUG_CONV =         (1<<4),
53         P9_DEBUG_MUX =          (1<<5),
54         P9_DEBUG_TRANS =        (1<<6),
55         P9_DEBUG_SLABS =        (1<<7),
56         P9_DEBUG_FCALL =        (1<<8),
57         P9_DEBUG_FID =          (1<<9),
58         P9_DEBUG_PKT =          (1<<10),
59         P9_DEBUG_FSC =          (1<<11),
60 };
61
62 #ifdef CONFIG_NET_9P_DEBUG
63 extern unsigned int p9_debug_level;
64
65 #define P9_DPRINTK(level, format, arg...) \
66 do {  \
67         if ((p9_debug_level & level) == level) {\
68                 if (level == P9_DEBUG_9P) \
69                         printk(KERN_NOTICE "(%8.8d) " \
70                         format , task_pid_nr(current) , ## arg); \
71                 else \
72                         printk(KERN_NOTICE "-- %s (%d): " \
73                         format , __func__, task_pid_nr(current) , ## arg); \
74         } \
75 } while (0)
76
77 #else
78 #define P9_DPRINTK(level, format, arg...)  do { } while (0)
79 #endif
80
81 #define P9_EPRINTK(level, format, arg...) \
82 do { \
83         printk(level "9p: %s (%d): " \
84                 format , __func__, task_pid_nr(current), ## arg); \
85 } while (0)
86
87 /**
88  * enum p9_msg_t - 9P message types
89  * @P9_TSTATFS: file system status request
90  * @P9_RSTATFS: file system status response
91  * @P9_TSYMLINK: make symlink request
92  * @P9_RSYMLINK: make symlink response
93  * @P9_TMKNOD: create a special file object request
94  * @P9_RMKNOD: create a special file object response
95  * @P9_TLCREATE: prepare a handle for I/O on an new file for 9P2000.L
96  * @P9_RLCREATE: response with file access information for 9P2000.L
97  * @P9_TRENAME: rename request
98  * @P9_RRENAME: rename response
99  * @P9_TMKDIR: create a directory request
100  * @P9_RMKDIR: create a directory response
101  * @P9_TVERSION: version handshake request
102  * @P9_RVERSION: version handshake response
103  * @P9_TAUTH: request to establish authentication channel
104  * @P9_RAUTH: response with authentication information
105  * @P9_TATTACH: establish user access to file service
106  * @P9_RATTACH: response with top level handle to file hierarchy
107  * @P9_TERROR: not used
108  * @P9_RERROR: response for any failed request
109  * @P9_TFLUSH: request to abort a previous request
110  * @P9_RFLUSH: response when previous request has been cancelled
111  * @P9_TWALK: descend a directory hierarchy
112  * @P9_RWALK: response with new handle for position within hierarchy
113  * @P9_TOPEN: prepare a handle for I/O on an existing file
114  * @P9_ROPEN: response with file access information
115  * @P9_TCREATE: prepare a handle for I/O on a new file
116  * @P9_RCREATE: response with file access information
117  * @P9_TREAD: request to transfer data from a file or directory
118  * @P9_RREAD: response with data requested
119  * @P9_TWRITE: reuqest to transfer data to a file
120  * @P9_RWRITE: response with out much data was transfered to file
121  * @P9_TCLUNK: forget about a handle to an entity within the file system
122  * @P9_RCLUNK: response when server has forgotten about the handle
123  * @P9_TREMOVE: request to remove an entity from the hierarchy
124  * @P9_RREMOVE: response when server has removed the entity
125  * @P9_TSTAT: request file entity attributes
126  * @P9_RSTAT: response with file entity attributes
127  * @P9_TWSTAT: request to update file entity attributes
128  * @P9_RWSTAT: response when file entity attributes are updated
129  *
130  * There are 14 basic operations in 9P2000, paired as
131  * requests and responses.  The one special case is ERROR
132  * as there is no @P9_TERROR request for clients to transmit to
133  * the server, but the server may respond to any other request
134  * with an @P9_RERROR.
135  *
136  * See Also: http://plan9.bell-labs.com/sys/man/5/INDEX.html
137  */
138
139 enum p9_msg_t {
140         P9_TSTATFS = 8,
141         P9_RSTATFS,
142         P9_TLCREATE = 14,
143         P9_RLCREATE,
144         P9_TSYMLINK = 16,
145         P9_RSYMLINK,
146         P9_TMKNOD = 18,
147         P9_RMKNOD,
148         P9_TRENAME = 20,
149         P9_RRENAME,
150         P9_TGETATTR = 24,
151         P9_RGETATTR,
152         P9_TSETATTR = 26,
153         P9_RSETATTR,
154         P9_TREADDIR = 40,
155         P9_RREADDIR,
156         P9_TLINK = 70,
157         P9_RLINK,
158         P9_TMKDIR = 72,
159         P9_RMKDIR,
160         P9_TVERSION = 100,
161         P9_RVERSION,
162         P9_TAUTH = 102,
163         P9_RAUTH,
164         P9_TATTACH = 104,
165         P9_RATTACH,
166         P9_TERROR = 106,
167         P9_RERROR,
168         P9_TFLUSH = 108,
169         P9_RFLUSH,
170         P9_TWALK = 110,
171         P9_RWALK,
172         P9_TOPEN = 112,
173         P9_ROPEN,
174         P9_TCREATE = 114,
175         P9_RCREATE,
176         P9_TREAD = 116,
177         P9_RREAD,
178         P9_TWRITE = 118,
179         P9_RWRITE,
180         P9_TCLUNK = 120,
181         P9_RCLUNK,
182         P9_TREMOVE = 122,
183         P9_RREMOVE,
184         P9_TSTAT = 124,
185         P9_RSTAT,
186         P9_TWSTAT = 126,
187         P9_RWSTAT,
188 };
189
190 /**
191  * enum p9_open_mode_t - 9P open modes
192  * @P9_OREAD: open file for reading only
193  * @P9_OWRITE: open file for writing only
194  * @P9_ORDWR: open file for reading or writing
195  * @P9_OEXEC: open file for execution
196  * @P9_OTRUNC: truncate file to zero-length before opening it
197  * @P9_OREXEC: close the file when an exec(2) system call is made
198  * @P9_ORCLOSE: remove the file when the file is closed
199  * @P9_OAPPEND: open the file and seek to the end
200  * @P9_OEXCL: only create a file, do not open it
201  *
202  * 9P open modes differ slightly from Posix standard modes.
203  * In particular, there are extra modes which specify different
204  * semantic behaviors than may be available on standard Posix
205  * systems.  For example, @P9_OREXEC and @P9_ORCLOSE are modes that
206  * most likely will not be issued from the Linux VFS client, but may
207  * be supported by servers.
208  *
209  * See Also: http://plan9.bell-labs.com/magic/man2html/2/open
210  */
211
212 enum p9_open_mode_t {
213         P9_OREAD = 0x00,
214         P9_OWRITE = 0x01,
215         P9_ORDWR = 0x02,
216         P9_OEXEC = 0x03,
217         P9_OTRUNC = 0x10,
218         P9_OREXEC = 0x20,
219         P9_ORCLOSE = 0x40,
220         P9_OAPPEND = 0x80,
221         P9_OEXCL = 0x1000,
222 };
223
224 /**
225  * enum p9_perm_t - 9P permissions
226  * @P9_DMDIR: mode bite for directories
227  * @P9_DMAPPEND: mode bit for is append-only
228  * @P9_DMEXCL: mode bit for excluse use (only one open handle allowed)
229  * @P9_DMMOUNT: mode bite for mount points
230  * @P9_DMAUTH: mode bit for authentication file
231  * @P9_DMTMP: mode bit for non-backed-up files
232  * @P9_DMSYMLINK: mode bit for symbolic links (9P2000.u)
233  * @P9_DMLINK: mode bit for hard-link (9P2000.u)
234  * @P9_DMDEVICE: mode bit for device files (9P2000.u)
235  * @P9_DMNAMEDPIPE: mode bit for named pipe (9P2000.u)
236  * @P9_DMSOCKET: mode bit for socket (9P2000.u)
237  * @P9_DMSETUID: mode bit for setuid (9P2000.u)
238  * @P9_DMSETGID: mode bit for setgid (9P2000.u)
239  * @P9_DMSETVTX: mode bit for sticky bit (9P2000.u)
240  *
241  * 9P permissions differ slightly from Posix standard modes.
242  *
243  * See Also: http://plan9.bell-labs.com/magic/man2html/2/stat
244  */
245 enum p9_perm_t {
246         P9_DMDIR = 0x80000000,
247         P9_DMAPPEND = 0x40000000,
248         P9_DMEXCL = 0x20000000,
249         P9_DMMOUNT = 0x10000000,
250         P9_DMAUTH = 0x08000000,
251         P9_DMTMP = 0x04000000,
252 /* 9P2000.u extensions */
253         P9_DMSYMLINK = 0x02000000,
254         P9_DMLINK = 0x01000000,
255         P9_DMDEVICE = 0x00800000,
256         P9_DMNAMEDPIPE = 0x00200000,
257         P9_DMSOCKET = 0x00100000,
258         P9_DMSETUID = 0x00080000,
259         P9_DMSETGID = 0x00040000,
260         P9_DMSETVTX = 0x00010000,
261 };
262
263 /**
264  * enum p9_qid_t - QID types
265  * @P9_QTDIR: directory
266  * @P9_QTAPPEND: append-only
267  * @P9_QTEXCL: excluse use (only one open handle allowed)
268  * @P9_QTMOUNT: mount points
269  * @P9_QTAUTH: authentication file
270  * @P9_QTTMP: non-backed-up files
271  * @P9_QTSYMLINK: symbolic links (9P2000.u)
272  * @P9_QTLINK: hard-link (9P2000.u)
273  * @P9_QTFILE: normal files
274  *
275  * QID types are a subset of permissions - they are primarily
276  * used to differentiate semantics for a file system entity via
277  * a jump-table.  Their value is also the most signifigant 16 bits
278  * of the permission_t
279  *
280  * See Also: http://plan9.bell-labs.com/magic/man2html/2/stat
281  */
282 enum p9_qid_t {
283         P9_QTDIR = 0x80,
284         P9_QTAPPEND = 0x40,
285         P9_QTEXCL = 0x20,
286         P9_QTMOUNT = 0x10,
287         P9_QTAUTH = 0x08,
288         P9_QTTMP = 0x04,
289         P9_QTSYMLINK = 0x02,
290         P9_QTLINK = 0x01,
291         P9_QTFILE = 0x00,
292 };
293
294 /* 9P Magic Numbers */
295 #define P9_NOTAG        (u16)(~0)
296 #define P9_NOFID        (u32)(~0)
297 #define P9_MAXWELEM     16
298
299 /* ample room for Twrite/Rread header */
300 #define P9_IOHDRSZ      24
301
302 /* Room for readdir header */
303 #define P9_READDIRHDRSZ 24
304
305 /**
306  * struct p9_str - length prefixed string type
307  * @len: length of the string
308  * @str: the string
309  *
310  * The protocol uses length prefixed strings for all
311  * string data, so we replicate that for our internal
312  * string members.
313  */
314
315 struct p9_str {
316         u16 len;
317         char *str;
318 };
319
320 /**
321  * struct p9_qid - file system entity information
322  * @type: 8-bit type &p9_qid_t
323  * @version: 16-bit monotonically incrementing version number
324  * @path: 64-bit per-server-unique ID for a file system element
325  *
326  * qids are identifiers used by 9P servers to track file system
327  * entities.  The type is used to differentiate semantics for operations
328  * on the entity (ie. read means something different on a directory than
329  * on a file).  The path provides a server unique index for an entity
330  * (roughly analogous to an inode number), while the version is updated
331  * every time a file is modified and can be used to maintain cache
332  * coherency between clients and serves.
333  * Servers will often differentiate purely synthetic entities by setting
334  * their version to 0, signaling that they should never be cached and
335  * should be accessed synchronously.
336  *
337  * See Also://plan9.bell-labs.com/magic/man2html/2/stat
338  */
339
340 struct p9_qid {
341         u8 type;
342         u32 version;
343         u64 path;
344 };
345
346 /**
347  * struct p9_stat - file system metadata information
348  * @size: length prefix for this stat structure instance
349  * @type: the type of the server (equivilent to a major number)
350  * @dev: the sub-type of the server (equivilent to a minor number)
351  * @qid: unique id from the server of type &p9_qid
352  * @mode: Plan 9 format permissions of type &p9_perm_t
353  * @atime: Last access/read time
354  * @mtime: Last modify/write time
355  * @length: file length
356  * @name: last element of path (aka filename) in type &p9_str
357  * @uid: owner name in type &p9_str
358  * @gid: group owner in type &p9_str
359  * @muid: last modifier in type &p9_str
360  * @extension: area used to encode extended UNIX support in type &p9_str
361  * @n_uid: numeric user id of owner (part of 9p2000.u extension)
362  * @n_gid: numeric group id (part of 9p2000.u extension)
363  * @n_muid: numeric user id of laster modifier (part of 9p2000.u extension)
364  *
365  * See Also: http://plan9.bell-labs.com/magic/man2html/2/stat
366  */
367
368 struct p9_wstat {
369         u16 size;
370         u16 type;
371         u32 dev;
372         struct p9_qid qid;
373         u32 mode;
374         u32 atime;
375         u32 mtime;
376         u64 length;
377         char *name;
378         char *uid;
379         char *gid;
380         char *muid;
381         char *extension;        /* 9p2000.u extensions */
382         u32 n_uid;              /* 9p2000.u extensions */
383         u32 n_gid;              /* 9p2000.u extensions */
384         u32 n_muid;             /* 9p2000.u extensions */
385 };
386
387 struct p9_stat_dotl {
388         u64 st_result_mask;
389         struct p9_qid qid;
390         u32 st_mode;
391         u32 st_uid;
392         u32 st_gid;
393         u64 st_nlink;
394         u64 st_rdev;
395         u64 st_size;
396         u64 st_blksize;
397         u64 st_blocks;
398         u64 st_atime_sec;
399         u64 st_atime_nsec;
400         u64 st_mtime_sec;
401         u64 st_mtime_nsec;
402         u64 st_ctime_sec;
403         u64 st_ctime_nsec;
404         u64 st_btime_sec;
405         u64 st_btime_nsec;
406         u64 st_gen;
407         u64 st_data_version;
408 };
409
410 #define P9_STATS_MODE           0x00000001ULL
411 #define P9_STATS_NLINK          0x00000002ULL
412 #define P9_STATS_UID            0x00000004ULL
413 #define P9_STATS_GID            0x00000008ULL
414 #define P9_STATS_RDEV           0x00000010ULL
415 #define P9_STATS_ATIME          0x00000020ULL
416 #define P9_STATS_MTIME          0x00000040ULL
417 #define P9_STATS_CTIME          0x00000080ULL
418 #define P9_STATS_INO            0x00000100ULL
419 #define P9_STATS_SIZE           0x00000200ULL
420 #define P9_STATS_BLOCKS         0x00000400ULL
421
422 #define P9_STATS_BTIME          0x00000800ULL
423 #define P9_STATS_GEN            0x00001000ULL
424 #define P9_STATS_DATA_VERSION   0x00002000ULL
425
426 #define P9_STATS_BASIC          0x000007ffULL /* Mask for fields up to BLOCKS */
427 #define P9_STATS_ALL            0x00003fffULL /* Mask for All fields above */
428
429 /**
430  * struct p9_iattr_dotl - P9 inode attribute for setattr
431  * @valid: bitfield specifying which fields are valid
432  *         same as in struct iattr
433  * @mode: File permission bits
434  * @uid: user id of owner
435  * @gid: group id
436  * @size: File size
437  * @atime_sec: Last access time, seconds
438  * @atime_nsec: Last access time, nanoseconds
439  * @mtime_sec: Last modification time, seconds
440  * @mtime_nsec: Last modification time, nanoseconds
441  */
442
443 struct p9_iattr_dotl {
444         u32 valid;
445         u32 mode;
446         u32 uid;
447         u32 gid;
448         u64 size;
449         u64 atime_sec;
450         u64 atime_nsec;
451         u64 mtime_sec;
452         u64 mtime_nsec;
453 };
454
455 /* Structures for Protocol Operations */
456 struct p9_tstatfs {
457         u32 fid;
458 };
459
460 struct p9_rstatfs {
461         u32 type;
462         u32 bsize;
463         u64 blocks;
464         u64 bfree;
465         u64 bavail;
466         u64 files;
467         u64 ffree;
468         u64 fsid;
469         u32 namelen;
470 };
471
472 struct p9_trename {
473         u32 fid;
474         u32 newdirfid;
475         struct p9_str name;
476 };
477
478 struct p9_rrename {
479 };
480
481 struct p9_tversion {
482         u32 msize;
483         struct p9_str version;
484 };
485
486 struct p9_rversion {
487         u32 msize;
488         struct p9_str version;
489 };
490
491 struct p9_tauth {
492         u32 afid;
493         struct p9_str uname;
494         struct p9_str aname;
495         u32 n_uname;            /* 9P2000.u extensions */
496 };
497
498 struct p9_rauth {
499         struct p9_qid qid;
500 };
501
502 struct p9_rerror {
503         struct p9_str error;
504         u32 errno;              /* 9p2000.u extension */
505 };
506
507 struct p9_tflush {
508         u16 oldtag;
509 };
510
511 struct p9_rflush {
512 };
513
514 struct p9_tattach {
515         u32 fid;
516         u32 afid;
517         struct p9_str uname;
518         struct p9_str aname;
519         u32 n_uname;            /* 9P2000.u extensions */
520 };
521
522 struct p9_rattach {
523         struct p9_qid qid;
524 };
525
526 struct p9_twalk {
527         u32 fid;
528         u32 newfid;
529         u16 nwname;
530         struct p9_str wnames[16];
531 };
532
533 struct p9_rwalk {
534         u16 nwqid;
535         struct p9_qid wqids[16];
536 };
537
538 struct p9_topen {
539         u32 fid;
540         u8 mode;
541 };
542
543 struct p9_ropen {
544         struct p9_qid qid;
545         u32 iounit;
546 };
547
548 struct p9_tcreate {
549         u32 fid;
550         struct p9_str name;
551         u32 perm;
552         u8 mode;
553         struct p9_str extension;
554 };
555
556 struct p9_rcreate {
557         struct p9_qid qid;
558         u32 iounit;
559 };
560
561 struct p9_tread {
562         u32 fid;
563         u64 offset;
564         u32 count;
565 };
566
567 struct p9_rread {
568         u32 count;
569         u8 *data;
570 };
571
572 struct p9_twrite {
573         u32 fid;
574         u64 offset;
575         u32 count;
576         u8 *data;
577 };
578
579 struct p9_rwrite {
580         u32 count;
581 };
582
583 struct p9_treaddir {
584         u32 fid;
585         u64 offset;
586         u32 count;
587 };
588
589 struct p9_rreaddir {
590         u32 count;
591         u8 *data;
592 };
593
594
595 struct p9_tclunk {
596         u32 fid;
597 };
598
599 struct p9_rclunk {
600 };
601
602 struct p9_tremove {
603         u32 fid;
604 };
605
606 struct p9_rremove {
607 };
608
609 struct p9_tstat {
610         u32 fid;
611 };
612
613 struct p9_rstat {
614         struct p9_wstat stat;
615 };
616
617 struct p9_twstat {
618         u32 fid;
619         struct p9_wstat stat;
620 };
621
622 struct p9_rwstat {
623 };
624
625 /**
626  * struct p9_fcall - primary packet structure
627  * @size: prefixed length of the structure
628  * @id: protocol operating identifier of type &p9_msg_t
629  * @tag: transaction id of the request
630  * @offset: used by marshalling routines to track currentposition in buffer
631  * @capacity: used by marshalling routines to track total capacity
632  * @sdata: payload
633  *
634  * &p9_fcall represents the structure for all 9P RPC
635  * transactions.  Requests are packaged into fcalls, and reponses
636  * must be extracted from them.
637  *
638  * See Also: http://plan9.bell-labs.com/magic/man2html/2/fcall
639  */
640
641 struct p9_fcall {
642         u32 size;
643         u8 id;
644         u16 tag;
645
646         size_t offset;
647         size_t capacity;
648
649         uint8_t *sdata;
650 };
651
652 struct p9_idpool;
653
654 int p9_errstr2errno(char *errstr, int len);
655
656 struct p9_idpool *p9_idpool_create(void);
657 void p9_idpool_destroy(struct p9_idpool *);
658 int p9_idpool_get(struct p9_idpool *p);
659 void p9_idpool_put(int id, struct p9_idpool *p);
660 int p9_idpool_check(int id, struct p9_idpool *p);
661
662 int p9_error_init(void);
663 int p9_errstr2errno(char *, int);
664 int p9_trans_fd_init(void);
665 void p9_trans_fd_exit(void);
666 #endif /* NET_9P_H */