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/math64.h>
  14 #include <linux/ratelimit.h>
  15
  16 struct dm_dev;
  17 struct dm_target;
  18 struct dm_table;
  19 struct mapped_device;
  20 struct bio_vec;
  21
  22 /*
  23  * Type of table, mapped_device's mempool and request_queue
  24  */
  25 enum dm_queue_mode {
  26         DM_TYPE_NONE             = 0,
  27         DM_TYPE_BIO_BASED        = 1,
  28         DM_TYPE_REQUEST_BASED    = 2,
  29         DM_TYPE_MQ_REQUEST_BASED = 3,
  30         DM_TYPE_DAX_BIO_BASED    = 4,
  31         DM_TYPE_NVME_BIO_BASED   = 5,
  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
  67 /*
  68  * Returns:
  69  * < 0 : error (currently ignored)
  70  * 0   : ended successfully
  71  * 1   : for some reason the io has still not completed (eg,
  72  *       multipath target might want to requeue a failed io).
  73  * 2   : The target wants to push back the io
  74  */
  75 typedef int (*dm_endio_fn) (struct dm_target *ti,
  76                             struct bio *bio, blk_status_t *error);
  77 typedef int (*dm_request_endio_fn) (struct dm_target *ti,
  78                                     struct request *clone, blk_status_t error,
  79                                     union map_info *map_context);
  80
  81 typedef void (*dm_presuspend_fn) (struct dm_target *ti);
  82 typedef void (*dm_presuspend_undo_fn) (struct dm_target *ti);
  83 typedef void (*dm_postsuspend_fn) (struct dm_target *ti);
  84 typedef int (*dm_preresume_fn) (struct dm_target *ti);
  85 typedef void (*dm_resume_fn) (struct dm_target *ti);
  86
  87 typedef void (*dm_status_fn) (struct dm_target *ti, status_type_t status_type,
  88                               unsigned status_flags, char *result, unsigned maxlen);
  89
  90 typedef int (*dm_message_fn) (struct dm_target *ti, unsigned argc, char **argv,
  91                               char *result, unsigned maxlen);
  92
  93 typedef int (*dm_prepare_ioctl_fn) (struct dm_target *ti, struct block_device **bdev);
  94
  95 /*
  96  * These iteration functions are typically used to check (and combine)
  97  * properties of underlying devices.
  98  * E.g. Does at least one underlying device support flush?
  99  *      Does any underlying device not support WRITE_SAME?
 100  *
 101  * The callout function is called once for each contiguous section of
 102  * an underlying device.  State can be maintained in *data.
 103  * Return non-zero to stop iterating through any further devices.
 104  */
 105 typedef int (*iterate_devices_callout_fn) (struct dm_target *ti,
 106                                            struct dm_dev *dev,
 107                                            sector_t start, sector_t len,
 108                                            void *data);
 109
 110 /*
 111  * This function must iterate through each section of device used by the
 112  * target until it encounters a non-zero return code, which it then returns.
 113  * Returns zero if no callout returned non-zero.
 114  */
 115 typedef int (*dm_iterate_devices_fn) (struct dm_target *ti,
 116                                       iterate_devices_callout_fn fn,
 117                                       void *data);
 118
 119 typedef void (*dm_io_hints_fn) (struct dm_target *ti,
 120                                 struct queue_limits *limits);
 121
 122 /*
 123  * Returns:
 124  *    0: The target can handle the next I/O immediately.
 125  *    1: The target can't handle the next I/O immediately.
 126  */
 127 typedef int (*dm_busy_fn) (struct dm_target *ti);
 128
 129 /*
 130  * Returns:
 131  *  < 0 : error
 132  * >= 0 : the number of bytes accessible at the address
 133  */
 134 typedef long (*dm_dax_direct_access_fn) (struct dm_target *ti, pgoff_t pgoff,
 135                 long nr_pages, void **kaddr, pfn_t *pfn);
 136 typedef size_t (*dm_dax_copy_from_iter_fn)(struct dm_target *ti, pgoff_t pgoff,
 137                 void *addr, size_t bytes, struct iov_iter *i);
 138 #define PAGE_SECTORS (PAGE_SIZE / 512)
 139
 140 void dm_error(const char *message);
 141
 142 struct dm_dev {
 143         struct block_device *bdev;
 144         struct dax_device *dax_dev;
 145         fmode_t mode;
 146         char name[16];
 147 };
 148
 149 dev_t dm_get_dev_t(const char *path);
 150
 151 /*
 152  * Constructors should call these functions to ensure destination devices
 153  * are opened/closed correctly.
 154  */
 155 int dm_get_device(struct dm_target *ti, const char *path, fmode_t mode,
 156                   struct dm_dev **result);
 157 void dm_put_device(struct dm_target *ti, struct dm_dev *d);
 158
 159 /*
 160  * Information about a target type
 161  */
 162
 163 struct target_type {
 164         uint64_t features;
 165         const char *name;
 166         struct module *module;
 167         unsigned version[3];
 168         dm_ctr_fn ctr;
 169         dm_dtr_fn dtr;
 170         dm_map_fn map;
 171         dm_clone_and_map_request_fn clone_and_map_rq;
 172         dm_release_clone_request_fn release_clone_rq;
 173         dm_endio_fn end_io;
 174         dm_request_endio_fn rq_end_io;
 175         dm_presuspend_fn presuspend;
 176         dm_presuspend_undo_fn presuspend_undo;
 177         dm_postsuspend_fn postsuspend;
 178         dm_preresume_fn preresume;
 179         dm_resume_fn resume;
 180         dm_status_fn status;
 181         dm_message_fn message;
 182         dm_prepare_ioctl_fn prepare_ioctl;
 183         dm_busy_fn busy;
 184         dm_iterate_devices_fn iterate_devices;
 185         dm_io_hints_fn io_hints;
 186         dm_dax_direct_access_fn direct_access;
 187         dm_dax_copy_from_iter_fn dax_copy_from_iter;
 188
 189         /* For internal device-mapper use. */
 190         struct list_head list;
 191 };
 192
 193 /*
 194  * Target features
 195  */
 196
 197 /*
 198  * Any table that contains an instance of this target must have only one.
 199  */
 200 #define DM_TARGET_SINGLETON             0x00000001
 201 #define dm_target_needs_singleton(type) ((type)->features & DM_TARGET_SINGLETON)
 202
 203 /*
 204  * Indicates that a target does not support read-only devices.
 205  */
 206 #define DM_TARGET_ALWAYS_WRITEABLE      0x00000002
 207 #define dm_target_always_writeable(type) \
 208                 ((type)->features & DM_TARGET_ALWAYS_WRITEABLE)
 209
 210 /*
 211  * Any device that contains a table with an instance of this target may never
 212  * have tables containing any different target type.
 213  */
 214 #define DM_TARGET_IMMUTABLE             0x00000004
 215 #define dm_target_is_immutable(type)    ((type)->features & DM_TARGET_IMMUTABLE)
 216
 217 /*
 218  * Indicates that a target may replace any target; even immutable targets.
 219  * .map, .map_rq, .clone_and_map_rq and .release_clone_rq are all defined.
 220  */
 221 #define DM_TARGET_WILDCARD              0x00000008
 222 #define dm_target_is_wildcard(type)     ((type)->features & DM_TARGET_WILDCARD)
 223
 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
 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
 236 /*
 237  * Indicates that a target supports host-managed zoned block devices.
 238  */
 239 #define DM_TARGET_ZONED_HM              0x00000040
 240 #define dm_target_supports_zoned_hm(type) ((type)->features & DM_TARGET_ZONED_HM)
 241
 242 struct dm_target {
 243         struct dm_table *table;
 244         struct target_type *type;
 245
 246         /* target limits */
 247         sector_t begin;
 248         sector_t len;
 249
 250         /* If non-zero, maximum size of I/O submitted to a target. */
 251         uint32_t max_io_len;
 252
 253         /*
 254          * A number of zero-length barrier bios that will be submitted
 255          * to the target for the purpose of flushing cache.
 256          *
 257          * The bio number can be accessed with dm_bio_get_target_bio_nr.
 258          * It is a responsibility of the target driver to remap these bios
 259          * to the real underlying devices.
 260          */
 261         unsigned num_flush_bios;
 262
 263         /*
 264          * The number of discard bios that will be submitted to the target.
 265          * The bio number can be accessed with dm_bio_get_target_bio_nr.
 266          */
 267         unsigned num_discard_bios;
 268
 269         /*
 270          * The number of secure erase bios that will be submitted to the target.
 271          * The bio number can be accessed with dm_bio_get_target_bio_nr.
 272          */
 273         unsigned num_secure_erase_bios;
 274
 275         /*
 276          * The number of WRITE SAME bios that will be submitted to the target.
 277          * The bio number can be accessed with dm_bio_get_target_bio_nr.
 278          */
 279         unsigned num_write_same_bios;
 280
 281         /*
 282          * The number of WRITE ZEROES bios that will be submitted to the target.
 283          * The bio number can be accessed with dm_bio_get_target_bio_nr.
 284          */
 285         unsigned num_write_zeroes_bios;
 286
 287         /*
 288          * The minimum number of extra bytes allocated in each io for the
 289          * target to use.
 290          */
 291         unsigned per_io_data_size;
 292
 293         /* target specific data */
 294         void *private;
 295
 296         /* Used to provide an error string from the ctr */
 297         char *error;
 298
 299         /*
 300          * Set if this target needs to receive flushes regardless of
 301          * whether or not its underlying devices have support.
 302          */
 303         bool flush_supported:1;
 304
 305         /*
 306          * Set if this target needs to receive discards regardless of
 307          * whether or not its underlying devices have support.
 308          */
 309         bool discards_supported:1;
 310
 311         /*
 312          * Set if the target required discard bios to be split
 313          * on max_io_len boundary.
 314          */
 315         bool split_discard_bios:1;
 316 };
 317
 318 /* Each target can link one of these into the table */
 319 struct dm_target_callbacks {
 320         struct list_head list;
 321         int (*congested_fn) (struct dm_target_callbacks *, int);
 322 };
 323
 324 void *dm_per_bio_data(struct bio *bio, size_t data_size);
 325 struct bio *dm_bio_from_per_bio_data(void *data, size_t data_size);
 326 unsigned dm_bio_get_target_bio_nr(const struct bio *bio);
 327
 328 int dm_register_target(struct target_type *t);
 329 void dm_unregister_target(struct target_type *t);
 330
 331 /*
 332  * Target argument parsing.
 333  */
 334 struct dm_arg_set {
 335         unsigned argc;
 336         char **argv;
 337 };
 338
 339 /*
 340  * The minimum and maximum value of a numeric argument, together with
 341  * the error message to use if the number is found to be outside that range.
 342  */
 343 struct dm_arg {
 344         unsigned min;
 345         unsigned max;
 346         char *error;
 347 };
 348
 349 /*
 350  * Validate the next argument, either returning it as *value or, if invalid,
 351  * returning -EINVAL and setting *error.
 352  */
 353 int dm_read_arg(const struct dm_arg *arg, struct dm_arg_set *arg_set,
 354                 unsigned *value, char **error);
 355
 356 /*
 357  * Process the next argument as the start of a group containing between
 358  * arg->min and arg->max further arguments. Either return the size as
 359  * *num_args or, if invalid, return -EINVAL and set *error.
 360  */
 361 int dm_read_arg_group(const struct dm_arg *arg, struct dm_arg_set *arg_set,
 362                       unsigned *num_args, char **error);
 363
 364 /*
 365  * Return the current argument and shift to the next.
 366  */
 367 const char *dm_shift_arg(struct dm_arg_set *as);
 368
 369 /*
 370  * Move through num_args arguments.
 371  */
 372 void dm_consume_args(struct dm_arg_set *as, unsigned num_args);
 373
 374 /*-----------------------------------------------------------------
 375  * Functions for creating and manipulating mapped devices.
 376  * Drop the reference with dm_put when you finish with the object.
 377  *---------------------------------------------------------------*/
 378
 379 /*
 380  * DM_ANY_MINOR chooses the next available minor number.
 381  */
 382 #define DM_ANY_MINOR (-1)
 383 int dm_create(int minor, struct mapped_device **md);
 384
 385 /*
 386  * Reference counting for md.
 387  */
 388 struct mapped_device *dm_get_md(dev_t dev);
 389 void dm_get(struct mapped_device *md);
 390 int dm_hold(struct mapped_device *md);
 391 void dm_put(struct mapped_device *md);
 392
 393 /*
 394  * An arbitrary pointer may be stored alongside a mapped device.
 395  */
 396 void dm_set_mdptr(struct mapped_device *md, void *ptr);
 397 void *dm_get_mdptr(struct mapped_device *md);
 398
 399 /*
 400  * A device can still be used while suspended, but I/O is deferred.
 401  */
 402 int dm_suspend(struct mapped_device *md, unsigned suspend_flags);
 403 int dm_resume(struct mapped_device *md);
 404
 405 /*
 406  * Event functions.
 407  */
 408 uint32_t dm_get_event_nr(struct mapped_device *md);
 409 int dm_wait_event(struct mapped_device *md, int event_nr);
 410 uint32_t dm_next_uevent_seq(struct mapped_device *md);
 411 void dm_uevent_add(struct mapped_device *md, struct list_head *elist);
 412
 413 /*
 414  * Info functions.
 415  */
 416 const char *dm_device_name(struct mapped_device *md);
 417 int dm_copy_name_and_uuid(struct mapped_device *md, char *name, char *uuid);
 418 struct gendisk *dm_disk(struct mapped_device *md);
 419 int dm_suspended(struct dm_target *ti);
 420 int dm_noflush_suspending(struct dm_target *ti);
 421 void dm_accept_partial_bio(struct bio *bio, unsigned n_sectors);
 422 void dm_remap_zone_report(struct dm_target *ti, struct bio *bio,
 423                           sector_t start);
 424 union map_info *dm_get_rq_mapinfo(struct request *rq);
 425
 426 struct queue_limits *dm_get_queue_limits(struct mapped_device *md);
 427
 428 /*
 429  * Geometry functions.
 430  */
 431 int dm_get_geometry(struct mapped_device *md, struct hd_geometry *geo);
 432 int dm_set_geometry(struct mapped_device *md, struct hd_geometry *geo);
 433
 434 /*-----------------------------------------------------------------
 435  * Functions for manipulating device-mapper tables.
 436  *---------------------------------------------------------------*/
 437
 438 /*
 439  * First create an empty table.
 440  */
 441 int dm_table_create(struct dm_table **result, fmode_t mode,
 442                     unsigned num_targets, struct mapped_device *md);
 443
 444 /*
 445  * Then call this once for each target.
 446  */
 447 int dm_table_add_target(struct dm_table *t, const char *type,
 448                         sector_t start, sector_t len, char *params);
 449
 450 /*
 451  * Target_ctr should call this if it needs to add any callbacks.
 452  */
 453 void dm_table_add_target_callbacks(struct dm_table *t, struct dm_target_callbacks *cb);
 454
 455 /*
 456  * Target can use this to set the table's type.
 457  * Can only ever be called from a target's ctr.
 458  * Useful for "hybrid" target (supports both bio-based
 459  * and request-based).
 460  */
 461 void dm_table_set_type(struct dm_table *t, enum dm_queue_mode type);
 462
 463 /*
 464  * Finally call this to make the table ready for use.
 465  */
 466 int dm_table_complete(struct dm_table *t);
 467
 468 /*
 469  * Destroy the table when finished.
 470  */
 471 void dm_table_destroy(struct dm_table *t);
 472
 473 /*
 474  * Target may require that it is never sent I/O larger than len.
 475  */
 476 int __must_check dm_set_target_max_io_len(struct dm_target *ti, sector_t len);
 477
 478 /*
 479  * Table reference counting.
 480  */
 481 struct dm_table *dm_get_live_table(struct mapped_device *md, int *srcu_idx);
 482 void dm_put_live_table(struct mapped_device *md, int srcu_idx);
 483 void dm_sync_table(struct mapped_device *md);
 484
 485 /*
 486  * Queries
 487  */
 488 sector_t dm_table_get_size(struct dm_table *t);
 489 unsigned int dm_table_get_num_targets(struct dm_table *t);
 490 fmode_t dm_table_get_mode(struct dm_table *t);
 491 struct mapped_device *dm_table_get_md(struct dm_table *t);
 492
 493 /*
 494  * Trigger an event.
 495  */
 496 void dm_table_event(struct dm_table *t);
 497
 498 /*
 499  * Run the queue for request-based targets.
 500  */
 501 void dm_table_run_md_queue_async(struct dm_table *t);
 502
 503 /*
 504  * The device must be suspended before calling this method.
 505  * Returns the previous table, which the caller must destroy.
 506  */
 507 struct dm_table *dm_swap_table(struct mapped_device *md,
 508                                struct dm_table *t);
 509
 510 /*
 511  * A wrapper around vmalloc.
 512  */
 513 void *dm_vcalloc(unsigned long nmemb, unsigned long elem_size);
 514
 515 /*-----------------------------------------------------------------
 516  * Macros.
 517  *---------------------------------------------------------------*/
 518 #define DM_NAME "device-mapper"
 519
 520 #define DM_RATELIMIT(pr_func, fmt, ...)                                 \
 521 do {                                                                    \
 522         static DEFINE_RATELIMIT_STATE(rs, DEFAULT_RATELIMIT_INTERVAL,   \
 523                                       DEFAULT_RATELIMIT_BURST);         \
 524                                                                         \
 525         if (__ratelimit(&rs))                                           \
 526                 pr_func(DM_FMT(fmt), ##__VA_ARGS__);                    \
 527 } while (0)
 528
 529 #define DM_FMT(fmt) DM_NAME ": " DM_MSG_PREFIX ": " fmt "\n"
 530
 531 #define DMCRIT(fmt, ...) pr_crit(DM_FMT(fmt), ##__VA_ARGS__)
 532
 533 #define DMERR(fmt, ...) pr_err(DM_FMT(fmt), ##__VA_ARGS__)
 534 #define DMERR_LIMIT(fmt, ...) DM_RATELIMIT(pr_err, fmt, ##__VA_ARGS__)
 535 #define DMWARN(fmt, ...) pr_warn(DM_FMT(fmt), ##__VA_ARGS__)
 536 #define DMWARN_LIMIT(fmt, ...) DM_RATELIMIT(pr_warn, fmt, ##__VA_ARGS__)
 537 #define DMINFO(fmt, ...) pr_info(DM_FMT(fmt), ##__VA_ARGS__)
 538 #define DMINFO_LIMIT(fmt, ...) DM_RATELIMIT(pr_info, fmt, ##__VA_ARGS__)
 539
 540 #ifdef CONFIG_DM_DEBUG
 541 #define DMDEBUG(fmt, ...) printk(KERN_DEBUG DM_FMT(fmt), ##__VA_ARGS__)
 542 #define DMDEBUG_LIMIT(fmt, ...) DM_RATELIMIT(pr_debug, fmt, ##__VA_ARGS__)
 543 #else
 544 #define DMDEBUG(fmt, ...) no_printk(fmt, ##__VA_ARGS__)
 545 #define DMDEBUG_LIMIT(fmt, ...) no_printk(fmt, ##__VA_ARGS__)
 546 #endif
 547
 548 #define DMEMIT(x...) sz += ((sz >= maxlen) ? \
 549                           0 : scnprintf(result + sz, maxlen - sz, x))
 550
 551 /*
 552  * Definitions of return values from target end_io function.
 553  */
 554 #define DM_ENDIO_DONE           0
 555 #define DM_ENDIO_INCOMPLETE     1
 556 #define DM_ENDIO_REQUEUE        2
 557 #define DM_ENDIO_DELAY_REQUEUE  3
 558
 559 /*
 560  * Definitions of return values from target map function.
 561  */
 562 #define DM_MAPIO_SUBMITTED      0
 563 #define DM_MAPIO_REMAPPED       1
 564 #define DM_MAPIO_REQUEUE        DM_ENDIO_REQUEUE
 565 #define DM_MAPIO_DELAY_REQUEUE  DM_ENDIO_DELAY_REQUEUE
 566 #define DM_MAPIO_KILL           4
 567
 568 #define dm_sector_div64(x, y)( \
 569 { \
 570         u64 _res; \
 571         (x) = div64_u64_rem(x, y, &_res); \
 572         _res; \
 573 } \
 574 )
 575
 576 /*
 577  * Ceiling(n / sz)
 578  */
 579 #define dm_div_up(n, sz) (((n) + (sz) - 1) / (sz))
 580
 581 #define dm_sector_div_up(n, sz) ( \
 582 { \
 583         sector_t _r = ((n) + (sz) - 1); \
 584         sector_div(_r, (sz)); \
 585         _r; \
 586 } \
 587 )
 588
 589 /*
 590  * ceiling(n / size) * size
 591  */
 592 #define dm_round_up(n, sz) (dm_div_up((n), (sz)) * (sz))
 593
 594 #define dm_array_too_big(fixed, obj, num) \
 595         ((num) > (UINT_MAX - (fixed)) / (obj))
 596
 597 /*
 598  * Sector offset taken relative to the start of the target instead of
 599  * relative to the start of the device.
 600  */
 601 #define dm_target_offset(ti, sector) ((sector) - (ti)->begin)
 602
 603 static inline sector_t to_sector(unsigned long n)
 604 {
 605         return (n >> SECTOR_SHIFT);
 606 }
 607
 608 static inline unsigned long to_bytes(sector_t n)
 609 {
 610         return (n << SECTOR_SHIFT);
 611 }
 612
 613 #endif  /* _LINUX_DEVICE_MAPPER_H */