partitioner.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_PARTITIONER_HPP_
#define FOEDUS_STORAGE_PARTITIONER_HPP_

#include <stdint.h>

#include <iosfwd>

#include "foedus/attachable.hpp"
#include "foedus/cxx11.hpp"
#include "foedus/epoch.hpp"
#include "foedus/error_stack.hpp"
#include "foedus/fwd.hpp"
#include "foedus/cache/fwd.hpp"
#include "foedus/memory/fwd.hpp"
#include "foedus/snapshot/log_buffer.hpp"
#include "foedus/snapshot/snapshot_id.hpp"
#include "foedus/soc/shared_mutex.hpp"
#include "foedus/storage/storage_id.hpp"

namespace foedus {
namespace storage {
class Partitioner CXX11_FINAL : public Attachable<PartitionerMetadata> {
 public:
  Partitioner(Engine* engine, StorageId id);

  const PartitionerMetadata& get_metadata() const;
  bool        is_valid()          const;
  StorageId   get_storage_id()    const { return id_;}
  StorageType get_storage_type()  const { return type_; }

  bool is_partitionable();

  struct DesignPartitionArguments {
    memory::AlignedMemory*  work_memory_;
    cache::SnapshotFileSet* snapshot_files_;
  };

  ErrorStack design_partition(const DesignPartitionArguments& args);

  struct PartitionBatchArguments {
    PartitionId                     local_partition_;
    const snapshot::LogBuffer&      log_buffer_;
    const snapshot::BufferPosition* log_positions_;
    uint32_t                        logs_count_;
    PartitionId*                    results_;
  };

  void partition_batch(const PartitionBatchArguments& args);

  struct SortBatchArguments {
    const snapshot::LogBuffer&        log_buffer_;
    const snapshot::BufferPosition*   log_positions_;
    uint32_t                          logs_count_;
    uint32_t                          shortest_key_length_;
    uint32_t                          longest_key_length_;
    memory::AlignedMemory*            work_memory_;
    Epoch                             base_epoch_;
    snapshot::BufferPosition*         output_buffer_;
    uint32_t*                         written_count_;
  };

  void                sort_batch(const SortBatchArguments& args);

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

 private:
  StorageId         id_;
  StorageType       type_;
};

struct PartitionerMetadata CXX11_FINAL {
  // This object is placed on shared memory. We only reinterpret them.
  PartitionerMetadata() CXX11_FUNC_DELETE;
  ~PartitionerMetadata() CXX11_FUNC_DELETE;

  void initialize() {
    mutex_.initialize();
    clear_counts();
  }
  void uninitialize() {
    mutex_.uninitialize();
  }
  void clear_counts() {
    valid_ = false;
    data_offset_ = 0;
    data_size_ = 0;
  }

  soc::SharedMutex  mutex_;
  bool              valid_;
  uint32_t          data_offset_;
  uint32_t          data_size_;

  void* locate_data(Engine* engine);

  ErrorCode allocate_data(Engine* engine, soc::SharedMutexScope* locked, uint32_t data_size);

  static PartitionerMetadata* get_metadata(Engine* engine, StorageId id);
  static PartitionerMetadata* get_index0_metadata(Engine* engine);

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

}  // namespace storage
}  // namespace foedus
#endif  // FOEDUS_STORAGE_PARTITIONER_HPP_