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