org.vanilladb.core.storage.tx.recovery

Class RecoveryMgr

java.lang.Object

org.vanilladb.core.storage.tx.recovery.RecoveryMgr

All Implemented Interfaces:

TransactionLifecycleListener

public class RecoveryMgr
extends Object
implements TransactionLifecycleListener

The recovery manager. Each transaction has its own recovery manager.

Constructor Summary

Constructors

Constructor and Description
RecoveryMgr(long txNum, boolean isReadOnly) Creates a recovery manager for the specified transaction.

Method Summary

Modifier and Type	Method and Description
LogSeqNum	checkpoint(List<Long> txNums) Writes a checkpoint record to the log.
static void	enableLogging(boolean log)
static void	initializeSystem(Transaction tx) Goes through the log, rolling back all uncompleted transactions.
LogSeqNum	logIndexDeletionEnd(String indexName, SearchKey searchKey, long recordBlockNum, int recordSlotId)
LogSeqNum	logIndexInsertionEnd(String indexName, SearchKey searchKey, long recordBlockNum, int recordSlotId)
LogSeqNum	logIndexPageDeletion(BlockId indexBlkId, boolean isDirPage, SearchKeyType keyType, int slotId)
LogSeqNum	logIndexPageDeletionClr(long compTxNum, BlockId indexBlkId, boolean isDirPage, SearchKeyType keyType, int slotId, LogSeqNum undoNextLSN)
LogSeqNum	logIndexPageInsertion(BlockId indexBlkId, boolean isDirPage, SearchKeyType keyType, int slotId)
LogSeqNum	logIndexPageInsertionClr(long compTxNum, BlockId indexBlkId, boolean isDirPage, SearchKeyType keyType, int slotId, LogSeqNum undoNextLSN)
LogSeqNum	logLogicalAbort(long txNum, LogSeqNum undoNextLSN) Writes a logical abort record into the log.
LogSeqNum	logLogicalStart()
LogSeqNum	logRecordFileDeletionEnd(String tblName, long blkNum, int slotId)
LogSeqNum	logRecordFileInsertionEnd(String tblName, long blkNum, int slotId)
LogSeqNum	logSetVal(Buffer buff, int offset, Constant newVal) Writes a set value record to the log.
LogSeqNum	logSetValClr(long compTxNum, Buffer buff, int offset, Constant newVal, LogSeqNum undoNextLSN)
void	onTxCommit(Transaction tx) Writes a commit record to the log, and then flushes the log record to disk.
void	onTxEndStatement(Transaction tx)
void	onTxRollback(Transaction tx) Does the roll back process, writes a rollback record to the log, and flushes the log record to disk.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RecoveryMgr

public RecoveryMgr(long txNum,
                   boolean isReadOnly)

Creates a recovery manager for the specified transaction.

Parameters:

txNum - the ID of the specified transaction

isReadOnly - is the transaction read-only

Method Detail

enableLogging

public static void enableLogging(boolean log)

initializeSystem

public static void initializeSystem(Transaction tx)

Goes through the log, rolling back all uncompleted transactions. Flushes all modified blocks. Finally, writes a quiescent checkpoint record to the log and flush it. This method should be called only during system startup, before user transactions begin.

Parameters:

tx - the context of executing transaction

onTxCommit

public void onTxCommit(Transaction tx)

Writes a commit record to the log, and then flushes the log record to disk.

Specified by:

onTxCommit in interface TransactionLifecycleListener

Parameters:

tx - the context of committing transaction

onTxRollback

public void onTxRollback(Transaction tx)

Does the roll back process, writes a rollback record to the log, and flushes the log record to disk.

Specified by:

onTxRollback in interface TransactionLifecycleListener

onTxEndStatement

public void onTxEndStatement(Transaction tx)

Specified by:

onTxEndStatement in interface TransactionLifecycleListener

checkpoint

public LogSeqNum checkpoint(List<Long> txNums)

Writes a checkpoint record to the log.

Parameters:

txNums - the transactions that are being executed when writing the checkpoint.

Returns:

the LSN of the log record.

logSetVal

public LogSeqNum logSetVal(Buffer buff,
                           int offset,
                           Constant newVal)

Writes a set value record to the log.

Parameters:

buff - the buffer containing the page

offset - the offset of the value in the page

newVal - the value to be written

Returns:

the LSN of the log record, or -1 if updates to temporary files

logLogicalStart

public LogSeqNum logLogicalStart()

logLogicalAbort

public LogSeqNum logLogicalAbort(long txNum,
                                 LogSeqNum undoNextLSN)

Writes a logical abort record into the log.

Parameters:

txNum - the number of aborted transaction

undoNextLSN - the LSN which the redo the Abort record should jump to

Returns:

the LSN of the log record, or null if recovery manager turns off the logging

logRecordFileInsertionEnd

public LogSeqNum logRecordFileInsertionEnd(String tblName,
                                           long blkNum,
                                           int slotId)

logRecordFileDeletionEnd

public LogSeqNum logRecordFileDeletionEnd(String tblName,
                                          long blkNum,
                                          int slotId)

logIndexInsertionEnd

public LogSeqNum logIndexInsertionEnd(String indexName,
                                      SearchKey searchKey,
                                      long recordBlockNum,
                                      int recordSlotId)

logIndexDeletionEnd

public LogSeqNum logIndexDeletionEnd(String indexName,
                                     SearchKey searchKey,
                                     long recordBlockNum,
                                     int recordSlotId)

logIndexPageInsertion

public LogSeqNum logIndexPageInsertion(BlockId indexBlkId,
                                       boolean isDirPage,
                                       SearchKeyType keyType,
                                       int slotId)

logIndexPageDeletion

public LogSeqNum logIndexPageDeletion(BlockId indexBlkId,
                                      boolean isDirPage,
                                      SearchKeyType keyType,
                                      int slotId)

logIndexPageInsertionClr

public LogSeqNum logIndexPageInsertionClr(long compTxNum,
                                          BlockId indexBlkId,
                                          boolean isDirPage,
                                          SearchKeyType keyType,
                                          int slotId,
                                          LogSeqNum undoNextLSN)

logIndexPageDeletionClr

public LogSeqNum logIndexPageDeletionClr(long compTxNum,
                                         BlockId indexBlkId,
                                         boolean isDirPage,
                                         SearchKeyType keyType,
                                         int slotId,
                                         LogSeqNum undoNextLSN)

logSetValClr

public LogSeqNum logSetValClr(long compTxNum,
                              Buffer buff,
                              int offset,
                              Constant newVal,
                              LogSeqNum undoNextLSN)