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

   1 /*
   2  * Copyright (c) 2020 PANTHEON.tech, s.r.o. 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 package org.opendaylight.controller.cluster.databroker;
   9
  10 import com.google.common.annotations.Beta;
  11 import com.google.common.collect.ClassToInstanceMap;
  12 import com.google.common.collect.ImmutableMap;
  13 import java.util.concurrent.ExecutorService;
  14 import java.util.concurrent.TimeUnit;
  15 import org.opendaylight.controller.md.sal.common.util.jmx.ThreadExecutorStatsMXBeanImpl;
  16 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  17 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
  18 import org.opendaylight.mdsal.dom.api.DOMDataBrokerExtension;
  19 import org.opendaylight.mdsal.dom.api.DOMDataTreeReadTransaction;
  20 import org.opendaylight.mdsal.dom.api.DOMDataTreeReadWriteTransaction;
  21 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
  22 import org.opendaylight.mdsal.dom.api.DOMTransactionChain;
  23 import org.opendaylight.mdsal.dom.api.DOMTransactionChainListener;
  24 import org.opendaylight.mdsal.dom.spi.store.DOMStore;
  25 import org.opendaylight.yangtools.util.DurationStatisticsTracker;
  26 import org.opendaylight.yangtools.util.concurrent.SpecialExecutors;
  27 import org.osgi.service.component.annotations.Activate;
  28 import org.osgi.service.component.annotations.Component;
  29 import org.osgi.service.component.annotations.Deactivate;
  30 import org.osgi.service.component.annotations.Reference;
  31 import org.osgi.service.metatype.annotations.AttributeDefinition;
  32 import org.osgi.service.metatype.annotations.Designate;
  33 import org.osgi.service.metatype.annotations.ObjectClassDefinition;
  34 import org.slf4j.Logger;
  35 import org.slf4j.LoggerFactory;
  36
  37 @Beta
  38 @Component(immediate = true, configurationPid = "org.opendaylight.controller.cluster.datastore.broker",
  39     property = "type=default")
  40 @Designate(ocd = OSGiDOMDataBroker.Config.class)
  41 public final class OSGiDOMDataBroker implements DOMDataBroker {
  42     @ObjectClassDefinition
  43     public @interface Config {
  44         @AttributeDefinition(name = "max-data-broker-future-callback-queue-size")
  45         int callbackQueueSize() default 1000;
  46         @AttributeDefinition(name = "max-data-broker-future-callback-pool-size")
  47         int callbackPoolSize() default 20;
  48     }
  49
  50     private static final Logger LOG = LoggerFactory.getLogger(OSGiDOMDataBroker.class);
  51
  52     @Reference(target = "(type=distributed-config)")
  53     DOMStore configDatastore = null;
  54     @Reference(target = "(type=distributed-operational)")
  55     DOMStore operDatastore = null;
  56
  57     private ExecutorService executorService;
  58     private ConcurrentDOMDataBroker delegate;
  59     private CommitStatsMXBeanImpl commitStats;
  60     private ThreadExecutorStatsMXBeanImpl threadStats;
  61
  62     @Override
  63     public DOMDataTreeReadTransaction newReadOnlyTransaction() {
  64         return delegate.newReadOnlyTransaction();
  65     }
  66
  67     @Override
  68     public DOMDataTreeWriteTransaction newWriteOnlyTransaction() {
  69         return delegate.newWriteOnlyTransaction();
  70     }
  71
  72     @Override
  73     public DOMDataTreeReadWriteTransaction newReadWriteTransaction() {
  74         return delegate.newReadWriteTransaction();
  75     }
  76
  77     @Override
  78     public ClassToInstanceMap<DOMDataBrokerExtension> getExtensions() {
  79         return delegate.getExtensions();
  80     }
  81
  82     @Override
  83     public DOMTransactionChain createTransactionChain(final DOMTransactionChainListener listener) {
  84         return delegate.createTransactionChain(listener);
  85     }
  86
  87     @Override
  88     public DOMTransactionChain createMergingTransactionChain(final DOMTransactionChainListener listener) {
  89         return delegate.createMergingTransactionChain(listener);
  90     }
  91
  92     @Activate
  93     void activate(final Config config) {
  94         LOG.info("DOM Data Broker starting");
  95         final DurationStatisticsTracker commitStatsTracker = DurationStatisticsTracker.createConcurrent();
  96
  97         executorService = SpecialExecutors.newBlockingBoundedCachedThreadPool(config.callbackPoolSize(),
  98             config.callbackQueueSize(), "CommitFutures", ConcurrentDOMDataBroker.class);
  99         delegate = new ConcurrentDOMDataBroker(ImmutableMap.of(
 100             LogicalDatastoreType.CONFIGURATION, configDatastore, LogicalDatastoreType.OPERATIONAL, operDatastore),
 101             executorService, commitStatsTracker);
 102
 103         commitStats = new CommitStatsMXBeanImpl(commitStatsTracker, "DOMDataBroker");
 104         commitStats.register();
 105         threadStats = ThreadExecutorStatsMXBeanImpl.create(executorService, "CommitFutureExecutorStats",
 106             "DOMDataBroker");
 107
 108         LOG.info("DOM Data Broker started");
 109     }
 110
 111     @Deactivate
 112     void deactivate() {
 113         LOG.info("DOM Data Broker stopping");
 114         commitStats.unregister();
 115         if (threadStats != null) {
 116             threadStats.unregister();
 117         }
 118
 119         delegate.close();
 120         executorService.shutdown();
 121         try {
 122             executorService.awaitTermination(1, TimeUnit.MINUTES);
 123         } catch (InterruptedException e) {
 124             LOG.warn("Future executor failed to finish in time, giving up", e);
 125         }
 126         LOG.info("DOM Data Broker stopped");
 127     }
 128 }