Loading...
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 *, const struct timespec64 *);
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);
117bool nfsd_read_splice_ok(struct svc_rqst *rqstp);
118__be32 nfsd_read(struct svc_rqst *rqstp, struct svc_fh *fhp,
119 loff_t offset, unsigned long *count,
120 u32 *eof);
121__be32 nfsd_write(struct svc_rqst *, struct svc_fh *, loff_t,
122 struct kvec *, int, unsigned long *,
123 int stable, __be32 *verf);
124__be32 nfsd_vfs_write(struct svc_rqst *rqstp, struct svc_fh *fhp,
125 struct nfsd_file *nf, loff_t offset,
126 struct kvec *vec, int vlen, unsigned long *cnt,
127 int stable, __be32 *verf);
128__be32 nfsd_readlink(struct svc_rqst *, struct svc_fh *,
129 char *, int *);
130__be32 nfsd_symlink(struct svc_rqst *, struct svc_fh *,
131 char *name, int len, char *path,
132 struct nfsd_attrs *attrs,
133 struct svc_fh *res);
134__be32 nfsd_link(struct svc_rqst *, struct svc_fh *,
135 char *, int, struct svc_fh *);
136ssize_t nfsd_copy_file_range(struct file *, u64,
137 struct file *, u64, u64);
138__be32 nfsd_rename(struct svc_rqst *,
139 struct svc_fh *, char *, int,
140 struct svc_fh *, char *, int);
141__be32 nfsd_unlink(struct svc_rqst *, struct svc_fh *, int type,
142 char *name, int len);
143__be32 nfsd_readdir(struct svc_rqst *, struct svc_fh *,
144 loff_t *, struct readdir_cd *, nfsd_filldir_t);
145__be32 nfsd_statfs(struct svc_rqst *, struct svc_fh *,
146 struct kstatfs *, int access);
147
148__be32 nfsd_permission(struct svc_rqst *, struct svc_export *,
149 struct dentry *, int);
150
151void nfsd_filp_close(struct file *fp);
152
153static inline int fh_want_write(struct svc_fh *fh)
154{
155 int ret;
156
157 if (fh->fh_want_write)
158 return 0;
159 ret = mnt_want_write(fh->fh_export->ex_path.mnt);
160 if (!ret)
161 fh->fh_want_write = true;
162 return ret;
163}
164
165static inline void fh_drop_write(struct svc_fh *fh)
166{
167 if (fh->fh_want_write) {
168 fh->fh_want_write = false;
169 mnt_drop_write(fh->fh_export->ex_path.mnt);
170 }
171}
172
173static inline __be32 fh_getattr(const struct svc_fh *fh, struct kstat *stat)
174{
175 u32 request_mask = STATX_BASIC_STATS;
176 struct path p = {.mnt = fh->fh_export->ex_path.mnt,
177 .dentry = fh->fh_dentry};
178
179 if (fh->fh_maxsize == NFS4_FHSIZE)
180 request_mask |= (STATX_BTIME | STATX_CHANGE_COOKIE);
181
182 return nfserrno(vfs_getattr(&p, stat, request_mask,
183 AT_STATX_SYNC_AS_STAT));
184}
185
186#endif /* LINUX_NFSD_VFS_H */
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/*
38 * Callback function for readdir
39 */
40typedef int (*nfsd_filldir_t)(void *, const char *, int, loff_t, u64, unsigned);
41
42/* nfsd/vfs.c */
43int nfsd_racache_init(int);
44void nfsd_racache_shutdown(void);
45int 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, time_t);
54int 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 file *, u64, struct file *,
61 u64, u64);
62#endif /* CONFIG_NFSD_V4 */
63__be32 nfsd_create_locked(struct svc_rqst *, struct svc_fh *,
64 char *name, int len, struct iattr *attrs,
65 int type, dev_t rdev, struct svc_fh *res);
66__be32 nfsd_create(struct svc_rqst *, struct svc_fh *,
67 char *name, int len, struct iattr *attrs,
68 int type, dev_t rdev, struct svc_fh *res);
69#ifdef CONFIG_NFSD_V3
70__be32 nfsd_access(struct svc_rqst *, struct svc_fh *, u32 *, u32 *);
71__be32 do_nfsd_create(struct svc_rqst *, struct svc_fh *,
72 char *name, int len, struct iattr *attrs,
73 struct svc_fh *res, int createmode,
74 u32 *verifier, bool *truncp, bool *created);
75__be32 nfsd_commit(struct svc_rqst *, struct svc_fh *,
76 loff_t, unsigned long);
77#endif /* CONFIG_NFSD_V3 */
78__be32 nfsd_open(struct svc_rqst *, struct svc_fh *, umode_t,
79 int, struct file **);
80struct raparms;
81__be32 nfsd_splice_read(struct svc_rqst *rqstp, struct svc_fh *fhp,
82 struct file *file, loff_t offset,
83 unsigned long *count);
84__be32 nfsd_readv(struct svc_rqst *rqstp, struct svc_fh *fhp,
85 struct file *file, loff_t offset,
86 struct kvec *vec, int vlen,
87 unsigned long *count);
88__be32 nfsd_read(struct svc_rqst *, struct svc_fh *,
89 loff_t, struct kvec *, int, unsigned long *);
90__be32 nfsd_write(struct svc_rqst *, struct svc_fh *, loff_t,
91 struct kvec *, int, unsigned long *, int);
92__be32 nfsd_vfs_write(struct svc_rqst *rqstp, struct svc_fh *fhp,
93 struct file *file, loff_t offset,
94 struct kvec *vec, int vlen, unsigned long *cnt,
95 int stable);
96__be32 nfsd_readlink(struct svc_rqst *, struct svc_fh *,
97 char *, int *);
98__be32 nfsd_symlink(struct svc_rqst *, struct svc_fh *,
99 char *name, int len, char *path,
100 struct svc_fh *res);
101__be32 nfsd_link(struct svc_rqst *, struct svc_fh *,
102 char *, int, struct svc_fh *);
103ssize_t nfsd_copy_file_range(struct file *, u64,
104 struct file *, u64, u64);
105__be32 nfsd_rename(struct svc_rqst *,
106 struct svc_fh *, char *, int,
107 struct svc_fh *, char *, int);
108__be32 nfsd_unlink(struct svc_rqst *, struct svc_fh *, int type,
109 char *name, int len);
110__be32 nfsd_readdir(struct svc_rqst *, struct svc_fh *,
111 loff_t *, struct readdir_cd *, nfsd_filldir_t);
112__be32 nfsd_statfs(struct svc_rqst *, struct svc_fh *,
113 struct kstatfs *, int access);
114
115__be32 nfsd_permission(struct svc_rqst *, struct svc_export *,
116 struct dentry *, int);
117
118struct raparms *nfsd_init_raparms(struct file *file);
119void nfsd_put_raparams(struct file *file, struct raparms *ra);
120
121static inline int fh_want_write(struct svc_fh *fh)
122{
123 int ret = mnt_want_write(fh->fh_export->ex_path.mnt);
124
125 if (!ret)
126 fh->fh_want_write = true;
127 return ret;
128}
129
130static inline void fh_drop_write(struct svc_fh *fh)
131{
132 if (fh->fh_want_write) {
133 fh->fh_want_write = false;
134 mnt_drop_write(fh->fh_export->ex_path.mnt);
135 }
136}
137
138static inline __be32 fh_getattr(struct svc_fh *fh, struct kstat *stat)
139{
140 struct path p = {.mnt = fh->fh_export->ex_path.mnt,
141 .dentry = fh->fh_dentry};
142 return nfserrno(vfs_getattr(&p, stat, STATX_BASIC_STATS,
143 AT_STATX_SYNC_AS_STAT));
144}
145
146static inline int nfsd_create_is_exclusive(int createmode)
147{
148 return createmode == NFS3_CREATE_EXCLUSIVE
149 || createmode == NFS4_CREATE_EXCLUSIVE4_1;
150}
151
152static inline bool nfsd_eof_on_read(long requested, long read,
153 loff_t offset, loff_t size)
154{
155 /* We assume a short read means eof: */
156 if (requested > read)
157 return true;
158 /*
159 * A non-short read might also reach end of file. The spec
160 * still requires us to set eof in that case.
161 *
162 * Further operations may have modified the file size since
163 * the read, so the following check is not atomic with the read.
164 * We've only seen that cause a problem for a client in the case
165 * where the read returned a count of 0 without setting eof.
166 * That case was fixed by the addition of the above check.
167 */
168 return (offset + read >= size);
169}
170
171#endif /* LINUX_NFSD_VFS_H */