com.sleepycat.je.tree

Class LN

java.lang.Object

com.sleepycat.je.tree.Node

com.sleepycat.je.tree.LN

All Implemented Interfaces:

Loggable, VersionedWriteLoggable

Direct Known Subclasses:

DupCountLN, FileSummaryLN, MapLN, NameLN, VersionedLN

public class LN
extends Node
implements VersionedWriteLoggable

An LN represents a Leaf Node in the JE tree.

Field Summary

Fields inherited from class com.sleepycat.je.tree.Node

NULL_NODE_ID

Constructor Summary

Constructors

Constructor and Description
LN() Create an empty LN, to be filled in from the log.
LN(SizeofMarker marker, DatabaseEntry dbt) For Sizeof.

Method Summary

Modifier and Type	Method and Description
void	addExtraMarshaledMemorySize(BIN parentBIN) Account for FileSummaryLN's extra marshaled memory.
String	beginTag()
void	clearDirty()
static byte[]	copyEntryData(DatabaseEntry entry) Returns a byte array that is a complete copy of the data in a non-partial entry.
void	delete()
void	dumpKey(StringBuilder sb, byte[] key)
void	dumpLog(StringBuilder sb, boolean verbose) Write the object into the string buffer for log dumping.
protected void	dumpLogAdditional(StringBuilder sb, boolean verbose)
String	dumpString(int nSpaces, boolean dumpTags)
String	endTag()
byte[]	getData()
Collection<VersionedWriteLoggable>	getEmbeddedLoggables()
boolean	getFetchedCold()
LogEntryType	getGenericLogType() Returns the generic LogEntryType for this node.
int	getLastFormatChange() Returns the log version of the most recent format change for this loggable item.
int	getLogSize()
int	getLogSize(int logVersion, boolean forReplication) Returns the number of bytes needed to store this object in the format for the specified log version.
protected LogEntryType	getLogType(boolean isInsert, boolean isTransactional, DatabaseImpl db)
long	getMemorySizeIncludedByParent() Compute the approximate size of this node in memory for evictor invocation purposes.
long	getVLSNSequence() Called by CursorImpl to get the record version.
boolean	hasReplicationFormat() Returns whether this format has a variant that is optimized for replication.
boolean	isDeleted()
boolean	isDirty()
boolean	isLN()
boolean	isReplicationFormatWorthwhile(ByteBuffer logBuffer, int srcVersion, int destVersion) Returns whether it is worthwhile to materialize and then re-serialize a log entry in a format optimized for replication.
LogItem	log(EnvironmentImpl envImpl, DatabaseImpl dbImpl, Locker locker, WriteLockInfo writeLockInfo, boolean newEmbeddedLN, byte[] newKey, int newExpiration, boolean newExpirationInHours, boolean currEmbeddedLN, long currLsn, int currSize, boolean isInsertion, boolean backgroundIO, ReplicationContext repContext) Convenience logging method, used to migrate an LN during cleaning.
boolean	logicalEquals(Loggable other)
static LN	makeLN(EnvironmentImpl envImpl, byte[] dataParam) Create a new LN from a byte array.
static LN	makeLN(EnvironmentImpl envImpl, DatabaseEntry dbt) Create a new LN from a DatabaseEntry.
void	modify(byte[] newData)
LogItem	optionalLog(EnvironmentImpl envImpl, DatabaseImpl dbImpl, Locker locker, WriteLockInfo writeLockInfo, boolean newEmbeddedLN, byte[] newKey, int newExpiration, boolean newExpirationInHours, boolean currEmbeddedLN, long currLsn, int currSize, boolean isInsertion, ReplicationContext repContext) Convenience logging method.
void	postFetchInit(DatabaseImpl db, long sourceLsn) Initialize a node that has been faulted in from the log.
void	readFromLog(ByteBuffer itemBuffer, int entryVersion) Initialize this object from the data in itemBuf.
static byte[]	resolvePartialEntry(DatabaseEntry entry, byte[] foundDataBytes) Merges the partial entry with the given byte array, effectively applying a partial entry to an existing record, and returns a enw byte array.
void	setDirty()
byte[]	setEmpty() Sets data to empty and returns old data.
void	setEntry(DatabaseEntry entry) Copies the non-deleted LN's byte array to the entry.
static void	setEntry(DatabaseEntry dest, byte[] bytes) Copies the given byte array to the given destination entry, copying only partial data if the entry is specified to be partial.
static void	setEntry(DatabaseEntry dest, DatabaseEntry src) Copies the given source entry to the given destination entry, copying only partial data if the destination entry is specified to be partial.
void	setFetchedCold(boolean val)
void	setVLSNSequence(long seq) Called by LogManager after writing an LN with a newly assigned VLSN, and called by LNLogEntry after reading the LN with the VLSN from the log entry header.
void	writeToLog(ByteBuffer logBuffer) Serialize this object into the buffer.
void	writeToLog(ByteBuffer logBuffer, int logVersion, boolean forReplication) Serializes this object into the specified buffer in the format for the specified log version.

