drivers/md/raid5.h

   1 #ifndef _RAID5_H
   2 #define _RAID5_H
   3
   4 #include <linux/raid/xor.h>
   5 #include <linux/dmaengine.h>
   6
   7 /*
   8  *
   9  * Each stripe contains one buffer per device.  Each buffer can be in
  10  * one of a number of states stored in "flags".  Changes between
  11  * these states happen *almost* exclusively under the protection of the
  12  * STRIPE_ACTIVE flag.  Some very specific changes can happen in bi_end_io, and
  13  * these are not protected by STRIPE_ACTIVE.
  14  *
  15  * The flag bits that are used to represent these states are:
  16  *   R5_UPTODATE and R5_LOCKED
  17  *
  18  * State Empty == !UPTODATE, !LOCK
  19  *        We have no data, and there is no active request
  20  * State Want == !UPTODATE, LOCK
  21  *        A read request is being submitted for this block
  22  * State Dirty == UPTODATE, LOCK
  23  *        Some new data is in this buffer, and it is being written out
  24  * State Clean == UPTODATE, !LOCK
  25  *        We have valid data which is the same as on disc
  26  *
  27  * The possible state transitions are:
  28  *
  29  *  Empty -> Want   - on read or write to get old data for  parity calc
  30  *  Empty -> Dirty  - on compute_parity to satisfy write/sync request.
  31  *  Empty -> Clean  - on compute_block when computing a block for failed drive
  32  *  Want  -> Empty  - on failed read
  33  *  Want  -> Clean  - on successful completion of read request
  34  *  Dirty -> Clean  - on successful completion of write request
  35  *  Dirty -> Clean  - on failed write
  36  *  Clean -> Dirty  - on compute_parity to satisfy write/sync (RECONSTRUCT or RMW)
  37  *
  38  * The Want->Empty, Want->Clean, Dirty->Clean, transitions
  39  * all happen in b_end_io at interrupt time.
  40  * Each sets the Uptodate bit before releasing the Lock bit.
  41  * This leaves one multi-stage transition:
  42  *    Want->Dirty->Clean
  43  * This is safe because thinking that a Clean buffer is actually dirty
  44  * will at worst delay some action, and the stripe will be scheduled
  45  * for attention after the transition is complete.
  46  *
  47  * There is one possibility that is not covered by these states.  That
  48  * is if one drive has failed and there is a spare being rebuilt.  We
  49  * can't distinguish between a clean block that has been generated
  50  * from parity calculations, and a clean block that has been
  51  * successfully written to the spare ( or to parity when resyncing).
  52  * To distinguish these states we have a stripe bit STRIPE_INSYNC that
  53  * is set whenever a write is scheduled to the spare, or to the parity
  54  * disc if there is no spare.  A sync request clears this bit, and
  55  * when we find it set with no buffers locked, we know the sync is
  56  * complete.
  57  *
  58  * Buffers for the md device that arrive via make_request are attached
  59  * to the appropriate stripe in one of two lists linked on b_reqnext.
  60  * One list (bh_read) for read requests, one (bh_write) for write.
  61  * There should never be more than one buffer on the two lists
  62  * together, but we are not guaranteed of that so we allow for more.
  63  *
  64  * If a buffer is on the read list when the associated cache buffer is
  65  * Uptodate, the data is copied into the read buffer and it's b_end_io
  66  * routine is called.  This may happen in the end_request routine only
  67  * if the buffer has just successfully been read.  end_request should
  68  * remove the buffers from the list and then set the Uptodate bit on
  69  * the buffer.  Other threads may do this only if they first check
  70  * that the Uptodate bit is set.  Once they have checked that they may
  71  * take buffers off the read queue.
  72  *
  73  * When a buffer on the write list is committed for write it is copied
  74  * into the cache buffer, which is then marked dirty, and moved onto a
  75  * third list, the written list (bh_written).  Once both the parity
  76  * block and the cached buffer are successfully written, any buffer on
  77  * a written list can be returned with b_end_io.
  78  *
  79  * The write list and read list both act as fifos.  The read list,
  80  * write list and written list are protected by the device_lock.
  81  * The device_lock is only for list manipulations and will only be
  82  * held for a very short time.  It can be claimed from interrupts.
  83  *
  84  *
  85  * Stripes in the stripe cache can be on one of two lists (or on
  86  * neither).  The "inactive_list" contains stripes which are not
  87  * currently being used for any request.  They can freely be reused
  88  * for another stripe.  The "handle_list" contains stripes that need
  89  * to be handled in some way.  Both of these are fifo queues.  Each
  90  * stripe is also (potentially) linked to a hash bucket in the hash
  91  * table so that it can be found by sector number.  Stripes that are
  92  * not hashed must be on the inactive_list, and will normally be at
  93  * the front.  All stripes start life this way.
  94  *
  95  * The inactive_list, handle_list and hash bucket lists are all protected by the
  96  * device_lock.
  97  *  - stripes have a reference counter. If count==0, they are on a list.
  98  *  - If a stripe might need handling, STRIPE_HANDLE is set.
  99  *  - When refcount reaches zero, then if STRIPE_HANDLE it is put on
 100  *    handle_list else inactive_list
 101  *
 102  * This, combined with the fact that STRIPE_HANDLE is only ever
 103  * cleared while a stripe has a non-zero count means that if the
 104  * refcount is 0 and STRIPE_HANDLE is set, then it is on the
 105  * handle_list and if recount is 0 and STRIPE_HANDLE is not set, then
 106  * the stripe is on inactive_list.
 107  *
 108  * The possible transitions are:
 109  *  activate an unhashed/inactive stripe (get_active_stripe())
 110  *     lockdev check-hash unlink-stripe cnt++ clean-stripe hash-stripe unlockdev
 111  *  activate a hashed, possibly active stripe (get_active_stripe())
 112  *     lockdev check-hash if(!cnt++)unlink-stripe unlockdev
 113  *  attach a request to an active stripe (add_stripe_bh())
 114  *     lockdev attach-buffer unlockdev
 115  *  handle a stripe (handle_stripe())
 116  *     setSTRIPE_ACTIVE,  clrSTRIPE_HANDLE ...
 117  *              (lockdev check-buffers unlockdev) ..
 118  *              change-state ..
 119  *              record io/ops needed clearSTRIPE_ACTIVE schedule io/ops
 120  *  release an active stripe (release_stripe())
 121  *     lockdev if (!--cnt) { if  STRIPE_HANDLE, add to handle_list else add to inactive-list } unlockdev
 122  *
 123  * The refcount counts each thread that have activated the stripe,
 124  * plus raid5d if it is handling it, plus one for each active request
 125  * on a cached buffer, and plus one if the stripe is undergoing stripe
 126  * operations.
 127  *
 128  * The stripe operations are:
 129  * -copying data between the stripe cache and user application buffers
 130  * -computing blocks to save a disk access, or to recover a missing block
 131  * -updating the parity on a write operation (reconstruct write and
 132  *  read-modify-write)
 133  * -checking parity correctness
 134  * -running i/o to disk
 135  * These operations are carried out by raid5_run_ops which uses the async_tx
 136  * api to (optionally) offload operations to dedicated hardware engines.
 137  * When requesting an operation handle_stripe sets the pending bit for the
 138  * operation and increments the count.  raid5_run_ops is then run whenever
 139  * the count is non-zero.
 140  * There are some critical dependencies between the operations that prevent some
 141  * from being requested while another is in flight.
 142  * 1/ Parity check operations destroy the in cache version of the parity block,
 143  *    so we prevent parity dependent operations like writes and compute_blocks
 144  *    from starting while a check is in progress.  Some dma engines can perform
 145  *    the check without damaging the parity block, in these cases the parity
 146  *    block is re-marked up to date (assuming the check was successful) and is
 147  *    not re-read from disk.
 148  * 2/ When a write operation is requested we immediately lock the affected
 149  *    blocks, and mark them as not up to date.  This causes new read requests
 150  *    to be held off, as well as parity checks and compute block operations.
 151  * 3/ Once a compute block operation has been requested handle_stripe treats
 152  *    that block as if it is up to date.  raid5_run_ops guaruntees that any
 153  *    operation that is dependent on the compute block result is initiated after
 154  *    the compute block completes.
 155  */
 156
 157 /*
 158  * Operations state - intermediate states that are visible outside of
 159  *   STRIPE_ACTIVE.
 160  * In general _idle indicates nothing is running, _run indicates a data
 161  * processing operation is active, and _result means the data processing result
 162  * is stable and can be acted upon.  For simple operations like biofill and
 163  * compute that only have an _idle and _run state they are indicated with
 164  * sh->state flags (STRIPE_BIOFILL_RUN and STRIPE_COMPUTE_RUN)
 165  */
 166 /**
 167  * enum check_states - handles syncing / repairing a stripe
 168  * @check_state_idle - check operations are quiesced
 169  * @check_state_run - check operation is running
 170  * @check_state_result - set outside lock when check result is valid
 171  * @check_state_compute_run - check failed and we are repairing
 172  * @check_state_compute_result - set outside lock when compute result is valid
 173  */
 174 enum check_states {
 175         check_state_idle = 0,
 176         check_state_run, /* xor parity check */
 177         check_state_run_q, /* q-parity check */
 178         check_state_run_pq, /* pq dual 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 llist_node       release_list;
 201         struct r5conf           *raid_conf;
 202         short                   generation;     /* increments with every
 203                                                  * reshape */
 204         sector_t                sector;         /* sector of this row */
 205         short                   pd_idx;         /* parity disk index */
 206         short                   qd_idx;         /* 'Q' disk index for raid6 */
 207         short                   ddf_layout;/* use DDF ordering to calculate Q */
 208         short                   hash_lock_index;
 209         unsigned long           state;          /* state flags */
 210         atomic_t                count;        /* nr of active thread/requests */
 211         int                     bm_seq; /* sequence number for bitmap flushes */
 212         int                     disks;          /* disks in stripe */
 213         int                     overwrite_disks; /* total overwrite disks in stripe,
 214                                                   * this is only checked when stripe
 215                                                   * has STRIPE_BATCH_READY
 216                                                   */
 217         enum check_states       check_state;
 218         enum reconstruct_states reconstruct_state;
 219         spinlock_t              stripe_lock;
 220         int                     cpu;
 221         struct r5worker_group   *group;
 222
 223         struct stripe_head      *batch_head; /* protected by stripe lock */
 224         spinlock_t              batch_lock; /* only header's lock is useful */
 225         struct list_head        batch_list; /* protected by head's batch lock*/
 226
 227         struct r5l_io_unit      *log_io;
 228         struct list_head        log_list;
 229         sector_t                log_start; /* first meta block on the journal */
 230         struct list_head        r5c; /* for r5c_cache->stripe_in_journal */
 231         /**
 232          * struct stripe_operations
 233          * @target - STRIPE_OP_COMPUTE_BLK target
 234          * @target2 - 2nd compute target in the raid6 case
 235          * @zero_sum_result - P and Q verification flags
 236          * @request - async service request flags for raid_run_ops
 237          */
 238         struct stripe_operations {
 239                 int                  target, target2;
 240                 enum sum_check_flags zero_sum_result;
 241         } ops;
 242         struct r5dev {
 243                 /* rreq and rvec are used for the replacement device when
 244                  * writing data to both devices.
 245                  */
 246                 struct bio      req, rreq;
 247                 struct bio_vec  vec, rvec;
 248                 struct page     *page, *orig_page;
 249                 struct bio      *toread, *read, *towrite, *written;
 250                 sector_t        sector;                 /* sector of this page */
 251                 unsigned long   flags;
 252                 u32             log_checksum;
 253         } dev[1]; /* allocated with extra space depending of RAID geometry */
 254 };
 255
 256 /* stripe_head_state - collects and tracks the dynamic state of a stripe_head
 257  *     for handle_stripe.
 258  */
 259 struct stripe_head_state {
 260         /* 'syncing' means that we need to read all devices, either
 261          * to check/correct parity, or to reconstruct a missing device.
 262          * 'replacing' means we are replacing one or more drives and
 263          * the source is valid at this point so we don't need to
 264          * read all devices, just the replacement targets.
 265          */
 266         int syncing, expanding, expanded, replacing;
 267         int locked, uptodate, to_read, to_write, failed, written;
 268         int to_fill, compute, req_compute, non_overwrite;
 269         int injournal, just_cached;
 270         int failed_num[2];
 271         int p_failed, q_failed;
 272         int dec_preread_active;
 273         unsigned long ops_request;
 274
 275         struct bio_list return_bi;
 276         struct md_rdev *blocked_rdev;
 277         int handle_bad_blocks;
 278         int log_failed;
 279         int waiting_extra_page;
 280 };
 281
 282 /* Flags for struct r5dev.flags */
 283 enum r5dev_flags {
 284         R5_UPTODATE,    /* page contains current data */
 285         R5_LOCKED,      /* IO has been submitted on "req" */
 286         R5_DOUBLE_LOCKED,/* Cannot clear R5_LOCKED until 2 writes complete */
 287         R5_OVERWRITE,   /* towrite covers whole page */
 288 /* and some that are internal to handle_stripe */
 289         R5_Insync,      /* rdev && rdev->in_sync at start */
 290         R5_Wantread,    /* want to schedule a read */
 291         R5_Wantwrite,
 292         R5_Overlap,     /* There is a pending overlapping request
 293                          * on this block */
 294         R5_ReadNoMerge, /* prevent bio from merging in block-layer */
 295         R5_ReadError,   /* seen a read error here recently */
 296         R5_ReWrite,     /* have tried to over-write the readerror */
 297
 298         R5_Expanded,    /* This block now has post-expand data */
 299         R5_Wantcompute, /* compute_block in progress treat as
 300                          * uptodate
 301                          */
 302         R5_Wantfill,    /* dev->toread contains a bio that needs
 303                          * filling
 304                          */
 305         R5_Wantdrain,   /* dev->towrite needs to be drained */
 306         R5_WantFUA,     /* Write should be FUA */
 307         R5_SyncIO,      /* The IO is sync */
 308         R5_WriteError,  /* got a write error - need to record it */
 309         R5_MadeGood,    /* A bad block has been fixed by writing to it */
 310         R5_ReadRepl,    /* Will/did read from replacement rather than orig */
 311         R5_MadeGoodRepl,/* A bad block on the replacement device has been
 312                          * fixed by writing to it */
 313         R5_NeedReplace, /* This device has a replacement which is not
 314                          * up-to-date at this stripe. */
 315         R5_WantReplace, /* We need to update the replacement, we have read
 316                          * data in, and now is a good time to write it out.
 317                          */
 318         R5_Discard,     /* Discard the stripe */
 319         R5_SkipCopy,    /* Don't copy data from bio to stripe cache */
 320         R5_InJournal,   /* data being written is in the journal device.
 321                          * if R5_InJournal is set for parity pd_idx, all the
 322                          * data and parity being written are in the journal
 323                          * device
 324                          */
 325         R5_OrigPageUPTDODATE,   /* with write back cache, we read old data into
 326                                  * dev->orig_page for prexor. When this flag is
 327                                  * set, orig_page contains latest data in the
 328                                  * raid disk.
 329                                  */
 330 };
 331
 332 /*
 333  * Stripe state
 334  */
 335 enum {
 336         STRIPE_ACTIVE,
 337         STRIPE_HANDLE,
 338         STRIPE_SYNC_REQUESTED,
 339         STRIPE_SYNCING,
 340         STRIPE_INSYNC,
 341         STRIPE_REPLACED,
 342         STRIPE_PREREAD_ACTIVE,
 343         STRIPE_DELAYED,
 344         STRIPE_DEGRADED,
 345         STRIPE_BIT_DELAY,
 346         STRIPE_EXPANDING,
 347         STRIPE_EXPAND_SOURCE,
 348         STRIPE_EXPAND_READY,
 349         STRIPE_IO_STARTED,      /* do not count towards 'bypass_count' */
 350         STRIPE_FULL_WRITE,      /* all blocks are set to be overwritten */
 351         STRIPE_BIOFILL_RUN,
 352         STRIPE_COMPUTE_RUN,
 353         STRIPE_OPS_REQ_PENDING,
 354         STRIPE_ON_UNPLUG_LIST,
 355         STRIPE_DISCARD,
 356         STRIPE_ON_RELEASE_LIST,
 357         STRIPE_BATCH_READY,
 358         STRIPE_BATCH_ERR,
 359         STRIPE_BITMAP_PENDING,  /* Being added to bitmap, don't add
 360                                  * to batch yet.
 361                                  */
 362         STRIPE_LOG_TRAPPED,     /* trapped into log (see raid5-cache.c)
 363                                  * this bit is used in two scenarios:
 364                                  *
 365                                  * 1. write-out phase
 366                                  *  set in first entry of r5l_write_stripe
 367                                  *  clear in second entry of r5l_write_stripe
 368                                  *  used to bypass logic in handle_stripe
 369                                  *
 370                                  * 2. caching phase
 371                                  *  set in r5c_try_caching_write()
 372                                  *  clear when journal write is done
 373                                  *  used to initiate r5c_cache_data()
 374                                  *  also used to bypass logic in handle_stripe
 375                                  */
 376         STRIPE_R5C_CACHING,     /* the stripe is in caching phase
 377                                  * see more detail in the raid5-cache.c
 378                                  */
 379         STRIPE_R5C_PARTIAL_STRIPE,      /* in r5c cache (to-be/being handled or
 380                                          * in conf->r5c_partial_stripe_list)
 381                                          */
 382         STRIPE_R5C_FULL_STRIPE, /* in r5c cache (to-be/being handled or
 383                                  * in conf->r5c_full_stripe_list)
 384                                  */
 385         STRIPE_R5C_PREFLUSH,    /* need to flush journal device */
 386 };
 387
 388 #define STRIPE_EXPAND_SYNC_FLAGS \
 389         ((1 << STRIPE_EXPAND_SOURCE) |\
 390         (1 << STRIPE_EXPAND_READY) |\
 391         (1 << STRIPE_EXPANDING) |\
 392         (1 << STRIPE_SYNC_REQUESTED))
 393 /*
 394  * Operation request flags
 395  */
 396 enum {
 397         STRIPE_OP_BIOFILL,
 398         STRIPE_OP_COMPUTE_BLK,
 399         STRIPE_OP_PREXOR,
 400         STRIPE_OP_BIODRAIN,
 401         STRIPE_OP_RECONSTRUCT,
 402         STRIPE_OP_CHECK,
 403 };
 404
 405 /*
 406  * RAID parity calculation preferences
 407  */
 408 enum {
 409         PARITY_DISABLE_RMW = 0,
 410         PARITY_ENABLE_RMW,
 411         PARITY_PREFER_RMW,
 412 };
 413
 414 /*
 415  * Pages requested from set_syndrome_sources()
 416  */
 417 enum {
 418         SYNDROME_SRC_ALL,
 419         SYNDROME_SRC_WANT_DRAIN,
 420         SYNDROME_SRC_WRITTEN,
 421 };
 422 /*
 423  * Plugging:
 424  *
 425  * To improve write throughput, we need to delay the handling of some
 426  * stripes until there has been a chance that several write requests
 427  * for the one stripe have all been collected.
 428  * In particular, any write request that would require pre-reading
 429  * is put on a "delayed" queue until there are no stripes currently
 430  * in a pre-read phase.  Further, if the "delayed" queue is empty when
 431  * a stripe is put on it then we "plug" the queue and do not process it
 432  * until an unplug call is made. (the unplug_io_fn() is called).
 433  *
 434  * When preread is initiated on a stripe, we set PREREAD_ACTIVE and add
 435  * it to the count of prereading stripes.
 436  * When write is initiated, or the stripe refcnt == 0 (just in case) we
 437  * clear the PREREAD_ACTIVE flag and decrement the count
 438  * Whenever the 'handle' queue is empty and the device is not plugged, we
 439  * move any strips from delayed to handle and clear the DELAYED flag and set
 440  * PREREAD_ACTIVE.
 441  * In stripe_handle, if we find pre-reading is necessary, we do it if
 442  * PREREAD_ACTIVE is set, else we set DELAYED which will send it to the delayed queue.
 443  * HANDLE gets cleared if stripe_handle leaves nothing locked.
 444  */
 445
 446 struct disk_info {
 447         struct md_rdev  *rdev, *replacement;
 448         struct page     *extra_page; /* extra page to use in prexor */
 449 };
 450
 451 /*
 452  * Stripe cache
 453  */
 454
 455 #define NR_STRIPES              256
 456 #define STRIPE_SIZE             PAGE_SIZE
 457 #define STRIPE_SHIFT            (PAGE_SHIFT - 9)
 458 #define STRIPE_SECTORS          (STRIPE_SIZE>>9)
 459 #define IO_THRESHOLD            1
 460 #define BYPASS_THRESHOLD        1
 461 #define NR_HASH                 (PAGE_SIZE / sizeof(struct hlist_head))
 462 #define HASH_MASK               (NR_HASH - 1)
 463 #define MAX_STRIPE_BATCH        8
 464
 465 /* bio's attached to a stripe+device for I/O are linked together in bi_sector
 466  * order without overlap.  There may be several bio's per stripe+device, and
 467  * a bio could span several devices.
 468  * When walking this list for a particular stripe+device, we must never proceed
 469  * beyond a bio that extends past this device, as the next bio might no longer
 470  * be valid.
 471  * This function is used to determine the 'next' bio in the list, given the
 472  * sector of the current stripe+device
 473  */
 474 static inline struct bio *r5_next_bio(struct bio *bio, sector_t sector)
 475 {
 476         int sectors = bio_sectors(bio);
 477
 478         if (bio->bi_iter.bi_sector + sectors < sector + STRIPE_SECTORS)
 479                 return bio->bi_next;
 480         else
 481                 return NULL;
 482 }
 483
 484 /*
 485  * We maintain a biased count of active stripes in the bottom 16 bits of
 486  * bi_phys_segments, and a count of processed stripes in the upper 16 bits
 487  */
 488 static inline int raid5_bi_processed_stripes(struct bio *bio)
 489 {
 490         atomic_t *segments = (atomic_t *)&bio->bi_phys_segments;
 491
 492         return (atomic_read(segments) >> 16) & 0xffff;
 493 }
 494
 495 static inline int raid5_dec_bi_active_stripes(struct bio *bio)
 496 {
 497         atomic_t *segments = (atomic_t *)&bio->bi_phys_segments;
 498
 499         return atomic_sub_return(1, segments) & 0xffff;
 500 }
 501
 502 static inline void raid5_inc_bi_active_stripes(struct bio *bio)
 503 {
 504         atomic_t *segments = (atomic_t *)&bio->bi_phys_segments;
 505
 506         atomic_inc(segments);
 507 }
 508
 509 static inline void raid5_set_bi_processed_stripes(struct bio *bio,
 510         unsigned int cnt)
 511 {
 512         atomic_t *segments = (atomic_t *)&bio->bi_phys_segments;
 513         int old, new;
 514
 515         do {
 516                 old = atomic_read(segments);
 517                 new = (old & 0xffff) | (cnt << 16);
 518         } while (atomic_cmpxchg(segments, old, new) != old);
 519 }
 520
 521 static inline void raid5_set_bi_stripes(struct bio *bio, unsigned int cnt)
 522 {
 523         atomic_t *segments = (atomic_t *)&bio->bi_phys_segments;
 524
 525         atomic_set(segments, cnt);
 526 }
 527
 528 /* NOTE NR_STRIPE_HASH_LOCKS must remain below 64.
 529  * This is because we sometimes take all the spinlocks
 530  * and creating that much locking depth can cause
 531  * problems.
 532  */
 533 #define NR_STRIPE_HASH_LOCKS 8
 534 #define STRIPE_HASH_LOCKS_MASK (NR_STRIPE_HASH_LOCKS - 1)
 535
 536 struct r5worker {
 537         struct work_struct work;
 538         struct r5worker_group *group;
 539         struct list_head temp_inactive_list[NR_STRIPE_HASH_LOCKS];
 540         bool working;
 541 };
 542
 543 struct r5worker_group {
 544         struct list_head handle_list;
 545         struct r5conf *conf;
 546         struct r5worker *workers;
 547         int stripes_cnt;
 548 };
 549
 550 enum r5_cache_state {
 551         R5_INACTIVE_BLOCKED,    /* release of inactive stripes blocked,
 552                                  * waiting for 25% to be free
 553                                  */
 554         R5_ALLOC_MORE,          /* It might help to allocate another
 555                                  * stripe.
 556                                  */
 557         R5_DID_ALLOC,           /* A stripe was allocated, don't allocate
 558                                  * more until at least one has been
 559                                  * released.  This avoids flooding
 560                                  * the cache.
 561                                  */
 562         R5C_LOG_TIGHT,          /* log device space tight, need to
 563                                  * prioritize stripes at last_checkpoint
 564                                  */
 565         R5C_LOG_CRITICAL,       /* log device is running out of space,
 566                                  * only process stripes that are already
 567                                  * occupying the log
 568                                  */
 569         R5C_EXTRA_PAGE_IN_USE,  /* a stripe is using disk_info.extra_page
 570                                  * for prexor
 571                                  */
 572 };
 573
 574 struct r5conf {
 575         struct hlist_head       *stripe_hashtbl;
 576         /* only protect corresponding hash list and inactive_list */
 577         spinlock_t              hash_locks[NR_STRIPE_HASH_LOCKS];
 578         struct mddev            *mddev;
 579         int                     chunk_sectors;
 580         int                     level, algorithm, rmw_level;
 581         int                     max_degraded;
 582         int                     raid_disks;
 583         int                     max_nr_stripes;
 584         int                     min_nr_stripes;
 585
 586         /* reshape_progress is the leading edge of a 'reshape'
 587          * It has value MaxSector when no reshape is happening
 588          * If delta_disks < 0, it is the last sector we started work on,
 589          * else is it the next sector to work on.
 590          */
 591         sector_t                reshape_progress;
 592         /* reshape_safe is the trailing edge of a reshape.  We know that
 593          * before (or after) this address, all reshape has completed.
 594          */
 595         sector_t                reshape_safe;
 596         int                     previous_raid_disks;
 597         int                     prev_chunk_sectors;
 598         int                     prev_algo;
 599         short                   generation; /* increments with every reshape */
 600         seqcount_t              gen_lock;       /* lock against generation changes */
 601         unsigned long           reshape_checkpoint; /* Time we last updated
 602                                                      * metadata */
 603         long long               min_offset_diff; /* minimum difference between
 604                                                   * data_offset and
 605                                                   * new_data_offset across all
 606                                                   * devices.  May be negative,
 607                                                   * but is closest to zero.
 608                                                   */
 609
 610         struct list_head        handle_list; /* stripes needing handling */
 611         struct list_head        hold_list; /* preread ready stripes */
 612         struct list_head        delayed_list; /* stripes that have plugged requests */
 613         struct list_head        bitmap_list; /* stripes delaying awaiting bitmap update */
 614         struct bio              *retry_read_aligned; /* currently retrying aligned bios   */
 615         struct bio              *retry_read_aligned_list; /* aligned bios retry list  */
 616         atomic_t                preread_active_stripes; /* stripes with scheduled io */
 617         atomic_t                active_aligned_reads;
 618         atomic_t                pending_full_writes; /* full write backlog */
 619         int                     bypass_count; /* bypassed prereads */
 620         int                     bypass_threshold; /* preread nice */
 621         int                     skip_copy; /* Don't copy data from bio to stripe cache */
 622         struct list_head        *last_hold; /* detect hold_list promotions */
 623
 624         /* bios to have bi_end_io called after metadata is synced */
 625         struct bio_list         return_bi;
 626
 627         atomic_t                reshape_stripes; /* stripes with pending writes for reshape */
 628         /* unfortunately we need two cache names as we temporarily have
 629          * two caches.
 630          */
 631         int                     active_name;
 632         char                    cache_name[2][32];
 633         struct kmem_cache       *slab_cache; /* for allocating stripes */
 634         struct mutex            cache_size_mutex; /* Protect changes to cache size */
 635
 636         int                     seq_flush, seq_write;
 637         int                     quiesce;
 638
 639         int                     fullsync;  /* set to 1 if a full sync is needed,
 640                                             * (fresh device added).
 641                                             * Cleared when a sync completes.
 642                                             */
 643         int                     recovery_disabled;
 644         /* per cpu variables */
 645         struct raid5_percpu {
 646                 struct page     *spare_page; /* Used when checking P/Q in raid6 */
 647                 struct flex_array *scribble;   /* space for constructing buffer
 648                                               * lists and performing address
 649                                               * conversions
 650                                               */
 651         } __percpu *percpu;
 652         int scribble_disks;
 653         int scribble_sectors;
 654         struct hlist_node node;
 655
 656         /*
 657          * Free stripes pool
 658          */
 659         atomic_t                active_stripes;
 660         struct list_head        inactive_list[NR_STRIPE_HASH_LOCKS];
 661
 662         atomic_t                r5c_cached_full_stripes;
 663         struct list_head        r5c_full_stripe_list;
 664         atomic_t                r5c_cached_partial_stripes;
 665         struct list_head        r5c_partial_stripe_list;
 666
 667         atomic_t                empty_inactive_list_nr;
 668         struct llist_head       released_stripes;
 669         wait_queue_head_t       wait_for_quiescent;
 670         wait_queue_head_t       wait_for_stripe;
 671         wait_queue_head_t       wait_for_overlap;
 672         unsigned long           cache_state;
 673         struct shrinker         shrinker;
 674         int                     pool_size; /* number of disks in stripeheads in pool */
 675         spinlock_t              device_lock;
 676         struct disk_info        *disks;
 677
 678         /* When taking over an array from a different personality, we store
 679          * the new thread here until we fully activate the array.
 680          */
 681         struct md_thread        *thread;
 682         struct list_head        temp_inactive_list[NR_STRIPE_HASH_LOCKS];
 683         struct r5worker_group   *worker_groups;
 684         int                     group_cnt;
 685         int                     worker_cnt_per_group;
 686         struct r5l_log          *log;
 687
 688         struct bio_list         pending_bios;
 689         spinlock_t              pending_bios_lock;
 690         bool                    batch_bio_dispatch;
 691 };
 692
 693
 694 /*
 695  * Our supported algorithms
 696  */
 697 #define ALGORITHM_LEFT_ASYMMETRIC       0 /* Rotating Parity N with Data Restart */
 698 #define ALGORITHM_RIGHT_ASYMMETRIC      1 /* Rotating Parity 0 with Data Restart */
 699 #define ALGORITHM_LEFT_SYMMETRIC        2 /* Rotating Parity N with Data Continuation */
 700 #define ALGORITHM_RIGHT_SYMMETRIC       3 /* Rotating Parity 0 with Data Continuation */
 701
 702 /* Define non-rotating (raid4) algorithms.  These allow
 703  * conversion of raid4 to raid5.
 704  */
 705 #define ALGORITHM_PARITY_0              4 /* P or P,Q are initial devices */
 706 #define ALGORITHM_PARITY_N              5 /* P or P,Q are final devices. */
 707
 708 /* DDF RAID6 layouts differ from md/raid6 layouts in two ways.
 709  * Firstly, the exact positioning of the parity block is slightly
 710  * different between the 'LEFT_*' modes of md and the "_N_*" modes
 711  * of DDF.
 712  * Secondly, or order of datablocks over which the Q syndrome is computed
 713  * is different.
 714  * Consequently we have different layouts for DDF/raid6 than md/raid6.
 715  * These layouts are from the DDFv1.2 spec.
 716  * Interestingly DDFv1.2-Errata-A does not specify N_CONTINUE but
 717  * leaves RLQ=3 as 'Vendor Specific'
 718  */
 719
 720 #define ALGORITHM_ROTATING_ZERO_RESTART 8 /* DDF PRL=6 RLQ=1 */
 721 #define ALGORITHM_ROTATING_N_RESTART    9 /* DDF PRL=6 RLQ=2 */
 722 #define ALGORITHM_ROTATING_N_CONTINUE   10 /*DDF PRL=6 RLQ=3 */
 723
 724 /* For every RAID5 algorithm we define a RAID6 algorithm
 725  * with exactly the same layout for data and parity, and
 726  * with the Q block always on the last device (N-1).
 727  * This allows trivial conversion from RAID5 to RAID6
 728  */
 729 #define ALGORITHM_LEFT_ASYMMETRIC_6     16
 730 #define ALGORITHM_RIGHT_ASYMMETRIC_6    17
 731 #define ALGORITHM_LEFT_SYMMETRIC_6      18
 732 #define ALGORITHM_RIGHT_SYMMETRIC_6     19
 733 #define ALGORITHM_PARITY_0_6            20
 734 #define ALGORITHM_PARITY_N_6            ALGORITHM_PARITY_N
 735
 736 static inline int algorithm_valid_raid5(int layout)
 737 {
 738         return (layout >= 0) &&
 739                 (layout <= 5);
 740 }
 741 static inline int algorithm_valid_raid6(int layout)
 742 {
 743         return (layout >= 0 && layout <= 5)
 744                 ||
 745                 (layout >= 8 && layout <= 10)
 746                 ||
 747                 (layout >= 16 && layout <= 20);
 748 }
 749
 750 static inline int algorithm_is_DDF(int layout)
 751 {
 752         return layout >= 8 && layout <= 10;
 753 }
 754
 755 extern void md_raid5_kick_device(struct r5conf *conf);
 756 extern int raid5_set_cache_size(struct mddev *mddev, int size);
 757 extern sector_t raid5_compute_blocknr(struct stripe_head *sh, int i, int previous);
 758 extern void raid5_release_stripe(struct stripe_head *sh);
 759 extern sector_t raid5_compute_sector(struct r5conf *conf, sector_t r_sector,
 760                                      int previous, int *dd_idx,
 761                                      struct stripe_head *sh);
 762 extern struct stripe_head *
 763 raid5_get_active_stripe(struct r5conf *conf, sector_t sector,
 764                         int previous, int noblock, int noquiesce);
 765 extern int raid5_calc_degraded(struct r5conf *conf);
 766 extern int r5l_init_log(struct r5conf *conf, struct md_rdev *rdev);
 767 extern void r5l_exit_log(struct r5l_log *log);
 768 extern int r5l_write_stripe(struct r5l_log *log, struct stripe_head *head_sh);
 769 extern void r5l_write_stripe_run(struct r5l_log *log);
 770 extern void r5l_flush_stripe_to_raid(struct r5l_log *log);
 771 extern void r5l_stripe_write_finished(struct stripe_head *sh);
 772 extern int r5l_handle_flush_request(struct r5l_log *log, struct bio *bio);
 773 extern void r5l_quiesce(struct r5l_log *log, int state);
 774 extern bool r5l_log_disk_error(struct r5conf *conf);
 775 extern bool r5c_is_writeback(struct r5l_log *log);
 776 extern int
 777 r5c_try_caching_write(struct r5conf *conf, struct stripe_head *sh,
 778                       struct stripe_head_state *s, int disks);
 779 extern void
 780 r5c_finish_stripe_write_out(struct r5conf *conf, struct stripe_head *sh,
 781                             struct stripe_head_state *s);
 782 extern void r5c_release_extra_page(struct stripe_head *sh);
 783 extern void r5c_use_extra_page(struct stripe_head *sh);
 784 extern void r5l_wake_reclaim(struct r5l_log *log, sector_t space);
 785 extern void r5c_handle_cached_data_endio(struct r5conf *conf,
 786         struct stripe_head *sh, int disks, struct bio_list *return_bi);
 787 extern int r5c_cache_data(struct r5l_log *log, struct stripe_head *sh,
 788                           struct stripe_head_state *s);
 789 extern void r5c_make_stripe_write_out(struct stripe_head *sh);
 790 extern void r5c_flush_cache(struct r5conf *conf, int num);
 791 extern void r5c_check_stripe_cache_usage(struct r5conf *conf);
 792 extern void r5c_check_cached_full_stripe(struct r5conf *conf);
 793 extern struct md_sysfs_entry r5c_journal_mode;
 794 extern void r5c_update_on_rdev_error(struct mddev *mddev);
 795 #endif