xref: /netbsd-src/sys/dev/dm/dm_ioctl.c (revision bdc22b2e01993381dcefeff2bc9b56ca75a4235c)
1 /* $NetBSD: dm_ioctl.c,v 1.32 2018/01/05 14:22:05 christos Exp $      */
2 
3 /*
4  * Copyright (c) 2008 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Adam Hamsik.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 #include <sys/cdefs.h>
32 __KERNEL_RCSID(0, "$NetBSD: dm_ioctl.c,v 1.32 2018/01/05 14:22:05 christos Exp $");
33 
34 /*
35  * Locking is used to synchronise between ioctl calls and between dm_table's
36  * users.
37  *
38  * ioctl locking:
39  * Simple reference counting, to count users of device will be used routines
40  * dm_dev_busy/dm_dev_unbusy are used for that.
41  * dm_dev_lookup/dm_dev_rem call dm_dev_busy before return(caller is therefore
42  * holder of reference_counter last).
43  *
44  * ioctl routines which change/remove dm_dev parameters must wait on
45  * dm_dev::dev_cv and when last user will call dm_dev_unbusy they will wake
46  * up them.
47  *
48  * table_head locking:
49  * To access table entries dm_table_* routines must be used.
50  *
51  * dm_table_get_entry will increment table users reference
52  * counter. It will return active or inactive table depends
53  * on uint8_t argument.
54  *
55  * dm_table_release must be called for every table_entry from
56  * dm_table_get_entry. Between these to calls tables can'tbe switched
57  * or destroyed.
58  *
59  * dm_table_head_init initialize talbe_entries SLISTS and io_cv.
60  *
61  * dm_table_head_destroy destroy cv.
62  *
63  * There are two types of users for dm_table_head first type will
64  * only read list and try to do anything with it e.g. dmstrategy,
65  * dm_table_size etc. There is another user for table_head which wants
66  * to change table lists e.g. dm_dev_resume_ioctl, dm_dev_remove_ioctl,
67  * dm_table_clear_ioctl.
68  *
69  * NOTE: It is not allowed to call dm_table_destroy, dm_table_switch_tables
70  *       with hold table reference counter. Table reference counter is hold
71  *       after calling dm_table_get_entry routine. After calling this
72  *       function user must call dm_table_release before any writer table
73  *       operation.
74  *
75  * Example: dm_table_get_entry
76  *          dm_table_destroy/dm_table_switch_tables
77  * This exaple will lead to deadlock situation because after dm_table_get_entry
78  * table reference counter is != 0 and dm_table_destroy have to wait on cv until
79  * reference counter is 0.
80  *
81  */
82 
83 #include <sys/types.h>
84 #include <sys/param.h>
85 
86 #include <sys/device.h>
87 #include <sys/disk.h>
88 #include <sys/disklabel.h>
89 #include <sys/kmem.h>
90 #include <sys/malloc.h>
91 #include <sys/vnode.h>
92 
93 #include <machine/int_fmtio.h>
94 
95 #include "netbsd-dm.h"
96 #include "dm.h"
97 
98 static uint32_t sc_minor_num;
99 extern const struct dkdriver dmdkdriver;
100 uint32_t dm_dev_counter;
101 
102 /* Generic cf_data for device-mapper driver */
103 static struct cfdata dm_cfdata = {
104 	.cf_name = "dm",
105 	.cf_atname = "dm",
106 	.cf_fstate = FSTATE_STAR,
107 	.cf_unit = 0
108 };
109 #define DM_REMOVE_FLAG(flag, name) do {					\
110 		prop_dictionary_get_uint32(dm_dict,DM_IOCTL_FLAGS,&flag); \
111 		flag &= ~name;						\
112 		prop_dictionary_set_uint32(dm_dict,DM_IOCTL_FLAGS,flag); \
113 } while (/*CONSTCOND*/0)
114 
115 #define DM_ADD_FLAG(flag, name) do {					\
116 		prop_dictionary_get_uint32(dm_dict,DM_IOCTL_FLAGS,&flag); \
117 		flag |= name;						\
118 		prop_dictionary_set_uint32(dm_dict,DM_IOCTL_FLAGS,flag); \
119 } while (/*CONSTCOND*/0)
120 
121 static int dm_dbg_print_flags(int);
122 
123 /*
124  * Print flags sent to the kernel from libevmapper.
125  */
126 static int
127 dm_dbg_print_flags(int flags)
128 {
129 	aprint_debug("dbg_print --- %d\n", flags);
130 
131 	if (flags & DM_READONLY_FLAG)
132 		aprint_debug("dbg_flags: DM_READONLY_FLAG set In/Out\n");
133 
134 	if (flags & DM_SUSPEND_FLAG)
135 		aprint_debug("dbg_flags: DM_SUSPEND_FLAG set In/Out \n");
136 
137 	if (flags & DM_PERSISTENT_DEV_FLAG)
138 		aprint_debug("db_flags: DM_PERSISTENT_DEV_FLAG set In\n");
139 
140 	if (flags & DM_STATUS_TABLE_FLAG)
141 		aprint_debug("dbg_flags: DM_STATUS_TABLE_FLAG set In\n");
142 
143 	if (flags & DM_ACTIVE_PRESENT_FLAG)
144 		aprint_debug("dbg_flags: DM_ACTIVE_PRESENT_FLAG set Out\n");
145 
146 	if (flags & DM_INACTIVE_PRESENT_FLAG)
147 		aprint_debug("dbg_flags: DM_INACTIVE_PRESENT_FLAG set Out\n");
148 
149 	if (flags & DM_BUFFER_FULL_FLAG)
150 		aprint_debug("dbg_flags: DM_BUFFER_FULL_FLAG set Out\n");
151 
152 	if (flags & DM_SKIP_BDGET_FLAG)
153 		aprint_debug("dbg_flags: DM_SKIP_BDGET_FLAG set In\n");
154 
155 	if (flags & DM_SKIP_LOCKFS_FLAG)
156 		aprint_debug("dbg_flags: DM_SKIP_LOCKFS_FLAG set In\n");
157 
158 	if (flags & DM_NOFLUSH_FLAG)
159 		aprint_debug("dbg_flags: DM_NOFLUSH_FLAG set In\n");
160 
161 	return 0;
162 }
163 
164 /*
165  * Get version ioctl call I do it as default therefore this
166  * function is unused now.
167  */
168 int
169 dm_get_version_ioctl(prop_dictionary_t dm_dict)
170 {
171 
172 	return 0;
173 }
174 
175 /*
176  * Get list of all available targets from global
177  * target list and sent them back to libdevmapper.
178  */
179 int
180 dm_list_versions_ioctl(prop_dictionary_t dm_dict)
181 {
182 	prop_array_t target_list;
183 	uint32_t flags;
184 
185 	flags = 0;
186 
187 	prop_dictionary_get_uint32(dm_dict, DM_IOCTL_FLAGS, &flags);
188 
189 	dm_dbg_print_flags(flags);
190 	target_list = dm_target_prop_list();
191 
192 	prop_dictionary_set(dm_dict, DM_IOCTL_CMD_DATA, target_list);
193 	prop_object_release(target_list);
194 
195 	return 0;
196 }
197 
198 /*
199  * Create in-kernel entry for device. Device attributes such as name, uuid are
200  * taken from proplib dictionary.
201  *
202  */
203 int
204 dm_dev_create_ioctl(prop_dictionary_t dm_dict)
205 {
206 	dm_dev_t *dmv;
207 	const char *name, *uuid;
208 	int r;
209 	uint32_t flags;
210 	device_t devt;
211 
212 	r = 0;
213 	flags = 0;
214 	name = NULL;
215 	uuid = NULL;
216 
217 	/* Get needed values from dictionary. */
218 	prop_dictionary_get_cstring_nocopy(dm_dict, DM_IOCTL_NAME, &name);
219 	prop_dictionary_get_cstring_nocopy(dm_dict, DM_IOCTL_UUID, &uuid);
220 	prop_dictionary_get_uint32(dm_dict, DM_IOCTL_FLAGS, &flags);
221 
222 	dm_dbg_print_flags(flags);
223 
224 	/* Lookup name and uuid if device already exist quit. */
225 	if ((dmv = dm_dev_lookup(name, uuid, -1)) != NULL) {
226 		DM_ADD_FLAG(flags, DM_EXISTS_FLAG);	/* Device already exists */
227 		dm_dev_unbusy(dmv);
228 		return EEXIST;
229 	}
230 	if ((devt = config_attach_pseudo(&dm_cfdata)) == NULL) {
231 		aprint_error("Unable to attach pseudo device dm/%s\n", name);
232 		return (ENOMEM);
233 	}
234 	if ((dmv = dm_dev_alloc()) == NULL)
235 		return ENOMEM;
236 
237 	if (uuid)
238 		strncpy(dmv->uuid, uuid, DM_UUID_LEN);
239 	else
240 		dmv->uuid[0] = '\0';
241 
242 	if (name)
243 		strlcpy(dmv->name, name, DM_NAME_LEN);
244 
245 	dmv->minor = (uint64_t)atomic_inc_32_nv(&sc_minor_num);
246 	dmv->flags = 0;		/* device flags are set when needed */
247 	dmv->ref_cnt = 0;
248 	dmv->event_nr = 0;
249 	dmv->dev_type = 0;
250 	dmv->devt = devt;
251 
252 	dm_table_head_init(&dmv->table_head);
253 
254 	mutex_init(&dmv->dev_mtx, MUTEX_DEFAULT, IPL_NONE);
255 	mutex_init(&dmv->diskp_mtx, MUTEX_DEFAULT, IPL_NONE);
256 	cv_init(&dmv->dev_cv, "dm_dev");
257 
258 	if (flags & DM_READONLY_FLAG)
259 		dmv->flags |= DM_READONLY_FLAG;
260 
261 	prop_dictionary_set_uint32(dm_dict, DM_IOCTL_MINOR, dmv->minor);
262 
263 	disk_init(dmv->diskp, dmv->name, &dmdkdriver);
264 	disk_attach(dmv->diskp);
265 
266 	dmv->diskp->dk_info = NULL;
267 
268 	if ((r = dm_dev_insert(dmv)) != 0)
269 		dm_dev_free(dmv);
270 
271 	DM_ADD_FLAG(flags, DM_EXISTS_FLAG);
272 	DM_REMOVE_FLAG(flags, DM_INACTIVE_PRESENT_FLAG);
273 
274 	/* Increment device counter After creating device */
275 	atomic_inc_32(&dm_dev_counter);
276 
277 	return r;
278 }
279 
280 /*
281  * Get list of created device-mapper devices fromglobal list and
282  * send it to kernel.
283  *
284  * Output dictionary:
285  *
286  * <key>cmd_data</key>
287  *  <array>
288  *   <dict>
289  *    <key>name<key>
290  *    <string>...</string>
291  *
292  *    <key>dev</key>
293  *    <integer>...</integer>
294  *   </dict>
295  *  </array>
296  *
297  */
298 int
299 dm_dev_list_ioctl(prop_dictionary_t dm_dict)
300 {
301 	prop_array_t dev_list;
302 
303 	uint32_t flags;
304 
305 	flags = 0;
306 
307 	prop_dictionary_get_uint32(dm_dict, DM_IOCTL_FLAGS, &flags);
308 
309 	dm_dbg_print_flags(flags);
310 
311 	dev_list = dm_dev_prop_list();
312 
313 	prop_dictionary_set(dm_dict, DM_IOCTL_CMD_DATA, dev_list);
314 	prop_object_release(dev_list);
315 
316 	return 0;
317 }
318 
319 /*
320  * Rename selected devices old name is in struct dm_ioctl.
321  * newname is taken from dictionary
322  *
323  * <key>cmd_data</key>
324  *  <array>
325  *   <string>...</string>
326  *  </array>
327  */
328 int
329 dm_dev_rename_ioctl(prop_dictionary_t dm_dict)
330 {
331 	prop_array_t cmd_array;
332 	dm_dev_t *dmv;
333 
334 	const char *name, *uuid, *n_name;
335 	uint32_t flags, minor;
336 
337 	name = NULL;
338 	uuid = NULL;
339 	minor = 0;
340 
341 	/* Get needed values from dictionary. */
342 	prop_dictionary_get_cstring_nocopy(dm_dict, DM_IOCTL_NAME, &name);
343 	prop_dictionary_get_cstring_nocopy(dm_dict, DM_IOCTL_UUID, &uuid);
344 	prop_dictionary_get_uint32(dm_dict, DM_IOCTL_FLAGS, &flags);
345 	prop_dictionary_get_uint32(dm_dict, DM_IOCTL_MINOR, &minor);
346 
347 	dm_dbg_print_flags(flags);
348 
349 	cmd_array = prop_dictionary_get(dm_dict, DM_IOCTL_CMD_DATA);
350 
351 	prop_array_get_cstring_nocopy(cmd_array, 0, &n_name);
352 
353 	if (strlen(n_name) + 1 > DM_NAME_LEN)
354 		return EINVAL;
355 
356 	if ((dmv = dm_dev_rem(name, uuid, minor)) == NULL) {
357 		DM_REMOVE_FLAG(flags, DM_EXISTS_FLAG);
358 		return ENOENT;
359 	}
360 	/* change device name */
361 	/*
362 	 * XXX How to deal with this change, name only used in
363 	 * dm_dev_routines, should I add dm_dev_change_name which will run
364 	 * under the dm_dev_list mutex ?
365 	 */
366 	strlcpy(dmv->name, n_name, DM_NAME_LEN);
367 
368 	prop_dictionary_set_uint32(dm_dict, DM_IOCTL_OPEN, dmv->table_head.io_cnt);
369 	prop_dictionary_set_uint32(dm_dict, DM_IOCTL_MINOR, dmv->minor);
370 	prop_dictionary_set_cstring(dm_dict, DM_IOCTL_UUID, dmv->uuid);
371 
372 	dm_dev_insert(dmv);
373 
374 	return 0;
375 }
376 
377 /*
378  * Remove device from global list I have to remove active
379  * and inactive tables first.
380  */
381 int
382 dm_dev_remove_ioctl(prop_dictionary_t dm_dict)
383 {
384 	dm_dev_t *dmv;
385 	const char *name, *uuid;
386 	uint32_t flags, minor;
387 	device_t devt;
388 
389 	flags = 0;
390 	name = NULL;
391 	uuid = NULL;
392 
393 	/* Get needed values from dictionary. */
394 	prop_dictionary_get_cstring_nocopy(dm_dict, DM_IOCTL_NAME, &name);
395 	prop_dictionary_get_cstring_nocopy(dm_dict, DM_IOCTL_UUID, &uuid);
396 	prop_dictionary_get_uint32(dm_dict, DM_IOCTL_FLAGS, &flags);
397 	prop_dictionary_get_uint32(dm_dict, DM_IOCTL_MINOR, &minor);
398 
399 	dm_dbg_print_flags(flags);
400 
401 	/*
402 	 * This seems as hack to me, probably use routine dm_dev_get_devt to
403 	 * atomicaly get devt from device.
404 	 */
405 	if ((dmv = dm_dev_lookup(name, uuid, minor)) == NULL) {
406 		DM_REMOVE_FLAG(flags, DM_EXISTS_FLAG);
407 		return ENOENT;
408 	}
409 	devt = dmv->devt;
410 
411 	dm_dev_unbusy(dmv);
412 
413 	/*
414 	 * This will call dm_detach routine which will actually removes
415 	 * device.
416 	 */
417 	return config_detach(devt, DETACH_QUIET);
418 }
419 
420 /*
421  * Return actual state of device to libdevmapper.
422  */
423 int
424 dm_dev_status_ioctl(prop_dictionary_t dm_dict)
425 {
426 	dm_dev_t *dmv;
427 	const char *name, *uuid;
428 	uint32_t flags, j, minor;
429 
430 	name = NULL;
431 	uuid = NULL;
432 	flags = 0;
433 	j = 0;
434 
435 	prop_dictionary_get_cstring_nocopy(dm_dict, DM_IOCTL_NAME, &name);
436 	prop_dictionary_get_cstring_nocopy(dm_dict, DM_IOCTL_UUID, &uuid);
437 	prop_dictionary_get_uint32(dm_dict, DM_IOCTL_FLAGS, &flags);
438 	prop_dictionary_get_uint32(dm_dict, DM_IOCTL_MINOR, &minor);
439 
440 	if ((dmv = dm_dev_lookup(name, uuid, minor)) == NULL) {
441 		DM_REMOVE_FLAG(flags, DM_EXISTS_FLAG);
442 		return ENOENT;
443 	}
444 	dm_dbg_print_flags(dmv->flags);
445 
446 	prop_dictionary_set_uint32(dm_dict, DM_IOCTL_OPEN, dmv->table_head.io_cnt);
447 	prop_dictionary_set_uint32(dm_dict, DM_IOCTL_MINOR, dmv->minor);
448 	prop_dictionary_set_cstring(dm_dict, DM_IOCTL_UUID, dmv->uuid);
449 
450 	if (dmv->flags & DM_SUSPEND_FLAG)
451 		DM_ADD_FLAG(flags, DM_SUSPEND_FLAG);
452 
453 	/*
454 	 * Add status flags for tables I have to check both active and
455 	 * inactive tables.
456 	 */
457 	if ((j = dm_table_get_target_count(&dmv->table_head, DM_TABLE_ACTIVE))) {
458 		DM_ADD_FLAG(flags, DM_ACTIVE_PRESENT_FLAG);
459 	} else
460 		DM_REMOVE_FLAG(flags, DM_ACTIVE_PRESENT_FLAG);
461 
462 	prop_dictionary_set_uint32(dm_dict, DM_IOCTL_TARGET_COUNT, j);
463 
464 	if (dm_table_get_target_count(&dmv->table_head, DM_TABLE_INACTIVE))
465 		DM_ADD_FLAG(flags, DM_INACTIVE_PRESENT_FLAG);
466 	else
467 		DM_REMOVE_FLAG(flags, DM_INACTIVE_PRESENT_FLAG);
468 
469 	dm_dev_unbusy(dmv);
470 
471 	return 0;
472 }
473 
474 /*
475  * Set only flag to suggest that device is suspended. This call is
476  * not supported in NetBSD.
477  *
478  */
479 int
480 dm_dev_suspend_ioctl(prop_dictionary_t dm_dict)
481 {
482 	dm_dev_t *dmv;
483 	const char *name, *uuid;
484 	uint32_t flags, minor;
485 
486 	name = NULL;
487 	uuid = NULL;
488 	flags = 0;
489 
490 	prop_dictionary_get_cstring_nocopy(dm_dict, DM_IOCTL_NAME, &name);
491 	prop_dictionary_get_cstring_nocopy(dm_dict, DM_IOCTL_UUID, &uuid);
492 	prop_dictionary_get_uint32(dm_dict, DM_IOCTL_FLAGS, &flags);
493 	prop_dictionary_get_uint32(dm_dict, DM_IOCTL_MINOR, &minor);
494 
495 	if ((dmv = dm_dev_lookup(name, uuid, minor)) == NULL) {
496 		DM_REMOVE_FLAG(flags, DM_EXISTS_FLAG);
497 		return ENOENT;
498 	}
499 	atomic_or_32(&dmv->flags, DM_SUSPEND_FLAG);
500 
501 	dm_dbg_print_flags(dmv->flags);
502 
503 	prop_dictionary_set_uint32(dm_dict, DM_IOCTL_OPEN, dmv->table_head.io_cnt);
504 	prop_dictionary_set_uint32(dm_dict, DM_IOCTL_FLAGS, dmv->flags);
505 	prop_dictionary_set_uint32(dm_dict, DM_IOCTL_MINOR, dmv->minor);
506 
507 	dm_dev_unbusy(dmv);
508 
509 	/* Add flags to dictionary flag after dmv -> dict copy */
510 	DM_ADD_FLAG(flags, DM_EXISTS_FLAG);
511 
512 	return 0;
513 }
514 
515 /*
516  * Simulate Linux behaviour better and switch tables here and not in
517  * dm_table_load_ioctl.
518  */
519 int
520 dm_dev_resume_ioctl(prop_dictionary_t dm_dict)
521 {
522 	dm_dev_t *dmv;
523 	const char *name, *uuid;
524 	uint32_t flags, minor;
525 
526 	name = NULL;
527 	uuid = NULL;
528 	flags = 0;
529 
530 	/*
531 	 * char *xml; xml = prop_dictionary_externalize(dm_dict);
532 	 * printf("%s\n",xml);
533 	 */
534 
535 	prop_dictionary_get_cstring_nocopy(dm_dict, DM_IOCTL_NAME, &name);
536 	prop_dictionary_get_cstring_nocopy(dm_dict, DM_IOCTL_UUID, &uuid);
537 	prop_dictionary_get_uint32(dm_dict, DM_IOCTL_FLAGS, &flags);
538 	prop_dictionary_get_uint32(dm_dict, DM_IOCTL_MINOR, &minor);
539 
540 	/* Remove device from global device list */
541 	if ((dmv = dm_dev_lookup(name, uuid, minor)) == NULL) {
542 		DM_REMOVE_FLAG(flags, DM_EXISTS_FLAG);
543 		return ENOENT;
544 	}
545 	atomic_and_32(&dmv->flags, ~(DM_SUSPEND_FLAG | DM_INACTIVE_PRESENT_FLAG));
546 	atomic_or_32(&dmv->flags, DM_ACTIVE_PRESENT_FLAG);
547 
548 	dm_table_switch_tables(&dmv->table_head);
549 
550 	DM_ADD_FLAG(flags, DM_EXISTS_FLAG);
551 
552 	dmgetproperties(dmv->diskp, &dmv->table_head);
553 
554 	prop_dictionary_set_uint32(dm_dict, DM_IOCTL_OPEN, dmv->table_head.io_cnt);
555 	prop_dictionary_set_uint32(dm_dict, DM_IOCTL_FLAGS, flags);
556 	prop_dictionary_set_uint32(dm_dict, DM_IOCTL_MINOR, dmv->minor);
557 
558 	dm_dev_unbusy(dmv);
559 
560 	/* Destroy inactive table after resume. */
561 	dm_table_destroy(&dmv->table_head, DM_TABLE_INACTIVE);
562 
563 	return 0;
564 }
565 
566 /*
567  * Table management routines
568  * lvm2tools doens't send name/uuid to kernel with table
569  * for lookup I have to use minor number.
570  */
571 
572 /*
573  * Remove inactive table from device. Routines which work's with inactive tables
574  * doesn't need to synchronise with dmstrategy. They can synchronise themselves with mutex?.
575  *
576  */
577 int
578 dm_table_clear_ioctl(prop_dictionary_t dm_dict)
579 {
580 	dm_dev_t *dmv;
581 	const char *name, *uuid;
582 	uint32_t flags, minor;
583 
584 	dmv = NULL;
585 	name = NULL;
586 	uuid = NULL;
587 	flags = 0;
588 	minor = 0;
589 
590 	prop_dictionary_get_cstring_nocopy(dm_dict, DM_IOCTL_NAME, &name);
591 	prop_dictionary_get_cstring_nocopy(dm_dict, DM_IOCTL_UUID, &uuid);
592 	prop_dictionary_get_uint32(dm_dict, DM_IOCTL_FLAGS, &flags);
593 	prop_dictionary_get_uint32(dm_dict, DM_IOCTL_MINOR, &minor);
594 
595 	aprint_debug("Clearing inactive table from device: %s--%s\n",
596 	    name, uuid);
597 
598 	if ((dmv = dm_dev_lookup(name, uuid, minor)) == NULL) {
599 		DM_REMOVE_FLAG(flags, DM_EXISTS_FLAG);
600 		return ENOENT;
601 	}
602 	/* Select unused table */
603 	dm_table_destroy(&dmv->table_head, DM_TABLE_INACTIVE);
604 
605 	atomic_and_32(&dmv->flags, ~DM_INACTIVE_PRESENT_FLAG);
606 
607 	dm_dev_unbusy(dmv);
608 
609 	return 0;
610 }
611 
612 /*
613  * Get list of physical devices for active table.
614  * Get dev_t from pdev vnode and insert it into cmd_array.
615  *
616  * XXX. This function is called from lvm2tools to get information
617  *      about physical devices, too e.g. during vgcreate.
618  */
619 int
620 dm_table_deps_ioctl(prop_dictionary_t dm_dict)
621 {
622 	dm_dev_t *dmv;
623 	dm_table_t *tbl;
624 	dm_table_entry_t *table_en;
625 
626 	prop_array_t cmd_array;
627 	const char *name, *uuid;
628 	uint32_t flags, minor;
629 
630 	int table_type;
631 
632 	name = NULL;
633 	uuid = NULL;
634 	dmv = NULL;
635 	flags = 0;
636 
637 	prop_dictionary_get_cstring_nocopy(dm_dict, DM_IOCTL_NAME, &name);
638 	prop_dictionary_get_cstring_nocopy(dm_dict, DM_IOCTL_UUID, &uuid);
639 	prop_dictionary_get_uint32(dm_dict, DM_IOCTL_FLAGS, &flags);
640 	prop_dictionary_get_uint32(dm_dict, DM_IOCTL_MINOR, &minor);
641 
642 	/* create array for dev_t's */
643 	cmd_array = prop_array_create();
644 
645 	if ((dmv = dm_dev_lookup(name, uuid, minor)) == NULL) {
646 		DM_REMOVE_FLAG(flags, DM_EXISTS_FLAG);
647 		return ENOENT;
648 	}
649 	prop_dictionary_set_uint32(dm_dict, DM_IOCTL_MINOR, dmv->minor);
650 	prop_dictionary_set_cstring(dm_dict, DM_IOCTL_NAME, dmv->name);
651 	prop_dictionary_set_cstring(dm_dict, DM_IOCTL_UUID, dmv->uuid);
652 
653 	aprint_debug("Getting table deps for device: %s\n", dmv->name);
654 
655 	/*
656 	 * if DM_QUERY_INACTIVE_TABLE_FLAG is passed we need to query
657 	 * INACTIVE TABLE
658 	 */
659 	if (flags & DM_QUERY_INACTIVE_TABLE_FLAG)
660 		table_type = DM_TABLE_INACTIVE;
661 	else
662 		table_type = DM_TABLE_ACTIVE;
663 
664 	tbl = dm_table_get_entry(&dmv->table_head, table_type);
665 
666 	SLIST_FOREACH(table_en, tbl, next)
667 	    table_en->target->deps(table_en, cmd_array);
668 
669 	dm_table_release(&dmv->table_head, table_type);
670 	dm_dev_unbusy(dmv);
671 
672 	prop_dictionary_set(dm_dict, DM_IOCTL_CMD_DATA, cmd_array);
673 	prop_object_release(cmd_array);
674 
675 	return 0;
676 }
677 
678 /*
679  * Load new table/tables to device.
680  * Call apropriate target init routine open all physical pdev's and
681  * link them to device. For other targets mirror, strip, snapshot
682  * etc. also add dependency devices to upcalls list.
683  *
684  * Load table to inactive slot table are switched in dm_device_resume_ioctl.
685  * This simulates Linux behaviour better there should not be any difference.
686  *
687  */
688 int
689 dm_table_load_ioctl(prop_dictionary_t dm_dict)
690 {
691 	dm_dev_t *dmv;
692 	dm_table_entry_t *table_en, *last_table;
693 	dm_table_t *tbl;
694 	dm_target_t *target;
695 
696 	prop_object_iterator_t iter;
697 	prop_array_t cmd_array;
698 	prop_dictionary_t target_dict;
699 
700 	const char *name, *uuid, *type;
701 
702 	uint32_t flags, ret, minor;
703 
704 	char *str;
705 
706 	ret = 0;
707 	flags = 0;
708 	name = NULL;
709 	uuid = NULL;
710 	dmv = NULL;
711 	last_table = NULL;
712 	str = NULL;
713 
714 	/*
715 	 * char *xml; xml = prop_dictionary_externalize(dm_dict);
716 	 * printf("%s\n",xml);
717 	 */
718 
719 	prop_dictionary_get_cstring_nocopy(dm_dict, DM_IOCTL_NAME, &name);
720 	prop_dictionary_get_cstring_nocopy(dm_dict, DM_IOCTL_UUID, &uuid);
721 	prop_dictionary_get_uint32(dm_dict, DM_IOCTL_FLAGS, &flags);
722 	prop_dictionary_get_uint32(dm_dict, DM_IOCTL_MINOR, &minor);
723 
724 	cmd_array = prop_dictionary_get(dm_dict, DM_IOCTL_CMD_DATA);
725 	iter = prop_array_iterator(cmd_array);
726 	dm_dbg_print_flags(flags);
727 
728 	if ((dmv = dm_dev_lookup(name, uuid, minor)) == NULL) {
729 		DM_REMOVE_FLAG(flags, DM_EXISTS_FLAG);
730 		prop_object_iterator_release(iter);
731 		return ENOENT;
732 	}
733 	aprint_debug("Loading table to device: %s--%d\n", name,
734 	    dmv->table_head.cur_active_table);
735 
736 	/*
737 	 * I have to check if this table slot is not used by another table list.
738 	 * if it is used I should free them.
739 	 */
740 	if (dmv->flags & DM_INACTIVE_PRESENT_FLAG)
741 		dm_table_destroy(&dmv->table_head, DM_TABLE_INACTIVE);
742 
743 	dm_dbg_print_flags(dmv->flags);
744 	tbl = dm_table_get_entry(&dmv->table_head, DM_TABLE_INACTIVE);
745 
746 	aprint_debug("dmv->name = %s\n", dmv->name);
747 
748 	prop_dictionary_set_uint32(dm_dict, DM_IOCTL_MINOR, dmv->minor);
749 
750 	while ((target_dict = prop_object_iterator_next(iter)) != NULL) {
751 
752 		prop_dictionary_get_cstring_nocopy(target_dict,
753 		    DM_TABLE_TYPE, &type);
754 		/*
755 		 * If we want to deny table with 2 or more different
756 		 * target we should do it here
757 		 */
758 		if (((target = dm_target_lookup(type)) == NULL) &&
759 		    ((target = dm_target_autoload(type)) == NULL)) {
760 			dm_table_release(&dmv->table_head, DM_TABLE_INACTIVE);
761 			dm_dev_unbusy(dmv);
762 			prop_object_iterator_release(iter);
763 			return ENOENT;
764 		}
765 		table_en = kmem_alloc(sizeof(dm_table_entry_t), KM_SLEEP);
766 		prop_dictionary_get_uint64(target_dict, DM_TABLE_START,
767 		    &table_en->start);
768 		prop_dictionary_get_uint64(target_dict, DM_TABLE_LENGTH,
769 		    &table_en->length);
770 
771 		table_en->target = target;
772 		table_en->dm_dev = dmv;
773 		table_en->target_config = NULL;
774 
775 		/*
776 		 * There is a parameter string after dm_target_spec
777 		 * structure which  points to /dev/wd0a 284 part of
778 		 * table. String str points to this text. This can be
779 		 * null and therefore it should be checked before we try to
780 		 * use it.
781 		 */
782 		prop_dictionary_get_cstring(target_dict,
783 		    DM_TABLE_PARAMS, (char **) &str);
784 
785 		if (SLIST_EMPTY(tbl) || last_table == NULL)
786 			/* insert this table to head */
787 			SLIST_INSERT_HEAD(tbl, table_en, next);
788 		else
789 			SLIST_INSERT_AFTER(last_table, table_en, next);
790 
791 		/*
792 		 * Params string is different for every target,
793 		 * therfore I have to pass it to target init
794 		 * routine and parse parameters there.
795 		 */
796 
797 		if ((ret = target->init(dmv, &table_en->target_config,
798 			    str)) != 0) {
799 
800 			dm_table_release(&dmv->table_head, DM_TABLE_INACTIVE);
801 			dm_table_destroy(&dmv->table_head, DM_TABLE_INACTIVE);
802 			free(str, M_TEMP);
803 
804 			dm_dev_unbusy(dmv);
805 			prop_object_iterator_release(iter);
806 			return ret;
807 		}
808 		last_table = table_en;
809 		free(str, M_TEMP);
810 	}
811 	prop_object_iterator_release(iter);
812 
813 	DM_ADD_FLAG(flags, DM_INACTIVE_PRESENT_FLAG);
814 	atomic_or_32(&dmv->flags, DM_INACTIVE_PRESENT_FLAG);
815 
816 	dm_table_release(&dmv->table_head, DM_TABLE_INACTIVE);
817 	dm_dev_unbusy(dmv);
818 	return 0;
819 }
820 
821 /*
822  * Get description of all tables loaded to device from kernel
823  * and send it to libdevmapper.
824  *
825  * Output dictionary for every table:
826  *
827  * <key>cmd_data</key>
828  * <array>
829  *   <dict>
830  *    <key>type<key>
831  *    <string>...</string>
832  *
833  *    <key>start</key>
834  *    <integer>...</integer>
835  *
836  *    <key>length</key>
837  *    <integer>...</integer>
838  *
839  *    <key>params</key>
840  *    <string>...</string>
841  *   </dict>
842  * </array>
843  *
844  */
845 int
846 dm_table_status_ioctl(prop_dictionary_t dm_dict)
847 {
848 	dm_dev_t *dmv;
849 	dm_table_t *tbl;
850 	dm_table_entry_t *table_en;
851 
852 	prop_array_t cmd_array;
853 	prop_dictionary_t target_dict;
854 
855 	uint32_t minor, flags;
856 
857 	const char *name, *uuid;
858 	char *params;
859 	int table_type;
860 
861 	dmv = NULL;
862 	uuid = NULL;
863 	name = NULL;
864 	params = NULL;
865 	flags = 0;
866 
867 	prop_dictionary_get_cstring_nocopy(dm_dict, DM_IOCTL_NAME, &name);
868 	prop_dictionary_get_cstring_nocopy(dm_dict, DM_IOCTL_UUID, &uuid);
869 	prop_dictionary_get_uint32(dm_dict, DM_IOCTL_FLAGS, &flags);
870 	prop_dictionary_get_uint32(dm_dict, DM_IOCTL_MINOR, &minor);
871 
872 	cmd_array = prop_array_create();
873 
874 	if ((dmv = dm_dev_lookup(name, uuid, minor)) == NULL) {
875 		DM_REMOVE_FLAG(flags, DM_EXISTS_FLAG);
876 		return ENOENT;
877 	}
878 	/*
879 	 * if DM_QUERY_INACTIVE_TABLE_FLAG is passed we need to query
880 	 * INACTIVE TABLE
881 	 */
882 	if (flags & DM_QUERY_INACTIVE_TABLE_FLAG)
883 		table_type = DM_TABLE_INACTIVE;
884 	else
885 		table_type = DM_TABLE_ACTIVE;
886 
887 	if (dm_table_get_target_count(&dmv->table_head, DM_TABLE_ACTIVE))
888 		DM_ADD_FLAG(flags, DM_ACTIVE_PRESENT_FLAG);
889 	else {
890 		DM_REMOVE_FLAG(flags, DM_ACTIVE_PRESENT_FLAG);
891 
892 		if (dm_table_get_target_count(&dmv->table_head, DM_TABLE_INACTIVE))
893 			DM_ADD_FLAG(flags, DM_INACTIVE_PRESENT_FLAG);
894 		else {
895 			DM_REMOVE_FLAG(flags, DM_INACTIVE_PRESENT_FLAG);
896 		}
897 	}
898 
899 	if (dmv->flags & DM_SUSPEND_FLAG)
900 		DM_ADD_FLAG(flags, DM_SUSPEND_FLAG);
901 
902 	prop_dictionary_set_uint32(dm_dict, DM_IOCTL_MINOR, dmv->minor);
903 
904 	aprint_debug("Status of device tables: %s--%d\n",
905 	    name, dmv->table_head.cur_active_table);
906 
907 	tbl = dm_table_get_entry(&dmv->table_head, table_type);
908 
909 	SLIST_FOREACH(table_en, tbl, next) {
910 		target_dict = prop_dictionary_create();
911 		aprint_debug("%016" PRIu64 ", length %016" PRIu64
912 		    ", target %s\n", table_en->start, table_en->length,
913 		    table_en->target->name);
914 
915 		prop_dictionary_set_uint64(target_dict, DM_TABLE_START,
916 		    table_en->start);
917 		prop_dictionary_set_uint64(target_dict, DM_TABLE_LENGTH,
918 		    table_en->length);
919 
920 		prop_dictionary_set_cstring(target_dict, DM_TABLE_TYPE,
921 		    table_en->target->name);
922 
923 		/* dm_table_get_cur_actv.table ?? */
924 		prop_dictionary_set_int32(target_dict, DM_TABLE_STAT,
925 		    dmv->table_head.cur_active_table);
926 
927 		if (flags & DM_STATUS_TABLE_FLAG) {
928 			params = table_en->target->status
929 			    (table_en->target_config);
930 
931 			if (params != NULL) {
932 				prop_dictionary_set_cstring(target_dict,
933 				    DM_TABLE_PARAMS, params);
934 
935 				kmem_free(params, DM_MAX_PARAMS_SIZE);
936 			}
937 		}
938 		prop_array_add(cmd_array, target_dict);
939 		prop_object_release(target_dict);
940 	}
941 
942 	dm_table_release(&dmv->table_head, table_type);
943 	dm_dev_unbusy(dmv);
944 
945 	prop_dictionary_set_uint32(dm_dict, DM_IOCTL_FLAGS, flags);
946 	prop_dictionary_set(dm_dict, DM_IOCTL_CMD_DATA, cmd_array);
947 	prop_object_release(cmd_array);
948 
949 	return 0;
950 }
951 
952 /*
953  * For every call I have to set kernel driver version.
954  * Because I can have commands supported only in other
955  * newer/later version. This routine is called for every
956  * ioctl command.
957  */
958 int
959 dm_check_version(prop_dictionary_t dm_dict)
960 {
961 	size_t i;
962 	uint32_t dm_version[3];
963 	prop_array_t ver;
964 
965 	ver = prop_dictionary_get(dm_dict, DM_IOCTL_VERSION);
966 
967 	for (i = 0; i < 3; i++)
968 		prop_array_get_uint32(ver, i, &dm_version[i]);
969 
970 	if (DM_VERSION_MAJOR != dm_version[0] || DM_VERSION_MINOR < dm_version[1]) {
971 		aprint_debug("libdevmapper/kernel version mismatch "
972 		    "kernel: %d.%d.%d libdevmapper: %d.%d.%d\n",
973 		    DM_VERSION_MAJOR, DM_VERSION_MINOR, DM_VERSION_PATCHLEVEL,
974 		    dm_version[0], dm_version[1], dm_version[2]);
975 
976 		return EIO;
977 	}
978 	prop_array_set_uint32(ver, 0, DM_VERSION_MAJOR);
979 	prop_array_set_uint32(ver, 1, DM_VERSION_MINOR);
980 	prop_array_set_uint32(ver, 2, DM_VERSION_PATCHLEVEL);
981 
982 	prop_dictionary_set(dm_dict, DM_IOCTL_VERSION, ver);
983 
984 	return 0;
985 }
986