com.sleepycat.je.tree
Class IN

java.lang.Object
  extended by com.sleepycat.je.tree.Node
      extended by com.sleepycat.je.tree.IN
All Implemented Interfaces:
Loggable, java.lang.Comparable<IN>
Direct Known Subclasses:
BIN, DIN

public class IN
extends Node
implements java.lang.Comparable<IN>, Loggable

An IN represents an Internal Node in the JE tree.


Field Summary
static int ACCUMULATED_LIMIT
           
static int BIN_LEVEL
           
static int DBMAP_LEVEL
           
static int EXACT_MATCH
           
static int INSERT_SUCCESS
           
protected  SharedLatch latch
           
static int LEVEL_MASK
           
static int MAIN_LEVEL
           
static int MAX_LEVEL
           
static int MAY_EVICT_LNS
           
static int MAY_EVICT_NODE
           
static int MAY_NOT_EVICT
           
static int MIN_LEVEL
           
 
Constructor Summary
IN()
          Create an empty IN, with no node id, to be filled in from the log.
IN(DatabaseImpl dbImpl, byte[] identifierKey, int capacity, int level)
          Create a new IN.
 
Method Summary
 void afterLog(LogManager logManager, INLogItem item, INLogContext context)
          Post-log processing.
 void beforeLog(LogManager logManager, INLogItem item, INLogContext context)
          Pre-log processing.
 java.lang.String beginTag()
           
protected  boolean canBeAncestor(boolean targetContainsDuplicates)
           
 void clearLsn(int idx)
          Set the LSN to null for the idx'th entry of this node.
 void clearPendingDeleted(int idx)
          Set pendingDeleted to false.
 int compareTo(IN argIN)
          Sort based on equality key.
 boolean compress(BINReference binRef, boolean canFetch, LocalUtilizationTracker localTracker)
           
protected static long computeArraysOverhead(DbConfigManager configManager)
           
protected  long computeMemorySize()
          Count up the memory usage attributable to this node alone.
static long computeOverhead(DbConfigManager configManager)
           
protected  IN createNewInstance(byte[] identifierKey, int maxEntries, int level)
          Create a new IN.
 boolean deleteEntry(int index, boolean maybeValidate)
          Deletes the ChildReference at index from this IN.
protected  void descendOnParentSearch(SearchResult result, boolean targetContainsDuplicates, boolean targetIsRoot, long targetNodeId, Node child, boolean requireExactMatch)
           
 void dumpLog(java.lang.StringBuffer sb, boolean verbose)
          Write the object into the string buffer for log dumping.
protected  void dumpLogAdditional(java.lang.StringBuffer sb)
          Allows subclasses to add additional fields before the end tag.
 java.lang.String dumpString(int nSpaces, boolean dumpTags)
          For unit test support:
 java.lang.String endTag()
           
 boolean equals(java.lang.Object obj)
           
 Node fetchTarget(int idx)
          Returns the target of the idx'th entry or null if a pendingDeleted or knownDeleted entry has been cleaned.
 int findEntry(byte[] key, boolean indicateIfDuplicate, boolean exact)
          Find the entry in this IN for which key arg is >= the key.
protected  int generateLevel(DatabaseId dbId, int newLevel)
           
 long getBudgetedMemorySize()
          Returns the amount of memory currently budgeted for this IN.
 byte[] getChildKey(IN child)
          Get the key (dupe or identifier) in child that is used to locate it in 'this' node.
 DatabaseImpl getDatabase()
          Get the database for this IN.
 DatabaseId getDatabaseId()
           
 boolean getDirty()
           
 byte[] getDupKey()
          Return the key for this duplicate set.
 byte[] getDupTreeKey()
          Return the key for navigating through the duplicate tree.
protected  long getEntryInMemorySize(byte[] key, Node target)
           
 int getEvictionType()
          Returns the eviction type for this IN, for use by the evictor.
 long getGeneration()
           
 byte[] getIdentifierKey()
           
 boolean getInListResident()
          Returns whether this IN is on the INList.
 long getInMemorySize()
          For unit tests.
 byte[] getKey(int idx)
          Return the idx'th key.
 java.util.Comparator<byte[]> getKeyComparator()
          Return the relevant user defined comparison function for this type of node.
 long getLastFullVersion()
          Returns the last logged LSN, or null if never logged.
 int getLevel()
          Cover for LN's and just return 0 since they'll always be at the bottom of the tree.
 int getLogSize()
           
 LogEntryType getLogType()
           
 long getLsn(int idx)
          Return the idx'th LSN for this entry.
 byte[] getMainTreeKey()
          Return the key for navigating through the main tree.
