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
13 * Enable debugging support for nfs client.
20 /* Default timeout values */
21 #define NFS_MAX_UDP_TIMEOUT (60*HZ)
22 #define NFS_MAX_TCP_TIMEOUT (600*HZ)
25 * superblock magic number for NFS
27 #define NFS_SUPER_MAGIC 0x6969
30 * When flushing a cluster of dirty pages, there can be different
33 #define FLUSH_SYNC 1 /* file being synced, or contention */
34 #define FLUSH_STABLE 4 /* commit to stable storage */
35 #define FLUSH_LOWPRI 8 /* low priority background flush */
36 #define FLUSH_HIGHPRI 16 /* high priority memory reclaim flush */
37 #define FLUSH_NOCOMMIT 32 /* Don't send the NFSv3/v4 COMMIT */
38 #define FLUSH_INVALIDATE 64 /* Invalidate the page cache */
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>
59 #include <linux/nfs_fs_sb.h>
61 #include <linux/rwsem.h>
62 #include <linux/mempool.h>
65 * These are the default flags for swap requests
67 #define NFS_RPC_SWAPFLAGS (RPC_TASK_SWAPPER|RPC_TASK_ROOTCREDS)
70 * NFSv3/v4 Access mode cache entry
72 struct nfs_access_entry {
73 struct rb_node rb_node;
75 unsigned long jiffies;
76 struct rpc_cred * cred;
81 struct nfs_open_context {
83 struct vfsmount *vfsmnt;
84 struct dentry *dentry;
85 struct rpc_cred *cred;
86 struct nfs4_state *state;
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 unsigned long read_cache_jiffies;
135 unsigned long attrtimeo;
136 unsigned long attrtimeo_timestamp;
137 __u64 change_attr; /* v4 only */
139 unsigned long last_updated;
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 * Counter indicating the number of outstanding requests that
147 * will cause a file data update.
149 atomic_t data_updates;
151 struct rb_root access_cache;
152 struct list_head access_cache_entry_lru;
153 struct list_head access_cache_inode_lru;
154 #ifdef CONFIG_NFS_V3_ACL
155 struct posix_acl *acl_access;
156 struct posix_acl *acl_default;
160 * This is the cookie verifier used for NFSv3 readdir
166 * This is the list of dirty unwritten pages.
169 struct list_head dirty;
170 struct list_head commit;
171 struct radix_tree_root nfs_page_tree;
177 /* Open contexts for shared mmap writes */
178 struct list_head open_files;
181 struct nfs4_cached_acl *nfs4_acl;
183 struct list_head open_states;
184 struct nfs_delegation *delegation;
185 int delegation_state;
186 struct rw_semaphore rwsem;
187 #endif /* CONFIG_NFS_V4*/
188 struct inode vfs_inode;
192 * Cache validity bit flags
194 #define NFS_INO_INVALID_ATTR 0x0001 /* cached attrs are invalid */
195 #define NFS_INO_INVALID_DATA 0x0002 /* cached data is invalid */
196 #define NFS_INO_INVALID_ATIME 0x0004 /* cached atime is invalid */
197 #define NFS_INO_INVALID_ACCESS 0x0008 /* cached access cred invalid */
198 #define NFS_INO_INVALID_ACL 0x0010 /* cached acls are invalid */
199 #define NFS_INO_REVAL_PAGECACHE 0x0020 /* must revalidate pagecache */
202 * Bit offsets in flags field
204 #define NFS_INO_REVALIDATING (0) /* revalidating attrs */
205 #define NFS_INO_ADVISE_RDPLUS (1) /* advise readdirplus */
206 #define NFS_INO_STALE (2) /* possible stale inode */
207 #define NFS_INO_ACL_LRU_SET (3) /* Inode is on the LRU list */
209 static inline struct nfs_inode *NFS_I(struct inode *inode)
211 return container_of(inode, struct nfs_inode, vfs_inode);
213 #define NFS_SB(s) ((struct nfs_server *)(s->s_fs_info))
215 #define NFS_FH(inode) (&NFS_I(inode)->fh)
216 #define NFS_SERVER(inode) (NFS_SB(inode->i_sb))
217 #define NFS_CLIENT(inode) (NFS_SERVER(inode)->client)
218 #define NFS_PROTO(inode) (NFS_SERVER(inode)->rpc_ops)
219 #define NFS_ADDR(inode) (RPC_PEERADDR(NFS_CLIENT(inode)))
220 #define NFS_COOKIEVERF(inode) (NFS_I(inode)->cookieverf)
221 #define NFS_READTIME(inode) (NFS_I(inode)->read_cache_jiffies)
222 #define NFS_CHANGE_ATTR(inode) (NFS_I(inode)->change_attr)
223 #define NFS_ATTRTIMEO(inode) (NFS_I(inode)->attrtimeo)
224 #define NFS_MINATTRTIMEO(inode) \
225 (S_ISDIR(inode->i_mode)? NFS_SERVER(inode)->acdirmin \
226 : NFS_SERVER(inode)->acregmin)
227 #define NFS_MAXATTRTIMEO(inode) \
228 (S_ISDIR(inode->i_mode)? NFS_SERVER(inode)->acdirmax \
229 : NFS_SERVER(inode)->acregmax)
230 #define NFS_ATTRTIMEO_UPDATE(inode) (NFS_I(inode)->attrtimeo_timestamp)
232 #define NFS_FLAGS(inode) (NFS_I(inode)->flags)
233 #define NFS_STALE(inode) (test_bit(NFS_INO_STALE, &NFS_FLAGS(inode)))
235 #define NFS_FILEID(inode) (NFS_I(inode)->fileid)
237 static inline int nfs_caches_unstable(struct inode *inode)
239 return atomic_read(&NFS_I(inode)->data_updates) != 0;
242 static inline void nfs_mark_for_revalidate(struct inode *inode)
244 struct nfs_inode *nfsi = NFS_I(inode);
246 spin_lock(&inode->i_lock);
247 nfsi->cache_validity |= NFS_INO_INVALID_ATTR|NFS_INO_INVALID_ACCESS;
248 if (S_ISDIR(inode->i_mode))
249 nfsi->cache_validity |= NFS_INO_REVAL_PAGECACHE|NFS_INO_INVALID_DATA;
250 spin_unlock(&inode->i_lock);
253 static inline void NFS_CACHEINV(struct inode *inode)
255 if (!nfs_caches_unstable(inode))
256 nfs_mark_for_revalidate(inode);
259 static inline int nfs_server_capable(struct inode *inode, int cap)
261 return NFS_SERVER(inode)->caps & cap;
264 static inline int NFS_USE_READDIRPLUS(struct inode *inode)
266 return test_bit(NFS_INO_ADVISE_RDPLUS, &NFS_FLAGS(inode));
270 * nfs_save_change_attribute - Returns the inode attribute change cookie
271 * @inode - pointer to inode
272 * The "change attribute" is updated every time we finish an operation
273 * that will result in a metadata change on the server.
275 static inline long nfs_save_change_attribute(struct inode *inode)
277 return NFS_I(inode)->cache_change_attribute;
281 * nfs_verify_change_attribute - Detects NFS inode cache updates
282 * @inode - pointer to inode
283 * @chattr - previously saved change attribute
284 * Return "false" if metadata has been updated (or is in the process of
285 * being updated) since the change attribute was saved.
287 static inline int nfs_verify_change_attribute(struct inode *inode, unsigned long chattr)
289 return !nfs_caches_unstable(inode)
290 && time_after_eq(chattr, NFS_I(inode)->cache_change_attribute);
294 * linux/fs/nfs/inode.c
296 extern int nfs_sync_mapping(struct address_space *mapping);
297 extern void nfs_zap_caches(struct inode *);
298 extern struct inode *nfs_fhget(struct super_block *, struct nfs_fh *,
300 extern int nfs_refresh_inode(struct inode *, struct nfs_fattr *);
301 extern int nfs_post_op_update_inode(struct inode *inode, struct nfs_fattr *fattr);
302 extern int nfs_getattr(struct vfsmount *, struct dentry *, struct kstat *);
303 extern int nfs_permission(struct inode *, int, struct nameidata *);
304 extern int nfs_access_get_cached(struct inode *, struct rpc_cred *, struct nfs_access_entry *);
305 extern void nfs_access_add_cache(struct inode *, struct nfs_access_entry *);
306 extern void nfs_access_zap_cache(struct inode *inode);
307 extern int nfs_open(struct inode *, struct file *);
308 extern int nfs_release(struct inode *, struct file *);
309 extern int nfs_attribute_timeout(struct inode *inode);
310 extern int nfs_revalidate_inode(struct nfs_server *server, struct inode *inode);
311 extern int __nfs_revalidate_inode(struct nfs_server *, struct inode *);
312 extern int nfs_revalidate_mapping(struct inode *inode, struct address_space *mapping);
313 extern int nfs_setattr(struct dentry *, struct iattr *);
314 extern void nfs_setattr_update_inode(struct inode *inode, struct iattr *attr);
315 extern void nfs_begin_attr_update(struct inode *);
316 extern void nfs_end_attr_update(struct inode *);
317 extern void nfs_begin_data_update(struct inode *);
318 extern void nfs_end_data_update(struct inode *);
319 extern struct nfs_open_context *get_nfs_open_context(struct nfs_open_context *ctx);
320 extern void put_nfs_open_context(struct nfs_open_context *ctx);
321 extern struct nfs_open_context *nfs_find_open_context(struct inode *inode, struct rpc_cred *cred, int mode);
322 extern struct vfsmount *nfs_do_submount(const struct vfsmount *mnt_parent,
323 const struct dentry *dentry,
325 struct nfs_fattr *fattr);
327 /* linux/net/ipv4/ipconfig.c: trims ip addr off front of name, too. */
328 extern u32 root_nfs_parse_addr(char *name); /*__init*/
330 static inline void nfs_fattr_init(struct nfs_fattr *fattr)
333 fattr->time_start = jiffies;
337 * linux/fs/nfs/file.c
339 extern struct inode_operations nfs_file_inode_operations;
341 extern struct inode_operations nfs3_file_inode_operations;
342 #endif /* CONFIG_NFS_V3 */
343 extern const struct file_operations nfs_file_operations;
344 extern const struct address_space_operations nfs_file_aops;
346 static inline struct rpc_cred *nfs_file_cred(struct file *file)
349 struct nfs_open_context *ctx;
351 ctx = (struct nfs_open_context*)file->private_data;
358 * linux/fs/nfs/xattr.c
360 #ifdef CONFIG_NFS_V3_ACL
361 extern ssize_t nfs3_listxattr(struct dentry *, char *, size_t);
362 extern ssize_t nfs3_getxattr(struct dentry *, const char *, void *, size_t);
363 extern int nfs3_setxattr(struct dentry *, const char *,
364 const void *, size_t, int);
365 extern int nfs3_removexattr (struct dentry *, const char *name);
367 # define nfs3_listxattr NULL
368 # define nfs3_getxattr NULL
369 # define nfs3_setxattr NULL
370 # define nfs3_removexattr NULL
374 * linux/fs/nfs/direct.c
376 extern ssize_t nfs_direct_IO(int, struct kiocb *, const struct iovec *, loff_t,
378 extern ssize_t nfs_file_direct_read(struct kiocb *iocb, char __user *buf,
379 size_t count, loff_t pos);
380 extern ssize_t nfs_file_direct_write(struct kiocb *iocb, const char __user *buf,
381 size_t count, loff_t pos);
386 extern struct inode_operations nfs_dir_inode_operations;
388 extern struct inode_operations nfs3_dir_inode_operations;
389 #endif /* CONFIG_NFS_V3 */
390 extern const struct file_operations nfs_dir_operations;
391 extern struct dentry_operations nfs_dentry_operations;
393 extern int nfs_instantiate(struct dentry *dentry, struct nfs_fh *fh, struct nfs_fattr *fattr);
396 * linux/fs/nfs/symlink.c
398 extern struct inode_operations nfs_symlink_inode_operations;
401 * linux/fs/nfs/sysctl.c
404 extern int nfs_register_sysctl(void);
405 extern void nfs_unregister_sysctl(void);
407 #define nfs_register_sysctl() 0
408 #define nfs_unregister_sysctl() do { } while(0)
412 * linux/fs/nfs/namespace.c
414 extern struct list_head nfs_automount_list;
415 extern struct inode_operations nfs_mountpoint_inode_operations;
416 extern struct inode_operations nfs_referral_inode_operations;
417 extern int nfs_mountpoint_expiry_timeout;
418 extern void nfs_release_automount_timer(void);
421 * linux/fs/nfs/unlink.c
423 extern int nfs_async_unlink(struct dentry *);
424 extern void nfs_complete_unlink(struct dentry *);
427 * linux/fs/nfs/write.c
429 extern int nfs_writepage(struct page *page, struct writeback_control *wbc);
430 extern int nfs_writepages(struct address_space *, struct writeback_control *);
431 extern int nfs_flush_incompatible(struct file *file, struct page *page);
432 extern int nfs_updatepage(struct file *, struct page *, unsigned int, unsigned int);
433 extern int nfs_writeback_done(struct rpc_task *, struct nfs_write_data *);
434 extern void nfs_writedata_release(void *);
436 #if defined(CONFIG_NFS_V3) || defined(CONFIG_NFS_V4)
437 struct nfs_write_data *nfs_commit_alloc(void);
438 void nfs_commit_free(struct nfs_write_data *p);
442 * Try to write back everything synchronously (but check the
445 extern int nfs_sync_inode_wait(struct inode *, unsigned long, unsigned int, int);
446 #if defined(CONFIG_NFS_V3) || defined(CONFIG_NFS_V4)
447 extern int nfs_commit_inode(struct inode *, int);
448 extern void nfs_commit_release(void *wdata);
451 nfs_commit_inode(struct inode *inode, int how)
458 nfs_have_writebacks(struct inode *inode)
460 return NFS_I(inode)->npages != 0;
464 nfs_wb_all(struct inode *inode)
466 int error = nfs_sync_inode_wait(inode, 0, 0, 0);
467 return (error < 0) ? error : 0;
471 * Write back all requests on one page - we do this before reading it.
473 static inline int nfs_wb_page_priority(struct inode *inode, struct page* page, int how)
475 int error = nfs_sync_inode_wait(inode, page->index, 1,
477 return (error < 0) ? error : 0;
480 static inline int nfs_wb_page(struct inode *inode, struct page* page)
482 return nfs_wb_page_priority(inode, page, 0);
486 * Allocate nfs_write_data structures
488 extern struct nfs_write_data *nfs_writedata_alloc(size_t len);
491 * linux/fs/nfs/read.c
493 extern int nfs_readpage(struct file *, struct page *);
494 extern int nfs_readpages(struct file *, struct address_space *,
495 struct list_head *, unsigned);
496 extern int nfs_readpage_result(struct rpc_task *, struct nfs_read_data *);
497 extern void nfs_readdata_release(void *data);
500 * Allocate nfs_read_data structures
502 extern struct nfs_read_data *nfs_readdata_alloc(size_t len);
505 * linux/fs/nfs3proc.c
507 #ifdef CONFIG_NFS_V3_ACL
508 extern struct posix_acl *nfs3_proc_getacl(struct inode *inode, int type);
509 extern int nfs3_proc_setacl(struct inode *inode, int type,
510 struct posix_acl *acl);
511 extern int nfs3_proc_set_default_acl(struct inode *dir, struct inode *inode,
513 extern void nfs3_forget_cached_acls(struct inode *inode);
515 static inline int nfs3_proc_set_default_acl(struct inode *dir,
522 static inline void nfs3_forget_cached_acls(struct inode *inode)
525 #endif /* CONFIG_NFS_V3_ACL */
528 * linux/fs/mount_clnt.c
529 * (Used only by nfsroot module)
531 extern int nfsroot_mount(struct sockaddr_in *, char *, struct nfs_fh *,
539 nfs_size_to_loff_t(__u64 size)
541 loff_t maxsz = (((loff_t) ULONG_MAX) << PAGE_CACHE_SHIFT) + PAGE_CACHE_SIZE - 1;
544 return (loff_t) size;
548 nfs_fileid_to_ino_t(u64 fileid)
550 ino_t ino = (ino_t) fileid;
551 if (sizeof(ino_t) < sizeof(u64))
552 ino ^= fileid >> (sizeof(u64)-sizeof(ino_t)) * 8;
558 extern void * nfs_root_data(void);
560 #define nfs_wait_event(clnt, wq, condition) \
563 if (clnt->cl_intr) { \
565 rpc_clnt_sigmask(clnt, &oldmask); \
566 __retval = wait_event_interruptible(wq, condition); \
567 rpc_clnt_sigunmask(clnt, &oldmask); \
569 wait_event(wq, condition); \
573 #define NFS_JUKEBOX_RETRY_TIME (5 * HZ)
575 #endif /* __KERNEL__ */
580 #define NFSDBG_VFS 0x0001
581 #define NFSDBG_DIRCACHE 0x0002
582 #define NFSDBG_LOOKUPCACHE 0x0004
583 #define NFSDBG_PAGECACHE 0x0008
584 #define NFSDBG_PROC 0x0010
585 #define NFSDBG_XDR 0x0020
586 #define NFSDBG_FILE 0x0040
587 #define NFSDBG_ROOT 0x0080
588 #define NFSDBG_CALLBACK 0x0100
589 #define NFSDBG_ALL 0xFFFF
594 # define ifdebug(fac) if (unlikely(nfs_debug & NFSDBG_##fac))
596 # define ifdebug(fac) if (0)
598 #endif /* __KERNEL */