blob: 443d12e020436f2e7af92333ae89d3f068dc614a [file] [log] [blame]
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -07001/*
2 * V9FS definitions.
3 *
Eric Van Hensbergen8a0dc952008-02-06 19:25:03 -06004 * Copyright (C) 2004-2008 by Eric Van Hensbergen <ericvh@gmail.com>
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -07005 * Copyright (C) 2002 by Ron Minnich <rminnich@lanl.gov>
6 *
7 * This program is free software; you can redistribute it and/or modify
Eric Van Hensbergen42e8c502006-03-25 03:07:28 -08008 * it under the terms of the GNU General Public License version 2
9 * as published by the Free Software Foundation.
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -070010 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to:
18 * Free Software Foundation
19 * 51 Franklin Street, Fifth Floor
20 * Boston, MA 02111-1301 USA
21 *
22 */
Aneesh Kumar K.Ve0459f52011-02-28 17:04:09 +053023#ifndef FS_9P_V9FS_H
24#define FS_9P_V9FS_H
25
Jens Axboe0ed07dd2010-04-22 11:42:00 +020026#include <linux/backing-dev.h>
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -070027
Eric Van Hensbergenee443992008-03-05 07:08:09 -060028/**
29 * enum p9_session_flags - option flags for each 9P session
Sripathi Kodidd6102f2010-03-05 18:48:00 +000030 * @V9FS_PROTO_2000U: whether or not to use 9P2000.u extensions
Sripathi Kodi45bc21e2010-03-08 17:33:04 +000031 * @V9FS_PROTO_2000L: whether or not to use 9P2000.l extensions
Eric Van Hensbergenee443992008-03-05 07:08:09 -060032 * @V9FS_ACCESS_SINGLE: only the mounting user can access the hierarchy
33 * @V9FS_ACCESS_USER: a new attach will be issued for every user (default)
Venkateswararao Jujjuri (JV)e782ef72011-01-25 15:40:54 -080034 * @V9FS_ACCESS_CLIENT: Just like user, but access check is performed on client.
Eric Van Hensbergenee443992008-03-05 07:08:09 -060035 * @V9FS_ACCESS_ANY: use a single attach for all users
36 * @V9FS_ACCESS_MASK: bit mask of different ACCESS options
Venkateswararao Jujjuri (JV)e782ef72011-01-25 15:40:54 -080037 * @V9FS_POSIX_ACL: POSIX ACLs are enforced
Eric Van Hensbergenee443992008-03-05 07:08:09 -060038 *
39 * Session flags reflect options selected by users at mount time
40 */
Aneesh Kumar K.V76381a42010-09-28 00:27:41 +053041#define V9FS_ACCESS_ANY (V9FS_ACCESS_SINGLE | \
42 V9FS_ACCESS_USER | \
43 V9FS_ACCESS_CLIENT)
44#define V9FS_ACCESS_MASK V9FS_ACCESS_ANY
Venkateswararao Jujjuri (JV)e782ef72011-01-25 15:40:54 -080045#define V9FS_ACL_MASK V9FS_POSIX_ACL
Aneesh Kumar K.V76381a42010-09-28 00:27:41 +053046
Eric Van Hensbergenee443992008-03-05 07:08:09 -060047enum p9_session_flags {
Sripathi Kodidd6102f2010-03-05 18:48:00 +000048 V9FS_PROTO_2000U = 0x01,
Sripathi Kodi45bc21e2010-03-08 17:33:04 +000049 V9FS_PROTO_2000L = 0x02,
Sripathi Kodidd6102f2010-03-05 18:48:00 +000050 V9FS_ACCESS_SINGLE = 0x04,
51 V9FS_ACCESS_USER = 0x08,
Venkateswararao Jujjuri (JV)e782ef72011-01-25 15:40:54 -080052 V9FS_ACCESS_CLIENT = 0x10,
53 V9FS_POSIX_ACL = 0x20
Eric Van Hensbergenee443992008-03-05 07:08:09 -060054};
55
56/* possible values of ->cache */
57/**
58 * enum p9_cache_modes - user specified cache preferences
59 * @CACHE_NONE: do not cache data, dentries, or directory contents (default)
60 * @CACHE_LOOSE: cache data, dentries, and directory contents w/no consistency
61 *
62 * eventually support loose, tight, time, session, default always none
63 */
64
65enum p9_cache_modes {
66 CACHE_NONE,
Dominique Martinetfb89b452014-01-10 13:44:09 +010067 CACHE_MMAP,
Eric Van Hensbergenee443992008-03-05 07:08:09 -060068 CACHE_LOOSE,
Abhishek Kulkarni60e78d22009-09-23 13:00:27 -050069 CACHE_FSCACHE,
Eric Van Hensbergenee443992008-03-05 07:08:09 -060070};
71
72/**
73 * struct v9fs_session_info - per-instance session information
74 * @flags: session options of type &p9_session_flags
75 * @nodev: set to 1 to disable device mapping
76 * @debug: debug level
77 * @afid: authentication handle
78 * @cache: cache mode of type &p9_cache_modes
Abhishek Kulkarni60e78d22009-09-23 13:00:27 -050079 * @cachetag: the tag of the cache associated with this session
80 * @fscache: session cookie associated with FS-Cache
Eric Van Hensbergenee443992008-03-05 07:08:09 -060081 * @uname: string user name to mount hierarchy as
82 * @aname: mount specifier for remote hierarchy
83 * @maxdata: maximum data to be sent/recvd per protocol message
84 * @dfltuid: default numeric userid to mount hierarchy as
85 * @dfltgid: default numeric groupid to mount hierarchy as
86 * @uid: if %V9FS_ACCESS_SINGLE, the numeric uid which mounted the hierarchy
87 * @clnt: reference to 9P network client instantiated for this session
Abhishek Kulkarni60e78d22009-09-23 13:00:27 -050088 * @slist: reference to list of registered 9p sessions
Eric Van Hensbergenee443992008-03-05 07:08:09 -060089 *
90 * This structure holds state for each session instance established during
91 * a sys_mount() .
92 *
93 * Bugs: there seems to be a lot of state which could be condensed and/or
94 * removed.
95 */
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -070096
97struct v9fs_session_info {
98 /* options */
Eric Van Hensbergenee443992008-03-05 07:08:09 -060099 unsigned char flags;
100 unsigned char nodev;
101 unsigned short debug;
102 unsigned int afid;
103 unsigned int cache;
Abhishek Kulkarni60e78d22009-09-23 13:00:27 -0500104#ifdef CONFIG_9P_FSCACHE
105 char *cachetag;
106 struct fscache_cookie *fscache;
107#endif
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700108
Latchesar Ionkovba176742007-10-17 14:31:07 -0500109 char *uname; /* user name to mount as */
110 char *aname; /* name of remote hierarchy being mounted */
Eric Van Hensbergen8a0dc952008-02-06 19:25:03 -0600111 unsigned int maxdata; /* max data for client interface */
Eric W. Biederman76ed23a2013-01-30 11:57:40 -0800112 kuid_t dfltuid; /* default uid/muid for legacy support */
113 kgid_t dfltgid; /* default gid for legacy support */
114 kuid_t uid; /* if ACCESS_SINGLE, the uid that has access */
Latchesar Ionkovbd238fb2007-07-10 17:57:28 -0500115 struct p9_client *clnt; /* 9p client */
Abhishek Kulkarni60e78d22009-09-23 13:00:27 -0500116 struct list_head slist; /* list of sessions registered with v9fs */
Jens Axboe0ed07dd2010-04-22 11:42:00 +0200117 struct backing_dev_info bdi;
Aneesh Kumar K.Va534c8d2010-06-30 19:18:50 +0530118 struct rw_semaphore rename_sem;
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700119};
120
Aneesh Kumar K.Vb3cbea02011-02-28 17:04:06 +0530121/* cache_validity flags */
122#define V9FS_INO_INVALID_ATTR 0x01
123
Aneesh Kumar K.Va78ce052011-02-28 17:04:02 +0530124struct v9fs_inode {
125#ifdef CONFIG_9P_FSCACHE
Sasha Levin8f5fed12016-01-07 17:49:51 -0500126 struct mutex fscache_lock;
Aneesh Kumar K.Va78ce052011-02-28 17:04:02 +0530127 struct fscache_cookie *fscache;
Aneesh Kumar K.Va78ce052011-02-28 17:04:02 +0530128#endif
Aneesh Kumar K.Vfd2421f2011-07-11 16:40:59 +0000129 struct p9_qid qid;
Aneesh Kumar K.Vb3cbea02011-02-28 17:04:06 +0530130 unsigned int cache_validity;
Aneesh Kumar K.V6b39f6d2011-02-28 17:04:03 +0530131 struct p9_fid *writeback_fid;
Aneesh Kumar K.V5a7e0a82011-03-08 16:39:46 +0530132 struct mutex v_mutex;
Aneesh Kumar K.Va78ce052011-02-28 17:04:02 +0530133 struct inode vfs_inode;
134};
135
136static inline struct v9fs_inode *V9FS_I(const struct inode *inode)
137{
138 return container_of(inode, struct v9fs_inode, vfs_inode);
139}
140
Latchesar Ionkovbd238fb2007-07-10 17:57:28 -0500141struct p9_fid *v9fs_session_init(struct v9fs_session_info *, const char *,
142 char *);
Aneesh Kumar K.V53c06f42011-01-10 13:51:47 -0600143extern void v9fs_session_close(struct v9fs_session_info *v9ses);
144extern void v9fs_session_cancel(struct v9fs_session_info *v9ses);
145extern void v9fs_session_begin_cancel(struct v9fs_session_info *v9ses);
146extern struct dentry *v9fs_vfs_lookup(struct inode *dir, struct dentry *dentry,
Al Viro00cd8dd2012-06-10 17:13:09 -0400147 unsigned int flags);
Aneesh Kumar K.V53c06f42011-01-10 13:51:47 -0600148extern int v9fs_vfs_unlink(struct inode *i, struct dentry *d);
149extern int v9fs_vfs_rmdir(struct inode *i, struct dentry *d);
150extern int v9fs_vfs_rename(struct inode *old_dir, struct dentry *old_dentry,
Miklos Szeredi1cd66c92016-09-27 11:03:58 +0200151 struct inode *new_dir, struct dentry *new_dentry,
152 unsigned int flags);
Aneesh Kumar K.Va78ce052011-02-28 17:04:02 +0530153extern struct inode *v9fs_inode_from_fid(struct v9fs_session_info *v9ses,
154 struct p9_fid *fid,
Aneesh Kumar K.Ved80fcf2011-07-06 16:32:31 +0530155 struct super_block *sb, int new);
Aneesh Kumar K.V53c06f42011-01-10 13:51:47 -0600156extern const struct inode_operations v9fs_dir_inode_operations_dotl;
157extern const struct inode_operations v9fs_file_inode_operations_dotl;
158extern const struct inode_operations v9fs_symlink_inode_operations_dotl;
Aneesh Kumar K.Va78ce052011-02-28 17:04:02 +0530159extern struct inode *v9fs_inode_from_fid_dotl(struct v9fs_session_info *v9ses,
160 struct p9_fid *fid,
Aneesh Kumar K.Ved80fcf2011-07-06 16:32:31 +0530161 struct super_block *sb, int new);
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700162
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700163/* other default globals */
Latchesar Ionkovbd32b822007-10-17 14:31:07 -0500164#define V9FS_PORT 564
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700165#define V9FS_DEFUSER "nobody"
166#define V9FS_DEFANAME ""
Eric W. Biederman76ed23a2013-01-30 11:57:40 -0800167#define V9FS_DEFUID KUIDT_INIT(-2)
168#define V9FS_DEFGID KGIDT_INIT(-2)
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700169
Latchesar Ionkovbd238fb2007-07-10 17:57:28 -0500170static inline struct v9fs_session_info *v9fs_inode2v9ses(struct inode *inode)
171{
172 return (inode->i_sb->s_fs_info);
173}
Latchesar Ionkov24056692007-10-17 14:31:07 -0500174
Aneesh Kumar K.V42869c82011-03-08 16:39:50 +0530175static inline struct v9fs_session_info *v9fs_dentry2v9ses(struct dentry *dentry)
176{
177 return dentry->d_sb->s_fs_info;
178}
179
Sripathi Kodidd6102f2010-03-05 18:48:00 +0000180static inline int v9fs_proto_dotu(struct v9fs_session_info *v9ses)
Latchesar Ionkov24056692007-10-17 14:31:07 -0500181{
Sripathi Kodidd6102f2010-03-05 18:48:00 +0000182 return v9ses->flags & V9FS_PROTO_2000U;
183}
184
185static inline int v9fs_proto_dotl(struct v9fs_session_info *v9ses)
186{
Sripathi Kodi45bc21e2010-03-08 17:33:04 +0000187 return v9ses->flags & V9FS_PROTO_2000L;
Latchesar Ionkov24056692007-10-17 14:31:07 -0500188}
Aneesh Kumar K.V53c06f42011-01-10 13:51:47 -0600189
190/**
Aneesh Kumar K.Va78ce052011-02-28 17:04:02 +0530191 * v9fs_get_inode_from_fid - Helper routine to populate an inode by
Aneesh Kumar K.V53c06f42011-01-10 13:51:47 -0600192 * issuing a attribute request
193 * @v9ses: session information
194 * @fid: fid to issue attribute request for
195 * @sb: superblock on which to create inode
196 *
197 */
198static inline struct inode *
Aneesh Kumar K.Va78ce052011-02-28 17:04:02 +0530199v9fs_get_inode_from_fid(struct v9fs_session_info *v9ses, struct p9_fid *fid,
200 struct super_block *sb)
Aneesh Kumar K.V53c06f42011-01-10 13:51:47 -0600201{
202 if (v9fs_proto_dotl(v9ses))
Aneesh Kumar K.Ved80fcf2011-07-06 16:32:31 +0530203 return v9fs_inode_from_fid_dotl(v9ses, fid, sb, 0);
Aneesh Kumar K.V53c06f42011-01-10 13:51:47 -0600204 else
Aneesh Kumar K.Ved80fcf2011-07-06 16:32:31 +0530205 return v9fs_inode_from_fid(v9ses, fid, sb, 0);
Aneesh Kumar K.V53c06f42011-01-10 13:51:47 -0600206}
Aneesh Kumar K.Ved80fcf2011-07-06 16:32:31 +0530207
208/**
209 * v9fs_get_new_inode_from_fid - Helper routine to populate an inode by
210 * issuing a attribute request
211 * @v9ses: session information
212 * @fid: fid to issue attribute request for
213 * @sb: superblock on which to create inode
214 *
215 */
216static inline struct inode *
217v9fs_get_new_inode_from_fid(struct v9fs_session_info *v9ses, struct p9_fid *fid,
218 struct super_block *sb)
219{
220 if (v9fs_proto_dotl(v9ses))
221 return v9fs_inode_from_fid_dotl(v9ses, fid, sb, 1);
222 else
223 return v9fs_inode_from_fid(v9ses, fid, sb, 1);
224}
225
Aneesh Kumar K.Ve0459f52011-02-28 17:04:09 +0530226#endif