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