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