xref: /kernel/linux/linux-6.6/fs/nfsd/vfs.h (revision 62306a36)
1/* SPDX-License-Identifier: GPL-2.0 */
2/*
3 * Copyright (C) 1995-1997 Olaf Kirch <okir@monad.swb.de>
4 */
5
6#ifndef LINUX_NFSD_VFS_H
7#define LINUX_NFSD_VFS_H
8
9#include <linux/fs.h>
10#include <linux/posix_acl.h>
11#include "nfsfh.h"
12#include "nfsd.h"
13
14/*
15 * Flags for nfsd_permission
16 */
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
25
26/* extra hints to permission and open routines: */
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
33
34#define NFSD_MAY_64BIT_COOKIE		0x1000 /* 64 bit readdir cookies for >= NFSv3 */
35
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
39struct nfsd_file;
40
41/*
42 * Callback function for readdir
43 */
44typedef int (*nfsd_filldir_t)(void *, const char *, int, loff_t, u64, unsigned);
45
46/* nfsd/vfs.c */
47struct nfsd_attrs {
48	struct iattr		*na_iattr;	/* input */
49	struct xdr_netobj	*na_seclabel;	/* input */
50	struct posix_acl	*na_pacl;	/* input */
51	struct posix_acl	*na_dpacl;	/* input */
52
53	int			na_labelerr;	/* output */
54	int			na_aclerr;	/* output */
55};
56
57static 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
63__be32		nfserrno (int errno);
64int		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 *,
72				struct nfsd_attrs *, int, time64_t);
73int nfsd_mountpoint(struct dentry *, struct svc_export *);
74#ifdef CONFIG_NFSD_V4
75__be32		nfsd4_vfs_fallocate(struct svc_rqst *, struct svc_fh *,
76				    struct file *, loff_t, loff_t, int);
77__be32		nfsd4_clone_file_range(struct svc_rqst *rqstp,
78				       struct nfsd_file *nf_src, u64 src_pos,
79				       struct nfsd_file *nf_dst, u64 dst_pos,
80				       u64 count, bool sync);
81#endif /* CONFIG_NFSD_V4 */
82__be32		nfsd_create_locked(struct svc_rqst *, struct svc_fh *,
83				struct nfsd_attrs *attrs, int type, dev_t rdev,
84				struct svc_fh *res);
85__be32		nfsd_create(struct svc_rqst *, struct svc_fh *,
86				char *name, int len, struct nfsd_attrs *attrs,
87				int type, dev_t rdev, struct svc_fh *res);
88__be32		nfsd_access(struct svc_rqst *, struct svc_fh *, u32 *, u32 *);
89__be32		nfsd_create_setattr(struct svc_rqst *rqstp, struct svc_fh *fhp,
90				struct svc_fh *resfhp, struct nfsd_attrs *iap);
91__be32		nfsd_commit(struct svc_rqst *rqst, struct svc_fh *fhp,
92				struct nfsd_file *nf, u64 offset, u32 count,
93				__be32 *verf);
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
104int 		nfsd_open_break_lease(struct inode *, int);
105__be32		nfsd_open(struct svc_rqst *, struct svc_fh *, umode_t,
106				int, struct file **);
107int		nfsd_open_verified(struct svc_rqst *rqstp, struct svc_fh *fhp,
108				   int may_flags, struct file **filp);
109__be32		nfsd_splice_read(struct svc_rqst *rqstp, struct svc_fh *fhp,
110				struct file *file, loff_t offset,
111				unsigned long *count,
112				u32 *eof);
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);
117__be32		nfsd_read(struct svc_rqst *rqstp, struct svc_fh *fhp,
118				loff_t offset, unsigned long *count,
119				u32 *eof);
120__be32 		nfsd_write(struct svc_rqst *, struct svc_fh *, loff_t,
121				struct kvec *, int, unsigned long *,
122				int stable, __be32 *verf);
123__be32		nfsd_vfs_write(struct svc_rqst *rqstp, struct svc_fh *fhp,
124				struct nfsd_file *nf, loff_t offset,
125				struct kvec *vec, int vlen, unsigned long *cnt,
126				int stable, __be32 *verf);
127__be32		nfsd_readlink(struct svc_rqst *, struct svc_fh *,
128				char *, int *);
129__be32		nfsd_symlink(struct svc_rqst *, struct svc_fh *,
130			     char *name, int len, char *path,
131			     struct nfsd_attrs *attrs,
132			     struct svc_fh *res);
133__be32		nfsd_link(struct svc_rqst *, struct svc_fh *,
134				char *, int, struct svc_fh *);
135ssize_t		nfsd_copy_file_range(struct file *, u64,
136				     struct file *, u64, u64);
137__be32		nfsd_rename(struct svc_rqst *,
138				struct svc_fh *, char *, int,
139				struct svc_fh *, char *, int);
140__be32		nfsd_unlink(struct svc_rqst *, struct svc_fh *, int type,
141				char *name, int len);
142__be32		nfsd_readdir(struct svc_rqst *, struct svc_fh *,
143			     loff_t *, struct readdir_cd *, nfsd_filldir_t);
144__be32		nfsd_statfs(struct svc_rqst *, struct svc_fh *,
145				struct kstatfs *, int access);
146
147__be32		nfsd_permission(struct svc_rqst *, struct svc_export *,
148				struct dentry *, int);
149
150static inline int fh_want_write(struct svc_fh *fh)
151{
152	int ret;
153
154	if (fh->fh_want_write)
155		return 0;
156	ret = mnt_want_write(fh->fh_export->ex_path.mnt);
157	if (!ret)
158		fh->fh_want_write = true;
159	return ret;
160}
161
162static inline void fh_drop_write(struct svc_fh *fh)
163{
164	if (fh->fh_want_write) {
165		fh->fh_want_write = false;
166		mnt_drop_write(fh->fh_export->ex_path.mnt);
167	}
168}
169
170static inline __be32 fh_getattr(const struct svc_fh *fh, struct kstat *stat)
171{
172	u32 request_mask = STATX_BASIC_STATS;
173	struct path p = {.mnt = fh->fh_export->ex_path.mnt,
174			 .dentry = fh->fh_dentry};
175
176	if (fh->fh_maxsize == NFS4_FHSIZE)
177		request_mask |= (STATX_BTIME | STATX_CHANGE_COOKIE);
178
179	return nfserrno(vfs_getattr(&p, stat, request_mask,
180				    AT_STATX_SYNC_AS_STAT));
181}
182
183#endif /* LINUX_NFSD_VFS_H */
184