com.persistit

Class IntegrityCheck

java.lang.Object

com.persistit.Task

com.persistit.IntegrityCheck

All Implemented Interfaces:

Runnable

public class IntegrityCheck
extends Task

A simple integrity checker that traverses all pages within one or more Trees, verifies the internal structure of each page, and verifies the relationships between the pages. Any inconsistency is noted as a IntegrityCheck.Fault.

An application creates an IntegrityCheck, invokes its checkVolume(com.persistit.Volume) or checkTree(com.persistit.Tree) method to perform the integrity check, and then reviews the Faults available through the getFaults() method.

In this version of Persistit, IntegrityCheck operates reliably only on quiescent Trees; if other threads are modifying a Tree while IntegrityCheck is reviewing its structure, spurious faults are likely to be detected.

Version:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IntegrityCheck.Fault A representation of an error or inconsistency within a Tree.

Field Summary

Fields inherited from class com.persistit.Task

_culledMessageCount, _description, _expirationTime, _finishTime, _lastException, _maxMessageLogSize, _messageLog, _messageLogVerbosity, _messageWriter, _owner, _persistit, _startTime, _state, _stop, _suspend, _suspendedDuration, _taskId, _thread, DEFAULT_MAX_MESSAGE_LOG_SIZE, LOG_NORMAL, LOG_VERBOSE, STATE_DONE, STATE_ENDED, STATE_EXPIRED, STATE_FAILED, STATE_NAMES, STATE_NOT_STARTED, STATE_RUNNING, STATE_SUSPENDED

Constructor Summary

Constructors

Constructor and Description
IntegrityCheck(Persistit persistit)

Method Summary

Modifier and Type	Method and Description
boolean	checkTree(Tree tree) Performs the integrity checking process on a Tree.
boolean	checkVolume(Volume volume) Performs the integrity checking process on a Volume.
long	getDataByteCount() Returns the total count of bytes in use (not page structure overhead) in data pages traversed during the integrity checking process.
long	getDataPageCount() Returns the total count of data pages traversed during the integrity checking process.
IntegrityCheck.Fault[]	getFaults() Returns the detected faults
long	getGarbagePageCount()
long	getIndexByteCount() Returns the total count of bytes in use (not page structure overhead) in index pages traversed during the integrity checking process.
long	getIndexHoleCount()
long	getIndexPageCount() Returns the total count of index pages traversed during the integrity checking process.
long	getLongRecordByteCount() Returns the total count of bytes in use (not page structure overhead) in long record pages traversed during the integrity checking process.
long	getLongRecordPageCount() Returns the total count of long record pages traversed during the integrity checking process.
long	getMvvAntiValues()
long	getMvvCount()
long	getMvvOverhead()
double	getProgress() Returns an approximate indication of progress during the integrity checking process, where 0.0 indicates that work has not started, and 1.0 represents completion.
long	getPrunedPagesCount()
long	getPruningErrorCount()
String	getStatus() Returns a displayable String indicating the tree currently being checked and the relative counts of pages that have been traversed.
String	getStatusDetail() Returns a String message describing the current state of this Task, possibly in greater detail than Task.getStatus().
boolean	hasFaults() Indicates whether fault have been detected
static IntegrityCheck	icheck(String treeSelectorString, boolean regex, boolean dontSuspendUpdates, boolean fixHoles, boolean prune, boolean pruneAndClear, boolean verbose, boolean csv)
boolean	isCsvMode() Indicate whether CSV mode is enabled.
boolean	isFixHolesEnabled() Indicate whether missing index pages should be added when an index "hole" is discovered.
boolean	isPruneEnabled() Indicate whether pages containing MVV values should be pruned.
boolean	isSuspendUpdates() Indicate mode of operation.
protected void	runTask() Called by a newly created Thread to perform the task.
void	setCsvMode(boolean csvMode) Control output format.
void	setFixHolesEnabled(boolean fixHoles) Control whether missing index pages should be added when an index "hole" is discovered.
void	setPruneEnabled(boolean prune) Control whether IntegrityCheck should attempt to prune pages containing MVV values.
void	setSuspendUpdates(boolean suspendUpdates) Control mode of operation.
String	toString() Returns a displayable summary of the state of the integrity check, including the number of detected faults, and the page and byte counts.
String	toString(boolean details) Creates A displayable representation of the state of the integrity check, including the number of detected faults, and the page and byte counts.

Methods inherited from class com.persistit.Task

appendMessage, cullMessages, endMessage, getMessageLogSize, getMessageLogVerbosity, getMessages, getMessageWriter, getRemainingTime, isImmediate, now, parseTreeList, poll, populateTaskStatus, postMessage, resume, run, setMaximumTime, setMessageLogVerbosity, setMessageWriter, setPersistit, setup, start, stop, suspend

Methods inherited from class java.lang.Object

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

Constructor Detail

IntegrityCheck

public IntegrityCheck(Persistit persistit)

Method Detail

icheck

public static IntegrityCheck icheck(String treeSelectorString,
                                    boolean regex,
                                    boolean dontSuspendUpdates,
                                    boolean fixHoles,
                                    boolean prune,
                                    boolean pruneAndClear,
                                    boolean verbose,
                                    boolean csv)
                             throws Exception

Throws:

Exception

runTask

protected void runTask()

Description copied from class: Task

Called by a newly created Thread to perform the task.

Specified by:

runTask in class Task

isSuspendUpdates

public boolean isSuspendUpdates()

