NeilBrown | 32a7627 | 2005-06-21 17:17:14 -0700 | [diff] [blame] | 1 | /* |
| 2 | * bitmap.h: Copyright (C) Peter T. Breuer (ptb@ot.uc3m.es) 2003 |
| 3 | * |
| 4 | * additions: Copyright (C) 2003-2004, Paul Clements, SteelEye Technology, Inc. |
| 5 | */ |
| 6 | #ifndef BITMAP_H |
| 7 | #define BITMAP_H 1 |
| 8 | |
NeilBrown | bd926c6 | 2005-11-08 21:39:32 -0800 | [diff] [blame] | 9 | #define BITMAP_MAJOR_LO 3 |
| 10 | /* version 4 insists the bitmap is in little-endian order |
| 11 | * with version 3, it is host-endian which is non-portable |
Goldwyn Rodrigues | 3c462c8 | 2015-08-19 07:35:54 +1000 | [diff] [blame] | 12 | * Version 5 is currently set only for clustered devices |
NeilBrown | bd926c6 | 2005-11-08 21:39:32 -0800 | [diff] [blame] | 13 | */ |
| 14 | #define BITMAP_MAJOR_HI 4 |
Goldwyn Rodrigues | 3c462c8 | 2015-08-19 07:35:54 +1000 | [diff] [blame] | 15 | #define BITMAP_MAJOR_CLUSTERED 5 |
NeilBrown | bd926c6 | 2005-11-08 21:39:32 -0800 | [diff] [blame] | 16 | #define BITMAP_MAJOR_HOSTENDIAN 3 |
| 17 | |
NeilBrown | 32a7627 | 2005-06-21 17:17:14 -0700 | [diff] [blame] | 18 | /* |
| 19 | * in-memory bitmap: |
| 20 | * |
| 21 | * Use 16 bit block counters to track pending writes to each "chunk". |
| 22 | * The 2 high order bits are special-purpose, the first is a flag indicating |
| 23 | * whether a resync is needed. The second is a flag indicating whether a |
| 24 | * resync is active. |
| 25 | * This means that the counter is actually 14 bits: |
| 26 | * |
| 27 | * +--------+--------+------------------------------------------------+ |
| 28 | * | resync | resync | counter | |
| 29 | * | needed | active | | |
| 30 | * | (0-1) | (0-1) | (0-16383) | |
| 31 | * +--------+--------+------------------------------------------------+ |
| 32 | * |
| 33 | * The "resync needed" bit is set when: |
| 34 | * a '1' bit is read from storage at startup. |
| 35 | * a write request fails on some drives |
| 36 | * a resync is aborted on a chunk with 'resync active' set |
| 37 | * It is cleared (and resync-active set) when a resync starts across all drives |
| 38 | * of the chunk. |
| 39 | * |
| 40 | * |
| 41 | * The "resync active" bit is set when: |
| 42 | * a resync is started on all drives, and resync_needed is set. |
| 43 | * resync_needed will be cleared (as long as resync_active wasn't already set). |
| 44 | * It is cleared when a resync completes. |
| 45 | * |
| 46 | * The counter counts pending write requests, plus the on-disk bit. |
| 47 | * When the counter is '1' and the resync bits are clear, the on-disk |
Lucas De Marchi | 25985ed | 2011-03-30 22:57:33 -0300 | [diff] [blame] | 48 | * bit can be cleared as well, thus setting the counter to 0. |
NeilBrown | 32a7627 | 2005-06-21 17:17:14 -0700 | [diff] [blame] | 49 | * When we set a bit, or in the counter (to start a write), if the fields is |
| 50 | * 0, we first set the disk bit and set the counter to 1. |
| 51 | * |
Guoqing Jiang | d85326c | 2016-03-14 17:01:39 +0800 | [diff] [blame] | 52 | * If the counter is 0, the on-disk bit is clear and the stripe is clean |
| 53 | * Anything that dirties the stripe pushes the counter to 2 (at least) |
NeilBrown | 32a7627 | 2005-06-21 17:17:14 -0700 | [diff] [blame] | 54 | * and sets the on-disk bit (lazily). |
| 55 | * If a periodic sweep find the counter at 2, it is decremented to 1. |
| 56 | * If the sweep find the counter at 1, the on-disk bit is cleared and the |
| 57 | * counter goes to zero. |
| 58 | * |
| 59 | * Also, we'll hijack the "map" pointer itself and use it as two 16 bit block |
| 60 | * counters as a fallback when "page" memory cannot be allocated: |
| 61 | * |
| 62 | * Normal case (page memory allocated): |
| 63 | * |
| 64 | * page pointer (32-bit) |
| 65 | * |
| 66 | * [ ] ------+ |
| 67 | * | |
| 68 | * +-------> [ ][ ]..[ ] (4096 byte page == 2048 counters) |
| 69 | * c1 c2 c2048 |
| 70 | * |
| 71 | * Hijacked case (page memory allocation failed): |
| 72 | * |
| 73 | * hijacked page pointer (32-bit) |
| 74 | * |
| 75 | * [ ][ ] (no page memory allocated) |
| 76 | * counter #1 (16-bit) counter #2 (16-bit) |
| 77 | * |
| 78 | */ |
| 79 | |
| 80 | #ifdef __KERNEL__ |
| 81 | |
| 82 | #define PAGE_BITS (PAGE_SIZE << 3) |
| 83 | #define PAGE_BIT_SHIFT (PAGE_SHIFT + 3) |
| 84 | |
| 85 | typedef __u16 bitmap_counter_t; |
| 86 | #define COUNTER_BITS 16 |
| 87 | #define COUNTER_BIT_SHIFT 4 |
NeilBrown | 32a7627 | 2005-06-21 17:17:14 -0700 | [diff] [blame] | 88 | #define COUNTER_BYTE_SHIFT (COUNTER_BIT_SHIFT - 3) |
| 89 | |
| 90 | #define NEEDED_MASK ((bitmap_counter_t) (1 << (COUNTER_BITS - 1))) |
| 91 | #define RESYNC_MASK ((bitmap_counter_t) (1 << (COUNTER_BITS - 2))) |
| 92 | #define COUNTER_MAX ((bitmap_counter_t) RESYNC_MASK - 1) |
| 93 | #define NEEDED(x) (((bitmap_counter_t) x) & NEEDED_MASK) |
| 94 | #define RESYNC(x) (((bitmap_counter_t) x) & RESYNC_MASK) |
| 95 | #define COUNTER(x) (((bitmap_counter_t) x) & COUNTER_MAX) |
| 96 | |
| 97 | /* how many counters per page? */ |
| 98 | #define PAGE_COUNTER_RATIO (PAGE_BITS / COUNTER_BITS) |
| 99 | /* same, except a shift value for more efficient bitops */ |
| 100 | #define PAGE_COUNTER_SHIFT (PAGE_BIT_SHIFT - COUNTER_BIT_SHIFT) |
| 101 | /* same, except a mask value for more efficient bitops */ |
| 102 | #define PAGE_COUNTER_MASK (PAGE_COUNTER_RATIO - 1) |
| 103 | |
NeilBrown | 32a7627 | 2005-06-21 17:17:14 -0700 | [diff] [blame] | 104 | #define BITMAP_BLOCK_SHIFT 9 |
| 105 | |
NeilBrown | 32a7627 | 2005-06-21 17:17:14 -0700 | [diff] [blame] | 106 | #endif |
| 107 | |
| 108 | /* |
| 109 | * bitmap structures: |
| 110 | */ |
| 111 | |
| 112 | #define BITMAP_MAGIC 0x6d746962 |
| 113 | |
| 114 | /* use these for bitmap->flags and bitmap->sb->state bit-fields */ |
| 115 | enum bitmap_state { |
NeilBrown | b405fe9 | 2012-05-22 13:55:15 +1000 | [diff] [blame] | 116 | BITMAP_STALE = 1, /* the bitmap file is out of date or had -EIO */ |
| 117 | BITMAP_WRITE_ERROR = 2, /* A write error has occurred */ |
| 118 | BITMAP_HOSTENDIAN =15, |
NeilBrown | 32a7627 | 2005-06-21 17:17:14 -0700 | [diff] [blame] | 119 | }; |
| 120 | |
| 121 | /* the superblock at the front of the bitmap file -- little endian */ |
| 122 | typedef struct bitmap_super_s { |
NeilBrown | 4f2e639 | 2006-10-21 10:24:09 -0700 | [diff] [blame] | 123 | __le32 magic; /* 0 BITMAP_MAGIC */ |
| 124 | __le32 version; /* 4 the bitmap major for now, could change... */ |
| 125 | __u8 uuid[16]; /* 8 128 bit uuid - must match md device uuid */ |
| 126 | __le64 events; /* 24 event counter for the bitmap (1)*/ |
| 127 | __le64 events_cleared;/*32 event counter when last bit cleared (2) */ |
| 128 | __le64 sync_size; /* 40 the size of the md device's sync range(3) */ |
| 129 | __le32 state; /* 48 bitmap state information */ |
| 130 | __le32 chunksize; /* 52 the bitmap chunk size in bytes */ |
| 131 | __le32 daemon_sleep; /* 56 seconds between disk flushes */ |
| 132 | __le32 write_behind; /* 60 number of outstanding write-behind writes */ |
NeilBrown | 1dff2b8 | 2012-05-22 13:55:34 +1000 | [diff] [blame] | 133 | __le32 sectors_reserved; /* 64 number of 512-byte sectors that are |
| 134 | * reserved for the bitmap. */ |
Goldwyn Rodrigues | 183bdf5 | 2014-03-07 10:30:43 -0600 | [diff] [blame] | 135 | __le32 nodes; /* 68 the maximum number of nodes in cluster. */ |
Goldwyn Rodrigues | cf921cc | 2014-03-30 00:42:49 -0500 | [diff] [blame] | 136 | __u8 cluster_name[64]; /* 72 cluster name to which this md belongs */ |
| 137 | __u8 pad[256 - 136]; /* set to zero */ |
NeilBrown | 32a7627 | 2005-06-21 17:17:14 -0700 | [diff] [blame] | 138 | } bitmap_super_t; |
| 139 | |
| 140 | /* notes: |
| 141 | * (1) This event counter is updated before the eventcounter in the md superblock |
| 142 | * When a bitmap is loaded, it is only accepted if this event counter is equal |
| 143 | * to, or one greater than, the event counter in the superblock. |
| 144 | * (2) This event counter is updated when the other one is *if*and*only*if* the |
| 145 | * array is not degraded. As bits are not cleared when the array is degraded, |
| 146 | * this represents the last time that any bits were cleared. |
| 147 | * If a device is being added that has an event count with this value or |
| 148 | * higher, it is accepted as conforming to the bitmap. |
| 149 | * (3)This is the number of sectors represented by the bitmap, and is the range that |
| 150 | * resync happens across. For raid1 and raid5/6 it is the size of individual |
| 151 | * devices. For raid10 it is the size of the array. |
| 152 | */ |
| 153 | |
| 154 | #ifdef __KERNEL__ |
| 155 | |
| 156 | /* the in-memory bitmap is represented by bitmap_pages */ |
| 157 | struct bitmap_page { |
| 158 | /* |
| 159 | * map points to the actual memory page |
| 160 | */ |
| 161 | char *map; |
| 162 | /* |
| 163 | * in emergencies (when map cannot be alloced), hijack the map |
| 164 | * pointer and use it as two counters itself |
| 165 | */ |
| 166 | unsigned int hijacked:1; |
| 167 | /* |
NeilBrown | bf07bb7 | 2012-05-22 13:55:06 +1000 | [diff] [blame] | 168 | * If any counter in this page is '1' or '2' - and so could be |
| 169 | * cleared then that page is marked as 'pending' |
| 170 | */ |
| 171 | unsigned int pending:1; |
| 172 | /* |
NeilBrown | 32a7627 | 2005-06-21 17:17:14 -0700 | [diff] [blame] | 173 | * count of dirty bits on the page |
| 174 | */ |
NeilBrown | bf07bb7 | 2012-05-22 13:55:06 +1000 | [diff] [blame] | 175 | unsigned int count:30; |
NeilBrown | 32a7627 | 2005-06-21 17:17:14 -0700 | [diff] [blame] | 176 | }; |
| 177 | |
NeilBrown | 32a7627 | 2005-06-21 17:17:14 -0700 | [diff] [blame] | 178 | /* the main bitmap structure - one per mddev */ |
| 179 | struct bitmap { |
NeilBrown | 40cffcc | 2012-05-22 13:55:24 +1000 | [diff] [blame] | 180 | |
| 181 | struct bitmap_counts { |
| 182 | spinlock_t lock; |
| 183 | struct bitmap_page *bp; |
| 184 | unsigned long pages; /* total number of pages |
| 185 | * in the bitmap */ |
| 186 | unsigned long missing_pages; /* number of pages |
| 187 | * not yet allocated */ |
| 188 | unsigned long chunkshift; /* chunksize = 2^chunkshift |
| 189 | * (for bitops) */ |
| 190 | unsigned long chunks; /* Total number of data |
| 191 | * chunks for the array */ |
| 192 | } counts; |
NeilBrown | 32a7627 | 2005-06-21 17:17:14 -0700 | [diff] [blame] | 193 | |
NeilBrown | fd01b88 | 2011-10-11 16:47:53 +1100 | [diff] [blame] | 194 | struct mddev *mddev; /* the md device that the bitmap is for */ |
NeilBrown | 32a7627 | 2005-06-21 17:17:14 -0700 | [diff] [blame] | 195 | |
NeilBrown | 32a7627 | 2005-06-21 17:17:14 -0700 | [diff] [blame] | 196 | __u64 events_cleared; |
Neil Brown | a0da84f | 2008-06-28 08:31:22 +1000 | [diff] [blame] | 197 | int need_sync; |
NeilBrown | 32a7627 | 2005-06-21 17:17:14 -0700 | [diff] [blame] | 198 | |
NeilBrown | 1ec885c | 2012-05-22 13:55:10 +1000 | [diff] [blame] | 199 | struct bitmap_storage { |
| 200 | struct file *file; /* backing disk file */ |
| 201 | struct page *sb_page; /* cached copy of the bitmap |
| 202 | * file superblock */ |
| 203 | struct page **filemap; /* list of cache pages for |
| 204 | * the file */ |
| 205 | unsigned long *filemap_attr; /* attributes associated |
| 206 | * w/ filemap pages */ |
| 207 | unsigned long file_pages; /* number of pages in the file*/ |
NeilBrown | 9b1215c | 2012-05-22 13:55:11 +1000 | [diff] [blame] | 208 | unsigned long bytes; /* total bytes in the bitmap */ |
NeilBrown | 1ec885c | 2012-05-22 13:55:10 +1000 | [diff] [blame] | 209 | } storage; |
NeilBrown | 32a7627 | 2005-06-21 17:17:14 -0700 | [diff] [blame] | 210 | |
| 211 | unsigned long flags; |
| 212 | |
NeilBrown | 8311c29 | 2008-03-04 14:29:30 -0800 | [diff] [blame] | 213 | int allclean; |
| 214 | |
NeilBrown | 4b6d287 | 2005-09-09 16:23:47 -0700 | [diff] [blame] | 215 | atomic_t behind_writes; |
Paul Clements | 696fcd5 | 2010-03-08 16:02:37 +1100 | [diff] [blame] | 216 | unsigned long behind_writes_used; /* highest actual value at runtime */ |
NeilBrown | 4b6d287 | 2005-09-09 16:23:47 -0700 | [diff] [blame] | 217 | |
NeilBrown | 32a7627 | 2005-06-21 17:17:14 -0700 | [diff] [blame] | 218 | /* |
| 219 | * the bitmap daemon - periodically wakes up and sweeps the bitmap |
| 220 | * file, cleaning up bits and flushing out pages to disk as necessary |
| 221 | */ |
| 222 | unsigned long daemon_lastrun; /* jiffies of last run */ |
NeilBrown | b47490c | 2008-02-06 01:39:50 -0800 | [diff] [blame] | 223 | unsigned long last_end_sync; /* when we lasted called end_sync to |
| 224 | * update bitmap with resync progress */ |
NeilBrown | 32a7627 | 2005-06-21 17:17:14 -0700 | [diff] [blame] | 225 | |
NeilBrown | d785a06 | 2006-06-26 00:27:48 -0700 | [diff] [blame] | 226 | atomic_t pending_writes; /* pending writes to the bitmap file */ |
| 227 | wait_queue_head_t write_wait; |
Neil Brown | da6e1a3 | 2007-02-08 14:20:37 -0800 | [diff] [blame] | 228 | wait_queue_head_t overflow_wait; |
NeilBrown | e555190 | 2010-03-31 11:21:44 +1100 | [diff] [blame] | 229 | wait_queue_head_t behind_wait; |
NeilBrown | d785a06 | 2006-06-26 00:27:48 -0700 | [diff] [blame] | 230 | |
Tejun Heo | 324a56e | 2013-12-11 14:11:53 -0500 | [diff] [blame] | 231 | struct kernfs_node *sysfs_can_clear; |
Goldwyn Rodrigues | b97e9257 | 2014-06-06 11:50:56 -0500 | [diff] [blame] | 232 | int cluster_slot; /* Slot offset for clustered env */ |
NeilBrown | 32a7627 | 2005-06-21 17:17:14 -0700 | [diff] [blame] | 233 | }; |
| 234 | |
| 235 | /* the bitmap API */ |
| 236 | |
| 237 | /* these are used only by md/bitmap */ |
Goldwyn Rodrigues | f9209a3 | 2014-06-06 12:43:49 -0500 | [diff] [blame] | 238 | struct bitmap *bitmap_create(struct mddev *mddev, int slot); |
NeilBrown | fd01b88 | 2011-10-11 16:47:53 +1100 | [diff] [blame] | 239 | int bitmap_load(struct mddev *mddev); |
| 240 | void bitmap_flush(struct mddev *mddev); |
| 241 | void bitmap_destroy(struct mddev *mddev); |
NeilBrown | 32a7627 | 2005-06-21 17:17:14 -0700 | [diff] [blame] | 242 | |
NeilBrown | 32a7627 | 2005-06-21 17:17:14 -0700 | [diff] [blame] | 243 | void bitmap_print_sb(struct bitmap *bitmap); |
NeilBrown | 4ad1366 | 2007-07-17 04:06:13 -0700 | [diff] [blame] | 244 | void bitmap_update_sb(struct bitmap *bitmap); |
NeilBrown | 5714896 | 2012-03-19 12:46:40 +1100 | [diff] [blame] | 245 | void bitmap_status(struct seq_file *seq, struct bitmap *bitmap); |
NeilBrown | 32a7627 | 2005-06-21 17:17:14 -0700 | [diff] [blame] | 246 | |
| 247 | int bitmap_setallbits(struct bitmap *bitmap); |
NeilBrown | a654b9d8 | 2005-06-21 17:17:27 -0700 | [diff] [blame] | 248 | void bitmap_write_all(struct bitmap *bitmap); |
NeilBrown | 32a7627 | 2005-06-21 17:17:14 -0700 | [diff] [blame] | 249 | |
Paul Clements | 9b1d1da | 2006-10-03 01:15:49 -0700 | [diff] [blame] | 250 | void bitmap_dirty_bits(struct bitmap *bitmap, unsigned long s, unsigned long e); |
| 251 | |
NeilBrown | 32a7627 | 2005-06-21 17:17:14 -0700 | [diff] [blame] | 252 | /* these are exported */ |
NeilBrown | 4b6d287 | 2005-09-09 16:23:47 -0700 | [diff] [blame] | 253 | int bitmap_startwrite(struct bitmap *bitmap, sector_t offset, |
| 254 | unsigned long sectors, int behind); |
| 255 | void bitmap_endwrite(struct bitmap *bitmap, sector_t offset, |
| 256 | unsigned long sectors, int success, int behind); |
NeilBrown | 57dab0b | 2010-10-19 10:03:39 +1100 | [diff] [blame] | 257 | int bitmap_start_sync(struct bitmap *bitmap, sector_t offset, sector_t *blocks, int degraded); |
| 258 | void bitmap_end_sync(struct bitmap *bitmap, sector_t offset, sector_t *blocks, int aborted); |
NeilBrown | 32a7627 | 2005-06-21 17:17:14 -0700 | [diff] [blame] | 259 | void bitmap_close_sync(struct bitmap *bitmap); |
Goldwyn Rodrigues | c40f341 | 2015-08-19 08:14:42 +1000 | [diff] [blame] | 260 | void bitmap_cond_end_sync(struct bitmap *bitmap, sector_t sector, bool force); |
NeilBrown | 32a7627 | 2005-06-21 17:17:14 -0700 | [diff] [blame] | 261 | |
NeilBrown | 4ad1366 | 2007-07-17 04:06:13 -0700 | [diff] [blame] | 262 | void bitmap_unplug(struct bitmap *bitmap); |
NeilBrown | fd01b88 | 2011-10-11 16:47:53 +1100 | [diff] [blame] | 263 | void bitmap_daemon_work(struct mddev *mddev); |
NeilBrown | d60b479 | 2012-05-22 13:55:25 +1000 | [diff] [blame] | 264 | |
| 265 | int bitmap_resize(struct bitmap *bitmap, sector_t blocks, |
| 266 | int chunksize, int init); |
Goldwyn Rodrigues | 11dd35d | 2014-06-07 00:36:26 -0500 | [diff] [blame] | 267 | int bitmap_copy_from_slot(struct mddev *mddev, int slot, |
Goldwyn Rodrigues | 97f6cd3 | 2015-04-14 10:45:42 -0500 | [diff] [blame] | 268 | sector_t *lo, sector_t *hi, bool clear_bits); |
NeilBrown | 32a7627 | 2005-06-21 17:17:14 -0700 | [diff] [blame] | 269 | #endif |
| 270 | |
| 271 | #endif |