nfs41: add support for callback with RPC version number 4
[linux-2.6.git] / fs / nfs / internal.h
1 /*
2  * NFS internal definitions
3  */
4
5 #include "nfs4_fs.h"
6 #include <linux/mount.h>
7 #include <linux/security.h>
8
9 #define NFS_MS_MASK (MS_RDONLY|MS_NOSUID|MS_NODEV|MS_NOEXEC|MS_SYNCHRONOUS)
10
11 struct nfs_string;
12
13 /* Maximum number of readahead requests
14  * FIXME: this should really be a sysctl so that users may tune it to suit
15  *        their needs. People that do NFS over a slow network, might for
16  *        instance want to reduce it to something closer to 1 for improved
17  *        interactive response.
18  */
19 #define NFS_MAX_READAHEAD       (RPC_DEF_SLOT_TABLE - 1)
20
21 /*
22  * Determine if sessions are in use.
23  */
24 static inline int nfs4_has_session(const struct nfs_client *clp)
25 {
26 #ifdef CONFIG_NFS_V4_1
27         if (clp->cl_session)
28                 return 1;
29 #endif /* CONFIG_NFS_V4_1 */
30         return 0;
31 }
32
33 struct nfs_clone_mount {
34         const struct super_block *sb;
35         const struct dentry *dentry;
36         struct nfs_fh *fh;
37         struct nfs_fattr *fattr;
38         char *hostname;
39         char *mnt_path;
40         struct sockaddr *addr;
41         size_t addrlen;
42         rpc_authflavor_t authflavor;
43 };
44
45 /*
46  * Note: RFC 1813 doesn't limit the number of auth flavors that
47  * a server can return, so make something up.
48  */
49 #define NFS_MAX_SECFLAVORS      (12)
50
51 /*
52  * Value used if the user did not specify a port value.
53  */
54 #define NFS_UNSPEC_PORT         (-1)
55
56 /*
57  * In-kernel mount arguments
58  */
59 struct nfs_parsed_mount_data {
60         int                     flags;
61         int                     rsize, wsize;
62         int                     timeo, retrans;
63         int                     acregmin, acregmax,
64                                 acdirmin, acdirmax;
65         int                     namlen;
66         unsigned int            options;
67         unsigned int            bsize;
68         unsigned int            auth_flavor_len;
69         rpc_authflavor_t        auth_flavors[1];
70         char                    *client_address;
71         unsigned int            version;
72         unsigned int            minorversion;
73         char                    *fscache_uniq;
74
75         struct {
76                 struct sockaddr_storage address;
77                 size_t                  addrlen;
78                 char                    *hostname;
79                 u32                     version;
80                 int                     port;
81                 unsigned short          protocol;
82         } mount_server;
83
84         struct {
85                 struct sockaddr_storage address;
86                 size_t                  addrlen;
87                 char                    *hostname;
88                 char                    *export_path;
89                 int                     port;
90                 unsigned short          protocol;
91         } nfs_server;
92
93         struct security_mnt_opts lsm_opts;
94 };
95
96 /* mount_clnt.c */
97 struct nfs_mount_request {
98         struct sockaddr         *sap;
99         size_t                  salen;
100         char                    *hostname;
101         char                    *dirpath;
102         u32                     version;
103         unsigned short          protocol;
104         struct nfs_fh           *fh;
105         int                     noresvport;
106         unsigned int            *auth_flav_len;
107         rpc_authflavor_t        *auth_flavs;
108 };
109
110 extern int nfs_mount(struct nfs_mount_request *info);
111 extern void nfs_umount(const struct nfs_mount_request *info);
112
113 /* client.c */
114 extern struct rpc_program nfs_program;
115
116 extern void nfs_put_client(struct nfs_client *);
117 extern struct nfs_client *nfs_find_client(const struct sockaddr *, u32);
118 extern struct nfs_client *nfs_find_client_next(struct nfs_client *);
119 extern struct nfs_server *nfs_create_server(
120                                         const struct nfs_parsed_mount_data *,
121                                         struct nfs_fh *);
122 extern struct nfs_server *nfs4_create_server(
123                                         const struct nfs_parsed_mount_data *,
124                                         struct nfs_fh *);
125 extern struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *,
126                                                       struct nfs_fh *);
127 extern void nfs_free_server(struct nfs_server *server);
128 extern struct nfs_server *nfs_clone_server(struct nfs_server *,
129                                            struct nfs_fh *,
130                                            struct nfs_fattr *);
131 extern void nfs_mark_client_ready(struct nfs_client *clp, int state);
132 extern int nfs4_check_client_ready(struct nfs_client *clp);
133 #ifdef CONFIG_PROC_FS
134 extern int __init nfs_fs_proc_init(void);
135 extern void nfs_fs_proc_exit(void);
136 #else
137 static inline int nfs_fs_proc_init(void)
138 {
139         return 0;
140 }
141 static inline void nfs_fs_proc_exit(void)
142 {
143 }
144 #endif
145
146 /* nfs4namespace.c */
147 #ifdef CONFIG_NFS_V4
148 extern struct vfsmount *nfs_do_refmount(const struct vfsmount *mnt_parent, struct dentry *dentry);
149 #else
150 static inline
151 struct vfsmount *nfs_do_refmount(const struct vfsmount *mnt_parent, struct dentry *dentry)
152 {
153         return ERR_PTR(-ENOENT);
154 }
155 #endif
156
157 /* callback_xdr.c */
158 extern struct svc_version nfs4_callback_version1;
159 extern struct svc_version nfs4_callback_version4;
160
161 /* pagelist.c */
162 extern int __init nfs_init_nfspagecache(void);
163 extern void nfs_destroy_nfspagecache(void);
164 extern int __init nfs_init_readpagecache(void);
165 extern void nfs_destroy_readpagecache(void);
166 extern int __init nfs_init_writepagecache(void);
167 extern void nfs_destroy_writepagecache(void);
168
169 extern int __init nfs_init_directcache(void);
170 extern void nfs_destroy_directcache(void);
171
172 /* nfs2xdr.c */
173 extern int nfs_stat_to_errno(int);
174 extern struct rpc_procinfo nfs_procedures[];
175 extern __be32 * nfs_decode_dirent(__be32 *, struct nfs_entry *, int);
176
177 /* nfs3xdr.c */
178 extern struct rpc_procinfo nfs3_procedures[];
179 extern __be32 *nfs3_decode_dirent(__be32 *, struct nfs_entry *, int);
180
181 /* nfs4xdr.c */
182 #ifdef CONFIG_NFS_V4
183 extern __be32 *nfs4_decode_dirent(__be32 *p, struct nfs_entry *entry, int plus);
184 #endif
185
186 /* nfs4proc.c */
187 extern void nfs4_restart_rpc(struct rpc_task *, const struct nfs_client *,
188                              struct nfs4_sequence_res *);
189 #ifdef CONFIG_NFS_V4
190 extern struct rpc_procinfo nfs4_procedures[];
191 #endif
192
193 /* proc.c */
194 void nfs_close_context(struct nfs_open_context *ctx, int is_sync);
195
196 /* dir.c */
197 extern int nfs_access_cache_shrinker(int nr_to_scan, gfp_t gfp_mask);
198
199 /* inode.c */
200 extern struct workqueue_struct *nfsiod_workqueue;
201 extern struct inode *nfs_alloc_inode(struct super_block *sb);
202 extern void nfs_destroy_inode(struct inode *);
203 extern int nfs_write_inode(struct inode *,int);
204 extern void nfs_clear_inode(struct inode *);
205 #ifdef CONFIG_NFS_V4
206 extern void nfs4_clear_inode(struct inode *);
207 #endif
208 void nfs_zap_acl_cache(struct inode *inode);
209 extern int nfs_wait_bit_killable(void *word);
210
211 /* super.c */
212 extern struct file_system_type nfs_xdev_fs_type;
213 #ifdef CONFIG_NFS_V4
214 extern struct file_system_type nfs4_xdev_fs_type;
215 extern struct file_system_type nfs4_referral_fs_type;
216 #endif
217
218 extern struct rpc_stat nfs_rpcstat;
219
220 extern int __init register_nfs_fs(void);
221 extern void __exit unregister_nfs_fs(void);
222 extern void nfs_sb_active(struct super_block *sb);
223 extern void nfs_sb_deactive(struct super_block *sb);
224
225 /* namespace.c */
226 extern char *nfs_path(const char *base,
227                       const struct dentry *droot,
228                       const struct dentry *dentry,
229                       char *buffer, ssize_t buflen);
230
231 /* getroot.c */
232 extern struct dentry *nfs_get_root(struct super_block *, struct nfs_fh *);
233 #ifdef CONFIG_NFS_V4
234 extern struct dentry *nfs4_get_root(struct super_block *, struct nfs_fh *);
235
236 extern int nfs4_path_walk(struct nfs_server *server,
237                           struct nfs_fh *mntfh,
238                           const char *path);
239 #endif
240
241 /* read.c */
242 extern void nfs_read_prepare(struct rpc_task *task, void *calldata);
243
244 /* write.c */
245 extern void nfs_write_prepare(struct rpc_task *task, void *calldata);
246 #ifdef CONFIG_MIGRATION
247 extern int nfs_migrate_page(struct address_space *,
248                 struct page *, struct page *);
249 #else
250 #define nfs_migrate_page NULL
251 #endif
252
253 /* nfs4proc.c */
254 extern int _nfs4_call_sync(struct nfs_server *server,
255                            struct rpc_message *msg,
256                            struct nfs4_sequence_args *args,
257                            struct nfs4_sequence_res *res,
258                            int cache_reply);
259 extern int _nfs4_call_sync_session(struct nfs_server *server,
260                                    struct rpc_message *msg,
261                                    struct nfs4_sequence_args *args,
262                                    struct nfs4_sequence_res *res,
263                                    int cache_reply);
264
265 #ifdef CONFIG_NFS_V4_1
266 extern void nfs41_sequence_free_slot(const struct nfs_client *,
267                                      struct nfs4_sequence_res *res);
268 #endif /* CONFIG_NFS_V4_1 */
269
270 static inline void nfs4_sequence_free_slot(const struct nfs_client *clp,
271                                            struct nfs4_sequence_res *res)
272 {
273 #ifdef CONFIG_NFS_V4_1
274         if (nfs4_has_session(clp))
275                 nfs41_sequence_free_slot(clp, res);
276 #endif /* CONFIG_NFS_V4_1 */
277 }
278
279 /*
280  * Determine the device name as a string
281  */
282 static inline char *nfs_devname(const struct vfsmount *mnt_parent,
283                                 const struct dentry *dentry,
284                                 char *buffer, ssize_t buflen)
285 {
286         return nfs_path(mnt_parent->mnt_devname, mnt_parent->mnt_root,
287                         dentry, buffer, buflen);
288 }
289
290 /*
291  * Determine the actual block size (and log2 thereof)
292  */
293 static inline
294 unsigned long nfs_block_bits(unsigned long bsize, unsigned char *nrbitsp)
295 {
296         /* make sure blocksize is a power of two */
297         if ((bsize & (bsize - 1)) || nrbitsp) {
298                 unsigned char   nrbits;
299
300                 for (nrbits = 31; nrbits && !(bsize & (1 << nrbits)); nrbits--)
301                         ;
302                 bsize = 1 << nrbits;
303                 if (nrbitsp)
304                         *nrbitsp = nrbits;
305         }
306
307         return bsize;
308 }
309
310 /*
311  * Calculate the number of 512byte blocks used.
312  */
313 static inline blkcnt_t nfs_calc_block_size(u64 tsize)
314 {
315         blkcnt_t used = (tsize + 511) >> 9;
316         return (used > ULONG_MAX) ? ULONG_MAX : used;
317 }
318
319 /*
320  * Compute and set NFS server blocksize
321  */
322 static inline
323 unsigned long nfs_block_size(unsigned long bsize, unsigned char *nrbitsp)
324 {
325         if (bsize < NFS_MIN_FILE_IO_SIZE)
326                 bsize = NFS_DEF_FILE_IO_SIZE;
327         else if (bsize >= NFS_MAX_FILE_IO_SIZE)
328                 bsize = NFS_MAX_FILE_IO_SIZE;
329
330         return nfs_block_bits(bsize, nrbitsp);
331 }
332
333 /*
334  * Determine the maximum file size for a superblock
335  */
336 static inline
337 void nfs_super_set_maxbytes(struct super_block *sb, __u64 maxfilesize)
338 {
339         sb->s_maxbytes = (loff_t)maxfilesize;
340         if (sb->s_maxbytes > MAX_LFS_FILESIZE || sb->s_maxbytes <= 0)
341                 sb->s_maxbytes = MAX_LFS_FILESIZE;
342 }
343
344 /*
345  * Determine the number of bytes of data the page contains
346  */
347 static inline
348 unsigned int nfs_page_length(struct page *page)
349 {
350         loff_t i_size = i_size_read(page->mapping->host);
351
352         if (i_size > 0) {
353                 pgoff_t end_index = (i_size - 1) >> PAGE_CACHE_SHIFT;
354                 if (page->index < end_index)
355                         return PAGE_CACHE_SIZE;
356                 if (page->index == end_index)
357                         return ((i_size - 1) & ~PAGE_CACHE_MASK) + 1;
358         }
359         return 0;
360 }
361
362 /*
363  * Determine the number of pages in an array of length 'len' and
364  * with a base offset of 'base'
365  */
366 static inline
367 unsigned int nfs_page_array_len(unsigned int base, size_t len)
368 {
369         return ((unsigned long)len + (unsigned long)base +
370                 PAGE_SIZE - 1) >> PAGE_SHIFT;
371 }