Methods inherited from class com.sleepycat.je.tree.Node

containsDuplicates, dump, getLevel, getTransactionId, getType, isBIN, isBINDelta, isBINDelta, isDBIN, isDIN, isIN, isUpperIN, latch, latchShared, latchShared, releaseLatch, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sleepycat.je.log.Loggable

getTransactionId

Constructor Detail

LN

public LN()

Create an empty LN, to be filled in from the log. If VLSNs are preserved for this environment, a VersionedLN will be created instead.

LN

public LN(SizeofMarker marker,
          DatabaseEntry dbt)

For Sizeof.

Method Detail

makeLN

public static LN makeLN(EnvironmentImpl envImpl,
                        byte[] dataParam)

Create a new LN from a byte array. Pass a null byte array to create a deleted LN. Does NOT copy the byte array, so after calling this method the array is "owned" by the Btree and should not be modified.

makeLN

public static LN makeLN(EnvironmentImpl envImpl,
                        DatabaseEntry dbt)

Create a new LN from a DatabaseEntry. Makes a copy of the byte array.

getData

public byte[] getData()

isDeleted

public boolean isDeleted()

isLN

public boolean isLN()

Overrides:

isLN in class Node

isDirty

public boolean isDirty()

setDirty

public void setDirty()

clearDirty

public void clearDirty()

getFetchedCold

public boolean getFetchedCold()

setFetchedCold

public void setFetchedCold(boolean val)

postFetchInit

public void postFetchInit(DatabaseImpl db,
                          long sourceLsn)

Description copied from class: Node

Initialize a node that has been faulted in from the log.

Overrides:

postFetchInit in class Node

getVLSNSequence

public long getVLSNSequence()

Called by CursorImpl to get the record version. If VLSNs are not preserved for this environment, returns -1 which is the sequence for VLSN.NULL_VLSN. If VLSNs are preserved for this environment, this method is overridden by VersionedLN which returns the VLSN sequence.

setVLSNSequence

public void setVLSNSequence(long seq)

Called by LogManager after writing an LN with a newly assigned VLSN, and called by LNLogEntry after reading the LN with the VLSN from the log entry header. If VLSNs are not preserved for this environment, does nothing. If VLSNs are preserved for this environment, this method is overridden by VersionedLN which stores the VLSN sequence.

delete

public void delete()

modify

public void modify(byte[] newData)

setEmpty

public byte[] setEmpty()

Sets data to empty and returns old data. Called when converting an old format LN in a duplicates DB.

getMemorySizeIncludedByParent

public long getMemorySizeIncludedByParent()

Compute the approximate size of this node in memory for evictor invocation purposes.

Overrides:

getMemorySizeIncludedByParent in class Node

beginTag

public String beginTag()

endTag

public String endTag()

dumpString

public String dumpString(int nSpaces,
                         boolean dumpTags)

optionalLog

