[linux.git] / fs / nfs / internal.h

/*
 * NFS internal definitions
 */

#include <linux/mount.h>

struct nfs_string;

/* Maximum number of readahead requests
 * FIXME: this should really be a sysctl so that users may tune it to suit
 *        their needs. People that do NFS over a slow network, might for
 *        instance want to reduce it to something closer to 1 for improved
 *        interactive response.
 */
#define NFS_MAX_READAHEAD	(RPC_DEF_SLOT_TABLE - 1)

struct nfs_clone_mount {
	const struct super_block *sb;
	const struct dentry *dentry;
	struct nfs_fh *fh;
	struct nfs_fattr *fattr;
	char *hostname;
	char *mnt_path;
	struct sockaddr *addr;
	size_t addrlen;
	rpc_authflavor_t authflavor;
};

/*
 * In-kernel mount arguments
 */
struct nfs_parsed_mount_data {
	int			flags;
	int			rsize, wsize;
	int			timeo, retrans;
	int			acregmin, acregmax,
				acdirmin, acdirmax;
	int			namlen;
	unsigned int		bsize;
	unsigned int		auth_flavor_len;
	rpc_authflavor_t	auth_flavors[1];
	char			*client_address;

	struct {
		struct sockaddr_storage	address;
		size_t			addrlen;
		char			*hostname;
		unsigned int		version;
		unsigned short		port;
		int			protocol;
	} mount_server;

	struct {
		struct sockaddr_storage	address;
		size_t			addrlen;
		char			*hostname;
		char			*export_path;
		int			protocol;
	} nfs_server;
};

/* client.c */
extern struct rpc_program nfs_program;

extern void nfs_put_client(struct nfs_client *);
extern struct nfs_client *nfs_find_client(const struct sockaddr *, u32);
extern struct nfs_client *nfs_find_client_next(struct nfs_client *);
extern struct nfs_server *nfs_create_server(
					const struct nfs_parsed_mount_data *,
					struct nfs_fh *);
extern struct nfs_server *nfs4_create_server(
					const struct nfs_parsed_mount_data *,
					struct nfs_fh *);
extern struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *,
						      struct nfs_fh *);
extern void nfs_free_server(struct nfs_server *server);
extern struct nfs_server *nfs_clone_server(struct nfs_server *,
					   struct nfs_fh *,
					   struct nfs_fattr *);
#ifdef CONFIG_PROC_FS
extern int __init nfs_fs_proc_init(void);
extern void nfs_fs_proc_exit(void);
#else
static inline int nfs_fs_proc_init(void)
{
	return 0;
}
static inline void nfs_fs_proc_exit(void)
{
}
#endif

/* nfs4namespace.c */
#ifdef CONFIG_NFS_V4
extern struct vfsmount *nfs_do_refmount(const struct vfsmount *mnt_parent, struct dentry *dentry);
#else
static inline
struct vfsmount *nfs_do_refmount(const struct vfsmount *mnt_parent, struct dentry *dentry)
{
	return ERR_PTR(-ENOENT);
}
#endif

/* callback_xdr.c */
extern struct svc_version nfs4_callback_version1;

/* pagelist.c */
extern int __init nfs_init_nfspagecache(void);
extern void nfs_destroy_nfspagecache(void);
extern int __init nfs_init_readpagecache(void);
extern void nfs_destroy_readpagecache(void);
extern int __init nfs_init_writepagecache(void);
extern void nfs_destroy_writepagecache(void);

#ifdef CONFIG_NFS_DIRECTIO
extern int __init nfs_init_directcache(void);
extern void nfs_destroy_directcache(void);
#else
#define nfs_init_directcache() (0)
#define nfs_destroy_directcache() do {} while(0)
#endif

/* nfs2xdr.c */
extern int nfs_stat_to_errno(int);
extern struct rpc_procinfo nfs_procedures[];
extern __be32 * nfs_decode_dirent(__be32 *, struct nfs_entry *, int);

/* nfs3xdr.c */
extern struct rpc_procinfo nfs3_procedures[];
extern __be32 *nfs3_decode_dirent(__be32 *, struct nfs_entry *, int);

/* nfs4xdr.c */
#ifdef CONFIG_NFS_V4
extern __be32 *nfs4_decode_dirent(__be32 *p, struct nfs_entry *entry, int plus);
#endif

