array_metadata.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_ARRAY_ARRAY_METADATA_HPP_
#define FOEDUS_STORAGE_ARRAY_ARRAY_METADATA_HPP_
#include <stdint.h>

#include <iosfwd>
#include <string>

#include "foedus/cxx11.hpp"
#include "foedus/error_stack.hpp"
#include "foedus/externalize/externalizable.hpp"
#include "foedus/storage/metadata.hpp"
#include "foedus/storage/storage_id.hpp"
#include "foedus/storage/array/array_id.hpp"
#include "foedus/storage/array/fwd.hpp"

namespace foedus {
namespace storage {
namespace array {
struct ArrayMetadata CXX11_FINAL : public Metadata {
  enum Constants {
    kDefaultSnapshotDropVolatilePagesThreshold = 3,
  };
  ArrayMetadata()
    : Metadata(0, kArrayStorage, ""),
    payload_size_(0),
    snapshot_drop_volatile_pages_threshold_(kDefaultSnapshotDropVolatilePagesThreshold),
    padding_(0),
    array_size_(0) {}
  ArrayMetadata(
    StorageId id,
    const StorageName& name,
    uint16_t payload_size,
    ArrayOffset array_size)
    : Metadata(id, kArrayStorage, name),
    payload_size_(payload_size),
    snapshot_drop_volatile_pages_threshold_(kDefaultSnapshotDropVolatilePagesThreshold),
    padding_(0),
    array_size_(array_size) {
  }
  ArrayMetadata(const StorageName& name, uint16_t payload_size, ArrayOffset array_size)
    : Metadata(0, kArrayStorage, name),
    payload_size_(payload_size),
    snapshot_drop_volatile_pages_threshold_(kDefaultSnapshotDropVolatilePagesThreshold),
    padding_(0),
    array_size_(array_size) {
  }

  std::string describe() const;
  friend std::ostream& operator<<(std::ostream& o, const ArrayMetadata& v);

  uint16_t            payload_size_;
  uint16_t            snapshot_drop_volatile_pages_threshold_;
  uint32_t            padding_;  // to make valgrind happy
  ArrayOffset         array_size_;
};

struct ArrayMetadataSerializer CXX11_FINAL : public virtual MetadataSerializer {
  ArrayMetadataSerializer() : MetadataSerializer() {}
  explicit ArrayMetadataSerializer(ArrayMetadata* data)
    : MetadataSerializer(data), data_casted_(data) {}
  EXTERNALIZABLE(ArrayMetadataSerializer);
  ArrayMetadata* data_casted_;
};

}  // namespace array
}  // namespace storage
}  // namespace foedus
#endif  // FOEDUS_STORAGE_ARRAY_ARRAY_METADATA_HPP_