protected  long getMemoryOverhead(MemoryBudget mb)
           
 boolean getMigrate(int idx)
          Get the idx'th migrate status.
 int getNEntries()
           
 boolean getRecalcToggle()
           
 byte getState(int idx)
           
 Node getTarget(int idx)
          Return the idx'th target.
 long getTreeAdminMemorySize()
          Returns the treeAdmin memory in objects referenced by this IN.
 int hashCode()
          We would like as even a hash distribution as possible so that the Evictor's LRU is as accurate as possible.
protected  void init(DatabaseImpl db, byte[] identifierKey, int initialCapacity, int level)
          Initialize IN object.
protected  void initMemorySize()
          Initialize the per-node memory count by computing its memory usage.
 boolean insertEntry(ChildReference entry)
          Inserts the argument ChildReference into this IN.
 int insertEntry1(ChildReference entry)
          Same as insertEntry except that it returns the index where the dup was found instead of false.
 boolean isCompressible()
           
 boolean isDbRoot()
           
 boolean isEntryKnownDeleted(int idx)
           
 boolean isEntryPendingDeleted(int idx)
           
 boolean isEvictable()
          Returns whether this node can be evicted.
 boolean isKeyInBounds(byte[] keyVal)
          Returns whether the given key is greater than or equal to the first key in the IN and less than or equal to the last key in the IN.
 boolean isLatchOwnerForRead()
           
 boolean isLatchOwnerForWrite()
           
 boolean isRoot()
           
protected  boolean isSoughtNode(long nid, CacheMode cacheMode)
           
 void latch()
          Latch this node exclusive and set the generation.
 void latch(CacheMode cacheMode)
          Latch this node exclusive, optionally setting the generation.
 boolean latchNoWait()
          Latch this node if it is not latched by another thread, and set the generation if the latch succeeds.
 boolean latchNoWait(CacheMode cacheMode)
          Latch this node if it is not latched by another thread, optionally setting the generation if the latch succeeds.
 void latchShared()
          Latch this node shared and set the generation.
 void latchShared(CacheMode cacheMode)
          Latch this node shared, optionally setting the generation.
 long log(LogManager logManager)
          Log this IN and clear the dirty flag.
 long log(LogManager logManager, boolean allowDeltas, boolean isProvisional, boolean proactiveMigration, boolean backgroundIO, IN parent)
          Log this node with all available options.
 long log(LogManager logManager, boolean allowDeltas, Provisional provisional, boolean proactiveMigration, boolean backgroundIO, IN parent)
           
 void logDirtyChildren()
          When splits and checkpoints intermingle in a deferred write databases, a checkpoint target may appear which has a valid target but a null LSN.
 boolean logicalEquals(Loggable other)
           
 boolean needsSplitting()
          Return true if this node needs splitting.
 long optionalLog(LogManager logManager)
          Log this IN and clear the dirty flag.
 long optionalLogProvisional(LogManager logManager, IN parent)
          Log this node provisionally and clear the dirty flag.
 void postFetchInit(DatabaseImpl db, long sourceLsn)
          Initialize a node that has been read in from the log.
 void postRecoveryInit(DatabaseImpl db, long sourceLsn)
          Initialize a node read in during recovery.
 void readFromLog(java.nio.ByteBuffer itemBuffer, byte entryVersion)
          Initialize this object from the data in itemBuf.
 void releaseLatch()
          Release the latch on this node.
 void releaseLatchIfOwner()
          Release the latch on this node.
 byte[] selectKey(byte[] mainTreeKey, byte[] dupTreeKey)
           
 void setDatabase(DatabaseImpl db)
          Set the database reference for this node.
 void setDirty(boolean dirty)
           
 void setEntry(int idx, Node target, byte[] keyVal, long lsn, byte state)
          Set the idx'th entry of this node.
 void setGeneration(CacheMode cacheMode)
           
 void setGeneration(long newGeneration)
           
 void setInListResident(boolean resident)
          Called when adding/removing this IN to/from the INList.
 void setMigrate(int idx, boolean migrate)
          Set the idx'th migrate status.
 void setPendingDeleted(int idx)
          Set pendingDeleted to true.
 void setProhibitNextDelta()
          Do nothing since INs don't support deltas.
 void setRecalcToggle(boolean toggle)
           
 java.lang.String shortClassName()
           
