blob: 0bf9e7bf5800af3855e3d93aaec194dcbea93ba6 [file] [log] [blame]
J. Bruce Fields0a3adad2009-11-04 18:12:35 -05001/*
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
J. Bruce Fields1557aca2009-12-04 19:36:06 -05008#include "nfsfh.h"
Al Viro3dadecc2013-01-24 02:18:08 -05009#include "nfsd.h"
J. Bruce Fields1557aca2009-12-04 19:36:06 -050010
J. Bruce Fields0a3adad2009-11-04 18:12:35 -050011/*
12 * Flags for nfsd_permission
13 */
J. Bruce Fields8e82fa82011-08-25 14:23:39 -040014#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
J. Bruce Fieldsaea93392011-04-10 10:35:12 -040022
23/* extra hints to permission and open routines: */
J. Bruce Fields8e82fa82011-08-25 14:23:39 -040024#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
J. Bruce Fields0a3adad2009-11-04 18:12:35 -050030
Bernd Schubert06effdb2012-03-18 22:44:50 -040031#define NFSD_MAY_64BIT_COOKIE 0x1000 /* 64 bit readdir cookies for >= NFSv3 */
32
J. Bruce Fields0a3adad2009-11-04 18:12:35 -050033#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 */
Miklos Szerediac7576f2014-10-30 17:37:34 +010039typedef int (*nfsd_filldir_t)(void *, const char *, int, loff_t, u64, unsigned);
J. Bruce Fields0a3adad2009-11-04 18:12:35 -050040
41/* nfsd/vfs.c */
J. Bruce Fields0a3adad2009-11-04 18:12:35 -050042int 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);
J. Bruce Fields3227fa42009-10-25 21:43:01 -040053int nfsd_mountpoint(struct dentry *, struct svc_export *);
J. Bruce Fields0a3adad2009-11-04 18:12:35 -050054#ifdef CONFIG_NFSD_V4
David Quigley18032ca2013-05-02 13:19:10 -040055__be32 nfsd4_set_nfs4_label(struct svc_rqst *, struct svc_fh *,
56 struct xdr_netobj *);
Anna Schumaker95d871f2014-11-07 14:44:26 -050057__be32 nfsd4_vfs_fallocate(struct svc_rqst *, struct svc_fh *,
58 struct file *, loff_t, loff_t, int);
Christoph Hellwigffa01602015-12-03 12:59:52 +010059__be32 nfsd4_clone_file_range(struct file *, u64, struct file *,
60 u64, u64);
J. Bruce Fields0a3adad2009-11-04 18:12:35 -050061#endif /* CONFIG_NFSD_V4 */
J. Bruce Fieldsb44061d2016-07-20 16:16:06 -040062__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);
J. Bruce Fields0a3adad2009-11-04 18:12:35 -050065__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 *);
Mi Jinlongac6721a2011-04-20 17:06:25 +080070__be32 do_nfsd_create(struct svc_rqst *, struct svc_fh *,
J. Bruce Fields0a3adad2009-11-04 18:12:35 -050071 char *name, int len, struct iattr *attrs,
72 struct svc_fh *res, int createmode,
J. Bruce Fields856121b2011-10-13 11:37:11 -040073 u32 *verifier, bool *truncp, bool *created);
J. Bruce Fields0a3adad2009-11-04 18:12:35 -050074__be32 nfsd_commit(struct svc_rqst *, struct svc_fh *,
75 loff_t, unsigned long);
76#endif /* CONFIG_NFSD_V3 */
Al Viro175a4eb2011-07-26 03:30:54 -040077__be32 nfsd_open(struct svc_rqst *, struct svc_fh *, umode_t,
J. Bruce Fields0a3adad2009-11-04 18:12:35 -050078 int, struct file **);
J. Bruce Fieldsdc976182014-03-18 17:01:51 -040079struct raparms;
Jeff Laytone2afc812014-06-17 07:44:13 -040080__be32 nfsd_splice_read(struct svc_rqst *,
J. Bruce Fieldsdc976182014-03-18 17:01:51 -040081 struct file *, loff_t, unsigned long *);
Jeff Laytone2afc812014-06-17 07:44:13 -040082__be32 nfsd_readv(struct file *, loff_t, struct kvec *, int,
J. Bruce Fieldsdc976182014-03-18 17:01:51 -040083 unsigned long *);
J. Bruce Fields039a87c2010-07-30 11:33:32 -040084__be32 nfsd_read(struct svc_rqst *, struct svc_fh *,
85 loff_t, struct kvec *, int, unsigned long *);
J. Bruce Fields0a3adad2009-11-04 18:12:35 -050086__be32 nfsd_write(struct svc_rqst *, struct svc_fh *,struct file *,
87 loff_t, struct kvec *,int, unsigned long *, int *);
Christoph Hellwigaf90f702015-06-18 16:45:00 +020088__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);
J. Bruce Fields0a3adad2009-11-04 18:12:35 -050092__be32 nfsd_readlink(struct svc_rqst *, struct svc_fh *,
93 char *, int *);
94__be32 nfsd_symlink(struct svc_rqst *, struct svc_fh *,
J. Bruce Fields52ee0432014-06-20 11:52:21 -040095 char *name, int len, char *path,
Kinglong Mee1e444f52014-07-01 17:48:02 +080096 struct svc_fh *res);
J. Bruce Fields0a3adad2009-11-04 18:12:35 -050097__be32 nfsd_link(struct svc_rqst *, struct svc_fh *,
98 char *, int, struct svc_fh *);
Anna Schumaker29ae7f92016-09-07 15:57:30 -040099ssize_t nfsd_copy_file_range(struct file *, u64,
100 struct file *, u64, u64);
J. Bruce Fields0a3adad2009-11-04 18:12:35 -0500101__be32 nfsd_rename(struct svc_rqst *,
102 struct svc_fh *, char *, int,
103 struct svc_fh *, char *, int);
J. Bruce Fields0a3adad2009-11-04 18:12:35 -0500104__be32 nfsd_unlink(struct svc_rqst *, struct svc_fh *, int type,
105 char *name, int len);
J. Bruce Fields0a3adad2009-11-04 18:12:35 -0500106__be32 nfsd_readdir(struct svc_rqst *, struct svc_fh *,
Miklos Szerediac7576f2014-10-30 17:37:34 +0100107 loff_t *, struct readdir_cd *, nfsd_filldir_t);
J. Bruce Fields0a3adad2009-11-04 18:12:35 -0500108__be32 nfsd_statfs(struct svc_rqst *, struct svc_fh *,
109 struct kstatfs *, int access);
110
J. Bruce Fields0a3adad2009-11-04 18:12:35 -0500111__be32 nfsd_permission(struct svc_rqst *, struct svc_export *,
112 struct dentry *, int);
J. Bruce Fields0a3adad2009-11-04 18:12:35 -0500113
Christoph Hellwige749a462015-06-18 16:44:58 +0200114struct raparms *nfsd_init_raparms(struct file *file);
115void nfsd_put_raparams(struct file *file, struct raparms *ra);
116
Al Virobad0dcf2011-11-23 12:03:18 -0500117static inline int fh_want_write(struct svc_fh *fh)
118{
Jan Kara4a55c102012-06-12 16:20:33 +0200119 int ret = mnt_want_write(fh->fh_export->ex_path.mnt);
120
121 if (!ret)
Jeff Laytonaaf91ec2015-09-17 08:28:39 -0400122 fh->fh_want_write = true;
Jan Kara4a55c102012-06-12 16:20:33 +0200123 return ret;
Al Virobad0dcf2011-11-23 12:03:18 -0500124}
125
126static inline void fh_drop_write(struct svc_fh *fh)
127{
Jan Kara4a55c102012-06-12 16:20:33 +0200128 if (fh->fh_want_write) {
Jeff Laytonaaf91ec2015-09-17 08:28:39 -0400129 fh->fh_want_write = false;
Jan Kara4a55c102012-06-12 16:20:33 +0200130 mnt_drop_write(fh->fh_export->ex_path.mnt);
131 }
Al Virobad0dcf2011-11-23 12:03:18 -0500132}
133
Al Viro3dadecc2013-01-24 02:18:08 -0500134static 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
Kinglong Meeead8fb82015-07-30 21:55:02 +0800141static inline int nfsd_create_is_exclusive(int createmode)
142{
143 return createmode == NFS3_CREATE_EXCLUSIVE
144 || createmode == NFS4_CREATE_EXCLUSIVE4_1;
145}
146
Benjamin Coddingtonac503e42016-03-22 10:28:36 -0400147static 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
J. Bruce Fields0a3adad2009-11-04 18:12:35 -0500166#endif /* LINUX_NFSD_VFS_H */