w_okvl.h

Go to the documentation of this file.

/*
 * (c) Copyright 2013-, Hewlett-Packard Development Company, LP
 */
#ifndef __W_OKVL_H
#define __W_OKVL_H

#include <cstring> // for memset/memcpy/memcmp
#include <cstdint>

const uint32_t OKVL_PARTITIONS = 2; // 127; // 29;

const uint32_t OKVL_MODE_COUNT = (OKVL_PARTITIONS + 1 + 1);

struct okvl_mode {
    typedef uint16_t part_id;

    enum element_lock_mode { N = 0, IS, IX, S, SIX, X, COUNT,
    };

    unsigned char modes[OKVL_MODE_COUNT];

    okvl_mode();

    okvl_mode(const okvl_mode& r);

    okvl_mode& operator=(const okvl_mode& r);

    okvl_mode(element_lock_mode key_mode, element_lock_mode gap_mode);

    okvl_mode(part_id part, element_lock_mode partition_mode);

    element_lock_mode get_partition_mode(part_id partition) const;

    element_lock_mode get_key_mode() const;

    element_lock_mode get_gap_mode() const;

    bool is_empty() const;

    bool is_keylock_empty() const;

    bool is_keylock_partition_empty() const;

    bool contains_dirty_lock() const;

    // Return whether this contains dirty lock on key, not gap
    bool contains_dirty_key_lock() const;

    void set_partition_mode(part_id partition, element_lock_mode mode);

    void set_key_mode(element_lock_mode mode);

    void set_gap_mode(element_lock_mode mode);

    void clear();

    bool is_compatible_request(const okvl_mode& requested) const;

    bool is_compatible_grant(const okvl_mode& granted) const;

    bool is_implied_by(const okvl_mode& superset) const;

    bool operator==(const okvl_mode& r) const;

    bool operator!=(const okvl_mode& r) const;

    static bool is_compatible(const okvl_mode& requested, const okvl_mode& granted);

    static bool is_compatible_element(element_lock_mode requested, element_lock_mode granted);

    static bool is_implied_by_element(element_lock_mode left, element_lock_mode right);

    static part_id compute_part_id(const void* uniquefier, int uniquefier_length);

    static okvl_mode combine(const okvl_mode& left, const okvl_mode& right);

private:
    enum const_values_enum {
        WORD_SIZE = sizeof(uint64_t),
    };

    static bool _can_batch64(part_id part);

    uint64_t _get_batch64(part_id part) const;

    uint64_t& _get_batch64_ref(part_id part);
};

#endif // __W_OKVL_H