com.sleepycat.je.log

Class LogManager

java.lang.Object

com.sleepycat.je.log.LogManager

public class LogManager
extends Object

The LogManager supports reading and writing to the JE log. The writing of data to the log is serialized via the logWriteMutex. Typically space is allocated under the LWL. The client computes the checksum and copies the data into the log buffer (not holding the LWL).

Constructor Summary

Constructors

Constructor and Description
LogManager(EnvironmentImpl envImpl, boolean readOnly) There is a single log manager per database environment.

Method Summary

Modifier and Type	Method and Description
void	countObsoleteNode(long lsn, LogEntryType type, int size, boolean countExact) Count node as obsolete under the log write latch.
void	countObsoleteNodeDupsAllowed(long lsn, LogEntryType type, int size) A flavor of countObsoleteNode which does not fire an assert if the offset has already been counted.
void	flushNoSync() Flush all log entries to the log but do not fsync.
void	flushSync() Flush all log entries to the log and perform an fsync.
Object	getEntry(long lsn) Fault in the first object in the log entry log entry at this LSN.
Object	getEntryHandleNotFound(long lsn)
long	getLastLsnAtRecovery()
LogEntry	getLogEntry(long lsn) Instantiate all the objects in the log entry at this LSN.
WholeEntry	getLogEntryAllowInvisible(long lsn) Instantiate all the objects in the log entry at this LSN.
WholeEntry	getLogEntryAllowInvisibleAtRecovery(long lsn, int size) Instantiate all the objects in the log entry at this LSN.
WholeEntry	getLogEntryDirectFromFile(long lsn) Reads a log entry using a FileSource, and returns null (rather than throwing a ChecksumException) if the entry exists in a log buffer that was not flushed.
LogEntry	getLogEntryHandleNotFound(long lsn)
LogSource	getLogSource(long lsn) Find the LSN, whether in a file or still in the log buffers.
long	getNCacheMiss() Return the current number of cache misses in a lightweight fashion, without incurring the cost of loading all the stats, and without clearing any stats.
LogBuffer	getReadBufferByLsn(long lsn) Return a log buffer locked for reading, or null if no log buffer holds this LSN location.
TrackedFileSummary	getUnflushableTrackedSummary(long file) Returns a tracked summary for the given file which will not be flushed.
WholeEntry	getWholeLogEntry(long lsn)
WholeEntry	getWholeLogEntryHandleNotFound(long lsn)
void	incRepeatIteratorReads()
void	initExpirationTracker(ExpirationTracker tracker) Called at the end of recovery to begin expiration tracking using the given tracker.
StatGroup	loadStats(StatsConfig config)
long	log(LogEntry entry, ReplicationContext repContext) Write a log entry.
LogItem	log(LogParams params) Log an item, first logging any items on the lazyLogQueue, and finally flushing and sync'ing (if requested).
long	logForceFlip(LogEntry entry) Log this single object and force a flip of the log files.
long	logForceFlush(LogEntry entry, boolean fsyncRequired, ReplicationContext repContext) Log this single object and force a write of the log files.
void	removeTrackedFile(TrackedFileSummary tfs) Removes the tracked summary for the given file.
void	resetPool(DbConfigManager configManager) Reset the pool when the cache is resized.
void	setDelayVLSNRegisterHook(TestHook<Object> hook)
void	setFlushLogHook(TestHook<Object> hook)
void	setLastLsnAtRecovery(long lastLsnAtRecovery)
void	setReadHook(TestHook hook)
void	transferToUtilizationTracker(LocalUtilizationTracker localTracker)

Methods inherited from class java.lang.Object

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

Constructor Detail

LogManager

public LogManager(EnvironmentImpl envImpl,
                  boolean readOnly)
           throws DatabaseException

There is a single log manager per database environment.

Throws:

DatabaseException

Method Detail

getLastLsnAtRecovery

public long getLastLsnAtRecovery()

setLastLsnAtRecovery

public void setLastLsnAtRecovery(long lastLsnAtRecovery)

initExpirationTracker

public void initExpirationTracker(ExpirationTracker tracker)

Called at the end of recovery to begin expiration tracking using the given tracker. During recovery we are single threaded, so we can set the field without taking the LWL.

resetPool

public void resetPool(DbConfigManager configManager)
               throws DatabaseException

Reset the pool when the cache is resized. This method is called after the memory budget has been calculated.

Throws:

DatabaseException

logForceFlush

public long logForceFlush(LogEntry entry,
                          boolean fsyncRequired,
                          ReplicationContext repContext)
                   throws DatabaseException

Log this single object and force a write of the log files.

Parameters:

entry - object to be logged

fsyncRequired - if true, log files should also be fsynced.

Returns:

LSN of the new log entry

Throws:

DatabaseException

logForceFlip

public long logForceFlip(LogEntry entry)
                  throws DatabaseException

Log this single object and force a flip of the log files.

Parameters:

entry - object to be logged

Returns:

LSN of the new log entry

Throws:

DatabaseException

log

public long log(LogEntry entry,
                ReplicationContext repContext)
         throws DatabaseException

