hash_storage_pimpl.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_STORAGE_PIMPL_HPP_
#define FOEDUS_STORAGE_HASH_HASH_STORAGE_PIMPL_HPP_
#include <stdint.h>

#include <string>
#include <vector>

#include "foedus/attachable.hpp"
#include "foedus/compiler.hpp"
#include "foedus/cxx11.hpp"
#include "foedus/fwd.hpp"
#include "foedus/assorted/assorted_func.hpp"
#include "foedus/assorted/const_div.hpp"
#include "foedus/cache/fwd.hpp"
#include "foedus/memory/fwd.hpp"
#include "foedus/soc/shared_memory_repo.hpp"
#include "foedus/storage/fwd.hpp"
#include "foedus/storage/storage.hpp"
#include "foedus/storage/storage_id.hpp"
#include "foedus/storage/hash/fwd.hpp"
#include "foedus/storage/hash/hash_id.hpp"
#include "foedus/storage/hash/hash_metadata.hpp"
#include "foedus/storage/hash/hash_page_impl.hpp"
#include "foedus/storage/hash/hash_storage.hpp"
#include "foedus/thread/fwd.hpp"
#include "foedus/xct/fwd.hpp"

namespace foedus {
namespace storage {
namespace hash {
struct HashStorageControlBlock final {
  // this is backed by shared memory. not instantiation. just reinterpret_cast.
  HashStorageControlBlock() = delete;
  ~HashStorageControlBlock() = delete;

  bool exists() const { return status_ == kExists || status_ == kMarkedForDeath; }
  uint16_t get_root_children() const {
    return assorted::int_div_ceil(bin_count_, kHashMaxBins[levels_ - 1U]);
  }

  soc::SharedMutex    status_mutex_;
  StorageStatus       status_;
  DualPagePointer     root_page_pointer_;
  HashMetadata        meta_;

  // Do NOT reorder members up to here. The layout must be compatible with StorageControlBlock
  // Type-specific shared members below.

  // these are static auxiliary variables. doesn't have to be shared actually, but easier.
  uint64_t            bin_count_;
  uint8_t             levels_;
  char                padding_[7];
};

class HashStoragePimpl final : public Attachable<HashStorageControlBlock> {
 public:
  HashStoragePimpl() : Attachable<HashStorageControlBlock>() {}
  explicit HashStoragePimpl(HashStorage* storage)
    : Attachable<HashStorageControlBlock>(
      storage->get_engine(),
      storage->get_control_block()) {}

  void        release_pages_recursive_root(
    memory::PageReleaseBatch* batch,
    HashIntermediatePage* page,
    VolatilePagePointer volatile_page_id);
  void        release_pages_recursive_intermediate(
    memory::PageReleaseBatch* batch,
    HashIntermediatePage* page,
    VolatilePagePointer volatile_page_id);
  void        release_pages_recursive_data(
    memory::PageReleaseBatch* batch,
    HashDataPage* page,
    VolatilePagePointer volatile_page_id);


  xct::TrackMovedRecordResult track_moved_record(
    xct::RwLockableXctId* old_address,
    xct::WriteXctAccess* write_set);
  xct::TrackMovedRecordResult track_moved_record_search(
    HashDataPage* page,
    const void* key,
    uint16_t key_length,
    const HashCombo& combo);

  ErrorStack  verify_single_thread(Engine* engine);
  ErrorStack  verify_single_thread(thread::Thread* context);
  ErrorStack  verify_single_thread_intermediate(Engine* engine, HashIntermediatePage* page);
  ErrorStack  verify_single_thread_data(Engine* engine, HashDataPage* head);

  ErrorStack  hcc_reset_all_temperature_stat();
  ErrorStack  hcc_reset_all_temperature_stat_intermediate(VolatilePagePointer intermediate_page_id);
  ErrorStack  hcc_reset_all_temperature_stat_data(VolatilePagePointer head_page_id);

  ErrorStack debugout_single_thread(
    Engine* engine,
    bool volatile_only,
    bool intermediate_only,
    uint32_t max_pages);
  ErrorStack debugout_single_thread_intermediate(
    Engine* engine,
    cache::SnapshotFileSet* fileset,
    HashIntermediatePage* parent,
    bool follow_volatile,
    bool intermediate_only,
    uint32_t* remaining_pages);
  ErrorStack debugout_single_thread_data(
    Engine* engine,
    cache::SnapshotFileSet* fileset,
    HashDataPage* head,
    bool follow_volatile,
    uint32_t* remaining_pages);

  ErrorStack  create(const HashMetadata& metadata);
  ErrorStack  load(const StorageControlBlock& snapshot_block);
  ErrorStack  drop();

  bool                exists()    const { return control_block_->exists(); }
  StorageId           get_id()    const { return control_block_->meta_.id_; }
  const StorageName&  get_name()  const { return control_block_->meta_.name_; }
  const HashMetadata& get_meta()  const { return control_block_->meta_; }
  uint8_t             get_levels() const { return control_block_->levels_; }
  HashBin             get_bin_count() const { return get_meta().get_bin_count(); }
  uint8_t             get_bin_bits() const { return get_meta().bin_bits_; }
  uint8_t             get_bin_shifts() const { return get_meta().get_bin_shifts(); }

  ErrorCode   get_record(
    thread::Thread* context,
    const void* key,
    uint16_t key_length,
    const HashCombo& combo,
    void* payload,
    uint16_t* payload_capacity,
    bool read_only);

