renderers/vpp/src/main/java/org/opendaylight/groupbasedpolicy/renderer/vpp/lisp/util/ConfigManagerHelper.java

   1 /*
   2  * Copyright (c) 2017 Cisco Systems. 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
   9 package org.opendaylight.groupbasedpolicy.renderer.vpp.lisp.util;
  10
  11 import com.google.common.base.Optional;
  12 import com.google.common.base.Preconditions;
  13 import com.google.common.util.concurrent.Futures;
  14 import com.google.common.util.concurrent.ListenableFuture;
  15 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  16 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  17 import org.opendaylight.groupbasedpolicy.renderer.vpp.iface.VppPathMapper;
  18 import org.opendaylight.groupbasedpolicy.renderer.vpp.lisp.LispState;
  19 import org.opendaylight.groupbasedpolicy.renderer.vpp.lisp.LispStateManager;
  20 import org.opendaylight.groupbasedpolicy.renderer.vpp.lisp.exception.LispNotFoundException;
  21 import org.opendaylight.groupbasedpolicy.renderer.vpp.util.GbpNetconfTransaction;
  22 import org.opendaylight.groupbasedpolicy.renderer.vpp.util.LispUtil;
  23 import org.opendaylight.groupbasedpolicy.renderer.vpp.util.MountedDataBrokerProvider;
  24 import org.opendaylight.groupbasedpolicy.renderer.vpp.util.VppIidFactory;
  25 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
  26 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.iana._if.type.rev140508.EthernetCsmacd;
  27 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone;
  28 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix;
  29 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.Interfaces;
  30 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfacesState;
  31 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface;
  32 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.Interface1;
  33 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.Interface2;
  34 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces.state._interface.Ipv4;
  35 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces.state._interface.ipv4.Address;
  36 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.Ipv4Afi;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.base_endpoint.rev160427.common.endpoint.fields.network.containment.Containment;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.base_endpoint.rev160427.common.endpoint.fields.network.containment.containment.NetworkDomainContainment;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.base_endpoint.rev160427.has.absolute.location.absolute.location.LocationType;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.base_endpoint.rev160427.has.absolute.location.absolute.location.location.type.ExternalLocationCase;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.forwarding.l2_l3.rev160427.IpPrefixType;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.renderer.renderer.policy.configuration.endpoints.AddressEndpointWithLocation;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.vpp_renderer.rev160425.config.VppEndpoint;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.lisp.rev170315.HmacKeyType;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.lisp.rev170315.dp.subtable.grouping.local.mappings.local.mapping.Eid;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.lisp.rev170315.hmac.key.grouping.HmacKey;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev170315.interfaces._interface.Routing;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev170315.interfaces._interface.RoutingBuilder;
  49 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  50 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  51 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
  52 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  53 import org.slf4j.Logger;
  54 import org.slf4j.LoggerFactory;
  55
  56 import javax.annotation.Nonnull;
  57 import java.util.List;
  58 import java.util.Map;
  59 import java.util.Set;
  60
  61
  62 /**
  63  * Created by Shakib Ahmed on 3/31/17.
  64  */
  65 public class ConfigManagerHelper {
  66     private static final Logger LOG = LoggerFactory.getLogger(ConfigManagerHelper.class);
  67
  68     private static final String TENANT_INTERFACE = "tenant-interface";
  69     private MountedDataBrokerProvider mountedDataBrokerProvider;
  70
  71     public ConfigManagerHelper(MountedDataBrokerProvider mountedDataBrokerProvider) {
  72         this.mountedDataBrokerProvider = mountedDataBrokerProvider;
  73     }
  74
  75     public Optional<DataBroker> getPotentialExternalDataBroker(AddressEndpointWithLocation addressEpWithLoc) {
  76         ExternalLocationCase externalLocationCase = resolveAndValidateLocation(addressEpWithLoc);
  77         InstanceIdentifier<?> vppNodeIid = externalLocationCase.getExternalNodeMountPoint();
  78         String interfacePath = externalLocationCase.getExternalNodeConnector();
  79
  80         Optional<DataBroker> potentialVppDataProvider = mountedDataBrokerProvider.getDataBrokerForMountPoint(vppNodeIid);
  81
  82         Preconditions.checkArgument(potentialVppDataProvider.isPresent(),
  83                 "Cannot resolve data broker for interface path: {}", interfacePath);
  84
  85         return potentialVppDataProvider;
  86     }
  87
  88     public Optional<DataBroker> getPotentialExternalDataBroker(VppEndpoint vppEp) {
  89         InstanceIdentifier<Node> vppNodeIid = VppIidFactory.getNetconfNodeIid(vppEp.getVppNodeId());
  90         Optional<DataBroker> potentialVppDataProvider =
  91                 mountedDataBrokerProvider.getDataBrokerForMountPoint(vppNodeIid);
  92
  93         Preconditions.checkArgument(potentialVppDataProvider.isPresent(),
  94                 "Cannot resolve data broker for Vpp Endpoint: {}", vppEp);
  95         return potentialVppDataProvider;
  96     }
  97
  98     public Optional<DataBroker> getPotentialExternalDataBroker(String hostId) {
  99         InstanceIdentifier<Node> nodeIid = VppIidFactory.getNetconfNodeIid(new NodeId(hostId));
 100         Optional<DataBroker> potentialVppDataProvider = mountedDataBrokerProvider.getDataBrokerForMountPoint(nodeIid);
 101         Preconditions.checkArgument(potentialVppDataProvider.isPresent(),
 102                 "Data Broker not found for {}", hostId);
 103         return potentialVppDataProvider;
 104     }
 105
 106     public Optional<String> getHostName(AddressEndpointWithLocation addrEp) {
 107         ExternalLocationCase locationCase = resolveAndValidateLocation(addrEp);
 108         NodeKey nodeKey = locationCase.getExternalNodeMountPoint().firstKeyOf(Node.class);
 109         String hostId = Preconditions.checkNotNull(nodeKey.getNodeId().getValue(),
 110                 "Host Id extraction failed from address endpoint: {}", addrEp);
 111         return Optional.fromNullable(hostId);
 112     }
 113
 114     public ExternalLocationCase resolveAndValidateLocation(AddressEndpointWithLocation addrEpWithLoc) {
 115         LocationType locationType = addrEpWithLoc.getAbsoluteLocation().getLocationType();
 116         if (!(locationType instanceof ExternalLocationCase)) {
 117             throw new IllegalArgumentException("Endpoint does not have external location " + addrEpWithLoc);
 118         }
 119         ExternalLocationCase result = (ExternalLocationCase) locationType;
 120         if (result.getExternalNodeMountPoint() == null || result.getExternalNodeConnector() == null) {
 121             throw new IllegalArgumentException(
 122                     "Endpoint does not have external-node-mount-point or external-node-connector " + addrEpWithLoc);
 123         }
 124         return result;
 125     }
 126
 127     //This is almost identical to VBD's equivalent method
 128     public ListenableFuture<String> readRlocInterface(@Nonnull String hostName, @Nonnull DataBroker vppDataBroker) {
 129         Preconditions.checkNotNull(hostName, "Hostname is null!");
 130         Preconditions.checkNotNull(vppDataBroker, "Vpp DataBroker is null!");
 131         final Optional<InterfacesState> opInterfaceState = GbpNetconfTransaction.read(vppDataBroker,
 132                 LogicalDatastoreType.OPERATIONAL, InstanceIdentifier.create(InterfacesState.class),
 133                 GbpNetconfTransaction.RETRY_COUNT);
 134
 135         if (!opInterfaceState.isPresent()) {
 136             LOG.debug("There appear to be no interfaces on node {}.", hostName);
 137             return Futures.immediateFailedFuture(new LispNotFoundException("No interfaces found"));
 138         }
 139
 140         String interfaceName = null;
 141         for(Interface intf: opInterfaceState.get().getInterface()) {
 142             if(!ipAddressPresent(intf)) {
 143                 continue;
 144             }
 145             interfaceName = intf.getName();
 146         }
 147
 148         final Optional<Interfaces> opInterfaces =
 149                 GbpNetconfTransaction.read(vppDataBroker, LogicalDatastoreType.CONFIGURATION,
 150                         InstanceIdentifier.create(Interfaces.class), GbpNetconfTransaction.RETRY_COUNT);
 151
 152
 153         if (opInterfaces.isPresent()) {
 154             for (org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.
 155                     interfaces.Interface intf : opInterfaces.get().getInterface()) {
 156                 if (TENANT_INTERFACE.equals(intf.getDescription())
 157                         && ipAddressPresent(intf)
 158                         && intf.getType().equals(EthernetCsmacd.class)) {
 159                     return Futures.immediateFuture(intf.getName());
 160                 }
 161             }
 162         }
 163
 164         if (interfaceName == null) {
 165             LOG.warn("No interface with IP found for host {}", hostName);
 166             return Futures.immediateFailedFuture(new LispNotFoundException("No interface with Ip address found!"));
 167         }
 168         return Futures.immediateFuture(interfaceName);
 169     }
 170
 171     private boolean ipAddressPresent(Interface intf) {
 172         Interface2 augIntf = intf.getAugmentation(Interface2.class);
 173
 174         if (augIntf == null) {
 175             return false;
 176         }
 177
 178         Ipv4 ipv4 = augIntf.getIpv4();
 179
 180         if (ipv4 == null) {
 181             return false;
 182         }
 183
 184         final List<Address> addresses = ipv4.getAddress();
 185
 186         if (addresses == null || addresses.isEmpty()) {
 187             return false;
 188         }
 189
 190         final Ipv4AddressNoZone ip = addresses.iterator().next().getIp();
 191
 192         if (ip == null) {
 193             return false;
 194         }
 195
 196         return true;
 197     }
 198
 199     private boolean ipAddressPresent(final org.opendaylight.yang.gen.v1.urn.ietf.
 200             params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface intf) {
 201         final Interface1 augIntf = intf.getAugmentation(Interface1.class);
 202
 203         if (augIntf == null) {
 204             LOG.debug("Cannot get Interface1 augmentation for intf {}", intf);
 205             return false;
 206         }
 207
 208         final org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces._interface.Ipv4 ipv4 =
 209                 augIntf.getIpv4();
 210         if (ipv4 == null) {
 211             return false;
 212         }
 213
 214         final List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces._interface.ipv4.Address> addresses =
 215                 ipv4.getAddress();
 216         if (addresses == null || addresses.isEmpty()) {
 217             return false;
 218         }
 219
 220         final Ipv4AddressNoZone ip = addresses.iterator().next().getIp();
 221         if (ip == null) {
 222             return false;
 223         }
 224
 225         return true;
 226     }
 227
 228     public String constructLocatorSetName(int locatorSetCount) {
 229         return LispStateManager.DEFAULT_LOCATOR_SET_NAME_PREFIX + (locatorSetCount + 1);
 230     }
 231
 232     public String constructMappingName(int presentMappingCount) {
 233         return LispStateManager.DEFAULT_MAPPINGRECORD_NAME_PREFIX + (presentMappingCount + 1);
 234     }
 235
 236     public String getSubnet(AddressEndpointWithLocation addressEp) {
 237         String subnetUuid = null;
 238         Containment containment = addressEp.getNetworkContainment().getContainment();
 239         if (containment instanceof NetworkDomainContainment) {
 240             NetworkDomainContainment networkDomainContainment = (NetworkDomainContainment) containment;
 241             subnetUuid = networkDomainContainment.getNetworkDomainId().getValue();
 242         }
 243         return subnetUuid;
 244     }
 245
 246     public Eid getEid(AddressEndpointWithLocation addressEp, long vni) {
 247         String ipPrefix = getIpWithPrefixOfEndpoint(addressEp);
 248         return LispUtil.toEid(LispUtil.toIpv4(ipPrefix), vni, Ipv4Afi.class);
 249     }
 250
 251     public String getIpWithPrefixOfEndpoint(AddressEndpointWithLocation addressEp) {
 252         String ipPrefix = null;
 253         if (addressEp.getAddressType().equals(IpPrefixType.class)) {
 254             ipPrefix = addressEp.getAddress();
 255         }
 256         return Preconditions.checkNotNull(ipPrefix,
 257                 "No IP address found for Address Endpoint: {}", addressEp);
 258     }
 259
 260     public Ipv4Address getInterfaceIp(AddressEndpointWithLocation addressEp) {
 261         String ipPrefix = getIpWithPrefixOfEndpoint(addressEp);
 262         return LispUtil.toIpv4(ipPrefix).getIpv4();
 263     }
 264
 265     public Ipv4Prefix getInterfaceIpAsPrefix(AddressEndpointWithLocation addressEp) {
 266         return new Ipv4Prefix(getInterfaceIp(addressEp).getValue() + "/32");
 267     }
 268
 269     public String getFirstLocatorSetName(LispState lispState) {
 270         Set<Map.Entry<String, String >> locatorSet = lispState.getLocatorSetEntry();
 271         Preconditions.checkNotNull(locatorSet, "No locator set found!");
 272         if (!locatorSet.iterator().hasNext()) {
 273             return null;
 274         }
 275
 276         return locatorSet.iterator().next().getValue();
 277     }
 278
 279     public HmacKey getDefaultHmacKey() {
 280         return LispUtil.toHmacKey(HmacKeyType.Sha196Key, LispStateManager.DEFAULT_XTR_KEY);
 281     }
 282
 283     public Routing getRouting(long vrf) {
 284         return new RoutingBuilder().setIpv4VrfId(vrf).build();
 285     }
 286 }