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