nfs_fs.h 15.7 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8 9 10 11
/*
 *  linux/include/linux/nfs_fs.h
 *
 *  Copyright (C) 1992  Rick Sladkey
 *
 *  OS-specific nfs filesystem definitions and declarations
 */

#ifndef _LINUX_NFS_FS_H
#define _LINUX_NFS_FS_H

12 13
#include <linux/magic.h>

L
Linus Torvalds 已提交
14 15 16 17 18 19 20 21
/*
 * Enable debugging support for nfs client.
 * Requires RPC_DEBUG.
 */
#ifdef RPC_DEBUG
# define NFS_DEBUG
#endif

22 23 24 25
/* Default timeout values */
#define NFS_MAX_UDP_TIMEOUT	(60*HZ)
#define NFS_MAX_TCP_TIMEOUT	(600*HZ)

L
Linus Torvalds 已提交
26 27 28 29 30 31 32 33
/*
 * When flushing a cluster of dirty pages, there can be different
 * strategies:
 */
#define FLUSH_SYNC		1	/* file being synced, or contention */
#define FLUSH_STABLE		4	/* commit to stable storage */
#define FLUSH_LOWPRI		8	/* low priority background flush */
#define FLUSH_HIGHPRI		16	/* high priority memory reclaim flush */
34
#define FLUSH_NOCOMMIT		32	/* Don't send the NFSv3/v4 COMMIT */
35
#define FLUSH_INVALIDATE	64	/* Invalidate the page cache */
L
Linus Torvalds 已提交
36 37 38

#ifdef __KERNEL__

39 40 41
#include <linux/in.h>
#include <linux/mm.h>
#include <linux/pagemap.h>
42
#include <linux/rbtree.h>
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
#include <linux/rwsem.h>
#include <linux/wait.h>

#include <linux/sunrpc/debug.h>
#include <linux/sunrpc/auth.h>
#include <linux/sunrpc/clnt.h>

#include <linux/nfs.h>
#include <linux/nfs2.h>
#include <linux/nfs3.h>
#include <linux/nfs4.h>
#include <linux/nfs_xdr.h>

#include <linux/nfs_fs_sb.h>

#include <linux/rwsem.h>
#include <linux/mempool.h>

/*
 * These are the default flags for swap requests
 */
#define NFS_RPC_SWAPFLAGS		(RPC_TASK_SWAPPER|RPC_TASK_ROOTCREDS)

L
Linus Torvalds 已提交
66 67 68 69
/*
 * NFSv3/v4 Access mode cache entry
 */
struct nfs_access_entry {
70
	struct rb_node		rb_node;
71
	struct list_head	lru;
L
Linus Torvalds 已提交
72 73 74 75 76 77 78 79
	unsigned long		jiffies;
	struct rpc_cred *	cred;
	int			mask;
};

struct nfs4_state;
struct nfs_open_context {
	atomic_t count;
80
	struct vfsmount *vfsmnt;
L
Linus Torvalds 已提交
81 82 83 84 85 86 87 88
	struct dentry *dentry;
	struct rpc_cred *cred;
	struct nfs4_state *state;
	fl_owner_t lockowner;
	int mode;
	int error;

	struct list_head list;
89 90

	__u64 dir_cookie;
L
Linus Torvalds 已提交
91 92 93 94 95 96 97
};

/*
 * NFSv4 delegation
 */
struct nfs_delegation;

98 99
struct posix_acl;

L
Linus Torvalds 已提交
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116
/*
 * nfs fs inode data in memory
 */
struct nfs_inode {
	/*
	 * The 64bit 'inode number'
	 */
	__u64 fileid;

	/*
	 * NFS file handle
	 */
	struct nfs_fh		fh;

	/*
	 * Various flags
	 */
117 118
	unsigned long		flags;			/* atomic bit ops */
	unsigned long		cache_validity;		/* bit mask */
L
Linus Torvalds 已提交
119 120

