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
;
41 struct dm_target_versions
*vers
, *old_vers
;
47 #define NUM_BUCKETS 64
48 #define MASK_BUCKETS (NUM_BUCKETS - 1)
49 static struct list_head _name_buckets
[NUM_BUCKETS
];
50 static struct list_head _uuid_buckets
[NUM_BUCKETS
];
52 static void dm_hash_remove_all(int keep_open_devices
);
55 * Guards access to both hash tables.
57 static DECLARE_RWSEM(_hash_lock
);
60 * Protects use of mdptr to obtain hash cell name and uuid from mapped device.
62 static DEFINE_MUTEX(dm_hash_cells_mutex
);
64 static void init_buckets(struct list_head
*buckets
)
68 for (i
= 0; i
< NUM_BUCKETS
; i
++)
69 INIT_LIST_HEAD(buckets
+ i
);
72 static int dm_hash_init(void)
74 init_buckets(_name_buckets
);
75 init_buckets(_uuid_buckets
);
79 static void dm_hash_exit(void)
81 dm_hash_remove_all(0);
84 /*-----------------------------------------------------------------
86 * We're not really concerned with the str hash function being
87 * fast since it's only used by the ioctl interface.
88 *---------------------------------------------------------------*/
89 static unsigned int hash_str(const char *str
)
91 const unsigned int hash_mult
= 2654435387U;
95 h
= (h
+ (unsigned int) *str
++) * hash_mult
;
97 return h
& MASK_BUCKETS
;
100 /*-----------------------------------------------------------------
101 * Code for looking up a device by name
102 *---------------------------------------------------------------*/
103 static struct hash_cell
*__get_name_cell(const char *str
)
105 struct hash_cell
*hc
;
106 unsigned int h
= hash_str(str
);
108 list_for_each_entry (hc
, _name_buckets
+ h
, name_list
)
109 if (!strcmp(hc
->name
, str
)) {
117 static struct hash_cell
*__get_uuid_cell(const char *str
)
119 struct hash_cell
*hc
;
120 unsigned int h
= hash_str(str
);
122 list_for_each_entry (hc
, _uuid_buckets
+ h
, uuid_list
)
123 if (!strcmp(hc
->uuid
, str
)) {
131 /*-----------------------------------------------------------------
132 * Inserting, removing and renaming a device.
133 *---------------------------------------------------------------*/
134 static struct hash_cell
*alloc_cell(const char *name
, const char *uuid
,
135 struct mapped_device
*md
)
137 struct hash_cell
*hc
;
139 hc
= kmalloc(sizeof(*hc
), GFP_KERNEL
);
143 hc
->name
= kstrdup(name
, GFP_KERNEL
);
153 hc
->uuid
= kstrdup(uuid
, GFP_KERNEL
);
161 INIT_LIST_HEAD(&hc
->name_list
);
162 INIT_LIST_HEAD(&hc
->uuid_list
);
168 static void free_cell(struct hash_cell
*hc
)
178 * The kdev_t and uuid of a device can never change once it is
179 * initially inserted.
181 static int dm_hash_insert(const char *name
, const char *uuid
, struct mapped_device
*md
)
183 struct hash_cell
*cell
, *hc
;
186 * Allocate the new cells.
188 cell
= alloc_cell(name
, uuid
, md
);
193 * Insert the cell into both hash tables.
195 down_write(&_hash_lock
);
196 hc
= __get_name_cell(name
);
202 list_add(&cell
->name_list
, _name_buckets
+ hash_str(name
));
205 hc
= __get_uuid_cell(uuid
);
207 list_del(&cell
->name_list
);
211 list_add(&cell
->uuid_list
, _uuid_buckets
+ hash_str(uuid
));
214 mutex_lock(&dm_hash_cells_mutex
);
215 dm_set_mdptr(md
, cell
);
216 mutex_unlock(&dm_hash_cells_mutex
);
217 up_write(&_hash_lock
);
222 up_write(&_hash_lock
);
227 static void __hash_remove(struct hash_cell
*hc
)
229 struct dm_table
*table
;
231 /* remove from the dev hash */
232 list_del(&hc
->uuid_list
);
233 list_del(&hc
->name_list
);
234 mutex_lock(&dm_hash_cells_mutex
);
235 dm_set_mdptr(hc
->md
, NULL
);
236 mutex_unlock(&dm_hash_cells_mutex
);
238 table
= dm_get_live_table(hc
->md
);
240 dm_table_event(table
);
245 dm_table_destroy(hc
->new_map
);
250 static void dm_hash_remove_all(int keep_open_devices
)
252 int i
, dev_skipped
, dev_removed
;
253 struct hash_cell
*hc
;
254 struct list_head
*tmp
, *n
;
256 down_write(&_hash_lock
);
259 dev_skipped
= dev_removed
= 0;
260 for (i
= 0; i
< NUM_BUCKETS
; i
++) {
261 list_for_each_safe (tmp
, n
, _name_buckets
+ i
) {
262 hc
= list_entry(tmp
, struct hash_cell
, name_list
);
264 if (keep_open_devices
&&
265 dm_lock_for_deletion(hc
->md
)) {
275 * Some mapped devices may be using other mapped devices, so if any
276 * still exist, repeat until we make no further progress.
282 DMWARN("remove_all left %d open device(s)", dev_skipped
);
285 up_write(&_hash_lock
);
288 static int dm_hash_rename(uint32_t cookie
, uint32_t *flags
, const char *old
,
291 char *new_name
, *old_name
;
292 struct hash_cell
*hc
;
293 struct dm_table
*table
;
298 new_name
= kstrdup(new, GFP_KERNEL
);
302 down_write(&_hash_lock
);
307 hc
= __get_name_cell(new);
309 DMWARN("asked to rename to an already existing name %s -> %s",
312 up_write(&_hash_lock
);
318 * Is there such a device as 'old' ?
320 hc
= __get_name_cell(old
);
322 DMWARN("asked to rename a non existent device %s -> %s",
324 up_write(&_hash_lock
);
330 * rename and move the name cell.
332 list_del(&hc
->name_list
);
334 mutex_lock(&dm_hash_cells_mutex
);
336 mutex_unlock(&dm_hash_cells_mutex
);
337 list_add(&hc
->name_list
, _name_buckets
+ hash_str(new_name
));
340 * Wake up any dm event waiters.
342 table
= dm_get_live_table(hc
->md
);
344 dm_table_event(table
);
348 if (!dm_kobject_uevent(hc
->md
, KOBJ_CHANGE
, cookie
))
349 *flags
|= DM_UEVENT_GENERATED_FLAG
;
352 up_write(&_hash_lock
);
357 /*-----------------------------------------------------------------
358 * Implementation of the ioctl commands
359 *---------------------------------------------------------------*/
361 * All the ioctl commands get dispatched to functions with this
364 typedef int (*ioctl_fn
)(struct dm_ioctl
*param
, size_t param_size
);
366 static int remove_all(struct dm_ioctl
*param
, size_t param_size
)
368 dm_hash_remove_all(1);
369 param
->data_size
= 0;
374 * Round up the ptr to an 8-byte boundary.
377 static inline void *align_ptr(void *ptr
)
379 return (void *) (((size_t) (ptr
+ ALIGN_MASK
)) & ~ALIGN_MASK
);
383 * Retrieves the data payload buffer from an already allocated
386 static void *get_result_buffer(struct dm_ioctl
*param
, size_t param_size
,
389 param
->data_start
= align_ptr(param
+ 1) - (void *) param
;
391 if (param
->data_start
< param_size
)
392 *len
= param_size
- param
->data_start
;
396 return ((void *) param
) + param
->data_start
;
399 static int list_devices(struct dm_ioctl
*param
, size_t param_size
)
402 struct hash_cell
*hc
;
403 size_t len
, needed
= 0;
404 struct gendisk
*disk
;
405 struct dm_name_list
*nl
, *old_nl
= NULL
;
407 down_write(&_hash_lock
);
410 * Loop through all the devices working out how much
413 for (i
= 0; i
< NUM_BUCKETS
; i
++) {
414 list_for_each_entry (hc
, _name_buckets
+ i
, name_list
) {
415 needed
+= sizeof(struct dm_name_list
);
416 needed
+= strlen(hc
->name
) + 1;
417 needed
+= ALIGN_MASK
;
422 * Grab our output buffer.
424 nl
= get_result_buffer(param
, param_size
, &len
);
426 param
->flags
|= DM_BUFFER_FULL_FLAG
;
429 param
->data_size
= param
->data_start
+ needed
;
431 nl
->dev
= 0; /* Flags no data */
434 * Now loop through filling out the names.
436 for (i
= 0; i
< NUM_BUCKETS
; i
++) {
437 list_for_each_entry (hc
, _name_buckets
+ i
, name_list
) {
439 old_nl
->next
= (uint32_t) ((void *) nl
-
441 disk
= dm_disk(hc
->md
);
442 nl
->dev
= huge_encode_dev(disk_devt(disk
));
444 strcpy(nl
->name
, hc
->name
);
447 nl
= align_ptr(((void *) ++nl
) + strlen(hc
->name
) + 1);
452 up_write(&_hash_lock
);
456 static void list_version_get_needed(struct target_type
*tt
, void *needed_param
)
458 size_t *needed
= needed_param
;
460 *needed
+= sizeof(struct dm_target_versions
);
461 *needed
+= strlen(tt
->name
);
462 *needed
+= ALIGN_MASK
;
465 static void list_version_get_info(struct target_type
*tt
, void *param
)
467 struct vers_iter
*info
= param
;
469 /* Check space - it might have changed since the first iteration */
470 if ((char *)info
->vers
+ sizeof(tt
->version
) + strlen(tt
->name
) + 1 >
473 info
->flags
= DM_BUFFER_FULL_FLAG
;
478 info
->old_vers
->next
= (uint32_t) ((void *)info
->vers
-
479 (void *)info
->old_vers
);
480 info
->vers
->version
[0] = tt
->version
[0];
481 info
->vers
->version
[1] = tt
->version
[1];
482 info
->vers
->version
[2] = tt
->version
[2];
483 info
->vers
->next
= 0;
484 strcpy(info
->vers
->name
, tt
->name
);
486 info
->old_vers
= info
->vers
;
487 info
->vers
= align_ptr(((void *) ++info
->vers
) + strlen(tt
->name
) + 1);
490 static int list_versions(struct dm_ioctl
*param
, size_t param_size
)
492 size_t len
, needed
= 0;
493 struct dm_target_versions
*vers
;
494 struct vers_iter iter_info
;
497 * Loop through all the devices working out how much
500 dm_target_iterate(list_version_get_needed
, &needed
);
503 * Grab our output buffer.
505 vers
= get_result_buffer(param
, param_size
, &len
);
507 param
->flags
|= DM_BUFFER_FULL_FLAG
;
510 param
->data_size
= param
->data_start
+ needed
;
512 iter_info
.param_size
= param_size
;
513 iter_info
.old_vers
= NULL
;
514 iter_info
.vers
= vers
;
516 iter_info
.end
= (char *)vers
+len
;
519 * Now loop through filling out the names & versions.
521 dm_target_iterate(list_version_get_info
, &iter_info
);
522 param
->flags
|= iter_info
.flags
;
528 static int check_name(const char *name
)
530 if (strchr(name
, '/')) {
531 DMWARN("invalid device name");
539 * On successful return, the caller must not attempt to acquire
540 * _hash_lock without first calling dm_table_put, because dm_table_destroy
541 * waits for this dm_table_put and could be called under this lock.
543 static struct dm_table
*dm_get_inactive_table(struct mapped_device
*md
)
545 struct hash_cell
*hc
;
546 struct dm_table
*table
= NULL
;
548 down_read(&_hash_lock
);
549 hc
= dm_get_mdptr(md
);
550 if (!hc
|| hc
->md
!= md
) {
551 DMWARN("device has been removed from the dev hash table.");
560 up_read(&_hash_lock
);
565 static struct dm_table
*dm_get_live_or_inactive_table(struct mapped_device
*md
,
566 struct dm_ioctl
*param
)
568 return (param
->flags
& DM_QUERY_INACTIVE_TABLE_FLAG
) ?
569 dm_get_inactive_table(md
) : dm_get_live_table(md
);
573 * Fills in a dm_ioctl structure, ready for sending back to
576 static int __dev_status(struct mapped_device
*md
, struct dm_ioctl
*param
)
578 struct gendisk
*disk
= dm_disk(md
);
579 struct dm_table
*table
;
581 param
->flags
&= ~(DM_SUSPEND_FLAG
| DM_READONLY_FLAG
|
582 DM_ACTIVE_PRESENT_FLAG
);
584 if (dm_suspended_md(md
))
585 param
->flags
|= DM_SUSPEND_FLAG
;
587 param
->dev
= huge_encode_dev(disk_devt(disk
));
590 * Yes, this will be out of date by the time it gets back
591 * to userland, but it is still very useful for
594 param
->open_count
= dm_open_count(md
);
596 param
->event_nr
= dm_get_event_nr(md
);
597 param
->target_count
= 0;
599 table
= dm_get_live_table(md
);
601 if (!(param
->flags
& DM_QUERY_INACTIVE_TABLE_FLAG
)) {
602 if (get_disk_ro(disk
))
603 param
->flags
|= DM_READONLY_FLAG
;
604 param
->target_count
= dm_table_get_num_targets(table
);
608 param
->flags
|= DM_ACTIVE_PRESENT_FLAG
;
611 if (param
->flags
& DM_QUERY_INACTIVE_TABLE_FLAG
) {
612 table
= dm_get_inactive_table(md
);
614 if (!(dm_table_get_mode(table
) & FMODE_WRITE
))
615 param
->flags
|= DM_READONLY_FLAG
;
616 param
->target_count
= dm_table_get_num_targets(table
);
624 static int dev_create(struct dm_ioctl
*param
, size_t param_size
)
626 int r
, m
= DM_ANY_MINOR
;
627 struct mapped_device
*md
;
629 r
= check_name(param
->name
);
633 if (param
->flags
& DM_PERSISTENT_DEV_FLAG
)
634 m
= MINOR(huge_decode_dev(param
->dev
));
636 r
= dm_create(m
, &md
);
640 r
= dm_hash_insert(param
->name
, *param
->uuid
? param
->uuid
: NULL
, md
);
646 param
->flags
&= ~DM_INACTIVE_PRESENT_FLAG
;
648 r
= __dev_status(md
, param
);
655 * Always use UUID for lookups if it's present, otherwise use name or dev.
657 static struct hash_cell
*__find_device_hash_cell(struct dm_ioctl
*param
)
659 struct mapped_device
*md
;
663 return __get_uuid_cell(param
->uuid
);
666 return __get_name_cell(param
->name
);
668 md
= dm_get_md(huge_decode_dev(param
->dev
));
672 mdptr
= dm_get_mdptr(md
);
680 static struct mapped_device
*find_device(struct dm_ioctl
*param
)
682 struct hash_cell
*hc
;
683 struct mapped_device
*md
= NULL
;
685 down_read(&_hash_lock
);
686 hc
= __find_device_hash_cell(param
);
691 * Sneakily write in both the name and the uuid
692 * while we have the cell.
694 strlcpy(param
->name
, hc
->name
, sizeof(param
->name
));
696 strlcpy(param
->uuid
, hc
->uuid
, sizeof(param
->uuid
));
698 param
->uuid
[0] = '\0';
701 param
->flags
|= DM_INACTIVE_PRESENT_FLAG
;
703 param
->flags
&= ~DM_INACTIVE_PRESENT_FLAG
;
705 up_read(&_hash_lock
);
710 static int dev_remove(struct dm_ioctl
*param
, size_t param_size
)
712 struct hash_cell
*hc
;
713 struct mapped_device
*md
;
716 down_write(&_hash_lock
);
717 hc
= __find_device_hash_cell(param
);
720 DMWARN("device doesn't appear to be in the dev hash table.");
721 up_write(&_hash_lock
);
728 * Ensure the device is not open and nothing further can open it.
730 r
= dm_lock_for_deletion(md
);
732 DMWARN("unable to remove open device %s", hc
->name
);
733 up_write(&_hash_lock
);
739 up_write(&_hash_lock
);
741 if (!dm_kobject_uevent(md
, KOBJ_REMOVE
, param
->event_nr
))
742 param
->flags
|= DM_UEVENT_GENERATED_FLAG
;
749 * Check a string doesn't overrun the chunk of
750 * memory we copied from userland.
752 static int invalid_str(char *str
, void *end
)
754 while ((void *) str
< end
)
761 static int dev_rename(struct dm_ioctl
*param
, size_t param_size
)
764 char *new_name
= (char *) param
+ param
->data_start
;
766 if (new_name
< param
->data
||
767 invalid_str(new_name
, (void *) param
+ param_size
) ||
768 strlen(new_name
) > DM_NAME_LEN
- 1) {
769 DMWARN("Invalid new logical volume name supplied.");
773 r
= check_name(new_name
);
777 param
->data_size
= 0;
779 return dm_hash_rename(param
->event_nr
, ¶m
->flags
, param
->name
,
783 static int dev_set_geometry(struct dm_ioctl
*param
, size_t param_size
)
786 struct mapped_device
*md
;
787 struct hd_geometry geometry
;
788 unsigned long indata
[4];
789 char *geostr
= (char *) param
+ param
->data_start
;
791 md
= find_device(param
);
795 if (geostr
< param
->data
||
796 invalid_str(geostr
, (void *) param
+ param_size
)) {
797 DMWARN("Invalid geometry supplied.");
801 x
= sscanf(geostr
, "%lu %lu %lu %lu", indata
,
802 indata
+ 1, indata
+ 2, indata
+ 3);
805 DMWARN("Unable to interpret geometry settings.");
809 if (indata
[0] > 65535 || indata
[1] > 255 ||
810 indata
[2] > 255 || indata
[3] > ULONG_MAX
) {
811 DMWARN("Geometry exceeds range limits.");
815 geometry
.cylinders
= indata
[0];
816 geometry
.heads
= indata
[1];
817 geometry
.sectors
= indata
[2];
818 geometry
.start
= indata
[3];
820 r
= dm_set_geometry(md
, &geometry
);
822 r
= __dev_status(md
, param
);
824 param
->data_size
= 0;
831 static int do_suspend(struct dm_ioctl
*param
)
834 unsigned suspend_flags
= DM_SUSPEND_LOCKFS_FLAG
;
835 struct mapped_device
*md
;
837 md
= find_device(param
);
841 if (param
->flags
& DM_SKIP_LOCKFS_FLAG
)
842 suspend_flags
&= ~DM_SUSPEND_LOCKFS_FLAG
;
843 if (param
->flags
& DM_NOFLUSH_FLAG
)
844 suspend_flags
|= DM_SUSPEND_NOFLUSH_FLAG
;
846 if (!dm_suspended_md(md
))
847 r
= dm_suspend(md
, suspend_flags
);
850 r
= __dev_status(md
, param
);
856 static int do_resume(struct dm_ioctl
*param
)
859 unsigned suspend_flags
= DM_SUSPEND_LOCKFS_FLAG
;
860 struct hash_cell
*hc
;
861 struct mapped_device
*md
;
862 struct dm_table
*new_map
, *old_map
= NULL
;
864 down_write(&_hash_lock
);
866 hc
= __find_device_hash_cell(param
);
868 DMWARN("device doesn't appear to be in the dev hash table.");
869 up_write(&_hash_lock
);
875 new_map
= hc
->new_map
;
877 param
->flags
&= ~DM_INACTIVE_PRESENT_FLAG
;
879 up_write(&_hash_lock
);
881 /* Do we need to load a new map ? */
883 /* Suspend if it isn't already suspended */
884 if (param
->flags
& DM_SKIP_LOCKFS_FLAG
)
885 suspend_flags
&= ~DM_SUSPEND_LOCKFS_FLAG
;
886 if (param
->flags
& DM_NOFLUSH_FLAG
)
887 suspend_flags
|= DM_SUSPEND_NOFLUSH_FLAG
;
888 if (!dm_suspended_md(md
))
889 dm_suspend(md
, suspend_flags
);
891 old_map
= dm_swap_table(md
, new_map
);
892 if (IS_ERR(old_map
)) {
893 dm_table_destroy(new_map
);
895 return PTR_ERR(old_map
);
898 if (dm_table_get_mode(new_map
) & FMODE_WRITE
)
899 set_disk_ro(dm_disk(md
), 0);
901 set_disk_ro(dm_disk(md
), 1);
904 if (dm_suspended_md(md
)) {
906 if (!r
&& !dm_kobject_uevent(md
, KOBJ_CHANGE
, param
->event_nr
))
907 param
->flags
|= DM_UEVENT_GENERATED_FLAG
;
911 dm_table_destroy(old_map
);
914 r
= __dev_status(md
, param
);
921 * Set or unset the suspension state of a device.
922 * If the device already is in the requested state we just return its status.
924 static int dev_suspend(struct dm_ioctl
*param
, size_t param_size
)
926 if (param
->flags
& DM_SUSPEND_FLAG
)
927 return do_suspend(param
);
929 return do_resume(param
);
933 * Copies device info back to user space, used by
934 * the create and info ioctls.
936 static int dev_status(struct dm_ioctl
*param
, size_t param_size
)
939 struct mapped_device
*md
;
941 md
= find_device(param
);
945 r
= __dev_status(md
, param
);
951 * Build up the status struct for each target
953 static void retrieve_status(struct dm_table
*table
,
954 struct dm_ioctl
*param
, size_t param_size
)
956 unsigned int i
, num_targets
;
957 struct dm_target_spec
*spec
;
958 char *outbuf
, *outptr
;
960 size_t remaining
, len
, used
= 0;
962 outptr
= outbuf
= get_result_buffer(param
, param_size
, &len
);
964 if (param
->flags
& DM_STATUS_TABLE_FLAG
)
965 type
= STATUSTYPE_TABLE
;
967 type
= STATUSTYPE_INFO
;
969 /* Get all the target info */
970 num_targets
= dm_table_get_num_targets(table
);
971 for (i
= 0; i
< num_targets
; i
++) {
972 struct dm_target
*ti
= dm_table_get_target(table
, i
);
974 remaining
= len
- (outptr
- outbuf
);
975 if (remaining
<= sizeof(struct dm_target_spec
)) {
976 param
->flags
|= DM_BUFFER_FULL_FLAG
;
980 spec
= (struct dm_target_spec
*) outptr
;
983 spec
->sector_start
= ti
->begin
;
984 spec
->length
= ti
->len
;
985 strncpy(spec
->target_type
, ti
->type
->name
,
986 sizeof(spec
->target_type
));
988 outptr
+= sizeof(struct dm_target_spec
);
989 remaining
= len
- (outptr
- outbuf
);
990 if (remaining
<= 0) {
991 param
->flags
|= DM_BUFFER_FULL_FLAG
;
995 /* Get the status/table string from the target driver */
996 if (ti
->type
->status
) {
997 if (ti
->type
->status(ti
, type
, outptr
, remaining
)) {
998 param
->flags
|= DM_BUFFER_FULL_FLAG
;
1004 outptr
+= strlen(outptr
) + 1;
1005 used
= param
->data_start
+ (outptr
- outbuf
);
1007 outptr
= align_ptr(outptr
);
1008 spec
->next
= outptr
- outbuf
;
1012 param
->data_size
= used
;
1014 param
->target_count
= num_targets
;
1018 * Wait for a device to report an event
1020 static int dev_wait(struct dm_ioctl
*param
, size_t param_size
)
1023 struct mapped_device
*md
;
1024 struct dm_table
*table
;
1026 md
= find_device(param
);
1031 * Wait for a notification event
1033 if (dm_wait_event(md
, param
->event_nr
)) {
1039 * The userland program is going to want to know what
1040 * changed to trigger the event, so we may as well tell
1041 * him and save an ioctl.
1043 r
= __dev_status(md
, param
);
1047 table
= dm_get_live_or_inactive_table(md
, param
);
1049 retrieve_status(table
, param
, param_size
);
1050 dm_table_put(table
);
1058 static inline fmode_t
get_mode(struct dm_ioctl
*param
)
1060 fmode_t mode
= FMODE_READ
| FMODE_WRITE
;
1062 if (param
->flags
& DM_READONLY_FLAG
)
1068 static int next_target(struct dm_target_spec
*last
, uint32_t next
, void *end
,
1069 struct dm_target_spec
**spec
, char **target_params
)
1071 *spec
= (struct dm_target_spec
*) ((unsigned char *) last
+ next
);
1072 *target_params
= (char *) (*spec
+ 1);
1074 if (*spec
< (last
+ 1))
1077 return invalid_str(*target_params
, end
);
1080 static int populate_table(struct dm_table
*table
,
1081 struct dm_ioctl
*param
, size_t param_size
)
1085 struct dm_target_spec
*spec
= (struct dm_target_spec
*) param
;
1086 uint32_t next
= param
->data_start
;
1087 void *end
= (void *) param
+ param_size
;
1088 char *target_params
;
1090 if (!param
->target_count
) {
1091 DMWARN("populate_table: no targets specified");
1095 for (i
= 0; i
< param
->target_count
; i
++) {
1097 r
= next_target(spec
, next
, end
, &spec
, &target_params
);
1099 DMWARN("unable to find target");
1103 r
= dm_table_add_target(table
, spec
->target_type
,
1104 (sector_t
) spec
->sector_start
,
1105 (sector_t
) spec
->length
,
1108 DMWARN("error adding target to table");
1115 r
= dm_table_set_type(table
);
1117 DMWARN("unable to set table type");
1121 return dm_table_complete(table
);
1124 static int table_prealloc_integrity(struct dm_table
*t
,
1125 struct mapped_device
*md
)
1127 struct list_head
*devices
= dm_table_get_devices(t
);
1128 struct dm_dev_internal
*dd
;
1130 list_for_each_entry(dd
, devices
, list
)
1131 if (bdev_get_integrity(dd
->dm_dev
.bdev
))
1132 return blk_integrity_register(dm_disk(md
), NULL
);
1137 static int table_load(struct dm_ioctl
*param
, size_t param_size
)
1140 struct hash_cell
*hc
;
1142 struct mapped_device
*md
;
1144 md
= find_device(param
);
1148 r
= dm_table_create(&t
, get_mode(param
), param
->target_count
, md
);
1152 r
= populate_table(t
, param
, param_size
);
1154 dm_table_destroy(t
);
1158 r
= table_prealloc_integrity(t
, md
);
1160 DMERR("%s: could not register integrity profile.",
1161 dm_device_name(md
));
1162 dm_table_destroy(t
);
1166 r
= dm_table_alloc_md_mempools(t
);
1168 DMWARN("unable to allocate mempools for this table");
1169 dm_table_destroy(t
);
1173 down_write(&_hash_lock
);
1174 hc
= dm_get_mdptr(md
);
1175 if (!hc
|| hc
->md
!= md
) {
1176 DMWARN("device has been removed from the dev hash table.");
1177 dm_table_destroy(t
);
1178 up_write(&_hash_lock
);
1184 dm_table_destroy(hc
->new_map
);
1186 up_write(&_hash_lock
);
1188 param
->flags
|= DM_INACTIVE_PRESENT_FLAG
;
1189 r
= __dev_status(md
, param
);
1197 static int table_clear(struct dm_ioctl
*param
, size_t param_size
)
1200 struct hash_cell
*hc
;
1201 struct mapped_device
*md
;
1203 down_write(&_hash_lock
);
1205 hc
= __find_device_hash_cell(param
);
1207 DMWARN("device doesn't appear to be in the dev hash table.");
1208 up_write(&_hash_lock
);
1213 dm_table_destroy(hc
->new_map
);
1217 param
->flags
&= ~DM_INACTIVE_PRESENT_FLAG
;
1219 r
= __dev_status(hc
->md
, param
);
1221 up_write(&_hash_lock
);
1227 * Retrieves a list of devices used by a particular dm device.
1229 static void retrieve_deps(struct dm_table
*table
,
1230 struct dm_ioctl
*param
, size_t param_size
)
1232 unsigned int count
= 0;
1233 struct list_head
*tmp
;
1235 struct dm_dev_internal
*dd
;
1236 struct dm_target_deps
*deps
;
1238 deps
= get_result_buffer(param
, param_size
, &len
);
1241 * Count the devices.
1243 list_for_each (tmp
, dm_table_get_devices(table
))
1247 * Check we have enough space.
1249 needed
= sizeof(*deps
) + (sizeof(*deps
->dev
) * count
);
1251 param
->flags
|= DM_BUFFER_FULL_FLAG
;
1256 * Fill in the devices.
1258 deps
->count
= count
;
1260 list_for_each_entry (dd
, dm_table_get_devices(table
), list
)
1261 deps
->dev
[count
++] = huge_encode_dev(dd
->dm_dev
.bdev
->bd_dev
);
1263 param
->data_size
= param
->data_start
+ needed
;
1266 static int table_deps(struct dm_ioctl
*param
, size_t param_size
)
1269 struct mapped_device
*md
;
1270 struct dm_table
*table
;
1272 md
= find_device(param
);
1276 r
= __dev_status(md
, param
);
1280 table
= dm_get_live_or_inactive_table(md
, param
);
1282 retrieve_deps(table
, param
, param_size
);
1283 dm_table_put(table
);
1292 * Return the status of a device as a text string for each
1295 static int table_status(struct dm_ioctl
*param
, size_t param_size
)
1298 struct mapped_device
*md
;
1299 struct dm_table
*table
;
1301 md
= find_device(param
);
1305 r
= __dev_status(md
, param
);
1309 table
= dm_get_live_or_inactive_table(md
, param
);
1311 retrieve_status(table
, param
, param_size
);
1312 dm_table_put(table
);
1321 * Pass a message to the target that's at the supplied device offset.
1323 static int target_message(struct dm_ioctl
*param
, size_t param_size
)
1327 struct mapped_device
*md
;
1328 struct dm_table
*table
;
1329 struct dm_target
*ti
;
1330 struct dm_target_msg
*tmsg
= (void *) param
+ param
->data_start
;
1332 md
= find_device(param
);
1336 r
= __dev_status(md
, param
);
1340 if (tmsg
< (struct dm_target_msg
*) param
->data
||
1341 invalid_str(tmsg
->message
, (void *) param
+ param_size
)) {
1342 DMWARN("Invalid target message parameters.");
1347 r
= dm_split_args(&argc
, &argv
, tmsg
->message
);
1349 DMWARN("Failed to split target message parameters");
1353 table
= dm_get_live_table(md
);
1357 if (dm_deleting_md(md
)) {
1362 ti
= dm_table_find_target(table
, tmsg
->sector
);
1363 if (!dm_target_is_valid(ti
)) {
1364 DMWARN("Target message sector outside device.");
1366 } else if (ti
->type
->message
)
1367 r
= ti
->type
->message(ti
, argc
, argv
);
1369 DMWARN("Target type does not support messages");
1374 dm_table_put(table
);
1378 param
->data_size
= 0;
1383 /*-----------------------------------------------------------------
1384 * Implementation of open/close/ioctl on the special char
1386 *---------------------------------------------------------------*/
1387 static ioctl_fn
lookup_ioctl(unsigned int cmd
)
1393 {DM_VERSION_CMD
, NULL
}, /* version is dealt with elsewhere */
1394 {DM_REMOVE_ALL_CMD
, remove_all
},
1395 {DM_LIST_DEVICES_CMD
, list_devices
},
1397 {DM_DEV_CREATE_CMD
, dev_create
},
1398 {DM_DEV_REMOVE_CMD
, dev_remove
},
1399 {DM_DEV_RENAME_CMD
, dev_rename
},
1400 {DM_DEV_SUSPEND_CMD
, dev_suspend
},
1401 {DM_DEV_STATUS_CMD
, dev_status
},
1402 {DM_DEV_WAIT_CMD
, dev_wait
},
1404 {DM_TABLE_LOAD_CMD
, table_load
},
1405 {DM_TABLE_CLEAR_CMD
, table_clear
},
1406 {DM_TABLE_DEPS_CMD
, table_deps
},
1407 {DM_TABLE_STATUS_CMD
, table_status
},
1409 {DM_LIST_VERSIONS_CMD
, list_versions
},
1411 {DM_TARGET_MSG_CMD
, target_message
},
1412 {DM_DEV_SET_GEOMETRY_CMD
, dev_set_geometry
}
1415 return (cmd
>= ARRAY_SIZE(_ioctls
)) ? NULL
: _ioctls
[cmd
].fn
;
1419 * As well as checking the version compatibility this always
1420 * copies the kernel interface version out.
1422 static int check_version(unsigned int cmd
, struct dm_ioctl __user
*user
)
1424 uint32_t version
[3];
1427 if (copy_from_user(version
, user
->version
, sizeof(version
)))
1430 if ((DM_VERSION_MAJOR
!= version
[0]) ||
1431 (DM_VERSION_MINOR
< version
[1])) {
1432 DMWARN("ioctl interface mismatch: "
1433 "kernel(%u.%u.%u), user(%u.%u.%u), cmd(%d)",
1434 DM_VERSION_MAJOR
, DM_VERSION_MINOR
,
1435 DM_VERSION_PATCHLEVEL
,
1436 version
[0], version
[1], version
[2], cmd
);
1441 * Fill in the kernel version.
1443 version
[0] = DM_VERSION_MAJOR
;
1444 version
[1] = DM_VERSION_MINOR
;
1445 version
[2] = DM_VERSION_PATCHLEVEL
;
1446 if (copy_to_user(user
->version
, version
, sizeof(version
)))
1452 static void free_params(struct dm_ioctl
*param
)
1457 static int copy_params(struct dm_ioctl __user
*user
, struct dm_ioctl
**param
)
1459 struct dm_ioctl tmp
, *dmi
;
1461 if (copy_from_user(&tmp
, user
, sizeof(tmp
) - sizeof(tmp
.data
)))
1464 if (tmp
.data_size
< (sizeof(tmp
) - sizeof(tmp
.data
)))
1467 dmi
= vmalloc(tmp
.data_size
);
1471 if (copy_from_user(dmi
, user
, tmp
.data_size
)) {
1480 static int validate_params(uint cmd
, struct dm_ioctl
*param
)
1482 /* Always clear this flag */
1483 param
->flags
&= ~DM_BUFFER_FULL_FLAG
;
1484 param
->flags
&= ~DM_UEVENT_GENERATED_FLAG
;
1486 /* Ignores parameters */
1487 if (cmd
== DM_REMOVE_ALL_CMD
||
1488 cmd
== DM_LIST_DEVICES_CMD
||
1489 cmd
== DM_LIST_VERSIONS_CMD
)
1492 if ((cmd
== DM_DEV_CREATE_CMD
)) {
1493 if (!*param
->name
) {
1494 DMWARN("name not supplied when creating device");
1497 } else if ((*param
->uuid
&& *param
->name
)) {
1498 DMWARN("only supply one of name or uuid, cmd(%u)", cmd
);
1502 /* Ensure strings are terminated */
1503 param
->name
[DM_NAME_LEN
- 1] = '\0';
1504 param
->uuid
[DM_UUID_LEN
- 1] = '\0';
1509 static int ctl_ioctl(uint command
, struct dm_ioctl __user
*user
)
1513 struct dm_ioctl
*uninitialized_var(param
);
1517 /* only root can play with this */
1518 if (!capable(CAP_SYS_ADMIN
))
1521 if (_IOC_TYPE(command
) != DM_IOCTL
)
1524 cmd
= _IOC_NR(command
);
1527 * Check the interface version passed in. This also
1528 * writes out the kernel's interface version.
1530 r
= check_version(cmd
, user
);
1535 * Nothing more to do for the version command.
1537 if (cmd
== DM_VERSION_CMD
)
1540 fn
= lookup_ioctl(cmd
);
1542 DMWARN("dm_ctl_ioctl: unknown command 0x%x", command
);
1547 * Trying to avoid low memory issues when a device is
1550 current
->flags
|= PF_MEMALLOC
;
1553 * Copy the parameters into kernel space.
1555 r
= copy_params(user
, ¶m
);
1557 current
->flags
&= ~PF_MEMALLOC
;
1562 r
= validate_params(cmd
, param
);
1566 param_size
= param
->data_size
;
1567 param
->data_size
= sizeof(*param
);
1568 r
= fn(param
, param_size
);
1571 * Copy the results back to userland.
1573 if (!r
&& copy_to_user(user
, param
, param
->data_size
))
1581 static long dm_ctl_ioctl(struct file
*file
, uint command
, ulong u
)
1583 return (long)ctl_ioctl(command
, (struct dm_ioctl __user
*)u
);
1586 #ifdef CONFIG_COMPAT
1587 static long dm_compat_ctl_ioctl(struct file
*file
, uint command
, ulong u
)
1589 return (long)dm_ctl_ioctl(file
, command
, (ulong
) compat_ptr(u
));
1592 #define dm_compat_ctl_ioctl NULL
1595 static const struct file_operations _ctl_fops
= {
1596 .unlocked_ioctl
= dm_ctl_ioctl
,
1597 .compat_ioctl
= dm_compat_ctl_ioctl
,
1598 .owner
= THIS_MODULE
,
1601 static struct miscdevice _dm_misc
= {
1602 .minor
= MISC_DYNAMIC_MINOR
,
1604 .nodename
= "mapper/control",
1609 * Create misc character device and link to DM_DIR/control.
1611 int __init
dm_interface_init(void)
1619 r
= misc_register(&_dm_misc
);
1621 DMERR("misc_register failed for control device");
1626 DMINFO("%d.%d.%d%s initialised: %s", DM_VERSION_MAJOR
,
1627 DM_VERSION_MINOR
, DM_VERSION_PATCHLEVEL
, DM_VERSION_EXTRA
,
1632 void dm_interface_exit(void)
1634 if (misc_deregister(&_dm_misc
) < 0)
1635 DMERR("misc_deregister failed for control device");
1641 * dm_copy_name_and_uuid - Copy mapped device name & uuid into supplied buffers
1642 * @md: Pointer to mapped_device
1643 * @name: Buffer (size DM_NAME_LEN) for name
1644 * @uuid: Buffer (size DM_UUID_LEN) for uuid or empty string if uuid not defined
1646 int dm_copy_name_and_uuid(struct mapped_device
*md
, char *name
, char *uuid
)
1649 struct hash_cell
*hc
;
1654 mutex_lock(&dm_hash_cells_mutex
);
1655 hc
= dm_get_mdptr(md
);
1656 if (!hc
|| hc
->md
!= md
) {
1662 strcpy(name
, hc
->name
);
1664 strcpy(uuid
, hc
->uuid
? : "");
1667 mutex_unlock(&dm_hash_cells_mutex
);