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