md.h 25.2 KB
Newer Older
L
Linus Torvalds 已提交
1
/*
2
   md.h : kernel internal structure of the Linux MD driver
L
Linus Torvalds 已提交
3
          Copyright (C) 1996-98 Ingo Molnar, Gadi Oxman
4

L
Linus Torvalds 已提交
5 6 7 8
   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2, or (at your option)
   any later version.
9

L
Linus Torvalds 已提交
10 11
   You should have received a copy of the GNU General Public License
   (for example /usr/src/linux/COPYING); if not, write to the Free
12
   Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
L
Linus Torvalds 已提交
13 14
*/

C
Christoph Hellwig 已提交
15 16 17 18
#ifndef _MD_MD_H
#define _MD_MD_H

#include <linux/blkdev.h>
19
#include <linux/backing-dev.h>
20
#include <linux/badblocks.h>
C
Christoph Hellwig 已提交
21 22 23 24 25 26 27
#include <linux/kobject.h>
#include <linux/list.h>
#include <linux/mm.h>
#include <linux/mutex.h>
#include <linux/timer.h>
#include <linux/wait.h>
#include <linux/workqueue.h>
28
#include "md-cluster.h"
29

L
Linus Torvalds 已提交
30 31
#define MaxSector (~(sector_t)0)

32 33 34 35 36 37 38 39 40 41
/*
 * These flags should really be called "NO_RETRY" rather than
 * "FAILFAST" because they don't make any promise about time lapse,
 * only about the number of retries, which will be zero.
 * REQ_FAILFAST_DRIVER is not included because
 * Commit: 4a27446f3e39 ("[SCSI] modify scsi to handle new fail fast flags.")
 * seems to suggest that the errors it avoids retrying should usually
 * be retried.
 */
#define	MD_FAILFAST	(REQ_FAILFAST_DEV | REQ_FAILFAST_TRANSPORT)
L
Linus Torvalds 已提交
42 43 44
/*
 * MD's 'extended' device
 */
45
struct md_rdev {
L
Linus Torvalds 已提交
46 47
	struct list_head same_set;	/* RAID devices within the same set */

48
	sector_t sectors;		/* Device size (in 512bytes sectors) */
49
	struct mddev *mddev;		/* RAID array if running */
N
NeilBrown 已提交
50
	int last_events;		/* IO event timestamp */
L
Linus Torvalds 已提交
51

52 53 54 55 56 57
	/*
	 * If meta_bdev is non-NULL, it means that a separate device is
	 * being used to store the metadata (superblock/bitmap) which
	 * would otherwise be contained on the same device as the data (bdev).
	 */
	struct block_device *meta_bdev;
L
Linus Torvalds 已提交
58 59
	struct block_device *bdev;	/* block device handle */

60
	struct page	*sb_page, *bb_page;
L
Linus Torvalds 已提交
61
	int		sb_loaded;
62
	__u64		sb_events;
L
Linus Torvalds 已提交
63
	sector_t	data_offset;	/* start of data in array */
64
	sector_t	new_data_offset;/* only relevant while reshaping */
65
	sector_t	sb_start;	/* offset of the super block (in 512byte sectors) */
66
	int		sb_size;	/* bytes in the superblock */
L
Linus Torvalds 已提交
67 68
	int		preferred_minor;	/* autorun support */

69 70
	struct kobject	kobj;

L
Linus Torvalds 已提交
71 72 73 74 75 76 77 78 79 80 81
	/* A device can be in one of three states based on two flags:
	 * Not working:   faulty==1 in_sync==0
	 * Fully working: faulty==0 in_sync==1
	 * Working, but not
	 * in sync with array
	 *                faulty==0 in_sync==0
	 *
	 * It can never have faulty==1, in_sync==1
	 * This reduces the burden of testing multiple flags in many cases
	 */

82
	unsigned long	flags;	/* bit set of 'enum flag_bits' bits. */
83
	wait_queue_head_t blocked_wait;
84

L
Linus Torvalds 已提交
85 86
	int desc_nr;			/* descriptor index in the superblock */
	int raid_disk;			/* role of device in array */
87 88 89
	int new_raid_disk;		/* role that the device will have in
					 * the array after a level-change completes.
					 */
90 91 92 93
	int saved_raid_disk;		/* role that device used to have in the
					 * array and could again if we did a partial
					 * resync from the bitmap
					 */
94 95
	union {
		sector_t recovery_offset;/* If this device has been partially
96 97 98
					 * recovered, this is where we were
					 * up to.
					 */
99 100 101 102 103
		sector_t journal_tail;	/* If this device is a journal device,
					 * this is the journal tail (journal
					 * recovery start point)
					 */
	};
L
Linus Torvalds 已提交
104 105 106 107 108

