drivers/md/dm-raid.c

   1 /*
   2  * Copyright (C) 2010-2011 Neil Brown
   3  * Copyright (C) 2010-2016 Red Hat, Inc. All rights reserved.
   4  *
   5  * This file is released under the GPL.
   6  */
   7
   8 #include <linux/slab.h>
   9 #include <linux/module.h>
  10
  11 #include "md.h"
  12 #include "raid1.h"
  13 #include "raid5.h"
  14 #include "raid10.h"
  15 #include "bitmap.h"
  16
  17 #include <linux/device-mapper.h>
  18
  19 #define DM_MSG_PREFIX "raid"
  20 #define MAX_RAID_DEVICES        253 /* md-raid kernel limit */
  21
  22 /*
  23  * Minimum sectors of free reshape space per raid device
  24  */
  25 #define MIN_FREE_RESHAPE_SPACE to_sector(4*4096)
  26
  27 static bool devices_handle_discard_safely = false;
  28
  29 /*
  30  * The following flags are used by dm-raid.c to set up the array state.
  31  * They must be cleared before md_run is called.
  32  */
  33 #define FirstUse 10             /* rdev flag */
  34
  35 struct raid_dev {
  36         /*
  37          * Two DM devices, one to hold metadata and one to hold the
  38          * actual data/parity.  The reason for this is to not confuse
  39          * ti->len and give more flexibility in altering size and
  40          * characteristics.
  41          *
  42          * While it is possible for this device to be associated
  43          * with a different physical device than the data_dev, it
  44          * is intended for it to be the same.
  45          *    |--------- Physical Device ---------|
  46          *    |- meta_dev -|------ data_dev ------|
  47          */
  48         struct dm_dev *meta_dev;
  49         struct dm_dev *data_dev;
  50         struct md_rdev rdev;
  51 };
  52
  53 /*
  54  * Bits for establishing rs->ctr_flags
  55  *
  56  * 1 = no flag value
  57  * 2 = flag with value
  58  */
  59 #define __CTR_FLAG_SYNC                 0  /* 1 */ /* Not with raid0! */
  60 #define __CTR_FLAG_NOSYNC               1  /* 1 */ /* Not with raid0! */
  61 #define __CTR_FLAG_REBUILD              2  /* 2 */ /* Not with raid0! */
  62 #define __CTR_FLAG_DAEMON_SLEEP         3  /* 2 */ /* Not with raid0! */
  63 #define __CTR_FLAG_MIN_RECOVERY_RATE    4  /* 2 */ /* Not with raid0! */
  64 #define __CTR_FLAG_MAX_RECOVERY_RATE    5  /* 2 */ /* Not with raid0! */
  65 #define __CTR_FLAG_MAX_WRITE_BEHIND     6  /* 2 */ /* Only with raid1! */
  66 #define __CTR_FLAG_WRITE_MOSTLY         7  /* 2 */ /* Only with raid1! */
  67 #define __CTR_FLAG_STRIPE_CACHE         8  /* 2 */ /* Only with raid4/5/6! */
  68 #define __CTR_FLAG_REGION_SIZE          9  /* 2 */ /* Not with raid0! */
  69 #define __CTR_FLAG_RAID10_COPIES        10 /* 2 */ /* Only with raid10 */
  70 #define __CTR_FLAG_RAID10_FORMAT        11 /* 2 */ /* Only with raid10 */
  71 /* New for v1.9.0 */
  72 #define __CTR_FLAG_DELTA_DISKS          12 /* 2 */ /* Only with reshapable raid4/5/6/10! */
  73 #define __CTR_FLAG_DATA_OFFSET          13 /* 2 */ /* Only with reshapable raid4/5/6/10! */
  74 #define __CTR_FLAG_RAID10_USE_NEAR_SETS 14 /* 2 */ /* Only with raid10! */
  75
  76 /*
  77  * Flags for rs->ctr_flags field.
  78  */
  79 #define CTR_FLAG_SYNC                   (1 << __CTR_FLAG_SYNC)
  80 #define CTR_FLAG_NOSYNC                 (1 << __CTR_FLAG_NOSYNC)
  81 #define CTR_FLAG_REBUILD                (1 << __CTR_FLAG_REBUILD)
  82 #define CTR_FLAG_DAEMON_SLEEP           (1 << __CTR_FLAG_DAEMON_SLEEP)
  83 #define CTR_FLAG_MIN_RECOVERY_RATE      (1 << __CTR_FLAG_MIN_RECOVERY_RATE)
  84 #define CTR_FLAG_MAX_RECOVERY_RATE      (1 << __CTR_FLAG_MAX_RECOVERY_RATE)
  85 #define CTR_FLAG_MAX_WRITE_BEHIND       (1 << __CTR_FLAG_MAX_WRITE_BEHIND)
  86 #define CTR_FLAG_WRITE_MOSTLY           (1 << __CTR_FLAG_WRITE_MOSTLY)
  87 #define CTR_FLAG_STRIPE_CACHE           (1 << __CTR_FLAG_STRIPE_CACHE)
  88 #define CTR_FLAG_REGION_SIZE            (1 << __CTR_FLAG_REGION_SIZE)
  89 #define CTR_FLAG_RAID10_COPIES          (1 << __CTR_FLAG_RAID10_COPIES)
  90 #define CTR_FLAG_RAID10_FORMAT          (1 << __CTR_FLAG_RAID10_FORMAT)
  91 #define CTR_FLAG_DELTA_DISKS            (1 << __CTR_FLAG_DELTA_DISKS)
  92 #define CTR_FLAG_DATA_OFFSET            (1 << __CTR_FLAG_DATA_OFFSET)
  93 #define CTR_FLAG_RAID10_USE_NEAR_SETS   (1 << __CTR_FLAG_RAID10_USE_NEAR_SETS)
  94
  95 /*
  96  * Definitions of various constructor flags to
  97  * be used in checks of valid / invalid flags
  98  * per raid level.
  99  */
 100 /* Define all any sync flags */
 101 #define CTR_FLAGS_ANY_SYNC              (CTR_FLAG_SYNC | CTR_FLAG_NOSYNC)
 102
 103 /* Define flags for options without argument (e.g. 'nosync') */
 104 #define CTR_FLAG_OPTIONS_NO_ARGS        (CTR_FLAGS_ANY_SYNC | \
 105                                          CTR_FLAG_RAID10_USE_NEAR_SETS)
 106
 107 /* Define flags for options with one argument (e.g. 'delta_disks +2') */
 108 #define CTR_FLAG_OPTIONS_ONE_ARG (CTR_FLAG_REBUILD | \
 109                                   CTR_FLAG_WRITE_MOSTLY | \
 110                                   CTR_FLAG_DAEMON_SLEEP | \
 111                                   CTR_FLAG_MIN_RECOVERY_RATE | \
 112                                   CTR_FLAG_MAX_RECOVERY_RATE | \
 113                                   CTR_FLAG_MAX_WRITE_BEHIND | \
 114                                   CTR_FLAG_STRIPE_CACHE | \
 115                                   CTR_FLAG_REGION_SIZE | \
 116                                   CTR_FLAG_RAID10_COPIES | \
 117                                   CTR_FLAG_RAID10_FORMAT | \
 118                                   CTR_FLAG_DELTA_DISKS | \
 119                                   CTR_FLAG_DATA_OFFSET)
 120
 121 /* Valid options definitions per raid level... */
 122
 123 /* "raid0" does only accept data offset */
 124 #define RAID0_VALID_FLAGS       (CTR_FLAG_DATA_OFFSET)
 125
 126 /* "raid1" does not accept stripe cache, data offset, delta_disks or any raid10 options */
 127 #define RAID1_VALID_FLAGS       (CTR_FLAGS_ANY_SYNC | \
 128                                  CTR_FLAG_REBUILD | \
 129                                  CTR_FLAG_WRITE_MOSTLY | \
 130                                  CTR_FLAG_DAEMON_SLEEP | \
 131                                  CTR_FLAG_MIN_RECOVERY_RATE | \
 132                                  CTR_FLAG_MAX_RECOVERY_RATE | \
 133                                  CTR_FLAG_MAX_WRITE_BEHIND | \
 134                                  CTR_FLAG_REGION_SIZE | \
 135                                  CTR_FLAG_DATA_OFFSET)
 136
 137 /* "raid10" does not accept any raid1 or stripe cache options */
 138 #define RAID10_VALID_FLAGS      (CTR_FLAGS_ANY_SYNC | \
 139                                  CTR_FLAG_REBUILD | \
 140                                  CTR_FLAG_DAEMON_SLEEP | \
 141                                  CTR_FLAG_MIN_RECOVERY_RATE | \
 142                                  CTR_FLAG_MAX_RECOVERY_RATE | \
 143                                  CTR_FLAG_REGION_SIZE | \
 144                                  CTR_FLAG_RAID10_COPIES | \
 145                                  CTR_FLAG_RAID10_FORMAT | \
 146                                  CTR_FLAG_DELTA_DISKS | \
 147                                  CTR_FLAG_DATA_OFFSET | \
 148                                  CTR_FLAG_RAID10_USE_NEAR_SETS)
 149
 150 /*
 151  * "raid4/5/6" do not accept any raid1 or raid10 specific options
 152  *
 153  * "raid6" does not accept "nosync", because it is not guaranteed
 154  * that both parity and q-syndrome are being written properly with
 155  * any writes
 156  */
 157 #define RAID45_VALID_FLAGS      (CTR_FLAGS_ANY_SYNC | \
 158                                  CTR_FLAG_REBUILD | \
 159                                  CTR_FLAG_DAEMON_SLEEP | \
 160                                  CTR_FLAG_MIN_RECOVERY_RATE | \
 161                                  CTR_FLAG_MAX_RECOVERY_RATE | \
 162                                  CTR_FLAG_MAX_WRITE_BEHIND | \
 163                                  CTR_FLAG_STRIPE_CACHE | \
 164                                  CTR_FLAG_REGION_SIZE | \
 165                                  CTR_FLAG_DELTA_DISKS | \
 166                                  CTR_FLAG_DATA_OFFSET)
 167
 168 #define RAID6_VALID_FLAGS       (CTR_FLAG_SYNC | \
 169                                  CTR_FLAG_REBUILD | \
 170                                  CTR_FLAG_DAEMON_SLEEP | \
 171                                  CTR_FLAG_MIN_RECOVERY_RATE | \
 172                                  CTR_FLAG_MAX_RECOVERY_RATE | \
 173                                  CTR_FLAG_MAX_WRITE_BEHIND | \
 174                                  CTR_FLAG_STRIPE_CACHE | \
 175                                  CTR_FLAG_REGION_SIZE | \
 176                                  CTR_FLAG_DELTA_DISKS | \
 177                                  CTR_FLAG_DATA_OFFSET)
 178 /* ...valid options definitions per raid level */
 179
 180 /*
 181  * Flags for rs->runtime_flags field
 182  * (RT_FLAG prefix meaning "runtime flag")
 183  *
 184  * These are all internal and used to define runtime state,
 185  * e.g. to prevent another resume from preresume processing
 186  * the raid set all over again.
 187  */
 188 #define RT_FLAG_RS_PRERESUMED           0
 189 #define RT_FLAG_RS_RESUMED              1
 190 #define RT_FLAG_RS_BITMAP_LOADED        2
 191 #define RT_FLAG_UPDATE_SBS              3
 192 #define RT_FLAG_RESHAPE_RS              4
 193
 194 /* Array elements of 64 bit needed for rebuild/write_mostly bits */
 195 #define DISKS_ARRAY_ELEMS ((MAX_RAID_DEVICES + (sizeof(uint64_t) * 8 - 1)) / sizeof(uint64_t) / 8)
 196
 197 /*
 198  * raid set level, layout and chunk sectors backup/restore
 199  */
 200 struct rs_layout {
 201         int new_level;
 202         int new_layout;
 203         int new_chunk_sectors;
 204 };
 205
 206 struct raid_set {
 207         struct dm_target *ti;
 208
 209         uint32_t bitmap_loaded;
 210         uint32_t stripe_cache_entries;
 211         unsigned long ctr_flags;
 212         unsigned long runtime_flags;
 213
 214         uint64_t rebuild_disks[DISKS_ARRAY_ELEMS];
 215
 216         int raid_disks;
 217         int delta_disks;
 218         int data_offset;
 219         int raid10_copies;
 220
 221         struct mddev md;
 222         struct raid_type *raid_type;
 223         struct dm_target_callbacks callbacks;
 224
 225         struct raid_dev dev[0];
 226 };
 227
 228 static void rs_config_backup(struct raid_set *rs, struct rs_layout *l)
 229 {
 230         struct mddev *mddev = &rs->md;
 231
 232         l->new_level = mddev->new_level;
 233         l->new_layout = mddev->new_layout;
 234         l->new_chunk_sectors = mddev->new_chunk_sectors;
 235 }
 236
 237 static void rs_config_restore(struct raid_set *rs, struct rs_layout *l)
 238 {
 239         struct mddev *mddev = &rs->md;
 240
 241         mddev->new_level = l->new_level;
 242         mddev->new_layout = l->new_layout;
 243         mddev->new_chunk_sectors = l->new_chunk_sectors;
 244 }
 245
 246 /* raid10 algorithms (i.e. formats) */
 247 #define ALGORITHM_RAID10_DEFAULT        0
 248 #define ALGORITHM_RAID10_NEAR           1
 249 #define ALGORITHM_RAID10_OFFSET         2
 250 #define ALGORITHM_RAID10_FAR            3
 251
 252 /* Supported raid types and properties. */
 253 static struct raid_type {
 254         const char *name;               /* RAID algorithm. */
 255         const char *descr;              /* Descriptor text for logging. */
 256         const unsigned parity_devs;     /* # of parity devices. */
 257         const unsigned minimal_devs;    /* minimal # of devices in set. */
 258         const unsigned level;           /* RAID level. */
 259         const unsigned algorithm;       /* RAID algorithm. */
 260 } raid_types[] = {
 261         {"raid0",         "raid0 (striping)",                       0, 2, 0,  0 /* NONE */},
 262         {"raid1",         "raid1 (mirroring)",                      0, 2, 1,  0 /* NONE */},
 263         {"raid10_far",    "raid10 far (striped mirrors)",           0, 2, 10, ALGORITHM_RAID10_FAR},
 264         {"raid10_offset", "raid10 offset (striped mirrors)",        0, 2, 10, ALGORITHM_RAID10_OFFSET},
 265         {"raid10_near",   "raid10 near (striped mirrors)",          0, 2, 10, ALGORITHM_RAID10_NEAR},
 266         {"raid10",        "raid10 (striped mirrors)",               0, 2, 10, ALGORITHM_RAID10_DEFAULT},
 267         {"raid4",         "raid4 (dedicated last parity disk)",     1, 2, 4,  ALGORITHM_PARITY_N}, /* raid4 layout = raid5_n */
 268         {"raid5_n",       "raid5 (dedicated last parity disk)",     1, 2, 5,  ALGORITHM_PARITY_N},
 269         {"raid5_ls",      "raid5 (left symmetric)",                 1, 2, 5,  ALGORITHM_LEFT_SYMMETRIC},
 270         {"raid5_rs",      "raid5 (right symmetric)",                1, 2, 5,  ALGORITHM_RIGHT_SYMMETRIC},
 271         {"raid5_la",      "raid5 (left asymmetric)",                1, 2, 5,  ALGORITHM_LEFT_ASYMMETRIC},
 272         {"raid5_ra",      "raid5 (right asymmetric)",               1, 2, 5,  ALGORITHM_RIGHT_ASYMMETRIC},
 273         {"raid6_zr",      "raid6 (zero restart)",                   2, 4, 6,  ALGORITHM_ROTATING_ZERO_RESTART},
 274         {"raid6_nr",      "raid6 (N restart)",                      2, 4, 6,  ALGORITHM_ROTATING_N_RESTART},
 275         {"raid6_nc",      "raid6 (N continue)",                     2, 4, 6,  ALGORITHM_ROTATING_N_CONTINUE},
 276         {"raid6_n_6",     "raid6 (dedicated parity/Q n/6)",         2, 4, 6,  ALGORITHM_PARITY_N_6},
 277         {"raid6_ls_6",    "raid6 (left symmetric dedicated Q 6)",   2, 4, 6,  ALGORITHM_LEFT_SYMMETRIC_6},
 278         {"raid6_rs_6",    "raid6 (right symmetric dedicated Q 6)",  2, 4, 6,  ALGORITHM_RIGHT_SYMMETRIC_6},
 279         {"raid6_la_6",    "raid6 (left asymmetric dedicated Q 6)",  2, 4, 6,  ALGORITHM_LEFT_ASYMMETRIC_6},
 280         {"raid6_ra_6",    "raid6 (right asymmetric dedicated Q 6)", 2, 4, 6,  ALGORITHM_RIGHT_ASYMMETRIC_6}
 281 };
 282
 283 /* True, if @v is in inclusive range [@min, @max] */
 284 static bool __within_range(long v, long min, long max)
 285 {
 286         return v >= min && v <= max;
 287 }
 288
 289 /* All table line arguments are defined here */
 290 static struct arg_name_flag {
 291         const unsigned long flag;
 292         const char *name;
 293 } __arg_name_flags[] = {
 294         { CTR_FLAG_SYNC, "sync"},
 295         { CTR_FLAG_NOSYNC, "nosync"},
 296         { CTR_FLAG_REBUILD, "rebuild"},
 297         { CTR_FLAG_DAEMON_SLEEP, "daemon_sleep"},
 298         { CTR_FLAG_MIN_RECOVERY_RATE, "min_recovery_rate"},
 299         { CTR_FLAG_MAX_RECOVERY_RATE, "max_recovery_rate"},
 300         { CTR_FLAG_MAX_WRITE_BEHIND, "max_write_behind"},
 301         { CTR_FLAG_WRITE_MOSTLY, "writemostly"},
 302         { CTR_FLAG_STRIPE_CACHE, "stripe_cache"},
 303         { CTR_FLAG_REGION_SIZE, "region_size"},
 304         { CTR_FLAG_RAID10_COPIES, "raid10_copies"},
 305         { CTR_FLAG_RAID10_FORMAT, "raid10_format"},
 306         { CTR_FLAG_DATA_OFFSET, "data_offset"},
 307         { CTR_FLAG_DELTA_DISKS, "delta_disks"},
 308         { CTR_FLAG_RAID10_USE_NEAR_SETS, "raid10_use_near_sets"},
 309 };
 310
 311 /* Return argument name string for given @flag */
 312 static const char *dm_raid_arg_name_by_flag(const uint32_t flag)
 313 {
 314         if (hweight32(flag) == 1) {
 315                 struct arg_name_flag *anf = __arg_name_flags + ARRAY_SIZE(__arg_name_flags);
 316
 317                 while (anf-- > __arg_name_flags)
 318                         if (flag & anf->flag)
 319                                 return anf->name;
 320
 321         } else
 322                 DMERR("%s called with more than one flag!", __func__);
 323
 324         return NULL;
 325 }
 326
 327 /*
 328  * bool helpers to test for various raid levels of a raid set,
 329  * is. it's level as reported by the superblock rather than
 330  * the requested raid_type passed to the constructor.
 331  */
 332 /* Return true, if raid set in @rs is raid0 */
 333 static bool rs_is_raid0(struct raid_set *rs)
 334 {
 335         return !rs->md.level;
 336 }
 337
 338 /* Return true, if raid set in @rs is raid1 */
 339 static bool rs_is_raid1(struct raid_set *rs)
 340 {
 341         return rs->md.level == 1;
 342 }
 343
 344 /* Return true, if raid set in @rs is raid10 */
 345 static bool rs_is_raid10(struct raid_set *rs)
 346 {
 347         return rs->md.level == 10;
 348 }
 349
 350 /* Return true, if raid set in @rs is level 4, 5 or 6 */
 351 static bool rs_is_raid456(struct raid_set *rs)
 352 {
 353         return __within_range(rs->md.level, 4, 6);
 354 }
 355
 356 /* Return true, if raid set in @rs is reshapable */
 357 static unsigned int __is_raid10_far(int layout);
 358 static bool rs_is_reshapable(struct raid_set *rs)
 359 {
 360         return rs_is_raid456(rs) ||
 361                (rs_is_raid10(rs) && !__is_raid10_far(rs->md.new_layout));
 362 }
 363
 364 /* Return true, if raid set in @rs is recovering */
 365 static bool rs_is_recovering(struct raid_set *rs)
 366 {
 367         smp_rmb();
 368         return rs->md.recovery_cp != MaxSector;
 369 }
 370
 371 /* Return true, if raid set in @rs is reshaping */
 372 static bool rs_is_reshaping(struct raid_set *rs)
 373 {
 374         smp_rmb();
 375         return rs->md.reshape_position != MaxSector;
 376 }
 377
 378 /*
 379  * bool helpers to test for various raid levels of a raid type
 380  */
 381
 382 /* Return true, if raid type in @rt is raid0 */
 383 static bool rt_is_raid0(struct raid_type *rt)
 384 {
 385         return !rt->level;
 386 }
 387
 388 /* Return true, if raid type in @rt is raid1 */
 389 static bool rt_is_raid1(struct raid_type *rt)
 390 {
 391         return rt->level == 1;
 392 }
 393
 394 /* Return true, if raid type in @rt is raid10 */
 395 static bool rt_is_raid10(struct raid_type *rt)
 396 {
 397         return rt->level == 10;
 398 }
 399
 400 /* Return true, if raid type in @rt is raid4/5 */
 401 static bool rt_is_raid45(struct raid_type *rt)
 402 {
 403         return __within_range(rt->level, 4, 5);
 404 }
 405
 406 /* Return true, if raid type in @rt is raid6 */
 407 static bool rt_is_raid6(struct raid_type *rt)
 408 {
 409         return rt->level == 6;
 410 }
 411
 412 /* Return true, if raid type in @rt is raid4/5/6 */
 413 static bool rt_is_raid456(struct raid_type *rt)
 414 {
 415         return __within_range(rt->level, 4, 6);
 416 }
 417 /* END: raid level bools */
 418
 419 /* Return valid ctr flags for the raid level of @rs */
 420 static unsigned long __valid_flags(struct raid_set *rs)
 421 {
 422         if (rt_is_raid0(rs->raid_type))
 423                 return RAID0_VALID_FLAGS;
 424         else if (rt_is_raid1(rs->raid_type))
 425                 return RAID1_VALID_FLAGS;
 426         else if (rt_is_raid10(rs->raid_type))
 427                 return RAID10_VALID_FLAGS;
 428         else if (rt_is_raid45(rs->raid_type))
 429                 return RAID45_VALID_FLAGS;
 430         else if (rt_is_raid6(rs->raid_type))
 431                 return RAID6_VALID_FLAGS;
 432
 433         return ~0;
 434 }
 435
 436 /*
 437  * Check for valid flags set on @rs
 438  *
 439  * Has to be called after parsing of the ctr flags!
 440  */
 441 static int rs_check_for_valid_flags(struct raid_set *rs)
 442 {
 443         if (rs->ctr_flags & ~__valid_flags(rs)) {
 444                 rs->ti->error = "Invalid flags combination";
 445                 return -EINVAL;
 446         }
 447
 448         return 0;
 449 }
 450
 451 /* MD raid10 bit definitions and helpers */
 452 #define RAID10_OFFSET                   (1 << 16) /* stripes with data copies area adjacent on devices */
 453 #define RAID10_BROCKEN_USE_FAR_SETS     (1 << 17) /* Broken in raid10.c: use sets instead of whole stripe rotation */
 454 #define RAID10_USE_FAR_SETS             (1 << 18) /* Use sets instead of whole stripe rotation */
 455 #define RAID10_FAR_COPIES_SHIFT         8         /* raid10 # far copies shift (2nd byte of layout) */
 456
 457 /* Return md raid10 near copies for @layout */
 458 static unsigned int __raid10_near_copies(int layout)
 459 {
 460         return layout & 0xFF;
 461 }
 462
 463 /* Return md raid10 far copies for @layout */
 464 static unsigned int __raid10_far_copies(int layout)
 465 {
 466         return __raid10_near_copies(layout >> RAID10_FAR_COPIES_SHIFT);
 467 }
 468
 469 /* Return true if md raid10 offset for @layout */
 470 static unsigned int __is_raid10_offset(int layout)
 471 {
 472         return layout & RAID10_OFFSET;
 473 }
 474
 475 /* Return true if md raid10 near for @layout */
 476 static unsigned int __is_raid10_near(int layout)
 477 {
 478         return !__is_raid10_offset(layout) && __raid10_near_copies(layout) > 1;
 479 }
 480
 481 /* Return true if md raid10 far for @layout */
 482 static unsigned int __is_raid10_far(int layout)
 483 {
 484         return !__is_raid10_offset(layout) && __raid10_far_copies(layout) > 1;
 485 }
 486
 487 /* Return md raid10 layout string for @layout */
 488 static const char *raid10_md_layout_to_format(int layout)
 489 {
 490         /*
 491          * Bit 16 stands for "offset"
 492          * (i.e. adjacent stripes hold copies)
 493          *
 494          * Refer to MD's raid10.c for details
 495          */
 496         if (__is_raid10_offset(layout))
 497                 return "offset";
 498
 499         if (__raid10_near_copies(layout) > 1)
 500                 return "near";
 501
 502         WARN_ON(__raid10_far_copies(layout) < 2);
 503
 504         return "far";
 505 }
 506
 507 /* Return md raid10 algorithm for @name */
 508 static const int raid10_name_to_format(const char *name)
 509 {
 510         if (!strcasecmp(name, "near"))
 511                 return ALGORITHM_RAID10_NEAR;
 512         else if (!strcasecmp(name, "offset"))
 513                 return ALGORITHM_RAID10_OFFSET;
 514         else if (!strcasecmp(name, "far"))
 515                 return ALGORITHM_RAID10_FAR;
 516
 517         return -EINVAL;
 518 }
 519
 520 /* Return md raid10 copies for @layout */
 521 static unsigned int raid10_md_layout_to_copies(int layout)
 522 {
 523         return __raid10_near_copies(layout) > 1 ?
 524                 __raid10_near_copies(layout) : __raid10_far_copies(layout);
 525 }
 526
 527 /* Return md raid10 format id for @format string */
 528 static int raid10_format_to_md_layout(struct raid_set *rs,
 529                                       unsigned int algorithm,
 530                                       unsigned int copies)
 531 {
 532         unsigned int n = 1, f = 1, r = 0;
 533
 534         /*
 535          * MD resilienece flaw:
 536          *
 537          * enabling use_far_sets for far/offset formats causes copies
 538          * to be colocated on the same devs together with their origins!
 539          *
 540          * -> disable it for now in the definition above
 541          */
 542         if (algorithm == ALGORITHM_RAID10_DEFAULT ||
 543             algorithm == ALGORITHM_RAID10_NEAR)
 544                 n = copies;
 545
 546         else if (algorithm == ALGORITHM_RAID10_OFFSET) {
 547                 f = copies;
 548                 r = RAID10_OFFSET;
 549                 if (!test_bit(__CTR_FLAG_RAID10_USE_NEAR_SETS, &rs->ctr_flags))
 550                         r |= RAID10_USE_FAR_SETS;
 551
 552         } else if (algorithm == ALGORITHM_RAID10_FAR) {
 553                 f = copies;
 554                 r = !RAID10_OFFSET;
 555                 if (!test_bit(__CTR_FLAG_RAID10_USE_NEAR_SETS, &rs->ctr_flags))
 556                         r |= RAID10_USE_FAR_SETS;
 557
 558         } else
 559                 return -EINVAL;
 560
 561         return r | (f << RAID10_FAR_COPIES_SHIFT) | n;
 562 }
 563 /* END: MD raid10 bit definitions and helpers */
 564
 565 /* Check for any of the raid10 algorithms */
 566 static int __got_raid10(struct raid_type *rtp, const int layout)
 567 {
 568         if (rtp->level == 10) {
 569                 switch (rtp->algorithm) {
 570                 case ALGORITHM_RAID10_DEFAULT:
 571                 case ALGORITHM_RAID10_NEAR:
 572                         return __is_raid10_near(layout);
 573                 case ALGORITHM_RAID10_OFFSET:
 574                         return __is_raid10_offset(layout);
 575                 case ALGORITHM_RAID10_FAR:
 576                         return __is_raid10_far(layout);
 577                 default:
 578                         break;
 579                 }
 580         }
 581
 582         return 0;
 583 }
 584
 585 /* Return raid_type for @name */
 586 static struct raid_type *get_raid_type(const char *name)
 587 {
 588         struct raid_type *rtp = raid_types + ARRAY_SIZE(raid_types);
 589
 590         while (rtp-- > raid_types)
 591                 if (!strcasecmp(rtp->name, name))
 592                         return rtp;
 593
 594         return NULL;
 595 }
 596
 597 /* Return raid_type for @name based derived from @level and @layout */
 598 static struct raid_type *get_raid_type_by_ll(const int level, const int layout)
 599 {
 600         struct raid_type *rtp = raid_types + ARRAY_SIZE(raid_types);
 601
 602         while (rtp-- > raid_types) {
 603                 /* RAID10 special checks based on @layout flags/properties */
 604                 if (rtp->level == level &&
 605                     (__got_raid10(rtp, layout) || rtp->algorithm == layout))
 606                         return rtp;
 607         }
 608
 609         return NULL;
 610 }
 611
 612 /*
 613  * Conditionally change bdev capacity of @rs
 614  * in case of a disk add/remove reshape
 615  */
 616 static void rs_set_capacity(struct raid_set *rs)
 617 {
 618         struct mddev *mddev = &rs->md;
 619
 620         /* Make sure we access most actual mddev properties */
 621         smp_rmb();
 622         if (rs->ti->len != mddev->array_sectors && !rs_is_reshaping(rs)) {
 623                 struct gendisk *gendisk = dm_disk(dm_table_get_md(rs->ti->table));
 624
 625                 set_capacity(gendisk, mddev->array_sectors);
 626                 revalidate_disk(gendisk);
 627         }
 628 }
 629
 630 /*
 631  * Set the mddev properties in @rs to the current
 632  * ones retrieved from the freshest superblock
 633  */
 634 static void rs_set_cur(struct raid_set *rs)
 635 {
 636         struct mddev *mddev = &rs->md;
 637
 638         mddev->new_level = mddev->level;
 639         mddev->new_layout = mddev->layout;
 640         mddev->new_chunk_sectors = mddev->chunk_sectors;
 641 }
 642
 643 /*
 644  * Set the mddev properties in @rs to the new
 645  * ones requested by the ctr
 646  */
 647 static void rs_set_new(struct raid_set *rs)
 648 {
 649         struct mddev *mddev = &rs->md;
 650
 651         mddev->level = mddev->new_level;
 652         mddev->layout = mddev->new_layout;
 653         mddev->chunk_sectors = mddev->new_chunk_sectors;
 654         mddev->raid_disks = rs->raid_disks;
 655         mddev->delta_disks = 0;
 656 }
 657
 658 static struct raid_set *raid_set_alloc(struct dm_target *ti, struct raid_type *raid_type,
 659                                        unsigned raid_devs)
 660 {
 661         unsigned i;
 662         struct raid_set *rs;
 663
 664         if (raid_devs <= raid_type->parity_devs) {
 665                 ti->error = "Insufficient number of devices";
 666                 return ERR_PTR(-EINVAL);
 667         }
 668
 669         rs = kzalloc(sizeof(*rs) + raid_devs * sizeof(rs->dev[0]), GFP_KERNEL);
 670         if (!rs) {
 671                 ti->error = "Cannot allocate raid context";
 672                 return ERR_PTR(-ENOMEM);
 673         }
 674
 675         mddev_init(&rs->md);
 676
 677         rs->raid_disks = raid_devs;
 678         rs->delta_disks = 0;
 679
 680         rs->ti = ti;
 681         rs->raid_type = raid_type;
 682         rs->stripe_cache_entries = 256;
 683         rs->md.raid_disks = raid_devs;
 684         rs->md.level = raid_type->level;
 685         rs->md.new_level = rs->md.level;
 686         rs->md.layout = raid_type->algorithm;
 687         rs->md.new_layout = rs->md.layout;
 688         rs->md.delta_disks = 0;
 689         rs->md.recovery_cp = rs_is_raid0(rs) ? MaxSector : 0;
 690
 691         for (i = 0; i < raid_devs; i++)
 692                 md_rdev_init(&rs->dev[i].rdev);
 693
 694         /*
 695          * Remaining items to be initialized by further RAID params:
 696          *  rs->md.persistent
 697          *  rs->md.external
 698          *  rs->md.chunk_sectors
 699          *  rs->md.new_chunk_sectors
 700          *  rs->md.dev_sectors
 701          */
 702
 703         return rs;
 704 }
 705
 706 static void raid_set_free(struct raid_set *rs)
 707 {
 708         int i;
 709
 710         for (i = 0; i < rs->md.raid_disks; i++) {
 711                 if (rs->dev[i].meta_dev)
 712                         dm_put_device(rs->ti, rs->dev[i].meta_dev);
 713                 md_rdev_clear(&rs->dev[i].rdev);
 714                 if (rs->dev[i].data_dev)
 715                         dm_put_device(rs->ti, rs->dev[i].data_dev);
 716         }
 717
 718         kfree(rs);
 719 }
 720
 721 /*
 722  * For every device we have two words
 723  *  <meta_dev>: meta device name or '-' if missing
 724  *  <data_dev>: data device name or '-' if missing
 725  *
 726  * The following are permitted:
 727  *    - -
 728  *    - <data_dev>
 729  *    <meta_dev> <data_dev>
 730  *
 731  * The following is not allowed:
 732  *    <meta_dev> -
 733  *
 734  * This code parses those words.  If there is a failure,
 735  * the caller must use raid_set_free() to unwind the operations.
 736  */
 737 static int parse_dev_params(struct raid_set *rs, struct dm_arg_set *as)
 738 {
 739         int i;
 740         int rebuild = 0;
 741         int metadata_available = 0;
 742         int r = 0;
 743         const char *arg;
 744
 745         /* Put off the number of raid devices argument to get to dev pairs */
 746         arg = dm_shift_arg(as);
 747         if (!arg)
 748                 return -EINVAL;
 749
 750         for (i = 0; i < rs->md.raid_disks; i++) {
 751                 rs->dev[i].rdev.raid_disk = i;
 752
 753                 rs->dev[i].meta_dev = NULL;
 754                 rs->dev[i].data_dev = NULL;
 755
 756                 /*
 757                  * There are no offsets, since there is a separate device
 758                  * for data and metadata.
 759                  */
 760                 rs->dev[i].rdev.data_offset = 0;
 761                 rs->dev[i].rdev.mddev = &rs->md;
 762
 763                 arg = dm_shift_arg(as);
 764                 if (!arg)
 765                         return -EINVAL;
 766
 767                 if (strcmp(arg, "-")) {
 768                         r = dm_get_device(rs->ti, arg, dm_table_get_mode(rs->ti->table),
 769                                           &rs->dev[i].meta_dev);
 770                         if (r) {
 771                                 rs->ti->error = "RAID metadata device lookup failure";
 772                                 return r;
 773                         }
 774
 775                         rs->dev[i].rdev.sb_page = alloc_page(GFP_KERNEL);
 776                         if (!rs->dev[i].rdev.sb_page) {
 777                                 rs->ti->error = "Failed to allocate superblock page";
 778                                 return -ENOMEM;
 779                         }
 780                 }
 781
 782                 arg = dm_shift_arg(as);
 783                 if (!arg)
 784                         return -EINVAL;
 785
 786                 if (!strcmp(arg, "-")) {
 787                         if (!test_bit(In_sync, &rs->dev[i].rdev.flags) &&
 788                             (!rs->dev[i].rdev.recovery_offset)) {
 789                                 rs->ti->error = "Drive designated for rebuild not specified";
 790                                 return -EINVAL;
 791                         }
 792
 793                         if (rs->dev[i].meta_dev) {
 794                                 rs->ti->error = "No data device supplied with metadata device";
 795                                 return -EINVAL;
 796                         }
 797
 798                         continue;
 799                 }
 800
 801                 r = dm_get_device(rs->ti, arg, dm_table_get_mode(rs->ti->table),
 802                                   &rs->dev[i].data_dev);
 803                 if (r) {
 804                         rs->ti->error = "RAID device lookup failure";
 805                         return r;
 806                 }
 807
 808                 if (rs->dev[i].meta_dev) {
 809                         metadata_available = 1;
 810                         rs->dev[i].rdev.meta_bdev = rs->dev[i].meta_dev->bdev;
 811                 }
 812                 rs->dev[i].rdev.bdev = rs->dev[i].data_dev->bdev;
 813                 list_add_tail(&rs->dev[i].rdev.same_set, &rs->md.disks);
 814                 if (!test_bit(In_sync, &rs->dev[i].rdev.flags))
 815                         rebuild++;
 816         }
 817
 818         if (metadata_available) {
 819                 rs->md.external = 0;
 820                 rs->md.persistent = 1;
 821                 rs->md.major_version = 2;
 822         } else if (rebuild && !rs->md.recovery_cp) {
 823                 /*
 824                  * Without metadata, we will not be able to tell if the array
 825                  * is in-sync or not - we must assume it is not.  Therefore,
 826                  * it is impossible to rebuild a drive.
 827                  *
 828                  * Even if there is metadata, the on-disk information may
 829                  * indicate that the array is not in-sync and it will then
 830                  * fail at that time.
 831                  *
 832                  * User could specify 'nosync' option if desperate.
 833                  */
 834                 rs->ti->error = "Unable to rebuild drive while array is not in-sync";
 835                 return -EINVAL;
 836         }
 837
 838         return 0;
 839 }
 840
 841 /*
 842  * validate_region_size
 843  * @rs
 844  * @region_size:  region size in sectors.  If 0, pick a size (4MiB default).
 845  *
 846  * Set rs->md.bitmap_info.chunksize (which really refers to 'region size').
 847  * Ensure that (ti->len/region_size < 2^21) - required by MD bitmap.
 848  *
 849  * Returns: 0 on success, -EINVAL on failure.
 850  */
 851 static int validate_region_size(struct raid_set *rs, unsigned long region_size)
 852 {
 853         unsigned long min_region_size = rs->ti->len / (1 << 21);
 854
 855         if (!region_size) {
 856                 /*
 857                  * Choose a reasonable default.  All figures in sectors.
 858                  */
 859                 if (min_region_size > (1 << 13)) {
 860                         /* If not a power of 2, make it the next power of 2 */
 861                         region_size = roundup_pow_of_two(min_region_size);
 862                         DMINFO("Choosing default region size of %lu sectors",
 863                                region_size);
 864                 } else {
 865                         DMINFO("Choosing default region size of 4MiB");
 866                         region_size = 1 << 13; /* sectors */
 867                 }
 868         } else {
 869                 /*
 870                  * Validate user-supplied value.
 871                  */
 872                 if (region_size > rs->ti->len) {
 873                         rs->ti->error = "Supplied region size is too large";
 874                         return -EINVAL;
 875                 }
 876
 877                 if (region_size < min_region_size) {
 878                         DMERR("Supplied region_size (%lu sectors) below minimum (%lu)",
 879                               region_size, min_region_size);
 880                         rs->ti->error = "Supplied region size is too small";
 881                         return -EINVAL;
 882                 }
 883
 884                 if (!is_power_of_2(region_size)) {
 885                         rs->ti->error = "Region size is not a power of 2";
 886                         return -EINVAL;
 887                 }
 888
 889                 if (region_size < rs->md.chunk_sectors) {
 890                         rs->ti->error = "Region size is smaller than the chunk size";
 891                         return -EINVAL;
 892                 }
 893         }
 894
 895         /*
 896          * Convert sectors to bytes.
 897          */
 898         rs->md.bitmap_info.chunksize = (region_size << 9);
 899
 900         return 0;
 901 }
 902
 903 /*
 904  * validate_raid_redundancy
 905  * @rs
 906  *
 907  * Determine if there are enough devices in the array that haven't
 908  * failed (or are being rebuilt) to form a usable array.
 909  *
 910  * Returns: 0 on success, -EINVAL on failure.
 911  */
 912 static int validate_raid_redundancy(struct raid_set *rs)
 913 {
 914         unsigned i, rebuild_cnt = 0;
 915         unsigned rebuilds_per_group = 0, copies;
 916         unsigned group_size, last_group_start;
 917
 918         for (i = 0; i < rs->md.raid_disks; i++)
 919                 if (!test_bit(In_sync, &rs->dev[i].rdev.flags) ||
 920                     !rs->dev[i].rdev.sb_page)
 921                         rebuild_cnt++;
 922
 923         switch (rs->raid_type->level) {
 924         case 1:
 925                 if (rebuild_cnt >= rs->md.raid_disks)
 926                         goto too_many;
 927                 break;
 928         case 4:
 929         case 5:
 930         case 6:
 931                 if (rebuild_cnt > rs->raid_type->parity_devs)
 932                         goto too_many;
 933                 break;
 934         case 10:
 935                 copies = raid10_md_layout_to_copies(rs->md.new_layout);
 936                 if (rebuild_cnt < copies)
 937                         break;
 938
 939                 /*
 940                  * It is possible to have a higher rebuild count for RAID10,
 941                  * as long as the failed devices occur in different mirror
 942                  * groups (i.e. different stripes).
 943                  *
 944                  * When checking "near" format, make sure no adjacent devices
 945                  * have failed beyond what can be handled.  In addition to the
 946                  * simple case where the number of devices is a multiple of the
 947                  * number of copies, we must also handle cases where the number
 948                  * of devices is not a multiple of the number of copies.
 949                  * E.g.    dev1 dev2 dev3 dev4 dev5
 950                  *          A    A    B    B    C
 951                  *          C    D    D    E    E
 952                  */
 953                 if (__is_raid10_near(rs->md.new_layout)) {
 954                         for (i = 0; i < rs->raid_disks; i++) {
 955                                 if (!(i % copies))
 956                                         rebuilds_per_group = 0;
 957                                 if ((!rs->dev[i].rdev.sb_page ||
 958                                     !test_bit(In_sync, &rs->dev[i].rdev.flags)) &&
 959                                     (++rebuilds_per_group >= copies))
 960                                         goto too_many;
 961                         }
 962                         break;
 963                 }
 964
 965                 /*
 966                  * When checking "far" and "offset" formats, we need to ensure
 967                  * that the device that holds its copy is not also dead or
 968                  * being rebuilt.  (Note that "far" and "offset" formats only
 969                  * support two copies right now.  These formats also only ever
 970                  * use the 'use_far_sets' variant.)
 971                  *
 972                  * This check is somewhat complicated by the need to account
 973                  * for arrays that are not a multiple of (far) copies.  This
 974                  * results in the need to treat the last (potentially larger)
 975                  * set differently.
 976                  */
 977                 group_size = (rs->md.raid_disks / copies);
 978                 last_group_start = (rs->md.raid_disks / group_size) - 1;
 979                 last_group_start *= group_size;
 980                 for (i = 0; i < rs->md.raid_disks; i++) {
 981                         if (!(i % copies) && !(i > last_group_start))
 982                                 rebuilds_per_group = 0;
 983                         if ((!rs->dev[i].rdev.sb_page ||
 984                              !test_bit(In_sync, &rs->dev[i].rdev.flags)) &&
 985                             (++rebuilds_per_group >= copies))
 986                                         goto too_many;
 987                 }
 988                 break;
 989         default:
 990                 if (rebuild_cnt)
 991                         return -EINVAL;
 992         }
 993
 994         return 0;
 995
 996 too_many:
 997         return -EINVAL;
 998 }
 999
