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" |
Alasdair G Kergon | 72d9486 | 2006-06-26 00:27:35 -0700 | [diff] [blame] | 20 | |
Jonathan Brassow | d0d444c7 | 2007-07-12 17:28:42 +0100 | [diff] [blame] | 21 | #define DMERR(f, arg...) \ |
| 22 | printk(KERN_ERR DM_NAME ": " DM_MSG_PREFIX ": " f "\n", ## arg) |
| 23 | #define DMERR_LIMIT(f, arg...) \ |
| 24 | do { \ |
| 25 | if (printk_ratelimit()) \ |
| 26 | printk(KERN_ERR DM_NAME ": " DM_MSG_PREFIX ": " \ |
| 27 | f "\n", ## arg); \ |
| 28 | } while (0) |
| 29 | |
| 30 | #define DMWARN(f, arg...) \ |
| 31 | printk(KERN_WARNING DM_NAME ": " DM_MSG_PREFIX ": " f "\n", ## arg) |
| 32 | #define DMWARN_LIMIT(f, arg...) \ |
| 33 | do { \ |
| 34 | if (printk_ratelimit()) \ |
| 35 | printk(KERN_WARNING DM_NAME ": " DM_MSG_PREFIX ": " \ |
| 36 | f "\n", ## arg); \ |
| 37 | } while (0) |
| 38 | |
| 39 | #define DMINFO(f, arg...) \ |
| 40 | printk(KERN_INFO DM_NAME ": " DM_MSG_PREFIX ": " f "\n", ## arg) |
| 41 | #define DMINFO_LIMIT(f, arg...) \ |
| 42 | do { \ |
| 43 | if (printk_ratelimit()) \ |
| 44 | printk(KERN_INFO DM_NAME ": " DM_MSG_PREFIX ": " f \ |
| 45 | "\n", ## arg); \ |
| 46 | } while (0) |
| 47 | |
Bryn Reeves | cc10920 | 2006-10-03 01:15:35 -0700 | [diff] [blame] | 48 | #ifdef CONFIG_DM_DEBUG |
Jonathan Brassow | d0d444c7 | 2007-07-12 17:28:42 +0100 | [diff] [blame] | 49 | # define DMDEBUG(f, arg...) \ |
| 50 | printk(KERN_DEBUG DM_NAME ": " DM_MSG_PREFIX " DEBUG: " f "\n", ## arg) |
| 51 | # define DMDEBUG_LIMIT(f, arg...) \ |
| 52 | do { \ |
| 53 | if (printk_ratelimit()) \ |
| 54 | printk(KERN_DEBUG DM_NAME ": " DM_MSG_PREFIX ": " f \ |
| 55 | "\n", ## arg); \ |
| 56 | } while (0) |
Bryn Reeves | cc10920 | 2006-10-03 01:15:35 -0700 | [diff] [blame] | 57 | #else |
| 58 | # define DMDEBUG(f, arg...) do {} while (0) |
Jonathan Brassow | d0d444c7 | 2007-07-12 17:28:42 +0100 | [diff] [blame] | 59 | # define DMDEBUG_LIMIT(f, arg...) do {} while (0) |
Bryn Reeves | cc10920 | 2006-10-03 01:15:35 -0700 | [diff] [blame] | 60 | #endif |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 61 | |
| 62 | #define DMEMIT(x...) sz += ((sz >= maxlen) ? \ |
| 63 | 0 : scnprintf(result + sz, maxlen - sz, x)) |
| 64 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 65 | #define SECTOR_SHIFT 9 |
| 66 | |
| 67 | /* |
Kiyoshi Ueda | 45cbcd7 | 2006-12-08 02:41:05 -0800 | [diff] [blame] | 68 | * Definitions of return values from target end_io function. |
| 69 | */ |
| 70 | #define DM_ENDIO_INCOMPLETE 1 |
Kiyoshi Ueda | 2e93ccc | 2006-12-08 02:41:09 -0800 | [diff] [blame] | 71 | #define DM_ENDIO_REQUEUE 2 |
Kiyoshi Ueda | 45cbcd7 | 2006-12-08 02:41:05 -0800 | [diff] [blame] | 72 | |
| 73 | /* |
| 74 | * Definitions of return values from target map function. |
| 75 | */ |
| 76 | #define DM_MAPIO_SUBMITTED 0 |
| 77 | #define DM_MAPIO_REMAPPED 1 |
Kiyoshi Ueda | 2e93ccc | 2006-12-08 02:41:09 -0800 | [diff] [blame] | 78 | #define DM_MAPIO_REQUEUE DM_ENDIO_REQUEUE |
Kiyoshi Ueda | 45cbcd7 | 2006-12-08 02:41:05 -0800 | [diff] [blame] | 79 | |
| 80 | /* |
Kiyoshi Ueda | a3d77d3 | 2006-12-08 02:41:04 -0800 | [diff] [blame] | 81 | * Suspend feature flags |
| 82 | */ |
| 83 | #define DM_SUSPEND_LOCKFS_FLAG (1 << 0) |
Kiyoshi Ueda | 81fdb09 | 2006-12-08 02:41:07 -0800 | [diff] [blame] | 84 | #define DM_SUSPEND_NOFLUSH_FLAG (1 << 1) |
Kiyoshi Ueda | a3d77d3 | 2006-12-08 02:41:04 -0800 | [diff] [blame] | 85 | |
| 86 | /* |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 87 | * List of devices that a metadevice uses and should open/close. |
| 88 | */ |
| 89 | struct dm_dev { |
| 90 | struct list_head list; |
| 91 | |
| 92 | atomic_t count; |
| 93 | int mode; |
| 94 | struct block_device *bdev; |
| 95 | char name[16]; |
| 96 | }; |
| 97 | |
| 98 | struct dm_table; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 99 | |
| 100 | /*----------------------------------------------------------------- |
Alasdair G Kergon | 17b2f66 | 2006-06-26 00:27:33 -0700 | [diff] [blame] | 101 | * Internal table functions. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 102 | *---------------------------------------------------------------*/ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 103 | void dm_table_event_callback(struct dm_table *t, |
| 104 | void (*fn)(void *), void *context); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 105 | struct dm_target *dm_table_get_target(struct dm_table *t, unsigned int index); |
| 106 | struct dm_target *dm_table_find_target(struct dm_table *t, sector_t sector); |
| 107 | void dm_table_set_restrictions(struct dm_table *t, struct request_queue *q); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 108 | struct list_head *dm_table_get_devices(struct dm_table *t); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 109 | void dm_table_presuspend_targets(struct dm_table *t); |
| 110 | void dm_table_postsuspend_targets(struct dm_table *t); |
Milan Broz | 8757b77 | 2006-10-03 01:15:36 -0700 | [diff] [blame] | 111 | int dm_table_resume_targets(struct dm_table *t); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 112 | int dm_table_any_congested(struct dm_table *t, int bdi_bits); |
| 113 | void dm_table_unplug_all(struct dm_table *t); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 114 | |
Jun'ichi Nomura | 512875b | 2007-12-13 14:15:25 +0000 | [diff] [blame] | 115 | /* |
| 116 | * To check the return value from dm_table_find_target(). |
| 117 | */ |
| 118 | #define dm_target_is_valid(t) ((t)->table) |
| 119 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 120 | /*----------------------------------------------------------------- |
| 121 | * A registry of target types. |
| 122 | *---------------------------------------------------------------*/ |
| 123 | int dm_target_init(void); |
| 124 | void dm_target_exit(void); |
| 125 | struct target_type *dm_get_target_type(const char *name); |
| 126 | void dm_put_target_type(struct target_type *t); |
| 127 | int dm_target_iterate(void (*iter_func)(struct target_type *tt, |
| 128 | void *param), void *param); |
| 129 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 130 | /*----------------------------------------------------------------- |
| 131 | * Useful inlines. |
| 132 | *---------------------------------------------------------------*/ |
| 133 | static inline int array_too_big(unsigned long fixed, unsigned long obj, |
| 134 | unsigned long num) |
| 135 | { |
| 136 | return (num > (ULONG_MAX - fixed) / obj); |
| 137 | } |
| 138 | |
| 139 | /* |
| 140 | * Ceiling(n / sz) |
| 141 | */ |
| 142 | #define dm_div_up(n, sz) (((n) + (sz) - 1) / (sz)) |
| 143 | |
| 144 | #define dm_sector_div_up(n, sz) ( \ |
| 145 | { \ |
| 146 | sector_t _r = ((n) + (sz) - 1); \ |
| 147 | sector_div(_r, (sz)); \ |
| 148 | _r; \ |
| 149 | } \ |
| 150 | ) |
| 151 | |
| 152 | /* |
| 153 | * ceiling(n / size) * size |
| 154 | */ |
| 155 | #define dm_round_up(n, sz) (dm_div_up((n), (sz)) * (sz)) |
| 156 | |
| 157 | static inline sector_t to_sector(unsigned long n) |
| 158 | { |
| 159 | return (n >> 9); |
| 160 | } |
| 161 | |
| 162 | static inline unsigned long to_bytes(sector_t n) |
| 163 | { |
| 164 | return (n << 9); |
| 165 | } |
| 166 | |
| 167 | int dm_split_args(int *argc, char ***argvp, char *input); |
| 168 | |
| 169 | /* |
| 170 | * The device-mapper can be driven through one of two interfaces; |
| 171 | * ioctl or filesystem, depending which patch you have applied. |
| 172 | */ |
| 173 | int dm_interface_init(void); |
| 174 | void dm_interface_exit(void); |
| 175 | |
| 176 | /* |
| 177 | * Targets for linear and striped mappings |
| 178 | */ |
| 179 | int dm_linear_init(void); |
| 180 | void dm_linear_exit(void); |
| 181 | |
| 182 | int dm_stripe_init(void); |
| 183 | void dm_stripe_exit(void); |
| 184 | |
| 185 | void *dm_vcalloc(unsigned long nmemb, unsigned long elem_size); |
| 186 | union map_info *dm_get_mapinfo(struct bio *bio); |
Alasdair G Kergon | 5c6bd75 | 2006-06-26 00:27:34 -0700 | [diff] [blame] | 187 | int dm_open_count(struct mapped_device *md); |
| 188 | int dm_lock_for_deletion(struct mapped_device *md); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 189 | |
Alasdair G Kergon | 69267a3 | 2007-12-13 14:15:57 +0000 | [diff] [blame] | 190 | void dm_kobject_uevent(struct mapped_device *md); |
| 191 | |
Heinz Mauelshagen | 416cd17 | 2008-04-24 21:43:35 +0100 | [diff] [blame] | 192 | /* |
| 193 | * Dirty log |
| 194 | */ |
| 195 | int dm_dirty_log_init(void); |
| 196 | void dm_dirty_log_exit(void); |
| 197 | |
Mikulas Patocka | 945fa4d | 2008-04-24 21:43:49 +0100 | [diff] [blame^] | 198 | int dm_kcopyd_init(void); |
| 199 | void dm_kcopyd_exit(void); |
| 200 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 201 | #endif |