blob: 81e568090d8ff427535d411516df1b73b52cd6ae [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>
19#include <linux/kobject.h>
20#include <linux/list.h>
21#include <linux/mm.h>
22#include <linux/mutex.h>
23#include <linux/timer.h>
24#include <linux/wait.h>
25#include <linux/workqueue.h>
Goldwyn Rodriguesedb39c92014-03-29 10:01:53 -050026#include "md-cluster.h"
David Howells93614012006-09-30 20:45:40 +020027
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#define MaxSector (~(sector_t)0)
Linus Torvalds1da177e2005-04-16 15:20:36 -070029
NeilBrown2230dfe2011-07-28 11:31:46 +100030/* Bad block numbers are stored sorted in a single page.
31 * 64bits is used for each block or extent.
32 * 54 bits are sector number, 9 bits are extent size,
33 * 1 bit is an 'acknowledged' flag.
34 */
35#define MD_MAX_BADBLOCKS (PAGE_SIZE/8)
36
Linus Torvalds1da177e2005-04-16 15:20:36 -070037/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070038 * MD's 'extended' device
39 */
NeilBrown3cb03002011-10-11 16:45:26 +110040struct md_rdev {
Linus Torvalds1da177e2005-04-16 15:20:36 -070041 struct list_head same_set; /* RAID devices within the same set */
42
Andre Nolldd8ac332009-03-31 14:33:13 +110043 sector_t sectors; /* Device size (in 512bytes sectors) */
NeilBrownfd01b882011-10-11 16:47:53 +110044 struct mddev *mddev; /* RAID array if running */
NeilBrowneea1bf32009-03-31 14:27:02 +110045 int last_events; /* IO event timestamp */
Linus Torvalds1da177e2005-04-16 15:20:36 -070046
Jonathan Brassowa6ff7e02011-01-14 09:14:34 +110047 /*
48 * If meta_bdev is non-NULL, it means that a separate device is
49 * being used to store the metadata (superblock/bitmap) which
50 * would otherwise be contained on the same device as the data (bdev).
51 */
52 struct block_device *meta_bdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -070053 struct block_device *bdev; /* block device handle */
54
NeilBrown2699b672011-07-28 11:31:47 +100055 struct page *sb_page, *bb_page;
Linus Torvalds1da177e2005-04-16 15:20:36 -070056 int sb_loaded;
NeilBrown42543762006-06-26 00:27:57 -070057 __u64 sb_events;
Linus Torvalds1da177e2005-04-16 15:20:36 -070058 sector_t data_offset; /* start of data in array */
NeilBrownc6563a82012-05-21 09:27:00 +100059 sector_t new_data_offset;/* only relevant while reshaping */
NeilBrownf72ffdd2014-09-30 14:23:59 +100060 sector_t sb_start; /* offset of the super block (in 512byte sectors) */
NeilBrown0002b272005-09-09 16:23:53 -070061 int sb_size; /* bytes in the superblock */
Linus Torvalds1da177e2005-04-16 15:20:36 -070062 int preferred_minor; /* autorun support */
63
NeilBrown86e6ffd2005-11-08 21:39:24 -080064 struct kobject kobj;
65
Linus Torvalds1da177e2005-04-16 15:20:36 -070066 /* A device can be in one of three states based on two flags:
67 * Not working: faulty==1 in_sync==0
68 * Fully working: faulty==0 in_sync==1
69 * Working, but not
70 * in sync with array
71 * faulty==0 in_sync==0
72 *
73 * It can never have faulty==1, in_sync==1
74 * This reduces the burden of testing multiple flags in many cases
75 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070076
NeilBrown2d78f8c2011-12-23 10:17:51 +110077 unsigned long flags; /* bit set of 'enum flag_bits' bits. */
Dan Williams6bfe0b42008-04-30 00:52:32 -070078 wait_queue_head_t blocked_wait;
NeilBrown8ddf9ef2005-09-09 16:23:45 -070079
Linus Torvalds1da177e2005-04-16 15:20:36 -070080 int desc_nr; /* descriptor index in the superblock */
81 int raid_disk; /* role of device in array */
NeilBrowne93f68a2010-06-15 09:36:03 +010082 int new_raid_disk; /* role that the device will have in
83 * the array after a level-change completes.
84 */
NeilBrown41158c72005-06-21 17:17:25 -070085 int saved_raid_disk; /* role that device used to have in the
86 * array and could again if we did a partial
87 * resync from the bitmap
88 */
NeilBrown5fd6c1d2006-06-26 00:27:40 -070089 sector_t recovery_offset;/* If this device has been partially
90 * recovered, this is where we were
91 * up to.
92 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070093
94 atomic_t nr_pending; /* number of pending requests.
95 * only maintained for arrays that
96 * support hot removal
97 */
NeilBrownba22dcb2005-11-08 21:39:31 -080098 atomic_t read_errors; /* number of consecutive read errors that
99 * we have tried to ignore.
100 */
Robert Becker1e509152009-12-14 12:49:58 +1100101 struct timespec last_read_error; /* monotonic time since our
102 * last read error
103 */
NeilBrown4dbcdc72006-01-06 00:20:52 -0800104 atomic_t corrected_errors; /* number of corrected read errors,
105 * for reporting to userspace and storing
106 * in superblock.
107 */
NeilBrown5792a282007-04-04 19:08:18 -0700108 struct work_struct del_work; /* used for delayed sysfs removal */
NeilBrown3c0ee632008-10-21 13:25:28 +1100109
Tejun Heo324a56e2013-12-11 14:11:53 -0500110 struct kernfs_node *sysfs_state; /* handle for 'state'
NeilBrown3c0ee632008-10-21 13:25:28 +1100111 * sysfs entry */
NeilBrown2230dfe2011-07-28 11:31:46 +1000112
113 struct badblocks {
114 int count; /* count of bad blocks */
NeilBrownde393cd2011-07-28 11:31:48 +1000115 int unacked_exist; /* there probably are unacknowledged
116 * bad blocks. This is only cleared
117 * when a read discovers none
118 */
NeilBrown2230dfe2011-07-28 11:31:46 +1000119 int shift; /* shift from sectors to block size
120 * a -ve shift means badblocks are
121 * disabled.*/
122 u64 *page; /* badblock list */
123 int changed;
124 seqlock_t lock;
NeilBrown2699b672011-07-28 11:31:47 +1000125
126 sector_t sector;
127 sector_t size; /* in sectors */
NeilBrown2230dfe2011-07-28 11:31:46 +1000128 } badblocks;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129};
NeilBrown2d78f8c2011-12-23 10:17:51 +1100130enum flag_bits {
131 Faulty, /* device is known to have a fault */
132 In_sync, /* device is in_sync with rest of array */
NeilBrown8313b8e2013-12-12 10:13:33 +1100133 Bitmap_sync, /* ..actually, not quite In_sync. Need a
134 * bitmap-based recovery to get fully in sync
135 */
NeilBrown050b6612012-03-19 12:46:39 +1100136 Unmerged, /* device is being added to array and should
137 * be considerred for bvec_merge_fn but not
138 * yet for actual IO
139 */
NeilBrown2d78f8c2011-12-23 10:17:51 +1100140 WriteMostly, /* Avoid reading if at all possible */
141 AutoDetected, /* added by auto-detect */
142 Blocked, /* An error occurred but has not yet
143 * been acknowledged by the metadata
144 * handler, so don't allow writes
145 * until it is cleared */
146 WriteErrorSeen, /* A write error has been seen on this
147 * device
148 */
149 FaultRecorded, /* Intermediate state for clearing
150 * Blocked. The Fault is/will-be
151 * recorded in the metadata, but that
152 * metadata hasn't been stored safely
153 * on disk yet.
154 */
155 BlockedBadBlocks, /* A writer is blocked because they
156 * found an unacknowledged bad-block.
157 * This can safely be cleared at any
158 * time, and the writer will re-check.
159 * It may be set at any time, and at
160 * worst the writer will timeout and
161 * re-check. So setting it as
162 * accurately as possible is good, but
163 * not absolutely critical.
164 */
165 WantReplacement, /* This device is a candidate to be
166 * hot-replaced, either because it has
167 * reported some faults, or because
168 * of explicit request.
169 */
170 Replacement, /* This device is a replacement for
171 * a want_replacement device with same
172 * raid_disk number.
173 */
174};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175
NeilBrown2230dfe2011-07-28 11:31:46 +1000176#define BB_LEN_MASK (0x00000000000001FFULL)
177#define BB_OFFSET_MASK (0x7FFFFFFFFFFFFE00ULL)
178#define BB_ACK_MASK (0x8000000000000000ULL)
179#define BB_MAX_LEN 512
180#define BB_OFFSET(x) (((x) & BB_OFFSET_MASK) >> 9)
181#define BB_LEN(x) (((x) & BB_LEN_MASK) + 1)
182#define BB_ACK(x) (!!((x) & BB_ACK_MASK))
183#define BB_MAKE(a, l, ack) (((a)<<9) | ((l)-1) | ((u64)(!!(ack)) << 63))
184
185extern int md_is_badblock(struct badblocks *bb, sector_t s, int sectors,
186 sector_t *first_bad, int *bad_sectors);
NeilBrown3cb03002011-10-11 16:45:26 +1100187static inline int is_badblock(struct md_rdev *rdev, sector_t s, int sectors,
NeilBrown2230dfe2011-07-28 11:31:46 +1000188 sector_t *first_bad, int *bad_sectors)
189{
190 if (unlikely(rdev->badblocks.count)) {
191 int rv = md_is_badblock(&rdev->badblocks, rdev->data_offset + s,
192 sectors,
193 first_bad, bad_sectors);
194 if (rv)
195 *first_bad -= rdev->data_offset;
196 return rv;
197 }
198 return 0;
199}
NeilBrown3cb03002011-10-11 16:45:26 +1100200extern int rdev_set_badblocks(struct md_rdev *rdev, sector_t s, int sectors,
NeilBrownc6563a82012-05-21 09:27:00 +1000201 int is_new);
202extern int rdev_clear_badblocks(struct md_rdev *rdev, sector_t s, int sectors,
203 int is_new);
NeilBrown2230dfe2011-07-28 11:31:46 +1000204extern void md_ack_all_badblocks(struct badblocks *bb);
205
Goldwyn Rodriguesc4ce8672014-03-29 10:20:02 -0500206struct md_cluster_info;
207
NeilBrownfd01b882011-10-11 16:47:53 +1100208struct mddev {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209 void *private;
NeilBrown84fc4b52011-10-11 16:49:58 +1100210 struct md_personality *pers;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211 dev_t unit;
212 int md_minor;
NeilBrown7a0a5352013-08-27 16:28:23 +1000213 struct list_head disks;
NeilBrown850b2b42006-10-03 01:15:46 -0700214 unsigned long flags;
215#define MD_CHANGE_DEVS 0 /* Some device status has changed */
216#define MD_CHANGE_CLEAN 1 /* transition to or from 'clean' */
NeilBrown070dc6d2010-08-30 17:33:34 +1000217#define MD_CHANGE_PENDING 2 /* switch from 'clean' to 'active' in progress */
NeilBrown7a0a5352013-08-27 16:28:23 +1000218#define MD_UPDATE_SB_FLAGS (1 | 2 | 4) /* If these are set, md_update_sb needed */
Jonathan Brassow9c810752011-06-08 17:59:30 -0500219#define MD_ARRAY_FIRST_USE 3 /* First use of array, needs initialization */
NeilBrown260fa032013-08-27 16:44:13 +1000220#define MD_STILL_CLOSED 4 /* If set, then array has not been opened since
221 * md_ioctl checked on it.
222 */
NeilBrown850b2b42006-10-03 01:15:46 -0700223
NeilBrown409c57f2009-03-31 14:39:39 +1100224 int suspended;
225 atomic_t active_io;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226 int ro;
NeilBrownbb4f1e92010-08-08 21:18:03 +1000227 int sysfs_active; /* set when sysfs deletes
228 * are happening, so run/
229 * takeover/stop are not safe
230 */
NeilBrown7a0a5352013-08-27 16:28:23 +1000231 int ready; /* See when safe to pass
NeilBrown0ca69882011-01-14 09:14:33 +1100232 * IO requests down */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233 struct gendisk *gendisk;
234
NeilBrowneae17012005-11-08 21:39:23 -0800235 struct kobject kobj;
NeilBrownd3374822009-01-09 08:31:10 +1100236 int hold_active;
237#define UNTIL_IOCTL 1
NeilBrownefeb53c2009-01-09 08:31:10 +1100238#define UNTIL_STOP 2
NeilBrowneae17012005-11-08 21:39:23 -0800239
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240 /* Superblock information */
241 int major_version,
242 minor_version,
243 patch_version;
244 int persistent;
NeilBrownf72ffdd2014-09-30 14:23:59 +1000245 int external; /* metadata is
NeilBrowne6910632008-02-06 01:39:51 -0800246 * managed externally */
247 char metadata_type[17]; /* externally set*/
Andre Noll9d8f0362009-06-18 08:45:01 +1000248 int chunk_sectors;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249 time_t ctime, utime;
250 int level, layout;
NeilBrownd9d166c2006-01-06 00:20:51 -0800251 char clevel[16];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252 int raid_disks;
253 int max_disks;
NeilBrownf72ffdd2014-09-30 14:23:59 +1000254 sector_t dev_sectors; /* used size of
Andre Noll58c0fed2009-03-31 14:33:13 +1100255 * component devices */
Andre Nollf233ea52008-07-21 17:05:22 +1000256 sector_t array_sectors; /* exported array size */
Dan Williamsb522adc2009-03-31 15:00:31 +1100257 int external_size; /* size managed
258 * externally */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259 __u64 events;
NeilBrowna8707c02010-05-18 09:28:43 +1000260 /* If the last 'event' was simply a clean->dirty transition, and
261 * we didn't write it to the spares, then it is safe and simple
262 * to just decrement the event count on a dirty->clean transition.
263 * So we record that possibility here.
264 */
265 int can_decrease_events;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266
267 char uuid[16];
268
NeilBrownf6705572006-03-27 01:18:11 -0800269 /* If the array is being reshaped, we need to record the
270 * new shape and an indication of where we are up to.
271 * This is written to the superblock.
272 * If reshape_position is MaxSector, then no reshape is happening (yet).
273 */
274 sector_t reshape_position;
Andre Noll664e7c42009-06-18 08:45:27 +1000275 int delta_disks, new_level, new_layout;
276 int new_chunk_sectors;
NeilBrown2c810cd2012-05-21 09:27:00 +1000277 int reshape_backwards;
NeilBrownf6705572006-03-27 01:18:11 -0800278
NeilBrown2b8bf342011-10-11 16:48:23 +1100279 struct md_thread *thread; /* management thread */
280 struct md_thread *sync_thread; /* doing resync or reconstruct */
Jonathan Brassowc4a39552013-06-25 01:23:59 -0500281
282 /* 'last_sync_action' is initialized to "none". It is set when a
283 * sync operation (i.e "data-check", "requested-resync", "resync",
284 * "recovery", or "reshape") is started. It holds this value even
285 * when the sync thread is "frozen" (interrupted) or "idle" (stopped
286 * or finished). It is overwritten when a new sync operation is begun.
287 */
288 char *last_sync_action;
NeilBrownff4e8d92006-07-10 04:44:16 -0700289 sector_t curr_resync; /* last block scheduled */
NeilBrown97e4f422009-03-31 14:33:13 +1100290 /* As resync requests can complete out of order, we cannot easily track
291 * how much resync has been completed. So we occasionally pause until
292 * everything completes, then set curr_resync_completed to curr_resync.
293 * As such it may be well behind the real resync mark, but it is a value
294 * we are certain of.
295 */
296 sector_t curr_resync_completed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297 unsigned long resync_mark; /* a recent timestamp */
298 sector_t resync_mark_cnt;/* blocks written at resync_mark */
NeilBrownff4e8d92006-07-10 04:44:16 -0700299 sector_t curr_mark_cnt; /* blocks scheduled now */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300
301 sector_t resync_max_sectors; /* may be set by personality */
NeilBrown9d888832005-11-08 21:39:26 -0800302
Jianpeng Ma7f7583d2012-10-11 14:17:59 +1100303 atomic64_t resync_mismatches; /* count of sectors where
NeilBrown9d888832005-11-08 21:39:26 -0800304 * parity/replica mismatch found
305 */
NeilBrowne464eaf2006-03-27 01:18:14 -0800306
307 /* allow user-space to request suspension of IO to regions of the array */
308 sector_t suspend_lo;
309 sector_t suspend_hi;
NeilBrown88202a02006-01-06 00:21:36 -0800310 /* if zero, use the system-wide default */
311 int sync_speed_min;
312 int sync_speed_max;
313
Bernd Schubert90b08712008-05-23 13:04:38 -0700314 /* resync even though the same disks are shared among md-devices */
315 int parallel_resync;
316
NeilBrown6ff8d8ec2006-01-06 00:20:15 -0800317 int ok_start_degraded;
NeilBrownf72ffdd2014-09-30 14:23:59 +1000318 /* recovery/resync flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319 * NEEDED: we might need to start a resync/recover
320 * RUNNING: a thread is running, or about to be started
321 * SYNC: actually doing a resync, not a recovery
Neil Brown72a23c22008-06-28 08:31:41 +1000322 * RECOVER: doing recovery, or need to try it.
NeilBrowndfc70642008-05-23 13:04:39 -0700323 * INTR: resync needs to be aborted for some reason
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324 * DONE: thread is done and is waiting to be reaped
NeilBrown24dd4692005-11-08 21:39:26 -0800325 * REQUEST: user-space has requested a sync (used with SYNC)
Anand Gadiyar411c9402009-07-07 15:24:23 +0530326 * CHECK: user-space request for check-only, no repair
NeilBrownccfcc3c2006-03-27 01:18:09 -0800327 * RESHAPE: A reshape is happening
majianpeng0a19caa2012-11-19 19:57:34 +0800328 * ERROR: sync-action interrupted because io-error
NeilBrownccfcc3c2006-03-27 01:18:09 -0800329 *
330 * If neither SYNC or RESHAPE are set, then it is a recovery.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331 */
332#define MD_RECOVERY_RUNNING 0
333#define MD_RECOVERY_SYNC 1
Neil Brown72a23c22008-06-28 08:31:41 +1000334#define MD_RECOVERY_RECOVER 2
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335#define MD_RECOVERY_INTR 3
336#define MD_RECOVERY_DONE 4
337#define MD_RECOVERY_NEEDED 5
NeilBrown24dd4692005-11-08 21:39:26 -0800338#define MD_RECOVERY_REQUESTED 6
339#define MD_RECOVERY_CHECK 7
NeilBrownccfcc3c2006-03-27 01:18:09 -0800340#define MD_RECOVERY_RESHAPE 8
NeilBrown5fd6c1d2006-06-26 00:27:40 -0700341#define MD_RECOVERY_FROZEN 9
majianpeng0a19caa2012-11-19 19:57:34 +0800342#define MD_RECOVERY_ERROR 10
NeilBrown5fd6c1d2006-06-26 00:27:40 -0700343
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344 unsigned long recovery;
NeilBrown53890422011-07-27 11:00:36 +1000345 /* If a RAID personality determines that recovery (of a particular
346 * device) will fail due to a read error on the source device, it
347 * takes a copy of this number and does not attempt recovery again
348 * until this number changes.
349 */
350 int recovery_disabled;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351
352 int in_sync; /* know to not need resync */
NeilBrownc8c00a62009-08-10 12:50:52 +1000353 /* 'open_mutex' avoids races between 'md_open' and 'do_md_stop', so
354 * that we are never stopping an array while it is open.
355 * 'reconfig_mutex' protects all other reconfiguration.
356 * These locks are separate due to conflicting interactions
357 * with bdev->bd_mutex.
358 * Lock ordering is:
359 * reconfig_mutex -> bd_mutex : e.g. do_md_run -> revalidate_disk
360 * bd_mutex -> open_mutex: e.g. __blkdev_get -> md_open
361 */
362 struct mutex open_mutex;
NeilBrowndf5b89b2006-03-27 01:18:20 -0800363 struct mutex reconfig_mutex;
NeilBrownf2ea68c2008-07-21 17:05:25 +1000364 atomic_t active; /* general refcount */
365 atomic_t openers; /* number of active opens */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366
NeilBrownf0b4f7e2011-02-24 17:26:41 +1100367 int changed; /* True if we might need to
368 * reread partition info */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369 int degraded; /* whether md should consider
370 * adding a spare
371 */
NeilBrown050b6612012-03-19 12:46:39 +1100372 int merge_check_needed; /* at least one
373 * member device
374 * has a
375 * merge_bvec_fn */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376
377 atomic_t recovery_active; /* blocks scheduled, but not written */
378 wait_queue_head_t recovery_wait;
379 sector_t recovery_cp;
Neil Brown5e96ee62008-06-28 08:31:24 +1000380 sector_t resync_min; /* user requested sync
381 * starts here */
NeilBrownc6207272008-02-06 01:39:52 -0800382 sector_t resync_max; /* resync should pause
383 * when it gets here */
NeilBrown06d91a52005-06-21 17:17:12 -0700384
Tejun Heo324a56e2013-12-11 14:11:53 -0500385 struct kernfs_node *sysfs_state; /* handle for 'array_state'
NeilBrownb62b7592008-10-21 13:25:21 +1100386 * file in sysfs.
387 */
Tejun Heo324a56e2013-12-11 14:11:53 -0500388 struct kernfs_node *sysfs_action; /* handle for 'sync_action' */
NeilBrownb62b7592008-10-21 13:25:21 +1100389
NeilBrownd3374822009-01-09 08:31:10 +1100390 struct work_struct del_work; /* used for delayed sysfs removal */
391
NeilBrown85572d72014-12-15 12:56:56 +1100392 /* "lock" protects:
393 * flush_bio transition from NULL to !NULL
394 * rdev superblocks, events
395 * clearing MD_CHANGE_*
396 * in_sync - and related safemode and MD_CHANGE changes
NeilBrown36d091f2014-12-15 12:56:58 +1100397 * pers (also protected by reconfig_mutex and pending IO).
NeilBrown978a7a42014-12-15 12:56:58 +1100398 * clearing ->bitmap
NeilBrown4af1a042014-12-15 12:57:00 +1100399 * clearing ->bitmap_info.file
NeilBrown23da4222014-12-15 12:57:01 +1100400 * changing ->resync_{min,max}
401 * setting MD_RECOVERY_RUNNING (which interacts with resync_{min,max})
NeilBrown85572d72014-12-15 12:56:56 +1100402 */
403 spinlock_t lock;
NeilBrown3d310eb2005-06-21 17:17:26 -0700404 wait_queue_head_t sb_wait; /* for waiting on superblock updates */
NeilBrown7bfa19f2005-06-21 17:17:28 -0700405 atomic_t pending_writes; /* number of active superblock writes */
NeilBrown06d91a52005-06-21 17:17:12 -0700406
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407 unsigned int safemode; /* if set, update "clean" superblock
408 * when no writes pending.
NeilBrownf72ffdd2014-09-30 14:23:59 +1000409 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410 unsigned int safemode_delay;
411 struct timer_list safemode_timer;
NeilBrownf72ffdd2014-09-30 14:23:59 +1000412 atomic_t writes_pending;
Jens Axboe165125e2007-07-24 09:28:11 +0200413 struct request_queue *queue; /* for plugging ... */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414
NeilBrownf72ffdd2014-09-30 14:23:59 +1000415 struct bitmap *bitmap; /* the bitmap for the device */
NeilBrownc3d97142009-12-14 12:49:52 +1100416 struct {
417 struct file *file; /* the bitmap file */
NeilBrownf6af9492009-12-14 12:49:54 +1100418 loff_t offset; /* offset from superblock of
NeilBrownc3d97142009-12-14 12:49:52 +1100419 * start of bitmap. May be
420 * negative, but not '0'
NeilBrownf6af9492009-12-14 12:49:54 +1100421 * For external metadata, offset
NeilBrownf72ffdd2014-09-30 14:23:59 +1000422 * from start of device.
NeilBrownc3d97142009-12-14 12:49:52 +1100423 */
NeilBrown6409bb02012-05-22 13:55:07 +1000424 unsigned long space; /* space available at this offset */
NeilBrownf6af9492009-12-14 12:49:54 +1100425 loff_t default_offset; /* this is the offset to use when
NeilBrownc3d97142009-12-14 12:49:52 +1100426 * hot-adding a bitmap. It should
427 * eventually be settable by sysfs.
428 */
NeilBrown6409bb02012-05-22 13:55:07 +1000429 unsigned long default_space; /* space available at
430 * default offset */
NeilBrownc3d97142009-12-14 12:49:52 +1100431 struct mutex mutex;
NeilBrown42a04b52009-12-14 12:49:53 +1100432 unsigned long chunksize;
NeilBrownac2f40b2010-06-01 19:37:31 +1000433 unsigned long daemon_sleep; /* how many jiffies between updates? */
NeilBrown42a04b52009-12-14 12:49:53 +1100434 unsigned long max_write_behind; /* write-behind mode */
NeilBrownece5cff2009-12-14 12:49:56 +1100435 int external;
Goldwyn Rodriguesc4ce8672014-03-29 10:20:02 -0500436 int nodes; /* Maximum number of nodes in the cluster */
Goldwyn Rodriguescf921cc2014-03-30 00:42:49 -0500437 char cluster_name[64]; /* Name of the cluster */
NeilBrownc3d97142009-12-14 12:49:52 +1100438 } bitmap_info;
NeilBrown32a76272005-06-21 17:17:14 -0700439
NeilBrownf72ffdd2014-09-30 14:23:59 +1000440 atomic_t max_corr_read_errors; /* max read retries */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441 struct list_head all_mddevs;
NeilBrowna2826aa2009-12-14 12:49:49 +1100442
NeilBrowna64c8762010-04-14 17:15:37 +1000443 struct attribute_group *to_remove;
NeilBrown252ac522010-06-01 19:37:29 +1000444
NeilBrowna167f662010-10-26 18:31:13 +1100445 struct bio_set *bio_set;
446
Tejun Heoe9c74692010-09-03 11:56:18 +0200447 /* Generic flush handling.
448 * The last to finish preflush schedules a worker to submit
449 * the rest of the request (without the REQ_FLUSH flag).
NeilBrowna2826aa2009-12-14 12:49:49 +1100450 */
Tejun Heoe9c74692010-09-03 11:56:18 +0200451 struct bio *flush_bio;
NeilBrowna2826aa2009-12-14 12:49:49 +1100452 atomic_t flush_pending;
Tejun Heoe9c74692010-09-03 11:56:18 +0200453 struct work_struct flush_work;
NeilBrown768a4182010-07-26 11:49:55 +1000454 struct work_struct event_work; /* used by dm to report failure event */
NeilBrownfd01b882011-10-11 16:47:53 +1100455 void (*sync_super)(struct mddev *mddev, struct md_rdev *rdev);
Goldwyn Rodriguesc4ce8672014-03-29 10:20:02 -0500456 struct md_cluster_info *cluster_info;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457};
458
NeilBrown5c47daf2014-12-15 12:57:01 +1100459static inline int __must_check mddev_lock(struct mddev *mddev)
460{
461 return mutex_lock_interruptible(&mddev->reconfig_mutex);
462}
463
464/* Sometimes we need to take the lock in a situation where
465 * failure due to interrupts is not acceptable.
466 */
467static inline void mddev_lock_nointr(struct mddev *mddev)
468{
469 mutex_lock(&mddev->reconfig_mutex);
470}
471
472static inline int mddev_is_locked(struct mddev *mddev)
473{
474 return mutex_is_locked(&mddev->reconfig_mutex);
475}
476
477static inline int mddev_trylock(struct mddev *mddev)
478{
479 return mutex_trylock(&mddev->reconfig_mutex);
480}
481extern void mddev_unlock(struct mddev *mddev);
482
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483static inline void md_sync_acct(struct block_device *bdev, unsigned long nr_sectors)
484{
NeilBrownf72ffdd2014-09-30 14:23:59 +1000485 atomic_add(nr_sectors, &bdev->bd_contains->bd_disk->sync_io);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486}
487
NeilBrown84fc4b52011-10-11 16:49:58 +1100488struct md_personality
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489{
490 char *name;
NeilBrown2604b702006-01-06 00:20:36 -0800491 int level;
492 struct list_head list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493 struct module *owner;
Linus Torvaldsb4fdcb02011-11-04 17:06:58 -0700494 void (*make_request)(struct mddev *mddev, struct bio *bio);
NeilBrownfd01b882011-10-11 16:47:53 +1100495 int (*run)(struct mddev *mddev);
NeilBrownafa0f552014-12-15 12:56:58 +1100496 void (*free)(struct mddev *mddev, void *priv);
NeilBrownfd01b882011-10-11 16:47:53 +1100497 void (*status)(struct seq_file *seq, struct mddev *mddev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498 /* error_handler must set ->faulty and clear ->in_sync
NeilBrownf72ffdd2014-09-30 14:23:59 +1000499 * if appropriate, and should abort recovery if needed
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500 */
NeilBrownfd01b882011-10-11 16:47:53 +1100501 void (*error_handler)(struct mddev *mddev, struct md_rdev *rdev);
502 int (*hot_add_disk) (struct mddev *mddev, struct md_rdev *rdev);
NeilBrownb8321b62011-12-23 10:17:51 +1100503 int (*hot_remove_disk) (struct mddev *mddev, struct md_rdev *rdev);
NeilBrownfd01b882011-10-11 16:47:53 +1100504 int (*spare_active) (struct mddev *mddev);
505 sector_t (*sync_request)(struct mddev *mddev, sector_t sector_nr, int *skipped, int go_faster);
506 int (*resize) (struct mddev *mddev, sector_t sectors);
507 sector_t (*size) (struct mddev *mddev, sector_t sectors, int raid_disks);
508 int (*check_reshape) (struct mddev *mddev);
509 int (*start_reshape) (struct mddev *mddev);
510 void (*finish_reshape) (struct mddev *mddev);
NeilBrown36fa3062005-09-09 16:23:45 -0700511 /* quiesce moves between quiescence states
512 * 0 - fully active
513 * 1 - no new requests allowed
514 * others - reserved
515 */
NeilBrownfd01b882011-10-11 16:47:53 +1100516 void (*quiesce) (struct mddev *mddev, int state);
NeilBrown245f46c2009-03-31 14:39:39 +1100517 /* takeover is used to transition an array from one
518 * personality to another. The new personality must be able
519 * to handle the data in the current layout.
520 * e.g. 2drive raid1 -> 2drive raid5
521 * ndrive raid5 -> degraded n+1drive raid6 with special layout
522 * If the takeover succeeds, a new 'private' structure is returned.
523 * This needs to be installed and then ->run used to activate the
524 * array.
525 */
NeilBrownfd01b882011-10-11 16:47:53 +1100526 void *(*takeover) (struct mddev *mddev);
NeilBrown5c675f82014-12-15 12:56:56 +1100527 /* congested implements bdi.congested_fn().
528 * Will not be called while array is 'suspended' */
529 int (*congested)(struct mddev *mddev, int bits);
NeilBrown64590f42014-12-15 12:56:57 +1100530 /* mergeable_bvec is use to implement ->merge_bvec_fn */
531 int (*mergeable_bvec)(struct mddev *mddev,
532 struct bvec_merge_data *bvm,
533 struct bio_vec *biovec);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534};
535
NeilBrown007583c2005-11-08 21:39:30 -0800536struct md_sysfs_entry {
537 struct attribute attr;
NeilBrownfd01b882011-10-11 16:47:53 +1100538 ssize_t (*show)(struct mddev *, char *);
539 ssize_t (*store)(struct mddev *, const char *, size_t);
NeilBrown007583c2005-11-08 21:39:30 -0800540};
NeilBrown43a70502009-12-14 12:49:55 +1100541extern struct attribute_group md_bitmap_group;
NeilBrown007583c2005-11-08 21:39:30 -0800542
Tejun Heo324a56e2013-12-11 14:11:53 -0500543static inline struct kernfs_node *sysfs_get_dirent_safe(struct kernfs_node *sd, char *name)
NeilBrown00bcb4a2010-06-01 19:37:23 +1000544{
545 if (sd)
Tejun Heo388975c2013-09-11 23:19:13 -0400546 return sysfs_get_dirent(sd, name);
NeilBrown00bcb4a2010-06-01 19:37:23 +1000547 return sd;
548}
Tejun Heo324a56e2013-12-11 14:11:53 -0500549static inline void sysfs_notify_dirent_safe(struct kernfs_node *sd)
NeilBrown00bcb4a2010-06-01 19:37:23 +1000550{
551 if (sd)
552 sysfs_notify_dirent(sd);
553}
554
NeilBrownfd01b882011-10-11 16:47:53 +1100555static inline char * mdname (struct mddev * mddev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556{
557 return mddev->gendisk ? mddev->gendisk->disk_name : "mdX";
558}
559
NeilBrownfd01b882011-10-11 16:47:53 +1100560static inline int sysfs_link_rdev(struct mddev *mddev, struct md_rdev *rdev)
Namhyung Kim36fad852011-07-27 11:00:36 +1000561{
562 char nm[20];
Jonathan Brassow90584fc2013-03-07 16:24:26 -0600563 if (!test_bit(Replacement, &rdev->flags) && mddev->kobj.sd) {
NeilBrown2d78f8c2011-12-23 10:17:51 +1100564 sprintf(nm, "rd%d", rdev->raid_disk);
565 return sysfs_create_link(&mddev->kobj, &rdev->kobj, nm);
566 } else
567 return 0;
Namhyung Kim36fad852011-07-27 11:00:36 +1000568}
569
NeilBrownfd01b882011-10-11 16:47:53 +1100570static inline void sysfs_unlink_rdev(struct mddev *mddev, struct md_rdev *rdev)
Namhyung Kim36fad852011-07-27 11:00:36 +1000571{
572 char nm[20];
Jonathan Brassow90584fc2013-03-07 16:24:26 -0600573 if (!test_bit(Replacement, &rdev->flags) && mddev->kobj.sd) {
NeilBrown2d78f8c2011-12-23 10:17:51 +1100574 sprintf(nm, "rd%d", rdev->raid_disk);
575 sysfs_remove_link(&mddev->kobj, nm);
576 }
Namhyung Kim36fad852011-07-27 11:00:36 +1000577}
578
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579/*
580 * iterates through some rdev ringlist. It's safe to remove the
581 * current 'rdev'. Dont touch 'tmp' though.
582 */
Cheng Renquan159ec1f2009-01-09 08:31:08 +1100583#define rdev_for_each_list(rdev, tmp, head) \
584 list_for_each_entry_safe(rdev, tmp, head, same_set)
585
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586/*
587 * iterates through the 'same array disks' ringlist
588 */
NeilBrowndafb20f2012-03-19 12:46:39 +1100589#define rdev_for_each(rdev, mddev) \
590 list_for_each_entry(rdev, &((mddev)->disks), same_set)
591
592#define rdev_for_each_safe(rdev, tmp, mddev) \
Cheng Renquan159ec1f2009-01-09 08:31:08 +1100593 list_for_each_entry_safe(rdev, tmp, &((mddev)->disks), same_set)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594
NeilBrown4b809912008-07-21 17:05:25 +1000595#define rdev_for_each_rcu(rdev, mddev) \
596 list_for_each_entry_rcu(rdev, &((mddev)->disks), same_set)
597
NeilBrown2b8bf342011-10-11 16:48:23 +1100598struct md_thread {
Shaohua Li4ed87312012-10-11 13:34:00 +1100599 void (*run) (struct md_thread *thread);
NeilBrownfd01b882011-10-11 16:47:53 +1100600 struct mddev *mddev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601 wait_queue_head_t wqueue;
NeilBrownf72ffdd2014-09-30 14:23:59 +1000602 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603 struct task_struct *tsk;
NeilBrown32a76272005-06-21 17:17:14 -0700604 unsigned long timeout;
Shaohua Li4ed87312012-10-11 13:34:00 +1100605 void *private;
NeilBrown2b8bf342011-10-11 16:48:23 +1100606};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607
608#define THREAD_WAKEUP 0
609
NeilBrown1345b1d2006-01-06 00:20:40 -0800610static inline void safe_put_page(struct page *p)
611{
612 if (p) put_page(p);
613}
614
NeilBrown84fc4b52011-10-11 16:49:58 +1100615extern int register_md_personality(struct md_personality *p);
616extern int unregister_md_personality(struct md_personality *p);
Goldwyn Rodriguesedb39c92014-03-29 10:01:53 -0500617extern int register_md_cluster_operations(struct md_cluster_operations *ops,
618 struct module *module);
619extern int unregister_md_cluster_operations(void);
620extern int md_setup_cluster(struct mddev *mddev, int nodes);
621extern void md_cluster_stop(struct mddev *mddev);
NeilBrown2b8bf342011-10-11 16:48:23 +1100622extern struct md_thread *md_register_thread(
Shaohua Li4ed87312012-10-11 13:34:00 +1100623 void (*run)(struct md_thread *thread),
NeilBrown2b8bf342011-10-11 16:48:23 +1100624 struct mddev *mddev,
625 const char *name);
626extern void md_unregister_thread(struct md_thread **threadp);
627extern void md_wakeup_thread(struct md_thread *thread);
NeilBrownfd01b882011-10-11 16:47:53 +1100628extern void md_check_recovery(struct mddev *mddev);
Jonathan Brassowa91d5ac2013-04-24 11:42:43 +1000629extern void md_reap_sync_thread(struct mddev *mddev);
NeilBrownfd01b882011-10-11 16:47:53 +1100630extern void md_write_start(struct mddev *mddev, struct bio *bi);
631extern void md_write_end(struct mddev *mddev);
632extern void md_done_sync(struct mddev *mddev, int blocks, int ok);
633extern void md_error(struct mddev *mddev, struct md_rdev *rdev);
NeilBrownc6563a82012-05-21 09:27:00 +1000634extern void md_finish_reshape(struct mddev *mddev);
NeilBrown92022952009-03-31 14:33:13 +1100635
NeilBrownfd01b882011-10-11 16:47:53 +1100636extern int mddev_congested(struct mddev *mddev, int bits);
637extern void md_flush_request(struct mddev *mddev, struct bio *bio);
638extern void md_super_write(struct mddev *mddev, struct md_rdev *rdev,
NeilBrown92022952009-03-31 14:33:13 +1100639 sector_t sector, int size, struct page *page);
NeilBrownfd01b882011-10-11 16:47:53 +1100640extern void md_super_wait(struct mddev *mddev);
NeilBrownf72ffdd2014-09-30 14:23:59 +1000641extern int sync_page_io(struct md_rdev *rdev, sector_t sector, int size,
Jonathan Brassowccebd4c2011-01-14 09:14:33 +1100642 struct page *page, int rw, bool metadata_op);
Shaohua Li4ed87312012-10-11 13:34:00 +1100643extern void md_do_sync(struct md_thread *thread);
NeilBrownfd01b882011-10-11 16:47:53 +1100644extern void md_new_event(struct mddev *mddev);
645extern int md_allow_write(struct mddev *mddev);
646extern void md_wait_for_blocked_rdev(struct md_rdev *rdev, struct mddev *mddev);
647extern void md_set_array_sectors(struct mddev *mddev, sector_t array_sectors);
648extern int md_check_no_bitmap(struct mddev *mddev);
649extern int md_integrity_register(struct mddev *mddev);
650extern void md_integrity_add_rdev(struct md_rdev *rdev, struct mddev *mddev);
NeilBrown72e02072009-12-14 12:49:55 +1100651extern int strict_strtoul_scaled(const char *cp, unsigned long *res, int scale);
Christoph Hellwig63fe0812009-04-14 12:01:53 +1000652
NeilBrownfd01b882011-10-11 16:47:53 +1100653extern void mddev_init(struct mddev *mddev);
654extern int md_run(struct mddev *mddev);
655extern void md_stop(struct mddev *mddev);
656extern void md_stop_writes(struct mddev *mddev);
NeilBrown3cb03002011-10-11 16:45:26 +1100657extern int md_rdev_init(struct md_rdev *rdev);
NeilBrown545c8792012-05-22 13:54:30 +1000658extern void md_rdev_clear(struct md_rdev *rdev);
NeilBrown390ee602010-06-01 19:37:27 +1000659
NeilBrownfd01b882011-10-11 16:47:53 +1100660extern void mddev_suspend(struct mddev *mddev);
661extern void mddev_resume(struct mddev *mddev);
NeilBrowna167f662010-10-26 18:31:13 +1100662extern struct bio *bio_clone_mddev(struct bio *bio, gfp_t gfp_mask,
NeilBrownfd01b882011-10-11 16:47:53 +1100663 struct mddev *mddev);
NeilBrowna167f662010-10-26 18:31:13 +1100664extern struct bio *bio_alloc_mddev(gfp_t gfp_mask, int nr_iovecs,
NeilBrownfd01b882011-10-11 16:47:53 +1100665 struct mddev *mddev);
NeilBrown9cbb1752012-07-31 09:08:14 +0200666
NeilBrown74018dc2012-07-31 09:08:15 +0200667extern void md_unplug(struct blk_plug_cb *cb, bool from_schedule);
NeilBrown9cbb1752012-07-31 09:08:14 +0200668static inline int mddev_check_plugged(struct mddev *mddev)
669{
670 return !!blk_check_plugged(md_unplug, mddev,
671 sizeof(struct blk_plug_cb));
672}
Hannes Reineckedfe15ac2012-07-26 11:12:18 +0200673
674static inline void rdev_dec_pending(struct md_rdev *rdev, struct mddev *mddev)
675{
676 int faulty = test_bit(Faulty, &rdev->flags);
677 if (atomic_dec_and_test(&rdev->nr_pending) && faulty) {
678 set_bit(MD_RECOVERY_NEEDED, &mddev->recovery);
679 md_wakeup_thread(mddev->thread);
680 }
681}
682
Goldwyn Rodriguesedb39c92014-03-29 10:01:53 -0500683extern struct md_cluster_operations *md_cluster_ops;
Goldwyn Rodriguesc4ce8672014-03-29 10:20:02 -0500684static inline int mddev_is_clustered(struct mddev *mddev)
685{
686 return mddev->cluster_info && mddev->bitmap_info.nodes > 1;
687}
Christoph Hellwig63fe0812009-04-14 12:01:53 +1000688#endif /* _MD_MD_H */