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