root / tags / 1.0.8 / xapian-core / backends / flint / flint_check.cc

/* flint_check.cc: Btree checking
 *
 * Copyright 1999,2000,2001 BrightStation PLC
 * Copyright 2002 Ananova Ltd
 * Copyright 2002,2004,2005,2008 Olly Betts
 *
 * 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., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301
 * USA
 */

#include <config.h>

#include <limits.h>

#include <iostream>

using namespace std;

#include "flint_check.h"

#define REVISION(b)      static_cast<unsigned int>(getint4(b, 0))
#define GET_LEVEL(b)     getint1(b, 4)
#define MAX_FREE(b)      getint2(b, 5)
#define TOTAL_FREE(b)    getint2(b, 7)
#define DIR_END(b)       getint2(b, 9)
#define DIR_START        11

void BtreeCheck::print_spaces(int n) const
{
    while (n--) out.put(' ');
}

void BtreeCheck::print_bytes(int n, const byte * p) const
{
    out.write(reinterpret_cast<const char *>(p), n);
}

void BtreeCheck::print_key(const byte * p, int c, int j) const
{
    Item_ item(p, c);
    string key;
    if (item.key().length() >= 0)
        item.key().read(&key);
    if (j == 0) {
        out << key << '/' << item.component_of();
    } else {
        for (string::const_iterator i = key.begin(); i != key.end(); ++i) {
            // out << (*i < 32 ? '.' : *i);
            char ch = *i;
            if (ch < 32) out << '/' << unsigned(ch); else out << ch;
        }
    }
}

void BtreeCheck::print_tag(const byte * p, int c, int j) const
{
    Item_ item(p, c);
    string tag;
    item.append_chunk(&tag);
    if (j == 0) {
        out << "/" << item.components_of() << tag;
    } else {
        out << "--> [" << getint4(reinterpret_cast<const byte*>(tag.data()), 0)
            << ']';
    }
}

void BtreeCheck::report_block_full(int m, int n, const byte * p) const
{
    int j = GET_LEVEL(p);
    int dir_end = DIR_END(p);
    out << '\n';
    print_spaces(m);
    out << "Block [" << n << "] level " << j << ", revision *" << REVISION(p)
         << " items (" << (dir_end - DIR_START)/D2 << ") usage "
         << block_usage(p) << "%:\n";
    for (int c = DIR_START; c < dir_end; c += D2) {
        print_spaces(m);
        print_key(p, c, j);
        out << ' ';
        print_tag(p, c, j);
        out << '\n';
    }
}

int BtreeCheck::block_usage(const byte * p) const
{
    int space = block_size - DIR_END(p);
    int free = TOTAL_FREE(p);
    return (space - free) * 100 / space;  /* a percentage */
}

/** BtreeCheck::report_block(m, n, p) prints the block at p, block number n,
 *  indented by m spaces.
 */
void BtreeCheck::report_block(int m, int n, const byte * p) const
{
    int j = GET_LEVEL(p);
    int dir_end = DIR_END(p);
    int c;
    print_spaces(m);
    out << "[" << n << "] *" << REVISION(p) << " ("
        << (dir_end - DIR_START)/D2 << ") " << block_usage(p) << "% ";

    for (c = DIR_START; c < dir_end; c += D2) {
        if (c == DIR_START + 6) out << "... ";
        if (c >= DIR_START + 6 && c < dir_end - 6) continue;

        print_key(p, c, j);
        out << ' ';
    }
    out << endl;
}

void BtreeCheck::failure(int n) const
{
    out << "B-tree error " << n << endl;
    throw "btree error";
}

