]> git.karo-electronics.de Git - karo-tx-linux.git/blob - include/linux/nfs_fs.h
18fb16f4b9393dd7c97e90df9ed3cd385dda8225
[karo-tx-linux.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 #ifndef _LINUX_NFS_FS_H
9 #define _LINUX_NFS_FS_H
10
11 #include <uapi/linux/nfs_fs.h>
12
13
14 /*
15  * Enable dprintk() debugging support for nfs client.
16  */
17 #ifdef CONFIG_NFS_DEBUG
18 # define NFS_DEBUG
19 #endif
20
21 #include <linux/in.h>
22 #include <linux/mm.h>
23 #include <linux/pagemap.h>
24 #include <linux/rbtree.h>
25 #include <linux/rwsem.h>
26 #include <linux/wait.h>
27
28 #include <linux/sunrpc/debug.h>
29 #include <linux/sunrpc/auth.h>
30 #include <linux/sunrpc/clnt.h>
31
32 #include <linux/nfs.h>
33 #include <linux/nfs2.h>
34 #include <linux/nfs3.h>
35 #include <linux/nfs4.h>
36 #include <linux/nfs_xdr.h>
37 #include <linux/nfs_fs_sb.h>
38
39 #include <linux/mempool.h>
40
41 /*
42  * These are the default flags for swap requests
43  */
44 #define NFS_RPC_SWAPFLAGS               (RPC_TASK_SWAPPER|RPC_TASK_ROOTCREDS)
45
46 /*
47  * NFSv3/v4 Access mode cache entry
48  */
49 struct nfs_access_entry {
50         struct rb_node          rb_node;
51         struct list_head        lru;
52         unsigned long           jiffies;
53         struct rpc_cred *       cred;
54         int                     mask;
55 };
56
57 struct nfs_lockowner {
58         fl_owner_t l_owner;
59         pid_t l_pid;
60 };
61
62 #define NFS_IO_INPROGRESS 0
63 struct nfs_io_counter {
64         unsigned long flags;
65         atomic_t io_count;
66 };
67
68 struct nfs_lock_context {
69         atomic_t count;
70         struct list_head list;
71         struct nfs_open_context *open_context;
72         struct nfs_lockowner lockowner;
73         struct nfs_io_counter io_count;
74 };
75
76 struct nfs4_state;
77 struct nfs_open_context {
78         struct nfs_lock_context lock_context;
79         struct dentry *dentry;
80         struct rpc_cred *cred;
81         struct nfs4_state *state;
82         fmode_t mode;
83
84         unsigned long flags;
85 #define NFS_CONTEXT_ERROR_WRITE         (0)
86 #define NFS_CONTEXT_RESEND_WRITES       (1)
87 #define NFS_CONTEXT_BAD                 (2)
88         int error;
89
90         struct list_head list;
91         struct nfs4_threshold   *mdsthreshold;
92 };
93
94 struct nfs_open_dir_context {
95         struct rpc_cred *cred;
96         unsigned long attr_gencount;
97         __u64 dir_cookie;
98         __u64 dup_cookie;
99         signed char duped;
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
147         unsigned long           attr_gencount;
148         /* "Generation counter" for the attribute cache. This is
149          * bumped whenever we update the metadata on the
150          * server.
151          */
152         unsigned long           cache_change_attribute;
153
154         struct rb_root          access_cache;
155         struct list_head        access_cache_entry_lru;
156         struct list_head        access_cache_inode_lru;
157 #ifdef CONFIG_NFS_V3_ACL
158         struct posix_acl        *acl_access;
159         struct posix_acl        *acl_default;
160 #endif
161
162         /*
163          * This is the cookie verifier used for NFSv3 readdir
164          * operations
165          */
166         __be32                  cookieverf[2];
167
168         unsigned long           npages;
169         struct nfs_mds_commit_info commit_info;
170
171         /* Open contexts for shared mmap writes */
172         struct list_head        open_files;
173
174         /* Number of in-flight sillydelete RPC calls */
175         atomic_t                silly_count;
176         /* List of deferred sillydelete requests */
177         struct hlist_head       silly_list;
178         wait_queue_head_t       waitqueue;
179
180 #if IS_ENABLED(CONFIG_NFS_V4)
181         struct nfs4_cached_acl  *nfs4_acl;
182         /* NFSv4 state */
183         struct list_head        open_states;
184         struct nfs_delegation __rcu *delegation;
185         fmode_t                  delegation_state;
186         struct rw_semaphore     rwsem;
187
188         /* pNFS layout information */
189         struct pnfs_layout_hdr *layout;
190 #endif /* CONFIG_NFS_V4*/
191         /* how many bytes have been written/read and how many bytes queued up */
192         __u64 write_io;
193         __u64 read_io;
194 #ifdef CONFIG_NFS_FSCACHE
195         struct fscache_cookie   *fscache;
196 #endif
197         struct inode            vfs_inode;
198 };
199
200 /*
201  * Cache validity bit flags
202  */
203 #define NFS_INO_INVALID_ATTR    0x0001          /* cached attrs are invalid */
204 #define NFS_INO_INVALID_DATA    0x0002          /* cached data is invalid */
205 #define NFS_INO_INVALID_ATIME   0x0004          /* cached atime is invalid */
206 #define NFS_INO_INVALID_ACCESS  0x0008          /* cached access cred invalid */
207 #define NFS_INO_INVALID_ACL     0x0010          /* cached acls are invalid */
208 #define NFS_INO_REVAL_PAGECACHE 0x0020          /* must revalidate pagecache */
209 #define NFS_INO_REVAL_FORCED    0x0040          /* force revalidation ignoring a delegation */
210 #define NFS_INO_INVALID_LABEL   0x0080          /* cached label is invalid */
211
212 /*
213  * Bit offsets in flags field
214  */
215 #define NFS_INO_ADVISE_RDPLUS   (0)             /* advise readdirplus */
216 #define NFS_INO_STALE           (1)             /* possible stale inode */
217 #define NFS_INO_ACL_LRU_SET     (2)             /* Inode is on the LRU list */
218 #define NFS_INO_INVALIDATING    (3)             /* inode is being invalidated */
219 #define NFS_INO_FLUSHING        (4)             /* inode is flushing out data */
220 #define NFS_INO_FSCACHE         (5)             /* inode can be cached by FS-Cache */
221 #define NFS_INO_FSCACHE_LOCK    (6)             /* FS-Cache cookie management lock */
222 #define NFS_INO_COMMIT          (7)             /* inode is committing unstable writes */
223 #define NFS_INO_LAYOUTCOMMIT    (9)             /* layoutcommit required */
224 #define NFS_INO_LAYOUTCOMMITTING (10)           /* layoutcommit inflight */
225
226 static inline struct nfs_inode *NFS_I(const struct inode *inode)
227 {
228         return container_of(inode, struct nfs_inode, vfs_inode);
229 }
230
231 static inline struct nfs_server *NFS_SB(const struct super_block *s)
232 {
233         return (struct nfs_server *)(s->s_fs_info);
234 }
235
236 static inline struct nfs_fh *NFS_FH(const struct inode *inode)
237 {
238         return &NFS_I(inode)->fh;
239 }
240
241 static inline struct nfs_server *NFS_SERVER(const struct inode *inode)
242 {
243         return NFS_SB(inode->i_sb);
244 }
245
246 static inline struct rpc_clnt *NFS_CLIENT(const struct inode *inode)
247 {
248         return NFS_SERVER(inode)->client;
249 }
250
251 static inline const struct nfs_rpc_ops *NFS_PROTO(const struct inode *inode)
252 {
253         return NFS_SERVER(inode)->nfs_client->rpc_ops;
254 }
255
256 static inline unsigned NFS_MINATTRTIMEO(const struct inode *inode)
257 {
258         struct nfs_server *nfss = NFS_SERVER(inode);
259         return S_ISDIR(inode->i_mode) ? nfss->acdirmin : nfss->acregmin;
260 }
261
262 static inline unsigned NFS_MAXATTRTIMEO(const struct inode *inode)
263 {
264         struct nfs_server *nfss = NFS_SERVER(inode);
265         return S_ISDIR(inode->i_mode) ? nfss->acdirmax : nfss->acregmax;
266 }
267
268 static inline int NFS_STALE(const struct inode *inode)
269 {
270         return test_bit(NFS_INO_STALE, &NFS_I(inode)->flags);
271 }
272
273 static inline struct fscache_cookie *nfs_i_fscache(struct inode *inode)
274 {
275 #ifdef CONFIG_NFS_FSCACHE
276         return NFS_I(inode)->fscache;
277 #else
278         return NULL;
279 #endif
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 void nfs_set_verifier(struct dentry * dentry, unsigned long verf)
309 {
310         dentry->d_time = verf;
311 }
312
313 /**
314  * nfs_save_change_attribute - Returns the inode attribute change cookie
315  * @dir - pointer to parent directory inode
316  * The "change attribute" is updated every time we finish an operation
317  * that will result in a metadata change on the server.
318  */
319 static inline unsigned long nfs_save_change_attribute(struct inode *dir)
320 {
321         return NFS_I(dir)->cache_change_attribute;
322 }
323
324 /**
325  * nfs_verify_change_attribute - Detects NFS remote directory changes
326  * @dir - pointer to parent directory inode
327  * @chattr - previously saved change attribute
328  * Return "false" if the verifiers doesn't match the change attribute.
329  * This would usually indicate that the directory contents have changed on
330  * the server, and that any dentries need revalidating.
331  */
332 static inline int nfs_verify_change_attribute(struct inode *dir, unsigned long chattr)
333 {
334         return chattr == NFS_I(dir)->cache_change_attribute;
335 }
336
337 /*
338  * linux/fs/nfs/inode.c
339  */
340 extern int nfs_sync_mapping(struct address_space *mapping);
341 extern void nfs_zap_mapping(struct inode *inode, struct address_space *mapping);
342 extern void nfs_zap_caches(struct inode *);
343 extern void nfs_invalidate_atime(struct inode *);
344 extern struct inode *nfs_fhget(struct super_block *, struct nfs_fh *,
345                                 struct nfs_fattr *, struct nfs4_label *);
346 extern int nfs_refresh_inode(struct inode *, struct nfs_fattr *);
347 extern int nfs_post_op_update_inode(struct inode *inode, struct nfs_fattr *fattr);
348 extern int nfs_post_op_update_inode_force_wcc(struct inode *inode, struct nfs_fattr *fattr);
349 extern int nfs_getattr(struct vfsmount *, struct dentry *, struct kstat *);
350 extern void nfs_access_add_cache(struct inode *, struct nfs_access_entry *);
351 extern void nfs_access_set_mask(struct nfs_access_entry *, u32);
352 extern int nfs_permission(struct inode *, int);
353 extern int nfs_open(struct inode *, struct file *);
354 extern int nfs_release(struct inode *, struct file *);
355 extern int nfs_attribute_timeout(struct inode *inode);
356 extern int nfs_attribute_cache_expired(struct inode *inode);
357 extern int nfs_revalidate_inode(struct nfs_server *server, struct inode *inode);
358 extern int __nfs_revalidate_inode(struct nfs_server *, struct inode *);
359 extern int nfs_revalidate_mapping(struct inode *inode, struct address_space *mapping);
360 extern int nfs_setattr(struct dentry *, struct iattr *);
361 extern void nfs_setattr_update_inode(struct inode *inode, struct iattr *attr);
362 extern void nfs_setsecurity(struct inode *inode, struct nfs_fattr *fattr,
363                                 struct nfs4_label *label);
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 dentry *dentry, fmode_t f_mode);
368 extern void nfs_inode_attach_open_context(struct nfs_open_context *ctx);
369 extern void nfs_file_set_open_context(struct file *filp, struct nfs_open_context *ctx);
370 extern struct nfs_lock_context *nfs_get_lock_context(struct nfs_open_context *ctx);
371 extern void nfs_put_lock_context(struct nfs_lock_context *l_ctx);
372 extern u64 nfs_compat_user_ino64(u64 fileid);
373 extern void nfs_fattr_init(struct nfs_fattr *fattr);
374 extern unsigned long nfs_inc_attr_generation_counter(void);
375
376 extern struct nfs_fattr *nfs_alloc_fattr(void);
377
378 static inline void nfs_free_fattr(const struct nfs_fattr *fattr)
379 {
380         kfree(fattr);
381 }
382
383 extern struct nfs_fh *nfs_alloc_fhandle(void);
384
385 static inline void nfs_free_fhandle(const struct nfs_fh *fh)
386 {
387         kfree(fh);
388 }
389
390 #ifdef NFS_DEBUG
391 extern u32 _nfs_display_fhandle_hash(const struct nfs_fh *fh);
392 static inline u32 nfs_display_fhandle_hash(const struct nfs_fh *fh)
393 {
394         return _nfs_display_fhandle_hash(fh);
395 }
396 extern void _nfs_display_fhandle(const struct nfs_fh *fh, const char *caption);
397 #define nfs_display_fhandle(fh, caption)                        \
398         do {                                                    \
399                 if (unlikely(nfs_debug & NFSDBG_FACILITY))      \
400                         _nfs_display_fhandle(fh, caption);      \
401         } while (0)
402 #else
403 static inline u32 nfs_display_fhandle_hash(const struct nfs_fh *fh)
404 {
405         return 0;
406 }
407 static inline void nfs_display_fhandle(const struct nfs_fh *fh,
408                                        const char *caption)
409 {
410 }
411 #endif
412
413 /*
414  * linux/fs/nfs/nfsroot.c
415  */
416 extern int  nfs_root_data(char **root_device, char **root_data); /*__init*/
417 /* linux/net/ipv4/ipconfig.c: trims ip addr off front of name, too. */
418 extern __be32 root_nfs_parse_addr(char *name); /*__init*/
419
420 /*
421  * linux/fs/nfs/file.c
422  */
423 extern const struct file_operations nfs_file_operations;
424 #if IS_ENABLED(CONFIG_NFS_V4)
425 extern const struct file_operations nfs4_file_operations;
426 #endif /* CONFIG_NFS_V4 */
427 extern const struct address_space_operations nfs_file_aops;
428 extern const struct address_space_operations nfs_dir_aops;
429
430 static inline struct nfs_open_context *nfs_file_open_context(struct file *filp)
431 {
432         return filp->private_data;
433 }
434
435 static inline struct rpc_cred *nfs_file_cred(struct file *file)
436 {
437         if (file != NULL) {
438                 struct nfs_open_context *ctx =
439                         nfs_file_open_context(file);
440                 if (ctx)
441                         return ctx->cred;
442         }
443         return NULL;
444 }
445
446 /*
447  * linux/fs/nfs/xattr.c
448  */
449 #ifdef CONFIG_NFS_V3_ACL
450 extern ssize_t nfs3_listxattr(struct dentry *, char *, size_t);
451 extern ssize_t nfs3_getxattr(struct dentry *, const char *, void *, size_t);
452 extern int nfs3_setxattr(struct dentry *, const char *,
453                         const void *, size_t, int);
454 extern int nfs3_removexattr (struct dentry *, const char *name);
455 #else
456 # define nfs3_listxattr NULL
457 # define nfs3_getxattr NULL
458 # define nfs3_setxattr NULL
459 # define nfs3_removexattr NULL
460 #endif
461
462 /*
463  * linux/fs/nfs/direct.c
464  */
465 extern ssize_t nfs_direct_IO(int, struct kiocb *, const struct iovec *, loff_t,
466                         unsigned long);
467 extern ssize_t nfs_file_direct_read(struct kiocb *iocb,
468                         const struct iovec *iov, unsigned long nr_segs,
469                         loff_t pos, bool uio);
470 extern ssize_t nfs_file_direct_write(struct kiocb *iocb,
471                         const struct iovec *iov, unsigned long nr_segs,
472                         loff_t pos, bool uio);
473
474 /*
475  * linux/fs/nfs/dir.c
476  */
477 extern const struct file_operations nfs_dir_operations;
478 extern const struct dentry_operations nfs_dentry_operations;
479
480 extern void nfs_force_lookup_revalidate(struct inode *dir);
481 extern int nfs_instantiate(struct dentry *dentry, struct nfs_fh *fh,
482                         struct nfs_fattr *fattr, struct nfs4_label *label);
483 extern int nfs_may_open(struct inode *inode, struct rpc_cred *cred, int openflags);
484 extern void nfs_access_zap_cache(struct inode *inode);
485
486 /*
487  * linux/fs/nfs/symlink.c
488  */
489 extern const struct inode_operations nfs_symlink_inode_operations;
490
491 /*
492  * linux/fs/nfs/sysctl.c
493  */
494 #ifdef CONFIG_SYSCTL
495 extern int nfs_register_sysctl(void);
496 extern void nfs_unregister_sysctl(void);
497 #else
498 #define nfs_register_sysctl() 0
499 #define nfs_unregister_sysctl() do { } while(0)
500 #endif
501
502 /*
503  * linux/fs/nfs/namespace.c
504  */
505 extern const struct inode_operations nfs_mountpoint_inode_operations;
506 extern const struct inode_operations nfs_referral_inode_operations;
507 extern int nfs_mountpoint_expiry_timeout;
508 extern void nfs_release_automount_timer(void);
509
510 /*
511  * linux/fs/nfs/unlink.c
512  */
513 extern void nfs_complete_unlink(struct dentry *dentry, struct inode *);
514 extern void nfs_wait_on_sillyrename(struct dentry *dentry);
515 extern void nfs_block_sillyrename(struct dentry *dentry);
516 extern void nfs_unblock_sillyrename(struct dentry *dentry);
517 extern int  nfs_sillyrename(struct inode *dir, struct dentry *dentry);
518
519 /*
520  * linux/fs/nfs/write.c
521  */
522 extern int  nfs_congestion_kb;
523 extern int  nfs_writepage(struct page *page, struct writeback_control *wbc);
524 extern int  nfs_writepages(struct address_space *, struct writeback_control *);
525 extern int  nfs_flush_incompatible(struct file *file, struct page *page);
526 extern int  nfs_updatepage(struct file *, struct page *, unsigned int, unsigned int);
527 extern void nfs_writeback_done(struct rpc_task *, struct nfs_write_data *);
528
529 /*
530  * Try to write back everything synchronously (but check the
531  * return value!)
532  */
533 extern int nfs_wb_all(struct inode *inode);
534 extern int nfs_wb_page(struct inode *inode, struct page* page);
535 extern int nfs_wb_page_cancel(struct inode *inode, struct page* page);
536 #if IS_ENABLED(CONFIG_NFS_V3) || IS_ENABLED(CONFIG_NFS_V4)
537 extern int  nfs_commit_inode(struct inode *, int);
538 extern struct nfs_commit_data *nfs_commitdata_alloc(void);
539 extern void nfs_commit_free(struct nfs_commit_data *data);
540 #else
541 static inline int
542 nfs_commit_inode(struct inode *inode, int how)
543 {
544         return 0;
545 }
546 #endif
547
548 static inline int
549 nfs_have_writebacks(struct inode *inode)
550 {
551         return NFS_I(inode)->npages != 0;
552 }
553
554 /*
555  * linux/fs/nfs/read.c
556  */
557 extern int  nfs_readpage(struct file *, struct page *);
558 extern int  nfs_readpages(struct file *, struct address_space *,
559                 struct list_head *, unsigned);
560 extern int  nfs_readpage_result(struct rpc_task *, struct nfs_read_data *);
561 extern int  nfs_readpage_async(struct nfs_open_context *, struct inode *,
562                                struct page *);
563
564 /*
565  * linux/fs/nfs3proc.c
566  */
567 #ifdef CONFIG_NFS_V3_ACL
568 extern struct posix_acl *nfs3_proc_getacl(struct inode *inode, int type);
569 extern int nfs3_proc_setacl(struct inode *inode, int type,
570                             struct posix_acl *acl);
571 extern int nfs3_proc_set_default_acl(struct inode *dir, struct inode *inode,
572                 umode_t mode);
573 extern void nfs3_forget_cached_acls(struct inode *inode);
574 #else
575 static inline int nfs3_proc_set_default_acl(struct inode *dir,
576                                             struct inode *inode,
577                                             umode_t mode)
578 {
579         return 0;
580 }
581
582 static inline void nfs3_forget_cached_acls(struct inode *inode)
583 {
584 }
585 #endif /* CONFIG_NFS_V3_ACL */
586
587 /*
588  * inline functions
589  */
590
591 static inline loff_t nfs_size_to_loff_t(__u64 size)
592 {
593         if (size > (__u64) OFFSET_MAX - 1)
594                 return OFFSET_MAX - 1;
595         return (loff_t) size;
596 }
597
598 static inline ino_t
599 nfs_fileid_to_ino_t(u64 fileid)
600 {
601         ino_t ino = (ino_t) fileid;
602         if (sizeof(ino_t) < sizeof(u64))
603                 ino ^= fileid >> (sizeof(u64)-sizeof(ino_t)) * 8;
604         return ino;
605 }
606
607 #define NFS_JUKEBOX_RETRY_TIME (5 * HZ)
608
609
610 # undef ifdebug
611 # ifdef NFS_DEBUG
612 #  define ifdebug(fac)          if (unlikely(nfs_debug & NFSDBG_##fac))
613 #  define NFS_IFDEBUG(x)        x
614 # else
615 #  define ifdebug(fac)          if (0)
616 #  define NFS_IFDEBUG(x)
617 # endif
618 #endif