9p: implement optional loose read cache
[linux-2.6.git] / fs / 9p / v9fs.h
1 /*
2  * V9FS definitions.
3  *
4  *  Copyright (C) 2004 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   * Idpool structure provides lock and id management
26   *
27   */
28
29 struct v9fs_idpool {
30         struct semaphore lock;
31         struct idr pool;
32 };
33
34 /*
35   * Session structure provides information for an opened session
36   *
37   */
38
39 struct v9fs_session_info {
40         /* options */
41         unsigned int maxdata;
42         unsigned char extended; /* set to 1 if we are using UNIX extensions */
43         unsigned char nodev;    /* set to 1 if no disable device mapping */
44         unsigned short port;    /* port to connect to */
45         unsigned short debug;   /* debug level */
46         unsigned short proto;   /* protocol to use */
47         unsigned int afid;      /* authentication fid */
48         unsigned int rfdno;     /* read file descriptor number */
49         unsigned int wfdno;     /* write file descriptor number */
50         unsigned int cache;     /* cache mode */
51
52         char *name;             /* user name to mount as */
53         char *remotename;       /* name of remote hierarchy being mounted */
54         unsigned int uid;       /* default uid/muid for legacy support */
55         unsigned int gid;       /* default gid for legacy support */
56
57         /* book keeping */
58         struct v9fs_idpool fidpool;     /* The FID pool for file descriptors */
59
60         struct v9fs_transport *transport;
61         struct v9fs_mux_data *mux;
62
63         int inprogress;         /* session in progress => true */
64         int shutdown;           /* session shutting down. no more attaches. */
65         unsigned char session_hung;
66         struct dentry *debugfs_dir;
67 };
68
69 /* possible values of ->proto */
70 enum {
71         PROTO_TCP,
72         PROTO_UNIX,
73         PROTO_FD,
74 };
75
76 /* possible values of ->cache */
77 /* eventually support loose, tight, time, session, default always none */
78 enum {
79         CACHE_NONE,             /* default */
80         CACHE_LOOSE,            /* no consistency */
81 };
82
83 extern struct dentry *v9fs_debugfs_root;
84
85 int v9fs_session_init(struct v9fs_session_info *, const char *, char *);
86 struct v9fs_session_info *v9fs_inode2v9ses(struct inode *);
87 void v9fs_session_close(struct v9fs_session_info *v9ses);
88 int v9fs_get_idpool(struct v9fs_idpool *p);
89 void v9fs_put_idpool(int id, struct v9fs_idpool *p);
90 int v9fs_check_idpool(int id, struct v9fs_idpool *p);
91 void v9fs_session_cancel(struct v9fs_session_info *v9ses);
92
93 #define V9FS_MAGIC 0x01021997
94
95 /* other default globals */
96 #define V9FS_PORT               564
97 #define V9FS_DEFUSER    "nobody"
98 #define V9FS_DEFANAME   ""
99