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 * 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. 46 */ 47 48enum p9_debug_flags { 49 P9_DEBUG_ERROR = (1<<0), 50 P9_DEBUG_9P = (1<<2), 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), 60}; 61 62#ifdef CONFIG_NET_9P_DEBUG 63extern unsigned int p9_debug_level; 64 65#define P9_DPRINTK(level, format, arg...) \ 66do { \ 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); \ 71 else \ 72 printk(KERN_NOTICE "-- %s (%d): " \ 73 format , __func__, task_pid_nr(current) , ## arg); \ 74 } \ 75} while (0) 76 77#else 78#define P9_DPRINTK(level, format, arg...) do { } while (0) 79#endif 80 81#define P9_EPRINTK(level, format, arg...) \ 82do { \ 83 printk(level "9p: %s (%d): " \ 84 format , __func__, task_pid_nr(current), ## arg); \ 85} while (0) 86 87/** 88 * enum p9_msg_t - 9P message types 89 * @P9_TSTATFS: file system status request 90 * @P9_RSTATFS: file system status response 91 * @P9_TSYMLINK: make symlink request 92 * @P9_RSYMLINK: make symlink response 93 * @P9_TMKNOD: create a special file object request 94 * @P9_RMKNOD: create a special file object response 95 * @P9_TLCREATE: prepare a handle for I/O on an new file for 9P2000.L 96 * @P9_RLCREATE: response with file access information for 9P2000.L 97 * @P9_TRENAME: rename request 98 * @P9_RRENAME: rename response 99 * @P9_TMKDIR: create a directory request 100 * @P9_RMKDIR: create a directory response 101 * @P9_TVERSION: version handshake request 102 * @P9_RVERSION: version handshake response 103 * @P9_TAUTH: request to establish authentication channel 104 * @P9_RAUTH: response with authentication information 105 * @P9_TATTACH: establish user access to file service 106 * @P9_RATTACH: response with top level handle to file hierarchy 107 * @P9_TERROR: not used 108 * @P9_RERROR: response for any failed request 109 * @P9_TFLUSH: request to abort a previous request 110 * @P9_RFLUSH: response when previous request has been cancelled 111 * @P9_TWALK: descend a directory hierarchy 112 * @P9_RWALK: response with new handle for position within hierarchy 113 * @P9_TOPEN: prepare a handle for I/O on an existing file 114 * @P9_ROPEN: response with file access information 115 * @P9_TCREATE: prepare a handle for I/O on a new file 116 * @P9_RCREATE: response with file access information 117 * @P9_TREAD: request to transfer data from a file or directory 118 * @P9_RREAD: response with data requested 119 * @P9_TWRITE: reuqest to transfer data to a file 120 * @P9_RWRITE: response with out much data was transfered to file 121 * @P9_TCLUNK: forget about a handle to an entity within the file system 122 * @P9_RCLUNK: response when server has forgotten about the handle 123 * @P9_TREMOVE: request to remove an entity from the hierarchy 124 * @P9_RREMOVE: response when server has removed the entity 125 * @P9_TSTAT: request file entity attributes 126 * @P9_RSTAT: response with file entity attributes 127 * @P9_TWSTAT: request to update file entity attributes 128 * @P9_RWSTAT: response when file entity attributes are updated 129 * 130 * There are 14 basic operations in 9P2000, paired as 131 * requests and responses. The one special case is ERROR 132 * as there is no @P9_TERROR request for clients to transmit to 133 * the server, but the server may respond to any other request 134 * with an @P9_RERROR. 135 * 136 * See Also: http://plan9.bell-labs.com/sys/man/5/INDEX.html 137 */ 138 139enum p9_msg_t { 140 P9_TSTATFS = 8, 141 P9_RSTATFS, 142 P9_TLOPEN = 12, 143 P9_RLOPEN, 144 P9_TLCREATE = 14, 145 P9_RLCREATE, 146 P9_TSYMLINK = 16, 147 P9_RSYMLINK, 148 P9_TMKNOD = 18, 149 P9_RMKNOD, 150 P9_TRENAME = 20, 151 P9_RRENAME, 152 P9_TGETATTR = 24, 153 P9_RGETATTR, 154 P9_TSETATTR = 26, 155 P9_RSETATTR, 156 P9_TXATTRWALK = 30, 157 P9_RXATTRWALK, 158 P9_TXATTRCREATE = 32, 159 P9_RXATTRCREATE, 160 P9_TREADDIR = 40, 161 P9_RREADDIR, 162 P9_TLINK = 70, 163 P9_RLINK, 164 P9_TMKDIR = 72, 165 P9_RMKDIR, 166 P9_TVERSION = 100, 167 P9_RVERSION, 168 P9_TAUTH = 102, 169 P9_RAUTH, 170 P9_TATTACH = 104, 171 P9_RATTACH, 172 P9_TERROR = 106, 173 P9_RERROR, 174 P9_TFLUSH = 108, 175 P9_RFLUSH, 176 P9_TWALK = 110, 177 P9_RWALK, 178 P9_TOPEN = 112, 179 P9_ROPEN, 180 P9_TCREATE = 114, 181 P9_RCREATE, 182 P9_TREAD = 116, 183 P9_RREAD, 184 P9_TWRITE = 118, 185 P9_RWRITE, 186 P9_TCLUNK = 120, 187 P9_RCLUNK, 188 P9_TREMOVE = 122, 189 P9_RREMOVE, 190 P9_TSTAT = 124, 191 P9_RSTAT, 192 P9_TWSTAT = 126, 193 P9_RWSTAT, 194}; 195 196/** 197 * enum p9_open_mode_t - 9P open modes 198 * @P9_OREAD: open file for reading only 199 * @P9_OWRITE: open file for writing only 200 * @P9_ORDWR: open file for reading or writing 201 * @P9_OEXEC: open file for execution 202 * @P9_OTRUNC: truncate file to zero-length before opening it 203 * @P9_OREXEC: close the file when an exec(2) system call is made 204 * @P9_ORCLOSE: remove the file when the file is closed 205 * @P9_OAPPEND: open the file and seek to the end 206 * @P9_OEXCL: only create a file, do not open it 207 * 208 * 9P open modes differ slightly from Posix standard modes. 209 * In particular, there are extra modes which specify different 210 * semantic behaviors than may be available on standard Posix 211 * systems. For example, @P9_OREXEC and @P9_ORCLOSE are modes that 212 * most likely will not be issued from the Linux VFS client, but may 213 * be supported by servers. 214 * 215 * See Also: http://plan9.bell-labs.com/magic/man2html/2/open 216 */ 217 218enum p9_open_mode_t { 219 P9_OREAD = 0x00, 220 P9_OWRITE = 0x01, 221 P9_ORDWR = 0x02, 222 P9_OEXEC = 0x03, 223 P9_OTRUNC = 0x10, 224 P9_OREXEC = 0x20, 225 P9_ORCLOSE = 0x40, 226 P9_OAPPEND = 0x80, 227 P9_OEXCL = 0x1000, 228}; 229 230/** 231 * enum p9_perm_t - 9P permissions 232 * @P9_DMDIR: mode bite for directories 233 * @P9_DMAPPEND: mode bit for is append-only 234 * @P9_DMEXCL: mode bit for excluse use (only one open handle allowed) 235 * @P9_DMMOUNT: mode bite for mount points 236 * @P9_DMAUTH: mode bit for authentication file 237 * @P9_DMTMP: mode bit for non-backed-up files 238 * @P9_DMSYMLINK: mode bit for symbolic links (9P2000.u) 239 * @P9_DMLINK: mode bit for hard-link (9P2000.u) 240 * @P9_DMDEVICE: mode bit for device files (9P2000.u) 241 * @P9_DMNAMEDPIPE: mode bit for named pipe (9P2000.u) 242 * @P9_DMSOCKET: mode bit for socket (9P2000.u) 243 * @P9_DMSETUID: mode bit for setuid (9P2000.u) 244 * @P9_DMSETGID: mode bit for setgid (9P2000.u) 245 * @P9_DMSETVTX: mode bit for sticky bit (9P2000.u) 246 * 247 * 9P permissions differ slightly from Posix standard modes. 248 * 249 * See Also: http://plan9.bell-labs.com/magic/man2html/2/stat 250 */ 251enum p9_perm_t { 252 P9_DMDIR = 0x80000000, 253 P9_DMAPPEND = 0x40000000, 254 P9_DMEXCL = 0x20000000, 255 P9_DMMOUNT = 0x10000000, 256 P9_DMAUTH = 0x08000000, 257 P9_DMTMP = 0x04000000, 258/* 9P2000.u extensions */ 259 P9_DMSYMLINK = 0x02000000, 260 P9_DMLINK = 0x01000000, 261 P9_DMDEVICE = 0x00800000, 262 P9_DMNAMEDPIPE = 0x00200000, 263 P9_DMSOCKET = 0x00100000, 264 P9_DMSETUID = 0x00080000, 265 P9_DMSETGID = 0x00040000, 266 P9_DMSETVTX = 0x00010000, 267}; 268 269/** 270 * enum p9_qid_t - QID types 271 * @P9_QTDIR: directory 272 * @P9_QTAPPEND: append-only 273 * @P9_QTEXCL: excluse use (only one open handle allowed) 274 * @P9_QTMOUNT: mount points 275 * @P9_QTAUTH: authentication file 276 * @P9_QTTMP: non-backed-up files 277 * @P9_QTSYMLINK: symbolic links (9P2000.u) 278 * @P9_QTLINK: hard-link (9P2000.u) 279 * @P9_QTFILE: normal files 280 * 281 * QID types are a subset of permissions - they are primarily 282 * used to differentiate semantics for a file system entity via 283 * a jump-table. Their value is also the most signifigant 16 bits 284 * of the permission_t 285 * 286 * See Also: http://plan9.bell-labs.com/magic/man2html/2/stat 287 */ 288enum p9_qid_t { 289 P9_QTDIR = 0x80, 290 P9_QTAPPEND = 0x40, 291 P9_QTEXCL = 0x20, 292 P9_QTMOUNT = 0x10, 293 P9_QTAUTH = 0x08, 294 P9_QTTMP = 0x04, 295 P9_QTSYMLINK = 0x02, 296 P9_QTLINK = 0x01, 297 P9_QTFILE = 0x00, 298}; 299 300/* 9P Magic Numbers */ 301#define P9_NOTAG (u16)(~0) 302#define P9_NOFID (u32)(~0) 303#define P9_MAXWELEM 16 304 305/* ample room for Twrite/Rread header */ 306#define P9_IOHDRSZ 24 307 308/* Room for readdir header */ 309#define P9_READDIRHDRSZ 24 310 311/** 312 * struct p9_str - length prefixed string type 313 * @len: length of the string 314 * @str: the string 315 * 316 * The protocol uses length prefixed strings for all 317 * string data, so we replicate that for our internal 318 * string members. 319 */ 320 321struct p9_str { 322 u16 len; 323 char *str; 324}; 325 326/** 327 * struct p9_qid - file system entity information 328 * @type: 8-bit type &p9_qid_t 329 * @version: 16-bit monotonically incrementing version number 330 * @path: 64-bit per-server-unique ID for a file system element 331 * 332 * qids are identifiers used by 9P servers to track file system 333 * entities. The type is used to differentiate semantics for operations 334 * on the entity (ie. read means something different on a directory than 335 * on a file). The path provides a server unique index for an entity 336 * (roughly analogous to an inode number), while the version is updated 337 * every time a file is modified and can be used to maintain cache 338 * coherency between clients and serves. 339 * Servers will often differentiate purely synthetic entities by setting 340 * their version to 0, signaling that they should never be cached and 341 * should be accessed synchronously. 342 * 343 * See Also://plan9.bell-labs.com/magic/man2html/2/stat 344 */ 345 346struct p9_qid { 347 u8 type; 348 u32 version; 349 u64 path; 350}; 351 352/** 353 * struct p9_stat - file system metadata information 354 * @size: length prefix for this stat structure instance 355 * @type: the type of the server (equivilent to a major number) 356 * @dev: the sub-type of the server (equivilent to a minor number) 357 * @qid: unique id from the server of type &p9_qid 358 * @mode: Plan 9 format permissions of type &p9_perm_t 359 * @atime: Last access/read time 360 * @mtime: Last modify/write time 361 * @length: file length 362 * @name: last element of path (aka filename) in type &p9_str 363 * @uid: owner name in type &p9_str 364 * @gid: group owner in type &p9_str 365 * @muid: last modifier in type &p9_str 366 * @extension: area used to encode extended UNIX support in type &p9_str 367 * @n_uid: numeric user id of owner (part of 9p2000.u extension) 368 * @n_gid: numeric group id (part of 9p2000.u extension) 369 * @n_muid: numeric user id of laster modifier (part of 9p2000.u extension) 370 * 371 * See Also: http://plan9.bell-labs.com/magic/man2html/2/stat 372 */ 373 374struct p9_wstat { 375 u16 size; 376 u16 type; 377 u32 dev; 378 struct p9_qid qid; 379 u32 mode; 380 u32 atime; 381 u32 mtime; 382 u64 length; 383 char *name; 384 char *uid; 385 char *gid; 386 char *muid; 387 char *extension; /* 9p2000.u extensions */ 388 u32 n_uid; /* 9p2000.u extensions */ 389 u32 n_gid; /* 9p2000.u extensions */ 390 u32 n_muid; /* 9p2000.u extensions */ 391}; 392 393struct p9_stat_dotl { 394 u64 st_result_mask; 395 struct p9_qid qid; 396 u32 st_mode; 397 u32 st_uid; 398 u32 st_gid; 399 u64 st_nlink; 400 u64 st_rdev; 401 u64 st_size; 402 u64 st_blksize; 403 u64 st_blocks; 404 u64 st_atime_sec; 405 u64 st_atime_nsec; 406 u64 st_mtime_sec; 407 u64 st_mtime_nsec; 408 u64 st_ctime_sec; 409 u64 st_ctime_nsec; 410 u64 st_btime_sec; 411 u64 st_btime_nsec; 412 u64 st_gen; 413 u64 st_data_version; 414}; 415 416#define P9_STATS_MODE 0x00000001ULL 417#define P9_STATS_NLINK 0x00000002ULL 418#define P9_STATS_UID 0x00000004ULL 419#define P9_STATS_GID 0x00000008ULL 420#define P9_STATS_RDEV 0x00000010ULL 421#define P9_STATS_ATIME 0x00000020ULL 422#define P9_STATS_MTIME 0x00000040ULL 423#define P9_STATS_CTIME 0x00000080ULL 424#define P9_STATS_INO 0x00000100ULL 425#define P9_STATS_SIZE 0x00000200ULL 426#define P9_STATS_BLOCKS 0x00000400ULL 427 428#define P9_STATS_BTIME 0x00000800ULL 429#define P9_STATS_GEN 0x00001000ULL 430#define P9_STATS_DATA_VERSION 0x00002000ULL 431 432#define P9_STATS_BASIC 0x000007ffULL /* Mask for fields up to BLOCKS */ 433#define P9_STATS_ALL 0x00003fffULL /* Mask for All fields above */ 434 435/** 436 * struct p9_iattr_dotl - P9 inode attribute for setattr 437 * @valid: bitfield specifying which fields are valid 438 * same as in struct iattr 439 * @mode: File permission bits 440 * @uid: user id of owner 441 * @gid: group id 442 * @size: File size 443 * @atime_sec: Last access time, seconds 444 * @atime_nsec: Last access time, nanoseconds 445 * @mtime_sec: Last modification time, seconds 446 * @mtime_nsec: Last modification time, nanoseconds 447 */ 448 449struct p9_iattr_dotl { 450 u32 valid; 451 u32 mode; 452 u32 uid; 453 u32 gid; 454 u64 size; 455 u64 atime_sec; 456 u64 atime_nsec; 457 u64 mtime_sec; 458 u64 mtime_nsec; 459}; 460 461/* Structures for Protocol Operations */ 462struct p9_tstatfs { 463 u32 fid; 464}; 465 466struct p9_rstatfs { 467 u32 type; 468 u32 bsize; 469 u64 blocks; 470 u64 bfree; 471 u64 bavail; 472 u64 files; 473 u64 ffree; 474 u64 fsid; 475 u32 namelen; 476}; 477 478struct p9_trename { 479 u32 fid; 480 u32 newdirfid; 481 struct p9_str name; 482}; 483 484struct p9_rrename { 485}; 486 487struct p9_tversion { 488 u32 msize; 489 struct p9_str version; 490}; 491 492struct p9_rversion { 493 u32 msize; 494 struct p9_str version; 495}; 496 497struct p9_tauth { 498 u32 afid; 499 struct p9_str uname; 500 struct p9_str aname; 501 u32 n_uname; /* 9P2000.u extensions */ 502}; 503 504struct p9_rauth { 505 struct p9_qid qid; 506}; 507 508struct p9_rerror { 509 struct p9_str error; 510 u32 errno; /* 9p2000.u extension */ 511}; 512 513struct p9_tflush { 514 u16 oldtag; 515}; 516 517struct p9_rflush { 518}; 519 520struct p9_tattach { 521 u32 fid; 522 u32 afid; 523 struct p9_str uname; 524 struct p9_str aname; 525 u32 n_uname; /* 9P2000.u extensions */ 526}; 527 528struct p9_rattach { 529 struct p9_qid qid; 530}; 531 532struct p9_twalk { 533 u32 fid; 534 u32 newfid; 535 u16 nwname; 536 struct p9_str wnames[16]; 537}; 538 539struct p9_rwalk { 540 u16 nwqid; 541 struct p9_qid wqids[16]; 542}; 543 544struct p9_topen { 545 u32 fid; 546 u8 mode; 547}; 548 549struct p9_ropen { 550 struct p9_qid qid; 551 u32 iounit; 552}; 553 554struct p9_tcreate { 555 u32 fid; 556 struct p9_str name; 557 u32 perm; 558 u8 mode; 559 struct p9_str extension; 560}; 561 562struct p9_rcreate { 563 struct p9_qid qid; 564 u32 iounit; 565}; 566 567struct p9_tread { 568 u32 fid; 569 u64 offset; 570 u32 count; 571}; 572 573struct p9_rread { 574 u32 count; 575 u8 *data; 576}; 577 578struct p9_twrite { 579 u32 fid; 580 u64 offset; 581 u32 count; 582 u8 *data; 583}; 584 585struct p9_rwrite { 586 u32 count; 587}; 588 589struct p9_treaddir { 590 u32 fid; 591 u64 offset; 592 u32 count; 593}; 594 595struct p9_rreaddir { 596 u32 count; 597 u8 *data; 598}; 599 600 601struct p9_tclunk { 602 u32 fid; 603}; 604 605struct p9_rclunk { 606}; 607 608struct p9_tremove { 609 u32 fid; 610}; 611 612struct p9_rremove { 613}; 614 615struct p9_tstat { 616 u32 fid; 617}; 618 619struct p9_rstat { 620 struct p9_wstat stat; 621}; 622 623struct p9_twstat { 624 u32 fid; 625 struct p9_wstat stat; 626}; 627 628struct p9_rwstat { 629}; 630 631/** 632 * struct p9_fcall - primary packet structure 633 * @size: prefixed length of the structure 634 * @id: protocol operating identifier of type &p9_msg_t 635 * @tag: transaction id of the request 636 * @offset: used by marshalling routines to track currentposition in buffer 637 * @capacity: used by marshalling routines to track total capacity 638 * @sdata: payload 639 * 640 * &p9_fcall represents the structure for all 9P RPC 641 * transactions. Requests are packaged into fcalls, and reponses 642 * must be extracted from them. 643 * 644 * See Also: http://plan9.bell-labs.com/magic/man2html/2/fcall 645 */ 646 647struct p9_fcall { 648 u32 size; 649 u8 id; 650 u16 tag; 651 652 size_t offset; 653 size_t capacity; 654 655 uint8_t *sdata; 656}; 657 658struct p9_idpool; 659 660int p9_errstr2errno(char *errstr, int len); 661 662struct p9_idpool *p9_idpool_create(void); 663void p9_idpool_destroy(struct p9_idpool *); 664int p9_idpool_get(struct p9_idpool *p); 665void p9_idpool_put(int id, struct p9_idpool *p); 666int p9_idpool_check(int id, struct p9_idpool *p); 667 668int p9_error_init(void); 669int p9_errstr2errno(char *, int); 670int p9_trans_fd_init(void); 671void p9_trans_fd_exit(void); 672#endif /* NET_9P_H */ 673