/* nfs4proc.c */
#ifdef CONFIG_NFS_V4
extern struct rpc_procinfo nfs4_procedures[];
#endif

/* dir.c */
extern int nfs_access_cache_shrinker(int nr_to_scan, gfp_t gfp_mask);

/* inode.c */
extern struct inode *nfs_alloc_inode(struct super_block *sb);
extern void nfs_destroy_inode(struct inode *);
extern int nfs_write_inode(struct inode *,int);
extern void nfs_clear_inode(struct inode *);
#ifdef CONFIG_NFS_V4
extern void nfs4_clear_inode(struct inode *);
#endif

/* super.c */
extern struct file_system_type nfs_xdev_fs_type;
#ifdef CONFIG_NFS_V4
extern struct file_system_type nfs4_xdev_fs_type;
extern struct file_system_type nfs4_referral_fs_type;
#endif

extern struct rpc_stat nfs_rpcstat;

extern int __init register_nfs_fs(void);
extern void __exit unregister_nfs_fs(void);
extern void nfs_sb_active(struct nfs_server *server);
extern void nfs_sb_deactive(struct nfs_server *server);

/* namespace.c */
extern char *nfs_path(const char *base,
		      const struct dentry *droot,
		      const struct dentry *dentry,
		      char *buffer, ssize_t buflen);

/* getroot.c */
extern struct dentry *nfs_get_root(struct super_block *, struct nfs_fh *);
#ifdef CONFIG_NFS_V4
extern struct dentry *nfs4_get_root(struct super_block *, struct nfs_fh *);

extern int nfs4_path_walk(struct nfs_server *server,
			  struct nfs_fh *mntfh,
			  const char *path);
#endif

/*
 * Determine the device name as a string
 */
static inline char *nfs_devname(const struct vfsmount *mnt_parent,
				const struct dentry *dentry,
				char *buffer, ssize_t buflen)
{
	return nfs_path(mnt_parent->mnt_devname, mnt_parent->mnt_root,
			dentry, buffer, buflen);
}

/*
 * Determine the actual block size (and log2 thereof)
 */
static inline
unsigned long nfs_block_bits(unsigned long bsize, unsigned char *nrbitsp)
{
	/* make sure blocksize is a power of two */
	if ((bsize & (bsize - 1)) || nrbitsp) {
		unsigned char	nrbits;

		for (nrbits = 31; nrbits && !(bsize & (1 << nrbits)); nrbits--)
			;
		bsize = 1 << nrbits;
		if (nrbitsp)
			*nrbitsp = nrbits;
	}

	return bsize;
}

/*
 * Calculate the number of 512byte blocks used.
 */
static inline blkcnt_t nfs_calc_block_size(u64 tsize)
{
	blkcnt_t used = (tsize + 511) >> 9;
	return (used > ULONG_MAX) ? ULONG_MAX : used;
}

/*
 * Compute and set NFS server blocksize
 */
static inline
unsigned long nfs_block_size(unsigned long bsize, unsigned char *nrbitsp)
{
	if (bsize < NFS_MIN_FILE_IO_SIZE)
		bsize = NFS_DEF_FILE_IO_SIZE;
	else if (bsize >= NFS_MAX_FILE_IO_SIZE)
		bsize = NFS_MAX_FILE_IO_SIZE;

	return nfs_block_bits(bsize, nrbitsp);
}

/*
 * Determine the maximum file size for a superblock
 */
static inline
void nfs_super_set_maxbytes(struct super_block *sb, __u64 maxfilesize)
{
	sb->s_maxbytes = (loff_t)maxfilesize;
	if (sb->s_maxbytes > MAX_LFS_FILESIZE || sb->s_maxbytes <= 0)
		sb->s_maxbytes = MAX_LFS_FILESIZE;
}

/*
 * Determine the number of bytes of data the page contains
 */
static inline
unsigned int nfs_page_length(struct page *page)
{
	loff_t i_size = i_size_read(page->mapping->host);

	if (i_size > 0) {
		pgoff_t end_index = (i_size - 1) >> PAGE_CACHE_SHIFT;
		if (page->index < end_index)
			return PAGE_CACHE_SIZE;
		if (page->index == end_index)
			return ((i_size - 1) & ~PAGE_CACHE_MASK) + 1;
	}
	return 0;
}

