treewide: remove redundant IS_ERR() before error code check
[linux/fpc-iii.git] / drivers / md / dm-ioctl.c
blobac83f5002ce5fe3a0483ea5630e389a9f29576ae
1 /*
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.
6 */
8 #include "dm-core.h"
10 #include <linux/module.h>
11 #include <linux/vmalloc.h>
12 #include <linux/miscdevice.h>
13 #include <linux/sched/mm.h>
14 #include <linux/init.h>
15 #include <linux/wait.h>
16 #include <linux/slab.h>
17 #include <linux/dm-ioctl.h>
18 #include <linux/hdreg.h>
19 #include <linux/compat.h>
21 #include <linux/uaccess.h>
23 #define DM_MSG_PREFIX "ioctl"
24 #define DM_DRIVER_EMAIL "dm-devel@redhat.com"
26 struct dm_file {
28 * poll will wait until the global event number is greater than
29 * this value.
31 volatile unsigned global_event_nr;
34 /*-----------------------------------------------------------------
35 * The ioctl interface needs to be able to look up devices by
36 * name or uuid.
37 *---------------------------------------------------------------*/
38 struct hash_cell {
39 struct list_head name_list;
40 struct list_head uuid_list;
42 char *name;
43 char *uuid;
44 struct mapped_device *md;
45 struct dm_table *new_map;
48 struct vers_iter {
49 size_t param_size;
50 struct dm_target_versions *vers, *old_vers;
51 char *end;
52 uint32_t flags;
56 #define NUM_BUCKETS 64
57 #define MASK_BUCKETS (NUM_BUCKETS - 1)
58 static struct list_head _name_buckets[NUM_BUCKETS];
59 static struct list_head _uuid_buckets[NUM_BUCKETS];
61 static void dm_hash_remove_all(bool keep_open_devices, bool mark_deferred, bool only_deferred);
64 * Guards access to both hash tables.
66 static DECLARE_RWSEM(_hash_lock);
69 * Protects use of mdptr to obtain hash cell name and uuid from mapped device.
71 static DEFINE_MUTEX(dm_hash_cells_mutex);
73 static void init_buckets(struct list_head *buckets)
75 unsigned int i;
77 for (i = 0; i < NUM_BUCKETS; i++)
78 INIT_LIST_HEAD(buckets + i);
81 static int dm_hash_init(void)
83 init_buckets(_name_buckets);
84 init_buckets(_uuid_buckets);
85 return 0;
88 static void dm_hash_exit(void)
90 dm_hash_remove_all(false, false, false);
93 /*-----------------------------------------------------------------
94 * Hash function:
95 * We're not really concerned with the str hash function being
96 * fast since it's only used by the ioctl interface.
97 *---------------------------------------------------------------*/
98 static unsigned int hash_str(const char *str)
100 const unsigned int hash_mult = 2654435387U;
101 unsigned int h = 0;
103 while (*str)
104 h = (h + (unsigned int) *str++) * hash_mult;
106 return h & MASK_BUCKETS;
109 /*-----------------------------------------------------------------
110 * Code for looking up a device by name
111 *---------------------------------------------------------------*/
112 static struct hash_cell *__get_name_cell(const char *str)
114 struct hash_cell *hc;
115 unsigned int h = hash_str(str);
117 list_for_each_entry (hc, _name_buckets + h, name_list)
118 if (!strcmp(hc->name, str)) {
119 dm_get(hc->md);
120 return hc;
123 return NULL;
126 static struct hash_cell *__get_uuid_cell(const char *str)
128 struct hash_cell *hc;
129 unsigned int h = hash_str(str);
131 list_for_each_entry (hc, _uuid_buckets + h, uuid_list)
132 if (!strcmp(hc->uuid, str)) {
133 dm_get(hc->md);
134 return hc;
137 return NULL;
140 static struct hash_cell *__get_dev_cell(uint64_t dev)
142 struct mapped_device *md;
143 struct hash_cell *hc;
145 md = dm_get_md(huge_decode_dev(dev));
146 if (!md)
147 return NULL;
149 hc = dm_get_mdptr(md);
150 if (!hc) {
151 dm_put(md);
152 return NULL;
155 return hc;
158 /*-----------------------------------------------------------------
159 * Inserting, removing and renaming a device.
160 *---------------------------------------------------------------*/
161 static struct hash_cell *alloc_cell(const char *name, const char *uuid,
162 struct mapped_device *md)
164 struct hash_cell *hc;
166 hc = kmalloc(sizeof(*hc), GFP_KERNEL);
167 if (!hc)
168 return NULL;
170 hc->name = kstrdup(name, GFP_KERNEL);
171 if (!hc->name) {
172 kfree(hc);
173 return NULL;
176 if (!uuid)
177 hc->uuid = NULL;
179 else {
180 hc->uuid = kstrdup(uuid, GFP_KERNEL);
181 if (!hc->uuid) {
182 kfree(hc->name);
183 kfree(hc);
184 return NULL;
188 INIT_LIST_HEAD(&hc->name_list);
189 INIT_LIST_HEAD(&hc->uuid_list);
190 hc->md = md;
191 hc->new_map = NULL;
192 return hc;
195 static void free_cell(struct hash_cell *hc)
197 if (hc) {
198 kfree(hc->name);
199 kfree(hc->uuid);
200 kfree(hc);
205 * The kdev_t and uuid of a device can never change once it is
206 * initially inserted.
208 static int dm_hash_insert(const char *name, const char *uuid, struct mapped_device *md)
210 struct hash_cell *cell, *hc;
213 * Allocate the new cells.
215 cell = alloc_cell(name, uuid, md);
216 if (!cell)
217 return -ENOMEM;
220 * Insert the cell into both hash tables.
222 down_write(&_hash_lock);
223 hc = __get_name_cell(name);
224 if (hc) {
225 dm_put(hc->md);
226 goto bad;
229 list_add(&cell->name_list, _name_buckets + hash_str(name));
231 if (uuid) {
232 hc = __get_uuid_cell(uuid);
233 if (hc) {
234 list_del(&cell->name_list);
235 dm_put(hc->md);
236 goto bad;
238 list_add(&cell->uuid_list, _uuid_buckets + hash_str(uuid));
240 dm_get(md);
241 mutex_lock(&dm_hash_cells_mutex);
242 dm_set_mdptr(md, cell);
243 mutex_unlock(&dm_hash_cells_mutex);
244 up_write(&_hash_lock);
246 return 0;
248 bad:
249 up_write(&_hash_lock);
250 free_cell(cell);
251 return -EBUSY;
254 static struct dm_table *__hash_remove(struct hash_cell *hc)
256 struct dm_table *table;
257 int srcu_idx;
259 /* remove from the dev hash */
260 list_del(&hc->uuid_list);
261 list_del(&hc->name_list);
262 mutex_lock(&dm_hash_cells_mutex);
263 dm_set_mdptr(hc->md, NULL);
264 mutex_unlock(&dm_hash_cells_mutex);
266 table = dm_get_live_table(hc->md, &srcu_idx);
267 if (table)
268 dm_table_event(table);
269 dm_put_live_table(hc->md, srcu_idx);
271 table = NULL;
272 if (hc->new_map)
273 table = hc->new_map;
274 dm_put(hc->md);
275 free_cell(hc);
277 return table;
280 static void dm_hash_remove_all(bool keep_open_devices, bool mark_deferred, bool only_deferred)
282 int i, dev_skipped;
283 struct hash_cell *hc;
284 struct mapped_device *md;
285 struct dm_table *t;
287 retry:
288 dev_skipped = 0;
290 down_write(&_hash_lock);
292 for (i = 0; i < NUM_BUCKETS; i++) {
293 list_for_each_entry(hc, _name_buckets + i, name_list) {
294 md = hc->md;
295 dm_get(md);
297 if (keep_open_devices &&
298 dm_lock_for_deletion(md, mark_deferred, only_deferred)) {
299 dm_put(md);
300 dev_skipped++;
301 continue;
304 t = __hash_remove(hc);
306 up_write(&_hash_lock);
308 if (t) {
309 dm_sync_table(md);
310 dm_table_destroy(t);
312 dm_put(md);
313 if (likely(keep_open_devices))
314 dm_destroy(md);
315 else
316 dm_destroy_immediate(md);
319 * Some mapped devices may be using other mapped
320 * devices, so repeat until we make no further
321 * progress. If a new mapped device is created
322 * here it will also get removed.
324 goto retry;
328 up_write(&_hash_lock);
330 if (dev_skipped)
331 DMWARN("remove_all left %d open device(s)", dev_skipped);
335 * Set the uuid of a hash_cell that isn't already set.
337 static void __set_cell_uuid(struct hash_cell *hc, char *new_uuid)
339 mutex_lock(&dm_hash_cells_mutex);
340 hc->uuid = new_uuid;
341 mutex_unlock(&dm_hash_cells_mutex);
343 list_add(&hc->uuid_list, _uuid_buckets + hash_str(new_uuid));
347 * Changes the name of a hash_cell and returns the old name for
348 * the caller to free.
350 static char *__change_cell_name(struct hash_cell *hc, char *new_name)
352 char *old_name;
355 * Rename and move the name cell.
357 list_del(&hc->name_list);
358 old_name = hc->name;
360 mutex_lock(&dm_hash_cells_mutex);
361 hc->name = new_name;
362 mutex_unlock(&dm_hash_cells_mutex);
364 list_add(&hc->name_list, _name_buckets + hash_str(new_name));
366 return old_name;
369 static struct mapped_device *dm_hash_rename(struct dm_ioctl *param,
370 const char *new)
372 char *new_data, *old_name = NULL;
373 struct hash_cell *hc;
374 struct dm_table *table;
375 struct mapped_device *md;
376 unsigned change_uuid = (param->flags & DM_UUID_FLAG) ? 1 : 0;
377 int srcu_idx;
380 * duplicate new.
382 new_data = kstrdup(new, GFP_KERNEL);
383 if (!new_data)
384 return ERR_PTR(-ENOMEM);
386 down_write(&_hash_lock);
389 * Is new free ?
391 if (change_uuid)
392 hc = __get_uuid_cell(new);
393 else
394 hc = __get_name_cell(new);
396 if (hc) {
397 DMWARN("Unable to change %s on mapped device %s to one that "
398 "already exists: %s",
399 change_uuid ? "uuid" : "name",
400 param->name, new);
401 dm_put(hc->md);
402 up_write(&_hash_lock);
403 kfree(new_data);
404 return ERR_PTR(-EBUSY);
408 * Is there such a device as 'old' ?
410 hc = __get_name_cell(param->name);
411 if (!hc) {
412 DMWARN("Unable to rename non-existent device, %s to %s%s",
413 param->name, change_uuid ? "uuid " : "", new);
414 up_write(&_hash_lock);
415 kfree(new_data);
416 return ERR_PTR(-ENXIO);
420 * Does this device already have a uuid?
422 if (change_uuid && hc->uuid) {
423 DMWARN("Unable to change uuid of mapped device %s to %s "
424 "because uuid is already set to %s",
425 param->name, new, hc->uuid);
426 dm_put(hc->md);
427 up_write(&_hash_lock);
428 kfree(new_data);
429 return ERR_PTR(-EINVAL);
432 if (change_uuid)
433 __set_cell_uuid(hc, new_data);
434 else
435 old_name = __change_cell_name(hc, new_data);
438 * Wake up any dm event waiters.
440 table = dm_get_live_table(hc->md, &srcu_idx);
441 if (table)
442 dm_table_event(table);
443 dm_put_live_table(hc->md, srcu_idx);
445 if (!dm_kobject_uevent(hc->md, KOBJ_CHANGE, param->event_nr))
446 param->flags |= DM_UEVENT_GENERATED_FLAG;
448 md = hc->md;
449 up_write(&_hash_lock);
450 kfree(old_name);
452 return md;
455 void dm_deferred_remove(void)
457 dm_hash_remove_all(true, false, true);
460 /*-----------------------------------------------------------------
461 * Implementation of the ioctl commands
462 *---------------------------------------------------------------*/
464 * All the ioctl commands get dispatched to functions with this
465 * prototype.
467 typedef int (*ioctl_fn)(struct file *filp, struct dm_ioctl *param, size_t param_size);
469 static int remove_all(struct file *filp, struct dm_ioctl *param, size_t param_size)
471 dm_hash_remove_all(true, !!(param->flags & DM_DEFERRED_REMOVE), false);
472 param->data_size = 0;
473 return 0;
477 * Round up the ptr to an 8-byte boundary.
479 #define ALIGN_MASK 7
480 static inline size_t align_val(size_t val)
482 return (val + ALIGN_MASK) & ~ALIGN_MASK;
484 static inline void *align_ptr(void *ptr)
486 return (void *)align_val((size_t)ptr);
490 * Retrieves the data payload buffer from an already allocated
491 * struct dm_ioctl.
493 static void *get_result_buffer(struct dm_ioctl *param, size_t param_size,
494 size_t *len)
496 param->data_start = align_ptr(param + 1) - (void *) param;
498 if (param->data_start < param_size)
499 *len = param_size - param->data_start;
500 else
501 *len = 0;
503 return ((void *) param) + param->data_start;
506 static int list_devices(struct file *filp, struct dm_ioctl *param, size_t param_size)
508 unsigned int i;
509 struct hash_cell *hc;
510 size_t len, needed = 0;
511 struct gendisk *disk;
512 struct dm_name_list *orig_nl, *nl, *old_nl = NULL;
513 uint32_t *event_nr;
515 down_write(&_hash_lock);
518 * Loop through all the devices working out how much
519 * space we need.
521 for (i = 0; i < NUM_BUCKETS; i++) {
522 list_for_each_entry (hc, _name_buckets + i, name_list) {
523 needed += align_val(offsetof(struct dm_name_list, name) + strlen(hc->name) + 1);
524 needed += align_val(sizeof(uint32_t));
529 * Grab our output buffer.
531 nl = orig_nl = get_result_buffer(param, param_size, &len);
532 if (len < needed) {
533 param->flags |= DM_BUFFER_FULL_FLAG;
534 goto out;
536 param->data_size = param->data_start + needed;
538 nl->dev = 0; /* Flags no data */
541 * Now loop through filling out the names.
543 for (i = 0; i < NUM_BUCKETS; i++) {
544 list_for_each_entry (hc, _name_buckets + i, name_list) {
545 if (old_nl)
546 old_nl->next = (uint32_t) ((void *) nl -
547 (void *) old_nl);
548 disk = dm_disk(hc->md);
549 nl->dev = huge_encode_dev(disk_devt(disk));
550 nl->next = 0;
551 strcpy(nl->name, hc->name);
553 old_nl = nl;
554 event_nr = align_ptr(nl->name + strlen(hc->name) + 1);
555 *event_nr = dm_get_event_nr(hc->md);
556 nl = align_ptr(event_nr + 1);
560 * If mismatch happens, security may be compromised due to buffer
561 * overflow, so it's better to crash.
563 BUG_ON((char *)nl - (char *)orig_nl != needed);
565 out:
566 up_write(&_hash_lock);
567 return 0;
570 static void list_version_get_needed(struct target_type *tt, void *needed_param)
572 size_t *needed = needed_param;
574 *needed += sizeof(struct dm_target_versions);
575 *needed += strlen(tt->name);
576 *needed += ALIGN_MASK;
579 static void list_version_get_info(struct target_type *tt, void *param)
581 struct vers_iter *info = param;
583 /* Check space - it might have changed since the first iteration */
584 if ((char *)info->vers + sizeof(tt->version) + strlen(tt->name) + 1 >
585 info->end) {
587 info->flags = DM_BUFFER_FULL_FLAG;
588 return;
591 if (info->old_vers)
592 info->old_vers->next = (uint32_t) ((void *)info->vers -
593 (void *)info->old_vers);
594 info->vers->version[0] = tt->version[0];
595 info->vers->version[1] = tt->version[1];
596 info->vers->version[2] = tt->version[2];
597 info->vers->next = 0;
598 strcpy(info->vers->name, tt->name);
600 info->old_vers = info->vers;
601 info->vers = align_ptr(((void *) ++info->vers) + strlen(tt->name) + 1);
604 static int __list_versions(struct dm_ioctl *param, size_t param_size, const char *name)
606 size_t len, needed = 0;
607 struct dm_target_versions *vers;
608 struct vers_iter iter_info;
609 struct target_type *tt = NULL;
611 if (name) {
612 tt = dm_get_target_type(name);
613 if (!tt)
614 return -EINVAL;
618 * Loop through all the devices working out how much
619 * space we need.
621 if (!tt)
622 dm_target_iterate(list_version_get_needed, &needed);
623 else
624 list_version_get_needed(tt, &needed);
627 * Grab our output buffer.
629 vers = get_result_buffer(param, param_size, &len);
630 if (len < needed) {
631 param->flags |= DM_BUFFER_FULL_FLAG;
632 goto out;
634 param->data_size = param->data_start + needed;
636 iter_info.param_size = param_size;
637 iter_info.old_vers = NULL;
638 iter_info.vers = vers;
639 iter_info.flags = 0;
640 iter_info.end = (char *)vers+len;
643 * Now loop through filling out the names & versions.
645 if (!tt)
646 dm_target_iterate(list_version_get_info, &iter_info);
647 else
648 list_version_get_info(tt, &iter_info);
649 param->flags |= iter_info.flags;
651 out:
652 if (tt)
653 dm_put_target_type(tt);
654 return 0;
657 static int list_versions(struct file *filp, struct dm_ioctl *param, size_t param_size)
659 return __list_versions(param, param_size, NULL);
662 static int get_target_version(struct file *filp, struct dm_ioctl *param, size_t param_size)
664 return __list_versions(param, param_size, param->name);
667 static int check_name(const char *name)
669 if (strchr(name, '/')) {
670 DMWARN("invalid device name");
671 return -EINVAL;
674 return 0;
678 * On successful return, the caller must not attempt to acquire
679 * _hash_lock without first calling dm_put_live_table, because dm_table_destroy
680 * waits for this dm_put_live_table and could be called under this lock.
682 static struct dm_table *dm_get_inactive_table(struct mapped_device *md, int *srcu_idx)
684 struct hash_cell *hc;
685 struct dm_table *table = NULL;
687 /* increment rcu count, we don't care about the table pointer */
688 dm_get_live_table(md, srcu_idx);
690 down_read(&_hash_lock);
691 hc = dm_get_mdptr(md);
692 if (!hc || hc->md != md) {
693 DMWARN("device has been removed from the dev hash table.");
694 goto out;
697 table = hc->new_map;
699 out:
700 up_read(&_hash_lock);
702 return table;
705 static struct dm_table *dm_get_live_or_inactive_table(struct mapped_device *md,
706 struct dm_ioctl *param,
707 int *srcu_idx)
709 return (param->flags & DM_QUERY_INACTIVE_TABLE_FLAG) ?
710 dm_get_inactive_table(md, srcu_idx) : dm_get_live_table(md, srcu_idx);
714 * Fills in a dm_ioctl structure, ready for sending back to
715 * userland.
717 static void __dev_status(struct mapped_device *md, struct dm_ioctl *param)
719 struct gendisk *disk = dm_disk(md);
720 struct dm_table *table;
721 int srcu_idx;
723 param->flags &= ~(DM_SUSPEND_FLAG | DM_READONLY_FLAG |
724 DM_ACTIVE_PRESENT_FLAG | DM_INTERNAL_SUSPEND_FLAG);
726 if (dm_suspended_md(md))
727 param->flags |= DM_SUSPEND_FLAG;
729 if (dm_suspended_internally_md(md))
730 param->flags |= DM_INTERNAL_SUSPEND_FLAG;
732 if (dm_test_deferred_remove_flag(md))
733 param->flags |= DM_DEFERRED_REMOVE;
735 param->dev = huge_encode_dev(disk_devt(disk));
738 * Yes, this will be out of date by the time it gets back
739 * to userland, but it is still very useful for
740 * debugging.
742 param->open_count = dm_open_count(md);
744 param->event_nr = dm_get_event_nr(md);
745 param->target_count = 0;
747 table = dm_get_live_table(md, &srcu_idx);
748 if (table) {
749 if (!(param->flags & DM_QUERY_INACTIVE_TABLE_FLAG)) {
750 if (get_disk_ro(disk))
751 param->flags |= DM_READONLY_FLAG;
752 param->target_count = dm_table_get_num_targets(table);
755 param->flags |= DM_ACTIVE_PRESENT_FLAG;
757 dm_put_live_table(md, srcu_idx);
759 if (param->flags & DM_QUERY_INACTIVE_TABLE_FLAG) {
760 int srcu_idx;
761 table = dm_get_inactive_table(md, &srcu_idx);
762 if (table) {
763 if (!(dm_table_get_mode(table) & FMODE_WRITE))
764 param->flags |= DM_READONLY_FLAG;
765 param->target_count = dm_table_get_num_targets(table);
767 dm_put_live_table(md, srcu_idx);
771 static int dev_create(struct file *filp, struct dm_ioctl *param, size_t param_size)
773 int r, m = DM_ANY_MINOR;
774 struct mapped_device *md;
776 r = check_name(param->name);
777 if (r)
778 return r;
780 if (param->flags & DM_PERSISTENT_DEV_FLAG)
781 m = MINOR(huge_decode_dev(param->dev));
783 r = dm_create(m, &md);
784 if (r)
785 return r;
787 r = dm_hash_insert(param->name, *param->uuid ? param->uuid : NULL, md);
788 if (r) {
789 dm_put(md);
790 dm_destroy(md);
791 return r;
794 param->flags &= ~DM_INACTIVE_PRESENT_FLAG;
796 __dev_status(md, param);
798 dm_put(md);
800 return 0;
804 * Always use UUID for lookups if it's present, otherwise use name or dev.
806 static struct hash_cell *__find_device_hash_cell(struct dm_ioctl *param)
808 struct hash_cell *hc = NULL;
810 if (*param->uuid) {
811 if (*param->name || param->dev)
812 return NULL;
814 hc = __get_uuid_cell(param->uuid);
815 if (!hc)
816 return NULL;
817 } else if (*param->name) {
818 if (param->dev)
819 return NULL;
821 hc = __get_name_cell(param->name);
822 if (!hc)
823 return NULL;
824 } else if (param->dev) {
825 hc = __get_dev_cell(param->dev);
826 if (!hc)
827 return NULL;
828 } else
829 return NULL;
832 * Sneakily write in both the name and the uuid
833 * while we have the cell.
835 strlcpy(param->name, hc->name, sizeof(param->name));
836 if (hc->uuid)
837 strlcpy(param->uuid, hc->uuid, sizeof(param->uuid));
838 else
839 param->uuid[0] = '\0';
841 if (hc->new_map)
842 param->flags |= DM_INACTIVE_PRESENT_FLAG;
843 else
844 param->flags &= ~DM_INACTIVE_PRESENT_FLAG;
846 return hc;
849 static struct mapped_device *find_device(struct dm_ioctl *param)
851 struct hash_cell *hc;
852 struct mapped_device *md = NULL;
854 down_read(&_hash_lock);
855 hc = __find_device_hash_cell(param);
856 if (hc)
857 md = hc->md;
858 up_read(&_hash_lock);
860 return md;
863 static int dev_remove(struct file *filp, struct dm_ioctl *param, size_t param_size)
865 struct hash_cell *hc;
866 struct mapped_device *md;
867 int r;
868 struct dm_table *t;
870 down_write(&_hash_lock);
871 hc = __find_device_hash_cell(param);
873 if (!hc) {
874 DMDEBUG_LIMIT("device doesn't appear to be in the dev hash table.");
875 up_write(&_hash_lock);
876 return -ENXIO;
879 md = hc->md;
882 * Ensure the device is not open and nothing further can open it.
884 r = dm_lock_for_deletion(md, !!(param->flags & DM_DEFERRED_REMOVE), false);
885 if (r) {
886 if (r == -EBUSY && param->flags & DM_DEFERRED_REMOVE) {
887 up_write(&_hash_lock);
888 dm_put(md);
889 return 0;
891 DMDEBUG_LIMIT("unable to remove open device %s", hc->name);
892 up_write(&_hash_lock);
893 dm_put(md);
894 return r;
897 t = __hash_remove(hc);
898 up_write(&_hash_lock);
900 if (t) {
901 dm_sync_table(md);
902 dm_table_destroy(t);
905 param->flags &= ~DM_DEFERRED_REMOVE;
907 if (!dm_kobject_uevent(md, KOBJ_REMOVE, param->event_nr))
908 param->flags |= DM_UEVENT_GENERATED_FLAG;
910 dm_put(md);
911 dm_destroy(md);
912 return 0;
916 * Check a string doesn't overrun the chunk of
917 * memory we copied from userland.
919 static int invalid_str(char *str, void *end)
921 while ((void *) str < end)
922 if (!*str++)
923 return 0;
925 return -EINVAL;
928 static int dev_rename(struct file *filp, struct dm_ioctl *param, size_t param_size)
930 int r;
931 char *new_data = (char *) param + param->data_start;
932 struct mapped_device *md;
933 unsigned change_uuid = (param->flags & DM_UUID_FLAG) ? 1 : 0;
935 if (new_data < param->data ||
936 invalid_str(new_data, (void *) param + param_size) || !*new_data ||
937 strlen(new_data) > (change_uuid ? DM_UUID_LEN - 1 : DM_NAME_LEN - 1)) {
938 DMWARN("Invalid new mapped device name or uuid string supplied.");
939 return -EINVAL;
942 if (!change_uuid) {
943 r = check_name(new_data);
944 if (r)
945 return r;
948 md = dm_hash_rename(param, new_data);
949 if (IS_ERR(md))
950 return PTR_ERR(md);
952 __dev_status(md, param);
953 dm_put(md);
955 return 0;
958 static int dev_set_geometry(struct file *filp, struct dm_ioctl *param, size_t param_size)
960 int r = -EINVAL, x;
961 struct mapped_device *md;
962 struct hd_geometry geometry;
963 unsigned long indata[4];
964 char *geostr = (char *) param + param->data_start;
965 char dummy;
967 md = find_device(param);
968 if (!md)
969 return -ENXIO;
971 if (geostr < param->data ||
972 invalid_str(geostr, (void *) param + param_size)) {
973 DMWARN("Invalid geometry supplied.");
974 goto out;
977 x = sscanf(geostr, "%lu %lu %lu %lu%c", indata,
978 indata + 1, indata + 2, indata + 3, &dummy);
980 if (x != 4) {
981 DMWARN("Unable to interpret geometry settings.");
982 goto out;
985 if (indata[0] > 65535 || indata[1] > 255 ||
986 indata[2] > 255 || indata[3] > ULONG_MAX) {
987 DMWARN("Geometry exceeds range limits.");
988 goto out;
991 geometry.cylinders = indata[0];
992 geometry.heads = indata[1];
993 geometry.sectors = indata[2];
994 geometry.start = indata[3];
996 r = dm_set_geometry(md, &geometry);
998 param->data_size = 0;
1000 out:
1001 dm_put(md);
1002 return r;
1005 static int do_suspend(struct dm_ioctl *param)
1007 int r = 0;
1008 unsigned suspend_flags = DM_SUSPEND_LOCKFS_FLAG;
1009 struct mapped_device *md;
1011 md = find_device(param);
1012 if (!md)
1013 return -ENXIO;
1015 if (param->flags & DM_SKIP_LOCKFS_FLAG)
1016 suspend_flags &= ~DM_SUSPEND_LOCKFS_FLAG;
1017 if (param->flags & DM_NOFLUSH_FLAG)
1018 suspend_flags |= DM_SUSPEND_NOFLUSH_FLAG;
1020 if (!dm_suspended_md(md)) {
1021 r = dm_suspend(md, suspend_flags);
1022 if (r)
1023 goto out;
1026 __dev_status(md, param);
1028 out:
1029 dm_put(md);
1031 return r;
1034 static int do_resume(struct dm_ioctl *param)
1036 int r = 0;
1037 unsigned suspend_flags = DM_SUSPEND_LOCKFS_FLAG;
1038 struct hash_cell *hc;
1039 struct mapped_device *md;
1040 struct dm_table *new_map, *old_map = NULL;
1042 down_write(&_hash_lock);
1044 hc = __find_device_hash_cell(param);
1045 if (!hc) {
1046 DMDEBUG_LIMIT("device doesn't appear to be in the dev hash table.");
1047 up_write(&_hash_lock);
1048 return -ENXIO;
1051 md = hc->md;
1053 new_map = hc->new_map;
1054 hc->new_map = NULL;
1055 param->flags &= ~DM_INACTIVE_PRESENT_FLAG;
1057 up_write(&_hash_lock);
1059 /* Do we need to load a new map ? */
1060 if (new_map) {
1061 /* Suspend if it isn't already suspended */
1062 if (param->flags & DM_SKIP_LOCKFS_FLAG)
1063 suspend_flags &= ~DM_SUSPEND_LOCKFS_FLAG;
1064 if (param->flags & DM_NOFLUSH_FLAG)
1065 suspend_flags |= DM_SUSPEND_NOFLUSH_FLAG;
1066 if (!dm_suspended_md(md))
1067 dm_suspend(md, suspend_flags);
1069 old_map = dm_swap_table(md, new_map);
1070 if (IS_ERR(old_map)) {
1071 dm_sync_table(md);
1072 dm_table_destroy(new_map);
1073 dm_put(md);
1074 return PTR_ERR(old_map);
1077 if (dm_table_get_mode(new_map) & FMODE_WRITE)
1078 set_disk_ro(dm_disk(md), 0);
1079 else
1080 set_disk_ro(dm_disk(md), 1);
1083 if (dm_suspended_md(md)) {
1084 r = dm_resume(md);
1085 if (!r && !dm_kobject_uevent(md, KOBJ_CHANGE, param->event_nr))
1086 param->flags |= DM_UEVENT_GENERATED_FLAG;
1090 * Since dm_swap_table synchronizes RCU, nobody should be in
1091 * read-side critical section already.
1093 if (old_map)
1094 dm_table_destroy(old_map);
1096 if (!r)
1097 __dev_status(md, param);
1099 dm_put(md);
1100 return r;
1104 * Set or unset the suspension state of a device.
1105 * If the device already is in the requested state we just return its status.
1107 static int dev_suspend(struct file *filp, struct dm_ioctl *param, size_t param_size)
1109 if (param->flags & DM_SUSPEND_FLAG)
1110 return do_suspend(param);
1112 return do_resume(param);
1116 * Copies device info back to user space, used by
1117 * the create and info ioctls.
1119 static int dev_status(struct file *filp, struct dm_ioctl *param, size_t param_size)
1121 struct mapped_device *md;
1123 md = find_device(param);
1124 if (!md)
1125 return -ENXIO;
1127 __dev_status(md, param);
1128 dm_put(md);
1130 return 0;
1134 * Build up the status struct for each target
1136 static void retrieve_status(struct dm_table *table,
1137 struct dm_ioctl *param, size_t param_size)
1139 unsigned int i, num_targets;
1140 struct dm_target_spec *spec;
1141 char *outbuf, *outptr;
1142 status_type_t type;
1143 size_t remaining, len, used = 0;
1144 unsigned status_flags = 0;
1146 outptr = outbuf = get_result_buffer(param, param_size, &len);
1148 if (param->flags & DM_STATUS_TABLE_FLAG)
1149 type = STATUSTYPE_TABLE;
1150 else
1151 type = STATUSTYPE_INFO;
1153 /* Get all the target info */
1154 num_targets = dm_table_get_num_targets(table);
1155 for (i = 0; i < num_targets; i++) {
1156 struct dm_target *ti = dm_table_get_target(table, i);
1157 size_t l;
1159 remaining = len - (outptr - outbuf);
1160 if (remaining <= sizeof(struct dm_target_spec)) {
1161 param->flags |= DM_BUFFER_FULL_FLAG;
1162 break;
1165 spec = (struct dm_target_spec *) outptr;
1167 spec->status = 0;
1168 spec->sector_start = ti->begin;
1169 spec->length = ti->len;
1170 strncpy(spec->target_type, ti->type->name,
1171 sizeof(spec->target_type));
1173 outptr += sizeof(struct dm_target_spec);
1174 remaining = len - (outptr - outbuf);
1175 if (remaining <= 0) {
1176 param->flags |= DM_BUFFER_FULL_FLAG;
1177 break;
1180 /* Get the status/table string from the target driver */
1181 if (ti->type->status) {
1182 if (param->flags & DM_NOFLUSH_FLAG)
1183 status_flags |= DM_STATUS_NOFLUSH_FLAG;
1184 ti->type->status(ti, type, status_flags, outptr, remaining);
1185 } else
1186 outptr[0] = '\0';
1188 l = strlen(outptr) + 1;
1189 if (l == remaining) {
1190 param->flags |= DM_BUFFER_FULL_FLAG;
1191 break;
1194 outptr += l;
1195 used = param->data_start + (outptr - outbuf);
1197 outptr = align_ptr(outptr);
1198 spec->next = outptr - outbuf;
1201 if (used)
1202 param->data_size = used;
1204 param->target_count = num_targets;
1208 * Wait for a device to report an event
1210 static int dev_wait(struct file *filp, struct dm_ioctl *param, size_t param_size)
1212 int r = 0;
1213 struct mapped_device *md;
1214 struct dm_table *table;
1215 int srcu_idx;
1217 md = find_device(param);
1218 if (!md)
1219 return -ENXIO;
1222 * Wait for a notification event
1224 if (dm_wait_event(md, param->event_nr)) {
1225 r = -ERESTARTSYS;
1226 goto out;
1230 * The userland program is going to want to know what
1231 * changed to trigger the event, so we may as well tell
1232 * him and save an ioctl.
1234 __dev_status(md, param);
1236 table = dm_get_live_or_inactive_table(md, param, &srcu_idx);
1237 if (table)
1238 retrieve_status(table, param, param_size);
1239 dm_put_live_table(md, srcu_idx);
1241 out:
1242 dm_put(md);
1244 return r;
1248 * Remember the global event number and make it possible to poll
1249 * for further events.
1251 static int dev_arm_poll(struct file *filp, struct dm_ioctl *param, size_t param_size)
1253 struct dm_file *priv = filp->private_data;
1255 priv->global_event_nr = atomic_read(&dm_global_event_nr);
1257 return 0;
1260 static inline fmode_t get_mode(struct dm_ioctl *param)
1262 fmode_t mode = FMODE_READ | FMODE_WRITE;
1264 if (param->flags & DM_READONLY_FLAG)
1265 mode = FMODE_READ;
1267 return mode;
1270 static int next_target(struct dm_target_spec *last, uint32_t next, void *end,
1271 struct dm_target_spec **spec, char **target_params)
1273 *spec = (struct dm_target_spec *) ((unsigned char *) last + next);
1274 *target_params = (char *) (*spec + 1);
1276 if (*spec < (last + 1))
1277 return -EINVAL;
1279 return invalid_str(*target_params, end);
1282 static int populate_table(struct dm_table *table,
1283 struct dm_ioctl *param, size_t param_size)
1285 int r;
1286 unsigned int i = 0;
1287 struct dm_target_spec *spec = (struct dm_target_spec *) param;
1288 uint32_t next = param->data_start;
1289 void *end = (void *) param + param_size;
1290 char *target_params;
1292 if (!param->target_count) {
1293 DMWARN("populate_table: no targets specified");
1294 return -EINVAL;
1297 for (i = 0; i < param->target_count; i++) {
1299 r = next_target(spec, next, end, &spec, &target_params);
1300 if (r) {
1301 DMWARN("unable to find target");
1302 return r;
1305 r = dm_table_add_target(table, spec->target_type,
1306 (sector_t) spec->sector_start,
1307 (sector_t) spec->length,
1308 target_params);
1309 if (r) {
1310 DMWARN("error adding target to table");
1311 return r;
1314 next = spec->next;
1317 return dm_table_complete(table);
1320 static bool is_valid_type(enum dm_queue_mode cur, enum dm_queue_mode new)
1322 if (cur == new ||
1323 (cur == DM_TYPE_BIO_BASED && new == DM_TYPE_DAX_BIO_BASED))
1324 return true;
1326 return false;
1329 static int table_load(struct file *filp, struct dm_ioctl *param, size_t param_size)
1331 int r;
1332 struct hash_cell *hc;
1333 struct dm_table *t, *old_map = NULL;
1334 struct mapped_device *md;
1335 struct target_type *immutable_target_type;
1337 md = find_device(param);
1338 if (!md)
1339 return -ENXIO;
1341 r = dm_table_create(&t, get_mode(param), param->target_count, md);
1342 if (r)
1343 goto err;
1345 /* Protect md->type and md->queue against concurrent table loads. */
1346 dm_lock_md_type(md);
1347 r = populate_table(t, param, param_size);
1348 if (r)
1349 goto err_unlock_md_type;
1351 immutable_target_type = dm_get_immutable_target_type(md);
1352 if (immutable_target_type &&
1353 (immutable_target_type != dm_table_get_immutable_target_type(t)) &&
1354 !dm_table_get_wildcard_target(t)) {
1355 DMWARN("can't replace immutable target type %s",
1356 immutable_target_type->name);
1357 r = -EINVAL;
1358 goto err_unlock_md_type;
1361 if (dm_get_md_type(md) == DM_TYPE_NONE) {
1362 /* Initial table load: acquire type of table. */
1363 dm_set_md_type(md, dm_table_get_type(t));
1365 /* setup md->queue to reflect md's type (may block) */
1366 r = dm_setup_md_queue(md, t);
1367 if (r) {
1368 DMWARN("unable to set up device queue for new table.");
1369 goto err_unlock_md_type;
1371 } else if (!is_valid_type(dm_get_md_type(md), dm_table_get_type(t))) {
1372 DMWARN("can't change device type (old=%u vs new=%u) after initial table load.",
1373 dm_get_md_type(md), dm_table_get_type(t));
1374 r = -EINVAL;
1375 goto err_unlock_md_type;
1378 dm_unlock_md_type(md);
1380 /* stage inactive table */
1381 down_write(&_hash_lock);
1382 hc = dm_get_mdptr(md);
1383 if (!hc || hc->md != md) {
1384 DMWARN("device has been removed from the dev hash table.");
1385 up_write(&_hash_lock);
1386 r = -ENXIO;
1387 goto err_destroy_table;
1390 if (hc->new_map)
1391 old_map = hc->new_map;
1392 hc->new_map = t;
1393 up_write(&_hash_lock);
1395 param->flags |= DM_INACTIVE_PRESENT_FLAG;
1396 __dev_status(md, param);
1398 if (old_map) {
1399 dm_sync_table(md);
1400 dm_table_destroy(old_map);
1403 dm_put(md);
1405 return 0;
1407 err_unlock_md_type:
1408 dm_unlock_md_type(md);
1409 err_destroy_table:
1410 dm_table_destroy(t);
1411 err:
1412 dm_put(md);
1414 return r;
1417 static int table_clear(struct file *filp, struct dm_ioctl *param, size_t param_size)
1419 struct hash_cell *hc;
1420 struct mapped_device *md;
1421 struct dm_table *old_map = NULL;
1423 down_write(&_hash_lock);
1425 hc = __find_device_hash_cell(param);
1426 if (!hc) {
1427 DMDEBUG_LIMIT("device doesn't appear to be in the dev hash table.");
1428 up_write(&_hash_lock);
1429 return -ENXIO;
1432 if (hc->new_map) {
1433 old_map = hc->new_map;
1434 hc->new_map = NULL;
1437 param->flags &= ~DM_INACTIVE_PRESENT_FLAG;
1439 __dev_status(hc->md, param);
1440 md = hc->md;
1441 up_write(&_hash_lock);
1442 if (old_map) {
1443 dm_sync_table(md);
1444 dm_table_destroy(old_map);
1446 dm_put(md);
1448 return 0;
1452 * Retrieves a list of devices used by a particular dm device.
1454 static void retrieve_deps(struct dm_table *table,
1455 struct dm_ioctl *param, size_t param_size)
1457 unsigned int count = 0;
1458 struct list_head *tmp;
1459 size_t len, needed;
1460 struct dm_dev_internal *dd;
1461 struct dm_target_deps *deps;
1463 deps = get_result_buffer(param, param_size, &len);
1466 * Count the devices.
1468 list_for_each (tmp, dm_table_get_devices(table))
1469 count++;
1472 * Check we have enough space.
1474 needed = sizeof(*deps) + (sizeof(*deps->dev) * count);
1475 if (len < needed) {
1476 param->flags |= DM_BUFFER_FULL_FLAG;
1477 return;
1481 * Fill in the devices.
1483 deps->count = count;
1484 count = 0;
1485 list_for_each_entry (dd, dm_table_get_devices(table), list)
1486 deps->dev[count++] = huge_encode_dev(dd->dm_dev->bdev->bd_dev);
1488 param->data_size = param->data_start + needed;
1491 static int table_deps(struct file *filp, struct dm_ioctl *param, size_t param_size)
1493 struct mapped_device *md;
1494 struct dm_table *table;
1495 int srcu_idx;
1497 md = find_device(param);
1498 if (!md)
1499 return -ENXIO;
1501 __dev_status(md, param);
1503 table = dm_get_live_or_inactive_table(md, param, &srcu_idx);
1504 if (table)
1505 retrieve_deps(table, param, param_size);
1506 dm_put_live_table(md, srcu_idx);
1508 dm_put(md);
1510 return 0;
1514 * Return the status of a device as a text string for each
1515 * target.
1517 static int table_status(struct file *filp, struct dm_ioctl *param, size_t param_size)
1519 struct mapped_device *md;
1520 struct dm_table *table;
1521 int srcu_idx;
1523 md = find_device(param);
1524 if (!md)
1525 return -ENXIO;
1527 __dev_status(md, param);
1529 table = dm_get_live_or_inactive_table(md, param, &srcu_idx);
1530 if (table)
1531 retrieve_status(table, param, param_size);
1532 dm_put_live_table(md, srcu_idx);
1534 dm_put(md);
1536 return 0;
1540 * Process device-mapper dependent messages. Messages prefixed with '@'
1541 * are processed by the DM core. All others are delivered to the target.
1542 * Returns a number <= 1 if message was processed by device mapper.
1543 * Returns 2 if message should be delivered to the target.
1545 static int message_for_md(struct mapped_device *md, unsigned argc, char **argv,
1546 char *result, unsigned maxlen)
1548 int r;
1550 if (**argv != '@')
1551 return 2; /* no '@' prefix, deliver to target */
1553 if (!strcasecmp(argv[0], "@cancel_deferred_remove")) {
1554 if (argc != 1) {
1555 DMERR("Invalid arguments for @cancel_deferred_remove");
1556 return -EINVAL;
1558 return dm_cancel_deferred_remove(md);
1561 r = dm_stats_message(md, argc, argv, result, maxlen);
1562 if (r < 2)
1563 return r;
1565 DMERR("Unsupported message sent to DM core: %s", argv[0]);
1566 return -EINVAL;
1570 * Pass a message to the target that's at the supplied device offset.
1572 static int target_message(struct file *filp, struct dm_ioctl *param, size_t param_size)
1574 int r, argc;
1575 char **argv;
1576 struct mapped_device *md;
1577 struct dm_table *table;
1578 struct dm_target *ti;
1579 struct dm_target_msg *tmsg = (void *) param + param->data_start;
1580 size_t maxlen;
1581 char *result = get_result_buffer(param, param_size, &maxlen);
1582 int srcu_idx;
1584 md = find_device(param);
1585 if (!md)
1586 return -ENXIO;
1588 if (tmsg < (struct dm_target_msg *) param->data ||
1589 invalid_str(tmsg->message, (void *) param + param_size)) {
1590 DMWARN("Invalid target message parameters.");
1591 r = -EINVAL;
1592 goto out;
1595 r = dm_split_args(&argc, &argv, tmsg->message);
1596 if (r) {
1597 DMWARN("Failed to split target message parameters");
1598 goto out;
1601 if (!argc) {
1602 DMWARN("Empty message received.");
1603 goto out_argv;
1606 r = message_for_md(md, argc, argv, result, maxlen);
1607 if (r <= 1)
1608 goto out_argv;
1610 table = dm_get_live_table(md, &srcu_idx);
1611 if (!table)
1612 goto out_table;
1614 if (dm_deleting_md(md)) {
1615 r = -ENXIO;
1616 goto out_table;
1619 ti = dm_table_find_target(table, tmsg->sector);
1620 if (!ti) {
1621 DMWARN("Target message sector outside device.");
1622 r = -EINVAL;
1623 } else if (ti->type->message)
1624 r = ti->type->message(ti, argc, argv, result, maxlen);
1625 else {
1626 DMWARN("Target type does not support messages");
1627 r = -EINVAL;
1630 out_table:
1631 dm_put_live_table(md, srcu_idx);
1632 out_argv:
1633 kfree(argv);
1634 out:
1635 if (r >= 0)
1636 __dev_status(md, param);
1638 if (r == 1) {
1639 param->flags |= DM_DATA_OUT_FLAG;
1640 if (dm_message_test_buffer_overflow(result, maxlen))
1641 param->flags |= DM_BUFFER_FULL_FLAG;
1642 else
1643 param->data_size = param->data_start + strlen(result) + 1;
1644 r = 0;
1647 dm_put(md);
1648 return r;
1652 * The ioctl parameter block consists of two parts, a dm_ioctl struct
1653 * followed by a data buffer. This flag is set if the second part,
1654 * which has a variable size, is not used by the function processing
1655 * the ioctl.
1657 #define IOCTL_FLAGS_NO_PARAMS 1
1658 #define IOCTL_FLAGS_ISSUE_GLOBAL_EVENT 2
1660 /*-----------------------------------------------------------------
1661 * Implementation of open/close/ioctl on the special char
1662 * device.
1663 *---------------------------------------------------------------*/
1664 static ioctl_fn lookup_ioctl(unsigned int cmd, int *ioctl_flags)
1666 static const struct {
1667 int cmd;
1668 int flags;
1669 ioctl_fn fn;
1670 } _ioctls[] = {
1671 {DM_VERSION_CMD, 0, NULL}, /* version is dealt with elsewhere */
1672 {DM_REMOVE_ALL_CMD, IOCTL_FLAGS_NO_PARAMS | IOCTL_FLAGS_ISSUE_GLOBAL_EVENT, remove_all},
1673 {DM_LIST_DEVICES_CMD, 0, list_devices},
1675 {DM_DEV_CREATE_CMD, IOCTL_FLAGS_NO_PARAMS | IOCTL_FLAGS_ISSUE_GLOBAL_EVENT, dev_create},
1676 {DM_DEV_REMOVE_CMD, IOCTL_FLAGS_NO_PARAMS | IOCTL_FLAGS_ISSUE_GLOBAL_EVENT, dev_remove},
1677 {DM_DEV_RENAME_CMD, IOCTL_FLAGS_ISSUE_GLOBAL_EVENT, dev_rename},
1678 {DM_DEV_SUSPEND_CMD, IOCTL_FLAGS_NO_PARAMS, dev_suspend},
1679 {DM_DEV_STATUS_CMD, IOCTL_FLAGS_NO_PARAMS, dev_status},
1680 {DM_DEV_WAIT_CMD, 0, dev_wait},
1682 {DM_TABLE_LOAD_CMD, 0, table_load},
1683 {DM_TABLE_CLEAR_CMD, IOCTL_FLAGS_NO_PARAMS, table_clear},
1684 {DM_TABLE_DEPS_CMD, 0, table_deps},
1685 {DM_TABLE_STATUS_CMD, 0, table_status},
1687 {DM_LIST_VERSIONS_CMD, 0, list_versions},
1689 {DM_TARGET_MSG_CMD, 0, target_message},
1690 {DM_DEV_SET_GEOMETRY_CMD, 0, dev_set_geometry},
1691 {DM_DEV_ARM_POLL, IOCTL_FLAGS_NO_PARAMS, dev_arm_poll},
1692 {DM_GET_TARGET_VERSION, 0, get_target_version},
1695 if (unlikely(cmd >= ARRAY_SIZE(_ioctls)))
1696 return NULL;
1698 *ioctl_flags = _ioctls[cmd].flags;
1699 return _ioctls[cmd].fn;
1703 * As well as checking the version compatibility this always
1704 * copies the kernel interface version out.
1706 static int check_version(unsigned int cmd, struct dm_ioctl __user *user)
1708 uint32_t version[3];
1709 int r = 0;
1711 if (copy_from_user(version, user->version, sizeof(version)))
1712 return -EFAULT;
1714 if ((DM_VERSION_MAJOR != version[0]) ||
1715 (DM_VERSION_MINOR < version[1])) {
1716 DMWARN("ioctl interface mismatch: "
1717 "kernel(%u.%u.%u), user(%u.%u.%u), cmd(%d)",
1718 DM_VERSION_MAJOR, DM_VERSION_MINOR,
1719 DM_VERSION_PATCHLEVEL,
1720 version[0], version[1], version[2], cmd);
1721 r = -EINVAL;
1725 * Fill in the kernel version.
1727 version[0] = DM_VERSION_MAJOR;
1728 version[1] = DM_VERSION_MINOR;
1729 version[2] = DM_VERSION_PATCHLEVEL;
1730 if (copy_to_user(user->version, version, sizeof(version)))
1731 return -EFAULT;
1733 return r;
1736 #define DM_PARAMS_MALLOC 0x0001 /* Params allocated with kvmalloc() */
1737 #define DM_WIPE_BUFFER 0x0010 /* Wipe input buffer before returning from ioctl */
1739 static void free_params(struct dm_ioctl *param, size_t param_size, int param_flags)
1741 if (param_flags & DM_WIPE_BUFFER)
1742 memset(param, 0, param_size);
1744 if (param_flags & DM_PARAMS_MALLOC)
1745 kvfree(param);
1748 static int copy_params(struct dm_ioctl __user *user, struct dm_ioctl *param_kernel,
1749 int ioctl_flags, struct dm_ioctl **param, int *param_flags)
1751 struct dm_ioctl *dmi;
1752 int secure_data;
1753 const size_t minimum_data_size = offsetof(struct dm_ioctl, data);
1754 unsigned noio_flag;
1756 if (copy_from_user(param_kernel, user, minimum_data_size))
1757 return -EFAULT;
1759 if (param_kernel->data_size < minimum_data_size)
1760 return -EINVAL;
1762 secure_data = param_kernel->flags & DM_SECURE_DATA_FLAG;
1764 *param_flags = secure_data ? DM_WIPE_BUFFER : 0;
1766 if (ioctl_flags & IOCTL_FLAGS_NO_PARAMS) {
1767 dmi = param_kernel;
1768 dmi->data_size = minimum_data_size;
1769 goto data_copied;
1773 * Use __GFP_HIGH to avoid low memory issues when a device is
1774 * suspended and the ioctl is needed to resume it.
1775 * Use kmalloc() rather than vmalloc() when we can.
1777 dmi = NULL;
1778 noio_flag = memalloc_noio_save();
1779 dmi = kvmalloc(param_kernel->data_size, GFP_KERNEL | __GFP_HIGH);
1780 memalloc_noio_restore(noio_flag);
1782 if (!dmi) {
1783 if (secure_data && clear_user(user, param_kernel->data_size))
1784 return -EFAULT;
1785 return -ENOMEM;
1788 *param_flags |= DM_PARAMS_MALLOC;
1790 /* Copy from param_kernel (which was already copied from user) */
1791 memcpy(dmi, param_kernel, minimum_data_size);
1793 if (copy_from_user(&dmi->data, (char __user *)user + minimum_data_size,
1794 param_kernel->data_size - minimum_data_size))
1795 goto bad;
1796 data_copied:
1797 /* Wipe the user buffer so we do not return it to userspace */
1798 if (secure_data && clear_user(user, param_kernel->data_size))
1799 goto bad;
1801 *param = dmi;
1802 return 0;
1804 bad:
1805 free_params(dmi, param_kernel->data_size, *param_flags);
1807 return -EFAULT;
1810 static int validate_params(uint cmd, struct dm_ioctl *param)
1812 /* Always clear this flag */
1813 param->flags &= ~DM_BUFFER_FULL_FLAG;
1814 param->flags &= ~DM_UEVENT_GENERATED_FLAG;
1815 param->flags &= ~DM_SECURE_DATA_FLAG;
1816 param->flags &= ~DM_DATA_OUT_FLAG;
1818 /* Ignores parameters */
1819 if (cmd == DM_REMOVE_ALL_CMD ||
1820 cmd == DM_LIST_DEVICES_CMD ||
1821 cmd == DM_LIST_VERSIONS_CMD)
1822 return 0;
1824 if (cmd == DM_DEV_CREATE_CMD) {
1825 if (!*param->name) {
1826 DMWARN("name not supplied when creating device");
1827 return -EINVAL;
1829 } else if (*param->uuid && *param->name) {
1830 DMWARN("only supply one of name or uuid, cmd(%u)", cmd);
1831 return -EINVAL;
1834 /* Ensure strings are terminated */
1835 param->name[DM_NAME_LEN - 1] = '\0';
1836 param->uuid[DM_UUID_LEN - 1] = '\0';
1838 return 0;
1841 static int ctl_ioctl(struct file *file, uint command, struct dm_ioctl __user *user)
1843 int r = 0;
1844 int ioctl_flags;
1845 int param_flags;
1846 unsigned int cmd;
1847 struct dm_ioctl *uninitialized_var(param);
1848 ioctl_fn fn = NULL;
1849 size_t input_param_size;
1850 struct dm_ioctl param_kernel;
1852 /* only root can play with this */
1853 if (!capable(CAP_SYS_ADMIN))
1854 return -EACCES;
1856 if (_IOC_TYPE(command) != DM_IOCTL)
1857 return -ENOTTY;
1859 cmd = _IOC_NR(command);
1862 * Check the interface version passed in. This also
1863 * writes out the kernel's interface version.
1865 r = check_version(cmd, user);
1866 if (r)
1867 return r;
1870 * Nothing more to do for the version command.
1872 if (cmd == DM_VERSION_CMD)
1873 return 0;
1875 fn = lookup_ioctl(cmd, &ioctl_flags);
1876 if (!fn) {
1877 DMWARN("dm_ctl_ioctl: unknown command 0x%x", command);
1878 return -ENOTTY;
1882 * Copy the parameters into kernel space.
1884 r = copy_params(user, &param_kernel, ioctl_flags, &param, &param_flags);
1886 if (r)
1887 return r;
1889 input_param_size = param->data_size;
1890 r = validate_params(cmd, param);
1891 if (r)
1892 goto out;
1894 param->data_size = offsetof(struct dm_ioctl, data);
1895 r = fn(file, param, input_param_size);
1897 if (unlikely(param->flags & DM_BUFFER_FULL_FLAG) &&
1898 unlikely(ioctl_flags & IOCTL_FLAGS_NO_PARAMS))
1899 DMERR("ioctl %d tried to output some data but has IOCTL_FLAGS_NO_PARAMS set", cmd);
1901 if (!r && ioctl_flags & IOCTL_FLAGS_ISSUE_GLOBAL_EVENT)
1902 dm_issue_global_event();
1905 * Copy the results back to userland.
1907 if (!r && copy_to_user(user, param, param->data_size))
1908 r = -EFAULT;
1910 out:
1911 free_params(param, input_param_size, param_flags);
1912 return r;
1915 static long dm_ctl_ioctl(struct file *file, uint command, ulong u)
1917 return (long)ctl_ioctl(file, command, (struct dm_ioctl __user *)u);
1920 #ifdef CONFIG_COMPAT
1921 static long dm_compat_ctl_ioctl(struct file *file, uint command, ulong u)
1923 return (long)dm_ctl_ioctl(file, command, (ulong) compat_ptr(u));
1925 #else
1926 #define dm_compat_ctl_ioctl NULL
1927 #endif
1929 static int dm_open(struct inode *inode, struct file *filp)
1931 int r;
1932 struct dm_file *priv;
1934 r = nonseekable_open(inode, filp);
1935 if (unlikely(r))
1936 return r;
1938 priv = filp->private_data = kmalloc(sizeof(struct dm_file), GFP_KERNEL);
1939 if (!priv)
1940 return -ENOMEM;
1942 priv->global_event_nr = atomic_read(&dm_global_event_nr);
1944 return 0;
1947 static int dm_release(struct inode *inode, struct file *filp)
1949 kfree(filp->private_data);
1950 return 0;
1953 static __poll_t dm_poll(struct file *filp, poll_table *wait)
1955 struct dm_file *priv = filp->private_data;
1956 __poll_t mask = 0;
1958 poll_wait(filp, &dm_global_eventq, wait);
1960 if ((int)(atomic_read(&dm_global_event_nr) - priv->global_event_nr) > 0)
1961 mask |= EPOLLIN;
1963 return mask;
1966 static const struct file_operations _ctl_fops = {
1967 .open = dm_open,
1968 .release = dm_release,
1969 .poll = dm_poll,
1970 .unlocked_ioctl = dm_ctl_ioctl,
1971 .compat_ioctl = dm_compat_ctl_ioctl,
1972 .owner = THIS_MODULE,
1973 .llseek = noop_llseek,
1976 static struct miscdevice _dm_misc = {
1977 .minor = MAPPER_CTRL_MINOR,
1978 .name = DM_NAME,
1979 .nodename = DM_DIR "/" DM_CONTROL_NODE,
1980 .fops = &_ctl_fops
1983 MODULE_ALIAS_MISCDEV(MAPPER_CTRL_MINOR);
1984 MODULE_ALIAS("devname:" DM_DIR "/" DM_CONTROL_NODE);
1987 * Create misc character device and link to DM_DIR/control.
1989 int __init dm_interface_init(void)
1991 int r;
1993 r = dm_hash_init();
1994 if (r)
1995 return r;
1997 r = misc_register(&_dm_misc);
1998 if (r) {
1999 DMERR("misc_register failed for control device");
2000 dm_hash_exit();
2001 return r;
2004 DMINFO("%d.%d.%d%s initialised: %s", DM_VERSION_MAJOR,
2005 DM_VERSION_MINOR, DM_VERSION_PATCHLEVEL, DM_VERSION_EXTRA,
2006 DM_DRIVER_EMAIL);
2007 return 0;
2010 void dm_interface_exit(void)
2012 misc_deregister(&_dm_misc);
2013 dm_hash_exit();
2017 * dm_copy_name_and_uuid - Copy mapped device name & uuid into supplied buffers
2018 * @md: Pointer to mapped_device
2019 * @name: Buffer (size DM_NAME_LEN) for name
2020 * @uuid: Buffer (size DM_UUID_LEN) for uuid or empty string if uuid not defined
2022 int dm_copy_name_and_uuid(struct mapped_device *md, char *name, char *uuid)
2024 int r = 0;
2025 struct hash_cell *hc;
2027 if (!md)
2028 return -ENXIO;
2030 mutex_lock(&dm_hash_cells_mutex);
2031 hc = dm_get_mdptr(md);
2032 if (!hc || hc->md != md) {
2033 r = -ENXIO;
2034 goto out;
2037 if (name)
2038 strcpy(name, hc->name);
2039 if (uuid)
2040 strcpy(uuid, hc->uuid ? : "");
2042 out:
2043 mutex_unlock(&dm_hash_cells_mutex);
2045 return r;
2050 * dm_early_create - create a mapped device in early boot.
2052 * @dmi: Contains main information of the device mapping to be created.
2053 * @spec_array: array of pointers to struct dm_target_spec. Describes the
2054 * mapping table of the device.
2055 * @target_params_array: array of strings with the parameters to a specific
2056 * target.
2058 * Instead of having the struct dm_target_spec and the parameters for every
2059 * target embedded at the end of struct dm_ioctl (as performed in a normal
2060 * ioctl), pass them as arguments, so the caller doesn't need to serialize them.
2061 * The size of the spec_array and target_params_array is given by
2062 * @dmi->target_count.
2063 * This function is supposed to be called in early boot, so locking mechanisms
2064 * to protect against concurrent loads are not required.
2066 int __init dm_early_create(struct dm_ioctl *dmi,
2067 struct dm_target_spec **spec_array,
2068 char **target_params_array)
2070 int r, m = DM_ANY_MINOR;
2071 struct dm_table *t, *old_map;
2072 struct mapped_device *md;
2073 unsigned int i;
2075 if (!dmi->target_count)
2076 return -EINVAL;
2078 r = check_name(dmi->name);
2079 if (r)
2080 return r;
2082 if (dmi->flags & DM_PERSISTENT_DEV_FLAG)
2083 m = MINOR(huge_decode_dev(dmi->dev));
2085 /* alloc dm device */
2086 r = dm_create(m, &md);
2087 if (r)
2088 return r;
2090 /* hash insert */
2091 r = dm_hash_insert(dmi->name, *dmi->uuid ? dmi->uuid : NULL, md);
2092 if (r)
2093 goto err_destroy_dm;
2095 /* alloc table */
2096 r = dm_table_create(&t, get_mode(dmi), dmi->target_count, md);
2097 if (r)
2098 goto err_hash_remove;
2100 /* add targets */
2101 for (i = 0; i < dmi->target_count; i++) {
2102 r = dm_table_add_target(t, spec_array[i]->target_type,
2103 (sector_t) spec_array[i]->sector_start,
2104 (sector_t) spec_array[i]->length,
2105 target_params_array[i]);
2106 if (r) {
2107 DMWARN("error adding target to table");
2108 goto err_destroy_table;
2112 /* finish table */
2113 r = dm_table_complete(t);
2114 if (r)
2115 goto err_destroy_table;
2117 md->type = dm_table_get_type(t);
2118 /* setup md->queue to reflect md's type (may block) */
2119 r = dm_setup_md_queue(md, t);
2120 if (r) {
2121 DMWARN("unable to set up device queue for new table.");
2122 goto err_destroy_table;
2125 /* Set new map */
2126 dm_suspend(md, 0);
2127 old_map = dm_swap_table(md, t);
2128 if (IS_ERR(old_map)) {
2129 r = PTR_ERR(old_map);
2130 goto err_destroy_table;
2132 set_disk_ro(dm_disk(md), !!(dmi->flags & DM_READONLY_FLAG));
2134 /* resume device */
2135 r = dm_resume(md);
2136 if (r)
2137 goto err_destroy_table;
2139 DMINFO("%s (%s) is ready", md->disk->disk_name, dmi->name);
2140 dm_put(md);
2141 return 0;
2143 err_destroy_table:
2144 dm_table_destroy(t);
2145 err_hash_remove:
2146 (void) __hash_remove(__get_name_cell(dmi->name));
2147 /* release reference from __get_name_cell */
2148 dm_put(md);
2149 err_destroy_dm:
2150 dm_put(md);
2151 dm_destroy(md);
2152 return r;