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