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() */
34 #include <linux/namei.h>
35 #include <linux/pagemap.h>
36 #include <linux/rbtree.h>
37 #include <linux/rwsem.h>
38 #include <linux/wait.h>
40 #include <linux/sunrpc/debug.h>
41 #include <linux/sunrpc/auth.h>
42 #include <linux/sunrpc/clnt.h>
44 #include <linux/nfs.h>
45 #include <linux/nfs2.h>
46 #include <linux/nfs3.h>
47 #include <linux/nfs4.h>
48 #include <linux/nfs_xdr.h>
50 #include <linux/nfs_fs_sb.h>
52 #include <linux/rwsem.h>
53 #include <linux/mempool.h>
56 * These are the default flags for swap requests
58 #define NFS_RPC_SWAPFLAGS (RPC_TASK_SWAPPER|RPC_TASK_ROOTCREDS)
61 * NFSv3/v4 Access mode cache entry
63 struct nfs_access_entry {
64 struct rb_node rb_node;
66 unsigned long jiffies;
67 struct rpc_cred * cred;
72 struct nfs_open_context {
75 struct rpc_cred *cred;
76 struct nfs4_state *state;
81 struct list_head list;
89 struct nfs_delegation;
94 * nfs fs inode data in memory
98 * The 64bit 'inode number'
110 unsigned long flags; /* atomic bit ops */
111 unsigned long cache_validity; /* bit mask */
114 * read_cache_jiffies is when we started read-caching this inode.
115 * attrtimeo is for how long the cached information is assumed
116 * to be valid. A successful attribute revalidation doubles
117 * attrtimeo (up to acregmax/acdirmax), a failure resets it to
120 * We need to revalidate the cached attrs for this inode if
122 * jiffies - read_cache_jiffies > attrtimeo
124 unsigned long read_cache_jiffies;
125 unsigned long attrtimeo;
126 unsigned long attrtimeo_timestamp;
127 __u64 change_attr; /* v4 only */
129 unsigned long last_updated;
130 /* "Generation counter" for the attribute cache. This is
131 * bumped whenever we update the metadata on the
134 unsigned long cache_change_attribute;
136 * Counter indicating the number of outstanding requests that
137 * will cause a file data update.
139 atomic_t data_updates;
141 struct rb_root access_cache;
142 struct list_head access_cache_entry_lru;
143 struct list_head access_cache_inode_lru;
144 #ifdef CONFIG_NFS_V3_ACL
145 struct posix_acl *acl_access;
146 struct posix_acl *acl_default;
150 * This is the cookie verifier used for NFSv3 readdir
153 __be32 cookieverf[2];
156 * This is the list of dirty unwritten pages.
159 struct radix_tree_root nfs_page_tree;
161 unsigned long ncommit,
164 /* Open contexts for shared mmap writes */
165 struct list_head open_files;
168 struct nfs4_cached_acl *nfs4_acl;
170 struct list_head open_states;
171 struct nfs_delegation *delegation;
172 int delegation_state;
173 struct rw_semaphore rwsem;
174 #endif /* CONFIG_NFS_V4*/
175 struct inode vfs_inode;
179 * Cache validity bit flags
181 #define NFS_INO_INVALID_ATTR 0x0001 /* cached attrs are invalid */
182 #define NFS_INO_INVALID_DATA 0x0002 /* cached data is invalid */
183 #define NFS_INO_INVALID_ATIME 0x0004 /* cached atime is invalid */
184 #define NFS_INO_INVALID_ACCESS 0x0008 /* cached access cred invalid */
185 #define NFS_INO_INVALID_ACL 0x0010 /* cached acls are invalid */
186 #define NFS_INO_REVAL_PAGECACHE 0x0020 /* must revalidate pagecache */
189 * Bit offsets in flags field
191 #define NFS_INO_REVALIDATING (0) /* revalidating attrs */
192 #define NFS_INO_ADVISE_RDPLUS (1) /* advise readdirplus */
193 #define NFS_INO_STALE (2) /* possible stale inode */
194 #define NFS_INO_ACL_LRU_SET (3) /* Inode is on the LRU list */
196 static inline struct nfs_inode *NFS_I(struct inode *inode)
198 return container_of(inode, struct nfs_inode, vfs_inode);
200 #define NFS_SB(s) ((struct nfs_server *)(s->s_fs_info))
202 #define NFS_FH(inode) (&NFS_I(inode)->fh)
203 #define NFS_SERVER(inode) (NFS_SB(inode->i_sb))
204 #define NFS_CLIENT(inode) (NFS_SERVER(inode)->client)
205 #define NFS_PROTO(inode) (NFS_SERVER(inode)->nfs_client->rpc_ops)
206 #define NFS_COOKIEVERF(inode) (NFS_I(inode)->cookieverf)
207 #define NFS_READTIME(inode) (NFS_I(inode)->read_cache_jiffies)
208 #define NFS_CHANGE_ATTR(inode) (NFS_I(inode)->change_attr)
209 #define NFS_ATTRTIMEO(inode) (NFS_I(inode)->attrtimeo)
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)
216 #define NFS_ATTRTIMEO_UPDATE(inode) (NFS_I(inode)->attrtimeo_timestamp)
218 #define NFS_FLAGS(inode) (NFS_I(inode)->flags)
219 #define NFS_STALE(inode) (test_bit(NFS_INO_STALE, &NFS_FLAGS(inode)))
221 #define NFS_FILEID(inode) (NFS_I(inode)->fileid)
223 static inline int nfs_caches_unstable(struct inode *inode)
225 return atomic_read(&NFS_I(inode)->data_updates) != 0;
228 static inline void nfs_mark_for_revalidate(struct inode *inode)
230 struct nfs_inode *nfsi = NFS_I(inode);
232 spin_lock(&inode->i_lock);
233 nfsi->cache_validity |= NFS_INO_INVALID_ATTR|NFS_INO_INVALID_ACCESS;
234 if (S_ISDIR(inode->i_mode))
235 nfsi->cache_validity |= NFS_INO_REVAL_PAGECACHE|NFS_INO_INVALID_DATA;
236 spin_unlock(&inode->i_lock);
239 static inline void NFS_CACHEINV(struct inode *inode)
241 if (!nfs_caches_unstable(inode))
242 nfs_mark_for_revalidate(inode);
245 static inline int nfs_server_capable(struct inode *inode, int cap)
247 return NFS_SERVER(inode)->caps & cap;
250 static inline int NFS_USE_READDIRPLUS(struct inode *inode)
252 return test_bit(NFS_INO_ADVISE_RDPLUS, &NFS_FLAGS(inode));
256 * nfs_save_change_attribute - Returns the inode attribute change cookie
257 * @inode - pointer to inode
258 * The "change attribute" is updated every time we finish an operation
259 * that will result in a metadata change on the server.
261 static inline long nfs_save_change_attribute(struct inode *inode)
263 return NFS_I(inode)->cache_change_attribute;
267 * nfs_verify_change_attribute - Detects NFS inode cache updates
268 * @inode - pointer to inode
269 * @chattr - previously saved change attribute
270 * Return "false" if metadata has been updated (or is in the process of
271 * being updated) since the change attribute was saved.
273 static inline int nfs_verify_change_attribute(struct inode *inode, unsigned long chattr)
275 return !nfs_caches_unstable(inode)
276 && time_after_eq(chattr, NFS_I(inode)->cache_change_attribute);
280 * linux/fs/nfs/inode.c
282 extern int nfs_sync_mapping(struct address_space *mapping);
283 extern void nfs_zap_mapping(struct inode *inode, struct address_space *mapping);
284 extern void nfs_zap_caches(struct inode *);
285 extern struct inode *nfs_fhget(struct super_block *, struct nfs_fh *,
287 extern int nfs_refresh_inode(struct inode *, struct nfs_fattr *);
288 extern int nfs_post_op_update_inode(struct inode *inode, struct nfs_fattr *fattr);
289 extern int nfs_getattr(struct vfsmount *, struct dentry *, struct kstat *);
290 extern int nfs_permission(struct inode *, int, struct nameidata *);
291 extern int nfs_access_get_cached(struct inode *, struct rpc_cred *, struct nfs_access_entry *);
292 extern void nfs_access_add_cache(struct inode *, struct nfs_access_entry *);
293 extern void nfs_access_zap_cache(struct inode *inode);
294 extern int nfs_open(struct inode *, struct file *);
295 extern int nfs_release(struct inode *, struct file *);
296 extern int nfs_attribute_timeout(struct inode *inode);
297 extern int nfs_revalidate_inode(struct nfs_server *server, struct inode *inode);
298 extern int __nfs_revalidate_inode(struct nfs_server *, struct inode *);
299 extern int nfs_revalidate_mapping(struct inode *inode, struct address_space *mapping);
300 extern int nfs_revalidate_mapping_nolock(struct inode *inode, struct address_space *mapping);
301 extern int nfs_setattr(struct dentry *, struct iattr *);
302 extern void nfs_setattr_update_inode(struct inode *inode, struct iattr *attr);
303 extern void nfs_begin_attr_update(struct inode *);
304 extern void nfs_end_attr_update(struct inode *);
305 extern void nfs_begin_data_update(struct inode *);
306 extern void nfs_end_data_update(struct inode *);
307 extern struct nfs_open_context *get_nfs_open_context(struct nfs_open_context *ctx);
308 extern void put_nfs_open_context(struct nfs_open_context *ctx);
309 extern struct nfs_open_context *nfs_find_open_context(struct inode *inode, struct rpc_cred *cred, int mode);
311 /* linux/net/ipv4/ipconfig.c: trims ip addr off front of name, too. */
312 extern __be32 root_nfs_parse_addr(char *name); /*__init*/
314 static inline void nfs_fattr_init(struct nfs_fattr *fattr)
317 fattr->time_start = jiffies;
321 * linux/fs/nfs/file.c
323 extern const struct inode_operations nfs_file_inode_operations;
325 extern const struct inode_operations nfs3_file_inode_operations;
326 #endif /* CONFIG_NFS_V3 */
327 extern const struct file_operations nfs_file_operations;
328 extern const struct address_space_operations nfs_file_aops;
330 static inline struct rpc_cred *nfs_file_cred(struct file *file)
333 struct nfs_open_context *ctx;
335 ctx = (struct nfs_open_context*)file->private_data;
342 * linux/fs/nfs/xattr.c
344 #ifdef CONFIG_NFS_V3_ACL
345 extern ssize_t nfs3_listxattr(struct dentry *, char *, size_t);
346 extern ssize_t nfs3_getxattr(struct dentry *, const char *, void *, size_t);
347 extern int nfs3_setxattr(struct dentry *, const char *,
348 const void *, size_t, int);
349 extern int nfs3_removexattr (struct dentry *, const char *name);
351 # define nfs3_listxattr NULL
352 # define nfs3_getxattr NULL
353 # define nfs3_setxattr NULL
354 # define nfs3_removexattr NULL
358 * linux/fs/nfs/direct.c
360 extern ssize_t nfs_direct_IO(int, struct kiocb *, const struct iovec *, loff_t,
362 extern ssize_t nfs_file_direct_read(struct kiocb *iocb,
363 const struct iovec *iov, unsigned long nr_segs,
365 extern ssize_t nfs_file_direct_write(struct kiocb *iocb,
366 const struct iovec *iov, unsigned long nr_segs,
372 extern const struct inode_operations nfs_dir_inode_operations;
374 extern const struct inode_operations nfs3_dir_inode_operations;
375 #endif /* CONFIG_NFS_V3 */
376 extern const struct file_operations nfs_dir_operations;
377 extern struct dentry_operations nfs_dentry_operations;
379 extern int nfs_instantiate(struct dentry *dentry, struct nfs_fh *fh, struct nfs_fattr *fattr);
382 * linux/fs/nfs/symlink.c
384 extern const struct inode_operations nfs_symlink_inode_operations;
387 * linux/fs/nfs/sysctl.c
390 extern int nfs_register_sysctl(void);
391 extern void nfs_unregister_sysctl(void);
393 #define nfs_register_sysctl() 0
394 #define nfs_unregister_sysctl() do { } while(0)
398 * linux/fs/nfs/namespace.c
400 extern struct list_head nfs_automount_list;
401 extern const struct inode_operations nfs_mountpoint_inode_operations;
402 extern const struct inode_operations nfs_referral_inode_operations;
403 extern int nfs_mountpoint_expiry_timeout;
404 extern void nfs_release_automount_timer(void);
407 * linux/fs/nfs/unlink.c
409 extern int nfs_async_unlink(struct dentry *);
410 extern void nfs_complete_unlink(struct dentry *);
413 * linux/fs/nfs/write.c
415 extern int nfs_congestion_kb;
416 extern int nfs_writepage(struct page *page, struct writeback_control *wbc);
417 extern int nfs_writepages(struct address_space *, struct writeback_control *);
418 extern int nfs_flush_incompatible(struct file *file, struct page *page);
419 extern int nfs_updatepage(struct file *, struct page *, unsigned int, unsigned int);
420 extern int nfs_writeback_done(struct rpc_task *, struct nfs_write_data *);
421 extern void nfs_writedata_release(void *);
422 extern int nfs_set_page_dirty(struct page *);
425 * Try to write back everything synchronously (but check the
428 extern long nfs_sync_mapping_wait(struct address_space *, struct writeback_control *, int);
429 extern int nfs_sync_mapping_range(struct address_space *, loff_t, loff_t, int);
430 extern int nfs_wb_all(struct inode *inode);
431 extern int nfs_wb_page(struct inode *inode, struct page* page);
432 extern int nfs_wb_page_priority(struct inode *inode, struct page* page, int how);
433 #if defined(CONFIG_NFS_V3) || defined(CONFIG_NFS_V4)
434 extern int nfs_commit_inode(struct inode *, int);
435 extern struct nfs_write_data *nfs_commit_alloc(void);
436 extern void nfs_commit_free(struct nfs_write_data *wdata);
437 extern void nfs_commit_release(void *wdata);
440 nfs_commit_inode(struct inode *inode, int how)
447 nfs_have_writebacks(struct inode *inode)
449 return NFS_I(inode)->npages != 0;
453 * Allocate nfs_write_data structures
455 extern struct nfs_write_data *nfs_writedata_alloc(unsigned int npages);
458 * linux/fs/nfs/read.c
460 extern int nfs_readpage(struct file *, struct page *);
461 extern int nfs_readpages(struct file *, struct address_space *,
462 struct list_head *, unsigned);
463 extern int nfs_readpage_result(struct rpc_task *, struct nfs_read_data *);
464 extern void nfs_readdata_release(void *data);
467 * Allocate nfs_read_data structures
469 extern struct nfs_read_data *nfs_readdata_alloc(unsigned int npages);
472 * linux/fs/nfs3proc.c
474 #ifdef CONFIG_NFS_V3_ACL
475 extern struct posix_acl *nfs3_proc_getacl(struct inode *inode, int type);
476 extern int nfs3_proc_setacl(struct inode *inode, int type,
477 struct posix_acl *acl);
478 extern int nfs3_proc_set_default_acl(struct inode *dir, struct inode *inode,
480 extern void nfs3_forget_cached_acls(struct inode *inode);
482 static inline int nfs3_proc_set_default_acl(struct inode *dir,
489 static inline void nfs3_forget_cached_acls(struct inode *inode)
492 #endif /* CONFIG_NFS_V3_ACL */
495 * linux/fs/mount_clnt.c
496 * (Used only by nfsroot module)
498 extern int nfsroot_mount(struct sockaddr_in *, char *, struct nfs_fh *,
506 nfs_size_to_loff_t(__u64 size)
508 loff_t maxsz = (((loff_t) ULONG_MAX) << PAGE_CACHE_SHIFT) + PAGE_CACHE_SIZE - 1;
511 return (loff_t) size;
515 nfs_fileid_to_ino_t(u64 fileid)
517 ino_t ino = (ino_t) fileid;
518 if (sizeof(ino_t) < sizeof(u64))
519 ino ^= fileid >> (sizeof(u64)-sizeof(ino_t)) * 8;
525 extern void * nfs_root_data(void);
527 #define nfs_wait_event(clnt, wq, condition) \
530 if (clnt->cl_intr) { \
532 rpc_clnt_sigmask(clnt, &oldmask); \
533 __retval = wait_event_interruptible(wq, condition); \
534 rpc_clnt_sigunmask(clnt, &oldmask); \
536 wait_event(wq, condition); \
540 #define NFS_JUKEBOX_RETRY_TIME (5 * HZ)
542 #endif /* __KERNEL__ */
547 #define NFSDBG_VFS 0x0001
548 #define NFSDBG_DIRCACHE 0x0002
549 #define NFSDBG_LOOKUPCACHE 0x0004
550 #define NFSDBG_PAGECACHE 0x0008
551 #define NFSDBG_PROC 0x0010
552 #define NFSDBG_XDR 0x0020
553 #define NFSDBG_FILE 0x0040
554 #define NFSDBG_ROOT 0x0080
555 #define NFSDBG_CALLBACK 0x0100
556 #define NFSDBG_CLIENT 0x0200
557 #define NFSDBG_ALL 0xFFFF
562 * Enable debugging support for nfs client.
563 * Requires RPC_DEBUG.
571 # define ifdebug(fac) if (unlikely(nfs_debug & NFSDBG_##fac))
573 # define ifdebug(fac) if (0)
575 #endif /* __KERNEL */