hash_record_location.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_RECORD_LOCATION_HPP_
#define FOEDUS_STORAGE_HASH_RECORD_LOCATION_HPP_

#include "foedus/cxx11.hpp"
#include "foedus/error_code.hpp"
#include "foedus/assorted/assorted_func.hpp"
#include "foedus/storage/hash/fwd.hpp"
#include "foedus/storage/hash/hash_id.hpp"
#include "foedus/xct/fwd.hpp"
#include "foedus/xct/xct_id.hpp"

namespace foedus {
namespace storage {
namespace hash {

struct RecordLocation {
  HashDataPage* page_;
  DataPageSlotIndex index_;
  uint16_t cur_payload_length_;
  uint16_t key_length_;
  uint16_t physical_record_length_;

  char* record_;
  xct::XctId observed_;

  xct::ReadXctAccess* readset_;

  bool is_found() const { return index_ != kSlotNotFound; }
  inline uint16_t get_aligned_key_length() const { return assorted::align8(key_length_); }
  inline uint16_t get_max_payload() const {
    return physical_record_length_ - get_aligned_key_length();
  }

  void clear() {
    page_ = CXX11_NULLPTR;
    index_ = kSlotNotFound;
    cur_payload_length_ = 0;
    key_length_ = 0;
    physical_record_length_ = 0;
    record_ = CXX11_NULLPTR;
    observed_.data_ = 0;
    readset_ = CXX11_NULLPTR;
  }

  ErrorCode populate_logical(
    xct::Xct* cur_xct,
    HashDataPage* page,
    DataPageSlotIndex index,
    bool intended_for_write);

  void populate_physical(HashDataPage* page, DataPageSlotIndex index);
};

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