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_NOCOMMIT 32 /* Don't send the NFSv3/v4 COMMIT */
37 #define FLUSH_INVALIDATE 64 /* Invalidate the page cache */
38 #define FLUSH_NOWRITEPAGE 128 /* Don't call writepage() */
44 #include <linux/pagemap.h>
45 #include <linux/rbtree.h>
46 #include <linux/rwsem.h>
47 #include <linux/wait.h>
49 #include <linux/sunrpc/debug.h>
50 #include <linux/sunrpc/auth.h>
51 #include <linux/sunrpc/clnt.h>
53 #include <linux/nfs.h>
54 #include <linux/nfs2.h>
55 #include <linux/nfs3.h>
56 #include <linux/nfs4.h>
57 #include <linux/nfs_xdr.h>
58 #include <linux/nfs_fs_sb.h>
60 #include <linux/mempool.h>
63 * These are the default flags for swap requests
65 #define NFS_RPC_SWAPFLAGS (RPC_TASK_SWAPPER|RPC_TASK_ROOTCREDS)
68 * NFSv3/v4 Access mode cache entry
70 struct nfs_access_entry
{
71 struct rb_node rb_node
;
73 unsigned long jiffies
;
74 struct rpc_cred
* cred
;
79 struct nfs_open_context
{
82 struct rpc_cred
*cred
;
83 struct nfs4_state
*state
;
88 #define NFS_CONTEXT_ERROR_WRITE (0)
91 struct list_head list
;
99 struct nfs_delegation
;
104 * nfs fs inode data in memory
108 * The 64bit 'inode number'
120 unsigned long flags
; /* atomic bit ops */
121 unsigned long cache_validity
; /* bit mask */
124 * read_cache_jiffies is when we started read-caching this inode.
125 * attrtimeo is for how long the cached information is assumed
126 * to be valid. A successful attribute revalidation doubles
127 * attrtimeo (up to acregmax/acdirmax), a failure resets it to
130 * We need to revalidate the cached attrs for this inode if
132 * jiffies - read_cache_jiffies >= attrtimeo
134 * Please note the comparison is greater than or equal
135 * so that zero timeout values can be specified.
137 unsigned long read_cache_jiffies
;
138 unsigned long attrtimeo
;
139 unsigned long attrtimeo_timestamp
;
140 __u64 change_attr
; /* v4 only */
142 unsigned long attr_gencount
;
143 /* "Generation counter" for the attribute cache. This is
144 * bumped whenever we update the metadata on the
147 unsigned long cache_change_attribute
;
149 struct rb_root access_cache
;
150 struct list_head access_cache_entry_lru
;
151 struct list_head access_cache_inode_lru
;
152 #ifdef CONFIG_NFS_V3_ACL
153 struct posix_acl
*acl_access
;
154 struct posix_acl
*acl_default
;
158 * This is the cookie verifier used for NFSv3 readdir
161 __be32 cookieverf
[2];
164 * This is the list of dirty unwritten pages.
166 struct radix_tree_root nfs_page_tree
;
168 unsigned long npages
;
170 /* Open contexts for shared mmap writes */
171 struct list_head open_files
;
173 /* Number of in-flight sillydelete RPC calls */
174 atomic_t silly_count
;
175 /* List of deferred sillydelete requests */
176 struct hlist_head silly_list
;
177 wait_queue_head_t waitqueue
;
180 struct nfs4_cached_acl
*nfs4_acl
;
182 struct list_head open_states
;
183 struct nfs_delegation
*delegation
;
184 fmode_t delegation_state
;
185 struct rw_semaphore rwsem
;
186 #endif /* CONFIG_NFS_V4*/
187 #ifdef CONFIG_NFS_FSCACHE
188 struct fscache_cookie
*fscache
;
190 struct inode vfs_inode
;
194 * Cache validity bit flags
196 #define NFS_INO_INVALID_ATTR 0x0001 /* cached attrs are invalid */
197 #define NFS_INO_INVALID_DATA 0x0002 /* cached data is invalid */
198 #define NFS_INO_INVALID_ATIME 0x0004 /* cached atime is invalid */
199 #define NFS_INO_INVALID_ACCESS 0x0008 /* cached access cred invalid */
200 #define NFS_INO_INVALID_ACL 0x0010 /* cached acls are invalid */
201 #define NFS_INO_REVAL_PAGECACHE 0x0020 /* must revalidate pagecache */
202 #define NFS_INO_REVAL_FORCED 0x0040 /* force revalidation ignoring a delegation */
205 * Bit offsets in flags field
207 #define NFS_INO_ADVISE_RDPLUS (0) /* advise readdirplus */
208 #define NFS_INO_STALE (1) /* possible stale inode */
209 #define NFS_INO_ACL_LRU_SET (2) /* Inode is on the LRU list */
210 #define NFS_INO_MOUNTPOINT (3) /* inode is remote mountpoint */
211 #define NFS_INO_FLUSHING (4) /* inode is flushing out data */
212 #define NFS_INO_FSCACHE (5) /* inode can be cached by FS-Cache */
213 #define NFS_INO_FSCACHE_LOCK (6) /* FS-Cache cookie management lock */
215 static inline struct nfs_inode
*NFS_I(const struct inode
*inode
)
217 return container_of(inode
, struct nfs_inode
, vfs_inode
);
220 static inline struct nfs_server
*NFS_SB(const struct super_block
*s
)
222 return (struct nfs_server
*)(s
->s_fs_info
);
225 static inline struct nfs_fh
*NFS_FH(const struct inode
*inode
)
227 return &NFS_I(inode
)->fh
;
230 static inline struct nfs_server
*NFS_SERVER(const struct inode
*inode
)
232 return NFS_SB(inode
->i_sb
);
235 static inline struct rpc_clnt
*NFS_CLIENT(const struct inode
*inode
)
237 return NFS_SERVER(inode
)->client
;
240 static inline const struct nfs_rpc_ops
*NFS_PROTO(const struct inode
*inode
)
242 return NFS_SERVER(inode
)->nfs_client
->rpc_ops
;
245 static inline __be32
*NFS_COOKIEVERF(const struct inode
*inode
)
247 return NFS_I(inode
)->cookieverf
;
250 static inline unsigned NFS_MINATTRTIMEO(const struct inode
*inode
)
252 struct nfs_server
*nfss
= NFS_SERVER(inode
);
253 return S_ISDIR(inode
->i_mode
) ? nfss
->acdirmin
: nfss
->acregmin
;
256 static inline unsigned NFS_MAXATTRTIMEO(const struct inode
*inode
)
258 struct nfs_server
*nfss
= NFS_SERVER(inode
);
259 return S_ISDIR(inode
->i_mode
) ? nfss
->acdirmax
: nfss
->acregmax
;
262 static inline int NFS_STALE(const struct inode
*inode
)
264 return test_bit(NFS_INO_STALE
, &NFS_I(inode
)->flags
);
267 static inline int NFS_FSCACHE(const struct inode
*inode
)
269 return test_bit(NFS_INO_FSCACHE
, &NFS_I(inode
)->flags
);
272 static inline __u64
NFS_FILEID(const struct inode
*inode
)
274 return NFS_I(inode
)->fileid
;
277 static inline void set_nfs_fileid(struct inode
*inode
, __u64 fileid
)
279 NFS_I(inode
)->fileid
= fileid
;
282 static inline void nfs_mark_for_revalidate(struct inode
*inode
)
284 struct nfs_inode
*nfsi
= NFS_I(inode
);
286 spin_lock(&inode
->i_lock
);
287 nfsi
->cache_validity
|= NFS_INO_INVALID_ATTR
|NFS_INO_INVALID_ACCESS
;
288 if (S_ISDIR(inode
->i_mode
))
289 nfsi
->cache_validity
|= NFS_INO_REVAL_PAGECACHE
|NFS_INO_INVALID_DATA
;
290 spin_unlock(&inode
->i_lock
);
293 static inline int nfs_server_capable(struct inode
*inode
, int cap
)
295 return NFS_SERVER(inode
)->caps
& cap
;
298 static inline int NFS_USE_READDIRPLUS(struct inode
*inode
)
300 return test_bit(NFS_INO_ADVISE_RDPLUS
, &NFS_I(inode
)->flags
);
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
*,
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 int nfs_permission(struct inode
*, int);
346 extern int nfs_open(struct inode
*, struct file
*);
347 extern int nfs_release(struct inode
*, struct file
*);
348 extern int nfs_attribute_timeout(struct inode
*inode
);
349 extern int nfs_revalidate_inode(struct nfs_server
*server
, struct inode
*inode
);
350 extern int __nfs_revalidate_inode(struct nfs_server
*, struct inode
*);
351 extern int nfs_revalidate_mapping(struct inode
*inode
, struct address_space
*mapping
);
352 extern int nfs_revalidate_mapping_nolock(struct inode
*inode
, struct address_space
*mapping
);
353 extern int nfs_setattr(struct dentry
*, struct iattr
*);
354 extern void nfs_setattr_update_inode(struct inode
*inode
, struct iattr
*attr
);
355 extern struct nfs_open_context
*get_nfs_open_context(struct nfs_open_context
*ctx
);
356 extern void put_nfs_open_context(struct nfs_open_context
*ctx
);
357 extern struct nfs_open_context
*nfs_find_open_context(struct inode
*inode
, struct rpc_cred
*cred
, fmode_t mode
);
358 extern u64
nfs_compat_user_ino64(u64 fileid
);
359 extern void nfs_fattr_init(struct nfs_fattr
*fattr
);
361 /* linux/net/ipv4/ipconfig.c: trims ip addr off front of name, too. */
362 extern __be32
root_nfs_parse_addr(char *name
); /*__init*/
363 extern unsigned long nfs_inc_attr_generation_counter(void);
366 * linux/fs/nfs/file.c
368 extern const struct inode_operations nfs_file_inode_operations
;
370 extern const struct inode_operations nfs3_file_inode_operations
;
371 #endif /* CONFIG_NFS_V3 */
372 extern const struct file_operations nfs_file_operations
;
373 extern const struct address_space_operations nfs_file_aops
;
375 static inline struct nfs_open_context
*nfs_file_open_context(struct file
*filp
)
377 return filp
->private_data
;
380 static inline struct rpc_cred
*nfs_file_cred(struct file
*file
)
383 struct nfs_open_context
*ctx
=
384 nfs_file_open_context(file
);
392 * linux/fs/nfs/xattr.c
394 #ifdef CONFIG_NFS_V3_ACL
395 extern ssize_t
nfs3_listxattr(struct dentry
*, char *, size_t);
396 extern ssize_t
nfs3_getxattr(struct dentry
*, const char *, void *, size_t);
397 extern int nfs3_setxattr(struct dentry
*, const char *,
398 const void *, size_t, int);
399 extern int nfs3_removexattr (struct dentry
*, const char *name
);
401 # define nfs3_listxattr NULL
402 # define nfs3_getxattr NULL
403 # define nfs3_setxattr NULL
404 # define nfs3_removexattr NULL
408 * linux/fs/nfs/direct.c
410 extern ssize_t
nfs_direct_IO(int, struct kiocb
*, const struct iovec
*, loff_t
,
412 extern ssize_t
nfs_file_direct_read(struct kiocb
*iocb
,
413 const struct iovec
*iov
, unsigned long nr_segs
,
415 extern ssize_t
nfs_file_direct_write(struct kiocb
*iocb
,
416 const struct iovec
*iov
, unsigned long nr_segs
,
422 extern const struct inode_operations nfs_dir_inode_operations
;
424 extern const struct inode_operations nfs3_dir_inode_operations
;
425 #endif /* CONFIG_NFS_V3 */
426 extern const struct file_operations nfs_dir_operations
;
427 extern const struct dentry_operations nfs_dentry_operations
;
429 extern void nfs_force_lookup_revalidate(struct inode
*dir
);
430 extern int nfs_instantiate(struct dentry
*dentry
, struct nfs_fh
*fh
, struct nfs_fattr
*fattr
);
431 extern int nfs_may_open(struct inode
*inode
, struct rpc_cred
*cred
, int openflags
);
432 extern void nfs_access_zap_cache(struct inode
*inode
);
435 * linux/fs/nfs/symlink.c
437 extern const struct inode_operations nfs_symlink_inode_operations
;
440 * linux/fs/nfs/sysctl.c
443 extern int nfs_register_sysctl(void);
444 extern void nfs_unregister_sysctl(void);
446 #define nfs_register_sysctl() 0
447 #define nfs_unregister_sysctl() do { } while(0)
451 * linux/fs/nfs/namespace.c
453 extern const struct inode_operations nfs_mountpoint_inode_operations
;
454 extern const struct inode_operations nfs_referral_inode_operations
;
455 extern int nfs_mountpoint_expiry_timeout
;
456 extern void nfs_release_automount_timer(void);
459 * linux/fs/nfs/unlink.c
461 extern int nfs_async_unlink(struct inode
*dir
, struct dentry
*dentry
);
462 extern void nfs_complete_unlink(struct dentry
*dentry
, struct inode
*);
463 extern void nfs_block_sillyrename(struct dentry
*dentry
);
464 extern void nfs_unblock_sillyrename(struct dentry
*dentry
);
467 * linux/fs/nfs/write.c
469 extern int nfs_congestion_kb
;
470 extern int nfs_writepage(struct page
*page
, struct writeback_control
*wbc
);
471 extern int nfs_writepages(struct address_space
*, struct writeback_control
*);
472 extern int nfs_flush_incompatible(struct file
*file
, struct page
*page
);
473 extern int nfs_updatepage(struct file
*, struct page
*, unsigned int, unsigned int);
474 extern int nfs_writeback_done(struct rpc_task
*, struct nfs_write_data
*);
477 * Try to write back everything synchronously (but check the
480 extern long nfs_sync_mapping_wait(struct address_space
*, struct writeback_control
*, int);
481 extern int nfs_wb_all(struct inode
*inode
);
482 extern int nfs_wb_nocommit(struct inode
*inode
);
483 extern int nfs_wb_page(struct inode
*inode
, struct page
* page
);
484 extern int nfs_wb_page_cancel(struct inode
*inode
, struct page
* page
);
485 #if defined(CONFIG_NFS_V3) || defined(CONFIG_NFS_V4)
486 extern int nfs_commit_inode(struct inode
*, int);
487 extern struct nfs_write_data
*nfs_commitdata_alloc(void);
488 extern void nfs_commit_free(struct nfs_write_data
*wdata
);
491 nfs_commit_inode(struct inode
*inode
, int how
)
498 nfs_have_writebacks(struct inode
*inode
)
500 return NFS_I(inode
)->npages
!= 0;
504 * Allocate nfs_write_data structures
506 extern struct nfs_write_data
*nfs_writedata_alloc(unsigned int npages
);
507 extern void nfs_writedata_free(struct nfs_write_data
*);
510 * linux/fs/nfs/read.c
512 extern int nfs_readpage(struct file
*, struct page
*);
513 extern int nfs_readpages(struct file
*, struct address_space
*,
514 struct list_head
*, unsigned);
515 extern int nfs_readpage_result(struct rpc_task
*, struct nfs_read_data
*);
516 extern int nfs_readpage_async(struct nfs_open_context
*, struct inode
*,
520 * Allocate nfs_read_data structures
522 extern struct nfs_read_data
*nfs_readdata_alloc(unsigned int npages
);
523 extern void nfs_readdata_free(struct nfs_read_data
*);
526 * linux/fs/nfs3proc.c
528 #ifdef CONFIG_NFS_V3_ACL
529 extern struct posix_acl
*nfs3_proc_getacl(struct inode
*inode
, int type
);
530 extern int nfs3_proc_setacl(struct inode
*inode
, int type
,
531 struct posix_acl
*acl
);
532 extern int nfs3_proc_set_default_acl(struct inode
*dir
, struct inode
*inode
,
534 extern void nfs3_forget_cached_acls(struct inode
*inode
);
536 static inline int nfs3_proc_set_default_acl(struct inode
*dir
,
543 static inline void nfs3_forget_cached_acls(struct inode
*inode
)
546 #endif /* CONFIG_NFS_V3_ACL */
552 static inline loff_t
nfs_size_to_loff_t(__u64 size
)
554 if (size
> (__u64
) OFFSET_MAX
- 1)
555 return OFFSET_MAX
- 1;
556 return (loff_t
) size
;
560 nfs_fileid_to_ino_t(u64 fileid
)
562 ino_t ino
= (ino_t
) fileid
;
563 if (sizeof(ino_t
) < sizeof(u64
))
564 ino
^= fileid
>> (sizeof(u64
)-sizeof(ino_t
)) * 8;
570 extern void * nfs_root_data(void);
572 #define nfs_wait_event(clnt, wq, condition) \
574 int __retval = wait_event_killable(wq, condition); \
578 #define NFS_JUKEBOX_RETRY_TIME (5 * HZ)
580 #endif /* __KERNEL__ */
585 #define NFSDBG_VFS 0x0001
586 #define NFSDBG_DIRCACHE 0x0002
587 #define NFSDBG_LOOKUPCACHE 0x0004
588 #define NFSDBG_PAGECACHE 0x0008
589 #define NFSDBG_PROC 0x0010
590 #define NFSDBG_XDR 0x0020
591 #define NFSDBG_FILE 0x0040
592 #define NFSDBG_ROOT 0x0080
593 #define NFSDBG_CALLBACK 0x0100
594 #define NFSDBG_CLIENT 0x0200
595 #define NFSDBG_MOUNT 0x0400
596 #define NFSDBG_FSCACHE 0x0800
597 #define NFSDBG_ALL 0xFFFF
602 * Enable debugging support for nfs client.
603 * Requires RPC_DEBUG.
611 # define ifdebug(fac) if (unlikely(nfs_debug & NFSDBG_##fac))
613 # define ifdebug(fac) if (0)
615 #endif /* __KERNEL */