bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/config/BgpDeployerImpl.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.rib.impl.config;
  10
  11 import static org.opendaylight.protocol.bgp.rib.impl.config.OpenConfigMappingUtil.getNeighborInstanceIdentifier;
  12 import static org.opendaylight.protocol.bgp.rib.impl.config.OpenConfigMappingUtil.getNeighborInstanceName;
  13 import static org.opendaylight.protocol.bgp.rib.impl.config.OpenConfigMappingUtil.getRibInstanceName;
  14
  15 import com.google.common.base.Preconditions;
  16 import com.google.common.util.concurrent.CheckedFuture;
  17 import com.google.common.util.concurrent.FutureCallback;
  18 import com.google.common.util.concurrent.Futures;
  19 import com.google.common.util.concurrent.ListenableFuture;
  20 import java.util.ArrayList;
  21 import java.util.Collection;
  22 import java.util.Dictionary;
  23 import java.util.HashMap;
  24 import java.util.Hashtable;
  25 import java.util.List;
  26 import java.util.Map;
  27 import javax.annotation.concurrent.GuardedBy;
  28 import org.opendaylight.controller.md.sal.binding.api.ClusteredDataTreeChangeListener;
  29 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  30 import org.opendaylight.controller.md.sal.binding.api.DataObjectModification;
  31 import org.opendaylight.controller.md.sal.binding.api.DataTreeIdentifier;
  32 import org.opendaylight.controller.md.sal.binding.api.DataTreeModification;
  33 import org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction;
  34 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  35 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  36 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  37 import org.opendaylight.protocol.bgp.openconfig.spi.BGPOpenConfigMappingService;
  38 import org.opendaylight.protocol.bgp.rib.impl.spi.BgpDeployer;
  39 import org.opendaylight.protocol.bgp.rib.impl.spi.InstanceType;
  40 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbors.Neighbor;
  41 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.top.Bgp;
  42 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.top.bgp.Global;
  43 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.top.bgp.Neighbors;
  44 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.NetworkInstances;
  45 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.network.instances.NetworkInstance;
  46 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.network.instances.NetworkInstanceBuilder;
  47 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.network.instances.NetworkInstanceKey;
  48 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.network.instances.network.instance.Protocols;
  49 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.network.instances.network.instance.ProtocolsBuilder;
  50 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.network.instances.network.instance.protocols.Protocol;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.openconfig.extensions.rev160614.Protocol1;
  52 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  53 import org.opendaylight.yangtools.yang.binding.DataObject;
  54 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  55 import org.osgi.framework.BundleContext;
  56 import org.osgi.framework.ServiceRegistration;
  57 import org.osgi.service.blueprint.container.BlueprintContainer;
  58 import org.slf4j.Logger;
  59 import org.slf4j.LoggerFactory;
  60
  61 public final class BgpDeployerImpl implements BgpDeployer, ClusteredDataTreeChangeListener<Bgp>, AutoCloseable {
  62     private static final Logger LOG = LoggerFactory.getLogger(BgpDeployerImpl.class);
  63     private final InstanceIdentifier<NetworkInstance> networkInstanceIId;
  64     private final BlueprintContainer container;
  65     private final BundleContext bundleContext;
  66     private final BGPOpenConfigMappingService mappingService;
  67     private final ListenerRegistration<BgpDeployerImpl> registration;
  68     @GuardedBy("this")
  69     private final Map<InstanceIdentifier<Bgp>, RibImpl> ribs = new HashMap<>();
  70     @GuardedBy("this")
  71     private final Map<InstanceIdentifier<Neighbor>, PeerBean> peers = new HashMap<>();
  72     private final DataBroker dataBroker;
  73     @GuardedBy("this")
  74     private boolean closed;
  75
  76     public BgpDeployerImpl(final String networkInstanceName, final BlueprintContainer container, final BundleContext bundleContext, final DataBroker dataBroker,
  77         final BGPOpenConfigMappingService mappingService) {
  78         this.dataBroker = Preconditions.checkNotNull(dataBroker);
  79         this.container = Preconditions.checkNotNull(container);
  80         this.bundleContext = Preconditions.checkNotNull(bundleContext);
  81         this.mappingService = Preconditions.checkNotNull(mappingService);
  82         this.networkInstanceIId = InstanceIdentifier.create(NetworkInstances.class)
  83             .child(NetworkInstance.class, new NetworkInstanceKey(networkInstanceName));
  84         Futures.addCallback(initializeNetworkInstance(dataBroker, this.networkInstanceIId), new FutureCallback<Void>() {
  85             @Override
  86             public void onSuccess(final Void result) {
  87                 LOG.debug("Network Instance {} initialized successfully.", networkInstanceName);
  88             }
  89
  90             @Override
  91             public void onFailure(final Throwable t) {
  92                 LOG.error("Failed to initialize Network Instance {}.", networkInstanceName, t);
  93             }
  94         });
  95         this.registration = dataBroker.registerDataTreeChangeListener(new DataTreeIdentifier<>(LogicalDatastoreType.CONFIGURATION,
  96             this.networkInstanceIId.child(Protocols.class).child(Protocol.class).augmentation(Protocol1.class).child(Bgp.class)), this);
  97         LOG.info("BGP Deployer {} started.", networkInstanceName);
  98     }
  99
 100     @Override
 101     public synchronized void onDataTreeChanged(final Collection<DataTreeModification<Bgp>> changes) {
 102         if (this.closed) {
 103             LOG.trace("BGP Deployer was already closed, skipping changes.");
 104             return;
 105         }
 106         for (final DataTreeModification<Bgp> dataTreeModification : changes) {
 107             final InstanceIdentifier<Bgp> rootIdentifier = dataTreeModification.getRootPath().getRootIdentifier();
 108             final DataObjectModification<Bgp> rootNode = dataTreeModification.getRootNode();
 109             LOG.trace("BGP configuration has changed: {}", rootNode);
 110             for (final DataObjectModification<? extends DataObject> dataObjectModification : rootNode.getModifiedChildren()) {
 111                 if (dataObjectModification.getDataType().equals(Global.class)) {
 112                     onGlobalChanged((DataObjectModification<Global>) dataObjectModification, rootIdentifier);
 113                 } else if (dataObjectModification.getDataType().equals(Neighbors.class)) {
 114                     onNeighborsChanged((DataObjectModification<Neighbors>) dataObjectModification, rootIdentifier);
 115                 }
 116             }
 117         }
 118     }
 119
 120     @Override
 121     public InstanceIdentifier<NetworkInstance> getInstanceIdentifier() {
 122         return this.networkInstanceIId;
 123     }
 124
 125     @Override
 126     public synchronized void close() throws Exception {
 127         this.registration.close();
 128         this.peers.values().forEach(PeerBean::close);
 129         this.peers.clear();
 130         this.ribs.values().forEach(RibImpl::close);
 131         this.ribs.clear();
 132         this.closed = true;
 133     }
 134
 135     private static CheckedFuture<Void, TransactionCommitFailedException> initializeNetworkInstance(final DataBroker dataBroker,
 136         final InstanceIdentifier<NetworkInstance> networkInstance) {
 137         final WriteTransaction wTx = dataBroker.newWriteOnlyTransaction();
 138         wTx.merge(LogicalDatastoreType.CONFIGURATION, networkInstance,
 139             new NetworkInstanceBuilder().setName(networkInstance.firstKeyOf(NetworkInstance.class).getName()).setProtocols(new ProtocolsBuilder().build()).build());
 140         return wTx.submit();
 141     }
 142
 143     private void onGlobalChanged(final DataObjectModification<Global> dataObjectModification,
 144         final InstanceIdentifier<Bgp> rootIdentifier) {
 145         switch (dataObjectModification.getModificationType()) {
 146         case DELETE:
 147             onGlobalRemoved(rootIdentifier);
 148             break;
 149         case SUBTREE_MODIFIED:
 150         case WRITE:
 151             onGlobalModified(rootIdentifier, dataObjectModification.getDataAfter(), null);
 152             break;
 153         default:
 154             break;
 155         }
 156     }
 157
 158     @Override
 159     public synchronized void onGlobalModified(final InstanceIdentifier<Bgp> rootIdentifier, final Global global,
 160         final WriteConfiguration configurationWriter) {
 161         LOG.debug("Modifying RIB instance with configuration: {}", global);
 162         //restart existing rib instance with a new configuration
 163         final RibImpl ribImpl = this.ribs.get(rootIdentifier);
 164         LOG.debug("RIB instance modified {}", ribImpl);
 165         if(ribImpl == null ) {
 166             onGlobalCreated(rootIdentifier, global, configurationWriter);
 167         } else if (!ribImpl.isGlobalEqual(global)) {
 168             onGlobalUpdated(rootIdentifier, global, ribImpl, configurationWriter);
 169         }
 170     }
 171
 172     private List<PeerBean> closeAllBindedPeers(final InstanceIdentifier<Bgp> rootIdentifier) {
 173         final List<PeerBean> filtered = new ArrayList<>();
 174         this.peers.entrySet().stream().filter(entry -> entry.getKey().contains(rootIdentifier)).forEach(entry -> {
 175             final PeerBean peer = entry.getValue();
 176             peer.close();
 177             filtered.add(peer);
 178         });
 179         return filtered;
 180     }
 181
 182     private synchronized void onGlobalCreated(final InstanceIdentifier<Bgp> rootIdentifier, final Global global,
 183         final WriteConfiguration configurationWriter) {
 184         LOG.debug("Creating RIB instance with configuration: {}", global);
 185         final RibImpl ribImpl = (RibImpl) this.container.getComponentInstance(InstanceType.RIB.getBeanName());
 186         initiateRibInstance(rootIdentifier, global, ribImpl, configurationWriter);
 187         this.ribs.put(rootIdentifier, ribImpl);
 188         LOG.debug("RIB instance created {}", ribImpl);
 189     }
 190
 191     private void onGlobalUpdated(final InstanceIdentifier<Bgp> rootIdentifier, final Global global, final RibImpl ribImpl,
 192         final WriteConfiguration configurationWriter) {
 193         final List<PeerBean> closedPeers = closeAllBindedPeers(rootIdentifier);
 194         ribImpl.close();
 195         initiateRibInstance(rootIdentifier, global, ribImpl, configurationWriter);
 196         closedPeers.forEach(peer -> peer.restart(ribImpl, this.mappingService));
 197     }
 198
 199     @Override
 200     public synchronized void onGlobalRemoved(final InstanceIdentifier<Bgp> rootIdentifier) {
 201         LOG.debug("Removing RIB instance: {}", rootIdentifier);
 202         final RibImpl ribImpl = this.ribs.remove(rootIdentifier);
 203         if (ribImpl != null) {
 204             LOG.debug("RIB instance removed {}", ribImpl);
 205             ribImpl.close();
 206         }
 207     }
 208
 209     private void registerRibInstance(final RibImpl ribImpl, final String ribInstanceName) {
 210         final Dictionary<String, String> properties = new Hashtable<>();
 211         properties.put(InstanceType.RIB.getBeanName(), ribInstanceName);
 212         final ServiceRegistration<?> serviceRegistration = this.bundleContext.registerService(InstanceType.RIB.getServices(), ribImpl, properties);
 213         ribImpl.setServiceRegistration(serviceRegistration);
 214     }
 215
 216     private void initiateRibInstance(final InstanceIdentifier<Bgp> rootIdentifier, final Global global,
 217         final RibImpl ribImpl, final WriteConfiguration configurationWriter) {
 218         final String ribInstanceName = getRibInstanceName(rootIdentifier);
 219         ribImpl.start(global, ribInstanceName, this.mappingService, configurationWriter);
 220         registerRibInstance(ribImpl, ribInstanceName);
 221     }
 222
 223     private void onNeighborsChanged(final DataObjectModification<Neighbors> dataObjectModification,
 224         final InstanceIdentifier<Bgp> rootIdentifier) {
 225         for (final DataObjectModification<? extends DataObject> neighborModification : dataObjectModification.getModifiedChildren()) {
 226             switch (neighborModification.getModificationType()) {
 227             case DELETE:
 228                 onNeighborRemoved(rootIdentifier, (Neighbor) neighborModification.getDataBefore());
 229                 break;
 230             case SUBTREE_MODIFIED:
 231             case WRITE:
 232                 onNeighborModified(rootIdentifier, (Neighbor) neighborModification.getDataAfter(), null);
 233                 break;
 234             default:
 235                 break;
 236             }
 237         }
 238     }
 239
 240     @Override
 241     public synchronized void onNeighborModified(final InstanceIdentifier<Bgp> rootIdentifier, final Neighbor neighbor,
 242         final WriteConfiguration configurationWriter) {
 243         LOG.debug("Modifying Peer instance with configuration: {}", neighbor);
 244         //restart peer instance with a new configuration
 245         final PeerBean bgpPeer = this.peers.get(getNeighborInstanceIdentifier(rootIdentifier, neighbor.getKey()));
 246         if (bgpPeer == null) {
 247             onNeighborCreated(rootIdentifier, neighbor, configurationWriter);
 248         } else if(!bgpPeer.containsEqualConfiguration(neighbor)){
 249             bgpPeer.close();
 250             final InstanceIdentifier<Neighbor> neighborInstanceIdentifier = getNeighborInstanceIdentifier(rootIdentifier, neighbor.getKey());
 251             initiatePeerInstance(rootIdentifier, neighborInstanceIdentifier, neighbor, bgpPeer, configurationWriter);
 252         }
 253         LOG.debug("Peer instance modified {}", bgpPeer);
 254     }
 255
 256     private synchronized void onNeighborCreated(final InstanceIdentifier<Bgp> rootIdentifier, final Neighbor neighbor,
 257         final WriteConfiguration configurationWriter) {
 258         LOG.debug("Creating Peer instance with configuration: {}", neighbor);
 259         final PeerBean bgpPeer;
 260         if (this.mappingService.isApplicationPeer(neighbor)) {
 261             bgpPeer = (PeerBean) this.container.getComponentInstance(InstanceType.APP_PEER.getBeanName());
 262         } else {
 263             bgpPeer = (PeerBean) this.container.getComponentInstance(InstanceType.PEER.getBeanName());
 264         }
 265         final InstanceIdentifier<Neighbor> neighborInstanceIdentifier = getNeighborInstanceIdentifier(rootIdentifier, neighbor.getKey());
 266         initiatePeerInstance(rootIdentifier, neighborInstanceIdentifier, neighbor, bgpPeer, configurationWriter);
 267         this.peers.put(neighborInstanceIdentifier, bgpPeer);
 268         LOG.debug("Peer instance created {}", bgpPeer);
 269     }
 270
 271     @Override
 272     public synchronized void onNeighborRemoved(final InstanceIdentifier<Bgp> rootIdentifier, final Neighbor neighbor) {
 273         LOG.debug("Removing Peer instance: {}", rootIdentifier);
 274         final PeerBean bgpPeer = this.peers.remove(getNeighborInstanceIdentifier(rootIdentifier, neighbor.getKey()));
 275         if (bgpPeer != null) {
 276             bgpPeer.close();
 277             LOG.debug("Peer instance removed {}", bgpPeer);
 278         }
 279     }
 280
 281     private void registerPeerInstance(final BgpPeer bgpPeer, final String peerInstanceName) {
 282         final Dictionary<String, String> properties = new Hashtable<>();
 283         properties.put(InstanceType.PEER.getBeanName(), peerInstanceName);
 284         final ServiceRegistration<?> serviceRegistration = this.bundleContext.registerService(InstanceType.PEER.getServices(), bgpPeer, properties);
 285         bgpPeer.setServiceRegistration(serviceRegistration);
 286     }
 287
 288     private void initiatePeerInstance(final InstanceIdentifier<Bgp> rootIdentifier, final InstanceIdentifier<Neighbor> neighborIdentifier, final Neighbor neighbor,
 289         final PeerBean bgpPeer, final WriteConfiguration configurationWriter) {
 290         final String peerInstanceName = getNeighborInstanceName(neighborIdentifier);
 291         final RibImpl rib = this.ribs.get(rootIdentifier);
 292         if (rib != null) {
 293             bgpPeer.start(rib, neighbor, this.mappingService, configurationWriter);
 294             if (bgpPeer instanceof BgpPeer) {
 295                 registerPeerInstance((BgpPeer) bgpPeer, peerInstanceName);
 296             }
 297         }
 298     }
 299
 300     @Override
 301     public BGPOpenConfigMappingService getMappingService() {
 302         return this.mappingService;
 303     }
 304
 305     @Override
 306     public <T extends DataObject> ListenableFuture<Void> writeConfiguration(final T data, final InstanceIdentifier<T> identifier) {
 307         final ReadWriteTransaction wTx = this.dataBroker.newReadWriteTransaction();
 308         wTx.put(LogicalDatastoreType.CONFIGURATION, identifier, data);
 309         return wTx.submit();
 310     }
 311
 312     @Override
 313     public <T extends DataObject> ListenableFuture<Void> removeConfiguration(
 314         final InstanceIdentifier<T> identifier) {
 315         final WriteTransaction wTx = this.dataBroker.newWriteOnlyTransaction();
 316         wTx.delete(LogicalDatastoreType.CONFIGURATION, identifier);
 317         return wTx.submit();
 318     }
 319 }