	atomic_t	nr_pending;	/* number of pending requests.
					 * only maintained for arrays that
					 * support hot removal
					 */
109 110 111
	atomic_t	read_errors;	/* number of consecutive read errors that
					 * we have tried to ignore.
					 */
112
	time64_t	last_read_error;	/* monotonic time since our
113 114
						 * last read error
						 */
115 116 117 118
	atomic_t	corrected_errors; /* number of corrected read errors,
					   * for reporting to userspace and storing
					   * in superblock.
					   */
119
	struct work_struct del_work;	/* used for delayed sysfs removal */
120

121
	struct kernfs_node *sysfs_state; /* handle for 'state'
122
					   * sysfs entry */
123

124
	struct badblocks badblocks;
125 126 127 128 129 130 131

	struct {
		short offset;	/* Offset from superblock to start of PPL.
				 * Not used by external metadata. */
		unsigned int size;	/* Size in sectors of the PPL space */
		sector_t sector;	/* First sector of the PPL space */
	} ppl;
L
Linus Torvalds 已提交
132
};
133 134 135
enum flag_bits {
	Faulty,			/* device is known to have a fault */
	In_sync,		/* device is in_sync with rest of array */
136
	Bitmap_sync,		/* ..actually, not quite In_sync.  Need a
137 138 139
				 * bitmap-based recovery to get fully in sync.
				 * The bit is only meaningful before device
				 * has been passed to pers->hot_add_disk.
140
				 */
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174
	WriteMostly,		/* Avoid reading if at all possible */
	AutoDetected,		/* added by auto-detect */
	Blocked,		/* An error occurred but has not yet
				 * been acknowledged by the metadata
				 * handler, so don't allow writes
				 * until it is cleared */
	WriteErrorSeen,		/* A write error has been seen on this
				 * device
				 */
	FaultRecorded,		/* Intermediate state for clearing
				 * Blocked.  The Fault is/will-be
				 * recorded in the metadata, but that
				 * metadata hasn't been stored safely
				 * on disk yet.
				 */
	BlockedBadBlocks,	/* A writer is blocked because they
				 * found an unacknowledged bad-block.
				 * This can safely be cleared at any
				 * time, and the writer will re-check.
				 * It may be set at any time, and at
				 * worst the writer will timeout and
				 * re-check.  So setting it as
				 * accurately as possible is good, but
				 * not absolutely critical.
				 */
	WantReplacement,	/* This device is a candidate to be
				 * hot-replaced, either because it has
				 * reported some faults, or because
				 * of explicit request.
				 */
	Replacement,		/* This device is a replacement for
				 * a want_replacement device with same
				 * raid_disk number.
				 */
175 176 177 178
	Candidate,		/* For clustered environments only:
				 * This device is seen locally but not
				 * by the whole cluster
				 */
179 180 181 182 183
	Journal,		/* This device is used as journal for
				 * raid-5/6.
				 * Usually, this device should be faster
				 * than other devices in the array
				 */
184
	ClusterRemove,
185 186 187 188 189
	RemoveSynchronized,	/* synchronize_rcu() was called after
				 * this device was known to be faulty,
				 * so it is safe to remove without
				 * another synchronize_rcu() call.
				 */
190 191 192
	ExternalBbl,            /* External metadata provides bad
				 * block management for a disk
				 */
193 194 195 196 197 198
	FailFast,		/* Minimal retries should be attempted on
				 * this device, so use REQ_FAILFAST_DEV.
				 * Also don't try to repair failed reads.
				 * It is expects that no bad block log
				 * is present.
				 */
199 200 201 202
	LastDev,		/* Seems to be the last working dev as
				 * it didn't fail, so don't use FailFast
				 * any more for metadata
				 */
203
};
L
Linus Torvalds 已提交
204

