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