[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 <linux/fs.h>
#include <linux/posix_acl.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)

struct nfsd_file;

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

/* nfsd/vfs.c */
struct nfsd_attrs {
	struct iattr		*na_iattr;	/* input */
	struct xdr_netobj	*na_seclabel;	/* input */
	struct posix_acl	*na_pacl;	/* input */
	struct posix_acl	*na_dpacl;	/* input */

	int			na_labelerr;	/* output */
	int			na_aclerr;	/* output */
};

static inline void nfsd_attrs_free(struct nfsd_attrs *attrs)
{
	posix_acl_release(attrs->na_pacl);
	posix_acl_release(attrs->na_dpacl);
}

__be32		nfserrno (int errno);
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 nfsd_attrs *, int, time64_t);
int nfsd_mountpoint(struct dentry *, struct svc_export *);
#ifdef CONFIG_NFSD_V4
__be32		nfsd4_vfs_fallocate(struct svc_rqst *, struct svc_fh *,
				    struct file *, loff_t, loff_t, int);
__be32		nfsd4_clone_file_range(struct svc_rqst *rqstp,
				       struct nfsd_file *nf_src, u64 src_pos,
				       struct nfsd_file *nf_dst, u64 dst_pos,
				       u64 count, bool sync);
#endif /* CONFIG_NFSD_V4 */
__be32		nfsd_create_locked(struct svc_rqst *, struct svc_fh *,
				struct nfsd_attrs *attrs, int type, dev_t rdev,
				struct svc_fh *res);
__be32		nfsd_create(struct svc_rqst *, struct svc_fh *,
				char *name, int len, struct nfsd_attrs *attrs,
				int type, dev_t rdev, struct svc_fh *res);
__be32		nfsd_access(struct svc_rqst *, struct svc_fh *, u32 *, u32 *);
__be32		nfsd_create_setattr(struct svc_rqst *rqstp, struct svc_fh *fhp,
				struct svc_fh *resfhp, struct nfsd_attrs *iap);
__be32		nfsd_commit(struct svc_rqst *rqst, struct svc_fh *fhp,
				struct nfsd_file *nf, u64 offset, u32 count,
				__be32 *verf);
#ifdef CONFIG_NFSD_V4
__be32		nfsd_getxattr(struct svc_rqst *rqstp, struct svc_fh *fhp,
			    char *name, void **bufp, int *lenp);
__be32		nfsd_listxattr(struct svc_rqst *rqstp, struct svc_fh *fhp,
			    char **bufp, int *lenp);
__be32		nfsd_removexattr(struct svc_rqst *rqstp, struct svc_fh *fhp,
			    char *name);
__be32		nfsd_setxattr(struct svc_rqst *rqstp, struct svc_fh *fhp,
			    char *name, void *buf, u32 len, u32 flags);
#endif
int 		nfsd_open_break_lease(struct inode *, int);
__be32		nfsd_open(struct svc_rqst *, struct svc_fh *, umode_t,
				int, struct file **);
int		nfsd_open_verified(struct svc_rqst *rqstp, struct svc_fh *fhp,
				   int may_flags, struct file **filp);
__be32		nfsd_splice_read(struct svc_rqst *rqstp, struct svc_fh *fhp,
				struct file *file, loff_t offset,
				unsigned long *count,
				u32 *eof);
__be32		nfsd_iter_read(struct svc_rqst *rqstp, struct svc_fh *fhp,
				struct file *file, loff_t offset,
				unsigned long *count, unsigned int base,
				u32 *eof);
bool		nfsd_read_splice_ok(struct svc_rqst *rqstp);
__be32		nfsd_read(struct svc_rqst *rqstp, struct svc_fh *fhp,
				loff_t offset, unsigned long *count,
				u32 *eof);
__be32 		nfsd_write(struct svc_rqst *, struct svc_fh *, loff_t,
				struct kvec *, int, unsigned long *,
				int stable, __be32 *verf);