205
static inline int is_badblock(struct md_rdev *rdev, sector_t s, int sectors,
206 207 208
			      sector_t *first_bad, int *bad_sectors)
{
	if (unlikely(rdev->badblocks.count)) {
209
		int rv = badblocks_check(&rdev->badblocks, rdev->data_offset + s,
210 211 212 213 214 215 216 217
					sectors,
					first_bad, bad_sectors);
		if (rv)
			*first_bad -= rdev->data_offset;
		return rv;
	}
	return 0;
}
218
extern int rdev_set_badblocks(struct md_rdev *rdev, sector_t s, int sectors,
219 220 221
			      int is_new);
extern int rdev_clear_badblocks(struct md_rdev *rdev, sector_t s, int sectors,
				int is_new);
G
Goldwyn Rodrigues 已提交
222 223
struct md_cluster_info;

224
/* change UNSUPPORTED_MDDEV_FLAGS for each array type if new flag is added */
225 226 227 228 229 230 231 232 233
enum mddev_flags {
	MD_ARRAY_FIRST_USE,	/* First use of array, needs initialization */
	MD_CLOSING,		/* If set, we are closing the array, do not open
				 * it then */
	MD_JOURNAL_CLEAN,	/* A raid with journal is already clean */
	MD_HAS_JOURNAL,		/* The raid array has journal feature set */
	MD_CLUSTER_RESYNC_LOCKED, /* cluster raid only, which means node
				   * already took resync lock, need to
				   * release the lock */
234 235 236 237
	MD_FAILFAST_SUPPORTED,	/* Using MD_FAILFAST on metadata writes is
				 * supported as calls to md_error() will
				 * never cause the array to become failed.
				 */
238
	MD_HAS_PPL,		/* The raid array has PPL feature set */
239
	MD_HAS_MULTIPLE_PPLS,	/* The raid array has multiple PPLs feature set */
240
};
241 242 243 244 245 246 247 248

enum mddev_sb_flags {
	MD_SB_CHANGE_DEVS,		/* Some device status has changed */
	MD_SB_CHANGE_CLEAN,	/* transition to or from 'clean' */
	MD_SB_CHANGE_PENDING,	/* switch from 'clean' to 'active' in progress */
	MD_SB_NEED_REWRITE,	/* metadata write needs to be repeated */
};

249
struct mddev {
L
Linus Torvalds 已提交
250
	void				*private;
251
	struct md_personality		*pers;
L
Linus Torvalds 已提交
252 253
	dev_t				unit;
	int				md_minor;
254
	struct list_head		disks;
255
	unsigned long			flags;
256
	unsigned long			sb_flags;
257

258 259
	int				suspended;
	atomic_t			active_io;
L
Linus Torvalds 已提交
260
	int				ro;
261 262 263 264
	int				sysfs_active; /* set when sysfs deletes
						       * are happening, so run/
						       * takeover/stop are not safe
						       */
L
Linus Torvalds 已提交
265 266
	struct gendisk			*gendisk;

267
	struct kobject			kobj;
268 269
	int				hold_active;
#define	UNTIL_IOCTL	1
270
#define	UNTIL_STOP	2
271

L
Linus Torvalds 已提交
272 273 274 275 276
	/* Superblock information */
	int				major_version,
					minor_version,
					patch_version;
	int				persistent;
277
	int				external;	/* metadata is
278 279
							 * managed externally */
	char				metadata_type[17]; /* externally set*/
280
	int				chunk_sectors;
281
	time64_t			ctime, utime;
L
Linus Torvalds 已提交
282
	int				level, layout;
283
	char				clevel[16];
L
Linus Torvalds 已提交
284 285
	int				raid_disks;
	int				max_disks;
286
	sector_t			dev_sectors;	/* used size of
A
Andre Noll 已提交
287
							 * component devices */
288
	sector_t			array_sectors; /* exported array size */
D
Dan Williams 已提交
289 290
	int				external_size; /* size managed
							* externally */
L
Linus Torvalds 已提交
291
	__u64				events;
292 293 294 295 296 297
	/* If the last 'event' was simply a clean->dirty transition, and
	 * we didn't write it to the spares, then it is safe and simple
	 * to just decrement the event count on a dirty->clean transition.
	 * So we record that possibility here.
	 */
	int				can_decrease_events;
L
Linus Torvalds 已提交
298 299 300

