Bump upstreams
[bgpcep.git] / pcep / topology / topology-provider / src / main / java / org / opendaylight / bgpcep / pcep / topology / provider / ServerSessionManager.java
index 858d9358098983ee65bae6f5e91fafb74f2d5f1b..8fde9947f136d0487108c749294a10ca93706241 100644 (file)
@@ -9,121 +9,182 @@ package org.opendaylight.bgpcep.pcep.topology.provider;
 
 import static java.util.Objects.requireNonNull;
 
-import com.google.common.annotations.VisibleForTesting;
 import com.google.common.util.concurrent.FluentFuture;
 import com.google.common.util.concurrent.FutureCallback;
 import com.google.common.util.concurrent.ListenableFuture;
 import com.google.common.util.concurrent.MoreExecutors;
+import com.google.common.util.concurrent.SettableFuture;
+import io.netty.util.Timeout;
+import java.lang.invoke.MethodHandles;
+import java.lang.invoke.VarHandle;
 import java.net.InetAddress;
-import java.net.InetSocketAddress;
 import java.util.HashMap;
+import java.util.List;
 import java.util.Map;
-import java.util.concurrent.ExecutionException;
 import java.util.concurrent.TimeUnit;
-import java.util.concurrent.atomic.AtomicBoolean;
 import org.checkerframework.checker.lock.qual.GuardedBy;
-import org.opendaylight.bgpcep.pcep.topology.provider.config.PCEPTopologyConfiguration;
-import org.opendaylight.bgpcep.pcep.topology.provider.config.PCEPTopologyProviderDependencies;
-import org.opendaylight.bgpcep.pcep.topology.spi.stats.TopologySessionStatsRegistry;
+import org.eclipse.jdt.annotation.NonNull;
+import org.eclipse.jdt.annotation.Nullable;
+import org.opendaylight.bgpcep.pcep.server.PceServerProvider;
 import org.opendaylight.mdsal.binding.api.WriteTransaction;
 import org.opendaylight.mdsal.common.api.CommitInfo;
 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
-import org.opendaylight.protocol.pcep.PCEPDispatcherDependencies;
-import org.opendaylight.protocol.pcep.PCEPPeerProposal;
-import org.opendaylight.protocol.pcep.PCEPSession;
 import org.opendaylight.protocol.pcep.PCEPSessionListenerFactory;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.stats.rev171113.PcepSessionState;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.open.object.open.TlvsBuilder;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev200120.AddLspArgs;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev200120.EnsureLspOperationalInput;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev200120.OperationResult;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev200120.RemoveLspArgs;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev200120.TearDownSessionInput;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev200120.TopologyTypes1Builder;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev200120.TriggerSyncArgs;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev200120.UpdateLspArgs;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev200120.topology.pcep.type.TopologyPcepBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.graph.rev220720.graph.topology.GraphKey;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev200720.SrpIdNumber;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev220730.AddLspArgs;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev220730.EnsureLspOperationalInput;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev220730.OperationResult;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev220730.RemoveLspArgs;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev220730.TearDownSessionInput;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev220730.TearDownSessionInputBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev220730.TopologyTypes1Builder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev220730.TriggerSyncArgs;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev220730.UpdateLspArgs;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev220730.network.topology.topology.topology.types.TopologyPcepBuilder;
 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
-import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TopologyId;
 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyBuilder;
 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
-import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
-import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.TopologyTypesBuilder;
-import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
-import org.opendaylight.yangtools.yang.common.RpcError;
+import org.opendaylight.yangtools.yang.common.ErrorType;
 import org.opendaylight.yangtools.yang.common.RpcResult;
 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 // Non-final for testing
