]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - drivers/md/md.h
md: md_unregister_thread should cope with being passed NULL
[mirror_ubuntu-artful-kernel.git] / drivers / md / md.h
CommitLineData
1da177e4
LT
1/*
2 md_k.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_K_H
16#define _MD_K_H
17
9361401e
DH
18#ifdef CONFIG_BLOCK
19
1da177e4 20#define MaxSector (~(sector_t)0)
1da177e4 21
1da177e4
LT
22typedef struct mddev_s mddev_t;
23typedef struct mdk_rdev_s mdk_rdev_t;
24
1da177e4
LT
25/*
26 * options passed in raidrun:
27 */
28
e8703fe1 29/* Currently this must fit in an 'int' */
8932c2e0 30#define MAX_CHUNK_SIZE (1<<30)
1da177e4 31
1da177e4
LT
32/*
33 * MD's 'extended' device
34 */
35struct mdk_rdev_s
36{
37 struct list_head same_set; /* RAID devices within the same set */
38
dd8ac336 39 sector_t sectors; /* Device size (in 512bytes sectors) */
1da177e4 40 mddev_t *mddev; /* RAID array if running */
eea1bf38 41 int last_events; /* IO event timestamp */
1da177e4
LT
42
43 struct block_device *bdev; /* block device handle */
44
45 struct page *sb_page;
46 int sb_loaded;
42543769 47 __u64 sb_events;
1da177e4 48 sector_t data_offset; /* start of data in array */
0f420358 49 sector_t sb_start; /* offset of the super block (in 512byte sectors) */
0002b271 50 int sb_size; /* bytes in the superblock */
1da177e4
LT
51 int preferred_minor; /* autorun support */
52
86e6ffdd
N
53 struct kobject kobj;
54
1da177e4
LT
55 /* A device can be in one of three states based on two flags:
56 * Not working: faulty==1 in_sync==0
57 * Fully working: faulty==0 in_sync==1
58 * Working, but not
59 * in sync with array
60 * faulty==0 in_sync==0
61 *
62 * It can never have faulty==1, in_sync==1
63 * This reduces the burden of testing multiple flags in many cases
64 */
1da177e4 65
b2d444d7
N
66 unsigned long flags;
67#define Faulty 1 /* device is known to have a fault */
68#define In_sync 2 /* device is in_sync with rest of array */
8ddf9efe 69#define WriteMostly 4 /* Avoid reading if at all possible */
a9701a30 70#define BarriersNotsupp 5 /* BIO_RW_BARRIER is not supported */
c5d79adb
N
71#define AllReserved 6 /* If whole device is reserved for
72 * one array */
d0fae18f 73#define AutoDetected 7 /* added by auto-detect */
6bfe0b49
DW
74#define Blocked 8 /* An error occured on an externally
75 * managed array, don't allow writes
76 * until it is cleared */
52664732
NB
77#define StateChanged 9 /* Faulty or Blocked has changed during
78 * interrupt, so it needs to be
79 * notified by the thread */
6bfe0b49 80 wait_queue_head_t blocked_wait;
8ddf9efe 81
1da177e4
LT
82 int desc_nr; /* descriptor index in the superblock */
83 int raid_disk; /* role of device in array */
41158c7e
N
84 int saved_raid_disk; /* role that device used to have in the
85 * array and could again if we did a partial
86 * resync from the bitmap
87 */
5fd6c1dc
N
88 sector_t recovery_offset;/* If this device has been partially
89 * recovered, this is where we were
90 * up to.
91 */
1da177e4
LT
92
93 atomic_t nr_pending; /* number of pending requests.
94 * only maintained for arrays that
95 * support hot removal
96 */
ba22dcbf
N
97 atomic_t read_errors; /* number of consecutive read errors that
98 * we have tried to ignore.
99 */
4dbcdc75
N
100 atomic_t corrected_errors; /* number of corrected read errors,
101 * for reporting to userspace and storing
102 * in superblock.
103 */
5792a285 104 struct work_struct del_work; /* used for delayed sysfs removal */
3c0ee63a
N
105
106 struct sysfs_dirent *sysfs_state; /* handle for 'state'
107 * sysfs entry */
1da177e4
LT
108};
109
1da177e4
LT
110struct mddev_s
111{
112 void *private;
2604b703 113 struct mdk_personality *pers;
1da177e4
LT
114 dev_t unit;
115 int md_minor;
116 struct list_head disks;
850b2b42
N
117 unsigned long flags;
118#define MD_CHANGE_DEVS 0 /* Some device status has changed */
119#define MD_CHANGE_CLEAN 1 /* transition to or from 'clean' */
120#define MD_CHANGE_PENDING 2 /* superblock update in progress */
121
1da177e4
LT
122 int ro;
123
124 struct gendisk *gendisk;
125
eae1701f 126 struct kobject kobj;
d3374825
N
127 int hold_active;
128#define UNTIL_IOCTL 1
efeb53c0 129#define UNTIL_STOP 2
eae1701f 130
1da177e4
LT
131 /* Superblock information */
132 int major_version,
133 minor_version,
134 patch_version;
135 int persistent;
e691063a
N
136 int external; /* metadata is
137 * managed externally */
138 char metadata_type[17]; /* externally set*/
1da177e4
LT
139 int chunk_size;
140 time_t ctime, utime;
141 int level, layout;
d9d166c2 142 char clevel[16];
1da177e4
LT
143 int raid_disks;
144 int max_disks;
58c0fed4
AN
145 sector_t dev_sectors; /* used size of
146 * component devices */
f233ea5c 147 sector_t array_sectors; /* exported array size */
1da177e4
LT
148 __u64 events;
149
150 char uuid[16];
151
f6705578
N
152 /* If the array is being reshaped, we need to record the
153 * new shape and an indication of where we are up to.
154 * This is written to the superblock.
155 * If reshape_position is MaxSector, then no reshape is happening (yet).
156 */
157 sector_t reshape_position;
158 int delta_disks, new_level, new_layout, new_chunk;
159
1da177e4
LT
160 struct mdk_thread_s *thread; /* management thread */
161 struct mdk_thread_s *sync_thread; /* doing resync or reconstruct */
ff4e8d9a 162 sector_t curr_resync; /* last block scheduled */
97e4f42d
N
163 /* As resync requests can complete out of order, we cannot easily track
164 * how much resync has been completed. So we occasionally pause until
165 * everything completes, then set curr_resync_completed to curr_resync.
166 * As such it may be well behind the real resync mark, but it is a value
167 * we are certain of.
168 */
169 sector_t curr_resync_completed;
1da177e4
LT
170 unsigned long resync_mark; /* a recent timestamp */
171 sector_t resync_mark_cnt;/* blocks written at resync_mark */
ff4e8d9a 172 sector_t curr_mark_cnt; /* blocks scheduled now */
1da177e4
LT
173
174 sector_t resync_max_sectors; /* may be set by personality */
9d88883e
N
175
176 sector_t resync_mismatches; /* count of sectors where
177 * parity/replica mismatch found
178 */
e464eafd
N
179
180 /* allow user-space to request suspension of IO to regions of the array */
181 sector_t suspend_lo;
182 sector_t suspend_hi;
88202a0c
N
183 /* if zero, use the system-wide default */
184 int sync_speed_min;
185 int sync_speed_max;
186
90b08710
BS
187 /* resync even though the same disks are shared among md-devices */
188 int parallel_resync;
189
6ff8d8ec 190 int ok_start_degraded;
1da177e4
LT
191 /* recovery/resync flags
192 * NEEDED: we might need to start a resync/recover
193 * RUNNING: a thread is running, or about to be started
194 * SYNC: actually doing a resync, not a recovery
72a23c21 195 * RECOVER: doing recovery, or need to try it.
dfc70645 196 * INTR: resync needs to be aborted for some reason
1da177e4 197 * DONE: thread is done and is waiting to be reaped
24dd469d
N
198 * REQUEST: user-space has requested a sync (used with SYNC)
199 * CHECK: user-space request for for check-only, no repair
ccfcc3c1
N
200 * RESHAPE: A reshape is happening
201 *
202 * If neither SYNC or RESHAPE are set, then it is a recovery.
1da177e4
LT
203 */
204#define MD_RECOVERY_RUNNING 0
205#define MD_RECOVERY_SYNC 1
72a23c21 206#define MD_RECOVERY_RECOVER 2
1da177e4
LT
207#define MD_RECOVERY_INTR 3
208#define MD_RECOVERY_DONE 4
209#define MD_RECOVERY_NEEDED 5
24dd469d
N
210#define MD_RECOVERY_REQUESTED 6
211#define MD_RECOVERY_CHECK 7
ccfcc3c1 212#define MD_RECOVERY_RESHAPE 8
5fd6c1dc
N
213#define MD_RECOVERY_FROZEN 9
214
1da177e4 215 unsigned long recovery;
4044ba58
N
216 int recovery_disabled; /* if we detect that recovery
217 * will always fail, set this
218 * so we don't loop trying */
1da177e4
LT
219
220 int in_sync; /* know to not need resync */
df5b89b3 221 struct mutex reconfig_mutex;
f2ea68cf
N
222 atomic_t active; /* general refcount */
223 atomic_t openers; /* number of active opens */
1da177e4 224
44ce6294 225 int changed; /* true if we might need to reread partition info */
1da177e4
LT
226 int degraded; /* whether md should consider
227 * adding a spare
228 */
a9701a30
N
229 int barriers_work; /* initialised to true, cleared as soon
230 * as a barrier request to slave
231 * fails. Only supported
232 */
233 struct bio *biolist; /* bios that need to be retried
234 * because BIO_RW_BARRIER is not supported
235 */
1da177e4
LT
236
237 atomic_t recovery_active; /* blocks scheduled, but not written */
238 wait_queue_head_t recovery_wait;
239 sector_t recovery_cp;
5e96ee65
NB
240 sector_t resync_min; /* user requested sync
241 * starts here */
c6207277
N
242 sector_t resync_max; /* resync should pause
243 * when it gets here */
06d91a5f 244
b62b7590
N
245 struct sysfs_dirent *sysfs_state; /* handle for 'array_state'
246 * file in sysfs.
247 */
0c3573f1 248 struct sysfs_dirent *sysfs_action; /* handle for 'sync_action' */
b62b7590 249
d3374825
N
250 struct work_struct del_work; /* used for delayed sysfs removal */
251
06d91a5f 252 spinlock_t write_lock;
3d310eb7 253 wait_queue_head_t sb_wait; /* for waiting on superblock updates */
7bfa19f2 254 atomic_t pending_writes; /* number of active superblock writes */
06d91a5f 255
1da177e4
LT
256 unsigned int safemode; /* if set, update "clean" superblock
257 * when no writes pending.
258 */
259 unsigned int safemode_delay;
260 struct timer_list safemode_timer;
261 atomic_t writes_pending;
165125e1 262 struct request_queue *queue; /* for plugging ... */
1da177e4 263
4b6d287f
N
264 atomic_t write_behind; /* outstanding async IO */
265 unsigned int max_write_behind; /* 0 = sync */
266
32a7627c
N
267 struct bitmap *bitmap; /* the bitmap for the device */
268 struct file *bitmap_file; /* the bitmap file */
a654b9d8
N
269 long bitmap_offset; /* offset from superblock of
270 * start of bitmap. May be
271 * negative, but not '0'
272 */
36fa3063
N
273 long default_bitmap_offset; /* this is the offset to use when
274 * hot-adding a bitmap. It should
275 * eventually be settable by sysfs.
276 */
32a7627c 277
1da177e4
LT
278 struct list_head all_mddevs;
279};
280
281
282static inline void rdev_dec_pending(mdk_rdev_t *rdev, mddev_t *mddev)
283{
b2d444d7 284 int faulty = test_bit(Faulty, &rdev->flags);
1da177e4
LT
285 if (atomic_dec_and_test(&rdev->nr_pending) && faulty)
286 set_bit(MD_RECOVERY_NEEDED, &mddev->recovery);
287}
288
289static inline void md_sync_acct(struct block_device *bdev, unsigned long nr_sectors)
290{
291 atomic_add(nr_sectors, &bdev->bd_contains->bd_disk->sync_io);
292}
293
2604b703 294struct mdk_personality
1da177e4
LT
295{
296 char *name;
2604b703
N
297 int level;
298 struct list_head list;
1da177e4 299 struct module *owner;
165125e1 300 int (*make_request)(struct request_queue *q, struct bio *bio);
1da177e4
LT
301 int (*run)(mddev_t *mddev);
302 int (*stop)(mddev_t *mddev);
303 void (*status)(struct seq_file *seq, mddev_t *mddev);
304 /* error_handler must set ->faulty and clear ->in_sync
305 * if appropriate, and should abort recovery if needed
306 */
307 void (*error_handler)(mddev_t *mddev, mdk_rdev_t *rdev);
308 int (*hot_add_disk) (mddev_t *mddev, mdk_rdev_t *rdev);
309 int (*hot_remove_disk) (mddev_t *mddev, int number);
310 int (*spare_active) (mddev_t *mddev);
57afd89f 311 sector_t (*sync_request)(mddev_t *mddev, sector_t sector_nr, int *skipped, int go_faster);
1da177e4 312 int (*resize) (mddev_t *mddev, sector_t sectors);
63c70c4f
N
313 int (*check_reshape) (mddev_t *mddev);
314 int (*start_reshape) (mddev_t *mddev);
1da177e4 315 int (*reconfig) (mddev_t *mddev, int layout, int chunk_size);
36fa3063
N
316 /* quiesce moves between quiescence states
317 * 0 - fully active
318 * 1 - no new requests allowed
319 * others - reserved
320 */
321 void (*quiesce) (mddev_t *mddev, int state);
1da177e4
LT
322};
323
324
007583c9
N
325struct md_sysfs_entry {
326 struct attribute attr;
327 ssize_t (*show)(mddev_t *, char *);
328 ssize_t (*store)(mddev_t *, const char *, size_t);
329};
330
331
1da177e4
LT
332static inline char * mdname (mddev_t * mddev)
333{
334 return mddev->gendisk ? mddev->gendisk->disk_name : "mdX";
335}
336
1da177e4
LT
337/*
338 * iterates through some rdev ringlist. It's safe to remove the
339 * current 'rdev'. Dont touch 'tmp' though.
340 */
159ec1fc
CR
341#define rdev_for_each_list(rdev, tmp, head) \
342 list_for_each_entry_safe(rdev, tmp, head, same_set)
343
1da177e4
LT
344/*
345 * iterates through the 'same array disks' ringlist
346 */
d089c6af 347#define rdev_for_each(rdev, tmp, mddev) \
159ec1fc 348 list_for_each_entry_safe(rdev, tmp, &((mddev)->disks), same_set)
1da177e4 349
4b80991c
N
350#define rdev_for_each_rcu(rdev, mddev) \
351 list_for_each_entry_rcu(rdev, &((mddev)->disks), same_set)
352
1da177e4
LT
353typedef struct mdk_thread_s {
354 void (*run) (mddev_t *mddev);
355 mddev_t *mddev;
356 wait_queue_head_t wqueue;
357 unsigned long flags;
1da177e4 358 struct task_struct *tsk;
32a7627c 359 unsigned long timeout;
1da177e4
LT
360} mdk_thread_t;
361
362#define THREAD_WAKEUP 0
363
364#define __wait_event_lock_irq(wq, condition, lock, cmd) \
365do { \
366 wait_queue_t __wait; \
367 init_waitqueue_entry(&__wait, current); \
368 \
369 add_wait_queue(&wq, &__wait); \
370 for (;;) { \
371 set_current_state(TASK_UNINTERRUPTIBLE); \
372 if (condition) \
373 break; \
374 spin_unlock_irq(&lock); \
375 cmd; \
376 schedule(); \
377 spin_lock_irq(&lock); \
378 } \
379 current->state = TASK_RUNNING; \
380 remove_wait_queue(&wq, &__wait); \
381} while (0)
382
383#define wait_event_lock_irq(wq, condition, lock, cmd) \
384do { \
385 if (condition) \
386 break; \
387 __wait_event_lock_irq(wq, condition, lock, cmd); \
388} while (0)
389
1345b1d8
N
390static inline void safe_put_page(struct page *p)
391{
392 if (p) put_page(p);
393}
394
9361401e 395#endif /* CONFIG_BLOCK */
1da177e4
LT
396#endif
397
92022950
N
398
399extern int register_md_personality(struct mdk_personality *p);
400extern int unregister_md_personality(struct mdk_personality *p);
401extern mdk_thread_t * md_register_thread(void (*run) (mddev_t *mddev),
402 mddev_t *mddev, const char *name);
403extern void md_unregister_thread(mdk_thread_t *thread);
404extern void md_wakeup_thread(mdk_thread_t *thread);
405extern void md_check_recovery(mddev_t *mddev);
406extern void md_write_start(mddev_t *mddev, struct bio *bi);
407extern void md_write_end(mddev_t *mddev);
408extern void md_done_sync(mddev_t *mddev, int blocks, int ok);
409extern void md_error(mddev_t *mddev, mdk_rdev_t *rdev);
410
411extern void md_super_write(mddev_t *mddev, mdk_rdev_t *rdev,
412 sector_t sector, int size, struct page *page);
413extern void md_super_wait(mddev_t *mddev);
414extern int sync_page_io(struct block_device *bdev, sector_t sector, int size,
415 struct page *page, int rw);
416extern void md_do_sync(mddev_t *mddev);
417extern void md_new_event(mddev_t *mddev);
418extern int md_allow_write(mddev_t *mddev);
419extern void md_wait_for_blocked_rdev(mdk_rdev_t *rdev, mddev_t *mddev);