BUG-6747: Race condition on peer connection
[bgpcep.git] / bgp / rib-impl / src / main / java / org / opendaylight / protocol / bgp / rib / impl / ExportPolicyPeerTrackerImpl.java
index ec61de5ea182b3f8d82cda2030e9210e9b65299a..4d5bbdbbb8d73e56f72d5c1d80c4a5437d515d50 100644 (file)
@@ -10,47 +10,42 @@ package org.opendaylight.protocol.bgp.rib.impl;
 import static java.util.function.Function.identity;
 import static java.util.stream.Collectors.toMap;
 
-import com.google.common.base.Optional;
 import com.google.common.base.Preconditions;
 import com.google.common.collect.ImmutableMap;
-import com.google.common.collect.Sets;
 import java.util.Collections;
 import java.util.EnumMap;
 import java.util.HashMap;
+import java.util.HashSet;
 import java.util.Map;
+import java.util.Optional;
 import java.util.Set;
 import java.util.stream.Collectors;
-import javax.annotation.Nonnull;
-import javax.annotation.Nullable;
+import javax.annotation.concurrent.GuardedBy;
+import javax.annotation.concurrent.ThreadSafe;
 import org.opendaylight.protocol.bgp.rib.spi.ExportPolicyPeerTracker;
 import org.opendaylight.protocol.bgp.rib.spi.IdentifierUtils;
 import org.opendaylight.protocol.bgp.rib.spi.PeerExportGroup;
 import org.opendaylight.protocol.bgp.rib.spi.PeerExportGroup.PeerExporTuple;
-import org.opendaylight.protocol.bgp.rib.spi.RibSupportUtils;
+import org.opendaylight.protocol.concepts.AbstractRegistration;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.SendReceive;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.PeerId;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.PeerRole;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.rib.peer.SupportedTables;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.SimpleRoutingPolicy;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.TablesKey;
-import org.opendaylight.yangtools.yang.binding.BindingMapping;
-import org.opendaylight.yangtools.yang.common.QName;
 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
