xref: /linux/fs/nfsd/vfs.h (revision 666ed8bfd1de3b091cf32ca03b651757dd86cfff)
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 "nfsfh.h"
10 #include "nfsd.h"
11 
12 /*
13  * Flags for nfsd_permission
14  */
15 #define NFSD_MAY_NOP			0
16 #define NFSD_MAY_EXEC			0x001 /* == MAY_EXEC */
17 #define NFSD_MAY_WRITE			0x002 /* == MAY_WRITE */
18 #define NFSD_MAY_READ			0x004 /* == MAY_READ */
19 #define NFSD_MAY_SATTR			0x008
20 #define NFSD_MAY_TRUNC			0x010
21 #define NFSD_MAY_LOCK			0x020
22 #define NFSD_MAY_MASK			0x03f
23 
24 /* extra hints to permission and open routines: */
25 #define NFSD_MAY_OWNER_OVERRIDE		0x040
26 #define NFSD_MAY_LOCAL_ACCESS		0x080 /* for device special files */
27 #define NFSD_MAY_BYPASS_GSS_ON_ROOT	0x100
28 #define NFSD_MAY_NOT_BREAK_LEASE	0x200
29 #define NFSD_MAY_BYPASS_GSS		0x400
30 #define NFSD_MAY_READ_IF_EXEC		0x800
31 
32 #define NFSD_MAY_64BIT_COOKIE		0x1000 /* 64 bit readdir cookies for >= NFSv3 */
33 
34 #define NFSD_MAY_CREATE		(NFSD_MAY_EXEC|NFSD_MAY_WRITE)
35 #define NFSD_MAY_REMOVE		(NFSD_MAY_EXEC|NFSD_MAY_WRITE|NFSD_MAY_TRUNC)
36 
37 struct nfsd_file;
38 
39 /*
40  * Callback function for readdir
41  */
42 typedef int (*nfsd_filldir_t)(void *, const char *, int, loff_t, u64, unsigned);
43 
44 /* nfsd/vfs.c */
45 int		nfsd_cross_mnt(struct svc_rqst *rqstp, struct dentry **dpp,
46 		                struct svc_export **expp);
47 __be32		nfsd_lookup(struct svc_rqst *, struct svc_fh *,
48 				const char *, unsigned int, struct svc_fh *);
49 __be32		 nfsd_lookup_dentry(struct svc_rqst *, struct svc_fh *,
50 				const char *, unsigned int,
51 				struct svc_export **, struct dentry **);
52 __be32		nfsd_setattr(struct svc_rqst *, struct svc_fh *,
53 				struct iattr *, int, time64_t);
54 int nfsd_mountpoint(struct dentry *, struct svc_export *);
55 #ifdef CONFIG_NFSD_V4
56 __be32          nfsd4_set_nfs4_label(struct svc_rqst *, struct svc_fh *,
57 		    struct xdr_netobj *);
58 __be32		nfsd4_vfs_fallocate(struct svc_rqst *, struct svc_fh *,
59 				    struct file *, loff_t, loff_t, int);
60 __be32		nfsd4_clone_file_range(struct nfsd_file *nf_src, u64 src_pos,
61 				       struct nfsd_file *nf_dst, u64 dst_pos,
62 				       u64 count, bool sync);
63 #endif /* CONFIG_NFSD_V4 */
64 __be32		nfsd_create_locked(struct svc_rqst *, struct svc_fh *,
65 				char *name, int len, struct iattr *attrs,
66 				int type, dev_t rdev, struct svc_fh *res);
67 __be32		nfsd_create(struct svc_rqst *, struct svc_fh *,
68 				char *name, int len, struct iattr *attrs,
69 				int type, dev_t rdev, struct svc_fh *res);
70 #ifdef CONFIG_NFSD_V3
71 __be32		nfsd_access(struct svc_rqst *, struct svc_fh *, u32 *, u32 *);
72 __be32		do_nfsd_create(struct svc_rqst *, struct svc_fh *,
73 				char *name, int len, struct iattr *attrs,
74 				struct svc_fh *res, int createmode,
75 				u32 *verifier, bool *truncp, bool *created);
76 __be32		nfsd_commit(struct svc_rqst *, struct svc_fh *,
77 				loff_t, unsigned long, __be32 *verf);
78 #endif /* CONFIG_NFSD_V3 */
79 int 		nfsd_open_break_lease(struct inode *, int);
80 __be32		nfsd_open(struct svc_rqst *, struct svc_fh *, umode_t,
81 				int, struct file **);
82 __be32		nfsd_open_verified(struct svc_rqst *, struct svc_fh *, umode_t,
83 				int, struct file **);
84 __be32		nfsd_splice_read(struct svc_rqst *rqstp, struct svc_fh *fhp,
85 				struct file *file, loff_t offset,
86 				unsigned long *count,
87 				u32 *eof);
88 __be32		nfsd_readv(struct svc_rqst *rqstp, struct svc_fh *fhp,
89 				struct file *file, loff_t offset,
90 				struct kvec *vec, int vlen,
91 				unsigned long *count,
92 				u32 *eof);
93 __be32 		nfsd_read(struct svc_rqst *, struct svc_fh *,
94 				loff_t, struct kvec *, int, unsigned long *,
95 				u32 *eof);
96 __be32 		nfsd_write(struct svc_rqst *, struct svc_fh *, loff_t,
97 				struct kvec *, int, unsigned long *,
98 				int stable, __be32 *verf);
99 __be32		nfsd_vfs_write(struct svc_rqst *rqstp, struct svc_fh *fhp,
100 				struct nfsd_file *nf, loff_t offset,
101 				struct kvec *vec, int vlen, unsigned long *cnt,
102 				int stable, __be32 *verf);
103 __be32		nfsd_readlink(struct svc_rqst *, struct svc_fh *,
104 				char *, int *);
105 __be32		nfsd_symlink(struct svc_rqst *, struct svc_fh *,
106 				char *name, int len, char *path,
107 				struct svc_fh *res);
108 __be32		nfsd_link(struct svc_rqst *, struct svc_fh *,
109 				char *, int, struct svc_fh *);
110 ssize_t		nfsd_copy_file_range(struct file *, u64,
111 				     struct file *, u64, u64);
112 __be32		nfsd_rename(struct svc_rqst *,
113 				struct svc_fh *, char *, int,
114 				struct svc_fh *, char *, int);
115 __be32		nfsd_unlink(struct svc_rqst *, struct svc_fh *, int type,
116 				char *name, int len);
117 __be32		nfsd_readdir(struct svc_rqst *, struct svc_fh *,
118 			     loff_t *, struct readdir_cd *, nfsd_filldir_t);
119 __be32		nfsd_statfs(struct svc_rqst *, struct svc_fh *,
120 				struct kstatfs *, int access);
121 
122 __be32		nfsd_permission(struct svc_rqst *, struct svc_export *,
123 				struct dentry *, int);
124 
125 static inline int fh_want_write(struct svc_fh *fh)
126 {
127 	int ret;
128 
129 	if (fh->fh_want_write)
130 		return 0;
131 	ret = mnt_want_write(fh->fh_export->ex_path.mnt);
132 	if (!ret)
133 		fh->fh_want_write = true;
134 	return ret;
135 }
136 
137 static inline void fh_drop_write(struct svc_fh *fh)
138 {
139 	if (fh->fh_want_write) {
140 		fh->fh_want_write = false;
141 		mnt_drop_write(fh->fh_export->ex_path.mnt);
142 	}
143 }
144 
145 static inline __be32 fh_getattr(struct svc_fh *fh, struct kstat *stat)
146 {
147 	struct path p = {.mnt = fh->fh_export->ex_path.mnt,
148 			 .dentry = fh->fh_dentry};
149 	return nfserrno(vfs_getattr(&p, stat, STATX_BASIC_STATS,
150 				    AT_STATX_SYNC_AS_STAT));
151 }
152 
153 static inline int nfsd_create_is_exclusive(int createmode)
154 {
155 	return createmode == NFS3_CREATE_EXCLUSIVE
156 	       || createmode == NFS4_CREATE_EXCLUSIVE4_1;
157 }
158 
159 #endif /* LINUX_NFSD_VFS_H */
160