blob: c961bc92c107d077b9d9df947ad215cb3071dbbe [file] [log] [blame]
David Howellsf7b422b2006-06-09 09:34:33 -04001/*
2 * NFS internal definitions
3 */
4
Andy Adamsoneedc0202009-04-01 09:22:41 -04005#include "nfs4_fs.h"
David Howellsf7b422b2006-06-09 09:34:33 -04006#include <linux/mount.h>
Eric Parisf9c3a382008-03-05 14:20:18 -05007#include <linux/security.h>
David Howellsf7b422b2006-06-09 09:34:33 -04008
David Howells08734042009-04-03 16:42:42 +01009#define NFS_MS_MASK (MS_RDONLY|MS_NOSUID|MS_NODEV|MS_NOEXEC|MS_SYNCHRONOUS)
10
David Howells54ceac42006-08-22 20:06:13 -040011struct nfs_string;
David Howells54ceac42006-08-22 20:06:13 -040012
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
Andy Adamsoneedc0202009-04-01 09:22:41 -040021/*
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
Alexandros Batsakisd8cb1a72009-12-05 13:29:53 -050033static 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
David Howellsf7b422b2006-06-09 09:34:33 -040042struct nfs_clone_mount {
43 const struct super_block *sb;
44 const struct dentry *dentry;
45 struct nfs_fh *fh;
46 struct nfs_fattr *fattr;
47 char *hostname;
48 char *mnt_path;
Chuck Lever6677d092007-12-10 14:59:06 -050049 struct sockaddr *addr;
50 size_t addrlen;
David Howellsf7b422b2006-06-09 09:34:33 -040051 rpc_authflavor_t authflavor;
52};
53
\"Talpey, Thomas\6b18eaa2007-09-10 13:43:29 -040054/*
Chuck Levera14017d2009-06-17 18:02:12 -070055 * Note: RFC 1813 doesn't limit the number of auth flavors that
56 * a server can return, so make something up.
57 */
58#define NFS_MAX_SECFLAVORS (12)
59
60/*
Chuck Lever4cfd74f2009-09-08 19:49:47 -040061 * Value used if the user did not specify a port value.
62 */
63#define NFS_UNSPEC_PORT (-1)
64
65/*
\"Talpey, Thomas\6b18eaa2007-09-10 13:43:29 -040066 * In-kernel mount arguments
67 */
68struct nfs_parsed_mount_data {
69 int flags;
70 int rsize, wsize;
71 int timeo, retrans;
72 int acregmin, acregmax,
73 acdirmin, acdirmax;
74 int namlen;
David Howellsb797cac2009-04-03 16:42:48 +010075 unsigned int options;
\"Talpey, Thomas\6b18eaa2007-09-10 13:43:29 -040076 unsigned int bsize;
77 unsigned int auth_flavor_len;
78 rpc_authflavor_t auth_flavors[1];
79 char *client_address;
Chuck Lever764302c2009-09-08 19:50:03 -040080 unsigned int version;
Mike Sager3fd5be92009-04-01 09:21:48 -040081 unsigned int minorversion;
David Howells08734042009-04-03 16:42:42 +010082 char *fscache_uniq;
\"Talpey, Thomas\6b18eaa2007-09-10 13:43:29 -040083
84 struct {
Chuck Lever4c568012007-12-10 14:59:28 -050085 struct sockaddr_storage address;
86 size_t addrlen;
\"Talpey, Thomas\6b18eaa2007-09-10 13:43:29 -040087 char *hostname;
Chuck Lever78fa7012008-03-14 14:10:15 -040088 u32 version;
Chuck Lever4cfd74f2009-09-08 19:49:47 -040089 int port;
Chuck Lever78fa7012008-03-14 14:10:15 -040090 unsigned short protocol;
\"Talpey, Thomas\6b18eaa2007-09-10 13:43:29 -040091 } mount_server;
92
93 struct {
Chuck Lever4c568012007-12-10 14:59:28 -050094 struct sockaddr_storage address;
95 size_t addrlen;
\"Talpey, Thomas\6b18eaa2007-09-10 13:43:29 -040096 char *hostname;
97 char *export_path;
Chuck Lever4cfd74f2009-09-08 19:49:47 -040098 int port;
Chuck Lever78fa7012008-03-14 14:10:15 -040099 unsigned short protocol;
\"Talpey, Thomas\6b18eaa2007-09-10 13:43:29 -0400100 } nfs_server;
Eric Parisf9c3a382008-03-05 14:20:18 -0500101
102 struct security_mnt_opts lsm_opts;
\"Talpey, Thomas\6b18eaa2007-09-10 13:43:29 -0400103};
104
Chuck Lever146ec942008-12-23 15:21:34 -0500105/* mount_clnt.c */
Chuck Leverc5d120f2008-12-23 15:21:35 -0500106struct nfs_mount_request {
107 struct sockaddr *sap;
108 size_t salen;
109 char *hostname;
110 char *dirpath;
111 u32 version;
112 unsigned short protocol;
113 struct nfs_fh *fh;
Chuck Lever50a737f2008-12-23 15:21:37 -0500114 int noresvport;
Chuck Lever8e02f6b2009-06-17 18:02:13 -0700115 unsigned int *auth_flav_len;
116 rpc_authflavor_t *auth_flavs;
Chuck Leverc5d120f2008-12-23 15:21:35 -0500117};
118
119extern int nfs_mount(struct nfs_mount_request *info);
Chuck Lever0b524122009-08-09 15:09:30 -0400120extern void nfs_umount(const struct nfs_mount_request *info);
Chuck Lever146ec942008-12-23 15:21:34 -0500121
David Howells24c8dbb2006-08-22 20:06:10 -0400122/* client.c */
David Howells54ceac42006-08-22 20:06:13 -0400123extern struct rpc_program nfs_program;
124
David Howells24c8dbb2006-08-22 20:06:10 -0400125extern void nfs_put_client(struct nfs_client *);
Chuck Leverff052642007-12-10 14:58:44 -0500126extern struct nfs_client *nfs_find_client(const struct sockaddr *, u32);
Trond Myklebust3fbd67a2008-01-26 01:06:40 -0500127extern struct nfs_client *nfs_find_client_next(struct nfs_client *);
\"Talpey, Thomas\2283f8d2007-09-10 13:43:56 -0400128extern struct nfs_server *nfs_create_server(
129 const struct nfs_parsed_mount_data *,
130 struct nfs_fh *);
\"Talpey, Thomas\91ea40b2007-09-10 13:44:33 -0400131extern struct nfs_server *nfs4_create_server(
132 const struct nfs_parsed_mount_data *,
133 struct nfs_fh *);
David Howells54ceac42006-08-22 20:06:13 -0400134extern struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *,
135 struct nfs_fh *);
136extern void nfs_free_server(struct nfs_server *server);
137extern struct nfs_server *nfs_clone_server(struct nfs_server *,
138 struct nfs_fh *,
139 struct nfs_fattr *);
Andy Adamson76db6d92009-04-01 09:22:38 -0400140extern void nfs_mark_client_ready(struct nfs_client *clp, int state);
Benny Halevy008f55d2009-04-01 09:22:50 -0400141extern int nfs4_check_client_ready(struct nfs_client *clp);
David Howells6aaca562006-08-22 20:06:13 -0400142#ifdef CONFIG_PROC_FS
143extern int __init nfs_fs_proc_init(void);
144extern void nfs_fs_proc_exit(void);
145#else
146static inline int nfs_fs_proc_init(void)
147{
148 return 0;
149}
150static inline void nfs_fs_proc_exit(void)
151{
152}
153#endif
David Howells24c8dbb2006-08-22 20:06:10 -0400154
David Howells7d4e2742006-08-22 20:06:07 -0400155/* nfs4namespace.c */
David Howellsf7b422b2006-06-09 09:34:33 -0400156#ifdef CONFIG_NFS_V4
157extern struct vfsmount *nfs_do_refmount(const struct vfsmount *mnt_parent, struct dentry *dentry);
158#else
159static inline
160struct vfsmount *nfs_do_refmount(const struct vfsmount *mnt_parent, struct dentry *dentry)
161{
162 return ERR_PTR(-ENOENT);
163}
164#endif
165
166/* callback_xdr.c */
167extern struct svc_version nfs4_callback_version1;
Alexandros Batsakis07bccc22009-12-05 13:19:01 -0500168extern struct svc_version nfs4_callback_version4;
David Howellsf7b422b2006-06-09 09:34:33 -0400169
170/* pagelist.c */
171extern int __init nfs_init_nfspagecache(void);
David Brownell266bee82006-06-27 12:59:15 -0700172extern void nfs_destroy_nfspagecache(void);
David Howellsf7b422b2006-06-09 09:34:33 -0400173extern int __init nfs_init_readpagecache(void);
David Brownell266bee82006-06-27 12:59:15 -0700174extern void nfs_destroy_readpagecache(void);
David Howellsf7b422b2006-06-09 09:34:33 -0400175extern int __init nfs_init_writepagecache(void);
David Brownell266bee82006-06-27 12:59:15 -0700176extern void nfs_destroy_writepagecache(void);
David Howellsf7b422b2006-06-09 09:34:33 -0400177
David Howellsf7b422b2006-06-09 09:34:33 -0400178extern int __init nfs_init_directcache(void);
David Brownell266bee82006-06-27 12:59:15 -0700179extern void nfs_destroy_directcache(void);
David Howellsf7b422b2006-06-09 09:34:33 -0400180
181/* nfs2xdr.c */
David Howells7d4e2742006-08-22 20:06:07 -0400182extern int nfs_stat_to_errno(int);
David Howellsf7b422b2006-06-09 09:34:33 -0400183extern struct rpc_procinfo nfs_procedures[];
Al Viro0dbb4c62006-10-19 23:28:49 -0700184extern __be32 * nfs_decode_dirent(__be32 *, struct nfs_entry *, int);
David Howellsf7b422b2006-06-09 09:34:33 -0400185
186/* nfs3xdr.c */
187extern struct rpc_procinfo nfs3_procedures[];
Al Viro0dbb4c62006-10-19 23:28:49 -0700188extern __be32 *nfs3_decode_dirent(__be32 *, struct nfs_entry *, int);
David Howellsf7b422b2006-06-09 09:34:33 -0400189
190/* nfs4xdr.c */
David Howells7d4e2742006-08-22 20:06:07 -0400191#ifdef CONFIG_NFS_V4
Al Viro0dbb4c62006-10-19 23:28:49 -0700192extern __be32 *nfs4_decode_dirent(__be32 *p, struct nfs_entry *entry, int plus);
David Howells7d4e2742006-08-22 20:06:07 -0400193#endif
Alexandros Batsakis2449ea22009-12-05 13:36:55 -0500194#ifdef CONFIG_NFS_V4_1
195extern const u32 nfs41_maxread_overhead;
196extern const u32 nfs41_maxwrite_overhead;
197#endif
David Howellsf7b422b2006-06-09 09:34:33 -0400198
199/* nfs4proc.c */
Andrew Mortond75d5412006-06-25 02:41:26 -0700200#ifdef CONFIG_NFS_V4
David Howellsf7b422b2006-06-09 09:34:33 -0400201extern struct rpc_procinfo nfs4_procedures[];
Andrew Mortond75d5412006-06-25 02:41:26 -0700202#endif
David Howellsf7b422b2006-06-09 09:34:33 -0400203
Trond Myklebust7fe5c392009-03-19 15:35:50 -0400204/* proc.c */
205void nfs_close_context(struct nfs_open_context *ctx, int is_sync);
206
Trond Myklebust979df722006-07-25 11:28:19 -0400207/* dir.c */
Dave Chinner7f8275d2010-07-19 14:56:17 +1000208extern int nfs_access_cache_shrinker(struct shrinker *shrink,
209 int nr_to_scan, gfp_t gfp_mask);
Trond Myklebust979df722006-07-25 11:28:19 -0400210
David Howellsf7b422b2006-06-09 09:34:33 -0400211/* inode.c */
Trond Myklebust57460062008-02-19 20:04:22 -0500212extern struct workqueue_struct *nfsiod_workqueue;
David Howellsf7b422b2006-06-09 09:34:33 -0400213extern struct inode *nfs_alloc_inode(struct super_block *sb);
214extern void nfs_destroy_inode(struct inode *);
Christoph Hellwiga9185b42010-03-05 09:21:37 +0100215extern int nfs_write_inode(struct inode *, struct writeback_control *);
Al Virob57922d2010-06-07 14:34:48 -0400216extern void nfs_evict_inode(struct inode *);
David Howellsf7b422b2006-06-09 09:34:33 -0400217#ifdef CONFIG_NFS_V4
Al Virob57922d2010-06-07 14:34:48 -0400218extern void nfs4_evict_inode(struct inode *);
David Howellsf7b422b2006-06-09 09:34:33 -0400219#endif
Trond Myklebustf41f7412008-06-11 17:39:04 -0400220void nfs_zap_acl_cache(struct inode *inode);
Trond Myklebust72cb77f2009-03-11 14:10:30 -0400221extern int nfs_wait_bit_killable(void *word);
David Howellsf7b422b2006-06-09 09:34:33 -0400222
223/* super.c */
David Howells54ceac42006-08-22 20:06:13 -0400224extern struct file_system_type nfs_xdev_fs_type;
David Howellsf7b422b2006-06-09 09:34:33 -0400225#ifdef CONFIG_NFS_V4
David Howells54ceac42006-08-22 20:06:13 -0400226extern struct file_system_type nfs4_xdev_fs_type;
227extern struct file_system_type nfs4_referral_fs_type;
David Howellsf7b422b2006-06-09 09:34:33 -0400228#endif
Dominik Hackl4ebd9ab2006-07-02 17:29:26 +0200229
David Howellsf7b422b2006-06-09 09:34:33 -0400230extern struct rpc_stat nfs_rpcstat;
Dominik Hackl4ebd9ab2006-07-02 17:29:26 +0200231
David Howellsf7b422b2006-06-09 09:34:33 -0400232extern int __init register_nfs_fs(void);
233extern void __exit unregister_nfs_fs(void);
Trond Myklebust1daef0a2008-07-27 18:19:01 -0400234extern void nfs_sb_active(struct super_block *sb);
235extern void nfs_sb_deactive(struct super_block *sb);
David Howellsf7b422b2006-06-09 09:34:33 -0400236
237/* namespace.c */
David Howells54ceac42006-08-22 20:06:13 -0400238extern char *nfs_path(const char *base,
239 const struct dentry *droot,
240 const struct dentry *dentry,
David Howellsf7b422b2006-06-09 09:34:33 -0400241 char *buffer, ssize_t buflen);
242
David Howells54ceac42006-08-22 20:06:13 -0400243/* getroot.c */
244extern struct dentry *nfs_get_root(struct super_block *, struct nfs_fh *);
David Howells7d4e2742006-08-22 20:06:07 -0400245#ifdef CONFIG_NFS_V4
David Howells54ceac42006-08-22 20:06:13 -0400246extern struct dentry *nfs4_get_root(struct super_block *, struct nfs_fh *);
247
Trond Myklebust815409d2010-04-16 16:22:46 -0400248extern int nfs4_get_rootfh(struct nfs_server *server, struct nfs_fh *mntfh);
David Howells7d4e2742006-08-22 20:06:07 -0400249#endif
David Howellsf7b422b2006-06-09 09:34:33 -0400250
Andy Adamsonf11c88a2009-04-01 09:22:25 -0400251/* read.c */
252extern void nfs_read_prepare(struct rpc_task *task, void *calldata);
253
Andy Adamsondef6ed72009-04-01 09:22:26 -0400254/* write.c */
255extern void nfs_write_prepare(struct rpc_task *task, void *calldata);
Trond Myklebust074cc1d2009-08-10 08:54:13 -0400256#ifdef CONFIG_MIGRATION
257extern int nfs_migrate_page(struct address_space *,
258 struct page *, struct page *);
259#else
260#define nfs_migrate_page NULL
261#endif
Andy Adamsondef6ed72009-04-01 09:22:26 -0400262
Andy Adamsoncccef3b2009-04-01 09:22:03 -0400263/* nfs4proc.c */
264extern int _nfs4_call_sync(struct nfs_server *server,
265 struct rpc_message *msg,
266 struct nfs4_sequence_args *args,
267 struct nfs4_sequence_res *res,
268 int cache_reply);
269extern int _nfs4_call_sync_session(struct nfs_server *server,
270 struct rpc_message *msg,
271 struct nfs4_sequence_args *args,
272 struct nfs4_sequence_res *res,
273 int cache_reply);
274
Andy Adamson557134a2009-04-01 09:21:53 -0400275/*
David Howellsf7b422b2006-06-09 09:34:33 -0400276 * Determine the device name as a string
277 */
278static inline char *nfs_devname(const struct vfsmount *mnt_parent,
David Howells54ceac42006-08-22 20:06:13 -0400279 const struct dentry *dentry,
280 char *buffer, ssize_t buflen)
David Howellsf7b422b2006-06-09 09:34:33 -0400281{
David Howells54ceac42006-08-22 20:06:13 -0400282 return nfs_path(mnt_parent->mnt_devname, mnt_parent->mnt_root,
283 dentry, buffer, buflen);
David Howellsf7b422b2006-06-09 09:34:33 -0400284}
285
286/*
287 * Determine the actual block size (and log2 thereof)
288 */
289static inline
290unsigned long nfs_block_bits(unsigned long bsize, unsigned char *nrbitsp)
291{
292 /* make sure blocksize is a power of two */
293 if ((bsize & (bsize - 1)) || nrbitsp) {
294 unsigned char nrbits;
295
296 for (nrbits = 31; nrbits && !(bsize & (1 << nrbits)); nrbits--)
297 ;
298 bsize = 1 << nrbits;
299 if (nrbitsp)
300 *nrbitsp = nrbits;
301 }
302
303 return bsize;
304}
305
306/*
307 * Calculate the number of 512byte blocks used.
308 */
Chuck Lever9eaa67c2007-07-01 12:12:19 -0400309static inline blkcnt_t nfs_calc_block_size(u64 tsize)
David Howellsf7b422b2006-06-09 09:34:33 -0400310{
Chuck Lever9eaa67c2007-07-01 12:12:19 -0400311 blkcnt_t used = (tsize + 511) >> 9;
David Howellsf7b422b2006-06-09 09:34:33 -0400312 return (used > ULONG_MAX) ? ULONG_MAX : used;
313}
314
315/*
316 * Compute and set NFS server blocksize
317 */
318static inline
319unsigned long nfs_block_size(unsigned long bsize, unsigned char *nrbitsp)
320{
321 if (bsize < NFS_MIN_FILE_IO_SIZE)
322 bsize = NFS_DEF_FILE_IO_SIZE;
323 else if (bsize >= NFS_MAX_FILE_IO_SIZE)
324 bsize = NFS_MAX_FILE_IO_SIZE;
325
326 return nfs_block_bits(bsize, nrbitsp);
327}
328
329/*
330 * Determine the maximum file size for a superblock
331 */
332static inline
333void nfs_super_set_maxbytes(struct super_block *sb, __u64 maxfilesize)
334{
335 sb->s_maxbytes = (loff_t)maxfilesize;
336 if (sb->s_maxbytes > MAX_LFS_FILESIZE || sb->s_maxbytes <= 0)
337 sb->s_maxbytes = MAX_LFS_FILESIZE;
338}
Trond Myklebust49a70f22006-12-05 00:35:38 -0500339
340/*
341 * Determine the number of bytes of data the page contains
342 */
343static inline
344unsigned int nfs_page_length(struct page *page)
345{
346 loff_t i_size = i_size_read(page->mapping->host);
347
348 if (i_size > 0) {
349 pgoff_t end_index = (i_size - 1) >> PAGE_CACHE_SHIFT;
350 if (page->index < end_index)
351 return PAGE_CACHE_SIZE;
352 if (page->index == end_index)
353 return ((i_size - 1) & ~PAGE_CACHE_MASK) + 1;
354 }
355 return 0;
356}
Trond Myklebust8d5658c2007-04-10 09:26:35 -0400357
358/*
359 * Determine the number of pages in an array of length 'len' and
360 * with a base offset of 'base'
361 */
362static inline
363unsigned int nfs_page_array_len(unsigned int base, size_t len)
364{
365 return ((unsigned long)len + (unsigned long)base +
366 PAGE_SIZE - 1) >> PAGE_SHIFT;
367}
Trond Myklebust0110ee12009-12-07 09:00:24 -0500368
369/*
370 * Helper for restarting RPC calls in the possible presence of NFSv4.1
371 * sessions.
372 */
Trond Myklebustd05dd4e2010-07-31 14:29:07 -0400373static inline int nfs_restart_rpc(struct rpc_task *task, const struct nfs_client *clp)
Trond Myklebust0110ee12009-12-07 09:00:24 -0500374{
375 if (nfs4_has_session(clp))
Trond Myklebustd05dd4e2010-07-31 14:29:07 -0400376 return rpc_restart_call_prepare(task);
377 return rpc_restart_call(task);
Trond Myklebust0110ee12009-12-07 09:00:24 -0500378}