Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
1/*
2 * linux/include/linux/nfs_fs.h
3 *
4 * Copyright (C) 1992 Rick Sladkey
5 *
6 * OS-specific nfs filesystem definitions and declarations
7 */
8
9#ifndef _LINUX_NFS_FS_H
10#define _LINUX_NFS_FS_H
11
12#include <linux/magic.h>
13
14/* Default timeout values */
15#define NFS_DEF_UDP_TIMEO (11)
16#define NFS_DEF_UDP_RETRANS (3)
17#define NFS_DEF_TCP_TIMEO (600)
18#define NFS_DEF_TCP_RETRANS (2)
19
20#define NFS_MAX_UDP_TIMEOUT (60*HZ)
21#define NFS_MAX_TCP_TIMEOUT (600*HZ)
22
23#define NFS_DEF_ACREGMIN (3)
24#define NFS_DEF_ACREGMAX (60)
25#define NFS_DEF_ACDIRMIN (30)
26#define NFS_DEF_ACDIRMAX (60)
27
28/*
29 * When flushing a cluster of dirty pages, there can be different
30 * strategies:
31 */
32#define FLUSH_SYNC 1 /* file being synced, or contention */
33#define FLUSH_STABLE 4 /* commit to stable storage */
34#define FLUSH_LOWPRI 8 /* low priority background flush */
35#define FLUSH_HIGHPRI 16 /* high priority memory reclaim flush */
36#define FLUSH_COND_STABLE 32 /* conditional stable write - only stable
37 * if everything fits in one RPC */
38
39#ifdef __KERNEL__
40
41#include <linux/in.h>
42#include <linux/mm.h>
43#include <linux/pagemap.h>
44#include <linux/rbtree.h>
45#include <linux/rwsem.h>
46#include <linux/wait.h>
47
48#include <linux/sunrpc/debug.h>
49#include <linux/sunrpc/auth.h>
50#include <linux/sunrpc/clnt.h>
51
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>
57#include <linux/nfs_fs_sb.h>
58
59#include <linux/mempool.h>
60
61/*
62 * These are the default flags for swap requests
63 */
64#define NFS_RPC_SWAPFLAGS (RPC_TASK_SWAPPER|RPC_TASK_ROOTCREDS)
65
66/*
67 * NFSv3/v4 Access mode cache entry
68 */
69struct nfs_access_entry {
70 struct rb_node rb_node;
71 struct list_head lru;
72 unsigned long jiffies;
73 struct rpc_cred * cred;
74 int mask;
75};
76
77struct nfs_lock_context {
78 atomic_t count;
79 struct list_head list;
80 struct nfs_open_context *open_context;
81 fl_owner_t lockowner;
82 pid_t pid;
83};
84
85struct nfs4_state;
86struct nfs_open_context {
87 struct nfs_lock_context lock_context;
88 struct path path;
89 struct rpc_cred *cred;
90 struct nfs4_state *state;
91 fmode_t mode;
92
93 unsigned long flags;
94#define NFS_CONTEXT_ERROR_WRITE (0)
95 int error;
96
97 struct list_head list;
98};
99
100struct nfs_open_dir_context {
101 struct rpc_cred *cred;
102 __u64 dir_cookie;
103 __u64 dup_cookie;
104 int duped;
105};
106
107/*
108 * NFSv4 delegation
109 */
110struct nfs_delegation;
111
112struct posix_acl;
113
114/*
115 * nfs fs inode data in memory
116 */
117struct nfs_inode {
118 /*
119 * The 64bit 'inode number'
120 */
121 __u64 fileid;
122
123 /*
124 * NFS file handle
125 */
126 struct nfs_fh fh;
127
128 /*
129 * Various flags
130 */
131 unsigned long flags; /* atomic bit ops */
132 unsigned long cache_validity; /* bit mask */
133
134 /*
135 * read_cache_jiffies is when we started read-caching this inode.
136 * attrtimeo is for how long the cached information is assumed
137 * to be valid. A successful attribute revalidation doubles
138 * attrtimeo (up to acregmax/acdirmax), a failure resets it to
139 * acregmin/acdirmin.
140 *
141 * We need to revalidate the cached attrs for this inode if
142 *
143 * jiffies - read_cache_jiffies >= attrtimeo
144 *
145 * Please note the comparison is greater than or equal
146 * so that zero timeout values can be specified.
147 */
148 unsigned long read_cache_jiffies;
149 unsigned long attrtimeo;
150 unsigned long attrtimeo_timestamp;
151 __u64 change_attr; /* v4 only */
152
153 unsigned long attr_gencount;
154 /* "Generation counter" for the attribute cache. This is
155 * bumped whenever we update the metadata on the
156 * server.
157 */
158 unsigned long cache_change_attribute;
159
160 struct rb_root access_cache;
161 struct list_head access_cache_entry_lru;
162 struct list_head access_cache_inode_lru;
163#ifdef CONFIG_NFS_V3_ACL
164 struct posix_acl *acl_access;
165 struct posix_acl *acl_default;
166#endif
167
168 /*
169 * This is the cookie verifier used for NFSv3 readdir
170 * operations
171 */
172 __be32 cookieverf[2];
173
174 /*
175 * This is the list of dirty unwritten pages.
176 */
177 struct radix_tree_root nfs_page_tree;
178
179 unsigned long npages;
180 unsigned long ncommit;
181
182 /* Open contexts for shared mmap writes */
183 struct list_head open_files;
184
185 /* Number of in-flight sillydelete RPC calls */
186 atomic_t silly_count;
187 /* List of deferred sillydelete requests */
188 struct hlist_head silly_list;
189 wait_queue_head_t waitqueue;
190
191#ifdef CONFIG_NFS_V4
192 struct nfs4_cached_acl *nfs4_acl;
193 /* NFSv4 state */
194 struct list_head open_states;
195 struct nfs_delegation __rcu *delegation;
196 fmode_t delegation_state;
197 struct rw_semaphore rwsem;
198
199 /* pNFS layout information */
200 struct pnfs_layout_hdr *layout;
201 atomic_t commits_outstanding;
202#endif /* CONFIG_NFS_V4*/
203#ifdef CONFIG_NFS_FSCACHE
204 struct fscache_cookie *fscache;
205#endif
206 struct inode vfs_inode;
207};
208
209/*
210 * Cache validity bit flags
211 */
212#define NFS_INO_INVALID_ATTR 0x0001 /* cached attrs are invalid */
213#define NFS_INO_INVALID_DATA 0x0002 /* cached data is invalid */
214#define NFS_INO_INVALID_ATIME 0x0004 /* cached atime is invalid */
215#define NFS_INO_INVALID_ACCESS 0x0008 /* cached access cred invalid */
216#define NFS_INO_INVALID_ACL 0x0010 /* cached acls are invalid */
217#define NFS_INO_REVAL_PAGECACHE 0x0020 /* must revalidate pagecache */
218#define NFS_INO_REVAL_FORCED 0x0040 /* force revalidation ignoring a delegation */
219
220/*
221 * Bit offsets in flags field
222 */
223#define NFS_INO_ADVISE_RDPLUS (0) /* advise readdirplus */
224#define NFS_INO_STALE (1) /* possible stale inode */
225#define NFS_INO_ACL_LRU_SET (2) /* Inode is on the LRU list */
226#define NFS_INO_FLUSHING (4) /* inode is flushing out data */
227#define NFS_INO_FSCACHE (5) /* inode can be cached by FS-Cache */
228#define NFS_INO_FSCACHE_LOCK (6) /* FS-Cache cookie management lock */
229#define NFS_INO_COMMIT (7) /* inode is committing unstable writes */
230#define NFS_INO_PNFS_COMMIT (8) /* use pnfs code for commit */
231#define NFS_INO_LAYOUTCOMMIT (9) /* layoutcommit required */
232
233static inline struct nfs_inode *NFS_I(const struct inode *inode)
234{
235 return container_of(inode, struct nfs_inode, vfs_inode);
236}
237
238static inline struct nfs_server *NFS_SB(const struct super_block *s)
239{
240 return (struct nfs_server *)(s->s_fs_info);
241}
242
243static inline struct nfs_fh *NFS_FH(const struct inode *inode)
244{
245 return &NFS_I(inode)->fh;
246}
247
248static inline struct nfs_server *NFS_SERVER(const struct inode *inode)
249{
250 return NFS_SB(inode->i_sb);
251}
252
253static inline struct rpc_clnt *NFS_CLIENT(const struct inode *inode)
254{
255 return NFS_SERVER(inode)->client;
256}
257
258static inline const struct nfs_rpc_ops *NFS_PROTO(const struct inode *inode)
259{
260 return NFS_SERVER(inode)->nfs_client->rpc_ops;
261}
262
263static inline __be32 *NFS_COOKIEVERF(const struct inode *inode)
264{
265 return NFS_I(inode)->cookieverf;
266}
267
268static inline unsigned NFS_MINATTRTIMEO(const struct inode *inode)
269{
270 struct nfs_server *nfss = NFS_SERVER(inode);
271 return S_ISDIR(inode->i_mode) ? nfss->acdirmin : nfss->acregmin;
272}
273
274static inline unsigned NFS_MAXATTRTIMEO(const struct inode *inode)
275{
276 struct nfs_server *nfss = NFS_SERVER(inode);
277 return S_ISDIR(inode->i_mode) ? nfss->acdirmax : nfss->acregmax;
278}
279
280static inline int NFS_STALE(const struct inode *inode)
281{
282 return test_bit(NFS_INO_STALE, &NFS_I(inode)->flags);
283}
284
285static inline int NFS_FSCACHE(const struct inode *inode)
286{
287 return test_bit(NFS_INO_FSCACHE, &NFS_I(inode)->flags);
288}
289
290static inline __u64 NFS_FILEID(const struct inode *inode)
291{
292 return NFS_I(inode)->fileid;
293}
294
295static inline void set_nfs_fileid(struct inode *inode, __u64 fileid)
296{
297 NFS_I(inode)->fileid = fileid;
298}
299
300static inline void nfs_mark_for_revalidate(struct inode *inode)
301{
302 struct nfs_inode *nfsi = NFS_I(inode);
303
304 spin_lock(&inode->i_lock);
305 nfsi->cache_validity |= NFS_INO_INVALID_ATTR|NFS_INO_INVALID_ACCESS;
306 if (S_ISDIR(inode->i_mode))
307 nfsi->cache_validity |= NFS_INO_REVAL_PAGECACHE|NFS_INO_INVALID_DATA;
308 spin_unlock(&inode->i_lock);
309}
310
311static inline int nfs_server_capable(struct inode *inode, int cap)
312{
313 return NFS_SERVER(inode)->caps & cap;
314}
315
316static inline int NFS_USE_READDIRPLUS(struct inode *inode)
317{
318 return test_bit(NFS_INO_ADVISE_RDPLUS, &NFS_I(inode)->flags);
319}
320
321static inline void nfs_set_verifier(struct dentry * dentry, unsigned long verf)
322{
323 dentry->d_time = verf;
324}
325
326/**
327 * nfs_save_change_attribute - Returns the inode attribute change cookie
328 * @dir - pointer to parent directory inode
329 * The "change attribute" is updated every time we finish an operation
330 * that will result in a metadata change on the server.
331 */
332static inline unsigned long nfs_save_change_attribute(struct inode *dir)
333{
334 return NFS_I(dir)->cache_change_attribute;
335}
336
337/**
338 * nfs_verify_change_attribute - Detects NFS remote directory changes
339 * @dir - pointer to parent directory inode
340 * @chattr - previously saved change attribute
341 * Return "false" if the verifiers doesn't match the change attribute.
342 * This would usually indicate that the directory contents have changed on
343 * the server, and that any dentries need revalidating.
344 */
345static inline int nfs_verify_change_attribute(struct inode *dir, unsigned long chattr)
346{
347 return chattr == NFS_I(dir)->cache_change_attribute;
348}
349
350/*
351 * linux/fs/nfs/inode.c
352 */
353extern int nfs_sync_mapping(struct address_space *mapping);
354extern void nfs_zap_mapping(struct inode *inode, struct address_space *mapping);
355extern void nfs_zap_caches(struct inode *);
356extern void nfs_invalidate_atime(struct inode *);
357extern struct inode *nfs_fhget(struct super_block *, struct nfs_fh *,
358 struct nfs_fattr *);
359extern int nfs_refresh_inode(struct inode *, struct nfs_fattr *);
360extern int nfs_post_op_update_inode(struct inode *inode, struct nfs_fattr *fattr);
361extern int nfs_post_op_update_inode_force_wcc(struct inode *inode, struct nfs_fattr *fattr);
362extern int nfs_getattr(struct vfsmount *, struct dentry *, struct kstat *);
363extern int nfs_permission(struct inode *, int, unsigned int);
364extern int nfs_open(struct inode *, struct file *);
365extern int nfs_release(struct inode *, struct file *);
366extern int nfs_attribute_timeout(struct inode *inode);
367extern int nfs_revalidate_inode(struct nfs_server *server, struct inode *inode);
368extern int __nfs_revalidate_inode(struct nfs_server *, struct inode *);
369extern int nfs_revalidate_mapping(struct inode *inode, struct address_space *mapping);
370extern int nfs_setattr(struct dentry *, struct iattr *);
371extern void nfs_setattr_update_inode(struct inode *inode, struct iattr *attr);
372extern struct nfs_open_context *get_nfs_open_context(struct nfs_open_context *ctx);
373extern void put_nfs_open_context(struct nfs_open_context *ctx);
374extern struct nfs_open_context *nfs_find_open_context(struct inode *inode, struct rpc_cred *cred, fmode_t mode);
375extern struct nfs_open_context *alloc_nfs_open_context(struct path *path, struct rpc_cred *cred, fmode_t f_mode);
376extern void nfs_file_set_open_context(struct file *filp, struct nfs_open_context *ctx);
377extern struct nfs_lock_context *nfs_get_lock_context(struct nfs_open_context *ctx);
378extern void nfs_put_lock_context(struct nfs_lock_context *l_ctx);
379extern u64 nfs_compat_user_ino64(u64 fileid);
380extern void nfs_fattr_init(struct nfs_fattr *fattr);
381extern unsigned long nfs_inc_attr_generation_counter(void);
382
383extern struct nfs_fattr *nfs_alloc_fattr(void);
384
385static inline void nfs_free_fattr(const struct nfs_fattr *fattr)
386{
387 kfree(fattr);
388}
389
390extern struct nfs_fh *nfs_alloc_fhandle(void);
391
392static inline void nfs_free_fhandle(const struct nfs_fh *fh)
393{
394 kfree(fh);
395}
396
397/*
398 * linux/fs/nfs/nfsroot.c
399 */
400extern int nfs_root_data(char **root_device, char **root_data); /*__init*/
401/* linux/net/ipv4/ipconfig.c: trims ip addr off front of name, too. */
402extern __be32 root_nfs_parse_addr(char *name); /*__init*/
403
404/*
405 * linux/fs/nfs/file.c
406 */
407extern const struct inode_operations nfs_file_inode_operations;
408#ifdef CONFIG_NFS_V3
409extern const struct inode_operations nfs3_file_inode_operations;
410#endif /* CONFIG_NFS_V3 */
411extern const struct file_operations nfs_file_operations;
412extern const struct address_space_operations nfs_file_aops;
413extern const struct address_space_operations nfs_dir_aops;
414
415static inline struct nfs_open_context *nfs_file_open_context(struct file *filp)
416{
417 return filp->private_data;
418}
419
420static inline struct rpc_cred *nfs_file_cred(struct file *file)
421{
422 if (file != NULL) {
423 struct nfs_open_context *ctx =
424 nfs_file_open_context(file);
425 if (ctx)
426 return ctx->cred;
427 }
428 return NULL;
429}
430
431/*
432 * linux/fs/nfs/xattr.c
433 */
434#ifdef CONFIG_NFS_V3_ACL
435extern ssize_t nfs3_listxattr(struct dentry *, char *, size_t);
436extern ssize_t nfs3_getxattr(struct dentry *, const char *, void *, size_t);
437extern int nfs3_setxattr(struct dentry *, const char *,
438 const void *, size_t, int);
439extern int nfs3_removexattr (struct dentry *, const char *name);
440#else
441# define nfs3_listxattr NULL
442# define nfs3_getxattr NULL
443# define nfs3_setxattr NULL
444# define nfs3_removexattr NULL
445#endif
446
447/*
448 * linux/fs/nfs/direct.c
449 */
450extern ssize_t nfs_direct_IO(int, struct kiocb *, const struct iovec *, loff_t,
451 unsigned long);
452extern ssize_t nfs_file_direct_read(struct kiocb *iocb,
453 const struct iovec *iov, unsigned long nr_segs,
454 loff_t pos);
455extern ssize_t nfs_file_direct_write(struct kiocb *iocb,
456 const struct iovec *iov, unsigned long nr_segs,
457 loff_t pos);
458
459/*
460 * linux/fs/nfs/dir.c
461 */
462extern const struct inode_operations nfs_dir_inode_operations;
463#ifdef CONFIG_NFS_V3
464extern const struct inode_operations nfs3_dir_inode_operations;
465#endif /* CONFIG_NFS_V3 */
466extern const struct file_operations nfs_dir_operations;
467extern const struct dentry_operations nfs_dentry_operations;
468
469extern void nfs_force_lookup_revalidate(struct inode *dir);
470extern int nfs_instantiate(struct dentry *dentry, struct nfs_fh *fh, struct nfs_fattr *fattr);
471extern int nfs_may_open(struct inode *inode, struct rpc_cred *cred, int openflags);
472extern void nfs_access_zap_cache(struct inode *inode);
473
474/*
475 * linux/fs/nfs/symlink.c
476 */
477extern const struct inode_operations nfs_symlink_inode_operations;
478
479/*
480 * linux/fs/nfs/sysctl.c
481 */
482#ifdef CONFIG_SYSCTL
483extern int nfs_register_sysctl(void);
484extern void nfs_unregister_sysctl(void);
485#else
486#define nfs_register_sysctl() 0
487#define nfs_unregister_sysctl() do { } while(0)
488#endif
489
490/*
491 * linux/fs/nfs/namespace.c
492 */
493extern const struct inode_operations nfs_mountpoint_inode_operations;
494extern const struct inode_operations nfs_referral_inode_operations;
495extern int nfs_mountpoint_expiry_timeout;
496extern void nfs_release_automount_timer(void);
497
498/*
499 * linux/fs/nfs/unlink.c
500 */
501extern void nfs_complete_unlink(struct dentry *dentry, struct inode *);
502extern void nfs_block_sillyrename(struct dentry *dentry);
503extern void nfs_unblock_sillyrename(struct dentry *dentry);
504extern int nfs_sillyrename(struct inode *dir, struct dentry *dentry);
505
506/*
507 * linux/fs/nfs/write.c
508 */
509extern int nfs_congestion_kb;
510extern int nfs_writepage(struct page *page, struct writeback_control *wbc);
511extern int nfs_writepages(struct address_space *, struct writeback_control *);
512extern int nfs_flush_incompatible(struct file *file, struct page *page);
513extern int nfs_updatepage(struct file *, struct page *, unsigned int, unsigned int);
514extern void nfs_writeback_done(struct rpc_task *, struct nfs_write_data *);
515
516/*
517 * Try to write back everything synchronously (but check the
518 * return value!)
519 */
520extern int nfs_wb_all(struct inode *inode);
521extern int nfs_wb_page(struct inode *inode, struct page* page);
522extern int nfs_wb_page_cancel(struct inode *inode, struct page* page);
523#if defined(CONFIG_NFS_V3) || defined(CONFIG_NFS_V4)
524extern int nfs_commit_inode(struct inode *, int);
525extern struct nfs_write_data *nfs_commitdata_alloc(void);
526extern void nfs_commit_free(struct nfs_write_data *wdata);
527#else
528static inline int
529nfs_commit_inode(struct inode *inode, int how)
530{
531 return 0;
532}
533#endif
534
535static inline int
536nfs_have_writebacks(struct inode *inode)
537{
538 return NFS_I(inode)->npages != 0;
539}
540
541/*
542 * Allocate nfs_write_data structures
543 */
544extern struct nfs_write_data *nfs_writedata_alloc(unsigned int npages);
545extern void nfs_writedata_free(struct nfs_write_data *);
546
547/*
548 * linux/fs/nfs/read.c
549 */
550extern int nfs_readpage(struct file *, struct page *);
551extern int nfs_readpages(struct file *, struct address_space *,
552 struct list_head *, unsigned);
553extern int nfs_readpage_result(struct rpc_task *, struct nfs_read_data *);
554extern int nfs_readpage_async(struct nfs_open_context *, struct inode *,
555 struct page *);
556
557/*
558 * Allocate nfs_read_data structures
559 */
560extern struct nfs_read_data *nfs_readdata_alloc(unsigned int npages);
561extern void nfs_readdata_free(struct nfs_read_data *);
562
563/*
564 * linux/fs/nfs3proc.c
565 */
566#ifdef CONFIG_NFS_V3_ACL
567extern struct posix_acl *nfs3_proc_getacl(struct inode *inode, int type);
568extern int nfs3_proc_setacl(struct inode *inode, int type,
569 struct posix_acl *acl);
570extern int nfs3_proc_set_default_acl(struct inode *dir, struct inode *inode,
571 mode_t mode);
572extern void nfs3_forget_cached_acls(struct inode *inode);
573#else
574static inline int nfs3_proc_set_default_acl(struct inode *dir,
575 struct inode *inode,
576 mode_t mode)
577{
578 return 0;
579}
580
581static inline void nfs3_forget_cached_acls(struct inode *inode)
582{
583}
584#endif /* CONFIG_NFS_V3_ACL */
585
586/*
587 * inline functions
588 */
589
590static inline loff_t nfs_size_to_loff_t(__u64 size)
591{
592 if (size > (__u64) OFFSET_MAX - 1)
593 return OFFSET_MAX - 1;
594 return (loff_t) size;
595}
596
597static inline ino_t
598nfs_fileid_to_ino_t(u64 fileid)
599{
600 ino_t ino = (ino_t) fileid;
601 if (sizeof(ino_t) < sizeof(u64))
602 ino ^= fileid >> (sizeof(u64)-sizeof(ino_t)) * 8;
603 return ino;
604}
605
606#define NFS_JUKEBOX_RETRY_TIME (5 * HZ)
607
608#endif /* __KERNEL__ */
609
610/*
611 * NFS debug flags
612 */
613#define NFSDBG_VFS 0x0001
614#define NFSDBG_DIRCACHE 0x0002
615#define NFSDBG_LOOKUPCACHE 0x0004
616#define NFSDBG_PAGECACHE 0x0008
617#define NFSDBG_PROC 0x0010
618#define NFSDBG_XDR 0x0020
619#define NFSDBG_FILE 0x0040
620#define NFSDBG_ROOT 0x0080
621#define NFSDBG_CALLBACK 0x0100
622#define NFSDBG_CLIENT 0x0200
623#define NFSDBG_MOUNT 0x0400
624#define NFSDBG_FSCACHE 0x0800
625#define NFSDBG_PNFS 0x1000
626#define NFSDBG_PNFS_LD 0x2000
627#define NFSDBG_ALL 0xFFFF
628
629#ifdef __KERNEL__
630
631/*
632 * Enable debugging support for nfs client.
633 * Requires RPC_DEBUG.
634 */
635#ifdef RPC_DEBUG
636# define NFS_DEBUG
637#endif
638
639# undef ifdebug
640# ifdef NFS_DEBUG
641# define ifdebug(fac) if (unlikely(nfs_debug & NFSDBG_##fac))
642# else
643# define ifdebug(fac) if (0)
644# endif
645#endif /* __KERNEL */
646
647#endif