Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2014 Open Networking Laboratory |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 16 | package org.onosproject.net.host.impl; |
Jonathan Hart | fca736c | 2014-09-19 17:26:59 -0700 | [diff] [blame] | 17 | |
Jonathan Hart | fca736c | 2014-09-19 17:26:59 -0700 | [diff] [blame] | 18 | import org.jboss.netty.util.Timeout; |
| 19 | import org.jboss.netty.util.TimerTask; |
Jonathan Hart | 6cd2f35 | 2015-01-13 17:44:45 -0800 | [diff] [blame^] | 20 | import org.onlab.packet.ARP; |
| 21 | import org.onlab.packet.Ethernet; |
| 22 | import org.onlab.packet.IpAddress; |
| 23 | import org.onlab.packet.MacAddress; |
| 24 | import org.onlab.packet.VlanId; |
| 25 | import org.onlab.util.Timer; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 26 | import org.onosproject.net.ConnectPoint; |
| 27 | import org.onosproject.net.Device; |
| 28 | import org.onosproject.net.DeviceId; |
| 29 | import org.onosproject.net.Host; |
| 30 | import org.onosproject.net.Port; |
| 31 | import org.onosproject.net.device.DeviceService; |
| 32 | import org.onosproject.net.flow.DefaultTrafficTreatment; |
| 33 | import org.onosproject.net.flow.TrafficTreatment; |
| 34 | import org.onosproject.net.flow.instructions.Instruction; |
| 35 | import org.onosproject.net.flow.instructions.Instructions; |
| 36 | import org.onosproject.net.host.HostProvider; |
| 37 | import org.onosproject.net.host.InterfaceIpAddress; |
| 38 | import org.onosproject.net.host.PortAddresses; |
| 39 | import org.onosproject.net.packet.DefaultOutboundPacket; |
| 40 | import org.onosproject.net.packet.OutboundPacket; |
| 41 | import org.onosproject.net.packet.PacketService; |
| 42 | import org.onosproject.net.provider.ProviderId; |
Jonathan Hart | 6cd2f35 | 2015-01-13 17:44:45 -0800 | [diff] [blame^] | 43 | |
| 44 | import java.nio.ByteBuffer; |
| 45 | import java.util.ArrayList; |
| 46 | import java.util.Collections; |
| 47 | import java.util.List; |
| 48 | import java.util.Set; |
| 49 | import java.util.concurrent.ConcurrentHashMap; |
| 50 | import java.util.concurrent.ConcurrentMap; |
| 51 | import java.util.concurrent.TimeUnit; |
Jonathan Hart | fca736c | 2014-09-19 17:26:59 -0700 | [diff] [blame] | 52 | |
Jonathan Hart | 87fbbad | 2014-09-23 08:43:50 -0700 | [diff] [blame] | 53 | /** |
| 54 | * Monitors hosts on the dataplane to detect changes in host data. |
Thomas Vachuska | 4b42077 | 2014-10-30 16:46:17 -0700 | [diff] [blame] | 55 | * <p> |
Jonathan Hart | 87fbbad | 2014-09-23 08:43:50 -0700 | [diff] [blame] | 56 | * The HostMonitor can monitor hosts that have already been detected for |
| 57 | * changes. At an application's request, it can also monitor and actively |
| 58 | * probe for hosts that have not yet been detected (specified by IP address). |
Thomas Vachuska | 4b42077 | 2014-10-30 16:46:17 -0700 | [diff] [blame] | 59 | * </p> |
Jonathan Hart | 87fbbad | 2014-09-23 08:43:50 -0700 | [diff] [blame] | 60 | */ |
tom | 202175a | 2014-09-19 19:00:11 -0700 | [diff] [blame] | 61 | public class HostMonitor implements TimerTask { |
Jonathan Hart | 70da512 | 2014-10-01 16:37:42 -0700 | [diff] [blame] | 62 | private DeviceService deviceService; |
| 63 | private PacketService packetService; |
| 64 | private HostManager hostManager; |
Jonathan Hart | fca736c | 2014-09-19 17:26:59 -0700 | [diff] [blame] | 65 | |
Jonathan Hart | 87fbbad | 2014-09-23 08:43:50 -0700 | [diff] [blame] | 66 | private final Set<IpAddress> monitoredAddresses; |
Jonathan Hart | fca736c | 2014-09-19 17:26:59 -0700 | [diff] [blame] | 67 | |
Jonathan Hart | 34ed2fd | 2014-10-02 19:08:55 -0700 | [diff] [blame] | 68 | private final ConcurrentMap<ProviderId, HostProvider> hostProviders; |
Jonathan Hart | 70da512 | 2014-10-01 16:37:42 -0700 | [diff] [blame] | 69 | |
Jonathan Hart | 34ed2fd | 2014-10-02 19:08:55 -0700 | [diff] [blame] | 70 | private static final long DEFAULT_PROBE_RATE = 30000; // milliseconds |
Yuta HIGUCHI | 3e848a8 | 2014-11-02 20:19:42 -0800 | [diff] [blame] | 71 | private static final byte[] ZERO_MAC_ADDRESS = MacAddress.ZERO.toBytes(); |
Jonathan Hart | 34ed2fd | 2014-10-02 19:08:55 -0700 | [diff] [blame] | 72 | private long probeRate = DEFAULT_PROBE_RATE; |
Jonathan Hart | fca736c | 2014-09-19 17:26:59 -0700 | [diff] [blame] | 73 | |
Jonathan Hart | 8f6f1ea | 2014-10-03 16:05:19 -0700 | [diff] [blame] | 74 | private Timeout timeout; |
Jonathan Hart | fca736c | 2014-09-19 17:26:59 -0700 | [diff] [blame] | 75 | |
Jonathan Hart | 8f6f1ea | 2014-10-03 16:05:19 -0700 | [diff] [blame] | 76 | /** |
| 77 | * Creates a new host monitor. |
| 78 | * |
| 79 | * @param deviceService device service used to find edge ports |
| 80 | * @param packetService packet service used to send packets on the data plane |
Jonathan Hart | b4758a9 | 2014-09-24 10:46:45 -0700 | [diff] [blame] | 81 | * @param hostManager host manager used to look up host information and |
| 82 | * probe existing hosts |
Jonathan Hart | 8f6f1ea | 2014-10-03 16:05:19 -0700 | [diff] [blame] | 83 | */ |
Jonathan Hart | 34ed2fd | 2014-10-02 19:08:55 -0700 | [diff] [blame] | 84 | public HostMonitor(DeviceService deviceService, PacketService packetService, |
Jonathan Hart | b4758a9 | 2014-09-24 10:46:45 -0700 | [diff] [blame] | 85 | HostManager hostManager) { |
Jonathan Hart | 70da512 | 2014-10-01 16:37:42 -0700 | [diff] [blame] | 86 | |
Jonathan Hart | fca736c | 2014-09-19 17:26:59 -0700 | [diff] [blame] | 87 | this.deviceService = deviceService; |
Jonathan Hart | 87fbbad | 2014-09-23 08:43:50 -0700 | [diff] [blame] | 88 | this.packetService = packetService; |
Jonathan Hart | b4758a9 | 2014-09-24 10:46:45 -0700 | [diff] [blame] | 89 | this.hostManager = hostManager; |
Jonathan Hart | fca736c | 2014-09-19 17:26:59 -0700 | [diff] [blame] | 90 | |
Jonathan Hart | 8f6f1ea | 2014-10-03 16:05:19 -0700 | [diff] [blame] | 91 | monitoredAddresses = Collections.newSetFromMap( |
| 92 | new ConcurrentHashMap<IpAddress, Boolean>()); |
Jonathan Hart | 70da512 | 2014-10-01 16:37:42 -0700 | [diff] [blame] | 93 | hostProviders = new ConcurrentHashMap<>(); |
Jonathan Hart | 70da512 | 2014-10-01 16:37:42 -0700 | [diff] [blame] | 94 | } |
| 95 | |
Jonathan Hart | 8f6f1ea | 2014-10-03 16:05:19 -0700 | [diff] [blame] | 96 | /** |
| 97 | * Adds an IP address to be monitored by the host monitor. The monitor will |
| 98 | * periodically probe the host to detect changes. |
| 99 | * |
| 100 | * @param ip IP address of the host to monitor |
| 101 | */ |
Jonathan Hart | 70da512 | 2014-10-01 16:37:42 -0700 | [diff] [blame] | 102 | void addMonitoringFor(IpAddress ip) { |
Jonathan Hart | fca736c | 2014-09-19 17:26:59 -0700 | [diff] [blame] | 103 | monitoredAddresses.add(ip); |
| 104 | } |
| 105 | |
Jonathan Hart | 8f6f1ea | 2014-10-03 16:05:19 -0700 | [diff] [blame] | 106 | /** |
| 107 | * Stops monitoring the given IP address. |
| 108 | * |
| 109 | * @param ip IP address to stop monitoring on |
| 110 | */ |
Jonathan Hart | 70da512 | 2014-10-01 16:37:42 -0700 | [diff] [blame] | 111 | void stopMonitoring(IpAddress ip) { |
Jonathan Hart | fca736c | 2014-09-19 17:26:59 -0700 | [diff] [blame] | 112 | monitoredAddresses.remove(ip); |
| 113 | } |
| 114 | |
Jonathan Hart | 8f6f1ea | 2014-10-03 16:05:19 -0700 | [diff] [blame] | 115 | /** |
| 116 | * Starts the host monitor. Does nothing if the monitor is already running. |
| 117 | */ |
| 118 | void start() { |
| 119 | synchronized (this) { |
| 120 | if (timeout == null) { |
| 121 | timeout = Timer.getTimer().newTimeout(this, 0, TimeUnit.MILLISECONDS); |
| 122 | } |
| 123 | } |
Jonathan Hart | fca736c | 2014-09-19 17:26:59 -0700 | [diff] [blame] | 124 | } |
| 125 | |
Jonathan Hart | 8f6f1ea | 2014-10-03 16:05:19 -0700 | [diff] [blame] | 126 | /** |
| 127 | * Stops the host monitor. |
| 128 | */ |
| 129 | void shutdown() { |
| 130 | synchronized (this) { |
| 131 | timeout.cancel(); |
| 132 | timeout = null; |
| 133 | } |
| 134 | } |
| 135 | |
| 136 | /** |
| 137 | * Registers a host provider with the host monitor. The monitor can use the |
| 138 | * provider to probe hosts. |
| 139 | * |
| 140 | * @param provider the host provider to register |
| 141 | */ |
Jonathan Hart | 70da512 | 2014-10-01 16:37:42 -0700 | [diff] [blame] | 142 | void registerHostProvider(HostProvider provider) { |
| 143 | hostProviders.put(provider.id(), provider); |
| 144 | } |
| 145 | |
Jonathan Hart | fca736c | 2014-09-19 17:26:59 -0700 | [diff] [blame] | 146 | @Override |
| 147 | public void run(Timeout timeout) throws Exception { |
Jonathan Hart | 87fbbad | 2014-09-23 08:43:50 -0700 | [diff] [blame] | 148 | for (IpAddress ip : monitoredAddresses) { |
Pavlin Radoslavov | 33f228a | 2014-10-27 19:33:16 -0700 | [diff] [blame] | 149 | Set<Host> hosts = hostManager.getHostsByIp(ip); |
Jonathan Hart | fca736c | 2014-09-19 17:26:59 -0700 | [diff] [blame] | 150 | |
| 151 | if (hosts.isEmpty()) { |
| 152 | sendArpRequest(ip); |
| 153 | } else { |
| 154 | for (Host host : hosts) { |
Jonathan Hart | 70da512 | 2014-10-01 16:37:42 -0700 | [diff] [blame] | 155 | HostProvider provider = hostProviders.get(host.providerId()); |
Jonathan Hart | 34ed2fd | 2014-10-02 19:08:55 -0700 | [diff] [blame] | 156 | if (provider == null) { |
| 157 | hostProviders.remove(host.providerId(), null); |
| 158 | } else { |
Jonathan Hart | 70da512 | 2014-10-01 16:37:42 -0700 | [diff] [blame] | 159 | provider.triggerProbe(host); |
| 160 | } |
Jonathan Hart | fca736c | 2014-09-19 17:26:59 -0700 | [diff] [blame] | 161 | } |
| 162 | } |
| 163 | } |
| 164 | |
Jonathan Hart | 8f6f1ea | 2014-10-03 16:05:19 -0700 | [diff] [blame] | 165 | this.timeout = Timer.getTimer().newTimeout(this, probeRate, TimeUnit.MILLISECONDS); |
Jonathan Hart | fca736c | 2014-09-19 17:26:59 -0700 | [diff] [blame] | 166 | } |
| 167 | |
| 168 | /** |
| 169 | * Sends an ARP request for the given IP address. |
| 170 | * |
| 171 | * @param targetIp IP address to ARP for |
| 172 | */ |
Jonathan Hart | 87fbbad | 2014-09-23 08:43:50 -0700 | [diff] [blame] | 173 | private void sendArpRequest(IpAddress targetIp) { |
Jonathan Hart | 87fbbad | 2014-09-23 08:43:50 -0700 | [diff] [blame] | 174 | // Find ports with an IP address in the target's subnet and sent ARP |
| 175 | // probes out those ports. |
| 176 | for (Device device : deviceService.getDevices()) { |
Jonathan Hart | fca736c | 2014-09-19 17:26:59 -0700 | [diff] [blame] | 177 | for (Port port : deviceService.getPorts(device.id())) { |
Jonathan Hart | 87fbbad | 2014-09-23 08:43:50 -0700 | [diff] [blame] | 178 | ConnectPoint cp = new ConnectPoint(device.id(), port.number()); |
Jonathan Hart | a887ba8 | 2014-11-03 15:20:52 -0800 | [diff] [blame] | 179 | Set<PortAddresses> portAddressSet = |
Pavlin Radoslavov | 76b0ae2 | 2014-10-27 15:33:19 -0700 | [diff] [blame] | 180 | hostManager.getAddressBindingsForPort(cp); |
Jonathan Hart | 87fbbad | 2014-09-23 08:43:50 -0700 | [diff] [blame] | 181 | |
Jonathan Hart | a887ba8 | 2014-11-03 15:20:52 -0800 | [diff] [blame] | 182 | for (PortAddresses portAddresses : portAddressSet) { |
| 183 | for (InterfaceIpAddress ia : portAddresses.ipAddresses()) { |
| 184 | if (ia.subnetAddress().contains(targetIp)) { |
| 185 | sendProbe(device.id(), port, targetIp, |
Jonathan Hart | 6cd2f35 | 2015-01-13 17:44:45 -0800 | [diff] [blame^] | 186 | ia.ipAddress(), portAddresses.mac(), |
| 187 | portAddresses.vlan()); |
Jonathan Hart | a887ba8 | 2014-11-03 15:20:52 -0800 | [diff] [blame] | 188 | } |
Jonathan Hart | 09585c6 | 2014-09-23 16:58:04 -0700 | [diff] [blame] | 189 | } |
Jonathan Hart | 70da512 | 2014-10-01 16:37:42 -0700 | [diff] [blame] | 190 | } |
Jonathan Hart | fca736c | 2014-09-19 17:26:59 -0700 | [diff] [blame] | 191 | } |
Jonathan Hart | 87fbbad | 2014-09-23 08:43:50 -0700 | [diff] [blame] | 192 | } |
Jonathan Hart | fca736c | 2014-09-19 17:26:59 -0700 | [diff] [blame] | 193 | } |
| 194 | |
Jonathan Hart | 70da512 | 2014-10-01 16:37:42 -0700 | [diff] [blame] | 195 | private void sendProbe(DeviceId deviceId, Port port, IpAddress targetIp, |
Jonathan Hart | 6cd2f35 | 2015-01-13 17:44:45 -0800 | [diff] [blame^] | 196 | IpAddress sourceIp, MacAddress sourceMac, VlanId vlan) { |
| 197 | Ethernet arpPacket = buildArpRequest(targetIp, sourceIp, sourceMac, vlan); |
Jonathan Hart | fca736c | 2014-09-19 17:26:59 -0700 | [diff] [blame] | 198 | |
Jonathan Hart | 87fbbad | 2014-09-23 08:43:50 -0700 | [diff] [blame] | 199 | List<Instruction> instructions = new ArrayList<>(); |
| 200 | instructions.add(Instructions.createOutput(port.number())); |
| 201 | |
tom | 9a693fd | 2014-10-03 11:32:19 -0700 | [diff] [blame] | 202 | TrafficTreatment treatment = DefaultTrafficTreatment.builder() |
alshabib | 010c31d | 2014-09-26 10:01:12 -0700 | [diff] [blame] | 203 | .setOutput(port.number()) |
| 204 | .build(); |
Jonathan Hart | 87fbbad | 2014-09-23 08:43:50 -0700 | [diff] [blame] | 205 | |
| 206 | OutboundPacket outboundPacket = |
| 207 | new DefaultOutboundPacket(deviceId, treatment, |
| 208 | ByteBuffer.wrap(arpPacket.serialize())); |
| 209 | |
| 210 | packetService.emit(outboundPacket); |
| 211 | } |
| 212 | |
Jonathan Hart | 70da512 | 2014-10-01 16:37:42 -0700 | [diff] [blame] | 213 | private Ethernet buildArpRequest(IpAddress targetIp, IpAddress sourceIp, |
Jonathan Hart | 6cd2f35 | 2015-01-13 17:44:45 -0800 | [diff] [blame^] | 214 | MacAddress sourceMac, VlanId vlan) { |
Jonathan Hart | 87fbbad | 2014-09-23 08:43:50 -0700 | [diff] [blame] | 215 | |
| 216 | ARP arp = new ARP(); |
| 217 | arp.setHardwareType(ARP.HW_TYPE_ETHERNET) |
Jonathan Hart | 70da512 | 2014-10-01 16:37:42 -0700 | [diff] [blame] | 218 | .setHardwareAddressLength((byte) Ethernet.DATALAYER_ADDRESS_LENGTH) |
| 219 | .setProtocolType(ARP.PROTO_TYPE_IP) |
Pavlin Radoslavov | 52307e6 | 2014-10-29 15:07:37 -0700 | [diff] [blame] | 220 | .setProtocolAddressLength((byte) IpAddress.INET_BYTE_LENGTH) |
Jonathan Hart | 70da512 | 2014-10-01 16:37:42 -0700 | [diff] [blame] | 221 | .setOpCode(ARP.OP_REQUEST); |
Jonathan Hart | 87fbbad | 2014-09-23 08:43:50 -0700 | [diff] [blame] | 222 | |
Yuta HIGUCHI | 3e848a8 | 2014-11-02 20:19:42 -0800 | [diff] [blame] | 223 | arp.setSenderHardwareAddress(sourceMac.toBytes()) |
Jonathan Hart | 70da512 | 2014-10-01 16:37:42 -0700 | [diff] [blame] | 224 | .setSenderProtocolAddress(sourceIp.toOctets()) |
Yuta HIGUCHI | 3e848a8 | 2014-11-02 20:19:42 -0800 | [diff] [blame] | 225 | .setTargetHardwareAddress(ZERO_MAC_ADDRESS) |
Jonathan Hart | 70da512 | 2014-10-01 16:37:42 -0700 | [diff] [blame] | 226 | .setTargetProtocolAddress(targetIp.toOctets()); |
Jonathan Hart | 87fbbad | 2014-09-23 08:43:50 -0700 | [diff] [blame] | 227 | |
| 228 | Ethernet ethernet = new Ethernet(); |
| 229 | ethernet.setEtherType(Ethernet.TYPE_ARP) |
Yuta HIGUCHI | 3e848a8 | 2014-11-02 20:19:42 -0800 | [diff] [blame] | 230 | .setDestinationMACAddress(MacAddress.BROADCAST) |
| 231 | .setSourceMACAddress(sourceMac) |
Jonathan Hart | 70da512 | 2014-10-01 16:37:42 -0700 | [diff] [blame] | 232 | .setPayload(arp); |
Jonathan Hart | 87fbbad | 2014-09-23 08:43:50 -0700 | [diff] [blame] | 233 | |
Jonathan Hart | 6cd2f35 | 2015-01-13 17:44:45 -0800 | [diff] [blame^] | 234 | if (!vlan.equals(VlanId.NONE)) { |
| 235 | ethernet.setVlanID(vlan.toShort()); |
| 236 | } |
| 237 | |
Jonathan Hart | 87fbbad | 2014-09-23 08:43:50 -0700 | [diff] [blame] | 238 | return ethernet; |
Jonathan Hart | fca736c | 2014-09-19 17:26:59 -0700 | [diff] [blame] | 239 | } |
| 240 | } |