hash_tmpbin.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2014-2015, Hewlett-Packard Development Company, LP.
 * 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
 *
 * HP designates this particular file as subject to the "Classpath" exception
 * as provided by HP in the LICENSE.txt file that accompanied this code.
 */
#ifndef FOEDUS_STORAGE_HASH_HASH_TMPBIN_HPP_
#define FOEDUS_STORAGE_HASH_HASH_TMPBIN_HPP_

#include <stdint.h>

#include <iosfwd>

#include "foedus/compiler.hpp"
#include "foedus/cxx11.hpp"
#include "foedus/assorted/assorted_func.hpp"
#include "foedus/memory/aligned_memory.hpp"
#include "foedus/storage/hash/fwd.hpp"
#include "foedus/storage/hash/hash_hashinate.hpp"
#include "foedus/storage/hash/hash_id.hpp"
#include "foedus/xct/xct_id.hpp"

namespace foedus {
namespace storage {
namespace hash {

class HashTmpBin CXX11_FINAL {
 public:
  enum Constants {
    kBucketCount = 1 << 16,
    kDefaultInitialSize = 1 << 24,
  };

  typedef uint32_t RecordIndex;

  struct Record {
    xct::XctId  xct_id_;          // +8 -> 8
    uint16_t    key_length_;      // +2 -> 10
    uint16_t    payload_length_;  // +2 -> 12
    uint16_t    aligned_key_length_;      // +2 -> 14
    uint16_t    aligned_payload_length_;  // +2 -> 16
    HashValue   hash_;            // +8 -> 24
    RecordIndex next_;            // +4 -> 28
    uint32_t    unused_;          // +4 -> 32
    char        data_[kPageSize - 32];  // -> kPageSize

    inline char*  get_key() ALWAYS_INLINE { return data_; }
    inline char*  get_payload() ALWAYS_INLINE { return data_ + aligned_key_length_; }
    inline Record*      get_record_next(const HashTmpBin* enclosure) const ALWAYS_INLINE {
      return enclosure->get_record(next_);
    }

    inline void   set_all(
      xct::XctId xct_id,
      const void* key,
      uint16_t key_length,
      HashValue hash,
      const void* payload,
      uint16_t payload_length) ALWAYS_INLINE {
      xct_id_ = xct_id;
      ASSERT_ND(!xct_id.is_deleted());
      key_length_ = key_length;
      payload_length_ = payload_length;
      aligned_key_length_ = assorted::align8(key_length);
      aligned_payload_length_ = assorted::align8(payload_length);
      hash_ = hash;
      next_ = 0;

      std::memcpy(get_key(), key, key_length);
      if (key_length != aligned_key_length_) {
        std::memset(get_key() + key_length, 0, aligned_key_length_ - key_length);
      }

      std::memcpy(get_payload(), payload, payload_length);
      if (payload_length != aligned_payload_length_) {
        std::memset(get_payload() + payload_length, 0, aligned_payload_length_ - payload_length);
      }
    }

    inline void   set_payload(const void* payload, uint16_t payload_length) ALWAYS_INLINE {
      payload_length_ = payload_length;
      aligned_payload_length_ = assorted::align8(payload_length);

      std::memcpy(get_payload(), payload, payload_length);
      if (payload_length != aligned_payload_length_) {
        std::memset(get_payload() + payload_length, 0, aligned_payload_length_ - payload_length);
      }
    }
    inline void   overwrite_payload(
      const void* payload,
      uint16_t payload_offset,
      uint16_t payload_count) ALWAYS_INLINE {
      std::memcpy(get_payload() + payload_offset, payload, payload_count);
    }
  };


  HashTmpBin();

  ErrorCode create_memory(uint16_t numa_node, uint64_t initial_size = kDefaultInitialSize);

  void      release_memory();

  void      steal_memory(memory::AlignedMemory* provider);

  void      give_memory(memory::AlignedMemory* recipient);

  void      clean();
  void      clean_quick();

  Record*     get_record(RecordIndex index) const {
    ASSERT_ND(index < records_capacity_);
    ASSERT_ND(index >= sizeof(RecordIndex) * kBucketCount / sizeof(Record));
    return records_ + index;
  }
  RecordIndex get_records_capacity() const { return records_capacity_; }
  RecordIndex get_records_consumed() const { return records_consumed_; }
  RecordIndex get_first_record() const {
    return sizeof(RecordIndex) * kBucketCount / sizeof(Record);
  }
  uint32_t    get_physical_record_count() const {
    return get_records_consumed() - get_first_record();
  }
  RecordIndex get_bucket_head(uint32_t bucket) const {
    ASSERT_ND(bucket < kBucketCount);
    return buckets_[bucket];
  }


  ErrorCode insert_record(
    xct::XctId xct_id,
    const void* key,
    uint16_t key_length,
    HashValue hash,
    const void* payload,
    uint16_t payload_length);

  ErrorCode delete_record(
    xct::XctId xct_id,
    const void* key,
    uint16_t key_length,
    HashValue hash);

  ErrorCode overwrite_record(
    xct::XctId xct_id,
    const void* key,
    uint16_t key_length,
    HashValue hash,
    const void* payload,
    uint16_t payload_offset,
    uint16_t payload_count);

  ErrorCode update_record(
    xct::XctId xct_id,
    const void* key,
    uint16_t key_length,
    HashValue hash,
    const void* payload,
    uint16_t payload_length);

  friend std::ostream& operator<<(std::ostream& o, const HashTmpBin& v);

 private:
  memory::AlignedMemory memory_;

  RecordIndex           records_capacity_;
  RecordIndex           records_consumed_;

  RecordIndex*          buckets_;

  Record*               records_;

  ErrorCode               alloc_record(RecordIndex* out) ALWAYS_INLINE;
  void                    on_memory_set();

  inline static uint16_t  extract_bucket(HashValue hash) ALWAYS_INLINE {
    return hash & 0xFFFFU;  // so far the lowest 16 bits.
  }

  struct SearchResult {
    SearchResult(RecordIndex found, RecordIndex tail) : found_(found), tail_(tail) {}
    RecordIndex found_;
    RecordIndex tail_;
  };
  SearchResult search_bucket(
    const void* key,
    uint16_t key_length,
    HashValue hash) const ALWAYS_INLINE;
};

}  // namespace hash
}  // namespace storage
}  // namespace foedus
#endif  // FOEDUS_STORAGE_HASH_HASH_TMPBIN_HPP_