[linux.git] / fs / nfsd / vfs.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 * Copyright (C) 1995-1997 Olaf Kirch <[email protected]>
 */

#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 *rqstp, struct svc_fh *fhp,
				struct file *file, loff_t offset,
				unsigned long *count);
__be32		nfsd_readv(struct svc_rqst *rqstp, struct svc_fh *fhp,
				struct file *file, loff_t offset,
				struct kvec *vec, int vlen,
				unsigned long *count);
__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;

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