| /* |
| * Copyright 2021-2023 Open Networking Foundation (ONF) and the ONF Contributors |
| * |
| * 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.opencord.olt.impl; |
| |
| import com.google.common.collect.ImmutableMap; |
| import org.onlab.packet.EthType; |
| import org.onlab.packet.IPv4; |
| import org.onlab.packet.IPv6; |
| import org.onlab.packet.MacAddress; |
| import org.onlab.packet.TpPort; |
| import org.onlab.packet.VlanId; |
| import org.onlab.util.KryoNamespace; |
| import org.onlab.util.Tools; |
| import org.onosproject.cfg.ComponentConfigService; |
| import org.onosproject.core.ApplicationId; |
| import org.onosproject.core.CoreService; |
| import org.onosproject.net.AnnotationKeys; |
| import org.onosproject.net.Annotations; |
| import org.onosproject.net.ConnectPoint; |
| import org.onosproject.net.DefaultAnnotations; |
| import org.onosproject.net.DefaultPort; |
| import org.onosproject.net.Device; |
| import org.onosproject.net.DeviceId; |
| import org.onosproject.net.Host; |
| import org.onosproject.net.Port; |
| import org.onosproject.net.PortNumber; |
| import org.onosproject.net.device.DeviceService; |
| import org.onosproject.net.flow.DefaultTrafficSelector; |
| import org.onosproject.net.flow.DefaultTrafficTreatment; |
| import org.onosproject.net.flow.FlowRule; |
| import org.onosproject.net.flow.FlowRuleEvent; |
| import org.onosproject.net.flow.FlowRuleListener; |
| import org.onosproject.net.flow.FlowRuleService; |
| import org.onosproject.net.flow.TrafficSelector; |
| import org.onosproject.net.flow.TrafficTreatment; |
| import org.onosproject.net.flow.criteria.Criteria; |
| import org.onosproject.net.flow.criteria.Criterion; |
| import org.onosproject.net.flow.criteria.VlanIdCriterion; |
| import org.onosproject.net.flow.instructions.L2ModificationInstruction; |
| import org.onosproject.net.flowobjective.DefaultFilteringObjective; |
| import org.onosproject.net.flowobjective.DefaultForwardingObjective; |
| import org.onosproject.net.flowobjective.FilteringObjective; |
| import org.onosproject.net.flowobjective.FlowObjectiveService; |
| import org.onosproject.net.flowobjective.ForwardingObjective; |
| import org.onosproject.net.flowobjective.Objective; |
| import org.onosproject.net.flowobjective.ObjectiveContext; |
| import org.onosproject.net.flowobjective.ObjectiveError; |
| import org.onosproject.net.host.HostService; |
| import org.onosproject.net.meter.MeterId; |
| import org.onosproject.store.serializers.KryoNamespaces; |
| import org.onosproject.store.service.Serializer; |
| import org.onosproject.store.service.StorageService; |
| import org.opencord.olt.AccessDevicePort; |
| import org.opencord.olt.DiscoveredSubscriber; |
| import org.opencord.olt.OltDeviceServiceInterface; |
| import org.opencord.olt.OltFlowServiceInterface; |
| import org.opencord.olt.OltMeterServiceInterface; |
| import org.opencord.olt.OltPortStatus; |
| import org.opencord.olt.ServiceKey; |
| import org.opencord.olt.OltFlowsStatus; |
| import org.opencord.olt.FlowDirection; |
| import org.opencord.olt.FlowOperation; |
| import org.opencord.olt.impl.fttb.FttbUtils; |
| import org.opencord.sadis.BandwidthProfileInformation; |
| import org.opencord.sadis.BaseInformationService; |
| import org.opencord.sadis.SadisService; |
| import org.opencord.sadis.SubscriberAndDeviceInformation; |
| import org.opencord.sadis.UniTagInformation; |
| import org.osgi.service.component.ComponentContext; |
| 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.Modified; |
| import org.osgi.service.component.annotations.Reference; |
| import org.osgi.service.component.annotations.ReferenceCardinality; |
| import org.osgi.service.component.annotations.ReferencePolicy; |
| import org.slf4j.Logger; |
| import org.slf4j.LoggerFactory; |
| |
| import java.util.ArrayList; |
| import java.util.Dictionary; |
| import java.util.HashMap; |
| import java.util.HashSet; |
| import java.util.Iterator; |
| import java.util.List; |
| import java.util.Map; |
| import java.util.Optional; |
| import java.util.Properties; |
| import java.util.Set; |
| import java.util.concurrent.atomic.AtomicBoolean; |
| import java.util.concurrent.locks.Lock; |
| import java.util.concurrent.locks.ReentrantReadWriteLock; |
| |
| import static com.google.common.base.Strings.isNullOrEmpty; |
| import static org.onlab.util.Tools.get; |
| import static org.opencord.olt.impl.OltUtils.completeFlowOpToString; |
| import static org.opencord.olt.impl.OltUtils.flowOpToString; |
| import static org.opencord.olt.impl.OltUtils.getPortName; |
| import static org.opencord.olt.impl.OltUtils.portWithName; |
| import static org.opencord.olt.impl.OltUtils.getProgrammedSubscriber; |
| import static org.opencord.olt.impl.OsgiPropertyConstants.*; |
| import static org.opencord.olt.impl.fttb.FttbUtils.FTTB_FLOW_DIRECTION; |
| import static org.opencord.olt.impl.fttb.FttbUtils.FTTB_FLOW_DOWNSTREAM; |
| import static org.opencord.olt.impl.fttb.FttbUtils.FTTB_FLOW_UPSTREAM; |
| import static org.opencord.olt.impl.fttb.FttbUtils.FTTB_SERVICE_DPU_ANCP_TRAFFIC; |
| import static org.opencord.olt.impl.fttb.FttbUtils.FTTB_SERVICE_DPU_MGMT_TRAFFIC; |
| import static org.opencord.olt.impl.fttb.FttbUtils.FTTB_SERVICE_NAME; |
| import static org.opencord.olt.impl.fttb.FttbUtils.FTTB_SERVICE_SUBSCRIBER_TRAFFIC; |
| |
| @Component(immediate = true, property = { |
| ENABLE_DHCP_ON_NNI + ":Boolean=" + ENABLE_DHCP_ON_NNI_DEFAULT, |
| ENABLE_DHCP_V4 + ":Boolean=" + ENABLE_DHCP_V4_DEFAULT, |
| ENABLE_DHCP_V6 + ":Boolean=" + ENABLE_DHCP_V6_DEFAULT, |
| ENABLE_IGMP_ON_NNI + ":Boolean=" + ENABLE_IGMP_ON_NNI_DEFAULT, |
| ENABLE_EAPOL + ":Boolean=" + ENABLE_EAPOL_DEFAULT, |
| ENABLE_PPPOE_ON_NNI + ":Boolean=" + ENABLE_PPPOE_ON_NNI_DEFAULT, |
| ENABLE_PPPOE + ":Boolean=" + ENABLE_PPPOE_DEFAULT, |
| DEFAULT_TP_ID + ":Integer=" + DEFAULT_TP_ID_DEFAULT, |
| // FIXME remove this option as potentially dangerous in production |
| WAIT_FOR_REMOVAL + ":Boolean=" + WAIT_FOR_REMOVAL_DEFAULT, |
| REMOVE_FLOWS_ON_DISABLE + ":Boolean=" + REMOVE_FLOWS_ON_DISABLE_DEFAULT |
| }) |
| public class OltFlowService implements OltFlowServiceInterface { |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY) |
| protected CoreService coreService; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY) |
| protected ComponentConfigService cfgService; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY) |
| protected FlowObjectiveService flowObjectiveService; |
| |
| @Reference(cardinality = ReferenceCardinality.OPTIONAL, |
| bind = "bindSadisService", |
| unbind = "unbindSadisService", |
| policy = ReferencePolicy.DYNAMIC) |
| protected volatile SadisService sadisService; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY) |
| protected OltMeterServiceInterface oltMeterService; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY) |
| protected OltDeviceServiceInterface oltDeviceService; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY) |
| protected FlowRuleService flowRuleService; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY) |
| protected HostService hostService; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY) |
| protected DeviceService deviceService; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY) |
| protected StorageService storageService; |
| |
| protected BaseInformationService<SubscriberAndDeviceInformation> subsService; |
| protected BaseInformationService<BandwidthProfileInformation> bpService; |
| |
| private static final String APP_NAME = "org.opencord.olt"; |
| protected ApplicationId appId; |
| private static final Integer MAX_PRIORITY = 10000; |
| private static final Integer MIN_PRIORITY = 1000; |
| public static final short EAPOL_DEFAULT_VLAN = 4091; |
| private static final int NONE_TP_ID = -1; |
| private static final String V4 = "V4"; |
| private static final String V6 = "V6"; |
| private final Logger log = LoggerFactory.getLogger(getClass()); |
| |
| protected UniTagInformation defaultEapolUniTag = new UniTagInformation.Builder() |
| .setServiceName("defaultEapol").build(); |
| protected UniTagInformation nniUniTag = new UniTagInformation.Builder() |
| .setServiceName("nni") |
| .setTechnologyProfileId(NONE_TP_ID) |
| .setPonCTag(VlanId.NONE) |
| .setUniTagMatch(VlanId.ANY) |
| .setUsPonCTagPriority(-1) |
| .build(); |
| |
| /** |
| * Connect Point status map. |
| * Used to keep track of which cp has flows that needs to be removed when the status changes. |
| */ |
| protected Map<ServiceKey, OltPortStatus> cpStatus; |
| private final ReentrantReadWriteLock cpStatusLock = new ReentrantReadWriteLock(); |
| private final Lock cpStatusWriteLock = cpStatusLock.writeLock(); |
| private final Lock cpStatusReadLock = cpStatusLock.readLock(); |
| |
| /** |
| * This map contains the subscriber that have been provisioned by the operator. |
| * They may or may not have flows, depending on the port status. |
| * The map is used to define whether flows need to be provisioned when a port comes up. |
| */ |
| protected Map<ServiceKey, Boolean> provisionedSubscribers; |
| private final ReentrantReadWriteLock provisionedSubscribersLock = new ReentrantReadWriteLock(); |
| private final Lock provisionedSubscribersWriteLock = provisionedSubscribersLock.writeLock(); |
| private final Lock provisionedSubscribersReadLock = provisionedSubscribersLock.readLock(); |
| |
| /** |
| * For storing the mapping of ConnectPoints to FTTB DPU MAC addresses. |
| */ |
| protected Map<ConnectPoint, MacAddress> fttbMacAddresses; |
| private final ReentrantReadWriteLock fttbMacAddressesLock = new ReentrantReadWriteLock(); |
| private final Lock fttbMacAddressesWriteLock = fttbMacAddressesLock.writeLock(); |
| |
| /** |
| * Create DHCP trap flow on NNI port(s). |
| */ |
| protected boolean enableDhcpOnNni = ENABLE_DHCP_ON_NNI_DEFAULT; |
| |
| /** |
| * Enable flows for DHCP v4 if dhcp is required in sadis config. |
| **/ |
| protected boolean enableDhcpV4 = ENABLE_DHCP_V4_DEFAULT; |
| |
| /** |
| * Enable flows for DHCP v6 if dhcp is required in sadis config. |
| **/ |
| protected boolean enableDhcpV6 = ENABLE_DHCP_V6_DEFAULT; |
| |
| /** |
| * Create IGMP trap flow on NNI port(s). |
| **/ |
| protected boolean enableIgmpOnNni = ENABLE_IGMP_ON_NNI_DEFAULT; |
| |
| /** |
| * Send EAPOL authentication trap flows before subscriber provisioning. |
| **/ |
| protected boolean enableEapol = ENABLE_EAPOL_DEFAULT; |
| |
| /** |
| * Send PPPoED authentication trap flows before subscriber provisioning. |
| **/ |
| protected boolean enablePppoeOnNni = ENABLE_PPPOE_ON_NNI_DEFAULT; |
| |
| /** |
| * Enable flows for PPPoE if it is required in sadis config. |
| **/ |
| protected boolean enablePppoe = ENABLE_PPPOE_DEFAULT; |
| |
| /** |
| * Default technology profile id that is used for authentication trap flows. |
| **/ |
| protected int defaultTechProfileId = DEFAULT_TP_ID_DEFAULT; |
| |
| protected boolean waitForRemoval = WAIT_FOR_REMOVAL_DEFAULT; |
| |
| /** |
| * Removes all the flows on an ONU disable. |
| **/ |
| protected boolean removeFlowsOnDisable = REMOVE_FLOWS_ON_DISABLE_DEFAULT; |
| |
| protected InternalFlowListener internalFlowListener; |
| |
| @Activate |
| public void activate(ComponentContext context) { |
| cfgService.registerProperties(getClass()); |
| appId = coreService.registerApplication(APP_NAME); |
| internalFlowListener = new InternalFlowListener(this); |
| |
| modified(context); |
| |
| KryoNamespace serializer = KryoNamespace.newBuilder() |
| .register(KryoNamespaces.API) |
| .register(OltFlowsStatus.class) |
| .register(FlowDirection.class) |
| .register(OltPortStatus.class) |
| .register(OltFlowsStatus.class) |
| .register(AccessDevicePort.class) |
| .register(new ServiceKeySerializer(), ServiceKey.class) |
| .register(UniTagInformation.class) |
| .build(); |
| |
| cpStatus = storageService.<ServiceKey, OltPortStatus>consistentMapBuilder() |
| .withName("volt-cp-status") |
| .withApplicationId(appId) |
| .withSerializer(Serializer.using(serializer)) |
| .build().asJavaMap(); |
| |
| provisionedSubscribers = storageService.<ServiceKey, Boolean>consistentMapBuilder() |
| .withName("volt-provisioned-subscriber") |
| .withApplicationId(appId) |
| .withSerializer(Serializer.using(serializer)) |
| .build().asJavaMap(); |
| |
| KryoNamespace fttbMacSerializer = KryoNamespace.newBuilder() |
| .register(KryoNamespaces.API) |
| .register(ConnectPoint.class) |
| .register(MacAddress.class) |
| .build(); |
| |
| fttbMacAddresses = storageService.<ConnectPoint, MacAddress>consistentMapBuilder() |
| .withName("fttb-mac-addresses") |
| .withApplicationId(appId) |
| .withSerializer(Serializer.using(fttbMacSerializer)) |
| .build().asJavaMap(); |
| |
| flowRuleService.addListener(internalFlowListener); |
| |
| log.info("Started"); |
| } |
| |
| @Deactivate |
| public void deactivate(ComponentContext context) { |
| cfgService.unregisterProperties(getClass(), false); |
| flowRuleService.removeListener(internalFlowListener); |
| log.info("Stopped"); |
| } |
| |
| @Modified |
| public void modified(ComponentContext context) { |
| |
| Dictionary<?, ?> properties = context != null ? context.getProperties() : new Properties(); |
| |
| Boolean o = Tools.isPropertyEnabled(properties, ENABLE_DHCP_ON_NNI); |
| if (o != null) { |
| enableDhcpOnNni = o; |
| } |
| |
| Boolean v4 = Tools.isPropertyEnabled(properties, ENABLE_DHCP_V4); |
| if (v4 != null) { |
| enableDhcpV4 = v4; |
| } |
| |
| Boolean v6 = Tools.isPropertyEnabled(properties, ENABLE_DHCP_V6); |
| if (v6 != null) { |
| enableDhcpV6 = v6; |
| } |
| |
| Boolean p = Tools.isPropertyEnabled(properties, ENABLE_IGMP_ON_NNI); |
| if (p != null) { |
| enableIgmpOnNni = p; |
| } |
| |
| Boolean eap = Tools.isPropertyEnabled(properties, ENABLE_EAPOL); |
| if (eap != null) { |
| enableEapol = eap; |
| } |
| |
| Boolean pppoeInNni = Tools.isPropertyEnabled(properties, ENABLE_PPPOE_ON_NNI); |
| if (pppoeInNni != null) { |
| enablePppoeOnNni = pppoeInNni; |
| } |
| |
| Boolean pppoe = Tools.isPropertyEnabled(properties, ENABLE_PPPOE); |
| if (pppoe != null) { |
| enablePppoe = pppoe; |
| } |
| |
| Boolean wait = Tools.isPropertyEnabled(properties, WAIT_FOR_REMOVAL); |
| if (wait != null) { |
| waitForRemoval = wait; |
| } |
| |
| String tpId = get(properties, DEFAULT_TP_ID); |
| defaultTechProfileId = isNullOrEmpty(tpId) ? DEFAULT_TP_ID_DEFAULT : Integer.parseInt(tpId.trim()); |
| |
| Boolean removeOnDisable = Tools.isPropertyEnabled(properties, REMOVE_FLOWS_ON_DISABLE); |
| if (removeOnDisable != null) { |
| removeFlowsOnDisable = removeOnDisable; |
| } |
| |
| log.info("Modified. Values = enableDhcpOnNni: {}, enableDhcpV4: {}, " + "enableDhcpV6:{}, " + |
| "enableIgmpOnNni:{}, enableEapol:{}, enablePppoeOnNni: {}, enablePppoe:{}, " + |
| "defaultTechProfileId:{}, waitForRemoval:{}, removeFlowsOnDisable:{}", |
| enableDhcpOnNni, enableDhcpV4, enableDhcpV6, enableIgmpOnNni, enableEapol, |
| enablePppoeOnNni, enablePppoe, defaultTechProfileId, waitForRemoval, removeOnDisable); |
| } |
| |
| @Override |
| public ImmutableMap<ServiceKey, OltPortStatus> getConnectPointStatus() { |
| try { |
| cpStatusReadLock.lock(); |
| return ImmutableMap.copyOf(cpStatus); |
| } finally { |
| cpStatusReadLock.unlock(); |
| } |
| } |
| |
| @Override |
| public ImmutableMap<ServiceKey, UniTagInformation> getProgrammedSubscribers() { |
| // NOTE we might want to remove this conversion and directly use cpStatus as it contains |
| // all the required information about subscribers |
| Map<ServiceKey, UniTagInformation> subscribers = |
| new HashMap<>(); |
| try { |
| cpStatusReadLock.lock(); |
| |
| cpStatus.forEach((sk, status) -> { |
| ConnectPoint cp = sk.getPort().connectPoint(); |
| Device device = deviceService.getDevice(cp.deviceId()); |
| boolean notNni = !oltDeviceService.isNniPort(device, cp.port()); |
| boolean notEapol = !sk.getService().equals(defaultEapolUniTag); |
| boolean hasHsia = status.subscriberFlowsStatus.hasFlow(); |
| boolean hasDhcp = status.dhcpStatus.hasFlow(); |
| if (notNni && notEapol && (hasHsia || hasDhcp)) { |
| subscribers.put(sk, sk.getService()); |
| } |
| }); |
| |
| return ImmutableMap.copyOf(subscribers); |
| } finally { |
| cpStatusReadLock.unlock(); |
| } |
| } |
| |
| @Override |
| public Map<ServiceKey, Boolean> getRequestedSubscribers() { |
| try { |
| provisionedSubscribersReadLock.lock(); |
| return ImmutableMap.copyOf(provisionedSubscribers); |
| } finally { |
| provisionedSubscribersReadLock.unlock(); |
| } |
| } |
| |
| @Override |
| public void handleNniFlows(Device device, Port port, FlowOperation action) { |
| |
| // always handle the LLDP flow |
| log.debug("{} LLDP trap flow on NNI {} for device {}", flowOpToString(action), portWithName(port), device.id()); |
| processLldpFilteringObjective(device.id(), port, action); |
| |
| if (enableDhcpOnNni) { |
| if (enableDhcpV4) { |
| log.debug("{} DHCPv4 trap flow on NNI {} for device {}", flowOpToString(action), |
| portWithName(port), device.id()); |
| processDhcpFilteringObjectives(device.id(), port, action, FlowDirection.DOWNSTREAM, |
| 67, 68, EthType.EtherType.IPV4.ethType(), IPv4.PROTOCOL_UDP, |
| null, null, nniUniTag); |
| } |
| if (enableDhcpV6) { |
| log.debug("{} DHCPv6 trap flow on NNI {} for device {}", flowOpToString(action), |
| portWithName(port), device.id()); |
| processDhcpFilteringObjectives(device.id(), port, action, FlowDirection.DOWNSTREAM, |
| 546, 547, EthType.EtherType.IPV6.ethType(), IPv6.PROTOCOL_UDP, |
| null, null, nniUniTag); |
| } |
| } else { |
| log.debug("DHCP is not required on NNI {} for device {}", portWithName(port), device.id()); |
| } |
| |
| if (enableIgmpOnNni) { |
| log.debug("{} IGMP flow on NNI {} for device {}", flowOpToString(action), portWithName(port), device.id()); |
| processIgmpFilteringObjectives(device.id(), port, action, FlowDirection.DOWNSTREAM, |
| null, null, NONE_TP_ID, VlanId.NONE, VlanId.ANY, -1); |
| } |
| |
| if (enablePppoeOnNni) { |
| log.debug("{} PPPoE flow on NNI {} for device {}", flowOpToString(action), port.number(), device.id()); |
| processPPPoEDFilteringObjectives(device.id(), port, action, FlowDirection.DOWNSTREAM, |
| null, null, NONE_TP_ID, VlanId.NONE, VlanId.ANY, null); |
| } |
| } |
| |
| @Override |
| public boolean handleBasicPortFlows(DiscoveredSubscriber sub, String bandwidthProfileId, |
| String oltBandwidthProfileId) { |
| // we only need to something if EAPOL is enabled |
| if (!enableEapol) { |
| log.debug("Eapol is disabled for {}", portWithName(sub.port)); |
| return true; |
| } |
| |
| if (sub.status == DiscoveredSubscriber.Status.ADDED) { |
| return addDefaultFlows(sub, bandwidthProfileId, oltBandwidthProfileId); |
| } else if (sub.status == DiscoveredSubscriber.Status.REMOVED) { |
| return removeDefaultFlows(sub, bandwidthProfileId, oltBandwidthProfileId); |
| } else { |
| log.error("Unknown Status {} on DiscoveredSubscriber {}", sub.status, sub); |
| return false; |
| } |
| } |
| |
| private boolean addDefaultFlows(DiscoveredSubscriber sub, String bandwidthProfileId, String oltBandwidthProfileId) { |
| log.debug("Adding default flows for {}, status {}", portWithName(sub.port), sub.status); |
| if (!oltMeterService.createMeter(sub.device.id(), bandwidthProfileId)) { |
| if (log.isTraceEnabled()) { |
| log.trace("waiting on meter for bp {} and sub {}", bandwidthProfileId, sub); |
| } |
| return false; |
| } |
| if (hasDefaultEapol(sub.port)) { |
| OltPortStatus status = getOltPortStatus(sub.port, defaultEapolUniTag); |
| log.debug("Eapol is already present for {} with status {}", portWithName(sub.port), status); |
| return true; |
| } |
| return handleEapolFlow(sub, bandwidthProfileId, |
| oltBandwidthProfileId, FlowOperation.ADD, VlanId.vlanId(EAPOL_DEFAULT_VLAN)); |
| |
| } |
| |
| private boolean removeDefaultFlows(DiscoveredSubscriber sub, String bandwidthProfile, String oltBandwidthProfile) { |
| // NOTE that we are not checking for meters as they must have been created to install the flow in first place |
| return handleEapolFlow(sub, bandwidthProfile, oltBandwidthProfile, |
| FlowOperation.REMOVE, VlanId.vlanId(EAPOL_DEFAULT_VLAN)); |
| } |
| |
| @Override |
| public boolean handleSubscriberFlows(DiscoveredSubscriber sub, String defaultBandwidthProfile, |
| String multicastServiceName) { |
| // NOTE that we are taking defaultBandwithProfile as a parameter as that can be configured in the Olt component |
| if (sub.status == DiscoveredSubscriber.Status.ADDED) { |
| return addSubscriberFlows(sub, defaultBandwidthProfile, multicastServiceName); |
| } else if (sub.status == DiscoveredSubscriber.Status.REMOVED || |
| sub.status == DiscoveredSubscriber.Status.ADMIN_REMOVED) { |
| return removeSubscriberFlows(sub, defaultBandwidthProfile, multicastServiceName); |
| } else { |
| log.error("don't know how to handle {}", sub); |
| return false; |
| } |
| } |
| |
| private boolean addSubscriberFlows(DiscoveredSubscriber sub, String defaultBandwithProfile, |
| String multicastServiceName) { |
| if (log.isTraceEnabled()) { |
| log.trace("Provisioning of subscriber on {} started", portWithName(sub.port)); |
| } |
| if (enableEapol) { |
| if (hasDefaultEapol(sub.port)) { |
| // remove EAPOL flow and throw exception so that we'll retry later |
| if (!isDefaultEapolPendingRemoval(sub.port)) { |
| removeDefaultFlows(sub, defaultBandwithProfile, defaultBandwithProfile); |
| } |
| |
| if (waitForRemoval) { |
| // NOTE wait for removal is a flag only needed to make sure VOLTHA |
| // does not explode with the flows remove/add in the same batch |
| log.debug("Awaiting for default flows removal for {}", portWithName(sub.port)); |
| return false; |
| } else { |
| log.warn("continuing provisioning on {}", portWithName(sub.port)); |
| } |
| } |
| } |
| |
| // NOTE createMeters will return if the meters are not installed |
| if (!oltMeterService.createMeters(sub.device.id(), |
| sub.subscriberAndDeviceInformation, multicastServiceName)) { |
| return false; |
| } |
| |
| // NOTE we need to add the DHCP flow regardless so that the host can be discovered and the MacAddress added |
| handleSubscriberDhcpFlows(sub.device.id(), sub.port, FlowOperation.ADD, |
| sub.subscriberAndDeviceInformation); |
| |
| if (isMacLearningEnabled(sub.subscriberAndDeviceInformation) |
| && !isMacAddressAvailable(sub.device.id(), sub.port, |
| sub.subscriberAndDeviceInformation)) { |
| log.debug("Awaiting for macAddress on {}", portWithName(sub.port)); |
| return false; |
| } |
| |
| // NOTE that the EAPOL flows handling is based on the data-plane flows status |
| // always process them before |
| handleSubscriberEapolFlows(sub, FlowOperation.ADD, sub.subscriberAndDeviceInformation); |
| |
| handleSubscriberPppoeFlows(sub.device.id(), sub.port, FlowOperation.ADD, sub.subscriberAndDeviceInformation); |
| |
| handleSubscriberDataFlows(sub.device, sub.port, FlowOperation.ADD, |
| sub.subscriberAndDeviceInformation, multicastServiceName); |
| |
| handleSubscriberIgmpFlows(sub, FlowOperation.ADD); |
| |
| log.info("Provisioning of subscriber on {} completed", portWithName(sub.port)); |
| return true; |
| } |
| |
| protected boolean removeSubscriberFlows(DiscoveredSubscriber sub, String defaultBandwithProfile, |
| String multicastServiceName) { |
| |
| if (log.isTraceEnabled()) { |
| log.trace("Removal of subscriber on {} started", |
| portWithName(sub.port)); |
| } |
| SubscriberAndDeviceInformation si = sub.subscriberAndDeviceInformation; |
| //If the port has been removed the device service will return null, while it will be true if it's just disabled |
| boolean isPortPresent = deviceService.getPort(new ConnectPoint(sub.device.id(), sub.port.number())) != null; |
| if (log.isTraceEnabled()) { |
| log.trace("Port {} present: ", portWithName(sub.port), isPortPresent); |
| } |
| // Always remove the EAPOL flow in case of port disable,remove or subscriber remove. |
| if (enableEapol) { |
| // remove the tagged eapol |
| handleSubscriberEapolFlows(sub, FlowOperation.REMOVE, si); |
| log.info("Removal of eapol flow for subscriber on {} completed", portWithName(sub.port)); |
| |
| } |
| // If the port is gone entirely (onu delete) or it's enabled (subscriber remove request) remove all the flows |
| // In the case the port is just disabled we remove only the EAPOL flow because the ONU disable only represents |
| // the UNI side of the ONU going down, either for RG cable detach or for an administrative decision, but the PON |
| // side is still up as nothing changed, so no need to add/remove flows, when and if the UNI comes up |
| // we will re-push the EAPOL flow to require the subscriber to auth again. |
| // When the subscriber is admin removed from REST or CLI we ignore the port status. |
| // Check the admin Status of the port |
| if ((!isPortPresent || sub.port.isEnabled() || sub.status == DiscoveredSubscriber.Status.ADMIN_REMOVED) |
| || removeFlowsOnDisable) { |
| |
| handleSubscriberDhcpFlows(sub.device.id(), sub.port, FlowOperation.REMOVE, si); |
| |
| handleSubscriberPppoeFlows(sub.device.id(), sub.port, FlowOperation.REMOVE, |
| sub.subscriberAndDeviceInformation); |
| |
| handleSubscriberDataFlows(sub.device, sub.port, FlowOperation.REMOVE, si, multicastServiceName); |
| |
| handleSubscriberIgmpFlows(sub, FlowOperation.REMOVE); |
| |
| |
| if (enableEapol) { |
| |
| // if any of the services still has flows, return false |
| Iterator<UniTagInformation> iter = sub.subscriberAndDeviceInformation.uniTagList().iterator(); |
| while (iter.hasNext()) { |
| UniTagInformation entry = iter.next(); |
| if (areSubscriberFlowsPendingRemoval(sub.port, entry, enableEapol)) { |
| log.info("Subscriber {} still have flows on service {}, postpone default EAPOL installation.", |
| portWithName(sub.port), entry.getServiceName()); |
| return false; |
| } |
| } |
| |
| // once the flows are removed add the default one back |
| // (only if the port is ENABLED and still present on the device) |
| if (sub.port.isEnabled() && deviceService.getPort(sub.device.id(), sub.port.number()) != null) { |
| |
| // NOTE we remove the subscriber when the port goes down |
| // but in that case we don't need to add default eapol |
| handleEapolFlow(sub, defaultBandwithProfile, defaultBandwithProfile, |
| FlowOperation.ADD, VlanId.vlanId(EAPOL_DEFAULT_VLAN)); |
| } |
| } |
| // FIXME check the return status of the flow and return accordingly |
| log.info("Removal of subscriber on {} completed", portWithName(sub.port)); |
| return true; |
| } |
| return true; |
| } |
| |
| @Override |
| public boolean hasDefaultEapol(Port port) { |
| OltPortStatus status = getOltPortStatus(port, defaultEapolUniTag); |
| return status != null && (status.defaultEapolStatus == OltFlowsStatus.ADDED || |
| status.defaultEapolStatus == OltFlowsStatus.PENDING_ADD); |
| } |
| |
| private OltPortStatus getOltPortStatus(Port port, UniTagInformation uniTagInformation) { |
| try { |
| cpStatusReadLock.lock(); |
| ServiceKey sk = new ServiceKey(new AccessDevicePort(port), uniTagInformation); |
| OltPortStatus status = cpStatus.get(sk); |
| return status; |
| } finally { |
| cpStatusReadLock.unlock(); |
| } |
| } |
| |
| public boolean isDefaultEapolPendingRemoval(Port port) { |
| OltPortStatus status = getOltPortStatus(port, defaultEapolUniTag); |
| if (log.isTraceEnabled()) { |
| log.trace("Status during EAPOL flow check {} for port {} and UniTagInformation {}", |
| status, portWithName(port), defaultEapolUniTag); |
| } |
| return status != null && status.defaultEapolStatus == OltFlowsStatus.PENDING_REMOVE; |
| } |
| |
| @Override |
| public boolean hasDhcpFlows(Port port, UniTagInformation uti) { |
| OltPortStatus status = getOltPortStatus(port, uti); |
| if (log.isTraceEnabled()) { |
| log.trace("Status during DHCP flow check {} for port {} and service {}", |
| status, portWithName(port), uti.getServiceName()); |
| } |
| return status != null && |
| (status.dhcpStatus == OltFlowsStatus.ADDED || |
| status.dhcpStatus == OltFlowsStatus.PENDING_ADD); |
| } |
| |
| @Override |
| public boolean hasPppoeFlows(Port port, UniTagInformation uti) { |
| OltPortStatus status = getOltPortStatus(port, uti); |
| if (log.isTraceEnabled()) { |
| log.trace("Status during PPPoE flow check {} for port {} and service {}", |
| status, portWithName(port), uti.getServiceName()); |
| } |
| return status != null && |
| (status.pppoeStatus == OltFlowsStatus.ADDED || |
| status.pppoeStatus == OltFlowsStatus.PENDING_ADD); |
| } |
| |
| @Override |
| public boolean hasSubscriberFlows(Port port, UniTagInformation uti) { |
| |
| OltPortStatus status = getOltPortStatus(port, uti); |
| if (log.isTraceEnabled()) { |
| log.trace("Status during subscriber flow check {} for port {} and service {}", |
| status, portWithName(port), uti.getServiceName()); |
| } |
| return status != null && (status.subscriberFlowsStatus == OltFlowsStatus.ADDED || |
| status.subscriberFlowsStatus == OltFlowsStatus.PENDING_ADD); |
| } |
| |
| public boolean areSubscriberFlowsPendingRemoval(Port port, UniTagInformation uti, boolean enableEapol) { |
| OltPortStatus status = getOltPortStatus(port, uti); |
| if (log.isTraceEnabled()) { |
| log.trace("Status during pending_remove flow check {} for port {} and UniTagInformation {}", |
| status, portWithName(port), uti); |
| } |
| return status != null && (status.subscriberFlowsStatus == OltFlowsStatus.PENDING_REMOVE || |
| (enableEapol && status.subscriberEapolStatus == OltFlowsStatus.PENDING_REMOVE) || |
| (uti.getIsDhcpRequired() && status.dhcpStatus == OltFlowsStatus.PENDING_REMOVE)); |
| } |
| |
| @Override |
| public void purgeDeviceFlows(DeviceId deviceId) { |
| log.debug("Purging flows on device {}", deviceId); |
| flowRuleService.purgeFlowRules(deviceId); |
| |
| // removing the status from the cpStatus map |
| if (log.isTraceEnabled()) { |
| log.trace("Clearing cp status from device {}", deviceId); |
| } |
| try { |
| cpStatusWriteLock.lock(); |
| Iterator<Map.Entry<ServiceKey, OltPortStatus>> iter = cpStatus.entrySet().iterator(); |
| while (iter.hasNext()) { |
| Map.Entry<ServiceKey, OltPortStatus> entry = iter.next(); |
| if (entry.getKey().getPort().connectPoint().deviceId().equals(deviceId)) { |
| cpStatus.remove(entry.getKey()); |
| } |
| } |
| } finally { |
| cpStatusWriteLock.unlock(); |
| } |
| |
| // removing subscribers from the provisioned map |
| if (log.isTraceEnabled()) { |
| log.trace("Clearing provisioned subscribers from device {}", deviceId); |
| } |
| try { |
| provisionedSubscribersWriteLock.lock(); |
| Iterator<Map.Entry<ServiceKey, Boolean>> iter = provisionedSubscribers.entrySet().iterator(); |
| while (iter.hasNext()) { |
| Map.Entry<ServiceKey, Boolean> entry = iter.next(); |
| if (entry.getKey().getPort().connectPoint().deviceId().equals(deviceId)) { |
| provisionedSubscribers.remove(entry.getKey()); |
| } |
| } |
| } finally { |
| provisionedSubscribersWriteLock.unlock(); |
| } |
| log.debug("Done clearing up device flows and subscribers"); |
| } |
| |
| @Override |
| public boolean isSubscriberServiceProvisioned(AccessDevicePort cp) { |
| Set<Map.Entry<ServiceKey, Boolean>> subs; |
| try { |
| provisionedSubscribersReadLock.lock(); |
| subs = new HashSet<>(provisionedSubscribers.entrySet()); |
| } finally { |
| provisionedSubscribersReadLock.unlock(); |
| } |
| |
| for (Map.Entry<ServiceKey, Boolean> entry : subs) { |
| if (entry.getKey().getPort().equals(cp) && entry.getValue()) { |
| return true; |
| } |
| } |
| return false; |
| } |
| |
| @Override |
| public boolean isSubscriberServiceProvisioned(ServiceKey sk) { |
| try { |
| provisionedSubscribersReadLock.lock(); |
| Boolean provisioned = provisionedSubscribers.get(sk); |
| if (provisioned == null || !provisioned) { |
| return false; |
| } |
| } finally { |
| provisionedSubscribersReadLock.unlock(); |
| } |
| return true; |
| } |
| |
| @Override |
| public void updateProvisionedSubscriberStatus(ServiceKey sk, Boolean status) { |
| try { |
| provisionedSubscribersWriteLock.lock(); |
| provisionedSubscribers.put(sk, status); |
| } finally { |
| provisionedSubscribersWriteLock.unlock(); |
| } |
| } |
| |
| protected boolean handleEapolFlow(DiscoveredSubscriber sub, String bandwidthProfile, |
| String oltBandwidthProfile, FlowOperation action, VlanId vlanId) { |
| |
| // create a subscriberKey for the EAPOL flow |
| ServiceKey sk = new ServiceKey(new AccessDevicePort(sub.port), defaultEapolUniTag); |
| OltFlowsStatus status = action == FlowOperation.ADD ? |
| OltFlowsStatus.PENDING_ADD : OltFlowsStatus.PENDING_REMOVE; |
| if (vlanId.id().equals(EAPOL_DEFAULT_VLAN)) { |
| updateConnectPointStatus(sk, status, OltFlowsStatus.NONE, OltFlowsStatus.NONE, |
| OltFlowsStatus.NONE, OltFlowsStatus.NONE); |
| |
| } else { |
| updateConnectPointStatus(sk, OltFlowsStatus.NONE, status, OltFlowsStatus.NONE, |
| OltFlowsStatus.NONE, OltFlowsStatus.NONE); |
| } |
| |
| DefaultFilteringObjective.Builder filterBuilder = DefaultFilteringObjective.builder(); |
| TrafficTreatment.Builder treatmentBuilder = DefaultTrafficTreatment.builder(); |
| |
| int techProfileId = getDefaultTechProfileId(sub.port); |
| MeterId meterId = oltMeterService.getMeterIdForBandwidthProfile(sub.device.id(), bandwidthProfile); |
| |
| // in the delete case the meter should still be there as we remove |
| // the meters only if no flows are pointing to them |
| if (meterId == null) { |
| log.debug("MeterId is null for BandwidthProfile {} on device {}", |
| bandwidthProfile, sub.device.id()); |
| return false; |
| } |
| |
| MeterId oltMeterId = oltMeterService.getMeterIdForBandwidthProfile(sub.device.id(), oltBandwidthProfile); |
| if (oltMeterId == null) { |
| log.debug("MeterId is null for OltBandwidthProfile {} on device {}", |
| oltBandwidthProfile, sub.device.id()); |
| return false; |
| } |
| |
| log.info("{} EAPOL flow for {} with vlanId {} and BandwidthProfile {} (meterId {})", |
| flowOpToString(action), portWithName(sub.port), vlanId, bandwidthProfile, meterId); |
| |
| FilteringObjective.Builder eapolAction; |
| |
| if (action == FlowOperation.ADD) { |
| eapolAction = filterBuilder.permit(); |
| } else if (action == FlowOperation.REMOVE) { |
| eapolAction = filterBuilder.deny(); |
| } else { |
| log.error("Operation {} not supported", action); |
| return false; |
| } |
| |
| FilteringObjective.Builder baseEapol = eapolAction |
| .withKey(Criteria.matchInPort(sub.port.number())) |
| .addCondition(Criteria.matchEthType(EthType.EtherType.EAPOL.ethType())); |
| |
| // NOTE we only need to add the treatment to install the flow, |
| // we can remove it based in the match |
| FilteringObjective.Builder eapol; |
| |
| // Setting VlanId.NONE as cvlan in the metadata as the packet will be single tagged |
| // and cvlan should not be filled. |
| TrafficTreatment treatment = treatmentBuilder |
| .meter(meterId) |
| .writeMetadata(OltFlowServiceUtils.createTechProfValueForWriteMetadata( |
| VlanId.NONE, |
| techProfileId, oltMeterId), 0) |
| .setOutput(PortNumber.CONTROLLER) |
| .pushVlan() |
| .setVlanId(vlanId) |
| .build(); |
| eapol = baseEapol |
| .withMeta(treatment); |
| |
| FilteringObjective eapolObjective = eapol |
| .fromApp(appId) |
| .withPriority(MAX_PRIORITY) |
| .add(new ObjectiveContext() { |
| @Override |
| public void onSuccess(Objective objective) { |
| log.info("EAPOL flow objective {} for {}", |
| completeFlowOpToString(action), portWithName(sub.port)); |
| if (log.isTraceEnabled()) { |
| log.trace("EAPOL flow details for port {}: {}", portWithName(sub.port), objective); |
| } |
| } |
| |
| @Override |
| public void onError(Objective objective, ObjectiveError error) { |
| log.error("Cannot {} eapol flow for {} : {}", action, |
| portWithName(sub.port), error); |
| |
| if (vlanId.id().equals(EAPOL_DEFAULT_VLAN)) { |
| updateConnectPointStatus(sk, |
| OltFlowsStatus.ERROR, null, null, null, null); |
| } |
| } |
| }); |
| |
| flowObjectiveService.filter(sub.device.id(), eapolObjective); |
| |
| log.info("{} EAPOL filter for {}", completeFlowOpToString(action), portWithName(sub.port)); |
| return true; |
| } |
| |
| // FIXME it's confusing that si is not necessarily inside the DiscoveredSubscriber |
| protected boolean handleSubscriberEapolFlows(DiscoveredSubscriber sub, FlowOperation action, |
| SubscriberAndDeviceInformation si) { |
| if (!enableEapol) { |
| return true; |
| } |
| // TODO verify we need an EAPOL flow for EACH service |
| AtomicBoolean success = new AtomicBoolean(true); |
| si.uniTagList().forEach(u -> { |
| //Always act on the eapol flow |
| log.info("{} EAPOL flows for subscriber {} on {} and service {}", |
| flowOpToString(action), si.id(), portWithName(sub.port), u.getServiceName()); |
| if (!handleEapolFlow(sub, u.getUpstreamBandwidthProfile(), |
| u.getUpstreamOltBandwidthProfile(), |
| action, u.getPonCTag())) { |
| // |
| log.error("Failed to {} EAPOL with subscriber tags", action); |
| //TODO this sets it for all services, maybe some services succeeded. |
| success.set(false); |
| } |
| }); |
| return success.get(); |
| } |
| |
| protected void handleSubscriberIgmpFlows(DiscoveredSubscriber sub, FlowOperation action) { |
| sub.subscriberAndDeviceInformation.uniTagList().forEach(uti -> { |
| if (uti.getIsIgmpRequired()) { |
| DeviceId deviceId = sub.device.id(); |
| // if we reached here a meter already exists |
| MeterId meterId = oltMeterService |
| .getMeterIdForBandwidthProfile(deviceId, uti.getUpstreamBandwidthProfile()); |
| MeterId oltMeterId = oltMeterService |
| .getMeterIdForBandwidthProfile(deviceId, uti.getUpstreamOltBandwidthProfile()); |
| |
| processIgmpFilteringObjectives(deviceId, sub.port, |
| action, FlowDirection.UPSTREAM, meterId, oltMeterId, uti.getTechnologyProfileId(), |
| uti.getPonCTag(), uti.getUniTagMatch(), uti.getUsPonCTagPriority()); |
| } |
| }); |
| } |
| |
| private boolean checkSadisRunning() { |
| if (bpService == null) { |
| log.warn("Sadis is not running"); |
| return false; |
| } |
| return true; |
| } |
| |
| private int getDefaultTechProfileId(Port port) { |
| if (!checkSadisRunning()) { |
| return defaultTechProfileId; |
| } |
| if (port != null) { |
| SubscriberAndDeviceInformation info = subsService.get(getPortName(port)); |
| if (info != null && info.uniTagList().size() == 1) { |
| return info.uniTagList().get(0).getTechnologyProfileId(); |
| } |
| } |
| return defaultTechProfileId; |
| } |
| |
| private void processLldpFilteringObjective(DeviceId deviceId, Port port, FlowOperation action) { |
| DefaultFilteringObjective.Builder builder = DefaultFilteringObjective.builder(); |
| |
| FilteringObjective lldp = (action == FlowOperation.ADD ? builder.permit() : builder.deny()) |
| .withKey(Criteria.matchInPort(port.number())) |
| .addCondition(Criteria.matchEthType(EthType.EtherType.LLDP.ethType())) |
| .withMeta(DefaultTrafficTreatment.builder() |
| .setOutput(PortNumber.CONTROLLER).build()) |
| .fromApp(appId) |
| .withPriority(MAX_PRIORITY) |
| .add(new ObjectiveContext() { |
| @Override |
| public void onSuccess(Objective objective) { |
| log.info("{} LLDP filter for {}.", completeFlowOpToString(action), portWithName(port)); |
| } |
| |
| @Override |
| public void onError(Objective objective, ObjectiveError error) { |
| log.error("Falied to {} LLDP filter on {} because {}", action, portWithName(port), |
| error); |
| } |
| }); |
| |
| flowObjectiveService.filter(deviceId, lldp); |
| } |
| |
| protected void handleSubscriberDhcpFlows(DeviceId deviceId, Port port, |
| FlowOperation action, |
| SubscriberAndDeviceInformation si) { |
| si.uniTagList().forEach(uti -> { |
| |
| if (!uti.getIsDhcpRequired()) { |
| return; |
| } |
| |
| // if it's an ADD skip if flows are there, |
| // if it's a DELETE skip if flows are not there |
| boolean hasFlows = hasDhcpFlows(port, uti); |
| if (action == FlowOperation.ADD && hasFlows || |
| action == FlowOperation.REMOVE && !hasFlows) { |
| log.debug("Not dealing with DHCP {} on {} as DHCP flow status is {}", action, |
| uti.getServiceName(), hasFlows); |
| return; |
| } |
| |
| log.info("{} DHCP flows for subscriber on {} and service {}", |
| flowOpToString(action), portWithName(port), uti.getServiceName()); |
| |
| // if we reached here a meter already exists |
| MeterId meterId = oltMeterService |
| .getMeterIdForBandwidthProfile(deviceId, uti.getUpstreamBandwidthProfile()); |
| MeterId oltMeterId = oltMeterService |
| .getMeterIdForBandwidthProfile(deviceId, uti.getUpstreamOltBandwidthProfile()); |
| |
| if (enableDhcpV4) { |
| processDhcpFilteringObjectives(deviceId, port, action, FlowDirection.UPSTREAM, 68, 67, |
| EthType.EtherType.IPV4.ethType(), IPv4.PROTOCOL_UDP, meterId, oltMeterId, |
| uti); |
| } |
| if (enableDhcpV6) { |
| log.error("DHCP V6 not supported for subscribers"); |
| } |
| }); |
| } |
| |
| protected void handleSubscriberPppoeFlows(DeviceId deviceId, Port port, |
| FlowOperation action, |
| SubscriberAndDeviceInformation si) { |
| si.uniTagList().forEach(uti -> { |
| |
| if (!uti.getIsPppoeRequired()) { |
| return; |
| } |
| |
| // if it's an ADD skip if flows are there, |
| // if it's a DELETE skip if flows are not there |
| boolean hasFlows = hasPppoeFlows(port, uti); |
| if (action == FlowOperation.ADD && hasFlows || |
| action == FlowOperation.REMOVE && !hasFlows) { |
| log.debug("Not dealing with PPPoE {} on {} as PPPoE flow status is {}", action, |
| uti.getServiceName(), hasFlows); |
| return; |
| } |
| |
| log.info("{} PPPoE flows for subscriber on {} and service {}", |
| flowOpToString(action), portWithName(port), uti.getServiceName()); |
| |
| // if we reached here a meter already exists |
| MeterId meterId = oltMeterService |
| .getMeterIdForBandwidthProfile(deviceId, uti.getUpstreamBandwidthProfile()); |
| MeterId oltMeterId = oltMeterService |
| .getMeterIdForBandwidthProfile(deviceId, uti.getUpstreamOltBandwidthProfile()); |
| |
| if (enablePppoe) { |
| processPPPoEDFilteringObjectives(deviceId, port, action, FlowDirection.UPSTREAM, meterId, oltMeterId, |
| uti.getTechnologyProfileId(), uti.getPonCTag(), uti.getUniTagMatch(), |
| (byte) uti.getUsPonCTagPriority()); |
| } |
| }); |
| } |
| |
| // FIXME return boolean, if this fails we need to retry |
| protected void handleSubscriberDataFlows(Device device, Port port, |
| FlowOperation action, |
| SubscriberAndDeviceInformation si, String multicastServiceName) { |
| |
| Optional<Port> nniPort = oltDeviceService.getNniPort(device); |
| if (nniPort == null || nniPort.isEmpty()) { |
| log.error("Cannot configure DP flows as upstream port is not configured for subscriber {} on {}", |
| si.id(), portWithName(port)); |
| return; |
| } |
| si.uniTagList().forEach(uti -> { |
| |
| boolean hasFlows = hasSubscriberFlows(port, uti); |
| if (action == FlowOperation.ADD && hasFlows || |
| action == FlowOperation.REMOVE && !hasFlows) { |
| log.debug("Not dealing with DP flows {} on {} as subscriber flow status is {}", action, |
| uti.getServiceName(), hasFlows); |
| return; |
| } |
| |
| if (multicastServiceName.equals(uti.getServiceName())) { |
| log.debug("This is the multicast service ({}) for subscriber {} on {}, " + |
| "dataplane flows are not needed", |
| uti.getServiceName(), si.id(), portWithName(port)); |
| return; |
| } |
| |
| log.info("{} Data plane flows for subscriber {} on {} and service {}", |
| flowOpToString(action), si.id(), portWithName(port), uti.getServiceName()); |
| ServiceKey sk = new ServiceKey(new AccessDevicePort(port), uti); |
| OltFlowsStatus status = action.equals(FlowOperation.ADD) ? |
| OltFlowsStatus.PENDING_ADD : OltFlowsStatus.PENDING_REMOVE; |
| updateConnectPointStatus(sk, null, null, status, null, null); |
| |
| // upstream flows |
| MeterId usMeterId = oltMeterService |
| .getMeterIdForBandwidthProfile(device.id(), uti.getUpstreamBandwidthProfile()); |
| MeterId oltUsMeterId = oltMeterService |
| .getMeterIdForBandwidthProfile(device.id(), uti.getUpstreamOltBandwidthProfile()); |
| |
| if (FttbUtils.isFttbService(uti)) { |
| processFttbUpstreamDataFilteringObjects(device.id(), port, nniPort.get(), action, |
| usMeterId, oltUsMeterId, uti, si); |
| } else { |
| processUpstreamDataFilteringObjects(device.id(), port, nniPort.get(), action, usMeterId, |
| oltUsMeterId, uti); |
| } |
| |
| // downstream flows |
| MeterId dsMeterId = oltMeterService |
| .getMeterIdForBandwidthProfile(device.id(), uti.getDownstreamBandwidthProfile()); |
| MeterId oltDsMeterId = oltMeterService |
| .getMeterIdForBandwidthProfile(device.id(), uti.getDownstreamOltBandwidthProfile()); |
| |
| if (FttbUtils.isFttbService(uti)) { |
| processFttbDownstreamDataFilteringObjects(device.id(), port, nniPort.get(), |
| action, dsMeterId, oltDsMeterId, uti, si); |
| } else { |
| processDownstreamDataFilteringObjects(device.id(), port, nniPort.get(), action, dsMeterId, |
| oltDsMeterId, uti, getMacAddress(device.id(), port, uti)); |
| } |
| }); |
| } |
| |
| private void processDhcpFilteringObjectives(DeviceId deviceId, Port port, |
| FlowOperation action, FlowDirection direction, |
| int udpSrc, int udpDst, EthType ethType, byte protocol, |
| MeterId meterId, MeterId oltMeterId, UniTagInformation uti) { |
| ServiceKey sk = new ServiceKey(new AccessDevicePort(port), uti); |
| log.debug("{} DHCP filtering objectives on {}", flowOpToString(action), sk); |
| |
| String serviceName = uti.getServiceName(); |
| |
| OltFlowsStatus status = action.equals(FlowOperation.ADD) ? |
| OltFlowsStatus.PENDING_ADD : OltFlowsStatus.PENDING_REMOVE; |
| updateConnectPointStatus(sk, null, null, null, status, null); |
| |
| DefaultFilteringObjective.Builder builder = DefaultFilteringObjective.builder(); |
| TrafficTreatment.Builder treatmentBuilder = DefaultTrafficTreatment.builder(); |
| |
| if (meterId != null) { |
| treatmentBuilder.meter(meterId); |
| } |
| |
| FilteringObjective.Builder dhcpBuilder = (action == FlowOperation.ADD ? builder.permit() : builder.deny()) |
| .withKey(Criteria.matchInPort(port.number())) |
| .addCondition(Criteria.matchEthType(ethType)) |
| .addCondition(Criteria.matchIPProtocol(protocol)) |
| .addCondition(Criteria.matchUdpSrc(TpPort.tpPort(udpSrc))) |
| .addCondition(Criteria.matchUdpDst(TpPort.tpPort(udpDst))) |
| .fromApp(appId) |
| .withPriority(MAX_PRIORITY); |
| |
| //VLAN changes and PCP matching need to happen only in the upstream directions |
| if (direction == FlowDirection.UPSTREAM) { |
| if (serviceName != null && serviceName.equals(FTTB_SERVICE_DPU_MGMT_TRAFFIC)) { |
| FttbUtils.addUpstreamDhcpCondition(dhcpBuilder, uti); |
| FttbUtils.addUpstreamDhcpTreatment(treatmentBuilder, uti); |
| } else { |
| treatmentBuilder.setVlanId(uti.getPonCTag()); |
| if (!VlanId.vlanId(VlanId.NO_VID).equals(uti.getUniTagMatch())) { |
| dhcpBuilder.addCondition(Criteria.matchVlanId(uti.getUniTagMatch())); |
| } |
| if (uti.getUsPonCTagPriority() != -1) { |
| treatmentBuilder.setVlanPcp((byte) uti.getUsPonCTagPriority()); |
| } |
| } |
| } else if (direction == FlowDirection.DOWNSTREAM) { |
| // Down stream DHCP vid to be matched if OLT Sadis info contains Vlan id in nniDhcpTrapVid. |
| Device device = deviceService.getDevice(deviceId); |
| SubscriberAndDeviceInformation oltSub = subsService.get(device.serialNumber()); |
| VlanId nniDhcpTrapVid = oltSub.nniDhcpTrapVid(); |
| |
| if (nniDhcpTrapVid != null && !VlanId.vlanId(VlanId.NO_VID).equals(nniDhcpTrapVid)) { |
| dhcpBuilder.addCondition(Criteria.matchVlanId(nniDhcpTrapVid)); |
| } |
| } |
| |
| if (uti.getTechnologyProfileId() != NONE_TP_ID) { |
| // Setting VlanId.NONE as cvlan, as the packet will be single tagged and cvlan should not be filled. |
| treatmentBuilder.writeMetadata( |
| OltFlowServiceUtils.createTechProfValueForWriteMetadata(VlanId.NONE, |
| uti.getTechnologyProfileId(), oltMeterId), 0); |
| } |
| |
| dhcpBuilder.withMeta(treatmentBuilder |
| .setOutput(PortNumber.CONTROLLER).build()); |
| |
| |
| FilteringObjective dhcpUpstream = dhcpBuilder.add(new ObjectiveContext() { |
| @Override |
| public void onSuccess(Objective objective) { |
| log.info("{} DHCP {} filter for {}.", |
| completeFlowOpToString(action), (ethType.equals(EthType.EtherType.IPV4.ethType())) ? V4 : V6, |
| portWithName(port)); |
| } |
| |
| @Override |
| public void onError(Objective objective, ObjectiveError error) { |
| log.error("DHCP {} filter for {} failed {} because {}", |
| (ethType.equals(EthType.EtherType.IPV4.ethType())) ? V4 : V6, |
| portWithName(port), |
| action, |
| error); |
| updateConnectPointStatus(sk, null, null, null, OltFlowsStatus.ERROR, null); |
| } |
| }); |
| flowObjectiveService.filter(deviceId, dhcpUpstream); |
| } |
| |
| private void processIgmpFilteringObjectives(DeviceId deviceId, Port port, |
| FlowOperation action, FlowDirection direction, |
| MeterId meterId, MeterId oltMeterId, int techProfileId, |
| VlanId cTag, VlanId unitagMatch, int vlanPcp) { |
| |
| DefaultFilteringObjective.Builder filterBuilder = DefaultFilteringObjective.builder(); |
| TrafficTreatment.Builder treatmentBuilder = DefaultTrafficTreatment.builder(); |
| if (direction == FlowDirection.UPSTREAM) { |
| |
| if (techProfileId != NONE_TP_ID) { |
| treatmentBuilder.writeMetadata(OltFlowServiceUtils.createTechProfValueForWriteMetadata(null, |
| techProfileId, oltMeterId), 0); |
| } |
| |
| |
| if (meterId != null) { |
| treatmentBuilder.meter(meterId); |
| } |
| |
| if (!VlanId.vlanId(VlanId.NO_VID).equals(unitagMatch)) { |
| filterBuilder.addCondition(Criteria.matchVlanId(unitagMatch)); |
| } |
| if (!VlanId.vlanId(VlanId.NO_VID).equals(cTag)) { |
| treatmentBuilder.setVlanId(cTag); |
| } |
| |
| if (vlanPcp != -1) { |
| treatmentBuilder.setVlanPcp((byte) vlanPcp); |
| } |
| } |
| |
| filterBuilder = (action == FlowOperation.ADD) ? filterBuilder.permit() : filterBuilder.deny(); |
| |
| FilteringObjective igmp = filterBuilder |
| .withKey(Criteria.matchInPort(port.number())) |
| .addCondition(Criteria.matchEthType(EthType.EtherType.IPV4.ethType())) |
| .addCondition(Criteria.matchIPProtocol(IPv4.PROTOCOL_IGMP)) |
| .withMeta(treatmentBuilder |
| .setOutput(PortNumber.CONTROLLER).build()) |
| .fromApp(appId) |
| .withPriority(MAX_PRIORITY) |
| .add(new ObjectiveContext() { |
| @Override |
| public void onSuccess(Objective objective) { |
| log.info("Igmp filter for {} {}.", portWithName(port), action); |
| } |
| |
| @Override |
| public void onError(Objective objective, ObjectiveError error) { |
| log.error("Igmp filter for {} failed {} because {}.", portWithName(port), action, |
| error); |
| } |
| }); |
| |
| flowObjectiveService.filter(deviceId, igmp); |
| |
| } |
| |
| private void processPPPoEDFilteringObjectives(DeviceId deviceId, Port port, |
| FlowOperation action, FlowDirection direction, |
| MeterId meterId, MeterId oltMeterId, int techProfileId, |
| VlanId cTag, VlanId unitagMatch, Byte vlanPcp) { |
| |
| DefaultFilteringObjective.Builder builder = DefaultFilteringObjective.builder(); |
| TrafficTreatment.Builder treatmentBuilder = DefaultTrafficTreatment.builder(); |
| |
| if (meterId != null) { |
| treatmentBuilder.meter(meterId); |
| } |
| |
| if (techProfileId != NONE_TP_ID) { |
| // Setting VlanId.NONE as cvlan as the packet will be single tagged and cvlan should not be filled. |
| treatmentBuilder.writeMetadata(OltFlowServiceUtils.createTechProfValueForWriteMetadata(VlanId.NONE, |
| techProfileId, oltMeterId), 0); |
| } |
| |
| DefaultFilteringObjective.Builder pppoedBuilder = ((action == FlowOperation.ADD) |
| ? builder.permit() : builder.deny()) |
| .withKey(Criteria.matchInPort(port.number())) |
| .addCondition(Criteria.matchEthType(EthType.EtherType.PPPoED.ethType())) |
| .fromApp(appId) |
| .withPriority(10000); |
| |
| if (direction == FlowDirection.UPSTREAM) { |
| treatmentBuilder.setVlanId(cTag); |
| if (!VlanId.vlanId(VlanId.NO_VID).equals(unitagMatch)) { |
| pppoedBuilder.addCondition(Criteria.matchVlanId(unitagMatch)); |
| } |
| if (vlanPcp != null) { |
| treatmentBuilder.setVlanPcp(vlanPcp); |
| } |
| } |
| pppoedBuilder = pppoedBuilder.withMeta(treatmentBuilder.setOutput(PortNumber.CONTROLLER).build()); |
| |
| FilteringObjective pppoed = pppoedBuilder |
| .add(new ObjectiveContext() { |
| @Override |
| public void onSuccess(Objective objective) { |
| log.info("PPPoED filter for {} {}.", portWithName(port), action); |
| } |
| |
| @Override |
| public void onError(Objective objective, ObjectiveError error) { |
| log.info("PPPoED filter for {} failed {} because {}", portWithName(port), |
| action, error); |
| } |
| }); |
| flowObjectiveService.filter(deviceId, pppoed); |
| } |
| |
| private void processUpstreamDataFilteringObjects(DeviceId deviceId, Port port, Port nniPort, |
| FlowOperation action, |
| MeterId upstreamMeterId, |
| MeterId upstreamOltMeterId, |
| UniTagInformation uti) { |
| ServiceKey sk = new ServiceKey(new AccessDevicePort(port), uti); |
| TrafficSelector selector = DefaultTrafficSelector.builder() |
| .matchInPort(port.number()) |
| .matchVlanId(uti.getUniTagMatch()) |
| .build(); |
| |
| TrafficTreatment.Builder treatmentBuilder = DefaultTrafficTreatment.builder(); |
| //if the subscriberVlan (cTag) is different than ANY it needs to set. |
| if (uti.getPonCTag().toShort() != VlanId.ANY_VALUE) { |
| treatmentBuilder.pushVlan() |
| .setVlanId(uti.getPonCTag()); |
| } |
| if (uti.getPonSTag().toShort() == VlanId.ANY_VALUE) { |
| treatmentBuilder.popVlan(); |
| } |
| |
| if (uti.getUsPonCTagPriority() != -1) { |
| treatmentBuilder.setVlanPcp((byte) uti.getUsPonCTagPriority()); |
| |
| } |
| |
| treatmentBuilder.pushVlan() |
| .setVlanId(uti.getPonSTag()); |
| |
| if (uti.getUsPonSTagPriority() != -1) { |
| treatmentBuilder.setVlanPcp((byte) uti.getUsPonSTagPriority()); |
| } |
| |
| treatmentBuilder.setOutput(nniPort.number()) |
| .writeMetadata(OltFlowServiceUtils.createMetadata(uti.getPonCTag(), |
| uti.getTechnologyProfileId(), nniPort.number()), 0L); |
| |
| DefaultAnnotations.Builder annotationBuilder = DefaultAnnotations.builder(); |
| |
| if (upstreamMeterId != null) { |
| treatmentBuilder.meter(upstreamMeterId); |
| annotationBuilder.set(UPSTREAM_ONU, upstreamMeterId.toString()); |
| } |
| if (upstreamOltMeterId != null) { |
| treatmentBuilder.meter(upstreamOltMeterId); |
| annotationBuilder.set(UPSTREAM_OLT, upstreamOltMeterId.toString()); |
| } |
| |
| DefaultForwardingObjective.Builder flowBuilder = createForwardingObjectiveBuilder(selector, |
| treatmentBuilder.build(), MIN_PRIORITY, |
| annotationBuilder.build()); |
| |
| ObjectiveContext context = getSubscriberFlowBuilderContext(sk, action, FlowDirection.UPSTREAM); |
| processForwardingRule(action, flowBuilder, context, deviceId); |
| } |
| |
| private void processDownstreamDataFilteringObjects(DeviceId deviceId, Port port, Port nniPort, |
| FlowOperation action, |
| MeterId downstreamMeterId, |
| MeterId downstreamOltMeterId, |
| UniTagInformation uti, |
| MacAddress macAddress) { |
| ServiceKey sk = new ServiceKey(new AccessDevicePort(port), uti); |
| //subscriberVlan can be any valid Vlan here including ANY to make sure the packet is tagged |
| TrafficSelector.Builder selectorBuilder = DefaultTrafficSelector.builder() |
| .matchVlanId(uti.getPonSTag()) |
| .matchInPort(nniPort.number()) |
| .matchInnerVlanId(uti.getPonCTag()); |
| |
| if (uti.getPonCTag().toShort() != VlanId.ANY_VALUE) { |
| selectorBuilder.matchMetadata(uti.getPonCTag().toShort()); |
| } |
| |
| if (uti.getDsPonCTagPriority() != -1) { |
| selectorBuilder.matchVlanPcp((byte) uti.getDsPonCTagPriority()); |
| } |
| |
| if (macAddress != null) { |
| selectorBuilder.matchEthDst(macAddress); |
| } |
| |
| TrafficTreatment.Builder treatmentBuilder = DefaultTrafficTreatment.builder() |
| .popVlan() |
| .setOutput(port.number()); |
| |
| treatmentBuilder.writeMetadata(OltFlowServiceUtils.createMetadata(uti.getPonCTag(), |
| uti.getTechnologyProfileId(), |
| port.number()), 0); |
| |
| // Upstream pbit is used to remark inner vlan pbit. |
| // Upstream is used to avoid trusting the BNG to send the packet with correct pbit. |
| // this is done because ds mode 0 is used because ds mode 3 or 6 that allow for |
| // all pbit acceptance are not widely supported by vendors even though present in |
| // the OMCI spec. |
| if (uti.getUsPonCTagPriority() != -1) { |
| treatmentBuilder.setVlanPcp((byte) uti.getUsPonCTagPriority()); |
| } |
| |
| if (!VlanId.NONE.equals(uti.getUniTagMatch()) && |
| uti.getPonCTag().toShort() != VlanId.ANY_VALUE) { |
| treatmentBuilder.setVlanId(uti.getUniTagMatch()); |
| } |
| |
| DefaultAnnotations.Builder annotationBuilder = DefaultAnnotations.builder(); |
| |
| if (downstreamMeterId != null) { |
| treatmentBuilder.meter(downstreamMeterId); |
| annotationBuilder.set(DOWNSTREAM_ONU, downstreamMeterId.toString()); |
| } |
| |
| if (downstreamOltMeterId != null) { |
| treatmentBuilder.meter(downstreamOltMeterId); |
| annotationBuilder.set(DOWNSTREAM_OLT, downstreamOltMeterId.toString()); |
| } |
| |
| DefaultForwardingObjective.Builder flowBuilder = createForwardingObjectiveBuilder(selectorBuilder.build(), |
| treatmentBuilder.build(), MIN_PRIORITY, annotationBuilder.build()); |
| |
| ObjectiveContext context = getSubscriberFlowBuilderContext(sk, action, FlowDirection.DOWNSTREAM); |
| processForwardingRule(action, flowBuilder, context, deviceId); |
| } |
| |
| private DefaultForwardingObjective.Builder createForwardingObjectiveBuilder(TrafficSelector selector, |
| TrafficTreatment treatment, |
| Integer priority, |
| Annotations annotations) { |
| return DefaultForwardingObjective.builder() |
| .withFlag(ForwardingObjective.Flag.VERSATILE) |
| .withPriority(priority) |
| .makePermanent() |
| .withSelector(selector) |
| .withAnnotations(annotations) |
| .fromApp(appId) |
| .withTreatment(treatment); |
| } |
| |
| private boolean isMacLearningEnabled(SubscriberAndDeviceInformation si) { |
| AtomicBoolean requiresMacLearning = new AtomicBoolean(); |
| requiresMacLearning.set(false); |
| |
| si.uniTagList().forEach(uniTagInfo -> { |
| if (uniTagInfo.getEnableMacLearning()) { |
| requiresMacLearning.set(true); |
| } |
| }); |
| |
| return requiresMacLearning.get(); |
| } |
| |
| /** |
| * Checks whether the subscriber has the MacAddress configured or discovered. |
| * |
| * @param deviceId DeviceId for this subscriber |
| * @param port Port for this subscriber |
| * @param si SubscriberAndDeviceInformation |
| * @return boolean |
| */ |
| protected boolean isMacAddressAvailable(DeviceId deviceId, Port port, SubscriberAndDeviceInformation si) { |
| AtomicBoolean isConfigured = new AtomicBoolean(); |
| isConfigured.set(true); |
| |
| si.uniTagList().forEach(uniTagInfo -> { |
| boolean isMacLearningEnabled = uniTagInfo.getEnableMacLearning(); |
| boolean configureMac = OltFlowServiceUtils.isMacAddressValid(uniTagInfo); |
| boolean discoveredMac = false; |
| |
| final VlanId vlan; |
| |
| if (FttbUtils.isFttbDpuOrAncpService(uniTagInfo)) { |
| // Using S tag, as C tag is replaced by Stag by ONU. |
| vlan = uniTagInfo.getPonSTag(); |
| } else { |
| vlan = uniTagInfo.getPonCTag(); |
| } |
| |
| Optional<Host> optHost = hostService.getConnectedHosts(new ConnectPoint(deviceId, port.number())) |
| .stream().filter(host -> host.vlan().equals(vlan)).findFirst(); |
| if (optHost.isPresent() && optHost.get().mac() != null) { |
| discoveredMac = true; |
| } |
| if (isMacLearningEnabled && !configureMac && !discoveredMac) { |
| log.debug("Awaiting for macAddress on {} for service {}", |
| portWithName(port), uniTagInfo.getServiceName()); |
| isConfigured.set(false); |
| } |
| }); |
| |
| return isConfigured.get(); |
| } |
| |
| protected MacAddress getMacAddress(DeviceId deviceId, Port port, UniTagInformation uniTagInfo) { |
| boolean configuredMac = OltFlowServiceUtils.isMacAddressValid(uniTagInfo); |
| if (configuredMac) { |
| return MacAddress.valueOf(uniTagInfo.getConfiguredMacAddress()); |
| } else if (uniTagInfo.getEnableMacLearning()) { |
| Optional<Host> optHost = hostService.getConnectedHosts(new ConnectPoint(deviceId, port.number())) |
| .stream().filter(host -> host.vlan().equals(uniTagInfo.getPonCTag())).findFirst(); |
| if (optHost.isPresent() && optHost.get().mac() != null) { |
| return optHost.get().mac(); |
| } |
| } |
| return null; |
| } |
| |
| protected void updateConnectPointStatus(ServiceKey key, OltFlowsStatus eapolStatus, |
| OltFlowsStatus subscriberEapolStatus, |
| OltFlowsStatus subscriberFlowsStatus, OltFlowsStatus dhcpStatus, |
| OltFlowsStatus pppoeStatus) { |
| if (log.isTraceEnabled()) { |
| log.trace("Updating cpStatus {} with values: eapolFlow={}, " + |
| "subscriberEapolStatus={}, subscriberFlows={}, dhcpFlow={}", |
| key, eapolStatus, subscriberEapolStatus, subscriberFlowsStatus, dhcpStatus); |
| } |
| try { |
| cpStatusWriteLock.lock(); |
| OltPortStatus status = cpStatus.get(key); |
| |
| |
| if (status == null) { |
| // if we don't have status for the connectPoint |
| // and we're only updating status to PENDING_REMOVE or ERROR |
| // do not create it. This is because this case will only happen when a device is removed |
| // and it's status cleaned |
| List<OltFlowsStatus> statusesToIgnore = new ArrayList<>(); |
| statusesToIgnore.add(OltFlowsStatus.PENDING_REMOVE); |
| statusesToIgnore.add(OltFlowsStatus.ERROR); |
| |
| if ( |
| (statusesToIgnore.contains(subscriberFlowsStatus) && dhcpStatus == null) || |
| (subscriberFlowsStatus == null && statusesToIgnore.contains(dhcpStatus)) |
| ) { |
| if (log.isTraceEnabled()) { |
| log.trace("Ignoring cpStatus update as status is meaningless"); |
| } |
| return; |
| } |
| |
| status = new OltPortStatus( |
| eapolStatus != null ? eapolStatus : OltFlowsStatus.NONE, |
| subscriberEapolStatus != null ? subscriberEapolStatus : OltFlowsStatus.NONE, |
| subscriberFlowsStatus != null ? subscriberFlowsStatus : OltFlowsStatus.NONE, |
| dhcpStatus != null ? dhcpStatus : OltFlowsStatus.NONE, |
| pppoeStatus != null ? pppoeStatus : OltFlowsStatus.NONE |
| ); |
| } else { |
| if (eapolStatus != null) { |
| status.defaultEapolStatus = eapolStatus; |
| } |
| if (subscriberFlowsStatus != null) { |
| status.subscriberFlowsStatus = subscriberFlowsStatus; |
| } |
| if (dhcpStatus != null) { |
| status.dhcpStatus = dhcpStatus; |
| } |
| } |
| |
| cpStatus.put(key, status); |
| } finally { |
| cpStatusWriteLock.unlock(); |
| } |
| } |
| |
| protected class InternalFlowListener implements FlowRuleListener { |
| |
| private OltFlowServiceInterface oltFlowService; |
| |
| public InternalFlowListener(OltFlowServiceInterface oltFlowService) { |
| this.oltFlowService = oltFlowService; |
| } |
| |
| @Override |
| public void event(FlowRuleEvent event) { |
| if (appId.id() != (event.subject().appId())) { |
| return; |
| } |
| |
| if (!oltDeviceService.isLocalLeader(event.subject().deviceId())) { |
| if (log.isTraceEnabled()) { |
| log.trace("ignoring flow event {} " + |
| "as not leader for {}", event, event.subject().deviceId()); |
| } |
| return; |
| } |
| |
| switch (event.type()) { |
| case RULE_ADDED: |
| case RULE_REMOVED: |
| DeviceId deviceId = event.subject().deviceId(); |
| Port port = getCpFromFlowRule(event.subject()); |
| if (port == null) { |
| log.warn("Port is gone in ONOS, " + |
| "manually creating it {}", event.subject()); |
| PortNumber inPort = OltFlowServiceUtils.getPortNumberFromFlowRule(event.subject()); |
| cpStatusReadLock.lock(); |
| Optional<ServiceKey> keyWithPort = cpStatus.keySet() |
| .stream().filter(key -> key.getPort().connectPoint() |
| .deviceId().equals(deviceId) |
| && key.getPort().connectPoint().port() |
| .equals(inPort)).findFirst(); |
| cpStatusReadLock.unlock(); |
| if (keyWithPort.isPresent()) { |
| port = new DefaultPort(deviceService.getDevice(deviceId), |
| inPort, false, |
| DefaultAnnotations.builder() |
| .set(AnnotationKeys.PORT_NAME, |
| keyWithPort.get().getPort().name()) |
| .build()); |
| } else { |
| log.warn("Can't find corresponding status for {}/{}", deviceId, inPort); |
| return; |
| } |
| } |
| if (log.isTraceEnabled()) { |
| log.trace("flow event {} on cp {}: {}", event.type(), |
| portWithName(port), event.subject()); |
| } |
| updateCpStatus(event.type(), port, event.subject()); |
| return; |
| case RULE_ADD_REQUESTED: |
| case RULE_REMOVE_REQUESTED: |
| // NOTE that PENDING_ADD/REMOVE is set when we create the flowObjective |
| return; |
| default: |
| return; |
| } |
| } |
| |
| protected void updateCpStatus(FlowRuleEvent.Type type, Port port, FlowRule flowRule) { |
| OltFlowsStatus status = OltFlowServiceUtils.flowRuleStatusToOltFlowStatus(type); |
| if (OltFlowServiceUtils.isDefaultEapolFlow(flowRule)) { |
| ServiceKey sk = new ServiceKey(new AccessDevicePort(port), |
| defaultEapolUniTag); |
| if (log.isTraceEnabled()) { |
| log.trace("update defaultEapolStatus {} on {}", status, sk); |
| } |
| updateConnectPointStatus(sk, status, null, null, null, null); |
| } else if (OltFlowServiceUtils.isSubscriberEapolFlow(flowRule)) { |
| ServiceKey sk = getSubscriberKeyFromFlowRule(flowRule, port); |
| if (sk == null) { |
| return; |
| } |
| if (log.isTraceEnabled()) { |
| log.trace("update subscriberEapolStatus {} on {}", status, sk); |
| } |
| updateConnectPointStatus(sk, null, status, null, null, null); |
| } else if (OltFlowServiceUtils.isDhcpFlow(flowRule)) { |
| ServiceKey sk = getSubscriberKeyFromFlowRule(flowRule, port); |
| if (sk == null) { |
| return; |
| } |
| if (log.isTraceEnabled()) { |
| log.trace("update dhcpStatus {} on {}", status, sk); |
| } |
| updateConnectPointStatus(sk, null, null, null, status, null); |
| } else if (OltFlowServiceUtils.isPppoeFlow(flowRule)) { |
| ServiceKey sk = getSubscriberKeyFromFlowRule(flowRule, port); |
| if (sk == null) { |
| return; |
| } |
| if (log.isTraceEnabled()) { |
| log.trace("update pppoeStatus {} on {}", status, sk); |
| } |
| updateConnectPointStatus(sk, null, null, null, null, status); |
| } else if (OltFlowServiceUtils.isDataFlow(flowRule)) { |
| PortNumber number = OltFlowServiceUtils.getPortNumberFromFlowRule(flowRule); |
| if (number == null) { |
| log.error("Can't capture the port number from flow {}", flowRule); |
| return; |
| } |
| if (oltDeviceService.isNniPort(deviceService.getDevice(flowRule.deviceId()), number)) { |
| // the NNI has data-plane for every subscriber, doesn't make sense to track them |
| return; |
| } |
| |
| ServiceKey sk = getSubscriberKeyFromFlowRule(flowRule, port); |
| if (sk == null) { |
| return; |
| } |
| if (log.isTraceEnabled()) { |
| log.trace("update dataplaneStatus {} on {}", status, sk); |
| } |
| updateConnectPointStatus(sk, null, null, status, null, null); |
| } |
| } |
| |
| |
| |
| private Port getCpFromFlowRule(FlowRule flowRule) { |
| DeviceId deviceId = flowRule.deviceId(); |
| PortNumber inPort = OltFlowServiceUtils.getPortNumberFromFlowRule(flowRule); |
| if (inPort != null) { |
| return deviceService.getPort(deviceId, inPort); |
| } |
| return null; |
| } |
| |
| private ServiceKey getSubscriberKeyFromFlowRule(FlowRule flowRule, Port flowPort) { |
| AccessDevicePort accessDevicePort = new AccessDevicePort(flowPort); |
| SubscriberAndDeviceInformation si = getProgrammedSubscriber(oltFlowService, accessDevicePort); |
| if (si == null) { |
| log.debug("si not found in programmedSubscribers, getting it from sadis."); |
| si = subsService.get(getPortName(flowPort)); |
| } |
| |
| Boolean isNni = oltDeviceService.isNniPort(deviceService.getDevice(flowRule.deviceId()), flowPort.number()); |
| if (si == null && !isNni) { |
| log.error("Subscriber information not found in sadis for port {}", portWithName(flowPort)); |
| return null; |
| } |
| |
| if (isNni) { |
| return new ServiceKey(new AccessDevicePort(flowPort), nniUniTag); |
| } |
| |
| Optional<UniTagInformation> found = Optional.empty(); |
| VlanId flowVlan = null; |
| if (OltFlowServiceUtils.isDhcpFlow(flowRule)) { |
| // we need to make a special case for DHCP as in the ATT workflow DHCP flows don't match on tags |
| L2ModificationInstruction.ModVlanIdInstruction instruction = |
| (L2ModificationInstruction.ModVlanIdInstruction) flowRule.treatment().immediate().get(1); |
| flowVlan = instruction.vlanId(); |
| } else if (OltFlowServiceUtils.isSubscriberEapolFlow(flowRule)) { |
| // we need to make a special case for EAPOL as in the ATT workflow EAPOL flows don't match on tags |
| L2ModificationInstruction.ModVlanIdInstruction instruction = |
| (L2ModificationInstruction.ModVlanIdInstruction) flowRule.treatment().immediate().get(2); |
| flowVlan = instruction.vlanId(); |
| } else { |
| // for now we assume that if it's not DHCP it's dataplane (or at least tagged) |
| VlanIdCriterion vlanIdCriterion = |
| (VlanIdCriterion) flowRule.selector().getCriterion(Criterion.Type.VLAN_VID); |
| if (vlanIdCriterion == null) { |
| log.warn("cannot match the flow to a subscriber service as it does not carry vlans"); |
| return null; |
| } |
| flowVlan = vlanIdCriterion.vlanId(); |
| } |
| |
| VlanId finalFlowVlan = flowVlan; |
| found = si.uniTagList().stream().filter(uti -> |
| uti.getPonCTag().equals(finalFlowVlan) || |
| uti.getPonSTag().equals(finalFlowVlan) || |
| uti.getUniTagMatch().equals(finalFlowVlan) |
| ).findFirst(); |
| |
| |
| if (found.isEmpty()) { |
| log.warn("Cannot map flow rule {} to Service in {}", flowRule, si); |
| } |
| |
| return found.isPresent() ? new ServiceKey(new AccessDevicePort(flowPort), found.get()) : null; |
| |
| } |
| } |
| |
| protected void bindSadisService(SadisService service) { |
| this.subsService = service.getSubscriberInfoService(); |
| this.bpService = service.getBandwidthProfileService(); |
| log.info("Sadis service is loaded"); |
| } |
| |
| protected void unbindSadisService(SadisService service) { |
| this.subsService = null; |
| this.bpService = null; |
| log.info("Sadis service is unloaded"); |
| } |
| |
| private void processFttbUpstreamDataFilteringObjects(DeviceId deviceId, Port port, Port nniPort, |
| FlowOperation action, |
| MeterId upstreamMeterId, |
| MeterId upstreamOltMeterId, |
| UniTagInformation uti, |
| SubscriberAndDeviceInformation si) { |
| String serviceName = uti.getServiceName(); |
| ServiceKey sk = new ServiceKey(new AccessDevicePort(port), uti); |
| TrafficSelector.Builder selectorBuilder = DefaultTrafficSelector.builder() |
| .matchInPort(port.number()) |
| .matchVlanId(uti.getPonCTag()); |
| |
| if (uti.getUsPonCTagPriority() != -1) { |
| selectorBuilder.matchVlanPcp((byte) uti.getUsPonCTagPriority()); |
| } |
| |
| TrafficTreatment.Builder treatmentBuilder = DefaultTrafficTreatment.builder(); |
| |
| treatmentBuilder.setVlanId(uti.getPonSTag()); |
| if (uti.getUsPonSTagPriority() != -1) { |
| treatmentBuilder.setVlanPcp((byte) uti.getUsPonSTagPriority()); |
| } |
| |
| DefaultAnnotations.Builder annotationBuilder = DefaultAnnotations.builder(); |
| annotationBuilder.set(FTTB_SERVICE_NAME, serviceName); |
| annotationBuilder.set(FTTB_FLOW_DIRECTION, FTTB_FLOW_UPSTREAM); |
| |
| if (upstreamMeterId != null) { |
| treatmentBuilder.meter(upstreamMeterId); |
| annotationBuilder.set(UPSTREAM_ONU, upstreamMeterId.toString()); |
| } |
| if (upstreamOltMeterId != null) { |
| treatmentBuilder.meter(upstreamOltMeterId); |
| annotationBuilder.set(UPSTREAM_OLT, upstreamOltMeterId.toString()); |
| } |
| |
| VlanId innerVlan = null; |
| treatmentBuilder.setOutput(nniPort.number()); |
| if (serviceName.equals(FTTB_SERVICE_DPU_MGMT_TRAFFIC) || serviceName.equals(FTTB_SERVICE_DPU_ANCP_TRAFFIC)) { |
| fttbMacAddressesWriteLock.lock(); |
| MacAddress mac = FttbUtils.getMacAddressFromDhcpEnabledUti( |
| hostService, si, deviceId, port, fttbMacAddresses); |
| fttbMacAddressesWriteLock.unlock(); |
| |
| if (mac == null) { |
| log.error("Mac address not found port:{}, vlan:{}, service:{}", |
| port, uti.getPonSTag(), serviceName); |
| return; |
| } |
| |
| selectorBuilder.matchEthSrc(mac); |
| |
| treatmentBuilder.writeMetadata(OltFlowServiceUtils.createMetadata(VlanId.NONE, |
| uti.getTechnologyProfileId(), nniPort.number()), 0L); |
| |
| } else if (serviceName.equals(FTTB_SERVICE_SUBSCRIBER_TRAFFIC)) { |
| treatmentBuilder.writeMetadata(OltFlowServiceUtils.createMetadata(VlanId.ANY, |
| uti.getTechnologyProfileId(), nniPort.number()), 0L); |
| } |
| |
| DefaultForwardingObjective.Builder flowBuilder = createForwardingObjectiveBuilder(selectorBuilder.build(), |
| treatmentBuilder.build(), MIN_PRIORITY, |
| annotationBuilder.build()); |
| |
| ObjectiveContext context = getSubscriberFlowBuilderContext(sk, action, FlowDirection.UPSTREAM); |
| processForwardingRule(action, flowBuilder, context, deviceId); |
| } |
| |
| private void processFttbDownstreamDataFilteringObjects(DeviceId deviceId, Port port, Port nniPort, |
| FlowOperation action, |
| MeterId downstreamMeterId, |
| MeterId downstreamOltMeterId, |
| UniTagInformation uti, SubscriberAndDeviceInformation si) { |
| String serviceName = uti.getServiceName(); |
| ServiceKey sk = new ServiceKey(new AccessDevicePort(port), uti); |
| //subscriberVlan can be any valid Vlan here including ANY to make sure the packet is tagged |
| TrafficSelector.Builder selectorBuilder = DefaultTrafficSelector.builder() |
| .matchVlanId(uti.getPonSTag()) |
| .matchInPort(nniPort.number()); |
| |
| TrafficTreatment.Builder treatmentBuilder = DefaultTrafficTreatment.builder() |
| .setVlanId(uti.getPonCTag()) |
| .setOutput(port.number()); |
| |
| DefaultAnnotations.Builder annotationBuilder = DefaultAnnotations.builder(); |
| annotationBuilder.set(FTTB_SERVICE_NAME, uti.getServiceName()); |
| annotationBuilder.set(FTTB_FLOW_DIRECTION, FTTB_FLOW_DOWNSTREAM); |
| |
| if (downstreamMeterId != null) { |
| treatmentBuilder.meter(downstreamMeterId); |
| annotationBuilder.set(DOWNSTREAM_ONU, downstreamMeterId.toString()); |
| } |
| |
| if (downstreamOltMeterId != null) { |
| treatmentBuilder.meter(downstreamOltMeterId); |
| annotationBuilder.set(DOWNSTREAM_OLT, downstreamOltMeterId.toString()); |
| } |
| |
| VlanId innerVlan = null; |
| |
| if (serviceName.equals(FTTB_SERVICE_DPU_MGMT_TRAFFIC) || serviceName.equals(FTTB_SERVICE_DPU_ANCP_TRAFFIC)) { |
| fttbMacAddressesWriteLock.lock(); |
| MacAddress mac = FttbUtils.getMacAddressFromDhcpEnabledUti( |
| hostService, si, deviceId, port, fttbMacAddresses); |
| fttbMacAddressesWriteLock.unlock(); |
| |
| if (mac == null) { |
| log.error("Mac address not found port:{}, vlan:{}, service:{}", |
| port, uti.getPonSTag(), serviceName); |
| return; |
| } |
| |
| selectorBuilder.matchEthDst(mac); |
| innerVlan = VlanId.NONE; |
| treatmentBuilder.writeMetadata(OltFlowServiceUtils.createMetadata(innerVlan, |
| uti.getTechnologyProfileId(), |
| port.number()), 0); |
| |
| } else if (serviceName.equals(FTTB_SERVICE_SUBSCRIBER_TRAFFIC)) { |
| selectorBuilder.matchMetadata(uti.getPonSTag().toShort()); |
| treatmentBuilder.writeMetadata(OltFlowServiceUtils.createMetadata(VlanId.ANY, |
| uti.getTechnologyProfileId(), |
| port.number()), 0); |
| } |
| |
| DefaultForwardingObjective.Builder flowBuilder = createForwardingObjectiveBuilder(selectorBuilder.build(), |
| treatmentBuilder.build(), MIN_PRIORITY, annotationBuilder.build()); |
| |
| ObjectiveContext context = getSubscriberFlowBuilderContext(sk, action, FlowDirection.DOWNSTREAM); |
| processForwardingRule(action, flowBuilder, context, deviceId); |
| } |
| |
| private ObjectiveContext getSubscriberFlowBuilderContext(ServiceKey sk, FlowOperation action, |
| FlowDirection flowDirection) { |
| ObjectiveContext context = new ObjectiveContext() { |
| @Override |
| public void onSuccess(Objective objective) { |
| log.info("{} {} Data plane filter for {}.", |
| completeFlowOpToString(action), flowDirection, sk); |
| } |
| |
| @Override |
| public void onError(Objective objective, ObjectiveError error) { |
| log.info("{} Data plane filter for {} failed {} because {}.", |
| flowDirection, sk, action, error); |
| updateConnectPointStatus(sk, null, null, OltFlowsStatus.ERROR, null, null); |
| } |
| }; |
| |
| return context; |
| } |
| |
| private void processForwardingRule(FlowOperation action, DefaultForwardingObjective.Builder flowBuilder, |
| ObjectiveContext context, DeviceId deviceId) { |
| ForwardingObjective flow = null; |
| if (action == FlowOperation.ADD) { |
| flow = flowBuilder.add(context); |
| } else if (action == FlowOperation.REMOVE) { |
| flow = flowBuilder.remove(context); |
| } else { |
| log.error("Flow action not supported: {}", action); |
| } |
| |
| if (flow != null) { |
| if (log.isTraceEnabled()) { |
| log.trace("Forwarding rule {}", flow); |
| } |
| flowObjectiveService.forward(deviceId, flow); |
| } |
| } |
| } |