11f327613SThomas Gleixner /* SPDX-License-Identifier: GPL-2.0-only */ 29e82cf6aSEric Van Hensbergen /* 39e82cf6aSEric Van Hensbergen * V9FS definitions. 49e82cf6aSEric Van Hensbergen * 58a0dc95fSEric Van Hensbergen * Copyright (C) 2004-2008 by Eric Van Hensbergen <ericvh@gmail.com> 69e82cf6aSEric Van Hensbergen * Copyright (C) 2002 by Ron Minnich <rminnich@lanl.gov> 79e82cf6aSEric Van Hensbergen */ 8e0459f57SAneesh Kumar K.V #ifndef FS_9P_V9FS_H 9e0459f57SAneesh Kumar K.V #define FS_9P_V9FS_H 10e0459f57SAneesh Kumar K.V 110ed07ddbSJens Axboe #include <linux/backing-dev.h> 12bc899ee1SDavid Howells #include <linux/netfs.h> 139e82cf6aSEric Van Hensbergen 14ee443996SEric Van Hensbergen /** 15ee443996SEric Van Hensbergen * enum p9_session_flags - option flags for each 9P session 16dd6102fbSSripathi Kodi * @V9FS_PROTO_2000U: whether or not to use 9P2000.u extensions 1745bc21edSSripathi Kodi * @V9FS_PROTO_2000L: whether or not to use 9P2000.l extensions 18ee443996SEric Van Hensbergen * @V9FS_ACCESS_SINGLE: only the mounting user can access the hierarchy 19ee443996SEric Van Hensbergen * @V9FS_ACCESS_USER: a new attach will be issued for every user (default) 20e782ef71SVenkateswararao Jujjuri (JV) * @V9FS_ACCESS_CLIENT: Just like user, but access check is performed on client. 21ee443996SEric Van Hensbergen * @V9FS_ACCESS_ANY: use a single attach for all users 22ee443996SEric Van Hensbergen * @V9FS_ACCESS_MASK: bit mask of different ACCESS options 23e782ef71SVenkateswararao Jujjuri (JV) * @V9FS_POSIX_ACL: POSIX ACLs are enforced 249e82cf6aSEric Van Hensbergen * 25ee443996SEric Van Hensbergen * Session flags reflect options selected by users at mount time 26ee443996SEric Van Hensbergen */ 2776381a42SAneesh Kumar K.V #define V9FS_ACCESS_ANY (V9FS_ACCESS_SINGLE | \ 2876381a42SAneesh Kumar K.V V9FS_ACCESS_USER | \ 2976381a42SAneesh Kumar K.V V9FS_ACCESS_CLIENT) 3076381a42SAneesh Kumar K.V #define V9FS_ACCESS_MASK V9FS_ACCESS_ANY 31e782ef71SVenkateswararao Jujjuri (JV) #define V9FS_ACL_MASK V9FS_POSIX_ACL 3276381a42SAneesh Kumar K.V 33ee443996SEric Van Hensbergen enum p9_session_flags { 34dd6102fbSSripathi Kodi V9FS_PROTO_2000U = 0x01, 3545bc21edSSripathi Kodi V9FS_PROTO_2000L = 0x02, 36dd6102fbSSripathi Kodi V9FS_ACCESS_SINGLE = 0x04, 37dd6102fbSSripathi Kodi V9FS_ACCESS_USER = 0x08, 38e782ef71SVenkateswararao Jujjuri (JV) V9FS_ACCESS_CLIENT = 0x10, 39*8142db4fSEric Van Hensbergen V9FS_POSIX_ACL = 0x20, 40*8142db4fSEric Van Hensbergen V9FS_NO_XATTR = 0x40 41ee443996SEric Van Hensbergen }; 42ee443996SEric Van Hensbergen 43ee443996SEric Van Hensbergen /* possible values of ->cache */ 44ee443996SEric Van Hensbergen /** 45ee443996SEric Van Hensbergen * enum p9_cache_modes - user specified cache preferences 46ee443996SEric Van Hensbergen * @CACHE_NONE: do not cache data, dentries, or directory contents (default) 47ee443996SEric Van Hensbergen * @CACHE_LOOSE: cache data, dentries, and directory contents w/no consistency 48ee443996SEric Van Hensbergen * 49ee443996SEric Van Hensbergen * eventually support loose, tight, time, session, default always none 50ee443996SEric Van Hensbergen */ 51ee443996SEric Van Hensbergen 52ee443996SEric Van Hensbergen enum p9_cache_modes { 53ee443996SEric Van Hensbergen CACHE_NONE, 54d9bc0d11SEric Van Hensbergen CACHE_READAHEAD, 55d9bc0d11SEric Van Hensbergen CACHE_WRITEBACK, 56fb89b45cSDominique Martinet CACHE_MMAP, 57ee443996SEric Van Hensbergen CACHE_LOOSE, 5860e78d2cSAbhishek Kulkarni CACHE_FSCACHE, 59c4fac910SDavid Howells nr__p9_cache_modes 60ee443996SEric Van Hensbergen }; 61ee443996SEric Van Hensbergen 62ee443996SEric Van Hensbergen /** 63ee443996SEric Van Hensbergen * struct v9fs_session_info - per-instance session information 64ee443996SEric Van Hensbergen * @flags: session options of type &p9_session_flags 65ee443996SEric Van Hensbergen * @nodev: set to 1 to disable device mapping 66ee443996SEric Van Hensbergen * @debug: debug level 67ee443996SEric Van Hensbergen * @afid: authentication handle 68ee443996SEric Van Hensbergen * @cache: cache mode of type &p9_cache_modes 6960e78d2cSAbhishek Kulkarni * @cachetag: the tag of the cache associated with this session 7060e78d2cSAbhishek Kulkarni * @fscache: session cookie associated with FS-Cache 71ee443996SEric Van Hensbergen * @uname: string user name to mount hierarchy as 72ee443996SEric Van Hensbergen * @aname: mount specifier for remote hierarchy 73ee443996SEric Van Hensbergen * @maxdata: maximum data to be sent/recvd per protocol message 74ee443996SEric Van Hensbergen * @dfltuid: default numeric userid to mount hierarchy as 75ee443996SEric Van Hensbergen * @dfltgid: default numeric groupid to mount hierarchy as 76ee443996SEric Van Hensbergen * @uid: if %V9FS_ACCESS_SINGLE, the numeric uid which mounted the hierarchy 77ee443996SEric Van Hensbergen * @clnt: reference to 9P network client instantiated for this session 7860e78d2cSAbhishek Kulkarni * @slist: reference to list of registered 9p sessions 79ee443996SEric Van Hensbergen * 80ee443996SEric Van Hensbergen * This structure holds state for each session instance established during 81ee443996SEric Van Hensbergen * a sys_mount() . 82ee443996SEric Van Hensbergen * 83ee443996SEric Van Hensbergen * Bugs: there seems to be a lot of state which could be condensed and/or 84ee443996SEric Van Hensbergen * removed. 859e82cf6aSEric Van Hensbergen */ 869e82cf6aSEric Van Hensbergen 879e82cf6aSEric Van Hensbergen struct v9fs_session_info { 889e82cf6aSEric Van Hensbergen /* options */ 89ee443996SEric Van Hensbergen unsigned char flags; 90ee443996SEric Van Hensbergen unsigned char nodev; 91ee443996SEric Van Hensbergen unsigned short debug; 92ee443996SEric Van Hensbergen unsigned int afid; 93ee443996SEric Van Hensbergen unsigned int cache; 9460e78d2cSAbhishek Kulkarni #ifdef CONFIG_9P_FSCACHE 9560e78d2cSAbhishek Kulkarni char *cachetag; 9624e42e32SDavid Howells struct fscache_volume *fscache; 9760e78d2cSAbhishek Kulkarni #endif 989e82cf6aSEric Van Hensbergen 99ba17674fSLatchesar Ionkov char *uname; /* user name to mount as */ 100ba17674fSLatchesar Ionkov char *aname; /* name of remote hierarchy being mounted */ 1018a0dc95fSEric Van Hensbergen unsigned int maxdata; /* max data for client interface */ 10276ed23a5SEric W. Biederman kuid_t dfltuid; /* default uid/muid for legacy support */ 10376ed23a5SEric W. Biederman kgid_t dfltgid; /* default gid for legacy support */ 10476ed23a5SEric W. Biederman kuid_t uid; /* if ACCESS_SINGLE, the uid that has access */ 105bd238fb4SLatchesar Ionkov struct p9_client *clnt; /* 9p client */ 10660e78d2cSAbhishek Kulkarni struct list_head slist; /* list of sessions registered with v9fs */ 107a534c8d1SAneesh Kumar K.V struct rw_semaphore rename_sem; 1085e172f75SDinu-Razvan Chis-Serban long session_lock_timeout; /* retry interval for blocking locks */ 1099e82cf6aSEric Van Hensbergen }; 1109e82cf6aSEric Van Hensbergen 111b3cbea03SAneesh Kumar K.V /* cache_validity flags */ 112b3cbea03SAneesh Kumar K.V #define V9FS_INO_INVALID_ATTR 0x01 113b3cbea03SAneesh Kumar K.V 114a78ce05dSAneesh Kumar K.V struct v9fs_inode { 115874c8ca1SDavid Howells struct netfs_inode netfs; /* Netfslib context and vfs inode */ 116fd2421f5SAneesh Kumar K.V struct p9_qid qid; 117b3cbea03SAneesh Kumar K.V unsigned int cache_validity; 1186b39f6d2SAneesh Kumar K.V struct p9_fid *writeback_fid; 1195a7e0a8cSAneesh Kumar K.V struct mutex v_mutex; 120a78ce05dSAneesh Kumar K.V }; 121a78ce05dSAneesh Kumar K.V 122a78ce05dSAneesh Kumar K.V static inline struct v9fs_inode *V9FS_I(const struct inode *inode) 123a78ce05dSAneesh Kumar K.V { 124874c8ca1SDavid Howells return container_of(inode, struct v9fs_inode, netfs.inode); 125a78ce05dSAneesh Kumar K.V } 126a78ce05dSAneesh Kumar K.V 127eb497943SDavid Howells static inline struct fscache_cookie *v9fs_inode_cookie(struct v9fs_inode *v9inode) 128eb497943SDavid Howells { 129eb497943SDavid Howells #ifdef CONFIG_9P_FSCACHE 130e81fb419SLinus Torvalds return netfs_i_cookie(&v9inode->netfs); 131eb497943SDavid Howells #else 132eb497943SDavid Howells return NULL; 133eb497943SDavid Howells #endif 134eb497943SDavid Howells } 135eb497943SDavid Howells 13624e42e32SDavid Howells static inline struct fscache_volume *v9fs_session_cache(struct v9fs_session_info *v9ses) 13724e42e32SDavid Howells { 13824e42e32SDavid Howells #ifdef CONFIG_9P_FSCACHE 13924e42e32SDavid Howells return v9ses->fscache; 14024e42e32SDavid Howells #else 14124e42e32SDavid Howells return NULL; 14224e42e32SDavid Howells #endif 14324e42e32SDavid Howells } 14424e42e32SDavid Howells 14524e42e32SDavid Howells 146c4fac910SDavid Howells extern int v9fs_show_options(struct seq_file *m, struct dentry *root); 147c4fac910SDavid Howells 148772712c5SSohaib Mohamed struct p9_fid *v9fs_session_init(struct v9fs_session_info *v9ses, 149772712c5SSohaib Mohamed const char *dev_name, char *data); 15053c06f4eSAneesh Kumar K.V extern void v9fs_session_close(struct v9fs_session_info *v9ses); 15153c06f4eSAneesh Kumar K.V extern void v9fs_session_cancel(struct v9fs_session_info *v9ses); 15253c06f4eSAneesh Kumar K.V extern void v9fs_session_begin_cancel(struct v9fs_session_info *v9ses); 15353c06f4eSAneesh Kumar K.V extern struct dentry *v9fs_vfs_lookup(struct inode *dir, struct dentry *dentry, 15400cd8dd3SAl Viro unsigned int flags); 15553c06f4eSAneesh Kumar K.V extern int v9fs_vfs_unlink(struct inode *i, struct dentry *d); 15653c06f4eSAneesh Kumar K.V extern int v9fs_vfs_rmdir(struct inode *i, struct dentry *d); 157e18275aeSChristian Brauner extern int v9fs_vfs_rename(struct mnt_idmap *idmap, 158549c7297SChristian Brauner struct inode *old_dir, struct dentry *old_dentry, 1591cd66c93SMiklos Szeredi struct inode *new_dir, struct dentry *new_dentry, 1601cd66c93SMiklos Szeredi unsigned int flags); 161a78ce05dSAneesh Kumar K.V extern struct inode *v9fs_inode_from_fid(struct v9fs_session_info *v9ses, 16253c06f4eSAneesh Kumar K.V struct p9_fid *fid, 163ed80fcfaSAneesh Kumar K.V struct super_block *sb, int new); 16453c06f4eSAneesh Kumar K.V extern const struct inode_operations v9fs_dir_inode_operations_dotl; 16553c06f4eSAneesh Kumar K.V extern const struct inode_operations v9fs_file_inode_operations_dotl; 16653c06f4eSAneesh Kumar K.V extern const struct inode_operations v9fs_symlink_inode_operations_dotl; 167bc899ee1SDavid Howells extern const struct netfs_request_ops v9fs_req_ops; 168a78ce05dSAneesh Kumar K.V extern struct inode *v9fs_inode_from_fid_dotl(struct v9fs_session_info *v9ses, 16953c06f4eSAneesh Kumar K.V struct p9_fid *fid, 170ed80fcfaSAneesh Kumar K.V struct super_block *sb, int new); 1719e82cf6aSEric Van Hensbergen 1729e82cf6aSEric Van Hensbergen /* other default globals */ 1739e82cf6aSEric Van Hensbergen #define V9FS_PORT 564 1749e82cf6aSEric Van Hensbergen #define V9FS_DEFUSER "nobody" 1759e82cf6aSEric Van Hensbergen #define V9FS_DEFANAME "" 17676ed23a5SEric W. Biederman #define V9FS_DEFUID KUIDT_INIT(-2) 17776ed23a5SEric W. Biederman #define V9FS_DEFGID KGIDT_INIT(-2) 1789e82cf6aSEric Van Hensbergen 179bd238fb4SLatchesar Ionkov static inline struct v9fs_session_info *v9fs_inode2v9ses(struct inode *inode) 180bd238fb4SLatchesar Ionkov { 181772712c5SSohaib Mohamed return inode->i_sb->s_fs_info; 182bd238fb4SLatchesar Ionkov } 1832405669bSLatchesar Ionkov 18442869c8aSAneesh Kumar K.V static inline struct v9fs_session_info *v9fs_dentry2v9ses(struct dentry *dentry) 18542869c8aSAneesh Kumar K.V { 18642869c8aSAneesh Kumar K.V return dentry->d_sb->s_fs_info; 18742869c8aSAneesh Kumar K.V } 18842869c8aSAneesh Kumar K.V 189dd6102fbSSripathi Kodi static inline int v9fs_proto_dotu(struct v9fs_session_info *v9ses) 1902405669bSLatchesar Ionkov { 191dd6102fbSSripathi Kodi return v9ses->flags & V9FS_PROTO_2000U; 192dd6102fbSSripathi Kodi } 193dd6102fbSSripathi Kodi 194dd6102fbSSripathi Kodi static inline int v9fs_proto_dotl(struct v9fs_session_info *v9ses) 195dd6102fbSSripathi Kodi { 19645bc21edSSripathi Kodi return v9ses->flags & V9FS_PROTO_2000L; 1972405669bSLatchesar Ionkov } 19853c06f4eSAneesh Kumar K.V 19953c06f4eSAneesh Kumar K.V /** 200a78ce05dSAneesh Kumar K.V * v9fs_get_inode_from_fid - Helper routine to populate an inode by 20153c06f4eSAneesh Kumar K.V * issuing a attribute request 20253c06f4eSAneesh Kumar K.V * @v9ses: session information 20353c06f4eSAneesh Kumar K.V * @fid: fid to issue attribute request for 20453c06f4eSAneesh Kumar K.V * @sb: superblock on which to create inode 20553c06f4eSAneesh Kumar K.V * 20653c06f4eSAneesh Kumar K.V */ 20753c06f4eSAneesh Kumar K.V static inline struct inode * 208a78ce05dSAneesh Kumar K.V v9fs_get_inode_from_fid(struct v9fs_session_info *v9ses, struct p9_fid *fid, 20953c06f4eSAneesh Kumar K.V struct super_block *sb) 21053c06f4eSAneesh Kumar K.V { 21153c06f4eSAneesh Kumar K.V if (v9fs_proto_dotl(v9ses)) 212ed80fcfaSAneesh Kumar K.V return v9fs_inode_from_fid_dotl(v9ses, fid, sb, 0); 21353c06f4eSAneesh Kumar K.V else 214ed80fcfaSAneesh Kumar K.V return v9fs_inode_from_fid(v9ses, fid, sb, 0); 21553c06f4eSAneesh Kumar K.V } 216ed80fcfaSAneesh Kumar K.V 217ed80fcfaSAneesh Kumar K.V /** 218ed80fcfaSAneesh Kumar K.V * v9fs_get_new_inode_from_fid - Helper routine to populate an inode by 219ed80fcfaSAneesh Kumar K.V * issuing a attribute request 220ed80fcfaSAneesh Kumar K.V * @v9ses: session information 221ed80fcfaSAneesh Kumar K.V * @fid: fid to issue attribute request for 222ed80fcfaSAneesh Kumar K.V * @sb: superblock on which to create inode 223ed80fcfaSAneesh Kumar K.V * 224ed80fcfaSAneesh Kumar K.V */ 225ed80fcfaSAneesh Kumar K.V static inline struct inode * 226ed80fcfaSAneesh Kumar K.V v9fs_get_new_inode_from_fid(struct v9fs_session_info *v9ses, struct p9_fid *fid, 227ed80fcfaSAneesh Kumar K.V struct super_block *sb) 228ed80fcfaSAneesh Kumar K.V { 229ed80fcfaSAneesh Kumar K.V if (v9fs_proto_dotl(v9ses)) 230ed80fcfaSAneesh Kumar K.V return v9fs_inode_from_fid_dotl(v9ses, fid, sb, 1); 231ed80fcfaSAneesh Kumar K.V else 232ed80fcfaSAneesh Kumar K.V return v9fs_inode_from_fid(v9ses, fid, sb, 1); 233ed80fcfaSAneesh Kumar K.V } 234ed80fcfaSAneesh Kumar K.V 235e0459f57SAneesh Kumar K.V #endif 236