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