Moving Multicast subsystem into app and refactoring APIs to support multihomed sources and sinks
Change-Id: I95d07b163c619b018ff106159b134ff214aa2ffd
diff --git a/apps/mcast/impl/src/main/java/org/onosproject/mcast/impl/DistributedMcastRoutesStore.java b/apps/mcast/impl/src/main/java/org/onosproject/mcast/impl/DistributedMcastRoutesStore.java
new file mode 100644
index 0000000..8bdf42e
--- /dev/null
+++ b/apps/mcast/impl/src/main/java/org/onosproject/mcast/impl/DistributedMcastRoutesStore.java
@@ -0,0 +1,283 @@
+/*
+ * Copyright 2015-present Open Networking Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.onosproject.mcast.impl;
+
+
+import com.google.common.collect.ImmutableSet;
+import com.google.common.collect.Sets;
+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.mcast.api.McastEvent;
+import org.onosproject.mcast.api.McastRoute;
+import org.onosproject.mcast.api.McastRouteData;
+import org.onosproject.mcast.api.McastStore;
+import org.onosproject.mcast.api.McastStoreDelegate;
+import org.onosproject.net.ConnectPoint;
+import org.onosproject.net.HostId;
+import org.onosproject.store.AbstractStore;
+import org.onosproject.store.serializers.KryoNamespaces;
+import org.onosproject.store.service.ConsistentMap;
+import org.onosproject.store.service.MapEvent;
+import org.onosproject.store.service.MapEventListener;
+import org.onosproject.store.service.Serializer;
+import org.onosproject.store.service.StorageService;
+import org.onosproject.store.service.Versioned;
+import org.slf4j.Logger;
+
+import java.util.Collection;
+import java.util.Map;
+import java.util.Optional;
+import java.util.Set;
+import java.util.concurrent.ScheduledExecutorService;
+import java.util.concurrent.atomic.AtomicReference;
+import java.util.stream.Collectors;
+
+import static com.google.common.base.Preconditions.checkNotNull;
+import static org.onosproject.mcast.api.McastRouteUpdate.mcastRouteUpdate;
+import static org.slf4j.LoggerFactory.getLogger;
+
+/**
+ * New distributed mcast route store implementation. Routes are stored consistently
+ * across the cluster.
+ */
+@Component(immediate = true)
+@Service
+public class DistributedMcastRoutesStore
+ extends AbstractStore<McastEvent, McastStoreDelegate>
+ implements McastStore {
+
+ private static final String MCASTRIB = "onos-mcast-route-table";
+ private Logger log = getLogger(getClass());
+
+ @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
+ protected StorageService storageService;
+
+ private Map<McastRoute, McastRouteData> mcastRoutes;
+ private ConsistentMap<McastRoute, McastRouteData> mcastRib;
+ private MapEventListener<McastRoute, McastRouteData> mcastRouteListener =
+ new McastRouteListener();
+
+ private ScheduledExecutorService executor;
+
+
+ @Activate
+ public void activate() {
+ mcastRib = storageService.<McastRoute, McastRouteData>consistentMapBuilder()
+ .withName(MCASTRIB)
+ .withSerializer(Serializer.using(KryoNamespace.newBuilder()
+ .register(KryoNamespaces.API)
+ .register(
+ McastRoute.class,
+ AtomicReference.class,
+ McastRouteData.class,
+ McastRoute.Type.class
+ ).build()))
+ .build();
+
+ mcastRoutes = mcastRib.asJavaMap();
+ mcastRib.addListener(mcastRouteListener);
+
+ log.info("Started");
+ }
+
+ @Deactivate
+ public void deactivate() {
+ mcastRib.removeListener(mcastRouteListener);
+ mcastRib.destroy();
+ log.info("Stopped");
+ }
+
+ @Override
+ public void storeRoute(McastRoute route) {
+ mcastRoutes.put(route, McastRouteData.empty());
+ }
+
+ @Override
+ public void removeRoute(McastRoute route) {
+ mcastRoutes.remove(route);
+ }
+
+ @Override
+ public void storeSources(McastRoute route, Set<ConnectPoint> sources) {
+ McastRouteData data = mcastRoutes.compute(route, (k, v) -> {
+ v.addSources(sources);
+ return v;
+ });
+ }
+
+ @Override
+ public void removeSources(McastRoute route) {
+ McastRouteData data = mcastRoutes.compute(route, (k, v) -> {
+ v.removeSources();
+ return v;
+ });
+ }
+
+ @Override
+ public void removeSources(McastRoute route, Set<ConnectPoint> sources) {
+ McastRouteData data = mcastRoutes.compute(route, (k, v) -> {
+ v.removeSources(sources);
+ return v;
+ });
+
+ }
+
+ @Override
+ public void addSink(McastRoute route, HostId hostId, Set<ConnectPoint> sinks) {
+ McastRouteData data = mcastRoutes.compute(route, (k, v) -> {
+ v.addSinks(hostId, sinks);
+ return v;
+ });
+ }
+
+ @Override
+ public void addSinks(McastRoute route, Set<ConnectPoint> sinks) {
+ McastRouteData data = mcastRoutes.compute(route, (k, v) -> {
+ v.addSinks(HostId.NONE, sinks);
+ return v;
+ });
+ }
+
+
+ @Override
+ public void removeSinks(McastRoute route) {
+ McastRouteData data = mcastRoutes.compute(route, (k, v) -> {
+ v.removeSinks();
+ return v;
+ });
+ }
+
+ @Override
+ public void removeSink(McastRoute route, HostId hostId) {
+ McastRouteData data = mcastRoutes.compute(route, (k, v) -> {
+ v.removeSinks(hostId);
+ return v;
+ });
+ }
+
+ @Override
+ public void removeSinks(McastRoute route, HostId hostId, Set<ConnectPoint> sinks) {
+ McastRouteData data = mcastRoutes.compute(route, (k, v) -> {
+ v.removeSinks(hostId, sinks);
+ return v;
+ });
+ }
+
+ @Override
+ public void removeSinks(McastRoute route, Set<ConnectPoint> sinks) {
+ McastRouteData data = mcastRoutes.compute(route, (k, v) -> {
+ v.removeSinks(HostId.NONE, sinks);
+ return v;
+ });
+ }
+
+ @Override
+ public Set<ConnectPoint> sourcesFor(McastRoute route) {
+ McastRouteData data = mcastRoutes.getOrDefault(route, null);
+ return data == null ? ImmutableSet.of() : ImmutableSet.copyOf(data.sources());
+ }
+
+ @Override
+ public Set<ConnectPoint> sinksFor(McastRoute route) {
+ McastRouteData data = mcastRoutes.getOrDefault(route, null);
+ return data == null ? ImmutableSet.of() : ImmutableSet.copyOf(data.sinks().values().stream()
+ .flatMap(Collection::stream).collect(Collectors.toSet()));
+ }
+
+ @Override
+ public Set<ConnectPoint> sinksFor(McastRoute route, HostId hostId) {
+ McastRouteData data = mcastRoutes.getOrDefault(route, null);
+ return data == null ? ImmutableSet.of() : ImmutableSet.copyOf(data.sinks(hostId));
+ }
+
+ @Override
+ public Set<McastRoute> getRoutes() {
+ return ImmutableSet.copyOf(mcastRoutes.keySet());
+ }
+
+ @Override
+ public McastRouteData getRouteData(McastRoute route) {
+ return mcastRoutes.get(route);
+ }
+
+ private class McastRouteListener implements MapEventListener<McastRoute, McastRouteData> {
+ @Override
+ public void event(MapEvent<McastRoute, McastRouteData> event) {
+ final McastRoute route = event.key();
+ final McastRouteData newData =
+ Optional.ofNullable(event.newValue()).map(Versioned::value).orElse(null);
+ final McastRouteData oldData =
+ Optional.ofNullable(event.oldValue()).map(Versioned::value).orElse(null);
+
+ switch (event.type()) {
+ case INSERT:
+ checkNotNull(newData);
+ McastEvent.Type type;
+ if (!newData.sources().isEmpty() || !newData.sinks().isEmpty()) {
+ type = McastEvent.Type.SOURCES_ADDED;
+ } else if (!newData.sinks().isEmpty()) {
+ type = McastEvent.Type.SINKS_ADDED;
+ } else {
+ type = McastEvent.Type.ROUTE_ADDED;
+ }
+ notifyDelegate(new McastEvent(type, null,
+ mcastRouteUpdate(route, newData.sources(), newData.sinks())));
+ break;
+ case UPDATE:
+ checkNotNull(newData);
+ checkNotNull(oldData);
+
+ if (!Sets.difference(newData.sources(), oldData.sources()).isEmpty()) {
+ notifyDelegate(new McastEvent(McastEvent.Type.SOURCES_ADDED,
+ mcastRouteUpdate(route, oldData.sources(), oldData.sinks()),
+ mcastRouteUpdate(route, newData.sources(), newData.sinks())));
+ }
+ if (!Sets.difference(oldData.sources(), newData.sources()).isEmpty()) {
+ notifyDelegate(new McastEvent(McastEvent.Type.SOURCES_REMOVED,
+ mcastRouteUpdate(route, oldData.sources(), oldData.sinks()),
+ mcastRouteUpdate(route, newData.sources(), newData.sinks())));
+ }
+ if (newData.allSinks().size() > oldData.allSinks().size()) {
+ notifyDelegate(new McastEvent(McastEvent.Type.SINKS_ADDED,
+ mcastRouteUpdate(route, oldData.sources(), oldData.sinks()),
+ mcastRouteUpdate(route, newData.sources(), newData.sinks())));
+ } else if (newData.allSinks().size() < oldData.allSinks().size()) {
+ log.info("Removed");
+ notifyDelegate(new McastEvent(McastEvent.Type.SINKS_REMOVED,
+ mcastRouteUpdate(route, oldData.sources(), oldData.sinks()),
+ mcastRouteUpdate(route, newData.sources(), newData.sinks())));
+ }
+ break;
+ case REMOVE:
+ // Verify old data is not null
+ checkNotNull(oldData);
+ // Create a route removed event with just the route
+ // and the source connect point
+ notifyDelegate(new McastEvent(McastEvent.Type.ROUTE_REMOVED,
+ mcastRouteUpdate(route, oldData.sources(), oldData.sinks()),
+ null));
+ break;
+ default:
+ log.warn("Unknown mcast operation type: {}", event.type());
+ }
+ }
+ }
+}