interfacemanager/interfacemanager-impl/src/main/java/org/opendaylight/genius/interfacemanager/renderer/ovs/statehelpers/OvsInterfaceStateUpdateHelper.java

   1 /*
   2  * Copyright (c) 2016 Ericsson India Global Services Pvt Ltd. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.genius.interfacemanager.renderer.ovs.statehelpers;
   9
  10 import com.google.common.util.concurrent.ListenableFuture;
  11 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  12 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  13 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  14 import org.opendaylight.genius.interfacemanager.IfmUtil;
  15 import org.opendaylight.genius.interfacemanager.commons.AlivenessMonitorUtils;
  16 import org.opendaylight.genius.interfacemanager.commons.InterfaceManagerCommonUtils;
  17 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface;
  18 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.InterfaceBuilder;
  19 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.InterfaceKey;
  20 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress;
  21 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeConnector;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.alivenessmonitor.rev160411.AlivenessMonitorService;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.IfTunnel;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnector;
  27 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  28 import org.slf4j.Logger;
  29 import org.slf4j.LoggerFactory;
  30
  31 import java.util.ArrayList;
  32 import java.util.List;
  33
  34 public class OvsInterfaceStateUpdateHelper {
  35     private static final Logger LOG = LoggerFactory.getLogger(OvsInterfaceStateUpdateHelper.class);
  36
  37     public static List<ListenableFuture<Void>> updateState(InstanceIdentifier<FlowCapableNodeConnector> key,
  38                                                            AlivenessMonitorService alivenessMonitorService,
  39                                                            DataBroker dataBroker, String interfaceName,
  40                                                            FlowCapableNodeConnector flowCapableNodeConnectorNew,
  41                                                            FlowCapableNodeConnector flowCapableNodeConnectorOld) {
  42         LOG.debug("Update of Interface State for port: {}", interfaceName);
  43         List<ListenableFuture<Void>> futures = new ArrayList<>();
  44         WriteTransaction transaction = dataBroker.newWriteOnlyTransaction();
  45
  46         Interface.OperStatus operStatusNew = getOpState(flowCapableNodeConnectorNew);
  47         MacAddress macAddressNew = flowCapableNodeConnectorNew.getHardwareAddress();
  48
  49         Interface.OperStatus operStatusOld = getOpState(flowCapableNodeConnectorOld);
  50         MacAddress macAddressOld = flowCapableNodeConnectorOld.getHardwareAddress();
  51
  52         boolean opstateModified = false;
  53         boolean hardwareAddressModified = false;
  54         if (!operStatusNew.equals(operStatusOld)) {
  55             opstateModified = true;
  56         }
  57         if (!macAddressNew.equals(macAddressOld)) {
  58             hardwareAddressModified = true;
  59         }
  60
  61         if (!opstateModified && !hardwareAddressModified) {
  62             LOG.debug("If State entry for port: {} Not Modified.", interfaceName);
  63             return futures;
  64         }
  65
  66         InterfaceBuilder ifaceBuilder = new InterfaceBuilder();
  67         if (hardwareAddressModified) {
  68             LOG.debug("Hw-Address Modified for Port: {}", interfaceName);
  69             PhysAddress physAddress = new PhysAddress(macAddressNew.getValue());
  70             ifaceBuilder.setPhysAddress(physAddress);
  71         }
  72         // modify the attributes in interface operational DS
  73         org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface iface =
  74                 handleInterfaceStateUpdates(interfaceName, transaction, dataBroker,
  75                         ifaceBuilder, opstateModified, flowCapableNodeConnectorNew.getName(), operStatusNew);
  76
  77         // start/stop monitoring based on opState
  78         if(modifyTunnel(iface, opstateModified)){
  79             handleTunnelMonitoringUpdates(alivenessMonitorService, dataBroker, iface.getAugmentation(IfTunnel.class),
  80                     iface.getName(), operStatusNew);
  81         }
  82
  83         futures.add(transaction.submit());
  84         return futures;
  85     }
  86
  87     public static void updateInterfaceStateOnNodeRemove(String interfaceName, FlowCapableNodeConnector flowCapableNodeConnector,
  88                                                         DataBroker dataBroker, AlivenessMonitorService alivenessMonitorService,
  89                                                         WriteTransaction transaction){
  90         LOG.debug("Updating interface oper-status to UNKNOWN for : {}", interfaceName);
  91
  92         InterfaceBuilder ifaceBuilder = new InterfaceBuilder();
  93         org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface iface =
  94                 handleInterfaceStateUpdates(interfaceName,transaction, dataBroker,
  95                         ifaceBuilder, true, flowCapableNodeConnector.getName(),
  96                         Interface.OperStatus.Unknown);
  97         if (InterfaceManagerCommonUtils.isTunnelInterface(iface)){
  98             handleTunnelMonitoringUpdates(alivenessMonitorService, dataBroker, iface.getAugmentation(IfTunnel.class),
  99                     interfaceName, Interface.OperStatus.Unknown);
 100         }
 101     }
 102
 103     public static Interface.OperStatus getOpState(FlowCapableNodeConnector flowCapableNodeConnector){
 104         Interface.OperStatus operStatus =
 105                 (flowCapableNodeConnector.getState().isLive() &&
 106                         !flowCapableNodeConnector.getConfiguration().isPORTDOWN())
 107                         ? Interface.OperStatus.Up: Interface.OperStatus.Down;
 108         return operStatus;
 109     }
 110
 111     public static org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface
 112     handleInterfaceStateUpdates(String interfaceName, WriteTransaction transaction,
 113                                 DataBroker dataBroker, InterfaceBuilder ifaceBuilder, boolean opStateModified,
 114                                 String portName,
 115                                 org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface.OperStatus opState){
 116         LOG.debug("updating interface state entry for {}", interfaceName);
 117         InstanceIdentifier<Interface> ifStateId = IfmUtil.buildStateInterfaceId(interfaceName);
 118         ifaceBuilder.setKey(new InterfaceKey(interfaceName));
 119         org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface iface =
 120                 InterfaceManagerCommonUtils.getInterfaceFromConfigDS(interfaceName, dataBroker);
 121         // if interface config DS is null, do the update only for the lower-layer-interfaces
 122         // which have no corresponding config entries
 123         if(iface == null && interfaceName != portName){
 124             return null;
 125         }
 126         if (modifyOpState(iface, opStateModified)) {
 127             LOG.debug("updating interface oper status as {} for {}", opState.name(), interfaceName);
 128             ifaceBuilder.setOperStatus(opState);
 129         }
 130         transaction.merge(LogicalDatastoreType.OPERATIONAL, ifStateId, ifaceBuilder.build(), false);
 131
 132         return iface;
 133     }
 134
 135     public static void handleTunnelMonitoringUpdates(AlivenessMonitorService alivenessMonitorService, DataBroker dataBroker,
 136                                                      IfTunnel ifTunnel, String interfaceName,
 137                                                      Interface.OperStatus operStatus){
 138
 139         LOG.debug("handling tunnel monitoring updates for {} due to opstate modification", interfaceName);
 140         if (operStatus == Interface.OperStatus.Down || operStatus == Interface.OperStatus.Unknown)
 141             AlivenessMonitorUtils.stopLLDPMonitoring(alivenessMonitorService, dataBroker, ifTunnel, interfaceName);
 142         else
 143             AlivenessMonitorUtils.startLLDPMonitoring(alivenessMonitorService, dataBroker, ifTunnel, interfaceName);
 144     }
 145
 146     public static boolean modifyOpState(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface iface,
 147                                         boolean opStateModified){
 148         return (opStateModified && (iface == null || iface != null && iface.isEnabled()));
 149     }
 150
 151     public static boolean modifyTunnel(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface iface,
 152                                        boolean opStateModified){
 153         return modifyOpState(iface, opStateModified) && iface != null && iface.getAugmentation(IfTunnel.class) != null;
 154     }
 155 }