xref: /linux/fs/nfsd/vfs.h (revision 447e140e66fd226350b3ce86cffc965eaae4c856)
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 
39 struct nfsd_file;
40 
41 /*
42  * Callback function for readdir
43  */
44 typedef int (*nfsd_filldir_t)(void *, const char *, int, loff_t, u64, unsigned);
45 
46 /* nfsd/vfs.c */
47 struct 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 
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 
63 static inline bool nfsd_attrs_valid(struct nfsd_attrs *attrs)
64 {
65 	struct iattr *iap = attrs->na_iattr;
66 
67 	return (iap->ia_valid || (attrs->na_seclabel &&
68 		attrs->na_seclabel->len));
69 }
70 
71 __be32		nfserrno (int errno);
72 int		nfsd_cross_mnt(struct svc_rqst *rqstp, struct dentry **dpp,
73 		                struct svc_export **expp);
74 __be32		nfsd_lookup(struct svc_rqst *, struct svc_fh *,
75 				const char *, unsigned int, struct svc_fh *);
76 __be32		 nfsd_lookup_dentry(struct svc_rqst *, struct svc_fh *,
77 				const char *, unsigned int,
78 				struct svc_export **, struct dentry **);
79 __be32		nfsd_setattr(struct svc_rqst *, struct svc_fh *,
80 			     struct nfsd_attrs *, const struct timespec64 *);
81 int nfsd_mountpoint(struct dentry *, struct svc_export *);
82 #ifdef CONFIG_NFSD_V4
83 __be32		nfsd4_vfs_fallocate(struct svc_rqst *, struct svc_fh *,
84 				    struct file *, loff_t, loff_t, int);
85 __be32		nfsd4_clone_file_range(struct svc_rqst *rqstp,
86 				       struct nfsd_file *nf_src, u64 src_pos,
87 				       struct nfsd_file *nf_dst, u64 dst_pos,
88 				       u64 count, bool sync);
89 #endif /* CONFIG_NFSD_V4 */
90 __be32		nfsd_create_locked(struct svc_rqst *, struct svc_fh *,
91 				struct nfsd_attrs *attrs, int type, dev_t rdev,
92 				struct svc_fh *res);
93 __be32		nfsd_create(struct svc_rqst *, struct svc_fh *,
94 				char *name, int len, struct nfsd_attrs *attrs,
95 				int type, dev_t rdev, struct svc_fh *res);
96 __be32		nfsd_access(struct svc_rqst *, struct svc_fh *, u32 *, u32 *);
97 __be32		nfsd_create_setattr(struct svc_rqst *rqstp, struct svc_fh *fhp,
98 				struct svc_fh *resfhp, struct nfsd_attrs *iap);
99 __be32		nfsd_commit(struct svc_rqst *rqst, struct svc_fh *fhp,
100 				struct nfsd_file *nf, u64 offset, u32 count,
101 				__be32 *verf);
102 #ifdef CONFIG_NFSD_V4
103 __be32		nfsd_getxattr(struct svc_rqst *rqstp, struct svc_fh *fhp,
104 			    char *name, void **bufp, int *lenp);
105 __be32		nfsd_listxattr(struct svc_rqst *rqstp, struct svc_fh *fhp,
106 			    char **bufp, int *lenp);
107 __be32		nfsd_removexattr(struct svc_rqst *rqstp, struct svc_fh *fhp,
108 			    char *name);
109 __be32		nfsd_setxattr(struct svc_rqst *rqstp, struct svc_fh *fhp,
110 			    char *name, void *buf, u32 len, u32 flags);
111 #endif
112 int 		nfsd_open_break_lease(struct inode *, int);
113 __be32		nfsd_open(struct svc_rqst *, struct svc_fh *, umode_t,
114 				int, struct file **);
115 int		nfsd_open_verified(struct svc_rqst *rqstp, struct svc_fh *fhp,
116 				   int may_flags, struct file **filp);
117 __be32		nfsd_splice_read(struct svc_rqst *rqstp, struct svc_fh *fhp,
118 				struct file *file, loff_t offset,
119 				unsigned long *count,
120 				u32 *eof);
121 __be32		nfsd_iter_read(struct svc_rqst *rqstp, struct svc_fh *fhp,
122 				struct file *file, loff_t offset,
123 				unsigned long *count, unsigned int base,
124 				u32 *eof);
125 bool		nfsd_read_splice_ok(struct svc_rqst *rqstp);
126 __be32		nfsd_read(struct svc_rqst *rqstp, struct svc_fh *fhp,
127 				loff_t offset, unsigned long *count,
128 				u32 *eof);
129 __be32 		nfsd_write(struct svc_rqst *, struct svc_fh *, loff_t,
130 				struct kvec *, int, unsigned long *,
131 				int stable, __be32 *verf);
132 __be32		nfsd_vfs_write(struct svc_rqst *rqstp, struct svc_fh *fhp,
133 				struct nfsd_file *nf, loff_t offset,
134 				struct kvec *vec, int vlen, unsigned long *cnt,
135 				int stable, __be32 *verf);
136 __be32		nfsd_readlink(struct svc_rqst *, struct svc_fh *,
137 				char *, int *);
138 __be32		nfsd_symlink(struct svc_rqst *, struct svc_fh *,
139 			     char *name, int len, char *path,
140 			     struct nfsd_attrs *attrs,
141 			     struct svc_fh *res);
142 __be32		nfsd_link(struct svc_rqst *, struct svc_fh *,
143 				char *, int, struct svc_fh *);
144 ssize_t		nfsd_copy_file_range(struct file *, u64,
145 				     struct file *, u64, u64);
146 __be32		nfsd_rename(struct svc_rqst *,
147 				struct svc_fh *, char *, int,
148 				struct svc_fh *, char *, int);
149 __be32		nfsd_unlink(struct svc_rqst *, struct svc_fh *, int type,
150 				char *name, int len);
151 __be32		nfsd_readdir(struct svc_rqst *, struct svc_fh *,
152 			     loff_t *, struct readdir_cd *, nfsd_filldir_t);
153 __be32		nfsd_statfs(struct svc_rqst *, struct svc_fh *,
154 				struct kstatfs *, int access);
155 
156 __be32		nfsd_permission(struct svc_rqst *, struct svc_export *,
157 				struct dentry *, int);
158 
159 void		nfsd_filp_close(struct file *fp);
160 
161 static inline int fh_want_write(struct svc_fh *fh)
162 {
163 	int ret;
164 
165 	if (fh->fh_want_write)
166 		return 0;
167 	ret = mnt_want_write(fh->fh_export->ex_path.mnt);
168 	if (!ret)
169 		fh->fh_want_write = true;
170 	return ret;
171 }
172 
173 static inline void fh_drop_write(struct svc_fh *fh)
174 {
175 	if (fh->fh_want_write) {
176 		fh->fh_want_write = false;
177 		mnt_drop_write(fh->fh_export->ex_path.mnt);
178 	}
179 }
180 
181 static inline __be32 fh_getattr(const struct svc_fh *fh, struct kstat *stat)
182 {
183 	u32 request_mask = STATX_BASIC_STATS;
184 	struct path p = {.mnt = fh->fh_export->ex_path.mnt,
185 			 .dentry = fh->fh_dentry};
186 
187 	if (fh->fh_maxsize == NFS4_FHSIZE)
188 		request_mask |= (STATX_BTIME | STATX_CHANGE_COOKIE);
189 
190 	return nfserrno(vfs_getattr(&p, stat, request_mask,
191 				    AT_STATX_SYNC_AS_STAT));
192 }
193 
194 #endif /* LINUX_NFSD_VFS_H */
195