Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
2 | * Copyright (C) 2001 Sistina Software (UK) Limited. | |
0da336e5 | 3 | * Copyright (C) 2004-2008 Red Hat, Inc. All rights reserved. |
1da177e4 LT |
4 | * |
5 | * This file is released under the LGPL. | |
6 | */ | |
7 | ||
8 | #ifndef _LINUX_DEVICE_MAPPER_H | |
9 | #define _LINUX_DEVICE_MAPPER_H | |
10 | ||
416cd17b | 11 | #include <linux/bio.h> |
f6fccb12 | 12 | #include <linux/blkdev.h> |
fd2ed4d2 | 13 | #include <linux/math64.h> |
71a16736 | 14 | #include <linux/ratelimit.h> |
416cd17b | 15 | |
af4874e0 | 16 | struct dm_dev; |
1da177e4 LT |
17 | struct dm_target; |
18 | struct dm_table; | |
17b2f66f | 19 | struct mapped_device; |
f6fccb12 | 20 | struct bio_vec; |
1da177e4 | 21 | |
e83068a5 MS |
22 | /* |
23 | * Type of table, mapped_device's mempool and request_queue | |
24 | */ | |
25 | #define DM_TYPE_NONE 0 | |
26 | #define DM_TYPE_BIO_BASED 1 | |
27 | #define DM_TYPE_REQUEST_BASED 2 | |
28 | #define DM_TYPE_MQ_REQUEST_BASED 3 | |
545ed20e | 29 | #define DM_TYPE_DAX_BIO_BASED 4 |
e83068a5 | 30 | |
1da177e4 LT |
31 | typedef enum { STATUSTYPE_INFO, STATUSTYPE_TABLE } status_type_t; |
32 | ||
33 | union map_info { | |
34 | void *ptr; | |
1da177e4 LT |
35 | }; |
36 | ||
37 | /* | |
38 | * In the constructor the target parameter will already have the | |
39 | * table, type, begin and len fields filled in. | |
40 | */ | |
41 | typedef int (*dm_ctr_fn) (struct dm_target *target, | |
42 | unsigned int argc, char **argv); | |
43 | ||
44 | /* | |
45 | * The destructor doesn't need to free the dm_target, just | |
46 | * anything hidden ti->private. | |
47 | */ | |
48 | typedef void (*dm_dtr_fn) (struct dm_target *ti); | |
49 | ||
50 | /* | |
51 | * The map function must return: | |
52 | * < 0: error | |
53 | * = 0: The target will handle the io by resubmitting it later | |
45cbcd79 | 54 | * = 1: simple remap complete |
2e93ccc1 | 55 | * = 2: The target wants to push back the io |
1da177e4 | 56 | */ |
7de3ee57 | 57 | typedef int (*dm_map_fn) (struct dm_target *ti, struct bio *bio); |
e5863d9a MS |
58 | typedef int (*dm_clone_and_map_request_fn) (struct dm_target *ti, |
59 | struct request *rq, | |
60 | union map_info *map_context, | |
61 | struct request **clone); | |
62 | typedef void (*dm_release_clone_request_fn) (struct request *clone); | |
1da177e4 LT |
63 | |
64 | /* | |
65 | * Returns: | |
66 | * < 0 : error (currently ignored) | |
67 | * 0 : ended successfully | |
68 | * 1 : for some reason the io has still not completed (eg, | |
69 | * multipath target might want to requeue a failed io). | |
2e93ccc1 | 70 | * 2 : The target wants to push back the io |
1da177e4 LT |
71 | */ |
72 | typedef int (*dm_endio_fn) (struct dm_target *ti, | |
7de3ee57 | 73 | struct bio *bio, int error); |
7d76345d KU |
74 | typedef int (*dm_request_endio_fn) (struct dm_target *ti, |
75 | struct request *clone, int error, | |
76 | union map_info *map_context); | |
1da177e4 LT |
77 | |
78 | typedef void (*dm_presuspend_fn) (struct dm_target *ti); | |
d67ee213 | 79 | typedef void (*dm_presuspend_undo_fn) (struct dm_target *ti); |
1da177e4 | 80 | typedef void (*dm_postsuspend_fn) (struct dm_target *ti); |
8757b776 | 81 | typedef int (*dm_preresume_fn) (struct dm_target *ti); |
1da177e4 LT |
82 | typedef void (*dm_resume_fn) (struct dm_target *ti); |
83 | ||
fd7c092e MP |
84 | typedef void (*dm_status_fn) (struct dm_target *ti, status_type_t status_type, |
85 | unsigned status_flags, char *result, unsigned maxlen); | |
1da177e4 LT |
86 | |
87 | typedef int (*dm_message_fn) (struct dm_target *ti, unsigned argc, char **argv); | |
88 | ||
e56f81e0 CH |
89 | typedef int (*dm_prepare_ioctl_fn) (struct dm_target *ti, |
90 | struct block_device **bdev, fmode_t *mode); | |
aa129a22 | 91 | |
058ce5ca AK |
92 | /* |
93 | * These iteration functions are typically used to check (and combine) | |
94 | * properties of underlying devices. | |
95 | * E.g. Does at least one underlying device support flush? | |
96 | * Does any underlying device not support WRITE_SAME? | |
97 | * | |
98 | * The callout function is called once for each contiguous section of | |
99 | * an underlying device. State can be maintained in *data. | |
100 | * Return non-zero to stop iterating through any further devices. | |
101 | */ | |
af4874e0 MS |
102 | typedef int (*iterate_devices_callout_fn) (struct dm_target *ti, |
103 | struct dm_dev *dev, | |
5dea271b | 104 | sector_t start, sector_t len, |
af4874e0 MS |
105 | void *data); |
106 | ||
058ce5ca AK |
107 | /* |
108 | * This function must iterate through each section of device used by the | |
109 | * target until it encounters a non-zero return code, which it then returns. | |
110 | * Returns zero if no callout returned non-zero. | |
111 | */ | |
af4874e0 MS |
112 | typedef int (*dm_iterate_devices_fn) (struct dm_target *ti, |
113 | iterate_devices_callout_fn fn, | |
114 | void *data); | |
115 | ||
40bea431 MS |
116 | typedef void (*dm_io_hints_fn) (struct dm_target *ti, |
117 | struct queue_limits *limits); | |
118 | ||
7d76345d KU |
119 | /* |
120 | * Returns: | |
121 | * 0: The target can handle the next I/O immediately. | |
122 | * 1: The target can't handle the next I/O immediately. | |
123 | */ | |
124 | typedef int (*dm_busy_fn) (struct dm_target *ti); | |
125 | ||
545ed20e TK |
126 | /* |
127 | * Returns: | |
128 | * < 0 : error | |
129 | * >= 0 : the number of bytes accessible at the address | |
130 | */ | |
131 | typedef long (*dm_direct_access_fn) (struct dm_target *ti, sector_t sector, | |
f0c98ebc | 132 | void **kaddr, pfn_t *pfn, long size); |
545ed20e | 133 | |
1da177e4 LT |
134 | void dm_error(const char *message); |
135 | ||
82b1519b MP |
136 | struct dm_dev { |
137 | struct block_device *bdev; | |
aeb5d727 | 138 | fmode_t mode; |
82b1519b MP |
139 | char name[16]; |
140 | }; | |
141 | ||
4df2bf46 D |
142 | dev_t dm_get_dev_t(const char *path); |
143 | ||
1da177e4 LT |
144 | /* |
145 | * Constructors should call these functions to ensure destination devices | |
146 | * are opened/closed correctly. | |
1da177e4 | 147 | */ |
8215d6ec | 148 | int dm_get_device(struct dm_target *ti, const char *path, fmode_t mode, |
11f0431b | 149 | struct dm_dev **result); |
1da177e4 LT |
150 | void dm_put_device(struct dm_target *ti, struct dm_dev *d); |
151 | ||
152 | /* | |
153 | * Information about a target type | |
154 | */ | |
ab4c1424 | 155 | |
1da177e4 | 156 | struct target_type { |
ab4c1424 | 157 | uint64_t features; |
1da177e4 LT |
158 | const char *name; |
159 | struct module *module; | |
17b2f66f | 160 | unsigned version[3]; |
1da177e4 LT |
161 | dm_ctr_fn ctr; |
162 | dm_dtr_fn dtr; | |
163 | dm_map_fn map; | |
e5863d9a MS |
164 | dm_clone_and_map_request_fn clone_and_map_rq; |
165 | dm_release_clone_request_fn release_clone_rq; | |
1da177e4 | 166 | dm_endio_fn end_io; |
7d76345d | 167 | dm_request_endio_fn rq_end_io; |
1da177e4 | 168 | dm_presuspend_fn presuspend; |
d67ee213 | 169 | dm_presuspend_undo_fn presuspend_undo; |
1da177e4 | 170 | dm_postsuspend_fn postsuspend; |
8757b776 | 171 | dm_preresume_fn preresume; |
1da177e4 LT |
172 | dm_resume_fn resume; |
173 | dm_status_fn status; | |
174 | dm_message_fn message; | |
e56f81e0 | 175 | dm_prepare_ioctl_fn prepare_ioctl; |
7d76345d | 176 | dm_busy_fn busy; |
af4874e0 | 177 | dm_iterate_devices_fn iterate_devices; |
40bea431 | 178 | dm_io_hints_fn io_hints; |
545ed20e | 179 | dm_direct_access_fn direct_access; |
45194e4f CR |
180 | |
181 | /* For internal device-mapper use. */ | |
182 | struct list_head list; | |
1da177e4 LT |
183 | }; |
184 | ||
3791e2fc AK |
185 | /* |
186 | * Target features | |
187 | */ | |
188 | ||
189 | /* | |
190 | * Any table that contains an instance of this target must have only one. | |
191 | */ | |
192 | #define DM_TARGET_SINGLETON 0x00000001 | |
193 | #define dm_target_needs_singleton(type) ((type)->features & DM_TARGET_SINGLETON) | |
194 | ||
cc6cbe14 AK |
195 | /* |
196 | * Indicates that a target does not support read-only devices. | |
197 | */ | |
198 | #define DM_TARGET_ALWAYS_WRITEABLE 0x00000002 | |
199 | #define dm_target_always_writeable(type) \ | |
200 | ((type)->features & DM_TARGET_ALWAYS_WRITEABLE) | |
201 | ||
36a0456f AK |
202 | /* |
203 | * Any device that contains a table with an instance of this target may never | |
204 | * have tables containing any different target type. | |
205 | */ | |
206 | #define DM_TARGET_IMMUTABLE 0x00000004 | |
207 | #define dm_target_is_immutable(type) ((type)->features & DM_TARGET_IMMUTABLE) | |
208 | ||
f083b09b MS |
209 | /* |
210 | * Indicates that a target may replace any target; even immutable targets. | |
211 | * .map, .map_rq, .clone_and_map_rq and .release_clone_rq are all defined. | |
212 | */ | |
213 | #define DM_TARGET_WILDCARD 0x00000008 | |
214 | #define dm_target_is_wildcard(type) ((type)->features & DM_TARGET_WILDCARD) | |
215 | ||
b0d8ed4d AK |
216 | /* |
217 | * Some targets need to be sent the same WRITE bio severals times so | |
218 | * that they can send copies of it to different devices. This function | |
219 | * examines any supplied bio and returns the number of copies of it the | |
220 | * target requires. | |
221 | */ | |
222 | typedef unsigned (*dm_num_write_bios_fn) (struct dm_target *ti, struct bio *bio); | |
223 | ||
9b4b5a79 MB |
224 | /* |
225 | * A target implements own bio data integrity. | |
226 | */ | |
227 | #define DM_TARGET_INTEGRITY 0x00000010 | |
228 | #define dm_target_has_integrity(type) ((type)->features & DM_TARGET_INTEGRITY) | |
229 | ||
e2460f2a MP |
230 | /* |
231 | * A target passes integrity data to the lower device. | |
232 | */ | |
233 | #define DM_TARGET_PASSES_INTEGRITY 0x00000020 | |
234 | #define dm_target_passes_integrity(type) ((type)->features & DM_TARGET_PASSES_INTEGRITY) | |
235 | ||
1da177e4 LT |
236 | struct dm_target { |
237 | struct dm_table *table; | |
238 | struct target_type *type; | |
239 | ||
240 | /* target limits */ | |
241 | sector_t begin; | |
242 | sector_t len; | |
243 | ||
542f9038 MS |
244 | /* If non-zero, maximum size of I/O submitted to a target. */ |
245 | uint32_t max_io_len; | |
1da177e4 | 246 | |
f9ab94ce | 247 | /* |
55a62eef | 248 | * A number of zero-length barrier bios that will be submitted |
f9ab94ce MP |
249 | * to the target for the purpose of flushing cache. |
250 | * | |
55a62eef AK |
251 | * The bio number can be accessed with dm_bio_get_target_bio_nr. |
252 | * It is a responsibility of the target driver to remap these bios | |
f9ab94ce MP |
253 | * to the real underlying devices. |
254 | */ | |
55a62eef | 255 | unsigned num_flush_bios; |
f9ab94ce | 256 | |
5ae89a87 | 257 | /* |
55a62eef AK |
258 | * The number of discard bios that will be submitted to the target. |
259 | * The bio number can be accessed with dm_bio_get_target_bio_nr. | |
5ae89a87 | 260 | */ |
55a62eef | 261 | unsigned num_discard_bios; |
5ae89a87 | 262 | |
d54eaa5a | 263 | /* |
55a62eef AK |
264 | * The number of WRITE SAME bios that will be submitted to the target. |
265 | * The bio number can be accessed with dm_bio_get_target_bio_nr. | |
d54eaa5a | 266 | */ |
55a62eef | 267 | unsigned num_write_same_bios; |
d54eaa5a | 268 | |
c0820cf5 | 269 | /* |
30187e1d MS |
270 | * The minimum number of extra bytes allocated in each io for the |
271 | * target to use. | |
c0820cf5 | 272 | */ |
30187e1d | 273 | unsigned per_io_data_size; |
c0820cf5 | 274 | |
b0d8ed4d AK |
275 | /* |
276 | * If defined, this function is called to find out how many | |
277 | * duplicate bios should be sent to the target when writing | |
278 | * data. | |
279 | */ | |
280 | dm_num_write_bios_fn num_write_bios; | |
281 | ||
1da177e4 LT |
282 | /* target specific data */ |
283 | void *private; | |
284 | ||
285 | /* Used to provide an error string from the ctr */ | |
286 | char *error; | |
4c259327 | 287 | |
0e9c24ed JT |
288 | /* |
289 | * Set if this target needs to receive flushes regardless of | |
290 | * whether or not its underlying devices have support. | |
291 | */ | |
292 | bool flush_supported:1; | |
293 | ||
4c259327 MS |
294 | /* |
295 | * Set if this target needs to receive discards regardless of | |
296 | * whether or not its underlying devices have support. | |
297 | */ | |
0ac55489 | 298 | bool discards_supported:1; |
983c7db3 | 299 | |
7acf0277 | 300 | /* |
55a62eef | 301 | * Set if the target required discard bios to be split |
7acf0277 MP |
302 | * on max_io_len boundary. |
303 | */ | |
55a62eef | 304 | bool split_discard_bios:1; |
7acf0277 | 305 | |
983c7db3 MB |
306 | /* |
307 | * Set if this target does not return zeroes on discarded blocks. | |
308 | */ | |
0ac55489 | 309 | bool discard_zeroes_data_unsupported:1; |
1da177e4 LT |
310 | }; |
311 | ||
9d357b07 N |
312 | /* Each target can link one of these into the table */ |
313 | struct dm_target_callbacks { | |
314 | struct list_head list; | |
315 | int (*congested_fn) (struct dm_target_callbacks *, int); | |
316 | }; | |
317 | ||
c0820cf5 MP |
318 | /* |
319 | * For bio-based dm. | |
320 | * One of these is allocated for each bio. | |
321 | * This structure shouldn't be touched directly by target drivers. | |
322 | * It is here so that we can inline dm_per_bio_data and | |
323 | * dm_bio_from_per_bio_data | |
324 | */ | |
325 | struct dm_target_io { | |
326 | struct dm_io *io; | |
327 | struct dm_target *ti; | |
55a62eef | 328 | unsigned target_bio_nr; |
1dd40c3e | 329 | unsigned *len_ptr; |
c0820cf5 MP |
330 | struct bio clone; |
331 | }; | |
332 | ||
333 | static inline void *dm_per_bio_data(struct bio *bio, size_t data_size) | |
334 | { | |
335 | return (char *)bio - offsetof(struct dm_target_io, clone) - data_size; | |
336 | } | |
337 | ||
338 | static inline struct bio *dm_bio_from_per_bio_data(void *data, size_t data_size) | |
339 | { | |
340 | return (struct bio *)((char *)data + data_size + offsetof(struct dm_target_io, clone)); | |
341 | } | |
342 | ||
55a62eef | 343 | static inline unsigned dm_bio_get_target_bio_nr(const struct bio *bio) |
ddbd658f | 344 | { |
55a62eef | 345 | return container_of(bio, struct dm_target_io, clone)->target_bio_nr; |
ddbd658f MP |
346 | } |
347 | ||
1da177e4 | 348 | int dm_register_target(struct target_type *t); |
10d3bd09 | 349 | void dm_unregister_target(struct target_type *t); |
17b2f66f | 350 | |
498f0103 MS |
351 | /* |
352 | * Target argument parsing. | |
353 | */ | |
354 | struct dm_arg_set { | |
355 | unsigned argc; | |
356 | char **argv; | |
357 | }; | |
358 | ||
359 | /* | |
360 | * The minimum and maximum value of a numeric argument, together with | |
361 | * the error message to use if the number is found to be outside that range. | |
362 | */ | |
363 | struct dm_arg { | |
364 | unsigned min; | |
365 | unsigned max; | |
366 | char *error; | |
367 | }; | |
368 | ||
369 | /* | |
370 | * Validate the next argument, either returning it as *value or, if invalid, | |
371 | * returning -EINVAL and setting *error. | |
372 | */ | |
373 | int dm_read_arg(struct dm_arg *arg, struct dm_arg_set *arg_set, | |
374 | unsigned *value, char **error); | |
375 | ||
376 | /* | |
377 | * Process the next argument as the start of a group containing between | |
378 | * arg->min and arg->max further arguments. Either return the size as | |
379 | * *num_args or, if invalid, return -EINVAL and set *error. | |
380 | */ | |
381 | int dm_read_arg_group(struct dm_arg *arg, struct dm_arg_set *arg_set, | |
382 | unsigned *num_args, char **error); | |
383 | ||
384 | /* | |
385 | * Return the current argument and shift to the next. | |
386 | */ | |
387 | const char *dm_shift_arg(struct dm_arg_set *as); | |
388 | ||
389 | /* | |
390 | * Move through num_args arguments. | |
391 | */ | |
392 | void dm_consume_args(struct dm_arg_set *as, unsigned num_args); | |
393 | ||
17b2f66f AK |
394 | /*----------------------------------------------------------------- |
395 | * Functions for creating and manipulating mapped devices. | |
396 | * Drop the reference with dm_put when you finish with the object. | |
397 | *---------------------------------------------------------------*/ | |
398 | ||
399 | /* | |
400 | * DM_ANY_MINOR chooses the next available minor number. | |
401 | */ | |
402 | #define DM_ANY_MINOR (-1) | |
403 | int dm_create(int minor, struct mapped_device **md); | |
404 | ||
405 | /* | |
406 | * Reference counting for md. | |
407 | */ | |
408 | struct mapped_device *dm_get_md(dev_t dev); | |
409 | void dm_get(struct mapped_device *md); | |
09ee96b2 | 410 | int dm_hold(struct mapped_device *md); |
17b2f66f AK |
411 | void dm_put(struct mapped_device *md); |
412 | ||
413 | /* | |
414 | * An arbitrary pointer may be stored alongside a mapped device. | |
415 | */ | |
416 | void dm_set_mdptr(struct mapped_device *md, void *ptr); | |
417 | void *dm_get_mdptr(struct mapped_device *md); | |
418 | ||
419 | /* | |
420 | * A device can still be used while suspended, but I/O is deferred. | |
421 | */ | |
a3d77d35 | 422 | int dm_suspend(struct mapped_device *md, unsigned suspend_flags); |
17b2f66f AK |
423 | int dm_resume(struct mapped_device *md); |
424 | ||
425 | /* | |
426 | * Event functions. | |
427 | */ | |
428 | uint32_t dm_get_event_nr(struct mapped_device *md); | |
429 | int dm_wait_event(struct mapped_device *md, int event_nr); | |
7a8c3d3b MA |
430 | uint32_t dm_next_uevent_seq(struct mapped_device *md); |
431 | void dm_uevent_add(struct mapped_device *md, struct list_head *elist); | |
17b2f66f AK |
432 | |
433 | /* | |
434 | * Info functions. | |
435 | */ | |
72d94861 | 436 | const char *dm_device_name(struct mapped_device *md); |
96a1f7db | 437 | int dm_copy_name_and_uuid(struct mapped_device *md, char *name, char *uuid); |
17b2f66f | 438 | struct gendisk *dm_disk(struct mapped_device *md); |
64dbce58 | 439 | int dm_suspended(struct dm_target *ti); |
2e93ccc1 | 440 | int dm_noflush_suspending(struct dm_target *ti); |
1dd40c3e | 441 | void dm_accept_partial_bio(struct bio *bio, unsigned n_sectors); |
cec47e3d | 442 | union map_info *dm_get_rq_mapinfo(struct request *rq); |
17b2f66f | 443 | |
f84cb8a4 MS |
444 | struct queue_limits *dm_get_queue_limits(struct mapped_device *md); |
445 | ||
17b2f66f AK |
446 | /* |
447 | * Geometry functions. | |
448 | */ | |
449 | int dm_get_geometry(struct mapped_device *md, struct hd_geometry *geo); | |
450 | int dm_set_geometry(struct mapped_device *md, struct hd_geometry *geo); | |
451 | ||
17b2f66f AK |
452 | /*----------------------------------------------------------------- |
453 | * Functions for manipulating device-mapper tables. | |
454 | *---------------------------------------------------------------*/ | |
455 | ||
456 | /* | |
457 | * First create an empty table. | |
458 | */ | |
aeb5d727 | 459 | int dm_table_create(struct dm_table **result, fmode_t mode, |
17b2f66f AK |
460 | unsigned num_targets, struct mapped_device *md); |
461 | ||
462 | /* | |
463 | * Then call this once for each target. | |
464 | */ | |
465 | int dm_table_add_target(struct dm_table *t, const char *type, | |
466 | sector_t start, sector_t len, char *params); | |
467 | ||
9d357b07 N |
468 | /* |
469 | * Target_ctr should call this if it needs to add any callbacks. | |
470 | */ | |
471 | void dm_table_add_target_callbacks(struct dm_table *t, struct dm_target_callbacks *cb); | |
e83068a5 MS |
472 | |
473 | /* | |
474 | * Target can use this to set the table's type. | |
475 | * Can only ever be called from a target's ctr. | |
476 | * Useful for "hybrid" target (supports both bio-based | |
477 | * and request-based). | |
478 | */ | |
479 | void dm_table_set_type(struct dm_table *t, unsigned type); | |
9d357b07 | 480 | |
17b2f66f AK |
481 | /* |
482 | * Finally call this to make the table ready for use. | |
483 | */ | |
484 | int dm_table_complete(struct dm_table *t); | |
485 | ||
542f9038 MS |
486 | /* |
487 | * Target may require that it is never sent I/O larger than len. | |
488 | */ | |
489 | int __must_check dm_set_target_max_io_len(struct dm_target *ti, sector_t len); | |
490 | ||
17b2f66f AK |
491 | /* |
492 | * Table reference counting. | |
493 | */ | |
83d5e5b0 MP |
494 | struct dm_table *dm_get_live_table(struct mapped_device *md, int *srcu_idx); |
495 | void dm_put_live_table(struct mapped_device *md, int srcu_idx); | |
496 | void dm_sync_table(struct mapped_device *md); | |
17b2f66f AK |
497 | |
498 | /* | |
499 | * Queries | |
500 | */ | |
501 | sector_t dm_table_get_size(struct dm_table *t); | |
502 | unsigned int dm_table_get_num_targets(struct dm_table *t); | |
aeb5d727 | 503 | fmode_t dm_table_get_mode(struct dm_table *t); |
17b2f66f AK |
504 | struct mapped_device *dm_table_get_md(struct dm_table *t); |
505 | ||
506 | /* | |
507 | * Trigger an event. | |
508 | */ | |
509 | void dm_table_event(struct dm_table *t); | |
510 | ||
9974fa2c MS |
511 | /* |
512 | * Run the queue for request-based targets. | |
513 | */ | |
514 | void dm_table_run_md_queue_async(struct dm_table *t); | |
515 | ||
17b2f66f AK |
516 | /* |
517 | * The device must be suspended before calling this method. | |
042d2a9b | 518 | * Returns the previous table, which the caller must destroy. |
17b2f66f | 519 | */ |
042d2a9b AK |
520 | struct dm_table *dm_swap_table(struct mapped_device *md, |
521 | struct dm_table *t); | |
17b2f66f | 522 | |
54160904 MP |
523 | /* |
524 | * A wrapper around vmalloc. | |
525 | */ | |
526 | void *dm_vcalloc(unsigned long nmemb, unsigned long elem_size); | |
527 | ||
0da336e5 AK |
528 | /*----------------------------------------------------------------- |
529 | * Macros. | |
530 | *---------------------------------------------------------------*/ | |
531 | #define DM_NAME "device-mapper" | |
532 | ||
71a16736 NK |
533 | #ifdef CONFIG_PRINTK |
534 | extern struct ratelimit_state dm_ratelimit_state; | |
535 | ||
536 | #define dm_ratelimit() __ratelimit(&dm_ratelimit_state) | |
537 | #else | |
538 | #define dm_ratelimit() 0 | |
539 | #endif | |
540 | ||
10d3bd09 MP |
541 | #define DMCRIT(f, arg...) \ |
542 | printk(KERN_CRIT DM_NAME ": " DM_MSG_PREFIX ": " f "\n", ## arg) | |
543 | ||
0da336e5 AK |
544 | #define DMERR(f, arg...) \ |
545 | printk(KERN_ERR DM_NAME ": " DM_MSG_PREFIX ": " f "\n", ## arg) | |
546 | #define DMERR_LIMIT(f, arg...) \ | |
547 | do { \ | |
71a16736 | 548 | if (dm_ratelimit()) \ |
0da336e5 AK |
549 | printk(KERN_ERR DM_NAME ": " DM_MSG_PREFIX ": " \ |
550 | f "\n", ## arg); \ | |
551 | } while (0) | |
552 | ||
553 | #define DMWARN(f, arg...) \ | |
554 | printk(KERN_WARNING DM_NAME ": " DM_MSG_PREFIX ": " f "\n", ## arg) | |
555 | #define DMWARN_LIMIT(f, arg...) \ | |
556 | do { \ | |
71a16736 | 557 | if (dm_ratelimit()) \ |
0da336e5 AK |
558 | printk(KERN_WARNING DM_NAME ": " DM_MSG_PREFIX ": " \ |
559 | f "\n", ## arg); \ | |
560 | } while (0) | |
561 | ||
562 | #define DMINFO(f, arg...) \ | |
563 | printk(KERN_INFO DM_NAME ": " DM_MSG_PREFIX ": " f "\n", ## arg) | |
564 | #define DMINFO_LIMIT(f, arg...) \ | |
565 | do { \ | |
71a16736 | 566 | if (dm_ratelimit()) \ |
0da336e5 AK |
567 | printk(KERN_INFO DM_NAME ": " DM_MSG_PREFIX ": " f \ |
568 | "\n", ## arg); \ | |
569 | } while (0) | |
570 | ||
571 | #ifdef CONFIG_DM_DEBUG | |
572 | # define DMDEBUG(f, arg...) \ | |
573 | printk(KERN_DEBUG DM_NAME ": " DM_MSG_PREFIX " DEBUG: " f "\n", ## arg) | |
574 | # define DMDEBUG_LIMIT(f, arg...) \ | |
575 | do { \ | |
71a16736 | 576 | if (dm_ratelimit()) \ |
0da336e5 AK |
577 | printk(KERN_DEBUG DM_NAME ": " DM_MSG_PREFIX ": " f \ |
578 | "\n", ## arg); \ | |
579 | } while (0) | |
580 | #else | |
581 | # define DMDEBUG(f, arg...) do {} while (0) | |
582 | # define DMDEBUG_LIMIT(f, arg...) do {} while (0) | |
583 | #endif | |
584 | ||
585 | #define DMEMIT(x...) sz += ((sz >= maxlen) ? \ | |
586 | 0 : scnprintf(result + sz, maxlen - sz, x)) | |
587 | ||
588 | #define SECTOR_SHIFT 9 | |
589 | ||
590 | /* | |
591 | * Definitions of return values from target end_io function. | |
592 | */ | |
593 | #define DM_ENDIO_INCOMPLETE 1 | |
594 | #define DM_ENDIO_REQUEUE 2 | |
595 | ||
596 | /* | |
597 | * Definitions of return values from target map function. | |
598 | */ | |
599 | #define DM_MAPIO_SUBMITTED 0 | |
600 | #define DM_MAPIO_REMAPPED 1 | |
601 | #define DM_MAPIO_REQUEUE DM_ENDIO_REQUEUE | |
a8ac51e4 | 602 | #define DM_MAPIO_DELAY_REQUEUE 3 |
0da336e5 | 603 | |
fd2ed4d2 MP |
604 | #define dm_sector_div64(x, y)( \ |
605 | { \ | |
606 | u64 _res; \ | |
607 | (x) = div64_u64_rem(x, y, &_res); \ | |
608 | _res; \ | |
609 | } \ | |
610 | ) | |
611 | ||
0da336e5 AK |
612 | /* |
613 | * Ceiling(n / sz) | |
614 | */ | |
615 | #define dm_div_up(n, sz) (((n) + (sz) - 1) / (sz)) | |
616 | ||
617 | #define dm_sector_div_up(n, sz) ( \ | |
618 | { \ | |
619 | sector_t _r = ((n) + (sz) - 1); \ | |
620 | sector_div(_r, (sz)); \ | |
621 | _r; \ | |
622 | } \ | |
623 | ) | |
624 | ||
625 | /* | |
626 | * ceiling(n / size) * size | |
627 | */ | |
628 | #define dm_round_up(n, sz) (dm_div_up((n), (sz)) * (sz)) | |
629 | ||
d63a5ce3 MP |
630 | #define dm_array_too_big(fixed, obj, num) \ |
631 | ((num) > (UINT_MAX - (fixed)) / (obj)) | |
632 | ||
56a67df7 MS |
633 | /* |
634 | * Sector offset taken relative to the start of the target instead of | |
635 | * relative to the start of the device. | |
636 | */ | |
637 | #define dm_target_offset(ti, sector) ((sector) - (ti)->begin) | |
638 | ||
0da336e5 AK |
639 | static inline sector_t to_sector(unsigned long n) |
640 | { | |
641 | return (n >> SECTOR_SHIFT); | |
642 | } | |
643 | ||
644 | static inline unsigned long to_bytes(sector_t n) | |
645 | { | |
646 | return (n << SECTOR_SHIFT); | |
647 | } | |
648 | ||
17b2f66f | 649 | #endif /* _LINUX_DEVICE_MAPPER_H */ |