2 * Copyright (C) 2001 Sistina Software (UK) Limited.
3 * Copyright (C) 2004 Red Hat, Inc. All rights reserved.
5 * This file is released under the LGPL.
8 #ifndef _LINUX_DEVICE_MAPPER_H
9 #define _LINUX_DEVICE_MAPPER_H
18 typedef enum { STATUSTYPE_INFO, STATUSTYPE_TABLE } status_type_t;
22 unsigned long long ll;
26 * In the constructor the target parameter will already have the
27 * table, type, begin and len fields filled in.
29 typedef int (*dm_ctr_fn) (struct dm_target *target,
30 unsigned int argc, char **argv);
33 * The destructor doesn't need to free the dm_target, just
34 * anything hidden ti->private.
36 typedef void (*dm_dtr_fn) (struct dm_target *ti);
39 * The map function must return:
41 * = 0: The target will handle the io by resubmitting it later
42 * > 0: simple remap complete
44 typedef int (*dm_map_fn) (struct dm_target *ti, struct bio *bio,
45 union map_info *map_context);
49 * < 0 : error (currently ignored)
50 * 0 : ended successfully
51 * 1 : for some reason the io has still not completed (eg,
52 * multipath target might want to requeue a failed io).
54 typedef int (*dm_endio_fn) (struct dm_target *ti,
55 struct bio *bio, int error,
56 union map_info *map_context);
58 typedef void (*dm_presuspend_fn) (struct dm_target *ti);
59 typedef void (*dm_postsuspend_fn) (struct dm_target *ti);
60 typedef int (*dm_preresume_fn) (struct dm_target *ti);
61 typedef void (*dm_resume_fn) (struct dm_target *ti);
63 typedef int (*dm_status_fn) (struct dm_target *ti, status_type_t status_type,
64 char *result, unsigned int maxlen);
66 typedef int (*dm_message_fn) (struct dm_target *ti, unsigned argc, char **argv);
68 typedef int (*dm_ioctl_fn) (struct dm_target *ti, struct inode *inode,
69 struct file *filp, unsigned int cmd,
72 void dm_error(const char *message);
75 * Constructors should call these functions to ensure destination devices
76 * are opened/closed correctly.
77 * FIXME: too many arguments.
79 int dm_get_device(struct dm_target *ti, const char *path, sector_t start,
80 sector_t len, int mode, struct dm_dev **result);
81 void dm_put_device(struct dm_target *ti, struct dm_dev *d);
84 * Information about a target type
88 struct module *module;
94 dm_presuspend_fn presuspend;
95 dm_postsuspend_fn postsuspend;
96 dm_preresume_fn preresume;
99 dm_message_fn message;
103 struct io_restrictions {
104 unsigned int max_sectors;
105 unsigned short max_phys_segments;
106 unsigned short max_hw_segments;
107 unsigned short hardsect_size;
108 unsigned int max_segment_size;
109 unsigned long seg_boundary_mask;
110 unsigned char no_cluster; /* inverted so that 0 is default */
114 struct dm_table *table;
115 struct target_type *type;
121 /* FIXME: turn this into a mask, and merge with io_restrictions */
122 /* Always a power of 2 */
126 * These are automatically filled in by
127 * dm_table_get_device.
129 struct io_restrictions limits;
131 /* target specific data */
134 /* Used to provide an error string from the ctr */
138 int dm_register_target(struct target_type *t);
139 int dm_unregister_target(struct target_type *t);
142 /*-----------------------------------------------------------------
143 * Functions for creating and manipulating mapped devices.
144 * Drop the reference with dm_put when you finish with the object.
145 *---------------------------------------------------------------*/
148 * DM_ANY_MINOR chooses the next available minor number.
150 #define DM_ANY_MINOR (-1)
151 int dm_create(int minor, struct mapped_device **md);
154 * Reference counting for md.
156 struct mapped_device *dm_get_md(dev_t dev);
157 void dm_get(struct mapped_device *md);
158 void dm_put(struct mapped_device *md);
161 * An arbitrary pointer may be stored alongside a mapped device.
163 void dm_set_mdptr(struct mapped_device *md, void *ptr);
164 void *dm_get_mdptr(struct mapped_device *md);
167 * A device can still be used while suspended, but I/O is deferred.
169 int dm_suspend(struct mapped_device *md, int with_lockfs);
170 int dm_resume(struct mapped_device *md);
175 uint32_t dm_get_event_nr(struct mapped_device *md);
176 int dm_wait_event(struct mapped_device *md, int event_nr);
181 const char *dm_device_name(struct mapped_device *md);
182 struct gendisk *dm_disk(struct mapped_device *md);
183 int dm_suspended(struct mapped_device *md);
186 * Geometry functions.
188 int dm_get_geometry(struct mapped_device *md, struct hd_geometry *geo);
189 int dm_set_geometry(struct mapped_device *md, struct hd_geometry *geo);
192 /*-----------------------------------------------------------------
193 * Functions for manipulating device-mapper tables.
194 *---------------------------------------------------------------*/
197 * First create an empty table.
199 int dm_table_create(struct dm_table **result, int mode,
200 unsigned num_targets, struct mapped_device *md);
203 * Then call this once for each target.
205 int dm_table_add_target(struct dm_table *t, const char *type,
206 sector_t start, sector_t len, char *params);
209 * Finally call this to make the table ready for use.
211 int dm_table_complete(struct dm_table *t);
214 * Table reference counting.
216 struct dm_table *dm_get_table(struct mapped_device *md);
217 void dm_table_get(struct dm_table *t);
218 void dm_table_put(struct dm_table *t);
223 sector_t dm_table_get_size(struct dm_table *t);
224 unsigned int dm_table_get_num_targets(struct dm_table *t);
225 int dm_table_get_mode(struct dm_table *t);
226 struct mapped_device *dm_table_get_md(struct dm_table *t);
231 void dm_table_event(struct dm_table *t);
234 * The device must be suspended before calling this method.
236 int dm_swap_table(struct mapped_device *md, struct dm_table *t);
239 * Prepare a table for a device that will error all I/O.
240 * To make it active, call dm_suspend(), dm_swap_table() then dm_resume().
242 int dm_create_error_table(struct dm_table **result, struct mapped_device *md);
244 #endif /* __KERNEL__ */
245 #endif /* _LINUX_DEVICE_MAPPER_H */