d1f6cd8486f28e890407bce23ecea5e181069886
[platform/adaptation/renesas_rcar/renesas_kernel.git] / include / linux / device-mapper.h
1 /*
2  * Copyright (C) 2001 Sistina Software (UK) Limited.
3  * Copyright (C) 2004-2008 Red Hat, Inc. All rights reserved.
4  *
5  * This file is released under the LGPL.
6  */
7
8 #ifndef _LINUX_DEVICE_MAPPER_H
9 #define _LINUX_DEVICE_MAPPER_H
10
11 #include <linux/bio.h>
12 #include <linux/blkdev.h>
13 #include <linux/ratelimit.h>
14
15 struct dm_dev;
16 struct dm_target;
17 struct dm_table;
18 struct mapped_device;
19 struct bio_vec;
20
21 typedef enum { STATUSTYPE_INFO, STATUSTYPE_TABLE } status_type_t;
22
23 union map_info {
24         void *ptr;
25         unsigned long long ll;
26         unsigned target_request_nr;
27 };
28
29 /*
30  * In the constructor the target parameter will already have the
31  * table, type, begin and len fields filled in.
32  */
33 typedef int (*dm_ctr_fn) (struct dm_target *target,
34                           unsigned int argc, char **argv);
35
36 /*
37  * The destructor doesn't need to free the dm_target, just
38  * anything hidden ti->private.
39  */
40 typedef void (*dm_dtr_fn) (struct dm_target *ti);
41
42 /*
43  * The map function must return:
44  * < 0: error
45  * = 0: The target will handle the io by resubmitting it later
46  * = 1: simple remap complete
47  * = 2: The target wants to push back the io
48  */
49 typedef int (*dm_map_fn) (struct dm_target *ti, struct bio *bio,
50                           union map_info *map_context);
51 typedef int (*dm_map_request_fn) (struct dm_target *ti, struct request *clone,
52                                   union map_info *map_context);
53
54 /*
55  * Returns:
56  * < 0 : error (currently ignored)
57  * 0   : ended successfully
58  * 1   : for some reason the io has still not completed (eg,
59  *       multipath target might want to requeue a failed io).
60  * 2   : The target wants to push back the io
61  */
62 typedef int (*dm_endio_fn) (struct dm_target *ti,
63                             struct bio *bio, int error,
64                             union map_info *map_context);
65 typedef int (*dm_request_endio_fn) (struct dm_target *ti,
66                                     struct request *clone, int error,
67                                     union map_info *map_context);
68
69 typedef void (*dm_presuspend_fn) (struct dm_target *ti);
70 typedef void (*dm_postsuspend_fn) (struct dm_target *ti);
71 typedef int (*dm_preresume_fn) (struct dm_target *ti);
72 typedef void (*dm_resume_fn) (struct dm_target *ti);
73
74 typedef int (*dm_status_fn) (struct dm_target *ti, status_type_t status_type,
75                              unsigned status_flags, char *result, unsigned maxlen);
76
77 typedef int (*dm_message_fn) (struct dm_target *ti, unsigned argc, char **argv);
78
79 typedef int (*dm_ioctl_fn) (struct dm_target *ti, unsigned int cmd,
80                             unsigned long arg);
81
82 typedef int (*dm_merge_fn) (struct dm_target *ti, struct bvec_merge_data *bvm,
83                             struct bio_vec *biovec, int max_size);
84
85 typedef int (*iterate_devices_callout_fn) (struct dm_target *ti,
86                                            struct dm_dev *dev,
87                                            sector_t start, sector_t len,
88                                            void *data);
89
90 typedef int (*dm_iterate_devices_fn) (struct dm_target *ti,
91                                       iterate_devices_callout_fn fn,
92                                       void *data);
93
94 typedef void (*dm_io_hints_fn) (struct dm_target *ti,
95                                 struct queue_limits *limits);
96
97 /*
98  * Returns:
99  *    0: The target can handle the next I/O immediately.
100  *    1: The target can't handle the next I/O immediately.
101  */
102 typedef int (*dm_busy_fn) (struct dm_target *ti);
103
104 void dm_error(const char *message);
105
106 /*
107  * Combine device limits.
108  */
109 int dm_set_device_limits(struct dm_target *ti, struct dm_dev *dev,
110                          sector_t start, sector_t len, void *data);
111
112 struct dm_dev {
113         struct block_device *bdev;
114         fmode_t mode;
115         char name[16];
116 };
117
118 /*
119  * Constructors should call these functions to ensure destination devices
120  * are opened/closed correctly.
121  */
122 int dm_get_device(struct dm_target *ti, const char *path, fmode_t mode,
123                                                  struct dm_dev **result);
124 void dm_put_device(struct dm_target *ti, struct dm_dev *d);
125
126 /*
127  * Information about a target type
128  */
129
130 struct target_type {
131         uint64_t features;
132         const char *name;
133         struct module *module;
134         unsigned version[3];
135         dm_ctr_fn ctr;
136         dm_dtr_fn dtr;
137         dm_map_fn map;
138         dm_map_request_fn map_rq;
139         dm_endio_fn end_io;
140         dm_request_endio_fn rq_end_io;
141         dm_presuspend_fn presuspend;
142         dm_postsuspend_fn postsuspend;
143         dm_preresume_fn preresume;
144         dm_resume_fn resume;
145         dm_status_fn status;
146         dm_message_fn message;
147         dm_ioctl_fn ioctl;
148         dm_merge_fn merge;
149         dm_busy_fn busy;
150         dm_iterate_devices_fn iterate_devices;
151         dm_io_hints_fn io_hints;
152
153         /* For internal device-mapper use. */
154         struct list_head list;
155 };
156
157 /*
158  * Target features
159  */
160
161 /*
162  * Any table that contains an instance of this target must have only one.
163  */
164 #define DM_TARGET_SINGLETON             0x00000001
165 #define dm_target_needs_singleton(type) ((type)->features & DM_TARGET_SINGLETON)
166
167 /*
168  * Indicates that a target does not support read-only devices.
169  */
170 #define DM_TARGET_ALWAYS_WRITEABLE      0x00000002
171 #define dm_target_always_writeable(type) \
172                 ((type)->features & DM_TARGET_ALWAYS_WRITEABLE)
173
174 /*
175  * Any device that contains a table with an instance of this target may never
176  * have tables containing any different target type.
177  */
178 #define DM_TARGET_IMMUTABLE             0x00000004
179 #define dm_target_is_immutable(type)    ((type)->features & DM_TARGET_IMMUTABLE)
180
181 struct dm_target {
182         struct dm_table *table;
183         struct target_type *type;
184
185         /* target limits */
186         sector_t begin;
187         sector_t len;
188
189         /* If non-zero, maximum size of I/O submitted to a target. */
190         uint32_t max_io_len;
191
192         /*
193          * A number of zero-length barrier requests that will be submitted
194          * to the target for the purpose of flushing cache.
195          *
196          * The request number will be placed in union map_info->target_request_nr.
197          * It is a responsibility of the target driver to remap these requests
198          * to the real underlying devices.
199          */
200         unsigned num_flush_requests;
201
202         /*
203          * The number of discard requests that will be submitted to the
204          * target.  map_info->request_nr is used just like num_flush_requests.
205          */
206         unsigned num_discard_requests;
207
208         /*
209          * The number of WRITE SAME requests that will be submitted to the target.
210          */
211         unsigned num_write_same_requests;
212
213         /* target specific data */
214         void *private;
215
216         /* Used to provide an error string from the ctr */
217         char *error;
218
219         /*
220          * Set if this target needs to receive flushes regardless of
221          * whether or not its underlying devices have support.
222          */
223         bool flush_supported:1;
224
225         /*
226          * Set if this target needs to receive discards regardless of
227          * whether or not its underlying devices have support.
228          */
229         bool discards_supported:1;
230
231         /*
232          * Set if the target required discard request to be split
233          * on max_io_len boundary.
234          */
235         bool split_discard_requests:1;
236
237         /*
238          * Set if this target does not return zeroes on discarded blocks.
239          */
240         bool discard_zeroes_data_unsupported:1;
241 };
242
243 /* Each target can link one of these into the table */
244 struct dm_target_callbacks {
245         struct list_head list;
246         int (*congested_fn) (struct dm_target_callbacks *, int);
247 };
248
249 int dm_register_target(struct target_type *t);
250 void dm_unregister_target(struct target_type *t);
251
252 /*
253  * Target argument parsing.
254  */
255 struct dm_arg_set {
256         unsigned argc;
257         char **argv;
258 };
259
260 /*
261  * The minimum and maximum value of a numeric argument, together with
262  * the error message to use if the number is found to be outside that range.
263  */
264 struct dm_arg {
265         unsigned min;
266         unsigned max;
267         char *error;
268 };
269
270 /*
271  * Validate the next argument, either returning it as *value or, if invalid,
272  * returning -EINVAL and setting *error.
273  */
274 int dm_read_arg(struct dm_arg *arg, struct dm_arg_set *arg_set,
275                 unsigned *value, char **error);
276
277 /*
278  * Process the next argument as the start of a group containing between
279  * arg->min and arg->max further arguments. Either return the size as
280  * *num_args or, if invalid, return -EINVAL and set *error.
281  */
282 int dm_read_arg_group(struct dm_arg *arg, struct dm_arg_set *arg_set,
283                       unsigned *num_args, char **error);
284
285 /*
286  * Return the current argument and shift to the next.
287  */
288 const char *dm_shift_arg(struct dm_arg_set *as);
289
290 /*
291  * Move through num_args arguments.
292  */
293 void dm_consume_args(struct dm_arg_set *as, unsigned num_args);
294
295 /*-----------------------------------------------------------------
296  * Functions for creating and manipulating mapped devices.
297  * Drop the reference with dm_put when you finish with the object.
298  *---------------------------------------------------------------*/
299
300 /*
301  * DM_ANY_MINOR chooses the next available minor number.
302  */
303 #define DM_ANY_MINOR (-1)
304 int dm_create(int minor, struct mapped_device **md);
305
306 /*
307  * Reference counting for md.
308  */
309 struct mapped_device *dm_get_md(dev_t dev);
310 void dm_get(struct mapped_device *md);
311 void dm_put(struct mapped_device *md);
312
313 /*
314  * An arbitrary pointer may be stored alongside a mapped device.
315  */
316 void dm_set_mdptr(struct mapped_device *md, void *ptr);
317 void *dm_get_mdptr(struct mapped_device *md);
318
319 /*
320  * A device can still be used while suspended, but I/O is deferred.
321  */
322 int dm_suspend(struct mapped_device *md, unsigned suspend_flags);
323 int dm_resume(struct mapped_device *md);
324
325 /*
326  * Event functions.
327  */
328 uint32_t dm_get_event_nr(struct mapped_device *md);
329 int dm_wait_event(struct mapped_device *md, int event_nr);
330 uint32_t dm_next_uevent_seq(struct mapped_device *md);
331 void dm_uevent_add(struct mapped_device *md, struct list_head *elist);
332
333 /*
334  * Info functions.
335  */
336 const char *dm_device_name(struct mapped_device *md);
337 int dm_copy_name_and_uuid(struct mapped_device *md, char *name, char *uuid);
338 struct gendisk *dm_disk(struct mapped_device *md);
339 int dm_suspended(struct dm_target *ti);
340 int dm_noflush_suspending(struct dm_target *ti);
341 union map_info *dm_get_mapinfo(struct bio *bio);
342 union map_info *dm_get_rq_mapinfo(struct request *rq);
343
344 /*
345  * Geometry functions.
346  */
347 int dm_get_geometry(struct mapped_device *md, struct hd_geometry *geo);
348 int dm_set_geometry(struct mapped_device *md, struct hd_geometry *geo);
349
350
351 /*-----------------------------------------------------------------
352  * Functions for manipulating device-mapper tables.
353  *---------------------------------------------------------------*/
354
355 /*
356  * First create an empty table.
357  */
358 int dm_table_create(struct dm_table **result, fmode_t mode,
359                     unsigned num_targets, struct mapped_device *md);
360
361 /*
362  * Then call this once for each target.
363  */
364 int dm_table_add_target(struct dm_table *t, const char *type,
365                         sector_t start, sector_t len, char *params);
366
367 /*
368  * Target_ctr should call this if it needs to add any callbacks.
369  */
370 void dm_table_add_target_callbacks(struct dm_table *t, struct dm_target_callbacks *cb);
371
372 /*
373  * Finally call this to make the table ready for use.
374  */
375 int dm_table_complete(struct dm_table *t);
376
377 /*
378  * Target may require that it is never sent I/O larger than len.
379  */
380 int __must_check dm_set_target_max_io_len(struct dm_target *ti, sector_t len);
381
382 /*
383  * Table reference counting.
384  */
385 struct dm_table *dm_get_live_table(struct mapped_device *md);
386 void dm_table_get(struct dm_table *t);
387 void dm_table_put(struct dm_table *t);
388
389 /*
390  * Queries
391  */
392 sector_t dm_table_get_size(struct dm_table *t);
393 unsigned int dm_table_get_num_targets(struct dm_table *t);
394 fmode_t dm_table_get_mode(struct dm_table *t);
395 struct mapped_device *dm_table_get_md(struct dm_table *t);
396
397 /*
398  * Trigger an event.
399  */
400 void dm_table_event(struct dm_table *t);
401
402 /*
403  * The device must be suspended before calling this method.
404  * Returns the previous table, which the caller must destroy.
405  */
406 struct dm_table *dm_swap_table(struct mapped_device *md,
407                                struct dm_table *t);
408
409 /*
410  * A wrapper around vmalloc.
411  */
412 void *dm_vcalloc(unsigned long nmemb, unsigned long elem_size);
413
414 /*-----------------------------------------------------------------
415  * Macros.
416  *---------------------------------------------------------------*/
417 #define DM_NAME "device-mapper"
418
419 #ifdef CONFIG_PRINTK
420 extern struct ratelimit_state dm_ratelimit_state;
421
422 #define dm_ratelimit()  __ratelimit(&dm_ratelimit_state)
423 #else
424 #define dm_ratelimit()  0
425 #endif
426
427 #define DMCRIT(f, arg...) \
428         printk(KERN_CRIT DM_NAME ": " DM_MSG_PREFIX ": " f "\n", ## arg)
429
430 #define DMERR(f, arg...) \
431         printk(KERN_ERR DM_NAME ": " DM_MSG_PREFIX ": " f "\n", ## arg)
432 #define DMERR_LIMIT(f, arg...) \
433         do { \
434                 if (dm_ratelimit())     \
435                         printk(KERN_ERR DM_NAME ": " DM_MSG_PREFIX ": " \
436                                f "\n", ## arg); \
437         } while (0)
438
439 #define DMWARN(f, arg...) \
440         printk(KERN_WARNING DM_NAME ": " DM_MSG_PREFIX ": " f "\n", ## arg)
441 #define DMWARN_LIMIT(f, arg...) \
442         do { \
443                 if (dm_ratelimit())     \
444                         printk(KERN_WARNING DM_NAME ": " DM_MSG_PREFIX ": " \
445                                f "\n", ## arg); \
446         } while (0)
447
448 #define DMINFO(f, arg...) \
449         printk(KERN_INFO DM_NAME ": " DM_MSG_PREFIX ": " f "\n", ## arg)
450 #define DMINFO_LIMIT(f, arg...) \
451         do { \
452                 if (dm_ratelimit())     \
453                         printk(KERN_INFO DM_NAME ": " DM_MSG_PREFIX ": " f \
454                                "\n", ## arg); \
455         } while (0)
456
457 #ifdef CONFIG_DM_DEBUG
458 #  define DMDEBUG(f, arg...) \
459         printk(KERN_DEBUG DM_NAME ": " DM_MSG_PREFIX " DEBUG: " f "\n", ## arg)
460 #  define DMDEBUG_LIMIT(f, arg...) \
461         do { \
462                 if (dm_ratelimit())     \
463                         printk(KERN_DEBUG DM_NAME ": " DM_MSG_PREFIX ": " f \
464                                "\n", ## arg); \
465         } while (0)
466 #else
467 #  define DMDEBUG(f, arg...) do {} while (0)
468 #  define DMDEBUG_LIMIT(f, arg...) do {} while (0)
469 #endif
470
471 #define DMEMIT(x...) sz += ((sz >= maxlen) ? \
472                           0 : scnprintf(result + sz, maxlen - sz, x))
473
474 #define SECTOR_SHIFT 9
475
476 /*
477  * Definitions of return values from target end_io function.
478  */
479 #define DM_ENDIO_INCOMPLETE     1
480 #define DM_ENDIO_REQUEUE        2
481
482 /*
483  * Definitions of return values from target map function.
484  */
485 #define DM_MAPIO_SUBMITTED      0
486 #define DM_MAPIO_REMAPPED       1
487 #define DM_MAPIO_REQUEUE        DM_ENDIO_REQUEUE
488
489 /*
490  * Ceiling(n / sz)
491  */
492 #define dm_div_up(n, sz) (((n) + (sz) - 1) / (sz))
493
494 #define dm_sector_div_up(n, sz) ( \
495 { \
496         sector_t _r = ((n) + (sz) - 1); \
497         sector_div(_r, (sz)); \
498         _r; \
499 } \
500 )
501
502 /*
503  * ceiling(n / size) * size
504  */
505 #define dm_round_up(n, sz) (dm_div_up((n), (sz)) * (sz))
506
507 #define dm_array_too_big(fixed, obj, num) \
508         ((num) > (UINT_MAX - (fixed)) / (obj))
509
510 /*
511  * Sector offset taken relative to the start of the target instead of
512  * relative to the start of the device.
513  */
514 #define dm_target_offset(ti, sector) ((sector) - (ti)->begin)
515
516 static inline sector_t to_sector(unsigned long n)
517 {
518         return (n >> SECTOR_SHIFT);
519 }
520
521 static inline unsigned long to_bytes(sector_t n)
522 {
523         return (n << SECTOR_SHIFT);
524 }
525
526 /*-----------------------------------------------------------------
527  * Helper for block layer and dm core operations
528  *---------------------------------------------------------------*/
529 void dm_dispatch_request(struct request *rq);
530 void dm_requeue_unmapped_request(struct request *rq);
531 void dm_kill_unmapped_request(struct request *rq, int error);
532 int dm_underlying_device_busy(struct request_queue *q);
533
534 #endif  /* _LINUX_DEVICE_MAPPER_H */