pcep/tunnel/tunnel-provider/src/main/java/org/opendaylight/bgpcep/pcep/tunnel/provider/CreateTunnelInstructionExecutor.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. 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
   9 package org.opendaylight.bgpcep.pcep.tunnel.provider;
  10
  11 import static java.util.Objects.requireNonNull;
  12
  13 import com.google.common.base.Preconditions;
  14 import com.google.common.util.concurrent.Futures;
  15 import com.google.common.util.concurrent.ListenableFuture;
  16 import com.google.common.util.concurrent.MoreExecutors;
  17 import java.util.List;
  18 import java.util.Optional;
  19 import java.util.concurrent.ExecutionException;
  20 import org.opendaylight.bgpcep.pcep.topology.spi.AbstractInstructionExecutor;
  21 import org.opendaylight.bgpcep.programming.topology.TopologyProgrammingUtil;
  22 import org.opendaylight.mdsal.binding.api.DataBroker;
  23 import org.opendaylight.mdsal.binding.api.ReadTransaction;
  24 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  25 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  26 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone;
  27 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6AddressNoZone;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.AdministrativeStatus;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.Arguments2;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.Arguments2Builder;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.PcepCreateP2pTunnelInput1;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.lsp.object.LspBuilder;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.bandwidth.object.BandwidthBuilder;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.classtype.object.ClassTypeBuilder;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.endpoints.AddressFamily;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.endpoints.address.family.Ipv4CaseBuilder;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.endpoints.address.family.Ipv6CaseBuilder;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.endpoints.address.family.ipv4._case.Ipv4Builder;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.endpoints.address.family.ipv6._case.Ipv6Builder;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.endpoints.object.EndpointsObjBuilder;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.lspa.object.LspaBuilder;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev181109.AddLspInput;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev181109.AddLspInputBuilder;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev181109.NetworkTopologyPcepService;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev181109.OperationResult;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev181109.add.lsp.args.Arguments;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev181109.add.lsp.args.ArgumentsBuilder;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.pcep.programming.rev181109.PcepCreateP2pTunnelInput;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.programming.rev130930.TpReference;
  50 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
  51 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Link;
  52 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  53 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
  54 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPoint;
  55 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPointKey;
  56 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.nt.l3.unicast.igp.topology.rev131021.TerminationPoint1;
  57 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.nt.l3.unicast.igp.topology.rev131021.igp.termination.point.attributes.igp.termination.point.attributes.TerminationPointType;
  58 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.nt.l3.unicast.igp.topology.rev131021.igp.termination.point.attributes.igp.termination.point.attributes.termination.point.type.Ip;
  59 import org.opendaylight.yangtools.yang.binding.DataObject;
  60 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  61 import org.opendaylight.yangtools.yang.common.RpcResult;
  62
  63 final class CreateTunnelInstructionExecutor extends AbstractInstructionExecutor {
  64     private final DataBroker dataProvider;
  65     private final NetworkTopologyPcepService topologyService;
  66     private final PcepCreateP2pTunnelInput p2pTunnelInput;
  67
  68     CreateTunnelInstructionExecutor(final PcepCreateP2pTunnelInput p2pTunnelInput, final DataBroker dataProvider,
  69             final NetworkTopologyPcepService topologyService) {
  70         super(p2pTunnelInput);
  71         this.p2pTunnelInput = p2pTunnelInput;
  72         this.dataProvider = dataProvider;
  73         this.topologyService = topologyService;
  74     }
  75
  76     private static void checkLinkIsnotExistent(final InstanceIdentifier<Topology> tii,
  77             final AddLspInputBuilder addLspInput, final ReadTransaction rt) {
  78         final InstanceIdentifier<Link> lii = NodeChangedListener.linkIdentifier(tii, addLspInput.getNode(),
  79                 addLspInput.getName());
  80         try {
  81             Preconditions.checkState(!rt.read(LogicalDatastoreType.OPERATIONAL, lii).get().isPresent());
  82         } catch (final InterruptedException | ExecutionException e) {
  83             throw new IllegalStateException("Failed to ensure link existence.", e);
  84         }
  85     }
  86
  87     private static AddressFamily buildAddressFamily(final TerminationPoint sp, final TerminationPoint dp) {
  88         // We need the IGP augmentation -- it has IP addresses
  89         final TerminationPoint1 sp1 = requireNonNull(sp.augmentation(TerminationPoint1.class));
  90         final TerminationPoint1 dp1 = requireNonNull(dp.augmentation(TerminationPoint1.class));
  91
  92         // Get the types
  93         final TerminationPointType spt = sp1.getIgpTerminationPointAttributes().getTerminationPointType();
  94         final TerminationPointType dpt = dp1.getIgpTerminationPointAttributes().getTerminationPointType();
  95
  96         // The types have to match
  97         Preconditions.checkArgument(spt.getImplementedInterface().equals(dpt.getImplementedInterface()));
  98
  99         // And they have to actually be Ip
 100         final Ip sips = (Ip) spt;
 101         final Ip dips = (Ip) dpt;
 102
 103         /*
 104          * Now a bit of magic. We need to find 'like' addresses, e.g. both
 105          * IPv4 or both IPv6. We are in IPv6-enabled world now, so let's
 106          * prefer that.
 107          */
 108         Optional<AddressFamily> ret = findIpv6(sips.getIpAddress(), dips.getIpAddress());
 109         if (!ret.isPresent()) {
 110             ret = findIpv4(sips.getIpAddress(), dips.getIpAddress());
 111         }
 112
 113         // We need to have a ret now
 114         Preconditions.checkArgument(ret != null, "Failed to find like Endpoint addresses");
 115
 116         return ret.get();
 117     }
 118
 119     private static Optional<AddressFamily> findIpv4(final List<IpAddress> srcs, final List<IpAddress> dsts) {
 120         for (final IpAddress sc : srcs) {
 121             if (sc.getIpv4Address() != null) {
 122                 for (final IpAddress dc : dsts) {
 123                     if (dc.getIpv4Address() != null) {
 124                         return Optional.of(new Ipv4CaseBuilder().setIpv4(new Ipv4Builder()
 125                                 .setSourceIpv4Address(new Ipv4AddressNoZone(sc.getIpv4Address()))
 126                                 .setDestinationIpv4Address(new Ipv4AddressNoZone(dc.getIpv4Address()))
 127                                 .build()).build());
 128                     }
 129                 }
 130             }
 131         }
 132
 133         return Optional.empty();
 134     }
 135
 136     private static Optional<AddressFamily> findIpv6(final List<IpAddress> srcs, final List<IpAddress> dsts) {
 137         for (final IpAddress sc : srcs) {
 138             if (sc.getIpv6Address() != null) {
 139                 for (final IpAddress dc : dsts) {
 140                     if (dc.getIpv6Address() != null) {
 141                         return Optional.of(new Ipv6CaseBuilder().setIpv6(new Ipv6Builder()
 142                                 .setSourceIpv6Address(new Ipv6AddressNoZone(sc.getIpv6Address()))
 143                                 .setDestinationIpv6Address(new Ipv6AddressNoZone(dc.getIpv6Address()))
 144                                 .build()).build());
 145                     }
 146                 }
 147             }
 148         }
 149
 150         return Optional.empty();
 151     }
 152
 153     @Override
 154     protected ListenableFuture<OperationResult> invokeOperation() {
 155         try (ReadTransaction transaction = this.dataProvider.newReadOnlyTransaction()) {
 156             AddLspInput addLspInput = createAddLspInput(transaction);
 157
 158             return Futures.transform(
 159                     this.topologyService.addLsp(addLspInput),
 160                     RpcResult::getResult, MoreExecutors.directExecutor());
 161         }
 162     }
 163
 164     private AddLspInput createAddLspInput(final ReadTransaction transaction) {
 165         final InstanceIdentifier<Topology> tii = TopologyProgrammingUtil.topologyForInput(this.p2pTunnelInput);
 166         final TpReader dr = new TpReader(transaction, tii, this.p2pTunnelInput.getDestination());
 167         final TerminationPoint dp = requireNonNull(dr.getTp());
 168
 169         final TpReader sr = new TpReader(transaction, tii, this.p2pTunnelInput.getSource());
 170         final TerminationPoint sp = requireNonNull(sr.getTp());
 171
 172         final Node sn = requireNonNull(sr.getNode());
 173         final AddLspInputBuilder ab = new AddLspInputBuilder();
 174         ab.setNode(requireNonNull(TunelProgrammingUtil.supportingNode(sn)));
 175         ab.setName(this.p2pTunnelInput.getSymbolicPathName());
 176
 177         checkLinkIsnotExistent(tii, ab, transaction);
 178
 179         ab.setArguments(buildArguments(sp, dp));
 180         return ab.build();
 181     }
 182
 183     private Arguments buildArguments(final TerminationPoint sp, final TerminationPoint dp) {
 184         final ArgumentsBuilder args = new ArgumentsBuilder();
 185         if (this.p2pTunnelInput.getBandwidth() != null) {
 186             args.setBandwidth(new BandwidthBuilder().setBandwidth(this.p2pTunnelInput.getBandwidth()).build());
 187         }
 188         if (this.p2pTunnelInput.getClassType() != null) {
 189             args.setClassType(new ClassTypeBuilder().setClassType(this.p2pTunnelInput.getClassType()).build());
 190         }
 191         args.setEndpointsObj(new EndpointsObjBuilder().setAddressFamily(buildAddressFamily(sp, dp)).build());
 192         args.setEro(TunelProgrammingUtil.buildEro(this.p2pTunnelInput.getExplicitHops()));
 193         args.setLspa(new LspaBuilder(this.p2pTunnelInput).build());
 194
 195         final AdministrativeStatus adminStatus = this.p2pTunnelInput.augmentation(PcepCreateP2pTunnelInput1.class)
 196                 .getAdministrativeStatus();
 197         if (adminStatus != null) {
 198             args.addAugmentation(Arguments2.class, new Arguments2Builder().setLsp(new LspBuilder()
 199                     .setAdministrative(adminStatus == AdministrativeStatus.Active).build()).build());
 200         }
 201         return args.build();
 202     }
 203
 204     private static final class TpReader {
 205         private final ReadTransaction rt;
 206         private final InstanceIdentifier<Node> nii;
 207         private final InstanceIdentifier<TerminationPoint> tii;
 208
 209         TpReader(final ReadTransaction rt, final InstanceIdentifier<Topology> topo, final TpReference ref) {
 210             this.rt = requireNonNull(rt);
 211
 212             this.nii = topo.child(Node.class, new NodeKey(ref.getNode()));
 213             this.tii = this.nii.child(TerminationPoint.class, new TerminationPointKey(ref.getTp()));
 214         }
 215
 216         private DataObject read(final InstanceIdentifier<?> id) {
 217             try {
 218                 return this.rt.read(LogicalDatastoreType.OPERATIONAL, id).get().get();
 219             } catch (final InterruptedException | ExecutionException e) {
 220                 throw new IllegalStateException("Failed to read data.", e);
 221             }
 222         }
 223
 224         private Node getNode() {
 225             return (Node) read(this.nii);
 226         }
 227
 228         private TerminationPoint getTp() {
 229             return (TerminationPoint) read(this.tii);
 230         }
 231     }
 232 }