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
;
55 struct rcu_head rcu_head
;
58 struct nfs_lockowner
{
63 #define NFS_IO_INPROGRESS 0
64 struct nfs_io_counter
{
69 struct nfs_lock_context
{
71 struct list_head list
;
72 struct nfs_open_context
*open_context
;
73 struct nfs_lockowner lockowner
;
74 struct nfs_io_counter io_count
;
78 struct nfs_open_context
{
79 struct nfs_lock_context lock_context
;
80 struct dentry
*dentry
;
81 struct rpc_cred
*cred
;
82 struct nfs4_state
*state
;
86 #define NFS_CONTEXT_ERROR_WRITE (0)
87 #define NFS_CONTEXT_RESEND_WRITES (1)
88 #define NFS_CONTEXT_BAD (2)
91 struct list_head list
;
92 struct nfs4_threshold
*mdsthreshold
;
95 struct nfs_open_dir_context
{
96 struct list_head list
;
97 struct rpc_cred
*cred
;
98 unsigned long attr_gencount
;
107 struct nfs_delegation
;
112 * nfs fs inode data in memory
116 * The 64bit 'inode number'
128 unsigned long flags
; /* atomic bit ops */
129 unsigned long cache_validity
; /* bit mask */
132 * read_cache_jiffies is when we started read-caching this inode.
133 * attrtimeo is for how long the cached information is assumed
134 * to be valid. A successful attribute revalidation doubles
135 * attrtimeo (up to acregmax/acdirmax), a failure resets it to
138 * We need to revalidate the cached attrs for this inode if
140 * jiffies - read_cache_jiffies >= attrtimeo
142 * Please note the comparison is greater than or equal
143 * so that zero timeout values can be specified.
145 unsigned long read_cache_jiffies
;
146 unsigned long attrtimeo
;
147 unsigned long attrtimeo_timestamp
;
149 unsigned long attr_gencount
;
150 /* "Generation counter" for the attribute cache. This is
151 * bumped whenever we update the metadata on the
154 unsigned long cache_change_attribute
;
156 struct rb_root access_cache
;
157 struct list_head access_cache_entry_lru
;
158 struct list_head access_cache_inode_lru
;
161 * This is the cookie verifier used for NFSv3 readdir
164 __be32 cookieverf
[2];
166 unsigned long nrequests
;
167 struct nfs_mds_commit_info commit_info
;
169 /* Open contexts for shared mmap writes */
170 struct list_head open_files
;
172 /* Number of in-flight sillydelete RPC calls */
173 atomic_t silly_count
;
174 /* List of deferred sillydelete requests */
175 struct hlist_head silly_list
;
176 wait_queue_head_t waitqueue
;
178 #if IS_ENABLED(CONFIG_NFS_V4)
179 struct nfs4_cached_acl
*nfs4_acl
;
181 struct list_head open_states
;
182 struct nfs_delegation __rcu
*delegation
;
183 fmode_t delegation_state
;
184 struct rw_semaphore rwsem
;
186 /* pNFS layout information */
187 struct pnfs_layout_hdr
*layout
;
188 #endif /* CONFIG_NFS_V4*/
189 /* how many bytes have been written/read and how many bytes queued up */
192 #ifdef CONFIG_NFS_FSCACHE
193 struct fscache_cookie
*fscache
;
195 struct inode vfs_inode
;
199 * Cache validity bit flags
201 #define NFS_INO_INVALID_ATTR 0x0001 /* cached attrs are invalid */
202 #define NFS_INO_INVALID_DATA 0x0002 /* cached data is invalid */
203 #define NFS_INO_INVALID_ATIME 0x0004 /* cached atime is invalid */
204 #define NFS_INO_INVALID_ACCESS 0x0008 /* cached access cred invalid */
205 #define NFS_INO_INVALID_ACL 0x0010 /* cached acls are invalid */
206 #define NFS_INO_REVAL_PAGECACHE 0x0020 /* must revalidate pagecache */
207 #define NFS_INO_REVAL_FORCED 0x0040 /* force revalidation ignoring a delegation */
208 #define NFS_INO_INVALID_LABEL 0x0080 /* cached label is invalid */
211 * Bit offsets in flags field
213 #define NFS_INO_ADVISE_RDPLUS (0) /* advise readdirplus */
214 #define NFS_INO_STALE (1) /* possible stale inode */
215 #define NFS_INO_ACL_LRU_SET (2) /* Inode is on the LRU list */
216 #define NFS_INO_INVALIDATING (3) /* inode is being invalidated */
217 #define NFS_INO_FLUSHING (4) /* inode is flushing out data */
218 #define NFS_INO_FSCACHE (5) /* inode can be cached by FS-Cache */
219 #define NFS_INO_FSCACHE_LOCK (6) /* FS-Cache cookie management lock */
220 #define NFS_INO_COMMIT (7) /* inode is committing unstable writes */
221 #define NFS_INO_LAYOUTCOMMIT (9) /* layoutcommit required */
222 #define NFS_INO_LAYOUTCOMMITTING (10) /* layoutcommit inflight */
224 static inline struct nfs_inode
*NFS_I(const struct inode
*inode
)
226 return container_of(inode
, struct nfs_inode
, vfs_inode
);
229 static inline struct nfs_server
*NFS_SB(const struct super_block
*s
)
231 return (struct nfs_server
*)(s
->s_fs_info
);
234 static inline struct nfs_fh
*NFS_FH(const struct inode
*inode
)
236 return &NFS_I(inode
)->fh
;
239 static inline struct nfs_server
*NFS_SERVER(const struct inode
*inode
)
241 return NFS_SB(inode
->i_sb
);
244 static inline struct rpc_clnt
*NFS_CLIENT(const struct inode
*inode
)
246 return NFS_SERVER(inode
)->client
;
249 static inline const struct nfs_rpc_ops
*NFS_PROTO(const struct inode
*inode
)
251 return NFS_SERVER(inode
)->nfs_client
->rpc_ops
;
254 static inline unsigned NFS_MINATTRTIMEO(const struct inode
*inode
)
256 struct nfs_server
*nfss
= NFS_SERVER(inode
);
257 return S_ISDIR(inode
->i_mode
) ? nfss
->acdirmin
: nfss
->acregmin
;
260 static inline unsigned NFS_MAXATTRTIMEO(const struct inode
*inode
)
262 struct nfs_server
*nfss
= NFS_SERVER(inode
);
263 return S_ISDIR(inode
->i_mode
) ? nfss
->acdirmax
: nfss
->acregmax
;
266 static inline int NFS_STALE(const struct inode
*inode
)
268 return test_bit(NFS_INO_STALE
, &NFS_I(inode
)->flags
);
271 static inline struct fscache_cookie
*nfs_i_fscache(struct inode
*inode
)
273 #ifdef CONFIG_NFS_FSCACHE
274 return NFS_I(inode
)->fscache
;
280 static inline __u64
NFS_FILEID(const struct inode
*inode
)
282 return NFS_I(inode
)->fileid
;
285 static inline void set_nfs_fileid(struct inode
*inode
, __u64 fileid
)
287 NFS_I(inode
)->fileid
= fileid
;
290 static inline void nfs_mark_for_revalidate(struct inode
*inode
)
292 struct nfs_inode
*nfsi
= NFS_I(inode
);
294 spin_lock(&inode
->i_lock
);
295 nfsi
->cache_validity
|= NFS_INO_INVALID_ATTR
|NFS_INO_INVALID_ACCESS
;
296 if (S_ISDIR(inode
->i_mode
))
297 nfsi
->cache_validity
|= NFS_INO_REVAL_PAGECACHE
|NFS_INO_INVALID_DATA
;
298 spin_unlock(&inode
->i_lock
);
301 static inline int nfs_server_capable(struct inode
*inode
, int cap
)
303 return NFS_SERVER(inode
)->caps
& cap
;
306 static inline void nfs_set_verifier(struct dentry
* dentry
, unsigned long verf
)
308 dentry
->d_time
= verf
;
312 * nfs_save_change_attribute - Returns the inode attribute change cookie
313 * @dir - pointer to parent directory inode
314 * The "change attribute" is updated every time we finish an operation
315 * that will result in a metadata change on the server.
317 static inline unsigned long nfs_save_change_attribute(struct inode
*dir
)
319 return NFS_I(dir
)->cache_change_attribute
;
323 * nfs_verify_change_attribute - Detects NFS remote directory changes
324 * @dir - pointer to parent directory inode
325 * @chattr - previously saved change attribute
326 * Return "false" if the verifiers doesn't match the change attribute.
327 * This would usually indicate that the directory contents have changed on
328 * the server, and that any dentries need revalidating.
330 static inline int nfs_verify_change_attribute(struct inode
*dir
, unsigned long chattr
)
332 return chattr
== NFS_I(dir
)->cache_change_attribute
;
336 * linux/fs/nfs/inode.c
338 extern int nfs_sync_mapping(struct address_space
*mapping
);
339 extern void nfs_zap_mapping(struct inode
*inode
, struct address_space
*mapping
);
340 extern void nfs_zap_caches(struct inode
*);
341 extern void nfs_invalidate_atime(struct inode
*);
342 extern struct inode
*nfs_fhget(struct super_block
*, struct nfs_fh
*,
343 struct nfs_fattr
*, struct nfs4_label
*);
344 extern int nfs_refresh_inode(struct inode
*, struct nfs_fattr
*);
345 extern int nfs_post_op_update_inode(struct inode
*inode
, struct nfs_fattr
*fattr
);
346 extern int nfs_post_op_update_inode_force_wcc(struct inode
*inode
, struct nfs_fattr
*fattr
);
347 extern int nfs_getattr(struct vfsmount
*, struct dentry
*, struct kstat
*);
348 extern void nfs_access_add_cache(struct inode
*, struct nfs_access_entry
*);
349 extern void nfs_access_set_mask(struct nfs_access_entry
*, u32
);
350 extern int nfs_permission(struct inode
*, int);
351 extern int nfs_open(struct inode
*, struct file
*);
352 extern int nfs_release(struct inode
*, struct file
*);
353 extern int nfs_attribute_timeout(struct inode
*inode
);
354 extern int nfs_attribute_cache_expired(struct inode
*inode
);
355 extern int nfs_revalidate_inode(struct nfs_server
*server
, struct inode
*inode
);
356 extern int nfs_revalidate_inode_rcu(struct nfs_server
*server
, struct inode
*inode
);
357 extern int __nfs_revalidate_inode(struct nfs_server
*, struct inode
*);
358 extern int nfs_revalidate_mapping(struct inode
*inode
, struct address_space
*mapping
);
359 extern int nfs_setattr(struct dentry
*, struct iattr
*);
360 extern void nfs_setattr_update_inode(struct inode
*inode
, struct iattr
*attr
);
361 extern void nfs_setsecurity(struct inode
*inode
, struct nfs_fattr
*fattr
,
362 struct nfs4_label
*label
);
363 extern struct nfs_open_context
*get_nfs_open_context(struct nfs_open_context
*ctx
);
364 extern void put_nfs_open_context(struct nfs_open_context
*ctx
);
365 extern struct nfs_open_context
*nfs_find_open_context(struct inode
*inode
, struct rpc_cred
*cred
, fmode_t mode
);
366 extern struct nfs_open_context
*alloc_nfs_open_context(struct dentry
*dentry
, fmode_t f_mode
);
367 extern void nfs_inode_attach_open_context(struct nfs_open_context
*ctx
);
368 extern void nfs_file_set_open_context(struct file
*filp
, struct nfs_open_context
*ctx
);
369 extern struct nfs_lock_context
*nfs_get_lock_context(struct nfs_open_context
*ctx
);
370 extern void nfs_put_lock_context(struct nfs_lock_context
*l_ctx
);
371 extern u64
nfs_compat_user_ino64(u64 fileid
);
372 extern void nfs_fattr_init(struct nfs_fattr
*fattr
);
373 extern unsigned long nfs_inc_attr_generation_counter(void);
375 extern struct nfs_fattr
*nfs_alloc_fattr(void);
377 static inline void nfs_free_fattr(const struct nfs_fattr
*fattr
)
382 extern struct nfs_fh
*nfs_alloc_fhandle(void);
384 static inline void nfs_free_fhandle(const struct nfs_fh
*fh
)
390 extern u32
_nfs_display_fhandle_hash(const struct nfs_fh
*fh
);
391 static inline u32
nfs_display_fhandle_hash(const struct nfs_fh
*fh
)
393 return _nfs_display_fhandle_hash(fh
);
395 extern void _nfs_display_fhandle(const struct nfs_fh
*fh
, const char *caption
);
396 #define nfs_display_fhandle(fh, caption) \
398 if (unlikely(nfs_debug & NFSDBG_FACILITY)) \
399 _nfs_display_fhandle(fh, caption); \
402 static inline u32
nfs_display_fhandle_hash(const struct nfs_fh
*fh
)
406 static inline void nfs_display_fhandle(const struct nfs_fh
*fh
,
413 * linux/fs/nfs/nfsroot.c
415 extern int nfs_root_data(char **root_device
, char **root_data
); /*__init*/
416 /* linux/net/ipv4/ipconfig.c: trims ip addr off front of name, too. */
417 extern __be32
root_nfs_parse_addr(char *name
); /*__init*/
420 * linux/fs/nfs/file.c
422 extern const struct file_operations nfs_file_operations
;
423 #if IS_ENABLED(CONFIG_NFS_V4)
424 extern const struct file_operations nfs4_file_operations
;
425 #endif /* CONFIG_NFS_V4 */
426 extern const struct address_space_operations nfs_file_aops
;
427 extern const struct address_space_operations nfs_dir_aops
;
429 static inline struct nfs_open_context
*nfs_file_open_context(struct file
*filp
)
431 return filp
->private_data
;
434 static inline struct rpc_cred
*nfs_file_cred(struct file
*file
)
437 struct nfs_open_context
*ctx
=
438 nfs_file_open_context(file
);
446 * linux/fs/nfs/direct.c
448 extern ssize_t
nfs_direct_IO(int, struct kiocb
*, struct iov_iter
*, loff_t
);
449 extern ssize_t
nfs_file_direct_read(struct kiocb
*iocb
,
450 struct iov_iter
*iter
,
452 extern ssize_t
nfs_file_direct_write(struct kiocb
*iocb
,
453 struct iov_iter
*iter
,
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
,
464 struct nfs_fattr
*fattr
, struct nfs4_label
*label
);
465 extern int nfs_may_open(struct inode
*inode
, struct rpc_cred
*cred
, int openflags
);
466 extern void nfs_access_zap_cache(struct inode
*inode
);
469 * linux/fs/nfs/symlink.c
471 extern const struct inode_operations nfs_symlink_inode_operations
;
474 * linux/fs/nfs/sysctl.c
477 extern int nfs_register_sysctl(void);
478 extern void nfs_unregister_sysctl(void);
480 #define nfs_register_sysctl() 0
481 #define nfs_unregister_sysctl() do { } while(0)
485 * linux/fs/nfs/namespace.c
487 extern const struct inode_operations nfs_mountpoint_inode_operations
;
488 extern const struct inode_operations nfs_referral_inode_operations
;
489 extern int nfs_mountpoint_expiry_timeout
;
490 extern void nfs_release_automount_timer(void);
493 * linux/fs/nfs/unlink.c
495 extern void nfs_complete_unlink(struct dentry
*dentry
, struct inode
*);
496 extern void nfs_wait_on_sillyrename(struct dentry
*dentry
);
497 extern void nfs_block_sillyrename(struct dentry
*dentry
);
498 extern void nfs_unblock_sillyrename(struct dentry
*dentry
);
501 * linux/fs/nfs/write.c
503 extern int nfs_congestion_kb
;
504 extern int nfs_writepage(struct page
*page
, struct writeback_control
*wbc
);
505 extern int nfs_writepages(struct address_space
*, struct writeback_control
*);
506 extern int nfs_flush_incompatible(struct file
*file
, struct page
*page
);
507 extern int nfs_updatepage(struct file
*, struct page
*, unsigned int, unsigned int);
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 extern int nfs_commit_inode(struct inode
*, int);
517 extern struct nfs_commit_data
*nfs_commitdata_alloc(void);
518 extern void nfs_commit_free(struct nfs_commit_data
*data
);
521 nfs_have_writebacks(struct inode
*inode
)
523 return NFS_I(inode
)->nrequests
!= 0;
527 * linux/fs/nfs/read.c
529 extern int nfs_readpage(struct file
*, struct page
*);
530 extern int nfs_readpages(struct file
*, struct address_space
*,
531 struct list_head
*, unsigned);
532 extern int nfs_readpage_async(struct nfs_open_context
*, struct inode
*,
539 static inline loff_t
nfs_size_to_loff_t(__u64 size
)
541 if (size
> (__u64
) OFFSET_MAX
- 1)
542 return OFFSET_MAX
- 1;
543 return (loff_t
) size
;
547 nfs_fileid_to_ino_t(u64 fileid
)
549 ino_t ino
= (ino_t
) fileid
;
550 if (sizeof(ino_t
) < sizeof(u64
))
551 ino
^= fileid
>> (sizeof(u64
)-sizeof(ino_t
)) * 8;
555 #define NFS_JUKEBOX_RETRY_TIME (5 * HZ)
560 # define ifdebug(fac) if (unlikely(nfs_debug & NFSDBG_##fac))
561 # define NFS_IFDEBUG(x) x
563 # define ifdebug(fac) if (0)
564 # define NFS_IFDEBUG(x)