	/*
121
	 * read_cache_jiffies is when we started read-caching this inode.
L
Linus Torvalds 已提交
122 123 124 125 126 127 128 129 130 131 132 133 134 135
	 * attrtimeo is for how long the cached information is assumed
	 * to be valid. A successful attribute revalidation doubles
	 * attrtimeo (up to acregmax/acdirmax), a failure resets it to
	 * acregmin/acdirmin.
	 *
	 * We need to revalidate the cached attrs for this inode if
	 *
	 *	jiffies - read_cache_jiffies > attrtimeo
	 */
	unsigned long		read_cache_jiffies;
	unsigned long		attrtimeo;
	unsigned long		attrtimeo_timestamp;
	__u64			change_attr;		/* v4 only */

136
	unsigned long		last_updated;
L
Linus Torvalds 已提交
137 138 139 140 141 142 143 144 145 146 147
	/* "Generation counter" for the attribute cache. This is
	 * bumped whenever we update the metadata on the
	 * server.
	 */
	unsigned long		cache_change_attribute;
	/*
	 * Counter indicating the number of outstanding requests that
	 * will cause a file data update.
	 */
	atomic_t		data_updates;

148
	struct rb_root		access_cache;
149 150
	struct list_head	access_cache_entry_lru;
	struct list_head	access_cache_inode_lru;
151 152 153 154
#ifdef CONFIG_NFS_V3_ACL
	struct posix_acl	*acl_access;
	struct posix_acl	*acl_default;
#endif
L
Linus Torvalds 已提交
155 156 157 158 159

	/*
	 * This is the cookie verifier used for NFSv3 readdir
	 * operations
	 */
A
Al Viro 已提交
160
	__be32			cookieverf[2];
L
Linus Torvalds 已提交
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177

	/*
	 * This is the list of dirty unwritten pages.
	 */
	spinlock_t		req_lock;
	struct list_head	dirty;
	struct list_head	commit;
	struct radix_tree_root	nfs_page_tree;

	unsigned int		ndirty,
				ncommit,
				npages;

	/* Open contexts for shared mmap writes */
	struct list_head	open_files;

#ifdef CONFIG_NFS_V4
178
	struct nfs4_cached_acl	*nfs4_acl;
L
Linus Torvalds 已提交
179 180 181 182 183 184 185 186 187 188
        /* NFSv4 state */
	struct list_head	open_states;
	struct nfs_delegation	*delegation;
	int			 delegation_state;
	struct rw_semaphore	rwsem;
#endif /* CONFIG_NFS_V4*/
	struct inode		vfs_inode;
};

/*
189
 * Cache validity bit flags
L
Linus Torvalds 已提交
190
 */
191 192 193 194 195 196 197 198
#define NFS_INO_INVALID_ATTR	0x0001		/* cached attrs are invalid */
#define NFS_INO_INVALID_DATA	0x0002		/* cached data is invalid */
#define NFS_INO_INVALID_ATIME	0x0004		/* cached atime is invalid */
#define NFS_INO_INVALID_ACCESS	0x0008		/* cached access cred invalid */
#define NFS_INO_INVALID_ACL	0x0010		/* cached acls are invalid */
#define NFS_INO_REVAL_PAGECACHE	0x0020		/* must revalidate pagecache */

/*
199
 * Bit offsets in flags field
200
 */
201 202 203
#define NFS_INO_REVALIDATING	(0)		/* revalidating attrs */
#define NFS_INO_ADVISE_RDPLUS	(1)		/* advise readdirplus */
#define NFS_INO_STALE		(2)		/* possible stale inode */
204
#define NFS_INO_ACL_LRU_SET	(3)		/* Inode is on the LRU list */
L
Linus Torvalds 已提交
205 206 207 208 209 210 211 212 213 214

static inline struct nfs_inode *NFS_I(struct inode *inode)
{
	return container_of(inode, struct nfs_inode, vfs_inode);
}
#define NFS_SB(s)		((struct nfs_server *)(s->s_fs_info))

