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