blob: e6356b750b777ae6224b8821fc253b1b4da30de6 [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/*
Bryan Schumaker56e4ebf2010-10-20 15:44:37 -040066 * Maximum number of pages that readdir can use for creating
67 * a vmapped array of pages.
68 */
69#define NFS_MAX_READDIR_PAGES 8
70
71/*
\"Talpey, Thomas\6b18eaa2007-09-10 13:43:29 -040072 * In-kernel mount arguments
73 */
74struct nfs_parsed_mount_data {
75 int flags;
76 int rsize, wsize;
77 int timeo, retrans;
78 int acregmin, acregmax,
79 acdirmin, acdirmax;
80 int namlen;
David Howellsb797cac2009-04-03 16:42:48 +010081 unsigned int options;
\"Talpey, Thomas\6b18eaa2007-09-10 13:43:29 -040082 unsigned int bsize;
83 unsigned int auth_flavor_len;
84 rpc_authflavor_t auth_flavors[1];
85 char *client_address;
Chuck Lever764302c2009-09-08 19:50:03 -040086 unsigned int version;
Mike Sager3fd5be92009-04-01 09:21:48 -040087 unsigned int minorversion;
David Howells08734042009-04-03 16:42:42 +010088 char *fscache_uniq;
\"Talpey, Thomas\6b18eaa2007-09-10 13:43:29 -040089
90 struct {
Chuck Lever4c568012007-12-10 14:59:28 -050091 struct sockaddr_storage address;
92 size_t addrlen;
\"Talpey, Thomas\6b18eaa2007-09-10 13:43:29 -040093 char *hostname;
Chuck Lever78fa7012008-03-14 14:10:15 -040094 u32 version;
Chuck Lever4cfd74f2009-09-08 19:49:47 -040095 int port;
Chuck Lever78fa7012008-03-14 14:10:15 -040096 unsigned short protocol;
\"Talpey, Thomas\6b18eaa2007-09-10 13:43:29 -040097 } mount_server;
98
99 struct {
Chuck Lever4c568012007-12-10 14:59:28 -0500100 struct sockaddr_storage address;
101 size_t addrlen;
\"Talpey, Thomas\6b18eaa2007-09-10 13:43:29 -0400102 char *hostname;
103 char *export_path;
Chuck Lever4cfd74f2009-09-08 19:49:47 -0400104 int port;
Chuck Lever78fa7012008-03-14 14:10:15 -0400105 unsigned short protocol;
\"Talpey, Thomas\6b18eaa2007-09-10 13:43:29 -0400106 } nfs_server;
Eric Parisf9c3a382008-03-05 14:20:18 -0500107
108 struct security_mnt_opts lsm_opts;
\"Talpey, Thomas\6b18eaa2007-09-10 13:43:29 -0400109};
110
Chuck Lever146ec942008-12-23 15:21:34 -0500111/* mount_clnt.c */
Chuck Leverc5d120f2008-12-23 15:21:35 -0500112struct nfs_mount_request {
113 struct sockaddr *sap;
114 size_t salen;
115 char *hostname;
116 char *dirpath;
117 u32 version;
118 unsigned short protocol;
119 struct nfs_fh *fh;
Chuck Lever50a737f2008-12-23 15:21:37 -0500120 int noresvport;
Chuck Lever8e02f6b2009-06-17 18:02:13 -0700121 unsigned int *auth_flav_len;
122 rpc_authflavor_t *auth_flavs;
Chuck Leverc5d120f2008-12-23 15:21:35 -0500123};
124
125extern int nfs_mount(struct nfs_mount_request *info);
Chuck Lever0b524122009-08-09 15:09:30 -0400126extern void nfs_umount(const struct nfs_mount_request *info);
Chuck Lever146ec942008-12-23 15:21:34 -0500127
David Howells24c8dbb2006-08-22 20:06:10 -0400128/* client.c */
David Howells54ceac42006-08-22 20:06:13 -0400129extern struct rpc_program nfs_program;
130
David Howells24c8dbb2006-08-22 20:06:10 -0400131extern void nfs_put_client(struct nfs_client *);
Chuck Leverff052642007-12-10 14:58:44 -0500132extern struct nfs_client *nfs_find_client(const struct sockaddr *, u32);
Trond Myklebust3fbd67a2008-01-26 01:06:40 -0500133extern struct nfs_client *nfs_find_client_next(struct nfs_client *);
\"Talpey, Thomas\2283f8d2007-09-10 13:43:56 -0400134extern struct nfs_server *nfs_create_server(
135 const struct nfs_parsed_mount_data *,
136 struct nfs_fh *);
\"Talpey, Thomas\91ea40b2007-09-10 13:44:33 -0400137extern struct nfs_server *nfs4_create_server(
138 const struct nfs_parsed_mount_data *,
139 struct nfs_fh *);
David Howells54ceac42006-08-22 20:06:13 -0400140extern struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *,
141 struct nfs_fh *);
142extern void nfs_free_server(struct nfs_server *server);
143extern struct nfs_server *nfs_clone_server(struct nfs_server *,
144 struct nfs_fh *,
145 struct nfs_fattr *);
Andy Adamson76db6d92009-04-01 09:22:38 -0400146extern void nfs_mark_client_ready(struct nfs_client *clp, int state);
Benny Halevy008f55d2009-04-01 09:22:50 -0400147extern int nfs4_check_client_ready(struct nfs_client *clp);
David Howells6aaca562006-08-22 20:06:13 -0400148#ifdef CONFIG_PROC_FS
149extern int __init nfs_fs_proc_init(void);
150extern void nfs_fs_proc_exit(void);
151#else
152static inline int nfs_fs_proc_init(void)
153{
154 return 0;
155}
156static inline void nfs_fs_proc_exit(void)
157{
158}
159#endif
David Howells24c8dbb2006-08-22 20:06:10 -0400160
David Howells7d4e2742006-08-22 20:06:07 -0400161/* nfs4namespace.c */
David Howellsf7b422b2006-06-09 09:34:33 -0400162#ifdef CONFIG_NFS_V4
163extern struct vfsmount *nfs_do_refmount(const struct vfsmount *mnt_parent, struct dentry *dentry);
164#else
165static inline
166struct vfsmount *nfs_do_refmount(const struct vfsmount *mnt_parent, struct dentry *dentry)
167{
168 return ERR_PTR(-ENOENT);
169}
170#endif
171
172/* callback_xdr.c */
173extern struct svc_version nfs4_callback_version1;
Alexandros Batsakis07bccc22009-12-05 13:19:01 -0500174extern struct svc_version nfs4_callback_version4;
David Howellsf7b422b2006-06-09 09:34:33 -0400175
176/* pagelist.c */
177extern int __init nfs_init_nfspagecache(void);
David Brownell266bee82006-06-27 12:59:15 -0700178extern void nfs_destroy_nfspagecache(void);
David Howellsf7b422b2006-06-09 09:34:33 -0400179extern int __init nfs_init_readpagecache(void);
David Brownell266bee82006-06-27 12:59:15 -0700180extern void nfs_destroy_readpagecache(void);
David Howellsf7b422b2006-06-09 09:34:33 -0400181extern int __init nfs_init_writepagecache(void);
David Brownell266bee82006-06-27 12:59:15 -0700182extern void nfs_destroy_writepagecache(void);
David Howellsf7b422b2006-06-09 09:34:33 -0400183
David Howellsf7b422b2006-06-09 09:34:33 -0400184extern int __init nfs_init_directcache(void);
David Brownell266bee82006-06-27 12:59:15 -0700185extern void nfs_destroy_directcache(void);
David Howellsf7b422b2006-06-09 09:34:33 -0400186
187/* nfs2xdr.c */
David Howells7d4e2742006-08-22 20:06:07 -0400188extern int nfs_stat_to_errno(int);
David Howellsf7b422b2006-06-09 09:34:33 -0400189extern struct rpc_procinfo nfs_procedures[];
Bryan Schumaker82f2e542010-10-21 16:33:18 -0400190extern __be32 *nfs_decode_dirent(struct xdr_stream *, struct nfs_entry *, struct nfs_server *, int);
David Howellsf7b422b2006-06-09 09:34:33 -0400191
192/* nfs3xdr.c */
193extern struct rpc_procinfo nfs3_procedures[];
Bryan Schumaker82f2e542010-10-21 16:33:18 -0400194extern __be32 *nfs3_decode_dirent(struct xdr_stream *, struct nfs_entry *, struct nfs_server *, int);
David Howellsf7b422b2006-06-09 09:34:33 -0400195
196/* nfs4xdr.c */
David Howells7d4e2742006-08-22 20:06:07 -0400197#ifdef CONFIG_NFS_V4
Bryan Schumaker82f2e542010-10-21 16:33:18 -0400198extern __be32 *nfs4_decode_dirent(struct xdr_stream *, struct nfs_entry *, struct nfs_server *, int);
David Howells7d4e2742006-08-22 20:06:07 -0400199#endif
Alexandros Batsakis2449ea22009-12-05 13:36:55 -0500200#ifdef CONFIG_NFS_V4_1
201extern const u32 nfs41_maxread_overhead;
202extern const u32 nfs41_maxwrite_overhead;
203#endif
David Howellsf7b422b2006-06-09 09:34:33 -0400204
205/* nfs4proc.c */
Andrew Mortond75d5412006-06-25 02:41:26 -0700206#ifdef CONFIG_NFS_V4
David Howellsf7b422b2006-06-09 09:34:33 -0400207extern struct rpc_procinfo nfs4_procedures[];
Andrew Mortond75d5412006-06-25 02:41:26 -0700208#endif
David Howellsf7b422b2006-06-09 09:34:33 -0400209
Trond Myklebust7fe5c392009-03-19 15:35:50 -0400210/* proc.c */
211void nfs_close_context(struct nfs_open_context *ctx, int is_sync);
212
Trond Myklebust979df722006-07-25 11:28:19 -0400213/* dir.c */
Dave Chinner7f8275d2010-07-19 14:56:17 +1000214extern int nfs_access_cache_shrinker(struct shrinker *shrink,
215 int nr_to_scan, gfp_t gfp_mask);
Trond Myklebust979df722006-07-25 11:28:19 -0400216
David Howellsf7b422b2006-06-09 09:34:33 -0400217/* inode.c */
Trond Myklebust57460062008-02-19 20:04:22 -0500218extern struct workqueue_struct *nfsiod_workqueue;
David Howellsf7b422b2006-06-09 09:34:33 -0400219extern struct inode *nfs_alloc_inode(struct super_block *sb);
220extern void nfs_destroy_inode(struct inode *);
Christoph Hellwiga9185b42010-03-05 09:21:37 +0100221extern int nfs_write_inode(struct inode *, struct writeback_control *);
Al Virob57922d2010-06-07 14:34:48 -0400222extern void nfs_evict_inode(struct inode *);
David Howellsf7b422b2006-06-09 09:34:33 -0400223#ifdef CONFIG_NFS_V4
Al Virob57922d2010-06-07 14:34:48 -0400224extern void nfs4_evict_inode(struct inode *);
David Howellsf7b422b2006-06-09 09:34:33 -0400225#endif
Trond Myklebustf41f7412008-06-11 17:39:04 -0400226void nfs_zap_acl_cache(struct inode *inode);
Trond Myklebust72cb77f2009-03-11 14:10:30 -0400227extern int nfs_wait_bit_killable(void *word);
David Howellsf7b422b2006-06-09 09:34:33 -0400228
229/* super.c */
David Howells54ceac42006-08-22 20:06:13 -0400230extern struct file_system_type nfs_xdev_fs_type;
David Howellsf7b422b2006-06-09 09:34:33 -0400231#ifdef CONFIG_NFS_V4
David Howells54ceac42006-08-22 20:06:13 -0400232extern struct file_system_type nfs4_xdev_fs_type;
233extern struct file_system_type nfs4_referral_fs_type;
David Howellsf7b422b2006-06-09 09:34:33 -0400234#endif
Dominik Hackl4ebd9ab2006-07-02 17:29:26 +0200235
David Howellsf7b422b2006-06-09 09:34:33 -0400236extern struct rpc_stat nfs_rpcstat;
Dominik Hackl4ebd9ab2006-07-02 17:29:26 +0200237
David Howellsf7b422b2006-06-09 09:34:33 -0400238extern int __init register_nfs_fs(void);
239extern void __exit unregister_nfs_fs(void);
Trond Myklebust1daef0a2008-07-27 18:19:01 -0400240extern void nfs_sb_active(struct super_block *sb);
241extern void nfs_sb_deactive(struct super_block *sb);
David Howellsf7b422b2006-06-09 09:34:33 -0400242
243/* namespace.c */
David Howells54ceac42006-08-22 20:06:13 -0400244extern char *nfs_path(const char *base,
245 const struct dentry *droot,
246 const struct dentry *dentry,
David Howellsf7b422b2006-06-09 09:34:33 -0400247 char *buffer, ssize_t buflen);
248
David Howells54ceac42006-08-22 20:06:13 -0400249/* getroot.c */
250extern struct dentry *nfs_get_root(struct super_block *, struct nfs_fh *);
David Howells7d4e2742006-08-22 20:06:07 -0400251#ifdef CONFIG_NFS_V4
David Howells54ceac42006-08-22 20:06:13 -0400252extern struct dentry *nfs4_get_root(struct super_block *, struct nfs_fh *);
253
Trond Myklebust815409d2010-04-16 16:22:46 -0400254extern int nfs4_get_rootfh(struct nfs_server *server, struct nfs_fh *mntfh);
David Howells7d4e2742006-08-22 20:06:07 -0400255#endif
David Howellsf7b422b2006-06-09 09:34:33 -0400256
Andy Adamsonf11c88a2009-04-01 09:22:25 -0400257/* read.c */
258extern void nfs_read_prepare(struct rpc_task *task, void *calldata);
259
Andy Adamsondef6ed72009-04-01 09:22:26 -0400260/* write.c */
261extern void nfs_write_prepare(struct rpc_task *task, void *calldata);
Trond Myklebust074cc1d2009-08-10 08:54:13 -0400262#ifdef CONFIG_MIGRATION
263extern int nfs_migrate_page(struct address_space *,
264 struct page *, struct page *);
265#else
266#define nfs_migrate_page NULL
267#endif
Andy Adamsondef6ed72009-04-01 09:22:26 -0400268
Andy Adamsoncccef3b2009-04-01 09:22:03 -0400269/* nfs4proc.c */
270extern int _nfs4_call_sync(struct nfs_server *server,
271 struct rpc_message *msg,
272 struct nfs4_sequence_args *args,
273 struct nfs4_sequence_res *res,
274 int cache_reply);
275extern int _nfs4_call_sync_session(struct nfs_server *server,
276 struct rpc_message *msg,
277 struct nfs4_sequence_args *args,
278 struct nfs4_sequence_res *res,
279 int cache_reply);
280
Andy Adamson557134a2009-04-01 09:21:53 -0400281/*
David Howellsf7b422b2006-06-09 09:34:33 -0400282 * Determine the device name as a string
283 */
284static inline char *nfs_devname(const struct vfsmount *mnt_parent,
David Howells54ceac42006-08-22 20:06:13 -0400285 const struct dentry *dentry,
286 char *buffer, ssize_t buflen)
David Howellsf7b422b2006-06-09 09:34:33 -0400287{
David Howells54ceac42006-08-22 20:06:13 -0400288 return nfs_path(mnt_parent->mnt_devname, mnt_parent->mnt_root,
289 dentry, buffer, buflen);
David Howellsf7b422b2006-06-09 09:34:33 -0400290}
291
292/*
293 * Determine the actual block size (and log2 thereof)
294 */
295static inline
296unsigned long nfs_block_bits(unsigned long bsize, unsigned char *nrbitsp)
297{
298 /* make sure blocksize is a power of two */
299 if ((bsize & (bsize - 1)) || nrbitsp) {
300 unsigned char nrbits;
301
302 for (nrbits = 31; nrbits && !(bsize & (1 << nrbits)); nrbits--)
303 ;
304 bsize = 1 << nrbits;
305 if (nrbitsp)
306 *nrbitsp = nrbits;
307 }
308
309 return bsize;
310}
311
312/*
313 * Calculate the number of 512byte blocks used.
314 */
Chuck Lever9eaa67c2007-07-01 12:12:19 -0400315static inline blkcnt_t nfs_calc_block_size(u64 tsize)
David Howellsf7b422b2006-06-09 09:34:33 -0400316{
Chuck Lever9eaa67c2007-07-01 12:12:19 -0400317 blkcnt_t used = (tsize + 511) >> 9;
David Howellsf7b422b2006-06-09 09:34:33 -0400318 return (used > ULONG_MAX) ? ULONG_MAX : used;
319}
320
321/*
322 * Compute and set NFS server blocksize
323 */
324static inline
325unsigned long nfs_block_size(unsigned long bsize, unsigned char *nrbitsp)
326{
327 if (bsize < NFS_MIN_FILE_IO_SIZE)
328 bsize = NFS_DEF_FILE_IO_SIZE;
329 else if (bsize >= NFS_MAX_FILE_IO_SIZE)
330 bsize = NFS_MAX_FILE_IO_SIZE;
331
332 return nfs_block_bits(bsize, nrbitsp);
333}
334
335/*
336 * Determine the maximum file size for a superblock
337 */
338static inline
339void nfs_super_set_maxbytes(struct super_block *sb, __u64 maxfilesize)
340{
341 sb->s_maxbytes = (loff_t)maxfilesize;
342 if (sb->s_maxbytes > MAX_LFS_FILESIZE || sb->s_maxbytes <= 0)
343 sb->s_maxbytes = MAX_LFS_FILESIZE;
344}
Trond Myklebust49a70f22006-12-05 00:35:38 -0500345
346/*
347 * Determine the number of bytes of data the page contains
348 */
349static inline
350unsigned int nfs_page_length(struct page *page)
351{
352 loff_t i_size = i_size_read(page->mapping->host);
353
354 if (i_size > 0) {
355 pgoff_t end_index = (i_size - 1) >> PAGE_CACHE_SHIFT;
356 if (page->index < end_index)
357 return PAGE_CACHE_SIZE;
358 if (page->index == end_index)
359 return ((i_size - 1) & ~PAGE_CACHE_MASK) + 1;
360 }
361 return 0;
362}
Trond Myklebust8d5658c2007-04-10 09:26:35 -0400363
364/*
Trond Myklebust0b26a0b2010-11-20 14:26:44 -0500365 * Convert a umode to a dirent->d_type
366 */
367static inline
368unsigned char nfs_umode_to_dtype(umode_t mode)
369{
370 return (mode >> 12) & 15;
371}
372
373/*
Trond Myklebust8d5658c2007-04-10 09:26:35 -0400374 * Determine the number of pages in an array of length 'len' and
375 * with a base offset of 'base'
376 */
377static inline
378unsigned int nfs_page_array_len(unsigned int base, size_t len)
379{
380 return ((unsigned long)len + (unsigned long)base +
381 PAGE_SIZE - 1) >> PAGE_SHIFT;
382}
Trond Myklebust0110ee12009-12-07 09:00:24 -0500383
384/*
385 * Helper for restarting RPC calls in the possible presence of NFSv4.1
386 * sessions.
387 */
Trond Myklebustd05dd4e2010-07-31 14:29:07 -0400388static inline int nfs_restart_rpc(struct rpc_task *task, const struct nfs_client *clp)
Trond Myklebust0110ee12009-12-07 09:00:24 -0500389{
390 if (nfs4_has_session(clp))
Trond Myklebustd05dd4e2010-07-31 14:29:07 -0400391 return rpc_restart_call_prepare(task);
392 return rpc_restart_call(task);
Trond Myklebust0110ee12009-12-07 09:00:24 -0500393}