2 * linux/include/linux/nfs_fs.h
4 * Copyright (C) 1992 Rick Sladkey
6 * OS-specific nfs filesystem definitions and declarations
9 #ifndef _LINUX_NFS_FS_H
10 #define _LINUX_NFS_FS_H
12 #include <linux/magic.h>
14 /* Default timeout values */
15 #define NFS_DEF_UDP_TIMEO (11)
16 #define NFS_DEF_UDP_RETRANS (3)
17 #define NFS_DEF_TCP_TIMEO (600)
18 #define NFS_DEF_TCP_RETRANS (2)
20 #define NFS_MAX_UDP_TIMEOUT (60*HZ)
21 #define NFS_MAX_TCP_TIMEOUT (600*HZ)
23 #define NFS_DEF_ACREGMIN (3)
24 #define NFS_DEF_ACREGMAX (60)
25 #define NFS_DEF_ACDIRMIN (30)
26 #define NFS_DEF_ACDIRMAX (60)
29 * When flushing a cluster of dirty pages, there can be different
32 #define FLUSH_SYNC 1 /* file being synced, or contention */
33 #define FLUSH_STABLE 4 /* commit to stable storage */
34 #define FLUSH_LOWPRI 8 /* low priority background flush */
35 #define FLUSH_HIGHPRI 16 /* high priority memory reclaim flush */
36 #define FLUSH_COND_STABLE 32 /* conditional stable write - only stable
37 * if everything fits in one RPC */
42 * Enable dprintk() debugging support for nfs client.
44 #ifdef CONFIG_NFS_DEBUG
50 #include <linux/pagemap.h>
51 #include <linux/rbtree.h>
52 #include <linux/rwsem.h>
53 #include <linux/wait.h>
55 #include <linux/sunrpc/debug.h>
56 #include <linux/sunrpc/auth.h>
57 #include <linux/sunrpc/clnt.h>
59 #include <linux/nfs.h>
60 #include <linux/nfs2.h>
61 #include <linux/nfs3.h>
62 #include <linux/nfs4.h>
63 #include <linux/nfs_xdr.h>
64 #include <linux/nfs_fs_sb.h>
66 #include <linux/mempool.h>
69 * These are the default flags for swap requests
71 #define NFS_RPC_SWAPFLAGS (RPC_TASK_SWAPPER|RPC_TASK_ROOTCREDS)
74 * NFSv3/v4 Access mode cache entry
76 struct nfs_access_entry
{
77 struct rb_node rb_node
;
79 unsigned long jiffies
;
80 struct rpc_cred
* cred
;
84 struct nfs_lockowner
{
89 struct nfs_lock_context
{
91 struct list_head list
;
92 struct nfs_open_context
*open_context
;
93 struct nfs_lockowner lockowner
;
97 struct nfs_open_context
{
98 struct nfs_lock_context lock_context
;
99 struct dentry
*dentry
;
100 struct rpc_cred
*cred
;
101 struct nfs4_state
*state
;
105 #define NFS_CONTEXT_ERROR_WRITE (0)
106 #define NFS_CONTEXT_RESEND_WRITES (1)
109 struct list_head list
;
110 struct nfs4_threshold
*mdsthreshold
;
113 struct nfs_open_dir_context
{
114 struct rpc_cred
*cred
;
115 unsigned long attr_gencount
;
124 struct nfs_delegation
;
129 * nfs fs inode data in memory
133 * The 64bit 'inode number'
145 unsigned long flags
; /* atomic bit ops */
146 unsigned long cache_validity
; /* bit mask */
149 * read_cache_jiffies is when we started read-caching this inode.
150 * attrtimeo is for how long the cached information is assumed
151 * to be valid. A successful attribute revalidation doubles
152 * attrtimeo (up to acregmax/acdirmax), a failure resets it to
155 * We need to revalidate the cached attrs for this inode if
157 * jiffies - read_cache_jiffies >= attrtimeo
159 * Please note the comparison is greater than or equal
160 * so that zero timeout values can be specified.
162 unsigned long read_cache_jiffies
;
163 unsigned long attrtimeo
;
164 unsigned long attrtimeo_timestamp
;
166 unsigned long attr_gencount
;
167 /* "Generation counter" for the attribute cache. This is
168 * bumped whenever we update the metadata on the
171 unsigned long cache_change_attribute
;
173 struct rb_root access_cache
;
174 struct list_head access_cache_entry_lru
;
175 struct list_head access_cache_inode_lru
;
176 #ifdef CONFIG_NFS_V3_ACL
177 struct posix_acl
*acl_access
;
178 struct posix_acl
*acl_default
;
182 * This is the cookie verifier used for NFSv3 readdir
185 __be32 cookieverf
[2];
187 unsigned long npages
;
188 struct nfs_mds_commit_info commit_info
;
190 /* Open contexts for shared mmap writes */
191 struct list_head open_files
;
193 /* Number of in-flight sillydelete RPC calls */
194 atomic_t silly_count
;
195 /* List of deferred sillydelete requests */
196 struct hlist_head silly_list
;
197 wait_queue_head_t waitqueue
;
199 #if IS_ENABLED(CONFIG_NFS_V4)
200 struct nfs4_cached_acl
*nfs4_acl
;
202 struct list_head open_states
;
203 struct nfs_delegation __rcu
*delegation
;
204 fmode_t delegation_state
;
205 struct rw_semaphore rwsem
;
207 /* pNFS layout information */
208 struct pnfs_layout_hdr
*layout
;
209 #endif /* CONFIG_NFS_V4*/
210 /* how many bytes have been written/read and how many bytes queued up */
213 #ifdef CONFIG_NFS_FSCACHE
214 struct fscache_cookie
*fscache
;
216 struct inode vfs_inode
;
220 * Cache validity bit flags
222 #define NFS_INO_INVALID_ATTR 0x0001 /* cached attrs are invalid */
223 #define NFS_INO_INVALID_DATA 0x0002 /* cached data is invalid */
224 #define NFS_INO_INVALID_ATIME 0x0004 /* cached atime is invalid */
225 #define NFS_INO_INVALID_ACCESS 0x0008 /* cached access cred invalid */
226 #define NFS_INO_INVALID_ACL 0x0010 /* cached acls are invalid */
227 #define NFS_INO_REVAL_PAGECACHE 0x0020 /* must revalidate pagecache */
228 #define NFS_INO_REVAL_FORCED 0x0040 /* force revalidation ignoring a delegation */
231 * Bit offsets in flags field
233 #define NFS_INO_ADVISE_RDPLUS (0) /* advise readdirplus */
234 #define NFS_INO_STALE (1) /* possible stale inode */
235 #define NFS_INO_ACL_LRU_SET (2) /* Inode is on the LRU list */
236 #define NFS_INO_FLUSHING (4) /* inode is flushing out data */
237 #define NFS_INO_FSCACHE (5) /* inode can be cached by FS-Cache */
238 #define NFS_INO_FSCACHE_LOCK (6) /* FS-Cache cookie management lock */
239 #define NFS_INO_COMMIT (7) /* inode is committing unstable writes */
240 #define NFS_INO_LAYOUTCOMMIT (9) /* layoutcommit required */
241 #define NFS_INO_LAYOUTCOMMITTING (10) /* layoutcommit inflight */
243 static inline struct nfs_inode
*NFS_I(const struct inode
*inode
)
245 return container_of(inode
, struct nfs_inode
, vfs_inode
);
248 static inline struct nfs_server
*NFS_SB(const struct super_block
*s
)
250 return (struct nfs_server
*)(s
->s_fs_info
);
253 static inline struct nfs_fh
*NFS_FH(const struct inode
*inode
)
255 return &NFS_I(inode
)->fh
;
258 static inline struct nfs_server
*NFS_SERVER(const struct inode
*inode
)
260 return NFS_SB(inode
->i_sb
);
263 static inline struct rpc_clnt
*NFS_CLIENT(const struct inode
*inode
)
265 return NFS_SERVER(inode
)->client
;
268 static inline const struct nfs_rpc_ops
*NFS_PROTO(const struct inode
*inode
)
270 return NFS_SERVER(inode
)->nfs_client
->rpc_ops
;
273 static inline unsigned NFS_MINATTRTIMEO(const struct inode
*inode
)
275 struct nfs_server
*nfss
= NFS_SERVER(inode
);
276 return S_ISDIR(inode
->i_mode
) ? nfss
->acdirmin
: nfss
->acregmin
;
279 static inline unsigned NFS_MAXATTRTIMEO(const struct inode
*inode
)
281 struct nfs_server
*nfss
= NFS_SERVER(inode
);
282 return S_ISDIR(inode
->i_mode
) ? nfss
->acdirmax
: nfss
->acregmax
;
285 static inline int NFS_STALE(const struct inode
*inode
)
287 return test_bit(NFS_INO_STALE
, &NFS_I(inode
)->flags
);
290 static inline int NFS_FSCACHE(const struct inode
*inode
)
292 return test_bit(NFS_INO_FSCACHE
, &NFS_I(inode
)->flags
);
295 static inline __u64
NFS_FILEID(const struct inode
*inode
)
297 return NFS_I(inode
)->fileid
;
300 static inline void set_nfs_fileid(struct inode
*inode
, __u64 fileid
)
302 NFS_I(inode
)->fileid
= fileid
;
305 static inline void nfs_mark_for_revalidate(struct inode
*inode
)
307 struct nfs_inode
*nfsi
= NFS_I(inode
);
309 spin_lock(&inode
->i_lock
);
310 nfsi
->cache_validity
|= NFS_INO_INVALID_ATTR
|NFS_INO_INVALID_ACCESS
;
311 if (S_ISDIR(inode
->i_mode
))
312 nfsi
->cache_validity
|= NFS_INO_REVAL_PAGECACHE
|NFS_INO_INVALID_DATA
;
313 spin_unlock(&inode
->i_lock
);
316 static inline int nfs_server_capable(struct inode
*inode
, int cap
)
318 return NFS_SERVER(inode
)->caps
& cap
;
321 static inline void nfs_set_verifier(struct dentry
* dentry
, unsigned long verf
)
323 dentry
->d_time
= verf
;
327 * nfs_save_change_attribute - Returns the inode attribute change cookie
328 * @dir - pointer to parent directory inode
329 * The "change attribute" is updated every time we finish an operation
330 * that will result in a metadata change on the server.
332 static inline unsigned long nfs_save_change_attribute(struct inode
*dir
)
334 return NFS_I(dir
)->cache_change_attribute
;
338 * nfs_verify_change_attribute - Detects NFS remote directory changes
339 * @dir - pointer to parent directory inode
340 * @chattr - previously saved change attribute
341 * Return "false" if the verifiers doesn't match the change attribute.
342 * This would usually indicate that the directory contents have changed on
343 * the server, and that any dentries need revalidating.
345 static inline int nfs_verify_change_attribute(struct inode
*dir
, unsigned long chattr
)
347 return chattr
== NFS_I(dir
)->cache_change_attribute
;
351 * linux/fs/nfs/inode.c
353 extern int nfs_sync_mapping(struct address_space
*mapping
);
354 extern void nfs_zap_mapping(struct inode
*inode
, struct address_space
*mapping
);
355 extern void nfs_zap_caches(struct inode
*);
356 extern void nfs_invalidate_atime(struct inode
*);
357 extern struct inode
*nfs_fhget(struct super_block
*, struct nfs_fh
*,
359 extern int nfs_refresh_inode(struct inode
*, struct nfs_fattr
*);
360 extern int nfs_post_op_update_inode(struct inode
*inode
, struct nfs_fattr
*fattr
);
361 extern int nfs_post_op_update_inode_force_wcc(struct inode
*inode
, struct nfs_fattr
*fattr
);
362 extern int nfs_getattr(struct vfsmount
*, struct dentry
*, struct kstat
*);
363 extern void nfs_access_add_cache(struct inode
*, struct nfs_access_entry
*);
364 extern void nfs_access_set_mask(struct nfs_access_entry
*, u32
);
365 extern int nfs_permission(struct inode
*, int);
366 extern int nfs_open(struct inode
*, struct file
*);
367 extern int nfs_release(struct inode
*, struct file
*);
368 extern int nfs_attribute_timeout(struct inode
*inode
);
369 extern int nfs_revalidate_inode(struct nfs_server
*server
, struct inode
*inode
);
370 extern int __nfs_revalidate_inode(struct nfs_server
*, struct inode
*);
371 extern int nfs_revalidate_mapping(struct inode
*inode
, struct address_space
*mapping
);
372 extern int nfs_setattr(struct dentry
*, struct iattr
*);
373 extern void nfs_setattr_update_inode(struct inode
*inode
, struct iattr
*attr
);
374 extern struct nfs_open_context
*get_nfs_open_context(struct nfs_open_context
*ctx
);
375 extern void put_nfs_open_context(struct nfs_open_context
*ctx
);
376 extern struct nfs_open_context
*nfs_find_open_context(struct inode
*inode
, struct rpc_cred
*cred
, fmode_t mode
);
377 extern struct nfs_open_context
*alloc_nfs_open_context(struct dentry
*dentry
, fmode_t f_mode
);
378 extern void nfs_file_set_open_context(struct file
*filp
, struct nfs_open_context
*ctx
);
379 extern struct nfs_lock_context
*nfs_get_lock_context(struct nfs_open_context
*ctx
);
380 extern void nfs_put_lock_context(struct nfs_lock_context
*l_ctx
);
381 extern u64
nfs_compat_user_ino64(u64 fileid
);
382 extern void nfs_fattr_init(struct nfs_fattr
*fattr
);
383 extern unsigned long nfs_inc_attr_generation_counter(void);
385 extern struct nfs_fattr
*nfs_alloc_fattr(void);
387 static inline void nfs_free_fattr(const struct nfs_fattr
*fattr
)
392 extern struct nfs_fh
*nfs_alloc_fhandle(void);
394 static inline void nfs_free_fhandle(const struct nfs_fh
*fh
)
400 extern u32
_nfs_display_fhandle_hash(const struct nfs_fh
*fh
);
401 static inline u32
nfs_display_fhandle_hash(const struct nfs_fh
*fh
)
403 return _nfs_display_fhandle_hash(fh
);
405 extern void _nfs_display_fhandle(const struct nfs_fh
*fh
, const char *caption
);
406 #define nfs_display_fhandle(fh, caption) \
408 if (unlikely(nfs_debug & NFSDBG_FACILITY)) \
409 _nfs_display_fhandle(fh, caption); \
412 static inline u32
nfs_display_fhandle_hash(const struct nfs_fh
*fh
)
416 static inline void nfs_display_fhandle(const struct nfs_fh
*fh
,
423 * linux/fs/nfs/nfsroot.c
425 extern int nfs_root_data(char **root_device
, char **root_data
); /*__init*/
426 /* linux/net/ipv4/ipconfig.c: trims ip addr off front of name, too. */
427 extern __be32
root_nfs_parse_addr(char *name
); /*__init*/
430 * linux/fs/nfs/file.c
432 extern const struct file_operations nfs_file_operations
;
433 #if IS_ENABLED(CONFIG_NFS_V4)
434 extern const struct file_operations nfs4_file_operations
;
435 #endif /* CONFIG_NFS_V4 */
436 extern const struct address_space_operations nfs_file_aops
;
437 extern const struct address_space_operations nfs_dir_aops
;
439 static inline struct nfs_open_context
*nfs_file_open_context(struct file
*filp
)
441 return filp
->private_data
;
444 static inline struct rpc_cred
*nfs_file_cred(struct file
*file
)
447 struct nfs_open_context
*ctx
=
448 nfs_file_open_context(file
);
456 * linux/fs/nfs/xattr.c
458 #ifdef CONFIG_NFS_V3_ACL
459 extern ssize_t
nfs3_listxattr(struct dentry
*, char *, size_t);
460 extern ssize_t
nfs3_getxattr(struct dentry
*, const char *, void *, size_t);
461 extern int nfs3_setxattr(struct dentry
*, const char *,
462 const void *, size_t, int);
463 extern int nfs3_removexattr (struct dentry
*, const char *name
);
465 # define nfs3_listxattr NULL
466 # define nfs3_getxattr NULL
467 # define nfs3_setxattr NULL
468 # define nfs3_removexattr NULL
472 * linux/fs/nfs/direct.c
474 extern ssize_t
nfs_direct_IO(int, struct kiocb
*, const struct iovec
*, loff_t
,
476 extern ssize_t
nfs_file_direct_read(struct kiocb
*iocb
,
477 const struct iovec
*iov
, unsigned long nr_segs
,
478 loff_t pos
, bool uio
);
479 extern ssize_t
nfs_file_direct_write(struct kiocb
*iocb
,
480 const struct iovec
*iov
, unsigned long nr_segs
,
481 loff_t pos
, bool uio
);
486 extern const struct file_operations nfs_dir_operations
;
487 extern const struct dentry_operations nfs_dentry_operations
;
489 extern void nfs_force_lookup_revalidate(struct inode
*dir
);
490 extern int nfs_instantiate(struct dentry
*dentry
, struct nfs_fh
*fh
, struct nfs_fattr
*fattr
);
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
);
495 * linux/fs/nfs/symlink.c
497 extern const struct inode_operations nfs_symlink_inode_operations
;
500 * linux/fs/nfs/sysctl.c
503 extern int nfs_register_sysctl(void);
504 extern void nfs_unregister_sysctl(void);
506 #define nfs_register_sysctl() 0
507 #define nfs_unregister_sysctl() do { } while(0)
511 * linux/fs/nfs/namespace.c
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);
519 * linux/fs/nfs/unlink.c
521 extern void nfs_complete_unlink(struct dentry
*dentry
, struct inode
*);
522 extern void nfs_block_sillyrename(struct dentry
*dentry
);
523 extern void nfs_unblock_sillyrename(struct dentry
*dentry
);
524 extern int nfs_sillyrename(struct inode
*dir
, struct dentry
*dentry
);
527 * linux/fs/nfs/write.c
529 extern int nfs_congestion_kb
;
530 extern int nfs_writepage(struct page
*page
, struct writeback_control
*wbc
);
531 extern int nfs_writepages(struct address_space
*, struct writeback_control
*);
532 extern int nfs_flush_incompatible(struct file
*file
, struct page
*page
);
533 extern int nfs_updatepage(struct file
*, struct page
*, unsigned int, unsigned int);
534 extern void nfs_writeback_done(struct rpc_task
*, struct nfs_write_data
*);
537 * Try to write back everything synchronously (but check the
540 extern int nfs_wb_all(struct inode
*inode
);
541 extern int nfs_wb_page(struct inode
*inode
, struct page
* page
);
542 extern int nfs_wb_page_cancel(struct inode
*inode
, struct page
* page
);
543 #if IS_ENABLED(CONFIG_NFS_V3) || IS_ENABLED(CONFIG_NFS_V4)
544 extern int nfs_commit_inode(struct inode
*, int);
545 extern struct nfs_commit_data
*nfs_commitdata_alloc(void);
546 extern void nfs_commit_free(struct nfs_commit_data
*data
);
549 nfs_commit_inode(struct inode
*inode
, int how
)
556 nfs_have_writebacks(struct inode
*inode
)
558 return NFS_I(inode
)->npages
!= 0;
562 * linux/fs/nfs/read.c
564 extern int nfs_readpage(struct file
*, struct page
*);
565 extern int nfs_readpages(struct file
*, struct address_space
*,
566 struct list_head
*, unsigned);
567 extern int nfs_readpage_result(struct rpc_task
*, struct nfs_read_data
*);
568 extern int nfs_readpage_async(struct nfs_open_context
*, struct inode
*,
572 * linux/fs/nfs3proc.c
574 #ifdef CONFIG_NFS_V3_ACL
575 extern struct posix_acl
*nfs3_proc_getacl(struct inode
*inode
, int type
);
576 extern int nfs3_proc_setacl(struct inode
*inode
, int type
,
577 struct posix_acl
*acl
);
578 extern int nfs3_proc_set_default_acl(struct inode
*dir
, struct inode
*inode
,
580 extern void nfs3_forget_cached_acls(struct inode
*inode
);
582 static inline int nfs3_proc_set_default_acl(struct inode
*dir
,
589 static inline void nfs3_forget_cached_acls(struct inode
*inode
)
592 #endif /* CONFIG_NFS_V3_ACL */
598 static inline loff_t
nfs_size_to_loff_t(__u64 size
)
600 if (size
> (__u64
) OFFSET_MAX
- 1)
601 return OFFSET_MAX
- 1;
602 return (loff_t
) size
;
606 nfs_fileid_to_ino_t(u64 fileid
)
608 ino_t ino
= (ino_t
) fileid
;
609 if (sizeof(ino_t
) < sizeof(u64
))
610 ino
^= fileid
>> (sizeof(u64
)-sizeof(ino_t
)) * 8;
614 #define NFS_JUKEBOX_RETRY_TIME (5 * HZ)
616 #endif /* __KERNEL__ */
621 #define NFSDBG_VFS 0x0001
622 #define NFSDBG_DIRCACHE 0x0002
623 #define NFSDBG_LOOKUPCACHE 0x0004
624 #define NFSDBG_PAGECACHE 0x0008
625 #define NFSDBG_PROC 0x0010
626 #define NFSDBG_XDR 0x0020
627 #define NFSDBG_FILE 0x0040
628 #define NFSDBG_ROOT 0x0080
629 #define NFSDBG_CALLBACK 0x0100
630 #define NFSDBG_CLIENT 0x0200
631 #define NFSDBG_MOUNT 0x0400
632 #define NFSDBG_FSCACHE 0x0800
633 #define NFSDBG_PNFS 0x1000
634 #define NFSDBG_PNFS_LD 0x2000
635 #define NFSDBG_STATE 0x4000
636 #define NFSDBG_ALL 0xFFFF
642 # define ifdebug(fac) if (unlikely(nfs_debug & NFSDBG_##fac))
643 # define NFS_IFDEBUG(x) x
645 # define ifdebug(fac) if (0)
646 # define NFS_IFDEBUG(x)
648 #endif /* __KERNEL */