xref: /openbmc/linux/drivers/md/md.h (revision e6dec923)
1 /*
2    md.h : kernel internal structure of the Linux MD driver
3           Copyright (C) 1996-98 Ingo Molnar, Gadi Oxman
4 
5    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.
9 
10    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
12    Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
13 */
14 
15 #ifndef _MD_MD_H
16 #define _MD_MD_H
17 
18 #include <linux/blkdev.h>
19 #include <linux/backing-dev.h>
20 #include <linux/badblocks.h>
21 #include <linux/kobject.h>
22 #include <linux/list.h>
23 #include <linux/mm.h>
24 #include <linux/mutex.h>
25 #include <linux/timer.h>
26 #include <linux/wait.h>
27 #include <linux/workqueue.h>
28 #include "md-cluster.h"
29 
30 #define MaxSector (~(sector_t)0)
31 
32 /*
33  * These flags should really be called "NO_RETRY" rather than
34  * "FAILFAST" because they don't make any promise about time lapse,
35  * only about the number of retries, which will be zero.
36  * REQ_FAILFAST_DRIVER is not included because
37  * Commit: 4a27446f3e39 ("[SCSI] modify scsi to handle new fail fast flags.")
38  * seems to suggest that the errors it avoids retrying should usually
39  * be retried.
40  */
41 #define	MD_FAILFAST	(REQ_FAILFAST_DEV | REQ_FAILFAST_TRANSPORT)
42 /*
43  * MD's 'extended' device
44  */
45 struct md_rdev {
46 	struct list_head same_set;	/* RAID devices within the same set */
47 
48 	sector_t sectors;		/* Device size (in 512bytes sectors) */
49 	struct mddev *mddev;		/* RAID array if running */
50 	int last_events;		/* IO event timestamp */
51 
52 	/*
53 	 * If meta_bdev is non-NULL, it means that a separate device is
54 	 * being used to store the metadata (superblock/bitmap) which
55 	 * would otherwise be contained on the same device as the data (bdev).
56 	 */
57 	struct block_device *meta_bdev;
58 	struct block_device *bdev;	/* block device handle */
59 
60 	struct page	*sb_page, *bb_page;
61 	int		sb_loaded;
62 	__u64		sb_events;
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 */
67 	int		preferred_minor;	/* autorun support */
68 
69 	struct kobject	kobj;
70 
71 	/* A device can be in one of three states based on two flags:
72 	 * Not working:   faulty==1 in_sync==0
73 	 * Fully working: faulty==0 in_sync==1
74 	 * Working, but not
75 	 * in sync with array
76 	 *                faulty==0 in_sync==0
77 	 *
78 	 * It can never have faulty==1, in_sync==1
79 	 * This reduces the burden of testing multiple flags in many cases
80 	 */
81 
82 	unsigned long	flags;	/* bit set of 'enum flag_bits' bits. */
83 	wait_queue_head_t blocked_wait;
84 
85 	int desc_nr;			/* descriptor index in the superblock */
86 	int raid_disk;			/* role of device in array */
87 	int new_raid_disk;		/* role that the device will have in
88 					 * the array after a level-change completes.
89 					 */
90 	int saved_raid_disk;		/* role that device used to have in the
91 					 * array and could again if we did a partial
92 					 * resync from the bitmap
93 					 */
94 	union {
95 		sector_t recovery_offset;/* If this device has been partially
96 					 * recovered, this is where we were
97 					 * up to.
98 					 */
99 		sector_t journal_tail;	/* If this device is a journal device,
100 					 * this is the journal tail (journal
101 					 * recovery start point)
102 					 */
103 	};
104 
105 	atomic_t	nr_pending;	/* number of pending requests.
106 					 * only maintained for arrays that
107 					 * support hot removal
108 					 */
109 	atomic_t	read_errors;	/* number of consecutive read errors that
110 					 * we have tried to ignore.
111 					 */
112 	time64_t	last_read_error;	/* monotonic time since our
113 						 * last read error
114 						 */
115 	atomic_t	corrected_errors; /* number of corrected read errors,
116 					   * for reporting to userspace and storing
117 					   * in superblock.
118 					   */
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 	struct {
127 		short offset;	/* Offset from superblock to start of PPL.
128 				 * Not used by external metadata. */
129 		unsigned int size;	/* Size in sectors of the PPL space */
130 		sector_t sector;	/* First sector of the PPL space */
131 	} ppl;
132 };
133 enum flag_bits {
134 	Faulty,			/* device is known to have a fault */
135 	In_sync,		/* device is in_sync with rest of array */
136 	Bitmap_sync,		/* ..actually, not quite In_sync.  Need a
137 				 * bitmap-based recovery to get fully in sync.
138 				 * The bit is only meaningful before device
139 				 * has been passed to pers->hot_add_disk.
140 				 */
141 	WriteMostly,		/* Avoid reading if at all possible */
142 	AutoDetected,		/* added by auto-detect */
143 	Blocked,		/* An error occurred but has not yet
144 				 * been acknowledged by the metadata
145 				 * handler, so don't allow writes
146 				 * until it is cleared */
147 	WriteErrorSeen,		/* A write error has been seen on this
148 				 * device
149 				 */
150 	FaultRecorded,		/* Intermediate state for clearing
151 				 * Blocked.  The Fault is/will-be
152 				 * recorded in the metadata, but that
153 				 * metadata hasn't been stored safely
154 				 * on disk yet.
155 				 */
156 	BlockedBadBlocks,	/* A writer is blocked because they
157 				 * found an unacknowledged bad-block.
158 				 * This can safely be cleared at any
159 				 * time, and the writer will re-check.
160 				 * It may be set at any time, and at
161 				 * worst the writer will timeout and
162 				 * re-check.  So setting it as
163 				 * accurately as possible is good, but
164 				 * not absolutely critical.
165 				 */
166 	WantReplacement,	/* This device is a candidate to be
167 				 * hot-replaced, either because it has
168 				 * reported some faults, or because
169 				 * of explicit request.
170 				 */
171 	Replacement,		/* This device is a replacement for
172 				 * a want_replacement device with same
173 				 * raid_disk number.
174 				 */
175 	Candidate,		/* For clustered environments only:
176 				 * This device is seen locally but not
177 				 * by the whole cluster
178 				 */
179 	Journal,		/* This device is used as journal for
180 				 * raid-5/6.
181 				 * Usually, this device should be faster
182 				 * than other devices in the array
183 				 */
184 	ClusterRemove,
185 	RemoveSynchronized,	/* synchronize_rcu() was called after
186 				 * this device was known to be faulty,
187 				 * so it is safe to remove without
188 				 * another synchronize_rcu() call.
189 				 */
190 	ExternalBbl,            /* External metadata provides bad
191 				 * block management for a disk
192 				 */
193 	FailFast,		/* Minimal retries should be attempted on
194 				 * this device, so use REQ_FAILFAST_DEV.
195 				 * Also don't try to repair failed reads.
196 				 * It is expects that no bad block log
197 				 * is present.
198 				 */
199 	LastDev,		/* Seems to be the last working dev as
200 				 * it didn't fail, so don't use FailFast
201 				 * any more for metadata
202 				 */
203 };
204 
205 static inline int is_badblock(struct md_rdev *rdev, sector_t s, int sectors,
206 			      sector_t *first_bad, int *bad_sectors)
207 {
208 	if (unlikely(rdev->badblocks.count)) {
209 		int rv = badblocks_check(&rdev->badblocks, rdev->data_offset + s,
210 					sectors,
211 					first_bad, bad_sectors);
212 		if (rv)
213 			*first_bad -= rdev->data_offset;
214 		return rv;
215 	}
216 	return 0;
217 }
218 extern int rdev_set_badblocks(struct md_rdev *rdev, sector_t s, int sectors,
219 			      int is_new);
220 extern int rdev_clear_badblocks(struct md_rdev *rdev, sector_t s, int sectors,
221 				int is_new);
222 struct md_cluster_info;
223 
224 /* change UNSUPPORTED_MDDEV_FLAGS for each array type if new flag is added */
225 enum mddev_flags {
226 	MD_ARRAY_FIRST_USE,	/* First use of array, needs initialization */
227 	MD_CLOSING,		/* If set, we are closing the array, do not open
228 				 * it then */
229 	MD_JOURNAL_CLEAN,	/* A raid with journal is already clean */
230 	MD_HAS_JOURNAL,		/* The raid array has journal feature set */
231 	MD_CLUSTER_RESYNC_LOCKED, /* cluster raid only, which means node
232 				   * already took resync lock, need to
233 				   * release the lock */
234 	MD_FAILFAST_SUPPORTED,	/* Using MD_FAILFAST on metadata writes is
235 				 * supported as calls to md_error() will
236 				 * never cause the array to become failed.
237 				 */
238 	MD_HAS_PPL,		/* The raid array has PPL feature set */
239 };
240 
241 enum mddev_sb_flags {
242 	MD_SB_CHANGE_DEVS,		/* Some device status has changed */
243 	MD_SB_CHANGE_CLEAN,	/* transition to or from 'clean' */
244 	MD_SB_CHANGE_PENDING,	/* switch from 'clean' to 'active' in progress */
245 	MD_SB_NEED_REWRITE,	/* metadata write needs to be repeated */
246 };
247 
248 struct mddev {
249 	void				*private;
250 	struct md_personality		*pers;
251 	dev_t				unit;
252 	int				md_minor;
253 	struct list_head		disks;
254 	unsigned long			flags;
255 	unsigned long			sb_flags;
256 
257 	int				suspended;
258 	atomic_t			active_io;
259 	int				ro;
260 	int				sysfs_active; /* set when sysfs deletes
261 						       * are happening, so run/
262 						       * takeover/stop are not safe
263 						       */
264 	struct gendisk			*gendisk;
265 
266 	struct kobject			kobj;
267 	int				hold_active;
268 #define	UNTIL_IOCTL	1
269 #define	UNTIL_STOP	2
270 
271 	/* Superblock information */
272 	int				major_version,
273 					minor_version,
274 					patch_version;
275 	int				persistent;
276 	int				external;	/* metadata is
277 							 * managed externally */
278 	char				metadata_type[17]; /* externally set*/
279 	int				chunk_sectors;
280 	time64_t			ctime, utime;
281 	int				level, layout;
282 	char				clevel[16];
283 	int				raid_disks;
284 	int				max_disks;
285 	sector_t			dev_sectors;	/* used size of
286 							 * component devices */
287 	sector_t			array_sectors; /* exported array size */
288 	int				external_size; /* size managed
289 							* externally */
290 	__u64				events;
291 	/* If the last 'event' was simply a clean->dirty transition, and
292 	 * we didn't write it to the spares, then it is safe and simple
293 	 * to just decrement the event count on a dirty->clean transition.
294 	 * So we record that possibility here.
295 	 */
296 	int				can_decrease_events;
297 
298 	char				uuid[16];
299 
300 	/* If the array is being reshaped, we need to record the
301 	 * new shape and an indication of where we are up to.
302 	 * This is written to the superblock.
303 	 * If reshape_position is MaxSector, then no reshape is happening (yet).
304 	 */
305 	sector_t			reshape_position;
306 	int				delta_disks, new_level, new_layout;
307 	int				new_chunk_sectors;
308 	int				reshape_backwards;
309 
310 	struct md_thread		*thread;	/* management thread */
311 	struct md_thread		*sync_thread;	/* doing resync or reconstruct */
312 
313 	/* 'last_sync_action' is initialized to "none".  It is set when a
314 	 * sync operation (i.e "data-check", "requested-resync", "resync",
315 	 * "recovery", or "reshape") is started.  It holds this value even
316 	 * when the sync thread is "frozen" (interrupted) or "idle" (stopped
317 	 * or finished).  It is overwritten when a new sync operation is begun.
318 	 */
319 	char				*last_sync_action;
320 	sector_t			curr_resync;	/* last block scheduled */
321 	/* As resync requests can complete out of order, we cannot easily track
322 	 * how much resync has been completed.  So we occasionally pause until
323 	 * everything completes, then set curr_resync_completed to curr_resync.
324 	 * As such it may be well behind the real resync mark, but it is a value
325 	 * we are certain of.
326 	 */
327 	sector_t			curr_resync_completed;
328 	unsigned long			resync_mark;	/* a recent timestamp */
329 	sector_t			resync_mark_cnt;/* blocks written at resync_mark */
330 	sector_t			curr_mark_cnt; /* blocks scheduled now */
331 
332 	sector_t			resync_max_sectors; /* may be set by personality */
333 
334 	atomic64_t			resync_mismatches; /* count of sectors where
335 							    * parity/replica mismatch found
336 							    */
337 
338 	/* allow user-space to request suspension of IO to regions of the array */
339 	sector_t			suspend_lo;
340 	sector_t			suspend_hi;
341 	/* if zero, use the system-wide default */
342 	int				sync_speed_min;
343 	int				sync_speed_max;
344 
345 	/* resync even though the same disks are shared among md-devices */
346 	int				parallel_resync;
347 
348 	int				ok_start_degraded;
349 
350 	unsigned long			recovery;
351 	/* If a RAID personality determines that recovery (of a particular
352 	 * device) will fail due to a read error on the source device, it
353 	 * takes a copy of this number and does not attempt recovery again
354 	 * until this number changes.
355 	 */
356 	int				recovery_disabled;
357 
358 	int				in_sync;	/* know to not need resync */
359 	/* 'open_mutex' avoids races between 'md_open' and 'do_md_stop', so
360 	 * that we are never stopping an array while it is open.
361 	 * 'reconfig_mutex' protects all other reconfiguration.
362 	 * These locks are separate due to conflicting interactions
363 	 * with bdev->bd_mutex.
364 	 * Lock ordering is:
365 	 *  reconfig_mutex -> bd_mutex : e.g. do_md_run -> revalidate_disk
366 	 *  bd_mutex -> open_mutex:  e.g. __blkdev_get -> md_open
367 	 */
368 	struct mutex			open_mutex;
369 	struct mutex			reconfig_mutex;
370 	atomic_t			active;		/* general refcount */
371 	atomic_t			openers;	/* number of active opens */
372 
373 	int				changed;	/* True if we might need to
374 							 * reread partition info */
375 	int				degraded;	/* whether md should consider
376 							 * adding a spare
377 							 */
378 
379 	atomic_t			recovery_active; /* blocks scheduled, but not written */
380 	wait_queue_head_t		recovery_wait;
381 	sector_t			recovery_cp;
382 	sector_t			resync_min;	/* user requested sync
383 							 * starts here */
384 	sector_t			resync_max;	/* resync should pause
385 							 * when it gets here */
386 
387 	struct kernfs_node		*sysfs_state;	/* handle for 'array_state'
388 							 * file in sysfs.
389 							 */
390 	struct kernfs_node		*sysfs_action;  /* handle for 'sync_action' */
391 
392 	struct work_struct del_work;	/* used for delayed sysfs removal */
393 
394 	/* "lock" protects:
395 	 *   flush_bio transition from NULL to !NULL
396 	 *   rdev superblocks, events
397 	 *   clearing MD_CHANGE_*
398 	 *   in_sync - and related safemode and MD_CHANGE changes
399 	 *   pers (also protected by reconfig_mutex and pending IO).
400 	 *   clearing ->bitmap
401 	 *   clearing ->bitmap_info.file
402 	 *   changing ->resync_{min,max}
403 	 *   setting MD_RECOVERY_RUNNING (which interacts with resync_{min,max})
404 	 */
405 	spinlock_t			lock;
406 	wait_queue_head_t		sb_wait;	/* for waiting on superblock updates */
407 	atomic_t			pending_writes;	/* number of active superblock writes */
408 
409 	unsigned int			safemode;	/* if set, update "clean" superblock
410 							 * when no writes pending.
411 							 */
412 	unsigned int			safemode_delay;
413 	struct timer_list		safemode_timer;
414 	struct percpu_ref		writes_pending;
415 	int				sync_checkers;	/* # of threads checking writes_pending */
416 	struct request_queue		*queue;	/* for plugging ... */
417 
418 	struct bitmap			*bitmap; /* the bitmap for the device */
419 	struct {
420 		struct file		*file; /* the bitmap file */
421 		loff_t			offset; /* offset from superblock of
422 						 * start of bitmap. May be
423 						 * negative, but not '0'
424 						 * For external metadata, offset
425 						 * from start of device.
426 						 */
427 		unsigned long		space; /* space available at this offset */
428 		loff_t			default_offset; /* this is the offset to use when
429 							 * hot-adding a bitmap.  It should
430 							 * eventually be settable by sysfs.
431 							 */
432 		unsigned long		default_space; /* space available at
433 							* default offset */
434 		struct mutex		mutex;
435 		unsigned long		chunksize;
436 		unsigned long		daemon_sleep; /* how many jiffies between updates? */
437 		unsigned long		max_write_behind; /* write-behind mode */
438 		int			external;
439 		int			nodes; /* Maximum number of nodes in the cluster */
440 		char                    cluster_name[64]; /* Name of the cluster */
441 	} bitmap_info;
442 
443 	atomic_t			max_corr_read_errors; /* max read retries */
444 	struct list_head		all_mddevs;
445 
446 	struct attribute_group		*to_remove;
447 
448 	struct bio_set			*bio_set;
449 	struct bio_set			*sync_set; /* for sync operations like
450 						   * metadata and bitmap writes
451 						   */
452 
453 	/* Generic flush handling.
454 	 * The last to finish preflush schedules a worker to submit
455 	 * the rest of the request (without the REQ_PREFLUSH flag).
456 	 */
457 	struct bio *flush_bio;
458 	atomic_t flush_pending;
459 	struct work_struct flush_work;
460 	struct work_struct event_work;	/* used by dm to report failure event */
461 	void (*sync_super)(struct mddev *mddev, struct md_rdev *rdev);
462 	struct md_cluster_info		*cluster_info;
463 	unsigned int			good_device_nr;	/* good device num within cluster raid */
464 };
465 
466 enum recovery_flags {
467 	/*
468 	 * If neither SYNC or RESHAPE are set, then it is a recovery.
469 	 */
470 	MD_RECOVERY_RUNNING,	/* a thread is running, or about to be started */
471 	MD_RECOVERY_SYNC,	/* actually doing a resync, not a recovery */
472 	MD_RECOVERY_RECOVER,	/* doing recovery, or need to try it. */
473 	MD_RECOVERY_INTR,	/* resync needs to be aborted for some reason */
474 	MD_RECOVERY_DONE,	/* thread is done and is waiting to be reaped */
475 	MD_RECOVERY_NEEDED,	/* we might need to start a resync/recover */
476 	MD_RECOVERY_REQUESTED,	/* user-space has requested a sync (used with SYNC) */
477 	MD_RECOVERY_CHECK,	/* user-space request for check-only, no repair */
478 	MD_RECOVERY_RESHAPE,	/* A reshape is happening */
479 	MD_RECOVERY_FROZEN,	/* User request to abort, and not restart, any action */
480 	MD_RECOVERY_ERROR,	/* sync-action interrupted because io-error */
481 };
482 
483 static inline int __must_check mddev_lock(struct mddev *mddev)
484 {
485 	return mutex_lock_interruptible(&mddev->reconfig_mutex);
486 }
487 
488 /* Sometimes we need to take the lock in a situation where
489  * failure due to interrupts is not acceptable.
490  */
491 static inline void mddev_lock_nointr(struct mddev *mddev)
492 {
493 	mutex_lock(&mddev->reconfig_mutex);
494 }
495 
496 static inline int mddev_is_locked(struct mddev *mddev)
497 {
498 	return mutex_is_locked(&mddev->reconfig_mutex);
499 }
500 
501 static inline int mddev_trylock(struct mddev *mddev)
502 {
503 	return mutex_trylock(&mddev->reconfig_mutex);
504 }
505 extern void mddev_unlock(struct mddev *mddev);
506 
507 static inline void md_sync_acct(struct block_device *bdev, unsigned long nr_sectors)
508 {
509 	atomic_add(nr_sectors, &bdev->bd_contains->bd_disk->sync_io);
510 }
511 
512 struct md_personality
513 {
514 	char *name;
515 	int level;
516 	struct list_head list;
517 	struct module *owner;
518 	bool (*make_request)(struct mddev *mddev, struct bio *bio);
519 	int (*run)(struct mddev *mddev);
520 	void (*free)(struct mddev *mddev, void *priv);
521 	void (*status)(struct seq_file *seq, struct mddev *mddev);
522 	/* error_handler must set ->faulty and clear ->in_sync
523 	 * if appropriate, and should abort recovery if needed
524 	 */
525 	void (*error_handler)(struct mddev *mddev, struct md_rdev *rdev);
526 	int (*hot_add_disk) (struct mddev *mddev, struct md_rdev *rdev);
527 	int (*hot_remove_disk) (struct mddev *mddev, struct md_rdev *rdev);
528 	int (*spare_active) (struct mddev *mddev);
529 	sector_t (*sync_request)(struct mddev *mddev, sector_t sector_nr, int *skipped);
530 	int (*resize) (struct mddev *mddev, sector_t sectors);
531 	sector_t (*size) (struct mddev *mddev, sector_t sectors, int raid_disks);
532 	int (*check_reshape) (struct mddev *mddev);
533 	int (*start_reshape) (struct mddev *mddev);
534 	void (*finish_reshape) (struct mddev *mddev);
535 	/* quiesce moves between quiescence states
536 	 * 0 - fully active
537 	 * 1 - no new requests allowed
538 	 * others - reserved
539 	 */
540 	void (*quiesce) (struct mddev *mddev, int state);
541 	/* takeover is used to transition an array from one
542 	 * personality to another.  The new personality must be able
543 	 * to handle the data in the current layout.
544 	 * e.g. 2drive raid1 -> 2drive raid5
545 	 *      ndrive raid5 -> degraded n+1drive raid6 with special layout
546 	 * If the takeover succeeds, a new 'private' structure is returned.
547 	 * This needs to be installed and then ->run used to activate the
548 	 * array.
549 	 */
550 	void *(*takeover) (struct mddev *mddev);
551 	/* congested implements bdi.congested_fn().
552 	 * Will not be called while array is 'suspended' */
553 	int (*congested)(struct mddev *mddev, int bits);
554 	/* Changes the consistency policy of an active array. */
555 	int (*change_consistency_policy)(struct mddev *mddev, const char *buf);
556 };
557 
558 struct md_sysfs_entry {
559 	struct attribute attr;
560 	ssize_t (*show)(struct mddev *, char *);
561 	ssize_t (*store)(struct mddev *, const char *, size_t);
562 };
563 extern struct attribute_group md_bitmap_group;
564 
565 static inline struct kernfs_node *sysfs_get_dirent_safe(struct kernfs_node *sd, char *name)
566 {
567 	if (sd)
568 		return sysfs_get_dirent(sd, name);
569 	return sd;
570 }
571 static inline void sysfs_notify_dirent_safe(struct kernfs_node *sd)
572 {
573 	if (sd)
574 		sysfs_notify_dirent(sd);
575 }
576 
577 static inline char * mdname (struct mddev * mddev)
578 {
579 	return mddev->gendisk ? mddev->gendisk->disk_name : "mdX";
580 }
581 
582 static inline int sysfs_link_rdev(struct mddev *mddev, struct md_rdev *rdev)
583 {
584 	char nm[20];
585 	if (!test_bit(Replacement, &rdev->flags) &&
586 	    !test_bit(Journal, &rdev->flags) &&
587 	    mddev->kobj.sd) {
588 		sprintf(nm, "rd%d", rdev->raid_disk);
589 		return sysfs_create_link(&mddev->kobj, &rdev->kobj, nm);
590 	} else
591 		return 0;
592 }
593 
594 static inline void sysfs_unlink_rdev(struct mddev *mddev, struct md_rdev *rdev)
595 {
596 	char nm[20];
597 	if (!test_bit(Replacement, &rdev->flags) &&
598 	    !test_bit(Journal, &rdev->flags) &&
599 	    mddev->kobj.sd) {
600 		sprintf(nm, "rd%d", rdev->raid_disk);
601 		sysfs_remove_link(&mddev->kobj, nm);
602 	}
603 }
604 
605 /*
606  * iterates through some rdev ringlist. It's safe to remove the
607  * current 'rdev'. Dont touch 'tmp' though.
608  */
609 #define rdev_for_each_list(rdev, tmp, head)				\
610 	list_for_each_entry_safe(rdev, tmp, head, same_set)
611 
612 /*
613  * iterates through the 'same array disks' ringlist
614  */
615 #define rdev_for_each(rdev, mddev)				\
616 	list_for_each_entry(rdev, &((mddev)->disks), same_set)
617 
618 #define rdev_for_each_safe(rdev, tmp, mddev)				\
619 	list_for_each_entry_safe(rdev, tmp, &((mddev)->disks), same_set)
620 
621 #define rdev_for_each_rcu(rdev, mddev)				\
622 	list_for_each_entry_rcu(rdev, &((mddev)->disks), same_set)
623 
624 struct md_thread {
625 	void			(*run) (struct md_thread *thread);
626 	struct mddev		*mddev;
627 	wait_queue_head_t	wqueue;
628 	unsigned long		flags;
629 	struct task_struct	*tsk;
630 	unsigned long		timeout;
631 	void			*private;
632 };
633 
634 #define THREAD_WAKEUP  0
635 
636 static inline void safe_put_page(struct page *p)
637 {
638 	if (p) put_page(p);
639 }
640 
641 extern int register_md_personality(struct md_personality *p);
642 extern int unregister_md_personality(struct md_personality *p);
643 extern int register_md_cluster_operations(struct md_cluster_operations *ops,
644 		struct module *module);
645 extern int unregister_md_cluster_operations(void);
646 extern int md_setup_cluster(struct mddev *mddev, int nodes);
647 extern void md_cluster_stop(struct mddev *mddev);
648 extern struct md_thread *md_register_thread(
649 	void (*run)(struct md_thread *thread),
650 	struct mddev *mddev,
651 	const char *name);
652 extern void md_unregister_thread(struct md_thread **threadp);
653 extern void md_wakeup_thread(struct md_thread *thread);
654 extern void md_check_recovery(struct mddev *mddev);
655 extern void md_reap_sync_thread(struct mddev *mddev);
656 extern int mddev_init_writes_pending(struct mddev *mddev);
657 extern bool md_write_start(struct mddev *mddev, struct bio *bi);
658 extern void md_write_inc(struct mddev *mddev, struct bio *bi);
659 extern void md_write_end(struct mddev *mddev);
660 extern void md_done_sync(struct mddev *mddev, int blocks, int ok);
661 extern void md_error(struct mddev *mddev, struct md_rdev *rdev);
662 extern void md_finish_reshape(struct mddev *mddev);
663 
664 extern int mddev_congested(struct mddev *mddev, int bits);
665 extern void md_flush_request(struct mddev *mddev, struct bio *bio);
666 extern void md_super_write(struct mddev *mddev, struct md_rdev *rdev,
667 			   sector_t sector, int size, struct page *page);
668 extern int md_super_wait(struct mddev *mddev);
669 extern int sync_page_io(struct md_rdev *rdev, sector_t sector, int size,
670 			struct page *page, int op, int op_flags,
671 			bool metadata_op);
672 extern void md_do_sync(struct md_thread *thread);
673 extern void md_new_event(struct mddev *mddev);
674 extern void md_allow_write(struct mddev *mddev);
675 extern void md_wait_for_blocked_rdev(struct md_rdev *rdev, struct mddev *mddev);
676 extern void md_set_array_sectors(struct mddev *mddev, sector_t array_sectors);
677 extern int md_check_no_bitmap(struct mddev *mddev);
678 extern int md_integrity_register(struct mddev *mddev);
679 extern int md_integrity_add_rdev(struct md_rdev *rdev, struct mddev *mddev);
680 extern int strict_strtoul_scaled(const char *cp, unsigned long *res, int scale);
681 
682 extern void mddev_init(struct mddev *mddev);
683 extern int md_run(struct mddev *mddev);
684 extern void md_stop(struct mddev *mddev);
685 extern void md_stop_writes(struct mddev *mddev);
686 extern int md_rdev_init(struct md_rdev *rdev);
687 extern void md_rdev_clear(struct md_rdev *rdev);
688 
689 extern void mddev_suspend(struct mddev *mddev);
690 extern void mddev_resume(struct mddev *mddev);
691 extern struct bio *bio_alloc_mddev(gfp_t gfp_mask, int nr_iovecs,
692 				   struct mddev *mddev);
693 
694 extern void md_reload_sb(struct mddev *mddev, int raid_disk);
695 extern void md_update_sb(struct mddev *mddev, int force);
696 extern void md_kick_rdev_from_array(struct md_rdev * rdev);
697 struct md_rdev *md_find_rdev_nr_rcu(struct mddev *mddev, int nr);
698 
699 static inline void rdev_dec_pending(struct md_rdev *rdev, struct mddev *mddev)
700 {
701 	int faulty = test_bit(Faulty, &rdev->flags);
702 	if (atomic_dec_and_test(&rdev->nr_pending) && faulty) {
703 		set_bit(MD_RECOVERY_NEEDED, &mddev->recovery);
704 		md_wakeup_thread(mddev->thread);
705 	}
706 }
707 
708 extern struct md_cluster_operations *md_cluster_ops;
709 static inline int mddev_is_clustered(struct mddev *mddev)
710 {
711 	return mddev->cluster_info && mddev->bitmap_info.nodes > 1;
712 }
713 
714 /* clear unsupported mddev_flags */
715 static inline void mddev_clear_unsupported_flags(struct mddev *mddev,
716 	unsigned long unsupported_flags)
717 {
718 	mddev->flags &= ~unsupported_flags;
719 }
720 
721 static inline void mddev_check_writesame(struct mddev *mddev, struct bio *bio)
722 {
723 	if (bio_op(bio) == REQ_OP_WRITE_SAME &&
724 	    !bdev_get_queue(bio->bi_bdev)->limits.max_write_same_sectors)
725 		mddev->queue->limits.max_write_same_sectors = 0;
726 }
727 
728 static inline void mddev_check_write_zeroes(struct mddev *mddev, struct bio *bio)
729 {
730 	if (bio_op(bio) == REQ_OP_WRITE_ZEROES &&
731 	    !bdev_get_queue(bio->bi_bdev)->limits.max_write_zeroes_sectors)
732 		mddev->queue->limits.max_write_zeroes_sectors = 0;
733 }
734 
735 /* Maximum size of each resync request */
736 #define RESYNC_BLOCK_SIZE (64*1024)
737 #define RESYNC_PAGES ((RESYNC_BLOCK_SIZE + PAGE_SIZE-1) / PAGE_SIZE)
738 
739 /* for managing resync I/O pages */
740 struct resync_pages {
741 	unsigned	idx;	/* for get/put page from the pool */
742 	void		*raid_bio;
743 	struct page	*pages[RESYNC_PAGES];
744 };
745 
746 static inline int resync_alloc_pages(struct resync_pages *rp,
747 				     gfp_t gfp_flags)
748 {
749 	int i;
750 
751 	for (i = 0; i < RESYNC_PAGES; i++) {
752 		rp->pages[i] = alloc_page(gfp_flags);
753 		if (!rp->pages[i])
754 			goto out_free;
755 	}
756 
757 	return 0;
758 
759 out_free:
760 	while (--i >= 0)
761 		put_page(rp->pages[i]);
762 	return -ENOMEM;
763 }
764 
765 static inline void resync_free_pages(struct resync_pages *rp)
766 {
767 	int i;
768 
769 	for (i = 0; i < RESYNC_PAGES; i++)
770 		put_page(rp->pages[i]);
771 }
772 
773 static inline void resync_get_all_pages(struct resync_pages *rp)
774 {
775 	int i;
776 
777 	for (i = 0; i < RESYNC_PAGES; i++)
778 		get_page(rp->pages[i]);
779 }
780 
781 static inline struct page *resync_fetch_page(struct resync_pages *rp,
782 					     unsigned idx)
783 {
784 	if (WARN_ON_ONCE(idx >= RESYNC_PAGES))
785 		return NULL;
786 	return rp->pages[idx];
787 }
788 #endif /* _MD_MD_H */
789