md: use mddev->external to select holder in export_rdev()
[linux-block.git] / drivers / md / md.h
CommitLineData
af1a8899 1/* SPDX-License-Identifier: GPL-2.0-or-later */
1da177e4 2/*
7e841526 3 md.h : kernel internal structure of the Linux MD driver
1da177e4 4 Copyright (C) 1996-98 Ingo Molnar, Gadi Oxman
f72ffdd6 5
1da177e4
LT
6*/
7
63fe0817
CH
8#ifndef _MD_MD_H
9#define _MD_MD_H
10
11#include <linux/blkdev.h>
66114cad 12#include <linux/backing-dev.h>
fc974ee2 13#include <linux/badblocks.h>
63fe0817
CH
14#include <linux/kobject.h>
15#include <linux/list.h>
16#include <linux/mm.h>
17#include <linux/mutex.h>
18#include <linux/timer.h>
19#include <linux/wait.h>
20#include <linux/workqueue.h>
edb39c9d 21#include "md-cluster.h"
9361401e 22
1da177e4 23#define MaxSector (~(sector_t)0)
1da177e4 24
46533ff7
N
25/*
26 * These flags should really be called "NO_RETRY" rather than
27 * "FAILFAST" because they don't make any promise about time lapse,
28 * only about the number of retries, which will be zero.
29 * REQ_FAILFAST_DRIVER is not included because
30 * Commit: 4a27446f3e39 ("[SCSI] modify scsi to handle new fail fast flags.")
31 * seems to suggest that the errors it avoids retrying should usually
32 * be retried.
33 */
34#define MD_FAILFAST (REQ_FAILFAST_DEV | REQ_FAILFAST_TRANSPORT)
69b00b5b
GJ
35
36/*
37 * The struct embedded in rdev is used to serialize IO.
38 */
39struct serial_in_rdev {
40 struct rb_root_cached serial_rb;
41 spinlock_t serial_lock;
42 wait_queue_head_t serial_io_wait;
43};
44
1da177e4
LT
45/*
46 * MD's 'extended' device
47 */
3cb03002 48struct md_rdev {
1da177e4
LT
49 struct list_head same_set; /* RAID devices within the same set */
50
dd8ac336 51 sector_t sectors; /* Device size (in 512bytes sectors) */
fd01b88c 52 struct mddev *mddev; /* RAID array if running */
eea1bf38 53 int last_events; /* IO event timestamp */
1da177e4 54
a6ff7e08
JB
55 /*
56 * If meta_bdev is non-NULL, it means that a separate device is
57 * being used to store the metadata (superblock/bitmap) which
58 * would otherwise be contained on the same device as the data (bdev).
59 */
60 struct block_device *meta_bdev;
1da177e4
LT
61 struct block_device *bdev; /* block device handle */
62
2699b672 63 struct page *sb_page, *bb_page;
1da177e4 64 int sb_loaded;
42543769 65 __u64 sb_events;
1da177e4 66 sector_t data_offset; /* start of data in array */
c6563a8c 67 sector_t new_data_offset;/* only relevant while reshaping */
f72ffdd6 68 sector_t sb_start; /* offset of the super block (in 512byte sectors) */
0002b271 69 int sb_size; /* bytes in the superblock */
1da177e4
LT
70 int preferred_minor; /* autorun support */
71
86e6ffdd
N
72 struct kobject kobj;
73
1da177e4
LT
74 /* A device can be in one of three states based on two flags:
75 * Not working: faulty==1 in_sync==0
76 * Fully working: faulty==0 in_sync==1
77 * Working, but not
78 * in sync with array
79 * faulty==0 in_sync==0
80 *
81 * It can never have faulty==1, in_sync==1
82 * This reduces the burden of testing multiple flags in many cases
83 */
1da177e4 84
2d78f8c4 85 unsigned long flags; /* bit set of 'enum flag_bits' bits. */
6bfe0b49 86 wait_queue_head_t blocked_wait;
8ddf9efe 87
1da177e4
LT
88 int desc_nr; /* descriptor index in the superblock */
89 int raid_disk; /* role of device in array */
e93f68a1
N
90 int new_raid_disk; /* role that the device will have in
91 * the array after a level-change completes.
92 */
41158c7e
N
93 int saved_raid_disk; /* role that device used to have in the
94 * array and could again if we did a partial
95 * resync from the bitmap
96 */
3069aa8d
SL
97 union {
98 sector_t recovery_offset;/* If this device has been partially
5fd6c1dc
N
99 * recovered, this is where we were
100 * up to.
101 */
3069aa8d
SL
102 sector_t journal_tail; /* If this device is a journal device,
103 * this is the journal tail (journal
104 * recovery start point)
105 */
106 };
1da177e4
LT
107
108 atomic_t nr_pending; /* number of pending requests.
109 * only maintained for arrays that
110 * support hot removal
111 */
ba22dcbf
N
112 atomic_t read_errors; /* number of consecutive read errors that
113 * we have tried to ignore.
114 */
0e3ef49e 115 time64_t last_read_error; /* monotonic time since our
1e50915f
RB
116 * last read error
117 */
4dbcdc75
N
118 atomic_t corrected_errors; /* number of corrected read errors,
119 * for reporting to userspace and storing
120 * in superblock.
121 */
3e148a32 122
69b00b5b 123 struct serial_in_rdev *serial; /* used for raid1 io serialization */
3e148a32 124
324a56e1 125 struct kernfs_node *sysfs_state; /* handle for 'state'
3c0ee63a 126 * sysfs entry */
e1a86dbb
JB
127 /* handle for 'unacknowledged_bad_blocks' sysfs dentry */
128 struct kernfs_node *sysfs_unack_badblocks;
129 /* handle for 'bad_blocks' sysfs dentry */
130 struct kernfs_node *sysfs_badblocks;
fc974ee2 131 struct badblocks badblocks;
ea0213e0
AP
132
133 struct {
134 short offset; /* Offset from superblock to start of PPL.
135 * Not used by external metadata. */
136 unsigned int size; /* Size in sectors of the PPL space */
137 sector_t sector; /* First sector of the PPL space */
138 } ppl;
1da177e4 139};
2d78f8c4
N
140enum flag_bits {
141 Faulty, /* device is known to have a fault */
142 In_sync, /* device is in_sync with rest of array */
8313b8e5 143 Bitmap_sync, /* ..actually, not quite In_sync. Need a
4aaf7694
GJ
144 * bitmap-based recovery to get fully in sync.
145 * The bit is only meaningful before device
146 * has been passed to pers->hot_add_disk.
8313b8e5 147 */
2d78f8c4
N
148 WriteMostly, /* Avoid reading if at all possible */
149 AutoDetected, /* added by auto-detect */
150 Blocked, /* An error occurred but has not yet
151 * been acknowledged by the metadata
152 * handler, so don't allow writes
153 * until it is cleared */
154 WriteErrorSeen, /* A write error has been seen on this
155 * device
156 */
157 FaultRecorded, /* Intermediate state for clearing
158 * Blocked. The Fault is/will-be
159 * recorded in the metadata, but that
160 * metadata hasn't been stored safely
161 * on disk yet.
162 */
163 BlockedBadBlocks, /* A writer is blocked because they
164 * found an unacknowledged bad-block.
165 * This can safely be cleared at any
166 * time, and the writer will re-check.
167 * It may be set at any time, and at
168 * worst the writer will timeout and
169 * re-check. So setting it as
170 * accurately as possible is good, but
171 * not absolutely critical.
172 */
173 WantReplacement, /* This device is a candidate to be
174 * hot-replaced, either because it has
175 * reported some faults, or because
176 * of explicit request.
177 */
178 Replacement, /* This device is a replacement for
179 * a want_replacement device with same
180 * raid_disk number.
181 */
1aee41f6
GR
182 Candidate, /* For clustered environments only:
183 * This device is seen locally but not
184 * by the whole cluster
185 */
bac624f3
SL
186 Journal, /* This device is used as journal for
187 * raid-5/6.
188 * Usually, this device should be faster
189 * than other devices in the array
190 */
659b254f 191 ClusterRemove,
d787be40
N
192 RemoveSynchronized, /* synchronize_rcu() was called after
193 * this device was known to be faulty,
194 * so it is safe to remove without
195 * another synchronize_rcu() call.
196 */
35b785f7
TM
197 ExternalBbl, /* External metadata provides bad
198 * block management for a disk
199 */
688834e6
N
200 FailFast, /* Minimal retries should be attempted on
201 * this device, so use REQ_FAILFAST_DEV.
202 * Also don't try to repair failed reads.
203 * It is expects that no bad block log
204 * is present.
205 */
46533ff7
N
206 LastDev, /* Seems to be the last working dev as
207 * it didn't fail, so don't use FailFast
208 * any more for metadata
209 */
404659cf
GJ
210 CollisionCheck, /*
211 * check if there is collision between raid1
212 * serial bios.
3e148a32 213 */
2d78f8c4 214};
1da177e4 215
3cb03002 216static inline int is_badblock(struct md_rdev *rdev, sector_t s, int sectors,
2230dfe4
N
217 sector_t *first_bad, int *bad_sectors)
218{
219 if (unlikely(rdev->badblocks.count)) {
fc974ee2 220 int rv = badblocks_check(&rdev->badblocks, rdev->data_offset + s,
2230dfe4
N
221 sectors,
222 first_bad, bad_sectors);
223 if (rv)
224 *first_bad -= rdev->data_offset;
225 return rv;
226 }
227 return 0;
228}
3cb03002 229extern int rdev_set_badblocks(struct md_rdev *rdev, sector_t s, int sectors,
c6563a8c
N
230 int is_new);
231extern int rdev_clear_badblocks(struct md_rdev *rdev, sector_t s, int sectors,
232 int is_new);
c4ce867f
GR
233struct md_cluster_info;
234
9631abdb
MT
235/**
236 * enum mddev_flags - md device flags.
237 * @MD_ARRAY_FIRST_USE: First use of array, needs initialization.
238 * @MD_CLOSING: If set, we are closing the array, do not open it then.
239 * @MD_JOURNAL_CLEAN: A raid with journal is already clean.
240 * @MD_HAS_JOURNAL: The raid array has journal feature set.
241 * @MD_CLUSTER_RESYNC_LOCKED: cluster raid only, which means node, already took
242 * resync lock, need to release the lock.
243 * @MD_FAILFAST_SUPPORTED: Using MD_FAILFAST on metadata writes is supported as
244 * calls to md_error() will never cause the array to
245 * become failed.
246 * @MD_HAS_PPL: The raid array has PPL feature set.
247 * @MD_HAS_MULTIPLE_PPLS: The raid array has multiple PPLs feature set.
248 * @MD_ALLOW_SB_UPDATE: md_check_recovery is allowed to update the metadata
249 * without taking reconfig_mutex.
250 * @MD_UPDATING_SB: md_check_recovery is updating the metadata without
251 * explicitly holding reconfig_mutex.
252 * @MD_NOT_READY: do_md_run() is active, so 'array_state', ust not report that
253 * array is ready yet.
254 * @MD_BROKEN: This is used to stop writes and mark array as failed.
12a6caf2 255 * @MD_DELETED: This device is being deleted
9631abdb
MT
256 *
257 * change UNSUPPORTED_MDDEV_FLAGS for each array type if new flag is added
258 */
be306c29 259enum mddev_flags {
9631abdb
MT
260 MD_ARRAY_FIRST_USE,
261 MD_CLOSING,
262 MD_JOURNAL_CLEAN,
263 MD_HAS_JOURNAL,
264 MD_CLUSTER_RESYNC_LOCKED,
265 MD_FAILFAST_SUPPORTED,
266 MD_HAS_PPL,
267 MD_HAS_MULTIPLE_PPLS,
268 MD_ALLOW_SB_UPDATE,
269 MD_UPDATING_SB,
270 MD_NOT_READY,
271 MD_BROKEN,
12a6caf2 272 MD_DELETED,
be306c29 273};
2953079c
SL
274
275enum mddev_sb_flags {
276 MD_SB_CHANGE_DEVS, /* Some device status has changed */
277 MD_SB_CHANGE_CLEAN, /* transition to or from 'clean' */
278 MD_SB_CHANGE_PENDING, /* switch from 'clean' to 'active' in progress */
279 MD_SB_NEED_REWRITE, /* metadata write needs to be repeated */
280};
281
404659cf
GJ
282#define NR_SERIAL_INFOS 8
283/* record current range of serialize IOs */
284struct serial_info {
69b00b5b
GJ
285 struct rb_node node;
286 sector_t start; /* start sector of rb node */
287 sector_t last; /* end sector of rb node */
288 sector_t _subtree_last; /* highest sector in subtree of rb node */
3e148a32
GJ
289};
290
eac58d08
LG
291/*
292 * mddev->curr_resync stores the current sector of the resync but
293 * also has some overloaded values.
294 */
295enum {
296 /* No resync in progress */
297 MD_RESYNC_NONE = 0,
298 /* Yielded to allow another conflicting resync to commence */
299 MD_RESYNC_YIELDED = 1,
300 /* Delayed to check that there is no conflict with another sync */
301 MD_RESYNC_DELAYED = 2,
302 /* Any value greater than or equal to this is in an active resync */
303 MD_RESYNC_ACTIVE = 3,
304};
305
fd01b88c 306struct mddev {
1da177e4 307 void *private;
84fc4b56 308 struct md_personality *pers;
1da177e4
LT
309 dev_t unit;
310 int md_minor;
7a0a5355 311 struct list_head disks;
850b2b42 312 unsigned long flags;
2953079c 313 unsigned long sb_flags;
850b2b42 314
409c57f3 315 int suspended;
72adae23 316 struct percpu_ref active_io;
1da177e4 317 int ro;
bb4f1e9d
N
318 int sysfs_active; /* set when sysfs deletes
319 * are happening, so run/
320 * takeover/stop are not safe
321 */
1da177e4
LT
322 struct gendisk *gendisk;
323
eae1701f 324 struct kobject kobj;
d3374825
N
325 int hold_active;
326#define UNTIL_IOCTL 1
efeb53c0 327#define UNTIL_STOP 2
eae1701f 328
1da177e4
LT
329 /* Superblock information */
330 int major_version,
331 minor_version,
332 patch_version;
333 int persistent;
f72ffdd6 334 int external; /* metadata is
e691063a
N
335 * managed externally */
336 char metadata_type[17]; /* externally set*/
77a68698 337 int chunk_sectors;
9ebc6ef1 338 time64_t ctime, utime;
1da177e4 339 int level, layout;
d9d166c2 340 char clevel[16];
1da177e4
LT
341 int raid_disks;
342 int max_disks;
f72ffdd6 343 sector_t dev_sectors; /* used size of
58c0fed4 344 * component devices */
f233ea5c 345 sector_t array_sectors; /* exported array size */
b522adcd
DW
346 int external_size; /* size managed
347 * externally */
1da177e4 348 __u64 events;
a8707c08
N
349 /* If the last 'event' was simply a clean->dirty transition, and
350 * we didn't write it to the spares, then it is safe and simple
351 * to just decrement the event count on a dirty->clean transition.
352 * So we record that possibility here.
353 */
354 int can_decrease_events;
1da177e4
LT
355
356 char uuid[16];
357
f6705578
N
358 /* If the array is being reshaped, we need to record the
359 * new shape and an indication of where we are up to.
360 * This is written to the superblock.
361 * If reshape_position is MaxSector, then no reshape is happening (yet).
362 */
363 sector_t reshape_position;
664e7c41 364 int delta_disks, new_level, new_layout;
77a68698 365 int new_chunk_sectors;
2c810cdd 366 int reshape_backwards;
f6705578 367
44693154
YK
368 struct md_thread __rcu *thread; /* management thread */
369 struct md_thread __rcu *sync_thread; /* doing resync or reconstruct */
c4a39551
JB
370
371 /* 'last_sync_action' is initialized to "none". It is set when a
372 * sync operation (i.e "data-check", "requested-resync", "resync",
373 * "recovery", or "reshape") is started. It holds this value even
374 * when the sync thread is "frozen" (interrupted) or "idle" (stopped
375 * or finished). It is overwritten when a new sync operation is begun.
376 */
377 char *last_sync_action;
ff4e8d9a 378 sector_t curr_resync; /* last block scheduled */
97e4f42d
N
379 /* As resync requests can complete out of order, we cannot easily track
380 * how much resync has been completed. So we occasionally pause until
381 * everything completes, then set curr_resync_completed to curr_resync.
382 * As such it may be well behind the real resync mark, but it is a value
383 * we are certain of.
384 */
385 sector_t curr_resync_completed;
1da177e4
LT
386 unsigned long resync_mark; /* a recent timestamp */
387 sector_t resync_mark_cnt;/* blocks written at resync_mark */
ff4e8d9a 388 sector_t curr_mark_cnt; /* blocks scheduled now */
1da177e4
LT
389
390 sector_t resync_max_sectors; /* may be set by personality */
9d88883e 391
7f7583d4 392 atomic64_t resync_mismatches; /* count of sectors where
9d88883e
N
393 * parity/replica mismatch found
394 */
e464eafd
N
395
396 /* allow user-space to request suspension of IO to regions of the array */
397 sector_t suspend_lo;
398 sector_t suspend_hi;
88202a0c
N
399 /* if zero, use the system-wide default */
400 int sync_speed_min;
401 int sync_speed_max;
402
90b08710
BS
403 /* resync even though the same disks are shared among md-devices */
404 int parallel_resync;
405
6ff8d8ec 406 int ok_start_degraded;
5fd6c1dc 407
1da177e4 408 unsigned long recovery;
5389042f
N
409 /* If a RAID personality determines that recovery (of a particular
410 * device) will fail due to a read error on the source device, it
411 * takes a copy of this number and does not attempt recovery again
412 * until this number changes.
413 */
414 int recovery_disabled;
1da177e4
LT
415
416 int in_sync; /* know to not need resync */
c8c00a69
N
417 /* 'open_mutex' avoids races between 'md_open' and 'do_md_stop', so
418 * that we are never stopping an array while it is open.
419 * 'reconfig_mutex' protects all other reconfiguration.
420 * These locks are separate due to conflicting interactions
a8698707 421 * with disk->open_mutex.
c8c00a69 422 * Lock ordering is:
a8698707
CH
423 * reconfig_mutex -> disk->open_mutex
424 * disk->open_mutex -> open_mutex: e.g. __blkdev_get -> md_open
c8c00a69
N
425 */
426 struct mutex open_mutex;
df5b89b3 427 struct mutex reconfig_mutex;
f2ea68cf
N
428 atomic_t active; /* general refcount */
429 atomic_t openers; /* number of active opens */
1da177e4 430
f0b4f7e2
N
431 int changed; /* True if we might need to
432 * reread partition info */
1da177e4
LT
433 int degraded; /* whether md should consider
434 * adding a spare
435 */
436
437 atomic_t recovery_active; /* blocks scheduled, but not written */
438 wait_queue_head_t recovery_wait;
439 sector_t recovery_cp;
5e96ee65
NB
440 sector_t resync_min; /* user requested sync
441 * starts here */
c6207277
N
442 sector_t resync_max; /* resync should pause
443 * when it gets here */
06d91a5f 444
324a56e1 445 struct kernfs_node *sysfs_state; /* handle for 'array_state'
b62b7590
N
446 * file in sysfs.
447 */
324a56e1 448 struct kernfs_node *sysfs_action; /* handle for 'sync_action' */
e1a86dbb
JB
449 struct kernfs_node *sysfs_completed; /*handle for 'sync_completed' */
450 struct kernfs_node *sysfs_degraded; /*handle for 'degraded' */
451 struct kernfs_node *sysfs_level; /*handle for 'level' */
b62b7590 452
d3374825
N
453 struct work_struct del_work; /* used for delayed sysfs removal */
454
85572d7c
N
455 /* "lock" protects:
456 * flush_bio transition from NULL to !NULL
457 * rdev superblocks, events
458 * clearing MD_CHANGE_*
459 * in_sync - and related safemode and MD_CHANGE changes
36d091f4 460 * pers (also protected by reconfig_mutex and pending IO).
978a7a47 461 * clearing ->bitmap
4af1a041 462 * clearing ->bitmap_info.file
23da422b
N
463 * changing ->resync_{min,max}
464 * setting MD_RECOVERY_RUNNING (which interacts with resync_{min,max})
85572d7c
N
465 */
466 spinlock_t lock;
3d310eb7 467 wait_queue_head_t sb_wait; /* for waiting on superblock updates */
7bfa19f2 468 atomic_t pending_writes; /* number of active superblock writes */
06d91a5f 469
1da177e4
LT
470 unsigned int safemode; /* if set, update "clean" superblock
471 * when no writes pending.
f72ffdd6 472 */
1da177e4
LT
473 unsigned int safemode_delay;
474 struct timer_list safemode_timer;
4ad23a97
N
475 struct percpu_ref writes_pending;
476 int sync_checkers; /* # of threads checking writes_pending */
165125e1 477 struct request_queue *queue; /* for plugging ... */
1da177e4 478
f72ffdd6 479 struct bitmap *bitmap; /* the bitmap for the device */
c3d9714e
N
480 struct {
481 struct file *file; /* the bitmap file */
f6af949c 482 loff_t offset; /* offset from superblock of
c3d9714e
N
483 * start of bitmap. May be
484 * negative, but not '0'
f6af949c 485 * For external metadata, offset
f72ffdd6 486 * from start of device.
c3d9714e 487 */
6409bb05 488 unsigned long space; /* space available at this offset */
f6af949c 489 loff_t default_offset; /* this is the offset to use when
c3d9714e
N
490 * hot-adding a bitmap. It should
491 * eventually be settable by sysfs.
492 */
6409bb05
N
493 unsigned long default_space; /* space available at
494 * default offset */
c3d9714e 495 struct mutex mutex;
42a04b50 496 unsigned long chunksize;
ac2f40be 497 unsigned long daemon_sleep; /* how many jiffies between updates? */
42a04b50 498 unsigned long max_write_behind; /* write-behind mode */
ece5cff0 499 int external;
c4ce867f 500 int nodes; /* Maximum number of nodes in the cluster */
cf921cc1 501 char cluster_name[64]; /* Name of the cluster */
c3d9714e 502 } bitmap_info;
32a7627c 503
f72ffdd6 504 atomic_t max_corr_read_errors; /* max read retries */
1da177e4 505 struct list_head all_mddevs;
a2826aa9 506
c32dc040 507 const struct attribute_group *to_remove;
252ac522 508
afeee514
KO
509 struct bio_set bio_set;
510 struct bio_set sync_set; /* for sync operations like
5a85071c
N
511 * metadata and bitmap writes
512 */
10764815 513 struct bio_set io_acct_set; /* for raid0 and raid5 io accounting */
a167f663 514
4bc034d3
N
515 /* Generic flush handling.
516 * The last to finish preflush schedules a worker to submit
517 * the rest of the request (without the REQ_PREFLUSH flag).
518 */
519 struct bio *flush_bio;
520 atomic_t flush_pending;
81ba3c24
PG
521 ktime_t start_flush, prev_flush_start; /* prev_flush_start is when the previous completed
522 * flush was started.
523 */
4bc034d3 524 struct work_struct flush_work;
768a418d 525 struct work_struct event_work; /* used by dm to report failure event */
404659cf 526 mempool_t *serial_info_pool;
fd01b88c 527 void (*sync_super)(struct mddev *mddev, struct md_rdev *rdev);
c4ce867f 528 struct md_cluster_info *cluster_info;
15858fa5 529 unsigned int good_device_nr; /* good device num within cluster raid */
78f57ef9 530 unsigned int noio_flag; /* for memalloc scope API */
4b6c1060 531
3ce94ce5
YK
532 /*
533 * Temporarily store rdev that will be finally removed when
534 * reconfig_mutex is unlocked.
535 */
536 struct list_head deleting;
537 /* Protect the deleting list */
538 struct mutex delete_mutex;
539
4b6c1060 540 bool has_superblocks:1;
9a567843 541 bool fail_last_dev:1;
3938f5fb 542 bool serialize_policy:1;
be306c29
N
543};
544
545enum recovery_flags {
546 /*
547 * If neither SYNC or RESHAPE are set, then it is a recovery.
548 */
549 MD_RECOVERY_RUNNING, /* a thread is running, or about to be started */
550 MD_RECOVERY_SYNC, /* actually doing a resync, not a recovery */
551 MD_RECOVERY_RECOVER, /* doing recovery, or need to try it. */
552 MD_RECOVERY_INTR, /* resync needs to be aborted for some reason */
553 MD_RECOVERY_DONE, /* thread is done and is waiting to be reaped */
554 MD_RECOVERY_NEEDED, /* we might need to start a resync/recover */
555 MD_RECOVERY_REQUESTED, /* user-space has requested a sync (used with SYNC) */
556 MD_RECOVERY_CHECK, /* user-space request for check-only, no repair */
557 MD_RECOVERY_RESHAPE, /* A reshape is happening */
558 MD_RECOVERY_FROZEN, /* User request to abort, and not restart, any action */
559 MD_RECOVERY_ERROR, /* sync-action interrupted because io-error */
d5d885fd 560 MD_RECOVERY_WAIT, /* waiting for pers->start() to finish */
0357ba27 561 MD_RESYNCING_REMOTE, /* remote node is running resync thread */
1da177e4
LT
562};
563
431e6125
YK
564enum md_ro_state {
565 MD_RDWR,
566 MD_RDONLY,
567 MD_AUTO_READ,
568 MD_MAX_STATE
569};
570
571static inline bool md_is_rdwr(struct mddev *mddev)
572{
573 return (mddev->ro == MD_RDWR);
574}
575
576static inline bool is_md_suspended(struct mddev *mddev)
577{
578 return percpu_ref_is_dying(&mddev->active_io);
579}
580
5c47daf6
N
581static inline int __must_check mddev_lock(struct mddev *mddev)
582{
583 return mutex_lock_interruptible(&mddev->reconfig_mutex);
584}
585
586/* Sometimes we need to take the lock in a situation where
587 * failure due to interrupts is not acceptable.
588 */
589static inline void mddev_lock_nointr(struct mddev *mddev)
590{
591 mutex_lock(&mddev->reconfig_mutex);
592}
593
5c47daf6
N
594static inline int mddev_trylock(struct mddev *mddev)
595{
596 return mutex_trylock(&mddev->reconfig_mutex);
597}
598extern void mddev_unlock(struct mddev *mddev);
599
1da177e4
LT
600static inline void md_sync_acct(struct block_device *bdev, unsigned long nr_sectors)
601{
4245e52d 602 atomic_add(nr_sectors, &bdev->bd_disk->sync_io);
1da177e4
LT
603}
604
74d46992
CH
605static inline void md_sync_acct_bio(struct bio *bio, unsigned long nr_sectors)
606{
309dca30 607 md_sync_acct(bio->bi_bdev, nr_sectors);
74d46992
CH
608}
609
84fc4b56 610struct md_personality
1da177e4
LT
611{
612 char *name;
2604b703
N
613 int level;
614 struct list_head list;
1da177e4 615 struct module *owner;
775d7831 616 bool __must_check (*make_request)(struct mddev *mddev, struct bio *bio);
d5d885fd
SL
617 /*
618 * start up works that do NOT require md_thread. tasks that
619 * requires md_thread should go into start()
620 */
fd01b88c 621 int (*run)(struct mddev *mddev);
d5d885fd
SL
622 /* start up works that require md threads */
623 int (*start)(struct mddev *mddev);
afa0f557 624 void (*free)(struct mddev *mddev, void *priv);
fd01b88c 625 void (*status)(struct seq_file *seq, struct mddev *mddev);
1da177e4 626 /* error_handler must set ->faulty and clear ->in_sync
f72ffdd6 627 * if appropriate, and should abort recovery if needed
1da177e4 628 */
fd01b88c
N
629 void (*error_handler)(struct mddev *mddev, struct md_rdev *rdev);
630 int (*hot_add_disk) (struct mddev *mddev, struct md_rdev *rdev);
b8321b68 631 int (*hot_remove_disk) (struct mddev *mddev, struct md_rdev *rdev);
fd01b88c 632 int (*spare_active) (struct mddev *mddev);
09314799 633 sector_t (*sync_request)(struct mddev *mddev, sector_t sector_nr, int *skipped);
fd01b88c
N
634 int (*resize) (struct mddev *mddev, sector_t sectors);
635 sector_t (*size) (struct mddev *mddev, sector_t sectors, int raid_disks);
636 int (*check_reshape) (struct mddev *mddev);
637 int (*start_reshape) (struct mddev *mddev);
638 void (*finish_reshape) (struct mddev *mddev);
7564beda 639 void (*update_reshape_pos) (struct mddev *mddev);
3e00777d 640 void (*prepare_suspend) (struct mddev *mddev);
b03e0ccb
N
641 /* quiesce suspends or resumes internal processing.
642 * 1 - stop new actions and wait for action io to complete
643 * 0 - return to normal behaviour
36fa3063 644 */
b03e0ccb 645 void (*quiesce) (struct mddev *mddev, int quiesce);
245f46c2
N
646 /* takeover is used to transition an array from one
647 * personality to another. The new personality must be able
648 * to handle the data in the current layout.
649 * e.g. 2drive raid1 -> 2drive raid5
650 * ndrive raid5 -> degraded n+1drive raid6 with special layout
651 * If the takeover succeeds, a new 'private' structure is returned.
652 * This needs to be installed and then ->run used to activate the
653 * array.
654 */
fd01b88c 655 void *(*takeover) (struct mddev *mddev);
ba903a3e
AP
656 /* Changes the consistency policy of an active array. */
657 int (*change_consistency_policy)(struct mddev *mddev, const char *buf);
1da177e4
LT
658};
659
007583c9
N
660struct md_sysfs_entry {
661 struct attribute attr;
fd01b88c
N
662 ssize_t (*show)(struct mddev *, char *);
663 ssize_t (*store)(struct mddev *, const char *, size_t);
007583c9 664};
c32dc040 665extern const struct attribute_group md_bitmap_group;
007583c9 666
324a56e1 667static inline struct kernfs_node *sysfs_get_dirent_safe(struct kernfs_node *sd, char *name)
00bcb4ac
N
668{
669 if (sd)
388975cc 670 return sysfs_get_dirent(sd, name);
00bcb4ac
N
671 return sd;
672}
324a56e1 673static inline void sysfs_notify_dirent_safe(struct kernfs_node *sd)
00bcb4ac
N
674{
675 if (sd)
676 sysfs_notify_dirent(sd);
677}
678
fd01b88c 679static inline char * mdname (struct mddev * mddev)
1da177e4
LT
680{
681 return mddev->gendisk ? mddev->gendisk->disk_name : "mdX";
682}
683
fd01b88c 684static inline int sysfs_link_rdev(struct mddev *mddev, struct md_rdev *rdev)
36fad858
NK
685{
686 char nm[20];
9b15603d
SL
687 if (!test_bit(Replacement, &rdev->flags) &&
688 !test_bit(Journal, &rdev->flags) &&
689 mddev->kobj.sd) {
2d78f8c4
N
690 sprintf(nm, "rd%d", rdev->raid_disk);
691 return sysfs_create_link(&mddev->kobj, &rdev->kobj, nm);
692 } else
693 return 0;
36fad858
NK
694}
695
fd01b88c 696static inline void sysfs_unlink_rdev(struct mddev *mddev, struct md_rdev *rdev)
36fad858
NK
697{
698 char nm[20];
9b15603d
SL
699 if (!test_bit(Replacement, &rdev->flags) &&
700 !test_bit(Journal, &rdev->flags) &&
701 mddev->kobj.sd) {
2d78f8c4
N
702 sprintf(nm, "rd%d", rdev->raid_disk);
703 sysfs_remove_link(&mddev->kobj, nm);
704 }
36fad858
NK
705}
706
1da177e4
LT
707/*
708 * iterates through some rdev ringlist. It's safe to remove the
709 * current 'rdev'. Dont touch 'tmp' though.
710 */
159ec1fc
CR
711#define rdev_for_each_list(rdev, tmp, head) \
712 list_for_each_entry_safe(rdev, tmp, head, same_set)
713
1da177e4
LT
714/*
715 * iterates through the 'same array disks' ringlist
716 */
dafb20fa
N
717#define rdev_for_each(rdev, mddev) \
718 list_for_each_entry(rdev, &((mddev)->disks), same_set)
719
720#define rdev_for_each_safe(rdev, tmp, mddev) \
159ec1fc 721 list_for_each_entry_safe(rdev, tmp, &((mddev)->disks), same_set)
1da177e4 722
4b80991c
N
723#define rdev_for_each_rcu(rdev, mddev) \
724 list_for_each_entry_rcu(rdev, &((mddev)->disks), same_set)
725
2b8bf345 726struct md_thread {
4ed8731d 727 void (*run) (struct md_thread *thread);
fd01b88c 728 struct mddev *mddev;
1da177e4 729 wait_queue_head_t wqueue;
f72ffdd6 730 unsigned long flags;
1da177e4 731 struct task_struct *tsk;
32a7627c 732 unsigned long timeout;
4ed8731d 733 void *private;
2b8bf345 734};
1da177e4 735
10764815 736struct md_io_acct {
76fed014
XN
737 struct mddev *mddev;
738 struct bio *orig_bio;
739 unsigned long start_time;
740 struct bio bio_clone;
10764815
GJ
741};
742
1da177e4
LT
743#define THREAD_WAKEUP 0
744
1345b1d8
N
745static inline void safe_put_page(struct page *p)
746{
747 if (p) put_page(p);
748}
749
84fc4b56
N
750extern int register_md_personality(struct md_personality *p);
751extern int unregister_md_personality(struct md_personality *p);
edb39c9d
GR
752extern int register_md_cluster_operations(struct md_cluster_operations *ops,
753 struct module *module);
754extern int unregister_md_cluster_operations(void);
755extern int md_setup_cluster(struct mddev *mddev, int nodes);
756extern void md_cluster_stop(struct mddev *mddev);
2b8bf345 757extern struct md_thread *md_register_thread(
4ed8731d 758 void (*run)(struct md_thread *thread),
2b8bf345
N
759 struct mddev *mddev,
760 const char *name);
44693154
YK
761extern void md_unregister_thread(struct md_thread __rcu **threadp);
762extern void md_wakeup_thread(struct md_thread __rcu *thread);
fd01b88c 763extern void md_check_recovery(struct mddev *mddev);
d0a18034 764extern void md_reap_sync_thread(struct mddev *mddev);
a415c0f1 765extern int mddev_init_writes_pending(struct mddev *mddev);
cc27b0c7 766extern bool md_write_start(struct mddev *mddev, struct bio *bi);
49728050 767extern void md_write_inc(struct mddev *mddev, struct bio *bi);
fd01b88c
N
768extern void md_write_end(struct mddev *mddev);
769extern void md_done_sync(struct mddev *mddev, int blocks, int ok);
770extern void md_error(struct mddev *mddev, struct md_rdev *rdev);
c6563a8c 771extern void md_finish_reshape(struct mddev *mddev);
cf78408f
XN
772void md_submit_discard_bio(struct mddev *mddev, struct md_rdev *rdev,
773 struct bio *bio, sector_t start, sector_t size);
0c031fd3
XN
774int acct_bioset_init(struct mddev *mddev);
775void acct_bioset_exit(struct mddev *mddev);
10764815 776void md_account_bio(struct mddev *mddev, struct bio **bio);
fd01b88c 777
775d7831 778extern bool __must_check md_flush_request(struct mddev *mddev, struct bio *bio);
fd01b88c 779extern void md_super_write(struct mddev *mddev, struct md_rdev *rdev,
92022950 780 sector_t sector, int size, struct page *page);
46533ff7 781extern int md_super_wait(struct mddev *mddev);
f72ffdd6 782extern int sync_page_io(struct md_rdev *rdev, sector_t sector, int size,
4ce4c73f 783 struct page *page, blk_opf_t opf, bool metadata_op);
4ed8731d 784extern void md_do_sync(struct md_thread *thread);
54679486 785extern void md_new_event(void);
2214c260 786extern void md_allow_write(struct mddev *mddev);
fd01b88c
N
787extern void md_wait_for_blocked_rdev(struct md_rdev *rdev, struct mddev *mddev);
788extern void md_set_array_sectors(struct mddev *mddev, sector_t array_sectors);
789extern int md_check_no_bitmap(struct mddev *mddev);
790extern int md_integrity_register(struct mddev *mddev);
1501efad 791extern int md_integrity_add_rdev(struct md_rdev *rdev, struct mddev *mddev);
72e02075 792extern int strict_strtoul_scaled(const char *cp, unsigned long *res, int scale);
63fe0817 793
fd01b88c 794extern void mddev_init(struct mddev *mddev);
34cb92c0
CH
795struct mddev *md_alloc(dev_t dev, char *name);
796void mddev_put(struct mddev *mddev);
fd01b88c 797extern int md_run(struct mddev *mddev);
d5d885fd 798extern int md_start(struct mddev *mddev);
fd01b88c
N
799extern void md_stop(struct mddev *mddev);
800extern void md_stop_writes(struct mddev *mddev);
3cb03002 801extern int md_rdev_init(struct md_rdev *rdev);
545c8795 802extern void md_rdev_clear(struct md_rdev *rdev);
63fe0817 803
393debc2 804extern void md_handle_request(struct mddev *mddev, struct bio *bio);
fd01b88c
N
805extern void mddev_suspend(struct mddev *mddev);
806extern void mddev_resume(struct mddev *mddev);
9cbb1750 807
70bcecdb 808extern void md_reload_sb(struct mddev *mddev, int raid_disk);
1aee41f6 809extern void md_update_sb(struct mddev *mddev, int force);
404659cf 810extern void mddev_create_serial_pool(struct mddev *mddev, struct md_rdev *rdev,
11d3a9f6 811 bool is_suspend);
69b00b5b
GJ
812extern void mddev_destroy_serial_pool(struct mddev *mddev, struct md_rdev *rdev,
813 bool is_suspend);
57d051dc 814struct md_rdev *md_find_rdev_nr_rcu(struct mddev *mddev, int nr);
1532d9e8 815struct md_rdev *md_find_rdev_rcu(struct mddev *mddev, dev_t dev);
dfe15ac1 816
c31fea2f 817static inline bool is_rdev_broken(struct md_rdev *rdev)
62f7b198 818{
c31fea2f 819 return !disk_live(rdev->bdev->bd_disk);
62f7b198
GP
820}
821
dfe15ac1
HR
822static inline void rdev_dec_pending(struct md_rdev *rdev, struct mddev *mddev)
823{
824 int faulty = test_bit(Faulty, &rdev->flags);
825 if (atomic_dec_and_test(&rdev->nr_pending) && faulty) {
826 set_bit(MD_RECOVERY_NEEDED, &mddev->recovery);
827 md_wakeup_thread(mddev->thread);
828 }
829}
830
edb39c9d 831extern struct md_cluster_operations *md_cluster_ops;
c4ce867f
GR
832static inline int mddev_is_clustered(struct mddev *mddev)
833{
834 return mddev->cluster_info && mddev->bitmap_info.nodes > 1;
835}
394ed8e4
SL
836
837/* clear unsupported mddev_flags */
838static inline void mddev_clear_unsupported_flags(struct mddev *mddev,
839 unsigned long unsupported_flags)
840{
841 mddev->flags &= ~unsupported_flags;
842}
26483819 843
3deff1a7
CH
844static inline void mddev_check_write_zeroes(struct mddev *mddev, struct bio *bio)
845{
846 if (bio_op(bio) == REQ_OP_WRITE_ZEROES &&
309dca30 847 !bio->bi_bdev->bd_disk->queue->limits.max_write_zeroes_sectors)
3deff1a7
CH
848 mddev->queue->limits.max_write_zeroes_sectors = 0;
849}
d82fa81c 850
7e0adbfc
CH
851struct mdu_array_info_s;
852struct mdu_disk_info_s;
853
1a6a0506 854extern int mdp_major;
a022325a 855extern struct workqueue_struct *md_bitmap_wq;
d82fa81c 856void md_autostart_arrays(int part);
7e0adbfc
CH
857int md_set_array_info(struct mddev *mddev, struct mdu_array_info_s *info);
858int md_add_new_disk(struct mddev *mddev, struct mdu_disk_info_s *info);
859int do_md_run(struct mddev *mddev);
860
861extern const struct block_device_operations md_fops;
d82fa81c 862
63fe0817 863#endif /* _MD_MD_H */