-class ServerSessionManager implements PCEPSessionListenerFactory, TopologySessionRPCs, PCEPPeerProposal,
-        TopologySessionStatsRegistry {
+class ServerSessionManager implements PCEPSessionListenerFactory, TopologySessionRPCs {
+    @FunctionalInterface
+    interface RpcTimeout {
+        void run(SrpIdNumber requestId);
+    }
+
     private static final Logger LOG = LoggerFactory.getLogger(ServerSessionManager.class);
     private static final long DEFAULT_HOLD_STATE_NANOS = TimeUnit.MINUTES.toNanos(5);
+    private static final VarHandle CLOSED;
+
+    static {
+        try {
+            CLOSED = MethodHandles.lookup().findVarHandle(ServerSessionManager.class, "closed", boolean.class);
+        } catch (NoSuchFieldException | IllegalAccessException e) {
+            throw new ExceptionInInitializerError(e);
+        }
+    }
+
+    private final @NonNull KeyedInstanceIdentifier<Topology, TopologyKey> topology;
+    private final @NonNull PCEPTopologyProviderDependencies dependencies;
+    private final @Nullable GraphKey graphKey;
 
-    @VisibleForTesting
-    final AtomicBoolean isClosed = new AtomicBoolean(false);
     @GuardedBy("this")
     private final Map<NodeId, TopologySessionListener> nodes = new HashMap<>();
     @GuardedBy("this")
     private final Map<NodeId, TopologyNodeState> state = new HashMap<>();
-    private final InstanceIdentifier<Topology> topology;
-    private final PCEPStatefulPeerProposal peerProposal;
-    private final short rpcTimeout;
-    private final PCEPTopologyProviderDependencies dependenciesProvider;
-    private final PCEPDispatcherDependencies pcepDispatcherDependencies;
-
-    ServerSessionManager(
-            final PCEPTopologyProviderDependencies dependenciesProvider,
-            final PCEPTopologyConfiguration configDependencies) {
-        this.dependenciesProvider = requireNonNull(dependenciesProvider);
-        topology = requireNonNull(configDependencies.getTopology());
-        peerProposal = PCEPStatefulPeerProposal
-                .createStatefulPeerProposal(dependenciesProvider.getDataBroker(), topology);
-        rpcTimeout = configDependencies.getRpcTimeout();
-        pcepDispatcherDependencies = new PCEPDispatcherDependenciesImpl(this, configDependencies);
-    }
 
-    private static NodeId createNodeId(final InetAddress addr) {
-        return new NodeId("pcc://" + addr.getHostAddress());
+    private volatile long updateInterval;
+    private volatile short rpcTimeout;
+    private volatile boolean closed;
+
+    ServerSessionManager(final KeyedInstanceIdentifier<Topology, TopologyKey> topology,
+            final PCEPTopologyProviderDependencies dependencies, final GraphKey graphKey,
+            final short rpcTimeout, final long updateInterval) {
+        this.dependencies = requireNonNull(dependencies);
+        this.topology = requireNonNull(topology);
+        this.graphKey = graphKey;
+        this.rpcTimeout = rpcTimeout;
+        this.updateInterval = updateInterval;
     }
 
-    /**
-     * Create Base Topology.
-     */
-    final synchronized void instantiateServiceInstance() {
-        final TopologyKey key = InstanceIdentifier.keyOf(topology);
-        final TopologyId topologyId = key.getTopologyId();
-        final WriteTransaction tx = dependenciesProvider.getDataBroker().newWriteOnlyTransaction();
-        tx.mergeParentStructurePut(LogicalDatastoreType.OPERATIONAL, topology, new TopologyBuilder()
-            .withKey(key)
-            .setTopologyId(topologyId).setTopologyTypes(new TopologyTypesBuilder()
-                .addAugmentation(new TopologyTypes1Builder()
-                    .setTopologyPcep(new TopologyPcepBuilder().build())
-                    .build())
+    // Initialize the operational view of the topology.
+    final ListenableFuture<Boolean> start() {
+        LOG.info("Creating PCEP Topology {}", topologyId());
+        final var tx = dependencies.getDataBroker().newWriteOnlyTransaction();
+        tx.put(LogicalDatastoreType.OPERATIONAL, topology, new TopologyBuilder()
+            .withKey(topology.getKey())
+            .setTopologyTypes(new TopologyTypesBuilder()
+                .addAugmentation(new TopologyTypes1Builder().setTopologyPcep(new TopologyPcepBuilder().build()).build())
                 .build())
             .build());
-        try {
-            tx.commit().get();
-            LOG.info("PCEP Topology {} created successfully.", topologyId.getValue());
-            ServerSessionManager.this.isClosed.set(false);
-        } catch (final ExecutionException | InterruptedException throwable) {
-            LOG.error("Failed to create PCEP Topology {}.", topologyId.getValue(), throwable);
-            ServerSessionManager.this.isClosed.set(true);
+
+        final var future = SettableFuture.<Boolean>create();
+        final var txFuture = tx.commit();
+        txFuture.addCallback(new FutureCallback<CommitInfo>() {
+            @Override
+            public void onSuccess(final CommitInfo result) {
+                LOG.info("PCEP Topology {} created successfully.", topologyId());
+                closed = false;
+                future.set(Boolean.TRUE);
+            }
+
+            @Override
+            public void onFailure(final Throwable failure) {
+                LOG.error("Failed to create PCEP Topology {}.", topologyId(), failure);
+                closed = true;
+                future.set(Boolean.FALSE);
+            }
+        }, MoreExecutors.directExecutor());
+
+        // Register this new topology to PCE Server
+        final PceServerProvider server = dependencies.getPceServerProvider();
+        if (server != null && graphKey != null) {
+            server.registerPcepTopology(topology, graphKey);
+        }
+        return future;
+    }
+
+    final boolean isClosed() {
+        return closed;
+    }
+
+    final synchronized FluentFuture<? extends CommitInfo> stop() {
+        if (!CLOSED.compareAndSet(this, false, true)) {
+            LOG.error("Session Manager has already been closed.");
+            return CommitInfo.emptyFluentFuture();
+        }
+
+        // Clean up sessions
+        for (final TopologySessionListener node : nodes.values()) {
+            node.close();
+        }
+        nodes.clear();
+
+        // Clean up remembered metadata
+        for (final TopologyNodeState topologyNodeState : state.values()) {
+            topologyNodeState.close();
         }
+        state.clear();
+
+        // Un-Register Pcep Topology into PCE Server
+        final PceServerProvider server = dependencies.getPceServerProvider();
+        if (server != null) {
+            server.unRegisterPcepTopology(topology);
+        }
+
+        final WriteTransaction t = dependencies.getDataBroker().newWriteOnlyTransaction();
+        t.delete(LogicalDatastoreType.OPERATIONAL, topology);
+        final FluentFuture<? extends CommitInfo> future = t.commit();
+        future.addCallback(new FutureCallback<CommitInfo>() {
+            @Override
+            public void onSuccess(final CommitInfo result) {
+                LOG.debug("Topology {} removed", topology);
+            }
+
+            @Override
+            public void onFailure(final Throwable throwable) {
+                LOG.warn("Failed to remove Topology {}", topology, throwable);
+            }
+        }, MoreExecutors.directExecutor());
+        return future;
     }
 
-    final synchronized void releaseNodeState(final TopologyNodeState nodeState, final PCEPSession session,
+    final synchronized void releaseNodeState(final TopologyNodeState nodeState, final InetAddress peerAddress,
             final boolean persistNode) {
-        if (isClosed.get()) {
+        if (isClosed()) {
             LOG.error("Session Manager has already been closed.");
             return;
         }
-        final NodeId nodeId = createNodeId(session.getRemoteAddress());
+        final NodeId nodeId = createNodeId(peerAddress);
         nodes.remove(nodeId);
         state.remove(nodeId);
         if (nodeState != null) {
@@ -135,7 +196,7 @@ class ServerSessionManager implements PCEPSessionListenerFactory, TopologySessio
     final synchronized TopologyNodeState takeNodeState(final InetAddress address,
             final TopologySessionListener sessionListener, final boolean retrieveNode) {
         final NodeId id = createNodeId(address);
-        if (isClosed.get()) {
+        if (isClosed()) {
             LOG.error("Server Session Manager is closed. Unable to create topology node {} with listener {}", id,
                 sessionListener);
             return null;
@@ -145,7 +206,7 @@ class ServerSessionManager implements PCEPSessionListenerFactory, TopologySessio
         TopologyNodeState ret = state.get(id);
 
         if (ret == null) {
-            ret = new TopologyNodeState(dependenciesProvider.getDataBroker(), topology, id, DEFAULT_HOLD_STATE_NANOS);
+            ret = new TopologyNodeState(dependencies.getDataBroker(), topology, id, DEFAULT_HOLD_STATE_NANOS);
             LOG.debug("Created topology node {} for id {} at {}", ret, id, ret.getNodeId());
             state.put(id, ret);
         }
@@ -165,7 +226,8 @@ class ServerSessionManager implements PCEPSessionListenerFactory, TopologySessio
     // Non-final for testing
     @Override
     public PCEPTopologySessionListener getSessionListener() {
-        return new PCEPTopologySessionListener(this);
+        return new PCEPTopologySessionListener(dependencies.getStateRegistry(), this,
+            dependencies.getPceServerProvider());
     }
 
     private synchronized TopologySessionListener checkSessionPresence(final NodeId nodeId) {
@@ -218,68 +280,43 @@ class ServerSessionManager implements PCEPSessionListenerFactory, TopologySessio
         }
 
         return RpcResultBuilder.<Void>failed()
-            .withError(RpcError.ErrorType.RPC, "Failed to find session " + nodeId)
+            .withError(ErrorType.RPC, "Failed to find session " + nodeId)
             .buildFuture();
     }
 
-    final synchronized FluentFuture<? extends CommitInfo> closeServiceInstance() {
-        if (isClosed.getAndSet(true)) {
-            LOG.error("Session Manager has already been closed.");
-            return CommitInfo.emptyFluentFuture();
-        }
-        for (final TopologySessionListener node : nodes.values()) {
-            node.close();
-        }
-        nodes.clear();
-        for (final TopologyNodeState topologyNodeState : state.values()) {
-            topologyNodeState.close();
-        }
-        state.clear();
-
-        final WriteTransaction t = dependenciesProvider.getDataBroker().newWriteOnlyTransaction();
-        t.delete(LogicalDatastoreType.OPERATIONAL, topology);
-        final FluentFuture<? extends CommitInfo> future = t.commit();
-        future.addCallback(new FutureCallback<CommitInfo>() {
-            @Override
-            public void onSuccess(final CommitInfo result) {
-                LOG.debug("Topology {} removed", topology);
-            }
+    final @Nullable Timeout newRpcTimeout(final RpcTimeout task, final SrpIdNumber requestId) {
+        final short localTimeout = rpcTimeout;
+        return localTimeout <= 0 ? null
+            : dependencies.getTimer().newTimeout(ignored -> task.run(requestId), localTimeout, TimeUnit.SECONDS);
+    }
 
-            @Override
-            public void onFailure(final Throwable throwable) {
-                LOG.warn("Failed to remove Topology {}", topology, throwable);
-            }
-        }, MoreExecutors.directExecutor());
-        return future;
+    final long updateInterval() {
+        return isClosed() ? 0 : updateInterval;
     }
 
-    @Override
-    public final void setPeerSpecificProposal(final InetSocketAddress address, final TlvsBuilder openBuilder) {
-        requireNonNull(address);
-        peerProposal.setPeerProposal(createNodeId(address.getAddress()), openBuilder,
-            pcepDispatcherDependencies.getSpeakerIdMapping().speakerIdForAddress(address.getAddress()));
+    final void setRpcTimeout(final short rpcTimeout) {
+        this.rpcTimeout = rpcTimeout;
     }
 
-    final short getRpcTimeout() {
-        return rpcTimeout;
+    final void setUpdateInterval(final long updateInterval) {
+        this.updateInterval = updateInterval;
     }
 
-    @Override
-    public final synchronized void bind(final KeyedInstanceIdentifier<Node, NodeKey> nodeId,
-            final PcepSessionState sessionState) {
-        dependenciesProvider.getStateRegistry().bind(nodeId, sessionState);
+    final void tearDownSessions(final List<InetAddress> outdatedNodes) {
+        for (var address : outdatedNodes) {
+            tearDownSession(new TearDownSessionInputBuilder().setNode(createNodeId(address)).build());
+        }
     }
 
-    @Override
-    public final synchronized void unbind(final KeyedInstanceIdentifier<Node, NodeKey> nodeId) {
-        dependenciesProvider.getStateRegistry().unbind(nodeId);
+    final PCEPTopologyProviderDependencies getPCEPTopologyProviderDependencies() {
+        return dependencies;
     }
 
-    final PCEPDispatcherDependencies getPCEPDispatcherDependencies() {
-        return pcepDispatcherDependencies;
+    static @NonNull NodeId createNodeId(final InetAddress addr) {
+        return new NodeId("pcc://" + addr.getHostAddress());
     }
 
-    final PCEPTopologyProviderDependencies getPCEPTopologyProviderDependencies() {
-        return dependenciesProvider;
+    private @NonNull String topologyId() {
+        return TopologyUtils.friendlyId(topology);
     }
 }
\ No newline at end of file