#define NFS_FH(inode)			(&NFS_I(inode)->fh)
#define NFS_SERVER(inode)		(NFS_SB(inode->i_sb))
#define NFS_CLIENT(inode)		(NFS_SERVER(inode)->client)
215
#define NFS_PROTO(inode)		(NFS_SERVER(inode)->nfs_client->rpc_ops)
L
Linus Torvalds 已提交
216 217 218 219 220 221 222 223 224 225 226 227 228
#define NFS_COOKIEVERF(inode)		(NFS_I(inode)->cookieverf)
#define NFS_READTIME(inode)		(NFS_I(inode)->read_cache_jiffies)
#define NFS_CHANGE_ATTR(inode)		(NFS_I(inode)->change_attr)
#define NFS_ATTRTIMEO(inode)		(NFS_I(inode)->attrtimeo)
#define NFS_MINATTRTIMEO(inode) \
	(S_ISDIR(inode->i_mode)? NFS_SERVER(inode)->acdirmin \
			       : NFS_SERVER(inode)->acregmin)
#define NFS_MAXATTRTIMEO(inode) \
	(S_ISDIR(inode->i_mode)? NFS_SERVER(inode)->acdirmax \
			       : NFS_SERVER(inode)->acregmax)
#define NFS_ATTRTIMEO_UPDATE(inode)	(NFS_I(inode)->attrtimeo_timestamp)

#define NFS_FLAGS(inode)		(NFS_I(inode)->flags)
229
#define NFS_STALE(inode)		(test_bit(NFS_INO_STALE, &NFS_FLAGS(inode)))
L
Linus Torvalds 已提交
230 231 232 233 234 235 236 237

#define NFS_FILEID(inode)		(NFS_I(inode)->fileid)

static inline int nfs_caches_unstable(struct inode *inode)
{
	return atomic_read(&NFS_I(inode)->data_updates) != 0;
}

238 239
static inline void nfs_mark_for_revalidate(struct inode *inode)
{
240 241
	struct nfs_inode *nfsi = NFS_I(inode);

242
	spin_lock(&inode->i_lock);
243 244 245
	nfsi->cache_validity |= NFS_INO_INVALID_ATTR|NFS_INO_INVALID_ACCESS;
	if (S_ISDIR(inode->i_mode))
		nfsi->cache_validity |= NFS_INO_REVAL_PAGECACHE|NFS_INO_INVALID_DATA;
246 247 248
	spin_unlock(&inode->i_lock);
}

L
Linus Torvalds 已提交
249 250
static inline void NFS_CACHEINV(struct inode *inode)
{
251 252
	if (!nfs_caches_unstable(inode))
		nfs_mark_for_revalidate(inode);
L
Linus Torvalds 已提交
253 254 255 256 257 258 259 260 261
}

static inline int nfs_server_capable(struct inode *inode, int cap)
{
	return NFS_SERVER(inode)->caps & cap;
}

static inline int NFS_USE_READDIRPLUS(struct inode *inode)
{
262
	return test_bit(NFS_INO_ADVISE_RDPLUS, &NFS_FLAGS(inode));
L
Linus Torvalds 已提交
263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
}

/**
 * nfs_save_change_attribute - Returns the inode attribute change cookie
 * @inode - pointer to inode
 * The "change attribute" is updated every time we finish an operation
 * that will result in a metadata change on the server.
 */
static inline long nfs_save_change_attribute(struct inode *inode)
{
	return NFS_I(inode)->cache_change_attribute;
}

/**
 * nfs_verify_change_attribute - Detects NFS inode cache updates
 * @inode - pointer to inode
 * @chattr - previously saved change attribute
 * Return "false" if metadata has been updated (or is in the process of
 * being updated) since the change attribute was saved.
 */
static inline int nfs_verify_change_attribute(struct inode *inode, unsigned long chattr)
{
	return !nfs_caches_unstable(inode)
286
		&& time_after_eq(chattr, NFS_I(inode)->cache_change_attribute);
L
Linus Torvalds 已提交
287 288 289 290 291
}

/*
 * linux/fs/nfs/inode.c
 */
T
Trond Myklebust 已提交
292
extern int nfs_sync_mapping(struct address_space *mapping);
293
extern void nfs_zap_mapping(struct inode *inode, struct address_space *mapping);
L
Linus Torvalds 已提交
294 295 296 297
extern void nfs_zap_caches(struct inode *);
extern struct inode *nfs_fhget(struct super_block *, struct nfs_fh *,
				struct nfs_fattr *);
