vpnmanager/api/src/main/java/org/opendaylight/netvirt/vpnmanager/api/InterfaceUtils.java

   1 /*
   2  * Copyright (c) 2015 - 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.netvirt.vpnmanager.api;
   9
  10 import com.google.common.base.Optional;
  11 import java.math.BigInteger;
  12 import java.util.List;
  13 import java.util.concurrent.ExecutionException;
  14 import java.util.concurrent.Future;
  15 import org.eclipse.jdt.annotation.Nullable;
  16 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  17 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  18 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
  19 import org.opendaylight.genius.datastoreutils.SingleTransactionDataBroker;
  20 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.Interfaces;
  21 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfacesState;
  22 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
  23 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface;
  24 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.GetDpidFromInterfaceInput;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.GetDpidFromInterfaceInputBuilder;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.GetDpidFromInterfaceOutput;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.OdlInterfaceRpcService;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.ServiceBindings;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.ServiceModeIngress;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.ServiceTypeFlowBased;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.StypeOpenflow;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.StypeOpenflowBuilder;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.ServicesInfo;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.ServicesInfoKey;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.services.info.BoundServices;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.services.info.BoundServicesBuilder;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.services.info.BoundServicesKey;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.DpnEndpoints;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.dpn.endpoints.DPNTEPsInfo;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.dpn.endpoints.DPNTEPsInfoKey;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.dpn.endpoints.dpn.teps.info.TunnelEndPoints;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
  45 import org.opendaylight.yangtools.yang.binding.DataObject;
  46 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  47 import org.opendaylight.yangtools.yang.common.RpcResult;
  48 import org.slf4j.Logger;
  49 import org.slf4j.LoggerFactory;
  50
  51 public final class InterfaceUtils {
  52     private static final Logger LOG = LoggerFactory.getLogger(InterfaceUtils.class);
  53     private static String OF_URI_SEPARATOR = ":";
  54
  55     private InterfaceUtils() { }
  56
  57     public static BigInteger getDpnForInterface(OdlInterfaceRpcService interfaceManagerRpcService, String ifName) {
  58         BigInteger nodeId = BigInteger.ZERO;
  59         try {
  60             GetDpidFromInterfaceInput
  61                 dpIdInput =
  62                 new GetDpidFromInterfaceInputBuilder().setIntfName(ifName).build();
  63             Future<RpcResult<GetDpidFromInterfaceOutput>>
  64                 dpIdOutput =
  65                 interfaceManagerRpcService.getDpidFromInterface(dpIdInput);
  66             RpcResult<GetDpidFromInterfaceOutput> dpIdResult = dpIdOutput.get();
  67             if (dpIdResult.isSuccessful()) {
  68                 nodeId = dpIdResult.getResult().getDpid();
  69             } else {
  70                 LOG.info("getDpnForInterface: Could not retrieve DPN Id for interface {}", ifName);
  71             }
  72         } catch (NullPointerException | InterruptedException | ExecutionException e) {
  73             LOG.error("getDpnForInterface: Exception when getting dpn for interface {}", ifName, e);
  74         }
  75         return nodeId;
  76     }
  77
  78     public static String getEndpointIpAddressForDPN(DataBroker broker, BigInteger dpnId) {
  79         String nextHopIp = null;
  80         InstanceIdentifier<DPNTEPsInfo> tunnelInfoId =
  81                 InstanceIdentifier.builder(DpnEndpoints.class).child(DPNTEPsInfo.class,
  82                         new DPNTEPsInfoKey(dpnId)).build();
  83         Optional<DPNTEPsInfo> tunnelInfo = read(broker, LogicalDatastoreType.CONFIGURATION, tunnelInfoId);
  84         if (tunnelInfo.isPresent()) {
  85             List<TunnelEndPoints> nexthopIpList = tunnelInfo.get().getTunnelEndPoints();
  86             if (nexthopIpList != null && !nexthopIpList.isEmpty()) {
  87                 nextHopIp = nexthopIpList.get(0).getIpAddress().stringValue();
  88             }
  89         }
  90         return nextHopIp;
  91     }
  92
  93     public static InstanceIdentifier<BoundServices> buildServiceId(String vpnInterfaceName, short serviceIndex) {
  94         return InstanceIdentifier.builder(ServiceBindings.class).child(ServicesInfo.class,
  95             new ServicesInfoKey(vpnInterfaceName, ServiceModeIngress.class))
  96             .child(BoundServices.class, new BoundServicesKey(serviceIndex)).build();
  97     }
  98
  99     public static BoundServices getBoundServices(String serviceName, short servicePriority, int flowPriority,
 100         BigInteger cookie, List<Instruction> instructions) {
 101         StypeOpenflowBuilder augBuilder =
 102             new StypeOpenflowBuilder().setFlowCookie(cookie).setFlowPriority(flowPriority).setInstruction(instructions);
 103         return new BoundServicesBuilder().withKey(new BoundServicesKey(servicePriority))
 104             .setServiceName(serviceName).setServicePriority(servicePriority)
 105             .setServiceType(ServiceTypeFlowBased.class).addAugmentation(StypeOpenflow.class,
 106                 augBuilder.build()).build();
 107     }
 108
 109     public static boolean isOperational(DataBroker dataBroker, String ifName) {
 110         return getInterfaceStateFromOperDS(dataBroker, ifName) != null;
 111     }
 112
 113     public static InstanceIdentifier<Interface> buildStateInterfaceId(String interfaceName) {
 114         InstanceIdentifier.InstanceIdentifierBuilder<Interface> idBuilder =
 115             InstanceIdentifier.builder(InterfacesState.class)
 116                 .child(
 117                     org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces
 118                         .state.Interface.class,
 119                     new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces
 120                         .state.InterfaceKey(
 121                         interfaceName));
 122         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces
 123             .rev140508.interfaces.state.Interface>
 124             id = idBuilder.build();
 125         return id;
 126     }
 127
 128     public static org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state
 129         .@Nullable Interface getInterfaceStateFromOperDS(
 130         DataBroker dataBroker, String interfaceName) {
 131         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces
 132             .rev140508.interfaces.state.Interface>
 133             ifStateId =
 134             buildStateInterfaceId(interfaceName);
 135         Optional<Interface> ifStateOptional = read(dataBroker, LogicalDatastoreType.OPERATIONAL, ifStateId);
 136         if (ifStateOptional.isPresent()) {
 137             return ifStateOptional.get();
 138         }
 139
 140         return null;
 141     }
 142
 143     public static org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces
 144         .@Nullable Interface getInterface(
 145         DataBroker broker, String interfaceName) {
 146         Optional<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces
 147             .Interface>
 148             optInterface = read(broker, LogicalDatastoreType.CONFIGURATION, getInterfaceIdentifier(interfaceName));
 149         if (optInterface.isPresent()) {
 150             return optInterface.get();
 151         }
 152         return null;
 153     }
 154
 155     public static Optional<String> getMacAddressForInterface(DataBroker dataBroker, String interfaceName) {
 156         Optional<String> macAddressOptional = Optional.absent();
 157         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces
 158             .rev140508.interfaces.state.Interface>
 159             ifStateId =
 160             buildStateInterfaceId(interfaceName);
 161         Optional<Interface> ifStateOptional = read(dataBroker, LogicalDatastoreType.OPERATIONAL, ifStateId);
 162         if (ifStateOptional.isPresent()) {
 163             PhysAddress macAddress = ifStateOptional.get().getPhysAddress();
 164             if (macAddress != null) {
 165                 macAddressOptional = Optional.of(macAddress.getValue());
 166             }
 167         }
 168         return macAddressOptional;
 169     }
 170
 171     public static Optional<String> getMacAddressFromInterfaceState(Interface ifState) {
 172         Optional<String> macAddressOptional = Optional.absent();
 173         PhysAddress macAddress = ifState.getPhysAddress();
 174         if (macAddress != null) {
 175             macAddressOptional = Optional.of(macAddress.getValue());
 176         }
 177         return macAddressOptional;
 178     }
 179
 180     public static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces
 181         .rev140508.interfaces.Interface> getInterfaceIdentifier(
 182         String interfaceName) {
 183         return InstanceIdentifier.builder(Interfaces.class)
 184             .child(
 185                 org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces
 186                     .Interface.class,
 187                 new InterfaceKey(interfaceName)).build();
 188     }
 189
 190     public static String getDpnFromNodeConnectorId(NodeConnectorId portId) {
 191         /*
 192          * NodeConnectorId is of form 'openflow:dpnid:portnum'
 193          */
 194         String[] split = portId.getValue().split(OF_URI_SEPARATOR);
 195         return split[1];
 196     }
 197
 198     public static BigInteger getDpIdFromInterface(
 199         org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface
 200             ifState) {
 201         String lowerLayerIf = ifState.getLowerLayerIf().get(0);
 202         NodeConnectorId nodeConnectorId = new NodeConnectorId(lowerLayerIf);
 203         return new BigInteger(getDpnFromNodeConnectorId(nodeConnectorId));
 204     }
 205
 206     private static <T extends DataObject> Optional<T> read(DataBroker broker, LogicalDatastoreType datastoreType,
 207             InstanceIdentifier<T> path) {
 208         try {
 209             return SingleTransactionDataBroker.syncReadOptional(broker, datastoreType, path);
 210         } catch (ReadFailedException e) {
 211             throw new RuntimeException(e);
 212         }
 213     }
 214 }