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