1 /* $NetBSD: dm.h,v 1.17 2009/12/29 23:37:48 haad Exp $ */
4 * Copyright (c) 2008 The NetBSD Foundation, Inc.
7 * This code is derived from software contributed to The NetBSD Foundation
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
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.
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.
38 #include <sys/errno.h>
39 #include <sys/systm.h>
40 #include <sys/kernel.h>
42 #include <cpu/inttypes.h>
43 #include <cpu/atomic.h>
44 #include <sys/condvar.h>
46 #include <sys/queue.h>
48 #include <sys/device.h>
49 #include <sys/devicestat.h>
50 #include <sys/diskslice.h>
51 #include <sys/disklabel.h>
53 #include <libprop/proplib.h>
55 #define DM_MAX_TYPE_NAME 16
56 #define DM_NAME_LEN 128
57 #define DM_UUID_LEN 129
59 #define DM_VERSION_MAJOR 4
60 #define DM_VERSION_MINOR 16
62 #define DM_VERSION_PATCHLEVEL 0
64 /*** Internal device-mapper structures ***/
67 * A table entry describes a physical range of the logical volume.
69 #define MAX_TARGET_STRING_LEN 32
72 * A device mapper table is a list of physical ranges plus the mapping target
78 typedef struct dm_table_entry {
79 struct dm_dev *dm_dev; /* backlink */
83 struct dm_target *target; /* Link to table target. */
84 void *target_config; /* Target specific data. */
85 SLIST_ENTRY(dm_table_entry) next;
88 SLIST_HEAD(dm_table, dm_table_entry);
90 typedef struct dm_table dm_table_t;
92 typedef struct dm_table_head {
93 /* Current active table is selected with this. */
95 struct dm_table tables[2];
97 struct lock table_mtx;
102 #define MAX_DEV_NAME 32
105 * This structure is used to store opened vnodes for disk with name.
106 * I need this because devices can be opened only once, but I can
107 * have more then one device on one partition.
110 typedef struct dm_pdev {
111 char name[MAX_DEV_NAME];
112 struct partinfo pdev_pinfo; /* partinfo of the underlying device */
114 struct vnode *pdev_vnode;
115 int ref_cnt; /* reference counter for users ofthis pdev */
117 SLIST_ENTRY(dm_pdev) next_pdev;
121 * This structure is called for every device-mapper device.
122 * It points to SLIST of device tables and mirrored, snapshoted etc. devices.
124 TAILQ_HEAD(dm_dev_head, dm_dev);
126 typedef struct dm_dev {
127 char name[DM_NAME_LEN];
128 char uuid[DM_UUID_LEN];
130 cdev_t devt; /* pointer to autoconf device_t structure */
132 uint32_t flags; /* store communication protocol flags */
134 struct lock dev_mtx; /* mutex for generall device lock */
135 struct cv dev_cv; /* cv for between ioctl synchronisation */
143 dm_table_head_t table_head;
145 struct dm_dev_head upcalls;
149 struct devstat stats;
151 TAILQ_ENTRY(dm_dev) next_upcall; /* LIST of mirrored, snapshoted devices. */
153 TAILQ_ENTRY(dm_dev) next_devlist; /* Major device list. */
156 /* Device types used for upcalls */
157 #define DM_ZERO_DEV (1 << 0)
158 #define DM_ERROR_DEV (1 << 1)
159 #define DM_LINEAR_DEV (1 << 2)
160 #define DM_MIRROR_DEV (1 << 3)
161 #define DM_STRIPE_DEV (1 << 4)
162 #define DM_SNAPSHOT_DEV (1 << 5)
163 #define DM_SNAPSHOT_ORIG_DEV (1 << 6)
164 #define DM_SPARE_DEV (1 << 7)
165 /* Set this device type only during dev remove ioctl. */
166 #define DM_DELETING_DEV (1 << 8)
167 #define DM_CRYPTO_DEV (1 << 9)
168 #define DM_RAID1_DEV (1 << 10)
170 /* for zero, error : dm_target->target_config == NULL */
173 * Target config is initiated with target_init function.
177 typedef struct target_linear_config {
180 } dm_target_linear_config_t;
184 #define MAX_STRIPES 32
186 typedef struct target_stripe_config {
187 struct target_linear_config stripe_devs[MAX_STRIPES];
189 uint64_t stripe_chunksize;
190 } dm_target_stripe_config_t;
193 typedef struct target_mirror_config {
194 #define MAX_MIRROR_COPIES 4
196 dm_pdev_t *copies[MAX_MIRROR_COPIES];
198 /* copied blocks bitmaps administration etc*/
199 dm_pdev_t *log_pdev; /* for administration */
200 uint64_t log_regionsize; /* blocksize of mirror */
202 /* list of parts that still need copied etc.; run length encoded? */
203 } dm_target_mirror_config_t;
207 typedef struct target_snapshot_config {
208 dm_pdev_t *tsc_snap_dev;
209 /* cow dev is set only for persistent snapshot devices */
210 dm_pdev_t *tsc_cow_dev;
212 uint64_t tsc_chunk_size;
213 uint32_t tsc_persistent_dev;
214 } dm_target_snapshot_config_t;
216 /* for snapshot-origin devices */
217 typedef struct target_snapshot_origin_config {
218 dm_pdev_t *tsoc_real_dev;
219 /* list of snapshots ? */
220 } dm_target_snapshot_origin_config_t;
222 /* constant dm_target structures for error, zero, linear, stripes etc. */
223 typedef struct dm_target {
224 char name[DM_MAX_TYPE_NAME];
225 /* Initialize target_config area */
226 int (*init)(dm_dev_t *, void **, char *);
228 /* Message interface */
229 int (*message)(dm_table_entry_t *, char *);
231 /* Destroy target_config area */
232 int (*destroy)(dm_table_entry_t *);
234 int (*deps) (dm_table_entry_t *, prop_array_t);
236 * Status routine is called to get params string, which is target
237 * specific. When dm_table_status_ioctl is called with flag
238 * DM_STATUS_TABLE_FLAG I have to sent params string back.
240 char * (*status)(void *);
241 int (*strategy)(dm_table_entry_t *, struct buf *);
242 int (*upcall)(dm_table_entry_t *, struct buf *);
243 int (*dump)(dm_table_entry_t *, void *data, size_t length, off_t offset);
248 TAILQ_ENTRY(dm_target) dm_target_next;
251 /* Interface structures */
254 * This structure is used to translate command sent to kernel driver in
257 * to function which I can call.
259 struct cmd_function {
261 int (*fn)(prop_dictionary_t);
265 void dmsetdiskinfo(struct disk *, dm_table_head_t *);
266 int dm_detach(dm_dev_t *);
269 int dm_dev_create_ioctl(prop_dictionary_t);
270 int dm_dev_list_ioctl(prop_dictionary_t);
271 int dm_dev_remove_ioctl(prop_dictionary_t);
272 int dm_dev_remove_all_ioctl(prop_dictionary_t);
273 int dm_dev_rename_ioctl(prop_dictionary_t);
274 int dm_dev_resume_ioctl(prop_dictionary_t);
275 int dm_dev_status_ioctl(prop_dictionary_t);
276 int dm_dev_suspend_ioctl(prop_dictionary_t);
278 int dm_check_version(prop_dictionary_t);
279 int dm_get_version_ioctl(prop_dictionary_t);
280 int dm_list_versions_ioctl(prop_dictionary_t);
282 int dm_table_clear_ioctl(prop_dictionary_t);
283 int dm_table_deps_ioctl(prop_dictionary_t);
284 int dm_table_load_ioctl(prop_dictionary_t);
285 int dm_table_status_ioctl(prop_dictionary_t);
286 int dm_message_ioctl(prop_dictionary_t);
289 int dm_target_init(void);
290 int dm_target_uninit(void);
291 dm_target_t* dm_target_alloc(const char *);
292 dm_target_t* dm_target_autoload(const char *);
293 int dm_target_insert(dm_target_t *);
294 prop_array_t dm_target_prop_list(void);
295 dm_target_t* dm_target_lookup(const char *);
296 int dm_target_rem(char *);
297 void dm_target_unbusy(dm_target_t *);
298 void dm_target_busy(dm_target_t *);
300 #define DM_MAX_PARAMS_SIZE 1024
302 /* Generic function used to convert char to string */
303 uint64_t atoi64(const char *);
305 /* dm_target_mirror.c */
306 int dm_target_mirror_init(dm_dev_t *, void**, char *);
307 char * dm_target_mirror_status(void *);
308 int dm_target_mirror_strategy(dm_table_entry_t *, struct buf *);
309 int dm_target_mirror_deps(dm_table_entry_t *, prop_array_t);
310 int dm_target_mirror_destroy(dm_table_entry_t *);
311 int dm_target_mirror_upcall(dm_table_entry_t *, struct buf *);
313 /* dm_target_snapshot.c */
314 int dm_target_snapshot_init(dm_dev_t *, void**, char *);
315 char * dm_target_snapshot_status(void *);
316 int dm_target_snapshot_strategy(dm_table_entry_t *, struct buf *);
317 int dm_target_snapshot_deps(dm_table_entry_t *, prop_array_t);
318 int dm_target_snapshot_destroy(dm_table_entry_t *);
319 int dm_target_snapshot_upcall(dm_table_entry_t *, struct buf *);
321 /* dm snapshot origin driver */
322 int dm_target_snapshot_orig_init(dm_dev_t *, void**, char *);
323 char * dm_target_snapshot_orig_status(void *);
324 int dm_target_snapshot_orig_strategy(dm_table_entry_t *, struct buf *);
325 int dm_target_snapshot_orig_deps(dm_table_entry_t *, prop_array_t);
326 int dm_target_snapshot_orig_destroy(dm_table_entry_t *);
327 int dm_target_snapshot_orig_upcall(dm_table_entry_t *, struct buf *);
330 #define DM_TABLE_ACTIVE 0
331 #define DM_TABLE_INACTIVE 1
333 int dm_table_destroy(dm_table_head_t *, uint8_t);
334 uint64_t dm_table_size(dm_table_head_t *);
335 uint64_t dm_inactive_table_size(dm_table_head_t *);
336 dm_table_t * dm_table_get_entry(dm_table_head_t *, uint8_t);
337 int dm_table_get_target_count(dm_table_head_t *, uint8_t);
338 void dm_table_release(dm_table_head_t *, uint8_t s);
339 void dm_table_switch_tables(dm_table_head_t *);
340 void dm_table_head_init(dm_table_head_t *);
341 void dm_table_head_destroy(dm_table_head_t *);
344 int dm_dev_init(void);
345 int dm_dev_uninit(void);
346 dm_dev_t* dm_dev_alloc(void);
347 void dm_dev_busy(dm_dev_t *);
348 int dm_dev_create(dm_dev_t **, const char *, const char *, int);
349 int dm_dev_remove(dm_dev_t *);
350 int dm_dev_remove_all(int);
351 int dm_dev_destroy(dm_dev_t *);
352 int dm_dev_free(dm_dev_t *);
353 int dm_dev_insert(dm_dev_t *);
354 dm_dev_t* dm_dev_lookup(const char *, const char *, int);
355 prop_array_t dm_dev_prop_list(void);
356 dm_dev_t* dm_dev_rem(dm_dev_t *, const char *, const char *, int);
357 /*int dm_dev_test_minor(int);*/
358 void dm_dev_unbusy(dm_dev_t *);
361 int dm_pdev_init(void);
362 int dm_pdev_uninit(void);
363 int dm_pdev_decr(dm_pdev_t *);
364 dm_pdev_t* dm_pdev_insert(const char *);
365 off_t dm_pdev_correct_dump_offset(dm_pdev_t *, off_t);
367 /* dm builtin magic */
368 void dm_builtin_init(void *);
369 void dm_builtin_uninit(void *);
371 extern int dm_debug_level;
372 MALLOC_DECLARE(M_DM);
374 #define aprint_debug(format, ...) \
375 do { if (dm_debug_level) kprintf(format, ## __VA_ARGS__); } while(0)
376 #define aprint_normal kprintf
378 #define DM_TARGET_MODULE(name, evh) \
379 static moduledata_t name##_mod = { \
384 DECLARE_MODULE(name, name##_mod, SI_SUB_DM_TARGETS, \
386 MODULE_DEPEND(name, dm, 1, 1, 1)
388 #define DM_TARGET_BUILTIN(name, evh) \
389 SYSINIT(name##module, SI_SUB_DM_TARGETS, SI_ORDER_ANY, \
390 dm_builtin_init, evh); \
391 SYSUNINIT(name##module, SI_SUB_DM_TARGETS, SI_ORDER_ANY, \
392 dm_builtin_uninit, evh)
396 #endif /*_DM_DEV_H_*/