1 /* $NetBSD: device-mapper.c,v 1.22 2010/03/26 15:46:04 jakllsch Exp $ */
4 * Copyright (c) 2010 The NetBSD Foundation, Inc.
7 * This code is derived from software contributed to The NetBSD Foundation
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
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.
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.
33 * I want to say thank you to all people who helped me with this project.
36 #include <sys/types.h>
37 #include <sys/param.h>
41 #include <sys/device.h>
42 #include <sys/devfs.h>
44 #include <sys/disklabel.h>
45 #include <sys/dtype.h>
46 #include <sys/ioccom.h>
47 #include <sys/malloc.h>
48 #include <sys/module.h>
49 #include <sys/sysctl.h>
51 #include "netbsd-dm.h"
54 static d_ioctl_t dmioctl;
55 static d_open_t dmopen;
56 static d_close_t dmclose;
57 static d_psize_t dmsize;
58 static d_strategy_t dmstrategy;
59 static d_dump_t dmdump;
61 /* attach and detach routines */
63 static int dm_modcmd(module_t mod, int cmd, void *unused);
64 static int dmdestroy(void);
66 static void dm_doinit(void);
68 static int dm_cmd_to_fun(prop_dictionary_t);
69 static int disk_ioctl_switch(cdev_t, u_long, void *);
70 static int dm_ioctl_switch(u_long);
72 static void dmminphys(struct buf *);
75 struct devfs_bitmap dm_minor_bitmap;
77 /* ***Variable-definitions*** */
78 struct dev_ops dm_ops = {
79 { "dm", 0, D_DISK | D_MPSAFE },
85 .d_strategy = dmstrategy,
91 MALLOC_DEFINE(M_DM, "dm", "Device Mapper allocations");
93 int dm_debug_level = 0;
95 extern uint64_t dm_dev_counter;
99 static moduledata_t dm_mod = {
104 DECLARE_MODULE(dm, dm_mod, SI_SUB_RAID, SI_ORDER_ANY);
107 * This array is used to translate cmd to function pointer.
109 * Interface between libdevmapper and lvm2tools uses different
110 * names for one IOCTL call because libdevmapper do another thing
111 * then. When I run "info" or "mknodes" libdevmapper will send same
112 * ioctl to kernel but will do another things in userspace.
115 static struct cmd_function cmd_fn[] = {
116 { .cmd = "version", .fn = dm_get_version_ioctl},
117 { .cmd = "targets", .fn = dm_list_versions_ioctl},
118 { .cmd = "create", .fn = dm_dev_create_ioctl},
119 { .cmd = "info", .fn = dm_dev_status_ioctl},
120 { .cmd = "mknodes", .fn = dm_dev_status_ioctl},
121 { .cmd = "names", .fn = dm_dev_list_ioctl},
122 { .cmd = "suspend", .fn = dm_dev_suspend_ioctl},
123 { .cmd = "remove", .fn = dm_dev_remove_ioctl},
124 { .cmd = "rename", .fn = dm_dev_rename_ioctl},
125 { .cmd = "resume", .fn = dm_dev_resume_ioctl},
126 { .cmd = "clear", .fn = dm_table_clear_ioctl},
127 { .cmd = "deps", .fn = dm_table_deps_ioctl},
128 { .cmd = "reload", .fn = dm_table_load_ioctl},
129 { .cmd = "status", .fn = dm_table_status_ioctl},
130 { .cmd = "table", .fn = dm_table_status_ioctl},
134 /* New module handle routine */
136 dm_modcmd(module_t mod, int cmd, void *unused)
138 int error, bmajor, cmajor;
146 devfs_clone_bitmap_init(&dm_minor_bitmap);
148 kprintf("Device Mapper version %d.%d.%d loaded\n",
149 DM_VERSION_MAJOR, DM_VERSION_MINOR, DM_VERSION_PATCHLEVEL);
154 * Disable unloading of dm module if there are any devices
155 * defined in driver. This is probably too strong we need
156 * to disable auto-unload only if there is mounted dm device
159 if (dm_dev_counter > 0)
165 kprintf("Device Mapper unloaded\n");
178 * Autoconfiguration detach function for pseudo-device glue.
179 * This routine is called by dm_ioctl::dm_dev_remove_ioctl and by autoconf to
180 * remove devices created in device-mapper.
183 dm_detach(dm_dev_t *dmv)
187 /* Remove device from list and wait for refcnt to drop to zero */
188 dm_dev_rem(dmv, NULL, NULL, -1);
190 /* Destroy active table first. */
191 dm_table_destroy(&dmv->table_head, DM_TABLE_ACTIVE);
193 /* Destroy inactive table if exits, too. */
194 dm_table_destroy(&dmv->table_head, DM_TABLE_INACTIVE);
196 dm_table_head_destroy(&dmv->table_head);
198 minor = dkunit(dmv->devt);
199 disk_destroy(dmv->diskp);
200 devstat_remove_entry(&dmv->stats);
202 release_dev(dmv->devt);
203 devfs_clone_bitmap_put(&dm_minor_bitmap, minor);
206 (void)dm_dev_free(dmv);
208 /* Decrement device counter After removing device */
209 --dm_dev_counter; /* XXX: was atomic 64 */
220 dmcdev = make_dev(&dm_ops, 0, UID_ROOT, GID_OPERATOR, 0640, "mapper/control");
223 /* Destroy routine */
237 dmopen(struct dev_open_args *ap)
239 cdev_t dev = ap->a_head.a_dev;
242 /* Shortcut for the control device */
246 if ((dmv = dm_dev_lookup(NULL, NULL, minor(dev))) == NULL)
252 aprint_debug("dm open routine called %" PRIu32 "\n",
253 minor(ap->a_head.a_dev));
258 dmclose(struct dev_close_args *ap)
260 cdev_t dev = ap->a_head.a_dev;
263 /* Shortcut for the control device */
267 if ((dmv = dm_dev_lookup(NULL, NULL, minor(dev))) == NULL)
273 aprint_debug("dm close routine called %" PRIu32 "\n",
274 minor(ap->a_head.a_dev));
280 dmioctl(struct dev_ioctl_args *ap)
282 cdev_t dev = ap->a_head.a_dev;
283 u_long cmd = ap->a_cmd;
284 void *data = ap->a_data;
287 prop_dictionary_t dm_dict_in;
291 aprint_debug("dmioctl called\n");
293 KKASSERT(data != NULL);
295 if (( r = disk_ioctl_switch(dev, cmd, data)) == ENOTTY) {
296 struct plistref *pref = (struct plistref *) data;
298 /* Check if we were called with NETBSD_DM_IOCTL ioctl
300 if ((r = dm_ioctl_switch(cmd)) != 0)
303 if((r = prop_dictionary_copyin_ioctl(pref, cmd, &dm_dict_in)) != 0)
306 if ((r = dm_check_version(dm_dict_in)) != 0)
309 /* run ioctl routine */
310 if ((err = dm_cmd_to_fun(dm_dict_in)) != 0)
314 r = prop_dictionary_copyout_ioctl(pref, cmd, dm_dict_in);
315 prop_object_release(dm_dict_in);
319 * Return the error of the actual command if one one has
320 * happened. Otherwise return 'r' which indicates errors
321 * that occurred during helper operations.
323 return (err != 0)?err:r;
327 * Translate command sent from libdevmapper to func.
330 dm_cmd_to_fun(prop_dictionary_t dm_dict){
332 prop_string_t command;
336 if ((command = prop_dictionary_get(dm_dict, DM_IOCTL_COMMAND)) == NULL)
339 for(i = 0; cmd_fn[i].cmd != NULL; i++)
340 if (prop_string_equals_cstring(command, cmd_fn[i].cmd))
343 if (cmd_fn[i].cmd == NULL)
346 aprint_debug("ioctl %s called\n", cmd_fn[i].cmd);
347 r = cmd_fn[i].fn(dm_dict);
352 /* Call apropriate ioctl handler function. */
354 dm_ioctl_switch(u_long cmd)
359 case NETBSD_DM_IOCTL:
360 aprint_debug("dm NetBSD_DM_IOCTL called\n");
363 aprint_debug("dm unknown ioctl called\n");
365 break; /* NOT REACHED */
372 * Check for disk specific ioctls.
376 disk_ioctl_switch(cdev_t dev, u_long cmd, void *data)
380 /* disk ioctls make sense only on block devices */
387 struct partinfo *dpart;
389 dpart = (void *)data;
390 bzero(dpart, sizeof(*dpart));
392 if ((dmv = dm_dev_lookup(NULL, NULL, minor(dev))) == NULL)
394 if (dmv->diskp->d_info.d_media_blksize == 0) {
398 size = dm_table_size(&dmv->table_head);
399 dpart->media_offset = 0;
400 dpart->media_size = size * DEV_BSIZE;
401 dpart->media_blocks = size;
402 dpart->media_blksize = DEV_BSIZE;
403 dpart->fstype = FS_BSDFFS;
410 aprint_debug("unknown disk_ioctl called\n");
412 break; /* NOT REACHED */
419 * Do all IO operations on dm logical devices.
422 dmstrategy(struct dev_strategy_args *ap)
424 cdev_t dev = ap->a_head.a_dev;
425 struct bio *bio = ap->a_bio;
426 struct buf *bp = bio->bio_buf;
431 dm_table_entry_t *table_en;
436 uint64_t buf_start, buf_len, issued_len;
437 uint64_t table_start, table_end;
440 buf_start = bio->bio_offset;
441 buf_len = bp->b_bcount;
449 if ((dmv = dm_dev_lookup(NULL, NULL, minor(dev))) == NULL) {
451 bp->b_resid = bp->b_bcount;
459 case BUF_CMD_FREEBLKS:
464 KKASSERT(buf_len == 0);
469 bp->b_resid = bp->b_bcount;
475 bounds_check_with_mediasize(bio, DEV_BSIZE,
476 dm_table_size(&dmv->table_head)) <= 0) {
478 bp->b_resid = bp->b_bcount;
483 /* Select active table */
484 tbl = dm_table_get_entry(&dmv->table_head, DM_TABLE_ACTIVE);
487 devstat_start_transaction(&dmv->stats);
490 * Find out what tables I want to select.
492 SLIST_FOREACH(table_en, tbl, next) {
494 * I need need number of bytes not blocks.
496 table_start = table_en->start * DEV_BSIZE;
497 table_end = table_start + (table_en->length) * DEV_BSIZE;
500 * Calculate the start and end
502 start = MAX(table_start, buf_start);
503 end = MIN(table_end, buf_start + buf_len);
505 aprint_debug("----------------------------------------\n");
506 aprint_debug("table_start %010" PRIu64", table_end %010"
507 PRIu64 "\n", table_start, table_end);
508 aprint_debug("buf_start %010" PRIu64", buf_len %010"
509 PRIu64"\n", buf_start, buf_len);
510 aprint_debug("start-buf_start %010"PRIu64", end %010"
511 PRIu64"\n", start - buf_start, end);
512 aprint_debug("start %010" PRIu64" , end %010"
513 PRIu64"\n", start, end);
514 aprint_debug("\n----------------------------------------\n");
517 nestbuf = getpbuf(NULL);
518 nestbuf->b_flags |= bio->bio_buf->b_flags & B_HASBOGUS;
520 nestiobuf_add(bio, nestbuf, 0, 0, &dmv->stats);
521 nestbuf->b_bio1.bio_offset = 0;
522 table_en->target->strategy(table_en, nestbuf);
523 } else if (start < end) {
524 nestbuf = getpbuf(NULL);
525 nestbuf->b_flags |= bio->bio_buf->b_flags & B_HASBOGUS;
527 nestiobuf_add(bio, nestbuf,
528 start - buf_start, (end - start),
530 issued_len += end - start;
532 nestbuf->b_bio1.bio_offset = (start - table_start);
533 table_en->target->strategy(table_en, nestbuf);
537 if (issued_len < buf_len)
538 nestiobuf_error(bio, EINVAL);
539 nestiobuf_start(bio);
540 dm_table_release(&dmv->table_head, DM_TABLE_ACTIVE);
547 dmdump(struct dev_dump_args *ap)
549 cdev_t dev = ap->a_head.a_dev;
552 dm_table_entry_t *table_en;
554 uint64_t buf_start, buf_len, issued_len;
555 uint64_t table_start, table_end;
556 uint64_t start, end, data_offset;
561 buf_start = ap->a_offset;
562 buf_len = ap->a_length;
570 if ((dmv = dm_dev_lookup(NULL, NULL, minor(dev))) == NULL) {
574 /* Select active table */
575 tbl = dm_table_get_entry(&dmv->table_head, DM_TABLE_ACTIVE);
579 * Find out what tables I want to select.
581 SLIST_FOREACH(table_en, tbl, next) {
583 * I need need number of bytes not blocks.
585 table_start = table_en->start * DEV_BSIZE;
586 table_end = table_start + (table_en->length) * DEV_BSIZE;
589 * Calculate the start and end
591 start = MAX(table_start, buf_start);
592 end = MIN(table_end, buf_start + buf_len);
594 if (ap->a_length == 0) {
595 if (table_en->target->dump == NULL) {
600 table_en->target->dump(table_en, NULL, 0, 0);
601 } else if (start < end) {
602 data_offset = start - buf_start;
603 offset = start - table_start;
604 length = end - start;
606 if (table_en->target->dump == NULL) {
611 table_en->target->dump(table_en,
612 (char *)ap->a_virtual + data_offset,
615 issued_len += end - start;
619 if (issued_len < buf_len)
623 dm_table_release(&dmv->table_head, DM_TABLE_ACTIVE);
630 dmsize(struct dev_psize_args *ap)
632 cdev_t dev = ap->a_head.a_dev;
638 if ((dmv = dm_dev_lookup(NULL, NULL, minor(dev))) == NULL)
641 size = dm_table_size(&dmv->table_head);
644 ap->a_result = (int64_t)size;
651 dmminphys(struct buf *bp)
654 bp->b_bcount = MIN(bp->b_bcount, MAXPHYS);
659 dmsetdiskinfo(struct disk *disk, dm_table_head_t *head)
661 struct disk_info info;
664 dmp_size = dm_table_size(head);
666 bzero(&info, sizeof(struct disk_info));
667 info.d_media_blksize = DEV_BSIZE;
668 info.d_media_blocks = dmp_size;
670 /* this is set by disk_setdiskinfo */
671 info.d_media_size = dmp_size * DEV_BSIZE;
673 info.d_dsflags = DSO_MBRQUIET | DSO_DEVICEMAPPER;
675 info.d_secpertrack = 32;
677 info.d_secpercyl = info.d_secpertrack * info.d_nheads;
678 info.d_ncylinders = dmp_size / info.d_secpercyl;
680 disk_setdiskinfo(disk, &info);
683 TUNABLE_INT("debug.dm_debug", &dm_debug_level);
684 SYSCTL_INT(_debug, OID_AUTO, dm_debug, CTLFLAG_RW, &dm_debug_level,
685 0, "Eanble device mapper debugging");