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
  36 #ifdef _KERNEL
  37
  38 #include <sys/errno.h>
  39 #include <sys/systm.h>
  40 #include <sys/kernel.h>
  41
  42 #include <cpu/inttypes.h>
  43 #include <cpu/atomic.h>
  44 #include <sys/condvar.h>
  45 #include <sys/lock.h>
  46 #include <sys/queue.h>
  47
  48 #include <sys/device.h>
  49 #include <sys/devicestat.h>
  50 #include <sys/diskslice.h>
  51 #include <sys/disklabel.h>
  52
  53 #include <libprop/proplib.h>
  54
  55 #define DM_MAX_TYPE_NAME 16
  56 #define DM_NAME_LEN 128
  57 #define DM_UUID_LEN 129
  58
  59 #define DM_VERSION_MAJOR        4
  60 #define DM_VERSION_MINOR        16
  61
  62 #define DM_VERSION_PATCHLEVEL   0
  63
  64 /*** Internal device-mapper structures ***/
  65
  66 /*
  67  * A table entry describes a physical range of the logical volume.
  68  */
  69 #define MAX_TARGET_STRING_LEN 32
  70
  71 /*
  72  * A device mapper table is a list of physical ranges plus the mapping target
  73  * applied to them.
  74  */
  75 struct buf;
  76 struct bio;
  77
  78 typedef struct dm_table_entry {
  79         struct dm_dev *dm_dev;          /* backlink */
  80         uint64_t start;
  81         uint64_t length;
  82
  83         struct dm_target *target;      /* Link to table target. */
  84         void *target_config;           /* Target specific data. */
  85         SLIST_ENTRY(dm_table_entry) next;
  86 } dm_table_entry_t;
  87
  88 SLIST_HEAD(dm_table, dm_table_entry);
  89
  90 typedef struct dm_table dm_table_t;
  91
  92 typedef struct dm_table_head {
  93         /* Current active table is selected with this. */
  94         int cur_active_table;
  95         struct dm_table tables[2];
  96
  97         struct lock   table_mtx;
  98
  99         int      io_cnt;
 100 } dm_table_head_t;
 101
 102 #define MAX_DEV_NAME 32
 103
 104 /*
 105  * This structure is used to store opened vnodes for disk with name.
 106  * I need this because devices can be opened only once, but I can
 107  * have more then one device on one partition.
 108  */
 109
 110 typedef struct dm_pdev {
 111         char name[MAX_DEV_NAME];
 112         struct partinfo pdev_pinfo; /* partinfo of the underlying device */
 113
 114         struct vnode *pdev_vnode;
 115         int ref_cnt; /* reference counter for users ofthis pdev */
 116
 117         SLIST_ENTRY(dm_pdev) next_pdev;
 118 } dm_pdev_t;
 119
 120 /*
 121  * This structure is called for every device-mapper device.
 122  * It points to SLIST of device tables and mirrored, snapshoted etc. devices.
 123  */
 124 TAILQ_HEAD(dm_dev_head, dm_dev);
 125
 126 typedef struct dm_dev {
 127         char name[DM_NAME_LEN];
 128         char uuid[DM_UUID_LEN];
 129
 130         cdev_t devt; /* pointer to autoconf device_t structure */
 131         uint64_t minor;
 132         uint32_t flags; /* store communication protocol flags */
 133
 134         struct lock dev_mtx; /* mutex for generall device lock */
 135         struct cv dev_cv; /* cv for between ioctl synchronisation */
 136
 137         uint32_t event_nr;
 138         uint32_t ref_cnt;
 139
 140         uint32_t dev_type;
 141         uint32_t is_open;
 142
 143         dm_table_head_t table_head;
 144
 145         struct dm_dev_head upcalls;
 146
 147         struct disk *diskp;
 148
 149         struct devstat stats;
 150
 151         TAILQ_ENTRY(dm_dev) next_upcall; /* LIST of mirrored, snapshoted devices. */
 152
 153         TAILQ_ENTRY(dm_dev) next_devlist; /* Major device list. */
 154 } dm_dev_t;
 155
 156 /* Device types used for upcalls */
 157 #define DM_ZERO_DEV            (1 << 0)
 158 #define DM_ERROR_DEV           (1 << 1)
 159 #define DM_LINEAR_DEV          (1 << 2)
 160 #define DM_MIRROR_DEV          (1 << 3)
 161 #define DM_STRIPE_DEV          (1 << 4)
 162 #define DM_SNAPSHOT_DEV        (1 << 5)
 163 #define DM_SNAPSHOT_ORIG_DEV   (1 << 6)
 164 #define DM_SPARE_DEV           (1 << 7)
 165 /* Set this device type only during dev remove ioctl. */
 166 #define DM_DELETING_DEV        (1 << 8)
 167 #define DM_CRYPTO_DEV           (1 << 9)
 168
 169 /* for zero, error : dm_target->target_config == NULL */
 170
 171 /*
 172  * Target config is initiated with target_init function.
 173  */
 174
 175 /* for linear : */
 176 typedef struct target_linear_config {
 177         dm_pdev_t *pdev;
 178         uint64_t offset;
 179 } dm_target_linear_config_t;
 180
 181 /* for stripe : */
 182
 183 #define MAX_STRIPES 32
 184
 185 typedef struct target_stripe_config {
 186         struct target_linear_config stripe_devs[MAX_STRIPES];
 187         int stripe_num;
 188         uint64_t stripe_chunksize;
 189 } dm_target_stripe_config_t;
 190
 191 /* for mirror : */
 192 typedef struct target_mirror_config {
 193 #define MAX_MIRROR_COPIES 4
 194         dm_pdev_t *orig;
 195         dm_pdev_t *copies[MAX_MIRROR_COPIES];
 196
 197         /* copied blocks bitmaps administration etc*/
 198         dm_pdev_t *log_pdev;    /* for administration */
 199         uint64_t log_regionsize;        /* blocksize of mirror */
 200
 201         /* list of parts that still need copied etc.; run length encoded? */
 202 } dm_target_mirror_config_t;
 203
 204
 205 /* for snapshot : */
 206 typedef struct target_snapshot_config {
 207         dm_pdev_t *tsc_snap_dev;
 208         /* cow dev is set only for persistent snapshot devices */
 209         dm_pdev_t *tsc_cow_dev;
 210
 211         uint64_t tsc_chunk_size;
 212         uint32_t tsc_persistent_dev;
 213 } dm_target_snapshot_config_t;
 214
 215 /* for snapshot-origin devices */
 216 typedef struct target_snapshot_origin_config {
 217         dm_pdev_t *tsoc_real_dev;
 218         /* list of snapshots ? */
 219 } dm_target_snapshot_origin_config_t;
 220
 221 /* constant dm_target structures for error, zero, linear, stripes etc. */
 222 typedef struct dm_target {
 223         char name[DM_MAX_TYPE_NAME];
 224         /* Initialize target_config area */
 225         int (*init)(dm_dev_t *, void **, char *);
 226
 227         /* Message interface */
 228         int (*message)(dm_table_entry_t *, char *);
 229
 230         /* Destroy target_config area */
 231         int (*destroy)(dm_table_entry_t *);
 232
 233         int (*deps) (dm_table_entry_t *, prop_array_t);
 234         /*
 235          * Status routine is called to get params string, which is target
 236          * specific. When dm_table_status_ioctl is called with flag
 237          * DM_STATUS_TABLE_FLAG I have to sent params string back.
 238          */
 239         char * (*status)(void *);
 240         int (*strategy)(dm_table_entry_t *, struct buf *);
 241         int (*upcall)(dm_table_entry_t *, struct buf *);
 242         int (*dump)(dm_table_entry_t *, void *data, size_t length, off_t offset);
 243
 244         uint32_t version[3];
 245         int ref_cnt;
 246
 247         TAILQ_ENTRY(dm_target) dm_target_next;
 248 } dm_target_t;
 249
 250 /* Interface structures */
 251
 252 /*
 253  * This structure is used to translate command sent to kernel driver in
 254  * <key>command</key>
 255  * <value></value>
 256  * to function which I can call.
 257  */
 258 struct cmd_function {
 259         const char *cmd;
 260         int  (*fn)(prop_dictionary_t);
 261 };
 262
 263 /* device-mapper */
 264 void dmsetdiskinfo(struct disk *, dm_table_head_t *);
 265 int dm_detach(dm_dev_t *);
 266
 267 /* dm_ioctl.c */
 268 int dm_dev_create_ioctl(prop_dictionary_t);
 269 int dm_dev_list_ioctl(prop_dictionary_t);
 270 int dm_dev_remove_ioctl(prop_dictionary_t);
 271 int dm_dev_remove_all_ioctl(prop_dictionary_t);
 272 int dm_dev_rename_ioctl(prop_dictionary_t);
 273 int dm_dev_resume_ioctl(prop_dictionary_t);
 274 int dm_dev_status_ioctl(prop_dictionary_t);
 275 int dm_dev_suspend_ioctl(prop_dictionary_t);
 276
 277 int dm_check_version(prop_dictionary_t);
 278 int dm_get_version_ioctl(prop_dictionary_t);
 279 int dm_list_versions_ioctl(prop_dictionary_t);
 280
 281 int dm_table_clear_ioctl(prop_dictionary_t);
 282 int dm_table_deps_ioctl(prop_dictionary_t);
 283 int dm_table_load_ioctl(prop_dictionary_t);
 284 int dm_table_status_ioctl(prop_dictionary_t);
 285 int dm_message_ioctl(prop_dictionary_t);
 286
 287 /* dm_target.c */
 288 int dm_target_init(void);
 289 int dm_target_uninit(void);
 290 dm_target_t* dm_target_alloc(const char *);
 291 dm_target_t* dm_target_autoload(const char *);
 292 int dm_target_insert(dm_target_t *);
 293 prop_array_t dm_target_prop_list(void);
 294 dm_target_t* dm_target_lookup(const char *);
 295 int dm_target_rem(char *);
 296 void dm_target_unbusy(dm_target_t *);
 297 void dm_target_busy(dm_target_t *);
 298
 299 #define DM_MAX_PARAMS_SIZE 1024
 300
 301 /* Generic function used to convert char to string */
 302 uint64_t atoi64(const char *);
 303
 304 /* dm_target_mirror.c */
 305 int dm_target_mirror_init(dm_dev_t *, void**, char *);
 306 char * dm_target_mirror_status(void *);
 307 int dm_target_mirror_strategy(dm_table_entry_t *, struct buf *);
 308 int dm_target_mirror_deps(dm_table_entry_t *, prop_array_t);
 309 int dm_target_mirror_destroy(dm_table_entry_t *);
 310 int dm_target_mirror_upcall(dm_table_entry_t *, struct buf *);
 311
 312 /* dm_target_snapshot.c */
 313 int dm_target_snapshot_init(dm_dev_t *, void**, char *);
 314 char * dm_target_snapshot_status(void *);
 315 int dm_target_snapshot_strategy(dm_table_entry_t *, struct buf *);
 316 int dm_target_snapshot_deps(dm_table_entry_t *, prop_array_t);
 317 int dm_target_snapshot_destroy(dm_table_entry_t *);
 318 int dm_target_snapshot_upcall(dm_table_entry_t *, struct buf *);
 319
 320 /* dm snapshot origin driver */
 321 int dm_target_snapshot_orig_init(dm_dev_t *, void**, char *);
 322 char * dm_target_snapshot_orig_status(void *);
 323 int dm_target_snapshot_orig_strategy(dm_table_entry_t *, struct buf *);
 324 int dm_target_snapshot_orig_deps(dm_table_entry_t *, prop_array_t);
 325 int dm_target_snapshot_orig_destroy(dm_table_entry_t *);
 326 int dm_target_snapshot_orig_upcall(dm_table_entry_t *, struct buf *);
 327
 328 /* dm_table.c  */
 329 #define DM_TABLE_ACTIVE 0
 330 #define DM_TABLE_INACTIVE 1
 331
 332 int dm_table_destroy(dm_table_head_t *, uint8_t);
 333 uint64_t dm_table_size(dm_table_head_t *);
 334 dm_table_t * dm_table_get_entry(dm_table_head_t *, uint8_t);
 335 int dm_table_get_target_count(dm_table_head_t *, uint8_t);
 336 void dm_table_release(dm_table_head_t *, uint8_t s);
 337 void dm_table_switch_tables(dm_table_head_t *);
 338 void dm_table_head_init(dm_table_head_t *);
 339 void dm_table_head_destroy(dm_table_head_t *);
 340
 341 /* dm_dev.c */
 342 int dm_dev_init(void);
 343 int dm_dev_uninit(void);
 344 dm_dev_t* dm_dev_alloc(void);
 345 void dm_dev_busy(dm_dev_t *);
 346 int dm_dev_create(dm_dev_t **, const char *, const char *, int);
 347 int dm_dev_remove(dm_dev_t *);
 348 int dm_dev_remove_all(int);
 349 int dm_dev_destroy(dm_dev_t *);
 350 int dm_dev_free(dm_dev_t *);
 351 int dm_dev_insert(dm_dev_t *);
 352 dm_dev_t* dm_dev_lookup(const char *, const char *, int);
 353 prop_array_t dm_dev_prop_list(void);
 354 dm_dev_t* dm_dev_rem(dm_dev_t *, const char *, const char *, int);
 355 /*int dm_dev_test_minor(int);*/
 356 void dm_dev_unbusy(dm_dev_t *);
 357
 358 /* dm_pdev.c */
 359 int dm_pdev_init(void);
 360 int dm_pdev_uninit(void);
 361 int dm_pdev_decr(dm_pdev_t *);
 362 dm_pdev_t* dm_pdev_insert(const char *);
 363 off_t dm_pdev_correct_dump_offset(dm_pdev_t *, off_t);
 364
 365 /* dm builtin magic */
 366 void dm_builtin_init(void *);
 367 void dm_builtin_uninit(void *);
 368
 369 extern int dm_debug_level;
 370 MALLOC_DECLARE(M_DM);
 371
 372 #define aprint_debug(format, ...)       \
 373     do { if (dm_debug_level) kprintf(format, ## __VA_ARGS__); } while(0)
 374 #define aprint_normal   kprintf
 375
 376 #define DM_TARGET_MODULE(name, evh)                             \
 377     static moduledata_t name##_mod = {                          \
 378             #name,                                              \
 379             evh,                                                \
 380             NULL                                                \
 381     };                                                          \
 382     DECLARE_MODULE(name, name##_mod, SI_SUB_DM_TARGETS,         \
 383                    SI_ORDER_ANY);                               \
 384     MODULE_DEPEND(name, dm, 1, 1, 1)
 385
 386 #define DM_TARGET_BUILTIN(name, evh)                            \
 387     SYSINIT(name##module, SI_SUB_DM_TARGETS, SI_ORDER_ANY,      \
 388         dm_builtin_init, evh);                                  \
 389     SYSUNINIT(name##module, SI_SUB_DM_TARGETS, SI_ORDER_ANY,    \
 390         dm_builtin_uninit, evh)
 391
 392 #endif /*_KERNEL*/
 393
 394 #endif /*_DM_DEV_H_*/