blob: 2bea51edfab707645a6d6b8a5b6c79bb0c6dde64 [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>
Christoph Hellwig63fe0812009-04-14 12:01:53 +100020#include <linux/kobject.h>
21#include <linux/list.h>
22#include <linux/mm.h>
23#include <linux/mutex.h>
24#include <linux/timer.h>
25#include <linux/wait.h>
26#include <linux/workqueue.h>
Goldwyn Rodriguesedb39c92014-03-29 10:01:53 -050027#include "md-cluster.h"
David Howells93614012006-09-30 20:45:40 +020028
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#define MaxSector (~(sector_t)0)
Linus Torvalds1da177e2005-04-16 15:20:36 -070030
NeilBrown2230dfe2011-07-28 11:31:46 +100031/* Bad block numbers are stored sorted in a single page.
32 * 64bits is used for each block or extent.
33 * 54 bits are sector number, 9 bits are extent size,
34 * 1 bit is an 'acknowledged' flag.
35 */
36#define MD_MAX_BADBLOCKS (PAGE_SIZE/8)
37
Linus Torvalds1da177e2005-04-16 15:20:36 -070038/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070039 * MD's 'extended' device
40 */
NeilBrown3cb03002011-10-11 16:45:26 +110041struct md_rdev {
Linus Torvalds1da177e2005-04-16 15:20:36 -070042 struct list_head same_set; /* RAID devices within the same set */
43
Andre Nolldd8ac332009-03-31 14:33:13 +110044 sector_t sectors; /* Device size (in 512bytes sectors) */
NeilBrownfd01b882011-10-11 16:47:53 +110045 struct mddev *mddev; /* RAID array if running */
NeilBrowneea1bf32009-03-31 14:27:02 +110046 int last_events; /* IO event timestamp */
Linus Torvalds1da177e2005-04-16 15:20:36 -070047
Jonathan Brassowa6ff7e02011-01-14 09:14:34 +110048 /*
49 * If meta_bdev is non-NULL, it means that a separate device is
50 * being used to store the metadata (superblock/bitmap) which
51 * would otherwise be contained on the same device as the data (bdev).
52 */
53 struct block_device *meta_bdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -070054 struct block_device *bdev; /* block device handle */
55
NeilBrown2699b672011-07-28 11:31:47 +100056 struct page *sb_page, *bb_page;
Linus Torvalds1da177e2005-04-16 15:20:36 -070057 int sb_loaded;
NeilBrown42543762006-06-26 00:27:57 -070058 __u64 sb_events;
Linus Torvalds1da177e2005-04-16 15:20:36 -070059 sector_t data_offset; /* start of data in array */
NeilBrownc6563a82012-05-21 09:27:00 +100060 sector_t new_data_offset;/* only relevant while reshaping */
NeilBrownf72ffdd2014-09-30 14:23:59 +100061 sector_t sb_start; /* offset of the super block (in 512byte sectors) */
NeilBrown0002b272005-09-09 16:23:53 -070062 int sb_size; /* bytes in the superblock */
Linus Torvalds1da177e2005-04-16 15:20:36 -070063 int preferred_minor; /* autorun support */
64
NeilBrown86e6ffd2005-11-08 21:39:24 -080065 struct kobject kobj;
66
Linus Torvalds1da177e2005-04-16 15:20:36 -070067 /* A device can be in one of three states based on two flags:
68 * Not working: faulty==1 in_sync==0
69 * Fully working: faulty==0 in_sync==1
70 * Working, but not
71 * in sync with array
72 * faulty==0 in_sync==0
73 *
74 * It can never have faulty==1, in_sync==1
75 * This reduces the burden of testing multiple flags in many cases
76 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070077
NeilBrown2d78f8c2011-12-23 10:17:51 +110078 unsigned long flags; /* bit set of 'enum flag_bits' bits. */
Dan Williams6bfe0b42008-04-30 00:52:32 -070079 wait_queue_head_t blocked_wait;
NeilBrown8ddf9ef2005-09-09 16:23:45 -070080
Linus Torvalds1da177e2005-04-16 15:20:36 -070081 int desc_nr; /* descriptor index in the superblock */
82 int raid_disk; /* role of device in array */
NeilBrowne93f68a2010-06-15 09:36:03 +010083 int new_raid_disk; /* role that the device will have in
84 * the array after a level-change completes.
85 */
NeilBrown41158c72005-06-21 17:17:25 -070086 int saved_raid_disk; /* role that device used to have in the
87 * array and could again if we did a partial
88 * resync from the bitmap
89 */
Shaohua Li3069aa82015-08-13 14:31:56 -070090 union {
91 sector_t recovery_offset;/* If this device has been partially
NeilBrown5fd6c1d2006-06-26 00:27:40 -070092 * recovered, this is where we were
93 * up to.
94 */
Shaohua Li3069aa82015-08-13 14:31:56 -070095 sector_t journal_tail; /* If this device is a journal device,
96 * this is the journal tail (journal
97 * recovery start point)
98 */
99 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100
101 atomic_t nr_pending; /* number of pending requests.
102 * only maintained for arrays that
103 * support hot removal
104 */
NeilBrownba22dcb2005-11-08 21:39:31 -0800105 atomic_t read_errors; /* number of consecutive read errors that
106 * we have tried to ignore.
107 */
Robert Becker1e509152009-12-14 12:49:58 +1100108 struct timespec last_read_error; /* monotonic time since our
109 * last read error
110 */
NeilBrown4dbcdc72006-01-06 00:20:52 -0800111 atomic_t corrected_errors; /* number of corrected read errors,
112 * for reporting to userspace and storing
113 * in superblock.
114 */
NeilBrown5792a282007-04-04 19:08:18 -0700115 struct work_struct del_work; /* used for delayed sysfs removal */
NeilBrown3c0ee632008-10-21 13:25:28 +1100116
Tejun Heo324a56e2013-12-11 14:11:53 -0500117 struct kernfs_node *sysfs_state; /* handle for 'state'
NeilBrown3c0ee632008-10-21 13:25:28 +1100118 * sysfs entry */
NeilBrown2230dfe2011-07-28 11:31:46 +1000119
120 struct badblocks {
121 int count; /* count of bad blocks */
NeilBrownde393cd2011-07-28 11:31:48 +1000122 int unacked_exist; /* there probably are unacknowledged
123 * bad blocks. This is only cleared
124 * when a read discovers none
125 */
NeilBrown2230dfe2011-07-28 11:31:46 +1000126 int shift; /* shift from sectors to block size
127 * a -ve shift means badblocks are
128 * disabled.*/
129 u64 *page; /* badblock list */
130 int changed;
131 seqlock_t lock;
NeilBrown2699b672011-07-28 11:31:47 +1000132
133 sector_t sector;
134 sector_t size; /* in sectors */
NeilBrown2230dfe2011-07-28 11:31:46 +1000135 } badblocks;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136};
NeilBrown2d78f8c2011-12-23 10:17:51 +1100137enum flag_bits {
138 Faulty, /* device is known to have a fault */
139 In_sync, /* device is in_sync with rest of array */
NeilBrown8313b8e2013-12-12 10:13:33 +1100140 Bitmap_sync, /* ..actually, not quite In_sync. Need a
141 * bitmap-based recovery to get fully in sync
142 */
NeilBrown2d78f8c2011-12-23 10:17:51 +1100143 WriteMostly, /* Avoid reading if at all possible */
144 AutoDetected, /* added by auto-detect */
145 Blocked, /* An error occurred but has not yet
146 * been acknowledged by the metadata
147 * handler, so don't allow writes
148 * until it is cleared */
149 WriteErrorSeen, /* A write error has been seen on this
150 * device
151 */
152 FaultRecorded, /* Intermediate state for clearing
153 * Blocked. The Fault is/will-be
154 * recorded in the metadata, but that
155 * metadata hasn't been stored safely
156 * on disk yet.
157 */
158 BlockedBadBlocks, /* A writer is blocked because they
159 * found an unacknowledged bad-block.
160 * This can safely be cleared at any
161 * time, and the writer will re-check.
162 * It may be set at any time, and at
163 * worst the writer will timeout and
164 * re-check. So setting it as
165 * accurately as possible is good, but
166 * not absolutely critical.
167 */
168 WantReplacement, /* This device is a candidate to be
169 * hot-replaced, either because it has
170 * reported some faults, or because
171 * of explicit request.
172 */
173 Replacement, /* This device is a replacement for
174 * a want_replacement device with same
175 * raid_disk number.
176 */
Goldwyn Rodrigues1aee41f2014-10-29 18:51:31 -0500177 Candidate, /* For clustered environments only:
178 * This device is seen locally but not
179 * by the whole cluster
180 */
Song Liubac624f2015-08-13 14:31:55 -0700181 Journal, /* This device is used as journal for
182 * raid-5/6.
183 * Usually, this device should be faster
184 * than other devices in the array
185 */
NeilBrown2d78f8c2011-12-23 10:17:51 +1100186};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187
NeilBrown2230dfe2011-07-28 11:31:46 +1000188#define BB_LEN_MASK (0x00000000000001FFULL)
189#define BB_OFFSET_MASK (0x7FFFFFFFFFFFFE00ULL)
190#define BB_ACK_MASK (0x8000000000000000ULL)
191#define BB_MAX_LEN 512
192#define BB_OFFSET(x) (((x) & BB_OFFSET_MASK) >> 9)
193#define BB_LEN(x) (((x) & BB_LEN_MASK) + 1)
194#define BB_ACK(x) (!!((x) & BB_ACK_MASK))
195#define BB_MAKE(a, l, ack) (((a)<<9) | ((l)-1) | ((u64)(!!(ack)) << 63))
196
197extern int md_is_badblock(struct badblocks *bb, sector_t s, int sectors,
198 sector_t *first_bad, int *bad_sectors);
NeilBrown3cb03002011-10-11 16:45:26 +1100199static inline int is_badblock(struct md_rdev *rdev, sector_t s, int sectors,
NeilBrown2230dfe2011-07-28 11:31:46 +1000200 sector_t *first_bad, int *bad_sectors)
201{
202 if (unlikely(rdev->badblocks.count)) {
203 int rv = md_is_badblock(&rdev->badblocks, rdev->data_offset + s,
204 sectors,
205 first_bad, bad_sectors);
206 if (rv)
207 *first_bad -= rdev->data_offset;
208 return rv;
209 }
210 return 0;
211}
NeilBrown3cb03002011-10-11 16:45:26 +1100212extern int rdev_set_badblocks(struct md_rdev *rdev, sector_t s, int sectors,
NeilBrownc6563a82012-05-21 09:27:00 +1000213 int is_new);
214extern int rdev_clear_badblocks(struct md_rdev *rdev, sector_t s, int sectors,
215 int is_new);
NeilBrown2230dfe2011-07-28 11:31:46 +1000216extern void md_ack_all_badblocks(struct badblocks *bb);
217
Goldwyn Rodriguesc4ce8672014-03-29 10:20:02 -0500218struct md_cluster_info;
219
NeilBrownfd01b882011-10-11 16:47:53 +1100220struct mddev {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221 void *private;
NeilBrown84fc4b52011-10-11 16:49:58 +1100222 struct md_personality *pers;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223 dev_t unit;
224 int md_minor;
NeilBrown7a0a5352013-08-27 16:28:23 +1000225 struct list_head disks;
NeilBrown850b2b42006-10-03 01:15:46 -0700226 unsigned long flags;
227#define MD_CHANGE_DEVS 0 /* Some device status has changed */
228#define MD_CHANGE_CLEAN 1 /* transition to or from 'clean' */
NeilBrown070dc6d2010-08-30 17:33:34 +1000229#define MD_CHANGE_PENDING 2 /* switch from 'clean' to 'active' in progress */
NeilBrown7a0a5352013-08-27 16:28:23 +1000230#define MD_UPDATE_SB_FLAGS (1 | 2 | 4) /* If these are set, md_update_sb needed */
Jonathan Brassow9c810752011-06-08 17:59:30 -0500231#define MD_ARRAY_FIRST_USE 3 /* First use of array, needs initialization */
NeilBrown260fa032013-08-27 16:44:13 +1000232#define MD_STILL_CLOSED 4 /* If set, then array has not been opened since
233 * md_ioctl checked on it.
234 */
Shaohua Libd18f642015-09-02 13:49:50 -0700235#define MD_JOURNAL_CLEAN 5 /* A raid with journal is already clean */
Song Liua97b7892015-10-08 21:54:09 -0700236#define MD_HAS_JOURNAL 6 /* The raid array has journal feature set */
NeilBrown850b2b42006-10-03 01:15:46 -0700237
NeilBrown409c57f2009-03-31 14:39:39 +1100238 int suspended;
239 atomic_t active_io;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240 int ro;
NeilBrownbb4f1e92010-08-08 21:18:03 +1000241 int sysfs_active; /* set when sysfs deletes
242 * are happening, so run/
243 * takeover/stop are not safe
244 */
NeilBrown7a0a5352013-08-27 16:28:23 +1000245 int ready; /* See when safe to pass
NeilBrown0ca69882011-01-14 09:14:33 +1100246 * IO requests down */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247 struct gendisk *gendisk;
248
NeilBrowneae17012005-11-08 21:39:23 -0800249 struct kobject kobj;
NeilBrownd3374822009-01-09 08:31:10 +1100250 int hold_active;
251#define UNTIL_IOCTL 1
NeilBrownefeb53c2009-01-09 08:31:10 +1100252#define UNTIL_STOP 2
NeilBrowneae17012005-11-08 21:39:23 -0800253
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254 /* Superblock information */
255 int major_version,
256 minor_version,
257 patch_version;
258 int persistent;
NeilBrownf72ffdd2014-09-30 14:23:59 +1000259 int external; /* metadata is
NeilBrowne6910632008-02-06 01:39:51 -0800260 * managed externally */
261 char metadata_type[17]; /* externally set*/
Andre Noll9d8f0362009-06-18 08:45:01 +1000262 int chunk_sectors;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263 time_t ctime, utime;
264 int level, layout;
NeilBrownd9d166c2006-01-06 00:20:51 -0800265 char clevel[16];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266 int raid_disks;
267 int max_disks;
NeilBrownf72ffdd2014-09-30 14:23:59 +1000268 sector_t dev_sectors; /* used size of
Andre Noll58c0fed2009-03-31 14:33:13 +1100269 * component devices */
Andre Nollf233ea52008-07-21 17:05:22 +1000270 sector_t array_sectors; /* exported array size */
Dan Williamsb522adc2009-03-31 15:00:31 +1100271 int external_size; /* size managed
272 * externally */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273 __u64 events;
NeilBrowna8707c02010-05-18 09:28:43 +1000274 /* If the last 'event' was simply a clean->dirty transition, and
275 * we didn't write it to the spares, then it is safe and simple
276 * to just decrement the event count on a dirty->clean transition.
277 * So we record that possibility here.
278 */
279 int can_decrease_events;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280
281 char uuid[16];
282
NeilBrownf6705572006-03-27 01:18:11 -0800283 /* If the array is being reshaped, we need to record the
284 * new shape and an indication of where we are up to.
285 * This is written to the superblock.
286 * If reshape_position is MaxSector, then no reshape is happening (yet).
287 */
288 sector_t reshape_position;
Andre Noll664e7c42009-06-18 08:45:27 +1000289 int delta_disks, new_level, new_layout;
290 int new_chunk_sectors;
NeilBrown2c810cd2012-05-21 09:27:00 +1000291 int reshape_backwards;
NeilBrownf6705572006-03-27 01:18:11 -0800292
NeilBrown2b8bf342011-10-11 16:48:23 +1100293 struct md_thread *thread; /* management thread */
294 struct md_thread *sync_thread; /* doing resync or reconstruct */
Jonathan Brassowc4a39552013-06-25 01:23:59 -0500295
296 /* 'last_sync_action' is initialized to "none". It is set when a
297 * sync operation (i.e "data-check", "requested-resync", "resync",
298 * "recovery", or "reshape") is started. It holds this value even
299 * when the sync thread is "frozen" (interrupted) or "idle" (stopped
300 * or finished). It is overwritten when a new sync operation is begun.
301 */
302 char *last_sync_action;
NeilBrownff4e8d92006-07-10 04:44:16 -0700303 sector_t curr_resync; /* last block scheduled */
NeilBrown97e4f422009-03-31 14:33:13 +1100304 /* As resync requests can complete out of order, we cannot easily track
305 * how much resync has been completed. So we occasionally pause until
306 * everything completes, then set curr_resync_completed to curr_resync.
307 * As such it may be well behind the real resync mark, but it is a value
308 * we are certain of.
309 */
310 sector_t curr_resync_completed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311 unsigned long resync_mark; /* a recent timestamp */
312 sector_t resync_mark_cnt;/* blocks written at resync_mark */
NeilBrownff4e8d92006-07-10 04:44:16 -0700313 sector_t curr_mark_cnt; /* blocks scheduled now */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314
315 sector_t resync_max_sectors; /* may be set by personality */
NeilBrown9d888832005-11-08 21:39:26 -0800316
Jianpeng Ma7f7583d2012-10-11 14:17:59 +1100317 atomic64_t resync_mismatches; /* count of sectors where
NeilBrown9d888832005-11-08 21:39:26 -0800318 * parity/replica mismatch found
319 */
NeilBrowne464eaf2006-03-27 01:18:14 -0800320
321 /* allow user-space to request suspension of IO to regions of the array */
322 sector_t suspend_lo;
323 sector_t suspend_hi;
NeilBrown88202a02006-01-06 00:21:36 -0800324 /* if zero, use the system-wide default */
325 int sync_speed_min;
326 int sync_speed_max;
327
Bernd Schubert90b08712008-05-23 13:04:38 -0700328 /* resync even though the same disks are shared among md-devices */
329 int parallel_resync;
330
NeilBrown6ff8d8ec2006-01-06 00:20:15 -0800331 int ok_start_degraded;
NeilBrownf72ffdd2014-09-30 14:23:59 +1000332 /* recovery/resync flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333 * NEEDED: we might need to start a resync/recover
334 * RUNNING: a thread is running, or about to be started
335 * SYNC: actually doing a resync, not a recovery
Neil Brown72a23c22008-06-28 08:31:41 +1000336 * RECOVER: doing recovery, or need to try it.
NeilBrowndfc70642008-05-23 13:04:39 -0700337 * INTR: resync needs to be aborted for some reason
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338 * DONE: thread is done and is waiting to be reaped
NeilBrown24dd4692005-11-08 21:39:26 -0800339 * REQUEST: user-space has requested a sync (used with SYNC)
Anand Gadiyar411c9402009-07-07 15:24:23 +0530340 * CHECK: user-space request for check-only, no repair
NeilBrownccfcc3c2006-03-27 01:18:09 -0800341 * RESHAPE: A reshape is happening
majianpeng0a19caa2012-11-19 19:57:34 +0800342 * ERROR: sync-action interrupted because io-error
NeilBrownccfcc3c2006-03-27 01:18:09 -0800343 *
344 * If neither SYNC or RESHAPE are set, then it is a recovery.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345 */
346#define MD_RECOVERY_RUNNING 0
347#define MD_RECOVERY_SYNC 1
Neil Brown72a23c22008-06-28 08:31:41 +1000348#define MD_RECOVERY_RECOVER 2
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349#define MD_RECOVERY_INTR 3
350#define MD_RECOVERY_DONE 4
351#define MD_RECOVERY_NEEDED 5
NeilBrown24dd4692005-11-08 21:39:26 -0800352#define MD_RECOVERY_REQUESTED 6
353#define MD_RECOVERY_CHECK 7
NeilBrownccfcc3c2006-03-27 01:18:09 -0800354#define MD_RECOVERY_RESHAPE 8
NeilBrown5fd6c1d2006-06-26 00:27:40 -0700355#define MD_RECOVERY_FROZEN 9
majianpeng0a19caa2012-11-19 19:57:34 +0800356#define MD_RECOVERY_ERROR 10
NeilBrown5fd6c1d2006-06-26 00:27:40 -0700357
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358 unsigned long recovery;
NeilBrown53890422011-07-27 11:00:36 +1000359 /* If a RAID personality determines that recovery (of a particular
360 * device) will fail due to a read error on the source device, it
361 * takes a copy of this number and does not attempt recovery again
362 * until this number changes.
363 */
364 int recovery_disabled;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365
366 int in_sync; /* know to not need resync */
NeilBrownc8c00a62009-08-10 12:50:52 +1000367 /* 'open_mutex' avoids races between 'md_open' and 'do_md_stop', so
368 * that we are never stopping an array while it is open.
369 * 'reconfig_mutex' protects all other reconfiguration.
370 * These locks are separate due to conflicting interactions
371 * with bdev->bd_mutex.
372 * Lock ordering is:
373 * reconfig_mutex -> bd_mutex : e.g. do_md_run -> revalidate_disk
374 * bd_mutex -> open_mutex: e.g. __blkdev_get -> md_open
375 */
376 struct mutex open_mutex;
NeilBrowndf5b89b2006-03-27 01:18:20 -0800377 struct mutex reconfig_mutex;
NeilBrownf2ea68c2008-07-21 17:05:25 +1000378 atomic_t active; /* general refcount */
379 atomic_t openers; /* number of active opens */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380
NeilBrownf0b4f7e2011-02-24 17:26:41 +1100381 int changed; /* True if we might need to
382 * reread partition info */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383 int degraded; /* whether md should consider
384 * adding a spare
385 */
386
387 atomic_t recovery_active; /* blocks scheduled, but not written */
388 wait_queue_head_t recovery_wait;
389 sector_t recovery_cp;
Neil Brown5e96ee62008-06-28 08:31:24 +1000390 sector_t resync_min; /* user requested sync
391 * starts here */
NeilBrownc6207272008-02-06 01:39:52 -0800392 sector_t resync_max; /* resync should pause
393 * when it gets here */
NeilBrown06d91a52005-06-21 17:17:12 -0700394
Tejun Heo324a56e2013-12-11 14:11:53 -0500395 struct kernfs_node *sysfs_state; /* handle for 'array_state'
NeilBrownb62b7592008-10-21 13:25:21 +1100396 * file in sysfs.
397 */
Tejun Heo324a56e2013-12-11 14:11:53 -0500398 struct kernfs_node *sysfs_action; /* handle for 'sync_action' */
NeilBrownb62b7592008-10-21 13:25:21 +1100399
NeilBrownd3374822009-01-09 08:31:10 +1100400 struct work_struct del_work; /* used for delayed sysfs removal */
401
NeilBrown85572d72014-12-15 12:56:56 +1100402 /* "lock" protects:
403 * flush_bio transition from NULL to !NULL
404 * rdev superblocks, events
405 * clearing MD_CHANGE_*
406 * in_sync - and related safemode and MD_CHANGE changes
NeilBrown36d091f2014-12-15 12:56:58 +1100407 * pers (also protected by reconfig_mutex and pending IO).
NeilBrown978a7a42014-12-15 12:56:58 +1100408 * clearing ->bitmap
NeilBrown4af1a042014-12-15 12:57:00 +1100409 * clearing ->bitmap_info.file
NeilBrown23da4222014-12-15 12:57:01 +1100410 * changing ->resync_{min,max}
411 * setting MD_RECOVERY_RUNNING (which interacts with resync_{min,max})
NeilBrown85572d72014-12-15 12:56:56 +1100412 */
413 spinlock_t lock;
NeilBrown3d310eb2005-06-21 17:17:26 -0700414 wait_queue_head_t sb_wait; /* for waiting on superblock updates */
NeilBrown7bfa19f2005-06-21 17:17:28 -0700415 atomic_t pending_writes; /* number of active superblock writes */
NeilBrown06d91a52005-06-21 17:17:12 -0700416
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417 unsigned int safemode; /* if set, update "clean" superblock
418 * when no writes pending.
NeilBrownf72ffdd2014-09-30 14:23:59 +1000419 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420 unsigned int safemode_delay;
421 struct timer_list safemode_timer;
NeilBrownf72ffdd2014-09-30 14:23:59 +1000422 atomic_t writes_pending;
Jens Axboe165125e2007-07-24 09:28:11 +0200423 struct request_queue *queue; /* for plugging ... */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424
NeilBrownf72ffdd2014-09-30 14:23:59 +1000425 struct bitmap *bitmap; /* the bitmap for the device */
NeilBrownc3d97142009-12-14 12:49:52 +1100426 struct {
427 struct file *file; /* the bitmap file */
NeilBrownf6af9492009-12-14 12:49:54 +1100428 loff_t offset; /* offset from superblock of
NeilBrownc3d97142009-12-14 12:49:52 +1100429 * start of bitmap. May be
430 * negative, but not '0'
NeilBrownf6af9492009-12-14 12:49:54 +1100431 * For external metadata, offset
NeilBrownf72ffdd2014-09-30 14:23:59 +1000432 * from start of device.
NeilBrownc3d97142009-12-14 12:49:52 +1100433 */
NeilBrown6409bb02012-05-22 13:55:07 +1000434 unsigned long space; /* space available at this offset */
NeilBrownf6af9492009-12-14 12:49:54 +1100435 loff_t default_offset; /* this is the offset to use when
NeilBrownc3d97142009-12-14 12:49:52 +1100436 * hot-adding a bitmap. It should
437 * eventually be settable by sysfs.
438 */
NeilBrown6409bb02012-05-22 13:55:07 +1000439 unsigned long default_space; /* space available at
440 * default offset */
NeilBrownc3d97142009-12-14 12:49:52 +1100441 struct mutex mutex;
NeilBrown42a04b52009-12-14 12:49:53 +1100442 unsigned long chunksize;
NeilBrownac2f40b2010-06-01 19:37:31 +1000443 unsigned long daemon_sleep; /* how many jiffies between updates? */
NeilBrown42a04b52009-12-14 12:49:53 +1100444 unsigned long max_write_behind; /* write-behind mode */
NeilBrownece5cff2009-12-14 12:49:56 +1100445 int external;
Goldwyn Rodriguesc4ce8672014-03-29 10:20:02 -0500446 int nodes; /* Maximum number of nodes in the cluster */
Goldwyn Rodriguescf921cc2014-03-30 00:42:49 -0500447 char cluster_name[64]; /* Name of the cluster */
NeilBrownc3d97142009-12-14 12:49:52 +1100448 } bitmap_info;
NeilBrown32a76272005-06-21 17:17:14 -0700449
NeilBrownf72ffdd2014-09-30 14:23:59 +1000450 atomic_t max_corr_read_errors; /* max read retries */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451 struct list_head all_mddevs;
NeilBrowna2826aa2009-12-14 12:49:49 +1100452
NeilBrowna64c8762010-04-14 17:15:37 +1000453 struct attribute_group *to_remove;
NeilBrown252ac522010-06-01 19:37:29 +1000454
NeilBrowna167f662010-10-26 18:31:13 +1100455 struct bio_set *bio_set;
456
Tejun Heoe9c74692010-09-03 11:56:18 +0200457 /* Generic flush handling.
458 * The last to finish preflush schedules a worker to submit
459 * the rest of the request (without the REQ_FLUSH flag).
NeilBrowna2826aa2009-12-14 12:49:49 +1100460 */
Tejun Heoe9c74692010-09-03 11:56:18 +0200461 struct bio *flush_bio;
NeilBrowna2826aa2009-12-14 12:49:49 +1100462 atomic_t flush_pending;
Tejun Heoe9c74692010-09-03 11:56:18 +0200463 struct work_struct flush_work;
NeilBrown768a4182010-07-26 11:49:55 +1000464 struct work_struct event_work; /* used by dm to report failure event */
NeilBrownfd01b882011-10-11 16:47:53 +1100465 void (*sync_super)(struct mddev *mddev, struct md_rdev *rdev);
Goldwyn Rodriguesc4ce8672014-03-29 10:20:02 -0500466 struct md_cluster_info *cluster_info;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467};
468
NeilBrown5c47daf2014-12-15 12:57:01 +1100469static inline int __must_check mddev_lock(struct mddev *mddev)
470{
471 return mutex_lock_interruptible(&mddev->reconfig_mutex);
472}
473
474/* Sometimes we need to take the lock in a situation where
475 * failure due to interrupts is not acceptable.
476 */
477static inline void mddev_lock_nointr(struct mddev *mddev)
478{
479 mutex_lock(&mddev->reconfig_mutex);
480}
481
482static inline int mddev_is_locked(struct mddev *mddev)
483{
484 return mutex_is_locked(&mddev->reconfig_mutex);
485}
486
487static inline int mddev_trylock(struct mddev *mddev)
488{
489 return mutex_trylock(&mddev->reconfig_mutex);
490}
491extern void mddev_unlock(struct mddev *mddev);
492
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493static inline void md_sync_acct(struct block_device *bdev, unsigned long nr_sectors)
494{
NeilBrownf72ffdd2014-09-30 14:23:59 +1000495 atomic_add(nr_sectors, &bdev->bd_contains->bd_disk->sync_io);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496}
497
NeilBrown84fc4b52011-10-11 16:49:58 +1100498struct md_personality
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499{
500 char *name;
NeilBrown2604b702006-01-06 00:20:36 -0800501 int level;
502 struct list_head list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503 struct module *owner;
Linus Torvaldsb4fdcb02011-11-04 17:06:58 -0700504 void (*make_request)(struct mddev *mddev, struct bio *bio);
NeilBrownfd01b882011-10-11 16:47:53 +1100505 int (*run)(struct mddev *mddev);
NeilBrownafa0f552014-12-15 12:56:58 +1100506 void (*free)(struct mddev *mddev, void *priv);
NeilBrownfd01b882011-10-11 16:47:53 +1100507 void (*status)(struct seq_file *seq, struct mddev *mddev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508 /* error_handler must set ->faulty and clear ->in_sync
NeilBrownf72ffdd2014-09-30 14:23:59 +1000509 * if appropriate, and should abort recovery if needed
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510 */
NeilBrownfd01b882011-10-11 16:47:53 +1100511 void (*error_handler)(struct mddev *mddev, struct md_rdev *rdev);
512 int (*hot_add_disk) (struct mddev *mddev, struct md_rdev *rdev);
NeilBrownb8321b62011-12-23 10:17:51 +1100513 int (*hot_remove_disk) (struct mddev *mddev, struct md_rdev *rdev);
NeilBrownfd01b882011-10-11 16:47:53 +1100514 int (*spare_active) (struct mddev *mddev);
NeilBrown09314792015-02-19 16:04:40 +1100515 sector_t (*sync_request)(struct mddev *mddev, sector_t sector_nr, int *skipped);
NeilBrownfd01b882011-10-11 16:47:53 +1100516 int (*resize) (struct mddev *mddev, sector_t sectors);
517 sector_t (*size) (struct mddev *mddev, sector_t sectors, int raid_disks);
518 int (*check_reshape) (struct mddev *mddev);
519 int (*start_reshape) (struct mddev *mddev);
520 void (*finish_reshape) (struct mddev *mddev);
NeilBrown36fa3062005-09-09 16:23:45 -0700521 /* quiesce moves between quiescence states
522 * 0 - fully active
523 * 1 - no new requests allowed
524 * others - reserved
525 */
NeilBrownfd01b882011-10-11 16:47:53 +1100526 void (*quiesce) (struct mddev *mddev, int state);
NeilBrown245f46c2009-03-31 14:39:39 +1100527 /* takeover is used to transition an array from one
528 * personality to another. The new personality must be able
529 * to handle the data in the current layout.
530 * e.g. 2drive raid1 -> 2drive raid5
531 * ndrive raid5 -> degraded n+1drive raid6 with special layout
532 * If the takeover succeeds, a new 'private' structure is returned.
533 * This needs to be installed and then ->run used to activate the
534 * array.
535 */
NeilBrownfd01b882011-10-11 16:47:53 +1100536 void *(*takeover) (struct mddev *mddev);
NeilBrown5c675f82014-12-15 12:56:56 +1100537 /* congested implements bdi.congested_fn().
538 * Will not be called while array is 'suspended' */
539 int (*congested)(struct mddev *mddev, int bits);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540};
541
NeilBrown007583c2005-11-08 21:39:30 -0800542struct md_sysfs_entry {
543 struct attribute attr;
NeilBrownfd01b882011-10-11 16:47:53 +1100544 ssize_t (*show)(struct mddev *, char *);
545 ssize_t (*store)(struct mddev *, const char *, size_t);
NeilBrown007583c2005-11-08 21:39:30 -0800546};
NeilBrown43a70502009-12-14 12:49:55 +1100547extern struct attribute_group md_bitmap_group;
NeilBrown007583c2005-11-08 21:39:30 -0800548
Tejun Heo324a56e2013-12-11 14:11:53 -0500549static inline struct kernfs_node *sysfs_get_dirent_safe(struct kernfs_node *sd, char *name)
NeilBrown00bcb4a2010-06-01 19:37:23 +1000550{
551 if (sd)
Tejun Heo388975c2013-09-11 23:19:13 -0400552 return sysfs_get_dirent(sd, name);
NeilBrown00bcb4a2010-06-01 19:37:23 +1000553 return sd;
554}
Tejun Heo324a56e2013-12-11 14:11:53 -0500555static inline void sysfs_notify_dirent_safe(struct kernfs_node *sd)
NeilBrown00bcb4a2010-06-01 19:37:23 +1000556{
557 if (sd)
558 sysfs_notify_dirent(sd);
559}
560
NeilBrownfd01b882011-10-11 16:47:53 +1100561static inline char * mdname (struct mddev * mddev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562{
563 return mddev->gendisk ? mddev->gendisk->disk_name : "mdX";
564}
565
NeilBrownfd01b882011-10-11 16:47:53 +1100566static inline int sysfs_link_rdev(struct mddev *mddev, struct md_rdev *rdev)
Namhyung Kim36fad852011-07-27 11:00:36 +1000567{
568 char nm[20];
Jonathan Brassow90584fc2013-03-07 16:24:26 -0600569 if (!test_bit(Replacement, &rdev->flags) && mddev->kobj.sd) {
NeilBrown2d78f8c2011-12-23 10:17:51 +1100570 sprintf(nm, "rd%d", rdev->raid_disk);
571 return sysfs_create_link(&mddev->kobj, &rdev->kobj, nm);
572 } else
573 return 0;
Namhyung Kim36fad852011-07-27 11:00:36 +1000574}
575
NeilBrownfd01b882011-10-11 16:47:53 +1100576static inline void sysfs_unlink_rdev(struct mddev *mddev, struct md_rdev *rdev)
Namhyung Kim36fad852011-07-27 11:00:36 +1000577{
578 char nm[20];
Jonathan Brassow90584fc2013-03-07 16:24:26 -0600579 if (!test_bit(Replacement, &rdev->flags) && mddev->kobj.sd) {
NeilBrown2d78f8c2011-12-23 10:17:51 +1100580 sprintf(nm, "rd%d", rdev->raid_disk);
581 sysfs_remove_link(&mddev->kobj, nm);
582 }
Namhyung Kim36fad852011-07-27 11:00:36 +1000583}
584
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585/*
586 * iterates through some rdev ringlist. It's safe to remove the
587 * current 'rdev'. Dont touch 'tmp' though.
588 */
Cheng Renquan159ec1f2009-01-09 08:31:08 +1100589#define rdev_for_each_list(rdev, tmp, head) \
590 list_for_each_entry_safe(rdev, tmp, head, same_set)
591
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592/*
593 * iterates through the 'same array disks' ringlist
594 */
NeilBrowndafb20f2012-03-19 12:46:39 +1100595#define rdev_for_each(rdev, mddev) \
596 list_for_each_entry(rdev, &((mddev)->disks), same_set)
597
598#define rdev_for_each_safe(rdev, tmp, mddev) \
Cheng Renquan159ec1f2009-01-09 08:31:08 +1100599 list_for_each_entry_safe(rdev, tmp, &((mddev)->disks), same_set)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600
NeilBrown4b809912008-07-21 17:05:25 +1000601#define rdev_for_each_rcu(rdev, mddev) \
602 list_for_each_entry_rcu(rdev, &((mddev)->disks), same_set)
603
NeilBrown2b8bf342011-10-11 16:48:23 +1100604struct md_thread {
Shaohua Li4ed87312012-10-11 13:34:00 +1100605 void (*run) (struct md_thread *thread);
NeilBrownfd01b882011-10-11 16:47:53 +1100606 struct mddev *mddev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607 wait_queue_head_t wqueue;
NeilBrownf72ffdd2014-09-30 14:23:59 +1000608 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609 struct task_struct *tsk;
NeilBrown32a76272005-06-21 17:17:14 -0700610 unsigned long timeout;
Shaohua Li4ed87312012-10-11 13:34:00 +1100611 void *private;
NeilBrown2b8bf342011-10-11 16:48:23 +1100612};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613
614#define THREAD_WAKEUP 0
615
NeilBrown1345b1d2006-01-06 00:20:40 -0800616static inline void safe_put_page(struct page *p)
617{
618 if (p) put_page(p);
619}
620
NeilBrown84fc4b52011-10-11 16:49:58 +1100621extern int register_md_personality(struct md_personality *p);
622extern int unregister_md_personality(struct md_personality *p);
Goldwyn Rodriguesedb39c92014-03-29 10:01:53 -0500623extern int register_md_cluster_operations(struct md_cluster_operations *ops,
624 struct module *module);
625extern int unregister_md_cluster_operations(void);
626extern int md_setup_cluster(struct mddev *mddev, int nodes);
627extern void md_cluster_stop(struct mddev *mddev);
NeilBrown2b8bf342011-10-11 16:48:23 +1100628extern struct md_thread *md_register_thread(
Shaohua Li4ed87312012-10-11 13:34:00 +1100629 void (*run)(struct md_thread *thread),
NeilBrown2b8bf342011-10-11 16:48:23 +1100630 struct mddev *mddev,
631 const char *name);
632extern void md_unregister_thread(struct md_thread **threadp);
633extern void md_wakeup_thread(struct md_thread *thread);
NeilBrownfd01b882011-10-11 16:47:53 +1100634extern void md_check_recovery(struct mddev *mddev);
Jonathan Brassowa91d5ac2013-04-24 11:42:43 +1000635extern void md_reap_sync_thread(struct mddev *mddev);
NeilBrownfd01b882011-10-11 16:47:53 +1100636extern void md_write_start(struct mddev *mddev, struct bio *bi);
637extern void md_write_end(struct mddev *mddev);
638extern void md_done_sync(struct mddev *mddev, int blocks, int ok);
639extern void md_error(struct mddev *mddev, struct md_rdev *rdev);
NeilBrownc6563a82012-05-21 09:27:00 +1000640extern void md_finish_reshape(struct mddev *mddev);
NeilBrown92022952009-03-31 14:33:13 +1100641
NeilBrownfd01b882011-10-11 16:47:53 +1100642extern int mddev_congested(struct mddev *mddev, int bits);
643extern void md_flush_request(struct mddev *mddev, struct bio *bio);
644extern void md_super_write(struct mddev *mddev, struct md_rdev *rdev,
NeilBrown92022952009-03-31 14:33:13 +1100645 sector_t sector, int size, struct page *page);
NeilBrownfd01b882011-10-11 16:47:53 +1100646extern void md_super_wait(struct mddev *mddev);
NeilBrownf72ffdd2014-09-30 14:23:59 +1000647extern int sync_page_io(struct md_rdev *rdev, sector_t sector, int size,
Jonathan Brassowccebd4c2011-01-14 09:14:33 +1100648 struct page *page, int rw, bool metadata_op);
Shaohua Li4ed87312012-10-11 13:34:00 +1100649extern void md_do_sync(struct md_thread *thread);
NeilBrownfd01b882011-10-11 16:47:53 +1100650extern void md_new_event(struct mddev *mddev);
651extern int md_allow_write(struct mddev *mddev);
652extern void md_wait_for_blocked_rdev(struct md_rdev *rdev, struct mddev *mddev);
653extern void md_set_array_sectors(struct mddev *mddev, sector_t array_sectors);
654extern int md_check_no_bitmap(struct mddev *mddev);
655extern int md_integrity_register(struct mddev *mddev);
656extern void md_integrity_add_rdev(struct md_rdev *rdev, struct mddev *mddev);
NeilBrown72e02072009-12-14 12:49:55 +1100657extern int strict_strtoul_scaled(const char *cp, unsigned long *res, int scale);
Christoph Hellwig63fe0812009-04-14 12:01:53 +1000658
NeilBrownfd01b882011-10-11 16:47:53 +1100659extern void mddev_init(struct mddev *mddev);
660extern int md_run(struct mddev *mddev);
661extern void md_stop(struct mddev *mddev);
662extern void md_stop_writes(struct mddev *mddev);
NeilBrown3cb03002011-10-11 16:45:26 +1100663extern int md_rdev_init(struct md_rdev *rdev);
NeilBrown545c8792012-05-22 13:54:30 +1000664extern void md_rdev_clear(struct md_rdev *rdev);
NeilBrown390ee602010-06-01 19:37:27 +1000665
NeilBrownfd01b882011-10-11 16:47:53 +1100666extern void mddev_suspend(struct mddev *mddev);
667extern void mddev_resume(struct mddev *mddev);
NeilBrowna167f662010-10-26 18:31:13 +1100668extern struct bio *bio_clone_mddev(struct bio *bio, gfp_t gfp_mask,
NeilBrownfd01b882011-10-11 16:47:53 +1100669 struct mddev *mddev);
NeilBrowna167f662010-10-26 18:31:13 +1100670extern struct bio *bio_alloc_mddev(gfp_t gfp_mask, int nr_iovecs,
NeilBrownfd01b882011-10-11 16:47:53 +1100671 struct mddev *mddev);
NeilBrown9cbb1752012-07-31 09:08:14 +0200672
NeilBrown74018dc2012-07-31 09:08:15 +0200673extern void md_unplug(struct blk_plug_cb *cb, bool from_schedule);
Goldwyn Rodrigues70bcecd2015-08-21 10:33:39 -0500674extern void md_reload_sb(struct mddev *mddev, int raid_disk);
Goldwyn Rodrigues1aee41f2014-10-29 18:51:31 -0500675extern void md_update_sb(struct mddev *mddev, int force);
Goldwyn Rodriguesfb56dfe2015-04-14 10:43:24 -0500676extern void md_kick_rdev_from_array(struct md_rdev * rdev);
Goldwyn Rodrigues57d051d2015-04-14 10:43:55 -0500677struct md_rdev *md_find_rdev_nr_rcu(struct mddev *mddev, int nr);
NeilBrown9cbb1752012-07-31 09:08:14 +0200678static inline int mddev_check_plugged(struct mddev *mddev)
679{
680 return !!blk_check_plugged(md_unplug, mddev,
681 sizeof(struct blk_plug_cb));
682}
Hannes Reineckedfe15ac2012-07-26 11:12:18 +0200683
684static inline void rdev_dec_pending(struct md_rdev *rdev, struct mddev *mddev)
685{
686 int faulty = test_bit(Faulty, &rdev->flags);
687 if (atomic_dec_and_test(&rdev->nr_pending) && faulty) {
688 set_bit(MD_RECOVERY_NEEDED, &mddev->recovery);
689 md_wakeup_thread(mddev->thread);
690 }
691}
692
Goldwyn Rodriguesedb39c92014-03-29 10:01:53 -0500693extern struct md_cluster_operations *md_cluster_ops;
Goldwyn Rodriguesc4ce8672014-03-29 10:20:02 -0500694static inline int mddev_is_clustered(struct mddev *mddev)
695{
696 return mddev->cluster_info && mddev->bitmap_info.nodes > 1;
697}
Christoph Hellwig63fe0812009-04-14 12:01:53 +1000698#endif /* _MD_MD_H */