pcep/topology/topology-provider/src/main/java/org/opendaylight/bgpcep/pcep/topology/provider/ServerSessionManager.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 java.util.Objects.requireNonNull;
  11
  12 import com.google.common.annotations.VisibleForTesting;
  13 import com.google.common.util.concurrent.FluentFuture;
  14 import com.google.common.util.concurrent.FutureCallback;
  15 import com.google.common.util.concurrent.ListenableFuture;
  16 import com.google.common.util.concurrent.MoreExecutors;
  17 import java.net.InetAddress;
  18 import java.net.InetSocketAddress;
  19 import java.util.ArrayList;
  20 import java.util.HashMap;
  21 import java.util.Map;
  22 import java.util.concurrent.ExecutionException;
  23 import java.util.concurrent.TimeUnit;
  24 import java.util.concurrent.atomic.AtomicBoolean;
  25 import org.checkerframework.checker.lock.qual.GuardedBy;
  26 import org.opendaylight.bgpcep.pcep.topology.provider.config.PCEPTopologyConfiguration;
  27 import org.opendaylight.bgpcep.pcep.topology.provider.config.PCEPTopologyProviderDependencies;
  28 import org.opendaylight.bgpcep.pcep.topology.spi.stats.TopologySessionStatsRegistry;
  29 import org.opendaylight.mdsal.binding.api.WriteTransaction;
  30 import org.opendaylight.mdsal.common.api.CommitInfo;
  31 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  32 import org.opendaylight.protocol.pcep.PCEPDispatcherDependencies;
  33 import org.opendaylight.protocol.pcep.PCEPPeerProposal;
  34 import org.opendaylight.protocol.pcep.PCEPSession;
  35 import org.opendaylight.protocol.pcep.PCEPSessionListener;
  36 import org.opendaylight.protocol.pcep.PCEPSessionListenerFactory;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.stats.rev171113.PcepSessionState;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.open.object.open.TlvsBuilder;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev200120.AddLspArgs;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev200120.EnsureLspOperationalInput;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev200120.OperationResult;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev200120.RemoveLspArgs;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev200120.TearDownSessionInput;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev200120.TopologyTypes1Builder;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev200120.TriggerSyncArgs;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev200120.UpdateLspArgs;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev200120.topology.pcep.type.TopologyPcepBuilder;
  48 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  49 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TopologyId;
  50 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
  51 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyBuilder;
  52 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
  53 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  54 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
  55 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.TopologyTypesBuilder;
  56 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  57 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
  58 import org.opendaylight.yangtools.yang.common.RpcError;
  59 import org.opendaylight.yangtools.yang.common.RpcResult;
  60 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  61 import org.slf4j.Logger;
  62 import org.slf4j.LoggerFactory;
  63
  64 final class ServerSessionManager implements PCEPSessionListenerFactory, TopologySessionRPCs, PCEPPeerProposal,
  65         TopologySessionStatsRegistry {
  66     private static final Logger LOG = LoggerFactory.getLogger(ServerSessionManager.class);
  67     private static final long DEFAULT_HOLD_STATE_NANOS = TimeUnit.MINUTES.toNanos(5);
  68     private static final String FAILURE_MSG = "Failed to find session";
  69     @VisibleForTesting
  70     final AtomicBoolean isClosed = new AtomicBoolean(false);
  71     @GuardedBy("this")
  72     private final Map<NodeId, TopologySessionListener> nodes = new HashMap<>();
  73     @GuardedBy("this")
  74     private final Map<NodeId, TopologyNodeState> state = new HashMap<>();
  75     private final TopologySessionListenerFactory listenerFactory;
  76     private final InstanceIdentifier<Topology> topology;
  77     private final PCEPStatefulPeerProposal peerProposal;
  78     private final short rpcTimeout;
  79     private final PCEPTopologyProviderDependencies dependenciesProvider;
  80     private final PCEPDispatcherDependencies pcepDispatcherDependencies;
  81
  82     ServerSessionManager(
  83             final PCEPTopologyProviderDependencies dependenciesProvider,
  84             final TopologySessionListenerFactory listenerFactory,
  85             final PCEPTopologyConfiguration configDependencies) {
  86         this.dependenciesProvider = requireNonNull(dependenciesProvider);
  87         this.topology = requireNonNull(configDependencies.getTopology());
  88         this.listenerFactory = requireNonNull(listenerFactory);
  89         this.peerProposal = PCEPStatefulPeerProposal
  90                 .createStatefulPeerProposal(this.dependenciesProvider.getDataBroker(), this.topology);
  91         this.rpcTimeout = configDependencies.getRpcTimeout();
  92         this.pcepDispatcherDependencies = new PCEPDispatcherDependenciesImpl(this, configDependencies);
  93     }
  94
  95     private static NodeId createNodeId(final InetAddress addr) {
  96         return new NodeId("pcc://" + addr.getHostAddress());
  97     }
  98
  99     /**
 100      * Create Base Topology.
 101      */
 102     synchronized void instantiateServiceInstance() {
 103         final TopologyKey key = InstanceIdentifier.keyOf(this.topology);
 104         final TopologyId topologyId = key.getTopologyId();
 105         final WriteTransaction tx = this.dependenciesProvider.getDataBroker().newWriteOnlyTransaction();
 106         tx.mergeParentStructurePut(LogicalDatastoreType.OPERATIONAL, this.topology, new TopologyBuilder().withKey(key)
 107                 .setTopologyId(topologyId).setTopologyTypes(new TopologyTypesBuilder()
 108                         .addAugmentation(new TopologyTypes1Builder().setTopologyPcep(new TopologyPcepBuilder().build())
 109                             .build()).build())
 110                 .setNode(new ArrayList<>()).build());
 111         try {
 112             tx.commit().get();
 113             LOG.info("PCEP Topology {} created successfully.", topologyId.getValue());
 114             ServerSessionManager.this.isClosed.set(false);
 115         } catch (final ExecutionException | InterruptedException throwable) {
 116             LOG.error("Failed to create PCEP Topology {}.", topologyId.getValue(), throwable);
 117             ServerSessionManager.this.isClosed.set(true);
 118         }
 119     }
 120
 121     synchronized void releaseNodeState(final TopologyNodeState nodeState, final PCEPSession session,
 122             final boolean persistNode) {
 123         if (this.isClosed.get()) {
 124             LOG.error("Session Manager has already been closed.");
 125             return;
 126         }
 127         this.nodes.remove(createNodeId(session.getRemoteAddress()));
 128         if (nodeState != null) {
 129             LOG.debug("Node {} unbound", nodeState.getNodeId());
 130             nodeState.released(persistNode);
 131         }
 132     }
 133
 134     synchronized TopologyNodeState takeNodeState(final InetAddress address,
 135             final TopologySessionListener sessionListener, final boolean retrieveNode) {
 136         final NodeId id = createNodeId(address);
 137         if (this.isClosed.get()) {
 138             LOG.error("Server Session Manager is closed. Unable to create topology node {} with listener {}",
 139                     id, sessionListener);
 140             return null;
 141         }
 142
 143         LOG.debug("Node {} requested by listener {}", id, sessionListener);
 144         TopologyNodeState ret = this.state.get(id);
 145
 146         if (ret == null) {
 147             ret = new TopologyNodeState(this.dependenciesProvider.getDataBroker(), this.topology, id,
 148                     DEFAULT_HOLD_STATE_NANOS);
 149             LOG.debug("Created topology node {} for id {} at {}", ret, id, ret.getNodeId());
 150             this.state.put(id, ret);
 151         }
 152         // if another listener requests the same session, close it
 153         final TopologySessionListener existingSessionListener = this.nodes.get(id);
 154         if (existingSessionListener != null && !sessionListener.equals(existingSessionListener)) {
 155             LOG.error("New session listener {} is in conflict with existing session listener {} on node {},"
 156                     + " closing the existing one.", existingSessionListener, sessionListener, id);
 157             existingSessionListener.close();
 158         }
 159         ret.taken(retrieveNode);
 160         this.nodes.put(id, sessionListener);
 161         LOG.debug("Node {} bound to listener {}", id, sessionListener);
 162         return ret;
 163     }
 164
 165     @Override
 166     public PCEPSessionListener getSessionListener() {
 167         return this.listenerFactory.createTopologySessionListener(this);
 168     }
 169
 170     private synchronized TopologySessionListener checkSessionPresence(final NodeId nodeId) {
 171         // Get the listener corresponding to the node
 172         final TopologySessionListener l = this.nodes.get(nodeId);
 173         if (l == null) {
 174             LOG.debug("Session for node {} not found", nodeId);
 175             return null;
 176         }
 177         return l;
 178     }
 179
 180     @Override
 181     public synchronized ListenableFuture<OperationResult> addLsp(final AddLspArgs input) {
 182         final TopologySessionListener l = checkSessionPresence(input.getNode());
 183         return l != null ? l.addLsp(input) : OperationResults.UNSENT.future();
 184     }
 185
 186     @Override
 187     public synchronized ListenableFuture<OperationResult> removeLsp(final RemoveLspArgs input) {
 188         final TopologySessionListener l = checkSessionPresence(input.getNode());
 189         return l != null ? l.removeLsp(input) : OperationResults.UNSENT.future();
 190     }
 191
 192     @Override
 193     public synchronized ListenableFuture<OperationResult> updateLsp(final UpdateLspArgs input) {
 194         final TopologySessionListener l = checkSessionPresence(input.getNode());
 195         return l != null ? l.updateLsp(input) : OperationResults.UNSENT.future();
 196     }
 197
 198     @Override
 199     public synchronized ListenableFuture<OperationResult> ensureLspOperational(final EnsureLspOperationalInput input) {
 200         final TopologySessionListener l = checkSessionPresence(input.getNode());
 201         return l != null ? l.ensureLspOperational(input) : OperationResults.UNSENT.future();
 202     }
 203
 204     @Override
 205     public synchronized ListenableFuture<OperationResult> triggerSync(final TriggerSyncArgs input) {
 206         final TopologySessionListener l = checkSessionPresence(input.getNode());
 207         return l != null ? l.triggerSync(input) : OperationResults.UNSENT.future();
 208     }
 209
 210     @Override
 211     public ListenableFuture<RpcResult<Void>> tearDownSession(final TearDownSessionInput input) {
 212         final TopologySessionListener listener = checkSessionPresence(input.getNode());
 213         if (listener == null) {
 214             return RpcResultBuilder.<Void>failed().withError(RpcError.ErrorType.RPC,
 215                     FAILURE_MSG).buildFuture();
 216         }
 217
 218         return listener.tearDownSession(input);
 219     }
 220
 221     synchronized FluentFuture<? extends CommitInfo> closeServiceInstance() {
 222         if (this.isClosed.getAndSet(true)) {
 223             LOG.error("Session Manager has already been closed.");
 224             return CommitInfo.emptyFluentFuture();
 225         }
 226         for (final TopologySessionListener node : this.nodes.values()) {
 227             node.close();
 228         }
 229         this.nodes.clear();
 230         for (final TopologyNodeState topologyNodeState : this.state.values()) {
 231             topologyNodeState.close();
 232         }
 233         this.state.clear();
 234
 235         final WriteTransaction t = this.dependenciesProvider.getDataBroker().newWriteOnlyTransaction();
 236         t.delete(LogicalDatastoreType.OPERATIONAL, this.topology);
 237         final FluentFuture<? extends CommitInfo> future = t.commit();
 238         future.addCallback(new FutureCallback<CommitInfo>() {
 239             @Override
 240             public void onSuccess(final CommitInfo result) {
 241                 LOG.debug("Topology {} removed", ServerSessionManager.this.topology);
 242             }
 243
 244             @Override
 245             public void onFailure(final Throwable throwable) {
 246                 LOG.warn("Failed to remove Topology {}", ServerSessionManager.this.topology, throwable);
 247             }
 248         }, MoreExecutors.directExecutor());
 249         return future;
 250     }
 251
 252     @Override
 253     public void setPeerSpecificProposal(final InetSocketAddress address, final TlvsBuilder openBuilder) {
 254         requireNonNull(address);
 255         final byte[] speakerId = this.pcepDispatcherDependencies.getSpeakerIdMapping().get(address.getAddress());
 256         this.peerProposal.setPeerProposal(createNodeId(address.getAddress()), openBuilder, speakerId);
 257     }
 258
 259     short getRpcTimeout() {
 260         return this.rpcTimeout;
 261     }
 262
 263     @Override
 264     public synchronized void bind(final KeyedInstanceIdentifier<Node, NodeKey> nodeId,
 265             final PcepSessionState sessionState) {
 266         this.dependenciesProvider.getStateRegistry().bind(nodeId, sessionState);
 267     }
 268
 269     @Override
 270     public synchronized void unbind(final KeyedInstanceIdentifier<Node, NodeKey> nodeId) {
 271         this.dependenciesProvider.getStateRegistry().unbind(nodeId);
 272     }
 273
 274     PCEPDispatcherDependencies getPCEPDispatcherDependencies() {
 275         return this.pcepDispatcherDependencies;
 276     }
 277
 278     PCEPTopologyProviderDependencies getPCEPTopologyProviderDependencies() {
 279         return this.dependenciesProvider;
 280     }
 281 }