bitmap.h
上传用户:szlgq88
上传日期:2009-04-28
资源大小:48287k
文件大小:10k
源码类别:

嵌入式Linux

开发平台:

Unix_Linux

  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. #define BITMAP_MAJOR 3
  9. #define BITMAP_MINOR 39
  10. /*
  11.  * in-memory bitmap:
  12.  *
  13.  * Use 16 bit block counters to track pending writes to each "chunk".
  14.  * The 2 high order bits are special-purpose, the first is a flag indicating
  15.  * whether a resync is needed.  The second is a flag indicating whether a
  16.  * resync is active.
  17.  * This means that the counter is actually 14 bits:
  18.  *
  19.  * +--------+--------+------------------------------------------------+
  20.  * | resync | resync |               counter                          |
  21.  * | needed | active |                                                |
  22.  * |  (0-1) |  (0-1) |              (0-16383)                         |
  23.  * +--------+--------+------------------------------------------------+
  24.  *
  25.  * The "resync needed" bit is set when:
  26.  *    a '1' bit is read from storage at startup.
  27.  *    a write request fails on some drives
  28.  *    a resync is aborted on a chunk with 'resync active' set
  29.  * It is cleared (and resync-active set) when a resync starts across all drives
  30.  * of the chunk.
  31.  *
  32.  *
  33.  * The "resync active" bit is set when:
  34.  *    a resync is started on all drives, and resync_needed is set.
  35.  *       resync_needed will be cleared (as long as resync_active wasn't already set).
  36.  * It is cleared when a resync completes.
  37.  *
  38.  * The counter counts pending write requests, plus the on-disk bit.
  39.  * When the counter is '1' and the resync bits are clear, the on-disk
  40.  * bit can be cleared aswell, thus setting the counter to 0.
  41.  * When we set a bit, or in the counter (to start a write), if the fields is
  42.  * 0, we first set the disk bit and set the counter to 1.
  43.  *
  44.  * If the counter is 0, the on-disk bit is clear and the stipe is clean
  45.  * Anything that dirties the stipe pushes the counter to 2 (at least)
  46.  * and sets the on-disk bit (lazily).
  47.  * If a periodic sweep find the counter at 2, it is decremented to 1.
  48.  * If the sweep find the counter at 1, the on-disk bit is cleared and the
  49.  * counter goes to zero.
  50.  *
  51.  * Also, we'll hijack the "map" pointer itself and use it as two 16 bit block
  52.  * counters as a fallback when "page" memory cannot be allocated:
  53.  *
  54.  * Normal case (page memory allocated):
  55.  *
  56.  *     page pointer (32-bit)
  57.  *
  58.  *     [ ] ------+
  59.  *               |
  60.  *               +-------> [   ][   ]..[   ] (4096 byte page == 2048 counters)
  61.  *                          c1   c2    c2048
  62.  *
  63.  * Hijacked case (page memory allocation failed):
  64.  *
  65.  *     hijacked page pointer (32-bit)
  66.  *
  67.  *     [   ][   ] (no page memory allocated)
  68.  *      counter #1 (16-bit) counter #2 (16-bit)
  69.  *
  70.  */
  71. #ifdef __KERNEL__
  72. #define PAGE_BITS (PAGE_SIZE << 3)
  73. #define PAGE_BIT_SHIFT (PAGE_SHIFT + 3)
  74. typedef __u16 bitmap_counter_t;
  75. #define COUNTER_BITS 16
  76. #define COUNTER_BIT_SHIFT 4
  77. #define COUNTER_BYTE_RATIO (COUNTER_BITS / 8)
  78. #define COUNTER_BYTE_SHIFT (COUNTER_BIT_SHIFT - 3)
  79. #define NEEDED_MASK ((bitmap_counter_t) (1 << (COUNTER_BITS - 1)))
  80. #define RESYNC_MASK ((bitmap_counter_t) (1 << (COUNTER_BITS - 2)))
  81. #define COUNTER_MAX ((bitmap_counter_t) RESYNC_MASK - 1)
  82. #define NEEDED(x) (((bitmap_counter_t) x) & NEEDED_MASK)
  83. #define RESYNC(x) (((bitmap_counter_t) x) & RESYNC_MASK)
  84. #define COUNTER(x) (((bitmap_counter_t) x) & COUNTER_MAX)
  85. /* how many counters per page? */
  86. #define PAGE_COUNTER_RATIO (PAGE_BITS / COUNTER_BITS)
  87. /* same, except a shift value for more efficient bitops */
  88. #define PAGE_COUNTER_SHIFT (PAGE_BIT_SHIFT - COUNTER_BIT_SHIFT)
  89. /* same, except a mask value for more efficient bitops */
  90. #define PAGE_COUNTER_MASK  (PAGE_COUNTER_RATIO - 1)
  91. #define BITMAP_BLOCK_SIZE 512
  92. #define BITMAP_BLOCK_SHIFT 9
  93. /* how many blocks per chunk? (this is variable) */
  94. #define CHUNK_BLOCK_RATIO(bitmap) ((bitmap)->chunksize >> BITMAP_BLOCK_SHIFT)
  95. #define CHUNK_BLOCK_SHIFT(bitmap) ((bitmap)->chunkshift - BITMAP_BLOCK_SHIFT)
  96. #define CHUNK_BLOCK_MASK(bitmap) (CHUNK_BLOCK_RATIO(bitmap) - 1)
  97. /* when hijacked, the counters and bits represent even larger "chunks" */
  98. /* there will be 1024 chunks represented by each counter in the page pointers */
  99. #define PAGEPTR_BLOCK_RATIO(bitmap) 
  100. (CHUNK_BLOCK_RATIO(bitmap) << PAGE_COUNTER_SHIFT >> 1)
  101. #define PAGEPTR_BLOCK_SHIFT(bitmap) 
  102. (CHUNK_BLOCK_SHIFT(bitmap) + PAGE_COUNTER_SHIFT - 1)
  103. #define PAGEPTR_BLOCK_MASK(bitmap) (PAGEPTR_BLOCK_RATIO(bitmap) - 1)
  104. /*
  105.  * on-disk bitmap:
  106.  *
  107.  * Use one bit per "chunk" (block set). We do the disk I/O on the bitmap
  108.  * file a page at a time. There's a superblock at the start of the file.
  109.  */
  110. /* map chunks (bits) to file pages - offset by the size of the superblock */
  111. #define CHUNK_BIT_OFFSET(chunk) ((chunk) + (sizeof(bitmap_super_t) << 3))
  112. #endif
  113. /*
  114.  * bitmap structures:
  115.  */
  116. #define BITMAP_MAGIC 0x6d746962
  117. /* use these for bitmap->flags and bitmap->sb->state bit-fields */
  118. enum bitmap_state {
  119. BITMAP_ACTIVE = 0x001, /* the bitmap is in use */
  120. BITMAP_STALE  = 0x002  /* the bitmap file is out of date or had -EIO */
  121. };
  122. /* the superblock at the front of the bitmap file -- little endian */
  123. typedef struct bitmap_super_s {
  124. __u32 magic;        /*  0  BITMAP_MAGIC */
  125. __u32 version;      /*  4  the bitmap major for now, could change... */
  126. __u8  uuid[16];     /*  8  128 bit uuid - must match md device uuid */
  127. __u64 events;       /* 24  event counter for the bitmap (1)*/
  128. __u64 events_cleared;/*32  event counter when last bit cleared (2) */
  129. __u64 sync_size;    /* 40  the size of the md device's sync range(3) */
  130. __u32 state;        /* 48  bitmap state information */
  131. __u32 chunksize;    /* 52  the bitmap chunk size in bytes */
  132. __u32 daemon_sleep; /* 56  seconds between disk flushes */
  133. __u32 write_behind; /* 60  number of outstanding write-behind writes */
  134. __u8  pad[256 - 64]; /* set to zero */
  135. } bitmap_super_t;
  136. /* notes:
  137.  * (1) This event counter is updated before the eventcounter in the md superblock
  138.  *    When a bitmap is loaded, it is only accepted if this event counter is equal
  139.  *    to, or one greater than, the event counter in the superblock.
  140.  * (2) This event counter is updated when the other one is *if*and*only*if* the
  141.  *    array is not degraded.  As bits are not cleared when the array is degraded,
  142.  *    this represents the last time that any bits were cleared.
  143.  *    If a device is being added that has an event count with this value or
  144.  *    higher, it is accepted as conforming to the bitmap.
  145.  * (3)This is the number of sectors represented by the bitmap, and is the range that
  146.  *    resync happens across.  For raid1 and raid5/6 it is the size of individual
  147.  *    devices.  For raid10 it is the size of the array.
  148.  */
  149. #ifdef __KERNEL__
  150. /* the in-memory bitmap is represented by bitmap_pages */
  151. struct bitmap_page {
  152. /*
  153.  * map points to the actual memory page
  154.  */
  155. char *map;
  156. /*
  157.  * in emergencies (when map cannot be alloced), hijack the map
  158.  * pointer and use it as two counters itself
  159.  */
  160. unsigned int hijacked:1;
  161. /*
  162.  * count of dirty bits on the page
  163.  */
  164. unsigned int  count:31;
  165. };
  166. /* keep track of bitmap file pages that have pending writes on them */
  167. struct page_list {
  168. struct list_head list;
  169. struct page *page;
  170. };
  171. /* the main bitmap structure - one per mddev */
  172. struct bitmap {
  173. struct bitmap_page *bp;
  174. unsigned long pages; /* total number of pages in the bitmap */
  175. unsigned long missing_pages; /* number of pages not yet allocated */
  176. mddev_t *mddev; /* the md device that the bitmap is for */
  177. int counter_bits; /* how many bits per block counter */
  178. /* bitmap chunksize -- how much data does each bit represent? */
  179. unsigned long chunksize;
  180. unsigned long chunkshift; /* chunksize = 2^chunkshift (for bitops) */
  181. unsigned long chunks; /* total number of data chunks for the array */
  182. /* We hold a count on the chunk currently being synced, and drop
  183.  * it when the last block is started.  If the resync is aborted
  184.  * midway, we need to be able to drop that count, so we remember
  185.  * the counted chunk..
  186.  */
  187. unsigned long syncchunk;
  188. __u64 events_cleared;
  189. /* bitmap spinlock */
  190. spinlock_t lock;
  191. long offset; /* offset from superblock if file is NULL */
  192. struct file *file; /* backing disk file */
  193. struct page *sb_page; /* cached copy of the bitmap file superblock */
  194. struct page **filemap; /* list of cache pages for the file */
  195. unsigned long *filemap_attr; /* attributes associated w/ filemap pages */
  196. unsigned long file_pages; /* number of pages in the file */
  197. unsigned long flags;
  198. unsigned long max_write_behind; /* write-behind mode */
  199. atomic_t behind_writes;
  200. /*
  201.  * the bitmap daemon - periodically wakes up and sweeps the bitmap
  202.  * file, cleaning up bits and flushing out pages to disk as necessary
  203.  */
  204. unsigned long daemon_lastrun; /* jiffies of last run */
  205. unsigned long daemon_sleep; /* how many seconds between updates? */
  206. /*
  207.  * bitmap_writeback_daemon waits for file-pages that have been written,
  208.  * as there is no way to get a call-back when a page write completes.
  209.  */
  210. mdk_thread_t *writeback_daemon;
  211. spinlock_t write_lock;
  212. wait_queue_head_t write_wait;
  213. struct list_head complete_pages;
  214. mempool_t *write_pool;
  215. };
  216. /* the bitmap API */
  217. /* these are used only by md/bitmap */
  218. int  bitmap_create(mddev_t *mddev);
  219. void bitmap_flush(mddev_t *mddev);
  220. void bitmap_destroy(mddev_t *mddev);
  221. int  bitmap_active(struct bitmap *bitmap);
  222. char *file_path(struct file *file, char *buf, int count);
  223. void bitmap_print_sb(struct bitmap *bitmap);
  224. int bitmap_update_sb(struct bitmap *bitmap);
  225. int  bitmap_setallbits(struct bitmap *bitmap);
  226. void bitmap_write_all(struct bitmap *bitmap);
  227. /* these are exported */
  228. int bitmap_startwrite(struct bitmap *bitmap, sector_t offset,
  229. unsigned long sectors, int behind);
  230. void bitmap_endwrite(struct bitmap *bitmap, sector_t offset,
  231. unsigned long sectors, int success, int behind);
  232. int bitmap_start_sync(struct bitmap *bitmap, sector_t offset, int *blocks, int degraded);
  233. void bitmap_end_sync(struct bitmap *bitmap, sector_t offset, int *blocks, int aborted);
  234. void bitmap_close_sync(struct bitmap *bitmap);
  235. int bitmap_unplug(struct bitmap *bitmap);
  236. int bitmap_daemon_work(struct bitmap *bitmap);
  237. #endif
  238. #endif