pcep/topology/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 static com.google.common.base.Preconditions.checkArgument;
  11 import static com.google.common.base.Preconditions.checkState;
  12 import static java.util.Objects.requireNonNull;
  13
  14 import com.google.common.util.concurrent.AsyncFunction;
  15 import com.google.common.util.concurrent.FluentFuture;
  16 import com.google.common.util.concurrent.Futures;
  17 import com.google.common.util.concurrent.ListenableFuture;
  18 import com.google.common.util.concurrent.MoreExecutors;
  19 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  20 import java.net.InetAddress;
  21 import java.nio.ByteBuffer;
  22 import java.nio.charset.StandardCharsets;
  23 import java.util.ArrayList;
  24 import java.util.Collections;
  25 import java.util.List;
  26 import java.util.Map;
  27 import java.util.Optional;
  28 import java.util.concurrent.atomic.AtomicBoolean;
  29 import java.util.concurrent.atomic.AtomicLong;
  30 import org.checkerframework.checker.lock.qual.GuardedBy;
  31 import org.opendaylight.protocol.pcep.PCEPSession;
  32 import org.opendaylight.protocol.pcep.spi.PCEPErrors;
  33 import org.opendaylight.protocol.pcep.spi.PSTUtil;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.pcep.sync.optimizations.rev181109.PathComputationClient1;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.pcep.sync.optimizations.rev181109.PathComputationClient1Builder;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.pcep.sync.optimizations.rev181109.lsp.db.version.tlv.LspDbVersion;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.crabbe.initiated.rev181109.Lsp1;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.crabbe.initiated.rev181109.PcinitiateBuilder;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.crabbe.initiated.rev181109.Srp1;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.crabbe.initiated.rev181109.Srp1Builder;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.crabbe.initiated.rev181109.Stateful1;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.crabbe.initiated.rev181109.pcinitiate.message.PcinitiateMessageBuilder;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.crabbe.initiated.rev181109.pcinitiate.message.pcinitiate.message.Requests;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.crabbe.initiated.rev181109.pcinitiate.message.pcinitiate.message.RequestsBuilder;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.Arguments1;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.Arguments2;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.Arguments3;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.OperationalStatus;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.Path1;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.Path1Builder;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.PcrptMessage;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.PcupdBuilder;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.PlspId;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.SrpIdNumber;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.StatefulTlv1;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.StatefulTlv1Builder;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.SymbolicPathName;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.Tlvs1;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.lsp.object.Lsp;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.lsp.object.LspBuilder;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.lsp.object.lsp.TlvsBuilder;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.pcerr.pcerr.message.error.type.StatefulCase;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.pcerr.pcerr.message.error.type.stateful._case.stateful.Srps;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.pcrpt.message.pcrpt.message.Reports;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.pcupd.message.PcupdMessageBuilder;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.pcupd.message.pcupd.message.UpdatesBuilder;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.pcupd.message.pcupd.message.updates.PathBuilder;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.srp.object.Srp;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.srp.object.SrpBuilder;
  70 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.stateful.capability.tlv.Stateful;
  71 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.symbolic.path.name.tlv.SymbolicPathNameBuilder;
  72 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.Message;
  73 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.PcerrMessage;
  74 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.explicit.route.object.EroBuilder;
  75 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.open.object.open.Tlvs;
  76 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.path.setup.type.tlv.PathSetupType;
  77 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev200120.AddLspArgs;
  78 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev200120.EnsureLspOperationalInput;
  79 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev200120.LspId;
  80 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev200120.Node1;
  81 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev200120.OperationResult;
  82 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev200120.PccSyncState;
  83 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev200120.RemoveLspArgs;
  84 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev200120.TriggerSyncArgs;
  85 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev200120.UpdateLspArgs;
  86 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev200120.ensure.lsp.operational.args.Arguments;
  87 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev200120.pcep.client.attributes.PathComputationClient;
  88 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev200120.pcep.client.attributes.PathComputationClientBuilder;
  89 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev200120.pcep.client.attributes.path.computation.client.ReportedLsp;
  90 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev200120.pcep.client.attributes.path.computation.client.ReportedLspBuilder;
  91 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev200120.pcep.client.attributes.path.computation.client.StatefulTlvBuilder;
  92 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev200120.pcep.client.attributes.path.computation.client.reported.lsp.Path;
  93 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  94 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  95 import org.opendaylight.yangtools.yang.common.Uint32;
  96 import org.slf4j.Logger;
  97 import org.slf4j.LoggerFactory;
  98
  99 class Stateful07TopologySessionListener extends AbstractTopologySessionListener<SrpIdNumber, PlspId> {
 100     private static final Logger LOG = LoggerFactory.getLogger(Stateful07TopologySessionListener.class);
 101     private static final PlspId PLSPID_ZERO = new PlspId(Uint32.ZERO);
 102
 103     private final AtomicLong requestId = new AtomicLong(1L);
 104
 105     @GuardedBy("this")
 106     private final List<PlspId> staleLsps = new ArrayList<>();
 107
 108     private final AtomicBoolean statefulCapability = new AtomicBoolean(false);
 109     private final AtomicBoolean lspUpdateCapability = new AtomicBoolean(false);
 110     private final AtomicBoolean initiationCapability = new AtomicBoolean(false);
 111
 112     /**
 113      * Creates a new stateful topology session listener for given server session manager.
 114      */
 115     Stateful07TopologySessionListener(final ServerSessionManager serverSessionManager) {
 116         super(serverSessionManager);
 117     }
 118
 119     private static LspDbVersion geLspDbVersionTlv(final Lsp lsp) {
 120         final org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.lsp.object
 121                 .lsp.Tlvs tlvs = lsp.getTlvs();
 122         if (tlvs != null && tlvs.augmentation(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang
 123                 .controller.pcep.sync.optimizations.rev181109.Tlvs1.class) != null) {
 124             return tlvs.augmentation(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller
 125                     .pcep.sync.optimizations.rev181109.Tlvs1.class).getLspDbVersion();
 126         }
 127         return null;
 128     }
 129
 130     @Override
 131     protected void onSessionUp(final PCEPSession session, final PathComputationClientBuilder pccBuilder) {
 132         final InetAddress peerAddress = session.getRemoteAddress();
 133
 134         final Tlvs tlvs = session.getRemoteTlvs();
 135         if (tlvs != null && tlvs.augmentation(Tlvs1.class) != null) {
 136             final Stateful stateful = tlvs.augmentation(Tlvs1.class).getStateful();
 137             if (stateful != null) {
 138                 setStatefulCapabilities(stateful);
 139                 pccBuilder.setReportedLsp(Collections.emptyList());
 140                 if (isSynchronized()) {
 141                     pccBuilder.setStateSync(PccSyncState.Synchronized);
 142                 } else if (isTriggeredInitialSynchro()) {
 143                     pccBuilder.setStateSync(PccSyncState.TriggeredInitialSync);
 144                 } else if (isIncrementalSynchro()) {
 145                     pccBuilder.setStateSync(PccSyncState.IncrementalSync);
 146                 } else {
 147                     pccBuilder.setStateSync(PccSyncState.InitialResync);
 148                 }
 149                 pccBuilder.setStatefulTlv(new StatefulTlvBuilder().addAugmentation(StatefulTlv1.class,
 150                         new StatefulTlv1Builder(tlvs.augmentation(Tlvs1.class)).build()).build());
 151             } else {
 152                 LOG.debug("Peer {} does not advertise stateful TLV", peerAddress);
 153             }
 154         } else {
 155             LOG.debug("Peer {} does not advertise stateful TLV", peerAddress);
 156         }
 157     }
 158
 159     @Override
 160     public synchronized ListenableFuture<OperationResult> triggerSync(final TriggerSyncArgs input) {
 161         if (isTriggeredInitialSynchro() && !isSynchronized()) {
 162             return triggerSynchronization(input);
 163         } else if (isSessionSynchronized() && isTriggeredReSyncEnabled()) {
 164             checkArgument(input != null && input.getNode() != null, MISSING_XML_TAG);
 165             return input.getName() == null ? triggerResyncronization(input) : triggerLspSyncronization(input);
 166         }
 167         return OperationResults.UNSENT.future();
 168     }
 169
 170     private ListenableFuture<OperationResult> triggerLspSyncronization(final TriggerSyncArgs input) {
 171         LOG.trace("Trigger Lsp Resynchronization {}", input);
 172
 173         // Make sure the LSP exists
 174         final InstanceIdentifier<ReportedLsp> lsp = lspIdentifier(input.getName());
 175         final FluentFuture<Optional<ReportedLsp>> f = readOperationalData(lsp);
 176         if (f == null) {
 177             return OperationResults.createUnsent(PCEPErrors.LSP_INTERNAL_ERROR).future();
 178         }
 179         return Futures.transformAsync(f, new ResyncLspFunction(input), MoreExecutors.directExecutor());
 180     }
 181
 182     private ListenableFuture<OperationResult> triggerResyncronization(final TriggerSyncArgs input) {
 183         LOG.trace("Trigger Resynchronization {}", input);
 184         markAllLspAsStale();
 185         updatePccState(PccSyncState.PcepTriggeredResync);
 186         final PcupdMessageBuilder pcupdMessageBuilder = new PcupdMessageBuilder(MESSAGE_HEADER);
 187         final SrpIdNumber srpIdNumber = createUpdateMessageSync(pcupdMessageBuilder);
 188         final Message msg = new PcupdBuilder().setPcupdMessage(pcupdMessageBuilder.build()).build();
 189         return sendMessage(msg, srpIdNumber, null);
 190     }
 191
 192     private ListenableFuture<OperationResult> triggerSynchronization(final TriggerSyncArgs input) {
 193         LOG.trace("Trigger Initial Synchronization {}", input);
 194         final PcupdMessageBuilder pcupdMessageBuilder = new PcupdMessageBuilder(MESSAGE_HEADER);
 195         final SrpIdNumber srpIdNumber = createUpdateMessageSync(pcupdMessageBuilder);
 196         final Message msg = new PcupdBuilder().setPcupdMessage(pcupdMessageBuilder.build()).build();
 197         return sendMessage(msg, srpIdNumber, null);
 198     }
 199
 200     private SrpIdNumber createUpdateMessageSync(final PcupdMessageBuilder pcupdMessageBuilder) {
 201         final UpdatesBuilder updBuilder = new UpdatesBuilder();
 202         // LSP mandatory in Upd
 203         final Lsp lsp = new LspBuilder().setPlspId(PLSPID_ZERO).setSync(Boolean.TRUE).build();
 204         // SRP Mandatory in Upd
 205         final SrpBuilder srpBuilder = new SrpBuilder();
 206         // not sue whether use 0 instead of nextRequest() or do not insert srp == SRP-ID-number = 0
 207         srpBuilder.setOperationId(nextRequest());
 208         final Srp srp = srpBuilder.build();
 209         //ERO Mandatory in Upd
 210         final PathBuilder pb = new PathBuilder();
 211         pb.setEro(new EroBuilder().build());
 212
 213         updBuilder.setPath(pb.build());
 214         updBuilder.setLsp(lsp).setSrp(srp).setPath(pb.build());
 215
 216         pcupdMessageBuilder.setUpdates(Collections.singletonList(updBuilder.build()));
 217         return srp.getOperationId();
 218     }
 219
 220     private void markAllLspAsStale() {
 221         this.staleLsps.addAll(this.lsps.keySet());
 222     }
 223
 224     private boolean handleErrorMessage(final PcerrMessage message) {
 225         final org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcerr.message
 226                 .PcerrMessage errMsg = message.getPcerrMessage();
 227         if (errMsg.getErrorType() instanceof StatefulCase) {
 228             final StatefulCase stat = (StatefulCase) errMsg.getErrorType();
 229             for (final Srps srps : stat.getStateful().getSrps()) {
 230                 final SrpIdNumber id = srps.getSrp().getOperationId();
 231                 if (id.getValue().toJava() != 0) {
 232                     final PCEPRequest req = removeRequest(id);
 233                     if (req != null) {
 234                         req.done(OperationResults.createFailed(errMsg.getErrors()));
 235                     } else {
 236                         LOG.warn("Request ID {} not found in outstanding DB", id);
 237                     }
 238                 }
 239             }
 240         } else {
 241             LOG.warn("Unhandled PCErr message {}.", errMsg);
 242             return true;
 243         }
 244         return false;
 245     }
 246
 247     private boolean isSolicited(final Srp srp, final Lsp lsp, final MessageContext ctx, final ReportedLspBuilder rlb) {
 248         if (srp == null) {
 249             return false;
 250         }
 251         final SrpIdNumber id = srp.getOperationId();
 252         if (id.getValue().toJava() == 0) {
 253             return false;
 254         }
 255         switch (lsp.getOperational()) {
 256             case Active:
 257             case Down:
 258             case Up:
 259                 if (!isTriggeredSyncInProcess()) {
 260                     final PCEPRequest req = removeRequest(id);
 261                     if (req != null) {
 262                         LOG.debug("Request {} resulted in LSP operational state {}", id, lsp.getOperational());
 263                         rlb.setMetadata(req.getMetadata());
 264                         ctx.resolveRequest(req);
 265                     } else {
 266                         LOG.warn("Request ID {} not found in outstanding DB", id);
 267                     }
 268                 }
 269                 break;
 270             case GoingDown:
 271             case GoingUp:
 272                 // These are transitive states, so we don't have to do anything, as they will be followed
 273                 // up...
 274                 break;
 275             default:
 276                 break;
 277         }
 278         return true;
 279     }
 280
 281     private boolean manageNextReport(final Reports report, final MessageContext ctx) {
 282         final Lsp lsp = report.getLsp();
 283         final PlspId plspid = lsp.getPlspId();
 284         final Srp srp = report.getSrp();
 285
 286         if (!lsp.isSync() && (plspid == null || plspid.getValue().toJava() == 0)) {
 287             purgeStaleLsps(ctx);
 288             if (isTriggeredSyncInProcess()) {
 289                 if (srp == null) {
 290                     return false;
 291                 }
 292                 final SrpIdNumber id = srp.getOperationId();
 293                 if (id.getValue().toJava() == 0) {
 294                     return false;
 295                 }
 296                 final PCEPRequest req = removeRequest(id);
 297                 ctx.resolveRequest(req);
 298             }
 299             stateSynchronizationAchieved(ctx);
 300             return true;
 301         }
 302         final ReportedLspBuilder rlb = new ReportedLspBuilder();
 303         boolean solicited = false;
 304         solicited = isSolicited(srp, lsp, ctx, rlb);
 305
 306         // if remove flag is set in SRP object, remove the tunnel immediately
 307         if (solicited && srp.augmentation(Srp1.class) != null) {
 308             final Srp1 initiatedSrp = srp.augmentation(Srp1.class);
 309             if (initiatedSrp.isRemove()) {
 310                 super.removeLsp(ctx, plspid);
 311                 return false;
 312             }
 313         }
 314         rlb.setPath(Collections.singletonList(buildPath(report, srp, lsp)));
 315
 316         String name = lookupLspName(plspid);
 317         if (lsp.getTlvs() != null && lsp.getTlvs().getSymbolicPathName() != null) {
 318             name = StandardCharsets.UTF_8.decode(ByteBuffer.wrap(lsp.getTlvs().getSymbolicPathName().getPathName()
 319                     .getValue())).toString();
 320         }
 321         //get LspDB from LSP and write it to pcc's node
 322         final LspDbVersion lspDbVersion = geLspDbVersionTlv(lsp);
 323         if (lspDbVersion != null) {
 324             updatePccNode(ctx, new PathComputationClientBuilder().addAugmentation(PathComputationClient1.class,
 325                     new PathComputationClient1Builder().setLspDbVersion(lspDbVersion).build()).build());
 326         }
 327         updateLsp(ctx, plspid, name, rlb, solicited, lsp.isRemove());
 328         unmarkStaleLsp(plspid);
 329
 330         LOG.debug("LSP {} updated", lsp);
 331         return true;
 332     }
 333
 334     private static Path buildPath(final Reports report, final Srp srp, final Lsp lsp) {
 335         final org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev200120.pcep.client
 336                 .attributes.path.computation.client.reported.lsp.PathBuilder pb = new org.opendaylight.yang.gen.v1
 337                 .urn.opendaylight.params.xml.ns.yang.topology.pcep.rev200120.pcep.client.attributes.path.computation
 338                 .client.reported.lsp.PathBuilder();
 339         if (report.getPath() != null) {
 340             pb.fieldsFrom(report.getPath());
 341         }
 342         // LSP is mandatory (if there is none, parser will throw an exception)
 343         // this is to ensure a path will be created at any rate
 344         final Path1Builder p1Builder = new Path1Builder();
 345         p1Builder.setLsp(report.getLsp());
 346         final PathSetupType pst;
 347         if (srp != null && srp.getTlvs() != null && srp.getTlvs().getPathSetupType() != null) {
 348             pst = srp.getTlvs().getPathSetupType();
 349             p1Builder.setPathSetupType(pst);
 350         } else {
 351             pst = null;
 352         }
 353         pb.addAugmentation(Path1.class, p1Builder.build());
 354         final org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.lsp
 355                 .object.lsp.Tlvs tlvs = report.getLsp().getTlvs();
 356         if (tlvs != null) {
 357             if (tlvs.getLspIdentifiers() != null) {
 358                 pb.setLspId(tlvs.getLspIdentifiers().getLspId());
 359             } else if (!PSTUtil.isDefaultPST(pst)) {
 360                 pb.setLspId(new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820
 361                         .LspId(lsp.getPlspId().getValue()));
 362             }
 363         }
 364         return pb.build();
 365     }
 366
 367     @Override
 368     protected synchronized boolean onMessage(final MessageContext ctx, final Message message) {
 369         if (message instanceof PcerrMessage) {
 370             return handleErrorMessage((PcerrMessage) message);
 371         }
 372         if (!(message instanceof PcrptMessage)) {
 373             return true;
 374         }
 375         this.listenerState.updateLastReceivedRptMsg();
 376         final org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.pcrpt
 377                 .message.PcrptMessage rpt = ((PcrptMessage) message).getPcrptMessage();
 378         for (final Reports report : rpt.getReports()) {
 379             if (!manageNextReport(report, ctx)) {
 380                 return false;
 381             }
 382         }
 383         return false;
 384     }
 385
 386     private SrpIdNumber nextRequest() {
 387         return new SrpIdNumber(Uint32.valueOf(this.requestId.getAndIncrement()));
 388     }
 389
 390     @Override
 391     @SuppressFBWarnings(value = "NP_NULL_ON_SOME_PATH", justification = "SB does not grok TYPE_USE")
 392     public synchronized ListenableFuture<OperationResult> addLsp(final AddLspArgs input) {
 393         checkArgument(input != null && input.getName() != null && input.getNode() != null
 394                 && input.getArguments() != null, MISSING_XML_TAG);
 395         LOG.trace("AddLspArgs {}", input);
 396         // Make sure there is no such LSP
 397         final InstanceIdentifier<ReportedLsp> lsp = lspIdentifier(input.getName());
 398         final ListenableFuture<Optional<ReportedLsp>> f = readOperationalData(lsp);
 399         return f == null ? OperationResults.createUnsent(PCEPErrors.LSP_INTERNAL_ERROR).future()
 400                 : Futures.transformAsync(f, new AddFunction(input, lsp), MoreExecutors.directExecutor());
 401     }
 402
 403     @Override
 404     @SuppressFBWarnings(value = "NP_NULL_ON_SOME_PATH", justification = "SB does not grok TYPE_USE")
 405     public synchronized ListenableFuture<OperationResult> removeLsp(final RemoveLspArgs input) {
 406         checkArgument(input != null && input.getName() != null && input.getNode() != null, MISSING_XML_TAG);
 407         LOG.trace("RemoveLspArgs {}", input);
 408         // Make sure the LSP exists, we need it for PLSP-ID
 409         final InstanceIdentifier<ReportedLsp> lsp = lspIdentifier(input.getName());
 410         final ListenableFuture<Optional<ReportedLsp>> f = readOperationalData(lsp);
 411         return f == null ? OperationResults.createUnsent(PCEPErrors.LSP_INTERNAL_ERROR).future()
 412                 : Futures.transformAsync(f, rep -> {
 413                     final Lsp reportedLsp = validateReportedLsp(rep, input);
 414                     if (reportedLsp == null) {
 415                         return OperationResults.createUnsent(PCEPErrors.UNKNOWN_PLSP_ID).future();
 416                     }
 417                     final PcinitiateMessageBuilder ib = new PcinitiateMessageBuilder(MESSAGE_HEADER);
 418                     final Requests rb = buildRequest(rep, reportedLsp);
 419                     ib.setRequests(Collections.singletonList(rb));
 420                     return sendMessage(new PcinitiateBuilder().setPcinitiateMessage(ib.build()).build(),
 421                         rb.getSrp().getOperationId(), null);
 422                 }, MoreExecutors.directExecutor());
 423     }
 424
 425     private Requests buildRequest(final Optional<ReportedLsp> rep, final Lsp reportedLsp) {
 426         // Build the request and send it
 427         final RequestsBuilder rb = new RequestsBuilder();
 428         final SrpBuilder srpBuilder = new SrpBuilder().addAugmentation(Srp1.class, new Srp1Builder()
 429                 .setRemove(Boolean.TRUE).build()).setOperationId(nextRequest()).setProcessingRule(Boolean.TRUE);
 430         final Optional<PathSetupType> maybePST = getPST(rep);
 431         if (maybePST.isPresent()) {
 432             srpBuilder.setTlvs(new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful
 433                     .rev181109.srp.object.srp.TlvsBuilder().setPathSetupType(maybePST.get()).build());
 434         }
 435         rb.setSrp(srpBuilder.build());
 436         rb.setLsp(new LspBuilder().setRemove(Boolean.FALSE).setPlspId(reportedLsp.getPlspId())
 437                 .setDelegate(reportedLsp.isDelegate()).build());
 438         return rb.build();
 439     }
 440
 441     @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD",
 442             justification = "https://github.com/spotbugs/spotbugs/issues/811")
 443     private ListenableFuture<OperationResult> redelegate(final Lsp reportedLsp, final Srp srp, final Lsp lsp,
 444             final UpdateLspArgs input) {
 445         // the D bit that was reported decides the type of PCE message sent
 446         requireNonNull(reportedLsp.isDelegate());
 447         final Message msg;
 448         if (reportedLsp.isDelegate()) {
 449             // we already have delegation, send update
 450             final UpdatesBuilder rb = new UpdatesBuilder();
 451             rb.setSrp(srp);
 452             rb.setLsp(lsp);
 453             final PathBuilder pb = new PathBuilder();
 454             pb.fieldsFrom(input.getArguments());
 455             rb.setPath(pb.build());
 456             final PcupdMessageBuilder ub = new PcupdMessageBuilder(MESSAGE_HEADER);
 457             ub.setUpdates(Collections.singletonList(rb.build()));
 458             msg = new PcupdBuilder().setPcupdMessage(ub.build()).build();
 459         } else {
 460             final Lsp1 lspCreateFlag = reportedLsp.augmentation(Lsp1.class);
 461             // we only retake delegation for PCE initiated tunnels
 462             if (lspCreateFlag != null && !lspCreateFlag.isCreate()) {
 463                 LOG.warn("Unable to retake delegation of PCC-initiated tunnel: {}", reportedLsp);
 464                 return OperationResults.createUnsent(PCEPErrors.UPDATE_REQ_FOR_NON_LSP).future();
 465             }
 466             // we want to revoke delegation, different type of message
 467             // is sent because of specification by Siva
 468             // this message is also sent, when input delegate bit is set to 0
 469             // generating an error in PCC
 470             final List<Requests> reqs = new ArrayList<>();
 471             reqs.add(new RequestsBuilder().setSrp(srp).setLsp(lsp).build());
 472             final PcinitiateMessageBuilder ib = new PcinitiateMessageBuilder();
 473             ib.setRequests(reqs);
 474             msg = new PcinitiateBuilder().setPcinitiateMessage(ib.build()).build();
 475         }
 476         return sendMessage(msg, srp.getOperationId(), input.getArguments().getMetadata());
 477     }
 478
 479     @Override
 480     @SuppressFBWarnings(value = "NP_NULL_ON_SOME_PATH", justification = "SB does not grok TYPE_USE")
 481
 482     public synchronized ListenableFuture<OperationResult> updateLsp(final UpdateLspArgs input) {
 483         checkArgument(input != null && input.getName() != null && input.getNode() != null
 484                 && input.getArguments() != null, MISSING_XML_TAG);
 485         LOG.trace("UpdateLspArgs {}", input);
 486         // Make sure the LSP exists
 487         final InstanceIdentifier<ReportedLsp> lsp = lspIdentifier(input.getName());
 488         final ListenableFuture<Optional<ReportedLsp>> f = readOperationalData(lsp);
 489         return f == null ? OperationResults.createUnsent(PCEPErrors.LSP_INTERNAL_ERROR).future()
 490                 : Futures.transformAsync(f, new UpdateFunction(input), MoreExecutors.directExecutor());
 491     }
 492
 493     @Override
 494     public synchronized ListenableFuture<OperationResult> ensureLspOperational(final EnsureLspOperationalInput input) {
 495         checkArgument(input != null && input.getName() != null && input.getNode() != null, MISSING_XML_TAG);
 496         final Arguments args = input.getArguments();
 497         checkArgument(args != null, MISSING_XML_TAG);
 498
 499         final OperationalStatus op;
 500         final Arguments1 aa = args.augmentation(Arguments1.class);
 501         if (aa != null) {
 502             op = aa.getOperational();
 503         } else {
 504             op = null;
 505         }
 506
 507         // Make sure the LSP exists
 508         final InstanceIdentifier<ReportedLsp> lsp = lspIdentifier(input.getName());
 509         LOG.debug("Checking if LSP {} has operational state {}", lsp, op);
 510         final ListenableFuture<Optional<ReportedLsp>> f = readOperationalData(lsp);
 511         return f == null ? OperationResults.createUnsent(PCEPErrors.LSP_INTERNAL_ERROR).future()
 512                 : listenableFuture(f, input, op);
 513     }
 514
 515     private static ListenableFuture<OperationResult> listenableFuture(
 516             final ListenableFuture<Optional<ReportedLsp>> future, final EnsureLspOperationalInput input,
 517             final OperationalStatus op) {
 518         return Futures.transform(future, rep -> {
 519             if (!rep.isPresent()) {
 520                 LOG.debug("Node {} does not contain LSP {}", input.getNode(), input.getName());
 521                 return OperationResults.UNSENT;
 522             }
 523             // check if at least one of the paths has the same status as requested
 524             for (final Path p : rep.get().getPath()) {
 525                 final Path1 p1 = p.augmentation(Path1.class);
 526                 if (p1 == null) {
 527                     LOG.warn("Node {} LSP {} does not contain data", input.getNode(), input.getName());
 528                     return OperationResults.UNSENT;
 529                 }
 530                 if (op.equals(p1.getLsp().getOperational())) {
 531                     return OperationResults.SUCCESS;
 532                 }
 533             }
 534             return OperationResults.UNSENT;
 535         }, MoreExecutors.directExecutor());
 536     }
 537
 538     @Override
 539     protected Lsp validateReportedLsp(final Optional<ReportedLsp> rep, final LspId input) {
 540         if (!rep.isPresent()) {
 541             LOG.debug("Node {} does not contain LSP {}", input.getNode(), input.getName());
 542             return null;
 543         }
 544         // it doesn't matter how many lsps there are in the path list, we only need data that is the same in each path
 545         final Path1 ra = rep.get().getPath().get(0).augmentation(Path1.class);
 546         checkState(ra != null, "Reported LSP reported null from data-store.");
 547         final Lsp reportedLsp = ra.getLsp();
 548         checkState(reportedLsp != null, "Reported LSP does not contain LSP object.");
 549         return reportedLsp;
 550     }
 551
 552     private static Optional<PathSetupType> getPST(final Optional<ReportedLsp> rep) {
 553         if (rep.isPresent()) {
 554             final Path1 path1 = rep.get().getPath().get(0).augmentation(Path1.class);
 555             if (path1 != null) {
 556                 final PathSetupType pst = path1.getPathSetupType();
 557                 if (!PSTUtil.isDefaultPST(pst)) {
 558                     return Optional.of(pst);
 559                 }
 560             }
 561         }
 562         return Optional.empty();
 563     }
 564
 565     /**
 566      * Recover lspData and mark any LSPs in the LSP database that were previously reported by the PCC as stale.
 567      */
 568     @Override
 569     protected synchronized void loadLspData(final Node node, final Map<String, ReportedLsp> lspData,
 570             final Map<PlspId, String> lsps, final boolean incrementalSynchro) {
 571         //load node's lsps from DS
 572         final PathComputationClient pcc = node.augmentation(Node1.class).getPathComputationClient();
 573         final List<ReportedLsp> reportedLsps = pcc.getReportedLsp();
 574         for (final ReportedLsp reportedLsp : reportedLsps) {
 575             final String lspName = reportedLsp.getName();
 576             lspData.put(lspName, reportedLsp);
 577             if (!reportedLsp.getPath().isEmpty()) {
 578                 final Path1 path1 = reportedLsp.getPath().get(0).augmentation(Path1.class);
 579                 if (path1 != null) {
 580                     final PlspId plspId = path1.getLsp().getPlspId();
 581                     if (!incrementalSynchro) {
 582                         this.staleLsps.add(plspId);
 583                     }
 584                     lsps.put(plspId, lspName);
 585                 }
 586             }
 587         }
 588     }
 589
 590     /**
 591      * When the PCC reports an LSP during state synchronization, if the LSP already
 592      * exists in the LSP database, the PCE MUST update the LSP database and
 593      * clear the stale marker from the LSP.
 594      *
 595      * @param plspId id
 596      */
 597     private synchronized void unmarkStaleLsp(final PlspId plspId) {
 598         this.staleLsps.remove(plspId);
 599     }
 600
 601     /**
 602      * Purge any LSPs from the LSP database that are still marked as stale.
 603      *
 604      * @param ctx message context
 605      */
 606     private synchronized void purgeStaleLsps(final MessageContext ctx) {
 607         for (final PlspId plspId : this.staleLsps) {
 608             removeLsp(ctx, plspId);
 609         }
 610         this.staleLsps.clear();
 611     }
 612
 613     @Override
 614     public boolean isInitiationCapability() {
 615         return this.initiationCapability.get();
 616     }
 617
 618     @Override
 619     public boolean isStatefulCapability() {
 620         return this.statefulCapability.get();
 621     }
 622
 623     @Override
 624     public boolean isLspUpdateCapability() {
 625         return this.lspUpdateCapability.get();
 626     }
 627
 628     private synchronized void setStatefulCapabilities(final Stateful stateful) {
 629         this.statefulCapability.set(true);
 630         if (stateful.isLspUpdateCapability() != null) {
 631             this.lspUpdateCapability.set(stateful.isLspUpdateCapability());
 632         }
 633         final Stateful1 stateful1 = stateful.augmentation(Stateful1.class);
 634         if (stateful1 != null && stateful1.isInitiation() != null) {
 635             this.initiationCapability.set(stateful1.isInitiation());
 636         }
 637     }
 638
 639     private class ResyncLspFunction implements AsyncFunction<Optional<ReportedLsp>, OperationResult> {
 640
 641         private final TriggerSyncArgs input;
 642
 643         ResyncLspFunction(final TriggerSyncArgs input) {
 644             this.input = input;
 645         }
 646
 647         @Override
 648         public ListenableFuture<OperationResult> apply(final Optional<ReportedLsp> rep) {
 649             final Lsp reportedLsp = validateReportedLsp(rep, this.input);
 650             if (reportedLsp == null || !rep.isPresent()) {
 651                 return OperationResults.createUnsent(PCEPErrors.UNKNOWN_PLSP_ID).future();
 652             }
 653             // mark lsp as stale
 654             final ReportedLsp staleLsp = rep.get();
 655             if (!staleLsp.getPath().isEmpty()) {
 656                 final Path1 path1 = staleLsp.getPath().get(0).augmentation(Path1.class);
 657                 if (path1 != null) {
 658                     Stateful07TopologySessionListener.this.staleLsps.add(path1.getLsp().getPlspId());
 659                 }
 660             }
 661             updatePccState(PccSyncState.PcepTriggeredResync);
 662             // create PCUpd with mandatory objects and LSP object set to 1
 663             final SrpBuilder srpBuilder = new SrpBuilder();
 664             srpBuilder.setOperationId(nextRequest());
 665             srpBuilder.setProcessingRule(Boolean.TRUE);
 666
 667             final Optional<PathSetupType> maybePST = getPST(rep);
 668             if (maybePST.isPresent()) {
 669                 srpBuilder.setTlvs(
 670                         new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful
 671                                 .rev181109.srp.object.srp.TlvsBuilder()
 672                                 .setPathSetupType(maybePST.get()).build());
 673             }
 674
 675             final Srp srp = srpBuilder.build();
 676             final Lsp lsp = new LspBuilder().setPlspId(reportedLsp.getPlspId()).setSync(Boolean.TRUE).build();
 677
 678             final Message msg = createPcepUpd(srp, lsp);
 679             return sendMessage(msg, srp.getOperationId(), null);
 680         }
 681
 682         private Message createPcepUpd(final Srp srp, final Lsp lsp) {
 683             final UpdatesBuilder rb = new UpdatesBuilder();
 684             rb.setSrp(srp);
 685             rb.setLsp(lsp);
 686             final PathBuilder pb = new PathBuilder();
 687             rb.setPath(pb.build());
 688             final PcupdMessageBuilder ub = new PcupdMessageBuilder(MESSAGE_HEADER);
 689             ub.setUpdates(Collections.singletonList(rb.build()));
 690             return new PcupdBuilder().setPcupdMessage(ub.build()).build();
 691         }
 692     }
 693
 694     private class AddFunction implements AsyncFunction<Optional<ReportedLsp>, OperationResult> {
 695
 696         private final AddLspArgs input;
 697         private final InstanceIdentifier<ReportedLsp> lsp;
 698
 699         AddFunction(final AddLspArgs input, final InstanceIdentifier<ReportedLsp> lsp) {
 700             this.input = input;
 701             this.lsp = lsp;
 702         }
 703
 704         @Override
 705         public ListenableFuture<OperationResult> apply(final Optional<ReportedLsp> rep) {
 706             if (rep.isPresent()) {
 707                 LOG.debug("Node {} already contains lsp {} at {}", this.input.getNode(), this.input.getName(),
 708                         this.lsp);
 709                 return OperationResults.createUnsent(PCEPErrors.USED_SYMBOLIC_PATH_NAME).future();
 710             }
 711             if (!Stateful07TopologySessionListener.this.initiationCapability.get()) {
 712                 return OperationResults.createUnsent(PCEPErrors.CAPABILITY_NOT_SUPPORTED).future();
 713             }
 714
 715             // Build the request
 716             final RequestsBuilder rb = new RequestsBuilder();
 717             final Arguments2 args = this.input.getArguments().augmentation(Arguments2.class);
 718             final Lsp inputLsp = args != null ? args.getLsp() : null;
 719             if (inputLsp == null) {
 720                 return OperationResults.createUnsent(PCEPErrors.LSP_MISSING).future();
 721             }
 722
 723             rb.fieldsFrom(this.input.getArguments());
 724
 725             final TlvsBuilder tlvsBuilder;
 726             if (inputLsp.getTlvs() != null) {
 727                 tlvsBuilder = new TlvsBuilder(inputLsp.getTlvs());
 728             } else {
 729                 tlvsBuilder = new TlvsBuilder();
 730             }
 731             tlvsBuilder.setSymbolicPathName(
 732                     new SymbolicPathNameBuilder().setPathName(new SymbolicPathName(this.input.getName()
 733                             .getBytes(StandardCharsets.UTF_8))).build());
 734
 735             final SrpBuilder srpBuilder = new SrpBuilder()
 736                     .setOperationId(nextRequest())
 737                     .setProcessingRule(Boolean.TRUE);
 738             if (!PSTUtil.isDefaultPST(args.getPathSetupType())) {
 739                 srpBuilder.setTlvs(
 740                         new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf
 741                                 .stateful.rev181109.srp.object.srp.TlvsBuilder()
 742                                 .setPathSetupType(args.getPathSetupType()).build());
 743             }
 744             rb.setSrp(srpBuilder.build());
 745
 746             rb.setLsp(new LspBuilder()
 747                 .setAdministrative(inputLsp.isAdministrative())
 748                 .setDelegate(inputLsp.isDelegate())
 749                 .setPlspId(PLSPID_ZERO)
 750                 .setTlvs(tlvsBuilder.build())
 751                 .build());
 752
 753             // Send the message
 754             return sendMessage(new PcinitiateBuilder()
 755                 .setPcinitiateMessage(new PcinitiateMessageBuilder(MESSAGE_HEADER)
 756                     .setRequests(Collections.singletonList(rb.build()))
 757                     .build())
 758                 .build(),
 759                 rb.getSrp().getOperationId(), this.input.getArguments().getMetadata());
 760         }
 761     }
 762
 763     private class UpdateFunction implements AsyncFunction<Optional<ReportedLsp>, OperationResult> {
 764
 765         private final UpdateLspArgs input;
 766
 767         UpdateFunction(final UpdateLspArgs input) {
 768             this.input = input;
 769         }
 770
 771         @Override
 772         public ListenableFuture<OperationResult> apply(final Optional<ReportedLsp> rep) {
 773             final Lsp reportedLsp = validateReportedLsp(rep, this.input);
 774             if (reportedLsp == null) {
 775                 return OperationResults.createUnsent(PCEPErrors.UNKNOWN_PLSP_ID).future();
 776             }
 777             // create mandatory objects
 778             final Arguments3 args = this.input.getArguments().augmentation(Arguments3.class);
 779             final SrpBuilder srpBuilder = new SrpBuilder();
 780             srpBuilder.setOperationId(nextRequest());
 781             srpBuilder.setProcessingRule(Boolean.TRUE);
 782             if (args != null && args.getPathSetupType() != null) {
 783                 if (!PSTUtil.isDefaultPST(args.getPathSetupType())) {
 784                     srpBuilder.setTlvs(
 785                             new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful
 786                                     .rev181109.srp.object.srp.TlvsBuilder()
 787                                     .setPathSetupType(args.getPathSetupType()).build());
 788                 }
 789             } else {
 790                 final Optional<PathSetupType> maybePST = getPST(rep);
 791                 if (maybePST.isPresent()) {
 792                     srpBuilder.setTlvs(
 793                             new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful
 794                                     .rev181109.srp.object.srp.TlvsBuilder()
 795                                     .setPathSetupType(maybePST.get()).build());
 796                 }
 797             }
 798             final Srp srp = srpBuilder.build();
 799             final Lsp inputLsp = args != null ? args.getLsp() : null;
 800             final LspBuilder lspBuilder = new LspBuilder().setPlspId(reportedLsp.getPlspId());
 801             if (inputLsp != null) {
 802                 lspBuilder.setDelegate(inputLsp.isDelegate() != null && inputLsp.isDelegate())
 803                         .setTlvs(inputLsp.getTlvs())
 804                         .setAdministrative(inputLsp.isAdministrative() != null && inputLsp.isAdministrative());
 805             }
 806             return redelegate(reportedLsp, srp, lspBuilder.build(), this.input);
 807         }
 808     }
 809 }