	char				uuid[16];

301 302 303 304 305 306
	/* If the array is being reshaped, we need to record the
	 * new shape and an indication of where we are up to.
	 * This is written to the superblock.
	 * If reshape_position is MaxSector, then no reshape is happening (yet).
	 */
	sector_t			reshape_position;
307 308
	int				delta_disks, new_level, new_layout;
	int				new_chunk_sectors;
309
	int				reshape_backwards;
310

311 312
	struct md_thread		*thread;	/* management thread */
	struct md_thread		*sync_thread;	/* doing resync or reconstruct */
313 314 315 316 317 318 319 320

	/* 'last_sync_action' is initialized to "none".  It is set when a
	 * sync operation (i.e "data-check", "requested-resync", "resync",
	 * "recovery", or "reshape") is started.  It holds this value even
	 * when the sync thread is "frozen" (interrupted) or "idle" (stopped
	 * or finished).  It is overwritten when a new sync operation is begun.
	 */
	char				*last_sync_action;
321
	sector_t			curr_resync;	/* last block scheduled */
322 323 324 325 326 327 328
	/* As resync requests can complete out of order, we cannot easily track
	 * how much resync has been completed.  So we occasionally pause until
	 * everything completes, then set curr_resync_completed to curr_resync.
	 * As such it may be well behind the real resync mark, but it is a value
	 * we are certain of.
	 */
	sector_t			curr_resync_completed;
L
Linus Torvalds 已提交
329 330
	unsigned long			resync_mark;	/* a recent timestamp */
	sector_t			resync_mark_cnt;/* blocks written at resync_mark */
331
	sector_t			curr_mark_cnt; /* blocks scheduled now */
L
Linus Torvalds 已提交
332 333

	sector_t			resync_max_sectors; /* may be set by personality */
334

335
	atomic64_t			resync_mismatches; /* count of sectors where
336 337
							    * parity/replica mismatch found
							    */
338 339 340 341

	/* allow user-space to request suspension of IO to regions of the array */
	sector_t			suspend_lo;
	sector_t			suspend_hi;
342 343 344 345
	/* if zero, use the system-wide default */
	int				sync_speed_min;
	int				sync_speed_max;

346 347 348
	/* resync even though the same disks are shared among md-devices */
	int				parallel_resync;

349
	int				ok_start_degraded;
350

L
Linus Torvalds 已提交
351
	unsigned long			recovery;
352 353 354 355 356 357
	/* If a RAID personality determines that recovery (of a particular
	 * device) will fail due to a read error on the source device, it
	 * takes a copy of this number and does not attempt recovery again
	 * until this number changes.
	 */
	int				recovery_disabled;
L
Linus Torvalds 已提交
358 359

	int				in_sync;	/* know to not need resync */
N
NeilBrown 已提交
360 361 362 363 364 365 366 367 368 369
	/* 'open_mutex' avoids races between 'md_open' and 'do_md_stop', so
	 * that we are never stopping an array while it is open.
	 * 'reconfig_mutex' protects all other reconfiguration.
	 * These locks are separate due to conflicting interactions
	 * with bdev->bd_mutex.
	 * Lock ordering is:
	 *  reconfig_mutex -> bd_mutex : e.g. do_md_run -> revalidate_disk
	 *  bd_mutex -> open_mutex:  e.g. __blkdev_get -> md_open
	 */
	struct mutex			open_mutex;
370
	struct mutex			reconfig_mutex;
371 372
	atomic_t			active;		/* general refcount */
	atomic_t			openers;	/* number of active opens */
L
Linus Torvalds 已提交
373

374 375
	int				changed;	/* True if we might need to
							 * reread partition info */
L
Linus Torvalds 已提交
376 377 378 379 380 381 382
	int				degraded;	/* whether md should consider
							 * adding a spare
							 */