Indicate mode of operation. If true then all threads attempting to perform updates are blocked while the integrity check is in progress.

Returns:

true if updates are suspended

setSuspendUpdates

public void setSuspendUpdates(boolean suspendUpdates)

Control mode of operation. If true then all threads attempting to perform updates are blocked while the integrity check is in progress.

Parameters:

suspendUpdates - true to suspend updates

setCsvMode

public void setCsvMode(boolean csvMode)

Control output format. When CSV mode is enabled, the output is organized as comma-separated-variable text that can be imported into a spreadsheet.

Parameters:

csvMode -

isCsvMode

public boolean isCsvMode()

Indicate whether CSV mode is enabled. If so the output is organized as comma-separated-variable text that can be imported into a spreadsheet.

Returns:

true if CSV mode is enabled.

isFixHolesEnabled

public boolean isFixHolesEnabled()

Indicate whether missing index pages should be added when an index "hole" is discovered.

Returns:

true if IntegrityCheck will attempt to fix holes.

isPruneEnabled

public boolean isPruneEnabled()

Indicate whether pages containing MVV values should be pruned.

Returns:

true if IntegrityCheck will attempt to prune MVV values.

setFixHolesEnabled

public void setFixHolesEnabled(boolean fixHoles)

Control whether missing index pages should be added when an index "hole" is discovered.

Parameters:

fixHoles - true to attempt to fix holes

setPruneEnabled

public void setPruneEnabled(boolean prune)

Control whether IntegrityCheck should attempt to prune pages containing MVV values.

Parameters:

prune - true to attempt to prune MVV values

hasFaults

public boolean hasFaults()

Indicates whether fault have been detected

Returns:

true if faults were detected

getFaults

public IntegrityCheck.Fault[] getFaults()

Returns the detected faults

Returns:

An array of detected Faults

getIndexPageCount

public long getIndexPageCount()

Returns the total count of index pages traversed during the integrity checking process.

Returns:

The count of pages

getDataPageCount

public long getDataPageCount()

Returns the total count of data pages traversed during the integrity checking process.

Returns:

The count of pages

getLongRecordPageCount

public long getLongRecordPageCount()

Returns the total count of long record pages traversed during the integrity checking process. Long record pages contain segments of long record values.

Returns:

The count of pages

getIndexByteCount

public long getIndexByteCount()

Returns the total count of bytes in use (not page structure overhead) in index pages traversed during the integrity checking process.

Returns:

The count of allocated bytes

getDataByteCount

public long getDataByteCount()

Returns the total count of bytes in use (not page structure overhead) in data pages traversed during the integrity checking process.

Returns:

The count of allocated bytes

getLongRecordByteCount

public long getLongRecordByteCount()

Returns the total count of bytes in use (not page structure overhead) in long record pages traversed during the integrity checking process.

Returns:

The count of allocated bytes

getMvvCount

public long getMvvCount()

Returns:

Count of records containing multiple versions. These will be condensed to primordial values by the CLEANUP_MANAGER.

getMvvOverhead

public long getMvvOverhead()

Returns:

Approximate overhead in bytes occupied by multi-version values. This space will be condensed by the CLEANUP_MANAGER.

getMvvAntiValues

public long getMvvAntiValues()

Returns:

Count records containing AntiValues. These records will be removed from the tree by the CLEANUP_MANAGER.

getIndexHoleCount

public long getIndexHoleCount()

Returns:

Count of pages for which an expected index pointer is missing

getPrunedPagesCount

public long getPrunedPagesCount()

Returns:

Count of pages having MVV values that were pruned

getPruningErrorCount

public long getPruningErrorCount()

Returns:

Count of errors encountered while pruning pages

getGarbagePageCount

public long getGarbagePageCount()

Returns:

Count of garbage pages encountered while checking volumes.

getProgress

public double getProgress()

Returns an approximate indication of progress during the integrity checking process, where 0.0 indicates that work has not started, and 1.0 represents completion.

Returns:

The progress indicator on a scale of 0.0 to 1.0.

getStatusDetail

public String getStatusDetail()

Description copied from class: Task

Returns a String message describing the current state of this Task, possibly in greater detail than Task.getStatus(). The default implementation returns the same description as getStatus.

Overrides:

getStatusDetail in class Task

Returns:

A detailed description of this Task's current state.

getStatus

public String getStatus()

Returns a displayable String indicating the tree currently being checked and the relative counts of pages that have been traversed.

Specified by:

getStatus in class Task

Returns:

The progress description

toString

public String toString()

Returns a displayable summary of the state of the integrity check, including the number of detected faults, and the page and byte counts.

Overrides:

toString in class Object

Returns:

The displayable string

toString

public String toString(boolean details)

Creates A displayable representation of the state of the integrity check, including the number of detected faults, and the page and byte counts. The returned String optionally includes a listing of all detected Faults.

Parameters:

details - If true the returned representation will include a list of all detected Faults.

Returns:

the String representation.

checkVolume

public boolean checkVolume(Volume volume)
                    throws PersistitException

Performs the integrity checking process on a Volume. Logs any detected Faults for subsequent review.

Parameters:

volume - The Volume to check.

Returns:

true if the volume is clean (has no Faults).

Throws:

PersistitException

checkTree

public boolean checkTree(Tree tree)
                  throws PersistitException

Performs the integrity checking process on a Tree. Logs any detected Faults for subsequent review.

Parameters:

tree - The Tree to check.

Returns:

true if the volume is clean (has no Faults).

Throws:

PersistitException