Log enhancements for better debuggability
[genius.git] / interfacemanager / interfacemanager-impl / src / main / java / org / opendaylight / genius / interfacemanager / renderer / ovs / statehelpers / OvsInterfaceStateUpdateHelper.java
index db9459942d0c4eb986ce6c91e83c18e9e826e242..ce2a8725ff9b7976e78c8e2f55ff5903c6843786 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2016 Ericsson India Global Services Pvt Ltd. and others.  All rights reserved.
+ * Copyright (c) 2016, 2017 Ericsson India Global Services Pvt Ltd. and others.  All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
@@ -8,6 +8,8 @@
 package org.opendaylight.genius.interfacemanager.renderer.ovs.statehelpers;
 
 import com.google.common.util.concurrent.ListenableFuture;
+import java.util.ArrayList;
+import java.util.List;
 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
@@ -26,25 +28,20 @@ import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import java.util.ArrayList;
-import java.util.List;
-
 public class OvsInterfaceStateUpdateHelper {
     private static final Logger LOG = LoggerFactory.getLogger(OvsInterfaceStateUpdateHelper.class);
 
     public static List<ListenableFuture<Void>> updateState(InstanceIdentifier<FlowCapableNodeConnector> key,
-                                                           AlivenessMonitorService alivenessMonitorService,
-                                                           DataBroker dataBroker, String interfaceName,
-                                                           FlowCapableNodeConnector flowCapableNodeConnectorNew,
-                                                           FlowCapableNodeConnector flowCapableNodeConnectorOld) {
-        LOG.debug("Update of Interface State for port: {}", interfaceName);
+            AlivenessMonitorService alivenessMonitorService, DataBroker dataBroker, String interfaceName,
+            FlowCapableNodeConnector flowCapableNodeConnectorNew,
+            FlowCapableNodeConnector flowCapableNodeConnectorOld) {
+        LOG.debug("Updating interface state information for interface: {}", interfaceName);
         List<ListenableFuture<Void>> futures = new ArrayList<>();
-        WriteTransaction transaction = dataBroker.newWriteOnlyTransaction();
 
-        Interface.OperStatus operStatusNew = getOpState(flowCapableNodeConnectorNew);
+        Interface.OperStatus operStatusNew = InterfaceManagerCommonUtils.getOpState(flowCapableNodeConnectorNew);
         MacAddress macAddressNew = flowCapableNodeConnectorNew.getHardwareAddress();
 
-        Interface.OperStatus operStatusOld = getOpState(flowCapableNodeConnectorOld);
+        Interface.OperStatus operStatusOld = InterfaceManagerCommonUtils.getOpState(flowCapableNodeConnectorOld);
         MacAddress macAddressOld = flowCapableNodeConnectorOld.getHardwareAddress();
 
         boolean opstateModified = false;
@@ -61,20 +58,33 @@ public class OvsInterfaceStateUpdateHelper {
             return futures;
         }
 
+        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf
+            .interfaces.rev140508.interfaces.Interface iface = InterfaceManagerCommonUtils
+                .getInterfaceFromConfigDS(interfaceName, dataBroker);
+
+        // For monitoring enabled tunnels, skip opstate update
+        if (isTunnelInterface(iface) && !modifyTunnelOpState(iface, opstateModified)) {
+            LOG.debug("skip interface-state updation for monitoring enabled tunnel interface {}", interfaceName);
+            opstateModified = false;
+        }
+
+        if (!opstateModified && !hardwareAddressModified) {
+            LOG.debug("If State entry for port: {} Not Modified.", interfaceName);
+            return futures;
+        }
         InterfaceBuilder ifaceBuilder = new InterfaceBuilder();
         if (hardwareAddressModified) {
             LOG.debug("Hw-Address Modified for Port: {}", interfaceName);
             PhysAddress physAddress = new PhysAddress(macAddressNew.getValue());
             ifaceBuilder.setPhysAddress(physAddress);
         }
-
         // modify the attributes in interface operational DS
-        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface iface =
-                handleInterfaceStateUpdates(interfaceName, transaction, dataBroker,
-                        ifaceBuilder, opstateModified, flowCapableNodeConnectorNew.getName(), operStatusNew);
+        WriteTransaction transaction = dataBroker.newWriteOnlyTransaction();
+        handleInterfaceStateUpdates(iface, transaction, dataBroker, ifaceBuilder, opstateModified, interfaceName,
+                flowCapableNodeConnectorNew.getName(), operStatusNew);
 
         // start/stop monitoring based on opState
-        if(modifyTunnel(iface, opstateModified)){
+        if (isTunnelInterface(iface) && opstateModified) {
             handleTunnelMonitoringUpdates(alivenessMonitorService, dataBroker, iface.getAugmentation(IfTunnel.class),
                     iface.getName(), operStatusNew);
         }
@@ -83,72 +93,74 @@ public class OvsInterfaceStateUpdateHelper {
         return futures;
     }
 
-    public static void updateInterfaceStateOnNodeRemove(String interfaceName, FlowCapableNodeConnector flowCapableNodeConnector,
-                                                        DataBroker dataBroker, AlivenessMonitorService alivenessMonitorService,
-                                                        WriteTransaction transaction){
+    public static void updateInterfaceStateOnNodeRemove(String interfaceName,
+            FlowCapableNodeConnector flowCapableNodeConnector, DataBroker dataBroker,
+            AlivenessMonitorService alivenessMonitorService, WriteTransaction transaction) {
         LOG.debug("Updating interface oper-status to UNKNOWN for : {}", interfaceName);
 
         InterfaceBuilder ifaceBuilder = new InterfaceBuilder();
-        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface iface =
-                handleInterfaceStateUpdates(interfaceName,transaction, dataBroker,
-                        ifaceBuilder, true, flowCapableNodeConnector.getName(),
-                        Interface.OperStatus.Unknown);
-        if (InterfaceManagerCommonUtils.isTunnelInterface(iface)){
+        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang
+            .ietf.interfaces.rev140508.interfaces.Interface iface = InterfaceManagerCommonUtils
+                .getInterfaceFromConfigDS(interfaceName, dataBroker);
+        handleInterfaceStateUpdates(iface, transaction, dataBroker, ifaceBuilder, true, interfaceName,
+                flowCapableNodeConnector.getName(), Interface.OperStatus.Unknown);
+        if (InterfaceManagerCommonUtils.isTunnelInterface(iface)) {
             handleTunnelMonitoringUpdates(alivenessMonitorService, dataBroker, iface.getAugmentation(IfTunnel.class),
                     interfaceName, Interface.OperStatus.Unknown);
         }
     }
 
-    public static Interface.OperStatus getOpState(FlowCapableNodeConnector flowCapableNodeConnector){
-        Interface.OperStatus operStatus =
-                (flowCapableNodeConnector.getState().isLive() &&
-                        !flowCapableNodeConnector.getConfiguration().isPORTDOWN())
-                        ? Interface.OperStatus.Up: Interface.OperStatus.Down;
-        return operStatus;
-    }
-
-    public static org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface
-    handleInterfaceStateUpdates(String interfaceName, WriteTransaction transaction,
-                                DataBroker dataBroker, InterfaceBuilder ifaceBuilder, boolean opStateModified,
-                                String portName,
-                                org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface.OperStatus opState){
+    public static void handleInterfaceStateUpdates(
+            org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang
+                .ietf.interfaces.rev140508.interfaces.Interface iface,
+            WriteTransaction transaction, DataBroker dataBroker, InterfaceBuilder ifaceBuilder, boolean opStateModified,
+            String interfaceName, String portName, Interface.OperStatus opState) {
+        // if interface config DS is null, do the update only for the
+        // lower-layer-interfaces
+        // which have no corresponding config entries
+        if (iface == null && !interfaceName.equals(portName)) {
+            return;
+        }
         LOG.debug("updating interface state entry for {}", interfaceName);
         InstanceIdentifier<Interface> ifStateId = IfmUtil.buildStateInterfaceId(interfaceName);
         ifaceBuilder.setKey(new InterfaceKey(interfaceName));
-        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface iface =
-                InterfaceManagerCommonUtils.getInterfaceFromConfigDS(interfaceName, dataBroker);
-        // if interface config DS is null, do the update only for the lower-layer-interfaces
-        // which have no corresponding config entries
-        if(iface == null && interfaceName != portName){
-            return null;
-        }
         if (modifyOpState(iface, opStateModified)) {
             LOG.debug("updating interface oper status as {} for {}", opState.name(), interfaceName);
             ifaceBuilder.setOperStatus(opState);
         }
         transaction.merge(LogicalDatastoreType.OPERATIONAL, ifStateId, ifaceBuilder.build(), false);
-
-        return iface;
     }
 
-    public static void handleTunnelMonitoringUpdates(AlivenessMonitorService alivenessMonitorService, DataBroker dataBroker,
-                                                     IfTunnel ifTunnel, String interfaceName,
-                                                     Interface.OperStatus operStatus){
-
+    public static void handleTunnelMonitoringUpdates(AlivenessMonitorService alivenessMonitorService,
+            DataBroker dataBroker, IfTunnel ifTunnel, String interfaceName, Interface.OperStatus operStatus) {
         LOG.debug("handling tunnel monitoring updates for {} due to opstate modification", interfaceName);
-        if (operStatus == Interface.OperStatus.Down || operStatus == Interface.OperStatus.Unknown)
+        if (operStatus == Interface.OperStatus.Down || operStatus == Interface.OperStatus.Unknown) {
             AlivenessMonitorUtils.stopLLDPMonitoring(alivenessMonitorService, dataBroker, ifTunnel, interfaceName);
-        else
+        } else {
             AlivenessMonitorUtils.startLLDPMonitoring(alivenessMonitorService, dataBroker, ifTunnel, interfaceName);
+        }
     }
 
-    public static boolean modifyOpState(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface iface,
-                                        boolean opStateModified){
-        return (opStateModified && (iface == null || iface != null && iface.isEnabled()));
+    public static boolean modifyOpState(
+            org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf
+                .interfaces.rev140508.interfaces.Interface iface,
+            boolean opStateModified) {
+        return opStateModified && (iface == null || iface != null && iface.isEnabled());
     }
 
-    public static boolean modifyTunnel(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface iface,
-                                       boolean opStateModified){
-        return modifyOpState(iface, opStateModified) && iface != null && iface.getAugmentation(IfTunnel.class) != null;
+    public static boolean isTunnelInterface(
+            org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang
+                .ietf.interfaces.rev140508.interfaces.Interface iface) {
+        return iface != null && iface.getAugmentation(IfTunnel.class) != null;
+    }
+
+    public static boolean modifyTunnelOpState(
+            org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang
+                .ietf.interfaces.rev140508.interfaces.Interface iface,
+            boolean opStateModified) {
+        if (!iface.getAugmentation(IfTunnel.class).isMonitorEnabled()) {
+            return modifyOpState(iface, opStateModified);
+        }
+        return false;
     }
 }