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 import akka.serialization.Serialization;
  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 import org.opendaylight.controller.cluster.datastore.exceptions.UnknownMessageException;
  21 import org.opendaylight.controller.cluster.datastore.jmx.mbeans.shard.ShardStats;
  22 import org.opendaylight.controller.cluster.datastore.messages.CloseTransaction;
  23 import org.opendaylight.controller.cluster.datastore.messages.CloseTransactionReply;
  24 import org.opendaylight.controller.cluster.datastore.messages.DataExists;
  25 import org.opendaylight.controller.cluster.datastore.messages.DataExistsReply;
  26 import org.opendaylight.controller.cluster.datastore.messages.DeleteData;
  27 import org.opendaylight.controller.cluster.datastore.messages.DeleteDataReply;
  28 import org.opendaylight.controller.cluster.datastore.messages.MergeData;
  29 import org.opendaylight.controller.cluster.datastore.messages.MergeDataReply;
  30 import org.opendaylight.controller.cluster.datastore.messages.ReadData;
  31 import org.opendaylight.controller.cluster.datastore.messages.ReadDataReply;
  32 import org.opendaylight.controller.cluster.datastore.messages.ReadyTransaction;
  33 import org.opendaylight.controller.cluster.datastore.messages.ReadyTransactionReply;
  34 import org.opendaylight.controller.cluster.datastore.messages.WriteData;
  35 import org.opendaylight.controller.cluster.datastore.messages.WriteDataReply;
  36 import org.opendaylight.controller.cluster.datastore.modification.CompositeModification;
  37 import org.opendaylight.controller.cluster.datastore.modification.DeleteModification;
  38 import org.opendaylight.controller.cluster.datastore.modification.ImmutableCompositeModification;
  39 import org.opendaylight.controller.cluster.datastore.modification.MergeModification;
  40 import org.opendaylight.controller.cluster.datastore.modification.MutableCompositeModification;
  41 import org.opendaylight.controller.cluster.datastore.modification.WriteModification;
  42 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
  43 import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadTransaction;
  44 import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadWriteTransaction;
  45 import org.opendaylight.controller.sal.core.spi.data.DOMStoreThreePhaseCommitCohort;
  46 import org.opendaylight.controller.sal.core.spi.data.DOMStoreTransaction;
  47 import org.opendaylight.controller.sal.core.spi.data.DOMStoreWriteTransaction;
  48 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  49 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  50 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  51
  52 /**
  53  * The ShardTransaction Actor represents a remote transaction
  54  * <p>
  55  * The ShardTransaction Actor delegates all actions to DOMDataReadWriteTransaction
  56  * </p>
  57  * <p>
  58  * Even though the DOMStore and the DOMStoreTransactionChain implement multiple types of transactions
  59  * the ShardTransaction Actor only works with read-write transactions. This is just to keep the logic simple. At this
  60  * time there are no known advantages for creating a read-only or write-only transaction which may change over time
  61  * at which point we can optimize things in the distributed store as well.
  62  * </p>
  63  * <p>
  64  * Handles Messages <br/>
  65  * ---------------- <br/>
  66  * <li> {@link org.opendaylight.controller.cluster.datastore.messages.ReadData}
  67  * <li> {@link org.opendaylight.controller.cluster.datastore.messages.WriteData}
  68  * <li> {@link org.opendaylight.controller.cluster.datastore.messages.MergeData}
  69  * <li> {@link org.opendaylight.controller.cluster.datastore.messages.DeleteData}
  70  * <li> {@link org.opendaylight.controller.cluster.datastore.messages.ReadyTransaction}
  71  * <li> {@link org.opendaylight.controller.cluster.datastore.messages.CloseTransaction}
  72  * </p>
  73  */
  74 public abstract class ShardTransaction extends AbstractUntypedActor {
  75
  76     private final ActorRef shardActor;
  77     protected final SchemaContext schemaContext;
  78     private final ShardStats shardStats;
  79
  80     private final MutableCompositeModification modification = new MutableCompositeModification();
  81
  82     protected ShardTransaction(ActorRef shardActor, SchemaContext schemaContext,
  83             ShardStats shardStats) {
  84         this.shardActor = shardActor;
  85         this.schemaContext = schemaContext;
  86         this.shardStats = shardStats;
  87     }
  88
  89     public static Props props(DOMStoreTransaction transaction, ActorRef shardActor,
  90             SchemaContext schemaContext,DatastoreContext datastoreContext, ShardStats shardStats) {
  91         return Props.create(new ShardTransactionCreator(transaction, shardActor, schemaContext,
  92            datastoreContext, shardStats));
  93     }
  94
  95     protected abstract DOMStoreTransaction getDOMStoreTransaction();
  96
  97     @Override
  98     public void handleReceive(Object message) throws Exception {
  99         if (message.getClass().equals(CloseTransaction.SERIALIZABLE_CLASS)) {
 100             closeTransaction(true);
 101         } else if (message instanceof GetCompositedModification) {
 102             // This is here for testing only
 103             getSender().tell(new GetCompositeModificationReply(
 104                     new ImmutableCompositeModification(modification)), getSelf());
 105         } else if (message instanceof ReceiveTimeout) {
 106             if(LOG.isDebugEnabled()) {
 107                 LOG.debug("Got ReceiveTimeout for inactivity - closing Tx");
 108             }
 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         if(LOG.isDebugEnabled()) {
 167             LOG.debug("writeData at path : " + message.getPath().toString());
 168         }
 169         try {
 170             transaction.write(message.getPath(), message.getData());
 171             getSender().tell(new WriteDataReply().toSerializable(), getSelf());
 172         }catch(Exception e){
 173             getSender().tell(new akka.actor.Status.Failure(e), getSelf());
 174         }
 175     }
 176
 177     protected void mergeData(DOMStoreWriteTransaction transaction, MergeData message) {
 178         modification.addModification(
 179                 new MergeModification(message.getPath(), message.getData(), schemaContext));
 180         if(LOG.isDebugEnabled()) {
 181             LOG.debug("mergeData at path : " + message.getPath().toString());
 182         }
 183         try {
 184             transaction.merge(message.getPath(), message.getData());
 185             getSender().tell(new MergeDataReply().toSerializable(), getSelf());
 186         }catch(Exception e){
 187             getSender().tell(new akka.actor.Status.Failure(e), getSelf());
 188         }
 189     }
 190
 191     protected void deleteData(DOMStoreWriteTransaction transaction, DeleteData message) {
 192         if(LOG.isDebugEnabled()) {
 193             LOG.debug("deleteData at path : " + message.getPath().toString());
 194         }
 195         modification.addModification(new DeleteModification(message.getPath()));
 196         try {
 197             transaction.delete(message.getPath());
 198             getSender().tell(new DeleteDataReply().toSerializable(), getSelf());
 199         }catch(Exception e){
 200             getSender().tell(new akka.actor.Status.Failure(e), getSelf());
 201         }
 202     }
 203
 204     protected void readyTransaction(DOMStoreWriteTransaction transaction, ReadyTransaction message) {
 205         DOMStoreThreePhaseCommitCohort cohort =  transaction.ready();
 206         ActorRef cohortActor = getContext().actorOf(
 207             ThreePhaseCommitCohort.props(cohort, shardActor, modification, shardStats), "cohort");
 208         getSender().tell(new ReadyTransactionReply(
 209             Serialization.serializedActorPath(cohortActor)).toSerializable(), getSelf());
 210
 211     }
 212
 213     private static class ShardTransactionCreator implements Creator<ShardTransaction> {
 214
 215         private static final long serialVersionUID = 1L;
 216
 217         final DOMStoreTransaction transaction;
 218         final ActorRef shardActor;
 219         final SchemaContext schemaContext;
 220         final DatastoreContext datastoreContext;
 221         final ShardStats shardStats;
 222
 223         ShardTransactionCreator(DOMStoreTransaction transaction, ActorRef shardActor,
 224                 SchemaContext schemaContext, DatastoreContext datastoreContext,
 225                 ShardStats shardStats) {
 226             this.transaction = transaction;
 227             this.shardActor = shardActor;
 228             this.shardStats = shardStats;
 229             this.schemaContext = schemaContext;
 230             this.datastoreContext = datastoreContext;
 231         }
 232
 233         @Override
 234         public ShardTransaction create() throws Exception {
 235             ShardTransaction tx;
 236             if(transaction instanceof DOMStoreReadWriteTransaction) {
 237                 tx = new ShardReadWriteTransaction((DOMStoreReadWriteTransaction)transaction,
 238                         shardActor, schemaContext, shardStats);
 239             } else if(transaction instanceof DOMStoreReadTransaction) {
 240                 tx = new ShardReadTransaction((DOMStoreReadTransaction)transaction, shardActor,
 241                         schemaContext, shardStats);
 242             } else {
 243                 tx = new ShardWriteTransaction((DOMStoreWriteTransaction)transaction,
 244                         shardActor, schemaContext, shardStats);
 245             }
 246
 247             tx.getContext().setReceiveTimeout(datastoreContext.getShardTransactionIdleTimeout());
 248             return tx;
 249         }
 250     }
 251
 252     // These classes are in here for test purposes only
 253
 254     static class GetCompositedModification {
 255     }
 256
 257
 258     static class GetCompositeModificationReply {
 259         private final CompositeModification modification;
 260
 261
 262         GetCompositeModificationReply(CompositeModification modification) {
 263             this.modification = modification;
 264         }
 265
 266
 267         public CompositeModification getModification() {
 268             return modification;
 269         }
 270     }
 271 }