Loading...
1/*
2 * Copyright (C) 2001, 2002 Sistina Software (UK) Limited.
3 * Copyright (C) 2004 - 2006 Red Hat, Inc. All rights reserved.
4 *
5 * This file is released under the GPL.
6 */
7
8#include "dm-core.h"
9#include "dm-ima.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/rbtree.h>
18#include <linux/dm-ioctl.h>
19#include <linux/hdreg.h>
20#include <linux/compat.h>
21#include <linux/nospec.h>
22
23#include <linux/uaccess.h>
24#include <linux/ima.h>
25
26#define DM_MSG_PREFIX "ioctl"
27#define DM_DRIVER_EMAIL "dm-devel@redhat.com"
28
29struct dm_file {
30 /*
31 * poll will wait until the global event number is greater than
32 * this value.
33 */
34 volatile unsigned global_event_nr;
35};
36
37/*-----------------------------------------------------------------
38 * The ioctl interface needs to be able to look up devices by
39 * name or uuid.
40 *---------------------------------------------------------------*/
41struct hash_cell {
42 struct rb_node name_node;
43 struct rb_node uuid_node;
44 bool name_set;
45 bool uuid_set;
46
47 char *name;
48 char *uuid;
49 struct mapped_device *md;
50 struct dm_table *new_map;
51};
52
53struct vers_iter {
54 size_t param_size;
55 struct dm_target_versions *vers, *old_vers;
56 char *end;
57 uint32_t flags;
58};
59
60
61static struct rb_root name_rb_tree = RB_ROOT;
62static struct rb_root uuid_rb_tree = RB_ROOT;
63
64static void dm_hash_remove_all(bool keep_open_devices, bool mark_deferred, bool only_deferred);
65
66/*
67 * Guards access to both hash tables.
68 */
69static DECLARE_RWSEM(_hash_lock);
70
71/*
72 * Protects use of mdptr to obtain hash cell name and uuid from mapped device.
73 */
74static DEFINE_MUTEX(dm_hash_cells_mutex);
75
76static void dm_hash_exit(void)
77{
78 dm_hash_remove_all(false, false, false);
79}
80
81/*-----------------------------------------------------------------
82 * Code for looking up a device by name
83 *---------------------------------------------------------------*/
84static struct hash_cell *__get_name_cell(const char *str)
85{
86 struct rb_node *n = name_rb_tree.rb_node;
87
88 while (n) {
89 struct hash_cell *hc = container_of(n, struct hash_cell, name_node);
90 int c = strcmp(hc->name, str);
91 if (!c) {
92 dm_get(hc->md);
93 return hc;
94 }
95 n = c >= 0 ? n->rb_left : n->rb_right;
96 }
97
98 return NULL;
99}
100
101static struct hash_cell *__get_uuid_cell(const char *str)
102{
103 struct rb_node *n = uuid_rb_tree.rb_node;
104
105 while (n) {
106 struct hash_cell *hc = container_of(n, struct hash_cell, uuid_node);
107 int c = strcmp(hc->uuid, str);
108 if (!c) {
109 dm_get(hc->md);
110 return hc;
111 }
112 n = c >= 0 ? n->rb_left : n->rb_right;
113 }
114
115 return NULL;
116}
117
118static void __unlink_name(struct hash_cell *hc)
119{
120 if (hc->name_set) {
121 hc->name_set = false;
122 rb_erase(&hc->name_node, &name_rb_tree);
123 }
124}
125
126static void __unlink_uuid(struct hash_cell *hc)
127{
128 if (hc->uuid_set) {
129 hc->uuid_set = false;
130 rb_erase(&hc->uuid_node, &uuid_rb_tree);
131 }
132}
133
134static void __link_name(struct hash_cell *new_hc)
135{
136 struct rb_node **n, *parent;
137
138 __unlink_name(new_hc);
139
140 new_hc->name_set = true;
141
142 n = &name_rb_tree.rb_node;
143 parent = NULL;
144
145 while (*n) {
146 struct hash_cell *hc = container_of(*n, struct hash_cell, name_node);
147 int c = strcmp(hc->name, new_hc->name);
148 BUG_ON(!c);
149 parent = *n;
150 n = c >= 0 ? &hc->name_node.rb_left : &hc->name_node.rb_right;
151 }
152
153 rb_link_node(&new_hc->name_node, parent, n);
154 rb_insert_color(&new_hc->name_node, &name_rb_tree);
155}
156
157static void __link_uuid(struct hash_cell *new_hc)
158{
159 struct rb_node **n, *parent;
160
161 __unlink_uuid(new_hc);
162
163 new_hc->uuid_set = true;
164
165 n = &uuid_rb_tree.rb_node;
166 parent = NULL;
167
168 while (*n) {
169 struct hash_cell *hc = container_of(*n, struct hash_cell, uuid_node);
170 int c = strcmp(hc->uuid, new_hc->uuid);
171 BUG_ON(!c);
172 parent = *n;
173 n = c > 0 ? &hc->uuid_node.rb_left : &hc->uuid_node.rb_right;
174 }
175
176 rb_link_node(&new_hc->uuid_node, parent, n);
177 rb_insert_color(&new_hc->uuid_node, &uuid_rb_tree);
178}
179
180static struct hash_cell *__get_dev_cell(uint64_t dev)
181{
182 struct mapped_device *md;
183 struct hash_cell *hc;
184
185 md = dm_get_md(huge_decode_dev(dev));
186 if (!md)
187 return NULL;
188
189 hc = dm_get_mdptr(md);
190 if (!hc) {
191 dm_put(md);
192 return NULL;
193 }
194
195 return hc;
196}
197
198/*-----------------------------------------------------------------
199 * Inserting, removing and renaming a device.
200 *---------------------------------------------------------------*/
201static struct hash_cell *alloc_cell(const char *name, const char *uuid,
202 struct mapped_device *md)
203{
204 struct hash_cell *hc;
205
206 hc = kmalloc(sizeof(*hc), GFP_KERNEL);
207 if (!hc)
208 return NULL;
209
210 hc->name = kstrdup(name, GFP_KERNEL);
211 if (!hc->name) {
212 kfree(hc);
213 return NULL;
214 }
215
216 if (!uuid)
217 hc->uuid = NULL;
218
219 else {
220 hc->uuid = kstrdup(uuid, GFP_KERNEL);
221 if (!hc->uuid) {
222 kfree(hc->name);
223 kfree(hc);
224 return NULL;
225 }
226 }
227
228 hc->name_set = hc->uuid_set = false;
229 hc->md = md;
230 hc->new_map = NULL;
231 return hc;
232}
233
234static void free_cell(struct hash_cell *hc)
235{
236 if (hc) {
237 kfree(hc->name);
238 kfree(hc->uuid);
239 kfree(hc);
240 }
241}
242
243/*
244 * The kdev_t and uuid of a device can never change once it is
245 * initially inserted.
246 */
247static int dm_hash_insert(const char *name, const char *uuid, struct mapped_device *md)
248{
249 struct hash_cell *cell, *hc;
250
251 /*
252 * Allocate the new cells.
253 */
254 cell = alloc_cell(name, uuid, md);
255 if (!cell)
256 return -ENOMEM;
257
258 /*
259 * Insert the cell into both hash tables.
260 */
261 down_write(&_hash_lock);
262 hc = __get_name_cell(name);
263 if (hc) {
264 dm_put(hc->md);
265 goto bad;
266 }
267
268 __link_name(cell);
269
270 if (uuid) {
271 hc = __get_uuid_cell(uuid);
272 if (hc) {
273 __unlink_name(cell);
274 dm_put(hc->md);
275 goto bad;
276 }
277 __link_uuid(cell);
278 }
279 dm_get(md);
280 mutex_lock(&dm_hash_cells_mutex);
281 dm_set_mdptr(md, cell);
282 mutex_unlock(&dm_hash_cells_mutex);
283 up_write(&_hash_lock);
284
285 return 0;
286
287 bad:
288 up_write(&_hash_lock);
289 free_cell(cell);
290 return -EBUSY;
291}
292
293static struct dm_table *__hash_remove(struct hash_cell *hc)
294{
295 struct dm_table *table;
296 int srcu_idx;
297
298 /* remove from the dev trees */
299 __unlink_name(hc);
300 __unlink_uuid(hc);
301 mutex_lock(&dm_hash_cells_mutex);
302 dm_set_mdptr(hc->md, NULL);
303 mutex_unlock(&dm_hash_cells_mutex);
304
305 table = dm_get_live_table(hc->md, &srcu_idx);
306 if (table)
307 dm_table_event(table);
308 dm_put_live_table(hc->md, srcu_idx);
309
310 table = NULL;
311 if (hc->new_map)
312 table = hc->new_map;
313 dm_put(hc->md);
314 free_cell(hc);
315
316 return table;
317}
318
319static void dm_hash_remove_all(bool keep_open_devices, bool mark_deferred, bool only_deferred)
320{
321 int dev_skipped;
322 struct rb_node *n;
323 struct hash_cell *hc;
324 struct mapped_device *md;
325 struct dm_table *t;
326
327retry:
328 dev_skipped = 0;
329
330 down_write(&_hash_lock);
331
332 for (n = rb_first(&name_rb_tree); n; n = rb_next(n)) {
333 hc = container_of(n, struct hash_cell, name_node);
334 md = hc->md;
335 dm_get(md);
336
337 if (keep_open_devices &&
338 dm_lock_for_deletion(md, mark_deferred, only_deferred)) {
339 dm_put(md);
340 dev_skipped++;
341 continue;
342 }
343
344 t = __hash_remove(hc);
345
346 up_write(&_hash_lock);
347
348 if (t) {
349 dm_sync_table(md);
350 dm_table_destroy(t);
351 }
352 dm_ima_measure_on_device_remove(md, true);
353 dm_put(md);
354 if (likely(keep_open_devices))
355 dm_destroy(md);
356 else
357 dm_destroy_immediate(md);
358
359 /*
360 * Some mapped devices may be using other mapped
361 * devices, so repeat until we make no further
362 * progress. If a new mapped device is created
363 * here it will also get removed.
364 */
365 goto retry;
366 }
367
368 up_write(&_hash_lock);
369
370 if (dev_skipped)
371 DMWARN("remove_all left %d open device(s)", dev_skipped);
372}
373
374/*
375 * Set the uuid of a hash_cell that isn't already set.
376 */
377static void __set_cell_uuid(struct hash_cell *hc, char *new_uuid)
378{
379 mutex_lock(&dm_hash_cells_mutex);
380 hc->uuid = new_uuid;
381 mutex_unlock(&dm_hash_cells_mutex);
382
383 __link_uuid(hc);
384}
385
386/*
387 * Changes the name of a hash_cell and returns the old name for
388 * the caller to free.
389 */
390static char *__change_cell_name(struct hash_cell *hc, char *new_name)
391{
392 char *old_name;
393
394 /*
395 * Rename and move the name cell.
396 */
397 __unlink_name(hc);
398 old_name = hc->name;
399
400 mutex_lock(&dm_hash_cells_mutex);
401 hc->name = new_name;
402 mutex_unlock(&dm_hash_cells_mutex);
403
404 __link_name(hc);
405
406 return old_name;
407}
408
409static struct mapped_device *dm_hash_rename(struct dm_ioctl *param,
410 const char *new)
411{
412 char *new_data, *old_name = NULL;
413 struct hash_cell *hc;
414 struct dm_table *table;
415 struct mapped_device *md;
416 unsigned change_uuid = (param->flags & DM_UUID_FLAG) ? 1 : 0;
417 int srcu_idx;
418
419 /*
420 * duplicate new.
421 */
422 new_data = kstrdup(new, GFP_KERNEL);
423 if (!new_data)
424 return ERR_PTR(-ENOMEM);
425
426 down_write(&_hash_lock);
427
428 /*
429 * Is new free ?
430 */
431 if (change_uuid)
432 hc = __get_uuid_cell(new);
433 else
434 hc = __get_name_cell(new);
435
436 if (hc) {
437 DMERR("Unable to change %s on mapped device %s to one that "
438 "already exists: %s",
439 change_uuid ? "uuid" : "name",
440 param->name, new);
441 dm_put(hc->md);
442 up_write(&_hash_lock);
443 kfree(new_data);
444 return ERR_PTR(-EBUSY);
445 }
446
447 /*
448 * Is there such a device as 'old' ?
449 */
450 hc = __get_name_cell(param->name);
451 if (!hc) {
452 DMERR("Unable to rename non-existent device, %s to %s%s",
453 param->name, change_uuid ? "uuid " : "", new);
454 up_write(&_hash_lock);
455 kfree(new_data);
456 return ERR_PTR(-ENXIO);
457 }
458
459 /*
460 * Does this device already have a uuid?
461 */
462 if (change_uuid && hc->uuid) {
463 DMERR("Unable to change uuid of mapped device %s to %s "
464 "because uuid is already set to %s",
465 param->name, new, hc->uuid);
466 dm_put(hc->md);
467 up_write(&_hash_lock);
468 kfree(new_data);
469 return ERR_PTR(-EINVAL);
470 }
471
472 if (change_uuid)
473 __set_cell_uuid(hc, new_data);
474 else
475 old_name = __change_cell_name(hc, new_data);
476
477 /*
478 * Wake up any dm event waiters.
479 */
480 table = dm_get_live_table(hc->md, &srcu_idx);
481 if (table)
482 dm_table_event(table);
483 dm_put_live_table(hc->md, srcu_idx);
484
485 if (!dm_kobject_uevent(hc->md, KOBJ_CHANGE, param->event_nr))
486 param->flags |= DM_UEVENT_GENERATED_FLAG;
487
488 md = hc->md;
489
490 dm_ima_measure_on_device_rename(md);
491
492 up_write(&_hash_lock);
493 kfree(old_name);
494
495 return md;
496}
497
498void dm_deferred_remove(void)
499{
500 dm_hash_remove_all(true, false, true);
501}
502
503/*-----------------------------------------------------------------
504 * Implementation of the ioctl commands
505 *---------------------------------------------------------------*/
506/*
507 * All the ioctl commands get dispatched to functions with this
508 * prototype.
509 */
510typedef int (*ioctl_fn)(struct file *filp, struct dm_ioctl *param, size_t param_size);
511
512static int remove_all(struct file *filp, struct dm_ioctl *param, size_t param_size)
513{
514 dm_hash_remove_all(true, !!(param->flags & DM_DEFERRED_REMOVE), false);
515 param->data_size = 0;
516 return 0;
517}
518
519/*
520 * Round up the ptr to an 8-byte boundary.
521 */
522#define ALIGN_MASK 7
523static inline size_t align_val(size_t val)
524{
525 return (val + ALIGN_MASK) & ~ALIGN_MASK;
526}
527static inline void *align_ptr(void *ptr)
528{
529 return (void *)align_val((size_t)ptr);
530}
531
532/*
533 * Retrieves the data payload buffer from an already allocated
534 * struct dm_ioctl.
535 */
536static void *get_result_buffer(struct dm_ioctl *param, size_t param_size,
537 size_t *len)
538{
539 param->data_start = align_ptr(param + 1) - (void *) param;
540
541 if (param->data_start < param_size)
542 *len = param_size - param->data_start;
543 else
544 *len = 0;
545
546 return ((void *) param) + param->data_start;
547}
548
549static bool filter_device(struct hash_cell *hc, const char *pfx_name, const char *pfx_uuid)
550{
551 const char *val;
552 size_t val_len, pfx_len;
553
554 val = hc->name;
555 val_len = strlen(val);
556 pfx_len = strnlen(pfx_name, DM_NAME_LEN);
557 if (pfx_len > val_len)
558 return false;
559 if (memcmp(val, pfx_name, pfx_len))
560 return false;
561
562 val = hc->uuid ? hc->uuid : "";
563 val_len = strlen(val);
564 pfx_len = strnlen(pfx_uuid, DM_UUID_LEN);
565 if (pfx_len > val_len)
566 return false;
567 if (memcmp(val, pfx_uuid, pfx_len))
568 return false;
569
570 return true;
571}
572
573static int list_devices(struct file *filp, struct dm_ioctl *param, size_t param_size)
574{
575 struct rb_node *n;
576 struct hash_cell *hc;
577 size_t len, needed = 0;
578 struct gendisk *disk;
579 struct dm_name_list *orig_nl, *nl, *old_nl = NULL;
580 uint32_t *event_nr;
581
582 down_write(&_hash_lock);
583
584 /*
585 * Loop through all the devices working out how much
586 * space we need.
587 */
588 for (n = rb_first(&name_rb_tree); n; n = rb_next(n)) {
589 hc = container_of(n, struct hash_cell, name_node);
590 if (!filter_device(hc, param->name, param->uuid))
591 continue;
592 needed += align_val(offsetof(struct dm_name_list, name) + strlen(hc->name) + 1);
593 needed += align_val(sizeof(uint32_t) * 2);
594 if (param->flags & DM_UUID_FLAG && hc->uuid)
595 needed += align_val(strlen(hc->uuid) + 1);
596 }
597
598 /*
599 * Grab our output buffer.
600 */
601 nl = orig_nl = get_result_buffer(param, param_size, &len);
602 if (len < needed || len < sizeof(nl->dev)) {
603 param->flags |= DM_BUFFER_FULL_FLAG;
604 goto out;
605 }
606 param->data_size = param->data_start + needed;
607
608 nl->dev = 0; /* Flags no data */
609
610 /*
611 * Now loop through filling out the names.
612 */
613 for (n = rb_first(&name_rb_tree); n; n = rb_next(n)) {
614 void *uuid_ptr;
615 hc = container_of(n, struct hash_cell, name_node);
616 if (!filter_device(hc, param->name, param->uuid))
617 continue;
618 if (old_nl)
619 old_nl->next = (uint32_t) ((void *) nl -
620 (void *) old_nl);
621 disk = dm_disk(hc->md);
622 nl->dev = huge_encode_dev(disk_devt(disk));
623 nl->next = 0;
624 strcpy(nl->name, hc->name);
625
626 old_nl = nl;
627 event_nr = align_ptr(nl->name + strlen(hc->name) + 1);
628 event_nr[0] = dm_get_event_nr(hc->md);
629 event_nr[1] = 0;
630 uuid_ptr = align_ptr(event_nr + 2);
631 if (param->flags & DM_UUID_FLAG) {
632 if (hc->uuid) {
633 event_nr[1] |= DM_NAME_LIST_FLAG_HAS_UUID;
634 strcpy(uuid_ptr, hc->uuid);
635 uuid_ptr = align_ptr(uuid_ptr + strlen(hc->uuid) + 1);
636 } else {
637 event_nr[1] |= DM_NAME_LIST_FLAG_DOESNT_HAVE_UUID;
638 }
639 }
640 nl = uuid_ptr;
641 }
642 /*
643 * If mismatch happens, security may be compromised due to buffer
644 * overflow, so it's better to crash.
645 */
646 BUG_ON((char *)nl - (char *)orig_nl != needed);
647
648 out:
649 up_write(&_hash_lock);
650 return 0;
651}
652
653static void list_version_get_needed(struct target_type *tt, void *needed_param)
654{
655 size_t *needed = needed_param;
656
657 *needed += sizeof(struct dm_target_versions);
658 *needed += strlen(tt->name) + 1;
659 *needed += ALIGN_MASK;
660}
661
662static void list_version_get_info(struct target_type *tt, void *param)
663{
664 struct vers_iter *info = param;
665
666 /* Check space - it might have changed since the first iteration */
667 if ((char *)info->vers + sizeof(tt->version) + strlen(tt->name) + 1 >
668 info->end) {
669
670 info->flags = DM_BUFFER_FULL_FLAG;
671 return;
672 }
673
674 if (info->old_vers)
675 info->old_vers->next = (uint32_t) ((void *)info->vers -
676 (void *)info->old_vers);
677 info->vers->version[0] = tt->version[0];
678 info->vers->version[1] = tt->version[1];
679 info->vers->version[2] = tt->version[2];
680 info->vers->next = 0;
681 strcpy(info->vers->name, tt->name);
682
683 info->old_vers = info->vers;
684 info->vers = align_ptr((void *)(info->vers + 1) + strlen(tt->name) + 1);
685}
686
687static int __list_versions(struct dm_ioctl *param, size_t param_size, const char *name)
688{
689 size_t len, needed = 0;
690 struct dm_target_versions *vers;
691 struct vers_iter iter_info;
692 struct target_type *tt = NULL;
693
694 if (name) {
695 tt = dm_get_target_type(name);
696 if (!tt)
697 return -EINVAL;
698 }
699
700 /*
701 * Loop through all the devices working out how much
702 * space we need.
703 */
704 if (!tt)
705 dm_target_iterate(list_version_get_needed, &needed);
706 else
707 list_version_get_needed(tt, &needed);
708
709 /*
710 * Grab our output buffer.
711 */
712 vers = get_result_buffer(param, param_size, &len);
713 if (len < needed) {
714 param->flags |= DM_BUFFER_FULL_FLAG;
715 goto out;
716 }
717 param->data_size = param->data_start + needed;
718
719 iter_info.param_size = param_size;
720 iter_info.old_vers = NULL;
721 iter_info.vers = vers;
722 iter_info.flags = 0;
723 iter_info.end = (char *)vers + needed;
724
725 /*
726 * Now loop through filling out the names & versions.
727 */
728 if (!tt)
729 dm_target_iterate(list_version_get_info, &iter_info);
730 else
731 list_version_get_info(tt, &iter_info);
732 param->flags |= iter_info.flags;
733
734 out:
735 if (tt)
736 dm_put_target_type(tt);
737 return 0;
738}
739
740static int list_versions(struct file *filp, struct dm_ioctl *param, size_t param_size)
741{
742 return __list_versions(param, param_size, NULL);
743}
744
745static int get_target_version(struct file *filp, struct dm_ioctl *param, size_t param_size)
746{
747 return __list_versions(param, param_size, param->name);
748}
749
750static int check_name(const char *name)
751{
752 if (strchr(name, '/')) {
753 DMERR("invalid device name");
754 return -EINVAL;
755 }
756
757 return 0;
758}
759
760/*
761 * On successful return, the caller must not attempt to acquire
762 * _hash_lock without first calling dm_put_live_table, because dm_table_destroy
763 * waits for this dm_put_live_table and could be called under this lock.
764 */
765static struct dm_table *dm_get_inactive_table(struct mapped_device *md, int *srcu_idx)
766{
767 struct hash_cell *hc;
768 struct dm_table *table = NULL;
769
770 /* increment rcu count, we don't care about the table pointer */
771 dm_get_live_table(md, srcu_idx);
772
773 down_read(&_hash_lock);
774 hc = dm_get_mdptr(md);
775 if (!hc || hc->md != md) {
776 DMERR("device has been removed from the dev hash table.");
777 goto out;
778 }
779
780 table = hc->new_map;
781
782out:
783 up_read(&_hash_lock);
784
785 return table;
786}
787
788static struct dm_table *dm_get_live_or_inactive_table(struct mapped_device *md,
789 struct dm_ioctl *param,
790 int *srcu_idx)
791{
792 return (param->flags & DM_QUERY_INACTIVE_TABLE_FLAG) ?
793 dm_get_inactive_table(md, srcu_idx) : dm_get_live_table(md, srcu_idx);
794}
795
796/*
797 * Fills in a dm_ioctl structure, ready for sending back to
798 * userland.
799 */
800static void __dev_status(struct mapped_device *md, struct dm_ioctl *param)
801{
802 struct gendisk *disk = dm_disk(md);
803 struct dm_table *table;
804 int srcu_idx;
805
806 param->flags &= ~(DM_SUSPEND_FLAG | DM_READONLY_FLAG |
807 DM_ACTIVE_PRESENT_FLAG | DM_INTERNAL_SUSPEND_FLAG);
808
809 if (dm_suspended_md(md))
810 param->flags |= DM_SUSPEND_FLAG;
811
812 if (dm_suspended_internally_md(md))
813 param->flags |= DM_INTERNAL_SUSPEND_FLAG;
814
815 if (dm_test_deferred_remove_flag(md))
816 param->flags |= DM_DEFERRED_REMOVE;
817
818 param->dev = huge_encode_dev(disk_devt(disk));
819
820 /*
821 * Yes, this will be out of date by the time it gets back
822 * to userland, but it is still very useful for
823 * debugging.
824 */
825 param->open_count = dm_open_count(md);
826
827 param->event_nr = dm_get_event_nr(md);
828 param->target_count = 0;
829
830 table = dm_get_live_table(md, &srcu_idx);
831 if (table) {
832 if (!(param->flags & DM_QUERY_INACTIVE_TABLE_FLAG)) {
833 if (get_disk_ro(disk))
834 param->flags |= DM_READONLY_FLAG;
835 param->target_count = table->num_targets;
836 }
837
838 param->flags |= DM_ACTIVE_PRESENT_FLAG;
839 }
840 dm_put_live_table(md, srcu_idx);
841
842 if (param->flags & DM_QUERY_INACTIVE_TABLE_FLAG) {
843 int srcu_idx;
844 table = dm_get_inactive_table(md, &srcu_idx);
845 if (table) {
846 if (!(dm_table_get_mode(table) & FMODE_WRITE))
847 param->flags |= DM_READONLY_FLAG;
848 param->target_count = table->num_targets;
849 }
850 dm_put_live_table(md, srcu_idx);
851 }
852}
853
854static int dev_create(struct file *filp, struct dm_ioctl *param, size_t param_size)
855{
856 int r, m = DM_ANY_MINOR;
857 struct mapped_device *md;
858
859 r = check_name(param->name);
860 if (r)
861 return r;
862
863 if (param->flags & DM_PERSISTENT_DEV_FLAG)
864 m = MINOR(huge_decode_dev(param->dev));
865
866 r = dm_create(m, &md);
867 if (r)
868 return r;
869
870 r = dm_hash_insert(param->name, *param->uuid ? param->uuid : NULL, md);
871 if (r) {
872 dm_put(md);
873 dm_destroy(md);
874 return r;
875 }
876
877 param->flags &= ~DM_INACTIVE_PRESENT_FLAG;
878
879 __dev_status(md, param);
880
881 dm_put(md);
882
883 return 0;
884}
885
886/*
887 * Always use UUID for lookups if it's present, otherwise use name or dev.
888 */
889static struct hash_cell *__find_device_hash_cell(struct dm_ioctl *param)
890{
891 struct hash_cell *hc = NULL;
892
893 if (*param->uuid) {
894 if (*param->name || param->dev) {
895 DMERR("Invalid ioctl structure: uuid %s, name %s, dev %llx",
896 param->uuid, param->name, (unsigned long long)param->dev);
897 return NULL;
898 }
899
900 hc = __get_uuid_cell(param->uuid);
901 if (!hc)
902 return NULL;
903 } else if (*param->name) {
904 if (param->dev) {
905 DMERR("Invalid ioctl structure: name %s, dev %llx",
906 param->name, (unsigned long long)param->dev);
907 return NULL;
908 }
909
910 hc = __get_name_cell(param->name);
911 if (!hc)
912 return NULL;
913 } else if (param->dev) {
914 hc = __get_dev_cell(param->dev);
915 if (!hc)
916 return NULL;
917 } else
918 return NULL;
919
920 /*
921 * Sneakily write in both the name and the uuid
922 * while we have the cell.
923 */
924 strlcpy(param->name, hc->name, sizeof(param->name));
925 if (hc->uuid)
926 strlcpy(param->uuid, hc->uuid, sizeof(param->uuid));
927 else
928 param->uuid[0] = '\0';
929
930 if (hc->new_map)
931 param->flags |= DM_INACTIVE_PRESENT_FLAG;
932 else
933 param->flags &= ~DM_INACTIVE_PRESENT_FLAG;
934
935 return hc;
936}
937
938static struct mapped_device *find_device(struct dm_ioctl *param)
939{
940 struct hash_cell *hc;
941 struct mapped_device *md = NULL;
942
943 down_read(&_hash_lock);
944 hc = __find_device_hash_cell(param);
945 if (hc)
946 md = hc->md;
947 up_read(&_hash_lock);
948
949 return md;
950}
951
952static int dev_remove(struct file *filp, struct dm_ioctl *param, size_t param_size)
953{
954 struct hash_cell *hc;
955 struct mapped_device *md;
956 int r;
957 struct dm_table *t;
958
959 down_write(&_hash_lock);
960 hc = __find_device_hash_cell(param);
961
962 if (!hc) {
963 DMDEBUG_LIMIT("device doesn't appear to be in the dev hash table.");
964 up_write(&_hash_lock);
965 return -ENXIO;
966 }
967
968 md = hc->md;
969
970 /*
971 * Ensure the device is not open and nothing further can open it.
972 */
973 r = dm_lock_for_deletion(md, !!(param->flags & DM_DEFERRED_REMOVE), false);
974 if (r) {
975 if (r == -EBUSY && param->flags & DM_DEFERRED_REMOVE) {
976 up_write(&_hash_lock);
977 dm_put(md);
978 return 0;
979 }
980 DMDEBUG_LIMIT("unable to remove open device %s", hc->name);
981 up_write(&_hash_lock);
982 dm_put(md);
983 return r;
984 }
985
986 t = __hash_remove(hc);
987 up_write(&_hash_lock);
988
989 if (t) {
990 dm_sync_table(md);
991 dm_table_destroy(t);
992 }
993
994 param->flags &= ~DM_DEFERRED_REMOVE;
995
996 dm_ima_measure_on_device_remove(md, false);
997
998 if (!dm_kobject_uevent(md, KOBJ_REMOVE, param->event_nr))
999 param->flags |= DM_UEVENT_GENERATED_FLAG;
1000
1001 dm_put(md);
1002 dm_destroy(md);
1003 return 0;
1004}
1005
1006/*
1007 * Check a string doesn't overrun the chunk of
1008 * memory we copied from userland.
1009 */
1010static int invalid_str(char *str, void *end)
1011{
1012 while ((void *) str < end)
1013 if (!*str++)
1014 return 0;
1015
1016 return -EINVAL;
1017}
1018
1019static int dev_rename(struct file *filp, struct dm_ioctl *param, size_t param_size)
1020{
1021 int r;
1022 char *new_data = (char *) param + param->data_start;
1023 struct mapped_device *md;
1024 unsigned change_uuid = (param->flags & DM_UUID_FLAG) ? 1 : 0;
1025
1026 if (new_data < param->data ||
1027 invalid_str(new_data, (void *) param + param_size) || !*new_data ||
1028 strlen(new_data) > (change_uuid ? DM_UUID_LEN - 1 : DM_NAME_LEN - 1)) {
1029 DMERR("Invalid new mapped device name or uuid string supplied.");
1030 return -EINVAL;
1031 }
1032
1033 if (!change_uuid) {
1034 r = check_name(new_data);
1035 if (r)
1036 return r;
1037 }
1038
1039 md = dm_hash_rename(param, new_data);
1040 if (IS_ERR(md))
1041 return PTR_ERR(md);
1042
1043 __dev_status(md, param);
1044 dm_put(md);
1045
1046 return 0;
1047}
1048
1049static int dev_set_geometry(struct file *filp, struct dm_ioctl *param, size_t param_size)
1050{
1051 int r = -EINVAL, x;
1052 struct mapped_device *md;
1053 struct hd_geometry geometry;
1054 unsigned long indata[4];
1055 char *geostr = (char *) param + param->data_start;
1056 char dummy;
1057
1058 md = find_device(param);
1059 if (!md)
1060 return -ENXIO;
1061
1062 if (geostr < param->data ||
1063 invalid_str(geostr, (void *) param + param_size)) {
1064 DMERR("Invalid geometry supplied.");
1065 goto out;
1066 }
1067
1068 x = sscanf(geostr, "%lu %lu %lu %lu%c", indata,
1069 indata + 1, indata + 2, indata + 3, &dummy);
1070
1071 if (x != 4) {
1072 DMERR("Unable to interpret geometry settings.");
1073 goto out;
1074 }
1075
1076 if (indata[0] > 65535 || indata[1] > 255 ||
1077 indata[2] > 255 || indata[3] > ULONG_MAX) {
1078 DMERR("Geometry exceeds range limits.");
1079 goto out;
1080 }
1081
1082 geometry.cylinders = indata[0];
1083 geometry.heads = indata[1];
1084 geometry.sectors = indata[2];
1085 geometry.start = indata[3];
1086
1087 r = dm_set_geometry(md, &geometry);
1088
1089 param->data_size = 0;
1090
1091out:
1092 dm_put(md);
1093 return r;
1094}
1095
1096static int do_suspend(struct dm_ioctl *param)
1097{
1098 int r = 0;
1099 unsigned suspend_flags = DM_SUSPEND_LOCKFS_FLAG;
1100 struct mapped_device *md;
1101
1102 md = find_device(param);
1103 if (!md)
1104 return -ENXIO;
1105
1106 if (param->flags & DM_SKIP_LOCKFS_FLAG)
1107 suspend_flags &= ~DM_SUSPEND_LOCKFS_FLAG;
1108 if (param->flags & DM_NOFLUSH_FLAG)
1109 suspend_flags |= DM_SUSPEND_NOFLUSH_FLAG;
1110
1111 if (!dm_suspended_md(md)) {
1112 r = dm_suspend(md, suspend_flags);
1113 if (r)
1114 goto out;
1115 }
1116
1117 __dev_status(md, param);
1118
1119out:
1120 dm_put(md);
1121
1122 return r;
1123}
1124
1125static int do_resume(struct dm_ioctl *param)
1126{
1127 int r = 0;
1128 unsigned suspend_flags = DM_SUSPEND_LOCKFS_FLAG;
1129 struct hash_cell *hc;
1130 struct mapped_device *md;
1131 struct dm_table *new_map, *old_map = NULL;
1132
1133 down_write(&_hash_lock);
1134
1135 hc = __find_device_hash_cell(param);
1136 if (!hc) {
1137 DMDEBUG_LIMIT("device doesn't appear to be in the dev hash table.");
1138 up_write(&_hash_lock);
1139 return -ENXIO;
1140 }
1141
1142 md = hc->md;
1143
1144 new_map = hc->new_map;
1145 hc->new_map = NULL;
1146 param->flags &= ~DM_INACTIVE_PRESENT_FLAG;
1147
1148 up_write(&_hash_lock);
1149
1150 /* Do we need to load a new map ? */
1151 if (new_map) {
1152 /* Suspend if it isn't already suspended */
1153 if (param->flags & DM_SKIP_LOCKFS_FLAG)
1154 suspend_flags &= ~DM_SUSPEND_LOCKFS_FLAG;
1155 if (param->flags & DM_NOFLUSH_FLAG)
1156 suspend_flags |= DM_SUSPEND_NOFLUSH_FLAG;
1157 if (!dm_suspended_md(md))
1158 dm_suspend(md, suspend_flags);
1159
1160 old_map = dm_swap_table(md, new_map);
1161 if (IS_ERR(old_map)) {
1162 dm_sync_table(md);
1163 dm_table_destroy(new_map);
1164 dm_put(md);
1165 return PTR_ERR(old_map);
1166 }
1167
1168 if (dm_table_get_mode(new_map) & FMODE_WRITE)
1169 set_disk_ro(dm_disk(md), 0);
1170 else
1171 set_disk_ro(dm_disk(md), 1);
1172 }
1173
1174 if (dm_suspended_md(md)) {
1175 r = dm_resume(md);
1176 if (!r) {
1177 dm_ima_measure_on_device_resume(md, new_map ? true : false);
1178
1179 if (!dm_kobject_uevent(md, KOBJ_CHANGE, param->event_nr))
1180 param->flags |= DM_UEVENT_GENERATED_FLAG;
1181 }
1182 }
1183
1184 /*
1185 * Since dm_swap_table synchronizes RCU, nobody should be in
1186 * read-side critical section already.
1187 */
1188 if (old_map)
1189 dm_table_destroy(old_map);
1190
1191 if (!r)
1192 __dev_status(md, param);
1193
1194 dm_put(md);
1195 return r;
1196}
1197
1198/*
1199 * Set or unset the suspension state of a device.
1200 * If the device already is in the requested state we just return its status.
1201 */
1202static int dev_suspend(struct file *filp, struct dm_ioctl *param, size_t param_size)
1203{
1204 if (param->flags & DM_SUSPEND_FLAG)
1205 return do_suspend(param);
1206
1207 return do_resume(param);
1208}
1209
1210/*
1211 * Copies device info back to user space, used by
1212 * the create and info ioctls.
1213 */
1214static int dev_status(struct file *filp, struct dm_ioctl *param, size_t param_size)
1215{
1216 struct mapped_device *md;
1217
1218 md = find_device(param);
1219 if (!md)
1220 return -ENXIO;
1221
1222 __dev_status(md, param);
1223 dm_put(md);
1224
1225 return 0;
1226}
1227
1228/*
1229 * Build up the status struct for each target
1230 */
1231static void retrieve_status(struct dm_table *table,
1232 struct dm_ioctl *param, size_t param_size)
1233{
1234 unsigned int i, num_targets;
1235 struct dm_target_spec *spec;
1236 char *outbuf, *outptr;
1237 status_type_t type;
1238 size_t remaining, len, used = 0;
1239 unsigned status_flags = 0;
1240
1241 outptr = outbuf = get_result_buffer(param, param_size, &len);
1242
1243 if (param->flags & DM_STATUS_TABLE_FLAG)
1244 type = STATUSTYPE_TABLE;
1245 else if (param->flags & DM_IMA_MEASUREMENT_FLAG)
1246 type = STATUSTYPE_IMA;
1247 else
1248 type = STATUSTYPE_INFO;
1249
1250 /* Get all the target info */
1251 num_targets = table->num_targets;
1252 for (i = 0; i < num_targets; i++) {
1253 struct dm_target *ti = dm_table_get_target(table, i);
1254 size_t l;
1255
1256 remaining = len - (outptr - outbuf);
1257 if (remaining <= sizeof(struct dm_target_spec)) {
1258 param->flags |= DM_BUFFER_FULL_FLAG;
1259 break;
1260 }
1261
1262 spec = (struct dm_target_spec *) outptr;
1263
1264 spec->status = 0;
1265 spec->sector_start = ti->begin;
1266 spec->length = ti->len;
1267 strncpy(spec->target_type, ti->type->name,
1268 sizeof(spec->target_type) - 1);
1269
1270 outptr += sizeof(struct dm_target_spec);
1271 remaining = len - (outptr - outbuf);
1272 if (remaining <= 0) {
1273 param->flags |= DM_BUFFER_FULL_FLAG;
1274 break;
1275 }
1276
1277 /* Get the status/table string from the target driver */
1278 if (ti->type->status) {
1279 if (param->flags & DM_NOFLUSH_FLAG)
1280 status_flags |= DM_STATUS_NOFLUSH_FLAG;
1281 ti->type->status(ti, type, status_flags, outptr, remaining);
1282 } else
1283 outptr[0] = '\0';
1284
1285 l = strlen(outptr) + 1;
1286 if (l == remaining) {
1287 param->flags |= DM_BUFFER_FULL_FLAG;
1288 break;
1289 }
1290
1291 outptr += l;
1292 used = param->data_start + (outptr - outbuf);
1293
1294 outptr = align_ptr(outptr);
1295 spec->next = outptr - outbuf;
1296 }
1297
1298 if (used)
1299 param->data_size = used;
1300
1301 param->target_count = num_targets;
1302}
1303
1304/*
1305 * Wait for a device to report an event
1306 */
1307static int dev_wait(struct file *filp, struct dm_ioctl *param, size_t param_size)
1308{
1309 int r = 0;
1310 struct mapped_device *md;
1311 struct dm_table *table;
1312 int srcu_idx;
1313
1314 md = find_device(param);
1315 if (!md)
1316 return -ENXIO;
1317
1318 /*
1319 * Wait for a notification event
1320 */
1321 if (dm_wait_event(md, param->event_nr)) {
1322 r = -ERESTARTSYS;
1323 goto out;
1324 }
1325
1326 /*
1327 * The userland program is going to want to know what
1328 * changed to trigger the event, so we may as well tell
1329 * him and save an ioctl.
1330 */
1331 __dev_status(md, param);
1332
1333 table = dm_get_live_or_inactive_table(md, param, &srcu_idx);
1334 if (table)
1335 retrieve_status(table, param, param_size);
1336 dm_put_live_table(md, srcu_idx);
1337
1338out:
1339 dm_put(md);
1340
1341 return r;
1342}
1343
1344/*
1345 * Remember the global event number and make it possible to poll
1346 * for further events.
1347 */
1348static int dev_arm_poll(struct file *filp, struct dm_ioctl *param, size_t param_size)
1349{
1350 struct dm_file *priv = filp->private_data;
1351
1352 priv->global_event_nr = atomic_read(&dm_global_event_nr);
1353
1354 return 0;
1355}
1356
1357static inline fmode_t get_mode(struct dm_ioctl *param)
1358{
1359 fmode_t mode = FMODE_READ | FMODE_WRITE;
1360
1361 if (param->flags & DM_READONLY_FLAG)
1362 mode = FMODE_READ;
1363
1364 return mode;
1365}
1366
1367static int next_target(struct dm_target_spec *last, uint32_t next, void *end,
1368 struct dm_target_spec **spec, char **target_params)
1369{
1370 *spec = (struct dm_target_spec *) ((unsigned char *) last + next);
1371 *target_params = (char *) (*spec + 1);
1372
1373 if (*spec < (last + 1))
1374 return -EINVAL;
1375
1376 return invalid_str(*target_params, end);
1377}
1378
1379static int populate_table(struct dm_table *table,
1380 struct dm_ioctl *param, size_t param_size)
1381{
1382 int r;
1383 unsigned int i = 0;
1384 struct dm_target_spec *spec = (struct dm_target_spec *) param;
1385 uint32_t next = param->data_start;
1386 void *end = (void *) param + param_size;
1387 char *target_params;
1388
1389 if (!param->target_count) {
1390 DMERR("populate_table: no targets specified");
1391 return -EINVAL;
1392 }
1393
1394 for (i = 0; i < param->target_count; i++) {
1395
1396 r = next_target(spec, next, end, &spec, &target_params);
1397 if (r) {
1398 DMERR("unable to find target");
1399 return r;
1400 }
1401
1402 r = dm_table_add_target(table, spec->target_type,
1403 (sector_t) spec->sector_start,
1404 (sector_t) spec->length,
1405 target_params);
1406 if (r) {
1407 DMERR("error adding target to table");
1408 return r;
1409 }
1410
1411 next = spec->next;
1412 }
1413
1414 return dm_table_complete(table);
1415}
1416
1417static bool is_valid_type(enum dm_queue_mode cur, enum dm_queue_mode new)
1418{
1419 if (cur == new ||
1420 (cur == DM_TYPE_BIO_BASED && new == DM_TYPE_DAX_BIO_BASED))
1421 return true;
1422
1423 return false;
1424}
1425
1426static int table_load(struct file *filp, struct dm_ioctl *param, size_t param_size)
1427{
1428 int r;
1429 struct hash_cell *hc;
1430 struct dm_table *t, *old_map = NULL;
1431 struct mapped_device *md;
1432 struct target_type *immutable_target_type;
1433
1434 md = find_device(param);
1435 if (!md)
1436 return -ENXIO;
1437
1438 r = dm_table_create(&t, get_mode(param), param->target_count, md);
1439 if (r)
1440 goto err;
1441
1442 /* Protect md->type and md->queue against concurrent table loads. */
1443 dm_lock_md_type(md);
1444 r = populate_table(t, param, param_size);
1445 if (r)
1446 goto err_unlock_md_type;
1447
1448 dm_ima_measure_on_table_load(t, STATUSTYPE_IMA);
1449
1450 immutable_target_type = dm_get_immutable_target_type(md);
1451 if (immutable_target_type &&
1452 (immutable_target_type != dm_table_get_immutable_target_type(t)) &&
1453 !dm_table_get_wildcard_target(t)) {
1454 DMERR("can't replace immutable target type %s",
1455 immutable_target_type->name);
1456 r = -EINVAL;
1457 goto err_unlock_md_type;
1458 }
1459
1460 if (dm_get_md_type(md) == DM_TYPE_NONE) {
1461 /* setup md->queue to reflect md's type (may block) */
1462 r = dm_setup_md_queue(md, t);
1463 if (r) {
1464 DMERR("unable to set up device queue for new table.");
1465 goto err_unlock_md_type;
1466 }
1467 } else if (!is_valid_type(dm_get_md_type(md), dm_table_get_type(t))) {
1468 DMERR("can't change device type (old=%u vs new=%u) after initial table load.",
1469 dm_get_md_type(md), dm_table_get_type(t));
1470 r = -EINVAL;
1471 goto err_unlock_md_type;
1472 }
1473
1474 dm_unlock_md_type(md);
1475
1476 /* stage inactive table */
1477 down_write(&_hash_lock);
1478 hc = dm_get_mdptr(md);
1479 if (!hc || hc->md != md) {
1480 DMERR("device has been removed from the dev hash table.");
1481 up_write(&_hash_lock);
1482 r = -ENXIO;
1483 goto err_destroy_table;
1484 }
1485
1486 if (hc->new_map)
1487 old_map = hc->new_map;
1488 hc->new_map = t;
1489 up_write(&_hash_lock);
1490
1491 param->flags |= DM_INACTIVE_PRESENT_FLAG;
1492 __dev_status(md, param);
1493
1494 if (old_map) {
1495 dm_sync_table(md);
1496 dm_table_destroy(old_map);
1497 }
1498
1499 dm_put(md);
1500
1501 return 0;
1502
1503err_unlock_md_type:
1504 dm_unlock_md_type(md);
1505err_destroy_table:
1506 dm_table_destroy(t);
1507err:
1508 dm_put(md);
1509
1510 return r;
1511}
1512
1513static int table_clear(struct file *filp, struct dm_ioctl *param, size_t param_size)
1514{
1515 struct hash_cell *hc;
1516 struct mapped_device *md;
1517 struct dm_table *old_map = NULL;
1518 bool has_new_map = false;
1519
1520 down_write(&_hash_lock);
1521
1522 hc = __find_device_hash_cell(param);
1523 if (!hc) {
1524 DMDEBUG_LIMIT("device doesn't appear to be in the dev hash table.");
1525 up_write(&_hash_lock);
1526 return -ENXIO;
1527 }
1528
1529 if (hc->new_map) {
1530 old_map = hc->new_map;
1531 hc->new_map = NULL;
1532 has_new_map = true;
1533 }
1534
1535 param->flags &= ~DM_INACTIVE_PRESENT_FLAG;
1536
1537 __dev_status(hc->md, param);
1538 md = hc->md;
1539 up_write(&_hash_lock);
1540 if (old_map) {
1541 dm_sync_table(md);
1542 dm_table_destroy(old_map);
1543 }
1544 dm_ima_measure_on_table_clear(md, has_new_map);
1545 dm_put(md);
1546
1547 return 0;
1548}
1549
1550/*
1551 * Retrieves a list of devices used by a particular dm device.
1552 */
1553static void retrieve_deps(struct dm_table *table,
1554 struct dm_ioctl *param, size_t param_size)
1555{
1556 unsigned int count = 0;
1557 struct list_head *tmp;
1558 size_t len, needed;
1559 struct dm_dev_internal *dd;
1560 struct dm_target_deps *deps;
1561
1562 deps = get_result_buffer(param, param_size, &len);
1563
1564 /*
1565 * Count the devices.
1566 */
1567 list_for_each (tmp, dm_table_get_devices(table))
1568 count++;
1569
1570 /*
1571 * Check we have enough space.
1572 */
1573 needed = struct_size(deps, dev, count);
1574 if (len < needed) {
1575 param->flags |= DM_BUFFER_FULL_FLAG;
1576 return;
1577 }
1578
1579 /*
1580 * Fill in the devices.
1581 */
1582 deps->count = count;
1583 count = 0;
1584 list_for_each_entry (dd, dm_table_get_devices(table), list)
1585 deps->dev[count++] = huge_encode_dev(dd->dm_dev->bdev->bd_dev);
1586
1587 param->data_size = param->data_start + needed;
1588}
1589
1590static int table_deps(struct file *filp, struct dm_ioctl *param, size_t param_size)
1591{
1592 struct mapped_device *md;
1593 struct dm_table *table;
1594 int srcu_idx;
1595
1596 md = find_device(param);
1597 if (!md)
1598 return -ENXIO;
1599
1600 __dev_status(md, param);
1601
1602 table = dm_get_live_or_inactive_table(md, param, &srcu_idx);
1603 if (table)
1604 retrieve_deps(table, param, param_size);
1605 dm_put_live_table(md, srcu_idx);
1606
1607 dm_put(md);
1608
1609 return 0;
1610}
1611
1612/*
1613 * Return the status of a device as a text string for each
1614 * target.
1615 */
1616static int table_status(struct file *filp, struct dm_ioctl *param, size_t param_size)
1617{
1618 struct mapped_device *md;
1619 struct dm_table *table;
1620 int srcu_idx;
1621
1622 md = find_device(param);
1623 if (!md)
1624 return -ENXIO;
1625
1626 __dev_status(md, param);
1627
1628 table = dm_get_live_or_inactive_table(md, param, &srcu_idx);
1629 if (table)
1630 retrieve_status(table, param, param_size);
1631 dm_put_live_table(md, srcu_idx);
1632
1633 dm_put(md);
1634
1635 return 0;
1636}
1637
1638/*
1639 * Process device-mapper dependent messages. Messages prefixed with '@'
1640 * are processed by the DM core. All others are delivered to the target.
1641 * Returns a number <= 1 if message was processed by device mapper.
1642 * Returns 2 if message should be delivered to the target.
1643 */
1644static int message_for_md(struct mapped_device *md, unsigned argc, char **argv,
1645 char *result, unsigned maxlen)
1646{
1647 int r;
1648
1649 if (**argv != '@')
1650 return 2; /* no '@' prefix, deliver to target */
1651
1652 if (!strcasecmp(argv[0], "@cancel_deferred_remove")) {
1653 if (argc != 1) {
1654 DMERR("Invalid arguments for @cancel_deferred_remove");
1655 return -EINVAL;
1656 }
1657 return dm_cancel_deferred_remove(md);
1658 }
1659
1660 r = dm_stats_message(md, argc, argv, result, maxlen);
1661 if (r < 2)
1662 return r;
1663
1664 DMERR("Unsupported message sent to DM core: %s", argv[0]);
1665 return -EINVAL;
1666}
1667
1668/*
1669 * Pass a message to the target that's at the supplied device offset.
1670 */
1671static int target_message(struct file *filp, struct dm_ioctl *param, size_t param_size)
1672{
1673 int r, argc;
1674 char **argv;
1675 struct mapped_device *md;
1676 struct dm_table *table;
1677 struct dm_target *ti;
1678 struct dm_target_msg *tmsg = (void *) param + param->data_start;
1679 size_t maxlen;
1680 char *result = get_result_buffer(param, param_size, &maxlen);
1681 int srcu_idx;
1682
1683 md = find_device(param);
1684 if (!md)
1685 return -ENXIO;
1686
1687 if (tmsg < (struct dm_target_msg *) param->data ||
1688 invalid_str(tmsg->message, (void *) param + param_size)) {
1689 DMERR("Invalid target message parameters.");
1690 r = -EINVAL;
1691 goto out;
1692 }
1693
1694 r = dm_split_args(&argc, &argv, tmsg->message);
1695 if (r) {
1696 DMERR("Failed to split target message parameters");
1697 goto out;
1698 }
1699
1700 if (!argc) {
1701 DMERR("Empty message received.");
1702 r = -EINVAL;
1703 goto out_argv;
1704 }
1705
1706 r = message_for_md(md, argc, argv, result, maxlen);
1707 if (r <= 1)
1708 goto out_argv;
1709
1710 table = dm_get_live_table(md, &srcu_idx);
1711 if (!table)
1712 goto out_table;
1713
1714 if (dm_deleting_md(md)) {
1715 r = -ENXIO;
1716 goto out_table;
1717 }
1718
1719 ti = dm_table_find_target(table, tmsg->sector);
1720 if (!ti) {
1721 DMERR("Target message sector outside device.");
1722 r = -EINVAL;
1723 } else if (ti->type->message)
1724 r = ti->type->message(ti, argc, argv, result, maxlen);
1725 else {
1726 DMERR("Target type does not support messages");
1727 r = -EINVAL;
1728 }
1729
1730 out_table:
1731 dm_put_live_table(md, srcu_idx);
1732 out_argv:
1733 kfree(argv);
1734 out:
1735 if (r >= 0)
1736 __dev_status(md, param);
1737
1738 if (r == 1) {
1739 param->flags |= DM_DATA_OUT_FLAG;
1740 if (dm_message_test_buffer_overflow(result, maxlen))
1741 param->flags |= DM_BUFFER_FULL_FLAG;
1742 else
1743 param->data_size = param->data_start + strlen(result) + 1;
1744 r = 0;
1745 }
1746
1747 dm_put(md);
1748 return r;
1749}
1750
1751/*
1752 * The ioctl parameter block consists of two parts, a dm_ioctl struct
1753 * followed by a data buffer. This flag is set if the second part,
1754 * which has a variable size, is not used by the function processing
1755 * the ioctl.
1756 */
1757#define IOCTL_FLAGS_NO_PARAMS 1
1758#define IOCTL_FLAGS_ISSUE_GLOBAL_EVENT 2
1759
1760/*-----------------------------------------------------------------
1761 * Implementation of open/close/ioctl on the special char
1762 * device.
1763 *---------------------------------------------------------------*/
1764static ioctl_fn lookup_ioctl(unsigned int cmd, int *ioctl_flags)
1765{
1766 static const struct {
1767 int cmd;
1768 int flags;
1769 ioctl_fn fn;
1770 } _ioctls[] = {
1771 {DM_VERSION_CMD, 0, NULL}, /* version is dealt with elsewhere */
1772 {DM_REMOVE_ALL_CMD, IOCTL_FLAGS_NO_PARAMS | IOCTL_FLAGS_ISSUE_GLOBAL_EVENT, remove_all},
1773 {DM_LIST_DEVICES_CMD, 0, list_devices},
1774
1775 {DM_DEV_CREATE_CMD, IOCTL_FLAGS_NO_PARAMS | IOCTL_FLAGS_ISSUE_GLOBAL_EVENT, dev_create},
1776 {DM_DEV_REMOVE_CMD, IOCTL_FLAGS_NO_PARAMS | IOCTL_FLAGS_ISSUE_GLOBAL_EVENT, dev_remove},
1777 {DM_DEV_RENAME_CMD, IOCTL_FLAGS_ISSUE_GLOBAL_EVENT, dev_rename},
1778 {DM_DEV_SUSPEND_CMD, IOCTL_FLAGS_NO_PARAMS, dev_suspend},
1779 {DM_DEV_STATUS_CMD, IOCTL_FLAGS_NO_PARAMS, dev_status},
1780 {DM_DEV_WAIT_CMD, 0, dev_wait},
1781
1782 {DM_TABLE_LOAD_CMD, 0, table_load},
1783 {DM_TABLE_CLEAR_CMD, IOCTL_FLAGS_NO_PARAMS, table_clear},
1784 {DM_TABLE_DEPS_CMD, 0, table_deps},
1785 {DM_TABLE_STATUS_CMD, 0, table_status},
1786
1787 {DM_LIST_VERSIONS_CMD, 0, list_versions},
1788
1789 {DM_TARGET_MSG_CMD, 0, target_message},
1790 {DM_DEV_SET_GEOMETRY_CMD, 0, dev_set_geometry},
1791 {DM_DEV_ARM_POLL_CMD, IOCTL_FLAGS_NO_PARAMS, dev_arm_poll},
1792 {DM_GET_TARGET_VERSION_CMD, 0, get_target_version},
1793 };
1794
1795 if (unlikely(cmd >= ARRAY_SIZE(_ioctls)))
1796 return NULL;
1797
1798 cmd = array_index_nospec(cmd, ARRAY_SIZE(_ioctls));
1799 *ioctl_flags = _ioctls[cmd].flags;
1800 return _ioctls[cmd].fn;
1801}
1802
1803/*
1804 * As well as checking the version compatibility this always
1805 * copies the kernel interface version out.
1806 */
1807static int check_version(unsigned int cmd, struct dm_ioctl __user *user)
1808{
1809 uint32_t version[3];
1810 int r = 0;
1811
1812 if (copy_from_user(version, user->version, sizeof(version)))
1813 return -EFAULT;
1814
1815 if ((DM_VERSION_MAJOR != version[0]) ||
1816 (DM_VERSION_MINOR < version[1])) {
1817 DMERR("ioctl interface mismatch: "
1818 "kernel(%u.%u.%u), user(%u.%u.%u), cmd(%d)",
1819 DM_VERSION_MAJOR, DM_VERSION_MINOR,
1820 DM_VERSION_PATCHLEVEL,
1821 version[0], version[1], version[2], cmd);
1822 r = -EINVAL;
1823 }
1824
1825 /*
1826 * Fill in the kernel version.
1827 */
1828 version[0] = DM_VERSION_MAJOR;
1829 version[1] = DM_VERSION_MINOR;
1830 version[2] = DM_VERSION_PATCHLEVEL;
1831 if (copy_to_user(user->version, version, sizeof(version)))
1832 return -EFAULT;
1833
1834 return r;
1835}
1836
1837#define DM_PARAMS_MALLOC 0x0001 /* Params allocated with kvmalloc() */
1838#define DM_WIPE_BUFFER 0x0010 /* Wipe input buffer before returning from ioctl */
1839
1840static void free_params(struct dm_ioctl *param, size_t param_size, int param_flags)
1841{
1842 if (param_flags & DM_WIPE_BUFFER)
1843 memset(param, 0, param_size);
1844
1845 if (param_flags & DM_PARAMS_MALLOC)
1846 kvfree(param);
1847}
1848
1849static int copy_params(struct dm_ioctl __user *user, struct dm_ioctl *param_kernel,
1850 int ioctl_flags, struct dm_ioctl **param, int *param_flags)
1851{
1852 struct dm_ioctl *dmi;
1853 int secure_data;
1854 const size_t minimum_data_size = offsetof(struct dm_ioctl, data);
1855 unsigned noio_flag;
1856
1857 if (copy_from_user(param_kernel, user, minimum_data_size))
1858 return -EFAULT;
1859
1860 if (param_kernel->data_size < minimum_data_size) {
1861 DMERR("Invalid data size in the ioctl structure: %u",
1862 param_kernel->data_size);
1863 return -EINVAL;
1864 }
1865
1866 secure_data = param_kernel->flags & DM_SECURE_DATA_FLAG;
1867
1868 *param_flags = secure_data ? DM_WIPE_BUFFER : 0;
1869
1870 if (ioctl_flags & IOCTL_FLAGS_NO_PARAMS) {
1871 dmi = param_kernel;
1872 dmi->data_size = minimum_data_size;
1873 goto data_copied;
1874 }
1875
1876 /*
1877 * Use __GFP_HIGH to avoid low memory issues when a device is
1878 * suspended and the ioctl is needed to resume it.
1879 * Use kmalloc() rather than vmalloc() when we can.
1880 */
1881 dmi = NULL;
1882 noio_flag = memalloc_noio_save();
1883 dmi = kvmalloc(param_kernel->data_size, GFP_KERNEL | __GFP_HIGH);
1884 memalloc_noio_restore(noio_flag);
1885
1886 if (!dmi) {
1887 if (secure_data && clear_user(user, param_kernel->data_size))
1888 return -EFAULT;
1889 return -ENOMEM;
1890 }
1891
1892 *param_flags |= DM_PARAMS_MALLOC;
1893
1894 /* Copy from param_kernel (which was already copied from user) */
1895 memcpy(dmi, param_kernel, minimum_data_size);
1896
1897 if (copy_from_user(&dmi->data, (char __user *)user + minimum_data_size,
1898 param_kernel->data_size - minimum_data_size))
1899 goto bad;
1900data_copied:
1901 /* Wipe the user buffer so we do not return it to userspace */
1902 if (secure_data && clear_user(user, param_kernel->data_size))
1903 goto bad;
1904
1905 *param = dmi;
1906 return 0;
1907
1908bad:
1909 free_params(dmi, param_kernel->data_size, *param_flags);
1910
1911 return -EFAULT;
1912}
1913
1914static int validate_params(uint cmd, struct dm_ioctl *param)
1915{
1916 /* Always clear this flag */
1917 param->flags &= ~DM_BUFFER_FULL_FLAG;
1918 param->flags &= ~DM_UEVENT_GENERATED_FLAG;
1919 param->flags &= ~DM_SECURE_DATA_FLAG;
1920 param->flags &= ~DM_DATA_OUT_FLAG;
1921
1922 /* Ignores parameters */
1923 if (cmd == DM_REMOVE_ALL_CMD ||
1924 cmd == DM_LIST_DEVICES_CMD ||
1925 cmd == DM_LIST_VERSIONS_CMD)
1926 return 0;
1927
1928 if (cmd == DM_DEV_CREATE_CMD) {
1929 if (!*param->name) {
1930 DMERR("name not supplied when creating device");
1931 return -EINVAL;
1932 }
1933 } else if (*param->uuid && *param->name) {
1934 DMERR("only supply one of name or uuid, cmd(%u)", cmd);
1935 return -EINVAL;
1936 }
1937
1938 /* Ensure strings are terminated */
1939 param->name[DM_NAME_LEN - 1] = '\0';
1940 param->uuid[DM_UUID_LEN - 1] = '\0';
1941
1942 return 0;
1943}
1944
1945static int ctl_ioctl(struct file *file, uint command, struct dm_ioctl __user *user)
1946{
1947 int r = 0;
1948 int ioctl_flags;
1949 int param_flags;
1950 unsigned int cmd;
1951 struct dm_ioctl *param;
1952 ioctl_fn fn = NULL;
1953 size_t input_param_size;
1954 struct dm_ioctl param_kernel;
1955
1956 /* only root can play with this */
1957 if (!capable(CAP_SYS_ADMIN))
1958 return -EACCES;
1959
1960 if (_IOC_TYPE(command) != DM_IOCTL)
1961 return -ENOTTY;
1962
1963 cmd = _IOC_NR(command);
1964
1965 /*
1966 * Check the interface version passed in. This also
1967 * writes out the kernel's interface version.
1968 */
1969 r = check_version(cmd, user);
1970 if (r)
1971 return r;
1972
1973 /*
1974 * Nothing more to do for the version command.
1975 */
1976 if (cmd == DM_VERSION_CMD)
1977 return 0;
1978
1979 fn = lookup_ioctl(cmd, &ioctl_flags);
1980 if (!fn) {
1981 DMERR("dm_ctl_ioctl: unknown command 0x%x", command);
1982 return -ENOTTY;
1983 }
1984
1985 /*
1986 * Copy the parameters into kernel space.
1987 */
1988 r = copy_params(user, ¶m_kernel, ioctl_flags, ¶m, ¶m_flags);
1989
1990 if (r)
1991 return r;
1992
1993 input_param_size = param->data_size;
1994 r = validate_params(cmd, param);
1995 if (r)
1996 goto out;
1997
1998 param->data_size = offsetof(struct dm_ioctl, data);
1999 r = fn(file, param, input_param_size);
2000
2001 if (unlikely(param->flags & DM_BUFFER_FULL_FLAG) &&
2002 unlikely(ioctl_flags & IOCTL_FLAGS_NO_PARAMS))
2003 DMERR("ioctl %d tried to output some data but has IOCTL_FLAGS_NO_PARAMS set", cmd);
2004
2005 if (!r && ioctl_flags & IOCTL_FLAGS_ISSUE_GLOBAL_EVENT)
2006 dm_issue_global_event();
2007
2008 /*
2009 * Copy the results back to userland.
2010 */
2011 if (!r && copy_to_user(user, param, param->data_size))
2012 r = -EFAULT;
2013
2014out:
2015 free_params(param, input_param_size, param_flags);
2016 return r;
2017}
2018
2019static long dm_ctl_ioctl(struct file *file, uint command, ulong u)
2020{
2021 return (long)ctl_ioctl(file, command, (struct dm_ioctl __user *)u);
2022}
2023
2024#ifdef CONFIG_COMPAT
2025static long dm_compat_ctl_ioctl(struct file *file, uint command, ulong u)
2026{
2027 return (long)dm_ctl_ioctl(file, command, (ulong) compat_ptr(u));
2028}
2029#else
2030#define dm_compat_ctl_ioctl NULL
2031#endif
2032
2033static int dm_open(struct inode *inode, struct file *filp)
2034{
2035 int r;
2036 struct dm_file *priv;
2037
2038 r = nonseekable_open(inode, filp);
2039 if (unlikely(r))
2040 return r;
2041
2042 priv = filp->private_data = kmalloc(sizeof(struct dm_file), GFP_KERNEL);
2043 if (!priv)
2044 return -ENOMEM;
2045
2046 priv->global_event_nr = atomic_read(&dm_global_event_nr);
2047
2048 return 0;
2049}
2050
2051static int dm_release(struct inode *inode, struct file *filp)
2052{
2053 kfree(filp->private_data);
2054 return 0;
2055}
2056
2057static __poll_t dm_poll(struct file *filp, poll_table *wait)
2058{
2059 struct dm_file *priv = filp->private_data;
2060 __poll_t mask = 0;
2061
2062 poll_wait(filp, &dm_global_eventq, wait);
2063
2064 if ((int)(atomic_read(&dm_global_event_nr) - priv->global_event_nr) > 0)
2065 mask |= EPOLLIN;
2066
2067 return mask;
2068}
2069
2070static const struct file_operations _ctl_fops = {
2071 .open = dm_open,
2072 .release = dm_release,
2073 .poll = dm_poll,
2074 .unlocked_ioctl = dm_ctl_ioctl,
2075 .compat_ioctl = dm_compat_ctl_ioctl,
2076 .owner = THIS_MODULE,
2077 .llseek = noop_llseek,
2078};
2079
2080static struct miscdevice _dm_misc = {
2081 .minor = MAPPER_CTRL_MINOR,
2082 .name = DM_NAME,
2083 .nodename = DM_DIR "/" DM_CONTROL_NODE,
2084 .fops = &_ctl_fops
2085};
2086
2087MODULE_ALIAS_MISCDEV(MAPPER_CTRL_MINOR);
2088MODULE_ALIAS("devname:" DM_DIR "/" DM_CONTROL_NODE);
2089
2090/*
2091 * Create misc character device and link to DM_DIR/control.
2092 */
2093int __init dm_interface_init(void)
2094{
2095 int r;
2096
2097 r = misc_register(&_dm_misc);
2098 if (r) {
2099 DMERR("misc_register failed for control device");
2100 return r;
2101 }
2102
2103 DMINFO("%d.%d.%d%s initialised: %s", DM_VERSION_MAJOR,
2104 DM_VERSION_MINOR, DM_VERSION_PATCHLEVEL, DM_VERSION_EXTRA,
2105 DM_DRIVER_EMAIL);
2106 return 0;
2107}
2108
2109void dm_interface_exit(void)
2110{
2111 misc_deregister(&_dm_misc);
2112 dm_hash_exit();
2113}
2114
2115/**
2116 * dm_copy_name_and_uuid - Copy mapped device name & uuid into supplied buffers
2117 * @md: Pointer to mapped_device
2118 * @name: Buffer (size DM_NAME_LEN) for name
2119 * @uuid: Buffer (size DM_UUID_LEN) for uuid or empty string if uuid not defined
2120 */
2121int dm_copy_name_and_uuid(struct mapped_device *md, char *name, char *uuid)
2122{
2123 int r = 0;
2124 struct hash_cell *hc;
2125
2126 if (!md)
2127 return -ENXIO;
2128
2129 mutex_lock(&dm_hash_cells_mutex);
2130 hc = dm_get_mdptr(md);
2131 if (!hc || hc->md != md) {
2132 r = -ENXIO;
2133 goto out;
2134 }
2135
2136 if (name)
2137 strcpy(name, hc->name);
2138 if (uuid)
2139 strcpy(uuid, hc->uuid ? : "");
2140
2141out:
2142 mutex_unlock(&dm_hash_cells_mutex);
2143
2144 return r;
2145}
2146EXPORT_SYMBOL_GPL(dm_copy_name_and_uuid);
2147
2148/**
2149 * dm_early_create - create a mapped device in early boot.
2150 *
2151 * @dmi: Contains main information of the device mapping to be created.
2152 * @spec_array: array of pointers to struct dm_target_spec. Describes the
2153 * mapping table of the device.
2154 * @target_params_array: array of strings with the parameters to a specific
2155 * target.
2156 *
2157 * Instead of having the struct dm_target_spec and the parameters for every
2158 * target embedded at the end of struct dm_ioctl (as performed in a normal
2159 * ioctl), pass them as arguments, so the caller doesn't need to serialize them.
2160 * The size of the spec_array and target_params_array is given by
2161 * @dmi->target_count.
2162 * This function is supposed to be called in early boot, so locking mechanisms
2163 * to protect against concurrent loads are not required.
2164 */
2165int __init dm_early_create(struct dm_ioctl *dmi,
2166 struct dm_target_spec **spec_array,
2167 char **target_params_array)
2168{
2169 int r, m = DM_ANY_MINOR;
2170 struct dm_table *t, *old_map;
2171 struct mapped_device *md;
2172 unsigned int i;
2173
2174 if (!dmi->target_count)
2175 return -EINVAL;
2176
2177 r = check_name(dmi->name);
2178 if (r)
2179 return r;
2180
2181 if (dmi->flags & DM_PERSISTENT_DEV_FLAG)
2182 m = MINOR(huge_decode_dev(dmi->dev));
2183
2184 /* alloc dm device */
2185 r = dm_create(m, &md);
2186 if (r)
2187 return r;
2188
2189 /* hash insert */
2190 r = dm_hash_insert(dmi->name, *dmi->uuid ? dmi->uuid : NULL, md);
2191 if (r)
2192 goto err_destroy_dm;
2193
2194 /* alloc table */
2195 r = dm_table_create(&t, get_mode(dmi), dmi->target_count, md);
2196 if (r)
2197 goto err_hash_remove;
2198
2199 /* add targets */
2200 for (i = 0; i < dmi->target_count; i++) {
2201 r = dm_table_add_target(t, spec_array[i]->target_type,
2202 (sector_t) spec_array[i]->sector_start,
2203 (sector_t) spec_array[i]->length,
2204 target_params_array[i]);
2205 if (r) {
2206 DMERR("error adding target to table");
2207 goto err_destroy_table;
2208 }
2209 }
2210
2211 /* finish table */
2212 r = dm_table_complete(t);
2213 if (r)
2214 goto err_destroy_table;
2215
2216 /* setup md->queue to reflect md's type (may block) */
2217 r = dm_setup_md_queue(md, t);
2218 if (r) {
2219 DMERR("unable to set up device queue for new table.");
2220 goto err_destroy_table;
2221 }
2222
2223 /* Set new map */
2224 dm_suspend(md, 0);
2225 old_map = dm_swap_table(md, t);
2226 if (IS_ERR(old_map)) {
2227 r = PTR_ERR(old_map);
2228 goto err_destroy_table;
2229 }
2230 set_disk_ro(dm_disk(md), !!(dmi->flags & DM_READONLY_FLAG));
2231
2232 /* resume device */
2233 r = dm_resume(md);
2234 if (r)
2235 goto err_destroy_table;
2236
2237 DMINFO("%s (%s) is ready", md->disk->disk_name, dmi->name);
2238 dm_put(md);
2239 return 0;
2240
2241err_destroy_table:
2242 dm_table_destroy(t);
2243err_hash_remove:
2244 (void) __hash_remove(__get_name_cell(dmi->name));
2245 /* release reference from __get_name_cell */
2246 dm_put(md);
2247err_destroy_dm:
2248 dm_put(md);
2249 dm_destroy(md);
2250 return r;
2251}
1/*
2 * Copyright (C) 2001, 2002 Sistina Software (UK) Limited.
3 * Copyright (C) 2004 - 2006 Red Hat, Inc. All rights reserved.
4 *
5 * This file is released under the GPL.
6 */
7
8#include "dm-core.h"
9
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>
20
21#include <linux/uaccess.h>
22
23#define DM_MSG_PREFIX "ioctl"
24#define DM_DRIVER_EMAIL "dm-devel@redhat.com"
25
26struct dm_file {
27 /*
28 * poll will wait until the global event number is greater than
29 * this value.
30 */
31 volatile unsigned global_event_nr;
32};
33
34/*-----------------------------------------------------------------
35 * The ioctl interface needs to be able to look up devices by
36 * name or uuid.
37 *---------------------------------------------------------------*/
38struct hash_cell {
39 struct list_head name_list;
40 struct list_head uuid_list;
41
42 char *name;
43 char *uuid;
44 struct mapped_device *md;
45 struct dm_table *new_map;
46};
47
48struct vers_iter {
49 size_t param_size;
50 struct dm_target_versions *vers, *old_vers;
51 char *end;
52 uint32_t flags;
53};
54
55
56#define NUM_BUCKETS 64
57#define MASK_BUCKETS (NUM_BUCKETS - 1)
58static struct list_head _name_buckets[NUM_BUCKETS];
59static struct list_head _uuid_buckets[NUM_BUCKETS];
60
61static void dm_hash_remove_all(bool keep_open_devices, bool mark_deferred, bool only_deferred);
62
63/*
64 * Guards access to both hash tables.
65 */
66static DECLARE_RWSEM(_hash_lock);
67
68/*
69 * Protects use of mdptr to obtain hash cell name and uuid from mapped device.
70 */
71static DEFINE_MUTEX(dm_hash_cells_mutex);
72
73static void init_buckets(struct list_head *buckets)
74{
75 unsigned int i;
76
77 for (i = 0; i < NUM_BUCKETS; i++)
78 INIT_LIST_HEAD(buckets + i);
79}
80
81static int dm_hash_init(void)
82{
83 init_buckets(_name_buckets);
84 init_buckets(_uuid_buckets);
85 return 0;
86}
87
88static void dm_hash_exit(void)
89{
90 dm_hash_remove_all(false, false, false);
91}
92
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 *---------------------------------------------------------------*/
98static unsigned int hash_str(const char *str)
99{
100 const unsigned int hash_mult = 2654435387U;
101 unsigned int h = 0;
102
103 while (*str)
104 h = (h + (unsigned int) *str++) * hash_mult;
105
106 return h & MASK_BUCKETS;
107}
108
109/*-----------------------------------------------------------------
110 * Code for looking up a device by name
111 *---------------------------------------------------------------*/
112static struct hash_cell *__get_name_cell(const char *str)
113{
114 struct hash_cell *hc;
115 unsigned int h = hash_str(str);
116
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;
121 }
122
123 return NULL;
124}
125
126static struct hash_cell *__get_uuid_cell(const char *str)
127{
128 struct hash_cell *hc;
129 unsigned int h = hash_str(str);
130
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;
135 }
136
137 return NULL;
138}
139
140static struct hash_cell *__get_dev_cell(uint64_t dev)
141{
142 struct mapped_device *md;
143 struct hash_cell *hc;
144
145 md = dm_get_md(huge_decode_dev(dev));
146 if (!md)
147 return NULL;
148
149 hc = dm_get_mdptr(md);
150 if (!hc) {
151 dm_put(md);
152 return NULL;
153 }
154
155 return hc;
156}
157
158/*-----------------------------------------------------------------
159 * Inserting, removing and renaming a device.
160 *---------------------------------------------------------------*/
161static struct hash_cell *alloc_cell(const char *name, const char *uuid,
162 struct mapped_device *md)
163{
164 struct hash_cell *hc;
165
166 hc = kmalloc(sizeof(*hc), GFP_KERNEL);
167 if (!hc)
168 return NULL;
169
170 hc->name = kstrdup(name, GFP_KERNEL);
171 if (!hc->name) {
172 kfree(hc);
173 return NULL;
174 }
175
176 if (!uuid)
177 hc->uuid = NULL;
178
179 else {
180 hc->uuid = kstrdup(uuid, GFP_KERNEL);
181 if (!hc->uuid) {
182 kfree(hc->name);
183 kfree(hc);
184 return NULL;
185 }
186 }
187
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;
193}
194
195static void free_cell(struct hash_cell *hc)
196{
197 if (hc) {
198 kfree(hc->name);
199 kfree(hc->uuid);
200 kfree(hc);
201 }
202}
203
204/*
205 * The kdev_t and uuid of a device can never change once it is
206 * initially inserted.
207 */
208static int dm_hash_insert(const char *name, const char *uuid, struct mapped_device *md)
209{
210 struct hash_cell *cell, *hc;
211
212 /*
213 * Allocate the new cells.
214 */
215 cell = alloc_cell(name, uuid, md);
216 if (!cell)
217 return -ENOMEM;
218
219 /*
220 * Insert the cell into both hash tables.
221 */
222 down_write(&_hash_lock);
223 hc = __get_name_cell(name);
224 if (hc) {
225 dm_put(hc->md);
226 goto bad;
227 }
228
229 list_add(&cell->name_list, _name_buckets + hash_str(name));
230
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;
237 }
238 list_add(&cell->uuid_list, _uuid_buckets + hash_str(uuid));
239 }
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);
245
246 return 0;
247
248 bad:
249 up_write(&_hash_lock);
250 free_cell(cell);
251 return -EBUSY;
252}
253
254static struct dm_table *__hash_remove(struct hash_cell *hc)
255{
256 struct dm_table *table;
257 int srcu_idx;
258
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);
265
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);
270
271 table = NULL;
272 if (hc->new_map)
273 table = hc->new_map;
274 dm_put(hc->md);
275 free_cell(hc);
276
277 return table;
278}
279
280static void dm_hash_remove_all(bool keep_open_devices, bool mark_deferred, bool only_deferred)
281{
282 int i, dev_skipped;
283 struct hash_cell *hc;
284 struct mapped_device *md;
285 struct dm_table *t;
286
287retry:
288 dev_skipped = 0;
289
290 down_write(&_hash_lock);
291
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);
296
297 if (keep_open_devices &&
298 dm_lock_for_deletion(md, mark_deferred, only_deferred)) {
299 dm_put(md);
300 dev_skipped++;
301 continue;
302 }
303
304 t = __hash_remove(hc);
305
306 up_write(&_hash_lock);
307
308 if (t) {
309 dm_sync_table(md);
310 dm_table_destroy(t);
311 }
312 dm_put(md);
313 if (likely(keep_open_devices))
314 dm_destroy(md);
315 else
316 dm_destroy_immediate(md);
317
318 /*
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.
323 */
324 goto retry;
325 }
326 }
327
328 up_write(&_hash_lock);
329
330 if (dev_skipped)
331 DMWARN("remove_all left %d open device(s)", dev_skipped);
332}
333
334/*
335 * Set the uuid of a hash_cell that isn't already set.
336 */
337static void __set_cell_uuid(struct hash_cell *hc, char *new_uuid)
338{
339 mutex_lock(&dm_hash_cells_mutex);
340 hc->uuid = new_uuid;
341 mutex_unlock(&dm_hash_cells_mutex);
342
343 list_add(&hc->uuid_list, _uuid_buckets + hash_str(new_uuid));
344}
345
346/*
347 * Changes the name of a hash_cell and returns the old name for
348 * the caller to free.
349 */
350static char *__change_cell_name(struct hash_cell *hc, char *new_name)
351{
352 char *old_name;
353
354 /*
355 * Rename and move the name cell.
356 */
357 list_del(&hc->name_list);
358 old_name = hc->name;
359
360 mutex_lock(&dm_hash_cells_mutex);
361 hc->name = new_name;
362 mutex_unlock(&dm_hash_cells_mutex);
363
364 list_add(&hc->name_list, _name_buckets + hash_str(new_name));
365
366 return old_name;
367}
368
369static struct mapped_device *dm_hash_rename(struct dm_ioctl *param,
370 const char *new)
371{
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;
378
379 /*
380 * duplicate new.
381 */
382 new_data = kstrdup(new, GFP_KERNEL);
383 if (!new_data)
384 return ERR_PTR(-ENOMEM);
385
386 down_write(&_hash_lock);
387
388 /*
389 * Is new free ?
390 */
391 if (change_uuid)
392 hc = __get_uuid_cell(new);
393 else
394 hc = __get_name_cell(new);
395
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);
405 }
406
407 /*
408 * Is there such a device as 'old' ?
409 */
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);
417 }
418
419 /*
420 * Does this device already have a uuid?
421 */
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);
430 }
431
432 if (change_uuid)
433 __set_cell_uuid(hc, new_data);
434 else
435 old_name = __change_cell_name(hc, new_data);
436
437 /*
438 * Wake up any dm event waiters.
439 */
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);
444
445 if (!dm_kobject_uevent(hc->md, KOBJ_CHANGE, param->event_nr))
446 param->flags |= DM_UEVENT_GENERATED_FLAG;
447
448 md = hc->md;
449 up_write(&_hash_lock);
450 kfree(old_name);
451
452 return md;
453}
454
455void dm_deferred_remove(void)
456{
457 dm_hash_remove_all(true, false, true);
458}
459
460/*-----------------------------------------------------------------
461 * Implementation of the ioctl commands
462 *---------------------------------------------------------------*/
463/*
464 * All the ioctl commands get dispatched to functions with this
465 * prototype.
466 */
467typedef int (*ioctl_fn)(struct file *filp, struct dm_ioctl *param, size_t param_size);
468
469static int remove_all(struct file *filp, struct dm_ioctl *param, size_t param_size)
470{
471 dm_hash_remove_all(true, !!(param->flags & DM_DEFERRED_REMOVE), false);
472 param->data_size = 0;
473 return 0;
474}
475
476/*
477 * Round up the ptr to an 8-byte boundary.
478 */
479#define ALIGN_MASK 7
480static inline size_t align_val(size_t val)
481{
482 return (val + ALIGN_MASK) & ~ALIGN_MASK;
483}
484static inline void *align_ptr(void *ptr)
485{
486 return (void *)align_val((size_t)ptr);
487}
488
489/*
490 * Retrieves the data payload buffer from an already allocated
491 * struct dm_ioctl.
492 */
493static void *get_result_buffer(struct dm_ioctl *param, size_t param_size,
494 size_t *len)
495{
496 param->data_start = align_ptr(param + 1) - (void *) param;
497
498 if (param->data_start < param_size)
499 *len = param_size - param->data_start;
500 else
501 *len = 0;
502
503 return ((void *) param) + param->data_start;
504}
505
506static int list_devices(struct file *filp, struct dm_ioctl *param, size_t param_size)
507{
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;
514
515 down_write(&_hash_lock);
516
517 /*
518 * Loop through all the devices working out how much
519 * space we need.
520 */
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));
525 }
526 }
527
528 /*
529 * Grab our output buffer.
530 */
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;
535 }
536 param->data_size = param->data_start + needed;
537
538 nl->dev = 0; /* Flags no data */
539
540 /*
541 * Now loop through filling out the names.
542 */
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);
552
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);
557 }
558 }
559 /*
560 * If mismatch happens, security may be compromised due to buffer
561 * overflow, so it's better to crash.
562 */
563 BUG_ON((char *)nl - (char *)orig_nl != needed);
564
565 out:
566 up_write(&_hash_lock);
567 return 0;
568}
569
570static void list_version_get_needed(struct target_type *tt, void *needed_param)
571{
572 size_t *needed = needed_param;
573
574 *needed += sizeof(struct dm_target_versions);
575 *needed += strlen(tt->name);
576 *needed += ALIGN_MASK;
577}
578
579static void list_version_get_info(struct target_type *tt, void *param)
580{
581 struct vers_iter *info = param;
582
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) {
586
587 info->flags = DM_BUFFER_FULL_FLAG;
588 return;
589 }
590
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);
599
600 info->old_vers = info->vers;
601 info->vers = align_ptr(((void *) ++info->vers) + strlen(tt->name) + 1);
602}
603
604static int list_versions(struct file *filp, struct dm_ioctl *param, size_t param_size)
605{
606 size_t len, needed = 0;
607 struct dm_target_versions *vers;
608 struct vers_iter iter_info;
609
610 /*
611 * Loop through all the devices working out how much
612 * space we need.
613 */
614 dm_target_iterate(list_version_get_needed, &needed);
615
616 /*
617 * Grab our output buffer.
618 */
619 vers = get_result_buffer(param, param_size, &len);
620 if (len < needed) {
621 param->flags |= DM_BUFFER_FULL_FLAG;
622 goto out;
623 }
624 param->data_size = param->data_start + needed;
625
626 iter_info.param_size = param_size;
627 iter_info.old_vers = NULL;
628 iter_info.vers = vers;
629 iter_info.flags = 0;
630 iter_info.end = (char *)vers+len;
631
632 /*
633 * Now loop through filling out the names & versions.
634 */
635 dm_target_iterate(list_version_get_info, &iter_info);
636 param->flags |= iter_info.flags;
637
638 out:
639 return 0;
640}
641
642static int check_name(const char *name)
643{
644 if (strchr(name, '/')) {
645 DMWARN("invalid device name");
646 return -EINVAL;
647 }
648
649 return 0;
650}
651
652/*
653 * On successful return, the caller must not attempt to acquire
654 * _hash_lock without first calling dm_put_live_table, because dm_table_destroy
655 * waits for this dm_put_live_table and could be called under this lock.
656 */
657static struct dm_table *dm_get_inactive_table(struct mapped_device *md, int *srcu_idx)
658{
659 struct hash_cell *hc;
660 struct dm_table *table = NULL;
661
662 /* increment rcu count, we don't care about the table pointer */
663 dm_get_live_table(md, srcu_idx);
664
665 down_read(&_hash_lock);
666 hc = dm_get_mdptr(md);
667 if (!hc || hc->md != md) {
668 DMWARN("device has been removed from the dev hash table.");
669 goto out;
670 }
671
672 table = hc->new_map;
673
674out:
675 up_read(&_hash_lock);
676
677 return table;
678}
679
680static struct dm_table *dm_get_live_or_inactive_table(struct mapped_device *md,
681 struct dm_ioctl *param,
682 int *srcu_idx)
683{
684 return (param->flags & DM_QUERY_INACTIVE_TABLE_FLAG) ?
685 dm_get_inactive_table(md, srcu_idx) : dm_get_live_table(md, srcu_idx);
686}
687
688/*
689 * Fills in a dm_ioctl structure, ready for sending back to
690 * userland.
691 */
692static void __dev_status(struct mapped_device *md, struct dm_ioctl *param)
693{
694 struct gendisk *disk = dm_disk(md);
695 struct dm_table *table;
696 int srcu_idx;
697
698 param->flags &= ~(DM_SUSPEND_FLAG | DM_READONLY_FLAG |
699 DM_ACTIVE_PRESENT_FLAG | DM_INTERNAL_SUSPEND_FLAG);
700
701 if (dm_suspended_md(md))
702 param->flags |= DM_SUSPEND_FLAG;
703
704 if (dm_suspended_internally_md(md))
705 param->flags |= DM_INTERNAL_SUSPEND_FLAG;
706
707 if (dm_test_deferred_remove_flag(md))
708 param->flags |= DM_DEFERRED_REMOVE;
709
710 param->dev = huge_encode_dev(disk_devt(disk));
711
712 /*
713 * Yes, this will be out of date by the time it gets back
714 * to userland, but it is still very useful for
715 * debugging.
716 */
717 param->open_count = dm_open_count(md);
718
719 param->event_nr = dm_get_event_nr(md);
720 param->target_count = 0;
721
722 table = dm_get_live_table(md, &srcu_idx);
723 if (table) {
724 if (!(param->flags & DM_QUERY_INACTIVE_TABLE_FLAG)) {
725 if (get_disk_ro(disk))
726 param->flags |= DM_READONLY_FLAG;
727 param->target_count = dm_table_get_num_targets(table);
728 }
729
730 param->flags |= DM_ACTIVE_PRESENT_FLAG;
731 }
732 dm_put_live_table(md, srcu_idx);
733
734 if (param->flags & DM_QUERY_INACTIVE_TABLE_FLAG) {
735 int srcu_idx;
736 table = dm_get_inactive_table(md, &srcu_idx);
737 if (table) {
738 if (!(dm_table_get_mode(table) & FMODE_WRITE))
739 param->flags |= DM_READONLY_FLAG;
740 param->target_count = dm_table_get_num_targets(table);
741 }
742 dm_put_live_table(md, srcu_idx);
743 }
744}
745
746static int dev_create(struct file *filp, struct dm_ioctl *param, size_t param_size)
747{
748 int r, m = DM_ANY_MINOR;
749 struct mapped_device *md;
750
751 r = check_name(param->name);
752 if (r)
753 return r;
754
755 if (param->flags & DM_PERSISTENT_DEV_FLAG)
756 m = MINOR(huge_decode_dev(param->dev));
757
758 r = dm_create(m, &md);
759 if (r)
760 return r;
761
762 r = dm_hash_insert(param->name, *param->uuid ? param->uuid : NULL, md);
763 if (r) {
764 dm_put(md);
765 dm_destroy(md);
766 return r;
767 }
768
769 param->flags &= ~DM_INACTIVE_PRESENT_FLAG;
770
771 __dev_status(md, param);
772
773 dm_put(md);
774
775 return 0;
776}
777
778/*
779 * Always use UUID for lookups if it's present, otherwise use name or dev.
780 */
781static struct hash_cell *__find_device_hash_cell(struct dm_ioctl *param)
782{
783 struct hash_cell *hc = NULL;
784
785 if (*param->uuid) {
786 if (*param->name || param->dev)
787 return NULL;
788
789 hc = __get_uuid_cell(param->uuid);
790 if (!hc)
791 return NULL;
792 } else if (*param->name) {
793 if (param->dev)
794 return NULL;
795
796 hc = __get_name_cell(param->name);
797 if (!hc)
798 return NULL;
799 } else if (param->dev) {
800 hc = __get_dev_cell(param->dev);
801 if (!hc)
802 return NULL;
803 } else
804 return NULL;
805
806 /*
807 * Sneakily write in both the name and the uuid
808 * while we have the cell.
809 */
810 strlcpy(param->name, hc->name, sizeof(param->name));
811 if (hc->uuid)
812 strlcpy(param->uuid, hc->uuid, sizeof(param->uuid));
813 else
814 param->uuid[0] = '\0';
815
816 if (hc->new_map)
817 param->flags |= DM_INACTIVE_PRESENT_FLAG;
818 else
819 param->flags &= ~DM_INACTIVE_PRESENT_FLAG;
820
821 return hc;
822}
823
824static struct mapped_device *find_device(struct dm_ioctl *param)
825{
826 struct hash_cell *hc;
827 struct mapped_device *md = NULL;
828
829 down_read(&_hash_lock);
830 hc = __find_device_hash_cell(param);
831 if (hc)
832 md = hc->md;
833 up_read(&_hash_lock);
834
835 return md;
836}
837
838static int dev_remove(struct file *filp, struct dm_ioctl *param, size_t param_size)
839{
840 struct hash_cell *hc;
841 struct mapped_device *md;
842 int r;
843 struct dm_table *t;
844
845 down_write(&_hash_lock);
846 hc = __find_device_hash_cell(param);
847
848 if (!hc) {
849 DMDEBUG_LIMIT("device doesn't appear to be in the dev hash table.");
850 up_write(&_hash_lock);
851 return -ENXIO;
852 }
853
854 md = hc->md;
855
856 /*
857 * Ensure the device is not open and nothing further can open it.
858 */
859 r = dm_lock_for_deletion(md, !!(param->flags & DM_DEFERRED_REMOVE), false);
860 if (r) {
861 if (r == -EBUSY && param->flags & DM_DEFERRED_REMOVE) {
862 up_write(&_hash_lock);
863 dm_put(md);
864 return 0;
865 }
866 DMDEBUG_LIMIT("unable to remove open device %s", hc->name);
867 up_write(&_hash_lock);
868 dm_put(md);
869 return r;
870 }
871
872 t = __hash_remove(hc);
873 up_write(&_hash_lock);
874
875 if (t) {
876 dm_sync_table(md);
877 dm_table_destroy(t);
878 }
879
880 param->flags &= ~DM_DEFERRED_REMOVE;
881
882 if (!dm_kobject_uevent(md, KOBJ_REMOVE, param->event_nr))
883 param->flags |= DM_UEVENT_GENERATED_FLAG;
884
885 dm_put(md);
886 dm_destroy(md);
887 return 0;
888}
889
890/*
891 * Check a string doesn't overrun the chunk of
892 * memory we copied from userland.
893 */
894static int invalid_str(char *str, void *end)
895{
896 while ((void *) str < end)
897 if (!*str++)
898 return 0;
899
900 return -EINVAL;
901}
902
903static int dev_rename(struct file *filp, struct dm_ioctl *param, size_t param_size)
904{
905 int r;
906 char *new_data = (char *) param + param->data_start;
907 struct mapped_device *md;
908 unsigned change_uuid = (param->flags & DM_UUID_FLAG) ? 1 : 0;
909
910 if (new_data < param->data ||
911 invalid_str(new_data, (void *) param + param_size) || !*new_data ||
912 strlen(new_data) > (change_uuid ? DM_UUID_LEN - 1 : DM_NAME_LEN - 1)) {
913 DMWARN("Invalid new mapped device name or uuid string supplied.");
914 return -EINVAL;
915 }
916
917 if (!change_uuid) {
918 r = check_name(new_data);
919 if (r)
920 return r;
921 }
922
923 md = dm_hash_rename(param, new_data);
924 if (IS_ERR(md))
925 return PTR_ERR(md);
926
927 __dev_status(md, param);
928 dm_put(md);
929
930 return 0;
931}
932
933static int dev_set_geometry(struct file *filp, struct dm_ioctl *param, size_t param_size)
934{
935 int r = -EINVAL, x;
936 struct mapped_device *md;
937 struct hd_geometry geometry;
938 unsigned long indata[4];
939 char *geostr = (char *) param + param->data_start;
940 char dummy;
941
942 md = find_device(param);
943 if (!md)
944 return -ENXIO;
945
946 if (geostr < param->data ||
947 invalid_str(geostr, (void *) param + param_size)) {
948 DMWARN("Invalid geometry supplied.");
949 goto out;
950 }
951
952 x = sscanf(geostr, "%lu %lu %lu %lu%c", indata,
953 indata + 1, indata + 2, indata + 3, &dummy);
954
955 if (x != 4) {
956 DMWARN("Unable to interpret geometry settings.");
957 goto out;
958 }
959
960 if (indata[0] > 65535 || indata[1] > 255 ||
961 indata[2] > 255 || indata[3] > ULONG_MAX) {
962 DMWARN("Geometry exceeds range limits.");
963 goto out;
964 }
965
966 geometry.cylinders = indata[0];
967 geometry.heads = indata[1];
968 geometry.sectors = indata[2];
969 geometry.start = indata[3];
970
971 r = dm_set_geometry(md, &geometry);
972
973 param->data_size = 0;
974
975out:
976 dm_put(md);
977 return r;
978}
979
980static int do_suspend(struct dm_ioctl *param)
981{
982 int r = 0;
983 unsigned suspend_flags = DM_SUSPEND_LOCKFS_FLAG;
984 struct mapped_device *md;
985
986 md = find_device(param);
987 if (!md)
988 return -ENXIO;
989
990 if (param->flags & DM_SKIP_LOCKFS_FLAG)
991 suspend_flags &= ~DM_SUSPEND_LOCKFS_FLAG;
992 if (param->flags & DM_NOFLUSH_FLAG)
993 suspend_flags |= DM_SUSPEND_NOFLUSH_FLAG;
994
995 if (!dm_suspended_md(md)) {
996 r = dm_suspend(md, suspend_flags);
997 if (r)
998 goto out;
999 }
1000
1001 __dev_status(md, param);
1002
1003out:
1004 dm_put(md);
1005
1006 return r;
1007}
1008
1009static int do_resume(struct dm_ioctl *param)
1010{
1011 int r = 0;
1012 unsigned suspend_flags = DM_SUSPEND_LOCKFS_FLAG;
1013 struct hash_cell *hc;
1014 struct mapped_device *md;
1015 struct dm_table *new_map, *old_map = NULL;
1016
1017 down_write(&_hash_lock);
1018
1019 hc = __find_device_hash_cell(param);
1020 if (!hc) {
1021 DMDEBUG_LIMIT("device doesn't appear to be in the dev hash table.");
1022 up_write(&_hash_lock);
1023 return -ENXIO;
1024 }
1025
1026 md = hc->md;
1027
1028 new_map = hc->new_map;
1029 hc->new_map = NULL;
1030 param->flags &= ~DM_INACTIVE_PRESENT_FLAG;
1031
1032 up_write(&_hash_lock);
1033
1034 /* Do we need to load a new map ? */
1035 if (new_map) {
1036 /* Suspend if it isn't already suspended */
1037 if (param->flags & DM_SKIP_LOCKFS_FLAG)
1038 suspend_flags &= ~DM_SUSPEND_LOCKFS_FLAG;
1039 if (param->flags & DM_NOFLUSH_FLAG)
1040 suspend_flags |= DM_SUSPEND_NOFLUSH_FLAG;
1041 if (!dm_suspended_md(md))
1042 dm_suspend(md, suspend_flags);
1043
1044 old_map = dm_swap_table(md, new_map);
1045 if (IS_ERR(old_map)) {
1046 dm_sync_table(md);
1047 dm_table_destroy(new_map);
1048 dm_put(md);
1049 return PTR_ERR(old_map);
1050 }
1051
1052 if (dm_table_get_mode(new_map) & FMODE_WRITE)
1053 set_disk_ro(dm_disk(md), 0);
1054 else
1055 set_disk_ro(dm_disk(md), 1);
1056 }
1057
1058 if (dm_suspended_md(md)) {
1059 r = dm_resume(md);
1060 if (!r && !dm_kobject_uevent(md, KOBJ_CHANGE, param->event_nr))
1061 param->flags |= DM_UEVENT_GENERATED_FLAG;
1062 }
1063
1064 /*
1065 * Since dm_swap_table synchronizes RCU, nobody should be in
1066 * read-side critical section already.
1067 */
1068 if (old_map)
1069 dm_table_destroy(old_map);
1070
1071 if (!r)
1072 __dev_status(md, param);
1073
1074 dm_put(md);
1075 return r;
1076}
1077
1078/*
1079 * Set or unset the suspension state of a device.
1080 * If the device already is in the requested state we just return its status.
1081 */
1082static int dev_suspend(struct file *filp, struct dm_ioctl *param, size_t param_size)
1083{
1084 if (param->flags & DM_SUSPEND_FLAG)
1085 return do_suspend(param);
1086
1087 return do_resume(param);
1088}
1089
1090/*
1091 * Copies device info back to user space, used by
1092 * the create and info ioctls.
1093 */
1094static int dev_status(struct file *filp, struct dm_ioctl *param, size_t param_size)
1095{
1096 struct mapped_device *md;
1097
1098 md = find_device(param);
1099 if (!md)
1100 return -ENXIO;
1101
1102 __dev_status(md, param);
1103 dm_put(md);
1104
1105 return 0;
1106}
1107
1108/*
1109 * Build up the status struct for each target
1110 */
1111static void retrieve_status(struct dm_table *table,
1112 struct dm_ioctl *param, size_t param_size)
1113{
1114 unsigned int i, num_targets;
1115 struct dm_target_spec *spec;
1116 char *outbuf, *outptr;
1117 status_type_t type;
1118 size_t remaining, len, used = 0;
1119 unsigned status_flags = 0;
1120
1121 outptr = outbuf = get_result_buffer(param, param_size, &len);
1122
1123 if (param->flags & DM_STATUS_TABLE_FLAG)
1124 type = STATUSTYPE_TABLE;
1125 else
1126 type = STATUSTYPE_INFO;
1127
1128 /* Get all the target info */
1129 num_targets = dm_table_get_num_targets(table);
1130 for (i = 0; i < num_targets; i++) {
1131 struct dm_target *ti = dm_table_get_target(table, i);
1132 size_t l;
1133
1134 remaining = len - (outptr - outbuf);
1135 if (remaining <= sizeof(struct dm_target_spec)) {
1136 param->flags |= DM_BUFFER_FULL_FLAG;
1137 break;
1138 }
1139
1140 spec = (struct dm_target_spec *) outptr;
1141
1142 spec->status = 0;
1143 spec->sector_start = ti->begin;
1144 spec->length = ti->len;
1145 strncpy(spec->target_type, ti->type->name,
1146 sizeof(spec->target_type));
1147
1148 outptr += sizeof(struct dm_target_spec);
1149 remaining = len - (outptr - outbuf);
1150 if (remaining <= 0) {
1151 param->flags |= DM_BUFFER_FULL_FLAG;
1152 break;
1153 }
1154
1155 /* Get the status/table string from the target driver */
1156 if (ti->type->status) {
1157 if (param->flags & DM_NOFLUSH_FLAG)
1158 status_flags |= DM_STATUS_NOFLUSH_FLAG;
1159 ti->type->status(ti, type, status_flags, outptr, remaining);
1160 } else
1161 outptr[0] = '\0';
1162
1163 l = strlen(outptr) + 1;
1164 if (l == remaining) {
1165 param->flags |= DM_BUFFER_FULL_FLAG;
1166 break;
1167 }
1168
1169 outptr += l;
1170 used = param->data_start + (outptr - outbuf);
1171
1172 outptr = align_ptr(outptr);
1173 spec->next = outptr - outbuf;
1174 }
1175
1176 if (used)
1177 param->data_size = used;
1178
1179 param->target_count = num_targets;
1180}
1181
1182/*
1183 * Wait for a device to report an event
1184 */
1185static int dev_wait(struct file *filp, struct dm_ioctl *param, size_t param_size)
1186{
1187 int r = 0;
1188 struct mapped_device *md;
1189 struct dm_table *table;
1190 int srcu_idx;
1191
1192 md = find_device(param);
1193 if (!md)
1194 return -ENXIO;
1195
1196 /*
1197 * Wait for a notification event
1198 */
1199 if (dm_wait_event(md, param->event_nr)) {
1200 r = -ERESTARTSYS;
1201 goto out;
1202 }
1203
1204 /*
1205 * The userland program is going to want to know what
1206 * changed to trigger the event, so we may as well tell
1207 * him and save an ioctl.
1208 */
1209 __dev_status(md, param);
1210
1211 table = dm_get_live_or_inactive_table(md, param, &srcu_idx);
1212 if (table)
1213 retrieve_status(table, param, param_size);
1214 dm_put_live_table(md, srcu_idx);
1215
1216out:
1217 dm_put(md);
1218
1219 return r;
1220}
1221
1222/*
1223 * Remember the global event number and make it possible to poll
1224 * for further events.
1225 */
1226static int dev_arm_poll(struct file *filp, struct dm_ioctl *param, size_t param_size)
1227{
1228 struct dm_file *priv = filp->private_data;
1229
1230 priv->global_event_nr = atomic_read(&dm_global_event_nr);
1231
1232 return 0;
1233}
1234
1235static inline fmode_t get_mode(struct dm_ioctl *param)
1236{
1237 fmode_t mode = FMODE_READ | FMODE_WRITE;
1238
1239 if (param->flags & DM_READONLY_FLAG)
1240 mode = FMODE_READ;
1241
1242 return mode;
1243}
1244
1245static int next_target(struct dm_target_spec *last, uint32_t next, void *end,
1246 struct dm_target_spec **spec, char **target_params)
1247{
1248 *spec = (struct dm_target_spec *) ((unsigned char *) last + next);
1249 *target_params = (char *) (*spec + 1);
1250
1251 if (*spec < (last + 1))
1252 return -EINVAL;
1253
1254 return invalid_str(*target_params, end);
1255}
1256
1257static int populate_table(struct dm_table *table,
1258 struct dm_ioctl *param, size_t param_size)
1259{
1260 int r;
1261 unsigned int i = 0;
1262 struct dm_target_spec *spec = (struct dm_target_spec *) param;
1263 uint32_t next = param->data_start;
1264 void *end = (void *) param + param_size;
1265 char *target_params;
1266
1267 if (!param->target_count) {
1268 DMWARN("populate_table: no targets specified");
1269 return -EINVAL;
1270 }
1271
1272 for (i = 0; i < param->target_count; i++) {
1273
1274 r = next_target(spec, next, end, &spec, &target_params);
1275 if (r) {
1276 DMWARN("unable to find target");
1277 return r;
1278 }
1279
1280 r = dm_table_add_target(table, spec->target_type,
1281 (sector_t) spec->sector_start,
1282 (sector_t) spec->length,
1283 target_params);
1284 if (r) {
1285 DMWARN("error adding target to table");
1286 return r;
1287 }
1288
1289 next = spec->next;
1290 }
1291
1292 return dm_table_complete(table);
1293}
1294
1295static bool is_valid_type(enum dm_queue_mode cur, enum dm_queue_mode new)
1296{
1297 if (cur == new ||
1298 (cur == DM_TYPE_BIO_BASED && new == DM_TYPE_DAX_BIO_BASED))
1299 return true;
1300
1301 return false;
1302}
1303
1304static int table_load(struct file *filp, struct dm_ioctl *param, size_t param_size)
1305{
1306 int r;
1307 struct hash_cell *hc;
1308 struct dm_table *t, *old_map = NULL;
1309 struct mapped_device *md;
1310 struct target_type *immutable_target_type;
1311
1312 md = find_device(param);
1313 if (!md)
1314 return -ENXIO;
1315
1316 r = dm_table_create(&t, get_mode(param), param->target_count, md);
1317 if (r)
1318 goto err;
1319
1320 /* Protect md->type and md->queue against concurrent table loads. */
1321 dm_lock_md_type(md);
1322 r = populate_table(t, param, param_size);
1323 if (r)
1324 goto err_unlock_md_type;
1325
1326 immutable_target_type = dm_get_immutable_target_type(md);
1327 if (immutable_target_type &&
1328 (immutable_target_type != dm_table_get_immutable_target_type(t)) &&
1329 !dm_table_get_wildcard_target(t)) {
1330 DMWARN("can't replace immutable target type %s",
1331 immutable_target_type->name);
1332 r = -EINVAL;
1333 goto err_unlock_md_type;
1334 }
1335
1336 if (dm_get_md_type(md) == DM_TYPE_NONE) {
1337 /* Initial table load: acquire type of table. */
1338 dm_set_md_type(md, dm_table_get_type(t));
1339
1340 /* setup md->queue to reflect md's type (may block) */
1341 r = dm_setup_md_queue(md, t);
1342 if (r) {
1343 DMWARN("unable to set up device queue for new table.");
1344 goto err_unlock_md_type;
1345 }
1346 } else if (!is_valid_type(dm_get_md_type(md), dm_table_get_type(t))) {
1347 DMWARN("can't change device type after initial table load.");
1348 r = -EINVAL;
1349 goto err_unlock_md_type;
1350 }
1351
1352 dm_unlock_md_type(md);
1353
1354 /* stage inactive table */
1355 down_write(&_hash_lock);
1356 hc = dm_get_mdptr(md);
1357 if (!hc || hc->md != md) {
1358 DMWARN("device has been removed from the dev hash table.");
1359 up_write(&_hash_lock);
1360 r = -ENXIO;
1361 goto err_destroy_table;
1362 }
1363
1364 if (hc->new_map)
1365 old_map = hc->new_map;
1366 hc->new_map = t;
1367 up_write(&_hash_lock);
1368
1369 param->flags |= DM_INACTIVE_PRESENT_FLAG;
1370 __dev_status(md, param);
1371
1372 if (old_map) {
1373 dm_sync_table(md);
1374 dm_table_destroy(old_map);
1375 }
1376
1377 dm_put(md);
1378
1379 return 0;
1380
1381err_unlock_md_type:
1382 dm_unlock_md_type(md);
1383err_destroy_table:
1384 dm_table_destroy(t);
1385err:
1386 dm_put(md);
1387
1388 return r;
1389}
1390
1391static int table_clear(struct file *filp, struct dm_ioctl *param, size_t param_size)
1392{
1393 struct hash_cell *hc;
1394 struct mapped_device *md;
1395 struct dm_table *old_map = NULL;
1396
1397 down_write(&_hash_lock);
1398
1399 hc = __find_device_hash_cell(param);
1400 if (!hc) {
1401 DMDEBUG_LIMIT("device doesn't appear to be in the dev hash table.");
1402 up_write(&_hash_lock);
1403 return -ENXIO;
1404 }
1405
1406 if (hc->new_map) {
1407 old_map = hc->new_map;
1408 hc->new_map = NULL;
1409 }
1410
1411 param->flags &= ~DM_INACTIVE_PRESENT_FLAG;
1412
1413 __dev_status(hc->md, param);
1414 md = hc->md;
1415 up_write(&_hash_lock);
1416 if (old_map) {
1417 dm_sync_table(md);
1418 dm_table_destroy(old_map);
1419 }
1420 dm_put(md);
1421
1422 return 0;
1423}
1424
1425/*
1426 * Retrieves a list of devices used by a particular dm device.
1427 */
1428static void retrieve_deps(struct dm_table *table,
1429 struct dm_ioctl *param, size_t param_size)
1430{
1431 unsigned int count = 0;
1432 struct list_head *tmp;
1433 size_t len, needed;
1434 struct dm_dev_internal *dd;
1435 struct dm_target_deps *deps;
1436
1437 deps = get_result_buffer(param, param_size, &len);
1438
1439 /*
1440 * Count the devices.
1441 */
1442 list_for_each (tmp, dm_table_get_devices(table))
1443 count++;
1444
1445 /*
1446 * Check we have enough space.
1447 */
1448 needed = sizeof(*deps) + (sizeof(*deps->dev) * count);
1449 if (len < needed) {
1450 param->flags |= DM_BUFFER_FULL_FLAG;
1451 return;
1452 }
1453
1454 /*
1455 * Fill in the devices.
1456 */
1457 deps->count = count;
1458 count = 0;
1459 list_for_each_entry (dd, dm_table_get_devices(table), list)
1460 deps->dev[count++] = huge_encode_dev(dd->dm_dev->bdev->bd_dev);
1461
1462 param->data_size = param->data_start + needed;
1463}
1464
1465static int table_deps(struct file *filp, struct dm_ioctl *param, size_t param_size)
1466{
1467 struct mapped_device *md;
1468 struct dm_table *table;
1469 int srcu_idx;
1470
1471 md = find_device(param);
1472 if (!md)
1473 return -ENXIO;
1474
1475 __dev_status(md, param);
1476
1477 table = dm_get_live_or_inactive_table(md, param, &srcu_idx);
1478 if (table)
1479 retrieve_deps(table, param, param_size);
1480 dm_put_live_table(md, srcu_idx);
1481
1482 dm_put(md);
1483
1484 return 0;
1485}
1486
1487/*
1488 * Return the status of a device as a text string for each
1489 * target.
1490 */
1491static int table_status(struct file *filp, struct dm_ioctl *param, size_t param_size)
1492{
1493 struct mapped_device *md;
1494 struct dm_table *table;
1495 int srcu_idx;
1496
1497 md = find_device(param);
1498 if (!md)
1499 return -ENXIO;
1500
1501 __dev_status(md, param);
1502
1503 table = dm_get_live_or_inactive_table(md, param, &srcu_idx);
1504 if (table)
1505 retrieve_status(table, param, param_size);
1506 dm_put_live_table(md, srcu_idx);
1507
1508 dm_put(md);
1509
1510 return 0;
1511}
1512
1513/*
1514 * Process device-mapper dependent messages. Messages prefixed with '@'
1515 * are processed by the DM core. All others are delivered to the target.
1516 * Returns a number <= 1 if message was processed by device mapper.
1517 * Returns 2 if message should be delivered to the target.
1518 */
1519static int message_for_md(struct mapped_device *md, unsigned argc, char **argv,
1520 char *result, unsigned maxlen)
1521{
1522 int r;
1523
1524 if (**argv != '@')
1525 return 2; /* no '@' prefix, deliver to target */
1526
1527 if (!strcasecmp(argv[0], "@cancel_deferred_remove")) {
1528 if (argc != 1) {
1529 DMERR("Invalid arguments for @cancel_deferred_remove");
1530 return -EINVAL;
1531 }
1532 return dm_cancel_deferred_remove(md);
1533 }
1534
1535 r = dm_stats_message(md, argc, argv, result, maxlen);
1536 if (r < 2)
1537 return r;
1538
1539 DMERR("Unsupported message sent to DM core: %s", argv[0]);
1540 return -EINVAL;
1541}
1542
1543/*
1544 * Pass a message to the target that's at the supplied device offset.
1545 */
1546static int target_message(struct file *filp, struct dm_ioctl *param, size_t param_size)
1547{
1548 int r, argc;
1549 char **argv;
1550 struct mapped_device *md;
1551 struct dm_table *table;
1552 struct dm_target *ti;
1553 struct dm_target_msg *tmsg = (void *) param + param->data_start;
1554 size_t maxlen;
1555 char *result = get_result_buffer(param, param_size, &maxlen);
1556 int srcu_idx;
1557
1558 md = find_device(param);
1559 if (!md)
1560 return -ENXIO;
1561
1562 if (tmsg < (struct dm_target_msg *) param->data ||
1563 invalid_str(tmsg->message, (void *) param + param_size)) {
1564 DMWARN("Invalid target message parameters.");
1565 r = -EINVAL;
1566 goto out;
1567 }
1568
1569 r = dm_split_args(&argc, &argv, tmsg->message);
1570 if (r) {
1571 DMWARN("Failed to split target message parameters");
1572 goto out;
1573 }
1574
1575 if (!argc) {
1576 DMWARN("Empty message received.");
1577 goto out_argv;
1578 }
1579
1580 r = message_for_md(md, argc, argv, result, maxlen);
1581 if (r <= 1)
1582 goto out_argv;
1583
1584 table = dm_get_live_table(md, &srcu_idx);
1585 if (!table)
1586 goto out_table;
1587
1588 if (dm_deleting_md(md)) {
1589 r = -ENXIO;
1590 goto out_table;
1591 }
1592
1593 ti = dm_table_find_target(table, tmsg->sector);
1594 if (!dm_target_is_valid(ti)) {
1595 DMWARN("Target message sector outside device.");
1596 r = -EINVAL;
1597 } else if (ti->type->message)
1598 r = ti->type->message(ti, argc, argv, result, maxlen);
1599 else {
1600 DMWARN("Target type does not support messages");
1601 r = -EINVAL;
1602 }
1603
1604 out_table:
1605 dm_put_live_table(md, srcu_idx);
1606 out_argv:
1607 kfree(argv);
1608 out:
1609 if (r >= 0)
1610 __dev_status(md, param);
1611
1612 if (r == 1) {
1613 param->flags |= DM_DATA_OUT_FLAG;
1614 if (dm_message_test_buffer_overflow(result, maxlen))
1615 param->flags |= DM_BUFFER_FULL_FLAG;
1616 else
1617 param->data_size = param->data_start + strlen(result) + 1;
1618 r = 0;
1619 }
1620
1621 dm_put(md);
1622 return r;
1623}
1624
1625/*
1626 * The ioctl parameter block consists of two parts, a dm_ioctl struct
1627 * followed by a data buffer. This flag is set if the second part,
1628 * which has a variable size, is not used by the function processing
1629 * the ioctl.
1630 */
1631#define IOCTL_FLAGS_NO_PARAMS 1
1632#define IOCTL_FLAGS_ISSUE_GLOBAL_EVENT 2
1633
1634/*-----------------------------------------------------------------
1635 * Implementation of open/close/ioctl on the special char
1636 * device.
1637 *---------------------------------------------------------------*/
1638static ioctl_fn lookup_ioctl(unsigned int cmd, int *ioctl_flags)
1639{
1640 static const struct {
1641 int cmd;
1642 int flags;
1643 ioctl_fn fn;
1644 } _ioctls[] = {
1645 {DM_VERSION_CMD, 0, NULL}, /* version is dealt with elsewhere */
1646 {DM_REMOVE_ALL_CMD, IOCTL_FLAGS_NO_PARAMS | IOCTL_FLAGS_ISSUE_GLOBAL_EVENT, remove_all},
1647 {DM_LIST_DEVICES_CMD, 0, list_devices},
1648
1649 {DM_DEV_CREATE_CMD, IOCTL_FLAGS_NO_PARAMS | IOCTL_FLAGS_ISSUE_GLOBAL_EVENT, dev_create},
1650 {DM_DEV_REMOVE_CMD, IOCTL_FLAGS_NO_PARAMS | IOCTL_FLAGS_ISSUE_GLOBAL_EVENT, dev_remove},
1651 {DM_DEV_RENAME_CMD, IOCTL_FLAGS_ISSUE_GLOBAL_EVENT, dev_rename},
1652 {DM_DEV_SUSPEND_CMD, IOCTL_FLAGS_NO_PARAMS, dev_suspend},
1653 {DM_DEV_STATUS_CMD, IOCTL_FLAGS_NO_PARAMS, dev_status},
1654 {DM_DEV_WAIT_CMD, 0, dev_wait},
1655
1656 {DM_TABLE_LOAD_CMD, 0, table_load},
1657 {DM_TABLE_CLEAR_CMD, IOCTL_FLAGS_NO_PARAMS, table_clear},
1658 {DM_TABLE_DEPS_CMD, 0, table_deps},
1659 {DM_TABLE_STATUS_CMD, 0, table_status},
1660
1661 {DM_LIST_VERSIONS_CMD, 0, list_versions},
1662
1663 {DM_TARGET_MSG_CMD, 0, target_message},
1664 {DM_DEV_SET_GEOMETRY_CMD, 0, dev_set_geometry},
1665 {DM_DEV_ARM_POLL, IOCTL_FLAGS_NO_PARAMS, dev_arm_poll},
1666 };
1667
1668 if (unlikely(cmd >= ARRAY_SIZE(_ioctls)))
1669 return NULL;
1670
1671 *ioctl_flags = _ioctls[cmd].flags;
1672 return _ioctls[cmd].fn;
1673}
1674
1675/*
1676 * As well as checking the version compatibility this always
1677 * copies the kernel interface version out.
1678 */
1679static int check_version(unsigned int cmd, struct dm_ioctl __user *user)
1680{
1681 uint32_t version[3];
1682 int r = 0;
1683
1684 if (copy_from_user(version, user->version, sizeof(version)))
1685 return -EFAULT;
1686
1687 if ((DM_VERSION_MAJOR != version[0]) ||
1688 (DM_VERSION_MINOR < version[1])) {
1689 DMWARN("ioctl interface mismatch: "
1690 "kernel(%u.%u.%u), user(%u.%u.%u), cmd(%d)",
1691 DM_VERSION_MAJOR, DM_VERSION_MINOR,
1692 DM_VERSION_PATCHLEVEL,
1693 version[0], version[1], version[2], cmd);
1694 r = -EINVAL;
1695 }
1696
1697 /*
1698 * Fill in the kernel version.
1699 */
1700 version[0] = DM_VERSION_MAJOR;
1701 version[1] = DM_VERSION_MINOR;
1702 version[2] = DM_VERSION_PATCHLEVEL;
1703 if (copy_to_user(user->version, version, sizeof(version)))
1704 return -EFAULT;
1705
1706 return r;
1707}
1708
1709#define DM_PARAMS_MALLOC 0x0001 /* Params allocated with kvmalloc() */
1710#define DM_WIPE_BUFFER 0x0010 /* Wipe input buffer before returning from ioctl */
1711
1712static void free_params(struct dm_ioctl *param, size_t param_size, int param_flags)
1713{
1714 if (param_flags & DM_WIPE_BUFFER)
1715 memset(param, 0, param_size);
1716
1717 if (param_flags & DM_PARAMS_MALLOC)
1718 kvfree(param);
1719}
1720
1721static int copy_params(struct dm_ioctl __user *user, struct dm_ioctl *param_kernel,
1722 int ioctl_flags,
1723 struct dm_ioctl **param, int *param_flags)
1724{
1725 struct dm_ioctl *dmi;
1726 int secure_data;
1727 const size_t minimum_data_size = offsetof(struct dm_ioctl, data);
1728 unsigned noio_flag;
1729
1730 if (copy_from_user(param_kernel, user, minimum_data_size))
1731 return -EFAULT;
1732
1733 if (param_kernel->data_size < minimum_data_size)
1734 return -EINVAL;
1735
1736 secure_data = param_kernel->flags & DM_SECURE_DATA_FLAG;
1737
1738 *param_flags = secure_data ? DM_WIPE_BUFFER : 0;
1739
1740 if (ioctl_flags & IOCTL_FLAGS_NO_PARAMS) {
1741 dmi = param_kernel;
1742 dmi->data_size = minimum_data_size;
1743 goto data_copied;
1744 }
1745
1746 /*
1747 * Use __GFP_HIGH to avoid low memory issues when a device is
1748 * suspended and the ioctl is needed to resume it.
1749 * Use kmalloc() rather than vmalloc() when we can.
1750 */
1751 dmi = NULL;
1752 noio_flag = memalloc_noio_save();
1753 dmi = kvmalloc(param_kernel->data_size, GFP_KERNEL | __GFP_HIGH);
1754 memalloc_noio_restore(noio_flag);
1755
1756 if (!dmi) {
1757 if (secure_data && clear_user(user, param_kernel->data_size))
1758 return -EFAULT;
1759 return -ENOMEM;
1760 }
1761
1762 *param_flags |= DM_PARAMS_MALLOC;
1763
1764 if (copy_from_user(dmi, user, param_kernel->data_size))
1765 goto bad;
1766
1767data_copied:
1768 /*
1769 * Abort if something changed the ioctl data while it was being copied.
1770 */
1771 if (dmi->data_size != param_kernel->data_size) {
1772 DMERR("rejecting ioctl: data size modified while processing parameters");
1773 goto bad;
1774 }
1775
1776 /* Wipe the user buffer so we do not return it to userspace */
1777 if (secure_data && clear_user(user, param_kernel->data_size))
1778 goto bad;
1779
1780 *param = dmi;
1781 return 0;
1782
1783bad:
1784 free_params(dmi, param_kernel->data_size, *param_flags);
1785
1786 return -EFAULT;
1787}
1788
1789static int validate_params(uint cmd, struct dm_ioctl *param)
1790{
1791 /* Always clear this flag */
1792 param->flags &= ~DM_BUFFER_FULL_FLAG;
1793 param->flags &= ~DM_UEVENT_GENERATED_FLAG;
1794 param->flags &= ~DM_SECURE_DATA_FLAG;
1795 param->flags &= ~DM_DATA_OUT_FLAG;
1796
1797 /* Ignores parameters */
1798 if (cmd == DM_REMOVE_ALL_CMD ||
1799 cmd == DM_LIST_DEVICES_CMD ||
1800 cmd == DM_LIST_VERSIONS_CMD)
1801 return 0;
1802
1803 if (cmd == DM_DEV_CREATE_CMD) {
1804 if (!*param->name) {
1805 DMWARN("name not supplied when creating device");
1806 return -EINVAL;
1807 }
1808 } else if (*param->uuid && *param->name) {
1809 DMWARN("only supply one of name or uuid, cmd(%u)", cmd);
1810 return -EINVAL;
1811 }
1812
1813 /* Ensure strings are terminated */
1814 param->name[DM_NAME_LEN - 1] = '\0';
1815 param->uuid[DM_UUID_LEN - 1] = '\0';
1816
1817 return 0;
1818}
1819
1820static int ctl_ioctl(struct file *file, uint command, struct dm_ioctl __user *user)
1821{
1822 int r = 0;
1823 int ioctl_flags;
1824 int param_flags;
1825 unsigned int cmd;
1826 struct dm_ioctl *uninitialized_var(param);
1827 ioctl_fn fn = NULL;
1828 size_t input_param_size;
1829 struct dm_ioctl param_kernel;
1830
1831 /* only root can play with this */
1832 if (!capable(CAP_SYS_ADMIN))
1833 return -EACCES;
1834
1835 if (_IOC_TYPE(command) != DM_IOCTL)
1836 return -ENOTTY;
1837
1838 cmd = _IOC_NR(command);
1839
1840 /*
1841 * Check the interface version passed in. This also
1842 * writes out the kernel's interface version.
1843 */
1844 r = check_version(cmd, user);
1845 if (r)
1846 return r;
1847
1848 /*
1849 * Nothing more to do for the version command.
1850 */
1851 if (cmd == DM_VERSION_CMD)
1852 return 0;
1853
1854 fn = lookup_ioctl(cmd, &ioctl_flags);
1855 if (!fn) {
1856 DMWARN("dm_ctl_ioctl: unknown command 0x%x", command);
1857 return -ENOTTY;
1858 }
1859
1860 /*
1861 * Copy the parameters into kernel space.
1862 */
1863 r = copy_params(user, ¶m_kernel, ioctl_flags, ¶m, ¶m_flags);
1864
1865 if (r)
1866 return r;
1867
1868 input_param_size = param->data_size;
1869 r = validate_params(cmd, param);
1870 if (r)
1871 goto out;
1872
1873 param->data_size = offsetof(struct dm_ioctl, data);
1874 r = fn(file, param, input_param_size);
1875
1876 if (unlikely(param->flags & DM_BUFFER_FULL_FLAG) &&
1877 unlikely(ioctl_flags & IOCTL_FLAGS_NO_PARAMS))
1878 DMERR("ioctl %d tried to output some data but has IOCTL_FLAGS_NO_PARAMS set", cmd);
1879
1880 if (!r && ioctl_flags & IOCTL_FLAGS_ISSUE_GLOBAL_EVENT)
1881 dm_issue_global_event();
1882
1883 /*
1884 * Copy the results back to userland.
1885 */
1886 if (!r && copy_to_user(user, param, param->data_size))
1887 r = -EFAULT;
1888
1889out:
1890 free_params(param, input_param_size, param_flags);
1891 return r;
1892}
1893
1894static long dm_ctl_ioctl(struct file *file, uint command, ulong u)
1895{
1896 return (long)ctl_ioctl(file, command, (struct dm_ioctl __user *)u);
1897}
1898
1899#ifdef CONFIG_COMPAT
1900static long dm_compat_ctl_ioctl(struct file *file, uint command, ulong u)
1901{
1902 return (long)dm_ctl_ioctl(file, command, (ulong) compat_ptr(u));
1903}
1904#else
1905#define dm_compat_ctl_ioctl NULL
1906#endif
1907
1908static int dm_open(struct inode *inode, struct file *filp)
1909{
1910 int r;
1911 struct dm_file *priv;
1912
1913 r = nonseekable_open(inode, filp);
1914 if (unlikely(r))
1915 return r;
1916
1917 priv = filp->private_data = kmalloc(sizeof(struct dm_file), GFP_KERNEL);
1918 if (!priv)
1919 return -ENOMEM;
1920
1921 priv->global_event_nr = atomic_read(&dm_global_event_nr);
1922
1923 return 0;
1924}
1925
1926static int dm_release(struct inode *inode, struct file *filp)
1927{
1928 kfree(filp->private_data);
1929 return 0;
1930}
1931
1932static __poll_t dm_poll(struct file *filp, poll_table *wait)
1933{
1934 struct dm_file *priv = filp->private_data;
1935 __poll_t mask = 0;
1936
1937 poll_wait(filp, &dm_global_eventq, wait);
1938
1939 if ((int)(atomic_read(&dm_global_event_nr) - priv->global_event_nr) > 0)
1940 mask |= EPOLLIN;
1941
1942 return mask;
1943}
1944
1945static const struct file_operations _ctl_fops = {
1946 .open = dm_open,
1947 .release = dm_release,
1948 .poll = dm_poll,
1949 .unlocked_ioctl = dm_ctl_ioctl,
1950 .compat_ioctl = dm_compat_ctl_ioctl,
1951 .owner = THIS_MODULE,
1952 .llseek = noop_llseek,
1953};
1954
1955static struct miscdevice _dm_misc = {
1956 .minor = MAPPER_CTRL_MINOR,
1957 .name = DM_NAME,
1958 .nodename = DM_DIR "/" DM_CONTROL_NODE,
1959 .fops = &_ctl_fops
1960};
1961
1962MODULE_ALIAS_MISCDEV(MAPPER_CTRL_MINOR);
1963MODULE_ALIAS("devname:" DM_DIR "/" DM_CONTROL_NODE);
1964
1965/*
1966 * Create misc character device and link to DM_DIR/control.
1967 */
1968int __init dm_interface_init(void)
1969{
1970 int r;
1971
1972 r = dm_hash_init();
1973 if (r)
1974 return r;
1975
1976 r = misc_register(&_dm_misc);
1977 if (r) {
1978 DMERR("misc_register failed for control device");
1979 dm_hash_exit();
1980 return r;
1981 }
1982
1983 DMINFO("%d.%d.%d%s initialised: %s", DM_VERSION_MAJOR,
1984 DM_VERSION_MINOR, DM_VERSION_PATCHLEVEL, DM_VERSION_EXTRA,
1985 DM_DRIVER_EMAIL);
1986 return 0;
1987}
1988
1989void dm_interface_exit(void)
1990{
1991 misc_deregister(&_dm_misc);
1992 dm_hash_exit();
1993}
1994
1995/**
1996 * dm_copy_name_and_uuid - Copy mapped device name & uuid into supplied buffers
1997 * @md: Pointer to mapped_device
1998 * @name: Buffer (size DM_NAME_LEN) for name
1999 * @uuid: Buffer (size DM_UUID_LEN) for uuid or empty string if uuid not defined
2000 */
2001int dm_copy_name_and_uuid(struct mapped_device *md, char *name, char *uuid)
2002{
2003 int r = 0;
2004 struct hash_cell *hc;
2005
2006 if (!md)
2007 return -ENXIO;
2008
2009 mutex_lock(&dm_hash_cells_mutex);
2010 hc = dm_get_mdptr(md);
2011 if (!hc || hc->md != md) {
2012 r = -ENXIO;
2013 goto out;
2014 }
2015
2016 if (name)
2017 strcpy(name, hc->name);
2018 if (uuid)
2019 strcpy(uuid, hc->uuid ? : "");
2020
2021out:
2022 mutex_unlock(&dm_hash_cells_mutex);
2023
2024 return r;
2025}