Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
1/* SPDX-License-Identifier: GPL-2.0 */
2/*
3 * linux/include/linux/nfs_fs.h
4 *
5 * Copyright (C) 1992 Rick Sladkey
6 *
7 * OS-specific nfs filesystem definitions and declarations
8 */
9#ifndef _LINUX_NFS_FS_H
10#define _LINUX_NFS_FS_H
11
12#include <uapi/linux/nfs_fs.h>
13
14
15/*
16 * Enable dprintk() debugging support for nfs client.
17 */
18#ifdef CONFIG_NFS_DEBUG
19# define NFS_DEBUG
20#endif
21
22#include <linux/in.h>
23#include <linux/mm.h>
24#include <linux/pagemap.h>
25#include <linux/rbtree.h>
26#include <linux/refcount.h>
27#include <linux/rwsem.h>
28#include <linux/wait.h>
29
30#include <linux/sunrpc/debug.h>
31#include <linux/sunrpc/auth.h>
32#include <linux/sunrpc/clnt.h>
33
34#include <linux/nfs.h>
35#include <linux/nfs2.h>
36#include <linux/nfs3.h>
37#include <linux/nfs4.h>
38#include <linux/nfs_xdr.h>
39#include <linux/nfs_fs_sb.h>
40
41#include <linux/mempool.h>
42
43/*
44 * These are the default flags for swap requests
45 */
46#define NFS_RPC_SWAPFLAGS (RPC_TASK_SWAPPER|RPC_TASK_ROOTCREDS)
47
48/*
49 * Size of the NFS directory verifier
50 */
51#define NFS_DIR_VERIFIER_SIZE 2
52
53/*
54 * NFSv3/v4 Access mode cache entry
55 */
56struct nfs_access_entry {
57 struct rb_node rb_node;
58 struct list_head lru;
59 const struct cred * cred;
60 __u32 mask;
61 struct rcu_head rcu_head;
62};
63
64struct nfs_lock_context {
65 refcount_t count;
66 struct list_head list;
67 struct nfs_open_context *open_context;
68 fl_owner_t lockowner;
69 atomic_t io_count;
70 struct rcu_head rcu_head;
71};
72
73struct nfs4_state;
74struct nfs_open_context {
75 struct nfs_lock_context lock_context;
76 fl_owner_t flock_owner;
77 struct dentry *dentry;
78 const struct cred *cred;
79 struct rpc_cred *ll_cred; /* low-level cred - use to check for expiry */
80 struct nfs4_state *state;
81 fmode_t mode;
82
83 unsigned long flags;
84#define NFS_CONTEXT_RESEND_WRITES (1)
85#define NFS_CONTEXT_BAD (2)
86#define NFS_CONTEXT_UNLOCK (3)
87 int error;
88
89 struct list_head list;
90 struct nfs4_threshold *mdsthreshold;
91 struct rcu_head rcu_head;
92};
93
94struct nfs_open_dir_context {
95 struct list_head list;
96 unsigned long attr_gencount;
97 __be32 verf[NFS_DIR_VERIFIER_SIZE];
98 __u64 dir_cookie;
99 __u64 dup_cookie;
100 signed char duped;
101};
102
103/*
104 * NFSv4 delegation
105 */
106struct nfs_delegation;
107
108struct posix_acl;
109
110struct nfs4_xattr_cache;
111
112/*
113 * nfs fs inode data in memory
114 */
115struct nfs_inode {
116 /*
117 * The 64bit 'inode number'
118 */
119 __u64 fileid;
120
121 /*
122 * NFS file handle
123 */
124 struct nfs_fh fh;
125
126 /*
127 * Various flags
128 */
129 unsigned long flags; /* atomic bit ops */
130 unsigned long cache_validity; /* bit mask */
131
132 /*
133 * read_cache_jiffies is when we started read-caching this inode.
134 * attrtimeo is for how long the cached information is assumed
135 * to be valid. A successful attribute revalidation doubles
136 * attrtimeo (up to acregmax/acdirmax), a failure resets it to
137 * acregmin/acdirmin.
138 *
139 * We need to revalidate the cached attrs for this inode if
140 *
141 * jiffies - read_cache_jiffies >= attrtimeo
142 *
143 * Please note the comparison is greater than or equal
144 * so that zero timeout values can be specified.
145 */
146 unsigned long read_cache_jiffies;
147 unsigned long attrtimeo;
148 unsigned long attrtimeo_timestamp;
149
150 unsigned long attr_gencount;
151 /* "Generation counter" for the attribute cache. This is
152 * bumped whenever we update the metadata on the
153 * server.
154 */
155 unsigned long cache_change_attribute;
156
157 struct rb_root access_cache;
158 struct list_head access_cache_entry_lru;
159 struct list_head access_cache_inode_lru;
160
161 /*
162 * This is the cookie verifier used for NFSv3 readdir
163 * operations
164 */
165 __be32 cookieverf[NFS_DIR_VERIFIER_SIZE];
166
167 atomic_long_t nrequests;
168 struct nfs_mds_commit_info commit_info;
169
170 /* Open contexts for shared mmap writes */
171 struct list_head open_files;
172
173 /* Readers: in-flight sillydelete RPC calls */
174 /* Writers: rmdir */
175 struct rw_semaphore rmdir_sem;
176 struct mutex commit_mutex;
177
178 /* track last access to cached pages */
179 unsigned long page_index;
180
181#if IS_ENABLED(CONFIG_NFS_V4)
182 struct nfs4_cached_acl *nfs4_acl;
183 /* NFSv4 state */
184 struct list_head open_states;
185 struct nfs_delegation __rcu *delegation;
186 struct rw_semaphore rwsem;
187
188 /* pNFS layout information */
189 struct pnfs_layout_hdr *layout;
190#endif /* CONFIG_NFS_V4*/
191 /* how many bytes have been written/read and how many bytes queued up */
192 __u64 write_io;
193 __u64 read_io;
194#ifdef CONFIG_NFS_FSCACHE
195 struct fscache_cookie *fscache;
196#endif
197 struct inode vfs_inode;
198
199#ifdef CONFIG_NFS_V4_2
200 struct nfs4_xattr_cache *xattr_cache;
201#endif
202};
203
204struct nfs4_copy_state {
205 struct list_head copies;
206 struct list_head src_copies;
207 nfs4_stateid stateid;
208 struct completion completion;
209 uint64_t count;
210 struct nfs_writeverf verf;
211 int error;
212 int flags;
213 struct nfs4_state *parent_src_state;
214 struct nfs4_state *parent_dst_state;
215};
216
217/*
218 * Access bit flags
219 */
220#define NFS_ACCESS_READ 0x0001
221#define NFS_ACCESS_LOOKUP 0x0002
222#define NFS_ACCESS_MODIFY 0x0004
223#define NFS_ACCESS_EXTEND 0x0008
224#define NFS_ACCESS_DELETE 0x0010
225#define NFS_ACCESS_EXECUTE 0x0020
226#define NFS_ACCESS_XAREAD 0x0040
227#define NFS_ACCESS_XAWRITE 0x0080
228#define NFS_ACCESS_XALIST 0x0100
229
230/*
231 * Cache validity bit flags
232 */
233#define NFS_INO_INVALID_DATA BIT(1) /* cached data is invalid */
234#define NFS_INO_INVALID_ATIME BIT(2) /* cached atime is invalid */
235#define NFS_INO_INVALID_ACCESS BIT(3) /* cached access cred invalid */
236#define NFS_INO_INVALID_ACL BIT(4) /* cached acls are invalid */
237#define NFS_INO_REVAL_PAGECACHE BIT(5) /* must revalidate pagecache */
238#define NFS_INO_REVAL_FORCED BIT(6) /* force revalidation ignoring a delegation */
239#define NFS_INO_INVALID_LABEL BIT(7) /* cached label is invalid */
240#define NFS_INO_INVALID_CHANGE BIT(8) /* cached change is invalid */
241#define NFS_INO_INVALID_CTIME BIT(9) /* cached ctime is invalid */
242#define NFS_INO_INVALID_MTIME BIT(10) /* cached mtime is invalid */
243#define NFS_INO_INVALID_SIZE BIT(11) /* cached size is invalid */
244#define NFS_INO_INVALID_OTHER BIT(12) /* other attrs are invalid */
245#define NFS_INO_DATA_INVAL_DEFER \
246 BIT(13) /* Deferred cache invalidation */
247#define NFS_INO_INVALID_BLOCKS BIT(14) /* cached blocks are invalid */
248#define NFS_INO_INVALID_XATTR BIT(15) /* xattrs are invalid */
249#define NFS_INO_INVALID_NLINK BIT(16) /* cached nlinks is invalid */
250#define NFS_INO_INVALID_MODE BIT(17) /* cached mode is invalid */
251
252#define NFS_INO_INVALID_ATTR (NFS_INO_INVALID_CHANGE \
253 | NFS_INO_INVALID_CTIME \
254 | NFS_INO_INVALID_MTIME \
255 | NFS_INO_INVALID_SIZE \
256 | NFS_INO_INVALID_NLINK \
257 | NFS_INO_INVALID_MODE \
258 | NFS_INO_INVALID_OTHER) /* inode metadata is invalid */
259
260/*
261 * Bit offsets in flags field
262 */
263#define NFS_INO_ADVISE_RDPLUS (0) /* advise readdirplus */
264#define NFS_INO_STALE (1) /* possible stale inode */
265#define NFS_INO_ACL_LRU_SET (2) /* Inode is on the LRU list */
266#define NFS_INO_INVALIDATING (3) /* inode is being invalidated */
267#define NFS_INO_FSCACHE (5) /* inode can be cached by FS-Cache */
268#define NFS_INO_FSCACHE_LOCK (6) /* FS-Cache cookie management lock */
269#define NFS_INO_LAYOUTCOMMIT (9) /* layoutcommit required */
270#define NFS_INO_LAYOUTCOMMITTING (10) /* layoutcommit inflight */
271#define NFS_INO_LAYOUTSTATS (11) /* layoutstats inflight */
272#define NFS_INO_ODIRECT (12) /* I/O setting is O_DIRECT */
273
274static inline struct nfs_inode *NFS_I(const struct inode *inode)
275{
276 return container_of(inode, struct nfs_inode, vfs_inode);
277}
278
279static inline struct nfs_server *NFS_SB(const struct super_block *s)
280{
281 return (struct nfs_server *)(s->s_fs_info);
282}
283
284static inline struct nfs_fh *NFS_FH(const struct inode *inode)
285{
286 return &NFS_I(inode)->fh;
287}
288
289static inline struct nfs_server *NFS_SERVER(const struct inode *inode)
290{
291 return NFS_SB(inode->i_sb);
292}
293
294static inline struct rpc_clnt *NFS_CLIENT(const struct inode *inode)
295{
296 return NFS_SERVER(inode)->client;
297}
298
299static inline const struct nfs_rpc_ops *NFS_PROTO(const struct inode *inode)
300{
301 return NFS_SERVER(inode)->nfs_client->rpc_ops;
302}
303
304static inline unsigned NFS_MINATTRTIMEO(const struct inode *inode)
305{
306 struct nfs_server *nfss = NFS_SERVER(inode);
307 return S_ISDIR(inode->i_mode) ? nfss->acdirmin : nfss->acregmin;
308}
309
310static inline unsigned NFS_MAXATTRTIMEO(const struct inode *inode)
311{
312 struct nfs_server *nfss = NFS_SERVER(inode);
313 return S_ISDIR(inode->i_mode) ? nfss->acdirmax : nfss->acregmax;
314}
315
316static inline int NFS_STALE(const struct inode *inode)
317{
318 return test_bit(NFS_INO_STALE, &NFS_I(inode)->flags);
319}
320
321static inline struct fscache_cookie *nfs_i_fscache(struct inode *inode)
322{
323#ifdef CONFIG_NFS_FSCACHE
324 return NFS_I(inode)->fscache;
325#else
326 return NULL;
327#endif
328}
329
330static inline __u64 NFS_FILEID(const struct inode *inode)
331{
332 return NFS_I(inode)->fileid;
333}
334
335static inline void set_nfs_fileid(struct inode *inode, __u64 fileid)
336{
337 NFS_I(inode)->fileid = fileid;
338}
339
340static inline void nfs_mark_for_revalidate(struct inode *inode)
341{
342 struct nfs_inode *nfsi = NFS_I(inode);
343
344 spin_lock(&inode->i_lock);
345 nfsi->cache_validity |= NFS_INO_REVAL_PAGECACHE
346 | NFS_INO_INVALID_ACCESS
347 | NFS_INO_INVALID_ACL
348 | NFS_INO_INVALID_CHANGE
349 | NFS_INO_INVALID_CTIME;
350 if (S_ISDIR(inode->i_mode))
351 nfsi->cache_validity |= NFS_INO_INVALID_DATA;
352 spin_unlock(&inode->i_lock);
353}
354
355static inline int nfs_server_capable(struct inode *inode, int cap)
356{
357 return NFS_SERVER(inode)->caps & cap;
358}
359
360/**
361 * nfs_save_change_attribute - Returns the inode attribute change cookie
362 * @dir - pointer to parent directory inode
363 * The "cache change attribute" is updated when we need to revalidate
364 * our dentry cache after a directory was seen to change on the server.
365 */
366static inline unsigned long nfs_save_change_attribute(struct inode *dir)
367{
368 return NFS_I(dir)->cache_change_attribute;
369}
370
371/*
372 * linux/fs/nfs/inode.c
373 */
374extern int nfs_sync_mapping(struct address_space *mapping);
375extern void nfs_zap_mapping(struct inode *inode, struct address_space *mapping);
376extern void nfs_zap_caches(struct inode *);
377extern void nfs_set_inode_stale(struct inode *inode);
378extern void nfs_invalidate_atime(struct inode *);
379extern struct inode *nfs_fhget(struct super_block *, struct nfs_fh *,
380 struct nfs_fattr *, struct nfs4_label *);
381struct inode *nfs_ilookup(struct super_block *sb, struct nfs_fattr *, struct nfs_fh *);
382extern int nfs_refresh_inode(struct inode *, struct nfs_fattr *);
383extern int nfs_post_op_update_inode(struct inode *inode, struct nfs_fattr *fattr);
384extern int nfs_post_op_update_inode_force_wcc(struct inode *inode, struct nfs_fattr *fattr);
385extern int nfs_post_op_update_inode_force_wcc_locked(struct inode *inode, struct nfs_fattr *fattr);
386extern int nfs_getattr(struct user_namespace *, const struct path *,
387 struct kstat *, u32, unsigned int);
388extern void nfs_access_add_cache(struct inode *, struct nfs_access_entry *);
389extern void nfs_access_set_mask(struct nfs_access_entry *, u32);
390extern int nfs_permission(struct user_namespace *, struct inode *, int);
391extern int nfs_open(struct inode *, struct file *);
392extern int nfs_attribute_cache_expired(struct inode *inode);
393extern int nfs_revalidate_inode(struct inode *inode, unsigned long flags);
394extern int __nfs_revalidate_inode(struct nfs_server *, struct inode *);
395extern int nfs_clear_invalid_mapping(struct address_space *mapping);
396extern bool nfs_mapping_need_revalidate_inode(struct inode *inode);
397extern int nfs_revalidate_mapping(struct inode *inode, struct address_space *mapping);
398extern int nfs_revalidate_mapping_rcu(struct inode *inode);
399extern int nfs_setattr(struct user_namespace *, struct dentry *, struct iattr *);
400extern void nfs_setattr_update_inode(struct inode *inode, struct iattr *attr, struct nfs_fattr *);
401extern void nfs_setsecurity(struct inode *inode, struct nfs_fattr *fattr,
402 struct nfs4_label *label);
403extern struct nfs_open_context *get_nfs_open_context(struct nfs_open_context *ctx);
404extern void put_nfs_open_context(struct nfs_open_context *ctx);
405extern struct nfs_open_context *nfs_find_open_context(struct inode *inode, const struct cred *cred, fmode_t mode);
406extern struct nfs_open_context *alloc_nfs_open_context(struct dentry *dentry, fmode_t f_mode, struct file *filp);
407extern void nfs_inode_attach_open_context(struct nfs_open_context *ctx);
408extern void nfs_file_set_open_context(struct file *filp, struct nfs_open_context *ctx);
409extern void nfs_file_clear_open_context(struct file *flip);
410extern struct nfs_lock_context *nfs_get_lock_context(struct nfs_open_context *ctx);
411extern void nfs_put_lock_context(struct nfs_lock_context *l_ctx);
412extern u64 nfs_compat_user_ino64(u64 fileid);
413extern void nfs_fattr_init(struct nfs_fattr *fattr);
414extern void nfs_fattr_set_barrier(struct nfs_fattr *fattr);
415extern unsigned long nfs_inc_attr_generation_counter(void);
416
417extern struct nfs_fattr *nfs_alloc_fattr(void);
418
419static inline void nfs_free_fattr(const struct nfs_fattr *fattr)
420{
421 kfree(fattr);
422}
423
424extern struct nfs_fh *nfs_alloc_fhandle(void);
425
426static inline void nfs_free_fhandle(const struct nfs_fh *fh)
427{
428 kfree(fh);
429}
430
431#ifdef NFS_DEBUG
432extern u32 _nfs_display_fhandle_hash(const struct nfs_fh *fh);
433static inline u32 nfs_display_fhandle_hash(const struct nfs_fh *fh)
434{
435 return _nfs_display_fhandle_hash(fh);
436}
437extern void _nfs_display_fhandle(const struct nfs_fh *fh, const char *caption);
438#define nfs_display_fhandle(fh, caption) \
439 do { \
440 if (unlikely(nfs_debug & NFSDBG_FACILITY)) \
441 _nfs_display_fhandle(fh, caption); \
442 } while (0)
443#else
444static inline u32 nfs_display_fhandle_hash(const struct nfs_fh *fh)
445{
446 return 0;
447}
448static inline void nfs_display_fhandle(const struct nfs_fh *fh,
449 const char *caption)
450{
451}
452#endif
453
454/*
455 * linux/fs/nfs/nfsroot.c
456 */
457extern int nfs_root_data(char **root_device, char **root_data); /*__init*/
458/* linux/net/ipv4/ipconfig.c: trims ip addr off front of name, too. */
459extern __be32 root_nfs_parse_addr(char *name); /*__init*/
460
461/*
462 * linux/fs/nfs/file.c
463 */
464extern const struct file_operations nfs_file_operations;
465#if IS_ENABLED(CONFIG_NFS_V4)
466extern const struct file_operations nfs4_file_operations;
467#endif /* CONFIG_NFS_V4 */
468extern const struct address_space_operations nfs_file_aops;
469extern const struct address_space_operations nfs_dir_aops;
470
471static inline struct nfs_open_context *nfs_file_open_context(struct file *filp)
472{
473 return filp->private_data;
474}
475
476static inline const struct cred *nfs_file_cred(struct file *file)
477{
478 if (file != NULL) {
479 struct nfs_open_context *ctx =
480 nfs_file_open_context(file);
481 if (ctx)
482 return ctx->cred;
483 }
484 return NULL;
485}
486
487/*
488 * linux/fs/nfs/direct.c
489 */
490extern ssize_t nfs_direct_IO(struct kiocb *, struct iov_iter *);
491extern ssize_t nfs_file_direct_read(struct kiocb *iocb,
492 struct iov_iter *iter);
493extern ssize_t nfs_file_direct_write(struct kiocb *iocb,
494 struct iov_iter *iter);
495
496/*
497 * linux/fs/nfs/dir.c
498 */
499extern const struct file_operations nfs_dir_operations;
500extern const struct dentry_operations nfs_dentry_operations;
501
502extern void nfs_force_lookup_revalidate(struct inode *dir);
503extern void nfs_set_verifier(struct dentry * dentry, unsigned long verf);
504#if IS_ENABLED(CONFIG_NFS_V4)
505extern void nfs_clear_verifier_delegated(struct inode *inode);
506#endif /* IS_ENABLED(CONFIG_NFS_V4) */
507extern struct dentry *nfs_add_or_obtain(struct dentry *dentry,
508 struct nfs_fh *fh, struct nfs_fattr *fattr,
509 struct nfs4_label *label);
510extern int nfs_instantiate(struct dentry *dentry, struct nfs_fh *fh,
511 struct nfs_fattr *fattr, struct nfs4_label *label);
512extern int nfs_may_open(struct inode *inode, const struct cred *cred, int openflags);
513extern void nfs_access_zap_cache(struct inode *inode);
514extern int nfs_access_get_cached(struct inode *inode, const struct cred *cred, struct nfs_access_entry *res,
515 bool may_block);
516
517/*
518 * linux/fs/nfs/symlink.c
519 */
520extern const struct inode_operations nfs_symlink_inode_operations;
521
522/*
523 * linux/fs/nfs/sysctl.c
524 */
525#ifdef CONFIG_SYSCTL
526extern int nfs_register_sysctl(void);
527extern void nfs_unregister_sysctl(void);
528#else
529#define nfs_register_sysctl() 0
530#define nfs_unregister_sysctl() do { } while(0)
531#endif
532
533/*
534 * linux/fs/nfs/namespace.c
535 */
536extern const struct inode_operations nfs_mountpoint_inode_operations;
537extern const struct inode_operations nfs_referral_inode_operations;
538extern int nfs_mountpoint_expiry_timeout;
539extern void nfs_release_automount_timer(void);
540
541/*
542 * linux/fs/nfs/unlink.c
543 */
544extern void nfs_complete_unlink(struct dentry *dentry, struct inode *);
545
546/*
547 * linux/fs/nfs/write.c
548 */
549extern int nfs_congestion_kb;
550extern int nfs_writepage(struct page *page, struct writeback_control *wbc);
551extern int nfs_writepages(struct address_space *, struct writeback_control *);
552extern int nfs_flush_incompatible(struct file *file, struct page *page);
553extern int nfs_updatepage(struct file *, struct page *, unsigned int, unsigned int);
554
555/*
556 * Try to write back everything synchronously (but check the
557 * return value!)
558 */
559extern int nfs_sync_inode(struct inode *inode);
560extern int nfs_wb_all(struct inode *inode);
561extern int nfs_wb_page(struct inode *inode, struct page *page);
562extern int nfs_wb_page_cancel(struct inode *inode, struct page* page);
563extern int nfs_commit_inode(struct inode *, int);
564extern struct nfs_commit_data *nfs_commitdata_alloc(bool never_fail);
565extern void nfs_commit_free(struct nfs_commit_data *data);
566
567static inline int
568nfs_have_writebacks(struct inode *inode)
569{
570 return atomic_long_read(&NFS_I(inode)->nrequests) != 0;
571}
572
573/*
574 * linux/fs/nfs/read.c
575 */
576extern int nfs_readpage(struct file *, struct page *);
577extern int nfs_readpages(struct file *, struct address_space *,
578 struct list_head *, unsigned);
579
580/*
581 * inline functions
582 */
583
584static inline loff_t nfs_size_to_loff_t(__u64 size)
585{
586 return min_t(u64, size, OFFSET_MAX);
587}
588
589static inline ino_t
590nfs_fileid_to_ino_t(u64 fileid)
591{
592 ino_t ino = (ino_t) fileid;
593 if (sizeof(ino_t) < sizeof(u64))
594 ino ^= fileid >> (sizeof(u64)-sizeof(ino_t)) * 8;
595 return ino;
596}
597
598#define NFS_JUKEBOX_RETRY_TIME (5 * HZ)
599
600
601# undef ifdebug
602# ifdef NFS_DEBUG
603# define ifdebug(fac) if (unlikely(nfs_debug & NFSDBG_##fac))
604# define NFS_IFDEBUG(x) x
605# else
606# define ifdebug(fac) if (0)
607# define NFS_IFDEBUG(x)
608# endif
609#endif