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

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