Bump odlparent to 6.0.0
[bgpcep.git] / bgp / rib-impl / src / main / java / org / opendaylight / protocol / bgp / rib / impl / config / BgpPeer.java
index e9df6da34d0d370d76feaecf7f52ab332efbdc90..4dd599dfad4d2b2a78c0db5ee6acbbb8d45286c1 100644 (file)
@@ -5,7 +5,6 @@
  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
  * and is available at http://www.eclipse.org/legal/epl-v10.html
  */
-
 package org.opendaylight.protocol.bgp.rib.impl.config;
 
 import static java.util.Objects.requireNonNull;
@@ -13,22 +12,27 @@ import static java.util.Objects.requireNonNull;
 import com.google.common.base.Preconditions;
 import com.google.common.collect.Iterables;
 import com.google.common.util.concurrent.FluentFuture;
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import io.netty.util.concurrent.Future;
 import java.net.InetSocketAddress;
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
+import java.util.Map;
 import java.util.Objects;
 import java.util.Optional;
 import java.util.Set;
-import javax.annotation.concurrent.GuardedBy;
+import java.util.stream.Collectors;
 import org.apache.commons.lang3.StringUtils;
-import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
+import org.checkerframework.checker.lock.qual.GuardedBy;
+import org.opendaylight.mdsal.binding.api.RpcProviderService;
 import org.opendaylight.mdsal.common.api.CommitInfo;
 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.parser.spi.RevisedErrorHandlingSupport;
 import org.opendaylight.protocol.bgp.rib.impl.BGPPeer;
+import org.opendaylight.protocol.bgp.rib.impl.BgpPeerUtil;
 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;
@@ -47,7 +51,6 @@ import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.
 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.rev180329.open.message.BgpParameters;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.open.message.BgpParametersBuilder;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.open.message.bgp.parameters.OptionalCapabilities;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.open.message.bgp.parameters.OptionalCapabilitiesBuilder;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.open.message.bgp.parameters.optional.capabilities.CParametersBuilder;