__be32		nfsd_vfs_write(struct svc_rqst *rqstp, struct svc_fh *fhp,
				struct nfsd_file *nf, loff_t offset,
				struct kvec *vec, int vlen, unsigned long *cnt,
				int stable, __be32 *verf);
__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 nfsd_attrs *attrs,
			     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);

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(const struct svc_fh *fh, struct kstat *stat)
{
	u32 request_mask = STATX_BASIC_STATS;
	struct path p = {.mnt = fh->fh_export->ex_path.mnt,
			 .dentry = fh->fh_dentry};

	if (fh->fh_maxsize == NFS4_FHSIZE)
		request_mask |= (STATX_BTIME | STATX_CHANGE_COOKIE);

	return nfserrno(vfs_getattr(&p, stat, request_mask,
				    AT_STATX_SYNC_AS_STAT));
}

#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
c0cbe707 N	9	#include <linux/fs.h>
c0cbe707 N	10	#include <linux/posix_acl.h>
1557aca7	11	#include "nfsfh.h"
3dadecce	12	#include "nfsd.h"
1557aca7	13
0a3adade BF	14	/*
	15	* Flags for nfsd_permission
	16	*/
8e82fa8f BF	17	#define NFSD_MAY_NOP 0
	18	#define NFSD_MAY_EXEC 0x001 /* == MAY_EXEC */
	19	#define NFSD_MAY_WRITE 0x002 /* == MAY_WRITE */
	20	#define NFSD_MAY_READ 0x004 /* == MAY_READ */
	21	#define NFSD_MAY_SATTR 0x008
	22	#define NFSD_MAY_TRUNC 0x010
	23	#define NFSD_MAY_LOCK 0x020
	24	#define NFSD_MAY_MASK 0x03f
aea93397 BF	25
aea93397 BF	26	/* extra hints to permission and open routines: */
8e82fa8f BF	27	#define NFSD_MAY_OWNER_OVERRIDE 0x040
	28	#define NFSD_MAY_LOCAL_ACCESS 0x080 /* for device special files */
	29	#define NFSD_MAY_BYPASS_GSS_ON_ROOT 0x100
	30	#define NFSD_MAY_NOT_BREAK_LEASE 0x200
	31	#define NFSD_MAY_BYPASS_GSS 0x400
	32	#define NFSD_MAY_READ_IF_EXEC 0x800
0a3adade	33
06effdbb BS	34	#define NFSD_MAY_64BIT_COOKIE 0x1000 /* 64 bit readdir cookies for >= NFSv3 */
06effdbb BS	35
0a3adade BF	36	#define NFSD_MAY_CREATE (NFSD_MAY_EXEC\|NFSD_MAY_WRITE)
	37	#define NFSD_MAY_REMOVE (NFSD_MAY_EXEC\|NFSD_MAY_WRITE\|NFSD_MAY_TRUNC)
	38
16f8f894 TM	39	struct nfsd_file;
16f8f894 TM	40
0a3adade BF	41	/*
	42	* Callback function for readdir
	43	*/
ac7576f4	44	typedef int (nfsd_filldir_t)(void , const char *, int, loff_t, u64, unsigned);
0a3adade BF	45
0a3adade BF	46	/* nfsd/vfs.c */
7fe2a71d N	47	struct nfsd_attrs {
7fe2a71d N	48	struct iattr na_iattr; / input */
d6a97d3f	49	struct xdr_netobj na_seclabel; / input */
c0cbe707 N	50	struct posix_acl na_pacl; / input */
c0cbe707 N	51	struct posix_acl na_dpacl; / input */
d6a97d3f N	52
d6a97d3f N	53	int na_labelerr; /* output */
c0cbe707	54	int na_aclerr; /* output */
7fe2a71d N	55	};
7fe2a71d N	56
c0cbe707 N	57	static inline void nfsd_attrs_free(struct nfsd_attrs *attrs)
	58	{
	59	posix_acl_release(attrs->na_pacl);
	60	posix_acl_release(attrs->na_dpacl);
	61	}
	62
