Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Internal header file for device mapper |
| 3 | * |
| 4 | * Copyright (C) 2001, 2002 Sistina Software |
Alasdair G Kergon | 2b06cff | 2006-06-26 00:27:32 -0700 | [diff] [blame] | 5 | * Copyright (C) 2004-2006 Red Hat, Inc. All rights reserved. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 6 | * |
| 7 | * This file is released under the LGPL. |
| 8 | */ |
| 9 | |
| 10 | #ifndef DM_INTERNAL_H |
| 11 | #define DM_INTERNAL_H |
| 12 | |
| 13 | #include <linux/fs.h> |
| 14 | #include <linux/device-mapper.h> |
| 15 | #include <linux/list.h> |
| 16 | #include <linux/blkdev.h> |
Darrick J. Wong | 3ac51e7 | 2006-03-27 01:17:54 -0800 | [diff] [blame] | 17 | #include <linux/hdreg.h> |
Mikulas Patocka | be35f48 | 2014-01-06 23:01:22 -0500 | [diff] [blame] | 18 | #include <linux/completion.h> |
Mikulas Patocka | 2995fa7 | 2014-01-13 19:37:54 -0500 | [diff] [blame] | 19 | #include <linux/kobject.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 20 | |
Mikulas Patocka | fd2ed4d | 2013-08-16 10:54:23 -0400 | [diff] [blame] | 21 | #include "dm-stats.h" |
| 22 | |
Kiyoshi Ueda | 45cbcd7 | 2006-12-08 02:41:05 -0800 | [diff] [blame] | 23 | /* |
Kiyoshi Ueda | a3d77d3 | 2006-12-08 02:41:04 -0800 | [diff] [blame] | 24 | * Suspend feature flags |
| 25 | */ |
| 26 | #define DM_SUSPEND_LOCKFS_FLAG (1 << 0) |
Kiyoshi Ueda | 81fdb09 | 2006-12-08 02:41:07 -0800 | [diff] [blame] | 27 | #define DM_SUSPEND_NOFLUSH_FLAG (1 << 1) |
Kiyoshi Ueda | a3d77d3 | 2006-12-08 02:41:04 -0800 | [diff] [blame] | 28 | |
| 29 | /* |
Alasdair G Kergon | 1f4e0ff | 2012-07-27 15:08:16 +0100 | [diff] [blame] | 30 | * Status feature flags |
| 31 | */ |
| 32 | #define DM_STATUS_NOFLUSH_FLAG (1 << 0) |
| 33 | |
| 34 | /* |
Kiyoshi Ueda | e6ee8c0 | 2009-06-22 10:12:36 +0100 | [diff] [blame] | 35 | * Type of table and mapped_device's mempool |
| 36 | */ |
| 37 | #define DM_TYPE_NONE 0 |
| 38 | #define DM_TYPE_BIO_BASED 1 |
| 39 | #define DM_TYPE_REQUEST_BASED 2 |
| 40 | |
| 41 | /* |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 42 | * List of devices that a metadevice uses and should open/close. |
| 43 | */ |
Mikulas Patocka | 82b1519 | 2008-10-10 13:37:09 +0100 | [diff] [blame] | 44 | struct dm_dev_internal { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 45 | struct list_head list; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 46 | atomic_t count; |
Mikulas Patocka | 82b1519 | 2008-10-10 13:37:09 +0100 | [diff] [blame] | 47 | struct dm_dev dm_dev; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 48 | }; |
| 49 | |
| 50 | struct dm_table; |
Kiyoshi Ueda | e6ee8c0 | 2009-06-22 10:12:36 +0100 | [diff] [blame] | 51 | struct dm_md_mempools; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 52 | |
| 53 | /*----------------------------------------------------------------- |
Alasdair G Kergon | 17b2f66 | 2006-06-26 00:27:33 -0700 | [diff] [blame] | 54 | * Internal table functions. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 55 | *---------------------------------------------------------------*/ |
Mikulas Patocka | d581687 | 2009-01-06 03:05:10 +0000 | [diff] [blame] | 56 | void dm_table_destroy(struct dm_table *t); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 57 | void dm_table_event_callback(struct dm_table *t, |
| 58 | void (*fn)(void *), void *context); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 59 | struct dm_target *dm_table_get_target(struct dm_table *t, unsigned int index); |
| 60 | struct dm_target *dm_table_find_target(struct dm_table *t, sector_t sector); |
Mike Snitzer | 3ae7065 | 2012-09-26 23:45:45 +0100 | [diff] [blame] | 61 | bool dm_table_has_no_data_devices(struct dm_table *table); |
Mike Snitzer | 754c5fc | 2009-06-22 10:12:34 +0100 | [diff] [blame] | 62 | int dm_calculate_queue_limits(struct dm_table *table, |
| 63 | struct queue_limits *limits); |
| 64 | void dm_table_set_restrictions(struct dm_table *t, struct request_queue *q, |
| 65 | struct queue_limits *limits); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 66 | struct list_head *dm_table_get_devices(struct dm_table *t); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 67 | void dm_table_presuspend_targets(struct dm_table *t); |
| 68 | void dm_table_postsuspend_targets(struct dm_table *t); |
Milan Broz | 8757b77 | 2006-10-03 01:15:36 -0700 | [diff] [blame] | 69 | int dm_table_resume_targets(struct dm_table *t); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 70 | int dm_table_any_congested(struct dm_table *t, int bdi_bits); |
Kiyoshi Ueda | cec47e3 | 2009-06-22 10:12:35 +0100 | [diff] [blame] | 71 | int dm_table_any_busy_target(struct dm_table *t); |
Kiyoshi Ueda | e6ee8c0 | 2009-06-22 10:12:36 +0100 | [diff] [blame] | 72 | unsigned dm_table_get_type(struct dm_table *t); |
Alasdair G Kergon | 36a0456 | 2011-10-31 20:19:04 +0000 | [diff] [blame] | 73 | struct target_type *dm_table_get_immutable_target_type(struct dm_table *t); |
Kiyoshi Ueda | e6ee8c0 | 2009-06-22 10:12:36 +0100 | [diff] [blame] | 74 | bool dm_table_request_based(struct dm_table *t); |
Mike Snitzer | 5ae89a8 | 2010-08-12 04:14:08 +0100 | [diff] [blame] | 75 | bool dm_table_supports_discards(struct dm_table *t); |
Kiyoshi Ueda | e6ee8c0 | 2009-06-22 10:12:36 +0100 | [diff] [blame] | 76 | int dm_table_alloc_md_mempools(struct dm_table *t); |
| 77 | void dm_table_free_md_mempools(struct dm_table *t); |
| 78 | struct dm_md_mempools *dm_table_get_md_mempools(struct dm_table *t); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 79 | |
Mikulas Patocka | d5b9dd0 | 2011-08-02 12:32:04 +0100 | [diff] [blame] | 80 | int dm_queue_merge_is_compulsory(struct request_queue *q); |
| 81 | |
Mike Snitzer | a5664da | 2010-08-12 04:14:01 +0100 | [diff] [blame] | 82 | void dm_lock_md_type(struct mapped_device *md); |
| 83 | void dm_unlock_md_type(struct mapped_device *md); |
| 84 | void dm_set_md_type(struct mapped_device *md, unsigned type); |
| 85 | unsigned dm_get_md_type(struct mapped_device *md); |
Alasdair G Kergon | 36a0456 | 2011-10-31 20:19:04 +0000 | [diff] [blame] | 86 | struct target_type *dm_get_immutable_target_type(struct mapped_device *md); |
Mike Snitzer | a5664da | 2010-08-12 04:14:01 +0100 | [diff] [blame] | 87 | |
Mike Snitzer | 4a0b4dd | 2010-08-12 04:14:02 +0100 | [diff] [blame] | 88 | int dm_setup_md_queue(struct mapped_device *md); |
| 89 | |
Jun'ichi Nomura | 512875b | 2007-12-13 14:15:25 +0000 | [diff] [blame] | 90 | /* |
| 91 | * To check the return value from dm_table_find_target(). |
| 92 | */ |
| 93 | #define dm_target_is_valid(t) ((t)->table) |
| 94 | |
Kiyoshi Ueda | e6ee8c0 | 2009-06-22 10:12:36 +0100 | [diff] [blame] | 95 | /* |
Mike Snitzer | 169e2cc | 2013-08-22 18:21:38 -0400 | [diff] [blame] | 96 | * To check whether the target type is bio-based or not (request-based). |
| 97 | */ |
| 98 | #define dm_target_bio_based(t) ((t)->type->map != NULL) |
| 99 | |
| 100 | /* |
Kiyoshi Ueda | e6ee8c0 | 2009-06-22 10:12:36 +0100 | [diff] [blame] | 101 | * To check whether the target type is request-based or not (bio-based). |
| 102 | */ |
| 103 | #define dm_target_request_based(t) ((t)->type->map_rq != NULL) |
| 104 | |
Mike Snitzer | 169e2cc | 2013-08-22 18:21:38 -0400 | [diff] [blame] | 105 | /* |
| 106 | * To check whether the target type is a hybrid (capable of being |
| 107 | * either request-based or bio-based). |
| 108 | */ |
| 109 | #define dm_target_hybrid(t) (dm_target_bio_based(t) && dm_target_request_based(t)) |
| 110 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 111 | /*----------------------------------------------------------------- |
| 112 | * A registry of target types. |
| 113 | *---------------------------------------------------------------*/ |
| 114 | int dm_target_init(void); |
| 115 | void dm_target_exit(void); |
| 116 | struct target_type *dm_get_target_type(const char *name); |
Cheng Renquan | 45194e4 | 2009-04-02 19:55:28 +0100 | [diff] [blame] | 117 | void dm_put_target_type(struct target_type *tt); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 118 | int dm_target_iterate(void (*iter_func)(struct target_type *tt, |
| 119 | void *param), void *param); |
| 120 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 121 | int dm_split_args(int *argc, char ***argvp, char *input); |
| 122 | |
| 123 | /* |
Mike Anderson | 432a212 | 2009-12-10 23:52:20 +0000 | [diff] [blame] | 124 | * Is this mapped_device being deleted? |
| 125 | */ |
| 126 | int dm_deleting_md(struct mapped_device *md); |
| 127 | |
| 128 | /* |
Kiyoshi Ueda | 4f186f8 | 2009-12-10 23:52:26 +0000 | [diff] [blame] | 129 | * Is this mapped_device suspended? |
| 130 | */ |
| 131 | int dm_suspended_md(struct mapped_device *md); |
| 132 | |
| 133 | /* |
Mikulas Patocka | 2c140a2 | 2013-11-01 18:27:41 -0400 | [diff] [blame] | 134 | * Test if the device is scheduled for deferred remove. |
| 135 | */ |
| 136 | int dm_test_deferred_remove_flag(struct mapped_device *md); |
| 137 | |
| 138 | /* |
| 139 | * Try to remove devices marked for deferred removal. |
| 140 | */ |
| 141 | void dm_deferred_remove(void); |
| 142 | |
| 143 | /* |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 144 | * The device-mapper can be driven through one of two interfaces; |
| 145 | * ioctl or filesystem, depending which patch you have applied. |
| 146 | */ |
| 147 | int dm_interface_init(void); |
| 148 | void dm_interface_exit(void); |
| 149 | |
| 150 | /* |
Milan Broz | 784aae7 | 2009-01-06 03:05:12 +0000 | [diff] [blame] | 151 | * sysfs interface |
| 152 | */ |
Mikulas Patocka | 2995fa7 | 2014-01-13 19:37:54 -0500 | [diff] [blame] | 153 | struct dm_kobject_holder { |
| 154 | struct kobject kobj; |
| 155 | struct completion completion; |
| 156 | }; |
| 157 | |
| 158 | static inline struct completion *dm_get_completion_from_kobject(struct kobject *kobj) |
| 159 | { |
| 160 | return &container_of(kobj, struct dm_kobject_holder, kobj)->completion; |
| 161 | } |
| 162 | |
Milan Broz | 784aae7 | 2009-01-06 03:05:12 +0000 | [diff] [blame] | 163 | int dm_sysfs_init(struct mapped_device *md); |
| 164 | void dm_sysfs_exit(struct mapped_device *md); |
| 165 | struct kobject *dm_kobject(struct mapped_device *md); |
| 166 | struct mapped_device *dm_get_from_kobject(struct kobject *kobj); |
Mikulas Patocka | 2995fa7 | 2014-01-13 19:37:54 -0500 | [diff] [blame] | 167 | |
| 168 | /* |
| 169 | * The kobject helper |
| 170 | */ |
| 171 | void dm_kobject_release(struct kobject *kobj); |
Milan Broz | 784aae7 | 2009-01-06 03:05:12 +0000 | [diff] [blame] | 172 | |
| 173 | /* |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 174 | * Targets for linear and striped mappings |
| 175 | */ |
| 176 | int dm_linear_init(void); |
| 177 | void dm_linear_exit(void); |
| 178 | |
| 179 | int dm_stripe_init(void); |
| 180 | void dm_stripe_exit(void); |
| 181 | |
Kiyoshi Ueda | 3f77316d | 2010-08-12 04:13:56 +0100 | [diff] [blame] | 182 | /* |
| 183 | * mapped_device operations |
| 184 | */ |
| 185 | void dm_destroy(struct mapped_device *md); |
| 186 | void dm_destroy_immediate(struct mapped_device *md); |
Alasdair G Kergon | 5c6bd75 | 2006-06-26 00:27:34 -0700 | [diff] [blame] | 187 | int dm_open_count(struct mapped_device *md); |
Mikulas Patocka | 2c140a2 | 2013-11-01 18:27:41 -0400 | [diff] [blame] | 188 | int dm_lock_for_deletion(struct mapped_device *md, bool mark_deferred, bool only_deferred); |
| 189 | int dm_cancel_deferred_remove(struct mapped_device *md); |
Mikulas Patocka | fd2ed4d | 2013-08-16 10:54:23 -0400 | [diff] [blame] | 190 | int dm_request_based(struct mapped_device *md); |
| 191 | sector_t dm_get_size(struct mapped_device *md); |
| 192 | struct dm_stats *dm_get_stats(struct mapped_device *md); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 193 | |
Peter Rajnoha | 3abf85b | 2010-03-06 02:32:31 +0000 | [diff] [blame] | 194 | int dm_kobject_uevent(struct mapped_device *md, enum kobject_action action, |
| 195 | unsigned cookie); |
Alasdair G Kergon | 69267a3 | 2007-12-13 14:15:57 +0000 | [diff] [blame] | 196 | |
Mikulas Patocka | fd2ed4d | 2013-08-16 10:54:23 -0400 | [diff] [blame] | 197 | void dm_internal_suspend(struct mapped_device *md); |
| 198 | void dm_internal_resume(struct mapped_device *md); |
| 199 | |
Mikulas Patocka | 952b355 | 2009-12-10 23:51:57 +0000 | [diff] [blame] | 200 | int dm_io_init(void); |
| 201 | void dm_io_exit(void); |
| 202 | |
Mikulas Patocka | 945fa4d | 2008-04-24 21:43:49 +0100 | [diff] [blame] | 203 | int dm_kcopyd_init(void); |
| 204 | void dm_kcopyd_exit(void); |
| 205 | |
Kiyoshi Ueda | e6ee8c0 | 2009-06-22 10:12:36 +0100 | [diff] [blame] | 206 | /* |
| 207 | * Mempool operations |
| 208 | */ |
Mikulas Patocka | c0820cf | 2012-12-21 20:23:38 +0000 | [diff] [blame] | 209 | struct dm_md_mempools *dm_alloc_md_mempools(unsigned type, unsigned integrity, unsigned per_bio_data_size); |
Kiyoshi Ueda | e6ee8c0 | 2009-06-22 10:12:36 +0100 | [diff] [blame] | 210 | void dm_free_md_mempools(struct dm_md_mempools *pools); |
| 211 | |
Mikulas Patocka | fd2ed4d | 2013-08-16 10:54:23 -0400 | [diff] [blame] | 212 | /* |
| 213 | * Helpers that are used by DM core |
| 214 | */ |
Mike Snitzer | e860313 | 2013-09-12 18:06:12 -0400 | [diff] [blame] | 215 | unsigned dm_get_reserved_bio_based_ios(void); |
Mike Snitzer | f479082 | 2013-09-12 18:06:12 -0400 | [diff] [blame] | 216 | unsigned dm_get_reserved_rq_based_ios(void); |
| 217 | |
Mikulas Patocka | fd2ed4d | 2013-08-16 10:54:23 -0400 | [diff] [blame] | 218 | static inline bool dm_message_test_buffer_overflow(char *result, unsigned maxlen) |
| 219 | { |
| 220 | return !maxlen || strlen(result) + 1 >= maxlen; |
| 221 | } |
| 222 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 223 | #endif |