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