dm.h revision 1.36
1 /* $NetBSD: dm.h,v 1.36 2019/12/08 10:35:53 tkusumi 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 40 #include <sys/atomic.h> 41 #include <sys/fcntl.h> 42 #include <sys/condvar.h> 43 #include <sys/kauth.h> 44 #include <sys/mutex.h> 45 #include <sys/rwlock.h> 46 #include <sys/queue.h> 47 #include <sys/vnode.h> 48 49 #include <sys/device.h> 50 #include <sys/disk.h> 51 #include <sys/disklabel.h> 52 53 #include <miscfs/specfs/specdev.h> /* for v_rdev */ 54 55 #include <prop/proplib.h> 56 57 #define DM_MAX_TYPE_NAME 16 58 #define DM_NAME_LEN 128 59 #define DM_UUID_LEN 129 60 61 #define DM_VERSION_MAJOR 4 62 #define DM_VERSION_MINOR 16 63 64 #define DM_VERSION_PATCHLEVEL 0 65 66 /*** Internal device-mapper structures ***/ 67 68 /* 69 * A device mapper table is a list of physical ranges plus the mapping target 70 * applied to them. 71 */ 72 73 typedef struct dm_table_entry { 74 struct dm_dev *dm_dev; /* backlink */ 75 uint64_t start; 76 uint64_t length; 77 78 struct dm_target *target; /* Link to table target. */ 79 void *target_config; /* Target specific data. */ 80 SLIST_ENTRY(dm_table_entry) next; 81 } dm_table_entry_t; 82 83 SLIST_HEAD(dm_table, dm_table_entry); 84 85 typedef struct dm_table dm_table_t; 86 87 typedef struct dm_table_head { 88 /* Current active table is selected with this. */ 89 int cur_active_table; 90 struct dm_table tables[2]; 91 92 kmutex_t table_mtx; 93 kcondvar_t table_cv; /*IO waiting cv */ 94 95 uint32_t io_cnt; 96 } dm_table_head_t; 97 98 #define MAX_DEV_NAME 32 99 100 /* 101 * This structure is used to store opened vnodes for disk with name. 102 * I need this because devices can be opened only once, but I can 103 * have more than one device on one partition. 104 */ 105 106 typedef struct dm_pdev { 107 char name[MAX_DEV_NAME]; 108 109 struct vnode *pdev_vnode; 110 uint64_t pdev_numsec; 111 unsigned pdev_secsize; 112 int ref_cnt; /* reference counter for users ofthis pdev */ 113 114 SLIST_ENTRY(dm_pdev) next_pdev; 115 } dm_pdev_t; 116 117 /* 118 * This structure is called for every device-mapper device. 119 * It points to SLIST of device tables and mirrored, snapshoted etc. devices. 120 */ 121 TAILQ_HEAD(dm_dev_head, dm_dev); 122 //extern struct dm_dev_head dm_devs; 123 124 typedef struct dm_dev { 125 char name[DM_NAME_LEN]; 126 char uuid[DM_UUID_LEN]; 127 128 device_t devt; /* pointer to autoconf device_t structure */ 129 uint64_t minor; /* Device minor number */ 130 uint32_t flags; /* store communication protocol flags */ 131 132 kmutex_t dev_mtx; /* mutex for generall device lock */ 133 kcondvar_t dev_cv; /* cv for between ioctl synchronisation */ 134 135 uint32_t event_nr; 136 uint32_t ref_cnt; 137 138 dm_table_head_t table_head; 139 140 //struct dm_dev_head upcalls; 141 142 struct disk *diskp; 143 kmutex_t diskp_mtx; 144 145 //TAILQ_ENTRY(dm_dev) next_upcall; /* LIST of mirrored, snapshoted devices. */ 146 147 TAILQ_ENTRY(dm_dev) next_devlist; /* Major device list. */ 148 } dm_dev_t; 149 150 /* for zero, error : dm_target->target_config == NULL */ 151 152 /* 153 * Target config is initiated with target_init function. 154 */ 155 156 /* for linear : */ 157 typedef struct target_linear_config { 158 dm_pdev_t *pdev; 159 uint64_t offset; 160 TAILQ_ENTRY(target_linear_config) entries; 161 } dm_target_linear_config_t; 162 163 /* 164 * Striping devices are stored in a linked list, this might be inefficient 165 * for more than 8 striping devices and can be changed to something more 166 * scalable. 167 * TODO: look for other options than linked list. 168 */ 169 TAILQ_HEAD(target_linear_devs, target_linear_config); 170 171 typedef struct target_linear_devs dm_target_linear_devs_t; 172 173 /* for stripe : */ 174 typedef struct target_stripe_config { 175 #define DM_STRIPE_DEV_OFFSET 2 176 struct target_linear_devs stripe_devs; 177 uint8_t stripe_num; 178 uint64_t stripe_chunksize; 179 size_t params_len; 180 } dm_target_stripe_config_t; 181 182 /* for mirror : */ 183 typedef struct target_mirror_config { 184 #define MAX_MIRROR_COPIES 4 185 dm_pdev_t *orig; 186 dm_pdev_t *copies[MAX_MIRROR_COPIES]; 187 188 /* copied blocks bitmaps administration etc*/ 189 dm_pdev_t *log_pdev; /* for administration */ 190 uint64_t log_regionsize; /* blocksize of mirror */ 191 192 /* list of parts that still need copied etc.; run length encoded? */ 193 } dm_target_mirror_config_t; 194 195 196 /* for snapshot : */ 197 typedef struct target_snapshot_config { 198 dm_pdev_t *tsc_snap_dev; 199 /* cow dev is set only for persistent snapshot devices */ 200 dm_pdev_t *tsc_cow_dev; 201 202 uint64_t tsc_chunk_size; 203 uint32_t tsc_persistent_dev; 204 } dm_target_snapshot_config_t; 205 206 /* for snapshot-origin devices */ 207 typedef struct target_snapshot_origin_config { 208 dm_pdev_t *tsoc_real_dev; 209 /* list of snapshots ? */ 210 } dm_target_snapshot_origin_config_t; 211 212 /* constant dm_target structures for error, zero, linear, stripes etc. */ 213 typedef struct dm_target { 214 char name[DM_MAX_TYPE_NAME]; 215 /* Initialize target_config area */ 216 int (*init)(dm_table_entry_t *, char *); 217 218 /* Destroy target_config area */ 219 int (*destroy)(dm_table_entry_t *); 220 221 int (*deps) (dm_table_entry_t *, prop_array_t); 222 /* 223 * Status routine is called to get params string, which is target 224 * specific. When dm_table_status_ioctl is called with flag 225 * DM_STATUS_TABLE_FLAG I have to sent params string back. 226 */ 227 char * (*status)(void *); 228 int (*strategy)(dm_table_entry_t *, struct buf *); 229 int (*sync)(dm_table_entry_t *); 230 int (*upcall)(dm_table_entry_t *, struct buf *); 231 int (*secsize)(dm_table_entry_t *, unsigned *); 232 233 uint32_t version[3]; 234 uint32_t ref_cnt; 235 236 TAILQ_ENTRY(dm_target) dm_target_next; 237 } dm_target_t; 238 239 /* Interface structures */ 240 241 /* device-mapper */ 242 void dmgetproperties(struct disk *, dm_table_head_t *); 243 244 /* dm_ioctl.c */ 245 int dm_dev_create_ioctl(prop_dictionary_t); 246 int dm_dev_list_ioctl(prop_dictionary_t); 247 int dm_dev_remove_ioctl(prop_dictionary_t); 248 int dm_dev_rename_ioctl(prop_dictionary_t); 249 int dm_dev_resume_ioctl(prop_dictionary_t); 250 int dm_dev_status_ioctl(prop_dictionary_t); 251 int dm_dev_suspend_ioctl(prop_dictionary_t); 252 253 int dm_check_version(prop_dictionary_t); 254 int dm_list_versions_ioctl(prop_dictionary_t); 255 256 int dm_table_clear_ioctl(prop_dictionary_t); 257 int dm_table_deps_ioctl(prop_dictionary_t); 258 int dm_table_load_ioctl(prop_dictionary_t); 259 int dm_table_status_ioctl(prop_dictionary_t); 260 261 /* dm_target.c */ 262 dm_target_t* dm_target_alloc(const char *); 263 dm_target_t* dm_target_autoload(const char *); 264 int dm_target_destroy(void); 265 int dm_target_insert(dm_target_t *); 266 prop_array_t dm_target_prop_list(void); 267 dm_target_t* dm_target_lookup(const char *); 268 int dm_target_rem(const char *); 269 void dm_target_unbusy(dm_target_t *); 270 void dm_target_busy(dm_target_t *); 271 272 /* XXX temporally add */ 273 int dm_target_init(void); 274 275 #define DM_MAX_PARAMS_SIZE 1024 276 277 /* dm_target_linear.c */ 278 int dm_target_linear_init(dm_table_entry_t *, char *); 279 char *dm_target_linear_status(void *); 280 int dm_target_linear_strategy(dm_table_entry_t *, struct buf *); 281 int dm_target_linear_sync(dm_table_entry_t *); 282 int dm_target_linear_deps(dm_table_entry_t *, prop_array_t); 283 int dm_target_linear_destroy(dm_table_entry_t *); 284 int dm_target_linear_upcall(dm_table_entry_t *, struct buf *); 285 int dm_target_linear_secsize(dm_table_entry_t *, unsigned *); 286 287 /* Generic function used to convert char to string */ 288 uint64_t atoi(const char *); 289 290 /* dm_target_stripe.c */ 291 int dm_target_stripe_init(dm_table_entry_t *, char *); 292 char *dm_target_stripe_status(void *); 293 int dm_target_stripe_strategy(dm_table_entry_t *, struct buf *); 294 int dm_target_stripe_sync(dm_table_entry_t *); 295 int dm_target_stripe_deps(dm_table_entry_t *, prop_array_t); 296 int dm_target_stripe_destroy(dm_table_entry_t *); 297 int dm_target_stripe_upcall(dm_table_entry_t *, struct buf *); 298 int dm_target_stripe_secsize(dm_table_entry_t *, unsigned *); 299 300 /* dm_table.c */ 301 #define DM_TABLE_ACTIVE 0 302 #define DM_TABLE_INACTIVE 1 303 304 int dm_table_destroy(dm_table_head_t *, uint8_t); 305 uint64_t dm_table_size(dm_table_head_t *); 306 uint64_t dm_inactive_table_size(dm_table_head_t *); 307 void dm_table_disksize(dm_table_head_t *, uint64_t *, unsigned *); 308 dm_table_t *dm_table_get_entry(dm_table_head_t *, uint8_t); 309 int dm_table_get_target_count(dm_table_head_t *, uint8_t); 310 void dm_table_release(dm_table_head_t *, uint8_t s); 311 void dm_table_switch_tables(dm_table_head_t *); 312 void dm_table_head_init(dm_table_head_t *); 313 void dm_table_head_destroy(dm_table_head_t *); 314 315 /* dm_dev.c */ 316 dm_dev_t* dm_dev_alloc(void); 317 void dm_dev_busy(dm_dev_t *); 318 int dm_dev_destroy(void); 319 dm_dev_t* dm_dev_detach(device_t); 320 int dm_dev_free(dm_dev_t *); 321 int dm_dev_init(void); 322 int dm_dev_insert(dm_dev_t *); 323 dm_dev_t* dm_dev_lookup(const char *, const char *, int); 324 prop_array_t dm_dev_prop_list(void); 325 dm_dev_t* dm_dev_rem(const char *, const char *, int); 326 /*int dm_dev_test_minor(int);*/ 327 void dm_dev_unbusy(dm_dev_t *); 328 329 /* dm_pdev.c */ 330 int dm_pdev_decr(dm_pdev_t *); 331 int dm_pdev_destroy(void); 332 int dm_pdev_init(void); 333 dm_pdev_t* dm_pdev_insert(const char *); 334 335 #endif /*_KERNEL*/ 336 337 #endif /*_DM_DEV_H_*/ 338
Indexes created Thu Sep 25 14:09:45 GMT 2025