xref: /openbmc/linux/fs/nfsd/vfs.h (revision 5f2fb52fac15a8a8e10ce020dd532504a8abfc4e)
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   */
40  typedef int (*nfsd_filldir_t)(void *, const char *, int, loff_t, u64, unsigned);
41  
42  /* nfsd/vfs.c */
43  int		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);
52  int 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, bool);
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 */
76  int 		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 *);
106  ssize_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  
121  static 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  
133  static 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  
141  static 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  
149  static 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 */
156