Adding ability to synchronize topology clusters' broadcast trees.

Proxy ARP now supports deferred ARP replies until instance learns of the subject host location.

Change-Id: Ib3ee97c0812858b5b4972d945e9e6d2bd397d4c5
diff --git a/core/store/dist/src/main/java/org/onosproject/store/topology/impl/DistributedTopologyStore.java b/core/store/dist/src/main/java/org/onosproject/store/topology/impl/DistributedTopologyStore.java
index 3a0f185..487fad9 100644
--- a/core/store/dist/src/main/java/org/onosproject/store/topology/impl/DistributedTopologyStore.java
+++ b/core/store/dist/src/main/java/org/onosproject/store/topology/impl/DistributedTopologyStore.java
@@ -16,19 +16,25 @@
 package org.onosproject.store.topology.impl;
 
 import static com.google.common.base.Preconditions.checkArgument;
+import static org.onlab.util.Tools.isNullOrEmpty;
 import static org.onosproject.net.topology.TopologyEvent.Type.TOPOLOGY_CHANGED;
 import static org.slf4j.LoggerFactory.getLogger;
 
 import java.util.Collections;
 import java.util.List;
 import java.util.Set;
+import java.util.stream.Collectors;
 
 import org.apache.felix.scr.annotations.Activate;
 import org.apache.felix.scr.annotations.Component;
 import org.apache.felix.scr.annotations.Deactivate;
+import org.apache.felix.scr.annotations.Reference;
+import org.apache.felix.scr.annotations.ReferenceCardinality;
 import org.apache.felix.scr.annotations.Service;
+import org.onlab.util.KryoNamespace;
 import org.onosproject.common.DefaultTopology;
 import org.onosproject.event.Event;
+import org.onosproject.mastership.MastershipService;
 import org.onosproject.net.ConnectPoint;
 import org.onosproject.net.Device;
 import org.onosproject.net.DeviceId;
@@ -46,6 +52,12 @@
 import org.onosproject.net.topology.TopologyStore;
 import org.onosproject.net.topology.TopologyStoreDelegate;
 import org.onosproject.store.AbstractStore;
+import org.onosproject.store.serializers.KryoNamespaces;
+import org.onosproject.store.service.EventuallyConsistentMap;
+import org.onosproject.store.service.EventuallyConsistentMapEvent;
+import org.onosproject.store.service.EventuallyConsistentMapListener;
+import org.onosproject.store.service.LogicalClockService;
+import org.onosproject.store.service.StorageService;
 import org.slf4j.Logger;
 
 /**
@@ -69,13 +81,41 @@
                                                             Collections.<Device>emptyList(),
                                                             Collections.<Link>emptyList()));
 
+    @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
+    protected StorageService storageService;
+
+    @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
+    protected LogicalClockService clockService;
+
+    @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
+    protected MastershipService mastershipService;
+
+    // Cluster root to broadcast points bindings to allow convergence to
+    // a shared broadcast tree; node that is the master of the cluster root
+    // is the primary.
+    private EventuallyConsistentMap<DeviceId, Set<ConnectPoint>> broadcastPoints;
+
+    private EventuallyConsistentMapListener<DeviceId, Set<ConnectPoint>> listener =
+            new InternalBroadcastPointListener();
+
     @Activate
     public void activate() {
+        KryoNamespace.Builder hostSerializer = KryoNamespace.newBuilder()
+                .register(KryoNamespaces.API);
+
+        broadcastPoints = storageService.<DeviceId, Set<ConnectPoint>>eventuallyConsistentMapBuilder()
+                .withName("onos-broadcast-trees")
+                .withSerializer(hostSerializer)
+                .withTimestampProvider((k, v) -> clockService.getTimestamp())
+                .build();
+        broadcastPoints.addListener(listener);
         log.info("Started");
     }
 
     @Deactivate
     public void deactivate() {
+        broadcastPoints.removeListener(listener);
+        broadcastPoints.destroy();
         log.info("Stopped");
     }
 
@@ -136,6 +176,22 @@
         return defaultTopology(topology).isBroadcastPoint(connectPoint);
     }
 
+    private boolean isBroadcastPoint(ConnectPoint connectPoint) {
+        // Any non-infrastructure, i.e. edge points are assumed to be OK.
+        if (!current.isInfrastructure(connectPoint)) {
+            return true;
+        }
+
+        // Find the cluster to which the device belongs.
+        TopologyCluster cluster = current.getCluster(connectPoint.deviceId());
+        checkArgument(cluster != null, "No cluster found for device %s", connectPoint.deviceId());
+
+        // If the broadcast set is null or empty, or if the point explicitly
+        // belongs to it, return true;
+        Set<ConnectPoint> points = broadcastPoints.get(cluster.root().deviceId());
+        return isNullOrEmpty(points) || points.contains(connectPoint);
+    }
+
     @Override
     public TopologyEvent updateTopology(ProviderId providerId,
                                         GraphDescription graphDescription,
@@ -147,7 +203,9 @@
         }
 
         // Have the default topology construct self from the description data.
-        DefaultTopology newTopology = new DefaultTopology(providerId, graphDescription);
+        DefaultTopology newTopology =
+                new DefaultTopology(providerId, graphDescription, this::isBroadcastPoint);
+        updateBroadcastPoints(newTopology);
 
         // Promote the new topology to current and return a ready-to-send event.
         synchronized (this) {
@@ -156,6 +214,24 @@
         }
     }
 
+    private void updateBroadcastPoints(DefaultTopology topology) {
+        // Remove any broadcast trees rooted by devices for which we are master.
+        Set<DeviceId> toRemove = broadcastPoints.keySet().stream()
+                .filter(mastershipService::isLocalMaster)
+                .collect(Collectors.toSet());
+
+        // Update the broadcast trees rooted by devices for which we are master.
+        topology.getClusters().forEach(c -> {
+            toRemove.remove(c.root().deviceId());
+            if (mastershipService.isLocalMaster(c.root().deviceId())) {
+                broadcastPoints.put(c.root().deviceId(),
+                                    topology.broadcastPoints(c.id()));
+            }
+        });
+
+        toRemove.forEach(broadcastPoints::remove);
+    }
+
     // Validates the specified topology and returns it as a default
     private DefaultTopology defaultTopology(Topology topology) {
         checkArgument(topology instanceof DefaultTopology,
@@ -163,4 +239,16 @@
         return (DefaultTopology) topology;
     }
 
+    private class InternalBroadcastPointListener
+            implements EventuallyConsistentMapListener<DeviceId, Set<ConnectPoint>> {
+        @Override
+        public void event(EventuallyConsistentMapEvent<DeviceId, Set<ConnectPoint>> event) {
+            if (event.type() == EventuallyConsistentMapEvent.Type.PUT) {
+                if (!event.value().isEmpty()) {
+                    log.info("Cluster rooted at {} has {} broadcast-points; #{}",
+                             event.key(), event.value().size(), event.value().hashCode());
+                }
+            }
+        }
+    }
 }