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, 39e782ef71SVenkateswararao Jujjuri (JV) V9FS_POSIX_ACL = 0x20 40ee443996SEric Van Hensbergen }; 41ee443996SEric Van Hensbergen 42ee443996SEric Van Hensbergen /* possible values of ->cache */ 43ee443996SEric Van Hensbergen /** 44ee443996SEric Van Hensbergen * enum p9_cache_modes - user specified cache preferences 45ee443996SEric Van Hensbergen * @CACHE_NONE: do not cache data, dentries, or directory contents (default) 46ee443996SEric Van Hensbergen * @CACHE_LOOSE: cache data, dentries, and directory contents w/no consistency 47ee443996SEric Van Hensbergen * 48ee443996SEric Van Hensbergen * eventually support loose, tight, time, session, default always none 49ee443996SEric Van Hensbergen */ 50ee443996SEric Van Hensbergen 51ee443996SEric Van Hensbergen enum p9_cache_modes { 52ee443996SEric Van Hensbergen CACHE_NONE, 53fb89b45cSDominique Martinet CACHE_MMAP, 54ee443996SEric Van Hensbergen CACHE_LOOSE, 5560e78d2cSAbhishek Kulkarni CACHE_FSCACHE, 56c4fac910SDavid Howells nr__p9_cache_modes 57ee443996SEric Van Hensbergen }; 58ee443996SEric Van Hensbergen 59ee443996SEric Van Hensbergen /** 60ee443996SEric Van Hensbergen * struct v9fs_session_info - per-instance session information 61ee443996SEric Van Hensbergen * @flags: session options of type &p9_session_flags 62ee443996SEric Van Hensbergen * @nodev: set to 1 to disable device mapping 63ee443996SEric Van Hensbergen * @debug: debug level 64ee443996SEric Van Hensbergen * @afid: authentication handle 65ee443996SEric Van Hensbergen * @cache: cache mode of type &p9_cache_modes 6660e78d2cSAbhishek Kulkarni * @cachetag: the tag of the cache associated with this session 6760e78d2cSAbhishek Kulkarni * @fscache: session cookie associated with FS-Cache 68ee443996SEric Van Hensbergen * @uname: string user name to mount hierarchy as 69ee443996SEric Van Hensbergen * @aname: mount specifier for remote hierarchy 70ee443996SEric Van Hensbergen * @maxdata: maximum data to be sent/recvd per protocol message 71ee443996SEric Van Hensbergen * @dfltuid: default numeric userid to mount hierarchy as 72ee443996SEric Van Hensbergen * @dfltgid: default numeric groupid to mount hierarchy as 73ee443996SEric Van Hensbergen * @uid: if %V9FS_ACCESS_SINGLE, the numeric uid which mounted the hierarchy 74ee443996SEric Van Hensbergen * @clnt: reference to 9P network client instantiated for this session 7560e78d2cSAbhishek Kulkarni * @slist: reference to list of registered 9p sessions 76ee443996SEric Van Hensbergen * 77ee443996SEric Van Hensbergen * This structure holds state for each session instance established during 78ee443996SEric Van Hensbergen * a sys_mount() . 79ee443996SEric Van Hensbergen * 80ee443996SEric Van Hensbergen * Bugs: there seems to be a lot of state which could be condensed and/or 81ee443996SEric Van Hensbergen * removed. 829e82cf6aSEric Van Hensbergen */ 839e82cf6aSEric Van Hensbergen 849e82cf6aSEric Van Hensbergen struct v9fs_session_info { 859e82cf6aSEric Van Hensbergen /* options */ 86ee443996SEric Van Hensbergen unsigned char flags; 87ee443996SEric Van Hensbergen unsigned char nodev; 88ee443996SEric Van Hensbergen unsigned short debug; 89ee443996SEric Van Hensbergen unsigned int afid; 90ee443996SEric Van Hensbergen unsigned int cache; 9160e78d2cSAbhishek Kulkarni #ifdef CONFIG_9P_FSCACHE 9260e78d2cSAbhishek Kulkarni char *cachetag; 9324e42e32SDavid Howells struct fscache_volume *fscache; 9460e78d2cSAbhishek Kulkarni #endif 959e82cf6aSEric Van Hensbergen 96ba17674fSLatchesar Ionkov char *uname; /* user name to mount as */ 97ba17674fSLatchesar Ionkov char *aname; /* name of remote hierarchy being mounted */ 988a0dc95fSEric Van Hensbergen unsigned int maxdata; /* max data for client interface */ 9976ed23a5SEric W. Biederman kuid_t dfltuid; /* default uid/muid for legacy support */ 10076ed23a5SEric W. Biederman kgid_t dfltgid; /* default gid for legacy support */ 10176ed23a5SEric W. Biederman kuid_t uid; /* if ACCESS_SINGLE, the uid that has access */ 102bd238fb4SLatchesar Ionkov struct p9_client *clnt; /* 9p client */ 10360e78d2cSAbhishek Kulkarni struct list_head slist; /* list of sessions registered with v9fs */ 104a534c8d1SAneesh Kumar K.V struct rw_semaphore rename_sem; 1055e172f75SDinu-Razvan Chis-Serban long session_lock_timeout; /* retry interval for blocking locks */ 1069e82cf6aSEric Van Hensbergen }; 1079e82cf6aSEric Van Hensbergen 108b3cbea03SAneesh Kumar K.V /* cache_validity flags */ 109b3cbea03SAneesh Kumar K.V #define V9FS_INO_INVALID_ATTR 0x01 110b3cbea03SAneesh Kumar K.V 111a78ce05dSAneesh Kumar K.V struct v9fs_inode { 112*874c8ca1SDavid Howells struct netfs_inode netfs; /* Netfslib context and vfs inode */ 113fd2421f5SAneesh Kumar K.V struct p9_qid qid; 114b3cbea03SAneesh Kumar K.V unsigned int cache_validity; 1156b39f6d2SAneesh Kumar K.V struct p9_fid *writeback_fid; 1165a7e0a8cSAneesh Kumar K.V struct mutex v_mutex; 117a78ce05dSAneesh Kumar K.V }; 118a78ce05dSAneesh Kumar K.V 119a78ce05dSAneesh Kumar K.V static inline struct v9fs_inode *V9FS_I(const struct inode *inode) 120a78ce05dSAneesh Kumar K.V { 121*874c8ca1SDavid Howells return container_of(inode, struct v9fs_inode, netfs.inode); 122a78ce05dSAneesh Kumar K.V } 123a78ce05dSAneesh Kumar K.V 124eb497943SDavid Howells static inline struct fscache_cookie *v9fs_inode_cookie(struct v9fs_inode *v9inode) 125eb497943SDavid Howells { 126eb497943SDavid Howells #ifdef CONFIG_9P_FSCACHE 127*874c8ca1SDavid Howells return netfs_i_cookie(&v9inode->netfs.inode); 128eb497943SDavid Howells #else 129eb497943SDavid Howells return NULL; 130eb497943SDavid Howells #endif 131eb497943SDavid Howells } 132eb497943SDavid Howells 13324e42e32SDavid Howells static inline struct fscache_volume *v9fs_session_cache(struct v9fs_session_info *v9ses) 13424e42e32SDavid Howells { 13524e42e32SDavid Howells #ifdef CONFIG_9P_FSCACHE 13624e42e32SDavid Howells return v9ses->fscache; 13724e42e32SDavid Howells #else 13824e42e32SDavid Howells return NULL; 13924e42e32SDavid Howells #endif 14024e42e32SDavid Howells } 14124e42e32SDavid Howells 14224e42e32SDavid Howells 143c4fac910SDavid Howells extern int v9fs_show_options(struct seq_file *m, struct dentry *root); 144c4fac910SDavid Howells 145772712c5SSohaib Mohamed struct p9_fid *v9fs_session_init(struct v9fs_session_info *v9ses, 146772712c5SSohaib Mohamed const char *dev_name, char *data); 14753c06f4eSAneesh Kumar K.V extern void v9fs_session_close(struct v9fs_session_info *v9ses); 14853c06f4eSAneesh Kumar K.V extern void v9fs_session_cancel(struct v9fs_session_info *v9ses); 14953c06f4eSAneesh Kumar K.V extern void v9fs_session_begin_cancel(struct v9fs_session_info *v9ses); 15053c06f4eSAneesh Kumar K.V extern struct dentry *v9fs_vfs_lookup(struct inode *dir, struct dentry *dentry, 15100cd8dd3SAl Viro unsigned int flags); 15253c06f4eSAneesh Kumar K.V extern int v9fs_vfs_unlink(struct inode *i, struct dentry *d); 15353c06f4eSAneesh Kumar K.V extern int v9fs_vfs_rmdir(struct inode *i, struct dentry *d); 154549c7297SChristian Brauner extern int v9fs_vfs_rename(struct user_namespace *mnt_userns, 155549c7297SChristian Brauner struct inode *old_dir, struct dentry *old_dentry, 1561cd66c93SMiklos Szeredi struct inode *new_dir, struct dentry *new_dentry, 1571cd66c93SMiklos Szeredi unsigned int flags); 158a78ce05dSAneesh Kumar K.V extern struct inode *v9fs_inode_from_fid(struct v9fs_session_info *v9ses, 15953c06f4eSAneesh Kumar K.V struct p9_fid *fid, 160ed80fcfaSAneesh Kumar K.V struct super_block *sb, int new); 16153c06f4eSAneesh Kumar K.V extern const struct inode_operations v9fs_dir_inode_operations_dotl; 16253c06f4eSAneesh Kumar K.V extern const struct inode_operations v9fs_file_inode_operations_dotl; 16353c06f4eSAneesh Kumar K.V extern const struct inode_operations v9fs_symlink_inode_operations_dotl; 164bc899ee1SDavid Howells extern const struct netfs_request_ops v9fs_req_ops; 165a78ce05dSAneesh Kumar K.V extern struct inode *v9fs_inode_from_fid_dotl(struct v9fs_session_info *v9ses, 16653c06f4eSAneesh Kumar K.V struct p9_fid *fid, 167ed80fcfaSAneesh Kumar K.V struct super_block *sb, int new); 1689e82cf6aSEric Van Hensbergen 1699e82cf6aSEric Van Hensbergen /* other default globals */ 1709e82cf6aSEric Van Hensbergen #define V9FS_PORT 564 1719e82cf6aSEric Van Hensbergen #define V9FS_DEFUSER "nobody" 1729e82cf6aSEric Van Hensbergen #define V9FS_DEFANAME "" 17376ed23a5SEric W. Biederman #define V9FS_DEFUID KUIDT_INIT(-2) 17476ed23a5SEric W. Biederman #define V9FS_DEFGID KGIDT_INIT(-2) 1759e82cf6aSEric Van Hensbergen 176bd238fb4SLatchesar Ionkov static inline struct v9fs_session_info *v9fs_inode2v9ses(struct inode *inode) 177bd238fb4SLatchesar Ionkov { 178772712c5SSohaib Mohamed return inode->i_sb->s_fs_info; 179bd238fb4SLatchesar Ionkov } 1802405669bSLatchesar Ionkov 18142869c8aSAneesh Kumar K.V static inline struct v9fs_session_info *v9fs_dentry2v9ses(struct dentry *dentry) 18242869c8aSAneesh Kumar K.V { 18342869c8aSAneesh Kumar K.V return dentry->d_sb->s_fs_info; 18442869c8aSAneesh Kumar K.V } 18542869c8aSAneesh Kumar K.V 186dd6102fbSSripathi Kodi static inline int v9fs_proto_dotu(struct v9fs_session_info *v9ses) 1872405669bSLatchesar Ionkov { 188dd6102fbSSripathi Kodi return v9ses->flags & V9FS_PROTO_2000U; 189dd6102fbSSripathi Kodi } 190dd6102fbSSripathi Kodi 191dd6102fbSSripathi Kodi static inline int v9fs_proto_dotl(struct v9fs_session_info *v9ses) 192dd6102fbSSripathi Kodi { 19345bc21edSSripathi Kodi return v9ses->flags & V9FS_PROTO_2000L; 1942405669bSLatchesar Ionkov } 19553c06f4eSAneesh Kumar K.V 19653c06f4eSAneesh Kumar K.V /** 197a78ce05dSAneesh Kumar K.V * v9fs_get_inode_from_fid - Helper routine to populate an inode by 19853c06f4eSAneesh Kumar K.V * issuing a attribute request 19953c06f4eSAneesh Kumar K.V * @v9ses: session information 20053c06f4eSAneesh Kumar K.V * @fid: fid to issue attribute request for 20153c06f4eSAneesh Kumar K.V * @sb: superblock on which to create inode 20253c06f4eSAneesh Kumar K.V * 20353c06f4eSAneesh Kumar K.V */ 20453c06f4eSAneesh Kumar K.V static inline struct inode * 205a78ce05dSAneesh Kumar K.V v9fs_get_inode_from_fid(struct v9fs_session_info *v9ses, struct p9_fid *fid, 20653c06f4eSAneesh Kumar K.V struct super_block *sb) 20753c06f4eSAneesh Kumar K.V { 20853c06f4eSAneesh Kumar K.V if (v9fs_proto_dotl(v9ses)) 209ed80fcfaSAneesh Kumar K.V return v9fs_inode_from_fid_dotl(v9ses, fid, sb, 0); 21053c06f4eSAneesh Kumar K.V else 211ed80fcfaSAneesh Kumar K.V return v9fs_inode_from_fid(v9ses, fid, sb, 0); 21253c06f4eSAneesh Kumar K.V } 213ed80fcfaSAneesh Kumar K.V 214ed80fcfaSAneesh Kumar K.V /** 215ed80fcfaSAneesh Kumar K.V * v9fs_get_new_inode_from_fid - Helper routine to populate an inode by 216ed80fcfaSAneesh Kumar K.V * issuing a attribute request 217ed80fcfaSAneesh Kumar K.V * @v9ses: session information 218ed80fcfaSAneesh Kumar K.V * @fid: fid to issue attribute request for 219ed80fcfaSAneesh Kumar K.V * @sb: superblock on which to create inode 220ed80fcfaSAneesh Kumar K.V * 221ed80fcfaSAneesh Kumar K.V */ 222ed80fcfaSAneesh Kumar K.V static inline struct inode * 223ed80fcfaSAneesh Kumar K.V v9fs_get_new_inode_from_fid(struct v9fs_session_info *v9ses, struct p9_fid *fid, 224ed80fcfaSAneesh Kumar K.V struct super_block *sb) 225ed80fcfaSAneesh Kumar K.V { 226ed80fcfaSAneesh Kumar K.V if (v9fs_proto_dotl(v9ses)) 227ed80fcfaSAneesh Kumar K.V return v9fs_inode_from_fid_dotl(v9ses, fid, sb, 1); 228ed80fcfaSAneesh Kumar K.V else 229ed80fcfaSAneesh Kumar K.V return v9fs_inode_from_fid(v9ses, fid, sb, 1); 230ed80fcfaSAneesh Kumar K.V } 231ed80fcfaSAneesh Kumar K.V 232e0459f57SAneesh Kumar K.V #endif 233