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