-import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
-import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
-import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
-import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidateNode;
-import org.opendaylight.yangtools.yang.data.api.schema.tree.ModificationType;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+@ThreadSafe
 final class ExportPolicyPeerTrackerImpl implements ExportPolicyPeerTracker {
     private static final Logger LOG = LoggerFactory.getLogger(ExportPolicyPeerTrackerImpl.class);
-    private static final QName SEND_RECEIVE = QName.create(SupportedTables.QNAME, "send-receive").intern();
-    private static final NodeIdentifier SEND_RECEIVE_NID = new NodeIdentifier(SEND_RECEIVE);
+    @GuardedBy("this")
     private final Map<YangInstanceIdentifier, PeerRole> peerRoles = new HashMap<>();
-    private final Set<PeerId> peerTables = Sets.newHashSet();
-    private final PolicyDatabase policyDatabase;
+    @GuardedBy("this")
     private final Map<PeerId, SendReceive> peerAddPathTables = new HashMap<>();
+    @GuardedBy("this")
+    private final Set<PeerId> peerTables = new HashSet<>();
+    private final PolicyDatabase policyDatabase;
     private final TablesKey localTableKey;
     private volatile Map<PeerRole, PeerExportGroup> groups = Collections.emptyMap();
 
@@ -59,99 +54,70 @@ final class ExportPolicyPeerTrackerImpl implements ExportPolicyPeerTracker {
         this.localTableKey = localTablesKey;
     }
 
-    private Map<PeerRole, PeerExportGroup> createGroups(final Map<YangInstanceIdentifier, PeerRole> peerPathRoles) {
-        if (peerPathRoles.isEmpty()) {
-            return Collections.emptyMap();
-        }
-
-        final Map<PeerRole, Map<PeerId, PeerExporTuple>> immutablePeers = peerPathRoles.entrySet().stream()
-            .collect(Collectors.groupingBy(Map.Entry::getValue, toMap(peer -> IdentifierUtils.peerKeyToPeerId(peer
-            .getKey()), peer -> new PeerExporTuple(peer.getKey(), peer.getValue()))));
-
-        final Map<PeerRole, PeerExportGroup> ret = peerPathRoles.values().stream().collect(Collectors.toSet()).stream()
-            .collect(toMap(identity(), role -> new PeerExportGroupImpl(ImmutableMap.copyOf(immutablePeers.get(role)),
-                this.policyDatabase.exportPolicyForRole(role)), (oldKey, newKey) -> oldKey, () -> new EnumMap<>(PeerRole.class)));
+    private synchronized void createGroups(final Map<YangInstanceIdentifier, PeerRole> peerPathRoles) {
+        if (!peerPathRoles.isEmpty()) {
+            final Map<PeerRole, Map<PeerId, PeerExporTuple>> immutablePeers = peerPathRoles.entrySet().stream()
+                .collect(Collectors.groupingBy(Map.Entry::getValue, toMap(peer -> IdentifierUtils.peerKeyToPeerId(peer
+                    .getKey()), peer -> new PeerExporTuple(peer.getKey(), peer.getValue()))));
 
-        return ret;
+            this.groups = peerPathRoles.values().stream().collect(Collectors.toSet()).stream()
+                .collect(toMap(identity(), role -> new PeerExportGroupImpl(ImmutableMap.copyOf(immutablePeers.get(role)),
+                    this.policyDatabase.exportPolicyForRole(role)), (oldKey, newKey) -> oldKey, () -> new EnumMap<>(PeerRole.class)));
+        }
     }
 
     @Override
-    public void peerRoleChanged(@Nonnull final YangInstanceIdentifier peerPath, @Nullable final PeerRole role) {
-        /*
-         * This is a sledgehammer approach to the problem: modify the role map first,
-         * then construct the group map from scratch.
-         */
-        final PeerRole oldRole;
-        if (role != null) {
-            oldRole = this.peerRoles.put(peerPath, role);
-        } else {
-            oldRole = this.peerRoles.remove(peerPath);
+    public synchronized AbstractRegistration registerPeer(final PeerId peerId, final SendReceive sendReceive, final YangInstanceIdentifier peerPath,
+        final PeerRole peerRole, final Optional<SimpleRoutingPolicy> optSimpleRoutingPolicy) {
+        if (sendReceive != null) {
+            this.peerAddPathTables.put(peerId, sendReceive);
+            LOG.debug("Supported Add BestPath table {} added to peer {}", sendReceive, peerId);
         }
-
-        if (role != oldRole) {
-            LOG.debug("Peer {} changed role from {} to {}", peerPath, oldRole, role);
-            this.groups = createGroups(this.peerRoles);
+        final SimpleRoutingPolicy simpleRoutingPolicy = optSimpleRoutingPolicy.orElse(null);
+        if (SimpleRoutingPolicy.AnnounceNone != simpleRoutingPolicy) {
+            this.peerTables.add(peerId);
         }
-    }
-
-    @Override
-    public void onTablesChanged(final PeerId peerId, final DataTreeCandidateNode tablesChange) {
-        final NodeIdentifierWithPredicates supTablesKey = RibSupportUtils.toYangKey(SupportedTables.QNAME, this.localTableKey);
-        final DataTreeCandidateNode localTableNode = tablesChange.getModifiedChild(supTablesKey);
-        if (localTableNode != null) {
-            final Optional<NormalizedNode<?, ?>> dataAfter = localTableNode.getDataAfter();
-            processSupportedSendReceiveTables(localTableNode.getModifiedChild(SEND_RECEIVE_NID), peerId);
-            if (dataAfter.isPresent()) {
-                final boolean added = this.peerTables.add(peerId);
-                if (added) {
-                    LOG.debug("Supported table {} added to peer {}", this.localTableKey, peerId);
+        this.peerRoles.put(peerPath, peerRole);
+        LOG.debug("Supported table {} added to peer {} role {}", this.localTableKey, peerId, peerRole);
+        createGroups(this.peerRoles);
+
+        final Object lock = this;
+        return new AbstractRegistration() {
+            @Override
+            protected void removeRegistration() {
+                synchronized (lock) {
+                    final SendReceive sendReceiveValue = peerAddPathTables.remove(peerId);
+                    if (sendReceiveValue != null) {
+                        LOG.debug("Supported Add BestPath table {} removed to peer {}", sendReceiveValue, peerId);
+                    }
+                    peerTables.remove(peerId);
+                    LOG.debug("Removed peer {} from supported table {}", peerId, localTableKey);
+                    peerRoles.remove(peerPath);
+                    createGroups(peerRoles);
                 }
-            } else {
-                final NodeIdentifierWithPredicates value = (NodeIdentifierWithPredicates) localTableNode.getIdentifier();
-                this.peerTables.remove(peerId);
-                LOG.debug("Removed tables {} from peer {}", value, peerId);
             }
-        }
+        };
     }
 
     @Override
-    public PeerExportGroup getPeerGroup(final PeerRole role) {
+    public synchronized PeerExportGroup getPeerGroup(final PeerRole role) {
         return this.groups.get(Preconditions.checkNotNull(role));
     }
 
     @Override
-    public PeerRole getRole(final YangInstanceIdentifier peerId) {
-        return this.peerRoles.get(peerId);
-    }
-
-    private void processSupportedSendReceiveTables(final DataTreeCandidateNode sendReceiveModChild, final PeerId peerId) {
-        if (sendReceiveModChild != null) {
-            if (sendReceiveModChild.getModificationType().equals(ModificationType.DELETE)) {
-                final Optional<NormalizedNode<?, ?>> sendReceiveNode = sendReceiveModChild.getDataBefore();
-                if (sendReceiveNode.isPresent()) {
-                    final SendReceive sendReceiveValue = SendReceive.valueOf(BindingMapping.getClassName((String) sendReceiveNode.get().getValue()));
-                    this.peerAddPathTables.remove(peerId);
-                    LOG.debug("Supported Add BestPath table {} removed to peer {}", sendReceiveValue, peerId);
-                }
-            } else {
-                final Optional<NormalizedNode<?, ?>> sendReceiveNode = sendReceiveModChild.getDataAfter();
-                if (sendReceiveNode.isPresent()) {
-                    final SendReceive sendReceiveValue = SendReceive.valueOf(BindingMapping.getClassName((String) sendReceiveNode.get().getValue()));
-                    this.peerAddPathTables.put(peerId, sendReceiveValue);
-                    LOG.debug("Supported Add BestPath table {} added to peer {}", sendReceiveValue, peerId);
-                }
-            }
-        }
+    public synchronized boolean isTableSupported(final PeerId peerId) {
+        return this.peerTables.contains(peerId);
     }
 
     @Override
-    public boolean isTableSupported(final PeerId peerId) {
-        return this.peerTables.contains(peerId);
+    public synchronized PeerRole getRole(final YangInstanceIdentifier peerId) {
+        return this.peerRoles.get(peerId);
     }
 
     @Override
-    public boolean isAddPathSupportedByPeer(final PeerId peerId) {
+    public synchronized boolean isAddPathSupportedByPeer(final PeerId peerId) {
         final SendReceive sendReceive = this.peerAddPathTables.get(peerId);
         return sendReceive != null && (sendReceive.equals(SendReceive.Both) || sendReceive.equals(SendReceive.Receive));
     }
+
 }
\ No newline at end of file