blob: f0015f801a7845890332dbafda8279dc1a34b53c [file] [log] [blame]
Greg Kroah-Hartmanb2441312017-11-01 15:07:57 +01001/* SPDX-License-Identifier: GPL-2.0 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
3 * linux/include/linux/nfs_fs.h
4 *
5 * Copyright (C) 1992 Rick Sladkey
6 *
7 * OS-specific nfs filesystem definitions and declarations
8 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07009#ifndef _LINUX_NFS_FS_H
10#define _LINUX_NFS_FS_H
11
David Howells607ca462012-10-13 10:46:48 +010012#include <uapi/linux/nfs_fs.h>
Jeff Garzike18fa702006-09-24 11:13:19 -040013
David Woodhouse7f1cbe52006-09-12 20:36:02 -070014
Trond Myklebuste27d3592012-03-18 14:07:42 -040015/*
16 * Enable dprintk() debugging support for nfs client.
17 */
18#ifdef CONFIG_NFS_DEBUG
19# define NFS_DEBUG
20#endif
21
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include <linux/in.h>
23#include <linux/mm.h>
24#include <linux/pagemap.h>
Trond Myklebust1c3c07e2006-07-25 11:28:18 -040025#include <linux/rbtree.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070026#include <linux/rwsem.h>
27#include <linux/wait.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070028
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#include <linux/sunrpc/debug.h>
30#include <linux/sunrpc/auth.h>
31#include <linux/sunrpc/clnt.h>
32
33#include <linux/nfs.h>
34#include <linux/nfs2.h>
35#include <linux/nfs3.h>
36#include <linux/nfs4.h>
37#include <linux/nfs_xdr.h>
Trond Myklebust8b4bdcf2006-06-09 09:34:19 -040038#include <linux/nfs_fs_sb.h>
39
Linus Torvalds1da177e2005-04-16 15:20:36 -070040#include <linux/mempool.h>
41
42/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070043 * These are the default flags for swap requests
44 */
45#define NFS_RPC_SWAPFLAGS (RPC_TASK_SWAPPER|RPC_TASK_ROOTCREDS)
46
Linus Torvalds1da177e2005-04-16 15:20:36 -070047/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070048 * NFSv3/v4 Access mode cache entry
49 */
50struct nfs_access_entry {
Trond Myklebust1c3c07e2006-07-25 11:28:18 -040051 struct rb_node rb_node;
Trond Myklebustcfcea3e2006-07-25 11:28:18 -040052 struct list_head lru;
Linus Torvalds1da177e2005-04-16 15:20:36 -070053 struct rpc_cred * cred;
Trond Myklebustbd8b2442017-07-11 17:54:34 -040054 __u32 mask;
NeilBrownf682a392014-07-14 11:28:20 +100055 struct rcu_head rcu_head;
Linus Torvalds1da177e2005-04-16 15:20:36 -070056};
57
Trond Myklebustf11ac8d2010-06-25 16:35:53 -040058struct nfs_lock_context {
59 atomic_t count;
60 struct list_head list;
61 struct nfs_open_context *open_context;
NeilBrownd51fdb82016-10-13 15:26:47 +110062 fl_owner_t lockowner;
Benjamin Coddington210c7c12016-01-06 10:40:18 -050063 atomic_t io_count;
Trond Myklebustf11ac8d2010-06-25 16:35:53 -040064};
65
Linus Torvalds1da177e2005-04-16 15:20:36 -070066struct nfs4_state;
67struct nfs_open_context {
Trond Myklebustf11ac8d2010-06-25 16:35:53 -040068 struct nfs_lock_context lock_context;
NeilBrown532d4de2016-10-13 15:26:47 +110069 fl_owner_t flock_owner;
Al Viro3d4ff432011-06-22 18:40:12 -040070 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -070071 struct rpc_cred *cred;
72 struct nfs4_state *state;
Trond Myklebustdc0b0272008-12-23 15:21:56 -050073 fmode_t mode;
Trond Myklebust7b159fc2007-07-25 14:09:54 -040074
75 unsigned long flags;
76#define NFS_CONTEXT_ERROR_WRITE (0)
Trond Myklebust05990d12012-09-11 16:01:22 -040077#define NFS_CONTEXT_RESEND_WRITES (1)
Trond Myklebustc58c8442013-03-18 19:45:14 -040078#define NFS_CONTEXT_BAD (2)
Benjamin Coddington7d6ddf82017-04-11 12:50:10 -040079#define NFS_CONTEXT_UNLOCK (3)
Linus Torvalds1da177e2005-04-16 15:20:36 -070080 int error;
81
82 struct list_head list;
Andy Adamson82be4172012-05-23 05:02:35 -040083 struct nfs4_threshold *mdsthreshold;
Bryan Schumaker480c2002011-03-23 14:48:29 -040084};
Olivier Galibert00a92642005-06-22 17:16:29 +000085
Bryan Schumaker480c2002011-03-23 14:48:29 -040086struct nfs_open_dir_context {
Trond Myklebust311324a2014-02-07 17:02:08 -050087 struct list_head list;
Bryan Schumaker480c2002011-03-23 14:48:29 -040088 struct rpc_cred *cred;
Trond Myklebust0c030802011-07-30 12:45:35 -040089 unsigned long attr_gencount;
Olivier Galibert00a92642005-06-22 17:16:29 +000090 __u64 dir_cookie;
Bryan Schumaker8ef2ce32011-03-23 15:04:31 -040091 __u64 dup_cookie;
Trond Myklebust0c030802011-07-30 12:45:35 -040092 signed char duped;
Linus Torvalds1da177e2005-04-16 15:20:36 -070093};
94
95/*
96 * NFSv4 delegation
97 */
98struct nfs_delegation;
99
Andreas Gruenbacher5c6a9f72005-06-22 17:16:27 +0000100struct posix_acl;
101
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102/*
103 * nfs fs inode data in memory
104 */
105struct nfs_inode {
106 /*
107 * The 64bit 'inode number'
108 */
109 __u64 fileid;
110
111 /*
112 * NFS file handle
113 */
114 struct nfs_fh fh;
115
116 /*
117 * Various flags
118 */
Chuck Lever412d5822005-08-18 11:24:11 -0700119 unsigned long flags; /* atomic bit ops */
120 unsigned long cache_validity; /* bit mask */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121
122 /*
Goldwyn Rodrigues24bd68f2006-03-20 13:44:11 -0500123 * read_cache_jiffies is when we started read-caching this inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124 * attrtimeo is for how long the cached information is assumed
125 * to be valid. A successful attribute revalidation doubles
126 * attrtimeo (up to acregmax/acdirmax), a failure resets it to
127 * acregmin/acdirmin.
128 *
129 * We need to revalidate the cached attrs for this inode if
130 *
Peter Staubach64672d52008-12-23 15:21:56 -0500131 * jiffies - read_cache_jiffies >= attrtimeo
132 *
133 * Please note the comparison is greater than or equal
134 * so that zero timeout values can be specified.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136 unsigned long read_cache_jiffies;
137 unsigned long attrtimeo;
138 unsigned long attrtimeo_timestamp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139
Trond Myklebust4704f0e2008-10-14 19:16:07 -0400140 unsigned long attr_gencount;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141 /* "Generation counter" for the attribute cache. This is
142 * bumped whenever we update the metadata on the
143 * server.
144 */
145 unsigned long cache_change_attribute;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146
Trond Myklebust1c3c07e2006-07-25 11:28:18 -0400147 struct rb_root access_cache;
Trond Myklebustcfcea3e2006-07-25 11:28:18 -0400148 struct list_head access_cache_entry_lru;
149 struct list_head access_cache_inode_lru;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150
151 /*
152 * This is the cookie verifier used for NFSv3 readdir
153 * operations
154 */
Al Virobc4785c2006-10-19 23:28:51 -0700155 __be32 cookieverf[2];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156
Trond Myklebusta6b6d5b2017-08-01 15:39:46 -0400157 atomic_long_t nrequests;
Fred Isamanea2cf222012-04-20 14:47:53 -0400158 struct nfs_mds_commit_info commit_info;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159
160 /* Open contexts for shared mmap writes */
161 struct list_head open_files;
162
Al Viro884be172016-04-28 23:56:31 -0400163 /* Readers: in-flight sillydelete RPC calls */
164 /* Writers: rmdir */
165 struct rw_semaphore rmdir_sem;
Trond Myklebuste824f992017-08-01 11:53:49 -0400166 struct mutex commit_mutex;
Trond Myklebust565277f2007-10-15 18:17:53 -0400167
Bryan Schumaker89d77c82012-07-30 16:05:25 -0400168#if IS_ENABLED(CONFIG_NFS_V4)
J. Bruce Fieldse50a1c22005-06-22 17:16:23 +0000169 struct nfs4_cached_acl *nfs4_acl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170 /* NFSv4 state */
171 struct list_head open_states;
Arnd Bergmann5b222162010-03-03 10:20:10 +0100172 struct nfs_delegation __rcu *delegation;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173 struct rw_semaphore rwsem;
Benny Halevye5e94012010-10-20 00:18:01 -0400174
175 /* pNFS layout information */
176 struct pnfs_layout_hdr *layout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177#endif /* CONFIG_NFS_V4*/
Andy Adamson2701d082012-05-24 13:13:24 -0400178 /* how many bytes have been written/read and how many bytes queued up */
179 __u64 write_io;
180 __u64 read_io;
David Howellsef79c092009-04-03 16:42:43 +0100181#ifdef CONFIG_NFS_FSCACHE
182 struct fscache_cookie *fscache;
183#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184 struct inode vfs_inode;
185};
186
187/*
Chuck Lever55296802005-08-18 11:24:09 -0700188 * Cache validity bit flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189 */
Chuck Lever55296802005-08-18 11:24:09 -0700190#define NFS_INO_INVALID_ATTR 0x0001 /* cached attrs are invalid */
191#define NFS_INO_INVALID_DATA 0x0002 /* cached data is invalid */
192#define NFS_INO_INVALID_ATIME 0x0004 /* cached atime is invalid */
193#define NFS_INO_INVALID_ACCESS 0x0008 /* cached access cred invalid */
194#define NFS_INO_INVALID_ACL 0x0010 /* cached acls are invalid */
195#define NFS_INO_REVAL_PAGECACHE 0x0020 /* must revalidate pagecache */
Trond Myklebust412c77c2007-07-03 16:10:55 -0400196#define NFS_INO_REVAL_FORCED 0x0040 /* force revalidation ignoring a delegation */
David Quigleyaa9c2662013-05-22 12:50:44 -0400197#define NFS_INO_INVALID_LABEL 0x0080 /* cached label is invalid */
Chuck Lever55296802005-08-18 11:24:09 -0700198
199/*
Chuck Lever412d5822005-08-18 11:24:11 -0700200 * Bit offsets in flags field
Chuck Lever55296802005-08-18 11:24:09 -0700201 */
Trond Myklebust691beb12008-10-05 14:48:22 -0400202#define NFS_INO_ADVISE_RDPLUS (0) /* advise readdirplus */
203#define NFS_INO_STALE (1) /* possible stale inode */
204#define NFS_INO_ACL_LRU_SET (2) /* Inode is on the LRU list */
Jeff Laytond529ef82014-01-27 13:46:15 -0500205#define NFS_INO_INVALIDATING (3) /* inode is being invalidated */
David Howellsef79c092009-04-03 16:42:43 +0100206#define NFS_INO_FSCACHE (5) /* inode can be cached by FS-Cache */
207#define NFS_INO_FSCACHE_LOCK (6) /* FS-Cache cookie management lock */
Andy Adamson863a3c62011-03-23 13:27:54 +0000208#define NFS_INO_LAYOUTCOMMIT (9) /* layoutcommit required */
Peng Tao92407e72011-10-23 20:21:17 -0700209#define NFS_INO_LAYOUTCOMMITTING (10) /* layoutcommit inflight */
Peng Tao1bfe3b22015-06-23 19:52:03 +0800210#define NFS_INO_LAYOUTSTATS (11) /* layoutstats inflight */
Trond Myklebusta5864c92016-06-03 17:07:19 -0400211#define NFS_INO_ODIRECT (12) /* I/O setting is O_DIRECT */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212
Benny Halevy99fadcd2008-01-23 08:59:08 +0200213static inline struct nfs_inode *NFS_I(const struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214{
215 return container_of(inode, struct nfs_inode, vfs_inode);
216}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217
Benny Halevy99fadcd2008-01-23 08:59:08 +0200218static inline struct nfs_server *NFS_SB(const struct super_block *s)
219{
220 return (struct nfs_server *)(s->s_fs_info);
221}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222
Benny Halevy99fadcd2008-01-23 08:59:08 +0200223static inline struct nfs_fh *NFS_FH(const struct inode *inode)
224{
225 return &NFS_I(inode)->fh;
226}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227
Benny Halevy99fadcd2008-01-23 08:59:08 +0200228static inline struct nfs_server *NFS_SERVER(const struct inode *inode)
229{
230 return NFS_SB(inode->i_sb);
231}
232
233static inline struct rpc_clnt *NFS_CLIENT(const struct inode *inode)
234{
235 return NFS_SERVER(inode)->client;
236}
237
238static inline const struct nfs_rpc_ops *NFS_PROTO(const struct inode *inode)
239{
240 return NFS_SERVER(inode)->nfs_client->rpc_ops;
241}
242
Benny Halevy99fadcd2008-01-23 08:59:08 +0200243static inline unsigned NFS_MINATTRTIMEO(const struct inode *inode)
244{
245 struct nfs_server *nfss = NFS_SERVER(inode);
246 return S_ISDIR(inode->i_mode) ? nfss->acdirmin : nfss->acregmin;
247}
248
249static inline unsigned NFS_MAXATTRTIMEO(const struct inode *inode)
250{
251 struct nfs_server *nfss = NFS_SERVER(inode);
252 return S_ISDIR(inode->i_mode) ? nfss->acdirmax : nfss->acregmax;
253}
254
255static inline int NFS_STALE(const struct inode *inode)
256{
257 return test_bit(NFS_INO_STALE, &NFS_I(inode)->flags);
258}
259
David Howellsf1fe29b2013-09-27 11:20:03 +0100260static inline struct fscache_cookie *nfs_i_fscache(struct inode *inode)
David Howellsef79c092009-04-03 16:42:43 +0100261{
David Howellsf1fe29b2013-09-27 11:20:03 +0100262#ifdef CONFIG_NFS_FSCACHE
263 return NFS_I(inode)->fscache;
264#else
265 return NULL;
266#endif
David Howellsef79c092009-04-03 16:42:43 +0100267}
268
Benny Halevy99fadcd2008-01-23 08:59:08 +0200269static inline __u64 NFS_FILEID(const struct inode *inode)
270{
271 return NFS_I(inode)->fileid;
272}
273
274static inline void set_nfs_fileid(struct inode *inode, __u64 fileid)
275{
276 NFS_I(inode)->fileid = fileid;
277}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278
Trond Myklebustdecf4912005-10-27 22:12:39 -0400279static inline void nfs_mark_for_revalidate(struct inode *inode)
280{
Trond Myklebust38478b22006-05-25 01:40:57 -0400281 struct nfs_inode *nfsi = NFS_I(inode);
282
Trond Myklebustdecf4912005-10-27 22:12:39 -0400283 spin_lock(&inode->i_lock);
Trond Myklebust115c48d2015-07-05 12:36:34 -0400284 nfsi->cache_validity |= NFS_INO_INVALID_ATTR |
285 NFS_INO_REVAL_PAGECACHE |
286 NFS_INO_INVALID_ACCESS |
287 NFS_INO_INVALID_ACL;
Trond Myklebustf3821112007-10-01 10:00:23 -0400288 if (S_ISDIR(inode->i_mode))
Trond Myklebust115c48d2015-07-05 12:36:34 -0400289 nfsi->cache_validity |= NFS_INO_INVALID_DATA;
Trond Myklebustdecf4912005-10-27 22:12:39 -0400290 spin_unlock(&inode->i_lock);
291}
292
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293static inline int nfs_server_capable(struct inode *inode, int cap)
294{
295 return NFS_SERVER(inode)->caps & cap;
296}
297
Trond Myklebustd75340c2007-10-01 21:42:01 -0400298static inline void nfs_set_verifier(struct dentry * dentry, unsigned long verf)
299{
300 dentry->d_time = verf;
301}
302
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303/**
304 * nfs_save_change_attribute - Returns the inode attribute change cookie
Trond Myklebust8edb0182007-09-29 17:14:03 -0400305 * @dir - pointer to parent directory inode
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306 * The "change attribute" is updated every time we finish an operation
307 * that will result in a metadata change on the server.
308 */
Trond Myklebust8edb0182007-09-29 17:14:03 -0400309static inline unsigned long nfs_save_change_attribute(struct inode *dir)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310{
Trond Myklebust8edb0182007-09-29 17:14:03 -0400311 return NFS_I(dir)->cache_change_attribute;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312}
313
314/**
Trond Myklebust4b841732007-09-29 17:15:01 -0400315 * nfs_verify_change_attribute - Detects NFS remote directory changes
316 * @dir - pointer to parent directory inode
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317 * @chattr - previously saved change attribute
Trond Myklebust4b841732007-09-29 17:15:01 -0400318 * Return "false" if the verifiers doesn't match the change attribute.
319 * This would usually indicate that the directory contents have changed on
320 * the server, and that any dentries need revalidating.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321 */
Trond Myklebust4b841732007-09-29 17:15:01 -0400322static inline int nfs_verify_change_attribute(struct inode *dir, unsigned long chattr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323{
Trond Myklebust4b841732007-09-29 17:15:01 -0400324 return chattr == NFS_I(dir)->cache_change_attribute;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325}
326
327/*
328 * linux/fs/nfs/inode.c
329 */
Trond Myklebust29884df2005-12-13 16:13:54 -0500330extern int nfs_sync_mapping(struct address_space *mapping);
Trond Myklebustcd9ae2b2006-10-19 23:28:40 -0700331extern void nfs_zap_mapping(struct inode *inode, struct address_space *mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332extern void nfs_zap_caches(struct inode *);
Trond Myklebustc4812992007-09-28 17:11:45 -0400333extern void nfs_invalidate_atime(struct inode *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334extern struct inode *nfs_fhget(struct super_block *, struct nfs_fh *,
David Quigley1775fd32013-05-22 12:50:42 -0400335 struct nfs_fattr *, struct nfs4_label *);
Peng Taof174ff72017-06-29 06:34:51 -0700336struct inode *nfs_ilookup(struct super_block *sb, struct nfs_fattr *, struct nfs_fh *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337extern int nfs_refresh_inode(struct inode *, struct nfs_fattr *);
Trond Myklebustdecf4912005-10-27 22:12:39 -0400338extern int nfs_post_op_update_inode(struct inode *inode, struct nfs_fattr *fattr);
Trond Myklebust70ca8852007-09-30 15:21:24 -0400339extern int nfs_post_op_update_inode_force_wcc(struct inode *inode, struct nfs_fattr *fattr);
Trond Myklebusta08a8cd2015-02-26 17:36:09 -0500340extern int nfs_post_op_update_inode_force_wcc_locked(struct inode *inode, struct nfs_fattr *fattr);
David Howellsa528d352017-01-31 16:46:22 +0000341extern int nfs_getattr(const struct path *, struct kstat *, u32, unsigned int);
Weston Andros Adamson6168f622012-09-10 14:00:46 -0400342extern void nfs_access_add_cache(struct inode *, struct nfs_access_entry *);
343extern void nfs_access_set_mask(struct nfs_access_entry *, u32);
Al Viro10556cb2011-06-20 19:28:19 -0400344extern int nfs_permission(struct inode *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345extern int nfs_open(struct inode *, struct file *);
Scott Mayhew43f291c2013-07-05 17:49:30 -0400346extern int nfs_attribute_cache_expired(struct inode *inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347extern int nfs_revalidate_inode(struct nfs_server *server, struct inode *inode);
348extern int __nfs_revalidate_inode(struct nfs_server *, struct inode *);
Trond Myklebust1cd9cb02016-12-04 18:34:34 -0500349extern bool nfs_mapping_need_revalidate_inode(struct inode *inode);
Trond Myklebust44b11872006-05-25 01:40:59 -0400350extern int nfs_revalidate_mapping(struct inode *inode, struct address_space *mapping);
Al Viro0d0def42015-11-17 21:14:24 -0500351extern int nfs_revalidate_mapping_rcu(struct inode *inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352extern int nfs_setattr(struct dentry *, struct iattr *);
Trond Myklebustf0446362015-02-26 16:09:04 -0500353extern void nfs_setattr_update_inode(struct inode *inode, struct iattr *attr, struct nfs_fattr *);
David Quigleyaa9c2662013-05-22 12:50:44 -0400354extern void nfs_setsecurity(struct inode *inode, struct nfs_fattr *fattr,
355 struct nfs4_label *label);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356extern struct nfs_open_context *get_nfs_open_context(struct nfs_open_context *ctx);
357extern void put_nfs_open_context(struct nfs_open_context *ctx);
Trond Myklebustdc0b0272008-12-23 15:21:56 -0500358extern struct nfs_open_context *nfs_find_open_context(struct inode *inode, struct rpc_cred *cred, fmode_t mode);
NeilBrown532d4de2016-10-13 15:26:47 +1100359extern struct nfs_open_context *alloc_nfs_open_context(struct dentry *dentry, fmode_t f_mode, struct file *filp);
Trond Myklebustc45ffdd2013-05-29 13:34:46 -0400360extern void nfs_inode_attach_open_context(struct nfs_open_context *ctx);
Trond Myklebustcd9a1c02010-09-17 10:56:50 -0400361extern void nfs_file_set_open_context(struct file *filp, struct nfs_open_context *ctx);
Anna Schumakeraff8d8d2015-07-13 14:01:33 -0400362extern void nfs_file_clear_open_context(struct file *flip);
Trond Myklebustf11ac8d2010-06-25 16:35:53 -0400363extern struct nfs_lock_context *nfs_get_lock_context(struct nfs_open_context *ctx);
364extern void nfs_put_lock_context(struct nfs_lock_context *l_ctx);
Trond Myklebustf43bf0b2007-10-09 12:01:04 -0400365extern u64 nfs_compat_user_ino64(u64 fileid);
Trond Myklebust4704f0e2008-10-14 19:16:07 -0400366extern void nfs_fattr_init(struct nfs_fattr *fattr);
Trond Myklebust140e0492015-02-26 17:42:42 -0500367extern void nfs_fattr_set_barrier(struct nfs_fattr *fattr);
Chuck Lever56463e52010-09-17 10:54:37 -0400368extern unsigned long nfs_inc_attr_generation_counter(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369
Trond Myklebust2d36bfde2010-04-16 16:22:45 -0400370extern struct nfs_fattr *nfs_alloc_fattr(void);
371
372static inline void nfs_free_fattr(const struct nfs_fattr *fattr)
373{
374 kfree(fattr);
375}
376
377extern struct nfs_fh *nfs_alloc_fhandle(void);
378
379static inline void nfs_free_fhandle(const struct nfs_fh *fh)
380{
381 kfree(fh);
382}
383
Trond Myklebuste27d3592012-03-18 14:07:42 -0400384#ifdef NFS_DEBUG
Weston Andros Adamsond8e05392012-03-06 20:46:43 -0500385extern u32 _nfs_display_fhandle_hash(const struct nfs_fh *fh);
386static inline u32 nfs_display_fhandle_hash(const struct nfs_fh *fh)
387{
388 return _nfs_display_fhandle_hash(fh);
389}
Chuck Lever20d27e92012-03-01 17:01:31 -0500390extern void _nfs_display_fhandle(const struct nfs_fh *fh, const char *caption);
391#define nfs_display_fhandle(fh, caption) \
392 do { \
393 if (unlikely(nfs_debug & NFSDBG_FACILITY)) \
394 _nfs_display_fhandle(fh, caption); \
395 } while (0)
396#else
Weston Andros Adamsond8e05392012-03-06 20:46:43 -0500397static inline u32 nfs_display_fhandle_hash(const struct nfs_fh *fh)
398{
Stephen Rothwell9304a812012-03-20 19:26:42 +1100399 return 0;
Weston Andros Adamsond8e05392012-03-06 20:46:43 -0500400}
Chuck Lever20d27e92012-03-01 17:01:31 -0500401static inline void nfs_display_fhandle(const struct nfs_fh *fh,
402 const char *caption)
403{
404}
405#endif
406
Chuck Lever56463e52010-09-17 10:54:37 -0400407/*
408 * linux/fs/nfs/nfsroot.c
409 */
410extern int nfs_root_data(char **root_device, char **root_data); /*__init*/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411/* linux/net/ipv4/ipconfig.c: trims ip addr off front of name, too. */
Al Viro5a874db2006-11-08 00:19:38 -0800412extern __be32 root_nfs_parse_addr(char *name); /*__init*/
Trond Myklebust0e574af2005-10-27 22:12:38 -0400413
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414/*
415 * linux/fs/nfs/file.c
416 */
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -0800417extern const struct file_operations nfs_file_operations;
Bryan Schumaker89d77c82012-07-30 16:05:25 -0400418#if IS_ENABLED(CONFIG_NFS_V4)
Jeff Layton1788ea62011-11-04 13:31:21 -0400419extern const struct file_operations nfs4_file_operations;
420#endif /* CONFIG_NFS_V4 */
Christoph Hellwigf5e54d62006-06-28 04:26:44 -0700421extern const struct address_space_operations nfs_file_aops;
Trond Myklebust11de3b12010-12-01 14:17:06 -0500422extern const struct address_space_operations nfs_dir_aops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423
Trond Myklebustc03025d2007-08-10 17:44:28 -0400424static inline struct nfs_open_context *nfs_file_open_context(struct file *filp)
425{
426 return filp->private_data;
427}
428
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429static inline struct rpc_cred *nfs_file_cred(struct file *file)
430{
Neil Brown504e5182008-10-16 14:15:16 +1100431 if (file != NULL) {
432 struct nfs_open_context *ctx =
433 nfs_file_open_context(file);
434 if (ctx)
435 return ctx->cred;
436 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437 return NULL;
438}
439
440/*
441 * linux/fs/nfs/direct.c
442 */
Christoph Hellwigc8b8e322016-04-07 08:51:58 -0700443extern ssize_t nfs_direct_IO(struct kiocb *, struct iov_iter *);
Badari Pulavarty027445c2006-09-30 23:28:46 -0700444extern ssize_t nfs_file_direct_read(struct kiocb *iocb,
Christoph Hellwigc8b8e322016-04-07 08:51:58 -0700445 struct iov_iter *iter);
Badari Pulavarty027445c2006-09-30 23:28:46 -0700446extern ssize_t nfs_file_direct_write(struct kiocb *iocb,
Al Viro65a4a1c2015-04-09 14:11:08 -0400447 struct iov_iter *iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448
449/*
450 * linux/fs/nfs/dir.c
451 */
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -0800452extern const struct file_operations nfs_dir_operations;
Al Virof786aa92009-02-20 05:51:22 +0000453extern const struct dentry_operations nfs_dentry_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454
Trond Myklebustbfc69a42007-10-15 18:18:29 -0400455extern void nfs_force_lookup_revalidate(struct inode *dir);
David Quigley1775fd32013-05-22 12:50:42 -0400456extern int nfs_instantiate(struct dentry *dentry, struct nfs_fh *fh,
457 struct nfs_fattr *fattr, struct nfs4_label *label);
Trond Myklebustaf22f942007-08-10 17:45:10 -0400458extern int nfs_may_open(struct inode *inode, struct rpc_cred *cred, int openflags);
459extern void nfs_access_zap_cache(struct inode *inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460
461/*
462 * linux/fs/nfs/symlink.c
463 */
Arjan van de Venc5ef1c42007-02-12 00:55:40 -0800464extern const struct inode_operations nfs_symlink_inode_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465
466/*
Trond Myklebusta72b4422006-01-03 09:55:41 +0100467 * linux/fs/nfs/sysctl.c
468 */
469#ifdef CONFIG_SYSCTL
470extern int nfs_register_sysctl(void);
471extern void nfs_unregister_sysctl(void);
472#else
Stephen Rothwell7fd105e2006-02-20 18:28:08 -0800473#define nfs_register_sysctl() 0
Trond Myklebusta72b4422006-01-03 09:55:41 +0100474#define nfs_unregister_sysctl() do { } while(0)
475#endif
476
477/*
Trond Myklebust55a97592006-06-09 09:34:19 -0400478 * linux/fs/nfs/namespace.c
479 */
Arjan van de Venc5ef1c42007-02-12 00:55:40 -0800480extern const struct inode_operations nfs_mountpoint_inode_operations;
481extern const struct inode_operations nfs_referral_inode_operations;
Trond Myklebust51d8fa62006-06-09 09:34:20 -0400482extern int nfs_mountpoint_expiry_timeout;
483extern void nfs_release_automount_timer(void);
Trond Myklebust55a97592006-06-09 09:34:19 -0400484
485/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486 * linux/fs/nfs/unlink.c
487 */
Trond Myklebuste4eff1a2007-07-14 15:39:58 -0400488extern void nfs_complete_unlink(struct dentry *dentry, struct inode *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489
490/*
491 * linux/fs/nfs/write.c
492 */
Peter Zijlstra89a09142007-03-16 13:38:26 -0800493extern int nfs_congestion_kb;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494extern int nfs_writepage(struct page *page, struct writeback_control *wbc);
495extern int nfs_writepages(struct address_space *, struct writeback_control *);
496extern int nfs_flush_incompatible(struct file *file, struct page *page);
497extern int nfs_updatepage(struct file *, struct page *, unsigned int, unsigned int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498
499/*
500 * Try to write back everything synchronously (but check the
501 * return value!)
502 */
Trond Myklebust9e1681c2015-03-25 17:23:31 -0400503extern int nfs_sync_inode(struct inode *inode);
Trond Myklebust1c759502006-10-09 16:18:38 -0400504extern int nfs_wb_all(struct inode *inode);
Trond Myklebustc373fff2017-04-26 12:26:22 -0400505extern int nfs_wb_page(struct inode *inode, struct page *page);
Trond Myklebust1b3b4a12007-08-28 10:29:36 -0400506extern int nfs_wb_page_cancel(struct inode *inode, struct page* page);
Trond Myklebustb608b282010-07-30 15:31:54 -0400507extern int nfs_commit_inode(struct inode *, int);
NeilBrown518662e2017-04-10 12:22:09 +1000508extern struct nfs_commit_data *nfs_commitdata_alloc(bool never_fail);
Fred Isaman0b7c0152012-04-20 14:47:39 -0400509extern void nfs_commit_free(struct nfs_commit_data *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510
511static inline int
512nfs_have_writebacks(struct inode *inode)
513{
Trond Myklebusta6b6d5b2017-08-01 15:39:46 -0400514 return atomic_long_read(&NFS_I(inode)->nrequests) != 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515}
516
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518 * linux/fs/nfs/read.c
519 */
520extern int nfs_readpage(struct file *, struct page *);
521extern int nfs_readpages(struct file *, struct address_space *,
522 struct list_head *, unsigned);
David Howellsf42b2932009-04-03 16:42:44 +0100523extern int nfs_readpage_async(struct nfs_open_context *, struct inode *,
524 struct page *);
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100525
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527 * inline functions
528 */
529
Chuck Lever433c9232007-07-01 12:12:14 -0400530static inline loff_t nfs_size_to_loff_t(__u64 size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531{
Christoph Hellwig50ab8ec2016-02-08 21:11:50 +0100532 return min_t(u64, size, OFFSET_MAX);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533}
534
535static inline ino_t
536nfs_fileid_to_ino_t(u64 fileid)
537{
538 ino_t ino = (ino_t) fileid;
539 if (sizeof(ino_t) < sizeof(u64))
540 ino ^= fileid >> (sizeof(u64)-sizeof(ino_t)) * 8;
541 return ino;
542}
543
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544#define NFS_JUKEBOX_RETRY_TIME (5 * HZ)
545
Benny Halevy4dc2eae2006-12-20 22:29:46 +0200546
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547# undef ifdebug
548# ifdef NFS_DEBUG
549# define ifdebug(fac) if (unlikely(nfs_debug & NFSDBG_##fac))
Trond Myklebust6f008662012-03-20 14:12:46 -0400550# define NFS_IFDEBUG(x) x
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551# else
552# define ifdebug(fac) if (0)
Trond Myklebust6f008662012-03-20 14:12:46 -0400553# define NFS_IFDEBUG(x)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554# endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555#endif