drivers/md/dm.h

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