c172371481c7a6dc814950e69b7dcaf47f5e76cd
[linux-2.6.git] / drivers / md / raid5.h
1 #ifndef _RAID5_H
2 #define _RAID5_H
3
4 #include <linux/raid/xor.h>
5
6 /*
7  *
8  * Each stripe contains one buffer per disc.  Each buffer can be in
9  * one of a number of states stored in "flags".  Changes between
10  * these states happen *almost* exclusively under a per-stripe
11  * spinlock.  Some very specific changes can happen in bi_end_io, and
12  * these are not protected by the spin lock.
13  *
14  * The flag bits that are used to represent these states are:
15  *   R5_UPTODATE and R5_LOCKED
16  *
17  * State Empty == !UPTODATE, !LOCK
18  *        We have no data, and there is no active request
19  * State Want == !UPTODATE, LOCK
20  *        A read request is being submitted for this block
21  * State Dirty == UPTODATE, LOCK
22  *        Some new data is in this buffer, and it is being written out
23  * State Clean == UPTODATE, !LOCK
24  *        We have valid data which is the same as on disc
25  *
26  * The possible state transitions are:
27  *
28  *  Empty -> Want   - on read or write to get old data for  parity calc
29  *  Empty -> Dirty  - on compute_parity to satisfy write/sync request.(RECONSTRUCT_WRITE)
30  *  Empty -> Clean  - on compute_block when computing a block for failed drive
31  *  Want  -> Empty  - on failed read
32  *  Want  -> Clean  - on successful completion of read request
33  *  Dirty -> Clean  - on successful completion of write request
34  *  Dirty -> Clean  - on failed write
35  *  Clean -> Dirty  - on compute_parity to satisfy write/sync (RECONSTRUCT or RMW)
36  *
37  * The Want->Empty, Want->Clean, Dirty->Clean, transitions
38  * all happen in b_end_io at interrupt time.
39  * Each sets the Uptodate bit before releasing the Lock bit.
40  * This leaves one multi-stage transition:
41  *    Want->Dirty->Clean
42  * This is safe because thinking that a Clean buffer is actually dirty
43  * will at worst delay some action, and the stripe will be scheduled
44  * for attention after the transition is complete.
45  *
46  * There is one possibility that is not covered by these states.  That
47  * is if one drive has failed and there is a spare being rebuilt.  We
48  * can't distinguish between a clean block that has been generated
49  * from parity calculations, and a clean block that has been
50  * successfully written to the spare ( or to parity when resyncing).
51  * To distingush these states we have a stripe bit STRIPE_INSYNC that
52  * is set whenever a write is scheduled to the spare, or to the parity
53  * disc if there is no spare.  A sync request clears this bit, and
54  * when we find it set with no buffers locked, we know the sync is
55  * complete.
56  *
57  * Buffers for the md device that arrive via make_request are attached
58  * to the appropriate stripe in one of two lists linked on b_reqnext.
59  * One list (bh_read) for read requests, one (bh_write) for write.
60  * There should never be more than one buffer on the two lists
61  * together, but we are not guaranteed of that so we allow for more.
62  *
63  * If a buffer is on the read list when the associated cache buffer is
64  * Uptodate, the data is copied into the read buffer and it's b_end_io
65  * routine is called.  This may happen in the end_request routine only
66  * if the buffer has just successfully been read.  end_request should
67  * remove the buffers from the list and then set the Uptodate bit on
68  * the buffer.  Other threads may do this only if they first check
69  * that the Uptodate bit is set.  Once they have checked that they may
70  * take buffers off the read queue.
71  *
72  * When a buffer on the write list is committed for write it is copied
73  * into the cache buffer, which is then marked dirty, and moved onto a
74  * third list, the written list (bh_written).  Once both the parity
75  * block and the cached buffer are successfully written, any buffer on
76  * a written list can be returned with b_end_io.
77  *
78  * The write list and read list both act as fifos.  The read list is
79  * protected by the device_lock.  The write and written lists are
80  * protected by the stripe lock.  The device_lock, which can be
81  * claimed while the stipe lock is held, is only for list
82  * manipulations and will only be held for a very short time.  It can
83  * be claimed from interrupts.
84  *
85  *
86  * Stripes in the stripe cache can be on one of two lists (or on
87  * neither).  The "inactive_list" contains stripes which are not
88  * currently being used for any request.  They can freely be reused
89  * for another stripe.  The "handle_list" contains stripes that need
90  * to be handled in some way.  Both of these are fifo queues.  Each
91  * stripe is also (potentially) linked to a hash bucket in the hash
92  * table so that it can be found by sector number.  Stripes that are
93  * not hashed must be on the inactive_list, and will normally be at
94  * the front.  All stripes start life this way.
95  *
96  * The inactive_list, handle_list and hash bucket lists are all protected by the
97  * device_lock.
98  *  - stripes on the inactive_list never have their stripe_lock held.
99  *  - stripes have a reference counter. If count==0, they are on a list.
100  *  - If a stripe might need handling, STRIPE_HANDLE is set.
101  *  - When refcount reaches zero, then if STRIPE_HANDLE it is put on
102  *    handle_list else inactive_list
103  *
104  * This, combined with the fact that STRIPE_HANDLE is only ever
105  * cleared while a stripe has a non-zero count means that if the
106  * refcount is 0 and STRIPE_HANDLE is set, then it is on the
107  * handle_list and if recount is 0 and STRIPE_HANDLE is not set, then
108  * the stripe is on inactive_list.
109  *
110  * The possible transitions are:
111  *  activate an unhashed/inactive stripe (get_active_stripe())
112  *     lockdev check-hash unlink-stripe cnt++ clean-stripe hash-stripe unlockdev
113  *  activate a hashed, possibly active stripe (get_active_stripe())
114  *     lockdev check-hash if(!cnt++)unlink-stripe unlockdev
115  *  attach a request to an active stripe (add_stripe_bh())
116  *     lockdev attach-buffer unlockdev
117  *  handle a stripe (handle_stripe())
118  *     lockstripe clrSTRIPE_HANDLE ...
119  *              (lockdev check-buffers unlockdev) ..
120  *              change-state ..
121  *              record io/ops needed unlockstripe schedule io/ops
122  *  release an active stripe (release_stripe())
123  *     lockdev if (!--cnt) { if  STRIPE_HANDLE, add to handle_list else add to inactive-list } unlockdev
124  *
125  * The refcount counts each thread that have activated the stripe,
126  * plus raid5d if it is handling it, plus one for each active request
127  * on a cached buffer, and plus one if the stripe is undergoing stripe
128  * operations.
129  *
130  * Stripe operations are performed outside the stripe lock,
131  * the stripe operations are:
132  * -copying data between the stripe cache and user application buffers
133  * -computing blocks to save a disk access, or to recover a missing block
134  * -updating the parity on a write operation (reconstruct write and
135  *  read-modify-write)
136  * -checking parity correctness
137  * -running i/o to disk
138  * These operations are carried out by raid5_run_ops which uses the async_tx
139  * api to (optionally) offload operations to dedicated hardware engines.
140  * When requesting an operation handle_stripe sets the pending bit for the
141  * operation and increments the count.  raid5_run_ops is then run whenever
142  * the count is non-zero.
143  * There are some critical dependencies between the operations that prevent some
144  * from being requested while another is in flight.
145  * 1/ Parity check operations destroy the in cache version of the parity block,
146  *    so we prevent parity dependent operations like writes and compute_blocks
147  *    from starting while a check is in progress.  Some dma engines can perform
148  *    the check without damaging the parity block, in these cases the parity
149  *    block is re-marked up to date (assuming the check was successful) and is
150  *    not re-read from disk.
151  * 2/ When a write operation is requested we immediately lock the affected
152  *    blocks, and mark them as not up to date.  This causes new read requests
153  *    to be held off, as well as parity checks and compute block operations.
154  * 3/ Once a compute block operation has been requested handle_stripe treats
155  *    that block as if it is up to date.  raid5_run_ops guaruntees that any
156  *    operation that is dependent on the compute block result is initiated after
157  *    the compute block completes.
158  */
159
160 /*
161  * Operations state - intermediate states that are visible outside of sh->lock
162  * In general _idle indicates nothing is running, _run indicates a data
163  * processing operation is active, and _result means the data processing result
164  * is stable and can be acted upon.  For simple operations like biofill and
165  * compute that only have an _idle and _run state they are indicated with
166  * sh->state flags (STRIPE_BIOFILL_RUN and STRIPE_COMPUTE_RUN)
167  */
168 /**
169  * enum check_states - handles syncing / repairing a stripe
170  * @check_state_idle - check operations are quiesced
171  * @check_state_run - check operation is running
172  * @check_state_result - set outside lock when check result is valid
173  * @check_state_compute_run - check failed and we are repairing
174  * @check_state_compute_result - set outside lock when compute result is valid
175  */
176 enum check_states {
177         check_state_idle = 0,
178         check_state_run, /* parity check */
179         check_state_check_result,
180         check_state_compute_run, /* parity repair */
181         check_state_compute_result,
182 };
183
184 /**
185  * enum reconstruct_states - handles writing or expanding a stripe
186  */
187 enum reconstruct_states {
188         reconstruct_state_idle = 0,
189         reconstruct_state_prexor_drain_run,     /* prexor-write */
190         reconstruct_state_drain_run,            /* write */
191         reconstruct_state_run,                  /* expand */
192         reconstruct_state_prexor_drain_result,
193         reconstruct_state_drain_result,
194         reconstruct_state_result,
195 };
196
197 struct stripe_head {
198         struct hlist_node       hash;
199         struct list_head        lru;          /* inactive_list or handle_list */
200         struct raid5_private_data *raid_conf;
201         sector_t                sector;         /* sector of this row */
202         short                   pd_idx;         /* parity disk index */
203         short                   qd_idx;         /* 'Q' disk index for raid6 */
204         short                   ddf_layout;/* use DDF ordering to calculate Q */
205         unsigned long           state;          /* state flags */
206         atomic_t                count;        /* nr of active thread/requests */
207         spinlock_t              lock;
208         int                     bm_seq; /* sequence number for bitmap flushes */
209         int                     disks;          /* disks in stripe */
210         enum check_states       check_state;
211         enum reconstruct_states reconstruct_state;
212         /* stripe_operations
213          * @target - STRIPE_OP_COMPUTE_BLK target
214          */
215         struct stripe_operations {
216                 int                target;
217                 u32                zero_sum_result;
218         } ops;
219         struct r5dev {
220                 struct bio      req;
221                 struct bio_vec  vec;
222                 struct page     *page;
223                 struct bio      *toread, *read, *towrite, *written;
224                 sector_t        sector;                 /* sector of this page */
225                 unsigned long   flags;
226         } dev[1]; /* allocated with extra space depending of RAID geometry */
227 };
228
229 /* stripe_head_state - collects and tracks the dynamic state of a stripe_head
230  *     for handle_stripe.  It is only valid under spin_lock(sh->lock);
231  */
232 struct stripe_head_state {
233         int syncing, expanding, expanded;
234         int locked, uptodate, to_read, to_write, failed, written;
235         int to_fill, compute, req_compute, non_overwrite;
236         int failed_num;
237         unsigned long ops_request;
238 };
239
240 /* r6_state - extra state data only relevant to r6 */
241 struct r6_state {
242         int p_failed, q_failed, qd_idx, failed_num[2];
243 };
244
245 /* Flags */
246 #define R5_UPTODATE     0       /* page contains current data */
247 #define R5_LOCKED       1       /* IO has been submitted on "req" */
248 #define R5_OVERWRITE    2       /* towrite covers whole page */
249 /* and some that are internal to handle_stripe */
250 #define R5_Insync       3       /* rdev && rdev->in_sync at start */
251 #define R5_Wantread     4       /* want to schedule a read */
252 #define R5_Wantwrite    5
253 #define R5_Overlap      7       /* There is a pending overlapping request on this block */
254 #define R5_ReadError    8       /* seen a read error here recently */
255 #define R5_ReWrite      9       /* have tried to over-write the readerror */
256
257 #define R5_Expanded     10      /* This block now has post-expand data */
258 #define R5_Wantcompute  11 /* compute_block in progress treat as
259                                     * uptodate
260                                     */
261 #define R5_Wantfill     12 /* dev->toread contains a bio that needs
262                                     * filling
263                                     */
264 #define R5_Wantdrain    13 /* dev->towrite needs to be drained */
265 /*
266  * Write method
267  */
268 #define RECONSTRUCT_WRITE       1
269 #define READ_MODIFY_WRITE       2
270 /* not a write method, but a compute_parity mode */
271 #define CHECK_PARITY            3
272
273 /*
274  * Stripe state
275  */
276 #define STRIPE_HANDLE           2
277 #define STRIPE_SYNCING          3
278 #define STRIPE_INSYNC           4
279 #define STRIPE_PREREAD_ACTIVE   5
280 #define STRIPE_DELAYED          6
281 #define STRIPE_DEGRADED         7
282 #define STRIPE_BIT_DELAY        8
283 #define STRIPE_EXPANDING        9
284 #define STRIPE_EXPAND_SOURCE    10
285 #define STRIPE_EXPAND_READY     11
286 #define STRIPE_IO_STARTED       12 /* do not count towards 'bypass_count' */
287 #define STRIPE_FULL_WRITE       13 /* all blocks are set to be overwritten */
288 #define STRIPE_BIOFILL_RUN      14
289 #define STRIPE_COMPUTE_RUN      15
290 /*
291  * Operation request flags
292  */
293 #define STRIPE_OP_BIOFILL       0
294 #define STRIPE_OP_COMPUTE_BLK   1
295 #define STRIPE_OP_PREXOR        2
296 #define STRIPE_OP_BIODRAIN      3
297 #define STRIPE_OP_POSTXOR       4
298 #define STRIPE_OP_CHECK 5
299
300 /*
301  * Plugging:
302  *
303  * To improve write throughput, we need to delay the handling of some
304  * stripes until there has been a chance that several write requests
305  * for the one stripe have all been collected.
306  * In particular, any write request that would require pre-reading
307  * is put on a "delayed" queue until there are no stripes currently
308  * in a pre-read phase.  Further, if the "delayed" queue is empty when
309  * a stripe is put on it then we "plug" the queue and do not process it
310  * until an unplug call is made. (the unplug_io_fn() is called).
311  *
312  * When preread is initiated on a stripe, we set PREREAD_ACTIVE and add
313  * it to the count of prereading stripes.
314  * When write is initiated, or the stripe refcnt == 0 (just in case) we
315  * clear the PREREAD_ACTIVE flag and decrement the count
316  * Whenever the 'handle' queue is empty and the device is not plugged, we
317  * move any strips from delayed to handle and clear the DELAYED flag and set
318  * PREREAD_ACTIVE.
319  * In stripe_handle, if we find pre-reading is necessary, we do it if
320  * PREREAD_ACTIVE is set, else we set DELAYED which will send it to the delayed queue.
321  * HANDLE gets cleared if stripe_handle leave nothing locked.
322  */
323
324
325 struct disk_info {
326         mdk_rdev_t      *rdev;
327 };
328
329 struct raid5_private_data {
330         struct hlist_head       *stripe_hashtbl;
331         mddev_t                 *mddev;
332         struct disk_info        *spare;
333         int                     chunk_size, level, algorithm;
334         int                     max_degraded;
335         int                     raid_disks;
336         int                     max_nr_stripes;
337
338         /* used during an expand */
339         sector_t                expand_progress;        /* MaxSector when no expand happening */
340         sector_t                expand_lo; /* from here up to expand_progress it out-of-bounds
341                                             * as we haven't flushed the metadata yet
342                                             */
343         int                     previous_raid_disks;
344
345         struct list_head        handle_list; /* stripes needing handling */
346         struct list_head        hold_list; /* preread ready stripes */
347         struct list_head        delayed_list; /* stripes that have plugged requests */
348         struct list_head        bitmap_list; /* stripes delaying awaiting bitmap update */
349         struct bio              *retry_read_aligned; /* currently retrying aligned bios   */
350         struct bio              *retry_read_aligned_list; /* aligned bios retry list  */
351         atomic_t                preread_active_stripes; /* stripes with scheduled io */
352         atomic_t                active_aligned_reads;
353         atomic_t                pending_full_writes; /* full write backlog */
354         int                     bypass_count; /* bypassed prereads */
355         int                     bypass_threshold; /* preread nice */
356         struct list_head        *last_hold; /* detect hold_list promotions */
357
358         atomic_t                reshape_stripes; /* stripes with pending writes for reshape */
359         /* unfortunately we need two cache names as we temporarily have
360          * two caches.
361          */
362         int                     active_name;
363         char                    cache_name[2][20];
364         struct kmem_cache               *slab_cache; /* for allocating stripes */
365
366         int                     seq_flush, seq_write;
367         int                     quiesce;
368
369         int                     fullsync;  /* set to 1 if a full sync is needed,
370                                             * (fresh device added).
371                                             * Cleared when a sync completes.
372                                             */
373
374         struct page             *spare_page; /* Used when checking P/Q in raid6 */
375
376         /*
377          * Free stripes pool
378          */
379         atomic_t                active_stripes;
380         struct list_head        inactive_list;
381         wait_queue_head_t       wait_for_stripe;
382         wait_queue_head_t       wait_for_overlap;
383         int                     inactive_blocked;       /* release of inactive stripes blocked,
384                                                          * waiting for 25% to be free
385                                                          */
386         int                     pool_size; /* number of disks in stripeheads in pool */
387         spinlock_t              device_lock;
388         struct disk_info        *disks;
389
390         /* When taking over an array from a different personality, we store
391          * the new thread here until we fully activate the array.
392          */
393         struct mdk_thread_s     *thread;
394 };
395
396 typedef struct raid5_private_data raid5_conf_t;
397
398 #define mddev_to_conf(mddev) ((raid5_conf_t *) mddev->private)
399
400 /*
401  * Our supported algorithms
402  */
403 #define ALGORITHM_LEFT_ASYMMETRIC       0 /* Rotating Parity N with Data Restart */
404 #define ALGORITHM_RIGHT_ASYMMETRIC      1 /* Rotating Parity 0 with Data Restart */
405 #define ALGORITHM_LEFT_SYMMETRIC        2 /* Rotating Parity N with Data Continuation */
406 #define ALGORITHM_RIGHT_SYMMETRIC       3 /* Rotating Parity 0 with Data Continuation */
407
408 /* Define non-rotating (raid4) algorithms.  These allow
409  * conversion of raid4 to raid5.
410  */
411 #define ALGORITHM_PARITY_0              4 /* P or P,Q are initial devices */
412 #define ALGORITHM_PARITY_N              5 /* P or P,Q are final devices. */
413
414 /* DDF RAID6 layouts differ from md/raid6 layouts in two ways.
415  * Firstly, the exact positioning of the parity block is slightly
416  * different between the 'LEFT_*' modes of md and the "_N_*" modes
417  * of DDF.
418  * Secondly, or order of datablocks over which the Q syndrome is computed
419  * is different.
420  * Consequently we have different layouts for DDF/raid6 than md/raid6.
421  * These layouts are from the DDFv1.2 spec.
422  * Interestingly DDFv1.2-Errata-A does not specify N_CONTINUE but
423  * leaves RLQ=3 as 'Vendor Specific'
424  */
425
426 #define ALGORITHM_ROTATING_ZERO_RESTART 8 /* DDF PRL=6 RLQ=1 */
427 #define ALGORITHM_ROTATING_N_RESTART    9 /* DDF PRL=6 RLQ=2 */
428 #define ALGORITHM_ROTATING_N_CONTINUE   10 /*DDF PRL=6 RLQ=3 */
429
430
431 /* For every RAID5 algorithm we define a RAID6 algorithm
432  * with exactly the same layout for data and parity, and
433  * with the Q block always on the last device (N-1).
434  * This allows trivial conversion from RAID5 to RAID6
435  */
436 #define ALGORITHM_LEFT_ASYMMETRIC_6     16
437 #define ALGORITHM_RIGHT_ASYMMETRIC_6    17
438 #define ALGORITHM_LEFT_SYMMETRIC_6      18
439 #define ALGORITHM_RIGHT_SYMMETRIC_6     19
440 #define ALGORITHM_PARITY_0_6            20
441 #define ALGORITHM_PARITY_N_6            ALGORITHM_PARITY_N
442
443 static inline int algorithm_valid_raid5(int layout)
444 {
445         return (layout >= 0) &&
446                 (layout <= 5);
447 }
448 static inline int algorithm_valid_raid6(int layout)
449 {
450         return (layout >= 0 && layout <= 5)
451                 ||
452                 (layout == 8 || layout == 10)
453                 ||
454                 (layout >= 16 && layout <= 20);
455 }
456
457 static inline int algorithm_is_DDF(int layout)
458 {
459         return layout >= 8 && layout <= 10;
460 }
461 #endif