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 */
43 #include <linux/pagemap.h>
44 #include <linux/rbtree.h>
45 #include <linux/rwsem.h>
46 #include <linux/wait.h>
48 #include <linux/sunrpc/debug.h>
49 #include <linux/sunrpc/auth.h>
50 #include <linux/sunrpc/clnt.h>
52 #include <linux/nfs.h>
53 #include <linux/nfs2.h>
54 #include <linux/nfs3.h>
55 #include <linux/nfs4.h>
56 #include <linux/nfs_xdr.h>
57 #include <linux/nfs_fs_sb.h>
59 #include <linux/mempool.h>
62 * These are the default flags for swap requests
64 #define NFS_RPC_SWAPFLAGS (RPC_TASK_SWAPPER|RPC_TASK_ROOTCREDS)
67 * NFSv3/v4 Access mode cache entry
69 struct nfs_access_entry
{
70 struct rb_node rb_node
;
72 unsigned long jiffies
;
73 struct rpc_cred
* cred
;
77 struct nfs_lock_context
{
79 struct list_head list
;
80 struct nfs_open_context
*open_context
;
86 struct nfs_open_context
{
87 struct nfs_lock_context lock_context
;
89 struct rpc_cred
*cred
;
90 struct nfs4_state
*state
;
94 #define NFS_CONTEXT_ERROR_WRITE (0)
97 struct list_head list
;
100 struct nfs_open_dir_context
{
101 struct rpc_cred
*cred
;
110 struct nfs_delegation
;
115 * nfs fs inode data in memory
119 * The 64bit 'inode number'
131 unsigned long flags
; /* atomic bit ops */
132 unsigned long cache_validity
; /* bit mask */
135 * read_cache_jiffies is when we started read-caching this inode.
136 * attrtimeo is for how long the cached information is assumed
137 * to be valid. A successful attribute revalidation doubles
138 * attrtimeo (up to acregmax/acdirmax), a failure resets it to
141 * We need to revalidate the cached attrs for this inode if
143 * jiffies - read_cache_jiffies >= attrtimeo
145 * Please note the comparison is greater than or equal
146 * so that zero timeout values can be specified.
148 unsigned long read_cache_jiffies
;
149 unsigned long attrtimeo
;
150 unsigned long attrtimeo_timestamp
;
151 __u64 change_attr
; /* v4 only */
153 unsigned long attr_gencount
;
154 /* "Generation counter" for the attribute cache. This is
155 * bumped whenever we update the metadata on the
158 unsigned long cache_change_attribute
;
160 struct rb_root access_cache
;
161 struct list_head access_cache_entry_lru
;
162 struct list_head access_cache_inode_lru
;
163 #ifdef CONFIG_NFS_V3_ACL
164 struct posix_acl
*acl_access
;
165 struct posix_acl
*acl_default
;
169 * This is the cookie verifier used for NFSv3 readdir
172 __be32 cookieverf
[2];
175 * This is the list of dirty unwritten pages.
177 struct radix_tree_root nfs_page_tree
;
179 unsigned long npages
;
180 unsigned long ncommit
;
182 /* Open contexts for shared mmap writes */
183 struct list_head open_files
;
185 /* Number of in-flight sillydelete RPC calls */
186 atomic_t silly_count
;
187 /* List of deferred sillydelete requests */
188 struct hlist_head silly_list
;
189 wait_queue_head_t waitqueue
;
192 struct nfs4_cached_acl
*nfs4_acl
;
194 struct list_head open_states
;
195 struct nfs_delegation __rcu
*delegation
;
196 fmode_t delegation_state
;
197 struct rw_semaphore rwsem
;
199 /* pNFS layout information */
200 struct pnfs_layout_hdr
*layout
;
201 #endif /* CONFIG_NFS_V4*/
202 #ifdef CONFIG_NFS_FSCACHE
203 struct fscache_cookie
*fscache
;
205 struct inode vfs_inode
;
209 * Cache validity bit flags
211 #define NFS_INO_INVALID_ATTR 0x0001 /* cached attrs are invalid */
212 #define NFS_INO_INVALID_DATA 0x0002 /* cached data is invalid */
213 #define NFS_INO_INVALID_ATIME 0x0004 /* cached atime is invalid */
214 #define NFS_INO_INVALID_ACCESS 0x0008 /* cached access cred invalid */
215 #define NFS_INO_INVALID_ACL 0x0010 /* cached acls are invalid */
216 #define NFS_INO_REVAL_PAGECACHE 0x0020 /* must revalidate pagecache */
217 #define NFS_INO_REVAL_FORCED 0x0040 /* force revalidation ignoring a delegation */
220 * Bit offsets in flags field
222 #define NFS_INO_ADVISE_RDPLUS (0) /* advise readdirplus */
223 #define NFS_INO_STALE (1) /* possible stale inode */
224 #define NFS_INO_ACL_LRU_SET (2) /* Inode is on the LRU list */
225 #define NFS_INO_FLUSHING (4) /* inode is flushing out data */
226 #define NFS_INO_FSCACHE (5) /* inode can be cached by FS-Cache */
227 #define NFS_INO_FSCACHE_LOCK (6) /* FS-Cache cookie management lock */
228 #define NFS_INO_COMMIT (7) /* inode is committing unstable writes */
229 #define NFS_INO_PNFS_COMMIT (8) /* use pnfs code for commit */
231 static inline struct nfs_inode
*NFS_I(const struct inode
*inode
)
233 return container_of(inode
, struct nfs_inode
, vfs_inode
);
236 static inline struct nfs_server
*NFS_SB(const struct super_block
*s
)
238 return (struct nfs_server
*)(s
->s_fs_info
);
241 static inline struct nfs_fh
*NFS_FH(const struct inode
*inode
)
243 return &NFS_I(inode
)->fh
;
246 static inline struct nfs_server
*NFS_SERVER(const struct inode
*inode
)
248 return NFS_SB(inode
->i_sb
);
251 static inline struct rpc_clnt
*NFS_CLIENT(const struct inode
*inode
)
253 return NFS_SERVER(inode
)->client
;
256 static inline const struct nfs_rpc_ops
*NFS_PROTO(const struct inode
*inode
)
258 return NFS_SERVER(inode
)->nfs_client
->rpc_ops
;
261 static inline __be32
*NFS_COOKIEVERF(const struct inode
*inode
)
263 return NFS_I(inode
)->cookieverf
;
266 static inline unsigned NFS_MINATTRTIMEO(const struct inode
*inode
)
268 struct nfs_server
*nfss
= NFS_SERVER(inode
);
269 return S_ISDIR(inode
->i_mode
) ? nfss
->acdirmin
: nfss
->acregmin
;
272 static inline unsigned NFS_MAXATTRTIMEO(const struct inode
*inode
)
274 struct nfs_server
*nfss
= NFS_SERVER(inode
);
275 return S_ISDIR(inode
->i_mode
) ? nfss
->acdirmax
: nfss
->acregmax
;
278 static inline int NFS_STALE(const struct inode
*inode
)
280 return test_bit(NFS_INO_STALE
, &NFS_I(inode
)->flags
);
283 static inline int NFS_FSCACHE(const struct inode
*inode
)
285 return test_bit(NFS_INO_FSCACHE
, &NFS_I(inode
)->flags
);
288 static inline __u64
NFS_FILEID(const struct inode
*inode
)
290 return NFS_I(inode
)->fileid
;
293 static inline void set_nfs_fileid(struct inode
*inode
, __u64 fileid
)
295 NFS_I(inode
)->fileid
= fileid
;
298 static inline void nfs_mark_for_revalidate(struct inode
*inode
)
300 struct nfs_inode
*nfsi
= NFS_I(inode
);
302 spin_lock(&inode
->i_lock
);
303 nfsi
->cache_validity
|= NFS_INO_INVALID_ATTR
|NFS_INO_INVALID_ACCESS
;
304 if (S_ISDIR(inode
->i_mode
))
305 nfsi
->cache_validity
|= NFS_INO_REVAL_PAGECACHE
|NFS_INO_INVALID_DATA
;
306 spin_unlock(&inode
->i_lock
);
309 static inline int nfs_server_capable(struct inode
*inode
, int cap
)
311 return NFS_SERVER(inode
)->caps
& cap
;
314 static inline int NFS_USE_READDIRPLUS(struct inode
*inode
)
316 return test_bit(NFS_INO_ADVISE_RDPLUS
, &NFS_I(inode
)->flags
);
319 static inline void nfs_set_verifier(struct dentry
* dentry
, unsigned long verf
)
321 dentry
->d_time
= verf
;
325 * nfs_save_change_attribute - Returns the inode attribute change cookie
326 * @dir - pointer to parent directory inode
327 * The "change attribute" is updated every time we finish an operation
328 * that will result in a metadata change on the server.
330 static inline unsigned long nfs_save_change_attribute(struct inode
*dir
)
332 return NFS_I(dir
)->cache_change_attribute
;
336 * nfs_verify_change_attribute - Detects NFS remote directory changes
337 * @dir - pointer to parent directory inode
338 * @chattr - previously saved change attribute
339 * Return "false" if the verifiers doesn't match the change attribute.
340 * This would usually indicate that the directory contents have changed on
341 * the server, and that any dentries need revalidating.
343 static inline int nfs_verify_change_attribute(struct inode
*dir
, unsigned long chattr
)
345 return chattr
== NFS_I(dir
)->cache_change_attribute
;
349 * linux/fs/nfs/inode.c
351 extern int nfs_sync_mapping(struct address_space
*mapping
);
352 extern void nfs_zap_mapping(struct inode
*inode
, struct address_space
*mapping
);
353 extern void nfs_zap_caches(struct inode
*);
354 extern void nfs_invalidate_atime(struct inode
*);
355 extern struct inode
*nfs_fhget(struct super_block
*, struct nfs_fh
*,
357 extern int nfs_refresh_inode(struct inode
*, struct nfs_fattr
*);
358 extern int nfs_post_op_update_inode(struct inode
*inode
, struct nfs_fattr
*fattr
);
359 extern int nfs_post_op_update_inode_force_wcc(struct inode
*inode
, struct nfs_fattr
*fattr
);
360 extern int nfs_getattr(struct vfsmount
*, struct dentry
*, struct kstat
*);
361 extern int nfs_permission(struct inode
*, int, unsigned int);
362 extern int nfs_open(struct inode
*, struct file
*);
363 extern int nfs_release(struct inode
*, struct file
*);
364 extern int nfs_attribute_timeout(struct inode
*inode
);
365 extern int nfs_revalidate_inode(struct nfs_server
*server
, struct inode
*inode
);
366 extern int __nfs_revalidate_inode(struct nfs_server
*, struct inode
*);
367 extern int nfs_revalidate_mapping(struct inode
*inode
, struct address_space
*mapping
);
368 extern int nfs_setattr(struct dentry
*, struct iattr
*);
369 extern void nfs_setattr_update_inode(struct inode
*inode
, struct iattr
*attr
);
370 extern struct nfs_open_context
*get_nfs_open_context(struct nfs_open_context
*ctx
);
371 extern void put_nfs_open_context(struct nfs_open_context
*ctx
);
372 extern struct nfs_open_context
*nfs_find_open_context(struct inode
*inode
, struct rpc_cred
*cred
, fmode_t mode
);
373 extern struct nfs_open_context
*alloc_nfs_open_context(struct path
*path
, struct rpc_cred
*cred
, fmode_t f_mode
);
374 extern void nfs_file_set_open_context(struct file
*filp
, struct nfs_open_context
*ctx
);
375 extern struct nfs_lock_context
*nfs_get_lock_context(struct nfs_open_context
*ctx
);
376 extern void nfs_put_lock_context(struct nfs_lock_context
*l_ctx
);
377 extern u64
nfs_compat_user_ino64(u64 fileid
);
378 extern void nfs_fattr_init(struct nfs_fattr
*fattr
);
379 extern unsigned long nfs_inc_attr_generation_counter(void);
381 extern struct nfs_fattr
*nfs_alloc_fattr(void);
383 static inline void nfs_free_fattr(const struct nfs_fattr
*fattr
)
388 extern struct nfs_fh
*nfs_alloc_fhandle(void);
390 static inline void nfs_free_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 inode_operations nfs_file_inode_operations
;
407 extern const struct inode_operations nfs3_file_inode_operations
;
408 #endif /* CONFIG_NFS_V3 */
409 extern const struct file_operations nfs_file_operations
;
410 extern const struct address_space_operations nfs_file_aops
;
411 extern const struct address_space_operations nfs_dir_aops
;
413 static inline struct nfs_open_context
*nfs_file_open_context(struct file
*filp
)
415 return filp
->private_data
;
418 static inline struct rpc_cred
*nfs_file_cred(struct file
*file
)
421 struct nfs_open_context
*ctx
=
422 nfs_file_open_context(file
);
430 * linux/fs/nfs/xattr.c
432 #ifdef CONFIG_NFS_V3_ACL
433 extern ssize_t
nfs3_listxattr(struct dentry
*, char *, size_t);
434 extern ssize_t
nfs3_getxattr(struct dentry
*, const char *, void *, size_t);
435 extern int nfs3_setxattr(struct dentry
*, const char *,
436 const void *, size_t, int);
437 extern int nfs3_removexattr (struct dentry
*, const char *name
);
439 # define nfs3_listxattr NULL
440 # define nfs3_getxattr NULL
441 # define nfs3_setxattr NULL
442 # define nfs3_removexattr NULL
446 * linux/fs/nfs/direct.c
448 extern ssize_t
nfs_direct_IO(int, struct kiocb
*, const struct iovec
*, loff_t
,
450 extern ssize_t
nfs_file_direct_read(struct kiocb
*iocb
,
451 const struct iovec
*iov
, unsigned long nr_segs
,
453 extern ssize_t
nfs_file_direct_write(struct kiocb
*iocb
,
454 const struct iovec
*iov
, unsigned long nr_segs
,
460 extern const struct inode_operations nfs_dir_inode_operations
;
462 extern const struct inode_operations nfs3_dir_inode_operations
;
463 #endif /* CONFIG_NFS_V3 */
464 extern const struct file_operations nfs_dir_operations
;
465 extern const struct dentry_operations nfs_dentry_operations
;
467 extern void nfs_force_lookup_revalidate(struct inode
*dir
);
468 extern int nfs_instantiate(struct dentry
*dentry
, struct nfs_fh
*fh
, struct nfs_fattr
*fattr
);
469 extern int nfs_may_open(struct inode
*inode
, struct rpc_cred
*cred
, int openflags
);
470 extern void nfs_access_zap_cache(struct inode
*inode
);
473 * linux/fs/nfs/symlink.c
475 extern const struct inode_operations nfs_symlink_inode_operations
;
478 * linux/fs/nfs/sysctl.c
481 extern int nfs_register_sysctl(void);
482 extern void nfs_unregister_sysctl(void);
484 #define nfs_register_sysctl() 0
485 #define nfs_unregister_sysctl() do { } while(0)
489 * linux/fs/nfs/namespace.c
491 extern const struct inode_operations nfs_mountpoint_inode_operations
;
492 extern const struct inode_operations nfs_referral_inode_operations
;
493 extern int nfs_mountpoint_expiry_timeout
;
494 extern void nfs_release_automount_timer(void);
497 * linux/fs/nfs/unlink.c
499 extern void nfs_complete_unlink(struct dentry
*dentry
, struct inode
*);
500 extern void nfs_block_sillyrename(struct dentry
*dentry
);
501 extern void nfs_unblock_sillyrename(struct dentry
*dentry
);
502 extern int nfs_sillyrename(struct inode
*dir
, struct dentry
*dentry
);
505 * linux/fs/nfs/write.c
507 extern int nfs_congestion_kb
;
508 extern int nfs_writepage(struct page
*page
, struct writeback_control
*wbc
);
509 extern int nfs_writepages(struct address_space
*, struct writeback_control
*);
510 extern int nfs_flush_incompatible(struct file
*file
, struct page
*page
);
511 extern int nfs_updatepage(struct file
*, struct page
*, unsigned int, unsigned int);
512 extern void nfs_writeback_done(struct rpc_task
*, struct nfs_write_data
*);
515 * Try to write back everything synchronously (but check the
518 extern int nfs_wb_all(struct inode
*inode
);
519 extern int nfs_wb_page(struct inode
*inode
, struct page
* page
);
520 extern int nfs_wb_page_cancel(struct inode
*inode
, struct page
* page
);
521 #if defined(CONFIG_NFS_V3) || defined(CONFIG_NFS_V4)
522 extern int nfs_commit_inode(struct inode
*, int);
523 extern struct nfs_write_data
*nfs_commitdata_alloc(void);
524 extern void nfs_commit_free(struct nfs_write_data
*wdata
);
527 nfs_commit_inode(struct inode
*inode
, int how
)
534 nfs_have_writebacks(struct inode
*inode
)
536 return NFS_I(inode
)->npages
!= 0;
540 * Allocate nfs_write_data structures
542 extern struct nfs_write_data
*nfs_writedata_alloc(unsigned int npages
);
543 extern void nfs_writedata_free(struct nfs_write_data
*);
546 * linux/fs/nfs/read.c
548 extern int nfs_readpage(struct file
*, struct page
*);
549 extern int nfs_readpages(struct file
*, struct address_space
*,
550 struct list_head
*, unsigned);
551 extern int nfs_readpage_result(struct rpc_task
*, struct nfs_read_data
*);
552 extern int nfs_readpage_async(struct nfs_open_context
*, struct inode
*,
556 * Allocate nfs_read_data structures
558 extern struct nfs_read_data
*nfs_readdata_alloc(unsigned int npages
);
559 extern void nfs_readdata_free(struct nfs_read_data
*);
562 * linux/fs/nfs3proc.c
564 #ifdef CONFIG_NFS_V3_ACL
565 extern struct posix_acl
*nfs3_proc_getacl(struct inode
*inode
, int type
);
566 extern int nfs3_proc_setacl(struct inode
*inode
, int type
,
567 struct posix_acl
*acl
);
568 extern int nfs3_proc_set_default_acl(struct inode
*dir
, struct inode
*inode
,
570 extern void nfs3_forget_cached_acls(struct inode
*inode
);
572 static inline int nfs3_proc_set_default_acl(struct inode
*dir
,
579 static inline void nfs3_forget_cached_acls(struct inode
*inode
)
582 #endif /* CONFIG_NFS_V3_ACL */
588 static inline loff_t
nfs_size_to_loff_t(__u64 size
)
590 if (size
> (__u64
) OFFSET_MAX
- 1)
591 return OFFSET_MAX
- 1;
592 return (loff_t
) size
;
596 nfs_fileid_to_ino_t(u64 fileid
)
598 ino_t ino
= (ino_t
) fileid
;
599 if (sizeof(ino_t
) < sizeof(u64
))
600 ino
^= fileid
>> (sizeof(u64
)-sizeof(ino_t
)) * 8;
604 #define NFS_JUKEBOX_RETRY_TIME (5 * HZ)
606 #endif /* __KERNEL__ */
611 #define NFSDBG_VFS 0x0001
612 #define NFSDBG_DIRCACHE 0x0002
613 #define NFSDBG_LOOKUPCACHE 0x0004
614 #define NFSDBG_PAGECACHE 0x0008
615 #define NFSDBG_PROC 0x0010
616 #define NFSDBG_XDR 0x0020
617 #define NFSDBG_FILE 0x0040
618 #define NFSDBG_ROOT 0x0080
619 #define NFSDBG_CALLBACK 0x0100
620 #define NFSDBG_CLIENT 0x0200
621 #define NFSDBG_MOUNT 0x0400
622 #define NFSDBG_FSCACHE 0x0800
623 #define NFSDBG_PNFS 0x1000
624 #define NFSDBG_PNFS_LD 0x2000
625 #define NFSDBG_ALL 0xFFFF
630 * Enable debugging support for nfs client.
631 * Requires RPC_DEBUG.
639 # define ifdebug(fac) if (unlikely(nfs_debug & NFSDBG_##fac))
641 # define ifdebug(fac) if (0)
643 #endif /* __KERNEL */