@@ -67,11 +70,11 @@ import org.osgi.framework.ServiceRegistration;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-public final class BgpPeer implements PeerBean, BGPPeerStateConsumer {
+public class BgpPeer implements PeerBean, BGPPeerStateConsumer {
 
     private static final Logger LOG = LoggerFactory.getLogger(BgpPeer.class);
 
-    private final RpcProviderRegistry rpcRegistry;
+    private final RpcProviderService rpcRegistry;
     @GuardedBy("this")
     private ServiceRegistration<?> serviceRegistration;
     @GuardedBy("this")
@@ -79,13 +82,14 @@ public final class BgpPeer implements PeerBean, BGPPeerStateConsumer {
     @GuardedBy("this")
     private BgpPeerSingletonService bgpPeerSingletonService;
 
-    public BgpPeer(final RpcProviderRegistry rpcRegistry) {
+    public BgpPeer(final RpcProviderService rpcRegistry) {
         this.rpcRegistry = rpcRegistry;
     }
 
-    private static List<BgpParameters> getBgpParameters(final AfiSafis afiSafis, final RIB rib,
-            final BGPTableTypeRegistryConsumer tableTypeRegistry) {
-        final List<BgpParameters> tlvs = new ArrayList<>();
+    @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD",
+            justification = "https://github.com/spotbugs/spotbugs/issues/811")
+    private static List<OptionalCapabilities> getBgpCapabilities(final AfiSafis afiSafis, final RIB rib,
+                                                          final BGPTableTypeRegistryConsumer tableTypeRegistry) {
         final List<OptionalCapabilities> caps = new ArrayList<>();
         caps.add(new OptionalCapabilitiesBuilder().setCParameters(new CParametersBuilder().setAs4BytesCapability(
                 new As4BytesCapabilityBuilder().setAsNumber(rib.getLocalAs()).build()).build()).build());
@@ -109,8 +113,8 @@ public final class BgpPeer implements PeerBean, BGPPeerStateConsumer {
         final List<BgpTableType> tableTypes = OpenConfigMappingUtil.toTableTypes(afiSafi, tableTypeRegistry);
         for (final BgpTableType tableType : tableTypes) {
             if (!rib.getLocalTables().contains(tableType)) {
-                LOG.info("RIB instance does not list {} " +
-                        "in its local tables. Incoming data will be dropped.", tableType);
+                LOG.info("RIB instance does not list {} in its local tables. Incoming data will be dropped.",
+                    tableType);
             }
 
             caps.add(new OptionalCapabilitiesBuilder().setCParameters(
@@ -118,10 +122,11 @@ public final class BgpPeer implements PeerBean, BGPPeerStateConsumer {
                             new CParameters1Builder().setMultiprotocolCapability(
                                     new MultiprotocolCapabilityBuilder(tableType).build()).build()).build()).build());
         }
-        tlvs.add(new BgpParametersBuilder().setOptionalCapabilities(caps).build());
-        return tlvs;
+        return caps;
     }
 
+    @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD",
+            justification = "https://github.com/spotbugs/spotbugs/issues/811")
     private static Optional<byte[]> getPassword(final KeyMapping key) {
         if (key != null) {
             return Optional.of(Iterables.getOnlyElement(key.values()));
@@ -148,7 +153,7 @@ public final class BgpPeer implements PeerBean, BGPPeerStateConsumer {
     }
 
     @Override
-    public synchronized void close() {
+    public void close() {
         if (this.serviceRegistration != null) {
             this.serviceRegistration.unregister();
             this.serviceRegistration = null;
@@ -227,6 +232,10 @@ public final class BgpPeer implements PeerBean, BGPPeerStateConsumer {
         private final BGPSessionPreferences prefs;
         private Future<Void> connection;
         private boolean isServiceInstantiated;
+        private final List<OptionalCapabilities> finalCapabilities;
+        private final int gracefulRestartTimer;
+        private final RevisedErrorHandlingSupport errorHandling;
+
 
         private BgpPeerSingletonService(final RIB rib, final Neighbor neighbor, final InstanceIdentifier<Bgp> bgpIid,
                 final PeerGroupConfigLoader peerGroupLoader, final BGPTableTypeRegistryConsumer tableTypeRegistry) {
@@ -242,34 +251,44 @@ public final class BgpPeer implements PeerBean, BGPPeerStateConsumer {
                     peerGroup = peerGroupLoader.getPeerGroup(bgpIid, peerGroupName);
                 }
             }
-            final AfiSafis afisSAfis;
+            final AfiSafis afisSafis;
             if (peerGroup != null && peerGroup.getAfiSafis() != null) {
-                afisSAfis = peerGroup.getAfiSafis();
+                afisSafis = peerGroup.getAfiSafis();
             } else {
-                afisSAfis = requireNonNull(neighbor.getAfiSafis(), "Missing mandatory AFIs/SAFIs");
+                afisSafis = requireNonNull(neighbor.getAfiSafis(), "Missing mandatory AFIs/SAFIs");
             }
 
             final Set<TablesKey> afiSafisAdvertized = OpenConfigMappingUtil
-                    .toTableKey(afisSAfis.getAfiSafi(), tableTypeRegistry);
+                    .toTableKey(afisSafis.getAfiSafi(), tableTypeRegistry);
             final PeerRole role = OpenConfigMappingUtil.toPeerRole(neighbor, peerGroup);
+
             final ClusterIdentifier clusterId = OpenConfigMappingUtil
                     .getNeighborClusterIdentifier(neighbor.getRouteReflector(), peerGroup);
-            final List<BgpParameters> bgpParameters = getBgpParameters(afisSAfis, rib, tableTypeRegistry);
+            final int hold = OpenConfigMappingUtil.getHoldTimer(neighbor, peerGroup);
+            this.gracefulRestartTimer = OpenConfigMappingUtil.getGracefulRestartTimer(neighbor,
+                    peerGroup, hold);
+            final Set<TablesKey> gracefulTables = GracefulRestartUtil.getGracefulTables(afisSafis.getAfiSafi(),
+                    tableTypeRegistry);
+            final Map<TablesKey, Integer> llGracefulTimers = GracefulRestartUtil
+                    .getLlGracefulTimers(afisSafis.getAfiSafi(), tableTypeRegistry);
+            this.finalCapabilities = getBgpCapabilities(afisSafis, rib, tableTypeRegistry);
+            final List<BgpParameters> bgpParameters = getInitialBgpParameters(gracefulTables, llGracefulTimers);
             final KeyMapping keyMapping = OpenConfigMappingUtil.getNeighborKey(neighbor);
             final IpAddress neighborLocalAddress = OpenConfigMappingUtil.getLocalAddress(neighbor.getTransport());
-            int hold = OpenConfigMappingUtil.getHoldTimer(neighbor, peerGroup);
             final AsNumber globalAs = rib.getLocalAs();
             final AsNumber neighborRemoteAs = OpenConfigMappingUtil
                     .getRemotePeerAs(neighbor.getConfig(), peerGroup, globalAs);
             final AsNumber neighborLocalAs;
-            if(role == PeerRole.Ebgp) {
+            if (role == PeerRole.Ebgp) {
                 neighborLocalAs = OpenConfigMappingUtil.getLocalPeerAs(neighbor.getConfig(), globalAs);
             } else {
                 neighborLocalAs = globalAs;
             }
 
+            this.errorHandling = OpenConfigMappingUtil.getRevisedErrorHandling(role, peerGroup, neighbor);
             this.bgpPeer = new BGPPeer(tableTypeRegistry, this.neighborAddress, peerGroupName, rib, role, clusterId,
-                    neighborLocalAs, BgpPeer.this.rpcRegistry, afiSafisAdvertized, Collections.emptySet());
+                    neighborLocalAs, BgpPeer.this.rpcRegistry, afiSafisAdvertized, gracefulTables, llGracefulTimers,
+                    BgpPeer.this);
             this.prefs = new BGPSessionPreferences(neighborLocalAs, hold, rib.getBgpIdentifier(),
                     neighborRemoteAs, bgpParameters, getPassword(keyMapping));
             this.activeConnection = OpenConfigMappingUtil.isActive(neighbor, peerGroup);
@@ -286,7 +305,17 @@ public final class BgpPeer implements PeerBean, BGPPeerStateConsumer {
             this.keys = keyMapping;
         }
 
-        private synchronized void instantiateServiceInstance() {
+        private List<BgpParameters> getInitialBgpParameters(final Set<TablesKey> gracefulTables,
+                                                            final Map<TablesKey, Integer> llGracefulTimers) {
+            final Set<BgpPeerUtil.LlGracefulRestartDTO> llGracefulRestarts = llGracefulTimers.entrySet().stream()
+                    .map(entry -> new BgpPeerUtil.LlGracefulRestartDTO(entry.getKey(), entry.getValue(), false))
+                    .collect(Collectors.toSet());
+            return Collections.singletonList(
+                    GracefulRestartUtil.getGracefulBgpParameters(this.finalCapabilities, gracefulTables,
+                            Collections.emptySet(), gracefulRestartTimer, false, llGracefulRestarts));
+        }
+
+        synchronized void instantiateServiceInstance() {
             this.isServiceInstantiated = true;
             LOG.info("Peer instantiated {}", this.neighborAddress);
             this.bgpPeer.instantiateServiceInstance();
@@ -297,7 +326,7 @@ public final class BgpPeer implements PeerBean, BGPPeerStateConsumer {
             }
         }
 
-        private synchronized FluentFuture<? extends CommitInfo> closeServiceInstance() {
+        synchronized FluentFuture<? extends CommitInfo> closeServiceInstance() {
             if (!this.isServiceInstantiated) {
                 LOG.info("Peer {} already closed", this.neighborAddress);
                 return CommitInfo.emptyFluentFuture();
@@ -318,4 +347,16 @@ public final class BgpPeer implements PeerBean, BGPPeerStateConsumer {
             return this.bgpPeer.getPeerState();
         }
     }
+
+    public synchronized List<OptionalCapabilities> getBgpFixedCapabilities() {
+        return this.bgpPeerSingletonService.finalCapabilities;
+    }
+
+    public synchronized int getGracefulRestartTimer() {
+        return this.bgpPeerSingletonService.gracefulRestartTimer;
+    }
+
+    public synchronized Optional<RevisedErrorHandlingSupport> getErrorHandling() {
+        return Optional.ofNullable(this.bgpPeerSingletonService.errorHandling);
+    }
 }