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 <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		attrs->na_pacl || attrs->na_dpacl);
 72}
 73
 74__be32		nfserrno (int errno);
 75int		nfsd_cross_mnt(struct svc_rqst *rqstp, struct dentry **dpp,
 76		                struct svc_export **expp);
 77__be32		nfsd_lookup(struct svc_rqst *, struct svc_fh *,
 78				const char *, unsigned int, struct svc_fh *);
 79__be32		 nfsd_lookup_dentry(struct svc_rqst *, struct svc_fh *,
 80				const char *, unsigned int,
 81				struct svc_export **, struct dentry **);
 82__be32		nfsd_setattr(struct svc_rqst *, struct svc_fh *,
 83			     struct nfsd_attrs *, const struct timespec64 *);
 84int nfsd_mountpoint(struct dentry *, struct svc_export *);
 85#ifdef CONFIG_NFSD_V4
 86__be32		nfsd4_vfs_fallocate(struct svc_rqst *, struct svc_fh *,
 87				    struct file *, loff_t, loff_t, int);
 88__be32		nfsd4_clone_file_range(struct svc_rqst *rqstp,
 89				       struct nfsd_file *nf_src, u64 src_pos,
 90				       struct nfsd_file *nf_dst, u64 dst_pos,
 91				       u64 count, bool sync);
 92#endif /* CONFIG_NFSD_V4 */
 93__be32		nfsd_create_locked(struct svc_rqst *, struct svc_fh *,
 94				struct nfsd_attrs *attrs, int type, dev_t rdev,
 95				struct svc_fh *res);
 96__be32		nfsd_create(struct svc_rqst *, struct svc_fh *,
 97				char *name, int len, struct nfsd_attrs *attrs,
 98				int type, dev_t rdev, struct svc_fh *res);
 99__be32		nfsd_access(struct svc_rqst *, struct svc_fh *, u32 *, u32 *);
100__be32		nfsd_create_setattr(struct svc_rqst *rqstp, struct svc_fh *fhp,
101				struct svc_fh *resfhp, struct nfsd_attrs *iap);
102__be32		nfsd_commit(struct svc_rqst *rqst, struct svc_fh *fhp,
103				struct nfsd_file *nf, u64 offset, u32 count,
104				__be32 *verf);
105#ifdef CONFIG_NFSD_V4
106__be32		nfsd_getxattr(struct svc_rqst *rqstp, struct svc_fh *fhp,
107			    char *name, void **bufp, int *lenp);
108__be32		nfsd_listxattr(struct svc_rqst *rqstp, struct svc_fh *fhp,
109			    char **bufp, int *lenp);
110__be32		nfsd_removexattr(struct svc_rqst *rqstp, struct svc_fh *fhp,
111			    char *name);
112__be32		nfsd_setxattr(struct svc_rqst *rqstp, struct svc_fh *fhp,
113			    char *name, void *buf, u32 len, u32 flags);
114#endif
115int 		nfsd_open_break_lease(struct inode *, int);
116__be32		nfsd_open(struct svc_rqst *, struct svc_fh *, umode_t,
117				int, struct file **);
118int		nfsd_open_verified(struct svc_fh *fhp, umode_t type, int may_flags,
119				struct file **filp);
120__be32		nfsd_splice_read(struct svc_rqst *rqstp, struct svc_fh *fhp,
121				struct file *file, loff_t offset,
122				unsigned long *count,
123				u32 *eof);
124__be32		nfsd_iter_read(struct svc_rqst *rqstp, struct svc_fh *fhp,
125				struct nfsd_file *nf, loff_t offset,
126				unsigned long *count, unsigned int base,
127				u32 *eof);
128bool		nfsd_read_splice_ok(struct svc_rqst *rqstp);
129__be32		nfsd_read(struct svc_rqst *rqstp, struct svc_fh *fhp,
130				loff_t offset, unsigned long *count,
131				u32 *eof);
132__be32		nfsd_write(struct svc_rqst *rqstp, struct svc_fh *fhp,
133				loff_t offset, const struct xdr_buf *payload,
134				unsigned long *cnt, int stable, __be32 *verf);
135__be32		nfsd_vfs_write(struct svc_rqst *rqstp, struct svc_fh *fhp,
136				struct nfsd_file *nf, loff_t offset,
137				const struct xdr_buf *payload,
138				unsigned long *cnt, int stable, __be32 *verf);
139__be32		nfsd_readlink(struct svc_rqst *, struct svc_fh *,
140				char *, int *);
141__be32		nfsd_symlink(struct svc_rqst *, struct svc_fh *,
142			     char *name, int len, char *path,
143			     struct nfsd_attrs *attrs,
144			     struct svc_fh *res);
145__be32		nfsd_link(struct svc_rqst *, struct svc_fh *,
146				char *, int, struct svc_fh *);
147ssize_t		nfsd_copy_file_range(struct file *, u64,
148				     struct file *, u64, u64);
149__be32		nfsd_rename(struct svc_rqst *,
150				struct svc_fh *, char *, int,
151				struct svc_fh *, char *, int);
152__be32		nfsd_unlink(struct svc_rqst *, struct svc_fh *, int type,
153				char *name, int len);
154__be32		nfsd_readdir(struct svc_rqst *, struct svc_fh *,
155			     loff_t *, struct readdir_cd *, nfsd_filldir_t);
156__be32		nfsd_statfs(struct svc_rqst *, struct svc_fh *,
157				struct kstatfs *, int access);
158
159__be32		nfsd_permission(struct svc_cred *cred, struct svc_export *exp,
160				struct dentry *dentry, int acc);
161
162void		nfsd_filp_close(struct file *fp);
163
164#endif /* LINUX_NFSD_VFS_H */