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_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
 121  *
 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.
 127  *
 128  * See Also: http://plan9.bell-labs.com/sys/man/5/INDEX.html
 129  */
 130
 131 enum p9_msg_t {
 132         P9_TSTATFS = 8,
 133         P9_RSTATFS,
 134         P9_TRENAME = 20,
 135         P9_RRENAME,
 136         P9_TVERSION = 100,
 137         P9_RVERSION,
 138         P9_TAUTH = 102,
 139         P9_RAUTH,
 140         P9_TATTACH = 104,
 141         P9_RATTACH,
 142         P9_TERROR = 106,
 143         P9_RERROR,
 144         P9_TFLUSH = 108,
 145         P9_RFLUSH,
 146         P9_TWALK = 110,
 147         P9_RWALK,
 148         P9_TOPEN = 112,
 149         P9_ROPEN,
 150         P9_TCREATE = 114,
 151         P9_RCREATE,
 152         P9_TREAD = 116,
 153         P9_RREAD,
 154         P9_TWRITE = 118,
 155         P9_RWRITE,
 156         P9_TCLUNK = 120,
 157         P9_RCLUNK,
 158         P9_TREMOVE = 122,
 159         P9_RREMOVE,
 160         P9_TSTAT = 124,
 161         P9_RSTAT,
 162         P9_TWSTAT = 126,
 163         P9_RWSTAT,
 164 };
 165
 166 /**
 167  * enum p9_open_mode_t - 9P open modes
 168  * @P9_OREAD: open file for reading only
 169  * @P9_OWRITE: open file for writing only
 170  * @P9_ORDWR: open file for reading or writing
 171  * @P9_OEXEC: open file for execution
 172  * @P9_OTRUNC: truncate file to zero-length before opening it
 173  * @P9_OREXEC: close the file when an exec(2) system call is made
 174  * @P9_ORCLOSE: remove the file when the file is closed
 175  * @P9_OAPPEND: open the file and seek to the end
 176  * @P9_OEXCL: only create a file, do not open it
 177  *
 178  * 9P open modes differ slightly from Posix standard modes.
 179  * In particular, there are extra modes which specify different
 180  * semantic behaviors than may be available on standard Posix
 181  * systems.  For example, @P9_OREXEC and @P9_ORCLOSE are modes that
 182  * most likely will not be issued from the Linux VFS client, but may
 183  * be supported by servers.
 184  *
 185  * See Also: http://plan9.bell-labs.com/magic/man2html/2/open
 186  */
 187
 188 enum p9_open_mode_t {
 189         P9_OREAD = 0x00,
 190         P9_OWRITE = 0x01,
 191         P9_ORDWR = 0x02,
 192         P9_OEXEC = 0x03,
 193         P9_OTRUNC = 0x10,
 194         P9_OREXEC = 0x20,
 195         P9_ORCLOSE = 0x40,
 196         P9_OAPPEND = 0x80,
 197         P9_OEXCL = 0x1000,
 198 };
 199
 200 /**
 201  * enum p9_perm_t - 9P permissions
 202  * @P9_DMDIR: mode bite for directories
 203  * @P9_DMAPPEND: mode bit for is append-only
 204  * @P9_DMEXCL: mode bit for excluse use (only one open handle allowed)
 205  * @P9_DMMOUNT: mode bite for mount points
 206  * @P9_DMAUTH: mode bit for authentication file
 207  * @P9_DMTMP: mode bit for non-backed-up files
 208  * @P9_DMSYMLINK: mode bit for symbolic links (9P2000.u)
 209  * @P9_DMLINK: mode bit for hard-link (9P2000.u)
 210  * @P9_DMDEVICE: mode bit for device files (9P2000.u)
 211  * @P9_DMNAMEDPIPE: mode bit for named pipe (9P2000.u)
 212  * @P9_DMSOCKET: mode bit for socket (9P2000.u)
 213  * @P9_DMSETUID: mode bit for setuid (9P2000.u)
 214  * @P9_DMSETGID: mode bit for setgid (9P2000.u)
 215  * @P9_DMSETVTX: mode bit for sticky bit (9P2000.u)
 216  *
 217  * 9P permissions differ slightly from Posix standard modes.
 218  *
 219  * See Also: http://plan9.bell-labs.com/magic/man2html/2/stat
 220  */
 221 enum p9_perm_t {
 222         P9_DMDIR = 0x80000000,
 223         P9_DMAPPEND = 0x40000000,
 224         P9_DMEXCL = 0x20000000,
 225         P9_DMMOUNT = 0x10000000,
 226         P9_DMAUTH = 0x08000000,
 227         P9_DMTMP = 0x04000000,
 228 /* 9P2000.u extensions */
 229         P9_DMSYMLINK = 0x02000000,
 230         P9_DMLINK = 0x01000000,
 231         P9_DMDEVICE = 0x00800000,
 232         P9_DMNAMEDPIPE = 0x00200000,
 233         P9_DMSOCKET = 0x00100000,
 234         P9_DMSETUID = 0x00080000,
 235         P9_DMSETGID = 0x00040000,
 236         P9_DMSETVTX = 0x00010000,
 237 };
 238
 239 /**
 240  * enum p9_qid_t - QID types
 241  * @P9_QTDIR: directory
 242  * @P9_QTAPPEND: append-only
 243  * @P9_QTEXCL: excluse use (only one open handle allowed)
 244  * @P9_QTMOUNT: mount points
 245  * @P9_QTAUTH: authentication file
 246  * @P9_QTTMP: non-backed-up files
 247  * @P9_QTSYMLINK: symbolic links (9P2000.u)
 248  * @P9_QTLINK: hard-link (9P2000.u)
 249  * @P9_QTFILE: normal files
 250  *
 251  * QID types are a subset of permissions - they are primarily
 252  * used to differentiate semantics for a file system entity via
 253  * a jump-table.  Their value is also the most signifigant 16 bits
 254  * of the permission_t
 255  *
 256  * See Also: http://plan9.bell-labs.com/magic/man2html/2/stat
 257  */
 258 enum p9_qid_t {
 259         P9_QTDIR = 0x80,
 260         P9_QTAPPEND = 0x40,
 261         P9_QTEXCL = 0x20,
 262         P9_QTMOUNT = 0x10,
 263         P9_QTAUTH = 0x08,
 264         P9_QTTMP = 0x04,
 265         P9_QTSYMLINK = 0x02,
 266         P9_QTLINK = 0x01,
 267         P9_QTFILE = 0x00,
 268 };
 269
 270 /* 9P Magic Numbers */
 271 #define P9_NOTAG        (u16)(~0)
 272 #define P9_NOFID        (u32)(~0)
 273 #define P9_MAXWELEM     16
 274
 275 /* ample room for Twrite/Rread header */
 276 #define P9_IOHDRSZ      24
 277
 278 /**
 279  * struct p9_str - length prefixed string type
 280  * @len: length of the string
 281  * @str: the string
 282  *
 283  * The protocol uses length prefixed strings for all
 284  * string data, so we replicate that for our internal
 285  * string members.
 286  */
 287
 288 struct p9_str {
 289         u16 len;
 290         char *str;
 291 };
 292
 293 /**
 294  * struct p9_qid - file system entity information
 295  * @type: 8-bit type &p9_qid_t
 296  * @version: 16-bit monotonically incrementing version number
 297  * @path: 64-bit per-server-unique ID for a file system element
 298  *
 299  * qids are identifiers used by 9P servers to track file system
 300  * entities.  The type is used to differentiate semantics for operations
 301  * on the entity (ie. read means something different on a directory than
 302  * on a file).  The path provides a server unique index for an entity
 303  * (roughly analogous to an inode number), while the version is updated
 304  * every time a file is modified and can be used to maintain cache
 305  * coherency between clients and serves.
 306  * Servers will often differentiate purely synthetic entities by setting
 307  * their version to 0, signaling that they should never be cached and
 308  * should be accessed synchronously.
 309  *
 310  * See Also://plan9.bell-labs.com/magic/man2html/2/stat
 311  */
 312
 313 struct p9_qid {
 314         u8 type;
 315         u32 version;
 316         u64 path;
 317 };
 318
 319 /**
 320  * struct p9_stat - file system metadata information
 321  * @size: length prefix for this stat structure instance
 322  * @type: the type of the server (equivilent to a major number)
 323  * @dev: the sub-type of the server (equivilent to a minor number)
 324  * @qid: unique id from the server of type &p9_qid
 325  * @mode: Plan 9 format permissions of type &p9_perm_t
 326  * @atime: Last access/read time
 327  * @mtime: Last modify/write time
 328  * @length: file length
 329  * @name: last element of path (aka filename) in type &p9_str
 330  * @uid: owner name in type &p9_str
 331  * @gid: group owner in type &p9_str
 332  * @muid: last modifier in type &p9_str
 333  * @extension: area used to encode extended UNIX support in type &p9_str
 334  * @n_uid: numeric user id of owner (part of 9p2000.u extension)
 335  * @n_gid: numeric group id (part of 9p2000.u extension)
 336  * @n_muid: numeric user id of laster modifier (part of 9p2000.u extension)
 337  *
 338  * See Also: http://plan9.bell-labs.com/magic/man2html/2/stat
 339  */
 340
 341 struct p9_wstat {
 342         u16 size;
 343         u16 type;
 344         u32 dev;
 345         struct p9_qid qid;
 346         u32 mode;
 347         u32 atime;
 348         u32 mtime;
 349         u64 length;
 350         char *name;
 351         char *uid;
 352         char *gid;
 353         char *muid;
 354         char *extension;        /* 9p2000.u extensions */
 355         u32 n_uid;              /* 9p2000.u extensions */
 356         u32 n_gid;              /* 9p2000.u extensions */
 357         u32 n_muid;             /* 9p2000.u extensions */
 358 };
 359
 360 /* Structures for Protocol Operations */
 361 struct p9_tstatfs {
 362         u32 fid;
 363 };
 364
 365 struct p9_rstatfs {
 366         u32 type;
 367         u32 bsize;
 368         u64 blocks;
 369         u64 bfree;
 370         u64 bavail;
 371         u64 files;
 372         u64 ffree;
 373         u64 fsid;
 374         u32 namelen;
 375 };
 376
 377 struct p9_trename {
 378         u32 fid;
 379         u32 newdirfid;
 380         struct p9_str name;
 381 };
 382
 383 struct p9_rrename {
 384 };
 385
 386 struct p9_tversion {
 387         u32 msize;
 388         struct p9_str version;
 389 };
 390
 391 struct p9_rversion {
 392         u32 msize;
 393         struct p9_str version;
 394 };
 395
 396 struct p9_tauth {
 397         u32 afid;
 398         struct p9_str uname;
 399         struct p9_str aname;
 400         u32 n_uname;            /* 9P2000.u extensions */
 401 };
 402
 403 struct p9_rauth {
 404         struct p9_qid qid;
 405 };
 406
 407 struct p9_rerror {
 408         struct p9_str error;
 409         u32 errno;              /* 9p2000.u extension */
 410 };
 411
 412 struct p9_tflush {
 413         u16 oldtag;
 414 };
 415
 416 struct p9_rflush {
 417 };
 418
 419 struct p9_tattach {
 420         u32 fid;
 421         u32 afid;
 422         struct p9_str uname;
 423         struct p9_str aname;
 424         u32 n_uname;            /* 9P2000.u extensions */
 425 };
 426
 427 struct p9_rattach {
 428         struct p9_qid qid;
 429 };
 430
 431 struct p9_twalk {
 432         u32 fid;
 433         u32 newfid;
 434         u16 nwname;
 435         struct p9_str wnames[16];
 436 };
 437
 438 struct p9_rwalk {
 439         u16 nwqid;
 440         struct p9_qid wqids[16];
 441 };
 442
 443 struct p9_topen {
 444         u32 fid;
 445         u8 mode;
 446 };
 447
 448 struct p9_ropen {
 449         struct p9_qid qid;
 450         u32 iounit;
 451 };
 452
 453 struct p9_tcreate {
 454         u32 fid;
 455         struct p9_str name;
 456         u32 perm;
 457         u8 mode;
 458         struct p9_str extension;
 459 };
 460
 461 struct p9_rcreate {
 462         struct p9_qid qid;
 463         u32 iounit;
 464 };
 465
 466 struct p9_tread {
 467         u32 fid;
 468         u64 offset;
 469         u32 count;
 470 };
 471
 472 struct p9_rread {
 473         u32 count;
 474         u8 *data;
 475 };
 476
 477 struct p9_twrite {
 478         u32 fid;
 479         u64 offset;
 480         u32 count;
 481         u8 *data;
 482 };
 483
 484 struct p9_rwrite {
 485         u32 count;
 486 };
 487
 488 struct p9_tclunk {
 489         u32 fid;
 490 };
 491
 492 struct p9_rclunk {
 493 };
 494
 495 struct p9_tremove {
 496         u32 fid;
 497 };
 498
 499 struct p9_rremove {
 500 };
 501
 502 struct p9_tstat {
 503         u32 fid;
 504 };
 505
 506 struct p9_rstat {
 507         struct p9_wstat stat;
 508 };
 509
 510 struct p9_twstat {
 511         u32 fid;
 512         struct p9_wstat stat;
 513 };
 514
 515 struct p9_rwstat {
 516 };
 517
 518 /**
 519  * struct p9_fcall - primary packet structure
 520  * @size: prefixed length of the structure
 521  * @id: protocol operating identifier of type &p9_msg_t
 522  * @tag: transaction id of the request
 523  * @offset: used by marshalling routines to track currentposition in buffer
 524  * @capacity: used by marshalling routines to track total capacity
 525  * @sdata: payload
 526  *
 527  * &p9_fcall represents the structure for all 9P RPC
 528  * transactions.  Requests are packaged into fcalls, and reponses
 529  * must be extracted from them.
 530  *
 531  * See Also: http://plan9.bell-labs.com/magic/man2html/2/fcall
 532  */
 533
 534 struct p9_fcall {
 535         u32 size;
 536         u8 id;
 537         u16 tag;
 538
 539         size_t offset;
 540         size_t capacity;
 541
 542         uint8_t *sdata;
 543 };
 544
 545 struct p9_idpool;
 546
 547 int p9_errstr2errno(char *errstr, int len);
 548
 549 struct p9_idpool *p9_idpool_create(void);
 550 void p9_idpool_destroy(struct p9_idpool *);
 551 int p9_idpool_get(struct p9_idpool *p);
 552 void p9_idpool_put(int id, struct p9_idpool *p);
 553 int p9_idpool_check(int id, struct p9_idpool *p);
 554
 555 int p9_error_init(void);
 556 int p9_errstr2errno(char *, int);
 557 int p9_trans_fd_init(void);
 558 void p9_trans_fd_exit(void);
 559 #endif /* NET_9P_H */