dm: rename dm_suspended to dm_suspended_md
[safe/jmp/linux-2.6] / drivers / md / dm-table.c
1 /*
2  * Copyright (C) 2001 Sistina Software (UK) Limited.
3  * Copyright (C) 2004-2008 Red Hat, Inc. All rights reserved.
4  *
5  * This file is released under the GPL.
6  */
7
8 #include "dm.h"
9
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 <linux/delay.h>
19 #include <asm/atomic.h>
20
21 #define DM_MSG_PREFIX "table"
22
23 #define MAX_DEPTH 16
24 #define NODE_SIZE L1_CACHE_BYTES
25 #define KEYS_PER_NODE (NODE_SIZE / sizeof(sector_t))
26 #define CHILDREN_PER_NODE (KEYS_PER_NODE + 1)
27
28 /*
29  * The table has always exactly one reference from either mapped_device->map
30  * or hash_cell->new_map. This reference is not counted in table->holders.
31  * A pair of dm_create_table/dm_destroy_table functions is used for table
32  * creation/destruction.
33  *
34  * Temporary references from the other code increase table->holders. A pair
35  * of dm_table_get/dm_table_put functions is used to manipulate it.
36  *
37  * When the table is about to be destroyed, we wait for table->holders to
38  * drop to zero.
39  */
40
41 struct dm_table {
42         struct mapped_device *md;
43         atomic_t holders;
44         unsigned type;
45
46         /* btree table */
47         unsigned int depth;
48         unsigned int counts[MAX_DEPTH]; /* in nodes */
49         sector_t *index[MAX_DEPTH];
50
51         unsigned int num_targets;
52         unsigned int num_allocated;
53         sector_t *highs;
54         struct dm_target *targets;
55
56         /*
57          * Indicates the rw permissions for the new logical
58          * device.  This should be a combination of FMODE_READ
59          * and FMODE_WRITE.
60          */
61         fmode_t mode;
62
63         /* a list of devices used by this table */
64         struct list_head devices;
65
66         /* events get handed up using this callback */
67         void (*event_fn)(void *);
68         void *event_context;
69
70         struct dm_md_mempools *mempools;
71 };
72
73 /*
74  * Similar to ceiling(log_size(n))
75  */
76 static unsigned int int_log(unsigned int n, unsigned int base)
77 {
78         int result = 0;
79
80         while (n > 1) {
81                 n = dm_div_up(n, base);
82                 result++;
83         }
84
85         return result;
86 }
87
88 /*
89  * Calculate the index of the child node of the n'th node k'th key.
90  */
91 static inline unsigned int get_child(unsigned int n, unsigned int k)
92 {
93         return (n * CHILDREN_PER_NODE) + k;
94 }
95
96 /*
97  * Return the n'th node of level l from table t.
98  */
99 static inline sector_t *get_node(struct dm_table *t,
100                                  unsigned int l, unsigned int n)
101 {
102         return t->index[l] + (n * KEYS_PER_NODE);
103 }
104
105 /*
106  * Return the highest key that you could lookup from the n'th
107  * node on level l of the btree.
108  */
109 static sector_t high(struct dm_table *t, unsigned int l, unsigned int n)
110 {
111         for (; l < t->depth - 1; l++)
112                 n = get_child(n, CHILDREN_PER_NODE - 1);
113
114         if (n >= t->counts[l])
115                 return (sector_t) - 1;
116
117         return get_node(t, l, n)[KEYS_PER_NODE - 1];
118 }
119
120 /*
121  * Fills in a level of the btree based on the highs of the level
122  * below it.
123  */
124 static int setup_btree_index(unsigned int l, struct dm_table *t)
125 {
126         unsigned int n, k;
127         sector_t *node;
128
129         for (n = 0U; n < t->counts[l]; n++) {
130                 node = get_node(t, l, n);
131
132                 for (k = 0U; k < KEYS_PER_NODE; k++)
133                         node[k] = high(t, l + 1, get_child(n, k));
134         }
135
136         return 0;
137 }
138
139 void *dm_vcalloc(unsigned long nmemb, unsigned long elem_size)
140 {
141         unsigned long size;
142         void *addr;
143
144         /*
145          * Check that we're not going to overflow.
146          */
147         if (nmemb > (ULONG_MAX / elem_size))
148                 return NULL;
149
150         size = nmemb * elem_size;
151         addr = vmalloc(size);
152         if (addr)
153                 memset(addr, 0, size);
154
155         return addr;
156 }
157
158 /*
159  * highs, and targets are managed as dynamic arrays during a
160  * table load.
161  */
162 static int alloc_targets(struct dm_table *t, unsigned int num)
163 {
164         sector_t *n_highs;
165         struct dm_target *n_targets;
166         int n = t->num_targets;
167
168         /*
169          * Allocate both the target array and offset array at once.
170          * Append an empty entry to catch sectors beyond the end of
171          * the device.
172          */
173         n_highs = (sector_t *) dm_vcalloc(num + 1, sizeof(struct dm_target) +
174                                           sizeof(sector_t));
175         if (!n_highs)
176                 return -ENOMEM;
177
178         n_targets = (struct dm_target *) (n_highs + num);
179
180         if (n) {
181                 memcpy(n_highs, t->highs, sizeof(*n_highs) * n);
182                 memcpy(n_targets, t->targets, sizeof(*n_targets) * n);
183         }
184
185         memset(n_highs + n, -1, sizeof(*n_highs) * (num - n));
186         vfree(t->highs);
187
188         t->num_allocated = num;
189         t->highs = n_highs;
190         t->targets = n_targets;
191
192         return 0;
193 }
194
195 int dm_table_create(struct dm_table **result, fmode_t mode,
196                     unsigned num_targets, struct mapped_device *md)
197 {
198         struct dm_table *t = kzalloc(sizeof(*t), GFP_KERNEL);
199
200         if (!t)
201                 return -ENOMEM;
202
203         INIT_LIST_HEAD(&t->devices);
204         atomic_set(&t->holders, 0);
205
206         if (!num_targets)
207                 num_targets = KEYS_PER_NODE;
208
209         num_targets = dm_round_up(num_targets, KEYS_PER_NODE);
210
211         if (alloc_targets(t, num_targets)) {
212                 kfree(t);
213                 t = NULL;
214                 return -ENOMEM;
215         }
216
217         t->mode = mode;
218         t->md = md;
219         *result = t;
220         return 0;
221 }
222
223 static void free_devices(struct list_head *devices)
224 {
225         struct list_head *tmp, *next;
226
227         list_for_each_safe(tmp, next, devices) {
228                 struct dm_dev_internal *dd =
229                     list_entry(tmp, struct dm_dev_internal, list);
230                 DMWARN("dm_table_destroy: dm_put_device call missing for %s",
231                        dd->dm_dev.name);
232                 kfree(dd);
233         }
234 }
235
236 void dm_table_destroy(struct dm_table *t)
237 {
238         unsigned int i;
239
240         if (!t)
241                 return;
242
243         while (atomic_read(&t->holders))
244                 msleep(1);
245         smp_mb();
246
247         /* free the indexes (see dm_table_complete) */
248         if (t->depth >= 2)
249                 vfree(t->index[t->depth - 2]);
250
251         /* free the targets */
252         for (i = 0; i < t->num_targets; i++) {
253                 struct dm_target *tgt = t->targets + i;
254
255                 if (tgt->type->dtr)
256                         tgt->type->dtr(tgt);
257
258                 dm_put_target_type(tgt->type);
259         }
260
261         vfree(t->highs);
262
263         /* free the device list */
264         if (t->devices.next != &t->devices)
265                 free_devices(&t->devices);
266
267         dm_free_md_mempools(t->mempools);
268
269         kfree(t);
270 }
271
272 void dm_table_get(struct dm_table *t)
273 {
274         atomic_inc(&t->holders);
275 }
276
277 void dm_table_put(struct dm_table *t)
278 {
279         if (!t)
280                 return;
281
282         smp_mb__before_atomic_dec();
283         atomic_dec(&t->holders);
284 }
285
286 /*
287  * Checks to see if we need to extend highs or targets.
288  */
289 static inline int check_space(struct dm_table *t)
290 {
291         if (t->num_targets >= t->num_allocated)
292                 return alloc_targets(t, t->num_allocated * 2);
293
294         return 0;
295 }
296
297 /*
298  * See if we've already got a device in the list.
299  */
300 static struct dm_dev_internal *find_device(struct list_head *l, dev_t dev)
301 {
302         struct dm_dev_internal *dd;
303
304         list_for_each_entry (dd, l, list)
305                 if (dd->dm_dev.bdev->bd_dev == dev)
306                         return dd;
307
308         return NULL;
309 }
310
311 /*
312  * Open a device so we can use it as a map destination.
313  */
314 static int open_dev(struct dm_dev_internal *d, dev_t dev,
315                     struct mapped_device *md)
316 {
317         static char *_claim_ptr = "I belong to device-mapper";
318         struct block_device *bdev;
319
320         int r;
321
322         BUG_ON(d->dm_dev.bdev);
323
324         bdev = open_by_devnum(dev, d->dm_dev.mode);
325         if (IS_ERR(bdev))
326                 return PTR_ERR(bdev);
327         r = bd_claim_by_disk(bdev, _claim_ptr, dm_disk(md));
328         if (r)
329                 blkdev_put(bdev, d->dm_dev.mode);
330         else
331                 d->dm_dev.bdev = bdev;
332         return r;
333 }
334
335 /*
336  * Close a device that we've been using.
337  */
338 static void close_dev(struct dm_dev_internal *d, struct mapped_device *md)
339 {
340         if (!d->dm_dev.bdev)
341                 return;
342
343         bd_release_from_disk(d->dm_dev.bdev, dm_disk(md));
344         blkdev_put(d->dm_dev.bdev, d->dm_dev.mode);
345         d->dm_dev.bdev = NULL;
346 }
347
348 /*
349  * If possible, this checks an area of a destination device is invalid.
350  */
351 static int device_area_is_invalid(struct dm_target *ti, struct dm_dev *dev,
352                                   sector_t start, sector_t len, void *data)
353 {
354         struct queue_limits *limits = data;
355         struct block_device *bdev = dev->bdev;
356         sector_t dev_size =
357                 i_size_read(bdev->bd_inode) >> SECTOR_SHIFT;
358         unsigned short logical_block_size_sectors =
359                 limits->logical_block_size >> SECTOR_SHIFT;
360         char b[BDEVNAME_SIZE];
361
362         if (!dev_size)
363                 return 0;
364
365         if ((start >= dev_size) || (start + len > dev_size)) {
366                 DMWARN("%s: %s too small for target: "
367                        "start=%llu, len=%llu, dev_size=%llu",
368                        dm_device_name(ti->table->md), bdevname(bdev, b),
369                        (unsigned long long)start,
370                        (unsigned long long)len,
371                        (unsigned long long)dev_size);
372                 return 1;
373         }
374
375         if (logical_block_size_sectors <= 1)
376                 return 0;
377
378         if (start & (logical_block_size_sectors - 1)) {
379                 DMWARN("%s: start=%llu not aligned to h/w "
380                        "logical block size %u of %s",
381                        dm_device_name(ti->table->md),
382                        (unsigned long long)start,
383                        limits->logical_block_size, bdevname(bdev, b));
384                 return 1;
385         }
386
387         if (len & (logical_block_size_sectors - 1)) {
388                 DMWARN("%s: len=%llu not aligned to h/w "
389                        "logical block size %u of %s",
390                        dm_device_name(ti->table->md),
391                        (unsigned long long)len,
392                        limits->logical_block_size, bdevname(bdev, b));
393                 return 1;
394         }
395
396         return 0;
397 }
398
399 /*
400  * This upgrades the mode on an already open dm_dev, being
401  * careful to leave things as they were if we fail to reopen the
402  * device and not to touch the existing bdev field in case
403  * it is accessed concurrently inside dm_table_any_congested().
404  */
405 static int upgrade_mode(struct dm_dev_internal *dd, fmode_t new_mode,
406                         struct mapped_device *md)
407 {
408         int r;
409         struct dm_dev_internal dd_new, dd_old;
410
411         dd_new = dd_old = *dd;
412
413         dd_new.dm_dev.mode |= new_mode;
414         dd_new.dm_dev.bdev = NULL;
415
416         r = open_dev(&dd_new, dd->dm_dev.bdev->bd_dev, md);
417         if (r)
418                 return r;
419
420         dd->dm_dev.mode |= new_mode;
421         close_dev(&dd_old, md);
422
423         return 0;
424 }
425
426 /*
427  * Add a device to the list, or just increment the usage count if
428  * it's already present.
429  */
430 static int __table_get_device(struct dm_table *t, struct dm_target *ti,
431                               const char *path, sector_t start, sector_t len,
432                               fmode_t mode, struct dm_dev **result)
433 {
434         int r;
435         dev_t uninitialized_var(dev);
436         struct dm_dev_internal *dd;
437         unsigned int major, minor;
438
439         BUG_ON(!t);
440
441         if (sscanf(path, "%u:%u", &major, &minor) == 2) {
442                 /* Extract the major/minor numbers */
443                 dev = MKDEV(major, minor);
444                 if (MAJOR(dev) != major || MINOR(dev) != minor)
445                         return -EOVERFLOW;
446         } else {
447                 /* convert the path to a device */
448                 struct block_device *bdev = lookup_bdev(path);
449
450                 if (IS_ERR(bdev))
451                         return PTR_ERR(bdev);
452                 dev = bdev->bd_dev;
453                 bdput(bdev);
454         }
455
456         dd = find_device(&t->devices, dev);
457         if (!dd) {
458                 dd = kmalloc(sizeof(*dd), GFP_KERNEL);
459                 if (!dd)
460                         return -ENOMEM;
461
462                 dd->dm_dev.mode = mode;
463                 dd->dm_dev.bdev = NULL;
464
465                 if ((r = open_dev(dd, dev, t->md))) {
466                         kfree(dd);
467                         return r;
468                 }
469
470                 format_dev_t(dd->dm_dev.name, dev);
471
472                 atomic_set(&dd->count, 0);
473                 list_add(&dd->list, &t->devices);
474
475         } else if (dd->dm_dev.mode != (mode | dd->dm_dev.mode)) {
476                 r = upgrade_mode(dd, mode, t->md);
477                 if (r)
478                         return r;
479         }
480         atomic_inc(&dd->count);
481
482         *result = &dd->dm_dev;
483         return 0;
484 }
485
486 /*
487  * Returns the minimum that is _not_ zero, unless both are zero.
488  */
489 #define min_not_zero(l, r) (l == 0) ? r : ((r == 0) ? l : min(l, r))
490
491 int dm_set_device_limits(struct dm_target *ti, struct dm_dev *dev,
492                          sector_t start, sector_t len, void *data)
493 {
494         struct queue_limits *limits = data;
495         struct block_device *bdev = dev->bdev;
496         struct request_queue *q = bdev_get_queue(bdev);
497         char b[BDEVNAME_SIZE];
498
499         if (unlikely(!q)) {
500                 DMWARN("%s: Cannot set limits for nonexistent device %s",
501                        dm_device_name(ti->table->md), bdevname(bdev, b));
502                 return 0;
503         }
504
505         if (blk_stack_limits(limits, &q->limits, start << 9) < 0)
506                 DMWARN("%s: target device %s is misaligned: "
507                        "physical_block_size=%u, logical_block_size=%u, "
508                        "alignment_offset=%u, start=%llu",
509                        dm_device_name(ti->table->md), bdevname(bdev, b),
510                        q->limits.physical_block_size,
511                        q->limits.logical_block_size,
512                        q->limits.alignment_offset,
513                        (unsigned long long) start << 9);
514
515
516         /*
517          * Check if merge fn is supported.
518          * If not we'll force DM to use PAGE_SIZE or
519          * smaller I/O, just to be safe.
520          */
521
522         if (q->merge_bvec_fn && !ti->type->merge)
523                 limits->max_sectors =
524                         min_not_zero(limits->max_sectors,
525                                      (unsigned int) (PAGE_SIZE >> 9));
526         return 0;
527 }
528 EXPORT_SYMBOL_GPL(dm_set_device_limits);
529
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)
532 {
533         return __table_get_device(ti->table, ti, path,
534                                   start, len, mode, result);
535 }
536
537
538 /*
539  * Decrement a devices use count and remove it if necessary.
540  */
541 void dm_put_device(struct dm_target *ti, struct dm_dev *d)
542 {
543         struct dm_dev_internal *dd = container_of(d, struct dm_dev_internal,
544                                                   dm_dev);
545
546         if (atomic_dec_and_test(&dd->count)) {
547                 close_dev(dd, ti->table->md);
548                 list_del(&dd->list);
549                 kfree(dd);
550         }
551 }
552
553 /*
554  * Checks to see if the target joins onto the end of the table.
555  */
556 static int adjoin(struct dm_table *table, struct dm_target *ti)
557 {
558         struct dm_target *prev;
559
560         if (!table->num_targets)
561                 return !ti->begin;
562
563         prev = &table->targets[table->num_targets - 1];
564         return (ti->begin == (prev->begin + prev->len));
565 }
566
567 /*
568  * Used to dynamically allocate the arg array.
569  */
570 static char **realloc_argv(unsigned *array_size, char **old_argv)
571 {
572         char **argv;
573         unsigned new_size;
574
575         new_size = *array_size ? *array_size * 2 : 64;
576         argv = kmalloc(new_size * sizeof(*argv), GFP_KERNEL);
577         if (argv) {
578                 memcpy(argv, old_argv, *array_size * sizeof(*argv));
579                 *array_size = new_size;
580         }
581
582         kfree(old_argv);
583         return argv;
584 }
585
586 /*
587  * Destructively splits up the argument list to pass to ctr.
588  */
589 int dm_split_args(int *argc, char ***argvp, char *input)
590 {
591         char *start, *end = input, *out, **argv = NULL;
592         unsigned array_size = 0;
593
594         *argc = 0;
595
596         if (!input) {
597                 *argvp = NULL;
598                 return 0;
599         }
600
601         argv = realloc_argv(&array_size, argv);
602         if (!argv)
603                 return -ENOMEM;
604
605         while (1) {
606                 start = end;
607
608                 /* Skip whitespace */
609                 while (*start && isspace(*start))
610                         start++;
611
612                 if (!*start)
613                         break;  /* success, we hit the end */
614
615                 /* 'out' is used to remove any back-quotes */
616                 end = out = start;
617                 while (*end) {
618                         /* Everything apart from '\0' can be quoted */
619                         if (*end == '\\' && *(end + 1)) {
620                                 *out++ = *(end + 1);
621                                 end += 2;
622                                 continue;
623                         }
624
625                         if (isspace(*end))
626                                 break;  /* end of token */
627
628                         *out++ = *end++;
629                 }
630
631                 /* have we already filled the array ? */
632                 if ((*argc + 1) > array_size) {
633                         argv = realloc_argv(&array_size, argv);
634                         if (!argv)
635                                 return -ENOMEM;
636                 }
637
638                 /* we know this is whitespace */
639                 if (*end)
640                         end++;
641
642                 /* terminate the string and put it in the array */
643                 *out = '\0';
644                 argv[*argc] = start;
645                 (*argc)++;
646         }
647
648         *argvp = argv;
649         return 0;
650 }
651
652 /*
653  * Impose necessary and sufficient conditions on a devices's table such
654  * that any incoming bio which respects its logical_block_size can be
655  * processed successfully.  If it falls across the boundary between
656  * two or more targets, the size of each piece it gets split into must
657  * be compatible with the logical_block_size of the target processing it.
658  */
659 static int validate_hardware_logical_block_alignment(struct dm_table *table,
660                                                  struct queue_limits *limits)
661 {
662         /*
663          * This function uses arithmetic modulo the logical_block_size
664          * (in units of 512-byte sectors).
665          */
666         unsigned short device_logical_block_size_sects =
667                 limits->logical_block_size >> SECTOR_SHIFT;
668
669         /*
670          * Offset of the start of the next table entry, mod logical_block_size.
671          */
672         unsigned short next_target_start = 0;
673
674         /*
675          * Given an aligned bio that extends beyond the end of a
676          * target, how many sectors must the next target handle?
677          */
678         unsigned short remaining = 0;
679
680         struct dm_target *uninitialized_var(ti);
681         struct queue_limits ti_limits;
682         unsigned i = 0;
683
684         /*
685          * Check each entry in the table in turn.
686          */
687         while (i < dm_table_get_num_targets(table)) {
688                 ti = dm_table_get_target(table, i++);
689
690                 blk_set_default_limits(&ti_limits);
691
692                 /* combine all target devices' limits */
693                 if (ti->type->iterate_devices)
694                         ti->type->iterate_devices(ti, dm_set_device_limits,
695                                                   &ti_limits);
696
697                 /*
698                  * If the remaining sectors fall entirely within this
699                  * table entry are they compatible with its logical_block_size?
700                  */
701                 if (remaining < ti->len &&
702                     remaining & ((ti_limits.logical_block_size >>
703                                   SECTOR_SHIFT) - 1))
704                         break;  /* Error */
705
706                 next_target_start =
707                     (unsigned short) ((next_target_start + ti->len) &
708                                       (device_logical_block_size_sects - 1));
709                 remaining = next_target_start ?
710                     device_logical_block_size_sects - next_target_start : 0;
711         }
712
713         if (remaining) {
714                 DMWARN("%s: table line %u (start sect %llu len %llu) "
715                        "not aligned to h/w logical block size %u",
716                        dm_device_name(table->md), i,
717                        (unsigned long long) ti->begin,
718                        (unsigned long long) ti->len,
719                        limits->logical_block_size);
720                 return -EINVAL;
721         }
722
723         return 0;
724 }
725
726 int dm_table_add_target(struct dm_table *t, const char *type,
727                         sector_t start, sector_t len, char *params)
728 {
729         int r = -EINVAL, argc;
730         char **argv;
731         struct dm_target *tgt;
732
733         if ((r = check_space(t)))
734                 return r;
735
736         tgt = t->targets + t->num_targets;
737         memset(tgt, 0, sizeof(*tgt));
738
739         if (!len) {
740                 DMERR("%s: zero-length target", dm_device_name(t->md));
741                 return -EINVAL;
742         }
743
744         tgt->type = dm_get_target_type(type);
745         if (!tgt->type) {
746                 DMERR("%s: %s: unknown target type", dm_device_name(t->md),
747                       type);
748                 return -EINVAL;
749         }
750
751         tgt->table = t;
752         tgt->begin = start;
753         tgt->len = len;
754         tgt->error = "Unknown error";
755
756         /*
757          * Does this target adjoin the previous one ?
758          */
759         if (!adjoin(t, tgt)) {
760                 tgt->error = "Gap in table";
761                 r = -EINVAL;
762                 goto bad;
763         }
764
765         r = dm_split_args(&argc, &argv, params);
766         if (r) {
767                 tgt->error = "couldn't split parameters (insufficient memory)";
768                 goto bad;
769         }
770
771         r = tgt->type->ctr(tgt, argc, argv);
772         kfree(argv);
773         if (r)
774                 goto bad;
775
776         t->highs[t->num_targets++] = tgt->begin + tgt->len - 1;
777
778         return 0;
779
780  bad:
781         DMERR("%s: %s: %s", dm_device_name(t->md), type, tgt->error);
782         dm_put_target_type(tgt->type);
783         return r;
784 }
785
786 int dm_table_set_type(struct dm_table *t)
787 {
788         unsigned i;
789         unsigned bio_based = 0, request_based = 0;
790         struct dm_target *tgt;
791         struct dm_dev_internal *dd;
792         struct list_head *devices;
793
794         for (i = 0; i < t->num_targets; i++) {
795                 tgt = t->targets + i;
796                 if (dm_target_request_based(tgt))
797                         request_based = 1;
798                 else
799                         bio_based = 1;
800
801                 if (bio_based && request_based) {
802                         DMWARN("Inconsistent table: different target types"
803                                " can't be mixed up");
804                         return -EINVAL;
805                 }
806         }
807
808         if (bio_based) {
809                 /* We must use this table as bio-based */
810                 t->type = DM_TYPE_BIO_BASED;
811                 return 0;
812         }
813
814         BUG_ON(!request_based); /* No targets in this table */
815
816         /* Non-request-stackable devices can't be used for request-based dm */
817         devices = dm_table_get_devices(t);
818         list_for_each_entry(dd, devices, list) {
819                 if (!blk_queue_stackable(bdev_get_queue(dd->dm_dev.bdev))) {
820                         DMWARN("table load rejected: including"
821                                " non-request-stackable devices");
822                         return -EINVAL;
823                 }
824         }
825
826         /*
827          * Request-based dm supports only tables that have a single target now.
828          * To support multiple targets, request splitting support is needed,
829          * and that needs lots of changes in the block-layer.
830          * (e.g. request completion process for partial completion.)
831          */
832         if (t->num_targets > 1) {
833                 DMWARN("Request-based dm doesn't support multiple targets yet");
834                 return -EINVAL;
835         }
836
837         t->type = DM_TYPE_REQUEST_BASED;
838
839         return 0;
840 }
841
842 unsigned dm_table_get_type(struct dm_table *t)
843 {
844         return t->type;
845 }
846
847 bool dm_table_request_based(struct dm_table *t)
848 {
849         return dm_table_get_type(t) == DM_TYPE_REQUEST_BASED;
850 }
851
852 int dm_table_alloc_md_mempools(struct dm_table *t)
853 {
854         unsigned type = dm_table_get_type(t);
855
856         if (unlikely(type == DM_TYPE_NONE)) {
857                 DMWARN("no table type is set, can't allocate mempools");
858                 return -EINVAL;
859         }
860
861         t->mempools = dm_alloc_md_mempools(type);
862         if (!t->mempools)
863                 return -ENOMEM;
864
865         return 0;
866 }
867
868 void dm_table_free_md_mempools(struct dm_table *t)
869 {
870         dm_free_md_mempools(t->mempools);
871         t->mempools = NULL;
872 }
873
874 struct dm_md_mempools *dm_table_get_md_mempools(struct dm_table *t)
875 {
876         return t->mempools;
877 }
878
879 static int setup_indexes(struct dm_table *t)
880 {
881         int i;
882         unsigned int total = 0;
883         sector_t *indexes;
884
885         /* allocate the space for *all* the indexes */
886         for (i = t->depth - 2; i >= 0; i--) {
887                 t->counts[i] = dm_div_up(t->counts[i + 1], CHILDREN_PER_NODE);
888                 total += t->counts[i];
889         }
890
891         indexes = (sector_t *) dm_vcalloc(total, (unsigned long) NODE_SIZE);
892         if (!indexes)
893                 return -ENOMEM;
894
895         /* set up internal nodes, bottom-up */
896         for (i = t->depth - 2; i >= 0; i--) {
897                 t->index[i] = indexes;
898                 indexes += (KEYS_PER_NODE * t->counts[i]);
899                 setup_btree_index(i, t);
900         }
901
902         return 0;
903 }
904
905 /*
906  * Builds the btree to index the map.
907  */
908 int dm_table_complete(struct dm_table *t)
909 {
910         int r = 0;
911         unsigned int leaf_nodes;
912
913         /* how many indexes will the btree have ? */
914         leaf_nodes = dm_div_up(t->num_targets, KEYS_PER_NODE);
915         t->depth = 1 + int_log(leaf_nodes, CHILDREN_PER_NODE);
916
917         /* leaf layer has already been set up */
918         t->counts[t->depth - 1] = leaf_nodes;
919         t->index[t->depth - 1] = t->highs;
920
921         if (t->depth >= 2)
922                 r = setup_indexes(t);
923
924         return r;
925 }
926
927 static DEFINE_MUTEX(_event_lock);
928 void dm_table_event_callback(struct dm_table *t,
929                              void (*fn)(void *), void *context)
930 {
931         mutex_lock(&_event_lock);
932         t->event_fn = fn;
933         t->event_context = context;
934         mutex_unlock(&_event_lock);
935 }
936
937 void dm_table_event(struct dm_table *t)
938 {
939         /*
940          * You can no longer call dm_table_event() from interrupt
941          * context, use a bottom half instead.
942          */
943         BUG_ON(in_interrupt());
944
945         mutex_lock(&_event_lock);
946         if (t->event_fn)
947                 t->event_fn(t->event_context);
948         mutex_unlock(&_event_lock);
949 }
950
951 sector_t dm_table_get_size(struct dm_table *t)
952 {
953         return t->num_targets ? (t->highs[t->num_targets - 1] + 1) : 0;
954 }
955
956 struct dm_target *dm_table_get_target(struct dm_table *t, unsigned int index)
957 {
958         if (index >= t->num_targets)
959                 return NULL;
960
961         return t->targets + index;
962 }
963
964 /*
965  * Search the btree for the correct target.
966  *
967  * Caller should check returned pointer with dm_target_is_valid()
968  * to trap I/O beyond end of device.
969  */
970 struct dm_target *dm_table_find_target(struct dm_table *t, sector_t sector)
971 {
972         unsigned int l, n = 0, k = 0;
973         sector_t *node;
974
975         for (l = 0; l < t->depth; l++) {
976                 n = get_child(n, k);
977                 node = get_node(t, l, n);
978
979                 for (k = 0; k < KEYS_PER_NODE; k++)
980                         if (node[k] >= sector)
981                                 break;
982         }
983
984         return &t->targets[(KEYS_PER_NODE * n) + k];
985 }
986
987 /*
988  * Establish the new table's queue_limits and validate them.
989  */
990 int dm_calculate_queue_limits(struct dm_table *table,
991                               struct queue_limits *limits)
992 {
993         struct dm_target *uninitialized_var(ti);
994         struct queue_limits ti_limits;
995         unsigned i = 0;
996
997         blk_set_default_limits(limits);
998
999         while (i < dm_table_get_num_targets(table)) {
1000                 blk_set_default_limits(&ti_limits);
1001
1002                 ti = dm_table_get_target(table, i++);
1003
1004                 if (!ti->type->iterate_devices)
1005                         goto combine_limits;
1006
1007                 /*
1008                  * Combine queue limits of all the devices this target uses.
1009                  */
1010                 ti->type->iterate_devices(ti, dm_set_device_limits,
1011                                           &ti_limits);
1012
1013                 /* Set I/O hints portion of queue limits */
1014                 if (ti->type->io_hints)
1015                         ti->type->io_hints(ti, &ti_limits);
1016
1017                 /*
1018                  * Check each device area is consistent with the target's
1019                  * overall queue limits.
1020                  */
1021                 if (ti->type->iterate_devices(ti, device_area_is_invalid,
1022                                               &ti_limits))
1023                         return -EINVAL;
1024
1025 combine_limits:
1026                 /*
1027                  * Merge this target's queue limits into the overall limits
1028                  * for the table.
1029                  */
1030                 if (blk_stack_limits(limits, &ti_limits, 0) < 0)
1031                         DMWARN("%s: target device "
1032                                "(start sect %llu len %llu) "
1033                                "is misaligned",
1034                                dm_device_name(table->md),
1035                                (unsigned long long) ti->begin,
1036                                (unsigned long long) ti->len);
1037         }
1038
1039         return validate_hardware_logical_block_alignment(table, limits);
1040 }
1041
1042 /*
1043  * Set the integrity profile for this device if all devices used have
1044  * matching profiles.
1045  */
1046 static void dm_table_set_integrity(struct dm_table *t)
1047 {
1048         struct list_head *devices = dm_table_get_devices(t);
1049         struct dm_dev_internal *prev = NULL, *dd = NULL;
1050
1051         if (!blk_get_integrity(dm_disk(t->md)))
1052                 return;
1053
1054         list_for_each_entry(dd, devices, list) {
1055                 if (prev &&
1056                     blk_integrity_compare(prev->dm_dev.bdev->bd_disk,
1057                                           dd->dm_dev.bdev->bd_disk) < 0) {
1058                         DMWARN("%s: integrity not set: %s and %s mismatch",
1059                                dm_device_name(t->md),
1060                                prev->dm_dev.bdev->bd_disk->disk_name,
1061                                dd->dm_dev.bdev->bd_disk->disk_name);
1062                         goto no_integrity;
1063                 }
1064                 prev = dd;
1065         }
1066
1067         if (!prev || !bdev_get_integrity(prev->dm_dev.bdev))
1068                 goto no_integrity;
1069
1070         blk_integrity_register(dm_disk(t->md),
1071                                bdev_get_integrity(prev->dm_dev.bdev));
1072
1073         return;
1074
1075 no_integrity:
1076         blk_integrity_register(dm_disk(t->md), NULL);
1077
1078         return;
1079 }
1080
1081 void dm_table_set_restrictions(struct dm_table *t, struct request_queue *q,
1082                                struct queue_limits *limits)
1083 {
1084         /*
1085          * Each target device in the table has a data area that should normally
1086          * be aligned such that the DM device's alignment_offset is 0.
1087          * FIXME: Propagate alignment_offsets up the stack and warn of
1088          *        sub-optimal or inconsistent settings.
1089          */
1090         limits->alignment_offset = 0;
1091         limits->misaligned = 0;
1092
1093         /*
1094          * Copy table's limits to the DM device's request_queue
1095          */
1096         q->limits = *limits;
1097
1098         if (limits->no_cluster)
1099                 queue_flag_clear_unlocked(QUEUE_FLAG_CLUSTER, q);
1100         else
1101                 queue_flag_set_unlocked(QUEUE_FLAG_CLUSTER, q);
1102
1103         dm_table_set_integrity(t);
1104
1105         /*
1106          * QUEUE_FLAG_STACKABLE must be set after all queue settings are
1107          * visible to other CPUs because, once the flag is set, incoming bios
1108          * are processed by request-based dm, which refers to the queue
1109          * settings.
1110          * Until the flag set, bios are passed to bio-based dm and queued to
1111          * md->deferred where queue settings are not needed yet.
1112          * Those bios are passed to request-based dm at the resume time.
1113          */
1114         smp_mb();
1115         if (dm_table_request_based(t))
1116                 queue_flag_set_unlocked(QUEUE_FLAG_STACKABLE, q);
1117 }
1118
1119 unsigned int dm_table_get_num_targets(struct dm_table *t)
1120 {
1121         return t->num_targets;
1122 }
1123
1124 struct list_head *dm_table_get_devices(struct dm_table *t)
1125 {
1126         return &t->devices;
1127 }
1128
1129 fmode_t dm_table_get_mode(struct dm_table *t)
1130 {
1131         return t->mode;
1132 }
1133
1134 static void suspend_targets(struct dm_table *t, unsigned postsuspend)
1135 {
1136         int i = t->num_targets;
1137         struct dm_target *ti = t->targets;
1138
1139         while (i--) {
1140                 if (postsuspend) {
1141                         if (ti->type->postsuspend)
1142                                 ti->type->postsuspend(ti);
1143                 } else if (ti->type->presuspend)
1144                         ti->type->presuspend(ti);
1145
1146                 ti++;
1147         }
1148 }
1149
1150 void dm_table_presuspend_targets(struct dm_table *t)
1151 {
1152         if (!t)
1153                 return;
1154
1155         suspend_targets(t, 0);
1156 }
1157
1158 void dm_table_postsuspend_targets(struct dm_table *t)
1159 {
1160         if (!t)
1161                 return;
1162
1163         suspend_targets(t, 1);
1164 }
1165
1166 int dm_table_resume_targets(struct dm_table *t)
1167 {
1168         int i, r = 0;
1169
1170         for (i = 0; i < t->num_targets; i++) {
1171                 struct dm_target *ti = t->targets + i;
1172
1173                 if (!ti->type->preresume)
1174                         continue;
1175
1176                 r = ti->type->preresume(ti);
1177                 if (r)
1178                         return r;
1179         }
1180
1181         for (i = 0; i < t->num_targets; i++) {
1182                 struct dm_target *ti = t->targets + i;
1183
1184                 if (ti->type->resume)
1185                         ti->type->resume(ti);
1186         }
1187
1188         return 0;
1189 }
1190
1191 int dm_table_any_congested(struct dm_table *t, int bdi_bits)
1192 {
1193         struct dm_dev_internal *dd;
1194         struct list_head *devices = dm_table_get_devices(t);
1195         int r = 0;
1196
1197         list_for_each_entry(dd, devices, list) {
1198                 struct request_queue *q = bdev_get_queue(dd->dm_dev.bdev);
1199                 char b[BDEVNAME_SIZE];
1200
1201                 if (likely(q))
1202                         r |= bdi_congested(&q->backing_dev_info, bdi_bits);
1203                 else
1204                         DMWARN_LIMIT("%s: any_congested: nonexistent device %s",
1205                                      dm_device_name(t->md),
1206                                      bdevname(dd->dm_dev.bdev, b));
1207         }
1208
1209         return r;
1210 }
1211
1212 int dm_table_any_busy_target(struct dm_table *t)
1213 {
1214         unsigned i;
1215         struct dm_target *ti;
1216
1217         for (i = 0; i < t->num_targets; i++) {
1218                 ti = t->targets + i;
1219                 if (ti->type->busy && ti->type->busy(ti))
1220                         return 1;
1221         }
1222
1223         return 0;
1224 }
1225
1226 void dm_table_unplug_all(struct dm_table *t)
1227 {
1228         struct dm_dev_internal *dd;
1229         struct list_head *devices = dm_table_get_devices(t);
1230
1231         list_for_each_entry(dd, devices, list) {
1232                 struct request_queue *q = bdev_get_queue(dd->dm_dev.bdev);
1233                 char b[BDEVNAME_SIZE];
1234
1235                 if (likely(q))
1236                         blk_unplug(q);
1237                 else
1238                         DMWARN_LIMIT("%s: Cannot unplug nonexistent device %s",
1239                                      dm_device_name(t->md),
1240                                      bdevname(dd->dm_dev.bdev, b));
1241         }
1242 }
1243
1244 struct mapped_device *dm_table_get_md(struct dm_table *t)
1245 {
1246         dm_get(t->md);
1247
1248         return t->md;
1249 }
1250
1251 EXPORT_SYMBOL(dm_vcalloc);
1252 EXPORT_SYMBOL(dm_get_device);
1253 EXPORT_SYMBOL(dm_put_device);
1254 EXPORT_SYMBOL(dm_table_event);
1255 EXPORT_SYMBOL(dm_table_get_size);
1256 EXPORT_SYMBOL(dm_table_get_mode);
1257 EXPORT_SYMBOL(dm_table_get_md);
1258 EXPORT_SYMBOL(dm_table_put);
1259 EXPORT_SYMBOL(dm_table_get);
1260 EXPORT_SYMBOL(dm_table_unplug_all);