protected  void splitInternal(IN parent, int childIndex, int maxEntries, int splitIndex, CacheMode cacheMode)
           
 java.lang.String toString()
          Default toString method at the root of the tree.
 void updateEntry(int idx, long lsn)
          Update the idx'th entry of this node.
 void updateEntry(int idx, long lsn, byte state)
          Update the idx'th entry of this node.
 void updateEntry(int idx, Node node, long lsn, byte[] key)
          Update the idx'th entry of this node.
protected  void updateMemorySize(ChildReference oldRef, ChildReference newRef)
           
protected  void updateMemorySize(long oldSize, long newSize)
           
 void updateNode(int idx, Node node, byte[] lnSlotKey)
          Update the idx'th entry, replacing the node and, if appropriate, the LN slot key.
 void updateNode(int idx, Node node, long lsn, byte[] lnSlotKey)
          Update the idx'th entry, replacing the node and, if appropriate, the LN slot key.
 void updateNode(int idx, Node node, long oldSize, long lsn, byte[] lnSlotKey)
          Update the idx'th entry of this node.
 void verify(byte[] maxKey)
          Check that the IN is in a valid state.
 boolean verifyMemorySize()
           
 void writeToLog(java.nio.ByteBuffer logBuffer)
          Serialize this object into the buffer.
 
Methods inherited from class com.sleepycat.je.tree.Node
containsDuplicates, dump, getMemorySizeIncludedByParent, getNodeId, getTransactionId, getType, shortDescription
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.sleepycat.je.log.Loggable
getTransactionId
 

Field Detail

DBMAP_LEVEL

public static final int DBMAP_LEVEL
See Also:
Constant Field Values

MAIN_LEVEL

public static final int MAIN_LEVEL
See Also:
Constant Field Values

LEVEL_MASK

public static final int LEVEL_MASK
See Also:
Constant Field Values

MIN_LEVEL

public static final int MIN_LEVEL
See Also:
Constant Field Values

MAX_LEVEL

public static final int MAX_LEVEL
See Also:
Constant Field Values

BIN_LEVEL

public static final int BIN_LEVEL
See Also:
Constant Field Values

MAY_NOT_EVICT

public static final int MAY_NOT_EVICT
See Also:
Constant Field Values

MAY_EVICT_LNS

public static final int MAY_EVICT_LNS
See Also:
Constant Field Values

MAY_EVICT_NODE

public static final int MAY_EVICT_NODE
See Also:
Constant Field Values

latch

protected SharedLatch latch

EXACT_MATCH

public static final int EXACT_MATCH
See Also:
Constant Field Values

INSERT_SUCCESS

public static final int INSERT_SUCCESS
See Also:
Constant Field Values

ACCUMULATED_LIMIT

public static int ACCUMULATED_LIMIT
Constructor Detail

IN

public IN()
Create an empty IN, with no node id, to be filled in from the log.


IN

public IN(DatabaseImpl dbImpl,
          byte[] identifierKey,
          int capacity,
          int level)
Create a new IN.

Method Detail

init

protected void init(DatabaseImpl db,
                    byte[] identifierKey,
                    int initialCapacity,
                    int level)
Initialize IN object.


initMemorySize

protected void initMemorySize()
Initialize the per-node memory count by computing its memory usage.


equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
We would like as even a hash distribution as possible so that the Evictor's LRU is as accurate as possible. ConcurrentHashMap takes the value returned by this method and runs its own hash algorithm on it. So a bit complement of the node ID is sufficent as the return value and is a little better than returning just the node ID. If we use a different container in the future that does not re-hash the return value, we should probably implement the Wang-Jenkins hash function here.

