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};
56
57struct nfs_lockowner {
58 fl_owner_t l_owner;
59 pid_t l_pid;
60};
61
62#define NFS_IO_INPROGRESS 0
63struct nfs_io_counter {
64 unsigned long flags;
65 atomic_t io_count;
66};
67
68struct nfs_lock_context {
69 atomic_t count;
70 struct list_head list;
71 struct nfs_open_context *open_context;
72 struct nfs_lockowner lockowner;
73 struct nfs_io_counter io_count;
74};
75
76struct nfs4_state;
77struct nfs_open_context {
78 struct nfs_lock_context lock_context;
79 struct dentry *dentry;
80 struct rpc_cred *cred;
81 struct nfs4_state *state;
82 fmode_t mode;
83
84 unsigned long flags;
85#define NFS_CONTEXT_ERROR_WRITE (0)
86#define NFS_CONTEXT_RESEND_WRITES (1)
87#define NFS_CONTEXT_BAD (2)
88 int error;
89
90 struct list_head list;
91 struct nfs4_threshold *mdsthreshold;
92};
93
94struct nfs_open_dir_context {
95 struct rpc_cred *cred;
96 unsigned long attr_gencount;
97 __u64 dir_cookie;
98 __u64 dup_cookie;
99 signed char duped;
100};
101
102/*
103 * NFSv4 delegation
104 */
105struct nfs_delegation;
106
107struct posix_acl;
108
109/*
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 */
126 unsigned long flags; /* atomic bit ops */
127 unsigned long cache_validity; /* bit mask */
128
129 /*
130 * read_cache_jiffies is when we started read-caching this inode.
131 * 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 *
138 * 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.
142 */
143 unsigned long read_cache_jiffies;
144 unsigned long attrtimeo;
145 unsigned long attrtimeo_timestamp;
146
147 unsigned long attr_gencount;
148 /* "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;
153
154 struct rb_root access_cache;
155 struct list_head access_cache_entry_lru;
156 struct list_head access_cache_inode_lru;
157#ifdef CONFIG_NFS_V3_ACL
158 struct posix_acl *acl_access;
159 struct posix_acl *acl_default;
160#endif
161
162 /*
163 * This is the cookie verifier used for NFSv3 readdir
164 * operations
165 */
166 __be32 cookieverf[2];
167
168 unsigned long npages;
169 struct nfs_mds_commit_info commit_info;
170
171 /* Open contexts for shared mmap writes */
172 struct list_head open_files;
173
174 /* 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
180#if IS_ENABLED(CONFIG_NFS_V4)
181 struct nfs4_cached_acl *nfs4_acl;
182 /* NFSv4 state */
183 struct list_head open_states;
184 struct nfs_delegation __rcu *delegation;
185 fmode_t delegation_state;
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
200/*
201 * Cache validity bit flags
202 */
203#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 */
209#define NFS_INO_REVAL_FORCED 0x0040 /* force revalidation ignoring a delegation */
210#define NFS_INO_INVALID_LABEL 0x0080 /* cached label is invalid */
211
212/*
213 * Bit offsets in flags field
214 */
215#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 */
218#define NFS_INO_FLUSHING (4) /* inode is flushing out data */
219#define NFS_INO_FSCACHE (5) /* inode can be cached by FS-Cache */
220#define NFS_INO_FSCACHE_LOCK (6) /* FS-Cache cookie management lock */
221#define NFS_INO_COMMIT (7) /* inode is committing unstable writes */
222#define NFS_INO_LAYOUTCOMMIT (9) /* layoutcommit required */
223#define NFS_INO_LAYOUTCOMMITTING (10) /* layoutcommit inflight */
224
225static inline struct nfs_inode *NFS_I(const struct inode *inode)
226{
227 return container_of(inode, struct nfs_inode, vfs_inode);
228}
229
230static inline struct nfs_server *NFS_SB(const struct super_block *s)
231{
232 return (struct nfs_server *)(s->s_fs_info);
233}
234
235static inline struct nfs_fh *NFS_FH(const struct inode *inode)
236{
237 return &NFS_I(inode)->fh;
238}
239
240static 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
255static 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
272static inline struct fscache_cookie *nfs_i_fscache(struct inode *inode)
273{
274#ifdef CONFIG_NFS_FSCACHE
275 return NFS_I(inode)->fscache;
276#else
277 return NULL;
278#endif
279}
280
281static inline __u64 NFS_FILEID(const struct inode *inode)
282{
283 return NFS_I(inode)->fileid;
284}
285
286static inline void set_nfs_fileid(struct inode *inode, __u64 fileid)
287{
288 NFS_I(inode)->fileid = fileid;
289}
290
291static inline void nfs_mark_for_revalidate(struct inode *inode)
292{
293 struct nfs_inode *nfsi = NFS_I(inode);
294
295 spin_lock(&inode->i_lock);
296 nfsi->cache_validity |= NFS_INO_INVALID_ATTR|NFS_INO_INVALID_ACCESS;
297 if (S_ISDIR(inode->i_mode))
298 nfsi->cache_validity |= NFS_INO_REVAL_PAGECACHE|NFS_INO_INVALID_DATA;
299 spin_unlock(&inode->i_lock);
300}
301
302static inline int nfs_server_capable(struct inode *inode, int cap)
303{
304 return NFS_SERVER(inode)->caps & cap;
305}
306
307static inline void nfs_set_verifier(struct dentry * dentry, unsigned long verf)
308{
309 dentry->d_time = verf;
310}
311
312/**
313 * nfs_save_change_attribute - Returns the inode attribute change cookie
314 * @dir - pointer to parent directory inode
315 * The "change attribute" is updated every time we finish an operation
316 * that will result in a metadata change on the server.
317 */
318static inline unsigned long nfs_save_change_attribute(struct inode *dir)
319{
320 return NFS_I(dir)->cache_change_attribute;
321}
322
323/**
324 * nfs_verify_change_attribute - Detects NFS remote directory changes
325 * @dir - pointer to parent directory inode
326 * @chattr - previously saved change attribute
327 * Return "false" if the verifiers doesn't match the change attribute.
328 * This would usually indicate that the directory contents have changed on
329 * the server, and that any dentries need revalidating.
330 */
331static inline int nfs_verify_change_attribute(struct inode *dir, unsigned long chattr)
332{
333 return chattr == NFS_I(dir)->cache_change_attribute;
334}
335
336/*
337 * linux/fs/nfs/inode.c
338 */
339extern int nfs_sync_mapping(struct address_space *mapping);
340extern void nfs_zap_mapping(struct inode *inode, struct address_space *mapping);
341extern void nfs_zap_caches(struct inode *);
342extern void nfs_invalidate_atime(struct inode *);
343extern struct inode *nfs_fhget(struct super_block *, struct nfs_fh *,
344 struct nfs_fattr *, struct nfs4_label *);
345extern int nfs_refresh_inode(struct inode *, struct nfs_fattr *);
346extern int nfs_post_op_update_inode(struct inode *inode, struct nfs_fattr *fattr);
347extern int nfs_post_op_update_inode_force_wcc(struct inode *inode, struct nfs_fattr *fattr);
348extern int nfs_getattr(struct vfsmount *, struct dentry *, struct kstat *);
349extern void nfs_access_add_cache(struct inode *, struct nfs_access_entry *);
350extern void nfs_access_set_mask(struct nfs_access_entry *, u32);
351extern int nfs_permission(struct inode *, int);
352extern int nfs_open(struct inode *, struct file *);
353extern int nfs_release(struct inode *, struct file *);
354extern int nfs_attribute_timeout(struct inode *inode);
355extern int nfs_attribute_cache_expired(struct inode *inode);
356extern int nfs_revalidate_inode(struct nfs_server *server, struct inode *inode);
357extern int __nfs_revalidate_inode(struct nfs_server *, struct inode *);
358extern int nfs_revalidate_mapping(struct inode *inode, struct address_space *mapping);
359extern int nfs_setattr(struct dentry *, struct iattr *);
360extern void nfs_setattr_update_inode(struct inode *inode, struct iattr *attr);
361extern void nfs_setsecurity(struct inode *inode, struct nfs_fattr *fattr,
362 struct nfs4_label *label);
363extern struct nfs_open_context *get_nfs_open_context(struct nfs_open_context *ctx);
364extern void put_nfs_open_context(struct nfs_open_context *ctx);
365extern struct nfs_open_context *nfs_find_open_context(struct inode *inode, struct rpc_cred *cred, fmode_t mode);
366extern struct nfs_open_context *alloc_nfs_open_context(struct dentry *dentry, fmode_t f_mode);
367extern void nfs_inode_attach_open_context(struct nfs_open_context *ctx);
368extern void nfs_file_set_open_context(struct file *filp, struct nfs_open_context *ctx);
369extern struct nfs_lock_context *nfs_get_lock_context(struct nfs_open_context *ctx);
370extern void nfs_put_lock_context(struct nfs_lock_context *l_ctx);
371extern u64 nfs_compat_user_ino64(u64 fileid);
372extern void nfs_fattr_init(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/xattr.c
447 */
448#ifdef CONFIG_NFS_V3_ACL
449extern ssize_t nfs3_listxattr(struct dentry *, char *, size_t);
450extern ssize_t nfs3_getxattr(struct dentry *, const char *, void *, size_t);
451extern int nfs3_setxattr(struct dentry *, const char *,
452 const void *, size_t, int);
453extern int nfs3_removexattr (struct dentry *, const char *name);
454#else
455# define nfs3_listxattr NULL
456# define nfs3_getxattr NULL
457# define nfs3_setxattr NULL
458# define nfs3_removexattr NULL
459#endif
460
461/*
462 * linux/fs/nfs/direct.c
463 */
464extern ssize_t nfs_direct_IO(int, struct kiocb *, const struct iovec *, loff_t,
465 unsigned long);
466extern ssize_t nfs_file_direct_read(struct kiocb *iocb,
467 const struct iovec *iov, unsigned long nr_segs,
468 loff_t pos, bool uio);
469extern ssize_t nfs_file_direct_write(struct kiocb *iocb,
470 const struct iovec *iov, unsigned long nr_segs,
471 loff_t pos, bool uio);
472
473/*
474 * linux/fs/nfs/dir.c
475 */
476extern const struct file_operations nfs_dir_operations;
477extern const struct dentry_operations nfs_dentry_operations;
478
479extern void nfs_force_lookup_revalidate(struct inode *dir);
480extern int nfs_instantiate(struct dentry *dentry, struct nfs_fh *fh,
481 struct nfs_fattr *fattr, struct nfs4_label *label);
482extern int nfs_may_open(struct inode *inode, struct rpc_cred *cred, int openflags);
483extern void nfs_access_zap_cache(struct inode *inode);
484
485/*
486 * linux/fs/nfs/symlink.c
487 */
488extern const struct inode_operations nfs_symlink_inode_operations;
489
490/*
491 * linux/fs/nfs/sysctl.c
492 */
493#ifdef CONFIG_SYSCTL
494extern int nfs_register_sysctl(void);
495extern void nfs_unregister_sysctl(void);
496#else
497#define nfs_register_sysctl() 0
498#define nfs_unregister_sysctl() do { } while(0)
499#endif
500
501/*
502 * linux/fs/nfs/namespace.c
503 */
504extern const struct inode_operations nfs_mountpoint_inode_operations;
505extern const struct inode_operations nfs_referral_inode_operations;
506extern int nfs_mountpoint_expiry_timeout;
507extern void nfs_release_automount_timer(void);
508
509/*
510 * linux/fs/nfs/unlink.c
511 */
512extern void nfs_complete_unlink(struct dentry *dentry, struct inode *);
513extern void nfs_wait_on_sillyrename(struct dentry *dentry);
514extern void nfs_block_sillyrename(struct dentry *dentry);
515extern void nfs_unblock_sillyrename(struct dentry *dentry);
516extern int nfs_sillyrename(struct inode *dir, struct dentry *dentry);
517
518/*
519 * linux/fs/nfs/write.c
520 */
521extern int nfs_congestion_kb;
522extern int nfs_writepage(struct page *page, struct writeback_control *wbc);
523extern int nfs_writepages(struct address_space *, struct writeback_control *);
524extern int nfs_flush_incompatible(struct file *file, struct page *page);
525extern int nfs_updatepage(struct file *, struct page *, unsigned int, unsigned int);
526extern void nfs_writeback_done(struct rpc_task *, struct nfs_write_data *);
527
528/*
529 * Try to write back everything synchronously (but check the
530 * return value!)
531 */
532extern int nfs_wb_all(struct inode *inode);
533extern int nfs_wb_page(struct inode *inode, struct page* page);
534extern int nfs_wb_page_cancel(struct inode *inode, struct page* page);
535#if IS_ENABLED(CONFIG_NFS_V3) || IS_ENABLED(CONFIG_NFS_V4)
536extern int nfs_commit_inode(struct inode *, int);
537extern struct nfs_commit_data *nfs_commitdata_alloc(void);
538extern void nfs_commit_free(struct nfs_commit_data *data);
539#else
540static inline int
541nfs_commit_inode(struct inode *inode, int how)
542{
543 return 0;
544}
545#endif
546
547static inline int
548nfs_have_writebacks(struct inode *inode)
549{
550 return NFS_I(inode)->npages != 0;
551}
552
553/*
554 * linux/fs/nfs/read.c
555 */
556extern int nfs_readpage(struct file *, struct page *);
557extern int nfs_readpages(struct file *, struct address_space *,
558 struct list_head *, unsigned);
559extern int nfs_readpage_result(struct rpc_task *, struct nfs_read_data *);
560extern int nfs_readpage_async(struct nfs_open_context *, struct inode *,
561 struct page *);
562
563/*
564 * linux/fs/nfs3proc.c
565 */
566#ifdef CONFIG_NFS_V3_ACL
567extern struct posix_acl *nfs3_proc_getacl(struct inode *inode, int type);
568extern int nfs3_proc_setacl(struct inode *inode, int type,
569 struct posix_acl *acl);
570extern int nfs3_proc_set_default_acl(struct inode *dir, struct inode *inode,
571 umode_t mode);
572extern void nfs3_forget_cached_acls(struct inode *inode);
573#else
574static inline int nfs3_proc_set_default_acl(struct inode *dir,
575 struct inode *inode,
576 umode_t mode)
577{
578 return 0;
579}
580
581static inline void nfs3_forget_cached_acls(struct inode *inode)
582{
583}
584#endif /* CONFIG_NFS_V3_ACL */
585
586/*
587 * inline functions
588 */
589
590static inline loff_t nfs_size_to_loff_t(__u64 size)
591{
592 if (size > (__u64) OFFSET_MAX - 1)
593 return OFFSET_MAX - 1;
594 return (loff_t) size;
595}
596
597static inline ino_t
598nfs_fileid_to_ino_t(u64 fileid)
599{
600 ino_t ino = (ino_t) fileid;
601 if (sizeof(ino_t) < sizeof(u64))
602 ino ^= fileid >> (sizeof(u64)-sizeof(ino_t)) * 8;
603 return ino;
604}
605
606#define NFS_JUKEBOX_RETRY_TIME (5 * HZ)
607
608
609# undef ifdebug
610# ifdef NFS_DEBUG
611# define ifdebug(fac) if (unlikely(nfs_debug & NFSDBG_##fac))
612# define NFS_IFDEBUG(x) x
613# else
614# define ifdebug(fac) if (0)
615# define NFS_IFDEBUG(x)
616# endif
617#endif