	atomic_t			recovery_active; /* blocks scheduled, but not written */
	wait_queue_head_t		recovery_wait;
	sector_t			recovery_cp;
383 384
	sector_t			resync_min;	/* user requested sync
							 * starts here */
385 386
	sector_t			resync_max;	/* resync should pause
							 * when it gets here */
387

388
	struct kernfs_node		*sysfs_state;	/* handle for 'array_state'
389 390
							 * file in sysfs.
							 */
391
	struct kernfs_node		*sysfs_action;  /* handle for 'sync_action' */
392

393 394
	struct work_struct del_work;	/* used for delayed sysfs removal */

395 396 397 398 399
	/* "lock" protects:
	 *   flush_bio transition from NULL to !NULL
	 *   rdev superblocks, events
	 *   clearing MD_CHANGE_*
	 *   in_sync - and related safemode and MD_CHANGE changes
400
	 *   pers (also protected by reconfig_mutex and pending IO).
401
	 *   clearing ->bitmap
402
	 *   clearing ->bitmap_info.file
403 404
	 *   changing ->resync_{min,max}
	 *   setting MD_RECOVERY_RUNNING (which interacts with resync_{min,max})
405 406
	 */
	spinlock_t			lock;
407
	wait_queue_head_t		sb_wait;	/* for waiting on superblock updates */
408
	atomic_t			pending_writes;	/* number of active superblock writes */
409

L
Linus Torvalds 已提交
410 411
	unsigned int			safemode;	/* if set, update "clean" superblock
							 * when no writes pending.
412
							 */
L
Linus Torvalds 已提交
413 414
	unsigned int			safemode_delay;
	struct timer_list		safemode_timer;
415 416
	struct percpu_ref		writes_pending;
	int				sync_checkers;	/* # of threads checking writes_pending */
417
	struct request_queue		*queue;	/* for plugging ... */
L
Linus Torvalds 已提交
418

419
	struct bitmap			*bitmap; /* the bitmap for the device */
420 421
	struct {
		struct file		*file; /* the bitmap file */
422
		loff_t			offset; /* offset from superblock of
423 424
						 * start of bitmap. May be
						 * negative, but not '0'
425
						 * For external metadata, offset
426
						 * from start of device.
427
						 */
428
		unsigned long		space; /* space available at this offset */
429
		loff_t			default_offset; /* this is the offset to use when
430 431 432
							 * hot-adding a bitmap.  It should
							 * eventually be settable by sysfs.
							 */
433 434
		unsigned long		default_space; /* space available at
							* default offset */
435
		struct mutex		mutex;
436
		unsigned long		chunksize;
437
		unsigned long		daemon_sleep; /* how many jiffies between updates? */
438
		unsigned long		max_write_behind; /* write-behind mode */
439
		int			external;
G
Goldwyn Rodrigues 已提交
440
		int			nodes; /* Maximum number of nodes in the cluster */
G
Goldwyn Rodrigues 已提交
441
		char                    cluster_name[64]; /* Name of the cluster */
442
	} bitmap_info;
443

444
	atomic_t			max_corr_read_errors; /* max read retries */
L
Linus Torvalds 已提交
445
	struct list_head		all_mddevs;
446

447
	struct attribute_group		*to_remove;
448

449
	struct bio_set			*bio_set;
450 451 452
	struct bio_set			*sync_set; /* for sync operations like
						   * metadata and bitmap writes
						   */
453

T
Tejun Heo 已提交
454 455
	/* Generic flush handling.
	 * The last to finish preflush schedules a worker to submit
456
	 * the rest of the request (without the REQ_PREFLUSH flag).
457
	 */
T
Tejun Heo 已提交
458
	struct bio *flush_bio;
459
	atomic_t flush_pending;
T
Tejun Heo 已提交
460
	struct work_struct flush_work;
461
	struct work_struct event_work;	/* used by dm to report failure event */
462
	void (*sync_super)(struct mddev *mddev, struct md_rdev *rdev);
G
Goldwyn Rodrigues 已提交
463
	struct md_cluster_info		*cluster_info;
464
	unsigned int			good_device_nr;	/* good device num within cluster raid */
465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481
};

enum recovery_flags {
	/*
	 * If neither SYNC or RESHAPE are set, then it is a recovery.
	 */
	MD_RECOVERY_RUNNING,	/* a thread is running, or about to be started */
	MD_RECOVERY_SYNC,	/* actually doing a resync, not a recovery */
	MD_RECOVERY_RECOVER,	/* doing recovery, or need to try it. */
	MD_RECOVERY_INTR,	/* resync needs to be aborted for some reason */
	MD_RECOVERY_DONE,	/* thread is done and is waiting to be reaped */
	MD_RECOVERY_NEEDED,	/* we might need to start a resync/recover */
	MD_RECOVERY_REQUESTED,	/* user-space has requested a sync (used with SYNC) */
	MD_RECOVERY_CHECK,	/* user-space request for check-only, no repair */
	MD_RECOVERY_RESHAPE,	/* A reshape is happening */
	MD_RECOVERY_FROZEN,	/* User request to abort, and not restart, any action */
	MD_RECOVERY_ERROR,	/* sync-action interrupted because io-error */
L
Linus Torvalds 已提交
482 483
};

