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/rwsem.h>
46 #include <linux/wait.h>
48 #include <linux/sunrpc/debug.h>
49 #include <linux/sunrpc/auth.h>
50 #include <linux/sunrpc/clnt.h>
52 #include <linux/nfs.h>
53 #include <linux/nfs2.h>
54 #include <linux/nfs3.h>
55 #include <linux/nfs4.h>
56 #include <linux/nfs_xdr.h>
58 #include <linux/nfs_fs_sb.h>
60 #include <linux/rwsem.h>
61 #include <linux/mempool.h>
62 #include <linux/fscache.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 unsigned long jiffies;
74 struct rpc_cred * cred;
79 struct nfs_open_context {
81 struct vfsmount *vfsmnt;
82 struct dentry *dentry;
83 struct rpc_cred *cred;
84 struct nfs4_state *state;
89 struct list_head list;
97 struct nfs_delegation;
102 * nfs fs inode data in memory
106 * The 64bit 'inode number'
118 unsigned long flags; /* atomic bit ops */
119 unsigned long cache_validity; /* bit mask */
122 * read_cache_jiffies is when we started read-caching this inode.
123 * attrtimeo is for how long the cached information is assumed
124 * to be valid. A successful attribute revalidation doubles
125 * attrtimeo (up to acregmax/acdirmax), a failure resets it to
128 * We need to revalidate the cached attrs for this inode if
130 * jiffies - read_cache_jiffies > attrtimeo
132 unsigned long read_cache_jiffies;
133 unsigned long attrtimeo;
134 unsigned long attrtimeo_timestamp;
135 __u64 change_attr; /* v4 only */
137 unsigned long last_updated;
138 /* "Generation counter" for the attribute cache. This is
139 * bumped whenever we update the metadata on the
142 unsigned long cache_change_attribute;
144 * Counter indicating the number of outstanding requests that
145 * will cause a file data update.
147 atomic_t data_updates;
149 struct nfs_access_entry cache_access;
150 #ifdef CONFIG_NFS_V3_ACL
151 struct posix_acl *acl_access;
152 struct posix_acl *acl_default;
156 * This is the cookie verifier used for NFSv3 readdir
162 * This is the list of dirty unwritten pages.
165 struct list_head dirty;
166 struct list_head commit;
167 struct radix_tree_root nfs_page_tree;
173 /* Open contexts for shared mmap writes */
174 struct list_head open_files;
177 struct nfs4_cached_acl *nfs4_acl;
179 struct list_head open_states;
180 struct nfs_delegation *delegation;
181 int delegation_state;
182 struct rw_semaphore rwsem;
183 #endif /* CONFIG_NFS_V4*/
184 #ifdef CONFIG_NFS_FSCACHE
185 struct fscache_cookie *fscache;
187 struct inode vfs_inode;
191 * Cache validity bit flags
193 #define NFS_INO_INVALID_ATTR 0x0001 /* cached attrs are invalid */
194 #define NFS_INO_INVALID_DATA 0x0002 /* cached data is invalid */
195 #define NFS_INO_INVALID_ATIME 0x0004 /* cached atime is invalid */
196 #define NFS_INO_INVALID_ACCESS 0x0008 /* cached access cred invalid */
197 #define NFS_INO_INVALID_ACL 0x0010 /* cached acls are invalid */
198 #define NFS_INO_REVAL_PAGECACHE 0x0020 /* must revalidate pagecache */
201 * Bit offsets in flags field
203 #define NFS_INO_REVALIDATING (0) /* revalidating attrs */
204 #define NFS_INO_ADVISE_RDPLUS (1) /* advise readdirplus */
205 #define NFS_INO_STALE (2) /* possible stale inode */
207 static inline struct nfs_inode *NFS_I(struct inode *inode)
209 return container_of(inode, struct nfs_inode, vfs_inode);
211 #define NFS_SB(s) ((struct nfs_server *)(s->s_fs_info))
213 #define NFS_FH(inode) (&NFS_I(inode)->fh)
214 #define NFS_SERVER(inode) (NFS_SB(inode->i_sb))
215 #define NFS_CLIENT(inode) (NFS_SERVER(inode)->client)
216 #define NFS_PROTO(inode) (NFS_SERVER(inode)->nfs_client->rpc_ops)
217 #define NFS_ADDR(inode) (RPC_PEERADDR(NFS_CLIENT(inode)))
218 #define NFS_COOKIEVERF(inode) (NFS_I(inode)->cookieverf)
219 #define NFS_READTIME(inode) (NFS_I(inode)->read_cache_jiffies)
220 #define NFS_CHANGE_ATTR(inode) (NFS_I(inode)->change_attr)
221 #define NFS_ATTRTIMEO(inode) (NFS_I(inode)->attrtimeo)
222 #define NFS_MINATTRTIMEO(inode) \
223 (S_ISDIR(inode->i_mode)? NFS_SERVER(inode)->acdirmin \
224 : NFS_SERVER(inode)->acregmin)
225 #define NFS_MAXATTRTIMEO(inode) \
226 (S_ISDIR(inode->i_mode)? NFS_SERVER(inode)->acdirmax \
227 : NFS_SERVER(inode)->acregmax)
228 #define NFS_ATTRTIMEO_UPDATE(inode) (NFS_I(inode)->attrtimeo_timestamp)
230 #define NFS_FLAGS(inode) (NFS_I(inode)->flags)
231 #define NFS_STALE(inode) (test_bit(NFS_INO_STALE, &NFS_FLAGS(inode)))
233 #define NFS_FILEID(inode) (NFS_I(inode)->fileid)
235 static inline int nfs_caches_unstable(struct inode *inode)
237 return atomic_read(&NFS_I(inode)->data_updates) != 0;
240 static inline void nfs_mark_for_revalidate(struct inode *inode)
242 struct nfs_inode *nfsi = NFS_I(inode);
244 spin_lock(&inode->i_lock);
245 nfsi->cache_validity |= NFS_INO_INVALID_ATTR|NFS_INO_INVALID_ACCESS;
246 if (S_ISDIR(inode->i_mode))
247 nfsi->cache_validity |= NFS_INO_REVAL_PAGECACHE|NFS_INO_INVALID_DATA;
248 spin_unlock(&inode->i_lock);
251 static inline void NFS_CACHEINV(struct inode *inode)
253 if (!nfs_caches_unstable(inode))
254 nfs_mark_for_revalidate(inode);
257 static inline int nfs_server_capable(struct inode *inode, int cap)
259 return NFS_SERVER(inode)->caps & cap;
262 static inline int NFS_USE_READDIRPLUS(struct inode *inode)
264 return test_bit(NFS_INO_ADVISE_RDPLUS, &NFS_FLAGS(inode));
268 * nfs_save_change_attribute - Returns the inode attribute change cookie
269 * @inode - pointer to inode
270 * The "change attribute" is updated every time we finish an operation
271 * that will result in a metadata change on the server.
273 static inline long nfs_save_change_attribute(struct inode *inode)
275 return NFS_I(inode)->cache_change_attribute;
279 * nfs_verify_change_attribute - Detects NFS inode cache updates
280 * @inode - pointer to inode
281 * @chattr - previously saved change attribute
282 * Return "false" if metadata has been updated (or is in the process of
283 * being updated) since the change attribute was saved.
285 static inline int nfs_verify_change_attribute(struct inode *inode, unsigned long chattr)
287 return !nfs_caches_unstable(inode)
288 && time_after_eq(chattr, NFS_I(inode)->cache_change_attribute);
292 * linux/fs/nfs/inode.c
294 extern int nfs_sync_mapping(struct address_space *mapping);
295 extern void nfs_zap_caches(struct inode *);
296 extern struct inode *nfs_fhget(struct super_block *, struct nfs_fh *,
298 extern int nfs_refresh_inode(struct inode *, struct nfs_fattr *);
299 extern int nfs_post_op_update_inode(struct inode *inode, struct nfs_fattr *fattr);
300 extern int nfs_getattr(struct vfsmount *, struct dentry *, struct kstat *);
301 extern int nfs_permission(struct inode *, int, struct nameidata *);
302 extern int nfs_access_get_cached(struct inode *, struct rpc_cred *, struct nfs_access_entry *);
303 extern void nfs_access_add_cache(struct inode *, struct nfs_access_entry *);
304 extern int nfs_open(struct inode *, struct file *);
305 extern int nfs_release(struct inode *, struct file *);
306 extern int nfs_attribute_timeout(struct inode *inode);
307 extern int nfs_revalidate_inode(struct nfs_server *server, struct inode *inode);
308 extern int __nfs_revalidate_inode(struct nfs_server *, struct inode *);
309 extern int nfs_revalidate_mapping(struct inode *inode, struct address_space *mapping);
310 extern int nfs_setattr(struct dentry *, struct iattr *);
311 extern void nfs_setattr_update_inode(struct inode *inode, struct iattr *attr);
312 extern void nfs_begin_attr_update(struct inode *);
313 extern void nfs_end_attr_update(struct inode *);
314 extern void nfs_begin_data_update(struct inode *);
315 extern void nfs_end_data_update(struct inode *);
316 extern struct nfs_open_context *get_nfs_open_context(struct nfs_open_context *ctx);
317 extern void put_nfs_open_context(struct nfs_open_context *ctx);
318 extern struct nfs_open_context *nfs_find_open_context(struct inode *inode, struct rpc_cred *cred, int mode);
319 extern struct vfsmount *nfs_do_submount(const struct vfsmount *mnt_parent,
320 const struct dentry *dentry,
322 struct nfs_fattr *fattr);
324 /* linux/net/ipv4/ipconfig.c: trims ip addr off front of name, too. */
325 extern u32 root_nfs_parse_addr(char *name); /*__init*/
327 static inline void nfs_fattr_init(struct nfs_fattr *fattr)
330 fattr->time_start = jiffies;
334 * linux/fs/nfs/file.c
336 extern struct inode_operations nfs_file_inode_operations;
338 extern struct inode_operations nfs3_file_inode_operations;
339 #endif /* CONFIG_NFS_V3 */
340 extern const struct file_operations nfs_file_operations;
341 extern const struct address_space_operations nfs_file_aops;
343 static inline struct rpc_cred *nfs_file_cred(struct file *file)
346 struct nfs_open_context *ctx;
348 ctx = (struct nfs_open_context*)file->private_data;
355 * linux/fs/nfs/xattr.c
357 #ifdef CONFIG_NFS_V3_ACL
358 extern ssize_t nfs3_listxattr(struct dentry *, char *, size_t);
359 extern ssize_t nfs3_getxattr(struct dentry *, const char *, void *, size_t);
360 extern int nfs3_setxattr(struct dentry *, const char *,
361 const void *, size_t, int);
362 extern int nfs3_removexattr (struct dentry *, const char *name);
364 # define nfs3_listxattr NULL
365 # define nfs3_getxattr NULL
366 # define nfs3_setxattr NULL
367 # define nfs3_removexattr NULL
371 * linux/fs/nfs/direct.c
373 extern ssize_t nfs_direct_IO(int, struct kiocb *, const struct iovec *, loff_t,
375 extern ssize_t nfs_file_direct_read(struct kiocb *iocb, char __user *buf,
376 size_t count, loff_t pos);
377 extern ssize_t nfs_file_direct_write(struct kiocb *iocb, const char __user *buf,
378 size_t count, loff_t pos);
383 extern struct inode_operations nfs_dir_inode_operations;
385 extern struct inode_operations nfs3_dir_inode_operations;
386 #endif /* CONFIG_NFS_V3 */
387 extern const struct file_operations nfs_dir_operations;
388 extern struct dentry_operations nfs_dentry_operations;
390 extern int nfs_instantiate(struct dentry *dentry, struct nfs_fh *fh, struct nfs_fattr *fattr);
393 * linux/fs/nfs/symlink.c
395 extern struct inode_operations nfs_symlink_inode_operations;
398 * linux/fs/nfs/sysctl.c
401 extern int nfs_register_sysctl(void);
402 extern void nfs_unregister_sysctl(void);
404 #define nfs_register_sysctl() 0
405 #define nfs_unregister_sysctl() do { } while(0)
409 * linux/fs/nfs/namespace.c
411 extern struct list_head nfs_automount_list;
412 extern struct inode_operations nfs_mountpoint_inode_operations;
413 extern struct inode_operations nfs_referral_inode_operations;
414 extern int nfs_mountpoint_expiry_timeout;
415 extern void nfs_release_automount_timer(void);
418 * linux/fs/nfs/unlink.c
420 extern int nfs_async_unlink(struct dentry *);
421 extern void nfs_complete_unlink(struct dentry *);
424 * linux/fs/nfs/write.c
426 extern int nfs_writepage(struct page *page, struct writeback_control *wbc);
427 extern int nfs_writepages(struct address_space *, struct writeback_control *);
428 extern int nfs_flush_incompatible(struct file *file, struct page *page);
429 extern int nfs_updatepage(struct file *, struct page *, unsigned int, unsigned int);
430 extern int nfs_writeback_done(struct rpc_task *, struct nfs_write_data *);
431 extern void nfs_writedata_release(void *);
433 #if defined(CONFIG_NFS_V3) || defined(CONFIG_NFS_V4)
434 struct nfs_write_data *nfs_commit_alloc(void);
435 void nfs_commit_free(struct nfs_write_data *p);
439 * Try to write back everything synchronously (but check the
442 extern int nfs_sync_inode_wait(struct inode *, unsigned long, unsigned int, int);
443 #if defined(CONFIG_NFS_V3) || defined(CONFIG_NFS_V4)
444 extern int nfs_commit_inode(struct inode *, int);
445 extern void nfs_commit_release(void *wdata);
448 nfs_commit_inode(struct inode *inode, int how)
455 nfs_have_writebacks(struct inode *inode)
457 return NFS_I(inode)->npages != 0;
461 nfs_wb_all(struct inode *inode)
463 int error = nfs_sync_inode_wait(inode, 0, 0, 0);
464 return (error < 0) ? error : 0;
468 * Write back all requests on one page - we do this before reading it.
470 static inline int nfs_wb_page_priority(struct inode *inode, struct page* page, int how)
472 int error = nfs_sync_inode_wait(inode, page->index, 1,
474 return (error < 0) ? error : 0;
477 static inline int nfs_wb_page(struct inode *inode, struct page* page)
479 return nfs_wb_page_priority(inode, page, 0);
483 * Allocate nfs_write_data structures
485 extern struct nfs_write_data *nfs_writedata_alloc(size_t len);
488 * linux/fs/nfs/read.c
490 extern int nfs_readpage(struct file *, struct page *);
491 extern int nfs_readpages(struct file *, struct address_space *,
492 struct list_head *, unsigned);
493 extern int nfs_readpage_result(struct rpc_task *, struct nfs_read_data *);
494 extern void nfs_readdata_release(void *data);
497 * Allocate nfs_read_data structures
499 extern struct nfs_read_data *nfs_readdata_alloc(size_t len);
502 * linux/fs/nfs3proc.c
504 #ifdef CONFIG_NFS_V3_ACL
505 extern struct posix_acl *nfs3_proc_getacl(struct inode *inode, int type);
506 extern int nfs3_proc_setacl(struct inode *inode, int type,
507 struct posix_acl *acl);
508 extern int nfs3_proc_set_default_acl(struct inode *dir, struct inode *inode,
510 extern void nfs3_forget_cached_acls(struct inode *inode);
512 static inline int nfs3_proc_set_default_acl(struct inode *dir,
519 static inline void nfs3_forget_cached_acls(struct inode *inode)
522 #endif /* CONFIG_NFS_V3_ACL */
525 * linux/fs/mount_clnt.c
526 * (Used only by nfsroot module)
528 extern int nfsroot_mount(struct sockaddr_in *, char *, struct nfs_fh *,
536 nfs_size_to_loff_t(__u64 size)
538 loff_t maxsz = (((loff_t) ULONG_MAX) << PAGE_CACHE_SHIFT) + PAGE_CACHE_SIZE - 1;
541 return (loff_t) size;
546 extern void * nfs_root_data(void);
548 #define nfs_wait_event(clnt, wq, condition) \
551 if (clnt->cl_intr) { \
553 rpc_clnt_sigmask(clnt, &oldmask); \
554 __retval = wait_event_interruptible(wq, condition); \
555 rpc_clnt_sigunmask(clnt, &oldmask); \
557 wait_event(wq, condition); \
561 #define NFS_JUKEBOX_RETRY_TIME (5 * HZ)
563 #endif /* __KERNEL__ */
568 #define NFSDBG_VFS 0x0001
569 #define NFSDBG_DIRCACHE 0x0002
570 #define NFSDBG_LOOKUPCACHE 0x0004
571 #define NFSDBG_PAGECACHE 0x0008
572 #define NFSDBG_PROC 0x0010
573 #define NFSDBG_XDR 0x0020
574 #define NFSDBG_FILE 0x0040
575 #define NFSDBG_ROOT 0x0080
576 #define NFSDBG_CALLBACK 0x0100
577 #define NFSDBG_CLIENT 0x0200
578 #define NFSDBG_FSCACHE 0x0400
579 #define NFSDBG_ALL 0xFFFF
584 # define ifdebug(fac) if (unlikely(nfs_debug & NFSDBG_##fac))
586 # define ifdebug(fac) if (0)
588 #endif /* __KERNEL */