xct_options.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_XCT_XCT_OPTIONS_HPP_
#define FOEDUS_XCT_XCT_OPTIONS_HPP_
#include <stdint.h>

#include <iosfwd>

#include "foedus/cxx11.hpp"
#include "foedus/externalize/externalizable.hpp"

namespace foedus {
namespace xct {
struct XctOptions CXX11_FINAL : public virtual externalize::Externalizable {
  enum Constants {
    kDefaultMaxReadSetSize = 32 << 10,
    kDefaultMaxWriteSetSize = 8 << 10,
    kDefaultMaxLockFreeReadSetSize = 1 << 8,
    kDefaultMaxLockFreeWriteSetSize = 4 << 10,
    kDefaultLocalWorkMemorySizeMb = 2,
    kDefaultEpochAdvanceIntervalMs = 20,
    kMcsImplementationTypeSimple = 0,
    kMcsImplementationTypeExtended = 1,
    kDefaultHotThreshold = 256,  // OCC by default (for test cases and benchamrks that don't set it)
  };

  XctOptions();

  EXTERNALIZABLE(XctOptions);

  uint32_t    max_read_set_size_;

  uint32_t    max_write_set_size_;

  uint32_t    max_lock_free_read_set_size_;

  uint32_t    max_lock_free_write_set_size_;

  uint32_t    local_work_memory_size_mb_;

  uint32_t    epoch_advance_interval_ms_;

  bool        enable_retrospective_lock_list_;

  uint16_t    hot_threshold_for_retrospective_lock_list_;

  bool        force_canonical_xlocks_in_precommit_;

  uint16_t    mcs_implementation_type_;
};
}  // namespace xct
}  // namespace foedus
#endif  // FOEDUS_XCT_XCT_OPTIONS_HPP_