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.opendaylight.controller.clustering.services.CacheConfigException;
33 import org.opendaylight.controller.clustering.services.CacheExistException;
34 import org.opendaylight.controller.clustering.services.IClusterContainerServices;
35 import org.opendaylight.controller.clustering.services.IClusterServices;
36 import org.opendaylight.controller.hosttracker.IfHostListener;
37 import org.opendaylight.controller.hosttracker.IfIptoHost;
38 import org.opendaylight.controller.hosttracker.IfNewHostNotify;
39 import org.opendaylight.controller.hosttracker.hostAware.HostNodeConnector;
40 import org.opendaylight.controller.hosttracker.hostAware.IHostFinder;
41 import org.opendaylight.controller.sal.core.ConstructionException;
42 import org.opendaylight.controller.sal.core.Edge;
43 import org.opendaylight.controller.sal.core.Host;
44 import org.opendaylight.controller.sal.core.Node;
45 import org.opendaylight.controller.sal.core.NodeConnector;
46 import org.opendaylight.controller.sal.core.Property;
47 import org.opendaylight.controller.sal.core.State;
48 import org.opendaylight.controller.sal.core.Tier;
49 import org.opendaylight.controller.sal.core.UpdateType;
50 import org.opendaylight.controller.sal.packet.address.DataLinkAddress;
51 import org.opendaylight.controller.sal.packet.address.EthernetAddress;
52 import org.opendaylight.controller.sal.topology.TopoEdgeUpdate;
53 import org.opendaylight.controller.sal.utils.GlobalConstants;
54 import org.opendaylight.controller.sal.utils.HexEncode;
55 import org.opendaylight.controller.sal.utils.NetUtils;
56 import org.opendaylight.controller.sal.utils.NodeCreator;
57 import org.opendaylight.controller.sal.utils.Status;
58 import org.opendaylight.controller.sal.utils.StatusCode;
59 import org.opendaylight.controller.switchmanager.IInventoryListener;
60 import org.opendaylight.controller.switchmanager.ISwitchManager;
61 import org.opendaylight.controller.switchmanager.ISwitchManagerAware;
62 import org.opendaylight.controller.switchmanager.Subnet;
63 import org.opendaylight.controller.topologymanager.ITopologyManager;
64 import org.opendaylight.controller.topologymanager.ITopologyManagerAware;
65 import org.slf4j.Logger;
66 import org.slf4j.LoggerFactory;
69 * @file HostTracker.java This class tracks the location of IP Hosts as to which
70 * Switch, Port, VLAN, they are connected to, as well as their MAC
71 * address. This is done dynamically as well as statically. The dynamic
72 * mechanism consists of listening to ARP messages as well sending ARP
73 * requests. Static mechanism consists of Northbound APIs to add or remove
74 * the hosts from the local database. ARP aging is also implemented to age
75 * out dynamically learned hosts. Interface methods are provided for other
76 * applications to 1. Query the local database for a single host 2. Get a
77 * list of all hosts 3. Get notification if a host is learned/added or
78 * removed the database
81 public class HostTracker implements IfIptoHost, IfHostListener, ISwitchManagerAware, IInventoryListener,
82 ITopologyManagerAware {
83 private static final Logger logger = LoggerFactory.getLogger(HostTracker.class);
84 private IHostFinder hostFinder;
85 private ConcurrentMap<InetAddress, HostNodeConnector> hostsDB;
87 * Following is a list of hosts which have been requested by NB APIs to be
88 * added, but either the switch or the port is not sup, so they will be
89 * added here until both come up
91 private ConcurrentMap<NodeConnector, HostNodeConnector> inactiveStaticHosts;
92 private final Set<IfNewHostNotify> newHostNotify = Collections.synchronizedSet(new HashSet<IfNewHostNotify>());
94 private ITopologyManager topologyManager;
95 private IClusterContainerServices clusterContainerService = null;
96 private ISwitchManager switchManager = null;
98 private Timer arp_refresh_timer;
99 private String containerName = null;
100 private ExecutorService executor;
101 private static class ARPPending {
102 protected InetAddress hostIP;
103 protected short sent_count;
104 protected HostTrackerCallable hostTrackerCallable;
106 public InetAddress getHostIP() {
110 public short getSent_count() {
114 public HostTrackerCallable getHostTrackerCallable() {
115 return hostTrackerCallable;
118 public void setHostIP(InetAddress networkAddr) {
119 this.hostIP = networkAddr;
122 public void setSent_count(short count) {
123 this.sent_count = count;
126 public void setHostTrackerCallable(HostTrackerCallable callable) {
127 hostTrackerCallable = callable;
131 // This list contains the hosts for which ARP requests are being sent
133 private final List<ARPPending> ARPPendingList = new ArrayList<HostTracker.ARPPending>();
135 * This list below contains the hosts which were initially in ARPPendingList
136 * above, but ARP response didn't come from there hosts after multiple
137 * attempts over 8 seconds. The assumption is that the response didn't come
138 * back due to one of the following possibilities: 1. The L3 interface
139 * wasn't created for this host in the controller. This would cause
140 * arphandler not to know where to send the ARP 2. The host facing port is
141 * down 3. The IP host doesn't exist or is not responding to ARP requests
143 * Conditions 1 and 2 above can be recovered if ARP is sent when the
144 * relevant L3 interface is added or the port facing host comes up. Whenever
145 * L3 interface is added or host facing port comes up, ARP will be sent to
146 * hosts in this list.
148 * We can't recover from condition 3 above
150 private final ArrayList<ARPPending> failedARPReqList = new ArrayList<HostTracker.ARPPending>();
152 public HostTracker() {
155 private void startUp() {
160 timer.schedule(new OutStandingARPHandler(), 4000, 4000);
161 executor = Executors.newFixedThreadPool(2);
162 /* ARP Refresh Timer to go off every 5 seconds to implement ARP aging */
163 arp_refresh_timer = new Timer();
164 arp_refresh_timer.schedule(new ARPRefreshHandler(), 5000, 5000);
165 logger.debug("startUp: Caches created, timers started");
168 @SuppressWarnings("deprecation")
169 private void allocateCache() {
170 if (this.clusterContainerService == null) {
171 logger.error("un-initialized clusterContainerService, can't create cache");
174 logger.debug("Creating Cache for HostTracker");
176 this.clusterContainerService.createCache("hostTrackerAH",
177 EnumSet.of(IClusterServices.cacheMode.NON_TRANSACTIONAL));
178 this.clusterContainerService.createCache("hostTrackerIH",
179 EnumSet.of(IClusterServices.cacheMode.NON_TRANSACTIONAL));
180 } catch (CacheConfigException cce) {
181 logger.error("Cache couldn't be created for HostTracker - check cache mode");
182 } catch (CacheExistException cce) {
183 logger.error("Cache for HostTracker already exists, destroy and recreate");
185 logger.debug("Cache successfully created for HostTracker");
188 @SuppressWarnings({ "unchecked", "deprecation" })
189 private void retrieveCache() {
190 if (this.clusterContainerService == null) {
191 logger.error("un-initialized clusterContainerService, can't retrieve cache");
194 logger.debug("Retrieving cache for HostTrackerAH");
195 hostsDB = (ConcurrentMap<InetAddress, HostNodeConnector>) this.clusterContainerService
196 .getCache("hostTrackerAH");
197 if (hostsDB == null) {
198 logger.error("Cache couldn't be retrieved for HostTracker");
200 logger.debug("Cache was successfully retrieved for HostTracker");
201 logger.debug("Retrieving cache for HostTrackerIH");
202 inactiveStaticHosts = (ConcurrentMap<NodeConnector, HostNodeConnector>) this.clusterContainerService
203 .getCache("hostTrackerIH");
204 if (inactiveStaticHosts == null) {
205 logger.error("Cache couldn't be retrieved for HostTrackerIH");
207 logger.debug("Cache was successfully retrieved for HostTrackerIH");
210 public void nonClusterObjectCreate() {
211 hostsDB = new ConcurrentHashMap<InetAddress, HostNodeConnector>();
212 inactiveStaticHosts = new ConcurrentHashMap<NodeConnector, HostNodeConnector>();
216 public void shutDown() {
219 public void setnewHostNotify(IfNewHostNotify obj) {
220 this.newHostNotify.add(obj);
223 public void unsetnewHostNotify(IfNewHostNotify obj) {
224 this.newHostNotify.remove(obj);
227 public void setArpHandler(IHostFinder hostFinder) {
228 this.hostFinder = hostFinder;
231 public void unsetArpHandler(IHostFinder hostFinder) {
232 if (this.hostFinder == hostFinder) {
233 logger.debug("Arp Handler Service removed!");
234 this.hostFinder = null;
238 public void setTopologyManager(ITopologyManager s) {
239 this.topologyManager = s;
242 public void unsetTopologyManager(ITopologyManager s) {
243 if (this.topologyManager == s) {
244 logger.debug("Topology Manager Service removed!");
245 this.topologyManager = null;
249 private boolean hostExists(HostNodeConnector host) {
250 HostNodeConnector lhost = hostsDB.get(host.getNetworkAddress());
251 return host.equals(lhost);
254 private HostNodeConnector getHostFromOnActiveDB(InetAddress networkAddress) {
255 return hostsDB.get(networkAddress);
258 private Entry<NodeConnector, HostNodeConnector> getHostFromInactiveDB(InetAddress networkAddress) {
259 for (Entry<NodeConnector, HostNodeConnector> entry : inactiveStaticHosts.entrySet()) {
260 if (entry.getValue().equalsByIP(networkAddress)) {
261 logger.debug("getHostFromInactiveDB(): Inactive Host found for IP:{} ", networkAddress.getHostAddress());
265 logger.debug("getHostFromInactiveDB() Inactive Host Not found for IP: {}", networkAddress.getHostAddress());
269 private void removeHostFromInactiveDB(InetAddress networkAddress) {
270 NodeConnector nodeConnector = null;
271 for (Entry<NodeConnector, HostNodeConnector> entry : inactiveStaticHosts.entrySet()) {
272 if (entry.getValue().equalsByIP(networkAddress)) {
273 nodeConnector = entry.getKey();
277 if (nodeConnector != null) {
278 inactiveStaticHosts.remove(nodeConnector);
279 logger.debug("removeHostFromInactiveDB(): Host Removed for IP: {}", networkAddress.getHostAddress());
282 logger.debug("removeHostFromInactiveDB(): Host Not found for IP: {}", networkAddress.getHostAddress());
285 protected boolean hostMoved(HostNodeConnector host) {
286 if (hostQuery(host.getNetworkAddress()) != null) {
293 public HostNodeConnector hostQuery(InetAddress networkAddress) {
294 return hostsDB.get(networkAddress);
298 public Future<HostNodeConnector> discoverHost(InetAddress networkAddress) {
299 if (executor == null) {
300 logger.error("discoverHost: Null executor");
303 Callable<HostNodeConnector> worker = new HostTrackerCallable(this, networkAddress);
304 Future<HostNodeConnector> submit = executor.submit(worker);
309 public HostNodeConnector hostFind(InetAddress networkAddress) {
311 * Sometimes at boot with containers configured in the startup we hit
312 * this path (from TIF) when hostFinder has not been set yet Caller
313 * already handles the null return
316 if (hostFinder == null) {
317 logger.debug("Exiting hostFind, null hostFinder");
321 HostNodeConnector host = hostQuery(networkAddress);
323 logger.debug("hostFind(): Host found for IP: {}", networkAddress.getHostAddress());
326 /* host is not found, initiate a discovery */
327 hostFinder.find(networkAddress);
328 /* Also add this host to ARPPending List for any potential retries */
329 AddtoARPPendingList(networkAddress);
330 logger.debug("hostFind(): Host Not Found for IP: {}, Inititated Host Discovery ...",
331 networkAddress.getHostAddress());
336 public Set<HostNodeConnector> getAllHosts() {
337 Set<HostNodeConnector> allHosts = new HashSet<HostNodeConnector>();
338 for (Entry<InetAddress, HostNodeConnector> entry : hostsDB.entrySet()) {
339 HostNodeConnector host = entry.getValue();
342 logger.debug("Exiting getAllHosts, Found {} Hosts", allHosts.size());
347 public Set<HostNodeConnector> getActiveStaticHosts() {
348 Set<HostNodeConnector> list = new HashSet<HostNodeConnector>();
349 for (Entry<InetAddress, HostNodeConnector> entry : hostsDB.entrySet()) {
350 HostNodeConnector host = entry.getValue();
351 if (host.isStaticHost()) {
355 logger.debug("getActiveStaticHosts(): Found {} Hosts", list.size());
360 public Set<HostNodeConnector> getInactiveStaticHosts() {
361 Set<HostNodeConnector> list = new HashSet<HostNodeConnector>();
362 for (Entry<NodeConnector, HostNodeConnector> entry : inactiveStaticHosts.entrySet()) {
363 list.add(entry.getValue());
365 logger.debug("getInactiveStaticHosts(): Found {} Hosts", list.size());
369 private void AddtoARPPendingList(InetAddress networkAddr) {
370 ARPPending arphost = new ARPPending();
372 arphost.setHostIP(networkAddr);
373 arphost.setSent_count((short) 1);
374 ARPPendingList.add(arphost);
375 logger.debug("Host Added to ARPPending List, IP: {}", networkAddr);
378 private void removePendingARPFromList(int index) {
379 if (index >= ARPPendingList.size()) {
380 logger.warn("removePendingARPFromList(): index greater than the List. Size:{}, Index:{}",
381 ARPPendingList.size(), index);
384 ARPPending arphost = ARPPendingList.remove(index);
385 HostTrackerCallable htCallable = arphost.getHostTrackerCallable();
386 if (htCallable != null)
390 public void setCallableOnPendingARP(InetAddress networkAddr, HostTrackerCallable callable) {
392 for (int i = 0; i < ARPPendingList.size(); i++) {
393 arphost = ARPPendingList.get(i);
394 if (arphost.getHostIP().equals(networkAddr)) {
395 arphost.setHostTrackerCallable(callable);
400 private void ProcPendingARPReqs(InetAddress networkAddr) {
403 for (int i = 0; i < ARPPendingList.size(); i++) {
404 arphost = ARPPendingList.get(i);
405 if (arphost.getHostIP().equals(networkAddr)) {
407 * An ARP was sent for this host. The address is learned, remove
410 removePendingARPFromList(i);
411 logger.debug("Host Removed from ARPPending List, IP: {}", networkAddr);
417 * It could have been a host from the FailedARPReqList
420 for (int i = 0; i < failedARPReqList.size(); i++) {
421 arphost = failedARPReqList.get(i);
422 if (arphost.getHostIP().equals(networkAddr)) {
424 * An ARP was sent for this host. The address is learned, remove
427 failedARPReqList.remove(i);
428 logger.debug("Host Removed from FailedARPReqList List, IP: {}", networkAddr);
435 private void learnNewHost(HostNodeConnector host) {
436 host.initArpSendCountDown();
437 HostNodeConnector rHost = hostsDB.putIfAbsent(host.getNetworkAddress(), host);
439 // Another host is already learned for this IP address, replace it
440 replaceHost(host.getNetworkAddress(), rHost, host);
442 logger.debug("New Host Learned: MAC: {} IP: {}", HexEncode.bytesToHexString(host
443 .getDataLayerAddressBytes()), host.getNetworkAddress().getHostAddress());
447 private void replaceHost(InetAddress networkAddr, HostNodeConnector removedHost, HostNodeConnector newHost) {
448 newHost.initArpSendCountDown();
449 if (hostsDB.replace(networkAddr, removedHost, newHost)) {
450 logger.debug("Host move occurred. Old Host:{}, New Host: {}", removedHost, newHost);
453 * Host replacement has failed, do the recovery
455 hostsDB.put(networkAddr, newHost);
456 logger.error("Host replacement failed. Overwrite the host. Repalced Host: {}, New Host: {}", removedHost,
459 notifyHostLearnedOrRemoved(removedHost, false);
460 notifyHostLearnedOrRemoved(newHost, true);
461 if (!newHost.isStaticHost()) {
462 ProcPendingARPReqs(networkAddr);
467 private void removeKnownHost(InetAddress key) {
468 HostNodeConnector host = hostsDB.get(key);
470 logger.debug("Removing Host: IP:{}", host.getNetworkAddress().getHostAddress());
473 logger.error("removeKnownHost(): Host for IP address {} not found in hostsDB", key.getHostAddress());
477 private class NotifyHostThread extends Thread {
479 private final HostNodeConnector host;
481 public NotifyHostThread(HostNodeConnector h) {
487 HostNodeConnector removedHost = null;
488 InetAddress networkAddr = host.getNetworkAddress();
490 /* Check for Host Move case */
491 if (hostMoved(host)) {
493 * Host has been moved from one location (switch,port, MAC, or
494 * VLAN) to another. Replace the existing host and its previous
495 * location parameters with new information, and notify the
496 * applications listening to host move.
498 removedHost = hostsDB.get(networkAddr);
499 if (removedHost != null) {
500 replaceHost(networkAddr, removedHost, host);
503 logger.error("Host to be removed not found in hostsDB. Host {}", removedHost);
507 if (removedHost == null) {
512 /* check if there is an outstanding request for this host */
513 ProcPendingARPReqs(networkAddr);
514 notifyHostLearnedOrRemoved(host, true);
519 public void hostListener(HostNodeConnector host) {
521 if (hostExists(host)) {
522 logger.debug("ARP received for Host: {}", host);
523 HostNodeConnector existinghost = hostsDB.get(host.getNetworkAddress());
524 existinghost.initArpSendCountDown();
527 new NotifyHostThread(host).start();
530 // Notify whoever is interested that a new host was learned (dynamically or
532 private void notifyHostLearnedOrRemoved(HostNodeConnector host, boolean add) {
533 // Update listeners if any
534 if (newHostNotify != null) {
535 synchronized (this.newHostNotify) {
536 for (IfNewHostNotify ta : newHostNotify) {
539 ta.notifyHTClient(host);
541 ta.notifyHTClientHostRemoved(host);
543 } catch (Exception e) {
544 logger.error("Exception on callback", e);
549 logger.error("notifyHostLearnedOrRemoved(): New host notify is null");
552 // Topology update is for some reason outside of listeners registry
554 Node node = host.getnodeconnectorNode();
556 NodeConnector p = host.getnodeConnector();
558 DataLinkAddress dla = new EthernetAddress(host.getDataLayerAddressBytes());
559 h = new Host(dla, host.getNetworkAddress());
560 } catch (ConstructionException ce) {
565 if (topologyManager != null && p != null && h != null) {
567 Tier tier = new Tier(1);
568 switchManager.setNodeProp(node, tier);
569 topologyManager.updateHostLink(p, h, UpdateType.ADDED, null);
571 // No need to reset the tiering if no other hosts are currently
573 // If this switch was discovered to be an access switch, it
574 // still is even if the host is down
575 Tier tier = new Tier(0);
576 switchManager.setNodeProp(node, tier);
577 topologyManager.updateHostLink(p, h, UpdateType.REMOVED, null);
583 * When a new Host is learnt by the hosttracker module, it places the
584 * directly connected Node in Tier-1 & using this function, updates the Tier
585 * value for all other Nodes in the network hierarchy.
587 * This is a recursive function and it takes care of updating the Tier value
588 * for all the connected and eligible Nodes.
591 * Node that represents one of the Vertex in the Topology Graph.
593 * The Tier on which n belongs
595 private void updateSwitchTiers(Node n, int currentTier) {
596 Map<Node, Set<Edge>> ndlinks = topologyManager.getNodeEdges();
597 if (ndlinks == null) {
598 logger.debug("updateSwitchTiers(): ndlinks null for Node: {}, Tier:{}", n, currentTier);
601 Set<Edge> links = ndlinks.get(n);
603 logger.debug("updateSwitchTiers(): links null for ndlinks:{}", ndlinks);
606 ArrayList<Node> needsVisiting = new ArrayList<Node>();
607 for (Edge lt : links) {
608 if (!lt.getHeadNodeConnector().getType().equals(NodeConnector.NodeConnectorIDType.OPENFLOW)) {
609 // We don't want to work on Node that are not openflow
613 Node dstNode = lt.getHeadNodeConnector().getNode();
614 if (switchNeedsTieringUpdate(dstNode, currentTier + 1)) {
615 Tier t = new Tier(currentTier + 1);
616 switchManager.setNodeProp(dstNode, t);
617 needsVisiting.add(dstNode);
622 * Due to the nature of the problem, having a separate loop for nodes
623 * that needs visiting provides a decent walk optimization.
625 for (Node node : needsVisiting) {
626 updateSwitchTiers(node, currentTier + 1);
631 * Internal convenience routine to check the eligibility of a Switch for a
632 * Tier update. Any Node with Tier=0 or a Tier value that is greater than
633 * the new Tier Value is eligible for the update.
636 * Node for which the Tier update eligibility is checked
639 * @return <code>true</code> if the Node is eligible for Tier Update
640 * <code>false</code> otherwise
643 private boolean switchNeedsTieringUpdate(Node n, int tier) {
645 logger.error("switchNeedsTieringUpdate(): Null node for tier: {}", tier);
649 * Node could have gone down
651 if (!switchManager.getNodes().contains(n)) {
654 // This is the case where Tier was never set for this node
655 Tier t = (Tier) switchManager.getNodeProp(n, Tier.TierPropName);
658 if (t.getValue() == 0)
660 else if (t.getValue() > tier)
666 * Internal convenience routine to clear all the Tier values to 0. This
667 * cleanup is performed during cases such as Topology Change where the
668 * existing Tier values might become incorrect
670 private void clearTiers() {
671 Set<Node> nodes = null;
672 if (switchManager == null) {
673 logger.error("clearTiers(): Null switchManager");
676 nodes = switchManager.getNodes();
678 for (Node n : nodes) {
679 Tier t = new Tier(0);
680 switchManager.setNodeProp(n, t);
685 * Internal convenience routine to print the hierarchies of switches.
687 @SuppressWarnings("unused")
688 private void logHierarchies(ArrayList<ArrayList<String>> hierarchies) {
689 String hierarchyString = null;
691 for (ArrayList<String> hierarchy : hierarchies) {
692 StringBuffer buf = new StringBuffer();
693 buf.append("Hierarchy#" + num + " : ");
694 for (String switchName : hierarchy) {
695 buf.append(switchName + "/");
697 logger.debug("{} -> {}", getContainerName(), buf);
703 * getHostNetworkHierarchy is the Back-end routine for the North-Bound API
704 * that returns the Network Hierarchy for a given Host. This API is
705 * typically used by applications like Hadoop for Rack Awareness
709 * IP-Address of the host/node.
710 * @return Network Hierarchies represented by an Array of Array (of
711 * Switch-Ids as String).
714 public List<List<String>> getHostNetworkHierarchy(InetAddress hostAddress) {
715 HostNodeConnector host = hostQuery(hostAddress);
719 List<List<String>> hierarchies = new ArrayList<List<String>>();
720 ArrayList<String> currHierarchy = new ArrayList<String>();
721 hierarchies.add(currHierarchy);
723 Node node = host.getnodeconnectorNode();
724 updateCurrentHierarchy(node, currHierarchy, hierarchies);
729 * dpidToHostNameHack is a hack function for Cisco Live Hadoop Demo. Mininet
730 * is used as the network for Hadoop Demos & in order to give a meaningful
731 * rack-awareness switch names, the DPID is organized in ASCII Characters
732 * and retrieved as string.
736 * @return Ascii String represented by the DPID.
738 private String dpidToHostNameHack(long dpid) {
739 String hex = Long.toHexString(dpid);
741 StringBuffer sb = new StringBuffer();
743 for (int i = 0; i < hex.length(); i++) {
744 result = (int) ((dpid >> (i * 8)) & 0xff);
749 sb.append(String.format("%c", result));
751 return sb.reverse().toString();
755 * A convenient recursive routine to obtain the Hierarchy of Switches.
758 * Current Node in the Recursive routine.
759 * @param currHierarchy
760 * Array of Nodes that make this hierarchy on which the Current
762 * @param fullHierarchy
763 * Array of multiple Hierarchies that represent a given host.
765 @SuppressWarnings("unchecked")
766 private void updateCurrentHierarchy(Node node, ArrayList<String> currHierarchy, List<List<String>> fullHierarchy) {
767 // currHierarchy.add(String.format("%x", currSw.getId()));
768 currHierarchy.add(dpidToHostNameHack((Long) node.getID()));
769 ArrayList<String> currHierarchyClone = (ArrayList<String>) currHierarchy.clone(); // Shallow
774 Map<Node, Set<Edge>> ndlinks = topologyManager.getNodeEdges();
775 if (ndlinks == null) {
776 logger.debug("updateCurrentHierarchy(): topologyManager returned null ndlinks for node: {}", node);
779 Node n = NodeCreator.createOFNode((Long) node.getID());
780 Set<Edge> links = ndlinks.get(n);
782 logger.debug("updateCurrentHierarchy(): Null links for ndlinks");
785 for (Edge lt : links) {
786 if (!lt.getHeadNodeConnector().getType().equals(NodeConnector.NodeConnectorIDType.OPENFLOW)) {
787 // We don't want to work on Node that are not openflow
791 Node dstNode = lt.getHeadNodeConnector().getNode();
793 Tier nodeTier = (Tier) switchManager.getNodeProp(node, Tier.TierPropName);
794 Tier dstNodeTier = (Tier) switchManager.getNodeProp(dstNode, Tier.TierPropName);
795 if (dstNodeTier.getValue() > nodeTier.getValue()) {
796 ArrayList<String> buildHierarchy = currHierarchy;
797 if (currHierarchy.size() > currHierarchyClone.size()) {
798 buildHierarchy = (ArrayList<String>) currHierarchyClone.clone(); // Shallow
802 fullHierarchy.add(buildHierarchy);
804 updateCurrentHierarchy(dstNode, buildHierarchy, fullHierarchy);
809 private void edgeUpdate(Edge e, UpdateType type, Set<Property> props) {
811 Short srcPort = null;
813 Short dstPort = null;
814 boolean added = false;
815 String srcType = null;
816 String dstType = null;
818 if (e == null || type == null) {
819 logger.error("Edge or Update type are null!");
822 srcType = e.getTailNodeConnector().getType();
823 dstType = e.getHeadNodeConnector().getType();
825 if (srcType.equals(NodeConnector.NodeConnectorIDType.PRODUCTION)) {
826 logger.debug("Skip updates for {}", e);
830 if (!srcType.equals(NodeConnector.NodeConnectorIDType.OPENFLOW)) {
831 logger.error("For now we cannot handle updates for " + "non-openflow nodes");
835 if (dstType.equals(NodeConnector.NodeConnectorIDType.PRODUCTION)) {
836 logger.debug("Skip updates for {}", e);
840 if (!dstType.equals(NodeConnector.NodeConnectorIDType.OPENFLOW)) {
841 logger.error("For now we cannot handle updates for " + "non-openflow nodes");
845 // At this point we know we got an openflow update, so
846 // lets fill everything accordingly.
847 srcNid = (Long) e.getTailNodeConnector().getNode().getID();
848 srcPort = (Short) e.getTailNodeConnector().getID();
849 dstNid = (Long) e.getHeadNodeConnector().getNode().getID();
850 dstPort = (Short) e.getHeadNodeConnector().getID();
852 // Now lets update the added flag
863 logger.debug("HostTracker Topology linkUpdate handling src:{}[port {}] dst:{}[port {}] added: {}",
864 new Object[] { srcNid, srcPort, dstNid, dstPort, added });
868 public void edgeUpdate(List<TopoEdgeUpdate> topoedgeupdateList) {
869 for (int i = 0; i < topoedgeupdateList.size(); i++) {
870 Edge e = topoedgeupdateList.get(i).getEdge();
871 Set<Property> p = topoedgeupdateList.get(i).getProperty();
872 UpdateType type = topoedgeupdateList.get(i).getUpdateType();
873 edgeUpdate(e, type, p);
878 public void subnetNotify(Subnet sub, boolean add) {
879 logger.debug("Received subnet notification: {} add={}", sub, add);
881 for (int i = 0; i < failedARPReqList.size(); i++) {
883 arphost = failedARPReqList.get(i);
884 logger.debug("Sending the ARP from FailedARPReqList fors IP: {}", arphost.getHostIP().getHostAddress());
885 hostFinder.find(arphost.getHostIP());
890 class OutStandingARPHandler extends TimerTask {
894 /* This routine runs every 4 seconds */
895 // logger.info ("ARP Handler called");
896 for (int i = 0; i < ARPPendingList.size(); i++) {
897 arphost = ARPPendingList.get(i);
898 if (arphost.getSent_count() < switchManager.getHostRetryCount()) {
900 * No reply has been received of first ARP Req, send the
903 hostFinder.find(arphost.getHostIP());
904 arphost.sent_count++;
905 logger.debug("ARP Sent from ARPPending List, IP: {}", arphost.getHostIP().getHostAddress());
906 } else if (arphost.getSent_count() >= switchManager.getHostRetryCount()) {
908 * Two ARP requests have been sent without receiving a
909 * reply, remove this from the pending list
911 removePendingARPFromList(i);
912 logger.debug("ARP reply not received after two attempts, removing from Pending List IP: {}",
913 arphost.getHostIP().getHostAddress());
915 * Add this host to a different list which will be processed
918 logger.debug("Adding the host to FailedARPReqList IP: {}", arphost.getHostIP().getHostAddress());
919 failedARPReqList.add(arphost);
922 logger.error("Inavlid arp_sent count for entery at index: {}", i);
928 private class ARPRefreshHandler extends TimerTask {
930 @SuppressWarnings("deprecation")
932 if ((clusterContainerService != null) && !clusterContainerService.amICoordinator()) {
935 if ((switchManager != null) && !switchManager.isHostRefreshEnabled()) {
937 * The host probe procedure was disabled by CLI
941 if (hostsDB == null) {
942 /* hostsDB is not allocated yet */
943 logger.error("ARPRefreshHandler(): hostsDB is not allocated yet:");
946 for (Entry<InetAddress, HostNodeConnector> entry : hostsDB.entrySet()) {
947 HostNodeConnector host = entry.getValue();
948 if (host.isStaticHost()) {
949 /* this host was learned via API3, don't age it out */
953 short arp_cntdown = host.getArpSendCountDown();
955 if (arp_cntdown > switchManager.getHostRetryCount()) {
956 host.setArpSendCountDown(arp_cntdown);
957 } else if (arp_cntdown <= 0) {
959 * No ARP Reply received in last 2 minutes, remove this host
960 * and inform applications
962 removeKnownHost(entry.getKey());
963 notifyHostLearnedOrRemoved(host, false);
964 } else if (arp_cntdown <= switchManager.getHostRetryCount()) {
966 * Use the services of arphandler to check if host is still
969 if (logger.isTraceEnabled()) {
971 "ARP Probing ({}) for {}({})",
972 new Object[] { arp_cntdown, host.getNetworkAddress().getHostAddress(),
973 HexEncode.bytesToHexString(host.getDataLayerAddressBytes()) });
975 host.setArpSendCountDown(arp_cntdown);
976 hostFinder.probe(host);
983 * Inform the controller IP to MAC binding of a host and its connectivity to
984 * an openflow switch in terms of Node, port, and VLAN.
987 * IP address of the host
989 * Address MAC address of the host
991 * NodeConnector to which host is connected
993 * Port of the switch to which host is connected
995 * Vlan of which this host is member of
997 * @return Status The status object as described in {@code Status}
998 * indicating the result of this action.
1001 public Status addStaticHostReq(InetAddress networkAddr, byte[] dataLayerAddress, NodeConnector nc, short vlan) {
1002 if (dataLayerAddress.length != NetUtils.MACAddrLengthInBytes) {
1003 return new Status(StatusCode.BADREQUEST, "Invalid MAC address");
1007 return new Status(StatusCode.BADREQUEST, "Invalid NodeConnector");
1009 HostNodeConnector host = null;
1011 host = new HostNodeConnector(dataLayerAddress, networkAddr, nc, vlan);
1012 if (hostExists(host)) {
1013 // This host is already learned either via ARP or through a
1014 // northbound request
1015 HostNodeConnector transHost = hostsDB.get(networkAddr);
1016 transHost.setStaticHost(true);
1017 return new Status(StatusCode.SUCCESS, null);
1020 if (hostsDB.get(networkAddr) != null) {
1021 // There is already a host with this IP address (but behind
1022 // a different (switch, port, vlan) tuple. Return an error
1023 return new Status(StatusCode.CONFLICT, "Existing IP, Use PUT to update");
1025 host.setStaticHost(true);
1027 * Check if the nc is an ISL port
1029 if (topologyManager != null) {
1030 if (topologyManager.isInternal(nc)) {
1031 return new Status(StatusCode.BADREQUEST, "Cannot add host on ISL port");
1035 * Before adding host, Check if the switch and the port have already
1038 if (switchManager.isNodeConnectorEnabled(nc)) {
1040 notifyHostLearnedOrRemoved(host, true);
1042 inactiveStaticHosts.put(nc, host);
1043 logger.debug("Switch or switchport is not up, adding host {} to inactive list",
1044 networkAddr.getHostName());
1046 return new Status(StatusCode.SUCCESS, null);
1047 } catch (ConstructionException e) {
1048 logger.error("", e);
1049 return new Status(StatusCode.INTERNALERROR, "Host could not be created");
1055 * Update the controller IP to MAC binding of a host and its connectivity to
1056 * an openflow switch in terms of switch id, switch port, and VLAN.
1058 * @param networkAddr
1059 * IP address of the host
1061 * Address MAC address of the host
1063 * NodeConnector to which host is connected
1065 * Port of the switch to which host is connected
1067 * Vlan of which this host is member of
1069 * @return Status The status object as described in {@code Status}
1070 * indicating the result of this action.
1072 public Status updateHostReq(InetAddress networkAddr, byte[] dataLayerAddress, NodeConnector nc, short vlan) {
1073 HostNodeConnector tobeUpdatedHost;
1074 HostNodeConnector host = null;
1076 if (dataLayerAddress.length != NetUtils.MACAddrLengthInBytes) {
1077 return new Status(StatusCode.BADREQUEST, "Invalid MAC address");
1081 return new Status(StatusCode.BADREQUEST, "Invalid NodeConnector");
1085 host = new HostNodeConnector(dataLayerAddress, networkAddr, nc, vlan);
1086 if (hostExists(host)) {
1087 return new Status(StatusCode.BADREQUEST, "Host already exists");
1090 if ((tobeUpdatedHost = hostsDB.get(networkAddr)) != null) {
1091 if (hostsDB.replace(networkAddr, tobeUpdatedHost, host)) {
1092 logger.debug("Host replaced from hostsDB. Old host: {} New Host: {}", tobeUpdatedHost, host);
1093 notifyHostLearnedOrRemoved(tobeUpdatedHost, false);
1094 notifyHostLearnedOrRemoved(host, true);
1095 return new Status(StatusCode.SUCCESS);
1097 logger.error("Static host replacement failed from hostsDB, Replaced Host: {}, New Host: {}",
1098 tobeUpdatedHost, host);
1099 return new Status(StatusCode.INTERNALERROR,
1100 "Host Replacement Failed due to presence of another host with same IP");
1104 // Check if the host exists in inactive hosts database
1105 if ((tobeUpdatedHost = inactiveStaticHosts.get(nc)) != null) {
1106 if (inactiveStaticHosts.replace(nc, tobeUpdatedHost, host)) {
1107 logger.debug("Host replaced from inactive hostsDB. Old host: {} New Host: {}", tobeUpdatedHost,
1109 return new Status(StatusCode.SUCCESS);
1111 logger.error("Static host replacement failed, Replaced Host: {}, New Host: {}", tobeUpdatedHost,
1113 return new Status(StatusCode.INTERNALERROR,
1114 "Host Replacement Failed due to presence of another host with same IP");
1118 // Host doesn't exist
1119 return new Status(StatusCode.BADREQUEST, "Host doesn't exists, can't update");
1120 } catch (ConstructionException e) {
1121 logger.error("", e);
1122 return new Status(StatusCode.INTERNALERROR, "host object creation failure");
1127 * Remove from the controller IP to MAC binding of a host and its
1128 * connectivity to an openflow switch
1130 * @param networkAddr
1131 * IP address of the host
1133 * @return boolean true if the host was removed successfully, false
1137 public Status removeStaticHostReq(InetAddress networkAddress) {
1138 // Check if host is in active hosts database
1139 HostNodeConnector host = getHostFromOnActiveDB(networkAddress);
1142 if (!host.isStaticHost()) {
1143 return new Status(StatusCode.FORBIDDEN, "Host " + networkAddress.getHostName() + " is not static");
1145 // Remove and notify
1146 notifyHostLearnedOrRemoved(host, false);
1147 removeKnownHost(networkAddress);
1148 return new Status(StatusCode.SUCCESS, null);
1151 // Check if host is in inactive hosts database
1152 Entry<NodeConnector, HostNodeConnector> entry = getHostFromInactiveDB(networkAddress);
1153 if (entry != null) {
1154 host = entry.getValue();
1156 if (!host.isStaticHost()) {
1157 return new Status(StatusCode.FORBIDDEN, "Host " + networkAddress.getHostName() + " is not static");
1159 this.removeHostFromInactiveDB(networkAddress);
1160 return new Status(StatusCode.SUCCESS, null);
1163 // Host is neither in active nor inactive hosts database
1164 return new Status(StatusCode.NOTFOUND, "Host does not exist");
1168 public void modeChangeNotify(Node node, boolean proactive) {
1169 logger.debug("Set Switch {} Mode to {}", node.getID(), proactive);
1173 public void notifyNode(Node node, UpdateType type, Map<String, Property> propMap) {
1179 logger.debug("Received removed node {}", node);
1180 for (Entry<InetAddress, HostNodeConnector> entry : hostsDB.entrySet()) {
1181 HostNodeConnector host = entry.getValue();
1182 if (host.getnodeconnectorNode().equals(node)) {
1183 logger.debug("Node: {} is down, remove from Hosts_DB", node);
1184 removeKnownHost(entry.getKey());
1185 notifyHostLearnedOrRemoved(host, false);
1195 public void notifyNodeConnector(NodeConnector nodeConnector, UpdateType type, Map<String, Property> propMap) {
1196 if (nodeConnector == null)
1207 State state = (State) propMap.get(State.StatePropName);
1208 if ((state != null) && (state.getValue() == State.EDGE_UP)) {
1217 handleNodeConnectorStatusUp(nodeConnector);
1219 handleNodeConnectorStatusDown(nodeConnector);
1224 public Status addStaticHost(String networkAddress, String dataLayerAddress, NodeConnector nc, String vlan) {
1226 InetAddress ip = InetAddress.getByName(networkAddress);
1228 return new Status(StatusCode.BADREQUEST, "Invalid NodeId");
1230 return addStaticHostReq(ip, HexEncode.bytesFromHexString(dataLayerAddress), nc, Short.valueOf(vlan));
1231 } catch (UnknownHostException e) {
1232 logger.error("", e);
1233 return new Status(StatusCode.BADREQUEST, "Invalid Address");
1238 public Status removeStaticHost(String networkAddress) {
1239 InetAddress address;
1241 address = InetAddress.getByName(networkAddress);
1242 return removeStaticHostReq(address);
1243 } catch (UnknownHostException e) {
1244 logger.error("", e);
1245 return new Status(StatusCode.BADREQUEST, "Invalid Address");
1249 private void handleNodeConnectorStatusUp(NodeConnector nodeConnector) {
1252 logger.debug("handleNodeConnectorStatusUp {}", nodeConnector);
1254 for (int i = 0; i < failedARPReqList.size(); i++) {
1255 arphost = failedARPReqList.get(i);
1256 logger.debug("Sending the ARP from FailedARPReqList fors IP: {}", arphost.getHostIP().getHostAddress());
1257 hostFinder.find(arphost.getHostIP());
1259 HostNodeConnector host = inactiveStaticHosts.get(nodeConnector);
1261 inactiveStaticHosts.remove(nodeConnector);
1263 notifyHostLearnedOrRemoved(host, true);
1267 private void handleNodeConnectorStatusDown(NodeConnector nodeConnector) {
1268 logger.debug("handleNodeConnectorStatusDown {}", nodeConnector);
1270 for (Entry<InetAddress, HostNodeConnector> entry : hostsDB.entrySet()) {
1271 HostNodeConnector host = entry.getValue();
1272 if (host.getnodeConnector().equals(nodeConnector)) {
1273 logger.debug(" NodeConnector: {} is down, remove from Hosts_DB", nodeConnector);
1274 removeKnownHost(entry.getKey());
1275 notifyHostLearnedOrRemoved(host, false);
1280 void setClusterContainerService(IClusterContainerServices s) {
1281 logger.debug("Cluster Service set");
1282 this.clusterContainerService = s;
1285 void unsetClusterContainerService(IClusterContainerServices s) {
1286 if (this.clusterContainerService == s) {
1287 logger.debug("Cluster Service removed!");
1288 this.clusterContainerService = null;
1292 void setSwitchManager(ISwitchManager s) {
1293 logger.debug("SwitchManager set");
1294 this.switchManager = s;
1297 void unsetSwitchManager(ISwitchManager s) {
1298 if (this.switchManager == s) {
1299 logger.debug("SwitchManager removed!");
1300 this.switchManager = null;
1304 public String getContainerName() {
1305 if (containerName == null)
1306 return GlobalConstants.DEFAULT.toString();
1307 return containerName;
1311 * Function called by the dependency manager when all the required
1312 * dependencies are satisfied
1315 void init(Component c) {
1316 Dictionary<?, ?> props = c.getServiceProperties();
1317 if (props != null) {
1318 this.containerName = (String) props.get("containerName");
1319 logger.debug("Running containerName: {}", this.containerName);
1321 // In the Global instance case the containerName is empty
1322 this.containerName = "";
1328 * Function called by the dependency manager when at least one dependency
1329 * become unsatisfied or when the component is shutting down because for
1330 * example bundle is being stopped.
1337 * Function called by dependency manager after "init ()" is called and after
1338 * the services provided by the class are registered in the service registry
1345 * Function called by the dependency manager before the services exported by
1346 * the component are unregistered, this will be followed by a "destroy ()"
1351 executor.shutdown();
1355 public void edgeOverUtilized(Edge edge) {
1356 // TODO Auto-generated method stub
1361 public void edgeUtilBackToNormal(Edge edge) {
1362 // TODO Auto-generated method stub