OpenFlow Protocol_plugin changes to make use of the Connection Manager infrastructure...
[controller.git] / opendaylight / protocol_plugins / openflow / src / main / java / org / opendaylight / controller / protocol_plugin / openflow / internal / DiscoveryService.java
index 0cbaf67d9ed9452afc0927de7b9b487547663713..bb303e3651de7e3a95659641cf001da4b0153bb4 100644 (file)
@@ -8,8 +8,10 @@
 
 package org.opendaylight.controller.protocol_plugin.openflow.internal;
 
+import java.nio.charset.Charset;
 import java.util.ArrayList;
 import java.util.Collection;
+import java.util.Collections;
 import java.util.HashSet;
 import java.util.List;
 import java.util.Map;
@@ -26,6 +28,8 @@ import org.eclipse.osgi.framework.console.CommandInterpreter;
 import org.eclipse.osgi.framework.console.CommandProvider;
 import org.opendaylight.controller.protocol_plugin.openflow.IDataPacketListen;
 import org.opendaylight.controller.protocol_plugin.openflow.IDataPacketMux;
+import org.opendaylight.controller.protocol_plugin.openflow.IDiscoveryListener;
+import org.opendaylight.controller.protocol_plugin.openflow.IInventoryProvider;
 import org.opendaylight.controller.protocol_plugin.openflow.IInventoryShimExternalListener;
 import org.opendaylight.controller.protocol_plugin.openflow.core.IController;
 import org.opendaylight.controller.protocol_plugin.openflow.core.ISwitch;
@@ -35,6 +39,7 @@ import org.osgi.framework.FrameworkUtil;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import org.opendaylight.controller.sal.connection.IPluginOutConnectionService;
 import org.opendaylight.controller.sal.core.Config;
 import org.opendaylight.controller.sal.core.ConstructionException;
 import org.opendaylight.controller.sal.core.Edge;
@@ -45,8 +50,6 @@ import org.opendaylight.controller.sal.core.NodeConnector;
 import org.opendaylight.controller.sal.core.Property;
 import org.opendaylight.controller.sal.core.State;
 import org.opendaylight.controller.sal.core.UpdateType;
-import org.opendaylight.controller.sal.discovery.IDiscoveryService;
-import org.opendaylight.controller.sal.inventory.IPluginInInventoryService;
 import org.opendaylight.controller.sal.packet.Ethernet;
 import org.opendaylight.controller.sal.packet.LLDP;
 import org.opendaylight.controller.sal.packet.LLDPTLV;
@@ -58,81 +61,75 @@ import org.opendaylight.controller.sal.utils.HexEncode;
 import org.opendaylight.controller.sal.utils.NetUtils;
 import org.opendaylight.controller.sal.utils.NodeConnectorCreator;
 import org.opendaylight.controller.sal.utils.NodeCreator;
+import org.opendaylight.controller.sal.utils.Status;
+import org.opendaylight.controller.sal.utils.StatusCode;
 
 /**
  * The class describes neighbor discovery service for an OpenFlow network.
  */
