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.Preconditions;
  12 import com.google.common.collect.ImmutableList;
  13 import com.google.common.collect.Lists;
  14 import com.google.common.util.concurrent.ListenableFuture;
  15
  16 import java.net.InetAddress;
  17 import java.nio.ByteBuffer;
  18 import java.util.Collections;
  19
  20 import javax.annotation.concurrent.GuardedBy;
  21
  22 import org.opendaylight.controller.sal.binding.api.data.DataModificationTransaction;
  23 import org.opendaylight.protocol.pcep.PCEPSession;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.crabbe.initiated.rev131126.PcinitiateBuilder;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.crabbe.initiated.rev131126.Srp1;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.crabbe.initiated.rev131126.Srp1Builder;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.crabbe.initiated.rev131126.pcinitiate.message.PcinitiateMessageBuilder;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.crabbe.initiated.rev131126.pcinitiate.message.pcinitiate.message.RequestsBuilder;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.Arguments1;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.Arguments2;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.Arguments3;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.OperationalStatus;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.Path1;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.Path1Builder;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.PcrptMessage;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.PcupdBuilder;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.PlspId;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.SrpIdNumber;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.StatefulTlv1;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.StatefulTlv1Builder;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.SymbolicPathName;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.Tlvs1;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.lsp.object.Lsp;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.lsp.object.LspBuilder;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.lsp.object.lsp.TlvsBuilder;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.pcerr.pcerr.message.error.type.StatefulCase;
  47 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;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.pcrpt.message.pcrpt.message.Reports;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.pcupd.message.PcupdMessageBuilder;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.pcupd.message.pcupd.message.UpdatesBuilder;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.pcupd.message.pcupd.message.updates.PathBuilder;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.srp.object.Srp;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.srp.object.SrpBuilder;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.stateful.capability.tlv.Stateful;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.symbolic.path.name.tlv.SymbolicPathNameBuilder;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.Message;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.PcerrMessage;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.open.object.open.Tlvs;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev130820.LspId;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.AddLspArgs;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.EnsureLspOperationalInput;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.OperationResult;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.PccSyncState;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.RemoveLspArgs;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.UpdateLspArgs;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.pcep.client.attributes.PathComputationClientBuilder;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.pcep.client.attributes.path.computation.client.ReportedLsp;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.pcep.client.attributes.path.computation.client.ReportedLspBuilder;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.pcep.client.attributes.path.computation.client.StatefulTlvBuilder;
  70 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  71 import org.slf4j.Logger;
  72 import org.slf4j.LoggerFactory;
  73
  74 final class Stateful07TopologySessionListener extends AbstractTopologySessionListener<SrpIdNumber, PlspId> {
  75     private static final Logger LOG = LoggerFactory.getLogger(Stateful07TopologySessionListener.class);
  76
  77     /**
  78      * @param serverSessionManager
  79      */
  80     Stateful07TopologySessionListener(final ServerSessionManager serverSessionManager) {
  81         super(serverSessionManager);
  82     }
  83
  84     @GuardedBy("this")
  85     private long requestId = 1;
  86
  87     @Override
  88     protected void onSessionUp(final PCEPSession session, final PathComputationClientBuilder pccBuilder) {
  89         final InetAddress peerAddress = session.getRemoteAddress();
  90
  91         final Tlvs tlvs = session.getRemoteTlvs();
  92         if (tlvs != null && tlvs.getAugmentation(Tlvs1.class) != null) {
  93             final Stateful stateful = tlvs.getAugmentation(Tlvs1.class).getStateful();
  94             if (stateful != null) {
  95                 pccBuilder.setReportedLsp(Collections.<ReportedLsp> emptyList());
  96                 pccBuilder.setStateSync(PccSyncState.InitialResync);
  97                 pccBuilder.setStatefulTlv(new StatefulTlvBuilder().addAugmentation(StatefulTlv1.class,
  98                         new StatefulTlv1Builder(tlvs.getAugmentation(Tlvs1.class)).build()).build());
  99             } else {
 100                 LOG.debug("Peer {} does not advertise stateful TLV", peerAddress);
 101             }
 102         } else {
 103             LOG.debug("Peer {} does not advertise stateful TLV", peerAddress);
 104         }
 105     }
 106
 107     @Override
 108     protected synchronized boolean onMessage(final DataModificationTransaction trans, final Message message) {
 109         if (message instanceof PcerrMessage) {
 110             final org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.pcerr.message.PcerrMessage errMsg = ((PcerrMessage) message).getPcerrMessage();
 111             if (errMsg.getErrorType() instanceof StatefulCase) {
 112                 StatefulCase stat = (StatefulCase)errMsg.getErrorType();
 113                 for (Srps srps : stat.getStateful().getSrps()) {
 114                     SrpIdNumber id = srps.getSrp().getOperationId();
 115                     if (id.getValue() != 0) {
 116                         final PCEPRequest req = removeRequest(id);
 117                         if (req != null) {
 118                             req.setResult(OperationResults.createFailed(errMsg.getErrors()));
 119                         } else {
 120                             LOG.warn("Request ID {} not found in outstanding DB", id);
 121                         }
 122                     }
 123                 }
 124             } else {
 125                 LOG.warn("Unhandled PCErr message {}.", errMsg);
 126                 return true;
 127             }
 128             return false;
 129         }
 130         if (!(message instanceof PcrptMessage)) {
 131             return true;
 132         }
 133
 134         final org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.pcrpt.message.PcrptMessage rpt = ((PcrptMessage) message).getPcrptMessage();
 135         for (final Reports report : rpt.getReports()) {
 136             final Lsp lsp = report.getLsp();
 137             final PlspId plspid = lsp.getPlspId();
 138
 139             if (!lsp.isSync() && (lsp.getPlspId() == null || plspid.getValue() == 0)) {
 140                 stateSynchronizationAchieved(trans);
 141                 continue;
 142             }
 143
 144             final ReportedLspBuilder rlb = new ReportedLspBuilder();
 145
 146             boolean solicited = false;
 147
 148             final Srp srp = report.getSrp();
 149             if (srp != null) {
 150                 final SrpIdNumber id = srp.getOperationId();
 151                 if (id.getValue() != 0) {
 152                     solicited = true;
 153
 154                     switch (lsp.getOperational()) {
 155                     case Active:
 156                     case Down:
 157                     case Up:
 158                         final PCEPRequest req = removeRequest(id);
 159                         if (req != null) {
 160                             LOG.debug("Request {} resulted in LSP operational state {}", id, lsp.getOperational());
 161                             rlb.setMetadata(req.getMetadata());
 162                             req.setResult(OperationResults.SUCCESS);
 163                         } else {
 164                             LOG.warn("Request ID {} not found in outstanding DB", id);
 165                         }
 166                         break;
 167                     case GoingDown:
 168                     case GoingUp:
 169                         // These are transitive states, so we don't have to do anything, as they will be followed
 170                         // up...
 171                         break;
 172                     }
 173
 174                 }
 175             }
 176             final org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.lsp.object.lsp.Tlvs tlvs = report.getLsp().getTlvs();
 177             final String name;
 178             if (tlvs != null && tlvs.getSymbolicPathName() != null) {
 179                 name = Charsets.UTF_8.decode(ByteBuffer.wrap(tlvs.getSymbolicPathName().getPathName().getValue())).toString();
 180             } else {
 181                 name = null;
 182             }
 183             LspId lspid = null;
 184             if (tlvs != null && tlvs.getLspIdentifiers() != null) {
 185                 lspid = tlvs.getLspIdentifiers().getLspId();
 186             }
 187             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();
 188             if (report.getPath() != null) {
 189                 pb.fieldsFrom(report.getPath());
 190             }
 191             // LSP is mandatory (if there is none, parser will throw an exception)
 192             // this is to ensure a path will be created at any rate
 193             pb.addAugmentation(Path1.class, new Path1Builder().setLsp(report.getLsp()).build());
 194             pb.setLspId(lspid);
 195             rlb.setPath(Lists.newArrayList(pb.build()));
 196             updateLsp(trans, plspid, name, rlb, solicited, lsp.isRemove());
 197             LOG.debug("LSP {} updated", lsp);
 198         }
 199         return false;
 200     }
 201
 202     @GuardedBy("this")
 203     private SrpIdNumber nextRequest() {
 204         return new SrpIdNumber(this.requestId++);
 205     }
 206
 207     @Override
 208     public synchronized ListenableFuture<OperationResult> addLsp(final AddLspArgs input) {
 209         Preconditions.checkArgument(input != null && input.getName() != null & input.getNode() != null && input.getArguments() != null, "Mandatory XML tags are missing.");
 210         LOG.trace("AddLspArgs {}", input);
 211         // Make sure there is no such LSP
 212         final InstanceIdentifier<ReportedLsp> lsp = lspIdentifier(input.getName()).build();
 213         if (readOperationalData(lsp) != null) {
 214             LOG.debug("Node {} already contains lsp {} at {}", input.getNode(), input.getName(), lsp);
 215             return OperationResults.UNSENT.future();
 216         }
 217         // Build the request
 218         final RequestsBuilder rb = new RequestsBuilder();
 219         Arguments2 args = input.getArguments().getAugmentation(Arguments2.class);
 220         Preconditions.checkState(args != null, "Input is missing operational tag.");
 221         Lsp inputLsp = args.getLsp();
 222         Preconditions.checkState(inputLsp != null, "Reported LSP does not contain LSP object.");
 223
 224         rb.fieldsFrom(input.getArguments());
 225
 226         TlvsBuilder tlvsBuilder = new TlvsBuilder();
 227         tlvsBuilder.setSymbolicPathName(
 228                 new SymbolicPathNameBuilder().setPathName(new SymbolicPathName(input.getName().getBytes(Charsets.UTF_8))).build());
 229         if (inputLsp.getTlvs() != null) {
 230             tlvsBuilder.setVsTlv(inputLsp.getTlvs().getVsTlv());
 231         }
 232
 233         rb.setSrp(new SrpBuilder().setOperationId(nextRequest()).setProcessingRule(Boolean.TRUE).build());
 234         rb.setLsp(new LspBuilder().setAdministrative(inputLsp.isAdministrative()).setDelegate(inputLsp.isDelegate()).setPlspId(
 235                 new PlspId(0L)).setTlvs(tlvsBuilder.build()).build());
 236
 237         final PcinitiateMessageBuilder ib = new PcinitiateMessageBuilder(MESSAGE_HEADER);
 238         ib.setRequests(ImmutableList.of(rb.build()));
 239
 240         // Send the message
 241         return sendMessage(new PcinitiateBuilder().setPcinitiateMessage(ib.build()).build(), rb.getSrp().getOperationId(),
 242                 input.getArguments().getMetadata());
 243     }
 244
 245     @Override
 246     public synchronized ListenableFuture<OperationResult> removeLsp(final RemoveLspArgs input) {
 247         Preconditions.checkArgument(input != null && input.getName() != null & input.getNode() != null, "Mandatory XML tags are missing.");
 248         LOG.trace("RemoveLspArgs {}", input);
 249         // Make sure the LSP exists, we need it for PLSP-ID
 250         final InstanceIdentifier<ReportedLsp> lsp = lspIdentifier(input.getName()).build();
 251         final ReportedLsp rep = readOperationalData(lsp);
 252         if (rep == null) {
 253             LOG.debug("Node {} does not contain LSP {}", input.getNode(), input.getName());
 254             return OperationResults.UNSENT.future();
 255         }
 256         // it doesn't matter how many lsps there are in the path list, we only need delegate & plspid that is the same in eeach path
 257         final Path1 ra = rep.getPath().get(0).getAugmentation(Path1.class);
 258         Preconditions.checkState(ra != null, "Reported LSP reported null from data-store.");
 259         Lsp reportedLsp = ra.getLsp();
 260         Preconditions.checkState(reportedLsp != null, "Reported LSP does not contain LSP object.");
 261
 262         // Build the request and send it
 263         final RequestsBuilder rb = new RequestsBuilder();
 264         rb.setSrp(new SrpBuilder().addAugmentation(Srp1.class, new Srp1Builder().setRemove(Boolean.TRUE).build()).setOperationId(nextRequest()).setProcessingRule(Boolean.TRUE).build());
 265         rb.setLsp(new LspBuilder().setRemove(Boolean.FALSE).setPlspId(reportedLsp.getPlspId()).setDelegate(reportedLsp.isDelegate()).build());
 266
 267         final PcinitiateMessageBuilder ib = new PcinitiateMessageBuilder(MESSAGE_HEADER);
 268         ib.setRequests(ImmutableList.of(rb.build()));
 269         return sendMessage(new PcinitiateBuilder().setPcinitiateMessage(ib.build()).build(), rb.getSrp().getOperationId(), null);
 270     }
 271
 272     @Override
 273     public synchronized ListenableFuture<OperationResult> updateLsp(final UpdateLspArgs input) {
 274         Preconditions.checkArgument(input != null && input.getName() != null & input.getNode() != null && input.getArguments() != null, "Mandatory XML tags are missing.");
 275         LOG.trace("UpdateLspArgs {}", input);
 276         // Make sure the LSP exists
 277         final InstanceIdentifier<ReportedLsp> lsp = lspIdentifier(input.getName()).build();
 278         final ReportedLsp rep = readOperationalData(lsp);
 279         if (rep == null) {
 280             LOG.debug("Node {} does not contain LSP {}", input.getNode(), input.getName());
 281             return OperationResults.UNSENT.future();
 282         }
 283         // it doesn't matter how many lsps there are in the path list, we only need plspid that is the same in each path
 284         final Path1 ra = rep.getPath().get(0).getAugmentation(Path1.class);
 285         Preconditions.checkState(ra != null, "Reported LSP reported null from data-store.");
 286         Lsp reportedLsp = ra.getLsp();
 287         Preconditions.checkState(reportedLsp != null, "Reported LSP does not contain LSP object.");
 288
 289         // Build the PCUpd request and send it
 290         final UpdatesBuilder rb = new UpdatesBuilder();
 291         rb.setSrp(new SrpBuilder().setOperationId(nextRequest()).setProcessingRule(Boolean.TRUE).build());
 292         Lsp inputLsp = input.getArguments().getAugmentation(Arguments3.class).getLsp();
 293         if (inputLsp != null) {
 294             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());
 295         } else {
 296             rb.setLsp(new LspBuilder().setPlspId(reportedLsp.getPlspId()).build());
 297         }
 298         final PathBuilder pb = new PathBuilder();
 299         pb.fieldsFrom(input.getArguments());
 300         rb.setPath(pb.build());
 301         final PcupdMessageBuilder ub = new PcupdMessageBuilder(MESSAGE_HEADER);
 302         ub.setUpdates(ImmutableList.of(rb.build()));
 303         return sendMessage(new PcupdBuilder().setPcupdMessage(ub.build()).build(), rb.getSrp().getOperationId(),
 304                 input.getArguments().getMetadata());
 305     }
 306
 307     @Override
 308     public synchronized ListenableFuture<OperationResult> ensureLspOperational(final EnsureLspOperationalInput input) {
 309         Preconditions.checkArgument(input != null && input.getName() != null & input.getNode() != null && input.getArguments() != null, "Mandatory XML tags are missing.");
 310         OperationalStatus op = null;
 311         final Arguments1 aa = input.getArguments().getAugmentation(Arguments1.class);
 312         if (aa != null) {
 313             op = aa.getOperational();
 314         }
 315
 316         // Make sure the LSP exists
 317         final InstanceIdentifier<ReportedLsp> lsp = lspIdentifier(input.getName()).build();
 318         LOG.debug("Checking if LSP {} has operational state {}", lsp, op);
 319         final ReportedLsp rep = readOperationalData(lsp);
 320         if (rep == null) {
 321             LOG.debug("Node {} does not contain LSP {}", input.getNode(), input.getName());
 322             return OperationResults.UNSENT.future();
 323         }
 324         boolean operational = false;
 325         // check if at least one of the paths has the same status as requested
 326         for (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.getPath()) {
 327             Path1 p1 = p.getAugmentation(Path1.class);
 328             if (p1 == null) {
 329                 LOG.warn("Node {} LSP {} does not contain data", input.getNode(), input.getName());
 330                 return OperationResults.UNSENT.future();
 331             }
 332             Lsp l = p1.getLsp();
 333             if (l.getOperational().equals(op)) {
 334                 operational = true;
 335             }
 336         }
 337         if (operational) {
 338             return OperationResults.SUCCESS.future();
 339         } else {
 340             return OperationResults.UNSENT.future();
 341         }
 342     }
 343 }