4 * 9P protocol definitions.
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>
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.
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.
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
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
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.
49 P9_DEBUG_ERROR = (1<<0),
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),
62 #ifdef CONFIG_NET_9P_DEBUG
63 extern unsigned int p9_debug_level;
65 #define P9_DPRINTK(level, format, arg...) \
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); \
72 printk(KERN_NOTICE "-- %s (%d): " \
73 format , __func__, task_pid_nr(current) , ## arg); \
78 #define P9_DPRINTK(level, format, arg...) do { } while (0)
81 #define P9_EPRINTK(level, format, arg...) \
83 printk(level "9p: %s (%d): " \
84 format , __func__, task_pid_nr(current), ## arg); \
88 * enum p9_msg_t - 9P message types
89 * @P9_TSTATFS: file system status request
90 * @P9_RSTATFS: file system status response
91 * @P9_TRENAME: rename request
92 * @P9_RRENAME: rename response
93 * @P9_TVERSION: version handshake request
94 * @P9_RVERSION: version handshake response
95 * @P9_TAUTH: request to establish authentication channel
96 * @P9_RAUTH: response with authentication information
97 * @P9_TATTACH: establish user access to file service
98 * @P9_RATTACH: response with top level handle to file hierarchy
99 * @P9_TERROR: not used
100 * @P9_RERROR: response for any failed request
101 * @P9_TFLUSH: request to abort a previous request
102 * @P9_RFLUSH: response when previous request has been cancelled
103 * @P9_TWALK: descend a directory hierarchy
104 * @P9_RWALK: response with new handle for position within hierarchy
105 * @P9_TOPEN: prepare a handle for I/O on an existing file
106 * @P9_ROPEN: response with file access information
107 * @P9_TCREATE: prepare a handle for I/O on a new file
108 * @P9_RCREATE: response with file access information
109 * @P9_TREAD: request to transfer data from a file or directory
110 * @P9_RREAD: response with data requested
111 * @P9_TWRITE: reuqest to transfer data to a file
112 * @P9_RWRITE: response with out much data was transfered to file
113 * @P9_TCLUNK: forget about a handle to an entity within the file system
114 * @P9_RCLUNK: response when server has forgotten about the handle
115 * @P9_TREMOVE: request to remove an entity from the hierarchy
116 * @P9_RREMOVE: response when server has removed the entity
117 * @P9_TSTAT: request file entity attributes
118 * @P9_RSTAT: response with file entity attributes
119 * @P9_TWSTAT: request to update file entity attributes
120 * @P9_RWSTAT: response when file entity attributes are updated
122 * There are 14 basic operations in 9P2000, paired as
123 * requests and responses. The one special case is ERROR
124 * as there is no @P9_TERROR request for clients to transmit to
125 * the server, but the server may respond to any other request
126 * with an @P9_RERROR.
128 * See Also: http://plan9.bell-labs.com/sys/man/5/INDEX.html
175 * enum p9_open_mode_t - 9P open modes
176 * @P9_OREAD: open file for reading only
177 * @P9_OWRITE: open file for writing only
178 * @P9_ORDWR: open file for reading or writing
179 * @P9_OEXEC: open file for execution
180 * @P9_OTRUNC: truncate file to zero-length before opening it
181 * @P9_OREXEC: close the file when an exec(2) system call is made
182 * @P9_ORCLOSE: remove the file when the file is closed
183 * @P9_OAPPEND: open the file and seek to the end
184 * @P9_OEXCL: only create a file, do not open it
186 * 9P open modes differ slightly from Posix standard modes.
187 * In particular, there are extra modes which specify different
188 * semantic behaviors than may be available on standard Posix
189 * systems. For example, @P9_OREXEC and @P9_ORCLOSE are modes that
190 * most likely will not be issued from the Linux VFS client, but may
191 * be supported by servers.
193 * See Also: http://plan9.bell-labs.com/magic/man2html/2/open
196 enum p9_open_mode_t {
209 * enum p9_perm_t - 9P permissions
210 * @P9_DMDIR: mode bite for directories
211 * @P9_DMAPPEND: mode bit for is append-only
212 * @P9_DMEXCL: mode bit for excluse use (only one open handle allowed)
213 * @P9_DMMOUNT: mode bite for mount points
214 * @P9_DMAUTH: mode bit for authentication file
215 * @P9_DMTMP: mode bit for non-backed-up files
216 * @P9_DMSYMLINK: mode bit for symbolic links (9P2000.u)
217 * @P9_DMLINK: mode bit for hard-link (9P2000.u)
218 * @P9_DMDEVICE: mode bit for device files (9P2000.u)
219 * @P9_DMNAMEDPIPE: mode bit for named pipe (9P2000.u)
220 * @P9_DMSOCKET: mode bit for socket (9P2000.u)
221 * @P9_DMSETUID: mode bit for setuid (9P2000.u)
222 * @P9_DMSETGID: mode bit for setgid (9P2000.u)
223 * @P9_DMSETVTX: mode bit for sticky bit (9P2000.u)
225 * 9P permissions differ slightly from Posix standard modes.
227 * See Also: http://plan9.bell-labs.com/magic/man2html/2/stat
230 P9_DMDIR = 0x80000000,
231 P9_DMAPPEND = 0x40000000,
232 P9_DMEXCL = 0x20000000,
233 P9_DMMOUNT = 0x10000000,
234 P9_DMAUTH = 0x08000000,
235 P9_DMTMP = 0x04000000,
236 /* 9P2000.u extensions */
237 P9_DMSYMLINK = 0x02000000,
238 P9_DMLINK = 0x01000000,
239 P9_DMDEVICE = 0x00800000,
240 P9_DMNAMEDPIPE = 0x00200000,
241 P9_DMSOCKET = 0x00100000,
242 P9_DMSETUID = 0x00080000,
243 P9_DMSETGID = 0x00040000,
244 P9_DMSETVTX = 0x00010000,
248 * enum p9_qid_t - QID types
249 * @P9_QTDIR: directory
250 * @P9_QTAPPEND: append-only
251 * @P9_QTEXCL: excluse use (only one open handle allowed)
252 * @P9_QTMOUNT: mount points
253 * @P9_QTAUTH: authentication file
254 * @P9_QTTMP: non-backed-up files
255 * @P9_QTSYMLINK: symbolic links (9P2000.u)
256 * @P9_QTLINK: hard-link (9P2000.u)
257 * @P9_QTFILE: normal files
259 * QID types are a subset of permissions - they are primarily
260 * used to differentiate semantics for a file system entity via
261 * a jump-table. Their value is also the most signifigant 16 bits
262 * of the permission_t
264 * See Also: http://plan9.bell-labs.com/magic/man2html/2/stat
278 /* 9P Magic Numbers */
279 #define P9_NOTAG (u16)(~0)
280 #define P9_NOFID (u32)(~0)
281 #define P9_MAXWELEM 16
283 /* ample room for Twrite/Rread header */
284 #define P9_IOHDRSZ 24
286 /* Room for readdir header */
287 #define P9_READDIRHDRSZ 24
290 * struct p9_str - length prefixed string type
291 * @len: length of the string
294 * The protocol uses length prefixed strings for all
295 * string data, so we replicate that for our internal
305 * struct p9_qid - file system entity information
306 * @type: 8-bit type &p9_qid_t
307 * @version: 16-bit monotonically incrementing version number
308 * @path: 64-bit per-server-unique ID for a file system element
310 * qids are identifiers used by 9P servers to track file system
311 * entities. The type is used to differentiate semantics for operations
312 * on the entity (ie. read means something different on a directory than
313 * on a file). The path provides a server unique index for an entity
314 * (roughly analogous to an inode number), while the version is updated
315 * every time a file is modified and can be used to maintain cache
316 * coherency between clients and serves.
317 * Servers will often differentiate purely synthetic entities by setting
318 * their version to 0, signaling that they should never be cached and
319 * should be accessed synchronously.
321 * See Also://plan9.bell-labs.com/magic/man2html/2/stat
331 * struct p9_stat - file system metadata information
332 * @size: length prefix for this stat structure instance
333 * @type: the type of the server (equivilent to a major number)
334 * @dev: the sub-type of the server (equivilent to a minor number)
335 * @qid: unique id from the server of type &p9_qid
336 * @mode: Plan 9 format permissions of type &p9_perm_t
337 * @atime: Last access/read time
338 * @mtime: Last modify/write time
339 * @length: file length
340 * @name: last element of path (aka filename) in type &p9_str
341 * @uid: owner name in type &p9_str
342 * @gid: group owner in type &p9_str
343 * @muid: last modifier in type &p9_str
344 * @extension: area used to encode extended UNIX support in type &p9_str
345 * @n_uid: numeric user id of owner (part of 9p2000.u extension)
346 * @n_gid: numeric group id (part of 9p2000.u extension)
347 * @n_muid: numeric user id of laster modifier (part of 9p2000.u extension)
349 * See Also: http://plan9.bell-labs.com/magic/man2html/2/stat
365 char *extension; /* 9p2000.u extensions */
366 u32 n_uid; /* 9p2000.u extensions */
367 u32 n_gid; /* 9p2000.u extensions */
368 u32 n_muid; /* 9p2000.u extensions */
371 struct p9_stat_dotl {
394 #define P9_STATS_MODE 0x00000001ULL
395 #define P9_STATS_NLINK 0x00000002ULL
396 #define P9_STATS_UID 0x00000004ULL
397 #define P9_STATS_GID 0x00000008ULL
398 #define P9_STATS_RDEV 0x00000010ULL
399 #define P9_STATS_ATIME 0x00000020ULL
400 #define P9_STATS_MTIME 0x00000040ULL
401 #define P9_STATS_CTIME 0x00000080ULL
402 #define P9_STATS_INO 0x00000100ULL
403 #define P9_STATS_SIZE 0x00000200ULL
404 #define P9_STATS_BLOCKS 0x00000400ULL
406 #define P9_STATS_BTIME 0x00000800ULL
407 #define P9_STATS_GEN 0x00001000ULL
408 #define P9_STATS_DATA_VERSION 0x00002000ULL
410 #define P9_STATS_BASIC 0x000007ffULL /* Mask for fields up to BLOCKS */
411 #define P9_STATS_ALL 0x00003fffULL /* Mask for All fields above */
414 * struct p9_iattr_dotl - P9 inode attribute for setattr
415 * @valid: bitfield specifying which fields are valid
416 * same as in struct iattr
417 * @mode: File permission bits
418 * @uid: user id of owner
421 * @atime_sec: Last access time, seconds
422 * @atime_nsec: Last access time, nanoseconds
423 * @mtime_sec: Last modification time, seconds
424 * @mtime_nsec: Last modification time, nanoseconds
427 struct p9_iattr_dotl {
439 /* Structures for Protocol Operations */
467 struct p9_str version;
472 struct p9_str version;
479 u32 n_uname; /* 9P2000.u extensions */
488 u32 errno; /* 9p2000.u extension */
503 u32 n_uname; /* 9P2000.u extensions */
514 struct p9_str wnames[16];
519 struct p9_qid wqids[16];
537 struct p9_str extension;
598 struct p9_wstat stat;
603 struct p9_wstat stat;
610 * struct p9_fcall - primary packet structure
611 * @size: prefixed length of the structure
612 * @id: protocol operating identifier of type &p9_msg_t
613 * @tag: transaction id of the request
614 * @offset: used by marshalling routines to track currentposition in buffer
615 * @capacity: used by marshalling routines to track total capacity
618 * &p9_fcall represents the structure for all 9P RPC
619 * transactions. Requests are packaged into fcalls, and reponses
620 * must be extracted from them.
622 * See Also: http://plan9.bell-labs.com/magic/man2html/2/fcall
638 int p9_errstr2errno(char *errstr, int len);
640 struct p9_idpool *p9_idpool_create(void);
641 void p9_idpool_destroy(struct p9_idpool *);
642 int p9_idpool_get(struct p9_idpool *p);
643 void p9_idpool_put(int id, struct p9_idpool *p);
644 int p9_idpool_check(int id, struct p9_idpool *p);
646 int p9_error_init(void);
647 int p9_errstr2errno(char *, int);
648 int p9_trans_fd_init(void);
649 void p9_trans_fd_exit(void);
650 #endif /* NET_9P_H */