include/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 #include <sys/sunldi.h>
  45
  46 /*
  47  * Prior to linux-2.6.33 only O_DSYNC semantics were implemented and
  48  * they used the O_SYNC flag.  As of linux-2.6.33 the this behavior
  49  * was properly split in to O_SYNC and O_DSYNC respectively.
  50  */
  51 #ifndef O_DSYNC
  52 #define O_DSYNC         O_SYNC
  53 #endif
  54
  55 #define FREAD           1
  56 #define FWRITE          2
  57 #define FCREAT          O_CREAT
  58 #define FTRUNC          O_TRUNC
  59 #define FOFFMAX         O_LARGEFILE
  60 #define FSYNC           O_SYNC
  61 #define FDSYNC          O_DSYNC
  62 #define FRSYNC          O_SYNC
  63 #define FEXCL           O_EXCL
  64 #define FDIRECT         O_DIRECT
  65 #define FAPPEND         O_APPEND
  66
  67 #define FNODSYNC        0x10000 /* fsync pseudo flag */
  68 #define FNOFOLLOW       0x20000 /* don't follow symlinks */
  69
  70 #define F_FREESP        11      /* Free file space */
  71
  72
  73 /*
  74  * The vnode AT_ flags are mapped to the Linux ATTR_* flags.
  75  * This allows them to be used safely with an iattr structure.
  76  * The AT_XVATTR flag has been added and mapped to the upper
  77  * bit range to avoid conflicting with the standard Linux set.
  78  */
  79 #undef AT_UID
  80 #undef AT_GID
  81
  82 #define AT_MODE         ATTR_MODE
  83 #define AT_UID          ATTR_UID
  84 #define AT_GID          ATTR_GID
  85 #define AT_SIZE         ATTR_SIZE
  86 #define AT_ATIME        ATTR_ATIME
  87 #define AT_MTIME        ATTR_MTIME
  88 #define AT_CTIME        ATTR_CTIME
  89
  90 #define ATTR_XVATTR     (1 << 31)
  91 #define AT_XVATTR       ATTR_XVATTR
  92
  93 #define ATTR_IATTR_MASK (ATTR_MODE | ATTR_UID | ATTR_GID | ATTR_SIZE | \
  94                         ATTR_ATIME | ATTR_MTIME | ATTR_CTIME | ATTR_FILE)
  95
  96 #define CRCREAT         0x01
  97 #define RMFILE          0x02
  98
  99 #define B_INVAL         0x01
 100 #define B_TRUNC         0x02
 101
 102 #define LOOKUP_DIR              0x01
 103 #define LOOKUP_XATTR            0x02
 104 #define CREATE_XATTR_DIR        0x04
 105 #define ATTR_NOACLCHECK         0x20
 106
 107 typedef enum vtype {
 108         VNON            = 0,
 109         VREG            = 1,
 110         VDIR            = 2,
 111         VBLK            = 3,
 112         VCHR            = 4,
 113         VLNK            = 5,
 114         VFIFO           = 6,
 115         VDOOR           = 7,
 116         VPROC           = 8,
 117         VSOCK           = 9,
 118         VPORT           = 10,
 119         VBAD            = 11
 120 } vtype_t;
 121
 122 typedef struct vattr {
 123         enum vtype      va_type;        /* vnode type */
 124         uint_t          va_mask;        /* attribute bit-mask */
 125         ushort_t        va_mode;        /* acc mode */
 126         uid_t           va_uid;         /* owner uid */
 127         gid_t           va_gid;         /* owner gid */
 128         long            va_fsid;        /* fs id */
 129         long            va_nodeid;      /* node # */
 130         uint32_t        va_nlink;       /* # links */
 131         uint64_t        va_size;        /* file size */
 132         inode_timespec_t va_atime;      /* last acc */
 133         inode_timespec_t va_mtime;      /* last mod */
 134         inode_timespec_t va_ctime;      /* last chg */
 135         dev_t           va_rdev;        /* dev */
 136         uint64_t        va_nblocks;     /* space used */
 137         uint32_t        va_blksize;     /* block size */
 138         uint32_t        va_seq;         /* sequence */
 139         struct dentry   *va_dentry;     /* dentry to wire */
 140 } vattr_t;
 141
 142 typedef struct vnode {
 143         struct file     *v_file;
 144         kmutex_t        v_lock;         /* protects vnode fields */
 145         uint_t          v_flag;         /* vnode flags (see below) */
 146         uint_t          v_count;        /* reference count */
 147         void            *v_data;        /* private data for fs */
 148         struct vfs      *v_vfsp;        /* ptr to containing VFS */
 149         struct stdata   *v_stream;      /* associated stream */
 150         enum vtype      v_type;         /* vnode type */
 151         dev_t           v_rdev;         /* device (VCHR, VBLK) */
 152         gfp_t           v_gfp_mask;     /* original mapping gfp mask */
 153 } vnode_t;
 154
 155 typedef struct vn_file {
 156         int             f_fd;           /* linux fd for lookup */
 157         struct task_struct *f_task;     /* linux task this fd belongs to */
 158         struct file     *f_file;        /* linux file struct */
 159         atomic_t        f_ref;          /* ref count */
 160         kmutex_t        f_lock;         /* struct lock */
 161         loff_t          f_offset;       /* offset */
 162         vnode_t         *f_vnode;       /* vnode */
 163         struct list_head f_list;        /* list referenced file_t's */
 164 } file_t;
 165
 166 extern vnode_t *vn_alloc(int flag);
 167 void vn_free(vnode_t *vp);
 168 extern vtype_t vn_mode_to_vtype(mode_t);
 169 extern mode_t vn_vtype_to_mode(vtype_t);
 170 extern int vn_open(const char *path, uio_seg_t seg, int flags, int mode,
 171     vnode_t **vpp, int x1, void *x2);
 172 extern int vn_openat(const char *path, uio_seg_t seg, int flags, int mode,
 173     vnode_t **vpp, int x1, void *x2, vnode_t *vp, int fd);
 174 extern int vn_rdwr(uio_rw_t uio, vnode_t *vp, void *addr, ssize_t len,
 175     offset_t off, uio_seg_t seg, int x1, rlim64_t x2,
 176     void *x3, ssize_t *residp);
 177 extern int vn_close(vnode_t *vp, int flags, int x1, int x2, void *x3, void *x4);
 178 extern int vn_seek(vnode_t *vp, offset_t o, offset_t *op, void *ct);
 179
 180 extern int vn_getattr(vnode_t *vp, vattr_t *vap, int flags, void *x3, void *x4);
 181 extern int vn_fsync(vnode_t *vp, int flags, void *x3, void *x4);
 182 extern int vn_space(vnode_t *vp, int cmd, struct flock *bfp, int flag,
 183     offset_t offset, void *x6, void *x7);
 184 extern file_t *vn_getf(int fd);
 185 extern void vn_releasef(int fd);
 186 extern void vn_areleasef(int fd, uf_info_t *fip);
 187 extern int vn_set_pwd(const char *filename);
 188
 189 int spl_vn_init(void);
 190 void spl_vn_fini(void);
 191
 192 #define VOP_CLOSE                               vn_close
 193 #define VOP_SEEK                                vn_seek
 194 #define VOP_GETATTR                             vn_getattr
 195 #define VOP_FSYNC                               vn_fsync
 196 #define VOP_SPACE                               vn_space
 197 #define VOP_PUTPAGE(vp, o, s, f, x1, x2)        ((void)0)
 198 #define vn_is_readonly(vp)                      0
 199 #define getf                                    vn_getf
 200 #define releasef                                vn_releasef
 201 #define areleasef                               vn_areleasef
 202
 203 extern vnode_t *rootdir;
 204
 205 #endif /* SPL_VNODE_H */