LXR linux/fs/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 *, loff_t,
  87                                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 stable);
  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, STATX_BASIC_STATS,
 139                                    AT_STATX_SYNC_AS_STAT));
 140}
 141
 142static inline int nfsd_create_is_exclusive(int createmode)
 143{
 144        return createmode == NFS3_CREATE_EXCLUSIVE
 145               || createmode == NFS4_CREATE_EXCLUSIVE4_1;
 146}
 147
 148static inline bool nfsd_eof_on_read(long requested, long read,
 149                                loff_t offset, loff_t size)
 150{
 151        /* We assume a short read means eof: */
 152        if (requested > read)
 153                return true;
 154        /*
 155         * A non-short read might also reach end of file.  The spec
 156         * still requires us to set eof in that case.
 157         *
 158         * Further operations may have modified the file size since
 159         * the read, so the following check is not atomic with the read.
 160         * We've only seen that cause a problem for a client in the case
 161         * where the read returned a count of 0 without setting eof.
 162         * That case was fixed by the addition of the above check.
 163         */
 164        return (offset + read >= size);
 165}
 166
 167#endif /* LINUX_NFSD_VFS_H */
 168