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