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