2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
9 package org.opendaylight.controller.hosttracker.internal;
11 import java.net.InetAddress;
12 import java.net.UnknownHostException;
13 import java.util.ArrayList;
14 import java.util.Collections;
15 import java.util.Dictionary;
16 import java.util.EnumSet;
17 import java.util.HashSet;
18 import java.util.List;
20 import java.util.Map.Entry;
22 import java.util.Timer;
23 import java.util.TimerTask;
24 import java.util.concurrent.Callable;
25 import java.util.concurrent.ConcurrentHashMap;
26 import java.util.concurrent.ConcurrentMap;
27 import java.util.concurrent.ExecutorService;
28 import java.util.concurrent.Executors;
29 import java.util.concurrent.Future;
31 import org.apache.felix.dm.Component;
32 import org.eclipse.osgi.framework.console.CommandInterpreter;
33 import org.eclipse.osgi.framework.console.CommandProvider;
34 import org.opendaylight.controller.clustering.services.CacheConfigException;
35 import org.opendaylight.controller.clustering.services.CacheExistException;
36 import org.opendaylight.controller.clustering.services.ICacheUpdateAware;
37 import org.opendaylight.controller.clustering.services.IClusterContainerServices;
38 import org.opendaylight.controller.clustering.services.IClusterServices;
39 import org.opendaylight.controller.hosttracker.IfHostListener;
40 import org.opendaylight.controller.hosttracker.IfIptoHost;
41 import org.opendaylight.controller.hosttracker.IfNewHostNotify;
42 import org.opendaylight.controller.hosttracker.hostAware.HostNodeConnector;
43 import org.opendaylight.controller.hosttracker.hostAware.IHostFinder;
44 import org.opendaylight.controller.sal.core.ConstructionException;
45 import org.opendaylight.controller.sal.core.Edge;
46 import org.opendaylight.controller.sal.core.Host;
47 import org.opendaylight.controller.sal.core.Node;
48 import org.opendaylight.controller.sal.core.NodeConnector;
49 import org.opendaylight.controller.sal.core.Property;
50 import org.opendaylight.controller.sal.core.State;
51 import org.opendaylight.controller.sal.core.Tier;
52 import org.opendaylight.controller.sal.core.UpdateType;
53 import org.opendaylight.controller.sal.packet.address.DataLinkAddress;
54 import org.opendaylight.controller.sal.packet.address.EthernetAddress;
55 import org.opendaylight.controller.sal.topology.TopoEdgeUpdate;
56 import org.opendaylight.controller.sal.utils.GlobalConstants;
57 import org.opendaylight.controller.sal.utils.HexEncode;
58 import org.opendaylight.controller.sal.utils.NetUtils;
59 import org.opendaylight.controller.sal.utils.NodeCreator;
60 import org.opendaylight.controller.sal.utils.Status;
61 import org.opendaylight.controller.sal.utils.StatusCode;
62 import org.opendaylight.controller.switchmanager.IInventoryListener;
63 import org.opendaylight.controller.switchmanager.ISwitchManager;
64 import org.opendaylight.controller.switchmanager.ISwitchManagerAware;
65 import org.opendaylight.controller.switchmanager.Subnet;
66 import org.opendaylight.controller.topologymanager.ITopologyManager;
67 import org.opendaylight.controller.topologymanager.ITopologyManagerAware;
68 import org.osgi.framework.BundleContext;
69 import org.osgi.framework.FrameworkUtil;
70 import org.slf4j.Logger;
71 import org.slf4j.LoggerFactory;
74 * @file HostTracker.java This class tracks the location of IP Hosts as to which
75 * Switch, Port, VLAN, they are connected to, as well as their MAC
76 * address. This is done dynamically as well as statically. The dynamic
77 * mechanism consists of listening to ARP messages as well sending ARP
78 * requests. Static mechanism consists of Northbound APIs to add or remove
79 * the hosts from the local database. ARP aging is also implemented to age
80 * out dynamically learned hosts. Interface methods are provided for other
81 * applications to 1. Query the local database for a single host 2. Get a
82 * list of all hosts 3. Get notification if a host is learned/added or
83 * removed the database
86 public class HostTracker implements IfIptoHost, IfHostListener, ISwitchManagerAware, IInventoryListener,
87 ITopologyManagerAware, ICacheUpdateAware<InetAddress, HostNodeConnector>, CommandProvider {
88 static final String ACTIVE_HOST_CACHE = "hosttracker.ActiveHosts";
89 static final String INACTIVE_HOST_CACHE = "hosttracker.InactiveHosts";
90 private static final Logger logger = LoggerFactory.getLogger(HostTracker.class);
91 protected IHostFinder hostFinder;
92 protected ConcurrentMap<InetAddress, HostNodeConnector> hostsDB;
94 * Following is a list of hosts which have been requested by NB APIs to be
95 * added, but either the switch or the port is not sup, so they will be
96 * added here until both come up
98 private ConcurrentMap<NodeConnector, HostNodeConnector> inactiveStaticHosts;
99 private final Set<IfNewHostNotify> newHostNotify = Collections.synchronizedSet(new HashSet<IfNewHostNotify>());
101 private ITopologyManager topologyManager;
102 protected IClusterContainerServices clusterContainerService = null;
103 protected ISwitchManager switchManager = null;
105 private Timer arpRefreshTimer;
106 private String containerName = null;
107 private ExecutorService executor;
108 protected boolean stopping;
109 private static class ARPPending {
110 protected InetAddress hostIP;
111 protected short sent_count;
112 protected HostTrackerCallable hostTrackerCallable;
114 public InetAddress getHostIP() {
118 public short getSent_count() {
122 public HostTrackerCallable getHostTrackerCallable() {
123 return hostTrackerCallable;
126 public void setHostIP(InetAddress networkAddr) {
127 this.hostIP = networkAddr;
130 public void setSent_count(short count) {
131 this.sent_count = count;
134 public void setHostTrackerCallable(HostTrackerCallable callable) {
135 hostTrackerCallable = callable;
139 // This list contains the hosts for which ARP requests are being sent
141 ConcurrentMap<InetAddress, ARPPending> ARPPendingList;
143 * This list below contains the hosts which were initially in ARPPendingList
144 * above, but ARP response didn't come from there hosts after multiple
145 * attempts over 8 seconds. The assumption is that the response didn't come
146 * back due to one of the following possibilities: 1. The L3 interface
147 * wasn't created for this host in the controller. This would cause
148 * arphandler not to know where to send the ARP 2. The host facing port is
149 * down 3. The IP host doesn't exist or is not responding to ARP requests
151 * Conditions 1 and 2 above can be recovered if ARP is sent when the
152 * relevant L3 interface is added or the port facing host comes up. Whenever
153 * L3 interface is added or host facing port comes up, ARP will be sent to
154 * hosts in this list.
156 * We can't recover from condition 3 above
158 ConcurrentMap<InetAddress, ARPPending> failedARPReqList;
160 public HostTracker() {
163 private void startUp() {
164 nonClusterObjectCreate();
170 timer.schedule(new OutStandingARPHandler(), 4000, 4000);
171 executor = Executors.newFixedThreadPool(2);
172 /* ARP Refresh Timer to go off every 5 seconds to implement ARP aging */
173 arpRefreshTimer = new Timer();
174 arpRefreshTimer.schedule(new ARPRefreshHandler(), 5000, 5000);
175 logger.debug("startUp: Caches created, timers started");
178 private void allocateCache() {
179 if (this.clusterContainerService == null) {
180 logger.error("un-initialized clusterContainerService, can't create cache");
183 logger.debug("Creating Cache for HostTracker");
185 this.clusterContainerService.createCache(ACTIVE_HOST_CACHE,
186 EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
187 this.clusterContainerService.createCache(INACTIVE_HOST_CACHE,
188 EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
189 } catch (CacheConfigException cce) {
190 logger.error("Cache couldn't be created for HostTracker - check cache mode");
191 } catch (CacheExistException cce) {
192 logger.error("Cache for HostTracker already exists, destroy and recreate");
194 logger.debug("Cache successfully created for HostTracker");
197 @SuppressWarnings({ "unchecked" })
198 private void retrieveCache() {
199 if (this.clusterContainerService == null) {
200 logger.error("un-initialized clusterContainerService, can't retrieve cache");
203 logger.debug("Retrieving cache for HostTrackerAH");
204 hostsDB = (ConcurrentMap<InetAddress, HostNodeConnector>) this.clusterContainerService
205 .getCache(ACTIVE_HOST_CACHE);
206 if (hostsDB == null) {
207 logger.error("Cache couldn't be retrieved for HostTracker");
209 logger.debug("Cache was successfully retrieved for HostTracker");
210 logger.debug("Retrieving cache for HostTrackerIH");
211 inactiveStaticHosts = (ConcurrentMap<NodeConnector, HostNodeConnector>) this.clusterContainerService
212 .getCache(INACTIVE_HOST_CACHE);
213 if (inactiveStaticHosts == null) {
214 logger.error("Cache couldn't be retrieved for HostTrackerIH");
216 logger.debug("Cache was successfully retrieved for HostTrackerIH");
219 public void nonClusterObjectCreate() {
220 hostsDB = new ConcurrentHashMap<InetAddress, HostNodeConnector>();
221 inactiveStaticHosts = new ConcurrentHashMap<NodeConnector, HostNodeConnector>();
222 ARPPendingList = new ConcurrentHashMap<InetAddress, ARPPending>();
223 failedARPReqList = new ConcurrentHashMap<InetAddress, ARPPending>();
226 public void shutDown() {
229 public void setnewHostNotify(IfNewHostNotify obj) {
230 this.newHostNotify.add(obj);
233 public void unsetnewHostNotify(IfNewHostNotify obj) {
234 this.newHostNotify.remove(obj);
237 public void setArpHandler(IHostFinder hostFinder) {
238 this.hostFinder = hostFinder;
241 public void unsetArpHandler(IHostFinder hostFinder) {
242 if (this.hostFinder == hostFinder) {
243 logger.debug("Arp Handler Service removed!");
244 this.hostFinder = null;
248 public void setTopologyManager(ITopologyManager s) {
249 this.topologyManager = s;
252 public void unsetTopologyManager(ITopologyManager s) {
253 if (this.topologyManager == s) {
254 logger.debug("Topology Manager Service removed!");
255 this.topologyManager = null;
259 private boolean hostExists(HostNodeConnector host) {
260 HostNodeConnector lhost = hostsDB.get(host.getNetworkAddress());
261 return host.equals(lhost);
264 private HostNodeConnector getHostFromOnActiveDB(InetAddress networkAddress) {
265 return hostsDB.get(networkAddress);
268 private Entry<NodeConnector, HostNodeConnector> getHostFromInactiveDB(InetAddress networkAddress) {
269 for (Entry<NodeConnector, HostNodeConnector> entry : inactiveStaticHosts.entrySet()) {
270 if (entry.getValue().equalsByIP(networkAddress)) {
271 logger.debug("getHostFromInactiveDB(): Inactive Host found for IP:{} ", networkAddress.getHostAddress());
275 logger.debug("getHostFromInactiveDB() Inactive Host Not found for IP: {}", networkAddress.getHostAddress());
279 private void removeHostFromInactiveDB(InetAddress networkAddress) {
280 NodeConnector nodeConnector = null;
281 for (Entry<NodeConnector, HostNodeConnector> entry : inactiveStaticHosts.entrySet()) {
282 if (entry.getValue().equalsByIP(networkAddress)) {
283 nodeConnector = entry.getKey();
287 if (nodeConnector != null) {
288 inactiveStaticHosts.remove(nodeConnector);
289 logger.debug("removeHostFromInactiveDB(): Host Removed for IP: {}", networkAddress.getHostAddress());
292 logger.debug("removeHostFromInactiveDB(): Host Not found for IP: {}", networkAddress.getHostAddress());
295 protected boolean hostMoved(HostNodeConnector host) {
296 if (hostQuery(host.getNetworkAddress()) != null) {
303 public HostNodeConnector hostQuery(InetAddress networkAddress) {
304 return hostsDB.get(networkAddress);
308 public Future<HostNodeConnector> discoverHost(InetAddress networkAddress) {
309 if (executor == null) {
310 logger.error("discoverHost: Null executor");
313 Callable<HostNodeConnector> worker = new HostTrackerCallable(this, networkAddress);
314 Future<HostNodeConnector> submit = executor.submit(worker);
319 public HostNodeConnector hostFind(InetAddress networkAddress) {
321 * Sometimes at boot with containers configured in the startup we hit
322 * this path (from TIF) when hostFinder has not been set yet Caller
323 * already handles the null return
326 if (hostFinder == null) {
327 logger.debug("Exiting hostFind, null hostFinder");
331 HostNodeConnector host = hostQuery(networkAddress);
333 logger.debug("hostFind(): Host found for IP: {}", networkAddress.getHostAddress());
337 /* Add this host to ARPPending List for any potential retries */
339 addToARPPendingList(networkAddress);
340 logger.debug("hostFind(): Host Not Found for IP: {}, Inititated Host Discovery ...",
341 networkAddress.getHostAddress());
343 /* host is not found, initiate a discovery */
345 hostFinder.find(networkAddress);
350 public Set<HostNodeConnector> getAllHosts() {
351 Set<HostNodeConnector> allHosts = new HashSet<HostNodeConnector>();
352 for (Entry<InetAddress, HostNodeConnector> entry : hostsDB.entrySet()) {
353 HostNodeConnector host = entry.getValue();
356 logger.debug("Exiting getAllHosts, Found {} Hosts", allHosts.size());
361 public Set<HostNodeConnector> getActiveStaticHosts() {
362 Set<HostNodeConnector> list = new HashSet<HostNodeConnector>();
363 for (Entry<InetAddress, HostNodeConnector> entry : hostsDB.entrySet()) {
364 HostNodeConnector host = entry.getValue();
365 if (host.isStaticHost()) {
369 logger.debug("getActiveStaticHosts(): Found {} Hosts", list.size());
374 public Set<HostNodeConnector> getInactiveStaticHosts() {
375 Set<HostNodeConnector> list = new HashSet<HostNodeConnector>();
376 for (Entry<NodeConnector, HostNodeConnector> entry : inactiveStaticHosts.entrySet()) {
377 list.add(entry.getValue());
379 logger.debug("getInactiveStaticHosts(): Found {} Hosts", list.size());
383 private void addToARPPendingList(InetAddress networkAddr) {
384 ARPPending arphost = new ARPPending();
386 arphost.setHostIP(networkAddr);
387 arphost.setSent_count((short) 1);
388 ARPPendingList.put(networkAddr, arphost);
389 logger.debug("Host Added to ARPPending List, IP: {}", networkAddr);
392 public void setCallableOnPendingARP(InetAddress networkAddr, HostTrackerCallable callable) {
394 for (Entry<InetAddress, ARPPending> entry : ARPPendingList.entrySet()) {
395 arphost = entry.getValue();
396 if (arphost.getHostIP().equals(networkAddr)) {
397 arphost.setHostTrackerCallable(callable);
402 private void processPendingARPReqs(InetAddress networkAddr) {
405 if ((arphost = ARPPendingList.remove(networkAddr)) != null) {
406 // Remove the arphost from ARPPendingList as it has been learned now
407 logger.debug("Host Removed from ARPPending List, IP: {}", networkAddr);
408 HostTrackerCallable htCallable = arphost.getHostTrackerCallable();
409 if (htCallable != null) {
416 * It could have been a host from the FailedARPReqList
419 if (failedARPReqList.containsKey(networkAddr)) {
420 failedARPReqList.remove(networkAddr);
421 logger.debug("Host Removed from FailedARPReqList List, IP: {}", networkAddr);
426 private void learnNewHost(HostNodeConnector host) {
427 host.initArpSendCountDown();
428 HostNodeConnector rHost = hostsDB.putIfAbsent(host.getNetworkAddress(), host);
430 // Another host is already learned for this IP address, replace it
431 replaceHost(host.getNetworkAddress(), rHost, host);
433 logger.debug("New Host Learned: MAC: {} IP: {}", HexEncode.bytesToHexString(host
434 .getDataLayerAddressBytes()), host.getNetworkAddress().getHostAddress());
438 private void replaceHost(InetAddress networkAddr, HostNodeConnector removedHost, HostNodeConnector newHost) {
439 // Ignore ARP messages from internal nodes
440 NodeConnector newHostNc = newHost.getnodeConnector();
441 boolean newHostIsInternal = topologyManager.isInternal(newHostNc);
442 if (newHostIsInternal) {
446 newHost.initArpSendCountDown();
448 if (hostsDB.replace(networkAddr, removedHost, newHost)) {
449 logger.debug("Host move occurred: Old Host IP:{}, New Host IP: {}", removedHost.getNetworkAddress()
450 .getHostAddress(), newHost.getNetworkAddress().getHostAddress());
451 logger.debug("Old Host MAC: {}, New Host MAC: {}",
452 HexEncode.bytesToHexString(removedHost.getDataLayerAddressBytes()),
453 HexEncode.bytesToHexString(newHost.getDataLayerAddressBytes()));
454 // Display the Old and New HostNodeConnectors also
455 logger.debug("Old {}, New {}", removedHost, newHost);
458 * Host replacement has failed, do the recovery
460 hostsDB.put(networkAddr, newHost);
461 logger.error("Host replacement failed. Overwrite the host. Repalced Host: {}, New Host: {}", removedHost,
464 notifyHostLearnedOrRemoved(removedHost, false);
465 notifyHostLearnedOrRemoved(newHost, true);
466 if (!newHost.isStaticHost()) {
467 processPendingARPReqs(networkAddr);
472 private void removeKnownHost(InetAddress key) {
473 HostNodeConnector host = hostsDB.get(key);
475 logger.debug("Removing Host: IP:{}", host.getNetworkAddress().getHostAddress());
478 logger.error("removeKnownHost(): Host for IP address {} not found in hostsDB", key.getHostAddress());
482 private class NotifyHostThread extends Thread {
484 private final HostNodeConnector host;
486 public NotifyHostThread(HostNodeConnector h) {
492 HostNodeConnector removedHost = null;
493 InetAddress networkAddr = host.getNetworkAddress();
495 /* Check for Host Move case */
496 if (hostMoved(host)) {
498 * Host has been moved from one location (switch,port, MAC, or
499 * VLAN) to another. Replace the existing host and its previous
500 * location parameters with new information, and notify the
501 * applications listening to host move.
503 removedHost = hostsDB.get(networkAddr);
504 if (removedHost != null) {
505 replaceHost(networkAddr, removedHost, host);
508 logger.error("Host to be removed not found in hostsDB");
515 /* check if there is an outstanding request for this host */
516 processPendingARPReqs(networkAddr);
517 notifyHostLearnedOrRemoved(host, true);
522 public void hostListener(HostNodeConnector host) {
524 logger.debug("ARP received for Host: IP {}, MAC {}, {}", host.getNetworkAddress().getHostAddress(),
525 HexEncode.bytesToHexString(host.getDataLayerAddressBytes()), host);
526 if (hostExists(host)) {
527 HostNodeConnector existinghost = hostsDB.get(host.getNetworkAddress());
528 existinghost.initArpSendCountDown();
530 hostsDB.put(host.getNetworkAddress(), existinghost);
533 new NotifyHostThread(host).start();
536 // Notify whoever is interested that a new host was learned (dynamically or
538 private void notifyHostLearnedOrRemoved(HostNodeConnector host, boolean add) {
539 // Update listeners if any
540 if (newHostNotify != null) {
541 logger.debug("Notifying Applications for Host {} Being {}", host.getNetworkAddress().getHostAddress(),
542 add ? "Added" : "Deleted");
543 synchronized (this.newHostNotify) {
544 for (IfNewHostNotify ta : newHostNotify) {
547 ta.notifyHTClient(host);
549 ta.notifyHTClientHostRemoved(host);
551 } catch (Exception e) {
552 logger.error("Exception on callback", e);
557 logger.error("notifyHostLearnedOrRemoved(): New host notify is null");
560 // Topology update is for some reason outside of listeners registry
562 Node node = host.getnodeconnectorNode();
564 NodeConnector p = host.getnodeConnector();
566 DataLinkAddress dla = new EthernetAddress(host.getDataLayerAddressBytes());
567 h = new Host(dla, host.getNetworkAddress());
568 } catch (ConstructionException ce) {
573 if (topologyManager != null && p != null && h != null) {
574 logger.debug("Notifying Topology Manager for Host {} Being {}", h.getNetworkAddress().getHostAddress(),
575 add ? "Added" : "Deleted");
577 Tier tier = new Tier(1);
578 switchManager.setNodeProp(node, tier);
579 topologyManager.updateHostLink(p, h, UpdateType.ADDED, null);
581 // No need to reset the tiering if no other hosts are currently
583 // If this switch was discovered to be an access switch, it
584 // still is even if the host is down
585 Tier tier = new Tier(0);
586 switchManager.setNodeProp(node, tier);
587 topologyManager.updateHostLink(p, h, UpdateType.REMOVED, null);
593 * When a new Host is learnt by the hosttracker module, it places the
594 * directly connected Node in Tier-1 & using this function, updates the Tier
595 * value for all other Nodes in the network hierarchy.
597 * This is a recursive function and it takes care of updating the Tier value
598 * for all the connected and eligible Nodes.
601 * Node that represents one of the Vertex in the Topology Graph.
603 * The Tier on which n belongs
605 @SuppressWarnings("unused")
606 private void updateSwitchTiers(Node n, int currentTier) {
607 Map<Node, Set<Edge>> ndlinks = topologyManager.getNodeEdges();
608 if (ndlinks == null) {
609 logger.debug("updateSwitchTiers(): ndlinks null for Node: {}, Tier:{}", n, currentTier);
612 Set<Edge> links = ndlinks.get(n);
614 logger.debug("updateSwitchTiers(): links null for ndlinks:{}", ndlinks);
617 ArrayList<Node> needsVisiting = new ArrayList<Node>();
618 for (Edge lt : links) {
619 if (!lt.getHeadNodeConnector().getType().equals(NodeConnector.NodeConnectorIDType.OPENFLOW)) {
620 // We don't want to work on Node that are not openflow
624 Node dstNode = lt.getHeadNodeConnector().getNode();
625 if (switchNeedsTieringUpdate(dstNode, currentTier + 1)) {
626 Tier t = new Tier(currentTier + 1);
627 switchManager.setNodeProp(dstNode, t);
628 needsVisiting.add(dstNode);
633 * Due to the nature of the problem, having a separate loop for nodes
634 * that needs visiting provides a decent walk optimization.
636 for (Node node : needsVisiting) {
637 updateSwitchTiers(node, currentTier + 1);
642 * Internal convenience routine to check the eligibility of a Switch for a
643 * Tier update. Any Node with Tier=0 or a Tier value that is greater than
644 * the new Tier Value is eligible for the update.
647 * Node for which the Tier update eligibility is checked
650 * @return <code>true</code> if the Node is eligible for Tier Update
651 * <code>false</code> otherwise
654 private boolean switchNeedsTieringUpdate(Node n, int tier) {
656 logger.error("switchNeedsTieringUpdate(): Null node for tier: {}", tier);
660 * Node could have gone down
662 if (!switchManager.getNodes().contains(n)) {
665 // This is the case where Tier was never set for this node
666 Tier t = (Tier) switchManager.getNodeProp(n, Tier.TierPropName);
670 if (t.getValue() == 0) {
672 } else if (t.getValue() > tier) {
679 * Internal convenience routine to clear all the Tier values to 0. This
680 * cleanup is performed during cases such as Topology Change where the
681 * existing Tier values might become incorrect
683 @SuppressWarnings("unused")
684 private void clearTiers() {
685 Set<Node> nodes = null;
686 if (switchManager == null) {
687 logger.error("clearTiers(): Null switchManager");
690 nodes = switchManager.getNodes();
692 for (Node n : nodes) {
693 Tier t = new Tier(0);
694 switchManager.setNodeProp(n, t);
699 * Internal convenience routine to print the hierarchies of switches.
701 @SuppressWarnings("unused")
702 private void logHierarchies(ArrayList<ArrayList<String>> hierarchies) {
703 String hierarchyString = null;
705 for (ArrayList<String> hierarchy : hierarchies) {
706 StringBuffer buf = new StringBuffer();
707 buf.append("Hierarchy#" + num + " : ");
708 for (String switchName : hierarchy) {
709 buf.append(switchName + "/");
711 logger.debug("{} -> {}", getContainerName(), buf);
717 * getHostNetworkHierarchy is the Back-end routine for the North-Bound API
718 * that returns the Network Hierarchy for a given Host. This API is
719 * typically used by applications like Hadoop for Rack Awareness
723 * IP-Address of the host/node.
724 * @return Network Hierarchies represented by an Array of Array (of
725 * Switch-Ids as String).
728 public List<List<String>> getHostNetworkHierarchy(InetAddress hostAddress) {
729 HostNodeConnector host = hostQuery(hostAddress);
734 List<List<String>> hierarchies = new ArrayList<List<String>>();
735 ArrayList<String> currHierarchy = new ArrayList<String>();
736 hierarchies.add(currHierarchy);
738 Node node = host.getnodeconnectorNode();
739 updateCurrentHierarchy(node, currHierarchy, hierarchies);
744 * dpidToHostNameHack is a hack function for Cisco Live Hadoop Demo. Mininet
745 * is used as the network for Hadoop Demos & in order to give a meaningful
746 * rack-awareness switch names, the DPID is organized in ASCII Characters
747 * and retrieved as string.
751 * @return Ascii String represented by the DPID.
753 private String dpidToHostNameHack(long dpid) {
754 String hex = Long.toHexString(dpid);
756 StringBuffer sb = new StringBuffer();
758 for (int i = 0; i < hex.length(); i++) {
759 result = (int) ((dpid >> (i * 8)) & 0xff);
766 sb.append(String.format("%c", result));
768 return sb.reverse().toString();
772 * A convenient recursive routine to obtain the Hierarchy of Switches.
775 * Current Node in the Recursive routine.
776 * @param currHierarchy
777 * Array of Nodes that make this hierarchy on which the Current
779 * @param fullHierarchy
780 * Array of multiple Hierarchies that represent a given host.
782 @SuppressWarnings("unchecked")
783 private void updateCurrentHierarchy(Node node, ArrayList<String> currHierarchy, List<List<String>> fullHierarchy) {
784 // currHierarchy.add(String.format("%x", currSw.getId()));
785 currHierarchy.add(dpidToHostNameHack((Long) node.getID()));
786 // Shallow copy as required
787 ArrayList<String> currHierarchyClone = (ArrayList<String>) currHierarchy.clone();
789 Map<Node, Set<Edge>> ndlinks = topologyManager.getNodeEdges();
790 if (ndlinks == null) {
791 logger.debug("updateCurrentHierarchy(): topologyManager returned null ndlinks for node: {}", node);
794 Node n = NodeCreator.createOFNode((Long) node.getID());
795 Set<Edge> links = ndlinks.get(n);
797 logger.debug("updateCurrentHierarchy(): Null links for ndlinks");
800 for (Edge lt : links) {
801 if (!lt.getHeadNodeConnector().getType().equals(NodeConnector.NodeConnectorIDType.OPENFLOW)) {
802 // We don't want to work on Node that are not openflow
806 Node dstNode = lt.getHeadNodeConnector().getNode();
808 Tier nodeTier = (Tier) switchManager.getNodeProp(node, Tier.TierPropName);
810 * If the host is directly attached to the src node, then the node
811 * should have been assigned the "Access" tier in
812 * notifyHostLearnedOrRemoved. If not, it would be assigned
813 * "Unknown" tier. Thus the tier of host attached node cannot be
814 * null. If the src node here, is the next node in the hierarchy of
815 * the nodes, then its tier cannot be null
818 Tier dstNodeTier = (Tier) switchManager.getNodeProp(dstNode, Tier.TierPropName);
820 * Skip if the tier of the destination node is null
822 if (dstNodeTier == null) {
825 if (dstNodeTier.getValue() > nodeTier.getValue()) {
826 ArrayList<String> buildHierarchy = currHierarchy;
827 if (currHierarchy.size() > currHierarchyClone.size()) {
828 // Shallow copy as required
829 buildHierarchy = (ArrayList<String>) currHierarchyClone.clone();
830 fullHierarchy.add(buildHierarchy);
832 updateCurrentHierarchy(dstNode, buildHierarchy, fullHierarchy);
837 private void debugEdgeUpdate(Edge e, UpdateType type, Set<Property> props) {
839 Short srcPort = null;
841 Short dstPort = null;
842 boolean added = false;
843 String srcType = null;
844 String dstType = null;
846 if (e == null || type == null) {
847 logger.error("Edge or Update type are null!");
850 srcType = e.getTailNodeConnector().getType();
851 dstType = e.getHeadNodeConnector().getType();
853 if (srcType.equals(NodeConnector.NodeConnectorIDType.PRODUCTION)) {
854 logger.debug("Skip updates for {}", e);
858 if (!srcType.equals(NodeConnector.NodeConnectorIDType.OPENFLOW)) {
859 logger.debug("For now we cannot handle updates for non-openflow nodes");
863 if (dstType.equals(NodeConnector.NodeConnectorIDType.PRODUCTION)) {
864 logger.debug("Skip updates for {}", e);
868 if (!dstType.equals(NodeConnector.NodeConnectorIDType.OPENFLOW)) {
869 logger.debug("For now we cannot handle updates for non-openflow nodes");
873 // At this point we know we got an openflow update, so
874 // lets fill everything accordingly.
875 srcNid = (Long) e.getTailNodeConnector().getNode().getID();
876 srcPort = (Short) e.getTailNodeConnector().getID();
877 dstNid = (Long) e.getHeadNodeConnector().getNode().getID();
878 dstPort = (Short) e.getHeadNodeConnector().getID();
880 // Now lets update the added flag
891 logger.debug("HostTracker Topology linkUpdate handling src:{}[port {}] dst:{}[port {}] added: {}",
892 new Object[] { srcNid, srcPort, dstNid, dstPort, added });
896 public void edgeUpdate(List<TopoEdgeUpdate> topoedgeupdateList) {
897 if (logger.isDebugEnabled()) {
898 for (TopoEdgeUpdate topoEdgeUpdate : topoedgeupdateList) {
899 Edge e = topoEdgeUpdate.getEdge();
900 Set<Property> p = topoEdgeUpdate.getProperty();
901 UpdateType type = topoEdgeUpdate.getUpdateType();
903 debugEdgeUpdate(e, type, p);
909 public void subnetNotify(Subnet sub, boolean add) {
910 logger.debug("Received subnet notification: {} add={}", sub, add);
912 for (Entry<InetAddress, ARPPending> entry : failedARPReqList.entrySet()) {
914 arphost = entry.getValue();
915 if (hostFinder == null) {
916 logger.warn("ARPHandler Services are not available on subnet addition");
919 logger.debug("Sending the ARP from FailedARPReqList fors IP: {}", arphost.getHostIP().getHostAddress());
920 hostFinder.find(arphost.getHostIP());
925 class OutStandingARPHandler extends TimerTask {
932 /* This routine runs every 4 seconds */
933 logger.trace("Number of Entries in ARP Pending/Failed Lists: ARPPendingList = {}, failedARPReqList = {}",
934 ARPPendingList.size(), failedARPReqList.size());
935 for (Entry<InetAddress, ARPPending> entry : ARPPendingList.entrySet()) {
936 arphost = entry.getValue();
938 if (hostsDB.containsKey(arphost.getHostIP())) {
939 // this host is already learned, shouldn't be in
941 // Remove it and continue
942 logger.warn("Learned Host {} found in ARPPendingList", arphost.getHostIP());
943 ARPPendingList.remove(entry.getKey());
946 if (arphost.getSent_count() < switchManager.getHostRetryCount()) {
948 * No reply has been received of first ARP Req, send the
949 * next one. Before sending the ARP, check if ARPHandler is
952 if (hostFinder == null) {
953 logger.warn("ARPHandler Services are not available for Outstanding ARPs");
956 hostFinder.find(arphost.getHostIP());
957 arphost.sent_count++;
958 logger.debug("ARP Sent from ARPPending List, IP: {}", arphost.getHostIP().getHostAddress());
959 } else if (arphost.getSent_count() >= switchManager.getHostRetryCount()) {
961 * ARP requests have been sent without receiving a reply,
962 * remove this from the pending list
964 ARPPendingList.remove(entry.getKey());
965 logger.debug("ARP reply not received after multiple attempts, removing from Pending List IP: {}",
966 arphost.getHostIP().getHostAddress());
968 * Add this host to a different list which will be processed
971 logger.debug("Adding the host to FailedARPReqList IP: {}", arphost.getHostIP().getHostAddress());
972 failedARPReqList.put(entry.getKey(), arphost);
975 logger.error("Inavlid arp_sent count for entry: {}", entry);
981 private class ARPRefreshHandler extends TimerTask {
987 if ((clusterContainerService != null) && !clusterContainerService.amICoordinator()) {
990 if ((switchManager != null) && !switchManager.isHostRefreshEnabled()) {
992 * The host probe procedure was disabled by CLI
996 if (hostsDB == null) {
997 /* hostsDB is not allocated yet */
998 logger.error("ARPRefreshHandler(): hostsDB is not allocated yet:");
1001 for (Entry<InetAddress, HostNodeConnector> entry : hostsDB.entrySet()) {
1002 HostNodeConnector host = entry.getValue();
1003 if (host.isStaticHost()) {
1004 /* this host was learned via API3, don't age it out */
1008 short arp_cntdown = host.getArpSendCountDown();
1010 if (arp_cntdown > switchManager.getHostRetryCount()) {
1011 host.setArpSendCountDown(arp_cntdown);
1012 } else if (arp_cntdown <= 0) {
1014 * No ARP Reply received in last 2 minutes, remove this host
1015 * and inform applications
1017 removeKnownHost(entry.getKey());
1018 notifyHostLearnedOrRemoved(host, false);
1019 } else if (arp_cntdown <= switchManager.getHostRetryCount()) {
1021 * Use the services of arphandler to check if host is still
1024 if (logger.isTraceEnabled()) {
1026 "ARP Probing ({}) for {}({})",
1027 new Object[] { arp_cntdown, host.getNetworkAddress().getHostAddress(),
1028 HexEncode.bytesToHexString(host.getDataLayerAddressBytes()) });
1030 host.setArpSendCountDown(arp_cntdown);
1031 if (hostFinder == null) {
1033 * If hostfinder is not available, then can't send the
1034 * probe. However, continue the age out the hosts since
1035 * we don't know if the host is indeed out there or not.
1037 logger.warn("ARPHandler is not avaialable, can't send the probe");
1040 hostFinder.probe(host);
1047 * Inform the controller IP to MAC binding of a host and its connectivity to
1048 * an openflow switch in terms of Node, port, and VLAN.
1050 * @param networkAddr
1051 * IP address of the host
1053 * Address MAC address of the host
1055 * NodeConnector to which host is connected
1057 * Port of the switch to which host is connected
1059 * Vlan of which this host is member of
1061 * @return Status The status object as described in {@code Status}
1062 * indicating the result of this action.
1065 public Status addStaticHostReq(InetAddress networkAddr, byte[] dataLayerAddress, NodeConnector nc, short vlan) {
1066 if (dataLayerAddress.length != NetUtils.MACAddrLengthInBytes) {
1067 return new Status(StatusCode.BADREQUEST, "Invalid MAC address");
1071 return new Status(StatusCode.BADREQUEST, "Invalid NodeConnector");
1073 HostNodeConnector host = null;
1075 host = new HostNodeConnector(dataLayerAddress, networkAddr, nc, vlan);
1076 if (hostExists(host)) {
1077 // This host is already learned either via ARP or through a
1078 // northbound request
1079 HostNodeConnector transHost = hostsDB.get(networkAddr);
1080 transHost.setStaticHost(true);
1081 return new Status(StatusCode.SUCCESS, null);
1084 if (hostsDB.get(networkAddr) != null) {
1085 // There is already a host with this IP address (but behind
1086 // a different (switch, port, vlan) tuple. Return an error
1087 return new Status(StatusCode.CONFLICT, "Existing IP, Use PUT to update");
1089 host.setStaticHost(true);
1091 * Check if the nc is an ISL port
1093 if (topologyManager != null) {
1094 if (topologyManager.isInternal(nc)) {
1095 return new Status(StatusCode.BADREQUEST, "Cannot add host on ISL port");
1099 * Before adding host, Check if the switch and the port have already
1102 if (switchManager.isNodeConnectorEnabled(nc)) {
1104 processPendingARPReqs(networkAddr);
1105 notifyHostLearnedOrRemoved(host, true);
1107 inactiveStaticHosts.put(nc, host);
1108 logger.debug("Switch or switchport is not up, adding host {} to inactive list",
1109 networkAddr.getHostName());
1111 return new Status(StatusCode.SUCCESS, null);
1112 } catch (ConstructionException e) {
1113 logger.error("", e);
1114 return new Status(StatusCode.INTERNALERROR, "Host could not be created");
1120 * Update the controller IP to MAC binding of a host and its connectivity to
1121 * an openflow switch in terms of switch id, switch port, and VLAN.
1123 * @param networkAddr
1124 * IP address of the host
1126 * Address MAC address of the host
1128 * NodeConnector to which host is connected
1130 * Port of the switch to which host is connected
1132 * Vlan of which this host is member of
1134 * @return Status The status object as described in {@code Status}
1135 * indicating the result of this action.
1137 public Status updateHostReq(InetAddress networkAddr, byte[] dataLayerAddress, NodeConnector nc, short vlan) {
1138 HostNodeConnector tobeUpdatedHost;
1139 HostNodeConnector host = null;
1141 if (dataLayerAddress.length != NetUtils.MACAddrLengthInBytes) {
1142 return new Status(StatusCode.BADREQUEST, "Invalid MAC address");
1146 return new Status(StatusCode.BADREQUEST, "Invalid NodeConnector");
1150 host = new HostNodeConnector(dataLayerAddress, networkAddr, nc, vlan);
1151 if (hostExists(host)) {
1152 return new Status(StatusCode.BADREQUEST, "Host already exists");
1155 if ((tobeUpdatedHost = hostsDB.get(networkAddr)) != null) {
1156 if (hostsDB.replace(networkAddr, tobeUpdatedHost, host)) {
1157 logger.debug("Host replaced from hostsDB. Old host: {} New Host: {}", tobeUpdatedHost, host);
1158 notifyHostLearnedOrRemoved(tobeUpdatedHost, false);
1159 notifyHostLearnedOrRemoved(host, true);
1160 return new Status(StatusCode.SUCCESS);
1162 logger.error("Static host replacement failed from hostsDB, Replaced Host: {}, New Host: {}",
1163 tobeUpdatedHost, host);
1164 return new Status(StatusCode.INTERNALERROR,
1165 "Host Replacement Failed due to presence of another host with same IP");
1169 // Check if the host exists in inactive hosts database
1170 if ((tobeUpdatedHost = inactiveStaticHosts.get(nc)) != null) {
1171 if (inactiveStaticHosts.replace(nc, tobeUpdatedHost, host)) {
1172 logger.debug("Host replaced from inactive hostsDB. Old host: {} New Host: {}", tobeUpdatedHost,
1174 return new Status(StatusCode.SUCCESS);
1176 logger.error("Static host replacement failed, Replaced Host: {}, New Host: {}", tobeUpdatedHost,
1178 return new Status(StatusCode.INTERNALERROR,
1179 "Host Replacement Failed due to presence of another host with same IP");
1183 // Host doesn't exist
1184 return new Status(StatusCode.BADREQUEST, "Host doesn't exists, can't update");
1185 } catch (ConstructionException e) {
1186 logger.error("", e);
1187 return new Status(StatusCode.INTERNALERROR, "host object creation failure");
1192 * Remove from the controller IP to MAC binding of a host and its
1193 * connectivity to an openflow switch
1195 * @param networkAddr
1196 * IP address of the host
1198 * @return boolean true if the host was removed successfully, false
1202 public Status removeStaticHostReq(InetAddress networkAddress) {
1203 // Check if host is in active hosts database
1204 HostNodeConnector host = getHostFromOnActiveDB(networkAddress);
1207 if (!host.isStaticHost()) {
1208 return new Status(StatusCode.FORBIDDEN, "Host " + networkAddress.getHostName() + " is not static");
1210 // Remove and notify
1211 notifyHostLearnedOrRemoved(host, false);
1212 removeKnownHost(networkAddress);
1213 return new Status(StatusCode.SUCCESS, null);
1216 // Check if host is in inactive hosts database
1217 Entry<NodeConnector, HostNodeConnector> entry = getHostFromInactiveDB(networkAddress);
1218 if (entry != null) {
1219 host = entry.getValue();
1221 if (!host.isStaticHost()) {
1222 return new Status(StatusCode.FORBIDDEN, "Host " + networkAddress.getHostName() + " is not static");
1224 this.removeHostFromInactiveDB(networkAddress);
1225 return new Status(StatusCode.SUCCESS, null);
1228 // Host is neither in active nor inactive hosts database
1229 return new Status(StatusCode.NOTFOUND, "Host does not exist");
1233 public void modeChangeNotify(Node node, boolean proactive) {
1234 logger.debug("Set Switch {} Mode to {}", node.getID(), proactive);
1238 public void notifyNode(Node node, UpdateType type, Map<String, Property> propMap) {
1245 logger.debug("Received removed node {}", node);
1246 for (Entry<InetAddress, HostNodeConnector> entry : hostsDB.entrySet()) {
1247 HostNodeConnector host = entry.getValue();
1248 if (host.getnodeconnectorNode().equals(node)) {
1249 logger.debug("Node: {} is down, remove from Hosts_DB", node);
1250 removeKnownHost(entry.getKey());
1251 notifyHostLearnedOrRemoved(host, false);
1261 public void notifyNodeConnector(NodeConnector nodeConnector, UpdateType type, Map<String, Property> propMap) {
1262 if (nodeConnector == null) {
1274 State state = (State) propMap.get(State.StatePropName);
1275 if ((state != null) && (state.getValue() == State.EDGE_UP)) {
1284 handleNodeConnectorStatusUp(nodeConnector);
1286 handleNodeConnectorStatusDown(nodeConnector);
1291 public Status addStaticHost(String networkAddress, String dataLayerAddress, NodeConnector nc, String vlan) {
1293 InetAddress ip = InetAddress.getByName(networkAddress);
1295 return new Status(StatusCode.BADREQUEST, "Invalid NodeId");
1297 return addStaticHostReq(ip, HexEncode.bytesFromHexString(dataLayerAddress), nc, Short.valueOf(vlan));
1298 } catch (UnknownHostException e) {
1299 logger.error("", e);
1300 return new Status(StatusCode.BADREQUEST, "Invalid Address");
1305 public Status removeStaticHost(String networkAddress) {
1306 InetAddress address;
1308 address = InetAddress.getByName(networkAddress);
1309 return removeStaticHostReq(address);
1310 } catch (UnknownHostException e) {
1311 logger.error("", e);
1312 return new Status(StatusCode.BADREQUEST, "Invalid Address");
1316 private void handleNodeConnectorStatusUp(NodeConnector nodeConnector) {
1318 HostNodeConnector host = null;
1320 logger.debug("handleNodeConnectorStatusUp {}", nodeConnector);
1322 for (Entry<InetAddress, ARPPending> entry : failedARPReqList.entrySet()) {
1323 arphost = entry.getValue();
1324 logger.debug("Sending the ARP from FailedARPReqList fors IP: {}", arphost.getHostIP().getHostAddress());
1325 if (hostFinder == null) {
1326 logger.warn("ARPHandler is not available at interface up");
1327 logger.warn("Since this event is missed, host(s) connected to interface {} may not be discovered",
1332 // Send a broadcast ARP only on the interface which just came up.
1333 // Use hostFinder's "probe" method
1335 byte[] dataLayerAddress = NetUtils.getBroadcastMACAddr();
1336 host = new HostNodeConnector(dataLayerAddress, arphost.getHostIP(), nodeConnector, (short) 0);
1337 hostFinder.probe(host);
1338 } catch (ConstructionException e) {
1339 logger.debug("HostNodeConnector couldn't be created for Host: {}, NodeConnector: {}",
1340 arphost.getHostIP(), nodeConnector);
1341 logger.error("", e);
1343 logger.debug("Done. handleNodeConnectorStatusUp {}", nodeConnector);
1346 host = inactiveStaticHosts.get(nodeConnector);
1348 inactiveStaticHosts.remove(nodeConnector);
1350 processPendingARPReqs(host.getNetworkAddress());
1351 notifyHostLearnedOrRemoved(host, true);
1355 private void handleNodeConnectorStatusDown(NodeConnector nodeConnector) {
1356 logger.debug("handleNodeConnectorStatusDown {}", nodeConnector);
1358 for (Entry<InetAddress, HostNodeConnector> entry : hostsDB.entrySet()) {
1359 HostNodeConnector host = entry.getValue();
1360 if (host.getnodeConnector().equals(nodeConnector)) {
1361 logger.debug(" NodeConnector: {} is down, remove from Hosts_DB", nodeConnector);
1362 removeKnownHost(entry.getKey());
1363 notifyHostLearnedOrRemoved(host, false);
1368 void setClusterContainerService(IClusterContainerServices s) {
1369 logger.debug("Cluster Service set");
1370 this.clusterContainerService = s;
1373 void unsetClusterContainerService(IClusterContainerServices s) {
1374 if (this.clusterContainerService == s) {
1375 logger.debug("Cluster Service removed!");
1376 this.clusterContainerService = null;
1380 void setSwitchManager(ISwitchManager s) {
1381 logger.debug("SwitchManager set");
1382 this.switchManager = s;
1385 void unsetSwitchManager(ISwitchManager s) {
1386 if (this.switchManager == s) {
1387 logger.debug("SwitchManager removed!");
1388 this.switchManager = null;
1392 public String getContainerName() {
1393 if (containerName == null) {
1394 return GlobalConstants.DEFAULT.toString();
1396 return containerName;
1400 * Function called by the dependency manager when all the required
1401 * dependencies are satisfied
1404 void init(Component c) {
1405 Dictionary<?, ?> props = c.getServiceProperties();
1406 if (props != null) {
1407 this.containerName = (String) props.get("containerName");
1408 logger.debug("Running containerName: {}", this.containerName);
1410 // In the Global instance case the containerName is empty
1411 this.containerName = "";
1417 * Function called by the dependency manager when at least one dependency
1418 * become unsatisfied or when the component is shutting down because for
1419 * example bundle is being stopped.
1426 * Function called by dependency manager after "init ()" is called and after
1427 * the services provided by the class are registered in the service registry
1431 registerWithOSGIConsole();
1435 * Function called by the dependency manager before the services exported by
1436 * the component are unregistered, this will be followed by a "destroy ()"
1445 arpRefreshTimer.cancel();
1447 executor.shutdownNow();
1451 public void edgeOverUtilized(Edge edge) {
1456 public void edgeUtilBackToNormal(Edge edge) {
1461 public void entryCreated(InetAddress key, String cacheName, boolean originLocal) {
1465 processPendingARPReqs(key);
1469 public void entryUpdated(InetAddress key, HostNodeConnector new_value, String cacheName, boolean originLocal) {
1473 public void entryDeleted(InetAddress key, String cacheName, boolean originLocal) {
1476 private void registerWithOSGIConsole() {
1477 BundleContext bundleContext = FrameworkUtil.getBundle(this.getClass()).getBundleContext();
1478 bundleContext.registerService(CommandProvider.class.getName(), this, null);
1482 public String getHelp() {
1486 public void _dumpPendingARPReqList(CommandInterpreter ci) {
1488 for (Entry<InetAddress, ARPPending> entry : ARPPendingList.entrySet()) {
1489 arphost = entry.getValue();
1490 ci.println(arphost.getHostIP().toString());
1494 public void _dumpFailedARPReqList(CommandInterpreter ci) {
1496 for (Entry<InetAddress, ARPPending> entry : failedARPReqList.entrySet()) {
1497 arphost = entry.getValue();
1498 ci.println(arphost.getHostIP().toString());