blob: 3ea4cde8701ce1e97d6a39a4a1264452468a5254 [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 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07008#ifndef _LINUX_NFS_FS_H
9#define _LINUX_NFS_FS_H
10
David Howells607ca462012-10-13 10:46:48 +010011#include <uapi/linux/nfs_fs.h>
Jeff Garzike18fa702006-09-24 11:13:19 -040012
David Woodhouse7f1cbe52006-09-12 20:36:02 -070013
Trond Myklebuste27d3592012-03-18 14:07:42 -040014/*
15 * Enable dprintk() debugging support for nfs client.
16 */
17#ifdef CONFIG_NFS_DEBUG
18# define NFS_DEBUG
19#endif
20
Linus Torvalds1da177e2005-04-16 15:20:36 -070021#include <linux/in.h>
22#include <linux/mm.h>
23#include <linux/pagemap.h>
Trond Myklebust1c3c07e2006-07-25 11:28:18 -040024#include <linux/rbtree.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025#include <linux/rwsem.h>
26#include <linux/wait.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#include <linux/sunrpc/debug.h>
29#include <linux/sunrpc/auth.h>
30#include <linux/sunrpc/clnt.h>
31
32#include <linux/nfs.h>
33#include <linux/nfs2.h>
34#include <linux/nfs3.h>
35#include <linux/nfs4.h>
36#include <linux/nfs_xdr.h>
Trond Myklebust8b4bdcf2006-06-09 09:34:19 -040037#include <linux/nfs_fs_sb.h>
38
Linus Torvalds1da177e2005-04-16 15:20:36 -070039#include <linux/mempool.h>
40
41/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070042 * These are the default flags for swap requests
43 */
44#define NFS_RPC_SWAPFLAGS (RPC_TASK_SWAPPER|RPC_TASK_ROOTCREDS)
45
Linus Torvalds1da177e2005-04-16 15:20:36 -070046/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070047 * NFSv3/v4 Access mode cache entry
48 */
49struct nfs_access_entry {
Trond Myklebust1c3c07e2006-07-25 11:28:18 -040050 struct rb_node rb_node;
Trond Myklebustcfcea3e2006-07-25 11:28:18 -040051 struct list_head lru;
Linus Torvalds1da177e2005-04-16 15:20:36 -070052 unsigned long jiffies;
53 struct rpc_cred * cred;
54 int mask;
55};
56
Trond Myklebust2a369152012-08-13 18:54:45 -040057struct nfs_lockowner {
58 fl_owner_t l_owner;
59 pid_t l_pid;
60};
61
Trond Myklebust577b4232013-04-08 21:38:12 -040062#define NFS_IO_INPROGRESS 0
63struct nfs_io_counter {
64 unsigned long flags;
65 atomic_t io_count;
66};
67
Trond Myklebustf11ac8d2010-06-25 16:35:53 -040068struct nfs_lock_context {
69 atomic_t count;
70 struct list_head list;
71 struct nfs_open_context *open_context;
Trond Myklebust2a369152012-08-13 18:54:45 -040072 struct nfs_lockowner lockowner;
Trond Myklebust577b4232013-04-08 21:38:12 -040073 struct nfs_io_counter io_count;
Trond Myklebustf11ac8d2010-06-25 16:35:53 -040074};
75
Linus Torvalds1da177e2005-04-16 15:20:36 -070076struct nfs4_state;
77struct nfs_open_context {
Trond Myklebustf11ac8d2010-06-25 16:35:53 -040078 struct nfs_lock_context lock_context;
Al Viro3d4ff432011-06-22 18:40:12 -040079 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -070080 struct rpc_cred *cred;
81 struct nfs4_state *state;
Trond Myklebustdc0b0272008-12-23 15:21:56 -050082 fmode_t mode;
Trond Myklebust7b159fc2007-07-25 14:09:54 -040083
84 unsigned long flags;
85#define NFS_CONTEXT_ERROR_WRITE (0)
Trond Myklebust05990d12012-09-11 16:01:22 -040086#define NFS_CONTEXT_RESEND_WRITES (1)
Trond Myklebustc58c8442013-03-18 19:45:14 -040087#define NFS_CONTEXT_BAD (2)
Linus Torvalds1da177e2005-04-16 15:20:36 -070088 int error;
89
90 struct list_head list;
Andy Adamson82be4172012-05-23 05:02:35 -040091 struct nfs4_threshold *mdsthreshold;
Bryan Schumaker480c2002011-03-23 14:48:29 -040092};
Olivier Galibert00a92642005-06-22 17:16:29 +000093
Bryan Schumaker480c2002011-03-23 14:48:29 -040094struct nfs_open_dir_context {
95 struct rpc_cred *cred;
Trond Myklebust0c030802011-07-30 12:45:35 -040096 unsigned long attr_gencount;
Olivier Galibert00a92642005-06-22 17:16:29 +000097 __u64 dir_cookie;
Bryan Schumaker8ef2ce32011-03-23 15:04:31 -040098 __u64 dup_cookie;
Trond Myklebust0c030802011-07-30 12:45:35 -040099 signed char duped;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100};
101
102/*
103 * NFSv4 delegation
104 */
105struct nfs_delegation;
106
Andreas Gruenbacher5c6a9f72005-06-22 17:16:27 +0000107struct posix_acl;
108
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109/*
110 * nfs fs inode data in memory
111 */
112struct nfs_inode {
113 /*
114 * The 64bit 'inode number'
115 */
116 __u64 fileid;
117
118 /*
119 * NFS file handle
120 */
121 struct nfs_fh fh;
122
123 /*
124 * Various flags
125 */
Chuck Lever412d5822005-08-18 11:24:11 -0700126 unsigned long flags; /* atomic bit ops */
127 unsigned long cache_validity; /* bit mask */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128
129 /*
Goldwyn Rodrigues24bd68f2006-03-20 13:44:11 -0500130 * read_cache_jiffies is when we started read-caching this inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131 * attrtimeo is for how long the cached information is assumed
132 * to be valid. A successful attribute revalidation doubles
133 * attrtimeo (up to acregmax/acdirmax), a failure resets it to
134 * acregmin/acdirmin.
135 *
136 * We need to revalidate the cached attrs for this inode if
137 *
Peter Staubach64672d52008-12-23 15:21:56 -0500138 * jiffies - read_cache_jiffies >= attrtimeo
139 *
140 * Please note the comparison is greater than or equal
141 * so that zero timeout values can be specified.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143 unsigned long read_cache_jiffies;
144 unsigned long attrtimeo;
145 unsigned long attrtimeo_timestamp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146
Trond Myklebust4704f0e2008-10-14 19:16:07 -0400147 unsigned long attr_gencount;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148 /* "Generation counter" for the attribute cache. This is
149 * bumped whenever we update the metadata on the
150 * server.
151 */
152 unsigned long cache_change_attribute;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153
Trond Myklebust1c3c07e2006-07-25 11:28:18 -0400154 struct rb_root access_cache;
Trond Myklebustcfcea3e2006-07-25 11:28:18 -0400155 struct list_head access_cache_entry_lru;
156 struct list_head access_cache_inode_lru;
Andreas Gruenbacher5c6a9f72005-06-22 17:16:27 +0000157#ifdef CONFIG_NFS_V3_ACL
158 struct posix_acl *acl_access;
159 struct posix_acl *acl_default;
160#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161
162 /*
163 * This is the cookie verifier used for NFSv3 readdir
164 * operations
165 */
Al Virobc4785c2006-10-19 23:28:51 -0700166 __be32 cookieverf[2];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167
Trond Myklebustfb8a1f12009-03-11 14:10:29 -0400168 unsigned long npages;
Fred Isamanea2cf222012-04-20 14:47:53 -0400169 struct nfs_mds_commit_info commit_info;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170
171 /* Open contexts for shared mmap writes */
172 struct list_head open_files;
173
Trond Myklebust565277f2007-10-15 18:17:53 -0400174 /* Number of in-flight sillydelete RPC calls */
175 atomic_t silly_count;
176 /* List of deferred sillydelete requests */
177 struct hlist_head silly_list;
178 wait_queue_head_t waitqueue;
179
Bryan Schumaker89d77c82012-07-30 16:05:25 -0400180#if IS_ENABLED(CONFIG_NFS_V4)
J. Bruce Fieldse50a1c22005-06-22 17:16:23 +0000181 struct nfs4_cached_acl *nfs4_acl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182 /* NFSv4 state */
183 struct list_head open_states;
Arnd Bergmann5b222162010-03-03 10:20:10 +0100184 struct nfs_delegation __rcu *delegation;
Trond Myklebustbd7bf9d2008-12-23 15:21:53 -0500185 fmode_t delegation_state;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186 struct rw_semaphore rwsem;
Benny Halevye5e94012010-10-20 00:18:01 -0400187
188 /* pNFS layout information */
189 struct pnfs_layout_hdr *layout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190#endif /* CONFIG_NFS_V4*/
Andy Adamson2701d082012-05-24 13:13:24 -0400191 /* how many bytes have been written/read and how many bytes queued up */
192 __u64 write_io;
193 __u64 read_io;
David Howellsef79c092009-04-03 16:42:43 +0100194#ifdef CONFIG_NFS_FSCACHE
195 struct fscache_cookie *fscache;
196#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197 struct inode vfs_inode;
198};
199
200/*
Chuck Lever55296802005-08-18 11:24:09 -0700201 * Cache validity bit flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202 */
Chuck Lever55296802005-08-18 11:24:09 -0700203#define NFS_INO_INVALID_ATTR 0x0001 /* cached attrs are invalid */
204#define NFS_INO_INVALID_DATA 0x0002 /* cached data is invalid */
205#define NFS_INO_INVALID_ATIME 0x0004 /* cached atime is invalid */
206#define NFS_INO_INVALID_ACCESS 0x0008 /* cached access cred invalid */
207#define NFS_INO_INVALID_ACL 0x0010 /* cached acls are invalid */
208#define NFS_INO_REVAL_PAGECACHE 0x0020 /* must revalidate pagecache */
Trond Myklebust412c77c2007-07-03 16:10:55 -0400209#define NFS_INO_REVAL_FORCED 0x0040 /* force revalidation ignoring a delegation */
David Quigleyaa9c2662013-05-22 12:50:44 -0400210#define NFS_INO_INVALID_LABEL 0x0080 /* cached label is invalid */
Chuck Lever55296802005-08-18 11:24:09 -0700211
212/*
Chuck Lever412d5822005-08-18 11:24:11 -0700213 * Bit offsets in flags field
Chuck Lever55296802005-08-18 11:24:09 -0700214 */
Trond Myklebust691beb12008-10-05 14:48:22 -0400215#define NFS_INO_ADVISE_RDPLUS (0) /* advise readdirplus */
216#define NFS_INO_STALE (1) /* possible stale inode */
217#define NFS_INO_ACL_LRU_SET (2) /* Inode is on the LRU list */
Trond Myklebust72cb77f2009-03-11 14:10:30 -0400218#define NFS_INO_FLUSHING (4) /* inode is flushing out data */
David Howellsef79c092009-04-03 16:42:43 +0100219#define NFS_INO_FSCACHE (5) /* inode can be cached by FS-Cache */
220#define NFS_INO_FSCACHE_LOCK (6) /* FS-Cache cookie management lock */
Trond Myklebust71d0a612010-04-22 15:35:57 -0400221#define NFS_INO_COMMIT (7) /* inode is committing unstable writes */
Andy Adamson863a3c62011-03-23 13:27:54 +0000222#define NFS_INO_LAYOUTCOMMIT (9) /* layoutcommit required */
Peng Tao92407e72011-10-23 20:21:17 -0700223#define NFS_INO_LAYOUTCOMMITTING (10) /* layoutcommit inflight */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224
Benny Halevy99fadcd2008-01-23 08:59:08 +0200225static inline struct nfs_inode *NFS_I(const struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226{
227 return container_of(inode, struct nfs_inode, vfs_inode);
228}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229
Benny Halevy99fadcd2008-01-23 08:59:08 +0200230static inline struct nfs_server *NFS_SB(const struct super_block *s)
231{
232 return (struct nfs_server *)(s->s_fs_info);
233}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234
Benny Halevy99fadcd2008-01-23 08:59:08 +0200235static inline struct nfs_fh *NFS_FH(const struct inode *inode)
236{
237 return &NFS_I(inode)->fh;
238}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239
Benny Halevy99fadcd2008-01-23 08:59:08 +0200240static inline struct nfs_server *NFS_SERVER(const struct inode *inode)
241{
242 return NFS_SB(inode->i_sb);
243}
244
245static inline struct rpc_clnt *NFS_CLIENT(const struct inode *inode)
246{
247 return NFS_SERVER(inode)->client;
248}
249
250static inline const struct nfs_rpc_ops *NFS_PROTO(const struct inode *inode)
251{
252 return NFS_SERVER(inode)->nfs_client->rpc_ops;
253}
254
Benny Halevy99fadcd2008-01-23 08:59:08 +0200255static inline unsigned NFS_MINATTRTIMEO(const struct inode *inode)
256{
257 struct nfs_server *nfss = NFS_SERVER(inode);
258 return S_ISDIR(inode->i_mode) ? nfss->acdirmin : nfss->acregmin;
259}
260
261static inline unsigned NFS_MAXATTRTIMEO(const struct inode *inode)
262{
263 struct nfs_server *nfss = NFS_SERVER(inode);
264 return S_ISDIR(inode->i_mode) ? nfss->acdirmax : nfss->acregmax;
265}
266
267static inline int NFS_STALE(const struct inode *inode)
268{
269 return test_bit(NFS_INO_STALE, &NFS_I(inode)->flags);
270}
271
David Howellsef79c092009-04-03 16:42:43 +0100272static inline int NFS_FSCACHE(const struct inode *inode)
273{
274 return test_bit(NFS_INO_FSCACHE, &NFS_I(inode)->flags);
275}
276
Benny Halevy99fadcd2008-01-23 08:59:08 +0200277static inline __u64 NFS_FILEID(const struct inode *inode)
278{
279 return NFS_I(inode)->fileid;
280}
281
282static inline void set_nfs_fileid(struct inode *inode, __u64 fileid)
283{
284 NFS_I(inode)->fileid = fileid;
285}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286
Trond Myklebustdecf4912005-10-27 22:12:39 -0400287static inline void nfs_mark_for_revalidate(struct inode *inode)
288{
Trond Myklebust38478b22006-05-25 01:40:57 -0400289 struct nfs_inode *nfsi = NFS_I(inode);
290
Trond Myklebustdecf4912005-10-27 22:12:39 -0400291 spin_lock(&inode->i_lock);
Trond Myklebust38478b22006-05-25 01:40:57 -0400292 nfsi->cache_validity |= NFS_INO_INVALID_ATTR|NFS_INO_INVALID_ACCESS;
Trond Myklebustf3821112007-10-01 10:00:23 -0400293 if (S_ISDIR(inode->i_mode))
Trond Myklebust38478b22006-05-25 01:40:57 -0400294 nfsi->cache_validity |= NFS_INO_REVAL_PAGECACHE|NFS_INO_INVALID_DATA;
Trond Myklebustdecf4912005-10-27 22:12:39 -0400295 spin_unlock(&inode->i_lock);
296}
297
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298static inline int nfs_server_capable(struct inode *inode, int cap)
299{
300 return NFS_SERVER(inode)->caps & cap;
301}
302
Trond Myklebustd75340c2007-10-01 21:42:01 -0400303static inline void nfs_set_verifier(struct dentry * dentry, unsigned long verf)
304{
305 dentry->d_time = verf;
306}
307
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308/**
309 * nfs_save_change_attribute - Returns the inode attribute change cookie
Trond Myklebust8edb0182007-09-29 17:14:03 -0400310 * @dir - pointer to parent directory inode
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311 * The "change attribute" is updated every time we finish an operation
312 * that will result in a metadata change on the server.
313 */
Trond Myklebust8edb0182007-09-29 17:14:03 -0400314static inline unsigned long nfs_save_change_attribute(struct inode *dir)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315{
Trond Myklebust8edb0182007-09-29 17:14:03 -0400316 return NFS_I(dir)->cache_change_attribute;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317}
318
319/**
Trond Myklebust4b841732007-09-29 17:15:01 -0400320 * nfs_verify_change_attribute - Detects NFS remote directory changes
321 * @dir - pointer to parent directory inode
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322 * @chattr - previously saved change attribute
Trond Myklebust4b841732007-09-29 17:15:01 -0400323 * Return "false" if the verifiers doesn't match the change attribute.
324 * This would usually indicate that the directory contents have changed on
325 * the server, and that any dentries need revalidating.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326 */
Trond Myklebust4b841732007-09-29 17:15:01 -0400327static inline int nfs_verify_change_attribute(struct inode *dir, unsigned long chattr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328{
Trond Myklebust4b841732007-09-29 17:15:01 -0400329 return chattr == NFS_I(dir)->cache_change_attribute;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330}
331
332/*
333 * linux/fs/nfs/inode.c
334 */
Trond Myklebust29884df2005-12-13 16:13:54 -0500335extern int nfs_sync_mapping(struct address_space *mapping);
Trond Myklebustcd9ae2b2006-10-19 23:28:40 -0700336extern void nfs_zap_mapping(struct inode *inode, struct address_space *mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337extern void nfs_zap_caches(struct inode *);
Trond Myklebustc4812992007-09-28 17:11:45 -0400338extern void nfs_invalidate_atime(struct inode *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339extern struct inode *nfs_fhget(struct super_block *, struct nfs_fh *,
David Quigley1775fd32013-05-22 12:50:42 -0400340 struct nfs_fattr *, struct nfs4_label *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341extern int nfs_refresh_inode(struct inode *, struct nfs_fattr *);
Trond Myklebustdecf4912005-10-27 22:12:39 -0400342extern int nfs_post_op_update_inode(struct inode *inode, struct nfs_fattr *fattr);
Trond Myklebust70ca8852007-09-30 15:21:24 -0400343extern int nfs_post_op_update_inode_force_wcc(struct inode *inode, struct nfs_fattr *fattr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344extern int nfs_getattr(struct vfsmount *, struct dentry *, struct kstat *);
Weston Andros Adamson6168f622012-09-10 14:00:46 -0400345extern void nfs_access_add_cache(struct inode *, struct nfs_access_entry *);
346extern void nfs_access_set_mask(struct nfs_access_entry *, u32);
Al Viro10556cb2011-06-20 19:28:19 -0400347extern int nfs_permission(struct inode *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348extern int nfs_open(struct inode *, struct file *);
349extern int nfs_release(struct inode *, struct file *);
350extern int nfs_attribute_timeout(struct inode *inode);
Scott Mayhew43f291c2013-07-05 17:49:30 -0400351extern int nfs_attribute_cache_expired(struct inode *inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352extern int nfs_revalidate_inode(struct nfs_server *server, struct inode *inode);
353extern int __nfs_revalidate_inode(struct nfs_server *, struct inode *);
Trond Myklebust44b11872006-05-25 01:40:59 -0400354extern int nfs_revalidate_mapping(struct inode *inode, struct address_space *mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355extern int nfs_setattr(struct dentry *, struct iattr *);
Trond Myklebust65e43082005-08-16 11:49:44 -0400356extern void nfs_setattr_update_inode(struct inode *inode, struct iattr *attr);
David Quigleyaa9c2662013-05-22 12:50:44 -0400357extern void nfs_setsecurity(struct inode *inode, struct nfs_fattr *fattr,
358 struct nfs4_label *label);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359extern struct nfs_open_context *get_nfs_open_context(struct nfs_open_context *ctx);
360extern void put_nfs_open_context(struct nfs_open_context *ctx);
Trond Myklebustdc0b0272008-12-23 15:21:56 -0500361extern 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 -0400362extern struct nfs_open_context *alloc_nfs_open_context(struct dentry *dentry, fmode_t f_mode);
Trond Myklebustc45ffdd2013-05-29 13:34:46 -0400363extern void nfs_inode_attach_open_context(struct nfs_open_context *ctx);
Trond Myklebustcd9a1c02010-09-17 10:56:50 -0400364extern void nfs_file_set_open_context(struct file *filp, struct nfs_open_context *ctx);
Trond Myklebustf11ac8d2010-06-25 16:35:53 -0400365extern struct nfs_lock_context *nfs_get_lock_context(struct nfs_open_context *ctx);
366extern void nfs_put_lock_context(struct nfs_lock_context *l_ctx);
Trond Myklebustf43bf0b2007-10-09 12:01:04 -0400367extern u64 nfs_compat_user_ino64(u64 fileid);
Trond Myklebust4704f0e2008-10-14 19:16:07 -0400368extern void nfs_fattr_init(struct nfs_fattr *fattr);
Chuck Lever56463e52010-09-17 10:54:37 -0400369extern unsigned long nfs_inc_attr_generation_counter(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370
Trond Myklebust2d36bfde2010-04-16 16:22:45 -0400371extern struct nfs_fattr *nfs_alloc_fattr(void);
372
373static inline void nfs_free_fattr(const struct nfs_fattr *fattr)
374{
375 kfree(fattr);
376}
377
378extern struct nfs_fh *nfs_alloc_fhandle(void);
379
380static inline void nfs_free_fhandle(const struct nfs_fh *fh)
381{
382 kfree(fh);
383}
384
Trond Myklebuste27d3592012-03-18 14:07:42 -0400385#ifdef NFS_DEBUG
Weston Andros Adamsond8e05392012-03-06 20:46:43 -0500386extern u32 _nfs_display_fhandle_hash(const struct nfs_fh *fh);
387static inline u32 nfs_display_fhandle_hash(const struct nfs_fh *fh)
388{
389 return _nfs_display_fhandle_hash(fh);
390}
Chuck Lever20d27e92012-03-01 17:01:31 -0500391extern void _nfs_display_fhandle(const struct nfs_fh *fh, const char *caption);
392#define nfs_display_fhandle(fh, caption) \
393 do { \
394 if (unlikely(nfs_debug & NFSDBG_FACILITY)) \
395 _nfs_display_fhandle(fh, caption); \
396 } while (0)
397#else
Weston Andros Adamsond8e05392012-03-06 20:46:43 -0500398static inline u32 nfs_display_fhandle_hash(const struct nfs_fh *fh)
399{
Stephen Rothwell9304a812012-03-20 19:26:42 +1100400 return 0;
Weston Andros Adamsond8e05392012-03-06 20:46:43 -0500401}
Chuck Lever20d27e92012-03-01 17:01:31 -0500402static inline void nfs_display_fhandle(const struct nfs_fh *fh,
403 const char *caption)
404{
405}
406#endif
407
Chuck Lever56463e52010-09-17 10:54:37 -0400408/*
409 * linux/fs/nfs/nfsroot.c
410 */
411extern int nfs_root_data(char **root_device, char **root_data); /*__init*/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412/* linux/net/ipv4/ipconfig.c: trims ip addr off front of name, too. */
Al Viro5a874db2006-11-08 00:19:38 -0800413extern __be32 root_nfs_parse_addr(char *name); /*__init*/
Trond Myklebust0e574af2005-10-27 22:12:38 -0400414
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415/*
416 * linux/fs/nfs/file.c
417 */
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -0800418extern const struct file_operations nfs_file_operations;
Bryan Schumaker89d77c82012-07-30 16:05:25 -0400419#if IS_ENABLED(CONFIG_NFS_V4)
Jeff Layton1788ea62011-11-04 13:31:21 -0400420extern const struct file_operations nfs4_file_operations;
421#endif /* CONFIG_NFS_V4 */
Christoph Hellwigf5e54d62006-06-28 04:26:44 -0700422extern const struct address_space_operations nfs_file_aops;
Trond Myklebust11de3b12010-12-01 14:17:06 -0500423extern const struct address_space_operations nfs_dir_aops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424
Trond Myklebustc03025d2007-08-10 17:44:28 -0400425static inline struct nfs_open_context *nfs_file_open_context(struct file *filp)
426{
427 return filp->private_data;
428}
429
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430static inline struct rpc_cred *nfs_file_cred(struct file *file)
431{
Neil Brown504e5182008-10-16 14:15:16 +1100432 if (file != NULL) {
433 struct nfs_open_context *ctx =
434 nfs_file_open_context(file);
435 if (ctx)
436 return ctx->cred;
437 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438 return NULL;
439}
440
441/*
Andreas Gruenbacherb7fa0552005-06-22 17:16:27 +0000442 * linux/fs/nfs/xattr.c
443 */
444#ifdef CONFIG_NFS_V3_ACL
445extern ssize_t nfs3_listxattr(struct dentry *, char *, size_t);
446extern ssize_t nfs3_getxattr(struct dentry *, const char *, void *, size_t);
447extern int nfs3_setxattr(struct dentry *, const char *,
448 const void *, size_t, int);
449extern int nfs3_removexattr (struct dentry *, const char *name);
450#else
451# define nfs3_listxattr NULL
452# define nfs3_getxattr NULL
453# define nfs3_setxattr NULL
454# define nfs3_removexattr NULL
455#endif
456
457/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458 * linux/fs/nfs/direct.c
459 */
460extern ssize_t nfs_direct_IO(int, struct kiocb *, const struct iovec *, loff_t,
461 unsigned long);
Badari Pulavarty027445c2006-09-30 23:28:46 -0700462extern ssize_t nfs_file_direct_read(struct kiocb *iocb,
463 const struct iovec *iov, unsigned long nr_segs,
Mel Gormana564b8f2012-07-31 16:45:12 -0700464 loff_t pos, bool uio);
Badari Pulavarty027445c2006-09-30 23:28:46 -0700465extern ssize_t nfs_file_direct_write(struct kiocb *iocb,
466 const struct iovec *iov, unsigned long nr_segs,
Mel Gormana564b8f2012-07-31 16:45:12 -0700467 loff_t pos, bool uio);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468
469/*
470 * linux/fs/nfs/dir.c
471 */
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -0800472extern const struct file_operations nfs_dir_operations;
Al Virof786aa92009-02-20 05:51:22 +0000473extern const struct dentry_operations nfs_dentry_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474
Trond Myklebustbfc69a42007-10-15 18:18:29 -0400475extern void nfs_force_lookup_revalidate(struct inode *dir);
David Quigley1775fd32013-05-22 12:50:42 -0400476extern int nfs_instantiate(struct dentry *dentry, struct nfs_fh *fh,
477 struct nfs_fattr *fattr, struct nfs4_label *label);
Trond Myklebustaf22f942007-08-10 17:45:10 -0400478extern int nfs_may_open(struct inode *inode, struct rpc_cred *cred, int openflags);
479extern void nfs_access_zap_cache(struct inode *inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480
481/*
482 * linux/fs/nfs/symlink.c
483 */
Arjan van de Venc5ef1c42007-02-12 00:55:40 -0800484extern const struct inode_operations nfs_symlink_inode_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485
486/*
Trond Myklebusta72b4422006-01-03 09:55:41 +0100487 * linux/fs/nfs/sysctl.c
488 */
489#ifdef CONFIG_SYSCTL
490extern int nfs_register_sysctl(void);
491extern void nfs_unregister_sysctl(void);
492#else
Stephen Rothwell7fd105e2006-02-20 18:28:08 -0800493#define nfs_register_sysctl() 0
Trond Myklebusta72b4422006-01-03 09:55:41 +0100494#define nfs_unregister_sysctl() do { } while(0)
495#endif
496
497/*
Trond Myklebust55a97592006-06-09 09:34:19 -0400498 * linux/fs/nfs/namespace.c
499 */
Arjan van de Venc5ef1c42007-02-12 00:55:40 -0800500extern const struct inode_operations nfs_mountpoint_inode_operations;
501extern const struct inode_operations nfs_referral_inode_operations;
Trond Myklebust51d8fa62006-06-09 09:34:20 -0400502extern int nfs_mountpoint_expiry_timeout;
503extern void nfs_release_automount_timer(void);
Trond Myklebust55a97592006-06-09 09:34:19 -0400504
505/*
Steve Dicksone058f702013-05-22 12:50:40 -0400506 * linux/fs/nfs/nfs4proc.c
507 */
508#ifdef CONFIG_NFS_V4_SECURITY_LABEL
509extern struct nfs4_label *nfs4_label_alloc(struct nfs_server *server, gfp_t flags);
510static inline void nfs4_label_free(struct nfs4_label *label)
511{
512 if (label) {
513 kfree(label->label);
514 kfree(label);
515 }
516 return;
517}
518#else
519static inline struct nfs4_label *nfs4_label_alloc(struct nfs_server *server, gfp_t flags) { return NULL; }
520static inline void nfs4_label_free(void *label) {}
521#endif
522
523/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524 * linux/fs/nfs/unlink.c
525 */
Trond Myklebuste4eff1a2007-07-14 15:39:58 -0400526extern void nfs_complete_unlink(struct dentry *dentry, struct inode *);
Trond Myklebustba6c0592013-08-30 12:24:25 -0400527extern void nfs_wait_on_sillyrename(struct dentry *dentry);
Trond Myklebust565277f2007-10-15 18:17:53 -0400528extern void nfs_block_sillyrename(struct dentry *dentry);
529extern void nfs_unblock_sillyrename(struct dentry *dentry);
Jeff Layton779c5172010-09-17 17:31:30 -0400530extern int nfs_sillyrename(struct inode *dir, struct dentry *dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531
532/*
533 * linux/fs/nfs/write.c
534 */
Peter Zijlstra89a09142007-03-16 13:38:26 -0800535extern int nfs_congestion_kb;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536extern int nfs_writepage(struct page *page, struct writeback_control *wbc);
537extern int nfs_writepages(struct address_space *, struct writeback_control *);
538extern int nfs_flush_incompatible(struct file *file, struct page *page);
539extern int nfs_updatepage(struct file *, struct page *, unsigned int, unsigned int);
Fred Isaman13602892011-02-11 15:42:38 +0000540extern void nfs_writeback_done(struct rpc_task *, struct nfs_write_data *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541
542/*
543 * Try to write back everything synchronously (but check the
544 * return value!)
545 */
Trond Myklebust1c759502006-10-09 16:18:38 -0400546extern int nfs_wb_all(struct inode *inode);
547extern int nfs_wb_page(struct inode *inode, struct page* page);
Trond Myklebust1b3b4a12007-08-28 10:29:36 -0400548extern int nfs_wb_page_cancel(struct inode *inode, struct page* page);
Bryan Schumaker89d77c82012-07-30 16:05:25 -0400549#if IS_ENABLED(CONFIG_NFS_V3) || IS_ENABLED(CONFIG_NFS_V4)
Trond Myklebustb608b282010-07-30 15:31:54 -0400550extern int nfs_commit_inode(struct inode *, int);
Fred Isaman0b7c0152012-04-20 14:47:39 -0400551extern struct nfs_commit_data *nfs_commitdata_alloc(void);
552extern void nfs_commit_free(struct nfs_commit_data *data);
Trond Myklebust77a63f32010-08-01 13:40:40 -0400553#else
554static inline int
555nfs_commit_inode(struct inode *inode, int how)
556{
557 return 0;
558}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559#endif
560
561static inline int
562nfs_have_writebacks(struct inode *inode)
563{
564 return NFS_I(inode)->npages != 0;
565}
566
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568 * linux/fs/nfs/read.c
569 */
570extern int nfs_readpage(struct file *, struct page *);
571extern int nfs_readpages(struct file *, struct address_space *,
572 struct list_head *, unsigned);
Trond Myklebustec06c092006-03-20 13:44:27 -0500573extern int nfs_readpage_result(struct rpc_task *, struct nfs_read_data *);
David Howellsf42b2932009-04-03 16:42:44 +0100574extern int nfs_readpage_async(struct nfs_open_context *, struct inode *,
575 struct page *);
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100576
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577/*
Andreas Gruenbacherb7fa0552005-06-22 17:16:27 +0000578 * linux/fs/nfs3proc.c
579 */
580#ifdef CONFIG_NFS_V3_ACL
581extern struct posix_acl *nfs3_proc_getacl(struct inode *inode, int type);
582extern int nfs3_proc_setacl(struct inode *inode, int type,
583 struct posix_acl *acl);
Andreas Gruenbacher055ffbe2005-06-22 17:16:27 +0000584extern int nfs3_proc_set_default_acl(struct inode *dir, struct inode *inode,
Al Virod3fb6122011-07-23 18:37:50 -0400585 umode_t mode);
Andreas Gruenbacher5c6a9f72005-06-22 17:16:27 +0000586extern void nfs3_forget_cached_acls(struct inode *inode);
Andreas Gruenbacher055ffbe2005-06-22 17:16:27 +0000587#else
588static inline int nfs3_proc_set_default_acl(struct inode *dir,
589 struct inode *inode,
Al Virod3fb6122011-07-23 18:37:50 -0400590 umode_t mode)
Andreas Gruenbacher055ffbe2005-06-22 17:16:27 +0000591{
592 return 0;
593}
Andreas Gruenbacher5c6a9f72005-06-22 17:16:27 +0000594
595static inline void nfs3_forget_cached_acls(struct inode *inode)
596{
597}
Andreas Gruenbacherb7fa0552005-06-22 17:16:27 +0000598#endif /* CONFIG_NFS_V3_ACL */
599
600/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601 * inline functions
602 */
603
Chuck Lever433c9232007-07-01 12:12:14 -0400604static inline loff_t nfs_size_to_loff_t(__u64 size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605{
Chuck Lever433c9232007-07-01 12:12:14 -0400606 if (size > (__u64) OFFSET_MAX - 1)
607 return OFFSET_MAX - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608 return (loff_t) size;
609}
610
611static inline ino_t
612nfs_fileid_to_ino_t(u64 fileid)
613{
614 ino_t ino = (ino_t) fileid;
615 if (sizeof(ino_t) < sizeof(u64))
616 ino ^= fileid >> (sizeof(u64)-sizeof(ino_t)) * 8;
617 return ino;
618}
619
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620#define NFS_JUKEBOX_RETRY_TIME (5 * HZ)
621
Benny Halevy4dc2eae2006-12-20 22:29:46 +0200622
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623# undef ifdebug
624# ifdef NFS_DEBUG
625# define ifdebug(fac) if (unlikely(nfs_debug & NFSDBG_##fac))
Trond Myklebust6f008662012-03-20 14:12:46 -0400626# define NFS_IFDEBUG(x) x
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627# else
628# define ifdebug(fac) if (0)
Trond Myklebust6f008662012-03-20 14:12:46 -0400629# define NFS_IFDEBUG(x)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630# endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631#endif