NFSv4: Clean up the nfs.callback_tcpport option
[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
f7b422b1
DH
33struct 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;
6677d095
CL
40 struct sockaddr *addr;
41 size_t addrlen;
f7b422b1
DH
42 rpc_authflavor_t authflavor;
43};
44
a14017db
CL
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
6b18eaa0
TT
51/*
52 * In-kernel mount arguments
53 */
54struct nfs_parsed_mount_data {
55 int flags;
56 int rsize, wsize;
57 int timeo, retrans;
58 int acregmin, acregmax,
59 acdirmin, acdirmax;
60 int namlen;
b797cac7 61 unsigned int options;
6b18eaa0
TT
62 unsigned int bsize;
63 unsigned int auth_flavor_len;
64 rpc_authflavor_t auth_flavors[1];
65 char *client_address;
3fd5be9e 66 unsigned int minorversion;
08734048 67 char *fscache_uniq;
6b18eaa0
TT
68
69 struct {
4c568017
CL
70 struct sockaddr_storage address;
71 size_t addrlen;
6b18eaa0 72 char *hostname;
78fa701f 73 u32 version;
6b18eaa0 74 unsigned short port;
78fa701f 75 unsigned short protocol;
6b18eaa0
TT
76 } mount_server;
77
78 struct {
4c568017
CL
79 struct sockaddr_storage address;
80 size_t addrlen;
6b18eaa0
TT
81 char *hostname;
82 char *export_path;
f22d6d79 83 unsigned short port;
78fa701f 84 unsigned short protocol;
6b18eaa0 85 } nfs_server;
f9c3a380
EP
86
87 struct security_mnt_opts lsm_opts;
6b18eaa0
TT
88};
89
146ec944 90/* mount_clnt.c */
c5d120f8
CL
91struct nfs_mount_request {
92 struct sockaddr *sap;
93 size_t salen;
94 char *hostname;
95 char *dirpath;
96 u32 version;
97 unsigned short protocol;
98 struct nfs_fh *fh;
50a737f8 99 int noresvport;
8e02f6b9
CL
100 unsigned int *auth_flav_len;
101 rpc_authflavor_t *auth_flavs;
c5d120f8
CL
102};
103
104extern int nfs_mount(struct nfs_mount_request *info);
146ec944 105
24c8dbbb 106/* client.c */
54ceac45
DH
107extern struct rpc_program nfs_program;
108
24c8dbbb 109extern void nfs_put_client(struct nfs_client *);
ff052645 110extern struct nfs_client *nfs_find_client(const struct sockaddr *, u32);
3fbd67ad 111extern struct nfs_client *nfs_find_client_next(struct nfs_client *);
2283f8d6
TT
112extern struct nfs_server *nfs_create_server(
113 const struct nfs_parsed_mount_data *,
114 struct nfs_fh *);
91ea40b9
TT
115extern struct nfs_server *nfs4_create_server(
116 const struct nfs_parsed_mount_data *,
117 struct nfs_fh *);
54ceac45
DH
118extern struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *,
119 struct nfs_fh *);
120extern void nfs_free_server(struct nfs_server *server);
121extern struct nfs_server *nfs_clone_server(struct nfs_server *,
122 struct nfs_fh *,
123 struct nfs_fattr *);
76db6d95 124extern void nfs_mark_client_ready(struct nfs_client *clp, int state);
008f55d0 125extern int nfs4_check_client_ready(struct nfs_client *clp);
6aaca566
DH
126#ifdef CONFIG_PROC_FS
127extern int __init nfs_fs_proc_init(void);
128extern void nfs_fs_proc_exit(void);
129#else
130static inline int nfs_fs_proc_init(void)
131{
132 return 0;
133}
134static inline void nfs_fs_proc_exit(void)
135{
136}
137#endif
24c8dbbb 138
7d4e2747 139/* nfs4namespace.c */
f7b422b1
DH
140#ifdef CONFIG_NFS_V4
141extern struct vfsmount *nfs_do_refmount(const struct vfsmount *mnt_parent, struct dentry *dentry);
142#else
143static inline
144struct vfsmount *nfs_do_refmount(const struct vfsmount *mnt_parent, struct dentry *dentry)
145{
146 return ERR_PTR(-ENOENT);
147}
148#endif
149
150/* callback_xdr.c */
151extern struct svc_version nfs4_callback_version1;
152
153/* pagelist.c */
154extern int __init nfs_init_nfspagecache(void);
266bee88 155extern void nfs_destroy_nfspagecache(void);
f7b422b1 156extern int __init nfs_init_readpagecache(void);
266bee88 157extern void nfs_destroy_readpagecache(void);
f7b422b1 158extern int __init nfs_init_writepagecache(void);
266bee88 159extern void nfs_destroy_writepagecache(void);
f7b422b1 160
f7b422b1 161extern int __init nfs_init_directcache(void);
266bee88 162extern void nfs_destroy_directcache(void);
f7b422b1
DH
163
164/* nfs2xdr.c */
7d4e2747 165extern int nfs_stat_to_errno(int);
f7b422b1 166extern struct rpc_procinfo nfs_procedures[];
0dbb4c67 167extern __be32 * nfs_decode_dirent(__be32 *, struct nfs_entry *, int);
f7b422b1
DH
168
169/* nfs3xdr.c */
170extern struct rpc_procinfo nfs3_procedures[];
0dbb4c67 171extern __be32 *nfs3_decode_dirent(__be32 *, struct nfs_entry *, int);
f7b422b1 172
eedc020e
AA
173/* nfs4proc.c */
174static inline void nfs4_restart_rpc(struct rpc_task *task,
175 const struct nfs_client *clp)
176{
177#ifdef CONFIG_NFS_V4_1
178 if (nfs4_has_session(clp) &&
179 test_bit(NFS4CLNT_SESSION_SETUP, &clp->cl_state)) {
180 rpc_restart_call_prepare(task);
181 return;
182 }
183#endif /* CONFIG_NFS_V4_1 */
184 rpc_restart_call(task);
185}
186
f7b422b1 187/* nfs4xdr.c */
7d4e2747 188#ifdef CONFIG_NFS_V4
0dbb4c67 189extern __be32 *nfs4_decode_dirent(__be32 *p, struct nfs_entry *entry, int plus);
7d4e2747 190#endif
f7b422b1
DH
191
192/* nfs4proc.c */
d75d5414 193#ifdef CONFIG_NFS_V4
f7b422b1 194extern struct rpc_procinfo nfs4_procedures[];
d75d5414 195#endif
f7b422b1 196
7fe5c398
TM
197/* proc.c */
198void nfs_close_context(struct nfs_open_context *ctx, int is_sync);
199
979df72e
TM
200/* dir.c */
201extern int nfs_access_cache_shrinker(int nr_to_scan, gfp_t gfp_mask);
202
f7b422b1 203/* inode.c */
5746006f 204extern struct workqueue_struct *nfsiod_workqueue;
f7b422b1
DH
205extern struct inode *nfs_alloc_inode(struct super_block *sb);
206extern void nfs_destroy_inode(struct inode *);
207extern int nfs_write_inode(struct inode *,int);
208extern void nfs_clear_inode(struct inode *);
209#ifdef CONFIG_NFS_V4
210extern void nfs4_clear_inode(struct inode *);
211#endif
f41f7418 212void nfs_zap_acl_cache(struct inode *inode);
72cb77f4 213extern int nfs_wait_bit_killable(void *word);
f7b422b1
DH
214
215/* super.c */
ea31a443 216void nfs_parse_ip_address(char *, size_t, struct sockaddr *, size_t *);
54ceac45 217extern struct file_system_type nfs_xdev_fs_type;
f7b422b1 218#ifdef CONFIG_NFS_V4
54ceac45
DH
219extern struct file_system_type nfs4_xdev_fs_type;
220extern struct file_system_type nfs4_referral_fs_type;
f7b422b1 221#endif
4ebd9ab3 222
f7b422b1 223extern struct rpc_stat nfs_rpcstat;
4ebd9ab3 224
f7b422b1
DH
225extern int __init register_nfs_fs(void);
226extern void __exit unregister_nfs_fs(void);
1daef0a8
TM
227extern void nfs_sb_active(struct super_block *sb);
228extern void nfs_sb_deactive(struct super_block *sb);
f7b422b1
DH
229
230/* namespace.c */
54ceac45
DH
231extern char *nfs_path(const char *base,
232 const struct dentry *droot,
233 const struct dentry *dentry,
f7b422b1
DH
234 char *buffer, ssize_t buflen);
235
54ceac45
DH
236/* getroot.c */
237extern struct dentry *nfs_get_root(struct super_block *, struct nfs_fh *);
7d4e2747 238#ifdef CONFIG_NFS_V4
54ceac45
DH
239extern struct dentry *nfs4_get_root(struct super_block *, struct nfs_fh *);
240
241extern int nfs4_path_walk(struct nfs_server *server,
242 struct nfs_fh *mntfh,
243 const char *path);
7d4e2747 244#endif
f7b422b1 245
f11c88af
AA
246/* read.c */
247extern void nfs_read_prepare(struct rpc_task *task, void *calldata);
248
def6ed7e
AA
249/* write.c */
250extern void nfs_write_prepare(struct rpc_task *task, void *calldata);
251
cccef3b9
AA
252/* nfs4proc.c */
253extern 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);
258extern 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
13615871
AA
264#ifdef CONFIG_NFS_V4_1
265extern void nfs41_sequence_free_slot(const struct nfs_client *,
266 struct nfs4_sequence_res *res);
267#endif /* CONFIG_NFS_V4_1 */
268
269static 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
f7b422b1
DH
278/*
279 * Determine the device name as a string
280 */
281static inline char *nfs_devname(const struct vfsmount *mnt_parent,
54ceac45
DH
282 const struct dentry *dentry,
283 char *buffer, ssize_t buflen)
f7b422b1 284{
54ceac45
DH
285 return nfs_path(mnt_parent->mnt_devname, mnt_parent->mnt_root,
286 dentry, buffer, buflen);
f7b422b1
DH
287}
288
289/*
290 * Determine the actual block size (and log2 thereof)
291 */
292static inline
293unsigned 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 */
9eaa67c6 312static inline blkcnt_t nfs_calc_block_size(u64 tsize)
f7b422b1 313{
9eaa67c6 314 blkcnt_t used = (tsize + 511) >> 9;
f7b422b1
DH
315 return (used > ULONG_MAX) ? ULONG_MAX : used;
316}
317
318/*
319 * Compute and set NFS server blocksize
320 */
321static inline
322unsigned 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 */
335static inline
336void 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}
49a70f27
TM
342
343/*
344 * Determine the number of bytes of data the page contains
345 */
346static inline
347unsigned 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}
8d5658c9
TM
360
361/*
362 * Determine the number of pages in an array of length 'len' and
363 * with a base offset of 'base'
364 */
365static inline
366unsigned 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}
371
ea31a443 372#define IPV6_SCOPE_DELIMITER '%'
f0c92925
BF
373
374/*
375 * Set the port number in an address. Be agnostic about the address
376 * family.
377 */
378static inline void nfs_set_port(struct sockaddr *sap, unsigned short port)
379{
456018d7
BF
380 struct sockaddr_in *ap = (struct sockaddr_in *)sap;
381 struct sockaddr_in6 *ap6 = (struct sockaddr_in6 *)sap;
382
f0c92925 383 switch (sap->sa_family) {
456018d7
BF
384 case AF_INET:
385 ap->sin_port = htons(port);
386 break;
387 case AF_INET6:
388 ap6->sin6_port = htons(port);
389 break;
f0c92925
BF
390 }
391}