include/spl/sys/vnode.h

   1 /*
   2  *  Copyright (C) 2007-2010 Lawrence Livermore National Security, LLC.
   3  *  Copyright (C) 2007 The Regents of the University of California.
   4  *  Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
   5  *  Written by Brian Behlendorf <behlendorf1@llnl.gov>.
   6  *  UCRL-CODE-235197
   7  *
   8  *  This file is part of the SPL, Solaris Porting Layer.
   9  *  For details, see <http://zfsonlinux.org/>.
  10  *
  11  *  The SPL is free software; you can redistribute it and/or modify it
  12  *  under the terms of the GNU General Public License as published by the
  13  *  Free Software Foundation; either version 2 of the License, or (at your
  14  *  option) any later version.
  15  *
  16  *  The SPL is distributed in the hope that it will be useful, but WITHOUT
  17  *  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18  *  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19  *  for more details.
  20  *
  21  *  You should have received a copy of the GNU General Public License along
  22  *  with the SPL.  If not, see <http://www.gnu.org/licenses/>.
  23  */
  24
  25 #ifndef _SPL_VNODE_H
  26 #define _SPL_VNODE_H
  27
  28 #include <linux/module.h>
  29 #include <linux/syscalls.h>
  30 #include <linux/fcntl.h>
  31 #include <linux/buffer_head.h>
  32 #include <linux/dcache.h>
  33 #include <linux/namei.h>
  34 #include <linux/file.h>
  35 #include <linux/fs.h>
  36 #include <linux/fs_struct.h>
  37 #include <linux/mount.h>
  38 #include <sys/kmem.h>
  39 #include <sys/mutex.h>
  40 #include <sys/types.h>
  41 #include <sys/time.h>
  42 #include <sys/uio.h>
  43 #include <sys/user.h>
  44
  45 /*
  46  * Prior to linux-2.6.33 only O_DSYNC semantics were implemented and
  47  * they used the O_SYNC flag.  As of linux-2.6.33 the this behavior
  48  * was properly split in to O_SYNC and O_DSYNC respectively.
  49  */
  50 #ifndef O_DSYNC
  51 #define O_DSYNC         O_SYNC
  52 #endif
  53
  54 #define FREAD           1
  55 #define FWRITE          2
  56 #define FCREAT          O_CREAT
  57 #define FTRUNC          O_TRUNC
  58 #define FOFFMAX         O_LARGEFILE
  59 #define FSYNC           O_SYNC
  60 #define FDSYNC          O_DSYNC
  61 #define FRSYNC          O_SYNC
  62 #define FEXCL           O_EXCL
  63 #define FDIRECT         O_DIRECT
  64 #define FAPPEND         O_APPEND
  65
  66 #define FNODSYNC        0x10000 /* fsync pseudo flag */
  67 #define FNOFOLLOW       0x20000 /* don't follow symlinks */
  68
  69 #define F_FREESP        11      /* Free file space */
  70
  71
  72 /*
  73  * The vnode AT_ flags are mapped to the Linux ATTR_* flags.
  74  * This allows them to be used safely with an iattr structure.
  75  * The AT_XVATTR flag has been added and mapped to the upper
  76  * bit range to avoid conflicting with the standard Linux set.
  77  */
  78 #undef AT_UID
  79 #undef AT_GID
  80
  81 #define AT_MODE         ATTR_MODE
  82 #define AT_UID          ATTR_UID
  83 #define AT_GID          ATTR_GID
  84 #define AT_SIZE         ATTR_SIZE
  85 #define AT_ATIME        ATTR_ATIME
  86 #define AT_MTIME        ATTR_MTIME
  87 #define AT_CTIME        ATTR_CTIME
  88
  89 #define ATTR_XVATTR     (1 << 31)
  90 #define AT_XVATTR       ATTR_XVATTR
  91
  92 #define ATTR_IATTR_MASK (ATTR_MODE | ATTR_UID | ATTR_GID | ATTR_SIZE | \
  93                         ATTR_ATIME | ATTR_MTIME | ATTR_CTIME | ATTR_FILE)
  94
  95 #define CRCREAT         0x01
  96 #define RMFILE          0x02
  97
  98 #define B_INVAL         0x01
  99 #define B_TRUNC         0x02
 100
 101 #define LOOKUP_DIR              0x01
 102 #define LOOKUP_XATTR            0x02
 103 #define CREATE_XATTR_DIR        0x04
 104 #define ATTR_NOACLCHECK         0x20
 105
 106 typedef enum vtype {
 107         VNON            = 0,
 108         VREG            = 1,
 109         VDIR            = 2,
 110         VBLK            = 3,
 111         VCHR            = 4,
 112         VLNK            = 5,
 113         VFIFO           = 6,
 114         VDOOR           = 7,
 115         VPROC           = 8,
 116         VSOCK           = 9,
 117         VPORT           = 10,
 118         VBAD            = 11
 119 } vtype_t;
 120
 121 typedef struct vattr {
 122         enum vtype      va_type;        /* vnode type */
 123         uint_t          va_mask;        /* attribute bit-mask */
 124         ushort_t        va_mode;        /* acc mode */
 125         uid_t           va_uid;         /* owner uid */
 126         gid_t           va_gid;         /* owner gid */
 127         long            va_fsid;        /* fs id */
 128         long            va_nodeid;      /* node # */
 129         uint32_t        va_nlink;       /* # links */
 130         uint64_t        va_size;        /* file size */
 131         struct timespec va_atime;       /* last acc */
 132         struct timespec va_mtime;       /* last mod */
 133         struct timespec va_ctime;       /* last chg */
 134         dev_t           va_rdev;        /* dev */
 135         uint64_t        va_nblocks;     /* space used */
 136         uint32_t        va_blksize;     /* block size */
 137         uint32_t        va_seq;         /* sequence */
 138         struct dentry   *va_dentry;     /* dentry to wire */
 139 } vattr_t;
 140
 141 typedef struct vnode {
 142         struct file     *v_file;
 143         kmutex_t        v_lock;         /* protects vnode fields */
 144         uint_t          v_flag;         /* vnode flags (see below) */
 145         uint_t          v_count;        /* reference count */
 146         void            *v_data;        /* private data for fs */
 147         struct vfs      *v_vfsp;        /* ptr to containing VFS */
 148         struct stdata   *v_stream;      /* associated stream */
 149         enum vtype      v_type;         /* vnode type */
 150         dev_t           v_rdev;         /* device (VCHR, VBLK) */
 151         gfp_t           v_gfp_mask;     /* original mapping gfp mask */
 152 } vnode_t;
 153
 154 typedef struct vn_file {
 155         int             f_fd;           /* linux fd for lookup */
 156         struct task_struct *f_task;     /* linux task this fd belongs to */
 157         struct file     *f_file;        /* linux file struct */
 158         atomic_t        f_ref;          /* ref count */
 159         kmutex_t        f_lock;         /* struct lock */
 160         loff_t          f_offset;       /* offset */
 161         vnode_t         *f_vnode;       /* vnode */
 162         struct list_head f_list;        /* list referenced file_t's */
 163 } file_t;
 164
 165 extern vnode_t *vn_alloc(int flag);
 166 void vn_free(vnode_t *vp);
 167 extern vtype_t vn_mode_to_vtype(mode_t);
 168 extern mode_t vn_vtype_to_mode(vtype_t);
 169 extern int vn_open(const char *path, uio_seg_t seg, int flags, int mode,
 170     vnode_t **vpp, int x1, void *x2);
 171 extern int vn_openat(const char *path, uio_seg_t seg, int flags, int mode,
 172     vnode_t **vpp, int x1, void *x2, vnode_t *vp, int fd);
 173 extern int vn_rdwr(uio_rw_t uio, vnode_t *vp, void *addr, ssize_t len,
 174     offset_t off, uio_seg_t seg, int x1, rlim64_t x2,
 175     void *x3, ssize_t *residp);
 176 extern int vn_close(vnode_t *vp, int flags, int x1, int x2, void *x3, void *x4);
 177 extern int vn_seek(vnode_t *vp, offset_t o, offset_t *op, void *ct);
 178
 179 extern int vn_getattr(vnode_t *vp, vattr_t *vap, int flags, void *x3, void *x4);
 180 extern int vn_fsync(vnode_t *vp, int flags, void *x3, void *x4);
 181 extern int vn_space(vnode_t *vp, int cmd, struct flock *bfp, int flag,
 182     offset_t offset, void *x6, void *x7);
 183 extern file_t *vn_getf(int fd);
 184 extern void vn_releasef(int fd);
 185 extern void vn_areleasef(int fd, uf_info_t *fip);
 186 extern int vn_set_pwd(const char *filename);
 187
 188 int spl_vn_init(void);
 189 void spl_vn_fini(void);
 190
 191 #define VOP_CLOSE                               vn_close
 192 #define VOP_SEEK                                vn_seek
 193 #define VOP_GETATTR                             vn_getattr
 194 #define VOP_FSYNC                               vn_fsync
 195 #define VOP_SPACE                               vn_space
 196 #define VOP_PUTPAGE(vp, o, s, f, x1, x2)        ((void)0)
 197 #define vn_is_readonly(vp)                      0
 198 #define getf                                    vn_getf
 199 #define releasef                                vn_releasef
 200 #define areleasef                               vn_areleasef
 201
 202 extern vnode_t *rootdir;
 203
 204 #endif /* SPL_VNODE_H */