opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/databroker/ClientBackedTransactionChain.java

   1 /*
   2  * Copyright (c) 2016 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.controller.cluster.databroker;
   9
  10 import com.google.common.base.Preconditions;
  11 import java.util.ArrayList;
  12 import java.util.List;
  13 import java.util.Map;
  14 import java.util.WeakHashMap;
  15 import javax.annotation.concurrent.GuardedBy;
  16 import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
  17 import org.opendaylight.controller.cluster.databroker.actors.dds.AbstractClientHandle;
  18 import org.opendaylight.controller.cluster.databroker.actors.dds.ClientLocalHistory;
  19 import org.opendaylight.controller.cluster.databroker.actors.dds.ClientSnapshot;
  20 import org.opendaylight.controller.cluster.databroker.actors.dds.ClientTransaction;
  21 import org.opendaylight.mdsal.dom.spi.store.DOMStoreReadTransaction;
  22 import org.opendaylight.mdsal.dom.spi.store.DOMStoreReadWriteTransaction;
  23 import org.opendaylight.mdsal.dom.spi.store.DOMStoreTransactionChain;
  24 import org.opendaylight.mdsal.dom.spi.store.DOMStoreWriteTransaction;
  25 import org.slf4j.Logger;
  26 import org.slf4j.LoggerFactory;
  27
  28 /**
  29  * An implementation of {@link DOMStoreTransactionChain} backed by a {@link ClientLocalHistory}.
  30  *
  31  * @author Robert Varga
  32  */
  33 final class ClientBackedTransactionChain implements DOMStoreTransactionChain {
  34     private static final Logger LOG = LoggerFactory.getLogger(ClientBackedTransactionChain.class);
  35
  36     @GuardedBy("this")
  37     private final Map<AbstractClientHandle<?>, Boolean> openSnapshots = new WeakHashMap<>();
  38
  39     private final ClientLocalHistory history;
  40     private final boolean debugAllocation;
  41
  42     ClientBackedTransactionChain(final ClientLocalHistory history, final boolean debugAllocation) {
  43         this.history = Preconditions.checkNotNull(history);
  44         this.debugAllocation = debugAllocation;
  45     }
  46
  47     @Override
  48     public DOMStoreReadTransaction newReadOnlyTransaction() {
  49         return new ClientBackedReadTransaction(createSnapshot(), this, allocationContext());
  50     }
  51
  52     @Override
  53     public DOMStoreReadWriteTransaction newReadWriteTransaction() {
  54         return new ClientBackedReadWriteTransaction(createTransaction(), allocationContext());
  55     }
  56
  57     @Override
  58     public DOMStoreWriteTransaction newWriteOnlyTransaction() {
  59         return new ClientBackedWriteTransaction(createTransaction(), allocationContext());
  60     }
  61
  62     @Override
  63     public synchronized void close() {
  64         final List<TransactionIdentifier> abortedSnapshots = new ArrayList<>();
  65         for (AbstractClientHandle<?> snap : openSnapshots.keySet()) {
  66             final TransactionIdentifier id = snap.getIdentifier();
  67             LOG.debug("Aborting recorded transaction {}", id);
  68             if (snap.abort()) {
  69                 abortedSnapshots.add(id);
  70             }
  71         }
  72         openSnapshots.clear();
  73
  74         if (!abortedSnapshots.isEmpty()) {
  75             LOG.warn("Aborted unclosed transactions {}", abortedSnapshots, new Throwable("at"));
  76         }
  77         history.close();
  78     }
  79
  80     synchronized void snapshotClosed(final ClientSnapshot clientTransaction) {
  81         openSnapshots.remove(clientTransaction);
  82     }
  83
  84     private ClientSnapshot createSnapshot() {
  85         return recordSnapshot(history.takeSnapshot());
  86     }
  87
  88     private ClientTransaction createTransaction() {
  89         return recordSnapshot(history.createTransaction());
  90     }
  91
  92     private Throwable allocationContext() {
  93         return debugAllocation ? new Throwable("allocated at") : null;
  94     }
  95
  96     private synchronized <T extends AbstractClientHandle<?>> T recordSnapshot(final T snapshot) {
  97         openSnapshots.put(snapshot, Boolean.TRUE);
  98         return snapshot;
  99     }
 100 }