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.topology.provider;
10 import com.google.common.base.Charsets;
11 import com.google.common.base.Function;
12 import com.google.common.base.Optional;
13 import com.google.common.base.Preconditions;
14 import com.google.common.collect.ImmutableList;
15 import com.google.common.collect.Lists;
16 import com.google.common.util.concurrent.AsyncFunction;
17 import com.google.common.util.concurrent.Futures;
18 import com.google.common.util.concurrent.ListenableFuture;
19 import java.net.InetAddress;
20 import java.nio.ByteBuffer;
21 import java.util.Collections;
22 import javax.annotation.concurrent.GuardedBy;
23 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
24 import org.opendaylight.protocol.pcep.PCEPSession;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.crabbe.initiated.rev131126.PcinitiateBuilder;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.crabbe.initiated.rev131126.Srp1;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.crabbe.initiated.rev131126.Srp1Builder;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.crabbe.initiated.rev131126.pcinitiate.message.PcinitiateMessageBuilder;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.crabbe.initiated.rev131126.pcinitiate.message.pcinitiate.message.RequestsBuilder;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.Arguments1;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.Arguments2;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.Arguments3;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.OperationalStatus;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.Path1;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.Path1Builder;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.PcrptMessage;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.PcupdBuilder;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.PlspId;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.SrpIdNumber;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.StatefulTlv1;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.StatefulTlv1Builder;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.SymbolicPathName;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.Tlvs1;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.lsp.object.Lsp;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.lsp.object.LspBuilder;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.lsp.object.lsp.TlvsBuilder;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.pcerr.pcerr.message.error.type.StatefulCase;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.pcerr.pcerr.message.error.type.stateful._case.stateful.Srps;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.pcrpt.message.pcrpt.message.Reports;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.pcupd.message.PcupdMessageBuilder;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.pcupd.message.pcupd.message.UpdatesBuilder;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.pcupd.message.pcupd.message.updates.PathBuilder;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.srp.object.Srp;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.srp.object.SrpBuilder;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.stateful.capability.tlv.Stateful;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.symbolic.path.name.tlv.SymbolicPathNameBuilder;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.Message;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.PcerrMessage;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.open.object.open.Tlvs;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev130820.LspId;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.AddLspArgs;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.EnsureLspOperationalInput;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.OperationResult;
64 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.PccSyncState;
65 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.RemoveLspArgs;
66 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.UpdateLspArgs;
67 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.pcep.client.attributes.PathComputationClientBuilder;
68 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.pcep.client.attributes.path.computation.client.ReportedLsp;
69 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.pcep.client.attributes.path.computation.client.ReportedLspBuilder;
70 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.pcep.client.attributes.path.computation.client.StatefulTlvBuilder;
71 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
72 import org.slf4j.Logger;
73 import org.slf4j.LoggerFactory;
75 final class Stateful07TopologySessionListener extends AbstractTopologySessionListener<SrpIdNumber, PlspId> {
76 private static final Logger LOG = LoggerFactory.getLogger(Stateful07TopologySessionListener.class);
79 * @param serverSessionManager
81 Stateful07TopologySessionListener(final ServerSessionManager serverSessionManager) {
82 super(serverSessionManager);
86 private long requestId = 1;
89 protected void onSessionUp(final PCEPSession session, final PathComputationClientBuilder pccBuilder) {
90 final InetAddress peerAddress = session.getRemoteAddress();
92 final Tlvs tlvs = session.getRemoteTlvs();
93 if (tlvs != null && tlvs.getAugmentation(Tlvs1.class) != null) {
94 final Stateful stateful = tlvs.getAugmentation(Tlvs1.class).getStateful();
95 if (stateful != null) {
96 pccBuilder.setReportedLsp(Collections.<ReportedLsp> emptyList());
97 pccBuilder.setStateSync(PccSyncState.InitialResync);
98 pccBuilder.setStatefulTlv(new StatefulTlvBuilder().addAugmentation(StatefulTlv1.class,
99 new StatefulTlv1Builder(tlvs.getAugmentation(Tlvs1.class)).build()).build());
101 LOG.debug("Peer {} does not advertise stateful TLV", peerAddress);
104 LOG.debug("Peer {} does not advertise stateful TLV", peerAddress);
109 protected synchronized boolean onMessage(final WriteTransaction trans, final Message message) {
110 if (message instanceof PcerrMessage) {
111 final org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcerr.message.PcerrMessage errMsg = ((PcerrMessage) message).getPcerrMessage();
112 if (errMsg.getErrorType() instanceof StatefulCase) {
113 final StatefulCase stat = (StatefulCase)errMsg.getErrorType();
114 for (final Srps srps : stat.getStateful().getSrps()) {
115 final SrpIdNumber id = srps.getSrp().getOperationId();
116 if (id.getValue() != 0) {
117 final PCEPRequest req = removeRequest(id);
119 req.setResult(OperationResults.createFailed(errMsg.getErrors()));
121 LOG.warn("Request ID {} not found in outstanding DB", id);
126 LOG.warn("Unhandled PCErr message {}.", errMsg);
131 if (!(message instanceof PcrptMessage)) {
135 final org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.pcrpt.message.PcrptMessage rpt = ((PcrptMessage) message).getPcrptMessage();
136 for (final Reports report : rpt.getReports()) {
137 final Lsp lsp = report.getLsp();
138 final PlspId plspid = lsp.getPlspId();
140 if (!lsp.isSync() && (lsp.getPlspId() == null || plspid.getValue() == 0)) {
141 stateSynchronizationAchieved(trans);
145 final ReportedLspBuilder rlb = new ReportedLspBuilder();
147 boolean solicited = false;
149 final Srp srp = report.getSrp();
151 final SrpIdNumber id = srp.getOperationId();
152 if (id.getValue() != 0) {
155 switch (lsp.getOperational()) {
159 final PCEPRequest req = removeRequest(id);
161 LOG.debug("Request {} resulted in LSP operational state {}", id, lsp.getOperational());
162 rlb.setMetadata(req.getMetadata());
163 req.setResult(OperationResults.SUCCESS);
165 LOG.warn("Request ID {} not found in outstanding DB", id);
170 // These are transitive states, so we don't have to do anything, as they will be followed
174 // if remove flag is set in SRP object, remove the tunnel immediately
175 if (srp.getAugmentation(Srp1.class) != null) {
176 final Srp1 initiatedSrp = srp.getAugmentation(Srp1.class);
177 if (initiatedSrp.isRemove()) {
178 super.removeLsp(trans, plspid);
184 final org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.lsp.object.lsp.Tlvs tlvs = report.getLsp().getTlvs();
186 if (tlvs != null && tlvs.getSymbolicPathName() != null) {
187 name = Charsets.UTF_8.decode(ByteBuffer.wrap(tlvs.getSymbolicPathName().getPathName().getValue())).toString();
192 if (tlvs != null && tlvs.getLspIdentifiers() != null) {
193 lspid = tlvs.getLspIdentifiers().getLspId();
195 final org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.pcep.client.attributes.path.computation.client.reported.lsp.PathBuilder pb = new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.pcep.client.attributes.path.computation.client.reported.lsp.PathBuilder();
196 if (report.getPath() != null) {
197 pb.fieldsFrom(report.getPath());
199 // LSP is mandatory (if there is none, parser will throw an exception)
200 // this is to ensure a path will be created at any rate
201 pb.addAugmentation(Path1.class, new Path1Builder().setLsp(report.getLsp()).build());
203 rlb.setPath(Lists.newArrayList(pb.build()));
204 updateLsp(trans, plspid, name, rlb, solicited, lsp.isRemove());
205 LOG.debug("LSP {} updated", lsp);
211 private SrpIdNumber nextRequest() {
212 return new SrpIdNumber(this.requestId++);
216 public synchronized ListenableFuture<OperationResult> addLsp(final AddLspArgs input) {
217 Preconditions.checkArgument(input != null && input.getName() != null && input.getNode() != null && input.getArguments() != null, "Mandatory XML tags are missing.");
218 LOG.trace("AddLspArgs {}", input);
219 // Make sure there is no such LSP
220 final InstanceIdentifier<ReportedLsp> lsp = lspIdentifier(input.getName()).build();
221 final ListenableFuture<Optional<ReportedLsp>> f = readOperationalData(lsp);
223 return Futures.transform(f, new AsyncFunction<Optional<ReportedLsp>, OperationResult>() {
225 public ListenableFuture<OperationResult> apply(final Optional<ReportedLsp> rep) {
226 if (rep.isPresent()) {
227 LOG.debug("Node {} already contains lsp {} at {}", input.getNode(), input.getName(), lsp);
228 return OperationResults.UNSENT.future();
232 final RequestsBuilder rb = new RequestsBuilder();
233 final Arguments2 args = input.getArguments().getAugmentation(Arguments2.class);
234 Preconditions.checkArgument(args != null, "Input is missing operational tag.");
235 final Lsp inputLsp = args.getLsp();
236 Preconditions.checkArgument(inputLsp != null, "Reported LSP does not contain LSP object.");
238 rb.fieldsFrom(input.getArguments());
240 final TlvsBuilder tlvsBuilder = new TlvsBuilder();
241 tlvsBuilder.setSymbolicPathName(
242 new SymbolicPathNameBuilder().setPathName(new SymbolicPathName(input.getName().getBytes(Charsets.UTF_8))).build());
243 if (inputLsp.getTlvs() != null) {
244 tlvsBuilder.setVsTlv(inputLsp.getTlvs().getVsTlv());
247 rb.setSrp(new SrpBuilder().setOperationId(nextRequest()).setProcessingRule(Boolean.TRUE).build());
248 rb.setLsp(new LspBuilder().setAdministrative(inputLsp.isAdministrative()).setDelegate(inputLsp.isDelegate()).setPlspId(
249 new PlspId(0L)).setTlvs(tlvsBuilder.build()).build());
251 final PcinitiateMessageBuilder ib = new PcinitiateMessageBuilder(MESSAGE_HEADER);
252 ib.setRequests(ImmutableList.of(rb.build()));
255 return sendMessage(new PcinitiateBuilder().setPcinitiateMessage(ib.build()).build(), rb.getSrp().getOperationId(),
256 input.getArguments().getMetadata());
262 public synchronized ListenableFuture<OperationResult> removeLsp(final RemoveLspArgs input) {
263 Preconditions.checkArgument(input != null && input.getName() != null && input.getNode() != null, "Mandatory XML tags are missing.");
264 LOG.trace("RemoveLspArgs {}", input);
265 // Make sure the LSP exists, we need it for PLSP-ID
266 final InstanceIdentifier<ReportedLsp> lsp = lspIdentifier(input.getName()).build();
267 final ListenableFuture<Optional<ReportedLsp>> f = readOperationalData(lsp);
269 return Futures.transform(f, new AsyncFunction<Optional<ReportedLsp>, OperationResult>() {
271 public ListenableFuture<OperationResult> apply(final Optional<ReportedLsp> rep) {
272 if (!rep.isPresent()) {
273 LOG.debug("Node {} does not contain LSP {}", input.getNode(), input.getName());
274 return OperationResults.UNSENT.future();
277 // it doesn't matter how many lsps there are in the path list, we only need delegate & plspid that is the same in each path
278 final Path1 ra = rep.get().getPath().get(0).getAugmentation(Path1.class);
279 Preconditions.checkState(ra != null, "Reported LSP reported null from data-store.");
280 final Lsp reportedLsp = ra.getLsp();
281 Preconditions.checkState(reportedLsp != null, "Reported LSP does not contain LSP object.");
283 // Build the request and send it
284 final RequestsBuilder rb = new RequestsBuilder();
285 rb.setSrp(new SrpBuilder().addAugmentation(Srp1.class, new Srp1Builder().setRemove(Boolean.TRUE).build()).setOperationId(nextRequest()).setProcessingRule(Boolean.TRUE).build());
286 rb.setLsp(new LspBuilder().setRemove(Boolean.FALSE).setPlspId(reportedLsp.getPlspId()).setDelegate(reportedLsp.isDelegate()).build());
288 final PcinitiateMessageBuilder ib = new PcinitiateMessageBuilder(MESSAGE_HEADER);
289 ib.setRequests(ImmutableList.of(rb.build()));
290 return sendMessage(new PcinitiateBuilder().setPcinitiateMessage(ib.build()).build(), rb.getSrp().getOperationId(), null);
296 public synchronized ListenableFuture<OperationResult> updateLsp(final UpdateLspArgs input) {
297 Preconditions.checkArgument(input != null && input.getName() != null && input.getNode() != null && input.getArguments() != null, "Mandatory XML tags are missing.");
298 LOG.trace("UpdateLspArgs {}", input);
299 // Make sure the LSP exists
300 final InstanceIdentifier<ReportedLsp> lsp = lspIdentifier(input.getName()).build();
301 final ListenableFuture<Optional<ReportedLsp>> f = readOperationalData(lsp);
303 return Futures.transform(f, new AsyncFunction<Optional<ReportedLsp>, OperationResult>() {
305 public ListenableFuture<OperationResult> apply(final Optional<ReportedLsp> rep) {
306 if (!rep.isPresent()) {
307 LOG.debug("Node {} does not contain LSP {}", input.getNode(), input.getName());
308 return OperationResults.UNSENT.future();
311 // it doesn't matter how many lsps there are in the path list, we only need plspid that is the same in each path
312 final Path1 ra = rep.get().getPath().get(0).getAugmentation(Path1.class);
313 Preconditions.checkState(ra != null, "Reported LSP reported null from data-store.");
314 final Lsp reportedLsp = ra.getLsp();
315 Preconditions.checkState(reportedLsp != null, "Reported LSP does not contain LSP object.");
317 // Build the PCUpd request and send it
318 final UpdatesBuilder rb = new UpdatesBuilder();
319 rb.setSrp(new SrpBuilder().setOperationId(nextRequest()).setProcessingRule(Boolean.TRUE).build());
320 final Lsp inputLsp = input.getArguments().getAugmentation(Arguments3.class).getLsp();
321 if (inputLsp != null) {
322 rb.setLsp(new LspBuilder().setPlspId(reportedLsp.getPlspId()).setDelegate((inputLsp.isDelegate() != null) ? inputLsp.isDelegate() : false).setTlvs(inputLsp.getTlvs()).setAdministrative((inputLsp.isAdministrative() != null) ? inputLsp.isAdministrative() : false).build());
324 rb.setLsp(new LspBuilder().setPlspId(reportedLsp.getPlspId()).build());
326 final PathBuilder pb = new PathBuilder();
327 pb.fieldsFrom(input.getArguments());
328 rb.setPath(pb.build());
329 final PcupdMessageBuilder ub = new PcupdMessageBuilder(MESSAGE_HEADER);
330 ub.setUpdates(ImmutableList.of(rb.build()));
331 return sendMessage(new PcupdBuilder().setPcupdMessage(ub.build()).build(), rb.getSrp().getOperationId(),
332 input.getArguments().getMetadata());
338 public synchronized ListenableFuture<OperationResult> ensureLspOperational(final EnsureLspOperationalInput input) {
339 Preconditions.checkArgument(input != null && input.getName() != null && input.getNode() != null && input.getArguments() != null, "Mandatory XML tags are missing.");
340 final OperationalStatus op;
341 final Arguments1 aa = input.getArguments().getAugmentation(Arguments1.class);
343 op = aa.getOperational();
348 // Make sure the LSP exists
349 final InstanceIdentifier<ReportedLsp> lsp = lspIdentifier(input.getName()).build();
350 LOG.debug("Checking if LSP {} has operational state {}", lsp, op);
351 final ListenableFuture<Optional<ReportedLsp>> f = readOperationalData(lsp);
353 return Futures.transform(f, new Function<Optional<ReportedLsp>, OperationResult>() {
355 public OperationResult apply(final Optional<ReportedLsp> rep) {
356 if (!rep.isPresent()) {
357 LOG.debug("Node {} does not contain LSP {}", input.getNode(), input.getName());
358 return OperationResults.UNSENT;
361 // check if at least one of the paths has the same status as requested
362 boolean operational = false;
363 for (final org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.pcep.client.attributes.path.computation.client.reported.lsp.Path p : rep.get().getPath()) {
364 final Path1 p1 = p.getAugmentation(Path1.class);
366 LOG.warn("Node {} LSP {} does not contain data", input.getNode(), input.getName());
367 return OperationResults.UNSENT;
369 final Lsp l = p1.getLsp();
370 if (l.getOperational().equals(op)) {
375 return operational ? OperationResults.SUCCESS : OperationResults.UNSENT;