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.annotations.VisibleForTesting;
13 import com.google.common.base.Preconditions;
14 import com.google.common.collect.Sets;
16 import java.util.concurrent.TimeUnit;
17 import org.apache.commons.lang3.text.WordUtils;
18 import org.opendaylight.controller.cluster.common.actor.AkkaConfigurationReader;
19 import org.opendaylight.controller.cluster.common.actor.FileAkkaConfigurationReader;
20 import org.opendaylight.controller.cluster.raft.ConfigParams;
21 import org.opendaylight.controller.cluster.raft.DefaultConfigParamsImpl;
22 import org.opendaylight.controller.cluster.raft.PeerAddressResolver;
23 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
24 import org.opendaylight.controller.md.sal.dom.store.impl.InMemoryDOMDataStoreConfigProperties;
25 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
26 import scala.concurrent.duration.Duration;
27 import scala.concurrent.duration.FiniteDuration;
30 * Contains contextual data for a data store.
32 * @author Thomas Pantelis
34 public class DatastoreContext {
35 public static final String METRICS_DOMAIN = "org.opendaylight.controller.cluster.datastore";
37 public static final Duration DEFAULT_SHARD_TRANSACTION_IDLE_TIMEOUT = Duration.create(10, TimeUnit.MINUTES);
38 public static final int DEFAULT_OPERATION_TIMEOUT_IN_MS = 5000;
39 public static final int DEFAULT_SHARD_TX_COMMIT_TIMEOUT_IN_SECONDS = 30;
40 public static final int DEFAULT_JOURNAL_RECOVERY_BATCH_SIZE = 1;
41 public static final int DEFAULT_SNAPSHOT_BATCH_COUNT = 20000;
42 public static final int DEFAULT_HEARTBEAT_INTERVAL_IN_MILLIS = 500;
43 public static final int DEFAULT_ISOLATED_LEADER_CHECK_INTERVAL_IN_MILLIS =
44 DEFAULT_HEARTBEAT_INTERVAL_IN_MILLIS * 10;
45 public static final int DEFAULT_SHARD_TX_COMMIT_QUEUE_CAPACITY = 50000;
46 public static final Timeout DEFAULT_SHARD_INITIALIZATION_TIMEOUT = new Timeout(5, TimeUnit.MINUTES);
47 public static final Timeout DEFAULT_SHARD_LEADER_ELECTION_TIMEOUT = new Timeout(30, TimeUnit.SECONDS);
48 public static final boolean DEFAULT_PERSISTENT = true;
49 public static final FileAkkaConfigurationReader DEFAULT_CONFIGURATION_READER = new FileAkkaConfigurationReader();
50 public static final int DEFAULT_SHARD_SNAPSHOT_DATA_THRESHOLD_PERCENTAGE = 12;
51 public static final int DEFAULT_SHARD_ELECTION_TIMEOUT_FACTOR = 2;
52 public static final int DEFAULT_TX_CREATION_INITIAL_RATE_LIMIT = 100;
53 public static final String UNKNOWN_DATA_STORE_TYPE = "unknown";
54 public static final int DEFAULT_SHARD_BATCHED_MODIFICATION_COUNT = 1000;
55 public static final long DEFAULT_SHARD_COMMIT_QUEUE_EXPIRY_TIMEOUT_IN_MS =
56 TimeUnit.MILLISECONDS.convert(2, TimeUnit.MINUTES);
57 public static final int DEFAULT_SHARD_SNAPSHOT_CHUNK_SIZE = 2048000;
59 private static final Set<String> GLOBAL_DATASTORE_NAMES = Sets.newConcurrentHashSet();
61 private InMemoryDOMDataStoreConfigProperties dataStoreProperties;
62 private Duration shardTransactionIdleTimeout = DatastoreContext.DEFAULT_SHARD_TRANSACTION_IDLE_TIMEOUT;
63 private long operationTimeoutInMillis = DEFAULT_OPERATION_TIMEOUT_IN_MS;
64 private String dataStoreMXBeanType;
65 private int shardTransactionCommitTimeoutInSeconds = DEFAULT_SHARD_TX_COMMIT_TIMEOUT_IN_SECONDS;
66 private int shardTransactionCommitQueueCapacity = DEFAULT_SHARD_TX_COMMIT_QUEUE_CAPACITY;
67 private Timeout shardInitializationTimeout = DEFAULT_SHARD_INITIALIZATION_TIMEOUT;
68 private Timeout shardLeaderElectionTimeout = DEFAULT_SHARD_LEADER_ELECTION_TIMEOUT;
69 private boolean persistent = DEFAULT_PERSISTENT;
70 private AkkaConfigurationReader configurationReader = DEFAULT_CONFIGURATION_READER;
71 private long transactionCreationInitialRateLimit = DEFAULT_TX_CREATION_INITIAL_RATE_LIMIT;
72 private final DefaultConfigParamsImpl raftConfig = new DefaultConfigParamsImpl();
73 private String dataStoreName = UNKNOWN_DATA_STORE_TYPE;
74 private LogicalDatastoreType logicalStoreType = LogicalDatastoreType.OPERATIONAL;
75 private YangInstanceIdentifier storeRoot = YangInstanceIdentifier.EMPTY;
76 private int shardBatchedModificationCount = DEFAULT_SHARD_BATCHED_MODIFICATION_COUNT;
77 private boolean writeOnlyTransactionOptimizationsEnabled = true;
78 private long shardCommitQueueExpiryTimeoutInMillis = DEFAULT_SHARD_COMMIT_QUEUE_EXPIRY_TIMEOUT_IN_MS;
79 private boolean useTellBasedProtocol = false;
80 private boolean transactionDebugContextEnabled = false;
81 private String shardManagerPersistenceId;
83 public static Set<String> getGlobalDatastoreNames() {
84 return GLOBAL_DATASTORE_NAMES;
87 private DatastoreContext() {
88 setShardJournalRecoveryLogBatchSize(DEFAULT_JOURNAL_RECOVERY_BATCH_SIZE);
89 setSnapshotBatchCount(DEFAULT_SNAPSHOT_BATCH_COUNT);
90 setHeartbeatInterval(DEFAULT_HEARTBEAT_INTERVAL_IN_MILLIS);
91 setIsolatedLeaderCheckInterval(DEFAULT_ISOLATED_LEADER_CHECK_INTERVAL_IN_MILLIS);
92 setSnapshotDataThresholdPercentage(DEFAULT_SHARD_SNAPSHOT_DATA_THRESHOLD_PERCENTAGE);
93 setElectionTimeoutFactor(DEFAULT_SHARD_ELECTION_TIMEOUT_FACTOR);
94 setShardSnapshotChunkSize(DEFAULT_SHARD_SNAPSHOT_CHUNK_SIZE);
97 private DatastoreContext(final DatastoreContext other) {
98 this.dataStoreProperties = other.dataStoreProperties;
99 this.shardTransactionIdleTimeout = other.shardTransactionIdleTimeout;
100 this.operationTimeoutInMillis = other.operationTimeoutInMillis;
101 this.dataStoreMXBeanType = other.dataStoreMXBeanType;
102 this.shardTransactionCommitTimeoutInSeconds = other.shardTransactionCommitTimeoutInSeconds;
103 this.shardTransactionCommitQueueCapacity = other.shardTransactionCommitQueueCapacity;
104 this.shardInitializationTimeout = other.shardInitializationTimeout;
105 this.shardLeaderElectionTimeout = other.shardLeaderElectionTimeout;
106 this.persistent = other.persistent;
107 this.configurationReader = other.configurationReader;
108 this.transactionCreationInitialRateLimit = other.transactionCreationInitialRateLimit;
109 this.dataStoreName = other.dataStoreName;
110 this.logicalStoreType = other.logicalStoreType;
111 this.storeRoot = other.storeRoot;
112 this.shardBatchedModificationCount = other.shardBatchedModificationCount;
113 this.writeOnlyTransactionOptimizationsEnabled = other.writeOnlyTransactionOptimizationsEnabled;
114 this.shardCommitQueueExpiryTimeoutInMillis = other.shardCommitQueueExpiryTimeoutInMillis;
115 this.transactionDebugContextEnabled = other.transactionDebugContextEnabled;
116 this.shardManagerPersistenceId = other.shardManagerPersistenceId;
117 this.useTellBasedProtocol = other.useTellBasedProtocol;
119 setShardJournalRecoveryLogBatchSize(other.raftConfig.getJournalRecoveryLogBatchSize());
120 setSnapshotBatchCount(other.raftConfig.getSnapshotBatchCount());
121 setHeartbeatInterval(other.raftConfig.getHeartBeatInterval().toMillis());
122 setIsolatedLeaderCheckInterval(other.raftConfig.getIsolatedCheckIntervalInMillis());
123 setSnapshotDataThresholdPercentage(other.raftConfig.getSnapshotDataThresholdPercentage());
124 setElectionTimeoutFactor(other.raftConfig.getElectionTimeoutFactor());
125 setCustomRaftPolicyImplementation(other.raftConfig.getCustomRaftPolicyImplementationClass());
126 setShardSnapshotChunkSize(other.raftConfig.getSnapshotChunkSize());
127 setPeerAddressResolver(other.raftConfig.getPeerAddressResolver());
130 public static Builder newBuilder() {
131 return new Builder(new DatastoreContext());
134 public static Builder newBuilderFrom(DatastoreContext context) {
135 return new Builder(new DatastoreContext(context));
138 public InMemoryDOMDataStoreConfigProperties getDataStoreProperties() {
139 return dataStoreProperties;
142 public Duration getShardTransactionIdleTimeout() {
143 return shardTransactionIdleTimeout;
146 public String getDataStoreMXBeanType() {
147 return dataStoreMXBeanType;
150 public long getOperationTimeoutInMillis() {
151 return operationTimeoutInMillis;
154 public ConfigParams getShardRaftConfig() {
158 public int getShardTransactionCommitTimeoutInSeconds() {
159 return shardTransactionCommitTimeoutInSeconds;
162 public int getShardTransactionCommitQueueCapacity() {
163 return shardTransactionCommitQueueCapacity;
166 public Timeout getShardInitializationTimeout() {
167 return shardInitializationTimeout;
170 public Timeout getShardLeaderElectionTimeout() {
171 return shardLeaderElectionTimeout;
174 public boolean isPersistent() {
178 public AkkaConfigurationReader getConfigurationReader() {
179 return configurationReader;
182 public long getShardElectionTimeoutFactor() {
183 return raftConfig.getElectionTimeoutFactor();
186 public String getDataStoreName() {
187 return dataStoreName;
190 public LogicalDatastoreType getLogicalStoreType() {
191 return logicalStoreType;
194 public YangInstanceIdentifier getStoreRoot() {
198 public long getTransactionCreationInitialRateLimit() {
199 return transactionCreationInitialRateLimit;
202 public String getShardManagerPersistenceId() {
203 return shardManagerPersistenceId;
206 private void setPeerAddressResolver(PeerAddressResolver resolver) {
207 raftConfig.setPeerAddressResolver(resolver);
210 private void setHeartbeatInterval(long shardHeartbeatIntervalInMillis) {
211 raftConfig.setHeartBeatInterval(new FiniteDuration(shardHeartbeatIntervalInMillis,
212 TimeUnit.MILLISECONDS));
215 private void setShardJournalRecoveryLogBatchSize(int shardJournalRecoveryLogBatchSize) {
216 raftConfig.setJournalRecoveryLogBatchSize(shardJournalRecoveryLogBatchSize);
220 private void setIsolatedLeaderCheckInterval(long shardIsolatedLeaderCheckIntervalInMillis) {
221 raftConfig.setIsolatedLeaderCheckInterval(
222 new FiniteDuration(shardIsolatedLeaderCheckIntervalInMillis, TimeUnit.MILLISECONDS));
225 private void setElectionTimeoutFactor(long shardElectionTimeoutFactor) {
226 raftConfig.setElectionTimeoutFactor(shardElectionTimeoutFactor);
229 private void setCustomRaftPolicyImplementation(String customRaftPolicyImplementation) {
230 raftConfig.setCustomRaftPolicyImplementationClass(customRaftPolicyImplementation);
233 private void setSnapshotDataThresholdPercentage(int shardSnapshotDataThresholdPercentage) {
234 Preconditions.checkArgument(shardSnapshotDataThresholdPercentage >= 0
235 && shardSnapshotDataThresholdPercentage <= 100);
236 raftConfig.setSnapshotDataThresholdPercentage(shardSnapshotDataThresholdPercentage);
239 private void setSnapshotBatchCount(long shardSnapshotBatchCount) {
240 raftConfig.setSnapshotBatchCount(shardSnapshotBatchCount);
243 private void setShardSnapshotChunkSize(int shardSnapshotChunkSize) {
244 raftConfig.setSnapshotChunkSize(shardSnapshotChunkSize);
247 public int getShardBatchedModificationCount() {
248 return shardBatchedModificationCount;
251 public boolean isWriteOnlyTransactionOptimizationsEnabled() {
252 return writeOnlyTransactionOptimizationsEnabled;
255 public long getShardCommitQueueExpiryTimeoutInMillis() {
256 return shardCommitQueueExpiryTimeoutInMillis;
259 public boolean isTransactionDebugContextEnabled() {
260 return transactionDebugContextEnabled;
263 public boolean isUseTellBasedProtocol() {
264 return useTellBasedProtocol;
267 public int getShardSnapshotChunkSize() {
268 return raftConfig.getSnapshotChunkSize();
271 public static class Builder {
272 private final DatastoreContext datastoreContext;
273 private int maxShardDataChangeExecutorPoolSize =
274 InMemoryDOMDataStoreConfigProperties.DEFAULT_MAX_DATA_CHANGE_EXECUTOR_POOL_SIZE;
275 private int maxShardDataChangeExecutorQueueSize =
276 InMemoryDOMDataStoreConfigProperties.DEFAULT_MAX_DATA_CHANGE_EXECUTOR_QUEUE_SIZE;
277 private int maxShardDataChangeListenerQueueSize =
278 InMemoryDOMDataStoreConfigProperties.DEFAULT_MAX_DATA_CHANGE_LISTENER_QUEUE_SIZE;
279 private int maxShardDataStoreExecutorQueueSize =
280 InMemoryDOMDataStoreConfigProperties.DEFAULT_MAX_DATA_STORE_EXECUTOR_QUEUE_SIZE;
282 private Builder(DatastoreContext datastoreContext) {
283 this.datastoreContext = datastoreContext;
285 if (datastoreContext.getDataStoreProperties() != null) {
286 maxShardDataChangeExecutorPoolSize =
287 datastoreContext.getDataStoreProperties().getMaxDataChangeExecutorPoolSize();
288 maxShardDataChangeExecutorQueueSize =
289 datastoreContext.getDataStoreProperties().getMaxDataChangeExecutorQueueSize();
290 maxShardDataChangeListenerQueueSize =
291 datastoreContext.getDataStoreProperties().getMaxDataChangeListenerQueueSize();
292 maxShardDataStoreExecutorQueueSize =
293 datastoreContext.getDataStoreProperties().getMaxDataStoreExecutorQueueSize();
297 public Builder boundedMailboxCapacity(int boundedMailboxCapacity) {
298 // TODO - this is defined in the yang DataStoreProperties but not currently used.
302 public Builder enableMetricCapture(boolean enableMetricCapture) {
303 // TODO - this is defined in the yang DataStoreProperties but not currently used.
308 public Builder shardTransactionIdleTimeout(long timeout, TimeUnit unit) {
309 datastoreContext.shardTransactionIdleTimeout = Duration.create(timeout, unit);
313 public Builder shardTransactionIdleTimeoutInMinutes(long timeout) {
314 return shardTransactionIdleTimeout(timeout, TimeUnit.MINUTES);
317 public Builder operationTimeoutInSeconds(int operationTimeoutInSeconds) {
318 datastoreContext.operationTimeoutInMillis = TimeUnit.SECONDS.toMillis(operationTimeoutInSeconds);
322 public Builder operationTimeoutInMillis(long operationTimeoutInMillis) {
323 datastoreContext.operationTimeoutInMillis = operationTimeoutInMillis;
327 public Builder dataStoreMXBeanType(String dataStoreMXBeanType) {
328 datastoreContext.dataStoreMXBeanType = dataStoreMXBeanType;
332 public Builder shardTransactionCommitTimeoutInSeconds(int shardTransactionCommitTimeoutInSeconds) {
333 datastoreContext.shardTransactionCommitTimeoutInSeconds = shardTransactionCommitTimeoutInSeconds;
337 public Builder shardJournalRecoveryLogBatchSize(int shardJournalRecoveryLogBatchSize) {
338 datastoreContext.setShardJournalRecoveryLogBatchSize(shardJournalRecoveryLogBatchSize);
342 public Builder shardSnapshotBatchCount(int shardSnapshotBatchCount) {
343 datastoreContext.setSnapshotBatchCount(shardSnapshotBatchCount);
347 public Builder shardSnapshotDataThresholdPercentage(int shardSnapshotDataThresholdPercentage) {
348 datastoreContext.setSnapshotDataThresholdPercentage(shardSnapshotDataThresholdPercentage);
352 public Builder shardHeartbeatIntervalInMillis(int shardHeartbeatIntervalInMillis) {
353 datastoreContext.setHeartbeatInterval(shardHeartbeatIntervalInMillis);
357 public Builder shardTransactionCommitQueueCapacity(int shardTransactionCommitQueueCapacity) {
358 datastoreContext.shardTransactionCommitQueueCapacity = shardTransactionCommitQueueCapacity;
362 public Builder shardInitializationTimeout(long timeout, TimeUnit unit) {
363 datastoreContext.shardInitializationTimeout = new Timeout(timeout, unit);
367 public Builder shardInitializationTimeoutInSeconds(long timeout) {
368 return shardInitializationTimeout(timeout, TimeUnit.SECONDS);
371 public Builder shardLeaderElectionTimeout(long timeout, TimeUnit unit) {
372 datastoreContext.shardLeaderElectionTimeout = new Timeout(timeout, unit);
376 public Builder shardLeaderElectionTimeoutInSeconds(long timeout) {
377 return shardLeaderElectionTimeout(timeout, TimeUnit.SECONDS);
380 public Builder configurationReader(AkkaConfigurationReader configurationReader) {
381 datastoreContext.configurationReader = configurationReader;
385 public Builder persistent(boolean persistent) {
386 datastoreContext.persistent = persistent;
390 public Builder shardIsolatedLeaderCheckIntervalInMillis(int shardIsolatedLeaderCheckIntervalInMillis) {
391 datastoreContext.setIsolatedLeaderCheckInterval(shardIsolatedLeaderCheckIntervalInMillis);
395 public Builder shardElectionTimeoutFactor(long shardElectionTimeoutFactor) {
396 datastoreContext.setElectionTimeoutFactor(shardElectionTimeoutFactor);
400 public Builder transactionCreationInitialRateLimit(long initialRateLimit) {
401 datastoreContext.transactionCreationInitialRateLimit = initialRateLimit;
405 public Builder logicalStoreType(LogicalDatastoreType logicalStoreType) {
406 datastoreContext.logicalStoreType = Preconditions.checkNotNull(logicalStoreType);
408 // Retain compatible naming
409 switch (logicalStoreType) {
411 dataStoreName("config");
414 dataStoreName("operational");
417 dataStoreName(logicalStoreType.name());
423 public Builder storeRoot(final YangInstanceIdentifier storeRoot) {
424 datastoreContext.storeRoot = storeRoot;
428 public Builder dataStoreName(String dataStoreName) {
429 datastoreContext.dataStoreName = Preconditions.checkNotNull(dataStoreName);
430 datastoreContext.dataStoreMXBeanType = "Distributed" + WordUtils.capitalize(dataStoreName) + "Datastore";
434 public Builder shardBatchedModificationCount(final int shardBatchedModificationCount) {
435 datastoreContext.shardBatchedModificationCount = shardBatchedModificationCount;
439 public Builder writeOnlyTransactionOptimizationsEnabled(boolean value) {
440 datastoreContext.writeOnlyTransactionOptimizationsEnabled = value;
444 public Builder shardCommitQueueExpiryTimeoutInMillis(long value) {
445 datastoreContext.shardCommitQueueExpiryTimeoutInMillis = value;
449 public Builder shardCommitQueueExpiryTimeoutInSeconds(long value) {
450 datastoreContext.shardCommitQueueExpiryTimeoutInMillis = TimeUnit.MILLISECONDS.convert(
451 value, TimeUnit.SECONDS);
455 public Builder transactionDebugContextEnabled(boolean value) {
456 datastoreContext.transactionDebugContextEnabled = value;
460 public Builder maxShardDataChangeExecutorPoolSize(int maxShardDataChangeExecutorPoolSize) {
461 this.maxShardDataChangeExecutorPoolSize = maxShardDataChangeExecutorPoolSize;
465 public Builder maxShardDataChangeExecutorQueueSize(int maxShardDataChangeExecutorQueueSize) {
466 this.maxShardDataChangeExecutorQueueSize = maxShardDataChangeExecutorQueueSize;
470 public Builder maxShardDataChangeListenerQueueSize(int maxShardDataChangeListenerQueueSize) {
471 this.maxShardDataChangeListenerQueueSize = maxShardDataChangeListenerQueueSize;
475 public Builder maxShardDataStoreExecutorQueueSize(int maxShardDataStoreExecutorQueueSize) {
476 this.maxShardDataStoreExecutorQueueSize = maxShardDataStoreExecutorQueueSize;
480 public Builder useTellBasedProtocol(boolean value) {
481 datastoreContext.useTellBasedProtocol = value;
486 * For unit tests only.
489 public Builder shardManagerPersistenceId(String id) {
490 datastoreContext.shardManagerPersistenceId = id;
494 public DatastoreContext build() {
495 datastoreContext.dataStoreProperties = InMemoryDOMDataStoreConfigProperties.create(
496 maxShardDataChangeExecutorPoolSize, maxShardDataChangeExecutorQueueSize,
497 maxShardDataChangeListenerQueueSize, maxShardDataStoreExecutorQueueSize);
499 if (datastoreContext.dataStoreName != null) {
500 GLOBAL_DATASTORE_NAMES.add(datastoreContext.dataStoreName);
503 return datastoreContext;
506 public Builder customRaftPolicyImplementation(String customRaftPolicyImplementation) {
507 datastoreContext.setCustomRaftPolicyImplementation(customRaftPolicyImplementation);
511 public Builder shardSnapshotChunkSize(int shardSnapshotChunkSize) {
512 datastoreContext.setShardSnapshotChunkSize(shardSnapshotChunkSize);
516 public Builder shardPeerAddressResolver(PeerAddressResolver resolver) {
517 datastoreContext.setPeerAddressResolver(resolver);