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
->seg_boundary_mask
=
103 min_not_zero(lhs
->seg_boundary_mask
, rhs
->seg_boundary_mask
);
105 lhs
->no_cluster
|= rhs
->no_cluster
;
109 * Calculate the index of the child node of the n'th node k'th key.
111 static inline unsigned int get_child(unsigned int n
, unsigned int k
)
113 return (n
* CHILDREN_PER_NODE
) + k
;
117 * Return the n'th node of level l from table t.
119 static inline sector_t
*get_node(struct dm_table
*t
,
120 unsigned int l
, unsigned int n
)
122 return t
->index
[l
] + (n
* KEYS_PER_NODE
);
126 * Return the highest key that you could lookup from the n'th
127 * node on level l of the btree.
129 static sector_t
high(struct dm_table
*t
, unsigned int l
, unsigned int n
)
131 for (; l
< t
->depth
- 1; l
++)
132 n
= get_child(n
, CHILDREN_PER_NODE
- 1);
134 if (n
>= t
->counts
[l
])
135 return (sector_t
) - 1;
137 return get_node(t
, l
, n
)[KEYS_PER_NODE
- 1];
141 * Fills in a level of the btree based on the highs of the level
144 static int setup_btree_index(unsigned int l
, struct dm_table
*t
)
149 for (n
= 0U; n
< t
->counts
[l
]; n
++) {
150 node
= get_node(t
, l
, n
);
152 for (k
= 0U; k
< KEYS_PER_NODE
; k
++)
153 node
[k
] = high(t
, l
+ 1, get_child(n
, k
));
159 void *dm_vcalloc(unsigned long nmemb
, unsigned long elem_size
)
165 * Check that we're not going to overflow.
167 if (nmemb
> (ULONG_MAX
/ elem_size
))
170 size
= nmemb
* elem_size
;
171 addr
= vmalloc(size
);
173 memset(addr
, 0, size
);
179 * highs, and targets are managed as dynamic arrays during a
182 static int alloc_targets(struct dm_table
*t
, unsigned int num
)
185 struct dm_target
*n_targets
;
186 int n
= t
->num_targets
;
189 * Allocate both the target array and offset array at once.
191 n_highs
= (sector_t
*) dm_vcalloc(num
, sizeof(struct dm_target
) +
196 n_targets
= (struct dm_target
*) (n_highs
+ num
);
199 memcpy(n_highs
, t
->highs
, sizeof(*n_highs
) * n
);
200 memcpy(n_targets
, t
->targets
, sizeof(*n_targets
) * n
);
203 memset(n_highs
+ n
, -1, sizeof(*n_highs
) * (num
- n
));
206 t
->num_allocated
= num
;
208 t
->targets
= n_targets
;
213 int dm_table_create(struct dm_table
**result
, int mode
,
214 unsigned num_targets
, struct mapped_device
*md
)
216 struct dm_table
*t
= kmalloc(sizeof(*t
), GFP_KERNEL
);
221 memset(t
, 0, sizeof(*t
));
222 INIT_LIST_HEAD(&t
->devices
);
223 atomic_set(&t
->holders
, 1);
226 num_targets
= KEYS_PER_NODE
;
228 num_targets
= dm_round_up(num_targets
, KEYS_PER_NODE
);
230 if (alloc_targets(t
, num_targets
)) {
242 int dm_create_error_table(struct dm_table
**result
, struct mapped_device
*md
)
245 sector_t dev_size
= 1;
249 * Find current size of device.
250 * Default to 1 sector if inactive.
252 t
= dm_get_table(md
);
254 dev_size
= dm_table_get_size(t
);
258 r
= dm_table_create(&t
, FMODE_READ
, 1, md
);
262 r
= dm_table_add_target(t
, "error", 0, dev_size
, NULL
);
266 r
= dm_table_complete(t
);
278 EXPORT_SYMBOL_GPL(dm_create_error_table
);
280 static void free_devices(struct list_head
*devices
)
282 struct list_head
*tmp
, *next
;
284 for (tmp
= devices
->next
; tmp
!= devices
; tmp
= next
) {
285 struct dm_dev
*dd
= list_entry(tmp
, struct dm_dev
, list
);
291 static void table_destroy(struct dm_table
*t
)
295 /* free the indexes (see dm_table_complete) */
297 vfree(t
->index
[t
->depth
- 2]);
299 /* free the targets */
300 for (i
= 0; i
< t
->num_targets
; i
++) {
301 struct dm_target
*tgt
= t
->targets
+ i
;
306 dm_put_target_type(tgt
->type
);
311 /* free the device list */
312 if (t
->devices
.next
!= &t
->devices
) {
313 DMWARN("devices still present during destroy: "
314 "dm_table_remove_device calls missing");
316 free_devices(&t
->devices
);
322 void dm_table_get(struct dm_table
*t
)
324 atomic_inc(&t
->holders
);
327 void dm_table_put(struct dm_table
*t
)
332 if (atomic_dec_and_test(&t
->holders
))
337 * Checks to see if we need to extend highs or targets.
339 static inline int check_space(struct dm_table
*t
)
341 if (t
->num_targets
>= t
->num_allocated
)
342 return alloc_targets(t
, t
->num_allocated
* 2);
348 * Convert a device path to a dev_t.
350 static int lookup_device(const char *path
, dev_t
*dev
)
356 if ((r
= path_lookup(path
, LOOKUP_FOLLOW
, &nd
)))
359 inode
= nd
.dentry
->d_inode
;
365 if (!S_ISBLK(inode
->i_mode
)) {
370 *dev
= inode
->i_rdev
;
378 * See if we've already got a device in the list.
380 static struct dm_dev
*find_device(struct list_head
*l
, dev_t dev
)
384 list_for_each_entry (dd
, l
, list
)
385 if (dd
->bdev
->bd_dev
== dev
)
392 * Open a device so we can use it as a map destination.
394 static int open_dev(struct dm_dev
*d
, dev_t dev
, struct mapped_device
*md
)
396 static char *_claim_ptr
= "I belong to device-mapper";
397 struct block_device
*bdev
;
403 bdev
= open_by_devnum(dev
, d
->mode
);
405 return PTR_ERR(bdev
);
406 r
= bd_claim_by_disk(bdev
, _claim_ptr
, dm_disk(md
));
415 * Close a device that we've been using.
417 static void close_dev(struct dm_dev
*d
, struct mapped_device
*md
)
422 bd_release_from_disk(d
->bdev
, dm_disk(md
));
428 * If possible, this checks an area of a destination device is valid.
430 static int check_device_area(struct dm_dev
*dd
, sector_t start
, sector_t len
)
432 sector_t dev_size
= dd
->bdev
->bd_inode
->i_size
>> SECTOR_SHIFT
;
437 return ((start
< dev_size
) && (len
<= (dev_size
- start
)));
441 * This upgrades the mode on an already open dm_dev. Being
442 * careful to leave things as they were if we fail to reopen the
445 static int upgrade_mode(struct dm_dev
*dd
, int new_mode
, struct mapped_device
*md
)
448 struct dm_dev dd_copy
;
449 dev_t dev
= dd
->bdev
->bd_dev
;
453 dd
->mode
|= new_mode
;
455 r
= open_dev(dd
, dev
, md
);
457 close_dev(&dd_copy
, md
);
465 * Add a device to the list, or just increment the usage count if
466 * it's already present.
468 static int __table_get_device(struct dm_table
*t
, struct dm_target
*ti
,
469 const char *path
, sector_t start
, sector_t len
,
470 int mode
, struct dm_dev
**result
)
475 unsigned int major
, minor
;
479 if (sscanf(path
, "%u:%u", &major
, &minor
) == 2) {
480 /* Extract the major/minor numbers */
481 dev
= MKDEV(major
, minor
);
482 if (MAJOR(dev
) != major
|| MINOR(dev
) != minor
)
485 /* convert the path to a device */
486 if ((r
= lookup_device(path
, &dev
)))
490 dd
= find_device(&t
->devices
, dev
);
492 dd
= kmalloc(sizeof(*dd
), GFP_KERNEL
);
499 if ((r
= open_dev(dd
, dev
, t
->md
))) {
504 format_dev_t(dd
->name
, dev
);
506 atomic_set(&dd
->count
, 0);
507 list_add(&dd
->list
, &t
->devices
);
509 } else if (dd
->mode
!= (mode
| dd
->mode
)) {
510 r
= upgrade_mode(dd
, mode
, t
->md
);
514 atomic_inc(&dd
->count
);
516 if (!check_device_area(dd
, start
, len
)) {
517 DMWARN("device %s too small for target", path
);
518 dm_put_device(ti
, dd
);
527 void dm_set_device_limits(struct dm_target
*ti
, struct block_device
*bdev
)
529 struct request_queue
*q
= bdev_get_queue(bdev
);
530 struct io_restrictions
*rs
= &ti
->limits
;
533 * Combine the device limits low.
535 * FIXME: if we move an io_restriction struct
536 * into q this would just be a call to
537 * combine_restrictions_low()
540 min_not_zero(rs
->max_sectors
, q
->max_sectors
);
542 /* FIXME: Device-Mapper on top of RAID-0 breaks because DM
543 * currently doesn't honor MD's merge_bvec_fn routine.
544 * In this case, we'll force DM to use PAGE_SIZE or
545 * smaller I/O, just to be safe. A better fix is in the
546 * works, but add this for the time being so it will at
547 * least operate correctly.
549 if (q
->merge_bvec_fn
)
551 min_not_zero(rs
->max_sectors
,
552 (unsigned int) (PAGE_SIZE
>> 9));
554 rs
->max_phys_segments
=
555 min_not_zero(rs
->max_phys_segments
,
556 q
->max_phys_segments
);
558 rs
->max_hw_segments
=
559 min_not_zero(rs
->max_hw_segments
, q
->max_hw_segments
);
561 rs
->hardsect_size
= max(rs
->hardsect_size
, q
->hardsect_size
);
563 rs
->max_segment_size
=
564 min_not_zero(rs
->max_segment_size
, q
->max_segment_size
);
566 rs
->seg_boundary_mask
=
567 min_not_zero(rs
->seg_boundary_mask
,
568 q
->seg_boundary_mask
);
570 rs
->no_cluster
|= !test_bit(QUEUE_FLAG_CLUSTER
, &q
->queue_flags
);
572 EXPORT_SYMBOL_GPL(dm_set_device_limits
);
574 int dm_get_device(struct dm_target
*ti
, const char *path
, sector_t start
,
575 sector_t len
, int mode
, struct dm_dev
**result
)
577 int r
= __table_get_device(ti
->table
, ti
, path
,
578 start
, len
, mode
, result
);
581 dm_set_device_limits(ti
, (*result
)->bdev
);
587 * Decrement a devices use count and remove it if necessary.
589 void dm_put_device(struct dm_target
*ti
, struct dm_dev
*dd
)
591 if (atomic_dec_and_test(&dd
->count
)) {
592 close_dev(dd
, ti
->table
->md
);
599 * Checks to see if the target joins onto the end of the table.
601 static int adjoin(struct dm_table
*table
, struct dm_target
*ti
)
603 struct dm_target
*prev
;
605 if (!table
->num_targets
)
608 prev
= &table
->targets
[table
->num_targets
- 1];
609 return (ti
->begin
== (prev
->begin
+ prev
->len
));
613 * Used to dynamically allocate the arg array.
615 static char **realloc_argv(unsigned *array_size
, char **old_argv
)
620 new_size
= *array_size
? *array_size
* 2 : 64;
621 argv
= kmalloc(new_size
* sizeof(*argv
), GFP_KERNEL
);
623 memcpy(argv
, old_argv
, *array_size
* sizeof(*argv
));
624 *array_size
= new_size
;
632 * Destructively splits up the argument list to pass to ctr.
634 int dm_split_args(int *argc
, char ***argvp
, char *input
)
636 char *start
, *end
= input
, *out
, **argv
= NULL
;
637 unsigned array_size
= 0;
646 argv
= realloc_argv(&array_size
, argv
);
653 /* Skip whitespace */
654 while (*start
&& isspace(*start
))
658 break; /* success, we hit the end */
660 /* 'out' is used to remove any back-quotes */
663 /* Everything apart from '\0' can be quoted */
664 if (*end
== '\\' && *(end
+ 1)) {
671 break; /* end of token */
676 /* have we already filled the array ? */
677 if ((*argc
+ 1) > array_size
) {
678 argv
= realloc_argv(&array_size
, argv
);
683 /* we know this is whitespace */
687 /* terminate the string and put it in the array */
697 static void check_for_valid_limits(struct io_restrictions
*rs
)
699 if (!rs
->max_sectors
)
700 rs
->max_sectors
= SAFE_MAX_SECTORS
;
701 if (!rs
->max_phys_segments
)
702 rs
->max_phys_segments
= MAX_PHYS_SEGMENTS
;
703 if (!rs
->max_hw_segments
)
704 rs
->max_hw_segments
= MAX_HW_SEGMENTS
;
705 if (!rs
->hardsect_size
)
706 rs
->hardsect_size
= 1 << SECTOR_SHIFT
;
707 if (!rs
->max_segment_size
)
708 rs
->max_segment_size
= MAX_SEGMENT_SIZE
;
709 if (!rs
->seg_boundary_mask
)
710 rs
->seg_boundary_mask
= -1;
713 int dm_table_add_target(struct dm_table
*t
, const char *type
,
714 sector_t start
, sector_t len
, char *params
)
716 int r
= -EINVAL
, argc
;
718 struct dm_target
*tgt
;
720 if ((r
= check_space(t
)))
723 tgt
= t
->targets
+ t
->num_targets
;
724 memset(tgt
, 0, sizeof(*tgt
));
727 DMERR("%s: zero-length target", dm_device_name(t
->md
));
731 tgt
->type
= dm_get_target_type(type
);
733 DMERR("%s: %s: unknown target type", dm_device_name(t
->md
),
741 tgt
->error
= "Unknown error";
744 * Does this target adjoin the previous one ?
746 if (!adjoin(t
, tgt
)) {
747 tgt
->error
= "Gap in table";
752 r
= dm_split_args(&argc
, &argv
, params
);
754 tgt
->error
= "couldn't split parameters (insufficient memory)";
758 r
= tgt
->type
->ctr(tgt
, argc
, argv
);
763 t
->highs
[t
->num_targets
++] = tgt
->begin
+ tgt
->len
- 1;
765 /* FIXME: the plan is to combine high here and then have
766 * the merge fn apply the target level restrictions. */
767 combine_restrictions_low(&t
->limits
, &tgt
->limits
);
771 DMERR("%s: %s: %s", dm_device_name(t
->md
), type
, tgt
->error
);
772 dm_put_target_type(tgt
->type
);
776 static int setup_indexes(struct dm_table
*t
)
779 unsigned int total
= 0;
782 /* allocate the space for *all* the indexes */
783 for (i
= t
->depth
- 2; i
>= 0; i
--) {
784 t
->counts
[i
] = dm_div_up(t
->counts
[i
+ 1], CHILDREN_PER_NODE
);
785 total
+= t
->counts
[i
];
788 indexes
= (sector_t
*) dm_vcalloc(total
, (unsigned long) NODE_SIZE
);
792 /* set up internal nodes, bottom-up */
793 for (i
= t
->depth
- 2, total
= 0; i
>= 0; i
--) {
794 t
->index
[i
] = indexes
;
795 indexes
+= (KEYS_PER_NODE
* t
->counts
[i
]);
796 setup_btree_index(i
, t
);
803 * Builds the btree to index the map.
805 int dm_table_complete(struct dm_table
*t
)
808 unsigned int leaf_nodes
;
810 check_for_valid_limits(&t
->limits
);
812 /* how many indexes will the btree have ? */
813 leaf_nodes
= dm_div_up(t
->num_targets
, KEYS_PER_NODE
);
814 t
->depth
= 1 + int_log(leaf_nodes
, CHILDREN_PER_NODE
);
816 /* leaf layer has already been set up */
817 t
->counts
[t
->depth
- 1] = leaf_nodes
;
818 t
->index
[t
->depth
- 1] = t
->highs
;
821 r
= setup_indexes(t
);
826 static DEFINE_MUTEX(_event_lock
);
827 void dm_table_event_callback(struct dm_table
*t
,
828 void (*fn
)(void *), void *context
)
830 mutex_lock(&_event_lock
);
832 t
->event_context
= context
;
833 mutex_unlock(&_event_lock
);
836 void dm_table_event(struct dm_table
*t
)
839 * You can no longer call dm_table_event() from interrupt
840 * context, use a bottom half instead.
842 BUG_ON(in_interrupt());
844 mutex_lock(&_event_lock
);
846 t
->event_fn(t
->event_context
);
847 mutex_unlock(&_event_lock
);
850 sector_t
dm_table_get_size(struct dm_table
*t
)
852 return t
->num_targets
? (t
->highs
[t
->num_targets
- 1] + 1) : 0;
855 struct dm_target
*dm_table_get_target(struct dm_table
*t
, unsigned int index
)
857 if (index
>= t
->num_targets
)
860 return t
->targets
+ index
;
864 * Search the btree for the correct target.
866 struct dm_target
*dm_table_find_target(struct dm_table
*t
, sector_t sector
)
868 unsigned int l
, n
= 0, k
= 0;
871 for (l
= 0; l
< t
->depth
; l
++) {
873 node
= get_node(t
, l
, n
);
875 for (k
= 0; k
< KEYS_PER_NODE
; k
++)
876 if (node
[k
] >= sector
)
880 return &t
->targets
[(KEYS_PER_NODE
* n
) + k
];
883 void dm_table_set_restrictions(struct dm_table
*t
, struct request_queue
*q
)
886 * Make sure we obey the optimistic sub devices
889 blk_queue_max_sectors(q
, t
->limits
.max_sectors
);
890 q
->max_phys_segments
= t
->limits
.max_phys_segments
;
891 q
->max_hw_segments
= t
->limits
.max_hw_segments
;
892 q
->hardsect_size
= t
->limits
.hardsect_size
;
893 q
->max_segment_size
= t
->limits
.max_segment_size
;
894 q
->seg_boundary_mask
= t
->limits
.seg_boundary_mask
;
895 if (t
->limits
.no_cluster
)
896 q
->queue_flags
&= ~(1 << QUEUE_FLAG_CLUSTER
);
898 q
->queue_flags
|= (1 << QUEUE_FLAG_CLUSTER
);
902 unsigned int dm_table_get_num_targets(struct dm_table
*t
)
904 return t
->num_targets
;
907 struct list_head
*dm_table_get_devices(struct dm_table
*t
)
912 int dm_table_get_mode(struct dm_table
*t
)
917 static void suspend_targets(struct dm_table
*t
, unsigned postsuspend
)
919 int i
= t
->num_targets
;
920 struct dm_target
*ti
= t
->targets
;
924 if (ti
->type
->postsuspend
)
925 ti
->type
->postsuspend(ti
);
926 } else if (ti
->type
->presuspend
)
927 ti
->type
->presuspend(ti
);
933 void dm_table_presuspend_targets(struct dm_table
*t
)
938 return suspend_targets(t
, 0);
941 void dm_table_postsuspend_targets(struct dm_table
*t
)
946 return suspend_targets(t
, 1);
949 int dm_table_resume_targets(struct dm_table
*t
)
953 for (i
= 0; i
< t
->num_targets
; i
++) {
954 struct dm_target
*ti
= t
->targets
+ i
;
956 if (!ti
->type
->preresume
)
959 r
= ti
->type
->preresume(ti
);
964 for (i
= 0; i
< t
->num_targets
; i
++) {
965 struct dm_target
*ti
= t
->targets
+ i
;
967 if (ti
->type
->resume
)
968 ti
->type
->resume(ti
);
974 int dm_table_any_congested(struct dm_table
*t
, int bdi_bits
)
976 struct list_head
*d
, *devices
;
979 devices
= dm_table_get_devices(t
);
980 for (d
= devices
->next
; d
!= devices
; d
= d
->next
) {
981 struct dm_dev
*dd
= list_entry(d
, struct dm_dev
, list
);
982 struct request_queue
*q
= bdev_get_queue(dd
->bdev
);
983 r
|= bdi_congested(&q
->backing_dev_info
, bdi_bits
);
989 void dm_table_unplug_all(struct dm_table
*t
)
991 struct list_head
*d
, *devices
= dm_table_get_devices(t
);
993 for (d
= devices
->next
; d
!= devices
; d
= d
->next
) {
994 struct dm_dev
*dd
= list_entry(d
, struct dm_dev
, list
);
995 struct request_queue
*q
= bdev_get_queue(dd
->bdev
);
1002 int dm_table_flush_all(struct dm_table
*t
)
1004 struct list_head
*d
, *devices
= dm_table_get_devices(t
);
1008 for (i
= 0; i
< t
->num_targets
; i
++)
1009 if (t
->targets
[i
].type
->flush
)
1010 t
->targets
[i
].type
->flush(&t
->targets
[i
]);
1012 for (d
= devices
->next
; d
!= devices
; d
= d
->next
) {
1013 struct dm_dev
*dd
= list_entry(d
, struct dm_dev
, list
);
1014 struct request_queue
*q
= bdev_get_queue(dd
->bdev
);
1017 if (!q
->issue_flush_fn
)
1020 err
= q
->issue_flush_fn(q
, dd
->bdev
->bd_disk
, NULL
);
1029 struct mapped_device
*dm_table_get_md(struct dm_table
*t
)
1036 EXPORT_SYMBOL(dm_vcalloc
);
1037 EXPORT_SYMBOL(dm_get_device
);
1038 EXPORT_SYMBOL(dm_put_device
);
1039 EXPORT_SYMBOL(dm_table_event
);
1040 EXPORT_SYMBOL(dm_table_get_size
);
1041 EXPORT_SYMBOL(dm_table_get_mode
);
1042 EXPORT_SYMBOL(dm_table_get_md
);
1043 EXPORT_SYMBOL(dm_table_put
);
1044 EXPORT_SYMBOL(dm_table_get
);
1045 EXPORT_SYMBOL(dm_table_unplug_all
);
1046 EXPORT_SYMBOL(dm_table_flush_all
);