2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.bgpcep.pcep.tunnel.provider;
10 import java.util.ArrayList;
11 import java.util.List;
13 import org.opendaylight.bgpcep.pcep.topology.spi.AbstractTopologyProgrammingExecutor;
14 import org.opendaylight.bgpcep.programming.spi.InstructionExecutor;
15 import org.opendaylight.bgpcep.programming.spi.InstructionScheduler;
16 import org.opendaylight.bgpcep.programming.spi.SuccessfulRpcResult;
17 import org.opendaylight.controller.sal.binding.api.data.DataModificationTransaction;
18 import org.opendaylight.controller.sal.binding.api.data.DataProviderService;
19 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.IpAddress;
20 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.bandwidth.object.BandwidthBuilder;
21 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.classtype.object.ClassTypeBuilder;
22 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.endpoints.AddressFamily;
23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.endpoints.address.family.Ipv4Builder;
24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.endpoints.address.family.Ipv6Builder;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.endpoints.object.EndpointsObjBuilder;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.explicit.route.object.Ero;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.explicit.route.object.EroBuilder;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.explicit.route.object.ero.Subobjects;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.explicit.route.object.ero.SubobjectsBuilder;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.lspa.object.LspaBuilder;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.programming.rev130930.submit.instruction.output.result.FailureBuilder;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.programming.rev130930.submit.instruction.output.result.failure.Failure;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.AddLspInputBuilder;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.AddLspOutput;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.NetworkTopologyPcepService;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.OperationResult;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.RemoveLspInputBuilder;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.RemoveLspOutput;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.UpdateLspInputBuilder;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.UpdateLspOutput;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.add.lsp.args.ArgumentsBuilder;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.programming.rev131102.TopologyInstructionInput;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.p2p.rev130819.tunnel.p2p.path.cfg.attributes.ExplicitHops;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.pcep.programming.rev131030.PcepCreateP2pTunnelInput;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.pcep.programming.rev131030.PcepCreateP2pTunnelOutput;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.pcep.programming.rev131030.PcepCreateP2pTunnelOutputBuilder;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.pcep.programming.rev131030.PcepDestroyTunnelInput;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.pcep.programming.rev131030.PcepDestroyTunnelOutput;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.pcep.programming.rev131030.PcepDestroyTunnelOutputBuilder;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.pcep.programming.rev131030.PcepUpdateTunnelInput;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.pcep.programming.rev131030.PcepUpdateTunnelOutput;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.pcep.programming.rev131030.PcepUpdateTunnelOutputBuilder;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.pcep.programming.rev131030.TopologyTunnelPcepProgrammingService;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.pcep.rev130820.AdministrativeStatus;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.pcep.rev130820.ExplicitHops1;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.pcep.rev130820.Link1;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.pcep.rev130820.SupportingNode1;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.programming.rev130930.BaseTunnelInput;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.programming.rev130930.TpReference;
60 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
61 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
62 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
63 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
64 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Link;
65 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.LinkKey;
66 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
67 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
68 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPoint;
69 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPointKey;
70 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.node.attributes.SupportingNode;
71 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.nt.l3.unicast.igp.topology.rev131021.TerminationPoint1;
72 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;
73 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;
74 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
75 import org.opendaylight.yangtools.yang.common.RpcResult;
76 import org.slf4j.Logger;
77 import org.slf4j.LoggerFactory;
79 import com.google.common.base.Function;
80 import com.google.common.base.Preconditions;
81 import com.google.common.util.concurrent.Futures;
82 import com.google.common.util.concurrent.ListenableFuture;
84 public final class TunnelProgramming implements TopologyTunnelPcepProgrammingService, AutoCloseable {
85 private static final Logger LOG = LoggerFactory.getLogger(TunnelProgramming.class);
86 private final NetworkTopologyPcepService topologyService;
87 private final DataProviderService dataProvider;
88 private final InstructionScheduler scheduler;
90 public TunnelProgramming(final InstructionScheduler scheduler, final DataProviderService dataProvider,
91 final NetworkTopologyPcepService topologyService) {
92 this.scheduler = Preconditions.checkNotNull(scheduler);
93 this.dataProvider = Preconditions.checkNotNull(dataProvider);
94 this.topologyService = Preconditions.checkNotNull(topologyService);
97 private static final class TpReader {
98 private final DataModificationTransaction t;
99 private final InstanceIdentifier<Node> nii;
100 private final InstanceIdentifier<TerminationPoint> tii;
102 TpReader(final DataModificationTransaction t, final InstanceIdentifier<Topology> topo, final TpReference ref) {
103 this.t = Preconditions.checkNotNull(t);
105 this.nii = InstanceIdentifier.builder(topo).child(Node.class, new NodeKey(ref.getNode())).toInstance();
106 this.tii = InstanceIdentifier.builder(this.nii).child(TerminationPoint.class, new TerminationPointKey(ref.getTp())).toInstance();
109 private Node getNode() {
110 return (Node) this.t.readOperationalData(this.nii);
113 private TerminationPoint getTp() {
114 return (TerminationPoint) this.t.readOperationalData(this.tii);
118 private AddressFamily buildAddressFamily(final TerminationPoint sp, final TerminationPoint dp) {
119 // We need the IGP augmentation -- it has IP addresses
120 final TerminationPoint1 sp1 = Preconditions.checkNotNull(sp.getAugmentation(TerminationPoint1.class));
121 final TerminationPoint1 dp1 = Preconditions.checkNotNull(dp.getAugmentation(TerminationPoint1.class));
124 final TerminationPointType spt = sp1.getIgpTerminationPointAttributes().getTerminationPointType();
125 final TerminationPointType dpt = dp1.getIgpTerminationPointAttributes().getTerminationPointType();
127 // The types have to match
128 Preconditions.checkArgument(spt.getImplementedInterface().equals(dpt.getImplementedInterface()));
130 // And they have to actually be Ip
131 final Ip sips = (Ip) spt;
132 final Ip dips = (Ip) dpt;
135 * Now a bit of magic. We need to find 'like' addresses, e.g. both
136 * IPv4 or both IPv6. We are in IPv6-enabled world now, so let's
139 AddressFamily ret = findIpv6(sips.getIpAddress(), dips.getIpAddress());
141 ret = findIpv4(sips.getIpAddress(), dips.getIpAddress());
144 // We need to have a ret now
145 Preconditions.checkArgument(ret != null, "Failed to find like Endpoint addresses");
150 private AddressFamily findIpv4(final List<IpAddress> srcs, final List<IpAddress> dsts) {
151 for (final IpAddress sc : srcs) {
152 if (sc.getIpv4Address() != null) {
153 for (final IpAddress dc : dsts) {
154 if (dc.getIpv4Address() != null) {
155 return new Ipv4Builder().setSourceIpv4Address(sc.getIpv4Address()).setDestinationIpv4Address(dc.getIpv4Address()).build();
164 private AddressFamily findIpv6(final List<IpAddress> srcs, final List<IpAddress> dsts) {
165 for (final IpAddress sc : srcs) {
166 if (sc.getIpv6Address() != null) {
167 for (final IpAddress dc : dsts) {
168 if (dc.getIpv6Address() != null) {
169 return new Ipv6Builder().setSourceIpv6Address(sc.getIpv6Address()).setDestinationIpv6Address(dc.getIpv6Address()).build();
178 private NodeId supportingNode(final DataModificationTransaction t, final Node node) {
179 for (final SupportingNode n : node.getSupportingNode()) {
180 final SupportingNode1 n1 = n.getAugmentation(SupportingNode1.class);
181 if (n1 != null && n1.getPathComputationClient().isControlling()) {
182 return n.getKey().getNodeRef();
189 private Ero buildEro(final List<ExplicitHops> explicitHops) {
190 final EroBuilder b = new EroBuilder();
192 if (!explicitHops.isEmpty()) {
193 final List<Subobjects> subobjs = new ArrayList<>(explicitHops.size());
194 for (final ExplicitHops h : explicitHops) {
196 final ExplicitHops1 h1 = h.getAugmentation(ExplicitHops1.class);
198 final SubobjectsBuilder sb = new SubobjectsBuilder();
200 sb.setLoose(h.isLoose());
201 subobjs.add(sb.build());
203 LOG.debug("Ignoring unhandled explicit hop {}", h);
206 b.setSubobjects(subobjs);
212 public ListenableFuture<RpcResult<PcepCreateP2pTunnelOutput>> pcepCreateP2pTunnel(final PcepCreateP2pTunnelInput input) {
213 final InstructionExecutor e = new AbstractTopologyProgrammingExecutor() {
215 protected ListenableFuture<OperationResult> executeImpl() {
216 final InstanceIdentifier<Topology> tii = topologyIdentifier(input);
218 final DataModificationTransaction t = TunnelProgramming.this.dataProvider.beginTransaction();
220 final TpReader dr = new TpReader(t, tii, input.getDestination());
221 final TpReader sr = new TpReader(t, tii, input.getSource());
223 final Node sn = Preconditions.checkNotNull(sr.getNode());
224 final TerminationPoint sp = Preconditions.checkNotNull(sr.getTp());
225 final TerminationPoint dp = Preconditions.checkNotNull(dr.getTp());
227 final AddLspInputBuilder ab = new AddLspInputBuilder();
228 ab.setNode(Preconditions.checkNotNull(supportingNode(t, sn)));
229 ab.setName(Preconditions.checkNotNull(input.getSymbolicPathName()));
231 // The link has to be non-existent
232 final InstanceIdentifier<Link> lii = NodeChangedListener.linkIdentifier(tii, ab.getNode(), ab.getName());
233 Preconditions.checkState(t.readOperationalData(lii) == null);
235 final ArgumentsBuilder args = new ArgumentsBuilder();
236 args.setAdministrative(input.getAdministrativeStatus() == AdministrativeStatus.Active);
237 args.setBandwidth(new BandwidthBuilder().setBandwidth(input.getBandwidth()).build());
238 args.setClassType(new ClassTypeBuilder().setClassType(input.getClassType()).build());
239 args.setEndpointsObj(new EndpointsObjBuilder().setAddressFamily(buildAddressFamily(sp, dp)).build());
240 args.setEro(buildEro(input.getExplicitHops()));
241 args.setLspa(new LspaBuilder(input).build());
243 ab.setArguments(args.build());
245 return Futures.transform(
246 (ListenableFuture<RpcResult<AddLspOutput>>) TunnelProgramming.this.topologyService.addLsp(ab.build()),
247 new Function<RpcResult<AddLspOutput>, OperationResult>() {
249 public OperationResult apply(final RpcResult<AddLspOutput> input) {
250 return input.getResult();
256 final Failure f = this.scheduler.submitInstruction(input, e);
257 final PcepCreateP2pTunnelOutputBuilder b = new PcepCreateP2pTunnelOutputBuilder();
259 b.setResult(new FailureBuilder().setFailure(f).build());
262 final RpcResult<PcepCreateP2pTunnelOutput> res = SuccessfulRpcResult.create(b.build());
263 return Futures.immediateFuture(res);
266 // FIXME: topology programming utility class
267 private InstanceIdentifier<Topology> topologyIdentifier(final TopologyInstructionInput input) {
268 return InstanceIdentifier.builder(NetworkTopology.class).child(Topology.class, new TopologyKey(input.getTopologyId())).toInstance();
271 // FIXME: tunnel programming utility class
272 private InstanceIdentifier<Link> linkIdentifier(final InstanceIdentifier<Topology> topology, final BaseTunnelInput input) {
273 return InstanceIdentifier.builder(topology).child(Link.class, new LinkKey(Preconditions.checkNotNull(input.getLinkId()))).toInstance();
276 private Node sourceNode(final DataModificationTransaction t, final InstanceIdentifier<Topology> topology, final Link link) {
277 final InstanceIdentifier<Node> nii = InstanceIdentifier.builder(topology).child(Node.class,
278 new NodeKey(link.getSource().getSourceNode())).toInstance();
279 return (Node) t.readOperationalData(nii);
283 public ListenableFuture<RpcResult<PcepDestroyTunnelOutput>> pcepDestroyTunnel(final PcepDestroyTunnelInput input) {
284 final InstructionExecutor e = new AbstractTopologyProgrammingExecutor() {
286 protected ListenableFuture<OperationResult> executeImpl() {
287 final InstanceIdentifier<Topology> tii = topologyIdentifier(input);
288 final InstanceIdentifier<Link> lii = linkIdentifier(tii, input);
290 final DataModificationTransaction t = TunnelProgramming.this.dataProvider.beginTransaction();
292 // The link has to exist
293 final Link link = (Link) t.readOperationalData(lii);
294 Preconditions.checkState(link != null);
296 // The source node has to exist
297 final Node node = sourceNode(t, tii, link);
298 Preconditions.checkState(node != null);
300 final RemoveLspInputBuilder ab = new RemoveLspInputBuilder();
301 ab.setName(link.getAugmentation(Link1.class).getSymbolicPathName());
302 ab.setNode(node.getSupportingNode().get(0).getKey().getNodeRef());
304 return Futures.transform(
305 (ListenableFuture<RpcResult<RemoveLspOutput>>) TunnelProgramming.this.topologyService.removeLsp(ab.build()),
306 new Function<RpcResult<RemoveLspOutput>, OperationResult>() {
308 public OperationResult apply(final RpcResult<RemoveLspOutput> input) {
309 return input.getResult();
315 final Failure f = this.scheduler.submitInstruction(input, e);
316 final PcepDestroyTunnelOutputBuilder b = new PcepDestroyTunnelOutputBuilder();
318 b.setResult(new FailureBuilder().setFailure(f).build());
321 final RpcResult<PcepDestroyTunnelOutput> res = SuccessfulRpcResult.create(b.build());
322 return Futures.immediateFuture(res);
326 public ListenableFuture<RpcResult<PcepUpdateTunnelOutput>> pcepUpdateTunnel(final PcepUpdateTunnelInput input) {
327 final InstructionExecutor e = new AbstractTopologyProgrammingExecutor() {
329 protected ListenableFuture<OperationResult> executeImpl() {
330 final InstanceIdentifier<Topology> tii = topologyIdentifier(input);
331 final InstanceIdentifier<Link> lii = linkIdentifier(tii, input);
333 final DataModificationTransaction t = TunnelProgramming.this.dataProvider.beginTransaction();
335 // The link has to exist
336 final Link link = (Link) t.readOperationalData(lii);
337 Preconditions.checkState(link != null);
339 // The source node has to exist
340 final Node node = sourceNode(t, tii, link);
341 Preconditions.checkState(node != null);
343 final UpdateLspInputBuilder ab = new UpdateLspInputBuilder();
344 ab.setName(link.getAugmentation(Link1.class).getSymbolicPathName());
345 ab.setNode(Preconditions.checkNotNull(supportingNode(t, node)));
347 final org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.update.lsp.args.ArgumentsBuilder args = new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.update.lsp.args.ArgumentsBuilder();
349 args.setAdministrative(input.getAdministrativeStatus() == AdministrativeStatus.Active);
350 args.setBandwidth(new BandwidthBuilder().setBandwidth(input.getBandwidth()).build());
351 args.setClassType(new ClassTypeBuilder().setClassType(input.getClassType()).build());
352 args.setEro(buildEro(input.getExplicitHops()));
353 args.setLspa(new LspaBuilder(input).build());
355 ab.setArguments(args.build());
357 return Futures.transform(
358 (ListenableFuture<RpcResult<UpdateLspOutput>>) TunnelProgramming.this.topologyService.updateLsp(ab.build()),
359 new Function<RpcResult<UpdateLspOutput>, OperationResult>() {
361 public OperationResult apply(final RpcResult<UpdateLspOutput> input) {
362 return input.getResult();
368 final Failure f = this.scheduler.submitInstruction(input, e);
369 final PcepUpdateTunnelOutputBuilder b = new PcepUpdateTunnelOutputBuilder();
371 b.setResult(new FailureBuilder().setFailure(f).build());
374 final RpcResult<PcepUpdateTunnelOutput> res = SuccessfulRpcResult.create(b.build());
375 return Futures.immediateFuture(res);
379 public void close() {
380 // FIXME: BUG-186: remove all scheduled instructions, etc.