NFS4.1: Add lseg to struct nfs4_fl_commit_bucket
[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;
e50a7a1a 126 struct net *net;
6b18eaa0
TT
127};
128
146ec944 129/* mount_clnt.c */
c5d120f8
CL
130struct nfs_mount_request {
131 struct sockaddr *sap;
132 size_t salen;
133 char *hostname;
134 char *dirpath;
135 u32 version;
136 unsigned short protocol;
137 struct nfs_fh *fh;
50a737f8 138 int noresvport;
8e02f6b9
CL
139 unsigned int *auth_flav_len;
140 rpc_authflavor_t *auth_flavs;
6d59b8d5 141 struct net *net;
c5d120f8
CL
142};
143
144extern int nfs_mount(struct nfs_mount_request *info);
0b524123 145extern void nfs_umount(const struct nfs_mount_request *info);
146ec944 146
24c8dbbb 147/* client.c */
a613fa16 148extern const struct rpc_program nfs_program;
6b13168b 149extern void nfs_clients_init(struct net *net);
54ceac45 150
28cd1b3f 151extern void nfs_cleanup_cb_ident_idr(struct net *);
24c8dbbb 152extern void nfs_put_client(struct nfs_client *);
28cd1b3f 153extern struct nfs_client *nfs4_find_client_ident(struct net *, int);
c36fca52 154extern struct nfs_client *
c7add9a9
SK
155nfs4_find_client_sessionid(struct net *, const struct sockaddr *,
156 struct nfs4_sessionid *);
2283f8d6
TT
157extern struct nfs_server *nfs_create_server(
158 const struct nfs_parsed_mount_data *,
159 struct nfs_fh *);
91ea40b9
TT
160extern struct nfs_server *nfs4_create_server(
161 const struct nfs_parsed_mount_data *,
162 struct nfs_fh *);
54ceac45
DH
163extern struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *,
164 struct nfs_fh *);
165extern void nfs_free_server(struct nfs_server *server);
166extern struct nfs_server *nfs_clone_server(struct nfs_server *,
167 struct nfs_fh *,
7e6eb683
BS
168 struct nfs_fattr *,
169 rpc_authflavor_t);
76db6d95 170extern void nfs_mark_client_ready(struct nfs_client *clp, int state);
008f55d0 171extern int nfs4_check_client_ready(struct nfs_client *clp);
d83217c1
AA
172extern struct nfs_client *nfs4_set_ds_client(struct nfs_client* mds_clp,
173 const struct sockaddr *ds_addr,
174 int ds_addrlen, int ds_proto);
6aaca566
DH
175#ifdef CONFIG_PROC_FS
176extern int __init nfs_fs_proc_init(void);
177extern void nfs_fs_proc_exit(void);
178#else
179static inline int nfs_fs_proc_init(void)
180{
181 return 0;
182}
183static inline void nfs_fs_proc_exit(void)
184{
185}
186#endif
24c8dbbb 187
7d4e2747 188/* nfs4namespace.c */
f7b422b1 189#ifdef CONFIG_NFS_V4
f05d147f 190extern struct vfsmount *nfs_do_refmount(struct rpc_clnt *client, struct dentry *dentry);
f7b422b1
DH
191#else
192static inline
f05d147f 193struct vfsmount *nfs_do_refmount(struct rpc_clnt *client, struct dentry *dentry)
f7b422b1
DH
194{
195 return ERR_PTR(-ENOENT);
196}
197#endif
198
199/* callback_xdr.c */
200extern struct svc_version nfs4_callback_version1;
07bccc2d 201extern struct svc_version nfs4_callback_version4;
f7b422b1
DH
202
203/* pagelist.c */
204extern int __init nfs_init_nfspagecache(void);
266bee88 205extern void nfs_destroy_nfspagecache(void);
f7b422b1 206extern int __init nfs_init_readpagecache(void);
266bee88 207extern void nfs_destroy_readpagecache(void);
f7b422b1 208extern int __init nfs_init_writepagecache(void);
266bee88 209extern void nfs_destroy_writepagecache(void);
f7b422b1 210
f7b422b1 211extern int __init nfs_init_directcache(void);
266bee88 212extern void nfs_destroy_directcache(void);
f7b422b1
DH
213
214/* nfs2xdr.c */
85828493 215extern int nfs_stat_to_errno(enum nfs_stat);
f7b422b1 216extern struct rpc_procinfo nfs_procedures[];
573c4e1e
CL
217extern int nfs2_decode_dirent(struct xdr_stream *,
218 struct nfs_entry *, int);
f7b422b1
DH
219
220/* nfs3xdr.c */
221extern struct rpc_procinfo nfs3_procedures[];
573c4e1e
CL
222extern int nfs3_decode_dirent(struct xdr_stream *,
223 struct nfs_entry *, int);
f7b422b1
DH
224
225/* nfs4xdr.c */
7d4e2747 226#ifdef CONFIG_NFS_V4
573c4e1e
CL
227extern int nfs4_decode_dirent(struct xdr_stream *,
228 struct nfs_entry *, int);
7d4e2747 229#endif
2449ea2e
AB
230#ifdef CONFIG_NFS_V4_1
231extern const u32 nfs41_maxread_overhead;
232extern const u32 nfs41_maxwrite_overhead;
233#endif
f7b422b1
DH
234
235/* nfs4proc.c */
d75d5414 236#ifdef CONFIG_NFS_V4
f7b422b1 237extern struct rpc_procinfo nfs4_procedures[];
d75d5414 238#endif
f7b422b1 239
d83217c1
AA
240extern int nfs4_init_ds_session(struct nfs_client *clp);
241
7fe5c398
TM
242/* proc.c */
243void nfs_close_context(struct nfs_open_context *ctx, int is_sync);
45a52a02
AA
244extern int nfs_init_client(struct nfs_client *clp,
245 const struct rpc_timeout *timeparms,
246 const char *ip_addr, rpc_authflavor_t authflavour,
247 int noresvport);
7fe5c398 248
979df72e 249/* dir.c */
7f8275d0 250extern int nfs_access_cache_shrinker(struct shrinker *shrink,
1495f230 251 struct shrink_control *sc);
979df72e 252
f7b422b1 253/* inode.c */
5746006f 254extern struct workqueue_struct *nfsiod_workqueue;
f7b422b1
DH
255extern struct inode *nfs_alloc_inode(struct super_block *sb);
256extern void nfs_destroy_inode(struct inode *);
a9185b41 257extern int nfs_write_inode(struct inode *, struct writeback_control *);
b57922d9 258extern void nfs_evict_inode(struct inode *);
f7b422b1 259#ifdef CONFIG_NFS_V4
b57922d9 260extern void nfs4_evict_inode(struct inode *);
f7b422b1 261#endif
f41f7418 262void nfs_zap_acl_cache(struct inode *inode);
72cb77f4 263extern int nfs_wait_bit_killable(void *word);
f7b422b1
DH
264
265/* super.c */
54ceac45 266extern struct file_system_type nfs_xdev_fs_type;
f7b422b1 267#ifdef CONFIG_NFS_V4
54ceac45
DH
268extern struct file_system_type nfs4_xdev_fs_type;
269extern struct file_system_type nfs4_referral_fs_type;
f7b422b1 270#endif
4ebd9ab3 271
f7b422b1 272extern struct rpc_stat nfs_rpcstat;
4ebd9ab3 273
f7b422b1
DH
274extern int __init register_nfs_fs(void);
275extern void __exit unregister_nfs_fs(void);
1daef0a8
TM
276extern void nfs_sb_active(struct super_block *sb);
277extern void nfs_sb_deactive(struct super_block *sb);
f7b422b1
DH
278
279/* namespace.c */
b514f872 280extern char *nfs_path(char **p, struct dentry *dentry,
f7b422b1 281 char *buffer, ssize_t buflen);
36d43a43 282extern struct vfsmount *nfs_d_automount(struct path *path);
fca78d6d
BS
283#ifdef CONFIG_NFS_V4
284rpc_authflavor_t nfs_find_best_sec(struct nfs4_secinfo_flavors *);
285#endif
f7b422b1 286
54ceac45 287/* getroot.c */
0d5839ad
AV
288extern struct dentry *nfs_get_root(struct super_block *, struct nfs_fh *,
289 const char *);
7d4e2747 290#ifdef CONFIG_NFS_V4
0d5839ad
AV
291extern struct dentry *nfs4_get_root(struct super_block *, struct nfs_fh *,
292 const char *);
54ceac45 293
815409d2 294extern int nfs4_get_rootfh(struct nfs_server *server, struct nfs_fh *mntfh);
7d4e2747 295#endif
f7b422b1 296
493292dd 297struct nfs_pageio_descriptor;
f11c88af 298/* read.c */
dc70d7b3
AA
299extern int nfs_initiate_read(struct nfs_read_data *data, struct rpc_clnt *clnt,
300 const struct rpc_call_ops *call_ops);
f11c88af 301extern void nfs_read_prepare(struct rpc_task *task, void *calldata);
493292dd
TM
302extern int nfs_generic_pagein(struct nfs_pageio_descriptor *desc,
303 struct list_head *head);
f11c88af 304
62e4a769
TM
305extern void nfs_pageio_init_read_mds(struct nfs_pageio_descriptor *pgio,
306 struct inode *inode);
493292dd
TM
307extern void nfs_pageio_reset_read_mds(struct nfs_pageio_descriptor *pgio);
308extern void nfs_readdata_release(struct nfs_read_data *rdata);
e885de1a 309
def6ed7e 310/* write.c */
dce81290
TM
311extern int nfs_generic_flush(struct nfs_pageio_descriptor *desc,
312 struct list_head *head);
e2fecb21
TM
313extern void nfs_pageio_init_write_mds(struct nfs_pageio_descriptor *pgio,
314 struct inode *inode, int ioflags);
dce81290
TM
315extern void nfs_pageio_reset_write_mds(struct nfs_pageio_descriptor *pgio);
316extern void nfs_writedata_release(struct nfs_write_data *wdata);
e0c2b380 317extern void nfs_commit_free(struct nfs_write_data *p);
a69aef14
FI
318extern int nfs_initiate_write(struct nfs_write_data *data,
319 struct rpc_clnt *clnt,
320 const struct rpc_call_ops *call_ops,
321 int how);
def6ed7e 322extern void nfs_write_prepare(struct rpc_task *task, void *calldata);
e0c2b380
FI
323extern int nfs_initiate_commit(struct nfs_write_data *data,
324 struct rpc_clnt *clnt,
325 const struct rpc_call_ops *call_ops,
326 int how);
327extern void nfs_init_commit(struct nfs_write_data *data,
328 struct list_head *head,
329 struct pnfs_layout_segment *lseg);
330void nfs_retry_commit(struct list_head *page_list,
331 struct pnfs_layout_segment *lseg);
332void nfs_commit_clear_lock(struct nfs_inode *nfsi);
333void nfs_commitdata_release(void *data);
334void nfs_commit_release_pages(struct nfs_write_data *data);
8dd37758
TM
335void nfs_request_add_commit_list(struct nfs_page *req, struct list_head *head);
336void nfs_request_remove_commit_list(struct nfs_page *req);
e0c2b380 337
074cc1de
TM
338#ifdef CONFIG_MIGRATION
339extern int nfs_migrate_page(struct address_space *,
a6bc32b8 340 struct page *, struct page *, enum migrate_mode);
074cc1de
TM
341#else
342#define nfs_migrate_page NULL
343#endif
def6ed7e 344
cccef3b9 345/* nfs4proc.c */
d20581aa 346extern void __nfs4_read_done_cb(struct nfs_read_data *);
cbdabc7f 347extern void nfs4_reset_read(struct rpc_task *task, struct nfs_read_data *data);
45a52a02
AA
348extern int nfs4_init_client(struct nfs_client *clp,
349 const struct rpc_timeout *timeparms,
350 const char *ip_addr,
351 rpc_authflavor_t authflavour,
352 int noresvport);
a69aef14 353extern void nfs4_reset_write(struct rpc_task *task, struct nfs_write_data *data);
7c513058
BS
354extern int _nfs4_call_sync(struct rpc_clnt *clnt,
355 struct nfs_server *server,
cccef3b9
AA
356 struct rpc_message *msg,
357 struct nfs4_sequence_args *args,
358 struct nfs4_sequence_res *res,
359 int cache_reply);
7c513058
BS
360extern int _nfs4_call_sync_session(struct rpc_clnt *clnt,
361 struct nfs_server *server,
cccef3b9
AA
362 struct rpc_message *msg,
363 struct nfs4_sequence_args *args,
364 struct nfs4_sequence_res *res,
365 int cache_reply);
366
f7b422b1
DH
367/*
368 * Determine the device name as a string
369 */
b514f872 370static inline char *nfs_devname(struct dentry *dentry,
54ceac45 371 char *buffer, ssize_t buflen)
f7b422b1 372{
b514f872
AV
373 char *dummy;
374 return nfs_path(&dummy, dentry, buffer, buflen);
f7b422b1
DH
375}
376
377/*
378 * Determine the actual block size (and log2 thereof)
379 */
380static inline
381unsigned long nfs_block_bits(unsigned long bsize, unsigned char *nrbitsp)
382{
383 /* make sure blocksize is a power of two */
384 if ((bsize & (bsize - 1)) || nrbitsp) {
385 unsigned char nrbits;
386
387 for (nrbits = 31; nrbits && !(bsize & (1 << nrbits)); nrbits--)
388 ;
389 bsize = 1 << nrbits;
390 if (nrbitsp)
391 *nrbitsp = nrbits;
392 }
393
394 return bsize;
395}
396
397/*
398 * Calculate the number of 512byte blocks used.
399 */
9eaa67c6 400static inline blkcnt_t nfs_calc_block_size(u64 tsize)
f7b422b1 401{
9eaa67c6 402 blkcnt_t used = (tsize + 511) >> 9;
f7b422b1
DH
403 return (used > ULONG_MAX) ? ULONG_MAX : used;
404}
405
406/*
407 * Compute and set NFS server blocksize
408 */
409static inline
410unsigned long nfs_block_size(unsigned long bsize, unsigned char *nrbitsp)
411{
412 if (bsize < NFS_MIN_FILE_IO_SIZE)
413 bsize = NFS_DEF_FILE_IO_SIZE;
414 else if (bsize >= NFS_MAX_FILE_IO_SIZE)
415 bsize = NFS_MAX_FILE_IO_SIZE;
416
417 return nfs_block_bits(bsize, nrbitsp);
418}
419
420/*
421 * Determine the maximum file size for a superblock
422 */
423static inline
424void nfs_super_set_maxbytes(struct super_block *sb, __u64 maxfilesize)
425{
426 sb->s_maxbytes = (loff_t)maxfilesize;
427 if (sb->s_maxbytes > MAX_LFS_FILESIZE || sb->s_maxbytes <= 0)
428 sb->s_maxbytes = MAX_LFS_FILESIZE;
429}
49a70f27
TM
430
431/*
432 * Determine the number of bytes of data the page contains
433 */
434static inline
435unsigned int nfs_page_length(struct page *page)
436{
437 loff_t i_size = i_size_read(page->mapping->host);
438
439 if (i_size > 0) {
440 pgoff_t end_index = (i_size - 1) >> PAGE_CACHE_SHIFT;
441 if (page->index < end_index)
442 return PAGE_CACHE_SIZE;
443 if (page->index == end_index)
444 return ((i_size - 1) & ~PAGE_CACHE_MASK) + 1;
445 }
446 return 0;
447}
8d5658c9 448
0b26a0bf
TM
449/*
450 * Convert a umode to a dirent->d_type
451 */
452static inline
453unsigned char nfs_umode_to_dtype(umode_t mode)
454{
455 return (mode >> 12) & 15;
456}
457
8d5658c9
TM
458/*
459 * Determine the number of pages in an array of length 'len' and
460 * with a base offset of 'base'
461 */
462static inline
463unsigned int nfs_page_array_len(unsigned int base, size_t len)
464{
465 return ((unsigned long)len + (unsigned long)base +
466 PAGE_SIZE - 1) >> PAGE_SHIFT;
467}
0110ee15 468