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

/*
 * NFS internal definitions
 */

#include <linux/mount.h>
#include <linux/security.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;
		u32			version;
		unsigned short		port;
		unsigned short		protocol;
	} mount_server;

	struct {
		struct sockaddr_storage	address;
		size_t			addrlen;
		char			*hostname;
		char			*export_path;
		unsigned short		port;
		unsigned short		protocol;
	} nfs_server;

	struct security_mnt_opts lsm_opts;
};

/* mount_clnt.c */
struct nfs_mount_request {
	struct sockaddr		*sap;
	size_t			salen;
	char			*hostname;
	char			*dirpath;
	u32			version;
	unsigned short		protocol;
	struct nfs_fh		*fh;
	int			noresvport;
};

extern int nfs_mount(struct nfs_mount_request *info);

/* 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);

extern int __init nfs_init_directcache(void);
extern void nfs_destroy_directcache(void);

/* 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 workqueue_struct *nfsiod_workqueue;
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
void nfs_zap_acl_cache(struct inode *inode);

/* super.c */
void nfs_parse_ip_address(char *, size_t, struct sockaddr *, size_t *);
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 super_block *sb);
extern void nfs_sb_deactive(struct super_block *sb);

/* 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;
}

#define IPV6_SCOPE_DELIMITER	'%'

/*
 * Set the port number in an address.  Be agnostic about the address
 * family.
 */
static inline void nfs_set_port(struct sockaddr *sap, unsigned short port)
{
	struct sockaddr_in *ap = (struct sockaddr_in *)sap;
	struct sockaddr_in6 *ap6 = (struct sockaddr_in6 *)sap;

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