/**
Copyright (C) SYSTAP, LLC DBA Blazegraph 2006-2016. All rights reserved.
Contact:
SYSTAP, LLC DBA Blazegraph
2501 Calvert ST NW #106
Washington, DC 20008
licenses@blazegraph.com
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; version 2 of the License.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
/*
* Created on Nov 27, 2006
*/
package com.bigdata.btree;
import org.apache.log4j.Level;
import com.bigdata.btree.keys.TestKeyBuilder;
import com.bigdata.io.SerializerUtil;
/**
* Test split and join of the root leaf (the tree never has more than two
* levels).
*
* @see src/architecture/btree.xls for examples for split().
*
* @author <a href="mailto:thompsonbry@users.sourceforge.net">Bryan Thompson</a>
* @version $Id$
*/
public class TestSplitJoinRootLeaf extends AbstractBTreeTestCase {
/**
*
*/
public TestSplitJoinRootLeaf() {
}
/**
* @param name
*/
public TestSplitJoinRootLeaf(String name) {
super(name);
}
/**
* A series of tests of the mechanisms for splitting and joining a leaf with
* a branching factor of three (3). Each tests uses the same initial
* conditions but forces removes a different key to trigger the join to test
* the various edge conditions.
*
* Note: this does not test all edge conditions since we only have two
* leaves and therefore only a single sibling is defined, but the general
* case allows two siblings, even with a branching factor of (3).
*
* Note: this does vary the insert key that drives the split, but we verify
* in other tests that the split key is correctly computed.
*
* Note: when m := 3, a node is either at its minimum or at its maximum so
* {@link Leaf#join()} always triggers {@link Leaf#merge(Leaf)}. This is
* not true when the branching factor is higher than three (3).
*
* @see Leaf#getSplitIndex(int)
* @see Leaf#split()
* @see Leaf#join()
* @see Leaf#merge(Leaf)
* @see Leaf#redistributeKeys(Leaf)
* @see Node#getIndexOf(AbstractNode)
*
* @todo Do detailed tests for a Node with a branching factor of 3.
* @todo Do detailed tests for a Node with a branching factor of 4.
*/
public void test_splitJoinLeafBranchingFactor3_01() {
BTree btree = getBTree(3);
Leaf a = (Leaf)btree.getRoot();
byte[] v2 = SerializerUtil.serialize(new SimpleEntry(2));
byte[] v3 = SerializerUtil.serialize(new SimpleEntry(3));
byte[] v5 = SerializerUtil.serialize(new SimpleEntry(5));
byte[] v7 = SerializerUtil.serialize(new SimpleEntry(7));
// SimpleEntry v2 = new SimpleEntry(2);
// SimpleEntry v3 = new SimpleEntry(3);
// SimpleEntry v5 = new SimpleEntry(5);
// SimpleEntry v7 = new SimpleEntry(7);
btree.insert(TestKeyBuilder.asSortKey(3), v3);
btree.insert(TestKeyBuilder.asSortKey(5), v5);
btree.insert(TestKeyBuilder.asSortKey(7), v7);
assertKeys(new int[]{3,5,7},a);
assertValues(new Object[]{v3,v5,v7},a);
// split the root leaf.
btree.insert(TestKeyBuilder.asSortKey(2), v2);
assertTrue("after split",btree.dump(Level.DEBUG,System.err));
Node root = (Node)btree.getRoot();
assertKeys(new int[]{5},root);
assertEquals(a,root.getChild(0));
Leaf b = (Leaf) root.getChild(1);
assertEntryCounts(new int[]{2,2},root);
assertKeys(new int[]{2,3},a);
assertValues(new Object[]{v2,v3},a);
assertKeys(new int[]{5,7},b);
assertValues(new Object[]{v5,v7},b);
assertEquals("height", 1, btree.height);
assertEquals("#nodes", 1, btree.nnodes);
assertEquals("#leaves", 2, btree.nleaves);
assertEquals("#entries", 4, btree.nentries);
/*
* make (a) deficient by removing the key/value for (1). This will cause
* a.join() to be invoked and trigger a.merge(b). The post-condition is
* a with the remaining keys and values. Both the root node and the
* merged sibling should be marked as deleted.
*/
btree.remove(TestKeyBuilder.asSortKey(2));
assertTrue("after join",btree.dump(Level.DEBUG,System.err));
assertKeys(new int[]{3,5,7},a);
assertValues(new Object[]{v3,v5,v7},a);
assertTrue(!a.isDeleted());
assertTrue(b.isDeleted());
assertTrue(root.isDeleted());
assertEquals("height", 0, btree.height);
assertEquals("#nodes", 0, btree.nnodes);
assertEquals("#leaves", 1, btree.nleaves);
assertEquals("#entries", 3, btree.nentries);
}
public void test_splitJoinLeafBranchingFactor3_02() {
BTree btree = getBTree(3);
Leaf a = (Leaf)btree.getRoot();
byte[] v2 = SerializerUtil.serialize(new SimpleEntry(2));
byte[] v3 = SerializerUtil.serialize(new SimpleEntry(3));
byte[] v5 = SerializerUtil.serialize(new SimpleEntry(5));
byte[] v7 = SerializerUtil.serialize(new SimpleEntry(7));
// SimpleEntry v2 = new SimpleEntry(2);
// SimpleEntry v3 = new SimpleEntry(3);
// SimpleEntry v5 = new SimpleEntry(5);
// SimpleEntry v7 = new SimpleEntry(7);
btree.insert(TestKeyBuilder.asSortKey(3), v3);
btree.insert(TestKeyBuilder.asSortKey(5), v5);
btree.insert(TestKeyBuilder.asSortKey(7), v7);
assertKeys(new int[]{3,5,7},a);
assertValues(new Object[]{v3,v5,v7},a);
// split the root leaf.
btree.insert(TestKeyBuilder.asSortKey(2), v2);
assertTrue("after split",btree.dump(Level.DEBUG,System.err));
Node root = (Node)btree.getRoot();
assertKeys(new int[]{5},root);
assertEquals(a,root.getChild(0));
Leaf b = (Leaf) root.getChild(1);
assertEntryCounts(new int[]{2,2},root);
assertKeys(new int[]{2,3},a);
assertValues(new Object[]{v2,v3},a);
assertKeys(new int[]{5,7},b);
assertValues(new Object[]{v5,v7},b);
assertEquals("height", 1, btree.height);
assertEquals("#nodes", 1, btree.nnodes);
assertEquals("#leaves", 2, btree.nleaves);
assertEquals("#entries", 4, btree.nentries);
/*
* make (a) deficient by removing the key/value for (3). This will cause
* a.join() to be invoked and trigger a.merge(b). The post-condition is
* a with the remaining keys and values. Both the root node and the
* merged sibling should be marked as deleted.
*/
btree.remove(TestKeyBuilder.asSortKey(3));
assertTrue("after join",btree.dump(Level.DEBUG,System.err));
assertKeys(new int[]{2,5,7},a);
assertValues(new Object[]{v2,v5,v7},a);
assertTrue(!a.isDeleted());
assertTrue(b.isDeleted());
assertTrue(root.isDeleted());
assertEquals("height", 0, btree.height);
assertEquals("#nodes", 0, btree.nnodes);
assertEquals("#leaves", 1, btree.nleaves);
assertEquals("#entries", 3, btree.nentries);
}
public void test_splitJoinLeafBranchingFactor3_03() {
BTree btree = getBTree(3);
Leaf a = (Leaf)btree.getRoot();
byte[] v2 = SerializerUtil.serialize(new SimpleEntry(2));
byte[] v3 = SerializerUtil.serialize(new SimpleEntry(3));
byte[] v5 = SerializerUtil.serialize(new SimpleEntry(5));
byte[] v7 = SerializerUtil.serialize(new SimpleEntry(7));
// SimpleEntry v2 = new SimpleEntry(2);
// SimpleEntry v3 = new SimpleEntry(3);
// SimpleEntry v5 = new SimpleEntry(5);
// SimpleEntry v7 = new SimpleEntry(7);
btree.insert(TestKeyBuilder.asSortKey(3), v3);
btree.insert(TestKeyBuilder.asSortKey(5), v5);
btree.insert(TestKeyBuilder.asSortKey(7), v7);
assertKeys(new int[]{3,5,7},a);
assertValues(new Object[]{v3,v5,v7},a);
// split the root leaf.
btree.insert(TestKeyBuilder.asSortKey(2), v2);
assertTrue("after split",btree.dump(Level.DEBUG,System.err));
Node root = (Node)btree.getRoot();
assertKeys(new int[]{5},root);
assertEquals(a,root.getChild(0));
Leaf b = (Leaf) root.getChild(1);
assertEntryCounts(new int[]{2,2},root);
assertKeys(new int[]{2,3},a);
assertValues(new Object[]{v2,v3},a);
assertKeys(new int[]{5,7},b);
assertValues(new Object[]{v5,v7},b);
assertEquals("height", 1, btree.height);
assertEquals("#nodes", 1, btree.nnodes);
assertEquals("#leaves", 2, btree.nleaves);
assertEquals("#entries", 4, btree.nentries);
/*
* make (b) deficient by removing the key/value for (5). This will cause
* b.join() to be invoked and trigger b.merge(a). The post-condition is
* b with the remaining keys and values. Both the root node and the
* merged sibling should be marked as deleted.
*/
btree.remove(TestKeyBuilder.asSortKey(5));
assertTrue("after join",btree.dump(Level.DEBUG,System.err));
assertKeys(new int[]{2,3,7},b);
assertValues(new Object[]{v2,v3,v7},b);
assertTrue(a.isDeleted());
assertTrue(!b.isDeleted());
assertTrue(root.isDeleted());
assertEquals("height", 0, btree.height);
assertEquals("#nodes", 0, btree.nnodes);
assertEquals("#leaves", 1, btree.nleaves);
assertEquals("#entries", 3, btree.nentries);
}
public void test_splitJoinLeafBranchingFactor3_04() {
BTree btree = getBTree(3);
Leaf a = (Leaf)btree.getRoot();
byte[] v2 = SerializerUtil.serialize(new SimpleEntry(2));
byte[] v3 = SerializerUtil.serialize(new SimpleEntry(3));
byte[] v5 = SerializerUtil.serialize(new SimpleEntry(5));
byte[] v7 = SerializerUtil.serialize(new SimpleEntry(7));
// SimpleEntry v2 = new SimpleEntry(2);
// SimpleEntry v3 = new SimpleEntry(3);
// SimpleEntry v5 = new SimpleEntry(5);
// SimpleEntry v7 = new SimpleEntry(7);
btree.insert(TestKeyBuilder.asSortKey(3), v3);
btree.insert(TestKeyBuilder.asSortKey(5), v5);
btree.insert(TestKeyBuilder.asSortKey(7), v7);
assertKeys(new int[]{3,5,7},a);
assertValues(new Object[]{v3,v5,v7},a);
// split the root leaf.
btree.insert(TestKeyBuilder.asSortKey(2), v2);
assertTrue("after split",btree.dump(Level.DEBUG,System.err));
Node root = (Node)btree.getRoot();
assertKeys(new int[]{5},root);
assertEquals(a,root.getChild(0));
Leaf b = (Leaf) root.getChild(1);
assertEntryCounts(new int[]{2,2},root);
assertKeys(new int[]{2,3},a);
assertValues(new Object[]{v2,v3},a);
assertKeys(new int[]{5,7},b);
assertValues(new Object[]{v5,v7},b);
assertEquals("height", 1, btree.height);
assertEquals("#nodes", 1, btree.nnodes);
assertEquals("#leaves", 2, btree.nleaves);
assertEquals("#entries", 4, btree.nentries);
/*
* make (b) deficient by removing the key/value for (7). This will cause
* b.join() to be invoked and trigger b.merge(a). The post-condition is
* b with the remaining keys and values. Both the root node and the
* merged sibling should be marked as deleted.
*/
btree.remove(TestKeyBuilder.asSortKey(7));
assertTrue("after join",btree.dump(Level.DEBUG,System.err));
assertKeys(new int[]{2,3,5},b);
assertValues(new Object[]{v2,v3,v5},b);
assertTrue(a.isDeleted());
assertTrue(!b.isDeleted());
assertTrue(root.isDeleted());
assertEquals("height", 0, btree.height);
assertEquals("#nodes", 0, btree.nnodes);
assertEquals("#leaves", 1, btree.nleaves);
assertEquals("#entries", 3, btree.nentries);
}
/**
* Note: with a branching factor greater than (3) it is possible for
* {@link Leaf#join()} to trigger {@link Leaf#redistributeKeys(Leaf)} rather
* than {@link Leaf#merge(Leaf)}. Since we tested {@link Leaf#merge(Leaf)}
* for m := 3, we focus on testing {@link Leaf#redistributeKeys(Leaf)} with
* m := 4.
*
* This test triggers the redistribution of a key from (b) to (a).
*/
public void test_splitJoinLeafBranchingFactor4_01() {
BTree btree = getBTree(4);
Leaf a = (Leaf)btree.getRoot();
byte[] v2 = SerializerUtil.serialize(new SimpleEntry(2));
byte[] v3 = SerializerUtil.serialize(new SimpleEntry(3));
byte[] v5 = SerializerUtil.serialize(new SimpleEntry(5));
byte[] v7 = SerializerUtil.serialize(new SimpleEntry(7));
byte[] v9 = SerializerUtil.serialize(new SimpleEntry(9));
// SimpleEntry v2 = new SimpleEntry(2);
// SimpleEntry v3 = new SimpleEntry(3);
// SimpleEntry v5 = new SimpleEntry(5);
// SimpleEntry v7 = new SimpleEntry(7);
// SimpleEntry v9 = new SimpleEntry(9);
btree.insert(TestKeyBuilder.asSortKey(3), v3);
btree.insert(TestKeyBuilder.asSortKey(5), v5);
btree.insert(TestKeyBuilder.asSortKey(7), v7);
btree.insert(TestKeyBuilder.asSortKey(9), v9);
assertKeys(new int[]{3,5,7,9},a);
assertValues(new Object[]{v3,v5,v7,v9},a);
// split the root leaf.
btree.insert(TestKeyBuilder.asSortKey(2), v2);
assertTrue("after split",btree.dump(Level.DEBUG,System.err));
Node root = (Node)btree.getRoot();
assertKeys(new int[]{5},root);
assertEquals(a,root.getChild(0));
Leaf b = (Leaf) root.getChild(1);
assertEntryCounts(new int[]{2,3},root);
assertKeys(new int[]{2,3},a);
assertValues(new Object[]{v2,v3},a);
assertKeys(new int[]{5,7,9},b);
assertValues(new Object[]{v5,v7,v9},b);
assertEquals("height", 1, btree.height);
assertEquals("#nodes", 1, btree.nnodes);
assertEquals("#leaves", 2, btree.nleaves);
assertEquals("#entries", 5, btree.nentries);
/*
* make (a) deficient by removing the key/value for (3). This will cause
* a.join() to be invoked and trigger a.redistributeKeys(b). The latter
* will move one key from (b) -> (a) and update the separator key on the
* parent.
*/
assertEquals(v3,btree.remove(TestKeyBuilder.asSortKey(3)));
assertTrue("after redistribute b->a", btree.dump(Level.DEBUG,System.err));
assertKeys(new int[]{7},root);
assertEquals(a,root.getChild(0));
assertEquals(b,root.getChild(1));
assertEntryCounts(new int[]{2,2},root);
assertKeys(new int[]{2,5},a);
assertValues(new Object[]{v2,v5},a);
assertKeys(new int[]{7,9},b);
assertValues(new Object[]{v7,v9},b);
assertTrue(!a.isDeleted());
assertTrue(!b.isDeleted());
assertTrue(!root.isDeleted());
assertEquals("height", 1, btree.height);
assertEquals("#nodes", 1, btree.nnodes);
assertEquals("#leaves", 2, btree.nleaves);
assertEquals("#entries", 4, btree.nentries);
/*
* Continue by removing another key and forcing merge. This removes (7)
* from (b), making (b) deficient and forcing b.merge(a). The
* postcondition is that (b) has all the remaining keys and has become
* the root leaf and that (a) and the root node are deleted.
*/
assertEquals(v7,btree.remove(TestKeyBuilder.asSortKey(7)));
assertTrue("after join", btree.dump(Level.DEBUG,System.err));
assertKeys(new int[]{2,5,9},b);
assertValues(new Object[]{v2,v5,v9},b);
assertTrue(a.isDeleted());
assertTrue(!b.isDeleted());
assertTrue(root.isDeleted());
assertEquals("height", 0, btree.height);
assertEquals("#nodes", 0, btree.nnodes);
assertEquals("#leaves", 1, btree.nleaves);
assertEquals("#entries", 3, btree.nentries);
}
/**
* This test triggers the redistribution of a key from (a) to (b).
*/
public void test_splitJoinLeafBranchingFactor4_02() {
BTree btree = getBTree(4);
Leaf a = (Leaf)btree.getRoot();
byte[] v2 = SerializerUtil.serialize(new SimpleEntry(2));
byte[] v3 = SerializerUtil.serialize(new SimpleEntry(3));
byte[] v4 = SerializerUtil.serialize(new SimpleEntry(4));
byte[] v5 = SerializerUtil.serialize(new SimpleEntry(5));
byte[] v7 = SerializerUtil.serialize(new SimpleEntry(7));
byte[] v9 = SerializerUtil.serialize(new SimpleEntry(9));
// SimpleEntry v2 = new SimpleEntry(2);
// SimpleEntry v3 = new SimpleEntry(3);
// SimpleEntry v4 = new SimpleEntry(4);
// SimpleEntry v5 = new SimpleEntry(5);
// SimpleEntry v7 = new SimpleEntry(7);
// SimpleEntry v9 = new SimpleEntry(9);
btree.insert(TestKeyBuilder.asSortKey(3), v3);
btree.insert(TestKeyBuilder.asSortKey(5), v5);
btree.insert(TestKeyBuilder.asSortKey(7), v7);
btree.insert(TestKeyBuilder.asSortKey(9), v9);
assertKeys(new int[]{3,5,7,9},a);
assertValues(new byte[][]{v3,v5,v7,v9},a);
// split the root leaf.
btree.insert(TestKeyBuilder.asSortKey(2), v2);
assertTrue("after split", btree.dump(Level.DEBUG,System.err));
Node root = (Node)btree.getRoot();
assertKeys(new int[]{5},root);
assertEquals(a,root.getChild(0));
Leaf b = (Leaf) root.getChild(1);
assertEntryCounts(new int[]{2,3},root);
assertKeys(new int[]{2,3},a);
assertValues(new Object[]{v2,v3},a);
assertKeys(new int[]{5,7,9},b);
assertValues(new Object[]{v5,v7,v9},b);
assertEquals("height", 1, btree.height);
assertEquals("#nodes", 1, btree.nnodes);
assertEquals("#leaves", 2, btree.nleaves);
assertEquals("#entries", 5, btree.nentries);
/*
* insert another key that will go into (a) bringing it above its
* minimum capacity.
*/
btree.insert(TestKeyBuilder.asSortKey(4),v4);
assertKeys(new int[]{5},root);
assertEquals(a,root.getChild(0));
assertEquals(b,root.getChild(1));
assertEntryCounts(new int[]{3,3},root);
assertKeys(new int[]{2,3,4},a);
assertValues(new Object[]{v2,v3,v4},a);
assertKeys(new int[]{5,7,9},b);
assertValues(new Object[]{v5,v7,v9},b);
assertEquals("height", 1, btree.height);
assertEquals("#nodes", 1, btree.nnodes);
assertEquals("#leaves", 2, btree.nleaves);
assertEquals("#entries", 6, btree.nentries);
/*
* make (b) deficient by removing the key/value for (5) and then (9).
* This will cause b.join() to be invoked and trigger
* b.redistributeKeys(a). The latter will move one key from (a) -> (b)
* and update the separator key on the parent.
*/
assertEquals(v5,btree.remove(TestKeyBuilder.asSortKey(5)));
assertKeys(new int[]{7,9},b);
assertValues(new Object[]{v7,v9},b);
assertEntryCounts(new int[]{3,2},root);
assertEquals(v9,btree.remove(TestKeyBuilder.asSortKey(9)));
assertTrue("after redistribute a->b",btree.dump(Level.DEBUG,System.err));
assertKeys(new int[]{4},root);
assertEquals(a,root.getChild(0));
assertEquals(b,root.getChild(1));
assertEntryCounts(new int[]{2,2},root);
assertKeys(new int[]{2,3},a);
assertValues(new Object[]{v2,v3},a);
assertKeys(new int[]{4,7},b);
assertValues(new Object[]{v4,v7},b);
assertTrue(!a.isDeleted());
assertTrue(!b.isDeleted());
assertTrue(!root.isDeleted());
assertEquals("height", 1, btree.height);
assertEquals("#nodes", 1, btree.nnodes);
assertEquals("#leaves", 2, btree.nleaves);
assertEquals("#entries", 4, btree.nentries);
/*
* Continue by removing another key and forcing merge. This removes (3)
* from (a), making (a) deficient and forcing a.merge(b). The
* postcondition is that (a) has all the remaining keys and has become
* the root leaf and (b) and the root node are deleted.
*/
assertEquals(v3,btree.remove(TestKeyBuilder.asSortKey(3)));
assertTrue("after join",btree.dump(Level.DEBUG,System.err));
assertKeys(new int[]{2,4,7},a);
assertValues(new Object[]{v2,v4,v7},a);
assertTrue(!a.isDeleted());
assertTrue(b.isDeleted());
assertTrue(root.isDeleted());
assertEquals("height", 0, btree.height);
assertEquals("#nodes", 0, btree.nnodes);
assertEquals("#leaves", 1, btree.nleaves);
assertEquals("#entries", 3, btree.nentries);
}
}