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 scala.concurrent.duration.Duration;
26 import scala.concurrent.duration.FiniteDuration;
29 * Contains contextual data for a data store.
31 * @author Thomas Pantelis
33 public class DatastoreContext {
34 public static final String METRICS_DOMAIN = "org.opendaylight.controller.cluster.datastore";
36 public static final Duration DEFAULT_SHARD_TRANSACTION_IDLE_TIMEOUT = Duration.create(10, TimeUnit.MINUTES);
37 public static final int DEFAULT_OPERATION_TIMEOUT_IN_MS = 5000;
38 public static final int DEFAULT_SHARD_TX_COMMIT_TIMEOUT_IN_SECONDS = 30;
39 public static final int DEFAULT_JOURNAL_RECOVERY_BATCH_SIZE = 1000;
40 public static final int DEFAULT_SNAPSHOT_BATCH_COUNT = 20000;
41 public static final int DEFAULT_HEARTBEAT_INTERVAL_IN_MILLIS = 500;
42 public static final int DEFAULT_ISOLATED_LEADER_CHECK_INTERVAL_IN_MILLIS = DEFAULT_HEARTBEAT_INTERVAL_IN_MILLIS * 10;
43 public static final int DEFAULT_SHARD_TX_COMMIT_QUEUE_CAPACITY = 50000;
44 public static final Timeout DEFAULT_SHARD_INITIALIZATION_TIMEOUT = new Timeout(5, TimeUnit.MINUTES);
45 public static final Timeout DEFAULT_SHARD_LEADER_ELECTION_TIMEOUT = new Timeout(30, TimeUnit.SECONDS);
46 public static final boolean DEFAULT_PERSISTENT = true;
47 public static final FileAkkaConfigurationReader DEFAULT_CONFIGURATION_READER = new FileAkkaConfigurationReader();
48 public static final int DEFAULT_SHARD_SNAPSHOT_DATA_THRESHOLD_PERCENTAGE = 12;
49 public static final int DEFAULT_SHARD_ELECTION_TIMEOUT_FACTOR = 2;
50 public static final int DEFAULT_TX_CREATION_INITIAL_RATE_LIMIT = 100;
51 public static final String UNKNOWN_DATA_STORE_TYPE = "unknown";
52 public static final int DEFAULT_SHARD_BATCHED_MODIFICATION_COUNT = 1000;
53 public static final long DEFAULT_SHARD_COMMIT_QUEUE_EXPIRY_TIMEOUT_IN_MS = TimeUnit.MILLISECONDS.convert(2, TimeUnit.MINUTES);
54 public static final int DEFAULT_SHARD_SNAPSHOT_CHUNK_SIZE = 2048000;
56 private static final Set<String> globalDatastoreTypes = Sets.newConcurrentHashSet();
58 private InMemoryDOMDataStoreConfigProperties dataStoreProperties;
59 private Duration shardTransactionIdleTimeout = DatastoreContext.DEFAULT_SHARD_TRANSACTION_IDLE_TIMEOUT;
60 private long operationTimeoutInMillis = DEFAULT_OPERATION_TIMEOUT_IN_MS;
61 private String dataStoreMXBeanType;
62 private int shardTransactionCommitTimeoutInSeconds = DEFAULT_SHARD_TX_COMMIT_TIMEOUT_IN_SECONDS;
63 private int shardTransactionCommitQueueCapacity = DEFAULT_SHARD_TX_COMMIT_QUEUE_CAPACITY;
64 private Timeout shardInitializationTimeout = DEFAULT_SHARD_INITIALIZATION_TIMEOUT;
65 private Timeout shardLeaderElectionTimeout = DEFAULT_SHARD_LEADER_ELECTION_TIMEOUT;
66 private boolean persistent = DEFAULT_PERSISTENT;
67 private AkkaConfigurationReader configurationReader = DEFAULT_CONFIGURATION_READER;
68 private long transactionCreationInitialRateLimit = DEFAULT_TX_CREATION_INITIAL_RATE_LIMIT;
69 private final DefaultConfigParamsImpl raftConfig = new DefaultConfigParamsImpl();
70 private String dataStoreName = UNKNOWN_DATA_STORE_TYPE;
71 private LogicalDatastoreType logicalStoreType = LogicalDatastoreType.OPERATIONAL;
72 private int shardBatchedModificationCount = DEFAULT_SHARD_BATCHED_MODIFICATION_COUNT;
73 private boolean writeOnlyTransactionOptimizationsEnabled = true;
74 private long shardCommitQueueExpiryTimeoutInMillis = DEFAULT_SHARD_COMMIT_QUEUE_EXPIRY_TIMEOUT_IN_MS;
75 private boolean transactionDebugContextEnabled = false;
76 private String shardManagerPersistenceId;
78 public static Set<String> getGlobalDatastoreTypes() {
79 return globalDatastoreTypes;
82 private DatastoreContext() {
83 setShardJournalRecoveryLogBatchSize(DEFAULT_JOURNAL_RECOVERY_BATCH_SIZE);
84 setSnapshotBatchCount(DEFAULT_SNAPSHOT_BATCH_COUNT);
85 setHeartbeatInterval(DEFAULT_HEARTBEAT_INTERVAL_IN_MILLIS);
86 setIsolatedLeaderCheckInterval(DEFAULT_ISOLATED_LEADER_CHECK_INTERVAL_IN_MILLIS);
87 setSnapshotDataThresholdPercentage(DEFAULT_SHARD_SNAPSHOT_DATA_THRESHOLD_PERCENTAGE);
88 setElectionTimeoutFactor(DEFAULT_SHARD_ELECTION_TIMEOUT_FACTOR);
89 setShardSnapshotChunkSize(DEFAULT_SHARD_SNAPSHOT_CHUNK_SIZE);
92 private DatastoreContext(DatastoreContext other) {
93 this.dataStoreProperties = other.dataStoreProperties;
94 this.shardTransactionIdleTimeout = other.shardTransactionIdleTimeout;
95 this.operationTimeoutInMillis = other.operationTimeoutInMillis;
96 this.dataStoreMXBeanType = other.dataStoreMXBeanType;
97 this.shardTransactionCommitTimeoutInSeconds = other.shardTransactionCommitTimeoutInSeconds;
98 this.shardTransactionCommitQueueCapacity = other.shardTransactionCommitQueueCapacity;
99 this.shardInitializationTimeout = other.shardInitializationTimeout;
100 this.shardLeaderElectionTimeout = other.shardLeaderElectionTimeout;
101 this.persistent = other.persistent;
102 this.configurationReader = other.configurationReader;
103 this.transactionCreationInitialRateLimit = other.transactionCreationInitialRateLimit;
104 this.dataStoreName = other.dataStoreName;
105 this.logicalStoreType = other.logicalStoreType;
106 this.shardBatchedModificationCount = other.shardBatchedModificationCount;
107 this.writeOnlyTransactionOptimizationsEnabled = other.writeOnlyTransactionOptimizationsEnabled;
108 this.shardCommitQueueExpiryTimeoutInMillis = other.shardCommitQueueExpiryTimeoutInMillis;
109 this.transactionDebugContextEnabled = other.transactionDebugContextEnabled;
110 this.shardManagerPersistenceId = other.shardManagerPersistenceId;
112 setShardJournalRecoveryLogBatchSize(other.raftConfig.getJournalRecoveryLogBatchSize());
113 setSnapshotBatchCount(other.raftConfig.getSnapshotBatchCount());
114 setHeartbeatInterval(other.raftConfig.getHeartBeatInterval().toMillis());
115 setIsolatedLeaderCheckInterval(other.raftConfig.getIsolatedCheckIntervalInMillis());
116 setSnapshotDataThresholdPercentage(other.raftConfig.getSnapshotDataThresholdPercentage());
117 setElectionTimeoutFactor(other.raftConfig.getElectionTimeoutFactor());
118 setCustomRaftPolicyImplementation(other.raftConfig.getCustomRaftPolicyImplementationClass());
119 setShardSnapshotChunkSize(other.raftConfig.getSnapshotChunkSize());
120 setPeerAddressResolver(other.raftConfig.getPeerAddressResolver());
123 public static Builder newBuilder() {
124 return new Builder(new DatastoreContext());
127 public static Builder newBuilderFrom(DatastoreContext context) {
128 return new Builder(new DatastoreContext(context));
131 public InMemoryDOMDataStoreConfigProperties getDataStoreProperties() {
132 return dataStoreProperties;
135 public Duration getShardTransactionIdleTimeout() {
136 return shardTransactionIdleTimeout;
139 public String getDataStoreMXBeanType() {
140 return dataStoreMXBeanType;
143 public long getOperationTimeoutInMillis() {
144 return operationTimeoutInMillis;
147 public ConfigParams getShardRaftConfig() {
151 public int getShardTransactionCommitTimeoutInSeconds() {
152 return shardTransactionCommitTimeoutInSeconds;
155 public int getShardTransactionCommitQueueCapacity() {
156 return shardTransactionCommitQueueCapacity;
159 public Timeout getShardInitializationTimeout() {
160 return shardInitializationTimeout;
163 public Timeout getShardLeaderElectionTimeout() {
164 return shardLeaderElectionTimeout;
167 public boolean isPersistent() {
171 public AkkaConfigurationReader getConfigurationReader() {
172 return configurationReader;
175 public long getShardElectionTimeoutFactor(){
176 return raftConfig.getElectionTimeoutFactor();
179 public String getDataStoreName(){
180 return dataStoreName;
183 public LogicalDatastoreType getLogicalStoreType() {
184 return logicalStoreType;
188 * @deprecated Use {@link #getDataStoreName()} or {@link #getLogicalStoreType()} instead.
191 public String getDataStoreType(){
192 return getDataStoreName();
195 public long getTransactionCreationInitialRateLimit() {
196 return transactionCreationInitialRateLimit;
199 public String getShardManagerPersistenceId() {
200 return shardManagerPersistenceId;
203 private void setPeerAddressResolver(PeerAddressResolver resolver) {
204 raftConfig.setPeerAddressResolver(resolver);
207 private void setHeartbeatInterval(long shardHeartbeatIntervalInMillis){
208 raftConfig.setHeartBeatInterval(new FiniteDuration(shardHeartbeatIntervalInMillis,
209 TimeUnit.MILLISECONDS));
212 private void setShardJournalRecoveryLogBatchSize(int shardJournalRecoveryLogBatchSize){
213 raftConfig.setJournalRecoveryLogBatchSize(shardJournalRecoveryLogBatchSize);
217 private void setIsolatedLeaderCheckInterval(long shardIsolatedLeaderCheckIntervalInMillis) {
218 raftConfig.setIsolatedLeaderCheckInterval(
219 new FiniteDuration(shardIsolatedLeaderCheckIntervalInMillis, TimeUnit.MILLISECONDS));
222 private void setElectionTimeoutFactor(long shardElectionTimeoutFactor) {
223 raftConfig.setElectionTimeoutFactor(shardElectionTimeoutFactor);
226 private void setCustomRaftPolicyImplementation(String customRaftPolicyImplementation) {
227 raftConfig.setCustomRaftPolicyImplementationClass(customRaftPolicyImplementation);
230 private void setSnapshotDataThresholdPercentage(int shardSnapshotDataThresholdPercentage) {
231 raftConfig.setSnapshotDataThresholdPercentage(shardSnapshotDataThresholdPercentage);
234 private void setSnapshotBatchCount(long shardSnapshotBatchCount) {
235 raftConfig.setSnapshotBatchCount(shardSnapshotBatchCount);
238 private void setShardSnapshotChunkSize(int shardSnapshotChunkSize) {
239 raftConfig.setSnapshotChunkSize(shardSnapshotChunkSize);
242 public int getShardBatchedModificationCount() {
243 return shardBatchedModificationCount;
246 public boolean isWriteOnlyTransactionOptimizationsEnabled() {
247 return writeOnlyTransactionOptimizationsEnabled;
250 public long getShardCommitQueueExpiryTimeoutInMillis() {
251 return shardCommitQueueExpiryTimeoutInMillis;
254 public boolean isTransactionDebugContextEnabled() {
255 return transactionDebugContextEnabled;
258 public int getShardSnapshotChunkSize() {
259 return raftConfig.getSnapshotChunkSize();
262 public static class Builder {
263 private final DatastoreContext datastoreContext;
264 private int maxShardDataChangeExecutorPoolSize =
265 InMemoryDOMDataStoreConfigProperties.DEFAULT_MAX_DATA_CHANGE_EXECUTOR_POOL_SIZE;
266 private int maxShardDataChangeExecutorQueueSize =
267 InMemoryDOMDataStoreConfigProperties.DEFAULT_MAX_DATA_CHANGE_EXECUTOR_QUEUE_SIZE;
268 private int maxShardDataChangeListenerQueueSize =
269 InMemoryDOMDataStoreConfigProperties.DEFAULT_MAX_DATA_CHANGE_LISTENER_QUEUE_SIZE;
270 private int maxShardDataStoreExecutorQueueSize =
271 InMemoryDOMDataStoreConfigProperties.DEFAULT_MAX_DATA_STORE_EXECUTOR_QUEUE_SIZE;
273 private Builder(DatastoreContext datastoreContext) {
274 this.datastoreContext = datastoreContext;
276 if(datastoreContext.getDataStoreProperties() != null) {
277 maxShardDataChangeExecutorPoolSize =
278 datastoreContext.getDataStoreProperties().getMaxDataChangeExecutorPoolSize();
279 maxShardDataChangeExecutorQueueSize =
280 datastoreContext.getDataStoreProperties().getMaxDataChangeExecutorQueueSize();
281 maxShardDataChangeListenerQueueSize =
282 datastoreContext.getDataStoreProperties().getMaxDataChangeListenerQueueSize();
283 maxShardDataStoreExecutorQueueSize =
284 datastoreContext.getDataStoreProperties().getMaxDataStoreExecutorQueueSize();
288 public Builder boundedMailboxCapacity(int boundedMailboxCapacity) {
289 // TODO - this is defined in the yang DataStoreProperties but not currently used.
293 public Builder enableMetricCapture(boolean enableMetricCapture) {
294 // TODO - this is defined in the yang DataStoreProperties but not currently used.
299 public Builder shardTransactionIdleTimeout(long timeout, TimeUnit unit) {
300 datastoreContext.shardTransactionIdleTimeout = Duration.create(timeout, unit);
304 public Builder shardTransactionIdleTimeoutInMinutes(long timeout) {
305 return shardTransactionIdleTimeout(timeout, TimeUnit.MINUTES);
308 public Builder operationTimeoutInSeconds(int operationTimeoutInSeconds) {
309 datastoreContext.operationTimeoutInMillis = TimeUnit.SECONDS.toMillis(operationTimeoutInSeconds);
313 public Builder operationTimeoutInMillis(long operationTimeoutInMillis) {
314 datastoreContext.operationTimeoutInMillis = operationTimeoutInMillis;
318 public Builder dataStoreMXBeanType(String dataStoreMXBeanType) {
319 datastoreContext.dataStoreMXBeanType = dataStoreMXBeanType;
323 public Builder shardTransactionCommitTimeoutInSeconds(int shardTransactionCommitTimeoutInSeconds) {
324 datastoreContext.shardTransactionCommitTimeoutInSeconds = shardTransactionCommitTimeoutInSeconds;
328 public Builder shardJournalRecoveryLogBatchSize(int shardJournalRecoveryLogBatchSize) {
329 datastoreContext.setShardJournalRecoveryLogBatchSize(shardJournalRecoveryLogBatchSize);
333 public Builder shardSnapshotBatchCount(int shardSnapshotBatchCount) {
334 datastoreContext.setSnapshotBatchCount(shardSnapshotBatchCount);
338 public Builder shardSnapshotDataThresholdPercentage(int shardSnapshotDataThresholdPercentage) {
339 datastoreContext.setSnapshotDataThresholdPercentage(shardSnapshotDataThresholdPercentage);
343 public Builder shardHeartbeatIntervalInMillis(int shardHeartbeatIntervalInMillis) {
344 datastoreContext.setHeartbeatInterval(shardHeartbeatIntervalInMillis);
348 public Builder shardTransactionCommitQueueCapacity(int shardTransactionCommitQueueCapacity) {
349 datastoreContext.shardTransactionCommitQueueCapacity = shardTransactionCommitQueueCapacity;
353 public Builder shardInitializationTimeout(long timeout, TimeUnit unit) {
354 datastoreContext.shardInitializationTimeout = new Timeout(timeout, unit);
358 public Builder shardInitializationTimeoutInSeconds(long timeout) {
359 return shardInitializationTimeout(timeout, TimeUnit.SECONDS);
362 public Builder shardLeaderElectionTimeout(long timeout, TimeUnit unit) {
363 datastoreContext.shardLeaderElectionTimeout = new Timeout(timeout, unit);
367 public Builder shardLeaderElectionTimeoutInSeconds(long timeout) {
368 return shardLeaderElectionTimeout(timeout, TimeUnit.SECONDS);
371 public Builder configurationReader(AkkaConfigurationReader configurationReader){
372 datastoreContext.configurationReader = configurationReader;
376 public Builder persistent(boolean persistent){
377 datastoreContext.persistent = persistent;
381 public Builder shardIsolatedLeaderCheckIntervalInMillis(int shardIsolatedLeaderCheckIntervalInMillis) {
382 datastoreContext.setIsolatedLeaderCheckInterval(shardIsolatedLeaderCheckIntervalInMillis);
386 public Builder shardElectionTimeoutFactor(long shardElectionTimeoutFactor){
387 datastoreContext.setElectionTimeoutFactor(shardElectionTimeoutFactor);
391 public Builder transactionCreationInitialRateLimit(long initialRateLimit){
392 datastoreContext.transactionCreationInitialRateLimit = initialRateLimit;
397 * @deprecated Use {@link #logicalStoreType(LogicalDatastoreType)} or {@link #dataStoreName(String)}.
400 public Builder dataStoreType(String dataStoreType){
401 return dataStoreName(dataStoreType);
404 public Builder logicalStoreType(LogicalDatastoreType logicalStoreType){
405 datastoreContext.logicalStoreType = Preconditions.checkNotNull(logicalStoreType);
407 // Retain compatible naming
408 switch (logicalStoreType) {
410 dataStoreName("config");
413 dataStoreName("operational");
416 dataStoreName(logicalStoreType.name());
422 public Builder dataStoreName(String dataStoreName){
423 datastoreContext.dataStoreName = Preconditions.checkNotNull(dataStoreName);
424 datastoreContext.dataStoreMXBeanType = "Distributed" + WordUtils.capitalize(dataStoreName) + "Datastore";
428 public Builder shardBatchedModificationCount(int shardBatchedModificationCount) {
429 datastoreContext.shardBatchedModificationCount = shardBatchedModificationCount;
433 public Builder writeOnlyTransactionOptimizationsEnabled(boolean value) {
434 datastoreContext.writeOnlyTransactionOptimizationsEnabled = value;
438 public Builder shardCommitQueueExpiryTimeoutInMillis(long value) {
439 datastoreContext.shardCommitQueueExpiryTimeoutInMillis = value;
443 public Builder shardCommitQueueExpiryTimeoutInSeconds(long value) {
444 datastoreContext.shardCommitQueueExpiryTimeoutInMillis = TimeUnit.MILLISECONDS.convert(
445 value, TimeUnit.SECONDS);
449 public Builder transactionDebugContextEnabled(boolean value) {
450 datastoreContext.transactionDebugContextEnabled = value;
454 public Builder maxShardDataChangeExecutorPoolSize(int maxShardDataChangeExecutorPoolSize) {
455 this.maxShardDataChangeExecutorPoolSize = maxShardDataChangeExecutorPoolSize;
459 public Builder maxShardDataChangeExecutorQueueSize(int maxShardDataChangeExecutorQueueSize) {
460 this.maxShardDataChangeExecutorQueueSize = maxShardDataChangeExecutorQueueSize;
464 public Builder maxShardDataChangeListenerQueueSize(int maxShardDataChangeListenerQueueSize) {
465 this.maxShardDataChangeListenerQueueSize = maxShardDataChangeListenerQueueSize;
469 public Builder maxShardDataStoreExecutorQueueSize(int maxShardDataStoreExecutorQueueSize) {
470 this.maxShardDataStoreExecutorQueueSize = maxShardDataStoreExecutorQueueSize;
475 * For unit tests only.
478 public Builder shardManagerPersistenceId(String id) {
479 datastoreContext.shardManagerPersistenceId = id;
483 public DatastoreContext build() {
484 datastoreContext.dataStoreProperties = InMemoryDOMDataStoreConfigProperties.create(
485 maxShardDataChangeExecutorPoolSize, maxShardDataChangeExecutorQueueSize,
486 maxShardDataChangeListenerQueueSize, maxShardDataStoreExecutorQueueSize);
488 if(datastoreContext.dataStoreName != null) {
489 globalDatastoreTypes.add(datastoreContext.dataStoreName);
492 return datastoreContext;
495 public Builder customRaftPolicyImplementation(String customRaftPolicyImplementation) {
496 datastoreContext.setCustomRaftPolicyImplementation(customRaftPolicyImplementation);
500 public Builder shardSnapshotChunkSize(int shardSnapshotChunkSize) {
501 datastoreContext.setShardSnapshotChunkSize(shardSnapshotChunkSize);
505 public Builder shardPeerAddressResolver(PeerAddressResolver resolver) {
506 datastoreContext.setPeerAddressResolver(resolver);