/*
 * Determine the number of pages in an array of length 'len' and
 * with a base offset of 'base'
 */
static inline
unsigned int nfs_page_array_len(unsigned int base, size_t len)
{
	return ((unsigned long)len + (unsigned long)base +
		PAGE_SIZE - 1) >> PAGE_SHIFT;
}
Commit	Line	Data
f7b422b1 DH	1	/*
	2	* NFS internal definitions
	3	*/
	4
	5	#include <linux/mount.h>
	6
54ceac45	7	struct nfs_string;
54ceac45 DH	8
	9	/* Maximum number of readahead requests
	10	* FIXME: this should really be a sysctl so that users may tune it to suit
	11	* their needs. People that do NFS over a slow network, might for
	12	* instance want to reduce it to something closer to 1 for improved
	13	* interactive response.
	14	*/
	15	#define NFS_MAX_READAHEAD (RPC_DEF_SLOT_TABLE - 1)
	16
f7b422b1 DH	17	struct nfs_clone_mount {
	18	const struct super_block *sb;
	19	const struct dentry *dentry;
	20	struct nfs_fh *fh;
	21	struct nfs_fattr *fattr;
	22	char *hostname;
	23	char *mnt_path;
6677d095 CL	24	struct sockaddr *addr;
6677d095 CL	25	size_t addrlen;
f7b422b1 DH	26	rpc_authflavor_t authflavor;
	27	};
	28
6b18eaa0 TT	29	/*
	30	* In-kernel mount arguments
	31	*/
	32	struct nfs_parsed_mount_data {
	33	int flags;
	34	int rsize, wsize;
	35	int timeo, retrans;
	36	int acregmin, acregmax,
	37	acdirmin, acdirmax;
	38	int namlen;
	39	unsigned int bsize;
	40	unsigned int auth_flavor_len;
	41	rpc_authflavor_t auth_flavors[1];
	42	char *client_address;
	43
	44	struct {
4c568017 CL	45	struct sockaddr_storage address;
4c568017 CL	46	size_t addrlen;
6b18eaa0	47	char *hostname;
6b18eaa0 TT	48	unsigned int version;
	49	unsigned short port;
	50	int protocol;
	51	} mount_server;
	52
	53	struct {
4c568017 CL	54	struct sockaddr_storage address;
4c568017 CL	55	size_t addrlen;
6b18eaa0 TT	56	char *hostname;
6b18eaa0 TT	57	char *export_path;
6b18eaa0 TT	58	int protocol;
	59	} nfs_server;
	60	};
	61
24c8dbbb	62	/* client.c */
54ceac45 DH	63	extern struct rpc_program nfs_program;
54ceac45 DH	64
24c8dbbb	65	extern void nfs_put_client(struct nfs_client *);
ff052645	66	extern struct nfs_client nfs_find_client(const struct sockaddr , u32);
3fbd67ad	67	extern struct nfs_client nfs_find_client_next(struct nfs_client );
2283f8d6 TT	68	extern struct nfs_server *nfs_create_server(
	69	const struct nfs_parsed_mount_data *,
	70	struct nfs_fh *);
91ea40b9 TT	71	extern struct nfs_server *nfs4_create_server(
	72	const struct nfs_parsed_mount_data *,
	73	struct nfs_fh *);
54ceac45 DH	74	extern struct nfs_server nfs4_create_referral_server(struct nfs_clone_mount ,
	75	struct nfs_fh *);
	76	extern void nfs_free_server(struct nfs_server *server);
	77	extern struct nfs_server nfs_clone_server(struct nfs_server ,
	78	struct nfs_fh *,
	79	struct nfs_fattr *);
6aaca566 DH	80	#ifdef CONFIG_PROC_FS
	81	extern int __init nfs_fs_proc_init(void);
	82	extern void nfs_fs_proc_exit(void);
	83	#else
	84	static inline int nfs_fs_proc_init(void)
	85	{
	86	return 0;
	87	}
	88	static inline void nfs_fs_proc_exit(void)
	89	{
	90	}
	91	#endif
