1/*
2 * Internal header file for device mapper
3 *
4 * Copyright (C) 2001, 2002 Sistina Software
5 * Copyright (C) 2004-2006 Red Hat, Inc. All rights reserved.
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>
17#include <linux/hdreg.h>
18
19/*
20 * Suspend feature flags
21 */
22#define DM_SUSPEND_LOCKFS_FLAG		(1 << 0)
23#define DM_SUSPEND_NOFLUSH_FLAG		(1 << 1)
24
25/*
26 * 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/*
33 * List of devices that a metadevice uses and should open/close.
34 */
35struct dm_dev_internal {
36	struct list_head list;
37	atomic_t count;
38	struct dm_dev dm_dev;
39};
40
41struct dm_table;
42struct dm_md_mempools;
43
44/*-----------------------------------------------------------------
45 * Internal table functions.
46 *---------------------------------------------------------------*/
47void dm_table_destroy(struct dm_table *t);
48void dm_table_event_callback(struct dm_table *t,
49			     void (*fn)(void *), void *context);
50struct 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);
52int 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);
56struct list_head *dm_table_get_devices(struct dm_table *t);
57void dm_table_presuspend_targets(struct dm_table *t);
58void dm_table_postsuspend_targets(struct dm_table *t);
59int dm_table_resume_targets(struct dm_table *t);
60int dm_table_any_congested(struct dm_table *t, int bdi_bits);
61int dm_table_any_busy_target(struct dm_table *t);
62unsigned dm_table_get_type(struct dm_table *t);
63bool dm_table_request_based(struct dm_table *t);
64bool dm_table_supports_discards(struct dm_table *t);
65int 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);
68
69void 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
74int dm_setup_md_queue(struct mapped_device *md);
75
76/*
77 * To check the return value from dm_table_find_target().
78 */
79#define dm_target_is_valid(t) ((t)->table)
80
81/*
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
86/*-----------------------------------------------------------------
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);
92void dm_put_target_type(struct target_type *tt);
93int dm_target_iterate(void (*iter_func)(struct target_type *tt,
94					void *param), void *param);
95
96int dm_split_args(int *argc, char ***argvp, char *input);
97
98/*
99 * Is this mapped_device being deleted?
100 */
101int dm_deleting_md(struct mapped_device *md);
102
103/*
104 * Is this mapped_device suspended?
105 */
106int dm_suspended_md(struct mapped_device *md);
107
108/*
109 * 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/*
116 * 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/*
124 * 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
132/*
133 * mapped_device operations
134 */
135void dm_destroy(struct mapped_device *md);
136void dm_destroy_immediate(struct mapped_device *md);
137int dm_open_count(struct mapped_device *md);
138int dm_lock_for_deletion(struct mapped_device *md);
139
140int dm_kobject_uevent(struct mapped_device *md, enum kobject_action action,
141		      unsigned cookie);
142
143int dm_io_init(void);
144void dm_io_exit(void);
145
146int dm_kcopyd_init(void);
147void dm_kcopyd_exit(void);
148
149/*
150 * Mempool operations
151 */
152struct dm_md_mempools *dm_alloc_md_mempools(unsigned type);
153void dm_free_md_mempools(struct dm_md_mempools *pools);
154
155#endif
156