1 /* SPDX-License-Identifier: GPL-2.0 */
3 * linux/include/linux/nfs_fs.h
5 * Copyright (C) 1992 Rick Sladkey
7 * OS-specific nfs filesystem definitions and declarations
9 #ifndef _LINUX_NFS_FS_H
10 #define _LINUX_NFS_FS_H
12 #include <uapi/linux/nfs_fs.h>
16 * Enable dprintk() debugging support for nfs client.
18 #ifdef CONFIG_NFS_DEBUG
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>
30 #include <linux/sunrpc/debug.h>
31 #include <linux/sunrpc/auth.h>
32 #include <linux/sunrpc/clnt.h>
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>
41 #include <linux/mempool.h>
44 * These are the default flags for swap requests
46 #define NFS_RPC_SWAPFLAGS (RPC_TASK_SWAPPER|RPC_TASK_ROOTCREDS)
49 * NFSv3/v4 Access mode cache entry
51 struct nfs_access_entry
{
52 struct rb_node rb_node
;
54 const struct cred
* cred
;
56 struct rcu_head rcu_head
;
59 struct nfs_lock_context
{
61 struct list_head list
;
62 struct nfs_open_context
*open_context
;
65 struct rcu_head rcu_head
;
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
;
79 #define NFS_CONTEXT_RESEND_WRITES (1)
80 #define NFS_CONTEXT_BAD (2)
81 #define NFS_CONTEXT_UNLOCK (3)
84 struct list_head list
;
85 struct nfs4_threshold
*mdsthreshold
;
86 struct rcu_head rcu_head
;
89 struct nfs_open_dir_context
{
90 struct list_head list
;
91 const struct cred
*cred
;
92 unsigned long attr_gencount
;
101 struct nfs_delegation
;
106 * nfs fs inode data in memory
110 * The 64bit 'inode number'
122 unsigned long flags
; /* atomic bit ops */
123 unsigned long cache_validity
; /* bit mask */
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
132 * We need to revalidate the cached attrs for this inode if
134 * jiffies - read_cache_jiffies >= attrtimeo
136 * Please note the comparison is greater than or equal
137 * so that zero timeout values can be specified.
139 unsigned long read_cache_jiffies
;
140 unsigned long attrtimeo
;
141 unsigned long attrtimeo_timestamp
;
143 unsigned long attr_gencount
;
144 /* "Generation counter" for the attribute cache. This is
145 * bumped whenever we update the metadata on the
148 unsigned long cache_change_attribute
;
150 struct rb_root access_cache
;
151 struct list_head access_cache_entry_lru
;
152 struct list_head access_cache_inode_lru
;
155 * This is the cookie verifier used for NFSv3 readdir
158 __be32 cookieverf
[2];
160 atomic_long_t nrequests
;
161 struct nfs_mds_commit_info commit_info
;
163 /* Open contexts for shared mmap writes */
164 struct list_head open_files
;
166 /* Readers: in-flight sillydelete RPC calls */
168 struct rw_semaphore rmdir_sem
;
169 struct mutex commit_mutex
;
171 #if IS_ENABLED(CONFIG_NFS_V4)
172 struct nfs4_cached_acl
*nfs4_acl
;
174 struct list_head open_states
;
175 struct nfs_delegation __rcu
*delegation
;
176 struct rw_semaphore rwsem
;
178 /* pNFS layout information */
179 struct pnfs_layout_hdr
*layout
;
180 #endif /* CONFIG_NFS_V4*/
181 /* how many bytes have been written/read and how many bytes queued up */
184 #ifdef CONFIG_NFS_FSCACHE
185 struct fscache_cookie
*fscache
;
187 struct inode vfs_inode
;
190 struct nfs4_copy_state
{
191 struct list_head copies
;
192 nfs4_stateid stateid
;
193 struct completion completion
;
195 struct nfs_writeverf verf
;
198 struct nfs4_state
*parent_state
;
204 #define NFS_ACCESS_READ 0x0001
205 #define NFS_ACCESS_LOOKUP 0x0002
206 #define NFS_ACCESS_MODIFY 0x0004
207 #define NFS_ACCESS_EXTEND 0x0008
208 #define NFS_ACCESS_DELETE 0x0010
209 #define NFS_ACCESS_EXECUTE 0x0020
212 * Cache validity bit flags
214 #define NFS_INO_INVALID_DATA BIT(1) /* cached data is invalid */
215 #define NFS_INO_INVALID_ATIME BIT(2) /* cached atime is invalid */
216 #define NFS_INO_INVALID_ACCESS BIT(3) /* cached access cred invalid */
217 #define NFS_INO_INVALID_ACL BIT(4) /* cached acls are invalid */
218 #define NFS_INO_REVAL_PAGECACHE BIT(5) /* must revalidate pagecache */
219 #define NFS_INO_REVAL_FORCED BIT(6) /* force revalidation ignoring a delegation */
220 #define NFS_INO_INVALID_LABEL BIT(7) /* cached label is invalid */
221 #define NFS_INO_INVALID_CHANGE BIT(8) /* cached change is invalid */
222 #define NFS_INO_INVALID_CTIME BIT(9) /* cached ctime is invalid */
223 #define NFS_INO_INVALID_MTIME BIT(10) /* cached mtime is invalid */
224 #define NFS_INO_INVALID_SIZE BIT(11) /* cached size is invalid */
225 #define NFS_INO_INVALID_OTHER BIT(12) /* other attrs are invalid */
227 #define NFS_INO_INVALID_ATTR (NFS_INO_INVALID_CHANGE \
228 | NFS_INO_INVALID_CTIME \
229 | NFS_INO_INVALID_MTIME \
230 | NFS_INO_INVALID_SIZE \
231 | NFS_INO_INVALID_OTHER) /* inode metadata is invalid */
234 * Bit offsets in flags field
236 #define NFS_INO_ADVISE_RDPLUS (0) /* advise readdirplus */
237 #define NFS_INO_STALE (1) /* possible stale inode */
238 #define NFS_INO_ACL_LRU_SET (2) /* Inode is on the LRU list */
239 #define NFS_INO_INVALIDATING (3) /* inode is being invalidated */
240 #define NFS_INO_FSCACHE (5) /* inode can be cached by FS-Cache */
241 #define NFS_INO_FSCACHE_LOCK (6) /* FS-Cache cookie management lock */
242 #define NFS_INO_LAYOUTCOMMIT (9) /* layoutcommit required */
243 #define NFS_INO_LAYOUTCOMMITTING (10) /* layoutcommit inflight */
244 #define NFS_INO_LAYOUTSTATS (11) /* layoutstats inflight */
245 #define NFS_INO_ODIRECT (12) /* I/O setting is O_DIRECT */
247 static inline struct nfs_inode
*NFS_I(const struct inode
*inode
)
249 return container_of(inode
, struct nfs_inode
, vfs_inode
);
252 static inline struct nfs_server
*NFS_SB(const struct super_block
*s
)
254 return (struct nfs_server
*)(s
->s_fs_info
);
257 static inline struct nfs_fh
*NFS_FH(const struct inode
*inode
)
259 return &NFS_I(inode
)->fh
;
262 static inline struct nfs_server
*NFS_SERVER(const struct inode
*inode
)
264 return NFS_SB(inode
->i_sb
);
267 static inline struct rpc_clnt
*NFS_CLIENT(const struct inode
*inode
)
269 return NFS_SERVER(inode
)->client
;
272 static inline const struct nfs_rpc_ops
*NFS_PROTO(const struct inode
*inode
)
274 return NFS_SERVER(inode
)->nfs_client
->rpc_ops
;
277 static inline unsigned NFS_MINATTRTIMEO(const struct inode
*inode
)
279 struct nfs_server
*nfss
= NFS_SERVER(inode
);
280 return S_ISDIR(inode
->i_mode
) ? nfss
->acdirmin
: nfss
->acregmin
;
283 static inline unsigned NFS_MAXATTRTIMEO(const struct inode
*inode
)
285 struct nfs_server
*nfss
= NFS_SERVER(inode
);
286 return S_ISDIR(inode
->i_mode
) ? nfss
->acdirmax
: nfss
->acregmax
;
289 static inline int NFS_STALE(const struct inode
*inode
)
291 return test_bit(NFS_INO_STALE
, &NFS_I(inode
)->flags
);
294 static inline struct fscache_cookie
*nfs_i_fscache(struct inode
*inode
)
296 #ifdef CONFIG_NFS_FSCACHE
297 return NFS_I(inode
)->fscache
;
303 static inline __u64
NFS_FILEID(const struct inode
*inode
)
305 return NFS_I(inode
)->fileid
;
308 static inline void set_nfs_fileid(struct inode
*inode
, __u64 fileid
)
310 NFS_I(inode
)->fileid
= fileid
;
313 static inline void nfs_mark_for_revalidate(struct inode
*inode
)
315 struct nfs_inode
*nfsi
= NFS_I(inode
);
317 spin_lock(&inode
->i_lock
);
318 nfsi
->cache_validity
|= NFS_INO_REVAL_PAGECACHE
319 | NFS_INO_INVALID_ACCESS
320 | NFS_INO_INVALID_ACL
321 | NFS_INO_INVALID_CHANGE
322 | NFS_INO_INVALID_CTIME
;
323 if (S_ISDIR(inode
->i_mode
))
324 nfsi
->cache_validity
|= NFS_INO_INVALID_DATA
;
325 spin_unlock(&inode
->i_lock
);
328 static inline int nfs_server_capable(struct inode
*inode
, int cap
)
330 return NFS_SERVER(inode
)->caps
& cap
;
333 static inline void nfs_set_verifier(struct dentry
* dentry
, unsigned long verf
)
335 dentry
->d_time
= verf
;
339 * nfs_save_change_attribute - Returns the inode attribute change cookie
340 * @dir - pointer to parent directory inode
341 * The "change attribute" is updated every time we finish an operation
342 * that will result in a metadata change on the server.
344 static inline unsigned long nfs_save_change_attribute(struct inode
*dir
)
346 return NFS_I(dir
)->cache_change_attribute
;
350 * nfs_verify_change_attribute - Detects NFS remote directory changes
351 * @dir - pointer to parent directory inode
352 * @chattr - previously saved change attribute
353 * Return "false" if the verifiers doesn't match the change attribute.
354 * This would usually indicate that the directory contents have changed on
355 * the server, and that any dentries need revalidating.
357 static inline int nfs_verify_change_attribute(struct inode
*dir
, unsigned long chattr
)
359 return chattr
== NFS_I(dir
)->cache_change_attribute
;
363 * linux/fs/nfs/inode.c
365 extern int nfs_sync_mapping(struct address_space
*mapping
);
366 extern void nfs_zap_mapping(struct inode
*inode
, struct address_space
*mapping
);
367 extern void nfs_zap_caches(struct inode
*);
368 extern void nfs_invalidate_atime(struct inode
*);
369 extern struct inode
*nfs_fhget(struct super_block
*, struct nfs_fh
*,
370 struct nfs_fattr
*, struct nfs4_label
*);
371 struct inode
*nfs_ilookup(struct super_block
*sb
, struct nfs_fattr
*, struct nfs_fh
*);
372 extern int nfs_refresh_inode(struct inode
*, struct nfs_fattr
*);
373 extern int nfs_post_op_update_inode(struct inode
*inode
, struct nfs_fattr
*fattr
);
374 extern int nfs_post_op_update_inode_force_wcc(struct inode
*inode
, struct nfs_fattr
*fattr
);
375 extern int nfs_post_op_update_inode_force_wcc_locked(struct inode
*inode
, struct nfs_fattr
*fattr
);
376 extern int nfs_getattr(const struct path
*, struct kstat
*, u32
, unsigned int);
377 extern void nfs_access_add_cache(struct inode
*, struct nfs_access_entry
*);
378 extern void nfs_access_set_mask(struct nfs_access_entry
*, u32
);
379 extern int nfs_permission(struct inode
*, int);
380 extern int nfs_open(struct inode
*, struct file
*);
381 extern int nfs_attribute_cache_expired(struct inode
*inode
);
382 extern int nfs_revalidate_inode(struct nfs_server
*server
, struct inode
*inode
);
383 extern int __nfs_revalidate_inode(struct nfs_server
*, struct inode
*);
384 extern bool nfs_mapping_need_revalidate_inode(struct inode
*inode
);
385 extern int nfs_revalidate_mapping(struct inode
*inode
, struct address_space
*mapping
);
386 extern int nfs_revalidate_mapping_rcu(struct inode
*inode
);
387 extern int nfs_setattr(struct dentry
*, struct iattr
*);
388 extern void nfs_setattr_update_inode(struct inode
*inode
, struct iattr
*attr
, struct nfs_fattr
*);
389 extern void nfs_setsecurity(struct inode
*inode
, struct nfs_fattr
*fattr
,
390 struct nfs4_label
*label
);
391 extern struct nfs_open_context
*get_nfs_open_context(struct nfs_open_context
*ctx
);
392 extern void put_nfs_open_context(struct nfs_open_context
*ctx
);
393 extern struct nfs_open_context
*nfs_find_open_context(struct inode
*inode
, const struct cred
*cred
, fmode_t mode
);
394 extern struct nfs_open_context
*alloc_nfs_open_context(struct dentry
*dentry
, fmode_t f_mode
, struct file
*filp
);
395 extern void nfs_inode_attach_open_context(struct nfs_open_context
*ctx
);
396 extern void nfs_file_set_open_context(struct file
*filp
, struct nfs_open_context
*ctx
);
397 extern void nfs_file_clear_open_context(struct file
*flip
);
398 extern struct nfs_lock_context
*nfs_get_lock_context(struct nfs_open_context
*ctx
);
399 extern void nfs_put_lock_context(struct nfs_lock_context
*l_ctx
);
400 extern u64
nfs_compat_user_ino64(u64 fileid
);
401 extern void nfs_fattr_init(struct nfs_fattr
*fattr
);
402 extern void nfs_fattr_set_barrier(struct nfs_fattr
*fattr
);
403 extern unsigned long nfs_inc_attr_generation_counter(void);
405 extern struct nfs_fattr
*nfs_alloc_fattr(void);
407 static inline void nfs_free_fattr(const struct nfs_fattr
*fattr
)
412 extern struct nfs_fh
*nfs_alloc_fhandle(void);
414 static inline void nfs_free_fhandle(const struct nfs_fh
*fh
)
420 extern u32
_nfs_display_fhandle_hash(const struct nfs_fh
*fh
);
421 static inline u32
nfs_display_fhandle_hash(const struct nfs_fh
*fh
)
423 return _nfs_display_fhandle_hash(fh
);
425 extern void _nfs_display_fhandle(const struct nfs_fh
*fh
, const char *caption
);
426 #define nfs_display_fhandle(fh, caption) \
428 if (unlikely(nfs_debug & NFSDBG_FACILITY)) \
429 _nfs_display_fhandle(fh, caption); \
432 static inline u32
nfs_display_fhandle_hash(const struct nfs_fh
*fh
)
436 static inline void nfs_display_fhandle(const struct nfs_fh
*fh
,
443 * linux/fs/nfs/nfsroot.c
445 extern int nfs_root_data(char **root_device
, char **root_data
); /*__init*/
446 /* linux/net/ipv4/ipconfig.c: trims ip addr off front of name, too. */
447 extern __be32
root_nfs_parse_addr(char *name
); /*__init*/
450 * linux/fs/nfs/file.c
452 extern const struct file_operations nfs_file_operations
;
453 #if IS_ENABLED(CONFIG_NFS_V4)
454 extern const struct file_operations nfs4_file_operations
;
455 #endif /* CONFIG_NFS_V4 */
456 extern const struct address_space_operations nfs_file_aops
;
457 extern const struct address_space_operations nfs_dir_aops
;
459 static inline struct nfs_open_context
*nfs_file_open_context(struct file
*filp
)
461 return filp
->private_data
;
464 static inline const struct cred
*nfs_file_cred(struct file
*file
)
467 struct nfs_open_context
*ctx
=
468 nfs_file_open_context(file
);
476 * linux/fs/nfs/direct.c
478 extern ssize_t
nfs_direct_IO(struct kiocb
*, struct iov_iter
*);
479 extern ssize_t
nfs_file_direct_read(struct kiocb
*iocb
,
480 struct iov_iter
*iter
);
481 extern ssize_t
nfs_file_direct_write(struct kiocb
*iocb
,
482 struct iov_iter
*iter
);
487 extern const struct file_operations nfs_dir_operations
;
488 extern const struct dentry_operations nfs_dentry_operations
;
490 extern void nfs_force_lookup_revalidate(struct inode
*dir
);
491 extern int nfs_instantiate(struct dentry
*dentry
, struct nfs_fh
*fh
,
492 struct nfs_fattr
*fattr
, struct nfs4_label
*label
);
493 extern int nfs_may_open(struct inode
*inode
, const struct cred
*cred
, int openflags
);
494 extern void nfs_access_zap_cache(struct inode
*inode
);
497 * linux/fs/nfs/symlink.c
499 extern const struct inode_operations nfs_symlink_inode_operations
;
502 * linux/fs/nfs/sysctl.c
505 extern int nfs_register_sysctl(void);
506 extern void nfs_unregister_sysctl(void);
508 #define nfs_register_sysctl() 0
509 #define nfs_unregister_sysctl() do { } while(0)
513 * linux/fs/nfs/namespace.c
515 extern const struct inode_operations nfs_mountpoint_inode_operations
;
516 extern const struct inode_operations nfs_referral_inode_operations
;
517 extern int nfs_mountpoint_expiry_timeout
;
518 extern void nfs_release_automount_timer(void);
521 * linux/fs/nfs/unlink.c
523 extern void nfs_complete_unlink(struct dentry
*dentry
, struct inode
*);
526 * linux/fs/nfs/write.c
528 extern int nfs_congestion_kb
;
529 extern int nfs_writepage(struct page
*page
, struct writeback_control
*wbc
);
530 extern int nfs_writepages(struct address_space
*, struct writeback_control
*);
531 extern int nfs_flush_incompatible(struct file
*file
, struct page
*page
);
532 extern int nfs_updatepage(struct file
*, struct page
*, unsigned int, unsigned int);
535 * Try to write back everything synchronously (but check the
538 extern int nfs_sync_inode(struct inode
*inode
);
539 extern int nfs_wb_all(struct inode
*inode
);
540 extern int nfs_wb_page(struct inode
*inode
, struct page
*page
);
541 extern int nfs_wb_page_cancel(struct inode
*inode
, struct page
* page
);
542 extern int nfs_commit_inode(struct inode
*, int);
543 extern struct nfs_commit_data
*nfs_commitdata_alloc(bool never_fail
);
544 extern void nfs_commit_free(struct nfs_commit_data
*data
);
547 nfs_have_writebacks(struct inode
*inode
)
549 return atomic_long_read(&NFS_I(inode
)->nrequests
) != 0;
553 * linux/fs/nfs/read.c
555 extern int nfs_readpage(struct file
*, struct page
*);
556 extern int nfs_readpages(struct file
*, struct address_space
*,
557 struct list_head
*, unsigned);
558 extern int nfs_readpage_async(struct nfs_open_context
*, struct inode
*,
565 static inline loff_t
nfs_size_to_loff_t(__u64 size
)
567 return min_t(u64
, size
, OFFSET_MAX
);
571 nfs_fileid_to_ino_t(u64 fileid
)
573 ino_t ino
= (ino_t
) fileid
;
574 if (sizeof(ino_t
) < sizeof(u64
))
575 ino
^= fileid
>> (sizeof(u64
)-sizeof(ino_t
)) * 8;
579 #define NFS_JUKEBOX_RETRY_TIME (5 * HZ)
584 # define ifdebug(fac) if (unlikely(nfs_debug & NFSDBG_##fac))
585 # define NFS_IFDEBUG(x) x
587 # define ifdebug(fac) if (0)
588 # define NFS_IFDEBUG(x)