  template <typename PAYLOAD>
  inline ErrorCode get_record_primitive(
    thread::Thread* context,
    const void* key,
    uint16_t key_length,
    const HashCombo& combo,
    PAYLOAD* payload,
    uint16_t payload_offset,
    bool read_only) {
    // at this point, there isn't enough benefit to do optimization specific to this case.
    // hash-lookup is anyway dominant. memcpy-vs-primitive is not the issue.
    return get_record_part(
      context,
      key,
      key_length,
      combo,
      payload,
      payload_offset,
      sizeof(PAYLOAD),
      read_only);
  }

  ErrorCode   get_record_part(
    thread::Thread* context,
    const void* key,
    uint16_t key_length,
    const HashCombo& combo,
    void* payload,
    uint16_t payload_offset,
    uint16_t payload_count,
    bool read_only);


  ErrorCode register_record_write_log(
    thread::Thread* context,
    const RecordLocation& location,
    log::RecordLogType* log_entry);

  ErrorCode insert_record(
    thread::Thread* context,
    const void* key,
    uint16_t key_length,
    const HashCombo& combo,
    const void* payload,
    uint16_t payload_count,
    uint16_t physical_payload_hint);

  ErrorCode delete_record(
    thread::Thread* context,
    const void* key,
    uint16_t key_length,
    const HashCombo& combo);

  ErrorCode upsert_record(
    thread::Thread* context,
    const void* key,
    uint16_t key_length,
    const HashCombo& combo,
    const void* payload,
    uint16_t payload_count,
    uint16_t physical_payload_hint);

  ErrorCode overwrite_record(
    thread::Thread* context,
    const void* key,
    uint16_t key_length,
    const HashCombo& combo,
    const void* payload,
    uint16_t payload_offset,
    uint16_t payload_count);

  template <typename PAYLOAD>
  inline ErrorCode overwrite_record_primitive(
    thread::Thread* context,
    const void* key,
    uint16_t key_length,
    const HashCombo& combo,
    PAYLOAD payload,
    uint16_t payload_offset) {
    // same above. still handy as an API, though.
    return overwrite_record(
      context,
      key,
      key_length,
      combo,
      &payload,
      payload_offset,
      sizeof(payload));
  }

  template <typename PAYLOAD>
  ErrorCode   increment_record(
    thread::Thread* context,
    const void* key,
    uint16_t key_length,
    const HashCombo& combo,
    PAYLOAD* value,
    uint16_t payload_offset);

  ErrorCode   get_root_page(
    thread::Thread* context,
    bool for_write,
    HashIntermediatePage** root);
  ErrorCode   follow_page(
    thread::Thread* context,
    bool for_write,
    HashIntermediatePage* parent,
    uint16_t index_in_parent,
    Page** page);
  ErrorCode   follow_page_bin_head(
    thread::Thread* context,
    bool for_write,
    HashIntermediatePage* parent,
    uint16_t index_in_parent,
    Page** page);

  ErrorCode   locate_bin(
    thread::Thread* context,
    bool for_write,
    const HashCombo& combo,
    HashDataPage** bin_head);

  ErrorCode   locate_record(
    thread::Thread* context,
    bool for_write,
    bool physical_only,
    bool create_if_notfound,
    uint16_t create_payload_length,
    const void* key,
    uint16_t key_length,
    const HashCombo& combo,
    HashDataPage* bin_head,
    RecordLocation* result);

  ErrorCode   locate_record_physical_only(
    thread::Thread* context,
    bool for_write,
    bool create_if_notfound,
    uint16_t create_payload_length,
    const void* key,
    uint16_t key_length,
    const HashCombo& combo,
    HashDataPage* bin_head,
    RecordLocation* result) {
    return locate_record(
      context,
      for_write,
      true,
      create_if_notfound,
      create_payload_length,
      key,
      key_length,
      combo,
      bin_head,
      result);
  }
  ErrorCode   locate_record_logical(
    thread::Thread* context,
    bool for_write,
    bool create_if_notfound,
    uint16_t create_payload_length,
    const void* key,
    uint16_t key_length,
    const HashCombo& combo,
    HashDataPage* bin_head,
    RecordLocation* result) {
    return locate_record(
      context,
      for_write,
      false,
      create_if_notfound,
      create_payload_length,
      key,
      key_length,
      combo,
      bin_head,
      result);
  }

  ErrorCode locate_record_in_snapshot(
    thread::Thread* context,
    const void* key,
    uint16_t key_length,
    const HashCombo& combo,
    HashDataPage* bin_head,
    RecordLocation* result);

  ErrorCode   locate_record_reserve_physical(
    thread::Thread* context,
    const void* key,
    uint16_t key_length,
    const HashCombo& combo,
    uint16_t payload_length,
    HashDataPage** page_in_out,
    uint16_t examined_records,
    DataPageSlotIndex* new_location);
};
static_assert(sizeof(HashStoragePimpl) <= kPageSize, "HashStoragePimpl is too large");
static_assert(
  sizeof(HashStorageControlBlock) <= soc::GlobalMemoryAnchors::kStorageMemorySize,
  "HashStorageControlBlock is too large.");
}  // namespace hash
}  // namespace storage
}  // namespace foedus
#endif  // FOEDUS_STORAGE_HASH_HASH_STORAGE_PIMPL_HPP_