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 struct nfs_lock_context
{
64 struct list_head list
;
65 struct nfs_open_context
*open_context
;
66 struct nfs_lockowner lockowner
;
70 struct nfs_open_context
{
71 struct nfs_lock_context lock_context
;
72 struct dentry
*dentry
;
73 struct rpc_cred
*cred
;
74 struct nfs4_state
*state
;
78 #define NFS_CONTEXT_ERROR_WRITE (0)
79 #define NFS_CONTEXT_RESEND_WRITES (1)
82 struct list_head list
;
83 struct nfs4_threshold
*mdsthreshold
;
86 struct nfs_open_dir_context
{
87 struct rpc_cred
*cred
;
88 unsigned long attr_gencount
;
97 struct nfs_delegation
;
102 * nfs fs inode data in memory
106 * The 64bit 'inode number'
118 unsigned long flags
; /* atomic bit ops */
119 unsigned long cache_validity
; /* bit mask */
122 * read_cache_jiffies is when we started read-caching this inode.
123 * attrtimeo is for how long the cached information is assumed
124 * to be valid. A successful attribute revalidation doubles
125 * attrtimeo (up to acregmax/acdirmax), a failure resets it to
128 * We need to revalidate the cached attrs for this inode if
130 * jiffies - read_cache_jiffies >= attrtimeo
132 * Please note the comparison is greater than or equal
133 * so that zero timeout values can be specified.
135 unsigned long read_cache_jiffies
;
136 unsigned long attrtimeo
;
137 unsigned long attrtimeo_timestamp
;
139 unsigned long attr_gencount
;
140 /* "Generation counter" for the attribute cache. This is
141 * bumped whenever we update the metadata on the
144 unsigned long cache_change_attribute
;
146 struct rb_root access_cache
;
147 struct list_head access_cache_entry_lru
;
148 struct list_head access_cache_inode_lru
;
149 #ifdef CONFIG_NFS_V3_ACL
150 struct posix_acl
*acl_access
;
151 struct posix_acl
*acl_default
;
155 * This is the cookie verifier used for NFSv3 readdir
158 __be32 cookieverf
[2];
160 unsigned long npages
;
161 struct nfs_mds_commit_info commit_info
;
163 /* Open contexts for shared mmap writes */
164 struct list_head open_files
;
166 /* Number of in-flight sillydelete RPC calls */
167 atomic_t silly_count
;
168 /* List of deferred sillydelete requests */
169 struct hlist_head silly_list
;
170 wait_queue_head_t waitqueue
;
172 #if IS_ENABLED(CONFIG_NFS_V4)
173 struct nfs4_cached_acl
*nfs4_acl
;
175 struct list_head open_states
;
176 struct nfs_delegation __rcu
*delegation
;
177 fmode_t delegation_state
;
178 struct rw_semaphore rwsem
;
180 /* pNFS layout information */
181 struct pnfs_layout_hdr
*layout
;
182 #endif /* CONFIG_NFS_V4*/
183 /* how many bytes have been written/read and how many bytes queued up */
186 #ifdef CONFIG_NFS_FSCACHE
187 struct fscache_cookie
*fscache
;
189 struct inode vfs_inode
;
193 * Cache validity bit flags
195 #define NFS_INO_INVALID_ATTR 0x0001 /* cached attrs are invalid */
196 #define NFS_INO_INVALID_DATA 0x0002 /* cached data is invalid */
197 #define NFS_INO_INVALID_ATIME 0x0004 /* cached atime is invalid */
198 #define NFS_INO_INVALID_ACCESS 0x0008 /* cached access cred invalid */
199 #define NFS_INO_INVALID_ACL 0x0010 /* cached acls are invalid */
200 #define NFS_INO_REVAL_PAGECACHE 0x0020 /* must revalidate pagecache */
201 #define NFS_INO_REVAL_FORCED 0x0040 /* force revalidation ignoring a delegation */
204 * Bit offsets in flags field
206 #define NFS_INO_ADVISE_RDPLUS (0) /* advise readdirplus */
207 #define NFS_INO_STALE (1) /* possible stale inode */
208 #define NFS_INO_ACL_LRU_SET (2) /* Inode is on the LRU list */
209 #define NFS_INO_FLUSHING (4) /* inode is flushing out data */
210 #define NFS_INO_FSCACHE (5) /* inode can be cached by FS-Cache */
211 #define NFS_INO_FSCACHE_LOCK (6) /* FS-Cache cookie management lock */
212 #define NFS_INO_COMMIT (7) /* inode is committing unstable writes */
213 #define NFS_INO_LAYOUTCOMMIT (9) /* layoutcommit required */
214 #define NFS_INO_LAYOUTCOMMITTING (10) /* layoutcommit inflight */
216 static inline struct nfs_inode
*NFS_I(const struct inode
*inode
)
218 return container_of(inode
, struct nfs_inode
, vfs_inode
);
221 static inline struct nfs_server
*NFS_SB(const struct super_block
*s
)
223 return (struct nfs_server
*)(s
->s_fs_info
);
226 static inline struct nfs_fh
*NFS_FH(const struct inode
*inode
)
228 return &NFS_I(inode
)->fh
;
231 static inline struct nfs_server
*NFS_SERVER(const struct inode
*inode
)
233 return NFS_SB(inode
->i_sb
);
236 static inline struct rpc_clnt
*NFS_CLIENT(const struct inode
*inode
)
238 return NFS_SERVER(inode
)->client
;
241 static inline const struct nfs_rpc_ops
*NFS_PROTO(const struct inode
*inode
)
243 return NFS_SERVER(inode
)->nfs_client
->rpc_ops
;
246 static inline unsigned NFS_MINATTRTIMEO(const struct inode
*inode
)
248 struct nfs_server
*nfss
= NFS_SERVER(inode
);
249 return S_ISDIR(inode
->i_mode
) ? nfss
->acdirmin
: nfss
->acregmin
;
252 static inline unsigned NFS_MAXATTRTIMEO(const struct inode
*inode
)
254 struct nfs_server
*nfss
= NFS_SERVER(inode
);
255 return S_ISDIR(inode
->i_mode
) ? nfss
->acdirmax
: nfss
->acregmax
;
258 static inline int NFS_STALE(const struct inode
*inode
)
260 return test_bit(NFS_INO_STALE
, &NFS_I(inode
)->flags
);
263 static inline int NFS_FSCACHE(const struct inode
*inode
)
265 return test_bit(NFS_INO_FSCACHE
, &NFS_I(inode
)->flags
);
268 static inline __u64
NFS_FILEID(const struct inode
*inode
)
270 return NFS_I(inode
)->fileid
;
273 static inline void set_nfs_fileid(struct inode
*inode
, __u64 fileid
)
275 NFS_I(inode
)->fileid
= fileid
;
278 static inline void nfs_mark_for_revalidate(struct inode
*inode
)
280 struct nfs_inode
*nfsi
= NFS_I(inode
);
282 spin_lock(&inode
->i_lock
);
283 nfsi
->cache_validity
|= NFS_INO_INVALID_ATTR
|NFS_INO_INVALID_ACCESS
;
284 if (S_ISDIR(inode
->i_mode
))
285 nfsi
->cache_validity
|= NFS_INO_REVAL_PAGECACHE
|NFS_INO_INVALID_DATA
;
286 spin_unlock(&inode
->i_lock
);
289 static inline int nfs_server_capable(struct inode
*inode
, int cap
)
291 return NFS_SERVER(inode
)->caps
& cap
;
294 static inline void nfs_set_verifier(struct dentry
* dentry
, unsigned long verf
)
296 dentry
->d_time
= verf
;
300 * nfs_save_change_attribute - Returns the inode attribute change cookie
301 * @dir - pointer to parent directory inode
302 * The "change attribute" is updated every time we finish an operation
303 * that will result in a metadata change on the server.
305 static inline unsigned long nfs_save_change_attribute(struct inode
*dir
)
307 return NFS_I(dir
)->cache_change_attribute
;
311 * nfs_verify_change_attribute - Detects NFS remote directory changes
312 * @dir - pointer to parent directory inode
313 * @chattr - previously saved change attribute
314 * Return "false" if the verifiers doesn't match the change attribute.
315 * This would usually indicate that the directory contents have changed on
316 * the server, and that any dentries need revalidating.
318 static inline int nfs_verify_change_attribute(struct inode
*dir
, unsigned long chattr
)
320 return chattr
== NFS_I(dir
)->cache_change_attribute
;
324 * linux/fs/nfs/inode.c
326 extern int nfs_sync_mapping(struct address_space
*mapping
);
327 extern void nfs_zap_mapping(struct inode
*inode
, struct address_space
*mapping
);
328 extern void nfs_zap_caches(struct inode
*);
329 extern void nfs_invalidate_atime(struct inode
*);
330 extern struct inode
*nfs_fhget(struct super_block
*, struct nfs_fh
*,
332 extern int nfs_refresh_inode(struct inode
*, struct nfs_fattr
*);
333 extern int nfs_post_op_update_inode(struct inode
*inode
, struct nfs_fattr
*fattr
);
334 extern int nfs_post_op_update_inode_force_wcc(struct inode
*inode
, struct nfs_fattr
*fattr
);
335 extern int nfs_getattr(struct vfsmount
*, struct dentry
*, struct kstat
*);
336 extern void nfs_access_add_cache(struct inode
*, struct nfs_access_entry
*);
337 extern void nfs_access_set_mask(struct nfs_access_entry
*, u32
);
338 extern int nfs_permission(struct inode
*, int);
339 extern int nfs_open(struct inode
*, struct file
*);
340 extern int nfs_release(struct inode
*, struct file
*);
341 extern int nfs_attribute_timeout(struct inode
*inode
);
342 extern int nfs_revalidate_inode(struct nfs_server
*server
, struct inode
*inode
);
343 extern int __nfs_revalidate_inode(struct nfs_server
*, struct inode
*);
344 extern int nfs_revalidate_mapping(struct inode
*inode
, struct address_space
*mapping
);
345 extern int nfs_setattr(struct dentry
*, struct iattr
*);
346 extern void nfs_setattr_update_inode(struct inode
*inode
, struct iattr
*attr
);
347 extern struct nfs_open_context
*get_nfs_open_context(struct nfs_open_context
*ctx
);
348 extern void put_nfs_open_context(struct nfs_open_context
*ctx
);
349 extern struct nfs_open_context
*nfs_find_open_context(struct inode
*inode
, struct rpc_cred
*cred
, fmode_t mode
);
350 extern struct nfs_open_context
*alloc_nfs_open_context(struct dentry
*dentry
, fmode_t f_mode
);
351 extern void nfs_file_set_open_context(struct file
*filp
, struct nfs_open_context
*ctx
);
352 extern struct nfs_lock_context
*nfs_get_lock_context(struct nfs_open_context
*ctx
);
353 extern void nfs_put_lock_context(struct nfs_lock_context
*l_ctx
);
354 extern u64
nfs_compat_user_ino64(u64 fileid
);
355 extern void nfs_fattr_init(struct nfs_fattr
*fattr
);
356 extern unsigned long nfs_inc_attr_generation_counter(void);
358 extern struct nfs_fattr
*nfs_alloc_fattr(void);
360 static inline void nfs_free_fattr(const struct nfs_fattr
*fattr
)
365 extern struct nfs_fh
*nfs_alloc_fhandle(void);
367 static inline void nfs_free_fhandle(const struct nfs_fh
*fh
)
373 extern u32
_nfs_display_fhandle_hash(const struct nfs_fh
*fh
);
374 static inline u32
nfs_display_fhandle_hash(const struct nfs_fh
*fh
)
376 return _nfs_display_fhandle_hash(fh
);
378 extern void _nfs_display_fhandle(const struct nfs_fh
*fh
, const char *caption
);
379 #define nfs_display_fhandle(fh, caption) \
381 if (unlikely(nfs_debug & NFSDBG_FACILITY)) \
382 _nfs_display_fhandle(fh, caption); \
385 static inline u32
nfs_display_fhandle_hash(const struct nfs_fh
*fh
)
389 static inline void nfs_display_fhandle(const struct nfs_fh
*fh
,
396 * linux/fs/nfs/nfsroot.c
398 extern int nfs_root_data(char **root_device
, char **root_data
); /*__init*/
399 /* linux/net/ipv4/ipconfig.c: trims ip addr off front of name, too. */
400 extern __be32
root_nfs_parse_addr(char *name
); /*__init*/
403 * linux/fs/nfs/file.c
405 extern const struct file_operations nfs_file_operations
;
406 #if IS_ENABLED(CONFIG_NFS_V4)
407 extern const struct file_operations nfs4_file_operations
;
408 #endif /* CONFIG_NFS_V4 */
409 extern const struct address_space_operations nfs_file_aops
;
410 extern const struct address_space_operations nfs_dir_aops
;
412 static inline struct nfs_open_context
*nfs_file_open_context(struct file
*filp
)
414 return filp
->private_data
;
417 static inline struct rpc_cred
*nfs_file_cred(struct file
*file
)
420 struct nfs_open_context
*ctx
=
421 nfs_file_open_context(file
);
429 * linux/fs/nfs/xattr.c
431 #ifdef CONFIG_NFS_V3_ACL
432 extern ssize_t
nfs3_listxattr(struct dentry
*, char *, size_t);
433 extern ssize_t
nfs3_getxattr(struct dentry
*, const char *, void *, size_t);
434 extern int nfs3_setxattr(struct dentry
*, const char *,
435 const void *, size_t, int);
436 extern int nfs3_removexattr (struct dentry
*, const char *name
);
438 # define nfs3_listxattr NULL
439 # define nfs3_getxattr NULL
440 # define nfs3_setxattr NULL
441 # define nfs3_removexattr NULL
445 * linux/fs/nfs/direct.c
447 extern ssize_t
nfs_direct_IO(int, struct kiocb
*, const struct iovec
*, loff_t
,
449 extern ssize_t
nfs_file_direct_read(struct kiocb
*iocb
,
450 const struct iovec
*iov
, unsigned long nr_segs
,
451 loff_t pos
, bool uio
);
452 extern ssize_t
nfs_file_direct_write(struct kiocb
*iocb
,
453 const struct iovec
*iov
, unsigned long nr_segs
,
454 loff_t pos
, bool uio
);
459 extern const struct file_operations nfs_dir_operations
;
460 extern const struct dentry_operations nfs_dentry_operations
;
462 extern void nfs_force_lookup_revalidate(struct inode
*dir
);
463 extern int nfs_instantiate(struct dentry
*dentry
, struct nfs_fh
*fh
, struct nfs_fattr
*fattr
);
464 extern int nfs_may_open(struct inode
*inode
, struct rpc_cred
*cred
, int openflags
);
465 extern void nfs_access_zap_cache(struct inode
*inode
);
468 * linux/fs/nfs/symlink.c
470 extern const struct inode_operations nfs_symlink_inode_operations
;
473 * linux/fs/nfs/sysctl.c
476 extern int nfs_register_sysctl(void);
477 extern void nfs_unregister_sysctl(void);
479 #define nfs_register_sysctl() 0
480 #define nfs_unregister_sysctl() do { } while(0)
484 * linux/fs/nfs/namespace.c
486 extern const struct inode_operations nfs_mountpoint_inode_operations
;
487 extern const struct inode_operations nfs_referral_inode_operations
;
488 extern int nfs_mountpoint_expiry_timeout
;
489 extern void nfs_release_automount_timer(void);
492 * linux/fs/nfs/unlink.c
494 extern void nfs_complete_unlink(struct dentry
*dentry
, struct inode
*);
495 extern void nfs_block_sillyrename(struct dentry
*dentry
);
496 extern void nfs_unblock_sillyrename(struct dentry
*dentry
);
497 extern int nfs_sillyrename(struct inode
*dir
, struct dentry
*dentry
);
500 * linux/fs/nfs/write.c
502 extern int nfs_congestion_kb
;
503 extern int nfs_writepage(struct page
*page
, struct writeback_control
*wbc
);
504 extern int nfs_writepages(struct address_space
*, struct writeback_control
*);
505 extern int nfs_flush_incompatible(struct file
*file
, struct page
*page
);
506 extern int nfs_updatepage(struct file
*, struct page
*, unsigned int, unsigned int);
507 extern void nfs_writeback_done(struct rpc_task
*, struct nfs_write_data
*);
510 * Try to write back everything synchronously (but check the
513 extern int nfs_wb_all(struct inode
*inode
);
514 extern int nfs_wb_page(struct inode
*inode
, struct page
* page
);
515 extern int nfs_wb_page_cancel(struct inode
*inode
, struct page
* page
);
516 #if IS_ENABLED(CONFIG_NFS_V3) || IS_ENABLED(CONFIG_NFS_V4)
517 extern int nfs_commit_inode(struct inode
*, int);
518 extern struct nfs_commit_data
*nfs_commitdata_alloc(void);
519 extern void nfs_commit_free(struct nfs_commit_data
*data
);
522 nfs_commit_inode(struct inode
*inode
, int how
)
529 nfs_have_writebacks(struct inode
*inode
)
531 return NFS_I(inode
)->npages
!= 0;
535 * linux/fs/nfs/read.c
537 extern int nfs_readpage(struct file
*, struct page
*);
538 extern int nfs_readpages(struct file
*, struct address_space
*,
539 struct list_head
*, unsigned);
540 extern int nfs_readpage_result(struct rpc_task
*, struct nfs_read_data
*);
541 extern int nfs_readpage_async(struct nfs_open_context
*, struct inode
*,
545 * linux/fs/nfs3proc.c
547 #ifdef CONFIG_NFS_V3_ACL
548 extern struct posix_acl
*nfs3_proc_getacl(struct inode
*inode
, int type
);
549 extern int nfs3_proc_setacl(struct inode
*inode
, int type
,
550 struct posix_acl
*acl
);
551 extern int nfs3_proc_set_default_acl(struct inode
*dir
, struct inode
*inode
,
553 extern void nfs3_forget_cached_acls(struct inode
*inode
);
555 static inline int nfs3_proc_set_default_acl(struct inode
*dir
,
562 static inline void nfs3_forget_cached_acls(struct inode
*inode
)
565 #endif /* CONFIG_NFS_V3_ACL */
571 static inline loff_t
nfs_size_to_loff_t(__u64 size
)
573 if (size
> (__u64
) OFFSET_MAX
- 1)
574 return OFFSET_MAX
- 1;
575 return (loff_t
) size
;
579 nfs_fileid_to_ino_t(u64 fileid
)
581 ino_t ino
= (ino_t
) fileid
;
582 if (sizeof(ino_t
) < sizeof(u64
))
583 ino
^= fileid
>> (sizeof(u64
)-sizeof(ino_t
)) * 8;
587 #define NFS_JUKEBOX_RETRY_TIME (5 * HZ)
592 # define ifdebug(fac) if (unlikely(nfs_debug & NFSDBG_##fac))
593 # define NFS_IFDEBUG(x) x
595 # define ifdebug(fac) if (0)
596 # define NFS_IFDEBUG(x)