d83a013008717faa8c73b8eda856ae1ba7c0065e
[deliverable/linux.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 * @P9_DEBUG_VPKT: Verbose packet debugging (full packet dump)
44 *
45 * These flags are passed at mount time to turn on various levels of
46 * verbosity and tracing which will be output to the system logs.
47 */
48
49 enum p9_debug_flags {
50 P9_DEBUG_ERROR = (1<<0),
51 P9_DEBUG_9P = (1<<2),
52 P9_DEBUG_VFS = (1<<3),
53 P9_DEBUG_CONV = (1<<4),
54 P9_DEBUG_MUX = (1<<5),
55 P9_DEBUG_TRANS = (1<<6),
56 P9_DEBUG_SLABS = (1<<7),
57 P9_DEBUG_FCALL = (1<<8),
58 P9_DEBUG_FID = (1<<9),
59 P9_DEBUG_PKT = (1<<10),
60 P9_DEBUG_FSC = (1<<11),
61 P9_DEBUG_VPKT = (1<<12),
62 };
63
64 #ifdef CONFIG_NET_9P_DEBUG
65 extern unsigned int p9_debug_level;
66
67 #define P9_DPRINTK(level, format, arg...) \
68 do { \
69 if ((p9_debug_level & level) == level) {\
70 if (level == P9_DEBUG_9P) \
71 printk(KERN_NOTICE "(%8.8d) " \
72 format , task_pid_nr(current) , ## arg); \
73 else \
74 printk(KERN_NOTICE "-- %s (%d): " \
75 format , __func__, task_pid_nr(current) , ## arg); \
76 } \
77 } while (0)
78
79 #define P9_DUMP_PKT(way, pdu) p9pdu_dump(way, pdu)
80
81 #else
82 #define P9_DPRINTK(level, format, arg...) do { } while (0)
83 #define P9_DUMP_PKT(way, pdu) do { } while (0)
84 #endif
85
86
87 #define P9_EPRINTK(level, format, arg...) \
88 do { \
89 printk(level "9p: %s (%d): " \
90 format , __func__, task_pid_nr(current), ## arg); \
91 } while (0)
92
93 /**
94 * enum p9_msg_t - 9P message types
95 * @P9_TLERROR: not used
96 * @P9_RLERROR: response for any failed request for 9P2000.L
97 * @P9_TSTATFS: file system status request
98 * @P9_RSTATFS: file system status response
99 * @P9_TSYMLINK: make symlink request
100 * @P9_RSYMLINK: make symlink response
101 * @P9_TMKNOD: create a special file object request
102 * @P9_RMKNOD: create a special file object response
103 * @P9_TLCREATE: prepare a handle for I/O on an new file for 9P2000.L
104 * @P9_RLCREATE: response with file access information for 9P2000.L
105 * @P9_TRENAME: rename request
106 * @P9_RRENAME: rename response
107 * @P9_TMKDIR: create a directory request
108 * @P9_RMKDIR: create a directory response
109 * @P9_TVERSION: version handshake request
110 * @P9_RVERSION: version handshake response
111 * @P9_TAUTH: request to establish authentication channel
112 * @P9_RAUTH: response with authentication information
113 * @P9_TATTACH: establish user access to file service
114 * @P9_RATTACH: response with top level handle to file hierarchy
115 * @P9_TERROR: not used
116 * @P9_RERROR: response for any failed request
117 * @P9_TFLUSH: request to abort a previous request
118 * @P9_RFLUSH: response when previous request has been cancelled
119 * @P9_TWALK: descend a directory hierarchy
120 * @P9_RWALK: response with new handle for position within hierarchy
121 * @P9_TOPEN: prepare a handle for I/O on an existing file
122 * @P9_ROPEN: response with file access information
123 * @P9_TCREATE: prepare a handle for I/O on a new file
124 * @P9_RCREATE: response with file access information
125 * @P9_TREAD: request to transfer data from a file or directory
126 * @P9_RREAD: response with data requested
127 * @P9_TWRITE: reuqest to transfer data to a file
128 * @P9_RWRITE: response with out much data was transferred to file
129 * @P9_TCLUNK: forget about a handle to an entity within the file system
130 * @P9_RCLUNK: response when server has forgotten about the handle
131 * @P9_TREMOVE: request to remove an entity from the hierarchy
132 * @P9_RREMOVE: response when server has removed the entity
133 * @P9_TSTAT: request file entity attributes
134 * @P9_RSTAT: response with file entity attributes
135 * @P9_TWSTAT: request to update file entity attributes
136 * @P9_RWSTAT: response when file entity attributes are updated
137 *
138 * There are 14 basic operations in 9P2000, paired as
139 * requests and responses. The one special case is ERROR
140 * as there is no @P9_TERROR request for clients to transmit to
141 * the server, but the server may respond to any other request
142 * with an @P9_RERROR.
143 *
144 * See Also: http://plan9.bell-labs.com/sys/man/5/INDEX.html
145 */
146
147 enum p9_msg_t {
148 P9_TLERROR = 6,
149 P9_RLERROR,
150 P9_TSTATFS = 8,
151 P9_RSTATFS,
152 P9_TLOPEN = 12,
153 P9_RLOPEN,
154 P9_TLCREATE = 14,
155 P9_RLCREATE,
156 P9_TSYMLINK = 16,
157 P9_RSYMLINK,
158 P9_TMKNOD = 18,
159 P9_RMKNOD,
160 P9_TRENAME = 20,
161 P9_RRENAME,
162 P9_TREADLINK = 22,
163 P9_RREADLINK,
164 P9_TGETATTR = 24,
165 P9_RGETATTR,
166 P9_TSETATTR = 26,
167 P9_RSETATTR,
168 P9_TXATTRWALK = 30,
169 P9_RXATTRWALK,
170 P9_TXATTRCREATE = 32,
171 P9_RXATTRCREATE,
172 P9_TREADDIR = 40,
173 P9_RREADDIR,
174 P9_TFSYNC = 50,
175 P9_RFSYNC,
176 P9_TLOCK = 52,
177 P9_RLOCK,
178 P9_TGETLOCK = 54,
179 P9_RGETLOCK,
180 P9_TLINK = 70,
181 P9_RLINK,
182 P9_TMKDIR = 72,
183 P9_RMKDIR,
184 P9_TRENAMEAT = 74,
185 P9_RRENAMEAT,
186 P9_TUNLINKAT = 76,
187 P9_RUNLINKAT,
188 P9_TVERSION = 100,
189 P9_RVERSION,
190 P9_TAUTH = 102,
191 P9_RAUTH,
192 P9_TATTACH = 104,
193 P9_RATTACH,
194 P9_TERROR = 106,
195 P9_RERROR,
196 P9_TFLUSH = 108,
197 P9_RFLUSH,
198 P9_TWALK = 110,
199 P9_RWALK,
200 P9_TOPEN = 112,
201 P9_ROPEN,
202 P9_TCREATE = 114,
203 P9_RCREATE,
204 P9_TREAD = 116,
205 P9_RREAD,
206 P9_TWRITE = 118,
207 P9_RWRITE,
208 P9_TCLUNK = 120,
209 P9_RCLUNK,
210 P9_TREMOVE = 122,
211 P9_RREMOVE,
212 P9_TSTAT = 124,
213 P9_RSTAT,
214 P9_TWSTAT = 126,
215 P9_RWSTAT,
216 };
217
218 /**
219 * enum p9_open_mode_t - 9P open modes
220 * @P9_OREAD: open file for reading only
221 * @P9_OWRITE: open file for writing only
222 * @P9_ORDWR: open file for reading or writing
223 * @P9_OEXEC: open file for execution
224 * @P9_OTRUNC: truncate file to zero-length before opening it
225 * @P9_OREXEC: close the file when an exec(2) system call is made
226 * @P9_ORCLOSE: remove the file when the file is closed
227 * @P9_OAPPEND: open the file and seek to the end
228 * @P9_OEXCL: only create a file, do not open it
229 *
230 * 9P open modes differ slightly from Posix standard modes.
231 * In particular, there are extra modes which specify different
232 * semantic behaviors than may be available on standard Posix
233 * systems. For example, @P9_OREXEC and @P9_ORCLOSE are modes that
234 * most likely will not be issued from the Linux VFS client, but may
235 * be supported by servers.
236 *
237 * See Also: http://plan9.bell-labs.com/magic/man2html/2/open
238 */
239
240 enum p9_open_mode_t {
241 P9_OREAD = 0x00,
242 P9_OWRITE = 0x01,
243 P9_ORDWR = 0x02,
244 P9_OEXEC = 0x03,
245 P9_OTRUNC = 0x10,
246 P9_OREXEC = 0x20,
247 P9_ORCLOSE = 0x40,
248 P9_OAPPEND = 0x80,
249 P9_OEXCL = 0x1000,
250 };
251
252 /**
253 * enum p9_perm_t - 9P permissions
254 * @P9_DMDIR: mode bit for directories
255 * @P9_DMAPPEND: mode bit for is append-only
256 * @P9_DMEXCL: mode bit for excluse use (only one open handle allowed)
257 * @P9_DMMOUNT: mode bit for mount points
258 * @P9_DMAUTH: mode bit for authentication file
259 * @P9_DMTMP: mode bit for non-backed-up files
260 * @P9_DMSYMLINK: mode bit for symbolic links (9P2000.u)
261 * @P9_DMLINK: mode bit for hard-link (9P2000.u)
262 * @P9_DMDEVICE: mode bit for device files (9P2000.u)
263 * @P9_DMNAMEDPIPE: mode bit for named pipe (9P2000.u)
264 * @P9_DMSOCKET: mode bit for socket (9P2000.u)
265 * @P9_DMSETUID: mode bit for setuid (9P2000.u)
266 * @P9_DMSETGID: mode bit for setgid (9P2000.u)
267 * @P9_DMSETVTX: mode bit for sticky bit (9P2000.u)
268 *
269 * 9P permissions differ slightly from Posix standard modes.
270 *
271 * See Also: http://plan9.bell-labs.com/magic/man2html/2/stat
272 */
273 enum p9_perm_t {
274 P9_DMDIR = 0x80000000,
275 P9_DMAPPEND = 0x40000000,
276 P9_DMEXCL = 0x20000000,
277 P9_DMMOUNT = 0x10000000,
278 P9_DMAUTH = 0x08000000,
279 P9_DMTMP = 0x04000000,
280 /* 9P2000.u extensions */
281 P9_DMSYMLINK = 0x02000000,
282 P9_DMLINK = 0x01000000,
283 P9_DMDEVICE = 0x00800000,
284 P9_DMNAMEDPIPE = 0x00200000,
285 P9_DMSOCKET = 0x00100000,
286 P9_DMSETUID = 0x00080000,
287 P9_DMSETGID = 0x00040000,
288 P9_DMSETVTX = 0x00010000,
289 };
290
291 /* 9p2000.L open flags */
292 #define P9_DOTL_RDONLY 00000000
293 #define P9_DOTL_WRONLY 00000001
294 #define P9_DOTL_RDWR 00000002
295 #define P9_DOTL_NOACCESS 00000003
296 #define P9_DOTL_CREATE 00000100
297 #define P9_DOTL_EXCL 00000200
298 #define P9_DOTL_NOCTTY 00000400
299 #define P9_DOTL_TRUNC 00001000
300 #define P9_DOTL_APPEND 00002000
301 #define P9_DOTL_NONBLOCK 00004000
302 #define P9_DOTL_DSYNC 00010000
303 #define P9_DOTL_FASYNC 00020000
304 #define P9_DOTL_DIRECT 00040000
305 #define P9_DOTL_LARGEFILE 00100000
306 #define P9_DOTL_DIRECTORY 00200000
307 #define P9_DOTL_NOFOLLOW 00400000
308 #define P9_DOTL_NOATIME 01000000
309 #define P9_DOTL_CLOEXEC 02000000
310 #define P9_DOTL_SYNC 04000000
311
312 /* 9p2000.L at flags */
313 #define P9_DOTL_AT_REMOVEDIR 0x200
314
315 /* 9p2000.L lock type */
316 #define P9_LOCK_TYPE_RDLCK 0
317 #define P9_LOCK_TYPE_WRLCK 1
318 #define P9_LOCK_TYPE_UNLCK 2
319
320 /**
321 * enum p9_qid_t - QID types
322 * @P9_QTDIR: directory
323 * @P9_QTAPPEND: append-only
324 * @P9_QTEXCL: excluse use (only one open handle allowed)
325 * @P9_QTMOUNT: mount points
326 * @P9_QTAUTH: authentication file
327 * @P9_QTTMP: non-backed-up files
328 * @P9_QTSYMLINK: symbolic links (9P2000.u)
329 * @P9_QTLINK: hard-link (9P2000.u)
330 * @P9_QTFILE: normal files
331 *
332 * QID types are a subset of permissions - they are primarily
333 * used to differentiate semantics for a file system entity via
334 * a jump-table. Their value is also the most significant 16 bits
335 * of the permission_t
336 *
337 * See Also: http://plan9.bell-labs.com/magic/man2html/2/stat
338 */
339 enum p9_qid_t {
340 P9_QTDIR = 0x80,
341 P9_QTAPPEND = 0x40,
342 P9_QTEXCL = 0x20,
343 P9_QTMOUNT = 0x10,
344 P9_QTAUTH = 0x08,
345 P9_QTTMP = 0x04,
346 P9_QTSYMLINK = 0x02,
347 P9_QTLINK = 0x01,
348 P9_QTFILE = 0x00,
349 };
350
351 /* 9P Magic Numbers */
352 #define P9_NOTAG (u16)(~0)
353 #define P9_NOFID (u32)(~0)
354 #define P9_MAXWELEM 16
355
356 /* ample room for Twrite/Rread header */
357 #define P9_IOHDRSZ 24
358
359 /* Room for readdir header */
360 #define P9_READDIRHDRSZ 24
361
362 /* size of header for zero copy read/write */
363 #define P9_ZC_HDR_SZ 4096
364
365 /**
366 * struct p9_qid - file system entity information
367 * @type: 8-bit type &p9_qid_t
368 * @version: 16-bit monotonically incrementing version number
369 * @path: 64-bit per-server-unique ID for a file system element
370 *
371 * qids are identifiers used by 9P servers to track file system
372 * entities. The type is used to differentiate semantics for operations
373 * on the entity (ie. read means something different on a directory than
374 * on a file). The path provides a server unique index for an entity
375 * (roughly analogous to an inode number), while the version is updated
376 * every time a file is modified and can be used to maintain cache
377 * coherency between clients and serves.
378 * Servers will often differentiate purely synthetic entities by setting
379 * their version to 0, signaling that they should never be cached and
380 * should be accessed synchronously.
381 *
382 * See Also://plan9.bell-labs.com/magic/man2html/2/stat
383 */
384
385 struct p9_qid {
386 u8 type;
387 u32 version;
388 u64 path;
389 };
390
391 /**
392 * struct p9_wstat - file system metadata information
393 * @size: length prefix for this stat structure instance
394 * @type: the type of the server (equivalent to a major number)
395 * @dev: the sub-type of the server (equivalent to a minor number)
396 * @qid: unique id from the server of type &p9_qid
397 * @mode: Plan 9 format permissions of type &p9_perm_t
398 * @atime: Last access/read time
399 * @mtime: Last modify/write time
400 * @length: file length
401 * @name: last element of path (aka filename)
402 * @uid: owner name
403 * @gid: group owner
404 * @muid: last modifier
405 * @extension: area used to encode extended UNIX support
406 * @n_uid: numeric user id of owner (part of 9p2000.u extension)
407 * @n_gid: numeric group id (part of 9p2000.u extension)
408 * @n_muid: numeric user id of laster modifier (part of 9p2000.u extension)
409 *
410 * See Also: http://plan9.bell-labs.com/magic/man2html/2/stat
411 */
412
413 struct p9_wstat {
414 u16 size;
415 u16 type;
416 u32 dev;
417 struct p9_qid qid;
418 u32 mode;
419 u32 atime;
420 u32 mtime;
421 u64 length;
422 char *name;
423 char *uid;
424 char *gid;
425 char *muid;
426 char *extension; /* 9p2000.u extensions */
427 u32 n_uid; /* 9p2000.u extensions */
428 u32 n_gid; /* 9p2000.u extensions */
429 u32 n_muid; /* 9p2000.u extensions */
430 };
431
432 struct p9_stat_dotl {
433 u64 st_result_mask;
434 struct p9_qid qid;
435 u32 st_mode;
436 u32 st_uid;
437 u32 st_gid;
438 u64 st_nlink;
439 u64 st_rdev;
440 u64 st_size;
441 u64 st_blksize;
442 u64 st_blocks;
443 u64 st_atime_sec;
444 u64 st_atime_nsec;
445 u64 st_mtime_sec;
446 u64 st_mtime_nsec;
447 u64 st_ctime_sec;
448 u64 st_ctime_nsec;
449 u64 st_btime_sec;
450 u64 st_btime_nsec;
451 u64 st_gen;
452 u64 st_data_version;
453 };
454
455 #define P9_STATS_MODE 0x00000001ULL
456 #define P9_STATS_NLINK 0x00000002ULL
457 #define P9_STATS_UID 0x00000004ULL
458 #define P9_STATS_GID 0x00000008ULL
459 #define P9_STATS_RDEV 0x00000010ULL
460 #define P9_STATS_ATIME 0x00000020ULL
461 #define P9_STATS_MTIME 0x00000040ULL
462 #define P9_STATS_CTIME 0x00000080ULL
463 #define P9_STATS_INO 0x00000100ULL
464 #define P9_STATS_SIZE 0x00000200ULL
465 #define P9_STATS_BLOCKS 0x00000400ULL
466
467 #define P9_STATS_BTIME 0x00000800ULL
468 #define P9_STATS_GEN 0x00001000ULL
469 #define P9_STATS_DATA_VERSION 0x00002000ULL
470
471 #define P9_STATS_BASIC 0x000007ffULL /* Mask for fields up to BLOCKS */
472 #define P9_STATS_ALL 0x00003fffULL /* Mask for All fields above */
473
474 /**
475 * struct p9_iattr_dotl - P9 inode attribute for setattr
476 * @valid: bitfield specifying which fields are valid
477 * same as in struct iattr
478 * @mode: File permission bits
479 * @uid: user id of owner
480 * @gid: group id
481 * @size: File size
482 * @atime_sec: Last access time, seconds
483 * @atime_nsec: Last access time, nanoseconds
484 * @mtime_sec: Last modification time, seconds
485 * @mtime_nsec: Last modification time, nanoseconds
486 */
487
488 struct p9_iattr_dotl {
489 u32 valid;
490 u32 mode;
491 u32 uid;
492 u32 gid;
493 u64 size;
494 u64 atime_sec;
495 u64 atime_nsec;
496 u64 mtime_sec;
497 u64 mtime_nsec;
498 };
499
500 #define P9_LOCK_SUCCESS 0
501 #define P9_LOCK_BLOCKED 1
502 #define P9_LOCK_ERROR 2
503 #define P9_LOCK_GRACE 3
504
505 #define P9_LOCK_FLAGS_BLOCK 1
506 #define P9_LOCK_FLAGS_RECLAIM 2
507
508 /* struct p9_flock: POSIX lock structure
509 * @type - type of lock
510 * @flags - lock flags
511 * @start - starting offset of the lock
512 * @length - number of bytes
513 * @proc_id - process id which wants to take lock
514 * @client_id - client id
515 */
516
517 struct p9_flock {
518 u8 type;
519 u32 flags;
520 u64 start;
521 u64 length;
522 u32 proc_id;
523 char *client_id;
524 };
525
526 /* struct p9_getlock: getlock structure
527 * @type - type of lock
528 * @start - starting offset of the lock
529 * @length - number of bytes
530 * @proc_id - process id which wants to take lock
531 * @client_id - client id
532 */
533
534 struct p9_getlock {
535 u8 type;
536 u64 start;
537 u64 length;
538 u32 proc_id;
539 char *client_id;
540 };
541
542 struct p9_rstatfs {
543 u32 type;
544 u32 bsize;
545 u64 blocks;
546 u64 bfree;
547 u64 bavail;
548 u64 files;
549 u64 ffree;
550 u64 fsid;
551 u32 namelen;
552 };
553
554 /**
555 * struct p9_fcall - primary packet structure
556 * @size: prefixed length of the structure
557 * @id: protocol operating identifier of type &p9_msg_t
558 * @tag: transaction id of the request
559 * @offset: used by marshalling routines to track current position in buffer
560 * @capacity: used by marshalling routines to track total malloc'd capacity
561 * @sdata: payload
562 *
563 * &p9_fcall represents the structure for all 9P RPC
564 * transactions. Requests are packaged into fcalls, and reponses
565 * must be extracted from them.
566 *
567 * See Also: http://plan9.bell-labs.com/magic/man2html/2/fcall
568 */
569
570 struct p9_fcall {
571 u32 size;
572 u8 id;
573 u16 tag;
574
575 size_t offset;
576 size_t capacity;
577
578 u8 *sdata;
579 };
580
581 struct p9_idpool;
582
583 int p9_errstr2errno(char *errstr, int len);
584
585 struct p9_idpool *p9_idpool_create(void);
586 void p9_idpool_destroy(struct p9_idpool *);
587 int p9_idpool_get(struct p9_idpool *p);
588 void p9_idpool_put(int id, struct p9_idpool *p);
589 int p9_idpool_check(int id, struct p9_idpool *p);
590
591 int p9_error_init(void);
592 int p9_trans_fd_init(void);
593 void p9_trans_fd_exit(void);
594 #endif /* NET_9P_H */
This page took 0.056982 seconds and 4 git commands to generate.