bgp/openconfig-state/src/main/java/org/opendaylight/protocol/bgp/state/StateProviderImpl.java

   1 /*
   2  * Copyright (c) 2016 Cisco 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.protocol.bgp.state;
  10
  11 import static java.util.Objects.requireNonNull;
  12 import static java.util.concurrent.TimeUnit.SECONDS;
  13
  14 import java.util.HashMap;
  15 import java.util.HashSet;
  16 import java.util.List;
  17 import java.util.Map;
  18 import java.util.Set;
  19 import java.util.TimerTask;
  20 import java.util.concurrent.Executors;
  21 import java.util.concurrent.ScheduledExecutorService;
  22 import java.util.concurrent.ScheduledFuture;
  23 import java.util.stream.Collectors;
  24 import javax.annotation.Nonnull;
  25 import javax.annotation.concurrent.GuardedBy;
  26 import javax.annotation.concurrent.ThreadSafe;
  27 import org.opendaylight.controller.md.sal.binding.api.BindingTransactionChain;
  28 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  29 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  30 import org.opendaylight.controller.md.sal.common.api.data.AsyncTransaction;
  31 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  32 import org.opendaylight.controller.md.sal.common.api.data.TransactionChain;
  33 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
  34 import org.opendaylight.protocol.bgp.openconfig.spi.BGPTableTypeRegistryConsumer;
  35 import org.opendaylight.protocol.bgp.rib.spi.state.BGPPeerState;
  36 import org.opendaylight.protocol.bgp.rib.spi.state.BGPRibState;
  37 import org.opendaylight.protocol.bgp.rib.spi.state.BGPStateConsumer;
  38 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.top.Bgp;
  39 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.top.BgpBuilder;
  40 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.top.bgp.Global;
  41 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.top.bgp.Neighbors;
  42 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.top.bgp.PeerGroups;
  43 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.NetworkInstances;
  44 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.network.instances.NetworkInstance;
  45 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.network.instances.NetworkInstanceKey;
  46 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.network.instances.network.instance.Protocols;
  47 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.network.instances.network.instance.protocols.Protocol;
  48 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.network.instances.network.instance.protocols.ProtocolKey;
  49 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.policy.types.rev151009.BGP;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.openconfig.extensions.rev180329.NetworkInstanceProtocol;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.Rib;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.RibKey;
  53 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  54 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
  55 import org.slf4j.Logger;
  56 import org.slf4j.LoggerFactory;
  57
  58 @ThreadSafe
  59 public final class StateProviderImpl implements TransactionChainListener, AutoCloseable {
  60     private static final Logger LOG = LoggerFactory.getLogger(StateProviderImpl.class);
  61     private final BGPStateConsumer stateCollector;
  62     private final BGPTableTypeRegistryConsumer bgpTableTypeRegistry;
  63     private final KeyedInstanceIdentifier<NetworkInstance, NetworkInstanceKey> networkInstanceIId;
  64     private final int timeout;
  65     private final DataBroker dataBroker;
  66     @GuardedBy("this")
  67     private final Map<String, InstanceIdentifier<Bgp>> instanceIdentifiersCache = new HashMap<>();
  68     @GuardedBy("this")
  69     private BindingTransactionChain transactionChain;
  70     @GuardedBy("this")
  71     private ScheduledFuture<?> scheduleTask;
  72     private final ScheduledExecutorService scheduler = Executors.newScheduledThreadPool(1);
  73
  74     public StateProviderImpl(@Nonnull final DataBroker dataBroker, final int timeout,
  75             @Nonnull final BGPTableTypeRegistryConsumer bgpTableTypeRegistry,
  76             @Nonnull final BGPStateConsumer stateCollector,
  77             @Nonnull final String networkInstanceName) {
  78         this.dataBroker = requireNonNull(dataBroker);
  79         this.bgpTableTypeRegistry = requireNonNull(bgpTableTypeRegistry);
  80         this.stateCollector = requireNonNull(stateCollector);
  81         this.networkInstanceIId = InstanceIdentifier.create(NetworkInstances.class)
  82                 .child(NetworkInstance.class, new NetworkInstanceKey(networkInstanceName));
  83         this.timeout = timeout;
  84     }
  85
  86     public synchronized void init() {
  87         this.transactionChain = this.dataBroker.createTransactionChain(this);
  88         final TimerTask task = new TimerTask() {
  89             @Override
  90             @SuppressWarnings("checkstyle:IllegalCatch")
  91             public void run() {
  92                 synchronized (StateProviderImpl.this) {
  93                     final WriteTransaction wTx = StateProviderImpl.this.transactionChain.newWriteOnlyTransaction();
  94                     try {
  95                         updateBGPStats(wTx);
  96                     } catch (final Exception e) {
  97                         LOG.warn("Failed to update BGP Stats", e);
  98                     } finally {
  99                         wTx.submit();
 100                     }
 101                 }
 102             }
 103         };
 104
 105         this.scheduleTask = this.scheduler.scheduleAtFixedRate(task, 0, this.timeout, SECONDS);
 106     }
 107
 108     private synchronized void updateBGPStats(final WriteTransaction wtx) {
 109         final Set<String> oldStats = new HashSet<>(this.instanceIdentifiersCache.keySet());
 110         this.stateCollector.getRibStats().stream().filter(BGPRibState::isActive).forEach(bgpStateConsumer -> {
 111             final KeyedInstanceIdentifier<Rib, RibKey> ribId = bgpStateConsumer.getInstanceIdentifier();
 112             final List<BGPPeerState> peerStats = this.stateCollector.getPeerStats().stream()
 113                     .filter(BGPPeerState::isActive).filter(peerState -> ribId.equals(peerState.getInstanceIdentifier()))
 114                     .collect(Collectors.toList());
 115             storeOperationalState(bgpStateConsumer, peerStats, ribId.getKey().getId().getValue(), wtx);
 116             oldStats.remove(ribId.getKey().getId().getValue());
 117         });
 118         oldStats.forEach(ribId -> removeStoredOperationalState(ribId, wtx));
 119     }
 120
 121     private synchronized void removeStoredOperationalState(final String ribId, final WriteTransaction wtx) {
 122         final InstanceIdentifier<Bgp> bgpIID = this.instanceIdentifiersCache.remove(ribId);
 123         wtx.delete(LogicalDatastoreType.OPERATIONAL, bgpIID);
 124     }
 125
 126     private synchronized void storeOperationalState(final BGPRibState bgpStateConsumer,
 127             final List<BGPPeerState> peerStats, final String ribId, final WriteTransaction wtx) {
 128         final Global global = GlobalUtil.buildGlobal(bgpStateConsumer, this.bgpTableTypeRegistry);
 129         final PeerGroups peerGroups = PeerGroupUtil.buildPeerGroups(peerStats);
 130         final Neighbors neighbors = NeighborUtil.buildNeighbors(peerStats, this.bgpTableTypeRegistry);
 131         InstanceIdentifier<Bgp> bgpIID = this.instanceIdentifiersCache.get(ribId);
 132         if (bgpIID == null) {
 133             final ProtocolKey protocolKey = new ProtocolKey(BGP.class, bgpStateConsumer.getInstanceIdentifier()
 134                     .getKey().getId().getValue());
 135             final KeyedInstanceIdentifier<Protocol, ProtocolKey> protocolIId = this.networkInstanceIId
 136                     .child(Protocols.class).child(Protocol.class, protocolKey);
 137             bgpIID = protocolIId.augmentation(NetworkInstanceProtocol.class).child(Bgp.class);
 138             this.instanceIdentifiersCache.put(ribId, bgpIID);
 139         }
 140
 141         final Bgp bgp = new BgpBuilder().setGlobal(global).setNeighbors(neighbors).setPeerGroups(peerGroups).build();
 142         wtx.put(LogicalDatastoreType.OPERATIONAL, bgpIID, bgp, WriteTransaction.CREATE_MISSING_PARENTS);
 143     }
 144
 145     @Override
 146     public synchronized void close() throws Exception {
 147         this.scheduleTask.cancel(true);
 148         if (!this.instanceIdentifiersCache.keySet().isEmpty()) {
 149             final WriteTransaction wTx = this.transactionChain.newWriteOnlyTransaction();
 150             this.instanceIdentifiersCache.keySet().iterator()
 151                     .forEachRemaining(ribId -> removeStoredOperationalState(ribId, wTx));
 152             wTx.submit().get();
 153         }
 154         this.transactionChain.close();
 155         this.scheduler.shutdown();
 156     }
 157
 158     @Override
 159     public void onTransactionChainFailed(final TransactionChain<?, ?> chain, final AsyncTransaction<?, ?> transaction,
 160             final Throwable cause) {
 161         LOG.error("Transaction chain failed {}.", transaction != null ? transaction.getIdentifier() : null, cause);
 162     }
 163
 164     @Override
 165     public void onTransactionChainSuccessful(final TransactionChain<?, ?> chain) {
 166         LOG.debug("Transaction chain {} successful.", chain);
 167     }
 168 }