Write a log entry.

Parameters:

entry - object to be logged

Returns:

LSN of the new log entry

Throws:

DatabaseException

log

public LogItem log(LogParams params)
            throws DatabaseException

Log an item, first logging any items on the lazyLogQueue, and finally flushing and sync'ing (if requested).

Throws:

DatabaseException

getLogEntry

public LogEntry getLogEntry(long lsn)
                     throws FileNotFoundException,
                            ErasedException

Instantiate all the objects in the log entry at this LSN.

Throws:

FileNotFoundException

ErasedException

getWholeLogEntry

public WholeEntry getWholeLogEntry(long lsn)
                            throws FileNotFoundException,
                                   ErasedException

Throws:

FileNotFoundException

ErasedException

getLogEntryAllowInvisibleAtRecovery

public WholeEntry getLogEntryAllowInvisibleAtRecovery(long lsn,
                                                      int size)
                                               throws FileNotFoundException,
                                                      ErasedException

Instantiate all the objects in the log entry at this LSN. Allow the fetch of invisible log entries if we are in recovery.

Throws:

FileNotFoundException

ErasedException

getLogEntryAllowInvisible

public WholeEntry getLogEntryAllowInvisible(long lsn)
                                     throws FileNotFoundException,
                                            ErasedException

Instantiate all the objects in the log entry at this LSN. The entry may be marked invisible.

Throws:

FileNotFoundException

ErasedException

getLogEntryHandleNotFound

public LogEntry getLogEntryHandleNotFound(long lsn)
                                   throws DatabaseException

Throws:

DatabaseException

getWholeLogEntryHandleNotFound

public WholeEntry getWholeLogEntryHandleNotFound(long lsn)
                                          throws DatabaseException

Throws:

DatabaseException

getEntry

public Object getEntry(long lsn)
                throws FileNotFoundException,
                       ErasedException,
                       DatabaseException

Fault in the first object in the log entry log entry at this LSN.

Parameters:

lsn - location of object in log

Returns:

the object in the log

Throws:

FileNotFoundException

ErasedException

DatabaseException

getEntryHandleNotFound

public Object getEntryHandleNotFound(long lsn)

getLogSource

public LogSource getLogSource(long lsn)
                       throws FileNotFoundException,
                              ChecksumException,
                              DatabaseException

Find the LSN, whether in a file or still in the log buffers. Is public for unit testing.

Throws:

FileNotFoundException

ChecksumException

DatabaseException

getLogEntryDirectFromFile

public WholeEntry getLogEntryDirectFromFile(long lsn)
                                     throws ChecksumException

Reads a log entry using a FileSource, and returns null (rather than throwing a ChecksumException) if the entry exists in a log buffer that was not flushed. Used to check whether an in-memory corruption is persistent.

Returns:

WholeEntry null means that this lsn does not exist in the file, either because the file is not found or the entry is erased.

Throws:

ChecksumException

getReadBufferByLsn

public LogBuffer getReadBufferByLsn(long lsn)

Return a log buffer locked for reading, or null if no log buffer holds this LSN location.

flushSync

public void flushSync()
               throws DatabaseException

Flush all log entries to the log and perform an fsync.

Throws:

DatabaseException

flushNoSync

public void flushNoSync()
                 throws DatabaseException

Flush all log entries to the log but do not fsync.

Throws:

DatabaseException

loadStats

public StatGroup loadStats(StatsConfig config)
                    throws DatabaseException

Throws:

DatabaseException

getNCacheMiss

public long getNCacheMiss()

Return the current number of cache misses in a lightweight fashion, without incurring the cost of loading all the stats, and without clearing any stats.

getUnflushableTrackedSummary

public TrackedFileSummary getUnflushableTrackedSummary(long file)

Returns a tracked summary for the given file which will not be flushed.

removeTrackedFile

public void removeTrackedFile(TrackedFileSummary tfs)

Removes the tracked summary for the given file.

countObsoleteNode

public void countObsoleteNode(long lsn,
                              LogEntryType type,
                              int size,
                              boolean countExact)

Count node as obsolete under the log write latch. This is done here because the log write latch is managed here, and all utilization counting must be performed under the log write latch.

countObsoleteNodeDupsAllowed

public void countObsoleteNodeDupsAllowed(long lsn,
                                         LogEntryType type,
                                         int size)

A flavor of countObsoleteNode which does not fire an assert if the offset has already been counted. Called through the LogManager so that this incidence of all utilization counting can be performed under the log write latch.

transferToUtilizationTracker

public void transferToUtilizationTracker(LocalUtilizationTracker localTracker)
                                  throws DatabaseException

Throws:

DatabaseException

See Also:

BaseUtilizationTracker.transferToUtilizationTracker(com.sleepycat.je.cleaner.UtilizationTracker)

incRepeatIteratorReads

public void incRepeatIteratorReads()

setReadHook

public void setReadHook(TestHook hook)

setDelayVLSNRegisterHook

public void setDelayVLSNRegisterHook(TestHook<Object> hook)

setFlushLogHook

public void setFlushLogHook(TestHook<Object> hook)