BGPCEP-576: Neighbor’s local address configurable
[bgpcep.git] / bgp / rib-impl / src / main / java / org / opendaylight / protocol / bgp / rib / impl / config / BgpPeer.java
index 0641841998e7360e99a8b4e08f90131c3932d73e..fe4beb7b64215790bf9d987f97dcd5cece51c3d4 100644 (file)
@@ -9,11 +9,7 @@
 package org.opendaylight.protocol.bgp.rib.impl.config;
 
 import static java.util.Objects.requireNonNull;
-import static org.opendaylight.protocol.bgp.rib.impl.config.OpenConfigMappingUtil.getHoldTimer;
-import static org.opendaylight.protocol.bgp.rib.impl.config.OpenConfigMappingUtil.getPeerAs;
-import static org.opendaylight.protocol.bgp.rib.impl.config.OpenConfigMappingUtil.getSimpleRoutingPolicy;
 
-import com.google.common.base.Optional;
 import com.google.common.base.Preconditions;
 import com.google.common.collect.Iterables;
 import com.google.common.util.concurrent.Futures;
@@ -24,15 +20,17 @@ import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
 import java.util.Objects;
+import java.util.Optional;
 import java.util.Set;
 import javax.annotation.concurrent.GuardedBy;
+import org.apache.commons.lang3.StringUtils;
 import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
-import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceRegistration;
 import org.opendaylight.protocol.bgp.openconfig.spi.BGPTableTypeRegistryConsumer;
 import org.opendaylight.protocol.bgp.parser.BgpExtendedMessageUtil;
 import org.opendaylight.protocol.bgp.parser.spi.MultiprotocolCapabilitiesUtil;
 import org.opendaylight.protocol.bgp.rib.impl.BGPPeer;
 import org.opendaylight.protocol.bgp.rib.impl.spi.BGPDispatcher;
+import org.opendaylight.protocol.bgp.rib.impl.spi.BGPPeerRegistry;
 import org.opendaylight.protocol.bgp.rib.impl.spi.BGPSessionPreferences;
 import org.opendaylight.protocol.bgp.rib.impl.spi.RIB;
 import org.opendaylight.protocol.bgp.rib.spi.state.BGPPeerState;
@@ -41,8 +39,13 @@ import org.opendaylight.protocol.concepts.KeyMapping;
 import org.opendaylight.protocol.util.Ipv4Util;
 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.multiprotocol.rev151009.bgp.common.afi.safi.list.AfiSafi;
 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.AfiSafis;
+import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.Config;
 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbors.Neighbor;
