blob: 69ec9cb3a867fa751e30bceeaed1b86d15adc7d4 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * linux/include/linux/nfs_fs.h
3 *
4 * Copyright (C) 1992 Rick Sladkey
5 *
6 * OS-specific nfs filesystem definitions and declarations
7 */
8
9#ifndef _LINUX_NFS_FS_H
10#define _LINUX_NFS_FS_H
11
Jeff Garzike18fa702006-09-24 11:13:19 -040012#include <linux/magic.h>
13
David Woodhouse7f1cbe52006-09-12 20:36:02 -070014/* Default timeout values */
Trond Myklebust259875e2008-07-02 14:43:47 -040015#define NFS_DEF_UDP_TIMEO (11)
16#define NFS_DEF_UDP_RETRANS (3)
17#define NFS_DEF_TCP_TIMEO (600)
18#define NFS_DEF_TCP_RETRANS (2)
19
David Woodhouse7f1cbe52006-09-12 20:36:02 -070020#define NFS_MAX_UDP_TIMEOUT (60*HZ)
21#define NFS_MAX_TCP_TIMEOUT (600*HZ)
22
Chuck Lever0e0cab72008-06-26 17:47:12 -040023#define NFS_DEF_ACREGMIN (3)
24#define NFS_DEF_ACREGMAX (60)
25#define NFS_DEF_ACDIRMIN (30)
26#define NFS_DEF_ACDIRMAX (60)
27
David Woodhouse7f1cbe52006-09-12 20:36:02 -070028/*
David Woodhouse7f1cbe52006-09-12 20:36:02 -070029 * When flushing a cluster of dirty pages, there can be different
30 * strategies:
31 */
32#define FLUSH_SYNC 1 /* file being synced, or contention */
33#define FLUSH_STABLE 4 /* commit to stable storage */
34#define FLUSH_LOWPRI 8 /* low priority background flush */
35#define FLUSH_HIGHPRI 16 /* high priority memory reclaim flush */
Trond Myklebustb31268a2011-03-21 17:02:00 -040036#define FLUSH_COND_STABLE 32 /* conditional stable write - only stable
37 * if everything fits in one RPC */
David Woodhouse7f1cbe52006-09-12 20:36:02 -070038
39#ifdef __KERNEL__
40
Trond Myklebuste27d3592012-03-18 14:07:42 -040041/*
42 * Enable dprintk() debugging support for nfs client.
43 */
44#ifdef CONFIG_NFS_DEBUG
45# define NFS_DEBUG
46#endif
47
Linus Torvalds1da177e2005-04-16 15:20:36 -070048#include <linux/in.h>
49#include <linux/mm.h>
50#include <linux/pagemap.h>
Trond Myklebust1c3c07e2006-07-25 11:28:18 -040051#include <linux/rbtree.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070052#include <linux/rwsem.h>
53#include <linux/wait.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070054
Linus Torvalds1da177e2005-04-16 15:20:36 -070055#include <linux/sunrpc/debug.h>
56#include <linux/sunrpc/auth.h>
57#include <linux/sunrpc/clnt.h>
58
59#include <linux/nfs.h>
60#include <linux/nfs2.h>
61#include <linux/nfs3.h>
62#include <linux/nfs4.h>
63#include <linux/nfs_xdr.h>
Trond Myklebust8b4bdcf2006-06-09 09:34:19 -040064#include <linux/nfs_fs_sb.h>
65
Linus Torvalds1da177e2005-04-16 15:20:36 -070066#include <linux/mempool.h>
67
68/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070069 * These are the default flags for swap requests
70 */
71#define NFS_RPC_SWAPFLAGS (RPC_TASK_SWAPPER|RPC_TASK_ROOTCREDS)
72
Linus Torvalds1da177e2005-04-16 15:20:36 -070073/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070074 * NFSv3/v4 Access mode cache entry
75 */
76struct nfs_access_entry {
Trond Myklebust1c3c07e2006-07-25 11:28:18 -040077 struct rb_node rb_node;
Trond Myklebustcfcea3e2006-07-25 11:28:18 -040078 struct list_head lru;
Linus Torvalds1da177e2005-04-16 15:20:36 -070079 unsigned long jiffies;
80 struct rpc_cred * cred;
81 int mask;
82};
83
Trond Myklebustf11ac8d2010-06-25 16:35:53 -040084struct nfs_lock_context {
85 atomic_t count;
86 struct list_head list;
87 struct nfs_open_context *open_context;
88 fl_owner_t lockowner;
89 pid_t pid;
90};
91
Linus Torvalds1da177e2005-04-16 15:20:36 -070092struct nfs4_state;
93struct nfs_open_context {
Trond Myklebustf11ac8d2010-06-25 16:35:53 -040094 struct nfs_lock_context lock_context;
Al Viro3d4ff432011-06-22 18:40:12 -040095 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -070096 struct rpc_cred *cred;
97 struct nfs4_state *state;
Trond Myklebustdc0b0272008-12-23 15:21:56 -050098 fmode_t mode;
Trond Myklebust7b159fc2007-07-25 14:09:54 -040099
100 unsigned long flags;
101#define NFS_CONTEXT_ERROR_WRITE (0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102 int error;
103
104 struct list_head list;
Bryan Schumaker480c2002011-03-23 14:48:29 -0400105};
Olivier Galibert00a92642005-06-22 17:16:29 +0000106
Bryan Schumaker480c2002011-03-23 14:48:29 -0400107struct nfs_open_dir_context {
108 struct rpc_cred *cred;
Trond Myklebust0c030802011-07-30 12:45:35 -0400109 unsigned long attr_gencount;
Olivier Galibert00a92642005-06-22 17:16:29 +0000110 __u64 dir_cookie;
Bryan Schumaker8ef2ce32011-03-23 15:04:31 -0400111 __u64 dup_cookie;
Trond Myklebust0c030802011-07-30 12:45:35 -0400112 signed char duped;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113};
114
115/*
116 * NFSv4 delegation
117 */
118struct nfs_delegation;
119
Andreas Gruenbacher5c6a9f72005-06-22 17:16:27 +0000120struct posix_acl;
121
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122/*
123 * nfs fs inode data in memory
124 */
125struct nfs_inode {
126 /*
127 * The 64bit 'inode number'
128 */
129 __u64 fileid;
130
131 /*
132 * NFS file handle
133 */
134 struct nfs_fh fh;
135
136 /*
137 * Various flags
138 */
Chuck Lever412d5822005-08-18 11:24:11 -0700139 unsigned long flags; /* atomic bit ops */
140 unsigned long cache_validity; /* bit mask */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141
142 /*
Goldwyn Rodrigues24bd68f2006-03-20 13:44:11 -0500143 * read_cache_jiffies is when we started read-caching this inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144 * attrtimeo is for how long the cached information is assumed
145 * to be valid. A successful attribute revalidation doubles
146 * attrtimeo (up to acregmax/acdirmax), a failure resets it to
147 * acregmin/acdirmin.
148 *
149 * We need to revalidate the cached attrs for this inode if
150 *
Peter Staubach64672d52008-12-23 15:21:56 -0500151 * jiffies - read_cache_jiffies >= attrtimeo
152 *
153 * Please note the comparison is greater than or equal
154 * so that zero timeout values can be specified.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156 unsigned long read_cache_jiffies;
157 unsigned long attrtimeo;
158 unsigned long attrtimeo_timestamp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159
Trond Myklebust4704f0e2008-10-14 19:16:07 -0400160 unsigned long attr_gencount;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161 /* "Generation counter" for the attribute cache. This is
162 * bumped whenever we update the metadata on the
163 * server.
164 */
165 unsigned long cache_change_attribute;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166
Trond Myklebust1c3c07e2006-07-25 11:28:18 -0400167 struct rb_root access_cache;
Trond Myklebustcfcea3e2006-07-25 11:28:18 -0400168 struct list_head access_cache_entry_lru;
169 struct list_head access_cache_inode_lru;
Andreas Gruenbacher5c6a9f72005-06-22 17:16:27 +0000170#ifdef CONFIG_NFS_V3_ACL
171 struct posix_acl *acl_access;
172 struct posix_acl *acl_default;
173#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174
175 /*
176 * This is the cookie verifier used for NFSv3 readdir
177 * operations
178 */
Al Virobc4785c2006-10-19 23:28:51 -0700179 __be32 cookieverf[2];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180
Trond Myklebustfb8a1f12009-03-11 14:10:29 -0400181 unsigned long npages;
Trond Myklebustff778d02010-02-19 16:53:39 -0800182 unsigned long ncommit;
Fred Isamand6d6dc72012-03-08 17:29:35 -0500183 struct list_head commit_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184
185 /* Open contexts for shared mmap writes */
186 struct list_head open_files;
187
Trond Myklebust565277f2007-10-15 18:17:53 -0400188 /* Number of in-flight sillydelete RPC calls */
189 atomic_t silly_count;
190 /* List of deferred sillydelete requests */
191 struct hlist_head silly_list;
192 wait_queue_head_t waitqueue;
193
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194#ifdef CONFIG_NFS_V4
J. Bruce Fieldse50a1c22005-06-22 17:16:23 +0000195 struct nfs4_cached_acl *nfs4_acl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196 /* NFSv4 state */
197 struct list_head open_states;
Arnd Bergmann5b222162010-03-03 10:20:10 +0100198 struct nfs_delegation __rcu *delegation;
Trond Myklebustbd7bf9d2008-12-23 15:21:53 -0500199 fmode_t delegation_state;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200 struct rw_semaphore rwsem;
Benny Halevye5e94012010-10-20 00:18:01 -0400201
202 /* pNFS layout information */
203 struct pnfs_layout_hdr *layout;
Fred Isamane0c2b382011-03-23 13:27:53 +0000204 atomic_t commits_outstanding;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205#endif /* CONFIG_NFS_V4*/
David Howellsef79c092009-04-03 16:42:43 +0100206#ifdef CONFIG_NFS_FSCACHE
207 struct fscache_cookie *fscache;
208#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209 struct inode vfs_inode;
210};
211
212/*
Chuck Lever55296802005-08-18 11:24:09 -0700213 * Cache validity bit flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214 */
Chuck Lever55296802005-08-18 11:24:09 -0700215#define NFS_INO_INVALID_ATTR 0x0001 /* cached attrs are invalid */
216#define NFS_INO_INVALID_DATA 0x0002 /* cached data is invalid */
217#define NFS_INO_INVALID_ATIME 0x0004 /* cached atime is invalid */
218#define NFS_INO_INVALID_ACCESS 0x0008 /* cached access cred invalid */
219#define NFS_INO_INVALID_ACL 0x0010 /* cached acls are invalid */
220#define NFS_INO_REVAL_PAGECACHE 0x0020 /* must revalidate pagecache */
Trond Myklebust412c77c2007-07-03 16:10:55 -0400221#define NFS_INO_REVAL_FORCED 0x0040 /* force revalidation ignoring a delegation */
Chuck Lever55296802005-08-18 11:24:09 -0700222
223/*
Chuck Lever412d5822005-08-18 11:24:11 -0700224 * Bit offsets in flags field
Chuck Lever55296802005-08-18 11:24:09 -0700225 */
Trond Myklebust691beb12008-10-05 14:48:22 -0400226#define NFS_INO_ADVISE_RDPLUS (0) /* advise readdirplus */
227#define NFS_INO_STALE (1) /* possible stale inode */
228#define NFS_INO_ACL_LRU_SET (2) /* Inode is on the LRU list */
Trond Myklebust72cb77f2009-03-11 14:10:30 -0400229#define NFS_INO_FLUSHING (4) /* inode is flushing out data */
David Howellsef79c092009-04-03 16:42:43 +0100230#define NFS_INO_FSCACHE (5) /* inode can be cached by FS-Cache */
231#define NFS_INO_FSCACHE_LOCK (6) /* FS-Cache cookie management lock */
Trond Myklebust71d0a612010-04-22 15:35:57 -0400232#define NFS_INO_COMMIT (7) /* inode is committing unstable writes */
Fred Isamana861a1e2011-03-23 13:27:51 +0000233#define NFS_INO_PNFS_COMMIT (8) /* use pnfs code for commit */
Andy Adamson863a3c62011-03-23 13:27:54 +0000234#define NFS_INO_LAYOUTCOMMIT (9) /* layoutcommit required */
Peng Tao92407e72011-10-23 20:21:17 -0700235#define NFS_INO_LAYOUTCOMMITTING (10) /* layoutcommit inflight */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236
Benny Halevy99fadcd2008-01-23 08:59:08 +0200237static inline struct nfs_inode *NFS_I(const struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238{
239 return container_of(inode, struct nfs_inode, vfs_inode);
240}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241
Benny Halevy99fadcd2008-01-23 08:59:08 +0200242static inline struct nfs_server *NFS_SB(const struct super_block *s)
243{
244 return (struct nfs_server *)(s->s_fs_info);
245}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246
Benny Halevy99fadcd2008-01-23 08:59:08 +0200247static inline struct nfs_fh *NFS_FH(const struct inode *inode)
248{
249 return &NFS_I(inode)->fh;
250}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251
Benny Halevy99fadcd2008-01-23 08:59:08 +0200252static inline struct nfs_server *NFS_SERVER(const struct inode *inode)
253{
254 return NFS_SB(inode->i_sb);
255}
256
257static inline struct rpc_clnt *NFS_CLIENT(const struct inode *inode)
258{
259 return NFS_SERVER(inode)->client;
260}
261
262static inline const struct nfs_rpc_ops *NFS_PROTO(const struct inode *inode)
263{
264 return NFS_SERVER(inode)->nfs_client->rpc_ops;
265}
266
267static inline __be32 *NFS_COOKIEVERF(const struct inode *inode)
268{
269 return NFS_I(inode)->cookieverf;
270}
271
272static inline unsigned NFS_MINATTRTIMEO(const struct inode *inode)
273{
274 struct nfs_server *nfss = NFS_SERVER(inode);
275 return S_ISDIR(inode->i_mode) ? nfss->acdirmin : nfss->acregmin;
276}
277
278static inline unsigned NFS_MAXATTRTIMEO(const struct inode *inode)
279{
280 struct nfs_server *nfss = NFS_SERVER(inode);
281 return S_ISDIR(inode->i_mode) ? nfss->acdirmax : nfss->acregmax;
282}
283
284static inline int NFS_STALE(const struct inode *inode)
285{
286 return test_bit(NFS_INO_STALE, &NFS_I(inode)->flags);
287}
288
David Howellsef79c092009-04-03 16:42:43 +0100289static inline int NFS_FSCACHE(const struct inode *inode)
290{
291 return test_bit(NFS_INO_FSCACHE, &NFS_I(inode)->flags);
292}
293
Benny Halevy99fadcd2008-01-23 08:59:08 +0200294static inline __u64 NFS_FILEID(const struct inode *inode)
295{
296 return NFS_I(inode)->fileid;
297}
298
299static inline void set_nfs_fileid(struct inode *inode, __u64 fileid)
300{
301 NFS_I(inode)->fileid = fileid;
302}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303
Trond Myklebustdecf4912005-10-27 22:12:39 -0400304static inline void nfs_mark_for_revalidate(struct inode *inode)
305{
Trond Myklebust38478b22006-05-25 01:40:57 -0400306 struct nfs_inode *nfsi = NFS_I(inode);
307
Trond Myklebustdecf4912005-10-27 22:12:39 -0400308 spin_lock(&inode->i_lock);
Trond Myklebust38478b22006-05-25 01:40:57 -0400309 nfsi->cache_validity |= NFS_INO_INVALID_ATTR|NFS_INO_INVALID_ACCESS;
Trond Myklebustf3821112007-10-01 10:00:23 -0400310 if (S_ISDIR(inode->i_mode))
Trond Myklebust38478b22006-05-25 01:40:57 -0400311 nfsi->cache_validity |= NFS_INO_REVAL_PAGECACHE|NFS_INO_INVALID_DATA;
Trond Myklebustdecf4912005-10-27 22:12:39 -0400312 spin_unlock(&inode->i_lock);
313}
314
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315static inline int nfs_server_capable(struct inode *inode, int cap)
316{
317 return NFS_SERVER(inode)->caps & cap;
318}
319
320static inline int NFS_USE_READDIRPLUS(struct inode *inode)
321{
Benny Halevy3a10c302008-01-23 08:58:59 +0200322 return test_bit(NFS_INO_ADVISE_RDPLUS, &NFS_I(inode)->flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323}
324
Trond Myklebustd75340c2007-10-01 21:42:01 -0400325static inline void nfs_set_verifier(struct dentry * dentry, unsigned long verf)
326{
327 dentry->d_time = verf;
328}
329
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330/**
331 * nfs_save_change_attribute - Returns the inode attribute change cookie
Trond Myklebust8edb0182007-09-29 17:14:03 -0400332 * @dir - pointer to parent directory inode
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333 * The "change attribute" is updated every time we finish an operation
334 * that will result in a metadata change on the server.
335 */
Trond Myklebust8edb0182007-09-29 17:14:03 -0400336static inline unsigned long nfs_save_change_attribute(struct inode *dir)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337{
Trond Myklebust8edb0182007-09-29 17:14:03 -0400338 return NFS_I(dir)->cache_change_attribute;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339}
340
341/**
Trond Myklebust4b841732007-09-29 17:15:01 -0400342 * nfs_verify_change_attribute - Detects NFS remote directory changes
343 * @dir - pointer to parent directory inode
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344 * @chattr - previously saved change attribute
Trond Myklebust4b841732007-09-29 17:15:01 -0400345 * Return "false" if the verifiers doesn't match the change attribute.
346 * This would usually indicate that the directory contents have changed on
347 * the server, and that any dentries need revalidating.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348 */
Trond Myklebust4b841732007-09-29 17:15:01 -0400349static inline int nfs_verify_change_attribute(struct inode *dir, unsigned long chattr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350{
Trond Myklebust4b841732007-09-29 17:15:01 -0400351 return chattr == NFS_I(dir)->cache_change_attribute;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352}
353
354/*
355 * linux/fs/nfs/inode.c
356 */
Trond Myklebust29884df2005-12-13 16:13:54 -0500357extern int nfs_sync_mapping(struct address_space *mapping);
Trond Myklebustcd9ae2b2006-10-19 23:28:40 -0700358extern void nfs_zap_mapping(struct inode *inode, struct address_space *mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359extern void nfs_zap_caches(struct inode *);
Trond Myklebustc4812992007-09-28 17:11:45 -0400360extern void nfs_invalidate_atime(struct inode *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361extern struct inode *nfs_fhget(struct super_block *, struct nfs_fh *,
362 struct nfs_fattr *);
363extern int nfs_refresh_inode(struct inode *, struct nfs_fattr *);
Trond Myklebustdecf4912005-10-27 22:12:39 -0400364extern int nfs_post_op_update_inode(struct inode *inode, struct nfs_fattr *fattr);
Trond Myklebust70ca8852007-09-30 15:21:24 -0400365extern int nfs_post_op_update_inode_force_wcc(struct inode *inode, struct nfs_fattr *fattr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366extern int nfs_getattr(struct vfsmount *, struct dentry *, struct kstat *);
Al Viro10556cb2011-06-20 19:28:19 -0400367extern int nfs_permission(struct inode *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368extern int nfs_open(struct inode *, struct file *);
369extern int nfs_release(struct inode *, struct file *);
370extern int nfs_attribute_timeout(struct inode *inode);
371extern int nfs_revalidate_inode(struct nfs_server *server, struct inode *inode);
372extern int __nfs_revalidate_inode(struct nfs_server *, struct inode *);
Trond Myklebust44b11872006-05-25 01:40:59 -0400373extern int nfs_revalidate_mapping(struct inode *inode, struct address_space *mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374extern int nfs_setattr(struct dentry *, struct iattr *);
Trond Myklebust65e43082005-08-16 11:49:44 -0400375extern void nfs_setattr_update_inode(struct inode *inode, struct iattr *attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376extern struct nfs_open_context *get_nfs_open_context(struct nfs_open_context *ctx);
377extern void put_nfs_open_context(struct nfs_open_context *ctx);
Trond Myklebustdc0b0272008-12-23 15:21:56 -0500378extern struct nfs_open_context *nfs_find_open_context(struct inode *inode, struct rpc_cred *cred, fmode_t mode);
Al Viro5ede7b12011-10-23 18:49:54 -0400379extern struct nfs_open_context *alloc_nfs_open_context(struct dentry *dentry, fmode_t f_mode);
Trond Myklebustcd9a1c02010-09-17 10:56:50 -0400380extern void nfs_file_set_open_context(struct file *filp, struct nfs_open_context *ctx);
Trond Myklebustf11ac8d2010-06-25 16:35:53 -0400381extern struct nfs_lock_context *nfs_get_lock_context(struct nfs_open_context *ctx);
382extern void nfs_put_lock_context(struct nfs_lock_context *l_ctx);
Trond Myklebustf43bf0b2007-10-09 12:01:04 -0400383extern u64 nfs_compat_user_ino64(u64 fileid);
Trond Myklebust4704f0e2008-10-14 19:16:07 -0400384extern void nfs_fattr_init(struct nfs_fattr *fattr);
Chuck Lever56463e52010-09-17 10:54:37 -0400385extern unsigned long nfs_inc_attr_generation_counter(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386
Trond Myklebust2d36bfde2010-04-16 16:22:45 -0400387extern struct nfs_fattr *nfs_alloc_fattr(void);
388
389static inline void nfs_free_fattr(const struct nfs_fattr *fattr)
390{
391 kfree(fattr);
392}
393
394extern struct nfs_fh *nfs_alloc_fhandle(void);
395
396static inline void nfs_free_fhandle(const struct nfs_fh *fh)
397{
398 kfree(fh);
399}
400
Trond Myklebuste27d3592012-03-18 14:07:42 -0400401#ifdef NFS_DEBUG
Weston Andros Adamsond8e05392012-03-06 20:46:43 -0500402extern u32 _nfs_display_fhandle_hash(const struct nfs_fh *fh);
403static inline u32 nfs_display_fhandle_hash(const struct nfs_fh *fh)
404{
405 return _nfs_display_fhandle_hash(fh);
406}
Chuck Lever20d27e92012-03-01 17:01:31 -0500407extern void _nfs_display_fhandle(const struct nfs_fh *fh, const char *caption);
408#define nfs_display_fhandle(fh, caption) \
409 do { \
410 if (unlikely(nfs_debug & NFSDBG_FACILITY)) \
411 _nfs_display_fhandle(fh, caption); \
412 } while (0)
413#else
Weston Andros Adamsond8e05392012-03-06 20:46:43 -0500414static inline u32 nfs_display_fhandle_hash(const struct nfs_fh *fh)
415{
Stephen Rothwell9304a812012-03-20 19:26:42 +1100416 return 0;
Weston Andros Adamsond8e05392012-03-06 20:46:43 -0500417}
Chuck Lever20d27e92012-03-01 17:01:31 -0500418static inline void nfs_display_fhandle(const struct nfs_fh *fh,
419 const char *caption)
420{
421}
422#endif
423
Chuck Lever56463e52010-09-17 10:54:37 -0400424/*
425 * linux/fs/nfs/nfsroot.c
426 */
427extern int nfs_root_data(char **root_device, char **root_data); /*__init*/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428/* linux/net/ipv4/ipconfig.c: trims ip addr off front of name, too. */
Al Viro5a874db2006-11-08 00:19:38 -0800429extern __be32 root_nfs_parse_addr(char *name); /*__init*/
Trond Myklebust0e574af2005-10-27 22:12:38 -0400430
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431/*
432 * linux/fs/nfs/file.c
433 */
Arjan van de Venc5ef1c42007-02-12 00:55:40 -0800434extern const struct inode_operations nfs_file_inode_operations;
Andreas Gruenbacherb7fa0552005-06-22 17:16:27 +0000435#ifdef CONFIG_NFS_V3
Arjan van de Venc5ef1c42007-02-12 00:55:40 -0800436extern const struct inode_operations nfs3_file_inode_operations;
Andreas Gruenbacherb7fa0552005-06-22 17:16:27 +0000437#endif /* CONFIG_NFS_V3 */
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -0800438extern const struct file_operations nfs_file_operations;
Jeff Layton1788ea62011-11-04 13:31:21 -0400439#ifdef CONFIG_NFS_V4
440extern const struct file_operations nfs4_file_operations;
441#endif /* CONFIG_NFS_V4 */
Christoph Hellwigf5e54d62006-06-28 04:26:44 -0700442extern const struct address_space_operations nfs_file_aops;
Trond Myklebust11de3b12010-12-01 14:17:06 -0500443extern const struct address_space_operations nfs_dir_aops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444
Trond Myklebustc03025d2007-08-10 17:44:28 -0400445static inline struct nfs_open_context *nfs_file_open_context(struct file *filp)
446{
447 return filp->private_data;
448}
449
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450static inline struct rpc_cred *nfs_file_cred(struct file *file)
451{
Neil Brown504e5182008-10-16 14:15:16 +1100452 if (file != NULL) {
453 struct nfs_open_context *ctx =
454 nfs_file_open_context(file);
455 if (ctx)
456 return ctx->cred;
457 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458 return NULL;
459}
460
461/*
Andreas Gruenbacherb7fa0552005-06-22 17:16:27 +0000462 * linux/fs/nfs/xattr.c
463 */
464#ifdef CONFIG_NFS_V3_ACL
465extern ssize_t nfs3_listxattr(struct dentry *, char *, size_t);
466extern ssize_t nfs3_getxattr(struct dentry *, const char *, void *, size_t);
467extern int nfs3_setxattr(struct dentry *, const char *,
468 const void *, size_t, int);
469extern int nfs3_removexattr (struct dentry *, const char *name);
470#else
471# define nfs3_listxattr NULL
472# define nfs3_getxattr NULL
473# define nfs3_setxattr NULL
474# define nfs3_removexattr NULL
475#endif
476
477/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478 * linux/fs/nfs/direct.c
479 */
480extern ssize_t nfs_direct_IO(int, struct kiocb *, const struct iovec *, loff_t,
481 unsigned long);
Badari Pulavarty027445c2006-09-30 23:28:46 -0700482extern ssize_t nfs_file_direct_read(struct kiocb *iocb,
483 const struct iovec *iov, unsigned long nr_segs,
484 loff_t pos);
485extern ssize_t nfs_file_direct_write(struct kiocb *iocb,
486 const struct iovec *iov, unsigned long nr_segs,
487 loff_t pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488
489/*
490 * linux/fs/nfs/dir.c
491 */
Arjan van de Venc5ef1c42007-02-12 00:55:40 -0800492extern const struct inode_operations nfs_dir_inode_operations;
Andreas Gruenbacherb7fa0552005-06-22 17:16:27 +0000493#ifdef CONFIG_NFS_V3
Arjan van de Venc5ef1c42007-02-12 00:55:40 -0800494extern const struct inode_operations nfs3_dir_inode_operations;
Andreas Gruenbacherb7fa0552005-06-22 17:16:27 +0000495#endif /* CONFIG_NFS_V3 */
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -0800496extern const struct file_operations nfs_dir_operations;
Al Virof786aa92009-02-20 05:51:22 +0000497extern const struct dentry_operations nfs_dentry_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498
Trond Myklebustbfc69a42007-10-15 18:18:29 -0400499extern void nfs_force_lookup_revalidate(struct inode *dir);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500extern int nfs_instantiate(struct dentry *dentry, struct nfs_fh *fh, struct nfs_fattr *fattr);
Trond Myklebustaf22f942007-08-10 17:45:10 -0400501extern int nfs_may_open(struct inode *inode, struct rpc_cred *cred, int openflags);
502extern void nfs_access_zap_cache(struct inode *inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503
504/*
505 * linux/fs/nfs/symlink.c
506 */
Arjan van de Venc5ef1c42007-02-12 00:55:40 -0800507extern const struct inode_operations nfs_symlink_inode_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508
509/*
Trond Myklebusta72b4422006-01-03 09:55:41 +0100510 * linux/fs/nfs/sysctl.c
511 */
512#ifdef CONFIG_SYSCTL
513extern int nfs_register_sysctl(void);
514extern void nfs_unregister_sysctl(void);
515#else
Stephen Rothwell7fd105e2006-02-20 18:28:08 -0800516#define nfs_register_sysctl() 0
Trond Myklebusta72b4422006-01-03 09:55:41 +0100517#define nfs_unregister_sysctl() do { } while(0)
518#endif
519
520/*
Trond Myklebust55a97592006-06-09 09:34:19 -0400521 * linux/fs/nfs/namespace.c
522 */
Arjan van de Venc5ef1c42007-02-12 00:55:40 -0800523extern const struct inode_operations nfs_mountpoint_inode_operations;
524extern const struct inode_operations nfs_referral_inode_operations;
Trond Myklebust51d8fa62006-06-09 09:34:20 -0400525extern int nfs_mountpoint_expiry_timeout;
526extern void nfs_release_automount_timer(void);
Trond Myklebust55a97592006-06-09 09:34:19 -0400527
528/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529 * linux/fs/nfs/unlink.c
530 */
Trond Myklebuste4eff1a2007-07-14 15:39:58 -0400531extern void nfs_complete_unlink(struct dentry *dentry, struct inode *);
Trond Myklebust565277f2007-10-15 18:17:53 -0400532extern void nfs_block_sillyrename(struct dentry *dentry);
533extern void nfs_unblock_sillyrename(struct dentry *dentry);
Jeff Layton779c5172010-09-17 17:31:30 -0400534extern int nfs_sillyrename(struct inode *dir, struct dentry *dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535
536/*
537 * linux/fs/nfs/write.c
538 */
Peter Zijlstra89a09142007-03-16 13:38:26 -0800539extern int nfs_congestion_kb;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540extern int nfs_writepage(struct page *page, struct writeback_control *wbc);
541extern int nfs_writepages(struct address_space *, struct writeback_control *);
542extern int nfs_flush_incompatible(struct file *file, struct page *page);
543extern int nfs_updatepage(struct file *, struct page *, unsigned int, unsigned int);
Fred Isaman13602892011-02-11 15:42:38 +0000544extern void nfs_writeback_done(struct rpc_task *, struct nfs_write_data *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545
546/*
547 * Try to write back everything synchronously (but check the
548 * return value!)
549 */
Trond Myklebust1c759502006-10-09 16:18:38 -0400550extern int nfs_wb_all(struct inode *inode);
551extern int nfs_wb_page(struct inode *inode, struct page* page);
Trond Myklebust1b3b4a12007-08-28 10:29:36 -0400552extern int nfs_wb_page_cancel(struct inode *inode, struct page* page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553#if defined(CONFIG_NFS_V3) || defined(CONFIG_NFS_V4)
Trond Myklebustb608b282010-07-30 15:31:54 -0400554extern int nfs_commit_inode(struct inode *, int);
Trond Myklebustc9d8f892008-04-15 16:56:39 -0400555extern struct nfs_write_data *nfs_commitdata_alloc(void);
Trond Myklebust8aca67f2006-11-13 16:23:44 -0500556extern void nfs_commit_free(struct nfs_write_data *wdata);
Trond Myklebust77a63f32010-08-01 13:40:40 -0400557#else
558static inline int
559nfs_commit_inode(struct inode *inode, int how)
560{
561 return 0;
562}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563#endif
564
565static inline int
566nfs_have_writebacks(struct inode *inode)
567{
568 return NFS_I(inode)->npages != 0;
569}
570
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571/*
Adrian Bunke4e20512006-08-03 15:07:47 -0400572 * Allocate nfs_write_data structures
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573 */
Trond Myklebust8d5658c2007-04-10 09:26:35 -0400574extern struct nfs_write_data *nfs_writedata_alloc(unsigned int npages);
Trond Myklebust1ae88b22009-08-12 09:12:30 -0400575extern void nfs_writedata_free(struct nfs_write_data *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577/*
578 * linux/fs/nfs/read.c
579 */
580extern int nfs_readpage(struct file *, struct page *);
581extern int nfs_readpages(struct file *, struct address_space *,
582 struct list_head *, unsigned);
Trond Myklebustec06c092006-03-20 13:44:27 -0500583extern int nfs_readpage_result(struct rpc_task *, struct nfs_read_data *);
David Howellsf42b2932009-04-03 16:42:44 +0100584extern int nfs_readpage_async(struct nfs_open_context *, struct inode *,
585 struct page *);
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100586
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587/*
Adrian Bunke4e20512006-08-03 15:07:47 -0400588 * Allocate nfs_read_data structures
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589 */
Trond Myklebust8d5658c2007-04-10 09:26:35 -0400590extern struct nfs_read_data *nfs_readdata_alloc(unsigned int npages);
Trond Myklebust1ae88b22009-08-12 09:12:30 -0400591extern void nfs_readdata_free(struct nfs_read_data *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593/*
Andreas Gruenbacherb7fa0552005-06-22 17:16:27 +0000594 * linux/fs/nfs3proc.c
595 */
596#ifdef CONFIG_NFS_V3_ACL
597extern struct posix_acl *nfs3_proc_getacl(struct inode *inode, int type);
598extern int nfs3_proc_setacl(struct inode *inode, int type,
599 struct posix_acl *acl);
Andreas Gruenbacher055ffbe2005-06-22 17:16:27 +0000600extern int nfs3_proc_set_default_acl(struct inode *dir, struct inode *inode,
Al Virod3fb6122011-07-23 18:37:50 -0400601 umode_t mode);
Andreas Gruenbacher5c6a9f72005-06-22 17:16:27 +0000602extern void nfs3_forget_cached_acls(struct inode *inode);
Andreas Gruenbacher055ffbe2005-06-22 17:16:27 +0000603#else
604static inline int nfs3_proc_set_default_acl(struct inode *dir,
605 struct inode *inode,
Al Virod3fb6122011-07-23 18:37:50 -0400606 umode_t mode)
Andreas Gruenbacher055ffbe2005-06-22 17:16:27 +0000607{
608 return 0;
609}
Andreas Gruenbacher5c6a9f72005-06-22 17:16:27 +0000610
611static inline void nfs3_forget_cached_acls(struct inode *inode)
612{
613}
Andreas Gruenbacherb7fa0552005-06-22 17:16:27 +0000614#endif /* CONFIG_NFS_V3_ACL */
615
616/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617 * inline functions
618 */
619
Chuck Lever433c9232007-07-01 12:12:14 -0400620static inline loff_t nfs_size_to_loff_t(__u64 size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621{
Chuck Lever433c9232007-07-01 12:12:14 -0400622 if (size > (__u64) OFFSET_MAX - 1)
623 return OFFSET_MAX - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624 return (loff_t) size;
625}
626
627static inline ino_t
628nfs_fileid_to_ino_t(u64 fileid)
629{
630 ino_t ino = (ino_t) fileid;
631 if (sizeof(ino_t) < sizeof(u64))
632 ino ^= fileid >> (sizeof(u64)-sizeof(ino_t)) * 8;
633 return ino;
634}
635
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636#define NFS_JUKEBOX_RETRY_TIME (5 * HZ)
637
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638#endif /* __KERNEL__ */
639
640/*
641 * NFS debug flags
642 */
643#define NFSDBG_VFS 0x0001
644#define NFSDBG_DIRCACHE 0x0002
645#define NFSDBG_LOOKUPCACHE 0x0004
646#define NFSDBG_PAGECACHE 0x0008
647#define NFSDBG_PROC 0x0010
648#define NFSDBG_XDR 0x0020
649#define NFSDBG_FILE 0x0040
650#define NFSDBG_ROOT 0x0080
651#define NFSDBG_CALLBACK 0x0100
David Howells24c8dbb2006-08-22 20:06:10 -0400652#define NFSDBG_CLIENT 0x0200
Chuck Leverf1828992007-07-01 12:12:51 -0400653#define NFSDBG_MOUNT 0x0400
David Howellsc6a6f192009-04-03 16:42:42 +0100654#define NFSDBG_FSCACHE 0x0800
Ricardo Labiaga85e174b2010-10-20 00:17:58 -0400655#define NFSDBG_PNFS 0x1000
Dean Hildebrand7ab672c2010-10-20 00:18:00 -0400656#define NFSDBG_PNFS_LD 0x2000
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657#define NFSDBG_ALL 0xFFFF
658
659#ifdef __KERNEL__
Benny Halevy4dc2eae2006-12-20 22:29:46 +0200660
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661# undef ifdebug
662# ifdef NFS_DEBUG
663# define ifdebug(fac) if (unlikely(nfs_debug & NFSDBG_##fac))
664# else
665# define ifdebug(fac) if (0)
666# endif
667#endif /* __KERNEL */
668
669#endif