pcep/topology-provider/src/main/java/org/opendaylight/bgpcep/pcep/topology/provider/Stateful07TopologySessionListener.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.topology.provider;
   9
  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.util.concurrent.AsyncFunction;
  15 import com.google.common.util.concurrent.Futures;
  16 import com.google.common.util.concurrent.ListenableFuture;
  17 import java.net.InetAddress;
  18 import java.nio.ByteBuffer;
  19 import java.util.ArrayList;
  20 import java.util.Collections;
  21 import java.util.List;
  22 import java.util.Map;
  23 import java.util.concurrent.atomic.AtomicLong;
  24 import javax.annotation.concurrent.GuardedBy;
  25 import org.opendaylight.controller.config.yang.pcep.topology.provider.PeerCapabilities;
  26 import org.opendaylight.protocol.pcep.PCEPSession;
  27 import org.opendaylight.protocol.pcep.spi.PCEPErrors;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.pcep.sync.optimizations.rev150714.PathComputationClient1;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.pcep.sync.optimizations.rev150714.PathComputationClient1Builder;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.pcep.sync.optimizations.rev150714.lsp.db.version.tlv.LspDbVersion;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.crabbe.initiated.rev131126.PcinitiateBuilder;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.crabbe.initiated.rev131126.Srp1;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.crabbe.initiated.rev131126.Srp1Builder;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.crabbe.initiated.rev131126.Stateful1;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.crabbe.initiated.rev131126.pcinitiate.message.PcinitiateMessageBuilder;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.crabbe.initiated.rev131126.pcinitiate.message.pcinitiate.message.Requests;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.crabbe.initiated.rev131126.pcinitiate.message.pcinitiate.message.RequestsBuilder;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.Arguments1;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.Arguments2;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.Arguments3;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.OperationalStatus;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.Path1;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.Path1Builder;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.PcrptMessage;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.PcupdBuilder;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.PlspId;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.SrpIdNumber;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.StatefulTlv1;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.StatefulTlv1Builder;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.SymbolicPathName;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.Tlvs1;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.lsp.object.Lsp;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.lsp.object.LspBuilder;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.lsp.object.lsp.TlvsBuilder;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.pcerr.pcerr.message.error.type.StatefulCase;
  56 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;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.pcrpt.message.pcrpt.message.Reports;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.pcupd.message.PcupdMessageBuilder;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.pcupd.message.pcupd.message.UpdatesBuilder;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.pcupd.message.pcupd.message.updates.PathBuilder;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.srp.object.Srp;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.srp.object.SrpBuilder;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.stateful.capability.tlv.Stateful;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.symbolic.path.name.tlv.SymbolicPathNameBuilder;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.Message;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.PcerrMessage;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.open.object.open.Tlvs;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.path.setup.type.tlv.PathSetupType;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.AddLspArgs;
  70 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.EnsureLspOperationalInput;
  71 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.LspId;
  72 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.Node1;
  73 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.OperationResult;
  74 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.PccSyncState;
  75 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.RemoveLspArgs;
  76 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.UpdateLspArgs;
  77 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.pcep.client.attributes.PathComputationClient;
  78 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.pcep.client.attributes.PathComputationClientBuilder;
  79 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.pcep.client.attributes.path.computation.client.ReportedLsp;
  80 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.pcep.client.attributes.path.computation.client.ReportedLspBuilder;
  81 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.pcep.client.attributes.path.computation.client.StatefulTlvBuilder;
  82 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.pcep.client.attributes.path.computation.client.reported.lsp.Path;
  83 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  84 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  85 import org.slf4j.Logger;
  86 import org.slf4j.LoggerFactory;
  87
  88 class Stateful07TopologySessionListener extends AbstractTopologySessionListener<SrpIdNumber, PlspId> {
  89     private static final Logger LOG = LoggerFactory.getLogger(Stateful07TopologySessionListener.class);
  90
  91     private final AtomicLong requestId = new AtomicLong(1L);
  92
  93     @GuardedBy("this")
  94     private final List<PlspId> staleLsps = new ArrayList<>();
  95
  96     /**
  97      * Creates a new stateful topology session listener for given server session manager.
  98      *
  99      * @param serverSessionManager
 100      */
 101     Stateful07TopologySessionListener(final ServerSessionManager serverSessionManager) {
 102         super(serverSessionManager);
 103     }
 104
 105     @Override
 106     protected void onSessionUp(final PCEPSession session, final PathComputationClientBuilder pccBuilder) {
 107         final InetAddress peerAddress = session.getRemoteAddress();
 108
 109         final Tlvs tlvs = session.getRemoteTlvs();
 110         if (tlvs != null && tlvs.getAugmentation(Tlvs1.class) != null) {
 111             final Stateful stateful = tlvs.getAugmentation(Tlvs1.class).getStateful();
 112             if (stateful != null) {
 113                 getSessionListenerState().setPeerCapabilities(getCapabilities(stateful));
 114                 pccBuilder.setReportedLsp(Collections.<ReportedLsp> emptyList());
 115                 if (isSynchronized()) {
 116                     pccBuilder.setStateSync(PccSyncState.Synchronized);
 117                 } else if (isIncrementalSynchro()) {
 118                     pccBuilder.setStateSync(PccSyncState.IncrementalSync);
 119                 } else {
 120                     pccBuilder.setStateSync(PccSyncState.InitialResync);
 121                 }
 122                 pccBuilder.setStatefulTlv(new StatefulTlvBuilder().addAugmentation(StatefulTlv1.class,
 123                     new StatefulTlv1Builder(tlvs.getAugmentation(Tlvs1.class)).build()).build());
 124             } else {
 125                 LOG.debug("Peer {} does not advertise stateful TLV", peerAddress);
 126             }
 127         } else {
 128             LOG.debug("Peer {} does not advertise stateful TLV", peerAddress);
 129         }
 130     }
 131
 132     private boolean handleErrorMessage(final PcerrMessage message) {
 133         final org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcerr.message.PcerrMessage errMsg = message.getPcerrMessage();
 134         if (errMsg.getErrorType() instanceof StatefulCase) {
 135             final StatefulCase stat = (StatefulCase)errMsg.getErrorType();
 136             for (final Srps srps : stat.getStateful().getSrps()) {
 137                 final SrpIdNumber id = srps.getSrp().getOperationId();
 138                 if (id.getValue() != 0) {
 139                     final PCEPRequest req = removeRequest(id);
 140                     if (req != null) {
 141                         req.done(OperationResults.createFailed(errMsg.getErrors()));
 142                     } else {
 143                         LOG.warn("Request ID {} not found in outstanding DB", id);
 144                     }
 145                 }
 146             }
 147         } else {
 148             LOG.warn("Unhandled PCErr message {}.", errMsg);
 149             return true;
 150         }
 151         return false;
 152     }
 153
 154     private boolean isSolicited(final Srp srp, final Lsp lsp, final MessageContext ctx, final ReportedLspBuilder rlb) {
 155         if (srp == null) {
 156             return false;
 157         }
 158         final SrpIdNumber id = srp.getOperationId();
 159         if (id.getValue() == 0) {
 160             return false;
 161         }
 162         switch (lsp.getOperational()) {
 163         case Active:
 164         case Down:
 165         case Up:
 166             final PCEPRequest req = removeRequest(id);
 167             if (req != null) {
 168                 LOG.debug("Request {} resulted in LSP operational state {}", id, lsp.getOperational());
 169                 rlb.setMetadata(req.getMetadata());
 170                 ctx.resolveRequest(req);
 171             } else {
 172                 LOG.warn("Request ID {} not found in outstanding DB", id);
 173             }
 174             break;
 175         case GoingDown:
 176         case GoingUp:
 177             // These are transitive states, so we don't have to do anything, as they will be followed
 178             // up...
 179             break;
 180         default:
 181             break;
 182         }
 183         return true;
 184     }
 185
 186     private boolean manageNextReport(final Reports report, final MessageContext ctx) {
 187         final Lsp lsp = report.getLsp();
 188         final PlspId plspid = lsp.getPlspId();
 189         if (!lsp.isSync() && (plspid == null || plspid.getValue() == 0)) {
 190             purgeStaleLsps(ctx);
 191             stateSynchronizationAchieved(ctx);
 192             return true;
 193         }
 194         final ReportedLspBuilder rlb = new ReportedLspBuilder();
 195         boolean solicited = false;
 196         final Srp srp = report.getSrp();
 197         solicited = isSolicited(srp, lsp, ctx, rlb);
 198
 199         // if remove flag is set in SRP object, remove the tunnel immediately
 200         if (solicited && srp.getAugmentation(Srp1.class) != null) {
 201             final Srp1 initiatedSrp = srp.getAugmentation(Srp1.class);
 202             if (initiatedSrp.isRemove()) {
 203                 super.removeLsp(ctx, plspid);
 204                 return false;
 205             }
 206         }
 207         rlb.setPath(Collections.singletonList(buildPath(report, srp, lsp)));
 208
 209         String name = lookupLspName(plspid);
 210         if (lsp.getTlvs() != null && lsp.getTlvs().getSymbolicPathName() != null) {
 211             name = Charsets.UTF_8.decode(ByteBuffer.wrap(lsp.getTlvs().getSymbolicPathName().getPathName().getValue())).toString();
 212         }
 213         //get LspDB from LSP and write it to pcc's node
 214         final LspDbVersion lspDbVersion = geLspDbVersionTlv(lsp);
 215         if (lspDbVersion != null) {
 216             updatePccNode(ctx, new PathComputationClientBuilder().addAugmentation(PathComputationClient1.class,
 217                     new PathComputationClient1Builder().setLspDbVersion(lspDbVersion).build()).build());
 218         }
 219         updateLsp(ctx, plspid, name, rlb, solicited, lsp.isRemove());
 220         unmarkStaleLsp(plspid, lsp.isSync());
 221
 222         LOG.debug("LSP {} updated", lsp);
 223         return true;
 224     }
 225
 226     private static LspDbVersion geLspDbVersionTlv(final Lsp lsp) {
 227         final org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.lsp.object.lsp.Tlvs tlvs = lsp.getTlvs();
 228         if (tlvs != null && tlvs.getAugmentation(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.pcep.sync.optimizations.rev150714.Tlvs1.class) != null) {
 229             return tlvs.getAugmentation(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.pcep.sync.optimizations.rev150714.Tlvs1.class).getLspDbVersion();
 230         }
 231         return null;
 232     }
 233
 234     private Path buildPath(final Reports report, final Srp srp, final Lsp lsp) {
 235         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();
 236         if (report.getPath() != null) {
 237             pb.fieldsFrom(report.getPath());
 238         }
 239         // LSP is mandatory (if there is none, parser will throw an exception)
 240         // this is to ensure a path will be created at any rate
 241         final Path1Builder p1Builder = new Path1Builder();
 242         p1Builder.setLsp(report.getLsp());
 243         final PathSetupType pst;
 244         if (srp != null && srp.getTlvs() != null && srp.getTlvs().getPathSetupType() != null) {
 245             pst = srp.getTlvs().getPathSetupType();
 246             p1Builder.setPathSetupType(pst);
 247         } else {
 248             pst = null;
 249         }
 250         pb.addAugmentation(Path1.class, p1Builder.build());
 251         final org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.lsp.object.lsp.Tlvs tlvs = report.getLsp().getTlvs();
 252         if (tlvs != null) {
 253             if (tlvs.getLspIdentifiers() != null) {
 254                 pb.setLspId(tlvs.getLspIdentifiers().getLspId());
 255             } else if (!isDefaultPST(pst)) {
 256                 pb.setLspId(new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.LspId(lsp.getPlspId().getValue()));
 257             }
 258         }
 259         return pb.build();
 260     }
 261
 262     @Override
 263     protected boolean onMessage(final MessageContext ctx, final Message message) {
 264         if (message instanceof PcerrMessage) {
 265             return handleErrorMessage((PcerrMessage) message);
 266         }
 267         if (!(message instanceof PcrptMessage)) {
 268             return true;
 269         }
 270         getSessionListenerState().updateLastReceivedRptMsg();
 271         final org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.pcrpt.message.PcrptMessage rpt = ((PcrptMessage) message).getPcrptMessage();
 272         for (final Reports report : rpt.getReports()) {
 273             if (!manageNextReport(report, ctx)) {
 274                 return false;
 275             }
 276         }
 277         return false;
 278     }
 279
 280     private SrpIdNumber nextRequest() {
 281         return new SrpIdNumber(this.requestId.getAndIncrement());
 282     }
 283
 284     private class AddFunction implements AsyncFunction<Optional<ReportedLsp>, OperationResult>  {
 285
 286         private final AddLspArgs input;
 287         private final InstanceIdentifier<ReportedLsp> lsp;
 288
 289         public AddFunction(final AddLspArgs input, final InstanceIdentifier<ReportedLsp> lsp) {
 290             this.input = input;
 291             this.lsp = lsp;
 292         }
 293
 294         @Override
 295         public ListenableFuture<OperationResult> apply(final Optional<ReportedLsp> rep) {
 296             if (rep.isPresent()) {
 297                 LOG.debug("Node {} already contains lsp {} at {}", this.input.getNode(), this.input.getName(), this.lsp);
 298                 return OperationResults.createUnsent(PCEPErrors.USED_SYMBOLIC_PATH_NAME).future();
 299             }
 300             if (!getPeerCapabilities().getInstantiation()) {
 301                 return OperationResults.createUnsent(PCEPErrors.CAPABILITY_NOT_SUPPORTED).future();
 302             }
 303
 304             // Build the request
 305             final RequestsBuilder rb = new RequestsBuilder();
 306             final Arguments2 args = this.input.getArguments().getAugmentation(Arguments2.class);
 307             Preconditions.checkArgument(args != null, "Input is missing operational tag.");
 308             final Lsp inputLsp = args.getLsp();
 309             Preconditions.checkArgument(inputLsp != null, "Reported LSP does not contain LSP object.");
 310
 311             rb.fieldsFrom(this.input.getArguments());
 312
 313             final TlvsBuilder tlvsBuilder;
 314             if (inputLsp.getTlvs() != null) {
 315                 tlvsBuilder = new TlvsBuilder(inputLsp.getTlvs());
 316             } else {
 317                 tlvsBuilder = new TlvsBuilder();
 318             }
 319             tlvsBuilder.setSymbolicPathName(
 320                 new SymbolicPathNameBuilder().setPathName(new SymbolicPathName(this.input.getName().getBytes(Charsets.UTF_8))).build());
 321
 322             final SrpBuilder srpBuilder = new SrpBuilder();
 323             srpBuilder.setOperationId(nextRequest());
 324             srpBuilder.setProcessingRule(Boolean.TRUE);
 325             if (!isDefaultPST(args.getPathSetupType())) {
 326                 srpBuilder.setTlvs(
 327                         new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.srp.object.srp.TlvsBuilder()
 328                             .setPathSetupType(args.getPathSetupType()).build());
 329             }
 330             rb.setSrp(srpBuilder.build());
 331
 332             rb.setLsp(new LspBuilder().setAdministrative(inputLsp.isAdministrative()).setDelegate(inputLsp.isDelegate()).setPlspId(
 333                 new PlspId(0L)).setTlvs(tlvsBuilder.build()).build());
 334
 335             final PcinitiateMessageBuilder ib = new PcinitiateMessageBuilder(MESSAGE_HEADER);
 336             ib.setRequests(Collections.singletonList(rb.build()));
 337
 338             // Send the message
 339             return sendMessage(new PcinitiateBuilder().setPcinitiateMessage(ib.build()).build(), rb.getSrp().getOperationId(),
 340                 this.input.getArguments().getMetadata());
 341         }
 342     }
 343
 344     @Override
 345     public synchronized ListenableFuture<OperationResult> addLsp(final AddLspArgs input) {
 346         Preconditions.checkArgument(input != null && input.getName() != null && input.getNode() != null && input.getArguments() != null, MISSING_XML_TAG);
 347         LOG.trace("AddLspArgs {}", input);
 348         // Make sure there is no such LSP
 349         final InstanceIdentifier<ReportedLsp> lsp = lspIdentifier(input.getName());
 350         final ListenableFuture<Optional<ReportedLsp>> f = readOperationalData(lsp);
 351         if (f == null) {
 352             return OperationResults.createUnsent(PCEPErrors.LSP_INTERNAL_ERROR).future();
 353         }
 354         return Futures.transform(f, new AddFunction(input, lsp));
 355     }
 356
 357     @Override
 358     public synchronized ListenableFuture<OperationResult> removeLsp(final RemoveLspArgs input) {
 359         Preconditions.checkArgument(input != null && input.getName() != null && input.getNode() != null, MISSING_XML_TAG);
 360         LOG.trace("RemoveLspArgs {}", input);
 361         // Make sure the LSP exists, we need it for PLSP-ID
 362         final InstanceIdentifier<ReportedLsp> lsp = lspIdentifier(input.getName());
 363         final ListenableFuture<Optional<ReportedLsp>> f = readOperationalData(lsp);
 364         if (f == null) {
 365             return OperationResults.createUnsent(PCEPErrors.LSP_INTERNAL_ERROR).future();
 366         }
 367         return Futures.transform(f, new AsyncFunction<Optional<ReportedLsp>, OperationResult>() {
 368             @Override
 369             public ListenableFuture<OperationResult> apply(final Optional<ReportedLsp> rep) {
 370                 final Lsp reportedLsp = validateReportedLsp(rep, input);
 371                 if (reportedLsp == null) {
 372                     return OperationResults.createUnsent(PCEPErrors.UNKNOWN_PLSP_ID).future();
 373                 }
 374                 final PcinitiateMessageBuilder ib = new PcinitiateMessageBuilder(MESSAGE_HEADER);
 375                 final Requests rb = buildRequest(rep, reportedLsp);
 376                 ib.setRequests(Collections.singletonList(rb));
 377                 return sendMessage(new PcinitiateBuilder().setPcinitiateMessage(ib.build()).build(), rb.getSrp().getOperationId(), null);
 378             }
 379         });
 380     }
 381
 382     private Requests buildRequest(final Optional<ReportedLsp> rep, final Lsp reportedLsp) {
 383         // Build the request and send it
 384         final RequestsBuilder rb = new RequestsBuilder();
 385         final SrpBuilder srpBuilder = new SrpBuilder().addAugmentation(Srp1.class, new Srp1Builder().setRemove(Boolean.TRUE).build()).setOperationId(nextRequest()).setProcessingRule(Boolean.TRUE);
 386         final Optional<PathSetupType> maybePST = getPST(rep);
 387         if (maybePST.isPresent()) {
 388             srpBuilder.setTlvs(new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.srp.object.srp.TlvsBuilder()
 389                 .setPathSetupType(maybePST.get())
 390                 .build());
 391         }
 392         rb.setSrp(srpBuilder.build());
 393         rb.setLsp(new LspBuilder().setRemove(Boolean.FALSE).setPlspId(reportedLsp.getPlspId()).setDelegate(reportedLsp.isDelegate()).build());
 394         return rb.build();
 395     }
 396
 397     private class UpdateFunction implements AsyncFunction<Optional<ReportedLsp>, OperationResult>  {
 398
 399         private final UpdateLspArgs input;
 400
 401         public UpdateFunction(final UpdateLspArgs input) {
 402             this.input = input;
 403         }
 404
 405         @Override
 406         public ListenableFuture<OperationResult> apply(final Optional<ReportedLsp> rep) {
 407             final Lsp reportedLsp = validateReportedLsp(rep, this.input);
 408             if (reportedLsp == null) {
 409                 return OperationResults.createUnsent(PCEPErrors.UNKNOWN_PLSP_ID).future();
 410             }
 411             // create mandatory objects
 412             final Arguments3 args = this.input.getArguments().getAugmentation(Arguments3.class);
 413             final SrpBuilder srpBuilder = new SrpBuilder();
 414             srpBuilder.setOperationId(nextRequest());
 415             srpBuilder.setProcessingRule(Boolean.TRUE);
 416             if (args != null && args.getPathSetupType() != null) {
 417                 if (!isDefaultPST(args.getPathSetupType())) {
 418                     srpBuilder.setTlvs(
 419                             new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.srp.object.srp.TlvsBuilder()
 420                                 .setPathSetupType(args.getPathSetupType()).build());
 421                 }
 422             } else {
 423                 final Optional<PathSetupType> maybePST = getPST(rep);
 424                 if (maybePST.isPresent()) {
 425                     srpBuilder.setTlvs(
 426                             new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.srp.object.srp.TlvsBuilder()
 427                                 .setPathSetupType(maybePST.get()).build());
 428                 }
 429             }
 430             final Srp srp = srpBuilder.build();
 431             final Lsp inputLsp = args.getLsp();
 432             final Lsp lsp = (inputLsp != null) ?
 433                 new LspBuilder().setPlspId(reportedLsp.getPlspId()).setDelegate((inputLsp.isDelegate() != null) ? inputLsp.isDelegate() : false).setTlvs(inputLsp.getTlvs()).setAdministrative((inputLsp.isAdministrative() != null) ? inputLsp.isAdministrative() : false).build()
 434                 : new LspBuilder().setPlspId(reportedLsp.getPlspId()).build();
 435             final Message msg = redelegate(reportedLsp.isDelegate(), srp, lsp, this.input);
 436             return sendMessage(msg, srp.getOperationId(), this.input.getArguments().getMetadata());
 437         }
 438     }
 439
 440     private Message redelegate(final Boolean isDelegate, final Srp srp, final Lsp lsp, final UpdateLspArgs input) {
 441         // the D bit that was reported decides the type of PCE message sent
 442         Preconditions.checkNotNull(isDelegate);
 443         if (isDelegate) {
 444             // we already have delegation, send update
 445             final UpdatesBuilder rb = new UpdatesBuilder();
 446             rb.setSrp(srp);
 447             rb.setLsp(lsp);
 448             final PathBuilder pb = new PathBuilder();
 449             pb.fieldsFrom(input.getArguments());
 450             rb.setPath(pb.build());
 451             final PcupdMessageBuilder ub = new PcupdMessageBuilder(MESSAGE_HEADER);
 452             ub.setUpdates(Collections.singletonList(rb.build()));
 453             return new PcupdBuilder().setPcupdMessage(ub.build()).build();
 454         }
 455         // we want to revoke delegation, different type of message
 456         // is sent because of specification by Siva
 457         // this message is also sent, when input delegate bit is set to 0
 458         // generating an error in PCC
 459         final List<Requests> reqs = new ArrayList<>();
 460         reqs.add(new RequestsBuilder().setSrp(srp).setLsp(lsp).build());
 461         final PcinitiateMessageBuilder ib = new PcinitiateMessageBuilder();
 462         ib.setRequests(reqs);
 463         return new PcinitiateBuilder().setPcinitiateMessage(ib.build()).build();
 464     }
 465
 466     @Override
 467     public synchronized ListenableFuture<OperationResult> updateLsp(final UpdateLspArgs input) {
 468         Preconditions.checkArgument(input != null && input.getName() != null && input.getNode() != null && input.getArguments() != null, MISSING_XML_TAG);
 469         LOG.trace("UpdateLspArgs {}", input);
 470         // Make sure the LSP exists
 471         final InstanceIdentifier<ReportedLsp> lsp = lspIdentifier(input.getName());
 472         final ListenableFuture<Optional<ReportedLsp>> f = readOperationalData(lsp);
 473         if (f == null) {
 474             return OperationResults.createUnsent(PCEPErrors.LSP_INTERNAL_ERROR).future();
 475         }
 476         return Futures.transform(f, new UpdateFunction(input));
 477     }
 478
 479     @Override
 480     public synchronized ListenableFuture<OperationResult> ensureLspOperational(final EnsureLspOperationalInput input) {
 481         Preconditions.checkArgument(input != null && input.getName() != null && input.getNode() != null && input.getArguments() != null, MISSING_XML_TAG);
 482         final OperationalStatus op;
 483         final Arguments1 aa = input.getArguments().getAugmentation(Arguments1.class);
 484         if (aa != null) {
 485             op = aa.getOperational();
 486         } else {
 487             op = null;
 488         }
 489
 490         // Make sure the LSP exists
 491         final InstanceIdentifier<ReportedLsp> lsp = lspIdentifier(input.getName());
 492         LOG.debug("Checking if LSP {} has operational state {}", lsp, op);
 493         final ListenableFuture<Optional<ReportedLsp>> f = readOperationalData(lsp);
 494         if (f == null) {
 495             return OperationResults.createUnsent(PCEPErrors.LSP_INTERNAL_ERROR).future();
 496         }
 497         return listenableFuture(f, input, op);
 498     }
 499
 500     private ListenableFuture<OperationResult> listenableFuture(final ListenableFuture<Optional<ReportedLsp>> f, final EnsureLspOperationalInput input, final OperationalStatus op) {
 501         return Futures.transform(f, new Function<Optional<ReportedLsp>, OperationResult>() {
 502             @Override
 503             public OperationResult apply(final Optional<ReportedLsp> rep) {
 504                 if (!rep.isPresent()) {
 505                     LOG.debug("Node {} does not contain LSP {}", input.getNode(), input.getName());
 506                     return OperationResults.UNSENT;
 507                 }
 508                 // check if at least one of the paths has the same status as requested
 509                 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()) {
 510                     final Path1 p1 = p.getAugmentation(Path1.class);
 511                     if (p1 == null) {
 512                         LOG.warn("Node {} LSP {} does not contain data", input.getNode(), input.getName());
 513                         return OperationResults.UNSENT;
 514                     }
 515                     if (op.equals(p1.getLsp().getOperational())) {
 516                         return OperationResults.SUCCESS;
 517                     }
 518                 }
 519                 return OperationResults.UNSENT;
 520             }
 521         });
 522     }
 523
 524     @Override
 525     protected Lsp validateReportedLsp(final Optional<ReportedLsp> rep, final LspId input) {
 526         if (!rep.isPresent()) {
 527             LOG.debug("Node {} does not contain LSP {}", input.getNode(), input.getName());
 528             return null;
 529         }
 530         // it doesn't matter how many lsps there are in the path list, we only need data that is the same in each path
 531         final Path1 ra = rep.get().getPath().get(0).getAugmentation(Path1.class);
 532         Preconditions.checkState(ra != null, "Reported LSP reported null from data-store.");
 533         final Lsp reportedLsp = ra.getLsp();
 534         Preconditions.checkState(reportedLsp != null, "Reported LSP does not contain LSP object.");
 535         return reportedLsp;
 536     }
 537
 538     private Optional<PathSetupType> getPST(final Optional<ReportedLsp> rep) {
 539         if (rep.isPresent()) {
 540             final Path1 path1 = rep.get().getPath().get(0).getAugmentation(Path1.class);
 541             if (path1 != null) {
 542                 final PathSetupType pst = path1.getPathSetupType();
 543                 if (!isDefaultPST(pst)) {
 544                     return Optional.of(pst);
 545                 }
 546             }
 547         }
 548         return Optional.absent();
 549     }
 550
 551     private static boolean isDefaultPST(final PathSetupType pst) {
 552         if (pst != null && pst.getPst() != null && pst.getPst().shortValue() != 0) {
 553             return false;
 554         }
 555         return true;
 556     }
 557
 558     private static PeerCapabilities getCapabilities(final Stateful stateful) {
 559         final PeerCapabilities capa = new PeerCapabilities();
 560         capa.setStateful(true);
 561         if (stateful.isLspUpdateCapability() != null) {
 562             capa.setActive(stateful.isLspUpdateCapability());
 563         }
 564         final Stateful1 stateful1 = stateful.getAugmentation(Stateful1.class);
 565         if (stateful1 != null && stateful1.isInitiation() != null) {
 566             capa.setInstantiation(stateful1.isInitiation());
 567         }
 568         return capa;
 569     }
 570
 571     /**
 572      * Recover lspData and mark any LSPs in the LSP database that were previously reported by the PCC as stale
 573      * @param lspData
 574      * @param lsps
 575      * @param incrementalSynchro
 576      */
 577     @Override
 578     protected synchronized void loadLspData(final Node node, final Map<String, ReportedLsp> lspData, final Map<PlspId, String> lsps, final boolean incrementalSynchro) {
 579         //load node's lsps from DS
 580         final PathComputationClient pcc = node.getAugmentation(Node1.class).getPathComputationClient();
 581         final List<ReportedLsp> reportedLsps = pcc.getReportedLsp();
 582         for (final ReportedLsp reportedLsp : reportedLsps) {
 583             final String lspName = reportedLsp.getName();
 584             lspData.put(lspName, reportedLsp);
 585             if (!reportedLsp.getPath().isEmpty()) {
 586                 final Path1 path1 = reportedLsp.getPath().get(0).getAugmentation(Path1.class);
 587                 if (path1 != null) {
 588                     final PlspId plspId = path1.getLsp().getPlspId();
 589                     if (!incrementalSynchro) {
 590                         staleLsps.add(plspId);
 591                     }
 592                     lsps.put(plspId, lspName);
 593                 }
 594             }
 595         }
 596     }
 597
 598     /**
 599      * When the PCC reports an LSP during state synchronization, if the LSP already
 600      * exists in the LSP database, the PCE MUST update the LSP database and
 601      * clear the stale marker from the LSP
 602      * @param plspId
 603      * @param sync
 604      */
 605     private synchronized void unmarkStaleLsp(final PlspId plspId, final boolean sync) {
 606         if (!sync) {
 607             staleLsps.remove(plspId);
 608         }
 609     }
 610
 611     /**
 612      *  Purge any LSPs from the LSP database that are still marked as stale
 613      * @param ctx
 614      */
 615     private synchronized void purgeStaleLsps(final MessageContext ctx) {
 616         for (final PlspId plspId : staleLsps) {
 617             removeLsp(ctx, plspId);
 618         }
 619         staleLsps.clear();
 620     }
 621 }