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 java.util.List;
  11 import java.util.Optional;
  12 import java.util.concurrent.ExecutionException;
  13 import java.util.concurrent.Future;
  14 import org.eclipse.jdt.annotation.Nullable;
  15 import org.opendaylight.genius.datastoreutils.SingleTransactionDataBroker;
  16 import org.opendaylight.mdsal.binding.api.DataBroker;
  17 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  18 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.Interfaces;
  19 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfacesState;
  20 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
  21 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface;
  22 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.GetDpidFromInterfaceInput;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.GetDpidFromInterfaceInputBuilder;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.GetDpidFromInterfaceOutput;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.OdlInterfaceRpcService;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.ServiceBindings;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.ServiceModeIngress;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.ServiceTypeFlowBased;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.StypeOpenflowBuilder;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.ServicesInfo;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.ServicesInfoKey;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.services.info.BoundServices;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.services.info.BoundServicesBuilder;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.services.info.BoundServicesKey;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.DpnEndpoints;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.dpn.endpoints.DPNTEPsInfo;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.dpn.endpoints.DPNTEPsInfoKey;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.dpn.endpoints.dpn.teps.info.TunnelEndPoints;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
  42 import org.opendaylight.yangtools.yang.binding.DataObject;
  43 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  44 import org.opendaylight.yangtools.yang.common.RpcResult;
  45 import org.opendaylight.yangtools.yang.common.Uint64;
  46 import org.slf4j.Logger;
  47 import org.slf4j.LoggerFactory;
  48
  49 public final class InterfaceUtils {
  50     private static final Logger LOG = LoggerFactory.getLogger(InterfaceUtils.class);
  51     private static String OF_URI_SEPARATOR = ":";
  52
  53     private InterfaceUtils() {
  54
  55     }
  56
  57     public static Uint64 getDpnForInterface(OdlInterfaceRpcService interfaceManagerRpcService, String ifName) {
  58         Uint64 nodeId = Uint64.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, Uint64 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         Uint64 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(augBuilder.build()).build();
 106     }
 107
 108     public static boolean isOperational(DataBroker dataBroker, String ifName) {
 109         return getInterfaceStateFromOperDS(dataBroker, ifName) != null;
 110     }
 111
 112     public static InstanceIdentifier<Interface> buildStateInterfaceId(String interfaceName) {
 113         InstanceIdentifier.InstanceIdentifierBuilder<Interface> idBuilder =
 114             InstanceIdentifier.builder(InterfacesState.class)
 115                 .child(
 116                     org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces
 117                         .state.Interface.class,
 118                     new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces
 119                         .state.InterfaceKey(
 120                         interfaceName));
 121         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces
 122             .rev140508.interfaces.state.Interface>
 123             id = idBuilder.build();
 124         return id;
 125     }
 126
 127     public static org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state
 128         .@Nullable Interface getInterfaceStateFromOperDS(
 129         DataBroker dataBroker, String interfaceName) {
 130         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces
 131             .rev140508.interfaces.state.Interface>
 132             ifStateId =
 133             buildStateInterfaceId(interfaceName);
 134         Optional<Interface> ifStateOptional = read(dataBroker, LogicalDatastoreType.OPERATIONAL, ifStateId);
 135         if (ifStateOptional.isPresent()) {
 136             return ifStateOptional.get();
 137         }
 138
 139         return null;
 140     }
 141
 142     public static org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces
 143         .@Nullable Interface getInterface(
 144         DataBroker broker, String interfaceName) {
 145         Optional<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces
 146             .Interface>
 147             optInterface = read(broker, LogicalDatastoreType.CONFIGURATION, getInterfaceIdentifier(interfaceName));
 148         if (optInterface.isPresent()) {
 149             return optInterface.get();
 150         }
 151         return null;
 152     }
 153
 154     public static Optional<String> getMacAddressForInterface(DataBroker dataBroker, String interfaceName) {
 155         Optional<String> macAddressOptional = Optional.empty();
 156         InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces
 157             .rev140508.interfaces.state.Interface>
 158             ifStateId =
 159             buildStateInterfaceId(interfaceName);
 160         Optional<Interface> ifStateOptional = read(dataBroker, LogicalDatastoreType.OPERATIONAL, ifStateId);
 161         if (ifStateOptional.isPresent()) {
 162             PhysAddress macAddress = ifStateOptional.get().getPhysAddress();
 163             if (macAddress != null) {
 164                 macAddressOptional = Optional.of(macAddress.getValue());
 165             }
 166         }
 167         return macAddressOptional;
 168     }
 169
 170     public static Optional<String> getMacAddressFromInterfaceState(Interface ifState) {
 171         Optional<String> macAddressOptional = Optional.empty();
 172         PhysAddress macAddress = ifState.getPhysAddress();
 173         if (macAddress != null) {
 174             macAddressOptional = Optional.of(macAddress.getValue());
 175         }
 176         return macAddressOptional;
 177     }
 178
 179     public static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces
 180         .rev140508.interfaces.Interface> getInterfaceIdentifier(
 181         String interfaceName) {
 182         return InstanceIdentifier.builder(Interfaces.class)
 183             .child(
 184                 org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces
 185                     .Interface.class,
 186                 new InterfaceKey(interfaceName)).build();
 187     }
 188
 189     public static String getDpnFromNodeConnectorId(NodeConnectorId portId) {
 190         /*
 191          * NodeConnectorId is of form 'openflow:dpnid:portnum'
 192          */
 193         String[] split = portId.getValue().split(OF_URI_SEPARATOR);
 194         return split[1];
 195     }
 196
 197     public static Uint64 getDpIdFromInterface(
 198         org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface
 199             ifState) {
 200         String lowerLayerIf = ifState.getLowerLayerIf().get(0);
 201         NodeConnectorId nodeConnectorId = new NodeConnectorId(lowerLayerIf);
 202         return Uint64.valueOf(getDpnFromNodeConnectorId(nodeConnectorId)).intern();
 203     }
 204
 205     private static <T extends DataObject> Optional<T> read(DataBroker broker, LogicalDatastoreType datastoreType,
 206             InstanceIdentifier<T> path) {
 207         try {
 208             return SingleTransactionDataBroker.syncReadOptional(broker, datastoreType, path);
 209         } catch (ExecutionException | InterruptedException e) {
 210             throw new RuntimeException(e);
 211         }
 212     }
 213 }