[mirror_ubuntu-artful-kernel.git] / fs / nfsd / vfs.h

/*
 * Copyright (C) 1995-1997 Olaf Kirch <okir@monad.swb.de>
 */

#ifndef LINUX_NFSD_VFS_H
#define LINUX_NFSD_VFS_H

#include "nfsfh.h"
#include "nfsd.h"

/*
 * Flags for nfsd_permission
 */
#define NFSD_MAY_NOP			0
#define NFSD_MAY_EXEC			0x001 /* == MAY_EXEC */
#define NFSD_MAY_WRITE			0x002 /* == MAY_WRITE */
#define NFSD_MAY_READ			0x004 /* == MAY_READ */
#define NFSD_MAY_SATTR			0x008
#define NFSD_MAY_TRUNC			0x010
#define NFSD_MAY_LOCK			0x020
#define NFSD_MAY_MASK			0x03f

/* extra hints to permission and open routines: */
#define NFSD_MAY_OWNER_OVERRIDE		0x040
#define NFSD_MAY_LOCAL_ACCESS		0x080 /* for device special files */
#define NFSD_MAY_BYPASS_GSS_ON_ROOT	0x100
#define NFSD_MAY_NOT_BREAK_LEASE	0x200
#define NFSD_MAY_BYPASS_GSS		0x400
#define NFSD_MAY_READ_IF_EXEC		0x800

#define NFSD_MAY_64BIT_COOKIE		0x1000 /* 64 bit readdir cookies for >= NFSv3 */

#define NFSD_MAY_CREATE		(NFSD_MAY_EXEC|NFSD_MAY_WRITE)
#define NFSD_MAY_REMOVE		(NFSD_MAY_EXEC|NFSD_MAY_WRITE|NFSD_MAY_TRUNC)

/*
 * Callback function for readdir
 */
typedef int (*nfsd_filldir_t)(void *, const char *, int, loff_t, u64, unsigned);

/* nfsd/vfs.c */
int		nfsd_racache_init(int);
void		nfsd_racache_shutdown(void);
int		nfsd_cross_mnt(struct svc_rqst *rqstp, struct dentry **dpp,
		                struct svc_export **expp);
__be32		nfsd_lookup(struct svc_rqst *, struct svc_fh *,
				const char *, unsigned int, struct svc_fh *);
__be32		 nfsd_lookup_dentry(struct svc_rqst *, struct svc_fh *,
				const char *, unsigned int,
				struct svc_export **, struct dentry **);
__be32		nfsd_setattr(struct svc_rqst *, struct svc_fh *,
				struct iattr *, int, time_t);
int nfsd_mountpoint(struct dentry *, struct svc_export *);
#ifdef CONFIG_NFSD_V4
__be32          nfsd4_set_nfs4_label(struct svc_rqst *, struct svc_fh *,
		    struct xdr_netobj *);
__be32		nfsd4_vfs_fallocate(struct svc_rqst *, struct svc_fh *,
				    struct file *, loff_t, loff_t, int);
__be32		nfsd4_clone_file_range(struct file *, u64, struct file *,
			u64, u64);
#endif /* CONFIG_NFSD_V4 */
__be32		nfsd_create_locked(struct svc_rqst *, struct svc_fh *,
				char *name, int len, struct iattr *attrs,
				int type, dev_t rdev, struct svc_fh *res);
__be32		nfsd_create(struct svc_rqst *, struct svc_fh *,
				char *name, int len, struct iattr *attrs,
				int type, dev_t rdev, struct svc_fh *res);
#ifdef CONFIG_NFSD_V3
__be32		nfsd_access(struct svc_rqst *, struct svc_fh *, u32 *, u32 *);
__be32		do_nfsd_create(struct svc_rqst *, struct svc_fh *,
				char *name, int len, struct iattr *attrs,
				struct svc_fh *res, int createmode,
				u32 *verifier, bool *truncp, bool *created);
__be32		nfsd_commit(struct svc_rqst *, struct svc_fh *,
				loff_t, unsigned long);
#endif /* CONFIG_NFSD_V3 */
__be32		nfsd_open(struct svc_rqst *, struct svc_fh *, umode_t,
				int, struct file **);
struct raparms;
__be32		nfsd_splice_read(struct svc_rqst *,
				struct file *, loff_t, unsigned long *);
__be32		nfsd_readv(struct file *, loff_t, struct kvec *, int,
				unsigned long *);