public LogItem optionalLog(EnvironmentImpl envImpl,
                           DatabaseImpl dbImpl,
                           Locker locker,
                           WriteLockInfo writeLockInfo,
                           boolean newEmbeddedLN,
                           byte[] newKey,
                           int newExpiration,
                           boolean newExpirationInHours,
                           boolean currEmbeddedLN,
                           long currLsn,
                           int currSize,
                           boolean isInsertion,
                           ReplicationContext repContext)
                    throws DatabaseException

Convenience logging method. See logInternal. For a deferred-write database, the logging will not actually occur and a transient LSN will be created and returned if the currLsn is NULL; otherwise the currLsn is returned. However, if the embeddedness of the LN changes, we must create a real logrec for the op. The following scenario is an example of what can go wrong if we don't log embeddedness changes: - R1 exists before DB is opened in DW mode. - R1 is embedded, so its on-disk image has been counted obsolete and might have been deleted already. - R1 is updated in DW mode, and its new version, R2, is not embedded (and not logged). Furthermore, the slot LSN points to R1 still. - R2 gets evicted and logged. As a result, R1 will be counted as obsolete again, because the slot points to R1 and says R1 is not embedded. If we do log embeddedness changes, then in the above scenario, R2 will be logged and this logging will not count R1 as obsolete, because the embedded flag in the slot still says that R1 is embedded. After R2 is logged, the slot is updated (both the slot LSN and the embedded flag). In general, the embedded flag in the slot must be in accord with the embedded flag in the last logged version of a record, even if multiple updates were done on the record since the last time it was logged and the current logging event.

Throws:

DatabaseException

log

public LogItem log(EnvironmentImpl envImpl,
                   DatabaseImpl dbImpl,
                   Locker locker,
                   WriteLockInfo writeLockInfo,
                   boolean newEmbeddedLN,
                   byte[] newKey,
                   int newExpiration,
                   boolean newExpirationInHours,
                   boolean currEmbeddedLN,
                   long currLsn,
                   int currSize,
                   boolean isInsertion,
                   boolean backgroundIO,
                   ReplicationContext repContext)
            throws DatabaseException

Convenience logging method, used to migrate an LN during cleaning. See logInternal.

Throws:

DatabaseException

getGenericLogType

public LogEntryType getGenericLogType()

Description copied from class: Node

Returns the generic LogEntryType for this node. Returning the actual type used to log the node is not always possible. Specifically, for LN nodes the generic type is less specific than the actual type used to log the node: + A non-transactional type is always returned. + LOG_INS_LN is returned rather than LOG_UPD_LN. + LOG_DEL_LN is returned rather than LOG_DEL_DUPLN.

Specified by:

getGenericLogType in class Node

See Also:

Node.getGenericLogType()

getLogType

protected LogEntryType getLogType(boolean isInsert,
                                  boolean isTransactional,
                                  DatabaseImpl db)

getLastFormatChange

public int getLastFormatChange()

Description copied from interface: VersionedWriteLoggable

Returns the log version of the most recent format change for this loggable item.

Specified by:

getLastFormatChange in interface VersionedWriteLoggable

Returns:

the log version of the most recent format change

See Also:

VersionedWriteLoggable.getLastFormatChange()

getEmbeddedLoggables

public Collection<VersionedWriteLoggable> getEmbeddedLoggables()

Specified by:

getEmbeddedLoggables in interface VersionedWriteLoggable

See Also:

ReplicableLogEntry.getEmbeddedLoggables()

getLogSize

public int getLogSize()

Specified by:

getLogSize in interface Loggable

Returns:

number of bytes used to store this object.

writeToLog

public void writeToLog(ByteBuffer logBuffer)

Description copied from interface: Loggable

Serialize this object into the buffer.

Specified by:

writeToLog in interface Loggable

Parameters:

logBuffer - is the destination buffer

getLogSize

public int getLogSize(int logVersion,
                      boolean forReplication)

Description copied from interface: VersionedWriteLoggable

Returns the number of bytes needed to store this object in the format for the specified log version. Earlier log versions only need to be supported for log entries with format changes made in LogEntryType.LOG_VERSION_REPLICATE_OLDER or greater.

