Merge tag 'for-linus-5.14-rc6-tag' of git://git.kernel.org/pub/scm/linux/kernel/git...
[linux-2.6-microblaze.git] / include / linux / device-mapper.h
1 /*
2  * Copyright (C) 2001 Sistina Software (UK) Limited.
3  * Copyright (C) 2004-2008 Red Hat, Inc. All rights reserved.
4  *
5  * This file is released under the LGPL.
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
17 struct dm_dev;
18 struct dm_target;
19 struct dm_table;
20 struct dm_report_zones_args;
21 struct mapped_device;
22 struct bio_vec;
23
24 /*
25  * Type of table, mapped_device's mempool and request_queue
26  */
27 enum 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 };
33
34 typedef enum { STATUSTYPE_INFO, STATUSTYPE_TABLE } status_type_t;
35
36 union map_info {
37         void *ptr;
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
57  * = 1: simple remap complete
58  * = 2: The target wants to push back the io
59  */
60 typedef int (*dm_map_fn) (struct dm_target *ti, struct bio *bio);
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);
65 typedef void (*dm_release_clone_request_fn) (struct request *clone,
66                                              union map_info *map_context);
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).
74  * 2   : The target wants to push back the io
75  */
76 typedef int (*dm_endio_fn) (struct dm_target *ti,
77                             struct bio *bio, blk_status_t *error);
78 typedef int (*dm_request_endio_fn) (struct dm_target *ti,
79                                     struct request *clone, blk_status_t error,
80                                     union map_info *map_context);
81
82 typedef void (*dm_presuspend_fn) (struct dm_target *ti);
83 typedef void (*dm_presuspend_undo_fn) (struct dm_target *ti);
84 typedef void (*dm_postsuspend_fn) (struct dm_target *ti);
85 typedef int (*dm_preresume_fn) (struct dm_target *ti);
86 typedef void (*dm_resume_fn) (struct dm_target *ti);
87
88 typedef void (*dm_status_fn) (struct dm_target *ti, status_type_t status_type,
89                               unsigned status_flags, char *result, unsigned maxlen);
90
91 typedef int (*dm_message_fn) (struct dm_target *ti, unsigned argc, char **argv,
92                               char *result, unsigned maxlen);
93
94 typedef int (*dm_prepare_ioctl_fn) (struct dm_target *ti, struct block_device **bdev);
95
96 #ifdef CONFIG_BLK_DEV_ZONED
97 typedef int (*dm_report_zones_fn) (struct dm_target *ti,
98                                    struct dm_report_zones_args *args,
99                                    unsigned int nr_zones);
100 #else
101 /*
102  * Define dm_report_zones_fn so that targets can assign to NULL if
103  * CONFIG_BLK_DEV_ZONED disabled. Otherwise each target needs to do
104  * awkward #ifdefs in their target_type, etc.
105  */
106 typedef int (*dm_report_zones_fn) (struct dm_target *dummy);
107 #endif
108
109 /*
110  * These iteration functions are typically used to check (and combine)
111  * properties of underlying devices.
112  * E.g. Does at least one underlying device support flush?
113  *      Does any underlying device not support WRITE_SAME?
114  *
115  * The callout function is called once for each contiguous section of
116  * an underlying device.  State can be maintained in *data.
117  * Return non-zero to stop iterating through any further devices.
118  */
119 typedef int (*iterate_devices_callout_fn) (struct dm_target *ti,
120                                            struct dm_dev *dev,
121                                            sector_t start, sector_t len,
122                                            void *data);
123
124 /*
125  * This function must iterate through each section of device used by the
126  * target until it encounters a non-zero return code, which it then returns.
127  * Returns zero if no callout returned non-zero.
128  */
129 typedef int (*dm_iterate_devices_fn) (struct dm_target *ti,
130                                       iterate_devices_callout_fn fn,
131                                       void *data);
132
133 typedef void (*dm_io_hints_fn) (struct dm_target *ti,
134                                 struct queue_limits *limits);
135
136 /*
137  * Returns:
138  *    0: The target can handle the next I/O immediately.
139  *    1: The target can't handle the next I/O immediately.
140  */
141 typedef int (*dm_busy_fn) (struct dm_target *ti);
142
143 /*
144  * Returns:
145  *  < 0 : error
146  * >= 0 : the number of bytes accessible at the address
147  */
148 typedef long (*dm_dax_direct_access_fn) (struct dm_target *ti, pgoff_t pgoff,
149                 long nr_pages, void **kaddr, pfn_t *pfn);
150 typedef size_t (*dm_dax_copy_iter_fn)(struct dm_target *ti, pgoff_t pgoff,
151                 void *addr, size_t bytes, struct iov_iter *i);
152 typedef int (*dm_dax_zero_page_range_fn)(struct dm_target *ti, pgoff_t pgoff,
153                 size_t nr_pages);
154 #define PAGE_SECTORS (PAGE_SIZE / 512)
155
156 void dm_error(const char *message);
157
158 struct dm_dev {
159         struct block_device *bdev;
160         struct dax_device *dax_dev;
161         fmode_t mode;
162         char name[16];
163 };
164
165 dev_t dm_get_dev_t(const char *path);
166
167 /*
168  * Constructors should call these functions to ensure destination devices
169  * are opened/closed correctly.
170  */
171 int dm_get_device(struct dm_target *ti, const char *path, fmode_t mode,
172                   struct dm_dev **result);
173 void dm_put_device(struct dm_target *ti, struct dm_dev *d);
174
175 /*
176  * Information about a target type
177  */
178
179 struct target_type {
180         uint64_t features;
181         const char *name;
182         struct module *module;
183         unsigned version[3];
184         dm_ctr_fn ctr;
185         dm_dtr_fn dtr;
186         dm_map_fn map;
187         dm_clone_and_map_request_fn clone_and_map_rq;
188         dm_release_clone_request_fn release_clone_rq;
189         dm_endio_fn end_io;
190         dm_request_endio_fn rq_end_io;
191         dm_presuspend_fn presuspend;
192         dm_presuspend_undo_fn presuspend_undo;
193         dm_postsuspend_fn postsuspend;
194         dm_preresume_fn preresume;
195         dm_resume_fn resume;
196         dm_status_fn status;
197         dm_message_fn message;
198         dm_prepare_ioctl_fn prepare_ioctl;
199         dm_report_zones_fn report_zones;
200         dm_busy_fn busy;
201         dm_iterate_devices_fn iterate_devices;
202         dm_io_hints_fn io_hints;
203         dm_dax_direct_access_fn direct_access;
204         dm_dax_copy_iter_fn dax_copy_from_iter;
205         dm_dax_copy_iter_fn dax_copy_to_iter;
206         dm_dax_zero_page_range_fn dax_zero_page_range;
207
208         /* For internal device-mapper use. */
209         struct list_head list;
210 };
211
212 /*
213  * Target features
214  */
215
216 /*
217  * Any table that contains an instance of this target must have only one.
218  */
219 #define DM_TARGET_SINGLETON             0x00000001
220 #define dm_target_needs_singleton(type) ((type)->features & DM_TARGET_SINGLETON)
221
222 /*
223  * Indicates that a target does not support read-only devices.
224  */
225 #define DM_TARGET_ALWAYS_WRITEABLE      0x00000002
226 #define dm_target_always_writeable(type) \
227                 ((type)->features & DM_TARGET_ALWAYS_WRITEABLE)
228
229 /*
230  * Any device that contains a table with an instance of this target may never
231  * have tables containing any different target type.
232  */
233 #define DM_TARGET_IMMUTABLE             0x00000004
234 #define dm_target_is_immutable(type)    ((type)->features & DM_TARGET_IMMUTABLE)
235
236 /*
237  * Indicates that a target may replace any target; even immutable targets.
238  * .map, .map_rq, .clone_and_map_rq and .release_clone_rq are all defined.
239  */
240 #define DM_TARGET_WILDCARD              0x00000008
241 #define dm_target_is_wildcard(type)     ((type)->features & DM_TARGET_WILDCARD)
242
243 /*
244  * A target implements own bio data integrity.
245  */
246 #define DM_TARGET_INTEGRITY             0x00000010
247 #define dm_target_has_integrity(type)   ((type)->features & DM_TARGET_INTEGRITY)
248
249 /*
250  * A target passes integrity data to the lower device.
251  */
252 #define DM_TARGET_PASSES_INTEGRITY      0x00000020
253 #define dm_target_passes_integrity(type) ((type)->features & DM_TARGET_PASSES_INTEGRITY)
254
255 /*
256  * Indicates support for zoned block devices:
257  * - DM_TARGET_ZONED_HM: the target also supports host-managed zoned
258  *   block devices but does not support combining different zoned models.
259  * - DM_TARGET_MIXED_ZONED_MODEL: the target supports combining multiple
260  *   devices with different zoned models.
261  */
262 #ifdef CONFIG_BLK_DEV_ZONED
263 #define DM_TARGET_ZONED_HM              0x00000040
264 #define dm_target_supports_zoned_hm(type) ((type)->features & DM_TARGET_ZONED_HM)
265 #else
266 #define DM_TARGET_ZONED_HM              0x00000000
267 #define dm_target_supports_zoned_hm(type) (false)
268 #endif
269
270 /*
271  * A target handles REQ_NOWAIT
272  */
273 #define DM_TARGET_NOWAIT                0x00000080
274 #define dm_target_supports_nowait(type) ((type)->features & DM_TARGET_NOWAIT)
275
276 /*
277  * A target supports passing through inline crypto support.
278  */
279 #define DM_TARGET_PASSES_CRYPTO         0x00000100
280 #define dm_target_passes_crypto(type) ((type)->features & DM_TARGET_PASSES_CRYPTO)
281
282 #ifdef CONFIG_BLK_DEV_ZONED
283 #define DM_TARGET_MIXED_ZONED_MODEL     0x00000200
284 #define dm_target_supports_mixed_zoned_model(type) \
285         ((type)->features & DM_TARGET_MIXED_ZONED_MODEL)
286 #else
287 #define DM_TARGET_MIXED_ZONED_MODEL     0x00000000
288 #define dm_target_supports_mixed_zoned_model(type) (false)
289 #endif
290
291 struct dm_target {
292         struct dm_table *table;
293         struct target_type *type;
294
295         /* target limits */
296         sector_t begin;
297         sector_t len;
298
299         /* If non-zero, maximum size of I/O submitted to a target. */
300         uint32_t max_io_len;
301
302         /*
303          * A number of zero-length barrier bios that will be submitted
304          * to the target for the purpose of flushing cache.
305          *
306          * The bio number can be accessed with dm_bio_get_target_bio_nr.
307          * It is a responsibility of the target driver to remap these bios
308          * to the real underlying devices.
309          */
310         unsigned num_flush_bios;
311
312         /*
313          * The number of discard bios that will be submitted to the target.
314          * The bio number can be accessed with dm_bio_get_target_bio_nr.
315          */
316         unsigned num_discard_bios;
317
318         /*
319          * The number of secure erase bios that will be submitted to the target.
320          * The bio number can be accessed with dm_bio_get_target_bio_nr.
321          */
322         unsigned num_secure_erase_bios;
323
324         /*
325          * The number of WRITE SAME bios that will be submitted to the target.
326          * The bio number can be accessed with dm_bio_get_target_bio_nr.
327          */
328         unsigned num_write_same_bios;
329
330         /*
331          * The number of WRITE ZEROES bios that will be submitted to the target.
332          * The bio number can be accessed with dm_bio_get_target_bio_nr.
333          */
334         unsigned num_write_zeroes_bios;
335
336         /*
337          * The minimum number of extra bytes allocated in each io for the
338          * target to use.
339          */
340         unsigned per_io_data_size;
341
342         /* target specific data */
343         void *private;
344
345         /* Used to provide an error string from the ctr */
346         char *error;
347
348         /*
349          * Set if this target needs to receive flushes regardless of
350          * whether or not its underlying devices have support.
351          */
352         bool flush_supported:1;
353
354         /*
355          * Set if this target needs to receive discards regardless of
356          * whether or not its underlying devices have support.
357          */
358         bool discards_supported:1;
359
360         /*
361          * Set if we need to limit the number of in-flight bios when swapping.
362          */
363         bool limit_swap_bios:1;
364
365         /*
366          * Set if this target implements a a zoned device and needs emulation of
367          * zone append operations using regular writes.
368          */
369         bool emulate_zone_append:1;
370 };
371
372 void *dm_per_bio_data(struct bio *bio, size_t data_size);
373 struct bio *dm_bio_from_per_bio_data(void *data, size_t data_size);
374 unsigned dm_bio_get_target_bio_nr(const struct bio *bio);
375
376 u64 dm_start_time_ns_from_clone(struct bio *bio);
377
378 int dm_register_target(struct target_type *t);
379 void dm_unregister_target(struct target_type *t);
380
381 /*
382  * Target argument parsing.
383  */
384 struct dm_arg_set {
385         unsigned argc;
386         char **argv;
387 };
388
389 /*
390  * The minimum and maximum value of a numeric argument, together with
391  * the error message to use if the number is found to be outside that range.
392  */
393 struct dm_arg {
394         unsigned min;
395         unsigned max;
396         char *error;
397 };
398
399 /*
400  * Validate the next argument, either returning it as *value or, if invalid,
401  * returning -EINVAL and setting *error.
402  */
403 int dm_read_arg(const struct dm_arg *arg, struct dm_arg_set *arg_set,
404                 unsigned *value, char **error);
405
406 /*
407  * Process the next argument as the start of a group containing between
408  * arg->min and arg->max further arguments. Either return the size as
409  * *num_args or, if invalid, return -EINVAL and set *error.
410  */
411 int dm_read_arg_group(const struct dm_arg *arg, struct dm_arg_set *arg_set,
412                       unsigned *num_args, char **error);
413
414 /*
415  * Return the current argument and shift to the next.
416  */
417 const char *dm_shift_arg(struct dm_arg_set *as);
418
419 /*
420  * Move through num_args arguments.
421  */
422 void dm_consume_args(struct dm_arg_set *as, unsigned num_args);
423
424 /*-----------------------------------------------------------------
425  * Functions for creating and manipulating mapped devices.
426  * Drop the reference with dm_put when you finish with the object.
427  *---------------------------------------------------------------*/
428
429 /*
430  * DM_ANY_MINOR chooses the next available minor number.
431  */
432 #define DM_ANY_MINOR (-1)
433 int dm_create(int minor, struct mapped_device **md);
434
435 /*
436  * Reference counting for md.
437  */
438 struct mapped_device *dm_get_md(dev_t dev);
439 void dm_get(struct mapped_device *md);
440 int dm_hold(struct mapped_device *md);
441 void dm_put(struct mapped_device *md);
442
443 /*
444  * An arbitrary pointer may be stored alongside a mapped device.
445  */
446 void dm_set_mdptr(struct mapped_device *md, void *ptr);
447 void *dm_get_mdptr(struct mapped_device *md);
448
449 /*
450  * A device can still be used while suspended, but I/O is deferred.
451  */
452 int dm_suspend(struct mapped_device *md, unsigned suspend_flags);
453 int dm_resume(struct mapped_device *md);
454
455 /*
456  * Event functions.
457  */
458 uint32_t dm_get_event_nr(struct mapped_device *md);
459 int dm_wait_event(struct mapped_device *md, int event_nr);
460 uint32_t dm_next_uevent_seq(struct mapped_device *md);
461 void dm_uevent_add(struct mapped_device *md, struct list_head *elist);
462
463 /*
464  * Info functions.
465  */
466 const char *dm_device_name(struct mapped_device *md);
467 int dm_copy_name_and_uuid(struct mapped_device *md, char *name, char *uuid);
468 struct gendisk *dm_disk(struct mapped_device *md);
469 int dm_suspended(struct dm_target *ti);
470 int dm_post_suspending(struct dm_target *ti);
471 int dm_noflush_suspending(struct dm_target *ti);
472 void dm_accept_partial_bio(struct bio *bio, unsigned n_sectors);
473 union map_info *dm_get_rq_mapinfo(struct request *rq);
474
475 #ifdef CONFIG_BLK_DEV_ZONED
476 struct dm_report_zones_args {
477         struct dm_target *tgt;
478         sector_t next_sector;
479
480         void *orig_data;
481         report_zones_cb orig_cb;
482         unsigned int zone_idx;
483
484         /* must be filled by ->report_zones before calling dm_report_zones_cb */
485         sector_t start;
486 };
487 int dm_report_zones(struct block_device *bdev, sector_t start, sector_t sector,
488                     struct dm_report_zones_args *args, unsigned int nr_zones);
489 #endif /* CONFIG_BLK_DEV_ZONED */
490
491 /*
492  * Device mapper functions to parse and create devices specified by the
493  * parameter "dm-mod.create="
494  */
495 int __init dm_early_create(struct dm_ioctl *dmi,
496                            struct dm_target_spec **spec_array,
497                            char **target_params_array);
498
499 struct queue_limits *dm_get_queue_limits(struct mapped_device *md);
500
501 /*
502  * Geometry functions.
503  */
504 int dm_get_geometry(struct mapped_device *md, struct hd_geometry *geo);
505 int dm_set_geometry(struct mapped_device *md, struct hd_geometry *geo);
506
507 /*-----------------------------------------------------------------
508  * Functions for manipulating device-mapper tables.
509  *---------------------------------------------------------------*/
510
511 /*
512  * First create an empty table.
513  */
514 int dm_table_create(struct dm_table **result, fmode_t mode,
515                     unsigned num_targets, struct mapped_device *md);
516
517 /*
518  * Then call this once for each target.
519  */
520 int dm_table_add_target(struct dm_table *t, const char *type,
521                         sector_t start, sector_t len, char *params);
522
523 /*
524  * Target can use this to set the table's type.
525  * Can only ever be called from a target's ctr.
526  * Useful for "hybrid" target (supports both bio-based
527  * and request-based).
528  */
529 void dm_table_set_type(struct dm_table *t, enum dm_queue_mode type);
530
531 /*
532  * Finally call this to make the table ready for use.
533  */
534 int dm_table_complete(struct dm_table *t);
535
536 /*
537  * Destroy the table when finished.
538  */
539 void dm_table_destroy(struct dm_table *t);
540
541 /*
542  * Target may require that it is never sent I/O larger than len.
543  */
544 int __must_check dm_set_target_max_io_len(struct dm_target *ti, sector_t len);
545
546 /*
547  * Table reference counting.
548  */
549 struct dm_table *dm_get_live_table(struct mapped_device *md, int *srcu_idx);
550 void dm_put_live_table(struct mapped_device *md, int srcu_idx);
551 void dm_sync_table(struct mapped_device *md);
552
553 /*
554  * Queries
555  */
556 sector_t dm_table_get_size(struct dm_table *t);
557 unsigned int dm_table_get_num_targets(struct dm_table *t);
558 fmode_t dm_table_get_mode(struct dm_table *t);
559 struct mapped_device *dm_table_get_md(struct dm_table *t);
560 const char *dm_table_device_name(struct dm_table *t);
561
562 /*
563  * Trigger an event.
564  */
565 void dm_table_event(struct dm_table *t);
566
567 /*
568  * Run the queue for request-based targets.
569  */
570 void dm_table_run_md_queue_async(struct dm_table *t);
571
572 /*
573  * The device must be suspended before calling this method.
574  * Returns the previous table, which the caller must destroy.
575  */
576 struct dm_table *dm_swap_table(struct mapped_device *md,
577                                struct dm_table *t);
578
579 /*
580  * Table keyslot manager functions
581  */
582 void dm_destroy_keyslot_manager(struct blk_keyslot_manager *ksm);
583
584 /*-----------------------------------------------------------------
585  * Macros.
586  *---------------------------------------------------------------*/
587 #define DM_NAME "device-mapper"
588
589 #define DM_FMT(fmt) DM_NAME ": " DM_MSG_PREFIX ": " fmt "\n"
590
591 #define DMCRIT(fmt, ...) pr_crit(DM_FMT(fmt), ##__VA_ARGS__)
592
593 #define DMERR(fmt, ...) pr_err(DM_FMT(fmt), ##__VA_ARGS__)
594 #define DMERR_LIMIT(fmt, ...) pr_err_ratelimited(DM_FMT(fmt), ##__VA_ARGS__)
595 #define DMWARN(fmt, ...) pr_warn(DM_FMT(fmt), ##__VA_ARGS__)
596 #define DMWARN_LIMIT(fmt, ...) pr_warn_ratelimited(DM_FMT(fmt), ##__VA_ARGS__)
597 #define DMINFO(fmt, ...) pr_info(DM_FMT(fmt), ##__VA_ARGS__)
598 #define DMINFO_LIMIT(fmt, ...) pr_info_ratelimited(DM_FMT(fmt), ##__VA_ARGS__)
599
600 #define DMDEBUG(fmt, ...) pr_debug(DM_FMT(fmt), ##__VA_ARGS__)
601 #define DMDEBUG_LIMIT(fmt, ...) pr_debug_ratelimited(DM_FMT(fmt), ##__VA_ARGS__)
602
603 #define DMEMIT(x...) sz += ((sz >= maxlen) ? \
604                           0 : scnprintf(result + sz, maxlen - sz, x))
605
606 /*
607  * Definitions of return values from target end_io function.
608  */
609 #define DM_ENDIO_DONE           0
610 #define DM_ENDIO_INCOMPLETE     1
611 #define DM_ENDIO_REQUEUE        2
612 #define DM_ENDIO_DELAY_REQUEUE  3
613
614 /*
615  * Definitions of return values from target map function.
616  */
617 #define DM_MAPIO_SUBMITTED      0
618 #define DM_MAPIO_REMAPPED       1
619 #define DM_MAPIO_REQUEUE        DM_ENDIO_REQUEUE
620 #define DM_MAPIO_DELAY_REQUEUE  DM_ENDIO_DELAY_REQUEUE
621 #define DM_MAPIO_KILL           4
622
623 #define dm_sector_div64(x, y)( \
624 { \
625         u64 _res; \
626         (x) = div64_u64_rem(x, y, &_res); \
627         _res; \
628 } \
629 )
630
631 /*
632  * Ceiling(n / sz)
633  */
634 #define dm_div_up(n, sz) (((n) + (sz) - 1) / (sz))
635
636 #define dm_sector_div_up(n, sz) ( \
637 { \
638         sector_t _r = ((n) + (sz) - 1); \
639         sector_div(_r, (sz)); \
640         _r; \
641 } \
642 )
643
644 /*
645  * ceiling(n / size) * size
646  */
647 #define dm_round_up(n, sz) (dm_div_up((n), (sz)) * (sz))
648
649 /*
650  * Sector offset taken relative to the start of the target instead of
651  * relative to the start of the device.
652  */
653 #define dm_target_offset(ti, sector) ((sector) - (ti)->begin)
654
655 static inline sector_t to_sector(unsigned long long n)
656 {
657         return (n >> SECTOR_SHIFT);
658 }
659
660 static inline unsigned long to_bytes(sector_t n)
661 {
662         return (n << SECTOR_SHIFT);
663 }
664
665 #endif  /* _LINUX_DEVICE_MAPPER_H */