dm.h revision 1.3
1 1.3 haad /* $NetBSD: dm.h,v 1.3 2008/12/19 16:30:41 haad Exp $ */ 2 1.2 haad 3 1.2 haad /* 4 1.2 haad * Copyright (c) 2008 The NetBSD Foundation, Inc. 5 1.2 haad * All rights reserved. 6 1.2 haad * 7 1.2 haad * This code is derived from software contributed to The NetBSD Foundation 8 1.2 haad * by Adam Hamsik. 9 1.2 haad * 10 1.2 haad * Redistribution and use in source and binary forms, with or without 11 1.2 haad * modification, are permitted provided that the following conditions 12 1.2 haad * are met: 13 1.2 haad * 1. Redistributions of source code must retain the above copyright 14 1.2 haad * notice, this list of conditions and the following disclaimer. 15 1.2 haad * 2. Redistributions in binary form must reproduce the above copyright 16 1.2 haad * notice, this list of conditions and the following disclaimer in the 17 1.2 haad * documentation and/or other materials provided with the distribution. 18 1.2 haad * 19 1.2 haad * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 20 1.2 haad * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 21 1.2 haad * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 22 1.2 haad * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 23 1.2 haad * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 24 1.2 haad * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 25 1.2 haad * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 26 1.2 haad * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 27 1.2 haad * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 28 1.2 haad * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 29 1.2 haad * POSSIBILITY OF SUCH DAMAGE. 30 1.2 haad */ 31 1.2 haad 32 1.2 haad #ifndef _DM_DEV_H_ 33 1.2 haad #define _DM_DEV_H_ 34 1.2 haad 35 1.2 haad 36 1.2 haad #ifdef _KERNEL 37 1.2 haad 38 1.2 haad #include <sys/errno.h> 39 1.2 haad 40 1.2 haad #include <sys/atomic.h> 41 1.2 haad #include <sys/condvar.h> 42 1.2 haad #include <sys/mutex.h> 43 1.2 haad #include <sys/rwlock.h> 44 1.2 haad #include <sys/queue.h> 45 1.2 haad 46 1.2 haad #define DM_MAX_TYPE_NAME 16 47 1.2 haad #define DM_NAME_LEN 128 48 1.2 haad #define DM_UUID_LEN 129 49 1.2 haad 50 1.2 haad #define DM_VERSION_MAJOR 4 51 1.2 haad #define DM_VERSION_MINOR 13 52 1.2 haad #define DM_VERSION_PATCHLEVEL 0 53 1.2 haad 54 1.2 haad /*** Internal device-mapper structures ***/ 55 1.2 haad 56 1.2 haad /* 57 1.2 haad * A table entry describes a physical range of the logical volume. 58 1.2 haad */ 59 1.2 haad #define MAX_TARGET_STRING_LEN 32 60 1.2 haad 61 1.2 haad /* 62 1.2 haad * A device mapper table is a list of physical ranges plus the mapping target 63 1.2 haad * applied to them. 64 1.2 haad */ 65 1.2 haad 66 1.2 haad typedef struct dm_table_entry { 67 1.2 haad struct dm_dev *dm_dev; /* backlink */ 68 1.2 haad uint64_t start; 69 1.2 haad uint64_t length; 70 1.2 haad 71 1.2 haad struct dm_target *target; /* Link to table target. */ 72 1.2 haad void *target_config; /* Target specific data. */ 73 1.2 haad SLIST_ENTRY(dm_table_entry) next; 74 1.2 haad } dm_table_entry_t; 75 1.2 haad 76 1.2 haad SLIST_HEAD(dm_table, dm_table_entry); 77 1.2 haad 78 1.2 haad typedef struct dm_table dm_table_t; 79 1.2 haad 80 1.2 haad typedef struct dm_table_head { 81 1.2 haad /* Current active table is selected with this. */ 82 1.2 haad int cur_active_table; 83 1.2 haad struct dm_table tables[2]; 84 1.2 haad 85 1.2 haad kmutex_t table_mtx; 86 1.2 haad kcondvar_t table_cv; /*IO waiting cv */ 87 1.2 haad 88 1.2 haad uint32_t io_cnt; 89 1.2 haad } dm_table_head_t; 90 1.2 haad 91 1.2 haad #define MAX_DEV_NAME 32 92 1.2 haad 93 1.2 haad /* 94 1.2 haad * This structure is used to store opened vnodes for disk with name. 95 1.2 haad * I need this because devices can be opened only once, but I can 96 1.2 haad * have more then one device on one partition. 97 1.2 haad */ 98 1.2 haad 99 1.2 haad typedef struct dm_pdev { 100 1.2 haad char name[MAX_DEV_NAME]; 101 1.2 haad 102 1.2 haad struct vnode *pdev_vnode; 103 1.2 haad int ref_cnt; /* reference counter for users ofthis pdev */ 104 1.2 haad 105 1.2 haad SLIST_ENTRY(dm_pdev) next_pdev; 106 1.2 haad } dm_pdev_t; 107 1.2 haad 108 1.2 haad /* 109 1.2 haad * This structure is called for every device-mapper device. 110 1.2 haad * It points to SLIST of device tables and mirrored, snapshoted etc. devices. 111 1.2 haad */ 112 1.2 haad TAILQ_HEAD(dm_dev_head, dm_dev) dm_devs; 113 1.2 haad 114 1.2 haad typedef struct dm_dev { 115 1.2 haad char name[DM_NAME_LEN]; 116 1.2 haad char uuid[DM_UUID_LEN]; 117 1.2 haad 118 1.2 haad int minor; 119 1.2 haad uint32_t flags; /* store communication protocol flags */ 120 1.2 haad 121 1.2 haad kmutex_t dev_mtx; /* mutex for generall device lock */ 122 1.2 haad kcondvar_t dev_cv; /* cv for between ioctl synchronisation */ 123 1.2 haad 124 1.2 haad uint32_t event_nr; 125 1.2 haad uint32_t ref_cnt; 126 1.2 haad 127 1.2 haad uint32_t dev_type; 128 1.2 haad 129 1.2 haad dm_table_head_t table_head; 130 1.2 haad 131 1.2 haad struct dm_dev_head upcalls; 132 1.2 haad 133 1.2 haad struct disklabel *dk_label; /* Disklabel for this table. */ 134 1.2 haad 135 1.2 haad TAILQ_ENTRY(dm_dev) next_upcall; /* LIST of mirrored, snapshoted devices. */ 136 1.2 haad 137 1.2 haad TAILQ_ENTRY(dm_dev) next_devlist; /* Major device list. */ 138 1.2 haad } dm_dev_t; 139 1.2 haad 140 1.2 haad /* Device types used for upcalls */ 141 1.2 haad #define DM_ZERO_DEV (1 << 0) 142 1.2 haad #define DM_ERROR_DEV (1 << 1) 143 1.2 haad #define DM_LINEAR_DEV (1 << 2) 144 1.2 haad #define DM_MIRROR_DEV (1 << 3) 145 1.2 haad #define DM_STRIPE_DEV (1 << 4) 146 1.2 haad #define DM_SNAPSHOT_DEV (1 << 5) 147 1.2 haad #define DM_SNAPSHOT_ORIG_DEV (1 << 6) 148 1.2 haad #define DM_SPARE_DEV (1 << 7) 149 1.2 haad /* Set this device type only during dev remove ioctl. */ 150 1.2 haad #define DM_DELETING_DEV (1 << 8) 151 1.2 haad 152 1.2 haad 153 1.2 haad /* for zero, error : dm_target->target_config == NULL */ 154 1.2 haad 155 1.2 haad /* 156 1.2 haad * Target config is initiated with target_init function. 157 1.2 haad */ 158 1.2 haad 159 1.2 haad /* for linear : */ 160 1.2 haad typedef struct target_linear_config { 161 1.2 haad dm_pdev_t *pdev; 162 1.2 haad uint64_t offset; 163 1.2 haad } dm_target_linear_config_t; 164 1.2 haad 165 1.2 haad 166 1.2 haad /* for mirror : */ 167 1.2 haad typedef struct target_mirror_config { 168 1.2 haad #define MAX_MIRROR_COPIES 4 169 1.2 haad dm_pdev_t *orig; 170 1.2 haad dm_pdev_t *copies[MAX_MIRROR_COPIES]; 171 1.2 haad 172 1.2 haad /* copied blocks bitmaps administration etc*/ 173 1.2 haad dm_pdev_t *log_pdev; /* for administration */ 174 1.2 haad uint64_t log_regionsize; /* blocksize of mirror */ 175 1.2 haad 176 1.2 haad /* list of parts that still need copied etc.; run length encoded? */ 177 1.2 haad } dm_target_mirror_config_t; 178 1.2 haad 179 1.2 haad 180 1.2 haad /* for snapshot : */ 181 1.2 haad typedef struct target_snapshot_config { 182 1.2 haad dm_pdev_t *tsc_snap_dev; 183 1.2 haad /* cow dev is set only for persistent snapshot devices */ 184 1.2 haad dm_pdev_t *tsc_cow_dev; 185 1.2 haad 186 1.2 haad uint64_t tsc_chunk_size; 187 1.2 haad uint32_t tsc_persistent_dev; 188 1.2 haad } dm_target_snapshot_config_t; 189 1.2 haad 190 1.2 haad /* for snapshot-origin devices */ 191 1.2 haad typedef struct target_snapshot_origin_config { 192 1.2 haad dm_pdev_t *tsoc_real_dev; 193 1.2 haad /* list of snapshots ? */ 194 1.2 haad } dm_target_snapshot_origin_config_t; 195 1.2 haad 196 1.2 haad /* constant dm_target structures for error, zero, linear, stripes etc. */ 197 1.2 haad typedef struct dm_target { 198 1.2 haad char name[DM_MAX_TYPE_NAME]; 199 1.2 haad /* Initialize target_config area */ 200 1.2 haad int (*init)(dm_dev_t *, void **, char *); 201 1.2 haad 202 1.2 haad /* Destroy target_config area */ 203 1.2 haad int (*destroy)(dm_table_entry_t *); 204 1.2 haad 205 1.2 haad int (*deps) (dm_table_entry_t *, prop_array_t); 206 1.2 haad /* 207 1.2 haad * Status routine is called to get params string, which is target 208 1.2 haad * specific. When dm_table_status_ioctl is called with flag 209 1.2 haad * DM_STATUS_TABLE_FLAG I have to sent params string back. 210 1.2 haad */ 211 1.2 haad char * (*status)(void *); 212 1.2 haad int (*strategy)(dm_table_entry_t *, struct buf *); 213 1.2 haad int (*upcall)(dm_table_entry_t *, struct buf *); 214 1.2 haad 215 1.2 haad uint32_t version[3]; 216 1.3 haad int ref_cnt; 217 1.2 haad 218 1.2 haad TAILQ_ENTRY(dm_target) dm_target_next; 219 1.2 haad } dm_target_t; 220 1.2 haad 221 1.2 haad /* Interface structures */ 222 1.2 haad 223 1.2 haad /* 224 1.2 haad * This structure is used to translate command sent to kernel driver in 225 1.2 haad * <key>command</key> 226 1.2 haad * <value></value> 227 1.2 haad * to function which I can call. 228 1.2 haad */ 229 1.2 haad struct cmd_function { 230 1.2 haad const char *cmd; 231 1.2 haad int (*fn)(prop_dictionary_t); 232 1.2 haad }; 233 1.2 haad 234 1.2 haad /* device-mapper */ 235 1.2 haad void dmgetdisklabel(struct disklabel *, dm_table_head_t *); 236 1.2 haad 237 1.2 haad /* dm_ioctl.c */ 238 1.2 haad int dm_dev_create_ioctl(prop_dictionary_t); 239 1.2 haad int dm_dev_list_ioctl(prop_dictionary_t); 240 1.2 haad int dm_dev_remove_ioctl(prop_dictionary_t); 241 1.2 haad int dm_dev_rename_ioctl(prop_dictionary_t); 242 1.2 haad int dm_dev_resume_ioctl(prop_dictionary_t); 243 1.2 haad int dm_dev_status_ioctl(prop_dictionary_t); 244 1.2 haad int dm_dev_suspend_ioctl(prop_dictionary_t); 245 1.2 haad 246 1.2 haad int dm_check_version(prop_dictionary_t); 247 1.2 haad int dm_get_version_ioctl(prop_dictionary_t); 248 1.2 haad int dm_list_versions_ioctl(prop_dictionary_t); 249 1.2 haad 250 1.2 haad int dm_table_clear_ioctl(prop_dictionary_t); 251 1.2 haad int dm_table_deps_ioctl(prop_dictionary_t); 252 1.2 haad int dm_table_load_ioctl(prop_dictionary_t); 253 1.2 haad int dm_table_status_ioctl(prop_dictionary_t); 254 1.2 haad 255 1.2 haad /* dm_target.c */ 256 1.2 haad int dm_target_destroy(void); 257 1.2 haad int dm_target_insert(dm_target_t *); 258 1.2 haad prop_array_t dm_target_prop_list(void); 259 1.3 haad dm_target_t* dm_target_lookup(const char *); 260 1.2 haad int dm_target_rem(char *); 261 1.3 haad void dm_target_unbusy(dm_target_t *); 262 1.3 haad void dm_target_busy(dm_target_t *); 263 1.2 haad 264 1.2 haad /* XXX temporally add */ 265 1.2 haad int dm_target_init(void); 266 1.2 haad 267 1.2 haad /* dm_target_zero.c */ 268 1.2 haad int dm_target_zero_init(dm_dev_t *, void**, char *); 269 1.2 haad char * dm_target_zero_status(void *); 270 1.2 haad int dm_target_zero_strategy(dm_table_entry_t *, struct buf *); 271 1.2 haad int dm_target_zero_destroy(dm_table_entry_t *); 272 1.2 haad int dm_target_zero_deps(dm_table_entry_t *, prop_array_t); 273 1.2 haad int dm_target_zero_upcall(dm_table_entry_t *, struct buf *); 274 1.2 haad 275 1.2 haad /* dm_target_error.c */ 276 1.2 haad int dm_target_error_init(dm_dev_t *, void**, char *); 277 1.2 haad char * dm_target_error_status(void *); 278 1.2 haad int dm_target_error_strategy(dm_table_entry_t *, struct buf *); 279 1.2 haad int dm_target_error_deps(dm_table_entry_t *, prop_array_t); 280 1.2 haad int dm_target_error_destroy(dm_table_entry_t *); 281 1.2 haad int dm_target_error_upcall(dm_table_entry_t *, struct buf *); 282 1.2 haad 283 1.2 haad /* dm_target_linear.c */ 284 1.2 haad int dm_target_linear_init(dm_dev_t *, void**, char *); 285 1.2 haad char * dm_target_linear_status(void *); 286 1.2 haad int dm_target_linear_strategy(dm_table_entry_t *, struct buf *); 287 1.2 haad int dm_target_linear_deps(dm_table_entry_t *, prop_array_t); 288 1.2 haad int dm_target_linear_destroy(dm_table_entry_t *); 289 1.2 haad int dm_target_linear_upcall(dm_table_entry_t *, struct buf *); 290 1.2 haad 291 1.2 haad /* Generic function used to convert char to string */ 292 1.2 haad uint64_t atoi(const char *); 293 1.2 haad 294 1.2 haad /* dm_target_snapshot.c */ 295 1.2 haad int dm_target_snapshot_init(dm_dev_t *, void**, char *); 296 1.2 haad char * dm_target_snapshot_status(void *); 297 1.2 haad int dm_target_snapshot_strategy(dm_table_entry_t *, struct buf *); 298 1.2 haad int dm_target_snapshot_deps(dm_table_entry_t *, prop_array_t); 299 1.2 haad int dm_target_snapshot_destroy(dm_table_entry_t *); 300 1.2 haad int dm_target_snapshot_upcall(dm_table_entry_t *, struct buf *); 301 1.2 haad 302 1.2 haad /* dm snapshot origin driver */ 303 1.2 haad int dm_target_snapshot_orig_init(dm_dev_t *, void**, char *); 304 1.2 haad char * dm_target_snapshot_orig_status(void *); 305 1.2 haad int dm_target_snapshot_orig_strategy(dm_table_entry_t *, struct buf *); 306 1.2 haad int dm_target_snapshot_orig_deps(dm_table_entry_t *, prop_array_t); 307 1.2 haad int dm_target_snapshot_orig_destroy(dm_table_entry_t *); 308 1.2 haad int dm_target_snapshot_orig_upcall(dm_table_entry_t *, struct buf *); 309 1.2 haad 310 1.2 haad /* dm_table.c */ 311 1.2 haad #define DM_TABLE_ACTIVE 0 312 1.2 haad #define DM_TABLE_INACTIVE 1 313 1.2 haad 314 1.2 haad int dm_table_destroy(dm_table_head_t *, uint8_t); 315 1.2 haad uint64_t dm_table_size(dm_table_head_t *); 316 1.2 haad dm_table_t * dm_table_get_entry(dm_table_head_t *, uint8_t); 317 1.2 haad int dm_table_get_target_count(dm_table_head_t *, uint8_t); 318 1.2 haad void dm_table_release(dm_table_head_t *, uint8_t s); 319 1.2 haad void dm_table_switch_tables(dm_table_head_t *); 320 1.2 haad void dm_table_head_init(dm_table_head_t *); 321 1.2 haad void dm_table_head_destroy(dm_table_head_t *); 322 1.2 haad 323 1.2 haad /* dm_dev.c */ 324 1.2 haad dm_dev_t* dm_dev_alloc(void); 325 1.2 haad void dm_dev_busy(dm_dev_t *); 326 1.2 haad int dm_dev_destroy(void); 327 1.2 haad int dm_dev_free(dm_dev_t *); 328 1.2 haad int dm_dev_init(void); 329 1.2 haad int dm_dev_insert(dm_dev_t *); 330 1.2 haad dm_dev_t* dm_dev_lookup(const char *, const char *, int); 331 1.2 haad prop_array_t dm_dev_prop_list(void); 332 1.2 haad dm_dev_t* dm_dev_rem(const char *, const char *, int); 333 1.2 haad /*int dm_dev_test_minor(int);*/ 334 1.2 haad void dm_dev_unbusy(dm_dev_t *); 335 1.2 haad 336 1.2 haad /* dm_pdev.c */ 337 1.2 haad int dm_pdev_decr(dm_pdev_t *); 338 1.2 haad int dm_pdev_destroy(void); 339 1.2 haad int dm_pdev_init(void); 340 1.2 haad dm_pdev_t* dm_pdev_insert(const char *); 341 1.2 haad 342 1.2 haad #endif /*_KERNEL*/ 343 1.2 haad 344 1.2 haad #endif /*_DM_DEV_H_*/ 345
Indexes created Mon Sep 22 13:09:51 GMT 2025