extern int nfs_refresh_inode(struct inode *, struct nfs_fattr *);
298
extern int nfs_post_op_update_inode(struct inode *inode, struct nfs_fattr *fattr);
L
Linus Torvalds 已提交
299 300 301 302
extern int nfs_getattr(struct vfsmount *, struct dentry *, struct kstat *);
extern int nfs_permission(struct inode *, int, struct nameidata *);
extern int nfs_access_get_cached(struct inode *, struct rpc_cred *, struct nfs_access_entry *);
extern void nfs_access_add_cache(struct inode *, struct nfs_access_entry *);
303
extern void nfs_access_zap_cache(struct inode *inode);
L
Linus Torvalds 已提交
304 305 306 307 308
extern int nfs_open(struct inode *, struct file *);
extern int nfs_release(struct inode *, struct file *);
extern int nfs_attribute_timeout(struct inode *inode);
extern int nfs_revalidate_inode(struct nfs_server *server, struct inode *inode);
extern int __nfs_revalidate_inode(struct nfs_server *, struct inode *);
309
extern int nfs_revalidate_mapping(struct inode *inode, struct address_space *mapping);
L
Linus Torvalds 已提交
310
extern int nfs_setattr(struct dentry *, struct iattr *);
311
extern void nfs_setattr_update_inode(struct inode *inode, struct iattr *attr);
L
Linus Torvalds 已提交
312 313 314 315 316 317
extern void nfs_begin_attr_update(struct inode *);
extern void nfs_end_attr_update(struct inode *);
extern void nfs_begin_data_update(struct inode *);
extern void nfs_end_data_update(struct inode *);
extern struct nfs_open_context *get_nfs_open_context(struct nfs_open_context *ctx);
extern void put_nfs_open_context(struct nfs_open_context *ctx);
318
extern struct nfs_open_context *nfs_find_open_context(struct inode *inode, struct rpc_cred *cred, int mode);
L
Linus Torvalds 已提交
319 320

/* linux/net/ipv4/ipconfig.c: trims ip addr off front of name, too. */
A
Al Viro 已提交
321
extern __be32 root_nfs_parse_addr(char *name); /*__init*/
L
Linus Torvalds 已提交
322

323 324 325
static inline void nfs_fattr_init(struct nfs_fattr *fattr)
{
	fattr->valid = 0;
326
	fattr->time_start = jiffies;
327 328
}

L
Linus Torvalds 已提交
329 330 331 332
/*
 * linux/fs/nfs/file.c
 */
extern struct inode_operations nfs_file_inode_operations;
333 334 335
#ifdef CONFIG_NFS_V3
extern struct inode_operations nfs3_file_inode_operations;
#endif /* CONFIG_NFS_V3 */
336
extern const struct file_operations nfs_file_operations;
337
extern const struct address_space_operations nfs_file_aops;
L
Linus Torvalds 已提交
338 339 340 341 342 343 344 345 346 347 348 349

static inline struct rpc_cred *nfs_file_cred(struct file *file)
{
	if (file != NULL) {
		struct nfs_open_context *ctx;

		ctx = (struct nfs_open_context*)file->private_data;
		return ctx->cred;
	}
	return NULL;
}

350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365
/*
 * linux/fs/nfs/xattr.c
 */
#ifdef CONFIG_NFS_V3_ACL
extern ssize_t nfs3_listxattr(struct dentry *, char *, size_t);
extern ssize_t nfs3_getxattr(struct dentry *, const char *, void *, size_t);
extern int nfs3_setxattr(struct dentry *, const char *,
			const void *, size_t, int);
extern int nfs3_removexattr (struct dentry *, const char *name);
#else
# define nfs3_listxattr NULL
# define nfs3_getxattr NULL
# define nfs3_setxattr NULL
# define nfs3_removexattr NULL
#endif

L
Linus Torvalds 已提交
366 367 368 369 370
/*
 * linux/fs/nfs/direct.c
 */
extern ssize_t nfs_direct_IO(int, struct kiocb *, const struct iovec *, loff_t,
			unsigned long);
371 372 373 374 375 376
extern ssize_t nfs_file_direct_read(struct kiocb *iocb,
			const struct iovec *iov, unsigned long nr_segs,
			loff_t pos);
