blob: 1f8fc7f9bcd8b8eb0d07588ba671b9327e53fe90 [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;
Andy Adamson82be4172012-05-23 05:02:35 -0400105 struct nfs4_threshold *mdsthreshold;
Bryan Schumaker480c2002011-03-23 14:48:29 -0400106};
Olivier Galibert00a92642005-06-22 17:16:29 +0000107
Bryan Schumaker480c2002011-03-23 14:48:29 -0400108struct nfs_open_dir_context {
109 struct rpc_cred *cred;
Trond Myklebust0c030802011-07-30 12:45:35 -0400110 unsigned long attr_gencount;
Olivier Galibert00a92642005-06-22 17:16:29 +0000111 __u64 dir_cookie;
Bryan Schumaker8ef2ce32011-03-23 15:04:31 -0400112 __u64 dup_cookie;
Trond Myklebust0c030802011-07-30 12:45:35 -0400113 signed char duped;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114};
115
116/*
117 * NFSv4 delegation
118 */
119struct nfs_delegation;
120
Andreas Gruenbacher5c6a9f72005-06-22 17:16:27 +0000121struct posix_acl;
122
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123/*
124 * nfs fs inode data in memory
125 */
126struct nfs_inode {
127 /*
128 * The 64bit 'inode number'
129 */
130 __u64 fileid;
131
132 /*
133 * NFS file handle
134 */
135 struct nfs_fh fh;
136
137 /*
138 * Various flags
139 */
Chuck Lever412d5822005-08-18 11:24:11 -0700140 unsigned long flags; /* atomic bit ops */
141 unsigned long cache_validity; /* bit mask */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142
143 /*
Goldwyn Rodrigues24bd68f2006-03-20 13:44:11 -0500144 * read_cache_jiffies is when we started read-caching this inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145 * attrtimeo is for how long the cached information is assumed
146 * to be valid. A successful attribute revalidation doubles
147 * attrtimeo (up to acregmax/acdirmax), a failure resets it to
148 * acregmin/acdirmin.
149 *
150 * We need to revalidate the cached attrs for this inode if
151 *
Peter Staubach64672d52008-12-23 15:21:56 -0500152 * jiffies - read_cache_jiffies >= attrtimeo
153 *
154 * Please note the comparison is greater than or equal
155 * so that zero timeout values can be specified.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157 unsigned long read_cache_jiffies;
158 unsigned long attrtimeo;
159 unsigned long attrtimeo_timestamp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160
Trond Myklebust4704f0e2008-10-14 19:16:07 -0400161 unsigned long attr_gencount;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162 /* "Generation counter" for the attribute cache. This is
163 * bumped whenever we update the metadata on the
164 * server.
165 */
166 unsigned long cache_change_attribute;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167
Trond Myklebust1c3c07e2006-07-25 11:28:18 -0400168 struct rb_root access_cache;
Trond Myklebustcfcea3e2006-07-25 11:28:18 -0400169 struct list_head access_cache_entry_lru;
170 struct list_head access_cache_inode_lru;
Andreas Gruenbacher5c6a9f72005-06-22 17:16:27 +0000171#ifdef CONFIG_NFS_V3_ACL
172 struct posix_acl *acl_access;
173 struct posix_acl *acl_default;
174#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175
176 /*
177 * This is the cookie verifier used for NFSv3 readdir
178 * operations
179 */
Al Virobc4785c2006-10-19 23:28:51 -0700180 __be32 cookieverf[2];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181
Trond Myklebustfb8a1f12009-03-11 14:10:29 -0400182 unsigned long npages;
Fred Isamanea2cf222012-04-20 14:47:53 -0400183 struct nfs_mds_commit_info commit_info;
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
Bryan Schumaker89d77c82012-07-30 16:05:25 -0400194#if IS_ENABLED(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;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204#endif /* CONFIG_NFS_V4*/
Andy Adamson2701d082012-05-24 13:13:24 -0400205 /* how many bytes have been written/read and how many bytes queued up */
206 __u64 write_io;
207 __u64 read_io;
David Howellsef79c092009-04-03 16:42:43 +0100208#ifdef CONFIG_NFS_FSCACHE
209 struct fscache_cookie *fscache;
210#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211 struct inode vfs_inode;
212};
213
214/*
Chuck Lever55296802005-08-18 11:24:09 -0700215 * Cache validity bit flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216 */
Chuck Lever55296802005-08-18 11:24:09 -0700217#define NFS_INO_INVALID_ATTR 0x0001 /* cached attrs are invalid */
218#define NFS_INO_INVALID_DATA 0x0002 /* cached data is invalid */
219#define NFS_INO_INVALID_ATIME 0x0004 /* cached atime is invalid */
220#define NFS_INO_INVALID_ACCESS 0x0008 /* cached access cred invalid */
221#define NFS_INO_INVALID_ACL 0x0010 /* cached acls are invalid */
222#define NFS_INO_REVAL_PAGECACHE 0x0020 /* must revalidate pagecache */
Trond Myklebust412c77c2007-07-03 16:10:55 -0400223#define NFS_INO_REVAL_FORCED 0x0040 /* force revalidation ignoring a delegation */
Chuck Lever55296802005-08-18 11:24:09 -0700224
225/*
Chuck Lever412d5822005-08-18 11:24:11 -0700226 * Bit offsets in flags field
Chuck Lever55296802005-08-18 11:24:09 -0700227 */
Trond Myklebust691beb12008-10-05 14:48:22 -0400228#define NFS_INO_ADVISE_RDPLUS (0) /* advise readdirplus */
229#define NFS_INO_STALE (1) /* possible stale inode */
230#define NFS_INO_ACL_LRU_SET (2) /* Inode is on the LRU list */
Trond Myklebust72cb77f2009-03-11 14:10:30 -0400231#define NFS_INO_FLUSHING (4) /* inode is flushing out data */
David Howellsef79c092009-04-03 16:42:43 +0100232#define NFS_INO_FSCACHE (5) /* inode can be cached by FS-Cache */
233#define NFS_INO_FSCACHE_LOCK (6) /* FS-Cache cookie management lock */
Trond Myklebust71d0a612010-04-22 15:35:57 -0400234#define NFS_INO_COMMIT (7) /* inode is committing unstable writes */
Andy Adamson863a3c62011-03-23 13:27:54 +0000235#define NFS_INO_LAYOUTCOMMIT (9) /* layoutcommit required */
Peng Tao92407e72011-10-23 20:21:17 -0700236#define NFS_INO_LAYOUTCOMMITTING (10) /* layoutcommit inflight */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237
Benny Halevy99fadcd2008-01-23 08:59:08 +0200238static inline struct nfs_inode *NFS_I(const struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239{
240 return container_of(inode, struct nfs_inode, vfs_inode);
241}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242
Benny Halevy99fadcd2008-01-23 08:59:08 +0200243static inline struct nfs_server *NFS_SB(const struct super_block *s)
244{
245 return (struct nfs_server *)(s->s_fs_info);
246}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247
Benny Halevy99fadcd2008-01-23 08:59:08 +0200248static inline struct nfs_fh *NFS_FH(const struct inode *inode)
249{
250 return &NFS_I(inode)->fh;
251}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252
Benny Halevy99fadcd2008-01-23 08:59:08 +0200253static inline struct nfs_server *NFS_SERVER(const struct inode *inode)
254{
255 return NFS_SB(inode->i_sb);
256}
257
258static inline struct rpc_clnt *NFS_CLIENT(const struct inode *inode)
259{
260 return NFS_SERVER(inode)->client;
261}
262
263static inline const struct nfs_rpc_ops *NFS_PROTO(const struct inode *inode)
264{
265 return NFS_SERVER(inode)->nfs_client->rpc_ops;
266}
267
268static inline __be32 *NFS_COOKIEVERF(const struct inode *inode)
269{
270 return NFS_I(inode)->cookieverf;
271}
272
273static inline unsigned NFS_MINATTRTIMEO(const struct inode *inode)
274{
275 struct nfs_server *nfss = NFS_SERVER(inode);
276 return S_ISDIR(inode->i_mode) ? nfss->acdirmin : nfss->acregmin;
277}
278
279static inline unsigned NFS_MAXATTRTIMEO(const struct inode *inode)
280{
281 struct nfs_server *nfss = NFS_SERVER(inode);
282 return S_ISDIR(inode->i_mode) ? nfss->acdirmax : nfss->acregmax;
283}
284
285static inline int NFS_STALE(const struct inode *inode)
286{
287 return test_bit(NFS_INO_STALE, &NFS_I(inode)->flags);
288}
289
David Howellsef79c092009-04-03 16:42:43 +0100290static inline int NFS_FSCACHE(const struct inode *inode)
291{
292 return test_bit(NFS_INO_FSCACHE, &NFS_I(inode)->flags);
293}
294
Benny Halevy99fadcd2008-01-23 08:59:08 +0200295static inline __u64 NFS_FILEID(const struct inode *inode)
296{
297 return NFS_I(inode)->fileid;
298}
299
300static inline void set_nfs_fileid(struct inode *inode, __u64 fileid)
301{
302 NFS_I(inode)->fileid = fileid;
303}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304
Trond Myklebustdecf4912005-10-27 22:12:39 -0400305static inline void nfs_mark_for_revalidate(struct inode *inode)
306{
Trond Myklebust38478b22006-05-25 01:40:57 -0400307 struct nfs_inode *nfsi = NFS_I(inode);
308
Trond Myklebustdecf4912005-10-27 22:12:39 -0400309 spin_lock(&inode->i_lock);
Trond Myklebust38478b22006-05-25 01:40:57 -0400310 nfsi->cache_validity |= NFS_INO_INVALID_ATTR|NFS_INO_INVALID_ACCESS;
Trond Myklebustf3821112007-10-01 10:00:23 -0400311 if (S_ISDIR(inode->i_mode))
Trond Myklebust38478b22006-05-25 01:40:57 -0400312 nfsi->cache_validity |= NFS_INO_REVAL_PAGECACHE|NFS_INO_INVALID_DATA;
Trond Myklebustdecf4912005-10-27 22:12:39 -0400313 spin_unlock(&inode->i_lock);
314}
315
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316static inline int nfs_server_capable(struct inode *inode, int cap)
317{
318 return NFS_SERVER(inode)->caps & cap;
319}
320
Trond Myklebustd75340c2007-10-01 21:42:01 -0400321static inline void nfs_set_verifier(struct dentry * dentry, unsigned long verf)
322{
323 dentry->d_time = verf;
324}
325
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326/**
327 * nfs_save_change_attribute - Returns the inode attribute change cookie
Trond Myklebust8edb0182007-09-29 17:14:03 -0400328 * @dir - pointer to parent directory inode
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329 * The "change attribute" is updated every time we finish an operation
330 * that will result in a metadata change on the server.
331 */
Trond Myklebust8edb0182007-09-29 17:14:03 -0400332static inline unsigned long nfs_save_change_attribute(struct inode *dir)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333{
Trond Myklebust8edb0182007-09-29 17:14:03 -0400334 return NFS_I(dir)->cache_change_attribute;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335}
336
337/**
Trond Myklebust4b841732007-09-29 17:15:01 -0400338 * nfs_verify_change_attribute - Detects NFS remote directory changes
339 * @dir - pointer to parent directory inode
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340 * @chattr - previously saved change attribute
Trond Myklebust4b841732007-09-29 17:15:01 -0400341 * Return "false" if the verifiers doesn't match the change attribute.
342 * This would usually indicate that the directory contents have changed on
343 * the server, and that any dentries need revalidating.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344 */
Trond Myklebust4b841732007-09-29 17:15:01 -0400345static inline int nfs_verify_change_attribute(struct inode *dir, unsigned long chattr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346{
Trond Myklebust4b841732007-09-29 17:15:01 -0400347 return chattr == NFS_I(dir)->cache_change_attribute;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348}
349
350/*
351 * linux/fs/nfs/inode.c
352 */
Trond Myklebust29884df2005-12-13 16:13:54 -0500353extern int nfs_sync_mapping(struct address_space *mapping);
Trond Myklebustcd9ae2b2006-10-19 23:28:40 -0700354extern void nfs_zap_mapping(struct inode *inode, struct address_space *mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355extern void nfs_zap_caches(struct inode *);
Trond Myklebustc4812992007-09-28 17:11:45 -0400356extern void nfs_invalidate_atime(struct inode *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357extern struct inode *nfs_fhget(struct super_block *, struct nfs_fh *,
358 struct nfs_fattr *);
359extern int nfs_refresh_inode(struct inode *, struct nfs_fattr *);
Trond Myklebustdecf4912005-10-27 22:12:39 -0400360extern int nfs_post_op_update_inode(struct inode *inode, struct nfs_fattr *fattr);
Trond Myklebust70ca8852007-09-30 15:21:24 -0400361extern int nfs_post_op_update_inode_force_wcc(struct inode *inode, struct nfs_fattr *fattr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362extern int nfs_getattr(struct vfsmount *, struct dentry *, struct kstat *);
Al Viro10556cb2011-06-20 19:28:19 -0400363extern int nfs_permission(struct inode *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364extern int nfs_open(struct inode *, struct file *);
365extern int nfs_release(struct inode *, struct file *);
366extern int nfs_attribute_timeout(struct inode *inode);
367extern int nfs_revalidate_inode(struct nfs_server *server, struct inode *inode);
368extern int __nfs_revalidate_inode(struct nfs_server *, struct inode *);
Trond Myklebust44b11872006-05-25 01:40:59 -0400369extern int nfs_revalidate_mapping(struct inode *inode, struct address_space *mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370extern int nfs_setattr(struct dentry *, struct iattr *);
Trond Myklebust65e43082005-08-16 11:49:44 -0400371extern void nfs_setattr_update_inode(struct inode *inode, struct iattr *attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372extern struct nfs_open_context *get_nfs_open_context(struct nfs_open_context *ctx);
373extern void put_nfs_open_context(struct nfs_open_context *ctx);
Trond Myklebustdc0b0272008-12-23 15:21:56 -0500374extern 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 -0400375extern struct nfs_open_context *alloc_nfs_open_context(struct dentry *dentry, fmode_t f_mode);
Trond Myklebustcd9a1c02010-09-17 10:56:50 -0400376extern void nfs_file_set_open_context(struct file *filp, struct nfs_open_context *ctx);
Trond Myklebustf11ac8d2010-06-25 16:35:53 -0400377extern struct nfs_lock_context *nfs_get_lock_context(struct nfs_open_context *ctx);
378extern void nfs_put_lock_context(struct nfs_lock_context *l_ctx);
Trond Myklebustf43bf0b2007-10-09 12:01:04 -0400379extern u64 nfs_compat_user_ino64(u64 fileid);
Trond Myklebust4704f0e2008-10-14 19:16:07 -0400380extern void nfs_fattr_init(struct nfs_fattr *fattr);
Chuck Lever56463e52010-09-17 10:54:37 -0400381extern unsigned long nfs_inc_attr_generation_counter(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382
Trond Myklebust2d36bfde2010-04-16 16:22:45 -0400383extern struct nfs_fattr *nfs_alloc_fattr(void);
384
385static inline void nfs_free_fattr(const struct nfs_fattr *fattr)
386{
387 kfree(fattr);
388}
389
390extern struct nfs_fh *nfs_alloc_fhandle(void);
391
392static inline void nfs_free_fhandle(const struct nfs_fh *fh)
393{
394 kfree(fh);
395}
396
Trond Myklebuste27d3592012-03-18 14:07:42 -0400397#ifdef NFS_DEBUG
Weston Andros Adamsond8e05392012-03-06 20:46:43 -0500398extern u32 _nfs_display_fhandle_hash(const struct nfs_fh *fh);
399static inline u32 nfs_display_fhandle_hash(const struct nfs_fh *fh)
400{
401 return _nfs_display_fhandle_hash(fh);
402}
Chuck Lever20d27e92012-03-01 17:01:31 -0500403extern void _nfs_display_fhandle(const struct nfs_fh *fh, const char *caption);
404#define nfs_display_fhandle(fh, caption) \
405 do { \
406 if (unlikely(nfs_debug & NFSDBG_FACILITY)) \
407 _nfs_display_fhandle(fh, caption); \
408 } while (0)
409#else
Weston Andros Adamsond8e05392012-03-06 20:46:43 -0500410static inline u32 nfs_display_fhandle_hash(const struct nfs_fh *fh)
411{
Stephen Rothwell9304a812012-03-20 19:26:42 +1100412 return 0;
Weston Andros Adamsond8e05392012-03-06 20:46:43 -0500413}
Chuck Lever20d27e92012-03-01 17:01:31 -0500414static inline void nfs_display_fhandle(const struct nfs_fh *fh,
415 const char *caption)
416{
417}
418#endif
419
Chuck Lever56463e52010-09-17 10:54:37 -0400420/*
421 * linux/fs/nfs/nfsroot.c
422 */
423extern int nfs_root_data(char **root_device, char **root_data); /*__init*/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424/* linux/net/ipv4/ipconfig.c: trims ip addr off front of name, too. */
Al Viro5a874db2006-11-08 00:19:38 -0800425extern __be32 root_nfs_parse_addr(char *name); /*__init*/
Trond Myklebust0e574af2005-10-27 22:12:38 -0400426
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427/*
428 * linux/fs/nfs/file.c
429 */
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -0800430extern const struct file_operations nfs_file_operations;
Bryan Schumaker89d77c82012-07-30 16:05:25 -0400431#if IS_ENABLED(CONFIG_NFS_V4)
Jeff Layton1788ea62011-11-04 13:31:21 -0400432extern const struct file_operations nfs4_file_operations;
433#endif /* CONFIG_NFS_V4 */
Christoph Hellwigf5e54d62006-06-28 04:26:44 -0700434extern const struct address_space_operations nfs_file_aops;
Trond Myklebust11de3b12010-12-01 14:17:06 -0500435extern const struct address_space_operations nfs_dir_aops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436
Trond Myklebustc03025d2007-08-10 17:44:28 -0400437static inline struct nfs_open_context *nfs_file_open_context(struct file *filp)
438{
439 return filp->private_data;
440}
441
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442static inline struct rpc_cred *nfs_file_cred(struct file *file)
443{
Neil Brown504e5182008-10-16 14:15:16 +1100444 if (file != NULL) {
445 struct nfs_open_context *ctx =
446 nfs_file_open_context(file);
447 if (ctx)
448 return ctx->cred;
449 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450 return NULL;
451}
452
453/*
Andreas Gruenbacherb7fa0552005-06-22 17:16:27 +0000454 * linux/fs/nfs/xattr.c
455 */
456#ifdef CONFIG_NFS_V3_ACL
457extern ssize_t nfs3_listxattr(struct dentry *, char *, size_t);
458extern ssize_t nfs3_getxattr(struct dentry *, const char *, void *, size_t);
459extern int nfs3_setxattr(struct dentry *, const char *,
460 const void *, size_t, int);
461extern int nfs3_removexattr (struct dentry *, const char *name);
462#else
463# define nfs3_listxattr NULL
464# define nfs3_getxattr NULL
465# define nfs3_setxattr NULL
466# define nfs3_removexattr NULL
467#endif
468
469/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470 * linux/fs/nfs/direct.c
471 */
472extern ssize_t nfs_direct_IO(int, struct kiocb *, const struct iovec *, loff_t,
473 unsigned long);
Badari Pulavarty027445c2006-09-30 23:28:46 -0700474extern ssize_t nfs_file_direct_read(struct kiocb *iocb,
475 const struct iovec *iov, unsigned long nr_segs,
Mel Gormana564b8f2012-07-31 16:45:12 -0700476 loff_t pos, bool uio);
Badari Pulavarty027445c2006-09-30 23:28:46 -0700477extern ssize_t nfs_file_direct_write(struct kiocb *iocb,
478 const struct iovec *iov, unsigned long nr_segs,
Mel Gormana564b8f2012-07-31 16:45:12 -0700479 loff_t pos, bool uio);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480
481/*
482 * linux/fs/nfs/dir.c
483 */
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -0800484extern const struct file_operations nfs_dir_operations;
Al Virof786aa92009-02-20 05:51:22 +0000485extern const struct dentry_operations nfs_dentry_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486
Trond Myklebustbfc69a42007-10-15 18:18:29 -0400487extern void nfs_force_lookup_revalidate(struct inode *dir);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488extern int nfs_instantiate(struct dentry *dentry, struct nfs_fh *fh, struct nfs_fattr *fattr);
Trond Myklebustaf22f942007-08-10 17:45:10 -0400489extern int nfs_may_open(struct inode *inode, struct rpc_cred *cred, int openflags);
490extern void nfs_access_zap_cache(struct inode *inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491
492/*
493 * linux/fs/nfs/symlink.c
494 */
Arjan van de Venc5ef1c42007-02-12 00:55:40 -0800495extern const struct inode_operations nfs_symlink_inode_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496
497/*
Trond Myklebusta72b4422006-01-03 09:55:41 +0100498 * linux/fs/nfs/sysctl.c
499 */
500#ifdef CONFIG_SYSCTL
501extern int nfs_register_sysctl(void);
502extern void nfs_unregister_sysctl(void);
503#else
Stephen Rothwell7fd105e2006-02-20 18:28:08 -0800504#define nfs_register_sysctl() 0
Trond Myklebusta72b4422006-01-03 09:55:41 +0100505#define nfs_unregister_sysctl() do { } while(0)
506#endif
507
508/*
Trond Myklebust55a97592006-06-09 09:34:19 -0400509 * linux/fs/nfs/namespace.c
510 */
Arjan van de Venc5ef1c42007-02-12 00:55:40 -0800511extern const struct inode_operations nfs_mountpoint_inode_operations;
512extern const struct inode_operations nfs_referral_inode_operations;
Trond Myklebust51d8fa62006-06-09 09:34:20 -0400513extern int nfs_mountpoint_expiry_timeout;
514extern void nfs_release_automount_timer(void);
Trond Myklebust55a97592006-06-09 09:34:19 -0400515
516/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517 * linux/fs/nfs/unlink.c
518 */
Trond Myklebuste4eff1a2007-07-14 15:39:58 -0400519extern void nfs_complete_unlink(struct dentry *dentry, struct inode *);
Trond Myklebust565277f2007-10-15 18:17:53 -0400520extern void nfs_block_sillyrename(struct dentry *dentry);
521extern void nfs_unblock_sillyrename(struct dentry *dentry);
Jeff Layton779c5172010-09-17 17:31:30 -0400522extern int nfs_sillyrename(struct inode *dir, struct dentry *dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523
524/*
525 * linux/fs/nfs/write.c
526 */
Peter Zijlstra89a09142007-03-16 13:38:26 -0800527extern int nfs_congestion_kb;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528extern int nfs_writepage(struct page *page, struct writeback_control *wbc);
529extern int nfs_writepages(struct address_space *, struct writeback_control *);
530extern int nfs_flush_incompatible(struct file *file, struct page *page);
531extern int nfs_updatepage(struct file *, struct page *, unsigned int, unsigned int);
Fred Isaman13602892011-02-11 15:42:38 +0000532extern void nfs_writeback_done(struct rpc_task *, struct nfs_write_data *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533
534/*
535 * Try to write back everything synchronously (but check the
536 * return value!)
537 */
Trond Myklebust1c759502006-10-09 16:18:38 -0400538extern int nfs_wb_all(struct inode *inode);
539extern int nfs_wb_page(struct inode *inode, struct page* page);
Trond Myklebust1b3b4a12007-08-28 10:29:36 -0400540extern int nfs_wb_page_cancel(struct inode *inode, struct page* page);
Bryan Schumaker89d77c82012-07-30 16:05:25 -0400541#if IS_ENABLED(CONFIG_NFS_V3) || IS_ENABLED(CONFIG_NFS_V4)
Trond Myklebustb608b282010-07-30 15:31:54 -0400542extern int nfs_commit_inode(struct inode *, int);
Fred Isaman0b7c0152012-04-20 14:47:39 -0400543extern struct nfs_commit_data *nfs_commitdata_alloc(void);
544extern void nfs_commit_free(struct nfs_commit_data *data);
Trond Myklebust77a63f32010-08-01 13:40:40 -0400545#else
546static inline int
547nfs_commit_inode(struct inode *inode, int how)
548{
549 return 0;
550}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551#endif
552
553static inline int
554nfs_have_writebacks(struct inode *inode)
555{
556 return NFS_I(inode)->npages != 0;
557}
558
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560 * linux/fs/nfs/read.c
561 */
562extern int nfs_readpage(struct file *, struct page *);
563extern int nfs_readpages(struct file *, struct address_space *,
564 struct list_head *, unsigned);
Trond Myklebustec06c092006-03-20 13:44:27 -0500565extern int nfs_readpage_result(struct rpc_task *, struct nfs_read_data *);
David Howellsf42b2932009-04-03 16:42:44 +0100566extern int nfs_readpage_async(struct nfs_open_context *, struct inode *,
567 struct page *);
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100568
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569/*
Andreas Gruenbacherb7fa0552005-06-22 17:16:27 +0000570 * linux/fs/nfs3proc.c
571 */
572#ifdef CONFIG_NFS_V3_ACL
573extern struct posix_acl *nfs3_proc_getacl(struct inode *inode, int type);
574extern int nfs3_proc_setacl(struct inode *inode, int type,
575 struct posix_acl *acl);
Andreas Gruenbacher055ffbe2005-06-22 17:16:27 +0000576extern int nfs3_proc_set_default_acl(struct inode *dir, struct inode *inode,
Al Virod3fb6122011-07-23 18:37:50 -0400577 umode_t mode);
Andreas Gruenbacher5c6a9f72005-06-22 17:16:27 +0000578extern void nfs3_forget_cached_acls(struct inode *inode);
Andreas Gruenbacher055ffbe2005-06-22 17:16:27 +0000579#else
580static inline int nfs3_proc_set_default_acl(struct inode *dir,
581 struct inode *inode,
Al Virod3fb6122011-07-23 18:37:50 -0400582 umode_t mode)
Andreas Gruenbacher055ffbe2005-06-22 17:16:27 +0000583{
584 return 0;
585}
Andreas Gruenbacher5c6a9f72005-06-22 17:16:27 +0000586
587static inline void nfs3_forget_cached_acls(struct inode *inode)
588{
589}
Andreas Gruenbacherb7fa0552005-06-22 17:16:27 +0000590#endif /* CONFIG_NFS_V3_ACL */
591
592/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593 * inline functions
594 */
595
Chuck Lever433c9232007-07-01 12:12:14 -0400596static inline loff_t nfs_size_to_loff_t(__u64 size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597{
Chuck Lever433c9232007-07-01 12:12:14 -0400598 if (size > (__u64) OFFSET_MAX - 1)
599 return OFFSET_MAX - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600 return (loff_t) size;
601}
602
603static inline ino_t
604nfs_fileid_to_ino_t(u64 fileid)
605{
606 ino_t ino = (ino_t) fileid;
607 if (sizeof(ino_t) < sizeof(u64))
608 ino ^= fileid >> (sizeof(u64)-sizeof(ino_t)) * 8;
609 return ino;
610}
611
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612#define NFS_JUKEBOX_RETRY_TIME (5 * HZ)
613
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614#endif /* __KERNEL__ */
615
616/*
617 * NFS debug flags
618 */
619#define NFSDBG_VFS 0x0001
620#define NFSDBG_DIRCACHE 0x0002
621#define NFSDBG_LOOKUPCACHE 0x0004
622#define NFSDBG_PAGECACHE 0x0008
623#define NFSDBG_PROC 0x0010
624#define NFSDBG_XDR 0x0020
625#define NFSDBG_FILE 0x0040
626#define NFSDBG_ROOT 0x0080
627#define NFSDBG_CALLBACK 0x0100
David Howells24c8dbb2006-08-22 20:06:10 -0400628#define NFSDBG_CLIENT 0x0200
Chuck Leverf1828992007-07-01 12:12:51 -0400629#define NFSDBG_MOUNT 0x0400
David Howellsc6a6f192009-04-03 16:42:42 +0100630#define NFSDBG_FSCACHE 0x0800
Ricardo Labiaga85e174b2010-10-20 00:17:58 -0400631#define NFSDBG_PNFS 0x1000
Dean Hildebrand7ab672c2010-10-20 00:18:00 -0400632#define NFSDBG_PNFS_LD 0x2000
Chuck Levere3c0fb72012-05-21 22:45:24 -0400633#define NFSDBG_STATE 0x4000
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634#define NFSDBG_ALL 0xFFFF
635
636#ifdef __KERNEL__
Benny Halevy4dc2eae2006-12-20 22:29:46 +0200637
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638# undef ifdebug
639# ifdef NFS_DEBUG
640# define ifdebug(fac) if (unlikely(nfs_debug & NFSDBG_##fac))
Trond Myklebust6f008662012-03-20 14:12:46 -0400641# define NFS_IFDEBUG(x) x
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642# else
643# define ifdebug(fac) if (0)
Trond Myklebust6f008662012-03-20 14:12:46 -0400644# define NFS_IFDEBUG(x)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645# endif
646#endif /* __KERNEL */
647
648#endif