fs/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
  37 struct nfsd_file;
  38
  39 /*
  40  * Callback function for readdir
  41  */
  42 typedef int (*nfsd_filldir_t)(void *, const char *, int, loff_t, u64, unsigned);
  43
  44 /* nfsd/vfs.c */
  45 int             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);
  54 int 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 svc_rqst *rqstp,
  61                                        struct nfsd_file *nf_src, u64 src_pos,
  62                                        struct nfsd_file *nf_dst, u64 dst_pos,
  63                                        u64 count, bool sync);
  64 #endif /* CONFIG_NFSD_V4 */
  65 __be32          nfsd_create_locked(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 __be32          nfsd_create(struct svc_rqst *, struct svc_fh *,
  69                                 char *name, int len, struct iattr *attrs,
  70                                 int type, dev_t rdev, struct svc_fh *res);
  71 #ifdef CONFIG_NFSD_V3
  72 __be32          nfsd_access(struct svc_rqst *, struct svc_fh *, u32 *, u32 *);
  73 __be32          do_nfsd_create(struct svc_rqst *, struct svc_fh *,
  74                                 char *name, int len, struct iattr *attrs,
  75                                 struct svc_fh *res, int createmode,
  76                                 u32 *verifier, bool *truncp, bool *created);
  77 __be32          nfsd_commit(struct svc_rqst *rqst, struct svc_fh *fhp,
  78                                 u64 offset, u32 count, __be32 *verf);
  79 #endif /* CONFIG_NFSD_V3 */
  80 #ifdef CONFIG_NFSD_V4
  81 __be32          nfsd_getxattr(struct svc_rqst *rqstp, struct svc_fh *fhp,
  82                             char *name, void **bufp, int *lenp);
  83 __be32          nfsd_listxattr(struct svc_rqst *rqstp, struct svc_fh *fhp,
  84                             char **bufp, int *lenp);
  85 __be32          nfsd_removexattr(struct svc_rqst *rqstp, struct svc_fh *fhp,
  86                             char *name);
  87 __be32          nfsd_setxattr(struct svc_rqst *rqstp, struct svc_fh *fhp,
  88                             char *name, void *buf, u32 len, u32 flags);
  89 #endif
  90 int             nfsd_open_break_lease(struct inode *, int);
  91 __be32          nfsd_open(struct svc_rqst *, struct svc_fh *, umode_t,
  92                                 int, struct file **);
  93 __be32          nfsd_open_verified(struct svc_rqst *, struct svc_fh *, umode_t,
  94                                 int, struct file **);
  95 __be32          nfsd_splice_read(struct svc_rqst *rqstp, struct svc_fh *fhp,
  96                                 struct file *file, loff_t offset,
  97                                 unsigned long *count,
  98                                 u32 *eof);
  99 __be32          nfsd_readv(struct svc_rqst *rqstp, struct svc_fh *fhp,
 100                                 struct file *file, loff_t offset,
 101                                 struct kvec *vec, int vlen,
 102                                 unsigned long *count,
 103                                 u32 *eof);
 104 __be32          nfsd_read(struct svc_rqst *, struct svc_fh *,
 105                                 loff_t, struct kvec *, int, unsigned long *,
 106                                 u32 *eof);
 107 __be32          nfsd_write(struct svc_rqst *, struct svc_fh *, loff_t,
 108                                 struct kvec *, int, unsigned long *,
 109                                 int stable, __be32 *verf);
 110 __be32          nfsd_vfs_write(struct svc_rqst *rqstp, struct svc_fh *fhp,
 111                                 struct nfsd_file *nf, loff_t offset,
 112                                 struct kvec *vec, int vlen, unsigned long *cnt,
 113                                 int stable, __be32 *verf);
 114 __be32          nfsd_readlink(struct svc_rqst *, struct svc_fh *,
 115                                 char *, int *);
 116 __be32          nfsd_symlink(struct svc_rqst *, struct svc_fh *,
 117                                 char *name, int len, char *path,
 118                                 struct svc_fh *res);
 119 __be32          nfsd_link(struct svc_rqst *, struct svc_fh *,
 120                                 char *, int, struct svc_fh *);
 121 ssize_t         nfsd_copy_file_range(struct file *, u64,
 122                                      struct file *, u64, u64);
 123 __be32          nfsd_rename(struct svc_rqst *,
 124                                 struct svc_fh *, char *, int,
 125                                 struct svc_fh *, char *, int);
 126 __be32          nfsd_unlink(struct svc_rqst *, struct svc_fh *, int type,
 127                                 char *name, int len);
 128 __be32          nfsd_readdir(struct svc_rqst *, struct svc_fh *,
 129                              loff_t *, struct readdir_cd *, nfsd_filldir_t);
 130 __be32          nfsd_statfs(struct svc_rqst *, struct svc_fh *,
 131                                 struct kstatfs *, int access);
 132
 133 __be32          nfsd_permission(struct svc_rqst *, struct svc_export *,
 134                                 struct dentry *, int);
 135
 136 static inline int fh_want_write(struct svc_fh *fh)
 137 {
 138         int ret;
 139
 140         if (fh->fh_want_write)
 141                 return 0;
 142         ret = mnt_want_write(fh->fh_export->ex_path.mnt);
 143         if (!ret)
 144                 fh->fh_want_write = true;
 145         return ret;
 146 }
 147
 148 static inline void fh_drop_write(struct svc_fh *fh)
 149 {
 150         if (fh->fh_want_write) {
 151                 fh->fh_want_write = false;
 152                 mnt_drop_write(fh->fh_export->ex_path.mnt);
 153         }
 154 }
 155
 156 static inline __be32 fh_getattr(const struct svc_fh *fh, struct kstat *stat)
 157 {
 158         struct path p = {.mnt = fh->fh_export->ex_path.mnt,
 159                          .dentry = fh->fh_dentry};
 160         return nfserrno(vfs_getattr(&p, stat, STATX_BASIC_STATS,
 161                                     AT_STATX_SYNC_AS_STAT));
 162 }
 163
 164 static inline int nfsd_create_is_exclusive(int createmode)
 165 {
 166         return createmode == NFS3_CREATE_EXCLUSIVE
 167                || createmode == NFS4_CREATE_EXCLUSIVE4_1;
 168 }
 169
 170 #endif /* LINUX_NFSD_VFS_H */