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 "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_cross_mnt(struct svc_rqst *rqstp, struct dentry **dpp,
44 struct svc_export **expp);
45__be32 nfsd_lookup(struct svc_rqst *, struct svc_fh *,
46 const char *, unsigned int, struct svc_fh *);
47__be32 nfsd_lookup_dentry(struct svc_rqst *, struct svc_fh *,
48 const char *, unsigned int,
49 struct svc_export **, struct dentry **);
50__be32 nfsd_setattr(struct svc_rqst *, struct svc_fh *,
51 struct iattr *, int, time_t);
52int nfsd_mountpoint(struct dentry *, struct svc_export *);
53#ifdef CONFIG_NFSD_V4
54__be32 nfsd4_set_nfs4_label(struct svc_rqst *, struct svc_fh *,
55 struct xdr_netobj *);
56__be32 nfsd4_vfs_fallocate(struct svc_rqst *, struct svc_fh *,
57 struct file *, loff_t, loff_t, int);
58__be32 nfsd4_clone_file_range(struct file *, u64, struct file *,
59 u64, u64);
60#endif /* CONFIG_NFSD_V4 */
61__be32 nfsd_create_locked(struct svc_rqst *, struct svc_fh *,
62 char *name, int len, struct iattr *attrs,
63 int type, dev_t rdev, struct svc_fh *res);
64__be32 nfsd_create(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#ifdef CONFIG_NFSD_V3
68__be32 nfsd_access(struct svc_rqst *, struct svc_fh *, u32 *, u32 *);
69__be32 do_nfsd_create(struct svc_rqst *, struct svc_fh *,
70 char *name, int len, struct iattr *attrs,
71 struct svc_fh *res, int createmode,
72 u32 *verifier, bool *truncp, bool *created);
73__be32 nfsd_commit(struct svc_rqst *, struct svc_fh *,
74 loff_t, unsigned long);
75#endif /* CONFIG_NFSD_V3 */
76int nfsd_open_break_lease(struct inode *, int);
77__be32 nfsd_open(struct svc_rqst *, struct svc_fh *, umode_t,
78 int, struct file **);
79__be32 nfsd_open_verified(struct svc_rqst *, struct svc_fh *, umode_t,
80 int, struct file **);
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 u32 *eof);
85__be32 nfsd_readv(struct svc_rqst *rqstp, struct svc_fh *fhp,
86 struct file *file, loff_t offset,
87 struct kvec *vec, int vlen,
88 unsigned long *count,
89 u32 *eof);
90__be32 nfsd_read(struct svc_rqst *, struct svc_fh *,
91 loff_t, struct kvec *, int, unsigned long *,
92 u32 *eof);
93__be32 nfsd_write(struct svc_rqst *, struct svc_fh *, loff_t,
94 struct kvec *, int, unsigned long *, int);
95__be32 nfsd_vfs_write(struct svc_rqst *rqstp, struct svc_fh *fhp,
96 struct file *file, loff_t offset,
97 struct kvec *vec, int vlen, unsigned long *cnt,
98 int stable);
99__be32 nfsd_readlink(struct svc_rqst *, struct svc_fh *,
100 char *, int *);
101__be32 nfsd_symlink(struct svc_rqst *, struct svc_fh *,
102 char *name, int len, char *path,
103 struct svc_fh *res);
104__be32 nfsd_link(struct svc_rqst *, struct svc_fh *,
105 char *, int, struct svc_fh *);
106ssize_t nfsd_copy_file_range(struct file *, u64,
107 struct file *, u64, u64);
108__be32 nfsd_rename(struct svc_rqst *,
109 struct svc_fh *, char *, int,
110 struct svc_fh *, char *, int);
111__be32 nfsd_unlink(struct svc_rqst *, struct svc_fh *, int type,
112 char *name, int len);
113__be32 nfsd_readdir(struct svc_rqst *, struct svc_fh *,
114 loff_t *, struct readdir_cd *, nfsd_filldir_t);
115__be32 nfsd_statfs(struct svc_rqst *, struct svc_fh *,
116 struct kstatfs *, int access);
117
118__be32 nfsd_permission(struct svc_rqst *, struct svc_export *,
119 struct dentry *, int);
120
121static inline int fh_want_write(struct svc_fh *fh)
122{
123 int ret;
124
125 if (fh->fh_want_write)
126 return 0;
127 ret = mnt_want_write(fh->fh_export->ex_path.mnt);
128 if (!ret)
129 fh->fh_want_write = true;
130 return ret;
131}
132
133static inline void fh_drop_write(struct svc_fh *fh)
134{
135 if (fh->fh_want_write) {
136 fh->fh_want_write = false;
137 mnt_drop_write(fh->fh_export->ex_path.mnt);
138 }
139}
140
141static inline __be32 fh_getattr(struct svc_fh *fh, struct kstat *stat)
142{
143 struct path p = {.mnt = fh->fh_export->ex_path.mnt,
144 .dentry = fh->fh_dentry};
145 return nfserrno(vfs_getattr(&p, stat, STATX_BASIC_STATS,
146 AT_STATX_SYNC_AS_STAT));
147}
148
149static inline int nfsd_create_is_exclusive(int createmode)
150{
151 return createmode == NFS3_CREATE_EXCLUSIVE
152 || createmode == NFS4_CREATE_EXCLUSIVE4_1;
153}
154
155#endif /* LINUX_NFSD_VFS_H */
1/*
2 * Copyright (C) 1995-1997 Olaf Kirch <okir@monad.swb.de>
3 */
4
5#ifndef LINUX_NFSD_VFS_H
6#define LINUX_NFSD_VFS_H
7
8#include "nfsfh.h"
9#include "nfsd.h"
10
11/*
12 * Flags for nfsd_permission
13 */
14#define NFSD_MAY_NOP 0
15#define NFSD_MAY_EXEC 0x001 /* == MAY_EXEC */
16#define NFSD_MAY_WRITE 0x002 /* == MAY_WRITE */
17#define NFSD_MAY_READ 0x004 /* == MAY_READ */
18#define NFSD_MAY_SATTR 0x008
19#define NFSD_MAY_TRUNC 0x010
20#define NFSD_MAY_LOCK 0x020
21#define NFSD_MAY_MASK 0x03f
22
23/* extra hints to permission and open routines: */
24#define NFSD_MAY_OWNER_OVERRIDE 0x040
25#define NFSD_MAY_LOCAL_ACCESS 0x080 /* for device special files */
26#define NFSD_MAY_BYPASS_GSS_ON_ROOT 0x100
27#define NFSD_MAY_NOT_BREAK_LEASE 0x200
28#define NFSD_MAY_BYPASS_GSS 0x400
29#define NFSD_MAY_READ_IF_EXEC 0x800
30
31#define NFSD_MAY_64BIT_COOKIE 0x1000 /* 64 bit readdir cookies for >= NFSv3 */
32
33#define NFSD_MAY_CREATE (NFSD_MAY_EXEC|NFSD_MAY_WRITE)
34#define NFSD_MAY_REMOVE (NFSD_MAY_EXEC|NFSD_MAY_WRITE|NFSD_MAY_TRUNC)
35
36/*
37 * Callback function for readdir
38 */
39typedef int (*nfsd_filldir_t)(void *, const char *, int, loff_t, u64, unsigned);
40
41/* nfsd/vfs.c */
42int nfsd_racache_init(int);
43void nfsd_racache_shutdown(void);
44int nfsd_cross_mnt(struct svc_rqst *rqstp, struct dentry **dpp,
45 struct svc_export **expp);
46__be32 nfsd_lookup(struct svc_rqst *, struct svc_fh *,
47 const char *, unsigned int, struct svc_fh *);
48__be32 nfsd_lookup_dentry(struct svc_rqst *, struct svc_fh *,
49 const char *, unsigned int,
50 struct svc_export **, struct dentry **);
51__be32 nfsd_setattr(struct svc_rqst *, struct svc_fh *,
52 struct iattr *, int, time_t);
53int nfsd_mountpoint(struct dentry *, struct svc_export *);
54#ifdef CONFIG_NFSD_V4
55__be32 nfsd4_set_nfs4_label(struct svc_rqst *, struct svc_fh *,
56 struct xdr_netobj *);
57__be32 nfsd4_vfs_fallocate(struct svc_rqst *, struct svc_fh *,
58 struct file *, loff_t, loff_t, int);
59__be32 nfsd4_clone_file_range(struct file *, u64, struct file *,
60 u64, u64);
61#endif /* CONFIG_NFSD_V4 */
62__be32 nfsd_create_locked(struct svc_rqst *, struct svc_fh *,
63 char *name, int len, struct iattr *attrs,
64 int type, dev_t rdev, struct svc_fh *res);
65__be32 nfsd_create(struct svc_rqst *, struct svc_fh *,
66 char *name, int len, struct iattr *attrs,
67 int type, dev_t rdev, struct svc_fh *res);
68#ifdef CONFIG_NFSD_V3
69__be32 nfsd_access(struct svc_rqst *, struct svc_fh *, u32 *, u32 *);
70__be32 do_nfsd_create(struct svc_rqst *, struct svc_fh *,
71 char *name, int len, struct iattr *attrs,
72 struct svc_fh *res, int createmode,
73 u32 *verifier, bool *truncp, bool *created);
74__be32 nfsd_commit(struct svc_rqst *, struct svc_fh *,
75 loff_t, unsigned long);
76#endif /* CONFIG_NFSD_V3 */
77__be32 nfsd_open(struct svc_rqst *, struct svc_fh *, umode_t,
78 int, struct file **);
79struct raparms;
80__be32 nfsd_splice_read(struct svc_rqst *,
81 struct file *, loff_t, unsigned long *);
82__be32 nfsd_readv(struct file *, loff_t, struct kvec *, int,
83 unsigned long *);
84__be32 nfsd_read(struct svc_rqst *, struct svc_fh *,
85 loff_t, struct kvec *, int, unsigned long *);
86__be32 nfsd_write(struct svc_rqst *, struct svc_fh *,struct file *,
87 loff_t, struct kvec *,int, unsigned long *, int *);
88__be32 nfsd_vfs_write(struct svc_rqst *rqstp, struct svc_fh *fhp,
89 struct file *file, loff_t offset,
90 struct kvec *vec, int vlen, unsigned long *cnt,
91 int *stablep);
92__be32 nfsd_readlink(struct svc_rqst *, struct svc_fh *,
93 char *, int *);
94__be32 nfsd_symlink(struct svc_rqst *, struct svc_fh *,
95 char *name, int len, char *path,
96 struct svc_fh *res);
97__be32 nfsd_link(struct svc_rqst *, struct svc_fh *,
98 char *, int, struct svc_fh *);
99ssize_t nfsd_copy_file_range(struct file *, u64,
100 struct file *, u64, u64);
101__be32 nfsd_rename(struct svc_rqst *,
102 struct svc_fh *, char *, int,
103 struct svc_fh *, char *, int);
104__be32 nfsd_unlink(struct svc_rqst *, struct svc_fh *, int type,
105 char *name, int len);
106__be32 nfsd_readdir(struct svc_rqst *, struct svc_fh *,
107 loff_t *, struct readdir_cd *, nfsd_filldir_t);
108__be32 nfsd_statfs(struct svc_rqst *, struct svc_fh *,
109 struct kstatfs *, int access);
110
111__be32 nfsd_permission(struct svc_rqst *, struct svc_export *,
112 struct dentry *, int);
113
114struct raparms *nfsd_init_raparms(struct file *file);
115void nfsd_put_raparams(struct file *file, struct raparms *ra);
116
117static inline int fh_want_write(struct svc_fh *fh)
118{
119 int ret = mnt_want_write(fh->fh_export->ex_path.mnt);
120
121 if (!ret)
122 fh->fh_want_write = true;
123 return ret;
124}
125
126static inline void fh_drop_write(struct svc_fh *fh)
127{
128 if (fh->fh_want_write) {
129 fh->fh_want_write = false;
130 mnt_drop_write(fh->fh_export->ex_path.mnt);
131 }
132}
133
134static inline __be32 fh_getattr(struct svc_fh *fh, struct kstat *stat)
135{
136 struct path p = {.mnt = fh->fh_export->ex_path.mnt,
137 .dentry = fh->fh_dentry};
138 return nfserrno(vfs_getattr(&p, stat));
139}
140
141static inline int nfsd_create_is_exclusive(int createmode)
142{
143 return createmode == NFS3_CREATE_EXCLUSIVE
144 || createmode == NFS4_CREATE_EXCLUSIVE4_1;
145}
146
147static inline bool nfsd_eof_on_read(long requested, long read,
148 loff_t offset, loff_t size)
149{
150 /* We assume a short read means eof: */
151 if (requested > read)
152 return true;
153 /*
154 * A non-short read might also reach end of file. The spec
155 * still requires us to set eof in that case.
156 *
157 * Further operations may have modified the file size since
158 * the read, so the following check is not atomic with the read.
159 * We've only seen that cause a problem for a client in the case
160 * where the read returned a count of 0 without setting eof.
161 * That case was fixed by the addition of the above check.
162 */
163 return (offset + read >= size);
164}
165
166#endif /* LINUX_NFSD_VFS_H */