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());
128 setTempFileDirectory(other.getTempFileDirectory());
129 setFileBackedStreamingThreshold(other.getFileBackedStreamingThreshold());
132 public static Builder newBuilder() {
133 return new Builder(new DatastoreContext());
136 public static Builder newBuilderFrom(DatastoreContext context) {
137 return new Builder(new DatastoreContext(context));
140 public InMemoryDOMDataStoreConfigProperties getDataStoreProperties() {
141 return dataStoreProperties;
144 public Duration getShardTransactionIdleTimeout() {
145 return shardTransactionIdleTimeout;
148 public String getDataStoreMXBeanType() {
149 return dataStoreMXBeanType;
152 public long getOperationTimeoutInMillis() {
153 return operationTimeoutInMillis;
156 public ConfigParams getShardRaftConfig() {
160 public int getShardTransactionCommitTimeoutInSeconds() {
161 return shardTransactionCommitTimeoutInSeconds;
164 public int getShardTransactionCommitQueueCapacity() {
165 return shardTransactionCommitQueueCapacity;
168 public Timeout getShardInitializationTimeout() {
169 return shardInitializationTimeout;
172 public Timeout getShardLeaderElectionTimeout() {
173 return shardLeaderElectionTimeout;
176 public boolean isPersistent() {
180 public AkkaConfigurationReader getConfigurationReader() {
181 return configurationReader;
184 public long getShardElectionTimeoutFactor() {
185 return raftConfig.getElectionTimeoutFactor();
188 public String getDataStoreName() {
189 return dataStoreName;
192 public LogicalDatastoreType getLogicalStoreType() {
193 return logicalStoreType;
196 public YangInstanceIdentifier getStoreRoot() {
200 public long getTransactionCreationInitialRateLimit() {
201 return transactionCreationInitialRateLimit;
204 public String getShardManagerPersistenceId() {
205 return shardManagerPersistenceId;
208 public String getTempFileDirectory() {
209 return raftConfig.getTempFileDirectory();
212 private void setTempFileDirectory(String tempFileDirectory) {
213 raftConfig.setTempFileDirectory(tempFileDirectory);
216 public int getFileBackedStreamingThreshold() {
217 return raftConfig.getFileBackedStreamingThreshold();
220 private void setFileBackedStreamingThreshold(int fileBackedStreamingThreshold) {
221 raftConfig.setFileBackedStreamingThreshold(fileBackedStreamingThreshold);
224 private void setPeerAddressResolver(PeerAddressResolver resolver) {
225 raftConfig.setPeerAddressResolver(resolver);
228 private void setHeartbeatInterval(long shardHeartbeatIntervalInMillis) {
229 raftConfig.setHeartBeatInterval(new FiniteDuration(shardHeartbeatIntervalInMillis,
230 TimeUnit.MILLISECONDS));
233 private void setShardJournalRecoveryLogBatchSize(int shardJournalRecoveryLogBatchSize) {
234 raftConfig.setJournalRecoveryLogBatchSize(shardJournalRecoveryLogBatchSize);
238 private void setIsolatedLeaderCheckInterval(long shardIsolatedLeaderCheckIntervalInMillis) {
239 raftConfig.setIsolatedLeaderCheckInterval(
240 new FiniteDuration(shardIsolatedLeaderCheckIntervalInMillis, TimeUnit.MILLISECONDS));
243 private void setElectionTimeoutFactor(long shardElectionTimeoutFactor) {
244 raftConfig.setElectionTimeoutFactor(shardElectionTimeoutFactor);
247 private void setCustomRaftPolicyImplementation(String customRaftPolicyImplementation) {
248 raftConfig.setCustomRaftPolicyImplementationClass(customRaftPolicyImplementation);
251 private void setSnapshotDataThresholdPercentage(int shardSnapshotDataThresholdPercentage) {
252 Preconditions.checkArgument(shardSnapshotDataThresholdPercentage >= 0
253 && shardSnapshotDataThresholdPercentage <= 100);
254 raftConfig.setSnapshotDataThresholdPercentage(shardSnapshotDataThresholdPercentage);
257 private void setSnapshotBatchCount(long shardSnapshotBatchCount) {
258 raftConfig.setSnapshotBatchCount(shardSnapshotBatchCount);
261 private void setShardSnapshotChunkSize(int shardSnapshotChunkSize) {
262 raftConfig.setSnapshotChunkSize(shardSnapshotChunkSize);
265 public int getShardBatchedModificationCount() {
266 return shardBatchedModificationCount;
269 public boolean isWriteOnlyTransactionOptimizationsEnabled() {
270 return writeOnlyTransactionOptimizationsEnabled;
273 public long getShardCommitQueueExpiryTimeoutInMillis() {
274 return shardCommitQueueExpiryTimeoutInMillis;
277 public boolean isTransactionDebugContextEnabled() {
278 return transactionDebugContextEnabled;
281 public boolean isUseTellBasedProtocol() {
282 return useTellBasedProtocol;
285 public int getShardSnapshotChunkSize() {
286 return raftConfig.getSnapshotChunkSize();
289 public static class Builder {
290 private final DatastoreContext datastoreContext;
291 private int maxShardDataChangeExecutorPoolSize =
292 InMemoryDOMDataStoreConfigProperties.DEFAULT_MAX_DATA_CHANGE_EXECUTOR_POOL_SIZE;
293 private int maxShardDataChangeExecutorQueueSize =
294 InMemoryDOMDataStoreConfigProperties.DEFAULT_MAX_DATA_CHANGE_EXECUTOR_QUEUE_SIZE;
295 private int maxShardDataChangeListenerQueueSize =
296 InMemoryDOMDataStoreConfigProperties.DEFAULT_MAX_DATA_CHANGE_LISTENER_QUEUE_SIZE;
297 private int maxShardDataStoreExecutorQueueSize =
298 InMemoryDOMDataStoreConfigProperties.DEFAULT_MAX_DATA_STORE_EXECUTOR_QUEUE_SIZE;
300 private Builder(DatastoreContext datastoreContext) {
301 this.datastoreContext = datastoreContext;
303 if (datastoreContext.getDataStoreProperties() != null) {
304 maxShardDataChangeExecutorPoolSize =
305 datastoreContext.getDataStoreProperties().getMaxDataChangeExecutorPoolSize();
306 maxShardDataChangeExecutorQueueSize =
307 datastoreContext.getDataStoreProperties().getMaxDataChangeExecutorQueueSize();
308 maxShardDataChangeListenerQueueSize =
309 datastoreContext.getDataStoreProperties().getMaxDataChangeListenerQueueSize();
310 maxShardDataStoreExecutorQueueSize =
311 datastoreContext.getDataStoreProperties().getMaxDataStoreExecutorQueueSize();
315 public Builder boundedMailboxCapacity(int boundedMailboxCapacity) {
316 // TODO - this is defined in the yang DataStoreProperties but not currently used.
320 public Builder enableMetricCapture(boolean enableMetricCapture) {
321 // TODO - this is defined in the yang DataStoreProperties but not currently used.
326 public Builder shardTransactionIdleTimeout(long timeout, TimeUnit unit) {
327 datastoreContext.shardTransactionIdleTimeout = Duration.create(timeout, unit);
331 public Builder shardTransactionIdleTimeoutInMinutes(long timeout) {
332 return shardTransactionIdleTimeout(timeout, TimeUnit.MINUTES);
335 public Builder operationTimeoutInSeconds(int operationTimeoutInSeconds) {
336 datastoreContext.operationTimeoutInMillis = TimeUnit.SECONDS.toMillis(operationTimeoutInSeconds);
340 public Builder operationTimeoutInMillis(long operationTimeoutInMillis) {
341 datastoreContext.operationTimeoutInMillis = operationTimeoutInMillis;
345 public Builder dataStoreMXBeanType(String dataStoreMXBeanType) {
346 datastoreContext.dataStoreMXBeanType = dataStoreMXBeanType;
350 public Builder shardTransactionCommitTimeoutInSeconds(int shardTransactionCommitTimeoutInSeconds) {
351 datastoreContext.shardTransactionCommitTimeoutInSeconds = shardTransactionCommitTimeoutInSeconds;
355 public Builder shardJournalRecoveryLogBatchSize(int shardJournalRecoveryLogBatchSize) {
356 datastoreContext.setShardJournalRecoveryLogBatchSize(shardJournalRecoveryLogBatchSize);
360 public Builder shardSnapshotBatchCount(int shardSnapshotBatchCount) {
361 datastoreContext.setSnapshotBatchCount(shardSnapshotBatchCount);
365 public Builder shardSnapshotDataThresholdPercentage(int shardSnapshotDataThresholdPercentage) {
366 datastoreContext.setSnapshotDataThresholdPercentage(shardSnapshotDataThresholdPercentage);
370 public Builder shardHeartbeatIntervalInMillis(int shardHeartbeatIntervalInMillis) {
371 datastoreContext.setHeartbeatInterval(shardHeartbeatIntervalInMillis);
375 public Builder shardTransactionCommitQueueCapacity(int shardTransactionCommitQueueCapacity) {
376 datastoreContext.shardTransactionCommitQueueCapacity = shardTransactionCommitQueueCapacity;
380 public Builder shardInitializationTimeout(long timeout, TimeUnit unit) {
381 datastoreContext.shardInitializationTimeout = new Timeout(timeout, unit);
385 public Builder shardInitializationTimeoutInSeconds(long timeout) {
386 return shardInitializationTimeout(timeout, TimeUnit.SECONDS);
389 public Builder shardLeaderElectionTimeout(long timeout, TimeUnit unit) {
390 datastoreContext.shardLeaderElectionTimeout = new Timeout(timeout, unit);
394 public Builder shardLeaderElectionTimeoutInSeconds(long timeout) {
395 return shardLeaderElectionTimeout(timeout, TimeUnit.SECONDS);
398 public Builder configurationReader(AkkaConfigurationReader configurationReader) {
399 datastoreContext.configurationReader = configurationReader;
403 public Builder persistent(boolean persistent) {
404 datastoreContext.persistent = persistent;
408 public Builder shardIsolatedLeaderCheckIntervalInMillis(int shardIsolatedLeaderCheckIntervalInMillis) {
409 datastoreContext.setIsolatedLeaderCheckInterval(shardIsolatedLeaderCheckIntervalInMillis);
413 public Builder shardElectionTimeoutFactor(long shardElectionTimeoutFactor) {
414 datastoreContext.setElectionTimeoutFactor(shardElectionTimeoutFactor);
418 public Builder transactionCreationInitialRateLimit(long initialRateLimit) {
419 datastoreContext.transactionCreationInitialRateLimit = initialRateLimit;
423 public Builder logicalStoreType(LogicalDatastoreType logicalStoreType) {
424 datastoreContext.logicalStoreType = Preconditions.checkNotNull(logicalStoreType);
426 // Retain compatible naming
427 switch (logicalStoreType) {
429 dataStoreName("config");
432 dataStoreName("operational");
435 dataStoreName(logicalStoreType.name());
441 public Builder storeRoot(final YangInstanceIdentifier storeRoot) {
442 datastoreContext.storeRoot = storeRoot;
446 public Builder dataStoreName(String dataStoreName) {
447 datastoreContext.dataStoreName = Preconditions.checkNotNull(dataStoreName);
448 datastoreContext.dataStoreMXBeanType = "Distributed" + WordUtils.capitalize(dataStoreName) + "Datastore";
452 public Builder shardBatchedModificationCount(final int shardBatchedModificationCount) {
453 datastoreContext.shardBatchedModificationCount = shardBatchedModificationCount;
457 public Builder writeOnlyTransactionOptimizationsEnabled(boolean value) {
458 datastoreContext.writeOnlyTransactionOptimizationsEnabled = value;
462 public Builder shardCommitQueueExpiryTimeoutInMillis(long value) {
463 datastoreContext.shardCommitQueueExpiryTimeoutInMillis = value;
467 public Builder shardCommitQueueExpiryTimeoutInSeconds(long value) {
468 datastoreContext.shardCommitQueueExpiryTimeoutInMillis = TimeUnit.MILLISECONDS.convert(
469 value, TimeUnit.SECONDS);
473 public Builder transactionDebugContextEnabled(boolean value) {
474 datastoreContext.transactionDebugContextEnabled = value;
478 public Builder maxShardDataChangeExecutorPoolSize(int maxShardDataChangeExecutorPoolSize) {
479 this.maxShardDataChangeExecutorPoolSize = maxShardDataChangeExecutorPoolSize;
483 public Builder maxShardDataChangeExecutorQueueSize(int maxShardDataChangeExecutorQueueSize) {
484 this.maxShardDataChangeExecutorQueueSize = maxShardDataChangeExecutorQueueSize;
488 public Builder maxShardDataChangeListenerQueueSize(int maxShardDataChangeListenerQueueSize) {
489 this.maxShardDataChangeListenerQueueSize = maxShardDataChangeListenerQueueSize;
493 public Builder maxShardDataStoreExecutorQueueSize(int maxShardDataStoreExecutorQueueSize) {
494 this.maxShardDataStoreExecutorQueueSize = maxShardDataStoreExecutorQueueSize;
498 public Builder useTellBasedProtocol(boolean value) {
499 datastoreContext.useTellBasedProtocol = value;
504 * For unit tests only.
507 public Builder shardManagerPersistenceId(String id) {
508 datastoreContext.shardManagerPersistenceId = id;
512 public DatastoreContext build() {
513 datastoreContext.dataStoreProperties = InMemoryDOMDataStoreConfigProperties.create(
514 maxShardDataChangeExecutorPoolSize, maxShardDataChangeExecutorQueueSize,
515 maxShardDataChangeListenerQueueSize, maxShardDataStoreExecutorQueueSize);
517 if (datastoreContext.dataStoreName != null) {
518 GLOBAL_DATASTORE_NAMES.add(datastoreContext.dataStoreName);
521 return datastoreContext;
524 public Builder customRaftPolicyImplementation(String customRaftPolicyImplementation) {
525 datastoreContext.setCustomRaftPolicyImplementation(customRaftPolicyImplementation);
529 public Builder shardSnapshotChunkSize(int shardSnapshotChunkSize) {
530 datastoreContext.setShardSnapshotChunkSize(shardSnapshotChunkSize);
534 public Builder shardPeerAddressResolver(PeerAddressResolver resolver) {
535 datastoreContext.setPeerAddressResolver(resolver);
539 public Builder tempFileDirectory(String tempFileDirectory) {
540 datastoreContext.setTempFileDirectory(tempFileDirectory);
544 public Builder fileBackedStreamingThresholdInMegabytes(int fileBackedStreamingThreshold) {
545 datastoreContext.setFileBackedStreamingThreshold(fileBackedStreamingThreshold * ConfigParams.MEGABYTE);