__be32 		nfsd_read(struct svc_rqst *, struct svc_fh *,
				loff_t, struct kvec *, int, unsigned long *);
__be32 		nfsd_write(struct svc_rqst *, struct svc_fh *, loff_t,
				struct kvec *, int, unsigned long *, int);
__be32		nfsd_vfs_write(struct svc_rqst *rqstp, struct svc_fh *fhp,
				struct file *file, loff_t offset,
				struct kvec *vec, int vlen, unsigned long *cnt,
				int stable);
__be32		nfsd_readlink(struct svc_rqst *, struct svc_fh *,
				char *, int *);
__be32		nfsd_symlink(struct svc_rqst *, struct svc_fh *,
				char *name, int len, char *path,
				struct svc_fh *res);
__be32		nfsd_link(struct svc_rqst *, struct svc_fh *,
				char *, int, struct svc_fh *);
ssize_t		nfsd_copy_file_range(struct file *, u64,
				     struct file *, u64, u64);
__be32		nfsd_rename(struct svc_rqst *,
				struct svc_fh *, char *, int,
				struct svc_fh *, char *, int);
__be32		nfsd_unlink(struct svc_rqst *, struct svc_fh *, int type,
				char *name, int len);
__be32		nfsd_readdir(struct svc_rqst *, struct svc_fh *,
			     loff_t *, struct readdir_cd *, nfsd_filldir_t);
__be32		nfsd_statfs(struct svc_rqst *, struct svc_fh *,
				struct kstatfs *, int access);

__be32		nfsd_permission(struct svc_rqst *, struct svc_export *,
				struct dentry *, int);

struct raparms *nfsd_init_raparms(struct file *file);
void		nfsd_put_raparams(struct file *file, struct raparms *ra);

static inline int fh_want_write(struct svc_fh *fh)
{
	int ret = mnt_want_write(fh->fh_export->ex_path.mnt);

	if (!ret)
		fh->fh_want_write = true;
	return ret;
}

static inline void fh_drop_write(struct svc_fh *fh)
{
	if (fh->fh_want_write) {
		fh->fh_want_write = false;
		mnt_drop_write(fh->fh_export->ex_path.mnt);
	}
}

static inline __be32 fh_getattr(struct svc_fh *fh, struct kstat *stat)
{
	struct path p = {.mnt = fh->fh_export->ex_path.mnt,
			 .dentry = fh->fh_dentry};
	return nfserrno(vfs_getattr(&p, stat, STATX_BASIC_STATS,
				    AT_STATX_SYNC_AS_STAT));
}

static inline int nfsd_create_is_exclusive(int createmode)
{
	return createmode == NFS3_CREATE_EXCLUSIVE
	       || createmode == NFS4_CREATE_EXCLUSIVE4_1;
}

static inline bool nfsd_eof_on_read(long requested, long read,
				loff_t offset, loff_t size)
{
	/* We assume a short read means eof: */
	if (requested > read)
		return true;
	/*
	 * A non-short read might also reach end of file.  The spec
	 * still requires us to set eof in that case.
	 *
	 * Further operations may have modified the file size since
	 * the read, so the following check is not atomic with the read.
	 * We've only seen that cause a problem for a client in the case
	 * where the read returned a count of 0 without setting eof.
	 * That case was fixed by the addition of the above check.
	 */
	return (offset + read >= size);
}

#endif /* LINUX_NFSD_VFS_H */
Commit	Line	Data
0a3adade BF	1	/*
	2	* Copyright (C) 1995-1997 Olaf Kirch <okir@monad.swb.de>
	3	*/
	4
	5	#ifndef LINUX_NFSD_VFS_H
	6	#define LINUX_NFSD_VFS_H
	7
1557aca7	8	#include "nfsfh.h"
3dadecce	9	#include "nfsd.h"
1557aca7	10
0a3adade BF	11	/*
	12	* Flags for nfsd_permission
	13	*/
8e82fa8f BF	14	#define NFSD_MAY_NOP 0
	15	#define NFSD_MAY_EXEC 0x001 /* == MAY_EXEC */
	16	#define NFSD_MAY_WRITE 0x002 /* == MAY_WRITE */
	17	#define NFSD_MAY_READ 0x004 /* == MAY_READ */
	18	#define NFSD_MAY_SATTR 0x008
	19	#define NFSD_MAY_TRUNC 0x010
	20	#define NFSD_MAY_LOCK 0x020
	21	#define NFSD_MAY_MASK 0x03f
