2 * Copyright (C) International Business Machines Corp., 2000-2004
3 * Portions Copyright (C) Christoph Hellwig, 2001-2002
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 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
13 * the GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 * jfs_logmgr.c: log manager
23 * for related information, see transaction manager (jfs_txnmgr.c), and
24 * recovery manager (jfs_logredo.c).
26 * note: for detail, RTFS.
29 * special purpose buffer manager supporting log i/o requirements.
30 * per log serial pageout of logpage
31 * queuing i/o requests and redrive i/o at iodone
32 * maintain current logpage buffer
33 * no caching since append only
34 * appropriate jfs buffer cache buffers as needed
37 * transactions which wrote COMMIT records in the same in-memory
38 * log page during the pageout of previous/current log page(s) are
39 * committed together by the pageout of the page.
42 * transactions are committed asynchronously when the log page
43 * containing it COMMIT is paged out when it becomes full;
46 * . a per log lock serialize log write.
47 * . a per log lock serialize group commit.
48 * . a per log lock serialize log open/close;
51 * careful-write (ping-pong) of last logpage to recover from crash
53 * detection of split (out-of-order) write of physical sectors
54 * of last logpage via timestamp at end of each sector
55 * with its mirror data array at trailer).
58 * lsn - 64-bit monotonically increasing integer vs
59 * 32-bit lspn and page eor.
63 #include <linux/blkdev.h>
64 #include <linux/interrupt.h>
65 #include <linux/completion.h>
66 #include <linux/kthread.h>
67 #include <linux/buffer_head.h> /* for sync_blockdev() */
68 #include <linux/bio.h>
69 #include <linux/freezer.h>
70 #include <linux/export.h>
71 #include <linux/delay.h>
72 #include <linux/mutex.h>
73 #include <linux/seq_file.h>
74 #include <linux/slab.h>
75 #include "jfs_incore.h"
76 #include "jfs_filsys.h"
77 #include "jfs_metapage.h"
78 #include "jfs_superblock.h"
79 #include "jfs_txnmgr.h"
80 #include "jfs_debug.h"
84 * lbuf's ready to be redriven. Protected by log_redrive_lock (jfsIO thread)
86 static struct lbuf *log_redrive_list;
87 static DEFINE_SPINLOCK(log_redrive_lock);
91 * log read/write serialization (per log)
93 #define LOG_LOCK_INIT(log) mutex_init(&(log)->loglock)
94 #define LOG_LOCK(log) mutex_lock(&((log)->loglock))
95 #define LOG_UNLOCK(log) mutex_unlock(&((log)->loglock))
99 * log group commit serialization (per log)
102 #define LOGGC_LOCK_INIT(log) spin_lock_init(&(log)->gclock)
103 #define LOGGC_LOCK(log) spin_lock_irq(&(log)->gclock)
104 #define LOGGC_UNLOCK(log) spin_unlock_irq(&(log)->gclock)
105 #define LOGGC_WAKEUP(tblk) wake_up_all(&(tblk)->gcwait)
108 * log sync serialization (per log)
110 #define LOGSYNC_DELTA(logsize) min((logsize)/8, 128*LOGPSIZE)
111 #define LOGSYNC_BARRIER(logsize) ((logsize)/4)
113 #define LOGSYNC_DELTA(logsize) min((logsize)/4, 256*LOGPSIZE)
114 #define LOGSYNC_BARRIER(logsize) ((logsize)/2)
119 * log buffer cache synchronization
121 static DEFINE_SPINLOCK(jfsLCacheLock);
123 #define LCACHE_LOCK(flags) spin_lock_irqsave(&jfsLCacheLock, flags)
124 #define LCACHE_UNLOCK(flags) spin_unlock_irqrestore(&jfsLCacheLock, flags)
127 * See __SLEEP_COND in jfs_locks.h
129 #define LCACHE_SLEEP_COND(wq, cond, flags) \
133 __SLEEP_COND(wq, cond, LCACHE_LOCK(flags), LCACHE_UNLOCK(flags)); \
136 #define LCACHE_WAKEUP(event) wake_up(event)
140 * lbuf buffer cache (lCache) control
142 /* log buffer manager pageout control (cumulative, inclusive) */
143 #define lbmREAD 0x0001
144 #define lbmWRITE 0x0002 /* enqueue at tail of write queue;
145 * init pageout if at head of queue;
147 #define lbmRELEASE 0x0004 /* remove from write queue
148 * at completion of pageout;
149 * do not free/recycle it yet:
150 * caller will free it;
152 #define lbmSYNC 0x0008 /* do not return to freelist
153 * when removed from write queue;
155 #define lbmFREE 0x0010 /* return to freelist
156 * at completion of pageout;
157 * the buffer may be recycled;
159 #define lbmDONE 0x0020
160 #define lbmERROR 0x0040
161 #define lbmGC 0x0080 /* lbmIODone to perform post-GC processing
164 #define lbmDIRECT 0x0100
167 * Global list of active external journals
169 static LIST_HEAD(jfs_external_logs);
170 static struct jfs_log *dummy_log = NULL;
171 static DEFINE_MUTEX(jfs_log_mutex);
176 static int lmWriteRecord(struct jfs_log * log, struct tblock * tblk,
177 struct lrd * lrd, struct tlock * tlck);
179 static int lmNextPage(struct jfs_log * log);
180 static int lmLogFileSystem(struct jfs_log * log, struct jfs_sb_info *sbi,
183 static int open_inline_log(struct super_block *sb);
184 static int open_dummy_log(struct super_block *sb);
185 static int lbmLogInit(struct jfs_log * log);
186 static void lbmLogShutdown(struct jfs_log * log);
187 static struct lbuf *lbmAllocate(struct jfs_log * log, int);
188 static void lbmFree(struct lbuf * bp);
189 static void lbmfree(struct lbuf * bp);
190 static int lbmRead(struct jfs_log * log, int pn, struct lbuf ** bpp);
191 static void lbmWrite(struct jfs_log * log, struct lbuf * bp, int flag, int cant_block);
192 static void lbmDirectWrite(struct jfs_log * log, struct lbuf * bp, int flag);
193 static int lbmIOWait(struct lbuf * bp, int flag);
194 static bio_end_io_t lbmIODone;
195 static void lbmStartIO(struct lbuf * bp);
196 static void lmGCwrite(struct jfs_log * log, int cant_block);
197 static int lmLogSync(struct jfs_log * log, int hard_sync);
204 #ifdef CONFIG_JFS_STATISTICS
205 static struct lmStat {
206 uint commit; /* # of commit */
207 uint pagedone; /* # of page written */
208 uint submitted; /* # of pages submitted */
209 uint full_page; /* # of full pages submitted */
210 uint partial_page; /* # of partial pages submitted */
214 static void write_special_inodes(struct jfs_log *log,
215 int (*writer)(struct address_space *))
217 struct jfs_sb_info *sbi;
219 list_for_each_entry(sbi, &log->sb_list, log_list) {
220 writer(sbi->ipbmap->i_mapping);
221 writer(sbi->ipimap->i_mapping);
222 writer(sbi->direct_inode->i_mapping);
229 * FUNCTION: write a log record;
233 * RETURN: lsn - offset to the next log record to write (end-of-log);
236 * note: todo: log error handler
238 int lmLog(struct jfs_log * log, struct tblock * tblk, struct lrd * lrd,
243 struct metapage *mp = NULL;
246 jfs_info("lmLog: log:0x%p tblk:0x%p, lrd:0x%p tlck:0x%p",
247 log, tblk, lrd, tlck);
251 /* log by (out-of-transaction) JFS ? */
255 /* log from page ? */
257 tlck->type & tlckBTROOT || (mp = tlck->mp) == NULL)
261 * initialize/update page/transaction recovery lsn
265 LOGSYNC_LOCK(log, flags);
268 * initialize page lsn if first log write of the page
275 /* insert page at tail of logsynclist */
276 list_add_tail(&mp->synclist, &log->synclist);
280 * initialize/update lsn of tblock of the page
282 * transaction inherits oldest lsn of pages associated
283 * with allocation/deallocation of resources (their
284 * log records are used to reconstruct allocation map
285 * at recovery time: inode for inode allocation map,
286 * B+-tree index of extent descriptors for block
288 * allocation map pages inherit transaction lsn at
289 * commit time to allow forwarding log syncpt past log
290 * records associated with allocation/deallocation of
291 * resources only after persistent map of these map pages
292 * have been updated and propagated to home.
295 * initialize transaction lsn:
297 if (tblk->lsn == 0) {
298 /* inherit lsn of its first page logged */
302 /* insert tblock after the page on logsynclist */
303 list_add(&tblk->synclist, &mp->synclist);
306 * update transaction lsn:
309 /* inherit oldest/smallest lsn of page */
310 logdiff(diffp, mp->lsn, log);
311 logdiff(difft, tblk->lsn, log);
313 /* update tblock lsn with page lsn */
316 /* move tblock after page on logsynclist */
317 list_move(&tblk->synclist, &mp->synclist);
321 LOGSYNC_UNLOCK(log, flags);
324 * write the log record
327 lsn = lmWriteRecord(log, tblk, lrd, tlck);
330 * forward log syncpt if log reached next syncpt trigger
332 logdiff(diffp, lsn, log);
333 if (diffp >= log->nextsync)
334 lsn = lmLogSync(log, 0);
336 /* update end-of-log lsn */
341 /* return end-of-log address */
346 * NAME: lmWriteRecord()
348 * FUNCTION: move the log record to current log page
350 * PARAMETER: cd - commit descriptor
352 * RETURN: end-of-log address
354 * serialization: LOG_LOCK() held on entry/exit
357 lmWriteRecord(struct jfs_log * log, struct tblock * tblk, struct lrd * lrd,
360 int lsn = 0; /* end-of-log address */
361 struct lbuf *bp; /* dst log page buffer */
362 struct logpage *lp; /* dst log page */
363 caddr_t dst; /* destination address in log page */
364 int dstoffset; /* end-of-log offset in log page */
365 int freespace; /* free space in log page */
366 caddr_t p; /* src meta-data page */
369 int nbytes; /* number of bytes to move */
372 struct linelock *linelock;
379 /* retrieve destination log page to write */
380 bp = (struct lbuf *) log->bp;
381 lp = (struct logpage *) bp->l_ldata;
382 dstoffset = log->eor;
384 /* any log data to write ? */
389 * move log record data
391 /* retrieve source meta-data page to log */
392 if (tlck->flag & tlckPAGELOCK) {
393 p = (caddr_t) (tlck->mp->data);
394 linelock = (struct linelock *) & tlck->lock;
396 /* retrieve source in-memory inode to log */
397 else if (tlck->flag & tlckINODELOCK) {
398 if (tlck->type & tlckDTREE)
399 p = (caddr_t) &JFS_IP(tlck->ip)->i_dtroot;
401 p = (caddr_t) &JFS_IP(tlck->ip)->i_xtroot;
402 linelock = (struct linelock *) & tlck->lock;
405 else if (tlck->flag & tlckINLINELOCK) {
407 inlinelock = (struct inlinelock *) & tlck;
408 p = (caddr_t) & inlinelock->pxd;
409 linelock = (struct linelock *) & tlck;
411 #endif /* _JFS_WIP */
413 jfs_err("lmWriteRecord: UFO tlck:0x%p", tlck);
414 return 0; /* Probably should trap */
416 l2linesize = linelock->l2linesize;
419 ASSERT(linelock->index <= linelock->maxcnt);
422 for (i = 0; i < linelock->index; i++, lv++) {
427 if (dstoffset >= LOGPSIZE - LOGPTLRSIZE) {
428 /* page become full: move on to next page */
432 lp = (struct logpage *) bp->l_ldata;
433 dstoffset = LOGPHDRSIZE;
437 * move log vector data
439 src = (u8 *) p + (lv->offset << l2linesize);
440 srclen = lv->length << l2linesize;
443 freespace = (LOGPSIZE - LOGPTLRSIZE) - dstoffset;
444 nbytes = min(freespace, srclen);
445 dst = (caddr_t) lp + dstoffset;
446 memcpy(dst, src, nbytes);
449 /* is page not full ? */
450 if (dstoffset < LOGPSIZE - LOGPTLRSIZE)
453 /* page become full: move on to next page */
456 bp = (struct lbuf *) log->bp;
457 lp = (struct logpage *) bp->l_ldata;
458 dstoffset = LOGPHDRSIZE;
465 * move log vector descriptor
468 lvd = (struct lvd *) ((caddr_t) lp + dstoffset);
469 lvd->offset = cpu_to_le16(lv->offset);
470 lvd->length = cpu_to_le16(lv->length);
472 jfs_info("lmWriteRecord: lv offset:%d length:%d",
473 lv->offset, lv->length);
476 if ((i = linelock->next)) {
477 linelock = (struct linelock *) lid_to_tlock(i);
482 * move log record descriptor
485 lrd->length = cpu_to_le16(len);
491 freespace = (LOGPSIZE - LOGPTLRSIZE) - dstoffset;
492 nbytes = min(freespace, srclen);
493 dst = (caddr_t) lp + dstoffset;
494 memcpy(dst, src, nbytes);
499 /* are there more to move than freespace of page ? */
504 * end of log record descriptor
507 /* update last log record eor */
508 log->eor = dstoffset;
509 bp->l_eor = dstoffset;
510 lsn = (log->page << L2LOGPSIZE) + dstoffset;
512 if (lrd->type & cpu_to_le16(LOG_COMMIT)) {
514 jfs_info("wr: tclsn:0x%x, beor:0x%x", tblk->clsn,
517 INCREMENT(lmStat.commit); /* # of commit */
520 * enqueue tblock for group commit:
522 * enqueue tblock of non-trivial/synchronous COMMIT
523 * at tail of group commit queue
524 * (trivial/asynchronous COMMITs are ignored by
529 /* init tblock gc state */
530 tblk->flag = tblkGC_QUEUE;
532 tblk->pn = log->page;
533 tblk->eor = log->eor;
535 /* enqueue transaction to commit queue */
536 list_add_tail(&tblk->cqueue, &log->cqueue);
541 jfs_info("lmWriteRecord: lrd:0x%04x bp:0x%p pn:%d eor:0x%x",
542 le16_to_cpu(lrd->type), log->bp, log->page, dstoffset);
544 /* page not full ? */
545 if (dstoffset < LOGPSIZE - LOGPTLRSIZE)
549 /* page become full: move on to next page */
552 bp = (struct lbuf *) log->bp;
553 lp = (struct logpage *) bp->l_ldata;
554 dstoffset = LOGPHDRSIZE;
565 * FUNCTION: write current page and allocate next page.
571 * serialization: LOG_LOCK() held on entry/exit
573 static int lmNextPage(struct jfs_log * log)
576 int lspn; /* log sequence page number */
577 int pn; /* current page number */
582 /* get current log page number and log sequence page number */
585 lp = (struct logpage *) bp->l_ldata;
586 lspn = le32_to_cpu(lp->h.page);
591 * write or queue the full page at the tail of write queue
593 /* get the tail tblk on commit queue */
594 if (list_empty(&log->cqueue))
597 tblk = list_entry(log->cqueue.prev, struct tblock, cqueue);
599 /* every tblk who has COMMIT record on the current page,
600 * and has not been committed, must be on commit queue
601 * since tblk is queued at commit queueu at the time
602 * of writing its COMMIT record on the page before
603 * page becomes full (even though the tblk thread
604 * who wrote COMMIT record may have been suspended
608 /* is page bound with outstanding tail tblk ? */
609 if (tblk && tblk->pn == pn) {
610 /* mark tblk for end-of-page */
611 tblk->flag |= tblkGC_EOP;
613 if (log->cflag & logGC_PAGEOUT) {
614 /* if page is not already on write queue,
615 * just enqueue (no lbmWRITE to prevent redrive)
616 * buffer to wqueue to ensure correct serial order
617 * of the pages since log pages will be added
620 if (bp->l_wqnext == NULL)
621 lbmWrite(log, bp, 0, 0);
624 * No current GC leader, initiate group commit
626 log->cflag |= logGC_PAGEOUT;
630 /* page is not bound with outstanding tblk:
631 * init write or mark it to be redriven (lbmWRITE)
634 /* finalize the page */
635 bp->l_ceor = bp->l_eor;
636 lp->h.eor = lp->t.eor = cpu_to_le16(bp->l_ceor);
637 lbmWrite(log, bp, lbmWRITE | lbmRELEASE | lbmFREE, 0);
642 * allocate/initialize next page
644 /* if log wraps, the first data page of log is 2
645 * (0 never used, 1 is superblock).
647 log->page = (pn == log->size - 1) ? 2 : pn + 1;
648 log->eor = LOGPHDRSIZE; /* ? valid page empty/full at logRedo() */
650 /* allocate/initialize next log page buffer */
651 nextbp = lbmAllocate(log, log->page);
652 nextbp->l_eor = log->eor;
655 /* initialize next log page */
656 lp = (struct logpage *) nextbp->l_ldata;
657 lp->h.page = lp->t.page = cpu_to_le32(lspn + 1);
658 lp->h.eor = lp->t.eor = cpu_to_le16(LOGPHDRSIZE);
665 * NAME: lmGroupCommit()
667 * FUNCTION: group commit
668 * initiate pageout of the pages with COMMIT in the order of
669 * page number - redrive pageout of the page at the head of
670 * pageout queue until full page has been written.
675 * LOGGC_LOCK serializes log group commit queue, and
676 * transaction blocks on the commit queue.
677 * N.B. LOG_LOCK is NOT held during lmGroupCommit().
679 int lmGroupCommit(struct jfs_log * log, struct tblock * tblk)
685 /* group committed already ? */
686 if (tblk->flag & tblkGC_COMMITTED) {
687 if (tblk->flag & tblkGC_ERROR)
693 jfs_info("lmGroup Commit: tblk = 0x%p, gcrtc = %d", tblk, log->gcrtc);
695 if (tblk->xflag & COMMIT_LAZY)
696 tblk->flag |= tblkGC_LAZY;
698 if ((!(log->cflag & logGC_PAGEOUT)) && (!list_empty(&log->cqueue)) &&
699 (!(tblk->xflag & COMMIT_LAZY) || test_bit(log_FLUSH, &log->flag)
700 || jfs_tlocks_low)) {
702 * No pageout in progress
704 * start group commit as its group leader.
706 log->cflag |= logGC_PAGEOUT;
711 if (tblk->xflag & COMMIT_LAZY) {
713 * Lazy transactions can leave now
719 /* lmGCwrite gives up LOGGC_LOCK, check again */
721 if (tblk->flag & tblkGC_COMMITTED) {
722 if (tblk->flag & tblkGC_ERROR)
729 /* upcount transaction waiting for completion
732 tblk->flag |= tblkGC_READY;
734 __SLEEP_COND(tblk->gcwait, (tblk->flag & tblkGC_COMMITTED),
735 LOGGC_LOCK(log), LOGGC_UNLOCK(log));
737 /* removed from commit queue */
738 if (tblk->flag & tblkGC_ERROR)
748 * FUNCTION: group commit write
749 * initiate write of log page, building a group of all transactions
750 * with commit records on that page.
755 * LOGGC_LOCK must be held by caller.
756 * N.B. LOG_LOCK is NOT held during lmGroupCommit().
758 static void lmGCwrite(struct jfs_log * log, int cant_write)
762 int gcpn; /* group commit page number */
764 struct tblock *xtblk = NULL;
767 * build the commit group of a log page
769 * scan commit queue and make a commit group of all
770 * transactions with COMMIT records on the same log page.
772 /* get the head tblk on the commit queue */
773 gcpn = list_entry(log->cqueue.next, struct tblock, cqueue)->pn;
775 list_for_each_entry(tblk, &log->cqueue, cqueue) {
776 if (tblk->pn != gcpn)
781 /* state transition: (QUEUE, READY) -> COMMIT */
782 tblk->flag |= tblkGC_COMMIT;
784 tblk = xtblk; /* last tblk of the page */
787 * pageout to commit transactions on the log page.
789 bp = (struct lbuf *) tblk->bp;
790 lp = (struct logpage *) bp->l_ldata;
791 /* is page already full ? */
792 if (tblk->flag & tblkGC_EOP) {
793 /* mark page to free at end of group commit of the page */
794 tblk->flag &= ~tblkGC_EOP;
795 tblk->flag |= tblkGC_FREE;
796 bp->l_ceor = bp->l_eor;
797 lp->h.eor = lp->t.eor = cpu_to_le16(bp->l_ceor);
798 lbmWrite(log, bp, lbmWRITE | lbmRELEASE | lbmGC,
800 INCREMENT(lmStat.full_page);
802 /* page is not yet full */
804 bp->l_ceor = tblk->eor; /* ? bp->l_ceor = bp->l_eor; */
805 lp->h.eor = lp->t.eor = cpu_to_le16(bp->l_ceor);
806 lbmWrite(log, bp, lbmWRITE | lbmGC, cant_write);
807 INCREMENT(lmStat.partial_page);
814 * FUNCTION: group commit post-processing
815 * Processes transactions after their commit records have been written
816 * to disk, redriving log I/O if necessary.
821 * This routine is called a interrupt time by lbmIODone
823 static void lmPostGC(struct lbuf * bp)
826 struct jfs_log *log = bp->l_log;
828 struct tblock *tblk, *temp;
831 spin_lock_irqsave(&log->gclock, flags);
833 * current pageout of group commit completed.
835 * remove/wakeup transactions from commit queue who were
836 * group committed with the current log page
838 list_for_each_entry_safe(tblk, temp, &log->cqueue, cqueue) {
839 if (!(tblk->flag & tblkGC_COMMIT))
841 /* if transaction was marked GC_COMMIT then
842 * it has been shipped in the current pageout
843 * and made it to disk - it is committed.
846 if (bp->l_flag & lbmERROR)
847 tblk->flag |= tblkGC_ERROR;
849 /* remove it from the commit queue */
850 list_del(&tblk->cqueue);
851 tblk->flag &= ~tblkGC_QUEUE;
853 if (tblk == log->flush_tblk) {
854 /* we can stop flushing the log now */
855 clear_bit(log_FLUSH, &log->flag);
856 log->flush_tblk = NULL;
859 jfs_info("lmPostGC: tblk = 0x%p, flag = 0x%x", tblk,
862 if (!(tblk->xflag & COMMIT_FORCE))
864 * Hand tblk over to lazy commit thread
868 /* state transition: COMMIT -> COMMITTED */
869 tblk->flag |= tblkGC_COMMITTED;
871 if (tblk->flag & tblkGC_READY)
877 /* was page full before pageout ?
878 * (and this is the last tblk bound with the page)
880 if (tblk->flag & tblkGC_FREE)
882 /* did page become full after pageout ?
883 * (and this is the last tblk bound with the page)
885 else if (tblk->flag & tblkGC_EOP) {
886 /* finalize the page */
887 lp = (struct logpage *) bp->l_ldata;
888 bp->l_ceor = bp->l_eor;
889 lp->h.eor = lp->t.eor = cpu_to_le16(bp->l_eor);
890 jfs_info("lmPostGC: calling lbmWrite");
891 lbmWrite(log, bp, lbmWRITE | lbmRELEASE | lbmFREE,
897 /* are there any transactions who have entered lnGroupCommit()
898 * (whose COMMITs are after that of the last log page written.
899 * They are waiting for new group commit (above at (SLEEP 1))
900 * or lazy transactions are on a full (queued) log page,
901 * select the latest ready transaction as new group leader and
902 * wake her up to lead her group.
904 if ((!list_empty(&log->cqueue)) &&
905 ((log->gcrtc > 0) || (tblk->bp->l_wqnext != NULL) ||
906 test_bit(log_FLUSH, &log->flag) || jfs_tlocks_low))
908 * Call lmGCwrite with new group leader
912 /* no transaction are ready yet (transactions are only just
913 * queued (GC_QUEUE) and not entered for group commit yet).
914 * the first transaction entering group commit
915 * will elect herself as new group leader.
918 log->cflag &= ~logGC_PAGEOUT;
921 spin_unlock_irqrestore(&log->gclock, flags);
928 * FUNCTION: write log SYNCPT record for specified log
929 * if new sync address is available
930 * (normally the case if sync() is executed by back-ground
932 * calculate new value of i_nextsync which determines when
933 * this code is called again.
935 * PARAMETERS: log - log structure
936 * hard_sync - 1 to force all metadata to be written
940 * serialization: LOG_LOCK() held on entry/exit
942 static int lmLogSync(struct jfs_log * log, int hard_sync)
945 int written; /* written since last syncpt */
946 int free; /* free space left available */
947 int delta; /* additional delta to write normally */
948 int more; /* additional write granted */
951 struct logsyncblk *lp;
954 /* push dirty metapages out to disk */
956 write_special_inodes(log, filemap_fdatawrite);
958 write_special_inodes(log, filemap_flush);
963 /* if last sync is same as last syncpt,
964 * invoke sync point forward processing to update sync.
967 if (log->sync == log->syncpt) {
968 LOGSYNC_LOCK(log, flags);
969 if (list_empty(&log->synclist))
970 log->sync = log->lsn;
972 lp = list_entry(log->synclist.next,
973 struct logsyncblk, synclist);
976 LOGSYNC_UNLOCK(log, flags);
980 /* if sync is different from last syncpt,
981 * write a SYNCPT record with syncpt = sync.
982 * reset syncpt = sync
984 if (log->sync != log->syncpt) {
987 lrd.type = cpu_to_le16(LOG_SYNCPT);
989 lrd.log.syncpt.sync = cpu_to_le32(log->sync);
990 lsn = lmWriteRecord(log, NULL, &lrd, NULL);
992 log->syncpt = log->sync;
997 * setup next syncpt trigger (SWAG)
999 logsize = log->logsize;
1001 logdiff(written, lsn, log);
1002 free = logsize - written;
1003 delta = LOGSYNC_DELTA(logsize);
1004 more = min(free / 2, delta);
1005 if (more < 2 * LOGPSIZE) {
1006 jfs_warn("\n ... Log Wrap ... Log Wrap ... Log Wrap ...\n");
1010 * option 1 - panic ? No.!
1011 * option 2 - shutdown file systems
1012 * associated with log ?
1013 * option 3 - extend log ?
1014 * option 4 - second chance
1016 * mark log wrapped, and continue.
1017 * when all active transactions are completed,
1018 * mark log valid for recovery.
1019 * if crashed during invalid state, log state
1020 * implies invalid log, forcing fsck().
1022 /* mark log state log wrap in log superblock */
1023 /* log->state = LOGWRAP; */
1025 /* reset sync point computation */
1026 log->syncpt = log->sync = lsn;
1027 log->nextsync = delta;
1029 /* next syncpt trigger = written + more */
1030 log->nextsync = written + more;
1032 /* if number of bytes written from last sync point is more
1033 * than 1/4 of the log size, stop new transactions from
1034 * starting until all current transactions are completed
1035 * by setting syncbarrier flag.
1037 if (!test_bit(log_SYNCBARRIER, &log->flag) &&
1038 (written > LOGSYNC_BARRIER(logsize)) && log->active) {
1039 set_bit(log_SYNCBARRIER, &log->flag);
1040 jfs_info("log barrier on: lsn=0x%x syncpt=0x%x", lsn,
1043 * We may have to initiate group commit
1045 jfs_flush_journal(log, 0);
1054 * FUNCTION: write log SYNCPT record for specified log
1056 * PARAMETERS: log - log structure
1057 * hard_sync - set to 1 to force metadata to be written
1059 void jfs_syncpt(struct jfs_log *log, int hard_sync)
1061 lmLogSync(log, hard_sync);
1068 * FUNCTION: open the log on first open;
1069 * insert filesystem in the active list of the log.
1071 * PARAMETER: ipmnt - file system mount inode
1072 * iplog - log inode (out)
1078 int lmLogOpen(struct super_block *sb)
1081 struct block_device *bdev;
1082 struct jfs_log *log;
1083 struct jfs_sb_info *sbi = JFS_SBI(sb);
1085 if (sbi->flag & JFS_NOINTEGRITY)
1086 return open_dummy_log(sb);
1088 if (sbi->mntflag & JFS_INLINELOG)
1089 return open_inline_log(sb);
1091 mutex_lock(&jfs_log_mutex);
1092 list_for_each_entry(log, &jfs_external_logs, journal_list) {
1093 if (log->bdev->bd_dev == sbi->logdev) {
1094 if (memcmp(log->uuid, sbi->loguuid,
1095 sizeof(log->uuid))) {
1096 jfs_warn("wrong uuid on JFS journal\n");
1097 mutex_unlock(&jfs_log_mutex);
1101 * add file system to log active file system list
1103 if ((rc = lmLogFileSystem(log, sbi, 1))) {
1104 mutex_unlock(&jfs_log_mutex);
1111 if (!(log = kzalloc(sizeof(struct jfs_log), GFP_KERNEL))) {
1112 mutex_unlock(&jfs_log_mutex);
1115 INIT_LIST_HEAD(&log->sb_list);
1116 init_waitqueue_head(&log->syncwait);
1119 * external log as separate logical volume
1121 * file systems to log may have n-to-1 relationship;
1124 bdev = blkdev_get_by_dev(sbi->logdev, FMODE_READ|FMODE_WRITE|FMODE_EXCL,
1132 memcpy(log->uuid, sbi->loguuid, sizeof(log->uuid));
1137 if ((rc = lmLogInit(log)))
1140 list_add(&log->journal_list, &jfs_external_logs);
1143 * add file system to log active file system list
1145 if ((rc = lmLogFileSystem(log, sbi, 1)))
1150 list_add(&sbi->log_list, &log->sb_list);
1154 mutex_unlock(&jfs_log_mutex);
1160 shutdown: /* unwind lbmLogInit() */
1161 list_del(&log->journal_list);
1162 lbmLogShutdown(log);
1164 close: /* close external log device */
1165 blkdev_put(bdev, FMODE_READ|FMODE_WRITE|FMODE_EXCL);
1167 free: /* free log descriptor */
1168 mutex_unlock(&jfs_log_mutex);
1171 jfs_warn("lmLogOpen: exit(%d)", rc);
1175 static int open_inline_log(struct super_block *sb)
1177 struct jfs_log *log;
1180 if (!(log = kzalloc(sizeof(struct jfs_log), GFP_KERNEL)))
1182 INIT_LIST_HEAD(&log->sb_list);
1183 init_waitqueue_head(&log->syncwait);
1185 set_bit(log_INLINELOG, &log->flag);
1186 log->bdev = sb->s_bdev;
1187 log->base = addressPXD(&JFS_SBI(sb)->logpxd);
1188 log->size = lengthPXD(&JFS_SBI(sb)->logpxd) >>
1189 (L2LOGPSIZE - sb->s_blocksize_bits);
1190 log->l2bsize = sb->s_blocksize_bits;
1191 ASSERT(L2LOGPSIZE >= sb->s_blocksize_bits);
1196 if ((rc = lmLogInit(log))) {
1198 jfs_warn("lmLogOpen: exit(%d)", rc);
1202 list_add(&JFS_SBI(sb)->log_list, &log->sb_list);
1203 JFS_SBI(sb)->log = log;
1208 static int open_dummy_log(struct super_block *sb)
1212 mutex_lock(&jfs_log_mutex);
1214 dummy_log = kzalloc(sizeof(struct jfs_log), GFP_KERNEL);
1216 mutex_unlock(&jfs_log_mutex);
1219 INIT_LIST_HEAD(&dummy_log->sb_list);
1220 init_waitqueue_head(&dummy_log->syncwait);
1221 dummy_log->no_integrity = 1;
1222 /* Make up some stuff */
1223 dummy_log->base = 0;
1224 dummy_log->size = 1024;
1225 rc = lmLogInit(dummy_log);
1229 mutex_unlock(&jfs_log_mutex);
1234 LOG_LOCK(dummy_log);
1235 list_add(&JFS_SBI(sb)->log_list, &dummy_log->sb_list);
1236 JFS_SBI(sb)->log = dummy_log;
1237 LOG_UNLOCK(dummy_log);
1238 mutex_unlock(&jfs_log_mutex);
1246 * FUNCTION: log initialization at first log open.
1248 * logredo() (or logformat()) should have been run previously.
1249 * initialize the log from log superblock.
1250 * set the log state in the superblock to LOGMOUNT and
1251 * write SYNCPT log record.
1253 * PARAMETER: log - log structure
1256 * -EINVAL - bad log magic number or superblock dirty
1257 * error returned from logwait()
1259 * serialization: single first open thread
1261 int lmLogInit(struct jfs_log * log)
1265 struct logsuper *logsuper;
1266 struct lbuf *bpsuper;
1271 jfs_info("lmLogInit: log:0x%p", log);
1273 /* initialize the group commit serialization lock */
1274 LOGGC_LOCK_INIT(log);
1276 /* allocate/initialize the log write serialization lock */
1279 LOGSYNC_LOCK_INIT(log);
1281 INIT_LIST_HEAD(&log->synclist);
1283 INIT_LIST_HEAD(&log->cqueue);
1284 log->flush_tblk = NULL;
1289 * initialize log i/o
1291 if ((rc = lbmLogInit(log)))
1294 if (!test_bit(log_INLINELOG, &log->flag))
1295 log->l2bsize = L2LOGPSIZE;
1297 /* check for disabled journaling to disk */
1298 if (log->no_integrity) {
1300 * Journal pages will still be filled. When the time comes
1301 * to actually do the I/O, the write is not done, and the
1302 * endio routine is called directly.
1304 bp = lbmAllocate(log , 0);
1306 bp->l_pn = bp->l_eor = 0;
1309 * validate log superblock
1311 if ((rc = lbmRead(log, 1, &bpsuper)))
1314 logsuper = (struct logsuper *) bpsuper->l_ldata;
1316 if (logsuper->magic != cpu_to_le32(LOGMAGIC)) {
1317 jfs_warn("*** Log Format Error ! ***");
1322 /* logredo() should have been run successfully. */
1323 if (logsuper->state != cpu_to_le32(LOGREDONE)) {
1324 jfs_warn("*** Log Is Dirty ! ***");
1329 /* initialize log from log superblock */
1330 if (test_bit(log_INLINELOG,&log->flag)) {
1331 if (log->size != le32_to_cpu(logsuper->size)) {
1335 jfs_info("lmLogInit: inline log:0x%p base:0x%Lx "
1337 (unsigned long long) log->base, log->size);
1339 if (memcmp(logsuper->uuid, log->uuid, 16)) {
1340 jfs_warn("wrong uuid on JFS log device");
1343 log->size = le32_to_cpu(logsuper->size);
1344 log->l2bsize = le32_to_cpu(logsuper->l2bsize);
1345 jfs_info("lmLogInit: external log:0x%p base:0x%Lx "
1347 (unsigned long long) log->base, log->size);
1350 log->page = le32_to_cpu(logsuper->end) / LOGPSIZE;
1351 log->eor = le32_to_cpu(logsuper->end) - (LOGPSIZE * log->page);
1354 * initialize for log append write mode
1356 /* establish current/end-of-log page/buffer */
1357 if ((rc = lbmRead(log, log->page, &bp)))
1360 lp = (struct logpage *) bp->l_ldata;
1362 jfs_info("lmLogInit: lsn:0x%x page:%d eor:%d:%d",
1363 le32_to_cpu(logsuper->end), log->page, log->eor,
1364 le16_to_cpu(lp->h.eor));
1367 bp->l_pn = log->page;
1368 bp->l_eor = log->eor;
1370 /* if current page is full, move on to next page */
1371 if (log->eor >= LOGPSIZE - LOGPTLRSIZE)
1375 * initialize log syncpoint
1378 * write the first SYNCPT record with syncpoint = 0
1379 * (i.e., log redo up to HERE !);
1380 * remove current page from lbm write queue at end of pageout
1381 * (to write log superblock update), but do not release to
1386 lrd.type = cpu_to_le16(LOG_SYNCPT);
1388 lrd.log.syncpt.sync = 0;
1389 lsn = lmWriteRecord(log, NULL, &lrd, NULL);
1391 bp->l_ceor = bp->l_eor;
1392 lp = (struct logpage *) bp->l_ldata;
1393 lp->h.eor = lp->t.eor = cpu_to_le16(bp->l_eor);
1394 lbmWrite(log, bp, lbmWRITE | lbmSYNC, 0);
1395 if ((rc = lbmIOWait(bp, 0)))
1399 * update/write superblock
1401 logsuper->state = cpu_to_le32(LOGMOUNT);
1402 log->serial = le32_to_cpu(logsuper->serial) + 1;
1403 logsuper->serial = cpu_to_le32(log->serial);
1404 lbmDirectWrite(log, bpsuper, lbmWRITE | lbmRELEASE | lbmSYNC);
1405 if ((rc = lbmIOWait(bpsuper, lbmFREE)))
1409 /* initialize logsync parameters */
1410 log->logsize = (log->size - 2) << L2LOGPSIZE;
1413 log->sync = log->syncpt;
1414 log->nextsync = LOGSYNC_DELTA(log->logsize);
1416 jfs_info("lmLogInit: lsn:0x%x syncpt:0x%x sync:0x%x",
1417 log->lsn, log->syncpt, log->sync);
1420 * initialize for lazy/group commit
1429 errout30: /* release log page */
1431 bp->l_wqnext = NULL;
1434 errout20: /* release log superblock */
1437 errout10: /* unwind lbmLogInit() */
1438 lbmLogShutdown(log);
1440 jfs_warn("lmLogInit: exit(%d)", rc);
1446 * NAME: lmLogClose()
1448 * FUNCTION: remove file system <ipmnt> from active list of log <iplog>
1449 * and close it on last close.
1451 * PARAMETER: sb - superblock
1453 * RETURN: errors from subroutines
1457 int lmLogClose(struct super_block *sb)
1459 struct jfs_sb_info *sbi = JFS_SBI(sb);
1460 struct jfs_log *log = sbi->log;
1461 struct block_device *bdev;
1464 jfs_info("lmLogClose: log:0x%p", log);
1466 mutex_lock(&jfs_log_mutex);
1468 list_del(&sbi->log_list);
1473 * We need to make sure all of the "written" metapages
1474 * actually make it to disk
1476 sync_blockdev(sb->s_bdev);
1478 if (test_bit(log_INLINELOG, &log->flag)) {
1480 * in-line log in host file system
1482 rc = lmLogShutdown(log);
1487 if (!log->no_integrity)
1488 lmLogFileSystem(log, sbi, 0);
1490 if (!list_empty(&log->sb_list))
1494 * TODO: ensure that the dummy_log is in a state to allow
1495 * lbmLogShutdown to deallocate all the buffers and call
1496 * kfree against dummy_log. For now, leave dummy_log & its
1497 * buffers in memory, and resuse if another no-integrity mount
1500 if (log->no_integrity)
1504 * external log as separate logical volume
1506 list_del(&log->journal_list);
1508 rc = lmLogShutdown(log);
1510 blkdev_put(bdev, FMODE_READ|FMODE_WRITE|FMODE_EXCL);
1515 mutex_unlock(&jfs_log_mutex);
1516 jfs_info("lmLogClose: exit(%d)", rc);
1522 * NAME: jfs_flush_journal()
1524 * FUNCTION: initiate write of any outstanding transactions to the journal
1525 * and optionally wait until they are all written to disk
1527 * wait == 0 flush until latest txn is committed, don't wait
1528 * wait == 1 flush until latest txn is committed, wait
1529 * wait > 1 flush until all txn's are complete, wait
1531 void jfs_flush_journal(struct jfs_log *log, int wait)
1534 struct tblock *target = NULL;
1536 /* jfs_write_inode may call us during read-only mount */
1540 jfs_info("jfs_flush_journal: log:0x%p wait=%d", log, wait);
1544 if (!list_empty(&log->cqueue)) {
1546 * This ensures that we will keep writing to the journal as long
1547 * as there are unwritten commit records
1549 target = list_entry(log->cqueue.prev, struct tblock, cqueue);
1551 if (test_bit(log_FLUSH, &log->flag)) {
1553 * We're already flushing.
1554 * if flush_tblk is NULL, we are flushing everything,
1555 * so leave it that way. Otherwise, update it to the
1556 * latest transaction
1558 if (log->flush_tblk)
1559 log->flush_tblk = target;
1561 /* Only flush until latest transaction is committed */
1562 log->flush_tblk = target;
1563 set_bit(log_FLUSH, &log->flag);
1566 * Initiate I/O on outstanding transactions
1568 if (!(log->cflag & logGC_PAGEOUT)) {
1569 log->cflag |= logGC_PAGEOUT;
1574 if ((wait > 1) || test_bit(log_SYNCBARRIER, &log->flag)) {
1575 /* Flush until all activity complete */
1576 set_bit(log_FLUSH, &log->flag);
1577 log->flush_tblk = NULL;
1580 if (wait && target && !(target->flag & tblkGC_COMMITTED)) {
1581 DECLARE_WAITQUEUE(__wait, current);
1583 add_wait_queue(&target->gcwait, &__wait);
1584 set_current_state(TASK_UNINTERRUPTIBLE);
1587 __set_current_state(TASK_RUNNING);
1589 remove_wait_queue(&target->gcwait, &__wait);
1596 write_special_inodes(log, filemap_fdatawrite);
1599 * If there was recent activity, we may need to wait
1600 * for the lazycommit thread to catch up
1602 if ((!list_empty(&log->cqueue)) || !list_empty(&log->synclist)) {
1603 for (i = 0; i < 200; i++) { /* Too much? */
1605 write_special_inodes(log, filemap_fdatawrite);
1606 if (list_empty(&log->cqueue) &&
1607 list_empty(&log->synclist))
1611 assert(list_empty(&log->cqueue));
1613 #ifdef CONFIG_JFS_DEBUG
1614 if (!list_empty(&log->synclist)) {
1615 struct logsyncblk *lp;
1617 printk(KERN_ERR "jfs_flush_journal: synclist not empty\n");
1618 list_for_each_entry(lp, &log->synclist, synclist) {
1619 if (lp->xflag & COMMIT_PAGE) {
1620 struct metapage *mp = (struct metapage *)lp;
1621 print_hex_dump(KERN_ERR, "metapage: ",
1622 DUMP_PREFIX_ADDRESS, 16, 4,
1623 mp, sizeof(struct metapage), 0);
1624 print_hex_dump(KERN_ERR, "page: ",
1625 DUMP_PREFIX_ADDRESS, 16,
1626 sizeof(long), mp->page,
1627 sizeof(struct page), 0);
1629 print_hex_dump(KERN_ERR, "tblock:",
1630 DUMP_PREFIX_ADDRESS, 16, 4,
1631 lp, sizeof(struct tblock), 0);
1635 WARN_ON(!list_empty(&log->synclist));
1637 clear_bit(log_FLUSH, &log->flag);
1641 * NAME: lmLogShutdown()
1643 * FUNCTION: log shutdown at last LogClose().
1645 * write log syncpt record.
1646 * update super block to set redone flag to 0.
1648 * PARAMETER: log - log inode
1650 * RETURN: 0 - success
1652 * serialization: single last close thread
1654 int lmLogShutdown(struct jfs_log * log)
1659 struct logsuper *logsuper;
1660 struct lbuf *bpsuper;
1664 jfs_info("lmLogShutdown: log:0x%p", log);
1666 jfs_flush_journal(log, 2);
1669 * write the last SYNCPT record with syncpoint = 0
1670 * (i.e., log redo up to HERE !)
1674 lrd.type = cpu_to_le16(LOG_SYNCPT);
1676 lrd.log.syncpt.sync = 0;
1678 lsn = lmWriteRecord(log, NULL, &lrd, NULL);
1680 lp = (struct logpage *) bp->l_ldata;
1681 lp->h.eor = lp->t.eor = cpu_to_le16(bp->l_eor);
1682 lbmWrite(log, log->bp, lbmWRITE | lbmRELEASE | lbmSYNC, 0);
1683 lbmIOWait(log->bp, lbmFREE);
1687 * synchronous update log superblock
1688 * mark log state as shutdown cleanly
1689 * (i.e., Log does not need to be replayed).
1691 if ((rc = lbmRead(log, 1, &bpsuper)))
1694 logsuper = (struct logsuper *) bpsuper->l_ldata;
1695 logsuper->state = cpu_to_le32(LOGREDONE);
1696 logsuper->end = cpu_to_le32(lsn);
1697 lbmDirectWrite(log, bpsuper, lbmWRITE | lbmRELEASE | lbmSYNC);
1698 rc = lbmIOWait(bpsuper, lbmFREE);
1700 jfs_info("lmLogShutdown: lsn:0x%x page:%d eor:%d",
1701 lsn, log->page, log->eor);
1705 * shutdown per log i/o
1707 lbmLogShutdown(log);
1710 jfs_warn("lmLogShutdown: exit(%d)", rc);
1717 * NAME: lmLogFileSystem()
1719 * FUNCTION: insert (<activate> = true)/remove (<activate> = false)
1720 * file system into/from log active file system list.
1722 * PARAMETE: log - pointer to logs inode.
1723 * fsdev - kdev_t of filesystem.
1724 * serial - pointer to returned log serial number
1725 * activate - insert/remove device from active list.
1727 * RETURN: 0 - success
1728 * errors returned by vms_iowait().
1730 static int lmLogFileSystem(struct jfs_log * log, struct jfs_sb_info *sbi,
1735 struct logsuper *logsuper;
1736 struct lbuf *bpsuper;
1737 char *uuid = sbi->uuid;
1740 * insert/remove file system device to log active file system list.
1742 if ((rc = lbmRead(log, 1, &bpsuper)))
1745 logsuper = (struct logsuper *) bpsuper->l_ldata;
1747 for (i = 0; i < MAX_ACTIVE; i++)
1748 if (!memcmp(logsuper->active[i].uuid, NULL_UUID, 16)) {
1749 memcpy(logsuper->active[i].uuid, uuid, 16);
1753 if (i == MAX_ACTIVE) {
1754 jfs_warn("Too many file systems sharing journal!");
1756 return -EMFILE; /* Is there a better rc? */
1759 for (i = 0; i < MAX_ACTIVE; i++)
1760 if (!memcmp(logsuper->active[i].uuid, uuid, 16)) {
1761 memcpy(logsuper->active[i].uuid, NULL_UUID, 16);
1764 if (i == MAX_ACTIVE) {
1765 jfs_warn("Somebody stomped on the journal!");
1773 * synchronous write log superblock:
1775 * write sidestream bypassing write queue:
1776 * at file system mount, log super block is updated for
1777 * activation of the file system before any log record
1778 * (MOUNT record) of the file system, and at file system
1779 * unmount, all meta data for the file system has been
1780 * flushed before log super block is updated for deactivation
1781 * of the file system.
1783 lbmDirectWrite(log, bpsuper, lbmWRITE | lbmRELEASE | lbmSYNC);
1784 rc = lbmIOWait(bpsuper, lbmFREE);
1790 * log buffer manager (lbm)
1791 * ------------------------
1793 * special purpose buffer manager supporting log i/o requirements.
1795 * per log write queue:
1796 * log pageout occurs in serial order by fifo write queue and
1797 * restricting to a single i/o in pregress at any one time.
1798 * a circular singly-linked list
1799 * (log->wrqueue points to the tail, and buffers are linked via
1800 * bp->wrqueue field), and
1801 * maintains log page in pageout ot waiting for pageout in serial pageout.
1807 * initialize per log I/O setup at lmLogInit()
1809 static int lbmLogInit(struct jfs_log * log)
1814 jfs_info("lbmLogInit: log:0x%p", log);
1816 /* initialize current buffer cursor */
1819 /* initialize log device write queue */
1823 * Each log has its own buffer pages allocated to it. These are
1824 * not managed by the page cache. This ensures that a transaction
1825 * writing to the log does not block trying to allocate a page from
1826 * the page cache (for the log). This would be bad, since page
1827 * allocation waits on the kswapd thread that may be committing inodes
1828 * which would cause log activity. Was that clear? I'm trying to
1829 * avoid deadlock here.
1831 init_waitqueue_head(&log->free_wait);
1833 log->lbuf_free = NULL;
1835 for (i = 0; i < LOGPAGES;) {
1840 buffer = (char *) get_zeroed_page(GFP_KERNEL);
1843 page = virt_to_page(buffer);
1844 for (offset = 0; offset < PAGE_SIZE; offset += LOGPSIZE) {
1845 lbuf = kmalloc(sizeof(struct lbuf), GFP_KERNEL);
1848 free_page((unsigned long) buffer);
1851 if (offset) /* we already have one reference */
1853 lbuf->l_offset = offset;
1854 lbuf->l_ldata = buffer + offset;
1855 lbuf->l_page = page;
1857 init_waitqueue_head(&lbuf->l_ioevent);
1859 lbuf->l_freelist = log->lbuf_free;
1860 log->lbuf_free = lbuf;
1868 lbmLogShutdown(log);
1876 * finalize per log I/O setup at lmLogShutdown()
1878 static void lbmLogShutdown(struct jfs_log * log)
1882 jfs_info("lbmLogShutdown: log:0x%p", log);
1884 lbuf = log->lbuf_free;
1886 struct lbuf *next = lbuf->l_freelist;
1887 __free_page(lbuf->l_page);
1897 * allocate an empty log buffer
1899 static struct lbuf *lbmAllocate(struct jfs_log * log, int pn)
1902 unsigned long flags;
1905 * recycle from log buffer freelist if any
1908 LCACHE_SLEEP_COND(log->free_wait, (bp = log->lbuf_free), flags);
1909 log->lbuf_free = bp->l_freelist;
1910 LCACHE_UNLOCK(flags);
1914 bp->l_wqnext = NULL;
1915 bp->l_freelist = NULL;
1918 bp->l_blkno = log->base + (pn << (L2LOGPSIZE - log->l2bsize));
1928 * release a log buffer to freelist
1930 static void lbmFree(struct lbuf * bp)
1932 unsigned long flags;
1938 LCACHE_UNLOCK(flags);
1941 static void lbmfree(struct lbuf * bp)
1943 struct jfs_log *log = bp->l_log;
1945 assert(bp->l_wqnext == NULL);
1948 * return the buffer to head of freelist
1950 bp->l_freelist = log->lbuf_free;
1951 log->lbuf_free = bp;
1953 wake_up(&log->free_wait);
1961 * FUNCTION: add a log buffer to the log redrive list
1967 * Takes log_redrive_lock.
1969 static inline void lbmRedrive(struct lbuf *bp)
1971 unsigned long flags;
1973 spin_lock_irqsave(&log_redrive_lock, flags);
1974 bp->l_redrive_next = log_redrive_list;
1975 log_redrive_list = bp;
1976 spin_unlock_irqrestore(&log_redrive_lock, flags);
1978 wake_up_process(jfsIOthread);
1985 static int lbmRead(struct jfs_log * log, int pn, struct lbuf ** bpp)
1991 * allocate a log buffer
1993 *bpp = bp = lbmAllocate(log, pn);
1994 jfs_info("lbmRead: bp:0x%p pn:0x%x", bp, pn);
1996 bp->l_flag |= lbmREAD;
1998 bio = bio_alloc(GFP_NOFS, 1);
2000 bio->bi_sector = bp->l_blkno << (log->l2bsize - 9);
2001 bio->bi_bdev = log->bdev;
2002 bio->bi_io_vec[0].bv_page = bp->l_page;
2003 bio->bi_io_vec[0].bv_len = LOGPSIZE;
2004 bio->bi_io_vec[0].bv_offset = bp->l_offset;
2008 bio->bi_size = LOGPSIZE;
2010 bio->bi_end_io = lbmIODone;
2011 bio->bi_private = bp;
2012 submit_bio(READ_SYNC, bio);
2014 wait_event(bp->l_ioevent, (bp->l_flag != lbmREAD));
2023 * buffer at head of pageout queue stays after completion of
2024 * partial-page pageout and redriven by explicit initiation of
2025 * pageout by caller until full-page pageout is completed and
2028 * device driver i/o done redrives pageout of new buffer at
2029 * head of pageout queue when current buffer at head of pageout
2030 * queue is released at the completion of its full-page pageout.
2032 * LOGGC_LOCK() serializes lbmWrite() by lmNextPage() and lmGroupCommit().
2033 * LCACHE_LOCK() serializes xflag between lbmWrite() and lbmIODone()
2035 static void lbmWrite(struct jfs_log * log, struct lbuf * bp, int flag,
2039 unsigned long flags;
2041 jfs_info("lbmWrite: bp:0x%p flag:0x%x pn:0x%x", bp, flag, bp->l_pn);
2043 /* map the logical block address to physical block address */
2045 log->base + (bp->l_pn << (L2LOGPSIZE - log->l2bsize));
2047 LCACHE_LOCK(flags); /* disable+lock */
2050 * initialize buffer for device driver
2055 * insert bp at tail of write queue associated with log
2057 * (request is either for bp already/currently at head of queue
2058 * or new bp to be inserted at tail)
2062 /* is buffer not already on write queue ? */
2063 if (bp->l_wqnext == NULL) {
2064 /* insert at tail of wqueue */
2070 bp->l_wqnext = tail->l_wqnext;
2071 tail->l_wqnext = bp;
2077 /* is buffer at head of wqueue and for write ? */
2078 if ((bp != tail->l_wqnext) || !(flag & lbmWRITE)) {
2079 LCACHE_UNLOCK(flags); /* unlock+enable */
2083 LCACHE_UNLOCK(flags); /* unlock+enable */
2087 else if (flag & lbmSYNC)
2100 * initiate pageout bypassing write queue for sidestream
2101 * (e.g., log superblock) write;
2103 static void lbmDirectWrite(struct jfs_log * log, struct lbuf * bp, int flag)
2105 jfs_info("lbmDirectWrite: bp:0x%p flag:0x%x pn:0x%x",
2106 bp, flag, bp->l_pn);
2109 * initialize buffer for device driver
2111 bp->l_flag = flag | lbmDIRECT;
2113 /* map the logical block address to physical block address */
2115 log->base + (bp->l_pn << (L2LOGPSIZE - log->l2bsize));
2118 * initiate pageout of the page
2125 * NAME: lbmStartIO()
2127 * FUNCTION: Interface to DD strategy routine
2131 * serialization: LCACHE_LOCK() is NOT held during log i/o;
2133 static void lbmStartIO(struct lbuf * bp)
2136 struct jfs_log *log = bp->l_log;
2138 jfs_info("lbmStartIO\n");
2140 bio = bio_alloc(GFP_NOFS, 1);
2141 bio->bi_sector = bp->l_blkno << (log->l2bsize - 9);
2142 bio->bi_bdev = log->bdev;
2143 bio->bi_io_vec[0].bv_page = bp->l_page;
2144 bio->bi_io_vec[0].bv_len = LOGPSIZE;
2145 bio->bi_io_vec[0].bv_offset = bp->l_offset;
2149 bio->bi_size = LOGPSIZE;
2151 bio->bi_end_io = lbmIODone;
2152 bio->bi_private = bp;
2154 /* check if journaling to disk has been disabled */
2155 if (log->no_integrity) {
2159 submit_bio(WRITE_SYNC, bio);
2160 INCREMENT(lmStat.submitted);
2168 static int lbmIOWait(struct lbuf * bp, int flag)
2170 unsigned long flags;
2173 jfs_info("lbmIOWait1: bp:0x%p flag:0x%x:0x%x", bp, bp->l_flag, flag);
2175 LCACHE_LOCK(flags); /* disable+lock */
2177 LCACHE_SLEEP_COND(bp->l_ioevent, (bp->l_flag & lbmDONE), flags);
2179 rc = (bp->l_flag & lbmERROR) ? -EIO : 0;
2184 LCACHE_UNLOCK(flags); /* unlock+enable */
2186 jfs_info("lbmIOWait2: bp:0x%p flag:0x%x:0x%x", bp, bp->l_flag, flag);
2193 * executed at INTIODONE level
2195 static void lbmIODone(struct bio *bio, int error)
2197 struct lbuf *bp = bio->bi_private;
2198 struct lbuf *nextbp, *tail;
2199 struct jfs_log *log;
2200 unsigned long flags;
2203 * get back jfs buffer bound to the i/o buffer
2205 jfs_info("lbmIODone: bp:0x%p flag:0x%x", bp, bp->l_flag);
2207 LCACHE_LOCK(flags); /* disable+lock */
2209 bp->l_flag |= lbmDONE;
2211 if (!test_bit(BIO_UPTODATE, &bio->bi_flags)) {
2212 bp->l_flag |= lbmERROR;
2214 jfs_err("lbmIODone: I/O error in JFS log");
2222 if (bp->l_flag & lbmREAD) {
2223 bp->l_flag &= ~lbmREAD;
2225 LCACHE_UNLOCK(flags); /* unlock+enable */
2227 /* wakeup I/O initiator */
2228 LCACHE_WAKEUP(&bp->l_ioevent);
2234 * pageout completion
2236 * the bp at the head of write queue has completed pageout.
2238 * if single-commit/full-page pageout, remove the current buffer
2239 * from head of pageout queue, and redrive pageout with
2240 * the new buffer at head of pageout queue;
2241 * otherwise, the partial-page pageout buffer stays at
2242 * the head of pageout queue to be redriven for pageout
2243 * by lmGroupCommit() until full-page pageout is completed.
2245 bp->l_flag &= ~lbmWRITE;
2246 INCREMENT(lmStat.pagedone);
2248 /* update committed lsn */
2250 log->clsn = (bp->l_pn << L2LOGPSIZE) + bp->l_ceor;
2252 if (bp->l_flag & lbmDIRECT) {
2253 LCACHE_WAKEUP(&bp->l_ioevent);
2254 LCACHE_UNLOCK(flags);
2260 /* single element queue */
2262 /* remove head buffer of full-page pageout
2263 * from log device write queue
2265 if (bp->l_flag & lbmRELEASE) {
2267 bp->l_wqnext = NULL;
2270 /* multi element queue */
2272 /* remove head buffer of full-page pageout
2273 * from log device write queue
2275 if (bp->l_flag & lbmRELEASE) {
2276 nextbp = tail->l_wqnext = bp->l_wqnext;
2277 bp->l_wqnext = NULL;
2280 * redrive pageout of next page at head of write queue:
2281 * redrive next page without any bound tblk
2282 * (i.e., page w/o any COMMIT records), or
2283 * first page of new group commit which has been
2284 * queued after current page (subsequent pageout
2285 * is performed synchronously, except page without
2286 * any COMMITs) by lmGroupCommit() as indicated
2289 if (nextbp->l_flag & lbmWRITE) {
2291 * We can't do the I/O at interrupt time.
2292 * The jfsIO thread can do it
2300 * synchronous pageout:
2302 * buffer has not necessarily been removed from write queue
2303 * (e.g., synchronous write of partial-page with COMMIT):
2304 * leave buffer for i/o initiator to dispose
2306 if (bp->l_flag & lbmSYNC) {
2307 LCACHE_UNLOCK(flags); /* unlock+enable */
2309 /* wakeup I/O initiator */
2310 LCACHE_WAKEUP(&bp->l_ioevent);
2314 * Group Commit pageout:
2316 else if (bp->l_flag & lbmGC) {
2317 LCACHE_UNLOCK(flags);
2322 * asynchronous pageout:
2324 * buffer must have been removed from write queue:
2325 * insert buffer at head of freelist where it can be recycled
2328 assert(bp->l_flag & lbmRELEASE);
2329 assert(bp->l_flag & lbmFREE);
2332 LCACHE_UNLOCK(flags); /* unlock+enable */
2336 int jfsIOWait(void *arg)
2341 spin_lock_irq(&log_redrive_lock);
2342 while ((bp = log_redrive_list)) {
2343 log_redrive_list = bp->l_redrive_next;
2344 bp->l_redrive_next = NULL;
2345 spin_unlock_irq(&log_redrive_lock);
2347 spin_lock_irq(&log_redrive_lock);
2350 if (freezing(current)) {
2351 spin_unlock_irq(&log_redrive_lock);
2354 set_current_state(TASK_INTERRUPTIBLE);
2355 spin_unlock_irq(&log_redrive_lock);
2357 __set_current_state(TASK_RUNNING);
2359 } while (!kthread_should_stop());
2361 jfs_info("jfsIOWait being killed!");
2366 * NAME: lmLogFormat()/jfs_logform()
2368 * FUNCTION: format file system log
2372 * logAddress - start address of log space in FS block
2373 * logSize - length of log space in FS block;
2375 * RETURN: 0 - success
2378 * XXX: We're synchronously writing one page at a time. This needs to
2379 * be improved by writing multiple pages at once.
2381 int lmLogFormat(struct jfs_log *log, s64 logAddress, int logSize)
2384 struct jfs_sb_info *sbi;
2385 struct logsuper *logsuper;
2387 int lspn; /* log sequence page number */
2388 struct lrd *lrd_ptr;
2392 jfs_info("lmLogFormat: logAddress:%Ld logSize:%d",
2393 (long long)logAddress, logSize);
2395 sbi = list_entry(log->sb_list.next, struct jfs_sb_info, log_list);
2397 /* allocate a log buffer */
2398 bp = lbmAllocate(log, 1);
2400 npages = logSize >> sbi->l2nbperpage;
2405 * page 0 - reserved;
2406 * page 1 - log superblock;
2407 * page 2 - log data page: A SYNC log record is written
2408 * into this page at logform time;
2409 * pages 3-N - log data page: set to empty log data pages;
2412 * init log superblock: log page 1
2414 logsuper = (struct logsuper *) bp->l_ldata;
2416 logsuper->magic = cpu_to_le32(LOGMAGIC);
2417 logsuper->version = cpu_to_le32(LOGVERSION);
2418 logsuper->state = cpu_to_le32(LOGREDONE);
2419 logsuper->flag = cpu_to_le32(sbi->mntflag); /* ? */
2420 logsuper->size = cpu_to_le32(npages);
2421 logsuper->bsize = cpu_to_le32(sbi->bsize);
2422 logsuper->l2bsize = cpu_to_le32(sbi->l2bsize);
2423 logsuper->end = cpu_to_le32(2 * LOGPSIZE + LOGPHDRSIZE + LOGRDSIZE);
2425 bp->l_flag = lbmWRITE | lbmSYNC | lbmDIRECT;
2426 bp->l_blkno = logAddress + sbi->nbperpage;
2428 if ((rc = lbmIOWait(bp, 0)))
2432 * init pages 2 to npages-1 as log data pages:
2434 * log page sequence number (lpsn) initialization:
2437 * +-----+-----+=====+=====+===.....===+=====+
2439 * <--- N page circular file ---->
2441 * the N (= npages-2) data pages of the log is maintained as
2442 * a circular file for the log records;
2443 * lpsn grows by 1 monotonically as each log page is written
2444 * to the circular file of the log;
2445 * and setLogpage() will not reset the page number even if
2446 * the eor is equal to LOGPHDRSIZE. In order for binary search
2447 * still work in find log end process, we have to simulate the
2448 * log wrap situation at the log format time.
2449 * The 1st log page written will have the highest lpsn. Then
2450 * the succeeding log pages will have ascending order of
2451 * the lspn starting from 0, ... (N-2)
2453 lp = (struct logpage *) bp->l_ldata;
2455 * initialize 1st log page to be written: lpsn = N - 1,
2456 * write a SYNCPT log record is written to this page
2458 lp->h.page = lp->t.page = cpu_to_le32(npages - 3);
2459 lp->h.eor = lp->t.eor = cpu_to_le16(LOGPHDRSIZE + LOGRDSIZE);
2461 lrd_ptr = (struct lrd *) &lp->data;
2462 lrd_ptr->logtid = 0;
2463 lrd_ptr->backchain = 0;
2464 lrd_ptr->type = cpu_to_le16(LOG_SYNCPT);
2465 lrd_ptr->length = 0;
2466 lrd_ptr->log.syncpt.sync = 0;
2468 bp->l_blkno += sbi->nbperpage;
2469 bp->l_flag = lbmWRITE | lbmSYNC | lbmDIRECT;
2471 if ((rc = lbmIOWait(bp, 0)))
2475 * initialize succeeding log pages: lpsn = 0, 1, ..., (N-2)
2477 for (lspn = 0; lspn < npages - 3; lspn++) {
2478 lp->h.page = lp->t.page = cpu_to_le32(lspn);
2479 lp->h.eor = lp->t.eor = cpu_to_le16(LOGPHDRSIZE);
2481 bp->l_blkno += sbi->nbperpage;
2482 bp->l_flag = lbmWRITE | lbmSYNC | lbmDIRECT;
2484 if ((rc = lbmIOWait(bp, 0)))
2493 /* release the buffer */
2499 #ifdef CONFIG_JFS_STATISTICS
2500 static int jfs_lmstats_proc_show(struct seq_file *m, void *v)
2503 "JFS Logmgr stats\n"
2504 "================\n"
2506 "writes submitted = %d\n"
2507 "writes completed = %d\n"
2508 "full pages submitted = %d\n"
2509 "partial pages submitted = %d\n",
2514 lmStat.partial_page);
2518 static int jfs_lmstats_proc_open(struct inode *inode, struct file *file)
2520 return single_open(file, jfs_lmstats_proc_show, NULL);
2523 const struct file_operations jfs_lmstats_proc_fops = {
2524 .owner = THIS_MODULE,
2525 .open = jfs_lmstats_proc_open,
2527 .llseek = seq_lseek,
2528 .release = single_release,
2530 #endif /* CONFIG_JFS_STATISTICS */