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