blob: fd90bc8f9e451e42ba986bd364cae771e5539c2e [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
5 * Copyright (C) 2004 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>
Darrick J. Wong3ac51e72006-03-27 01:17:54 -080017#include <linux/hdreg.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070018
19#define DM_NAME "device-mapper"
20#define DMWARN(f, x...) printk(KERN_WARNING DM_NAME ": " f "\n" , ## x)
21#define DMERR(f, x...) printk(KERN_ERR DM_NAME ": " f "\n" , ## x)
22#define DMINFO(f, x...) printk(KERN_INFO DM_NAME ": " f "\n" , ## x)
23
24#define DMEMIT(x...) sz += ((sz >= maxlen) ? \
25 0 : scnprintf(result + sz, maxlen - sz, x))
26
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#define SECTOR_SHIFT 9
28
29/*
30 * List of devices that a metadevice uses and should open/close.
31 */
32struct dm_dev {
33 struct list_head list;
34
35 atomic_t count;
36 int mode;
37 struct block_device *bdev;
38 char name[16];
39};
40
41struct dm_table;
42struct mapped_device;
43
44/*-----------------------------------------------------------------
45 * Functions for manipulating a struct mapped_device.
46 * Drop the reference with dm_put when you finish with the object.
47 *---------------------------------------------------------------*/
48int dm_create(struct mapped_device **md);
49int dm_create_with_minor(unsigned int minor, struct mapped_device **md);
50void dm_set_mdptr(struct mapped_device *md, void *ptr);
Alasdair G Kergon9ade92a2006-03-27 01:17:53 -080051void *dm_get_mdptr(struct mapped_device *md);
David Teiglandd229a952006-01-06 00:20:01 -080052struct mapped_device *dm_get_md(dev_t dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -070053
54/*
55 * Reference counting for md.
56 */
57void dm_get(struct mapped_device *md);
58void dm_put(struct mapped_device *md);
59
60/*
61 * A device can still be used while suspended, but I/O is deferred.
62 */
Alasdair G Kergonaa8d7c22006-01-06 00:20:06 -080063int dm_suspend(struct mapped_device *md, int with_lockfs);
Linus Torvalds1da177e2005-04-16 15:20:36 -070064int dm_resume(struct mapped_device *md);
65
66/*
67 * The device must be suspended before calling this method.
68 */
69int dm_swap_table(struct mapped_device *md, struct dm_table *t);
70
71/*
72 * Drop a reference on the table when you've finished with the
73 * result.
74 */
75struct dm_table *dm_get_table(struct mapped_device *md);
76
77/*
78 * Event functions.
79 */
80uint32_t dm_get_event_nr(struct mapped_device *md);
81int dm_wait_event(struct mapped_device *md, int event_nr);
82
83/*
84 * Info functions.
85 */
86struct gendisk *dm_disk(struct mapped_device *md);
87int dm_suspended(struct mapped_device *md);
88
Darrick J. Wong3ac51e72006-03-27 01:17:54 -080089/*
90 * Geometry functions.
91 */
92int dm_get_geometry(struct mapped_device *md, struct hd_geometry *geo);
93int dm_set_geometry(struct mapped_device *md, struct hd_geometry *geo);
94
Linus Torvalds1da177e2005-04-16 15:20:36 -070095/*-----------------------------------------------------------------
96 * Functions for manipulating a table. Tables are also reference
97 * counted.
98 *---------------------------------------------------------------*/
Mike Anderson1134e5a2006-03-27 01:17:54 -080099int dm_table_create(struct dm_table **result, int mode,
100 unsigned num_targets, struct mapped_device *md);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101
102void dm_table_get(struct dm_table *t);
103void dm_table_put(struct dm_table *t);
104
105int dm_table_add_target(struct dm_table *t, const char *type,
106 sector_t start, sector_t len, char *params);
107int dm_table_complete(struct dm_table *t);
108void dm_table_event_callback(struct dm_table *t,
109 void (*fn)(void *), void *context);
110void dm_table_event(struct dm_table *t);
111sector_t dm_table_get_size(struct dm_table *t);
112struct dm_target *dm_table_get_target(struct dm_table *t, unsigned int index);
113struct dm_target *dm_table_find_target(struct dm_table *t, sector_t sector);
114void dm_table_set_restrictions(struct dm_table *t, struct request_queue *q);
115unsigned int dm_table_get_num_targets(struct dm_table *t);
116struct list_head *dm_table_get_devices(struct dm_table *t);
117int dm_table_get_mode(struct dm_table *t);
Mike Anderson1134e5a2006-03-27 01:17:54 -0800118struct mapped_device *dm_table_get_md(struct dm_table *t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119void dm_table_presuspend_targets(struct dm_table *t);
120void dm_table_postsuspend_targets(struct dm_table *t);
121void dm_table_resume_targets(struct dm_table *t);
122int dm_table_any_congested(struct dm_table *t, int bdi_bits);
123void dm_table_unplug_all(struct dm_table *t);
124int dm_table_flush_all(struct dm_table *t);
125
126/*-----------------------------------------------------------------
127 * A registry of target types.
128 *---------------------------------------------------------------*/
129int dm_target_init(void);
130void dm_target_exit(void);
131struct target_type *dm_get_target_type(const char *name);
132void dm_put_target_type(struct target_type *t);
133int dm_target_iterate(void (*iter_func)(struct target_type *tt,
134 void *param), void *param);
135
136
137/*-----------------------------------------------------------------
138 * Useful inlines.
139 *---------------------------------------------------------------*/
140static inline int array_too_big(unsigned long fixed, unsigned long obj,
141 unsigned long num)
142{
143 return (num > (ULONG_MAX - fixed) / obj);
144}
145
146/*
147 * Ceiling(n / sz)
148 */
149#define dm_div_up(n, sz) (((n) + (sz) - 1) / (sz))
150
151#define dm_sector_div_up(n, sz) ( \
152{ \
153 sector_t _r = ((n) + (sz) - 1); \
154 sector_div(_r, (sz)); \
155 _r; \
156} \
157)
158
159/*
160 * ceiling(n / size) * size
161 */
162#define dm_round_up(n, sz) (dm_div_up((n), (sz)) * (sz))
163
164static inline sector_t to_sector(unsigned long n)
165{
166 return (n >> 9);
167}
168
169static inline unsigned long to_bytes(sector_t n)
170{
171 return (n << 9);
172}
173
174int dm_split_args(int *argc, char ***argvp, char *input);
175
176/*
177 * The device-mapper can be driven through one of two interfaces;
178 * ioctl or filesystem, depending which patch you have applied.
179 */
180int dm_interface_init(void);
181void dm_interface_exit(void);
182
183/*
184 * Targets for linear and striped mappings
185 */
186int dm_linear_init(void);
187void dm_linear_exit(void);
188
189int dm_stripe_init(void);
190void dm_stripe_exit(void);
191
192void *dm_vcalloc(unsigned long nmemb, unsigned long elem_size);
193union map_info *dm_get_mapinfo(struct bio *bio);
194
195#endif