1000 /*
1001  * Possible arguments are...
1002  *      <chunk_size> [optional_args]
1003  *
1004  * Argument definitions
1005  *    <chunk_size>                      The number of sectors per disk that
1006  *                                      will form the "stripe"
1007  *    [[no]sync]                        Force or prevent recovery of the
1008  *                                      entire array
1009  *    [rebuild <idx>]                   Rebuild the drive indicated by the index
1010  *    [daemon_sleep <ms>]               Time between bitmap daemon work to
1011  *                                      clear bits
1012  *    [min_recovery_rate <kB/sec/disk>] Throttle RAID initialization
1013  *    [max_recovery_rate <kB/sec/disk>] Throttle RAID initialization
1014  *    [write_mostly <idx>]              Indicate a write mostly drive via index
1015  *    [max_write_behind <sectors>]      See '-write-behind=' (man mdadm)
1016  *    [stripe_cache <sectors>]          Stripe cache size for higher RAIDs
1017  *    [region_size <sectors>]           Defines granularity of bitmap
1018  *
1019  * RAID10-only options:
1020  *    [raid10_copies <# copies>]        Number of copies.  (Default: 2)
1021  *    [raid10_format <near|far|offset>] Layout algorithm.  (Default: near)
1022  */
1023 static int parse_raid_params(struct raid_set *rs, struct dm_arg_set *as,
1024                              unsigned num_raid_params)
1025 {
1026         int value, raid10_format = ALGORITHM_RAID10_DEFAULT;
1027         unsigned raid10_copies = 2;
1028         unsigned i;
1029         unsigned region_size = 0;
1030         sector_t max_io_len;
1031         const char *arg, *key;
1032         struct raid_dev *rd;
1033         struct raid_type *rt = rs->raid_type;
1034
1035         arg = dm_shift_arg(as);
1036         num_raid_params--; /* Account for chunk_size argument */
1037
1038         if (kstrtoint(arg, 10, &value) < 0) {
1039                 rs->ti->error = "Bad numerical argument given for chunk_size";
1040                 return -EINVAL;
1041         }
1042
1043         /*
1044          * First, parse the in-order required arguments
1045          * "chunk_size" is the only argument of this type.
1046          */
1047         if (rt_is_raid1(rt)) {
1048                 if (value)
1049                         DMERR("Ignoring chunk size parameter for RAID 1");
1050                 value = 0;
1051         } else if (!is_power_of_2(value)) {
1052                 rs->ti->error = "Chunk size must be a power of 2";
1053                 return -EINVAL;
1054         } else if (value < 8) {
1055                 rs->ti->error = "Chunk size value is too small";
1056                 return -EINVAL;
1057         }
1058
1059         rs->md.new_chunk_sectors = rs->md.chunk_sectors = value;
1060
1061         /*
1062          * We set each individual device as In_sync with a completed
1063          * 'recovery_offset'.  If there has been a device failure or
1064          * replacement then one of the following cases applies:
1065          *
1066          *   1) User specifies 'rebuild'.
1067          *      - Device is reset when param is read.
1068          *   2) A new device is supplied.
1069          *      - No matching superblock found, resets device.
1070          *   3) Device failure was transient and returns on reload.
1071          *      - Failure noticed, resets device for bitmap replay.
1072          *   4) Device hadn't completed recovery after previous failure.
1073          *      - Superblock is read and overrides recovery_offset.
1074          *
1075          * What is found in the superblocks of the devices is always
1076          * authoritative, unless 'rebuild' or '[no]sync' was specified.
1077          */
1078         for (i = 0; i < rs->md.raid_disks; i++) {
1079                 set_bit(In_sync, &rs->dev[i].rdev.flags);
1080                 rs->dev[i].rdev.recovery_offset = MaxSector;
1081         }
1082
1083         /*
1084          * Second, parse the unordered optional arguments
1085          */
1086         for (i = 0; i < num_raid_params; i++) {
1087                 key = dm_shift_arg(as);
1088                 if (!key) {
1089                         rs->ti->error = "Not enough raid parameters given";
1090                         return -EINVAL;
1091                 }
1092
1093                 if (!strcasecmp(key, dm_raid_arg_name_by_flag(CTR_FLAG_NOSYNC))) {
1094                         if (test_and_set_bit(__CTR_FLAG_NOSYNC, &rs->ctr_flags)) {
1095                                 rs->ti->error = "Only one 'nosync' argument allowed";
1096                                 return -EINVAL;
1097                         }
1098                         rs->md.recovery_cp = MaxSector;
1099                         continue;
1100                 }
1101                 if (!strcasecmp(key, dm_raid_arg_name_by_flag(CTR_FLAG_SYNC))) {
1102                         if (test_and_set_bit(__CTR_FLAG_SYNC, &rs->ctr_flags)) {
1103                                 rs->ti->error = "Only one 'sync' argument allowed";
1104                                 return -EINVAL;
1105                         }
1106                         rs->md.recovery_cp = 0;
1107                         continue;
1108                 }
1109                 if (!strcasecmp(key, dm_raid_arg_name_by_flag(CTR_FLAG_RAID10_USE_NEAR_SETS))) {
1110                         if (test_and_set_bit(__CTR_FLAG_RAID10_USE_NEAR_SETS, &rs->ctr_flags)) {
1111                                 rs->ti->error = "Only one 'raid10_use_new_sets' argument allowed";
1112                                 return -EINVAL;
1113                         }
1114                         continue;
1115                 }
1116
1117                 arg = dm_shift_arg(as);
1118                 i++; /* Account for the argument pairs */
1119                 if (!arg) {
1120                         rs->ti->error = "Wrong number of raid parameters given";
1121                         return -EINVAL;
1122                 }
1123
1124                 /*
1125                  * Parameters that take a string value are checked here.
1126                  */
1127
1128                 if (!strcasecmp(key, dm_raid_arg_name_by_flag(CTR_FLAG_RAID10_FORMAT))) {
1129                         if (test_and_set_bit(__CTR_FLAG_RAID10_FORMAT, &rs->ctr_flags)) {
1130                                 rs->ti->error = "Only one 'raid10_format' argument pair allowed";
1131                                 return -EINVAL;
1132                         }
1133                         if (!rt_is_raid10(rt)) {
1134                                 rs->ti->error = "'raid10_format' is an invalid parameter for this RAID type";
1135                                 return -EINVAL;
1136                         }
1137                         raid10_format = raid10_name_to_format(arg);
1138                         if (raid10_format < 0) {
1139                                 rs->ti->error = "Invalid 'raid10_format' value given";
1140                                 return raid10_format;
1141                         }
1142                         continue;
1143                 }
1144
1145                 if (kstrtoint(arg, 10, &value) < 0) {
1146                         rs->ti->error = "Bad numerical argument given in raid params";
1147                         return -EINVAL;
1148                 }
1149
1150                 if (!strcasecmp(key, dm_raid_arg_name_by_flag(CTR_FLAG_REBUILD))) {
1151                         /*
1152                          * "rebuild" is being passed in by userspace to provide
1153                          * indexes of replaced devices and to set up additional
1154                          * devices on raid level takeover.
1155                          */
1156                         if (!__within_range(value, 0, rs->raid_disks - 1)) {
1157                                 rs->ti->error = "Invalid rebuild index given";
1158                                 return -EINVAL;
1159                         }
1160
1161                         if (test_and_set_bit(value, (void *) rs->rebuild_disks)) {
1162                                 rs->ti->error = "rebuild for this index already given";
1163                                 return -EINVAL;
1164                         }
1165
1166                         rd = rs->dev + value;
1167                         clear_bit(In_sync, &rd->rdev.flags);
1168                         clear_bit(Faulty, &rd->rdev.flags);
1169                         rd->rdev.recovery_offset = 0;
1170                         set_bit(__CTR_FLAG_REBUILD, &rs->ctr_flags);
1171                 } else if (!strcasecmp(key, dm_raid_arg_name_by_flag(CTR_FLAG_WRITE_MOSTLY))) {
1172                         if (!rt_is_raid1(rt)) {
1173                                 rs->ti->error = "write_mostly option is only valid for RAID1";
1174                                 return -EINVAL;
1175                         }
1176
1177                         if (!__within_range(value, 0, rs->md.raid_disks - 1)) {
1178                                 rs->ti->error = "Invalid write_mostly index given";
1179                                 return -EINVAL;
1180                         }
1181
1182                         set_bit(WriteMostly, &rs->dev[value].rdev.flags);
1183                         set_bit(__CTR_FLAG_WRITE_MOSTLY, &rs->ctr_flags);
1184                 } else if (!strcasecmp(key, dm_raid_arg_name_by_flag(CTR_FLAG_MAX_WRITE_BEHIND))) {
1185                         if (!rt_is_raid1(rt)) {
1186                                 rs->ti->error = "max_write_behind option is only valid for RAID1";
1187                                 return -EINVAL;
1188                         }
1189
1190                         if (test_and_set_bit(__CTR_FLAG_MAX_WRITE_BEHIND, &rs->ctr_flags)) {
1191                                 rs->ti->error = "Only one max_write_behind argument pair allowed";
1192                                 return -EINVAL;
1193                         }
1194
1195                         /*
1196                          * In device-mapper, we specify things in sectors, but
1197                          * MD records this value in kB
1198                          */
1199                         value /= 2;
1200                         if (value > COUNTER_MAX) {
1201                                 rs->ti->error = "Max write-behind limit out of range";
1202                                 return -EINVAL;
1203                         }
1204
1205                         rs->md.bitmap_info.max_write_behind = value;
1206                 } else if (!strcasecmp(key, dm_raid_arg_name_by_flag(CTR_FLAG_DAEMON_SLEEP))) {
1207                         if (test_and_set_bit(__CTR_FLAG_DAEMON_SLEEP, &rs->ctr_flags)) {
1208                                 rs->ti->error = "Only one daemon_sleep argument pair allowed";
1209                                 return -EINVAL;
1210                         }
1211                         if (!value || (value > MAX_SCHEDULE_TIMEOUT)) {
1212                                 rs->ti->error = "daemon sleep period out of range";
1213                                 return -EINVAL;
1214                         }
1215                         rs->md.bitmap_info.daemon_sleep = value;
1216                 } else if (!strcasecmp(key, dm_raid_arg_name_by_flag(CTR_FLAG_DATA_OFFSET))) {
1217                         /* Userspace passes new data_offset after having extended the the data image LV */
1218                         if (test_and_set_bit(__CTR_FLAG_DATA_OFFSET, &rs->ctr_flags)) {
1219                                 rs->ti->error = "Only one data_offset argument pair allowed";
1220                                 return -EINVAL;
1221                         }
1222                         /* Ensure sensible data offset */
1223                         if (value < 0) {
1224                                 rs->ti->error = "Bogus data_offset value";
1225                                 return -EINVAL;
1226                         }
1227                         rs->data_offset = value;
1228                 } else if (!strcasecmp(key, dm_raid_arg_name_by_flag(CTR_FLAG_DELTA_DISKS))) {
1229                         /* Define the +/-# of disks to add to/remove from the given raid set */
1230                         if (test_and_set_bit(__CTR_FLAG_DELTA_DISKS, &rs->ctr_flags)) {
1231                                 rs->ti->error = "Only one delta_disks argument pair allowed";
1232                                 return -EINVAL;
1233                         }
1234                         /* Ensure MAX_RAID_DEVICES and raid type minimal_devs! */
1235                         if (!__within_range(abs(value), 1, MAX_RAID_DEVICES - rt->minimal_devs)) {
1236                                 rs->ti->error = "Too many delta_disk requested";
1237                                 return -EINVAL;
1238                         }
1239
1240                         rs->delta_disks = value;
1241                 } else if (!strcasecmp(key, dm_raid_arg_name_by_flag(CTR_FLAG_STRIPE_CACHE))) {
1242                         if (test_and_set_bit(__CTR_FLAG_STRIPE_CACHE, &rs->ctr_flags)) {
1243                                 rs->ti->error = "Only one stripe_cache argument pair allowed";
1244                                 return -EINVAL;
1245                         }
1246
1247                         if (!rt_is_raid456(rt)) {
1248                                 rs->ti->error = "Inappropriate argument: stripe_cache";
1249                                 return -EINVAL;
1250                         }
1251
1252                         rs->stripe_cache_entries = value;
1253                 } else if (!strcasecmp(key, dm_raid_arg_name_by_flag(CTR_FLAG_MIN_RECOVERY_RATE))) {
1254                         if (test_and_set_bit(__CTR_FLAG_MIN_RECOVERY_RATE, &rs->ctr_flags)) {
1255                                 rs->ti->error = "Only one min_recovery_rate argument pair allowed";
1256                                 return -EINVAL;
1257                         }
1258                         if (value > INT_MAX) {
1259                                 rs->ti->error = "min_recovery_rate out of range";
1260                                 return -EINVAL;
1261                         }
1262                         rs->md.sync_speed_min = (int)value;
1263                 } else if (!strcasecmp(key, dm_raid_arg_name_by_flag(CTR_FLAG_MAX_RECOVERY_RATE))) {
1264                         if (test_and_set_bit(__CTR_FLAG_MIN_RECOVERY_RATE, &rs->ctr_flags)) {
1265                                 rs->ti->error = "Only one max_recovery_rate argument pair allowed";
1266                                 return -EINVAL;
1267                         }
1268                         if (value > INT_MAX) {
1269                                 rs->ti->error = "max_recovery_rate out of range";
1270                                 return -EINVAL;
1271                         }
1272                         rs->md.sync_speed_max = (int)value;
1273                 } else if (!strcasecmp(key, dm_raid_arg_name_by_flag(CTR_FLAG_REGION_SIZE))) {
1274                         if (test_and_set_bit(__CTR_FLAG_REGION_SIZE, &rs->ctr_flags)) {
1275                                 rs->ti->error = "Only one region_size argument pair allowed";
1276                                 return -EINVAL;
1277                         }
1278
1279                         region_size = value;
1280                 } else if (!strcasecmp(key, dm_raid_arg_name_by_flag(CTR_FLAG_RAID10_COPIES))) {
1281                         if (test_and_set_bit(__CTR_FLAG_RAID10_COPIES, &rs->ctr_flags)) {
1282                                 rs->ti->error = "Only one raid10_copies argument pair allowed";
1283                                 return -EINVAL;
1284                         }
1285
1286                         if (!__within_range(value, 2, rs->md.raid_disks)) {
1287                                 rs->ti->error = "Bad value for 'raid10_copies'";
1288                                 return -EINVAL;
1289                         }
1290
1291                         raid10_copies = value;
1292                 } else {
1293                         DMERR("Unable to parse RAID parameter: %s", key);
1294                         rs->ti->error = "Unable to parse RAID parameter";
1295                         return -EINVAL;
1296                 }
1297         }
1298
1299         if (validate_region_size(rs, region_size))
1300                 return -EINVAL;
1301
1302         if (rs->md.chunk_sectors)
1303                 max_io_len = rs->md.chunk_sectors;
1304         else
1305                 max_io_len = region_size;
1306
1307         if (dm_set_target_max_io_len(rs->ti, max_io_len))
1308                 return -EINVAL;
1309
1310         if (rt_is_raid10(rt)) {
1311                 if (raid10_copies > rs->md.raid_disks) {
1312                         rs->ti->error = "Not enough devices to satisfy specification";
1313                         return -EINVAL;
1314                 }
1315
1316                 rs->md.new_layout = raid10_format_to_md_layout(rs, raid10_format, raid10_copies);
1317                 if (rs->md.new_layout < 0) {
1318                         rs->ti->error = "Error getting raid10 format";
1319                         return rs->md.new_layout;
1320                 }
1321
1322                 rt = get_raid_type_by_ll(10, rs->md.new_layout);
1323                 if (!rt) {
1324                         rs->ti->error = "Failed to recognize new raid10 layout";
1325                         return -EINVAL;
1326                 }
1327
1328                 if ((rt->algorithm == ALGORITHM_RAID10_DEFAULT ||
1329                      rt->algorithm == ALGORITHM_RAID10_NEAR) &&
1330                     test_bit(__CTR_FLAG_RAID10_USE_NEAR_SETS, &rs->ctr_flags)) {
1331                         rs->ti->error = "RAID10 format 'near' and 'raid10_use_near_sets' are incompatible";
1332                         return -EINVAL;
1333                 }
1334         }
1335
1336         rs->raid10_copies = raid10_copies;
1337
1338         /* Assume there are no metadata devices until the drives are parsed */
1339         rs->md.persistent = 0;
1340         rs->md.external = 1;
1341
1342         /* Check, if any invalid ctr arguments have been passed in for the raid level */
1343         return rs_check_for_valid_flags(rs);
1344 }
1345
1346 /* Set raid4/5/6 cache size */
1347 static int rs_set_raid456_stripe_cache(struct raid_set *rs)
1348 {
1349         int r;
1350         struct r5conf *conf;
1351         struct mddev *mddev = &rs->md;
1352         uint32_t min_stripes = max(mddev->chunk_sectors, mddev->new_chunk_sectors) / 2;
1353         uint32_t nr_stripes = rs->stripe_cache_entries;
1354
1355         if (!rt_is_raid456(rs->raid_type)) {
1356                 rs->ti->error = "Inappropriate raid level; cannot change stripe_cache size";
1357                 return -EINVAL;
1358         }
1359
1360         if (nr_stripes < min_stripes) {
1361                 DMINFO("Adjusting requested %u stripe cache entries to %u to suit stripe size",
1362                        nr_stripes, min_stripes);
1363                 nr_stripes = min_stripes;
1364         }
1365
1366         conf = mddev->private;
1367         if (!conf) {
1368                 rs->ti->error = "Cannot change stripe_cache size on inactive RAID set";
1369                 return -EINVAL;
1370         }
1371
1372         /* Try setting number of stripes in raid456 stripe cache */
1373         if (conf->min_nr_stripes != nr_stripes) {
1374                 r = raid5_set_cache_size(mddev, nr_stripes);
1375                 if (r) {
1376                         rs->ti->error = "Failed to set raid4/5/6 stripe cache size";
1377                         return r;
1378                 }
1379
1380                 DMINFO("%u stripe cache entries", nr_stripes);
1381         }
1382
1383         return 0;
1384 }
1385
1386 /* Return # of data stripes as kept in mddev as of @rs (i.e. as of superblock) */
1387 static unsigned int mddev_data_stripes(struct raid_set *rs)
1388 {
1389         return rs->md.raid_disks - rs->raid_type->parity_devs;
1390 }
1391
1392 /* Return # of data stripes of @rs (i.e. as of ctr) */
1393 static unsigned int rs_data_stripes(struct raid_set *rs)
1394 {
1395         return rs->raid_disks - rs->raid_type->parity_devs;
1396 }
1397
1398 /* Calculate the sectors per device and per array used for @rs */
1399 static int rs_set_dev_and_array_sectors(struct raid_set *rs, bool use_mddev)
1400 {
1401         int delta_disks;
1402         unsigned int data_stripes;
1403         struct mddev *mddev = &rs->md;
1404         struct md_rdev *rdev;
1405         sector_t array_sectors = rs->ti->len, dev_sectors = rs->ti->len;
1406         sector_t cur_dev_sectors = rs->dev[0].rdev.sectors;
1407
1408         if (use_mddev) {
1409                 delta_disks = mddev->delta_disks;
1410                 data_stripes = mddev_data_stripes(rs);
1411         } else {
1412                 delta_disks = rs->delta_disks;
1413                 data_stripes = rs_data_stripes(rs);
1414         }
1415
1416         /* Special raid1 case w/o delta_disks support (yet) */
1417         if (rt_is_raid1(rs->raid_type))
1418                 ;
1419         else if (rt_is_raid10(rs->raid_type)) {
1420                 if (rs->raid10_copies < 2 ||
1421                     delta_disks < 0) {
1422                         rs->ti->error = "Bogus raid10 data copies or delta disks";
1423                         return EINVAL;
1424                 }
1425
1426                 dev_sectors *= rs->raid10_copies;
1427                 if (sector_div(dev_sectors, data_stripes))
1428                         goto bad;
1429
1430                 array_sectors = (data_stripes + delta_disks) * dev_sectors;
1431                 if (sector_div(array_sectors, rs->raid10_copies))
1432                         goto bad;
1433
1434         } else if (sector_div(dev_sectors, data_stripes))
1435                 goto bad;
1436
1437         else
1438                 /* Striped layouts */
1439                 array_sectors = (data_stripes + delta_disks) * dev_sectors;
1440
1441         rdev_for_each(rdev, mddev)
1442                 rdev->sectors = dev_sectors;
1443
1444         mddev->array_sectors = array_sectors;
1445         mddev->dev_sectors = dev_sectors;
1446
1447         if (!rs_is_raid0(rs) && dev_sectors > cur_dev_sectors)
1448                 mddev->recovery_cp = dev_sectors;
1449
1450         return 0;
1451 bad:
1452         rs->ti->error = "Target length not divisible by number of data devices";
1453         return EINVAL;
1454 }
1455
1456 static void do_table_event(struct work_struct *ws)
1457 {
1458         struct raid_set *rs = container_of(ws, struct raid_set, md.event_work);
1459
1460         rs_set_capacity(rs);
1461         dm_table_event(rs->ti->table);
1462 }
1463
1464 static int raid_is_congested(struct dm_target_callbacks *cb, int bits)
1465 {
1466         struct raid_set *rs = container_of(cb, struct raid_set, callbacks);
1467
1468         return mddev_congested(&rs->md, bits);
1469 }
1470
1471 /*
1472  * Make sure a valid takover (level switch) is being requested on @rs
1473  *
1474  * Conversions of raid sets from one MD personality to another
1475  * have to conform to restrictions which are enforced here.
1476  *
1477  * Degration is already checked for in rs_check_conversion() below.
1478  */
1479 static int rs_check_takeover(struct raid_set *rs)
1480 {
1481         struct mddev *mddev = &rs->md;
1482         unsigned int near_copies;
1483
1484         smp_rmb();
1485         if (rs->md.degraded) {
1486                 rs->ti->error = "Can't takeover degraded raid set";
1487                 return -EPERM;
1488         }
1489
1490         if (rs_is_reshaping(rs)) {
1491                 rs->ti->error = "Can't takeover reshaping raid set";
1492                 return -EPERM;
1493         }
1494
1495         switch (mddev->level) {
1496         case 0:
1497                 /* raid0 -> raid1/5 with one disk */
1498                 if ((mddev->new_level == 1 || mddev->new_level == 5) &&
1499                     mddev->raid_disks == 1)
1500                         return 0;
1501
1502                 /* raid0 -> raid10 */
1503                 if (mddev->new_level == 10 &&
1504                     !(rs->raid_disks % mddev->raid_disks))
1505                         return 0;
1506
1507                 /* raid0 with multiple disks -> raid4/5/6 */
1508                 if (__within_range(mddev->new_level, 4, 6) &&
1509                     mddev->new_layout == ALGORITHM_PARITY_N &&
1510                     mddev->raid_disks > 1)
1511                         return 0;
1512
1513                 break;
1514
1515         case 10:
1516                 /* Can't takeover raid10_offset! */
1517                 if (__is_raid10_offset(mddev->layout))
1518                         break;
1519
1520                 near_copies = __raid10_near_copies(mddev->layout);
1521
1522                 /* raid10* -> raid0 */
1523                 if (mddev->new_level == 0) {
1524                         /* Can takeover raid10_near with raid disks divisable by data copies! */
1525                         if (near_copies > 1 &&
1526                             !(mddev->raid_disks % near_copies)) {
1527                                 mddev->raid_disks /= near_copies;
1528                                 mddev->delta_disks = mddev->raid_disks;
1529                                 return 0;
1530                         }
1531
1532                         /* Can takeover raid10_far */
1533                         if (near_copies == 1 &&
1534                             __raid10_far_copies(mddev->layout) > 1)
1535                                 return 0;
1536
1537                         break;
1538                 }
1539
1540                 /* raid10_{near,far} -> raid1 */
1541                 if (mddev->new_level == 1 &&
1542                     max(near_copies, __raid10_far_copies(mddev->layout)) == mddev->raid_disks)
1543                         return 0;
1544
1545                 /* raid10_{near,far} with 2 disks -> raid4/5 */
1546                 if (__within_range(mddev->new_level, 4, 5) &&
1547                     mddev->raid_disks == 2)
1548                         return 0;
1549                 break;
1550
1551         case 1:
1552                 /* raid1 with 2 disks -> raid4/5 */
1553                 if (__within_range(mddev->new_level, 4, 5) &&
1554                     mddev->raid_disks == 2) {
1555                         mddev->degraded = 1;
1556                         return 0;
1557                 }
1558
1559                 /* raid1 -> raid0 */
1560                 if (mddev->new_level == 0 &&
1561                     mddev->raid_disks == 1)
1562                         return 0;
1563
1564                 /* raid1 -> raid10 */
1565                 if (mddev->new_level == 10)
1566                         return 0;
1567
1568                 break;
1569
1570         case 4:
1571                 /* raid4 -> raid0 */
1572                 if (mddev->new_level == 0)
1573                         return 0;
1574
1575                 /* raid4 -> raid1/5 with 2 disks */
1576                 if ((mddev->new_level == 1 || mddev->new_level == 5) &&
1577                     mddev->raid_disks == 2)
1578                         return 0;
1579
1580                 /* raid4 -> raid5/6 with parity N */
1581                 if (__within_range(mddev->new_level, 5, 6) &&
1582                     mddev->layout == ALGORITHM_PARITY_N)
1583                         return 0;
1584                 break;
1585
1586         case 5:
1587                 /* raid5 with parity N -> raid0 */
1588                 if (mddev->new_level == 0 &&
1589                     mddev->layout == ALGORITHM_PARITY_N)
1590                         return 0;
1591
1592                 /* raid5 with parity N -> raid4 */
1593                 if (mddev->new_level == 4 &&
1594                     mddev->layout == ALGORITHM_PARITY_N)
1595                         return 0;
1596
1597                 /* raid5 with 2 disks -> raid1/4/10 */
1598                 if ((mddev->new_level == 1 || mddev->new_level == 4 || mddev->new_level == 10) &&
1599                     mddev->raid_disks == 2)
1600                         return 0;
1601
1602                 /* raid5 with parity N -> raid6 with parity N */
1603                 if (mddev->new_level == 6 &&
1604                     ((mddev->layout == ALGORITHM_PARITY_N && mddev->new_layout == ALGORITHM_PARITY_N) ||
1605                       __within_range(mddev->new_layout, ALGORITHM_LEFT_ASYMMETRIC_6, ALGORITHM_RIGHT_SYMMETRIC_6)))
1606                         return 0;
1607                 break;
1608
1609         case 6:
1610                 /* raid6 with parity N -> raid0 */
1611                 if (mddev->new_level == 0 &&
1612                     mddev->layout == ALGORITHM_PARITY_N)
1613                         return 0;
1614
1615                 /* raid6 with parity N -> raid4 */
1616                 if (mddev->new_level == 4 &&
1617                     mddev->layout == ALGORITHM_PARITY_N)
1618                         return 0;
1619
1620                 /* raid6_*_n with parity N -> raid5_* */
1621                 if (mddev->new_level == 5 &&
1622                     ((mddev->layout == ALGORITHM_PARITY_N && mddev->new_layout == ALGORITHM_PARITY_N) ||
1623                      __within_range(mddev->new_layout, ALGORITHM_LEFT_ASYMMETRIC, ALGORITHM_RIGHT_SYMMETRIC)))
1624                         return 0;
1625
1626         default:
1627                 break;
1628         }
1629
1630         rs->ti->error = "takeover not possible";
1631         return -EINVAL;
1632 }
1633
1634 /* True if @rs requested to be taken over */
1635 static bool rs_takeover_requested(struct raid_set *rs)
1636 {
1637         return rs->md.new_level != rs->md.level;
1638 }
1639
1640 /* True if @rs is requested to reshape by ctr */
1641 static bool rs_reshape_requested(struct raid_set *rs)
1642 {
1643         struct mddev *mddev = &rs->md;
1644
1645         if (!mddev->level)
1646                 return false;
1647
1648         return !__is_raid10_far(mddev->new_layout) &&
1649                mddev->new_level == mddev->level &&
1650                (mddev->new_layout != mddev->layout ||
1651                 mddev->new_chunk_sectors != mddev->chunk_sectors ||
1652                 rs->raid_disks + rs->delta_disks != mddev->raid_disks);
1653 }
1654
1655 /*  Features */
1656 #define FEATURE_FLAG_SUPPORTS_V190      0x1 /* Supports extended superblock */
1657
1658 /* State flags for sb->flags */
1659 #define SB_FLAG_RESHAPE_ACTIVE          0x1
1660 #define SB_FLAG_RESHAPE_BACKWARDS       0x2
1661
1662 /*
1663  * This structure is never routinely used by userspace, unlike md superblocks.
1664  * Devices with this superblock should only ever be accessed via device-mapper.
1665  */
1666 #define DM_RAID_MAGIC 0x64526D44
1667 struct dm_raid_superblock {
1668         __le32 magic;           /* "DmRd" */
1669         __le32 compat_features; /* Used to indicate compatible features (like 1.9.0 ondisk metadata extension) */
1670
1671         __le32 num_devices;     /* Number of devices in this raid set. (Max 64) */
1672         __le32 array_position;  /* The position of this drive in the raid set */
1673
1674         __le64 events;          /* Incremented by md when superblock updated */
1675         __le64 failed_devices;  /* Pre 1.9.0 part of bit field of devices to */
1676                                 /* indicate failures (see extension below) */
1677
1678         /*
1679          * This offset tracks the progress of the repair or replacement of
1680          * an individual drive.
1681          */
1682         __le64 disk_recovery_offset;
1683
1684         /*
1685          * This offset tracks the progress of the initial raid set
1686          * synchronisation/parity calculation.
1687          */
1688         __le64 array_resync_offset;
1689
1690         /*
1691          * raid characteristics
1692          */
1693         __le32 level;
1694         __le32 layout;
1695         __le32 stripe_sectors;
1696
1697         /********************************************************************
1698          * BELOW FOLLOW V1.9.0 EXTENSIONS TO THE PRISTINE SUPERBLOCK FORMAT!!!
1699          *
1700          * FEATURE_FLAG_SUPPORTS_V190 in the features member indicates that those exist
1701          */
1702
1703         __le32 flags; /* Flags defining array states for reshaping */
1704
1705         /*
1706          * This offset tracks the progress of a raid
1707          * set reshape in order to be able to restart it
1708          */
1709         __le64 reshape_position;
1710
1711         /*
1712          * These define the properties of the array in case of an interrupted reshape
1713          */
1714         __le32 new_level;
1715         __le32 new_layout;
1716         __le32 new_stripe_sectors;
1717         __le32 delta_disks;
1718
1719         __le64 array_sectors; /* Array size in sectors */
1720
1721         /*
1722          * Sector offsets to data on devices (reshaping).
1723          * Needed to support out of place reshaping, thus
1724          * not writing over any stripes whilst converting
1725          * them from old to new layout
1726          */
1727         __le64 data_offset;
1728         __le64 new_data_offset;
1729
1730         __le64 sectors; /* Used device size in sectors */
1731
1732         /*
1733          * Additonal Bit field of devices indicating failures to support
1734          * up to 256 devices with the 1.9.0 on-disk metadata format
1735          */
1736         __le64 extended_failed_devices[DISKS_ARRAY_ELEMS - 1];
1737
1738         __le32 incompat_features;       /* Used to indicate any incompatible features */
1739
1740         /* Always set rest up to logical block size to 0 when writing (see get_metadata_device() below). */
1741 } __packed;
1742
1743 /*
1744  * Check for reshape constraints on raid set @rs:
1745  *
1746  * - reshape function non-existent
1747  * - degraded set
1748  * - ongoing recovery
1749  * - ongoing reshape
1750  *
1751  * Returns 0 if none or -EPERM if given constraint
1752  * and error message reference in @errmsg
1753  */
1754 static int rs_check_reshape(struct raid_set *rs)
1755 {
1756         struct mddev *mddev = &rs->md;
1757
1758         smp_rmb(); /* Make sure we access recent reshape position */
1759
1760         if (!mddev->pers || !mddev->pers->check_reshape)
1761                 rs->ti->error = "Reshape not supported";
1762         else if (mddev->degraded)
1763                 rs->ti->error = "Can't reshape degraded raid set";
1764         else if (rs_is_recovering(rs))
1765                 rs->ti->error = "Convert request on recovering raid set prohibited";
1766         else if (mddev->reshape_position && rs_is_reshaping(rs))
1767                 rs->ti->error = "raid set already reshaping!";
1768         else if (!(rs_is_raid10(rs) || rs_is_raid456(rs)))
1769                 rs->ti->error = "Reshaping only supported for raid4/5/6/10";
1770         else
1771                 return 0;
1772
1773         return -EPERM;
1774 }
1775
1776 static int read_disk_sb(struct md_rdev *rdev, int size)
1777 {
1778         BUG_ON(!rdev->sb_page);
1779
1780         if (rdev->sb_loaded)
1781                 return 0;
1782
1783         if (!sync_page_io(rdev, 0, size, rdev->sb_page, REQ_OP_READ, 0, 1)) {
1784                 DMERR("Failed to read superblock of device at position %d",
1785                       rdev->raid_disk);
1786                 md_error(rdev->mddev, rdev);
1787                 return -EINVAL;
1788         }
1789
1790         rdev->sb_loaded = 1;
1791
1792         return 0;
1793 }
1794
1795 static void sb_retrieve_failed_devices(struct dm_raid_superblock *sb, uint64_t *failed_devices)
1796 {
1797         failed_devices[0] = le64_to_cpu(sb->failed_devices);
1798         memset(failed_devices + 1, 0, sizeof(sb->extended_failed_devices));
1799
1800         if (le32_to_cpu(sb->compat_features) & FEATURE_FLAG_SUPPORTS_V190) {
1801                 int i = ARRAY_SIZE(sb->extended_failed_devices);
1802
1803                 while (i--)
1804                         failed_devices[i+1] = le64_to_cpu(sb->extended_failed_devices[i]);
1805         }
1806 }
1807
1808 static void sb_update_failed_devices(struct dm_raid_superblock *sb, uint64_t *failed_devices)
1809 {
1810         int i = ARRAY_SIZE(sb->extended_failed_devices);
1811
1812         sb->failed_devices = cpu_to_le64(failed_devices[0]);
1813         while (i--)
1814                 sb->extended_failed_devices[i] = cpu_to_le64(failed_devices[i+1]);
1815 }
1816
1817 /*
1818  * Synchronize the superblock members with the raid set properties
1819  *
1820  * All superblock data is little endian.
1821  */
1822 static void super_sync(struct mddev *mddev, struct md_rdev *rdev)
1823 {
1824         bool update_failed_devices = false;
1825         unsigned int i;
1826         uint64_t failed_devices[DISKS_ARRAY_ELEMS];
1827         struct dm_raid_superblock *sb;
1828         struct raid_set *rs = container_of(mddev, struct raid_set, md);
1829
1830         /* No metadata device, no superblock */
1831         if (!rdev->meta_bdev)
1832                 return;
1833
1834         BUG_ON(!rdev->sb_page);
1835
1836         sb = page_address(rdev->sb_page);
1837
1838         sb_retrieve_failed_devices(sb, failed_devices);
1839
1840         for (i = 0; i < rs->raid_disks; i++)
1841                 if (!rs->dev[i].data_dev || test_bit(Faulty, &rs->dev[i].rdev.flags)) {
1842                         update_failed_devices = true;
1843                         set_bit(i, (void *) failed_devices);
1844                 }
1845
1846         if (update_failed_devices)
1847                 sb_update_failed_devices(sb, failed_devices);
1848
1849         sb->magic = cpu_to_le32(DM_RAID_MAGIC);
1850         sb->compat_features = cpu_to_le32(FEATURE_FLAG_SUPPORTS_V190);
1851
1852         sb->num_devices = cpu_to_le32(mddev->raid_disks);
1853         sb->array_position = cpu_to_le32(rdev->raid_disk);
1854
1855         sb->events = cpu_to_le64(mddev->events);
1856
1857         sb->disk_recovery_offset = cpu_to_le64(rdev->recovery_offset);
1858         sb->array_resync_offset = cpu_to_le64(mddev->recovery_cp);
1859
1860         sb->level = cpu_to_le32(mddev->level);
1861         sb->layout = cpu_to_le32(mddev->layout);
1862         sb->stripe_sectors = cpu_to_le32(mddev->chunk_sectors);
1863
1864         sb->new_level = cpu_to_le32(mddev->new_level);
1865         sb->new_layout = cpu_to_le32(mddev->new_layout);
1866         sb->new_stripe_sectors = cpu_to_le32(mddev->new_chunk_sectors);
1867
1868         sb->delta_disks = cpu_to_le32(mddev->delta_disks);
1869
1870         smp_rmb(); /* Make sure we access most recent reshape position */
1871         sb->reshape_position = cpu_to_le64(mddev->reshape_position);
1872         if (le64_to_cpu(sb->reshape_position) != MaxSector) {
1873                 /* Flag ongoing reshape */
1874                 sb->flags |= cpu_to_le32(SB_FLAG_RESHAPE_ACTIVE);
1875
1876                 if (mddev->delta_disks < 0 || mddev->reshape_backwards)
1877                         sb->flags |= cpu_to_le32(SB_FLAG_RESHAPE_BACKWARDS);
1878         } else {
1879                 /* Clear reshape flags */
1880                 sb->flags &= ~(cpu_to_le32(SB_FLAG_RESHAPE_ACTIVE|SB_FLAG_RESHAPE_BACKWARDS));
1881         }
1882
1883         sb->array_sectors = cpu_to_le64(mddev->array_sectors);
1884         sb->data_offset = cpu_to_le64(rdev->data_offset);
1885         sb->new_data_offset = cpu_to_le64(rdev->new_data_offset);
1886         sb->sectors = cpu_to_le64(rdev->sectors);
1887
1888         /* Zero out the rest of the payload after the size of the superblock */
1889         memset(sb + 1, 0, rdev->sb_size - sizeof(*sb));
1890 }
1891
1892 /*
1893  * super_load
1894  *
1895  * This function creates a superblock if one is not found on the device
1896  * and will decide which superblock to use if there's a choice.
1897  *
1898  * Return: 1 if use rdev, 0 if use refdev, -Exxx otherwise
1899  */
1900 static int super_load(struct md_rdev *rdev, struct md_rdev *refdev)
1901 {
1902         int r;
1903         struct dm_raid_superblock *sb;
1904         struct dm_raid_superblock *refsb;
1905         uint64_t events_sb, events_refsb;
1906
1907         rdev->sb_start = 0;
1908         rdev->sb_size = bdev_logical_block_size(rdev->meta_bdev);
1909         if (rdev->sb_size < sizeof(*sb) || rdev->sb_size > PAGE_SIZE) {
1910                 DMERR("superblock size of a logical block is no longer valid");
1911                 return -EINVAL;
1912         }
1913
1914         r = read_disk_sb(rdev, rdev->sb_size);
1915         if (r)
1916                 return r;
1917
1918         sb = page_address(rdev->sb_page);
1919
1920         /*
1921          * Two cases that we want to write new superblocks and rebuild:
1922          * 1) New device (no matching magic number)
1923          * 2) Device specified for rebuild (!In_sync w/ offset == 0)
1924          */
1925         if ((sb->magic != cpu_to_le32(DM_RAID_MAGIC)) ||
1926             (!test_bit(In_sync, &rdev->flags) && !rdev->recovery_offset)) {
1927                 super_sync(rdev->mddev, rdev);
1928
1929                 set_bit(FirstUse, &rdev->flags);
1930                 sb->compat_features = cpu_to_le32(FEATURE_FLAG_SUPPORTS_V190);
1931
1932                 /* Force writing of superblocks to disk */
1933                 set_bit(MD_CHANGE_DEVS, &rdev->mddev->flags);
1934
1935                 /* Any superblock is better than none, choose that if given */
1936                 return refdev ? 0 : 1;
1937         }
1938
1939         if (!refdev)
1940                 return 1;
1941
1942         events_sb = le64_to_cpu(sb->events);
1943
1944         refsb = page_address(refdev->sb_page);
1945         events_refsb = le64_to_cpu(refsb->events);
1946
1947         return (events_sb > events_refsb) ? 1 : 0;
1948 }
1949
1950 static int super_init_validation(struct raid_set *rs, struct md_rdev *rdev)
1951 {
1952         int role;
1953         unsigned int d;
1954         struct mddev *mddev = &rs->md;
1955         uint64_t events_sb;
1956         uint64_t failed_devices[DISKS_ARRAY_ELEMS];
1957         struct dm_raid_superblock *sb;
1958         uint32_t new_devs = 0, rebuild_and_new = 0, rebuilds = 0;
1959         struct md_rdev *r;
1960         struct dm_raid_superblock *sb2;
1961
1962         sb = page_address(rdev->sb_page);
1963         events_sb = le64_to_cpu(sb->events);
1964
1965         /*
1966          * Initialise to 1 if this is a new superblock.
1967          */
1968         mddev->events = events_sb ? : 1;
1969
1970         mddev->reshape_position = MaxSector;
1971
1972         /*
1973          * Reshaping is supported, e.g. reshape_position is valid
1974          * in superblock and superblock content is authoritative.
1975          */
1976         if (le32_to_cpu(sb->compat_features) & FEATURE_FLAG_SUPPORTS_V190) {
1977                 /* Superblock is authoritative wrt given raid set layout! */
1978                 mddev->raid_disks = le32_to_cpu(sb->num_devices);
1979                 mddev->level = le32_to_cpu(sb->level);
1980                 mddev->layout = le32_to_cpu(sb->layout);
1981                 mddev->chunk_sectors = le32_to_cpu(sb->stripe_sectors);
1982                 mddev->new_level = le32_to_cpu(sb->new_level);
1983                 mddev->new_layout = le32_to_cpu(sb->new_layout);
1984                 mddev->new_chunk_sectors = le32_to_cpu(sb->new_stripe_sectors);
1985                 mddev->delta_disks = le32_to_cpu(sb->delta_disks);
1986                 mddev->array_sectors = le64_to_cpu(sb->array_sectors);
1987
1988                 /* raid was reshaping and got interrupted */
1989                 if (le32_to_cpu(sb->flags) & SB_FLAG_RESHAPE_ACTIVE) {
1990                         if (test_bit(__CTR_FLAG_DELTA_DISKS, &rs->ctr_flags)) {
1991                                 DMERR("Reshape requested but raid set is still reshaping");
1992                                 return -EINVAL;
1993                         }
1994
1995                         if (mddev->delta_disks < 0 ||
1996                             (!mddev->delta_disks && (le32_to_cpu(sb->flags) & SB_FLAG_RESHAPE_BACKWARDS)))
1997                                 mddev->reshape_backwards = 1;
1998                         else
1999                                 mddev->reshape_backwards = 0;
2000
2001                         mddev->reshape_position = le64_to_cpu(sb->reshape_position);
2002                         rs->raid_type = get_raid_type_by_ll(mddev->level, mddev->layout);
2003                 }
2004
2005         } else {
2006                 /*
2007                  * No takeover/reshaping, because we don't have the extended v1.9.0 metadata
2008                  */
2009                 if (le32_to_cpu(sb->level) != mddev->level) {
2010                         DMERR("Reshaping/takeover raid sets not yet supported. (raid level/stripes/size change)");
2011                         return -EINVAL;
2012                 }
2013                 if (le32_to_cpu(sb->layout) != mddev->layout) {
2014                         DMERR("Reshaping raid sets not yet supported. (raid layout change)");
2015                         DMERR("  0x%X vs 0x%X", le32_to_cpu(sb->layout), mddev->layout);
2016                         DMERR("  Old layout: %s w/ %d copies",
2017                               raid10_md_layout_to_format(le32_to_cpu(sb->layout)),
2018                               raid10_md_layout_to_copies(le32_to_cpu(sb->layout)));
2019                         DMERR("  New layout: %s w/ %d copies",
2020                               raid10_md_layout_to_format(mddev->layout),
2021                               raid10_md_layout_to_copies(mddev->layout));
2022                         return -EINVAL;
2023                 }
2024                 if (le32_to_cpu(sb->stripe_sectors) != mddev->chunk_sectors) {
2025                         DMERR("Reshaping raid sets not yet supported. (stripe sectors change)");
2026                         return -EINVAL;
2027                 }
2028
2029                 /* We can only change the number of devices in raid1 with old (i.e. pre 1.0.7) metadata */
2030                 if (!rt_is_raid1(rs->raid_type) &&
2031                     (le32_to_cpu(sb->num_devices) != mddev->raid_disks)) {
2032                         DMERR("Reshaping raid sets not yet supported. (device count change from %u to %u)",
2033                               sb->num_devices, mddev->raid_disks);
2034                         return -EINVAL;
2035                 }
2036
2037                 /* Table line is checked vs. authoritative superblock */
2038                 rs_set_new(rs);
2039         }
2040
2041         if (!test_bit(__CTR_FLAG_NOSYNC, &rs->ctr_flags))
2042                 mddev->recovery_cp = le64_to_cpu(sb->array_resync_offset);
2043
2044         /*
2045          * During load, we set FirstUse if a new superblock was written.
2046          * There are two reasons we might not have a superblock:
2047          * 1) The raid set is brand new - in which case, all of the
2048          *    devices must have their In_sync bit set.  Also,
2049          *    recovery_cp must be 0, unless forced.
2050          * 2) This is a new device being added to an old raid set
2051          *    and the new device needs to be rebuilt - in which
2052          *    case the In_sync bit will /not/ be set and
2053          *    recovery_cp must be MaxSector.
2054          * 3) This is/are a new device(s) being added to an old
2055          *    raid set during takeover to a higher raid level
2056          *    to provide capacity for redundancy or during reshape
2057          *    to add capacity to grow the raid set.
2058          */
2059         d = 0;
2060         rdev_for_each(r, mddev) {
2061                 if (test_bit(FirstUse, &r->flags))
2062                         new_devs++;
2063
2064                 if (!test_bit(In_sync, &r->flags)) {
2065                         DMINFO("Device %d specified for rebuild; clearing superblock",
2066                                 r->raid_disk);
2067                         rebuilds++;
2068
2069                         if (test_bit(FirstUse, &r->flags))
2070                                 rebuild_and_new++;
2071                 }
2072
2073                 d++;
2074         }
2075
2076         if (new_devs == rs->raid_disks || !rebuilds) {
2077                 /* Replace a broken device */
2078                 if (new_devs == 1 && !rs->delta_disks)
2079                         ;
2080                 if (new_devs == rs->raid_disks) {
2081                         DMINFO("Superblocks created for new raid set");
2082                         set_bit(MD_ARRAY_FIRST_USE, &mddev->flags);
2083                         mddev->recovery_cp = 0;
2084                 } else if (new_devs != rebuilds &&
2085                            new_devs != rs->delta_disks) {
2086                         DMERR("New device injected into existing raid set without "
2087                               "'delta_disks' or 'rebuild' parameter specified");
2088                         return -EINVAL;
2089                 }
2090         } else if (new_devs && new_devs != rebuilds) {
2091                 DMERR("%u 'rebuild' devices cannot be injected into"
2092                       " a raid set with %u other first-time devices",
2093                       rebuilds, new_devs);
2094                 return -EINVAL;
2095         } else if (rebuilds) {
2096                 if (rebuild_and_new && rebuilds != rebuild_and_new) {
2097                         DMERR("new device%s provided without 'rebuild'",
2098                               new_devs > 1 ? "s" : "");
2099                         return -EINVAL;
2100                 } else if (rs_is_recovering(rs)) {
2101                         DMERR("'rebuild' specified while raid set is not in-sync (recovery_cp=%llu)",
2102                               (unsigned long long) mddev->recovery_cp);
2103                         return -EINVAL;
2104                 } else if (rs_is_reshaping(rs)) {
2105                         DMERR("'rebuild' specified while raid set is being reshaped (reshape_position=%llu)",
2106                               (unsigned long long) mddev->reshape_position);
2107                         return -EINVAL;
2108                 }
2109         }
2110
2111         /*
2112          * Now we set the Faulty bit for those devices that are
2113          * recorded in the superblock as failed.
2114          */
2115         sb_retrieve_failed_devices(sb, failed_devices);
2116         rdev_for_each(r, mddev) {
2117                 if (!r->sb_page)
2118                         continue;
2119                 sb2 = page_address(r->sb_page);
2120                 sb2->failed_devices = 0;
2121                 memset(sb2->extended_failed_devices, 0, sizeof(sb2->extended_failed_devices));
2122
2123                 /*
2124                  * Check for any device re-ordering.
2125                  */
2126                 if (!test_bit(FirstUse, &r->flags) && (r->raid_disk >= 0)) {
2127                         role = le32_to_cpu(sb2->array_position);
2128                         if (role < 0)
2129                                 continue;
2130
2131                         if (role != r->raid_disk) {
2132                                 if (__is_raid10_near(mddev->layout)) {
2133                                         if (mddev->raid_disks % __raid10_near_copies(mddev->layout) ||
2134                                             rs->raid_disks % rs->raid10_copies) {
2135                                                 rs->ti->error =
2136                                                         "Cannot change raid10 near set to odd # of devices!";
2137                                                 return -EINVAL;
2138                                         }
2139
2140                                         sb2->array_position = cpu_to_le32(r->raid_disk);
2141
2142                                 } else if (!(rs_is_raid10(rs) && rt_is_raid0(rs->raid_type)) &&
2143                                            !(rs_is_raid0(rs) && rt_is_raid10(rs->raid_type)) &&
2144                                            !rt_is_raid1(rs->raid_type)) {
2145                                         rs->ti->error = "Cannot change device positions in raid set";
2146                                         return -EINVAL;
2147                                 }
2148
2149                                 DMINFO("raid device #%d now at position #%d", role, r->raid_disk);
2150                         }
2151
2152                         /*
2153                          * Partial recovery is performed on
2154                          * returning failed devices.
2155                          */
2156                         if (test_bit(role, (void *) failed_devices))
2157                                 set_bit(Faulty, &r->flags);
2158                 }
2159         }
2160
2161         return 0;
2162 }
2163
2164 static int super_validate(struct raid_set *rs, struct md_rdev *rdev)
2165 {
2166         struct mddev *mddev = &rs->md;
2167         struct dm_raid_superblock *sb;
2168
2169         if (rs_is_raid0(rs) || !rdev->sb_page)
2170                 return 0;
2171
2172         sb = page_address(rdev->sb_page);
2173
2174         /*
2175          * If mddev->events is not set, we know we have not yet initialized
2176          * the array.
2177          */
2178         if (!mddev->events && super_init_validation(rs, rdev))
2179                 return -EINVAL;
2180
2181         if (le32_to_cpu(sb->compat_features) != FEATURE_FLAG_SUPPORTS_V190) {
2182                 rs->ti->error = "Unable to assemble array: Unknown flag(s) in compatible feature flags";
2183                 return -EINVAL;
2184         }
2185
2186         if (sb->incompat_features) {
2187                 rs->ti->error = "Unable to assemble array: No incompatible feature flags supported yet";
2188                 return -EINVAL;
2189         }
2190
2191         /* Enable bitmap creation for RAID levels != 0 */
2192         mddev->bitmap_info.offset = rt_is_raid0(rs->raid_type) ? 0 : to_sector(4096);
2193         rdev->mddev->bitmap_info.default_offset = mddev->bitmap_info.offset;
2194
2195         if (!test_and_clear_bit(FirstUse, &rdev->flags)) {
2196                 /* Retrieve device size stored in superblock to be prepared for shrink */
2197                 rdev->sectors = le64_to_cpu(sb->sectors);
2198                 rdev->recovery_offset = le64_to_cpu(sb->disk_recovery_offset);
2199                 if (rdev->recovery_offset == MaxSector)
2200                         set_bit(In_sync, &rdev->flags);
2201                 /*
2202                  * If no reshape in progress -> we're recovering single
2203                  * disk(s) and have to set the device(s) to out-of-sync
2204                  */
2205                 else if (!rs_is_reshaping(rs))
2206                         clear_bit(In_sync, &rdev->flags); /* Mandatory for recovery */
2207         }
2208
2209         /*
2210          * If a device comes back, set it as not In_sync and no longer faulty.
2211          */
2212         if (test_and_clear_bit(Faulty, &rdev->flags)) {
2213                 rdev->recovery_offset = 0;
2214                 clear_bit(In_sync, &rdev->flags);
2215                 rdev->saved_raid_disk = rdev->raid_disk;
2216         }
2217
2218         /* Reshape support -> restore repective data offsets */
2219         rdev->data_offset = le64_to_cpu(sb->data_offset);
2220         rdev->new_data_offset = le64_to_cpu(sb->new_data_offset);
2221
2222         return 0;
2223 }
2224
2225 /*
2226  * Analyse superblocks and select the freshest.
2227  */
2228 static int analyse_superblocks(struct dm_target *ti, struct raid_set *rs)
2229 {
2230         int r;
2231         struct raid_dev *dev;
2232         struct md_rdev *rdev, *tmp, *freshest;
2233         struct mddev *mddev = &rs->md;
2234
2235         freshest = NULL;
2236         rdev_for_each_safe(rdev, tmp, mddev) {
2237                 /*
2238                  * Skipping super_load due to CTR_FLAG_SYNC will cause
2239                  * the array to undergo initialization again as
2240                  * though it were new.  This is the intended effect
2241                  * of the "sync" directive.
2242                  *
2243                  * When reshaping capability is added, we must ensure
2244                  * that the "sync" directive is disallowed during the
2245                  * reshape.
2246                  */
2247                 if (test_bit(__CTR_FLAG_SYNC, &rs->ctr_flags))
2248                         continue;
2249
2250                 if (!rdev->meta_bdev)
2251                         continue;
2252
2253                 r = super_load(rdev, freshest);
2254
2255                 switch (r) {
2256                 case 1:
2257                         freshest = rdev;
2258                         break;
2259                 case 0:
2260                         break;
2261                 default:
2262                         dev = container_of(rdev, struct raid_dev, rdev);
2263                         if (dev->meta_dev)
2264                                 dm_put_device(ti, dev->meta_dev);
2265
2266                         dev->meta_dev = NULL;
2267                         rdev->meta_bdev = NULL;
2268
2269                         if (rdev->sb_page)
2270                                 put_page(rdev->sb_page);
2271
2272                         rdev->sb_page = NULL;
2273
2274                         rdev->sb_loaded = 0;
2275
2276                         /*
2277                          * We might be able to salvage the data device
2278                          * even though the meta device has failed.  For
2279                          * now, we behave as though '- -' had been
2280                          * set for this device in the table.
2281                          */
2282                         if (dev->data_dev)
2283                                 dm_put_device(ti, dev->data_dev);
2284
2285                         dev->data_dev = NULL;
2286                         rdev->bdev = NULL;
2287
2288                         list_del(&rdev->same_set);
2289                 }
2290         }
2291
2292         if (!freshest)
2293                 return 0;
2294
2295         if (validate_raid_redundancy(rs)) {
2296                 rs->ti->error = "Insufficient redundancy to activate array";
2297                 return -EINVAL;
2298         }
2299
2300         /*
2301          * Validation of the freshest device provides the source of
2302          * validation for the remaining devices.
2303          */
2304         rs->ti->error = "Unable to assemble array: Invalid superblocks";
2305         if (super_validate(rs, freshest))
2306                 return -EINVAL;
2307
2308         rdev_for_each(rdev, mddev)
2309                 if ((rdev != freshest) && super_validate(rs, rdev))
2310                         return -EINVAL;
2311         return 0;
2312 }
2313
2314 /*
2315  * Adjust data_offset and new_data_offset on all disk members of @rs
2316  * for out of place reshaping if requested by contructor
2317  *
2318  * We need free space at the beginning of each raid disk for forward
2319  * and at the end for backward reshapes which userspace has to provide
2320  * via remapping/reordering of space.
2321  */
2322 static int rs_adjust_data_offsets(struct raid_set *rs)
2323 {
2324         sector_t data_offset = 0, new_data_offset = 0;
2325         struct md_rdev *rdev;
2326
2327         /* Constructor did not request data offset change */
2328         if (!test_bit(__CTR_FLAG_DATA_OFFSET, &rs->ctr_flags)) {
2329                 if (!rs_is_reshapable(rs))
2330                         goto out;
2331
2332                 return 0;
2333         }
2334
2335         /* HM FIXME: get InSync raid_dev? */
2336         rdev = &rs->dev[0].rdev;
2337
2338         if (rs->delta_disks < 0) {
2339                 /*
2340                  * Removing disks (reshaping backwards):
2341                  *
2342                  * - before reshape: data is at offset 0 and free space
2343                  *                   is at end of each component LV
2344                  *
2345                  * - after reshape: data is at offset rs->data_offset != 0 on each component LV
2346                  */
2347                 data_offset = 0;
2348                 new_data_offset = rs->data_offset;
2349
2350         } else if (rs->delta_disks > 0) {
2351                 /*
2352                  * Adding disks (reshaping forwards):
2353                  *
2354                  * - before reshape: data is at offset rs->data_offset != 0 and
2355                  *                   free space is at begin of each component LV
2356                  *
2357                  * - after reshape: data is at offset 0 on each component LV
2358                  */
2359                 data_offset = rs->data_offset;
2360                 new_data_offset = 0;
2361
2362         } else {
2363                 /*
2364                  * User space passes in 0 for data offset after having removed reshape space
2365                  *
2366                  * - or - (data offset != 0)
2367                  *
2368                  * Changing RAID layout or chunk size -> toggle offsets
2369                  *
2370                  * - before reshape: data is at offset rs->data_offset 0 and
2371                  *                   free space is at end of each component LV
2372                  *                   -or-
2373                  *                   data is at offset rs->data_offset != 0 and
2374                  *                   free space is at begin of each component LV
2375                  *
2376                  * - after reshape: data is at offset 0 if i was at offset != 0
2377                  *                  of at offset != 0 if it was at offset 0
2378                  *                  on each component LV
2379                  *
2380                  */
2381                 data_offset = rs->data_offset ? rdev->data_offset : 0;
2382                 new_data_offset = data_offset ? 0 : rs->data_offset;
2383                 set_bit(RT_FLAG_UPDATE_SBS, &rs->runtime_flags);
2384         }
2385
2386         /*
2387          * Make sure we got a minimum amount of free sectors per device
2388          */
2389         if (rs->data_offset &&
2390             to_sector(i_size_read(rdev->bdev->bd_inode)) - rdev->sectors < MIN_FREE_RESHAPE_SPACE) {
2391                 rs->ti->error = data_offset ? "No space for forward reshape" :
2392                                               "No space for backward reshape";
2393                 return -ENOSPC;
2394         }
2395 out:
2396         /* Adjust data offsets on all rdevs */
2397         rdev_for_each(rdev, &rs->md) {
2398                 rdev->data_offset = data_offset;
2399                 rdev->new_data_offset = new_data_offset;
2400         }
2401
2402         return 0;
2403 }
2404
2405 /* Userpace reordered disks -> adjust raid_disk indexes in @rs */
2406 static void __reorder_raid_disk_indexes(struct raid_set *rs)
2407 {
2408         int i = 0;
2409         struct md_rdev *rdev;
2410
2411         rdev_for_each(rdev, &rs->md) {
2412                 rdev->raid_disk = i++;
2413                 rdev->saved_raid_disk = rdev->new_raid_disk = -1;
2414         }
2415 }
2416
2417 /*
2418  * Setup @rs for takeover by a different raid level
2419  */
2420 static int rs_setup_takeover(struct raid_set *rs)
2421 {
2422         struct mddev *mddev = &rs->md;
2423         struct md_rdev *rdev;
2424         unsigned int d = mddev->raid_disks = rs->raid_disks;
2425         sector_t new_data_offset = rs->dev[0].rdev.data_offset ? 0 : rs->data_offset;
2426
2427         if (rt_is_raid10(rs->raid_type)) {
2428                 if (mddev->level == 0) {
2429                         /* Userpace reordered disks -> adjust raid_disk indexes */
2430                         __reorder_raid_disk_indexes(rs);
2431
2432                         /* raid0 -> raid10_far layout */
2433                         mddev->layout = raid10_format_to_md_layout(rs, ALGORITHM_RAID10_FAR,
2434                                                                    rs->raid10_copies);
2435                 } else if (mddev->level == 1)
2436                         /* raid1 -> raid10_near layout */
2437                         mddev->layout = raid10_format_to_md_layout(rs, ALGORITHM_RAID10_NEAR,
2438                                                                    rs->raid_disks);
2439                  else
2440                         return -EINVAL;
2441
2442         }
2443
2444         clear_bit(MD_ARRAY_FIRST_USE, &mddev->flags);
2445         mddev->recovery_cp = MaxSector;
2446
2447         while (d--) {
2448                 rdev = &rs->dev[d].rdev;
2449
2450                 if (test_bit(d, (void *) rs->rebuild_disks)) {
2451                         clear_bit(In_sync, &rdev->flags);
2452                         clear_bit(Faulty, &rdev->flags);
2453                         mddev->recovery_cp = rdev->recovery_offset = 0;
2454                         /* Bitmap has to be created when we do an "up" takeover */
2455                         set_bit(MD_ARRAY_FIRST_USE, &mddev->flags);
2456                 }
2457
2458                 rdev->new_data_offset = new_data_offset;
2459         }
2460
2461         return 0;
2462 }
2463
2464 /*
2465  *
2466  * - change raid layout
2467  * - change chunk size
2468  * - add disks
2469  * - remove disks
2470  */
2471 static int rs_setup_reshape(struct raid_set *rs)
2472 {
2473         int r = 0;
2474         unsigned int cur_raid_devs, d;
2475         struct mddev *mddev = &rs->md;
2476         struct md_rdev *rdev;
2477
2478         mddev->delta_disks = rs->delta_disks;
2479         cur_raid_devs = mddev->raid_disks;
2480
2481         /* Ignore impossible layout change whilst adding/removing disks */
2482         if (mddev->delta_disks &&
2483             mddev->layout != mddev->new_layout) {
2484                 DMINFO("Ignoring invalid layout change with delta_disks=%d", rs->delta_disks);
2485                 mddev->new_layout = mddev->layout;
2486         }
2487
2488         /*
2489          * Adjust array size:
2490          *
2491          * - in case of adding disks, array size has
2492          *   to grow after the disk adding reshape,
2493          *   which'll hapen in the event handler;
2494          *   reshape will happen forward, so space has to
2495          *   be available at the beginning of each disk
2496          *
2497          * - in case of removing disks, array size
2498          *   has to shrink before starting the reshape,
2499          *   which'll happen here;
2500          *   reshape will happen backward, so space has to
2501          *   be available at the end of each disk
2502          *
2503          * - data_offset and new_data_offset are
2504          *   adjusted for afreentioned out of place
2505          *   reshaping based on userspace passing in
2506          *   the "data_offset <sectors>" key/value
2507          *   pair via te constructor
2508          */
2509
2510         /* Add disk(s) */
2511         if (rs->delta_disks > 0) {
2512                 /* Prepare disks for check in raid4/5/6/10 {check|start}_reshape */
2513                 for (d = cur_raid_devs; d < rs->raid_disks; d++) {
2514                         rdev = &rs->dev[d].rdev;
2515                         clear_bit(In_sync, &rdev->flags);
2516
2517                         /*
2518                          * save_raid_disk needs to be -1, or recovery_offset will be set to 0
2519                          * by md, which'll store that erroneously in the superblock on reshape
2520                          */
2521                         rdev->saved_raid_disk = -1;
2522                         rdev->raid_disk = d;
2523
2524                         rdev->sectors = mddev->dev_sectors;
2525                         rdev->recovery_offset = MaxSector;
2526                 }
2527
2528                 mddev->reshape_backwards = 0; /* adding disks -> forward reshape */
2529
2530         /* Remove disk(s) */
2531         } else if (rs->delta_disks < 0) {
2532                 r = rs_set_dev_and_array_sectors(rs, true);
2533                 mddev->reshape_backwards = 1; /* removing disk(s) -> backward reshape */
2534
2535         /* Change layout and/or chunk size */
2536         } else {
2537                 /*
2538                  * Reshape layout (e.g. raid5_ls -> raid5_n) and/or chunk size:
2539                  *
2540                  * keeping number of disks and do layout change ->
2541                  *
2542                  * toggle reshape_backward depending on data_offset:
2543                  *
2544                  * - free space upfront -> reshape forward
2545                  *
2546                  * - free space at the end -> reshape backward
2547                  *
2548                  *
2549                  * This utilizes free reshape space avoiding the need
2550                  * for userspace to move (parts of) LV segments in
2551                  * case of layout/chunksize change  (for disk
2552                  * adding/removing reshape space has to be at
2553                  * the proper address (see above with delta_disks):
2554                  *
2555                  * add disk(s)   -> begin
2556                  * remove disk(s)-> end
2557                  */
2558                 mddev->reshape_backwards = rs->dev[0].rdev.data_offset ? 0 : 1;
2559         }
2560
2561         return r;
2562 }
2563
2564 /*
2565  * Enable/disable discard support on RAID set depending on
2566  * RAID level and discard properties of underlying RAID members.
2567  */
2568 static void configure_discard_support(struct raid_set *rs)
2569 {
2570         int i;
2571         bool raid456;
2572         struct dm_target *ti = rs->ti;
2573
2574         /* Assume discards not supported until after checks below. */
2575         ti->discards_supported = false;
2576
2577         /* RAID level 4,5,6 require discard_zeroes_data for data integrity! */
2578         raid456 = (rs->md.level == 4 || rs->md.level == 5 || rs->md.level == 6);
2579
2580         for (i = 0; i < rs->md.raid_disks; i++) {
2581                 struct request_queue *q;
2582
2583                 if (!rs->dev[i].rdev.bdev)
2584                         continue;
2585
2586                 q = bdev_get_queue(rs->dev[i].rdev.bdev);
2587                 if (!q || !blk_queue_discard(q))
2588                         return;
2589
2590                 if (raid456) {
2591                         if (!q->limits.discard_zeroes_data)
2592                                 return;
2593                         if (!devices_handle_discard_safely) {
2594                                 DMERR("raid456 discard support disabled due to discard_zeroes_data uncertainty.");
2595                                 DMERR("Set dm-raid.devices_handle_discard_safely=Y to override.");
2596                                 return;
2597                         }
2598                 }
2599         }
2600
2601         /* All RAID members properly support discards */
2602         ti->discards_supported = true;
2603
2604         /*
2605          * RAID1 and RAID10 personalities require bio splitting,
2606          * RAID0/4/5/6 don't and process large discard bios properly.
2607          */
2608         ti->split_discard_bios = !!(rs->md.level == 1 || rs->md.level == 10);
2609         ti->num_discard_bios = 1;
2610 }
2611
2612 /*
2613  * Construct a RAID0/1/10/4/5/6 mapping:
2614  * Args:
2615  *      <raid_type> <#raid_params> <raid_params>{0,}    \
2616  *      <#raid_devs> [<meta_dev1> <dev1>]{1,}
2617  *
2618  * <raid_params> varies by <raid_type>.  See 'parse_raid_params' for
2619  * details on possible <raid_params>.
2620  *
2621  * Userspace is free to initialize the metadata devices, hence the superblocks to
2622  * enforce recreation based on the passed in table parameters.
2623  *
2624  */
2625 static int raid_ctr(struct dm_target *ti, unsigned argc, char **argv)
2626 {
2627         int r;
2628         struct raid_type *rt;
2629         unsigned num_raid_params, num_raid_devs;
2630         struct raid_set *rs = NULL;
2631         const char *arg;
2632         struct rs_layout rs_layout;
2633         struct dm_arg_set as = { argc, argv }, as_nrd;
2634         struct dm_arg _args[] = {
2635                 { 0, as.argc, "Cannot understand number of raid parameters" },
2636                 { 1, 254, "Cannot understand number of raid devices parameters" }
2637         };
2638
2639         /* Must have <raid_type> */
2640         arg = dm_shift_arg(&as);
2641         if (!arg) {
2642                 ti->error = "No arguments";
2643                 return -EINVAL;
2644         }
2645
2646         rt = get_raid_type(arg);
2647         if (!rt) {
2648                 ti->error = "Unrecognised raid_type";
2649                 return -EINVAL;
2650         }
2651
2652         /* Must have <#raid_params> */
2653         if (dm_read_arg_group(_args, &as, &num_raid_params, &ti->error))
2654                 return -EINVAL;
2655
2656         /* number of raid device tupples <meta_dev data_dev> */
2657         as_nrd = as;
2658         dm_consume_args(&as_nrd, num_raid_params);
2659         _args[1].max = (as_nrd.argc - 1) / 2;
2660         if (dm_read_arg(_args + 1, &as_nrd, &num_raid_devs, &ti->error))
2661                 return -EINVAL;
2662
2663         if (!__within_range(num_raid_devs, 1, MAX_RAID_DEVICES)) {
2664                 ti->error = "Invalid number of supplied raid devices";
2665                 return -EINVAL;
2666         }
2667
2668         rs = raid_set_alloc(ti, rt, num_raid_devs);
2669         if (IS_ERR(rs))
2670                 return PTR_ERR(rs);
2671
2672         r = parse_raid_params(rs, &as, num_raid_params);
2673         if (r)
2674                 goto bad;
2675
2676         r = parse_dev_params(rs, &as);
2677         if (r)
2678                 goto bad;
2679
2680         rs->md.sync_super = super_sync;
2681
2682         r = rs_set_dev_and_array_sectors(rs, false);
2683         if (r)
2684                 return r;
2685
2686         /*
2687          * Backup any new raid set level, layout, ...
2688          * requested to be able to compare to superblock
2689          * members for conversion decisions.
2690          */
2691         rs_config_backup(rs, &rs_layout);
2692
2693         r = analyse_superblocks(ti, rs);
2694         if (r)
2695                 goto bad;
2696
2697         INIT_WORK(&rs->md.event_work, do_table_event);
2698         ti->private = rs;
2699         ti->num_flush_bios = 1;
2700
2701         /* Restore any requested new layout for conversion decision */
2702         rs_config_restore(rs, &rs_layout);
2703
2704         if (test_bit(MD_ARRAY_FIRST_USE, &rs->md.flags)) {
2705                 set_bit(RT_FLAG_UPDATE_SBS, &rs->runtime_flags);
2706                 rs_set_new(rs);
2707         } else if (rs_is_reshaping(rs))
2708                 ; /* skip rs setup */
2709         else if (rs_takeover_requested(rs)) {
2710                 if (rs_is_reshaping(rs)) {
2711                         ti->error = "Can't takeover a reshaping raid set";
2712                         return -EPERM;
2713                 }
2714
2715                 /*
2716                  * If a takeover is needed, just set the level to
2717                  * the new requested one and allow the raid set to run.
2718                  */
2719                 r = rs_check_takeover(rs);
2720                 if (r)
2721                         return r;
2722
2723                 r = rs_setup_takeover(rs);
2724                 if (r)
2725                         return r;
2726
2727                 set_bit(RT_FLAG_UPDATE_SBS, &rs->runtime_flags);
2728                 rs_set_new(rs);
2729         } else if (rs_reshape_requested(rs)) {
2730                 if (rs_is_reshaping(rs)) {
2731                         ti->error = "raid set already reshaping!";
2732                         return -EPERM;
2733                 }
2734
2735                 if (rs_is_raid10(rs)) {
2736                         if (rs->raid_disks != rs->md.raid_disks &&
2737                             __is_raid10_near(rs->md.layout) &&
2738                             rs->raid10_copies &&
2739                             rs->raid10_copies != __raid10_near_copies(rs->md.layout)) {
2740                                 /*
2741                                  * raid disk have to be multiple of data copies to allow this conversion,
2742                                  *
2743                                  * This is actually not a reshape it is a
2744                                  * rebuild of any additional mirrors per group
2745                                  */
2746                                 if (rs->raid_disks % rs->raid10_copies) {
2747                                         ti->error = "Can't reshape raid10 mirror groups";
2748                                         return -EINVAL;
2749                                 }
2750
2751                                 /* Userpace reordered disks to add/remove mirrors -> adjust raid_disk indexes */
2752                                 __reorder_raid_disk_indexes(rs);
2753                                 rs->md.layout = raid10_format_to_md_layout(rs, ALGORITHM_RAID10_NEAR,
2754                                                                            rs->raid10_copies);
2755                                 rs->md.new_layout = rs->md.layout;
2756
2757                         } else
2758                                 set_bit(RT_FLAG_RESHAPE_RS, &rs->runtime_flags);
2759
2760                 } else if (rs_is_raid456(rs))
2761                         set_bit(RT_FLAG_RESHAPE_RS, &rs->runtime_flags);
2762
2763                 /*
2764                  * HM FIXME: process raid1 via delta_disks as well?
2765                  *           Would cause allocations in raid1->check_reshape
2766                  *           though, thus more issues with potential failures
2767                  */
2768                 else if (rs_is_raid1(rs))
2769                         rs->md.raid_disks = rs->raid_disks;
2770
2771                 if (rs->md.raid_disks < rs->raid_disks)
2772                         set_bit(MD_ARRAY_FIRST_USE, &rs->md.flags);
2773
2774                 set_bit(RT_FLAG_UPDATE_SBS, &rs->runtime_flags);
2775                 rs_set_cur(rs);
2776         } else
2777                 rs_set_cur(rs);
2778
2779         /* If constructor requested it, change data and new_data offsets */
2780         r = rs_adjust_data_offsets(rs);
2781         if (r)
2782                 return r;
2783
2784         /* Start raid set read-only and assumed clean to change in raid_resume() */
2785         rs->md.ro = 1;
2786         rs->md.in_sync = 1;
2787         set_bit(MD_RECOVERY_FROZEN, &rs->md.recovery);
2788
2789         /* Has to be held on running the array */
2790         mddev_lock_nointr(&rs->md);
2791         r = md_run(&rs->md);
2792         rs->md.in_sync = 0; /* Assume already marked dirty */
2793
2794         if (r) {
2795                 ti->error = "Failed to run raid array";
2796                 mddev_unlock(&rs->md);
2797                 goto bad;
2798         }
2799
2800         rs->callbacks.congested_fn = raid_is_congested;
2801         dm_table_add_target_callbacks(ti->table, &rs->callbacks);
2802
2803         mddev_suspend(&rs->md);
2804
2805         /* Try to adjust the raid4/5/6 stripe cache size to the stripe size */
2806         if (rs_is_raid456(rs)) {
2807                 r = rs_set_raid456_stripe_cache(rs);
2808                 if (r)
2809                         goto bad_stripe_cache;
2810         }
2811
2812         /* Now do an early reshape check */
2813         if (test_bit(RT_FLAG_RESHAPE_RS, &rs->runtime_flags)) {
2814                 r = rs_check_reshape(rs);
2815                 if (r)
2816                         return r;
2817
2818                 /* Restore new, ctr requested layout to perform check */
2819                 rs_config_restore(rs, &rs_layout);
2820
2821                 r = rs->md.pers->check_reshape(&rs->md);
2822                 if (r) {
2823                         ti->error = "Reshape check failed";
2824                         goto bad_check_reshape;
2825                 }
2826         }
2827
2828         mddev_unlock(&rs->md);
2829         return 0;
2830
2831 bad_stripe_cache:
2832 bad_check_reshape:
2833         md_stop(&rs->md);
2834 bad:
2835         raid_set_free(rs);
2836
2837         return r;
2838 }
2839
2840 static void raid_dtr(struct dm_target *ti)
2841 {
2842         struct raid_set *rs = ti->private;
2843
2844         list_del_init(&rs->callbacks.list);
2845         md_stop(&rs->md);
2846         raid_set_free(rs);
2847 }
2848
2849 static int raid_map(struct dm_target *ti, struct bio *bio)
2850 {
2851         struct raid_set *rs = ti->private;
2852         struct mddev *mddev = &rs->md;
2853
2854         /*
2855          * If we're reshaping to add disk(s)), ti->len and
2856          * mddev->array_sectors will differ during the process
2857          * (ti->len > mddev->array_sectors), so we have to requeue
2858          * bios with addresses > mddev->array_sectors here or
2859          * or there will occur accesses past EOD of the component
2860          * data images thus erroring the raid set.
2861          */
2862         if (unlikely(bio_end_sector(bio) > mddev->array_sectors))
2863                 return DM_MAPIO_REQUEUE;
2864
2865         mddev->pers->make_request(mddev, bio);
2866
2867         return DM_MAPIO_SUBMITTED;
2868 }
2869
2870 /* Return string describing the current sync action of @mddev */
2871 static const char *decipher_sync_action(struct mddev *mddev)
2872 {
2873         if (test_bit(MD_RECOVERY_FROZEN, &mddev->recovery))
2874                 return "frozen";
2875
2876         if (test_bit(MD_RECOVERY_RUNNING, &mddev->recovery) ||
2877             (!mddev->ro && test_bit(MD_RECOVERY_NEEDED, &mddev->recovery))) {
2878                 if (test_bit(MD_RECOVERY_RESHAPE, &mddev->recovery))
2879                         return "reshape";
2880
2881                 if (test_bit(MD_RECOVERY_SYNC, &mddev->recovery)) {
2882                         if (!test_bit(MD_RECOVERY_REQUESTED, &mddev->recovery))
2883                                 return "resync";
2884                         else if (test_bit(MD_RECOVERY_CHECK, &mddev->recovery))
2885                                 return "check";
2886                         return "repair";
2887                 }
2888
2889                 if (test_bit(MD_RECOVERY_RECOVER, &mddev->recovery))
2890                         return "recover";
2891         }
2892
2893         return "idle";
2894 }
2895
2896 /*
2897  * Return status string @rdev
2898  *
2899  * Status characters:
2900  *
2901  *  'D' = Dead/Failed device
2902  *  'a' = Alive but not in-sync
2903  *  'A' = Alive and in-sync
2904  */
2905 static const char *__raid_dev_status(struct md_rdev *rdev, bool array_in_sync)
2906 {
2907         if (test_bit(Faulty, &rdev->flags))
2908                 return "D";
2909         else if (!array_in_sync || !test_bit(In_sync, &rdev->flags))
2910                 return "a";
2911         else
2912                 return "A";
2913 }
2914
2915 /* Helper to return resync/reshape progress for @rs and @array_in_sync */
2916 static sector_t rs_get_progress(struct raid_set *rs,
2917                                 sector_t resync_max_sectors, bool *array_in_sync)
2918 {
2919         sector_t r, recovery_cp, curr_resync_completed;
2920         struct mddev *mddev = &rs->md;
2921
2922         curr_resync_completed = mddev->curr_resync_completed ?: mddev->recovery_cp;
2923         recovery_cp = mddev->recovery_cp;
2924         *array_in_sync = false;
2925
2926         if (rs_is_raid0(rs)) {
2927                 r = resync_max_sectors;
2928                 *array_in_sync = true;
2929
2930         } else {
2931                 r = mddev->reshape_position;
2932
2933                 /* Reshape is relative to the array size */
2934                 if (test_bit(MD_RECOVERY_RESHAPE, &mddev->recovery) ||
2935                     r != MaxSector) {
2936                         if (r == MaxSector) {
2937                                 *array_in_sync = true;
2938                                 r = resync_max_sectors;
2939                         } else {
2940                                 /* Got to reverse on backward reshape */
2941                                 if (mddev->reshape_backwards)
2942                                         r = mddev->array_sectors - r;
2943
2944                                 /* Devide by # of data stripes */
2945                                 sector_div(r, mddev_data_stripes(rs));
2946                         }
2947
2948                 /* Sync is relative to the component device size */
2949                 } else if (test_bit(MD_RECOVERY_RUNNING, &mddev->recovery))
2950                         r = curr_resync_completed;
2951                 else
2952                         r = recovery_cp;
2953
2954                 if (r == MaxSector) {
2955                         /*
2956                          * Sync complete.
2957                          */
2958                         *array_in_sync = true;
2959                         r = resync_max_sectors;
2960                 } else if (test_bit(MD_RECOVERY_REQUESTED, &mddev->recovery)) {
2961                         /*
2962                          * If "check" or "repair" is occurring, the raid set has
2963                          * undergone an initial sync and the health characters
2964                          * should not be 'a' anymore.
2965                          */
2966                         *array_in_sync = true;
2967                 } else {
2968                         struct md_rdev *rdev;
2969
2970                         /*
2971                          * The raid set may be doing an initial sync, or it may
2972                          * be rebuilding individual components.  If all the
2973                          * devices are In_sync, then it is the raid set that is
2974                          * being initialized.
2975                          */
2976                         rdev_for_each(rdev, mddev)
2977                                 if (!test_bit(In_sync, &rdev->flags))
2978                                         *array_in_sync = true;
2979 #if 0
2980                         r = 0; /* HM FIXME: TESTME: https://bugzilla.redhat.com/show_bug.cgi?id=1210637 ? */
2981 #endif
2982                 }
2983         }
2984
2985         return r;
2986 }
2987
2988 /* Helper to return @dev name or "-" if !@dev */
2989 static const char *__get_dev_name(struct dm_dev *dev)
2990 {
2991         return dev ? dev->name : "-";
2992 }
2993
2994 static void raid_status(struct dm_target *ti, status_type_t type,
2995                         unsigned int status_flags, char *result, unsigned int maxlen)
2996 {
2997         struct raid_set *rs = ti->private;
2998         struct mddev *mddev = &rs->md;
2999         struct r5conf *conf = mddev->private;
3000         int max_nr_stripes = conf ? conf->max_nr_stripes : 0;
3001         bool array_in_sync;
3002         unsigned int raid_param_cnt = 1; /* at least 1 for chunksize */
3003         unsigned int sz = 0;
3004         unsigned int write_mostly_params = 0;
3005         sector_t progress, resync_max_sectors, resync_mismatches;
3006         const char *sync_action;
3007         struct raid_type *rt;
3008         struct md_rdev *rdev;
3009
3010         switch (type) {
3011         case STATUSTYPE_INFO:
3012                 /* *Should* always succeed */
3013                 rt = get_raid_type_by_ll(mddev->new_level, mddev->new_layout);
3014                 if (!rt)
3015                         return;
3016
3017                 DMEMIT("%s %d ", rt->name, mddev->raid_disks);
3018
3019                 /* Access most recent mddev properties for status output */
3020                 smp_rmb();
3021                 /* Get sensible max sectors even if raid set not yet started */
3022                 resync_max_sectors = test_bit(RT_FLAG_RS_PRERESUMED, &rs->runtime_flags) ?
3023                                       mddev->resync_max_sectors : mddev->dev_sectors;
3024                 progress = rs_get_progress(rs, resync_max_sectors, &array_in_sync);
3025                 resync_mismatches = (mddev->last_sync_action && !strcasecmp(mddev->last_sync_action, "check")) ?
3026                                     atomic64_read(&mddev->resync_mismatches) : 0;
3027                 sync_action = decipher_sync_action(&rs->md);
3028
3029                 /* HM FIXME: do we want another state char for raid0? It shows 'D' or 'A' now */
3030                 rdev_for_each(rdev, mddev)
3031                         DMEMIT(__raid_dev_status(rdev, array_in_sync));
3032
3033                 /*
3034                  * In-sync/Reshape ratio:
3035                  *  The in-sync ratio shows the progress of:
3036                  *   - Initializing the raid set
3037                  *   - Rebuilding a subset of devices of the raid set
3038                  *  The user can distinguish between the two by referring
3039                  *  to the status characters.
3040                  *
3041                  *  The reshape ratio shows the progress of
3042                  *  changing the raid layout or the number of
3043                  *  disks of a raid set
3044                  */
3045                 DMEMIT(" %llu/%llu", (unsigned long long) progress,
3046                                      (unsigned long long) resync_max_sectors);
3047
3048                 /*
3049                  * v1.5.0+:
3050                  *
3051                  * Sync action:
3052                  *   See Documentation/device-mapper/dm-raid.txt for
3053                  *   information on each of these states.
3054                  */
3055                 DMEMIT(" %s", sync_action);
3056
3057                 /*
3058                  * v1.5.0+:
3059                  *
3060                  * resync_mismatches/mismatch_cnt
3061                  *   This field shows the number of discrepancies found when
3062                  *   performing a "check" of the raid set.
3063                  */
3064                 DMEMIT(" %llu", (unsigned long long) resync_mismatches);
3065
3066                 /*
3067                  * v1.9.0+:
3068                  *
3069                  * data_offset (needed for out of space reshaping)
3070                  *   This field shows the data offset into the data
3071                  *   image LV where the first stripes data starts.
3072                  *
3073                  * We keep data_offset equal on all raid disks of the set,
3074                  * so retrieving it from the first raid disk is sufficient.
3075                  */
3076                 DMEMIT(" %llu", (unsigned long long) rs->dev[0].rdev.data_offset);
3077                 break;
3078
3079         case STATUSTYPE_TABLE:
3080                 /* Report the table line string you would use to construct this raid set */
3081
3082                 /* Calculate raid parameter count */
3083                 rdev_for_each(rdev, mddev)
3084                         if (test_bit(WriteMostly, &rdev->flags))
3085                                 write_mostly_params += 2;
3086                 raid_param_cnt += memweight(rs->rebuild_disks,
3087                                             DISKS_ARRAY_ELEMS * sizeof(*rs->rebuild_disks)) * 2 +
3088                                   write_mostly_params +
3089                                   hweight32(rs->ctr_flags & CTR_FLAG_OPTIONS_NO_ARGS) +
3090                                   hweight32(rs->ctr_flags & CTR_FLAG_OPTIONS_ONE_ARG) * 2;
3091                 /* Emit table line */
3092                 DMEMIT("%s %u %u", rs->raid_type->name, raid_param_cnt, mddev->new_chunk_sectors);
3093                 if (test_bit(__CTR_FLAG_RAID10_FORMAT, &rs->ctr_flags))
3094                         DMEMIT(" %s %s", dm_raid_arg_name_by_flag(CTR_FLAG_RAID10_FORMAT),
3095                                          raid10_md_layout_to_format(mddev->layout));
3096                 if (test_bit(__CTR_FLAG_RAID10_COPIES, &rs->ctr_flags))
3097                         DMEMIT(" %s %d", dm_raid_arg_name_by_flag(CTR_FLAG_RAID10_COPIES),
3098                                          raid10_md_layout_to_copies(mddev->layout));
3099                 if (test_bit(__CTR_FLAG_NOSYNC, &rs->ctr_flags))
3100                         DMEMIT(" %s", dm_raid_arg_name_by_flag(CTR_FLAG_NOSYNC));
3101                 if (test_bit(__CTR_FLAG_SYNC, &rs->ctr_flags))
3102                         DMEMIT(" %s", dm_raid_arg_name_by_flag(CTR_FLAG_SYNC));
3103                 if (test_bit(__CTR_FLAG_REGION_SIZE, &rs->ctr_flags))
3104                         DMEMIT(" %s %llu", dm_raid_arg_name_by_flag(CTR_FLAG_REGION_SIZE),
3105                                            (unsigned long long) to_sector(mddev->bitmap_info.chunksize));
3106                 if (test_bit(__CTR_FLAG_DATA_OFFSET, &rs->ctr_flags))
3107                         DMEMIT(" %s %llu", dm_raid_arg_name_by_flag(CTR_FLAG_DATA_OFFSET),
3108                                            (unsigned long long) rs->data_offset);
3109                 if (test_bit(__CTR_FLAG_DAEMON_SLEEP, &rs->ctr_flags))
3110                         DMEMIT(" %s %lu", dm_raid_arg_name_by_flag(CTR_FLAG_DAEMON_SLEEP),
3111                                           mddev->bitmap_info.daemon_sleep);
3112                 if (test_bit(__CTR_FLAG_DELTA_DISKS, &rs->ctr_flags))
3113                         DMEMIT(" %s %d", dm_raid_arg_name_by_flag(CTR_FLAG_DELTA_DISKS),
3114                                          mddev->delta_disks);
3115                 if (test_bit(__CTR_FLAG_STRIPE_CACHE, &rs->ctr_flags))
3116                         DMEMIT(" %s %d", dm_raid_arg_name_by_flag(CTR_FLAG_STRIPE_CACHE),
3117                                          max_nr_stripes);
3118                 rdev_for_each(rdev, mddev)
3119                         if (test_bit(rdev->raid_disk, (void *) rs->rebuild_disks))
3120                                 DMEMIT(" %s %u", dm_raid_arg_name_by_flag(CTR_FLAG_REBUILD),
3121                                                  rdev->raid_disk);
3122                 rdev_for_each(rdev, mddev)
3123                         if (test_bit(WriteMostly, &rdev->flags))
3124                                 DMEMIT(" %s %d", dm_raid_arg_name_by_flag(CTR_FLAG_WRITE_MOSTLY),
3125                                                  rdev->raid_disk);
3126                 if (test_bit(__CTR_FLAG_MAX_WRITE_BEHIND, &rs->ctr_flags))
3127                         DMEMIT(" %s %lu", dm_raid_arg_name_by_flag(CTR_FLAG_MAX_WRITE_BEHIND),
3128                                           mddev->bitmap_info.max_write_behind);
3129                 if (test_bit(__CTR_FLAG_MAX_RECOVERY_RATE, &rs->ctr_flags))
3130                         DMEMIT(" %s %d", dm_raid_arg_name_by_flag(CTR_FLAG_MAX_RECOVERY_RATE),
3131                                          mddev->sync_speed_max);
3132                 if (test_bit(__CTR_FLAG_MIN_RECOVERY_RATE, &rs->ctr_flags))
3133                         DMEMIT(" %s %d", dm_raid_arg_name_by_flag(CTR_FLAG_MIN_RECOVERY_RATE),
3134                                          mddev->sync_speed_min);
3135                 DMEMIT(" %d", rs->raid_disks);
3136                 rdev_for_each(rdev, mddev) {
3137                         struct raid_dev *rd = container_of(rdev, struct raid_dev, rdev);
3138
3139                         DMEMIT(" %s %s", __get_dev_name(rd->meta_dev),
3140                                          __get_dev_name(rd->data_dev));
3141                 }
3142         }
3143 }
3144
3145 static int raid_message(struct dm_target *ti, unsigned argc, char **argv)
3146 {
3147         struct raid_set *rs = ti->private;
3148         struct mddev *mddev = &rs->md;
3149
3150         if (!mddev->pers || !mddev->pers->sync_request)
3151                 return -EINVAL;
3152
3153         if (!strcasecmp(argv[0], "frozen"))
3154                 set_bit(MD_RECOVERY_FROZEN, &mddev->recovery);
3155         else
3156                 clear_bit(MD_RECOVERY_FROZEN, &mddev->recovery);
3157
3158         if (!strcasecmp(argv[0], "idle") || !strcasecmp(argv[0], "frozen")) {
3159                 if (mddev->sync_thread) {
3160                         set_bit(MD_RECOVERY_INTR, &mddev->recovery);
3161                         md_reap_sync_thread(mddev);
3162                 }
3163         } else if (test_bit(MD_RECOVERY_RUNNING, &mddev->recovery) ||
3164                    test_bit(MD_RECOVERY_NEEDED, &mddev->recovery))
3165                 return -EBUSY;
3166         else if (!strcasecmp(argv[0], "resync"))
3167                 ; /* MD_RECOVERY_NEEDED set below */
3168         else if (!strcasecmp(argv[0], "recover"))
3169                 set_bit(MD_RECOVERY_RECOVER, &mddev->recovery);
3170         else {
3171                 if (!strcasecmp(argv[0], "check"))
3172                         set_bit(MD_RECOVERY_CHECK, &mddev->recovery);
3173                 else if (!!strcasecmp(argv[0], "repair"))
3174                         return -EINVAL;
3175                 set_bit(MD_RECOVERY_REQUESTED, &mddev->recovery);
3176                 set_bit(MD_RECOVERY_SYNC, &mddev->recovery);
3177         }
3178         if (mddev->ro == 2) {
3179                 /* A write to sync_action is enough to justify
3180                  * canceling read-auto mode
3181                  */
3182                 mddev->ro = 0;
3183                 if (!mddev->suspended && mddev->sync_thread)
3184                         md_wakeup_thread(mddev->sync_thread);
3185         }
3186         set_bit(MD_RECOVERY_NEEDED, &mddev->recovery);
3187         if (!mddev->suspended && mddev->thread)
3188                 md_wakeup_thread(mddev->thread);
3189
3190         return 0;
3191 }
3192
3193 static int raid_iterate_devices(struct dm_target *ti,
3194                                 iterate_devices_callout_fn fn, void *data)
3195 {
3196         struct raid_set *rs = ti->private;
3197         unsigned i;
3198         int r = 0;
3199
3200         for (i = 0; !r && i < rs->md.raid_disks; i++)
3201                 if (rs->dev[i].data_dev)
3202                         r = fn(ti,
3203                                  rs->dev[i].data_dev,
3204                                  0, /* No offset on data devs */
3205                                  rs->md.dev_sectors,
3206                                  data);
3207
3208         return r;
3209 }
3210
3211 static void raid_io_hints(struct dm_target *ti, struct queue_limits *limits)
3212 {
3213         struct raid_set *rs = ti->private;
3214         unsigned chunk_size = rs->md.chunk_sectors << 9;
3215         struct r5conf *conf = rs->md.private;
3216
3217         blk_limits_io_min(limits, chunk_size);
3218         blk_limits_io_opt(limits, chunk_size * (conf->raid_disks - conf->max_degraded));
3219 }
3220
3221 static void raid_presuspend(struct dm_target *ti)
3222 {
3223         struct raid_set *rs = ti->private;
3224
3225         md_stop_writes(&rs->md);
3226 }
3227
3228 static void raid_postsuspend(struct dm_target *ti)
3229 {
3230         struct raid_set *rs = ti->private;
3231
3232         mddev_suspend(&rs->md);
3233         rs->md.ro = 1;
3234         clear_bit(RT_FLAG_RS_RESUMED, &rs->runtime_flags);
3235 }
3236
3237 static void attempt_restore_of_faulty_devices(struct raid_set *rs)
3238 {
3239         int i;
3240         uint64_t failed_devices, cleared_failed_devices = 0;
3241         unsigned long flags;
3242         struct dm_raid_superblock *sb;
3243         struct md_rdev *r;
3244
3245         for (i = 0; i < rs->md.raid_disks; i++) {
3246                 r = &rs->dev[i].rdev;
3247                 if (test_bit(Faulty, &r->flags) && r->sb_page &&
3248                     sync_page_io(r, 0, r->sb_size, r->sb_page, REQ_OP_READ, 0,
3249                                  1)) {
3250                         DMINFO("Faulty %s device #%d has readable super block."
3251                                "  Attempting to revive it.",
3252                                rs->raid_type->name, i);
3253
3254                         /*
3255                          * Faulty bit may be set, but sometimes the array can
3256                          * be suspended before the personalities can respond
3257                          * by removing the device from the array (i.e. calling
3258                          * 'hot_remove_disk').  If they haven't yet removed
3259                          * the failed device, its 'raid_disk' number will be
3260                          * '>= 0' - meaning we must call this function
3261                          * ourselves.
3262                          */
3263                         if ((r->raid_disk >= 0) &&
3264                             (r->mddev->pers->hot_remove_disk(r->mddev, r) != 0))
3265                                 /* Failed to revive this device, try next */
3266                                 continue;
3267
3268                         r->raid_disk = i;
3269                         r->saved_raid_disk = i;
3270                         flags = r->flags;
3271                         clear_bit(Faulty, &r->flags);
3272                         clear_bit(WriteErrorSeen, &r->flags);
3273                         clear_bit(In_sync, &r->flags);
3274                         if (r->mddev->pers->hot_add_disk(r->mddev, r)) {
3275                                 r->raid_disk = -1;
3276                                 r->saved_raid_disk = -1;
3277                                 r->flags = flags;
3278                         } else {
3279                                 r->recovery_offset = 0;
3280                                 cleared_failed_devices |= 1 << i;
3281                         }
3282                 }
3283         }
3284         if (cleared_failed_devices) {
3285                 rdev_for_each(r, &rs->md) {
3286                         sb = page_address(r->sb_page);
3287                         failed_devices = le64_to_cpu(sb->failed_devices);
3288                         failed_devices &= ~cleared_failed_devices;
3289                         sb->failed_devices = cpu_to_le64(failed_devices);
3290                 }
3291         }
3292 }
3293
3294 static int __load_dirty_region_bitmap(struct raid_set *rs)
3295 {
3296         int r = 0;
3297
3298         /* Try loading the bitmap unless "raid0", which does not have one */
3299         if (!rs_is_raid0(rs) &&
3300             !test_and_set_bit(RT_FLAG_RS_BITMAP_LOADED, &rs->runtime_flags)) {
3301                 r = bitmap_load(&rs->md);
3302                 if (r)
3303                         DMERR("Failed to load bitmap");
3304         }
3305
3306         return r;
3307 }
3308
3309 /*
3310  * Reshape changes raid algorithm of @rs to new one within personality
3311  * (e.g. raid6_zr -> raid6_nc), changes stripe size, adds/removes
3312  * disks from a raid set thus growing/shrinking it or resizes the set
3313  *
3314  * Call mddev_lock_nointr() before!
3315  */
3316 static int rs_start_reshape(struct raid_set *rs)
3317 {
3318         int r;
3319         struct mddev *mddev = &rs->md;
3320         struct md_personality *pers = mddev->pers;
3321
3322         r = rs_setup_reshape(rs);
3323         if (r)
3324                 return r;
3325
3326         /* Need to be resumed to be able to start reshape, recovery is frozen until raid_resume() though */
3327         if (mddev->suspended)
3328                 mddev_resume(mddev);
3329
3330         /*
3331          * Check any reshape constraints enforced by the personalility
3332          *
3333          * May as well already kick the reshape off so that * pers->start_reshape() becomes optional.
3334          */
3335         r = pers->check_reshape(mddev);
3336         if (r) {
3337                 rs->ti->error = "pers->check_reshape() failed";
3338                 return r;
3339         }
3340
3341         /*
3342          * Personality may not provide start reshape method in which
3343          * case check_reshape above has already covered everything
3344          */
3345         if (pers->start_reshape) {
3346                 r = pers->start_reshape(mddev);
3347                 if (r) {
3348                         rs->ti->error = "pers->start_reshape() failed";
3349                         return r;
3350                 }
3351         }
3352
3353         /* Suspend because a resume will happen in raid_resume() */
3354         if (!mddev->suspended)
3355                 mddev_suspend(mddev);
3356
3357         mddev->ro = 0;
3358         md_update_sb(mddev, 1);
3359         mddev->ro = 1;
3360
3361         return 0;
3362 }
3363
3364 static int raid_preresume(struct dm_target *ti)
3365 {
3366         int r;
3367         struct raid_set *rs = ti->private;
3368         struct mddev *mddev = &rs->md;
3369
3370         /* This is a resume after a suspend of the set -> it's already started */
3371         if (test_and_set_bit(RT_FLAG_RS_PRERESUMED, &rs->runtime_flags))
3372                 return 0;
3373
3374         /*
3375          * The superblocks need to be updated on disk if the
3376          * array is new or __load_dirty_region_bitmap will overwrite them
3377          * in core with old data.
3378          *
3379          * In case the array got modified (takeover/reshape/resize)
3380          * or the data offsets on the component devices changed, they
3381          * have to be updated as well.
3382          *
3383          * Have to switch to readwrite and back in order to
3384          * allow for the superblock updates.
3385          */
3386         if (test_and_clear_bit(RT_FLAG_UPDATE_SBS, &rs->runtime_flags)) {
3387                 set_bit(MD_CHANGE_DEVS, &mddev->flags);
3388                 mddev->ro = 0;
3389                 md_update_sb(mddev, 1);
3390                 mddev->ro = 1;
3391         }
3392
3393         /*
3394          * Disable/enable discard support on raid set after any
3395          * conversion, because devices can have been added
3396          */
3397         configure_discard_support(rs);
3398
3399         /* Load the bitmap from disk unless raid0 */
3400         r = __load_dirty_region_bitmap(rs);
3401         if (r)
3402                 return r;
3403
3404         /* Check for any resize/reshape on @rs and adjust/initiate */
3405         /* Be prepared for mddev_resume() in raid_resume() */
3406         set_bit(MD_RECOVERY_FROZEN, &mddev->recovery);
3407         if (mddev->recovery_cp && mddev->recovery_cp < MaxSector) {
3408                 set_bit(MD_RECOVERY_REQUESTED, &mddev->recovery);
3409                 set_bit(MD_RECOVERY_SYNC, &mddev->recovery);
3410                 mddev->resync_min = mddev->recovery_cp;
3411         }
3412
3413         rs_set_capacity(rs);
3414
3415         /* Check for any reshape request and region size change unless new raid set */
3416         if (test_and_clear_bit(RT_FLAG_RESHAPE_RS, &rs->runtime_flags)) {
3417                 /* Initiate a reshape. */
3418                 mddev_lock_nointr(mddev);
3419                 r = rs_start_reshape(rs);
3420                 mddev_unlock(mddev);
3421                 if (r)
3422                         DMWARN("Failed to check/start reshape, continuing without change");
3423                 r = 0;
3424         }
3425
3426         return r;
3427 }
3428
3429 static void raid_resume(struct dm_target *ti)
3430 {
3431         struct raid_set *rs = ti->private;
3432         struct mddev *mddev = &rs->md;
3433
3434         if (test_and_set_bit(RT_FLAG_RS_RESUMED, &rs->runtime_flags)) {
3435                 /*
3436                  * A secondary resume while the device is active.
3437                  * Take this opportunity to check whether any failed
3438                  * devices are reachable again.
3439                  */
3440                 attempt_restore_of_faulty_devices(rs);
3441         }
3442
3443         mddev->ro = 0;
3444         mddev->in_sync = 0;
3445         clear_bit(MD_RECOVERY_FROZEN, &mddev->recovery);
3446
3447         if (mddev->suspended)
3448                 mddev_resume(mddev);
3449 }
3450
3451 static struct target_type raid_target = {
3452         .name = "raid",
3453         .version = {1, 9, 0},
3454         .module = THIS_MODULE,
3455         .ctr = raid_ctr,
3456         .dtr = raid_dtr,
3457         .map = raid_map,
3458         .status = raid_status,
3459         .message = raid_message,
3460         .iterate_devices = raid_iterate_devices,
3461         .io_hints = raid_io_hints,
3462         .presuspend = raid_presuspend,
3463         .postsuspend = raid_postsuspend,
3464         .preresume = raid_preresume,
3465         .resume = raid_resume,
3466 };
3467
3468 static int __init dm_raid_init(void)
3469 {
3470         DMINFO("Loading target version %u.%u.%u",
3471                raid_target.version[0],
3472                raid_target.version[1],
3473                raid_target.version[2]);
3474         return dm_register_target(&raid_target);
3475 }
3476
3477 static void __exit dm_raid_exit(void)
3478 {
3479         dm_unregister_target(&raid_target);
3480 }
3481
3482 module_init(dm_raid_init);
3483 module_exit(dm_raid_exit);
3484
3485 module_param(devices_handle_discard_safely, bool, 0644);
3486 MODULE_PARM_DESC(devices_handle_discard_safely,
3487                  "Set to Y if all devices in each array reliably return zeroes on reads from discarded regions");
3488
3489 MODULE_DESCRIPTION(DM_NAME " raid0/1/10/4/5/6 target");
3490 MODULE_ALIAS("dm-raid0");
3491 MODULE_ALIAS("dm-raid1");
3492 MODULE_ALIAS("dm-raid10");
3493 MODULE_ALIAS("dm-raid4");
3494 MODULE_ALIAS("dm-raid5");
3495 MODULE_ALIAS("dm-raid6");
3496 MODULE_AUTHOR("Neil Brown <dm-devel@redhat.com>");
3497 MODULE_AUTHOR("Heinz Mauelshagen <dm-devel@redhat.com>");
3498 MODULE_LICENSE("GPL");