Overrides:
hashCode in class java.lang.Object

compareTo

public int compareTo(IN argIN)
Sort based on equality key.

Specified by:
compareTo in interface java.lang.Comparable<IN>

createNewInstance

protected IN createNewInstance(byte[] identifierKey,
                               int maxEntries,
                               int level)
Create a new IN. Need this because we can't call newInstance() without getting a 0 for nodeid.


postFetchInit

public void postFetchInit(DatabaseImpl db,
                          long sourceLsn)
                   throws DatabaseException
Initialize a node that has been read in from the log.

Overrides:
postFetchInit in class Node
Throws:
DatabaseException

postRecoveryInit

public void postRecoveryInit(DatabaseImpl db,
                             long sourceLsn)
Initialize a node read in during recovery.


getLastFullVersion

public long getLastFullVersion()
Returns the last logged LSN, or null if never logged. Is public for unit testing.


latch

public void latch(CacheMode cacheMode)
           throws DatabaseException
Latch this node exclusive, optionally setting the generation.

Throws:
DatabaseException

latchShared

public void latchShared(CacheMode cacheMode)
                 throws DatabaseException
Latch this node shared, optionally setting the generation.

Overrides:
latchShared in class Node
Throws:
DatabaseException

latchNoWait

public boolean latchNoWait(CacheMode cacheMode)
                    throws DatabaseException
Latch this node if it is not latched by another thread, optionally setting the generation if the latch succeeds.

Throws:
DatabaseException

latch

public void latch()
           throws DatabaseException
Latch this node exclusive and set the generation.

Throws:
DatabaseException

latchShared

public void latchShared()
                 throws DatabaseException
Latch this node shared and set the generation.

Overrides:
latchShared in class Node
Throws:
DatabaseException

latchNoWait

public boolean latchNoWait()
                    throws DatabaseException
Latch this node if it is not latched by another thread, and set the generation if the latch succeeds.

Throws:
DatabaseException

releaseLatch

public void releaseLatch()
                  throws LatchNotHeldException
Release the latch on this node.

Overrides:
releaseLatch in class Node
Throws:
LatchNotHeldException

releaseLatchIfOwner

public void releaseLatchIfOwner()
                         throws LatchNotHeldException
Release the latch on this node.

Throws:
LatchNotHeldException

isLatchOwnerForRead

public boolean isLatchOwnerForRead()
Returns:
true if this thread holds the IN's latch

isLatchOwnerForWrite

public boolean isLatchOwnerForWrite()

getGeneration

public long getGeneration()

setGeneration

public void setGeneration(CacheMode cacheMode)

setGeneration

public void setGeneration(long newGeneration)

getLevel

public int getLevel()
Description copied from class: Node
Cover for LN's and just return 0 since they'll always be at the bottom of the tree.

Overrides:
getLevel in class Node

generateLevel

protected int generateLevel(DatabaseId dbId,
                            int newLevel)

getDirty

public boolean getDirty()

setDirty

public void setDirty(boolean dirty)

getRecalcToggle

public boolean getRecalcToggle()

setRecalcToggle

public void setRecalcToggle(boolean toggle)

isRoot

public boolean isRoot()

isDbRoot

public boolean isDbRoot()

getIdentifierKey

public byte[] getIdentifierKey()
Returns:
the identifier key for this node.

getChildKey

public byte[] getChildKey(IN child)
                   throws DatabaseException
Get the key (dupe or identifier) in child that is used to locate it in 'this' node.

Throws:
DatabaseException

selectKey

public byte[] selectKey(byte[] mainTreeKey,
                        byte[] dupTreeKey)

getDupKey

public byte[] getDupKey()
                 throws DatabaseException
Return the key for this duplicate set.

Throws:
DatabaseException

getDupTreeKey

public byte[] getDupTreeKey()
Return the key for navigating through the duplicate tree.


getMainTreeKey

public byte[] getMainTreeKey()
Return the key for navigating through the main tree.


getDatabase

public DatabaseImpl getDatabase()
Get the database for this IN.


setDatabase

public void setDatabase(DatabaseImpl db)
Set the database reference for this node.


getDatabaseId

public DatabaseId getDatabaseId()

getKey

