blob: 2a514036a83dc0da07c0966b7fe247c18356bbbf [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Wang Sheng-Hui7e841522011-09-21 15:37:46 +10002 md.h : kernel internal structure of the Linux MD driver
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 Copyright (C) 1996-98 Ingo Molnar, Gadi Oxman
NeilBrownf72ffdd2014-09-30 14:23:59 +10004
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2, or (at your option)
8 any later version.
NeilBrownf72ffdd2014-09-30 14:23:59 +10009
Linus Torvalds1da177e2005-04-16 15:20:36 -070010 You should have received a copy of the GNU General Public License
11 (for example /usr/src/linux/COPYING); if not, write to the Free
NeilBrownf72ffdd2014-09-30 14:23:59 +100012 Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
Linus Torvalds1da177e2005-04-16 15:20:36 -070013*/
14
Christoph Hellwig63fe0812009-04-14 12:01:53 +100015#ifndef _MD_MD_H
16#define _MD_MD_H
Linus Torvalds1da177e2005-04-16 15:20:36 -070017
Christoph Hellwig63fe0812009-04-14 12:01:53 +100018#include <linux/blkdev.h>
Tejun Heo66114ca2015-05-22 17:13:32 -040019#include <linux/backing-dev.h>
Vishal Vermafc974ee2015-12-24 19:20:34 -070020#include <linux/badblocks.h>
Christoph Hellwig63fe0812009-04-14 12:01:53 +100021#include <linux/kobject.h>
22#include <linux/list.h>
23#include <linux/mm.h>
24#include <linux/mutex.h>
25#include <linux/timer.h>
26#include <linux/wait.h>
27#include <linux/workqueue.h>
Goldwyn Rodriguesedb39c92014-03-29 10:01:53 -050028#include "md-cluster.h"
David Howells93614012006-09-30 20:45:40 +020029
Linus Torvalds1da177e2005-04-16 15:20:36 -070030#define MaxSector (~(sector_t)0)
Linus Torvalds1da177e2005-04-16 15:20:36 -070031
Linus Torvalds1da177e2005-04-16 15:20:36 -070032/*
NeilBrown46533ff2016-11-18 16:16:11 +110033 * These flags should really be called "NO_RETRY" rather than
34 * "FAILFAST" because they don't make any promise about time lapse,
35 * only about the number of retries, which will be zero.
36 * REQ_FAILFAST_DRIVER is not included because
37 * Commit: 4a27446f3e39 ("[SCSI] modify scsi to handle new fail fast flags.")
38 * seems to suggest that the errors it avoids retrying should usually
39 * be retried.
40 */
41#define MD_FAILFAST (REQ_FAILFAST_DEV | REQ_FAILFAST_TRANSPORT)
42/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070043 * MD's 'extended' device
44 */
NeilBrown3cb03002011-10-11 16:45:26 +110045struct md_rdev {
Linus Torvalds1da177e2005-04-16 15:20:36 -070046 struct list_head same_set; /* RAID devices within the same set */
47
Andre Nolldd8ac332009-03-31 14:33:13 +110048 sector_t sectors; /* Device size (in 512bytes sectors) */
NeilBrownfd01b882011-10-11 16:47:53 +110049 struct mddev *mddev; /* RAID array if running */
NeilBrowneea1bf32009-03-31 14:27:02 +110050 int last_events; /* IO event timestamp */
Linus Torvalds1da177e2005-04-16 15:20:36 -070051
Jonathan Brassowa6ff7e02011-01-14 09:14:34 +110052 /*
53 * If meta_bdev is non-NULL, it means that a separate device is
54 * being used to store the metadata (superblock/bitmap) which
55 * would otherwise be contained on the same device as the data (bdev).
56 */
57 struct block_device *meta_bdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -070058 struct block_device *bdev; /* block device handle */
59
NeilBrown2699b672011-07-28 11:31:47 +100060 struct page *sb_page, *bb_page;
Linus Torvalds1da177e2005-04-16 15:20:36 -070061 int sb_loaded;
NeilBrown42543762006-06-26 00:27:57 -070062 __u64 sb_events;
Linus Torvalds1da177e2005-04-16 15:20:36 -070063 sector_t data_offset; /* start of data in array */
NeilBrownc6563a82012-05-21 09:27:00 +100064 sector_t new_data_offset;/* only relevant while reshaping */
NeilBrownf72ffdd2014-09-30 14:23:59 +100065 sector_t sb_start; /* offset of the super block (in 512byte sectors) */
NeilBrown0002b272005-09-09 16:23:53 -070066 int sb_size; /* bytes in the superblock */
Linus Torvalds1da177e2005-04-16 15:20:36 -070067 int preferred_minor; /* autorun support */
68
NeilBrown86e6ffd2005-11-08 21:39:24 -080069 struct kobject kobj;
70
Linus Torvalds1da177e2005-04-16 15:20:36 -070071 /* A device can be in one of three states based on two flags:
72 * Not working: faulty==1 in_sync==0
73 * Fully working: faulty==0 in_sync==1
74 * Working, but not
75 * in sync with array
76 * faulty==0 in_sync==0
77 *
78 * It can never have faulty==1, in_sync==1
79 * This reduces the burden of testing multiple flags in many cases
80 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070081
NeilBrown2d78f8c2011-12-23 10:17:51 +110082 unsigned long flags; /* bit set of 'enum flag_bits' bits. */
Dan Williams6bfe0b42008-04-30 00:52:32 -070083 wait_queue_head_t blocked_wait;
NeilBrown8ddf9ef2005-09-09 16:23:45 -070084
Linus Torvalds1da177e2005-04-16 15:20:36 -070085 int desc_nr; /* descriptor index in the superblock */
86 int raid_disk; /* role of device in array */
NeilBrowne93f68a2010-06-15 09:36:03 +010087 int new_raid_disk; /* role that the device will have in
88 * the array after a level-change completes.
89 */
NeilBrown41158c72005-06-21 17:17:25 -070090 int saved_raid_disk; /* role that device used to have in the
91 * array and could again if we did a partial
92 * resync from the bitmap
93 */
Shaohua Li3069aa82015-08-13 14:31:56 -070094 union {
95 sector_t recovery_offset;/* If this device has been partially
NeilBrown5fd6c1d2006-06-26 00:27:40 -070096 * recovered, this is where we were
97 * up to.
98 */
Shaohua Li3069aa82015-08-13 14:31:56 -070099 sector_t journal_tail; /* If this device is a journal device,
100 * this is the journal tail (journal
101 * recovery start point)
102 */
103 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104
105 atomic_t nr_pending; /* number of pending requests.
106 * only maintained for arrays that
107 * support hot removal
108 */
NeilBrownba22dcb2005-11-08 21:39:31 -0800109 atomic_t read_errors; /* number of consecutive read errors that
110 * we have tried to ignore.
111 */
Arnd Bergmann0e3ef492016-06-17 17:33:10 +0200112 time64_t last_read_error; /* monotonic time since our
Robert Becker1e509152009-12-14 12:49:58 +1100113 * last read error
114 */
NeilBrown4dbcdc72006-01-06 00:20:52 -0800115 atomic_t corrected_errors; /* number of corrected read errors,
116 * for reporting to userspace and storing
117 * in superblock.
118 */
NeilBrown5792a282007-04-04 19:08:18 -0700119 struct work_struct del_work; /* used for delayed sysfs removal */
NeilBrown3c0ee632008-10-21 13:25:28 +1100120
Tejun Heo324a56e2013-12-11 14:11:53 -0500121 struct kernfs_node *sysfs_state; /* handle for 'state'
NeilBrown3c0ee632008-10-21 13:25:28 +1100122 * sysfs entry */
NeilBrown2230dfe2011-07-28 11:31:46 +1000123
Vishal Vermafc974ee2015-12-24 19:20:34 -0700124 struct badblocks badblocks;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125};
NeilBrown2d78f8c2011-12-23 10:17:51 +1100126enum flag_bits {
127 Faulty, /* device is known to have a fault */
128 In_sync, /* device is in_sync with rest of array */
NeilBrown8313b8e2013-12-12 10:13:33 +1100129 Bitmap_sync, /* ..actually, not quite In_sync. Need a
130 * bitmap-based recovery to get fully in sync
131 */
NeilBrown2d78f8c2011-12-23 10:17:51 +1100132 WriteMostly, /* Avoid reading if at all possible */
133 AutoDetected, /* added by auto-detect */
134 Blocked, /* An error occurred but has not yet
135 * been acknowledged by the metadata
136 * handler, so don't allow writes
137 * until it is cleared */
138 WriteErrorSeen, /* A write error has been seen on this
139 * device
140 */
141 FaultRecorded, /* Intermediate state for clearing
142 * Blocked. The Fault is/will-be
143 * recorded in the metadata, but that
144 * metadata hasn't been stored safely
145 * on disk yet.
146 */
147 BlockedBadBlocks, /* A writer is blocked because they
148 * found an unacknowledged bad-block.
149 * This can safely be cleared at any
150 * time, and the writer will re-check.
151 * It may be set at any time, and at
152 * worst the writer will timeout and
153 * re-check. So setting it as
154 * accurately as possible is good, but
155 * not absolutely critical.
156 */
157 WantReplacement, /* This device is a candidate to be
158 * hot-replaced, either because it has
159 * reported some faults, or because
160 * of explicit request.
161 */
162 Replacement, /* This device is a replacement for
163 * a want_replacement device with same
164 * raid_disk number.
165 */
Goldwyn Rodrigues1aee41f2014-10-29 18:51:31 -0500166 Candidate, /* For clustered environments only:
167 * This device is seen locally but not
168 * by the whole cluster
169 */
Song Liubac624f2015-08-13 14:31:55 -0700170 Journal, /* This device is used as journal for
171 * raid-5/6.
172 * Usually, this device should be faster
173 * than other devices in the array
174 */
Guoqing Jiang659b2542015-12-21 10:50:59 +1100175 ClusterRemove,
NeilBrownd787be42016-06-02 16:19:53 +1000176 RemoveSynchronized, /* synchronize_rcu() was called after
177 * this device was known to be faulty,
178 * so it is safe to remove without
179 * another synchronize_rcu() call.
180 */
Tomasz Majchrzak35b785f2016-10-21 16:26:57 +0200181 ExternalBbl, /* External metadata provides bad
182 * block management for a disk
183 */
NeilBrown688834e2016-11-18 16:16:11 +1100184 FailFast, /* Minimal retries should be attempted on
185 * this device, so use REQ_FAILFAST_DEV.
186 * Also don't try to repair failed reads.
187 * It is expects that no bad block log
188 * is present.
189 */
NeilBrown46533ff2016-11-18 16:16:11 +1100190 LastDev, /* Seems to be the last working dev as
191 * it didn't fail, so don't use FailFast
192 * any more for metadata
193 */
NeilBrown2d78f8c2011-12-23 10:17:51 +1100194};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195
NeilBrown3cb03002011-10-11 16:45:26 +1100196static inline int is_badblock(struct md_rdev *rdev, sector_t s, int sectors,
NeilBrown2230dfe2011-07-28 11:31:46 +1000197 sector_t *first_bad, int *bad_sectors)
198{
199 if (unlikely(rdev->badblocks.count)) {
Vishal Vermafc974ee2015-12-24 19:20:34 -0700200 int rv = badblocks_check(&rdev->badblocks, rdev->data_offset + s,
NeilBrown2230dfe2011-07-28 11:31:46 +1000201 sectors,
202 first_bad, bad_sectors);
203 if (rv)
204 *first_bad -= rdev->data_offset;
205 return rv;
206 }
207 return 0;
208}
NeilBrown3cb03002011-10-11 16:45:26 +1100209extern int rdev_set_badblocks(struct md_rdev *rdev, sector_t s, int sectors,
NeilBrownc6563a82012-05-21 09:27:00 +1000210 int is_new);
211extern int rdev_clear_badblocks(struct md_rdev *rdev, sector_t s, int sectors,
212 int is_new);
Goldwyn Rodriguesc4ce8672014-03-29 10:20:02 -0500213struct md_cluster_info;
214
Shaohua Li394ed8e2017-01-04 16:10:19 -0800215/* change UNSUPPORTED_MDDEV_FLAGS for each array type if new flag is added */
NeilBrownbe306c22016-11-09 10:21:33 +1100216enum mddev_flags {
NeilBrownbe306c22016-11-09 10:21:33 +1100217 MD_ARRAY_FIRST_USE, /* First use of array, needs initialization */
218 MD_CLOSING, /* If set, we are closing the array, do not open
219 * it then */
220 MD_JOURNAL_CLEAN, /* A raid with journal is already clean */
221 MD_HAS_JOURNAL, /* The raid array has journal feature set */
222 MD_RELOAD_SB, /* Reload the superblock because another node
223 * updated it.
224 */
225 MD_CLUSTER_RESYNC_LOCKED, /* cluster raid only, which means node
226 * already took resync lock, need to
227 * release the lock */
NeilBrown46533ff2016-11-18 16:16:11 +1100228 MD_FAILFAST_SUPPORTED, /* Using MD_FAILFAST on metadata writes is
229 * supported as calls to md_error() will
230 * never cause the array to become failed.
231 */
NeilBrownbe306c22016-11-09 10:21:33 +1100232};
Shaohua Li29530792016-12-08 15:48:19 -0800233
234enum mddev_sb_flags {
235 MD_SB_CHANGE_DEVS, /* Some device status has changed */
236 MD_SB_CHANGE_CLEAN, /* transition to or from 'clean' */
237 MD_SB_CHANGE_PENDING, /* switch from 'clean' to 'active' in progress */
238 MD_SB_NEED_REWRITE, /* metadata write needs to be repeated */
239};
240
NeilBrownfd01b882011-10-11 16:47:53 +1100241struct mddev {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242 void *private;
NeilBrown84fc4b52011-10-11 16:49:58 +1100243 struct md_personality *pers;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244 dev_t unit;
245 int md_minor;
NeilBrown7a0a5352013-08-27 16:28:23 +1000246 struct list_head disks;
NeilBrown850b2b42006-10-03 01:15:46 -0700247 unsigned long flags;
Shaohua Li29530792016-12-08 15:48:19 -0800248 unsigned long sb_flags;
NeilBrown850b2b42006-10-03 01:15:46 -0700249
NeilBrown409c57f2009-03-31 14:39:39 +1100250 int suspended;
251 atomic_t active_io;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252 int ro;
NeilBrownbb4f1e92010-08-08 21:18:03 +1000253 int sysfs_active; /* set when sysfs deletes
254 * are happening, so run/
255 * takeover/stop are not safe
256 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257 struct gendisk *gendisk;
258
NeilBrowneae17012005-11-08 21:39:23 -0800259 struct kobject kobj;
NeilBrownd3374822009-01-09 08:31:10 +1100260 int hold_active;
261#define UNTIL_IOCTL 1
NeilBrownefeb53c2009-01-09 08:31:10 +1100262#define UNTIL_STOP 2
NeilBrowneae17012005-11-08 21:39:23 -0800263
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264 /* Superblock information */
265 int major_version,
266 minor_version,
267 patch_version;
268 int persistent;
NeilBrownf72ffdd2014-09-30 14:23:59 +1000269 int external; /* metadata is
NeilBrowne6910632008-02-06 01:39:51 -0800270 * managed externally */
271 char metadata_type[17]; /* externally set*/
Andre Noll9d8f0362009-06-18 08:45:01 +1000272 int chunk_sectors;
Deepa Dinamani9ebc6ef2015-12-21 10:51:01 +1100273 time64_t ctime, utime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274 int level, layout;
NeilBrownd9d166c2006-01-06 00:20:51 -0800275 char clevel[16];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276 int raid_disks;
277 int max_disks;
NeilBrownf72ffdd2014-09-30 14:23:59 +1000278 sector_t dev_sectors; /* used size of
Andre Noll58c0fed2009-03-31 14:33:13 +1100279 * component devices */
Andre Nollf233ea52008-07-21 17:05:22 +1000280 sector_t array_sectors; /* exported array size */
Dan Williamsb522adc2009-03-31 15:00:31 +1100281 int external_size; /* size managed
282 * externally */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283 __u64 events;
NeilBrowna8707c02010-05-18 09:28:43 +1000284 /* If the last 'event' was simply a clean->dirty transition, and
285 * we didn't write it to the spares, then it is safe and simple
286 * to just decrement the event count on a dirty->clean transition.
287 * So we record that possibility here.
288 */
289 int can_decrease_events;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290
291 char uuid[16];
292
NeilBrownf6705572006-03-27 01:18:11 -0800293 /* If the array is being reshaped, we need to record the
294 * new shape and an indication of where we are up to.
295 * This is written to the superblock.
296 * If reshape_position is MaxSector, then no reshape is happening (yet).
297 */
298 sector_t reshape_position;
Andre Noll664e7c42009-06-18 08:45:27 +1000299 int delta_disks, new_level, new_layout;
300 int new_chunk_sectors;
NeilBrown2c810cd2012-05-21 09:27:00 +1000301 int reshape_backwards;
NeilBrownf6705572006-03-27 01:18:11 -0800302
NeilBrown2b8bf342011-10-11 16:48:23 +1100303 struct md_thread *thread; /* management thread */
304 struct md_thread *sync_thread; /* doing resync or reconstruct */
Jonathan Brassowc4a39552013-06-25 01:23:59 -0500305
306 /* 'last_sync_action' is initialized to "none". It is set when a
307 * sync operation (i.e "data-check", "requested-resync", "resync",
308 * "recovery", or "reshape") is started. It holds this value even
309 * when the sync thread is "frozen" (interrupted) or "idle" (stopped
310 * or finished). It is overwritten when a new sync operation is begun.
311 */
312 char *last_sync_action;
NeilBrownff4e8d92006-07-10 04:44:16 -0700313 sector_t curr_resync; /* last block scheduled */
NeilBrown97e4f422009-03-31 14:33:13 +1100314 /* As resync requests can complete out of order, we cannot easily track
315 * how much resync has been completed. So we occasionally pause until
316 * everything completes, then set curr_resync_completed to curr_resync.
317 * As such it may be well behind the real resync mark, but it is a value
318 * we are certain of.
319 */
320 sector_t curr_resync_completed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321 unsigned long resync_mark; /* a recent timestamp */
322 sector_t resync_mark_cnt;/* blocks written at resync_mark */
NeilBrownff4e8d92006-07-10 04:44:16 -0700323 sector_t curr_mark_cnt; /* blocks scheduled now */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324
325 sector_t resync_max_sectors; /* may be set by personality */
NeilBrown9d888832005-11-08 21:39:26 -0800326
Jianpeng Ma7f7583d2012-10-11 14:17:59 +1100327 atomic64_t resync_mismatches; /* count of sectors where
NeilBrown9d888832005-11-08 21:39:26 -0800328 * parity/replica mismatch found
329 */
NeilBrowne464eaf2006-03-27 01:18:14 -0800330
331 /* allow user-space to request suspension of IO to regions of the array */
332 sector_t suspend_lo;
333 sector_t suspend_hi;
NeilBrown88202a02006-01-06 00:21:36 -0800334 /* if zero, use the system-wide default */
335 int sync_speed_min;
336 int sync_speed_max;
337
Bernd Schubert90b08712008-05-23 13:04:38 -0700338 /* resync even though the same disks are shared among md-devices */
339 int parallel_resync;
340
NeilBrown6ff8d8ec2006-01-06 00:20:15 -0800341 int ok_start_degraded;
NeilBrown5fd6c1d2006-06-26 00:27:40 -0700342
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343 unsigned long recovery;
NeilBrown53890422011-07-27 11:00:36 +1000344 /* If a RAID personality determines that recovery (of a particular
345 * device) will fail due to a read error on the source device, it
346 * takes a copy of this number and does not attempt recovery again
347 * until this number changes.
348 */
349 int recovery_disabled;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350
351 int in_sync; /* know to not need resync */
NeilBrownc8c00a62009-08-10 12:50:52 +1000352 /* 'open_mutex' avoids races between 'md_open' and 'do_md_stop', so
353 * that we are never stopping an array while it is open.
354 * 'reconfig_mutex' protects all other reconfiguration.
355 * These locks are separate due to conflicting interactions
356 * with bdev->bd_mutex.
357 * Lock ordering is:
358 * reconfig_mutex -> bd_mutex : e.g. do_md_run -> revalidate_disk
359 * bd_mutex -> open_mutex: e.g. __blkdev_get -> md_open
360 */
361 struct mutex open_mutex;
NeilBrowndf5b89b2006-03-27 01:18:20 -0800362 struct mutex reconfig_mutex;
NeilBrownf2ea68c2008-07-21 17:05:25 +1000363 atomic_t active; /* general refcount */
364 atomic_t openers; /* number of active opens */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365
NeilBrownf0b4f7e2011-02-24 17:26:41 +1100366 int changed; /* True if we might need to
367 * reread partition info */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368 int degraded; /* whether md should consider
369 * adding a spare
370 */
371
372 atomic_t recovery_active; /* blocks scheduled, but not written */
373 wait_queue_head_t recovery_wait;
374 sector_t recovery_cp;
Neil Brown5e96ee62008-06-28 08:31:24 +1000375 sector_t resync_min; /* user requested sync
376 * starts here */
NeilBrownc6207272008-02-06 01:39:52 -0800377 sector_t resync_max; /* resync should pause
378 * when it gets here */
NeilBrown06d91a52005-06-21 17:17:12 -0700379
Tejun Heo324a56e2013-12-11 14:11:53 -0500380 struct kernfs_node *sysfs_state; /* handle for 'array_state'
NeilBrownb62b7592008-10-21 13:25:21 +1100381 * file in sysfs.
382 */
Tejun Heo324a56e2013-12-11 14:11:53 -0500383 struct kernfs_node *sysfs_action; /* handle for 'sync_action' */
NeilBrownb62b7592008-10-21 13:25:21 +1100384
NeilBrownd3374822009-01-09 08:31:10 +1100385 struct work_struct del_work; /* used for delayed sysfs removal */
386
NeilBrown85572d72014-12-15 12:56:56 +1100387 /* "lock" protects:
388 * flush_bio transition from NULL to !NULL
389 * rdev superblocks, events
390 * clearing MD_CHANGE_*
391 * in_sync - and related safemode and MD_CHANGE changes
NeilBrown36d091f2014-12-15 12:56:58 +1100392 * pers (also protected by reconfig_mutex and pending IO).
NeilBrown978a7a42014-12-15 12:56:58 +1100393 * clearing ->bitmap
NeilBrown4af1a042014-12-15 12:57:00 +1100394 * clearing ->bitmap_info.file
NeilBrown23da4222014-12-15 12:57:01 +1100395 * changing ->resync_{min,max}
396 * setting MD_RECOVERY_RUNNING (which interacts with resync_{min,max})
NeilBrown85572d72014-12-15 12:56:56 +1100397 */
398 spinlock_t lock;
NeilBrown3d310eb2005-06-21 17:17:26 -0700399 wait_queue_head_t sb_wait; /* for waiting on superblock updates */
NeilBrown7bfa19f2005-06-21 17:17:28 -0700400 atomic_t pending_writes; /* number of active superblock writes */
NeilBrown06d91a52005-06-21 17:17:12 -0700401
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402 unsigned int safemode; /* if set, update "clean" superblock
403 * when no writes pending.
NeilBrownf72ffdd2014-09-30 14:23:59 +1000404 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405 unsigned int safemode_delay;
406 struct timer_list safemode_timer;
NeilBrownf72ffdd2014-09-30 14:23:59 +1000407 atomic_t writes_pending;
Jens Axboe165125e2007-07-24 09:28:11 +0200408 struct request_queue *queue; /* for plugging ... */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409
NeilBrownf72ffdd2014-09-30 14:23:59 +1000410 struct bitmap *bitmap; /* the bitmap for the device */
NeilBrownc3d97142009-12-14 12:49:52 +1100411 struct {
412 struct file *file; /* the bitmap file */
NeilBrownf6af9492009-12-14 12:49:54 +1100413 loff_t offset; /* offset from superblock of
NeilBrownc3d97142009-12-14 12:49:52 +1100414 * start of bitmap. May be
415 * negative, but not '0'
NeilBrownf6af9492009-12-14 12:49:54 +1100416 * For external metadata, offset
NeilBrownf72ffdd2014-09-30 14:23:59 +1000417 * from start of device.
NeilBrownc3d97142009-12-14 12:49:52 +1100418 */
NeilBrown6409bb02012-05-22 13:55:07 +1000419 unsigned long space; /* space available at this offset */
NeilBrownf6af9492009-12-14 12:49:54 +1100420 loff_t default_offset; /* this is the offset to use when
NeilBrownc3d97142009-12-14 12:49:52 +1100421 * hot-adding a bitmap. It should
422 * eventually be settable by sysfs.
423 */
NeilBrown6409bb02012-05-22 13:55:07 +1000424 unsigned long default_space; /* space available at
425 * default offset */
NeilBrownc3d97142009-12-14 12:49:52 +1100426 struct mutex mutex;
NeilBrown42a04b52009-12-14 12:49:53 +1100427 unsigned long chunksize;
NeilBrownac2f40b2010-06-01 19:37:31 +1000428 unsigned long daemon_sleep; /* how many jiffies between updates? */
NeilBrown42a04b52009-12-14 12:49:53 +1100429 unsigned long max_write_behind; /* write-behind mode */
NeilBrownece5cff2009-12-14 12:49:56 +1100430 int external;
Goldwyn Rodriguesc4ce8672014-03-29 10:20:02 -0500431 int nodes; /* Maximum number of nodes in the cluster */
Goldwyn Rodriguescf921cc2014-03-30 00:42:49 -0500432 char cluster_name[64]; /* Name of the cluster */
NeilBrownc3d97142009-12-14 12:49:52 +1100433 } bitmap_info;
NeilBrown32a76272005-06-21 17:17:14 -0700434
NeilBrownf72ffdd2014-09-30 14:23:59 +1000435 atomic_t max_corr_read_errors; /* max read retries */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436 struct list_head all_mddevs;
NeilBrowna2826aa2009-12-14 12:49:49 +1100437
NeilBrowna64c8762010-04-14 17:15:37 +1000438 struct attribute_group *to_remove;
NeilBrown252ac522010-06-01 19:37:29 +1000439
NeilBrowna167f662010-10-26 18:31:13 +1100440 struct bio_set *bio_set;
441
Tejun Heoe9c74692010-09-03 11:56:18 +0200442 /* Generic flush handling.
443 * The last to finish preflush schedules a worker to submit
Mike Christie28a8f0d2016-06-05 14:32:25 -0500444 * the rest of the request (without the REQ_PREFLUSH flag).
NeilBrowna2826aa2009-12-14 12:49:49 +1100445 */
Tejun Heoe9c74692010-09-03 11:56:18 +0200446 struct bio *flush_bio;
NeilBrowna2826aa2009-12-14 12:49:49 +1100447 atomic_t flush_pending;
Tejun Heoe9c74692010-09-03 11:56:18 +0200448 struct work_struct flush_work;
NeilBrown768a4182010-07-26 11:49:55 +1000449 struct work_struct event_work; /* used by dm to report failure event */
NeilBrownfd01b882011-10-11 16:47:53 +1100450 void (*sync_super)(struct mddev *mddev, struct md_rdev *rdev);
Goldwyn Rodriguesc4ce8672014-03-29 10:20:02 -0500451 struct md_cluster_info *cluster_info;
Guoqing Jiang15858fa2015-12-21 10:51:00 +1100452 unsigned int good_device_nr; /* good device num within cluster raid */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453};
454
NeilBrownbe306c22016-11-09 10:21:33 +1100455enum recovery_flags {
456 /*
457 * If neither SYNC or RESHAPE are set, then it is a recovery.
458 */
459 MD_RECOVERY_RUNNING, /* a thread is running, or about to be started */
460 MD_RECOVERY_SYNC, /* actually doing a resync, not a recovery */
461 MD_RECOVERY_RECOVER, /* doing recovery, or need to try it. */
462 MD_RECOVERY_INTR, /* resync needs to be aborted for some reason */
463 MD_RECOVERY_DONE, /* thread is done and is waiting to be reaped */
464 MD_RECOVERY_NEEDED, /* we might need to start a resync/recover */
465 MD_RECOVERY_REQUESTED, /* user-space has requested a sync (used with SYNC) */
466 MD_RECOVERY_CHECK, /* user-space request for check-only, no repair */
467 MD_RECOVERY_RESHAPE, /* A reshape is happening */
468 MD_RECOVERY_FROZEN, /* User request to abort, and not restart, any action */
469 MD_RECOVERY_ERROR, /* sync-action interrupted because io-error */
470};
471
NeilBrown5c47daf2014-12-15 12:57:01 +1100472static inline int __must_check mddev_lock(struct mddev *mddev)
473{
474 return mutex_lock_interruptible(&mddev->reconfig_mutex);
475}
476
477/* Sometimes we need to take the lock in a situation where
478 * failure due to interrupts is not acceptable.
479 */
480static inline void mddev_lock_nointr(struct mddev *mddev)
481{
482 mutex_lock(&mddev->reconfig_mutex);
483}
484
485static inline int mddev_is_locked(struct mddev *mddev)
486{
487 return mutex_is_locked(&mddev->reconfig_mutex);
488}
489
490static inline int mddev_trylock(struct mddev *mddev)
491{
492 return mutex_trylock(&mddev->reconfig_mutex);
493}
494extern void mddev_unlock(struct mddev *mddev);
495
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496static inline void md_sync_acct(struct block_device *bdev, unsigned long nr_sectors)
497{
NeilBrownf72ffdd2014-09-30 14:23:59 +1000498 atomic_add(nr_sectors, &bdev->bd_contains->bd_disk->sync_io);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499}
500
NeilBrown84fc4b52011-10-11 16:49:58 +1100501struct md_personality
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502{
503 char *name;
NeilBrown2604b702006-01-06 00:20:36 -0800504 int level;
505 struct list_head list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506 struct module *owner;
Linus Torvaldsb4fdcb02011-11-04 17:06:58 -0700507 void (*make_request)(struct mddev *mddev, struct bio *bio);
NeilBrownfd01b882011-10-11 16:47:53 +1100508 int (*run)(struct mddev *mddev);
NeilBrownafa0f552014-12-15 12:56:58 +1100509 void (*free)(struct mddev *mddev, void *priv);
NeilBrownfd01b882011-10-11 16:47:53 +1100510 void (*status)(struct seq_file *seq, struct mddev *mddev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511 /* error_handler must set ->faulty and clear ->in_sync
NeilBrownf72ffdd2014-09-30 14:23:59 +1000512 * if appropriate, and should abort recovery if needed
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513 */
NeilBrownfd01b882011-10-11 16:47:53 +1100514 void (*error_handler)(struct mddev *mddev, struct md_rdev *rdev);
515 int (*hot_add_disk) (struct mddev *mddev, struct md_rdev *rdev);
NeilBrownb8321b62011-12-23 10:17:51 +1100516 int (*hot_remove_disk) (struct mddev *mddev, struct md_rdev *rdev);
NeilBrownfd01b882011-10-11 16:47:53 +1100517 int (*spare_active) (struct mddev *mddev);
NeilBrown09314792015-02-19 16:04:40 +1100518 sector_t (*sync_request)(struct mddev *mddev, sector_t sector_nr, int *skipped);
NeilBrownfd01b882011-10-11 16:47:53 +1100519 int (*resize) (struct mddev *mddev, sector_t sectors);
520 sector_t (*size) (struct mddev *mddev, sector_t sectors, int raid_disks);
521 int (*check_reshape) (struct mddev *mddev);
522 int (*start_reshape) (struct mddev *mddev);
523 void (*finish_reshape) (struct mddev *mddev);
NeilBrown36fa3062005-09-09 16:23:45 -0700524 /* quiesce moves between quiescence states
525 * 0 - fully active
526 * 1 - no new requests allowed
527 * others - reserved
528 */
NeilBrownfd01b882011-10-11 16:47:53 +1100529 void (*quiesce) (struct mddev *mddev, int state);
NeilBrown245f46c2009-03-31 14:39:39 +1100530 /* takeover is used to transition an array from one
531 * personality to another. The new personality must be able
532 * to handle the data in the current layout.
533 * e.g. 2drive raid1 -> 2drive raid5
534 * ndrive raid5 -> degraded n+1drive raid6 with special layout
535 * If the takeover succeeds, a new 'private' structure is returned.
536 * This needs to be installed and then ->run used to activate the
537 * array.
538 */
NeilBrownfd01b882011-10-11 16:47:53 +1100539 void *(*takeover) (struct mddev *mddev);
NeilBrown5c675f82014-12-15 12:56:56 +1100540 /* congested implements bdi.congested_fn().
541 * Will not be called while array is 'suspended' */
542 int (*congested)(struct mddev *mddev, int bits);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543};
544
NeilBrown007583c2005-11-08 21:39:30 -0800545struct md_sysfs_entry {
546 struct attribute attr;
NeilBrownfd01b882011-10-11 16:47:53 +1100547 ssize_t (*show)(struct mddev *, char *);
548 ssize_t (*store)(struct mddev *, const char *, size_t);
NeilBrown007583c2005-11-08 21:39:30 -0800549};
NeilBrown43a70502009-12-14 12:49:55 +1100550extern struct attribute_group md_bitmap_group;
NeilBrown007583c2005-11-08 21:39:30 -0800551
Tejun Heo324a56e2013-12-11 14:11:53 -0500552static inline struct kernfs_node *sysfs_get_dirent_safe(struct kernfs_node *sd, char *name)
NeilBrown00bcb4a2010-06-01 19:37:23 +1000553{
554 if (sd)
Tejun Heo388975c2013-09-11 23:19:13 -0400555 return sysfs_get_dirent(sd, name);
NeilBrown00bcb4a2010-06-01 19:37:23 +1000556 return sd;
557}
Tejun Heo324a56e2013-12-11 14:11:53 -0500558static inline void sysfs_notify_dirent_safe(struct kernfs_node *sd)
NeilBrown00bcb4a2010-06-01 19:37:23 +1000559{
560 if (sd)
561 sysfs_notify_dirent(sd);
562}
563
NeilBrownfd01b882011-10-11 16:47:53 +1100564static inline char * mdname (struct mddev * mddev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565{
566 return mddev->gendisk ? mddev->gendisk->disk_name : "mdX";
567}
568
NeilBrownfd01b882011-10-11 16:47:53 +1100569static inline int sysfs_link_rdev(struct mddev *mddev, struct md_rdev *rdev)
Namhyung Kim36fad852011-07-27 11:00:36 +1000570{
571 char nm[20];
Shaohua Li9b156032015-12-18 15:19:16 +1100572 if (!test_bit(Replacement, &rdev->flags) &&
573 !test_bit(Journal, &rdev->flags) &&
574 mddev->kobj.sd) {
NeilBrown2d78f8c2011-12-23 10:17:51 +1100575 sprintf(nm, "rd%d", rdev->raid_disk);
576 return sysfs_create_link(&mddev->kobj, &rdev->kobj, nm);
577 } else
578 return 0;
Namhyung Kim36fad852011-07-27 11:00:36 +1000579}
580
NeilBrownfd01b882011-10-11 16:47:53 +1100581static inline void sysfs_unlink_rdev(struct mddev *mddev, struct md_rdev *rdev)
Namhyung Kim36fad852011-07-27 11:00:36 +1000582{
583 char nm[20];
Shaohua Li9b156032015-12-18 15:19:16 +1100584 if (!test_bit(Replacement, &rdev->flags) &&
585 !test_bit(Journal, &rdev->flags) &&
586 mddev->kobj.sd) {
NeilBrown2d78f8c2011-12-23 10:17:51 +1100587 sprintf(nm, "rd%d", rdev->raid_disk);
588 sysfs_remove_link(&mddev->kobj, nm);
589 }
Namhyung Kim36fad852011-07-27 11:00:36 +1000590}
591
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592/*
593 * iterates through some rdev ringlist. It's safe to remove the
594 * current 'rdev'. Dont touch 'tmp' though.
595 */
Cheng Renquan159ec1f2009-01-09 08:31:08 +1100596#define rdev_for_each_list(rdev, tmp, head) \
597 list_for_each_entry_safe(rdev, tmp, head, same_set)
598
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599/*
600 * iterates through the 'same array disks' ringlist
601 */
NeilBrowndafb20f2012-03-19 12:46:39 +1100602#define rdev_for_each(rdev, mddev) \
603 list_for_each_entry(rdev, &((mddev)->disks), same_set)
604
605#define rdev_for_each_safe(rdev, tmp, mddev) \
Cheng Renquan159ec1f2009-01-09 08:31:08 +1100606 list_for_each_entry_safe(rdev, tmp, &((mddev)->disks), same_set)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607
NeilBrown4b809912008-07-21 17:05:25 +1000608#define rdev_for_each_rcu(rdev, mddev) \
609 list_for_each_entry_rcu(rdev, &((mddev)->disks), same_set)
610
NeilBrown2b8bf342011-10-11 16:48:23 +1100611struct md_thread {
Shaohua Li4ed87312012-10-11 13:34:00 +1100612 void (*run) (struct md_thread *thread);
NeilBrownfd01b882011-10-11 16:47:53 +1100613 struct mddev *mddev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614 wait_queue_head_t wqueue;
NeilBrownf72ffdd2014-09-30 14:23:59 +1000615 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616 struct task_struct *tsk;
NeilBrown32a76272005-06-21 17:17:14 -0700617 unsigned long timeout;
Shaohua Li4ed87312012-10-11 13:34:00 +1100618 void *private;
NeilBrown2b8bf342011-10-11 16:48:23 +1100619};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620
621#define THREAD_WAKEUP 0
622
NeilBrown1345b1d2006-01-06 00:20:40 -0800623static inline void safe_put_page(struct page *p)
624{
625 if (p) put_page(p);
626}
627
NeilBrown84fc4b52011-10-11 16:49:58 +1100628extern int register_md_personality(struct md_personality *p);
629extern int unregister_md_personality(struct md_personality *p);
Goldwyn Rodriguesedb39c92014-03-29 10:01:53 -0500630extern int register_md_cluster_operations(struct md_cluster_operations *ops,
631 struct module *module);
632extern int unregister_md_cluster_operations(void);
633extern int md_setup_cluster(struct mddev *mddev, int nodes);
634extern void md_cluster_stop(struct mddev *mddev);
NeilBrown2b8bf342011-10-11 16:48:23 +1100635extern struct md_thread *md_register_thread(
Shaohua Li4ed87312012-10-11 13:34:00 +1100636 void (*run)(struct md_thread *thread),
NeilBrown2b8bf342011-10-11 16:48:23 +1100637 struct mddev *mddev,
638 const char *name);
639extern void md_unregister_thread(struct md_thread **threadp);
640extern void md_wakeup_thread(struct md_thread *thread);
NeilBrownfd01b882011-10-11 16:47:53 +1100641extern void md_check_recovery(struct mddev *mddev);
Jonathan Brassowa91d5ac2013-04-24 11:42:43 +1000642extern void md_reap_sync_thread(struct mddev *mddev);
NeilBrownfd01b882011-10-11 16:47:53 +1100643extern void md_write_start(struct mddev *mddev, struct bio *bi);
644extern void md_write_end(struct mddev *mddev);
645extern void md_done_sync(struct mddev *mddev, int blocks, int ok);
646extern void md_error(struct mddev *mddev, struct md_rdev *rdev);
NeilBrownc6563a82012-05-21 09:27:00 +1000647extern void md_finish_reshape(struct mddev *mddev);
NeilBrown92022952009-03-31 14:33:13 +1100648
NeilBrownfd01b882011-10-11 16:47:53 +1100649extern int mddev_congested(struct mddev *mddev, int bits);
650extern void md_flush_request(struct mddev *mddev, struct bio *bio);
651extern void md_super_write(struct mddev *mddev, struct md_rdev *rdev,
NeilBrown92022952009-03-31 14:33:13 +1100652 sector_t sector, int size, struct page *page);
NeilBrown46533ff2016-11-18 16:16:11 +1100653extern int md_super_wait(struct mddev *mddev);
NeilBrownf72ffdd2014-09-30 14:23:59 +1000654extern int sync_page_io(struct md_rdev *rdev, sector_t sector, int size,
Mike Christie796a5cf2016-06-05 14:32:07 -0500655 struct page *page, int op, int op_flags,
656 bool metadata_op);
Shaohua Li4ed87312012-10-11 13:34:00 +1100657extern void md_do_sync(struct md_thread *thread);
NeilBrownfd01b882011-10-11 16:47:53 +1100658extern void md_new_event(struct mddev *mddev);
659extern int md_allow_write(struct mddev *mddev);
660extern void md_wait_for_blocked_rdev(struct md_rdev *rdev, struct mddev *mddev);
661extern void md_set_array_sectors(struct mddev *mddev, sector_t array_sectors);
662extern int md_check_no_bitmap(struct mddev *mddev);
663extern int md_integrity_register(struct mddev *mddev);
Dan Williams1501efa2016-01-13 16:00:07 -0800664extern int md_integrity_add_rdev(struct md_rdev *rdev, struct mddev *mddev);
NeilBrown72e02072009-12-14 12:49:55 +1100665extern int strict_strtoul_scaled(const char *cp, unsigned long *res, int scale);
Christoph Hellwig63fe0812009-04-14 12:01:53 +1000666
NeilBrownfd01b882011-10-11 16:47:53 +1100667extern void mddev_init(struct mddev *mddev);
668extern int md_run(struct mddev *mddev);
669extern void md_stop(struct mddev *mddev);
670extern void md_stop_writes(struct mddev *mddev);
NeilBrown3cb03002011-10-11 16:45:26 +1100671extern int md_rdev_init(struct md_rdev *rdev);
NeilBrown545c8792012-05-22 13:54:30 +1000672extern void md_rdev_clear(struct md_rdev *rdev);
NeilBrown390ee602010-06-01 19:37:27 +1000673
NeilBrownfd01b882011-10-11 16:47:53 +1100674extern void mddev_suspend(struct mddev *mddev);
675extern void mddev_resume(struct mddev *mddev);
NeilBrowna167f662010-10-26 18:31:13 +1100676extern struct bio *bio_clone_mddev(struct bio *bio, gfp_t gfp_mask,
NeilBrownfd01b882011-10-11 16:47:53 +1100677 struct mddev *mddev);
NeilBrowna167f662010-10-26 18:31:13 +1100678extern struct bio *bio_alloc_mddev(gfp_t gfp_mask, int nr_iovecs,
NeilBrownfd01b882011-10-11 16:47:53 +1100679 struct mddev *mddev);
NeilBrown9cbb1752012-07-31 09:08:14 +0200680
NeilBrown74018dc2012-07-31 09:08:15 +0200681extern void md_unplug(struct blk_plug_cb *cb, bool from_schedule);
Goldwyn Rodrigues70bcecd2015-08-21 10:33:39 -0500682extern void md_reload_sb(struct mddev *mddev, int raid_disk);
Goldwyn Rodrigues1aee41f2014-10-29 18:51:31 -0500683extern void md_update_sb(struct mddev *mddev, int force);
Goldwyn Rodriguesfb56dfe2015-04-14 10:43:24 -0500684extern void md_kick_rdev_from_array(struct md_rdev * rdev);
Goldwyn Rodrigues57d051d2015-04-14 10:43:55 -0500685struct md_rdev *md_find_rdev_nr_rcu(struct mddev *mddev, int nr);
NeilBrown9cbb1752012-07-31 09:08:14 +0200686static inline int mddev_check_plugged(struct mddev *mddev)
687{
688 return !!blk_check_plugged(md_unplug, mddev,
689 sizeof(struct blk_plug_cb));
690}
Hannes Reineckedfe15ac2012-07-26 11:12:18 +0200691
692static inline void rdev_dec_pending(struct md_rdev *rdev, struct mddev *mddev)
693{
694 int faulty = test_bit(Faulty, &rdev->flags);
695 if (atomic_dec_and_test(&rdev->nr_pending) && faulty) {
696 set_bit(MD_RECOVERY_NEEDED, &mddev->recovery);
697 md_wakeup_thread(mddev->thread);
698 }
699}
700
Goldwyn Rodriguesedb39c92014-03-29 10:01:53 -0500701extern struct md_cluster_operations *md_cluster_ops;
Goldwyn Rodriguesc4ce8672014-03-29 10:20:02 -0500702static inline int mddev_is_clustered(struct mddev *mddev)
703{
704 return mddev->cluster_info && mddev->bitmap_info.nodes > 1;
705}
Shaohua Li394ed8e2017-01-04 16:10:19 -0800706
707/* clear unsupported mddev_flags */
708static inline void mddev_clear_unsupported_flags(struct mddev *mddev,
709 unsigned long unsupported_flags)
710{
711 mddev->flags &= ~unsupported_flags;
712}
Christoph Hellwig63fe0812009-04-14 12:01:53 +1000713#endif /* _MD_MD_H */