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 package org.opendaylight.protocol.bgp.state;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.annotations.VisibleForTesting;
  13 import com.google.common.util.concurrent.FutureCallback;
  14 import com.google.common.util.concurrent.MoreExecutors;
  15 import java.util.HashMap;
  16 import java.util.HashSet;
  17 import java.util.List;
  18 import java.util.Map;
  19 import java.util.Set;
  20 import java.util.TimerTask;
  21 import java.util.concurrent.Executors;
  22 import java.util.concurrent.ScheduledExecutorService;
  23 import java.util.concurrent.ScheduledFuture;
  24 import java.util.concurrent.TimeUnit;
  25 import java.util.concurrent.atomic.AtomicBoolean;
  26 import java.util.stream.Collectors;
  27 import javax.annotation.PreDestroy;
  28 import javax.inject.Inject;
  29 import javax.inject.Singleton;
  30 import org.checkerframework.checker.lock.qual.GuardedBy;
  31 import org.eclipse.jdt.annotation.NonNull;
  32 import org.opendaylight.mdsal.binding.api.DataBroker;
  33 import org.opendaylight.mdsal.binding.api.Transaction;
  34 import org.opendaylight.mdsal.binding.api.TransactionChain;
  35 import org.opendaylight.mdsal.binding.api.TransactionChainListener;
  36 import org.opendaylight.mdsal.binding.api.WriteOperations;
  37 import org.opendaylight.mdsal.binding.api.WriteTransaction;
  38 import org.opendaylight.mdsal.common.api.CommitInfo;
  39 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  40 import org.opendaylight.protocol.bgp.openconfig.spi.BGPTableTypeRegistryConsumer;
  41 import org.opendaylight.protocol.bgp.rib.spi.state.BGPPeerState;
  42 import org.opendaylight.protocol.bgp.rib.spi.state.BGPRibState;
  43 import org.opendaylight.protocol.bgp.rib.spi.state.BGPStateProvider;
  44 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.top.Bgp;
  45 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.top.BgpBuilder;
  46 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.top.bgp.Global;
  47 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.top.bgp.Neighbors;
  48 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.top.bgp.PeerGroups;
  49 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.OpenconfigNetworkInstanceData;
  50 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.NetworkInstances;
  51 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.network.instances.NetworkInstance;
  52 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.network.instances.NetworkInstanceKey;
  53 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.network.instances.network.instance.Protocols;
  54 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.network.instances.network.instance.protocols.Protocol;
  55 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.network.instances.network.instance.protocols.ProtocolKey;
  56 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.policy.types.rev151009.BGP;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.openconfig.extensions.rev180329.NetworkInstanceProtocol;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.Rib;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.RibKey;
  60 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  61 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
  62 import org.osgi.service.component.annotations.Activate;
  63 import org.osgi.service.component.annotations.Component;
  64 import org.osgi.service.component.annotations.Deactivate;
  65 import org.osgi.service.component.annotations.Reference;
  66 import org.osgi.service.component.annotations.RequireServiceComponentRuntime;
  67 import org.osgi.service.metatype.annotations.AttributeDefinition;
  68 import org.osgi.service.metatype.annotations.Designate;
  69 import org.osgi.service.metatype.annotations.ObjectClassDefinition;
  70 import org.slf4j.Logger;
  71 import org.slf4j.LoggerFactory;
  72
  73 // This class is thread-safe
  74 @Singleton
  75 @Component(service = {})
  76 @Designate(ocd = StateProviderImpl.Configuration.class)
  77 @RequireServiceComponentRuntime
  78 public final class StateProviderImpl implements TransactionChainListener, AutoCloseable {
  79     @ObjectClassDefinition
  80     public @interface Configuration {
  81         @AttributeDefinition(description = "Name of the OpenConfig network instance to which to bind")
  82         String networkInstanceName() default "global-bgp";
  83
  84         @AttributeDefinition(description = "Statistics update interval, in seconds", min = "1")
  85         int updateIntervalSeconds() default 5;
  86     }
  87
  88     private static final Logger LOG = LoggerFactory.getLogger(StateProviderImpl.class);
  89
  90     private final BGPStateProvider stateProvider;
  91     private final BGPTableTypeRegistryConsumer bgpTableTypeRegistry;
  92     private final KeyedInstanceIdentifier<NetworkInstance, NetworkInstanceKey> networkInstanceIId;
  93     private final DataBroker dataBroker;
  94     @GuardedBy("this")
  95     private final Map<String, InstanceIdentifier<Bgp>> instanceIdentifiersCache = new HashMap<>();
  96     @GuardedBy("this")
  97     private TransactionChain transactionChain;
  98     @GuardedBy("this")
  99     private final ScheduledFuture<?> scheduleTask;
 100     private final ScheduledExecutorService scheduler;
 101     private final AtomicBoolean closed = new AtomicBoolean(false);
 102
 103     @Activate
 104     public StateProviderImpl(@Reference final @NonNull DataBroker dataBroker,
 105             @Reference final @NonNull BGPTableTypeRegistryConsumer bgpTableTypeRegistry,
 106             @Reference final @NonNull BGPStateProvider stateProvider, final @NonNull Configuration configuration) {
 107         this(dataBroker, configuration.updateIntervalSeconds(), bgpTableTypeRegistry, stateProvider,
 108                 configuration.networkInstanceName());
 109     }
 110
 111     @Inject
 112     public StateProviderImpl(final @NonNull DataBroker dataBroker, final int timeout,
 113             final @NonNull BGPTableTypeRegistryConsumer bgpTableTypeRegistry,
 114             final @NonNull BGPStateProvider stateProvider,
 115             final @NonNull String networkInstanceName) {
 116         this(dataBroker, timeout, TimeUnit.SECONDS, bgpTableTypeRegistry, stateProvider, networkInstanceName,
 117                 Executors.newScheduledThreadPool(1));
 118     }
 119
 120     @VisibleForTesting
 121     StateProviderImpl(final @NonNull DataBroker dataBroker, final long period, final TimeUnit timeUnit,
 122             final @NonNull BGPTableTypeRegistryConsumer bgpTableTypeRegistry,
 123             final @NonNull BGPStateProvider stateProvider,
 124             final @NonNull String networkInstanceName, final @NonNull ScheduledExecutorService scheduler) {
 125         this.dataBroker = requireNonNull(dataBroker);
 126         this.bgpTableTypeRegistry = requireNonNull(bgpTableTypeRegistry);
 127         this.stateProvider = requireNonNull(stateProvider);
 128         networkInstanceIId =
 129             InstanceIdentifier.builderOfInherited(OpenconfigNetworkInstanceData.class, NetworkInstances.class).build()
 130                 .child(NetworkInstance.class, new NetworkInstanceKey(networkInstanceName));
 131         this.scheduler = scheduler;
 132
 133         transactionChain = this.dataBroker.createMergingTransactionChain(this);
 134         final TimerTask task = new TimerTask() {
 135             @Override
 136             @SuppressWarnings("checkstyle:IllegalCatch")
 137             public void run() {
 138                 synchronized (StateProviderImpl.this) {
 139                     final WriteTransaction wTx = transactionChain.newWriteOnlyTransaction();
 140                     try {
 141                         updateBGPStats(wTx);
 142                     } catch (final Exception e) {
 143                         LOG.warn("Failed to prepare Tx for BGP stats update", e);
 144                         wTx.cancel();
 145                         return;
 146                     }
 147
 148                     wTx.commit().addCallback(new FutureCallback<CommitInfo>() {
 149                         @Override
 150                         public void onSuccess(final CommitInfo result) {
 151                             LOG.debug("Successfully committed BGP stats update");
 152                         }
 153
 154                         @Override
 155                         public void onFailure(final Throwable ex) {
 156                             LOG.error("Failed to commit BGP stats update", ex);
 157                         }
 158                     }, MoreExecutors.directExecutor());
 159                 }
 160             }
 161         };
 162
 163         scheduleTask = this.scheduler.scheduleAtFixedRate(task, 0, period, timeUnit);
 164     }
 165
 166     private synchronized void updateBGPStats(final WriteOperations wtx) {
 167         final Set<String> oldStats = new HashSet<>(instanceIdentifiersCache.keySet());
 168         stateProvider.getRibStats().stream().filter(BGPRibState::isActive).forEach(bgpStateConsumer -> {
 169             final KeyedInstanceIdentifier<Rib, RibKey> ribId = bgpStateConsumer.getInstanceIdentifier();
 170             final List<BGPPeerState> peerStats = stateProvider.getPeerStats().stream()
 171                     .filter(BGPPeerState::isActive).filter(peerState -> ribId.equals(peerState.getInstanceIdentifier()))
 172                     .collect(Collectors.toList());
 173             storeOperationalState(bgpStateConsumer, peerStats, ribId.getKey().getId().getValue(), wtx);
 174             oldStats.remove(ribId.getKey().getId().getValue());
 175         });
 176         oldStats.forEach(ribId -> removeStoredOperationalState(ribId, wtx));
 177     }
 178
 179     private synchronized void removeStoredOperationalState(final String ribId, final WriteOperations wtx) {
 180         final InstanceIdentifier<Bgp> bgpIID = instanceIdentifiersCache.remove(ribId);
 181         wtx.delete(LogicalDatastoreType.OPERATIONAL, bgpIID);
 182     }
 183
 184     private synchronized void storeOperationalState(final BGPRibState bgpStateConsumer,
 185             final List<BGPPeerState> peerStats, final String ribId, final WriteOperations wtx) {
 186         final Global global = GlobalUtil.buildGlobal(bgpStateConsumer, bgpTableTypeRegistry);
 187         final PeerGroups peerGroups = PeerGroupUtil.buildPeerGroups(peerStats);
 188         final Neighbors neighbors = NeighborUtil.buildNeighbors(peerStats, bgpTableTypeRegistry);
 189         InstanceIdentifier<Bgp> bgpIID = instanceIdentifiersCache.get(ribId);
 190         if (bgpIID == null) {
 191             final ProtocolKey protocolKey = new ProtocolKey(BGP.VALUE, bgpStateConsumer.getInstanceIdentifier()
 192                     .getKey().getId().getValue());
 193             final KeyedInstanceIdentifier<Protocol, ProtocolKey> protocolIId = networkInstanceIId
 194                     .child(Protocols.class).child(Protocol.class, protocolKey);
 195             bgpIID = protocolIId.augmentation(NetworkInstanceProtocol.class).child(Bgp.class);
 196             instanceIdentifiersCache.put(ribId, bgpIID);
 197         }
 198
 199         final Bgp bgp = new BgpBuilder().setGlobal(global).setNeighbors(neighbors).setPeerGroups(peerGroups).build();
 200         wtx.mergeParentStructurePut(LogicalDatastoreType.OPERATIONAL, bgpIID, bgp);
 201     }
 202
 203     @Deactivate
 204     @PreDestroy
 205     @Override
 206     public synchronized void close() {
 207         if (closed.compareAndSet(false, true)) {
 208             scheduleTask.cancel(true);
 209             if (!instanceIdentifiersCache.isEmpty()) {
 210                 final WriteTransaction wTx = transactionChain.newWriteOnlyTransaction();
 211                 instanceIdentifiersCache.values()
 212                         .forEach(bgpIID -> wTx.delete(LogicalDatastoreType.OPERATIONAL, bgpIID));
 213                 instanceIdentifiersCache.clear();
 214                 wTx.commit().addCallback(new FutureCallback<CommitInfo>() {
 215                     @Override
 216                     public void onSuccess(final CommitInfo result) {
 217                         LOG.trace("Successfully operational stats removed.");
 218                     }
 219
 220                     @Override
 221                     public void onFailure(final Throwable throwable) {
 222                         LOG.error("Failed to clean up operational stats", throwable);
 223                     }
 224                 }, MoreExecutors.directExecutor());
 225             }
 226             transactionChain.close();
 227             scheduler.shutdown();
 228         }
 229     }
 230
 231     @Override
 232     public synchronized void onTransactionChainFailed(final TransactionChain chain, final Transaction transaction,
 233             final Throwable cause) {
 234         LOG.error("Transaction chain {} failed for tx {}",
 235                 chain, transaction != null ? transaction.getIdentifier() : null, cause);
 236
 237         if (!closed.get()) {
 238             transactionChain.close();
 239             transactionChain = dataBroker.createMergingTransactionChain(this);
 240         }
 241     }
 242
 243     @Override
 244     public void onTransactionChainSuccessful(final TransactionChain chain) {
 245         LOG.debug("Transaction chain {} successful.", chain);
 246     }
 247 }