sys/vfs/dirfs/dirfs.h

   1 /*
   2  * Copyright (c) 2013 The DragonFly Project.  All rights reserved.
   3  *
   4  * This code is derived from software contributed to The DragonFly Project
   5  * by Antonio Huete Jimenez <tuxillo@quantumachine.net>
   6  * by Matthew Dillon <dillon@dragonflybsd.org>
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  *
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in
  16  *    the documentation and/or other materials provided with the
  17  *    distribution.
  18  * 3. Neither the name of The DragonFly Project nor the names of its
  19  *    contributors may be used to endorse or promote products derived
  20  *    from this software without specific, prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  23  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  24  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  25  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  26  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  27  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  28  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  29  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  30  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  31  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  32  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  33  * SUCH DAMAGE.
  34  *
  35  */
  36
  37 #ifndef _SYS_VFS_DIRFS_DIRFS_H_
  38 #define _SYS_VFS_DIRFS_DIRFS_H_
  39
  40 #include <unistd.h>
  41
  42 #include <sys/lockf.h>
  43 #include <sys/stat.h>
  44 #include <sys/vnode.h>
  45
  46 MALLOC_DECLARE(M_DIRFS);
  47 MALLOC_DECLARE(M_DIRFS_NODE);
  48 MALLOC_DECLARE(M_DIRFS_MISC);
  49
  50 #ifndef KTR_DIRFS
  51 #define KTR_DIRFS KTR_ALL
  52 #endif
  53
  54 #define DIRFS_NOFD      -1      /* No fd present */
  55
  56 #define DIRFS_ROOT      0x00000001
  57 #define DIRFS_DOOMED    0x00000002
  58 #define DIRFS_NODE_RD   0x00000004
  59 #define DIRFS_NODE_WR   0x00000008
  60 #define DIRFS_NODE_EXE  0x00000010
  61
  62 #define DIRFS_TXTFLG "doomed"
  63
  64 /* Used for buffer cache operations */
  65 #define BSIZE   16384
  66 #define BMASK   (BSIZE - 1)
  67
  68 /*
  69  * XXX This should be temporary. A semi-proper solution would be to expose
  70  * below prototypes in the _KERNEL_VIRTUAL case.
  71  */
  72 extern int getdirentries(int, char *, int, long *);
  73 extern int statfs(const char *, struct statfs *);
  74
  75 /*
  76  * Debugging macros. The impact should be determined and in case it has a
  77  * considerable performance penalty, it should be enclosed in a DEBUG #ifdef.
  78  */
  79 #define debug_called() do {                                     \
  80                 dbg(9, "called\n", __func__);                   \
  81 } while(0)
  82
  83 #define dbg(lvl, fmt, ...) do {                                 \
  84                 debug(lvl, "%s: " fmt, __func__, ##__VA_ARGS__);        \
  85 } while(0)
  86
  87 #define debug_node(s) do {                                              \
  88                 dbg(5, "mode=%u flags=%u dn_name=%s "                   \
  89                     "uid=%u gid=%u objtype=%u nlinks=%d "               \
  90                     "size=%jd ctime=%ju atime=%ju mtime=%ju\n",         \
  91                     s->dn_mode, s->dn_flags, s->dn_name,                \
  92                     s->dn_uid, s->dn_gid, s->dn_type,                   \
  93                     s->dn_links, s->dn_size,                            \
  94                     s->dn_ctime, s->dn_atime,                           \
  95                     s->dn_mtime);                                       \
  96 } while(0)
  97
  98 #define debug_node2(n) do {                                             \
  99                 dbg(5, "dnp=%p name=%s fd=%d parent=%p vnode=%p "       \
 100                     "refcnt=%d state=%s\n",                             \
 101                     n, n->dn_name, n->dn_fd, n->dn_parent, n->dn_vnode, \
 102                     n->dn_refcnt, dirfs_flag2str(n));                   \
 103 } while(0)
 104
 105 /*
 106  * Locking macros
 107  */
 108 #define dirfs_node_islocked(n)  (lockstatus(&(n)->dn_lock,curthread) == LK_EXCLUSIVE)
 109 #define dirfs_node_lock(n)      lockmgr(&(n)->dn_lock, LK_EXCLUSIVE|LK_RETRY)
 110 #define dirfs_node_unlock(n)    lockmgr(&(n)->dn_lock, LK_RELEASE)
 111 #define dirfs_mount_lock(m)     lockmgr(&(m)->dm_lock, LK_EXCLUSIVE|LK_RETRY)
 112 #define dirfs_mount_unlock(m)   lockmgr(&(m)->dm_lock, LK_RELEASE)
 113 #define dirfs_mount_gettoken(m) lwkt_gettoken(&(m)->dm_token)
 114 #define dirfs_mount_reltoken(m) lwkt_reltoken(&(m)->dm_token)
 115
 116 /*
 117  * Misc macros
 118  */
 119 #define dirfs_node_isroot(n)    (n->dn_state & DIRFS_ROOT)
 120 #define dirfs_node_hasfd(n)     (n->dn_fd != DIRFS_NOFD)
 121
 122 /*
 123  * Main in-memory node structure which will represent a host file when active.
 124  * Upon VOP_NRESOLVE() an attempt to initialize its generic fields will be made
 125  * via a fstatat(2)/lstat(2) call.
 126  */
 127 struct dirfs_node {
 128         enum vtype              dn_type;        /* Node type. Same as vnode
 129                                                    type for simplicty */
 130
 131         int                     dn_state;       /* Node state flags */
 132
 133         RB_ENTRY(dirfs_node)    dn_rbentry;     /* Inode no. lookup */
 134
 135         int                     dn_refcnt;      /* Refs from children */
 136         int                     dn_fd;          /* File des. for open(2) */
 137
 138         struct dirfs_node *     dn_parent;      /* Pointer to parent node */
 139
 140         struct vnode *          dn_vnode;       /* Reference to its vnode on
 141                                                    the vkernel scope */
 142         char *                  dn_name;
 143         int                     dn_namelen;
 144
 145         struct lockf            dn_advlock;
 146         struct lock             dn_lock;
 147
 148         uint32_t                dn_st_dev;      /* Device number */
 149
 150         /* Generic attributes */
 151         ino_t                   dn_ino;
 152         long                    dn_blocksize;
 153         uid_t                   dn_uid;
 154         gid_t                   dn_gid;
 155         mode_t                  dn_mode;
 156         int                     dn_flags;
 157         nlink_t                 dn_links;
 158         int32_t                 dn_atime;
 159         int32_t                 dn_atimensec;
 160         int32_t                 dn_mtime;
 161         int32_t                 dn_mtimensec;
 162         int32_t                 dn_ctime;
 163         int32_t                 dn_ctimensec;
 164         unsigned long           dn_gen;
 165         off_t                   dn_size;
 166 };
 167 typedef struct dirfs_node *dirfs_node_t;
 168
 169 /*
 170  * In-memory dirfs mount structure. It corresponds to a mounted
 171  * dirfs filesystem.
 172  */
 173 struct dirfs_mount {
 174         RB_HEAD(, dn_rbentry) dm_inotree;
 175
 176         struct lock             dm_lock;
 177         struct lwkt_token       dm_token;
 178         dirfs_node_t            dm_root;        /* Root dirfs node */
 179         struct mount *          dm_mount;
 180         int                     dm_rdonly;
 181
 182         int                     dm_fd_used;     /* Opened file descriptors */
 183
 184         uid_t                   dm_uid; /* User running the vkernel */
 185         gid_t                   dm_gid;
 186
 187         char                    dm_path[MAXPATHLEN];
 188 };
 189 typedef struct dirfs_mount *dirfs_mount_t;
 190
 191 /*
 192  * VFS <-> DIRFS conversion macros
 193  */
 194 #define VFS_TO_DIRFS(mp)        ((dirfs_mount_t)((mp)->mnt_data))
 195 #define DIRFS_TO_VFS(dmp)       ((struct mount *)((dmp)->dm_mount))
 196 #define VP_TO_NODE(vp)          ((dirfs_node_t)((vp)->v_data))
 197 #define NODE_TO_VP(dnp)         ((dnp)->dn_vnode)
 198
 199 /* Misc stuff */
 200 extern int debuglvl;
 201 extern int dirfs_fd_limit;
 202 extern int dirfs_fd_used;
 203
 204 extern struct vop_ops dirfs_vnode_vops;
 205
 206 /*
 207  * Misc functions for node operations
 208  */
 209 static __inline void
 210 dirfs_node_ref(dirfs_node_t dnp)
 211 {
 212         lockmgr(&dnp->dn_lock, LK_EXCLUSIVE);
 213         atomic_add_int(&dnp->dn_refcnt, 1);
 214         lockmgr(&dnp->dn_lock, LK_RELEASE);
 215 }
 216
 217 static __inline int
 218 dirfs_node_unref(dirfs_node_t dnp)
 219 {
 220         int ret = 0;
 221
 222         /*
 223          * Returns non-zero on last unref.
 224          */
 225         KKASSERT(dnp->dn_refcnt > 0);
 226
 227         lockmgr(&dnp->dn_lock, LK_EXCLUSIVE);
 228         ret = (atomic_fetchadd_int(&dnp->dn_refcnt, -1) == 1);
 229         lockmgr(&dnp->dn_lock, LK_RELEASE);
 230
 231         return ret;
 232 }
 233
 234 static __inline void
 235 dirfs_node_setflags(dirfs_node_t dnp, int flags)
 236 {
 237         atomic_set_int(&dnp->dn_state, flags);
 238 }
 239
 240 static __inline void
 241 dirfs_node_clrflags(dirfs_node_t dnp, int flags)
 242 {
 243         atomic_clear_int(&dnp->dn_state, flags);
 244 }
 245
 246
 247 /*
 248  * Prototypes
 249  */
 250 dirfs_node_t dirfs_node_alloc(struct mount *);
 251 int dirfs_node_stat(int, const char *, dirfs_node_t);
 252 int dirfs_nodetype(struct stat *);
 253 void dirfs_node_setname(dirfs_node_t, const char *, int);
 254 char *dirfs_node_fullpath(dirfs_mount_t, const char *);
 255 int dirfs_node_free(dirfs_mount_t, dirfs_node_t);
 256 void dirfs_node_drop(dirfs_mount_t dmp, dirfs_node_t dnp);
 257 void dirfs_alloc_vp(struct mount *, struct vnode **, int, dirfs_node_t);
 258 void dirfs_free_vp(dirfs_node_t);
 259 int dirfs_alloc_file(dirfs_mount_t, dirfs_node_t *, dirfs_node_t,
 260     struct namecache *, struct vnode **, struct vattr *, int);
 261 dirfs_node_t dirfs_findfd(dirfs_mount_t dmp, dirfs_node_t cur,
 262                         char **pathto, char **pathfree);
 263 void dirfs_dropfd(dirfs_mount_t dmp, dirfs_node_t dnp1, char *pathfree);
 264 char *dirfs_node_absolute_path(dirfs_mount_t, dirfs_node_t, char **);
 265 char *dirfs_node_absolute_path_plus(dirfs_mount_t, dirfs_node_t,
 266                         char *, char **);
 267 int dirfs_open_helper(dirfs_mount_t, dirfs_node_t, int, char *);
 268 int dirfs_close_helper(dirfs_node_t);
 269 int dirfs_node_refcnt(dirfs_node_t);
 270 char *dirfs_flag2str(dirfs_node_t);
 271 int dirfs_node_getperms(dirfs_node_t, int *);
 272 int dirfs_node_chflags(dirfs_node_t, int, struct ucred *);
 273 int dirfs_node_chtimes(dirfs_node_t);
 274 int dirfs_node_chmod(dirfs_mount_t, dirfs_node_t, mode_t cur_mode);
 275 int dirfs_node_chown(dirfs_mount_t, dirfs_node_t,
 276                         uid_t cur_uid, uid_t cur_gid, mode_t cur_mode);
 277 int dirfs_node_chsize(dirfs_node_t, off_t);
 278 void debug(int, const char *, ...);
 279
 280 #endif /* _SYS_VFS_DIRFS_DIRFS_H_ */