include/net/9p/9p.h

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