public byte[] getKey(int idx)
Return the idx'th key. If prefixing is enabled, construct a new byte[] containing the prefix and suffix. If prefixing is not enabled, just return the current byte[] in entryKeyVals[].


getMigrate

public boolean getMigrate(int idx)
Get the idx'th migrate status.


setMigrate

public void setMigrate(int idx,
                       boolean migrate)
Set the idx'th migrate status.


getState

public byte getState(int idx)

getTarget

public Node getTarget(int idx)
Return the idx'th target.


getLsn

public long getLsn(int idx)
Return the idx'th LSN for this entry.

Returns:
the idx'th LSN for this entry.

isEntryPendingDeleted

public boolean isEntryPendingDeleted(int idx)
Returns:
true if the idx'th entry has been deleted, although the transaction that performed the deletion may not be committed.

setPendingDeleted

public void setPendingDeleted(int idx)
Set pendingDeleted to true.


clearPendingDeleted

public void clearPendingDeleted(int idx)
Set pendingDeleted to false.


isEntryKnownDeleted

public boolean isEntryKnownDeleted(int idx)
Returns:
true if the idx'th entry is deleted for sure. If a transaction performed the deletion, it has been committed.

getNEntries

public int getNEntries()
Returns:
the number of entries in this node.

fetchTarget

public Node fetchTarget(int idx)
                 throws DatabaseException
Returns the target of the idx'th entry or null if a pendingDeleted or knownDeleted entry has been cleaned. Note that null can only be returned for a slot that could contain a deleted LN, not other node types and not a DupCountLN since DupCountLNs are never deleted. Null is also returned for a KnownDeleted slot with a NULL_LSN.

Returns:
the target node or null.
Throws:
DatabaseException

setEntry

public void setEntry(int idx,
                     Node target,
                     byte[] keyVal,
                     long lsn,
                     byte state)
Set the idx'th entry of this node.


clearLsn

public void clearLsn(int idx)
Set the LSN to null for the idx'th entry of this node. Only allowed for a temporary database. Used to wipe an LSN for a file that is being cleaned and will be deleted.


updateNode

public void updateNode(int idx,
                       Node node,
                       long oldSize,
                       long lsn,
                       byte[] lnSlotKey)
Update the idx'th entry of this node. This flavor is used when the target LN is being modified, by an operation like a delete or update. We don't have to check whether the LSN has been nulled or not, because we know an LSN existed before. Also, the modification of the target is done in the caller, so instead of passing in the old and new nodes, we pass in the new node and old size.


updateNode

public void updateNode(int idx,
                       Node node,
                       byte[] lnSlotKey)
Update the idx'th entry, replacing the node and, if appropriate, the LN slot key. See updateNode(int, Node, long, byte[]) for details. Note that the LSN is not passed to this method because the node has been either (a) fetched in from disk and is not dirty, or (b) will be written out later by something like a checkpoint. Note: does not dirty the node unless the LN slot key is changed.


updateNode

public void updateNode(int idx,
                       Node node,
                       long lsn,
                       byte[] lnSlotKey)
Update the idx'th entry, replacing the node and, if appropriate, the LN slot key. The updateNode methods are special versions of updateEntry that are called to update the node in a slot. When an LN node is changed, the slot key may also need to be updated when a partial key comparator is used. Callers must be sure to pass the correct lnSlotKey parameter when passing an LN for the node parameter. See setLNSlotKey for details. [#15704]


updateEntry

public void updateEntry(int idx,
                        Node node,
                        long lsn,
                        byte[] key)
Update the idx'th entry of this node. Note that although this method allows updating the node, it always replaces the key and therefore does not need an lnSlotKey parameter. See the updateNode methods for more information. [#15704]


updateEntry

public void updateEntry(int idx,
                        long lsn)
Update the idx'th entry of this node.


updateEntry

public void updateEntry(int idx,
                        long lsn,
                        byte state)
Update the idx'th entry of this node.


verifyMemorySize

public boolean verifyMemorySize()

getBudgetedMemorySize

public long getBudgetedMemorySize()
Returns the amount of memory currently budgeted for this IN.


getTreeAdminMemorySize

