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