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