484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507
static inline int __must_check mddev_lock(struct mddev *mddev)
{
	return mutex_lock_interruptible(&mddev->reconfig_mutex);
}

/* Sometimes we need to take the lock in a situation where
 * failure due to interrupts is not acceptable.
 */
static inline void mddev_lock_nointr(struct mddev *mddev)
{
	mutex_lock(&mddev->reconfig_mutex);
}

static inline int mddev_is_locked(struct mddev *mddev)
{
	return mutex_is_locked(&mddev->reconfig_mutex);
}

static inline int mddev_trylock(struct mddev *mddev)
{
	return mutex_trylock(&mddev->reconfig_mutex);
}
extern void mddev_unlock(struct mddev *mddev);

L
Linus Torvalds 已提交
508 509
static inline void md_sync_acct(struct block_device *bdev, unsigned long nr_sectors)
{
510
	atomic_add(nr_sectors, &bdev->bd_contains->bd_disk->sync_io);
L
Linus Torvalds 已提交
511 512
}

513 514 515 516 517
static inline void md_sync_acct_bio(struct bio *bio, unsigned long nr_sectors)
{
	atomic_add(nr_sectors, &bio->bi_disk->sync_io);
}

518
struct md_personality
L
Linus Torvalds 已提交
519 520
{
	char *name;
521 522
	int level;
	struct list_head list;
L
Linus Torvalds 已提交
523
	struct module *owner;
524
	bool (*make_request)(struct mddev *mddev, struct bio *bio);
525
	int (*run)(struct mddev *mddev);
N
NeilBrown 已提交
526
	void (*free)(struct mddev *mddev, void *priv);
527
	void (*status)(struct seq_file *seq, struct mddev *mddev);
L
Linus Torvalds 已提交
528
	/* error_handler must set ->faulty and clear ->in_sync
529
	 * if appropriate, and should abort recovery if needed
L
Linus Torvalds 已提交
530
	 */
531 532
	void (*error_handler)(struct mddev *mddev, struct md_rdev *rdev);
	int (*hot_add_disk) (struct mddev *mddev, struct md_rdev *rdev);
533
	int (*hot_remove_disk) (struct mddev *mddev, struct md_rdev *rdev);
534
	int (*spare_active) (struct mddev *mddev);
535
	sector_t (*sync_request)(struct mddev *mddev, sector_t sector_nr, int *skipped);
536 537 538 539 540
	int (*resize) (struct mddev *mddev, sector_t sectors);
	sector_t (*size) (struct mddev *mddev, sector_t sectors, int raid_disks);
	int (*check_reshape) (struct mddev *mddev);
	int (*start_reshape) (struct mddev *mddev);
	void (*finish_reshape) (struct mddev *mddev);
541 542 543 544 545
	/* quiesce moves between quiescence states
	 * 0 - fully active
	 * 1 - no new requests allowed
	 * others - reserved
	 */
546
	void (*quiesce) (struct mddev *mddev, int state);
547 548 549 550 551 552 553 554 555
	/* takeover is used to transition an array from one
	 * personality to another.  The new personality must be able
	 * to handle the data in the current layout.
	 * e.g. 2drive raid1 -> 2drive raid5
	 *      ndrive raid5 -> degraded n+1drive raid6 with special layout
	 * If the takeover succeeds, a new 'private' structure is returned.
	 * This needs to be installed and then ->run used to activate the
	 * array.
	 */
556
	void *(*takeover) (struct mddev *mddev);
557 558 559
	/* congested implements bdi.congested_fn().
	 * Will not be called while array is 'suspended' */
	int (*congested)(struct mddev *mddev, int bits);
560 561
	/* Changes the consistency policy of an active array. */
	int (*change_consistency_policy)(struct mddev *mddev, const char *buf);
L
Linus Torvalds 已提交
562 563
};

564 565
struct md_sysfs_entry {
	struct attribute attr;
566 567
	ssize_t (*show)(struct mddev *, char *);
	ssize_t (*store)(struct mddev *, const char *, size_t);
568
};
569
extern struct attribute_group md_bitmap_group;
570

