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