cb12fae1	63	__be32 nfserrno (int errno);
0a3adade BF	64	int nfsd_cross_mnt(struct svc_rqst rqstp, struct dentry *dpp,
	65	struct svc_export **expp);
	66	__be32 nfsd_lookup(struct svc_rqst , struct svc_fh ,
	67	const char , unsigned int, struct svc_fh );
	68	__be32 nfsd_lookup_dentry(struct svc_rqst , struct svc_fh ,
	69	const char *, unsigned int,
	70	struct svc_export , struct dentry );
	71	__be32 nfsd_setattr(struct svc_rqst , struct svc_fh ,
7fe2a71d	72	struct nfsd_attrs *, int, time64_t);
3227fa41	73	int nfsd_mountpoint(struct dentry , struct svc_export );
0a3adade	74	#ifdef CONFIG_NFSD_V4
95d871f0 AS	75	__be32 nfsd4_vfs_fallocate(struct svc_rqst , struct svc_fh ,
95d871f0 AS	76	struct file *, loff_t, loff_t, int);
a2f4c3fa TM	77	__be32 nfsd4_clone_file_range(struct svc_rqst *rqstp,
a2f4c3fa TM	78	struct nfsd_file *nf_src, u64 src_pos,
b66ae6dd TM	79	struct nfsd_file *nf_dst, u64 dst_pos,
b66ae6dd TM	80	u64 count, bool sync);
0a3adade	81	#endif /* CONFIG_NFSD_V4 */
b44061d0	82	__be32 nfsd_create_locked(struct svc_rqst , struct svc_fh ,
9558f930 N	83	struct nfsd_attrs *attrs, int type, dev_t rdev,
9558f930 N	84	struct svc_fh *res);
0a3adade	85	__be32 nfsd_create(struct svc_rqst , struct svc_fh ,
7fe2a71d	86	char name, int len, struct nfsd_attrs attrs,
0a3adade	87	int type, dev_t rdev, struct svc_fh *res);
0a3adade	88	__be32 nfsd_access(struct svc_rqst , struct svc_fh , u32 , u32 );
5f46e950	89	__be32 nfsd_create_setattr(struct svc_rqst rqstp, struct svc_fh fhp,
7fe2a71d	90	struct svc_fh resfhp, struct nfsd_attrs iap);
3f965021	91	__be32 nfsd_commit(struct svc_rqst rqst, struct svc_fh fhp,
c2528490 CL	92	struct nfsd_file *nf, u64 offset, u32 count,
c2528490 CL	93	__be32 *verf);
32119446 FL	94	#ifdef CONFIG_NFSD_V4
	95	__be32 nfsd_getxattr(struct svc_rqst rqstp, struct svc_fh fhp,
	96	char name, void bufp, int lenp);
	97	__be32 nfsd_listxattr(struct svc_rqst rqstp, struct svc_fh fhp,
	98	char *bufp, int lenp);
	99	__be32 nfsd_removexattr(struct svc_rqst rqstp, struct svc_fh fhp,
	100	char *name);
	101	__be32 nfsd_setxattr(struct svc_rqst rqstp, struct svc_fh fhp,
	102	char name, void buf, u32 len, u32 flags);
	103	#endif
65294c1f	104	int nfsd_open_break_lease(struct inode *, int);
175a4eb7	105	__be32 nfsd_open(struct svc_rqst , struct svc_fh , umode_t,
0a3adade	106	int, struct file **);
d59b3515 TM	107	int nfsd_open_verified(struct svc_rqst rqstp, struct svc_fh fhp,
d59b3515 TM	108	int may_flags, struct file **filp);
87c5942e CL	109	__be32 nfsd_splice_read(struct svc_rqst rqstp, struct svc_fh fhp,
87c5942e CL	110	struct file *file, loff_t offset,
83a63072 TM	111	unsigned long *count,
83a63072 TM	112	u32 *eof);
507df40e CL	113	__be32 nfsd_iter_read(struct svc_rqst rqstp, struct svc_fh fhp,
	114	struct file *file, loff_t offset,
	115	unsigned long *count, unsigned int base,
	116	u32 *eof);
