dm.h 6.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217
  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 "dm-stats.h"
  21. /*
  22. * Suspend feature flags
  23. */
  24. #define DM_SUSPEND_LOCKFS_FLAG (1 << 0)
  25. #define DM_SUSPEND_NOFLUSH_FLAG (1 << 1)
  26. /*
  27. * Status feature flags
  28. */
  29. #define DM_STATUS_NOFLUSH_FLAG (1 << 0)
  30. /*
  31. * List of devices that a metadevice uses and should open/close.
  32. */
  33. struct dm_dev_internal {
  34. struct list_head list;
  35. atomic_t count;
  36. struct dm_dev *dm_dev;
  37. };
  38. struct dm_table;
  39. struct dm_md_mempools;
  40. /*-----------------------------------------------------------------
  41. * Internal table functions.
  42. *---------------------------------------------------------------*/
  43. void dm_table_destroy(struct dm_table *t);
  44. void dm_table_event_callback(struct dm_table *t,
  45. void (*fn)(void *), void *context);
  46. struct dm_target *dm_table_get_target(struct dm_table *t, unsigned int index);
  47. struct dm_target *dm_table_find_target(struct dm_table *t, sector_t sector);
  48. bool dm_table_has_no_data_devices(struct dm_table *table);
  49. int dm_calculate_queue_limits(struct dm_table *table,
  50. struct queue_limits *limits);
  51. void dm_table_set_restrictions(struct dm_table *t, struct request_queue *q,
  52. struct queue_limits *limits);
  53. struct list_head *dm_table_get_devices(struct dm_table *t);
  54. void dm_table_presuspend_targets(struct dm_table *t);
  55. void dm_table_presuspend_undo_targets(struct dm_table *t);
  56. void dm_table_postsuspend_targets(struct dm_table *t);
  57. int dm_table_resume_targets(struct dm_table *t);
  58. int dm_table_any_congested(struct dm_table *t, int bdi_bits);
  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. bool dm_table_all_blk_mq_devices(struct dm_table *t);
  66. void dm_table_free_md_mempools(struct dm_table *t);
  67. struct dm_md_mempools *dm_table_get_md_mempools(struct dm_table *t);
  68. void dm_lock_md_type(struct mapped_device *md);
  69. void dm_unlock_md_type(struct mapped_device *md);
  70. void dm_set_md_type(struct mapped_device *md, enum dm_queue_mode type);
  71. enum dm_queue_mode dm_get_md_type(struct mapped_device *md);
  72. struct target_type *dm_get_immutable_target_type(struct mapped_device *md);
  73. int dm_setup_md_queue(struct mapped_device *md, struct dm_table *t);
  74. /*
  75. * To check the return value from dm_table_find_target().
  76. */
  77. #define dm_target_is_valid(t) ((t)->table)
  78. /*
  79. * To check whether the target type is bio-based or not (request-based).
  80. */
  81. #define dm_target_bio_based(t) ((t)->type->map != NULL)
  82. /*
  83. * To check whether the target type is request-based or not (bio-based).
  84. */
  85. #define dm_target_request_based(t) ((t)->type->clone_and_map_rq != NULL)
  86. /*
  87. * To check whether the target type is a hybrid (capable of being
  88. * either request-based or bio-based).
  89. */
  90. #define dm_target_hybrid(t) (dm_target_bio_based(t) && dm_target_request_based(t))
  91. /*-----------------------------------------------------------------
  92. * A registry of target types.
  93. *---------------------------------------------------------------*/
  94. int dm_target_init(void);
  95. void dm_target_exit(void);
  96. struct target_type *dm_get_target_type(const char *name);
  97. void dm_put_target_type(struct target_type *tt);
  98. int dm_target_iterate(void (*iter_func)(struct target_type *tt,
  99. void *param), void *param);
  100. int dm_split_args(int *argc, char ***argvp, char *input);
  101. /*
  102. * Is this mapped_device being deleted?
  103. */
  104. int dm_deleting_md(struct mapped_device *md);
  105. /*
  106. * Is this mapped_device suspended?
  107. */
  108. int dm_suspended_md(struct mapped_device *md);
  109. /*
  110. * Internal suspend and resume methods.
  111. */
  112. int dm_suspended_internally_md(struct mapped_device *md);
  113. void dm_internal_suspend_fast(struct mapped_device *md);
  114. void dm_internal_resume_fast(struct mapped_device *md);
  115. void dm_internal_suspend_noflush(struct mapped_device *md);
  116. void dm_internal_resume(struct mapped_device *md);
  117. /*
  118. * Test if the device is scheduled for deferred remove.
  119. */
  120. int dm_test_deferred_remove_flag(struct mapped_device *md);
  121. /*
  122. * Try to remove devices marked for deferred removal.
  123. */
  124. void dm_deferred_remove(void);
  125. /*
  126. * The device-mapper can be driven through one of two interfaces;
  127. * ioctl or filesystem, depending which patch you have applied.
  128. */
  129. int dm_interface_init(void);
  130. void dm_interface_exit(void);
  131. /*
  132. * sysfs interface
  133. */
  134. int dm_sysfs_init(struct mapped_device *md);
  135. void dm_sysfs_exit(struct mapped_device *md);
  136. struct kobject *dm_kobject(struct mapped_device *md);
  137. struct mapped_device *dm_get_from_kobject(struct kobject *kobj);
  138. /*
  139. * The kobject helper
  140. */
  141. void dm_kobject_release(struct kobject *kobj);
  142. /*
  143. * Targets for linear and striped mappings
  144. */
  145. int dm_linear_init(void);
  146. void dm_linear_exit(void);
  147. int dm_stripe_init(void);
  148. void dm_stripe_exit(void);
  149. /*
  150. * mapped_device operations
  151. */
  152. void dm_destroy(struct mapped_device *md);
  153. void dm_destroy_immediate(struct mapped_device *md);
  154. int dm_open_count(struct mapped_device *md);
  155. int dm_lock_for_deletion(struct mapped_device *md, bool mark_deferred, bool only_deferred);
  156. int dm_cancel_deferred_remove(struct mapped_device *md);
  157. int dm_request_based(struct mapped_device *md);
  158. sector_t dm_get_size(struct mapped_device *md);
  159. struct request_queue *dm_get_md_queue(struct mapped_device *md);
  160. int dm_get_table_device(struct mapped_device *md, dev_t dev, fmode_t mode,
  161. struct dm_dev **result);
  162. void dm_put_table_device(struct mapped_device *md, struct dm_dev *d);
  163. struct dm_stats *dm_get_stats(struct mapped_device *md);
  164. int dm_kobject_uevent(struct mapped_device *md, enum kobject_action action,
  165. unsigned cookie);
  166. void dm_internal_suspend(struct mapped_device *md);
  167. void dm_internal_resume(struct mapped_device *md);
  168. int dm_io_init(void);
  169. void dm_io_exit(void);
  170. int dm_kcopyd_init(void);
  171. void dm_kcopyd_exit(void);
  172. /*
  173. * Mempool operations
  174. */
  175. struct dm_md_mempools *dm_alloc_md_mempools(struct mapped_device *md, enum dm_queue_mode type,
  176. unsigned integrity, unsigned per_bio_data_size);
  177. void dm_free_md_mempools(struct dm_md_mempools *pools);
  178. /*
  179. * Various helpers
  180. */
  181. unsigned dm_get_reserved_bio_based_ios(void);
  182. #endif