blob: 6fa3cf5547d50db79d813d3d5c73b7baee78eddf [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 */
Jens Axboe0ed07dd2010-04-22 11:42:00 +020023#include <linux/backing-dev.h>
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -070024
Eric Van Hensbergenee443992008-03-05 07:08:09 -060025/**
26 * enum p9_session_flags - option flags for each 9P session
Sripathi Kodidd6102f2010-03-05 18:48:00 +000027 * @V9FS_PROTO_2000U: whether or not to use 9P2000.u extensions
Sripathi Kodi45bc21e2010-03-08 17:33:04 +000028 * @V9FS_PROTO_2000L: whether or not to use 9P2000.l extensions
Eric Van Hensbergenee443992008-03-05 07:08:09 -060029 * @V9FS_ACCESS_SINGLE: only the mounting user can access the hierarchy
30 * @V9FS_ACCESS_USER: a new attach will be issued for every user (default)
Venkateswararao Jujjuri (JV)e782ef72011-01-25 15:40:54 -080031 * @V9FS_ACCESS_CLIENT: Just like user, but access check is performed on client.
Eric Van Hensbergenee443992008-03-05 07:08:09 -060032 * @V9FS_ACCESS_ANY: use a single attach for all users
33 * @V9FS_ACCESS_MASK: bit mask of different ACCESS options
Venkateswararao Jujjuri (JV)e782ef72011-01-25 15:40:54 -080034 * @V9FS_POSIX_ACL: POSIX ACLs are enforced
Eric Van Hensbergenee443992008-03-05 07:08:09 -060035 *
36 * Session flags reflect options selected by users at mount time
37 */
Aneesh Kumar K.V76381a42010-09-28 00:27:41 +053038#define V9FS_ACCESS_ANY (V9FS_ACCESS_SINGLE | \
39 V9FS_ACCESS_USER | \
40 V9FS_ACCESS_CLIENT)
41#define V9FS_ACCESS_MASK V9FS_ACCESS_ANY
Venkateswararao Jujjuri (JV)e782ef72011-01-25 15:40:54 -080042#define V9FS_ACL_MASK V9FS_POSIX_ACL
Aneesh Kumar K.V76381a42010-09-28 00:27:41 +053043
Eric Van Hensbergenee443992008-03-05 07:08:09 -060044enum p9_session_flags {
Sripathi Kodidd6102f2010-03-05 18:48:00 +000045 V9FS_PROTO_2000U = 0x01,
Sripathi Kodi45bc21e2010-03-08 17:33:04 +000046 V9FS_PROTO_2000L = 0x02,
Sripathi Kodidd6102f2010-03-05 18:48:00 +000047 V9FS_ACCESS_SINGLE = 0x04,
48 V9FS_ACCESS_USER = 0x08,
Venkateswararao Jujjuri (JV)e782ef72011-01-25 15:40:54 -080049 V9FS_ACCESS_CLIENT = 0x10,
50 V9FS_POSIX_ACL = 0x20
Eric Van Hensbergenee443992008-03-05 07:08:09 -060051};
52
53/* possible values of ->cache */
54/**
55 * enum p9_cache_modes - user specified cache preferences
56 * @CACHE_NONE: do not cache data, dentries, or directory contents (default)
57 * @CACHE_LOOSE: cache data, dentries, and directory contents w/no consistency
58 *
59 * eventually support loose, tight, time, session, default always none
60 */
61
62enum p9_cache_modes {
63 CACHE_NONE,
64 CACHE_LOOSE,
Abhishek Kulkarni60e78d22009-09-23 13:00:27 -050065 CACHE_FSCACHE,
Eric Van Hensbergenee443992008-03-05 07:08:09 -060066};
67
68/**
69 * struct v9fs_session_info - per-instance session information
70 * @flags: session options of type &p9_session_flags
71 * @nodev: set to 1 to disable device mapping
72 * @debug: debug level
73 * @afid: authentication handle
74 * @cache: cache mode of type &p9_cache_modes
Abhishek Kulkarni60e78d22009-09-23 13:00:27 -050075 * @cachetag: the tag of the cache associated with this session
76 * @fscache: session cookie associated with FS-Cache
Eric Van Hensbergenee443992008-03-05 07:08:09 -060077 * @options: copy of options string given by user
78 * @uname: string user name to mount hierarchy as
79 * @aname: mount specifier for remote hierarchy
80 * @maxdata: maximum data to be sent/recvd per protocol message
81 * @dfltuid: default numeric userid to mount hierarchy as
82 * @dfltgid: default numeric groupid to mount hierarchy as
83 * @uid: if %V9FS_ACCESS_SINGLE, the numeric uid which mounted the hierarchy
84 * @clnt: reference to 9P network client instantiated for this session
Abhishek Kulkarni60e78d22009-09-23 13:00:27 -050085 * @slist: reference to list of registered 9p sessions
Eric Van Hensbergenee443992008-03-05 07:08:09 -060086 *
87 * This structure holds state for each session instance established during
88 * a sys_mount() .
89 *
90 * Bugs: there seems to be a lot of state which could be condensed and/or
91 * removed.
92 */
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -070093
94struct v9fs_session_info {
95 /* options */
Eric Van Hensbergenee443992008-03-05 07:08:09 -060096 unsigned char flags;
97 unsigned char nodev;
98 unsigned short debug;
99 unsigned int afid;
100 unsigned int cache;
Abhishek Kulkarni60e78d22009-09-23 13:00:27 -0500101#ifdef CONFIG_9P_FSCACHE
102 char *cachetag;
103 struct fscache_cookie *fscache;
104#endif
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700105
Latchesar Ionkovba176742007-10-17 14:31:07 -0500106 char *uname; /* user name to mount as */
107 char *aname; /* name of remote hierarchy being mounted */
Eric Van Hensbergen8a0dc952008-02-06 19:25:03 -0600108 unsigned int maxdata; /* max data for client interface */
Latchesar Ionkovbd32b822007-10-17 14:31:07 -0500109 unsigned int dfltuid; /* default uid/muid for legacy support */
110 unsigned int dfltgid; /* default gid for legacy support */
Latchesar Ionkovba176742007-10-17 14:31:07 -0500111 u32 uid; /* if ACCESS_SINGLE, the uid that has access */
Latchesar Ionkovbd238fb2007-07-10 17:57:28 -0500112 struct p9_client *clnt; /* 9p client */
Abhishek Kulkarni60e78d22009-09-23 13:00:27 -0500113 struct list_head slist; /* list of sessions registered with v9fs */
Jens Axboe0ed07dd2010-04-22 11:42:00 +0200114 struct backing_dev_info bdi;
Aneesh Kumar K.Va534c8d2010-06-30 19:18:50 +0530115 struct rw_semaphore rename_sem;
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700116};
117
Latchesar Ionkovbd238fb2007-07-10 17:57:28 -0500118struct p9_fid *v9fs_session_init(struct v9fs_session_info *, const char *,
119 char *);
Aneesh Kumar K.V53c06f42011-01-10 13:51:47 -0600120extern void v9fs_session_close(struct v9fs_session_info *v9ses);
121extern void v9fs_session_cancel(struct v9fs_session_info *v9ses);
122extern void v9fs_session_begin_cancel(struct v9fs_session_info *v9ses);
123extern struct dentry *v9fs_vfs_lookup(struct inode *dir, struct dentry *dentry,
124 struct nameidata *nameidata);
125extern int v9fs_vfs_unlink(struct inode *i, struct dentry *d);
126extern int v9fs_vfs_rmdir(struct inode *i, struct dentry *d);
127extern int v9fs_vfs_rename(struct inode *old_dir, struct dentry *old_dentry,
128 struct inode *new_dir, struct dentry *new_dentry);
129extern void v9fs_vfs_put_link(struct dentry *dentry, struct nameidata *nd,
130 void *p);
131extern struct inode *v9fs_inode(struct v9fs_session_info *v9ses,
132 struct p9_fid *fid,
133 struct super_block *sb);
134
135extern const struct inode_operations v9fs_dir_inode_operations_dotl;
136extern const struct inode_operations v9fs_file_inode_operations_dotl;
137extern const struct inode_operations v9fs_symlink_inode_operations_dotl;
138extern struct inode *v9fs_inode_dotl(struct v9fs_session_info *v9ses,
139 struct p9_fid *fid,
140 struct super_block *sb);
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700141
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700142/* other default globals */
Latchesar Ionkovbd32b822007-10-17 14:31:07 -0500143#define V9FS_PORT 564
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700144#define V9FS_DEFUSER "nobody"
145#define V9FS_DEFANAME ""
Latchesar Ionkovbd32b822007-10-17 14:31:07 -0500146#define V9FS_DEFUID (-2)
147#define V9FS_DEFGID (-2)
Eric Van Hensbergen9e82cf62005-09-09 13:04:20 -0700148
Latchesar Ionkovbd238fb2007-07-10 17:57:28 -0500149static inline struct v9fs_session_info *v9fs_inode2v9ses(struct inode *inode)
150{
151 return (inode->i_sb->s_fs_info);
152}
Latchesar Ionkov24056692007-10-17 14:31:07 -0500153
Sripathi Kodidd6102f2010-03-05 18:48:00 +0000154static inline int v9fs_proto_dotu(struct v9fs_session_info *v9ses)
Latchesar Ionkov24056692007-10-17 14:31:07 -0500155{
Sripathi Kodidd6102f2010-03-05 18:48:00 +0000156 return v9ses->flags & V9FS_PROTO_2000U;
157}
158
159static inline int v9fs_proto_dotl(struct v9fs_session_info *v9ses)
160{
Sripathi Kodi45bc21e2010-03-08 17:33:04 +0000161 return v9ses->flags & V9FS_PROTO_2000L;
Latchesar Ionkov24056692007-10-17 14:31:07 -0500162}
Aneesh Kumar K.V53c06f42011-01-10 13:51:47 -0600163
164/**
165 * v9fs_inode_from_fid - Helper routine to populate an inode by
166 * issuing a attribute request
167 * @v9ses: session information
168 * @fid: fid to issue attribute request for
169 * @sb: superblock on which to create inode
170 *
171 */
172static inline struct inode *
173v9fs_inode_from_fid(struct v9fs_session_info *v9ses, struct p9_fid *fid,
174 struct super_block *sb)
175{
176 if (v9fs_proto_dotl(v9ses))
177 return v9fs_inode_dotl(v9ses, fid, sb);
178 else
179 return v9fs_inode(v9ses, fid, sb);
180}