1/*
2 * Copyright (c) 2010 The NetBSD Foundation, Inc.
3 * All rights reserved.
4 *
5 * This code is derived from software contributed to The NetBSD Foundation
6 * by Adam Hamsik.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
18 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
19 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
20 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
21 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27 * POSSIBILITY OF SUCH DAMAGE.
28 */
29
30
31#ifndef _LIB_DM_H_
32#define _LIB_DM_H_
33
34#include <sys/cdefs.h>
35#include <stddef.h>
36#include <stdint.h>
37
38__BEGIN_DECLS
39
40#define DM_DEVICE_PATH "/dev/mapper/control"
41
42#define IOCTL_TYPE_IN 0x1
43#define IOCTL_TYPE_OUT 0x2
44
45struct libdm_task;
46struct libdm_cmd;
47struct libdm_target;
48struct libdm_table;
49struct libdm_dev;
50struct libdm_iter;
51
52typedef struct libdm_task* libdm_task_t;
53typedef struct libdm_cmd* libdm_cmd_t;
54typedef struct libdm_target* libdm_target_t;
55typedef struct libdm_table* libdm_table_t;
56typedef struct libdm_dev* libdm_dev_t;
57typedef struct libdm_iter* libdm_iter_t;
58
59struct cmd_version {
60 const char *cmd;
61 uint32_t version[3];
62};
63
64void libdm_iter_destroy(libdm_iter_t);
65
66libdm_task_t libdm_task_create(const char *);
67void libdm_task_destroy(libdm_task_t);
68
69char *libdm_task_get_command(libdm_task_t);
70int32_t libdm_task_get_cmd_version(libdm_task_t, uint32_t *, size_t);
71
72int libdm_task_set_name(const char *, libdm_task_t);
73char *libdm_task_get_name(libdm_task_t);
74
75int libdm_task_set_uuid(const char *, libdm_task_t);
76char *libdm_task_get_uuid(libdm_task_t);
77
78int libdm_task_set_minor(uint32_t, libdm_task_t);
79uint32_t libdm_task_get_minor(libdm_task_t);
80
81uint32_t libdm_task_get_flags(libdm_task_t);
82void libdm_task_set_flags(libdm_task_t, uint32_t);
83
84void libdm_task_set_suspend_flag(libdm_task_t);
85void libdm_task_del_suspend_flag(libdm_task_t);
86
87void libdm_task_set_status_flag(libdm_task_t);
88void libdm_task_del_status_flag(libdm_task_t);
89
90void libdm_task_set_exists_flag(libdm_task_t);
91void libdm_task_del_exists_flag(libdm_task_t);
92
93void libdm_task_set_nocount_flag(libdm_task_t);
94void libdm_task_del_nocount_flag(libdm_task_t);
95
96uint32_t libdm_task_get_target_num(libdm_task_t);
97int32_t libdm_task_get_open_num(libdm_task_t);
98uint32_t libdm_task_get_event_num(libdm_task_t);
99
100int libdm_task_set_cmd(libdm_cmd_t, libdm_task_t);
101libdm_cmd_t libdm_task_get_cmd(libdm_task_t);
102
103/* cmd_data dictionary entry manipulating functions */
104libdm_cmd_t libdm_cmd_create(void);
105void libdm_cmd_destroy(libdm_cmd_t);
106libdm_iter_t libdm_cmd_iter_create(libdm_cmd_t);
107
108int libdm_cmd_set_table(libdm_table_t, libdm_cmd_t);
109
110/* cmd is array of table dictionaries */
111libdm_table_t libdm_cmd_get_table(libdm_iter_t);
112
113/* cmd is array of dev dictionaries */
114libdm_dev_t libdm_cmd_get_dev(libdm_iter_t);
115
116/* cmd is array of target dictonaries */
117libdm_target_t libdm_cmd_get_target(libdm_iter_t);
118/* cmd is array of dev_t's */
119uint64_t libdm_cmd_get_deps(libdm_iter_t);
120
121/* Table functions. */
122libdm_table_t libdm_table_create(void);
123void libdm_table_destroy(libdm_table_t);
124
125int libdm_table_set_start(uint64_t, libdm_table_t);
126uint64_t libdm_table_get_start(libdm_table_t);
127
128int libdm_table_set_length(uint64_t, libdm_table_t);
129uint64_t libdm_table_get_length(libdm_table_t);
130
131int libdm_table_set_target(const char *, libdm_table_t);
132char * libdm_table_get_target(libdm_table_t);
133
134int libdm_table_set_params(const char *, libdm_table_t);
135char * libdm_table_get_params(libdm_table_t);
136
137int32_t libdm_table_get_status(libdm_table_t);
138
139/* Target manipulating functions. */
140void libdm_target_destroy(libdm_target_t);
141
142char * libdm_target_get_name(libdm_target_t);
143int32_t libdm_target_get_version(libdm_target_t, uint32_t *, size_t);
144
145/* Dev manipulating functions. */
146void libdm_dev_destroy(libdm_dev_t);
147
148char * libdm_dev_get_name(libdm_dev_t);
149uint32_t libdm_dev_get_minor(libdm_dev_t);
150
151int libdm_dev_set_newname(const char *, libdm_cmd_t);
152
153/* task run routine */
154int libdm_task_run(libdm_task_t);
155
156__END_DECLS
157
158#endif /* _LIB_DM_H_ */
159