yacy_search_server/source/de/anomic/kelondro/kelondroStack.java
orbiter dc0c06e43d PLEASE MAKE A BACK-UP OF YOUR COMPLETE DATA DIRECTORY BEFORE USING THIS
redesign for better IO performance
enhanced database seek-time by avoiding write operations at distant
positions of a database file. until now, a USEDC counter was written
at the head-section of a kelondroRecords database file (which is the
basic data structure of all kelondro database files) to store the
actual number of records that are contained in the database. Now, this
value is computed from the database file size. This is either done
only once at start-time, or continuously when run in asserts enabled.
The counter is then updated only in RAM, and written at close of the
file. If the close fails, the correct number can be computed from the
file size, and if this is not equal to the stored number it is a strong
evidence that YaCY was not shut down properly.
To preserve consistency, the complete storage-routine had to be re-written.
Another change enhances read of nodes in some cases, where the data-tail
can be read together with the data-head. This saves another IO lookup during
each DB node fetch.
Includes also many small bugfixes.
IF ANYTHING GOES WRONG, ALL YOUR DATA IS LOST: PLEASE MAKE A BACK-UP

git-svn-id: https://svn.berlios.de/svnroot/repos/yacy/trunk@3375 6c8d7289-2bf4-0310-a012-ef5d649a1542
2007-02-20 08:35:51 +00:00

457 lines
17 KiB
Java

