dm.h 6.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227
  1. /*
  2. * Internal header file for device mapper
  3. *
  4. * Copyright (C) 2001, 2002 Sistina Software
  5. * Copyright (C) 2004-2006 Red Hat, Inc. All rights reserved.
  6. *
  7. * This file is released under the LGPL.
  8. */
  9. #ifndef DM_INTERNAL_H
  10. #define DM_INTERNAL_H
  11. #include <linux/fs.h>
  12. #include <linux/device-mapper.h>
  13. #include <linux/list.h>
  14. #include <linux/moduleparam.h>
  15. #include <linux/blkdev.h>
  16. #include <linux/backing-dev.h>
  17. #include <linux/hdreg.h>
  18. #include <linux/completion.h>
  19. #include <linux/kobject.h>
  20. #include <linux/refcount.h>
  21. #include "dm-stats.h"
  22. /*
  23. * Suspend feature flags
  24. */
  25. #define DM_SUSPEND_LOCKFS_FLAG (1 << 0)
  26. #define DM_SUSPEND_NOFLUSH_FLAG (1 << 1)
  27. /*
  28. * Status feature flags
  29. */
  30. #define DM_STATUS_NOFLUSH_FLAG (1 << 0)
  31. /*
  32. * List of devices that a metadevice uses and should open/close.
  33. */
  34. struct dm_dev_internal {
  35. struct list_head list;
  36. refcount_t count;
  37. struct dm_dev *dm_dev;
  38. };
  39. struct dm_table;
  40. struct dm_md_mempools;
  41. struct dm_target_io;
  42. struct dm_io;
  43. /*-----------------------------------------------------------------
  44. * Internal table functions.
  45. *---------------------------------------------------------------*/
  46. void dm_table_event_callback(struct dm_table *t,
  47. void (*fn)(void *), void *context);
  48. struct dm_target *dm_table_find_target(struct dm_table *t, sector_t sector);
  49. bool dm_table_has_no_data_devices(struct dm_table *table);
  50. int dm_calculate_queue_limits(struct dm_table *table,
  51. struct queue_limits *limits);
  52. int dm_table_set_restrictions(struct dm_table *t, struct request_queue *q,
  53. struct queue_limits *limits);
  54. struct list_head *dm_table_get_devices(struct dm_table *t);
  55. void dm_table_presuspend_targets(struct dm_table *t);
  56. void dm_table_presuspend_undo_targets(struct dm_table *t);
  57. void dm_table_postsuspend_targets(struct dm_table *t);
  58. int dm_table_resume_targets(struct dm_table *t);
  59. enum dm_queue_mode dm_table_get_type(struct dm_table *t);
  60. struct target_type *dm_table_get_immutable_target_type(struct dm_table *t);
  61. struct dm_target *dm_table_get_immutable_target(struct dm_table *t);
  62. struct dm_target *dm_table_get_wildcard_target(struct dm_table *t);
  63. bool dm_table_bio_based(struct dm_table *t);
  64. bool dm_table_request_based(struct dm_table *t);
  65. void dm_lock_md_type(struct mapped_device *md);
  66. void dm_unlock_md_type(struct mapped_device *md);
  67. void dm_set_md_type(struct mapped_device *md, enum dm_queue_mode type);
  68. enum dm_queue_mode dm_get_md_type(struct mapped_device *md);
  69. struct target_type *dm_get_immutable_target_type(struct mapped_device *md);
  70. int dm_setup_md_queue(struct mapped_device *md, struct dm_table *t);
  71. /*
  72. * To check whether the target type is bio-based or not (request-based).
  73. */
  74. #define dm_target_bio_based(t) ((t)->type->map != NULL)
  75. /*
  76. * To check whether the target type is request-based or not (bio-based).
  77. */
  78. #define dm_target_request_based(t) ((t)->type->clone_and_map_rq != NULL)
  79. /*
  80. * To check whether the target type is a hybrid (capable of being
  81. * either request-based or bio-based).
  82. */
  83. #define dm_target_hybrid(t) (dm_target_bio_based(t) && dm_target_request_based(t))
  84. /*
  85. * Zoned targets related functions.
  86. */
  87. int dm_set_zones_restrictions(struct dm_table *t, struct request_queue *q);
  88. void dm_zone_endio(struct dm_io *io, struct bio *clone);
  89. #ifdef CONFIG_BLK_DEV_ZONED
  90. void dm_cleanup_zoned_dev(struct mapped_device *md);
  91. int dm_blk_report_zones(struct gendisk *disk, sector_t sector,
  92. unsigned int nr_zones, report_zones_cb cb, void *data);
  93. bool dm_is_zone_write(struct mapped_device *md, struct bio *bio);
  94. int dm_zone_map_bio(struct dm_target_io *io);
  95. #else
  96. static inline void dm_cleanup_zoned_dev(struct mapped_device *md) {}
  97. #define dm_blk_report_zones NULL
  98. static inline bool dm_is_zone_write(struct mapped_device *md, struct bio *bio)
  99. {
  100. return false;
  101. }
  102. static inline int dm_zone_map_bio(struct dm_target_io *tio)
  103. {
  104. return DM_MAPIO_KILL;
  105. }
  106. #endif
  107. /*-----------------------------------------------------------------
  108. * A registry of target types.
  109. *---------------------------------------------------------------*/
  110. int dm_target_init(void);
  111. void dm_target_exit(void);
  112. struct target_type *dm_get_target_type(const char *name);
  113. void dm_put_target_type(struct target_type *tt);
  114. int dm_target_iterate(void (*iter_func)(struct target_type *tt,
  115. void *param), void *param);
  116. int dm_split_args(int *argc, char ***argvp, char *input);
  117. /*
  118. * Is this mapped_device being deleted?
  119. */
  120. int dm_deleting_md(struct mapped_device *md);
  121. /*
  122. * Is this mapped_device suspended?
  123. */
  124. int dm_suspended_md(struct mapped_device *md);
  125. /*
  126. * Internal suspend and resume methods.
  127. */
  128. int dm_suspended_internally_md(struct mapped_device *md);
  129. void dm_internal_suspend_fast(struct mapped_device *md);
  130. void dm_internal_resume_fast(struct mapped_device *md);
  131. void dm_internal_suspend_noflush(struct mapped_device *md);
  132. void dm_internal_resume(struct mapped_device *md);
  133. /*
  134. * Test if the device is scheduled for deferred remove.
  135. */
  136. int dm_test_deferred_remove_flag(struct mapped_device *md);
  137. /*
  138. * Try to remove devices marked for deferred removal.
  139. */
  140. void dm_deferred_remove(void);
  141. /*
  142. * The device-mapper can be driven through one of two interfaces;
  143. * ioctl or filesystem, depending which patch you have applied.
  144. */
  145. int dm_interface_init(void);
  146. void dm_interface_exit(void);
  147. /*
  148. * sysfs interface
  149. */
  150. int dm_sysfs_init(struct mapped_device *md);
  151. void dm_sysfs_exit(struct mapped_device *md);
  152. struct kobject *dm_kobject(struct mapped_device *md);
  153. struct mapped_device *dm_get_from_kobject(struct kobject *kobj);
  154. /*
  155. * The kobject helper
  156. */
  157. void dm_kobject_release(struct kobject *kobj);
  158. /*
  159. * Targets for linear and striped mappings
  160. */
  161. int dm_linear_init(void);
  162. void dm_linear_exit(void);
  163. int dm_stripe_init(void);
  164. void dm_stripe_exit(void);
  165. /*
  166. * mapped_device operations
  167. */
  168. void dm_destroy(struct mapped_device *md);
  169. void dm_destroy_immediate(struct mapped_device *md);
  170. int dm_open_count(struct mapped_device *md);
  171. int dm_lock_for_deletion(struct mapped_device *md, bool mark_deferred, bool only_deferred);
  172. int dm_cancel_deferred_remove(struct mapped_device *md);
  173. int dm_request_based(struct mapped_device *md);
  174. int dm_get_table_device(struct mapped_device *md, dev_t dev, fmode_t mode,
  175. struct dm_dev **result);
  176. void dm_put_table_device(struct mapped_device *md, struct dm_dev *d);
  177. int dm_kobject_uevent(struct mapped_device *md, enum kobject_action action,
  178. unsigned int cookie, bool need_resize_uevent);
  179. void dm_internal_suspend(struct mapped_device *md);
  180. void dm_internal_resume(struct mapped_device *md);
  181. int dm_io_init(void);
  182. void dm_io_exit(void);
  183. int dm_kcopyd_init(void);
  184. void dm_kcopyd_exit(void);
  185. /*
  186. * Mempool operations
  187. */
  188. void dm_free_md_mempools(struct dm_md_mempools *pools);
  189. /*
  190. * Various helpers
  191. */
  192. unsigned int dm_get_reserved_bio_based_ios(void);
  193. #endif