Merge branch 'pnfs-submit' of git://git.open-osd.org/linux-open-osd
[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 static inline int nfs4_has_persistent_session(const struct nfs_client *clp)
34 {
35 #ifdef CONFIG_NFS_V4_1
36         if (nfs4_has_session(clp))
37                 return (clp->cl_session->flags & SESSION4_PERSIST);
38 #endif /* CONFIG_NFS_V4_1 */
39         return 0;
40 }
41
42 static inline void nfs_attr_check_mountpoint(struct super_block *parent, struct nfs_fattr *fattr)
43 {
44         if (!nfs_fsid_equal(&NFS_SB(parent)->fsid, &fattr->fsid))
45                 fattr->valid |= NFS_ATTR_FATTR_MOUNTPOINT;
46 }
47
48 struct nfs_clone_mount {
49         const struct super_block *sb;
50         const struct dentry *dentry;
51         struct nfs_fh *fh;
52         struct nfs_fattr *fattr;
53         char *hostname;
54         char *mnt_path;
55         struct sockaddr *addr;
56         size_t addrlen;
57         rpc_authflavor_t authflavor;
58 };
59
60 /*
61  * Note: RFC 1813 doesn't limit the number of auth flavors that
62  * a server can return, so make something up.
63  */
64 #define NFS_MAX_SECFLAVORS      (12)
65
66 /*
67  * Value used if the user did not specify a port value.
68  */
69 #define NFS_UNSPEC_PORT         (-1)
70
71 /*
72  * Maximum number of pages that readdir can use for creating
73  * a vmapped array of pages.
74  */
75 #define NFS_MAX_READDIR_PAGES 8
76
77 /*
78  * In-kernel mount arguments
79  */
80 struct nfs_parsed_mount_data {
81         int                     flags;
82         int                     rsize, wsize;
83         int                     timeo, retrans;
84         int                     acregmin, acregmax,
85                                 acdirmin, acdirmax;
86         int                     namlen;
87         unsigned int            options;
88         unsigned int            bsize;
89         unsigned int            auth_flavor_len;
90         rpc_authflavor_t        auth_flavors[1];
91         char                    *client_address;
92         unsigned int            version;
93         unsigned int            minorversion;
94         char                    *fscache_uniq;
95
96         struct {
97                 struct sockaddr_storage address;
98                 size_t                  addrlen;
99                 char                    *hostname;
100                 u32                     version;
101                 int                     port;
102                 unsigned short          protocol;
103         } mount_server;
104
105         struct {
106                 struct sockaddr_storage address;
107                 size_t                  addrlen;
108                 char                    *hostname;
109                 char                    *export_path;
110                 int                     port;
111                 unsigned short          protocol;
112         } nfs_server;
113
114         struct security_mnt_opts lsm_opts;
115 };
116
117 /* mount_clnt.c */
118 struct nfs_mount_request {
119         struct sockaddr         *sap;
120         size_t                  salen;
121         char                    *hostname;
122         char                    *dirpath;
123         u32                     version;
124         unsigned short          protocol;
125         struct nfs_fh           *fh;
126         int                     noresvport;
127         unsigned int            *auth_flav_len;
128         rpc_authflavor_t        *auth_flavs;
129 };
130
131 extern int nfs_mount(struct nfs_mount_request *info);
132 extern void nfs_umount(const struct nfs_mount_request *info);
133
134 /* client.c */
135 extern struct rpc_program nfs_program;
136
137 extern void nfs_cleanup_cb_ident_idr(void);
138 extern void nfs_put_client(struct nfs_client *);
139 extern struct nfs_client *nfs4_find_client_no_ident(const struct sockaddr *);
140 extern struct nfs_client *nfs4_find_client_ident(int);
141 extern struct nfs_client *
142 nfs4_find_client_sessionid(const struct sockaddr *, struct nfs4_sessionid *);
143 extern struct nfs_server *nfs_create_server(
144                                         const struct nfs_parsed_mount_data *,
145                                         struct nfs_fh *);
146 extern struct nfs_server *nfs4_create_server(
147                                         const struct nfs_parsed_mount_data *,
148                                         struct nfs_fh *);
149 extern struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *,
150                                                       struct nfs_fh *);
151 extern void nfs_free_server(struct nfs_server *server);
152 extern struct nfs_server *nfs_clone_server(struct nfs_server *,
153                                            struct nfs_fh *,
154                                            struct nfs_fattr *);
155 extern void nfs_mark_client_ready(struct nfs_client *clp, int state);
156 extern int nfs4_check_client_ready(struct nfs_client *clp);
157 extern struct nfs_client *nfs4_set_ds_client(struct nfs_client* mds_clp,
158                                              const struct sockaddr *ds_addr,
159                                              int ds_addrlen, int ds_proto);
160 #ifdef CONFIG_PROC_FS
161 extern int __init nfs_fs_proc_init(void);
162 extern void nfs_fs_proc_exit(void);
163 #else
164 static inline int nfs_fs_proc_init(void)
165 {
166         return 0;
167 }
168 static inline void nfs_fs_proc_exit(void)
169 {
170 }
171 #endif
172
173 /* nfs4namespace.c */
174 #ifdef CONFIG_NFS_V4
175 extern struct vfsmount *nfs_do_refmount(struct dentry *dentry);
176 #else
177 static inline
178 struct vfsmount *nfs_do_refmount(struct dentry *dentry)
179 {
180         return ERR_PTR(-ENOENT);
181 }
182 #endif
183
184 /* callback_xdr.c */
185 extern struct svc_version nfs4_callback_version1;
186 extern struct svc_version nfs4_callback_version4;
187
188 /* pagelist.c */
189 extern int __init nfs_init_nfspagecache(void);
190 extern void nfs_destroy_nfspagecache(void);
191 extern int __init nfs_init_readpagecache(void);
192 extern void nfs_destroy_readpagecache(void);
193 extern int __init nfs_init_writepagecache(void);
194 extern void nfs_destroy_writepagecache(void);
195
196 extern int __init nfs_init_directcache(void);
197 extern void nfs_destroy_directcache(void);
198
199 /* nfs2xdr.c */
200 extern int nfs_stat_to_errno(enum nfs_stat);
201 extern struct rpc_procinfo nfs_procedures[];
202 extern int nfs2_decode_dirent(struct xdr_stream *,
203                                 struct nfs_entry *, int);
204
205 /* nfs3xdr.c */
206 extern struct rpc_procinfo nfs3_procedures[];
207 extern int nfs3_decode_dirent(struct xdr_stream *,
208                                 struct nfs_entry *, int);
209
210 /* nfs4xdr.c */
211 #ifdef CONFIG_NFS_V4
212 extern int nfs4_decode_dirent(struct xdr_stream *,
213                                 struct nfs_entry *, int);
214 #endif
215 #ifdef CONFIG_NFS_V4_1
216 extern const u32 nfs41_maxread_overhead;
217 extern const u32 nfs41_maxwrite_overhead;
218 #endif
219
220 /* nfs4proc.c */
221 #ifdef CONFIG_NFS_V4
222 extern struct rpc_procinfo nfs4_procedures[];
223 void nfs_fixup_secinfo_attributes(struct nfs_fattr *, struct nfs_fh *);
224 #endif
225
226 extern int nfs4_init_ds_session(struct nfs_client *clp);
227
228 /* proc.c */
229 void nfs_close_context(struct nfs_open_context *ctx, int is_sync);
230 extern int nfs_init_client(struct nfs_client *clp,
231                            const struct rpc_timeout *timeparms,
232                            const char *ip_addr, rpc_authflavor_t authflavour,
233                            int noresvport);
234
235 /* dir.c */
236 extern int nfs_access_cache_shrinker(struct shrinker *shrink,
237                                         struct shrink_control *sc);
238
239 /* inode.c */
240 extern struct workqueue_struct *nfsiod_workqueue;
241 extern struct inode *nfs_alloc_inode(struct super_block *sb);
242 extern void nfs_destroy_inode(struct inode *);
243 extern int nfs_write_inode(struct inode *, struct writeback_control *);
244 extern void nfs_evict_inode(struct inode *);
245 #ifdef CONFIG_NFS_V4
246 extern void nfs4_evict_inode(struct inode *);
247 #endif
248 void nfs_zap_acl_cache(struct inode *inode);
249 extern int nfs_wait_bit_killable(void *word);
250
251 /* super.c */
252 extern struct file_system_type nfs_xdev_fs_type;
253 #ifdef CONFIG_NFS_V4
254 extern struct file_system_type nfs4_xdev_fs_type;
255 extern struct file_system_type nfs4_referral_fs_type;
256 #endif
257
258 extern struct rpc_stat nfs_rpcstat;
259
260 extern int __init register_nfs_fs(void);
261 extern void __exit unregister_nfs_fs(void);
262 extern void nfs_sb_active(struct super_block *sb);
263 extern void nfs_sb_deactive(struct super_block *sb);
264
265 /* namespace.c */
266 extern char *nfs_path(char **p, struct dentry *dentry,
267                       char *buffer, ssize_t buflen);
268 extern struct vfsmount *nfs_d_automount(struct path *path);
269
270 /* getroot.c */
271 extern struct dentry *nfs_get_root(struct super_block *, struct nfs_fh *,
272                                    const char *);
273 #ifdef CONFIG_NFS_V4
274 extern struct dentry *nfs4_get_root(struct super_block *, struct nfs_fh *,
275                                     const char *);
276
277 extern int nfs4_get_rootfh(struct nfs_server *server, struct nfs_fh *mntfh);
278 #endif
279
280 /* read.c */
281 extern int nfs_initiate_read(struct nfs_read_data *data, struct rpc_clnt *clnt,
282                              const struct rpc_call_ops *call_ops);
283 extern void nfs_read_prepare(struct rpc_task *task, void *calldata);
284
285 /* write.c */
286 extern void nfs_commit_free(struct nfs_write_data *p);
287 extern int nfs_initiate_write(struct nfs_write_data *data,
288                               struct rpc_clnt *clnt,
289                               const struct rpc_call_ops *call_ops,
290                               int how);
291 extern void nfs_write_prepare(struct rpc_task *task, void *calldata);
292 extern int nfs_initiate_commit(struct nfs_write_data *data,
293                                struct rpc_clnt *clnt,
294                                const struct rpc_call_ops *call_ops,
295                                int how);
296 extern void nfs_init_commit(struct nfs_write_data *data,
297                             struct list_head *head,
298                             struct pnfs_layout_segment *lseg);
299 void nfs_retry_commit(struct list_head *page_list,
300                       struct pnfs_layout_segment *lseg);
301 void nfs_commit_clear_lock(struct nfs_inode *nfsi);
302 void nfs_commitdata_release(void *data);
303 void nfs_commit_release_pages(struct nfs_write_data *data);
304
305 #ifdef CONFIG_MIGRATION
306 extern int nfs_migrate_page(struct address_space *,
307                 struct page *, struct page *);
308 #else
309 #define nfs_migrate_page NULL
310 #endif
311
312 /* nfs4proc.c */
313 extern void __nfs4_read_done_cb(struct nfs_read_data *);
314 extern void nfs4_reset_read(struct rpc_task *task, struct nfs_read_data *data);
315 extern int nfs4_init_client(struct nfs_client *clp,
316                             const struct rpc_timeout *timeparms,
317                             const char *ip_addr,
318                             rpc_authflavor_t authflavour,
319                             int noresvport);
320 extern void nfs4_reset_write(struct rpc_task *task, struct nfs_write_data *data);
321 extern int _nfs4_call_sync(struct rpc_clnt *clnt,
322                            struct nfs_server *server,
323                            struct rpc_message *msg,
324                            struct nfs4_sequence_args *args,
325                            struct nfs4_sequence_res *res,
326                            int cache_reply);
327 extern int _nfs4_call_sync_session(struct rpc_clnt *clnt,
328                                    struct nfs_server *server,
329                                    struct rpc_message *msg,
330                                    struct nfs4_sequence_args *args,
331                                    struct nfs4_sequence_res *res,
332                                    int cache_reply);
333
334 /*
335  * Determine the device name as a string
336  */
337 static inline char *nfs_devname(struct dentry *dentry,
338                                 char *buffer, ssize_t buflen)
339 {
340         char *dummy;
341         return nfs_path(&dummy, dentry, buffer, buflen);
342 }
343
344 /*
345  * Determine the actual block size (and log2 thereof)
346  */
347 static inline
348 unsigned long nfs_block_bits(unsigned long bsize, unsigned char *nrbitsp)
349 {
350         /* make sure blocksize is a power of two */
351         if ((bsize & (bsize - 1)) || nrbitsp) {
352                 unsigned char   nrbits;
353
354                 for (nrbits = 31; nrbits && !(bsize & (1 << nrbits)); nrbits--)
355                         ;
356                 bsize = 1 << nrbits;
357                 if (nrbitsp)
358                         *nrbitsp = nrbits;
359         }
360
361         return bsize;
362 }
363
364 /*
365  * Calculate the number of 512byte blocks used.
366  */
367 static inline blkcnt_t nfs_calc_block_size(u64 tsize)
368 {
369         blkcnt_t used = (tsize + 511) >> 9;
370         return (used > ULONG_MAX) ? ULONG_MAX : used;
371 }
372
373 /*
374  * Compute and set NFS server blocksize
375  */
376 static inline
377 unsigned long nfs_block_size(unsigned long bsize, unsigned char *nrbitsp)
378 {
379         if (bsize < NFS_MIN_FILE_IO_SIZE)
380                 bsize = NFS_DEF_FILE_IO_SIZE;
381         else if (bsize >= NFS_MAX_FILE_IO_SIZE)
382                 bsize = NFS_MAX_FILE_IO_SIZE;
383
384         return nfs_block_bits(bsize, nrbitsp);
385 }
386
387 /*
388  * Determine the maximum file size for a superblock
389  */
390 static inline
391 void nfs_super_set_maxbytes(struct super_block *sb, __u64 maxfilesize)
392 {
393         sb->s_maxbytes = (loff_t)maxfilesize;
394         if (sb->s_maxbytes > MAX_LFS_FILESIZE || sb->s_maxbytes <= 0)
395                 sb->s_maxbytes = MAX_LFS_FILESIZE;
396 }
397
398 /*
399  * Determine the number of bytes of data the page contains
400  */
401 static inline
402 unsigned int nfs_page_length(struct page *page)
403 {
404         loff_t i_size = i_size_read(page->mapping->host);
405
406         if (i_size > 0) {
407                 pgoff_t end_index = (i_size - 1) >> PAGE_CACHE_SHIFT;
408                 if (page->index < end_index)
409                         return PAGE_CACHE_SIZE;
410                 if (page->index == end_index)
411                         return ((i_size - 1) & ~PAGE_CACHE_MASK) + 1;
412         }
413         return 0;
414 }
415
416 /*
417  * Convert a umode to a dirent->d_type
418  */
419 static inline
420 unsigned char nfs_umode_to_dtype(umode_t mode)
421 {
422         return (mode >> 12) & 15;
423 }
424
425 /*
426  * Determine the number of pages in an array of length 'len' and
427  * with a base offset of 'base'
428  */
429 static inline
430 unsigned int nfs_page_array_len(unsigned int base, size_t len)
431 {
432         return ((unsigned long)len + (unsigned long)base +
433                 PAGE_SIZE - 1) >> PAGE_SHIFT;
434 }
435
436 /*
437  * Helper for restarting RPC calls in the possible presence of NFSv4.1
438  * sessions.
439  */
440 static inline int nfs_restart_rpc(struct rpc_task *task, const struct nfs_client *clp)
441 {
442         if (nfs4_has_session(clp))
443                 return rpc_restart_call_prepare(task);
444         return rpc_restart_call(task);
445 }