opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/DatastoreContext.java

   1 /*
   2  * Copyright (c) 2014 Brocade Communications Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8
   9 package org.opendaylight.controller.cluster.datastore;
  10
  11 import akka.util.Timeout;
  12 import com.google.common.collect.Sets;
  13 import java.util.Set;
  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;
  24
  25 /**
  26  * Contains contextual data for a data store.
  27  *
  28  * @author Thomas Pantelis
  29  */
  30 public class DatastoreContext {
  31     public static final String METRICS_DOMAIN = "org.opendaylight.controller.cluster.datastore";
  32
  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;
  52
  53     private static Set<String> globalDatastoreTypes = Sets.newConcurrentHashSet();
  54
  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;
  72     private String customRaftPolicyImplementation = "";
  73
  74     public static Set<String> getGlobalDatastoreTypes() {
  75         return globalDatastoreTypes;
  76     }
  77
  78     private DatastoreContext() {
  79         setShardJournalRecoveryLogBatchSize(DEFAULT_JOURNAL_RECOVERY_BATCH_SIZE);
  80         setSnapshotBatchCount(DEFAULT_SNAPSHOT_BATCH_COUNT);
  81         setHeartbeatInterval(DEFAULT_HEARTBEAT_INTERVAL_IN_MILLIS);
  82         setIsolatedLeaderCheckInterval(DEFAULT_ISOLATED_LEADER_CHECK_INTERVAL_IN_MILLIS);
  83         setSnapshotDataThresholdPercentage(DEFAULT_SHARD_SNAPSHOT_DATA_THRESHOLD_PERCENTAGE);
  84         setElectionTimeoutFactor(DEFAULT_SHARD_ELECTION_TIMEOUT_FACTOR);
  85         setShardSnapshotChunkSize(DEFAULT_SHARD_SNAPSHOT_CHUNK_SIZE);
  86     }
  87
  88     private DatastoreContext(DatastoreContext other) {
  89         this.dataStoreProperties = other.dataStoreProperties;
  90         this.shardTransactionIdleTimeout = other.shardTransactionIdleTimeout;
  91         this.operationTimeoutInMillis = other.operationTimeoutInMillis;
  92         this.dataStoreMXBeanType = other.dataStoreMXBeanType;
  93         this.shardTransactionCommitTimeoutInSeconds = other.shardTransactionCommitTimeoutInSeconds;
  94         this.shardTransactionCommitQueueCapacity = other.shardTransactionCommitQueueCapacity;
  95         this.shardInitializationTimeout = other.shardInitializationTimeout;
  96         this.shardLeaderElectionTimeout = other.shardLeaderElectionTimeout;
  97         this.persistent = other.persistent;
  98         this.configurationReader = other.configurationReader;
  99         this.transactionCreationInitialRateLimit = other.transactionCreationInitialRateLimit;
 100         this.dataStoreType = other.dataStoreType;
 101         this.shardBatchedModificationCount = other.shardBatchedModificationCount;
 102         this.writeOnlyTransactionOptimizationsEnabled = other.writeOnlyTransactionOptimizationsEnabled;
 103         this.shardCommitQueueExpiryTimeoutInMillis = other.shardCommitQueueExpiryTimeoutInMillis;
 104         this.transactionDebugContextEnabled = other.transactionDebugContextEnabled;
 105         this.customRaftPolicyImplementation = other.customRaftPolicyImplementation;
 106
 107         setShardJournalRecoveryLogBatchSize(other.raftConfig.getJournalRecoveryLogBatchSize());
 108         setSnapshotBatchCount(other.raftConfig.getSnapshotBatchCount());
 109         setHeartbeatInterval(other.raftConfig.getHeartBeatInterval().toMillis());
 110         setIsolatedLeaderCheckInterval(other.raftConfig.getIsolatedCheckIntervalInMillis());
 111         setSnapshotDataThresholdPercentage(other.raftConfig.getSnapshotDataThresholdPercentage());
 112         setElectionTimeoutFactor(other.raftConfig.getElectionTimeoutFactor());
 113         setCustomRaftPolicyImplementation(other.customRaftPolicyImplementation);
 114         setShardSnapshotChunkSize(other.raftConfig.getSnapshotChunkSize());
 115         setPeerAddressResolver(other.raftConfig.getPeerAddressResolver());
 116     }
 117
 118     public static Builder newBuilder() {
 119         return new Builder(new DatastoreContext());
 120     }
 121
 122     public static Builder newBuilderFrom(DatastoreContext context) {
 123         return new Builder(new DatastoreContext(context));
 124     }
 125
 126     public InMemoryDOMDataStoreConfigProperties getDataStoreProperties() {
 127         return dataStoreProperties;
 128     }
 129
 130     public Duration getShardTransactionIdleTimeout() {
 131         return shardTransactionIdleTimeout;
 132     }
 133
 134     public String getDataStoreMXBeanType() {
 135         return dataStoreMXBeanType;
 136     }
 137
 138     public long getOperationTimeoutInMillis() {
 139         return operationTimeoutInMillis;
 140     }
 141
 142     public ConfigParams getShardRaftConfig() {
 143         return raftConfig;
 144     }
 145
 146     public int getShardTransactionCommitTimeoutInSeconds() {
 147         return shardTransactionCommitTimeoutInSeconds;
 148     }
 149
 150     public int getShardTransactionCommitQueueCapacity() {
 151         return shardTransactionCommitQueueCapacity;
 152     }
 153
 154     public Timeout getShardInitializationTimeout() {
 155         return shardInitializationTimeout;
 156     }
 157
 158     public Timeout getShardLeaderElectionTimeout() {
 159         return shardLeaderElectionTimeout;
 160     }
 161
 162     public boolean isPersistent() {
 163         return persistent;
 164     }
 165
 166     public AkkaConfigurationReader getConfigurationReader() {
 167         return configurationReader;
 168     }
 169
 170     public long getShardElectionTimeoutFactor(){
 171         return raftConfig.getElectionTimeoutFactor();
 172     }
 173
 174     public String getDataStoreType(){
 175         return dataStoreType;
 176     }
 177
 178     public long getTransactionCreationInitialRateLimit() {
 179         return transactionCreationInitialRateLimit;
 180     }
 181
 182     private void setPeerAddressResolver(PeerAddressResolver resolver) {
 183         raftConfig.setPeerAddressResolver(resolver);
 184     }
 185
 186     private void setHeartbeatInterval(long shardHeartbeatIntervalInMillis){
 187         raftConfig.setHeartBeatInterval(new FiniteDuration(shardHeartbeatIntervalInMillis,
 188                 TimeUnit.MILLISECONDS));
 189     }
 190
 191     private void setShardJournalRecoveryLogBatchSize(int shardJournalRecoveryLogBatchSize){
 192         raftConfig.setJournalRecoveryLogBatchSize(shardJournalRecoveryLogBatchSize);
 193     }
 194
 195
 196     private void setIsolatedLeaderCheckInterval(long shardIsolatedLeaderCheckIntervalInMillis) {
 197         raftConfig.setIsolatedLeaderCheckInterval(
 198                 new FiniteDuration(shardIsolatedLeaderCheckIntervalInMillis, TimeUnit.MILLISECONDS));
 199     }
 200
 201     private void setElectionTimeoutFactor(long shardElectionTimeoutFactor) {
 202         raftConfig.setElectionTimeoutFactor(shardElectionTimeoutFactor);
 203     }
 204
 205     private void setCustomRaftPolicyImplementation(String customRaftPolicyImplementation) {
 206         raftConfig.setCustomRaftPolicyImplementationClass(customRaftPolicyImplementation);
 207     }
 208
 209     private void setSnapshotDataThresholdPercentage(int shardSnapshotDataThresholdPercentage) {
 210         raftConfig.setSnapshotDataThresholdPercentage(shardSnapshotDataThresholdPercentage);
 211     }
 212
 213     private void setSnapshotBatchCount(long shardSnapshotBatchCount) {
 214         raftConfig.setSnapshotBatchCount(shardSnapshotBatchCount);
 215     }
 216
 217     private void setShardSnapshotChunkSize(int shardSnapshotChunkSize) {
 218         raftConfig.setSnapshotChunkSize(shardSnapshotChunkSize);
 219     }
 220
 221     public int getShardBatchedModificationCount() {
 222         return shardBatchedModificationCount;
 223     }
 224
 225     public boolean isWriteOnlyTransactionOptimizationsEnabled() {
 226         return writeOnlyTransactionOptimizationsEnabled;
 227     }
 228
 229     public long getShardCommitQueueExpiryTimeoutInMillis() {
 230         return shardCommitQueueExpiryTimeoutInMillis;
 231     }
 232
 233     public boolean isTransactionDebugContextEnabled() {
 234         return transactionDebugContextEnabled;
 235     }
 236
 237     public int getShardSnapshotChunkSize() {
 238         return raftConfig.getSnapshotChunkSize();
 239     }
 240
 241     public static class Builder {
 242         private final DatastoreContext datastoreContext;
 243         private int maxShardDataChangeExecutorPoolSize =
 244                 InMemoryDOMDataStoreConfigProperties.DEFAULT_MAX_DATA_CHANGE_EXECUTOR_POOL_SIZE;
 245         private int maxShardDataChangeExecutorQueueSize =
 246                 InMemoryDOMDataStoreConfigProperties.DEFAULT_MAX_DATA_CHANGE_EXECUTOR_QUEUE_SIZE;
 247         private int maxShardDataChangeListenerQueueSize =
 248                 InMemoryDOMDataStoreConfigProperties.DEFAULT_MAX_DATA_CHANGE_LISTENER_QUEUE_SIZE;
 249         private int maxShardDataStoreExecutorQueueSize =
 250                 InMemoryDOMDataStoreConfigProperties.DEFAULT_MAX_DATA_STORE_EXECUTOR_QUEUE_SIZE;
 251
 252         private Builder(DatastoreContext datastoreContext) {
 253             this.datastoreContext = datastoreContext;
 254
 255             if(datastoreContext.getDataStoreProperties() != null) {
 256                 maxShardDataChangeExecutorPoolSize =
 257                         datastoreContext.getDataStoreProperties().getMaxDataChangeExecutorPoolSize();
 258                 maxShardDataChangeExecutorQueueSize =
 259                         datastoreContext.getDataStoreProperties().getMaxDataChangeExecutorQueueSize();
 260                 maxShardDataChangeListenerQueueSize =
 261                         datastoreContext.getDataStoreProperties().getMaxDataChangeListenerQueueSize();
 262                 maxShardDataStoreExecutorQueueSize =
 263                         datastoreContext.getDataStoreProperties().getMaxDataStoreExecutorQueueSize();
 264             }
 265         }
 266
 267         public Builder boundedMailboxCapacity(int boundedMailboxCapacity) {
 268             // TODO - this is defined in the yang DataStoreProperties but not currently used.
 269             return this;
 270         }
 271
 272         public Builder enableMetricCapture(boolean enableMetricCapture) {
 273             // TODO - this is defined in the yang DataStoreProperties but not currently used.
 274             return this;
 275         }
 276
 277
 278         public Builder shardTransactionIdleTimeout(long timeout, TimeUnit unit) {
 279             datastoreContext.shardTransactionIdleTimeout = Duration.create(timeout, unit);
 280             return this;
 281         }
 282
 283         public Builder shardTransactionIdleTimeoutInMinutes(long timeout) {
 284             return shardTransactionIdleTimeout(timeout, TimeUnit.MINUTES);
 285         }
 286
 287         public Builder operationTimeoutInSeconds(int operationTimeoutInSeconds) {
 288             datastoreContext.operationTimeoutInMillis = TimeUnit.SECONDS.toMillis(operationTimeoutInSeconds);
 289             return this;
 290         }
 291
 292         public Builder operationTimeoutInMillis(long operationTimeoutInMillis) {
 293             datastoreContext.operationTimeoutInMillis = operationTimeoutInMillis;
 294             return this;
 295         }
 296
 297         public Builder dataStoreMXBeanType(String dataStoreMXBeanType) {
 298             datastoreContext.dataStoreMXBeanType = dataStoreMXBeanType;
 299             return this;
 300         }
 301
 302         public Builder shardTransactionCommitTimeoutInSeconds(int shardTransactionCommitTimeoutInSeconds) {
 303             datastoreContext.shardTransactionCommitTimeoutInSeconds = shardTransactionCommitTimeoutInSeconds;
 304             return this;
 305         }
 306
 307         public Builder shardJournalRecoveryLogBatchSize(int shardJournalRecoveryLogBatchSize) {
 308             datastoreContext.setShardJournalRecoveryLogBatchSize(shardJournalRecoveryLogBatchSize);
 309             return this;
 310         }
 311
 312         public Builder shardSnapshotBatchCount(int shardSnapshotBatchCount) {
 313             datastoreContext.setSnapshotBatchCount(shardSnapshotBatchCount);
 314             return this;
 315         }
 316
 317         public Builder shardSnapshotDataThresholdPercentage(int shardSnapshotDataThresholdPercentage) {
 318             datastoreContext.setSnapshotDataThresholdPercentage(shardSnapshotDataThresholdPercentage);
 319             return this;
 320         }
 321
 322         public Builder shardHeartbeatIntervalInMillis(int shardHeartbeatIntervalInMillis) {
 323             datastoreContext.setHeartbeatInterval(shardHeartbeatIntervalInMillis);
 324             return this;
 325         }
 326
 327         public Builder shardTransactionCommitQueueCapacity(int shardTransactionCommitQueueCapacity) {
 328             datastoreContext.shardTransactionCommitQueueCapacity = shardTransactionCommitQueueCapacity;
 329             return this;
 330         }
 331
 332         public Builder shardInitializationTimeout(long timeout, TimeUnit unit) {
 333             datastoreContext.shardInitializationTimeout = new Timeout(timeout, unit);
 334             return this;
 335         }
 336
 337         public Builder shardInitializationTimeoutInSeconds(long timeout) {
 338             return shardInitializationTimeout(timeout, TimeUnit.SECONDS);
 339         }
 340
 341         public Builder shardLeaderElectionTimeout(long timeout, TimeUnit unit) {
 342             datastoreContext.shardLeaderElectionTimeout = new Timeout(timeout, unit);
 343             return this;
 344         }
 345
 346         public Builder shardLeaderElectionTimeoutInSeconds(long timeout) {
 347             return shardLeaderElectionTimeout(timeout, TimeUnit.SECONDS);
 348         }
 349
 350         public Builder configurationReader(AkkaConfigurationReader configurationReader){
 351             datastoreContext.configurationReader = configurationReader;
 352             return this;
 353         }
 354
 355         public Builder persistent(boolean persistent){
 356             datastoreContext.persistent = persistent;
 357             return this;
 358         }
 359
 360         public Builder shardIsolatedLeaderCheckIntervalInMillis(int shardIsolatedLeaderCheckIntervalInMillis) {
 361             datastoreContext.setIsolatedLeaderCheckInterval(shardIsolatedLeaderCheckIntervalInMillis);
 362             return this;
 363         }
 364
 365         public Builder shardElectionTimeoutFactor(long shardElectionTimeoutFactor){
 366             datastoreContext.setElectionTimeoutFactor(shardElectionTimeoutFactor);
 367             return this;
 368         }
 369
 370         public Builder transactionCreationInitialRateLimit(long initialRateLimit){
 371             datastoreContext.transactionCreationInitialRateLimit = initialRateLimit;
 372             return this;
 373         }
 374
 375         public Builder dataStoreType(String dataStoreType){
 376             datastoreContext.dataStoreType = dataStoreType;
 377             datastoreContext.dataStoreMXBeanType = "Distributed" + WordUtils.capitalize(dataStoreType) + "Datastore";
 378             return this;
 379         }
 380
 381         public Builder shardBatchedModificationCount(int shardBatchedModificationCount) {
 382             datastoreContext.shardBatchedModificationCount = shardBatchedModificationCount;
 383             return this;
 384         }
 385
 386         public Builder writeOnlyTransactionOptimizationsEnabled(boolean value) {
 387             datastoreContext.writeOnlyTransactionOptimizationsEnabled = value;
 388             return this;
 389         }
 390
 391         public Builder shardCommitQueueExpiryTimeoutInMillis(long value) {
 392             datastoreContext.shardCommitQueueExpiryTimeoutInMillis = value;
 393             return this;
 394         }
 395
 396         public Builder shardCommitQueueExpiryTimeoutInSeconds(long value) {
 397             datastoreContext.shardCommitQueueExpiryTimeoutInMillis = TimeUnit.MILLISECONDS.convert(
 398                     value, TimeUnit.SECONDS);
 399             return this;
 400         }
 401
 402         public Builder transactionDebugContextEnabled(boolean value) {
 403             datastoreContext.transactionDebugContextEnabled = value;
 404             return this;
 405         }
 406
 407         public Builder maxShardDataChangeExecutorPoolSize(int maxShardDataChangeExecutorPoolSize) {
 408             this.maxShardDataChangeExecutorPoolSize = maxShardDataChangeExecutorPoolSize;
 409             return this;
 410         }
 411
 412         public Builder maxShardDataChangeExecutorQueueSize(int maxShardDataChangeExecutorQueueSize) {
 413             this.maxShardDataChangeExecutorQueueSize = maxShardDataChangeExecutorQueueSize;
 414             return this;
 415         }
 416
 417         public Builder maxShardDataChangeListenerQueueSize(int maxShardDataChangeListenerQueueSize) {
 418             this.maxShardDataChangeListenerQueueSize = maxShardDataChangeListenerQueueSize;
 419             return this;
 420         }
 421
 422         public Builder maxShardDataStoreExecutorQueueSize(int maxShardDataStoreExecutorQueueSize) {
 423             this.maxShardDataStoreExecutorQueueSize = maxShardDataStoreExecutorQueueSize;
 424             return this;
 425         }
 426
 427         public DatastoreContext build() {
 428             datastoreContext.dataStoreProperties = InMemoryDOMDataStoreConfigProperties.create(
 429                     maxShardDataChangeExecutorPoolSize, maxShardDataChangeExecutorQueueSize,
 430                     maxShardDataChangeListenerQueueSize, maxShardDataStoreExecutorQueueSize);
 431
 432             if(datastoreContext.dataStoreType != null) {
 433                 globalDatastoreTypes.add(datastoreContext.dataStoreType);
 434             }
 435
 436             return datastoreContext;
 437         }
 438
 439         public Builder customRaftPolicyImplementation(String customRaftPolicyImplementation) {
 440             datastoreContext.setCustomRaftPolicyImplementation(customRaftPolicyImplementation);
 441             return this;
 442         }
 443
 444         public Builder shardSnapshotChunkSize(int shardSnapshotChunkSize) {
 445             datastoreContext.setShardSnapshotChunkSize(shardSnapshotChunkSize);
 446             return this;
 447         }
 448
 449         public Builder shardPeerAddressResolver(PeerAddressResolver resolver) {
 450             datastoreContext.setPeerAddressResolver(resolver);
 451             return this;
 452         }
 453     }
 454 }