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