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.Optional;
  14 import com.google.common.base.Preconditions;
  15 import com.google.common.util.concurrent.Futures;
  16 import com.google.common.util.concurrent.ListenableFuture;
  17 import com.google.common.util.concurrent.MoreExecutors;
  18 import java.util.List;
  19 import org.opendaylight.bgpcep.pcep.topology.spi.AbstractInstructionExecutor;
  20 import org.opendaylight.bgpcep.programming.topology.TopologyProgrammingUtil;
  21 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  22 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  23 import org.opendaylight.controller.md.sal.binding.api.ReadTransaction;
  24 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  25 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
  26 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev171025.AdministrativeStatus;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev171025.Arguments2;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev171025.Arguments2Builder;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev171025.PcepCreateP2pTunnelInput1;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev171025.lsp.object.LspBuilder;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.bandwidth.object.BandwidthBuilder;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.classtype.object.ClassTypeBuilder;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.endpoints.AddressFamily;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.endpoints.address.family.Ipv4CaseBuilder;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.endpoints.address.family.Ipv6CaseBuilder;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.endpoints.address.family.ipv4._case.Ipv4Builder;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.endpoints.address.family.ipv6._case.Ipv6Builder;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.endpoints.object.EndpointsObjBuilder;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.lspa.object.LspaBuilder;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev171025.AddLspInput;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev171025.AddLspInputBuilder;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev171025.AddLspOutput;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev171025.NetworkTopologyPcepService;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev171025.OperationResult;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev171025.add.lsp.args.Arguments;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev171025.add.lsp.args.ArgumentsBuilder;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.pcep.programming.rev131030.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 ReadOnlyTransaction rt) {
  78         final InstanceIdentifier<Link> lii = NodeChangedListener.linkIdentifier(tii, addLspInput.getNode(),
  79                 addLspInput.getName());
  80         try {
  81             Preconditions.checkState(!rt.read(LogicalDatastoreType.OPERATIONAL, lii).checkedGet().isPresent());
  82         } catch (final ReadFailedException 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.getAugmentation(TerminationPoint1.class));
  90         final TerminationPoint1 dp1 = requireNonNull(dp.getAugmentation(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(sc.getIpv4Address())
 126                                 .setDestinationIpv4Address(dc.getIpv4Address()).build()).build());
 127                     }
 128                 }
 129             }
 130         }
 131
 132         return Optional.absent();
 133     }
 134
 135     private static Optional<AddressFamily> findIpv6(final List<IpAddress> srcs, final List<IpAddress> dsts) {
 136         for (final IpAddress sc : srcs) {
 137             if (sc.getIpv6Address() != null) {
 138                 for (final IpAddress dc : dsts) {
 139                     if (dc.getIpv6Address() != null) {
 140                         return Optional.of(new Ipv6CaseBuilder().setIpv6(new Ipv6Builder()
 141                                 .setSourceIpv6Address(sc.getIpv6Address())
 142                                 .setDestinationIpv6Address(dc.getIpv6Address()).build()).build());
 143                     }
 144                 }
 145             }
 146         }
 147
 148         return Optional.absent();
 149     }
 150
 151     @Override
 152     protected ListenableFuture<OperationResult> invokeOperation() {
 153         try (ReadOnlyTransaction transaction = this.dataProvider.newReadOnlyTransaction()) {
 154             AddLspInput addLspInput = createAddLspInput(transaction);
 155
 156             return Futures.transform(
 157                     (ListenableFuture<RpcResult<AddLspOutput>>) this.topologyService.addLsp(addLspInput),
 158                     RpcResult::getResult, MoreExecutors.directExecutor());
 159         }
 160     }
 161
 162     private AddLspInput createAddLspInput(final ReadOnlyTransaction transaction) {
 163         final InstanceIdentifier<Topology> tii = TopologyProgrammingUtil.topologyForInput(this.p2pTunnelInput);
 164         final TpReader dr = new TpReader(transaction, tii, this.p2pTunnelInput.getDestination());
 165         final TerminationPoint dp = requireNonNull(dr.getTp());
 166
 167         final TpReader sr = new TpReader(transaction, tii, this.p2pTunnelInput.getSource());
 168         final TerminationPoint sp = requireNonNull(sr.getTp());
 169
 170         final Node sn = requireNonNull(sr.getNode());
 171         final AddLspInputBuilder ab = new AddLspInputBuilder();
 172         ab.setNode(requireNonNull(TunelProgrammingUtil.supportingNode(sn)));
 173         ab.setName(this.p2pTunnelInput.getSymbolicPathName());
 174
 175         checkLinkIsnotExistent(tii, ab, transaction);
 176
 177         ab.setArguments(buildArguments(sp, dp));
 178         return ab.build();
 179     }
 180
 181     private Arguments buildArguments(final TerminationPoint sp, final TerminationPoint dp) {
 182         final ArgumentsBuilder args = new ArgumentsBuilder();
 183         if (this.p2pTunnelInput.getBandwidth() != null) {
 184             args.setBandwidth(new BandwidthBuilder().setBandwidth(this.p2pTunnelInput.getBandwidth()).build());
 185         }
 186         if (this.p2pTunnelInput.getClassType() != null) {
 187             args.setClassType(new ClassTypeBuilder().setClassType(this.p2pTunnelInput.getClassType()).build());
 188         }
 189         args.setEndpointsObj(new EndpointsObjBuilder().setAddressFamily(buildAddressFamily(sp, dp)).build());
 190         args.setEro(TunelProgrammingUtil.buildEro(this.p2pTunnelInput.getExplicitHops()));
 191         args.setLspa(new LspaBuilder(this.p2pTunnelInput).build());
 192
 193         final AdministrativeStatus adminStatus = this.p2pTunnelInput.getAugmentation(PcepCreateP2pTunnelInput1.class)
 194                 .getAdministrativeStatus();
 195         if (adminStatus != null) {
 196             args.addAugmentation(Arguments2.class, new Arguments2Builder().setLsp(new LspBuilder()
 197                     .setAdministrative(adminStatus == AdministrativeStatus.Active).build()).build());
 198         }
 199         return args.build();
 200     }
 201
 202     private static final class TpReader {
 203         private final ReadTransaction rt;
 204         private final InstanceIdentifier<Node> nii;
 205         private final InstanceIdentifier<TerminationPoint> tii;
 206
 207         TpReader(final ReadTransaction rt, final InstanceIdentifier<Topology> topo, final TpReference ref) {
 208             this.rt = requireNonNull(rt);
 209
 210             this.nii = topo.child(Node.class, new NodeKey(ref.getNode()));
 211             this.tii = this.nii.child(TerminationPoint.class, new TerminationPointKey(ref.getTp()));
 212         }
 213
 214         private DataObject read(final InstanceIdentifier<?> id) {
 215             try {
 216                 return this.rt.read(LogicalDatastoreType.OPERATIONAL, id).checkedGet().get();
 217             } catch (ReadFailedException | IllegalStateException e) {
 218                 throw new IllegalStateException("Failed to read data.", e);
 219             }
 220         }
 221
 222         private Node getNode() {
 223             return (Node) read(this.nii);
 224         }
 225
 226         private TerminationPoint getTp() {
 227             return (TerminationPoint) read(this.tii);
 228         }
 229     }
 230 }