| /* |
| * 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.xconnect.impl; |
| |
| import com.google.common.collect.ImmutableList; |
| import com.google.common.cache.Cache; |
| import com.google.common.cache.CacheBuilder; |
| import com.google.common.cache.RemovalNotification; |
| import com.google.common.collect.ImmutableMap; |
| import com.google.common.collect.ImmutableSet; |
| import com.google.common.collect.Lists; |
| import com.google.common.collect.Sets; |
| import org.onlab.packet.Ethernet; |
| import org.onlab.packet.MacAddress; |
| import org.onlab.packet.VlanId; |
| import org.onlab.util.KryoNamespace; |
| import org.onosproject.cluster.ClusterService; |
| import org.onosproject.cluster.LeadershipService; |
| import org.onosproject.cluster.NodeId; |
| import org.onosproject.codec.CodecService; |
| import org.onosproject.core.ApplicationId; |
| import org.onosproject.core.CoreService; |
| import org.onosproject.portloadbalancer.api.PortLoadBalancerEvent; |
| import org.onosproject.portloadbalancer.api.PortLoadBalancerId; |
| import org.onosproject.portloadbalancer.api.PortLoadBalancerListener; |
| import org.onosproject.portloadbalancer.api.PortLoadBalancerService; |
| import org.onosproject.mastership.MastershipService; |
| import org.onosproject.net.ConnectPoint; |
| import org.onosproject.net.DeviceId; |
| import org.onosproject.net.Host; |
| import org.onosproject.net.HostLocation; |
| import org.onosproject.net.PortNumber; |
| import org.onosproject.net.config.NetworkConfigService; |
| import org.onosproject.net.device.DeviceEvent; |
| import org.onosproject.net.device.DeviceListener; |
| import org.onosproject.net.device.DeviceService; |
| 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.flow.criteria.Criteria; |
| import org.onosproject.net.flowobjective.DefaultFilteringObjective; |
| import org.onosproject.net.flowobjective.DefaultForwardingObjective; |
| import org.onosproject.net.flowobjective.DefaultNextObjective; |
| import org.onosproject.net.flowobjective.DefaultNextTreatment; |
| import org.onosproject.net.flowobjective.DefaultObjectiveContext; |
| import org.onosproject.net.flowobjective.FilteringObjective; |
| import org.onosproject.net.flowobjective.FlowObjectiveService; |
| import org.onosproject.net.flowobjective.ForwardingObjective; |
| import org.onosproject.net.flowobjective.IdNextTreatment; |
| import org.onosproject.net.flowobjective.NextObjective; |
| import org.onosproject.net.flowobjective.NextTreatment; |
| import org.onosproject.net.flowobjective.Objective; |
| import org.onosproject.net.flowobjective.ObjectiveContext; |
| import org.onosproject.net.flowobjective.ObjectiveError; |
| import org.onosproject.net.host.HostEvent; |
| import org.onosproject.net.host.HostListener; |
| import org.onosproject.net.host.HostService; |
| import org.onosproject.net.intf.InterfaceService; |
| import org.onosproject.segmentrouting.SegmentRoutingService; |
| import org.onosproject.segmentrouting.storekey.VlanNextObjectiveStoreKey; |
| import org.onosproject.segmentrouting.xconnect.api.XconnectCodec; |
| import org.onosproject.segmentrouting.xconnect.api.XconnectDesc; |
| import org.onosproject.segmentrouting.xconnect.api.XconnectEndpoint; |
| import org.onosproject.segmentrouting.xconnect.api.XconnectKey; |
| import org.onosproject.segmentrouting.xconnect.api.XconnectLoadBalancerEndpoint; |
| import org.onosproject.segmentrouting.xconnect.api.XconnectPortEndpoint; |
| import org.onosproject.segmentrouting.xconnect.api.XconnectService; |
| 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.osgi.service.component.annotations.Activate; |
| import org.osgi.service.component.annotations.Component; |
| import org.osgi.service.component.annotations.Deactivate; |
| import org.osgi.service.component.annotations.Reference; |
| import org.osgi.service.component.annotations.ReferenceCardinality; |
| import org.slf4j.Logger; |
| import org.slf4j.LoggerFactory; |
| |
| import java.io.Serializable; |
| import java.util.Collections; |
| import java.util.List; |
| import java.util.Optional; |
| import java.util.Set; |
| import java.util.concurrent.CompletableFuture; |
| import java.util.concurrent.ExecutorService; |
| import java.util.concurrent.Executors; |
| import java.util.concurrent.ScheduledExecutorService; |
| import java.util.concurrent.TimeUnit; |
| import java.util.function.BiConsumer; |
| import java.util.function.Consumer; |
| import java.util.stream.Collectors; |
| |
| import static java.util.concurrent.Executors.newScheduledThreadPool; |
| import static org.onlab.util.Tools.groupedThreads; |
| |
| @Component(immediate = true, service = XconnectService.class) |
| public class XconnectManager implements XconnectService { |
| @Reference(cardinality = ReferenceCardinality.MANDATORY) |
| private CoreService coreService; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY) |
| private CodecService codecService; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY) |
| private StorageService storageService; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY) |
| public NetworkConfigService netCfgService; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY) |
| public DeviceService deviceService; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY) |
| public FlowObjectiveService flowObjectiveService; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY) |
| private LeadershipService leadershipService; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY) |
| private ClusterService clusterService; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY) |
| public MastershipService mastershipService; |
| |
| @Reference(cardinality = ReferenceCardinality.OPTIONAL) |
| public SegmentRoutingService srService; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY) |
| public InterfaceService interfaceService; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY) |
| HostService hostService; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY) |
| private PortLoadBalancerService portLoadBalancerService; |
| |
| private static final String APP_NAME = "org.onosproject.xconnect"; |
| private static final String ERROR_NOT_LEADER = "Not leader controller"; |
| private static final String ERROR_NEXT_OBJ_BUILDER = "Unable to construct next objective builder"; |
| private static final String ERROR_NEXT_ID = "Unable to get next id"; |
| |
| private static Logger log = LoggerFactory.getLogger(XconnectManager.class); |
| |
| private ApplicationId appId; |
| private ConsistentMap<XconnectKey, Set<XconnectEndpoint>> xconnectStore; |
| private ConsistentMap<XconnectKey, Integer> xconnectNextObjStore; |
| |
| private ConsistentMap<VlanNextObjectiveStoreKey, Integer> xconnectMulticastNextStore; |
| private ConsistentMap<VlanNextObjectiveStoreKey, List<PortNumber>> xconnectMulticastPortsStore; |
| |
| private final MapEventListener<XconnectKey, Set<XconnectEndpoint>> xconnectListener = new XconnectMapListener(); |
| private ExecutorService xConnectExecutor; |
| |
| private final DeviceListener deviceListener = new InternalDeviceListener(); |
| private ExecutorService deviceEventExecutor; |
| |
| private final HostListener hostListener = new InternalHostListener(); |
| private ExecutorService hostEventExecutor; |
| |
| // Wait time for the cache |
| private static final int WAIT_TIME_MS = 15000; |
| //The cache is implemented as buffer for waiting the installation of PortLoadBalancer when present |
| private Cache<PortLoadBalancerId, XconnectKey> portLoadBalancerCache; |
| // Executor for the cache |
| private ScheduledExecutorService portLoadBalancerExecutor; |
| // We need to listen for some events to properly installed the xconnect with portloadbalancer |
| private final PortLoadBalancerListener portLoadBalancerListener = new InternalPortLoadBalancerListener(); |
| |
| @Activate |
| void activate() { |
| appId = coreService.registerApplication(APP_NAME); |
| codecService.registerCodec(XconnectDesc.class, new XconnectCodec()); |
| |
| KryoNamespace.Builder serializer = KryoNamespace.newBuilder() |
| .register(KryoNamespaces.API) |
| .register(XconnectManager.class) |
| .register(XconnectKey.class) |
| .register(XconnectEndpoint.class) |
| .register(XconnectPortEndpoint.class) |
| .register(XconnectLoadBalancerEndpoint.class) |
| .register(VlanNextObjectiveStoreKey.class); |
| |
| xconnectStore = storageService.<XconnectKey, Set<XconnectEndpoint>>consistentMapBuilder() |
| .withName("onos-sr-xconnect") |
| .withRelaxedReadConsistency() |
| .withSerializer(Serializer.using(serializer.build())) |
| .build(); |
| xConnectExecutor = Executors.newSingleThreadScheduledExecutor( |
| groupedThreads("sr-xconnect-event", "%d", log)); |
| xconnectStore.addListener(xconnectListener, xConnectExecutor); |
| |
| xconnectNextObjStore = storageService.<XconnectKey, Integer>consistentMapBuilder() |
| .withName("onos-sr-xconnect-next") |
| .withRelaxedReadConsistency() |
| .withSerializer(Serializer.using(serializer.build())) |
| .build(); |
| |
| xconnectMulticastNextStore = storageService.<VlanNextObjectiveStoreKey, Integer>consistentMapBuilder() |
| .withName("onos-sr-xconnect-l2multicast-next") |
| .withSerializer(Serializer.using(serializer.build())) |
| .build(); |
| xconnectMulticastPortsStore = storageService.<VlanNextObjectiveStoreKey, List<PortNumber>>consistentMapBuilder() |
| .withName("onos-sr-xconnect-l2multicast-ports") |
| .withSerializer(Serializer.using(serializer.build())) |
| .build(); |
| |
| deviceEventExecutor = Executors.newSingleThreadScheduledExecutor( |
| groupedThreads("sr-xconnect-device-event", "%d", log)); |
| deviceService.addListener(deviceListener); |
| |
| hostEventExecutor = Executors.newSingleThreadExecutor( |
| groupedThreads("sr-xconnect-host-event", "%d", log)); |
| hostService.addListener(hostListener); |
| |
| portLoadBalancerCache = CacheBuilder.newBuilder() |
| .expireAfterWrite(WAIT_TIME_MS, TimeUnit.MILLISECONDS) |
| .removalListener((RemovalNotification<PortLoadBalancerId, XconnectKey> notification) -> |
| log.debug("PortLoadBalancer cache removal event. portLoadBalancerId={}, xConnectKey={}", |
| notification.getKey(), notification.getValue())).build(); |
| portLoadBalancerExecutor = newScheduledThreadPool(1, |
| groupedThreads("portLoadBalancerCacheWorker", "-%d", log)); |
| // Let's schedule the cleanup of the cache |
| portLoadBalancerExecutor.scheduleAtFixedRate(portLoadBalancerCache::cleanUp, 0, |
| WAIT_TIME_MS, TimeUnit.MILLISECONDS); |
| portLoadBalancerService.addListener(portLoadBalancerListener); |
| |
| log.info("Started"); |
| } |
| |
| @Deactivate |
| void deactivate() { |
| xconnectStore.removeListener(xconnectListener); |
| deviceService.removeListener(deviceListener); |
| hostService.removeListener(hostListener); |
| codecService.unregisterCodec(XconnectDesc.class); |
| |
| deviceEventExecutor.shutdown(); |
| hostEventExecutor.shutdown(); |
| xConnectExecutor.shutdown(); |
| portLoadBalancerExecutor.shutdown(); |
| |
| log.info("Stopped"); |
| } |
| |
| @Override |
| public void addOrUpdateXconnect(DeviceId deviceId, VlanId vlanId, Set<XconnectEndpoint> endpoints) { |
| log.info("Adding or updating xconnect. deviceId={}, vlanId={}, endpoints={}", |
| deviceId, vlanId, endpoints); |
| final XconnectKey key = new XconnectKey(deviceId, vlanId); |
| xconnectStore.put(key, endpoints); |
| } |
| |
| @Override |
| public void removeXonnect(DeviceId deviceId, VlanId vlanId) { |
| log.info("Removing xconnect. deviceId={}, vlanId={}", |
| deviceId, vlanId); |
| final XconnectKey key = new XconnectKey(deviceId, vlanId); |
| xconnectStore.remove(key); |
| |
| // Cleanup multicasting support, if any. |
| srService.getPairDeviceId(deviceId).ifPresent(pairDeviceId -> |
| cleanupL2MulticastRule(pairDeviceId, srService.getPairLocalPort(pairDeviceId).get(), vlanId, true) |
| ); |
| |
| } |
| |
| @Override |
| public Set<XconnectDesc> getXconnects() { |
| return xconnectStore.asJavaMap().entrySet().stream() |
| .map(e -> new XconnectDesc(e.getKey(), e.getValue())) |
| .collect(Collectors.toSet()); |
| } |
| |
| @Override |
| public boolean hasXconnect(ConnectPoint cp) { |
| return getXconnects().stream().anyMatch(desc -> |
| desc.key().deviceId().equals(cp.deviceId()) && desc.endpoints().stream().anyMatch(ep -> |
| ep.type() == XconnectEndpoint.Type.PORT && ((XconnectPortEndpoint) ep).port().equals(cp.port()) |
| ) |
| ); |
| } |
| |
| @Override |
| public List<VlanId> getXconnectVlans(DeviceId deviceId, PortNumber port) { |
| return getXconnects().stream() |
| .filter(desc -> desc.key().deviceId().equals(deviceId) && desc.endpoints().stream().anyMatch(ep -> |
| ep.type() == XconnectEndpoint.Type.PORT && ((XconnectPortEndpoint) ep).port().equals(port))) |
| .map(XconnectDesc::key) |
| .map(XconnectKey::vlanId) |
| .collect(Collectors.toList()); |
| } |
| |
| @Override |
| public boolean isXconnectVlan(DeviceId deviceId, VlanId vlanId) { |
| XconnectKey key = new XconnectKey(deviceId, vlanId); |
| return Versioned.valueOrNull(xconnectStore.get(key)) != null; |
| } |
| |
| @Override |
| public ImmutableMap<XconnectKey, Integer> getNext() { |
| if (xconnectNextObjStore != null) { |
| return ImmutableMap.copyOf(xconnectNextObjStore.asJavaMap()); |
| } else { |
| return ImmutableMap.of(); |
| } |
| } |
| |
| @Override |
| public int getNextId(DeviceId deviceId, VlanId vlanId) { |
| return Versioned.valueOrElse(xconnectNextObjStore.get(new XconnectKey(deviceId, vlanId)), -1); |
| } |
| |
| @Override |
| public void removeNextId(int nextId) { |
| xconnectNextObjStore.entrySet().forEach(e -> { |
| if (e.getValue().value() == nextId) { |
| xconnectNextObjStore.remove(e.getKey()); |
| } |
| }); |
| } |
| |
| private class XconnectMapListener implements MapEventListener<XconnectKey, Set<XconnectEndpoint>> { |
| @Override |
| public void event(MapEvent<XconnectKey, Set<XconnectEndpoint>> event) { |
| XconnectKey key = event.key(); |
| Set<XconnectEndpoint> ports = Versioned.valueOrNull(event.newValue()); |
| Set<XconnectEndpoint> oldPorts = Versioned.valueOrNull(event.oldValue()); |
| |
| switch (event.type()) { |
| case INSERT: |
| populateXConnect(key, ports); |
| break; |
| case UPDATE: |
| updateXConnect(key, oldPorts, ports); |
| break; |
| case REMOVE: |
| revokeXConnect(key, oldPorts); |
| break; |
| default: |
| break; |
| } |
| } |
| } |
| |
| private class InternalDeviceListener implements DeviceListener { |
| // Offload the execution to an executor and then process the event |
| // if this instance is the leader of the device |
| @Override |
| public void event(DeviceEvent event) { |
| deviceEventExecutor.execute(() -> { |
| DeviceId deviceId = event.subject().id(); |
| // Just skip if we are not the leader |
| if (!isLocalLeader(deviceId)) { |
| log.debug("Not the leader of {}. Skip event {}", deviceId, event); |
| return; |
| } |
| // Populate or revoke according to the device availability |
| if (deviceService.isAvailable(deviceId)) { |
| init(deviceId); |
| } else { |
| cleanup(deviceId); |
| } |
| }); |
| } |
| // We want to manage only a subset of events and if we are the leader |
| @Override |
| public boolean isRelevant(DeviceEvent event) { |
| return event.type() == DeviceEvent.Type.DEVICE_ADDED || |
| event.type() == DeviceEvent.Type.DEVICE_AVAILABILITY_CHANGED || |
| event.type() == DeviceEvent.Type.DEVICE_UPDATED; |
| } |
| } |
| |
| private class InternalHostListener implements HostListener { |
| @Override |
| public void event(HostEvent event) { |
| hostEventExecutor.execute(() -> { |
| |
| switch (event.type()) { |
| case HOST_MOVED: |
| log.trace("Processing host event {}", event); |
| |
| Host host = event.subject(); |
| Set<HostLocation> prevLocations = event.prevSubject().locations(); |
| Set<HostLocation> newLocations = host.locations(); |
| |
| // Dual-home host port failure |
| // For each old location, in failed and paired devices update L2 vlan groups |
| Sets.difference(prevLocations, newLocations).forEach(prevLocation -> { |
| |
| Optional<DeviceId> pairDeviceId = srService.getPairDeviceId(prevLocation.deviceId()); |
| Optional<PortNumber> pairLocalPort = srService.getPairLocalPort(prevLocation.deviceId()); |
| |
| if (pairDeviceId.isPresent() && pairLocalPort.isPresent() && newLocations.stream() |
| .anyMatch(location -> location.deviceId().equals(pairDeviceId.get())) && |
| hasXconnect(new ConnectPoint(prevLocation.deviceId(), prevLocation.port()))) { |
| |
| List<VlanId> xconnectVlans = getXconnectVlans(prevLocation.deviceId(), |
| prevLocation.port()); |
| xconnectVlans.forEach(xconnectVlan -> { |
| // Add single-home host into L2 multicast group at paired device side. |
| // Also append ACL rule to forward traffic from paired port to L2 multicast group. |
| newLocations.stream() |
| .filter(location -> location.deviceId().equals(pairDeviceId.get())) |
| .forEach(location -> populateL2Multicast(location.deviceId(), |
| srService.getPairLocalPort( |
| location.deviceId()).get(), |
| xconnectVlan, |
| Collections.singletonList( |
| location.port()))); |
| // Ensure pair-port attached to xconnect vlan flooding group |
| // at dual home failed device. |
| updateL2Flooding(prevLocation.deviceId(), pairLocalPort.get(), xconnectVlan, true); |
| }); |
| } |
| }); |
| |
| // Dual-home host port restoration |
| // For each new location, reverse xconnect loop prevention groups. |
| Sets.difference(newLocations, prevLocations).forEach(newLocation -> { |
| final Optional<DeviceId> pairDeviceId = srService.getPairDeviceId(newLocation.deviceId()); |
| Optional<PortNumber> pairLocalPort = srService.getPairLocalPort(newLocation.deviceId()); |
| if (pairDeviceId.isPresent() && pairLocalPort.isPresent() && |
| hasXconnect((new ConnectPoint(newLocation.deviceId(), newLocation.port())))) { |
| |
| List<VlanId> xconnectVlans = getXconnectVlans(newLocation.deviceId(), |
| newLocation.port()); |
| xconnectVlans.forEach(xconnectVlan -> { |
| // Remove recovered dual homed port from vlan L2 multicast group |
| prevLocations.stream() |
| .filter(prevLocation -> prevLocation.deviceId().equals(pairDeviceId.get())) |
| .forEach(prevLocation -> revokeL2Multicast( |
| prevLocation.deviceId(), |
| xconnectVlan, |
| Collections.singletonList(newLocation.port())) |
| ); |
| |
| // Remove pair-port from vlan's flooding group at dual home |
| // restored device, if needed. |
| if (!hasAccessPortInMulticastGroup(new VlanNextObjectiveStoreKey( |
| newLocation.deviceId(), xconnectVlan), pairLocalPort.get())) { |
| updateL2Flooding(newLocation.deviceId(), |
| pairLocalPort.get(), |
| xconnectVlan, |
| false); |
| |
| // Clean L2 multicast group at pair-device; also update store. |
| cleanupL2MulticastRule(pairDeviceId.get(), |
| srService.getPairLocalPort(pairDeviceId.get()).get(), |
| xconnectVlan, |
| false); |
| } |
| }); |
| } |
| }); |
| break; |
| |
| default: |
| log.warn("Unsupported host event type: {} received. Ignoring.", event.type()); |
| break; |
| } |
| }); |
| } |
| } |
| |
| private void init(DeviceId deviceId) { |
| getXconnects().stream() |
| .filter(desc -> desc.key().deviceId().equals(deviceId)) |
| .forEach(desc -> populateXConnect(desc.key(), desc.endpoints())); |
| } |
| |
| private void cleanup(DeviceId deviceId) { |
| xconnectNextObjStore.entrySet().stream() |
| .filter(entry -> entry.getKey().deviceId().equals(deviceId)) |
| .forEach(entry -> xconnectNextObjStore.remove(entry.getKey())); |
| log.debug("{} is removed from xConnectNextObjStore", deviceId); |
| } |
| |
| /** |
| * Populates XConnect groups and flows for given key. |
| * |
| * @param key XConnect key |
| * @param endpoints a set of endpoints to be cross-connected |
| */ |
| private void populateXConnect(XconnectKey key, Set<XconnectEndpoint> endpoints) { |
| if (!isLocalLeader(key.deviceId())) { |
| log.debug("Abort populating XConnect {}: {}", key, ERROR_NOT_LEADER); |
| return; |
| } |
| |
| int nextId = populateNext(key, endpoints); |
| if (nextId == -1) { |
| log.warn("Fail to populateXConnect {}: {}", key, ERROR_NEXT_ID); |
| return; |
| } |
| populateFilter(key, endpoints); |
| populateFwd(key, nextId); |
| populateAcl(key); |
| } |
| |
| /** |
| * Populates filtering objectives for given XConnect. |
| * |
| * @param key XConnect store key |
| * @param endpoints XConnect endpoints |
| */ |
| private void populateFilter(XconnectKey key, Set<XconnectEndpoint> endpoints) { |
| // FIXME Improve the logic |
| // If port load balancer is not involved, use filtered port. Otherwise, use unfiltered port. |
| // The purpose is to make sure existing XConnect logic can still work on a configured port. |
| boolean filtered = endpoints.stream() |
| .map(ep -> getNextTreatment(key.deviceId(), ep, false)) |
| .allMatch(t -> t.type().equals(NextTreatment.Type.TREATMENT)); |
| |
| endpoints.stream() |
| .map(ep -> getPhysicalPorts(key.deviceId(), ep)) |
| .flatMap(Set::stream).forEach(port -> { |
| FilteringObjective.Builder filtObjBuilder = filterObjBuilder(key, port, filtered); |
| ObjectiveContext context = new DefaultObjectiveContext( |
| (objective) -> log.debug("XConnect FilterObj for {} on port {} populated", |
| key, port), |
| (objective, error) -> |
| log.warn("Failed to populate XConnect FilterObj for {} on port {}: {}", |
| key, port, error)); |
| flowObjectiveService.filter(key.deviceId(), filtObjBuilder.add(context)); |
| }); |
| } |
| |
| /** |
| * Populates next objectives for given XConnect. |
| * |
| * @param key XConnect store key |
| * @param endpoints XConnect endpoints |
| * @return next id |
| */ |
| private int populateNext(XconnectKey key, Set<XconnectEndpoint> endpoints) { |
| int nextId = Versioned.valueOrElse(xconnectNextObjStore.get(key), -1); |
| if (nextId != -1) { |
| log.debug("NextObj for {} found, id={}", key, nextId); |
| return nextId; |
| } else { |
| NextObjective.Builder nextObjBuilder = nextObjBuilder(key, endpoints); |
| if (nextObjBuilder == null) { |
| log.warn("Fail to populate {}: {}", key, ERROR_NEXT_OBJ_BUILDER); |
| return -1; |
| } |
| ObjectiveContext nextContext = new DefaultObjectiveContext( |
| // To serialize this with kryo |
| (Serializable & Consumer<Objective>) (objective) -> |
| log.debug("XConnect NextObj for {} added", key), |
| (Serializable & BiConsumer<Objective, ObjectiveError>) (objective, error) -> { |
| log.warn("Failed to add XConnect NextObj for {}: {}", key, error); |
| srService.invalidateNextObj(objective.id()); |
| }); |
| NextObjective nextObj = nextObjBuilder.add(nextContext); |
| flowObjectiveService.next(key.deviceId(), nextObj); |
| xconnectNextObjStore.put(key, nextObj.id()); |
| log.debug("NextObj for {} not found. Creating new NextObj with id={}", key, nextObj.id()); |
| return nextObj.id(); |
| } |
| } |
| |
| /** |
| * Populates bridging forwarding objectives for given XConnect. |
| * |
| * @param key XConnect store key |
| * @param nextId next objective id |
| */ |
| private void populateFwd(XconnectKey key, int nextId) { |
| ForwardingObjective.Builder fwdObjBuilder = fwdObjBuilder(key, nextId); |
| ObjectiveContext fwdContext = new DefaultObjectiveContext( |
| (objective) -> log.debug("XConnect FwdObj for {} populated", key), |
| (objective, error) -> |
| log.warn("Failed to populate XConnect FwdObj for {}: {}", key, error)); |
| flowObjectiveService.forward(key.deviceId(), fwdObjBuilder.add(fwdContext)); |
| } |
| |
| /** |
| * Populates ACL forwarding objectives for given XConnect. |
| * |
| * @param key XConnect store key |
| */ |
| private void populateAcl(XconnectKey key) { |
| ForwardingObjective.Builder aclObjBuilder = aclObjBuilder(key.vlanId()); |
| ObjectiveContext aclContext = new DefaultObjectiveContext( |
| (objective) -> log.debug("XConnect AclObj for {} populated", key), |
| (objective, error) -> |
| log.warn("Failed to populate XConnect AclObj for {}: {}", key, error)); |
| flowObjectiveService.forward(key.deviceId(), aclObjBuilder.add(aclContext)); |
| } |
| |
| /** |
| * Revokes XConnect groups and flows for given key. |
| * |
| * @param key XConnect key |
| * @param endpoints XConnect endpoints |
| */ |
| private void revokeXConnect(XconnectKey key, Set<XconnectEndpoint> endpoints) { |
| if (!isLocalLeader(key.deviceId())) { |
| log.debug("Abort revoking XConnect {}: {}", key, ERROR_NOT_LEADER); |
| return; |
| } |
| |
| revokeFilter(key, endpoints); |
| int nextId = Versioned.valueOrElse(xconnectNextObjStore.get(key), -1); |
| if (nextId != -1) { |
| revokeFwd(key, nextId, null); |
| revokeNext(key, endpoints, nextId, null); |
| } else { |
| log.warn("NextObj for {} does not exist in the store.", key); |
| } |
| revokeFilter(key, endpoints); |
| revokeAcl(key); |
| } |
| |
| /** |
| * Revokes filtering objectives for given XConnect. |
| * |
| * @param key XConnect store key |
| * @param endpoints XConnect endpoints |
| */ |
| private void revokeFilter(XconnectKey key, Set<XconnectEndpoint> endpoints) { |
| // FIXME Improve the logic |
| // If port load balancer is not involved, use filtered port. Otherwise, use unfiltered port. |
| // The purpose is to make sure existing XConnect logic can still work on a configured port. |
| boolean filtered = endpoints.stream() |
| .map(ep -> getNextTreatment(key.deviceId(), ep, false)) |
| .allMatch(t -> t.type().equals(NextTreatment.Type.TREATMENT)); |
| |
| endpoints.stream() |
| .map(ep -> getPhysicalPorts(key.deviceId(), ep)). |
| flatMap(Set::stream).forEach(port -> { |
| FilteringObjective.Builder filtObjBuilder = filterObjBuilder(key, port, filtered); |
| ObjectiveContext context = new DefaultObjectiveContext( |
| (objective) -> log.debug("XConnect FilterObj for {} on port {} revoked", |
| key, port), |
| (objective, error) -> |
| log.warn("Failed to revoke XConnect FilterObj for {} on port {}: {}", |
| key, port, error)); |
| flowObjectiveService.filter(key.deviceId(), filtObjBuilder.remove(context)); |
| }); |
| } |
| |
| /** |
| * Revokes next objectives for given XConnect. |
| * |
| * @param key XConnect store key |
| * @param endpoints XConnect endpoints |
| * @param nextId next objective id |
| * @param nextFuture completable future for this next objective operation |
| */ |
| private void revokeNext(XconnectKey key, Set<XconnectEndpoint> endpoints, int nextId, |
| CompletableFuture<ObjectiveError> nextFuture) { |
| ObjectiveContext context = new ObjectiveContext() { |
| @Override |
| public void onSuccess(Objective objective) { |
| log.debug("Previous NextObj for {} removed", key); |
| if (nextFuture != null) { |
| nextFuture.complete(null); |
| } |
| } |
| |
| @Override |
| public void onError(Objective objective, ObjectiveError error) { |
| log.warn("Failed to remove previous NextObj for {}: {}", key, error); |
| if (nextFuture != null) { |
| nextFuture.complete(error); |
| } |
| srService.invalidateNextObj(objective.id()); |
| } |
| }; |
| |
| NextObjective.Builder nextObjBuilder = nextObjBuilder(key, endpoints, nextId); |
| if (nextObjBuilder == null) { |
| log.warn("Fail to revokeNext {}: {}", key, ERROR_NEXT_OBJ_BUILDER); |
| return; |
| } |
| // Release the port load balancer if present |
| endpoints.stream() |
| .filter(endpoint -> endpoint.type() == XconnectEndpoint.Type.LOAD_BALANCER) |
| .forEach(endpoint -> { |
| String portLoadBalancerKey = String.valueOf(((XconnectLoadBalancerEndpoint) endpoint).key()); |
| portLoadBalancerService.release(new PortLoadBalancerId(key.deviceId(), |
| Integer.parseInt(portLoadBalancerKey)), appId); |
| }); |
| flowObjectiveService.next(key.deviceId(), nextObjBuilder.remove(context)); |
| xconnectNextObjStore.remove(key); |
| } |
| |
| /** |
| * Revokes bridging forwarding objectives for given XConnect. |
| * |
| * @param key XConnect store key |
| * @param nextId next objective id |
| * @param fwdFuture completable future for this forwarding objective operation |
| */ |
| private void revokeFwd(XconnectKey key, int nextId, CompletableFuture<ObjectiveError> fwdFuture) { |
| ForwardingObjective.Builder fwdObjBuilder = fwdObjBuilder(key, nextId); |
| ObjectiveContext context = new ObjectiveContext() { |
| @Override |
| public void onSuccess(Objective objective) { |
| log.debug("Previous FwdObj for {} removed", key); |
| if (fwdFuture != null) { |
| fwdFuture.complete(null); |
| } |
| } |
| |
| @Override |
| public void onError(Objective objective, ObjectiveError error) { |
| log.warn("Failed to remove previous FwdObj for {}: {}", key, error); |
| if (fwdFuture != null) { |
| fwdFuture.complete(error); |
| } |
| } |
| }; |
| flowObjectiveService.forward(key.deviceId(), fwdObjBuilder.remove(context)); |
| } |
| |
| /** |
| * Revokes ACL forwarding objectives for given XConnect. |
| * |
| * @param key XConnect store key |
| */ |
| private void revokeAcl(XconnectKey key) { |
| ForwardingObjective.Builder aclObjBuilder = aclObjBuilder(key.vlanId()); |
| ObjectiveContext aclContext = new DefaultObjectiveContext( |
| (objective) -> log.debug("XConnect AclObj for {} populated", key), |
| (objective, error) -> |
| log.warn("Failed to populate XConnect AclObj for {}: {}", key, error)); |
| flowObjectiveService.forward(key.deviceId(), aclObjBuilder.remove(aclContext)); |
| } |
| |
| /** |
| * Updates XConnect groups and flows for given key. |
| * |
| * @param key XConnect key |
| * @param prevEndpoints previous XConnect endpoints |
| * @param endpoints new XConnect endpoints |
| */ |
| private void updateXConnect(XconnectKey key, Set<XconnectEndpoint> prevEndpoints, |
| Set<XconnectEndpoint> endpoints) { |
| if (!isLocalLeader(key.deviceId())) { |
| log.debug("Abort updating XConnect {}: {}", key, ERROR_NOT_LEADER); |
| return; |
| } |
| // NOTE: ACL flow doesn't include port information. No need to update it. |
| // Pair port is built-in and thus not going to change. No need to update it. |
| |
| // remove old filter |
| prevEndpoints.stream().filter(prevEndpoint -> !endpoints.contains(prevEndpoint)).forEach(prevEndpoint -> |
| revokeFilter(key, ImmutableSet.of(prevEndpoint))); |
| // install new filter |
| endpoints.stream().filter(endpoint -> !prevEndpoints.contains(endpoint)).forEach(endpoint -> |
| populateFilter(key, ImmutableSet.of(endpoint))); |
| |
| CompletableFuture<ObjectiveError> fwdFuture = new CompletableFuture<>(); |
| CompletableFuture<ObjectiveError> nextFuture = new CompletableFuture<>(); |
| |
| int nextId = Versioned.valueOrElse(xconnectNextObjStore.get(key), -1); |
| if (nextId != -1) { |
| revokeFwd(key, nextId, fwdFuture); |
| |
| fwdFuture.thenAcceptAsync(fwdStatus -> { |
| if (fwdStatus == null) { |
| log.debug("Fwd removed. Now remove group {}", key); |
| revokeNext(key, prevEndpoints, nextId, nextFuture); |
| } |
| }); |
| |
| nextFuture.thenAcceptAsync(nextStatus -> { |
| if (nextStatus == null) { |
| log.debug("Installing new group and flow for {}", key); |
| int newNextId = populateNext(key, endpoints); |
| if (newNextId == -1) { |
| log.warn("Fail to updateXConnect {}: {}", key, ERROR_NEXT_ID); |
| return; |
| } |
| populateFwd(key, newNextId); |
| } |
| }); |
| } else { |
| log.warn("NextObj for {} does not exist in the store.", key); |
| } |
| } |
| |
| /** |
| * Creates a next objective builder for XConnect with given nextId. |
| * |
| * @param key XConnect key |
| * @param endpoints XConnect endpoints |
| * @param nextId next objective id |
| * @return next objective builder |
| */ |
| private NextObjective.Builder nextObjBuilder(XconnectKey key, Set<XconnectEndpoint> endpoints, int nextId) { |
| TrafficSelector metadata = |
| DefaultTrafficSelector.builder().matchVlanId(key.vlanId()).build(); |
| NextObjective.Builder nextObjBuilder = DefaultNextObjective |
| .builder().withId(nextId) |
| .withType(NextObjective.Type.BROADCAST).fromApp(appId) |
| .withMeta(metadata); |
| |
| for (XconnectEndpoint endpoint : endpoints) { |
| NextTreatment nextTreatment = getNextTreatment(key.deviceId(), endpoint, true); |
| if (nextTreatment == null) { |
| // If a PortLoadBalancer is used in the XConnect - putting on hold |
| if (endpoint.type() == XconnectEndpoint.Type.LOAD_BALANCER) { |
| log.warn("Unable to create nextObj. PortLoadBalancer not ready"); |
| String portLoadBalancerKey = String.valueOf(((XconnectLoadBalancerEndpoint) endpoint).key()); |
| portLoadBalancerCache.asMap().putIfAbsent(new PortLoadBalancerId(key.deviceId(), |
| Integer.parseInt(portLoadBalancerKey)), key); |
| } else { |
| log.warn("Unable to create nextObj. Null NextTreatment"); |
| } |
| return null; |
| } |
| nextObjBuilder.addTreatment(nextTreatment); |
| } |
| |
| return nextObjBuilder; |
| } |
| |
| /** |
| * Creates a next objective builder for XConnect. |
| * |
| * @param key XConnect key |
| * @param endpoints Xconnect endpoints |
| * @return next objective builder |
| */ |
| private NextObjective.Builder nextObjBuilder(XconnectKey key, Set<XconnectEndpoint> endpoints) { |
| int nextId = flowObjectiveService.allocateNextId(); |
| return nextObjBuilder(key, endpoints, nextId); |
| } |
| |
| |
| /** |
| * Creates a bridging forwarding objective builder for XConnect. |
| * |
| * @param key XConnect key |
| * @param nextId next ID of the broadcast group for this XConnect key |
| * @return forwarding objective builder |
| */ |
| private ForwardingObjective.Builder fwdObjBuilder(XconnectKey key, int nextId) { |
| /* |
| * Driver should treat objectives with MacAddress.NONE and !VlanId.NONE |
| * as the VLAN cross-connect broadcast rules |
| */ |
| TrafficSelector.Builder sbuilder = DefaultTrafficSelector.builder(); |
| sbuilder.matchVlanId(key.vlanId()); |
| sbuilder.matchEthDst(MacAddress.NONE); |
| |
| ForwardingObjective.Builder fob = DefaultForwardingObjective.builder(); |
| fob.withFlag(ForwardingObjective.Flag.SPECIFIC) |
| .withSelector(sbuilder.build()) |
| .nextStep(nextId) |
| .withPriority(XCONNECT_PRIORITY) |
| .fromApp(appId) |
| .makePermanent(); |
| return fob; |
| } |
| |
| /** |
| * Creates an ACL forwarding objective builder for XConnect. |
| * |
| * @param vlanId cross connect VLAN id |
| * @return forwarding objective builder |
| */ |
| private ForwardingObjective.Builder aclObjBuilder(VlanId vlanId) { |
| TrafficSelector.Builder sbuilder = DefaultTrafficSelector.builder(); |
| sbuilder.matchVlanId(vlanId); |
| |
| TrafficTreatment.Builder tbuilder = DefaultTrafficTreatment.builder(); |
| |
| ForwardingObjective.Builder fob = DefaultForwardingObjective.builder(); |
| fob.withFlag(ForwardingObjective.Flag.VERSATILE) |
| .withSelector(sbuilder.build()) |
| .withTreatment(tbuilder.build()) |
| .withPriority(XCONNECT_ACL_PRIORITY) |
| .fromApp(appId) |
| .makePermanent(); |
| return fob; |
| } |
| |
| /** |
| * Creates a filtering objective builder for XConnect. |
| * |
| * @param key XConnect key |
| * @param port XConnect ports |
| * @param filtered true if this is a filtered port |
| * @return next objective builder |
| */ |
| private FilteringObjective.Builder filterObjBuilder(XconnectKey key, PortNumber port, boolean filtered) { |
| FilteringObjective.Builder fob = DefaultFilteringObjective.builder(); |
| fob.withKey(Criteria.matchInPort(port)) |
| .addCondition(Criteria.matchEthDst(MacAddress.NONE)) |
| .withPriority(XCONNECT_PRIORITY); |
| if (filtered) { |
| fob.addCondition(Criteria.matchVlanId(key.vlanId())); |
| } else { |
| fob.addCondition(Criteria.matchVlanId(VlanId.ANY)); |
| } |
| return fob.permit().fromApp(appId); |
| } |
| |
| /** |
| * Updates L2 flooding groups; add pair link into L2 flooding group of given xconnect vlan. |
| * |
| * @param deviceId Device ID |
| * @param port Port details |
| * @param vlanId VLAN ID |
| * @param install Whether to add or revoke pair link addition to flooding group |
| */ |
| private void updateL2Flooding(DeviceId deviceId, PortNumber port, VlanId vlanId, boolean install) { |
| XconnectKey key = new XconnectKey(deviceId, vlanId); |
| // Ensure leadership on device |
| if (!isLocalLeader(deviceId)) { |
| log.debug("Abort updating L2Flood {}: {}", key, ERROR_NOT_LEADER); |
| return; |
| } |
| |
| // Locate L2 flooding group details for given xconnect vlan |
| int nextId = Versioned.valueOrElse(xconnectNextObjStore.get(key), -1); |
| if (nextId == -1) { |
| log.debug("XConnect vlan {} broadcast group for device {} doesn't exists. " + |
| "Aborting pair group linking.", vlanId, deviceId); |
| return; |
| } |
| |
| // Add pairing-port group to flooding group |
| TrafficTreatment.Builder treatment = DefaultTrafficTreatment.builder(); |
| // treatment.popVlan(); |
| treatment.setOutput(port); |
| ObjectiveContext context = new DefaultObjectiveContext( |
| (objective) -> |
| log.debug("Pair port added/removed to vlan {} next objective {} on {}", |
| vlanId, nextId, deviceId), |
| (objective, error) -> |
| log.warn("Failed adding/removing pair port to vlan {} next objective {} on {}." + |
| "Error : {}", vlanId, nextId, deviceId, error) |
| ); |
| NextObjective.Builder vlanNextObjectiveBuilder = DefaultNextObjective.builder() |
| .withId(nextId) |
| .withType(NextObjective.Type.BROADCAST) |
| .fromApp(srService.appId()) |
| .withMeta(DefaultTrafficSelector.builder().matchVlanId(vlanId).build()) |
| .addTreatment(treatment.build()); |
| if (install) { |
| flowObjectiveService.next(deviceId, vlanNextObjectiveBuilder.addToExisting(context)); |
| } else { |
| flowObjectiveService.next(deviceId, vlanNextObjectiveBuilder.removeFromExisting(context)); |
| } |
| log.debug("Submitted next objective {} for vlan: {} in device {}", |
| nextId, vlanId, deviceId); |
| } |
| |
| /** |
| * Populate L2 multicast rule on given deviceId that matches given mac, given vlan and |
| * output to given port's L2 mulitcast group. |
| * |
| * @param deviceId Device ID |
| * @param pairPort Pair port number |
| * @param vlanId VLAN ID |
| * @param accessPorts List of access ports to be added into L2 multicast group |
| */ |
| private void populateL2Multicast(DeviceId deviceId, PortNumber pairPort, |
| VlanId vlanId, List<PortNumber> accessPorts) { |
| // Ensure enough rights to program pair device |
| if (!srService.shouldProgram(deviceId)) { |
| log.debug("Abort populate L2Multicast {}-{}: {}", deviceId, vlanId, ERROR_NOT_LEADER); |
| return; |
| } |
| |
| boolean multicastGroupExists = true; |
| int vlanMulticastNextId; |
| VlanNextObjectiveStoreKey key = new VlanNextObjectiveStoreKey(deviceId, vlanId); |
| |
| // Step 1 : Populate single homed access ports into vlan's L2 multicast group |
| NextObjective.Builder vlanMulticastNextObjBuilder = DefaultNextObjective |
| .builder() |
| .withType(NextObjective.Type.BROADCAST) |
| .fromApp(srService.appId()) |
| .withMeta(DefaultTrafficSelector.builder().matchVlanId(vlanId) |
| .matchEthDst(MacAddress.IPV4_MULTICAST).build()); |
| vlanMulticastNextId = getMulticastGroupNextObjectiveId(key); |
| if (vlanMulticastNextId == -1) { |
| // Vlan's L2 multicast group doesn't exist; create it, update store and add pair port as sub-group |
| multicastGroupExists = false; |
| vlanMulticastNextId = flowObjectiveService.allocateNextId(); |
| addMulticastGroupNextObjectiveId(key, vlanMulticastNextId); |
| vlanMulticastNextObjBuilder.addTreatment( |
| DefaultTrafficTreatment.builder().popVlan().setOutput(pairPort).build() |
| ); |
| } |
| vlanMulticastNextObjBuilder.withId(vlanMulticastNextId); |
| int nextId = vlanMulticastNextId; |
| accessPorts.forEach(p -> { |
| TrafficTreatment.Builder egressAction = DefaultTrafficTreatment.builder(); |
| // Do vlan popup action based on interface configuration |
| if (interfaceService.getInterfacesByPort(new ConnectPoint(deviceId, p)) |
| .stream().noneMatch(i -> i.vlanTagged().contains(vlanId))) { |
| egressAction.popVlan(); |
| } |
| egressAction.setOutput(p); |
| vlanMulticastNextObjBuilder.addTreatment(egressAction.build()); |
| addMulticastGroupPort(key, p); |
| }); |
| ObjectiveContext context = new DefaultObjectiveContext( |
| (objective) -> |
| log.debug("L2 multicast group installed/updated. " |
| + "NextObject Id {} on {} for subnet {} ", |
| nextId, deviceId, vlanId), |
| (objective, error) -> |
| log.warn("L2 multicast group failed to install/update. " |
| + " NextObject Id {} on {} for subnet {} : {}", |
| nextId, deviceId, vlanId, error) |
| ); |
| if (!multicastGroupExists) { |
| flowObjectiveService.next(deviceId, vlanMulticastNextObjBuilder.add(context)); |
| |
| // Step 2 : Populate ACL rule; selector = vlan + pair-port, output = vlan L2 multicast group |
| TrafficSelector.Builder multicastSelector = DefaultTrafficSelector.builder(); |
| multicastSelector.matchEthType(Ethernet.TYPE_VLAN); |
| multicastSelector.matchInPort(pairPort); |
| multicastSelector.matchVlanId(vlanId); |
| ForwardingObjective.Builder vlanMulticastForwardingObj = DefaultForwardingObjective.builder() |
| .withFlag(ForwardingObjective.Flag.VERSATILE) |
| .nextStep(vlanMulticastNextId) |
| .withSelector(multicastSelector.build()) |
| .withPriority(100) |
| .fromApp(srService.appId()) |
| .makePermanent(); |
| context = new DefaultObjectiveContext( |
| (objective) -> log.debug("L2 multicasting versatile rule for device {}, port/vlan {}/{} populated", |
| deviceId, |
| pairPort, |
| vlanId), |
| (objective, error) -> log.warn("Failed to populate L2 multicasting versatile rule for device {}, " + |
| "ports/vlan {}/{}: {}", deviceId, pairPort, vlanId, error)); |
| flowObjectiveService.forward(deviceId, vlanMulticastForwardingObj.add(context)); |
| } else { |
| // L2_MULTICAST & BROADCAST are similar structure in subgroups; so going with BROADCAST type. |
| vlanMulticastNextObjBuilder.withType(NextObjective.Type.BROADCAST); |
| flowObjectiveService.next(deviceId, vlanMulticastNextObjBuilder.addToExisting(context)); |
| } |
| } |
| |
| /** |
| * Removes access ports from VLAN L2 multicast group on given deviceId. |
| * |
| * @param deviceId Device ID |
| * @param vlanId VLAN ID |
| * @param accessPorts List of access ports to be added into L2 multicast group |
| */ |
| private void revokeL2Multicast(DeviceId deviceId, VlanId vlanId, List<PortNumber> accessPorts) { |
| // Ensure enough rights to program pair device |
| if (!srService.shouldProgram(deviceId)) { |
| log.debug("Abort revoke L2Multicast {}-{}: {}", deviceId, vlanId, ERROR_NOT_LEADER); |
| return; |
| } |
| |
| VlanNextObjectiveStoreKey key = new VlanNextObjectiveStoreKey(deviceId, vlanId); |
| |
| int vlanMulticastNextId = getMulticastGroupNextObjectiveId(key); |
| if (vlanMulticastNextId == -1) { |
| return; |
| } |
| NextObjective.Builder vlanMulticastNextObjBuilder = DefaultNextObjective |
| .builder() |
| .withType(NextObjective.Type.BROADCAST) |
| .fromApp(srService.appId()) |
| .withMeta(DefaultTrafficSelector.builder().matchVlanId(vlanId).build()) |
| .withId(vlanMulticastNextId); |
| accessPorts.forEach(p -> { |
| TrafficTreatment.Builder egressAction = DefaultTrafficTreatment.builder(); |
| // Do vlan popup action based on interface configuration |
| if (interfaceService.getInterfacesByPort(new ConnectPoint(deviceId, p)) |
| .stream().noneMatch(i -> i.vlanTagged().contains(vlanId))) { |
| egressAction.popVlan(); |
| } |
| egressAction.setOutput(p); |
| vlanMulticastNextObjBuilder.addTreatment(egressAction.build()); |
| removeMulticastGroupPort(key, p); |
| }); |
| ObjectiveContext context = new DefaultObjectiveContext( |
| (objective) -> |
| log.debug("L2 multicast group installed/updated. " |
| + "NextObject Id {} on {} for subnet {} ", |
| vlanMulticastNextId, deviceId, vlanId), |
| (objective, error) -> |
| log.warn("L2 multicast group failed to install/update. " |
| + " NextObject Id {} on {} for subnet {} : {}", |
| vlanMulticastNextId, deviceId, vlanId, error) |
| ); |
| flowObjectiveService.next(deviceId, vlanMulticastNextObjBuilder.removeFromExisting(context)); |
| } |
| |
| /** |
| * Cleans up VLAN L2 multicast group on given deviceId. ACL rules for the group will also be deleted. |
| * Normally multicast group is not removed if it contains access ports; which can be forced |
| * by "force" flag |
| * |
| * @param deviceId Device ID |
| * @param pairPort Pair port number |
| * @param vlanId VLAN ID |
| * @param force Forceful removal |
| */ |
| private void cleanupL2MulticastRule(DeviceId deviceId, PortNumber pairPort, VlanId vlanId, boolean force) { |
| |
| // Ensure enough rights to program pair device |
| if (!srService.shouldProgram(deviceId)) { |
| log.debug("Abort cleanup L2Multicast {}-{}: {}", deviceId, vlanId, ERROR_NOT_LEADER); |
| return; |
| } |
| |
| VlanNextObjectiveStoreKey key = new VlanNextObjectiveStoreKey(deviceId, vlanId); |
| |
| // Ensure L2 multicast group doesn't contain access ports |
| if (hasAccessPortInMulticastGroup(key, pairPort) && !force) { |
| return; |
| } |
| |
| // Load L2 multicast group details |
| int vlanMulticastNextId = getMulticastGroupNextObjectiveId(key); |
| if (vlanMulticastNextId == -1) { |
| return; |
| } |
| |
| // Step 1 : Clear ACL rule; selector = vlan + pair-port, output = vlan L2 multicast group |
| TrafficSelector.Builder l2MulticastSelector = DefaultTrafficSelector.builder(); |
| l2MulticastSelector.matchEthType(Ethernet.TYPE_VLAN); |
| l2MulticastSelector.matchInPort(pairPort); |
| l2MulticastSelector.matchVlanId(vlanId); |
| ForwardingObjective.Builder vlanMulticastForwardingObj = DefaultForwardingObjective.builder() |
| .withFlag(ForwardingObjective.Flag.VERSATILE) |
| .nextStep(vlanMulticastNextId) |
| .withSelector(l2MulticastSelector.build()) |
| .withPriority(100) |
| .fromApp(srService.appId()) |
| .makePermanent(); |
| ObjectiveContext context = new DefaultObjectiveContext( |
| (objective) -> log.debug("L2 multicasting rule for device {}, port/vlan {}/{} deleted", deviceId, |
| pairPort, vlanId), |
| (objective, error) -> log.warn("Failed to delete L2 multicasting rule for device {}, " + |
| "ports/vlan {}/{}: {}", deviceId, pairPort, vlanId, error)); |
| flowObjectiveService.forward(deviceId, vlanMulticastForwardingObj.remove(context)); |
| |
| // Step 2 : Clear L2 multicast group associated with vlan |
| NextObjective.Builder l2MulticastGroupBuilder = DefaultNextObjective |
| .builder() |
| .withId(vlanMulticastNextId) |
| .withType(NextObjective.Type.BROADCAST) |
| .fromApp(srService.appId()) |
| .withMeta(DefaultTrafficSelector.builder() |
| .matchVlanId(vlanId) |
| .matchEthDst(MacAddress.IPV4_MULTICAST).build()) |
| .addTreatment(DefaultTrafficTreatment.builder().popVlan().setOutput(pairPort).build()); |
| context = new DefaultObjectiveContext( |
| (objective) -> |
| log.debug("L2 multicast group with NextObject Id {} deleted on {} for subnet {} ", |
| vlanMulticastNextId, deviceId, vlanId), |
| (objective, error) -> |
| log.warn("L2 multicast group with NextObject Id {} failed to delete on {} for subnet {} : {}", |
| vlanMulticastNextId, deviceId, vlanId, error) |
| ); |
| flowObjectiveService.next(deviceId, l2MulticastGroupBuilder.remove(context)); |
| |
| // Finally clear store. |
| removeMulticastGroup(key); |
| } |
| |
| private int getMulticastGroupNextObjectiveId(VlanNextObjectiveStoreKey key) { |
| return Versioned.valueOrElse(xconnectMulticastNextStore.get(key), -1); |
| } |
| |
| private void addMulticastGroupNextObjectiveId(VlanNextObjectiveStoreKey key, int nextId) { |
| if (nextId == -1) { |
| return; |
| } |
| xconnectMulticastNextStore.put(key, nextId); |
| } |
| |
| private void addMulticastGroupPort(VlanNextObjectiveStoreKey groupKey, PortNumber port) { |
| xconnectMulticastPortsStore.compute(groupKey, (key, ports) -> { |
| if (ports == null) { |
| ports = Lists.newArrayList(); |
| } |
| ports.add(port); |
| return ports; |
| }); |
| } |
| |
| private void removeMulticastGroupPort(VlanNextObjectiveStoreKey groupKey, PortNumber port) { |
| xconnectMulticastPortsStore.compute(groupKey, (key, ports) -> { |
| if (ports != null && !ports.isEmpty()) { |
| ports.remove(port); |
| } |
| return ports; |
| }); |
| } |
| |
| private void removeMulticastGroup(VlanNextObjectiveStoreKey groupKey) { |
| xconnectMulticastPortsStore.remove(groupKey); |
| xconnectMulticastNextStore.remove(groupKey); |
| } |
| |
| private boolean hasAccessPortInMulticastGroup(VlanNextObjectiveStoreKey groupKey, PortNumber pairPort) { |
| List<PortNumber> ports = Versioned.valueOrElse(xconnectMulticastPortsStore.get(groupKey), ImmutableList.of()); |
| return ports.stream().anyMatch(p -> !p.equals(pairPort)); |
| } |
| |
| // Custom-built function, when the device is not available we need a fallback mechanism |
| private boolean isLocalLeader(DeviceId deviceId) { |
| if (!mastershipService.isLocalMaster(deviceId)) { |
| // When the device is available we just check the mastership |
| if (deviceService.isAvailable(deviceId)) { |
| return false; |
| } |
| // Fallback with Leadership service - device id is used as topic |
| NodeId leader = leadershipService.runForLeadership( |
| deviceId.toString()).leaderNodeId(); |
| // Verify if this node is the leader |
| return clusterService.getLocalNode().id().equals(leader); |
| } |
| return true; |
| } |
| |
| private Set<PortNumber> getPhysicalPorts(DeviceId deviceId, XconnectEndpoint endpoint) { |
| if (endpoint.type() == XconnectEndpoint.Type.PORT) { |
| PortNumber port = ((XconnectPortEndpoint) endpoint).port(); |
| return Sets.newHashSet(port); |
| } |
| if (endpoint.type() == XconnectEndpoint.Type.LOAD_BALANCER) { |
| PortLoadBalancerId portLoadBalancerId = new PortLoadBalancerId(deviceId, |
| ((XconnectLoadBalancerEndpoint) endpoint).key()); |
| Set<PortNumber> ports = portLoadBalancerService.getPortLoadBalancer(portLoadBalancerId).ports(); |
| return Sets.newHashSet(ports); |
| } |
| return Sets.newHashSet(); |
| } |
| |
| private NextTreatment getNextTreatment(DeviceId deviceId, XconnectEndpoint endpoint, boolean reserve) { |
| if (endpoint.type() == XconnectEndpoint.Type.PORT) { |
| PortNumber port = ((XconnectPortEndpoint) endpoint).port(); |
| return DefaultNextTreatment.of(DefaultTrafficTreatment.builder().setOutput(port).build()); |
| } |
| if (endpoint.type() == XconnectEndpoint.Type.LOAD_BALANCER) { |
| PortLoadBalancerId portLoadBalancerId = new PortLoadBalancerId(deviceId, |
| ((XconnectLoadBalancerEndpoint) endpoint).key()); |
| NextTreatment idNextTreatment = IdNextTreatment.of(portLoadBalancerService |
| .getPortLoadBalancerNext(portLoadBalancerId)); |
| // Reserve only one time during next objective creation |
| if (reserve) { |
| if (!portLoadBalancerService.reserve(portLoadBalancerId, appId)) { |
| log.warn("Reservation failed for {}", portLoadBalancerId); |
| idNextTreatment = null; |
| } |
| } |
| return idNextTreatment; |
| } |
| return null; |
| } |
| |
| private class InternalPortLoadBalancerListener implements PortLoadBalancerListener { |
| // Populate xconnect once portloadbalancer is available |
| @Override |
| public void event(PortLoadBalancerEvent event) { |
| portLoadBalancerExecutor.execute(() -> dequeue(event.subject().portLoadBalancerId())); |
| } |
| // When we receive INSTALLED port load balancing is ready |
| @Override |
| public boolean isRelevant(PortLoadBalancerEvent event) { |
| return event.type() == PortLoadBalancerEvent.Type.INSTALLED; |
| } |
| } |
| |
| // Invalidate the cache and re-start the xconnect installation |
| private void dequeue(PortLoadBalancerId portLoadBalancerId) { |
| XconnectKey xconnectKey = portLoadBalancerCache.getIfPresent(portLoadBalancerId); |
| if (xconnectKey == null) { |
| log.trace("{} not present in the cache", portLoadBalancerId); |
| return; |
| } |
| log.debug("Dequeue {}", portLoadBalancerId); |
| portLoadBalancerCache.invalidate(portLoadBalancerId); |
| Set<XconnectEndpoint> endpoints = Versioned.valueOrNull(xconnectStore.get(xconnectKey)); |
| if (endpoints == null || endpoints.isEmpty()) { |
| log.warn("Endpoints not found for XConnect {}", xconnectKey); |
| return; |
| } |
| populateXConnect(xconnectKey, endpoints); |
| log.trace("PortLoadBalancer cache size {}", portLoadBalancerCache.size()); |
| } |
| |
| } |