Specified by:

getLogSize in interface VersionedWriteLoggable

Parameters:

logVersion - the log version

forReplication - whether the entry will be sent over the wire, and not written to the log.

Returns:

the number of bytes to store this object for the log version

writeToLog

public void writeToLog(ByteBuffer logBuffer,
                       int logVersion,
                       boolean forReplication)

Description copied from interface: VersionedWriteLoggable

Serializes this object into the specified buffer in the format for the specified log version. Earlier log versions only need to be supported for log entries with format changes made in LogEntryType.LOG_VERSION_REPLICATE_OLDER or greater.

Specified by:

writeToLog in interface VersionedWriteLoggable

Parameters:

logBuffer - the destination buffer

logVersion - the log version

forReplication - whether the entry will be sent over the wire, and not written to the log.

readFromLog

public void readFromLog(ByteBuffer itemBuffer,
                        int entryVersion)

Description copied from interface: Loggable

Initialize this object from the data in itemBuf.

Specified by:

readFromLog in interface Loggable

Parameters:

itemBuffer - the source buffer

entryVersion - the log version of the data

hasReplicationFormat

public boolean hasReplicationFormat()

Description copied from interface: VersionedWriteLoggable

Returns whether this format has a variant that is optimized for replication.

Specified by:

hasReplicationFormat in interface VersionedWriteLoggable

isReplicationFormatWorthwhile

public boolean isReplicationFormatWorthwhile(ByteBuffer logBuffer,
                                             int srcVersion,
                                             int destVersion)

Description copied from interface: VersionedWriteLoggable

Returns whether it is worthwhile to materialize and then re-serialize a log entry in a format optimized for replication. Implementations should attempt to check efficiently, without instantiating the log entry object. Some implementations will simply return false.

WARNING: The logBuffer position must not be changed by this method.

WARNING: The shared LogEntry object is used for calling this method, and this method must not change any of the fields in the object.

Specified by:

isReplicationFormatWorthwhile in interface VersionedWriteLoggable

Parameters:

logBuffer - contains the entry that would be re-serialized.

srcVersion - the log version of entry in logBuffer.

destVersion - the version that would be used for re-serialization.

logicalEquals

public boolean logicalEquals(Loggable other)

Specified by:

logicalEquals in interface Loggable

Returns:

true if these two loggable items are logically the same. Used for replication testing.

dumpLog

public void dumpLog(StringBuilder sb,
                    boolean verbose)

Description copied from interface: Loggable

Write the object into the string buffer for log dumping. Each object should be dumped without indentation or new lines and should be valid XML.

Specified by:

dumpLog in interface Loggable

Parameters:

sb - destination string buffer

verbose - if true, dump the full, verbose version

dumpKey

public void dumpKey(StringBuilder sb,
                    byte[] key)

dumpLogAdditional

protected void dumpLogAdditional(StringBuilder sb,
                                 boolean verbose)

addExtraMarshaledMemorySize

public void addExtraMarshaledMemorySize(BIN parentBIN)

Account for FileSummaryLN's extra marshaled memory. [#17462]

setEntry

public void setEntry(DatabaseEntry entry)

Copies the non-deleted LN's byte array to the entry. Does not support partial data.

setEntry

public static void setEntry(DatabaseEntry dest,
                            byte[] bytes)

Copies the given byte array to the given destination entry, copying only partial data if the entry is specified to be partial. If the byte array is null, clears the entry.

setEntry

public static void setEntry(DatabaseEntry dest,
                            DatabaseEntry src)

Copies the given source entry to the given destination entry, copying only partial data if the destination entry is specified to be partial.

copyEntryData

public static byte[] copyEntryData(DatabaseEntry entry)

Returns a byte array that is a complete copy of the data in a non-partial entry.

resolvePartialEntry

public static byte[] resolvePartialEntry(DatabaseEntry entry,
                                         byte[] foundDataBytes)

Merges the partial entry with the given byte array, effectively applying a partial entry to an existing record, and returns a enw byte array.