571
static inline struct kernfs_node *sysfs_get_dirent_safe(struct kernfs_node *sd, char *name)
N
NeilBrown 已提交
572 573
{
	if (sd)
T
Tejun Heo 已提交
574
		return sysfs_get_dirent(sd, name);
N
NeilBrown 已提交
575 576
	return sd;
}
577
static inline void sysfs_notify_dirent_safe(struct kernfs_node *sd)
N
NeilBrown 已提交
578 579 580 581 582
{
	if (sd)
		sysfs_notify_dirent(sd);
}

583
static inline char * mdname (struct mddev * mddev)
L
Linus Torvalds 已提交
584 585 586 587
{
	return mddev->gendisk ? mddev->gendisk->disk_name : "mdX";
}

588
static inline int sysfs_link_rdev(struct mddev *mddev, struct md_rdev *rdev)
589 590
{
	char nm[20];
591 592 593
	if (!test_bit(Replacement, &rdev->flags) &&
	    !test_bit(Journal, &rdev->flags) &&
	    mddev->kobj.sd) {
594 595 596 597
		sprintf(nm, "rd%d", rdev->raid_disk);
		return sysfs_create_link(&mddev->kobj, &rdev->kobj, nm);
	} else
		return 0;
598 599
}

600
static inline void sysfs_unlink_rdev(struct mddev *mddev, struct md_rdev *rdev)
601 602
{
	char nm[20];
603 604 605
	if (!test_bit(Replacement, &rdev->flags) &&
	    !test_bit(Journal, &rdev->flags) &&
	    mddev->kobj.sd) {
606 607 608
		sprintf(nm, "rd%d", rdev->raid_disk);
		sysfs_remove_link(&mddev->kobj, nm);
	}
609 610
}

L
Linus Torvalds 已提交
611 612 613 614
/*
 * iterates through some rdev ringlist. It's safe to remove the
 * current 'rdev'. Dont touch 'tmp' though.
 */
615 616 617
#define rdev_for_each_list(rdev, tmp, head)				\
	list_for_each_entry_safe(rdev, tmp, head, same_set)

L
Linus Torvalds 已提交
618 619 620
/*
 * iterates through the 'same array disks' ringlist
 */
N
NeilBrown 已提交
621 622 623 624
#define rdev_for_each(rdev, mddev)				\
	list_for_each_entry(rdev, &((mddev)->disks), same_set)

#define rdev_for_each_safe(rdev, tmp, mddev)				\
625
	list_for_each_entry_safe(rdev, tmp, &((mddev)->disks), same_set)
L
Linus Torvalds 已提交
626

627 628 629
#define rdev_for_each_rcu(rdev, mddev)				\
	list_for_each_entry_rcu(rdev, &((mddev)->disks), same_set)

630
struct md_thread {
S
Shaohua Li 已提交
631
	void			(*run) (struct md_thread *thread);
632
	struct mddev		*mddev;
L
Linus Torvalds 已提交
633
	wait_queue_head_t	wqueue;
634
	unsigned long		flags;
L
Linus Torvalds 已提交
635
	struct task_struct	*tsk;
636
	unsigned long		timeout;
S
Shaohua Li 已提交
637
	void			*private;
638
};
L
Linus Torvalds 已提交
639 640 641

#define THREAD_WAKEUP  0

642 643 644 645 646
static inline void safe_put_page(struct page *p)
{
	if (p) put_page(p);
}

647 648
extern int register_md_personality(struct md_personality *p);
extern int unregister_md_personality(struct md_personality *p);
649 650 651 652 653
extern int register_md_cluster_operations(struct md_cluster_operations *ops,
		struct module *module);
extern int unregister_md_cluster_operations(void);
extern int md_setup_cluster(struct mddev *mddev, int nodes);
extern void md_cluster_stop(struct mddev *mddev);
654
extern struct md_thread *md_register_thread(
S
Shaohua Li 已提交
655
	void (*run)(struct md_thread *thread),
656 657 658 659
	struct mddev *mddev,
	const char *name);
extern void md_unregister_thread(struct md_thread **threadp);
extern void md_wakeup_thread(struct md_thread *thread);
660
extern void md_check_recovery(struct mddev *mddev);
661
extern void md_reap_sync_thread(struct mddev *mddev);
662
extern int mddev_init_writes_pending(struct mddev *mddev);
663
extern bool md_write_start(struct mddev *mddev, struct bio *bi);
664
extern void md_write_inc(struct mddev *mddev, struct bio *bi);
665 666 667
extern void md_write_end(struct mddev *mddev);
extern void md_done_sync(struct mddev *mddev, int blocks, int ok);
extern void md_error(struct mddev *mddev, struct md_rdev *rdev);
668
extern void md_finish_reshape(struct mddev *mddev);
669 670 671 672