aea93397 BF	22
aea93397 BF	23	/* extra hints to permission and open routines: */
8e82fa8f BF	24	#define NFSD_MAY_OWNER_OVERRIDE 0x040
	25	#define NFSD_MAY_LOCAL_ACCESS 0x080 /* for device special files */
	26	#define NFSD_MAY_BYPASS_GSS_ON_ROOT 0x100
	27	#define NFSD_MAY_NOT_BREAK_LEASE 0x200
	28	#define NFSD_MAY_BYPASS_GSS 0x400
	29	#define NFSD_MAY_READ_IF_EXEC 0x800
0a3adade	30
06effdbb BS	31	#define NFSD_MAY_64BIT_COOKIE 0x1000 /* 64 bit readdir cookies for >= NFSv3 */
06effdbb BS	32
0a3adade BF	33	#define NFSD_MAY_CREATE (NFSD_MAY_EXEC\|NFSD_MAY_WRITE)
	34	#define NFSD_MAY_REMOVE (NFSD_MAY_EXEC\|NFSD_MAY_WRITE\|NFSD_MAY_TRUNC)
	35
	36	/*
	37	* Callback function for readdir
	38	*/
ac7576f4	39	typedef int (nfsd_filldir_t)(void , const char *, int, loff_t, u64, unsigned);
0a3adade BF	40
0a3adade BF	41	/* nfsd/vfs.c */
0a3adade BF	42	int nfsd_racache_init(int);
	43	void nfsd_racache_shutdown(void);
	44	int nfsd_cross_mnt(struct svc_rqst rqstp, struct dentry *dpp,
	45	struct svc_export **expp);
	46	__be32 nfsd_lookup(struct svc_rqst , struct svc_fh ,
	47	const char , unsigned int, struct svc_fh );
	48	__be32 nfsd_lookup_dentry(struct svc_rqst , struct svc_fh ,
	49	const char *, unsigned int,
	50	struct svc_export , struct dentry );
	51	__be32 nfsd_setattr(struct svc_rqst , struct svc_fh ,
	52	struct iattr *, int, time_t);
3227fa41	53	int nfsd_mountpoint(struct dentry , struct svc_export );
0a3adade	54	#ifdef CONFIG_NFSD_V4
18032ca0 DQ	55	__be32 nfsd4_set_nfs4_label(struct svc_rqst , struct svc_fh ,
18032ca0 DQ	56	struct xdr_netobj *);
95d871f0 AS	57	__be32 nfsd4_vfs_fallocate(struct svc_rqst , struct svc_fh ,
95d871f0 AS	58	struct file *, loff_t, loff_t, int);
ffa0160a CH	59	__be32 nfsd4_clone_file_range(struct file , u64, struct file ,
ffa0160a CH	60	u64, u64);
0a3adade	61	#endif /* CONFIG_NFSD_V4 */
b44061d0 BF	62	__be32 nfsd_create_locked(struct svc_rqst , struct svc_fh ,
	63	char name, int len, struct iattr attrs,
	64	int type, dev_t rdev, struct svc_fh *res);
0a3adade BF	65	__be32 nfsd_create(struct svc_rqst , struct svc_fh ,
	66	char name, int len, struct iattr attrs,
	67	int type, dev_t rdev, struct svc_fh *res);
	68	#ifdef CONFIG_NFSD_V3
	69	__be32 nfsd_access(struct svc_rqst , struct svc_fh , u32 , u32 );
ac6721a1	70	__be32 do_nfsd_create(struct svc_rqst , struct svc_fh ,
0a3adade BF	71	char name, int len, struct iattr attrs,
0a3adade BF	72	struct svc_fh *res, int createmode,
856121b2	73	u32 verifier, bool truncp, bool *created);
0a3adade BF	74	__be32 nfsd_commit(struct svc_rqst , struct svc_fh ,
	75	loff_t, unsigned long);
	76	#endif /* CONFIG_NFSD_V3 */