-public class DiscoveryService implements IInventoryShimExternalListener,
-        IDataPacketListen, IContainerListener, CommandProvider {
-    private static Logger logger = LoggerFactory
-            .getLogger(DiscoveryService.class);
+public class DiscoveryService implements IInventoryShimExternalListener, IDataPacketListen, IContainerListener,
+        CommandProvider {
+    private static Logger logger = LoggerFactory.getLogger(DiscoveryService.class);
     private IController controller = null;
-    private IDiscoveryService discoveryService = null;
-    private IPluginInInventoryService pluginInInventoryService = null;
+    private IDiscoveryListener discoveryListener = null;
+    private IInventoryProvider inventoryProvider = null;
     private IDataPacketMux iDataPacketMux = null;
-
-    private List<NodeConnector> readyListHi = null; // newly added ports go into
-                                                    // this list and will be
-                                                    // served first
-    private List<NodeConnector> readyListLo = null; // come here after served at
-                                                    // least once
-    private List<NodeConnector> waitingList = null; // staging area during quiet
-                                                    // period
-    private ConcurrentMap<NodeConnector, Integer> pendingMap = null;// wait for
-                                                                    // response
-                                                                    // back
-    private ConcurrentMap<NodeConnector, Edge> edgeMap = null; // openflow edges
-                                                               // keyed by head
-                                                               // connector
-    private ConcurrentMap<NodeConnector, Integer> agingMap = null; // aging
-                                                                   // entries
-                                                                   // keyed by
-                                                                   // edge port
-    private ConcurrentMap<NodeConnector, Edge> prodMap = null; // production
-                                                               // edges keyed by
-                                                               // edge port
-
-    private Timer discoveryTimer; // discovery timer
-    private DiscoveryTimerTask discoveryTimerTask; // timer task
-    private long discoveryTimerTick = 1L * 1000; // per tick in msec
+    // High priority list containing newly added ports which will be served first
+    private List<NodeConnector> readyListHi = null;
+    // List containing all the ports which will be served periodically
+    private List<NodeConnector> readyListLo = null;
+    // Staging area during quiet period
+    private List<NodeConnector> stagingList = null;
+    // Wait for next discovery packet. The map contains the time elapsed since
+    // the last received LLDP frame on each node connector
+    private ConcurrentMap<NodeConnector, Integer> holdTime = null;
+    // Allow one more retry for newly added ports. This map contains the time
+    // period elapsed since last discovery pkt transmission on the port.
+    private ConcurrentMap<NodeConnector, Integer> elapsedTime = null;
+    // OpenFlow edges keyed by head connector
+    private ConcurrentMap<NodeConnector, Edge> edgeMap = null;
+    // The map contains aging entry keyed by head connector of Production edge
+    private ConcurrentMap<NodeConnector, Integer> agingMap = null;
+    // Production edges keyed by head connector
+    private ConcurrentMap<NodeConnector, Edge> prodMap = null;
+
+    private Timer discoveryTimer;
+    private DiscoveryTimerTask discoveryTimerTask;
+    private final static long discoveryTimerTick = 2L * 1000; // per tick in msec
     private int discoveryTimerTickCount = 0; // main tick counter
-    private int discoveryBatchMaxPorts = 500; // max # of ports handled in one
-                                              // batch
-    private int discoveryBatchRestartTicks = getDiscoveryInterval(); // periodically
-                                                                     // restart
-                                                                     // batching
-                                                                     // process
-    private int discoveryBatchPausePeriod = 5; // pause for few secs
-    private int discoveryBatchPauseTicks = discoveryBatchRestartTicks
-            - discoveryBatchPausePeriod; // pause after this point
-    private int discoveryRetry = getDiscoveryRetry(); // number of retries after
-                                                      // initial timeout
-    private int discoveryTimeoutTicks = getDiscoveryTimeout(); // timeout in sec
-    private int discoveryAgeoutTicks = 120; // age out 2 min
-    private int discoveryConsistencyCheckMultiple = 2; // multiple of
-                                                       // discoveryBatchRestartTicks
-    private int discoveryConsistencyCheckTickCount = discoveryBatchPauseTicks; // CC
-                                                                               // tick
-                                                                               // counter
-    private int discoveryConsistencyCheckCallingTimes = 0; // # of times CC gets
-                                                           // called
-    private int discoveryConsistencyCheckCorrected = 0; // # of cases CC
-                                                        // corrected
-    private boolean discoveryConsistencyCheckEnabled = true;// enable or disable
-                                                            // CC
-    private boolean discoveryAgingEnabled = true; // enable or disable aging
-    private boolean discoverySnoopingEnabled = true; // global flag to enable or
-                                                     // disable LLDP snooping
-    private List<NodeConnector> discoverySnoopingDisableList; // the list of
-                                                              // ports that will
-                                                              // not do LLDP
-                                                              // snooping
+    // Max # of ports handled in one batch
+    private int discoveryBatchMaxPorts;
+    // Periodically restart batching process
+    private int discoveryBatchRestartTicks;
+    private int discoveryBatchPausePeriod = 2;
+    // Pause after this point
+    private int discoveryBatchPauseTicks;
+    private int discoveryTimeoutTicks;
+    private int discoveryThresholdTicks;
+    private int discoveryAgeoutTicks;
+    // multiple of discoveryBatchRestartTicks
+    private int discoveryConsistencyCheckMultiple = 2;
+    // CC tick counter
+    private int discoveryConsistencyCheckTickCount;
+    // # of times CC gets called
+    private int discoveryConsistencyCheckCallingTimes = 0;
+    // # of cases CC corrected
+    private int discoveryConsistencyCheckCorrected = 0;
+    // Enable or disable CC
+    private boolean discoveryConsistencyCheckEnabled = true;
+    // Enable or disable aging
+    private boolean discoveryAgingEnabled = true;
+    // Global flag to enable or disable LLDP snooping
+    private boolean discoverySnoopingEnabled = true;
+    // The list of ports that will not do LLDP snooping
+    private List<NodeConnector> discoverySnoopingDisableList;
     private BlockingQueue<NodeConnector> transmitQ;
     private Thread transmitThread;
     private Boolean throttling = false; // if true, no more batching.
     private volatile Boolean shuttingDown = false;
 
     private LLDPTLV chassisIdTlv, portIdTlv, ttlTlv, customTlv;
+    private IPluginOutConnectionService connectionOutService;
 
     class DiscoveryTransmit implements Runnable {
         private final BlockingQueue<NodeConnector> transmitQ;
@@ -141,6 +138,7 @@ public class DiscoveryService implements IInventoryShimExternalListener,
             this.transmitQ = transmitQ;
         }
 
+        @Override
         public void run() {
             while (true) {
                 try {
@@ -150,8 +148,9 @@ public class DiscoveryService implements IInventoryShimExternalListener,
                     nodeConnector = null;
                 } catch (InterruptedException e1) {
                     logger.warn("DiscoveryTransmit interupted", e1.getMessage());
-                    if (shuttingDown)
+                    if (shuttingDown) {
                         return;
+                    }
                 } catch (Exception e2) {
                     logger.error("", e2);
                 }
@@ -160,6 +159,7 @@ public class DiscoveryService implements IInventoryShimExternalListener,
     }
 
     class DiscoveryTimerTask extends TimerTask {
+        @Override
         public void run() {
             checkTimeout();
             checkAging();
@@ -168,26 +168,63 @@ public class DiscoveryService implements IInventoryShimExternalListener,
         }
     }
 
+    public enum DiscoveryPeriod {
+        INTERVAL        (300),
+        AGEOUT          (120),
+        THRESHOLD       (30);
+
+        private int time;   // sec
+        private int tick;   // tick
+
+        DiscoveryPeriod(int time) {
+            this.time = time;
+            this.tick = time2Tick(time);
+        }
+
+        public int getTime() {
+            return time;
+        }
+
+        public void setTime(int time) {
+            this.time = time;
+            this.tick = time2Tick(time);
+        }
+
+        public int getTick() {
+            return tick;
+        }
+
+        public void setTick(int tick) {
+            this.time = tick2Time(tick);
+            this.tick = tick;
+        }
+
+        private int time2Tick(int time) {
+            return (int) (time / (discoveryTimerTick / 1000));
+        }
+
+        private int tick2Time(int tick) {
+            return (int) (tick * (discoveryTimerTick / 1000));
+        }
+    }
+
     private RawPacket createDiscoveryPacket(NodeConnector nodeConnector) {
-        String nodeId = HexEncode.longToHexString((Long) nodeConnector
-                .getNode().getID());
+        String nodeId = HexEncode.longToHexString((Long) nodeConnector.getNode().getID());
 
         // Create LLDP ChassisID TLV
         byte[] cidValue = LLDPTLV.createChassisIDTLVValue(nodeId);
-        chassisIdTlv.setType((byte) LLDPTLV.TLVType.ChassisID.getValue())
-                .setLength((short) cidValue.length).setValue(cidValue);
+        chassisIdTlv.setType(LLDPTLV.TLVType.ChassisID.getValue()).setLength((short) cidValue.length)
+                .setValue(cidValue);
 
         // Create LLDP PortID TLV
         String portId = nodeConnector.getNodeConnectorIDString();
         byte[] pidValue = LLDPTLV.createPortIDTLVValue(portId);
-        portIdTlv.setType((byte) LLDPTLV.TLVType.PortID.getValue())
-                .setLength((short) pidValue.length).setValue(pidValue);
+        portIdTlv.setType(LLDPTLV.TLVType.PortID.getValue()).setLength((short) pidValue.length).setValue(pidValue);
 
         // Create LLDP Custom TLV
-        byte[] customValue = LLDPTLV.createCustomTLVValue(nodeConnector
-                .toString());
-        customTlv.setType((byte) LLDPTLV.TLVType.Custom.getValue())
-                .setLength((short) customValue.length).setValue(customValue);
+        byte[] customValue = LLDPTLV.createCustomTLVValue(nodeConnector.toString());
+        customTlv.setType(LLDPTLV.TLVType.Custom.getValue()).setLength((short) customValue.length)
+                .setValue(customValue);
 
         // Create LLDP Custom Option list
         List<LLDPTLV> customList = new ArrayList<LLDPTLV>();
@@ -195,25 +232,21 @@ public class DiscoveryService implements IInventoryShimExternalListener,
 
         // Create discovery pkt
         LLDP discoveryPkt = new LLDP();
-        discoveryPkt.setChassisId(chassisIdTlv).setPortId(portIdTlv)
-                .setTtl(ttlTlv).setOptionalTLVList(customList);
+        discoveryPkt.setChassisId(chassisIdTlv).setPortId(portIdTlv).setTtl(ttlTlv).setOptionalTLVList(customList);
 
         RawPacket rawPkt = null;
         try {
             // Create ethernet pkt
-            byte[] sourceMac = getSouceMACFromNodeID(nodeId);
+            byte[] sourceMac = getSourceMACFromNodeID(nodeId);
             Ethernet ethPkt = new Ethernet();
-            ethPkt.setSourceMACAddress(sourceMac)
-                    .setDestinationMACAddress(LLDP.LLDPMulticastMac)
-                    .setEtherType(EtherTypes.LLDP.shortValue())
-                    .setPayload(discoveryPkt);
+            ethPkt.setSourceMACAddress(sourceMac).setDestinationMACAddress(LLDP.LLDPMulticastMac)
+                    .setEtherType(EtherTypes.LLDP.shortValue()).setPayload(discoveryPkt);
 
             byte[] data = ethPkt.serialize();
             rawPkt = new RawPacket(data);
             rawPkt.setOutgoingNodeConnector(nodeConnector);
         } catch (ConstructionException cex) {
-            logger.warn("RawPacket creation caught exception {}",
-                    cex.getMessage());
+            logger.warn("RawPacket creation caught exception {}", cex.getMessage());
         } catch (Exception e) {
             logger.error("Failed to serialize the LLDP packet: " + e);
         }
@@ -221,13 +254,17 @@ public class DiscoveryService implements IInventoryShimExternalListener,
         return rawPkt;
     }
 
-    private void sendDiscoveryPacket(NodeConnector nodeConnector,
-            RawPacket outPkt) {
+    private void sendDiscoveryPacket(NodeConnector nodeConnector, RawPacket outPkt) {
         if (nodeConnector == null) {
             logger.debug("Can not send discovery packet out since nodeConnector is null");
             return;
         }
 
+        if (!connectionOutService.isLocal(nodeConnector.getNode())) {
+            logger.debug("Discoery packets will not be sent to {} in a non-master controller", nodeConnector.toString());
+            return;
+        }
+
         if (outPkt == null) {
             logger.debug("Can not send discovery packet out since outPkt is null");
             return;
@@ -237,16 +274,12 @@ public class DiscoveryService implements IInventoryShimExternalListener,
         ISwitch sw = controller.getSwitches().get(sid);
 
         if (sw == null) {
-            logger.debug(
-                    "Can not send discovery packet out since switch {} is null",
-                    sid);
+            logger.debug("Can not send discovery packet out since switch {} is null", sid);
             return;
         }
 
         if (!sw.isOperational()) {
-            logger.debug(
-                    "Can not send discovery packet out since switch {} is not operational",
-                    sw);
+            logger.debug("Can not send discovery packet out since switch {} is not operational", sw);
             return;
         }
 
@@ -277,26 +310,31 @@ public class DiscoveryService implements IInventoryShimExternalListener,
             return PacketResult.IGNORED;
         }
 
-        if (((Short) inPkt.getIncomingNodeConnector().getID())
-                .equals(NodeConnector.SPECIALNODECONNECTORID)) {
+        NodeConnector nodeConnector = inPkt.getIncomingNodeConnector();
+        if (((Short) nodeConnector.getID()).equals(NodeConnector.SPECIALNODECONNECTORID)) {
             logger.trace("Ignoring ethernet packet received on special port: "
                     + inPkt.getIncomingNodeConnector().toString());
             return PacketResult.IGNORED;
         }
 
+        if (!connectionOutService.isLocal(nodeConnector.getNode())) {
+            logger.debug("Discoery packets will not be processed from {} in a non-master controller", nodeConnector.toString());
+            return PacketResult.IGNORED;
+        }
+
         Ethernet ethPkt = new Ethernet();
         try {
             ethPkt.deserialize(data, 0, data.length * NetUtils.NumBitsInAByte);
         } catch (Exception e) {
-            logger.warn("Failed to decode LLDP packet from {}: {}",
-                    inPkt.getIncomingNodeConnector(), e);
+            logger.warn("Failed to decode LLDP packet from {}: {}", inPkt.getIncomingNodeConnector(), e);
             return PacketResult.IGNORED;
         }
+
         if (ethPkt.getPayload() instanceof LLDP) {
             NodeConnector dst = inPkt.getIncomingNodeConnector();
             if (isEnabled(dst)) {
                 if (!processDiscoveryPacket(dst, ethPkt)) {
-                    /* Snoop the discovery pkt if not generated from us */
+                    // Snoop the discovery pkt if not generated from us
                     snoopDiscoveryPacket(dst, ethPkt);
                 }
                 return PacketResult.CONSUME;
@@ -309,13 +347,9 @@ public class DiscoveryService implements IInventoryShimExternalListener,
      * Snoop incoming discovery frames generated by the production network
      * neighbor switch
      */
-    private void snoopDiscoveryPacket(NodeConnector dstNodeConnector,
-            Ethernet ethPkt) {
-        if (!this.discoverySnoopingEnabled
-                || discoverySnoopingDisableList.contains(dstNodeConnector)) {
-            logger.trace(
-                    "Discarded received discovery packet on {} since snooping is turned off",
-                    dstNodeConnector);
+    private void snoopDiscoveryPacket(NodeConnector dstNodeConnector, Ethernet ethPkt) {
+        if (!this.discoverySnoopingEnabled || discoverySnoopingDisableList.contains(dstNodeConnector)) {
+            logger.trace("Discarded received discovery packet on {} since snooping is turned off", dstNodeConnector);
             return;
         }
 
@@ -327,10 +361,8 @@ public class DiscoveryService implements IInventoryShimExternalListener,
         LLDP lldp = (LLDP) ethPkt.getPayload();
 
         try {
-            String nodeId = LLDPTLV.getHexStringValue(lldp.getChassisId()
-                    .getValue(), lldp.getChassisId().getLength());
-            String portId = LLDPTLV.getStringValue(lldp.getPortId().getValue(),
-                    lldp.getPortId().getLength());
+            String nodeId = LLDPTLV.getHexStringValue(lldp.getChassisId().getValue(), lldp.getChassisId().getLength());
+            String portId = LLDPTLV.getStringValue(lldp.getPortId().getValue(), lldp.getPortId().getLength());
             byte[] systemNameBytes = null;
             // get system name if present in the LLDP pkt
             for (LLDPTLV lldptlv : lldp.getOptionalTLVList()) {
@@ -339,13 +371,11 @@ public class DiscoveryService implements IInventoryShimExternalListener,
                     break;
                 }
             }
-            String nodeName = (systemNameBytes == null) ? nodeId : new String(
-                    systemNameBytes);
+            String nodeName = (systemNameBytes == null) ? nodeId
+                    : new String(systemNameBytes, Charset.defaultCharset());
             Node srcNode = new Node(Node.NodeIDType.PRODUCTION, nodeName);
-            NodeConnector srcNodeConnector = NodeConnectorCreator
-                    .createNodeConnector(
-                            NodeConnector.NodeConnectorIDType.PRODUCTION,
-                            portId, srcNode);
+            NodeConnector srcNodeConnector = NodeConnectorCreator.createNodeConnector(
+                    NodeConnector.NodeConnectorIDType.PRODUCTION, portId, srcNode);
 
             Edge edge = null;
             Set<Property> props = null;
@@ -360,25 +390,22 @@ public class DiscoveryService implements IInventoryShimExternalListener,
 
     /*
      * Handle discovery frames generated by our controller
-     * 
+     *
      * @return true if it's a success
      */
-    private boolean processDiscoveryPacket(NodeConnector dstNodeConnector,
-            Ethernet ethPkt) {
+    private boolean processDiscoveryPacket(NodeConnector dstNodeConnector, Ethernet ethPkt) {
         if ((dstNodeConnector == null) || (ethPkt == null)) {
             logger.trace("Ignoring processing of discovery packet: Null node connector or packet");
             return false;
         }
 
-        logger.trace("Handle discovery packet {} from {}", ethPkt,
-                dstNodeConnector);
+        logger.trace("Handle discovery packet {} from {}", ethPkt, dstNodeConnector);
 
         LLDP lldp = (LLDP) ethPkt.getPayload();
 
         List<LLDPTLV> optionalTLVList = lldp.getOptionalTLVList();
         if (optionalTLVList == null) {
-            logger.info("The discovery packet with null custom option from {}",
-                    dstNodeConnector);
+            logger.info("The discovery packet with null custom option from {}", dstNodeConnector);
             return false;
         }
 
@@ -386,26 +413,16 @@ public class DiscoveryService implements IInventoryShimExternalListener,
         NodeConnector srcNodeConnector = null;
         for (LLDPTLV lldptlv : lldp.getOptionalTLVList()) {
             if (lldptlv.getType() == LLDPTLV.TLVType.Custom.getValue()) {
-                String ncString = LLDPTLV.getCustomString(lldptlv.getValue(),
-                        lldptlv.getLength());
+                String ncString = LLDPTLV.getCustomString(lldptlv.getValue(), lldptlv.getLength());
                 srcNodeConnector = NodeConnector.fromString(ncString);
                 if (srcNodeConnector != null) {
                     srcNode = srcNodeConnector.getNode();
-                    /* Check if it's expected */
-                    if (isTracked(srcNodeConnector)) {
-                        break;
-                    } else {
-                        srcNode = null;
-                        srcNodeConnector = null;
-                    }
                 }
             }
         }
 
         if ((srcNode == null) || (srcNodeConnector == null)) {
-            logger.trace(
-                    "Received non-controller generated discovery packet from {}",
-                    dstNodeConnector);
+            logger.trace("Received non-controller generated discovery packet from {}", dstNodeConnector);
             return false;
         }
 
@@ -430,12 +447,11 @@ public class DiscoveryService implements IInventoryShimExternalListener,
             return null;
         }
 
-        if (pluginInInventoryService == null) {
+        if (inventoryProvider == null) {
             return null;
         }
 
-        Map<NodeConnector, Map<String, Property>> props = pluginInInventoryService
-                .getNodeConnectorProps(false);
+        Map<NodeConnector, Map<String, Property>> props = inventoryProvider.getNodeConnectorProps(false);
         if (props == null) {
             return null;
         }
@@ -449,7 +465,7 @@ public class DiscoveryService implements IInventoryShimExternalListener,
             return null;
         }
 
-        Property prop = (Property) propMap.get(propName);
+        Property prop = propMap.get(propName);
         return prop;
     }
 
@@ -470,8 +486,7 @@ public class DiscoveryService implements IInventoryShimExternalListener,
 
         Config config = (Config) getProp(nodeConnector, Config.ConfigPropName);
         State state = (State) getProp(nodeConnector, State.StatePropName);
-        return ((config != null) && (config.getValue() == Config.ADMIN_UP)
-                && (state != null) && (state.getValue() == State.EDGE_UP));
+        return ((config != null) && (config.getValue() == Config.ADMIN_UP) && (state != null) && (state.getValue() == State.EDGE_UP));
     }
 
     private boolean isTracked(NodeConnector nodeConnector) {
@@ -483,11 +498,11 @@ public class DiscoveryService implements IInventoryShimExternalListener,
             return true;
         }
 
-        if (pendingMap.keySet().contains(nodeConnector)) {
+        if (holdTime.keySet().contains(nodeConnector)) {
             return true;
         }
 
-        if (waitingList.contains(nodeConnector)) {
+        if (stagingList.contains(nodeConnector)) {
             return true;
         }
 
@@ -505,6 +520,9 @@ public class DiscoveryService implements IInventoryShimExternalListener,
 
             workingSet.add(nodeConnector);
             removeSet.add(nodeConnector);
+
+            // Put it in the map and start the timer. It may need retry.
+            elapsedTime.put(nodeConnector, 0);
         }
         readyListHi.removeAll(removeSet);
 
@@ -540,14 +558,13 @@ public class DiscoveryService implements IInventoryShimExternalListener,
 
     private void addDiscovery(Node node) {
         Map<Long, ISwitch> switches = controller.getSwitches();
-        ISwitch sw = switches.get((Long) node.getID());
+        ISwitch sw = switches.get(node.getID());
         List<OFPhysicalPort> ports = sw.getEnabledPorts();
         if (ports == null) {
             return;
         }
         for (OFPhysicalPort port : ports) {
-            NodeConnector nodeConnector = NodeConnectorCreator
-                    .createOFNodeConnector(port.getPortNumber(), node);
+            NodeConnector nodeConnector = NodeConnectorCreator.createOFNodeConnector(port.getPortNumber(), node);
             if (!readyListHi.contains(nodeConnector)) {
                 readyListHi.add(nodeConnector);
             }
@@ -562,15 +579,23 @@ public class DiscoveryService implements IInventoryShimExternalListener,
         readyListHi.add(nodeConnector);
     }
 
-    private Set<NodeConnector> getRemoveSet(Collection<NodeConnector> c,
-            Node node) {
+    private Set<NodeConnector> getRemoveSet(Collection<NodeConnector> c, Node node) {
         Set<NodeConnector> removeSet = new HashSet<NodeConnector>();
         if (c == null) {
             return removeSet;
         }
         for (NodeConnector nodeConnector : c) {
             if (node.equals(nodeConnector.getNode())) {
-                removeSet.add(nodeConnector);
+                Edge edge1 = edgeMap.get(nodeConnector);
+                if (edge1 != null) {
+                    removeSet.add(nodeConnector);
+
+                    // check reverse direction
+                    Edge edge2 = edgeMap.get(edge1.getTailNodeConnector());
+                    if ((edge2 != null) && node.equals(edge2.getTailNodeConnector().getNode())) {
+                        removeSet.add(edge2.getHeadNodeConnector());
+                    }
+                }
             }
         }
         return removeSet;
@@ -585,12 +610,12 @@ public class DiscoveryService implements IInventoryShimExternalListener,
         removeSet = getRemoveSet(readyListLo, node);
         readyListLo.removeAll(removeSet);
 
-        removeSet = getRemoveSet(waitingList, node);
-        waitingList.removeAll(removeSet);
+        removeSet = getRemoveSet(stagingList, node);
+        stagingList.removeAll(removeSet);
 
-        removeSet = getRemoveSet(pendingMap.keySet(), node);
+        removeSet = getRemoveSet(holdTime.keySet(), node);
         for (NodeConnector nodeConnector : removeSet) {
-            pendingMap.remove(nodeConnector);
+            holdTime.remove(nodeConnector);
         }
 
         removeSet = getRemoveSet(edgeMap.keySet(), node);
@@ -607,28 +632,25 @@ public class DiscoveryService implements IInventoryShimExternalListener,
     private void removeDiscovery(NodeConnector nodeConnector) {
         readyListHi.remove(nodeConnector);
         readyListLo.remove(nodeConnector);
-        waitingList.remove(nodeConnector);
-        pendingMap.remove(nodeConnector);
+        stagingList.remove(nodeConnector);
+        holdTime.remove(nodeConnector);
         removeEdge(nodeConnector, false);
         removeProdEdge(nodeConnector);
     }
 
     private void checkTimeout() {
         Set<NodeConnector> removeSet = new HashSet<NodeConnector>();
-        Set<NodeConnector> retrySet = new HashSet<NodeConnector>();
-        int sentCount;
-
-        Set<NodeConnector> pendingSet = pendingMap.keySet();
-        if (pendingSet != null) {
-            for (NodeConnector nodeConnector : pendingSet) {
-                sentCount = pendingMap.get(nodeConnector);
-                pendingMap.put(nodeConnector, ++sentCount);
-                if (sentCount > getDiscoveryFinalTimeoutInterval()) {
+        int ticks;
+
+        Set<NodeConnector> monitorSet = holdTime.keySet();
+        if (monitorSet != null) {
+            for (NodeConnector nodeConnector : monitorSet) {
+                ticks = holdTime.get(nodeConnector);
+                holdTime.put(nodeConnector, ++ticks);
+                if (ticks >= discoveryTimeoutTicks) {
                     // timeout the edge
                     removeSet.add(nodeConnector);
                     logger.trace("Discovery timeout {}", nodeConnector);
-                } else if (sentCount % discoveryTimeoutTicks == 0) {
-                    retrySet.add(nodeConnector);
                 }
             }
         }
@@ -637,8 +659,25 @@ public class DiscoveryService implements IInventoryShimExternalListener,
             removeEdge(nodeConnector);
         }
 
-        for (NodeConnector nodeConnector : retrySet) {
-            transmitQ.add(nodeConnector);
+        Set<NodeConnector> retrySet = new HashSet<NodeConnector>();
+        Set<NodeConnector> ncSet = elapsedTime.keySet();
+        if ((ncSet != null) && (ncSet.size() > 0)) {
+            for (NodeConnector nodeConnector : ncSet) {
+                ticks = elapsedTime.get(nodeConnector);
+                elapsedTime.put(nodeConnector, ++ticks);
+                if (ticks >= discoveryThresholdTicks) {
+                    retrySet.add(nodeConnector);
+                }
+            }
+
+            for (NodeConnector nodeConnector : retrySet) {
+                // Allow one more retry
+                readyListLo.add(nodeConnector);
+                elapsedTime.remove(nodeConnector);
+                if (connectionOutService.isLocal(nodeConnector.getNode())) {
+                    transmitQ.add(nodeConnector);
+                }
+            }
         }
     }
 
@@ -648,14 +687,14 @@ public class DiscoveryService implements IInventoryShimExternalListener,
         }
 
         Set<NodeConnector> removeSet = new HashSet<NodeConnector>();
-        int sentCount;
+        int ticks;
 
         Set<NodeConnector> agingSet = agingMap.keySet();
         if (agingSet != null) {
             for (NodeConnector nodeConnector : agingSet) {
-                sentCount = agingMap.get(nodeConnector);
-                agingMap.put(nodeConnector, ++sentCount);
-                if (sentCount > discoveryAgeoutTicks) {
+                ticks = agingMap.get(nodeConnector);
+                agingMap.put(nodeConnector, ++ticks);
+                if (ticks > discoveryAgeoutTicks) {
                     // age out the edge
                     removeSet.add(nodeConnector);
                     logger.trace("Discovery age out {}", nodeConnector);
@@ -671,16 +710,22 @@ public class DiscoveryService implements IInventoryShimExternalListener,
     private void doDiscovery() {
         if (++discoveryTimerTickCount <= discoveryBatchPauseTicks) {
             for (NodeConnector nodeConnector : getWorkingSet()) {
-                pendingMap.put(nodeConnector, 0);
-                transmitQ.add(nodeConnector);
+                if (connectionOutService.isLocal(nodeConnector.getNode())) {
+                    transmitQ.add(nodeConnector);
+                    // Move to staging area after it's served
+                    if (!stagingList.contains(nodeConnector)) {
+                        stagingList.add(nodeConnector);
+                    }
+                }
             }
         } else if (discoveryTimerTickCount >= discoveryBatchRestartTicks) {
             discoveryTimerTickCount = 0;
-            for (NodeConnector nodeConnector : waitingList) {
-                if (!readyListLo.contains(nodeConnector))
+            for (NodeConnector nodeConnector : stagingList) {
+                if (!readyListLo.contains(nodeConnector)) {
                     readyListLo.add(nodeConnector);
+                }
             }
-            waitingList.removeAll(readyListLo);
+            stagingList.removeAll(readyListLo);
         }
     }
 
@@ -689,8 +734,7 @@ public class DiscoveryService implements IInventoryShimExternalListener,
             return;
         }
 
-        if (++discoveryConsistencyCheckTickCount
-                % getDiscoveryConsistencyCheckInterval() != 0) {
+        if (++discoveryConsistencyCheckTickCount % getDiscoveryConsistencyCheckInterval() != 0) {
             return;
         }
 
@@ -705,16 +749,14 @@ public class DiscoveryService implements IInventoryShimExternalListener,
             if (!isEnabled(nodeConnector)) {
                 removeSet.add(nodeConnector);
                 discoveryConsistencyCheckCorrected++;
-                logger.debug("ConsistencyChecker: remove disabled {}",
-                        nodeConnector);
+                logger.debug("ConsistencyChecker: remove disabled {}", nodeConnector);
                 continue;
             }
 
             if (!isTracked(nodeConnector)) {
-                waitingList.add(nodeConnector);
+                stagingList.add(nodeConnector);
                 discoveryConsistencyCheckCorrected++;
-                logger.debug("ConsistencyChecker: add back untracked {}",
-                        nodeConnector);
+                logger.debug("ConsistencyChecker: add back untracked {}", nodeConnector);
                 continue;
             }
         }
@@ -725,28 +767,25 @@ public class DiscoveryService implements IInventoryShimExternalListener,
 
         // remove stale entries
         removeSet.clear();
-        for (NodeConnector nodeConnector : waitingList) {
+        for (NodeConnector nodeConnector : stagingList) {
             if (!isEnabled(nodeConnector)) {
                 removeSet.add(nodeConnector);
                 discoveryConsistencyCheckCorrected++;
-                logger.debug("ConsistencyChecker: remove disabled {}",
-                        nodeConnector);
+                logger.debug("ConsistencyChecker: remove disabled {}", nodeConnector);
             }
         }
-        waitingList.removeAll(removeSet);
+        stagingList.removeAll(removeSet);
 
         // Get a snapshot of all the existing switches
         Map<Long, ISwitch> switches = this.controller.getSwitches();
         for (ISwitch sw : switches.values()) {
             for (OFPhysicalPort port : sw.getEnabledPorts()) {
                 Node node = NodeCreator.createOFNode(sw.getId());
-                NodeConnector nodeConnector = NodeConnectorCreator
-                        .createOFNodeConnector(port.getPortNumber(), node);
+                NodeConnector nodeConnector = NodeConnectorCreator.createOFNodeConnector(port.getPortNumber(), node);
                 if (!isTracked(nodeConnector)) {
-                    waitingList.add(nodeConnector);
+                    stagingList.add(nodeConnector);
                     discoveryConsistencyCheckCorrected++;
-                    logger.debug("ConsistencyChecker: add back untracked {}",
-                            nodeConnector);
+                    logger.debug("ConsistencyChecker: add back untracked {}", nodeConnector);
                 }
             }
         }
@@ -758,24 +797,22 @@ public class DiscoveryService implements IInventoryShimExternalListener,
         }
 
         NodeConnector src = edge.getTailNodeConnector();
+        NodeConnector dst = edge.getHeadNodeConnector();
         if (!src.getType().equals(NodeConnector.NodeConnectorIDType.PRODUCTION)) {
-            pendingMap.remove(src);
-            if (!waitingList.contains(src)) {
-                waitingList.add(src);
-            }
+            holdTime.put(dst, 0);
         } else {
-            NodeConnector dst = edge.getHeadNodeConnector();
             agingMap.put(dst, 0);
         }
+        elapsedTime.remove(src);
 
-        // notify routeEngine
+        // notify
         updateEdge(edge, UpdateType.ADDED, props);
         logger.trace("Add edge {}", edge);
     }
 
     /**
      * Update Production Edge
-     * 
+     *
      * @param edge
      *            The Production Edge
      * @param props
@@ -786,9 +823,7 @@ public class DiscoveryService implements IInventoryShimExternalListener,
 
         /* Do not update in case there is an existing OpenFlow link */
         if (edgeMap.get(edgePort) != null) {
-            logger.trace(
-                    "Discarded edge {} since there is an existing OF link {}",
-                    edge, edgeMap.get(edgePort));
+            logger.trace("Discarded edge {} since there is an existing OF link {}", edge, edgeMap.get(edgePort));
             return;
         }
 
@@ -811,7 +846,7 @@ public class DiscoveryService implements IInventoryShimExternalListener,
 
     /**
      * Remove Production Edge for a given edge port
-     * 
+     *
      * @param edgePort
      *            The OF edge port
      */
@@ -826,8 +861,8 @@ public class DiscoveryService implements IInventoryShimExternalListener,
         }
 
         // notify Topology
-        if (this.discoveryService != null) {
-            this.discoveryService.notifyEdge(edge, UpdateType.REMOVED, null);
+        if (this.discoveryListener != null) {
+            this.discoveryListener.notifyEdge(edge, UpdateType.REMOVED, null);
         }
         logger.trace("Remove edge {}", edge);
     }
@@ -836,18 +871,18 @@ public class DiscoveryService implements IInventoryShimExternalListener,
      * Remove OpenFlow edge
      */
     private void removeEdge(NodeConnector nodeConnector, boolean stillEnabled) {
-        pendingMap.remove(nodeConnector);
+        holdTime.remove(nodeConnector);
         readyListLo.remove(nodeConnector);
         readyListHi.remove(nodeConnector);
 
         if (stillEnabled) {
             // keep discovering
-            if (!waitingList.contains(nodeConnector)) {
-                waitingList.add(nodeConnector);
+            if (!stagingList.contains(nodeConnector)) {
+                stagingList.add(nodeConnector);
             }
         } else {
             // stop it
-            waitingList.remove(nodeConnector);
+            stagingList.remove(nodeConnector);
         }
 
         Edge edge = null;
@@ -858,8 +893,8 @@ public class DiscoveryService implements IInventoryShimExternalListener,
         }
 
         // notify Topology
-        if (this.discoveryService != null) {
-            this.discoveryService.notifyEdge(edge, UpdateType.REMOVED, null);
+        if (this.discoveryListener != null) {
+            this.discoveryListener.notifyEdge(edge, UpdateType.REMOVED, null);
         }
         logger.trace("Remove {}", nodeConnector);
     }
@@ -869,14 +904,13 @@ public class DiscoveryService implements IInventoryShimExternalListener,
     }
 
     private void updateEdge(Edge edge, UpdateType type, Set<Property> props) {
-        if (discoveryService == null) {
+        if (discoveryListener == null) {
             return;
         }
 
-        this.discoveryService.notifyEdge(edge, type, props);
+        this.discoveryListener.notifyEdge(edge, type, props);
 
-        NodeConnector src = edge.getTailNodeConnector(), dst = edge
-                .getHeadNodeConnector();
+        NodeConnector src = edge.getTailNodeConnector(), dst = edge.getHeadNodeConnector();
         if (!src.getType().equals(NodeConnector.NodeConnectorIDType.PRODUCTION)) {
             if (type == UpdateType.ADDED) {
                 edgeMap.put(dst, edge);
@@ -895,57 +929,49 @@ public class DiscoveryService implements IInventoryShimExternalListener,
         }
     }
 
-    private void moreToReadyListHi(NodeConnector nodeConnector) {
+    private void moveToReadyListHi(NodeConnector nodeConnector) {
         if (readyListLo.contains(nodeConnector)) {
             readyListLo.remove(nodeConnector);
-            readyListHi.add(nodeConnector);
-        } else if (waitingList.contains(nodeConnector)) {
-            waitingList.remove(nodeConnector);
-            readyListHi.add(nodeConnector);
+        } else if (stagingList.contains(nodeConnector)) {
+            stagingList.remove(nodeConnector);
         }
+        readyListHi.add(nodeConnector);
     }
 
     private void registerWithOSGIConsole() {
-        BundleContext bundleContext = FrameworkUtil.getBundle(this.getClass())
-                .getBundleContext();
-        bundleContext.registerService(CommandProvider.class.getName(), this,
-                null);
+        BundleContext bundleContext = FrameworkUtil.getBundle(this.getClass()).getBundleContext();
+        bundleContext.registerService(CommandProvider.class.getName(), this, null);
     }
 
     private int getDiscoveryConsistencyCheckInterval() {
         return discoveryConsistencyCheckMultiple * discoveryBatchRestartTicks;
     }
 
-    private int getDiscoveryFinalTimeoutInterval() {
-        return (discoveryRetry + 1) * discoveryTimeoutTicks;
-    }
-
     @Override
     public String getHelp() {
         StringBuffer help = new StringBuffer();
         help.append("---Topology Discovery---\n");
         help.append("\t prlh                            - Print readyListHi entries\n");
         help.append("\t prll                            - Print readyListLo entries\n");
-        help.append("\t pwl                             - Print waitingList entries\n");
-        help.append("\t ppl                             - Print pendingList entries\n");
+        help.append("\t psl                             - Print stagingList entries\n");
+        help.append("\t pht                             - Print hold time\n");
+        help.append("\t pet                             - Print elapsed time\n");
         help.append("\t ptick                           - Print tick time in msec\n");
         help.append("\t pcc                             - Print CC info\n");
         help.append("\t psize                           - Print sizes of all the lists\n");
         help.append("\t ptm                             - Print timeout info\n");
-        help.append("\t ecc                            - Enable CC\n");
-        help.append("\t dcc                            - Disable CC\n");
+        help.append("\t ecc                             - Enable CC\n");
+        help.append("\t dcc                             - Disable CC\n");
         help.append("\t scc [multiple]                  - Set/show CC multiple and interval\n");
-        help.append("\t sports [ports]                         - Set/show max ports per batch\n");
+        help.append("\t sports [ports]                  - Set/show max ports per batch\n");
         help.append("\t spause [ticks]                  - Set/show pause period\n");
-        help.append("\t sdi [ticks]                            - Set/show discovery interval in ticks\n");
-        help.append("\t stm [ticks]                     - Set/show per timeout ticks\n");
-        help.append("\t sretry [count]                         - Set/show num of retries\n");
-        help.append("\t addsw <swid>                   - Add a switch\n");
-        help.append("\t remsw <swid>                   - Remove a switch\n");
+        help.append("\t sdi [ticks]                     - Set/show discovery interval in ticks\n");
+        help.append("\t addsw <swid>                    - Add a switch\n");
+        help.append("\t remsw <swid>                    - Remove a switch\n");
         help.append("\t page                            - Print aging info\n");
         help.append("\t sage                            - Set/Show aging time limit\n");
-        help.append("\t eage                           - Enable aging\n");
-        help.append("\t dage                           - Disable aging\n");
+        help.append("\t eage                            - Enable aging\n");
+        help.append("\t dage                            - Disable aging\n");
         help.append("\t pthrot                          - Print throttling\n");
         help.append("\t ethrot                          - Enable throttling\n");
         help.append("\t dthrot                          - Disable throttling\n");
@@ -955,44 +981,69 @@ public class DiscoveryService implements IInventoryShimExternalListener,
         return help.toString();
     }
 
+    private List<NodeConnector> sortList(Collection<NodeConnector> ncs) {
+        List<String> ncStrArray = new ArrayList<String>();
+        for (NodeConnector nc : ncs) {
+            ncStrArray.add(nc.toString());
+        }
+        Collections.sort(ncStrArray);
+
+        List<NodeConnector> sortedNodeConnectors = new ArrayList<NodeConnector>();
+        for (String ncStr : ncStrArray) {
+            sortedNodeConnectors.add(NodeConnector.fromString(ncStr));
+        }
+
+        return sortedNodeConnectors;
+    }
+
     public void _prlh(CommandInterpreter ci) {
-        ci.println("ReadyListHi\n");
-        for (NodeConnector nodeConnector : readyListHi) {
+        ci.println("readyListHi\n");
+        for (NodeConnector nodeConnector : sortList(readyListHi)) {
             if (nodeConnector == null) {
                 continue;
             }
             ci.println(nodeConnector);
         }
+        ci.println("Total number of Node Connectors: " + readyListHi.size());
     }
 
     public void _prll(CommandInterpreter ci) {
-        ci.println("ReadyListLo\n");
-        for (NodeConnector nodeConnector : readyListLo) {
+        ci.println("readyListLo\n");
+        for (NodeConnector nodeConnector : sortList(readyListLo)) {
             if (nodeConnector == null) {
                 continue;
             }
             ci.println(nodeConnector);
         }
+        ci.println("Total number of Node Connectors: " + readyListLo.size());
     }
 
-    public void _pwl(CommandInterpreter ci) {
-        ci.println("WaitingList\n");
-        for (NodeConnector nodeConnector : waitingList) {
+    public void _psl(CommandInterpreter ci) {
+        ci.println("stagingList\n");
+        for (NodeConnector nodeConnector : sortList(stagingList)) {
             if (nodeConnector == null) {
                 continue;
             }
             ci.println(nodeConnector);
         }
+        ci.println("Total number of Node Connectors: " + stagingList.size());
     }
 
-    public void _ppl(CommandInterpreter ci) {
-        ci.println("PendingList\n");
-        for (NodeConnector nodeConnector : pendingMap.keySet()) {
-            if (nodeConnector == null) {
-                continue;
-            }
-            ci.println(nodeConnector);
+    public void _pht(CommandInterpreter ci) {
+        ci.println("          NodeConnector            Last rx LLDP (sec)");
+        for (ConcurrentMap.Entry<NodeConnector, Integer> entry: holdTime.entrySet()) {
+            ci.println(entry.getKey() + "\t\t" + entry.getValue() * (discoveryTimerTick / 1000));
+        }
+        ci.println("\nSize: " + holdTime.size() + "\tTimeout: " + discoveryTimeoutTicks * (discoveryTimerTick / 1000)
+                + " sec");
+    }
+
+    public void _pet(CommandInterpreter ci) {
+        ci.println("          NodeConnector            Elapsed Time (sec)");
+        for (ConcurrentMap.Entry<NodeConnector, Integer> entry: elapsedTime.entrySet()) {
+            ci.println(entry.getKey() + "\t\t" + entry.getValue() * (discoveryTimerTick / 1000));
         }
+        ci.println("\nSize: " + elapsedTime.size() + "\tThreshold: " + DiscoveryPeriod.THRESHOLD.getTime() + " sec");
     }
 
     public void _ptick(CommandInterpreter ci) {
@@ -1007,24 +1058,19 @@ public class DiscoveryService implements IInventoryShimExternalListener,
         }
         ci.println("Interval " + getDiscoveryConsistencyCheckInterval());
         ci.println("Multiple " + discoveryConsistencyCheckMultiple);
-        ci.println("Number of times called "
-                + discoveryConsistencyCheckCallingTimes);
+        ci.println("Number of times called " + discoveryConsistencyCheckCallingTimes);
         ci.println("Corrected count " + discoveryConsistencyCheckCorrected);
     }
 
     public void _ptm(CommandInterpreter ci) {
-        ci.println("Final timeout ticks " + getDiscoveryFinalTimeoutInterval());
-        ci.println("Per timeout ticks " + discoveryTimeoutTicks);
-        ci.println("Number of retries after initial timeout " + discoveryRetry);
+        ci.println("Timeout " + discoveryTimeoutTicks + " ticks, " + discoveryTimerTick / 1000 + " sec per tick.");
     }
 
     public void _psize(CommandInterpreter ci) {
-        ci.println("readyListLo size " + readyListLo.size() + "\n"
-                + "readyListHi size " + readyListHi.size() + "\n"
-                + "waitingList size " + waitingList.size() + "\n"
-                + "pendingMap size " + pendingMap.size() + "\n"
-                + "edgeMap size " + edgeMap.size() + "\n" + "prodMap size "
-                + prodMap.size() + "\n" + "agingMap size " + agingMap.size());
+        ci.println("readyListLo size " + readyListLo.size() + "\n" + "readyListHi size " + readyListHi.size() + "\n"
+                + "stagingList size " + stagingList.size() + "\n" + "holdTime size " + holdTime.size() + "\n"
+                + "edgeMap size " + edgeMap.size() + "\n" + "prodMap size " + prodMap.size() + "\n" + "agingMap size "
+                + agingMap.size() + "\n" + "elapsedTime size " + elapsedTime.size());
     }
 
     public void _page(CommandInterpreter ci) {
@@ -1047,7 +1093,7 @@ public class DiscoveryService implements IInventoryShimExternalListener,
             }
         }
         ci.println("\n");
-        ci.println("              NodeConnector                                                Edge ");
+        ci.println("              NodeConnector                                                 Edge ");
         Set<NodeConnector> keySet = prodMap.keySet();
         if (keySet == null) {
             return;
@@ -1061,8 +1107,7 @@ public class DiscoveryService implements IInventoryShimExternalListener,
     public void _sage(CommandInterpreter ci) {
         String val = ci.nextArgument();
         if (val == null) {
-            ci.println("Please enter aging time limit. Current value "
-                    + this.discoveryAgeoutTicks);
+            ci.println("Please enter aging time limit. Current value " + this.discoveryAgeoutTicks);
             return;
         }
         try {
@@ -1088,10 +1133,8 @@ public class DiscoveryService implements IInventoryShimExternalListener,
     public void _scc(CommandInterpreter ci) {
         String val = ci.nextArgument();
         if (val == null) {
-            ci.println("Please enter CC multiple. Current multiple "
-                    + discoveryConsistencyCheckMultiple + " (interval "
-                    + getDiscoveryConsistencyCheckInterval()
-                    + ") calling times "
+            ci.println("Please enter CC multiple. Current multiple " + discoveryConsistencyCheckMultiple
+                    + " (interval " + getDiscoveryConsistencyCheckInterval() + ") calling times "
                     + discoveryConsistencyCheckCallingTimes);
             return;
         }
@@ -1141,8 +1184,7 @@ public class DiscoveryService implements IInventoryShimExternalListener,
             NodeConnector nodeConnector = NodeConnector.fromString(val);
             if (nodeConnector != null) {
                 discoverySnoopingDisableList.remove(nodeConnector);
-                ci.println("Discovery snooping is locally enabled on port "
-                        + nodeConnector);
+                ci.println("Discovery snooping is locally enabled on port " + nodeConnector);
             } else {
                 ci.println("Entered invalid NodeConnector " + val);
             }
@@ -1162,8 +1204,7 @@ public class DiscoveryService implements IInventoryShimExternalListener,
             NodeConnector nodeConnector = NodeConnector.fromString(val);
             if (nodeConnector != null) {
                 discoverySnoopingDisableList.add(nodeConnector);
-                ci.println("Discovery snooping is locally disabled on port "
-                        + nodeConnector);
+                ci.println("Discovery snooping is locally disabled on port " + nodeConnector);
             } else {
                 ci.println("Entered invalid NodeConnector " + val);
             }
@@ -1173,18 +1214,16 @@ public class DiscoveryService implements IInventoryShimExternalListener,
 
     public void _spause(CommandInterpreter ci) {
         String val = ci.nextArgument();
-        String out = "Please enter pause period less than "
-                + discoveryBatchRestartTicks + ". Current pause period is "
-                + discoveryBatchPausePeriod + " pause tick is "
-                + discoveryBatchPauseTicks + ".";
+        String out = "Please enter pause period less than " + discoveryBatchRestartTicks + ". Current pause period is "
+                + discoveryBatchPausePeriod + " ticks, pause at " + discoveryBatchPauseTicks + " ticks, "
+                + discoveryTimerTick / 1000 + " sec per tick.";
 
         if (val != null) {
             try {
                 int pause = Integer.parseInt(val);
                 if (pause < discoveryBatchRestartTicks) {
                     discoveryBatchPausePeriod = pause;
-                    discoveryBatchPauseTicks = discoveryBatchRestartTicks
-                            - discoveryBatchPausePeriod;
+                    discoveryBatchPauseTicks = getDiscoveryPauseInterval();
                     return;
                 }
             } catch (Exception e) {
@@ -1196,19 +1235,17 @@ public class DiscoveryService implements IInventoryShimExternalListener,
 
     public void _sdi(CommandInterpreter ci) {
         String val = ci.nextArgument();
-        String out = "Please enter discovery interval greater than "
-                + discoveryBatchPausePeriod + ". Current value is "
-                + discoveryBatchRestartTicks + ".";
+        String out = "Please enter discovery interval in ticks. Current value is " + discoveryBatchRestartTicks + " ticks, "
+                + discoveryTimerTick / 1000 + " sec per tick.";
 
         if (val != null) {
             try {
-                int restart = Integer.parseInt(val);
-                if (restart > discoveryBatchPausePeriod) {
-                    discoveryBatchRestartTicks = restart;
-                    discoveryBatchPauseTicks = discoveryBatchRestartTicks
-                            - discoveryBatchPausePeriod;
-                    return;
-                }
+                int ticks = Integer.parseInt(val);
+                DiscoveryPeriod.INTERVAL.setTick(ticks);
+                discoveryBatchRestartTicks = getDiscoveryInterval();
+                discoveryBatchPauseTicks = getDiscoveryPauseInterval();
+                discoveryTimeoutTicks = getDiscoveryTimeout();
+                return;
             } catch (Exception e) {
             }
         }
@@ -1218,8 +1255,7 @@ public class DiscoveryService implements IInventoryShimExternalListener,
     public void _sports(CommandInterpreter ci) {
         String val = ci.nextArgument();
         if (val == null) {
-            ci.println("Please enter max ports per batch. Current value is "
-                    + discoveryBatchMaxPorts);
+            ci.println("Please enter max ports per batch. Current value is " + discoveryBatchMaxPorts);
             return;
         }
         try {
@@ -1230,40 +1266,6 @@ public class DiscoveryService implements IInventoryShimExternalListener,
         return;
     }
 
-    public void _sretry(CommandInterpreter ci) {
-        String val = ci.nextArgument();
-        if (val == null) {
-            ci.println("Please enter number of retries. Current value is "
-                    + discoveryRetry);
-            return;
-        }
-        try {
-            discoveryRetry = Integer.parseInt(val);
-        } catch (Exception e) {
-            ci.println("Please enter a valid number");
-        }
-        return;
-    }
-
-    public void _stm(CommandInterpreter ci) {
-        String val = ci.nextArgument();
-        String out = "Please enter timeout tick value less than "
-                + discoveryBatchRestartTicks + ". Current value is "
-                + discoveryTimeoutTicks;
-        if (val != null) {
-            try {
-                int timeout = Integer.parseInt(val);
-                if (timeout < discoveryBatchRestartTicks) {
-                    discoveryTimeoutTicks = timeout;
-                    return;
-                }
-            } catch (Exception e) {
-            }
-        }
-
-        ci.println(out);
-    }
-
     public void _addsw(CommandInterpreter ci) {
         String val = ci.nextArgument();
         Long sid;
@@ -1325,8 +1327,7 @@ public class DiscoveryService implements IInventoryShimExternalListener,
     }
 
     @Override
-    public void updateNodeConnector(NodeConnector nodeConnector,
-            UpdateType type, Set<Property> props) {
+    public void updateNodeConnector(NodeConnector nodeConnector, UpdateType type, Set<Property> props) {
         Config config = null;
         State state = null;
         boolean enabled = false;
@@ -1338,8 +1339,7 @@ public class DiscoveryService implements IInventoryShimExternalListener,
                 state = (State) prop;
             }
         }
-        enabled = ((config != null) && (config.getValue() == Config.ADMIN_UP)
-                && (state != null) && (state.getValue() == State.EDGE_UP));
+        enabled = ((config != null) && (config.getValue() == Config.ADMIN_UP) && (state != null) && (state.getValue() == State.EDGE_UP));
 
         switch (type) {
         case ADDED:
@@ -1369,22 +1369,21 @@ public class DiscoveryService implements IInventoryShimExternalListener,
     }
 
     public void addNode(Node node, Set<Property> props) {
-        if (node == null)
+        if (node == null) {
             return;
+        }
 
         addDiscovery(node);
     }
 
     public void removeNode(Node node) {
-        if (node == null)
+        if (node == null) {
             return;
+        }
 
         removeDiscovery(node);
     }
 
-    public void updateNode(Node node, Set<Property> props) {
-    }
-
     void setController(IController s) {
         this.controller = s;
     }
@@ -1395,12 +1394,12 @@ public class DiscoveryService implements IInventoryShimExternalListener,
         }
     }
 
-    public void setPluginInInventoryService(IPluginInInventoryService service) {
-        this.pluginInInventoryService = service;
+    public void setInventoryProvider(IInventoryProvider service) {
+        this.inventoryProvider = service;
     }
 
-    public void unsetPluginInInventoryService(IPluginInInventoryService service) {
-        this.pluginInInventoryService = null;
+    public void unsetInventoryProvider(IInventoryProvider service) {
+        this.inventoryProvider = null;
     }
 
     public void setIDataPacketMux(IDataPacketMux service) {
@@ -1413,30 +1412,39 @@ public class DiscoveryService implements IInventoryShimExternalListener,
         }
     }
 
-    void setDiscoveryService(IDiscoveryService s) {
-        this.discoveryService = s;
+    void setDiscoveryListener(IDiscoveryListener s) {
+        this.discoveryListener = s;
     }
 
-    void unsetDiscoveryService(IDiscoveryService s) {
-        if (this.discoveryService == s) {
-            this.discoveryService = null;
+    void unsetDiscoveryListener(IDiscoveryListener s) {
+        if (this.discoveryListener == s) {
+            this.discoveryListener = null;
+        }
+    }
+
+    void setIPluginOutConnectionService(IPluginOutConnectionService s) {
+        connectionOutService = s;
+    }
+
+    void unsetIPluginOutConnectionService(IPluginOutConnectionService s) {
+        if (connectionOutService == s) {
+            connectionOutService = null;
         }
     }
 
     private void initDiscoveryPacket() {
         // Create LLDP ChassisID TLV
         chassisIdTlv = new LLDPTLV();
-        chassisIdTlv.setType((byte) LLDPTLV.TLVType.ChassisID.getValue());
+        chassisIdTlv.setType(LLDPTLV.TLVType.ChassisID.getValue());
 
         // Create LLDP PortID TLV
         portIdTlv = new LLDPTLV();
-        portIdTlv.setType((byte) LLDPTLV.TLVType.PortID.getValue());
+        portIdTlv.setType(LLDPTLV.TLVType.PortID.getValue());
 
         // Create LLDP TTL TLV
         byte[] ttl = new byte[] { (byte) 0, (byte) 120 };
         ttlTlv = new LLDPTLV();
-        ttlTlv.setType((byte) LLDPTLV.TLVType.TTL.getValue())
-                .setLength((short) ttl.length).setValue(ttl);
+        ttlTlv.setType(LLDPTLV.TLVType.TTL.getValue()).setLength((short) ttl.length).setValue(ttl);
 
         customTlv = new LLDPTLV();
     }
@@ -1444,7 +1452,7 @@ public class DiscoveryService implements IInventoryShimExternalListener,
     /**
      * Function called by the dependency manager when all the required
      * dependencies are satisfied
-     * 
+     *
      */
     void init() {
         logger.trace("Init called");
@@ -1453,13 +1461,22 @@ public class DiscoveryService implements IInventoryShimExternalListener,
 
         readyListHi = new CopyOnWriteArrayList<NodeConnector>();
         readyListLo = new CopyOnWriteArrayList<NodeConnector>();
-        waitingList = new CopyOnWriteArrayList<NodeConnector>();
-        pendingMap = new ConcurrentHashMap<NodeConnector, Integer>();
+        stagingList = new CopyOnWriteArrayList<NodeConnector>();
+        holdTime = new ConcurrentHashMap<NodeConnector, Integer>();
+        elapsedTime = new ConcurrentHashMap<NodeConnector, Integer>();
         edgeMap = new ConcurrentHashMap<NodeConnector, Edge>();
         agingMap = new ConcurrentHashMap<NodeConnector, Integer>();
         prodMap = new ConcurrentHashMap<NodeConnector, Edge>();
         discoverySnoopingDisableList = new CopyOnWriteArrayList<NodeConnector>();
 
+        discoveryBatchRestartTicks = getDiscoveryInterval();
+        discoveryBatchPauseTicks = getDiscoveryPauseInterval();
+        discoveryTimeoutTicks = getDiscoveryTimeout();
+        discoveryThresholdTicks = getDiscoveryThreshold();
+        discoveryAgeoutTicks = getDiscoveryAgeout();
+        discoveryConsistencyCheckTickCount = discoveryBatchPauseTicks;
+        discoveryBatchMaxPorts = getDiscoveryBatchMaxPorts();
+
         discoveryTimer = new Timer("DiscoveryService");
         discoveryTimerTask = new DiscoveryTimerTask();
 
@@ -1474,14 +1491,14 @@ public class DiscoveryService implements IInventoryShimExternalListener,
      * Function called by the dependency manager when at least one dependency
      * become unsatisfied or when the component is shutting down because for
      * example bundle is being stopped.
-     * 
+     *
      */
     void destroy() {
         transmitQ = null;
         readyListHi = null;
         readyListLo = null;
-        waitingList = null;
-        pendingMap = null;
+        stagingList = null;
+        holdTime = null;
         edgeMap = null;
         agingMap = null;
         prodMap = null;
@@ -1493,11 +1510,10 @@ public class DiscoveryService implements IInventoryShimExternalListener,
     /**
      * Function called by dependency manager after "init ()" is called and after
      * the services provided by the class are registered in the service registry
-     * 
+     *
      */
     void start() {
-        discoveryTimer.schedule(discoveryTimerTask, discoveryTimerTick,
-                discoveryTimerTick);
+        discoveryTimer.schedule(discoveryTimerTask, discoveryTimerTick, discoveryTimerTick);
         transmitThread.start();
     }
 
@@ -1513,7 +1529,7 @@ public class DiscoveryService implements IInventoryShimExternalListener,
      * Function called by the dependency manager before the services exported by
      * the component are unregistered, this will be followed by a "destroy ()"
      * calls
-     * 
+     *
      */
     void stop() {
         shuttingDown = true;
@@ -1522,21 +1538,19 @@ public class DiscoveryService implements IInventoryShimExternalListener,
     }
 
     @Override
-    public void tagUpdated(String containerName, Node n, short oldTag,
-            short newTag, UpdateType t) {
+    public void tagUpdated(String containerName, Node n, short oldTag, short newTag, UpdateType t) {
     }
 
     @Override
-    public void containerFlowUpdated(String containerName,
-            ContainerFlow previousFlow, ContainerFlow currentFlow, UpdateType t) {
+    public void containerFlowUpdated(String containerName, ContainerFlow previousFlow, ContainerFlow currentFlow,
+            UpdateType t) {
     }
 
     @Override
-    public void nodeConnectorUpdated(String containerName, NodeConnector p,
-            UpdateType t) {
+    public void nodeConnectorUpdated(String containerName, NodeConnector p, UpdateType t) {
         switch (t) {
         case ADDED:
-            moreToReadyListHi(p);
+            moveToReadyListHi(p);
             break;
         default:
             break;
@@ -1548,7 +1562,7 @@ public class DiscoveryService implements IInventoryShimExternalListener,
         // do nothing
     }
 
-    private byte[] getSouceMACFromNodeID(String nodeId) {
+    private byte[] getSourceMACFromNodeID(String nodeId) {
         byte[] cid = HexEncode.bytesFromHexString(nodeId);
         byte[] sourceMac = new byte[6];
         int pos = cid.length - sourceMac.length;
@@ -1560,63 +1574,98 @@ public class DiscoveryService implements IInventoryShimExternalListener,
         return sourceMac;
     }
 
+    private int getDiscoveryTicks(DiscoveryPeriod dp, String val) {
+        if (dp == null) {
+            return 0;
+        }
+
+        if (val != null) {
+            try {
+                dp.setTime(Integer.parseInt(val));
+            } catch (Exception e) {
+            }
+        }
+
+        return dp.getTick();
+    }
+
     /**
      * This method returns the interval which determines how often the discovery
-     * packets will be sent. Default is 300 seconds.
-     * 
-     * @return The discovery interval in second
+     * packets will be sent.
+     *
+     * @return The discovery interval in ticks
      */
     private int getDiscoveryInterval() {
-        String elapsedTime = System.getProperty("of.discoveryInterval");
-        int rv = 300;
+        String intvl = System.getProperty("of.discoveryInterval");
+        return getDiscoveryTicks(DiscoveryPeriod.INTERVAL, intvl);
+    }
 
-        try {
-            if (elapsedTime != null) {
-                rv = Integer.parseInt(elapsedTime);
+    /**
+     * This method returns the timeout value in receiving subsequent discovery packets on a port.
+     *
+     * @return The discovery timeout in ticks
+     */
+    private int getDiscoveryTimeout() {
+        String val = System.getProperty("of.discoveryTimeoutMultiple");
+        int multiple = 2;
+
+        if (val != null) {
+            try {
+                multiple = Integer.parseInt(val);
+            } catch (Exception e) {
             }
-        } catch (Exception e) {
         }
+        return getDiscoveryInterval() * multiple + 3;
+    }
 
-        return rv;
+    /**
+     * This method returns the user configurable threshold value
+     *
+     * @return The discovery threshold value in ticks
+     */
+    private int getDiscoveryThreshold() {
+        String val = System.getProperty("of.discoveryThreshold");
+        return getDiscoveryTicks(DiscoveryPeriod.THRESHOLD, val);
     }
 
     /**
-     * This method returns the timeout value in waiting for response of a
-     * discovery query. Default is 60 seconds.
-     * 
-     * @return The discovery timeout in second
+     * This method returns the discovery entry aging time in ticks.
+     *
+     * @return The aging time in ticks
      */
-    private int getDiscoveryTimeout() {
-        String elapsedTime = System.getProperty("of.discoveryTimeout");
-        int rv = 60;
+    private int getDiscoveryAgeout() {
+        return getDiscoveryTicks(DiscoveryPeriod.AGEOUT, null);
+    }
 
-        try {
-            if (elapsedTime != null) {
-                rv = Integer.parseInt(elapsedTime);
-            }
-        } catch (Exception e) {
+    /**
+     * This method returns the pause interval
+     *
+     * @return The pause interval in ticks
+     */
+    private int getDiscoveryPauseInterval() {
+        if (discoveryBatchRestartTicks > discoveryBatchPausePeriod) {
+            return discoveryBatchRestartTicks - discoveryBatchPausePeriod;
+        } else {
+            return discoveryBatchRestartTicks - 1;
         }
-
-        return rv;
     }
 
     /**
-     * This method returns the number of retries after the initial discovery
-     * packet is not received within the timeout period. Default is 2 times.
-     * 
-     * @return The number of discovery retries
+     * This method returns the user configurable maximum number of ports handled
+     * in one discovery batch.
+     *
+     * @return The maximum number of ports
      */
-    private int getDiscoveryRetry() {
-        String retry = System.getProperty("of.discoveryRetry");
-        int rv = 2;
+    private int getDiscoveryBatchMaxPorts() {
+        String val = System.getProperty("of.discoveryBatchMaxPorts");
+        int ports = 1024;
 
-        if (retry != null) {
+        if (val != null) {
             try {
-                rv = Integer.parseInt(retry);
+                ports = Integer.parseInt(val);
             } catch (Exception e) {
             }
         }
-
-        return rv;
+        return ports;
     }
 }