btree.h

Go to the documentation of this file.

/*
 * (c) Copyright 2011-2014, Hewlett-Packard Development Company, LP
 */

#ifndef __BTREE_H
#define __BTREE_H

/*
 *  Interface to btree manager.
 *  NB: put NO INLINE FUNCTIONS here.
 *  Implementation is class btree_impl, in btree_impl.[ch].
 */
#include "w_defines.h"

class btree_page_h;
struct btree_stats_t;
class bt_cursor_t;
struct btree_lf_stats_t;
struct btree_int_stats_t;
class w_keystr_t;
class verify_volume_result;
struct okvl_mode;

class btree_m : public smlevel_0 {
    friend class btree_page_h;
    friend class btree_impl;
    friend class bt_cursor_t;
    friend class btree_remove_log;
    friend class btree_insert_log;
    friend class btree_insert_nonghost_log;
    friend class btree_update_log;
    friend class btree_overwrite_log;
    friend class btree_ghost_mark_log;
    friend class btree_ghost_reclaim_log;

public:
    btree_m() {};

    ~btree_m() {};

    void construct_once();

    void destruct_once();

    static smsize_t max_entry_size();

    static rc_t create(
            StoreID stid,
            PageID root
                      );

    static rc_t insert(
            StoreID store,
            const w_keystr_t& key,
            const cvec_t& elem);

    static rc_t update(
            StoreID store,
            const w_keystr_t& key,
            const cvec_t& elem);

    static rc_t put(
            StoreID store,
            const w_keystr_t& key,
            const cvec_t& elem);

    static rc_t overwrite(
            StoreID store,
            const w_keystr_t& key,
            const char* el,
            smsize_t offset,
            smsize_t elen);

    static rc_t remove(
            StoreID store,
            const w_keystr_t& key);

    static void print(const PageID& root, bool print_elem = true);

    static rc_t touch_all(StoreID stid, uint64_t& page_count);

    static rc_t touch(const btree_page_h& page, uint64_t& page_count);

    static rc_t defrag_page(btree_page_h& page);

    static rc_t lookup(
            StoreID store,
            const w_keystr_t& key_to_find,
            void* el,
            smsize_t& elen,
            bool& found);

    static rc_t get_du_statistics(
            const PageID& root_pid,
            btree_stats_t& btree_stats,
            bool audit);

    static rc_t verify_tree(
            StoreID store, int hash_bits, bool& consistent);

    static rc_t verify_volume(
            int hash_bits, verify_volume_result& result);

protected:
    /*
     * for use by logrecs for undo
     */
    static rc_t remove_as_undo(StoreID store, const w_keystr_t& key);

    static rc_t update_as_undo(StoreID store, const w_keystr_t& key, const cvec_t& elem);

    static rc_t overwrite_as_undo(StoreID store, const w_keystr_t& key,
                                  const char* el, smsize_t offset, smsize_t elen);

    static rc_t undo_ghost_mark(StoreID store, const w_keystr_t& key);

private:
    static rc_t is_empty(StoreID store, bool& ret);

    static rc_t _get_du_statistics_recurse(
            const PageID& currentpid,
            btree_stats_t& _stats,
            base_stat_t& lf_cnt,
            base_stat_t& int_cnt,
            btree_lf_stats_t& lf_stats,
            btree_int_stats_t& int_stats,
            bool audit);
};

/*<std-footer incl-file-exclusion='BTREE_H'>  -- do not edit anything below this line -- */

#endif // __BTREE_H /*</std-footer>*/