]> bbs.cooldavid.org Git - net-next-2.6.git/blame - include/linux/device-mapper.h
dm table: replace struct io_restrictions with struct queue_limits
[net-next-2.6.git] / include / linux / device-mapper.h
CommitLineData
1da177e4
LT
1/*
2 * Copyright (C) 2001 Sistina Software (UK) Limited.
0da336e5 3 * Copyright (C) 2004-2008 Red Hat, Inc. All rights reserved.
1da177e4
LT
4 *
5 * This file is released under the LGPL.
6 */
7
8#ifndef _LINUX_DEVICE_MAPPER_H
9#define _LINUX_DEVICE_MAPPER_H
10
416cd17b 11#include <linux/bio.h>
f6fccb12 12#include <linux/blkdev.h>
416cd17b 13
1da177e4
LT
14struct dm_target;
15struct dm_table;
17b2f66f 16struct mapped_device;
f6fccb12 17struct bio_vec;
1da177e4
LT
18
19typedef enum { STATUSTYPE_INFO, STATUSTYPE_TABLE } status_type_t;
20
21union map_info {
22 void *ptr;
23 unsigned long long ll;
f9ab94ce 24 unsigned flush_request;
1da177e4
LT
25};
26
27/*
28 * In the constructor the target parameter will already have the
29 * table, type, begin and len fields filled in.
30 */
31typedef int (*dm_ctr_fn) (struct dm_target *target,
32 unsigned int argc, char **argv);
33
34/*
35 * The destructor doesn't need to free the dm_target, just
36 * anything hidden ti->private.
37 */
38typedef void (*dm_dtr_fn) (struct dm_target *ti);
39
40/*
41 * The map function must return:
42 * < 0: error
43 * = 0: The target will handle the io by resubmitting it later
45cbcd79 44 * = 1: simple remap complete
2e93ccc1 45 * = 2: The target wants to push back the io
1da177e4
LT
46 */
47typedef int (*dm_map_fn) (struct dm_target *ti, struct bio *bio,
48 union map_info *map_context);
7d76345d
KU
49typedef int (*dm_map_request_fn) (struct dm_target *ti, struct request *clone,
50 union map_info *map_context);
1da177e4
LT
51
52/*
53 * Returns:
54 * < 0 : error (currently ignored)
55 * 0 : ended successfully
56 * 1 : for some reason the io has still not completed (eg,
57 * multipath target might want to requeue a failed io).
2e93ccc1 58 * 2 : The target wants to push back the io
1da177e4
LT
59 */
60typedef int (*dm_endio_fn) (struct dm_target *ti,
61 struct bio *bio, int error,
62 union map_info *map_context);
7d76345d
KU
63typedef int (*dm_request_endio_fn) (struct dm_target *ti,
64 struct request *clone, int error,
65 union map_info *map_context);
1da177e4 66
999d8168 67typedef void (*dm_flush_fn) (struct dm_target *ti);
1da177e4
LT
68typedef void (*dm_presuspend_fn) (struct dm_target *ti);
69typedef void (*dm_postsuspend_fn) (struct dm_target *ti);
8757b776 70typedef int (*dm_preresume_fn) (struct dm_target *ti);
1da177e4
LT
71typedef void (*dm_resume_fn) (struct dm_target *ti);
72
73typedef int (*dm_status_fn) (struct dm_target *ti, status_type_t status_type,
74 char *result, unsigned int maxlen);
75
76typedef int (*dm_message_fn) (struct dm_target *ti, unsigned argc, char **argv);
77
647b3d00 78typedef int (*dm_ioctl_fn) (struct dm_target *ti, unsigned int cmd,
aa129a22
MB
79 unsigned long arg);
80
f6fccb12
MB
81typedef int (*dm_merge_fn) (struct dm_target *ti, struct bvec_merge_data *bvm,
82 struct bio_vec *biovec, int max_size);
83
7d76345d
KU
84/*
85 * Returns:
86 * 0: The target can handle the next I/O immediately.
87 * 1: The target can't handle the next I/O immediately.
88 */
89typedef int (*dm_busy_fn) (struct dm_target *ti);
90
1da177e4
LT
91void dm_error(const char *message);
92
3cb40214
BR
93/*
94 * Combine device limits.
95 */
96void dm_set_device_limits(struct dm_target *ti, struct block_device *bdev);
97
82b1519b
MP
98struct dm_dev {
99 struct block_device *bdev;
aeb5d727 100 fmode_t mode;
82b1519b
MP
101 char name[16];
102};
103
1da177e4
LT
104/*
105 * Constructors should call these functions to ensure destination devices
106 * are opened/closed correctly.
107 * FIXME: too many arguments.
108 */
109int dm_get_device(struct dm_target *ti, const char *path, sector_t start,
aeb5d727 110 sector_t len, fmode_t mode, struct dm_dev **result);
1da177e4
LT
111void dm_put_device(struct dm_target *ti, struct dm_dev *d);
112
113/*
114 * Information about a target type
115 */
ab4c1424
AK
116
117/*
118 * Target features
119 */
ab4c1424 120
1da177e4 121struct target_type {
ab4c1424 122 uint64_t features;
1da177e4
LT
123 const char *name;
124 struct module *module;
17b2f66f 125 unsigned version[3];
1da177e4
LT
126 dm_ctr_fn ctr;
127 dm_dtr_fn dtr;
128 dm_map_fn map;
7d76345d 129 dm_map_request_fn map_rq;
1da177e4 130 dm_endio_fn end_io;
7d76345d 131 dm_request_endio_fn rq_end_io;
999d8168 132 dm_flush_fn flush;
1da177e4
LT
133 dm_presuspend_fn presuspend;
134 dm_postsuspend_fn postsuspend;
8757b776 135 dm_preresume_fn preresume;
1da177e4
LT
136 dm_resume_fn resume;
137 dm_status_fn status;
138 dm_message_fn message;
aa129a22 139 dm_ioctl_fn ioctl;
f6fccb12 140 dm_merge_fn merge;
7d76345d 141 dm_busy_fn busy;
45194e4f
CR
142
143 /* For internal device-mapper use. */
144 struct list_head list;
1da177e4
LT
145};
146
1da177e4
LT
147struct dm_target {
148 struct dm_table *table;
149 struct target_type *type;
150
151 /* target limits */
152 sector_t begin;
153 sector_t len;
154
5ab97588 155 /* FIXME: turn this into a mask, and merge with queue_limits */
1da177e4
LT
156 /* Always a power of 2 */
157 sector_t split_io;
158
f9ab94ce
MP
159 /*
160 * A number of zero-length barrier requests that will be submitted
161 * to the target for the purpose of flushing cache.
162 *
163 * The request number will be placed in union map_info->flush_request.
164 * It is a responsibility of the target driver to remap these requests
165 * to the real underlying devices.
166 */
167 unsigned num_flush_requests;
168
1da177e4
LT
169 /*
170 * These are automatically filled in by
171 * dm_table_get_device.
172 */
5ab97588 173 struct queue_limits limits;
1da177e4
LT
174
175 /* target specific data */
176 void *private;
177
178 /* Used to provide an error string from the ctr */
179 char *error;
180};
181
182int dm_register_target(struct target_type *t);
10d3bd09 183void dm_unregister_target(struct target_type *t);
17b2f66f
AK
184
185/*-----------------------------------------------------------------
186 * Functions for creating and manipulating mapped devices.
187 * Drop the reference with dm_put when you finish with the object.
188 *---------------------------------------------------------------*/
189
190/*
191 * DM_ANY_MINOR chooses the next available minor number.
192 */
193#define DM_ANY_MINOR (-1)
194int dm_create(int minor, struct mapped_device **md);
195
196/*
197 * Reference counting for md.
198 */
199struct mapped_device *dm_get_md(dev_t dev);
200void dm_get(struct mapped_device *md);
201void dm_put(struct mapped_device *md);
202
203/*
204 * An arbitrary pointer may be stored alongside a mapped device.
205 */
206void dm_set_mdptr(struct mapped_device *md, void *ptr);
207void *dm_get_mdptr(struct mapped_device *md);
208
209/*
210 * A device can still be used while suspended, but I/O is deferred.
211 */
a3d77d35 212int dm_suspend(struct mapped_device *md, unsigned suspend_flags);
17b2f66f
AK
213int dm_resume(struct mapped_device *md);
214
215/*
216 * Event functions.
217 */
218uint32_t dm_get_event_nr(struct mapped_device *md);
219int dm_wait_event(struct mapped_device *md, int event_nr);
7a8c3d3b
MA
220uint32_t dm_next_uevent_seq(struct mapped_device *md);
221void dm_uevent_add(struct mapped_device *md, struct list_head *elist);
17b2f66f
AK
222
223/*
224 * Info functions.
225 */
72d94861 226const char *dm_device_name(struct mapped_device *md);
96a1f7db 227int dm_copy_name_and_uuid(struct mapped_device *md, char *name, char *uuid);
17b2f66f
AK
228struct gendisk *dm_disk(struct mapped_device *md);
229int dm_suspended(struct mapped_device *md);
2e93ccc1 230int dm_noflush_suspending(struct dm_target *ti);
89343da0 231union map_info *dm_get_mapinfo(struct bio *bio);
17b2f66f
AK
232
233/*
234 * Geometry functions.
235 */
236int dm_get_geometry(struct mapped_device *md, struct hd_geometry *geo);
237int dm_set_geometry(struct mapped_device *md, struct hd_geometry *geo);
238
239
240/*-----------------------------------------------------------------
241 * Functions for manipulating device-mapper tables.
242 *---------------------------------------------------------------*/
243
244/*
245 * First create an empty table.
246 */
aeb5d727 247int dm_table_create(struct dm_table **result, fmode_t mode,
17b2f66f
AK
248 unsigned num_targets, struct mapped_device *md);
249
250/*
251 * Then call this once for each target.
252 */
253int dm_table_add_target(struct dm_table *t, const char *type,
254 sector_t start, sector_t len, char *params);
255
256/*
257 * Finally call this to make the table ready for use.
258 */
259int dm_table_complete(struct dm_table *t);
260
ea0ec640
MP
261/*
262 * Unplug all devices in a table.
263 */
264void dm_table_unplug_all(struct dm_table *t);
265
17b2f66f
AK
266/*
267 * Table reference counting.
268 */
269struct dm_table *dm_get_table(struct mapped_device *md);
270void dm_table_get(struct dm_table *t);
271void dm_table_put(struct dm_table *t);
272
273/*
274 * Queries
275 */
276sector_t dm_table_get_size(struct dm_table *t);
277unsigned int dm_table_get_num_targets(struct dm_table *t);
aeb5d727 278fmode_t dm_table_get_mode(struct dm_table *t);
17b2f66f
AK
279struct mapped_device *dm_table_get_md(struct dm_table *t);
280
281/*
282 * Trigger an event.
283 */
284void dm_table_event(struct dm_table *t);
285
286/*
287 * The device must be suspended before calling this method.
288 */
289int dm_swap_table(struct mapped_device *md, struct dm_table *t);
290
54160904
MP
291/*
292 * A wrapper around vmalloc.
293 */
294void *dm_vcalloc(unsigned long nmemb, unsigned long elem_size);
295
0da336e5
AK
296/*-----------------------------------------------------------------
297 * Macros.
298 *---------------------------------------------------------------*/
299#define DM_NAME "device-mapper"
300
10d3bd09
MP
301#define DMCRIT(f, arg...) \
302 printk(KERN_CRIT DM_NAME ": " DM_MSG_PREFIX ": " f "\n", ## arg)
303
0da336e5
AK
304#define DMERR(f, arg...) \
305 printk(KERN_ERR DM_NAME ": " DM_MSG_PREFIX ": " f "\n", ## arg)
306#define DMERR_LIMIT(f, arg...) \
307 do { \
308 if (printk_ratelimit()) \
309 printk(KERN_ERR DM_NAME ": " DM_MSG_PREFIX ": " \
310 f "\n", ## arg); \
311 } while (0)
312
313#define DMWARN(f, arg...) \
314 printk(KERN_WARNING DM_NAME ": " DM_MSG_PREFIX ": " f "\n", ## arg)
315#define DMWARN_LIMIT(f, arg...) \
316 do { \
317 if (printk_ratelimit()) \
318 printk(KERN_WARNING DM_NAME ": " DM_MSG_PREFIX ": " \
319 f "\n", ## arg); \
320 } while (0)
321
322#define DMINFO(f, arg...) \
323 printk(KERN_INFO DM_NAME ": " DM_MSG_PREFIX ": " f "\n", ## arg)
324#define DMINFO_LIMIT(f, arg...) \
325 do { \
326 if (printk_ratelimit()) \
327 printk(KERN_INFO DM_NAME ": " DM_MSG_PREFIX ": " f \
328 "\n", ## arg); \
329 } while (0)
330
331#ifdef CONFIG_DM_DEBUG
332# define DMDEBUG(f, arg...) \
333 printk(KERN_DEBUG DM_NAME ": " DM_MSG_PREFIX " DEBUG: " f "\n", ## arg)
334# define DMDEBUG_LIMIT(f, arg...) \
335 do { \
336 if (printk_ratelimit()) \
337 printk(KERN_DEBUG DM_NAME ": " DM_MSG_PREFIX ": " f \
338 "\n", ## arg); \
339 } while (0)
340#else
341# define DMDEBUG(f, arg...) do {} while (0)
342# define DMDEBUG_LIMIT(f, arg...) do {} while (0)
343#endif
344
345#define DMEMIT(x...) sz += ((sz >= maxlen) ? \
346 0 : scnprintf(result + sz, maxlen - sz, x))
347
348#define SECTOR_SHIFT 9
349
350/*
351 * Definitions of return values from target end_io function.
352 */
353#define DM_ENDIO_INCOMPLETE 1
354#define DM_ENDIO_REQUEUE 2
355
356/*
357 * Definitions of return values from target map function.
358 */
359#define DM_MAPIO_SUBMITTED 0
360#define DM_MAPIO_REMAPPED 1
361#define DM_MAPIO_REQUEUE DM_ENDIO_REQUEUE
362
363/*
364 * Ceiling(n / sz)
365 */
366#define dm_div_up(n, sz) (((n) + (sz) - 1) / (sz))
367
368#define dm_sector_div_up(n, sz) ( \
369{ \
370 sector_t _r = ((n) + (sz) - 1); \
371 sector_div(_r, (sz)); \
372 _r; \
373} \
374)
375
376/*
377 * ceiling(n / size) * size
378 */
379#define dm_round_up(n, sz) (dm_div_up((n), (sz)) * (sz))
380
d63a5ce3
MP
381#define dm_array_too_big(fixed, obj, num) \
382 ((num) > (UINT_MAX - (fixed)) / (obj))
383
0da336e5
AK
384static inline sector_t to_sector(unsigned long n)
385{
386 return (n >> SECTOR_SHIFT);
387}
388
389static inline unsigned long to_bytes(sector_t n)
390{
391 return (n << SECTOR_SHIFT);
392}
393
17b2f66f 394#endif /* _LINUX_DEVICE_MAPPER_H */