24c8dbbb	92
7d4e2747	93	/* nfs4namespace.c */
f7b422b1 DH	94	#ifdef CONFIG_NFS_V4
	95	extern struct vfsmount nfs_do_refmount(const struct vfsmount mnt_parent, struct dentry *dentry);
	96	#else
	97	static inline
	98	struct vfsmount nfs_do_refmount(const struct vfsmount mnt_parent, struct dentry *dentry)
	99	{
	100	return ERR_PTR(-ENOENT);
	101	}
	102	#endif
	103
	104	/* callback_xdr.c */
	105	extern struct svc_version nfs4_callback_version1;
	106
	107	/* pagelist.c */
	108	extern int __init nfs_init_nfspagecache(void);
266bee88	109	extern void nfs_destroy_nfspagecache(void);
f7b422b1	110	extern int __init nfs_init_readpagecache(void);
266bee88	111	extern void nfs_destroy_readpagecache(void);
f7b422b1	112	extern int __init nfs_init_writepagecache(void);
266bee88	113	extern void nfs_destroy_writepagecache(void);
f7b422b1 DH	114
	115	#ifdef CONFIG_NFS_DIRECTIO
	116	extern int __init nfs_init_directcache(void);
266bee88	117	extern void nfs_destroy_directcache(void);
f7b422b1 DH	118	#else
	119	#define nfs_init_directcache() (0)
	120	#define nfs_destroy_directcache() do {} while(0)
	121	#endif
	122
	123	/* nfs2xdr.c */
7d4e2747	124	extern int nfs_stat_to_errno(int);
f7b422b1	125	extern struct rpc_procinfo nfs_procedures[];
0dbb4c67	126	extern __be32 * nfs_decode_dirent(__be32 , struct nfs_entry , int);
f7b422b1 DH	127
	128	/* nfs3xdr.c */
	129	extern struct rpc_procinfo nfs3_procedures[];
0dbb4c67	130	extern __be32 nfs3_decode_dirent(__be32 , struct nfs_entry *, int);
f7b422b1 DH	131
f7b422b1 DH	132	/* nfs4xdr.c */
7d4e2747	133	#ifdef CONFIG_NFS_V4
0dbb4c67	134	extern __be32 nfs4_decode_dirent(__be32 p, struct nfs_entry *entry, int plus);
7d4e2747	135	#endif
f7b422b1 DH	136
f7b422b1 DH	137	/* nfs4proc.c */
d75d5414	138	#ifdef CONFIG_NFS_V4
f7b422b1	139	extern struct rpc_procinfo nfs4_procedures[];
d75d5414	140	#endif
f7b422b1	141
979df72e TM	142	/* dir.c */
	143	extern int nfs_access_cache_shrinker(int nr_to_scan, gfp_t gfp_mask);
	144
f7b422b1 DH	145	/* inode.c */
	146	extern struct inode nfs_alloc_inode(struct super_block sb);
	147	extern void nfs_destroy_inode(struct inode *);
	148	extern int nfs_write_inode(struct inode *,int);
	149	extern void nfs_clear_inode(struct inode *);
	150	#ifdef CONFIG_NFS_V4
	151	extern void nfs4_clear_inode(struct inode *);
	152	#endif
	153
	154	/* super.c */
54ceac45	155	extern struct file_system_type nfs_xdev_fs_type;
f7b422b1	156	#ifdef CONFIG_NFS_V4
54ceac45 DH	157	extern struct file_system_type nfs4_xdev_fs_type;
54ceac45 DH	158	extern struct file_system_type nfs4_referral_fs_type;
f7b422b1	159	#endif
4ebd9ab3	160
f7b422b1	161	extern struct rpc_stat nfs_rpcstat;
4ebd9ab3	162
f7b422b1 DH	163	extern int __init register_nfs_fs(void);
f7b422b1 DH	164	extern void __exit unregister_nfs_fs(void);
ef818a28 SD	165	extern void nfs_sb_active(struct nfs_server *server);
ef818a28 SD	166	extern void nfs_sb_deactive(struct nfs_server *server);
f7b422b1 DH	167
f7b422b1 DH	168	/* namespace.c */
54ceac45 DH	169	extern char nfs_path(const char base,
	170	const struct dentry *droot,
	171	const struct dentry *dentry,
f7b422b1 DH	172	char *buffer, ssize_t buflen);
f7b422b1 DH	173
54ceac45 DH	174	/* getroot.c */
54ceac45 DH	175	extern struct dentry nfs_get_root(struct super_block , struct nfs_fh *);
7d4e2747	176	#ifdef CONFIG_NFS_V4
54ceac45 DH	177	extern struct dentry nfs4_get_root(struct super_block , struct nfs_fh *);
	178
	179	extern int nfs4_path_walk(struct nfs_server *server,
	180	struct nfs_fh *mntfh,
	181	const char *path);
