1
2
3
4
5
6
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
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
43
44#define NFS_RPC_SWAPFLAGS (RPC_TASK_SWAPPER|RPC_TASK_ROOTCREDS)
45
46
47
48
49struct 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 struct rcu_head rcu_head;
56};
57
58struct nfs_lock_context {
59 atomic_t count;
60 struct list_head list;
61 struct nfs_open_context *open_context;
62 fl_owner_t lockowner;
63 atomic_t io_count;
64};
65
66struct nfs4_state;
67struct nfs_open_context {
68 struct nfs_lock_context lock_context;
69 fl_owner_t flock_owner;
70 struct dentry *dentry;
71 struct rpc_cred *cred;
72 struct nfs4_state *state;
73 fmode_t mode;
74
75 unsigned long flags;
76#define NFS_CONTEXT_ERROR_WRITE (0)
77#define NFS_CONTEXT_RESEND_WRITES (1)
78#define NFS_CONTEXT_BAD (2)
79#define NFS_CONTEXT_UNLOCK (3)
80 int error;
81
82 struct list_head list;
83 struct nfs4_threshold *mdsthreshold;
84};
85
86struct nfs_open_dir_context {
87 struct list_head list;
88 struct rpc_cred *cred;
89 unsigned long attr_gencount;
90 __u64 dir_cookie;
91 __u64 dup_cookie;
92 signed char duped;
93};
94
95
96
97
98struct nfs_delegation;
99
100struct posix_acl;
101
102
103
104
105struct nfs_inode {
106
107
108
109 __u64 fileid;
110
111
112
113
114 struct nfs_fh fh;
115
116
117
118
119 unsigned long flags;
120 unsigned long cache_validity;
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136 unsigned long read_cache_jiffies;
137 unsigned long attrtimeo;
138 unsigned long attrtimeo_timestamp;
139
140 unsigned long attr_gencount;
141
142
143
144
145 unsigned long cache_change_attribute;
146
147 struct rb_root access_cache;
148 struct list_head access_cache_entry_lru;
149 struct list_head access_cache_inode_lru;
150#ifdef CONFIG_NFS_V3_ACL
151 struct posix_acl *acl_access;
152 struct posix_acl *acl_default;
153#endif
154
155
156
157
158
159 __be32 cookieverf[2];
160
161 unsigned long nrequests;
162 struct nfs_mds_commit_info commit_info;
163
164
165 struct list_head open_files;
166
167
168 atomic_t silly_count;
169
170 struct hlist_head silly_list;
171 wait_queue_head_t waitqueue;
172
173#if IS_ENABLED(CONFIG_NFS_V4)
174 struct nfs4_cached_acl *nfs4_acl;
175
176 struct list_head open_states;
177 struct nfs_delegation __rcu *delegation;
178 struct rw_semaphore rwsem;
179
180
181 struct pnfs_layout_hdr *layout;
182#endif
183
184 __u64 write_io;
185 __u64 read_io;
186#ifdef CONFIG_NFS_FSCACHE
187 struct fscache_cookie *fscache;
188#endif
189 struct inode vfs_inode;
190};
191
192
193
194
195#define NFS_INO_INVALID_ATTR 0x0001
196#define NFS_INO_INVALID_DATA 0x0002
197#define NFS_INO_INVALID_ATIME 0x0004
198#define NFS_INO_INVALID_ACCESS 0x0008
199#define NFS_INO_INVALID_ACL 0x0010
200#define NFS_INO_REVAL_PAGECACHE 0x0020
201#define NFS_INO_REVAL_FORCED 0x0040
202#define NFS_INO_INVALID_LABEL 0x0080
203
204
205
206
207#define NFS_INO_ADVISE_RDPLUS (0)
208#define NFS_INO_STALE (1)
209#define NFS_INO_ACL_LRU_SET (2)
210#define NFS_INO_INVALIDATING (3)
211#define NFS_INO_FLUSHING (4)
212#define NFS_INO_FSCACHE (5)
213#define NFS_INO_FSCACHE_LOCK (6)
214#define NFS_INO_LAYOUTCOMMIT (9)
215#define NFS_INO_LAYOUTCOMMITTING (10)
216#define NFS_INO_LAYOUTSTATS (11)
217
218static inline struct nfs_inode *NFS_I(const struct inode *inode)
219{
220 return container_of(inode, struct nfs_inode, vfs_inode);
221}
222
223static inline struct nfs_server *NFS_SB(const struct super_block *s)
224{
225 return (struct nfs_server *)(s->s_fs_info);
226}
227
228static inline struct nfs_fh *NFS_FH(const struct inode *inode)
229{
230 return &NFS_I(inode)->fh;
231}
232
233static inline struct nfs_server *NFS_SERVER(const struct inode *inode)
234{
235 return NFS_SB(inode->i_sb);
236}
237
238static inline struct rpc_clnt *NFS_CLIENT(const struct inode *inode)
239{
240 return NFS_SERVER(inode)->client;
241}
242
243static inline const struct nfs_rpc_ops *NFS_PROTO(const struct inode *inode)
244{
245 return NFS_SERVER(inode)->nfs_client->rpc_ops;
246}
247
248static inline unsigned NFS_MINATTRTIMEO(const struct inode *inode)
249{
250 struct nfs_server *nfss = NFS_SERVER(inode);
251 return S_ISDIR(inode->i_mode) ? nfss->acdirmin : nfss->acregmin;
252}
253
254static inline unsigned NFS_MAXATTRTIMEO(const struct inode *inode)
255{
256 struct nfs_server *nfss = NFS_SERVER(inode);
257 return S_ISDIR(inode->i_mode) ? nfss->acdirmax : nfss->acregmax;
258}
259
260static inline int NFS_STALE(const struct inode *inode)
261{
262 return test_bit(NFS_INO_STALE, &NFS_I(inode)->flags);
263}
264
265static inline struct fscache_cookie *nfs_i_fscache(struct inode *inode)
266{
267#ifdef CONFIG_NFS_FSCACHE
268 return NFS_I(inode)->fscache;
269#else
270 return NULL;
271#endif
272}
273
274static inline __u64 NFS_FILEID(const struct inode *inode)
275{
276 return NFS_I(inode)->fileid;
277}
278
279static inline void set_nfs_fileid(struct inode *inode, __u64 fileid)
280{
281 NFS_I(inode)->fileid = fileid;
282}
283
284static inline void nfs_mark_for_revalidate(struct inode *inode)
285{
286 struct nfs_inode *nfsi = NFS_I(inode);
287
288 spin_lock(&inode->i_lock);
289 nfsi->cache_validity |= NFS_INO_INVALID_ATTR |
290 NFS_INO_REVAL_PAGECACHE |
291 NFS_INO_INVALID_ACCESS |
292 NFS_INO_INVALID_ACL;
293 if (S_ISDIR(inode->i_mode))
294 nfsi->cache_validity |= NFS_INO_INVALID_DATA;
295 spin_unlock(&inode->i_lock);
296}
297
298static inline int nfs_server_capable(struct inode *inode, int cap)
299{
300 return NFS_SERVER(inode)->caps & cap;
301}
302
303static inline void nfs_set_verifier(struct dentry * dentry, unsigned long verf)
304{
305 dentry->d_time = verf;
306}
307
308
309
310
311
312
313
314static inline unsigned long nfs_save_change_attribute(struct inode *dir)
315{
316 return NFS_I(dir)->cache_change_attribute;
317}
318
319
320
321
322
323
324
325
326
327static inline int nfs_verify_change_attribute(struct inode *dir, unsigned long chattr)
328{
329 return chattr == NFS_I(dir)->cache_change_attribute;
330}
331
332
333
334
335extern int nfs_sync_mapping(struct address_space *mapping);
336extern void nfs_zap_mapping(struct inode *inode, struct address_space *mapping);
337extern void nfs_zap_caches(struct inode *);
338extern void nfs_invalidate_atime(struct inode *);
339extern struct inode *nfs_fhget(struct super_block *, struct nfs_fh *,
340 struct nfs_fattr *, struct nfs4_label *);
341extern int nfs_refresh_inode(struct inode *, struct nfs_fattr *);
342extern int nfs_post_op_update_inode(struct inode *inode, struct nfs_fattr *fattr);
343extern int nfs_post_op_update_inode_force_wcc(struct inode *inode, struct nfs_fattr *fattr);
344extern int nfs_post_op_update_inode_force_wcc_locked(struct inode *inode, struct nfs_fattr *fattr);
345extern int nfs_getattr(struct vfsmount *, struct dentry *, struct kstat *);
346extern void nfs_access_add_cache(struct inode *, struct nfs_access_entry *);
347extern void nfs_access_set_mask(struct nfs_access_entry *, u32);
348extern int nfs_permission(struct inode *, int);
349extern int nfs_open(struct inode *, struct file *);
350extern int nfs_attribute_timeout(struct inode *inode);
351extern int nfs_attribute_cache_expired(struct inode *inode);
352extern int nfs_revalidate_inode(struct nfs_server *server, struct inode *inode);
353extern int nfs_revalidate_inode_rcu(struct nfs_server *server, struct inode *inode);
354extern int __nfs_revalidate_inode(struct nfs_server *, struct inode *);
355extern int nfs_revalidate_mapping(struct inode *inode, struct address_space *mapping);
356extern int nfs_revalidate_mapping_protected(struct inode *inode, struct address_space *mapping);
357extern int nfs_setattr(struct dentry *, struct iattr *);
358extern void nfs_setattr_update_inode(struct inode *inode, struct iattr *attr, struct nfs_fattr *);
359extern void nfs_setsecurity(struct inode *inode, struct nfs_fattr *fattr,
360 struct nfs4_label *label);
361extern struct nfs_open_context *get_nfs_open_context(struct nfs_open_context *ctx);
362extern void put_nfs_open_context(struct nfs_open_context *ctx);
363extern struct nfs_open_context *nfs_find_open_context(struct inode *inode, struct rpc_cred *cred, fmode_t mode);
364extern struct nfs_open_context *alloc_nfs_open_context(struct dentry *dentry, fmode_t f_mode, struct file *filp);
365extern void nfs_inode_attach_open_context(struct nfs_open_context *ctx);
366extern void nfs_file_set_open_context(struct file *filp, struct nfs_open_context *ctx);
367extern void nfs_file_clear_open_context(struct file *flip);
368extern struct nfs_lock_context *nfs_get_lock_context(struct nfs_open_context *ctx);
369extern void nfs_put_lock_context(struct nfs_lock_context *l_ctx);
370extern u64 nfs_compat_user_ino64(u64 fileid);
371extern void nfs_fattr_init(struct nfs_fattr *fattr);
372extern void nfs_fattr_set_barrier(struct nfs_fattr *fattr);
373extern unsigned long nfs_inc_attr_generation_counter(void);
374
375extern struct nfs_fattr *nfs_alloc_fattr(void);
376
377static inline void nfs_free_fattr(const struct nfs_fattr *fattr)
378{
379 kfree(fattr);
380}
381
382extern struct nfs_fh *nfs_alloc_fhandle(void);
383
384static inline void nfs_free_fhandle(const struct nfs_fh *fh)
385{
386 kfree(fh);
387}
388
389#ifdef NFS_DEBUG
390extern u32 _nfs_display_fhandle_hash(const struct nfs_fh *fh);
391static inline u32 nfs_display_fhandle_hash(const struct nfs_fh *fh)
392{
393 return _nfs_display_fhandle_hash(fh);
394}
395extern void _nfs_display_fhandle(const struct nfs_fh *fh, const char *caption);
396#define nfs_display_fhandle(fh, caption) \
397 do { \
398 if (unlikely(nfs_debug & NFSDBG_FACILITY)) \
399 _nfs_display_fhandle(fh, caption); \
400 } while (0)
401#else
402static inline u32 nfs_display_fhandle_hash(const struct nfs_fh *fh)
403{
404 return 0;
405}
406static inline void nfs_display_fhandle(const struct nfs_fh *fh,
407 const char *caption)
408{
409}
410#endif
411
412
413
414
415extern int nfs_root_data(char **root_device, char **root_data);
416
417extern __be32 root_nfs_parse_addr(char *name);
418
419
420
421
422extern const struct file_operations nfs_file_operations;
423#if IS_ENABLED(CONFIG_NFS_V4)
424extern const struct file_operations_extend nfs4_file_operations;
425#endif
426extern const struct address_space_operations nfs_file_aops;
427extern const struct address_space_operations nfs_dir_aops;
428
429static inline struct nfs_open_context *nfs_file_open_context(struct file *filp)
430{
431 return filp->private_data;
432}
433
434static inline struct rpc_cred *nfs_file_cred(struct file *file)
435{
436 if (file != NULL) {
437 struct nfs_open_context *ctx =
438 nfs_file_open_context(file);
439 if (ctx)
440 return ctx->cred;
441 }
442 return NULL;
443}
444
445
446
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, bool uio);
453extern ssize_t nfs_file_direct_write(struct kiocb *iocb,
454 const struct iovec *iov, unsigned long nr_segs,
455 loff_t pos, bool uio);
456
457
458
459
460extern const struct file_operations nfs_dir_operations;
461extern const struct dentry_operations nfs_dentry_operations;
462
463extern void nfs_force_lookup_revalidate(struct inode *dir);
464extern int nfs_instantiate(struct dentry *dentry, struct nfs_fh *fh,
465 struct nfs_fattr *fattr, struct nfs4_label *label);
466extern int nfs_may_open(struct inode *inode, struct rpc_cred *cred, int openflags);
467extern void nfs_access_zap_cache(struct inode *inode);
468
469
470
471
472extern const struct inode_operations nfs_symlink_inode_operations;
473
474
475
476
477#ifdef CONFIG_SYSCTL
478extern int nfs_register_sysctl(void);
479extern 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
487
488extern const struct inode_operations nfs_mountpoint_inode_operations;
489extern const struct inode_operations nfs_referral_inode_operations;
490extern int nfs_mountpoint_expiry_timeout;
491extern void nfs_release_automount_timer(void);
492
493
494
495
496extern void nfs_complete_unlink(struct dentry *dentry, struct inode *);
497extern void nfs_wait_on_sillyrename(struct dentry *dentry);
498extern void nfs_block_sillyrename(struct dentry *dentry);
499extern void nfs_unblock_sillyrename(struct dentry *dentry);
500
501
502
503
504extern int nfs_congestion_kb;
505extern int nfs_writepage(struct page *page, struct writeback_control *wbc);
506extern int nfs_writepages(struct address_space *, struct writeback_control *);
507extern int nfs_flush_incompatible(struct file *file, struct page *page);
508extern int nfs_updatepage(struct file *, struct page *, unsigned int, unsigned int);
509
510
511
512
513
514extern int nfs_sync_inode(struct inode *inode);
515extern int nfs_wb_all(struct inode *inode);
516extern int nfs_wb_single_page(struct inode *inode, struct page *page, bool launder);
517extern int nfs_wb_page_cancel(struct inode *inode, struct page* page);
518extern int nfs_commit_inode(struct inode *, int);
519extern struct nfs_commit_data *nfs_commitdata_alloc(void);
520extern void nfs_commit_free(struct nfs_commit_data *data);
521
522static inline int
523nfs_wb_launder_page(struct inode *inode, struct page *page)
524{
525 return nfs_wb_single_page(inode, page, true);
526}
527
528static inline int
529nfs_wb_page(struct inode *inode, struct page *page)
530{
531 return nfs_wb_single_page(inode, page, false);
532}
533
534static inline int
535nfs_have_writebacks(struct inode *inode)
536{
537 return NFS_I(inode)->nrequests != 0;
538}
539
540
541
542
543extern int nfs_readpage(struct file *, struct page *);
544extern int nfs_readpages(struct file *, struct address_space *,
545 struct list_head *, unsigned);
546extern int nfs_readpage_async(struct nfs_open_context *, struct inode *,
547 struct page *);
548
549
550
551
552static inline loff_t nfs_size_to_loff_t(__u64 size)
553{
554 if (size > (__u64) OFFSET_MAX - 1)
555 return OFFSET_MAX - 1;
556 return (loff_t) size;
557}
558
559static inline ino_t
560nfs_fileid_to_ino_t(u64 fileid)
561{
562 ino_t ino = (ino_t) fileid;
563 if (sizeof(ino_t) < sizeof(u64))
564 ino ^= fileid >> (sizeof(u64)-sizeof(ino_t)) * 8;
565 return ino;
566}
567
568#define NFS_JUKEBOX_RETRY_TIME (5 * HZ)
569
570
571# undef ifdebug
572# ifdef NFS_DEBUG
573# define ifdebug(fac) if (unlikely(nfs_debug & NFSDBG_##fac))
574# define NFS_IFDEBUG(x) x
575# else
576# define ifdebug(fac) if (0)
577# define NFS_IFDEBUG(x)
578# endif
579#endif
580