]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame_incremental - include/linux/nfs_fs.h
projects / mirror_ubuntu-artful-kernel.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
NFSv4.1: remove GETATTR from ds commits
[mirror_ubuntu-artful-kernel.git] / include / linux / nfs_fs.h
... / ...
CommitLineData
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#endif /* CONFIG_NFS_V4*/
202#ifdef CONFIG_NFS_FSCACHE
203 struct fscache_cookie *fscache;
204#endif
205 struct inode vfs_inode;
206};
207
208/*
209 * Cache validity bit flags
210 */
211#define NFS_INO_INVALID_ATTR 0x0001 /* cached attrs are invalid */
212#define NFS_INO_INVALID_DATA 0x0002 /* cached data is invalid */
213#define NFS_INO_INVALID_ATIME 0x0004 /* cached atime is invalid */
214#define NFS_INO_INVALID_ACCESS 0x0008 /* cached access cred invalid */
215#define NFS_INO_INVALID_ACL 0x0010 /* cached acls are invalid */
216#define NFS_INO_REVAL_PAGECACHE 0x0020 /* must revalidate pagecache */
217#define NFS_INO_REVAL_FORCED 0x0040 /* force revalidation ignoring a delegation */
218
219/*
220 * Bit offsets in flags field
221 */
222#define NFS_INO_ADVISE_RDPLUS (0) /* advise readdirplus */
223#define NFS_INO_STALE (1) /* possible stale inode */
224#define NFS_INO_ACL_LRU_SET (2) /* Inode is on the LRU list */
225#define NFS_INO_FLUSHING (4) /* inode is flushing out data */
226#define NFS_INO_FSCACHE (5) /* inode can be cached by FS-Cache */
227#define NFS_INO_FSCACHE_LOCK (6) /* FS-Cache cookie management lock */
228#define NFS_INO_COMMIT (7) /* inode is committing unstable writes */
229#define NFS_INO_PNFS_COMMIT (8) /* use pnfs code for commit */
230
231static inline struct nfs_inode *NFS_I(const struct inode *inode)
232{
233 return container_of(inode, struct nfs_inode, vfs_inode);
234}
235
236static inline struct nfs_server *NFS_SB(const struct super_block *s)
237{
238 return (struct nfs_server *)(s->s_fs_info);
239}
240
241static inline struct nfs_fh *NFS_FH(const struct inode *inode)
242{
243 return &NFS_I(inode)->fh;
244}
245
246static inline struct nfs_server *NFS_SERVER(const struct inode *inode)
247{
248 return NFS_SB(inode->i_sb);
249}
250
251static inline struct rpc_clnt *NFS_CLIENT(const struct inode *inode)
252{
253 return NFS_SERVER(inode)->client;
254}
255
256static inline const struct nfs_rpc_ops *NFS_PROTO(const struct inode *inode)
257{
258 return NFS_SERVER(inode)->nfs_client->rpc_ops;
259}
260
261static inline __be32 *NFS_COOKIEVERF(const struct inode *inode)
262{
263 return NFS_I(inode)->cookieverf;
264}
265
266static inline unsigned NFS_MINATTRTIMEO(const struct inode *inode)
267{
268 struct nfs_server *nfss = NFS_SERVER(inode);
269 return S_ISDIR(inode->i_mode) ? nfss->acdirmin : nfss->acregmin;
270}
271
272static inline unsigned NFS_MAXATTRTIMEO(const struct inode *inode)
273{
274 struct nfs_server *nfss = NFS_SERVER(inode);
275 return S_ISDIR(inode->i_mode) ? nfss->acdirmax : nfss->acregmax;
276}
277
278static inline int NFS_STALE(const struct inode *inode)
279{
280 return test_bit(NFS_INO_STALE, &NFS_I(inode)->flags);
281}
282
283static inline int NFS_FSCACHE(const struct inode *inode)
284{
285 return test_bit(NFS_INO_FSCACHE, &NFS_I(inode)->flags);
286}
287
288static inline __u64 NFS_FILEID(const struct inode *inode)
289{
290 return NFS_I(inode)->fileid;
291}
292
293static inline void set_nfs_fileid(struct inode *inode, __u64 fileid)
294{
295 NFS_I(inode)->fileid = fileid;
296}
297
298static inline void nfs_mark_for_revalidate(struct inode *inode)
299{
300 struct nfs_inode *nfsi = NFS_I(inode);
301
302 spin_lock(&inode->i_lock);
303 nfsi->cache_validity |= NFS_INO_INVALID_ATTR|NFS_INO_INVALID_ACCESS;
304 if (S_ISDIR(inode->i_mode))
305 nfsi->cache_validity |= NFS_INO_REVAL_PAGECACHE|NFS_INO_INVALID_DATA;
306 spin_unlock(&inode->i_lock);
307}
308
309static inline int nfs_server_capable(struct inode *inode, int cap)
310{
311 return NFS_SERVER(inode)->caps & cap;
312}
313
314static inline int NFS_USE_READDIRPLUS(struct inode *inode)
315{
316 return test_bit(NFS_INO_ADVISE_RDPLUS, &NFS_I(inode)->flags);
317}
318
319static inline void nfs_set_verifier(struct dentry * dentry, unsigned long verf)
320{
321 dentry->d_time = verf;
322}
323
324/**
325 * nfs_save_change_attribute - Returns the inode attribute change cookie
326 * @dir - pointer to parent directory inode
327 * The "change attribute" is updated every time we finish an operation
328 * that will result in a metadata change on the server.
329 */
330static inline unsigned long nfs_save_change_attribute(struct inode *dir)
331{
332 return NFS_I(dir)->cache_change_attribute;
333}
334
335/**
336 * nfs_verify_change_attribute - Detects NFS remote directory changes
337 * @dir - pointer to parent directory inode
338 * @chattr - previously saved change attribute
339 * Return "false" if the verifiers doesn't match the change attribute.
340 * This would usually indicate that the directory contents have changed on
341 * the server, and that any dentries need revalidating.
342 */
343static inline int nfs_verify_change_attribute(struct inode *dir, unsigned long chattr)
344{
345 return chattr == NFS_I(dir)->cache_change_attribute;
346}
347
348/*
349 * linux/fs/nfs/inode.c
350 */
351extern int nfs_sync_mapping(struct address_space *mapping);
352extern void nfs_zap_mapping(struct inode *inode, struct address_space *mapping);
353extern void nfs_zap_caches(struct inode *);
354extern void nfs_invalidate_atime(struct inode *);
355extern struct inode *nfs_fhget(struct super_block *, struct nfs_fh *,
356 struct nfs_fattr *);
357extern int nfs_refresh_inode(struct inode *, struct nfs_fattr *);
358extern int nfs_post_op_update_inode(struct inode *inode, struct nfs_fattr *fattr);
359extern int nfs_post_op_update_inode_force_wcc(struct inode *inode, struct nfs_fattr *fattr);
360extern int nfs_getattr(struct vfsmount *, struct dentry *, struct kstat *);
361extern int nfs_permission(struct inode *, int, unsigned int);
362extern int nfs_open(struct inode *, struct file *);
363extern int nfs_release(struct inode *, struct file *);
364extern int nfs_attribute_timeout(struct inode *inode);
365extern int nfs_revalidate_inode(struct nfs_server *server, struct inode *inode);
366extern int __nfs_revalidate_inode(struct nfs_server *, struct inode *);
367extern int nfs_revalidate_mapping(struct inode *inode, struct address_space *mapping);
368extern int nfs_setattr(struct dentry *, struct iattr *);
369extern void nfs_setattr_update_inode(struct inode *inode, struct iattr *attr);
370extern struct nfs_open_context *get_nfs_open_context(struct nfs_open_context *ctx);
371extern void put_nfs_open_context(struct nfs_open_context *ctx);
372extern struct nfs_open_context *nfs_find_open_context(struct inode *inode, struct rpc_cred *cred, fmode_t mode);
373extern struct nfs_open_context *alloc_nfs_open_context(struct path *path, struct rpc_cred *cred, fmode_t f_mode);
374extern void nfs_file_set_open_context(struct file *filp, struct nfs_open_context *ctx);
375extern struct nfs_lock_context *nfs_get_lock_context(struct nfs_open_context *ctx);
376extern void nfs_put_lock_context(struct nfs_lock_context *l_ctx);
377extern u64 nfs_compat_user_ino64(u64 fileid);
378extern void nfs_fattr_init(struct nfs_fattr *fattr);
379extern unsigned long nfs_inc_attr_generation_counter(void);
380
381extern struct nfs_fattr *nfs_alloc_fattr(void);
382
383static inline void nfs_free_fattr(const struct nfs_fattr *fattr)
384{
385 kfree(fattr);
386}
387
388extern struct nfs_fh *nfs_alloc_fhandle(void);
389
390static inline void nfs_free_fhandle(const struct nfs_fh *fh)
391{
392 kfree(fh);
393}
394
395/*
396 * linux/fs/nfs/nfsroot.c
397 */
398extern int nfs_root_data(char **root_device, char **root_data); /*__init*/
399/* linux/net/ipv4/ipconfig.c: trims ip addr off front of name, too. */
400extern __be32 root_nfs_parse_addr(char *name); /*__init*/
401
402/*
403 * linux/fs/nfs/file.c
404 */
405extern const struct inode_operations nfs_file_inode_operations;
406#ifdef CONFIG_NFS_V3
407extern const struct inode_operations nfs3_file_inode_operations;
408#endif /* CONFIG_NFS_V3 */
409extern const struct file_operations nfs_file_operations;
410extern const struct address_space_operations nfs_file_aops;
411extern const struct address_space_operations nfs_dir_aops;
412
413static inline struct nfs_open_context *nfs_file_open_context(struct file *filp)
414{
415 return filp->private_data;
416}
417
418static inline struct rpc_cred *nfs_file_cred(struct file *file)
419{
420 if (file != NULL) {
421 struct nfs_open_context *ctx =
422 nfs_file_open_context(file);
423 if (ctx)
424 return ctx->cred;
425 }
426 return NULL;
427}
428
429/*
430 * linux/fs/nfs/xattr.c
431 */
432#ifdef CONFIG_NFS_V3_ACL
433extern ssize_t nfs3_listxattr(struct dentry *, char *, size_t);
434extern ssize_t nfs3_getxattr(struct dentry *, const char *, void *, size_t);
435extern int nfs3_setxattr(struct dentry *, const char *,
436 const void *, size_t, int);
437extern int nfs3_removexattr (struct dentry *, const char *name);
438#else
439# define nfs3_listxattr NULL
440# define nfs3_getxattr NULL
441# define nfs3_setxattr NULL
442# define nfs3_removexattr NULL
443#endif
444
445/*
446 * linux/fs/nfs/direct.c
447 */
448extern ssize_t nfs_direct_IO(int, struct kiocb *, const struct iovec *, loff_t,
449 unsigned long);
450extern ssize_t nfs_file_direct_read(struct kiocb *iocb,
451 const struct iovec *iov, unsigned long nr_segs,
452 loff_t pos);
453extern ssize_t nfs_file_direct_write(struct kiocb *iocb,
454 const struct iovec *iov, unsigned long nr_segs,
455 loff_t pos);
456
457/*
458 * linux/fs/nfs/dir.c
459 */
460extern const struct inode_operations nfs_dir_inode_operations;
461#ifdef CONFIG_NFS_V3
462extern const struct inode_operations nfs3_dir_inode_operations;
463#endif /* CONFIG_NFS_V3 */
464extern const struct file_operations nfs_dir_operations;
465extern const struct dentry_operations nfs_dentry_operations;
466
467extern void nfs_force_lookup_revalidate(struct inode *dir);
468extern int nfs_instantiate(struct dentry *dentry, struct nfs_fh *fh, struct nfs_fattr *fattr);
469extern int nfs_may_open(struct inode *inode, struct rpc_cred *cred, int openflags);
470extern void nfs_access_zap_cache(struct inode *inode);
471
472/*
473 * linux/fs/nfs/symlink.c
474 */
475extern const struct inode_operations nfs_symlink_inode_operations;
476
477/*
478 * linux/fs/nfs/sysctl.c
479 */
480#ifdef CONFIG_SYSCTL
481extern int nfs_register_sysctl(void);
482extern void nfs_unregister_sysctl(void);
483#else
484#define nfs_register_sysctl() 0
485#define nfs_unregister_sysctl() do { } while(0)
486#endif
487
488/*
489 * linux/fs/nfs/namespace.c
490 */
491extern const struct inode_operations nfs_mountpoint_inode_operations;
492extern const struct inode_operations nfs_referral_inode_operations;
493extern int nfs_mountpoint_expiry_timeout;
494extern void nfs_release_automount_timer(void);
495
496/*
497 * linux/fs/nfs/unlink.c
498 */
499extern void nfs_complete_unlink(struct dentry *dentry, struct inode *);
500extern void nfs_block_sillyrename(struct dentry *dentry);
501extern void nfs_unblock_sillyrename(struct dentry *dentry);
502extern int nfs_sillyrename(struct inode *dir, struct dentry *dentry);
503
504/*
505 * linux/fs/nfs/write.c
506 */
507extern int nfs_congestion_kb;
508extern int nfs_writepage(struct page *page, struct writeback_control *wbc);
509extern int nfs_writepages(struct address_space *, struct writeback_control *);
510extern int nfs_flush_incompatible(struct file *file, struct page *page);
511extern int nfs_updatepage(struct file *, struct page *, unsigned int, unsigned int);
512extern void nfs_writeback_done(struct rpc_task *, struct nfs_write_data *);
513
514/*
515 * Try to write back everything synchronously (but check the
516 * return value!)
517 */
518extern int nfs_wb_all(struct inode *inode);
519extern int nfs_wb_page(struct inode *inode, struct page* page);
520extern int nfs_wb_page_cancel(struct inode *inode, struct page* page);
521#if defined(CONFIG_NFS_V3) || defined(CONFIG_NFS_V4)
522extern int nfs_commit_inode(struct inode *, int);
523extern struct nfs_write_data *nfs_commitdata_alloc(void);
524extern void nfs_commit_free(struct nfs_write_data *wdata);
525#else
526static inline int
527nfs_commit_inode(struct inode *inode, int how)
528{
529 return 0;
530}
531#endif
532
533static inline int
534nfs_have_writebacks(struct inode *inode)
535{
536 return NFS_I(inode)->npages != 0;
537}
538
539/*
540 * Allocate nfs_write_data structures
541 */
542extern struct nfs_write_data *nfs_writedata_alloc(unsigned int npages);
543extern void nfs_writedata_free(struct nfs_write_data *);
544
545/*
546 * linux/fs/nfs/read.c
547 */
548extern int nfs_readpage(struct file *, struct page *);
549extern int nfs_readpages(struct file *, struct address_space *,
550 struct list_head *, unsigned);
551extern int nfs_readpage_result(struct rpc_task *, struct nfs_read_data *);
552extern int nfs_readpage_async(struct nfs_open_context *, struct inode *,
553 struct page *);
554
555/*
556 * Allocate nfs_read_data structures
557 */
558extern struct nfs_read_data *nfs_readdata_alloc(unsigned int npages);
559extern void nfs_readdata_free(struct nfs_read_data *);
560
561/*
562 * linux/fs/nfs3proc.c
563 */
564#ifdef CONFIG_NFS_V3_ACL
565extern struct posix_acl *nfs3_proc_getacl(struct inode *inode, int type);
566extern int nfs3_proc_setacl(struct inode *inode, int type,
567 struct posix_acl *acl);
568extern int nfs3_proc_set_default_acl(struct inode *dir, struct inode *inode,
569 mode_t mode);
570extern void nfs3_forget_cached_acls(struct inode *inode);
571#else
572static inline int nfs3_proc_set_default_acl(struct inode *dir,
573 struct inode *inode,
574 mode_t mode)
575{
576 return 0;
577}
578
579static inline void nfs3_forget_cached_acls(struct inode *inode)
580{
581}
582#endif /* CONFIG_NFS_V3_ACL */
583
584/*
585 * inline functions
586 */
587
588static inline loff_t nfs_size_to_loff_t(__u64 size)
589{
590 if (size > (__u64) OFFSET_MAX - 1)
591 return OFFSET_MAX - 1;
592 return (loff_t) size;
593}
594
595static inline ino_t
596nfs_fileid_to_ino_t(u64 fileid)
597{
598 ino_t ino = (ino_t) fileid;
599 if (sizeof(ino_t) < sizeof(u64))
600 ino ^= fileid >> (sizeof(u64)-sizeof(ino_t)) * 8;
601 return ino;
602}
603
604#define NFS_JUKEBOX_RETRY_TIME (5 * HZ)
605
606#endif /* __KERNEL__ */
607
608/*
609 * NFS debug flags
610 */
611#define NFSDBG_VFS 0x0001
612#define NFSDBG_DIRCACHE 0x0002
613#define NFSDBG_LOOKUPCACHE 0x0004
614#define NFSDBG_PAGECACHE 0x0008
615#define NFSDBG_PROC 0x0010
616#define NFSDBG_XDR 0x0020
617#define NFSDBG_FILE 0x0040
618#define NFSDBG_ROOT 0x0080
619#define NFSDBG_CALLBACK 0x0100
620#define NFSDBG_CLIENT 0x0200
621#define NFSDBG_MOUNT 0x0400
622#define NFSDBG_FSCACHE 0x0800
623#define NFSDBG_PNFS 0x1000
624#define NFSDBG_PNFS_LD 0x2000
625#define NFSDBG_ALL 0xFFFF
626
627#ifdef __KERNEL__
628
629/*
630 * Enable debugging support for nfs client.
631 * Requires RPC_DEBUG.
632 */
633#ifdef RPC_DEBUG
634# define NFS_DEBUG
635#endif
636
637# undef ifdebug
638# ifdef NFS_DEBUG
639# define ifdebug(fac) if (unlikely(nfs_debug & NFSDBG_##fac))
640# else
641# define ifdebug(fac) if (0)
642# endif
643#endif /* __KERNEL */
644
645#endif
Ubuntu Artful kernel mirror