Merge tag 'asoc-fix-v5.6-rc4' of https://git.kernel.org/pub/scm/linux/kernel/git...
[linux-2.6-microblaze.git] / include / linux / nfs_fs.h
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  * NFSv3/v4 Access mode cache entry
50  */
51 struct nfs_access_entry {
52         struct rb_node          rb_node;
53         struct list_head        lru;
54         const struct cred *     cred;
55         __u32                   mask;
56         struct rcu_head         rcu_head;
57 };
58
59 struct nfs_lock_context {
60         refcount_t count;
61         struct list_head list;
62         struct nfs_open_context *open_context;
63         fl_owner_t lockowner;
64         atomic_t io_count;
65         struct rcu_head rcu_head;
66 };
67
68 struct nfs4_state;
69 struct nfs_open_context {
70         struct nfs_lock_context lock_context;
71         fl_owner_t flock_owner;
72         struct dentry *dentry;
73         const struct cred *cred;
74         struct rpc_cred *ll_cred;       /* low-level cred - use to check for expiry */
75         struct nfs4_state *state;
76         fmode_t mode;
77
78         unsigned long flags;
79 #define NFS_CONTEXT_RESEND_WRITES       (1)
80 #define NFS_CONTEXT_BAD                 (2)
81 #define NFS_CONTEXT_UNLOCK      (3)
82         int error;
83
84         struct list_head list;
85         struct nfs4_threshold   *mdsthreshold;
86         struct rcu_head rcu_head;
87 };
88
89 struct nfs_open_dir_context {
90         struct list_head list;
91         const struct 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  */
101 struct nfs_delegation;
102
103 struct posix_acl;
104
105 /*
106  * nfs fs inode data in memory
107  */
108 struct 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         atomic_long_t           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         /* Readers: in-flight sillydelete RPC calls */
167         /* Writers: rmdir */
168         struct rw_semaphore     rmdir_sem;
169         struct mutex            commit_mutex;
170
171         /* track last access to cached pages */
172         unsigned long           page_index;
173
174 #if IS_ENABLED(CONFIG_NFS_V4)
175         struct nfs4_cached_acl  *nfs4_acl;
176         /* NFSv4 state */
177         struct list_head        open_states;
178         struct nfs_delegation __rcu *delegation;
179         struct rw_semaphore     rwsem;
180
181         /* pNFS layout information */
182         struct pnfs_layout_hdr *layout;
183 #endif /* CONFIG_NFS_V4*/
184         /* how many bytes have been written/read and how many bytes queued up */
185         __u64 write_io;
186         __u64 read_io;
187 #ifdef CONFIG_NFS_FSCACHE
188         struct fscache_cookie   *fscache;
189 #endif
190         struct inode            vfs_inode;
191 };
192
193 struct nfs4_copy_state {
194         struct list_head        copies;
195         struct list_head        src_copies;
196         nfs4_stateid            stateid;
197         struct completion       completion;
198         uint64_t                count;
199         struct nfs_writeverf    verf;
200         int                     error;
201         int                     flags;
202         struct nfs4_state       *parent_src_state;
203         struct nfs4_state       *parent_dst_state;
204 };
205
206 /*
207  * Access bit flags
208  */
209 #define NFS_ACCESS_READ        0x0001
210 #define NFS_ACCESS_LOOKUP      0x0002
211 #define NFS_ACCESS_MODIFY      0x0004
212 #define NFS_ACCESS_EXTEND      0x0008
213 #define NFS_ACCESS_DELETE      0x0010
214 #define NFS_ACCESS_EXECUTE     0x0020
215
216 /*
217  * Cache validity bit flags
218  */
219 #define NFS_INO_INVALID_DATA    BIT(1)          /* cached data is invalid */
220 #define NFS_INO_INVALID_ATIME   BIT(2)          /* cached atime is invalid */
221 #define NFS_INO_INVALID_ACCESS  BIT(3)          /* cached access cred invalid */
222 #define NFS_INO_INVALID_ACL     BIT(4)          /* cached acls are invalid */
223 #define NFS_INO_REVAL_PAGECACHE BIT(5)          /* must revalidate pagecache */
224 #define NFS_INO_REVAL_FORCED    BIT(6)          /* force revalidation ignoring a delegation */
225 #define NFS_INO_INVALID_LABEL   BIT(7)          /* cached label is invalid */
226 #define NFS_INO_INVALID_CHANGE  BIT(8)          /* cached change is invalid */
227 #define NFS_INO_INVALID_CTIME   BIT(9)          /* cached ctime is invalid */
228 #define NFS_INO_INVALID_MTIME   BIT(10)         /* cached mtime is invalid */
229 #define NFS_INO_INVALID_SIZE    BIT(11)         /* cached size is invalid */
230 #define NFS_INO_INVALID_OTHER   BIT(12)         /* other attrs are invalid */
231 #define NFS_INO_DATA_INVAL_DEFER        \
232                                 BIT(13)         /* Deferred cache invalidation */
233
234 #define NFS_INO_INVALID_ATTR    (NFS_INO_INVALID_CHANGE \
235                 | NFS_INO_INVALID_CTIME \
236                 | NFS_INO_INVALID_MTIME \
237                 | NFS_INO_INVALID_SIZE \
238                 | NFS_INO_INVALID_OTHER)        /* inode metadata is invalid */
239
240 /*
241  * Bit offsets in flags field
242  */
243 #define NFS_INO_ADVISE_RDPLUS   (0)             /* advise readdirplus */
244 #define NFS_INO_STALE           (1)             /* possible stale inode */
245 #define NFS_INO_ACL_LRU_SET     (2)             /* Inode is on the LRU list */
246 #define NFS_INO_INVALIDATING    (3)             /* inode is being invalidated */
247 #define NFS_INO_FSCACHE         (5)             /* inode can be cached by FS-Cache */
248 #define NFS_INO_FSCACHE_LOCK    (6)             /* FS-Cache cookie management lock */
249 #define NFS_INO_LAYOUTCOMMIT    (9)             /* layoutcommit required */
250 #define NFS_INO_LAYOUTCOMMITTING (10)           /* layoutcommit inflight */
251 #define NFS_INO_LAYOUTSTATS     (11)            /* layoutstats inflight */
252 #define NFS_INO_ODIRECT         (12)            /* I/O setting is O_DIRECT */
253
254 static inline struct nfs_inode *NFS_I(const struct inode *inode)
255 {
256         return container_of(inode, struct nfs_inode, vfs_inode);
257 }
258
259 static inline struct nfs_server *NFS_SB(const struct super_block *s)
260 {
261         return (struct nfs_server *)(s->s_fs_info);
262 }
263
264 static inline struct nfs_fh *NFS_FH(const struct inode *inode)
265 {
266         return &NFS_I(inode)->fh;
267 }
268
269 static inline struct nfs_server *NFS_SERVER(const struct inode *inode)
270 {
271         return NFS_SB(inode->i_sb);
272 }
273
274 static inline struct rpc_clnt *NFS_CLIENT(const struct inode *inode)
275 {
276         return NFS_SERVER(inode)->client;
277 }
278
279 static inline const struct nfs_rpc_ops *NFS_PROTO(const struct inode *inode)
280 {
281         return NFS_SERVER(inode)->nfs_client->rpc_ops;
282 }
283
284 static inline unsigned NFS_MINATTRTIMEO(const struct inode *inode)
285 {
286         struct nfs_server *nfss = NFS_SERVER(inode);
287         return S_ISDIR(inode->i_mode) ? nfss->acdirmin : nfss->acregmin;
288 }
289
290 static inline unsigned NFS_MAXATTRTIMEO(const struct inode *inode)
291 {
292         struct nfs_server *nfss = NFS_SERVER(inode);
293         return S_ISDIR(inode->i_mode) ? nfss->acdirmax : nfss->acregmax;
294 }
295
296 static inline int NFS_STALE(const struct inode *inode)
297 {
298         return test_bit(NFS_INO_STALE, &NFS_I(inode)->flags);
299 }
300
301 static inline struct fscache_cookie *nfs_i_fscache(struct inode *inode)
302 {
303 #ifdef CONFIG_NFS_FSCACHE
304         return NFS_I(inode)->fscache;
305 #else
306         return NULL;
307 #endif
308 }
309
310 static inline __u64 NFS_FILEID(const struct inode *inode)
311 {
312         return NFS_I(inode)->fileid;
313 }
314
315 static inline void set_nfs_fileid(struct inode *inode, __u64 fileid)
316 {
317         NFS_I(inode)->fileid = fileid;
318 }
319
320 static inline void nfs_mark_for_revalidate(struct inode *inode)
321 {
322         struct nfs_inode *nfsi = NFS_I(inode);
323
324         spin_lock(&inode->i_lock);
325         nfsi->cache_validity |= NFS_INO_REVAL_PAGECACHE
326                 | NFS_INO_INVALID_ACCESS
327                 | NFS_INO_INVALID_ACL
328                 | NFS_INO_INVALID_CHANGE
329                 | NFS_INO_INVALID_CTIME;
330         if (S_ISDIR(inode->i_mode))
331                 nfsi->cache_validity |= NFS_INO_INVALID_DATA;
332         spin_unlock(&inode->i_lock);
333 }
334
335 static inline int nfs_server_capable(struct inode *inode, int cap)
336 {
337         return NFS_SERVER(inode)->caps & cap;
338 }
339
340 static inline void nfs_set_verifier(struct dentry * dentry, unsigned long verf)
341 {
342         dentry->d_time = verf;
343 }
344
345 /**
346  * nfs_save_change_attribute - Returns the inode attribute change cookie
347  * @dir - pointer to parent directory inode
348  * The "change attribute" is updated every time we finish an operation
349  * that will result in a metadata change on the server.
350  */
351 static inline unsigned long nfs_save_change_attribute(struct inode *dir)
352 {
353         return NFS_I(dir)->cache_change_attribute;
354 }
355
356 /**
357  * nfs_verify_change_attribute - Detects NFS remote directory changes
358  * @dir - pointer to parent directory inode
359  * @chattr - previously saved change attribute
360  * Return "false" if the verifiers doesn't match the change attribute.
361  * This would usually indicate that the directory contents have changed on
362  * the server, and that any dentries need revalidating.
363  */
364 static inline int nfs_verify_change_attribute(struct inode *dir, unsigned long chattr)
365 {
366         return chattr == NFS_I(dir)->cache_change_attribute;
367 }
368
369 /*
370  * linux/fs/nfs/inode.c
371  */
372 extern int nfs_sync_mapping(struct address_space *mapping);
373 extern void nfs_zap_mapping(struct inode *inode, struct address_space *mapping);
374 extern void nfs_zap_caches(struct inode *);
375 extern void nfs_invalidate_atime(struct inode *);
376 extern struct inode *nfs_fhget(struct super_block *, struct nfs_fh *,
377                                 struct nfs_fattr *, struct nfs4_label *);
378 struct inode *nfs_ilookup(struct super_block *sb, struct nfs_fattr *, struct nfs_fh *);
379 extern int nfs_refresh_inode(struct inode *, struct nfs_fattr *);
380 extern int nfs_post_op_update_inode(struct inode *inode, struct nfs_fattr *fattr);
381 extern int nfs_post_op_update_inode_force_wcc(struct inode *inode, struct nfs_fattr *fattr);
382 extern int nfs_post_op_update_inode_force_wcc_locked(struct inode *inode, struct nfs_fattr *fattr);
383 extern int nfs_getattr(const struct path *, struct kstat *, u32, unsigned int);
384 extern void nfs_access_add_cache(struct inode *, struct nfs_access_entry *);
385 extern void nfs_access_set_mask(struct nfs_access_entry *, u32);
386 extern int nfs_permission(struct inode *, int);
387 extern int nfs_open(struct inode *, struct file *);
388 extern int nfs_attribute_cache_expired(struct inode *inode);
389 extern int nfs_revalidate_inode(struct nfs_server *server, struct inode *inode);
390 extern int __nfs_revalidate_inode(struct nfs_server *, struct inode *);
391 extern bool nfs_mapping_need_revalidate_inode(struct inode *inode);
392 extern int nfs_revalidate_mapping(struct inode *inode, struct address_space *mapping);
393 extern int nfs_revalidate_mapping_rcu(struct inode *inode);
394 extern int nfs_setattr(struct dentry *, struct iattr *);
395 extern void nfs_setattr_update_inode(struct inode *inode, struct iattr *attr, struct nfs_fattr *);
396 extern void nfs_setsecurity(struct inode *inode, struct nfs_fattr *fattr,
397                                 struct nfs4_label *label);
398 extern struct nfs_open_context *get_nfs_open_context(struct nfs_open_context *ctx);
399 extern void put_nfs_open_context(struct nfs_open_context *ctx);
400 extern struct nfs_open_context *nfs_find_open_context(struct inode *inode, const struct cred *cred, fmode_t mode);
401 extern struct nfs_open_context *alloc_nfs_open_context(struct dentry *dentry, fmode_t f_mode, struct file *filp);
402 extern void nfs_inode_attach_open_context(struct nfs_open_context *ctx);
403 extern void nfs_file_set_open_context(struct file *filp, struct nfs_open_context *ctx);
404 extern void nfs_file_clear_open_context(struct file *flip);
405 extern struct nfs_lock_context *nfs_get_lock_context(struct nfs_open_context *ctx);
406 extern void nfs_put_lock_context(struct nfs_lock_context *l_ctx);
407 extern u64 nfs_compat_user_ino64(u64 fileid);
408 extern void nfs_fattr_init(struct nfs_fattr *fattr);
409 extern void nfs_fattr_set_barrier(struct nfs_fattr *fattr);
410 extern unsigned long nfs_inc_attr_generation_counter(void);
411
412 extern struct nfs_fattr *nfs_alloc_fattr(void);
413
414 static inline void nfs_free_fattr(const struct nfs_fattr *fattr)
415 {
416         kfree(fattr);
417 }
418
419 extern struct nfs_fh *nfs_alloc_fhandle(void);
420
421 static inline void nfs_free_fhandle(const struct nfs_fh *fh)
422 {
423         kfree(fh);
424 }
425
426 #ifdef NFS_DEBUG
427 extern u32 _nfs_display_fhandle_hash(const struct nfs_fh *fh);
428 static inline u32 nfs_display_fhandle_hash(const struct nfs_fh *fh)
429 {
430         return _nfs_display_fhandle_hash(fh);
431 }
432 extern void _nfs_display_fhandle(const struct nfs_fh *fh, const char *caption);
433 #define nfs_display_fhandle(fh, caption)                        \
434         do {                                                    \
435                 if (unlikely(nfs_debug & NFSDBG_FACILITY))      \
436                         _nfs_display_fhandle(fh, caption);      \
437         } while (0)
438 #else
439 static inline u32 nfs_display_fhandle_hash(const struct nfs_fh *fh)
440 {
441         return 0;
442 }
443 static inline void nfs_display_fhandle(const struct nfs_fh *fh,
444                                        const char *caption)
445 {
446 }
447 #endif
448
449 /*
450  * linux/fs/nfs/nfsroot.c
451  */
452 extern int  nfs_root_data(char **root_device, char **root_data); /*__init*/
453 /* linux/net/ipv4/ipconfig.c: trims ip addr off front of name, too. */
454 extern __be32 root_nfs_parse_addr(char *name); /*__init*/
455
456 /*
457  * linux/fs/nfs/file.c
458  */
459 extern const struct file_operations nfs_file_operations;
460 #if IS_ENABLED(CONFIG_NFS_V4)
461 extern const struct file_operations nfs4_file_operations;
462 #endif /* CONFIG_NFS_V4 */
463 extern const struct address_space_operations nfs_file_aops;
464 extern const struct address_space_operations nfs_dir_aops;
465
466 static inline struct nfs_open_context *nfs_file_open_context(struct file *filp)
467 {
468         return filp->private_data;
469 }
470
471 static inline const struct cred *nfs_file_cred(struct file *file)
472 {
473         if (file != NULL) {
474                 struct nfs_open_context *ctx =
475                         nfs_file_open_context(file);
476                 if (ctx)
477                         return ctx->cred;
478         }
479         return NULL;
480 }
481
482 /*
483  * linux/fs/nfs/direct.c
484  */
485 extern ssize_t nfs_direct_IO(struct kiocb *, struct iov_iter *);
486 extern ssize_t nfs_file_direct_read(struct kiocb *iocb,
487                         struct iov_iter *iter);
488 extern ssize_t nfs_file_direct_write(struct kiocb *iocb,
489                         struct iov_iter *iter);
490
491 /*
492  * linux/fs/nfs/dir.c
493  */
494 extern const struct file_operations nfs_dir_operations;
495 extern const struct dentry_operations nfs_dentry_operations;
496
497 extern void nfs_force_lookup_revalidate(struct inode *dir);
498 extern struct dentry *nfs_add_or_obtain(struct dentry *dentry,
499                         struct nfs_fh *fh, struct nfs_fattr *fattr,
500                         struct nfs4_label *label);
501 extern int nfs_instantiate(struct dentry *dentry, struct nfs_fh *fh,
502                         struct nfs_fattr *fattr, struct nfs4_label *label);
503 extern int nfs_may_open(struct inode *inode, const struct cred *cred, int openflags);
504 extern void nfs_access_zap_cache(struct inode *inode);
505
506 /*
507  * linux/fs/nfs/symlink.c
508  */
509 extern const struct inode_operations nfs_symlink_inode_operations;
510
511 /*
512  * linux/fs/nfs/sysctl.c
513  */
514 #ifdef CONFIG_SYSCTL
515 extern int nfs_register_sysctl(void);
516 extern void nfs_unregister_sysctl(void);
517 #else
518 #define nfs_register_sysctl() 0
519 #define nfs_unregister_sysctl() do { } while(0)
520 #endif
521
522 /*
523  * linux/fs/nfs/namespace.c
524  */
525 extern const struct inode_operations nfs_mountpoint_inode_operations;
526 extern const struct inode_operations nfs_referral_inode_operations;
527 extern int nfs_mountpoint_expiry_timeout;
528 extern void nfs_release_automount_timer(void);
529
530 /*
531  * linux/fs/nfs/unlink.c
532  */
533 extern void nfs_complete_unlink(struct dentry *dentry, struct inode *);
534
535 /*
536  * linux/fs/nfs/write.c
537  */
538 extern int  nfs_congestion_kb;
539 extern int  nfs_writepage(struct page *page, struct writeback_control *wbc);
540 extern int  nfs_writepages(struct address_space *, struct writeback_control *);
541 extern int  nfs_flush_incompatible(struct file *file, struct page *page);
542 extern int  nfs_updatepage(struct file *, struct page *, unsigned int, unsigned int);
543
544 /*
545  * Try to write back everything synchronously (but check the
546  * return value!)
547  */
548 extern int nfs_sync_inode(struct inode *inode);
549 extern int nfs_wb_all(struct inode *inode);
550 extern int nfs_wb_page(struct inode *inode, struct page *page);
551 extern int nfs_wb_page_cancel(struct inode *inode, struct page* page);
552 extern int  nfs_commit_inode(struct inode *, int);
553 extern struct nfs_commit_data *nfs_commitdata_alloc(bool never_fail);
554 extern void nfs_commit_free(struct nfs_commit_data *data);
555
556 static inline int
557 nfs_have_writebacks(struct inode *inode)
558 {
559         return atomic_long_read(&NFS_I(inode)->nrequests) != 0;
560 }
561
562 /*
563  * linux/fs/nfs/read.c
564  */
565 extern int  nfs_readpage(struct file *, struct page *);
566 extern int  nfs_readpages(struct file *, struct address_space *,
567                 struct list_head *, unsigned);
568 extern int  nfs_readpage_async(struct nfs_open_context *, struct inode *,
569                                struct page *);
570
571 /*
572  * inline functions
573  */
574
575 static inline loff_t nfs_size_to_loff_t(__u64 size)
576 {
577         return min_t(u64, size, OFFSET_MAX);
578 }
579
580 static inline ino_t
581 nfs_fileid_to_ino_t(u64 fileid)
582 {
583         ino_t ino = (ino_t) fileid;
584         if (sizeof(ino_t) < sizeof(u64))
585                 ino ^= fileid >> (sizeof(u64)-sizeof(ino_t)) * 8;
586         return ino;
587 }
588
589 #define NFS_JUKEBOX_RETRY_TIME (5 * HZ)
590
591
592 # undef ifdebug
593 # ifdef NFS_DEBUG
594 #  define ifdebug(fac)          if (unlikely(nfs_debug & NFSDBG_##fac))
595 #  define NFS_IFDEBUG(x)        x
596 # else
597 #  define ifdebug(fac)          if (0)
598 #  define NFS_IFDEBUG(x)
599 # endif
600 #endif