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> 129e82cf6aSEric Van Hensbergen 13ee443996SEric Van Hensbergen /** 14ee443996SEric Van Hensbergen * enum p9_session_flags - option flags for each 9P session 15dd6102fbSSripathi Kodi * @V9FS_PROTO_2000U: whether or not to use 9P2000.u extensions 1645bc21edSSripathi Kodi * @V9FS_PROTO_2000L: whether or not to use 9P2000.l extensions 17ee443996SEric Van Hensbergen * @V9FS_ACCESS_SINGLE: only the mounting user can access the hierarchy 18ee443996SEric Van Hensbergen * @V9FS_ACCESS_USER: a new attach will be issued for every user (default) 19e782ef71SVenkateswararao Jujjuri (JV) * @V9FS_ACCESS_CLIENT: Just like user, but access check is performed on client. 20ee443996SEric Van Hensbergen * @V9FS_ACCESS_ANY: use a single attach for all users 21ee443996SEric Van Hensbergen * @V9FS_ACCESS_MASK: bit mask of different ACCESS options 22e782ef71SVenkateswararao Jujjuri (JV) * @V9FS_POSIX_ACL: POSIX ACLs are enforced 239e82cf6aSEric Van Hensbergen * 24ee443996SEric Van Hensbergen * Session flags reflect options selected by users at mount time 25ee443996SEric Van Hensbergen */ 2676381a42SAneesh Kumar K.V #define V9FS_ACCESS_ANY (V9FS_ACCESS_SINGLE | \ 2776381a42SAneesh Kumar K.V V9FS_ACCESS_USER | \ 2876381a42SAneesh Kumar K.V V9FS_ACCESS_CLIENT) 2976381a42SAneesh Kumar K.V #define V9FS_ACCESS_MASK V9FS_ACCESS_ANY 30e782ef71SVenkateswararao Jujjuri (JV) #define V9FS_ACL_MASK V9FS_POSIX_ACL 3176381a42SAneesh Kumar K.V 32ee443996SEric Van Hensbergen enum p9_session_flags { 33dd6102fbSSripathi Kodi V9FS_PROTO_2000U = 0x01, 3445bc21edSSripathi Kodi V9FS_PROTO_2000L = 0x02, 35dd6102fbSSripathi Kodi V9FS_ACCESS_SINGLE = 0x04, 36dd6102fbSSripathi Kodi V9FS_ACCESS_USER = 0x08, 37e782ef71SVenkateswararao Jujjuri (JV) V9FS_ACCESS_CLIENT = 0x10, 38e782ef71SVenkateswararao Jujjuri (JV) V9FS_POSIX_ACL = 0x20 39ee443996SEric Van Hensbergen }; 40ee443996SEric Van Hensbergen 41ee443996SEric Van Hensbergen /* possible values of ->cache */ 42ee443996SEric Van Hensbergen /** 43ee443996SEric Van Hensbergen * enum p9_cache_modes - user specified cache preferences 44ee443996SEric Van Hensbergen * @CACHE_NONE: do not cache data, dentries, or directory contents (default) 45ee443996SEric Van Hensbergen * @CACHE_LOOSE: cache data, dentries, and directory contents w/no consistency 46ee443996SEric Van Hensbergen * 47ee443996SEric Van Hensbergen * eventually support loose, tight, time, session, default always none 48ee443996SEric Van Hensbergen */ 49ee443996SEric Van Hensbergen 50ee443996SEric Van Hensbergen enum p9_cache_modes { 51ee443996SEric Van Hensbergen CACHE_NONE, 52fb89b45cSDominique Martinet CACHE_MMAP, 53ee443996SEric Van Hensbergen CACHE_LOOSE, 5460e78d2cSAbhishek Kulkarni CACHE_FSCACHE, 55c4fac910SDavid Howells nr__p9_cache_modes 56ee443996SEric Van Hensbergen }; 57ee443996SEric Van Hensbergen 58ee443996SEric Van Hensbergen /** 59ee443996SEric Van Hensbergen * struct v9fs_session_info - per-instance session information 60ee443996SEric Van Hensbergen * @flags: session options of type &p9_session_flags 61ee443996SEric Van Hensbergen * @nodev: set to 1 to disable device mapping 62ee443996SEric Van Hensbergen * @debug: debug level 63ee443996SEric Van Hensbergen * @afid: authentication handle 64ee443996SEric Van Hensbergen * @cache: cache mode of type &p9_cache_modes 6560e78d2cSAbhishek Kulkarni * @cachetag: the tag of the cache associated with this session 6660e78d2cSAbhishek Kulkarni * @fscache: session cookie associated with FS-Cache 67ee443996SEric Van Hensbergen * @uname: string user name to mount hierarchy as 68ee443996SEric Van Hensbergen * @aname: mount specifier for remote hierarchy 69ee443996SEric Van Hensbergen * @maxdata: maximum data to be sent/recvd per protocol message 70ee443996SEric Van Hensbergen * @dfltuid: default numeric userid to mount hierarchy as 71ee443996SEric Van Hensbergen * @dfltgid: default numeric groupid to mount hierarchy as 72ee443996SEric Van Hensbergen * @uid: if %V9FS_ACCESS_SINGLE, the numeric uid which mounted the hierarchy 73ee443996SEric Van Hensbergen * @clnt: reference to 9P network client instantiated for this session 7460e78d2cSAbhishek Kulkarni * @slist: reference to list of registered 9p sessions 75ee443996SEric Van Hensbergen * 76ee443996SEric Van Hensbergen * This structure holds state for each session instance established during 77ee443996SEric Van Hensbergen * a sys_mount() . 78ee443996SEric Van Hensbergen * 79ee443996SEric Van Hensbergen * Bugs: there seems to be a lot of state which could be condensed and/or 80ee443996SEric Van Hensbergen * removed. 819e82cf6aSEric Van Hensbergen */ 829e82cf6aSEric Van Hensbergen 839e82cf6aSEric Van Hensbergen struct v9fs_session_info { 849e82cf6aSEric Van Hensbergen /* options */ 85ee443996SEric Van Hensbergen unsigned char flags; 86ee443996SEric Van Hensbergen unsigned char nodev; 87ee443996SEric Van Hensbergen unsigned short debug; 88ee443996SEric Van Hensbergen unsigned int afid; 89ee443996SEric Van Hensbergen unsigned int cache; 9060e78d2cSAbhishek Kulkarni #ifdef CONFIG_9P_FSCACHE 9160e78d2cSAbhishek Kulkarni char *cachetag; 9260e78d2cSAbhishek Kulkarni struct fscache_cookie *fscache; 9360e78d2cSAbhishek Kulkarni #endif 949e82cf6aSEric Van Hensbergen 95ba17674fSLatchesar Ionkov char *uname; /* user name to mount as */ 96ba17674fSLatchesar Ionkov char *aname; /* name of remote hierarchy being mounted */ 978a0dc95fSEric Van Hensbergen unsigned int maxdata; /* max data for client interface */ 9876ed23a5SEric W. Biederman kuid_t dfltuid; /* default uid/muid for legacy support */ 9976ed23a5SEric W. Biederman kgid_t dfltgid; /* default gid for legacy support */ 10076ed23a5SEric W. Biederman kuid_t uid; /* if ACCESS_SINGLE, the uid that has access */ 101bd238fb4SLatchesar Ionkov struct p9_client *clnt; /* 9p client */ 10260e78d2cSAbhishek Kulkarni struct list_head slist; /* list of sessions registered with v9fs */ 103a534c8d1SAneesh Kumar K.V struct rw_semaphore rename_sem; 1045e172f75SDinu-Razvan Chis-Serban long session_lock_timeout; /* retry interval for blocking locks */ 1059e82cf6aSEric Van Hensbergen }; 1069e82cf6aSEric Van Hensbergen 107b3cbea03SAneesh Kumar K.V /* cache_validity flags */ 108b3cbea03SAneesh Kumar K.V #define V9FS_INO_INVALID_ATTR 0x01 109b3cbea03SAneesh Kumar K.V 110a78ce05dSAneesh Kumar K.V struct v9fs_inode { 111a78ce05dSAneesh Kumar K.V #ifdef CONFIG_9P_FSCACHE 1128f5fed1eSSasha Levin struct mutex fscache_lock; 113a78ce05dSAneesh Kumar K.V struct fscache_cookie *fscache; 114a78ce05dSAneesh Kumar K.V #endif 115fd2421f5SAneesh Kumar K.V struct p9_qid qid; 116b3cbea03SAneesh Kumar K.V unsigned int cache_validity; 1176b39f6d2SAneesh Kumar K.V struct p9_fid *writeback_fid; 1185a7e0a8cSAneesh Kumar K.V struct mutex v_mutex; 119a78ce05dSAneesh Kumar K.V struct inode vfs_inode; 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 { 124a78ce05dSAneesh Kumar K.V return container_of(inode, struct v9fs_inode, vfs_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 130eb497943SDavid Howells return v9inode->fscache; 131eb497943SDavid Howells #else 132eb497943SDavid Howells return NULL; 133eb497943SDavid Howells #endif 134eb497943SDavid Howells } 135eb497943SDavid Howells 136c4fac910SDavid Howells extern int v9fs_show_options(struct seq_file *m, struct dentry *root); 137c4fac910SDavid Howells 138*772712c5SSohaib Mohamed struct p9_fid *v9fs_session_init(struct v9fs_session_info *v9ses, 139*772712c5SSohaib Mohamed const char *dev_name, char *data); 14053c06f4eSAneesh Kumar K.V extern void v9fs_session_close(struct v9fs_session_info *v9ses); 14153c06f4eSAneesh Kumar K.V extern void v9fs_session_cancel(struct v9fs_session_info *v9ses); 14253c06f4eSAneesh Kumar K.V extern void v9fs_session_begin_cancel(struct v9fs_session_info *v9ses); 14353c06f4eSAneesh Kumar K.V extern struct dentry *v9fs_vfs_lookup(struct inode *dir, struct dentry *dentry, 14400cd8dd3SAl Viro unsigned int flags); 14553c06f4eSAneesh Kumar K.V extern int v9fs_vfs_unlink(struct inode *i, struct dentry *d); 14653c06f4eSAneesh Kumar K.V extern int v9fs_vfs_rmdir(struct inode *i, struct dentry *d); 147549c7297SChristian Brauner extern int v9fs_vfs_rename(struct user_namespace *mnt_userns, 148549c7297SChristian Brauner struct inode *old_dir, struct dentry *old_dentry, 1491cd66c93SMiklos Szeredi struct inode *new_dir, struct dentry *new_dentry, 1501cd66c93SMiklos Szeredi unsigned int flags); 151a78ce05dSAneesh Kumar K.V extern struct inode *v9fs_inode_from_fid(struct v9fs_session_info *v9ses, 15253c06f4eSAneesh Kumar K.V struct p9_fid *fid, 153ed80fcfaSAneesh Kumar K.V struct super_block *sb, int new); 15453c06f4eSAneesh Kumar K.V extern const struct inode_operations v9fs_dir_inode_operations_dotl; 15553c06f4eSAneesh Kumar K.V extern const struct inode_operations v9fs_file_inode_operations_dotl; 15653c06f4eSAneesh Kumar K.V extern const struct inode_operations v9fs_symlink_inode_operations_dotl; 157a78ce05dSAneesh Kumar K.V extern struct inode *v9fs_inode_from_fid_dotl(struct v9fs_session_info *v9ses, 15853c06f4eSAneesh Kumar K.V struct p9_fid *fid, 159ed80fcfaSAneesh Kumar K.V struct super_block *sb, int new); 1609e82cf6aSEric Van Hensbergen 1619e82cf6aSEric Van Hensbergen /* other default globals */ 1629e82cf6aSEric Van Hensbergen #define V9FS_PORT 564 1639e82cf6aSEric Van Hensbergen #define V9FS_DEFUSER "nobody" 1649e82cf6aSEric Van Hensbergen #define V9FS_DEFANAME "" 16576ed23a5SEric W. Biederman #define V9FS_DEFUID KUIDT_INIT(-2) 16676ed23a5SEric W. Biederman #define V9FS_DEFGID KGIDT_INIT(-2) 1679e82cf6aSEric Van Hensbergen 168bd238fb4SLatchesar Ionkov static inline struct v9fs_session_info *v9fs_inode2v9ses(struct inode *inode) 169bd238fb4SLatchesar Ionkov { 170*772712c5SSohaib Mohamed return inode->i_sb->s_fs_info; 171bd238fb4SLatchesar Ionkov } 1722405669bSLatchesar Ionkov 17342869c8aSAneesh Kumar K.V static inline struct v9fs_session_info *v9fs_dentry2v9ses(struct dentry *dentry) 17442869c8aSAneesh Kumar K.V { 17542869c8aSAneesh Kumar K.V return dentry->d_sb->s_fs_info; 17642869c8aSAneesh Kumar K.V } 17742869c8aSAneesh Kumar K.V 178dd6102fbSSripathi Kodi static inline int v9fs_proto_dotu(struct v9fs_session_info *v9ses) 1792405669bSLatchesar Ionkov { 180dd6102fbSSripathi Kodi return v9ses->flags & V9FS_PROTO_2000U; 181dd6102fbSSripathi Kodi } 182dd6102fbSSripathi Kodi 183dd6102fbSSripathi Kodi static inline int v9fs_proto_dotl(struct v9fs_session_info *v9ses) 184dd6102fbSSripathi Kodi { 18545bc21edSSripathi Kodi return v9ses->flags & V9FS_PROTO_2000L; 1862405669bSLatchesar Ionkov } 18753c06f4eSAneesh Kumar K.V 18853c06f4eSAneesh Kumar K.V /** 189a78ce05dSAneesh Kumar K.V * v9fs_get_inode_from_fid - Helper routine to populate an inode by 19053c06f4eSAneesh Kumar K.V * issuing a attribute request 19153c06f4eSAneesh Kumar K.V * @v9ses: session information 19253c06f4eSAneesh Kumar K.V * @fid: fid to issue attribute request for 19353c06f4eSAneesh Kumar K.V * @sb: superblock on which to create inode 19453c06f4eSAneesh Kumar K.V * 19553c06f4eSAneesh Kumar K.V */ 19653c06f4eSAneesh Kumar K.V static inline struct inode * 197a78ce05dSAneesh Kumar K.V v9fs_get_inode_from_fid(struct v9fs_session_info *v9ses, struct p9_fid *fid, 19853c06f4eSAneesh Kumar K.V struct super_block *sb) 19953c06f4eSAneesh Kumar K.V { 20053c06f4eSAneesh Kumar K.V if (v9fs_proto_dotl(v9ses)) 201ed80fcfaSAneesh Kumar K.V return v9fs_inode_from_fid_dotl(v9ses, fid, sb, 0); 20253c06f4eSAneesh Kumar K.V else 203ed80fcfaSAneesh Kumar K.V return v9fs_inode_from_fid(v9ses, fid, sb, 0); 20453c06f4eSAneesh Kumar K.V } 205ed80fcfaSAneesh Kumar K.V 206ed80fcfaSAneesh Kumar K.V /** 207ed80fcfaSAneesh Kumar K.V * v9fs_get_new_inode_from_fid - Helper routine to populate an inode by 208ed80fcfaSAneesh Kumar K.V * issuing a attribute request 209ed80fcfaSAneesh Kumar K.V * @v9ses: session information 210ed80fcfaSAneesh Kumar K.V * @fid: fid to issue attribute request for 211ed80fcfaSAneesh Kumar K.V * @sb: superblock on which to create inode 212ed80fcfaSAneesh Kumar K.V * 213ed80fcfaSAneesh Kumar K.V */ 214ed80fcfaSAneesh Kumar K.V static inline struct inode * 215ed80fcfaSAneesh Kumar K.V v9fs_get_new_inode_from_fid(struct v9fs_session_info *v9ses, struct p9_fid *fid, 216ed80fcfaSAneesh Kumar K.V struct super_block *sb) 217ed80fcfaSAneesh Kumar K.V { 218ed80fcfaSAneesh Kumar K.V if (v9fs_proto_dotl(v9ses)) 219ed80fcfaSAneesh Kumar K.V return v9fs_inode_from_fid_dotl(v9ses, fid, sb, 1); 220ed80fcfaSAneesh Kumar K.V else 221ed80fcfaSAneesh Kumar K.V return v9fs_inode_from_fid(v9ses, fid, sb, 1); 222ed80fcfaSAneesh Kumar K.V } 223ed80fcfaSAneesh Kumar K.V 224e0459f57SAneesh Kumar K.V #endif 225