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