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