9P2010.L handshake: Add VFS flags
[linux-2.6.git] / fs / 9p / v9fs.h
1 /*
2  * V9FS definitions.
3  *
4  *  Copyright (C) 2004-2008 by Eric Van Hensbergen <ericvh@gmail.com>
5  *  Copyright (C) 2002 by Ron Minnich <rminnich@lanl.gov>
6  *
7  *  This program is free software; you can redistribute it and/or modify
8  *  it under the terms of the GNU General Public License version 2
9  *  as published by the Free Software Foundation.
10  *
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  */
23
24 /**
25  * enum p9_session_flags - option flags for each 9P session
26  * @V9FS_PROTO_2000U: whether or not to use 9P2000.u extensions
27  * @V9FS_PROTO_2010L: whether or not to use 9P2010.l extensions
28  * @V9FS_ACCESS_SINGLE: only the mounting user can access the hierarchy
29  * @V9FS_ACCESS_USER: a new attach will be issued for every user (default)
30  * @V9FS_ACCESS_ANY: use a single attach for all users
31  * @V9FS_ACCESS_MASK: bit mask of different ACCESS options
32  *
33  * Session flags reflect options selected by users at mount time
34  */
35 enum p9_session_flags {
36         V9FS_PROTO_2000U        = 0x01,
37         V9FS_PROTO_2010L        = 0x02,
38         V9FS_ACCESS_SINGLE      = 0x04,
39         V9FS_ACCESS_USER        = 0x08,
40         V9FS_ACCESS_ANY         = 0x0C,
41         V9FS_ACCESS_MASK        = 0x0C,
42 };
43
44 /* possible values of ->cache */
45 /**
46  * enum p9_cache_modes - user specified cache preferences
47  * @CACHE_NONE: do not cache data, dentries, or directory contents (default)
48  * @CACHE_LOOSE: cache data, dentries, and directory contents w/no consistency
49  *
50  * eventually support loose, tight, time, session, default always none
51  */
52
53 enum p9_cache_modes {
54         CACHE_NONE,
55         CACHE_LOOSE,
56         CACHE_FSCACHE,
57 };
58
59 /**
60  * struct v9fs_session_info - per-instance session information
61  * @flags: session options of type &p9_session_flags
62  * @nodev: set to 1 to disable device mapping
63  * @debug: debug level
64  * @afid: authentication handle
65  * @cache: cache mode of type &p9_cache_modes
66  * @cachetag: the tag of the cache associated with this session
67  * @fscache: session cookie associated with FS-Cache
68  * @options: copy of options string given by user
69  * @uname: string user name to mount hierarchy as
70  * @aname: mount specifier for remote hierarchy
71  * @maxdata: maximum data to be sent/recvd per protocol message
72  * @dfltuid: default numeric userid to mount hierarchy as
73  * @dfltgid: default numeric groupid to mount hierarchy as
74  * @uid: if %V9FS_ACCESS_SINGLE, the numeric uid which mounted the hierarchy
75  * @clnt: reference to 9P network client instantiated for this session
76  * @slist: reference to list of registered 9p sessions
77  *
78  * This structure holds state for each session instance established during
79  * a sys_mount() .
80  *
81  * Bugs: there seems to be a lot of state which could be condensed and/or
82  * removed.
83  */
84
85 struct v9fs_session_info {
86         /* options */
87         unsigned char flags;
88         unsigned char nodev;
89         unsigned short debug;
90         unsigned int afid;
91         unsigned int cache;
92 #ifdef CONFIG_9P_FSCACHE
93         char *cachetag;
94         struct fscache_cookie *fscache;
95 #endif
96
97         char *uname;            /* user name to mount as */
98         char *aname;            /* name of remote hierarchy being mounted */
99         unsigned int maxdata;   /* max data for client interface */
100         unsigned int dfltuid;   /* default uid/muid for legacy support */
101         unsigned int dfltgid;   /* default gid for legacy support */
102         u32 uid;                /* if ACCESS_SINGLE, the uid that has access */
103         struct p9_client *clnt; /* 9p client */
104         struct list_head slist; /* list of sessions registered with v9fs */
105 };
106
107 struct p9_fid *v9fs_session_init(struct v9fs_session_info *, const char *,
108                                                                         char *);
109 void v9fs_session_close(struct v9fs_session_info *v9ses);
110 void v9fs_session_cancel(struct v9fs_session_info *v9ses);
111
112 #define V9FS_MAGIC 0x01021997
113
114 /* other default globals */
115 #define V9FS_PORT       564
116 #define V9FS_DEFUSER    "nobody"
117 #define V9FS_DEFANAME   ""
118 #define V9FS_DEFUID     (-2)
119 #define V9FS_DEFGID     (-2)
120
121 static inline struct v9fs_session_info *v9fs_inode2v9ses(struct inode *inode)
122 {
123         return (inode->i_sb->s_fs_info);
124 }
125
126 static inline int v9fs_proto_dotu(struct v9fs_session_info *v9ses)
127 {
128         return v9ses->flags & V9FS_PROTO_2000U;
129 }
130
131 static inline int v9fs_proto_dotl(struct v9fs_session_info *v9ses)
132 {
133         return v9ses->flags & V9FS_PROTO_2010L;
134 }