c21fd7a8	117	bool nfsd_read_splice_ok(struct svc_rqst *rqstp);
507df40e CL	118	__be32 nfsd_read(struct svc_rqst rqstp, struct svc_fh fhp,
507df40e CL	119	loff_t offset, unsigned long *count,
83a63072	120	u32 *eof);
52e380e0	121	__be32 nfsd_write(struct svc_rqst , struct svc_fh , loff_t,
19e0663f TM	122	struct kvec , int, unsigned long ,
19e0663f TM	123	int stable, __be32 *verf);
af90f707	124	__be32 nfsd_vfs_write(struct svc_rqst rqstp, struct svc_fh fhp,
16f8f894	125	struct nfsd_file *nf, loff_t offset,
af90f707	126	struct kvec vec, int vlen, unsigned long cnt,
19e0663f	127	int stable, __be32 *verf);
0a3adade BF	128	__be32 nfsd_readlink(struct svc_rqst , struct svc_fh ,
	129	char , int );
	130	__be32 nfsd_symlink(struct svc_rqst , struct svc_fh ,
93adc1e3 N	131	char name, int len, char path,
	132	struct nfsd_attrs *attrs,
	133	struct svc_fh *res);
0a3adade BF	134	__be32 nfsd_link(struct svc_rqst , struct svc_fh ,
0a3adade BF	135	char , int, struct svc_fh );
29ae7f9d AS	136	ssize_t nfsd_copy_file_range(struct file *, u64,
29ae7f9d AS	137	struct file *, u64, u64);
0a3adade BF	138	__be32 nfsd_rename(struct svc_rqst *,
	139	struct svc_fh , char , int,
	140	struct svc_fh , char , int);
0a3adade BF	141	__be32 nfsd_unlink(struct svc_rqst , struct svc_fh , int type,
0a3adade BF	142	char *name, int len);
0a3adade	143	__be32 nfsd_readdir(struct svc_rqst , struct svc_fh ,
ac7576f4	144	loff_t , struct readdir_cd , nfsd_filldir_t);
0a3adade BF	145	__be32 nfsd_statfs(struct svc_rqst , struct svc_fh ,
	146	struct kstatfs *, int access);
	147
0a3adade BF	148	__be32 nfsd_permission(struct svc_rqst , struct svc_export ,
0a3adade BF	149	struct dentry *, int);
0a3adade	150
bad0dcff AV	151	static inline int fh_want_write(struct svc_fh *fh)
bad0dcff AV	152	{
0b8f6262	153	int ret;
4a55c101	154
0b8f6262 BF	155	if (fh->fh_want_write)
	156	return 0;
	157	ret = mnt_want_write(fh->fh_export->ex_path.mnt);
4a55c101	158	if (!ret)
aaf91ec1	159	fh->fh_want_write = true;
4a55c101	160	return ret;
bad0dcff AV	161	}
	162
	163	static inline void fh_drop_write(struct svc_fh *fh)
	164	{
4a55c101	165	if (fh->fh_want_write) {
aaf91ec1	166	fh->fh_want_write = false;
4a55c101 JK	167	mnt_drop_write(fh->fh_export->ex_path.mnt);
4a55c101 JK	168	}
bad0dcff AV	169	}
bad0dcff AV	170
907c3822	171	static inline __be32 fh_getattr(const struct svc_fh fh, struct kstat stat)
3dadecce	172	{
638e3e7d	173	u32 request_mask = STATX_BASIC_STATS;
3dadecce AV	174	struct path p = {.mnt = fh->fh_export->ex_path.mnt,
3dadecce AV	175	.dentry = fh->fh_dentry};
638e3e7d JL	176
	177	if (fh->fh_maxsize == NFS4_FHSIZE)
	178	request_mask \|= (STATX_BTIME \| STATX_CHANGE_COOKIE);
	179
	180	return nfserrno(vfs_getattr(&p, stat, request_mask,
a528d35e	181	AT_STATX_SYNC_AS_STAT));
3dadecce AV	182	}
3dadecce AV	183
0a3adade	184	#endif /* LINUX_NFSD_VFS_H */