sys/dev/disk/dm/dm.h

   1 /*        $NetBSD: dm.h,v 1.17 2009/12/29 23:37:48 haad Exp $      */
   2
   3 /*
   4  * Copyright (c) 2008 The NetBSD Foundation, Inc.
   5  * All rights reserved.
   6  *
   7  * This code is derived from software contributed to The NetBSD Foundation
   8  * by Adam Hamsik.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  29  * POSSIBILITY OF SUCH DAMAGE.
  30  */
  31
  32 #ifndef _DM_DEV_H_
  33 #define _DM_DEV_H_
  34
  35 #ifdef _KERNEL
  36
  37 #include <sys/errno.h>
  38 #include <sys/systm.h>
  39 #include <sys/kernel.h>
  40
  41 #include <cpu/inttypes.h>
  42 #include <cpu/atomic.h>
  43 #include <sys/condvar.h>
  44 #include <sys/lock.h>
  45 #include <sys/queue.h>
  46
  47 #include <sys/buf.h>
  48 #include <sys/device.h>
  49 #include <sys/devicestat.h>
  50 #include <sys/diskslice.h>
  51 #include <sys/disklabel.h>
  52 #include <sys/vfscache.h>
  53
  54 #include <libprop/proplib.h>
  55
  56 #define DM_VERSION_MAJOR        4
  57 #define DM_VERSION_MINOR        16
  58 #define DM_VERSION_PATCHLEVEL   0
  59
  60 #define DM_MAX_TYPE_NAME 16
  61 #define DM_MAX_DEV_NAME 32
  62 #define DM_MAX_PARAMS_SIZE 1024
  63
  64 #define DM_NAME_LEN 128
  65 #define DM_UUID_LEN 129
  66
  67 #define DM_TABLE_ACTIVE 0
  68 #define DM_TABLE_INACTIVE 1
  69
  70 typedef struct dm_mapping {
  71         union {
  72                 struct dm_pdev *pdev;
  73         } data;
  74         TAILQ_ENTRY(dm_mapping) next;
  75 } dm_mapping_t;
  76
  77 /*
  78  * A device mapper table is a list of physical ranges plus the mapping target
  79  * applied to them.
  80  */
  81 typedef struct dm_table_entry {
  82         struct dm_dev *dev;             /* backlink */
  83         uint64_t start;
  84         uint64_t length;
  85
  86         struct dm_target *target;      /* Link to table target. */
  87         void *target_config;           /* Target specific data. */
  88         TAILQ_ENTRY(dm_table_entry) next;
  89
  90         TAILQ_HEAD(, dm_mapping) pdev_maps;
  91 } dm_table_entry_t;
  92
  93 TAILQ_HEAD(dm_table, dm_table_entry);
  94
  95 typedef struct dm_table dm_table_t;
  96
  97 typedef struct dm_table_head {
  98         /* Current active table is selected with this. */
  99         int cur_active_table;
 100         struct dm_table tables[2];
 101
 102         struct lock   table_mtx;
 103
 104         int      io_cnt;
 105 } dm_table_head_t;
 106
 107 /*
 108  * This structure is used to store opened vnodes for disk with name.
 109  * I need this because devices can be opened only once, but I can
 110  * have more then one device on one partition.
 111  */
 112 typedef struct dm_pdev {
 113         char name[DM_MAX_DEV_NAME];
 114         char udev_name[DM_MAX_DEV_NAME];
 115         udev_t udev;
 116         struct partinfo pdev_pinfo; /* partinfo of the underlying device */
 117
 118         struct vnode *pdev_vnode;
 119         int ref_cnt; /* reference counter for users ofthis pdev */
 120
 121         TAILQ_ENTRY(dm_pdev) next_pdev;
 122 } dm_pdev_t;
 123
 124 /*
 125  * This structure is called for every device-mapper device.
 126  * It points to TAILQ of device tables and mirrored, snapshoted etc. devices.
 127  */
 128 typedef struct dm_dev {
 129         char name[DM_NAME_LEN];
 130         char uuid[DM_UUID_LEN];
 131
 132         cdev_t devt; /* pointer to autoconf device_t structure */
 133         uint64_t minor;
 134         uint32_t flags; /* store communication protocol flags */
 135
 136         struct lock dev_mtx; /* mutex for general device lock */
 137         struct cv dev_cv; /* cv for between ioctl synchronization */
 138
 139         /* uint32_t event_nr; */
 140         uint32_t ref_cnt;
 141
 142         uint32_t dev_type; /* DM_XXX_DEV, but not used  */
 143         uint32_t is_open;
 144
 145         dm_table_head_t table_head;
 146
 147         struct disk *diskp;
 148
 149         struct devstat stats;
 150
 151         TAILQ_ENTRY(dm_dev) next_devlist; /* Major device list. */
 152 } dm_dev_t;
 153
 154 #define DM_ZERO_DEV            (1 << 0)
 155 #define DM_ERROR_DEV           (1 << 1)
 156 #define DM_LINEAR_DEV          (1 << 2)
 157 #define DM_MIRROR_DEV          (1 << 3)
 158 #define DM_STRIPE_DEV          (1 << 4)
 159 #define DM_SNAPSHOT_DEV        (1 << 5)
 160 #define DM_SNAPSHOT_ORIG_DEV   (1 << 6)
 161 #define DM_RESERVED1_DEV       (1 << 7)
 162 #define DM_RESERVED2_DEV       (1 << 8)
 163 #define DM_CRYPTO_DEV          (1 << 9)
 164 #define DM_RAID1_DEV           (1 << 10)
 165 #define DM_DELAY_DEV           (1 << 11)
 166
 167 /*
 168  * Target config is initiated with dm_target_init function.
 169  */
 170
 171 /* constant dm_target structures for error, zero, linear, stripes etc. */
 172 typedef struct dm_target {
 173         char name[DM_MAX_TYPE_NAME];
 174
 175         /*
 176          * Mandatory handlers
 177          */
 178         int (*init)(dm_table_entry_t *, int, char **);
 179         int (*destroy)(dm_table_entry_t *);
 180         int (*strategy)(dm_table_entry_t *, struct buf *);
 181
 182         /*
 183          * Optional handlers
 184          */
 185         char *(*table)(void *); /* DM_STATUS_TABLE_FLAG */
 186         char *(*info)(void *);  /* !DM_STATUS_TABLE_FLAG */
 187         int (*dump)(dm_table_entry_t *, void *data, size_t length, off_t offset);
 188         int (*message)(dm_table_entry_t *, char *);
 189
 190         uint32_t version[3];
 191         int ref_cnt;
 192         int max_argc;
 193
 194         TAILQ_ENTRY(dm_target) dm_target_next;
 195 } dm_target_t;
 196
 197 /* device-mapper.c */
 198 void dmsetdiskinfo(struct disk *, dm_table_head_t *);
 199 uint64_t atoi64(const char *);
 200 char *dm_alloc_string(int len);
 201 void dm_builtin_init(void *);
 202 void dm_builtin_uninit(void *);
 203 MALLOC_DECLARE(M_DM);
 204 extern int dm_debug_level;
 205
 206 /* dm_ioctl.c */
 207 int dm_list_versions_ioctl(prop_dictionary_t);
 208 int dm_dev_create_ioctl(prop_dictionary_t);
 209 int dm_dev_list_ioctl(prop_dictionary_t);
 210 int dm_dev_rename_ioctl(prop_dictionary_t);
 211 int dm_dev_remove_ioctl(prop_dictionary_t);
 212 int dm_dev_remove_all_ioctl(prop_dictionary_t);
 213 int dm_dev_status_ioctl(prop_dictionary_t);
 214 int dm_dev_suspend_ioctl(prop_dictionary_t);
 215 int dm_dev_resume_ioctl(prop_dictionary_t);
 216 int dm_table_clear_ioctl(prop_dictionary_t);
 217 int dm_table_deps_ioctl(prop_dictionary_t);
 218 int dm_table_load_ioctl(prop_dictionary_t);
 219 int dm_table_status_ioctl(prop_dictionary_t);
 220 int dm_message_ioctl(prop_dictionary_t);
 221 int dm_check_version(prop_dictionary_t);
 222
 223 /* dm_target.c */
 224 void dm_target_busy(dm_target_t *);
 225 void dm_target_unbusy(dm_target_t *);
 226 dm_target_t* dm_target_autoload(const char *);
 227 dm_target_t* dm_target_lookup(const char *);
 228 int dm_target_insert(dm_target_t *);
 229 int dm_target_remove(char *);
 230 dm_target_t* dm_target_alloc(const char *);
 231 int dm_target_free(dm_target_t *);
 232 prop_array_t dm_target_prop_list(void);
 233 int dm_target_init(void);
 234 int dm_target_uninit(void);
 235
 236 /* dm_table.c  */
 237 dm_table_t *dm_table_get_entry(dm_table_head_t *, uint8_t);
 238 void dm_table_release(dm_table_head_t *, uint8_t s);
 239 void dm_table_switch_tables(dm_table_head_t *);
 240 int dm_table_destroy(dm_table_head_t *, uint8_t);
 241 uint64_t dm_table_size(dm_table_head_t *);
 242 uint64_t dm_inactive_table_size(dm_table_head_t *);
 243 int dm_table_get_target_count(dm_table_head_t *, uint8_t);
 244 void dm_table_head_init(dm_table_head_t *);
 245 void dm_table_head_destroy(dm_table_head_t *);
 246 void dm_table_init_target(dm_table_entry_t *table_en, uint32_t type, void *cfg);
 247 int dm_table_add_deps(dm_table_entry_t *table_en, dm_pdev_t *pdev);
 248 void dm_table_free_deps(dm_table_entry_t *table_en);
 249
 250 /* dm_dev.c */
 251 dm_dev_t* dm_dev_lookup(const char *, const char *, int);
 252 int dm_dev_insert(dm_dev_t *);
 253 #if 0
 254 dm_dev_t* dm_dev_lookup_evict(const char *, const char *, int);
 255 #endif
 256 int dm_dev_create(dm_dev_t **, const char *, const char *, int);
 257 int dm_dev_remove(dm_dev_t *);
 258 int dm_dev_remove_all(int);
 259 void dm_dev_busy(dm_dev_t *);
 260 void dm_dev_unbusy(dm_dev_t *);
 261 prop_array_t dm_dev_prop_list(void);
 262 int dm_dev_init(void);
 263 int dm_dev_uninit(void);
 264
 265 /* dm_pdev.c */
 266 off_t dm_pdev_correct_dump_offset(dm_pdev_t *, off_t);
 267 dm_pdev_t* dm_pdev_insert(const char *);
 268 int dm_pdev_decr(dm_pdev_t *);
 269 uint64_t dm_pdev_get_udev(dm_pdev_t *);
 270 int dm_pdev_get_vattr(dm_pdev_t *, struct vattr *);
 271 int dm_pdev_init(void);
 272 int dm_pdev_uninit(void);
 273
 274 #define dmdebug(format, ...)    \
 275     do { if (dm_debug_level) kprintf(format, ## __VA_ARGS__); } while(0)
 276
 277 #define DM_TARGET_MODULE(name, evh)                             \
 278     static moduledata_t name##_mod = {                          \
 279             #name,                                              \
 280             evh,                                                \
 281             NULL                                                \
 282     };                                                          \
 283     DECLARE_MODULE(name, name##_mod, SI_SUB_DM_TARGETS,         \
 284                    SI_ORDER_ANY);                               \
 285     MODULE_DEPEND(name, dm, 1, 1, 1)
 286
 287 #define DM_TARGET_BUILTIN(name, evh)                            \
 288     SYSINIT(name##module, SI_SUB_DM_TARGETS, SI_ORDER_ANY,      \
 289         dm_builtin_init, evh);                                  \
 290     SYSUNINIT(name##module, SI_SUB_DM_TARGETS, SI_ORDER_ANY,    \
 291         dm_builtin_uninit, evh)
 292
 293 #endif /*_KERNEL*/
 294
 295 #endif /*_DM_DEV_H_*/