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>
16 #include <linux/rwsem.h>
17 #include <linux/wait.h>
18 #include <linux/uio.h>
20 #include <linux/nfs_fs_sb.h>
22 #include <linux/sunrpc/debug.h>
23 #include <linux/sunrpc/auth.h>
24 #include <linux/sunrpc/clnt.h>
26 #include <linux/nfs.h>
27 #include <linux/nfs2.h>
28 #include <linux/nfs3.h>
29 #include <linux/nfs4.h>
30 #include <linux/nfs_xdr.h>
33 * Enable debugging support for nfs client.
40 #define NFS_MAX_FILE_IO_BUFFER_SIZE 32768
41 #define NFS_DEF_FILE_IO_BUFFER_SIZE 4096
44 * The upper limit on timeouts for the exponential backoff algorithm.
46 #define NFS_WRITEBACK_DELAY (5*HZ)
47 #define NFS_WRITEBACK_LOCKDELAY (60*HZ)
48 #define NFS_COMMIT_DELAY (5*HZ)
51 * superblock magic number for NFS
53 #define NFS_SUPER_MAGIC 0x6969
56 * These are the default flags for swap requests
58 #define NFS_RPC_SWAPFLAGS (RPC_TASK_SWAPPER|RPC_TASK_ROOTCREDS)
60 #define NFS_RW_SYNC 0x0001 /* O_SYNC handling */
61 #define NFS_RW_SWAP 0x0002 /* This is a swap request */
64 * When flushing a cluster of dirty pages, there can be different
67 #define FLUSH_AGING 0 /* only flush old buffers */
68 #define FLUSH_SYNC 1 /* file being synced, or contention */
69 #define FLUSH_WAIT 2 /* wait for completion */
70 #define FLUSH_STABLE 4 /* commit to stable storage */
75 * NFSv3 Access mode cache
77 struct nfs_access_cache {
78 unsigned long jiffies;
79 struct rpc_cred * cred;
85 * nfs fs inode data in memory
89 * The 64bit 'inode number'
101 unsigned short flags;
104 * read_cache_jiffies is when we started read-caching this inode,
105 * and read_cache_mtime is the mtime of the inode at that time.
106 * attrtimeo is for how long the cached information is assumed
107 * to be valid. A successful attribute revalidation doubles
108 * attrtimeo (up to acregmax/acdirmax), a failure resets it to
111 * We need to revalidate the cached attrs for this inode if
113 * jiffies - read_cache_jiffies > attrtimeo
115 * and invalidate any cached data/flush out any dirty pages if
118 * mtime != read_cache_mtime
120 unsigned long read_cache_jiffies;
121 struct timespec read_cache_ctime;
122 struct timespec read_cache_mtime;
123 __u64 read_cache_isize;
124 unsigned long attrtimeo;
125 unsigned long attrtimeo_timestamp;
126 __u64 change_attr; /* v4 only */
129 * Timestamp that dates the change made to read_cache_mtime.
130 * This is of use for dentry revalidation
132 unsigned long cache_mtime_jiffies;
134 struct nfs_access_cache cache_access;
137 * This is the cookie verifier used for NFSv3 readdir
143 * This is the list of dirty unwritten pages.
145 struct list_head dirty;
146 struct list_head commit;
147 struct radix_tree_root nfs_page_tree;
153 /* Credentials for shared mmap */
154 struct rpc_cred *mm_cred;
156 wait_queue_head_t nfs_i_wait;
160 struct list_head open_states;
161 #endif /* CONFIG_NFS_V4*/
163 struct inode vfs_inode;
167 * Legal inode flag values
169 #define NFS_INO_STALE 0x0001 /* possible stale inode */
170 #define NFS_INO_ADVISE_RDPLUS 0x0002 /* advise readdirplus */
171 #define NFS_INO_REVALIDATING 0x0004 /* revalidating attrs */
172 #define NFS_INO_FLUSH 0x0008 /* inode is due for flushing */
173 #define NFS_INO_FAKE_ROOT 0x0080 /* root inode placeholder */
175 static inline struct nfs_inode *NFS_I(struct inode *inode)
177 return container_of(inode, struct nfs_inode, vfs_inode);
179 #define NFS_SB(s) ((struct nfs_server *)(s->s_fs_info))
181 #define NFS_FH(inode) (&NFS_I(inode)->fh)
182 #define NFS_SERVER(inode) (NFS_SB(inode->i_sb))
183 #define NFS_CLIENT(inode) (NFS_SERVER(inode)->client)
184 #define NFS_PROTO(inode) (NFS_SERVER(inode)->rpc_ops)
185 #define NFS_ADDR(inode) (RPC_PEERADDR(NFS_CLIENT(inode)))
186 #define NFS_COOKIEVERF(inode) (NFS_I(inode)->cookieverf)
187 #define NFS_READTIME(inode) (NFS_I(inode)->read_cache_jiffies)
188 #define NFS_MTIME_UPDATE(inode) (NFS_I(inode)->cache_mtime_jiffies)
189 #define NFS_CACHE_CTIME(inode) (NFS_I(inode)->read_cache_ctime)
190 #define NFS_CACHE_MTIME(inode) (NFS_I(inode)->read_cache_mtime)
191 #define NFS_CACHE_ISIZE(inode) (NFS_I(inode)->read_cache_isize)
192 #define NFS_CHANGE_ATTR(inode) (NFS_I(inode)->change_attr)
193 #define NFS_CACHEINV(inode) \
195 NFS_READTIME(inode) = jiffies - NFS_MAXATTRTIMEO(inode) - 1; \
197 #define NFS_ATTRTIMEO(inode) (NFS_I(inode)->attrtimeo)
198 #define NFS_MINATTRTIMEO(inode) \
199 (S_ISDIR(inode->i_mode)? NFS_SERVER(inode)->acdirmin \
200 : NFS_SERVER(inode)->acregmin)
201 #define NFS_MAXATTRTIMEO(inode) \
202 (S_ISDIR(inode->i_mode)? NFS_SERVER(inode)->acdirmax \
203 : NFS_SERVER(inode)->acregmax)
204 #define NFS_ATTRTIMEO_UPDATE(inode) (NFS_I(inode)->attrtimeo_timestamp)
206 #define NFS_FLAGS(inode) (NFS_I(inode)->flags)
207 #define NFS_REVALIDATING(inode) (NFS_FLAGS(inode) & NFS_INO_REVALIDATING)
208 #define NFS_STALE(inode) (NFS_FLAGS(inode) & NFS_INO_STALE)
209 #define NFS_FAKE_ROOT(inode) (NFS_FLAGS(inode) & NFS_INO_FAKE_ROOT)
211 #define NFS_FILEID(inode) (NFS_I(inode)->fileid)
213 static inline int nfs_server_capable(struct inode *inode, int cap)
215 return NFS_SERVER(inode)->caps & cap;
218 static inline int NFS_USE_READDIRPLUS(struct inode *inode)
220 return NFS_FLAGS(inode) & NFS_INO_ADVISE_RDPLUS;
224 loff_t page_offset(struct page *page)
226 return ((loff_t)page->index) << PAGE_CACHE_SHIFT;
230 * linux/fs/nfs/inode.c
232 extern void nfs_zap_caches(struct inode *);
233 extern struct inode *nfs_fhget(struct super_block *, struct nfs_fh *,
235 extern int __nfs_refresh_inode(struct inode *, struct nfs_fattr *);
236 extern int nfs_getattr(struct vfsmount *, struct dentry *, struct kstat *);
237 extern int nfs_permission(struct inode *, int, struct nameidata *);
238 extern void nfs_set_mmcred(struct inode *, struct rpc_cred *);
239 extern int nfs_open(struct inode *, struct file *);
240 extern int nfs_release(struct inode *, struct file *);
241 extern int __nfs_revalidate_inode(struct nfs_server *, struct inode *);
242 extern int nfs_setattr(struct dentry *, struct iattr *);
245 * linux/fs/nfs/file.c
247 extern struct inode_operations nfs_file_inode_operations;
248 extern struct file_operations nfs_file_operations;
249 extern struct address_space_operations nfs_file_aops;
252 * linux/fs/nfs/xattr.c
254 #ifdef CONFIG_NFS_ACL
255 extern ssize_t nfs_listxattr(struct dentry *, char *, size_t);
256 extern ssize_t nfs_getxattr(struct dentry *, const char *, void *, size_t);
257 extern int nfs_setxattr(struct dentry *, const char *,
258 const void *, size_t, int);
259 extern int nfs_removexattr (struct dentry *, const char *name);
261 # define nfs_listxattr NULL
262 # define nfs_getxattr NULL
263 # define nfs_setxattr NULL
264 # define nfs_removexattr NULL
267 static __inline__ struct rpc_cred *
268 nfs_file_cred(struct file *file)
270 struct rpc_cred *cred = NULL;
272 cred = (struct rpc_cred *)file->private_data;
274 if (cred && cred->cr_magic != RPCAUTH_CRED_MAGIC)
281 * linux/fs/nfs/direct.c
283 extern int nfs_direct_IO(int, struct kiocb *, const struct iovec *, loff_t,
289 extern struct inode_operations nfs_dir_inode_operations;
290 extern struct file_operations nfs_dir_operations;
291 extern struct dentry_operations nfs_dentry_operations;
294 * linux/fs/nfs/symlink.c
296 extern struct inode_operations nfs_symlink_inode_operations;
299 * linux/fs/nfs/locks.c
301 extern int nfs_lock(struct file *, int, struct file_lock *);
304 * linux/fs/nfs/unlink.c
306 extern int nfs_async_unlink(struct dentry *);
307 extern void nfs_complete_unlink(struct dentry *);
310 * linux/fs/nfs/write.c
312 extern int nfs_writepage(struct page *page, struct writeback_control *wbc);
313 extern int nfs_writepages(struct address_space *, struct writeback_control *);
314 extern int nfs_flush_incompatible(struct file *file, struct page *page);
315 extern int nfs_updatepage(struct file *, struct page *, unsigned int, unsigned int);
316 extern void nfs_writeback_done(struct rpc_task *task);
317 extern void nfs_writedata_release(struct rpc_task *task);
319 #if defined(CONFIG_NFS_V3) || defined(CONFIG_NFS_V4)
320 extern void nfs_commit_release(struct rpc_task *task);
321 extern void nfs_commit_done(struct rpc_task *);
325 * Try to write back everything synchronously (but check the
328 extern int nfs_sync_file(struct inode *, struct file *, unsigned long, unsigned int, int);
329 extern int nfs_flush_file(struct inode *, struct file *, unsigned long, unsigned int, int);
330 extern int nfs_flush_list(struct list_head *, int, int);
331 #if defined(CONFIG_NFS_V3) || defined(CONFIG_NFS_V4)
332 extern int nfs_commit_file(struct inode *, struct file *, unsigned long, unsigned int, int);
333 extern int nfs_commit_list(struct list_head *, int);
336 nfs_commit_file(struct inode *inode, struct file *file, unsigned long offset,
337 unsigned int len, int flags)
344 nfs_have_writebacks(struct inode *inode)
346 return NFS_I(inode)->npages != 0;
350 nfs_wb_all(struct inode *inode)
352 int error = nfs_sync_file(inode, 0, 0, 0, FLUSH_WAIT);
353 return (error < 0) ? error : 0;
357 * Write back all requests on one page - we do this before reading it.
360 nfs_wb_page(struct inode *inode, struct page* page)
362 int error = nfs_sync_file(inode, 0, page->index, 1,
363 FLUSH_WAIT | FLUSH_STABLE);
364 return (error < 0) ? error : 0;
368 * Write back all pending writes for one user..
371 nfs_wb_file(struct inode *inode, struct file *file)
373 int error = nfs_sync_file(inode, file, 0, 0, FLUSH_WAIT);
374 return (error < 0) ? error : 0;
377 /* Hack for future NFS swap support */
379 # define IS_SWAPFILE(inode) (0)
383 * linux/fs/nfs/read.c
385 extern int nfs_readpage(struct file *, struct page *);
386 extern int nfs_readpages(struct file *, struct address_space *,
387 struct list_head *, unsigned);
388 extern int nfs_pagein_list(struct list_head *, int);
389 extern void nfs_readpage_result(struct rpc_task *);
390 extern void nfs_readdata_release(struct rpc_task *);
393 * linux/fs/mount_clnt.c
394 * (Used only by nfsroot module)
396 extern int nfsroot_mount(struct sockaddr_in *, char *, struct nfs_fh *,
403 nfs_revalidate_inode(struct nfs_server *server, struct inode *inode)
405 if (time_before(jiffies, NFS_READTIME(inode)+NFS_ATTRTIMEO(inode)))
406 return NFS_STALE(inode) ? -ESTALE : 0;
407 return __nfs_revalidate_inode(server, inode);
411 nfs_refresh_inode(struct inode *inode, struct nfs_fattr *fattr)
413 if ((fattr->valid & NFS_ATTR_FATTR) == 0)
415 return __nfs_refresh_inode(inode,fattr);
419 nfs_size_to_loff_t(__u64 size)
421 loff_t maxsz = (((loff_t) ULONG_MAX) << PAGE_CACHE_SHIFT) + PAGE_CACHE_SIZE - 1;
424 return (loff_t) size;
428 nfs_fileid_to_ino_t(u64 fileid)
430 ino_t ino = (ino_t) fileid;
431 if (sizeof(ino_t) < sizeof(u64))
432 ino ^= fileid >> (sizeof(u64)-sizeof(ino_t)) * 8;
438 extern void * nfs_root_data(void);
440 #define nfs_wait_event(clnt, wq, condition) \
443 if (clnt->cl_intr) { \
445 rpc_clnt_sigmask(clnt, &oldmask); \
446 __retval = wait_event_interruptible(wq, condition); \
447 rpc_clnt_sigunmask(clnt, &oldmask); \
449 wait_event(wq, condition); \
453 #define NFS_JUKEBOX_RETRY_TIME (5 * HZ)
458 * In a seqid-mutating op, this macro controls which error return
459 * values trigger incrementation of the seqid.
462 * The client MUST monotonically increment the sequence number for the
463 * CLOSE, LOCK, LOCKU, OPEN, OPEN_CONFIRM, and OPEN_DOWNGRADE
464 * operations. This is true even in the event that the previous
465 * operation that used the sequence number received an error. The only
466 * exception to this rule is if the previous operation received one of
467 * the following errors: NFSERR_STALE_CLIENTID, NFSERR_STALE_STATEID,
468 * NFSERR_BAD_STATEID, NFSERR_BAD_SEQID, NFSERR_BADXDR,
469 * NFSERR_RESOURCE, NFSERR_NOFILEHANDLE.
472 #define seqid_mutating_err(err) \
473 (((err) != NFSERR_STALE_CLIENTID) && \
474 ((err) != NFSERR_STALE_STATEID) && \
475 ((err) != NFSERR_BAD_STATEID) && \
476 ((err) != NFSERR_BAD_SEQID) && \
477 ((err) != NFSERR_BAD_XDR) && \
478 ((err) != NFSERR_RESOURCE) && \
479 ((err) != NFSERR_NOFILEHANDLE))
481 enum nfs4_client_state {
487 * The nfs4_client identifies our client state to the server.
490 struct list_head cl_servers; /* Global list of servers */
491 struct in_addr cl_addr; /* Server identifier */
492 u64 cl_clientid; /* constant */
493 nfs4_verifier cl_confirm;
494 enum nfs4_client_state cl_state;
499 * The following rwsem ensures exclusive access to the server
500 * while we recover the state following a lease expiration.
502 struct rw_semaphore cl_sem;
504 struct list_head cl_state_owners;
505 struct list_head cl_unused;
512 * NFS4 state_owners and lock_owners are simply labels for ordered
513 * sequences of RPC calls. Their sole purpose is to provide once-only
514 * semantics by allowing the server to identify replayed requests.
516 * The ->so_sema is held during all state_owner seqid-mutating operations:
517 * OPEN, OPEN_DOWNGRADE, and CLOSE. Its purpose is to properly serialize
520 struct nfs4_state_owner {
521 struct list_head so_list; /* per-clientid list of state_owners */
522 struct nfs4_client *so_client;
523 u32 so_id; /* 32-bit identifier, unique */
524 struct semaphore so_sema;
525 u32 so_seqid; /* protected by so_sema */
526 unsigned int so_flags; /* protected by so_sema */
529 struct rpc_cred *so_cred; /* Associated cred */
530 struct list_head so_states;
534 * struct nfs4_state maintains the client-side state for a given
535 * (state_owner,inode) tuple.
537 * In order to know when to OPEN_DOWNGRADE or CLOSE the state on the server,
538 * we need to know how many files are open for reading or writing on a
539 * given inode. This information too is stored here.
542 struct list_head open_states; /* List of states for the same state_owner */
543 struct list_head inode_states; /* List of states for the same inode */
545 struct nfs4_state_owner *owner; /* Pointer to the open owner */
546 struct inode *inode; /* Pointer to the inode */
547 pid_t pid; /* Thread that called OPEN */
549 nfs4_stateid stateid;
551 int state; /* State on the server (R,W, or RW) */
557 extern int nfs4_proc_renew(struct nfs_server *server);
558 extern int nfs4_do_close(struct inode *, struct nfs4_state *);
561 extern int nfs4_init_renewd(struct nfs_server *server);
564 extern struct nfs4_client *nfs4_get_client(struct in_addr *);
565 extern void nfs4_put_client(struct nfs4_client *clp);
566 extern struct nfs4_state_owner * nfs4_get_state_owner(struct nfs_server *, struct rpc_cred *);
567 extern void nfs4_put_state_owner(struct nfs4_state_owner *);
568 extern struct nfs4_state * nfs4_get_open_state(struct inode *, struct nfs4_state_owner *);
569 extern void nfs4_put_open_state(struct nfs4_state *);
570 extern void nfs4_increment_seqid(u32 status, struct nfs4_state_owner *sp);
577 struct nfs4_mount_data;
579 create_nfsv4_state(struct nfs_server *server, struct nfs4_mount_data *data)
581 server->nfs4_state = NULL;
586 destroy_nfsv4_state(struct nfs_server *server)
588 if (server->mnt_path) {
589 kfree(server->mnt_path);
590 server->mnt_path = NULL;
592 if (server->nfs4_state) {
593 nfs4_put_client(server->nfs4_state);
594 server->nfs4_state = NULL;
598 #define create_nfsv4_state(server, data) 0
599 #define destroy_nfsv4_state(server) do { } while (0)
600 #define nfs4_put_state_owner(inode, owner) do { } while (0)
601 #define nfs4_put_open_state(state) do { } while (0)
604 #endif /* __KERNEL__ */
609 #define NFSDBG_VFS 0x0001
610 #define NFSDBG_DIRCACHE 0x0002
611 #define NFSDBG_LOOKUPCACHE 0x0004
612 #define NFSDBG_PAGECACHE 0x0008
613 #define NFSDBG_PROC 0x0010
614 #define NFSDBG_XDR 0x0020
615 #define NFSDBG_FILE 0x0040
616 #define NFSDBG_ROOT 0x0080
617 #define NFSDBG_ALL 0xFFFF
622 # define ifdebug(fac) if (nfs_debug & NFSDBG_##fac)
624 # define ifdebug(fac) if (0)
626 #endif /* __KERNEL */