1 /* $NetBSD: netbsd-dm.h,v 1.2 2008/12/19 15:24:03 haad 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 32 #ifndef __NETBSD_DM_H__ 33 #define __NETBSD_DM_H__ 34 35 #include <prop/proplib.h> 36 37 #define DM_CMD_LEN 16 38 39 #define DM_IOCTL 0xfd 40 41 #define DM_IOCTL_CMD 0 42 43 #define NETBSD_DM_IOCTL _IOWR(DM_IOCTL, DM_IOCTL_CMD, struct plistref) 44 45 46 /* 47 * DM-ioctl dictionary. 48 * 49 * This contains general information about dm device. 50 * 51 * <dict> 52 * <key>command</key> 53 * <string>...</string> 54 * 55 * <key>event_nr</key> 56 * <integer>...</integer> 57 * 58 * <key>name</key> 59 * <string>...</string> 60 * 61 * <key>uuid</key> 62 * <string>...</string> 63 * 64 * <key>dev</key> 65 * <integer></integer> 66 * 67 * <key>flags</key> 68 * <integer></integer> 69 * 70 * <key>version</key> 71 * <array> 72 * <integer>...</integer> 73 * <integer>...</integer> 74 * <integer>...</integer> 75 * </array> 76 * 77 * <key>cmd_data</key> 78 * <array> 79 * <!-- See below for command 80 * specific dictionaries --> 81 * </array> 82 * </dict> 83 * 84 * Available commands from _cmd_data_v4. 85 * 86 * create, reload, remove, remove_all, suspend, 87 * resume, info, deps, rename, version, status, 88 * table, waitevent, names, clear, mknodes, 89 * targets, message, setgeometry 90 * 91 */ 92 93 /* 94 * DM_LIST_VERSIONS == "targets" command dictionary entry. 95 * Lists all available targets with their version. 96 * 97 * <array> 98 * <dict> 99 * <key>name<key> 100 * <string>...</string> 101 * 102 * <key>version</key> 103 * <array> 104 * <integer>...</integer> 105 * <integer>...</integer> 106 * <integer>...</integer> 107 * </array> 108 * </dict> 109 * </array> 110 * 111 */ 112 113 /* 114 * DM_DEV_LIST == "names" 115 * Request list of device-mapper created devices from kernel. 116 * 117 * <array> 118 * <dict> 119 * <key>name<key> 120 * <string>...</string> 121 * 122 * <key>dev</key> 123 * <integer>...</integer> 124 * </dict> 125 * </array> 126 * 127 * dev is uint64_t 128 * 129 */ 130 131 /* 132 * DM_DEV_RENAME == "rename" 133 * Rename device to string. 134 * 135 * <array> 136 * <string>...</string> 137 * </array> 138 * 139 */ 140 141 /* 142 * DM_DEV_STATUS == "info, mknodes" 143 * Will change fields DM_IOCTL_OPEN, DM_IOCTL_DEV in received dictionary, 144 * with dm device values with name or uuid from list. 145 * 146 */ 147 148 /* 149 * DM_TABLE_STATUS == "status,table" 150 * Request list of device-mapper created devices from kernel. 151 * 152 * <array> 153 * <dict> 154 * <key>type<key> 155 * <string>...</string> 156 * 157 * <key>start</key> 158 * <integer>...</integer> 159 * 160 * <key>length</key> 161 * <integer>...</integer> 162 * 163 * <key>params</key> 164 * <string>...</string> 165 * </dict> 166 * </array> 167 * 168 * params is string which contains {device} {parameters} 169 * 170 */ 171 172 /* 173 * DM_TABLE_DEPS == "deps" 174 * Request list active table device dependiences. 175 * 176 * This command is also run to get dm-device 177 * dependiences for existing real block device. 178 * 179 * eg. vgcreate calls DM_TABLE_DEPS 180 * 181 * <array> 182 * <integer>...</integer> 183 * </array> 184 * 185 */ 186 187 #define DM_IOCTL_COMMAND "command" 188 #define DM_IOCTL_VERSION "version" 189 #define DM_IOCTL_OPEN "open_count" 190 #define DM_IOCTL_MINOR "minor" 191 #define DM_IOCTL_NAME "name" 192 #define DM_IOCTL_UUID "uuid" 193 #define DM_IOCTL_TARGET_COUNT "target_count" 194 #define DM_IOCTL_EVENT "event_nr" 195 #define DM_IOCTL_FLAGS "flags" 196 #define DM_IOCTL_CMD_DATA "cmd_data" 197 198 #define DM_TARGETS_NAME "name" 199 #define DM_TARGETS_VERSION "ver" 200 201 #define DM_DEV_NEWNAME "newname" 202 #define DM_DEV_NAME "name" 203 #define DM_DEV_DEV "dev" 204 205 #define DM_TABLE_TYPE "type" 206 #define DM_TABLE_START "start" 207 #define DM_TABLE_STAT "status" 208 #define DM_TABLE_LENGTH "length" 209 #define DM_TABLE_PARAMS "params" 210 #define DM_TABLE_DEPS "deps" 211 212 213 /* Status bits */ 214 /* IO mode of device */ 215 #define DM_READONLY_FLAG (1 << 0) /* In/Out *//* to kernel/from kernel */ 216 #define DM_SUSPEND_FLAG (1 << 1) /* In/Out */ 217 /* XXX. This flag is undocumented. */ 218 #define DM_EXISTS_FLAG (1 << 2) /* In/Out */ 219 /* Minor number is persistent */ 220 #define DM_PERSISTENT_DEV_FLAG (1 << 3) /* In */ 221 222 /* 223 * Flag passed into ioctl STATUS command to get table information 224 * rather than current status. 225 */ 226 #define DM_STATUS_TABLE_FLAG (1 << 4) /* In */ 227 228 /* 229 * Flags that indicate whether a table is present in either of 230 * the two table slots that a device has. 231 */ 232 #define DM_ACTIVE_PRESENT_FLAG (1 << 5) /* Out */ 233 #define DM_INACTIVE_PRESENT_FLAG (1 << 6) /* Out */ 234 235 /* 236 * Indicates that the buffer passed in wasn't big enough for the 237 * results. 238 */ 239 #define DM_BUFFER_FULL_FLAG (1 << 8) /* Out */ 240 241 /* 242 * This flag is now ignored. 243 */ 244 #define DM_SKIP_BDGET_FLAG (1 << 9) /* In */ 245 246 /* 247 * Set this to avoid attempting to freeze any filesystem when suspending. 248 */ 249 #define DM_SKIP_LOCKFS_FLAG (1 << 10) /* In */ 250 251 /* 252 * Set this to suspend without flushing queued ios. 253 */ 254 #define DM_NOFLUSH_FLAG (1 << 11) /* In */ 255 256 257 #ifdef __LIB_DEVMAPPER__ 258 259 # define MAJOR(x) major((x)) 260 # define MINOR(x) minor((x)) 261 # define MKDEV(x,y) makedev((x),(y)) 262 263 /* Name of device-mapper driver in kernel */ 264 #define DM_NAME "dm" 265 266 /* Types for nbsd_get_dm_major */ 267 #define DM_CHAR_MAJOR 1 268 #define DM_BLOCK_MAJOR 2 269 270 /* libdm_netbsd.c */ 271 /* Get dm device major/minor numbers */ 272 int nbsd_get_dm_major(uint32_t *, uint32_t *, int); 273 274 int nbsd_dmi_add_cmd(const char *, prop_dictionary_t); 275 int nbsd_dmi_add_version(const int [3], prop_dictionary_t); 276 int nbsd_dm_add_uint(const char *, uint64_t, prop_dictionary_t); 277 int nbsd_dm_add_str(const char *, char *, prop_dictionary_t ); 278 279 struct dm_ioctl* nbsd_dm_dict_to_dmi(prop_dictionary_t, const int); 280 281 #endif /* __LIB_DEVMAPPER__ */ 282 283 #endif /* __NETBSD_DM_H__ */ 284