a6f7b6cbfd09b9f6296f0a02d38c449481c35148
[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
160 /* pagelist.c */
161 extern int __init nfs_init_nfspagecache(void);
162 extern void nfs_destroy_nfspagecache(void);
163 extern int __init nfs_init_readpagecache(void);
164 extern void nfs_destroy_readpagecache(void);
165 extern int __init nfs_init_writepagecache(void);
166 extern void nfs_destroy_writepagecache(void);
167
168 extern int __init nfs_init_directcache(void);
169 extern void nfs_destroy_directcache(void);
170
171 /* nfs2xdr.c */
172 extern int nfs_stat_to_errno(int);
173 extern struct rpc_procinfo nfs_procedures[];
174 extern __be32 * nfs_decode_dirent(__be32 *, struct nfs_entry *, int);
175
176 /* nfs3xdr.c */
177 extern struct rpc_procinfo nfs3_procedures[];
178 extern __be32 *nfs3_decode_dirent(__be32 *, struct nfs_entry *, int);
179
180 /* nfs4xdr.c */
181 #ifdef CONFIG_NFS_V4
182 extern __be32 *nfs4_decode_dirent(__be32 *p, struct nfs_entry *entry, int plus);
183 #endif
184
185 /* nfs4proc.c */
186 extern void nfs4_restart_rpc(struct rpc_task *, const struct nfs_client *,
187                              struct nfs4_sequence_res *);
188 #ifdef CONFIG_NFS_V4
189 extern struct rpc_procinfo nfs4_procedures[];
190 #endif
191
192 /* proc.c */
193 void nfs_close_context(struct nfs_open_context *ctx, int is_sync);
194
195 /* dir.c */
196 extern int nfs_access_cache_shrinker(int nr_to_scan, gfp_t gfp_mask);
197
198 /* inode.c */
199 extern struct workqueue_struct *nfsiod_workqueue;
200 extern struct inode *nfs_alloc_inode(struct super_block *sb);
201 extern void nfs_destroy_inode(struct inode *);
202 extern int nfs_write_inode(struct inode *,int);
203 extern void nfs_clear_inode(struct inode *);
204 #ifdef CONFIG_NFS_V4
205 extern void nfs4_clear_inode(struct inode *);
206 #endif
207 void nfs_zap_acl_cache(struct inode *inode);
208 extern int nfs_wait_bit_killable(void *word);
209
210 /* super.c */
211 extern struct file_system_type nfs_xdev_fs_type;
212 #ifdef CONFIG_NFS_V4
213 extern struct file_system_type nfs4_xdev_fs_type;
214 extern struct file_system_type nfs4_referral_fs_type;
215 #endif
216
217 extern struct rpc_stat nfs_rpcstat;
218
219 extern int __init register_nfs_fs(void);
220 extern void __exit unregister_nfs_fs(void);
221 extern void nfs_sb_active(struct super_block *sb);
222 extern void nfs_sb_deactive(struct super_block *sb);
223
224 /* namespace.c */
225 extern char *nfs_path(const char *base,
226                       const struct dentry *droot,
227                       const struct dentry *dentry,
228                       char *buffer, ssize_t buflen);
229
230 /* getroot.c */
231 extern struct dentry *nfs_get_root(struct super_block *, struct nfs_fh *);
232 #ifdef CONFIG_NFS_V4
233 extern struct dentry *nfs4_get_root(struct super_block *, struct nfs_fh *);
234
235 extern int nfs4_path_walk(struct nfs_server *server,
236                           struct nfs_fh *mntfh,
237                           const char *path);
238 #endif
239
240 /* read.c */
241 extern void nfs_read_prepare(struct rpc_task *task, void *calldata);
242
243 /* write.c */
244 extern void nfs_write_prepare(struct rpc_task *task, void *calldata);
245 #ifdef CONFIG_MIGRATION
246 extern int nfs_migrate_page(struct address_space *,
247                 struct page *, struct page *);
248 #else
249 #define nfs_migrate_page NULL
250 #endif
251
252 /* nfs4proc.c */
253 extern int _nfs4_call_sync(struct nfs_server *server,
254                            struct rpc_message *msg,
255                            struct nfs4_sequence_args *args,
256                            struct nfs4_sequence_res *res,
257                            int cache_reply);
258 extern int _nfs4_call_sync_session(struct nfs_server *server,
259                                    struct rpc_message *msg,
260                                    struct nfs4_sequence_args *args,
261                                    struct nfs4_sequence_res *res,
262                                    int cache_reply);
263
264 #ifdef CONFIG_NFS_V4_1
265 extern void nfs41_sequence_free_slot(const struct nfs_client *,
266                                      struct nfs4_sequence_res *res);
267 #endif /* CONFIG_NFS_V4_1 */
268
269 static inline void nfs4_sequence_free_slot(const struct nfs_client *clp,
270                                            struct nfs4_sequence_res *res)
271 {
272 #ifdef CONFIG_NFS_V4_1
273         if (nfs4_has_session(clp))
274                 nfs41_sequence_free_slot(clp, res);
275 #endif /* CONFIG_NFS_V4_1 */
276 }
277
278 /*
279  * Determine the device name as a string
280  */
281 static inline char *nfs_devname(const struct vfsmount *mnt_parent,
282                                 const struct dentry *dentry,
283                                 char *buffer, ssize_t buflen)
284 {
285         return nfs_path(mnt_parent->mnt_devname, mnt_parent->mnt_root,
286                         dentry, buffer, buflen);
287 }
288
289 /*
290  * Determine the actual block size (and log2 thereof)
291  */
292 static inline
293 unsigned long nfs_block_bits(unsigned long bsize, unsigned char *nrbitsp)
294 {
295         /* make sure blocksize is a power of two */
296         if ((bsize & (bsize - 1)) || nrbitsp) {
297                 unsigned char   nrbits;
298
299                 for (nrbits = 31; nrbits && !(bsize & (1 << nrbits)); nrbits--)
300                         ;
301                 bsize = 1 << nrbits;
302                 if (nrbitsp)
303                         *nrbitsp = nrbits;
304         }
305
306         return bsize;
307 }
308
309 /*
310  * Calculate the number of 512byte blocks used.
311  */
312 static inline blkcnt_t nfs_calc_block_size(u64 tsize)
313 {
314         blkcnt_t used = (tsize + 511) >> 9;
315         return (used > ULONG_MAX) ? ULONG_MAX : used;
316 }
317
318 /*
319  * Compute and set NFS server blocksize
320  */
321 static inline
322 unsigned long nfs_block_size(unsigned long bsize, unsigned char *nrbitsp)
323 {
324         if (bsize < NFS_MIN_FILE_IO_SIZE)
325                 bsize = NFS_DEF_FILE_IO_SIZE;
326         else if (bsize >= NFS_MAX_FILE_IO_SIZE)
327                 bsize = NFS_MAX_FILE_IO_SIZE;
328
329         return nfs_block_bits(bsize, nrbitsp);
330 }
331
332 /*
333  * Determine the maximum file size for a superblock
334  */
335 static inline
336 void nfs_super_set_maxbytes(struct super_block *sb, __u64 maxfilesize)
337 {
338         sb->s_maxbytes = (loff_t)maxfilesize;
339         if (sb->s_maxbytes > MAX_LFS_FILESIZE || sb->s_maxbytes <= 0)
340                 sb->s_maxbytes = MAX_LFS_FILESIZE;
341 }
342
343 /*
344  * Determine the number of bytes of data the page contains
345  */
346 static inline
347 unsigned int nfs_page_length(struct page *page)
348 {
349         loff_t i_size = i_size_read(page->mapping->host);
350
351         if (i_size > 0) {
352                 pgoff_t end_index = (i_size - 1) >> PAGE_CACHE_SHIFT;
353                 if (page->index < end_index)
354                         return PAGE_CACHE_SIZE;
355                 if (page->index == end_index)
356                         return ((i_size - 1) & ~PAGE_CACHE_MASK) + 1;
357         }
358         return 0;
359 }
360
361 /*
362  * Determine the number of pages in an array of length 'len' and
363  * with a base offset of 'base'
364  */
365 static inline
366 unsigned int nfs_page_array_len(unsigned int base, size_t len)
367 {
368         return ((unsigned long)len + (unsigned long)base +
369                 PAGE_SIZE - 1) >> PAGE_SHIFT;
370 }