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

   1 /*
   2  * Copyright (c) 2014 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
   9 package org.opendaylight.controller.cluster.datastore;
  10
  11 import akka.actor.ActorRef;
  12 import akka.actor.PoisonPill;
  13 import akka.actor.Props;
  14 import akka.actor.ReceiveTimeout;
  15 import akka.japi.Creator;
  16
  17 import com.google.common.base.Optional;
  18 import com.google.common.util.concurrent.CheckedFuture;
  19 import org.opendaylight.controller.cluster.common.actor.AbstractUntypedActor;
  20
  21
  22 import org.opendaylight.controller.cluster.datastore.exceptions.UnknownMessageException;
  23 import org.opendaylight.controller.cluster.datastore.jmx.mbeans.shard.ShardStats;
  24 import org.opendaylight.controller.cluster.datastore.messages.CloseTransaction;
  25 import org.opendaylight.controller.cluster.datastore.messages.CloseTransactionReply;
  26 import org.opendaylight.controller.cluster.datastore.messages.DataExists;
  27 import org.opendaylight.controller.cluster.datastore.messages.DataExistsReply;
  28 import org.opendaylight.controller.cluster.datastore.messages.DeleteData;
  29 import org.opendaylight.controller.cluster.datastore.messages.DeleteDataReply;
  30 import org.opendaylight.controller.cluster.datastore.messages.MergeData;
  31 import org.opendaylight.controller.cluster.datastore.messages.MergeDataReply;
  32 import org.opendaylight.controller.cluster.datastore.messages.ReadData;
  33 import org.opendaylight.controller.cluster.datastore.messages.ReadDataReply;
  34 import org.opendaylight.controller.cluster.datastore.messages.ReadyTransaction;
  35 import org.opendaylight.controller.cluster.datastore.messages.ReadyTransactionReply;
  36 import org.opendaylight.controller.cluster.datastore.messages.WriteData;
  37 import org.opendaylight.controller.cluster.datastore.messages.WriteDataReply;
  38 import org.opendaylight.controller.cluster.datastore.modification.CompositeModification;
  39 import org.opendaylight.controller.cluster.datastore.modification.DeleteModification;
  40 import org.opendaylight.controller.cluster.datastore.modification.ImmutableCompositeModification;
  41 import org.opendaylight.controller.cluster.datastore.modification.MergeModification;
  42 import org.opendaylight.controller.cluster.datastore.modification.MutableCompositeModification;
  43 import org.opendaylight.controller.cluster.datastore.modification.WriteModification;
  44 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
  45 import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadTransaction;
  46 import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadWriteTransaction;
  47 import org.opendaylight.controller.sal.core.spi.data.DOMStoreThreePhaseCommitCohort;
  48 import org.opendaylight.controller.sal.core.spi.data.DOMStoreTransaction;
  49 import org.opendaylight.controller.sal.core.spi.data.DOMStoreWriteTransaction;
  50 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  51 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  52 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  53
  54 /**
  55  * The ShardTransaction Actor represents a remote transaction
  56  * <p>
  57  * The ShardTransaction Actor delegates all actions to DOMDataReadWriteTransaction
  58  * </p>
  59  * <p>
  60  * Even though the DOMStore and the DOMStoreTransactionChain implement multiple types of transactions
  61  * the ShardTransaction Actor only works with read-write transactions. This is just to keep the logic simple. At this
  62  * time there are no known advantages for creating a read-only or write-only transaction which may change over time
  63  * at which point we can optimize things in the distributed store as well.
  64  * </p>
  65  * <p>
  66  * Handles Messages <br/>
  67  * ---------------- <br/>
  68  * <li> {@link org.opendaylight.controller.cluster.datastore.messages.ReadData}
  69  * <li> {@link org.opendaylight.controller.cluster.datastore.messages.WriteData}
  70  * <li> {@link org.opendaylight.controller.cluster.datastore.messages.MergeData}
  71  * <li> {@link org.opendaylight.controller.cluster.datastore.messages.DeleteData}
  72  * <li> {@link org.opendaylight.controller.cluster.datastore.messages.ReadyTransaction}
  73  * <li> {@link org.opendaylight.controller.cluster.datastore.messages.CloseTransaction}
  74  * </p>
  75  */
  76 public abstract class ShardTransaction extends AbstractUntypedActor {
  77
  78     private final ActorRef shardActor;
  79     protected final SchemaContext schemaContext;
  80     private final ShardStats shardStats;
  81
  82     private final MutableCompositeModification modification = new MutableCompositeModification();
  83
  84     protected ShardTransaction(ActorRef shardActor, SchemaContext schemaContext,
  85             ShardStats shardStats) {
  86         this.shardActor = shardActor;
  87         this.schemaContext = schemaContext;
  88         this.shardStats = shardStats;
  89     }
  90
  91     public static Props props(DOMStoreTransaction transaction, ActorRef shardActor,
  92             SchemaContext schemaContext,DatastoreContext datastoreContext, ShardStats shardStats) {
  93         return Props.create(new ShardTransactionCreator(transaction, shardActor, schemaContext,
  94            datastoreContext, shardStats));
  95     }
  96
  97     protected abstract DOMStoreTransaction getDOMStoreTransaction();
  98
  99     @Override
 100     public void handleReceive(Object message) throws Exception {
 101         if (message.getClass().equals(CloseTransaction.SERIALIZABLE_CLASS)) {
 102             closeTransaction(true);
 103         } else if (message instanceof GetCompositedModification) {
 104             // This is here for testing only
 105             getSender().tell(new GetCompositeModificationReply(
 106                     new ImmutableCompositeModification(modification)), getSelf());
 107         } else if (message instanceof ReceiveTimeout) {
 108             LOG.debug("Got ReceiveTimeout for inactivity - closing Tx");
 109             closeTransaction(false);
 110         } else {
 111             throw new UnknownMessageException(message);
 112         }
 113     }
 114
 115     private void closeTransaction(boolean sendReply) {
 116         getDOMStoreTransaction().close();
 117
 118         if(sendReply) {
 119             getSender().tell(new CloseTransactionReply().toSerializable(), getSelf());
 120         }
 121
 122         getSelf().tell(PoisonPill.getInstance(), getSelf());
 123     }
 124
 125     protected void readData(DOMStoreReadTransaction transaction,ReadData message) {
 126         final ActorRef sender = getSender();
 127         final ActorRef self = getSelf();
 128         final YangInstanceIdentifier path = message.getPath();
 129         final CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException> future =
 130                 transaction.read(path);
 131
 132         future.addListener(new Runnable() {
 133             @Override
 134             public void run() {
 135                 try {
 136                     Optional<NormalizedNode<?, ?>> optional = future.checkedGet();
 137                     if (optional.isPresent()) {
 138                         sender.tell(new ReadDataReply(schemaContext,optional.get()).toSerializable(), self);
 139                     } else {
 140                         sender.tell(new ReadDataReply(schemaContext,null).toSerializable(), self);
 141                     }
 142                 } catch (Exception e) {
 143                     shardStats.incrementFailedReadTransactionsCount();
 144                     sender.tell(new akka.actor.Status.Failure(e), self);
 145                 }
 146
 147             }
 148         }, getContext().dispatcher());
 149     }
 150
 151     protected void dataExists(DOMStoreReadTransaction transaction, DataExists message) {
 152         final YangInstanceIdentifier path = message.getPath();
 153
 154         try {
 155             Boolean exists = transaction.exists(path).checkedGet();
 156             getSender().tell(new DataExistsReply(exists).toSerializable(), getSelf());
 157         } catch (ReadFailedException e) {
 158             getSender().tell(new akka.actor.Status.Failure(e),getSelf());
 159         }
 160
 161     }
 162
 163     protected void writeData(DOMStoreWriteTransaction transaction, WriteData message) {
 164         modification.addModification(
 165                 new WriteModification(message.getPath(), message.getData(),schemaContext));
 166         LOG.debug("writeData at path : " + message.getPath().toString());
 167
 168         try {
 169             transaction.write(message.getPath(), message.getData());
 170             getSender().tell(new WriteDataReply().toSerializable(), getSelf());
 171         }catch(Exception e){
 172             getSender().tell(new akka.actor.Status.Failure(e), getSelf());
 173         }
 174     }
 175
 176     protected void mergeData(DOMStoreWriteTransaction transaction, MergeData message) {
 177         modification.addModification(
 178                 new MergeModification(message.getPath(), message.getData(), schemaContext));
 179         LOG.debug("mergeData at path : " + message.getPath().toString());
 180         try {
 181             transaction.merge(message.getPath(), message.getData());
 182             getSender().tell(new MergeDataReply().toSerializable(), getSelf());
 183         }catch(Exception e){
 184             getSender().tell(new akka.actor.Status.Failure(e), getSelf());
 185         }
 186     }
 187
 188     protected void deleteData(DOMStoreWriteTransaction transaction, DeleteData message) {
 189         LOG.debug("deleteData at path : " + message.getPath().toString());
 190         modification.addModification(new DeleteModification(message.getPath()));
 191         try {
 192             transaction.delete(message.getPath());
 193             getSender().tell(new DeleteDataReply().toSerializable(), getSelf());
 194         }catch(Exception e){
 195             getSender().tell(new akka.actor.Status.Failure(e), getSelf());
 196         }
 197     }
 198
 199     protected void readyTransaction(DOMStoreWriteTransaction transaction, ReadyTransaction message) {
 200         DOMStoreThreePhaseCommitCohort cohort =  transaction.ready();
 201         ActorRef cohortActor = getContext().actorOf(
 202             ThreePhaseCommitCohort.props(cohort, shardActor, modification, shardStats), "cohort");
 203         getSender()
 204         .tell(new ReadyTransactionReply(cohortActor.path()).toSerializable(), getSelf());
 205
 206     }
 207
 208     private static class ShardTransactionCreator implements Creator<ShardTransaction> {
 209
 210         private static final long serialVersionUID = 1L;
 211
 212         final DOMStoreTransaction transaction;
 213         final ActorRef shardActor;
 214         final SchemaContext schemaContext;
 215         final DatastoreContext datastoreContext;
 216         final ShardStats shardStats;
 217
 218         ShardTransactionCreator(DOMStoreTransaction transaction, ActorRef shardActor,
 219                 SchemaContext schemaContext, DatastoreContext datastoreContext,
 220                 ShardStats shardStats) {
 221             this.transaction = transaction;
 222             this.shardActor = shardActor;
 223             this.shardStats = shardStats;
 224             this.schemaContext = schemaContext;
 225             this.datastoreContext = datastoreContext;
 226         }
 227
 228         @Override
 229         public ShardTransaction create() throws Exception {
 230             ShardTransaction tx;
 231             if(transaction instanceof DOMStoreReadWriteTransaction) {
 232                 tx = new ShardReadWriteTransaction((DOMStoreReadWriteTransaction)transaction,
 233                         shardActor, schemaContext, shardStats);
 234             } else if(transaction instanceof DOMStoreReadTransaction) {
 235                 tx = new ShardReadTransaction((DOMStoreReadTransaction)transaction, shardActor,
 236                         schemaContext, shardStats);
 237             } else {
 238                 tx = new ShardWriteTransaction((DOMStoreWriteTransaction)transaction,
 239                         shardActor, schemaContext, shardStats);
 240             }
 241
 242             tx.getContext().setReceiveTimeout(datastoreContext.getShardTransactionIdleTimeout());
 243             return tx;
 244         }
 245     }
 246
 247     // These classes are in here for test purposes only
 248
 249     static class GetCompositedModification {
 250     }
 251
 252
 253     static class GetCompositeModificationReply {
 254         private final CompositeModification modification;
 255
 256
 257         GetCompositeModificationReply(CompositeModification modification) {
 258             this.modification = modification;
 259         }
 260
 261
 262         public CompositeModification getModification() {
 263             return modification;
 264         }
 265     }
 266 }