void
BtreeCheck::block_check(Cursor_ * C_, int j, int opts)
{
    byte * p = C_[j].p;
    uint4 n = C_[j].n;
    size_t c;
    size_t significant_c = j == 0 ? DIR_START : DIR_START + D2;
        /* the first key in an index block is dummy, remember */

    size_t max_free = MAX_FREE(p);
    size_t dir_end = DIR_END(p);
    int total_free = block_size - dir_end;

    if (base.block_free_at_start(n)) failure(0);
    if (base.block_free_now(n)) failure(1);
    base.free_block(n);

    if (j != GET_LEVEL(p)) failure(10);
    if (dir_end <= DIR_START || dir_end > block_size) failure(20);

    if (opts & OPT_SHORT_TREE) report_block(3*(level - j), n, p);

    if (opts & OPT_FULL_TREE) report_block_full(3*(level - j), n, p);

    for (c = DIR_START; c < dir_end; c += D2) {
        Item_ item(p, c);
        int o = item.get_address() - p;
        if (o > int(block_size)) failure(21);
        if (o - dir_end < max_free) failure(30);

        int kt_len = item.size();
        if (o + kt_len > int(block_size)) failure(40);
        total_free -= kt_len;

        if (c > significant_c && Item_(p, c - D2).key() >= item.key())
            failure(50);
    }
    if (total_free != TOTAL_FREE(p))
        failure(60);

    if (j == 0) return;
    for (c = DIR_START; c < dir_end; c += D2) {
        C_[j].c = c;
        block_to_cursor(C_, j - 1, Item_(p, c).block_given_by());

        block_check(C_, j - 1, opts);

        byte * q = C_[j - 1].p;
        /* if j == 1, and c > DIR_START, the first key of level j - 1 must be
         * >= the key of p, c: */

        if (j == 1 && c > DIR_START)
            if (Item_(q, DIR_START).key() < Item_(p, c).key())
                failure(70);

        /* if j > 1, and c > DIR_START, the second key of level j - 1 must be
         * >= the key of p, c: */

        if (j > 1 && c > DIR_START && DIR_END(q) > DIR_START + D2 &&
            Item_(q, DIR_START + D2).key() < Item_(p, c).key())
            failure(80);

        /* the last key of level j - 1 must be < the key of p, c + D2, if c +
         * D2 < dir_end: */

        if (c + D2 < dir_end &&
            (j == 1 || DIR_START + D2 < DIR_END(q)) &&
            Item_(q, DIR_END(q) - D2).key() >= Item_(p, c + D2).key())
            failure(90);

        if (REVISION(q) > REVISION(p)) failure(91);
    }
}

void
BtreeCheck::check(const string & name, int opts, ostream &out)
{
    BtreeCheck B(name, false, out);
    B.open(); // throws exception if open fails
    Cursor_ * C = B.C;

    if (opts & OPT_SHOW_STATS) {
        out << "base" << (char)B.base_letter
            << " blocksize=" << B.block_size / 1024 << "K"
               " items=" << B.item_count
            << " lastblock=" << B.base.get_last_block()
            << " revision=" << B.revision_number
            << " levels=" << B.level
            << " root=";
        if (B.faked_root_block)
            out << "(faked)";
        else
            out << C[B.level].n;
        out << endl;
    }

    int limit = B.base.get_bit_map_size() - 1;

    limit = limit * CHAR_BIT + CHAR_BIT - 1;

    if (opts & OPT_SHOW_BITMAP) {
        for (int j = 0; j <= limit; j++) {
            out << (B.base.block_free_at_start(j) ? '.' : '*');
            if (j > 0) {
                if ((j + 1) % 100 == 0) {
                    out << '\n';
                } else if ((j + 1) % 10 == 0) {
                    out << ' ';
                }
            }
        }
        out << '\n' << endl;
    }

    if (B.faked_root_block) {
        if (opts) out << "void ";
    } else {
        B.block_check(C, B.level, opts);

        /* the bit map should now be entirely clear: */

        if (!B.base.is_empty()) {
            B.failure(100);
        }
    }
    if (opts) out << "B-tree checked okay" << endl;
}

void BtreeCheck::report_cursor(int N, const Cursor_ * C_) const
{
    out << N << ")\n";
    for (int i = 0; i <= level; i++)
        out << "p=" << C_[i].p << ", c=" << C_[i].c << ", n=[" << C_[i].n
            << "], rewrite=" << C_[i].rewrite << endl;
}