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 = 1;
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 =
43 DEFAULT_HEARTBEAT_INTERVAL_IN_MILLIS * 10;
44 public static final int DEFAULT_SHARD_TX_COMMIT_QUEUE_CAPACITY = 50000;
45 public static final Timeout DEFAULT_SHARD_INITIALIZATION_TIMEOUT = new Timeout(5, TimeUnit.MINUTES);
46 public static final Timeout DEFAULT_SHARD_LEADER_ELECTION_TIMEOUT = new Timeout(30, TimeUnit.SECONDS);
47 public static final boolean DEFAULT_PERSISTENT = true;
48 public static final FileAkkaConfigurationReader DEFAULT_CONFIGURATION_READER = new FileAkkaConfigurationReader();
49 public static final int DEFAULT_SHARD_SNAPSHOT_DATA_THRESHOLD_PERCENTAGE = 12;
50 public static final int DEFAULT_SHARD_ELECTION_TIMEOUT_FACTOR = 2;
51 public static final int DEFAULT_TX_CREATION_INITIAL_RATE_LIMIT = 100;
52 public static final String UNKNOWN_DATA_STORE_TYPE = "unknown";
53 public static final int DEFAULT_SHARD_BATCHED_MODIFICATION_COUNT = 1000;
54 public static final long DEFAULT_SHARD_COMMIT_QUEUE_EXPIRY_TIMEOUT_IN_MS =
55 TimeUnit.MILLISECONDS.convert(2, TimeUnit.MINUTES);
56 public static final int DEFAULT_SHARD_SNAPSHOT_CHUNK_SIZE = 2048000;
58 private static final Set<String> GLOBAL_DATASTORE_NAMES = Sets.newConcurrentHashSet();
60 private InMemoryDOMDataStoreConfigProperties dataStoreProperties;
61 private Duration shardTransactionIdleTimeout = DatastoreContext.DEFAULT_SHARD_TRANSACTION_IDLE_TIMEOUT;
62 private long operationTimeoutInMillis = DEFAULT_OPERATION_TIMEOUT_IN_MS;
63 private String dataStoreMXBeanType;
64 private int shardTransactionCommitTimeoutInSeconds = DEFAULT_SHARD_TX_COMMIT_TIMEOUT_IN_SECONDS;
65 private int shardTransactionCommitQueueCapacity = DEFAULT_SHARD_TX_COMMIT_QUEUE_CAPACITY;
66 private Timeout shardInitializationTimeout = DEFAULT_SHARD_INITIALIZATION_TIMEOUT;
67 private Timeout shardLeaderElectionTimeout = DEFAULT_SHARD_LEADER_ELECTION_TIMEOUT;
68 private boolean persistent = DEFAULT_PERSISTENT;
69 private AkkaConfigurationReader configurationReader = DEFAULT_CONFIGURATION_READER;
70 private long transactionCreationInitialRateLimit = DEFAULT_TX_CREATION_INITIAL_RATE_LIMIT;
71 private final DefaultConfigParamsImpl raftConfig = new DefaultConfigParamsImpl();
72 private String dataStoreName = UNKNOWN_DATA_STORE_TYPE;
73 private LogicalDatastoreType logicalStoreType = LogicalDatastoreType.OPERATIONAL;
74 private int shardBatchedModificationCount = DEFAULT_SHARD_BATCHED_MODIFICATION_COUNT;
75 private boolean writeOnlyTransactionOptimizationsEnabled = true;
76 private long shardCommitQueueExpiryTimeoutInMillis = DEFAULT_SHARD_COMMIT_QUEUE_EXPIRY_TIMEOUT_IN_MS;
77 private boolean transactionDebugContextEnabled = false;
78 private String shardManagerPersistenceId;
80 public static Set<String> getGlobalDatastoreNames() {
81 return GLOBAL_DATASTORE_NAMES;
84 private DatastoreContext() {
85 setShardJournalRecoveryLogBatchSize(DEFAULT_JOURNAL_RECOVERY_BATCH_SIZE);
86 setSnapshotBatchCount(DEFAULT_SNAPSHOT_BATCH_COUNT);
87 setHeartbeatInterval(DEFAULT_HEARTBEAT_INTERVAL_IN_MILLIS);
88 setIsolatedLeaderCheckInterval(DEFAULT_ISOLATED_LEADER_CHECK_INTERVAL_IN_MILLIS);
89 setSnapshotDataThresholdPercentage(DEFAULT_SHARD_SNAPSHOT_DATA_THRESHOLD_PERCENTAGE);
90 setElectionTimeoutFactor(DEFAULT_SHARD_ELECTION_TIMEOUT_FACTOR);
91 setShardSnapshotChunkSize(DEFAULT_SHARD_SNAPSHOT_CHUNK_SIZE);
94 private DatastoreContext(DatastoreContext other) {
95 this.dataStoreProperties = other.dataStoreProperties;
96 this.shardTransactionIdleTimeout = other.shardTransactionIdleTimeout;
97 this.operationTimeoutInMillis = other.operationTimeoutInMillis;
98 this.dataStoreMXBeanType = other.dataStoreMXBeanType;
99 this.shardTransactionCommitTimeoutInSeconds = other.shardTransactionCommitTimeoutInSeconds;
100 this.shardTransactionCommitQueueCapacity = other.shardTransactionCommitQueueCapacity;
101 this.shardInitializationTimeout = other.shardInitializationTimeout;
102 this.shardLeaderElectionTimeout = other.shardLeaderElectionTimeout;
103 this.persistent = other.persistent;
104 this.configurationReader = other.configurationReader;
105 this.transactionCreationInitialRateLimit = other.transactionCreationInitialRateLimit;
106 this.dataStoreName = other.dataStoreName;
107 this.logicalStoreType = other.logicalStoreType;
108 this.shardBatchedModificationCount = other.shardBatchedModificationCount;
109 this.writeOnlyTransactionOptimizationsEnabled = other.writeOnlyTransactionOptimizationsEnabled;
110 this.shardCommitQueueExpiryTimeoutInMillis = other.shardCommitQueueExpiryTimeoutInMillis;
111 this.transactionDebugContextEnabled = other.transactionDebugContextEnabled;
112 this.shardManagerPersistenceId = other.shardManagerPersistenceId;
114 setShardJournalRecoveryLogBatchSize(other.raftConfig.getJournalRecoveryLogBatchSize());
115 setSnapshotBatchCount(other.raftConfig.getSnapshotBatchCount());
116 setHeartbeatInterval(other.raftConfig.getHeartBeatInterval().toMillis());
117 setIsolatedLeaderCheckInterval(other.raftConfig.getIsolatedCheckIntervalInMillis());
118 setSnapshotDataThresholdPercentage(other.raftConfig.getSnapshotDataThresholdPercentage());
119 setElectionTimeoutFactor(other.raftConfig.getElectionTimeoutFactor());
120 setCustomRaftPolicyImplementation(other.raftConfig.getCustomRaftPolicyImplementationClass());
121 setShardSnapshotChunkSize(other.raftConfig.getSnapshotChunkSize());
122 setPeerAddressResolver(other.raftConfig.getPeerAddressResolver());
125 public static Builder newBuilder() {
126 return new Builder(new DatastoreContext());
129 public static Builder newBuilderFrom(DatastoreContext context) {
130 return new Builder(new DatastoreContext(context));
133 public InMemoryDOMDataStoreConfigProperties getDataStoreProperties() {
134 return dataStoreProperties;
137 public Duration getShardTransactionIdleTimeout() {
138 return shardTransactionIdleTimeout;
141 public String getDataStoreMXBeanType() {
142 return dataStoreMXBeanType;
145 public long getOperationTimeoutInMillis() {
146 return operationTimeoutInMillis;
149 public ConfigParams getShardRaftConfig() {
153 public int getShardTransactionCommitTimeoutInSeconds() {
154 return shardTransactionCommitTimeoutInSeconds;
157 public int getShardTransactionCommitQueueCapacity() {
158 return shardTransactionCommitQueueCapacity;
161 public Timeout getShardInitializationTimeout() {
162 return shardInitializationTimeout;
165 public Timeout getShardLeaderElectionTimeout() {
166 return shardLeaderElectionTimeout;
169 public boolean isPersistent() {
173 public AkkaConfigurationReader getConfigurationReader() {
174 return configurationReader;
177 public long getShardElectionTimeoutFactor() {
178 return raftConfig.getElectionTimeoutFactor();
181 public String getDataStoreName() {
182 return dataStoreName;
185 public LogicalDatastoreType getLogicalStoreType() {
186 return logicalStoreType;
189 public long getTransactionCreationInitialRateLimit() {
190 return transactionCreationInitialRateLimit;
193 public String getShardManagerPersistenceId() {
194 return shardManagerPersistenceId;
197 private void setPeerAddressResolver(PeerAddressResolver resolver) {
198 raftConfig.setPeerAddressResolver(resolver);
201 private void setHeartbeatInterval(long shardHeartbeatIntervalInMillis) {
202 raftConfig.setHeartBeatInterval(new FiniteDuration(shardHeartbeatIntervalInMillis,
203 TimeUnit.MILLISECONDS));
206 private void setShardJournalRecoveryLogBatchSize(int shardJournalRecoveryLogBatchSize) {
207 raftConfig.setJournalRecoveryLogBatchSize(shardJournalRecoveryLogBatchSize);
211 private void setIsolatedLeaderCheckInterval(long shardIsolatedLeaderCheckIntervalInMillis) {
212 raftConfig.setIsolatedLeaderCheckInterval(
213 new FiniteDuration(shardIsolatedLeaderCheckIntervalInMillis, TimeUnit.MILLISECONDS));
216 private void setElectionTimeoutFactor(long shardElectionTimeoutFactor) {
217 raftConfig.setElectionTimeoutFactor(shardElectionTimeoutFactor);
220 private void setCustomRaftPolicyImplementation(String customRaftPolicyImplementation) {
221 raftConfig.setCustomRaftPolicyImplementationClass(customRaftPolicyImplementation);
224 private void setSnapshotDataThresholdPercentage(int shardSnapshotDataThresholdPercentage) {
225 Preconditions.checkArgument(shardSnapshotDataThresholdPercentage >= 0
226 && shardSnapshotDataThresholdPercentage <= 100);
227 raftConfig.setSnapshotDataThresholdPercentage(shardSnapshotDataThresholdPercentage);
230 private void setSnapshotBatchCount(long shardSnapshotBatchCount) {
231 raftConfig.setSnapshotBatchCount(shardSnapshotBatchCount);
234 private void setShardSnapshotChunkSize(int shardSnapshotChunkSize) {
235 raftConfig.setSnapshotChunkSize(shardSnapshotChunkSize);
238 public int getShardBatchedModificationCount() {
239 return shardBatchedModificationCount;
242 public boolean isWriteOnlyTransactionOptimizationsEnabled() {
243 return writeOnlyTransactionOptimizationsEnabled;
246 public long getShardCommitQueueExpiryTimeoutInMillis() {
247 return shardCommitQueueExpiryTimeoutInMillis;
250 public boolean isTransactionDebugContextEnabled() {
251 return transactionDebugContextEnabled;
254 public int getShardSnapshotChunkSize() {
255 return raftConfig.getSnapshotChunkSize();
258 public static class Builder {
259 private final DatastoreContext datastoreContext;
260 private int maxShardDataChangeExecutorPoolSize =
261 InMemoryDOMDataStoreConfigProperties.DEFAULT_MAX_DATA_CHANGE_EXECUTOR_POOL_SIZE;
262 private int maxShardDataChangeExecutorQueueSize =
263 InMemoryDOMDataStoreConfigProperties.DEFAULT_MAX_DATA_CHANGE_EXECUTOR_QUEUE_SIZE;
264 private int maxShardDataChangeListenerQueueSize =
265 InMemoryDOMDataStoreConfigProperties.DEFAULT_MAX_DATA_CHANGE_LISTENER_QUEUE_SIZE;
266 private int maxShardDataStoreExecutorQueueSize =
267 InMemoryDOMDataStoreConfigProperties.DEFAULT_MAX_DATA_STORE_EXECUTOR_QUEUE_SIZE;
269 private Builder(DatastoreContext datastoreContext) {
270 this.datastoreContext = datastoreContext;
272 if (datastoreContext.getDataStoreProperties() != null) {
273 maxShardDataChangeExecutorPoolSize =
274 datastoreContext.getDataStoreProperties().getMaxDataChangeExecutorPoolSize();
275 maxShardDataChangeExecutorQueueSize =
276 datastoreContext.getDataStoreProperties().getMaxDataChangeExecutorQueueSize();
277 maxShardDataChangeListenerQueueSize =
278 datastoreContext.getDataStoreProperties().getMaxDataChangeListenerQueueSize();
279 maxShardDataStoreExecutorQueueSize =
280 datastoreContext.getDataStoreProperties().getMaxDataStoreExecutorQueueSize();
284 public Builder boundedMailboxCapacity(int boundedMailboxCapacity) {
285 // TODO - this is defined in the yang DataStoreProperties but not currently used.
289 public Builder enableMetricCapture(boolean enableMetricCapture) {
290 // TODO - this is defined in the yang DataStoreProperties but not currently used.
295 public Builder shardTransactionIdleTimeout(long timeout, TimeUnit unit) {
296 datastoreContext.shardTransactionIdleTimeout = Duration.create(timeout, unit);
300 public Builder shardTransactionIdleTimeoutInMinutes(long timeout) {
301 return shardTransactionIdleTimeout(timeout, TimeUnit.MINUTES);
304 public Builder operationTimeoutInSeconds(int operationTimeoutInSeconds) {
305 datastoreContext.operationTimeoutInMillis = TimeUnit.SECONDS.toMillis(operationTimeoutInSeconds);
309 public Builder operationTimeoutInMillis(long operationTimeoutInMillis) {
310 datastoreContext.operationTimeoutInMillis = operationTimeoutInMillis;
314 public Builder dataStoreMXBeanType(String dataStoreMXBeanType) {
315 datastoreContext.dataStoreMXBeanType = dataStoreMXBeanType;
319 public Builder shardTransactionCommitTimeoutInSeconds(int shardTransactionCommitTimeoutInSeconds) {
320 datastoreContext.shardTransactionCommitTimeoutInSeconds = shardTransactionCommitTimeoutInSeconds;
324 public Builder shardJournalRecoveryLogBatchSize(int shardJournalRecoveryLogBatchSize) {
325 datastoreContext.setShardJournalRecoveryLogBatchSize(shardJournalRecoveryLogBatchSize);
329 public Builder shardSnapshotBatchCount(int shardSnapshotBatchCount) {
330 datastoreContext.setSnapshotBatchCount(shardSnapshotBatchCount);
334 public Builder shardSnapshotDataThresholdPercentage(int shardSnapshotDataThresholdPercentage) {
335 datastoreContext.setSnapshotDataThresholdPercentage(shardSnapshotDataThresholdPercentage);
339 public Builder shardHeartbeatIntervalInMillis(int shardHeartbeatIntervalInMillis) {
340 datastoreContext.setHeartbeatInterval(shardHeartbeatIntervalInMillis);
344 public Builder shardTransactionCommitQueueCapacity(int shardTransactionCommitQueueCapacity) {
345 datastoreContext.shardTransactionCommitQueueCapacity = shardTransactionCommitQueueCapacity;
349 public Builder shardInitializationTimeout(long timeout, TimeUnit unit) {
350 datastoreContext.shardInitializationTimeout = new Timeout(timeout, unit);
354 public Builder shardInitializationTimeoutInSeconds(long timeout) {
355 return shardInitializationTimeout(timeout, TimeUnit.SECONDS);
358 public Builder shardLeaderElectionTimeout(long timeout, TimeUnit unit) {
359 datastoreContext.shardLeaderElectionTimeout = new Timeout(timeout, unit);
363 public Builder shardLeaderElectionTimeoutInSeconds(long timeout) {
364 return shardLeaderElectionTimeout(timeout, TimeUnit.SECONDS);
367 public Builder configurationReader(AkkaConfigurationReader configurationReader) {
368 datastoreContext.configurationReader = configurationReader;
372 public Builder persistent(boolean persistent) {
373 datastoreContext.persistent = persistent;
377 public Builder shardIsolatedLeaderCheckIntervalInMillis(int shardIsolatedLeaderCheckIntervalInMillis) {
378 datastoreContext.setIsolatedLeaderCheckInterval(shardIsolatedLeaderCheckIntervalInMillis);
382 public Builder shardElectionTimeoutFactor(long shardElectionTimeoutFactor) {
383 datastoreContext.setElectionTimeoutFactor(shardElectionTimeoutFactor);
387 public Builder transactionCreationInitialRateLimit(long initialRateLimit) {
388 datastoreContext.transactionCreationInitialRateLimit = initialRateLimit;
392 public Builder logicalStoreType(LogicalDatastoreType logicalStoreType) {
393 datastoreContext.logicalStoreType = Preconditions.checkNotNull(logicalStoreType);
395 // Retain compatible naming
396 switch (logicalStoreType) {
398 dataStoreName("config");
401 dataStoreName("operational");
404 dataStoreName(logicalStoreType.name());
410 public Builder dataStoreName(String dataStoreName) {
411 datastoreContext.dataStoreName = Preconditions.checkNotNull(dataStoreName);
412 datastoreContext.dataStoreMXBeanType = "Distributed" + WordUtils.capitalize(dataStoreName) + "Datastore";
416 public Builder shardBatchedModificationCount(int shardBatchedModificationCount) {
417 datastoreContext.shardBatchedModificationCount = shardBatchedModificationCount;
421 public Builder writeOnlyTransactionOptimizationsEnabled(boolean value) {
422 datastoreContext.writeOnlyTransactionOptimizationsEnabled = value;
426 public Builder shardCommitQueueExpiryTimeoutInMillis(long value) {
427 datastoreContext.shardCommitQueueExpiryTimeoutInMillis = value;
431 public Builder shardCommitQueueExpiryTimeoutInSeconds(long value) {
432 datastoreContext.shardCommitQueueExpiryTimeoutInMillis = TimeUnit.MILLISECONDS.convert(
433 value, TimeUnit.SECONDS);
437 public Builder transactionDebugContextEnabled(boolean value) {
438 datastoreContext.transactionDebugContextEnabled = value;
442 public Builder maxShardDataChangeExecutorPoolSize(int maxShardDataChangeExecutorPoolSize) {
443 this.maxShardDataChangeExecutorPoolSize = maxShardDataChangeExecutorPoolSize;
447 public Builder maxShardDataChangeExecutorQueueSize(int maxShardDataChangeExecutorQueueSize) {
448 this.maxShardDataChangeExecutorQueueSize = maxShardDataChangeExecutorQueueSize;
452 public Builder maxShardDataChangeListenerQueueSize(int maxShardDataChangeListenerQueueSize) {
453 this.maxShardDataChangeListenerQueueSize = maxShardDataChangeListenerQueueSize;
457 public Builder maxShardDataStoreExecutorQueueSize(int maxShardDataStoreExecutorQueueSize) {
458 this.maxShardDataStoreExecutorQueueSize = maxShardDataStoreExecutorQueueSize;
463 * For unit tests only.
466 public Builder shardManagerPersistenceId(String id) {
467 datastoreContext.shardManagerPersistenceId = id;
471 public DatastoreContext build() {
472 datastoreContext.dataStoreProperties = InMemoryDOMDataStoreConfigProperties.create(
473 maxShardDataChangeExecutorPoolSize, maxShardDataChangeExecutorQueueSize,
474 maxShardDataChangeListenerQueueSize, maxShardDataStoreExecutorQueueSize);
476 if (datastoreContext.dataStoreName != null) {
477 GLOBAL_DATASTORE_NAMES.add(datastoreContext.dataStoreName);
480 return datastoreContext;
483 public Builder customRaftPolicyImplementation(String customRaftPolicyImplementation) {
484 datastoreContext.setCustomRaftPolicyImplementation(customRaftPolicyImplementation);
488 public Builder shardSnapshotChunkSize(int shardSnapshotChunkSize) {
489 datastoreContext.setShardSnapshotChunkSize(shardSnapshotChunkSize);
493 public Builder shardPeerAddressResolver(PeerAddressResolver resolver) {
494 datastoreContext.setPeerAddressResolver(resolver);