xref: /linux/fs/nfsd/vfs.h (revision 345c4b7734e841d20a70a84deb13cb317c45d484)
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_NLM			0x020 /* request is from lockd */
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_LOCALIO		0x2000 /* for tracing, reflects when localio used */
37 
38 #define NFSD_MAY_CREATE		(NFSD_MAY_EXEC|NFSD_MAY_WRITE)
39 #define NFSD_MAY_REMOVE		(NFSD_MAY_EXEC|NFSD_MAY_WRITE|NFSD_MAY_TRUNC)
40 
41 struct nfsd_file;
42 
43 /*
44  * Callback function for readdir
45  */
46 typedef int (*nfsd_filldir_t)(void *, const char *, int, loff_t, u64, unsigned);
47 
48 /* nfsd/vfs.c */
49 struct nfsd_attrs {
50 	struct iattr		*na_iattr;	/* input */
51 	struct xdr_netobj	*na_seclabel;	/* input */
52 	struct posix_acl	*na_pacl;	/* input */
53 	struct posix_acl	*na_dpacl;	/* input */
54 
55 	int			na_labelerr;	/* output */
56 	int			na_dpaclerr;	/* output */
57 	int			na_paclerr;	/* output */
58 };
59 
60 static inline void nfsd_attrs_free(struct nfsd_attrs *attrs)
61 {
62 	posix_acl_release(attrs->na_pacl);
63 	posix_acl_release(attrs->na_dpacl);
64 }
65 
66 static inline bool nfsd_attrs_valid(struct nfsd_attrs *attrs)
67 {
68 	struct iattr *iap = attrs->na_iattr;
69 
70 	return (iap->ia_valid || (attrs->na_seclabel &&
71 		attrs->na_seclabel->len) ||
72 		attrs->na_pacl || attrs->na_dpacl);
73 }
74 
75 __be32		nfserrno (int errno);
76 int		nfsd_cross_mnt(struct svc_rqst *rqstp, struct dentry **dpp,
77 		                struct svc_export **expp);
78 __be32		nfsd_lookup(struct svc_rqst *, struct svc_fh *,
79 				const char *, unsigned int, struct svc_fh *);
80 __be32		 nfsd_lookup_dentry(struct svc_rqst *, struct svc_fh *,
81 				const char *, unsigned int,
82 				struct svc_export **, struct dentry **);
83 __be32		nfsd_setattr(struct svc_rqst *, struct svc_fh *,
84 			     struct nfsd_attrs *, const struct timespec64 *);
85 int nfsd_mountpoint(struct dentry *, struct svc_export *);
86 #ifdef CONFIG_NFSD_V4
87 __be32		nfsd4_vfs_fallocate(struct svc_rqst *, struct svc_fh *,
88 				    struct file *, loff_t, loff_t, int);
89 __be32		nfsd4_clone_file_range(struct svc_rqst *rqstp,
90 				       struct nfsd_file *nf_src, u64 src_pos,
91 				       struct nfsd_file *nf_dst, u64 dst_pos,
92 				       u64 count, bool sync);
93 #endif /* CONFIG_NFSD_V4 */
94 __be32		nfsd_create_locked(struct svc_rqst *, struct svc_fh *,
95 				struct nfsd_attrs *attrs, int type, dev_t rdev,
96 				struct svc_fh *res);
97 __be32		nfsd_create(struct svc_rqst *, struct svc_fh *,
98 				char *name, int len, struct nfsd_attrs *attrs,
99 				int type, dev_t rdev, struct svc_fh *res);
100 __be32		nfsd_access(struct svc_rqst *, struct svc_fh *, u32 *, u32 *);
101 __be32		nfsd_create_setattr(struct svc_rqst *rqstp, struct svc_fh *fhp,
102 				struct svc_fh *resfhp, struct nfsd_attrs *iap);
103 __be32		nfsd_commit(struct svc_rqst *rqst, struct svc_fh *fhp,
104 				struct nfsd_file *nf, u64 offset, u32 count,
105 				__be32 *verf);
106 #ifdef CONFIG_NFSD_V4
107 __be32		nfsd_getxattr(struct svc_rqst *rqstp, struct svc_fh *fhp,
108 			    char *name, void **bufp, int *lenp);
109 __be32		nfsd_listxattr(struct svc_rqst *rqstp, struct svc_fh *fhp,
110 			    char **bufp, int *lenp);
111 __be32		nfsd_removexattr(struct svc_rqst *rqstp, struct svc_fh *fhp,
112 			    char *name);
113 __be32		nfsd_setxattr(struct svc_rqst *rqstp, struct svc_fh *fhp,
114 			    char *name, void *buf, u32 len, u32 flags);
115 #endif
116 int 		nfsd_open_break_lease(struct inode *, int);
117 __be32		nfsd_open(struct svc_rqst *, struct svc_fh *, umode_t,
118 				int, struct file **);
119 int		nfsd_open_verified(struct svc_fh *fhp, umode_t type, int may_flags,
120 				struct file **filp);
121 __be32		nfsd_splice_read(struct svc_rqst *rqstp, struct svc_fh *fhp,
122 				struct file *file, loff_t offset,
123 				unsigned long *count,
124 				u32 *eof);
125 __be32		nfsd_iter_read(struct svc_rqst *rqstp, struct svc_fh *fhp,
126 				struct nfsd_file *nf, loff_t offset,
127 				unsigned long *count, unsigned int base,
128 				u32 *eof);
129 bool		nfsd_read_splice_ok(struct svc_rqst *rqstp);
130 __be32		nfsd_read(struct svc_rqst *rqstp, struct svc_fh *fhp,
131 				loff_t offset, unsigned long *count,
132 				u32 *eof);
133 __be32		nfsd_write(struct svc_rqst *rqstp, struct svc_fh *fhp,
134 				loff_t offset, const struct xdr_buf *payload,
135 				unsigned long *cnt, int stable, __be32 *verf);
136 __be32		nfsd_vfs_write(struct svc_rqst *rqstp, struct svc_fh *fhp,
137 				struct nfsd_file *nf, loff_t offset,
138 				const struct xdr_buf *payload,
139 				unsigned long *cnt, int stable, __be32 *verf);
140 __be32		nfsd_readlink(struct svc_rqst *, struct svc_fh *,
141 				char *, int *);
142 __be32		nfsd_symlink(struct svc_rqst *, struct svc_fh *,
143 			     char *name, int len, char *path,
144 			     struct nfsd_attrs *attrs,
145 			     struct svc_fh *res);
146 __be32		nfsd_link(struct svc_rqst *, struct svc_fh *,
147 				char *, int, struct svc_fh *);
148 ssize_t		nfsd_copy_file_range(struct file *, u64,
149 				     struct file *, u64, u64);
150 __be32		nfsd_rename(struct svc_rqst *,
151 				struct svc_fh *, char *, int,
152 				struct svc_fh *, char *, int);
153 __be32		nfsd_unlink(struct svc_rqst *, struct svc_fh *, int type,
154 				char *name, int len);
155 __be32		nfsd_readdir(struct svc_rqst *, struct svc_fh *,
156 			     loff_t *, struct readdir_cd *, nfsd_filldir_t);
157 __be32		nfsd_statfs(struct svc_rqst *, struct svc_fh *,
158 				struct kstatfs *, int access);
159 
160 __be32		nfsd_permission(struct svc_cred *cred, struct svc_export *exp,
161 				struct dentry *dentry, int acc);
162 
163 void		nfsd_filp_close(struct file *fp);
164 
165 #endif /* LINUX_NFSD_VFS_H */
166