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