[CORD-2486] Improve Mcast CLI APIs
It adds following commands:
- sr-mcast-tree which shows the mapping group-tree
- sr-mcast-next which shows the mapping device-next
- mcast-routes which is similar to the unicast command (routes)
It improve following commands:
- mcast-join adds completer and improves output
- mcast-delete adds completer and improves output
- mcast-show improves output and adds completer
Change-Id: I4e273ac23b05142026b6b77317b0c9b7af76c3ec
diff --git a/src/main/java/org/onosproject/segmentrouting/McastHandler.java b/src/main/java/org/onosproject/segmentrouting/McastHandler.java
index a5ef34c..fff2c92 100644
--- a/src/main/java/org/onosproject/segmentrouting/McastHandler.java
+++ b/src/main/java/org/onosproject/segmentrouting/McastHandler.java
@@ -1351,4 +1351,103 @@
}
}
+
+ public Map<McastStoreKey, Integer> getMcastNextIds(IpAddress mcastIp) {
+ // If mcast ip is present
+ if (mcastIp != null) {
+ return mcastNextObjStore.entrySet().stream()
+ .filter(mcastEntry -> mcastIp.equals(mcastEntry.getKey().mcastIp()))
+ .collect(Collectors.toMap(Map.Entry::getKey,
+ entry -> entry.getValue().value().id()));
+ }
+ // Otherwise take all the groups
+ return mcastNextObjStore.entrySet().stream()
+ .collect(Collectors.toMap(Map.Entry::getKey,
+ entry -> entry.getValue().value().id()));
+ }
+
+ public Map<McastStoreKey, McastHandler.McastRole> getMcastRoles(IpAddress mcastIp) {
+ // If mcast ip is present
+ if (mcastIp != null) {
+ return mcastRoleStore.entrySet().stream()
+ .filter(mcastEntry -> mcastIp.equals(mcastEntry.getKey().mcastIp()))
+ .collect(Collectors.toMap(Map.Entry::getKey,
+ entry -> entry.getValue().value()));
+ }
+ // Otherwise take all the groups
+ return mcastRoleStore.entrySet().stream()
+ .collect(Collectors.toMap(Map.Entry::getKey,
+ entry -> entry.getValue().value()));
+ }
+
+ public Map<ConnectPoint, List<ConnectPoint>> getMcastPaths(IpAddress mcastIp) {
+ Map<ConnectPoint, List<ConnectPoint>> mcastPaths = Maps.newHashMap();
+ // Get the source
+ ConnectPoint source = getSource(mcastIp);
+ // Source cannot be null, we don't know the starting point
+ if (source != null) {
+ // Init steps
+ Set<DeviceId> visited = Sets.newHashSet();
+ List<ConnectPoint> currentPath = Lists.newArrayList(
+ source
+ );
+ // Build recursively the mcast paths
+ buildMcastPaths(source.deviceId(), visited, mcastPaths, currentPath, mcastIp);
+ }
+ return mcastPaths;
+ }
+
+ private void buildMcastPaths(DeviceId toVisit, Set<DeviceId> visited,
+ Map<ConnectPoint, List<ConnectPoint>> mcastPaths,
+ List<ConnectPoint> currentPath, IpAddress mcastIp) {
+ // If we have visited the node to visit
+ // there is a loop
+ if (visited.contains(toVisit)) {
+ return;
+ }
+ // Visit next-hop
+ visited.add(toVisit);
+ McastStoreKey mcastStoreKey = new McastStoreKey(mcastIp, toVisit);
+ // Looking for next-hops
+ if (mcastNextObjStore.containsKey(mcastStoreKey)) {
+ // Build egress connectpoints
+ NextObjective nextObjective = mcastNextObjStore.get(mcastStoreKey).value();
+ // Get Ports
+ Set<PortNumber> outputPorts = getPorts(nextObjective.next());
+ // Build relative cps
+ ImmutableSet.Builder<ConnectPoint> cpBuilder = ImmutableSet.builder();
+ outputPorts.forEach(portNumber -> cpBuilder.add(new ConnectPoint(toVisit, portNumber)));
+ Set<ConnectPoint> egressPoints = cpBuilder.build();
+ // Define other variables for the next steps
+ Set<Link> egressLinks;
+ List<ConnectPoint> newCurrentPath;
+ Set<DeviceId> newVisited;
+ DeviceId newToVisit;
+ for (ConnectPoint egressPoint : egressPoints) {
+ egressLinks = srManager.linkService.getEgressLinks(egressPoint);
+ // If it does not have egress links, stop
+ if (egressLinks.isEmpty()) {
+ // Add the connect points to the path
+ newCurrentPath = Lists.newArrayList(currentPath);
+ newCurrentPath.add(0, egressPoint);
+ // Save in the map
+ mcastPaths.put(egressPoint, newCurrentPath);
+ } else {
+ newVisited = Sets.newHashSet(visited);
+ // Iterate over the egress links for the next hops
+ for (Link egressLink : egressLinks) {
+ // Update to visit
+ newToVisit = egressLink.dst().deviceId();
+ // Add the connect points to the path
+ newCurrentPath = Lists.newArrayList(currentPath);
+ newCurrentPath.add(0, egressPoint);
+ newCurrentPath.add(0, egressLink.dst());
+ // Go to the next hop
+ buildMcastPaths(newToVisit, newVisited, mcastPaths, newCurrentPath, mcastIp);
+ }
+ }
+ }
+ }
+ }
+
}
diff --git a/src/main/java/org/onosproject/segmentrouting/SegmentRoutingManager.java b/src/main/java/org/onosproject/segmentrouting/SegmentRoutingManager.java
index 4f85368..525f84a 100644
--- a/src/main/java/org/onosproject/segmentrouting/SegmentRoutingManager.java
+++ b/src/main/java/org/onosproject/segmentrouting/SegmentRoutingManager.java
@@ -105,6 +105,7 @@
import org.onosproject.segmentrouting.pwaas.DefaultL2TunnelPolicy;
import org.onosproject.segmentrouting.pwaas.L2TunnelHandler;
import org.onosproject.segmentrouting.storekey.DestinationSetNextObjectiveStoreKey;
+import org.onosproject.segmentrouting.storekey.McastStoreKey;
import org.onosproject.segmentrouting.storekey.PortNextObjectiveStoreKey;
import org.onosproject.segmentrouting.storekey.VlanNextObjectiveStoreKey;
import org.onosproject.segmentrouting.storekey.XConnectStoreKey;
@@ -662,6 +663,21 @@
return linkHandler.getDownedPorts();
}
+ @Override
+ public Map<McastStoreKey, Integer> getMcastNextIds(IpAddress mcastIp) {
+ return mcastHandler.getMcastNextIds(mcastIp);
+ }
+
+ @Override
+ public Map<McastStoreKey, McastHandler.McastRole> getMcastRoles(IpAddress mcastIp) {
+ return mcastHandler.getMcastRoles(mcastIp);
+ }
+
+ @Override
+ public Map<ConnectPoint, List<ConnectPoint>> getMcastPaths(IpAddress mcastIp) {
+ return mcastHandler.getMcastPaths(mcastIp);
+ }
+
/**
* Extracts the application ID from the manager.
*
diff --git a/src/main/java/org/onosproject/segmentrouting/SegmentRoutingService.java b/src/main/java/org/onosproject/segmentrouting/SegmentRoutingService.java
index 3269657..00e7a6a 100644
--- a/src/main/java/org/onosproject/segmentrouting/SegmentRoutingService.java
+++ b/src/main/java/org/onosproject/segmentrouting/SegmentRoutingService.java
@@ -15,7 +15,9 @@
*/
package org.onosproject.segmentrouting;
+import org.onlab.packet.IpAddress;
import org.onlab.packet.IpPrefix;
+import org.onosproject.net.ConnectPoint;
import org.onosproject.net.DeviceId;
import org.onosproject.net.Link;
import org.onosproject.net.PortNumber;
@@ -26,6 +28,7 @@
import org.onosproject.segmentrouting.storekey.DestinationSetNextObjectiveStoreKey;
import com.google.common.collect.ImmutableMap;
+import org.onosproject.segmentrouting.storekey.McastStoreKey;
import java.util.List;
import java.util.Map;
@@ -207,4 +210,31 @@
* ports. Does not include ports manually disabled by the operator.
*/
ImmutableMap<DeviceId, Set<PortNumber>> getDownedPortState();
+
+ /**
+ * Returns the associated next ids to the mcast groups or to the single
+ * group if mcastIp is present.
+ *
+ * @param mcastIp the group ip
+ * @return the mapping mcastIp-device to next id
+ */
+ Map<McastStoreKey, Integer> getMcastNextIds(IpAddress mcastIp);
+
+ /**
+ * Returns the associated roles to the mcast groups or to the single
+ * group if mcastIp is present.
+ *
+ * @param mcastIp the group ip
+ * @return the mapping mcastIp-device to mcast role
+ */
+ Map<McastStoreKey, McastHandler.McastRole> getMcastRoles(IpAddress mcastIp);
+
+ /**
+ * Returns the associated paths to the mcast group.
+ *
+ * @param mcastIp the group ip
+ * @return the mapping egress point to mcast path
+ */
+ Map<ConnectPoint, List<ConnectPoint>> getMcastPaths(IpAddress mcastIp);
+
}
diff --git a/src/main/java/org/onosproject/segmentrouting/cli/McastNextListCommand.java b/src/main/java/org/onosproject/segmentrouting/cli/McastNextListCommand.java
new file mode 100644
index 0000000..341c87d
--- /dev/null
+++ b/src/main/java/org/onosproject/segmentrouting/cli/McastNextListCommand.java
@@ -0,0 +1,81 @@
+/*
+ * Copyright 2018-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.segmentrouting.cli;
+
+import com.google.common.collect.Maps;
+import org.apache.karaf.shell.commands.Argument;
+import org.apache.karaf.shell.commands.Command;
+import org.onlab.packet.IpAddress;
+import org.onosproject.cli.AbstractShellCommand;
+import org.onosproject.net.DeviceId;
+import org.onosproject.segmentrouting.SegmentRoutingService;
+import org.onosproject.segmentrouting.storekey.McastStoreKey;
+
+import java.util.Map;
+import java.util.Set;
+import java.util.stream.Collectors;
+
+import static com.google.common.base.Strings.isNullOrEmpty;
+
+/**
+ * Command to show the list of mcast nextids.
+ */
+@Command(scope = "onos", name = "sr-mcast-next",
+ description = "Lists all mcast nextids")
+public class McastNextListCommand extends AbstractShellCommand {
+
+ // Format for group line
+ private static final String FORMAT_MAPPING = "group=%s, deviceIds-nextIds=%s";
+
+ @Argument(index = 0, name = "mcastIp", description = "mcast Ip",
+ required = false, multiValued = false)
+ String mcastIp;
+
+ @Override
+ protected void execute() {
+ // Verify mcast group
+ IpAddress mcastGroup = null;
+ if (!isNullOrEmpty(mcastIp)) {
+ mcastGroup = IpAddress.valueOf(mcastIp);
+
+ }
+ // Get SR service
+ SegmentRoutingService srService = get(SegmentRoutingService.class);
+ // Get the mapping
+ Map<McastStoreKey, Integer> keyToNextId = srService.getMcastNextIds(mcastGroup);
+ // Reduce to the set of mcast groups
+ Set<IpAddress> mcastGroups = keyToNextId.keySet().stream()
+ .map(McastStoreKey::mcastIp)
+ .collect(Collectors.toSet());
+ // Print the nextids for each group
+ mcastGroups.forEach(group -> {
+ // Create a new map for the group
+ Map<DeviceId, Integer> deviceIdNextMap = Maps.newHashMap();
+ keyToNextId.entrySet()
+ .stream()
+ // Filter only the elements related to this group
+ .filter(entry -> entry.getKey().mcastIp().equals(group))
+ // For each create a new entry in the group related map
+ .forEach(entry -> deviceIdNextMap.put(entry.getKey().deviceId(), entry.getValue()));
+ // Print the map
+ printMcastNext(group, deviceIdNextMap);
+ });
+ }
+
+ private void printMcastNext(IpAddress mcastGroup, Map<DeviceId, Integer> deviceIdNextMap) {
+ print(FORMAT_MAPPING, mcastGroup, deviceIdNextMap);
+ }
+}
diff --git a/src/main/java/org/onosproject/segmentrouting/cli/McastTreeListCommand.java b/src/main/java/org/onosproject/segmentrouting/cli/McastTreeListCommand.java
new file mode 100644
index 0000000..73cbb1a
--- /dev/null
+++ b/src/main/java/org/onosproject/segmentrouting/cli/McastTreeListCommand.java
@@ -0,0 +1,107 @@
+/*
+ * Copyright 2018-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.segmentrouting.cli;
+
+import com.google.common.collect.ArrayListMultimap;
+import com.google.common.collect.Multimap;
+import org.apache.karaf.shell.commands.Argument;
+import org.apache.karaf.shell.commands.Command;
+import org.onlab.packet.IpAddress;
+import org.onosproject.cli.AbstractShellCommand;
+import org.onosproject.net.ConnectPoint;
+import org.onosproject.net.DeviceId;
+import org.onosproject.segmentrouting.McastHandler.McastRole;
+import org.onosproject.segmentrouting.SegmentRoutingService;
+import org.onosproject.segmentrouting.storekey.McastStoreKey;
+
+import java.util.Collection;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+import java.util.stream.Collectors;
+
+import static com.google.common.base.Strings.isNullOrEmpty;
+import static org.onosproject.segmentrouting.McastHandler.McastRole.EGRESS;
+import static org.onosproject.segmentrouting.McastHandler.McastRole.INGRESS;
+import static org.onosproject.segmentrouting.McastHandler.McastRole.TRANSIT;
+
+/**
+ * Command to show the list of mcast trees.
+ */
+@Command(scope = "onos", name = "sr-mcast-tree",
+ description = "Lists all mcast trees")
+public class McastTreeListCommand extends AbstractShellCommand {
+
+ // Format for group line
+ private static final String G_FORMAT_MAPPING = "group=%s, ingress=%s, transit=%s, egress=%s";
+ // Format for sink line
+ private static final String S_FORMAT_MAPPING = "\tsink=%s\tpath=%s";
+
+ @Argument(index = 0, name = "mcastIp", description = "mcast Ip",
+ required = false, multiValued = false)
+ String mcastIp;
+
+ @Override
+ protected void execute() {
+ // Verify mcast group
+ IpAddress mcastGroup = null;
+ if (!isNullOrEmpty(mcastIp)) {
+ mcastGroup = IpAddress.valueOf(mcastIp);
+
+ }
+ // Get SR service
+ SegmentRoutingService srService = get(SegmentRoutingService.class);
+ // Get the mapping
+ Map<McastStoreKey, McastRole> keyToRole = srService.getMcastRoles(mcastGroup);
+ // Reduce to the set of mcast groups
+ Set<IpAddress> mcastGroups = keyToRole.keySet().stream()
+ .map(McastStoreKey::mcastIp)
+ .collect(Collectors.toSet());
+ // Print the trees for each group
+ mcastGroups.forEach(group -> {
+ // Create a new map for the group
+ Multimap<McastRole, DeviceId> roleDeviceIdMap = ArrayListMultimap.create();
+ keyToRole.entrySet()
+ .stream()
+ // Filter only the elements related to this group
+ .filter(entry -> entry.getKey().mcastIp().equals(group))
+ // For each create a new entry in the group related map
+ .forEach(entry -> roleDeviceIdMap.put(entry.getValue(), entry.getKey().deviceId()));
+ // Print the map
+ printMcastRole(group,
+ roleDeviceIdMap.get(INGRESS),
+ roleDeviceIdMap.get(TRANSIT),
+ roleDeviceIdMap.get(EGRESS)
+ );
+ // Get sinks paths
+ Map<ConnectPoint, List<ConnectPoint>> mcastPaths = srService.getMcastPaths(group);
+ // Print the paths
+ mcastPaths.forEach(this::printMcastSink);
+ });
+ }
+
+ private void printMcastRole(IpAddress mcastGroup,
+ Collection<DeviceId> ingress,
+ Collection<DeviceId> transit,
+ Collection<DeviceId> egress) {
+ print(G_FORMAT_MAPPING, mcastGroup, ingress, transit, egress);
+ }
+
+ private void printMcastSink(ConnectPoint sink, List<ConnectPoint> path) {
+ print(S_FORMAT_MAPPING, sink, path);
+ }
+}
diff --git a/src/main/resources/OSGI-INF/blueprint/shell-config.xml b/src/main/resources/OSGI-INF/blueprint/shell-config.xml
index 56b6f43..cfd7502 100644
--- a/src/main/resources/OSGI-INF/blueprint/shell-config.xml
+++ b/src/main/resources/OSGI-INF/blueprint/shell-config.xml
@@ -69,10 +69,26 @@
<command>
<action class="org.onosproject.segmentrouting.cli.LinkStateCommand"/>
</command>
+ <command>
+ <action class="org.onosproject.segmentrouting.cli.McastNextListCommand"/>
+ <completers>
+ <ref component-id="mcastGroupCompleter"/>
+ <ref component-id="nullCompleter"/>
+ </completers>
+ </command>
+ <command>
+ <action class="org.onosproject.segmentrouting.cli.McastTreeListCommand"/>
+ <completers>
+ <ref component-id="mcastGroupCompleter"/>
+ <ref component-id="nullCompleter"/>
+ </completers>
+ </command>
</command-bundle>
+ <bean id="nullCompleter" class="org.apache.karaf.shell.console.completer.NullCompleter"/>
<bean id="deviceIdCompleter" class="org.onosproject.cli.net.DeviceIdCompleter"/>
<bean id="pseudowireIdCompleter" class="org.onosproject.segmentrouting.cli.PseudowireIdCompleter"/>
+ <bean id="mcastGroupCompleter" class="org.onosproject.cli.net.McastGroupCompleter"/>
</blueprint>