| /* |
| * Copyright 2014 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.onlab.onos.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.onos.net.ConnectPoint; |
| import org.onlab.onos.net.DeviceId; |
| import org.onlab.onos.net.Host; |
| import org.onlab.onos.net.HostId; |
| import org.onlab.onos.net.HostLocation; |
| import org.onlab.onos.net.device.DeviceEvent; |
| import org.onlab.onos.net.device.DeviceListener; |
| import org.onlab.onos.net.device.DeviceService; |
| import org.onlab.onos.net.host.DefaultHostDescription; |
| import org.onlab.onos.net.host.HostDescription; |
| import org.onlab.onos.net.host.HostProvider; |
| import org.onlab.onos.net.host.HostProviderRegistry; |
| import org.onlab.onos.net.host.HostProviderService; |
| import org.onlab.onos.net.host.HostService; |
| import org.onlab.onos.net.packet.PacketContext; |
| import org.onlab.onos.net.packet.PacketProcessor; |
| import org.onlab.onos.net.packet.PacketService; |
| import org.onlab.onos.net.provider.AbstractProvider; |
| import org.onlab.onos.net.provider.ProviderId; |
| import org.onlab.onos.net.topology.Topology; |
| import org.onlab.onos.net.topology.TopologyService; |
| import org.onlab.packet.ARP; |
| import org.onlab.packet.Ethernet; |
| import org.onlab.packet.IpAddress; |
| import org.onlab.packet.VlanId; |
| import org.osgi.service.component.ComponentContext; |
| import org.slf4j.Logger; |
| |
| import java.util.Dictionary; |
| import java.util.Set; |
| |
| 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 HostProviderRegistry providerRegistry; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| protected PacketService pktService; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| protected TopologyService topologyService; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| protected HostService hostService; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| protected DeviceService deviceService; |
| |
| private HostProviderService providerService; |
| |
| private final InternalHostProvider processor = new InternalHostProvider(); |
| private final DeviceListener deviceListener = new InternalDeviceListener(); |
| |
| @Property(name = "hostRemovalEnabled", boolValue = true, |
| label = "Enable host removal on port/device down events") |
| private boolean hostRemovalEnabled = true; |
| |
| |
| /** |
| * Creates an OpenFlow host provider. |
| */ |
| public HostLocationProvider() { |
| super(new ProviderId("of", "org.onlab.onos.provider.host")); |
| } |
| |
| @Activate |
| public void activate(ComponentContext context) { |
| modified(context); |
| providerService = providerRegistry.register(this); |
| pktService.addProcessor(processor, 1); |
| deviceService.addListener(deviceListener); |
| log.info("Started"); |
| } |
| |
| @Deactivate |
| public void deactivate() { |
| providerRegistry.unregister(this); |
| pktService.removeProcessor(processor); |
| deviceService.removeListener(deviceListener); |
| providerService = null; |
| log.info("Stopped"); |
| } |
| |
| @Modified |
| public void modified(ComponentContext context) { |
| Dictionary properties = context.getProperties(); |
| try { |
| String flag = (String) properties.get("hostRemovalEnabled"); |
| if (flag != null) { |
| hostRemovalEnabled = flag.equals("true"); |
| } |
| } catch (Exception e) { |
| hostRemovalEnabled = true; |
| } |
| log.info("Host removal is {}", hostRemovalEnabled ? "enabled" : "disabled"); |
| } |
| |
| @Override |
| public void triggerProbe(Host host) { |
| log.info("Triggering probe on device {}", host); |
| } |
| |
| private class InternalHostProvider implements PacketProcessor { |
| |
| @Override |
| public void process(PacketContext context) { |
| if (context == null) { |
| return; |
| } |
| Ethernet eth = context.inPacket().parsed(); |
| |
| VlanId vlan = VlanId.vlanId(eth.getVlanID()); |
| ConnectPoint heardOn = context.inPacket().receivedFrom(); |
| |
| // 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); |
| |
| // Potentially a new or moved host |
| if (eth.getEtherType() == Ethernet.TYPE_ARP) { |
| ARP arp = (ARP) eth.getPayload(); |
| IpAddress ip = |
| IpAddress.valueOf(IpAddress.Version.INET, |
| arp.getSenderProtocolAddress()); |
| HostDescription hdescr = |
| new DefaultHostDescription(eth.getSourceMAC(), vlan, hloc, ip); |
| providerService.hostDetected(hid, hdescr); |
| |
| } else if (eth.getEtherType() == Ethernet.TYPE_IPV4) { |
| //Do not learn new ip from ip packet. |
| HostDescription hdescr = |
| new DefaultHostDescription(eth.getSourceMAC(), vlan, hloc); |
| providerService.hostDetected(hid, hdescr); |
| |
| } |
| } |
| } |
| |
| // Auxiliary listener to device events. |
| private class InternalDeviceListener implements DeviceListener { |
| @Override |
| public void event(DeviceEvent event) { |
| if (!hostRemovalEnabled) { |
| return; |
| } |
| |
| DeviceEvent.Type type = event.type(); |
| DeviceId deviceId = event.subject().id(); |
| if (type == DeviceEvent.Type.PORT_UPDATED) { |
| ConnectPoint point = new ConnectPoint(deviceId, event.port().number()); |
| removeHosts(hostService.getConnectedHosts(point)); |
| |
| } else if (type == DeviceEvent.Type.DEVICE_AVAILABILITY_CHANGED) { |
| if (!deviceService.isAvailable(deviceId)) { |
| removeHosts(hostService.getConnectedHosts(deviceId)); |
| } |
| |
| } else if (type == DeviceEvent.Type.DEVICE_REMOVED) { |
| removeHosts(hostService.getConnectedHosts(deviceId)); |
| } |
| } |
| } |
| |
| // Signals host vanish for all specified hosts. |
| private void removeHosts(Set<Host> hosts) { |
| for (Host host : hosts) { |
| providerService.hostVanished(host.id()); |
| } |
| } |
| |
| } |