/* SPDX-License-Identifier: GPL-2.0-only */ /* * 9P protocol definitions. * * Copyright (C) 2005 by Latchesar Ionkov <[email protected]> * Copyright (C) 2004 by Eric Van Hensbergen <[email protected]> * Copyright (C) 2002 by Ron Minnich <[email protected]> */ #ifndef NET_9P_H #define NET_9P_H /** * enum p9_debug_flags - bits for mount time debug parameter * @P9_DEBUG_ERROR: more verbose error messages including original error string * @P9_DEBUG_9P: 9P protocol tracing * @P9_DEBUG_VFS: VFS API tracing * @P9_DEBUG_CONV: protocol conversion tracing * @P9_DEBUG_MUX: trace management of concurrent transactions * @P9_DEBUG_TRANS: transport tracing * @P9_DEBUG_SLABS: memory management tracing * @P9_DEBUG_FCALL: verbose dump of protocol messages * @P9_DEBUG_FID: fid allocation/deallocation tracking * @P9_DEBUG_PKT: packet marshalling/unmarshalling * @P9_DEBUG_FSC: FS-cache tracing * @P9_DEBUG_VPKT: Verbose packet debugging (full packet dump) * * These flags are passed at mount time to turn on various levels of * verbosity and tracing which will be output to the system logs. */ enum p9_debug_flags { … }; #ifdef CONFIG_NET_9P_DEBUG extern unsigned int p9_debug_level; __printf(3, 4) void _p9_debug(enum p9_debug_flags level, const char *func, const char *fmt, ...); #define p9_debug(level, fmt, ...) … #else #define p9_debug … #endif /** * enum p9_msg_t - 9P message types * @P9_TLERROR: not used * @P9_RLERROR: response for any failed request for 9P2000.L * @P9_TSTATFS: file system status request * @P9_RSTATFS: file system status response * @P9_TSYMLINK: make symlink request * @P9_RSYMLINK: make symlink response * @P9_TMKNOD: create a special file object request * @P9_RMKNOD: create a special file object response * @P9_TLCREATE: prepare a handle for I/O on an new file for 9P2000.L * @P9_RLCREATE: response with file access information for 9P2000.L * @P9_TRENAME: rename request * @P9_RRENAME: rename response * @P9_TMKDIR: create a directory request * @P9_RMKDIR: create a directory response * @P9_TVERSION: version handshake request * @P9_RVERSION: version handshake response * @P9_TAUTH: request to establish authentication channel * @P9_RAUTH: response with authentication information * @P9_TATTACH: establish user access to file service * @P9_RATTACH: response with top level handle to file hierarchy * @P9_TERROR: not used * @P9_RERROR: response for any failed request * @P9_TFLUSH: request to abort a previous request * @P9_RFLUSH: response when previous request has been cancelled * @P9_TWALK: descend a directory hierarchy * @P9_RWALK: response with new handle for position within hierarchy * @P9_TOPEN: prepare a handle for I/O on an existing file * @P9_ROPEN: response with file access information * @P9_TCREATE: prepare a handle for I/O on a new file * @P9_RCREATE: response with file access information * @P9_TREAD: request to transfer data from a file or directory * @P9_RREAD: response with data requested * @P9_TWRITE: reuqest to transfer data to a file * @P9_RWRITE: response with out much data was transferred to file * @P9_TCLUNK: forget about a handle to an entity within the file system * @P9_RCLUNK: response when server has forgotten about the handle * @P9_TREMOVE: request to remove an entity from the hierarchy * @P9_RREMOVE: response when server has removed the entity * @P9_TSTAT: request file entity attributes * @P9_RSTAT: response with file entity attributes * @P9_TWSTAT: request to update file entity attributes * @P9_RWSTAT: response when file entity attributes are updated * * There are 14 basic operations in 9P2000, paired as * requests and responses. The one special case is ERROR * as there is no @P9_TERROR request for clients to transmit to * the server, but the server may respond to any other request * with an @P9_RERROR. * * See Also: http://plan9.bell-labs.com/sys/man/5/INDEX.html */ enum p9_msg_t { … }; /** * enum p9_open_mode_t - 9P open modes * @P9_OREAD: open file for reading only * @P9_OWRITE: open file for writing only * @P9_ORDWR: open file for reading or writing * @P9_OEXEC: open file for execution * @P9_OTRUNC: truncate file to zero-length before opening it * @P9_OREXEC: close the file when an exec(2) system call is made * @P9_ORCLOSE: remove the file when the file is closed * @P9_OAPPEND: open the file and seek to the end * @P9_OEXCL: only create a file, do not open it * * 9P open modes differ slightly from Posix standard modes. * In particular, there are extra modes which specify different * semantic behaviors than may be available on standard Posix * systems. For example, @P9_OREXEC and @P9_ORCLOSE are modes that * most likely will not be issued from the Linux VFS client, but may * be supported by servers. * * See Also: http://plan9.bell-labs.com/magic/man2html/2/open */ enum p9_open_mode_t { … }; /** * enum p9_perm_t - 9P permissions * @P9_DMDIR: mode bit for directories * @P9_DMAPPEND: mode bit for is append-only * @P9_DMEXCL: mode bit for excluse use (only one open handle allowed) * @P9_DMMOUNT: mode bit for mount points * @P9_DMAUTH: mode bit for authentication file * @P9_DMTMP: mode bit for non-backed-up files * @P9_DMSYMLINK: mode bit for symbolic links (9P2000.u) * @P9_DMLINK: mode bit for hard-link (9P2000.u) * @P9_DMDEVICE: mode bit for device files (9P2000.u) * @P9_DMNAMEDPIPE: mode bit for named pipe (9P2000.u) * @P9_DMSOCKET: mode bit for socket (9P2000.u) * @P9_DMSETUID: mode bit for setuid (9P2000.u) * @P9_DMSETGID: mode bit for setgid (9P2000.u) * @P9_DMSETVTX: mode bit for sticky bit (9P2000.u) * * 9P permissions differ slightly from Posix standard modes. * * See Also: http://plan9.bell-labs.com/magic/man2html/2/stat */ enum p9_perm_t { … }; /* 9p2000.L open flags */ #define P9_DOTL_RDONLY … #define P9_DOTL_WRONLY … #define P9_DOTL_RDWR … #define P9_DOTL_NOACCESS … #define P9_DOTL_CREATE … #define P9_DOTL_EXCL … #define P9_DOTL_NOCTTY … #define P9_DOTL_TRUNC … #define P9_DOTL_APPEND … #define P9_DOTL_NONBLOCK … #define P9_DOTL_DSYNC … #define P9_DOTL_FASYNC … #define P9_DOTL_DIRECT … #define P9_DOTL_LARGEFILE … #define P9_DOTL_DIRECTORY … #define P9_DOTL_NOFOLLOW … #define P9_DOTL_NOATIME … #define P9_DOTL_CLOEXEC … #define P9_DOTL_SYNC … /* 9p2000.L at flags */ #define P9_DOTL_AT_REMOVEDIR … /* 9p2000.L lock type */ #define P9_LOCK_TYPE_RDLCK … #define P9_LOCK_TYPE_WRLCK … #define P9_LOCK_TYPE_UNLCK … /** * enum p9_qid_t - QID types * @P9_QTDIR: directory * @P9_QTAPPEND: append-only * @P9_QTEXCL: excluse use (only one open handle allowed) * @P9_QTMOUNT: mount points * @P9_QTAUTH: authentication file * @P9_QTTMP: non-backed-up files * @P9_QTSYMLINK: symbolic links (9P2000.u) * @P9_QTLINK: hard-link (9P2000.u) * @P9_QTFILE: normal files * * QID types are a subset of permissions - they are primarily * used to differentiate semantics for a file system entity via * a jump-table. Their value is also the most significant 16 bits * of the permission_t * * See Also: http://plan9.bell-labs.com/magic/man2html/2/stat */ enum p9_qid_t { … }; /* 9P Magic Numbers */ #define P9_NOTAG … #define P9_NOFID … #define P9_MAXWELEM … /* Minimal header size: size[4] type[1] tag[2] */ #define P9_HDRSZ … /* ample room for Twrite/Rread header */ #define P9_IOHDRSZ … /* Room for readdir header */ #define P9_READDIRHDRSZ … /* size of header for zero copy read/write */ #define P9_ZC_HDR_SZ … /* maximum length of an error string */ #define P9_ERRMAX … /** * struct p9_qid - file system entity information * @type: 8-bit type &p9_qid_t * @version: 16-bit monotonically incrementing version number * @path: 64-bit per-server-unique ID for a file system element * * qids are identifiers used by 9P servers to track file system * entities. The type is used to differentiate semantics for operations * on the entity (ie. read means something different on a directory than * on a file). The path provides a server unique index for an entity * (roughly analogous to an inode number), while the version is updated * every time a file is modified and can be used to maintain cache * coherency between clients and serves. * Servers will often differentiate purely synthetic entities by setting * their version to 0, signaling that they should never be cached and * should be accessed synchronously. * * See Also://plan9.bell-labs.com/magic/man2html/2/stat */ struct p9_qid { … }; /** * struct p9_wstat - file system metadata information * @size: length prefix for this stat structure instance * @type: the type of the server (equivalent to a major number) * @dev: the sub-type of the server (equivalent to a minor number) * @qid: unique id from the server of type &p9_qid * @mode: Plan 9 format permissions of type &p9_perm_t * @atime: Last access/read time * @mtime: Last modify/write time * @length: file length * @name: last element of path (aka filename) * @uid: owner name * @gid: group owner * @muid: last modifier * @extension: area used to encode extended UNIX support * @n_uid: numeric user id of owner (part of 9p2000.u extension) * @n_gid: numeric group id (part of 9p2000.u extension) * @n_muid: numeric user id of laster modifier (part of 9p2000.u extension) * * See Also: http://plan9.bell-labs.com/magic/man2html/2/stat */ struct p9_wstat { … }; struct p9_stat_dotl { … }; #define P9_STATS_MODE … #define P9_STATS_NLINK … #define P9_STATS_UID … #define P9_STATS_GID … #define P9_STATS_RDEV … #define P9_STATS_ATIME … #define P9_STATS_MTIME … #define P9_STATS_CTIME … #define P9_STATS_INO … #define P9_STATS_SIZE … #define P9_STATS_BLOCKS … #define P9_STATS_BTIME … #define P9_STATS_GEN … #define P9_STATS_DATA_VERSION … #define P9_STATS_BASIC … #define P9_STATS_ALL … /** * struct p9_iattr_dotl - P9 inode attribute for setattr * @valid: bitfield specifying which fields are valid * same as in struct iattr * @mode: File permission bits * @uid: user id of owner * @gid: group id * @size: File size * @atime_sec: Last access time, seconds * @atime_nsec: Last access time, nanoseconds * @mtime_sec: Last modification time, seconds * @mtime_nsec: Last modification time, nanoseconds */ struct p9_iattr_dotl { … }; #define P9_LOCK_SUCCESS … #define P9_LOCK_BLOCKED … #define P9_LOCK_ERROR … #define P9_LOCK_GRACE … #define P9_LOCK_FLAGS_BLOCK … #define P9_LOCK_FLAGS_RECLAIM … /* struct p9_flock: POSIX lock structure * @type - type of lock * @flags - lock flags * @start - starting offset of the lock * @length - number of bytes * @proc_id - process id which wants to take lock * @client_id - client id */ struct p9_flock { … }; /* struct p9_getlock: getlock structure * @type - type of lock * @start - starting offset of the lock * @length - number of bytes * @proc_id - process id which wants to take lock * @client_id - client id */ struct p9_getlock { … }; struct p9_rstatfs { … }; /** * struct p9_fcall - primary packet structure * @size: prefixed length of the structure * @id: protocol operating identifier of type &p9_msg_t * @tag: transaction id of the request * @offset: used by marshalling routines to track current position in buffer * @capacity: used by marshalling routines to track total malloc'd capacity * @sdata: payload * @zc: whether zero-copy is used * * &p9_fcall represents the structure for all 9P RPC * transactions. Requests are packaged into fcalls, and reponses * must be extracted from them. * * See Also: http://plan9.bell-labs.com/magic/man2html/2/fcall */ struct p9_fcall { … }; int p9_errstr2errno(char *errstr, int len); int p9_error_init(void); #endif /* NET_9P_H */
Codebase Browser
linux