hash_reserve_impl.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_RESERVE_IMPL_HPP_
#define FOEDUS_STORAGE_HASH_HASH_RESERVE_IMPL_HPP_

#include "foedus/error_code.hpp"
#include "foedus/storage/hash/fwd.hpp"
#include "foedus/storage/hash/hash_combo.hpp"
#include "foedus/storage/hash/hash_id.hpp"
#include "foedus/thread/fwd.hpp"
#include "foedus/xct/sysxct_functor.hpp"

namespace foedus {
namespace storage {
namespace hash {

struct ReserveRecords final : public xct::SysxctFunctor {
  thread::Thread* const  context_;
  HashDataPage* const     target_;
  const void* const       key_;
  const HashCombo&        combo_;
  const KeyLength         key_length_;
  const PayloadLength     payload_count_;
  const PayloadLength     aggressive_payload_count_hint_;
  const DataPageSlotIndex hint_check_from_;

  DataPageSlotIndex       out_slot_;
  HashDataPage*           out_page_;

  ReserveRecords(
    thread::Thread* context,
    HashDataPage* target,
    const void* key,
    KeyLength key_length,
    const HashCombo& combo,
    PayloadLength payload_count,
    PayloadLength aggressive_payload_count_hint,
    DataPageSlotIndex hint_check_from)
    : xct::SysxctFunctor(),
      context_(context),
      target_(target),
      key_(key),
      combo_(combo),
      key_length_(key_length),
      payload_count_(payload_count),
      aggressive_payload_count_hint_(aggressive_payload_count_hint),
      hint_check_from_(hint_check_from),
      out_slot_(kSlotNotFound),
      out_page_(nullptr) {
  }
  virtual ErrorCode run(xct::SysxctWorkspace* sysxct_workspace) override;

  ErrorCode find_or_create_or_expand(
    xct::SysxctWorkspace* sysxct_workspace,
    HashDataPage* page,
    DataPageSlotIndex examined_records);

  ErrorCode expand_record(
    xct::SysxctWorkspace* sysxct_workspace,
    HashDataPage* page,
    DataPageSlotIndex index);

  ErrorCode find_and_lock_spacious_tail(
    xct::SysxctWorkspace* sysxct_workspace,
    HashDataPage* from_page,
    HashDataPage** tail);

  ErrorCode create_new_record_in_tail_page(HashDataPage* tail);

  ErrorCode create_new_tail_page(
    HashDataPage* cur_tail,
    HashDataPage** new_tail);

  DataPageSlotIndex search_within_page(
    const HashDataPage* page,
    DataPageSlotIndex key_count,
    DataPageSlotIndex examined_records) const;
  DataPageSlotIndex append_record_to_page(HashDataPage* page, xct::XctId initial_xid) const;
};

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