libfoedus-core
FOEDUS Core Library
cache_options.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2014-2015, Hewlett-Packard Development Company, LP.
3  * This program is free software; you can redistribute it and/or modify it
4  * under the terms of the GNU General Public License as published by the Free
5  * Software Foundation; either version 2 of the License, or (at your option)
6  * any later version.
7  *
8  * This program is distributed in the hope that it will be useful, but WITHOUT
9  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
11  * more details. You should have received a copy of the GNU General Public
12  * License along with this program; if not, write to the Free Software
13  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
14  *
15  * HP designates this particular file as subject to the "Classpath" exception
16  * as provided by HP in the LICENSE.txt file that accompanied this code.
17  */
18 #ifndef FOEDUS_CACHE_CACHE_OPTIONS_HPP_
19 #define FOEDUS_CACHE_CACHE_OPTIONS_HPP_
20 #include "foedus/cxx11.hpp"
21 #include "foedus/externalize/externalizable.hpp"
22 namespace foedus {
23 namespace cache {
29 struct CacheOptions CXX11_FINAL : public virtual externalize::Externalizable {
31  enum Constants {
33  kDefaultSnapshotCacheSizeMbPerNode = 1 << 10,
34  };
35 
39  CacheOptions();
40 
50  bool snapshot_cache_enabled_;
51 
58  uint32_t snapshot_cache_size_mb_per_node_;
59 
68  uint32_t private_snapshot_cache_initial_grab_;
69 
83  float snapshot_cache_eviction_threshold_;
84 
96  float snapshot_cache_urgent_threshold_;
97 
98  EXTERNALIZABLE(CacheOptions);
99 };
100 } // namespace cache
101 } // namespace foedus
102 #endif // FOEDUS_CACHE_CACHE_OPTIONS_HPP_
foedus::externalize::Externalizable
Represents an object that can be written to and read from files/bytes in XML format.
Definition: externalizable.hpp:53
foedus
Root package of FOEDUS (Fast Optimistic Engine for Data Unification Services).
Definition: assert_nd.hpp:44
EXTERNALIZABLE
#define EXTERNALIZABLE(clazz)
Macro to declare/define essential methods for an externalizable class.
Definition: externalizable.hpp:294
foedus::cache::CacheOptions::snapshot_cache_enabled_
bool snapshot_cache_enabled_
Whether to cache the read accesses on snapshot files.
Definition: cache_options.hpp:50
foedus::cache::CacheOptions::CacheOptions
CacheOptions()
Constructs option values with default values.
Definition: cache_options.cpp:24
CXX11_FINAL
#define CXX11_FINAL
Used in public headers in place of "final" of C++11.
Definition: cxx11.hpp:131
foedus::cache::CacheOptions::private_snapshot_cache_initial_grab_
uint32_t private_snapshot_cache_initial_grab_
How many pages for snapshot cache each NumaCoreMemory initially grabs when it is initialized.
Definition: cache_options.hpp:68
foedus::cache::CacheOptions::snapshot_cache_urgent_threshold_
float snapshot_cache_urgent_threshold_
When the cache eviction performs in an urgent mode, which immediately advances the current epoch to r...
Definition: cache_options.hpp:96
foedus::cache::CacheOptions::snapshot_cache_eviction_threshold_
float snapshot_cache_eviction_threshold_
When to start evicting pages in fraction of snapshot page pool capacity.
Definition: cache_options.hpp:83
foedus::cache::CacheOptions
Set of options for snapshot cache manager.
Definition: cache_options.hpp:29
foedus::cache::CacheOptions::kDefaultSnapshotCacheSizeMbPerNode
Default value for snapshot_cache_size_mb_per_node_.
Definition: cache_options.hpp:33
foedus::cache::CacheOptions::snapshot_cache_size_mb_per_node_
uint32_t snapshot_cache_size_mb_per_node_
Size of the snapshot cache in MB per each NUMA node.
Definition: cache_options.hpp:58