2 * Copyright (C) Sistina Software, Inc. 1997-2003 All rights reserved.
3 * Copyright (C) 2004-2006 Red Hat, Inc. All rights reserved.
5 * This copyrighted material is made available to anyone wishing to use,
6 * modify, copy, or redistribute it subject to the terms and conditions
7 * of the GNU General Public License version 2.
10 #include <linux/module.h>
11 #include <linux/slab.h>
12 #include <linux/spinlock.h>
13 #include <linux/completion.h>
14 #include <linux/buffer_head.h>
15 #include <linux/gfs2_ondisk.h>
16 #include <linux/crc32.h>
30 struct workqueue_struct
*gfs_recovery_wq
;
32 int gfs2_replay_read_block(struct gfs2_jdesc
*jd
, unsigned int blk
,
33 struct buffer_head
**bh
)
35 struct gfs2_inode
*ip
= GFS2_I(jd
->jd_inode
);
36 struct gfs2_glock
*gl
= ip
->i_gl
;
42 error
= gfs2_extent_map(&ip
->i_inode
, blk
, &new, &dblock
, &extlen
);
46 gfs2_consist_inode(ip
);
50 *bh
= gfs2_meta_ra(gl
, dblock
, extlen
);
55 int gfs2_revoke_add(struct gfs2_sbd
*sdp
, u64 blkno
, unsigned int where
)
57 struct list_head
*head
= &sdp
->sd_revoke_list
;
58 struct gfs2_revoke_replay
*rr
;
61 list_for_each_entry(rr
, head
, rr_list
) {
62 if (rr
->rr_blkno
== blkno
) {
73 rr
= kmalloc(sizeof(struct gfs2_revoke_replay
), GFP_NOFS
);
79 list_add(&rr
->rr_list
, head
);
84 int gfs2_revoke_check(struct gfs2_sbd
*sdp
, u64 blkno
, unsigned int where
)
86 struct gfs2_revoke_replay
*rr
;
87 int wrap
, a
, b
, revoke
;
90 list_for_each_entry(rr
, &sdp
->sd_revoke_list
, rr_list
) {
91 if (rr
->rr_blkno
== blkno
) {
100 wrap
= (rr
->rr_where
< sdp
->sd_replay_tail
);
101 a
= (sdp
->sd_replay_tail
< where
);
102 b
= (where
< rr
->rr_where
);
103 revoke
= (wrap
) ? (a
|| b
) : (a
&& b
);
108 void gfs2_revoke_clean(struct gfs2_sbd
*sdp
)
110 struct list_head
*head
= &sdp
->sd_revoke_list
;
111 struct gfs2_revoke_replay
*rr
;
113 while (!list_empty(head
)) {
114 rr
= list_entry(head
->next
, struct gfs2_revoke_replay
, rr_list
);
115 list_del(&rr
->rr_list
);
120 static int gfs2_log_header_in(struct gfs2_log_header_host
*lh
, const void *buf
)
122 const struct gfs2_log_header
*str
= buf
;
124 if (str
->lh_header
.mh_magic
!= cpu_to_be32(GFS2_MAGIC
) ||
125 str
->lh_header
.mh_type
!= cpu_to_be32(GFS2_METATYPE_LH
))
128 lh
->lh_sequence
= be64_to_cpu(str
->lh_sequence
);
129 lh
->lh_flags
= be32_to_cpu(str
->lh_flags
);
130 lh
->lh_tail
= be32_to_cpu(str
->lh_tail
);
131 lh
->lh_blkno
= be32_to_cpu(str
->lh_blkno
);
132 lh
->lh_hash
= be32_to_cpu(str
->lh_hash
);
137 * get_log_header - read the log header for a given segment
139 * @blk: the block to look at
140 * @lh: the log header to return
142 * Read the log header for a given segement in a given journal. Do a few
143 * sanity checks on it.
145 * Returns: 0 on success,
146 * 1 if the header was invalid or incomplete,
150 static int get_log_header(struct gfs2_jdesc
*jd
, unsigned int blk
,
151 struct gfs2_log_header_host
*head
)
153 struct buffer_head
*bh
;
154 struct gfs2_log_header_host
uninitialized_var(lh
);
155 const u32 nothing
= 0;
159 error
= gfs2_replay_read_block(jd
, blk
, &bh
);
163 hash
= crc32_le((u32
)~0, bh
->b_data
, sizeof(struct gfs2_log_header
) -
165 hash
= crc32_le(hash
, (unsigned char const *)¬hing
, sizeof(nothing
));
167 error
= gfs2_log_header_in(&lh
, bh
->b_data
);
170 if (error
|| lh
.lh_blkno
!= blk
|| lh
.lh_hash
!= hash
)
179 * find_good_lh - find a good log header
181 * @blk: the segment to start searching from
182 * @lh: the log header to fill in
183 * @forward: if true search forward in the log, else search backward
185 * Call get_log_header() to get a log header for a segment, but if the
186 * segment is bad, either scan forward or backward until we find a good one.
191 static int find_good_lh(struct gfs2_jdesc
*jd
, unsigned int *blk
,
192 struct gfs2_log_header_host
*head
)
194 unsigned int orig_blk
= *blk
;
198 error
= get_log_header(jd
, *blk
, head
);
202 if (++*blk
== jd
->jd_blocks
)
205 if (*blk
== orig_blk
) {
206 gfs2_consist_inode(GFS2_I(jd
->jd_inode
));
213 * jhead_scan - make sure we've found the head of the log
215 * @head: this is filled in with the log descriptor of the head
217 * At this point, seg and lh should be either the head of the log or just
218 * before. Scan forward until we find the head.
223 static int jhead_scan(struct gfs2_jdesc
*jd
, struct gfs2_log_header_host
*head
)
225 unsigned int blk
= head
->lh_blkno
;
226 struct gfs2_log_header_host lh
;
230 if (++blk
== jd
->jd_blocks
)
233 error
= get_log_header(jd
, blk
, &lh
);
239 if (lh
.lh_sequence
== head
->lh_sequence
) {
240 gfs2_consist_inode(GFS2_I(jd
->jd_inode
));
243 if (lh
.lh_sequence
< head
->lh_sequence
)
253 * gfs2_find_jhead - find the head of a log
255 * @head: the log descriptor for the head of the log is returned here
257 * Do a binary search of a journal and find the valid log entry with the
258 * highest sequence number. (i.e. the log head)
263 int gfs2_find_jhead(struct gfs2_jdesc
*jd
, struct gfs2_log_header_host
*head
)
265 struct gfs2_log_header_host lh_1
, lh_m
;
266 u32 blk_1
, blk_2
, blk_m
;
270 blk_2
= jd
->jd_blocks
- 1;
273 blk_m
= (blk_1
+ blk_2
) / 2;
275 error
= find_good_lh(jd
, &blk_1
, &lh_1
);
279 error
= find_good_lh(jd
, &blk_m
, &lh_m
);
283 if (blk_1
== blk_m
|| blk_m
== blk_2
)
286 if (lh_1
.lh_sequence
<= lh_m
.lh_sequence
)
292 error
= jhead_scan(jd
, &lh_1
);
302 * foreach_descriptor - go through the active part of the log
304 * @start: the first log header in the active region
305 * @end: the last log header (don't process the contents of this entry))
307 * Call a given function once for every log descriptor in the active
308 * portion of the log.
313 static int foreach_descriptor(struct gfs2_jdesc
*jd
, unsigned int start
,
314 unsigned int end
, int pass
)
316 struct gfs2_sbd
*sdp
= GFS2_SB(jd
->jd_inode
);
317 struct buffer_head
*bh
;
318 struct gfs2_log_descriptor
*ld
;
322 unsigned int offset
= sizeof(struct gfs2_log_descriptor
);
323 offset
+= sizeof(__be64
) - 1;
324 offset
&= ~(sizeof(__be64
) - 1);
326 while (start
!= end
) {
327 error
= gfs2_replay_read_block(jd
, start
, &bh
);
330 if (gfs2_meta_check(sdp
, bh
)) {
334 ld
= (struct gfs2_log_descriptor
*)bh
->b_data
;
335 length
= be32_to_cpu(ld
->ld_length
);
337 if (be32_to_cpu(ld
->ld_header
.mh_type
) == GFS2_METATYPE_LH
) {
338 struct gfs2_log_header_host lh
;
339 error
= get_log_header(jd
, start
, &lh
);
341 gfs2_replay_incr_blk(sdp
, &start
);
346 gfs2_consist_inode(GFS2_I(jd
->jd_inode
));
351 } else if (gfs2_metatype_check(sdp
, bh
, GFS2_METATYPE_LD
)) {
355 ptr
= (__be64
*)(bh
->b_data
+ offset
);
356 error
= lops_scan_elements(jd
, start
, ld
, ptr
, pass
);
363 gfs2_replay_incr_blk(sdp
, &start
);
372 * clean_journal - mark a dirty journal as being clean
373 * @sdp: the filesystem
375 * @gl: the journal's glock
376 * @head: the head journal to start from
381 static int clean_journal(struct gfs2_jdesc
*jd
, struct gfs2_log_header_host
*head
)
383 struct gfs2_inode
*ip
= GFS2_I(jd
->jd_inode
);
384 struct gfs2_sbd
*sdp
= GFS2_SB(jd
->jd_inode
);
386 struct gfs2_log_header
*lh
;
388 struct buffer_head
*bh
;
390 struct buffer_head bh_map
= { .b_state
= 0, .b_blocknr
= 0 };
392 lblock
= head
->lh_blkno
;
393 gfs2_replay_incr_blk(sdp
, &lblock
);
394 bh_map
.b_size
= 1 << ip
->i_inode
.i_blkbits
;
395 error
= gfs2_block_map(&ip
->i_inode
, lblock
, &bh_map
, 0);
398 if (!bh_map
.b_blocknr
) {
399 gfs2_consist_inode(ip
);
403 bh
= sb_getblk(sdp
->sd_vfs
, bh_map
.b_blocknr
);
405 memset(bh
->b_data
, 0, bh
->b_size
);
406 set_buffer_uptodate(bh
);
407 clear_buffer_dirty(bh
);
410 lh
= (struct gfs2_log_header
*)bh
->b_data
;
411 memset(lh
, 0, sizeof(struct gfs2_log_header
));
412 lh
->lh_header
.mh_magic
= cpu_to_be32(GFS2_MAGIC
);
413 lh
->lh_header
.mh_type
= cpu_to_be32(GFS2_METATYPE_LH
);
414 lh
->lh_header
.__pad0
= cpu_to_be64(0);
415 lh
->lh_header
.mh_format
= cpu_to_be32(GFS2_FORMAT_LH
);
416 lh
->lh_header
.mh_jid
= cpu_to_be32(sdp
->sd_jdesc
->jd_jid
);
417 lh
->lh_sequence
= cpu_to_be64(head
->lh_sequence
+ 1);
418 lh
->lh_flags
= cpu_to_be32(GFS2_LOG_HEAD_UNMOUNT
);
419 lh
->lh_blkno
= cpu_to_be32(lblock
);
420 hash
= gfs2_disk_hash((const char *)lh
, sizeof(struct gfs2_log_header
));
421 lh
->lh_hash
= cpu_to_be32(hash
);
423 set_buffer_dirty(bh
);
424 if (sync_dirty_buffer(bh
))
425 gfs2_io_error_bh(sdp
, bh
);
432 static void gfs2_recovery_done(struct gfs2_sbd
*sdp
, unsigned int jid
,
433 unsigned int message
)
437 char *envp
[] = { env_jid
, env_status
, NULL
};
438 struct lm_lockstruct
*ls
= &sdp
->sd_lockstruct
;
440 ls
->ls_recover_jid_done
= jid
;
441 ls
->ls_recover_jid_status
= message
;
442 sprintf(env_jid
, "JID=%d", jid
);
443 sprintf(env_status
, "RECOVERY=%s",
444 message
== LM_RD_SUCCESS
? "Done" : "Failed");
445 kobject_uevent_env(&sdp
->sd_kobj
, KOBJ_CHANGE
, envp
);
447 if (sdp
->sd_lockstruct
.ls_ops
->lm_recovery_result
)
448 sdp
->sd_lockstruct
.ls_ops
->lm_recovery_result(sdp
, jid
, message
);
451 void gfs2_recover_func(struct work_struct
*work
)
453 struct gfs2_jdesc
*jd
= container_of(work
, struct gfs2_jdesc
, jd_work
);
454 struct gfs2_inode
*ip
= GFS2_I(jd
->jd_inode
);
455 struct gfs2_sbd
*sdp
= GFS2_SB(jd
->jd_inode
);
456 struct gfs2_log_header_host head
;
457 struct gfs2_holder j_gh
, ji_gh
, t_gh
;
464 if (sdp
->sd_args
.ar_spectator
||
465 (jd
->jd_jid
!= sdp
->sd_lockstruct
.ls_jid
)) {
466 fs_info(sdp
, "jid=%u: Trying to acquire journal lock...\n",
469 /* Acquire the journal lock so we can do recovery */
471 error
= gfs2_glock_nq_num(sdp
, jd
->jd_jid
, &gfs2_journal_glops
,
473 LM_FLAG_NOEXP
| LM_FLAG_TRY
| GL_NOCACHE
,
480 fs_info(sdp
, "jid=%u: Busy\n", jd
->jd_jid
);
487 error
= gfs2_glock_nq_init(ip
->i_gl
, LM_ST_SHARED
,
488 LM_FLAG_NOEXP
| GL_NOCACHE
, &ji_gh
);
492 fs_info(sdp
, "jid=%u, already locked for use\n", jd
->jd_jid
);
495 fs_info(sdp
, "jid=%u: Looking at journal...\n", jd
->jd_jid
);
497 error
= gfs2_jdesc_check(jd
);
499 goto fail_gunlock_ji
;
501 error
= gfs2_find_jhead(jd
, &head
);
503 goto fail_gunlock_ji
;
505 if (!(head
.lh_flags
& GFS2_LOG_HEAD_UNMOUNT
)) {
506 fs_info(sdp
, "jid=%u: Acquiring the transaction lock...\n",
511 /* Acquire a shared hold on the transaction lock */
513 error
= gfs2_glock_nq_init(sdp
->sd_trans_gl
, LM_ST_SHARED
,
514 LM_FLAG_NOEXP
| LM_FLAG_PRIORITY
|
517 goto fail_gunlock_ji
;
519 if (test_bit(SDF_RORECOVERY
, &sdp
->sd_flags
)) {
521 } else if (test_bit(SDF_JOURNAL_CHECKED
, &sdp
->sd_flags
)) {
522 if (!test_bit(SDF_JOURNAL_LIVE
, &sdp
->sd_flags
))
525 if (sdp
->sd_vfs
->s_flags
& MS_RDONLY
) {
526 /* check if device itself is read-only */
527 ro
= bdev_read_only(sdp
->sd_vfs
->s_bdev
);
529 fs_info(sdp
, "recovery required on "
530 "read-only filesystem.\n");
531 fs_info(sdp
, "write access will be "
532 "enabled during recovery.\n");
538 fs_warn(sdp
, "jid=%u: Can't replay: read-only block "
539 "device\n", jd
->jd_jid
);
541 goto fail_gunlock_tr
;
544 fs_info(sdp
, "jid=%u: Replaying journal...\n", jd
->jd_jid
);
546 for (pass
= 0; pass
< 2; pass
++) {
547 lops_before_scan(jd
, &head
, pass
);
548 error
= foreach_descriptor(jd
, head
.lh_tail
,
549 head
.lh_blkno
, pass
);
550 lops_after_scan(jd
, error
, pass
);
552 goto fail_gunlock_tr
;
555 error
= clean_journal(jd
, &head
);
557 goto fail_gunlock_tr
;
559 gfs2_glock_dq_uninit(&t_gh
);
560 t
= DIV_ROUND_UP(jiffies
- t
, HZ
);
561 fs_info(sdp
, "jid=%u: Journal replayed in %lus\n",
565 gfs2_recovery_done(sdp
, jd
->jd_jid
, LM_RD_SUCCESS
);
568 gfs2_glock_dq_uninit(&ji_gh
);
569 gfs2_glock_dq_uninit(&j_gh
);
572 fs_info(sdp
, "jid=%u: Done\n", jd
->jd_jid
);
576 gfs2_glock_dq_uninit(&t_gh
);
579 gfs2_glock_dq_uninit(&ji_gh
);
581 gfs2_glock_dq_uninit(&j_gh
);
584 fs_info(sdp
, "jid=%u: %s\n", jd
->jd_jid
, (error
) ? "Failed" : "Done");
586 jd
->jd_recover_error
= error
;
587 gfs2_recovery_done(sdp
, jd
->jd_jid
, LM_RD_GAVEUP
);
589 clear_bit(JDF_RECOVERY
, &jd
->jd_flags
);
590 smp_mb__after_clear_bit();
591 wake_up_bit(&jd
->jd_flags
, JDF_RECOVERY
);
594 static int gfs2_recovery_wait(void *word
)
600 int gfs2_recover_journal(struct gfs2_jdesc
*jd
, bool wait
)
604 if (test_and_set_bit(JDF_RECOVERY
, &jd
->jd_flags
))
607 /* we have JDF_RECOVERY, queue should always succeed */
608 rv
= queue_work(gfs_recovery_wq
, &jd
->jd_work
);
612 wait_on_bit(&jd
->jd_flags
, JDF_RECOVERY
, gfs2_recovery_wait
,
613 TASK_UNINTERRUPTIBLE
);
615 return wait
? jd
->jd_recover_error
: 0;