2 * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
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
9 package org.opendaylight.protocol.pcep.pcc.mock;
11 import static org.opendaylight.protocol.pcep.pcc.mock.spi.MsgBuilderUtil.createLsp;
12 import static org.opendaylight.protocol.pcep.pcc.mock.spi.MsgBuilderUtil.createLspTlvs;
13 import static org.opendaylight.protocol.pcep.pcc.mock.spi.MsgBuilderUtil.createLspTlvsEndofSync;
14 import static org.opendaylight.protocol.pcep.pcc.mock.spi.MsgBuilderUtil.createPath;
15 import static org.opendaylight.protocol.pcep.pcc.mock.spi.MsgBuilderUtil.createPcRtpMessage;
16 import static org.opendaylight.protocol.pcep.pcc.mock.spi.MsgBuilderUtil.createSrp;
17 import static org.opendaylight.protocol.pcep.pcc.mock.spi.MsgBuilderUtil.reqToRptPath;
18 import static org.opendaylight.protocol.pcep.pcc.mock.spi.MsgBuilderUtil.updToRptPath;
20 import com.google.common.base.Optional;
21 import com.google.common.base.Preconditions;
22 import com.google.common.net.InetAddresses;
23 import io.netty.util.Timeout;
24 import io.netty.util.Timer;
25 import java.math.BigInteger;
26 import java.net.InetAddress;
27 import java.util.Collections;
28 import java.util.HashMap;
29 import java.util.List;
31 import java.util.Map.Entry;
32 import java.util.concurrent.TimeUnit;
33 import java.util.concurrent.atomic.AtomicLong;
34 import javax.annotation.Nonnull;
35 import javax.annotation.concurrent.GuardedBy;
36 import org.opendaylight.protocol.pcep.pcc.mock.api.LspType;
37 import org.opendaylight.protocol.pcep.pcc.mock.api.PCCSession;
38 import org.opendaylight.protocol.pcep.pcc.mock.api.PCCTunnelManager;
39 import org.opendaylight.protocol.pcep.pcc.mock.spi.MsgBuilderUtil;
40 import org.opendaylight.protocol.pcep.spi.PCEPErrors;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.crabbe.initiated.rev131126.Lsp1;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.crabbe.initiated.rev131126.Lsp1Builder;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.crabbe.initiated.rev131126.Srp1;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.crabbe.initiated.rev131126.Srp1Builder;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.crabbe.initiated.rev131126.pcinitiate.message.pcinitiate.message.Requests;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.OperationalStatus;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.Pcrpt;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.PlspId;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.SrpIdNumber;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.lsp.object.Lsp;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.lsp.object.LspBuilder;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.lsp.object.lsp.Tlvs;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.pcrpt.message.pcrpt.message.reports.Path;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.pcrpt.message.pcrpt.message.reports.PathBuilder;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.pcupd.message.pcupd.message.Updates;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.srp.object.Srp;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.srp.object.SrpBuilder;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.explicit.route.object.ero.Subobject;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.basic.explicit.route.subobjects.subobject.type.IpPrefixCase;
61 public final class PCCTunnelManagerImpl implements PCCTunnelManager {
63 private static final Optional<Srp> NO_SRP = Optional.absent();
65 private final Map<Integer, PCCSession> sessions = new HashMap<>();
66 private final AtomicLong plspIDsCounter;
67 private final String address;
68 private final Timer timer;
69 private final int redelegationTimeout;
70 private final int stateTimeout;
71 private final int lspsCount;
72 private final Optional<TimerHandler> timerHandler;
74 private final Map<PlspId, PCCTunnel> tunnels = new HashMap<>();
75 private PCCSyncOptimization syncOptimization;
77 public PCCTunnelManagerImpl(final int lspsCount, final InetAddress address, final int redelegationTimeout,
78 final int stateTimeout, final Timer timer, final Optional<TimerHandler> timerHandler) {
79 Preconditions.checkArgument(lspsCount >= 0);
80 this.redelegationTimeout = redelegationTimeout;
81 this.stateTimeout = stateTimeout;
82 this.plspIDsCounter = new AtomicLong(lspsCount);
83 this.address = InetAddresses.toAddrString(Preconditions.checkNotNull(address));
84 this.timer = Preconditions.checkNotNull(timer);
85 this.timerHandler = timerHandler;
86 this.lspsCount = lspsCount;
89 protected void reportToAll(final Updates update, final PCCSession session) {
90 final PlspId plspId = update.getLsp().getPlspId();
91 final PCCTunnel tunnel = this.tunnels.get(plspId);
92 final long srpId = update.getSrp().getOperationId().getValue();
94 if (hasDelegation(tunnel, session)) {
95 final Srp srp = createSrp(update.getSrp().getOperationId().getValue());
96 final Path path = updToRptPath(update.getPath());
97 final List<Subobject> subobjects = update.getPath().getEro().getSubobject();
98 final Lsp lsp = update.getLsp();
99 sendToAll(tunnel, plspId, subobjects, srp, path, lsp);
100 //update tunnel state
101 tunnel.setLspState(path);
103 session.sendError(MsgBuilderUtil.createErrorMsg(PCEPErrors.UPDATE_REQ_FOR_NON_LSP, srpId));
106 session.sendError(MsgBuilderUtil.createErrorMsg(PCEPErrors.UNKNOWN_PLSP_ID, srpId));
110 private void returnDelegation(final Updates update, final PCCSession session) {
111 final PlspId plspId = update.getLsp().getPlspId();
112 final PCCTunnel tunnel = this.tunnels.get(plspId);
113 final long srpId = update.getSrp().getOperationId().getValue();
114 if (tunnel != null) {
115 //check if session really has a delegation
116 if (hasDelegation(tunnel, session)) {
118 final Tlvs tlvs = buildTlvs(tunnel, plspId.getValue(), Optional.absent());
119 final Pcrpt pcrtp = createPcRtpMessage(new LspBuilder(update.getLsp()).setSync(true).setOperational(OperationalStatus.Up).setDelegate(false).
120 setTlvs(tlvs).build(), Optional.of(createSrp(srpId)), tunnel.getLspState());
121 session.sendReport(pcrtp);
123 startStateTimeout(tunnel, plspId);
124 //if PCC's LSP, start re-delegation timer
125 if (tunnel.getType() == LspType.PCC_LSP) {
126 startRedelegationTimer(tunnel, plspId, session);
128 //if PCE-initiated LSP, revoke delegation instantly
129 setDelegation(plspId, null);
132 session.sendError(MsgBuilderUtil.createErrorMsg(PCEPErrors.UPDATE_REQ_FOR_NON_LSP, srpId));
135 session.sendError(MsgBuilderUtil.createErrorMsg(PCEPErrors.UNKNOWN_PLSP_ID, srpId));
139 protected void takeDelegation(final Requests request, final PCCSession session) {
140 final PlspId plspId = request.getLsp().getPlspId();
141 final PCCTunnel tunnel = this.tunnels.get(plspId);
142 final long srpId = request.getSrp().getOperationId().getValue();
143 if (tunnel != null) {
144 //check if tunnel has no delegation
145 if ((tunnel.getType() == LspType.PCE_LSP) && ((tunnel.getDelegationHolder() == -1) || (tunnel.getDelegationHolder() == session.getId()))) {
147 tunnel.cancelTimeouts();
148 setDelegation(plspId, session);
150 final Tlvs tlvs = buildTlvs(tunnel, plspId.getValue(), Optional.absent());
151 session.sendReport(createPcRtpMessage(
152 new LspBuilder(request.getLsp()).setSync(true).setOperational(OperationalStatus.Up).setDelegate(true).setTlvs(tlvs).build(),
153 Optional.of(createSrp(srpId)), tunnel.getLspState()));
155 session.sendError(MsgBuilderUtil.createErrorMsg(PCEPErrors.LSP_NOT_PCE_INITIATED, srpId));
158 session.sendError(MsgBuilderUtil.createErrorMsg(PCEPErrors.UNKNOWN_PLSP_ID, srpId));
163 public synchronized void onSessionUp(final PCCSession session) {
164 this.syncOptimization = new PCCSyncOptimization(session);
165 lazyTunnelInicialization();
167 //first session - delegate all PCC's LSPs only when reporting at startup
168 if (!this.sessions.containsKey(session.getId()) && (session.getId() == 0)) {
169 for (final PlspId plspId : this.tunnels.keySet()) {
170 setDelegation(plspId, session);
173 this.sessions.put(session.getId(), session);
175 if (!this.syncOptimization.isTriggeredInitSyncEnabled()) {
181 public synchronized void onSessionDown(final PCCSession session) {
182 for (final Entry<PlspId, PCCTunnel> entry : this.tunnels.entrySet()) {
183 final PCCTunnel tunnel = entry.getValue();
184 final PlspId plspId = entry.getKey();
185 //deal with delegations
186 if (hasDelegation(tunnel, session)) {
187 startStateTimeout(tunnel, entry.getKey());
188 startRedelegationTimer(tunnel, plspId, session);
193 protected void addTunnel(final Requests request, final PCCSession session) {
194 final PlspId plspId = new PlspId(this.plspIDsCounter.incrementAndGet());
195 final PCCTunnel tunnel = new PCCTunnel(request.getLsp().getTlvs().getSymbolicPathName().getPathName().getValue(),
196 session.getId(), LspType.PCE_LSP, reqToRptPath(request));
197 sendToAll(tunnel, plspId, request.getEro().getSubobject(), createSrp(request.getSrp().getOperationId().getValue()),
198 tunnel.getLspState(), new LspBuilder(request.getLsp()).addAugmentation(Lsp1.class, new Lsp1Builder().setCreate(true).build()).build());
199 this.tunnels.put(plspId, tunnel);
202 protected void removeTunnel(final Requests request, final PCCSession session) {
203 final PlspId plspId = request.getLsp().getPlspId();
204 final PCCTunnel tunnel = this.tunnels.get(plspId);
205 final long srpId = request.getSrp().getOperationId().getValue();
206 if (tunnel != null) {
207 if (tunnel.getType() == LspType.PCE_LSP) {
208 if (hasDelegation(tunnel, session)) {
209 this.tunnels.remove(plspId);
210 sendToAll(tunnel, plspId, tunnel.getLspState().getEro().getSubobject(),
211 new SrpBuilder(request.getSrp()).addAugmentation(Srp1.class, new Srp1Builder().setRemove(true).build()).build(),
212 reqToRptPath(request), request.getLsp());
214 session.sendError(MsgBuilderUtil.createErrorMsg(PCEPErrors.UPDATE_REQ_FOR_NON_LSP, srpId));
217 session.sendError(MsgBuilderUtil.createErrorMsg(PCEPErrors.LSP_NOT_PCE_INITIATED, srpId));
220 session.sendError(MsgBuilderUtil.createErrorMsg(PCEPErrors.UNKNOWN_PLSP_ID, srpId));
225 public void onMessagePcupd(@Nonnull final Updates update, @Nonnull final PCCSession session) {
226 final Lsp lsp = update.getLsp();
227 if (isInitialSyncTriggered(lsp)) {
229 if (this.timerHandler.isPresent()) {
230 this.timerHandler.get().createDisconnectTask();
232 } else if (isReSyncTriggered(lsp)) {
233 handledDbTriggeredResync(update, session);
234 } else if ((lsp.isDelegate() != null) && lsp.isDelegate()) {
236 reportToAll(update, session);
238 //returning LSP delegation
239 returnDelegation(update, session);
244 public void onMessagePcInitiate(@Nonnull final Requests request, @Nonnull final PCCSession session) {
245 if ((request.getSrp().getAugmentation(Srp1.class) != null) && request.getSrp().getAugmentation(Srp1.class).isRemove()) {
247 removeTunnel(request, session);
248 } else if ((request.getLsp().isDelegate() != null) && request.getLsp().isDelegate() && (request.getEndpointsObj() == null)) {
249 //take LSP delegation
250 takeDelegation(request, session);
253 addTunnel(request, session);
257 private Tlvs buildTlvs(final PCCTunnel tunnel, final Long plspId, final Optional<List<Subobject>> subobjectsList) {
258 final List<Subobject> subObject = subobjectsList.isPresent() ? subobjectsList.get() : tunnel.getLspState().getEro().getSubobject();
259 final String destinationAddress = getDestinationAddress(subObject, this.address);
261 return createLspTlvs(plspId, true, destinationAddress, this.address, this.address, Optional.of(tunnel.getPathName()),
262 this.syncOptimization.incrementLspDBVersion());
265 private void lazyTunnelInicialization() {
266 if (this.tunnels.isEmpty()) {
267 final BigInteger dbV = this.syncOptimization.getLocalLspDbVersionValue();
268 if (this.syncOptimization.isSyncAvoidanceEnabled() && !((dbV != null) && dbV.equals(BigInteger.ONE))) {
269 this.tunnels.putAll(PCCTunnelBuilder.createTunnels(this.address, dbV.intValue()));
271 this.tunnels.putAll(PCCTunnelBuilder.createTunnels(this.address, this.lspsCount));
276 private boolean isReSyncTriggered(final Lsp lsp) {
277 return this.syncOptimization.isTriggeredReSyncEnabled() && lsp.isSync();
280 private boolean isInitialSyncTriggered(final Lsp lsp) {
281 return (lsp.getPlspId().getValue() == 0) && lsp.isSync() && this.syncOptimization.isTriggeredInitSyncEnabled();
284 private void handledDbTriggeredResync(final Updates update, final PCCSession session) {
285 this.syncOptimization.setResynchronizingState(Boolean.TRUE);
286 final SrpIdNumber operationId = update.getSrp().getOperationId();
287 if (update.getLsp().getPlspId().getValue() == 0) {
288 reportAllKnownLsp(Optional.of(operationId), session);
290 reportLsp(update.getLsp().getPlspId(), operationId, session);
292 sendEndOfSynchronization(session, Optional.of(operationId));
293 this.syncOptimization.setResynchronizingState(Boolean.FALSE);
296 private void lspReport(final PCCSession session) {
297 if (!this.tunnels.isEmpty()) {
298 if (!this.syncOptimization.isSyncAvoidanceEnabled()) {
299 reportAllKnownLsp(session);
300 sendEndOfSynchronization(session);
301 } else if (!this.syncOptimization.doesLspDbMatch()) {
302 if (this.syncOptimization.isDeltaSyncEnabled()) {
303 reportMissedLsp(session);
304 sendEndOfSynchronization(session);
306 reportAllKnownLsp(session);
307 sendEndOfSynchronization(session);
314 * Reports Missed Lsp when DbVersion doesnt match
318 private void reportMissedLsp(final PCCSession session) {
319 for (long missedLsp = this.syncOptimization.getRemoteLspDbVersionValue().longValue() + 1;
320 missedLsp <= this.syncOptimization.getLocalLspDbVersionValue().longValue(); missedLsp++) {
321 final PlspId plspId = new PlspId(missedLsp);
322 final PCCTunnel tunnel = this.tunnels.get(plspId);
323 createLspAndSendReport(missedLsp, tunnel, session, Optional.absent(), NO_SRP);
327 private void createLspAndSendReport(final long plspId, final PCCTunnel tunnel, final PCCSession session, final Optional<Boolean> isSync, final Optional<Srp> srp) {
328 final boolean delegation = hasDelegation(tunnel, session);
330 tunnel.cancelTimeouts();
332 final String destinationAddress = getDestinationAddress(tunnel.getLspState().getEro().getSubobject(), this.address);
333 final Tlvs tlvs = createLspTlvs(plspId, true, destinationAddress, this.address, this.address, Optional.of(tunnel.getPathName()),
334 this.syncOptimization.incrementLspDBVersion());
336 final boolean sync = isSync.isPresent() ? isSync.get() : this.syncOptimization.isSyncNeedIt();
337 final Lsp lsp = createLsp(plspId, sync, Optional.fromNullable(tlvs), delegation, false);
338 final Pcrpt pcrtp = createPcRtpMessage(lsp, srp, tunnel.getLspState());
339 session.sendReport(pcrtp);
342 private void sendEndOfSynchronization(final PCCSession session) {
343 sendEndOfSynchronization(session, Optional.absent());
346 private void sendEndOfSynchronization(final PCCSession session, final Optional<SrpIdNumber> operationId) {
348 if (operationId.isPresent()) {
349 srp = new SrpBuilder().setOperationId(operationId.get()).build();
351 Optional<Tlvs> tlv = Optional.absent();
352 if (this.syncOptimization.isSyncAvoidanceEnabled()) {
353 tlv = createLspTlvsEndofSync(this.syncOptimization.incrementLspDBVersion().get());
355 final Pcrpt pcrtp = createPcRtpMessage(createLsp(0, false, tlv, true, false), Optional.fromNullable(srp), createPath(Collections
357 session.sendReport(pcrtp);
360 private void reportAllKnownLsp(final PCCSession session) {
361 reportAllKnownLsp(Optional.absent(), session);
364 private void reportAllKnownLsp(final Optional<SrpIdNumber> operationId, final PCCSession session) {
366 if (operationId.isPresent()) {
367 srp = new SrpBuilder().setOperationId(operationId.get()).build();
370 for (final Entry<PlspId, PCCTunnel> entry : this.tunnels.entrySet()) {
371 final PCCTunnel tunnel = entry.getValue();
372 final long plspId = entry.getKey().getValue();
373 createLspAndSendReport(plspId, tunnel, session, Optional.absent(), Optional.fromNullable(srp));
377 private void reportLsp(final PlspId plspId, final SrpIdNumber operationId, final PCCSession session) {
378 final PCCTunnel tunnel = this.tunnels.get(plspId);
379 if (tunnel == null) {
382 final Srp srp = new SrpBuilder().setOperationId(operationId).build();
383 createLspAndSendReport(plspId.getValue(), tunnel, session, Optional.of(Boolean.TRUE), Optional.of(srp));
386 private void sendToAll(final PCCTunnel tunnel, final PlspId plspId, final List<Subobject> subobjects, final Srp srp, final Path path, final Lsp lsp) {
387 for (final PCCSession session : this.sessions.values()) {
388 final boolean isDelegated = hasDelegation(tunnel, session);
389 final Tlvs tlvs = buildTlvs(tunnel, plspId.getValue(), Optional.of(subobjects));
391 final Pcrpt pcRpt = createPcRtpMessage(
394 .setOperational(OperationalStatus.Up)
395 .setDelegate(isDelegated)
397 .addAugmentation(Lsp1.class, new Lsp1Builder().setCreate(tunnel.getType() == LspType.PCE_LSP).build())
398 .setTlvs(tlvs).build(),
399 Optional.fromNullable(srp), path);
400 session.sendReport(pcRpt);
404 private void startStateTimeout(final PCCTunnel tunnel, final PlspId plspId) {
405 if (this.stateTimeout > -1) {
406 final Timeout newStateTimeout = this.timer.newTimeout(timeout -> {
407 if (tunnel.getType() == LspType.PCE_LSP) {
408 PCCTunnelManagerImpl.this.tunnels.remove(plspId);
409 //report tunnel removal to all
410 sendToAll(tunnel, plspId, Collections.emptyList(), createSrp(0), new PathBuilder().build(),
411 createLsp(plspId.getValue(), false, Optional.absent(), false, true));
413 }, this.stateTimeout, TimeUnit.SECONDS);
414 tunnel.setStateTimeout(newStateTimeout);
418 private void startRedelegationTimer(final PCCTunnel tunnel, final PlspId plspId, final PCCSession session) {
419 final Timeout newRedelegationTimeout = this.timer.newTimeout(timeout -> {
421 PCCTunnelManagerImpl.this.setDelegation(plspId, null);
422 //delegate to another PCE
423 int index = session.getId();
424 for (int i = 1; i < PCCTunnelManagerImpl.this.sessions.size(); i++) {
426 if (index == PCCTunnelManagerImpl.this.sessions.size()) {
429 final PCCSession nextSession = PCCTunnelManagerImpl.this.sessions.get(index);
430 if (nextSession != null) {
431 tunnel.cancelTimeouts();
432 final Tlvs tlvs = buildTlvs(tunnel, plspId.getValue(), Optional.absent());
434 nextSession.sendReport(createPcRtpMessage(
435 createLsp(plspId.getValue(), true, Optional.fromNullable(tlvs), true, false), NO_SRP,
436 tunnel.getLspState()));
437 tunnel.setDelegationHolder(nextSession.getId());
441 }, this.redelegationTimeout, TimeUnit.SECONDS);
442 tunnel.setRedelegationTimeout(newRedelegationTimeout);
445 private void setDelegation(final PlspId plspId, final PCCSession session) {
446 final PCCTunnel tunnel = this.tunnels.get(plspId);
448 if (session != null) {
449 sessionId = session.getId();
451 sessionId = PCCTunnelBuilder.PCC_DELEGATION;
453 tunnel.setDelegationHolder(sessionId);
456 private static boolean hasDelegation(final PCCTunnel tunnel, final PCCSession session) {
457 final int sessionId = session.getId();
458 final int delegationHolder = tunnel.getDelegationHolder();
459 return delegationHolder == sessionId;
462 private static String getDestinationAddress(final List<Subobject> subobjects, final String defaultAddress) {
463 if ((subobjects != null) && !subobjects.isEmpty()) {
464 final String prefix = ((IpPrefixCase) subobjects.get(subobjects.size() - 1).getSubobjectType())
465 .getIpPrefix().getIpPrefix().getIpv4Prefix().getValue();
466 return prefix.substring(0, prefix.indexOf('/'));
468 return defaultAddress;