blob: ed76126aac542e57d092a1d50a00135d8119c2ec [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>
Darrick J. Wong3ac51e72006-03-27 01:17:54 -080017#include <linux/hdreg.h>
Mikulas Patockabe35f482014-01-06 23:01:22 -050018#include <linux/completion.h>
Mikulas Patocka2995fa72014-01-13 19:37:54 -050019#include <linux/kobject.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070020
Mikulas Patockafd2ed4d2013-08-16 10:54:23 -040021#include "dm-stats.h"
22
Kiyoshi Ueda45cbcd72006-12-08 02:41:05 -080023/*
Kiyoshi Uedaa3d77d32006-12-08 02:41:04 -080024 * Suspend feature flags
25 */
26#define DM_SUSPEND_LOCKFS_FLAG (1 << 0)
Kiyoshi Ueda81fdb092006-12-08 02:41:07 -080027#define DM_SUSPEND_NOFLUSH_FLAG (1 << 1)
Kiyoshi Uedaa3d77d32006-12-08 02:41:04 -080028
29/*
Alasdair G Kergon1f4e0ff2012-07-27 15:08:16 +010030 * Status feature flags
31 */
32#define DM_STATUS_NOFLUSH_FLAG (1 << 0)
33
34/*
Kiyoshi Uedae6ee8c02009-06-22 10:12:36 +010035 * 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 Torvalds1da177e2005-04-16 15:20:36 -070042 * List of devices that a metadevice uses and should open/close.
43 */
Mikulas Patocka82b15192008-10-10 13:37:09 +010044struct dm_dev_internal {
Linus Torvalds1da177e2005-04-16 15:20:36 -070045 struct list_head list;
Linus Torvalds1da177e2005-04-16 15:20:36 -070046 atomic_t count;
Mikulas Patocka82b15192008-10-10 13:37:09 +010047 struct dm_dev dm_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -070048};
49
50struct dm_table;
Kiyoshi Uedae6ee8c02009-06-22 10:12:36 +010051struct dm_md_mempools;
Linus Torvalds1da177e2005-04-16 15:20:36 -070052
53/*-----------------------------------------------------------------
Alasdair G Kergon17b2f662006-06-26 00:27:33 -070054 * Internal table functions.
Linus Torvalds1da177e2005-04-16 15:20:36 -070055 *---------------------------------------------------------------*/
Mikulas Patockad5816872009-01-06 03:05:10 +000056void dm_table_destroy(struct dm_table *t);
Linus Torvalds1da177e2005-04-16 15:20:36 -070057void dm_table_event_callback(struct dm_table *t,
58 void (*fn)(void *), void *context);
Linus Torvalds1da177e2005-04-16 15:20:36 -070059struct dm_target *dm_table_get_target(struct dm_table *t, unsigned int index);
60struct dm_target *dm_table_find_target(struct dm_table *t, sector_t sector);
Mike Snitzer3ae70652012-09-26 23:45:45 +010061bool dm_table_has_no_data_devices(struct dm_table *table);
Mike Snitzer754c5fc2009-06-22 10:12:34 +010062int dm_calculate_queue_limits(struct dm_table *table,
63 struct queue_limits *limits);
64void dm_table_set_restrictions(struct dm_table *t, struct request_queue *q,
65 struct queue_limits *limits);
Linus Torvalds1da177e2005-04-16 15:20:36 -070066struct list_head *dm_table_get_devices(struct dm_table *t);
Linus Torvalds1da177e2005-04-16 15:20:36 -070067void dm_table_presuspend_targets(struct dm_table *t);
68void dm_table_postsuspend_targets(struct dm_table *t);
Milan Broz8757b772006-10-03 01:15:36 -070069int dm_table_resume_targets(struct dm_table *t);
Linus Torvalds1da177e2005-04-16 15:20:36 -070070int dm_table_any_congested(struct dm_table *t, int bdi_bits);
Kiyoshi Uedacec47e32009-06-22 10:12:35 +010071int dm_table_any_busy_target(struct dm_table *t);
Kiyoshi Uedae6ee8c02009-06-22 10:12:36 +010072unsigned dm_table_get_type(struct dm_table *t);
Alasdair G Kergon36a04562011-10-31 20:19:04 +000073struct target_type *dm_table_get_immutable_target_type(struct dm_table *t);
Kiyoshi Uedae6ee8c02009-06-22 10:12:36 +010074bool dm_table_request_based(struct dm_table *t);
Mike Snitzer5ae89a82010-08-12 04:14:08 +010075bool dm_table_supports_discards(struct dm_table *t);
Kiyoshi Uedae6ee8c02009-06-22 10:12:36 +010076void dm_table_free_md_mempools(struct dm_table *t);
77struct dm_md_mempools *dm_table_get_md_mempools(struct dm_table *t);
Linus Torvalds1da177e2005-04-16 15:20:36 -070078
Mikulas Patockad5b9dd02011-08-02 12:32:04 +010079int dm_queue_merge_is_compulsory(struct request_queue *q);
80
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 */
102#define dm_target_request_based(t) ((t)->type->map_rq != NULL)
103
Mike Snitzer169e2cc2013-08-22 18:21:38 -0400104/*
105 * To check whether the target type is a hybrid (capable of being
106 * either request-based or bio-based).
107 */
108#define dm_target_hybrid(t) (dm_target_bio_based(t) && dm_target_request_based(t))
109
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110/*-----------------------------------------------------------------
111 * A registry of target types.
112 *---------------------------------------------------------------*/
113int dm_target_init(void);
114void dm_target_exit(void);
115struct target_type *dm_get_target_type(const char *name);
Cheng Renquan45194e42009-04-02 19:55:28 +0100116void dm_put_target_type(struct target_type *tt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117int dm_target_iterate(void (*iter_func)(struct target_type *tt,
118 void *param), void *param);
119
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120int dm_split_args(int *argc, char ***argvp, char *input);
121
122/*
Mike Anderson432a2122009-12-10 23:52:20 +0000123 * Is this mapped_device being deleted?
124 */
125int dm_deleting_md(struct mapped_device *md);
126
127/*
Kiyoshi Ueda4f186f82009-12-10 23:52:26 +0000128 * Is this mapped_device suspended?
129 */
130int dm_suspended_md(struct mapped_device *md);
131
132/*
Mikulas Patocka2c140a22013-11-01 18:27:41 -0400133 * Test if the device is scheduled for deferred remove.
134 */
135int dm_test_deferred_remove_flag(struct mapped_device *md);
136
137/*
138 * Try to remove devices marked for deferred removal.
139 */
140void dm_deferred_remove(void);
141
142/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143 * The device-mapper can be driven through one of two interfaces;
144 * ioctl or filesystem, depending which patch you have applied.
145 */
146int dm_interface_init(void);
147void dm_interface_exit(void);
148
149/*
Milan Broz784aae72009-01-06 03:05:12 +0000150 * sysfs interface
151 */
Mikulas Patocka2995fa72014-01-13 19:37:54 -0500152struct dm_kobject_holder {
153 struct kobject kobj;
154 struct completion completion;
155};
156
157static inline struct completion *dm_get_completion_from_kobject(struct kobject *kobj)
158{
159 return &container_of(kobj, struct dm_kobject_holder, kobj)->completion;
160}
161
Milan Broz784aae72009-01-06 03:05:12 +0000162int dm_sysfs_init(struct mapped_device *md);
163void dm_sysfs_exit(struct mapped_device *md);
164struct kobject *dm_kobject(struct mapped_device *md);
165struct mapped_device *dm_get_from_kobject(struct kobject *kobj);
Mikulas Patocka2995fa72014-01-13 19:37:54 -0500166
167/*
168 * The kobject helper
169 */
170void dm_kobject_release(struct kobject *kobj);
Milan Broz784aae72009-01-06 03:05:12 +0000171
172/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173 * Targets for linear and striped mappings
174 */
175int dm_linear_init(void);
176void dm_linear_exit(void);
177
178int dm_stripe_init(void);
179void dm_stripe_exit(void);
180
Kiyoshi Ueda3f77316d2010-08-12 04:13:56 +0100181/*
182 * mapped_device operations
183 */
184void dm_destroy(struct mapped_device *md);
185void dm_destroy_immediate(struct mapped_device *md);
Alasdair G Kergon5c6bd752006-06-26 00:27:34 -0700186int dm_open_count(struct mapped_device *md);
Mikulas Patocka2c140a22013-11-01 18:27:41 -0400187int dm_lock_for_deletion(struct mapped_device *md, bool mark_deferred, bool only_deferred);
188int dm_cancel_deferred_remove(struct mapped_device *md);
Mikulas Patockafd2ed4d2013-08-16 10:54:23 -0400189int dm_request_based(struct mapped_device *md);
190sector_t dm_get_size(struct mapped_device *md);
Mike Snitzer9974fa22014-02-28 15:33:43 +0100191struct request_queue *dm_get_md_queue(struct mapped_device *md);
Mikulas Patockafd2ed4d2013-08-16 10:54:23 -0400192struct dm_stats *dm_get_stats(struct mapped_device *md);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193
Peter Rajnoha3abf85b2010-03-06 02:32:31 +0000194int dm_kobject_uevent(struct mapped_device *md, enum kobject_action action,
195 unsigned cookie);
Alasdair G Kergon69267a32007-12-13 14:15:57 +0000196
Mikulas Patockafd2ed4d2013-08-16 10:54:23 -0400197void dm_internal_suspend(struct mapped_device *md);
198void dm_internal_resume(struct mapped_device *md);
199
Mikulas Patocka952b3552009-12-10 23:51:57 +0000200int dm_io_init(void);
201void dm_io_exit(void);
202
Mikulas Patocka945fa4d2008-04-24 21:43:49 +0100203int dm_kcopyd_init(void);
204void dm_kcopyd_exit(void);
205
Kiyoshi Uedae6ee8c02009-06-22 10:12:36 +0100206/*
207 * Mempool operations
208 */
Mikulas Patockac0820cf2012-12-21 20:23:38 +0000209struct dm_md_mempools *dm_alloc_md_mempools(unsigned type, unsigned integrity, unsigned per_bio_data_size);
Kiyoshi Uedae6ee8c02009-06-22 10:12:36 +0100210void dm_free_md_mempools(struct dm_md_mempools *pools);
211
Mikulas Patockafd2ed4d2013-08-16 10:54:23 -0400212/*
213 * Helpers that are used by DM core
214 */
Mike Snitzere8603132013-09-12 18:06:12 -0400215unsigned dm_get_reserved_bio_based_ios(void);
Mike Snitzerf4790822013-09-12 18:06:12 -0400216unsigned dm_get_reserved_rq_based_ios(void);
217
Mikulas Patockafd2ed4d2013-08-16 10:54:23 -0400218static inline bool dm_message_test_buffer_overflow(char *result, unsigned maxlen)
219{
220 return !maxlen || strlen(result) + 1 >= maxlen;
221}
222
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223#endif