1 // SPDX-License-Identifier: GPL-2.0-only
3 * Partial Parity Log for closing the RAID5 write hole
4 * Copyright (c) 2017, Intel Corporation.
7 #include <linux/kernel.h>
8 #include <linux/blkdev.h>
9 #include <linux/slab.h>
10 #include <linux/crc32c.h>
11 #include <linux/async_tx.h>
12 #include <linux/raid/md_p.h>
15 #include "raid5-log.h"
18 * PPL consists of a 4KB header (struct ppl_header) and at least 128KB for
19 * partial parity data. The header contains an array of entries
20 * (struct ppl_header_entry) which describe the logged write requests.
21 * Partial parity for the entries comes after the header, written in the same
22 * sequence as the entries:
33 * An entry describes one or more consecutive stripe_heads, up to a full
34 * stripe. The modifed raid data chunks form an m-by-n matrix, where m is the
35 * number of stripe_heads in the entry and n is the number of modified data
36 * disks. Every stripe_head in the entry must write to the same data disks.
37 * An example of a valid case described by a single entry (writes to the first
38 * stripe of a 4 disk array, 16k chunk size):
40 * sh->sector dd0 dd1 dd2 ppl
42 * 0 | --- | --- | --- | +----+
43 * 8 | -W- | -W- | --- | | pp | data_sector = 8
44 * 16 | -W- | -W- | --- | | pp | data_size = 3 * 2 * 4k
45 * 24 | -W- | -W- | --- | | pp | pp_size = 3 * 4k
46 * +-----+-----+-----+ +----+
48 * data_sector is the first raid sector of the modified data, data_size is the
49 * total size of modified data and pp_size is the size of partial parity for
50 * this entry. Entries for full stripe writes contain no partial parity
51 * (pp_size = 0), they only mark the stripes for which parity should be
52 * recalculated after an unclean shutdown. Every entry holds a checksum of its
53 * partial parity, the header also has a checksum of the header itself.
55 * A write request is always logged to the PPL instance stored on the parity
56 * disk of the corresponding stripe. For each member disk there is one ppl_log
57 * used to handle logging for this disk, independently from others. They are
58 * grouped in child_logs array in struct ppl_conf, which is assigned to
59 * r5conf->log_private.
61 * ppl_io_unit represents a full PPL write, header_page contains the ppl_header.
62 * PPL entries for logged stripes are added in ppl_log_stripe(). A stripe_head
63 * can be appended to the last entry if it meets the conditions for a valid
64 * entry described above, otherwise a new entry is added. Checksums of entries
65 * are calculated incrementally as stripes containing partial parity are being
66 * added. ppl_submit_iounit() calculates the checksum of the header and submits
67 * a bio containing the header page and partial parity pages (sh->ppl_page) for
68 * all stripes of the io_unit. When the PPL write completes, the stripes
69 * associated with the io_unit are released and raid5d starts writing their data
70 * and parity. When all stripes are written, the io_unit is freed and the next
73 * An io_unit is used to gather stripes until it is submitted or becomes full
74 * (if the maximum number of entries or size of PPL is reached). Another io_unit
75 * can't be submitted until the previous has completed (PPL and stripe
76 * data+parity is written). The log->io_list tracks all io_units of a log
77 * (for a single member disk). New io_units are added to the end of the list
78 * and the first io_unit is submitted, if it is not submitted already.
79 * The current io_unit accepting new stripes is always at the end of the list.
81 * If write-back cache is enabled for any of the disks in the array, its data
82 * must be flushed before next io_unit is submitted.
85 #define PPL_SPACE_SIZE (128 * 1024)
90 /* array of child logs, one for each raid disk */
91 struct ppl_log *child_logs;
94 int block_size; /* the logical block size used for data_sector
95 * in ppl_header_entry */
96 u32 signature; /* raid array identifier */
97 atomic64_t seq; /* current log write sequence number */
99 struct kmem_cache *io_kc;
102 struct bio_set flush_bs;
104 /* used only for recovery */
105 int recovered_entries;
108 /* stripes to retry if failed to allocate io_unit */
109 struct list_head no_mem_stripes;
110 spinlock_t no_mem_stripes_lock;
112 unsigned short write_hint;
116 struct ppl_conf *ppl_conf; /* shared between all log instances */
118 struct md_rdev *rdev; /* array member disk associated with
119 * this log instance */
120 struct mutex io_mutex;
121 struct ppl_io_unit *current_io; /* current io_unit accepting new data
122 * always at the end of io_list */
123 spinlock_t io_list_lock;
124 struct list_head io_list; /* all io_units of this log */
126 sector_t next_io_sector;
127 unsigned int entry_space;
130 unsigned long disk_flush_bitmap;
133 #define PPL_IO_INLINE_BVECS 32
138 struct page *header_page; /* for ppl_header */
140 unsigned int entries_count; /* number of entries in ppl_header */
141 unsigned int pp_size; /* total size current of partial parity */
143 u64 seq; /* sequence number of this log write */
144 struct list_head log_sibling; /* log->io_list */
146 struct list_head stripe_list; /* stripes added to the io_unit */
147 atomic_t pending_stripes; /* how many stripes not written to raid */
148 atomic_t pending_flushes; /* how many disk flushes are in progress */
150 bool submitted; /* true if write to log started */
152 /* inline bio and its biovec for submitting the iounit */
154 struct bio_vec biovec[PPL_IO_INLINE_BVECS];
157 struct dma_async_tx_descriptor *
158 ops_run_partial_parity(struct stripe_head *sh, struct raid5_percpu *percpu,
159 struct dma_async_tx_descriptor *tx)
161 int disks = sh->disks;
162 struct page **srcs = percpu->scribble;
163 int count = 0, pd_idx = sh->pd_idx, i;
164 struct async_submit_ctl submit;
166 pr_debug("%s: stripe %llu\n", __func__, (unsigned long long)sh->sector);
169 * Partial parity is the XOR of stripe data chunks that are not changed
170 * during the write request. Depending on available data
171 * (read-modify-write vs. reconstruct-write case) we calculate it
174 if (sh->reconstruct_state == reconstruct_state_prexor_drain_run) {
176 * rmw: xor old data and parity from updated disks
177 * This is calculated earlier by ops_run_prexor5() so just copy
178 * the parity dev page.
180 srcs[count++] = sh->dev[pd_idx].page;
181 } else if (sh->reconstruct_state == reconstruct_state_drain_run) {
182 /* rcw: xor data from all not updated disks */
183 for (i = disks; i--;) {
184 struct r5dev *dev = &sh->dev[i];
185 if (test_bit(R5_UPTODATE, &dev->flags))
186 srcs[count++] = dev->page;
192 init_async_submit(&submit, ASYNC_TX_FENCE|ASYNC_TX_XOR_ZERO_DST, tx,
193 NULL, sh, (void *) (srcs + sh->disks + 2));
196 tx = async_memcpy(sh->ppl_page, srcs[0], 0, 0, PAGE_SIZE,
199 tx = async_xor(sh->ppl_page, srcs, 0, count, PAGE_SIZE,
205 static void *ppl_io_pool_alloc(gfp_t gfp_mask, void *pool_data)
207 struct kmem_cache *kc = pool_data;
208 struct ppl_io_unit *io;
210 io = kmem_cache_alloc(kc, gfp_mask);
214 io->header_page = alloc_page(gfp_mask);
215 if (!io->header_page) {
216 kmem_cache_free(kc, io);
223 static void ppl_io_pool_free(void *element, void *pool_data)
225 struct kmem_cache *kc = pool_data;
226 struct ppl_io_unit *io = element;
228 __free_page(io->header_page);
229 kmem_cache_free(kc, io);
232 static struct ppl_io_unit *ppl_new_iounit(struct ppl_log *log,
233 struct stripe_head *sh)
235 struct ppl_conf *ppl_conf = log->ppl_conf;
236 struct ppl_io_unit *io;
237 struct ppl_header *pplhdr;
238 struct page *header_page;
240 io = mempool_alloc(&ppl_conf->io_pool, GFP_NOWAIT);
244 header_page = io->header_page;
245 memset(io, 0, sizeof(*io));
246 io->header_page = header_page;
249 INIT_LIST_HEAD(&io->log_sibling);
250 INIT_LIST_HEAD(&io->stripe_list);
251 atomic_set(&io->pending_stripes, 0);
252 atomic_set(&io->pending_flushes, 0);
253 bio_init(&io->bio, log->rdev->bdev, io->biovec, PPL_IO_INLINE_BVECS,
254 REQ_OP_WRITE | REQ_FUA);
256 pplhdr = page_address(io->header_page);
258 memset(pplhdr->reserved, 0xff, PPL_HDR_RESERVED);
259 pplhdr->signature = cpu_to_le32(ppl_conf->signature);
261 io->seq = atomic64_add_return(1, &ppl_conf->seq);
262 pplhdr->generation = cpu_to_le64(io->seq);
267 static int ppl_log_stripe(struct ppl_log *log, struct stripe_head *sh)
269 struct ppl_io_unit *io = log->current_io;
270 struct ppl_header_entry *e = NULL;
271 struct ppl_header *pplhdr;
273 sector_t data_sector = 0;
275 struct r5conf *conf = sh->raid_conf;
277 pr_debug("%s: stripe: %llu\n", __func__, (unsigned long long)sh->sector);
279 /* check if current io_unit is full */
280 if (io && (io->pp_size == log->entry_space ||
281 io->entries_count == PPL_HDR_MAX_ENTRIES)) {
282 pr_debug("%s: add io_unit blocked by seq: %llu\n",
287 /* add a new unit if there is none or the current is full */
289 io = ppl_new_iounit(log, sh);
292 spin_lock_irq(&log->io_list_lock);
293 list_add_tail(&io->log_sibling, &log->io_list);
294 spin_unlock_irq(&log->io_list_lock);
296 log->current_io = io;
299 for (i = 0; i < sh->disks; i++) {
300 struct r5dev *dev = &sh->dev[i];
302 if (i != sh->pd_idx && test_bit(R5_Wantwrite, &dev->flags)) {
303 if (!data_disks || dev->sector < data_sector)
304 data_sector = dev->sector;
310 pr_debug("%s: seq: %llu data_sector: %llu data_disks: %d\n", __func__,
311 io->seq, (unsigned long long)data_sector, data_disks);
313 pplhdr = page_address(io->header_page);
315 if (io->entries_count > 0) {
316 struct ppl_header_entry *last =
317 &pplhdr->entries[io->entries_count - 1];
318 struct stripe_head *sh_last = list_last_entry(
319 &io->stripe_list, struct stripe_head, log_list);
320 u64 data_sector_last = le64_to_cpu(last->data_sector);
321 u32 data_size_last = le32_to_cpu(last->data_size);
324 * Check if we can append the stripe to the last entry. It must
325 * be just after the last logged stripe and write to the same
326 * disks. Use bit shift and logarithm to avoid 64-bit division.
328 if ((sh->sector == sh_last->sector + RAID5_STRIPE_SECTORS(conf)) &&
329 (data_sector >> ilog2(conf->chunk_sectors) ==
330 data_sector_last >> ilog2(conf->chunk_sectors)) &&
331 ((data_sector - data_sector_last) * data_disks ==
332 data_size_last >> 9))
337 e = &pplhdr->entries[io->entries_count++];
338 e->data_sector = cpu_to_le64(data_sector);
339 e->parity_disk = cpu_to_le32(sh->pd_idx);
340 e->checksum = cpu_to_le32(~0);
343 le32_add_cpu(&e->data_size, data_disks << PAGE_SHIFT);
345 /* don't write any PP if full stripe write */
346 if (!test_bit(STRIPE_FULL_WRITE, &sh->state)) {
347 le32_add_cpu(&e->pp_size, PAGE_SIZE);
348 io->pp_size += PAGE_SIZE;
349 e->checksum = cpu_to_le32(crc32c_le(le32_to_cpu(e->checksum),
350 page_address(sh->ppl_page),
354 list_add_tail(&sh->log_list, &io->stripe_list);
355 atomic_inc(&io->pending_stripes);
361 int ppl_write_stripe(struct r5conf *conf, struct stripe_head *sh)
363 struct ppl_conf *ppl_conf = conf->log_private;
364 struct ppl_io_unit *io = sh->ppl_io;
367 if (io || test_bit(STRIPE_SYNCING, &sh->state) || !sh->ppl_page ||
368 !test_bit(R5_Wantwrite, &sh->dev[sh->pd_idx].flags) ||
369 !test_bit(R5_Insync, &sh->dev[sh->pd_idx].flags)) {
370 clear_bit(STRIPE_LOG_TRAPPED, &sh->state);
374 log = &ppl_conf->child_logs[sh->pd_idx];
376 mutex_lock(&log->io_mutex);
378 if (!log->rdev || test_bit(Faulty, &log->rdev->flags)) {
379 mutex_unlock(&log->io_mutex);
383 set_bit(STRIPE_LOG_TRAPPED, &sh->state);
384 clear_bit(STRIPE_DELAYED, &sh->state);
385 atomic_inc(&sh->count);
387 if (ppl_log_stripe(log, sh)) {
388 spin_lock_irq(&ppl_conf->no_mem_stripes_lock);
389 list_add_tail(&sh->log_list, &ppl_conf->no_mem_stripes);
390 spin_unlock_irq(&ppl_conf->no_mem_stripes_lock);
393 mutex_unlock(&log->io_mutex);
398 static void ppl_log_endio(struct bio *bio)
400 struct ppl_io_unit *io = bio->bi_private;
401 struct ppl_log *log = io->log;
402 struct ppl_conf *ppl_conf = log->ppl_conf;
403 struct stripe_head *sh, *next;
405 pr_debug("%s: seq: %llu\n", __func__, io->seq);
408 md_error(ppl_conf->mddev, log->rdev);
410 list_for_each_entry_safe(sh, next, &io->stripe_list, log_list) {
411 list_del_init(&sh->log_list);
413 set_bit(STRIPE_HANDLE, &sh->state);
414 raid5_release_stripe(sh);
418 static void ppl_submit_iounit_bio(struct ppl_io_unit *io, struct bio *bio)
420 pr_debug("%s: seq: %llu size: %u sector: %llu dev: %pg\n",
421 __func__, io->seq, bio->bi_iter.bi_size,
422 (unsigned long long)bio->bi_iter.bi_sector,
428 static void ppl_submit_iounit(struct ppl_io_unit *io)
430 struct ppl_log *log = io->log;
431 struct ppl_conf *ppl_conf = log->ppl_conf;
432 struct ppl_header *pplhdr = page_address(io->header_page);
433 struct bio *bio = &io->bio;
434 struct stripe_head *sh;
437 bio->bi_private = io;
439 if (!log->rdev || test_bit(Faulty, &log->rdev->flags)) {
444 for (i = 0; i < io->entries_count; i++) {
445 struct ppl_header_entry *e = &pplhdr->entries[i];
447 pr_debug("%s: seq: %llu entry: %d data_sector: %llu pp_size: %u data_size: %u\n",
448 __func__, io->seq, i, le64_to_cpu(e->data_sector),
449 le32_to_cpu(e->pp_size), le32_to_cpu(e->data_size));
451 e->data_sector = cpu_to_le64(le64_to_cpu(e->data_sector) >>
452 ilog2(ppl_conf->block_size >> 9));
453 e->checksum = cpu_to_le32(~le32_to_cpu(e->checksum));
456 pplhdr->entries_count = cpu_to_le32(io->entries_count);
457 pplhdr->checksum = cpu_to_le32(~crc32c_le(~0, pplhdr, PPL_HEADER_SIZE));
459 /* Rewind the buffer if current PPL is larger then remaining space */
460 if (log->use_multippl &&
461 log->rdev->ppl.sector + log->rdev->ppl.size - log->next_io_sector <
462 (PPL_HEADER_SIZE + io->pp_size) >> 9)
463 log->next_io_sector = log->rdev->ppl.sector;
466 bio->bi_end_io = ppl_log_endio;
467 bio->bi_iter.bi_sector = log->next_io_sector;
468 bio_add_page(bio, io->header_page, PAGE_SIZE, 0);
470 pr_debug("%s: log->current_io_sector: %llu\n", __func__,
471 (unsigned long long)log->next_io_sector);
473 if (log->use_multippl)
474 log->next_io_sector += (PPL_HEADER_SIZE + io->pp_size) >> 9;
476 WARN_ON(log->disk_flush_bitmap != 0);
478 list_for_each_entry(sh, &io->stripe_list, log_list) {
479 for (i = 0; i < sh->disks; i++) {
480 struct r5dev *dev = &sh->dev[i];
482 if ((ppl_conf->child_logs[i].wb_cache_on) &&
483 (test_bit(R5_Wantwrite, &dev->flags))) {
484 set_bit(i, &log->disk_flush_bitmap);
488 /* entries for full stripe writes have no partial parity */
489 if (test_bit(STRIPE_FULL_WRITE, &sh->state))
492 if (!bio_add_page(bio, sh->ppl_page, PAGE_SIZE, 0)) {
493 struct bio *prev = bio;
495 bio = bio_alloc_bioset(prev->bi_bdev, BIO_MAX_VECS,
496 prev->bi_opf, GFP_NOIO,
498 bio->bi_iter.bi_sector = bio_end_sector(prev);
499 bio_add_page(bio, sh->ppl_page, PAGE_SIZE, 0);
501 bio_chain(bio, prev);
502 ppl_submit_iounit_bio(io, prev);
506 ppl_submit_iounit_bio(io, bio);
509 static void ppl_submit_current_io(struct ppl_log *log)
511 struct ppl_io_unit *io;
513 spin_lock_irq(&log->io_list_lock);
515 io = list_first_entry_or_null(&log->io_list, struct ppl_io_unit,
517 if (io && io->submitted)
520 spin_unlock_irq(&log->io_list_lock);
523 io->submitted = true;
525 if (io == log->current_io)
526 log->current_io = NULL;
528 ppl_submit_iounit(io);
532 void ppl_write_stripe_run(struct r5conf *conf)
534 struct ppl_conf *ppl_conf = conf->log_private;
538 for (i = 0; i < ppl_conf->count; i++) {
539 log = &ppl_conf->child_logs[i];
541 mutex_lock(&log->io_mutex);
542 ppl_submit_current_io(log);
543 mutex_unlock(&log->io_mutex);
547 static void ppl_io_unit_finished(struct ppl_io_unit *io)
549 struct ppl_log *log = io->log;
550 struct ppl_conf *ppl_conf = log->ppl_conf;
551 struct r5conf *conf = ppl_conf->mddev->private;
554 pr_debug("%s: seq: %llu\n", __func__, io->seq);
556 local_irq_save(flags);
558 spin_lock(&log->io_list_lock);
559 list_del(&io->log_sibling);
560 spin_unlock(&log->io_list_lock);
562 mempool_free(io, &ppl_conf->io_pool);
564 spin_lock(&ppl_conf->no_mem_stripes_lock);
565 if (!list_empty(&ppl_conf->no_mem_stripes)) {
566 struct stripe_head *sh;
568 sh = list_first_entry(&ppl_conf->no_mem_stripes,
569 struct stripe_head, log_list);
570 list_del_init(&sh->log_list);
571 set_bit(STRIPE_HANDLE, &sh->state);
572 raid5_release_stripe(sh);
574 spin_unlock(&ppl_conf->no_mem_stripes_lock);
576 local_irq_restore(flags);
578 wake_up(&conf->wait_for_quiescent);
581 static void ppl_flush_endio(struct bio *bio)
583 struct ppl_io_unit *io = bio->bi_private;
584 struct ppl_log *log = io->log;
585 struct ppl_conf *ppl_conf = log->ppl_conf;
586 struct r5conf *conf = ppl_conf->mddev->private;
588 pr_debug("%s: dev: %pg\n", __func__, bio->bi_bdev);
590 if (bio->bi_status) {
591 struct md_rdev *rdev;
594 rdev = md_find_rdev_rcu(conf->mddev, bio_dev(bio));
596 md_error(rdev->mddev, rdev);
602 if (atomic_dec_and_test(&io->pending_flushes)) {
603 ppl_io_unit_finished(io);
604 md_wakeup_thread(conf->mddev->thread);
608 static void ppl_do_flush(struct ppl_io_unit *io)
610 struct ppl_log *log = io->log;
611 struct ppl_conf *ppl_conf = log->ppl_conf;
612 struct r5conf *conf = ppl_conf->mddev->private;
613 int raid_disks = conf->raid_disks;
614 int flushed_disks = 0;
617 atomic_set(&io->pending_flushes, raid_disks);
619 for_each_set_bit(i, &log->disk_flush_bitmap, raid_disks) {
620 struct md_rdev *rdev;
621 struct block_device *bdev = NULL;
624 rdev = rcu_dereference(conf->disks[i].rdev);
625 if (rdev && !test_bit(Faulty, &rdev->flags))
632 bio = bio_alloc_bioset(bdev, 0,
633 REQ_OP_WRITE | REQ_PREFLUSH,
634 GFP_NOIO, &ppl_conf->flush_bs);
635 bio->bi_private = io;
636 bio->bi_end_io = ppl_flush_endio;
638 pr_debug("%s: dev: %ps\n", __func__, bio->bi_bdev);
645 log->disk_flush_bitmap = 0;
647 for (i = flushed_disks ; i < raid_disks; i++) {
648 if (atomic_dec_and_test(&io->pending_flushes))
649 ppl_io_unit_finished(io);
653 static inline bool ppl_no_io_unit_submitted(struct r5conf *conf,
656 struct ppl_io_unit *io;
658 io = list_first_entry_or_null(&log->io_list, struct ppl_io_unit,
661 return !io || !io->submitted;
664 void ppl_quiesce(struct r5conf *conf, int quiesce)
666 struct ppl_conf *ppl_conf = conf->log_private;
670 for (i = 0; i < ppl_conf->count; i++) {
671 struct ppl_log *log = &ppl_conf->child_logs[i];
673 spin_lock_irq(&log->io_list_lock);
674 wait_event_lock_irq(conf->wait_for_quiescent,
675 ppl_no_io_unit_submitted(conf, log),
677 spin_unlock_irq(&log->io_list_lock);
682 int ppl_handle_flush_request(struct bio *bio)
684 if (bio->bi_iter.bi_size == 0) {
688 bio->bi_opf &= ~REQ_PREFLUSH;
692 void ppl_stripe_write_finished(struct stripe_head *sh)
694 struct ppl_io_unit *io;
699 if (io && atomic_dec_and_test(&io->pending_stripes)) {
700 if (io->log->disk_flush_bitmap)
703 ppl_io_unit_finished(io);
707 static void ppl_xor(int size, struct page *page1, struct page *page2)
709 struct async_submit_ctl submit;
710 struct dma_async_tx_descriptor *tx;
711 struct page *xor_srcs[] = { page1, page2 };
713 init_async_submit(&submit, ASYNC_TX_ACK|ASYNC_TX_XOR_DROP_DST,
714 NULL, NULL, NULL, NULL);
715 tx = async_xor(page1, xor_srcs, 0, 2, size, &submit);
717 async_tx_quiesce(&tx);
721 * PPL recovery strategy: xor partial parity and data from all modified data
722 * disks within a stripe and write the result as the new stripe parity. If all
723 * stripe data disks are modified (full stripe write), no partial parity is
724 * available, so just xor the data disks.
726 * Recovery of a PPL entry shall occur only if all modified data disks are
727 * available and read from all of them succeeds.
729 * A PPL entry applies to a stripe, partial parity size for an entry is at most
730 * the size of the chunk. Examples of possible cases for a single entry:
732 * case 0: single data disk write:
733 * data0 data1 data2 ppl parity
734 * +--------+--------+--------+ +--------------------+
735 * | ------ | ------ | ------ | +----+ | (no change) |
736 * | ------ | -data- | ------ | | pp | -> | data1 ^ pp |
737 * | ------ | -data- | ------ | | pp | -> | data1 ^ pp |
738 * | ------ | ------ | ------ | +----+ | (no change) |
739 * +--------+--------+--------+ +--------------------+
740 * pp_size = data_size
742 * case 1: more than one data disk write:
743 * data0 data1 data2 ppl parity
744 * +--------+--------+--------+ +--------------------+
745 * | ------ | ------ | ------ | +----+ | (no change) |
746 * | -data- | -data- | ------ | | pp | -> | data0 ^ data1 ^ pp |
747 * | -data- | -data- | ------ | | pp | -> | data0 ^ data1 ^ pp |
748 * | ------ | ------ | ------ | +----+ | (no change) |
749 * +--------+--------+--------+ +--------------------+
750 * pp_size = data_size / modified_data_disks
752 * case 2: write to all data disks (also full stripe write):
753 * data0 data1 data2 parity
754 * +--------+--------+--------+ +--------------------+
755 * | ------ | ------ | ------ | | (no change) |
756 * | -data- | -data- | -data- | --------> | xor all data |
757 * | ------ | ------ | ------ | --------> | (no change) |
758 * | ------ | ------ | ------ | | (no change) |
759 * +--------+--------+--------+ +--------------------+
762 * The following cases are possible only in other implementations. The recovery
763 * code can handle them, but they are not generated at runtime because they can
764 * be reduced to cases 0, 1 and 2:
767 * data0 data1 data2 ppl parity
768 * +--------+--------+--------+ +----+ +--------------------+
769 * | ------ | -data- | -data- | | pp | | data1 ^ data2 ^ pp |
770 * | ------ | -data- | -data- | | pp | -> | data1 ^ data2 ^ pp |
771 * | -data- | -data- | -data- | | -- | -> | xor all data |
772 * | -data- | -data- | ------ | | pp | | data0 ^ data1 ^ pp |
773 * +--------+--------+--------+ +----+ +--------------------+
774 * pp_size = chunk_size
777 * data0 data1 data2 ppl parity
778 * +--------+--------+--------+ +----+ +--------------------+
779 * | ------ | -data- | ------ | | pp | | data1 ^ pp |
780 * | ------ | ------ | ------ | | -- | -> | (no change) |
781 * | ------ | ------ | ------ | | -- | -> | (no change) |
782 * | -data- | ------ | ------ | | pp | | data0 ^ pp |
783 * +--------+--------+--------+ +----+ +--------------------+
784 * pp_size = chunk_size
786 static int ppl_recover_entry(struct ppl_log *log, struct ppl_header_entry *e,
789 struct ppl_conf *ppl_conf = log->ppl_conf;
790 struct mddev *mddev = ppl_conf->mddev;
791 struct r5conf *conf = mddev->private;
792 int block_size = ppl_conf->block_size;
795 sector_t r_sector_first;
796 sector_t r_sector_last;
801 unsigned int pp_size = le32_to_cpu(e->pp_size);
802 unsigned int data_size = le32_to_cpu(e->data_size);
804 page1 = alloc_page(GFP_KERNEL);
805 page2 = alloc_page(GFP_KERNEL);
807 if (!page1 || !page2) {
812 r_sector_first = le64_to_cpu(e->data_sector) * (block_size >> 9);
814 if ((pp_size >> 9) < conf->chunk_sectors) {
816 data_disks = data_size / pp_size;
817 strip_sectors = pp_size >> 9;
819 data_disks = conf->raid_disks - conf->max_degraded;
820 strip_sectors = (data_size >> 9) / data_disks;
822 r_sector_last = r_sector_first +
823 (data_disks - 1) * conf->chunk_sectors +
826 data_disks = conf->raid_disks - conf->max_degraded;
827 strip_sectors = conf->chunk_sectors;
828 r_sector_last = r_sector_first + (data_size >> 9);
831 pr_debug("%s: array sector first: %llu last: %llu\n", __func__,
832 (unsigned long long)r_sector_first,
833 (unsigned long long)r_sector_last);
835 /* if start and end is 4k aligned, use a 4k block */
836 if (block_size == 512 &&
837 (r_sector_first & (RAID5_STRIPE_SECTORS(conf) - 1)) == 0 &&
838 (r_sector_last & (RAID5_STRIPE_SECTORS(conf) - 1)) == 0)
839 block_size = RAID5_STRIPE_SIZE(conf);
841 /* iterate through blocks in strip */
842 for (i = 0; i < strip_sectors; i += (block_size >> 9)) {
843 bool update_parity = false;
844 sector_t parity_sector;
845 struct md_rdev *parity_rdev;
846 struct stripe_head sh;
850 pr_debug("%s:%*s iter %d start\n", __func__, indent, "", i);
853 memset(page_address(page1), 0, PAGE_SIZE);
855 /* iterate through data member disks */
856 for (disk = 0; disk < data_disks; disk++) {
858 struct md_rdev *rdev;
860 sector_t r_sector = r_sector_first + i +
861 (disk * conf->chunk_sectors);
863 pr_debug("%s:%*s data member disk %d start\n",
864 __func__, indent, "", disk);
867 if (r_sector >= r_sector_last) {
868 pr_debug("%s:%*s array sector %llu doesn't need parity update\n",
869 __func__, indent, "",
870 (unsigned long long)r_sector);
875 update_parity = true;
877 /* map raid sector to member disk */
878 sector = raid5_compute_sector(conf, r_sector, 0,
880 pr_debug("%s:%*s processing array sector %llu => data member disk %d, sector %llu\n",
881 __func__, indent, "",
882 (unsigned long long)r_sector, dd_idx,
883 (unsigned long long)sector);
885 /* Array has not started so rcu dereference is safe */
886 rdev = rcu_dereference_protected(
887 conf->disks[dd_idx].rdev, 1);
888 if (!rdev || (!test_bit(In_sync, &rdev->flags) &&
889 sector >= rdev->recovery_offset)) {
890 pr_debug("%s:%*s data member disk %d missing\n",
891 __func__, indent, "", dd_idx);
892 update_parity = false;
896 pr_debug("%s:%*s reading data member disk %pg sector %llu\n",
897 __func__, indent, "", rdev->bdev,
898 (unsigned long long)sector);
899 if (!sync_page_io(rdev, sector, block_size, page2,
900 REQ_OP_READ, false)) {
901 md_error(mddev, rdev);
902 pr_debug("%s:%*s read failed!\n", __func__,
908 ppl_xor(block_size, page1, page2);
917 pr_debug("%s:%*s reading pp disk sector %llu\n",
918 __func__, indent, "",
919 (unsigned long long)(ppl_sector + i));
920 if (!sync_page_io(log->rdev,
921 ppl_sector - log->rdev->data_offset + i,
922 block_size, page2, REQ_OP_READ,
924 pr_debug("%s:%*s read failed!\n", __func__,
926 md_error(mddev, log->rdev);
931 ppl_xor(block_size, page1, page2);
934 /* map raid sector to parity disk */
935 parity_sector = raid5_compute_sector(conf, r_sector_first + i,
937 BUG_ON(sh.pd_idx != le32_to_cpu(e->parity_disk));
939 /* Array has not started so rcu dereference is safe */
940 parity_rdev = rcu_dereference_protected(
941 conf->disks[sh.pd_idx].rdev, 1);
943 BUG_ON(parity_rdev->bdev->bd_dev != log->rdev->bdev->bd_dev);
944 pr_debug("%s:%*s write parity at sector %llu, disk %pg\n",
945 __func__, indent, "",
946 (unsigned long long)parity_sector,
948 if (!sync_page_io(parity_rdev, parity_sector, block_size,
949 page1, REQ_OP_WRITE, false)) {
950 pr_debug("%s:%*s parity write error!\n", __func__,
952 md_error(mddev, parity_rdev);
965 static int ppl_recover(struct ppl_log *log, struct ppl_header *pplhdr,
968 struct ppl_conf *ppl_conf = log->ppl_conf;
969 struct md_rdev *rdev = log->rdev;
970 struct mddev *mddev = rdev->mddev;
971 sector_t ppl_sector = rdev->ppl.sector + offset +
972 (PPL_HEADER_SIZE >> 9);
977 page = alloc_page(GFP_KERNEL);
981 /* iterate through all PPL entries saved */
982 for (i = 0; i < le32_to_cpu(pplhdr->entries_count); i++) {
983 struct ppl_header_entry *e = &pplhdr->entries[i];
984 u32 pp_size = le32_to_cpu(e->pp_size);
985 sector_t sector = ppl_sector;
986 int ppl_entry_sectors = pp_size >> 9;
989 pr_debug("%s: disk: %d entry: %d ppl_sector: %llu pp_size: %u\n",
990 __func__, rdev->raid_disk, i,
991 (unsigned long long)ppl_sector, pp_size);
994 crc_stored = le32_to_cpu(e->checksum);
996 /* read parial parity for this entry and calculate its checksum */
998 int s = pp_size > PAGE_SIZE ? PAGE_SIZE : pp_size;
1000 if (!sync_page_io(rdev, sector - rdev->data_offset,
1001 s, page, REQ_OP_READ, false)) {
1002 md_error(mddev, rdev);
1007 crc = crc32c_le(crc, page_address(page), s);
1015 if (crc != crc_stored) {
1017 * Don't recover this entry if the checksum does not
1018 * match, but keep going and try to recover other
1021 pr_debug("%s: ppl entry crc does not match: stored: 0x%x calculated: 0x%x\n",
1022 __func__, crc_stored, crc);
1023 ppl_conf->mismatch_count++;
1025 ret = ppl_recover_entry(log, e, ppl_sector);
1028 ppl_conf->recovered_entries++;
1031 ppl_sector += ppl_entry_sectors;
1034 /* flush the disk cache after recovery if necessary */
1035 ret = blkdev_issue_flush(rdev->bdev);
1041 static int ppl_write_empty_header(struct ppl_log *log)
1044 struct ppl_header *pplhdr;
1045 struct md_rdev *rdev = log->rdev;
1048 pr_debug("%s: disk: %d ppl_sector: %llu\n", __func__,
1049 rdev->raid_disk, (unsigned long long)rdev->ppl.sector);
1051 page = alloc_page(GFP_NOIO | __GFP_ZERO);
1055 pplhdr = page_address(page);
1056 /* zero out PPL space to avoid collision with old PPLs */
1057 blkdev_issue_zeroout(rdev->bdev, rdev->ppl.sector,
1058 log->rdev->ppl.size, GFP_NOIO, 0);
1059 memset(pplhdr->reserved, 0xff, PPL_HDR_RESERVED);
1060 pplhdr->signature = cpu_to_le32(log->ppl_conf->signature);
1061 pplhdr->checksum = cpu_to_le32(~crc32c_le(~0, pplhdr, PAGE_SIZE));
1063 if (!sync_page_io(rdev, rdev->ppl.sector - rdev->data_offset,
1064 PPL_HEADER_SIZE, page, REQ_OP_WRITE | REQ_SYNC |
1066 md_error(rdev->mddev, rdev);
1074 static int ppl_load_distributed(struct ppl_log *log)
1076 struct ppl_conf *ppl_conf = log->ppl_conf;
1077 struct md_rdev *rdev = log->rdev;
1078 struct mddev *mddev = rdev->mddev;
1079 struct page *page, *page2;
1080 struct ppl_header *pplhdr = NULL, *prev_pplhdr = NULL;
1081 u32 crc, crc_stored;
1084 sector_t pplhdr_offset = 0, prev_pplhdr_offset = 0;
1086 pr_debug("%s: disk: %d\n", __func__, rdev->raid_disk);
1087 /* read PPL headers, find the recent one */
1088 page = alloc_page(GFP_KERNEL);
1092 page2 = alloc_page(GFP_KERNEL);
1098 /* searching ppl area for latest ppl */
1099 while (pplhdr_offset < rdev->ppl.size - (PPL_HEADER_SIZE >> 9)) {
1100 if (!sync_page_io(rdev,
1101 rdev->ppl.sector - rdev->data_offset +
1102 pplhdr_offset, PAGE_SIZE, page, REQ_OP_READ,
1104 md_error(mddev, rdev);
1106 /* if not able to read - don't recover any PPL */
1110 pplhdr = page_address(page);
1112 /* check header validity */
1113 crc_stored = le32_to_cpu(pplhdr->checksum);
1114 pplhdr->checksum = 0;
1115 crc = ~crc32c_le(~0, pplhdr, PAGE_SIZE);
1117 if (crc_stored != crc) {
1118 pr_debug("%s: ppl header crc does not match: stored: 0x%x calculated: 0x%x (offset: %llu)\n",
1119 __func__, crc_stored, crc,
1120 (unsigned long long)pplhdr_offset);
1121 pplhdr = prev_pplhdr;
1122 pplhdr_offset = prev_pplhdr_offset;
1126 signature = le32_to_cpu(pplhdr->signature);
1128 if (mddev->external) {
1130 * For external metadata the header signature is set and
1131 * validated in userspace.
1133 ppl_conf->signature = signature;
1134 } else if (ppl_conf->signature != signature) {
1135 pr_debug("%s: ppl header signature does not match: stored: 0x%x configured: 0x%x (offset: %llu)\n",
1136 __func__, signature, ppl_conf->signature,
1137 (unsigned long long)pplhdr_offset);
1138 pplhdr = prev_pplhdr;
1139 pplhdr_offset = prev_pplhdr_offset;
1143 if (prev_pplhdr && le64_to_cpu(prev_pplhdr->generation) >
1144 le64_to_cpu(pplhdr->generation)) {
1145 /* previous was newest */
1146 pplhdr = prev_pplhdr;
1147 pplhdr_offset = prev_pplhdr_offset;
1151 prev_pplhdr_offset = pplhdr_offset;
1152 prev_pplhdr = pplhdr;
1156 /* calculate next potential ppl offset */
1157 for (i = 0; i < le32_to_cpu(pplhdr->entries_count); i++)
1159 le32_to_cpu(pplhdr->entries[i].pp_size) >> 9;
1160 pplhdr_offset += PPL_HEADER_SIZE >> 9;
1163 /* no valid ppl found */
1165 ppl_conf->mismatch_count++;
1167 pr_debug("%s: latest PPL found at offset: %llu, with generation: %llu\n",
1168 __func__, (unsigned long long)pplhdr_offset,
1169 le64_to_cpu(pplhdr->generation));
1171 /* attempt to recover from log if we are starting a dirty array */
1172 if (pplhdr && !mddev->pers && mddev->recovery_cp != MaxSector)
1173 ret = ppl_recover(log, pplhdr, pplhdr_offset);
1175 /* write empty header if we are starting the array */
1176 if (!ret && !mddev->pers)
1177 ret = ppl_write_empty_header(log);
1182 pr_debug("%s: return: %d mismatch_count: %d recovered_entries: %d\n",
1183 __func__, ret, ppl_conf->mismatch_count,
1184 ppl_conf->recovered_entries);
1188 static int ppl_load(struct ppl_conf *ppl_conf)
1192 bool signature_set = false;
1195 for (i = 0; i < ppl_conf->count; i++) {
1196 struct ppl_log *log = &ppl_conf->child_logs[i];
1198 /* skip missing drive */
1202 ret = ppl_load_distributed(log);
1207 * For external metadata we can't check if the signature is
1208 * correct on a single drive, but we can check if it is the same
1211 if (ppl_conf->mddev->external) {
1212 if (!signature_set) {
1213 signature = ppl_conf->signature;
1214 signature_set = true;
1215 } else if (signature != ppl_conf->signature) {
1216 pr_warn("md/raid:%s: PPL header signature does not match on all member drives\n",
1217 mdname(ppl_conf->mddev));
1224 pr_debug("%s: return: %d mismatch_count: %d recovered_entries: %d\n",
1225 __func__, ret, ppl_conf->mismatch_count,
1226 ppl_conf->recovered_entries);
1230 static void __ppl_exit_log(struct ppl_conf *ppl_conf)
1232 clear_bit(MD_HAS_PPL, &ppl_conf->mddev->flags);
1233 clear_bit(MD_HAS_MULTIPLE_PPLS, &ppl_conf->mddev->flags);
1235 kfree(ppl_conf->child_logs);
1237 bioset_exit(&ppl_conf->bs);
1238 bioset_exit(&ppl_conf->flush_bs);
1239 mempool_exit(&ppl_conf->io_pool);
1240 kmem_cache_destroy(ppl_conf->io_kc);
1245 void ppl_exit_log(struct r5conf *conf)
1247 struct ppl_conf *ppl_conf = conf->log_private;
1250 __ppl_exit_log(ppl_conf);
1251 conf->log_private = NULL;
1255 static int ppl_validate_rdev(struct md_rdev *rdev)
1257 int ppl_data_sectors;
1261 * The configured PPL size must be enough to store
1262 * the header and (at the very least) partial parity
1263 * for one stripe. Round it down to ensure the data
1264 * space is cleanly divisible by stripe size.
1266 ppl_data_sectors = rdev->ppl.size - (PPL_HEADER_SIZE >> 9);
1268 if (ppl_data_sectors > 0)
1269 ppl_data_sectors = rounddown(ppl_data_sectors,
1270 RAID5_STRIPE_SECTORS((struct r5conf *)rdev->mddev->private));
1272 if (ppl_data_sectors <= 0) {
1273 pr_warn("md/raid:%s: PPL space too small on %pg\n",
1274 mdname(rdev->mddev), rdev->bdev);
1278 ppl_size_new = ppl_data_sectors + (PPL_HEADER_SIZE >> 9);
1280 if ((rdev->ppl.sector < rdev->data_offset &&
1281 rdev->ppl.sector + ppl_size_new > rdev->data_offset) ||
1282 (rdev->ppl.sector >= rdev->data_offset &&
1283 rdev->data_offset + rdev->sectors > rdev->ppl.sector)) {
1284 pr_warn("md/raid:%s: PPL space overlaps with data on %pg\n",
1285 mdname(rdev->mddev), rdev->bdev);
1289 if (!rdev->mddev->external &&
1290 ((rdev->ppl.offset > 0 && rdev->ppl.offset < (rdev->sb_size >> 9)) ||
1291 (rdev->ppl.offset <= 0 && rdev->ppl.offset + ppl_size_new > 0))) {
1292 pr_warn("md/raid:%s: PPL space overlaps with superblock on %pg\n",
1293 mdname(rdev->mddev), rdev->bdev);
1297 rdev->ppl.size = ppl_size_new;
1302 static void ppl_init_child_log(struct ppl_log *log, struct md_rdev *rdev)
1304 struct request_queue *q;
1306 if ((rdev->ppl.size << 9) >= (PPL_SPACE_SIZE +
1307 PPL_HEADER_SIZE) * 2) {
1308 log->use_multippl = true;
1309 set_bit(MD_HAS_MULTIPLE_PPLS,
1310 &log->ppl_conf->mddev->flags);
1311 log->entry_space = PPL_SPACE_SIZE;
1313 log->use_multippl = false;
1314 log->entry_space = (log->rdev->ppl.size << 9) -
1317 log->next_io_sector = rdev->ppl.sector;
1319 q = bdev_get_queue(rdev->bdev);
1320 if (test_bit(QUEUE_FLAG_WC, &q->queue_flags))
1321 log->wb_cache_on = true;
1324 int ppl_init_log(struct r5conf *conf)
1326 struct ppl_conf *ppl_conf;
1327 struct mddev *mddev = conf->mddev;
1332 pr_debug("md/raid:%s: enabling distributed Partial Parity Log\n",
1333 mdname(conf->mddev));
1335 if (PAGE_SIZE != 4096)
1338 if (mddev->level != 5) {
1339 pr_warn("md/raid:%s PPL is not compatible with raid level %d\n",
1340 mdname(mddev), mddev->level);
1344 if (mddev->bitmap_info.file || mddev->bitmap_info.offset) {
1345 pr_warn("md/raid:%s PPL is not compatible with bitmap\n",
1350 if (test_bit(MD_HAS_JOURNAL, &mddev->flags)) {
1351 pr_warn("md/raid:%s PPL is not compatible with journal\n",
1356 max_disks = sizeof_field(struct ppl_log, disk_flush_bitmap) *
1358 if (conf->raid_disks > max_disks) {
1359 pr_warn("md/raid:%s PPL doesn't support over %d disks in the array\n",
1360 mdname(mddev), max_disks);
1364 ppl_conf = kzalloc(sizeof(struct ppl_conf), GFP_KERNEL);
1368 ppl_conf->mddev = mddev;
1370 ppl_conf->io_kc = KMEM_CACHE(ppl_io_unit, 0);
1371 if (!ppl_conf->io_kc) {
1376 ret = mempool_init(&ppl_conf->io_pool, conf->raid_disks, ppl_io_pool_alloc,
1377 ppl_io_pool_free, ppl_conf->io_kc);
1381 ret = bioset_init(&ppl_conf->bs, conf->raid_disks, 0, BIOSET_NEED_BVECS);
1385 ret = bioset_init(&ppl_conf->flush_bs, conf->raid_disks, 0, 0);
1389 ppl_conf->count = conf->raid_disks;
1390 ppl_conf->child_logs = kcalloc(ppl_conf->count, sizeof(struct ppl_log),
1392 if (!ppl_conf->child_logs) {
1397 atomic64_set(&ppl_conf->seq, 0);
1398 INIT_LIST_HEAD(&ppl_conf->no_mem_stripes);
1399 spin_lock_init(&ppl_conf->no_mem_stripes_lock);
1401 if (!mddev->external) {
1402 ppl_conf->signature = ~crc32c_le(~0, mddev->uuid, sizeof(mddev->uuid));
1403 ppl_conf->block_size = 512;
1405 ppl_conf->block_size = queue_logical_block_size(mddev->queue);
1408 for (i = 0; i < ppl_conf->count; i++) {
1409 struct ppl_log *log = &ppl_conf->child_logs[i];
1410 /* Array has not started so rcu dereference is safe */
1411 struct md_rdev *rdev =
1412 rcu_dereference_protected(conf->disks[i].rdev, 1);
1414 mutex_init(&log->io_mutex);
1415 spin_lock_init(&log->io_list_lock);
1416 INIT_LIST_HEAD(&log->io_list);
1418 log->ppl_conf = ppl_conf;
1422 ret = ppl_validate_rdev(rdev);
1426 ppl_init_child_log(log, rdev);
1430 /* load and possibly recover the logs from the member disks */
1431 ret = ppl_load(ppl_conf);
1435 } else if (!mddev->pers && mddev->recovery_cp == 0 &&
1436 ppl_conf->recovered_entries > 0 &&
1437 ppl_conf->mismatch_count == 0) {
1439 * If we are starting a dirty array and the recovery succeeds
1440 * without any issues, set the array as clean.
1442 mddev->recovery_cp = MaxSector;
1443 set_bit(MD_SB_CHANGE_CLEAN, &mddev->sb_flags);
1444 } else if (mddev->pers && ppl_conf->mismatch_count > 0) {
1445 /* no mismatch allowed when enabling PPL for a running array */
1450 conf->log_private = ppl_conf;
1451 set_bit(MD_HAS_PPL, &ppl_conf->mddev->flags);
1455 __ppl_exit_log(ppl_conf);
1459 int ppl_modify_log(struct r5conf *conf, struct md_rdev *rdev, bool add)
1461 struct ppl_conf *ppl_conf = conf->log_private;
1462 struct ppl_log *log;
1468 pr_debug("%s: disk: %d operation: %s dev: %pg\n",
1469 __func__, rdev->raid_disk, add ? "add" : "remove",
1472 if (rdev->raid_disk < 0)
1475 if (rdev->raid_disk >= ppl_conf->count)
1478 log = &ppl_conf->child_logs[rdev->raid_disk];
1480 mutex_lock(&log->io_mutex);
1482 ret = ppl_validate_rdev(rdev);
1485 ret = ppl_write_empty_header(log);
1486 ppl_init_child_log(log, rdev);
1491 mutex_unlock(&log->io_mutex);
1497 ppl_write_hint_show(struct mddev *mddev, char *buf)
1499 return sprintf(buf, "%d\n", 0);
1503 ppl_write_hint_store(struct mddev *mddev, const char *page, size_t len)
1505 struct r5conf *conf;
1509 if (len >= PAGE_SIZE)
1511 if (kstrtou16(page, 10, &new))
1514 err = mddev_lock(mddev);
1518 conf = mddev->private;
1521 else if (!raid5_has_ppl(conf) || !conf->log_private)
1524 mddev_unlock(mddev);
1529 struct md_sysfs_entry
1530 ppl_write_hint = __ATTR(ppl_write_hint, S_IRUGO | S_IWUSR,
1531 ppl_write_hint_show,
1532 ppl_write_hint_store);