public long getTreeAdminMemorySize()
Returns the treeAdmin memory in objects referenced by this IN. Specifically, this refers to the DbFileSummaryMap held by MapLNs


getInMemorySize

public long getInMemorySize()
For unit tests.


getEntryInMemorySize

protected long getEntryInMemorySize(byte[] key,
                                    Node target)

computeMemorySize

protected long computeMemorySize()
Count up the memory usage attributable to this node alone. LNs children are counted by their BIN/DIN parents, but INs are not counted by their parents because they are resident on the IN list. The identifierKey is "intentionally" not kept track of in the memory budget.


computeOverhead

public static long computeOverhead(DbConfigManager configManager)
                            throws DatabaseException
Throws:
DatabaseException

computeArraysOverhead

protected static long computeArraysOverhead(DbConfigManager configManager)
                                     throws DatabaseException
Throws:
DatabaseException

getMemoryOverhead

protected long getMemoryOverhead(MemoryBudget mb)

updateMemorySize

protected void updateMemorySize(ChildReference oldRef,
                                ChildReference newRef)

updateMemorySize

protected void updateMemorySize(long oldSize,
                                long newSize)

setInListResident

public void setInListResident(boolean resident)
Called when adding/removing this IN to/from the INList.


getInListResident

public boolean getInListResident()
Returns whether this IN is on the INList.


isKeyInBounds

public boolean isKeyInBounds(byte[] keyVal)
Returns whether the given key is greater than or equal to the first key in the IN and less than or equal to the last key in the IN. This method is used to determine whether a key to be inserted belongs in this IN, without doing a tree search. If false is returned it is still possible that the key belongs in this IN, but a tree search must be performed to find out.


findEntry

public int findEntry(byte[] key,
                     boolean indicateIfDuplicate,
                     boolean exact)
Find the entry in this IN for which key arg is >= the key. Currently uses a binary search, but eventually, this may use binary or linear search depending on key size, number of entries, etc. Note that the 0'th entry's key is treated specially in an IN. It always compares lower than any other key. This is public so that DbCursorTest can access it.

Parameters:
key - - the key to search for.
indicateIfDuplicate - - true if EXACT_MATCH should be or'd onto the return value if key is already present in this node.
exact - - true if an exact match must be found.
Returns:
offset for the entry that has a key >= the arg. 0 if key is less than the 1st entry. -1 if exact is true and no exact match is found. If indicateIfDuplicate is true and an exact match was found then EXACT_MATCH is or'd onto the return value.

insertEntry

public boolean insertEntry(ChildReference entry)
                    throws DatabaseException
Inserts the argument ChildReference into this IN. Assumes this node is already latched by the caller.

Parameters:
entry - The ChildReference to insert into the IN.
Returns:
true if the entry was successfully inserted, false if it was a duplicate.
Throws:
InconsistentNodeException - if the node is full (it should have been split earlier).
DatabaseException

insertEntry1

public int insertEntry1(ChildReference entry)
                 throws DatabaseException
Same as insertEntry except that it returns the index where the dup was found instead of false. The return value is |'d with either INSERT_SUCCESS or EXACT_MATCH depending on whether the entry was inserted or it was a duplicate, resp. This returns a failure if there's a duplicate match. The caller must do the processing to check if the entry is actually deleted and can be overwritten. This is foisted upon the caller rather than handled in this object because there may be some latch releasing/retaking in order to check a child LN. Inserts the argument ChildReference into this IN. Assumes this node is already latched by the caller.

Parameters:
entry - The ChildReference to insert into the IN.
Returns:
either (1) the index of location in the IN where the entry was inserted |'d with INSERT_SUCCESS, or (2) the index of the duplicate in the IN |'d with EXACT_MATCH if the entry was found to be a duplicate.
Throws:
InconsistentNodeException - if the node is full (it should have been split earlier).
DatabaseException

deleteEntry

public boolean deleteEntry(int index,
                           boolean maybeValidate)
                    throws DatabaseException
Deletes the ChildReference at index from this IN. Assumes this node is already latched by the caller.

Parameters:
index - The index of the entry to delete from the IN.
maybeValidate - true if asserts are enabled.
Returns:
true if the entry was successfully deleted, false if it was not found.
Throws:
DatabaseException

setProhibitNextDelta

