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/ratelimit.h>
  14
  15 struct dm_dev;
  16 struct dm_target;
  17 struct dm_table;
  18 struct mapped_device;
  19 struct bio_vec;
  20
  21 typedef enum { STATUSTYPE_INFO, STATUSTYPE_TABLE } status_type_t;
  22
  23 union map_info {
  24         void *ptr;
  25         unsigned long long ll;
  26 };
  27
  28 /*
  29  * In the constructor the target parameter will already have the
  30  * table, type, begin and len fields filled in.
  31  */
  32 typedef int (*dm_ctr_fn) (struct dm_target *target,
  33                           unsigned int argc, char **argv);
  34
  35 /*
  36  * The destructor doesn't need to free the dm_target, just
  37  * anything hidden ti->private.
  38  */
  39 typedef void (*dm_dtr_fn) (struct dm_target *ti);
  40
  41 /*
  42  * The map function must return:
  43  * < 0: error
  44  * = 0: The target will handle the io by resubmitting it later
  45  * = 1: simple remap complete
  46  * = 2: The target wants to push back the io
  47  */
  48 typedef int (*dm_map_fn) (struct dm_target *ti, struct bio *bio,
  49                           union map_info *map_context);
  50 typedef int (*dm_map_request_fn) (struct dm_target *ti, struct request *clone,
  51                                   union map_info *map_context);
  52
  53 /*
  54  * Returns:
  55  * < 0 : error (currently ignored)
  56  * 0   : ended successfully
  57  * 1   : for some reason the io has still not completed (eg,
  58  *       multipath target might want to requeue a failed io).
  59  * 2   : The target wants to push back the io
  60  */
  61 typedef int (*dm_endio_fn) (struct dm_target *ti,
  62                             struct bio *bio, int error,
  63                             union map_info *map_context);
  64 typedef int (*dm_request_endio_fn) (struct dm_target *ti,
  65                                     struct request *clone, int error,
  66                                     union map_info *map_context);
  67
  68 typedef void (*dm_presuspend_fn) (struct dm_target *ti);
  69 typedef void (*dm_postsuspend_fn) (struct dm_target *ti);
  70 typedef int (*dm_preresume_fn) (struct dm_target *ti);
  71 typedef void (*dm_resume_fn) (struct dm_target *ti);
  72
  73 typedef int (*dm_status_fn) (struct dm_target *ti, status_type_t status_type,
  74                              unsigned status_flags, char *result, unsigned maxlen);
  75
  76 typedef int (*dm_message_fn) (struct dm_target *ti, unsigned argc, char **argv);
  77
  78 typedef int (*dm_ioctl_fn) (struct dm_target *ti, unsigned int cmd,
  79                             unsigned long arg);
  80
  81 typedef int (*dm_merge_fn) (struct dm_target *ti, struct bvec_merge_data *bvm,
  82                             struct bio_vec *biovec, int max_size);
  83
  84 typedef int (*iterate_devices_callout_fn) (struct dm_target *ti,
  85                                            struct dm_dev *dev,
  86                                            sector_t start, sector_t len,
  87                                            void *data);
  88
  89 typedef int (*dm_iterate_devices_fn) (struct dm_target *ti,
  90                                       iterate_devices_callout_fn fn,
  91                                       void *data);
  92
  93 typedef void (*dm_io_hints_fn) (struct dm_target *ti,
  94                                 struct queue_limits *limits);
  95
  96 /*
  97  * Returns:
  98  *    0: The target can handle the next I/O immediately.
  99  *    1: The target can't handle the next I/O immediately.
 100  */
 101 typedef int (*dm_busy_fn) (struct dm_target *ti);
 102
 103 void dm_error(const char *message);
 104
 105 /*
 106  * Combine device limits.
 107  */
 108 int dm_set_device_limits(struct dm_target *ti, struct dm_dev *dev,
 109                          sector_t start, sector_t len, void *data);
 110
 111 struct dm_dev {
 112         struct block_device *bdev;
 113         fmode_t mode;
 114         char name[16];
 115 };
 116
 117 /*
 118  * Constructors should call these functions to ensure destination devices
 119  * are opened/closed correctly.
 120  */
 121 int dm_get_device(struct dm_target *ti, const char *path, fmode_t mode,
 122                                                  struct dm_dev **result);
 123 void dm_put_device(struct dm_target *ti, struct dm_dev *d);
 124
 125 /*
 126  * Information about a target type
 127  */
 128
 129 struct target_type {
 130         uint64_t features;
 131         const char *name;
 132         struct module *module;
 133         unsigned version[3];
 134         dm_ctr_fn ctr;
 135         dm_dtr_fn dtr;
 136         dm_map_fn map;
 137         dm_map_request_fn map_rq;
 138         dm_endio_fn end_io;
 139         dm_request_endio_fn rq_end_io;
 140         dm_presuspend_fn presuspend;
 141         dm_postsuspend_fn postsuspend;
 142         dm_preresume_fn preresume;
 143         dm_resume_fn resume;
 144         dm_status_fn status;
 145         dm_message_fn message;
 146         dm_ioctl_fn ioctl;
 147         dm_merge_fn merge;
 148         dm_busy_fn busy;
 149         dm_iterate_devices_fn iterate_devices;
 150         dm_io_hints_fn io_hints;
 151
 152         /* For internal device-mapper use. */
 153         struct list_head list;
 154 };
 155
 156 /*
 157  * Target features
 158  */
 159
 160 /*
 161  * Any table that contains an instance of this target must have only one.
 162  */
 163 #define DM_TARGET_SINGLETON             0x00000001
 164 #define dm_target_needs_singleton(type) ((type)->features & DM_TARGET_SINGLETON)
 165
 166 /*
 167  * Indicates that a target does not support read-only devices.
 168  */
 169 #define DM_TARGET_ALWAYS_WRITEABLE      0x00000002
 170 #define dm_target_always_writeable(type) \
 171                 ((type)->features & DM_TARGET_ALWAYS_WRITEABLE)
 172
 173 /*
 174  * Any device that contains a table with an instance of this target may never
 175  * have tables containing any different target type.
 176  */
 177 #define DM_TARGET_IMMUTABLE             0x00000004
 178 #define dm_target_is_immutable(type)    ((type)->features & DM_TARGET_IMMUTABLE)
 179
 180 struct dm_target {
 181         struct dm_table *table;
 182         struct target_type *type;
 183
 184         /* target limits */
 185         sector_t begin;
 186         sector_t len;
 187
 188         /* If non-zero, maximum size of I/O submitted to a target. */
 189         uint32_t max_io_len;
 190
 191         /*
 192          * A number of zero-length barrier requests that will be submitted
 193          * to the target for the purpose of flushing cache.
 194          *
 195          * The request number can be accessed with dm_bio_get_target_request_nr.
 196          * It is a responsibility of the target driver to remap these requests
 197          * to the real underlying devices.
 198          */
 199         unsigned num_flush_requests;
 200
 201         /*
 202          * The number of discard requests that will be submitted to the target.
 203          * The request number can be accessed with dm_bio_get_target_request_nr.
 204          */
 205         unsigned num_discard_requests;
 206
 207         /*
 208          * The number of WRITE SAME requests that will be submitted to the target.
 209          * The request number can be accessed with dm_bio_get_target_request_nr.
 210          */
 211         unsigned num_write_same_requests;
 212
 213         /*
 214          * The minimum number of extra bytes allocated in each bio for the
 215          * target to use.  dm_per_bio_data returns the data location.
 216          */
 217         unsigned per_bio_data_size;
 218
 219         /* target specific data */
 220         void *private;
 221
 222         /* Used to provide an error string from the ctr */
 223         char *error;
 224
 225         /*
 226          * Set if this target needs to receive flushes regardless of
 227          * whether or not its underlying devices have support.
 228          */
 229         bool flush_supported:1;
 230
 231         /*
 232          * Set if this target needs to receive discards regardless of
 233          * whether or not its underlying devices have support.
 234          */
 235         bool discards_supported:1;
 236
 237         /*
 238          * Set if the target required discard request to be split
 239          * on max_io_len boundary.
 240          */
 241         bool split_discard_requests:1;
 242
 243         /*
 244          * Set if this target does not return zeroes on discarded blocks.
 245          */
 246         bool discard_zeroes_data_unsupported:1;
 247 };
 248
 249 /* Each target can link one of these into the table */
 250 struct dm_target_callbacks {
 251         struct list_head list;
 252         int (*congested_fn) (struct dm_target_callbacks *, int);
 253 };
 254
 255 /*
 256  * For bio-based dm.
 257  * One of these is allocated for each bio.
 258  * This structure shouldn't be touched directly by target drivers.
 259  * It is here so that we can inline dm_per_bio_data and
 260  * dm_bio_from_per_bio_data
 261  */
 262 struct dm_target_io {
 263         struct dm_io *io;
 264         struct dm_target *ti;
 265         union map_info info;
 266         unsigned target_request_nr;
 267         struct bio clone;
 268 };
 269
 270 static inline void *dm_per_bio_data(struct bio *bio, size_t data_size)
 271 {
 272         return (char *)bio - offsetof(struct dm_target_io, clone) - data_size;
 273 }
 274
 275 static inline struct bio *dm_bio_from_per_bio_data(void *data, size_t data_size)
 276 {
 277         return (struct bio *)((char *)data + data_size + offsetof(struct dm_target_io, clone));
 278 }
 279
 280 static inline unsigned dm_bio_get_target_request_nr(const struct bio *bio)
 281 {
 282         return container_of(bio, struct dm_target_io, clone)->target_request_nr;
 283 }
 284
 285 int dm_register_target(struct target_type *t);
 286 void dm_unregister_target(struct target_type *t);
 287
 288 /*
 289  * Target argument parsing.
 290  */
 291 struct dm_arg_set {
 292         unsigned argc;
 293         char **argv;
 294 };
 295
 296 /*
 297  * The minimum and maximum value of a numeric argument, together with
 298  * the error message to use if the number is found to be outside that range.
 299  */
 300 struct dm_arg {
 301         unsigned min;
 302         unsigned max;
 303         char *error;
 304 };
 305
 306 /*
 307  * Validate the next argument, either returning it as *value or, if invalid,
 308  * returning -EINVAL and setting *error.
 309  */
 310 int dm_read_arg(struct dm_arg *arg, struct dm_arg_set *arg_set,
 311                 unsigned *value, char **error);
 312
 313 /*
 314  * Process the next argument as the start of a group containing between
 315  * arg->min and arg->max further arguments. Either return the size as
 316  * *num_args or, if invalid, return -EINVAL and set *error.
 317  */
 318 int dm_read_arg_group(struct dm_arg *arg, struct dm_arg_set *arg_set,
 319                       unsigned *num_args, char **error);
 320
 321 /*
 322  * Return the current argument and shift to the next.
 323  */
 324 const char *dm_shift_arg(struct dm_arg_set *as);
 325
 326 /*
 327  * Move through num_args arguments.
 328  */
 329 void dm_consume_args(struct dm_arg_set *as, unsigned num_args);
 330
 331 /*-----------------------------------------------------------------
 332  * Functions for creating and manipulating mapped devices.
 333  * Drop the reference with dm_put when you finish with the object.
 334  *---------------------------------------------------------------*/
 335
 336 /*
 337  * DM_ANY_MINOR chooses the next available minor number.
 338  */
 339 #define DM_ANY_MINOR (-1)
 340 int dm_create(int minor, struct mapped_device **md);
 341
 342 /*
 343  * Reference counting for md.
 344  */
 345 struct mapped_device *dm_get_md(dev_t dev);
 346 void dm_get(struct mapped_device *md);
 347 void dm_put(struct mapped_device *md);
 348
 349 /*
 350  * An arbitrary pointer may be stored alongside a mapped device.
 351  */
 352 void dm_set_mdptr(struct mapped_device *md, void *ptr);
 353 void *dm_get_mdptr(struct mapped_device *md);
 354
 355 /*
 356  * A device can still be used while suspended, but I/O is deferred.
 357  */
 358 int dm_suspend(struct mapped_device *md, unsigned suspend_flags);
 359 int dm_resume(struct mapped_device *md);
 360
 361 /*
 362  * Event functions.
 363  */
 364 uint32_t dm_get_event_nr(struct mapped_device *md);
 365 int dm_wait_event(struct mapped_device *md, int event_nr);
 366 uint32_t dm_next_uevent_seq(struct mapped_device *md);
 367 void dm_uevent_add(struct mapped_device *md, struct list_head *elist);
 368
 369 /*
 370  * Info functions.
 371  */
 372 const char *dm_device_name(struct mapped_device *md);
 373 int dm_copy_name_and_uuid(struct mapped_device *md, char *name, char *uuid);
 374 struct gendisk *dm_disk(struct mapped_device *md);
 375 int dm_suspended(struct dm_target *ti);
 376 int dm_noflush_suspending(struct dm_target *ti);
 377 union map_info *dm_get_mapinfo(struct bio *bio);
 378 union map_info *dm_get_rq_mapinfo(struct request *rq);
 379
 380 /*
 381  * Geometry functions.
 382  */
 383 int dm_get_geometry(struct mapped_device *md, struct hd_geometry *geo);
 384 int dm_set_geometry(struct mapped_device *md, struct hd_geometry *geo);
 385
 386
 387 /*-----------------------------------------------------------------
 388  * Functions for manipulating device-mapper tables.
 389  *---------------------------------------------------------------*/
 390
 391 /*
 392  * First create an empty table.
 393  */
 394 int dm_table_create(struct dm_table **result, fmode_t mode,
 395                     unsigned num_targets, struct mapped_device *md);
 396
 397 /*
 398  * Then call this once for each target.
 399  */
 400 int dm_table_add_target(struct dm_table *t, const char *type,
 401                         sector_t start, sector_t len, char *params);
 402
 403 /*
 404  * Target_ctr should call this if it needs to add any callbacks.
 405  */
 406 void dm_table_add_target_callbacks(struct dm_table *t, struct dm_target_callbacks *cb);
 407
 408 /*
 409  * Finally call this to make the table ready for use.
 410  */
 411 int dm_table_complete(struct dm_table *t);
 412
 413 /*
 414  * Target may require that it is never sent I/O larger than len.
 415  */
 416 int __must_check dm_set_target_max_io_len(struct dm_target *ti, sector_t len);
 417
 418 /*
 419  * Table reference counting.
 420  */
 421 struct dm_table *dm_get_live_table(struct mapped_device *md);
 422 void dm_table_get(struct dm_table *t);
 423 void dm_table_put(struct dm_table *t);
 424
 425 /*
 426  * Queries
 427  */
 428 sector_t dm_table_get_size(struct dm_table *t);
 429 unsigned int dm_table_get_num_targets(struct dm_table *t);
 430 fmode_t dm_table_get_mode(struct dm_table *t);
 431 struct mapped_device *dm_table_get_md(struct dm_table *t);
 432
 433 /*
 434  * Trigger an event.
 435  */
 436 void dm_table_event(struct dm_table *t);
 437
 438 /*
 439  * The device must be suspended before calling this method.
 440  * Returns the previous table, which the caller must destroy.
 441  */
 442 struct dm_table *dm_swap_table(struct mapped_device *md,
 443                                struct dm_table *t);
 444
 445 /*
 446  * A wrapper around vmalloc.
 447  */
 448 void *dm_vcalloc(unsigned long nmemb, unsigned long elem_size);
 449
 450 /*-----------------------------------------------------------------
 451  * Macros.
 452  *---------------------------------------------------------------*/
 453 #define DM_NAME "device-mapper"
 454
 455 #ifdef CONFIG_PRINTK
 456 extern struct ratelimit_state dm_ratelimit_state;
 457
 458 #define dm_ratelimit()  __ratelimit(&dm_ratelimit_state)
 459 #else
 460 #define dm_ratelimit()  0
 461 #endif
 462
 463 #define DMCRIT(f, arg...) \
 464         printk(KERN_CRIT DM_NAME ": " DM_MSG_PREFIX ": " f "\n", ## arg)
 465
 466 #define DMERR(f, arg...) \
 467         printk(KERN_ERR DM_NAME ": " DM_MSG_PREFIX ": " f "\n", ## arg)
 468 #define DMERR_LIMIT(f, arg...) \
 469         do { \
 470                 if (dm_ratelimit())     \
 471                         printk(KERN_ERR DM_NAME ": " DM_MSG_PREFIX ": " \
 472                                f "\n", ## arg); \
 473         } while (0)
 474
 475 #define DMWARN(f, arg...) \
 476         printk(KERN_WARNING DM_NAME ": " DM_MSG_PREFIX ": " f "\n", ## arg)
 477 #define DMWARN_LIMIT(f, arg...) \
 478         do { \
 479                 if (dm_ratelimit())     \
 480                         printk(KERN_WARNING DM_NAME ": " DM_MSG_PREFIX ": " \
 481                                f "\n", ## arg); \
 482         } while (0)
 483
 484 #define DMINFO(f, arg...) \
 485         printk(KERN_INFO DM_NAME ": " DM_MSG_PREFIX ": " f "\n", ## arg)
 486 #define DMINFO_LIMIT(f, arg...) \
 487         do { \
 488                 if (dm_ratelimit())     \
 489                         printk(KERN_INFO DM_NAME ": " DM_MSG_PREFIX ": " f \
 490                                "\n", ## arg); \
 491         } while (0)
 492
 493 #ifdef CONFIG_DM_DEBUG
 494 #  define DMDEBUG(f, arg...) \
 495         printk(KERN_DEBUG DM_NAME ": " DM_MSG_PREFIX " DEBUG: " f "\n", ## arg)
 496 #  define DMDEBUG_LIMIT(f, arg...) \
 497         do { \
 498                 if (dm_ratelimit())     \
 499                         printk(KERN_DEBUG DM_NAME ": " DM_MSG_PREFIX ": " f \
 500                                "\n", ## arg); \
 501         } while (0)
 502 #else
 503 #  define DMDEBUG(f, arg...) do {} while (0)
 504 #  define DMDEBUG_LIMIT(f, arg...) do {} while (0)
 505 #endif
 506
 507 #define DMEMIT(x...) sz += ((sz >= maxlen) ? \
 508                           0 : scnprintf(result + sz, maxlen - sz, x))
 509
 510 #define SECTOR_SHIFT 9
 511
 512 /*
 513  * Definitions of return values from target end_io function.
 514  */
 515 #define DM_ENDIO_INCOMPLETE     1
 516 #define DM_ENDIO_REQUEUE        2
 517
 518 /*
 519  * Definitions of return values from target map function.
 520  */
 521 #define DM_MAPIO_SUBMITTED      0
 522 #define DM_MAPIO_REMAPPED       1
 523 #define DM_MAPIO_REQUEUE        DM_ENDIO_REQUEUE
 524
 525 /*
 526  * Ceiling(n / sz)
 527  */
 528 #define dm_div_up(n, sz) (((n) + (sz) - 1) / (sz))
 529
 530 #define dm_sector_div_up(n, sz) ( \
 531 { \
 532         sector_t _r = ((n) + (sz) - 1); \
 533         sector_div(_r, (sz)); \
 534         _r; \
 535 } \
 536 )
 537
 538 /*
 539  * ceiling(n / size) * size
 540  */
 541 #define dm_round_up(n, sz) (dm_div_up((n), (sz)) * (sz))
 542
 543 #define dm_array_too_big(fixed, obj, num) \
 544         ((num) > (UINT_MAX - (fixed)) / (obj))
 545
 546 /*
 547  * Sector offset taken relative to the start of the target instead of
 548  * relative to the start of the device.
 549  */
 550 #define dm_target_offset(ti, sector) ((sector) - (ti)->begin)
 551
 552 static inline sector_t to_sector(unsigned long n)
 553 {
 554         return (n >> SECTOR_SHIFT);
 555 }
 556
 557 static inline unsigned long to_bytes(sector_t n)
 558 {
 559         return (n << SECTOR_SHIFT);
 560 }
 561
 562 /*-----------------------------------------------------------------
 563  * Helper for block layer and dm core operations
 564  *---------------------------------------------------------------*/
 565 void dm_dispatch_request(struct request *rq);
 566 void dm_requeue_unmapped_request(struct request *rq);
 567 void dm_kill_unmapped_request(struct request *rq, int error);
 568 int dm_underlying_device_busy(struct request_queue *q);
 569
 570 #endif  /* _LINUX_DEVICE_MAPPER_H */