xref: /openbmc/linux/drivers/md/raid5-ppl.c (revision df202b452fe6c6d6f1351bad485e2367ef1e644e)
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  * Partial Parity Log for closing the RAID5 write hole
4  * Copyright (c) 2017, Intel Corporation.
5  */
6 
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>
13 #include "md.h"
14 #include "raid5.h"
15 #include "raid5-log.h"
16 
17 /*
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:
23  *
24  * Header
25  *   entry0
26  *   ...
27  *   entryN
28  * PP data
29  *   PP for entry0
30  *   ...
31  *   PP for entryN
32  *
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):
39  *
40  * sh->sector   dd0   dd1   dd2    ppl
41  *            +-----+-----+-----+
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  *            +-----+-----+-----+ +----+
47  *
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.
54  *
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.
60  *
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
71  * can be submitted.
72  *
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.
80  *
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.
83  */
84 
85 #define PPL_SPACE_SIZE (128 * 1024)
86 
87 struct ppl_conf {
88 	struct mddev *mddev;
89 
90 	/* array of child logs, one for each raid disk */
91 	struct ppl_log *child_logs;
92 	int count;
93 
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 */
98 
99 	struct kmem_cache *io_kc;
100 	mempool_t io_pool;
101 	struct bio_set bs;
102 	struct bio_set flush_bs;
103 
104 	/* used only for recovery */
105 	int recovered_entries;
106 	int mismatch_count;
107 
108 	/* stripes to retry if failed to allocate io_unit */
109 	struct list_head no_mem_stripes;
110 	spinlock_t no_mem_stripes_lock;
111 
112 	unsigned short write_hint;
113 };
114 
115 struct ppl_log {
116 	struct ppl_conf *ppl_conf;	/* shared between all log instances */
117 
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 */
125 
126 	sector_t next_io_sector;
127 	unsigned int entry_space;
128 	bool use_multippl;
129 	bool wb_cache_on;
130 	unsigned long disk_flush_bitmap;
131 };
132 
133 #define PPL_IO_INLINE_BVECS 32
134 
135 struct ppl_io_unit {
136 	struct ppl_log *log;
137 
138 	struct page *header_page;	/* for ppl_header */
139 
140 	unsigned int entries_count;	/* number of entries in ppl_header */
141 	unsigned int pp_size;		/* total size current of partial parity */
142 
143 	u64 seq;			/* sequence number of this log write */
144 	struct list_head log_sibling;	/* log->io_list */
145 
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 */
149 
150 	bool submitted;			/* true if write to log started */
151 
152 	/* inline bio and its biovec for submitting the iounit */
153 	struct bio bio;
154 	struct bio_vec biovec[PPL_IO_INLINE_BVECS];
155 };
156 
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)
160 {
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;
165 
166 	pr_debug("%s: stripe %llu\n", __func__, (unsigned long long)sh->sector);
167 
168 	/*
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
172 	 * differently.
173 	 */
174 	if (sh->reconstruct_state == reconstruct_state_prexor_drain_run) {
175 		/*
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.
179 		 */
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;
187 		}
188 	} else {
189 		return tx;
190 	}
191 
192 	init_async_submit(&submit, ASYNC_TX_FENCE|ASYNC_TX_XOR_ZERO_DST, tx,
193 			  NULL, sh, (void *) (srcs + sh->disks + 2));
194 
195 	if (count == 1)
196 		tx = async_memcpy(sh->ppl_page, srcs[0], 0, 0, PAGE_SIZE,
197 				  &submit);
198 	else
199 		tx = async_xor(sh->ppl_page, srcs, 0, count, PAGE_SIZE,
200 			       &submit);
201 
202 	return tx;
203 }
204 
205 static void *ppl_io_pool_alloc(gfp_t gfp_mask, void *pool_data)
206 {
207 	struct kmem_cache *kc = pool_data;
208 	struct ppl_io_unit *io;
209 
210 	io = kmem_cache_alloc(kc, gfp_mask);
211 	if (!io)
212 		return NULL;
213 
214 	io->header_page = alloc_page(gfp_mask);
215 	if (!io->header_page) {
216 		kmem_cache_free(kc, io);
217 		return NULL;
218 	}
219 
220 	return io;
221 }
222 
223 static void ppl_io_pool_free(void *element, void *pool_data)
224 {
225 	struct kmem_cache *kc = pool_data;
226 	struct ppl_io_unit *io = element;
227 
228 	__free_page(io->header_page);
229 	kmem_cache_free(kc, io);
230 }
231 
232 static struct ppl_io_unit *ppl_new_iounit(struct ppl_log *log,
233 					  struct stripe_head *sh)
234 {
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;
239 
240 	io = mempool_alloc(&ppl_conf->io_pool, GFP_NOWAIT);
241 	if (!io)
242 		return NULL;
243 
244 	header_page = io->header_page;
245 	memset(io, 0, sizeof(*io));
246 	io->header_page = header_page;
247 
248 	io->log = log;
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);
255 
256 	pplhdr = page_address(io->header_page);
257 	clear_page(pplhdr);
258 	memset(pplhdr->reserved, 0xff, PPL_HDR_RESERVED);
259 	pplhdr->signature = cpu_to_le32(ppl_conf->signature);
260 
261 	io->seq = atomic64_add_return(1, &ppl_conf->seq);
262 	pplhdr->generation = cpu_to_le64(io->seq);
263 
264 	return io;
265 }
266 
267 static int ppl_log_stripe(struct ppl_log *log, struct stripe_head *sh)
268 {
269 	struct ppl_io_unit *io = log->current_io;
270 	struct ppl_header_entry *e = NULL;
271 	struct ppl_header *pplhdr;
272 	int i;
273 	sector_t data_sector = 0;
274 	int data_disks = 0;
275 	struct r5conf *conf = sh->raid_conf;
276 
277 	pr_debug("%s: stripe: %llu\n", __func__, (unsigned long long)sh->sector);
278 
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",
283 			 __func__, io->seq);
284 		io = NULL;
285 	}
286 
287 	/* add a new unit if there is none or the current is full */
288 	if (!io) {
289 		io = ppl_new_iounit(log, sh);
290 		if (!io)
291 			return -ENOMEM;
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);
295 
296 		log->current_io = io;
297 	}
298 
299 	for (i = 0; i < sh->disks; i++) {
300 		struct r5dev *dev = &sh->dev[i];
301 
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;
305 			data_disks++;
306 		}
307 	}
308 	BUG_ON(!data_disks);
309 
310 	pr_debug("%s: seq: %llu data_sector: %llu data_disks: %d\n", __func__,
311 		 io->seq, (unsigned long long)data_sector, data_disks);
312 
313 	pplhdr = page_address(io->header_page);
314 
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);
322 
323 		/*
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.
327 		 */
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))
333 			e = last;
334 	}
335 
336 	if (!e) {
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);
341 	}
342 
343 	le32_add_cpu(&e->data_size, data_disks << PAGE_SHIFT);
344 
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),
351 						    PAGE_SIZE));
352 	}
353 
354 	list_add_tail(&sh->log_list, &io->stripe_list);
355 	atomic_inc(&io->pending_stripes);
356 	sh->ppl_io = io;
357 
358 	return 0;
359 }
360 
361 int ppl_write_stripe(struct r5conf *conf, struct stripe_head *sh)
362 {
363 	struct ppl_conf *ppl_conf = conf->log_private;
364 	struct ppl_io_unit *io = sh->ppl_io;
365 	struct ppl_log *log;
366 
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);
371 		return -EAGAIN;
372 	}
373 
374 	log = &ppl_conf->child_logs[sh->pd_idx];
375 
376 	mutex_lock(&log->io_mutex);
377 
378 	if (!log->rdev || test_bit(Faulty, &log->rdev->flags)) {
379 		mutex_unlock(&log->io_mutex);
380 		return -EAGAIN;
381 	}
382 
383 	set_bit(STRIPE_LOG_TRAPPED, &sh->state);
384 	clear_bit(STRIPE_DELAYED, &sh->state);
385 	atomic_inc(&sh->count);
386 
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);
391 	}
392 
393 	mutex_unlock(&log->io_mutex);
394 
395 	return 0;
396 }
397 
398 static void ppl_log_endio(struct bio *bio)
399 {
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;
404 
405 	pr_debug("%s: seq: %llu\n", __func__, io->seq);
406 
407 	if (bio->bi_status)
408 		md_error(ppl_conf->mddev, log->rdev);
409 
410 	list_for_each_entry_safe(sh, next, &io->stripe_list, log_list) {
411 		list_del_init(&sh->log_list);
412 
413 		set_bit(STRIPE_HANDLE, &sh->state);
414 		raid5_release_stripe(sh);
415 	}
416 }
417 
418 static void ppl_submit_iounit_bio(struct ppl_io_unit *io, struct bio *bio)
419 {
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,
423 		 bio->bi_bdev);
424 
425 	submit_bio(bio);
426 }
427 
428 static void ppl_submit_iounit(struct ppl_io_unit *io)
429 {
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;
435 	int i;
436 
437 	bio->bi_private = io;
438 
439 	if (!log->rdev || test_bit(Faulty, &log->rdev->flags)) {
440 		ppl_log_endio(bio);
441 		return;
442 	}
443 
444 	for (i = 0; i < io->entries_count; i++) {
445 		struct ppl_header_entry *e = &pplhdr->entries[i];
446 
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));
450 
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));
454 	}
455 
456 	pplhdr->entries_count = cpu_to_le32(io->entries_count);
457 	pplhdr->checksum = cpu_to_le32(~crc32c_le(~0, pplhdr, PPL_HEADER_SIZE));
458 
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;
464 
465 
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);
469 
470 	pr_debug("%s: log->current_io_sector: %llu\n", __func__,
471 	    (unsigned long long)log->next_io_sector);
472 
473 	if (log->use_multippl)
474 		log->next_io_sector += (PPL_HEADER_SIZE + io->pp_size) >> 9;
475 
476 	WARN_ON(log->disk_flush_bitmap != 0);
477 
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];
481 
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);
485 			}
486 		}
487 
488 		/* entries for full stripe writes have no partial parity */
489 		if (test_bit(STRIPE_FULL_WRITE, &sh->state))
490 			continue;
491 
492 		if (!bio_add_page(bio, sh->ppl_page, PAGE_SIZE, 0)) {
493 			struct bio *prev = bio;
494 
495 			bio = bio_alloc_bioset(prev->bi_bdev, BIO_MAX_VECS,
496 					       prev->bi_opf, GFP_NOIO,
497 					       &ppl_conf->bs);
498 			bio->bi_iter.bi_sector = bio_end_sector(prev);
499 			bio_add_page(bio, sh->ppl_page, PAGE_SIZE, 0);
500 
501 			bio_chain(bio, prev);
502 			ppl_submit_iounit_bio(io, prev);
503 		}
504 	}
505 
506 	ppl_submit_iounit_bio(io, bio);
507 }
508 
509 static void ppl_submit_current_io(struct ppl_log *log)
510 {
511 	struct ppl_io_unit *io;
512 
513 	spin_lock_irq(&log->io_list_lock);
514 
515 	io = list_first_entry_or_null(&log->io_list, struct ppl_io_unit,
516 				      log_sibling);
517 	if (io && io->submitted)
518 		io = NULL;
519 
520 	spin_unlock_irq(&log->io_list_lock);
521 
522 	if (io) {
523 		io->submitted = true;
524 
525 		if (io == log->current_io)
526 			log->current_io = NULL;
527 
528 		ppl_submit_iounit(io);
529 	}
530 }
531 
532 void ppl_write_stripe_run(struct r5conf *conf)
533 {
534 	struct ppl_conf *ppl_conf = conf->log_private;
535 	struct ppl_log *log;
536 	int i;
537 
538 	for (i = 0; i < ppl_conf->count; i++) {
539 		log = &ppl_conf->child_logs[i];
540 
541 		mutex_lock(&log->io_mutex);
542 		ppl_submit_current_io(log);
543 		mutex_unlock(&log->io_mutex);
544 	}
545 }
546 
547 static void ppl_io_unit_finished(struct ppl_io_unit *io)
548 {
549 	struct ppl_log *log = io->log;
550 	struct ppl_conf *ppl_conf = log->ppl_conf;
551 	struct r5conf *conf = ppl_conf->mddev->private;
552 	unsigned long flags;
553 
554 	pr_debug("%s: seq: %llu\n", __func__, io->seq);
555 
556 	local_irq_save(flags);
557 
558 	spin_lock(&log->io_list_lock);
559 	list_del(&io->log_sibling);
560 	spin_unlock(&log->io_list_lock);
561 
562 	mempool_free(io, &ppl_conf->io_pool);
563 
564 	spin_lock(&ppl_conf->no_mem_stripes_lock);
565 	if (!list_empty(&ppl_conf->no_mem_stripes)) {
566 		struct stripe_head *sh;
567 
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);
573 	}
574 	spin_unlock(&ppl_conf->no_mem_stripes_lock);
575 
576 	local_irq_restore(flags);
577 
578 	wake_up(&conf->wait_for_quiescent);
579 }
580 
581 static void ppl_flush_endio(struct bio *bio)
582 {
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;
587 
588 	pr_debug("%s: dev: %pg\n", __func__, bio->bi_bdev);
589 
590 	if (bio->bi_status) {
591 		struct md_rdev *rdev;
592 
593 		rcu_read_lock();
594 		rdev = md_find_rdev_rcu(conf->mddev, bio_dev(bio));
595 		if (rdev)
596 			md_error(rdev->mddev, rdev);
597 		rcu_read_unlock();
598 	}
599 
600 	bio_put(bio);
601 
602 	if (atomic_dec_and_test(&io->pending_flushes)) {
603 		ppl_io_unit_finished(io);
604 		md_wakeup_thread(conf->mddev->thread);
605 	}
606 }
607 
608 static void ppl_do_flush(struct ppl_io_unit *io)
609 {
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;
615 	int i;
616 
617 	atomic_set(&io->pending_flushes, raid_disks);
618 
619 	for_each_set_bit(i, &log->disk_flush_bitmap, raid_disks) {
620 		struct md_rdev *rdev;
621 		struct block_device *bdev = NULL;
622 
623 		rcu_read_lock();
624 		rdev = rcu_dereference(conf->disks[i].rdev);
625 		if (rdev && !test_bit(Faulty, &rdev->flags))
626 			bdev = rdev->bdev;
627 		rcu_read_unlock();
628 
629 		if (bdev) {
630 			struct bio *bio;
631 
632 			bio = bio_alloc_bioset(bdev, 0, GFP_NOIO,
633 					       REQ_OP_WRITE | REQ_PREFLUSH,
634 					       &ppl_conf->flush_bs);
635 			bio->bi_private = io;
636 			bio->bi_end_io = ppl_flush_endio;
637 
638 			pr_debug("%s: dev: %ps\n", __func__, bio->bi_bdev);
639 
640 			submit_bio(bio);
641 			flushed_disks++;
642 		}
643 	}
644 
645 	log->disk_flush_bitmap = 0;
646 
647 	for (i = flushed_disks ; i < raid_disks; i++) {
648 		if (atomic_dec_and_test(&io->pending_flushes))
649 			ppl_io_unit_finished(io);
650 	}
651 }
652 
653 static inline bool ppl_no_io_unit_submitted(struct r5conf *conf,
654 					    struct ppl_log *log)
655 {
656 	struct ppl_io_unit *io;
657 
658 	io = list_first_entry_or_null(&log->io_list, struct ppl_io_unit,
659 				      log_sibling);
660 
661 	return !io || !io->submitted;
662 }
663 
664 void ppl_quiesce(struct r5conf *conf, int quiesce)
665 {
666 	struct ppl_conf *ppl_conf = conf->log_private;
667 	int i;
668 
669 	if (quiesce) {
670 		for (i = 0; i < ppl_conf->count; i++) {
671 			struct ppl_log *log = &ppl_conf->child_logs[i];
672 
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),
676 					    log->io_list_lock);
677 			spin_unlock_irq(&log->io_list_lock);
678 		}
679 	}
680 }
681 
682 int ppl_handle_flush_request(struct r5l_log *log, struct bio *bio)
683 {
684 	if (bio->bi_iter.bi_size == 0) {
685 		bio_endio(bio);
686 		return 0;
687 	}
688 	bio->bi_opf &= ~REQ_PREFLUSH;
689 	return -EAGAIN;
690 }
691 
692 void ppl_stripe_write_finished(struct stripe_head *sh)
693 {
694 	struct ppl_io_unit *io;
695 
696 	io = sh->ppl_io;
697 	sh->ppl_io = NULL;
698 
699 	if (io && atomic_dec_and_test(&io->pending_stripes)) {
700 		if (io->log->disk_flush_bitmap)
701 			ppl_do_flush(io);
702 		else
703 			ppl_io_unit_finished(io);
704 	}
705 }
706 
707 static void ppl_xor(int size, struct page *page1, struct page *page2)
708 {
709 	struct async_submit_ctl submit;
710 	struct dma_async_tx_descriptor *tx;
711 	struct page *xor_srcs[] = { page1, page2 };
712 
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);
716 
717 	async_tx_quiesce(&tx);
718 }
719 
720 /*
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.
725  *
726  * Recovery of a PPL entry shall occur only if all modified data disks are
727  * available and read from all of them succeeds.
728  *
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:
731  *
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
741  *
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
751  *
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  * +--------+--------+--------+           +--------------------+
760  * pp_size = 0
761  *
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:
765  *
766  * case 3:
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
775  *
776  * case 4:
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
785  */
786 static int ppl_recover_entry(struct ppl_log *log, struct ppl_header_entry *e,
787 			     sector_t ppl_sector)
788 {
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;
793 	struct page *page1;
794 	struct page *page2;
795 	sector_t r_sector_first;
796 	sector_t r_sector_last;
797 	int strip_sectors;
798 	int data_disks;
799 	int i;
800 	int ret = 0;
801 	char b[BDEVNAME_SIZE];
802 	unsigned int pp_size = le32_to_cpu(e->pp_size);
803 	unsigned int data_size = le32_to_cpu(e->data_size);
804 
805 	page1 = alloc_page(GFP_KERNEL);
806 	page2 = alloc_page(GFP_KERNEL);
807 
808 	if (!page1 || !page2) {
809 		ret = -ENOMEM;
810 		goto out;
811 	}
812 
813 	r_sector_first = le64_to_cpu(e->data_sector) * (block_size >> 9);
814 
815 	if ((pp_size >> 9) < conf->chunk_sectors) {
816 		if (pp_size > 0) {
817 			data_disks = data_size / pp_size;
818 			strip_sectors = pp_size >> 9;
819 		} else {
820 			data_disks = conf->raid_disks - conf->max_degraded;
821 			strip_sectors = (data_size >> 9) / data_disks;
822 		}
823 		r_sector_last = r_sector_first +
824 				(data_disks - 1) * conf->chunk_sectors +
825 				strip_sectors;
826 	} else {
827 		data_disks = conf->raid_disks - conf->max_degraded;
828 		strip_sectors = conf->chunk_sectors;
829 		r_sector_last = r_sector_first + (data_size >> 9);
830 	}
831 
832 	pr_debug("%s: array sector first: %llu last: %llu\n", __func__,
833 		 (unsigned long long)r_sector_first,
834 		 (unsigned long long)r_sector_last);
835 
836 	/* if start and end is 4k aligned, use a 4k block */
837 	if (block_size == 512 &&
838 	    (r_sector_first & (RAID5_STRIPE_SECTORS(conf) - 1)) == 0 &&
839 	    (r_sector_last & (RAID5_STRIPE_SECTORS(conf) - 1)) == 0)
840 		block_size = RAID5_STRIPE_SIZE(conf);
841 
842 	/* iterate through blocks in strip */
843 	for (i = 0; i < strip_sectors; i += (block_size >> 9)) {
844 		bool update_parity = false;
845 		sector_t parity_sector;
846 		struct md_rdev *parity_rdev;
847 		struct stripe_head sh;
848 		int disk;
849 		int indent = 0;
850 
851 		pr_debug("%s:%*s iter %d start\n", __func__, indent, "", i);
852 		indent += 2;
853 
854 		memset(page_address(page1), 0, PAGE_SIZE);
855 
856 		/* iterate through data member disks */
857 		for (disk = 0; disk < data_disks; disk++) {
858 			int dd_idx;
859 			struct md_rdev *rdev;
860 			sector_t sector;
861 			sector_t r_sector = r_sector_first + i +
862 					    (disk * conf->chunk_sectors);
863 
864 			pr_debug("%s:%*s data member disk %d start\n",
865 				 __func__, indent, "", disk);
866 			indent += 2;
867 
868 			if (r_sector >= r_sector_last) {
869 				pr_debug("%s:%*s array sector %llu doesn't need parity update\n",
870 					 __func__, indent, "",
871 					 (unsigned long long)r_sector);
872 				indent -= 2;
873 				continue;
874 			}
875 
876 			update_parity = true;
877 
878 			/* map raid sector to member disk */
879 			sector = raid5_compute_sector(conf, r_sector, 0,
880 						      &dd_idx, NULL);
881 			pr_debug("%s:%*s processing array sector %llu => data member disk %d, sector %llu\n",
882 				 __func__, indent, "",
883 				 (unsigned long long)r_sector, dd_idx,
884 				 (unsigned long long)sector);
885 
886 			/* Array has not started so rcu dereference is safe */
887 			rdev = rcu_dereference_protected(
888 					conf->disks[dd_idx].rdev, 1);
889 			if (!rdev || (!test_bit(In_sync, &rdev->flags) &&
890 				      sector >= rdev->recovery_offset)) {
891 				pr_debug("%s:%*s data member disk %d missing\n",
892 					 __func__, indent, "", dd_idx);
893 				update_parity = false;
894 				break;
895 			}
896 
897 			pr_debug("%s:%*s reading data member disk %s sector %llu\n",
898 				 __func__, indent, "", bdevname(rdev->bdev, b),
899 				 (unsigned long long)sector);
900 			if (!sync_page_io(rdev, sector, block_size, page2,
901 					REQ_OP_READ, 0, false)) {
902 				md_error(mddev, rdev);
903 				pr_debug("%s:%*s read failed!\n", __func__,
904 					 indent, "");
905 				ret = -EIO;
906 				goto out;
907 			}
908 
909 			ppl_xor(block_size, page1, page2);
910 
911 			indent -= 2;
912 		}
913 
914 		if (!update_parity)
915 			continue;
916 
917 		if (pp_size > 0) {
918 			pr_debug("%s:%*s reading pp disk sector %llu\n",
919 				 __func__, indent, "",
920 				 (unsigned long long)(ppl_sector + i));
921 			if (!sync_page_io(log->rdev,
922 					ppl_sector - log->rdev->data_offset + i,
923 					block_size, page2, REQ_OP_READ, 0,
924 					false)) {
925 				pr_debug("%s:%*s read failed!\n", __func__,
926 					 indent, "");
927 				md_error(mddev, log->rdev);
928 				ret = -EIO;
929 				goto out;
930 			}
931 
932 			ppl_xor(block_size, page1, page2);
933 		}
934 
935 		/* map raid sector to parity disk */
936 		parity_sector = raid5_compute_sector(conf, r_sector_first + i,
937 				0, &disk, &sh);
938 		BUG_ON(sh.pd_idx != le32_to_cpu(e->parity_disk));
939 
940 		/* Array has not started so rcu dereference is safe */
941 		parity_rdev = rcu_dereference_protected(
942 					conf->disks[sh.pd_idx].rdev, 1);
943 
944 		BUG_ON(parity_rdev->bdev->bd_dev != log->rdev->bdev->bd_dev);
945 		pr_debug("%s:%*s write parity at sector %llu, disk %s\n",
946 			 __func__, indent, "",
947 			 (unsigned long long)parity_sector,
948 			 bdevname(parity_rdev->bdev, b));
949 		if (!sync_page_io(parity_rdev, parity_sector, block_size,
950 				page1, REQ_OP_WRITE, 0, false)) {
951 			pr_debug("%s:%*s parity write error!\n", __func__,
952 				 indent, "");
953 			md_error(mddev, parity_rdev);
954 			ret = -EIO;
955 			goto out;
956 		}
957 	}
958 out:
959 	if (page1)
960 		__free_page(page1);
961 	if (page2)
962 		__free_page(page2);
963 	return ret;
964 }
965 
966 static int ppl_recover(struct ppl_log *log, struct ppl_header *pplhdr,
967 		       sector_t offset)
968 {
969 	struct ppl_conf *ppl_conf = log->ppl_conf;
970 	struct md_rdev *rdev = log->rdev;
971 	struct mddev *mddev = rdev->mddev;
972 	sector_t ppl_sector = rdev->ppl.sector + offset +
973 			      (PPL_HEADER_SIZE >> 9);
974 	struct page *page;
975 	int i;
976 	int ret = 0;
977 
978 	page = alloc_page(GFP_KERNEL);
979 	if (!page)
980 		return -ENOMEM;
981 
982 	/* iterate through all PPL entries saved */
983 	for (i = 0; i < le32_to_cpu(pplhdr->entries_count); i++) {
984 		struct ppl_header_entry *e = &pplhdr->entries[i];
985 		u32 pp_size = le32_to_cpu(e->pp_size);
986 		sector_t sector = ppl_sector;
987 		int ppl_entry_sectors = pp_size >> 9;
988 		u32 crc, crc_stored;
989 
990 		pr_debug("%s: disk: %d entry: %d ppl_sector: %llu pp_size: %u\n",
991 			 __func__, rdev->raid_disk, i,
992 			 (unsigned long long)ppl_sector, pp_size);
993 
994 		crc = ~0;
995 		crc_stored = le32_to_cpu(e->checksum);
996 
997 		/* read parial parity for this entry and calculate its checksum */
998 		while (pp_size) {
999 			int s = pp_size > PAGE_SIZE ? PAGE_SIZE : pp_size;
1000 
1001 			if (!sync_page_io(rdev, sector - rdev->data_offset,
1002 					s, page, REQ_OP_READ, 0, false)) {
1003 				md_error(mddev, rdev);
1004 				ret = -EIO;
1005 				goto out;
1006 			}
1007 
1008 			crc = crc32c_le(crc, page_address(page), s);
1009 
1010 			pp_size -= s;
1011 			sector += s >> 9;
1012 		}
1013 
1014 		crc = ~crc;
1015 
1016 		if (crc != crc_stored) {
1017 			/*
1018 			 * Don't recover this entry if the checksum does not
1019 			 * match, but keep going and try to recover other
1020 			 * entries.
1021 			 */
1022 			pr_debug("%s: ppl entry crc does not match: stored: 0x%x calculated: 0x%x\n",
1023 				 __func__, crc_stored, crc);
1024 			ppl_conf->mismatch_count++;
1025 		} else {
1026 			ret = ppl_recover_entry(log, e, ppl_sector);
1027 			if (ret)
1028 				goto out;
1029 			ppl_conf->recovered_entries++;
1030 		}
1031 
1032 		ppl_sector += ppl_entry_sectors;
1033 	}
1034 
1035 	/* flush the disk cache after recovery if necessary */
1036 	ret = blkdev_issue_flush(rdev->bdev);
1037 out:
1038 	__free_page(page);
1039 	return ret;
1040 }
1041 
1042 static int ppl_write_empty_header(struct ppl_log *log)
1043 {
1044 	struct page *page;
1045 	struct ppl_header *pplhdr;
1046 	struct md_rdev *rdev = log->rdev;
1047 	int ret = 0;
1048 
1049 	pr_debug("%s: disk: %d ppl_sector: %llu\n", __func__,
1050 		 rdev->raid_disk, (unsigned long long)rdev->ppl.sector);
1051 
1052 	page = alloc_page(GFP_NOIO | __GFP_ZERO);
1053 	if (!page)
1054 		return -ENOMEM;
1055 
1056 	pplhdr = page_address(page);
1057 	/* zero out PPL space to avoid collision with old PPLs */
1058 	blkdev_issue_zeroout(rdev->bdev, rdev->ppl.sector,
1059 			    log->rdev->ppl.size, GFP_NOIO, 0);
1060 	memset(pplhdr->reserved, 0xff, PPL_HDR_RESERVED);
1061 	pplhdr->signature = cpu_to_le32(log->ppl_conf->signature);
1062 	pplhdr->checksum = cpu_to_le32(~crc32c_le(~0, pplhdr, PAGE_SIZE));
1063 
1064 	if (!sync_page_io(rdev, rdev->ppl.sector - rdev->data_offset,
1065 			  PPL_HEADER_SIZE, page, REQ_OP_WRITE | REQ_SYNC |
1066 			  REQ_FUA, 0, false)) {
1067 		md_error(rdev->mddev, rdev);
1068 		ret = -EIO;
1069 	}
1070 
1071 	__free_page(page);
1072 	return ret;
1073 }
1074 
1075 static int ppl_load_distributed(struct ppl_log *log)
1076 {
1077 	struct ppl_conf *ppl_conf = log->ppl_conf;
1078 	struct md_rdev *rdev = log->rdev;
1079 	struct mddev *mddev = rdev->mddev;
1080 	struct page *page, *page2;
1081 	struct ppl_header *pplhdr = NULL, *prev_pplhdr = NULL;
1082 	u32 crc, crc_stored;
1083 	u32 signature;
1084 	int ret = 0, i;
1085 	sector_t pplhdr_offset = 0, prev_pplhdr_offset = 0;
1086 
1087 	pr_debug("%s: disk: %d\n", __func__, rdev->raid_disk);
1088 	/* read PPL headers, find the recent one */
1089 	page = alloc_page(GFP_KERNEL);
1090 	if (!page)
1091 		return -ENOMEM;
1092 
1093 	page2 = alloc_page(GFP_KERNEL);
1094 	if (!page2) {
1095 		__free_page(page);
1096 		return -ENOMEM;
1097 	}
1098 
1099 	/* searching ppl area for latest ppl */
1100 	while (pplhdr_offset < rdev->ppl.size - (PPL_HEADER_SIZE >> 9)) {
1101 		if (!sync_page_io(rdev,
1102 				  rdev->ppl.sector - rdev->data_offset +
1103 				  pplhdr_offset, PAGE_SIZE, page, REQ_OP_READ,
1104 				  0, false)) {
1105 			md_error(mddev, rdev);
1106 			ret = -EIO;
1107 			/* if not able to read - don't recover any PPL */
1108 			pplhdr = NULL;
1109 			break;
1110 		}
1111 		pplhdr = page_address(page);
1112 
1113 		/* check header validity */
1114 		crc_stored = le32_to_cpu(pplhdr->checksum);
1115 		pplhdr->checksum = 0;
1116 		crc = ~crc32c_le(~0, pplhdr, PAGE_SIZE);
1117 
1118 		if (crc_stored != crc) {
1119 			pr_debug("%s: ppl header crc does not match: stored: 0x%x calculated: 0x%x (offset: %llu)\n",
1120 				 __func__, crc_stored, crc,
1121 				 (unsigned long long)pplhdr_offset);
1122 			pplhdr = prev_pplhdr;
1123 			pplhdr_offset = prev_pplhdr_offset;
1124 			break;
1125 		}
1126 
1127 		signature = le32_to_cpu(pplhdr->signature);
1128 
1129 		if (mddev->external) {
1130 			/*
1131 			 * For external metadata the header signature is set and
1132 			 * validated in userspace.
1133 			 */
1134 			ppl_conf->signature = signature;
1135 		} else if (ppl_conf->signature != signature) {
1136 			pr_debug("%s: ppl header signature does not match: stored: 0x%x configured: 0x%x (offset: %llu)\n",
1137 				 __func__, signature, ppl_conf->signature,
1138 				 (unsigned long long)pplhdr_offset);
1139 			pplhdr = prev_pplhdr;
1140 			pplhdr_offset = prev_pplhdr_offset;
1141 			break;
1142 		}
1143 
1144 		if (prev_pplhdr && le64_to_cpu(prev_pplhdr->generation) >
1145 		    le64_to_cpu(pplhdr->generation)) {
1146 			/* previous was newest */
1147 			pplhdr = prev_pplhdr;
1148 			pplhdr_offset = prev_pplhdr_offset;
1149 			break;
1150 		}
1151 
1152 		prev_pplhdr_offset = pplhdr_offset;
1153 		prev_pplhdr = pplhdr;
1154 
1155 		swap(page, page2);
1156 
1157 		/* calculate next potential ppl offset */
1158 		for (i = 0; i < le32_to_cpu(pplhdr->entries_count); i++)
1159 			pplhdr_offset +=
1160 			    le32_to_cpu(pplhdr->entries[i].pp_size) >> 9;
1161 		pplhdr_offset += PPL_HEADER_SIZE >> 9;
1162 	}
1163 
1164 	/* no valid ppl found */
1165 	if (!pplhdr)
1166 		ppl_conf->mismatch_count++;
1167 	else
1168 		pr_debug("%s: latest PPL found at offset: %llu, with generation: %llu\n",
1169 		    __func__, (unsigned long long)pplhdr_offset,
1170 		    le64_to_cpu(pplhdr->generation));
1171 
1172 	/* attempt to recover from log if we are starting a dirty array */
1173 	if (pplhdr && !mddev->pers && mddev->recovery_cp != MaxSector)
1174 		ret = ppl_recover(log, pplhdr, pplhdr_offset);
1175 
1176 	/* write empty header if we are starting the array */
1177 	if (!ret && !mddev->pers)
1178 		ret = ppl_write_empty_header(log);
1179 
1180 	__free_page(page);
1181 	__free_page(page2);
1182 
1183 	pr_debug("%s: return: %d mismatch_count: %d recovered_entries: %d\n",
1184 		 __func__, ret, ppl_conf->mismatch_count,
1185 		 ppl_conf->recovered_entries);
1186 	return ret;
1187 }
1188 
1189 static int ppl_load(struct ppl_conf *ppl_conf)
1190 {
1191 	int ret = 0;
1192 	u32 signature = 0;
1193 	bool signature_set = false;
1194 	int i;
1195 
1196 	for (i = 0; i < ppl_conf->count; i++) {
1197 		struct ppl_log *log = &ppl_conf->child_logs[i];
1198 
1199 		/* skip missing drive */
1200 		if (!log->rdev)
1201 			continue;
1202 
1203 		ret = ppl_load_distributed(log);
1204 		if (ret)
1205 			break;
1206 
1207 		/*
1208 		 * For external metadata we can't check if the signature is
1209 		 * correct on a single drive, but we can check if it is the same
1210 		 * on all drives.
1211 		 */
1212 		if (ppl_conf->mddev->external) {
1213 			if (!signature_set) {
1214 				signature = ppl_conf->signature;
1215 				signature_set = true;
1216 			} else if (signature != ppl_conf->signature) {
1217 				pr_warn("md/raid:%s: PPL header signature does not match on all member drives\n",
1218 					mdname(ppl_conf->mddev));
1219 				ret = -EINVAL;
1220 				break;
1221 			}
1222 		}
1223 	}
1224 
1225 	pr_debug("%s: return: %d mismatch_count: %d recovered_entries: %d\n",
1226 		 __func__, ret, ppl_conf->mismatch_count,
1227 		 ppl_conf->recovered_entries);
1228 	return ret;
1229 }
1230 
1231 static void __ppl_exit_log(struct ppl_conf *ppl_conf)
1232 {
1233 	clear_bit(MD_HAS_PPL, &ppl_conf->mddev->flags);
1234 	clear_bit(MD_HAS_MULTIPLE_PPLS, &ppl_conf->mddev->flags);
1235 
1236 	kfree(ppl_conf->child_logs);
1237 
1238 	bioset_exit(&ppl_conf->bs);
1239 	bioset_exit(&ppl_conf->flush_bs);
1240 	mempool_exit(&ppl_conf->io_pool);
1241 	kmem_cache_destroy(ppl_conf->io_kc);
1242 
1243 	kfree(ppl_conf);
1244 }
1245 
1246 void ppl_exit_log(struct r5conf *conf)
1247 {
1248 	struct ppl_conf *ppl_conf = conf->log_private;
1249 
1250 	if (ppl_conf) {
1251 		__ppl_exit_log(ppl_conf);
1252 		conf->log_private = NULL;
1253 	}
1254 }
1255 
1256 static int ppl_validate_rdev(struct md_rdev *rdev)
1257 {
1258 	char b[BDEVNAME_SIZE];
1259 	int ppl_data_sectors;
1260 	int ppl_size_new;
1261 
1262 	/*
1263 	 * The configured PPL size must be enough to store
1264 	 * the header and (at the very least) partial parity
1265 	 * for one stripe. Round it down to ensure the data
1266 	 * space is cleanly divisible by stripe size.
1267 	 */
1268 	ppl_data_sectors = rdev->ppl.size - (PPL_HEADER_SIZE >> 9);
1269 
1270 	if (ppl_data_sectors > 0)
1271 		ppl_data_sectors = rounddown(ppl_data_sectors,
1272 				RAID5_STRIPE_SECTORS((struct r5conf *)rdev->mddev->private));
1273 
1274 	if (ppl_data_sectors <= 0) {
1275 		pr_warn("md/raid:%s: PPL space too small on %s\n",
1276 			mdname(rdev->mddev), bdevname(rdev->bdev, b));
1277 		return -ENOSPC;
1278 	}
1279 
1280 	ppl_size_new = ppl_data_sectors + (PPL_HEADER_SIZE >> 9);
1281 
1282 	if ((rdev->ppl.sector < rdev->data_offset &&
1283 	     rdev->ppl.sector + ppl_size_new > rdev->data_offset) ||
1284 	    (rdev->ppl.sector >= rdev->data_offset &&
1285 	     rdev->data_offset + rdev->sectors > rdev->ppl.sector)) {
1286 		pr_warn("md/raid:%s: PPL space overlaps with data on %s\n",
1287 			mdname(rdev->mddev), bdevname(rdev->bdev, b));
1288 		return -EINVAL;
1289 	}
1290 
1291 	if (!rdev->mddev->external &&
1292 	    ((rdev->ppl.offset > 0 && rdev->ppl.offset < (rdev->sb_size >> 9)) ||
1293 	     (rdev->ppl.offset <= 0 && rdev->ppl.offset + ppl_size_new > 0))) {
1294 		pr_warn("md/raid:%s: PPL space overlaps with superblock on %s\n",
1295 			mdname(rdev->mddev), bdevname(rdev->bdev, b));
1296 		return -EINVAL;
1297 	}
1298 
1299 	rdev->ppl.size = ppl_size_new;
1300 
1301 	return 0;
1302 }
1303 
1304 static void ppl_init_child_log(struct ppl_log *log, struct md_rdev *rdev)
1305 {
1306 	struct request_queue *q;
1307 
1308 	if ((rdev->ppl.size << 9) >= (PPL_SPACE_SIZE +
1309 				      PPL_HEADER_SIZE) * 2) {
1310 		log->use_multippl = true;
1311 		set_bit(MD_HAS_MULTIPLE_PPLS,
1312 			&log->ppl_conf->mddev->flags);
1313 		log->entry_space = PPL_SPACE_SIZE;
1314 	} else {
1315 		log->use_multippl = false;
1316 		log->entry_space = (log->rdev->ppl.size << 9) -
1317 				   PPL_HEADER_SIZE;
1318 	}
1319 	log->next_io_sector = rdev->ppl.sector;
1320 
1321 	q = bdev_get_queue(rdev->bdev);
1322 	if (test_bit(QUEUE_FLAG_WC, &q->queue_flags))
1323 		log->wb_cache_on = true;
1324 }
1325 
1326 int ppl_init_log(struct r5conf *conf)
1327 {
1328 	struct ppl_conf *ppl_conf;
1329 	struct mddev *mddev = conf->mddev;
1330 	int ret = 0;
1331 	int max_disks;
1332 	int i;
1333 
1334 	pr_debug("md/raid:%s: enabling distributed Partial Parity Log\n",
1335 		 mdname(conf->mddev));
1336 
1337 	if (PAGE_SIZE != 4096)
1338 		return -EINVAL;
1339 
1340 	if (mddev->level != 5) {
1341 		pr_warn("md/raid:%s PPL is not compatible with raid level %d\n",
1342 			mdname(mddev), mddev->level);
1343 		return -EINVAL;
1344 	}
1345 
1346 	if (mddev->bitmap_info.file || mddev->bitmap_info.offset) {
1347 		pr_warn("md/raid:%s PPL is not compatible with bitmap\n",
1348 			mdname(mddev));
1349 		return -EINVAL;
1350 	}
1351 
1352 	if (test_bit(MD_HAS_JOURNAL, &mddev->flags)) {
1353 		pr_warn("md/raid:%s PPL is not compatible with journal\n",
1354 			mdname(mddev));
1355 		return -EINVAL;
1356 	}
1357 
1358 	max_disks = sizeof_field(struct ppl_log, disk_flush_bitmap) *
1359 		BITS_PER_BYTE;
1360 	if (conf->raid_disks > max_disks) {
1361 		pr_warn("md/raid:%s PPL doesn't support over %d disks in the array\n",
1362 			mdname(mddev), max_disks);
1363 		return -EINVAL;
1364 	}
1365 
1366 	ppl_conf = kzalloc(sizeof(struct ppl_conf), GFP_KERNEL);
1367 	if (!ppl_conf)
1368 		return -ENOMEM;
1369 
1370 	ppl_conf->mddev = mddev;
1371 
1372 	ppl_conf->io_kc = KMEM_CACHE(ppl_io_unit, 0);
1373 	if (!ppl_conf->io_kc) {
1374 		ret = -ENOMEM;
1375 		goto err;
1376 	}
1377 
1378 	ret = mempool_init(&ppl_conf->io_pool, conf->raid_disks, ppl_io_pool_alloc,
1379 			   ppl_io_pool_free, ppl_conf->io_kc);
1380 	if (ret)
1381 		goto err;
1382 
1383 	ret = bioset_init(&ppl_conf->bs, conf->raid_disks, 0, BIOSET_NEED_BVECS);
1384 	if (ret)
1385 		goto err;
1386 
1387 	ret = bioset_init(&ppl_conf->flush_bs, conf->raid_disks, 0, 0);
1388 	if (ret)
1389 		goto err;
1390 
1391 	ppl_conf->count = conf->raid_disks;
1392 	ppl_conf->child_logs = kcalloc(ppl_conf->count, sizeof(struct ppl_log),
1393 				       GFP_KERNEL);
1394 	if (!ppl_conf->child_logs) {
1395 		ret = -ENOMEM;
1396 		goto err;
1397 	}
1398 
1399 	atomic64_set(&ppl_conf->seq, 0);
1400 	INIT_LIST_HEAD(&ppl_conf->no_mem_stripes);
1401 	spin_lock_init(&ppl_conf->no_mem_stripes_lock);
1402 
1403 	if (!mddev->external) {
1404 		ppl_conf->signature = ~crc32c_le(~0, mddev->uuid, sizeof(mddev->uuid));
1405 		ppl_conf->block_size = 512;
1406 	} else {
1407 		ppl_conf->block_size = queue_logical_block_size(mddev->queue);
1408 	}
1409 
1410 	for (i = 0; i < ppl_conf->count; i++) {
1411 		struct ppl_log *log = &ppl_conf->child_logs[i];
1412 		/* Array has not started so rcu dereference is safe */
1413 		struct md_rdev *rdev =
1414 			rcu_dereference_protected(conf->disks[i].rdev, 1);
1415 
1416 		mutex_init(&log->io_mutex);
1417 		spin_lock_init(&log->io_list_lock);
1418 		INIT_LIST_HEAD(&log->io_list);
1419 
1420 		log->ppl_conf = ppl_conf;
1421 		log->rdev = rdev;
1422 
1423 		if (rdev) {
1424 			ret = ppl_validate_rdev(rdev);
1425 			if (ret)
1426 				goto err;
1427 
1428 			ppl_init_child_log(log, rdev);
1429 		}
1430 	}
1431 
1432 	/* load and possibly recover the logs from the member disks */
1433 	ret = ppl_load(ppl_conf);
1434 
1435 	if (ret) {
1436 		goto err;
1437 	} else if (!mddev->pers && mddev->recovery_cp == 0 &&
1438 		   ppl_conf->recovered_entries > 0 &&
1439 		   ppl_conf->mismatch_count == 0) {
1440 		/*
1441 		 * If we are starting a dirty array and the recovery succeeds
1442 		 * without any issues, set the array as clean.
1443 		 */
1444 		mddev->recovery_cp = MaxSector;
1445 		set_bit(MD_SB_CHANGE_CLEAN, &mddev->sb_flags);
1446 	} else if (mddev->pers && ppl_conf->mismatch_count > 0) {
1447 		/* no mismatch allowed when enabling PPL for a running array */
1448 		ret = -EINVAL;
1449 		goto err;
1450 	}
1451 
1452 	conf->log_private = ppl_conf;
1453 	set_bit(MD_HAS_PPL, &ppl_conf->mddev->flags);
1454 
1455 	return 0;
1456 err:
1457 	__ppl_exit_log(ppl_conf);
1458 	return ret;
1459 }
1460 
1461 int ppl_modify_log(struct r5conf *conf, struct md_rdev *rdev, bool add)
1462 {
1463 	struct ppl_conf *ppl_conf = conf->log_private;
1464 	struct ppl_log *log;
1465 	int ret = 0;
1466 	char b[BDEVNAME_SIZE];
1467 
1468 	if (!rdev)
1469 		return -EINVAL;
1470 
1471 	pr_debug("%s: disk: %d operation: %s dev: %s\n",
1472 		 __func__, rdev->raid_disk, add ? "add" : "remove",
1473 		 bdevname(rdev->bdev, b));
1474 
1475 	if (rdev->raid_disk < 0)
1476 		return 0;
1477 
1478 	if (rdev->raid_disk >= ppl_conf->count)
1479 		return -ENODEV;
1480 
1481 	log = &ppl_conf->child_logs[rdev->raid_disk];
1482 
1483 	mutex_lock(&log->io_mutex);
1484 	if (add) {
1485 		ret = ppl_validate_rdev(rdev);
1486 		if (!ret) {
1487 			log->rdev = rdev;
1488 			ret = ppl_write_empty_header(log);
1489 			ppl_init_child_log(log, rdev);
1490 		}
1491 	} else {
1492 		log->rdev = NULL;
1493 	}
1494 	mutex_unlock(&log->io_mutex);
1495 
1496 	return ret;
1497 }
1498 
1499 static ssize_t
1500 ppl_write_hint_show(struct mddev *mddev, char *buf)
1501 {
1502 	return sprintf(buf, "%d\n", 0);
1503 }
1504 
1505 static ssize_t
1506 ppl_write_hint_store(struct mddev *mddev, const char *page, size_t len)
1507 {
1508 	struct r5conf *conf;
1509 	int err = 0;
1510 	unsigned short new;
1511 
1512 	if (len >= PAGE_SIZE)
1513 		return -EINVAL;
1514 	if (kstrtou16(page, 10, &new))
1515 		return -EINVAL;
1516 
1517 	err = mddev_lock(mddev);
1518 	if (err)
1519 		return err;
1520 
1521 	conf = mddev->private;
1522 	if (!conf)
1523 		err = -ENODEV;
1524 	else if (!raid5_has_ppl(conf) || !conf->log_private)
1525 		err = -EINVAL;
1526 
1527 	mddev_unlock(mddev);
1528 
1529 	return err ?: len;
1530 }
1531 
1532 struct md_sysfs_entry
1533 ppl_write_hint = __ATTR(ppl_write_hint, S_IRUGO | S_IWUSR,
1534 			ppl_write_hint_show,
1535 			ppl_write_hint_store);
1536