7d4e2747	182	#endif
f7b422b1 DH	183
	184	/*
	185	* Determine the device name as a string
	186	*/
	187	static inline char nfs_devname(const struct vfsmount mnt_parent,
54ceac45 DH	188	const struct dentry *dentry,
54ceac45 DH	189	char *buffer, ssize_t buflen)
f7b422b1	190	{
54ceac45 DH	191	return nfs_path(mnt_parent->mnt_devname, mnt_parent->mnt_root,
54ceac45 DH	192	dentry, buffer, buflen);
f7b422b1 DH	193	}
	194
	195	/*
	196	* Determine the actual block size (and log2 thereof)
	197	*/
	198	static inline
	199	unsigned long nfs_block_bits(unsigned long bsize, unsigned char *nrbitsp)
	200	{
	201	/* make sure blocksize is a power of two */
	202	if ((bsize & (bsize - 1)) \|\| nrbitsp) {
	203	unsigned char nrbits;
	204
	205	for (nrbits = 31; nrbits && !(bsize & (1 << nrbits)); nrbits--)
	206	;
	207	bsize = 1 << nrbits;
	208	if (nrbitsp)
	209	*nrbitsp = nrbits;
	210	}
	211
	212	return bsize;
	213	}
	214
	215	/*
	216	* Calculate the number of 512byte blocks used.
	217	*/
9eaa67c6	218	static inline blkcnt_t nfs_calc_block_size(u64 tsize)
f7b422b1	219	{
9eaa67c6	220	blkcnt_t used = (tsize + 511) >> 9;
f7b422b1 DH	221	return (used > ULONG_MAX) ? ULONG_MAX : used;
	222	}
	223
	224	/*
	225	* Compute and set NFS server blocksize
	226	*/
	227	static inline
	228	unsigned long nfs_block_size(unsigned long bsize, unsigned char *nrbitsp)
	229	{
	230	if (bsize < NFS_MIN_FILE_IO_SIZE)
	231	bsize = NFS_DEF_FILE_IO_SIZE;
	232	else if (bsize >= NFS_MAX_FILE_IO_SIZE)
	233	bsize = NFS_MAX_FILE_IO_SIZE;
	234
	235	return nfs_block_bits(bsize, nrbitsp);
	236	}
	237
	238	/*
	239	* Determine the maximum file size for a superblock
	240	*/
	241	static inline
	242	void nfs_super_set_maxbytes(struct super_block *sb, __u64 maxfilesize)
	243	{
	244	sb->s_maxbytes = (loff_t)maxfilesize;
	245	if (sb->s_maxbytes > MAX_LFS_FILESIZE \|\| sb->s_maxbytes <= 0)
	246	sb->s_maxbytes = MAX_LFS_FILESIZE;
	247	}
49a70f27 TM	248
	249	/*
	250	* Determine the number of bytes of data the page contains
	251	*/
	252	static inline
	253	unsigned int nfs_page_length(struct page *page)
	254	{
	255	loff_t i_size = i_size_read(page->mapping->host);
	256
	257	if (i_size > 0) {
	258	pgoff_t end_index = (i_size - 1) >> PAGE_CACHE_SHIFT;
	259	if (page->index < end_index)
	260	return PAGE_CACHE_SIZE;
	261	if (page->index == end_index)
	262	return ((i_size - 1) & ~PAGE_CACHE_MASK) + 1;
	263	}
	264	return 0;
	265	}
8d5658c9 TM	266
	267	/*
	268	* Determine the number of pages in an array of length 'len' and
	269	* with a base offset of 'base'
	270	*/
	271	static inline
	272	unsigned int nfs_page_array_len(unsigned int base, size_t len)
	273	{
	274	return ((unsigned long)len + (unsigned long)base +
	275	PAGE_SIZE - 1) >> PAGE_SHIFT;
	276	}
	277