extern ssize_t nfs_file_direct_write(struct kiocb *iocb,
			const struct iovec *iov, unsigned long nr_segs,
			loff_t pos);
L
Linus Torvalds 已提交
377 378 379 380 381

/*
 * linux/fs/nfs/dir.c
 */
extern struct inode_operations nfs_dir_inode_operations;
382 383 384
#ifdef CONFIG_NFS_V3
extern struct inode_operations nfs3_dir_inode_operations;
#endif /* CONFIG_NFS_V3 */
385
extern const struct file_operations nfs_dir_operations;
L
Linus Torvalds 已提交
386 387 388 389 390 391 392 393 394
extern struct dentry_operations nfs_dentry_operations;

extern int nfs_instantiate(struct dentry *dentry, struct nfs_fh *fh, struct nfs_fattr *fattr);

/*
 * linux/fs/nfs/symlink.c
 */
extern struct inode_operations nfs_symlink_inode_operations;

395 396 397 398 399 400 401
/*
 * linux/fs/nfs/sysctl.c
 */
#ifdef CONFIG_SYSCTL
extern int nfs_register_sysctl(void);
extern void nfs_unregister_sysctl(void);
#else
402
#define nfs_register_sysctl() 0
403 404 405
#define nfs_unregister_sysctl() do { } while(0)
#endif

406 407 408
/*
 * linux/fs/nfs/namespace.c
 */
T
Trond Myklebust 已提交
409
extern struct list_head nfs_automount_list;
410
extern struct inode_operations nfs_mountpoint_inode_operations;
M
Manoj Naik 已提交
411
extern struct inode_operations nfs_referral_inode_operations;
T
Trond Myklebust 已提交
412 413
extern int nfs_mountpoint_expiry_timeout;
extern void nfs_release_automount_timer(void);
414

L
Linus Torvalds 已提交
415 416 417 418 419 420 421 422 423 424 425 426 427
/*
 * linux/fs/nfs/unlink.c
 */
extern int  nfs_async_unlink(struct dentry *);
extern void nfs_complete_unlink(struct dentry *);

/*
 * linux/fs/nfs/write.c
 */
extern int  nfs_writepage(struct page *page, struct writeback_control *wbc);
extern int  nfs_writepages(struct address_space *, struct writeback_control *);
extern int  nfs_flush_incompatible(struct file *file, struct page *page);
extern int  nfs_updatepage(struct file *, struct page *, unsigned int, unsigned int);
428 429
extern int nfs_writeback_done(struct rpc_task *, struct nfs_write_data *);
extern void nfs_writedata_release(void *);
L
Linus Torvalds 已提交
430 431 432 433 434

/*
 * Try to write back everything synchronously (but check the
 * return value!)
 */
435 436 437 438
extern long nfs_sync_mapping_wait(struct address_space *, struct writeback_control *, int);
extern int nfs_sync_mapping_range(struct address_space *, loff_t, loff_t, int);
extern int nfs_wb_all(struct inode *inode);
extern int nfs_wb_page(struct inode *inode, struct page* page);
L
Linus Torvalds 已提交
439
#if defined(CONFIG_NFS_V3) || defined(CONFIG_NFS_V4)
440
extern int  nfs_commit_inode(struct inode *, int);
441 442
extern struct nfs_write_data *nfs_commit_alloc(void);
extern void nfs_commit_free(struct nfs_write_data *wdata);
443
extern void nfs_commit_release(void *wdata);
L
Linus Torvalds 已提交
444 445
#else
static inline int
446
nfs_commit_inode(struct inode *inode, int how)
L
Linus Torvalds 已提交
447 448 449 450 451 452 453 454 455 456 457 458
{
	return 0;
}
#endif

static inline int
nfs_have_writebacks(struct inode *inode)
{
	return NFS_I(inode)->npages != 0;
}

/*
A
Adrian Bunk 已提交
459
 * Allocate nfs_write_data structures
L
Linus Torvalds 已提交
460
 */
461
extern struct nfs_write_data *nfs_writedata_alloc(size_t len);
L
Linus Torvalds 已提交
462 463 464 465 466 467 468

