Removed checkstyle warnings.
[bgpcep.git] / pcep / tunnel-provider / src / main / java / org / opendaylight / bgpcep / pcep / tunnel / provider / TunnelProgramming.java
1 /*
2  * Copyright (c) 2013 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 package org.opendaylight.bgpcep.pcep.tunnel.provider;
9
10 import com.google.common.base.Function;
11 import com.google.common.base.Preconditions;
12 import com.google.common.util.concurrent.Futures;
13 import com.google.common.util.concurrent.ListenableFuture;
14
15 import java.util.ArrayList;
16 import java.util.List;
17
18 import org.opendaylight.bgpcep.pcep.topology.spi.AbstractInstructionExecutor;
19 import org.opendaylight.bgpcep.programming.spi.InstructionScheduler;
20 import org.opendaylight.bgpcep.programming.spi.SuccessfulRpcResult;
21 import org.opendaylight.bgpcep.programming.topology.TopologyProgrammingUtil;
22 import org.opendaylight.bgpcep.programming.tunnel.TunnelProgrammingUtil;
23 import org.opendaylight.controller.sal.binding.api.data.DataModificationTransaction;
24 import org.opendaylight.controller.sal.binding.api.data.DataProviderService;
25 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.IpAddress;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.AdministrativeStatus;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.PcepCreateP2pTunnelInput1;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.PcepUpdateTunnelInput1;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.bandwidth.object.BandwidthBuilder;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.classtype.object.ClassTypeBuilder;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.endpoints.AddressFamily;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.endpoints.address.family.Ipv4CaseBuilder;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.endpoints.address.family.Ipv6CaseBuilder;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.endpoints.address.family.ipv4._case.Ipv4Builder;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.endpoints.address.family.ipv6._case.Ipv6Builder;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.endpoints.object.EndpointsObjBuilder;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.explicit.route.object.Ero;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.explicit.route.object.EroBuilder;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.explicit.route.object.ero.Subobject;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.explicit.route.object.ero.SubobjectBuilder;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.lspa.object.LspaBuilder;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.AddLspInputBuilder;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.AddLspOutput;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.NetworkTopologyPcepService;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.OperationResult;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.RemoveLspInputBuilder;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.RemoveLspOutput;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.UpdateLspInputBuilder;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.UpdateLspOutput;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.add.lsp.args.ArgumentsBuilder;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.p2p.rev130819.tunnel.p2p.path.cfg.attributes.ExplicitHops;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.pcep.programming.rev131030.PcepCreateP2pTunnelInput;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.pcep.programming.rev131030.PcepCreateP2pTunnelOutput;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.pcep.programming.rev131030.PcepCreateP2pTunnelOutputBuilder;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.pcep.programming.rev131030.PcepDestroyTunnelInput;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.pcep.programming.rev131030.PcepDestroyTunnelOutput;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.pcep.programming.rev131030.PcepDestroyTunnelOutputBuilder;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.pcep.programming.rev131030.PcepUpdateTunnelInput;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.pcep.programming.rev131030.PcepUpdateTunnelOutput;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.pcep.programming.rev131030.PcepUpdateTunnelOutputBuilder;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.pcep.programming.rev131030.TopologyTunnelPcepProgrammingService;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.pcep.rev130820.ExplicitHops1;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.pcep.rev130820.Link1;
64 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.pcep.rev130820.SupportingNode1;
65 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.programming.rev130930.TpReference;
66 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
67 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
68 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Link;
69 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
70 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
71 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPoint;
72 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPointKey;
73 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.node.attributes.SupportingNode;
74 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.nt.l3.unicast.igp.topology.rev131021.TerminationPoint1;
75 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;
76 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;
77 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
78 import org.opendaylight.yangtools.yang.common.RpcResult;
79 import org.slf4j.Logger;
80 import org.slf4j.LoggerFactory;
81
82 public final class TunnelProgramming implements TopologyTunnelPcepProgrammingService, AutoCloseable {
83     private static final Logger LOG = LoggerFactory.getLogger(TunnelProgramming.class);
84     private final NetworkTopologyPcepService topologyService;
85     private final DataProviderService dataProvider;
86     private final InstructionScheduler scheduler;
87
88     public TunnelProgramming(final InstructionScheduler scheduler, final DataProviderService dataProvider,
89             final NetworkTopologyPcepService topologyService) {
90         this.scheduler = Preconditions.checkNotNull(scheduler);
91         this.dataProvider = Preconditions.checkNotNull(dataProvider);
92         this.topologyService = Preconditions.checkNotNull(topologyService);
93     }
94
95     private static final class TpReader {
96         private final DataModificationTransaction t;
97         private final InstanceIdentifier<Node> nii;
98         private final InstanceIdentifier<TerminationPoint> tii;
99
100         TpReader(final DataModificationTransaction t, final InstanceIdentifier<Topology> topo, final TpReference ref) {
101             this.t = Preconditions.checkNotNull(t);
102
103             this.nii = topo.child(Node.class, new NodeKey(ref.getNode()));
104             this.tii = this.nii.child(TerminationPoint.class, new TerminationPointKey(ref.getTp()));
105         }
106
107         private Node getNode() {
108             return (Node) this.t.readOperationalData(this.nii);
109         }
110
111         private TerminationPoint getTp() {
112             return (TerminationPoint) this.t.readOperationalData(this.tii);
113         }
114     }
115
116     private AddressFamily buildAddressFamily(final TerminationPoint sp, final TerminationPoint dp) {
117         // We need the IGP augmentation -- it has IP addresses
118         final TerminationPoint1 sp1 = Preconditions.checkNotNull(sp.getAugmentation(TerminationPoint1.class));
119         final TerminationPoint1 dp1 = Preconditions.checkNotNull(dp.getAugmentation(TerminationPoint1.class));
120
121         // Get the types
122         final TerminationPointType spt = sp1.getIgpTerminationPointAttributes().getTerminationPointType();
123         final TerminationPointType dpt = dp1.getIgpTerminationPointAttributes().getTerminationPointType();
124
125         // The types have to match
126         Preconditions.checkArgument(spt.getImplementedInterface().equals(dpt.getImplementedInterface()));
127
128         // And they have to actually be Ip
129         final Ip sips = (Ip) spt;
130         final Ip dips = (Ip) dpt;
131
132         /*
133          * Now a bit of magic. We need to find 'like' addresses, e.g. both
134          * IPv4 or both IPv6. We are in IPv6-enabled world now, so let's
135          * prefer that.
136          */
137         AddressFamily ret = findIpv6(sips.getIpAddress(), dips.getIpAddress());
138         if (ret == null) {
139             ret = findIpv4(sips.getIpAddress(), dips.getIpAddress());
140         }
141
142         // We need to have a ret now
143         Preconditions.checkArgument(ret != null, "Failed to find like Endpoint addresses");
144
145         return ret;
146     }
147
148     private AddressFamily findIpv4(final List<IpAddress> srcs, final List<IpAddress> dsts) {
149         for (final IpAddress sc : srcs) {
150             if (sc.getIpv4Address() != null) {
151                 for (final IpAddress dc : dsts) {
152                     if (dc.getIpv4Address() != null) {
153                         return new Ipv4CaseBuilder().setIpv4(
154                                 new Ipv4Builder().setSourceIpv4Address(sc.getIpv4Address()).setDestinationIpv4Address(dc.getIpv4Address()).build()).build();
155                     }
156                 }
157             }
158         }
159
160         return null;
161     }
162
163     private AddressFamily findIpv6(final List<IpAddress> srcs, final List<IpAddress> dsts) {
164         for (final IpAddress sc : srcs) {
165             if (sc.getIpv6Address() != null) {
166                 for (final IpAddress dc : dsts) {
167                     if (dc.getIpv6Address() != null) {
168                         return new Ipv6CaseBuilder().setIpv6(
169                                 new Ipv6Builder().setSourceIpv6Address(sc.getIpv6Address()).setDestinationIpv6Address(dc.getIpv6Address()).build()).build();
170                     }
171                 }
172             }
173         }
174
175         return null;
176     }
177
178     private NodeId supportingNode(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();
183             }
184         }
185
186         return null;
187     }
188
189     private Ero buildEro(final List<ExplicitHops> explicitHops) {
190         final EroBuilder b = new EroBuilder();
191
192         if (!explicitHops.isEmpty()) {
193             final List<Subobject> subobjs = new ArrayList<>(explicitHops.size());
194             for (final ExplicitHops h : explicitHops) {
195
196                 final ExplicitHops1 h1 = h.getAugmentation(ExplicitHops1.class);
197                 if (h1 != null) {
198                     final SubobjectBuilder sb = new SubobjectBuilder();
199                     sb.fieldsFrom(h1);
200                     sb.setLoose(h.isLoose());
201                     subobjs.add(sb.build());
202                 } else {
203                     LOG.debug("Ignoring unhandled explicit hop {}", h);
204                 }
205             }
206             b.setSubobject(subobjs);
207         }
208         return b.build();
209     }
210
211     @Override
212     public ListenableFuture<RpcResult<PcepCreateP2pTunnelOutput>> pcepCreateP2pTunnel(final PcepCreateP2pTunnelInput input) {
213         final PcepCreateP2pTunnelOutputBuilder b = new PcepCreateP2pTunnelOutputBuilder();
214         b.setResult(AbstractInstructionExecutor.schedule(scheduler, new AbstractInstructionExecutor(input) {
215             @Override
216             protected ListenableFuture<OperationResult> invokeOperation() {
217                 final InstanceIdentifier<Topology> tii = TopologyProgrammingUtil.topologyForInput(input);
218
219                 final DataModificationTransaction t = TunnelProgramming.this.dataProvider.beginTransaction();
220
221                 final TpReader dr = new TpReader(t, tii, input.getDestination());
222                 final TpReader sr = new TpReader(t, tii, input.getSource());
223
224                 final Node sn = Preconditions.checkNotNull(sr.getNode());
225                 final TerminationPoint sp = Preconditions.checkNotNull(sr.getTp());
226                 final TerminationPoint dp = Preconditions.checkNotNull(dr.getTp());
227
228                 final AddLspInputBuilder ab = new AddLspInputBuilder();
229                 ab.setNode(Preconditions.checkNotNull(supportingNode(sn)));
230                 ab.setName(input.getSymbolicPathName());
231
232                 // The link has to be non-existent
233                 final InstanceIdentifier<Link> lii = NodeChangedListener.linkIdentifier(tii, ab.getNode(), ab.getName());
234                 Preconditions.checkState(t.readOperationalData(lii) == null);
235
236                 final ArgumentsBuilder args = new ArgumentsBuilder();
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());
242
243                 final PcepCreateP2pTunnelInput1 ia = input.getAugmentation(PcepCreateP2pTunnelInput1.class);
244                 if (ia != null) {
245                     args.setAdministrative(ia.getAdministrativeStatus() == AdministrativeStatus.Active);
246                 }
247
248                 ab.setArguments(args.build());
249
250                 return Futures.transform(
251                         (ListenableFuture<RpcResult<AddLspOutput>>) TunnelProgramming.this.topologyService.addLsp(ab.build()),
252                         new Function<RpcResult<AddLspOutput>, OperationResult>() {
253                             @Override
254                             public OperationResult apply(final RpcResult<AddLspOutput> input) {
255                                 return input.getResult();
256                             }
257                         });
258             }
259         }));
260
261         final RpcResult<PcepCreateP2pTunnelOutput> res = SuccessfulRpcResult.create(b.build());
262         return Futures.immediateFuture(res);
263     }
264
265     private Node sourceNode(final DataModificationTransaction t, final InstanceIdentifier<Topology> topology, final Link link) {
266         return (Node) t.readOperationalData(topology.child(Node.class, new NodeKey(link.getSource().getSourceNode())));
267     }
268
269     @Override
270     public ListenableFuture<RpcResult<PcepDestroyTunnelOutput>> pcepDestroyTunnel(final PcepDestroyTunnelInput input) {
271         final PcepDestroyTunnelOutputBuilder b = new PcepDestroyTunnelOutputBuilder();
272         b.setResult(AbstractInstructionExecutor.schedule(scheduler, new AbstractInstructionExecutor(input) {
273             @Override
274             protected ListenableFuture<OperationResult> invokeOperation() {
275                 final InstanceIdentifier<Topology> tii = TopologyProgrammingUtil.topologyForInput(input);
276                 final InstanceIdentifier<Link> lii = TunnelProgrammingUtil.linkIdentifier(tii, input);
277
278                 final DataModificationTransaction t = TunnelProgramming.this.dataProvider.beginTransaction();
279
280                 // The link has to exist
281                 final Link link = (Link) t.readOperationalData(lii);
282                 Preconditions.checkState(link != null);
283
284                 // The source node has to exist
285                 final Node node = sourceNode(t, tii, link);
286                 Preconditions.checkState(node != null);
287
288                 final RemoveLspInputBuilder ab = new RemoveLspInputBuilder();
289                 ab.setName(link.getAugmentation(Link1.class).getSymbolicPathName());
290                 ab.setNode(node.getSupportingNode().get(0).getKey().getNodeRef());
291
292                 return Futures.transform(
293                         (ListenableFuture<RpcResult<RemoveLspOutput>>) TunnelProgramming.this.topologyService.removeLsp(ab.build()),
294                         new Function<RpcResult<RemoveLspOutput>, OperationResult>() {
295                             @Override
296                             public OperationResult apply(final RpcResult<RemoveLspOutput> input) {
297                                 return input.getResult();
298                             }
299                         });
300             }
301         }));
302
303         final RpcResult<PcepDestroyTunnelOutput> res = SuccessfulRpcResult.create(b.build());
304         return Futures.immediateFuture(res);
305     }
306
307     @Override
308     public ListenableFuture<RpcResult<PcepUpdateTunnelOutput>> pcepUpdateTunnel(final PcepUpdateTunnelInput input) {
309         final PcepUpdateTunnelOutputBuilder b = new PcepUpdateTunnelOutputBuilder();
310         b.setResult(AbstractInstructionExecutor.schedule(scheduler, new AbstractInstructionExecutor(input) {
311             @Override
312             protected ListenableFuture<OperationResult> invokeOperation() {
313
314                 final InstanceIdentifier<Topology> tii = TopologyProgrammingUtil.topologyForInput(input);
315                 final InstanceIdentifier<Link> lii = TunnelProgrammingUtil.linkIdentifier(tii, input);
316
317                 final DataModificationTransaction t = TunnelProgramming.this.dataProvider.beginTransaction();
318
319                 // The link has to exist
320                 final Link link = (Link) t.readOperationalData(lii);
321                 Preconditions.checkState(link != null);
322
323                 // The source node has to exist
324                 final Node node = sourceNode(t, tii, link);
325                 Preconditions.checkState(node != null);
326
327                 final UpdateLspInputBuilder ab = new UpdateLspInputBuilder();
328                 ab.setName(link.getAugmentation(Link1.class).getSymbolicPathName());
329                 ab.setNode(Preconditions.checkNotNull(supportingNode(node)));
330
331                 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();
332                 args.setBandwidth(new BandwidthBuilder().setBandwidth(input.getBandwidth()).build());
333                 args.setClassType(new ClassTypeBuilder().setClassType(input.getClassType()).build());
334                 args.setEro(buildEro(input.getExplicitHops()));
335                 args.setLspa(new LspaBuilder(input).build());
336
337                 final PcepUpdateTunnelInput1 ia = input.getAugmentation(PcepUpdateTunnelInput1.class);
338                 if (ia != null) {
339                     args.setAdministrative(ia.getAdministrativeStatus() == AdministrativeStatus.Active);
340                 }
341
342                 ab.setArguments(args.build());
343
344                 return Futures.transform(
345                         (ListenableFuture<RpcResult<UpdateLspOutput>>) TunnelProgramming.this.topologyService.updateLsp(ab.build()),
346                         new Function<RpcResult<UpdateLspOutput>, OperationResult>() {
347                             @Override
348                             public OperationResult apply(final RpcResult<UpdateLspOutput> input) {
349                                 return input.getResult();
350                             }
351                         });
352             }
353         }));
354
355         final RpcResult<PcepUpdateTunnelOutput> res = SuccessfulRpcResult.create(b.build());
356         return Futures.immediateFuture(res);
357     }
358
359     @Override
360     public void close() {
361         LOG.debug("Shutting down instruction scheduler {}", this);
362     }
363 }