public void setProhibitNextDelta()
Do nothing since INs don't support deltas.


compress

public boolean compress(BINReference binRef,
                        boolean canFetch,
                        LocalUtilizationTracker localTracker)
                 throws DatabaseException
Throws:
DatabaseException

isCompressible

public boolean isCompressible()

needsSplitting

public boolean needsSplitting()
Return true if this node needs splitting. For the moment, needing to be split is defined by there being no free entries available.


splitInternal

protected void splitInternal(IN parent,
                             int childIndex,
                             int maxEntries,
                             int splitIndex,
                             CacheMode cacheMode)
                      throws DatabaseException
Throws:
DatabaseException

getKeyComparator

public java.util.Comparator<byte[]> getKeyComparator()
Return the relevant user defined comparison function for this type of node. For IN's and BIN's, this is the BTree Comparison function.


verify

public void verify(byte[] maxKey)
            throws DatabaseException
Check that the IN is in a valid state. For now, validity means that the keys are in sorted order and that there are more than 0 entries. maxKey, if non-null specifies that all keys in this node must be less than maxKey.

Overrides:
verify in class Node
Throws:
DatabaseException

descendOnParentSearch

protected void descendOnParentSearch(SearchResult result,
                                     boolean targetContainsDuplicates,
                                     boolean targetIsRoot,
                                     long targetNodeId,
                                     Node child,
                                     boolean requireExactMatch)
                              throws DatabaseException
Throws:
DatabaseException

isSoughtNode

protected boolean isSoughtNode(long nid,
                               CacheMode cacheMode)
                        throws DatabaseException
Specified by:
isSoughtNode in class Node
Returns:
true if you're an IN in the search path
Throws:
DatabaseException

canBeAncestor

protected boolean canBeAncestor(boolean targetContainsDuplicates)
Specified by:
canBeAncestor in class Node
Returns:
true if you can be the ancestor of the target IN. Currently the determining factor is whether the target IN contains duplicates.

isEvictable

public boolean isEvictable()
Returns whether this node can be evicted. This is slower than (getEvictionType() == MAY_EVICT_NODE) because it does a more static, stringent check and is used by the evictor after a node has been selected, to check that it is still evictable. The more specific evaluation done by getEvictionType() is used when initially selecting a node for inclusion in the eviction set. Note that the IN may or may not be latched when this method is called. Returning the wrong answer is OK in that case (it will be called again later when latched), but an exception should not occur.


getEvictionType

public int getEvictionType()
Returns the eviction type for this IN, for use by the evictor. Uses the internal isEvictionProhibited and getChildEvictionType methods that may be overridden by subclasses. This differs from isEvictable() because it does more detailed evaluation about the degree of evictability. It's used generally when selecting candidates for eviction. Note that the IN may or may not be latched when this method is called. Returning the wrong answer is OK in that case (it will be called again later when latched), but an exception should not occur.

Returns:
MAY_EVICT_LNS if evictable LNs may be stripped; otherwise, MAY_EVICT_NODE if the node itself may be evicted; otherwise, MAY_NOT_EVICT.

logDirtyChildren

public void logDirtyChildren()
                      throws DatabaseException
When splits and checkpoints intermingle in a deferred write databases, a checkpoint target may appear which has a valid target but a null LSN. Deferred write dbs are written out in checkpoint style by either Database.sync() or a checkpoint which has cleaned a file containing deferred write entries. For example, INa | BINb A checkpoint or Database.sync starts The INList is traversed, dirty nodes are selected BINb is bypassed on the INList, since it's not dirty BINb is split, creating a new sibling, BINc, and dirtying INa INa is selected as a dirty node for the ckpt If this happens, INa is in the selected dirty set, but not its dirty child BINb and new child BINc. In a durable db, the existence of BINb and BINc are logged anyway. But in a deferred write db, there is an entry that points to BINc, but no logged version. This will not cause problems with eviction, because INa can't be evicted until BINb and BINc are logged, are non-dirty, and are detached. But it can cause problems at recovery, because INa will have a null LSN for a valid entry, and the LN children of BINc will not find a home. To prevent this, search for all dirty children that might have been missed during the selection phase, and write them out. It's not sufficient to write only null-LSN children, because the existing sibling must be logged lest LN children recover twice (once in the new sibling, once in the old existing sibling.

