| /* |
| * Copyright 2014-2015 Open Networking Laboratory |
| * |
| * 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.provider.host.impl; |
| |
| import org.apache.felix.scr.annotations.Activate; |
| import org.apache.felix.scr.annotations.Component; |
| import org.apache.felix.scr.annotations.Deactivate; |
| import org.apache.felix.scr.annotations.Modified; |
| import org.apache.felix.scr.annotations.Property; |
| import org.apache.felix.scr.annotations.Reference; |
| import org.apache.felix.scr.annotations.ReferenceCardinality; |
| import org.onlab.packet.ARP; |
| import org.onlab.packet.Ethernet; |
| import org.onlab.packet.ICMP6; |
| import org.onlab.packet.IPacket; |
| import org.onlab.packet.IPv6; |
| import org.onlab.packet.IpAddress; |
| import org.onlab.packet.MacAddress; |
| import org.onlab.packet.VlanId; |
| import org.onlab.packet.ipv6.IExtensionHeader; |
| import org.onlab.packet.ndp.NeighborAdvertisement; |
| import org.onlab.packet.ndp.NeighborSolicitation; |
| import org.onlab.packet.ndp.RouterAdvertisement; |
| import org.onlab.packet.ndp.RouterSolicitation; |
| import org.onosproject.cfg.ComponentConfigService; |
| import org.onosproject.core.ApplicationId; |
| import org.onosproject.core.CoreService; |
| import org.onosproject.net.ConnectPoint; |
| import org.onosproject.net.Device; |
| import org.onosproject.net.Host; |
| import org.onosproject.net.HostId; |
| import org.onosproject.net.HostLocation; |
| 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.TrafficSelector; |
| import org.onosproject.net.host.DefaultHostDescription; |
| import org.onosproject.net.host.HostDescription; |
| import org.onosproject.net.host.HostProvider; |
| import org.onosproject.net.host.HostProviderRegistry; |
| import org.onosproject.net.host.HostProviderService; |
| import org.onosproject.net.host.HostService; |
| import org.onosproject.net.packet.PacketContext; |
| import org.onosproject.net.packet.PacketPriority; |
| import org.onosproject.net.packet.PacketProcessor; |
| import org.onosproject.net.packet.PacketService; |
| import org.onosproject.net.provider.AbstractProvider; |
| import org.onosproject.net.provider.ProviderId; |
| import org.onosproject.net.topology.Topology; |
| import org.onosproject.net.topology.TopologyService; |
| import org.osgi.service.component.ComponentContext; |
| import org.slf4j.Logger; |
| |
| import java.util.Dictionary; |
| import java.util.Set; |
| |
| import static com.google.common.base.Strings.isNullOrEmpty; |
| import static org.slf4j.LoggerFactory.getLogger; |
| |
| /** |
| * Provider which uses an OpenFlow controller to detect network |
| * end-station hosts. |
| */ |
| @Component(immediate = true) |
| public class HostLocationProvider extends AbstractProvider implements HostProvider { |
| |
| private final Logger log = getLogger(getClass()); |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| protected CoreService coreService; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| protected HostProviderRegistry providerRegistry; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| protected PacketService packetService; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| protected TopologyService topologyService; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| protected HostService hostService; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| protected DeviceService deviceService; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| protected ComponentConfigService cfgService; |
| |
| private HostProviderService providerService; |
| |
| private final InternalHostProvider processor = new InternalHostProvider(); |
| private final DeviceListener deviceListener = new InternalDeviceListener(); |
| |
| private ApplicationId appId; |
| |
| @Property(name = "hostRemovalEnabled", boolValue = true, |
| label = "Enable host removal on port/device down events") |
| private boolean hostRemovalEnabled = true; |
| |
| @Property(name = "ipv6NeighborDiscovery", boolValue = false, |
| label = "Enable using IPv6 Neighbor Discovery by the " + |
| "Host Location Provider; default is false") |
| private boolean ipv6NeighborDiscovery = false; |
| |
| /** |
| * Creates an OpenFlow host provider. |
| */ |
| public HostLocationProvider() { |
| super(new ProviderId("of", "org.onosproject.provider.host")); |
| } |
| |
| @Activate |
| public void activate(ComponentContext context) { |
| cfgService.registerProperties(getClass()); |
| appId = coreService.registerApplication("org.onosproject.provider.host"); |
| |
| providerService = providerRegistry.register(this); |
| packetService.addProcessor(processor, 1); |
| deviceService.addListener(deviceListener); |
| readComponentConfiguration(context); |
| requestIntercepts(); |
| |
| log.info("Started with Application ID {}", appId.id()); |
| } |
| |
| @Deactivate |
| public void deactivate() { |
| cfgService.unregisterProperties(getClass(), false); |
| |
| withdrawIntercepts(); |
| |
| providerRegistry.unregister(this); |
| packetService.removeProcessor(processor); |
| deviceService.removeListener(deviceListener); |
| providerService = null; |
| log.info("Stopped"); |
| } |
| |
| @Modified |
| public void modified(ComponentContext context) { |
| readComponentConfiguration(context); |
| requestIntercepts(); |
| } |
| |
| /** |
| * Request packet intercepts. |
| */ |
| private void requestIntercepts() { |
| TrafficSelector.Builder selector = DefaultTrafficSelector.builder(); |
| selector.matchEthType(Ethernet.TYPE_ARP); |
| packetService.requestPackets(selector.build(), PacketPriority.CONTROL, appId); |
| |
| // IPv6 Neighbor Solicitation packet. |
| selector.matchEthType(Ethernet.TYPE_IPV6); |
| selector.matchIPProtocol(IPv6.PROTOCOL_ICMP6); |
| selector.matchIcmpv6Type(ICMP6.NEIGHBOR_SOLICITATION); |
| if (ipv6NeighborDiscovery) { |
| packetService.requestPackets(selector.build(), PacketPriority.CONTROL, appId); |
| } else { |
| packetService.cancelPackets(selector.build(), PacketPriority.CONTROL, appId); |
| } |
| |
| // IPv6 Neighbor Advertisement packet. |
| selector.matchIcmpv6Type(ICMP6.NEIGHBOR_ADVERTISEMENT); |
| if (ipv6NeighborDiscovery) { |
| packetService.requestPackets(selector.build(), PacketPriority.CONTROL, appId); |
| } else { |
| packetService.cancelPackets(selector.build(), PacketPriority.CONTROL, appId); |
| } |
| } |
| |
| /** |
| * Withdraw packet intercepts. |
| */ |
| private void withdrawIntercepts() { |
| TrafficSelector.Builder selector = DefaultTrafficSelector.builder(); |
| selector.matchEthType(Ethernet.TYPE_ARP); |
| packetService.cancelPackets(selector.build(), PacketPriority.CONTROL, appId); |
| |
| // IPv6 Neighbor Solicitation packet. |
| selector.matchEthType(Ethernet.TYPE_IPV6); |
| selector.matchIPProtocol(IPv6.PROTOCOL_ICMP6); |
| selector.matchIcmpv6Type(ICMP6.NEIGHBOR_SOLICITATION); |
| packetService.cancelPackets(selector.build(), PacketPriority.CONTROL, appId); |
| |
| // IPv6 Neighbor Advertisement packet. |
| selector.matchIcmpv6Type(ICMP6.NEIGHBOR_ADVERTISEMENT); |
| packetService.cancelPackets(selector.build(), PacketPriority.CONTROL, appId); |
| } |
| |
| /** |
| * Extracts properties from the component configuration context. |
| * |
| * @param context the component context |
| */ |
| private void readComponentConfiguration(ComponentContext context) { |
| Dictionary<?, ?> properties = context.getProperties(); |
| Boolean flag; |
| |
| flag = isPropertyEnabled(properties, "hostRemovalEnabled"); |
| if (flag == null) { |
| log.info("Host removal on port/device down events is not configured, " + |
| "using current value of {}", hostRemovalEnabled); |
| } else { |
| hostRemovalEnabled = flag; |
| log.info("Configured. Host removal on port/device down events is {}", |
| hostRemovalEnabled ? "enabled" : "disabled"); |
| } |
| |
| flag = isPropertyEnabled(properties, "ipv6NeighborDiscovery"); |
| if (flag == null) { |
| log.info("Using IPv6 Neighbor Discovery is not configured, " + |
| "using current value of {}", ipv6NeighborDiscovery); |
| } else { |
| ipv6NeighborDiscovery = flag; |
| log.info("Configured. Using IPv6 Neighbor Discovery is {}", |
| ipv6NeighborDiscovery ? "enabled" : "disabled"); |
| } |
| } |
| |
| /** |
| * Check property name is defined and set to true. |
| * |
| * @param properties properties to be looked up |
| * @param propertyName the name of the property to look up |
| * @return value when the propertyName is defined or return null |
| */ |
| private static Boolean isPropertyEnabled(Dictionary<?, ?> properties, |
| String propertyName) { |
| Boolean value = null; |
| try { |
| String s = (String) properties.get(propertyName); |
| value = isNullOrEmpty(s) ? null : s.trim().equals("true"); |
| } catch (ClassCastException e) { |
| // No propertyName defined. |
| value = null; |
| } |
| return value; |
| } |
| |
| @Override |
| public void triggerProbe(Host host) { |
| log.info("Triggering probe on device {}", host); |
| } |
| |
| private class InternalHostProvider implements PacketProcessor { |
| /** |
| * Update host location only. |
| * |
| * @param hid host ID |
| * @param mac source Mac address |
| * @param vlan VLAN ID |
| * @param hloc host location |
| */ |
| private void updateLocation(HostId hid, MacAddress mac, |
| VlanId vlan, HostLocation hloc) { |
| HostDescription desc = new DefaultHostDescription(mac, vlan, hloc); |
| try { |
| providerService.hostDetected(hid, desc); |
| } catch (IllegalStateException e) { |
| log.debug("Host {} suppressed", hid); |
| } |
| } |
| |
| /** |
| * Update host location and IP address. |
| * |
| * @param hid host ID |
| * @param mac source Mac address |
| * @param vlan VLAN ID |
| * @param hloc host location |
| * @param ip source IP address |
| */ |
| private void updateLocationIP(HostId hid, MacAddress mac, |
| VlanId vlan, HostLocation hloc, |
| IpAddress ip) { |
| HostDescription desc = new DefaultHostDescription(mac, vlan, hloc, ip); |
| try { |
| providerService.hostDetected(hid, desc); |
| } catch (IllegalStateException e) { |
| log.debug("Host {} suppressed", hid); |
| } |
| } |
| |
| @Override |
| public void process(PacketContext context) { |
| if (context == null) { |
| return; |
| } |
| |
| Ethernet eth = context.inPacket().parsed(); |
| if (eth == null) { |
| return; |
| } |
| MacAddress srcMac = eth.getSourceMAC(); |
| |
| VlanId vlan = VlanId.vlanId(eth.getVlanID()); |
| ConnectPoint heardOn = context.inPacket().receivedFrom(); |
| |
| // If this arrived on control port, bail out. |
| if (heardOn.port().isLogical()) { |
| return; |
| } |
| |
| // If this is not an edge port, bail out. |
| Topology topology = topologyService.currentTopology(); |
| if (topologyService.isInfrastructure(topology, heardOn)) { |
| return; |
| } |
| |
| HostLocation hloc = |
| new HostLocation(heardOn, System.currentTimeMillis()); |
| |
| HostId hid = HostId.hostId(eth.getSourceMAC(), vlan); |
| |
| // ARP: possible new hosts, update both location and IP |
| if (eth.getEtherType() == Ethernet.TYPE_ARP) { |
| ARP arp = (ARP) eth.getPayload(); |
| IpAddress ip = IpAddress.valueOf(IpAddress.Version.INET, |
| arp.getSenderProtocolAddress()); |
| updateLocationIP(hid, srcMac, vlan, hloc, ip); |
| |
| // IPv4: update location only |
| } else if (eth.getEtherType() == Ethernet.TYPE_IPV4) { |
| updateLocation(hid, srcMac, vlan, hloc); |
| |
| // |
| // NeighborAdvertisement and NeighborSolicitation: possible |
| // new hosts, update both location and IP. |
| // |
| // IPv6: update location only |
| } else if (eth.getEtherType() == Ethernet.TYPE_IPV6) { |
| IPv6 ipv6 = (IPv6) eth.getPayload(); |
| IpAddress ip = IpAddress.valueOf(IpAddress.Version.INET6, |
| ipv6.getSourceAddress()); |
| |
| // skip extension headers |
| IPacket pkt = ipv6; |
| while (pkt.getPayload() != null && |
| pkt.getPayload() instanceof IExtensionHeader) { |
| pkt = pkt.getPayload(); |
| } |
| |
| // Neighbor Discovery Protocol |
| pkt = pkt.getPayload(); |
| if (pkt != null && pkt instanceof ICMP6) { |
| pkt = pkt.getPayload(); |
| // RouterSolicitation, RouterAdvertisement |
| if (pkt != null && (pkt instanceof RouterAdvertisement || |
| pkt instanceof RouterSolicitation)) { |
| return; |
| } |
| if (pkt != null && (pkt instanceof NeighborSolicitation || |
| pkt instanceof NeighborAdvertisement)) { |
| // Duplicate Address Detection |
| if (ip.isZero()) { |
| return; |
| } |
| // NeighborSolicitation, NeighborAdvertisement |
| updateLocationIP(hid, srcMac, vlan, hloc, ip); |
| return; |
| } |
| } |
| |
| // multicast |
| if (eth.isMulticast()) { |
| return; |
| } |
| |
| // normal IPv6 packets |
| updateLocation(hid, srcMac, vlan, hloc); |
| } |
| } |
| } |
| |
| // Auxiliary listener to device events. |
| private class InternalDeviceListener implements DeviceListener { |
| @Override |
| public void event(DeviceEvent event) { |
| Device device = event.subject(); |
| switch (event.type()) { |
| case DEVICE_ADDED: |
| break; |
| case DEVICE_AVAILABILITY_CHANGED: |
| if (hostRemovalEnabled && |
| !deviceService.isAvailable(device.id())) { |
| removeHosts(hostService.getConnectedHosts(device.id())); |
| } |
| break; |
| case DEVICE_SUSPENDED: |
| case DEVICE_UPDATED: |
| // Nothing to do? |
| break; |
| case DEVICE_REMOVED: |
| if (hostRemovalEnabled) { |
| removeHosts(hostService.getConnectedHosts(device.id())); |
| } |
| break; |
| case PORT_ADDED: |
| break; |
| case PORT_UPDATED: |
| if (hostRemovalEnabled) { |
| ConnectPoint point = |
| new ConnectPoint(device.id(), event.port().number()); |
| removeHosts(hostService.getConnectedHosts(point)); |
| } |
| break; |
| case PORT_REMOVED: |
| // Nothing to do? |
| break; |
| default: |
| break; |
| } |
| } |
| } |
| |
| // Signals host vanish for all specified hosts. |
| private void removeHosts(Set<Host> hosts) { |
| for (Host host : hosts) { |
| providerService.hostVanished(host.id()); |
| } |
| } |
| |
| } |