[mirror_ubuntu-bionic-kernel.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;
};

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