// kelondroStack.java
// -----------------------
// part of The Kelondro Database
// (C) by Michael Peter Christen; mc@anomic.de
// first published on http://www.anomic.de
// Frankfurt, Germany, 2004
// last change: 11.01.2004
//
// 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; either version 2 of the License, or
// (at your option) any later version.
//
// 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
//
// Using this software in any meaning (reading, learning, copying, compiling,
// running) means that you agree that the Author(s) is (are) not responsible
// for cost, loss of data or any harm that may be caused directly or indirectly
// by usage of this softare or this documentation. The usage of this software
// is on your own risk. The installation and usage (starting/running) of this
// software may allow other people or application to access your computer and
// any attached devices and is highly dependent on the configuration of the
// software which must be done by the user of the software; the author(s) is
// (are) also not responsible for proper configuration and usage of the
// software, even if provoked by documentation provided together with
// the software.
//
// Any changes to this file according to the GPL as documented in the file
// gpl.txt aside this file in the shipment you received can be done to the
// lines that follows this copyright notice here, but changes must not be
// done inside the copyright notive above. A re-distribution must contain
// the intact and unchanged copyright notice.
// Contributions and changes to the program code must be marked as such.
/*
This class extends the kelondroRecords and adds a stack structure
*/
package de.anomic.kelondro;
import java.io.BufferedReader;
import java.io.File;
import java.io.FileReader;
import java.io.IOException;
import java.io.RandomAccessFile;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.StringTokenizer;
public final class kelondroStack extends kelondroRecords {
// define the Over-Head-Array
private static short thisOHBytes = 0; // our record definition does not need extra bytes
private static short thisOHHandles = 2; // and two handles overhead for a double-chained list
private static short thisFHandles = 2; // two file handles for root handle and handle to last lement
// define pointers for OH array access
protected static final int left = 0; // pointer for OHHandle-array: handle()-Value of left child Node
protected static final int right = 1; // pointer for OHHandle-array: handle()-Value of right child Node
protected static final int root = 0; // pointer for FHandles-array: pointer to root node
protected static final int toor = 1; // pointer for FHandles-array: pointer to root node
public kelondroStack(File file, kelondroRow rowdef) throws IOException {
// this creates a new stack
super(file, 0, 0, thisOHBytes, thisOHHandles, rowdef, thisFHandles, rowdef.columns() /* txtProps */, 80 /* txtPropWidth */);
if (super.fileExisted) {
//if ((getHandle(root) == null) && (getHandle(toor) == null)) clear();
} else {
setHandle(root, null); // define the root value
setHandle(toor, null); // define the toor value
}
}
public static final kelondroStack open(File file, kelondroRow rowdef) {
try {
return new kelondroStack(file, rowdef);
} catch (IOException e) {
file.delete();
try {
return new kelondroStack(file, rowdef);
} catch (IOException ee) {
System.out.println("kelondroStack: cannot open or create file " + file.toString());
e.printStackTrace();
ee.printStackTrace();
return null;
}
}
}
public static kelondroStack reset(kelondroStack stack) {
// memorize settings to this file
File f = new File(stack.filename);
kelondroRow row = stack.row();
// close and delete the file
try {stack.close();} catch (Exception e) {}
if (f.exists()) f.delete();
// re-open a database with same settings as before
return open(f, row);
}
public class Counter implements Iterator {
Handle nextHandle = null;
public Counter() {
nextHandle = getHandle(root);
}
public boolean hasNext() {
return (nextHandle != null);
}
public Object next() {
Handle ret = nextHandle;
try {
nextHandle = getNode(nextHandle, null, 0, false).getOHHandle(right);
return getNode(ret, null, 0, true);
} catch (IOException e) {
throw new kelondroException(filename, "IO error at Counter:next()");
}
}
public void remove() {
throw new UnsupportedOperationException("no remove here..");
}
}
public synchronized int size() {
return super.size();
}
public synchronized void push(kelondroRow.Entry row) throws IOException {
// check if there is already a stack
if (getHandle(toor) == null) {
if (getHandle(root) != null) throw new RuntimeException("push: internal organisation of root and toor");
// create node
Node n = newNode(row.bytes());
n.setOHHandle(left, null);
n.setOHHandle(right, null);
n.commit(CP_NONE);
// assign handles
setHandle(root, n.handle());
setHandle(toor, n.handle());
// thats it
} else {
// expand the list at the end
Node n = newNode(row.bytes());
n.setOHHandle(left, getHandle(toor));
n.setOHHandle(right, null);
Node n1 = getNode(getHandle(toor), null, 0, false);
n1.setOHHandle(right, n.handle());
n.commit(CP_NONE);
n1.commit(CP_NONE);
// assign handles
setHandle(toor, n.handle());
// thats it
}
}
public synchronized kelondroRow.Entry pop() throws IOException {
// return row ontop of the stack and shrink stack by one
return pop(0);
}
public synchronized kelondroRow.Entry pop(int dist) throws IOException {
// return row relative to top of the stack and remove addressed element
Node n = topNode(dist);
if (n == null) return null;
kelondroRow.Entry ret = row().newEntry(n.getValueRow());
// remove node
unlinkNode(n);
deleteNode(n.handle());
return ret;
}
public synchronized kelondroRow.Entry top() throws IOException {
// return row ontop of the stack
return top(0);
}
public synchronized kelondroRow.Entry top(int dist) throws IOException {
// return row ontop of the stack
// with dist == 0 this is the same function as with top()
Node n = topNode(dist);
if (n == null) return null;
return row().newEntry(n.getValueRow());
}
public synchronized kelondroRow.Entry pot() throws IOException {
// return row on the bottom of the stack and remove record
return pot(0);
}
public synchronized kelondroRow.Entry pot(int dist) throws IOException {
// return row relative to the bottom of the stack and remove addressed element
Node n = botNode(dist);
if (n == null) return null;
kelondroRow.Entry ret = row().newEntry(n.getValueRow());
// remove node
unlinkNode(n);
deleteNode(n.handle());
return ret;
}
public synchronized kelondroRow.Entry bot() throws IOException {
// return row on the bottom of the stack
return bot(0);
}
public synchronized kelondroRow.Entry bot(int dist) throws IOException {
// return row on bottom of the stack
// with dist == 0 this is the same function as with bot()
Node n = botNode(dist);
if (n == null) return null;
return row().newEntry(n.getValueRow());
}
public synchronized ArrayList botList(int dist) throws IOException {
ArrayList botList = new ArrayList(size());
for (int i=dist; i < size(); i++) {
botList.add(bot(i));
}
return botList;
}
private void unlinkNode(Node n) throws IOException {
// join chaines over node
Handle l = n.getOHHandle(left);
Handle r = n.getOHHandle(right);
// look left
if (l == null) {
// reached the root on left side
setHandle(root, r);
} else {
// un-link the previous record
Node k = getNode(l, null, 0, false);
k.setOHHandle(left, k.getOHHandle(left));
k.setOHHandle(right, r);
k.commit(CP_NONE);
}
// look right
if (r == null) {
// reached the root on right side
setHandle(toor, l);
} else {
// un-link the following record
Node k = getNode(r, null, 0, false);
k.setOHHandle(left, l);
k.setOHHandle(right, k.getOHHandle(right));
k.commit(CP_NONE);
}
}
private Node topNode(int dist) throws IOException {
// return node ontop of the stack
return queueNode(dist, toor, left);
}
private Node botNode(int dist) throws IOException {
// return node on bottom of the stack
return queueNode(dist, root, right);
}
private Node queueNode(int dist, int side, int dir) throws IOException {
// with dist == 0 this is the same function as with
// getNode(getHandle(side), null, 0)
Handle h = getHandle(side);
if (h == null) return null;
if (dist >= size()) return null; // that would exceed the stack
while (dist-- > 0) h = getNode(h, false).getOHHandle(dir); // track through elements
if (h == null) return null; else return getNode(h, true);
}
public Iterator iterator() {
// iterates the elements in an ordered way. returns Node - type Objects
return new Counter();
}
public int imp(File file, String separator) throws IOException {
// imports a value-separated file, returns number of records that have been read
RandomAccessFile f = null;
try {
f = new RandomAccessFile(file,"r");
String s;
StringTokenizer st;
int recs = 0;
kelondroRow.Entry buffer = row().newEntry();
int c;
int line = 0;
while ((s = f.readLine()) != null) {
s = s.trim();
line++;
if ((s.length() > 0) && (!(s.startsWith("#")))) {
st = new StringTokenizer(s, separator);
// buffer the entry
c = 0;
while ((c < row().columns()) && (st.hasMoreTokens())) {
buffer.setCol(c++, st.nextToken().trim().getBytes());
}
if ((st.hasMoreTokens()) || (c != row().columns())) {
System.err.println("inapropriate number of entries in line " + line);
} else {
push(buffer);
recs++;
}
}
}
return recs;
} finally {
if (f!=null) try{f.close();}catch(Exception e){}
}
}
public String hp(Handle h) {
if (h == null)
return "NULL";
else
return h.toString();
}
public void print() throws IOException {
super.print(false);
Node n;
try {
Iterator it = iterator();
kelondroRow.Entry r;
while (it.hasNext()) {
n = (Node) it.next();
r = row().newEntry(n.getValueRow());
// n = getNode(h, null, 0);
System.out.println("> NODE " + hp(n.handle()) + "; left "
+ hp(n.getOHHandle(left)) + ", right "
+ hp(n.getOHHandle(right)));
System.out.print(" KEY:'" + r.getColString(0, null) + "'");
for (int j = 1; j < row().columns(); j++)
System.out.print(", V[" + j + "]:'" + r.getColString(j, null) + "'");
System.out.println();
}
System.out.println();
} catch (IOException e) {
System.out.println("File error: " + e.getMessage());
}
}
private static void cmd(String[] args) {
System.out.print("kelondroStack ");
for (int i = 0; i < args.length; i++) System.out.print(args[i] + " ");
System.out.println("");
byte[] ret = null;
kelondroRow lens = new kelondroRow("byte[] key-" + Integer.parseInt(args[1]) + ", byte[] value-" + Integer.parseInt(args[2]), kelondroNaturalOrder.naturalOrder, 0);
try {
if ((args.length > 4) || (args.length < 2)) {
System.err.println("usage: kelondroStack -c|-p|-v|-g|-i|-s [file]|[key [value]] <db-file>");
System.err.println("( create, push, view, (g)pop, imp, shell)");
System.exit(0);
} else if (args.length == 2) {
kelondroStack fm = new kelondroStack(new File(args[1]), lens);
if (args[0].equals("-v")) {
fm.print();
ret = null;
} else if (args[0].equals("-g")) {
fm = new kelondroStack(new File(args[1]), lens);
kelondroRow.Entry ret2 = fm.pop();
ret = ((ret2 == null) ? null : ret2.getColBytes(1));
fm.close();
}
fm.close();
} else if (args.length == 3) {
if (args[0].equals("-i")) {
kelondroStack fm = new kelondroStack(new File(args[2]), lens);
int i = fm.imp(new File(args[1]),";");
fm.close();
ret = (i + " records imported").getBytes();
} else if (args[0].equals("-s")) {
String db = args[2];
BufferedReader f = null;
try {
f = new BufferedReader(new FileReader(args[1]));
String m;
while (true) {
m = f.readLine();
if (m == null) break;
if ((m.length() > 1) && (!m.startsWith("#"))) {
m = m + " " + db;
cmd(line2args(m));
}
}
ret = null;
} finally {
if (f != null) try {f.close();}catch(Exception e) {}
}
} else if (args[0].equals("-g")) {
kelondroStack fm = new kelondroStack(new File(args[2]), lens);
kelondroRow.Entry ret2 = fm.pop(Integer.parseInt(args[1]));
ret = ((ret2 == null) ? null : ret2.getColBytes(1));
fm.close();
}
} else if (args.length == 4) {
if (args[0].equals("-c")) {
// create <keylen> <valuelen> <filename>
File f = new File(args[3]);
if (f.exists()) f.delete();
kelondroStack fm = new kelondroStack(f, lens);
fm.close();
} else if (args[0].equals("-p")) {
kelondroStack fm = new kelondroStack(new File(args[3]), lens);
fm.push(fm.row().newEntry(new byte[][] {args[1].getBytes(), args[2].getBytes()}));
fm.close();
}
}
if (ret == null)
System.out.println("NULL");
else
System.out.println(new String(ret));
} catch (Exception e) {
e.printStackTrace();
}
}
public static void main(String[] args) {
// -c 10 20 test.stack
// -p a a1 test.stack
// -p b b1 test.stack
// -p c c1 test.stack
// -v test.stack
// -g test.stack
// -v test.stack
// -g 1 test.stack
cmd(args);
/*
kelondroStack s = new kelondroStack(new File("/Users/admin/dev/yacy/trunk/test.stack"), 1024, new int[]{10,10}, false);
try {
s.push(s.row().newEntry(new byte[][]{"test123".getBytes(), "abcdefg".getBytes()}));
s.close();
} catch (IOException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
*/
}
}