Throws:
DatabaseException

log

public long log(LogManager logManager)
         throws DatabaseException
Log this IN and clear the dirty flag.

Throws:
DatabaseException

log

public long log(LogManager logManager,
                boolean allowDeltas,
                boolean isProvisional,
                boolean proactiveMigration,
                boolean backgroundIO,
                IN parent)
         throws DatabaseException
Log this node with all available options.

Throws:
DatabaseException

log

public long log(LogManager logManager,
                boolean allowDeltas,
                Provisional provisional,
                boolean proactiveMigration,
                boolean backgroundIO,
                IN parent)
         throws DatabaseException
Throws:
DatabaseException

optionalLog

public long optionalLog(LogManager logManager)
                 throws DatabaseException
Log this IN and clear the dirty flag.

Throws:
DatabaseException

optionalLogProvisional

public long optionalLogProvisional(LogManager logManager,
                                   IN parent)
                            throws DatabaseException
Log this node provisionally and clear the dirty flag.

Parameters:
item - object to be logged
Returns:
LSN of the new log entry
Throws:
DatabaseException

beforeLog

public void beforeLog(LogManager logManager,
                      INLogItem item,
                      INLogContext context)
               throws DatabaseException
Pre-log processing. Used implicitly for single-item logging and explicitly for multi-item logging. Overridden by subclasses as needed. Decide how to log this node. INs are always logged in full. Cleaner LN migration is never performed since it only applies to BINs.

Throws:
DatabaseException

afterLog

public void afterLog(LogManager logManager,
                     INLogItem item,
                     INLogContext context)
              throws DatabaseException
Post-log processing. Used implicitly for single-item logging and explicitly for multi-item logging. Overridden by subclasses as needed. The last version of this node must be counted obsolete at the correct time. If logging non-provisionally, the last version of this node and any provisionally logged descendants are immediately obsolete and can be flushed. If logging provisionally, the last version isn't obsolete until an ancestor is logged non-provisionally, so propagate obsolete lsns upwards.

Throws:
DatabaseException

getLogType

public LogEntryType getLogType()
Specified by:
getLogType in class Node
See Also:
Node.getLogType()

getLogSize

public int getLogSize()
Specified by:
getLogSize in interface Loggable
Overrides:
getLogSize in class Node
Returns:
number of bytes used to store this object.
See Also:
Loggable.getLogSize()

writeToLog

public void writeToLog(java.nio.ByteBuffer logBuffer)
Description copied from interface: Loggable
Serialize this object into the buffer.

Specified by:
writeToLog in interface Loggable
Overrides:
writeToLog in class Node
Parameters:
logBuffer - is the destination buffer
See Also:
Loggable.writeToLog(java.nio.ByteBuffer)

readFromLog

public void readFromLog(java.nio.ByteBuffer itemBuffer,
                        byte entryVersion)
                 throws LogException
Description copied from interface: Loggable
Initialize this object from the data in itemBuf.

Specified by:
readFromLog in interface Loggable
Overrides:
readFromLog in class Node
Throws:
LogException
See Also:
Loggable.readFromLog(java.nio.ByteBuffer, byte)

dumpLog

public void dumpLog(java.lang.StringBuffer 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
Overrides:
dumpLog in class Node
Parameters:
sb - destination string buffer
verbose - if true, dump the full, verbose version
See Also:
Loggable.dumpLog(java.lang.StringBuffer, boolean)

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.
See Also:
Always return false, this item should never be compared.

dumpLogAdditional

protected void dumpLogAdditional(java.lang.StringBuffer sb)
Allows subclasses to add additional fields before the end tag. If they just overload dumpLog, the xml isn't nested.


beginTag

public java.lang.String beginTag()

endTag

public java.lang.String endTag()

dumpString

public java.lang.String dumpString(int nSpaces,
                                   boolean dumpTags)
For unit test support:

Returns:
a string that dumps information about this IN, without

toString

public java.lang.String toString()
Description copied from class: Node
Default toString method at the root of the tree.

Overrides:
toString in class Node

shortClassName

public java.lang.String shortClassName()