composer.cpp

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.
 */
#include "foedus/storage/composer.hpp"

#include <ostream>

#include "foedus/assert_nd.hpp"
#include "foedus/engine.hpp"
#include "foedus/cache/snapshot_file_set.hpp"
#include "foedus/memory/engine_memory.hpp"
#include "foedus/memory/numa_node_memory.hpp"
#include "foedus/snapshot/snapshot.hpp"
#include "foedus/snapshot/snapshot_writer_impl.hpp"
#include "foedus/storage/metadata.hpp"
#include "foedus/storage/storage.hpp"
#include "foedus/storage/storage_manager.hpp"
#include "foedus/storage/array/array_composer_impl.hpp"
#include "foedus/storage/hash/hash_composer_impl.hpp"
#include "foedus/storage/masstree/masstree_composer_impl.hpp"
#include "foedus/storage/sequential/sequential_composer_impl.hpp"

namespace foedus {
namespace storage {
std::ostream& operator<<(std::ostream& o, const Composer& v) {
  o << "<Composer>"
    << "<storage_id_>" << v.get_storage_id() << "</storage_id_>"
    << "<storage_type>" << to_storage_type_name(v.get_storage_type()) << "</storage_type>"
    << "</Composer>";
  return o;
}
std::ostream& operator<<(std::ostream& o, const Composer::DropResult& v) {
  o << "<DropResult>"
    << "<max_observed_>" << v.max_observed_ << "</max_observed_>"
    << "<dropped_all_>" << v.dropped_all_ << "</dropped_all_>"
    << "</DropResult>";
  return o;
}


Composer::Composer(Engine *engine, StorageId storage_id)
  : engine_(engine),
    storage_id_(storage_id),
    storage_type_(engine_->get_storage_manager()->get_storage(storage_id_)->meta_.type_) {}


ErrorStack Composer::compose(const ComposeArguments& args) {
  switch (storage_type_) {
    case kArrayStorage: return array::ArrayComposer(this).compose(args);
    case kHashStorage: return hash::HashComposer(this).compose(args);
    case kSequentialStorage: return sequential::SequentialComposer(this).compose(args);
    case kMasstreeStorage: return masstree::MasstreeComposer(this).compose(args);
    default:
      return kRetOk;
  }
}

ErrorStack Composer::construct_root(const ConstructRootArguments& args) {
  switch (storage_type_) {
    case kArrayStorage: return array::ArrayComposer(this).construct_root(args);
    case kHashStorage: return hash::HashComposer(this).construct_root(args);
    case kSequentialStorage: return sequential::SequentialComposer(this).construct_root(args);
    case kMasstreeStorage: return masstree::MasstreeComposer(this).construct_root(args);
    default:
      return kRetOk;
  }
}

Composer::DropResult Composer::drop_volatiles(const DropVolatilesArguments& args) {
  switch (storage_type_) {
    case kArrayStorage:  return array::ArrayComposer(this).drop_volatiles(args);
    case kHashStorage:  return hash::HashComposer(this).drop_volatiles(args);
    case kSequentialStorage: return sequential::SequentialComposer(this).drop_volatiles(args);
    case kMasstreeStorage: return masstree::MasstreeComposer(this).drop_volatiles(args);
    default:
      return DropResult(args);
  }
}

void Composer::drop_root_volatile(const Composer::DropVolatilesArguments& args) {
  switch (storage_type_) {
    case kArrayStorage:
      array::ArrayComposer(this).drop_root_volatile(args);
      return;
    case kHashStorage:
      hash::HashComposer(this).drop_root_volatile(args);
      return;
    case kSequentialStorage:
      // Sequential storage already dropped it. Nothing to do.
      return;
    case kMasstreeStorage:
      masstree::MasstreeComposer(this).drop_root_volatile(args);
      return;
    default:
      return;
  }
}


void Composer::DropVolatilesArguments::drop(
  Engine* engine,
  VolatilePagePointer pointer) const {
  uint16_t node = pointer.get_numa_node();
  ASSERT_ND(node < engine->get_soc_count());
  ASSERT_ND(!pointer.is_null());
#ifndef NDEBUG
  // let's fill the page with garbage to help debugging
  std::memset(
    engine->get_memory_manager()->get_global_volatile_page_resolver().resolve_offset(pointer),
    0xDA,
    sizeof(Page));
#endif  // NDEBUG

  memory::PagePoolOffsetChunk* chunk = dropped_chunks_ + node;
  if (chunk->full()) {
    memory::PagePool* pool
      = engine->get_memory_manager()->get_node_memory(node)->get_volatile_pool();
    pool->release(chunk->size(), chunk);
    ASSERT_ND(chunk->empty());
  }
  ASSERT_ND(!chunk->full());
  chunk->push_back(pointer.get_offset());
  ++(*dropped_count_);
}

}  // namespace storage
}  // namespace foedus