backends/flint/flint_compact.cc

Go to the documentation of this file.

/* Copyright (C) 2004,2005,2006,2007,2008,2009,2010 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 <xapian/compactor.h>

#include <algorithm>
#include <queue>

#include <cstdio>

#include "safeerrno.h"
#include <sys/types.h>
#include "safesysstat.h"

#include "flint_table.h"
#include "flint_compact.h"
#include "flint_cursor.h"
#include "flint_utils.h"
#include "internaltypes.h"
#include "utils.h"

#include "../byte_length_strings.h"
#include "../prefix_compressed_strings.h"
#include <xapian.h>

using namespace std;

// Put all the helpers in a namespace to avoid symbols colliding with those of
// the same name in chert_compact.cc.
namespace FlintCompact {

static inline bool
is_metainfo_key(const string & key)
{
    return key.size() == 1 && key[0] == '\0';
}

static inline bool
is_user_metadata_key(const string & key)
{
    return key.size() > 1 && key[0] == '\0' && key[1] == '\xc0';
}

class PostlistCursor : private FlintCursor {
    Xapian::docid offset;

  public:
    string key, tag;
    Xapian::docid firstdid;
    Xapian::termcount tf, cf;

    PostlistCursor(FlintTable *in, Xapian::docid offset_)
        : FlintCursor(in), offset(offset_), firstdid(0)
    {
        find_entry(string());
        next();
    }

    ~PostlistCursor()
    {
        delete FlintCursor::get_table();
    }

    bool next() {
        if (!FlintCursor::next()) return false;
        // We put all chunks into the non-initial chunk form here, then fix up
        // the first chunk for each term in the merged database as we merge.
        read_tag();
        key = current_key;
        tag = current_tag;
        tf = cf = 0;
        if (is_metainfo_key(key)) return true;
        if (is_user_metadata_key(key)) return true;
        // Adjust key if this is *NOT* an initial chunk.
        // key is: F_pack_string_preserving_sort(tname)
        // plus optionally: F_pack_uint_preserving_sort(did)
        const char * d = key.data();
        const char * e = d + key.size();
        string tname;
        if (!F_unpack_string_preserving_sort(&d, e, tname))
            throw Xapian::DatabaseCorruptError("Bad postlist key");
        if (d == e) {
            // This is an initial chunk for a term, so adjust tag header.
            d = tag.data();
            e = d + tag.size();
            if (!F_unpack_uint(&d, e, &tf) ||
                !F_unpack_uint(&d, e, &cf) ||
                !F_unpack_uint(&d, e, &firstdid)) {
                throw Xapian::DatabaseCorruptError("Bad postlist tag");
            }
            ++firstdid;
            tag.erase(0, d - tag.data());
        } else {
            // Not an initial chunk, so adjust key.
            size_t tmp = d - key.data();
            if (!F_unpack_uint_preserving_sort(&d, e, &firstdid) || d != e)
                throw Xapian::DatabaseCorruptError("Bad postlist key");
            key.erase(tmp);
        }
        firstdid += offset;
        return true;
    }
};

class PostlistCursorGt {
  public:
    bool operator()(const PostlistCursor *a, const PostlistCursor *b) {
        if (a->key > b->key) return true;
        if (a->key != b->key) return false;
        return (a->firstdid > b->firstdid);
    }
};

static void
merge_postlists(Xapian::Compactor & compactor,
                FlintTable * out, vector<Xapian::docid>::const_iterator offset,
                vector<string>::const_iterator b,
                vector<string>::const_iterator e,
                Xapian::docid last_docid)
{
    totlen_t tot_totlen = 0;
    priority_queue<PostlistCursor *, vector<PostlistCursor *>, PostlistCursorGt> pq;
    for ( ; b != e; ++b, ++offset) {
        FlintTable *in = new FlintTable("postlist", *b, true);
        in->open();
        if (in->empty()) {
            // Skip empty tables.
            delete in;
            continue;
        }

        // PostlistCursor takes ownership of FlintTable in and is
        // responsible for deleting it.
        PostlistCursor * cur = new PostlistCursor(in, *offset);
        // Merge the METAINFO tags from each database into one.
        // They have a key consisting of a single zero byte.
        // They may be absent, if the database contains no documents.  If it
        // has user metadata we'll still get here.
        if (is_metainfo_key(cur->key)) {
            const char * data = cur->tag.data();
            const char * end = data + cur->tag.size();
            Xapian::docid dummy_did = 0;
            if (!F_unpack_uint(&data, end, &dummy_did)) {
                throw Xapian::DatabaseCorruptError("Tag containing meta information is corrupt.");
            }
            totlen_t totlen = 0;
            if (!F_unpack_uint_last(&data, end, &totlen)) {
                throw Xapian::DatabaseCorruptError("Tag containing meta information is corrupt.");
            }
            tot_totlen += totlen;
            if (tot_totlen < totlen) {
                throw "totlen wrapped!";
            }
        }
        if (cur->next()) {
            pq.push(cur);
        } else {
            delete cur;
        }
    }

    {
        string tag = F_pack_uint(last_docid);
        tag += F_pack_uint_last(tot_totlen);
        out->add(string(1, '\0'), tag);
    }

    string last_key;
    {
        // Merge user metadata.
        vector<string> tags;
        while (!pq.empty()) {
            PostlistCursor * cur = pq.top();
            const string& key = cur->key;
            if (!is_user_metadata_key(key)) break;

            if (key != last_key) {
                if (tags.size() > 1) {
                    Assert(!last_key.empty());
                    out->add(last_key,
                             compactor.resolve_duplicate_metadata(last_key,
                                                                  tags.size(),
                                                                  &tags[0]));
                } else if (tags.size() == 1) {
                    Assert(!last_key.empty());
                    out->add(last_key, tags[0]);
                }
                tags.resize(0);
                last_key = key;
            }
            tags.push_back(cur->tag);

            pq.pop();
            if (cur->next()) {
                pq.push(cur);
            } else {
                delete cur;
            }
        }
        if (tags.size() > 1) {
            Assert(!last_key.empty());
            out->add(last_key,
                     compactor.resolve_duplicate_metadata(last_key,
                                                          tags.size(),
                                                          &tags[0]));
        } else if (tags.size() == 1) {
            Assert(!last_key.empty());
            out->add(last_key, tags[0]);
        }
    }

    Xapian::termcount tf = 0, cf = 0; // Initialise to avoid warnings.
    vector<pair<Xapian::docid, string> > tags;
    while (true) {
        PostlistCursor * cur = NULL;
        if (!pq.empty()) {
            cur = pq.top();
            pq.pop();
        }
        Assert(cur == NULL || !is_user_metadata_key(cur->key));
        if (cur == NULL || cur->key != last_key) {
            if (!tags.empty()) {
                string first_tag = F_pack_uint(tf);
                first_tag += F_pack_uint(cf);
                first_tag += F_pack_uint(tags[0].first - 1);
                string tag = tags[0].second;
                tag[0] = (tags.size() == 1) ? '1' : '0';
                first_tag += tag;
                out->add(last_key, first_tag);
                vector<pair<Xapian::docid, string> >::const_iterator i;
                i = tags.begin();
                while (++i != tags.end()) {
                    string new_key = last_key;
                    new_key += F_pack_uint_preserving_sort(i->first);
                    tag = i->second;
                    tag[0] = (i + 1 == tags.end()) ? '1' : '0';
                    out->add(new_key, tag);
                }
            }
            tags.clear();
            if (cur == NULL) break;
            tf = cf = 0;
            last_key = cur->key;
        }
        tf += cur->tf;
        cf += cur->cf;
        tags.push_back(make_pair(cur->firstdid, cur->tag));
        if (cur->next()) {
            pq.push(cur);
        } else {
            delete cur;
        }
    }
}

struct MergeCursor : public FlintCursor {
    MergeCursor(FlintTable *in) : FlintCursor(in) {
        find_entry(string());
        next();
    }

    ~MergeCursor() {
        delete FlintCursor::get_table();
    }
};

struct CursorGt {
    bool operator()(const FlintCursor *a, const FlintCursor *b) {
        if (b->after_end()) return false;
        if (a->after_end()) return true;
        return (a->current_key > b->current_key);
    }
};

static void
merge_spellings(FlintTable * out,
                vector<string>::const_iterator b,
                vector<string>::const_iterator e)
{
    priority_queue<MergeCursor *, vector<MergeCursor *>, CursorGt> pq;
    for ( ; b != e; ++b) {
        FlintTable *in = new FlintTable("spelling", *b, true, DONT_COMPRESS, true);
        in->open();
        if (!in->empty()) {
            // The MergeCursor takes ownership of FlintTable in and is
            // responsible for deleting it.
            pq.push(new MergeCursor(in));
        } else {
            delete in;
        }
    }

    while (!pq.empty()) {
        MergeCursor * cur = pq.top();
        pq.pop();

        string key = cur->current_key;
        if (pq.empty() || pq.top()->current_key > key) {
            // No need to merge the tags, just copy the (possibly compressed)
            // tag value.
            bool compressed = cur->read_tag(true);
            out->add(key, cur->current_tag, compressed);
            if (cur->next()) {
                pq.push(cur);
            } else {
                delete cur;
            }
            continue;
        }

        // Merge tag values with the same key:
        string tag;
        if (key[0] != 'W') {
            // We just want the union of words, so copy over the first instance
            // and skip any identical ones.
            priority_queue<PrefixCompressedStringItor *,
                           vector<PrefixCompressedStringItor *>,
                           PrefixCompressedStringItorGt> pqtag;
            // Stick all the MergeCursor pointers in a vector because their
            // current_tag members must remain valid while we're merging their
            // tags, but we need to call next() on them all afterwards.
            vector<MergeCursor *> vec;
            vec.reserve(pq.size());

            while (true) {
                cur->read_tag();
                pqtag.push(new PrefixCompressedStringItor(cur->current_tag));
                vec.push_back(cur);
                if (pq.empty() || pq.top()->current_key != key) break;
                cur = pq.top();
                pq.pop();
            }

            PrefixCompressedStringWriter wr(tag);
            string lastword;
            while (!pqtag.empty()) {
                PrefixCompressedStringItor * it = pqtag.top();
                string word = **it;
                if (word != lastword) {
                    lastword = word;
                    wr.append(lastword);
                }
                ++*it;
                pqtag.pop();
                if (!it->at_end()) {
                    pqtag.push(it);
                } else {
                    delete it;
                }
            }

            vector<MergeCursor *>::const_iterator i;
            for (i = vec.begin(); i != vec.end(); ++i) {
                cur = *i;
                if (cur->next()) {
                    pq.push(cur);
                } else {
                    delete cur;
                }
            }
        } else {
            // We want to sum the frequencies from tags for the same key.
            Xapian::termcount tot_freq = 0;
            while (true) {
                cur->read_tag();
                Xapian::termcount freq;
                const char * p = cur->current_tag.data();
                const char * end = p + cur->current_tag.size();
                if (!F_unpack_uint_last(&p, end, &freq) || freq == 0) {
                    throw Xapian::DatabaseCorruptError("Bad spelling word freq");
                }
                tot_freq += freq;
                if (cur->next()) {
                    pq.push(cur);
                } else {
                    delete cur;
                }
                if (pq.empty() || pq.top()->current_key != key) break;
                cur = pq.top();
                pq.pop();
            }
            tag = F_pack_uint_last(tot_freq);
        }
        out->add(key, tag);
    }
}

static void
merge_synonyms(FlintTable * out,
               vector<string>::const_iterator b,
               vector<string>::const_iterator e)
{
    priority_queue<MergeCursor *, vector<MergeCursor *>, CursorGt> pq;
    for ( ; b != e; ++b) {
        FlintTable *in = new FlintTable("synonym", *b, true, DONT_COMPRESS, true);
        in->open();
        if (!in->empty()) {
            // The MergeCursor takes ownership of FlintTable in and is
            // responsible for deleting it.
            pq.push(new MergeCursor(in));
        } else {
            delete in;
        }
    }

    while (!pq.empty()) {
        MergeCursor * cur = pq.top();
        pq.pop();

        string key = cur->current_key;
        if (pq.empty() || pq.top()->current_key > key) {
            // No need to merge the tags, just copy the (possibly compressed)
            // tag value.
            bool compressed = cur->read_tag(true);
            out->add(key, cur->current_tag, compressed);
            if (cur->next()) {
                pq.push(cur);
            } else {
                delete cur;
            }
            continue;
        }

        // Merge tag values with the same key:
        string tag;

        // We just want the union of words, so copy over the first instance
        // and skip any identical ones.
        priority_queue<ByteLengthPrefixedStringItor *,
                       vector<ByteLengthPrefixedStringItor *>,
                       ByteLengthPrefixedStringItorGt> pqtag;
        vector<MergeCursor *> vec;

        while (true) {
            cur->read_tag();
            pqtag.push(new ByteLengthPrefixedStringItor(cur->current_tag));
            vec.push_back(cur);
            if (pq.empty() || pq.top()->current_key != key) break;
            cur = pq.top();
            pq.pop();
        }

        string lastword;
        while (!pqtag.empty()) {
            ByteLengthPrefixedStringItor * it = pqtag.top();
            if (**it != lastword) {
                lastword = **it;
                tag += byte(lastword.size() ^ MAGIC_XOR_VALUE);
                tag += lastword;
            }
            ++*it;
            pqtag.pop();
            if (!it->at_end()) {
                pqtag.push(it);
            } else {
                delete it;
            }
        }

        vector<MergeCursor *>::const_iterator i;
        for (i = vec.begin(); i != vec.end(); ++i) {
            cur = *i;
            if (cur->next()) {
                pq.push(cur);
            } else {
                delete cur;
            }
        }

        out->add(key, tag);
    }
}

static void
multimerge_postlists(Xapian::Compactor & compactor,
                     FlintTable * out, const char * tmpdir,
                     Xapian::docid last_docid,
                     vector<string> tmp, vector<Xapian::docid> off)
{
    unsigned int c = 0;
    while (tmp.size() > 3) {
        vector<string> tmpout;
        tmpout.reserve(tmp.size() / 2);
        vector<Xapian::docid> newoff;
        newoff.resize(tmp.size() / 2);
        for (unsigned int i = 0, j; i < tmp.size(); i = j) {
            j = i + 2;
            if (j == tmp.size() - 1) ++j;

            string dest = tmpdir;
            char buf[64];
            sprintf(buf, "/tmp%u_%u.", c, i / 2);
            dest += buf;

            // Don't compress temporary tables, even if the final table would
            // be.
            FlintTable tmptab("postlist", dest, false);
            // Use maximum blocksize for temporary tables.
            tmptab.create_and_open(65536);

            merge_postlists(compactor, &tmptab, off.begin() + i,
                            tmp.begin() + i, tmp.begin() + j, 0);
            if (c > 0) {
                for (unsigned int k = i; k < j; ++k) {
                    unlink((tmp[k] + "DB").c_str());
                    unlink((tmp[k] + "baseA").c_str());
                    unlink((tmp[k] + "baseB").c_str());
                }
            }
            tmpout.push_back(dest);
            tmptab.flush_db();
            tmptab.commit(1);
        }
        swap(tmp, tmpout);
        swap(off, newoff);
        ++c;
    }
    merge_postlists(compactor,
                    out, off.begin(), tmp.begin(), tmp.end(), last_docid);
    if (c > 0) {
        for (size_t k = 0; k < tmp.size(); ++k) {
            unlink((tmp[k] + "DB").c_str());
            unlink((tmp[k] + "baseA").c_str());
            unlink((tmp[k] + "baseB").c_str());
        }
    }
}

static void
merge_docid_keyed(const char * tablename,
                  FlintTable *out, const vector<string> & inputs,
                  const vector<Xapian::docid> & offset, bool lazy)
{
    for (size_t i = 0; i < inputs.size(); ++i) {
        Xapian::docid off = offset[i];

        FlintTable in(tablename, inputs[i], true, DONT_COMPRESS, lazy);
        in.open();
        if (in.empty()) continue;

        FlintCursor cur(&in);
        cur.find_entry(string());

        string key;
        while (cur.next()) {
            // Adjust the key if this isn't the first database.
            if (off) {
                Xapian::docid did;
                const char * d = cur.current_key.data();
                const char * e = d + cur.current_key.size();
                if (!F_unpack_uint_preserving_sort(&d, e, &did)) {
                    string msg = "Bad key in ";
                    msg += inputs[i];
                    throw Xapian::DatabaseCorruptError(msg);
                }
                did += off;
                key = F_pack_uint_preserving_sort(did);
                if (d != e) {
                    // Copy over the termname for the position table.
                    key.append(d, e - d);
                }
            } else {
                key = cur.current_key;
            }
            bool compressed = cur.read_tag(true);
            out->add(key, cur.current_tag, compressed);
        }
    }
}

}

using namespace FlintCompact;

void
compact_flint(Xapian::Compactor & compactor,
              const char * destdir, const vector<string> & sources,
              const vector<Xapian::docid> & offset, size_t block_size,
              Xapian::Compactor::compaction_level compaction, bool multipass,
              Xapian::docid last_docid) {
    enum table_type {
        POSTLIST, RECORD, TERMLIST, POSITION, VALUE, SPELLING, SYNONYM
    };
    struct table_list {
        // The "base name" of the table.
        const char * name;
        // The type.
        table_type type;
        // zlib compression strategy to use on tags.
        int compress_strategy;
        // Create tables after position lazily.
        bool lazy;
    };

    static const table_list tables[] = {
        // name         type            compress_strategy       lazy
        { "postlist",   POSTLIST,       DONT_COMPRESS,          false },
        { "record",     RECORD,         Z_DEFAULT_STRATEGY,     false },
        { "termlist",   TERMLIST,       Z_DEFAULT_STRATEGY,     false },
        { "position",   POSITION,       DONT_COMPRESS,          true },
        { "value",      VALUE,          DONT_COMPRESS,          true },
        { "spelling",   SPELLING,       Z_DEFAULT_STRATEGY,     true },
        { "synonym",    SYNONYM,        Z_DEFAULT_STRATEGY,     true }
    };
    const table_list * tables_end = tables +
        (sizeof(tables) / sizeof(tables[0]));

    for (const table_list * t = tables; t < tables_end; ++t) {
        // The postlist table requires an N-way merge, adjusting the
        // headers of various blocks.  The spelling and synonym tables also
        // need special handling.  The other tables have keys sorted in
        // docid order, so we can merge them by simply copying all the keys
        // from each source table in turn.
        compactor.set_status(t->name, string());

        string dest = destdir;
        dest += '/';
        dest += t->name;
        dest += '.';

        bool output_will_exist = !t->lazy;

        // Sometimes stat can fail for benign reasons (e.g. >= 2GB file
        // on certain systems).
        bool bad_stat = false;

        off_t in_size = 0;

        vector<string> inputs;
        inputs.reserve(sources.size());
        size_t inputs_present = 0;
        for (vector<string>::const_iterator src = sources.begin();
             src != sources.end(); ++src) {
            string s(*src);
            s += t->name;
            s += '.';

            struct stat sb;
            if (stat(s + "DB", &sb) == 0) {
                in_size += sb.st_size / 1024;
                output_will_exist = true;
                ++inputs_present;
            } else if (errno != ENOENT) {
                // We get ENOENT for an optional table.
                bad_stat = true;
                output_will_exist = true;
                ++inputs_present;
            }
            inputs.push_back(s);
        }

        if (!output_will_exist) {
            compactor.set_status(t->name, "doesn't exist");
            continue;
        }

        FlintTable out(t->name, dest, false, t->compress_strategy, t->lazy);
        if (!t->lazy) {
            out.create_and_open(block_size);
        } else {
            out.erase();
            out.set_block_size(block_size);
        }

        out.set_full_compaction(compaction != compactor.STANDARD);
        if (compaction == compactor.FULLER) out.set_max_item_size(1);

        switch (t->type) {
            case POSTLIST:
                if (multipass && inputs.size() > 3) {
                    multimerge_postlists(compactor, &out, destdir, last_docid,
                                         inputs, offset);
                } else {
                    merge_postlists(compactor, &out, offset.begin(),
                                    inputs.begin(), inputs.end(),
                                    last_docid);
                }
                break;
            case SPELLING:
                merge_spellings(&out, inputs.begin(), inputs.end());
                break;
            case SYNONYM:
                merge_synonyms(&out, inputs.begin(), inputs.end());
                break;
            default:
                // Position, Record, Termlist, Value.
                merge_docid_keyed(t->name, &out, inputs, offset, t->lazy);
                break;
        }

        // Commit as revision 1.
        out.flush_db();
        out.commit(1);

        off_t out_size = 0;
        if (!bad_stat) {
            struct stat sb;
            if (stat(dest + "DB", &sb) == 0) {
                out_size = sb.st_size / 1024;
            } else {
                bad_stat = (errno != ENOENT);
            }
        }
        if (bad_stat) {
            compactor.set_status(t->name, "Done (couldn't stat all the DB files)");
        } else {
            string status;
            if (out_size == in_size) {
                status = "Size unchanged (";
            } else {
                off_t delta;
                if (out_size < in_size) {
                    delta = in_size - out_size;
                    status = "Reduced by ";
                } else {
                    delta = out_size - in_size;
                    status = "INCREASED by ";
                }
                status += str(100 * delta / in_size);
                status += "% ";
                status += str(delta);
                status += "K (";
                status += str(in_size);
                status += "K -> ";
            }
            status += str(out_size);
            status += "K)";
            compactor.set_status(t->name, status);
        }
    }
}

---