2 * linux/include/linux/nfs_fs.h
4 * Copyright (C) 1992 Rick Sladkey
6 * OS-specific nfs filesystem definitions and declarations
8 #ifndef _LINUX_NFS_FS_H
9 #define _LINUX_NFS_FS_H
11 #include <uapi/linux/nfs_fs.h>
15 * Enable dprintk() debugging support for nfs client.
17 #ifdef CONFIG_NFS_DEBUG
23 #include <linux/pagemap.h>
24 #include <linux/rbtree.h>
25 #include <linux/rwsem.h>
26 #include <linux/wait.h>
28 #include <linux/sunrpc/debug.h>
29 #include <linux/sunrpc/auth.h>
30 #include <linux/sunrpc/clnt.h>
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>
39 #include <linux/mempool.h>
42 * These are the default flags for swap requests
44 #define NFS_RPC_SWAPFLAGS (RPC_TASK_SWAPPER|RPC_TASK_ROOTCREDS)
47 * NFSv3/v4 Access mode cache entry
49 struct nfs_access_entry
{
50 struct rb_node rb_node
;
52 unsigned long jiffies
;
53 struct rpc_cred
* cred
;
57 struct nfs_lockowner
{
62 #define NFS_IO_INPROGRESS 0
63 struct nfs_io_counter
{
68 struct nfs_lock_context
{
70 struct list_head list
;
71 struct nfs_open_context
*open_context
;
72 struct nfs_lockowner lockowner
;
73 struct nfs_io_counter io_count
;
77 struct nfs_open_context
{
78 struct nfs_lock_context lock_context
;
79 struct dentry
*dentry
;
80 struct rpc_cred
*cred
;
81 struct nfs4_state
*state
;
85 #define NFS_CONTEXT_ERROR_WRITE (0)
86 #define NFS_CONTEXT_RESEND_WRITES (1)
87 #define NFS_CONTEXT_BAD (2)
90 struct list_head list
;
91 struct nfs4_threshold
*mdsthreshold
;
94 struct nfs_open_dir_context
{
95 struct rpc_cred
*cred
;
96 unsigned long attr_gencount
;
105 struct nfs_delegation
;
110 * nfs fs inode data in memory
114 * The 64bit 'inode number'
126 unsigned long flags
; /* atomic bit ops */
127 unsigned long cache_validity
; /* bit mask */
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
136 * We need to revalidate the cached attrs for this inode if
138 * jiffies - read_cache_jiffies >= attrtimeo
140 * Please note the comparison is greater than or equal
141 * so that zero timeout values can be specified.
143 unsigned long read_cache_jiffies
;
144 unsigned long attrtimeo
;
145 unsigned long attrtimeo_timestamp
;
147 unsigned long attr_gencount
;
148 /* "Generation counter" for the attribute cache. This is
149 * bumped whenever we update the metadata on the
152 unsigned long cache_change_attribute
;
154 struct rb_root access_cache
;
155 struct list_head access_cache_entry_lru
;
156 struct list_head access_cache_inode_lru
;
159 * This is the cookie verifier used for NFSv3 readdir
162 __be32 cookieverf
[2];
164 unsigned long npages
;
165 struct nfs_mds_commit_info commit_info
;
167 /* Open contexts for shared mmap writes */
168 struct list_head open_files
;
170 /* Number of in-flight sillydelete RPC calls */
171 atomic_t silly_count
;
172 /* List of deferred sillydelete requests */
173 struct hlist_head silly_list
;
174 wait_queue_head_t waitqueue
;
176 #if IS_ENABLED(CONFIG_NFS_V4)
177 struct nfs4_cached_acl
*nfs4_acl
;
179 struct list_head open_states
;
180 struct nfs_delegation __rcu
*delegation
;
181 fmode_t delegation_state
;
182 struct rw_semaphore rwsem
;
184 /* pNFS layout information */
185 struct pnfs_layout_hdr
*layout
;
186 #endif /* CONFIG_NFS_V4*/
187 /* how many bytes have been written/read and how many bytes queued up */
190 #ifdef CONFIG_NFS_FSCACHE
191 struct fscache_cookie
*fscache
;
193 struct inode vfs_inode
;
197 * Cache validity bit flags
199 #define NFS_INO_INVALID_ATTR 0x0001 /* cached attrs are invalid */
200 #define NFS_INO_INVALID_DATA 0x0002 /* cached data is invalid */
201 #define NFS_INO_INVALID_ATIME 0x0004 /* cached atime is invalid */
202 #define NFS_INO_INVALID_ACCESS 0x0008 /* cached access cred invalid */
203 #define NFS_INO_INVALID_ACL 0x0010 /* cached acls are invalid */
204 #define NFS_INO_REVAL_PAGECACHE 0x0020 /* must revalidate pagecache */
205 #define NFS_INO_REVAL_FORCED 0x0040 /* force revalidation ignoring a delegation */
206 #define NFS_INO_INVALID_LABEL 0x0080 /* cached label is invalid */
209 * Bit offsets in flags field
211 #define NFS_INO_ADVISE_RDPLUS (0) /* advise readdirplus */
212 #define NFS_INO_STALE (1) /* possible stale inode */
213 #define NFS_INO_ACL_LRU_SET (2) /* Inode is on the LRU list */
214 #define NFS_INO_FLUSHING (4) /* inode is flushing out data */
215 #define NFS_INO_FSCACHE (5) /* inode can be cached by FS-Cache */
216 #define NFS_INO_FSCACHE_LOCK (6) /* FS-Cache cookie management lock */
217 #define NFS_INO_COMMIT (7) /* inode is committing unstable writes */
218 #define NFS_INO_LAYOUTCOMMIT (9) /* layoutcommit required */
219 #define NFS_INO_LAYOUTCOMMITTING (10) /* layoutcommit inflight */
221 static inline struct nfs_inode
*NFS_I(const struct inode
*inode
)
223 return container_of(inode
, struct nfs_inode
, vfs_inode
);
226 static inline struct nfs_server
*NFS_SB(const struct super_block
*s
)
228 return (struct nfs_server
*)(s
->s_fs_info
);
231 static inline struct nfs_fh
*NFS_FH(const struct inode
*inode
)
233 return &NFS_I(inode
)->fh
;
236 static inline struct nfs_server
*NFS_SERVER(const struct inode
*inode
)
238 return NFS_SB(inode
->i_sb
);
241 static inline struct rpc_clnt
*NFS_CLIENT(const struct inode
*inode
)
243 return NFS_SERVER(inode
)->client
;
246 static inline const struct nfs_rpc_ops
*NFS_PROTO(const struct inode
*inode
)
248 return NFS_SERVER(inode
)->nfs_client
->rpc_ops
;
251 static inline unsigned NFS_MINATTRTIMEO(const struct inode
*inode
)
253 struct nfs_server
*nfss
= NFS_SERVER(inode
);
254 return S_ISDIR(inode
->i_mode
) ? nfss
->acdirmin
: nfss
->acregmin
;
257 static inline unsigned NFS_MAXATTRTIMEO(const struct inode
*inode
)
259 struct nfs_server
*nfss
= NFS_SERVER(inode
);
260 return S_ISDIR(inode
->i_mode
) ? nfss
->acdirmax
: nfss
->acregmax
;
263 static inline int NFS_STALE(const struct inode
*inode
)
265 return test_bit(NFS_INO_STALE
, &NFS_I(inode
)->flags
);
268 static inline struct fscache_cookie
*nfs_i_fscache(struct inode
*inode
)
270 #ifdef CONFIG_NFS_FSCACHE
271 return NFS_I(inode
)->fscache
;
277 static inline __u64
NFS_FILEID(const struct inode
*inode
)
279 return NFS_I(inode
)->fileid
;
282 static inline void set_nfs_fileid(struct inode
*inode
, __u64 fileid
)
284 NFS_I(inode
)->fileid
= fileid
;
287 static inline void nfs_mark_for_revalidate(struct inode
*inode
)
289 struct nfs_inode
*nfsi
= NFS_I(inode
);
291 spin_lock(&inode
->i_lock
);
292 nfsi
->cache_validity
|= NFS_INO_INVALID_ATTR
|NFS_INO_INVALID_ACCESS
;
293 if (S_ISDIR(inode
->i_mode
))
294 nfsi
->cache_validity
|= NFS_INO_REVAL_PAGECACHE
|NFS_INO_INVALID_DATA
;
295 spin_unlock(&inode
->i_lock
);
298 static inline int nfs_server_capable(struct inode
*inode
, int cap
)
300 return NFS_SERVER(inode
)->caps
& cap
;
303 static inline void nfs_set_verifier(struct dentry
* dentry
, unsigned long verf
)
305 dentry
->d_time
= verf
;
309 * nfs_save_change_attribute - Returns the inode attribute change cookie
310 * @dir - pointer to parent directory inode
311 * The "change attribute" is updated every time we finish an operation
312 * that will result in a metadata change on the server.
314 static inline unsigned long nfs_save_change_attribute(struct inode
*dir
)
316 return NFS_I(dir
)->cache_change_attribute
;
320 * nfs_verify_change_attribute - Detects NFS remote directory changes
321 * @dir - pointer to parent directory inode
322 * @chattr - previously saved change attribute
323 * Return "false" if the verifiers doesn't match the change attribute.
324 * This would usually indicate that the directory contents have changed on
325 * the server, and that any dentries need revalidating.
327 static inline int nfs_verify_change_attribute(struct inode
*dir
, unsigned long chattr
)
329 return chattr
== NFS_I(dir
)->cache_change_attribute
;
333 * linux/fs/nfs/inode.c
335 extern int nfs_sync_mapping(struct address_space
*mapping
);
336 extern void nfs_zap_mapping(struct inode
*inode
, struct address_space
*mapping
);
337 extern void nfs_zap_caches(struct inode
*);
338 extern void nfs_invalidate_atime(struct inode
*);
339 extern struct inode
*nfs_fhget(struct super_block
*, struct nfs_fh
*,
340 struct nfs_fattr
*, struct nfs4_label
*);
341 extern int nfs_refresh_inode(struct inode
*, struct nfs_fattr
*);
342 extern int nfs_post_op_update_inode(struct inode
*inode
, struct nfs_fattr
*fattr
);
343 extern int nfs_post_op_update_inode_force_wcc(struct inode
*inode
, struct nfs_fattr
*fattr
);
344 extern int nfs_getattr(struct vfsmount
*, struct dentry
*, struct kstat
*);
345 extern void nfs_access_add_cache(struct inode
*, struct nfs_access_entry
*);
346 extern void nfs_access_set_mask(struct nfs_access_entry
*, u32
);
347 extern int nfs_permission(struct inode
*, int);
348 extern int nfs_open(struct inode
*, struct file
*);
349 extern int nfs_release(struct inode
*, struct file
*);
350 extern int nfs_attribute_timeout(struct inode
*inode
);
351 extern int nfs_attribute_cache_expired(struct inode
*inode
);
352 extern int nfs_revalidate_inode(struct nfs_server
*server
, struct inode
*inode
);
353 extern int __nfs_revalidate_inode(struct nfs_server
*, struct inode
*);
354 extern int nfs_revalidate_mapping(struct inode
*inode
, struct address_space
*mapping
);
355 extern int nfs_setattr(struct dentry
*, struct iattr
*);
356 extern void nfs_setattr_update_inode(struct inode
*inode
, struct iattr
*attr
);
357 extern void nfs_setsecurity(struct inode
*inode
, struct nfs_fattr
*fattr
,
358 struct nfs4_label
*label
);
359 extern struct nfs_open_context
*get_nfs_open_context(struct nfs_open_context
*ctx
);
360 extern void put_nfs_open_context(struct nfs_open_context
*ctx
);
361 extern struct nfs_open_context
*nfs_find_open_context(struct inode
*inode
, struct rpc_cred
*cred
, fmode_t mode
);
362 extern struct nfs_open_context
*alloc_nfs_open_context(struct dentry
*dentry
, fmode_t f_mode
);
363 extern void nfs_inode_attach_open_context(struct nfs_open_context
*ctx
);
364 extern void nfs_file_set_open_context(struct file
*filp
, struct nfs_open_context
*ctx
);
365 extern struct nfs_lock_context
*nfs_get_lock_context(struct nfs_open_context
*ctx
);
366 extern void nfs_put_lock_context(struct nfs_lock_context
*l_ctx
);
367 extern u64
nfs_compat_user_ino64(u64 fileid
);
368 extern void nfs_fattr_init(struct nfs_fattr
*fattr
);
369 extern unsigned long nfs_inc_attr_generation_counter(void);
371 extern struct nfs_fattr
*nfs_alloc_fattr(void);
373 static inline void nfs_free_fattr(const struct nfs_fattr
*fattr
)
378 extern struct nfs_fh
*nfs_alloc_fhandle(void);
380 static inline void nfs_free_fhandle(const struct nfs_fh
*fh
)
386 extern u32
_nfs_display_fhandle_hash(const struct nfs_fh
*fh
);
387 static inline u32
nfs_display_fhandle_hash(const struct nfs_fh
*fh
)
389 return _nfs_display_fhandle_hash(fh
);
391 extern void _nfs_display_fhandle(const struct nfs_fh
*fh
, const char *caption
);
392 #define nfs_display_fhandle(fh, caption) \
394 if (unlikely(nfs_debug & NFSDBG_FACILITY)) \
395 _nfs_display_fhandle(fh, caption); \
398 static inline u32
nfs_display_fhandle_hash(const struct nfs_fh
*fh
)
402 static inline void nfs_display_fhandle(const struct nfs_fh
*fh
,
409 * linux/fs/nfs/nfsroot.c
411 extern int nfs_root_data(char **root_device
, char **root_data
); /*__init*/
412 /* linux/net/ipv4/ipconfig.c: trims ip addr off front of name, too. */
413 extern __be32
root_nfs_parse_addr(char *name
); /*__init*/
416 * linux/fs/nfs/file.c
418 extern const struct file_operations nfs_file_operations
;
419 #if IS_ENABLED(CONFIG_NFS_V4)
420 extern const struct file_operations nfs4_file_operations
;
421 #endif /* CONFIG_NFS_V4 */
422 extern const struct address_space_operations nfs_file_aops
;
423 extern const struct address_space_operations nfs_dir_aops
;
425 static inline struct nfs_open_context
*nfs_file_open_context(struct file
*filp
)
427 return filp
->private_data
;
430 static inline struct rpc_cred
*nfs_file_cred(struct file
*file
)
433 struct nfs_open_context
*ctx
=
434 nfs_file_open_context(file
);
442 * linux/fs/nfs/xattr.c
444 #ifdef CONFIG_NFS_V3_ACL
445 extern ssize_t
nfs3_listxattr(struct dentry
*, char *, size_t);
446 extern ssize_t
nfs3_getxattr(struct dentry
*, const char *, void *, size_t);
447 extern int nfs3_setxattr(struct dentry
*, const char *,
448 const void *, size_t, int);
449 extern int nfs3_removexattr (struct dentry
*, const char *name
);
451 # define nfs3_listxattr NULL
452 # define nfs3_getxattr NULL
453 # define nfs3_setxattr NULL
454 # define nfs3_removexattr NULL
458 * linux/fs/nfs/direct.c
460 extern ssize_t
nfs_direct_IO(int, struct kiocb
*, const struct iovec
*, loff_t
,
462 extern ssize_t
nfs_file_direct_read(struct kiocb
*iocb
,
463 const struct iovec
*iov
, unsigned long nr_segs
,
464 loff_t pos
, bool uio
);
465 extern ssize_t
nfs_file_direct_write(struct kiocb
*iocb
,
466 const struct iovec
*iov
, unsigned long nr_segs
,
467 loff_t pos
, bool uio
);
472 extern const struct file_operations nfs_dir_operations
;
473 extern const struct dentry_operations nfs_dentry_operations
;
475 extern void nfs_force_lookup_revalidate(struct inode
*dir
);
476 extern int nfs_instantiate(struct dentry
*dentry
, struct nfs_fh
*fh
,
477 struct nfs_fattr
*fattr
, struct nfs4_label
*label
);
478 extern int nfs_may_open(struct inode
*inode
, struct rpc_cred
*cred
, int openflags
);
479 extern void nfs_access_zap_cache(struct inode
*inode
);
482 * linux/fs/nfs/symlink.c
484 extern const struct inode_operations nfs_symlink_inode_operations
;
487 * linux/fs/nfs/sysctl.c
490 extern int nfs_register_sysctl(void);
491 extern void nfs_unregister_sysctl(void);
493 #define nfs_register_sysctl() 0
494 #define nfs_unregister_sysctl() do { } while(0)
498 * linux/fs/nfs/namespace.c
500 extern const struct inode_operations nfs_mountpoint_inode_operations
;
501 extern const struct inode_operations nfs_referral_inode_operations
;
502 extern int nfs_mountpoint_expiry_timeout
;
503 extern void nfs_release_automount_timer(void);
506 * linux/fs/nfs/unlink.c
508 extern void nfs_complete_unlink(struct dentry
*dentry
, struct inode
*);
509 extern void nfs_wait_on_sillyrename(struct dentry
*dentry
);
510 extern void nfs_block_sillyrename(struct dentry
*dentry
);
511 extern void nfs_unblock_sillyrename(struct dentry
*dentry
);
512 extern int nfs_sillyrename(struct inode
*dir
, struct dentry
*dentry
);
515 * linux/fs/nfs/write.c
517 extern int nfs_congestion_kb
;
518 extern int nfs_writepage(struct page
*page
, struct writeback_control
*wbc
);
519 extern int nfs_writepages(struct address_space
*, struct writeback_control
*);
520 extern int nfs_flush_incompatible(struct file
*file
, struct page
*page
);
521 extern int nfs_updatepage(struct file
*, struct page
*, unsigned int, unsigned int);
522 extern void nfs_writeback_done(struct rpc_task
*, struct nfs_write_data
*);
525 * Try to write back everything synchronously (but check the
528 extern int nfs_wb_all(struct inode
*inode
);
529 extern int nfs_wb_page(struct inode
*inode
, struct page
* page
);
530 extern int nfs_wb_page_cancel(struct inode
*inode
, struct page
* page
);
531 #if IS_ENABLED(CONFIG_NFS_V3) || IS_ENABLED(CONFIG_NFS_V4)
532 extern int nfs_commit_inode(struct inode
*, int);
533 extern struct nfs_commit_data
*nfs_commitdata_alloc(void);
534 extern void nfs_commit_free(struct nfs_commit_data
*data
);
537 nfs_commit_inode(struct inode
*inode
, int how
)
544 nfs_have_writebacks(struct inode
*inode
)
546 return NFS_I(inode
)->npages
!= 0;
550 * linux/fs/nfs/read.c
552 extern int nfs_readpage(struct file
*, struct page
*);
553 extern int nfs_readpages(struct file
*, struct address_space
*,
554 struct list_head
*, unsigned);
555 extern int nfs_readpage_result(struct rpc_task
*, struct nfs_read_data
*);
556 extern int nfs_readpage_async(struct nfs_open_context
*, struct inode
*,
560 * linux/fs/nfs3proc.c
562 #ifdef CONFIG_NFS_V3_ACL
563 extern struct posix_acl
*nfs3_get_acl(struct inode
*inode
, int type
);
564 extern int nfs3_set_acl(struct inode
*inode
, struct posix_acl
*acl
, int type
);
565 extern int nfs3_proc_setacls(struct inode
*inode
, struct posix_acl
*acl
,
566 struct posix_acl
*dfacl
);
567 extern const struct xattr_handler
*nfs3_xattr_handlers
[];
569 static inline int nfs3_proc_setacls(struct inode
*inode
, struct posix_acl
*acl
,
570 struct posix_acl
*dfacl
)
574 #endif /* CONFIG_NFS_V3_ACL */
580 static inline loff_t
nfs_size_to_loff_t(__u64 size
)
582 if (size
> (__u64
) OFFSET_MAX
- 1)
583 return OFFSET_MAX
- 1;
584 return (loff_t
) size
;
588 nfs_fileid_to_ino_t(u64 fileid
)
590 ino_t ino
= (ino_t
) fileid
;
591 if (sizeof(ino_t
) < sizeof(u64
))
592 ino
^= fileid
>> (sizeof(u64
)-sizeof(ino_t
)) * 8;
596 #define NFS_JUKEBOX_RETRY_TIME (5 * HZ)
601 # define ifdebug(fac) if (unlikely(nfs_debug & NFSDBG_##fac))
602 # define NFS_IFDEBUG(x) x
604 # define ifdebug(fac) if (0)
605 # define NFS_IFDEBUG(x)