Blame view
include/linux/dm-ioctl.h
9.54 KB
1da177e4c Linux-2.6.12-rc2 |
1 2 |
/* * Copyright (C) 2001 - 2003 Sistina Software (UK) Limited. |
1d0f3ce83 dm ioctl: retriev... |
3 |
* Copyright (C) 2004 - 2009 Red Hat, Inc. All rights reserved. |
1da177e4c Linux-2.6.12-rc2 |
4 5 6 7 8 9 10 11 12 13 |
* * This file is released under the LGPL. */ #ifndef _LINUX_DM_IOCTL_V4_H #define _LINUX_DM_IOCTL_V4_H #include <linux/types.h> #define DM_DIR "mapper" /* Slashes not supported */ |
7e507eb64 dm: allow autoloa... |
14 |
#define DM_CONTROL_NODE "control" |
1da177e4c Linux-2.6.12-rc2 |
15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 |
#define DM_MAX_TYPE_NAME 16 #define DM_NAME_LEN 128 #define DM_UUID_LEN 129 /* * A traditional ioctl interface for the device mapper. * * Each device can have two tables associated with it, an * 'active' table which is the one currently used by io passing * through the device, and an 'inactive' one which is a table * that is being prepared as a replacement for the 'active' one. * * DM_VERSION: * Just get the version information for the ioctl interface. * * DM_REMOVE_ALL: * Remove all dm devices, destroy all tables. Only really used * for debug. * * DM_LIST_DEVICES: * Get a list of all the dm device names. * * DM_DEV_CREATE: * Create a new device, neither the 'active' or 'inactive' table * slots will be filled. The device will be in suspended state * after creation, however any io to the device will get errored * since it will be out-of-bounds. * * DM_DEV_REMOVE: * Remove a device, destroy any tables. * * DM_DEV_RENAME: |
84c89557a dm ioctl: allow r... |
47 |
* Rename a device or set its uuid if none was previously supplied. |
1da177e4c Linux-2.6.12-rc2 |
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 |
* * DM_SUSPEND: * This performs both suspend and resume, depending which flag is * passed in. * Suspend: This command will not return until all pending io to * the device has completed. Further io will be deferred until * the device is resumed. * Resume: It is no longer an error to issue this command on an * unsuspended device. If a table is present in the 'inactive' * slot, it will be moved to the active slot, then the old table * from the active slot will be _destroyed_. Finally the device * is resumed. * * DM_DEV_STATUS: * Retrieves the status for the table in the 'active' slot. * * DM_DEV_WAIT: * Wait for a significant event to occur to the device. This * could either be caused by an event triggered by one of the * targets of the table in the 'active' slot, or a table change. * * DM_TABLE_LOAD: * Load a table into the 'inactive' slot for the device. The * device does _not_ need to be suspended prior to this command. * * DM_TABLE_CLEAR: * Destroy any table in the 'inactive' slot (ie. abort). * * DM_TABLE_DEPS: * Return a set of device dependencies for the 'active' table. * * DM_TABLE_STATUS: * Return the targets status for the 'active' table. * * DM_TARGET_MSG: * Pass a message string to the target at a specific offset of a device. |
3ac51e741 [PATCH] dm store ... |
84 85 86 87 88 89 90 91 92 93 |
* * DM_DEV_SET_GEOMETRY: * Set the geometry of a device by passing in a string in this format: * * "cylinders heads sectors_per_track start_sector" * * Beware that CHS geometry is nearly obsolete and only provided * for compatibility with dm devices that can be booted by a PC * BIOS. See struct hd_geometry for range limits. Also note that * the geometry is erased if the device size changes. |
1da177e4c Linux-2.6.12-rc2 |
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 |
*/ /* * All ioctl arguments consist of a single chunk of memory, with * this structure at the start. If a uuid is specified any * lookup (eg. for a DM_INFO) will be done on that, *not* the * name. */ struct dm_ioctl { /* * The version number is made up of three parts: * major - no backward or forward compatibility, * minor - only backwards compatible, * patch - both backwards and forwards compatible. * * All clients of the ioctl interface should fill in the * version number of the interface that they were * compiled with. * * All recognised ioctl commands (ie. those that don't * return -ENOTTY) fill out this field, even if the * command failed. */ |
9adfbfb61 make most exporte... |
117 118 |
__u32 version[3]; /* in/out */ __u32 data_size; /* total size of data passed in |
1da177e4c Linux-2.6.12-rc2 |
119 |
* including this struct */ |
9adfbfb61 make most exporte... |
120 |
__u32 data_start; /* offset to start of data |
1da177e4c Linux-2.6.12-rc2 |
121 |
* relative to start of this struct */ |
9adfbfb61 make most exporte... |
122 123 124 |
__u32 target_count; /* in/out */ __s32 open_count; /* out */ __u32 flags; /* in/out */ |
60935eb21 dm ioctl: support... |
125 126 127 128 129 130 131 132 133 134 |
/* * event_nr holds either the event number (input and output) or the * udev cookie value (input only). * The DM_DEV_WAIT ioctl takes an event number as input. * The DM_SUSPEND, DM_DEV_REMOVE and DM_DEV_RENAME ioctls * use the field as a cookie to return in the DM_COOKIE * variable with the uevents they issue. * For output, the ioctls return the event number, not the cookie. */ |
9adfbfb61 make most exporte... |
135 136 |
__u32 event_nr; /* in/out */ __u32 padding; |
1da177e4c Linux-2.6.12-rc2 |
137 |
|
9adfbfb61 make most exporte... |
138 |
__u64 dev; /* in/out */ |
1da177e4c Linux-2.6.12-rc2 |
139 140 141 142 |
char name[DM_NAME_LEN]; /* device name */ char uuid[DM_UUID_LEN]; /* unique identifier for * the block device */ |
027d50f92 dm io:ctl use con... |
143 |
char data[7]; /* padding or data */ |
1da177e4c Linux-2.6.12-rc2 |
144 145 146 147 148 149 150 |
}; /* * Used to specify tables. These structures appear after the * dm_ioctl. */ struct dm_target_spec { |
9adfbfb61 make most exporte... |
151 152 153 |
__u64 sector_start; __u64 length; __s32 status; /* used when reading from kernel only */ |
1da177e4c Linux-2.6.12-rc2 |
154 155 156 157 158 159 160 161 162 163 164 |
/* * Location of the next dm_target_spec. * - When specifying targets on a DM_TABLE_LOAD command, this value is * the number of bytes from the start of the "current" dm_target_spec * to the start of the "next" dm_target_spec. * - When retrieving targets on a DM_TABLE_STATUS command, this value * is the number of bytes from the start of the first dm_target_spec * (that follows the dm_ioctl struct) to the start of the "next" * dm_target_spec. */ |
9adfbfb61 make most exporte... |
165 |
__u32 next; |
1da177e4c Linux-2.6.12-rc2 |
166 167 168 169 170 171 172 173 174 175 176 177 178 179 |
char target_type[DM_MAX_TYPE_NAME]; /* * Parameter string starts immediately after this object. * Be careful to add padding after string to ensure correct * alignment of subsequent dm_target_spec. */ }; /* * Used to retrieve the target dependencies. */ struct dm_target_deps { |
9adfbfb61 make most exporte... |
180 181 182 |
__u32 count; /* Array size */ __u32 padding; /* unused */ __u64 dev[0]; /* out */ |
1da177e4c Linux-2.6.12-rc2 |
183 184 185 186 187 188 |
}; /* * Used to get a list of all dm devices. */ struct dm_name_list { |
9adfbfb61 make most exporte... |
189 190 |
__u64 dev; __u32 next; /* offset to the next record from |
1da177e4c Linux-2.6.12-rc2 |
191 192 193 194 195 196 197 198 |
the _start_ of this */ char name[0]; }; /* * Used to retrieve the target versions */ struct dm_target_versions { |
9adfbfb61 make most exporte... |
199 200 |
__u32 next; __u32 version[3]; |
1da177e4c Linux-2.6.12-rc2 |
201 202 203 204 205 206 207 208 |
char name[0]; }; /* * Used to pass message to a target */ struct dm_target_msg { |
9adfbfb61 make most exporte... |
209 |
__u64 sector; /* Device sector */ |
1da177e4c Linux-2.6.12-rc2 |
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 |
char message[0]; }; /* * If you change this make sure you make the corresponding change * to dm-ioctl.c:lookup_ioctl() */ enum { /* Top level cmds */ DM_VERSION_CMD = 0, DM_REMOVE_ALL_CMD, DM_LIST_DEVICES_CMD, /* device level cmds */ DM_DEV_CREATE_CMD, DM_DEV_REMOVE_CMD, DM_DEV_RENAME_CMD, DM_DEV_SUSPEND_CMD, DM_DEV_STATUS_CMD, DM_DEV_WAIT_CMD, /* Table level cmds */ DM_TABLE_LOAD_CMD, DM_TABLE_CLEAR_CMD, DM_TABLE_DEPS_CMD, DM_TABLE_STATUS_CMD, /* Added later */ DM_LIST_VERSIONS_CMD, DM_TARGET_MSG_CMD, |
3ac51e741 [PATCH] dm store ... |
241 |
DM_DEV_SET_GEOMETRY_CMD |
1da177e4c Linux-2.6.12-rc2 |
242 |
}; |
1da177e4c Linux-2.6.12-rc2 |
243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 |
#define DM_IOCTL 0xfd #define DM_VERSION _IOWR(DM_IOCTL, DM_VERSION_CMD, struct dm_ioctl) #define DM_REMOVE_ALL _IOWR(DM_IOCTL, DM_REMOVE_ALL_CMD, struct dm_ioctl) #define DM_LIST_DEVICES _IOWR(DM_IOCTL, DM_LIST_DEVICES_CMD, struct dm_ioctl) #define DM_DEV_CREATE _IOWR(DM_IOCTL, DM_DEV_CREATE_CMD, struct dm_ioctl) #define DM_DEV_REMOVE _IOWR(DM_IOCTL, DM_DEV_REMOVE_CMD, struct dm_ioctl) #define DM_DEV_RENAME _IOWR(DM_IOCTL, DM_DEV_RENAME_CMD, struct dm_ioctl) #define DM_DEV_SUSPEND _IOWR(DM_IOCTL, DM_DEV_SUSPEND_CMD, struct dm_ioctl) #define DM_DEV_STATUS _IOWR(DM_IOCTL, DM_DEV_STATUS_CMD, struct dm_ioctl) #define DM_DEV_WAIT _IOWR(DM_IOCTL, DM_DEV_WAIT_CMD, struct dm_ioctl) #define DM_TABLE_LOAD _IOWR(DM_IOCTL, DM_TABLE_LOAD_CMD, struct dm_ioctl) #define DM_TABLE_CLEAR _IOWR(DM_IOCTL, DM_TABLE_CLEAR_CMD, struct dm_ioctl) #define DM_TABLE_DEPS _IOWR(DM_IOCTL, DM_TABLE_DEPS_CMD, struct dm_ioctl) #define DM_TABLE_STATUS _IOWR(DM_IOCTL, DM_TABLE_STATUS_CMD, struct dm_ioctl) #define DM_LIST_VERSIONS _IOWR(DM_IOCTL, DM_LIST_VERSIONS_CMD, struct dm_ioctl) #define DM_TARGET_MSG _IOWR(DM_IOCTL, DM_TARGET_MSG_CMD, struct dm_ioctl) |
3ac51e741 [PATCH] dm store ... |
264 |
#define DM_DEV_SET_GEOMETRY _IOWR(DM_IOCTL, DM_DEV_SET_GEOMETRY_CMD, struct dm_ioctl) |
1da177e4c Linux-2.6.12-rc2 |
265 266 |
#define DM_VERSION_MAJOR 4 |
84c89557a dm ioctl: allow r... |
267 |
#define DM_VERSION_MINOR 19 |
9c4376de9 dm: use non reent... |
268 269 |
#define DM_VERSION_PATCHLEVEL 1 #define DM_VERSION_EXTRA "-ioctl (2011-01-07)" |
1da177e4c Linux-2.6.12-rc2 |
270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 |
/* Status bits */ #define DM_READONLY_FLAG (1 << 0) /* In/Out */ #define DM_SUSPEND_FLAG (1 << 1) /* In/Out */ #define DM_PERSISTENT_DEV_FLAG (1 << 3) /* In */ /* * Flag passed into ioctl STATUS command to get table information * rather than current status. */ #define DM_STATUS_TABLE_FLAG (1 << 4) /* In */ /* * Flags that indicate whether a table is present in either of * the two table slots that a device has. */ #define DM_ACTIVE_PRESENT_FLAG (1 << 5) /* Out */ #define DM_INACTIVE_PRESENT_FLAG (1 << 6) /* Out */ /* * Indicates that the buffer passed in wasn't big enough for the * results. */ #define DM_BUFFER_FULL_FLAG (1 << 8) /* Out */ /* |
5c6bd75d0 [PATCH] dm: preve... |
296 |
* This flag is now ignored. |
1da177e4c Linux-2.6.12-rc2 |
297 298 |
*/ #define DM_SKIP_BDGET_FLAG (1 << 9) /* In */ |
6da487dcc [PATCH] device-ma... |
299 300 301 302 |
/* * Set this to avoid attempting to freeze any filesystem when suspending. */ #define DM_SKIP_LOCKFS_FLAG (1 << 10) /* In */ |
81fdb096d [PATCH] dm: ioctl... |
303 304 305 306 |
/* * Set this to suspend without flushing queued ios. */ #define DM_NOFLUSH_FLAG (1 << 11) /* In */ |
1d0f3ce83 dm ioctl: retriev... |
307 308 309 310 311 312 |
/* * If set, any table information returned will relate to the inactive * table instead of the live one. Always check DM_INACTIVE_PRESENT_FLAG * is set before using the data returned. */ #define DM_QUERY_INACTIVE_TABLE_FLAG (1 << 12) /* In */ |
3abf85b5b dm ioctl: introdu... |
313 314 315 316 |
/* * If set, a uevent was generated for which the caller may need to wait. */ #define DM_UEVENT_GENERATED_FLAG (1 << 13) /* Out */ |
84c89557a dm ioctl: allow r... |
317 318 319 320 321 |
/* * If set, rename changes the uuid not the name. Only permitted * if no uuid was previously supplied: an existing uuid cannot be changed. */ #define DM_UUID_FLAG (1 << 14) /* In */ |
1da177e4c Linux-2.6.12-rc2 |
322 |
#endif /* _LINUX_DM_IOCTL_H */ |