2 * Copyright (C) 2001, 2002 Sistina Software (UK) Limited.
3 * Copyright (C) 2004 - 2006 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/miscdevice.h>
13 #include <linux/init.h>
14 #include <linux/wait.h>
15 #include <linux/slab.h>
16 #include <linux/dm-ioctl.h>
17 #include <linux/hdreg.h>
18 #include <linux/compat.h>
20 #include <asm/uaccess.h>
22 #define DM_MSG_PREFIX "ioctl"
23 #define DM_DRIVER_EMAIL "dm-devel@redhat.com"
25 /*-----------------------------------------------------------------
26 * The ioctl interface needs to be able to look up devices by
28 *---------------------------------------------------------------*/
30 struct list_head name_list
;
31 struct list_head uuid_list
;
35 struct mapped_device
*md
;
36 struct dm_table
*new_map
;
40 * A dummy definition to make RCU happy.
41 * struct dm_table should never be dereferenced in this file.
49 struct dm_target_versions
*vers
, *old_vers
;
55 #define NUM_BUCKETS 64
56 #define MASK_BUCKETS (NUM_BUCKETS - 1)
57 static struct list_head _name_buckets
[NUM_BUCKETS
];
58 static struct list_head _uuid_buckets
[NUM_BUCKETS
];
60 static void dm_hash_remove_all(int keep_open_devices
);
63 * Guards access to both hash tables.
65 static DECLARE_RWSEM(_hash_lock
);
68 * Protects use of mdptr to obtain hash cell name and uuid from mapped device.
70 static DEFINE_MUTEX(dm_hash_cells_mutex
);
72 static void init_buckets(struct list_head
*buckets
)
76 for (i
= 0; i
< NUM_BUCKETS
; i
++)
77 INIT_LIST_HEAD(buckets
+ i
);
80 static int dm_hash_init(void)
82 init_buckets(_name_buckets
);
83 init_buckets(_uuid_buckets
);
87 static void dm_hash_exit(void)
89 dm_hash_remove_all(0);
92 /*-----------------------------------------------------------------
94 * We're not really concerned with the str hash function being
95 * fast since it's only used by the ioctl interface.
96 *---------------------------------------------------------------*/
97 static unsigned int hash_str(const char *str
)
99 const unsigned int hash_mult
= 2654435387U;
103 h
= (h
+ (unsigned int) *str
++) * hash_mult
;
105 return h
& MASK_BUCKETS
;
108 /*-----------------------------------------------------------------
109 * Code for looking up a device by name
110 *---------------------------------------------------------------*/
111 static struct hash_cell
*__get_name_cell(const char *str
)
113 struct hash_cell
*hc
;
114 unsigned int h
= hash_str(str
);
116 list_for_each_entry (hc
, _name_buckets
+ h
, name_list
)
117 if (!strcmp(hc
->name
, str
)) {
125 static struct hash_cell
*__get_uuid_cell(const char *str
)
127 struct hash_cell
*hc
;
128 unsigned int h
= hash_str(str
);
130 list_for_each_entry (hc
, _uuid_buckets
+ h
, uuid_list
)
131 if (!strcmp(hc
->uuid
, str
)) {
139 static struct hash_cell
*__get_dev_cell(uint64_t dev
)
141 struct mapped_device
*md
;
142 struct hash_cell
*hc
;
144 md
= dm_get_md(huge_decode_dev(dev
));
148 hc
= dm_get_mdptr(md
);
157 /*-----------------------------------------------------------------
158 * Inserting, removing and renaming a device.
159 *---------------------------------------------------------------*/
160 static struct hash_cell
*alloc_cell(const char *name
, const char *uuid
,
161 struct mapped_device
*md
)
163 struct hash_cell
*hc
;
165 hc
= kmalloc(sizeof(*hc
), GFP_KERNEL
);
169 hc
->name
= kstrdup(name
, GFP_KERNEL
);
179 hc
->uuid
= kstrdup(uuid
, GFP_KERNEL
);
187 INIT_LIST_HEAD(&hc
->name_list
);
188 INIT_LIST_HEAD(&hc
->uuid_list
);
194 static void free_cell(struct hash_cell
*hc
)
204 * The kdev_t and uuid of a device can never change once it is
205 * initially inserted.
207 static int dm_hash_insert(const char *name
, const char *uuid
, struct mapped_device
*md
)
209 struct hash_cell
*cell
, *hc
;
212 * Allocate the new cells.
214 cell
= alloc_cell(name
, uuid
, md
);
219 * Insert the cell into both hash tables.
221 down_write(&_hash_lock
);
222 hc
= __get_name_cell(name
);
228 list_add(&cell
->name_list
, _name_buckets
+ hash_str(name
));
231 hc
= __get_uuid_cell(uuid
);
233 list_del(&cell
->name_list
);
237 list_add(&cell
->uuid_list
, _uuid_buckets
+ hash_str(uuid
));
240 mutex_lock(&dm_hash_cells_mutex
);
241 dm_set_mdptr(md
, cell
);
242 mutex_unlock(&dm_hash_cells_mutex
);
243 up_write(&_hash_lock
);
248 up_write(&_hash_lock
);
253 static struct dm_table
*__hash_remove(struct hash_cell
*hc
)
255 struct dm_table
*table
;
258 /* remove from the dev hash */
259 list_del(&hc
->uuid_list
);
260 list_del(&hc
->name_list
);
261 mutex_lock(&dm_hash_cells_mutex
);
262 dm_set_mdptr(hc
->md
, NULL
);
263 mutex_unlock(&dm_hash_cells_mutex
);
265 table
= dm_get_live_table(hc
->md
, &srcu_idx
);
267 dm_table_event(table
);
268 dm_put_live_table(hc
->md
, srcu_idx
);
279 static void dm_hash_remove_all(int keep_open_devices
)
282 struct hash_cell
*hc
;
283 struct mapped_device
*md
;
289 down_write(&_hash_lock
);
291 for (i
= 0; i
< NUM_BUCKETS
; i
++) {
292 list_for_each_entry(hc
, _name_buckets
+ i
, name_list
) {
296 if (keep_open_devices
&& dm_lock_for_deletion(md
)) {
302 t
= __hash_remove(hc
);
304 up_write(&_hash_lock
);
311 if (likely(keep_open_devices
))
314 dm_destroy_immediate(md
);
317 * Some mapped devices may be using other mapped
318 * devices, so repeat until we make no further
319 * progress. If a new mapped device is created
320 * here it will also get removed.
326 up_write(&_hash_lock
);
329 DMWARN("remove_all left %d open device(s)", dev_skipped
);
333 * Set the uuid of a hash_cell that isn't already set.
335 static void __set_cell_uuid(struct hash_cell
*hc
, char *new_uuid
)
337 mutex_lock(&dm_hash_cells_mutex
);
339 mutex_unlock(&dm_hash_cells_mutex
);
341 list_add(&hc
->uuid_list
, _uuid_buckets
+ hash_str(new_uuid
));
345 * Changes the name of a hash_cell and returns the old name for
346 * the caller to free.
348 static char *__change_cell_name(struct hash_cell
*hc
, char *new_name
)
353 * Rename and move the name cell.
355 list_del(&hc
->name_list
);
358 mutex_lock(&dm_hash_cells_mutex
);
360 mutex_unlock(&dm_hash_cells_mutex
);
362 list_add(&hc
->name_list
, _name_buckets
+ hash_str(new_name
));
367 static struct mapped_device
*dm_hash_rename(struct dm_ioctl
*param
,
370 char *new_data
, *old_name
= NULL
;
371 struct hash_cell
*hc
;
372 struct dm_table
*table
;
373 struct mapped_device
*md
;
374 unsigned change_uuid
= (param
->flags
& DM_UUID_FLAG
) ? 1 : 0;
380 new_data
= kstrdup(new, GFP_KERNEL
);
382 return ERR_PTR(-ENOMEM
);
384 down_write(&_hash_lock
);
390 hc
= __get_uuid_cell(new);
392 hc
= __get_name_cell(new);
395 DMWARN("Unable to change %s on mapped device %s to one that "
396 "already exists: %s",
397 change_uuid
? "uuid" : "name",
400 up_write(&_hash_lock
);
402 return ERR_PTR(-EBUSY
);
406 * Is there such a device as 'old' ?
408 hc
= __get_name_cell(param
->name
);
410 DMWARN("Unable to rename non-existent device, %s to %s%s",
411 param
->name
, change_uuid
? "uuid " : "", new);
412 up_write(&_hash_lock
);
414 return ERR_PTR(-ENXIO
);
418 * Does this device already have a uuid?
420 if (change_uuid
&& hc
->uuid
) {
421 DMWARN("Unable to change uuid of mapped device %s to %s "
422 "because uuid is already set to %s",
423 param
->name
, new, hc
->uuid
);
425 up_write(&_hash_lock
);
427 return ERR_PTR(-EINVAL
);
431 __set_cell_uuid(hc
, new_data
);
433 old_name
= __change_cell_name(hc
, new_data
);
436 * Wake up any dm event waiters.
438 table
= dm_get_live_table(hc
->md
, &srcu_idx
);
440 dm_table_event(table
);
441 dm_put_live_table(hc
->md
, srcu_idx
);
443 if (!dm_kobject_uevent(hc
->md
, KOBJ_CHANGE
, param
->event_nr
))
444 param
->flags
|= DM_UEVENT_GENERATED_FLAG
;
447 up_write(&_hash_lock
);
453 /*-----------------------------------------------------------------
454 * Implementation of the ioctl commands
455 *---------------------------------------------------------------*/
457 * All the ioctl commands get dispatched to functions with this
460 typedef int (*ioctl_fn
)(struct dm_ioctl
*param
, size_t param_size
);
462 static int remove_all(struct dm_ioctl
*param
, size_t param_size
)
464 dm_hash_remove_all(1);
465 param
->data_size
= 0;
470 * Round up the ptr to an 8-byte boundary.
473 static inline void *align_ptr(void *ptr
)
475 return (void *) (((size_t) (ptr
+ ALIGN_MASK
)) & ~ALIGN_MASK
);
479 * Retrieves the data payload buffer from an already allocated
482 static void *get_result_buffer(struct dm_ioctl
*param
, size_t param_size
,
485 param
->data_start
= align_ptr(param
+ 1) - (void *) param
;
487 if (param
->data_start
< param_size
)
488 *len
= param_size
- param
->data_start
;
492 return ((void *) param
) + param
->data_start
;
495 static int list_devices(struct dm_ioctl
*param
, size_t param_size
)
498 struct hash_cell
*hc
;
499 size_t len
, needed
= 0;
500 struct gendisk
*disk
;
501 struct dm_name_list
*nl
, *old_nl
= NULL
;
503 down_write(&_hash_lock
);
506 * Loop through all the devices working out how much
509 for (i
= 0; i
< NUM_BUCKETS
; i
++) {
510 list_for_each_entry (hc
, _name_buckets
+ i
, name_list
) {
511 needed
+= sizeof(struct dm_name_list
);
512 needed
+= strlen(hc
->name
) + 1;
513 needed
+= ALIGN_MASK
;
518 * Grab our output buffer.
520 nl
= get_result_buffer(param
, param_size
, &len
);
522 param
->flags
|= DM_BUFFER_FULL_FLAG
;
525 param
->data_size
= param
->data_start
+ needed
;
527 nl
->dev
= 0; /* Flags no data */
530 * Now loop through filling out the names.
532 for (i
= 0; i
< NUM_BUCKETS
; i
++) {
533 list_for_each_entry (hc
, _name_buckets
+ i
, name_list
) {
535 old_nl
->next
= (uint32_t) ((void *) nl
-
537 disk
= dm_disk(hc
->md
);
538 nl
->dev
= huge_encode_dev(disk_devt(disk
));
540 strcpy(nl
->name
, hc
->name
);
543 nl
= align_ptr(((void *) ++nl
) + strlen(hc
->name
) + 1);
548 up_write(&_hash_lock
);
552 static void list_version_get_needed(struct target_type
*tt
, void *needed_param
)
554 size_t *needed
= needed_param
;
556 *needed
+= sizeof(struct dm_target_versions
);
557 *needed
+= strlen(tt
->name
);
558 *needed
+= ALIGN_MASK
;
561 static void list_version_get_info(struct target_type
*tt
, void *param
)
563 struct vers_iter
*info
= param
;
565 /* Check space - it might have changed since the first iteration */
566 if ((char *)info
->vers
+ sizeof(tt
->version
) + strlen(tt
->name
) + 1 >
569 info
->flags
= DM_BUFFER_FULL_FLAG
;
574 info
->old_vers
->next
= (uint32_t) ((void *)info
->vers
-
575 (void *)info
->old_vers
);
576 info
->vers
->version
[0] = tt
->version
[0];
577 info
->vers
->version
[1] = tt
->version
[1];
578 info
->vers
->version
[2] = tt
->version
[2];
579 info
->vers
->next
= 0;
580 strcpy(info
->vers
->name
, tt
->name
);
582 info
->old_vers
= info
->vers
;
583 info
->vers
= align_ptr(((void *) ++info
->vers
) + strlen(tt
->name
) + 1);
586 static int list_versions(struct dm_ioctl
*param
, size_t param_size
)
588 size_t len
, needed
= 0;
589 struct dm_target_versions
*vers
;
590 struct vers_iter iter_info
;
593 * Loop through all the devices working out how much
596 dm_target_iterate(list_version_get_needed
, &needed
);
599 * Grab our output buffer.
601 vers
= get_result_buffer(param
, param_size
, &len
);
603 param
->flags
|= DM_BUFFER_FULL_FLAG
;
606 param
->data_size
= param
->data_start
+ needed
;
608 iter_info
.param_size
= param_size
;
609 iter_info
.old_vers
= NULL
;
610 iter_info
.vers
= vers
;
612 iter_info
.end
= (char *)vers
+len
;
615 * Now loop through filling out the names & versions.
617 dm_target_iterate(list_version_get_info
, &iter_info
);
618 param
->flags
|= iter_info
.flags
;
624 static int check_name(const char *name
)
626 if (strchr(name
, '/')) {
627 DMWARN("invalid device name");
635 * On successful return, the caller must not attempt to acquire
636 * _hash_lock without first calling dm_table_put, because dm_table_destroy
637 * waits for this dm_table_put and could be called under this lock.
639 static struct dm_table
*dm_get_inactive_table(struct mapped_device
*md
, int *srcu_idx
)
641 struct hash_cell
*hc
;
642 struct dm_table
*table
= NULL
;
644 /* increment rcu count, we don't care about the table pointer */
645 dm_get_live_table(md
, srcu_idx
);
647 down_read(&_hash_lock
);
648 hc
= dm_get_mdptr(md
);
649 if (!hc
|| hc
->md
!= md
) {
650 DMWARN("device has been removed from the dev hash table.");
657 up_read(&_hash_lock
);
662 static struct dm_table
*dm_get_live_or_inactive_table(struct mapped_device
*md
,
663 struct dm_ioctl
*param
,
666 return (param
->flags
& DM_QUERY_INACTIVE_TABLE_FLAG
) ?
667 dm_get_inactive_table(md
, srcu_idx
) : dm_get_live_table(md
, srcu_idx
);
671 * Fills in a dm_ioctl structure, ready for sending back to
674 static void __dev_status(struct mapped_device
*md
, struct dm_ioctl
*param
)
676 struct gendisk
*disk
= dm_disk(md
);
677 struct dm_table
*table
;
680 param
->flags
&= ~(DM_SUSPEND_FLAG
| DM_READONLY_FLAG
|
681 DM_ACTIVE_PRESENT_FLAG
);
683 if (dm_suspended_md(md
))
684 param
->flags
|= DM_SUSPEND_FLAG
;
686 param
->dev
= huge_encode_dev(disk_devt(disk
));
689 * Yes, this will be out of date by the time it gets back
690 * to userland, but it is still very useful for
693 param
->open_count
= dm_open_count(md
);
695 param
->event_nr
= dm_get_event_nr(md
);
696 param
->target_count
= 0;
698 table
= dm_get_live_table(md
, &srcu_idx
);
700 if (!(param
->flags
& DM_QUERY_INACTIVE_TABLE_FLAG
)) {
701 if (get_disk_ro(disk
))
702 param
->flags
|= DM_READONLY_FLAG
;
703 param
->target_count
= dm_table_get_num_targets(table
);
706 param
->flags
|= DM_ACTIVE_PRESENT_FLAG
;
708 dm_put_live_table(md
, srcu_idx
);
710 if (param
->flags
& DM_QUERY_INACTIVE_TABLE_FLAG
) {
712 table
= dm_get_inactive_table(md
, &srcu_idx
);
714 if (!(dm_table_get_mode(table
) & FMODE_WRITE
))
715 param
->flags
|= DM_READONLY_FLAG
;
716 param
->target_count
= dm_table_get_num_targets(table
);
718 dm_put_live_table(md
, srcu_idx
);
722 static int dev_create(struct dm_ioctl
*param
, size_t param_size
)
724 int r
, m
= DM_ANY_MINOR
;
725 struct mapped_device
*md
;
727 r
= check_name(param
->name
);
731 if (param
->flags
& DM_PERSISTENT_DEV_FLAG
)
732 m
= MINOR(huge_decode_dev(param
->dev
));
734 r
= dm_create(m
, &md
);
738 r
= dm_hash_insert(param
->name
, *param
->uuid
? param
->uuid
: NULL
, md
);
745 param
->flags
&= ~DM_INACTIVE_PRESENT_FLAG
;
747 __dev_status(md
, param
);
755 * Always use UUID for lookups if it's present, otherwise use name or dev.
757 static struct hash_cell
*__find_device_hash_cell(struct dm_ioctl
*param
)
759 struct hash_cell
*hc
= NULL
;
762 if (*param
->name
|| param
->dev
)
765 hc
= __get_uuid_cell(param
->uuid
);
768 } else if (*param
->name
) {
772 hc
= __get_name_cell(param
->name
);
775 } else if (param
->dev
) {
776 hc
= __get_dev_cell(param
->dev
);
783 * Sneakily write in both the name and the uuid
784 * while we have the cell.
786 strlcpy(param
->name
, hc
->name
, sizeof(param
->name
));
788 strlcpy(param
->uuid
, hc
->uuid
, sizeof(param
->uuid
));
790 param
->uuid
[0] = '\0';
793 param
->flags
|= DM_INACTIVE_PRESENT_FLAG
;
795 param
->flags
&= ~DM_INACTIVE_PRESENT_FLAG
;
800 static struct mapped_device
*find_device(struct dm_ioctl
*param
)
802 struct hash_cell
*hc
;
803 struct mapped_device
*md
= NULL
;
805 down_read(&_hash_lock
);
806 hc
= __find_device_hash_cell(param
);
809 up_read(&_hash_lock
);
814 static int dev_remove(struct dm_ioctl
*param
, size_t param_size
)
816 struct hash_cell
*hc
;
817 struct mapped_device
*md
;
821 down_write(&_hash_lock
);
822 hc
= __find_device_hash_cell(param
);
825 DMDEBUG_LIMIT("device doesn't appear to be in the dev hash table.");
826 up_write(&_hash_lock
);
833 * Ensure the device is not open and nothing further can open it.
835 r
= dm_lock_for_deletion(md
);
837 DMDEBUG_LIMIT("unable to remove open device %s", hc
->name
);
838 up_write(&_hash_lock
);
843 t
= __hash_remove(hc
);
844 up_write(&_hash_lock
);
851 if (!dm_kobject_uevent(md
, KOBJ_REMOVE
, param
->event_nr
))
852 param
->flags
|= DM_UEVENT_GENERATED_FLAG
;
860 * Check a string doesn't overrun the chunk of
861 * memory we copied from userland.
863 static int invalid_str(char *str
, void *end
)
865 while ((void *) str
< end
)
872 static int dev_rename(struct dm_ioctl
*param
, size_t param_size
)
875 char *new_data
= (char *) param
+ param
->data_start
;
876 struct mapped_device
*md
;
877 unsigned change_uuid
= (param
->flags
& DM_UUID_FLAG
) ? 1 : 0;
879 if (new_data
< param
->data
||
880 invalid_str(new_data
, (void *) param
+ param_size
) || !*new_data
||
881 strlen(new_data
) > (change_uuid
? DM_UUID_LEN
- 1 : DM_NAME_LEN
- 1)) {
882 DMWARN("Invalid new mapped device name or uuid string supplied.");
887 r
= check_name(new_data
);
892 md
= dm_hash_rename(param
, new_data
);
896 __dev_status(md
, param
);
902 static int dev_set_geometry(struct dm_ioctl
*param
, size_t param_size
)
905 struct mapped_device
*md
;
906 struct hd_geometry geometry
;
907 unsigned long indata
[4];
908 char *geostr
= (char *) param
+ param
->data_start
;
911 md
= find_device(param
);
915 if (geostr
< param
->data
||
916 invalid_str(geostr
, (void *) param
+ param_size
)) {
917 DMWARN("Invalid geometry supplied.");
921 x
= sscanf(geostr
, "%lu %lu %lu %lu%c", indata
,
922 indata
+ 1, indata
+ 2, indata
+ 3, &dummy
);
925 DMWARN("Unable to interpret geometry settings.");
929 if (indata
[0] > 65535 || indata
[1] > 255 ||
930 indata
[2] > 255 || indata
[3] > ULONG_MAX
) {
931 DMWARN("Geometry exceeds range limits.");
935 geometry
.cylinders
= indata
[0];
936 geometry
.heads
= indata
[1];
937 geometry
.sectors
= indata
[2];
938 geometry
.start
= indata
[3];
940 r
= dm_set_geometry(md
, &geometry
);
942 param
->data_size
= 0;
949 static int do_suspend(struct dm_ioctl
*param
)
952 unsigned suspend_flags
= DM_SUSPEND_LOCKFS_FLAG
;
953 struct mapped_device
*md
;
955 md
= find_device(param
);
959 if (param
->flags
& DM_SKIP_LOCKFS_FLAG
)
960 suspend_flags
&= ~DM_SUSPEND_LOCKFS_FLAG
;
961 if (param
->flags
& DM_NOFLUSH_FLAG
)
962 suspend_flags
|= DM_SUSPEND_NOFLUSH_FLAG
;
964 if (!dm_suspended_md(md
)) {
965 r
= dm_suspend(md
, suspend_flags
);
970 __dev_status(md
, param
);
978 static int do_resume(struct dm_ioctl
*param
)
981 unsigned suspend_flags
= DM_SUSPEND_LOCKFS_FLAG
;
982 struct hash_cell
*hc
;
983 struct mapped_device
*md
;
984 struct dm_table
*new_map
, *old_map
= NULL
;
986 down_write(&_hash_lock
);
988 hc
= __find_device_hash_cell(param
);
990 DMDEBUG_LIMIT("device doesn't appear to be in the dev hash table.");
991 up_write(&_hash_lock
);
997 new_map
= hc
->new_map
;
999 param
->flags
&= ~DM_INACTIVE_PRESENT_FLAG
;
1001 up_write(&_hash_lock
);
1003 /* Do we need to load a new map ? */
1005 /* Suspend if it isn't already suspended */
1006 if (param
->flags
& DM_SKIP_LOCKFS_FLAG
)
1007 suspend_flags
&= ~DM_SUSPEND_LOCKFS_FLAG
;
1008 if (param
->flags
& DM_NOFLUSH_FLAG
)
1009 suspend_flags
|= DM_SUSPEND_NOFLUSH_FLAG
;
1010 if (!dm_suspended_md(md
))
1011 dm_suspend(md
, suspend_flags
);
1013 old_map
= dm_swap_table(md
, new_map
);
1014 if (IS_ERR(old_map
)) {
1016 dm_table_destroy(new_map
);
1018 return PTR_ERR(old_map
);
1021 if (dm_table_get_mode(new_map
) & FMODE_WRITE
)
1022 set_disk_ro(dm_disk(md
), 0);
1024 set_disk_ro(dm_disk(md
), 1);
1027 if (dm_suspended_md(md
)) {
1029 if (!r
&& !dm_kobject_uevent(md
, KOBJ_CHANGE
, param
->event_nr
))
1030 param
->flags
|= DM_UEVENT_GENERATED_FLAG
;
1034 * Since dm_swap_table synchronizes RCU, nobody should be in
1035 * read-side critical section already.
1038 dm_table_destroy(old_map
);
1041 __dev_status(md
, param
);
1048 * Set or unset the suspension state of a device.
1049 * If the device already is in the requested state we just return its status.
1051 static int dev_suspend(struct dm_ioctl
*param
, size_t param_size
)
1053 if (param
->flags
& DM_SUSPEND_FLAG
)
1054 return do_suspend(param
);
1056 return do_resume(param
);
1060 * Copies device info back to user space, used by
1061 * the create and info ioctls.
1063 static int dev_status(struct dm_ioctl
*param
, size_t param_size
)
1065 struct mapped_device
*md
;
1067 md
= find_device(param
);
1071 __dev_status(md
, param
);
1078 * Build up the status struct for each target
1080 static void retrieve_status(struct dm_table
*table
,
1081 struct dm_ioctl
*param
, size_t param_size
)
1083 unsigned int i
, num_targets
;
1084 struct dm_target_spec
*spec
;
1085 char *outbuf
, *outptr
;
1087 size_t remaining
, len
, used
= 0;
1088 unsigned status_flags
= 0;
1090 outptr
= outbuf
= get_result_buffer(param
, param_size
, &len
);
1092 if (param
->flags
& DM_STATUS_TABLE_FLAG
)
1093 type
= STATUSTYPE_TABLE
;
1095 type
= STATUSTYPE_INFO
;
1097 /* Get all the target info */
1098 num_targets
= dm_table_get_num_targets(table
);
1099 for (i
= 0; i
< num_targets
; i
++) {
1100 struct dm_target
*ti
= dm_table_get_target(table
, i
);
1103 remaining
= len
- (outptr
- outbuf
);
1104 if (remaining
<= sizeof(struct dm_target_spec
)) {
1105 param
->flags
|= DM_BUFFER_FULL_FLAG
;
1109 spec
= (struct dm_target_spec
*) outptr
;
1112 spec
->sector_start
= ti
->begin
;
1113 spec
->length
= ti
->len
;
1114 strncpy(spec
->target_type
, ti
->type
->name
,
1115 sizeof(spec
->target_type
));
1117 outptr
+= sizeof(struct dm_target_spec
);
1118 remaining
= len
- (outptr
- outbuf
);
1119 if (remaining
<= 0) {
1120 param
->flags
|= DM_BUFFER_FULL_FLAG
;
1124 /* Get the status/table string from the target driver */
1125 if (ti
->type
->status
) {
1126 if (param
->flags
& DM_NOFLUSH_FLAG
)
1127 status_flags
|= DM_STATUS_NOFLUSH_FLAG
;
1128 ti
->type
->status(ti
, type
, status_flags
, outptr
, remaining
);
1132 l
= strlen(outptr
) + 1;
1133 if (l
== remaining
) {
1134 param
->flags
|= DM_BUFFER_FULL_FLAG
;
1139 used
= param
->data_start
+ (outptr
- outbuf
);
1141 outptr
= align_ptr(outptr
);
1142 spec
->next
= outptr
- outbuf
;
1146 param
->data_size
= used
;
1148 param
->target_count
= num_targets
;
1152 * Wait for a device to report an event
1154 static int dev_wait(struct dm_ioctl
*param
, size_t param_size
)
1157 struct mapped_device
*md
;
1158 struct dm_table
*table
;
1161 md
= find_device(param
);
1166 * Wait for a notification event
1168 if (dm_wait_event(md
, param
->event_nr
)) {
1174 * The userland program is going to want to know what
1175 * changed to trigger the event, so we may as well tell
1176 * him and save an ioctl.
1178 __dev_status(md
, param
);
1180 table
= dm_get_live_or_inactive_table(md
, param
, &srcu_idx
);
1182 retrieve_status(table
, param
, param_size
);
1183 dm_put_live_table(md
, srcu_idx
);
1191 static inline fmode_t
get_mode(struct dm_ioctl
*param
)
1193 fmode_t mode
= FMODE_READ
| FMODE_WRITE
;
1195 if (param
->flags
& DM_READONLY_FLAG
)
1201 static int next_target(struct dm_target_spec
*last
, uint32_t next
, void *end
,
1202 struct dm_target_spec
**spec
, char **target_params
)
1204 *spec
= (struct dm_target_spec
*) ((unsigned char *) last
+ next
);
1205 *target_params
= (char *) (*spec
+ 1);
1207 if (*spec
< (last
+ 1))
1210 return invalid_str(*target_params
, end
);
1213 static int populate_table(struct dm_table
*table
,
1214 struct dm_ioctl
*param
, size_t param_size
)
1218 struct dm_target_spec
*spec
= (struct dm_target_spec
*) param
;
1219 uint32_t next
= param
->data_start
;
1220 void *end
= (void *) param
+ param_size
;
1221 char *target_params
;
1223 if (!param
->target_count
) {
1224 DMWARN("populate_table: no targets specified");
1228 for (i
= 0; i
< param
->target_count
; i
++) {
1230 r
= next_target(spec
, next
, end
, &spec
, &target_params
);
1232 DMWARN("unable to find target");
1236 r
= dm_table_add_target(table
, spec
->target_type
,
1237 (sector_t
) spec
->sector_start
,
1238 (sector_t
) spec
->length
,
1241 DMWARN("error adding target to table");
1248 return dm_table_complete(table
);
1251 static int table_load(struct dm_ioctl
*param
, size_t param_size
)
1254 struct hash_cell
*hc
;
1255 struct dm_table
*t
, *old_map
= NULL
;
1256 struct mapped_device
*md
;
1257 struct target_type
*immutable_target_type
;
1259 md
= find_device(param
);
1263 r
= dm_table_create(&t
, get_mode(param
), param
->target_count
, md
);
1267 /* Protect md->type and md->queue against concurrent table loads. */
1268 dm_lock_md_type(md
);
1269 r
= populate_table(t
, param
, param_size
);
1271 goto err_unlock_md_type
;
1273 immutable_target_type
= dm_get_immutable_target_type(md
);
1274 if (immutable_target_type
&&
1275 (immutable_target_type
!= dm_table_get_immutable_target_type(t
))) {
1276 DMWARN("can't replace immutable target type %s",
1277 immutable_target_type
->name
);
1279 goto err_unlock_md_type
;
1282 if (dm_get_md_type(md
) == DM_TYPE_NONE
)
1283 /* Initial table load: acquire type of table. */
1284 dm_set_md_type(md
, dm_table_get_type(t
));
1285 else if (dm_get_md_type(md
) != dm_table_get_type(t
)) {
1286 DMWARN("can't change device type after initial table load.");
1288 goto err_unlock_md_type
;
1291 /* setup md->queue to reflect md's type (may block) */
1292 r
= dm_setup_md_queue(md
);
1294 DMWARN("unable to set up device queue for new table.");
1295 goto err_unlock_md_type
;
1297 dm_unlock_md_type(md
);
1299 /* stage inactive table */
1300 down_write(&_hash_lock
);
1301 hc
= dm_get_mdptr(md
);
1302 if (!hc
|| hc
->md
!= md
) {
1303 DMWARN("device has been removed from the dev hash table.");
1304 up_write(&_hash_lock
);
1306 goto err_destroy_table
;
1310 old_map
= hc
->new_map
;
1312 up_write(&_hash_lock
);
1314 param
->flags
|= DM_INACTIVE_PRESENT_FLAG
;
1315 __dev_status(md
, param
);
1319 dm_table_destroy(old_map
);
1327 dm_unlock_md_type(md
);
1329 dm_table_destroy(t
);
1336 static int table_clear(struct dm_ioctl
*param
, size_t param_size
)
1338 struct hash_cell
*hc
;
1339 struct mapped_device
*md
;
1340 struct dm_table
*old_map
= NULL
;
1342 down_write(&_hash_lock
);
1344 hc
= __find_device_hash_cell(param
);
1346 DMDEBUG_LIMIT("device doesn't appear to be in the dev hash table.");
1347 up_write(&_hash_lock
);
1352 old_map
= hc
->new_map
;
1356 param
->flags
&= ~DM_INACTIVE_PRESENT_FLAG
;
1358 __dev_status(hc
->md
, param
);
1360 up_write(&_hash_lock
);
1363 dm_table_destroy(old_map
);
1371 * Retrieves a list of devices used by a particular dm device.
1373 static void retrieve_deps(struct dm_table
*table
,
1374 struct dm_ioctl
*param
, size_t param_size
)
1376 unsigned int count
= 0;
1377 struct list_head
*tmp
;
1379 struct dm_dev_internal
*dd
;
1380 struct dm_target_deps
*deps
;
1382 deps
= get_result_buffer(param
, param_size
, &len
);
1385 * Count the devices.
1387 list_for_each (tmp
, dm_table_get_devices(table
))
1391 * Check we have enough space.
1393 needed
= sizeof(*deps
) + (sizeof(*deps
->dev
) * count
);
1395 param
->flags
|= DM_BUFFER_FULL_FLAG
;
1400 * Fill in the devices.
1402 deps
->count
= count
;
1404 list_for_each_entry (dd
, dm_table_get_devices(table
), list
)
1405 deps
->dev
[count
++] = huge_encode_dev(dd
->dm_dev
.bdev
->bd_dev
);
1407 param
->data_size
= param
->data_start
+ needed
;
1410 static int table_deps(struct dm_ioctl
*param
, size_t param_size
)
1412 struct mapped_device
*md
;
1413 struct dm_table
*table
;
1416 md
= find_device(param
);
1420 __dev_status(md
, param
);
1422 table
= dm_get_live_or_inactive_table(md
, param
, &srcu_idx
);
1424 retrieve_deps(table
, param
, param_size
);
1425 dm_put_live_table(md
, srcu_idx
);
1433 * Return the status of a device as a text string for each
1436 static int table_status(struct dm_ioctl
*param
, size_t param_size
)
1438 struct mapped_device
*md
;
1439 struct dm_table
*table
;
1442 md
= find_device(param
);
1446 __dev_status(md
, param
);
1448 table
= dm_get_live_or_inactive_table(md
, param
, &srcu_idx
);
1450 retrieve_status(table
, param
, param_size
);
1451 dm_put_live_table(md
, srcu_idx
);
1459 * Process device-mapper dependent messages. Messages prefixed with '@'
1460 * are processed by the DM core. All others are delivered to the target.
1461 * Returns a number <= 1 if message was processed by device mapper.
1462 * Returns 2 if message should be delivered to the target.
1464 static int message_for_md(struct mapped_device
*md
, unsigned argc
, char **argv
,
1465 char *result
, unsigned maxlen
)
1470 return 2; /* no '@' prefix, deliver to target */
1472 r
= dm_stats_message(md
, argc
, argv
, result
, maxlen
);
1476 DMERR("Unsupported message sent to DM core: %s", argv
[0]);
1481 * Pass a message to the target that's at the supplied device offset.
1483 static int target_message(struct dm_ioctl
*param
, size_t param_size
)
1487 struct mapped_device
*md
;
1488 struct dm_table
*table
;
1489 struct dm_target
*ti
;
1490 struct dm_target_msg
*tmsg
= (void *) param
+ param
->data_start
;
1492 char *result
= get_result_buffer(param
, param_size
, &maxlen
);
1495 md
= find_device(param
);
1499 if (tmsg
< (struct dm_target_msg
*) param
->data
||
1500 invalid_str(tmsg
->message
, (void *) param
+ param_size
)) {
1501 DMWARN("Invalid target message parameters.");
1506 r
= dm_split_args(&argc
, &argv
, tmsg
->message
);
1508 DMWARN("Failed to split target message parameters");
1513 DMWARN("Empty message received.");
1517 r
= message_for_md(md
, argc
, argv
, result
, maxlen
);
1521 table
= dm_get_live_table(md
, &srcu_idx
);
1525 if (dm_deleting_md(md
)) {
1530 ti
= dm_table_find_target(table
, tmsg
->sector
);
1531 if (!dm_target_is_valid(ti
)) {
1532 DMWARN("Target message sector outside device.");
1534 } else if (ti
->type
->message
)
1535 r
= ti
->type
->message(ti
, argc
, argv
);
1537 DMWARN("Target type does not support messages");
1542 dm_put_live_table(md
, srcu_idx
);
1547 __dev_status(md
, param
);
1550 param
->flags
|= DM_DATA_OUT_FLAG
;
1551 if (dm_message_test_buffer_overflow(result
, maxlen
))
1552 param
->flags
|= DM_BUFFER_FULL_FLAG
;
1554 param
->data_size
= param
->data_start
+ strlen(result
) + 1;
1563 * The ioctl parameter block consists of two parts, a dm_ioctl struct
1564 * followed by a data buffer. This flag is set if the second part,
1565 * which has a variable size, is not used by the function processing
1568 #define IOCTL_FLAGS_NO_PARAMS 1
1570 /*-----------------------------------------------------------------
1571 * Implementation of open/close/ioctl on the special char
1573 *---------------------------------------------------------------*/
1574 static ioctl_fn
lookup_ioctl(unsigned int cmd
, int *ioctl_flags
)
1581 {DM_VERSION_CMD
, 0, NULL
}, /* version is dealt with elsewhere */
1582 {DM_REMOVE_ALL_CMD
, IOCTL_FLAGS_NO_PARAMS
, remove_all
},
1583 {DM_LIST_DEVICES_CMD
, 0, list_devices
},
1585 {DM_DEV_CREATE_CMD
, IOCTL_FLAGS_NO_PARAMS
, dev_create
},
1586 {DM_DEV_REMOVE_CMD
, IOCTL_FLAGS_NO_PARAMS
, dev_remove
},
1587 {DM_DEV_RENAME_CMD
, 0, dev_rename
},
1588 {DM_DEV_SUSPEND_CMD
, IOCTL_FLAGS_NO_PARAMS
, dev_suspend
},
1589 {DM_DEV_STATUS_CMD
, IOCTL_FLAGS_NO_PARAMS
, dev_status
},
1590 {DM_DEV_WAIT_CMD
, 0, dev_wait
},
1592 {DM_TABLE_LOAD_CMD
, 0, table_load
},
1593 {DM_TABLE_CLEAR_CMD
, IOCTL_FLAGS_NO_PARAMS
, table_clear
},
1594 {DM_TABLE_DEPS_CMD
, 0, table_deps
},
1595 {DM_TABLE_STATUS_CMD
, 0, table_status
},
1597 {DM_LIST_VERSIONS_CMD
, 0, list_versions
},
1599 {DM_TARGET_MSG_CMD
, 0, target_message
},
1600 {DM_DEV_SET_GEOMETRY_CMD
, 0, dev_set_geometry
}
1603 if (unlikely(cmd
>= ARRAY_SIZE(_ioctls
)))
1606 *ioctl_flags
= _ioctls
[cmd
].flags
;
1607 return _ioctls
[cmd
].fn
;
1611 * As well as checking the version compatibility this always
1612 * copies the kernel interface version out.
1614 static int check_version(unsigned int cmd
, struct dm_ioctl __user
*user
)
1616 uint32_t version
[3];
1619 if (copy_from_user(version
, user
->version
, sizeof(version
)))
1622 if ((DM_VERSION_MAJOR
!= version
[0]) ||
1623 (DM_VERSION_MINOR
< version
[1])) {
1624 DMWARN("ioctl interface mismatch: "
1625 "kernel(%u.%u.%u), user(%u.%u.%u), cmd(%d)",
1626 DM_VERSION_MAJOR
, DM_VERSION_MINOR
,
1627 DM_VERSION_PATCHLEVEL
,
1628 version
[0], version
[1], version
[2], cmd
);
1633 * Fill in the kernel version.
1635 version
[0] = DM_VERSION_MAJOR
;
1636 version
[1] = DM_VERSION_MINOR
;
1637 version
[2] = DM_VERSION_PATCHLEVEL
;
1638 if (copy_to_user(user
->version
, version
, sizeof(version
)))
1644 #define DM_PARAMS_KMALLOC 0x0001 /* Params alloced with kmalloc */
1645 #define DM_PARAMS_VMALLOC 0x0002 /* Params alloced with vmalloc */
1646 #define DM_WIPE_BUFFER 0x0010 /* Wipe input buffer before returning from ioctl */
1648 static void free_params(struct dm_ioctl
*param
, size_t param_size
, int param_flags
)
1650 if (param_flags
& DM_WIPE_BUFFER
)
1651 memset(param
, 0, param_size
);
1653 if (param_flags
& DM_PARAMS_KMALLOC
)
1655 if (param_flags
& DM_PARAMS_VMALLOC
)
1659 static int copy_params(struct dm_ioctl __user
*user
, struct dm_ioctl
*param_kernel
,
1661 struct dm_ioctl
**param
, int *param_flags
)
1663 struct dm_ioctl
*dmi
;
1665 const size_t minimum_data_size
= sizeof(*param_kernel
) - sizeof(param_kernel
->data
);
1667 if (copy_from_user(param_kernel
, user
, minimum_data_size
))
1670 if (param_kernel
->data_size
< minimum_data_size
)
1673 secure_data
= param_kernel
->flags
& DM_SECURE_DATA_FLAG
;
1675 *param_flags
= secure_data
? DM_WIPE_BUFFER
: 0;
1677 if (ioctl_flags
& IOCTL_FLAGS_NO_PARAMS
) {
1679 dmi
->data_size
= minimum_data_size
;
1684 * Try to avoid low memory issues when a device is suspended.
1685 * Use kmalloc() rather than vmalloc() when we can.
1688 if (param_kernel
->data_size
<= KMALLOC_MAX_SIZE
) {
1689 dmi
= kmalloc(param_kernel
->data_size
, GFP_NOIO
| __GFP_NORETRY
| __GFP_NOMEMALLOC
| __GFP_NOWARN
);
1691 *param_flags
|= DM_PARAMS_KMALLOC
;
1696 noio_flag
= memalloc_noio_save();
1697 dmi
= __vmalloc(param_kernel
->data_size
, GFP_NOIO
| __GFP_REPEAT
| __GFP_HIGH
| __GFP_HIGHMEM
, PAGE_KERNEL
);
1698 memalloc_noio_restore(noio_flag
);
1700 *param_flags
|= DM_PARAMS_VMALLOC
;
1704 if (secure_data
&& clear_user(user
, param_kernel
->data_size
))
1709 if (copy_from_user(dmi
, user
, param_kernel
->data_size
))
1714 * Abort if something changed the ioctl data while it was being copied.
1716 if (dmi
->data_size
!= param_kernel
->data_size
) {
1717 DMERR("rejecting ioctl: data size modified while processing parameters");
1721 /* Wipe the user buffer so we do not return it to userspace */
1722 if (secure_data
&& clear_user(user
, param_kernel
->data_size
))
1729 free_params(dmi
, param_kernel
->data_size
, *param_flags
);
1734 static int validate_params(uint cmd
, struct dm_ioctl
*param
)
1736 /* Always clear this flag */
1737 param
->flags
&= ~DM_BUFFER_FULL_FLAG
;
1738 param
->flags
&= ~DM_UEVENT_GENERATED_FLAG
;
1739 param
->flags
&= ~DM_SECURE_DATA_FLAG
;
1740 param
->flags
&= ~DM_DATA_OUT_FLAG
;
1742 /* Ignores parameters */
1743 if (cmd
== DM_REMOVE_ALL_CMD
||
1744 cmd
== DM_LIST_DEVICES_CMD
||
1745 cmd
== DM_LIST_VERSIONS_CMD
)
1748 if ((cmd
== DM_DEV_CREATE_CMD
)) {
1749 if (!*param
->name
) {
1750 DMWARN("name not supplied when creating device");
1753 } else if ((*param
->uuid
&& *param
->name
)) {
1754 DMWARN("only supply one of name or uuid, cmd(%u)", cmd
);
1758 /* Ensure strings are terminated */
1759 param
->name
[DM_NAME_LEN
- 1] = '\0';
1760 param
->uuid
[DM_UUID_LEN
- 1] = '\0';
1765 static int ctl_ioctl(uint command
, struct dm_ioctl __user
*user
)
1771 struct dm_ioctl
*uninitialized_var(param
);
1773 size_t input_param_size
;
1774 struct dm_ioctl param_kernel
;
1776 /* only root can play with this */
1777 if (!capable(CAP_SYS_ADMIN
))
1780 if (_IOC_TYPE(command
) != DM_IOCTL
)
1783 cmd
= _IOC_NR(command
);
1786 * Check the interface version passed in. This also
1787 * writes out the kernel's interface version.
1789 r
= check_version(cmd
, user
);
1794 * Nothing more to do for the version command.
1796 if (cmd
== DM_VERSION_CMD
)
1799 fn
= lookup_ioctl(cmd
, &ioctl_flags
);
1801 DMWARN("dm_ctl_ioctl: unknown command 0x%x", command
);
1806 * Copy the parameters into kernel space.
1808 r
= copy_params(user
, ¶m_kernel
, ioctl_flags
, ¶m
, ¶m_flags
);
1813 input_param_size
= param
->data_size
;
1814 r
= validate_params(cmd
, param
);
1818 param
->data_size
= sizeof(*param
);
1819 r
= fn(param
, input_param_size
);
1821 if (unlikely(param
->flags
& DM_BUFFER_FULL_FLAG
) &&
1822 unlikely(ioctl_flags
& IOCTL_FLAGS_NO_PARAMS
))
1823 DMERR("ioctl %d tried to output some data but has IOCTL_FLAGS_NO_PARAMS set", cmd
);
1826 * Copy the results back to userland.
1828 if (!r
&& copy_to_user(user
, param
, param
->data_size
))
1832 free_params(param
, input_param_size
, param_flags
);
1836 static long dm_ctl_ioctl(struct file
*file
, uint command
, ulong u
)
1838 return (long)ctl_ioctl(command
, (struct dm_ioctl __user
*)u
);
1841 #ifdef CONFIG_COMPAT
1842 static long dm_compat_ctl_ioctl(struct file
*file
, uint command
, ulong u
)
1844 return (long)dm_ctl_ioctl(file
, command
, (ulong
) compat_ptr(u
));
1847 #define dm_compat_ctl_ioctl NULL
1850 static const struct file_operations _ctl_fops
= {
1851 .open
= nonseekable_open
,
1852 .unlocked_ioctl
= dm_ctl_ioctl
,
1853 .compat_ioctl
= dm_compat_ctl_ioctl
,
1854 .owner
= THIS_MODULE
,
1855 .llseek
= noop_llseek
,
1858 static struct miscdevice _dm_misc
= {
1859 .minor
= MAPPER_CTRL_MINOR
,
1861 .nodename
= DM_DIR
"/" DM_CONTROL_NODE
,
1865 MODULE_ALIAS_MISCDEV(MAPPER_CTRL_MINOR
);
1866 MODULE_ALIAS("devname:" DM_DIR
"/" DM_CONTROL_NODE
);
1869 * Create misc character device and link to DM_DIR/control.
1871 int __init
dm_interface_init(void)
1879 r
= misc_register(&_dm_misc
);
1881 DMERR("misc_register failed for control device");
1886 DMINFO("%d.%d.%d%s initialised: %s", DM_VERSION_MAJOR
,
1887 DM_VERSION_MINOR
, DM_VERSION_PATCHLEVEL
, DM_VERSION_EXTRA
,
1892 void dm_interface_exit(void)
1894 if (misc_deregister(&_dm_misc
) < 0)
1895 DMERR("misc_deregister failed for control device");
1901 * dm_copy_name_and_uuid - Copy mapped device name & uuid into supplied buffers
1902 * @md: Pointer to mapped_device
1903 * @name: Buffer (size DM_NAME_LEN) for name
1904 * @uuid: Buffer (size DM_UUID_LEN) for uuid or empty string if uuid not defined
1906 int dm_copy_name_and_uuid(struct mapped_device
*md
, char *name
, char *uuid
)
1909 struct hash_cell
*hc
;
1914 mutex_lock(&dm_hash_cells_mutex
);
1915 hc
= dm_get_mdptr(md
);
1916 if (!hc
|| hc
->md
!= md
) {
1922 strcpy(name
, hc
->name
);
1924 strcpy(uuid
, hc
->uuid
? : "");
1927 mutex_unlock(&dm_hash_cells_mutex
);