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

/*
 * NFS internal definitions
 */

#include <linux/mount.h>
#include <linux/security.h>

#define NFS_MS_MASK (MS_RDONLY|MS_NOSUID|MS_NODEV|MS_NOEXEC|MS_SYNCHRONOUS)

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

/*
 * Note: RFC 1813 doesn't limit the number of auth flavors that
 * a server can return, so make something up.
 */
#define NFS_MAX_SECFLAVORS	(12)

/*
 * 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		options;
	unsigned int		bsize;
	unsigned int		auth_flavor_len;
	rpc_authflavor_t	auth_flavors[1];
	char			*client_address;
	char			*fscache_uniq;

	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

/* proc.c */
void nfs_close_context(struct nfs_open_context *ctx, int is_sync);

/* 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);
extern int nfs_wait_bit_killable(void *word);

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