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