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>
19 #include <linux/nfs_fs_sb.h>
21 #include <linux/sunrpc/debug.h>
22 #include <linux/sunrpc/auth.h>
23 #include <linux/sunrpc/clnt.h>
25 #include <linux/nfs.h>
26 #include <linux/nfs2.h>
27 #include <linux/nfs3.h>
28 #include <linux/nfs4.h>
29 #include <linux/nfs_xdr.h>
30 #include <linux/rwsem.h>
31 #include <linux/mempool.h>
34 * Enable debugging support for nfs client.
41 /* Default timeout values */
42 #define NFS_MAX_UDP_TIMEOUT (60*HZ)
43 #define NFS_MAX_TCP_TIMEOUT (600*HZ)
46 * superblock magic number for NFS
48 #define NFS_SUPER_MAGIC 0x6969
51 * These are the default flags for swap requests
53 #define NFS_RPC_SWAPFLAGS (RPC_TASK_SWAPPER|RPC_TASK_ROOTCREDS)
56 * When flushing a cluster of dirty pages, there can be different
59 #define FLUSH_AGING 0 /* only flush old buffers */
60 #define FLUSH_SYNC 1 /* file being synced, or contention */
61 #define FLUSH_WAIT 2 /* wait for completion */
62 #define FLUSH_STABLE 4 /* commit to stable storage */
63 #define FLUSH_LOWPRI 8 /* low priority background flush */
64 #define FLUSH_HIGHPRI 16 /* high priority memory reclaim flush */
65 #define FLUSH_NOCOMMIT 32 /* Don't send the NFSv3/v4 COMMIT */
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 struct inode vfs_inode
;
188 * Cache validity bit flags
190 #define NFS_INO_INVALID_ATTR 0x0001 /* cached attrs are invalid */
191 #define NFS_INO_INVALID_DATA 0x0002 /* cached data is invalid */
192 #define NFS_INO_INVALID_ATIME 0x0004 /* cached atime is invalid */
193 #define NFS_INO_INVALID_ACCESS 0x0008 /* cached access cred invalid */
194 #define NFS_INO_INVALID_ACL 0x0010 /* cached acls are invalid */
195 #define NFS_INO_REVAL_PAGECACHE 0x0020 /* must revalidate pagecache */
198 * Bit offsets in flags field
200 #define NFS_INO_REVALIDATING (0) /* revalidating attrs */
201 #define NFS_INO_ADVISE_RDPLUS (1) /* advise readdirplus */
202 #define NFS_INO_STALE (2) /* possible stale inode */
204 static inline struct nfs_inode
*NFS_I(struct inode
*inode
)
206 return container_of(inode
, struct nfs_inode
, vfs_inode
);
208 #define NFS_SB(s) ((struct nfs_server *)(s->s_fs_info))
210 #define NFS_FH(inode) (&NFS_I(inode)->fh)
211 #define NFS_SERVER(inode) (NFS_SB(inode->i_sb))
212 #define NFS_CLIENT(inode) (NFS_SERVER(inode)->client)
213 #define NFS_PROTO(inode) (NFS_SERVER(inode)->rpc_ops)
214 #define NFS_ADDR(inode) (RPC_PEERADDR(NFS_CLIENT(inode)))
215 #define NFS_COOKIEVERF(inode) (NFS_I(inode)->cookieverf)
216 #define NFS_READTIME(inode) (NFS_I(inode)->read_cache_jiffies)
217 #define NFS_CHANGE_ATTR(inode) (NFS_I(inode)->change_attr)
218 #define NFS_ATTRTIMEO(inode) (NFS_I(inode)->attrtimeo)
219 #define NFS_MINATTRTIMEO(inode) \
220 (S_ISDIR(inode->i_mode)? NFS_SERVER(inode)->acdirmin \
221 : NFS_SERVER(inode)->acregmin)
222 #define NFS_MAXATTRTIMEO(inode) \
223 (S_ISDIR(inode->i_mode)? NFS_SERVER(inode)->acdirmax \
224 : NFS_SERVER(inode)->acregmax)
225 #define NFS_ATTRTIMEO_UPDATE(inode) (NFS_I(inode)->attrtimeo_timestamp)
227 #define NFS_FLAGS(inode) (NFS_I(inode)->flags)
228 #define NFS_STALE(inode) (test_bit(NFS_INO_STALE, &NFS_FLAGS(inode)))
230 #define NFS_FILEID(inode) (NFS_I(inode)->fileid)
232 static inline int nfs_caches_unstable(struct inode
*inode
)
234 return atomic_read(&NFS_I(inode
)->data_updates
) != 0;
237 static inline void nfs_mark_for_revalidate(struct inode
*inode
)
239 spin_lock(&inode
->i_lock
);
240 NFS_I(inode
)->cache_validity
|= NFS_INO_INVALID_ATTR
| NFS_INO_INVALID_ACCESS
;
241 spin_unlock(&inode
->i_lock
);
244 static inline void NFS_CACHEINV(struct inode
*inode
)
246 if (!nfs_caches_unstable(inode
))
247 nfs_mark_for_revalidate(inode
);
250 static inline int nfs_server_capable(struct inode
*inode
, int cap
)
252 return NFS_SERVER(inode
)->caps
& cap
;
255 static inline int NFS_USE_READDIRPLUS(struct inode
*inode
)
257 return test_bit(NFS_INO_ADVISE_RDPLUS
, &NFS_FLAGS(inode
));
261 * nfs_save_change_attribute - Returns the inode attribute change cookie
262 * @inode - pointer to inode
263 * The "change attribute" is updated every time we finish an operation
264 * that will result in a metadata change on the server.
266 static inline long nfs_save_change_attribute(struct inode
*inode
)
268 return NFS_I(inode
)->cache_change_attribute
;
272 * nfs_verify_change_attribute - Detects NFS inode cache updates
273 * @inode - pointer to inode
274 * @chattr - previously saved change attribute
275 * Return "false" if metadata has been updated (or is in the process of
276 * being updated) since the change attribute was saved.
278 static inline int nfs_verify_change_attribute(struct inode
*inode
, unsigned long chattr
)
280 return !nfs_caches_unstable(inode
)
281 && time_after_eq(chattr
, NFS_I(inode
)->cache_change_attribute
);
285 * linux/fs/nfs/inode.c
287 extern int nfs_sync_mapping(struct address_space
*mapping
);
288 extern void nfs_zap_caches(struct inode
*);
289 extern struct inode
*nfs_fhget(struct super_block
*, struct nfs_fh
*,
291 extern int nfs_refresh_inode(struct inode
*, struct nfs_fattr
*);
292 extern int nfs_post_op_update_inode(struct inode
*inode
, struct nfs_fattr
*fattr
);
293 extern int nfs_getattr(struct vfsmount
*, struct dentry
*, struct kstat
*);
294 extern int nfs_permission(struct inode
*, int, struct nameidata
*);
295 extern int nfs_access_get_cached(struct inode
*, struct rpc_cred
*, struct nfs_access_entry
*);
296 extern void nfs_access_add_cache(struct inode
*, struct nfs_access_entry
*);
297 extern int nfs_open(struct inode
*, struct file
*);
298 extern int nfs_release(struct inode
*, struct file
*);
299 extern int nfs_attribute_timeout(struct inode
*inode
);
300 extern int nfs_revalidate_inode(struct nfs_server
*server
, struct inode
*inode
);
301 extern int __nfs_revalidate_inode(struct nfs_server
*, struct inode
*);
302 extern void nfs_revalidate_mapping(struct inode
*inode
, struct address_space
*mapping
);
303 extern int nfs_setattr(struct dentry
*, struct iattr
*);
304 extern void nfs_setattr_update_inode(struct inode
*inode
, struct iattr
*attr
);
305 extern void nfs_begin_attr_update(struct inode
*);
306 extern void nfs_end_attr_update(struct inode
*);
307 extern void nfs_begin_data_update(struct inode
*);
308 extern void nfs_end_data_update(struct inode
*);
309 extern struct nfs_open_context
*get_nfs_open_context(struct nfs_open_context
*ctx
);
310 extern void put_nfs_open_context(struct nfs_open_context
*ctx
);
311 extern struct nfs_open_context
*nfs_find_open_context(struct inode
*inode
, struct rpc_cred
*cred
, int mode
);
313 /* linux/net/ipv4/ipconfig.c: trims ip addr off front of name, too. */
314 extern u32
root_nfs_parse_addr(char *name
); /*__init*/
316 static inline void nfs_fattr_init(struct nfs_fattr
*fattr
)
319 fattr
->time_start
= jiffies
;
323 * linux/fs/nfs/file.c
325 extern struct inode_operations nfs_file_inode_operations
;
327 extern struct inode_operations nfs3_file_inode_operations
;
328 #endif /* CONFIG_NFS_V3 */
329 extern struct file_operations nfs_file_operations
;
330 extern struct address_space_operations nfs_file_aops
;
332 static inline struct rpc_cred
*nfs_file_cred(struct file
*file
)
335 struct nfs_open_context
*ctx
;
337 ctx
= (struct nfs_open_context
*)file
->private_data
;
344 * linux/fs/nfs/xattr.c
346 #ifdef CONFIG_NFS_V3_ACL
347 extern ssize_t
nfs3_listxattr(struct dentry
*, char *, size_t);
348 extern ssize_t
nfs3_getxattr(struct dentry
*, const char *, void *, size_t);
349 extern int nfs3_setxattr(struct dentry
*, const char *,
350 const void *, size_t, int);
351 extern int nfs3_removexattr (struct dentry
*, const char *name
);
353 # define nfs3_listxattr NULL
354 # define nfs3_getxattr NULL
355 # define nfs3_setxattr NULL
356 # define nfs3_removexattr NULL
360 * linux/fs/nfs/direct.c
362 extern ssize_t
nfs_direct_IO(int, struct kiocb
*, const struct iovec
*, loff_t
,
364 extern ssize_t
nfs_file_direct_read(struct kiocb
*iocb
, char __user
*buf
,
365 size_t count
, loff_t pos
);
366 extern ssize_t
nfs_file_direct_write(struct kiocb
*iocb
, const char __user
*buf
,
367 size_t count
, loff_t pos
);
372 extern struct inode_operations nfs_dir_inode_operations
;
374 extern struct inode_operations nfs3_dir_inode_operations
;
375 #endif /* CONFIG_NFS_V3 */
376 extern 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 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/unlink.c
400 extern int nfs_async_unlink(struct dentry
*);
401 extern void nfs_complete_unlink(struct dentry
*);
404 * linux/fs/nfs/write.c
406 extern int nfs_writepage(struct page
*page
, struct writeback_control
*wbc
);
407 extern int nfs_writepages(struct address_space
*, struct writeback_control
*);
408 extern int nfs_flush_incompatible(struct file
*file
, struct page
*page
);
409 extern int nfs_updatepage(struct file
*, struct page
*, unsigned int, unsigned int);
412 * Try to write back everything synchronously (but check the
415 extern int nfs_sync_inode(struct inode
*, unsigned long, unsigned int, int);
416 #if defined(CONFIG_NFS_V3) || defined(CONFIG_NFS_V4)
417 extern int nfs_commit_inode(struct inode
*, int);
420 nfs_commit_inode(struct inode
*inode
, int how
)
427 nfs_have_writebacks(struct inode
*inode
)
429 return NFS_I(inode
)->npages
!= 0;
433 nfs_wb_all(struct inode
*inode
)
435 int error
= nfs_sync_inode(inode
, 0, 0, FLUSH_WAIT
);
436 return (error
< 0) ? error
: 0;
440 * Write back all requests on one page - we do this before reading it.
442 static inline int nfs_wb_page_priority(struct inode
*inode
, struct page
* page
, int how
)
444 int error
= nfs_sync_inode(inode
, page
->index
, 1,
445 how
| FLUSH_WAIT
| FLUSH_STABLE
);
446 return (error
< 0) ? error
: 0;
449 static inline int nfs_wb_page(struct inode
*inode
, struct page
* page
)
451 return nfs_wb_page_priority(inode
, page
, 0);
455 * Allocate and free nfs_write_data structures
457 extern mempool_t
*nfs_wdata_mempool
;
459 static inline struct nfs_write_data
*nfs_writedata_alloc(unsigned int pagecount
)
461 struct nfs_write_data
*p
= mempool_alloc(nfs_wdata_mempool
, SLAB_NOFS
);
464 memset(p
, 0, sizeof(*p
));
465 INIT_LIST_HEAD(&p
->pages
);
466 if (pagecount
< NFS_PAGEVEC_SIZE
)
467 p
->pagevec
= &p
->page_array
[0];
469 size_t size
= ++pagecount
* sizeof(struct page
*);
470 p
->pagevec
= kmalloc(size
, GFP_NOFS
);
472 memset(p
->pagevec
, 0, size
);
474 mempool_free(p
, nfs_wdata_mempool
);
482 static inline void nfs_writedata_free(struct nfs_write_data
*p
)
484 if (p
&& (p
->pagevec
!= &p
->page_array
[0]))
486 mempool_free(p
, nfs_wdata_mempool
);
490 * linux/fs/nfs/read.c
492 extern int nfs_readpage(struct file
*, struct page
*);
493 extern int nfs_readpages(struct file
*, struct address_space
*,
494 struct list_head
*, unsigned);
495 extern void nfs_readpage_result(struct rpc_task
*, void *);
496 extern void nfs_readdata_release(void *data
);
500 * Allocate and free nfs_read_data structures
502 extern mempool_t
*nfs_rdata_mempool
;
504 static inline struct nfs_read_data
*nfs_readdata_alloc(unsigned int pagecount
)
506 struct nfs_read_data
*p
= mempool_alloc(nfs_rdata_mempool
, SLAB_NOFS
);
509 memset(p
, 0, sizeof(*p
));
510 INIT_LIST_HEAD(&p
->pages
);
511 if (pagecount
< NFS_PAGEVEC_SIZE
)
512 p
->pagevec
= &p
->page_array
[0];
514 size_t size
= ++pagecount
* sizeof(struct page
*);
515 p
->pagevec
= kmalloc(size
, GFP_NOFS
);
517 memset(p
->pagevec
, 0, size
);
519 mempool_free(p
, nfs_rdata_mempool
);
527 static inline void nfs_readdata_free(struct nfs_read_data
*p
)
529 if (p
&& (p
->pagevec
!= &p
->page_array
[0]))
531 mempool_free(p
, nfs_rdata_mempool
);
535 * linux/fs/nfs3proc.c
537 #ifdef CONFIG_NFS_V3_ACL
538 extern struct posix_acl
*nfs3_proc_getacl(struct inode
*inode
, int type
);
539 extern int nfs3_proc_setacl(struct inode
*inode
, int type
,
540 struct posix_acl
*acl
);
541 extern int nfs3_proc_set_default_acl(struct inode
*dir
, struct inode
*inode
,
543 extern void nfs3_forget_cached_acls(struct inode
*inode
);
545 static inline int nfs3_proc_set_default_acl(struct inode
*dir
,
552 static inline void nfs3_forget_cached_acls(struct inode
*inode
)
555 #endif /* CONFIG_NFS_V3_ACL */
558 * linux/fs/mount_clnt.c
559 * (Used only by nfsroot module)
561 extern int nfsroot_mount(struct sockaddr_in
*, char *, struct nfs_fh
*,
569 nfs_size_to_loff_t(__u64 size
)
571 loff_t maxsz
= (((loff_t
) ULONG_MAX
) << PAGE_CACHE_SHIFT
) + PAGE_CACHE_SIZE
- 1;
574 return (loff_t
) size
;
578 nfs_fileid_to_ino_t(u64 fileid
)
580 ino_t ino
= (ino_t
) fileid
;
581 if (sizeof(ino_t
) < sizeof(u64
))
582 ino
^= fileid
>> (sizeof(u64
)-sizeof(ino_t
)) * 8;
588 extern void * nfs_root_data(void);
590 #define nfs_wait_event(clnt, wq, condition) \
593 if (clnt->cl_intr) { \
595 rpc_clnt_sigmask(clnt, &oldmask); \
596 __retval = wait_event_interruptible(wq, condition); \
597 rpc_clnt_sigunmask(clnt, &oldmask); \
599 wait_event(wq, condition); \
603 #define NFS_JUKEBOX_RETRY_TIME (5 * HZ)
605 #endif /* __KERNEL__ */
610 #define NFSDBG_VFS 0x0001
611 #define NFSDBG_DIRCACHE 0x0002
612 #define NFSDBG_LOOKUPCACHE 0x0004
613 #define NFSDBG_PAGECACHE 0x0008
614 #define NFSDBG_PROC 0x0010
615 #define NFSDBG_XDR 0x0020
616 #define NFSDBG_FILE 0x0040
617 #define NFSDBG_ROOT 0x0080
618 #define NFSDBG_CALLBACK 0x0100
619 #define NFSDBG_ALL 0xFFFF
624 # define ifdebug(fac) if (unlikely(nfs_debug & NFSDBG_##fac))
626 # define ifdebug(fac) if (0)
628 #endif /* __KERNEL */