1
2
3
4
5
6
7
8#ifndef _LINUX_DEVICE_MAPPER_H
9#define _LINUX_DEVICE_MAPPER_H
10
11#include <linux/bio.h>
12#include <linux/blkdev.h>
13#include <linux/dm-ioctl.h>
14#include <linux/math64.h>
15#include <linux/ratelimit.h>
16
17struct dm_dev;
18struct dm_target;
19struct dm_table;
20struct dm_report_zones_args;
21struct mapped_device;
22struct bio_vec;
23
24
25
26
27enum dm_queue_mode {
28 DM_TYPE_NONE = 0,
29 DM_TYPE_BIO_BASED = 1,
30 DM_TYPE_REQUEST_BASED = 2,
31 DM_TYPE_DAX_BIO_BASED = 3,
32 DM_TYPE_NVME_BIO_BASED = 4,
33};
34
35typedef enum { STATUSTYPE_INFO, STATUSTYPE_TABLE } status_type_t;
36
37union map_info {
38 void *ptr;
39};
40
41
42
43
44
45typedef int (*dm_ctr_fn) (struct dm_target *target,
46 unsigned int argc, char **argv);
47
48
49
50
51
52typedef void (*dm_dtr_fn) (struct dm_target *ti);
53
54
55
56
57
58
59
60
61typedef int (*dm_map_fn) (struct dm_target *ti, struct bio *bio);
62typedef int (*dm_clone_and_map_request_fn) (struct dm_target *ti,
63 struct request *rq,
64 union map_info *map_context,
65 struct request **clone);
66typedef void (*dm_release_clone_request_fn) (struct request *clone,
67 union map_info *map_context);
68
69
70
71
72
73
74
75
76
77typedef int (*dm_endio_fn) (struct dm_target *ti,
78 struct bio *bio, blk_status_t *error);
79typedef int (*dm_request_endio_fn) (struct dm_target *ti,
80 struct request *clone, blk_status_t error,
81 union map_info *map_context);
82
83typedef void (*dm_presuspend_fn) (struct dm_target *ti);
84typedef void (*dm_presuspend_undo_fn) (struct dm_target *ti);
85typedef void (*dm_postsuspend_fn) (struct dm_target *ti);
86typedef int (*dm_preresume_fn) (struct dm_target *ti);
87typedef void (*dm_resume_fn) (struct dm_target *ti);
88
89typedef void (*dm_status_fn) (struct dm_target *ti, status_type_t status_type,
90 unsigned status_flags, char *result, unsigned maxlen);
91
92typedef int (*dm_message_fn) (struct dm_target *ti, unsigned argc, char **argv,
93 char *result, unsigned maxlen);
94
95typedef int (*dm_prepare_ioctl_fn) (struct dm_target *ti, struct block_device **bdev);
96
97typedef int (*dm_report_zones_fn) (struct dm_target *ti,
98 struct dm_report_zones_args *args,
99 unsigned int nr_zones);
100
101
102
103
104
105
106
107
108
109
110
111typedef int (*iterate_devices_callout_fn) (struct dm_target *ti,
112 struct dm_dev *dev,
113 sector_t start, sector_t len,
114 void *data);
115
116
117
118
119
120
121typedef int (*dm_iterate_devices_fn) (struct dm_target *ti,
122 iterate_devices_callout_fn fn,
123 void *data);
124
125typedef void (*dm_io_hints_fn) (struct dm_target *ti,
126 struct queue_limits *limits);
127
128
129
130
131
132
133typedef int (*dm_busy_fn) (struct dm_target *ti);
134
135
136
137
138
139
140typedef long (*dm_dax_direct_access_fn) (struct dm_target *ti, pgoff_t pgoff,
141 long nr_pages, void **kaddr, pfn_t *pfn);
142typedef size_t (*dm_dax_copy_iter_fn)(struct dm_target *ti, pgoff_t pgoff,
143 void *addr, size_t bytes, struct iov_iter *i);
144typedef int (*dm_dax_zero_page_range_fn)(struct dm_target *ti, pgoff_t pgoff,
145 size_t nr_pages);
146#define PAGE_SECTORS (PAGE_SIZE / 512)
147
148void dm_error(const char *message);
149
150struct dm_dev {
151 struct block_device *bdev;
152 struct dax_device *dax_dev;
153 fmode_t mode;
154 char name[16];
155};
156
157dev_t dm_get_dev_t(const char *path);
158
159
160
161
162
163int dm_get_device(struct dm_target *ti, const char *path, fmode_t mode,
164 struct dm_dev **result);
165void dm_put_device(struct dm_target *ti, struct dm_dev *d);
166
167
168
169
170
171struct target_type {
172 uint64_t features;
173 const char *name;
174 struct module *module;
175 unsigned version[3];
176 dm_ctr_fn ctr;
177 dm_dtr_fn dtr;
178 dm_map_fn map;
179 dm_clone_and_map_request_fn clone_and_map_rq;
180 dm_release_clone_request_fn release_clone_rq;
181 dm_endio_fn end_io;
182 dm_request_endio_fn rq_end_io;
183 dm_presuspend_fn presuspend;
184 dm_presuspend_undo_fn presuspend_undo;
185 dm_postsuspend_fn postsuspend;
186 dm_preresume_fn preresume;
187 dm_resume_fn resume;
188 dm_status_fn status;
189 dm_message_fn message;
190 dm_prepare_ioctl_fn prepare_ioctl;
191#ifdef CONFIG_BLK_DEV_ZONED
192 dm_report_zones_fn report_zones;
193#endif
194 dm_busy_fn busy;
195 dm_iterate_devices_fn iterate_devices;
196 dm_io_hints_fn io_hints;
197 dm_dax_direct_access_fn direct_access;
198 dm_dax_copy_iter_fn dax_copy_from_iter;
199 dm_dax_copy_iter_fn dax_copy_to_iter;
200 dm_dax_zero_page_range_fn dax_zero_page_range;
201
202
203 struct list_head list;
204};
205
206
207
208
209
210
211
212
213#define DM_TARGET_SINGLETON 0x00000001
214#define dm_target_needs_singleton(type) ((type)->features & DM_TARGET_SINGLETON)
215
216
217
218
219#define DM_TARGET_ALWAYS_WRITEABLE 0x00000002
220#define dm_target_always_writeable(type) \
221 ((type)->features & DM_TARGET_ALWAYS_WRITEABLE)
222
223
224
225
226
227#define DM_TARGET_IMMUTABLE 0x00000004
228#define dm_target_is_immutable(type) ((type)->features & DM_TARGET_IMMUTABLE)
229
230
231
232
233
234#define DM_TARGET_WILDCARD 0x00000008
235#define dm_target_is_wildcard(type) ((type)->features & DM_TARGET_WILDCARD)
236
237
238
239
240#define DM_TARGET_INTEGRITY 0x00000010
241#define dm_target_has_integrity(type) ((type)->features & DM_TARGET_INTEGRITY)
242
243
244
245
246#define DM_TARGET_PASSES_INTEGRITY 0x00000020
247#define dm_target_passes_integrity(type) ((type)->features & DM_TARGET_PASSES_INTEGRITY)
248
249
250
251
252#define DM_TARGET_ZONED_HM 0x00000040
253#define dm_target_supports_zoned_hm(type) ((type)->features & DM_TARGET_ZONED_HM)
254
255struct dm_target {
256 struct dm_table *table;
257 struct target_type *type;
258
259
260 sector_t begin;
261 sector_t len;
262
263
264 uint32_t max_io_len;
265
266
267
268
269
270
271
272
273
274 unsigned num_flush_bios;
275
276
277
278
279
280 unsigned num_discard_bios;
281
282
283
284
285
286 unsigned num_secure_erase_bios;
287
288
289
290
291
292 unsigned num_write_same_bios;
293
294
295
296
297
298 unsigned num_write_zeroes_bios;
299
300
301
302
303
304 unsigned per_io_data_size;
305
306
307 void *private;
308
309
310 char *error;
311
312
313
314
315
316 bool flush_supported:1;
317
318
319
320
321
322 bool discards_supported:1;
323};
324
325
326struct dm_target_callbacks {
327 struct list_head list;
328 int (*congested_fn) (struct dm_target_callbacks *, int);
329};
330
331void *dm_per_bio_data(struct bio *bio, size_t data_size);
332struct bio *dm_bio_from_per_bio_data(void *data, size_t data_size);
333unsigned dm_bio_get_target_bio_nr(const struct bio *bio);
334
335u64 dm_start_time_ns_from_clone(struct bio *bio);
336
337int dm_register_target(struct target_type *t);
338void dm_unregister_target(struct target_type *t);
339
340
341
342
343struct dm_arg_set {
344 unsigned argc;
345 char **argv;
346};
347
348
349
350
351
352struct dm_arg {
353 unsigned min;
354 unsigned max;
355 char *error;
356};
357
358
359
360
361
362int dm_read_arg(const struct dm_arg *arg, struct dm_arg_set *arg_set,
363 unsigned *value, char **error);
364
365
366
367
368
369
370int dm_read_arg_group(const struct dm_arg *arg, struct dm_arg_set *arg_set,
371 unsigned *num_args, char **error);
372
373
374
375
376const char *dm_shift_arg(struct dm_arg_set *as);
377
378
379
380
381void dm_consume_args(struct dm_arg_set *as, unsigned num_args);
382
383
384
385
386
387
388
389
390
391#define DM_ANY_MINOR (-1)
392int dm_create(int minor, struct mapped_device **md);
393
394
395
396
397struct mapped_device *dm_get_md(dev_t dev);
398void dm_get(struct mapped_device *md);
399int dm_hold(struct mapped_device *md);
400void dm_put(struct mapped_device *md);
401
402
403
404
405void dm_set_mdptr(struct mapped_device *md, void *ptr);
406void *dm_get_mdptr(struct mapped_device *md);
407
408
409
410
411int dm_suspend(struct mapped_device *md, unsigned suspend_flags);
412int dm_resume(struct mapped_device *md);
413
414
415
416
417uint32_t dm_get_event_nr(struct mapped_device *md);
418int dm_wait_event(struct mapped_device *md, int event_nr);
419uint32_t dm_next_uevent_seq(struct mapped_device *md);
420void dm_uevent_add(struct mapped_device *md, struct list_head *elist);
421
422
423
424
425const char *dm_device_name(struct mapped_device *md);
426int dm_copy_name_and_uuid(struct mapped_device *md, char *name, char *uuid);
427struct gendisk *dm_disk(struct mapped_device *md);
428int dm_suspended(struct dm_target *ti);
429int dm_post_suspending(struct dm_target *ti);
430int dm_noflush_suspending(struct dm_target *ti);
431void dm_accept_partial_bio(struct bio *bio, unsigned n_sectors);
432union map_info *dm_get_rq_mapinfo(struct request *rq);
433
434#ifdef CONFIG_BLK_DEV_ZONED
435struct dm_report_zones_args {
436 struct dm_target *tgt;
437 sector_t next_sector;
438
439 void *orig_data;
440 report_zones_cb orig_cb;
441 unsigned int zone_idx;
442
443
444 sector_t start;
445};
446int dm_report_zones_cb(struct blk_zone *zone, unsigned int idx, void *data);
447#endif
448
449
450
451
452
453int __init dm_early_create(struct dm_ioctl *dmi,
454 struct dm_target_spec **spec_array,
455 char **target_params_array);
456
457struct queue_limits *dm_get_queue_limits(struct mapped_device *md);
458
459
460
461
462int dm_get_geometry(struct mapped_device *md, struct hd_geometry *geo);
463int dm_set_geometry(struct mapped_device *md, struct hd_geometry *geo);
464
465
466
467
468
469
470
471
472int dm_table_create(struct dm_table **result, fmode_t mode,
473 unsigned num_targets, struct mapped_device *md);
474
475
476
477
478int dm_table_add_target(struct dm_table *t, const char *type,
479 sector_t start, sector_t len, char *params);
480
481
482
483
484void dm_table_add_target_callbacks(struct dm_table *t, struct dm_target_callbacks *cb);
485
486
487
488
489
490
491
492void dm_table_set_type(struct dm_table *t, enum dm_queue_mode type);
493
494
495
496
497int dm_table_complete(struct dm_table *t);
498
499
500
501
502void dm_table_destroy(struct dm_table *t);
503
504
505
506
507int __must_check dm_set_target_max_io_len(struct dm_target *ti, sector_t len);
508
509
510
511
512struct dm_table *dm_get_live_table(struct mapped_device *md, int *srcu_idx);
513void dm_put_live_table(struct mapped_device *md, int srcu_idx);
514void dm_sync_table(struct mapped_device *md);
515
516
517
518
519sector_t dm_table_get_size(struct dm_table *t);
520unsigned int dm_table_get_num_targets(struct dm_table *t);
521fmode_t dm_table_get_mode(struct dm_table *t);
522struct mapped_device *dm_table_get_md(struct dm_table *t);
523const char *dm_table_device_name(struct dm_table *t);
524
525
526
527
528void dm_table_event(struct dm_table *t);
529
530
531
532
533void dm_table_run_md_queue_async(struct dm_table *t);
534
535
536
537
538
539struct dm_table *dm_swap_table(struct mapped_device *md,
540 struct dm_table *t);
541
542
543
544
545void *dm_vcalloc(unsigned long nmemb, unsigned long elem_size);
546
547
548
549
550#define DM_NAME "device-mapper"
551
552#define DM_FMT(fmt) DM_NAME ": " DM_MSG_PREFIX ": " fmt "\n"
553
554#define DMCRIT(fmt, ...) pr_crit(DM_FMT(fmt), ##__VA_ARGS__)
555
556#define DMERR(fmt, ...) pr_err(DM_FMT(fmt), ##__VA_ARGS__)
557#define DMERR_LIMIT(fmt, ...) pr_err_ratelimited(DM_FMT(fmt), ##__VA_ARGS__)
558#define DMWARN(fmt, ...) pr_warn(DM_FMT(fmt), ##__VA_ARGS__)
559#define DMWARN_LIMIT(fmt, ...) pr_warn_ratelimited(DM_FMT(fmt), ##__VA_ARGS__)
560#define DMINFO(fmt, ...) pr_info(DM_FMT(fmt), ##__VA_ARGS__)
561#define DMINFO_LIMIT(fmt, ...) pr_info_ratelimited(DM_FMT(fmt), ##__VA_ARGS__)
562
563#define DMDEBUG(fmt, ...) pr_debug(DM_FMT(fmt), ##__VA_ARGS__)
564#define DMDEBUG_LIMIT(fmt, ...) pr_debug_ratelimited(DM_FMT(fmt), ##__VA_ARGS__)
565
566#define DMEMIT(x...) sz += ((sz >= maxlen) ? \
567 0 : scnprintf(result + sz, maxlen - sz, x))
568
569
570
571
572#define DM_ENDIO_DONE 0
573#define DM_ENDIO_INCOMPLETE 1
574#define DM_ENDIO_REQUEUE 2
575#define DM_ENDIO_DELAY_REQUEUE 3
576
577
578
579
580#define DM_MAPIO_SUBMITTED 0
581#define DM_MAPIO_REMAPPED 1
582#define DM_MAPIO_REQUEUE DM_ENDIO_REQUEUE
583#define DM_MAPIO_DELAY_REQUEUE DM_ENDIO_DELAY_REQUEUE
584#define DM_MAPIO_KILL 4
585
586#define dm_sector_div64(x, y)( \
587{ \
588 u64 _res; \
589 (x) = div64_u64_rem(x, y, &_res); \
590 _res; \
591} \
592)
593
594
595
596
597#define dm_div_up(n, sz) (((n) + (sz) - 1) / (sz))
598
599#define dm_sector_div_up(n, sz) ( \
600{ \
601 sector_t _r = ((n) + (sz) - 1); \
602 sector_div(_r, (sz)); \
603 _r; \
604} \
605)
606
607
608
609
610#define dm_round_up(n, sz) (dm_div_up((n), (sz)) * (sz))
611
612
613
614
615
616#define dm_target_offset(ti, sector) ((sector) - (ti)->begin)
617
618static inline sector_t to_sector(unsigned long long n)
619{
620 return (n >> SECTOR_SHIFT);
621}
622
623static inline unsigned long to_bytes(sector_t n)
624{
625 return (n << SECTOR_SHIFT);
626}
627
628#endif
629