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 /** 292 * enum p9_qid_t - QID types 293 * @P9_QTDIR: directory 294 * @P9_QTAPPEND: append-only 295 * @P9_QTEXCL: excluse use (only one open handle allowed) 296 * @P9_QTMOUNT: mount points 297 * @P9_QTAUTH: authentication file 298 * @P9_QTTMP: non-backed-up files 299 * @P9_QTSYMLINK: symbolic links (9P2000.u) 300 * @P9_QTLINK: hard-link (9P2000.u) 301 * @P9_QTFILE: normal files 302 * 303 * QID types are a subset of permissions - they are primarily 304 * used to differentiate semantics for a file system entity via 305 * a jump-table. Their value is also the most significant 16 bits 306 * of the permission_t 307 * 308 * See Also: http://plan9.bell-labs.com/magic/man2html/2/stat 309 */ 310 enum p9_qid_t { 311 P9_QTDIR = 0x80, 312 P9_QTAPPEND = 0x40, 313 P9_QTEXCL = 0x20, 314 P9_QTMOUNT = 0x10, 315 P9_QTAUTH = 0x08, 316 P9_QTTMP = 0x04, 317 P9_QTSYMLINK = 0x02, 318 P9_QTLINK = 0x01, 319 P9_QTFILE = 0x00, 320 }; 321 322 /* 9P Magic Numbers */ 323 #define P9_NOTAG (u16)(~0) 324 #define P9_NOFID (u32)(~0) 325 #define P9_MAXWELEM 16 326 327 /* ample room for Twrite/Rread header */ 328 #define P9_IOHDRSZ 24 329 330 /* Room for readdir header */ 331 #define P9_READDIRHDRSZ 24 332 333 /** 334 * struct p9_qid - file system entity information 335 * @type: 8-bit type &p9_qid_t 336 * @version: 16-bit monotonically incrementing version number 337 * @path: 64-bit per-server-unique ID for a file system element 338 * 339 * qids are identifiers used by 9P servers to track file system 340 * entities. The type is used to differentiate semantics for operations 341 * on the entity (ie. read means something different on a directory than 342 * on a file). The path provides a server unique index for an entity 343 * (roughly analogous to an inode number), while the version is updated 344 * every time a file is modified and can be used to maintain cache 345 * coherency between clients and serves. 346 * Servers will often differentiate purely synthetic entities by setting 347 * their version to 0, signaling that they should never be cached and 348 * should be accessed synchronously. 349 * 350 * See Also://plan9.bell-labs.com/magic/man2html/2/stat 351 */ 352 353 struct p9_qid { 354 u8 type; 355 u32 version; 356 u64 path; 357 }; 358 359 /** 360 * struct p9_wstat - file system metadata information 361 * @size: length prefix for this stat structure instance 362 * @type: the type of the server (equivalent to a major number) 363 * @dev: the sub-type of the server (equivalent to a minor number) 364 * @qid: unique id from the server of type &p9_qid 365 * @mode: Plan 9 format permissions of type &p9_perm_t 366 * @atime: Last access/read time 367 * @mtime: Last modify/write time 368 * @length: file length 369 * @name: last element of path (aka filename) 370 * @uid: owner name 371 * @gid: group owner 372 * @muid: last modifier 373 * @extension: area used to encode extended UNIX support 374 * @n_uid: numeric user id of owner (part of 9p2000.u extension) 375 * @n_gid: numeric group id (part of 9p2000.u extension) 376 * @n_muid: numeric user id of laster modifier (part of 9p2000.u extension) 377 * 378 * See Also: http://plan9.bell-labs.com/magic/man2html/2/stat 379 */ 380 381 struct p9_wstat { 382 u16 size; 383 u16 type; 384 u32 dev; 385 struct p9_qid qid; 386 u32 mode; 387 u32 atime; 388 u32 mtime; 389 u64 length; 390 char *name; 391 char *uid; 392 char *gid; 393 char *muid; 394 char *extension; /* 9p2000.u extensions */ 395 u32 n_uid; /* 9p2000.u extensions */ 396 u32 n_gid; /* 9p2000.u extensions */ 397 u32 n_muid; /* 9p2000.u extensions */ 398 }; 399 400 struct p9_stat_dotl { 401 u64 st_result_mask; 402 struct p9_qid qid; 403 u32 st_mode; 404 u32 st_uid; 405 u32 st_gid; 406 u64 st_nlink; 407 u64 st_rdev; 408 u64 st_size; 409 u64 st_blksize; 410 u64 st_blocks; 411 u64 st_atime_sec; 412 u64 st_atime_nsec; 413 u64 st_mtime_sec; 414 u64 st_mtime_nsec; 415 u64 st_ctime_sec; 416 u64 st_ctime_nsec; 417 u64 st_btime_sec; 418 u64 st_btime_nsec; 419 u64 st_gen; 420 u64 st_data_version; 421 }; 422 423 #define P9_STATS_MODE 0x00000001ULL 424 #define P9_STATS_NLINK 0x00000002ULL 425 #define P9_STATS_UID 0x00000004ULL 426 #define P9_STATS_GID 0x00000008ULL 427 #define P9_STATS_RDEV 0x00000010ULL 428 #define P9_STATS_ATIME 0x00000020ULL 429 #define P9_STATS_MTIME 0x00000040ULL 430 #define P9_STATS_CTIME 0x00000080ULL 431 #define P9_STATS_INO 0x00000100ULL 432 #define P9_STATS_SIZE 0x00000200ULL 433 #define P9_STATS_BLOCKS 0x00000400ULL 434 435 #define P9_STATS_BTIME 0x00000800ULL 436 #define P9_STATS_GEN 0x00001000ULL 437 #define P9_STATS_DATA_VERSION 0x00002000ULL 438 439 #define P9_STATS_BASIC 0x000007ffULL /* Mask for fields up to BLOCKS */ 440 #define P9_STATS_ALL 0x00003fffULL /* Mask for All fields above */ 441 442 /** 443 * struct p9_iattr_dotl - P9 inode attribute for setattr 444 * @valid: bitfield specifying which fields are valid 445 * same as in struct iattr 446 * @mode: File permission bits 447 * @uid: user id of owner 448 * @gid: group id 449 * @size: File size 450 * @atime_sec: Last access time, seconds 451 * @atime_nsec: Last access time, nanoseconds 452 * @mtime_sec: Last modification time, seconds 453 * @mtime_nsec: Last modification time, nanoseconds 454 */ 455 456 struct p9_iattr_dotl { 457 u32 valid; 458 u32 mode; 459 u32 uid; 460 u32 gid; 461 u64 size; 462 u64 atime_sec; 463 u64 atime_nsec; 464 u64 mtime_sec; 465 u64 mtime_nsec; 466 }; 467 468 #define P9_LOCK_SUCCESS 0 469 #define P9_LOCK_BLOCKED 1 470 #define P9_LOCK_ERROR 2 471 #define P9_LOCK_GRACE 3 472 473 #define P9_LOCK_FLAGS_BLOCK 1 474 #define P9_LOCK_FLAGS_RECLAIM 2 475 476 /* struct p9_flock: POSIX lock structure 477 * @type - type of lock 478 * @flags - lock flags 479 * @start - starting offset of the lock 480 * @length - number of bytes 481 * @proc_id - process id which wants to take lock 482 * @client_id - client id 483 */ 484 485 struct p9_flock { 486 u8 type; 487 u32 flags; 488 u64 start; 489 u64 length; 490 u32 proc_id; 491 char *client_id; 492 }; 493 494 /* struct p9_getlock: getlock structure 495 * @type - type of lock 496 * @start - starting offset of the lock 497 * @length - number of bytes 498 * @proc_id - process id which wants to take lock 499 * @client_id - client id 500 */ 501 502 struct p9_getlock { 503 u8 type; 504 u64 start; 505 u64 length; 506 u32 proc_id; 507 char *client_id; 508 }; 509 510 struct p9_rstatfs { 511 u32 type; 512 u32 bsize; 513 u64 blocks; 514 u64 bfree; 515 u64 bavail; 516 u64 files; 517 u64 ffree; 518 u64 fsid; 519 u32 namelen; 520 }; 521 522 /** 523 * struct p9_fcall - primary packet structure 524 * @size: prefixed length of the structure 525 * @id: protocol operating identifier of type &p9_msg_t 526 * @tag: transaction id of the request 527 * @offset: used by marshalling routines to track current position in buffer 528 * @capacity: used by marshalling routines to track total malloc'd capacity 529 * @pubuf: Payload user buffer given by the caller 530 * @pkbuf: Payload kernel buffer given by the caller 531 * @pbuf_size: pubuf/pkbuf(only one will be !NULL) size to be read/write. 532 * @private: For transport layer's use. 533 * @sdata: payload 534 * 535 * &p9_fcall represents the structure for all 9P RPC 536 * transactions. Requests are packaged into fcalls, and reponses 537 * must be extracted from them. 538 * 539 * See Also: http://plan9.bell-labs.com/magic/man2html/2/fcall 540 */ 541 542 struct p9_fcall { 543 u32 size; 544 u8 id; 545 u16 tag; 546 547 size_t offset; 548 size_t capacity; 549 char __user *pubuf; 550 char *pkbuf; 551 size_t pbuf_size; 552 void *private; 553 554 u8 *sdata; 555 }; 556 557 struct p9_idpool; 558 559 int p9_errstr2errno(char *errstr, int len); 560 561 struct p9_idpool *p9_idpool_create(void); 562 void p9_idpool_destroy(struct p9_idpool *); 563 int p9_idpool_get(struct p9_idpool *p); 564 void p9_idpool_put(int id, struct p9_idpool *p); 565 int p9_idpool_check(int id, struct p9_idpool *p); 566 567 int p9_error_init(void); 568 int p9_trans_fd_init(void); 569 void p9_trans_fd_exit(void); 570 #endif /* NET_9P_H */ 571