blob: 6f06d60b99a74a1a7efeed6822a8483a06a72996 [file] [log] [blame]
/*
* 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.segmentrouting.grouphandler;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Iterables;
import com.google.common.collect.Sets;
import org.apache.commons.lang3.RandomUtils;
import org.onlab.packet.MacAddress;
import org.onlab.packet.MplsLabel;
import org.onlab.packet.VlanId;
import org.onlab.util.KryoNamespace;
import org.onosproject.core.ApplicationId;
import org.onosproject.net.ConnectPoint;
import org.onosproject.net.DeviceId;
import org.onosproject.net.Link;
import org.onosproject.net.PortNumber;
import org.onosproject.net.flow.DefaultTrafficSelector;
import org.onosproject.net.flow.DefaultTrafficTreatment;
import org.onosproject.net.flow.TrafficSelector;
import org.onosproject.net.flow.TrafficTreatment;
import org.onosproject.net.flowobjective.DefaultNextObjective;
import org.onosproject.net.flowobjective.DefaultObjectiveContext;
import org.onosproject.net.flowobjective.FlowObjectiveService;
import org.onosproject.net.flowobjective.NextObjective;
import org.onosproject.net.flowobjective.ObjectiveContext;
import org.onosproject.net.link.LinkService;
import org.onosproject.segmentrouting.DefaultRoutingHandler;
import org.onosproject.segmentrouting.SegmentRoutingManager;
import org.onosproject.segmentrouting.config.DeviceConfigNotFoundException;
import org.onosproject.segmentrouting.config.DeviceProperties;
import org.onosproject.segmentrouting.storekey.DestinationSetNextObjectiveStoreKey;
import org.onosproject.segmentrouting.storekey.PortNextObjectiveStoreKey;
import org.onosproject.segmentrouting.storekey.VlanNextObjectiveStoreKey;
import org.onosproject.store.service.EventuallyConsistentMap;
import org.slf4j.Logger;
import java.net.URI;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.TimeUnit;
import java.util.stream.Collectors;
import static com.google.common.base.Preconditions.checkNotNull;
import static java.util.concurrent.Executors.newScheduledThreadPool;
import static org.onlab.util.Tools.groupedThreads;
import static org.onosproject.segmentrouting.SegmentRoutingManager.INTERNAL_VLAN;
import static org.slf4j.LoggerFactory.getLogger;
/**
* Default ECMP group handler creation module. This component creates a set of
* ECMP groups for every neighbor that this device is connected to based on
* whether the current device is an edge device or a transit device.
*/
public class DefaultGroupHandler {
protected static final Logger log = getLogger(DefaultGroupHandler.class);
private static final long VERIFY_INTERVAL = 30; // secs
protected final DeviceId deviceId;
protected final ApplicationId appId;
protected final DeviceProperties deviceConfig;
protected final List<Integer> allSegmentIds;
protected int ipv4NodeSegmentId = -1;
protected int ipv6NodeSegmentId = -1;
protected boolean isEdgeRouter = false;
protected MacAddress nodeMacAddr = null;
protected LinkService linkService;
protected FlowObjectiveService flowObjectiveService;
/**
* local store for neighbor-device-ids and the set of ports on this device
* that connect to the same neighbor.
*/
protected ConcurrentHashMap<DeviceId, Set<PortNumber>> devicePortMap =
new ConcurrentHashMap<>();
/**
* local store for ports on this device connected to neighbor-device-id.
*/
protected ConcurrentHashMap<PortNumber, DeviceId> portDeviceMap =
new ConcurrentHashMap<>();
// distributed store for (device+destination-set) mapped to next-id and neighbors
protected EventuallyConsistentMap<DestinationSetNextObjectiveStoreKey, NextNeighbors>
dsNextObjStore = null;
// distributed store for (device+subnet-ip-prefix) mapped to next-id
protected EventuallyConsistentMap<VlanNextObjectiveStoreKey, Integer>
vlanNextObjStore = null;
// distributed store for (device+port+treatment) mapped to next-id
protected EventuallyConsistentMap<PortNextObjectiveStoreKey, Integer>
portNextObjStore = null;
private SegmentRoutingManager srManager;
private ScheduledExecutorService executorService
= newScheduledThreadPool(1, groupedThreads("bktCorrector", "bktC-%d", log));
protected KryoNamespace.Builder kryo = new KryoNamespace.Builder()
.register(URI.class).register(HashSet.class)
.register(DeviceId.class).register(PortNumber.class)
.register(DestinationSet.class).register(PolicyGroupIdentifier.class)
.register(PolicyGroupParams.class)
.register(GroupBucketIdentifier.class)
.register(GroupBucketIdentifier.BucketOutputType.class);
protected DefaultGroupHandler(DeviceId deviceId, ApplicationId appId,
DeviceProperties config,
LinkService linkService,
FlowObjectiveService flowObjService,
SegmentRoutingManager srManager) {
this.deviceId = checkNotNull(deviceId);
this.appId = checkNotNull(appId);
this.deviceConfig = checkNotNull(config);
this.linkService = checkNotNull(linkService);
this.allSegmentIds = checkNotNull(config.getAllDeviceSegmentIds());
try {
this.ipv4NodeSegmentId = config.getIPv4SegmentId(deviceId);
this.ipv6NodeSegmentId = config.getIPv6SegmentId(deviceId);
this.isEdgeRouter = config.isEdgeDevice(deviceId);
this.nodeMacAddr = checkNotNull(config.getDeviceMac(deviceId));
} catch (DeviceConfigNotFoundException e) {
log.warn(e.getMessage()
+ " Skipping value assignment in DefaultGroupHandler");
}
this.flowObjectiveService = flowObjService;
this.dsNextObjStore = srManager.dsNextObjStore();
this.vlanNextObjStore = srManager.vlanNextObjStore();
this.portNextObjStore = srManager.portNextObjStore();
this.srManager = srManager;
executorService.scheduleWithFixedDelay(new BucketCorrector(), 10,
VERIFY_INTERVAL,
TimeUnit.SECONDS);
populateNeighborMaps();
}
/**
* Gracefully shuts down a groupHandler. Typically called when the handler is
* no longer needed.
*/
public void shutdown() {
executorService.shutdown();
}
/**
* Creates a group handler object.
*
* @param deviceId device identifier
* @param appId application identifier
* @param config interface to retrieve the device properties
* @param linkService link service object
* @param flowObjService flow objective service object
* @param srManager segment routing manager
* @throws DeviceConfigNotFoundException if the device configuration is not found
* @return default group handler type
*/
public static DefaultGroupHandler createGroupHandler(
DeviceId deviceId,
ApplicationId appId,
DeviceProperties config,
LinkService linkService,
FlowObjectiveService flowObjService,
SegmentRoutingManager srManager)
throws DeviceConfigNotFoundException {
return new DefaultGroupHandler(deviceId, appId, config,
linkService,
flowObjService,
srManager);
}
/**
* Updates local stores for link-src device/port to neighbor (link-dst).
*
* @param link the infrastructure link
*/
public void portUpForLink(Link link) {
if (!link.src().deviceId().equals(deviceId)) {
log.warn("linkUp: deviceId{} doesn't match with link src {}",
deviceId, link.src().deviceId());
return;
}
log.info("* portUpForLink: Device {} linkUp at local port {} to "
+ "neighbor {}", deviceId, link.src().port(), link.dst().deviceId());
// ensure local state is updated even if linkup is aborted later on
addNeighborAtPort(link.dst().deviceId(),
link.src().port());
}
/**
* Updates local stores for port that has gone down.
*
* @param port port number that has gone down
*/
public void portDown(PortNumber port) {
if (portDeviceMap.get(port) == null) {
log.warn("portDown: unknown port");
return;
}
log.debug("Device {} portDown {} to neighbor {}", deviceId, port,
portDeviceMap.get(port));
devicePortMap.get(portDeviceMap.get(port)).remove(port);
portDeviceMap.remove(port);
}
/**
* Checks all groups in the src-device of link for neighbor sets that include
* the dst-device of link, and edits the hash groups according to link up
* or down. Should only be called by the master instance of the src-switch
* of link. Typically used when there are no route-path changes due to the
* link up or down, as the ECMPspg does not change.
*
* @param link the infrastructure link that has gone down or come up
* @param linkDown true if link has gone down
* @param firstTime true if link has come up for the first time i.e a link
* not seen-before
*/
public void retryHash(Link link, boolean linkDown, boolean firstTime) {
MacAddress dstMac;
try {
dstMac = deviceConfig.getDeviceMac(link.dst().deviceId());
} catch (DeviceConfigNotFoundException e) {
log.warn(e.getMessage() + " Aborting retryHash.");
return;
}
// find all the destinationSets related to link
Set<DestinationSetNextObjectiveStoreKey> dsKeySet = dsNextObjStore.entrySet()
.stream()
.filter(entry -> entry.getKey().deviceId().equals(deviceId))
.filter(entry -> entry.getValue().containsNextHop(link.dst().deviceId()))
.map(entry -> entry.getKey())
.collect(Collectors.toSet());
log.debug("retryHash: dsNextObjStore contents for linkSrc {} -> linkDst {}: {}",
deviceId, link.dst().deviceId(), dsKeySet);
for (DestinationSetNextObjectiveStoreKey dsKey : dsKeySet) {
NextNeighbors nextHops = dsNextObjStore.get(dsKey);
if (nextHops == null) {
log.warn("retryHash in device {}, but global store has no record "
+ "for dsKey:{}", deviceId, dsKey);
continue;
}
int nextId = nextHops.nextId();
Set<DeviceId> dstSet = nextHops.getDstForNextHop(link.dst().deviceId());
if (!linkDown) {
dstSet.forEach(dst -> {
int edgeLabel = dsKey.destinationSet().getEdgeLabel(dst);
addToHashedNextObjective(link.src().port(), dstMac,
edgeLabel, nextId);
});
if (firstTime) {
// some links may have come up before the next-objective was created
// we take this opportunity to ensure other ports to same next-hop-dst
// are part of the hash group (see CORD-1180). Duplicate additions
// to the same hash group are avoided by the driver.
for (PortNumber p : devicePortMap.get(link.dst().deviceId())) {
if (p.equals(link.src().port())) {
continue;
}
dstSet.forEach(dst -> {
int edgeLabel = dsKey.destinationSet().getEdgeLabel(dst);
addToHashedNextObjective(p, dstMac, edgeLabel, nextId);
});
}
}
} else {
dstSet.forEach(dst -> {
int edgeLabel = dsKey.destinationSet().getEdgeLabel(dst);
removeFromHashedNextObjective(link.src().port(), dstMac,
edgeLabel, nextId);
});
}
}
}
/**
* Makes a call to the FlowObjective service to add a single bucket to
* a hashed group.
*
* @param outport port to add to hash group
* @param dstMac destination mac address of next-hop
* @param edgeLabel the label to use in the bucket
* @param nextId id for next-objective to which the bucket will be added
*
*/
private void addToHashedNextObjective(PortNumber outport, MacAddress dstMac,
int edgeLabel, Integer nextId) {
// Create the new bucket to be updated
TrafficTreatment.Builder tBuilder =
DefaultTrafficTreatment.builder();
tBuilder.setOutput(outport)
.setEthDst(dstMac)
.setEthSrc(nodeMacAddr);
if (edgeLabel != DestinationSet.NO_EDGE_LABEL) {
tBuilder.pushMpls()
.copyTtlOut()
.setMpls(MplsLabel.mplsLabel(edgeLabel));
}
// setup metadata to pass to nextObjective - indicate the vlan on egress
// if needed by the switch pipeline. Since hashed next-hops are always to
// other neighboring routers, there is no subnet assigned on those ports.
TrafficSelector.Builder metabuilder = DefaultTrafficSelector.builder();
metabuilder.matchVlanId(INTERNAL_VLAN);
NextObjective.Builder nextObjBuilder = DefaultNextObjective.builder()
.withId(nextId)
.withType(NextObjective.Type.HASHED)
.addTreatment(tBuilder.build())
.withMeta(metabuilder.build())
.fromApp(appId);
log.debug("addToHash in device {}: Adding Bucket with port/label {}/{} "
+ "to nextId {}", deviceId, outport, edgeLabel, nextId);
ObjectiveContext context = new DefaultObjectiveContext(
(objective) -> log.debug("addToHash addedTo NextObj {} on {}",
nextId, deviceId),
(objective, error) ->
log.warn("addToHash failed to addTo NextObj {} on {}: {}",
nextId, deviceId, error));
NextObjective nextObjective = nextObjBuilder.addToExisting(context);
flowObjectiveService.next(deviceId, nextObjective);
}
/**
* Makes a call to the FlowObjective service to remove a single bucket from
* a hashed group.
*
* @param port port to remove from hash group
* @param dstMac destination mac address of next-hop
* @param edgeLabel the label to use in the bucket
* @param nextId id for next-objective from which the bucket will be removed
*/
private void removeFromHashedNextObjective(PortNumber port, MacAddress dstMac,
int edgeLabel, Integer nextId) {
// Create the bucket to be removed
TrafficTreatment.Builder tBuilder = DefaultTrafficTreatment
.builder();
tBuilder.setOutput(port)
.setEthDst(dstMac)
.setEthSrc(nodeMacAddr);
if (edgeLabel != DestinationSet.NO_EDGE_LABEL) {
tBuilder.pushMpls()
.copyTtlOut()
.setMpls(MplsLabel.mplsLabel(edgeLabel));
}
log.info("{} in device {}: Removing Bucket with Port {} to next object id {}",
"removeFromHash", deviceId, port, nextId);
NextObjective.Builder nextObjBuilder = DefaultNextObjective
.builder()
.withType(NextObjective.Type.HASHED) //same as original
.withId(nextId)
.fromApp(appId)
.addTreatment(tBuilder.build());
ObjectiveContext context = new DefaultObjectiveContext(
(objective) -> log.debug("port {} removedFrom NextObj {} on {}",
port, nextId, deviceId),
(objective, error) ->
log.warn("port {} failed to removeFrom NextObj {} on {}: {}",
port, nextId, deviceId, error));
NextObjective nextObjective = nextObjBuilder.
removeFromExisting(context);
flowObjectiveService.next(deviceId, nextObjective);
}
/**
* Checks all the hash-groups in the target-switch meant for the destination
* switch, and either adds or removes buckets to make the neighbor-set
* match the given next-hops. Typically called by the master instance of the
* destination switch, which may be different from the master instance of the
* target switch where hash-group changes are made.
*
* @param targetSw the switch in which the hash groups will be edited
* @param nextHops the current next hops for the target switch to reach
* the dest sw
* @param destSw the destination switch
* @param revoke true if hash groups need to remove buckets from the
* the groups to match the current next hops
* @return true if calls are made to edit buckets, or if no edits are required
*/
public boolean fixHashGroups(DeviceId targetSw, Set<DeviceId> nextHops,
DeviceId destSw, boolean revoke) {
// temporary storage of keys to be updated
Map<DestinationSetNextObjectiveStoreKey, Set<DeviceId>> tempStore =
new HashMap<>();
boolean foundNextObjective = false;
// retrieve hash-groups meant for destSw, which have destinationSets
// with different neighbors than the given next-hops
for (DestinationSetNextObjectiveStoreKey dskey : dsNextObjStore.keySet()) {
if (!dskey.deviceId().equals(targetSw) ||
!dskey.destinationSet().getDestinationSwitches().contains(destSw)) {
continue;
}
foundNextObjective = true;
NextNeighbors nhops = dsNextObjStore.get(dskey);
Set<DeviceId> currNeighbors = nhops.nextHops(destSw);
int edgeLabel = dskey.destinationSet().getEdgeLabel(destSw);
Integer nextId = nhops.nextId();
Set<DeviceId> diff;
if (revoke) {
diff = Sets.difference(currNeighbors, nextHops);
log.debug("targetSw:{} -> dstSw:{} in nextId:{} has current next "
+ "hops:{} ..removing {}", targetSw, destSw, nextId,
currNeighbors, diff);
} else {
diff = Sets.difference(nextHops, currNeighbors);
log.debug("targetSw:{} -> dstSw:{} in nextId:{} has current next "
+ "hops:{} ..adding {}", targetSw, destSw, nextId,
currNeighbors, diff);
}
for (DeviceId neighbor : diff) {
MacAddress dstMac;
try {
dstMac = deviceConfig.getDeviceMac(neighbor);
} catch (DeviceConfigNotFoundException e) {
log.warn(e.getMessage() + " Aborting fixHashGroup for nextId:"
+ nextId);
return false;
}
if (devicePortMap.get(neighbor) == null ||
devicePortMap.get(neighbor).isEmpty()) {
log.warn("No ports found in dev:{} for neighbor:{} .. cannot "
+ "fix hash group for nextId: {}",
deviceId, neighbor, nextId);
return false;
}
if (revoke) {
for (PortNumber port : devicePortMap.get(neighbor)) {
log.info("fixHashGroup in device {}: Removing Bucket "
+ "with Port {} to next object id {}",
deviceId, port, nextId);
removeFromHashedNextObjective(port, dstMac,
edgeLabel,
nextId);
}
// to update neighbor set with changes made
tempStore.put(dskey, Sets.difference(currNeighbors, diff));
} else {
for (PortNumber port : devicePortMap.get(neighbor)) {
log.info("fixHashGroup in device {}: Adding Bucket "
+ "with Port {} to next object id {}",
deviceId, port, nextId);
addToHashedNextObjective(port, dstMac, edgeLabel, nextId);
}
// to update neighbor set with changes made
tempStore.put(dskey, Sets.union(currNeighbors, diff));
}
}
}
if (!foundNextObjective) {
log.debug("Cannot find any nextObjectives for route targetSw:{} "
+ "-> dstSw:{}", targetSw, destSw);
return true; // nothing to do, return true so ECMPspg is updated
}
// update the dsNextObjectiveStore with new destinationSet to nextId mappings
for (DestinationSetNextObjectiveStoreKey key : tempStore.keySet()) {
NextNeighbors oldHops = dsNextObjStore.get(key);
if (oldHops == null) {
continue;
}
Set<DeviceId> newNeighbors = tempStore.get(key);
Set<DeviceId> oldNeighbors = ImmutableSet.copyOf(oldHops.nextHops(destSw));
oldHops.dstNextHops().put(destSw, newNeighbors);
log.debug("Updating nsNextObjStore: oldHops:{} -> newHops:{} :: nextId:{}",
oldNeighbors, newNeighbors, oldHops.nextId());
}
return true;
}
/**
* Updates the DestinationSetNextObjectiveStore with any per-destination nexthops
* that are not already in the store for the given DestinationSet. Note that
* this method does not remove existing next hops for the destinations in the
* DestinationSet.
*
* @param ds the DestinationSet for which the next hops need to be updated
* @param newDstNextHops a map of per-destination next hops to update the
* destinationSet with
* @return true if successful in updating all next hops
*/
private boolean updateNextHops(DestinationSet ds,
Map<DeviceId, Set<DeviceId>> newDstNextHops) {
DestinationSetNextObjectiveStoreKey key =
new DestinationSetNextObjectiveStoreKey(deviceId, ds);
NextNeighbors currNext = dsNextObjStore.get(key);
Map<DeviceId, Set<DeviceId>> currDstNextHops = currNext.dstNextHops();
// add newDstNextHops to currDstNextHops for each dst
boolean success = true;
for (DeviceId dstSw : ds.getDestinationSwitches()) {
Set<DeviceId> currNhops = currDstNextHops.get(dstSw);
Set<DeviceId> newNhops = newDstNextHops.get(dstSw);
currNhops = (currNhops == null) ? Sets.newHashSet() : currNhops;
newNhops = (newNhops == null) ? Sets.newHashSet() : newNhops;
int edgeLabel = ds.getEdgeLabel(dstSw);
int nextId = currNext.nextId();
// new next hops should be added
boolean suc = updateAllPortsToNextHop(Sets.difference(newNhops, currNhops),
edgeLabel, nextId, false);
if (suc) {
currNhops.addAll(newNhops);
currDstNextHops.put(dstSw, currNhops); // this is only a local change
}
success &= suc;
}
if (success) {
// update global store
dsNextObjStore.put(key, new NextNeighbors(currDstNextHops,
currNext.nextId()));
log.debug("Updated device:{} ds:{} new next-hops: {}", deviceId, ds,
dsNextObjStore.get(key));
}
return success;
}
/**
* Adds or removes buckets for all ports to a set of neighbor devices.
*
* @param neighbors set of neighbor device ids
* @param edgeLabel MPLS label to use in buckets
* @param nextId the nextObjective to change
* @param revoke true if buckets need to be removed, false if they need to
* be added
* @return true if successful in adding or removing buckets for all ports
* to the neighbors
*/
private boolean updateAllPortsToNextHop(Set<DeviceId> neighbors, int edgeLabel,
int nextId, boolean revoke) {
for (DeviceId neighbor : neighbors) {
MacAddress dstMac;
try {
dstMac = deviceConfig.getDeviceMac(neighbor);
} catch (DeviceConfigNotFoundException e) {
log.warn(e.getMessage() + " Aborting fixHashGroup for nextId:"
+ nextId);
return false;
}
if (devicePortMap.get(neighbor) == null ||
devicePortMap.get(neighbor).isEmpty()) {
log.warn("No ports found in dev:{} for neighbor:{} .. cannot "
+ "fix hash group for nextId: {}",
deviceId, neighbor, nextId);
return false;
}
if (revoke) {
for (PortNumber port : devicePortMap.get(neighbor)) {
log.debug("fixHashGroup in device {}: Removing Bucket "
+ "with Port {} edgeLabel:{} to next object id {}",
deviceId, port, edgeLabel, nextId);
removeFromHashedNextObjective(port, dstMac,
edgeLabel,
nextId);
}
} else {
for (PortNumber port : devicePortMap.get(neighbor)) {
log.debug("fixHashGroup in device {}: Adding Bucket "
+ "with Port {} edgeLabel: {} to next object id {}",
deviceId, port, edgeLabel, nextId);
addToHashedNextObjective(port, dstMac, edgeLabel, nextId);
}
}
}
return true;
}
/**
* Adds or removes a port that has been configured with a vlan to a broadcast group
* for bridging. Should only be called by the master instance for this device.
*
* @param port the port on this device that needs to be added/removed to a bcast group
* @param vlanId the vlan id corresponding to the broadcast domain/group
* @param popVlan indicates if packets should be sent out untagged or not out
* of the port. If true, indicates an access (untagged) or native vlan
* configuration. If false, indicates a trunk (tagged) vlan config.
* @param portUp true if port is enabled, false if disabled
*/
public void processEdgePort(PortNumber port, VlanId vlanId,
boolean popVlan, boolean portUp) {
//get the next id for the subnet and edit it.
Integer nextId = getVlanNextObjectiveId(vlanId);
if (nextId == -1) {
if (portUp) {
log.debug("**Creating flooding group for first port enabled in"
+ " subnet {} on dev {} port {}", vlanId, deviceId, port);
createBcastGroupFromVlan(vlanId, Collections.singleton(port));
} else {
log.warn("Could not find flooding group for subnet {} on dev:{} when"
+ " removing port:{}", vlanId, deviceId, port);
}
return;
}
log.info("**port{} in device {}: {} Bucket with Port {} to"
+ " next-id {}", (portUp) ? "UP" : "DOWN", deviceId,
(portUp) ? "Adding" : "Removing",
port, nextId);
// Create the bucket to be added or removed
TrafficTreatment.Builder tBuilder = DefaultTrafficTreatment.builder();
if (popVlan) {
tBuilder.popVlan();
}
tBuilder.setOutput(port);
TrafficSelector metadata =
DefaultTrafficSelector.builder().matchVlanId(vlanId).build();
NextObjective.Builder nextObjBuilder = DefaultNextObjective
.builder().withId(nextId)
.withType(NextObjective.Type.BROADCAST).fromApp(appId)
.addTreatment(tBuilder.build())
.withMeta(metadata);
ObjectiveContext context = new DefaultObjectiveContext(
(objective) -> log.debug("port {} successfully {} NextObj {} on {}",
port, (portUp) ? "addedTo" : "removedFrom",
nextId, deviceId),
(objective, error) ->
log.warn("port {} failed to {} NextObj {} on {}: {}",
port, (portUp) ? "addTo" : "removeFrom",
nextId, deviceId, error));
NextObjective nextObj = (portUp) ? nextObjBuilder.addToExisting(context)
: nextObjBuilder.removeFromExisting(context);
log.debug("edgePort processed: Submited next objective {} in device {}",
nextId, deviceId);
flowObjectiveService.next(deviceId, nextObj);
}
/**
* Returns the next objective of type hashed associated with the destination set.
* In addition, updates the existing next-objective if new route-route paths found
* have resulted in the addition of new next-hops to a particular destination.
* If there is no existing next objective for this destination set, this method
* would create a next objective and return the nextId. Optionally metadata can be
* passed in for the creation of the next objective.
*
* @param ds destination set
* @param nextHops a map of per destination next hops
* @param meta metadata passed into the creation of a Next Objective
* @param isBos if Bos is set
* @return int if found or -1 if there are errors in the creation of the
* neighbor set.
*/
public int getNextObjectiveId(DestinationSet ds,
Map<DeviceId, Set<DeviceId>> nextHops,
TrafficSelector meta, boolean isBos) {
NextNeighbors next = dsNextObjStore.
get(new DestinationSetNextObjectiveStoreKey(deviceId, ds));
if (next == null) {
log.debug("getNextObjectiveId in device{}: Next objective id "
+ "not found for {} ... creating", deviceId, ds);
log.trace("getNextObjectiveId: nsNextObjStore contents for device {}: {}",
deviceId,
dsNextObjStore.entrySet()
.stream()
.filter((nsStoreEntry) ->
(nsStoreEntry.getKey().deviceId().equals(deviceId)))
.collect(Collectors.toList()));
createGroupFromDestinationSet(ds, nextHops, meta, isBos);
next = dsNextObjStore.
get(new DestinationSetNextObjectiveStoreKey(deviceId, ds));
if (next == null) {
log.warn("getNextObjectiveId: unable to create next objective");
// failure in creating group
return -1;
} else {
log.debug("getNextObjectiveId in device{}: Next objective id {} "
+ "created for {}", deviceId, next.nextId(), ds);
}
} else {
log.trace("getNextObjectiveId in device{}: Next objective id {} "
+ "found for {}", deviceId, next.nextId(), ds);
// should fix hash groups too if next-hops have changed
if (!next.dstNextHops().equals(nextHops)) {
log.debug("Nexthops have changed for dev:{} nextId:{} ..updating",
deviceId, next.nextId());
if (!updateNextHops(ds, nextHops)) {
// failure in updating group
return -1;
}
}
}
return next.nextId();
}
/**
* Returns the next objective of type broadcast associated with the vlan,
* or -1 if no such objective exists. Note that this method does NOT create
* the next objective as a side-effect. It is expected that is objective is
* created at startup from network configuration. Typically this is used
* for L2 flooding within the subnet configured on the switch.
*
* @param vlanId vlan id
* @return int if found or -1
*/
public int getVlanNextObjectiveId(VlanId vlanId) {
Integer nextId = vlanNextObjStore.
get(new VlanNextObjectiveStoreKey(deviceId, vlanId));
return (nextId != null) ? nextId : -1;
}
/**
* Returns the next objective of type simple associated with the port on the
* device, given the treatment. Different treatments to the same port result
* in different next objectives. If no such objective exists, this method
* creates one (if requested) and returns the id. Optionally metadata can be passed in for
* the creation of the objective. Typically this is used for L2 and L3 forwarding
* to compute nodes and containers/VMs on the compute nodes directly attached
* to the switch.
*
* @param portNum the port number for the simple next objective
* @param treatment the actions to apply on the packets (should include outport)
* @param meta optional metadata passed into the creation of the next objective
* @param createIfMissing true if a next object should be created if not found
* @return int if found or created, -1 if there are errors during the
* creation of the next objective.
*/
public int getPortNextObjectiveId(PortNumber portNum, TrafficTreatment treatment,
TrafficSelector meta, boolean createIfMissing) {
Integer nextId = portNextObjStore
.get(new PortNextObjectiveStoreKey(deviceId, portNum, treatment, meta));
if (nextId != null) {
return nextId;
}
log.debug("getPortNextObjectiveId in device {}: Next objective id "
+ "not found for port: {} .. {}", deviceId, portNum,
(createIfMissing) ? "creating" : "aborting");
if (!createIfMissing) {
return -1;
}
// create missing next objective
createGroupFromPort(portNum, treatment, meta);
nextId = portNextObjStore.get(new PortNextObjectiveStoreKey(deviceId, portNum,
treatment, meta));
if (nextId == null) {
log.warn("getPortNextObjectiveId: unable to create next obj"
+ "for dev:{} port:{}", deviceId, portNum);
return -1;
}
return nextId;
}
/**
* Checks if the next objective ID (group) for the neighbor set exists or not.
*
* @param ns neighbor set to check
* @return true if it exists, false otherwise
*/
public boolean hasNextObjectiveId(DestinationSet ns) {
NextNeighbors nextHops = dsNextObjStore.
get(new DestinationSetNextObjectiveStoreKey(deviceId, ns));
if (nextHops == null) {
return false;
}
return true;
}
private void populateNeighborMaps() {
Set<Link> outgoingLinks = linkService.getDeviceEgressLinks(deviceId);
for (Link link : outgoingLinks) {
if (link.type() != Link.Type.DIRECT) {
continue;
}
addNeighborAtPort(link.dst().deviceId(), link.src().port());
}
}
protected void addNeighborAtPort(DeviceId neighborId,
PortNumber portToNeighbor) {
// Update DeviceToPort database
log.debug("Device {} addNeighborAtPort: neighbor {} at port {}",
deviceId, neighborId, portToNeighbor);
Set<PortNumber> ports = Collections
.newSetFromMap(new ConcurrentHashMap<PortNumber, Boolean>());
ports.add(portToNeighbor);
Set<PortNumber> portnums = devicePortMap.putIfAbsent(neighborId, ports);
if (portnums != null) {
portnums.add(portToNeighbor);
}
// Update portToDevice database
DeviceId prev = portDeviceMap.putIfAbsent(portToNeighbor, neighborId);
if (prev != null) {
log.debug("Device: {} port: {} already has neighbor: {} ",
deviceId, portToNeighbor, prev, neighborId);
}
}
/**
* Creates a NextObjective for a hash group in this device from a given
* DestinationSet.
*
* @param ds the DestinationSet
* @param neighbors a map for each destination and its next-hops
* @param meta metadata passed into the creation of a Next Objective
* @param isBos if BoS is set
*/
public void createGroupFromDestinationSet(DestinationSet ds,
Map<DeviceId, Set<DeviceId>> neighbors,
TrafficSelector meta,
boolean isBos) {
int nextId = flowObjectiveService.allocateNextId();
NextObjective.Type type = NextObjective.Type.HASHED;
if (neighbors == null || neighbors.isEmpty()) {
log.warn("createGroupsFromDestinationSet: needs at least one neighbor"
+ "to create group in dev:{} for ds: {} with next-hops {}",
deviceId, ds, neighbors);
return;
}
// If Bos == False and MPLS-ECMP == false, we have
// to use simple group and we will pick a single neighbor for a single dest.
if (!isBos && !srManager.getMplsEcmp()) {
type = NextObjective.Type.SIMPLE;
}
NextObjective.Builder nextObjBuilder = DefaultNextObjective
.builder()
.withId(nextId)
.withType(type)
.fromApp(appId);
if (meta != null) {
nextObjBuilder.withMeta(meta);
}
// create treatment buckets for each neighbor for each dst Device
// except in the special case where we only want to pick a single
// neighbor for a simple group
boolean foundSingleNeighbor = false;
boolean treatmentAdded = false;
Map<DeviceId, Set<DeviceId>> dstNextHops = new ConcurrentHashMap<>();
for (DeviceId dst : ds.getDestinationSwitches()) {
Set<DeviceId> nextHops = neighbors.get(dst);
if (nextHops == null || nextHops.isEmpty()) {
continue;
}
if (foundSingleNeighbor) {
break;
}
for (DeviceId neighborId : nextHops) {
if (devicePortMap.get(neighborId) == null) {
log.warn("Neighbor {} is not in the port map yet for dev:{}",
neighborId, deviceId);
return;
} else if (devicePortMap.get(neighborId).isEmpty()) {
log.warn("There are no ports for "
+ "the Device {} in the port map yet", neighborId);
return;
}
MacAddress neighborMac;
try {
neighborMac = deviceConfig.getDeviceMac(neighborId);
} catch (DeviceConfigNotFoundException e) {
log.warn(e.getMessage() + " Aborting createGroupsFromDestinationset.");
return;
}
// For each port to the neighbor, we create a new treatment
Set<PortNumber> neighborPorts = devicePortMap.get(neighborId);
// In this case we are using a SIMPLE group. We randomly pick a port
if (!isBos && !srManager.getMplsEcmp()) {
int size = devicePortMap.get(neighborId).size();
int index = RandomUtils.nextInt(0, size);
neighborPorts = Collections.singleton(
Iterables.get(devicePortMap.get(neighborId),
index));
foundSingleNeighbor = true;
}
for (PortNumber sp : neighborPorts) {
TrafficTreatment.Builder tBuilder = DefaultTrafficTreatment
.builder();
tBuilder.setEthDst(neighborMac).setEthSrc(nodeMacAddr);
int edgeLabel = ds.getEdgeLabel(dst);
if (edgeLabel != DestinationSet.NO_EDGE_LABEL) {
tBuilder.pushMpls()
.copyTtlOut()
.setMpls(MplsLabel.mplsLabel(edgeLabel));
}
tBuilder.setOutput(sp);
nextObjBuilder.addTreatment(tBuilder.build());
treatmentAdded = true;
//update store
Set<DeviceId> existingNeighbors = dstNextHops.get(dst);
if (existingNeighbors == null) {
existingNeighbors = new HashSet<>();
}
existingNeighbors.add(neighborId);
dstNextHops.put(dst, existingNeighbors);
log.debug("creating treatment for port/label {}/{} in next:{}",
sp, edgeLabel, nextId);
}
if (foundSingleNeighbor) {
break;
}
}
}
if (!treatmentAdded) {
log.warn("Could not createGroup from DestinationSet {} without any"
+ "next hops {}", ds, neighbors);
return;
}
ObjectiveContext context = new DefaultObjectiveContext(
(objective) ->
log.debug("createGroupsFromDestinationSet installed "
+ "NextObj {} on {}", nextId, deviceId),
(objective, error) ->
log.warn("createGroupsFromDestinationSet failed to install"
+ " NextObj {} on {}: {}", nextId, deviceId, error)
);
NextObjective nextObj = nextObjBuilder.add(context);
log.debug(".. createGroupsFromDestinationSet: Submitted "
+ "next objective {} in device {}", nextId, deviceId);
flowObjectiveService.next(deviceId, nextObj);
//update store
dsNextObjStore.put(new DestinationSetNextObjectiveStoreKey(deviceId, ds),
new NextNeighbors(dstNextHops, nextId));
}
/**
* Creates broadcast groups for all ports in the same subnet for
* all configured subnets.
*/
public void createGroupsFromVlanConfig() {
srManager.getVlanPortMap(deviceId).asMap().forEach((vlanId, ports) -> {
createBcastGroupFromVlan(vlanId, ports);
});
}
/**
* Creates a single broadcast group from a given vlan id and list of ports.
*
* @param vlanId vlan id
* @param ports list of ports in the subnet
*/
public void createBcastGroupFromVlan(VlanId vlanId, Collection<PortNumber> ports) {
VlanNextObjectiveStoreKey key = new VlanNextObjectiveStoreKey(deviceId, vlanId);
if (vlanNextObjStore.containsKey(key)) {
log.debug("Broadcast group for device {} and subnet {} exists",
deviceId, vlanId);
return;
}
TrafficSelector metadata =
DefaultTrafficSelector.builder().matchVlanId(vlanId).build();
int nextId = flowObjectiveService.allocateNextId();
NextObjective.Builder nextObjBuilder = DefaultNextObjective
.builder().withId(nextId)
.withType(NextObjective.Type.BROADCAST).fromApp(appId)
.withMeta(metadata);
ports.forEach(port -> {
TrafficTreatment.Builder tBuilder = DefaultTrafficTreatment.builder();
if (toPopVlan(port, vlanId)) {
tBuilder.popVlan();
}
tBuilder.setOutput(port);
nextObjBuilder.addTreatment(tBuilder.build());
});
ObjectiveContext context = new DefaultObjectiveContext(
(objective) ->
log.debug("createBroadcastGroupFromVlan installed "
+ "NextObj {} on {}", nextId, deviceId),
(objective, error) ->
log.warn("createBroadcastGroupFromVlan failed to install"
+ " NextObj {} on {}: {}", nextId, deviceId, error)
);
NextObjective nextObj = nextObjBuilder.add(context);
flowObjectiveService.next(deviceId, nextObj);
log.debug("createBcastGroupFromVlan: Submited next objective {} in device {}",
nextId, deviceId);
vlanNextObjStore.put(key, nextId);
}
/**
* Determine if we should pop given vlan before sending packets to the given port.
*
* @param portNumber port number
* @param vlanId vlan id
* @return true if the vlan id is not contained in any vlanTagged config
*/
private boolean toPopVlan(PortNumber portNumber, VlanId vlanId) {
return srManager.interfaceService
.getInterfacesByPort(new ConnectPoint(deviceId, portNumber))
.stream().noneMatch(intf -> intf.vlanTagged().contains(vlanId));
}
/**
* Create simple next objective for a single port. The treatments can include
* all outgoing actions that need to happen on the packet.
*
* @param portNum the outgoing port on the device
* @param treatment the actions to apply on the packets (should include outport)
* @param meta optional data to pass to the driver
*/
public void createGroupFromPort(PortNumber portNum, TrafficTreatment treatment,
TrafficSelector meta) {
int nextId = flowObjectiveService.allocateNextId();
PortNextObjectiveStoreKey key = new PortNextObjectiveStoreKey(
deviceId, portNum, treatment, meta);
NextObjective.Builder nextObjBuilder = DefaultNextObjective
.builder().withId(nextId)
.withType(NextObjective.Type.SIMPLE)
.addTreatment(treatment)
.fromApp(appId)
.withMeta(meta);
ObjectiveContext context = new DefaultObjectiveContext(
(objective) ->
log.debug("createGroupFromPort installed "
+ "NextObj {} on {}", nextId, deviceId),
(objective, error) ->
log.warn("createGroupFromPort failed to install"
+ " NextObj {} on {}: {}", nextId, deviceId, error)
);
NextObjective nextObj = nextObjBuilder.add(context);
flowObjectiveService.next(deviceId, nextObj);
log.debug("createGroupFromPort: Submited next objective {} in device {} "
+ "for port {}", nextId, deviceId, portNum);
portNextObjStore.put(key, nextId);
}
/**
* Removes groups for the next objective ID given.
*
* @param objectiveId next objective ID to remove
* @return true if succeeds, false otherwise
*/
public boolean removeGroup(int objectiveId) {
for (Map.Entry<DestinationSetNextObjectiveStoreKey, NextNeighbors> e :
dsNextObjStore.entrySet()) {
if (e.getValue().nextId() != objectiveId) {
continue;
}
NextObjective.Builder nextObjBuilder = DefaultNextObjective
.builder().withId(objectiveId)
.withType(NextObjective.Type.HASHED).fromApp(appId);
ObjectiveContext context = new DefaultObjectiveContext(
(objective) -> log.debug("RemoveGroup removes NextObj {} on {}",
objectiveId, deviceId),
(objective, error) ->
log.warn("RemoveGroup failed to remove NextObj {} on {}: {}",
objectiveId, deviceId, error));
NextObjective nextObjective = nextObjBuilder.remove(context);
log.info("**removeGroup: Submited "
+ "next objective {} in device {}",
objectiveId, deviceId);
flowObjectiveService.next(deviceId, nextObjective);
dsNextObjStore.remove(e.getKey());
return true;
}
return false;
}
/**
* Removes all groups from all next objective stores.
*/
/*public void removeAllGroups() {
for (Map.Entry<NeighborSetNextObjectiveStoreKey, NextNeighbors> entry:
nsNextObjStore.entrySet()) {
removeGroup(entry.getValue().nextId());
}
for (Map.Entry<PortNextObjectiveStoreKey, Integer> entry:
portNextObjStore.entrySet()) {
removeGroup(entry.getValue());
}
for (Map.Entry<VlanNextObjectiveStoreKey, Integer> entry:
vlanNextObjStore.entrySet()) {
removeGroup(entry.getValue());
}
}*/ //XXX revisit
/**
* Triggers a one time bucket verification operation on all hash groups
* on this device.
*/
public void triggerBucketCorrector() {
BucketCorrector bc = new BucketCorrector();
bc.run();
}
/**
*
*
*/
protected final class BucketCorrector implements Runnable {
Integer nextId;
BucketCorrector() {
this.nextId = null;
}
BucketCorrector(Integer nextId) {
this.nextId = nextId;
}
@Override
public void run() {
if (!srManager.mastershipService.isLocalMaster(deviceId)) {
return;
}
DefaultRoutingHandler rh = srManager.getRoutingHandler();
if (rh == null) {
return;
}
if (!rh.isRoutingStable()) {
return;
}
rh.acquireRoutingLock();
try {
log.debug("running bucket corrector for dev: {}", deviceId);
Set<DestinationSetNextObjectiveStoreKey> dsKeySet = dsNextObjStore.entrySet()
.stream()
.filter(entry -> entry.getKey().deviceId().equals(deviceId))
.map(entry -> entry.getKey())
.collect(Collectors.toSet());
for (DestinationSetNextObjectiveStoreKey dsKey : dsKeySet) {
NextNeighbors next = dsNextObjStore.get(dsKey);
if (next == null) {
continue;
}
int nid = next.nextId();
if (nextId != null && nextId != nid) {
continue;
}
log.debug("bkt-corr: dsNextObjStore for device {}: {}",
deviceId, dsKey, next);
TrafficSelector.Builder metabuilder = DefaultTrafficSelector.builder();
metabuilder.matchVlanId(INTERNAL_VLAN);
NextObjective.Builder nextObjBuilder = DefaultNextObjective.builder()
.withId(nid)
.withType(NextObjective.Type.HASHED)
.withMeta(metabuilder.build())
.fromApp(appId);
next.dstNextHops().forEach((dstDev, nextHops) -> {
int edgeLabel = dsKey.destinationSet().getEdgeLabel(dstDev);
nextHops.forEach(neighbor -> {
MacAddress neighborMac;
try {
neighborMac = deviceConfig.getDeviceMac(neighbor);
} catch (DeviceConfigNotFoundException e) {
log.warn(e.getMessage() + " Aborting neighbor"
+ neighbor);
return;
}
devicePortMap.get(neighbor).forEach(port -> {
log.debug("verify in device {} nextId {}: bucket with"
+ " port/label {}/{} to dst {} via {}",
deviceId, nid, port, edgeLabel,
dstDev, neighbor);
nextObjBuilder.addTreatment(treatmentBuilder(port,
neighborMac, edgeLabel));
});
});
});
NextObjective nextObjective = nextObjBuilder.verify();
flowObjectiveService.next(deviceId, nextObjective);
}
} finally {
rh.releaseRoutingLock();
}
}
TrafficTreatment treatmentBuilder(PortNumber outport, MacAddress dstMac,
int edgeLabel) {
TrafficTreatment.Builder tBuilder =
DefaultTrafficTreatment.builder();
tBuilder.setOutput(outport)
.setEthDst(dstMac)
.setEthSrc(nodeMacAddr);
if (edgeLabel != DestinationSet.NO_EDGE_LABEL) {
tBuilder.pushMpls()
.copyTtlOut()
.setMpls(MplsLabel.mplsLabel(edgeLabel));
}
return tBuilder.build();
}
}
}