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