+import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.peer.group.PeerGroup;
+import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.top.Bgp;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.open.message.BgpParameters;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.open.message.BgpParametersBuilder;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.open.message.bgp.parameters.OptionalCapabilities;
@@ -55,12 +58,15 @@ import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.mult
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.mp.capabilities.AddPathCapabilityBuilder;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.mp.capabilities.MultiprotocolCapabilityBuilder;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.mp.capabilities.add.path.capability.AddressFamilies;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.openconfig.extensions.rev180321.NeighborPeerGroupConfig;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.PeerRole;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.rib.TablesKey;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.ClusterIdentifier;
+import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 import org.osgi.framework.ServiceRegistration;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-
 public final class BgpPeer implements PeerBean, BGPPeerStateConsumer {
 
     private static final Logger LOG = LoggerFactory.getLogger(BgpPeer.class);
@@ -77,7 +83,7 @@ public final class BgpPeer implements PeerBean, BGPPeerStateConsumer {
         this.rpcRegistry = rpcRegistry;
     }
 
-    private static List<BgpParameters> getBgpParameters(final Neighbor neighbor, final RIB rib,
+    private static List<BgpParameters> getBgpParameters(final AfiSafis afiSafis, final RIB rib,
             final BGPTableTypeRegistryConsumer tableTypeRegistry) {
         final List<BgpParameters> tlvs = new ArrayList<>();
         final List<OptionalCapabilities> caps = new ArrayList<>();
@@ -89,8 +95,7 @@ public final class BgpPeer implements PeerBean, BGPPeerStateConsumer {
         caps.add(new OptionalCapabilitiesBuilder()
                 .setCParameters(MultiprotocolCapabilitiesUtil.RR_CAPABILITY).build());
 
-        final List<AfiSafi> afiSafi = OpenConfigMappingUtil
-                .getAfiSafiWithDefault(neighbor.getAfiSafis(), false);
+        final List<AfiSafi> afiSafi = OpenConfigMappingUtil.getAfiSafiWithDefault(afiSafis, false);
         final List<AddressFamilies> addPathCapability = OpenConfigMappingUtil
                 .toAddPathCapability(afiSafi, tableTypeRegistry);
         if (!addPathCapability.isEmpty()) {
@@ -121,27 +126,29 @@ public final class BgpPeer implements PeerBean, BGPPeerStateConsumer {
         if (key != null) {
             return Optional.of(Iterables.getOnlyElement(key.values()));
         }
-        return Optional.absent();
+        return Optional.empty();
     }
 
     @Override
-    public synchronized void start(final RIB rib, final Neighbor neighbor,
-            final BGPTableTypeRegistryConsumer tableTypeRegistry) {
+    public synchronized void start(final RIB rib, final Neighbor neighbor, final InstanceIdentifier<Bgp> bgpIid,
+            final PeerGroupConfigLoader peerGroupLoader, final BGPTableTypeRegistryConsumer tableTypeRegistry) {
         Preconditions.checkState(this.bgpPeerSingletonService == null,
                 "Previous peer instance was not closed.");
-        this.bgpPeerSingletonService = new BgpPeerSingletonService(rib, neighbor, tableTypeRegistry);
+
+        this.bgpPeerSingletonService = new BgpPeerSingletonService(rib, neighbor, bgpIid, peerGroupLoader,
+                tableTypeRegistry);
         this.currentConfiguration = neighbor;
     }
 
     @Override
-    public synchronized void restart(final RIB rib, final BGPTableTypeRegistryConsumer tableTypeRegistry) {
+    public synchronized void restart(final RIB rib, final InstanceIdentifier<Bgp> bgpIid,
+            final PeerGroupConfigLoader peerGroupLoader, final BGPTableTypeRegistryConsumer tableTypeRegistry) {
         Preconditions.checkState(this.currentConfiguration != null);
-        start(rib, this.currentConfiguration, tableTypeRegistry);
+        start(rib, this.currentConfiguration, bgpIid, peerGroupLoader, tableTypeRegistry);
     }
 
     @Override
     public synchronized void close() {
-        closeSingletonService();
         if (this.serviceRegistration != null) {
             this.serviceRegistration.unregister();
             this.serviceRegistration = null;
@@ -158,24 +165,18 @@ public final class BgpPeer implements PeerBean, BGPPeerStateConsumer {
     @Override
     public synchronized ListenableFuture<Void> closeServiceInstance() {
         if (this.bgpPeerSingletonService != null) {
-            return this.bgpPeerSingletonService.closeServiceInstance();
+            final ListenableFuture<Void> fut = this.bgpPeerSingletonService.closeServiceInstance();
+            this.bgpPeerSingletonService = null;
+            return fut;
         }
         return Futures.immediateFuture(null);
     }
 
-    private void closeSingletonService() {
-        if (this.bgpPeerSingletonService != null) {
-            try {
-                this.bgpPeerSingletonService.close();
-                this.bgpPeerSingletonService = null;
-            } catch (final Exception e) {
-                LOG.warn("Failed to close peer instance", e);
-            }
-        }
-    }
-
     @Override
-    public Boolean containsEqualConfiguration(final Neighbor neighbor) {
+    public synchronized Boolean containsEqualConfiguration(final Neighbor neighbor) {
+        if (this.currentConfiguration == null) {
+            return false;
+        }
         final AfiSafis actAfiSafi = this.currentConfiguration.getAfiSafis();
         final AfiSafis extAfiSafi = neighbor.getAfiSafis();
         final List<AfiSafi> actualSafi = actAfiSafi != null ? actAfiSafi.getAfiSafi() : Collections.emptyList();
@@ -197,7 +198,7 @@ public final class BgpPeer implements PeerBean, BGPPeerStateConsumer {
     }
 
     @Override
-    public BGPPeerState getPeerState() {
+    public synchronized BGPPeerState getPeerState() {
         if (this.bgpPeerSingletonService == null) {
             return null;
         }
@@ -208,48 +209,77 @@ public final class BgpPeer implements PeerBean, BGPPeerStateConsumer {
         this.serviceRegistration = serviceRegistration;
     }
 
-    private final class BgpPeerSingletonService implements BGPPeerStateConsumer, AutoCloseable {
-        private final boolean activeConnection;
+    synchronized void removePeer(final BGPPeerRegistry bgpPeerRegistry) {
+        if (BgpPeer.this.currentConfiguration != null) {
+            bgpPeerRegistry.removePeer(BgpPeer.this.currentConfiguration.getNeighborAddress());
+        }
+    }
+
+    private final class BgpPeerSingletonService implements BGPPeerStateConsumer {
+        private boolean activeConnection;
         private final BGPDispatcher dispatcher;
         private final InetSocketAddress inetAddress;
         private final int retryTimer;
         private final KeyMapping keys;
-        private ClusterSingletonServiceRegistration registration;
+        private final InetSocketAddress localAddress;
         private final BGPPeer bgpPeer;
         private final IpAddress neighborAddress;
         private final BGPSessionPreferences prefs;
         private Future<Void> connection;
-        @GuardedBy("this")
         private boolean isServiceInstantiated;
 
-        private BgpPeerSingletonService(final RIB rib, final Neighbor neighbor,
-                final BGPTableTypeRegistryConsumer tableTypeRegistry) {
+        private BgpPeerSingletonService(final RIB rib, final Neighbor neighbor, final InstanceIdentifier<Bgp> bgpIid,
+                final PeerGroupConfigLoader peerGroupLoader, final BGPTableTypeRegistryConsumer tableTypeRegistry) {
             this.neighborAddress = neighbor.getNeighborAddress();
-            final AfiSafis afisSAfis = requireNonNull(neighbor.getAfiSafis());
+
+            PeerGroup peerGroup = null;
+            String peerGroupName = null;
+            final Config neighborConfig = neighbor.getConfig();
+            if (neighborConfig != null) {
+                final NeighborPeerGroupConfig pgConfig = neighborConfig.getAugmentation(NeighborPeerGroupConfig.class);
+                if (pgConfig != null) {
+                    peerGroupName = StringUtils.substringBetween(pgConfig.getPeerGroup(), "=\"", "\"");
+                    peerGroup = peerGroupLoader.getPeerGroup(bgpIid, peerGroupName);
+                }
+            }
+            final AfiSafis afisSAfis;
+            if (peerGroup != null && peerGroup.getAfiSafis() != null) {
+                afisSAfis = peerGroup.getAfiSafis();
+            } else {
+                afisSAfis = requireNonNull(neighbor.getAfiSafis(), "Missing mandatory AFIs/SAFIs");
+            }
+
             final Set<TablesKey> afiSafisAdvertized = OpenConfigMappingUtil
                     .toTableKey(afisSAfis.getAfiSafi(), tableTypeRegistry);
-            this.bgpPeer = new BGPPeer(this.neighborAddress, rib,
-                    OpenConfigMappingUtil.toPeerRole(neighbor),
-                    getSimpleRoutingPolicy(neighbor), BgpPeer.this.rpcRegistry,
-                    afiSafisAdvertized, Collections.emptySet());
-            final List<BgpParameters> bgpParameters = getBgpParameters(neighbor, rib, tableTypeRegistry);
+
+            final PeerRole role = OpenConfigMappingUtil.toPeerRole(neighbor, peerGroup);
+            final ClusterIdentifier clusterId = OpenConfigMappingUtil
+                    .getNeighborClusterIdentifier(neighbor.getConfig());
+
+            this.bgpPeer = new BGPPeer(this.neighborAddress, peerGroupName, rib, role, clusterId,
+                    BgpPeer.this.rpcRegistry, afiSafisAdvertized, Collections.emptySet());
+
+            final List<BgpParameters> bgpParameters = getBgpParameters(afisSAfis, rib, tableTypeRegistry);
             final KeyMapping keyMapping = OpenConfigMappingUtil.getNeighborKey(neighbor);
-            this.prefs = new BGPSessionPreferences(rib.getLocalAs(), getHoldTimer(neighbor), rib.getBgpIdentifier(),
-                    getPeerAs(neighbor, rib), bgpParameters, getPassword(keyMapping));
-            this.activeConnection = OpenConfigMappingUtil.isActive(neighbor);
+            final IpAddress neighborLocalAddress = OpenConfigMappingUtil.getLocalAddress(neighbor.getTransport());
+            int hold = OpenConfigMappingUtil.getHoldTimer(neighbor, peerGroup);
+            final AsNumber ribAs = rib.getLocalAs();
+            final AsNumber neighborAs = OpenConfigMappingUtil.getPeerAs(neighbor, peerGroup, ribAs);
+
+            this.prefs = new BGPSessionPreferences(ribAs, hold, rib.getBgpIdentifier(),
+                    neighborAs, bgpParameters, getPassword(keyMapping));
+            this.activeConnection = OpenConfigMappingUtil.isActive(neighbor, peerGroup);
+            this.retryTimer = OpenConfigMappingUtil.getRetryTimer(neighbor, peerGroup);
             this.dispatcher = rib.getDispatcher();
-            this.inetAddress = Ipv4Util.toInetSocketAddress(this.neighborAddress,
-                    OpenConfigMappingUtil.getPort(neighbor));
-            this.retryTimer = OpenConfigMappingUtil.getRetryTimer(neighbor);
-            this.keys = keyMapping;
-        }
 
-        @Override
-        public void close() throws Exception {
-            if (this.registration != null) {
-                this.registration.close();
-                this.registration = null;
+            final PortNumber port = OpenConfigMappingUtil.getPort(neighbor, peerGroup);
+            this.inetAddress = Ipv4Util.toInetSocketAddress(this.neighborAddress, port);
+            if (neighborLocalAddress != null) {
+                this.localAddress = Ipv4Util.toInetSocketAddress(neighborLocalAddress, port);
+            } else {
+                this.localAddress = null;
             }
+            this.keys = keyMapping;
         }
 
         private synchronized void instantiateServiceInstance() {
@@ -258,8 +288,8 @@ public final class BgpPeer implements PeerBean, BGPPeerStateConsumer {
             this.bgpPeer.instantiateServiceInstance();
             this.dispatcher.getBGPPeerRegistry().addPeer(this.neighborAddress, this.bgpPeer, this.prefs);
             if (this.activeConnection) {
-                this.connection = this.dispatcher.createReconnectingClient(this.inetAddress, this.retryTimer,
-                        this.keys);
+                this.connection = this.dispatcher.createReconnectingClient(this.inetAddress, this.localAddress,
+                        this.retryTimer, this.keys);
             }
         }
 
@@ -275,9 +305,7 @@ public final class BgpPeer implements PeerBean, BGPPeerStateConsumer {
                 this.connection = null;
             }
             final ListenableFuture<Void> future = this.bgpPeer.close();
-            if (BgpPeer.this.currentConfiguration != null) {
-                this.dispatcher.getBGPPeerRegistry().removePeer(BgpPeer.this.currentConfiguration.getNeighborAddress());
-            }
+            removePeer(this.dispatcher.getBGPPeerRegistry());
             return future;
         }