/*
 * linux/fs/nfs/read.c
 */
extern int  nfs_readpage(struct file *, struct page *);
extern int  nfs_readpages(struct file *, struct address_space *,
		struct list_head *, unsigned);
T
Trond Myklebust 已提交
469 470
extern int  nfs_readpage_result(struct rpc_task *, struct nfs_read_data *);
extern void nfs_readdata_release(void *data);
471

L
Linus Torvalds 已提交
472
/*
A
Adrian Bunk 已提交
473
 * Allocate nfs_read_data structures
L
Linus Torvalds 已提交
474
 */
475
extern struct nfs_read_data *nfs_readdata_alloc(size_t len);
L
Linus Torvalds 已提交
476

477 478 479 480 481 482 483
/*
 * linux/fs/nfs3proc.c
 */
#ifdef CONFIG_NFS_V3_ACL
extern struct posix_acl *nfs3_proc_getacl(struct inode *inode, int type);
extern int nfs3_proc_setacl(struct inode *inode, int type,
			    struct posix_acl *acl);
484 485
extern int nfs3_proc_set_default_acl(struct inode *dir, struct inode *inode,
		mode_t mode);
486
extern void nfs3_forget_cached_acls(struct inode *inode);
487 488 489 490 491 492 493
#else
static inline int nfs3_proc_set_default_acl(struct inode *dir,
					    struct inode *inode,
					    mode_t mode)
{
	return 0;
}
494 495 496 497

static inline void nfs3_forget_cached_acls(struct inode *inode)
{
}
498 499
#endif /* CONFIG_NFS_V3_ACL */

L
Linus Torvalds 已提交
500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561
/*
 * linux/fs/mount_clnt.c
 * (Used only by nfsroot module)
 */
extern int  nfsroot_mount(struct sockaddr_in *, char *, struct nfs_fh *,
		int, int);

/*
 * inline functions
 */

static inline loff_t
nfs_size_to_loff_t(__u64 size)
{
	loff_t maxsz = (((loff_t) ULONG_MAX) << PAGE_CACHE_SHIFT) + PAGE_CACHE_SIZE - 1;
	if (size > maxsz)
		return maxsz;
	return (loff_t) size;
}

static inline ino_t
nfs_fileid_to_ino_t(u64 fileid)
{
	ino_t ino = (ino_t) fileid;
	if (sizeof(ino_t) < sizeof(u64))
		ino ^= fileid >> (sizeof(u64)-sizeof(ino_t)) * 8;
	return ino;
}

/* NFS root */

extern void * nfs_root_data(void);

#define nfs_wait_event(clnt, wq, condition)				\
({									\
	int __retval = 0;						\
	if (clnt->cl_intr) {						\
		sigset_t oldmask;					\
		rpc_clnt_sigmask(clnt, &oldmask);			\
		__retval = wait_event_interruptible(wq, condition);	\
		rpc_clnt_sigunmask(clnt, &oldmask);			\
	} else								\
		wait_event(wq, condition);				\
	__retval;							\
})

#define NFS_JUKEBOX_RETRY_TIME (5 * HZ)

#endif /* __KERNEL__ */

/*
 * NFS debug flags
 */
#define NFSDBG_VFS		0x0001
#define NFSDBG_DIRCACHE		0x0002
#define NFSDBG_LOOKUPCACHE	0x0004
#define NFSDBG_PAGECACHE	0x0008
#define NFSDBG_PROC		0x0010
#define NFSDBG_XDR		0x0020
#define NFSDBG_FILE		0x0040
#define NFSDBG_ROOT		0x0080
#define NFSDBG_CALLBACK		0x0100
562
#define NFSDBG_CLIENT		0x0200
L
Linus Torvalds 已提交
563 564 565 566 567 568 569 570 571 572 573 574
#define NFSDBG_ALL		0xFFFF

#ifdef __KERNEL__
# undef ifdebug
# ifdef NFS_DEBUG
#  define ifdebug(fac)		if (unlikely(nfs_debug & NFSDBG_##fac))
# else
#  define ifdebug(fac)		if (0)
# endif
#endif /* __KERNEL */

#endif