blob: deac3b4e5e18afdc4dfbf4c86715590b615ad02f [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * Copyright (C) 2001 Sistina Software (UK) Limited.
Alasdair G Kergon0da336e2008-04-24 21:43:52 +01003 * Copyright (C) 2004-2008 Red Hat, Inc. All rights reserved.
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 *
5 * This file is released under the LGPL.
6 */
7
8#ifndef _LINUX_DEVICE_MAPPER_H
9#define _LINUX_DEVICE_MAPPER_H
10
Heinz Mauelshagen416cd172008-04-24 21:43:35 +010011#include <linux/bio.h>
Milan Brozf6fccb12008-07-21 12:00:37 +010012#include <linux/blkdev.h>
Heinz Mauelshagen416cd172008-04-24 21:43:35 +010013
Mike Snitzeraf4874e2009-06-22 10:12:33 +010014struct dm_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -070015struct dm_target;
16struct dm_table;
Alasdair G Kergon17b2f662006-06-26 00:27:33 -070017struct mapped_device;
Milan Brozf6fccb12008-07-21 12:00:37 +010018struct bio_vec;
Linus Torvalds1da177e2005-04-16 15:20:36 -070019
20typedef enum { STATUSTYPE_INFO, STATUSTYPE_TABLE } status_type_t;
21
22union map_info {
23 void *ptr;
24 unsigned long long ll;
Mikulas Patockaf9ab94c2009-06-22 10:12:20 +010025 unsigned flush_request;
Linus Torvalds1da177e2005-04-16 15:20:36 -070026};
27
28/*
29 * In the constructor the target parameter will already have the
30 * table, type, begin and len fields filled in.
31 */
32typedef int (*dm_ctr_fn) (struct dm_target *target,
33 unsigned int argc, char **argv);
34
35/*
36 * The destructor doesn't need to free the dm_target, just
37 * anything hidden ti->private.
38 */
39typedef void (*dm_dtr_fn) (struct dm_target *ti);
40
41/*
42 * The map function must return:
43 * < 0: error
44 * = 0: The target will handle the io by resubmitting it later
Kiyoshi Ueda45cbcd72006-12-08 02:41:05 -080045 * = 1: simple remap complete
Kiyoshi Ueda2e93ccc2006-12-08 02:41:09 -080046 * = 2: The target wants to push back the io
Linus Torvalds1da177e2005-04-16 15:20:36 -070047 */
48typedef int (*dm_map_fn) (struct dm_target *ti, struct bio *bio,
49 union map_info *map_context);
Kiyoshi Ueda7d763452009-01-06 03:05:07 +000050typedef int (*dm_map_request_fn) (struct dm_target *ti, struct request *clone,
51 union map_info *map_context);
Linus Torvalds1da177e2005-04-16 15:20:36 -070052
53/*
54 * Returns:
55 * < 0 : error (currently ignored)
56 * 0 : ended successfully
57 * 1 : for some reason the io has still not completed (eg,
58 * multipath target might want to requeue a failed io).
Kiyoshi Ueda2e93ccc2006-12-08 02:41:09 -080059 * 2 : The target wants to push back the io
Linus Torvalds1da177e2005-04-16 15:20:36 -070060 */
61typedef int (*dm_endio_fn) (struct dm_target *ti,
62 struct bio *bio, int error,
63 union map_info *map_context);
Kiyoshi Ueda7d763452009-01-06 03:05:07 +000064typedef int (*dm_request_endio_fn) (struct dm_target *ti,
65 struct request *clone, int error,
66 union map_info *map_context);
Linus Torvalds1da177e2005-04-16 15:20:36 -070067
Bryn Reeves999d8162006-10-03 01:15:43 -070068typedef void (*dm_flush_fn) (struct dm_target *ti);
Linus Torvalds1da177e2005-04-16 15:20:36 -070069typedef void (*dm_presuspend_fn) (struct dm_target *ti);
70typedef void (*dm_postsuspend_fn) (struct dm_target *ti);
Milan Broz8757b772006-10-03 01:15:36 -070071typedef int (*dm_preresume_fn) (struct dm_target *ti);
Linus Torvalds1da177e2005-04-16 15:20:36 -070072typedef void (*dm_resume_fn) (struct dm_target *ti);
73
74typedef int (*dm_status_fn) (struct dm_target *ti, status_type_t status_type,
75 char *result, unsigned int maxlen);
76
77typedef int (*dm_message_fn) (struct dm_target *ti, unsigned argc, char **argv);
78
Al Viro647b3d02007-08-28 22:15:59 -040079typedef int (*dm_ioctl_fn) (struct dm_target *ti, unsigned int cmd,
Milan Brozaa129a22006-10-03 01:15:15 -070080 unsigned long arg);
81
Milan Brozf6fccb12008-07-21 12:00:37 +010082typedef int (*dm_merge_fn) (struct dm_target *ti, struct bvec_merge_data *bvm,
83 struct bio_vec *biovec, int max_size);
84
Mike Snitzeraf4874e2009-06-22 10:12:33 +010085typedef int (*iterate_devices_callout_fn) (struct dm_target *ti,
86 struct dm_dev *dev,
87 sector_t physical_start,
88 void *data);
89
90typedef int (*dm_iterate_devices_fn) (struct dm_target *ti,
91 iterate_devices_callout_fn fn,
92 void *data);
93
Kiyoshi Ueda7d763452009-01-06 03:05:07 +000094/*
95 * Returns:
96 * 0: The target can handle the next I/O immediately.
97 * 1: The target can't handle the next I/O immediately.
98 */
99typedef int (*dm_busy_fn) (struct dm_target *ti);
100
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101void dm_error(const char *message);
102
103/*
Bryn Reeves3cb40212006-10-03 01:15:42 -0700104 * Combine device limits.
105 */
106void dm_set_device_limits(struct dm_target *ti, struct block_device *bdev);
107
Mikulas Patocka82b15192008-10-10 13:37:09 +0100108struct dm_dev {
109 struct block_device *bdev;
Al Viroaeb5d722008-09-02 15:28:45 -0400110 fmode_t mode;
Mikulas Patocka82b15192008-10-10 13:37:09 +0100111 char name[16];
112};
113
Bryn Reeves3cb40212006-10-03 01:15:42 -0700114/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115 * Constructors should call these functions to ensure destination devices
116 * are opened/closed correctly.
117 * FIXME: too many arguments.
118 */
119int dm_get_device(struct dm_target *ti, const char *path, sector_t start,
Al Viroaeb5d722008-09-02 15:28:45 -0400120 sector_t len, fmode_t mode, struct dm_dev **result);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121void dm_put_device(struct dm_target *ti, struct dm_dev *d);
122
123/*
124 * Information about a target type
125 */
Andi Kleenab4c142482009-01-06 03:05:09 +0000126
127/*
128 * Target features
129 */
Andi Kleenab4c142482009-01-06 03:05:09 +0000130
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131struct target_type {
Andi Kleenab4c142482009-01-06 03:05:09 +0000132 uint64_t features;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 const char *name;
134 struct module *module;
Alasdair G Kergon17b2f662006-06-26 00:27:33 -0700135 unsigned version[3];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136 dm_ctr_fn ctr;
137 dm_dtr_fn dtr;
138 dm_map_fn map;
Kiyoshi Ueda7d763452009-01-06 03:05:07 +0000139 dm_map_request_fn map_rq;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140 dm_endio_fn end_io;
Kiyoshi Ueda7d763452009-01-06 03:05:07 +0000141 dm_request_endio_fn rq_end_io;
Bryn Reeves999d8162006-10-03 01:15:43 -0700142 dm_flush_fn flush;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143 dm_presuspend_fn presuspend;
144 dm_postsuspend_fn postsuspend;
Milan Broz8757b772006-10-03 01:15:36 -0700145 dm_preresume_fn preresume;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146 dm_resume_fn resume;
147 dm_status_fn status;
148 dm_message_fn message;
Milan Brozaa129a22006-10-03 01:15:15 -0700149 dm_ioctl_fn ioctl;
Milan Brozf6fccb12008-07-21 12:00:37 +0100150 dm_merge_fn merge;
Kiyoshi Ueda7d763452009-01-06 03:05:07 +0000151 dm_busy_fn busy;
Mike Snitzeraf4874e2009-06-22 10:12:33 +0100152 dm_iterate_devices_fn iterate_devices;
Cheng Renquan45194e42009-04-02 19:55:28 +0100153
154 /* For internal device-mapper use. */
155 struct list_head list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156};
157
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158struct dm_target {
159 struct dm_table *table;
160 struct target_type *type;
161
162 /* target limits */
163 sector_t begin;
164 sector_t len;
165
Mike Snitzer5ab97582009-06-22 10:12:32 +0100166 /* FIXME: turn this into a mask, and merge with queue_limits */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167 /* Always a power of 2 */
168 sector_t split_io;
169
170 /*
Mikulas Patockaf9ab94c2009-06-22 10:12:20 +0100171 * A number of zero-length barrier requests that will be submitted
172 * to the target for the purpose of flushing cache.
173 *
174 * The request number will be placed in union map_info->flush_request.
175 * It is a responsibility of the target driver to remap these requests
176 * to the real underlying devices.
177 */
178 unsigned num_flush_requests;
179
180 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181 * These are automatically filled in by
182 * dm_table_get_device.
183 */
Mike Snitzer5ab97582009-06-22 10:12:32 +0100184 struct queue_limits limits;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185
186 /* target specific data */
187 void *private;
188
189 /* Used to provide an error string from the ctr */
190 char *error;
191};
192
193int dm_register_target(struct target_type *t);
Mikulas Patocka10d3bd02009-01-06 03:04:58 +0000194void dm_unregister_target(struct target_type *t);
Alasdair G Kergon17b2f662006-06-26 00:27:33 -0700195
196/*-----------------------------------------------------------------
197 * Functions for creating and manipulating mapped devices.
198 * Drop the reference with dm_put when you finish with the object.
199 *---------------------------------------------------------------*/
200
201/*
202 * DM_ANY_MINOR chooses the next available minor number.
203 */
204#define DM_ANY_MINOR (-1)
205int dm_create(int minor, struct mapped_device **md);
206
207/*
208 * Reference counting for md.
209 */
210struct mapped_device *dm_get_md(dev_t dev);
211void dm_get(struct mapped_device *md);
212void dm_put(struct mapped_device *md);
213
214/*
215 * An arbitrary pointer may be stored alongside a mapped device.
216 */
217void dm_set_mdptr(struct mapped_device *md, void *ptr);
218void *dm_get_mdptr(struct mapped_device *md);
219
220/*
221 * A device can still be used while suspended, but I/O is deferred.
222 */
Kiyoshi Uedaa3d77d32006-12-08 02:41:04 -0800223int dm_suspend(struct mapped_device *md, unsigned suspend_flags);
Alasdair G Kergon17b2f662006-06-26 00:27:33 -0700224int dm_resume(struct mapped_device *md);
225
226/*
227 * Event functions.
228 */
229uint32_t dm_get_event_nr(struct mapped_device *md);
230int dm_wait_event(struct mapped_device *md, int event_nr);
Mike Anderson7a8c3d32007-10-19 22:48:01 +0100231uint32_t dm_next_uevent_seq(struct mapped_device *md);
232void dm_uevent_add(struct mapped_device *md, struct list_head *elist);
Alasdair G Kergon17b2f662006-06-26 00:27:33 -0700233
234/*
235 * Info functions.
236 */
Alasdair G Kergon72d94862006-06-26 00:27:35 -0700237const char *dm_device_name(struct mapped_device *md);
Mike Anderson96a1f7d2007-10-19 22:47:59 +0100238int dm_copy_name_and_uuid(struct mapped_device *md, char *name, char *uuid);
Alasdair G Kergon17b2f662006-06-26 00:27:33 -0700239struct gendisk *dm_disk(struct mapped_device *md);
240int dm_suspended(struct mapped_device *md);
Kiyoshi Ueda2e93ccc2006-12-08 02:41:09 -0800241int dm_noflush_suspending(struct dm_target *ti);
Mikulas Patocka89343da2008-10-10 13:37:10 +0100242union map_info *dm_get_mapinfo(struct bio *bio);
Alasdair G Kergon17b2f662006-06-26 00:27:33 -0700243
244/*
245 * Geometry functions.
246 */
247int dm_get_geometry(struct mapped_device *md, struct hd_geometry *geo);
248int dm_set_geometry(struct mapped_device *md, struct hd_geometry *geo);
249
250
251/*-----------------------------------------------------------------
252 * Functions for manipulating device-mapper tables.
253 *---------------------------------------------------------------*/
254
255/*
256 * First create an empty table.
257 */
Al Viroaeb5d722008-09-02 15:28:45 -0400258int dm_table_create(struct dm_table **result, fmode_t mode,
Alasdair G Kergon17b2f662006-06-26 00:27:33 -0700259 unsigned num_targets, struct mapped_device *md);
260
261/*
262 * Then call this once for each target.
263 */
264int dm_table_add_target(struct dm_table *t, const char *type,
265 sector_t start, sector_t len, char *params);
266
267/*
268 * Finally call this to make the table ready for use.
269 */
270int dm_table_complete(struct dm_table *t);
271
272/*
Mikulas Patockaea0ec642008-10-10 13:37:11 +0100273 * Unplug all devices in a table.
274 */
275void dm_table_unplug_all(struct dm_table *t);
276
277/*
Alasdair G Kergon17b2f662006-06-26 00:27:33 -0700278 * Table reference counting.
279 */
280struct dm_table *dm_get_table(struct mapped_device *md);
281void dm_table_get(struct dm_table *t);
282void dm_table_put(struct dm_table *t);
283
284/*
285 * Queries
286 */
287sector_t dm_table_get_size(struct dm_table *t);
288unsigned int dm_table_get_num_targets(struct dm_table *t);
Al Viroaeb5d722008-09-02 15:28:45 -0400289fmode_t dm_table_get_mode(struct dm_table *t);
Alasdair G Kergon17b2f662006-06-26 00:27:33 -0700290struct mapped_device *dm_table_get_md(struct dm_table *t);
291
292/*
293 * Trigger an event.
294 */
295void dm_table_event(struct dm_table *t);
296
297/*
298 * The device must be suspended before calling this method.
299 */
300int dm_swap_table(struct mapped_device *md, struct dm_table *t);
301
Mikulas Patocka54160902008-10-10 13:37:12 +0100302/*
303 * A wrapper around vmalloc.
304 */
305void *dm_vcalloc(unsigned long nmemb, unsigned long elem_size);
306
Alasdair G Kergon0da336e2008-04-24 21:43:52 +0100307/*-----------------------------------------------------------------
308 * Macros.
309 *---------------------------------------------------------------*/
310#define DM_NAME "device-mapper"
311
Mikulas Patocka10d3bd02009-01-06 03:04:58 +0000312#define DMCRIT(f, arg...) \
313 printk(KERN_CRIT DM_NAME ": " DM_MSG_PREFIX ": " f "\n", ## arg)
314
Alasdair G Kergon0da336e2008-04-24 21:43:52 +0100315#define DMERR(f, arg...) \
316 printk(KERN_ERR DM_NAME ": " DM_MSG_PREFIX ": " f "\n", ## arg)
317#define DMERR_LIMIT(f, arg...) \
318 do { \
319 if (printk_ratelimit()) \
320 printk(KERN_ERR DM_NAME ": " DM_MSG_PREFIX ": " \
321 f "\n", ## arg); \
322 } while (0)
323
324#define DMWARN(f, arg...) \
325 printk(KERN_WARNING DM_NAME ": " DM_MSG_PREFIX ": " f "\n", ## arg)
326#define DMWARN_LIMIT(f, arg...) \
327 do { \
328 if (printk_ratelimit()) \
329 printk(KERN_WARNING DM_NAME ": " DM_MSG_PREFIX ": " \
330 f "\n", ## arg); \
331 } while (0)
332
333#define DMINFO(f, arg...) \
334 printk(KERN_INFO DM_NAME ": " DM_MSG_PREFIX ": " f "\n", ## arg)
335#define DMINFO_LIMIT(f, arg...) \
336 do { \
337 if (printk_ratelimit()) \
338 printk(KERN_INFO DM_NAME ": " DM_MSG_PREFIX ": " f \
339 "\n", ## arg); \
340 } while (0)
341
342#ifdef CONFIG_DM_DEBUG
343# define DMDEBUG(f, arg...) \
344 printk(KERN_DEBUG DM_NAME ": " DM_MSG_PREFIX " DEBUG: " f "\n", ## arg)
345# define DMDEBUG_LIMIT(f, arg...) \
346 do { \
347 if (printk_ratelimit()) \
348 printk(KERN_DEBUG DM_NAME ": " DM_MSG_PREFIX ": " f \
349 "\n", ## arg); \
350 } while (0)
351#else
352# define DMDEBUG(f, arg...) do {} while (0)
353# define DMDEBUG_LIMIT(f, arg...) do {} while (0)
354#endif
355
356#define DMEMIT(x...) sz += ((sz >= maxlen) ? \
357 0 : scnprintf(result + sz, maxlen - sz, x))
358
359#define SECTOR_SHIFT 9
360
361/*
362 * Definitions of return values from target end_io function.
363 */
364#define DM_ENDIO_INCOMPLETE 1
365#define DM_ENDIO_REQUEUE 2
366
367/*
368 * Definitions of return values from target map function.
369 */
370#define DM_MAPIO_SUBMITTED 0
371#define DM_MAPIO_REMAPPED 1
372#define DM_MAPIO_REQUEUE DM_ENDIO_REQUEUE
373
374/*
375 * Ceiling(n / sz)
376 */
377#define dm_div_up(n, sz) (((n) + (sz) - 1) / (sz))
378
379#define dm_sector_div_up(n, sz) ( \
380{ \
381 sector_t _r = ((n) + (sz) - 1); \
382 sector_div(_r, (sz)); \
383 _r; \
384} \
385)
386
387/*
388 * ceiling(n / size) * size
389 */
390#define dm_round_up(n, sz) (dm_div_up((n), (sz)) * (sz))
391
Mikulas Patockad63a5ce2008-10-21 17:44:57 +0100392#define dm_array_too_big(fixed, obj, num) \
393 ((num) > (UINT_MAX - (fixed)) / (obj))
394
Alasdair G Kergon0da336e2008-04-24 21:43:52 +0100395static inline sector_t to_sector(unsigned long n)
396{
397 return (n >> SECTOR_SHIFT);
398}
399
400static inline unsigned long to_bytes(sector_t n)
401{
402 return (n << SECTOR_SHIFT);
403}
404
Alasdair G Kergon17b2f662006-06-26 00:27:33 -0700405#endif /* _LINUX_DEVICE_MAPPER_H */