2 * Copyright (C) 2001 Sistina Software (UK) Limited.
3 * Copyright (C) 2004 Red Hat, Inc. All rights reserved.
5 * This file is released under the GPL.
10 #include <linux/module.h>
11 #include <linux/vmalloc.h>
12 #include <linux/blkdev.h>
13 #include <linux/namei.h>
14 #include <linux/ctype.h>
15 #include <linux/slab.h>
16 #include <linux/interrupt.h>
17 #include <linux/mutex.h>
18 #include <asm/atomic.h>
20 #define DM_MSG_PREFIX "table"
23 #define NODE_SIZE L1_CACHE_BYTES
24 #define KEYS_PER_NODE (NODE_SIZE / sizeof(sector_t))
25 #define CHILDREN_PER_NODE (KEYS_PER_NODE + 1)
28 struct mapped_device *md;
33 unsigned int counts[MAX_DEPTH]; /* in nodes */
34 sector_t *index[MAX_DEPTH];
36 unsigned int num_targets;
37 unsigned int num_allocated;
39 struct dm_target *targets;
42 * Indicates the rw permissions for the new logical
43 * device. This should be a combination of FMODE_READ
48 /* a list of devices used by this table */
49 struct list_head devices;
52 * These are optimistic limits taken from all the
53 * targets, some targets will need smaller limits.
55 struct io_restrictions limits;
57 /* events get handed up using this callback */
58 void (*event_fn)(void *);
63 * Similar to ceiling(log_size(n))
65 static unsigned int int_log(unsigned int n, unsigned int base)
70 n = dm_div_up(n, base);
78 * Returns the minimum that is _not_ zero, unless both are zero.
80 #define min_not_zero(l, r) (l == 0) ? r : ((r == 0) ? l : min(l, r))
83 * Combine two io_restrictions, always taking the lower value.
85 static void combine_restrictions_low(struct io_restrictions *lhs,
86 struct io_restrictions *rhs)
89 min_not_zero(lhs->max_sectors, rhs->max_sectors);
91 lhs->max_phys_segments =
92 min_not_zero(lhs->max_phys_segments, rhs->max_phys_segments);
94 lhs->max_hw_segments =
95 min_not_zero(lhs->max_hw_segments, rhs->max_hw_segments);
97 lhs->hardsect_size = max(lhs->hardsect_size, rhs->hardsect_size);
99 lhs->max_segment_size =
100 min_not_zero(lhs->max_segment_size, rhs->max_segment_size);
102 lhs->max_hw_sectors =
103 min_not_zero(lhs->max_hw_sectors, rhs->max_hw_sectors);
105 lhs->seg_boundary_mask =
106 min_not_zero(lhs->seg_boundary_mask, rhs->seg_boundary_mask);
108 lhs->bounce_pfn = min_not_zero(lhs->bounce_pfn, rhs->bounce_pfn);
110 lhs->no_cluster |= rhs->no_cluster;
114 * Calculate the index of the child node of the n'th node k'th key.
116 static inline unsigned int get_child(unsigned int n, unsigned int k)
118 return (n * CHILDREN_PER_NODE) + k;
122 * Return the n'th node of level l from table t.
124 static inline sector_t *get_node(struct dm_table *t,
125 unsigned int l, unsigned int n)
127 return t->index[l] + (n * KEYS_PER_NODE);
131 * Return the highest key that you could lookup from the n'th
132 * node on level l of the btree.
134 static sector_t high(struct dm_table *t, unsigned int l, unsigned int n)
136 for (; l < t->depth - 1; l++)
137 n = get_child(n, CHILDREN_PER_NODE - 1);
139 if (n >= t->counts[l])
140 return (sector_t) - 1;
142 return get_node(t, l, n)[KEYS_PER_NODE - 1];
146 * Fills in a level of the btree based on the highs of the level
149 static int setup_btree_index(unsigned int l, struct dm_table *t)
154 for (n = 0U; n < t->counts[l]; n++) {
155 node = get_node(t, l, n);
157 for (k = 0U; k < KEYS_PER_NODE; k++)
158 node[k] = high(t, l + 1, get_child(n, k));
164 void *dm_vcalloc(unsigned long nmemb, unsigned long elem_size)
170 * Check that we're not going to overflow.
172 if (nmemb > (ULONG_MAX / elem_size))
175 size = nmemb * elem_size;
176 addr = vmalloc(size);
178 memset(addr, 0, size);
184 * highs, and targets are managed as dynamic arrays during a
187 static int alloc_targets(struct dm_table *t, unsigned int num)
190 struct dm_target *n_targets;
191 int n = t->num_targets;
194 * Allocate both the target array and offset array at once.
195 * Append an empty entry to catch sectors beyond the end of
198 n_highs = (sector_t *) dm_vcalloc(num + 1, sizeof(struct dm_target) +
203 n_targets = (struct dm_target *) (n_highs + num);
206 memcpy(n_highs, t->highs, sizeof(*n_highs) * n);
207 memcpy(n_targets, t->targets, sizeof(*n_targets) * n);
210 memset(n_highs + n, -1, sizeof(*n_highs) * (num - n));
213 t->num_allocated = num;
215 t->targets = n_targets;
220 int dm_table_create(struct dm_table **result, fmode_t mode,
221 unsigned num_targets, struct mapped_device *md)
223 struct dm_table *t = kzalloc(sizeof(*t), GFP_KERNEL);
228 INIT_LIST_HEAD(&t->devices);
229 atomic_set(&t->holders, 1);
232 num_targets = KEYS_PER_NODE;
234 num_targets = dm_round_up(num_targets, KEYS_PER_NODE);
236 if (alloc_targets(t, num_targets)) {
248 static void free_devices(struct list_head *devices)
250 struct list_head *tmp, *next;
252 list_for_each_safe(tmp, next, devices) {
253 struct dm_dev_internal *dd =
254 list_entry(tmp, struct dm_dev_internal, list);
259 static void table_destroy(struct dm_table *t)
263 /* free the indexes (see dm_table_complete) */
265 vfree(t->index[t->depth - 2]);
267 /* free the targets */
268 for (i = 0; i < t->num_targets; i++) {
269 struct dm_target *tgt = t->targets + i;
274 dm_put_target_type(tgt->type);
279 /* free the device list */
280 if (t->devices.next != &t->devices) {
281 DMWARN("devices still present during destroy: "
282 "dm_table_remove_device calls missing");
284 free_devices(&t->devices);
290 void dm_table_get(struct dm_table *t)
292 atomic_inc(&t->holders);
295 void dm_table_put(struct dm_table *t)
300 if (atomic_dec_and_test(&t->holders))
305 * Checks to see if we need to extend highs or targets.
307 static inline int check_space(struct dm_table *t)
309 if (t->num_targets >= t->num_allocated)
310 return alloc_targets(t, t->num_allocated * 2);
316 * See if we've already got a device in the list.
318 static struct dm_dev_internal *find_device(struct list_head *l, dev_t dev)
320 struct dm_dev_internal *dd;
322 list_for_each_entry (dd, l, list)
323 if (dd->dm_dev.bdev->bd_dev == dev)
330 * Open a device so we can use it as a map destination.
332 static int open_dev(struct dm_dev_internal *d, dev_t dev,
333 struct mapped_device *md)
335 static char *_claim_ptr = "I belong to device-mapper";
336 struct block_device *bdev;
340 BUG_ON(d->dm_dev.bdev);
342 bdev = open_by_devnum(dev, d->dm_dev.mode);
344 return PTR_ERR(bdev);
345 r = bd_claim_by_disk(bdev, _claim_ptr, dm_disk(md));
347 blkdev_put(bdev, d->dm_dev.mode);
349 d->dm_dev.bdev = bdev;
354 * Close a device that we've been using.
356 static void close_dev(struct dm_dev_internal *d, struct mapped_device *md)
361 bd_release_from_disk(d->dm_dev.bdev, dm_disk(md));
362 blkdev_put(d->dm_dev.bdev, d->dm_dev.mode);
363 d->dm_dev.bdev = NULL;
367 * If possible, this checks an area of a destination device is valid.
369 static int check_device_area(struct dm_dev_internal *dd, sector_t start,
372 sector_t dev_size = dd->dm_dev.bdev->bd_inode->i_size >> SECTOR_SHIFT;
377 return ((start < dev_size) && (len <= (dev_size - start)));
381 * This upgrades the mode on an already open dm_dev. Being
382 * careful to leave things as they were if we fail to reopen the
385 static int upgrade_mode(struct dm_dev_internal *dd, fmode_t new_mode,
386 struct mapped_device *md)
389 struct dm_dev_internal dd_copy;
390 dev_t dev = dd->dm_dev.bdev->bd_dev;
394 dd->dm_dev.mode |= new_mode;
395 dd->dm_dev.bdev = NULL;
396 r = open_dev(dd, dev, md);
398 close_dev(&dd_copy, md);
406 * Add a device to the list, or just increment the usage count if
407 * it's already present.
409 static int __table_get_device(struct dm_table *t, struct dm_target *ti,
410 const char *path, sector_t start, sector_t len,
411 fmode_t mode, struct dm_dev **result)
414 dev_t uninitialized_var(dev);
415 struct dm_dev_internal *dd;
416 unsigned int major, minor;
420 if (sscanf(path, "%u:%u", &major, &minor) == 2) {
421 /* Extract the major/minor numbers */
422 dev = MKDEV(major, minor);
423 if (MAJOR(dev) != major || MINOR(dev) != minor)
426 /* convert the path to a device */
427 struct block_device *bdev = lookup_bdev(path);
430 return PTR_ERR(bdev);
435 dd = find_device(&t->devices, dev);
437 dd = kmalloc(sizeof(*dd), GFP_KERNEL);
441 dd->dm_dev.mode = mode;
442 dd->dm_dev.bdev = NULL;
444 if ((r = open_dev(dd, dev, t->md))) {
449 format_dev_t(dd->dm_dev.name, dev);
451 atomic_set(&dd->count, 0);
452 list_add(&dd->list, &t->devices);
454 } else if (dd->dm_dev.mode != (mode | dd->dm_dev.mode)) {
455 r = upgrade_mode(dd, mode, t->md);
459 atomic_inc(&dd->count);
461 if (!check_device_area(dd, start, len)) {
462 DMWARN("device %s too small for target", path);
463 dm_put_device(ti, &dd->dm_dev);
467 *result = &dd->dm_dev;
472 void dm_set_device_limits(struct dm_target *ti, struct block_device *bdev)
474 struct request_queue *q = bdev_get_queue(bdev);
475 struct io_restrictions *rs = &ti->limits;
476 char b[BDEVNAME_SIZE];
479 DMWARN("%s: Cannot set limits for nonexistent device %s",
480 dm_device_name(ti->table->md), bdevname(bdev, b));
485 * Combine the device limits low.
487 * FIXME: if we move an io_restriction struct
488 * into q this would just be a call to
489 * combine_restrictions_low()
492 min_not_zero(rs->max_sectors, q->max_sectors);
495 * Check if merge fn is supported.
496 * If not we'll force DM to use PAGE_SIZE or
497 * smaller I/O, just to be safe.
500 if (q->merge_bvec_fn && !ti->type->merge)
502 min_not_zero(rs->max_sectors,
503 (unsigned int) (PAGE_SIZE >> 9));
505 rs->max_phys_segments =
506 min_not_zero(rs->max_phys_segments,
507 q->max_phys_segments);
509 rs->max_hw_segments =
510 min_not_zero(rs->max_hw_segments, q->max_hw_segments);
512 rs->hardsect_size = max(rs->hardsect_size, q->hardsect_size);
514 rs->max_segment_size =
515 min_not_zero(rs->max_segment_size, q->max_segment_size);
518 min_not_zero(rs->max_hw_sectors, q->max_hw_sectors);
520 rs->seg_boundary_mask =
521 min_not_zero(rs->seg_boundary_mask,
522 q->seg_boundary_mask);
524 rs->bounce_pfn = min_not_zero(rs->bounce_pfn, q->bounce_pfn);
526 rs->no_cluster |= !test_bit(QUEUE_FLAG_CLUSTER, &q->queue_flags);
528 EXPORT_SYMBOL_GPL(dm_set_device_limits);
530 int dm_get_device(struct dm_target *ti, const char *path, sector_t start,
531 sector_t len, fmode_t mode, struct dm_dev **result)
533 int r = __table_get_device(ti->table, ti, path,
534 start, len, mode, result);
537 dm_set_device_limits(ti, (*result)->bdev);
543 * Decrement a devices use count and remove it if necessary.
545 void dm_put_device(struct dm_target *ti, struct dm_dev *d)
547 struct dm_dev_internal *dd = container_of(d, struct dm_dev_internal,
550 if (atomic_dec_and_test(&dd->count)) {
551 close_dev(dd, ti->table->md);
558 * Checks to see if the target joins onto the end of the table.
560 static int adjoin(struct dm_table *table, struct dm_target *ti)
562 struct dm_target *prev;
564 if (!table->num_targets)
567 prev = &table->targets[table->num_targets - 1];
568 return (ti->begin == (prev->begin + prev->len));
572 * Used to dynamically allocate the arg array.
574 static char **realloc_argv(unsigned *array_size, char **old_argv)
579 new_size = *array_size ? *array_size * 2 : 64;
580 argv = kmalloc(new_size * sizeof(*argv), GFP_KERNEL);
582 memcpy(argv, old_argv, *array_size * sizeof(*argv));
583 *array_size = new_size;
591 * Destructively splits up the argument list to pass to ctr.
593 int dm_split_args(int *argc, char ***argvp, char *input)
595 char *start, *end = input, *out, **argv = NULL;
596 unsigned array_size = 0;
605 argv = realloc_argv(&array_size, argv);
612 /* Skip whitespace */
613 while (*start && isspace(*start))
617 break; /* success, we hit the end */
619 /* 'out' is used to remove any back-quotes */
622 /* Everything apart from '\0' can be quoted */
623 if (*end == '\\' && *(end + 1)) {
630 break; /* end of token */
635 /* have we already filled the array ? */
636 if ((*argc + 1) > array_size) {
637 argv = realloc_argv(&array_size, argv);
642 /* we know this is whitespace */
646 /* terminate the string and put it in the array */
656 static void check_for_valid_limits(struct io_restrictions *rs)
658 if (!rs->max_sectors)
659 rs->max_sectors = SAFE_MAX_SECTORS;
660 if (!rs->max_hw_sectors)
661 rs->max_hw_sectors = SAFE_MAX_SECTORS;
662 if (!rs->max_phys_segments)
663 rs->max_phys_segments = MAX_PHYS_SEGMENTS;
664 if (!rs->max_hw_segments)
665 rs->max_hw_segments = MAX_HW_SEGMENTS;
666 if (!rs->hardsect_size)
667 rs->hardsect_size = 1 << SECTOR_SHIFT;
668 if (!rs->max_segment_size)
669 rs->max_segment_size = MAX_SEGMENT_SIZE;
670 if (!rs->seg_boundary_mask)
671 rs->seg_boundary_mask = -1;
676 int dm_table_add_target(struct dm_table *t, const char *type,
677 sector_t start, sector_t len, char *params)
679 int r = -EINVAL, argc;
681 struct dm_target *tgt;
683 if ((r = check_space(t)))
686 tgt = t->targets + t->num_targets;
687 memset(tgt, 0, sizeof(*tgt));
690 DMERR("%s: zero-length target", dm_device_name(t->md));
694 tgt->type = dm_get_target_type(type);
696 DMERR("%s: %s: unknown target type", dm_device_name(t->md),
704 tgt->error = "Unknown error";
707 * Does this target adjoin the previous one ?
709 if (!adjoin(t, tgt)) {
710 tgt->error = "Gap in table";
715 r = dm_split_args(&argc, &argv, params);
717 tgt->error = "couldn't split parameters (insufficient memory)";
721 r = tgt->type->ctr(tgt, argc, argv);
726 t->highs[t->num_targets++] = tgt->begin + tgt->len - 1;
728 /* FIXME: the plan is to combine high here and then have
729 * the merge fn apply the target level restrictions. */
730 combine_restrictions_low(&t->limits, &tgt->limits);
734 DMERR("%s: %s: %s", dm_device_name(t->md), type, tgt->error);
735 dm_put_target_type(tgt->type);
739 static int setup_indexes(struct dm_table *t)
742 unsigned int total = 0;
745 /* allocate the space for *all* the indexes */
746 for (i = t->depth - 2; i >= 0; i--) {
747 t->counts[i] = dm_div_up(t->counts[i + 1], CHILDREN_PER_NODE);
748 total += t->counts[i];
751 indexes = (sector_t *) dm_vcalloc(total, (unsigned long) NODE_SIZE);
755 /* set up internal nodes, bottom-up */
756 for (i = t->depth - 2; i >= 0; i--) {
757 t->index[i] = indexes;
758 indexes += (KEYS_PER_NODE * t->counts[i]);
759 setup_btree_index(i, t);
766 * Builds the btree to index the map.
768 int dm_table_complete(struct dm_table *t)
771 unsigned int leaf_nodes;
773 check_for_valid_limits(&t->limits);
775 /* how many indexes will the btree have ? */
776 leaf_nodes = dm_div_up(t->num_targets, KEYS_PER_NODE);
777 t->depth = 1 + int_log(leaf_nodes, CHILDREN_PER_NODE);
779 /* leaf layer has already been set up */
780 t->counts[t->depth - 1] = leaf_nodes;
781 t->index[t->depth - 1] = t->highs;
784 r = setup_indexes(t);
789 static DEFINE_MUTEX(_event_lock);
790 void dm_table_event_callback(struct dm_table *t,
791 void (*fn)(void *), void *context)
793 mutex_lock(&_event_lock);
795 t->event_context = context;
796 mutex_unlock(&_event_lock);
799 void dm_table_event(struct dm_table *t)
802 * You can no longer call dm_table_event() from interrupt
803 * context, use a bottom half instead.
805 BUG_ON(in_interrupt());
807 mutex_lock(&_event_lock);
809 t->event_fn(t->event_context);
810 mutex_unlock(&_event_lock);
813 sector_t dm_table_get_size(struct dm_table *t)
815 return t->num_targets ? (t->highs[t->num_targets - 1] + 1) : 0;
818 struct dm_target *dm_table_get_target(struct dm_table *t, unsigned int index)
820 if (index >= t->num_targets)
823 return t->targets + index;
827 * Search the btree for the correct target.
829 * Caller should check returned pointer with dm_target_is_valid()
830 * to trap I/O beyond end of device.
832 struct dm_target *dm_table_find_target(struct dm_table *t, sector_t sector)
834 unsigned int l, n = 0, k = 0;
837 for (l = 0; l < t->depth; l++) {
839 node = get_node(t, l, n);
841 for (k = 0; k < KEYS_PER_NODE; k++)
842 if (node[k] >= sector)
846 return &t->targets[(KEYS_PER_NODE * n) + k];
849 void dm_table_set_restrictions(struct dm_table *t, struct request_queue *q)
852 * Make sure we obey the optimistic sub devices
855 blk_queue_max_sectors(q, t->limits.max_sectors);
856 q->max_phys_segments = t->limits.max_phys_segments;
857 q->max_hw_segments = t->limits.max_hw_segments;
858 q->hardsect_size = t->limits.hardsect_size;
859 q->max_segment_size = t->limits.max_segment_size;
860 q->max_hw_sectors = t->limits.max_hw_sectors;
861 q->seg_boundary_mask = t->limits.seg_boundary_mask;
862 q->bounce_pfn = t->limits.bounce_pfn;
864 if (t->limits.no_cluster)
865 queue_flag_clear_unlocked(QUEUE_FLAG_CLUSTER, q);
867 queue_flag_set_unlocked(QUEUE_FLAG_CLUSTER, q);
871 unsigned int dm_table_get_num_targets(struct dm_table *t)
873 return t->num_targets;
876 struct list_head *dm_table_get_devices(struct dm_table *t)
881 fmode_t dm_table_get_mode(struct dm_table *t)
886 static void suspend_targets(struct dm_table *t, unsigned postsuspend)
888 int i = t->num_targets;
889 struct dm_target *ti = t->targets;
893 if (ti->type->postsuspend)
894 ti->type->postsuspend(ti);
895 } else if (ti->type->presuspend)
896 ti->type->presuspend(ti);
902 void dm_table_presuspend_targets(struct dm_table *t)
907 suspend_targets(t, 0);
910 void dm_table_postsuspend_targets(struct dm_table *t)
915 suspend_targets(t, 1);
918 int dm_table_resume_targets(struct dm_table *t)
922 for (i = 0; i < t->num_targets; i++) {
923 struct dm_target *ti = t->targets + i;
925 if (!ti->type->preresume)
928 r = ti->type->preresume(ti);
933 for (i = 0; i < t->num_targets; i++) {
934 struct dm_target *ti = t->targets + i;
936 if (ti->type->resume)
937 ti->type->resume(ti);
943 int dm_table_any_congested(struct dm_table *t, int bdi_bits)
945 struct dm_dev_internal *dd;
946 struct list_head *devices = dm_table_get_devices(t);
949 list_for_each_entry(dd, devices, list) {
950 struct request_queue *q = bdev_get_queue(dd->dm_dev.bdev);
951 char b[BDEVNAME_SIZE];
954 r |= bdi_congested(&q->backing_dev_info, bdi_bits);
956 DMWARN_LIMIT("%s: any_congested: nonexistent device %s",
957 dm_device_name(t->md),
958 bdevname(dd->dm_dev.bdev, b));
964 void dm_table_unplug_all(struct dm_table *t)
966 struct dm_dev_internal *dd;
967 struct list_head *devices = dm_table_get_devices(t);
969 list_for_each_entry(dd, devices, list) {
970 struct request_queue *q = bdev_get_queue(dd->dm_dev.bdev);
971 char b[BDEVNAME_SIZE];
976 DMWARN_LIMIT("%s: Cannot unplug nonexistent device %s",
977 dm_device_name(t->md),
978 bdevname(dd->dm_dev.bdev, b));
982 struct mapped_device *dm_table_get_md(struct dm_table *t)
989 EXPORT_SYMBOL(dm_vcalloc);
990 EXPORT_SYMBOL(dm_get_device);
991 EXPORT_SYMBOL(dm_put_device);
992 EXPORT_SYMBOL(dm_table_event);
993 EXPORT_SYMBOL(dm_table_get_size);
994 EXPORT_SYMBOL(dm_table_get_mode);
995 EXPORT_SYMBOL(dm_table_get_md);
996 EXPORT_SYMBOL(dm_table_put);
997 EXPORT_SYMBOL(dm_table_get);
998 EXPORT_SYMBOL(dm_table_unplug_all);