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