drivers/md/raid5-ppl.c

   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                         rdev = conf->disks[dd_idx].rdev;
 887                         if (!rdev || (!test_bit(In_sync, &rdev->flags) &&
 888                                       sector >= rdev->recovery_offset)) {
 889                                 pr_debug("%s:%*s data member disk %d missing\n",
 890                                          __func__, indent, "", dd_idx);
 891                                 update_parity = false;
 892                                 break;
 893                         }
 894
 895                         pr_debug("%s:%*s reading data member disk %s sector %llu\n",
 896                                  __func__, indent, "", bdevname(rdev->bdev, b),
 897                                  (unsigned long long)sector);
 898                         if (!sync_page_io(rdev, sector, block_size, page2,
 899                                         REQ_OP_READ, 0, false)) {
 900                                 md_error(mddev, rdev);
 901                                 pr_debug("%s:%*s read failed!\n", __func__,
 902                                          indent, "");
 903                                 ret = -EIO;
 904                                 goto out;
 905                         }
 906
 907                         ppl_xor(block_size, page1, page2);
 908
 909                         indent -= 2;
 910                 }
 911
 912                 if (!update_parity)
 913                         continue;
 914
 915                 if (pp_size > 0) {
 916                         pr_debug("%s:%*s reading pp disk sector %llu\n",
 917                                  __func__, indent, "",
 918                                  (unsigned long long)(ppl_sector + i));
 919                         if (!sync_page_io(log->rdev,
 920                                         ppl_sector - log->rdev->data_offset + i,
 921                                         block_size, page2, REQ_OP_READ, 0,
 922                                         false)) {
 923                                 pr_debug("%s:%*s read failed!\n", __func__,
 924                                          indent, "");
 925                                 md_error(mddev, log->rdev);
 926                                 ret = -EIO;
 927                                 goto out;
 928                         }
 929
 930                         ppl_xor(block_size, page1, page2);
 931                 }
 932
 933                 /* map raid sector to parity disk */
 934                 parity_sector = raid5_compute_sector(conf, r_sector_first + i,
 935                                 0, &disk, &sh);
 936                 BUG_ON(sh.pd_idx != le32_to_cpu(e->parity_disk));
 937                 parity_rdev = conf->disks[sh.pd_idx].rdev;
 938
 939                 BUG_ON(parity_rdev->bdev->bd_dev != log->rdev->bdev->bd_dev);
 940                 pr_debug("%s:%*s write parity at sector %llu, disk %s\n",
 941                          __func__, indent, "",
 942                          (unsigned long long)parity_sector,
 943                          bdevname(parity_rdev->bdev, b));
 944                 if (!sync_page_io(parity_rdev, parity_sector, block_size,
 945                                 page1, REQ_OP_WRITE, 0, false)) {
 946                         pr_debug("%s:%*s parity write error!\n", __func__,
 947                                  indent, "");
 948                         md_error(mddev, parity_rdev);
 949                         ret = -EIO;
 950                         goto out;
 951                 }
 952         }
 953 out:
 954         if (page1)
 955                 __free_page(page1);
 956         if (page2)
 957                 __free_page(page2);
 958         return ret;
 959 }
 960
 961 static int ppl_recover(struct ppl_log *log, struct ppl_header *pplhdr,
 962                        sector_t offset)
 963 {
 964         struct ppl_conf *ppl_conf = log->ppl_conf;
 965         struct md_rdev *rdev = log->rdev;
 966         struct mddev *mddev = rdev->mddev;
 967         sector_t ppl_sector = rdev->ppl.sector + offset +
 968                               (PPL_HEADER_SIZE >> 9);
 969         struct page *page;
 970         int i;
 971         int ret = 0;
 972
 973         page = alloc_page(GFP_KERNEL);
 974         if (!page)
 975                 return -ENOMEM;
 976
 977         /* iterate through all PPL entries saved */
 978         for (i = 0; i < le32_to_cpu(pplhdr->entries_count); i++) {
 979                 struct ppl_header_entry *e = &pplhdr->entries[i];
 980                 u32 pp_size = le32_to_cpu(e->pp_size);
 981                 sector_t sector = ppl_sector;
 982                 int ppl_entry_sectors = pp_size >> 9;
 983                 u32 crc, crc_stored;
 984
 985                 pr_debug("%s: disk: %d entry: %d ppl_sector: %llu pp_size: %u\n",
 986                          __func__, rdev->raid_disk, i,
 987                          (unsigned long long)ppl_sector, pp_size);
 988
 989                 crc = ~0;
 990                 crc_stored = le32_to_cpu(e->checksum);
 991
 992                 /* read parial parity for this entry and calculate its checksum */
 993                 while (pp_size) {
 994                         int s = pp_size > PAGE_SIZE ? PAGE_SIZE : pp_size;
 995
 996                         if (!sync_page_io(rdev, sector - rdev->data_offset,
 997                                         s, page, REQ_OP_READ, 0, false)) {
 998                                 md_error(mddev, rdev);
 999                                 ret = -EIO;
1000                                 goto out;
1001                         }
1002
1003                         crc = crc32c_le(crc, page_address(page), s);
1004
1005                         pp_size -= s;
1006                         sector += s >> 9;
1007                 }
1008
1009                 crc = ~crc;
1010
1011                 if (crc != crc_stored) {
1012                         /*
1013                          * Don't recover this entry if the checksum does not
1014                          * match, but keep going and try to recover other
1015                          * entries.
1016                          */
1017                         pr_debug("%s: ppl entry crc does not match: stored: 0x%x calculated: 0x%x\n",
1018                                  __func__, crc_stored, crc);
1019                         ppl_conf->mismatch_count++;
1020                 } else {
1021                         ret = ppl_recover_entry(log, e, ppl_sector);
1022                         if (ret)
1023                                 goto out;
1024                         ppl_conf->recovered_entries++;
1025                 }
1026
1027                 ppl_sector += ppl_entry_sectors;
1028         }
1029
1030         /* flush the disk cache after recovery if necessary */
1031         ret = blkdev_issue_flush(rdev->bdev);
1032 out:
1033         __free_page(page);
1034         return ret;
1035 }
1036
1037 static int ppl_write_empty_header(struct ppl_log *log)
1038 {
1039         struct page *page;
1040         struct ppl_header *pplhdr;
1041         struct md_rdev *rdev = log->rdev;
1042         int ret = 0;
1043
1044         pr_debug("%s: disk: %d ppl_sector: %llu\n", __func__,
1045                  rdev->raid_disk, (unsigned long long)rdev->ppl.sector);
1046
1047         page = alloc_page(GFP_NOIO | __GFP_ZERO);
1048         if (!page)
1049                 return -ENOMEM;
1050
1051         pplhdr = page_address(page);
1052         /* zero out PPL space to avoid collision with old PPLs */
1053         blkdev_issue_zeroout(rdev->bdev, rdev->ppl.sector,
1054                             log->rdev->ppl.size, GFP_NOIO, 0);
1055         memset(pplhdr->reserved, 0xff, PPL_HDR_RESERVED);
1056         pplhdr->signature = cpu_to_le32(log->ppl_conf->signature);
1057         pplhdr->checksum = cpu_to_le32(~crc32c_le(~0, pplhdr, PAGE_SIZE));
1058
1059         if (!sync_page_io(rdev, rdev->ppl.sector - rdev->data_offset,
1060                           PPL_HEADER_SIZE, page, REQ_OP_WRITE | REQ_SYNC |
1061                           REQ_FUA, 0, false)) {
1062                 md_error(rdev->mddev, rdev);
1063                 ret = -EIO;
1064         }
1065
1066         __free_page(page);
1067         return ret;
1068 }
1069
1070 static int ppl_load_distributed(struct ppl_log *log)
1071 {
1072         struct ppl_conf *ppl_conf = log->ppl_conf;
1073         struct md_rdev *rdev = log->rdev;
1074         struct mddev *mddev = rdev->mddev;
1075         struct page *page, *page2;
1076         struct ppl_header *pplhdr = NULL, *prev_pplhdr = NULL;
1077         u32 crc, crc_stored;
1078         u32 signature;
1079         int ret = 0, i;
1080         sector_t pplhdr_offset = 0, prev_pplhdr_offset = 0;
1081
1082         pr_debug("%s: disk: %d\n", __func__, rdev->raid_disk);
1083         /* read PPL headers, find the recent one */
1084         page = alloc_page(GFP_KERNEL);
1085         if (!page)
1086                 return -ENOMEM;
1087
1088         page2 = alloc_page(GFP_KERNEL);
1089         if (!page2) {
1090                 __free_page(page);
1091                 return -ENOMEM;
1092         }
1093
1094         /* searching ppl area for latest ppl */
1095         while (pplhdr_offset < rdev->ppl.size - (PPL_HEADER_SIZE >> 9)) {
1096                 if (!sync_page_io(rdev,
1097                                   rdev->ppl.sector - rdev->data_offset +
1098                                   pplhdr_offset, PAGE_SIZE, page, REQ_OP_READ,
1099                                   0, false)) {
1100                         md_error(mddev, rdev);
1101                         ret = -EIO;
1102                         /* if not able to read - don't recover any PPL */
1103                         pplhdr = NULL;
1104                         break;
1105                 }
1106                 pplhdr = page_address(page);
1107
1108                 /* check header validity */
1109                 crc_stored = le32_to_cpu(pplhdr->checksum);
1110                 pplhdr->checksum = 0;
1111                 crc = ~crc32c_le(~0, pplhdr, PAGE_SIZE);
1112
1113                 if (crc_stored != crc) {
1114                         pr_debug("%s: ppl header crc does not match: stored: 0x%x calculated: 0x%x (offset: %llu)\n",
1115                                  __func__, crc_stored, crc,
1116                                  (unsigned long long)pplhdr_offset);
1117                         pplhdr = prev_pplhdr;
1118                         pplhdr_offset = prev_pplhdr_offset;
1119                         break;
1120                 }
1121
1122                 signature = le32_to_cpu(pplhdr->signature);
1123
1124                 if (mddev->external) {
1125                         /*
1126                          * For external metadata the header signature is set and
1127                          * validated in userspace.
1128                          */
1129                         ppl_conf->signature = signature;
1130                 } else if (ppl_conf->signature != signature) {
1131                         pr_debug("%s: ppl header signature does not match: stored: 0x%x configured: 0x%x (offset: %llu)\n",
1132                                  __func__, signature, ppl_conf->signature,
1133                                  (unsigned long long)pplhdr_offset);
1134                         pplhdr = prev_pplhdr;
1135                         pplhdr_offset = prev_pplhdr_offset;
1136                         break;
1137                 }
1138
1139                 if (prev_pplhdr && le64_to_cpu(prev_pplhdr->generation) >
1140                     le64_to_cpu(pplhdr->generation)) {
1141                         /* previous was newest */
1142                         pplhdr = prev_pplhdr;
1143                         pplhdr_offset = prev_pplhdr_offset;
1144                         break;
1145                 }
1146
1147                 prev_pplhdr_offset = pplhdr_offset;
1148                 prev_pplhdr = pplhdr;
1149
1150                 swap(page, page2);
1151
1152                 /* calculate next potential ppl offset */
1153                 for (i = 0; i < le32_to_cpu(pplhdr->entries_count); i++)
1154                         pplhdr_offset +=
1155                             le32_to_cpu(pplhdr->entries[i].pp_size) >> 9;
1156                 pplhdr_offset += PPL_HEADER_SIZE >> 9;
1157         }
1158
1159         /* no valid ppl found */
1160         if (!pplhdr)
1161                 ppl_conf->mismatch_count++;
1162         else
1163                 pr_debug("%s: latest PPL found at offset: %llu, with generation: %llu\n",
1164                     __func__, (unsigned long long)pplhdr_offset,
1165                     le64_to_cpu(pplhdr->generation));
1166
1167         /* attempt to recover from log if we are starting a dirty array */
1168         if (pplhdr && !mddev->pers && mddev->recovery_cp != MaxSector)
1169                 ret = ppl_recover(log, pplhdr, pplhdr_offset);
1170
1171         /* write empty header if we are starting the array */
1172         if (!ret && !mddev->pers)
1173                 ret = ppl_write_empty_header(log);
1174
1175         __free_page(page);
1176         __free_page(page2);
1177
1178         pr_debug("%s: return: %d mismatch_count: %d recovered_entries: %d\n",
1179                  __func__, ret, ppl_conf->mismatch_count,
1180                  ppl_conf->recovered_entries);
1181         return ret;
1182 }
1183
1184 static int ppl_load(struct ppl_conf *ppl_conf)
1185 {
1186         int ret = 0;
1187         u32 signature = 0;
1188         bool signature_set = false;
1189         int i;
1190
1191         for (i = 0; i < ppl_conf->count; i++) {
1192                 struct ppl_log *log = &ppl_conf->child_logs[i];
1193
1194                 /* skip missing drive */
1195                 if (!log->rdev)
1196                         continue;
1197
1198                 ret = ppl_load_distributed(log);
1199                 if (ret)
1200                         break;
1201
1202                 /*
1203                  * For external metadata we can't check if the signature is
1204                  * correct on a single drive, but we can check if it is the same
1205                  * on all drives.
1206                  */
1207                 if (ppl_conf->mddev->external) {
1208                         if (!signature_set) {
1209                                 signature = ppl_conf->signature;
1210                                 signature_set = true;
1211                         } else if (signature != ppl_conf->signature) {
1212                                 pr_warn("md/raid:%s: PPL header signature does not match on all member drives\n",
1213                                         mdname(ppl_conf->mddev));
1214                                 ret = -EINVAL;
1215                                 break;
1216                         }
1217                 }
1218         }
1219
1220         pr_debug("%s: return: %d mismatch_count: %d recovered_entries: %d\n",
1221                  __func__, ret, ppl_conf->mismatch_count,
1222                  ppl_conf->recovered_entries);
1223         return ret;
1224 }
1225
1226 static void __ppl_exit_log(struct ppl_conf *ppl_conf)
1227 {
1228         clear_bit(MD_HAS_PPL, &ppl_conf->mddev->flags);
1229         clear_bit(MD_HAS_MULTIPLE_PPLS, &ppl_conf->mddev->flags);
1230
1231         kfree(ppl_conf->child_logs);
1232
1233         bioset_exit(&ppl_conf->bs);
1234         bioset_exit(&ppl_conf->flush_bs);
1235         mempool_exit(&ppl_conf->io_pool);
1236         kmem_cache_destroy(ppl_conf->io_kc);
1237
1238         kfree(ppl_conf);
1239 }
1240
1241 void ppl_exit_log(struct r5conf *conf)
1242 {
1243         struct ppl_conf *ppl_conf = conf->log_private;
1244
1245         if (ppl_conf) {
1246                 __ppl_exit_log(ppl_conf);
1247                 conf->log_private = NULL;
1248         }
1249 }
1250
1251 static int ppl_validate_rdev(struct md_rdev *rdev)
1252 {
1253         char b[BDEVNAME_SIZE];
1254         int ppl_data_sectors;
1255         int ppl_size_new;
1256
1257         /*
1258          * The configured PPL size must be enough to store
1259          * the header and (at the very least) partial parity
1260          * for one stripe. Round it down to ensure the data
1261          * space is cleanly divisible by stripe size.
1262          */
1263         ppl_data_sectors = rdev->ppl.size - (PPL_HEADER_SIZE >> 9);
1264
1265         if (ppl_data_sectors > 0)
1266                 ppl_data_sectors = rounddown(ppl_data_sectors,
1267                                 RAID5_STRIPE_SECTORS((struct r5conf *)rdev->mddev->private));
1268
1269         if (ppl_data_sectors <= 0) {
1270                 pr_warn("md/raid:%s: PPL space too small on %s\n",
1271                         mdname(rdev->mddev), bdevname(rdev->bdev, b));
1272                 return -ENOSPC;
1273         }
1274
1275         ppl_size_new = ppl_data_sectors + (PPL_HEADER_SIZE >> 9);
1276
1277         if ((rdev->ppl.sector < rdev->data_offset &&
1278              rdev->ppl.sector + ppl_size_new > rdev->data_offset) ||
1279             (rdev->ppl.sector >= rdev->data_offset &&
1280              rdev->data_offset + rdev->sectors > rdev->ppl.sector)) {
1281                 pr_warn("md/raid:%s: PPL space overlaps with data on %s\n",
1282                         mdname(rdev->mddev), bdevname(rdev->bdev, b));
1283                 return -EINVAL;
1284         }
1285
1286         if (!rdev->mddev->external &&
1287             ((rdev->ppl.offset > 0 && rdev->ppl.offset < (rdev->sb_size >> 9)) ||
1288              (rdev->ppl.offset <= 0 && rdev->ppl.offset + ppl_size_new > 0))) {
1289                 pr_warn("md/raid:%s: PPL space overlaps with superblock on %s\n",
1290                         mdname(rdev->mddev), bdevname(rdev->bdev, b));
1291                 return -EINVAL;
1292         }
1293
1294         rdev->ppl.size = ppl_size_new;
1295
1296         return 0;
1297 }
1298
1299 static void ppl_init_child_log(struct ppl_log *log, struct md_rdev *rdev)
1300 {
1301         struct request_queue *q;
1302
1303         if ((rdev->ppl.size << 9) >= (PPL_SPACE_SIZE +
1304                                       PPL_HEADER_SIZE) * 2) {
1305                 log->use_multippl = true;
1306                 set_bit(MD_HAS_MULTIPLE_PPLS,
1307                         &log->ppl_conf->mddev->flags);
1308                 log->entry_space = PPL_SPACE_SIZE;
1309         } else {
1310                 log->use_multippl = false;
1311                 log->entry_space = (log->rdev->ppl.size << 9) -
1312                                    PPL_HEADER_SIZE;
1313         }
1314         log->next_io_sector = rdev->ppl.sector;
1315
1316         q = bdev_get_queue(rdev->bdev);
1317         if (test_bit(QUEUE_FLAG_WC, &q->queue_flags))
1318                 log->wb_cache_on = true;
1319 }
1320
1321 int ppl_init_log(struct r5conf *conf)
1322 {
1323         struct ppl_conf *ppl_conf;
1324         struct mddev *mddev = conf->mddev;
1325         int ret = 0;
1326         int max_disks;
1327         int i;
1328
1329         pr_debug("md/raid:%s: enabling distributed Partial Parity Log\n",
1330                  mdname(conf->mddev));
1331
1332         if (PAGE_SIZE != 4096)
1333                 return -EINVAL;
1334
1335         if (mddev->level != 5) {
1336                 pr_warn("md/raid:%s PPL is not compatible with raid level %d\n",
1337                         mdname(mddev), mddev->level);
1338                 return -EINVAL;
1339         }
1340
1341         if (mddev->bitmap_info.file || mddev->bitmap_info.offset) {
1342                 pr_warn("md/raid:%s PPL is not compatible with bitmap\n",
1343                         mdname(mddev));
1344                 return -EINVAL;
1345         }
1346
1347         if (test_bit(MD_HAS_JOURNAL, &mddev->flags)) {
1348                 pr_warn("md/raid:%s PPL is not compatible with journal\n",
1349                         mdname(mddev));
1350                 return -EINVAL;
1351         }
1352
1353         max_disks = sizeof_field(struct ppl_log, disk_flush_bitmap) *
1354                 BITS_PER_BYTE;
1355         if (conf->raid_disks > max_disks) {
1356                 pr_warn("md/raid:%s PPL doesn't support over %d disks in the array\n",
1357                         mdname(mddev), max_disks);
1358                 return -EINVAL;
1359         }
1360
1361         ppl_conf = kzalloc(sizeof(struct ppl_conf), GFP_KERNEL);
1362         if (!ppl_conf)
1363                 return -ENOMEM;
1364
1365         ppl_conf->mddev = mddev;
1366
1367         ppl_conf->io_kc = KMEM_CACHE(ppl_io_unit, 0);
1368         if (!ppl_conf->io_kc) {
1369                 ret = -ENOMEM;
1370                 goto err;
1371         }
1372
1373         ret = mempool_init(&ppl_conf->io_pool, conf->raid_disks, ppl_io_pool_alloc,
1374                            ppl_io_pool_free, ppl_conf->io_kc);
1375         if (ret)
1376                 goto err;
1377
1378         ret = bioset_init(&ppl_conf->bs, conf->raid_disks, 0, BIOSET_NEED_BVECS);
1379         if (ret)
1380                 goto err;
1381
1382         ret = bioset_init(&ppl_conf->flush_bs, conf->raid_disks, 0, 0);
1383         if (ret)
1384                 goto err;
1385
1386         ppl_conf->count = conf->raid_disks;
1387         ppl_conf->child_logs = kcalloc(ppl_conf->count, sizeof(struct ppl_log),
1388                                        GFP_KERNEL);
1389         if (!ppl_conf->child_logs) {
1390                 ret = -ENOMEM;
1391                 goto err;
1392         }
1393
1394         atomic64_set(&ppl_conf->seq, 0);
1395         INIT_LIST_HEAD(&ppl_conf->no_mem_stripes);
1396         spin_lock_init(&ppl_conf->no_mem_stripes_lock);
1397
1398         if (!mddev->external) {
1399                 ppl_conf->signature = ~crc32c_le(~0, mddev->uuid, sizeof(mddev->uuid));
1400                 ppl_conf->block_size = 512;
1401         } else {
1402                 ppl_conf->block_size = queue_logical_block_size(mddev->queue);
1403         }
1404
1405         for (i = 0; i < ppl_conf->count; i++) {
1406                 struct ppl_log *log = &ppl_conf->child_logs[i];
1407                 struct md_rdev *rdev = conf->disks[i].rdev;
1408
1409                 mutex_init(&log->io_mutex);
1410                 spin_lock_init(&log->io_list_lock);
1411                 INIT_LIST_HEAD(&log->io_list);
1412
1413                 log->ppl_conf = ppl_conf;
1414                 log->rdev = rdev;
1415
1416                 if (rdev) {
1417                         ret = ppl_validate_rdev(rdev);
1418                         if (ret)
1419                                 goto err;
1420
1421                         ppl_init_child_log(log, rdev);
1422                 }
1423         }
1424
1425         /* load and possibly recover the logs from the member disks */
1426         ret = ppl_load(ppl_conf);
1427
1428         if (ret) {
1429                 goto err;
1430         } else if (!mddev->pers && mddev->recovery_cp == 0 &&
1431                    ppl_conf->recovered_entries > 0 &&
1432                    ppl_conf->mismatch_count == 0) {
1433                 /*
1434                  * If we are starting a dirty array and the recovery succeeds
1435                  * without any issues, set the array as clean.
1436                  */
1437                 mddev->recovery_cp = MaxSector;
1438                 set_bit(MD_SB_CHANGE_CLEAN, &mddev->sb_flags);
1439         } else if (mddev->pers && ppl_conf->mismatch_count > 0) {
1440                 /* no mismatch allowed when enabling PPL for a running array */
1441                 ret = -EINVAL;
1442                 goto err;
1443         }
1444
1445         conf->log_private = ppl_conf;
1446         set_bit(MD_HAS_PPL, &ppl_conf->mddev->flags);
1447
1448         return 0;
1449 err:
1450         __ppl_exit_log(ppl_conf);
1451         return ret;
1452 }
1453
1454 int ppl_modify_log(struct r5conf *conf, struct md_rdev *rdev, bool add)
1455 {
1456         struct ppl_conf *ppl_conf = conf->log_private;
1457         struct ppl_log *log;
1458         int ret = 0;
1459         char b[BDEVNAME_SIZE];
1460
1461         if (!rdev)
1462                 return -EINVAL;
1463
1464         pr_debug("%s: disk: %d operation: %s dev: %s\n",
1465                  __func__, rdev->raid_disk, add ? "add" : "remove",
1466                  bdevname(rdev->bdev, b));
1467
1468         if (rdev->raid_disk < 0)
1469                 return 0;
1470
1471         if (rdev->raid_disk >= ppl_conf->count)
1472                 return -ENODEV;
1473
1474         log = &ppl_conf->child_logs[rdev->raid_disk];
1475
1476         mutex_lock(&log->io_mutex);
1477         if (add) {
1478                 ret = ppl_validate_rdev(rdev);
1479                 if (!ret) {
1480                         log->rdev = rdev;
1481                         ret = ppl_write_empty_header(log);
1482                         ppl_init_child_log(log, rdev);
1483                 }
1484         } else {
1485                 log->rdev = NULL;
1486         }
1487         mutex_unlock(&log->io_mutex);
1488
1489         return ret;
1490 }
1491
1492 static ssize_t
1493 ppl_write_hint_show(struct mddev *mddev, char *buf)
1494 {
1495         return sprintf(buf, "%d\n", 0);
1496 }
1497
1498 static ssize_t
1499 ppl_write_hint_store(struct mddev *mddev, const char *page, size_t len)
1500 {
1501         struct r5conf *conf;
1502         int err = 0;
1503         unsigned short new;
1504
1505         if (len >= PAGE_SIZE)
1506                 return -EINVAL;
1507         if (kstrtou16(page, 10, &new))
1508                 return -EINVAL;
1509
1510         err = mddev_lock(mddev);
1511         if (err)
1512                 return err;
1513
1514         conf = mddev->private;
1515         if (!conf)
1516                 err = -ENODEV;
1517         else if (!raid5_has_ppl(conf) || !conf->log_private)
1518                 err = -EINVAL;
1519
1520         mddev_unlock(mddev);
1521
1522         return err ?: len;
1523 }
1524
1525 struct md_sysfs_entry
1526 ppl_write_hint = __ATTR(ppl_write_hint, S_IRUGO | S_IWUSR,
1527                         ppl_write_hint_show,
1528                         ppl_write_hint_store);