sys/vfs/hammer2/hammer2.h

   1 /*
   2  * Copyright (c) 2011-2012 The DragonFly Project.  All rights reserved.
   3  *
   4  * This code is derived from software contributed to The DragonFly Project
   5  * by Matthew Dillon <dillon@dragonflybsd.org>
   6  * by Venkatesh Srinivas <vsrinivas@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  * This header file contains structures used internally by the HAMMER2
  38  * implementation.  See hammer2_disk.h for on-disk structures.
  39  */
  40
  41 #ifndef _VFS_HAMMER2_HAMMER2_H_
  42 #define _VFS_HAMMER2_HAMMER2_H_
  43
  44 #include <sys/param.h>
  45 #include <sys/types.h>
  46 #include <sys/kernel.h>
  47 #include <sys/conf.h>
  48 #include <sys/systm.h>
  49 #include <sys/tree.h>
  50 #include <sys/malloc.h>
  51 #include <sys/mount.h>
  52 #include <sys/vnode.h>
  53 #include <sys/proc.h>
  54 #include <sys/mountctl.h>
  55 #include <sys/priv.h>
  56 #include <sys/stat.h>
  57 #include <sys/globaldata.h>
  58 #include <sys/lockf.h>
  59 #include <sys/buf.h>
  60 #include <sys/queue.h>
  61 #include <sys/limits.h>
  62 #include <sys/buf2.h>
  63 #include <sys/signal2.h>
  64 #include <sys/tree.h>
  65
  66 #include "hammer2_disk.h"
  67 #include "hammer2_mount.h"
  68
  69 struct hammer2_chain;
  70 struct hammer2_inode;
  71 struct hammer2_mount;
  72
  73 /*
  74  * The chain structure tracks blockref recursions all the way to
  75  * the root volume.  These consist of indirect blocks, inodes,
  76  * and eventually the volume header.
  77  *
  78  * The chain structure is embedded in the hammer2_mount, hammer2_inode,
  79  * and other system memory structures.  The chain structure typically
  80  * implements the reference count and busy flag for the larger structure.
  81  *
  82  * It is always possible to track a chain element all the way back to the
  83  * root by following the (parent) links.  (index) is a type-dependent index
  84  * in the parent indicating where in the parent the chain element resides.
  85  *
  86  * When a blockref is added or deleted the related chain element is marked
  87  * modified and all of its parents are marked SUBMODIFIED (the parent
  88  * recursion can stop once we hit a node that is already marked SUBMODIFIED).
  89  * A deleted chain element must remain intact until synchronized against
  90  * its parent.
  91  *
  92  * The blockref at (parent, index) is not adjusted until the modified chain
  93  * element is flushed and unmarked.  Until then the child's blockref may
  94  * not match the blockref at (parent, index).
  95  */
  96 SPLAY_HEAD(hammer2_chain_splay, hammer2_chain);
  97
  98 struct hammer2_chain {
  99         struct hammer2_blockref bref;
 100         struct hammer2_chain *parent;   /* return chain to root */
 101         struct hammer2_chain_splay shead;
 102         SPLAY_ENTRY(hammer2_chain) snode;
 103         union {
 104                 struct hammer2_inode *ip;
 105                 struct hammer2_indblock *np;
 106                 struct hammer2_data *dp;
 107                 void *mem;
 108         } u;
 109
 110         struct buf      *bp;            /* buffer cache (ro) */
 111         hammer2_media_data_t *data;     /* modified copy of data (rw) */
 112
 113         struct lock     lk;             /* lockmgr lock */
 114         int             index;          /* index in parent */
 115         u_int           refs;
 116         u_int           busy;           /* soft-busy */
 117         u_int           flags;
 118 };
 119
 120 typedef struct hammer2_chain hammer2_chain_t;
 121
 122 int hammer2_chain_cmp(hammer2_chain_t *chain1, hammer2_chain_t *chain2);
 123 SPLAY_PROTOTYPE(hammer2_chain_splay, hammer2_chain, snode, hammer2_chain_cmp);
 124
 125 #define HAMMER2_CHAIN_MODIFIED          0x00000001      /* this elm modified */
 126 #define HAMMER2_CHAIN_COMMITTING        0x00000002      /* mods committing */
 127 #define HAMMER2_CHAIN_SUBMODIFIED       0x00000004      /* 1+ subs modified */
 128 #define HAMMER2_CHAIN_SUBCOMMITTING     0x00000008      /* 1+ subs committing */
 129 #define HAMMER2_CHAIN_DELETED           0x00000010
 130 #define HAMMER2_CHAIN_INITIAL           0x00000020      /* initial write */
 131
 132 /*
 133  * HAMMER2 IN-MEMORY CACHE OF MEDIA STRUCTURES
 134  *
 135  * There is an in-memory representation of all on-media data structure.
 136  *
 137  * When accessed read-only the data will be mapped to the related buffer
 138  * cache buffer.
 139  *
 140  * When accessed read-write (marked modified) a kmalloc()'d copy of the
 141  * is created which can then be modified.  The copy is destroyed when a
 142  * filesystem block is allocated to replace it.
 143  *
 144  * Active inodes (those with vnodes attached) will maintain the kmalloc()'d
 145  * copy for both the read-only and the read-write case.  The combination of
 146  * (bp) and (data) determines whether (data) was allocated or not.
 147  *
 148  * The in-memory representation may remain cached (for example in order to
 149  * placemark clustering locks) even after the related data has been
 150  * detached.
 151  */
 152
 153 /*
 154  * A hammer2 inode.
 155  */
 156 struct hammer2_inode {
 157         struct hammer2_mount    *hmp;
 158         struct hammer2_inode    *pip;           /* parent inode */
 159         struct vnode            *vp;
 160         hammer2_chain_t         chain;
 161         struct hammer2_inode_data ip_data;
 162 };
 163
 164 typedef struct hammer2_inode hammer2_inode_t;
 165
 166 /*
 167  * A hammer2 indirect block
 168  */
 169 struct hammer2_indblock {
 170         hammer2_chain_t         chain;
 171 };
 172
 173 typedef struct hammer2_indblock hammer2_indblock_t;
 174
 175 #define np_data         chain.data->npdata
 176
 177 /*
 178  * A hammer2 data block
 179  */
 180 struct hammer2_data {
 181         hammer2_chain_t         chain;
 182 };
 183
 184 #define dp_data         chain.data->buf
 185
 186 typedef struct hammer2_data hammer2_data_t;
 187
 188 /*
 189  * Governing mount structure for filesystem (aka vp->v_mount)
 190  */
 191 struct hammer2_mount {
 192         struct mount    *mp;            /* kernel mount */
 193         struct vnode    *devvp;         /* device vnode */
 194         struct netexport export;        /* nfs export */
 195         int             ronly;          /* read-only mount */
 196
 197         struct malloc_type *minode;
 198         int             ninodes;
 199         int             maxinodes;
 200
 201         struct malloc_type *mchain;
 202         int             nipstacks;
 203         int             maxipstacks;
 204         hammer2_chain_t vchain;         /* anchor chain */
 205         hammer2_chain_t *schain;        /* super-root */
 206         hammer2_chain_t *rchain;        /* label-root */
 207         struct hammer2_inode *iroot;
 208
 209         hammer2_volume_data_t voldata;
 210         hammer2_off_t   freecache[HAMMER2_MAX_RADIX];
 211 };
 212
 213 typedef struct hammer2_mount hammer2_mount_t;
 214
 215 #if defined(_KERNEL)
 216
 217 MALLOC_DECLARE(M_HAMMER2);
 218
 219 static __inline
 220 struct mount *
 221 H2TOMP(struct hammer2_mount *hmp)
 222 {
 223         return (struct mount *) hmp->mp;
 224 }
 225
 226 #define VTOI(vp)        ((hammer2_inode_t *)(vp)->v_data)
 227 #define ITOV(ip)        ((ip)->vp)
 228
 229 static __inline
 230 struct hammer2_mount *
 231 MPTOH2(struct mount *mp)
 232 {
 233         return (hammer2_mount_t *) mp->mnt_data;
 234 }
 235
 236 extern struct vop_ops hammer2_vnode_vops;
 237 extern struct vop_ops hammer2_spec_vops;
 238 extern struct vop_ops hammer2_fifo_vops;
 239
 240 /*
 241  * hammer2_subr.c
 242  */
 243 void hammer2_inode_lock_ex(hammer2_inode_t *ip);
 244 void hammer2_inode_unlock_ex(hammer2_inode_t *ip);
 245 void hammer2_inode_lock_sh(hammer2_inode_t *ip);
 246 void hammer2_inode_unlock_sh(hammer2_inode_t *ip);
 247 void hammer2_inode_busy(hammer2_inode_t *ip);
 248 void hammer2_inode_unbusy(hammer2_inode_t *ip);
 249
 250 void hammer2_mount_exlock(hammer2_mount_t *hmp);
 251 void hammer2_mount_shlock(hammer2_mount_t *hmp);
 252 void hammer2_mount_unlock(hammer2_mount_t *hmp);
 253
 254 int hammer2_get_dtype(hammer2_inode_t *ip);
 255 int hammer2_get_vtype(hammer2_inode_t *ip);
 256 u_int8_t hammer2_get_obj_type(enum vtype vtype);
 257 void hammer2_time_to_timespec(u_int64_t xtime, struct timespec *ts);
 258 u_int32_t hammer2_to_unix_xid(uuid_t *uuid);
 259
 260 hammer2_key_t hammer2_dirhash(const unsigned char *name, size_t len);
 261
 262 /*
 263  * hammer2_inode.c
 264  */
 265 struct vnode *hammer2_igetv(hammer2_inode_t *ip, int *errorp);
 266 hammer2_inode_t *hammer2_inode_alloc(hammer2_mount_t *hmp, void *data);
 267 void hammer2_inode_free(hammer2_inode_t *ip);
 268 void hammer2_inode_ref(hammer2_inode_t *ip);
 269 void hammer2_inode_drop(hammer2_inode_t *ip);
 270 int hammer2_create_inode(hammer2_mount_t *hmp,
 271                          struct vattr *vap, struct ucred *cred,
 272                          hammer2_inode_t *dip,
 273                          const uint8_t *name, size_t name_len,
 274                          hammer2_inode_t **nipp);
 275
 276 /*
 277  * hammer2_chain.c
 278  */
 279 hammer2_chain_t *hammer2_chain_alloc(hammer2_mount_t *hmp,
 280                                 hammer2_blockref_t *bref);
 281 void hammer2_chain_free(hammer2_mount_t *hmp, hammer2_chain_t *chain);
 282 void hammer2_chain_ref(hammer2_mount_t *hmp, hammer2_chain_t *chain);
 283 void hammer2_chain_drop(hammer2_mount_t *hmp, hammer2_chain_t *chain);
 284 int hammer2_chain_lock(hammer2_mount_t *hmp, hammer2_chain_t *chain);
 285 void hammer2_chain_modify(hammer2_mount_t *hmp, hammer2_chain_t *chain);
 286 void hammer2_chain_unlock(hammer2_mount_t *hmp, hammer2_chain_t *chain);
 287 hammer2_chain_t *hammer2_chain_find(hammer2_mount_t *hmp,
 288                                 hammer2_chain_t *parent, int index);
 289 hammer2_chain_t *hammer2_chain_get(hammer2_mount_t *hmp,
 290                                 hammer2_chain_t *parent, int index);
 291 void hammer2_chain_put(hammer2_mount_t *hmp, hammer2_chain_t *chain);
 292 hammer2_chain_t *hammer2_chain_lookup(hammer2_mount_t *hmp,
 293                                 hammer2_chain_t **parentp,
 294                                 hammer2_key_t key_beg, hammer2_key_t key_end);
 295 hammer2_chain_t *hammer2_chain_next(hammer2_mount_t *hmp,
 296                                 hammer2_chain_t **parentp,
 297                                 hammer2_chain_t *chain,
 298                                 hammer2_key_t key_beg, hammer2_key_t key_end);
 299 hammer2_chain_t *hammer2_chain_create(hammer2_mount_t *hmp,
 300                                 hammer2_chain_t *parent,
 301                                 hammer2_key_t key, int keybits,
 302                                 int type, size_t bytes);
 303 void hammer2_chain_delete(hammer2_mount_t *hmp, hammer2_chain_t **parentp,
 304                                 hammer2_chain_t *chain);
 305 void hammer2_chain_flush(hammer2_mount_t *hmp, hammer2_chain_t *chain,
 306                                 hammer2_blockref_t *parent_bref);
 307 void hammer2_chain_commit(hammer2_mount_t *hmp, hammer2_chain_t *chain);
 308
 309 /*
 310  * hammer2_freemap.c
 311  */
 312 hammer2_off_t hammer2_freemap_alloc(hammer2_mount_t *hmp, size_t bytes);
 313
 314 #endif /* !_KERNEL */
 315 #endif /* !_VFS_HAMMER2_HAMMER2_H_ */