extern int mddev_congested(struct mddev *mddev, int bits);
extern void md_flush_request(struct mddev *mddev, struct bio *bio);
extern void md_super_write(struct mddev *mddev, struct md_rdev *rdev,
673
			   sector_t sector, int size, struct page *page);
674
extern int md_super_wait(struct mddev *mddev);
675
extern int sync_page_io(struct md_rdev *rdev, sector_t sector, int size,
M
Mike Christie 已提交
676 677
			struct page *page, int op, int op_flags,
			bool metadata_op);
S
Shaohua Li 已提交
678
extern void md_do_sync(struct md_thread *thread);
679
extern void md_new_event(struct mddev *mddev);
680
extern void md_allow_write(struct mddev *mddev);
681 682 683 684
extern void md_wait_for_blocked_rdev(struct md_rdev *rdev, struct mddev *mddev);
extern void md_set_array_sectors(struct mddev *mddev, sector_t array_sectors);
extern int md_check_no_bitmap(struct mddev *mddev);
extern int md_integrity_register(struct mddev *mddev);
685
extern int md_integrity_add_rdev(struct md_rdev *rdev, struct mddev *mddev);
686
extern int strict_strtoul_scaled(const char *cp, unsigned long *res, int scale);
C
Christoph Hellwig 已提交
687

688 689 690 691
extern void mddev_init(struct mddev *mddev);
extern int md_run(struct mddev *mddev);
extern void md_stop(struct mddev *mddev);
extern void md_stop_writes(struct mddev *mddev);
692
extern int md_rdev_init(struct md_rdev *rdev);
693
extern void md_rdev_clear(struct md_rdev *rdev);
C
Christoph Hellwig 已提交
694

695 696
extern void mddev_suspend(struct mddev *mddev);
extern void mddev_resume(struct mddev *mddev);
697
extern struct bio *bio_alloc_mddev(gfp_t gfp_mask, int nr_iovecs,
698
				   struct mddev *mddev);
699

700
extern void md_reload_sb(struct mddev *mddev, int raid_disk);
701
extern void md_update_sb(struct mddev *mddev, int force);
702
extern void md_kick_rdev_from_array(struct md_rdev * rdev);
703
struct md_rdev *md_find_rdev_nr_rcu(struct mddev *mddev, int nr);
704 705 706 707 708 709 710 711 712 713

static inline void rdev_dec_pending(struct md_rdev *rdev, struct mddev *mddev)
{
	int faulty = test_bit(Faulty, &rdev->flags);
	if (atomic_dec_and_test(&rdev->nr_pending) && faulty) {
		set_bit(MD_RECOVERY_NEEDED, &mddev->recovery);
		md_wakeup_thread(mddev->thread);
	}
}

714
extern struct md_cluster_operations *md_cluster_ops;
G
Goldwyn Rodrigues 已提交
715 716 717 718
static inline int mddev_is_clustered(struct mddev *mddev)
{
	return mddev->cluster_info && mddev->bitmap_info.nodes > 1;
}
719 720 721 722 723 724 725

/* clear unsupported mddev_flags */
static inline void mddev_clear_unsupported_flags(struct mddev *mddev,
	unsigned long unsupported_flags)
{
	mddev->flags &= ~unsupported_flags;
}
726 727 728 729

static inline void mddev_check_writesame(struct mddev *mddev, struct bio *bio)
{
	if (bio_op(bio) == REQ_OP_WRITE_SAME &&
730
	    !bio->bi_disk->queue->limits.max_write_same_sectors)
731 732
		mddev->queue->limits.max_write_same_sectors = 0;
}
733 734 735 736

static inline void mddev_check_write_zeroes(struct mddev *mddev, struct bio *bio)
{
	if (bio_op(bio) == REQ_OP_WRITE_ZEROES &&
737
	    !bio->bi_disk->queue->limits.max_write_zeroes_sectors)
738 739
		mddev->queue->limits.max_write_zeroes_sectors = 0;
}
C
Christoph Hellwig 已提交
740
#endif /* _MD_MD_H */