Blame view
include/linux/device-mapper.h
13.6 KB
1da177e4c Linux-2.6.12-rc2 |
1 2 |
/* * Copyright (C) 2001 Sistina Software (UK) Limited. |
0da336e5f dm: expose macros |
3 |
* Copyright (C) 2004-2008 Red Hat, Inc. All rights reserved. |
1da177e4c Linux-2.6.12-rc2 |
4 5 6 7 8 9 |
* * This file is released under the LGPL. */ #ifndef _LINUX_DEVICE_MAPPER_H #define _LINUX_DEVICE_MAPPER_H |
416cd17b1 dm log: clean int... |
10 |
#include <linux/bio.h> |
f6fccb121 dm: introduce mer... |
11 |
#include <linux/blkdev.h> |
71a16736a dm: use local pri... |
12 |
#include <linux/ratelimit.h> |
416cd17b1 dm log: clean int... |
13 |
|
af4874e03 dm target:s intro... |
14 |
struct dm_dev; |
1da177e4c Linux-2.6.12-rc2 |
15 16 |
struct dm_target; struct dm_table; |
17b2f66f2 [PATCH] dm: add e... |
17 |
struct mapped_device; |
f6fccb121 dm: introduce mer... |
18 |
struct bio_vec; |
1da177e4c Linux-2.6.12-rc2 |
19 20 21 22 23 24 |
typedef enum { STATUSTYPE_INFO, STATUSTYPE_TABLE } status_type_t; union map_info { void *ptr; unsigned long long ll; |
57cba5d36 dm: rename map_in... |
25 |
unsigned target_request_nr; |
1da177e4c Linux-2.6.12-rc2 |
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 |
}; /* * In the constructor the target parameter will already have the * table, type, begin and len fields filled in. */ typedef int (*dm_ctr_fn) (struct dm_target *target, unsigned int argc, char **argv); /* * The destructor doesn't need to free the dm_target, just * anything hidden ti->private. */ typedef void (*dm_dtr_fn) (struct dm_target *ti); /* * The map function must return: * < 0: error * = 0: The target will handle the io by resubmitting it later |
45cbcd798 [PATCH] dm: map a... |
45 |
* = 1: simple remap complete |
2e93ccc19 [PATCH] dm: suspe... |
46 |
* = 2: The target wants to push back the io |
1da177e4c Linux-2.6.12-rc2 |
47 48 49 |
*/ typedef int (*dm_map_fn) (struct dm_target *ti, struct bio *bio, union map_info *map_context); |
7d76345da dm request: exten... |
50 51 |
typedef int (*dm_map_request_fn) (struct dm_target *ti, struct request *clone, union map_info *map_context); |
1da177e4c Linux-2.6.12-rc2 |
52 53 54 55 56 57 58 |
/* * Returns: * < 0 : error (currently ignored) * 0 : ended successfully * 1 : for some reason the io has still not completed (eg, * multipath target might want to requeue a failed io). |
2e93ccc19 [PATCH] dm: suspe... |
59 |
* 2 : The target wants to push back the io |
1da177e4c Linux-2.6.12-rc2 |
60 61 62 63 |
*/ typedef int (*dm_endio_fn) (struct dm_target *ti, struct bio *bio, int error, union map_info *map_context); |
7d76345da dm request: exten... |
64 65 66 |
typedef int (*dm_request_endio_fn) (struct dm_target *ti, struct request *clone, int error, union map_info *map_context); |
1da177e4c Linux-2.6.12-rc2 |
67 |
|
999d81685 [PATCH] dm table:... |
68 |
typedef void (*dm_flush_fn) (struct dm_target *ti); |
1da177e4c Linux-2.6.12-rc2 |
69 70 |
typedef void (*dm_presuspend_fn) (struct dm_target *ti); typedef void (*dm_postsuspend_fn) (struct dm_target *ti); |
8757b7764 [PATCH] dm table:... |
71 |
typedef int (*dm_preresume_fn) (struct dm_target *ti); |
1da177e4c Linux-2.6.12-rc2 |
72 73 74 75 76 77 |
typedef void (*dm_resume_fn) (struct dm_target *ti); typedef int (*dm_status_fn) (struct dm_target *ti, status_type_t status_type, char *result, unsigned int maxlen); typedef int (*dm_message_fn) (struct dm_target *ti, unsigned argc, char **argv); |
647b3d008 [PATCH] lose unus... |
78 |
typedef int (*dm_ioctl_fn) (struct dm_target *ti, unsigned int cmd, |
aa129a224 [PATCH] dm: suppo... |
79 |
unsigned long arg); |
f6fccb121 dm: introduce mer... |
80 81 |
typedef int (*dm_merge_fn) (struct dm_target *ti, struct bvec_merge_data *bvm, struct bio_vec *biovec, int max_size); |
af4874e03 dm target:s intro... |
82 83 |
typedef int (*iterate_devices_callout_fn) (struct dm_target *ti, struct dm_dev *dev, |
5dea271b6 dm table: pass co... |
84 |
sector_t start, sector_t len, |
af4874e03 dm target:s intro... |
85 86 87 88 89 |
void *data); typedef int (*dm_iterate_devices_fn) (struct dm_target *ti, iterate_devices_callout_fn fn, void *data); |
40bea4312 dm stripe: expose... |
90 91 |
typedef void (*dm_io_hints_fn) (struct dm_target *ti, struct queue_limits *limits); |
7d76345da dm request: exten... |
92 93 94 95 96 97 |
/* * Returns: * 0: The target can handle the next I/O immediately. * 1: The target can't handle the next I/O immediately. */ typedef int (*dm_busy_fn) (struct dm_target *ti); |
1da177e4c Linux-2.6.12-rc2 |
98 99 100 |
void dm_error(const char *message); /* |
3cb402145 [PATCH] dm: extra... |
101 102 |
* Combine device limits. */ |
754c5fc7e dm: calculate que... |
103 |
int dm_set_device_limits(struct dm_target *ti, struct dm_dev *dev, |
5dea271b6 dm table: pass co... |
104 |
sector_t start, sector_t len, void *data); |
3cb402145 [PATCH] dm: extra... |
105 |
|
82b1519b3 dm: export struct... |
106 107 |
struct dm_dev { struct block_device *bdev; |
aeb5d7270 [PATCH] introduce... |
108 |
fmode_t mode; |
82b1519b3 dm: export struct... |
109 110 |
char name[16]; }; |
3cb402145 [PATCH] dm: extra... |
111 |
/* |
1da177e4c Linux-2.6.12-rc2 |
112 113 |
* Constructors should call these functions to ensure destination devices * are opened/closed correctly. |
1da177e4c Linux-2.6.12-rc2 |
114 |
*/ |
8215d6ec5 dm table: remove ... |
115 116 |
int dm_get_device(struct dm_target *ti, const char *path, fmode_t mode, struct dm_dev **result); |
1da177e4c Linux-2.6.12-rc2 |
117 118 119 120 121 |
void dm_put_device(struct dm_target *ti, struct dm_dev *d); /* * Information about a target type */ |
ab4c14248 dm: support barri... |
122 |
|
1da177e4c Linux-2.6.12-rc2 |
123 |
struct target_type { |
ab4c14248 dm: support barri... |
124 |
uint64_t features; |
1da177e4c Linux-2.6.12-rc2 |
125 126 |
const char *name; struct module *module; |
17b2f66f2 [PATCH] dm: add e... |
127 |
unsigned version[3]; |
1da177e4c Linux-2.6.12-rc2 |
128 129 130 |
dm_ctr_fn ctr; dm_dtr_fn dtr; dm_map_fn map; |
7d76345da dm request: exten... |
131 |
dm_map_request_fn map_rq; |
1da177e4c Linux-2.6.12-rc2 |
132 |
dm_endio_fn end_io; |
7d76345da dm request: exten... |
133 |
dm_request_endio_fn rq_end_io; |
999d81685 [PATCH] dm table:... |
134 |
dm_flush_fn flush; |
1da177e4c Linux-2.6.12-rc2 |
135 136 |
dm_presuspend_fn presuspend; dm_postsuspend_fn postsuspend; |
8757b7764 [PATCH] dm table:... |
137 |
dm_preresume_fn preresume; |
1da177e4c Linux-2.6.12-rc2 |
138 139 140 |
dm_resume_fn resume; dm_status_fn status; dm_message_fn message; |
aa129a224 [PATCH] dm: suppo... |
141 |
dm_ioctl_fn ioctl; |
f6fccb121 dm: introduce mer... |
142 |
dm_merge_fn merge; |
7d76345da dm request: exten... |
143 |
dm_busy_fn busy; |
af4874e03 dm target:s intro... |
144 |
dm_iterate_devices_fn iterate_devices; |
40bea4312 dm stripe: expose... |
145 |
dm_io_hints_fn io_hints; |
45194e4f8 dm target: remove... |
146 147 148 |
/* For internal device-mapper use. */ struct list_head list; |
1da177e4c Linux-2.6.12-rc2 |
149 |
}; |
3791e2fc0 dm table: add sin... |
150 151 152 153 154 155 156 157 158 |
/* * Target features */ /* * Any table that contains an instance of this target must have only one. */ #define DM_TARGET_SINGLETON 0x00000001 #define dm_target_needs_singleton(type) ((type)->features & DM_TARGET_SINGLETON) |
cc6cbe141 dm table: add alw... |
159 160 161 162 163 164 |
/* * Indicates that a target does not support read-only devices. */ #define DM_TARGET_ALWAYS_WRITEABLE 0x00000002 #define dm_target_always_writeable(type) \ ((type)->features & DM_TARGET_ALWAYS_WRITEABLE) |
36a0456fb dm table: add imm... |
165 166 167 168 169 170 |
/* * Any device that contains a table with an instance of this target may never * have tables containing any different target type. */ #define DM_TARGET_IMMUTABLE 0x00000004 #define dm_target_is_immutable(type) ((type)->features & DM_TARGET_IMMUTABLE) |
1da177e4c Linux-2.6.12-rc2 |
171 172 173 174 175 176 177 |
struct dm_target { struct dm_table *table; struct target_type *type; /* target limits */ sector_t begin; sector_t len; |
1da177e4c Linux-2.6.12-rc2 |
178 179 180 181 |
/* Always a power of 2 */ sector_t split_io; /* |
f9ab94cee dm: introduce num... |
182 183 184 |
* A number of zero-length barrier requests that will be submitted * to the target for the purpose of flushing cache. * |
57cba5d36 dm: rename map_in... |
185 |
* The request number will be placed in union map_info->target_request_nr. |
f9ab94cee dm: introduce num... |
186 187 188 189 |
* It is a responsibility of the target driver to remap these requests * to the real underlying devices. */ unsigned num_flush_requests; |
5ae89a872 dm: linear suppor... |
190 191 192 193 194 |
/* * The number of discard requests that will be submitted to the * target. map_info->request_nr is used just like num_flush_requests. */ unsigned num_discard_requests; |
1da177e4c Linux-2.6.12-rc2 |
195 196 197 198 199 |
/* target specific data */ void *private; /* Used to provide an error string from the ctr */ char *error; |
4c2593270 dm table: allow t... |
200 201 202 203 204 205 |
/* * Set if this target needs to receive discards regardless of * whether or not its underlying devices have support. */ unsigned discards_supported:1; |
983c7db34 dm crypt: always ... |
206 207 208 209 210 |
/* * Set if this target does not return zeroes on discarded blocks. */ unsigned discard_zeroes_data_unsupported:1; |
1da177e4c Linux-2.6.12-rc2 |
211 |
}; |
9d357b078 dm: introduce tar... |
212 213 214 215 216 |
/* Each target can link one of these into the table */ struct dm_target_callbacks { struct list_head list; int (*congested_fn) (struct dm_target_callbacks *, int); }; |
1da177e4c Linux-2.6.12-rc2 |
217 |
int dm_register_target(struct target_type *t); |
10d3bd09a dm: consolidate t... |
218 |
void dm_unregister_target(struct target_type *t); |
17b2f66f2 [PATCH] dm: add e... |
219 |
|
498f0103e dm table: share t... |
220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 |
/* * Target argument parsing. */ struct dm_arg_set { unsigned argc; char **argv; }; /* * The minimum and maximum value of a numeric argument, together with * the error message to use if the number is found to be outside that range. */ struct dm_arg { unsigned min; unsigned max; char *error; }; /* * Validate the next argument, either returning it as *value or, if invalid, * returning -EINVAL and setting *error. */ int dm_read_arg(struct dm_arg *arg, struct dm_arg_set *arg_set, unsigned *value, char **error); /* * Process the next argument as the start of a group containing between * arg->min and arg->max further arguments. Either return the size as * *num_args or, if invalid, return -EINVAL and set *error. */ int dm_read_arg_group(struct dm_arg *arg, struct dm_arg_set *arg_set, unsigned *num_args, char **error); /* * Return the current argument and shift to the next. */ const char *dm_shift_arg(struct dm_arg_set *as); /* * Move through num_args arguments. */ void dm_consume_args(struct dm_arg_set *as, unsigned num_args); |
17b2f66f2 [PATCH] dm: add e... |
262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 |
/*----------------------------------------------------------------- * Functions for creating and manipulating mapped devices. * Drop the reference with dm_put when you finish with the object. *---------------------------------------------------------------*/ /* * DM_ANY_MINOR chooses the next available minor number. */ #define DM_ANY_MINOR (-1) int dm_create(int minor, struct mapped_device **md); /* * Reference counting for md. */ struct mapped_device *dm_get_md(dev_t dev); void dm_get(struct mapped_device *md); void dm_put(struct mapped_device *md); /* * An arbitrary pointer may be stored alongside a mapped device. */ void dm_set_mdptr(struct mapped_device *md, void *ptr); void *dm_get_mdptr(struct mapped_device *md); /* * A device can still be used while suspended, but I/O is deferred. */ |
a3d77d35b [PATCH] dm: suspe... |
289 |
int dm_suspend(struct mapped_device *md, unsigned suspend_flags); |
17b2f66f2 [PATCH] dm: add e... |
290 291 292 293 294 295 296 |
int dm_resume(struct mapped_device *md); /* * Event functions. */ uint32_t dm_get_event_nr(struct mapped_device *md); int dm_wait_event(struct mapped_device *md, int event_nr); |
7a8c3d3b9 dm: uevent genera... |
297 298 |
uint32_t dm_next_uevent_seq(struct mapped_device *md); void dm_uevent_add(struct mapped_device *md, struct list_head *elist); |
17b2f66f2 [PATCH] dm: add e... |
299 300 301 302 |
/* * Info functions. */ |
72d948616 [PATCH] dm: impro... |
303 |
const char *dm_device_name(struct mapped_device *md); |
96a1f7dba dm: export name a... |
304 |
int dm_copy_name_and_uuid(struct mapped_device *md, char *name, char *uuid); |
17b2f66f2 [PATCH] dm: add e... |
305 |
struct gendisk *dm_disk(struct mapped_device *md); |
64dbce580 dm: export suspen... |
306 |
int dm_suspended(struct dm_target *ti); |
2e93ccc19 [PATCH] dm: suspe... |
307 |
int dm_noflush_suspending(struct dm_target *ti); |
89343da07 dm: publish dm_ge... |
308 |
union map_info *dm_get_mapinfo(struct bio *bio); |
cec47e3d4 dm: prepare for r... |
309 |
union map_info *dm_get_rq_mapinfo(struct request *rq); |
17b2f66f2 [PATCH] dm: add e... |
310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 |
/* * Geometry functions. */ int dm_get_geometry(struct mapped_device *md, struct hd_geometry *geo); int dm_set_geometry(struct mapped_device *md, struct hd_geometry *geo); /*----------------------------------------------------------------- * Functions for manipulating device-mapper tables. *---------------------------------------------------------------*/ /* * First create an empty table. */ |
aeb5d7270 [PATCH] introduce... |
325 |
int dm_table_create(struct dm_table **result, fmode_t mode, |
17b2f66f2 [PATCH] dm: add e... |
326 327 328 329 330 331 332 333 334 |
unsigned num_targets, struct mapped_device *md); /* * Then call this once for each target. */ int dm_table_add_target(struct dm_table *t, const char *type, sector_t start, sector_t len, char *params); /* |
9d357b078 dm: introduce tar... |
335 336 337 338 339 |
* Target_ctr should call this if it needs to add any callbacks. */ void dm_table_add_target_callbacks(struct dm_table *t, struct dm_target_callbacks *cb); /* |
17b2f66f2 [PATCH] dm: add e... |
340 341 342 343 344 345 346 |
* Finally call this to make the table ready for use. */ int dm_table_complete(struct dm_table *t); /* * Table reference counting. */ |
7c6664114 dm: rename dm_get... |
347 |
struct dm_table *dm_get_live_table(struct mapped_device *md); |
17b2f66f2 [PATCH] dm: add e... |
348 349 350 351 352 353 354 355 |
void dm_table_get(struct dm_table *t); void dm_table_put(struct dm_table *t); /* * Queries */ sector_t dm_table_get_size(struct dm_table *t); unsigned int dm_table_get_num_targets(struct dm_table *t); |
aeb5d7270 [PATCH] introduce... |
356 |
fmode_t dm_table_get_mode(struct dm_table *t); |
17b2f66f2 [PATCH] dm: add e... |
357 358 359 360 361 362 363 364 365 |
struct mapped_device *dm_table_get_md(struct dm_table *t); /* * Trigger an event. */ void dm_table_event(struct dm_table *t); /* * The device must be suspended before calling this method. |
042d2a9bc dm: keep old tabl... |
366 |
* Returns the previous table, which the caller must destroy. |
17b2f66f2 [PATCH] dm: add e... |
367 |
*/ |
042d2a9bc dm: keep old tabl... |
368 369 |
struct dm_table *dm_swap_table(struct mapped_device *md, struct dm_table *t); |
17b2f66f2 [PATCH] dm: add e... |
370 |
|
541609042 dm: publish dm_vc... |
371 372 373 374 |
/* * A wrapper around vmalloc. */ void *dm_vcalloc(unsigned long nmemb, unsigned long elem_size); |
0da336e5f dm: expose macros |
375 376 377 378 |
/*----------------------------------------------------------------- * Macros. *---------------------------------------------------------------*/ #define DM_NAME "device-mapper" |
71a16736a dm: use local pri... |
379 380 381 382 383 384 385 |
#ifdef CONFIG_PRINTK extern struct ratelimit_state dm_ratelimit_state; #define dm_ratelimit() __ratelimit(&dm_ratelimit_state) #else #define dm_ratelimit() 0 #endif |
10d3bd09a dm: consolidate t... |
386 387 388 |
#define DMCRIT(f, arg...) \ printk(KERN_CRIT DM_NAME ": " DM_MSG_PREFIX ": " f " ", ## arg) |
0da336e5f dm: expose macros |
389 390 391 392 393 |
#define DMERR(f, arg...) \ printk(KERN_ERR DM_NAME ": " DM_MSG_PREFIX ": " f " ", ## arg) #define DMERR_LIMIT(f, arg...) \ do { \ |
71a16736a dm: use local pri... |
394 |
if (dm_ratelimit()) \ |
0da336e5f dm: expose macros |
395 396 397 398 399 400 401 402 403 404 |
printk(KERN_ERR DM_NAME ": " DM_MSG_PREFIX ": " \ f " ", ## arg); \ } while (0) #define DMWARN(f, arg...) \ printk(KERN_WARNING DM_NAME ": " DM_MSG_PREFIX ": " f " ", ## arg) #define DMWARN_LIMIT(f, arg...) \ do { \ |
71a16736a dm: use local pri... |
405 |
if (dm_ratelimit()) \ |
0da336e5f dm: expose macros |
406 407 408 409 410 411 412 413 414 415 |
printk(KERN_WARNING DM_NAME ": " DM_MSG_PREFIX ": " \ f " ", ## arg); \ } while (0) #define DMINFO(f, arg...) \ printk(KERN_INFO DM_NAME ": " DM_MSG_PREFIX ": " f " ", ## arg) #define DMINFO_LIMIT(f, arg...) \ do { \ |
71a16736a dm: use local pri... |
416 |
if (dm_ratelimit()) \ |
0da336e5f dm: expose macros |
417 418 419 420 421 422 423 424 425 426 427 |
printk(KERN_INFO DM_NAME ": " DM_MSG_PREFIX ": " f \ " ", ## arg); \ } while (0) #ifdef CONFIG_DM_DEBUG # define DMDEBUG(f, arg...) \ printk(KERN_DEBUG DM_NAME ": " DM_MSG_PREFIX " DEBUG: " f " ", ## arg) # define DMDEBUG_LIMIT(f, arg...) \ do { \ |
71a16736a dm: use local pri... |
428 |
if (dm_ratelimit()) \ |
0da336e5f dm: expose macros |
429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 |
printk(KERN_DEBUG DM_NAME ": " DM_MSG_PREFIX ": " f \ " ", ## arg); \ } while (0) #else # define DMDEBUG(f, arg...) do {} while (0) # define DMDEBUG_LIMIT(f, arg...) do {} while (0) #endif #define DMEMIT(x...) sz += ((sz >= maxlen) ? \ 0 : scnprintf(result + sz, maxlen - sz, x)) #define SECTOR_SHIFT 9 /* * Definitions of return values from target end_io function. */ #define DM_ENDIO_INCOMPLETE 1 #define DM_ENDIO_REQUEUE 2 /* * Definitions of return values from target map function. */ #define DM_MAPIO_SUBMITTED 0 #define DM_MAPIO_REMAPPED 1 #define DM_MAPIO_REQUEUE DM_ENDIO_REQUEUE /* * Ceiling(n / sz) */ #define dm_div_up(n, sz) (((n) + (sz) - 1) / (sz)) #define dm_sector_div_up(n, sz) ( \ { \ sector_t _r = ((n) + (sz) - 1); \ sector_div(_r, (sz)); \ _r; \ } \ ) /* * ceiling(n / size) * size */ #define dm_round_up(n, sz) (dm_div_up((n), (sz)) * (sz)) |
d63a5ce3c dm: publish array... |
473 474 |
#define dm_array_too_big(fixed, obj, num) \ ((num) > (UINT_MAX - (fixed)) / (obj)) |
56a67df76 dm: factor out ma... |
475 476 477 478 479 |
/* * Sector offset taken relative to the start of the target instead of * relative to the start of the device. */ #define dm_target_offset(ti, sector) ((sector) - (ti)->begin) |
0da336e5f dm: expose macros |
480 481 482 483 484 485 486 487 488 |
static inline sector_t to_sector(unsigned long n) { return (n >> SECTOR_SHIFT); } static inline unsigned long to_bytes(sector_t n) { return (n << SECTOR_SHIFT); } |
cec47e3d4 dm: prepare for r... |
489 490 491 492 493 494 495 |
/*----------------------------------------------------------------- * Helper for block layer and dm core operations *---------------------------------------------------------------*/ void dm_dispatch_request(struct request *rq); void dm_requeue_unmapped_request(struct request *rq); void dm_kill_unmapped_request(struct request *rq, int error); int dm_underlying_device_busy(struct request_queue *q); |
17b2f66f2 [PATCH] dm: add e... |
496 |
#endif /* _LINUX_DEVICE_MAPPER_H */ |