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/config.h>
15 #include <linux/pagemap.h>
17 #include <linux/sunrpc/debug.h>
18 #include <linux/sunrpc/auth.h>
19 #include <linux/sunrpc/clnt.h>
21 #include <linux/nfs.h>
22 #include <linux/nfs2.h>
23 #include <linux/nfs3.h>
24 #include <linux/nfs_xdr.h>
27 * Enable debugging support for nfs client.
35 * NFS_MAX_DIRCACHE controls the number of simultaneously cached
36 * directory chunks. Each chunk holds the list of nfs_entry's returned
37 * in a single readdir call in a memory region of size PAGE_SIZE.
39 * Note that at most server->rsize bytes of the cache memory are used.
41 #define NFS_MAX_DIRCACHE 16
43 #define NFS_MAX_FILE_IO_BUFFER_SIZE 32768
44 #define NFS_DEF_FILE_IO_BUFFER_SIZE 4096
47 * The upper limit on timeouts for the exponential backoff algorithm.
49 #define NFS_MAX_RPC_TIMEOUT (6*HZ)
50 #define NFS_READ_DELAY (2*HZ)
51 #define NFS_WRITEBACK_DELAY (5*HZ)
52 #define NFS_WRITEBACK_LOCKDELAY (60*HZ)
53 #define NFS_COMMIT_DELAY (5*HZ)
56 * Size of the lookup cache in units of number of entries cached.
57 * It is better not to make this too large although the optimum
58 * depends on a usage and environment.
60 #define NFS_LOOKUP_CACHE_SIZE 64
63 * superblock magic number for NFS
65 #define NFS_SUPER_MAGIC 0x6969
67 static inline struct nfs_inode_info *NFS_I(struct inode *inode)
69 return &inode->u.nfs_i;
72 #define NFS_FH(inode) (&(inode)->u.nfs_i.fh)
73 #define NFS_SERVER(inode) (&(inode)->i_sb->u.nfs_sb.s_server)
74 #define NFS_CLIENT(inode) (NFS_SERVER(inode)->client)
75 #define NFS_PROTO(inode) (NFS_SERVER(inode)->rpc_ops)
76 #define NFS_REQUESTLIST(inode) (NFS_SERVER(inode)->rw_requests)
77 #define NFS_ADDR(inode) (RPC_PEERADDR(NFS_CLIENT(inode)))
78 #define NFS_CONGESTED(inode) (RPC_CONGESTED(NFS_CLIENT(inode)))
79 #define NFS_COOKIEVERF(inode) ((inode)->u.nfs_i.cookieverf)
80 #define NFS_READTIME(inode) ((inode)->u.nfs_i.read_cache_jiffies)
81 #define NFS_MTIME_UPDATE(inode) ((inode)->u.nfs_i.cache_mtime_jiffies)
82 #define NFS_CACHE_CTIME(inode) ((inode)->u.nfs_i.read_cache_ctime)
83 #define NFS_CACHE_MTIME(inode) ((inode)->u.nfs_i.read_cache_mtime)
84 #define NFS_CACHE_ISIZE(inode) ((inode)->u.nfs_i.read_cache_isize)
85 #define NFS_NEXTSCAN(inode) ((inode)->u.nfs_i.nextscan)
86 #define NFS_CACHEINV(inode) \
88 NFS_READTIME(inode) = jiffies - NFS_MAXATTRTIMEO(inode) - 1; \
90 #define NFS_ATTRTIMEO(inode) ((inode)->u.nfs_i.attrtimeo)
91 #define NFS_MINATTRTIMEO(inode) \
92 (S_ISDIR(inode->i_mode)? NFS_SERVER(inode)->acdirmin \
93 : NFS_SERVER(inode)->acregmin)
94 #define NFS_MAXATTRTIMEO(inode) \
95 (S_ISDIR(inode->i_mode)? NFS_SERVER(inode)->acdirmax \
96 : NFS_SERVER(inode)->acregmax)
97 #define NFS_ATTRTIMEO_UPDATE(inode) ((inode)->u.nfs_i.attrtimeo_timestamp)
99 #define NFS_FLAGS(inode) ((inode)->u.nfs_i.flags)
100 #define NFS_REVALIDATING(inode) (NFS_FLAGS(inode) & NFS_INO_REVALIDATING)
101 #define NFS_STALE(inode) (NFS_FLAGS(inode) & NFS_INO_STALE)
103 #define NFS_FILEID(inode) ((inode)->u.nfs_i.fileid)
106 #define NFS_USE_READDIRPLUS(inode) ((NFS_FLAGS(inode) & NFS_INO_ADVISE_RDPLUS) ? 1 : 0)
109 * These are the default flags for swap requests
111 #define NFS_RPC_SWAPFLAGS (RPC_TASK_SWAPPER|RPC_TASK_ROOTCREDS)
113 /* Flags in the RPC client structure */
114 #define NFS_CLNTF_BUFSIZE 0x0001 /* readdir buffer in longwords */
116 #define NFS_RW_SYNC 0x0001 /* O_SYNC handling */
117 #define NFS_RW_SWAP 0x0002 /* This is a swap request */
120 * When flushing a cluster of dirty pages, there can be different
123 #define FLUSH_AGING 0 /* only flush old buffers */
124 #define FLUSH_SYNC 1 /* file being synced, or contention */
125 #define FLUSH_WAIT 2 /* wait for completion */
126 #define FLUSH_STABLE 4 /* commit to stable storage */
129 loff_t page_offset(struct page *page)
131 return ((loff_t)page->index) << PAGE_CACHE_SHIFT;
135 unsigned long page_index(struct page *page)
142 * linux/fs/nfs/inode.c
144 extern struct super_block *nfs_read_super(struct super_block *, void *, int);
145 extern void nfs_zap_caches(struct inode *);
146 extern int nfs_inode_is_stale(struct inode *, struct nfs_fh *,
148 extern struct inode *nfs_fhget(struct dentry *, struct nfs_fh *,
150 extern int __nfs_refresh_inode(struct inode *, struct nfs_fattr *);
151 extern int nfs_revalidate(struct dentry *);
152 extern int nfs_permission(struct inode *, int);
153 extern int nfs_open(struct inode *, struct file *);
154 extern int nfs_release(struct inode *, struct file *);
155 extern int __nfs_revalidate_inode(struct nfs_server *, struct inode *);
156 extern int nfs_check_stale(struct inode *);
157 extern int nfs_notify_change(struct dentry *, struct iattr *);
160 * linux/fs/nfs/file.c
162 extern struct inode_operations nfs_file_inode_operations;
163 extern struct file_operations nfs_file_operations;
164 extern struct address_space_operations nfs_file_aops;
166 static __inline__ struct rpc_cred *
167 nfs_file_cred(struct file *file)
169 struct rpc_cred *cred = NULL;
171 cred = (struct rpc_cred *)file->private_data;
173 if (cred && cred->cr_magic != RPCAUTH_CRED_MAGIC)
182 extern struct inode_operations nfs_dir_inode_operations;
183 extern struct file_operations nfs_dir_operations;
184 extern struct dentry_operations nfs_dentry_operations;
187 * linux/fs/nfs/symlink.c
189 extern struct inode_operations nfs_symlink_inode_operations;
192 * linux/fs/nfs/locks.c
194 extern int nfs_lock(struct file *, int, struct file_lock *);
197 * linux/fs/nfs/unlink.c
199 extern int nfs_async_unlink(struct dentry *);
200 extern void nfs_complete_unlink(struct dentry *);
203 * linux/fs/nfs/write.c
205 extern int nfs_writepage(struct page *);
206 extern int nfs_flush_incompatible(struct file *file, struct page *page);
207 extern int nfs_updatepage(struct file *, struct page *, unsigned int, unsigned int);
209 * Try to write back everything synchronously (but check the
212 extern int nfs_sync_file(struct inode *, struct file *, unsigned long, unsigned int, int);
213 extern int nfs_flush_file(struct inode *, struct file *, unsigned long, unsigned int, int);
214 extern int nfs_flush_list(struct list_head *, int, int);
215 extern int nfs_scan_lru_dirty(struct nfs_server *, struct list_head *);
216 extern int nfs_scan_lru_dirty_timeout(struct nfs_server *, struct list_head *);
218 extern int nfs_commit_file(struct inode *, struct file *, unsigned long, unsigned int, int);
219 extern int nfs_commit_list(struct list_head *, int);
220 extern int nfs_scan_lru_commit(struct nfs_server *, struct list_head *);
221 extern int nfs_scan_lru_commit_timeout(struct nfs_server *, struct list_head *);
225 nfs_have_read(struct inode *inode)
227 return !list_empty(&inode->u.nfs_i.read);
231 nfs_have_writebacks(struct inode *inode)
233 return !list_empty(&inode->u.nfs_i.writeback);
237 nfs_wb_all(struct inode *inode)
239 int error = nfs_sync_file(inode, 0, 0, 0, FLUSH_WAIT);
240 return (error < 0) ? error : 0;
244 * Write back all requests on one page - we do this before reading it.
247 nfs_wb_page(struct inode *inode, struct page* page)
249 int error = nfs_sync_file(inode, 0, page_index(page), 1, FLUSH_WAIT | FLUSH_STABLE);
250 return (error < 0) ? error : 0;
254 * Write back all pending writes for one user..
257 nfs_wb_file(struct inode *inode, struct file *file)
259 int error = nfs_sync_file(inode, file, 0, 0, FLUSH_WAIT);
260 return (error < 0) ? error : 0;
264 * linux/fs/nfs/read.c
266 extern int nfs_readpage(struct file *, struct page *);
267 extern int nfs_pagein_inode(struct inode *, unsigned long, unsigned int);
268 extern int nfs_pagein_list(struct list_head *, int);
269 extern int nfs_scan_lru_read(struct nfs_server *, struct list_head *);
270 extern int nfs_scan_lru_read_timeout(struct nfs_server *, struct list_head *);
272 #define NFS_SetPageSync(page) set_bit(PG_fs_1, &(page)->flags)
273 #define NFS_ClearPageSync(page) clear_bit(PG_fs_1, &(page)->flags)
274 #define NFS_TestClearPageSync(page) test_and_clear_bit(PG_fs_1, &(page)->flags)
277 * linux/fs/mount_clnt.c
278 * (Used only by nfsroot module)
280 extern int nfsroot_mount(struct sockaddr_in *, char *, struct nfs_fh *,
283 /* linux/net/ipv4/ipconfig.c: trims ip addr off front of name, too. */
284 extern u32 root_nfs_parse_addr(char *name); /*__init*/
290 nfs_revalidate_inode(struct nfs_server *server, struct inode *inode)
292 if (time_before(jiffies, NFS_READTIME(inode)+NFS_ATTRTIMEO(inode)))
293 return NFS_STALE(inode) ? -ESTALE : 0;
294 return __nfs_revalidate_inode(server, inode);
298 nfs_refresh_inode(struct inode *inode, struct nfs_fattr *fattr)
300 if ((fattr->valid & NFS_ATTR_FATTR) == 0)
302 return __nfs_refresh_inode(inode,fattr);
306 nfs_size_to_loff_t(__u64 size)
308 loff_t maxsz = (((loff_t) ULONG_MAX) << PAGE_CACHE_SHIFT) + PAGE_CACHE_SIZE - 1;
311 return (loff_t) size;
315 nfs_fileid_to_ino_t(u64 fileid)
317 ino_t ino = (ino_t) fileid;
318 if (sizeof(ino_t) < sizeof(u64))
319 ino ^= fileid >> (sizeof(u64)-sizeof(ino_t)) * 8;
324 nfs_time_to_secs(__u64 time)
326 return (time_t)(time >> 32);
331 extern void * nfs_root_data(void);
333 #define nfs_wait_event(clnt, wq, condition) \
336 if (clnt->cl_intr) { \
338 rpc_clnt_sigmask(clnt, &oldmask); \
339 __retval = wait_event_interruptible(wq, condition); \
340 rpc_clnt_sigunmask(clnt, &oldmask); \
342 wait_event(wq, condition); \
348 #define NFS_JUKEBOX_RETRY_TIME (5 * HZ)
350 nfs_async_handle_jukebox(struct rpc_task *task)
352 if (task->tk_status != -EJUKEBOX)
355 rpc_restart_call(task);
356 rpc_delay(task, NFS_JUKEBOX_RETRY_TIME);
363 nfs_async_handle_jukebox(struct rpc_task *task)
367 #endif /* CONFIG_NFS_V3 */
369 #endif /* __KERNEL__ */
374 #define NFSDBG_VFS 0x0001
375 #define NFSDBG_DIRCACHE 0x0002
376 #define NFSDBG_LOOKUPCACHE 0x0004
377 #define NFSDBG_PAGECACHE 0x0008
378 #define NFSDBG_PROC 0x0010
379 #define NFSDBG_XDR 0x0020
380 #define NFSDBG_FILE 0x0040
381 #define NFSDBG_ROOT 0x0080
382 #define NFSDBG_ALL 0xFFFF
387 # define ifdebug(fac) if (nfs_debug & NFSDBG_##fac)
389 # define ifdebug(fac) if (0)
391 #endif /* __KERNEL */