[PATCH] NFSv4: ACL support for the NFSv4 client: write
[deliverable/linux.git] / include / linux / nfs_fs.h
CommitLineData
1da177e4
LT
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/config.h>
13#include <linux/in.h>
14#include <linux/mm.h>
15#include <linux/pagemap.h>
16#include <linux/rwsem.h>
17#include <linux/wait.h>
1da177e4
LT
18
19#include <linux/nfs_fs_sb.h>
20
21#include <linux/sunrpc/debug.h>
22#include <linux/sunrpc/auth.h>
23#include <linux/sunrpc/clnt.h>
24
25#include <linux/nfs.h>
26#include <linux/nfs2.h>
27#include <linux/nfs3.h>
28#include <linux/nfs4.h>
29#include <linux/nfs_xdr.h>
30#include <linux/rwsem.h>
1da177e4
LT
31#include <linux/mempool.h>
32
33/*
34 * Enable debugging support for nfs client.
35 * Requires RPC_DEBUG.
36 */
37#ifdef RPC_DEBUG
38# define NFS_DEBUG
39#endif
40
41#define NFS_MAX_FILE_IO_BUFFER_SIZE 32768
42#define NFS_DEF_FILE_IO_BUFFER_SIZE 4096
43
1da177e4
LT
44/*
45 * superblock magic number for NFS
46 */
47#define NFS_SUPER_MAGIC 0x6969
48
49/*
50 * These are the default flags for swap requests
51 */
52#define NFS_RPC_SWAPFLAGS (RPC_TASK_SWAPPER|RPC_TASK_ROOTCREDS)
53
1da177e4
LT
54/*
55 * When flushing a cluster of dirty pages, there can be different
56 * strategies:
57 */
58#define FLUSH_AGING 0 /* only flush old buffers */
59#define FLUSH_SYNC 1 /* file being synced, or contention */
60#define FLUSH_WAIT 2 /* wait for completion */
61#define FLUSH_STABLE 4 /* commit to stable storage */
62#define FLUSH_LOWPRI 8 /* low priority background flush */
63#define FLUSH_HIGHPRI 16 /* high priority memory reclaim flush */
64
65#ifdef __KERNEL__
66
67/*
68 * NFSv3/v4 Access mode cache entry
69 */
70struct nfs_access_entry {
71 unsigned long jiffies;
72 struct rpc_cred * cred;
73 int mask;
74};
75
76struct nfs4_state;
77struct nfs_open_context {
78 atomic_t count;
79 struct dentry *dentry;
80 struct rpc_cred *cred;
81 struct nfs4_state *state;
82 fl_owner_t lockowner;
83 int mode;
84 int error;
85
86 struct list_head list;
1da177e4
LT
87};
88
89/*
90 * NFSv4 delegation
91 */
92struct nfs_delegation;
93
94/*
95 * nfs fs inode data in memory
96 */
97struct nfs_inode {
98 /*
99 * The 64bit 'inode number'
100 */
101 __u64 fileid;
102
103 /*
104 * NFS file handle
105 */
106 struct nfs_fh fh;
107
108 /*
109 * Various flags
110 */
111 unsigned int flags;
112
113 /*
114 * read_cache_jiffies is when we started read-caching this inode,
115 * and read_cache_mtime is the mtime of the inode at that time.
116 * attrtimeo is for how long the cached information is assumed
117 * to be valid. A successful attribute revalidation doubles
118 * attrtimeo (up to acregmax/acdirmax), a failure resets it to
119 * acregmin/acdirmin.
120 *
121 * We need to revalidate the cached attrs for this inode if
122 *
123 * jiffies - read_cache_jiffies > attrtimeo
124 *
125 * and invalidate any cached data/flush out any dirty pages if
126 * we find that
127 *
128 * mtime != read_cache_mtime
129 */
1da177e4
LT
130 unsigned long read_cache_jiffies;
131 unsigned long attrtimeo;
132 unsigned long attrtimeo_timestamp;
133 __u64 change_attr; /* v4 only */
134
135 /* "Generation counter" for the attribute cache. This is
136 * bumped whenever we update the metadata on the
137 * server.
138 */
139 unsigned long cache_change_attribute;
140 /*
141 * Counter indicating the number of outstanding requests that
142 * will cause a file data update.
143 */
144 atomic_t data_updates;
145
146 struct nfs_access_entry cache_access;
147
148 /*
149 * This is the cookie verifier used for NFSv3 readdir
150 * operations
151 */
152 __u32 cookieverf[2];
153
154 /*
155 * This is the list of dirty unwritten pages.
156 */
157 spinlock_t req_lock;
158 struct list_head dirty;
159 struct list_head commit;
160 struct radix_tree_root nfs_page_tree;
161
162 unsigned int ndirty,
163 ncommit,
164 npages;
165
166 /* Open contexts for shared mmap writes */
167 struct list_head open_files;
168
169 wait_queue_head_t nfs_i_wait;
170
171#ifdef CONFIG_NFS_V4
172 /* NFSv4 state */
173 struct list_head open_states;
174 struct nfs_delegation *delegation;
175 int delegation_state;
176 struct rw_semaphore rwsem;
177#endif /* CONFIG_NFS_V4*/
178
179 struct inode vfs_inode;
180};
181
182/*
183 * Legal inode flag values
184 */
185#define NFS_INO_STALE 0x0001 /* possible stale inode */
186#define NFS_INO_ADVISE_RDPLUS 0x0002 /* advise readdirplus */
187#define NFS_INO_REVALIDATING 0x0004 /* revalidating attrs */
188#define NFS_INO_INVALID_ATTR 0x0008 /* cached attrs are invalid */
189#define NFS_INO_INVALID_DATA 0x0010 /* cached data is invalid */
190#define NFS_INO_INVALID_ATIME 0x0020 /* cached atime is invalid */
191#define NFS_INO_INVALID_ACCESS 0x0040 /* cached access cred invalid */
ada70d94 192#define NFS_INO_INVALID_ACL 0x0080 /* cached acls are invalid */
1da177e4
LT
193
194static inline struct nfs_inode *NFS_I(struct inode *inode)
195{
196 return container_of(inode, struct nfs_inode, vfs_inode);
197}
198#define NFS_SB(s) ((struct nfs_server *)(s->s_fs_info))
199
200#define NFS_FH(inode) (&NFS_I(inode)->fh)
201#define NFS_SERVER(inode) (NFS_SB(inode->i_sb))
202#define NFS_CLIENT(inode) (NFS_SERVER(inode)->client)
203#define NFS_PROTO(inode) (NFS_SERVER(inode)->rpc_ops)
204#define NFS_ADDR(inode) (RPC_PEERADDR(NFS_CLIENT(inode)))
205#define NFS_COOKIEVERF(inode) (NFS_I(inode)->cookieverf)
206#define NFS_READTIME(inode) (NFS_I(inode)->read_cache_jiffies)
207#define NFS_CHANGE_ATTR(inode) (NFS_I(inode)->change_attr)
208#define NFS_ATTRTIMEO(inode) (NFS_I(inode)->attrtimeo)
209#define NFS_MINATTRTIMEO(inode) \
210 (S_ISDIR(inode->i_mode)? NFS_SERVER(inode)->acdirmin \
211 : NFS_SERVER(inode)->acregmin)
212#define NFS_MAXATTRTIMEO(inode) \
213 (S_ISDIR(inode->i_mode)? NFS_SERVER(inode)->acdirmax \
214 : NFS_SERVER(inode)->acregmax)
215#define NFS_ATTRTIMEO_UPDATE(inode) (NFS_I(inode)->attrtimeo_timestamp)
216
217#define NFS_FLAGS(inode) (NFS_I(inode)->flags)
218#define NFS_REVALIDATING(inode) (NFS_FLAGS(inode) & NFS_INO_REVALIDATING)
219#define NFS_STALE(inode) (NFS_FLAGS(inode) & NFS_INO_STALE)
220
221#define NFS_FILEID(inode) (NFS_I(inode)->fileid)
222
223static inline int nfs_caches_unstable(struct inode *inode)
224{
225 return atomic_read(&NFS_I(inode)->data_updates) != 0;
226}
227
228static inline void NFS_CACHEINV(struct inode *inode)
229{
230 if (!nfs_caches_unstable(inode))
231 NFS_FLAGS(inode) |= NFS_INO_INVALID_ATTR | NFS_INO_INVALID_ACCESS;
232}
233
234static inline int nfs_server_capable(struct inode *inode, int cap)
235{
236 return NFS_SERVER(inode)->caps & cap;
237}
238
239static inline int NFS_USE_READDIRPLUS(struct inode *inode)
240{
241 return NFS_FLAGS(inode) & NFS_INO_ADVISE_RDPLUS;
242}
243
244/**
245 * nfs_save_change_attribute - Returns the inode attribute change cookie
246 * @inode - pointer to inode
247 * The "change attribute" is updated every time we finish an operation
248 * that will result in a metadata change on the server.
249 */
250static inline long nfs_save_change_attribute(struct inode *inode)
251{
252 return NFS_I(inode)->cache_change_attribute;
253}
254
255/**
256 * nfs_verify_change_attribute - Detects NFS inode cache updates
257 * @inode - pointer to inode
258 * @chattr - previously saved change attribute
259 * Return "false" if metadata has been updated (or is in the process of
260 * being updated) since the change attribute was saved.
261 */
262static inline int nfs_verify_change_attribute(struct inode *inode, unsigned long chattr)
263{
264 return !nfs_caches_unstable(inode)
265 && chattr == NFS_I(inode)->cache_change_attribute;
266}
267
268/*
269 * linux/fs/nfs/inode.c
270 */
271extern void nfs_zap_caches(struct inode *);
272extern struct inode *nfs_fhget(struct super_block *, struct nfs_fh *,
273 struct nfs_fattr *);
274extern int nfs_refresh_inode(struct inode *, struct nfs_fattr *);
275extern int nfs_getattr(struct vfsmount *, struct dentry *, struct kstat *);
276extern int nfs_permission(struct inode *, int, struct nameidata *);
277extern int nfs_access_get_cached(struct inode *, struct rpc_cred *, struct nfs_access_entry *);
278extern void nfs_access_add_cache(struct inode *, struct nfs_access_entry *);
279extern int nfs_open(struct inode *, struct file *);
280extern int nfs_release(struct inode *, struct file *);
281extern int nfs_attribute_timeout(struct inode *inode);
282extern int nfs_revalidate_inode(struct nfs_server *server, struct inode *inode);
283extern int __nfs_revalidate_inode(struct nfs_server *, struct inode *);
284extern int nfs_setattr(struct dentry *, struct iattr *);
285extern void nfs_begin_attr_update(struct inode *);
286extern void nfs_end_attr_update(struct inode *);
287extern void nfs_begin_data_update(struct inode *);
288extern void nfs_end_data_update(struct inode *);
289extern void nfs_end_data_update_defer(struct inode *);
290extern struct nfs_open_context *alloc_nfs_open_context(struct dentry *dentry, struct rpc_cred *cred);
291extern struct nfs_open_context *get_nfs_open_context(struct nfs_open_context *ctx);
292extern void put_nfs_open_context(struct nfs_open_context *ctx);
293extern void nfs_file_set_open_context(struct file *filp, struct nfs_open_context *ctx);
294extern struct nfs_open_context *nfs_find_open_context(struct inode *inode, int mode);
295extern void nfs_file_clear_open_context(struct file *filp);
296
297/* linux/net/ipv4/ipconfig.c: trims ip addr off front of name, too. */
298extern u32 root_nfs_parse_addr(char *name); /*__init*/
299
300/*
301 * linux/fs/nfs/file.c
302 */
303extern struct inode_operations nfs_file_inode_operations;
304extern struct file_operations nfs_file_operations;
305extern struct address_space_operations nfs_file_aops;
306
307static inline struct rpc_cred *nfs_file_cred(struct file *file)
308{
309 if (file != NULL) {
310 struct nfs_open_context *ctx;
311
312 ctx = (struct nfs_open_context*)file->private_data;
313 return ctx->cred;
314 }
315 return NULL;
316}
317
318/*
319 * linux/fs/nfs/direct.c
320 */
321extern ssize_t nfs_direct_IO(int, struct kiocb *, const struct iovec *, loff_t,
322 unsigned long);
323extern ssize_t nfs_file_direct_read(struct kiocb *iocb, char __user *buf,
324 size_t count, loff_t pos);
325extern ssize_t nfs_file_direct_write(struct kiocb *iocb, const char __user *buf,
326 size_t count, loff_t pos);
327
328/*
329 * linux/fs/nfs/dir.c
330 */
331extern struct inode_operations nfs_dir_inode_operations;
332extern struct file_operations nfs_dir_operations;
333extern struct dentry_operations nfs_dentry_operations;
334
335extern int nfs_instantiate(struct dentry *dentry, struct nfs_fh *fh, struct nfs_fattr *fattr);
336
337/*
338 * linux/fs/nfs/symlink.c
339 */
340extern struct inode_operations nfs_symlink_inode_operations;
341
342/*
343 * linux/fs/nfs/unlink.c
344 */
345extern int nfs_async_unlink(struct dentry *);
346extern void nfs_complete_unlink(struct dentry *);
347
348/*
349 * linux/fs/nfs/write.c
350 */
351extern int nfs_writepage(struct page *page, struct writeback_control *wbc);
352extern int nfs_writepages(struct address_space *, struct writeback_control *);
353extern int nfs_flush_incompatible(struct file *file, struct page *page);
354extern int nfs_updatepage(struct file *, struct page *, unsigned int, unsigned int);
355extern void nfs_writeback_done(struct rpc_task *task);
356
357#if defined(CONFIG_NFS_V3) || defined(CONFIG_NFS_V4)
358extern void nfs_commit_done(struct rpc_task *);
359#endif
360
361/*
362 * Try to write back everything synchronously (but check the
363 * return value!)
364 */
365extern int nfs_sync_inode(struct inode *, unsigned long, unsigned int, int);
366#if defined(CONFIG_NFS_V3) || defined(CONFIG_NFS_V4)
367extern int nfs_commit_inode(struct inode *, unsigned long, unsigned int, int);
368#else
369static inline int
370nfs_commit_inode(struct inode *inode, unsigned long idx_start, unsigned int npages, int how)
371{
372 return 0;
373}
374#endif
375
376static inline int
377nfs_have_writebacks(struct inode *inode)
378{
379 return NFS_I(inode)->npages != 0;
380}
381
382static inline int
383nfs_wb_all(struct inode *inode)
384{
385 int error = nfs_sync_inode(inode, 0, 0, FLUSH_WAIT);
386 return (error < 0) ? error : 0;
387}
388
389/*
390 * Write back all requests on one page - we do this before reading it.
391 */
392static inline int nfs_wb_page_priority(struct inode *inode, struct page* page, int how)
393{
394 int error = nfs_sync_inode(inode, page->index, 1,
395 how | FLUSH_WAIT | FLUSH_STABLE);
396 return (error < 0) ? error : 0;
397}
398
399static inline int nfs_wb_page(struct inode *inode, struct page* page)
400{
401 return nfs_wb_page_priority(inode, page, 0);
402}
403
404/*
405 * Allocate and free nfs_write_data structures
406 */
407extern mempool_t *nfs_wdata_mempool;
408
409static inline struct nfs_write_data *nfs_writedata_alloc(void)
410{
411 struct nfs_write_data *p = mempool_alloc(nfs_wdata_mempool, SLAB_NOFS);
412 if (p) {
413 memset(p, 0, sizeof(*p));
414 INIT_LIST_HEAD(&p->pages);
415 }
416 return p;
417}
418
419static inline void nfs_writedata_free(struct nfs_write_data *p)
420{
421 mempool_free(p, nfs_wdata_mempool);
422}
423
1da177e4
LT
424/*
425 * linux/fs/nfs/read.c
426 */
427extern int nfs_readpage(struct file *, struct page *);
428extern int nfs_readpages(struct file *, struct address_space *,
429 struct list_head *, unsigned);
430extern void nfs_readpage_result(struct rpc_task *);
431
432/*
433 * Allocate and free nfs_read_data structures
434 */
435extern mempool_t *nfs_rdata_mempool;
436
437static inline struct nfs_read_data *nfs_readdata_alloc(void)
438{
439 struct nfs_read_data *p = mempool_alloc(nfs_rdata_mempool, SLAB_NOFS);
440 if (p)
441 memset(p, 0, sizeof(*p));
442 return p;
443}
444
445static inline void nfs_readdata_free(struct nfs_read_data *p)
446{
447 mempool_free(p, nfs_rdata_mempool);
448}
449
450extern void nfs_readdata_release(struct rpc_task *task);
451
452/*
453 * linux/fs/mount_clnt.c
454 * (Used only by nfsroot module)
455 */
456extern int nfsroot_mount(struct sockaddr_in *, char *, struct nfs_fh *,
457 int, int);
458
459/*
460 * inline functions
461 */
462
463static inline loff_t
464nfs_size_to_loff_t(__u64 size)
465{
466 loff_t maxsz = (((loff_t) ULONG_MAX) << PAGE_CACHE_SHIFT) + PAGE_CACHE_SIZE - 1;
467 if (size > maxsz)
468 return maxsz;
469 return (loff_t) size;
470}
471
472static inline ino_t
473nfs_fileid_to_ino_t(u64 fileid)
474{
475 ino_t ino = (ino_t) fileid;
476 if (sizeof(ino_t) < sizeof(u64))
477 ino ^= fileid >> (sizeof(u64)-sizeof(ino_t)) * 8;
478 return ino;
479}
480
481/* NFS root */
482
483extern void * nfs_root_data(void);
484
485#define nfs_wait_event(clnt, wq, condition) \
486({ \
487 int __retval = 0; \
488 if (clnt->cl_intr) { \
489 sigset_t oldmask; \
490 rpc_clnt_sigmask(clnt, &oldmask); \
491 __retval = wait_event_interruptible(wq, condition); \
492 rpc_clnt_sigunmask(clnt, &oldmask); \
493 } else \
494 wait_event(wq, condition); \
495 __retval; \
496})
497
498#define NFS_JUKEBOX_RETRY_TIME (5 * HZ)
499
1da177e4
LT
500#endif /* __KERNEL__ */
501
502/*
503 * NFS debug flags
504 */
505#define NFSDBG_VFS 0x0001
506#define NFSDBG_DIRCACHE 0x0002
507#define NFSDBG_LOOKUPCACHE 0x0004
508#define NFSDBG_PAGECACHE 0x0008
509#define NFSDBG_PROC 0x0010
510#define NFSDBG_XDR 0x0020
511#define NFSDBG_FILE 0x0040
512#define NFSDBG_ROOT 0x0080
513#define NFSDBG_CALLBACK 0x0100
514#define NFSDBG_ALL 0xFFFF
515
516#ifdef __KERNEL__
517# undef ifdebug
518# ifdef NFS_DEBUG
519# define ifdebug(fac) if (unlikely(nfs_debug & NFSDBG_##fac))
520# else
521# define ifdebug(fac) if (0)
522# endif
523#endif /* __KERNEL */
524
525#endif
This page took 0.098989 seconds and 5 git commands to generate.