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>
51 #include <linux/nfs_fs_sb.h>
53 #include <linux/rwsem.h>
54 #include <linux/mempool.h>
57 * These are the default flags for swap requests
59 #define NFS_RPC_SWAPFLAGS (RPC_TASK_SWAPPER|RPC_TASK_ROOTCREDS)
62 * NFSv3/v4 Access mode cache entry
64 struct nfs_access_entry {
65 struct rb_node rb_node;
67 unsigned long jiffies;
68 struct rpc_cred * cred;
73 struct nfs_open_context {
76 struct rpc_cred *cred;
77 struct nfs4_state *state;
82 #define NFS_CONTEXT_ERROR_WRITE (0)
85 struct list_head list;
93 struct nfs_delegation;
98 * nfs fs inode data in memory
102 * The 64bit 'inode number'
114 unsigned long flags; /* atomic bit ops */
115 unsigned long cache_validity; /* bit mask */
118 * read_cache_jiffies is when we started read-caching this inode.
119 * attrtimeo is for how long the cached information is assumed
120 * to be valid. A successful attribute revalidation doubles
121 * attrtimeo (up to acregmax/acdirmax), a failure resets it to
124 * We need to revalidate the cached attrs for this inode if
126 * jiffies - read_cache_jiffies > attrtimeo
128 unsigned long read_cache_jiffies;
129 unsigned long attrtimeo;
130 unsigned long attrtimeo_timestamp;
131 __u64 change_attr; /* v4 only */
133 unsigned long last_updated;
134 /* "Generation counter" for the attribute cache. This is
135 * bumped whenever we update the metadata on the
138 unsigned long cache_change_attribute;
140 * Counter indicating the number of outstanding requests that
141 * will cause a file data update.
143 atomic_t data_updates;
145 struct rb_root access_cache;
146 struct list_head access_cache_entry_lru;
147 struct list_head access_cache_inode_lru;
148 #ifdef CONFIG_NFS_V3_ACL
149 struct posix_acl *acl_access;
150 struct posix_acl *acl_default;
154 * This is the cookie verifier used for NFSv3 readdir
157 __be32 cookieverf[2];
160 * This is the list of dirty unwritten pages.
162 struct radix_tree_root nfs_page_tree;
164 unsigned long ncommit,
167 /* Open contexts for shared mmap writes */
168 struct list_head open_files;
171 struct nfs4_cached_acl *nfs4_acl;
173 struct list_head open_states;
174 struct nfs_delegation *delegation;
175 int delegation_state;
176 struct rw_semaphore rwsem;
177 #endif /* CONFIG_NFS_V4*/
178 struct inode vfs_inode;
182 * Cache validity bit flags
184 #define NFS_INO_INVALID_ATTR 0x0001 /* cached attrs are invalid */
185 #define NFS_INO_INVALID_DATA 0x0002 /* cached data is invalid */
186 #define NFS_INO_INVALID_ATIME 0x0004 /* cached atime is invalid */
187 #define NFS_INO_INVALID_ACCESS 0x0008 /* cached access cred invalid */
188 #define NFS_INO_INVALID_ACL 0x0010 /* cached acls are invalid */
189 #define NFS_INO_REVAL_PAGECACHE 0x0020 /* must revalidate pagecache */
190 #define NFS_INO_REVAL_FORCED 0x0040 /* force revalidation ignoring a delegation */
193 * Bit offsets in flags field
195 #define NFS_INO_REVALIDATING (0) /* revalidating attrs */
196 #define NFS_INO_ADVISE_RDPLUS (1) /* advise readdirplus */
197 #define NFS_INO_STALE (2) /* possible stale inode */
198 #define NFS_INO_ACL_LRU_SET (3) /* Inode is on the LRU list */
200 static inline struct nfs_inode *NFS_I(struct inode *inode)
202 return container_of(inode, struct nfs_inode, vfs_inode);
204 #define NFS_SB(s) ((struct nfs_server *)(s->s_fs_info))
206 #define NFS_FH(inode) (&NFS_I(inode)->fh)
207 #define NFS_SERVER(inode) (NFS_SB(inode->i_sb))
208 #define NFS_CLIENT(inode) (NFS_SERVER(inode)->client)
209 #define NFS_PROTO(inode) (NFS_SERVER(inode)->nfs_client->rpc_ops)
210 #define NFS_COOKIEVERF(inode) (NFS_I(inode)->cookieverf)
211 #define NFS_READTIME(inode) (NFS_I(inode)->read_cache_jiffies)
212 #define NFS_CHANGE_ATTR(inode) (NFS_I(inode)->change_attr)
213 #define NFS_ATTRTIMEO(inode) (NFS_I(inode)->attrtimeo)
214 #define NFS_MINATTRTIMEO(inode) \
215 (S_ISDIR(inode->i_mode)? NFS_SERVER(inode)->acdirmin \
216 : NFS_SERVER(inode)->acregmin)
217 #define NFS_MAXATTRTIMEO(inode) \
218 (S_ISDIR(inode->i_mode)? NFS_SERVER(inode)->acdirmax \
219 : NFS_SERVER(inode)->acregmax)
220 #define NFS_ATTRTIMEO_UPDATE(inode) (NFS_I(inode)->attrtimeo_timestamp)
222 #define NFS_FLAGS(inode) (NFS_I(inode)->flags)
223 #define NFS_STALE(inode) (test_bit(NFS_INO_STALE, &NFS_FLAGS(inode)))
225 #define NFS_FILEID(inode) (NFS_I(inode)->fileid)
227 static inline int nfs_caches_unstable(struct inode *inode)
229 return atomic_read(&NFS_I(inode)->data_updates) != 0;
232 static inline void nfs_mark_for_revalidate(struct inode *inode)
234 struct nfs_inode *nfsi = NFS_I(inode);
236 spin_lock(&inode->i_lock);
237 nfsi->cache_validity |= NFS_INO_INVALID_ATTR|NFS_INO_INVALID_ACCESS;
238 if (S_ISDIR(inode->i_mode))
239 nfsi->cache_validity |= NFS_INO_REVAL_PAGECACHE|NFS_INO_INVALID_DATA;
240 spin_unlock(&inode->i_lock);
243 static inline int nfs_server_capable(struct inode *inode, int cap)
245 return NFS_SERVER(inode)->caps & cap;
248 static inline int NFS_USE_READDIRPLUS(struct inode *inode)
250 return test_bit(NFS_INO_ADVISE_RDPLUS, &NFS_FLAGS(inode));
254 * nfs_save_change_attribute - Returns the inode attribute change cookie
255 * @dir - pointer to parent directory inode
256 * The "change attribute" is updated every time we finish an operation
257 * that will result in a metadata change on the server.
259 static inline unsigned long nfs_save_change_attribute(struct inode *dir)
261 return NFS_I(dir)->cache_change_attribute;
265 * nfs_verify_change_attribute - Detects NFS remote directory changes
266 * @dir - pointer to parent directory inode
267 * @chattr - previously saved change attribute
268 * Return "false" if the verifiers doesn't match the change attribute.
269 * This would usually indicate that the directory contents have changed on
270 * the server, and that any dentries need revalidating.
272 static inline int nfs_verify_change_attribute(struct inode *dir, unsigned long chattr)
274 return chattr == NFS_I(dir)->cache_change_attribute;
278 * linux/fs/nfs/inode.c
280 extern int nfs_sync_mapping(struct address_space *mapping);
281 extern void nfs_zap_mapping(struct inode *inode, struct address_space *mapping);
282 extern void nfs_zap_caches(struct inode *);
283 extern void nfs_invalidate_atime(struct inode *);
284 extern struct inode *nfs_fhget(struct super_block *, struct nfs_fh *,
286 extern int nfs_refresh_inode(struct inode *, struct nfs_fattr *);
287 extern int nfs_post_op_update_inode(struct inode *inode, struct nfs_fattr *fattr);
288 extern int nfs_post_op_update_inode_force_wcc(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_open(struct inode *, struct file *);
292 extern int nfs_release(struct inode *, struct file *);
293 extern int nfs_attribute_timeout(struct inode *inode);
294 extern int nfs_revalidate_inode(struct nfs_server *server, struct inode *inode);
295 extern int __nfs_revalidate_inode(struct nfs_server *, struct inode *);
296 extern int nfs_revalidate_mapping(struct inode *inode, struct address_space *mapping);
297 extern int nfs_revalidate_mapping_nolock(struct inode *inode, struct address_space *mapping);
298 extern int nfs_setattr(struct dentry *, struct iattr *);
299 extern void nfs_setattr_update_inode(struct inode *inode, struct iattr *attr);
300 extern void nfs_begin_attr_update(struct inode *);
301 extern void nfs_end_attr_update(struct inode *);
302 extern void nfs_begin_data_update(struct inode *);
303 extern void nfs_end_data_update(struct inode *);
304 extern struct nfs_open_context *get_nfs_open_context(struct nfs_open_context *ctx);
305 extern void put_nfs_open_context(struct nfs_open_context *ctx);
306 extern struct nfs_open_context *nfs_find_open_context(struct inode *inode, struct rpc_cred *cred, int mode);
308 /* linux/net/ipv4/ipconfig.c: trims ip addr off front of name, too. */
309 extern __be32 root_nfs_parse_addr(char *name); /*__init*/
311 static inline void nfs_fattr_init(struct nfs_fattr *fattr)
314 fattr->time_start = jiffies;
318 * linux/fs/nfs/file.c
320 extern const struct inode_operations nfs_file_inode_operations;
322 extern const struct inode_operations nfs3_file_inode_operations;
323 #endif /* CONFIG_NFS_V3 */
324 extern const struct file_operations nfs_file_operations;
325 extern const struct address_space_operations nfs_file_aops;
327 static inline struct nfs_open_context *nfs_file_open_context(struct file *filp)
329 return filp->private_data;
332 static inline struct rpc_cred *nfs_file_cred(struct file *file)
335 return nfs_file_open_context(file)->cred;
340 * linux/fs/nfs/xattr.c
342 #ifdef CONFIG_NFS_V3_ACL
343 extern ssize_t nfs3_listxattr(struct dentry *, char *, size_t);
344 extern ssize_t nfs3_getxattr(struct dentry *, const char *, void *, size_t);
345 extern int nfs3_setxattr(struct dentry *, const char *,
346 const void *, size_t, int);
347 extern int nfs3_removexattr (struct dentry *, const char *name);
349 # define nfs3_listxattr NULL
350 # define nfs3_getxattr NULL
351 # define nfs3_setxattr NULL
352 # define nfs3_removexattr NULL
356 * linux/fs/nfs/direct.c
358 extern ssize_t nfs_direct_IO(int, struct kiocb *, const struct iovec *, loff_t,
360 extern ssize_t nfs_file_direct_read(struct kiocb *iocb,
361 const struct iovec *iov, unsigned long nr_segs,
363 extern ssize_t nfs_file_direct_write(struct kiocb *iocb,
364 const struct iovec *iov, unsigned long nr_segs,
370 extern const struct inode_operations nfs_dir_inode_operations;
372 extern const struct inode_operations nfs3_dir_inode_operations;
373 #endif /* CONFIG_NFS_V3 */
374 extern const struct file_operations nfs_dir_operations;
375 extern struct dentry_operations nfs_dentry_operations;
377 extern int nfs_instantiate(struct dentry *dentry, struct nfs_fh *fh, struct nfs_fattr *fattr);
378 extern int nfs_may_open(struct inode *inode, struct rpc_cred *cred, int openflags);
379 extern void nfs_access_zap_cache(struct inode *inode);
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 inode *dir, struct dentry *dentry);
410 extern void nfs_complete_unlink(struct dentry *dentry, struct inode *);
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 *);
424 * Try to write back everything synchronously (but check the
427 extern long nfs_sync_mapping_wait(struct address_space *, struct writeback_control *, int);
428 extern int nfs_wb_all(struct inode *inode);
429 extern int nfs_wb_nocommit(struct inode *inode);
430 extern int nfs_wb_page(struct inode *inode, struct page* page);
431 extern int nfs_wb_page_priority(struct inode *inode, struct page* page, int how);
432 extern int nfs_wb_page_cancel(struct inode *inode, struct page* page);
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
497 extern int nfs_mount(struct sockaddr *, size_t, char *, char *,
498 int, int, struct nfs_fh *);
504 static inline loff_t nfs_size_to_loff_t(__u64 size)
506 if (size > (__u64) OFFSET_MAX - 1)
507 return OFFSET_MAX - 1;
508 return (loff_t) size;
512 nfs_fileid_to_ino_t(u64 fileid)
514 ino_t ino = (ino_t) fileid;
515 if (sizeof(ino_t) < sizeof(u64))
516 ino ^= fileid >> (sizeof(u64)-sizeof(ino_t)) * 8;
522 extern void * nfs_root_data(void);
524 #define nfs_wait_event(clnt, wq, condition) \
527 if (clnt->cl_intr) { \
529 rpc_clnt_sigmask(clnt, &oldmask); \
530 __retval = wait_event_interruptible(wq, condition); \
531 rpc_clnt_sigunmask(clnt, &oldmask); \
533 wait_event(wq, condition); \
537 #define NFS_JUKEBOX_RETRY_TIME (5 * HZ)
539 #endif /* __KERNEL__ */
544 #define NFSDBG_VFS 0x0001
545 #define NFSDBG_DIRCACHE 0x0002
546 #define NFSDBG_LOOKUPCACHE 0x0004
547 #define NFSDBG_PAGECACHE 0x0008
548 #define NFSDBG_PROC 0x0010
549 #define NFSDBG_XDR 0x0020
550 #define NFSDBG_FILE 0x0040
551 #define NFSDBG_ROOT 0x0080
552 #define NFSDBG_CALLBACK 0x0100
553 #define NFSDBG_CLIENT 0x0200
554 #define NFSDBG_MOUNT 0x0400
555 #define NFSDBG_ALL 0xFFFF
560 * Enable debugging support for nfs client.
561 * Requires RPC_DEBUG.
569 # define ifdebug(fac) if (unlikely(nfs_debug & NFSDBG_##fac))
571 # define ifdebug(fac) if (0)
573 #endif /* __KERNEL */