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.TransactionChain;
  26 import org.opendaylight.mdsal.binding.api.WriteTransaction;
  27 import org.opendaylight.mdsal.common.api.CommitInfo;
  28 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev220730.Node1;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev220730.lsp.metadata.Metadata;
  31 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  32 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
  33 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  34 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeBuilder;
  35 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
  36 import org.opendaylight.yangtools.yang.binding.DataObject;
  37 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  38 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
  39 import org.opendaylight.yangtools.yang.common.Empty;
  40 import org.slf4j.Logger;
  41 import org.slf4j.LoggerFactory;
  42
  43 // This class is thread-safe
  44 final class TopologyNodeState implements FutureCallback<Empty> {
  45     private static final Logger LOG = LoggerFactory.getLogger(TopologyNodeState.class);
  46
  47     private final Map<String, Metadata> metadata = new HashMap<>();
  48     private final KeyedInstanceIdentifier<Node, NodeKey> nodeId;
  49     private final TransactionChain chain;
  50     private final long holdStateNanos;
  51     private long lastReleased = 0;
  52     //cache initial node state, if any node was persisted
  53     @GuardedBy("this")
  54     private Node initialNodeState = null;
  55
  56     TopologyNodeState(final DataBroker broker, final InstanceIdentifier<Topology> topology, final NodeId id,
  57             final long holdStateNanos) {
  58         checkArgument(holdStateNanos >= 0);
  59         nodeId = topology.child(Node.class, new NodeKey(id));
  60         this.holdStateNanos = holdStateNanos;
  61         chain = broker.createMergingTransactionChain();
  62         chain.addCallback(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 onFailure(final Throwable cause) {
 151         // FIXME: flip internal state, so that the next attempt to update fails, triggering node reconnect
 152         LOG.error("Unexpected transaction failure in node {}", nodeId, cause);
 153         close();
 154     }
 155
 156     @Override
 157     public void onSuccess(final Empty result) {
 158         LOG.info("Node {} shutdown successfully", nodeId);
 159     }
 160
 161     synchronized void close() {
 162         chain.close();
 163     }
 164
 165     @Holding("this")
 166     private void putTopologyNode() {
 167         final Node node = new NodeBuilder().withKey(nodeId.getKey()).build();
 168         final WriteTransaction tx = chain.newWriteOnlyTransaction();
 169         LOG.trace("Put topology Node {}, value {}", nodeId, node);
 170         // FIXME: why is this a 'merge' and not a 'put'? This seems to be related to BGPCEP-739, but there is little
 171         //        evidence as to what exactly was being overwritten
 172         tx.merge(LogicalDatastoreType.OPERATIONAL, nodeId, node);
 173         tx.commit().addCallback(new FutureCallback<CommitInfo>() {
 174             @Override
 175             public void onSuccess(final CommitInfo result) {
 176                 LOG.trace("Topology Node stored {}, value {}", nodeId, node);
 177             }
 178
 179             @Override
 180             public void onFailure(final Throwable throwable) {
 181                 LOG.error("Put topology Node failed {}, value {}", nodeId, node, throwable);
 182             }
 183         }, MoreExecutors.directExecutor());
 184     }
 185
 186     @NonNull FluentFuture<? extends @NonNull CommitInfo> storeNode(final InstanceIdentifier<Node1> topologyAugment,
 187             final Node1 ta) {
 188         LOG.trace("Peer data {} set to {}", topologyAugment, ta);
 189         synchronized (this) {
 190             final WriteTransaction trans = chain.newWriteOnlyTransaction();
 191             trans.put(LogicalDatastoreType.OPERATIONAL, topologyAugment, ta);
 192             // All set, commit the modifications
 193             return trans.commit();
 194         }
 195     }
 196 }