175a4eb7	77	__be32 nfsd_open(struct svc_rqst , struct svc_fh , umode_t,
0a3adade	78	int, struct file **);
dc97618d	79	struct raparms;
e2afc819	80	__be32 nfsd_splice_read(struct svc_rqst *,
dc97618d	81	struct file , loff_t, unsigned long );
e2afc819	82	__be32 nfsd_readv(struct file , loff_t, struct kvec , int,
dc97618d	83	unsigned long *);
039a87ca BF	84	__be32 nfsd_read(struct svc_rqst , struct svc_fh ,
039a87ca BF	85	loff_t, struct kvec , int, unsigned long );
52e380e0 KM	86	__be32 nfsd_write(struct svc_rqst , struct svc_fh , loff_t,
52e380e0 KM	87	struct kvec , int, unsigned long , int);
af90f707 CH	88	__be32 nfsd_vfs_write(struct svc_rqst rqstp, struct svc_fh fhp,
	89	struct file *file, loff_t offset,
	90	struct kvec vec, int vlen, unsigned long cnt,
54bbb7d2	91	int stable);
0a3adade BF	92	__be32 nfsd_readlink(struct svc_rqst , struct svc_fh ,
	93	char , int );
	94	__be32 nfsd_symlink(struct svc_rqst , struct svc_fh ,
52ee0433	95	char name, int len, char path,
1e444f5b	96	struct svc_fh *res);
0a3adade BF	97	__be32 nfsd_link(struct svc_rqst , struct svc_fh ,
0a3adade BF	98	char , int, struct svc_fh );
29ae7f9d AS	99	ssize_t nfsd_copy_file_range(struct file *, u64,
29ae7f9d AS	100	struct file *, u64, u64);
0a3adade BF	101	__be32 nfsd_rename(struct svc_rqst *,
	102	struct svc_fh , char , int,
	103	struct svc_fh , char , int);
0a3adade BF	104	__be32 nfsd_unlink(struct svc_rqst , struct svc_fh , int type,
0a3adade BF	105	char *name, int len);
0a3adade	106	__be32 nfsd_readdir(struct svc_rqst , struct svc_fh ,
ac7576f4	107	loff_t , struct readdir_cd , nfsd_filldir_t);
0a3adade BF	108	__be32 nfsd_statfs(struct svc_rqst , struct svc_fh ,
	109	struct kstatfs *, int access);
	110
0a3adade BF	111	__be32 nfsd_permission(struct svc_rqst , struct svc_export ,
0a3adade BF	112	struct dentry *, int);
0a3adade	113
e749a462 CH	114	struct raparms nfsd_init_raparms(struct file file);
	115	void nfsd_put_raparams(struct file file, struct raparms ra);
	116
bad0dcff AV	117	static inline int fh_want_write(struct svc_fh *fh)
bad0dcff AV	118	{
4a55c101 JK	119	int ret = mnt_want_write(fh->fh_export->ex_path.mnt);
	120
	121	if (!ret)
aaf91ec1	122	fh->fh_want_write = true;
4a55c101	123	return ret;
bad0dcff AV	124	}
	125
	126	static inline void fh_drop_write(struct svc_fh *fh)
	127	{
4a55c101	128	if (fh->fh_want_write) {
aaf91ec1	129	fh->fh_want_write = false;
4a55c101 JK	130	mnt_drop_write(fh->fh_export->ex_path.mnt);
4a55c101 JK	131	}
bad0dcff AV	132	}
bad0dcff AV	133
3dadecce AV	134	static inline __be32 fh_getattr(struct svc_fh fh, struct kstat stat)
	135	{
	136	struct path p = {.mnt = fh->fh_export->ex_path.mnt,
	137	.dentry = fh->fh_dentry};
a528d35e DH	138	return nfserrno(vfs_getattr(&p, stat, STATX_BASIC_STATS,
a528d35e DH	139	AT_STATX_SYNC_AS_STAT));
3dadecce AV	140	}
3dadecce AV	141
ead8fb8c KM	142	static inline int nfsd_create_is_exclusive(int createmode)
	143	{
	144	return createmode == NFS3_CREATE_EXCLUSIVE
	145	\|\| createmode == NFS4_CREATE_EXCLUSIVE4_1;
	146	}
	147
ac503e4a BC	148	static inline bool nfsd_eof_on_read(long requested, long read,
	149	loff_t offset, loff_t size)
	150	{
	151	/* We assume a short read means eof: */
	152	if (requested > read)
	153	return true;
	154	/*
	155	* A non-short read might also reach end of file. The spec
	156	* still requires us to set eof in that case.
	157	*
	158	* Further operations may have modified the file size since
	159	* the read, so the following check is not atomic with the read.
	160	* We've only seen that cause a problem for a client in the case
	161	* where the read returned a count of 0 without setting eof.
	162	* That case was fixed by the addition of the above check.
	163	*/
	164	return (offset + read >= size);
	165	}
	166
0a3adade	167	#endif /* LINUX_NFSD_VFS_H */