2 * Copyright (c) 2014 Brocade Communications Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
9 package org.opendaylight.controller.cluster.datastore;
11 import akka.util.Timeout;
12 import com.google.common.collect.Sets;
14 import java.util.concurrent.TimeUnit;
15 import org.apache.commons.lang3.text.WordUtils;
16 import org.opendaylight.controller.cluster.common.actor.AkkaConfigurationReader;
17 import org.opendaylight.controller.cluster.common.actor.FileAkkaConfigurationReader;
18 import org.opendaylight.controller.cluster.raft.ConfigParams;
19 import org.opendaylight.controller.cluster.raft.DefaultConfigParamsImpl;
20 import org.opendaylight.controller.cluster.raft.PeerAddressResolver;
21 import org.opendaylight.controller.md.sal.dom.store.impl.InMemoryDOMDataStoreConfigProperties;
22 import scala.concurrent.duration.Duration;
23 import scala.concurrent.duration.FiniteDuration;
26 * Contains contextual data for a data store.
28 * @author Thomas Pantelis
30 public class DatastoreContext {
31 public static final String METRICS_DOMAIN = "org.opendaylight.controller.cluster.datastore";
33 public static final Duration DEFAULT_SHARD_TRANSACTION_IDLE_TIMEOUT = Duration.create(10, TimeUnit.MINUTES);
34 public static final int DEFAULT_OPERATION_TIMEOUT_IN_MS = 5000;
35 public static final int DEFAULT_SHARD_TX_COMMIT_TIMEOUT_IN_SECONDS = 30;
36 public static final int DEFAULT_JOURNAL_RECOVERY_BATCH_SIZE = 1000;
37 public static final int DEFAULT_SNAPSHOT_BATCH_COUNT = 20000;
38 public static final int DEFAULT_HEARTBEAT_INTERVAL_IN_MILLIS = 500;
39 public static final int DEFAULT_ISOLATED_LEADER_CHECK_INTERVAL_IN_MILLIS = DEFAULT_HEARTBEAT_INTERVAL_IN_MILLIS * 10;
40 public static final int DEFAULT_SHARD_TX_COMMIT_QUEUE_CAPACITY = 50000;
41 public static final Timeout DEFAULT_SHARD_INITIALIZATION_TIMEOUT = new Timeout(5, TimeUnit.MINUTES);
42 public static final Timeout DEFAULT_SHARD_LEADER_ELECTION_TIMEOUT = new Timeout(30, TimeUnit.SECONDS);
43 public static final boolean DEFAULT_PERSISTENT = true;
44 public static final FileAkkaConfigurationReader DEFAULT_CONFIGURATION_READER = new FileAkkaConfigurationReader();
45 public static final int DEFAULT_SHARD_SNAPSHOT_DATA_THRESHOLD_PERCENTAGE = 12;
46 public static final int DEFAULT_SHARD_ELECTION_TIMEOUT_FACTOR = 2;
47 public static final int DEFAULT_TX_CREATION_INITIAL_RATE_LIMIT = 100;
48 public static final String UNKNOWN_DATA_STORE_TYPE = "unknown";
49 public static final int DEFAULT_SHARD_BATCHED_MODIFICATION_COUNT = 1000;
50 public static final long DEFAULT_SHARD_COMMIT_QUEUE_EXPIRY_TIMEOUT_IN_MS = TimeUnit.MILLISECONDS.convert(2, TimeUnit.MINUTES);
51 public static final int DEFAULT_SHARD_SNAPSHOT_CHUNK_SIZE = 2048000;
53 private static Set<String> globalDatastoreTypes = Sets.newConcurrentHashSet();
55 private InMemoryDOMDataStoreConfigProperties dataStoreProperties;
56 private Duration shardTransactionIdleTimeout = DatastoreContext.DEFAULT_SHARD_TRANSACTION_IDLE_TIMEOUT;
57 private long operationTimeoutInMillis = DEFAULT_OPERATION_TIMEOUT_IN_MS;
58 private String dataStoreMXBeanType;
59 private int shardTransactionCommitTimeoutInSeconds = DEFAULT_SHARD_TX_COMMIT_TIMEOUT_IN_SECONDS;
60 private int shardTransactionCommitQueueCapacity = DEFAULT_SHARD_TX_COMMIT_QUEUE_CAPACITY;
61 private Timeout shardInitializationTimeout = DEFAULT_SHARD_INITIALIZATION_TIMEOUT;
62 private Timeout shardLeaderElectionTimeout = DEFAULT_SHARD_LEADER_ELECTION_TIMEOUT;
63 private boolean persistent = DEFAULT_PERSISTENT;
64 private AkkaConfigurationReader configurationReader = DEFAULT_CONFIGURATION_READER;
65 private long transactionCreationInitialRateLimit = DEFAULT_TX_CREATION_INITIAL_RATE_LIMIT;
66 private final DefaultConfigParamsImpl raftConfig = new DefaultConfigParamsImpl();
67 private String dataStoreType = UNKNOWN_DATA_STORE_TYPE;
68 private int shardBatchedModificationCount = DEFAULT_SHARD_BATCHED_MODIFICATION_COUNT;
69 private boolean writeOnlyTransactionOptimizationsEnabled = true;
70 private long shardCommitQueueExpiryTimeoutInMillis = DEFAULT_SHARD_COMMIT_QUEUE_EXPIRY_TIMEOUT_IN_MS;
71 private boolean transactionDebugContextEnabled = false;
73 public static Set<String> getGlobalDatastoreTypes() {
74 return globalDatastoreTypes;
77 private DatastoreContext() {
78 setShardJournalRecoveryLogBatchSize(DEFAULT_JOURNAL_RECOVERY_BATCH_SIZE);
79 setSnapshotBatchCount(DEFAULT_SNAPSHOT_BATCH_COUNT);
80 setHeartbeatInterval(DEFAULT_HEARTBEAT_INTERVAL_IN_MILLIS);
81 setIsolatedLeaderCheckInterval(DEFAULT_ISOLATED_LEADER_CHECK_INTERVAL_IN_MILLIS);
82 setSnapshotDataThresholdPercentage(DEFAULT_SHARD_SNAPSHOT_DATA_THRESHOLD_PERCENTAGE);
83 setElectionTimeoutFactor(DEFAULT_SHARD_ELECTION_TIMEOUT_FACTOR);
84 setShardSnapshotChunkSize(DEFAULT_SHARD_SNAPSHOT_CHUNK_SIZE);
87 private DatastoreContext(DatastoreContext other) {
88 this.dataStoreProperties = other.dataStoreProperties;
89 this.shardTransactionIdleTimeout = other.shardTransactionIdleTimeout;
90 this.operationTimeoutInMillis = other.operationTimeoutInMillis;
91 this.dataStoreMXBeanType = other.dataStoreMXBeanType;
92 this.shardTransactionCommitTimeoutInSeconds = other.shardTransactionCommitTimeoutInSeconds;
93 this.shardTransactionCommitQueueCapacity = other.shardTransactionCommitQueueCapacity;
94 this.shardInitializationTimeout = other.shardInitializationTimeout;
95 this.shardLeaderElectionTimeout = other.shardLeaderElectionTimeout;
96 this.persistent = other.persistent;
97 this.configurationReader = other.configurationReader;
98 this.transactionCreationInitialRateLimit = other.transactionCreationInitialRateLimit;
99 this.dataStoreType = other.dataStoreType;
100 this.shardBatchedModificationCount = other.shardBatchedModificationCount;
101 this.writeOnlyTransactionOptimizationsEnabled = other.writeOnlyTransactionOptimizationsEnabled;
102 this.shardCommitQueueExpiryTimeoutInMillis = other.shardCommitQueueExpiryTimeoutInMillis;
103 this.transactionDebugContextEnabled = other.transactionDebugContextEnabled;
105 setShardJournalRecoveryLogBatchSize(other.raftConfig.getJournalRecoveryLogBatchSize());
106 setSnapshotBatchCount(other.raftConfig.getSnapshotBatchCount());
107 setHeartbeatInterval(other.raftConfig.getHeartBeatInterval().toMillis());
108 setIsolatedLeaderCheckInterval(other.raftConfig.getIsolatedCheckIntervalInMillis());
109 setSnapshotDataThresholdPercentage(other.raftConfig.getSnapshotDataThresholdPercentage());
110 setElectionTimeoutFactor(other.raftConfig.getElectionTimeoutFactor());
111 setCustomRaftPolicyImplementation(other.raftConfig.getCustomRaftPolicyImplementationClass());
112 setShardSnapshotChunkSize(other.raftConfig.getSnapshotChunkSize());
113 setPeerAddressResolver(other.raftConfig.getPeerAddressResolver());
116 public static Builder newBuilder() {
117 return new Builder(new DatastoreContext());
120 public static Builder newBuilderFrom(DatastoreContext context) {
121 return new Builder(new DatastoreContext(context));
124 public InMemoryDOMDataStoreConfigProperties getDataStoreProperties() {
125 return dataStoreProperties;
128 public Duration getShardTransactionIdleTimeout() {
129 return shardTransactionIdleTimeout;
132 public String getDataStoreMXBeanType() {
133 return dataStoreMXBeanType;
136 public long getOperationTimeoutInMillis() {
137 return operationTimeoutInMillis;
140 public ConfigParams getShardRaftConfig() {
144 public int getShardTransactionCommitTimeoutInSeconds() {
145 return shardTransactionCommitTimeoutInSeconds;
148 public int getShardTransactionCommitQueueCapacity() {
149 return shardTransactionCommitQueueCapacity;
152 public Timeout getShardInitializationTimeout() {
153 return shardInitializationTimeout;
156 public Timeout getShardLeaderElectionTimeout() {
157 return shardLeaderElectionTimeout;
160 public boolean isPersistent() {
164 public AkkaConfigurationReader getConfigurationReader() {
165 return configurationReader;
168 public long getShardElectionTimeoutFactor(){
169 return raftConfig.getElectionTimeoutFactor();
172 public String getDataStoreType(){
173 return dataStoreType;
176 public long getTransactionCreationInitialRateLimit() {
177 return transactionCreationInitialRateLimit;
180 private void setPeerAddressResolver(PeerAddressResolver resolver) {
181 raftConfig.setPeerAddressResolver(resolver);
184 private void setHeartbeatInterval(long shardHeartbeatIntervalInMillis){
185 raftConfig.setHeartBeatInterval(new FiniteDuration(shardHeartbeatIntervalInMillis,
186 TimeUnit.MILLISECONDS));
189 private void setShardJournalRecoveryLogBatchSize(int shardJournalRecoveryLogBatchSize){
190 raftConfig.setJournalRecoveryLogBatchSize(shardJournalRecoveryLogBatchSize);
194 private void setIsolatedLeaderCheckInterval(long shardIsolatedLeaderCheckIntervalInMillis) {
195 raftConfig.setIsolatedLeaderCheckInterval(
196 new FiniteDuration(shardIsolatedLeaderCheckIntervalInMillis, TimeUnit.MILLISECONDS));
199 private void setElectionTimeoutFactor(long shardElectionTimeoutFactor) {
200 raftConfig.setElectionTimeoutFactor(shardElectionTimeoutFactor);
203 private void setCustomRaftPolicyImplementation(String customRaftPolicyImplementation) {
204 raftConfig.setCustomRaftPolicyImplementationClass(customRaftPolicyImplementation);
207 private void setSnapshotDataThresholdPercentage(int shardSnapshotDataThresholdPercentage) {
208 raftConfig.setSnapshotDataThresholdPercentage(shardSnapshotDataThresholdPercentage);
211 private void setSnapshotBatchCount(long shardSnapshotBatchCount) {
212 raftConfig.setSnapshotBatchCount(shardSnapshotBatchCount);
215 private void setShardSnapshotChunkSize(int shardSnapshotChunkSize) {
216 raftConfig.setSnapshotChunkSize(shardSnapshotChunkSize);
219 public int getShardBatchedModificationCount() {
220 return shardBatchedModificationCount;
223 public boolean isWriteOnlyTransactionOptimizationsEnabled() {
224 return writeOnlyTransactionOptimizationsEnabled;
227 public long getShardCommitQueueExpiryTimeoutInMillis() {
228 return shardCommitQueueExpiryTimeoutInMillis;
231 public boolean isTransactionDebugContextEnabled() {
232 return transactionDebugContextEnabled;
235 public int getShardSnapshotChunkSize() {
236 return raftConfig.getSnapshotChunkSize();
239 public static class Builder {
240 private final DatastoreContext datastoreContext;
241 private int maxShardDataChangeExecutorPoolSize =
242 InMemoryDOMDataStoreConfigProperties.DEFAULT_MAX_DATA_CHANGE_EXECUTOR_POOL_SIZE;
243 private int maxShardDataChangeExecutorQueueSize =
244 InMemoryDOMDataStoreConfigProperties.DEFAULT_MAX_DATA_CHANGE_EXECUTOR_QUEUE_SIZE;
245 private int maxShardDataChangeListenerQueueSize =
246 InMemoryDOMDataStoreConfigProperties.DEFAULT_MAX_DATA_CHANGE_LISTENER_QUEUE_SIZE;
247 private int maxShardDataStoreExecutorQueueSize =
248 InMemoryDOMDataStoreConfigProperties.DEFAULT_MAX_DATA_STORE_EXECUTOR_QUEUE_SIZE;
250 private Builder(DatastoreContext datastoreContext) {
251 this.datastoreContext = datastoreContext;
253 if(datastoreContext.getDataStoreProperties() != null) {
254 maxShardDataChangeExecutorPoolSize =
255 datastoreContext.getDataStoreProperties().getMaxDataChangeExecutorPoolSize();
256 maxShardDataChangeExecutorQueueSize =
257 datastoreContext.getDataStoreProperties().getMaxDataChangeExecutorQueueSize();
258 maxShardDataChangeListenerQueueSize =
259 datastoreContext.getDataStoreProperties().getMaxDataChangeListenerQueueSize();
260 maxShardDataStoreExecutorQueueSize =
261 datastoreContext.getDataStoreProperties().getMaxDataStoreExecutorQueueSize();
265 public Builder boundedMailboxCapacity(int boundedMailboxCapacity) {
266 // TODO - this is defined in the yang DataStoreProperties but not currently used.
270 public Builder enableMetricCapture(boolean enableMetricCapture) {
271 // TODO - this is defined in the yang DataStoreProperties but not currently used.
276 public Builder shardTransactionIdleTimeout(long timeout, TimeUnit unit) {
277 datastoreContext.shardTransactionIdleTimeout = Duration.create(timeout, unit);
281 public Builder shardTransactionIdleTimeoutInMinutes(long timeout) {
282 return shardTransactionIdleTimeout(timeout, TimeUnit.MINUTES);
285 public Builder operationTimeoutInSeconds(int operationTimeoutInSeconds) {
286 datastoreContext.operationTimeoutInMillis = TimeUnit.SECONDS.toMillis(operationTimeoutInSeconds);
290 public Builder operationTimeoutInMillis(long operationTimeoutInMillis) {
291 datastoreContext.operationTimeoutInMillis = operationTimeoutInMillis;
295 public Builder dataStoreMXBeanType(String dataStoreMXBeanType) {
296 datastoreContext.dataStoreMXBeanType = dataStoreMXBeanType;
300 public Builder shardTransactionCommitTimeoutInSeconds(int shardTransactionCommitTimeoutInSeconds) {
301 datastoreContext.shardTransactionCommitTimeoutInSeconds = shardTransactionCommitTimeoutInSeconds;
305 public Builder shardJournalRecoveryLogBatchSize(int shardJournalRecoveryLogBatchSize) {
306 datastoreContext.setShardJournalRecoveryLogBatchSize(shardJournalRecoveryLogBatchSize);
310 public Builder shardSnapshotBatchCount(int shardSnapshotBatchCount) {
311 datastoreContext.setSnapshotBatchCount(shardSnapshotBatchCount);
315 public Builder shardSnapshotDataThresholdPercentage(int shardSnapshotDataThresholdPercentage) {
316 datastoreContext.setSnapshotDataThresholdPercentage(shardSnapshotDataThresholdPercentage);
320 public Builder shardHeartbeatIntervalInMillis(int shardHeartbeatIntervalInMillis) {
321 datastoreContext.setHeartbeatInterval(shardHeartbeatIntervalInMillis);
325 public Builder shardTransactionCommitQueueCapacity(int shardTransactionCommitQueueCapacity) {
326 datastoreContext.shardTransactionCommitQueueCapacity = shardTransactionCommitQueueCapacity;
330 public Builder shardInitializationTimeout(long timeout, TimeUnit unit) {
331 datastoreContext.shardInitializationTimeout = new Timeout(timeout, unit);
335 public Builder shardInitializationTimeoutInSeconds(long timeout) {
336 return shardInitializationTimeout(timeout, TimeUnit.SECONDS);
339 public Builder shardLeaderElectionTimeout(long timeout, TimeUnit unit) {
340 datastoreContext.shardLeaderElectionTimeout = new Timeout(timeout, unit);
344 public Builder shardLeaderElectionTimeoutInSeconds(long timeout) {
345 return shardLeaderElectionTimeout(timeout, TimeUnit.SECONDS);
348 public Builder configurationReader(AkkaConfigurationReader configurationReader){
349 datastoreContext.configurationReader = configurationReader;
353 public Builder persistent(boolean persistent){
354 datastoreContext.persistent = persistent;
358 public Builder shardIsolatedLeaderCheckIntervalInMillis(int shardIsolatedLeaderCheckIntervalInMillis) {
359 datastoreContext.setIsolatedLeaderCheckInterval(shardIsolatedLeaderCheckIntervalInMillis);
363 public Builder shardElectionTimeoutFactor(long shardElectionTimeoutFactor){
364 datastoreContext.setElectionTimeoutFactor(shardElectionTimeoutFactor);
368 public Builder transactionCreationInitialRateLimit(long initialRateLimit){
369 datastoreContext.transactionCreationInitialRateLimit = initialRateLimit;
373 public Builder dataStoreType(String dataStoreType){
374 datastoreContext.dataStoreType = dataStoreType;
375 datastoreContext.dataStoreMXBeanType = "Distributed" + WordUtils.capitalize(dataStoreType) + "Datastore";
379 public Builder shardBatchedModificationCount(int shardBatchedModificationCount) {
380 datastoreContext.shardBatchedModificationCount = shardBatchedModificationCount;
384 public Builder writeOnlyTransactionOptimizationsEnabled(boolean value) {
385 datastoreContext.writeOnlyTransactionOptimizationsEnabled = value;
389 public Builder shardCommitQueueExpiryTimeoutInMillis(long value) {
390 datastoreContext.shardCommitQueueExpiryTimeoutInMillis = value;
394 public Builder shardCommitQueueExpiryTimeoutInSeconds(long value) {
395 datastoreContext.shardCommitQueueExpiryTimeoutInMillis = TimeUnit.MILLISECONDS.convert(
396 value, TimeUnit.SECONDS);
400 public Builder transactionDebugContextEnabled(boolean value) {
401 datastoreContext.transactionDebugContextEnabled = value;
405 public Builder maxShardDataChangeExecutorPoolSize(int maxShardDataChangeExecutorPoolSize) {
406 this.maxShardDataChangeExecutorPoolSize = maxShardDataChangeExecutorPoolSize;
410 public Builder maxShardDataChangeExecutorQueueSize(int maxShardDataChangeExecutorQueueSize) {
411 this.maxShardDataChangeExecutorQueueSize = maxShardDataChangeExecutorQueueSize;
415 public Builder maxShardDataChangeListenerQueueSize(int maxShardDataChangeListenerQueueSize) {
416 this.maxShardDataChangeListenerQueueSize = maxShardDataChangeListenerQueueSize;
420 public Builder maxShardDataStoreExecutorQueueSize(int maxShardDataStoreExecutorQueueSize) {
421 this.maxShardDataStoreExecutorQueueSize = maxShardDataStoreExecutorQueueSize;
425 public DatastoreContext build() {
426 datastoreContext.dataStoreProperties = InMemoryDOMDataStoreConfigProperties.create(
427 maxShardDataChangeExecutorPoolSize, maxShardDataChangeExecutorQueueSize,
428 maxShardDataChangeListenerQueueSize, maxShardDataStoreExecutorQueueSize);
430 if(datastoreContext.dataStoreType != null) {
431 globalDatastoreTypes.add(datastoreContext.dataStoreType);
434 return datastoreContext;
437 public Builder customRaftPolicyImplementation(String customRaftPolicyImplementation) {
438 datastoreContext.setCustomRaftPolicyImplementation(customRaftPolicyImplementation);
442 public Builder shardSnapshotChunkSize(int shardSnapshotChunkSize) {
443 datastoreContext.setShardSnapshotChunkSize(shardSnapshotChunkSize);
447 public Builder shardPeerAddressResolver(PeerAddressResolver resolver) {
448 datastoreContext.setPeerAddressResolver(resolver);