2 * Copyright (c) 2013 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
8 package org.opendaylight.bgpcep.pcep.topology.provider;
10 import static java.util.Objects.requireNonNull;
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;
22 import java.util.concurrent.ExecutionException;
23 import java.util.concurrent.TimeUnit;
24 import java.util.concurrent.atomic.AtomicBoolean;
25 import javax.annotation.concurrent.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.controller.md.sal.binding.api.WriteTransaction;
30 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
31 import org.opendaylight.mdsal.common.api.CommitInfo;
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.rev131005.open.object.open.TlvsBuilder;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev171025.AddLspArgs;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev171025.EnsureLspOperationalInput;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev171025.OperationResult;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev171025.RemoveLspArgs;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev171025.TearDownSessionInput;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev171025.TopologyTypes1;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev171025.TopologyTypes1Builder;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev171025.TriggerSyncArgs;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev171025.UpdateLspArgs;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev171025.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;
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";
71 final AtomicBoolean isClosed = new AtomicBoolean(false);
73 private final Map<NodeId, TopologySessionListener> nodes = new HashMap<>();
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;
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);
96 private static NodeId createNodeId(final InetAddress addr) {
97 return new NodeId("pcc://" + addr.getHostAddress());
101 * Create Base Topology.
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.put(LogicalDatastoreType.OPERATIONAL, this.topology, new TopologyBuilder().setKey(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(), true);
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);
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.");
128 this.nodes.remove(createNodeId(session.getRemoteAddress()));
129 if (nodeState != null) {
130 LOG.debug("Node {} unbound", nodeState.getNodeId());
131 nodeState.released(persistNode);
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);
144 LOG.debug("Node {} requested by listener {}", id, sessionListener);
145 TopologyNodeState ret = this.state.get(id);
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);
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();
160 ret.taken(retrieveNode);
161 this.nodes.put(id, sessionListener);
162 LOG.debug("Node {} bound to listener {}", id, sessionListener);
167 public PCEPSessionListener getSessionListener() {
168 return this.listenerFactory.createTopologySessionListener(this);
171 private synchronized TopologySessionListener checkSessionPresence(final NodeId nodeId) {
172 // Get the listener corresponding to the node
173 final TopologySessionListener l = this.nodes.get(nodeId);
175 LOG.debug("Session for node {} not found", nodeId);
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();
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();
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();
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();
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();
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();
219 return listener.tearDownSession(input);
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();
227 for (final TopologySessionListener node : this.nodes.values()) {
231 for (final TopologyNodeState topologyNodeState : this.state.values()) {
232 topologyNodeState.close();
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>() {
241 public void onSuccess(final CommitInfo result) {
242 LOG.debug("Topology {} removed", ServerSessionManager.this.topology);
246 public void onFailure(final Throwable throwable) {
247 LOG.warn("Failed to remove Topology {}", ServerSessionManager.this.topology, throwable);
249 }, MoreExecutors.directExecutor());
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);
260 short getRpcTimeout() {
261 return this.rpcTimeout;
265 public synchronized void bind(final KeyedInstanceIdentifier<Node, NodeKey> nodeId,
266 final PcepSessionState sessionState) {
267 this.dependenciesProvider.getStateRegistry().bind(nodeId, sessionState);
271 public synchronized void unbind(final KeyedInstanceIdentifier<Node, NodeKey> nodeId) {
272 this.dependenciesProvider.getStateRegistry().unbind(nodeId);
275 PCEPDispatcherDependencies getPCEPDispatcherDependencies() {
276 return this.pcepDispatcherDependencies;