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