blob: 1aaf16746da86f6bfb9c9ffaab334841c044d92a [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/*
Kiyoshi Uedae6ee8c02009-06-22 10:12:36 +010026 * Type of table and mapped_device's mempool
27 */
28#define DM_TYPE_NONE 0
29#define DM_TYPE_BIO_BASED 1
30#define DM_TYPE_REQUEST_BASED 2
31
32/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070033 * List of devices that a metadevice uses and should open/close.
34 */
Mikulas Patocka82b15192008-10-10 13:37:09 +010035struct dm_dev_internal {
Linus Torvalds1da177e2005-04-16 15:20:36 -070036 struct list_head list;
Linus Torvalds1da177e2005-04-16 15:20:36 -070037 atomic_t count;
Mikulas Patocka82b15192008-10-10 13:37:09 +010038 struct dm_dev dm_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -070039};
40
41struct dm_table;
Kiyoshi Uedae6ee8c02009-06-22 10:12:36 +010042struct dm_md_mempools;
Linus Torvalds1da177e2005-04-16 15:20:36 -070043
44/*-----------------------------------------------------------------
Alasdair G Kergon17b2f662006-06-26 00:27:33 -070045 * Internal table functions.
Linus Torvalds1da177e2005-04-16 15:20:36 -070046 *---------------------------------------------------------------*/
Mikulas Patockad5816872009-01-06 03:05:10 +000047void dm_table_destroy(struct dm_table *t);
Linus Torvalds1da177e2005-04-16 15:20:36 -070048void dm_table_event_callback(struct dm_table *t,
49 void (*fn)(void *), void *context);
Linus Torvalds1da177e2005-04-16 15:20:36 -070050struct dm_target *dm_table_get_target(struct dm_table *t, unsigned int index);
51struct dm_target *dm_table_find_target(struct dm_table *t, sector_t sector);
Mike Snitzer754c5fc2009-06-22 10:12:34 +010052int dm_calculate_queue_limits(struct dm_table *table,
53 struct queue_limits *limits);
54void dm_table_set_restrictions(struct dm_table *t, struct request_queue *q,
55 struct queue_limits *limits);
Linus Torvalds1da177e2005-04-16 15:20:36 -070056struct list_head *dm_table_get_devices(struct dm_table *t);
Linus Torvalds1da177e2005-04-16 15:20:36 -070057void dm_table_presuspend_targets(struct dm_table *t);
58void dm_table_postsuspend_targets(struct dm_table *t);
Milan Broz8757b772006-10-03 01:15:36 -070059int dm_table_resume_targets(struct dm_table *t);
Linus Torvalds1da177e2005-04-16 15:20:36 -070060int dm_table_any_congested(struct dm_table *t, int bdi_bits);
Kiyoshi Uedacec47e32009-06-22 10:12:35 +010061int dm_table_any_busy_target(struct dm_table *t);
Kiyoshi Uedae6ee8c02009-06-22 10:12:36 +010062unsigned dm_table_get_type(struct dm_table *t);
63bool dm_table_request_based(struct dm_table *t);
Mike Snitzer5ae89a82010-08-12 04:14:08 +010064bool dm_table_supports_discards(struct dm_table *t);
Kiyoshi Uedae6ee8c02009-06-22 10:12:36 +010065int dm_table_alloc_md_mempools(struct dm_table *t);
66void dm_table_free_md_mempools(struct dm_table *t);
67struct dm_md_mempools *dm_table_get_md_mempools(struct dm_table *t);
Linus Torvalds1da177e2005-04-16 15:20:36 -070068
Mike Snitzera5664da2010-08-12 04:14:01 +010069void dm_lock_md_type(struct mapped_device *md);
70void dm_unlock_md_type(struct mapped_device *md);
71void dm_set_md_type(struct mapped_device *md, unsigned type);
72unsigned dm_get_md_type(struct mapped_device *md);
73
Mike Snitzer4a0b4dd2010-08-12 04:14:02 +010074int dm_setup_md_queue(struct mapped_device *md);
75
Jun'ichi Nomura512875b2007-12-13 14:15:25 +000076/*
77 * To check the return value from dm_table_find_target().
78 */
79#define dm_target_is_valid(t) ((t)->table)
80
Kiyoshi Uedae6ee8c02009-06-22 10:12:36 +010081/*
82 * To check whether the target type is request-based or not (bio-based).
83 */
84#define dm_target_request_based(t) ((t)->type->map_rq != NULL)
85
Linus Torvalds1da177e2005-04-16 15:20:36 -070086/*-----------------------------------------------------------------
87 * A registry of target types.
88 *---------------------------------------------------------------*/
89int dm_target_init(void);
90void dm_target_exit(void);
91struct target_type *dm_get_target_type(const char *name);
Cheng Renquan45194e42009-04-02 19:55:28 +010092void dm_put_target_type(struct target_type *tt);
Linus Torvalds1da177e2005-04-16 15:20:36 -070093int dm_target_iterate(void (*iter_func)(struct target_type *tt,
94 void *param), void *param);
95
Linus Torvalds1da177e2005-04-16 15:20:36 -070096int dm_split_args(int *argc, char ***argvp, char *input);
97
98/*
Mike Anderson432a2122009-12-10 23:52:20 +000099 * Is this mapped_device being deleted?
100 */
101int dm_deleting_md(struct mapped_device *md);
102
103/*
Kiyoshi Ueda4f186f82009-12-10 23:52:26 +0000104 * Is this mapped_device suspended?
105 */
106int dm_suspended_md(struct mapped_device *md);
107
108/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109 * The device-mapper can be driven through one of two interfaces;
110 * ioctl or filesystem, depending which patch you have applied.
111 */
112int dm_interface_init(void);
113void dm_interface_exit(void);
114
115/*
Milan Broz784aae72009-01-06 03:05:12 +0000116 * sysfs interface
117 */
118int dm_sysfs_init(struct mapped_device *md);
119void dm_sysfs_exit(struct mapped_device *md);
120struct kobject *dm_kobject(struct mapped_device *md);
121struct mapped_device *dm_get_from_kobject(struct kobject *kobj);
122
123/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124 * Targets for linear and striped mappings
125 */
126int dm_linear_init(void);
127void dm_linear_exit(void);
128
129int dm_stripe_init(void);
130void dm_stripe_exit(void);
131
Kiyoshi Ueda3f77316d2010-08-12 04:13:56 +0100132/*
133 * mapped_device operations
134 */
135void dm_destroy(struct mapped_device *md);
136void dm_destroy_immediate(struct mapped_device *md);
Alasdair G Kergon5c6bd752006-06-26 00:27:34 -0700137int dm_open_count(struct mapped_device *md);
138int dm_lock_for_deletion(struct mapped_device *md);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139
Peter Rajnoha3abf85b2010-03-06 02:32:31 +0000140int dm_kobject_uevent(struct mapped_device *md, enum kobject_action action,
141 unsigned cookie);
Alasdair G Kergon69267a32007-12-13 14:15:57 +0000142
Mikulas Patocka952b3552009-12-10 23:51:57 +0000143int dm_io_init(void);
144void dm_io_exit(void);
145
Mikulas Patocka945fa4d2008-04-24 21:43:49 +0100146int dm_kcopyd_init(void);
147void dm_kcopyd_exit(void);
148
Kiyoshi Uedae6ee8c02009-06-22 10:12:36 +0100149/*
150 * Mempool operations
151 */
Martin K. Petersena91a2782011-03-17 11:11:05 +0100152struct dm_md_mempools *dm_alloc_md_mempools(unsigned type, unsigned integrity);
Kiyoshi Uedae6ee8c02009-06-22 10:12:36 +0100153void dm_free_md_mempools(struct dm_md_mempools *pools);
154
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155#endif