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
14 * Enable debugging support for nfs client.
21 /* Default timeout values */
22 #define NFS_MAX_UDP_TIMEOUT (60*HZ)
23 #define NFS_MAX_TCP_TIMEOUT (600*HZ)
26 * superblock magic number for NFS
28 #define NFS_SUPER_MAGIC 0x6969
31 * These are the default flags for swap requests
33 #define NFS_RPC_SWAPFLAGS (RPC_TASK_SWAPPER|RPC_TASK_ROOTCREDS)
36 * When flushing a cluster of dirty pages, there can be different
39 #define FLUSH_SYNC 1 /* file being synced, or contention */
40 #define FLUSH_STABLE 4 /* commit to stable storage */
41 #define FLUSH_LOWPRI 8 /* low priority background flush */
42 #define FLUSH_HIGHPRI 16 /* high priority memory reclaim flush */
43 #define FLUSH_NOCOMMIT 32 /* Don't send the NFSv3/v4 COMMIT */
48 #include <linux/pagemap.h>
49 #include <linux/rwsem.h>
50 #include <linux/wait.h>
52 #include <linux/nfs_fs_sb.h>
54 #include <linux/sunrpc/debug.h>
55 #include <linux/sunrpc/auth.h>
56 #include <linux/sunrpc/clnt.h>
58 #include <linux/nfs.h>
59 #include <linux/nfs2.h>
60 #include <linux/nfs3.h>
61 #include <linux/nfs4.h>
62 #include <linux/nfs_xdr.h>
63 #include <linux/rwsem.h>
64 #include <linux/mempool.h>
67 * NFSv3/v4 Access mode cache entry
69 struct nfs_access_entry
{
70 unsigned long jiffies
;
71 struct rpc_cred
* cred
;
76 struct nfs_open_context
{
78 struct vfsmount
*vfsmnt
;
79 struct dentry
*dentry
;
80 struct rpc_cred
*cred
;
81 struct nfs4_state
*state
;
86 struct list_head list
;
94 struct nfs_delegation
;
99 * nfs fs inode data in memory
103 * The 64bit 'inode number'
115 unsigned long flags
; /* atomic bit ops */
116 unsigned long cache_validity
; /* bit mask */
119 * read_cache_jiffies is when we started read-caching this inode.
120 * attrtimeo is for how long the cached information is assumed
121 * to be valid. A successful attribute revalidation doubles
122 * attrtimeo (up to acregmax/acdirmax), a failure resets it to
125 * We need to revalidate the cached attrs for this inode if
127 * jiffies - read_cache_jiffies > attrtimeo
129 unsigned long read_cache_jiffies
;
130 unsigned long attrtimeo
;
131 unsigned long attrtimeo_timestamp
;
132 __u64 change_attr
; /* v4 only */
134 unsigned long last_updated
;
135 /* "Generation counter" for the attribute cache. This is
136 * bumped whenever we update the metadata on the
139 unsigned long cache_change_attribute
;
141 * Counter indicating the number of outstanding requests that
142 * will cause a file data update.
144 atomic_t data_updates
;
146 struct nfs_access_entry cache_access
;
147 #ifdef CONFIG_NFS_V3_ACL
148 struct posix_acl
*acl_access
;
149 struct posix_acl
*acl_default
;
153 * This is the cookie verifier used for NFSv3 readdir
159 * This is the list of dirty unwritten pages.
162 struct list_head dirty
;
163 struct list_head commit
;
164 struct radix_tree_root nfs_page_tree
;
170 /* Open contexts for shared mmap writes */
171 struct list_head open_files
;
174 struct nfs4_cached_acl
*nfs4_acl
;
176 struct list_head open_states
;
177 struct nfs_delegation
*delegation
;
178 int delegation_state
;
179 struct rw_semaphore rwsem
;
180 #endif /* CONFIG_NFS_V4*/
181 struct inode vfs_inode
;
185 * Cache validity bit flags
187 #define NFS_INO_INVALID_ATTR 0x0001 /* cached attrs are invalid */
188 #define NFS_INO_INVALID_DATA 0x0002 /* cached data is invalid */
189 #define NFS_INO_INVALID_ATIME 0x0004 /* cached atime is invalid */
190 #define NFS_INO_INVALID_ACCESS 0x0008 /* cached access cred invalid */
191 #define NFS_INO_INVALID_ACL 0x0010 /* cached acls are invalid */
192 #define NFS_INO_REVAL_PAGECACHE 0x0020 /* must revalidate pagecache */
195 * Bit offsets in flags field
197 #define NFS_INO_REVALIDATING (0) /* revalidating attrs */
198 #define NFS_INO_ADVISE_RDPLUS (1) /* advise readdirplus */
199 #define NFS_INO_STALE (2) /* possible stale inode */
201 static inline struct nfs_inode
*NFS_I(struct inode
*inode
)
203 return container_of(inode
, struct nfs_inode
, vfs_inode
);
205 #define NFS_SB(s) ((struct nfs_server *)(s->s_fs_info))
207 #define NFS_FH(inode) (&NFS_I(inode)->fh)
208 #define NFS_SERVER(inode) (NFS_SB(inode->i_sb))
209 #define NFS_CLIENT(inode) (NFS_SERVER(inode)->client)
210 #define NFS_PROTO(inode) (NFS_SERVER(inode)->rpc_ops)
211 #define NFS_ADDR(inode) (RPC_PEERADDR(NFS_CLIENT(inode)))
212 #define NFS_COOKIEVERF(inode) (NFS_I(inode)->cookieverf)
213 #define NFS_READTIME(inode) (NFS_I(inode)->read_cache_jiffies)
214 #define NFS_CHANGE_ATTR(inode) (NFS_I(inode)->change_attr)
215 #define NFS_ATTRTIMEO(inode) (NFS_I(inode)->attrtimeo)
216 #define NFS_MINATTRTIMEO(inode) \
217 (S_ISDIR(inode->i_mode)? NFS_SERVER(inode)->acdirmin \
218 : NFS_SERVER(inode)->acregmin)
219 #define NFS_MAXATTRTIMEO(inode) \
220 (S_ISDIR(inode->i_mode)? NFS_SERVER(inode)->acdirmax \
221 : NFS_SERVER(inode)->acregmax)
222 #define NFS_ATTRTIMEO_UPDATE(inode) (NFS_I(inode)->attrtimeo_timestamp)
224 #define NFS_FLAGS(inode) (NFS_I(inode)->flags)
225 #define NFS_STALE(inode) (test_bit(NFS_INO_STALE, &NFS_FLAGS(inode)))
227 #define NFS_FILEID(inode) (NFS_I(inode)->fileid)
229 static inline int nfs_caches_unstable(struct inode
*inode
)
231 return atomic_read(&NFS_I(inode
)->data_updates
) != 0;
234 static inline void nfs_mark_for_revalidate(struct inode
*inode
)
236 spin_lock(&inode
->i_lock
);
237 NFS_I(inode
)->cache_validity
|= NFS_INO_INVALID_ATTR
| NFS_INO_INVALID_ACCESS
;
238 spin_unlock(&inode
->i_lock
);
241 static inline void NFS_CACHEINV(struct inode
*inode
)
243 if (!nfs_caches_unstable(inode
))
244 nfs_mark_for_revalidate(inode
);
247 static inline int nfs_server_capable(struct inode
*inode
, int cap
)
249 return NFS_SERVER(inode
)->caps
& cap
;
252 static inline int NFS_USE_READDIRPLUS(struct inode
*inode
)
254 return test_bit(NFS_INO_ADVISE_RDPLUS
, &NFS_FLAGS(inode
));
258 * nfs_save_change_attribute - Returns the inode attribute change cookie
259 * @inode - pointer to inode
260 * The "change attribute" is updated every time we finish an operation
261 * that will result in a metadata change on the server.
263 static inline long nfs_save_change_attribute(struct inode
*inode
)
265 return NFS_I(inode
)->cache_change_attribute
;
269 * nfs_verify_change_attribute - Detects NFS inode cache updates
270 * @inode - pointer to inode
271 * @chattr - previously saved change attribute
272 * Return "false" if metadata has been updated (or is in the process of
273 * being updated) since the change attribute was saved.
275 static inline int nfs_verify_change_attribute(struct inode
*inode
, unsigned long chattr
)
277 return !nfs_caches_unstable(inode
)
278 && time_after_eq(chattr
, NFS_I(inode
)->cache_change_attribute
);
282 * linux/fs/nfs/inode.c
284 extern int nfs_sync_mapping(struct address_space
*mapping
);
285 extern void nfs_zap_caches(struct inode
*);
286 extern struct inode
*nfs_fhget(struct super_block
*, struct nfs_fh
*,
288 extern int nfs_refresh_inode(struct inode
*, struct nfs_fattr
*);
289 extern int nfs_post_op_update_inode(struct inode
*inode
, struct nfs_fattr
*fattr
);
290 extern int nfs_getattr(struct vfsmount
*, struct dentry
*, struct kstat
*);
291 extern int nfs_permission(struct inode
*, int, struct nameidata
*);
292 extern int nfs_access_get_cached(struct inode
*, struct rpc_cred
*, struct nfs_access_entry
*);
293 extern void nfs_access_add_cache(struct inode
*, struct nfs_access_entry
*);
294 extern int nfs_open(struct inode
*, struct file
*);
295 extern int nfs_release(struct inode
*, struct file
*);
296 extern int nfs_attribute_timeout(struct inode
*inode
);
297 extern int nfs_revalidate_inode(struct nfs_server
*server
, struct inode
*inode
);
298 extern int __nfs_revalidate_inode(struct nfs_server
*, struct inode
*);
299 extern void nfs_revalidate_mapping(struct inode
*inode
, struct address_space
*mapping
);
300 extern int nfs_setattr(struct dentry
*, struct iattr
*);
301 extern void nfs_setattr_update_inode(struct inode
*inode
, struct iattr
*attr
);
302 extern void nfs_begin_attr_update(struct inode
*);
303 extern void nfs_end_attr_update(struct inode
*);
304 extern void nfs_begin_data_update(struct inode
*);
305 extern void nfs_end_data_update(struct inode
*);
306 extern struct nfs_open_context
*get_nfs_open_context(struct nfs_open_context
*ctx
);
307 extern void put_nfs_open_context(struct nfs_open_context
*ctx
);
308 extern struct nfs_open_context
*nfs_find_open_context(struct inode
*inode
, struct rpc_cred
*cred
, int mode
);
310 /* linux/net/ipv4/ipconfig.c: trims ip addr off front of name, too. */
311 extern u32
root_nfs_parse_addr(char *name
); /*__init*/
313 static inline void nfs_fattr_init(struct nfs_fattr
*fattr
)
316 fattr
->time_start
= jiffies
;
320 * linux/fs/nfs/file.c
322 extern struct inode_operations nfs_file_inode_operations
;
324 extern struct inode_operations nfs3_file_inode_operations
;
325 #endif /* CONFIG_NFS_V3 */
326 extern const struct file_operations nfs_file_operations
;
327 extern struct address_space_operations nfs_file_aops
;
329 static inline struct rpc_cred
*nfs_file_cred(struct file
*file
)
332 struct nfs_open_context
*ctx
;
334 ctx
= (struct nfs_open_context
*)file
->private_data
;
341 * linux/fs/nfs/xattr.c
343 #ifdef CONFIG_NFS_V3_ACL
344 extern ssize_t
nfs3_listxattr(struct dentry
*, char *, size_t);
345 extern ssize_t
nfs3_getxattr(struct dentry
*, const char *, void *, size_t);
346 extern int nfs3_setxattr(struct dentry
*, const char *,
347 const void *, size_t, int);
348 extern int nfs3_removexattr (struct dentry
*, const char *name
);
350 # define nfs3_listxattr NULL
351 # define nfs3_getxattr NULL
352 # define nfs3_setxattr NULL
353 # define nfs3_removexattr NULL
357 * linux/fs/nfs/direct.c
359 extern ssize_t
nfs_direct_IO(int, struct kiocb
*, const struct iovec
*, loff_t
,
361 extern ssize_t
nfs_file_direct_read(struct kiocb
*iocb
, char __user
*buf
,
362 size_t count
, loff_t pos
);
363 extern ssize_t
nfs_file_direct_write(struct kiocb
*iocb
, const char __user
*buf
,
364 size_t count
, loff_t pos
);
369 extern struct inode_operations nfs_dir_inode_operations
;
371 extern struct inode_operations nfs3_dir_inode_operations
;
372 #endif /* CONFIG_NFS_V3 */
373 extern const struct file_operations nfs_dir_operations
;
374 extern struct dentry_operations nfs_dentry_operations
;
376 extern int nfs_instantiate(struct dentry
*dentry
, struct nfs_fh
*fh
, struct nfs_fattr
*fattr
);
379 * linux/fs/nfs/symlink.c
381 extern struct inode_operations nfs_symlink_inode_operations
;
384 * linux/fs/nfs/sysctl.c
387 extern int nfs_register_sysctl(void);
388 extern void nfs_unregister_sysctl(void);
390 #define nfs_register_sysctl() 0
391 #define nfs_unregister_sysctl() do { } while(0)
395 * linux/fs/nfs/unlink.c
397 extern int nfs_async_unlink(struct dentry
*);
398 extern void nfs_complete_unlink(struct dentry
*);
401 * linux/fs/nfs/write.c
403 extern int nfs_writepage(struct page
*page
, struct writeback_control
*wbc
);
404 extern int nfs_writepages(struct address_space
*, struct writeback_control
*);
405 extern int nfs_flush_incompatible(struct file
*file
, struct page
*page
);
406 extern int nfs_updatepage(struct file
*, struct page
*, unsigned int, unsigned int);
407 extern int nfs_writeback_done(struct rpc_task
*, struct nfs_write_data
*);
408 extern void nfs_writedata_release(void *);
410 #if defined(CONFIG_NFS_V3) || defined(CONFIG_NFS_V4)
411 struct nfs_write_data
*nfs_commit_alloc(unsigned int pagecount
);
412 void nfs_commit_free(struct nfs_write_data
*p
);
416 * Try to write back everything synchronously (but check the
419 extern int nfs_sync_inode_wait(struct inode
*, unsigned long, unsigned int, int);
420 #if defined(CONFIG_NFS_V3) || defined(CONFIG_NFS_V4)
421 extern int nfs_commit_inode(struct inode
*, int);
422 extern void nfs_commit_release(void *wdata
);
425 nfs_commit_inode(struct inode
*inode
, int how
)
432 nfs_have_writebacks(struct inode
*inode
)
434 return NFS_I(inode
)->npages
!= 0;
438 nfs_wb_all(struct inode
*inode
)
440 int error
= nfs_sync_inode_wait(inode
, 0, 0, 0);
441 return (error
< 0) ? error
: 0;
445 * Write back all requests on one page - we do this before reading it.
447 static inline int nfs_wb_page_priority(struct inode
*inode
, struct page
* page
, int how
)
449 int error
= nfs_sync_inode_wait(inode
, page
->index
, 1,
451 return (error
< 0) ? error
: 0;
454 static inline int nfs_wb_page(struct inode
*inode
, struct page
* page
)
456 return nfs_wb_page_priority(inode
, page
, 0);
460 * Allocate and free nfs_write_data structures
462 extern struct nfs_write_data
*nfs_writedata_alloc(unsigned int pagecount
);
463 extern void nfs_writedata_free(struct nfs_write_data
*p
);
466 * linux/fs/nfs/read.c
468 extern int nfs_readpage(struct file
*, struct page
*);
469 extern int nfs_readpages(struct file
*, struct address_space
*,
470 struct list_head
*, unsigned);
471 extern int nfs_readpage_result(struct rpc_task
*, struct nfs_read_data
*);
472 extern void nfs_readdata_release(void *data
);
475 * Allocate and free nfs_read_data structures
477 extern struct nfs_read_data
*nfs_readdata_alloc(unsigned int pagecount
);
478 extern void nfs_readdata_free(struct nfs_read_data
*p
);
481 * linux/fs/nfs3proc.c
483 #ifdef CONFIG_NFS_V3_ACL
484 extern struct posix_acl
*nfs3_proc_getacl(struct inode
*inode
, int type
);
485 extern int nfs3_proc_setacl(struct inode
*inode
, int type
,
486 struct posix_acl
*acl
);
487 extern int nfs3_proc_set_default_acl(struct inode
*dir
, struct inode
*inode
,
489 extern void nfs3_forget_cached_acls(struct inode
*inode
);
491 static inline int nfs3_proc_set_default_acl(struct inode
*dir
,
498 static inline void nfs3_forget_cached_acls(struct inode
*inode
)
501 #endif /* CONFIG_NFS_V3_ACL */
504 * linux/fs/mount_clnt.c
505 * (Used only by nfsroot module)
507 extern int nfsroot_mount(struct sockaddr_in
*, char *, struct nfs_fh
*,
515 nfs_size_to_loff_t(__u64 size
)
517 loff_t maxsz
= (((loff_t
) ULONG_MAX
) << PAGE_CACHE_SHIFT
) + PAGE_CACHE_SIZE
- 1;
520 return (loff_t
) size
;
524 nfs_fileid_to_ino_t(u64 fileid
)
526 ino_t ino
= (ino_t
) fileid
;
527 if (sizeof(ino_t
) < sizeof(u64
))
528 ino
^= fileid
>> (sizeof(u64
)-sizeof(ino_t
)) * 8;
534 extern void * nfs_root_data(void);
536 #define nfs_wait_event(clnt, wq, condition) \
539 if (clnt->cl_intr) { \
541 rpc_clnt_sigmask(clnt, &oldmask); \
542 __retval = wait_event_interruptible(wq, condition); \
543 rpc_clnt_sigunmask(clnt, &oldmask); \
545 wait_event(wq, condition); \
549 #define NFS_JUKEBOX_RETRY_TIME (5 * HZ)
551 #endif /* __KERNEL__ */
556 #define NFSDBG_VFS 0x0001
557 #define NFSDBG_DIRCACHE 0x0002
558 #define NFSDBG_LOOKUPCACHE 0x0004
559 #define NFSDBG_PAGECACHE 0x0008
560 #define NFSDBG_PROC 0x0010
561 #define NFSDBG_XDR 0x0020
562 #define NFSDBG_FILE 0x0040
563 #define NFSDBG_ROOT 0x0080
564 #define NFSDBG_CALLBACK 0x0100
565 #define NFSDBG_ALL 0xFFFF
570 # define ifdebug(fac) if (unlikely(nfs_debug & NFSDBG_##fac))
572 # define ifdebug(fac) if (0)
574 #endif /* __KERNEL */