blob: 7edcf97dfa5a66fc93b964c4f16671d72a17e5a8 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * Internal header file for device mapper
3 *
4 * Copyright (C) 2001, 2002 Sistina Software
Alasdair G Kergon2b06cff2006-06-26 00:27:32 -07005 * Copyright (C) 2004-2006 Red Hat, Inc. All rights reserved.
Linus Torvalds1da177e2005-04-16 15:20:36 -07006 *
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>
Tejun Heo66114ca2015-05-22 17:13:32 -040017#include <linux/backing-dev.h>
Darrick J. Wong3ac51e72006-03-27 01:17:54 -080018#include <linux/hdreg.h>
Mikulas Patockabe35f482014-01-06 23:01:22 -050019#include <linux/completion.h>
Mikulas Patocka2995fa72014-01-13 19:37:54 -050020#include <linux/kobject.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070021
Mikulas Patockafd2ed4d2013-08-16 10:54:23 -040022#include "dm-stats.h"
23
Kiyoshi Ueda45cbcd72006-12-08 02:41:05 -080024/*
Kiyoshi Uedaa3d77d32006-12-08 02:41:04 -080025 * Suspend feature flags
26 */
27#define DM_SUSPEND_LOCKFS_FLAG (1 << 0)
Kiyoshi Ueda81fdb092006-12-08 02:41:07 -080028#define DM_SUSPEND_NOFLUSH_FLAG (1 << 1)
Kiyoshi Uedaa3d77d32006-12-08 02:41:04 -080029
30/*
Alasdair G Kergon1f4e0ff2012-07-27 15:08:16 +010031 * Status feature flags
32 */
33#define DM_STATUS_NOFLUSH_FLAG (1 << 0)
34
35/*
Kiyoshi Uedae6ee8c02009-06-22 10:12:36 +010036 * Type of table and mapped_device's mempool
37 */
Mike Snitzere5863d92014-12-17 21:08:12 -050038#define DM_TYPE_NONE 0
39#define DM_TYPE_BIO_BASED 1
40#define DM_TYPE_REQUEST_BASED 2
41#define DM_TYPE_MQ_REQUEST_BASED 3
Kiyoshi Uedae6ee8c02009-06-22 10:12:36 +010042
43/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070044 * List of devices that a metadevice uses and should open/close.
45 */
Mikulas Patocka82b15192008-10-10 13:37:09 +010046struct dm_dev_internal {
Linus Torvalds1da177e2005-04-16 15:20:36 -070047 struct list_head list;
Linus Torvalds1da177e2005-04-16 15:20:36 -070048 atomic_t count;
Benjamin Marzinski86f11522014-08-13 13:53:43 -050049 struct dm_dev *dm_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -070050};
51
52struct dm_table;
Kiyoshi Uedae6ee8c02009-06-22 10:12:36 +010053struct dm_md_mempools;
Linus Torvalds1da177e2005-04-16 15:20:36 -070054
55/*-----------------------------------------------------------------
Alasdair G Kergon17b2f662006-06-26 00:27:33 -070056 * Internal table functions.
Linus Torvalds1da177e2005-04-16 15:20:36 -070057 *---------------------------------------------------------------*/
Mikulas Patockad5816872009-01-06 03:05:10 +000058void dm_table_destroy(struct dm_table *t);
Linus Torvalds1da177e2005-04-16 15:20:36 -070059void dm_table_event_callback(struct dm_table *t,
60 void (*fn)(void *), void *context);
Linus Torvalds1da177e2005-04-16 15:20:36 -070061struct dm_target *dm_table_get_target(struct dm_table *t, unsigned int index);
62struct dm_target *dm_table_find_target(struct dm_table *t, sector_t sector);
Mike Snitzer3ae70652012-09-26 23:45:45 +010063bool dm_table_has_no_data_devices(struct dm_table *table);
Mike Snitzer754c5fc2009-06-22 10:12:34 +010064int dm_calculate_queue_limits(struct dm_table *table,
65 struct queue_limits *limits);
66void dm_table_set_restrictions(struct dm_table *t, struct request_queue *q,
67 struct queue_limits *limits);
Linus Torvalds1da177e2005-04-16 15:20:36 -070068struct list_head *dm_table_get_devices(struct dm_table *t);
Linus Torvalds1da177e2005-04-16 15:20:36 -070069void dm_table_presuspend_targets(struct dm_table *t);
Mike Snitzerd67ee212014-10-28 20:13:31 -040070void dm_table_presuspend_undo_targets(struct dm_table *t);
Linus Torvalds1da177e2005-04-16 15:20:36 -070071void dm_table_postsuspend_targets(struct dm_table *t);
Milan Broz8757b772006-10-03 01:15:36 -070072int dm_table_resume_targets(struct dm_table *t);
Linus Torvalds1da177e2005-04-16 15:20:36 -070073int dm_table_any_congested(struct dm_table *t, int bdi_bits);
Kiyoshi Uedae6ee8c02009-06-22 10:12:36 +010074unsigned dm_table_get_type(struct dm_table *t);
Alasdair G Kergon36a04562011-10-31 20:19:04 +000075struct target_type *dm_table_get_immutable_target_type(struct dm_table *t);
Kiyoshi Uedae6ee8c02009-06-22 10:12:36 +010076bool dm_table_request_based(struct dm_table *t);
Mike Snitzere5863d92014-12-17 21:08:12 -050077bool dm_table_mq_request_based(struct dm_table *t);
Kiyoshi Uedae6ee8c02009-06-22 10:12:36 +010078void dm_table_free_md_mempools(struct dm_table *t);
79struct dm_md_mempools *dm_table_get_md_mempools(struct dm_table *t);
Linus Torvalds1da177e2005-04-16 15:20:36 -070080
Mike Snitzera5664da2010-08-12 04:14:01 +010081void dm_lock_md_type(struct mapped_device *md);
82void dm_unlock_md_type(struct mapped_device *md);
83void dm_set_md_type(struct mapped_device *md, unsigned type);
84unsigned dm_get_md_type(struct mapped_device *md);
Alasdair G Kergon36a04562011-10-31 20:19:04 +000085struct target_type *dm_get_immutable_target_type(struct mapped_device *md);
Mike Snitzera5664da2010-08-12 04:14:01 +010086
Mike Snitzer4a0b4dd2010-08-12 04:14:02 +010087int dm_setup_md_queue(struct mapped_device *md);
88
Jun'ichi Nomura512875b2007-12-13 14:15:25 +000089/*
90 * To check the return value from dm_table_find_target().
91 */
92#define dm_target_is_valid(t) ((t)->table)
93
Kiyoshi Uedae6ee8c02009-06-22 10:12:36 +010094/*
Mike Snitzer169e2cc2013-08-22 18:21:38 -040095 * To check whether the target type is bio-based or not (request-based).
96 */
97#define dm_target_bio_based(t) ((t)->type->map != NULL)
98
99/*
Kiyoshi Uedae6ee8c02009-06-22 10:12:36 +0100100 * To check whether the target type is request-based or not (bio-based).
101 */
Mike Snitzer65803c22014-12-18 16:26:47 -0500102#define dm_target_request_based(t) (((t)->type->map_rq != NULL) || \
103 ((t)->type->clone_and_map_rq != NULL))
Kiyoshi Uedae6ee8c02009-06-22 10:12:36 +0100104
Mike Snitzer169e2cc2013-08-22 18:21:38 -0400105/*
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 Torvalds1da177e2005-04-16 15:20:36 -0700111/*-----------------------------------------------------------------
112 * A registry of target types.
113 *---------------------------------------------------------------*/
114int dm_target_init(void);
115void dm_target_exit(void);
116struct target_type *dm_get_target_type(const char *name);
Cheng Renquan45194e42009-04-02 19:55:28 +0100117void dm_put_target_type(struct target_type *tt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118int dm_target_iterate(void (*iter_func)(struct target_type *tt,
119 void *param), void *param);
120
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121int dm_split_args(int *argc, char ***argvp, char *input);
122
123/*
Mike Anderson432a2122009-12-10 23:52:20 +0000124 * Is this mapped_device being deleted?
125 */
126int dm_deleting_md(struct mapped_device *md);
127
128/*
Kiyoshi Ueda4f186f82009-12-10 23:52:26 +0000129 * Is this mapped_device suspended?
130 */
131int dm_suspended_md(struct mapped_device *md);
132
133/*
Mike Snitzerffcc3932014-10-28 18:34:52 -0400134 * Internal suspend and resume methods.
135 */
136int dm_suspended_internally_md(struct mapped_device *md);
137void dm_internal_suspend_fast(struct mapped_device *md);
138void dm_internal_resume_fast(struct mapped_device *md);
139void dm_internal_suspend_noflush(struct mapped_device *md);
140void dm_internal_resume(struct mapped_device *md);
141
142/*
Mikulas Patocka2c140a22013-11-01 18:27:41 -0400143 * Test if the device is scheduled for deferred remove.
144 */
145int dm_test_deferred_remove_flag(struct mapped_device *md);
146
147/*
148 * Try to remove devices marked for deferred removal.
149 */
150void dm_deferred_remove(void);
151
152/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153 * The device-mapper can be driven through one of two interfaces;
154 * ioctl or filesystem, depending which patch you have applied.
155 */
156int dm_interface_init(void);
157void dm_interface_exit(void);
158
159/*
Milan Broz784aae72009-01-06 03:05:12 +0000160 * sysfs interface
161 */
Mikulas Patocka2995fa72014-01-13 19:37:54 -0500162struct dm_kobject_holder {
163 struct kobject kobj;
164 struct completion completion;
165};
166
167static inline struct completion *dm_get_completion_from_kobject(struct kobject *kobj)
168{
169 return &container_of(kobj, struct dm_kobject_holder, kobj)->completion;
170}
171
Milan Broz784aae72009-01-06 03:05:12 +0000172int dm_sysfs_init(struct mapped_device *md);
173void dm_sysfs_exit(struct mapped_device *md);
174struct kobject *dm_kobject(struct mapped_device *md);
175struct mapped_device *dm_get_from_kobject(struct kobject *kobj);
Mikulas Patocka2995fa72014-01-13 19:37:54 -0500176
177/*
178 * The kobject helper
179 */
180void dm_kobject_release(struct kobject *kobj);
Milan Broz784aae72009-01-06 03:05:12 +0000181
182/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183 * Targets for linear and striped mappings
184 */
185int dm_linear_init(void);
186void dm_linear_exit(void);
187
188int dm_stripe_init(void);
189void dm_stripe_exit(void);
190
Kiyoshi Ueda3f77316d2010-08-12 04:13:56 +0100191/*
192 * mapped_device operations
193 */
194void dm_destroy(struct mapped_device *md);
195void dm_destroy_immediate(struct mapped_device *md);
Alasdair G Kergon5c6bd752006-06-26 00:27:34 -0700196int dm_open_count(struct mapped_device *md);
Mikulas Patocka2c140a22013-11-01 18:27:41 -0400197int dm_lock_for_deletion(struct mapped_device *md, bool mark_deferred, bool only_deferred);
198int dm_cancel_deferred_remove(struct mapped_device *md);
Mikulas Patockafd2ed4d2013-08-16 10:54:23 -0400199int dm_request_based(struct mapped_device *md);
200sector_t dm_get_size(struct mapped_device *md);
Mike Snitzer9974fa22014-02-28 15:33:43 +0100201struct request_queue *dm_get_md_queue(struct mapped_device *md);
Benjamin Marzinski86f11522014-08-13 13:53:43 -0500202int dm_get_table_device(struct mapped_device *md, dev_t dev, fmode_t mode,
203 struct dm_dev **result);
204void dm_put_table_device(struct mapped_device *md, struct dm_dev *d);
Mikulas Patockafd2ed4d2013-08-16 10:54:23 -0400205struct dm_stats *dm_get_stats(struct mapped_device *md);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206
Peter Rajnoha3abf85b2010-03-06 02:32:31 +0000207int dm_kobject_uevent(struct mapped_device *md, enum kobject_action action,
208 unsigned cookie);
Alasdair G Kergon69267a32007-12-13 14:15:57 +0000209
Mikulas Patockafd2ed4d2013-08-16 10:54:23 -0400210void dm_internal_suspend(struct mapped_device *md);
211void dm_internal_resume(struct mapped_device *md);
212
Mike Snitzer17e149b2015-03-11 15:01:09 -0400213bool dm_use_blk_mq(struct mapped_device *md);
214
Mikulas Patocka952b3552009-12-10 23:51:57 +0000215int dm_io_init(void);
216void dm_io_exit(void);
217
Mikulas Patocka945fa4d2008-04-24 21:43:49 +0100218int dm_kcopyd_init(void);
219void dm_kcopyd_exit(void);
220
Kiyoshi Uedae6ee8c02009-06-22 10:12:36 +0100221/*
222 * Mempool operations
223 */
Mike Snitzer78d8e582015-06-26 10:01:13 -0400224struct dm_md_mempools *dm_alloc_md_mempools(struct mapped_device *md, unsigned type,
225 unsigned integrity, unsigned per_bio_data_size);
Kiyoshi Uedae6ee8c02009-06-22 10:12:36 +0100226void dm_free_md_mempools(struct dm_md_mempools *pools);
227
Mikulas Patockafd2ed4d2013-08-16 10:54:23 -0400228/*
229 * Helpers that are used by DM core
230 */
Mike Snitzere8603132013-09-12 18:06:12 -0400231unsigned dm_get_reserved_bio_based_ios(void);
Mike Snitzerf4790822013-09-12 18:06:12 -0400232unsigned dm_get_reserved_rq_based_ios(void);
233
Mikulas Patockafd2ed4d2013-08-16 10:54:23 -0400234static inline bool dm_message_test_buffer_overflow(char *result, unsigned maxlen)
235{
236 return !maxlen || strlen(result) + 1 >= maxlen;
237}
238
Mike Snitzer0ce65792015-02-26 00:50:28 -0500239ssize_t dm_attr_rq_based_seq_io_merge_deadline_show(struct mapped_device *md, char *buf);
240ssize_t dm_attr_rq_based_seq_io_merge_deadline_store(struct mapped_device *md,
241 const char *buf, size_t count);
242
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243#endif