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/thread.h>
  58 #include <sys/globaldata.h>
  59 #include <sys/lockf.h>
  60 #include <sys/buf.h>
  61 #include <sys/queue.h>
  62 #include <sys/limits.h>
  63 #include <sys/buf2.h>
  64 #include <sys/signal2.h>
  65 #include <sys/tree.h>
  66
  67 #include "hammer2_disk.h"
  68 #include "hammer2_mount.h"
  69 #include "hammer2_ioctl.h"
  70 #include "hammer2_ccms.h"
  71
  72 struct hammer2_chain;
  73 struct hammer2_inode;
  74 struct hammer2_mount;
  75 struct hammer2_pfsmount;
  76
  77 /*
  78  * The chain structure tracks blockref recursions all the way to
  79  * the root volume.  These consist of indirect blocks, inodes,
  80  * and eventually the volume header.
  81  *
  82  * The chain structure is embedded in the hammer2_mount, hammer2_inode,
  83  * and other system memory structures.  The chain structure typically
  84  * implements the reference count and busy flag for the larger structure.
  85  *
  86  * It is always possible to track a chain element all the way back to the
  87  * root by following the (parent) links.  (index) is a type-dependent index
  88  * in the parent indicating where in the parent the chain element resides.
  89  *
  90  * When a blockref is added or deleted the related chain element is marked
  91  * modified and all of its parents are marked SUBMODIFIED (the parent
  92  * recursion can stop once we hit a node that is already marked SUBMODIFIED).
  93  * A deleted chain element must remain intact until synchronized against
  94  * its parent.
  95  *
  96  * The blockref at (parent, index) is not adjusted until the modified chain
  97  * element is flushed and unmarked.  Until then the child's blockref may
  98  * not match the blockref at (parent, index).
  99  */
 100 RB_HEAD(hammer2_chain_tree, hammer2_chain);
 101 TAILQ_HEAD(flush_deferral_list, hammer2_chain);
 102
 103 struct hammer2_chain {
 104         ccms_cst_t      cst;                    /* attr or data cst */
 105         struct hammer2_blockref bref;
 106         struct hammer2_blockref bref_flush;     /* synchronized w/MOVED bit */
 107         struct hammer2_chain *parent;           /* return chain to root */
 108         struct hammer2_chain_tree rbhead;
 109         RB_ENTRY(hammer2_chain) rbnode;
 110         TAILQ_ENTRY(hammer2_chain) flush_node;  /* flush deferral list */
 111         union {
 112                 struct hammer2_inode *ip;
 113                 struct hammer2_indblock *np;
 114                 struct hammer2_data *dp;
 115                 void *mem;
 116         } u;
 117
 118         struct buf      *bp;            /* buffer cache (ro) */
 119         hammer2_media_data_t *data;     /* modified copy of data (rw) */
 120         u_int           bytes;          /* physical size of data */
 121         int             index;          /* index in parent */
 122         u_int           refs;
 123         u_int           flags;
 124 };
 125
 126 typedef struct hammer2_chain hammer2_chain_t;
 127
 128 int hammer2_chain_cmp(hammer2_chain_t *chain1, hammer2_chain_t *chain2);
 129 RB_PROTOTYPE(hammer2_chain_tree, hammer2_chain, rbnode, hammer2_chain_cmp);
 130
 131 /*
 132  * MOVED - This bit is set during the flush when the MODIFIED bit is cleared,
 133  *         indicating that the parent's blocktable must inherit a change to
 134  *         the bref (typically a block reallocation)
 135  *
 136  *         It must also be set in situations where a chain is not MODIFIED
 137  *         but whos bref has changed (typically due to fields other than
 138  *         a block reallocation).
 139  */
 140 #define HAMMER2_CHAIN_MODIFIED          0x00000001      /* active mods */
 141 #define HAMMER2_CHAIN_DIRTYEMBED        0x00000002      /* inode embedded */
 142 #define HAMMER2_CHAIN_DIRTYBP           0x00000004      /* dirty on unlock */
 143 #define HAMMER2_CHAIN_SUBMODIFIED       0x00000008      /* 1+ subs modified */
 144 #define HAMMER2_CHAIN_DELETED           0x00000010
 145 #define HAMMER2_CHAIN_INITIAL           0x00000020      /* initial create */
 146 #define HAMMER2_CHAIN_FLUSHED           0x00000040      /* flush on unlock */
 147 #define HAMMER2_CHAIN_MOVED             0x00000080      /* bref changed */
 148 #define HAMMER2_CHAIN_IOFLUSH           0x00000100      /* bawrite on put */
 149 #define HAMMER2_CHAIN_DEFERRED          0x00000200      /* on a deferral list*/
 150 #define HAMMER2_CHAIN_DESTROYED         0x00000400      /* destroying */
 151 #define HAMMER2_CHAIN_MODIFIED_AUX      0x00000800      /* hmp->vchain only */
 152 #define HAMMER2_CHAIN_MODIFY_TID        0x00001000      /* mod updates field */
 153 #define HAMMER2_CHAIN_MOUNTED           0x00002000      /* PFS is mounted */
 154
 155 /*
 156  * Flags passed to hammer2_chain_lookup() and hammer2_chain_next()
 157  */
 158 #define HAMMER2_LOOKUP_NOLOCK           0x00000001      /* ref only */
 159 #define HAMMER2_LOOKUP_NODATA           0x00000002      /* data left NULL */
 160 #define HAMMER2_LOOKUP_SHARED           0x00000100
 161
 162 /*
 163  * Flags passed to hammer2_chain_modify() and hammer2_chain_resize()
 164  *
 165  * NOTE: OPTDATA allows us to avoid instantiating buffers for INDIRECT
 166  *       blocks in the INITIAL-create state.
 167  *
 168  * NOTE: NO_MODIFY_TID tells the function to not set HAMMER2_CHAIN_MODIFY_TID
 169  *       when marking the chain modified (used when a sub-chain modification
 170  *       propagates upward).
 171  */
 172 #define HAMMER2_MODIFY_NOSUB            0x00000001      /* do not set SUBMOD */
 173 #define HAMMER2_MODIFY_OPTDATA          0x00000002      /* data can be NULL */
 174 #define HAMMER2_MODIFY_NO_MODIFY_TID    0x00000004
 175
 176 /*
 177  * Flags passed to hammer2_chain_lock()
 178  */
 179 #define HAMMER2_RESOLVE_NEVER           1
 180 #define HAMMER2_RESOLVE_MAYBE           2
 181 #define HAMMER2_RESOLVE_ALWAYS          3
 182 #define HAMMER2_RESOLVE_MASK            0x0F
 183
 184 #define HAMMER2_RESOLVE_SHARED          0x10
 185
 186 /*
 187  * Cluster different types of storage together for allocations
 188  */
 189 #define HAMMER2_FREECACHE_INODE         0
 190 #define HAMMER2_FREECACHE_INDIR         1
 191 #define HAMMER2_FREECACHE_DATA          2
 192 #define HAMMER2_FREECACHE_UNUSED3       3
 193 #define HAMMER2_FREECACHE_TYPES         4
 194
 195 /*
 196  * BMAP read-ahead maximum parameters
 197  */
 198 #define HAMMER2_BMAP_COUNT              16      /* max bmap read-ahead */
 199 #define HAMMER2_BMAP_BYTES              (HAMMER2_PBUFSIZE * HAMMER2_BMAP_COUNT)
 200
 201 /*
 202  * Misc
 203  */
 204 #define HAMMER2_FLUSH_DEPTH_LIMIT       40      /* stack recursion limit */
 205
 206 /*
 207  * HAMMER2 IN-MEMORY CACHE OF MEDIA STRUCTURES
 208  *
 209  * There is an in-memory representation of all on-media data structure.
 210  *
 211  * When accessed read-only the data will be mapped to the related buffer
 212  * cache buffer.
 213  *
 214  * When accessed read-write (marked modified) a kmalloc()'d copy of the
 215  * is created which can then be modified.  The copy is destroyed when a
 216  * filesystem block is allocated to replace it.
 217  *
 218  * Active inodes (those with vnodes attached) will maintain the kmalloc()'d
 219  * copy for both the read-only and the read-write case.  The combination of
 220  * (bp) and (data) determines whether (data) was allocated or not.
 221  *
 222  * The in-memory representation may remain cached (for example in order to
 223  * placemark clustering locks) even after the related data has been
 224  * detached.
 225  */
 226
 227 /*
 228  * A hammer2 inode.
 229  *
 230  * NOTE: The inode's attribute CST which is also used to lock the inode
 231  *       is embedded in the chain (chain.cst) and aliased w/ attr_cst.
 232  */
 233 struct hammer2_inode {
 234         struct hammer2_mount    *hmp;           /* Global mount */
 235         struct hammer2_pfsmount *pmp;           /* PFS mount */
 236         struct hammer2_inode    *pip;           /* parent inode */
 237         struct vnode            *vp;
 238         ccms_cst_t              topo_cst;       /* directory topology cst */
 239         hammer2_chain_t         chain;
 240         struct hammer2_inode_data ip_data;
 241         struct lockf            advlock;
 242         u_int                   depth;          /* directory depth */
 243         hammer2_off_t           delta_dcount;   /* adjust data_count */
 244         hammer2_off_t           delta_icount;   /* adjust inode_count */
 245 };
 246
 247 typedef struct hammer2_inode hammer2_inode_t;
 248
 249 /*
 250  * A hammer2 indirect block
 251  */
 252 struct hammer2_indblock {
 253         hammer2_chain_t         chain;
 254 };
 255
 256 typedef struct hammer2_indblock hammer2_indblock_t;
 257
 258 /*
 259  * A hammer2 data block
 260  */
 261 struct hammer2_data {
 262         hammer2_chain_t         chain;
 263 };
 264
 265 typedef struct hammer2_data hammer2_data_t;
 266
 267 struct hammer2_freecache {
 268         hammer2_off_t   bulk;
 269         hammer2_off_t   single;
 270 };
 271
 272 typedef struct hammer2_freecache hammer2_freecache_t;
 273
 274 /*
 275  * Global (per device) mount structure for device (aka vp->v_mount->hmp)
 276  */
 277 struct hammer2_mount {
 278         struct vnode    *devvp;         /* device vnode */
 279         int             ronly;          /* read-only mount */
 280         int             pmp_count;      /* PFS mounts backed by us */
 281         TAILQ_ENTRY(hammer2_mount) mntentry; /* hammer2_mntlist */
 282
 283         struct malloc_type *minode;
 284         int             ninodes;
 285         int             maxinodes;
 286
 287         struct malloc_type *mchain;
 288         int             nipstacks;
 289         int             maxipstacks;
 290         hammer2_chain_t vchain;         /* anchor chain */
 291         hammer2_chain_t *schain;        /* super-root */
 292         struct lock     alloclk;        /* lockmgr lock */
 293         struct lock     voldatalk;      /* lockmgr lock */
 294
 295         hammer2_volume_data_t voldata;
 296         hammer2_freecache_t freecache[HAMMER2_FREECACHE_TYPES]
 297                                      [HAMMER2_MAX_RADIX+1];
 298 };
 299
 300 typedef struct hammer2_mount hammer2_mount_t;
 301
 302 /*
 303  * Per-PFS mount structure for device (aka vp->v_mount)
 304  */
 305 struct hammer2_pfsmount {
 306         struct mount            *mp;            /* kernel mount */
 307         struct hammer2_mount    *hmp;           /* device global mount */
 308         hammer2_chain_t         *rchain;        /* PFS root chain */
 309         hammer2_inode_t         *iroot;         /* PFS root inode */
 310         ccms_domain_t           ccms_dom;
 311         struct netexport        export;         /* nfs export */
 312         int                     ronly;          /* read-only mount */
 313         struct file             *msg_fp;        /* cluster pipe->userland */
 314         thread_t                msgrd_td;       /* cluster thread */
 315         thread_t                msgwr_td;       /* cluster thread */
 316         int                     msg_ctl;        /* wakeup flags */
 317 };
 318
 319 typedef struct hammer2_pfsmount hammer2_pfsmount_t;
 320
 321 #define HAMMER2_CLUSTERCTL_KILL 0x0001
 322
 323 #if defined(_KERNEL)
 324
 325 MALLOC_DECLARE(M_HAMMER2);
 326
 327 #define VTOI(vp)        ((hammer2_inode_t *)(vp)->v_data)
 328 #define ITOV(ip)        ((ip)->vp)
 329
 330 static __inline
 331 hammer2_pfsmount_t *
 332 MPTOPMP(struct mount *mp)
 333 {
 334         return ((hammer2_pfsmount_t *)mp->mnt_data);
 335 }
 336
 337 static __inline
 338 hammer2_mount_t *
 339 MPTOHMP(struct mount *mp)
 340 {
 341         return (((hammer2_pfsmount_t *)mp->mnt_data)->hmp);
 342 }
 343
 344 extern struct vop_ops hammer2_vnode_vops;
 345 extern struct vop_ops hammer2_spec_vops;
 346 extern struct vop_ops hammer2_fifo_vops;
 347
 348 extern int hammer2_debug;
 349 extern int hammer2_cluster_enable;
 350 extern int hammer2_hardlink_enable;
 351 extern long hammer2_iod_file_read;
 352 extern long hammer2_iod_meta_read;
 353 extern long hammer2_iod_indr_read;
 354 extern long hammer2_iod_file_write;
 355 extern long hammer2_iod_meta_write;
 356 extern long hammer2_iod_indr_write;
 357 extern long hammer2_iod_volu_write;
 358 extern long hammer2_ioa_file_read;
 359 extern long hammer2_ioa_meta_read;
 360 extern long hammer2_ioa_indr_read;
 361 extern long hammer2_ioa_file_write;
 362 extern long hammer2_ioa_meta_write;
 363 extern long hammer2_ioa_indr_write;
 364 extern long hammer2_ioa_volu_write;
 365
 366 /*
 367  * hammer2_subr.c
 368  */
 369 void hammer2_inode_lock_ex(hammer2_inode_t *ip);
 370 void hammer2_inode_unlock_ex(hammer2_inode_t *ip);
 371 void hammer2_inode_lock_sh(hammer2_inode_t *ip);
 372 void hammer2_inode_unlock_sh(hammer2_inode_t *ip);
 373 void hammer2_inode_busy(hammer2_inode_t *ip);
 374 void hammer2_inode_unbusy(hammer2_inode_t *ip);
 375 void hammer2_voldata_lock(hammer2_mount_t *hmp);
 376 void hammer2_voldata_unlock(hammer2_mount_t *hmp);
 377
 378 void hammer2_mount_exlock(hammer2_mount_t *hmp);
 379 void hammer2_mount_shlock(hammer2_mount_t *hmp);
 380 void hammer2_mount_unlock(hammer2_mount_t *hmp);
 381
 382 int hammer2_get_dtype(hammer2_inode_t *ip);
 383 int hammer2_get_vtype(hammer2_inode_t *ip);
 384 u_int8_t hammer2_get_obj_type(enum vtype vtype);
 385 void hammer2_time_to_timespec(u_int64_t xtime, struct timespec *ts);
 386 u_int64_t hammer2_timespec_to_time(struct timespec *ts);
 387 u_int32_t hammer2_to_unix_xid(uuid_t *uuid);
 388 void hammer2_guid_to_uuid(uuid_t *uuid, u_int32_t guid);
 389
 390 hammer2_key_t hammer2_dirhash(const unsigned char *name, size_t len);
 391 int hammer2_bytes_to_radix(size_t bytes);
 392
 393 int hammer2_calc_logical(hammer2_inode_t *ip, hammer2_off_t uoff,
 394                          hammer2_key_t *lbasep, hammer2_key_t *leofp);
 395 void hammer2_update_time(uint64_t *timep);
 396
 397 /*
 398  * hammer2_inode.c
 399  */
 400 struct vnode *hammer2_igetv(hammer2_inode_t *ip, int *errorp);
 401
 402 void hammer2_inode_lock_nlinks(hammer2_inode_t *ip);
 403 void hammer2_inode_unlock_nlinks(hammer2_inode_t *ip);
 404 hammer2_inode_t *hammer2_inode_alloc(hammer2_pfsmount_t *pmp, void *data);
 405 void hammer2_inode_free(hammer2_inode_t *ip);
 406 void hammer2_inode_ref(hammer2_inode_t *ip);
 407 void hammer2_inode_drop(hammer2_inode_t *ip);
 408 int hammer2_inode_calc_alloc(hammer2_key_t filesize);
 409
 410 int hammer2_inode_create(hammer2_inode_t *dip,
 411                         struct vattr *vap, struct ucred *cred,
 412                         const uint8_t *name, size_t name_len,
 413                         hammer2_inode_t **nipp);
 414
 415 int hammer2_inode_duplicate(hammer2_inode_t *dip,
 416                         hammer2_inode_t *oip, hammer2_inode_t **nipp,
 417                         const uint8_t *name, size_t name_len);
 418 int hammer2_inode_connect(hammer2_inode_t *dip, hammer2_inode_t *oip,
 419                         const uint8_t *name, size_t name_len);
 420
 421 int hammer2_unlink_file(hammer2_inode_t *dip,
 422                         const uint8_t *name, size_t name_len,
 423                         int isdir, hammer2_inode_t *retain_ip);
 424 int hammer2_hardlink_consolidate(hammer2_inode_t **ipp, hammer2_inode_t *tdip);
 425 int hammer2_hardlink_deconsolidate(hammer2_inode_t *dip,
 426                         hammer2_chain_t **chainp, hammer2_inode_t **ipp);
 427 int hammer2_hardlink_find(hammer2_inode_t *dip, hammer2_chain_t **chainp,
 428                         hammer2_inode_t **ipp);
 429
 430 /*
 431  * hammer2_chain.c
 432  */
 433 void hammer2_modify_volume(hammer2_mount_t *hmp);
 434 hammer2_chain_t *hammer2_chain_alloc(hammer2_mount_t *hmp,
 435                                 hammer2_blockref_t *bref);
 436 void hammer2_chain_free(hammer2_mount_t *hmp, hammer2_chain_t *chain);
 437 void hammer2_chain_ref(hammer2_mount_t *hmp, hammer2_chain_t *chain);
 438 void hammer2_chain_drop(hammer2_mount_t *hmp, hammer2_chain_t *chain);
 439 int hammer2_chain_lock(hammer2_mount_t *hmp, hammer2_chain_t *chain, int how);
 440 void hammer2_chain_moved(hammer2_mount_t *hmp, hammer2_chain_t *chain);
 441 void hammer2_chain_modify(hammer2_mount_t *hmp, hammer2_chain_t *chain,
 442                                 int flags);
 443 void hammer2_chain_resize(hammer2_inode_t *ip, hammer2_chain_t *chain,
 444                                 int nradix, int flags);
 445 void hammer2_chain_unlock(hammer2_mount_t *hmp, hammer2_chain_t *chain);
 446 hammer2_chain_t *hammer2_chain_find(hammer2_mount_t *hmp,
 447                                 hammer2_chain_t *parent, int index);
 448 hammer2_chain_t *hammer2_chain_get(hammer2_mount_t *hmp,
 449                                 hammer2_chain_t *parent,
 450                                 int index, int flags);
 451 hammer2_chain_t *hammer2_chain_lookup(hammer2_mount_t *hmp,
 452                                 hammer2_chain_t **parentp,
 453                                 hammer2_key_t key_beg, hammer2_key_t key_end,
 454                                 int flags);
 455 hammer2_chain_t *hammer2_chain_next(hammer2_mount_t *hmp,
 456                                 hammer2_chain_t **parentp,
 457                                 hammer2_chain_t *chain,
 458                                 hammer2_key_t key_beg, hammer2_key_t key_end,
 459                                 int flags);
 460 hammer2_chain_t *hammer2_chain_create(hammer2_mount_t *hmp,
 461                                 hammer2_chain_t *parent,
 462                                 hammer2_chain_t *chain,
 463                                 hammer2_key_t key, int keybits,
 464                                 int type, size_t bytes);
 465 void hammer2_chain_delete(hammer2_mount_t *hmp, hammer2_chain_t *parent,
 466                                 hammer2_chain_t *chain, int retain);
 467 void hammer2_chain_flush(hammer2_mount_t *hmp, hammer2_chain_t *chain,
 468                                 hammer2_tid_t modify_tid);
 469 void hammer2_chain_commit(hammer2_mount_t *hmp, hammer2_chain_t *chain);
 470
 471 /*
 472  * hammer2_ioctl.c
 473  */
 474 int hammer2_ioctl(hammer2_inode_t *ip, u_long com, void *data,
 475                                 int fflag, struct ucred *cred);
 476
 477 /*
 478  * hammer2_freemap.c
 479  */
 480 hammer2_off_t hammer2_freemap_alloc(hammer2_mount_t *hmp,
 481                                 int type, size_t bytes);
 482 void hammer2_freemap_free(hammer2_mount_t *hmp, hammer2_off_t data_off,
 483                                 int type);
 484
 485 #endif /* !_KERNEL */
 486 #endif /* !_VFS_HAMMER2_HAMMER2_H_ */