module/zfs/include/sys/space_map.h

   1 /*
   2  * CDDL HEADER START
   3  *
   4  * The contents of this file are subject to the terms of the
   5  * Common Development and Distribution License (the "License").
   6  * You may not use this file except in compliance with the License.
   7  *
   8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
   9  * or http://www.opensolaris.org/os/licensing.
  10  * See the License for the specific language governing permissions
  11  * and limitations under the License.
  12  *
  13  * When distributing Covered Code, include this CDDL HEADER in each
  14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  15  * If applicable, add the following below this CDDL HEADER, with the
  16  * fields enclosed by brackets "[]" replaced with your own identifying
  17  * information: Portions Copyright [yyyy] [name of copyright owner]
  18  *
  19  * CDDL HEADER END
  20  */
  21 /*
  22  * Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
  23  * Use is subject to license terms.
  24  */
  25
  26 #ifndef _SYS_SPACE_MAP_H
  27 #define _SYS_SPACE_MAP_H
  28
  29 #include <sys/avl.h>
  30 #include <sys/dmu.h>
  31
  32 #ifdef  __cplusplus
  33 extern "C" {
  34 #endif
  35
  36 typedef struct space_map_ops space_map_ops_t;
  37
  38 typedef struct space_map {
  39         avl_tree_t      sm_root;        /* AVL tree of map segments */
  40         uint64_t        sm_space;       /* sum of all segments in the map */
  41         uint64_t        sm_start;       /* start of map */
  42         uint64_t        sm_size;        /* size of map */
  43         uint8_t         sm_shift;       /* unit shift */
  44         uint8_t         sm_pad[3];      /* unused */
  45         uint8_t         sm_loaded;      /* map loaded? */
  46         uint8_t         sm_loading;     /* map loading? */
  47         kcondvar_t      sm_load_cv;     /* map load completion */
  48         space_map_ops_t *sm_ops;        /* space map block picker ops vector */
  49         void            *sm_ppd;        /* picker-private data */
  50         kmutex_t        *sm_lock;       /* pointer to lock that protects map */
  51 } space_map_t;
  52
  53 typedef struct space_seg {
  54         avl_node_t      ss_node;        /* AVL node */
  55         uint64_t        ss_start;       /* starting offset of this segment */
  56         uint64_t        ss_end;         /* ending offset (non-inclusive) */
  57 } space_seg_t;
  58
  59 typedef struct space_ref {
  60         avl_node_t      sr_node;        /* AVL node */
  61         uint64_t        sr_offset;      /* offset (start or end) */
  62         int64_t         sr_refcnt;      /* associated reference count */
  63 } space_ref_t;
  64
  65 typedef struct space_map_obj {
  66         uint64_t        smo_object;     /* on-disk space map object */
  67         uint64_t        smo_objsize;    /* size of the object */
  68         uint64_t        smo_alloc;      /* space allocated from the map */
  69 } space_map_obj_t;
  70
  71 struct space_map_ops {
  72         void    (*smop_load)(space_map_t *sm);
  73         void    (*smop_unload)(space_map_t *sm);
  74         uint64_t (*smop_alloc)(space_map_t *sm, uint64_t size);
  75         void    (*smop_claim)(space_map_t *sm, uint64_t start, uint64_t size);
  76         void    (*smop_free)(space_map_t *sm, uint64_t start, uint64_t size);
  77 };
  78
  79 /*
  80  * debug entry
  81  *
  82  *    1      3         10                     50
  83  *  ,---+--------+------------+---------------------------------.
  84  *  | 1 | action |  syncpass  |        txg (lower bits)         |
  85  *  `---+--------+------------+---------------------------------'
  86  *   63  62    60 59        50 49                               0
  87  *
  88  *
  89  *
  90  * non-debug entry
  91  *
  92  *    1               47                   1           15
  93  *  ,-----------------------------------------------------------.
  94  *  | 0 |   offset (sm_shift units)    | type |       run       |
  95  *  `-----------------------------------------------------------'
  96  *   63  62                          17   16   15               0
  97  */
  98
  99 /* All this stuff takes and returns bytes */
 100 #define SM_RUN_DECODE(x)        (BF64_DECODE(x, 0, 15) + 1)
 101 #define SM_RUN_ENCODE(x)        BF64_ENCODE((x) - 1, 0, 15)
 102 #define SM_TYPE_DECODE(x)       BF64_DECODE(x, 15, 1)
 103 #define SM_TYPE_ENCODE(x)       BF64_ENCODE(x, 15, 1)
 104 #define SM_OFFSET_DECODE(x)     BF64_DECODE(x, 16, 47)
 105 #define SM_OFFSET_ENCODE(x)     BF64_ENCODE(x, 16, 47)
 106 #define SM_DEBUG_DECODE(x)      BF64_DECODE(x, 63, 1)
 107 #define SM_DEBUG_ENCODE(x)      BF64_ENCODE(x, 63, 1)
 108
 109 #define SM_DEBUG_ACTION_DECODE(x)       BF64_DECODE(x, 60, 3)
 110 #define SM_DEBUG_ACTION_ENCODE(x)       BF64_ENCODE(x, 60, 3)
 111
 112 #define SM_DEBUG_SYNCPASS_DECODE(x)     BF64_DECODE(x, 50, 10)
 113 #define SM_DEBUG_SYNCPASS_ENCODE(x)     BF64_ENCODE(x, 50, 10)
 114
 115 #define SM_DEBUG_TXG_DECODE(x)          BF64_DECODE(x, 0, 50)
 116 #define SM_DEBUG_TXG_ENCODE(x)          BF64_ENCODE(x, 0, 50)
 117
 118 #define SM_RUN_MAX                      SM_RUN_DECODE(~0ULL)
 119
 120 #define SM_ALLOC        0x0
 121 #define SM_FREE         0x1
 122
 123 /*
 124  * The data for a given space map can be kept on blocks of any size.
 125  * Larger blocks entail fewer i/o operations, but they also cause the
 126  * DMU to keep more data in-core, and also to waste more i/o bandwidth
 127  * when only a few blocks have changed since the last transaction group.
 128  * This could use a lot more research, but for now, set the freelist
 129  * block size to 4k (2^12).
 130  */
 131 #define SPACE_MAP_BLOCKSHIFT    12
 132
 133 typedef void space_map_func_t(space_map_t *sm, uint64_t start, uint64_t size);
 134
 135 extern void space_map_create(space_map_t *sm, uint64_t start, uint64_t size,
 136     uint8_t shift, kmutex_t *lp);
 137 extern void space_map_destroy(space_map_t *sm);
 138 extern void space_map_add(space_map_t *sm, uint64_t start, uint64_t size);
 139 extern void space_map_remove(space_map_t *sm, uint64_t start, uint64_t size);
 140 extern boolean_t space_map_contains(space_map_t *sm,
 141     uint64_t start, uint64_t size);
 142 extern void space_map_vacate(space_map_t *sm,
 143     space_map_func_t *func, space_map_t *mdest);
 144 extern void space_map_walk(space_map_t *sm,
 145     space_map_func_t *func, space_map_t *mdest);
 146
 147 extern void space_map_load_wait(space_map_t *sm);
 148 extern int space_map_load(space_map_t *sm, space_map_ops_t *ops,
 149     uint8_t maptype, space_map_obj_t *smo, objset_t *os);
 150 extern void space_map_unload(space_map_t *sm);
 151
 152 extern uint64_t space_map_alloc(space_map_t *sm, uint64_t size);
 153 extern void space_map_claim(space_map_t *sm, uint64_t start, uint64_t size);
 154 extern void space_map_free(space_map_t *sm, uint64_t start, uint64_t size);
 155
 156 extern void space_map_sync(space_map_t *sm, uint8_t maptype,
 157     space_map_obj_t *smo, objset_t *os, dmu_tx_t *tx);
 158 extern void space_map_truncate(space_map_obj_t *smo,
 159     objset_t *os, dmu_tx_t *tx);
 160
 161 extern void space_map_ref_create(avl_tree_t *t);
 162 extern void space_map_ref_destroy(avl_tree_t *t);
 163 extern void space_map_ref_add_seg(avl_tree_t *t,
 164     uint64_t start, uint64_t end, int64_t refcnt);
 165 extern void space_map_ref_add_map(avl_tree_t *t,
 166     space_map_t *sm, int64_t refcnt);
 167 extern void space_map_ref_generate_map(avl_tree_t *t,
 168     space_map_t *sm, int64_t minref);
 169
 170 #ifdef  __cplusplus
 171 }
 172 #endif
 173
 174 #endif  /* _SYS_SPACE_MAP_H */