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_MAX_UDP_TIMEOUT (60*HZ)
16 #define NFS_MAX_TCP_TIMEOUT (600*HZ)
19 * When flushing a cluster of dirty pages, there can be different
22 #define FLUSH_SYNC 1 /* file being synced, or contention */
23 #define FLUSH_STABLE 4 /* commit to stable storage */
24 #define FLUSH_LOWPRI 8 /* low priority background flush */
25 #define FLUSH_HIGHPRI 16 /* high priority memory reclaim flush */
26 #define FLUSH_NOCOMMIT 32 /* Don't send the NFSv3/v4 COMMIT */
27 #define FLUSH_INVALIDATE 64 /* Invalidate the page cache */
28 #define FLUSH_NOWRITEPAGE 128 /* Don't call writepage() */
33 #include <linux/kref.h>
35 #include <linux/namei.h>
36 #include <linux/pagemap.h>
37 #include <linux/rbtree.h>
38 #include <linux/rwsem.h>
39 #include <linux/wait.h>
41 #include <linux/sunrpc/debug.h>
42 #include <linux/sunrpc/auth.h>
43 #include <linux/sunrpc/clnt.h>
45 #include <linux/nfs.h>
46 #include <linux/nfs2.h>
47 #include <linux/nfs3.h>
48 #include <linux/nfs4.h>
49 #include <linux/nfs_xdr.h>
50 #include <linux/nfs_fs_sb.h>
52 #include <linux/mempool.h>
55 * These are the default flags for swap requests
57 #define NFS_RPC_SWAPFLAGS (RPC_TASK_SWAPPER|RPC_TASK_ROOTCREDS)
60 * NFSv3/v4 Access mode cache entry
62 struct nfs_access_entry {
63 struct rb_node rb_node;
65 unsigned long jiffies;
66 struct rpc_cred * cred;
71 struct nfs_open_context {
74 struct rpc_cred *cred;
75 struct nfs4_state *state;
80 #define NFS_CONTEXT_ERROR_WRITE (0)
83 struct list_head list;
91 struct nfs_delegation;
96 * nfs fs inode data in memory
100 * The 64bit 'inode number'
112 unsigned long flags; /* atomic bit ops */
113 unsigned long cache_validity; /* bit mask */
116 * read_cache_jiffies is when we started read-caching this inode.
117 * attrtimeo is for how long the cached information is assumed
118 * to be valid. A successful attribute revalidation doubles
119 * attrtimeo (up to acregmax/acdirmax), a failure resets it to
122 * We need to revalidate the cached attrs for this inode if
124 * jiffies - read_cache_jiffies > attrtimeo
126 unsigned long read_cache_jiffies;
127 unsigned long attrtimeo;
128 unsigned long attrtimeo_timestamp;
129 __u64 change_attr; /* v4 only */
131 unsigned long last_updated;
132 /* "Generation counter" for the attribute cache. This is
133 * bumped whenever we update the metadata on the
136 unsigned long cache_change_attribute;
138 struct rb_root access_cache;
139 struct list_head access_cache_entry_lru;
140 struct list_head access_cache_inode_lru;
141 #ifdef CONFIG_NFS_V3_ACL
142 struct posix_acl *acl_access;
143 struct posix_acl *acl_default;
147 * This is the cookie verifier used for NFSv3 readdir
150 __be32 cookieverf[2];
153 * This is the list of dirty unwritten pages.
155 struct radix_tree_root nfs_page_tree;
157 unsigned long ncommit,
160 /* Open contexts for shared mmap writes */
161 struct list_head open_files;
163 /* Number of in-flight sillydelete RPC calls */
164 atomic_t silly_count;
165 /* List of deferred sillydelete requests */
166 struct hlist_head silly_list;
167 wait_queue_head_t waitqueue;
170 struct nfs4_cached_acl *nfs4_acl;
172 struct list_head open_states;
173 struct nfs_delegation *delegation;
174 int delegation_state;
175 struct rw_semaphore rwsem;
176 #endif /* CONFIG_NFS_V4*/
177 struct inode vfs_inode;
181 * Cache validity bit flags
183 #define NFS_INO_INVALID_ATTR 0x0001 /* cached attrs are invalid */
184 #define NFS_INO_INVALID_DATA 0x0002 /* cached data is invalid */
185 #define NFS_INO_INVALID_ATIME 0x0004 /* cached atime is invalid */
186 #define NFS_INO_INVALID_ACCESS 0x0008 /* cached access cred invalid */
187 #define NFS_INO_INVALID_ACL 0x0010 /* cached acls are invalid */
188 #define NFS_INO_REVAL_PAGECACHE 0x0020 /* must revalidate pagecache */
189 #define NFS_INO_REVAL_FORCED 0x0040 /* force revalidation ignoring a delegation */
192 * Bit offsets in flags field
194 #define NFS_INO_REVALIDATING (0) /* revalidating attrs */
195 #define NFS_INO_ADVISE_RDPLUS (1) /* advise readdirplus */
196 #define NFS_INO_STALE (2) /* possible stale inode */
197 #define NFS_INO_ACL_LRU_SET (3) /* Inode is on the LRU list */
199 static inline struct nfs_inode *NFS_I(struct inode *inode)
201 return container_of(inode, struct nfs_inode, vfs_inode);
203 #define NFS_SB(s) ((struct nfs_server *)(s->s_fs_info))
205 #define NFS_FH(inode) (&NFS_I(inode)->fh)
206 #define NFS_SERVER(inode) (NFS_SB(inode->i_sb))
207 #define NFS_CLIENT(inode) (NFS_SERVER(inode)->client)
208 #define NFS_PROTO(inode) (NFS_SERVER(inode)->nfs_client->rpc_ops)
209 #define NFS_COOKIEVERF(inode) (NFS_I(inode)->cookieverf)
210 #define NFS_MINATTRTIMEO(inode) \
211 (S_ISDIR(inode->i_mode)? NFS_SERVER(inode)->acdirmin \
212 : NFS_SERVER(inode)->acregmin)
213 #define NFS_MAXATTRTIMEO(inode) \
214 (S_ISDIR(inode->i_mode)? NFS_SERVER(inode)->acdirmax \
215 : NFS_SERVER(inode)->acregmax)
217 #define NFS_FLAGS(inode) (NFS_I(inode)->flags)
218 #define NFS_STALE(inode) (test_bit(NFS_INO_STALE, &NFS_FLAGS(inode)))
220 #define NFS_FILEID(inode) (NFS_I(inode)->fileid)
222 static inline void nfs_mark_for_revalidate(struct inode *inode)
224 struct nfs_inode *nfsi = NFS_I(inode);
226 spin_lock(&inode->i_lock);
227 nfsi->cache_validity |= NFS_INO_INVALID_ATTR|NFS_INO_INVALID_ACCESS;
228 if (S_ISDIR(inode->i_mode))
229 nfsi->cache_validity |= NFS_INO_REVAL_PAGECACHE|NFS_INO_INVALID_DATA;
230 spin_unlock(&inode->i_lock);
233 static inline int nfs_server_capable(struct inode *inode, int cap)
235 return NFS_SERVER(inode)->caps & cap;
238 static inline int NFS_USE_READDIRPLUS(struct inode *inode)
240 return test_bit(NFS_INO_ADVISE_RDPLUS, &NFS_FLAGS(inode));
243 static inline void nfs_set_verifier(struct dentry * dentry, unsigned long verf)
245 dentry->d_time = verf;
249 * nfs_save_change_attribute - Returns the inode attribute change cookie
250 * @dir - pointer to parent directory inode
251 * The "change attribute" is updated every time we finish an operation
252 * that will result in a metadata change on the server.
254 static inline unsigned long nfs_save_change_attribute(struct inode *dir)
256 return NFS_I(dir)->cache_change_attribute;
260 * nfs_verify_change_attribute - Detects NFS remote directory changes
261 * @dir - pointer to parent directory inode
262 * @chattr - previously saved change attribute
263 * Return "false" if the verifiers doesn't match the change attribute.
264 * This would usually indicate that the directory contents have changed on
265 * the server, and that any dentries need revalidating.
267 static inline int nfs_verify_change_attribute(struct inode *dir, unsigned long chattr)
269 return chattr == NFS_I(dir)->cache_change_attribute;
273 * linux/fs/nfs/inode.c
275 extern int nfs_sync_mapping(struct address_space *mapping);
276 extern void nfs_zap_mapping(struct inode *inode, struct address_space *mapping);
277 extern void nfs_zap_caches(struct inode *);
278 extern void nfs_invalidate_atime(struct inode *);
279 extern struct inode *nfs_fhget(struct super_block *, struct nfs_fh *,
281 extern int nfs_refresh_inode(struct inode *, struct nfs_fattr *);
282 extern int nfs_post_op_update_inode(struct inode *inode, struct nfs_fattr *fattr);
283 extern int nfs_post_op_update_inode_force_wcc(struct inode *inode, struct nfs_fattr *fattr);
284 extern int nfs_getattr(struct vfsmount *, struct dentry *, struct kstat *);
285 extern int nfs_permission(struct inode *, int, struct nameidata *);
286 extern int nfs_open(struct inode *, struct file *);
287 extern int nfs_release(struct inode *, struct file *);
288 extern int nfs_attribute_timeout(struct inode *inode);
289 extern int nfs_revalidate_inode(struct nfs_server *server, struct inode *inode);
290 extern int __nfs_revalidate_inode(struct nfs_server *, struct inode *);
291 extern int nfs_revalidate_mapping(struct inode *inode, struct address_space *mapping);
292 extern int nfs_revalidate_mapping_nolock(struct inode *inode, struct address_space *mapping);
293 extern int nfs_setattr(struct dentry *, struct iattr *);
294 extern void nfs_setattr_update_inode(struct inode *inode, struct iattr *attr);
295 extern struct nfs_open_context *get_nfs_open_context(struct nfs_open_context *ctx);
296 extern void put_nfs_open_context(struct nfs_open_context *ctx);
297 extern struct nfs_open_context *nfs_find_open_context(struct inode *inode, struct rpc_cred *cred, int mode);
298 extern u64 nfs_compat_user_ino64(u64 fileid);
300 /* linux/net/ipv4/ipconfig.c: trims ip addr off front of name, too. */
301 extern __be32 root_nfs_parse_addr(char *name); /*__init*/
303 static inline void nfs_fattr_init(struct nfs_fattr *fattr)
306 fattr->time_start = jiffies;
310 * linux/fs/nfs/file.c
312 extern const struct inode_operations nfs_file_inode_operations;
314 extern const struct inode_operations nfs3_file_inode_operations;
315 #endif /* CONFIG_NFS_V3 */
316 extern const struct file_operations nfs_file_operations;
317 extern const struct address_space_operations nfs_file_aops;
319 static inline struct nfs_open_context *nfs_file_open_context(struct file *filp)
321 return filp->private_data;
324 static inline struct rpc_cred *nfs_file_cred(struct file *file)
327 return nfs_file_open_context(file)->cred;
332 * linux/fs/nfs/xattr.c
334 #ifdef CONFIG_NFS_V3_ACL
335 extern ssize_t nfs3_listxattr(struct dentry *, char *, size_t);
336 extern ssize_t nfs3_getxattr(struct dentry *, const char *, void *, size_t);
337 extern int nfs3_setxattr(struct dentry *, const char *,
338 const void *, size_t, int);
339 extern int nfs3_removexattr (struct dentry *, const char *name);
341 # define nfs3_listxattr NULL
342 # define nfs3_getxattr NULL
343 # define nfs3_setxattr NULL
344 # define nfs3_removexattr NULL
348 * linux/fs/nfs/direct.c
350 extern ssize_t nfs_direct_IO(int, struct kiocb *, const struct iovec *, loff_t,
352 extern ssize_t nfs_file_direct_read(struct kiocb *iocb,
353 const struct iovec *iov, unsigned long nr_segs,
355 extern ssize_t nfs_file_direct_write(struct kiocb *iocb,
356 const struct iovec *iov, unsigned long nr_segs,
362 extern const struct inode_operations nfs_dir_inode_operations;
364 extern const struct inode_operations nfs3_dir_inode_operations;
365 #endif /* CONFIG_NFS_V3 */
366 extern const struct file_operations nfs_dir_operations;
367 extern struct dentry_operations nfs_dentry_operations;
369 extern int nfs_instantiate(struct dentry *dentry, struct nfs_fh *fh, struct nfs_fattr *fattr);
370 extern int nfs_may_open(struct inode *inode, struct rpc_cred *cred, int openflags);
371 extern void nfs_access_zap_cache(struct inode *inode);
374 * linux/fs/nfs/symlink.c
376 extern const struct inode_operations nfs_symlink_inode_operations;
379 * linux/fs/nfs/sysctl.c
382 extern int nfs_register_sysctl(void);
383 extern void nfs_unregister_sysctl(void);
385 #define nfs_register_sysctl() 0
386 #define nfs_unregister_sysctl() do { } while(0)
390 * linux/fs/nfs/namespace.c
392 extern struct list_head nfs_automount_list;
393 extern const struct inode_operations nfs_mountpoint_inode_operations;
394 extern const struct inode_operations nfs_referral_inode_operations;
395 extern int nfs_mountpoint_expiry_timeout;
396 extern void nfs_release_automount_timer(void);
399 * linux/fs/nfs/unlink.c
401 extern int nfs_async_unlink(struct inode *dir, struct dentry *dentry);
402 extern void nfs_complete_unlink(struct dentry *dentry, struct inode *);
403 extern void nfs_block_sillyrename(struct dentry *dentry);
404 extern void nfs_unblock_sillyrename(struct dentry *dentry);
407 * linux/fs/nfs/write.c
409 extern int nfs_congestion_kb;
410 extern int nfs_writepage(struct page *page, struct writeback_control *wbc);
411 extern int nfs_writepages(struct address_space *, struct writeback_control *);
412 extern int nfs_flush_incompatible(struct file *file, struct page *page);
413 extern int nfs_updatepage(struct file *, struct page *, unsigned int, unsigned int);
414 extern int nfs_writeback_done(struct rpc_task *, struct nfs_write_data *);
415 extern void nfs_writedata_release(void *);
418 * Try to write back everything synchronously (but check the
421 extern long nfs_sync_mapping_wait(struct address_space *, struct writeback_control *, int);
422 extern int nfs_wb_all(struct inode *inode);
423 extern int nfs_wb_nocommit(struct inode *inode);
424 extern int nfs_wb_page(struct inode *inode, struct page* page);
425 extern int nfs_wb_page_cancel(struct inode *inode, struct page* page);
426 #if defined(CONFIG_NFS_V3) || defined(CONFIG_NFS_V4)
427 extern int nfs_commit_inode(struct inode *, int);
428 extern struct nfs_write_data *nfs_commit_alloc(void);
429 extern void nfs_commit_free(struct nfs_write_data *wdata);
430 extern void nfs_commit_release(void *wdata);
433 nfs_commit_inode(struct inode *inode, int how)
440 nfs_have_writebacks(struct inode *inode)
442 return NFS_I(inode)->npages != 0;
446 * Allocate nfs_write_data structures
448 extern struct nfs_write_data *nfs_writedata_alloc(unsigned int npages);
451 * linux/fs/nfs/read.c
453 extern int nfs_readpage(struct file *, struct page *);
454 extern int nfs_readpages(struct file *, struct address_space *,
455 struct list_head *, unsigned);
456 extern int nfs_readpage_result(struct rpc_task *, struct nfs_read_data *);
457 extern void nfs_readdata_release(void *data);
460 * Allocate nfs_read_data structures
462 extern struct nfs_read_data *nfs_readdata_alloc(unsigned int npages);
465 * linux/fs/nfs3proc.c
467 #ifdef CONFIG_NFS_V3_ACL
468 extern struct posix_acl *nfs3_proc_getacl(struct inode *inode, int type);
469 extern int nfs3_proc_setacl(struct inode *inode, int type,
470 struct posix_acl *acl);
471 extern int nfs3_proc_set_default_acl(struct inode *dir, struct inode *inode,
473 extern void nfs3_forget_cached_acls(struct inode *inode);
475 static inline int nfs3_proc_set_default_acl(struct inode *dir,
482 static inline void nfs3_forget_cached_acls(struct inode *inode)
485 #endif /* CONFIG_NFS_V3_ACL */
488 * linux/fs/mount_clnt.c
490 extern int nfs_mount(struct sockaddr *, size_t, char *, char *,
491 int, int, struct nfs_fh *);
497 static inline loff_t nfs_size_to_loff_t(__u64 size)
499 if (size > (__u64) OFFSET_MAX - 1)
500 return OFFSET_MAX - 1;
501 return (loff_t) size;
505 nfs_fileid_to_ino_t(u64 fileid)
507 ino_t ino = (ino_t) fileid;
508 if (sizeof(ino_t) < sizeof(u64))
509 ino ^= fileid >> (sizeof(u64)-sizeof(ino_t)) * 8;
515 extern void * nfs_root_data(void);
517 #define nfs_wait_event(clnt, wq, condition) \
519 int __retval = wait_event_killable(wq, condition); \
523 #define NFS_JUKEBOX_RETRY_TIME (5 * HZ)
525 #endif /* __KERNEL__ */
530 #define NFSDBG_VFS 0x0001
531 #define NFSDBG_DIRCACHE 0x0002
532 #define NFSDBG_LOOKUPCACHE 0x0004
533 #define NFSDBG_PAGECACHE 0x0008
534 #define NFSDBG_PROC 0x0010
535 #define NFSDBG_XDR 0x0020
536 #define NFSDBG_FILE 0x0040
537 #define NFSDBG_ROOT 0x0080
538 #define NFSDBG_CALLBACK 0x0100
539 #define NFSDBG_CLIENT 0x0200
540 #define NFSDBG_MOUNT 0x0400
541 #define NFSDBG_ALL 0xFFFF
546 * Enable debugging support for nfs client.
547 * Requires RPC_DEBUG.
555 # define ifdebug(fac) if (unlikely(nfs_debug & NFSDBG_##fac))
557 # define ifdebug(fac) if (0)
559 #endif /* __KERNEL */