blob: 6a99fefaa74306aa6e586c47c3eacf33706556b1 [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>
Linus Torvalds1da177e2005-04-16 15:20:36 -070018
Kiyoshi Ueda45cbcd72006-12-08 02:41:05 -080019/*
Kiyoshi Uedaa3d77d32006-12-08 02:41:04 -080020 * Suspend feature flags
21 */
22#define DM_SUSPEND_LOCKFS_FLAG (1 << 0)
Kiyoshi Ueda81fdb092006-12-08 02:41:07 -080023#define DM_SUSPEND_NOFLUSH_FLAG (1 << 1)
Kiyoshi Uedaa3d77d32006-12-08 02:41:04 -080024
25/*
Alasdair G Kergon1f4e0ff2012-07-27 15:08:16 +010026 * Status feature flags
27 */
28#define DM_STATUS_NOFLUSH_FLAG (1 << 0)
29
30/*
Kiyoshi Uedae6ee8c02009-06-22 10:12:36 +010031 * Type of table and mapped_device's mempool
32 */
33#define DM_TYPE_NONE 0
34#define DM_TYPE_BIO_BASED 1
35#define DM_TYPE_REQUEST_BASED 2
36
37/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070038 * List of devices that a metadevice uses and should open/close.
39 */
Mikulas Patocka82b15192008-10-10 13:37:09 +010040struct dm_dev_internal {
Linus Torvalds1da177e2005-04-16 15:20:36 -070041 struct list_head list;
Linus Torvalds1da177e2005-04-16 15:20:36 -070042 atomic_t count;
Mikulas Patocka82b15192008-10-10 13:37:09 +010043 struct dm_dev dm_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -070044};
45
46struct dm_table;
Kiyoshi Uedae6ee8c02009-06-22 10:12:36 +010047struct dm_md_mempools;
Linus Torvalds1da177e2005-04-16 15:20:36 -070048
49/*-----------------------------------------------------------------
Alasdair G Kergon17b2f662006-06-26 00:27:33 -070050 * Internal table functions.
Linus Torvalds1da177e2005-04-16 15:20:36 -070051 *---------------------------------------------------------------*/
Mikulas Patockad5816872009-01-06 03:05:10 +000052void dm_table_destroy(struct dm_table *t);
Linus Torvalds1da177e2005-04-16 15:20:36 -070053void dm_table_event_callback(struct dm_table *t,
54 void (*fn)(void *), void *context);
Linus Torvalds1da177e2005-04-16 15:20:36 -070055struct dm_target *dm_table_get_target(struct dm_table *t, unsigned int index);
56struct dm_target *dm_table_find_target(struct dm_table *t, sector_t sector);
Mike Snitzer3ae70652012-09-26 23:45:45 +010057bool dm_table_has_no_data_devices(struct dm_table *table);
Mike Snitzer754c5fc2009-06-22 10:12:34 +010058int dm_calculate_queue_limits(struct dm_table *table,
59 struct queue_limits *limits);
60void dm_table_set_restrictions(struct dm_table *t, struct request_queue *q,
61 struct queue_limits *limits);
Linus Torvalds1da177e2005-04-16 15:20:36 -070062struct list_head *dm_table_get_devices(struct dm_table *t);
Linus Torvalds1da177e2005-04-16 15:20:36 -070063void dm_table_presuspend_targets(struct dm_table *t);
64void dm_table_postsuspend_targets(struct dm_table *t);
Milan Broz8757b772006-10-03 01:15:36 -070065int dm_table_resume_targets(struct dm_table *t);
Linus Torvalds1da177e2005-04-16 15:20:36 -070066int dm_table_any_congested(struct dm_table *t, int bdi_bits);
Kiyoshi Uedacec47e32009-06-22 10:12:35 +010067int dm_table_any_busy_target(struct dm_table *t);
Kiyoshi Uedae6ee8c02009-06-22 10:12:36 +010068unsigned dm_table_get_type(struct dm_table *t);
Alasdair G Kergon36a04562011-10-31 20:19:04 +000069struct target_type *dm_table_get_immutable_target_type(struct dm_table *t);
Kiyoshi Uedae6ee8c02009-06-22 10:12:36 +010070bool dm_table_request_based(struct dm_table *t);
Mike Snitzer5ae89a82010-08-12 04:14:08 +010071bool dm_table_supports_discards(struct dm_table *t);
Kiyoshi Uedae6ee8c02009-06-22 10:12:36 +010072int dm_table_alloc_md_mempools(struct dm_table *t);
73void dm_table_free_md_mempools(struct dm_table *t);
74struct dm_md_mempools *dm_table_get_md_mempools(struct dm_table *t);
Linus Torvalds1da177e2005-04-16 15:20:36 -070075
Mikulas Patockad5b9dd02011-08-02 12:32:04 +010076int dm_queue_merge_is_compulsory(struct request_queue *q);
77
Mike Snitzera5664da2010-08-12 04:14:01 +010078void dm_lock_md_type(struct mapped_device *md);
79void dm_unlock_md_type(struct mapped_device *md);
80void dm_set_md_type(struct mapped_device *md, unsigned type);
81unsigned dm_get_md_type(struct mapped_device *md);
Alasdair G Kergon36a04562011-10-31 20:19:04 +000082struct target_type *dm_get_immutable_target_type(struct mapped_device *md);
Mike Snitzera5664da2010-08-12 04:14:01 +010083
Mike Snitzer4a0b4dd2010-08-12 04:14:02 +010084int dm_setup_md_queue(struct mapped_device *md);
85
Jun'ichi Nomura512875b2007-12-13 14:15:25 +000086/*
87 * To check the return value from dm_table_find_target().
88 */
89#define dm_target_is_valid(t) ((t)->table)
90
Kiyoshi Uedae6ee8c02009-06-22 10:12:36 +010091/*
92 * To check whether the target type is request-based or not (bio-based).
93 */
94#define dm_target_request_based(t) ((t)->type->map_rq != NULL)
95
Linus Torvalds1da177e2005-04-16 15:20:36 -070096/*-----------------------------------------------------------------
97 * A registry of target types.
98 *---------------------------------------------------------------*/
99int dm_target_init(void);
100void dm_target_exit(void);
101struct target_type *dm_get_target_type(const char *name);
Cheng Renquan45194e42009-04-02 19:55:28 +0100102void dm_put_target_type(struct target_type *tt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103int dm_target_iterate(void (*iter_func)(struct target_type *tt,
104 void *param), void *param);
105
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106int dm_split_args(int *argc, char ***argvp, char *input);
107
108/*
Mike Anderson432a2122009-12-10 23:52:20 +0000109 * Is this mapped_device being deleted?
110 */
111int dm_deleting_md(struct mapped_device *md);
112
113/*
Kiyoshi Ueda4f186f82009-12-10 23:52:26 +0000114 * Is this mapped_device suspended?
115 */
116int dm_suspended_md(struct mapped_device *md);
117
118/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119 * The device-mapper can be driven through one of two interfaces;
120 * ioctl or filesystem, depending which patch you have applied.
121 */
122int dm_interface_init(void);
123void dm_interface_exit(void);
124
125/*
Milan Broz784aae72009-01-06 03:05:12 +0000126 * sysfs interface
127 */
128int dm_sysfs_init(struct mapped_device *md);
129void dm_sysfs_exit(struct mapped_device *md);
130struct kobject *dm_kobject(struct mapped_device *md);
131struct mapped_device *dm_get_from_kobject(struct kobject *kobj);
132
133/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134 * Targets for linear and striped mappings
135 */
136int dm_linear_init(void);
137void dm_linear_exit(void);
138
139int dm_stripe_init(void);
140void dm_stripe_exit(void);
141
Kiyoshi Ueda3f77316d2010-08-12 04:13:56 +0100142/*
143 * mapped_device operations
144 */
145void dm_destroy(struct mapped_device *md);
146void dm_destroy_immediate(struct mapped_device *md);
Alasdair G Kergon5c6bd752006-06-26 00:27:34 -0700147int dm_open_count(struct mapped_device *md);
148int dm_lock_for_deletion(struct mapped_device *md);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149
Peter Rajnoha3abf85b2010-03-06 02:32:31 +0000150int dm_kobject_uevent(struct mapped_device *md, enum kobject_action action,
151 unsigned cookie);
Alasdair G Kergon69267a32007-12-13 14:15:57 +0000152
Mikulas Patocka952b3552009-12-10 23:51:57 +0000153int dm_io_init(void);
154void dm_io_exit(void);
155
Mikulas Patocka945fa4d2008-04-24 21:43:49 +0100156int dm_kcopyd_init(void);
157void dm_kcopyd_exit(void);
158
Kiyoshi Uedae6ee8c02009-06-22 10:12:36 +0100159/*
160 * Mempool operations
161 */
Martin K. Petersena91a2782011-03-17 11:11:05 +0100162struct dm_md_mempools *dm_alloc_md_mempools(unsigned type, unsigned integrity);
Kiyoshi Uedae6ee8c02009-06-22 10:12:36 +0100163void dm_free_md_mempools(struct dm_md_mempools *pools);
164
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165#endif