pcep/topology/topology-provider/src/main/java/org/opendaylight/bgpcep/pcep/topology/provider/TopologyNodeState.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 com.google.common.base.Preconditions.checkArgument;
  11
  12 import com.google.common.util.concurrent.FluentFuture;
  13 import com.google.common.util.concurrent.FutureCallback;
  14 import com.google.common.util.concurrent.MoreExecutors;
  15 import java.util.Collection;
  16 import java.util.HashMap;
  17 import java.util.Map;
  18 import java.util.Optional;
  19 import java.util.concurrent.ExecutionException;
  20 import org.checkerframework.checker.lock.qual.GuardedBy;
  21 import org.checkerframework.checker.lock.qual.Holding;
  22 import org.eclipse.jdt.annotation.NonNull;
  23 import org.opendaylight.mdsal.binding.api.DataBroker;
  24 import org.opendaylight.mdsal.binding.api.ReadTransaction;
  25 import org.opendaylight.mdsal.binding.api.Transaction;
  26 import org.opendaylight.mdsal.binding.api.TransactionChain;
  27 import org.opendaylight.mdsal.binding.api.TransactionChainListener;
  28 import org.opendaylight.mdsal.binding.api.WriteTransaction;
  29 import org.opendaylight.mdsal.common.api.CommitInfo;
  30 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev220730.Node1;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev220730.lsp.metadata.Metadata;
  33 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  34 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
  35 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  36 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeBuilder;
  37 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
  38 import org.opendaylight.yangtools.yang.binding.DataObject;
  39 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  40 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
  41 import org.slf4j.Logger;
  42 import org.slf4j.LoggerFactory;
  43
  44 // This class is thread-safe
  45 final class TopologyNodeState implements TransactionChainListener {
  46     private static final Logger LOG = LoggerFactory.getLogger(TopologyNodeState.class);
  47
  48     private final Map<String, Metadata> metadata = new HashMap<>();
  49     private final KeyedInstanceIdentifier<Node, NodeKey> nodeId;
  50     private final TransactionChain chain;
  51     private final long holdStateNanos;
  52     private long lastReleased = 0;
  53     //cache initial node state, if any node was persisted
  54     @GuardedBy("this")
  55     private Node initialNodeState = null;
  56
  57     TopologyNodeState(final DataBroker broker, final InstanceIdentifier<Topology> topology, final NodeId id,
  58             final long holdStateNanos) {
  59         checkArgument(holdStateNanos >= 0);
  60         nodeId = topology.child(Node.class, new NodeKey(id));
  61         this.holdStateNanos = holdStateNanos;
  62         chain = broker.createMergingTransactionChain(this);
  63     }
  64
  65     @NonNull KeyedInstanceIdentifier<Node, NodeKey> getNodeId() {
  66         return nodeId;
  67     }
  68
  69     synchronized Metadata getLspMetadata(final String name) {
  70         return metadata.get(name);
  71     }
  72
  73     synchronized void setLspMetadata(final String name, final Metadata value) {
  74         if (value == null) {
  75             metadata.remove(name);
  76         } else {
  77             metadata.put(name, value);
  78         }
  79     }
  80
  81     synchronized void cleanupExcept(final Collection<String> values) {
  82         metadata.keySet().removeIf(s -> !values.contains(s));
  83     }
  84
  85     synchronized void released(final boolean persist) {
  86         // The session went down. Undo all the Topology changes we have done.
  87         // We might want to persist topology node for later re-use.
  88         if (!persist) {
  89             final WriteTransaction trans = chain.newWriteOnlyTransaction();
  90             trans.delete(LogicalDatastoreType.OPERATIONAL, nodeId);
  91             trans.commit().addCallback(new FutureCallback<CommitInfo>() {
  92                 @Override
  93                 public void onSuccess(final CommitInfo result) {
  94                     LOG.trace("Internal state for node {} cleaned up successfully", nodeId);
  95                 }
  96
  97                 @Override
  98                 public void onFailure(final Throwable throwable) {
  99                     LOG.error("Failed to cleanup internal state for session {}", nodeId, throwable);
 100                 }
 101             }, MoreExecutors.directExecutor());
 102         }
 103
 104         close();
 105         lastReleased = System.nanoTime();
 106     }
 107
 108     synchronized void taken(final boolean retrieveNode) {
 109         final long now = System.nanoTime();
 110
 111         if (now - lastReleased > holdStateNanos) {
 112             metadata.clear();
 113         }
 114
 115         //try to get the topology's node
 116         if (retrieveNode) {
 117             try {
 118                 // FIXME: we really should not be performing synchronous operations
 119                 final Optional<Node> prevNode = readOperationalData(nodeId).get();
 120                 if (prevNode.isEmpty()) {
 121                     putTopologyNode();
 122                 } else {
 123                     //cache retrieved node
 124                     initialNodeState = prevNode.orElseThrow();
 125                 }
 126             } catch (final ExecutionException | InterruptedException throwable) {
 127                 LOG.error("Failed to get topology node {}", nodeId, throwable);
 128             }
 129         } else {
 130             putTopologyNode();
 131         }
 132     }
 133
 134     synchronized Node getInitialNodeState() {
 135         return initialNodeState;
 136     }
 137
 138     synchronized TransactionChain getChain() {
 139         return chain;
 140     }
 141
 142     synchronized <T extends DataObject> FluentFuture<Optional<T>> readOperationalData(
 143             final InstanceIdentifier<T> id) {
 144         try (ReadTransaction t = chain.newReadOnlyTransaction()) {
 145             return t.read(LogicalDatastoreType.OPERATIONAL, id);
 146         }
 147     }
 148
 149     @Override
 150     public void onTransactionChainFailed(final TransactionChain pchain, final Transaction transaction,
 151             final Throwable cause) {
 152         // FIXME: flip internal state, so that the next attempt to update fails, triggering node reconnect
 153         LOG.error("Unexpected transaction failure in node {} transaction {}", nodeId, transaction.getIdentifier(),
 154             cause);
 155         close();
 156     }
 157
 158     @Override
 159     public void onTransactionChainSuccessful(final TransactionChain pchain) {
 160         LOG.info("Node {} shutdown successfully", nodeId);
 161     }
 162
 163     synchronized void close() {
 164         chain.close();
 165     }
 166
 167     @Holding("this")
 168     private void putTopologyNode() {
 169         final Node node = new NodeBuilder().withKey(nodeId.getKey()).build();
 170         final WriteTransaction tx = chain.newWriteOnlyTransaction();
 171         LOG.trace("Put topology Node {}, value {}", nodeId, node);
 172         // FIXME: why is this a 'merge' and not a 'put'? This seems to be related to BGPCEP-739, but there is little
 173         //        evidence as to what exactly was being overwritten
 174         tx.merge(LogicalDatastoreType.OPERATIONAL, nodeId, node);
 175         tx.commit().addCallback(new FutureCallback<CommitInfo>() {
 176             @Override
 177             public void onSuccess(final CommitInfo result) {
 178                 LOG.trace("Topology Node stored {}, value {}", nodeId, node);
 179             }
 180
 181             @Override
 182             public void onFailure(final Throwable throwable) {
 183                 LOG.error("Put topology Node failed {}, value {}", nodeId, node, throwable);
 184             }
 185         }, MoreExecutors.directExecutor());
 186     }
 187
 188     @NonNull FluentFuture<? extends @NonNull CommitInfo> storeNode(final InstanceIdentifier<Node1> topologyAugment,
 189             final Node1 ta) {
 190         LOG.trace("Peer data {} set to {}", topologyAugment, ta);
 191         synchronized (this) {
 192             final WriteTransaction trans = chain.newWriteOnlyTransaction();
 193             trans.put(LogicalDatastoreType.OPERATIONAL, topologyAugment, ta);
 194             // All set, commit the modifications
 195             return trans.commit();
 196         }
 197     }
 198 }