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

   1 /*
   2  * Copyright (c) 2016, 2017 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.sharding;
  10
  11 import static akka.actor.ActorRef.noSender;
  12
  13 import akka.actor.ActorRef;
  14 import akka.actor.ActorSystem;
  15 import akka.actor.PoisonPill;
  16 import akka.actor.Props;
  17 import akka.dispatch.Mapper;
  18 import akka.dispatch.OnComplete;
  19 import akka.pattern.Patterns;
  20 import akka.util.Timeout;
  21 import com.google.common.base.Optional;
  22 import com.google.common.base.Preconditions;
  23 import com.google.common.base.Throwables;
  24 import com.google.common.collect.ClassToInstanceMap;
  25 import com.google.common.collect.ForwardingObject;
  26 import com.google.common.collect.ImmutableClassToInstanceMap;
  27 import com.google.common.util.concurrent.FutureCallback;
  28 import com.google.common.util.concurrent.Futures;
  29 import com.google.common.util.concurrent.ListenableFuture;
  30 import com.google.common.util.concurrent.MoreExecutors;
  31 import com.google.common.util.concurrent.SettableFuture;
  32 import com.google.common.util.concurrent.Uninterruptibles;
  33 import java.util.AbstractMap.SimpleEntry;
  34 import java.util.ArrayList;
  35 import java.util.Collection;
  36 import java.util.Collections;
  37 import java.util.EnumMap;
  38 import java.util.HashMap;
  39 import java.util.List;
  40 import java.util.Map;
  41 import java.util.Map.Entry;
  42 import java.util.Set;
  43 import java.util.concurrent.CompletionStage;
  44 import java.util.concurrent.ExecutionException;
  45 import java.util.concurrent.TimeUnit;
  46 import java.util.concurrent.TimeoutException;
  47 import javax.annotation.Nonnull;
  48 import javax.annotation.Nullable;
  49 import javax.annotation.concurrent.GuardedBy;
  50 import org.opendaylight.controller.cluster.ActorSystemProvider;
  51 import org.opendaylight.controller.cluster.access.concepts.MemberName;
  52 import org.opendaylight.controller.cluster.databroker.actors.dds.DataStoreClient;
  53 import org.opendaylight.controller.cluster.databroker.actors.dds.SimpleDataStoreClientActor;
  54 import org.opendaylight.controller.cluster.datastore.AbstractDataStore;
  55 import org.opendaylight.controller.cluster.datastore.Shard;
  56 import org.opendaylight.controller.cluster.datastore.config.Configuration;
  57 import org.opendaylight.controller.cluster.datastore.config.ModuleShardConfiguration;
  58 import org.opendaylight.controller.cluster.datastore.messages.CreateShard;
  59 import org.opendaylight.controller.cluster.datastore.shardstrategy.ModuleShardStrategy;
  60 import org.opendaylight.controller.cluster.datastore.utils.ActorContext;
  61 import org.opendaylight.controller.cluster.datastore.utils.ClusterUtils;
  62 import org.opendaylight.controller.cluster.dom.api.CDSDataTreeProducer;
  63 import org.opendaylight.controller.cluster.dom.api.CDSShardAccess;
  64 import org.opendaylight.controller.cluster.sharding.ShardedDataTreeActor.ShardedDataTreeActorCreator;
  65 import org.opendaylight.controller.cluster.sharding.messages.InitConfigListener;
  66 import org.opendaylight.controller.cluster.sharding.messages.LookupPrefixShard;
  67 import org.opendaylight.controller.cluster.sharding.messages.PrefixShardRemovalLookup;
  68 import org.opendaylight.controller.cluster.sharding.messages.ProducerCreated;
  69 import org.opendaylight.controller.cluster.sharding.messages.ProducerRemoved;
  70 import org.opendaylight.controller.cluster.sharding.messages.StartConfigShardLookup;
  71 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  72 import org.opendaylight.mdsal.dom.api.DOMDataTreeCursorAwareTransaction;
  73 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
  74 import org.opendaylight.mdsal.dom.api.DOMDataTreeListener;
  75 import org.opendaylight.mdsal.dom.api.DOMDataTreeLoopException;
  76 import org.opendaylight.mdsal.dom.api.DOMDataTreeProducer;
  77 import org.opendaylight.mdsal.dom.api.DOMDataTreeProducerException;
  78 import org.opendaylight.mdsal.dom.api.DOMDataTreeService;
  79 import org.opendaylight.mdsal.dom.api.DOMDataTreeServiceExtension;
  80 import org.opendaylight.mdsal.dom.api.DOMDataTreeShard;
  81 import org.opendaylight.mdsal.dom.api.DOMDataTreeShardingConflictException;
  82 import org.opendaylight.mdsal.dom.api.DOMDataTreeShardingService;
  83 import org.opendaylight.mdsal.dom.broker.DOMDataTreeShardRegistration;
  84 import org.opendaylight.mdsal.dom.broker.ShardedDOMDataTree;
  85 import org.opendaylight.mdsal.dom.spi.DOMDataTreePrefixTable;
  86 import org.opendaylight.mdsal.dom.spi.DOMDataTreePrefixTableEntry;
  87 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.clustering.prefix.shard.configuration.rev170110.PrefixShards;
  88 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  89 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  90 import org.slf4j.Logger;
  91 import org.slf4j.LoggerFactory;
  92 import scala.compat.java8.FutureConverters;
  93 import scala.concurrent.Future;
  94 import scala.concurrent.Promise;
  95 import scala.concurrent.duration.FiniteDuration;
  96
  97 /**
  98  * A layer on top of DOMDataTreeService that distributes producer/shard registrations to remote nodes via
  99  * {@link ShardedDataTreeActor}. Also provides QoL method for addition of prefix based clustered shard into the system.
 100  */
 101 public class DistributedShardedDOMDataTree implements DOMDataTreeService, DOMDataTreeShardingService,
 102         DistributedShardFactory {
 103
 104     private static final Logger LOG = LoggerFactory.getLogger(DistributedShardedDOMDataTree.class);
 105
 106     private static final int MAX_ACTOR_CREATION_RETRIES = 100;
 107     private static final int ACTOR_RETRY_DELAY = 100;
 108     private static final TimeUnit ACTOR_RETRY_TIME_UNIT = TimeUnit.MILLISECONDS;
 109     private static final int LOOKUP_TASK_MAX_RETRIES = 100;
 110     static final FiniteDuration SHARD_FUTURE_TIMEOUT_DURATION =
 111             new FiniteDuration(LOOKUP_TASK_MAX_RETRIES * LOOKUP_TASK_MAX_RETRIES * 3, TimeUnit.SECONDS);
 112     static final Timeout SHARD_FUTURE_TIMEOUT = new Timeout(SHARD_FUTURE_TIMEOUT_DURATION);
 113
 114     static final String ACTOR_ID = "ShardedDOMDataTreeFrontend";
 115
 116     private final ShardedDOMDataTree shardedDOMDataTree;
 117     private final ActorSystem actorSystem;
 118     private final AbstractDataStore distributedOperDatastore;
 119     private final AbstractDataStore distributedConfigDatastore;
 120
 121     private final ActorRef shardedDataTreeActor;
 122     private final MemberName memberName;
 123
 124     @GuardedBy("shards")
 125     private final DOMDataTreePrefixTable<DOMDataTreeShardRegistration<DOMDataTreeShard>> shards =
 126             DOMDataTreePrefixTable.create();
 127
 128     private final EnumMap<LogicalDatastoreType, Entry<DataStoreClient, ActorRef>> configurationShardMap =
 129             new EnumMap<>(LogicalDatastoreType.class);
 130
 131     private final EnumMap<LogicalDatastoreType, PrefixedShardConfigWriter> writerMap =
 132             new EnumMap<>(LogicalDatastoreType.class);
 133
 134     private final PrefixedShardConfigUpdateHandler updateHandler;
 135
 136     public DistributedShardedDOMDataTree(final ActorSystemProvider actorSystemProvider,
 137                                          final AbstractDataStore distributedOperDatastore,
 138                                          final AbstractDataStore distributedConfigDatastore) {
 139         this.actorSystem = Preconditions.checkNotNull(actorSystemProvider).getActorSystem();
 140         this.distributedOperDatastore = Preconditions.checkNotNull(distributedOperDatastore);
 141         this.distributedConfigDatastore = Preconditions.checkNotNull(distributedConfigDatastore);
 142         shardedDOMDataTree = new ShardedDOMDataTree();
 143
 144         shardedDataTreeActor = createShardedDataTreeActor(actorSystem,
 145                 new ShardedDataTreeActorCreator()
 146                         .setShardingService(this)
 147                         .setActorSystem(actorSystem)
 148                         .setClusterWrapper(distributedConfigDatastore.getActorContext().getClusterWrapper())
 149                         .setDistributedConfigDatastore(distributedConfigDatastore)
 150                         .setDistributedOperDatastore(distributedOperDatastore)
 151                         .setLookupTaskMaxRetries(LOOKUP_TASK_MAX_RETRIES),
 152                 ACTOR_ID);
 153
 154         this.memberName = distributedConfigDatastore.getActorContext().getCurrentMemberName();
 155
 156         updateHandler = new PrefixedShardConfigUpdateHandler(shardedDataTreeActor,
 157                 distributedConfigDatastore.getActorContext().getCurrentMemberName());
 158
 159         LOG.debug("{} - Starting prefix configuration shards", memberName);
 160         createPrefixConfigShard(distributedConfigDatastore);
 161         createPrefixConfigShard(distributedOperDatastore);
 162     }
 163
 164     private static void createPrefixConfigShard(final AbstractDataStore dataStore) {
 165         Configuration configuration = dataStore.getActorContext().getConfiguration();
 166         Collection<MemberName> memberNames = configuration.getUniqueMemberNamesForAllShards();
 167         CreateShard createShardMessage =
 168                 new CreateShard(new ModuleShardConfiguration(PrefixShards.QNAME.getNamespace(),
 169                         "prefix-shard-configuration", ClusterUtils.PREFIX_CONFIG_SHARD_ID, ModuleShardStrategy.NAME,
 170                         memberNames),
 171                         Shard.builder(), dataStore.getActorContext().getDatastoreContext());
 172
 173         dataStore.getActorContext().getShardManager().tell(createShardMessage, noSender());
 174     }
 175
 176     /**
 177      * This will try to initialize prefix configuration shards upon their
 178      * successful start. We need to create writers to these shards, so we can
 179      * satisfy future {@link #createDistributedShard} and
 180      * {@link #resolveShardAdditions} requests and update prefix configuration
 181      * shards accordingly.
 182      *
 183      * <p>
 184      * We also need to initialize listeners on these shards, so we can react
 185      * on changes made on them by other cluster members or even by ourselves.
 186      *
 187      * <p>
 188      * Finally, we need to be sure that default shards for both operational and
 189      * configuration data stores are up and running and we have distributed
 190      * shards frontend created for them.
 191      *
 192      * <p>
 193      * This is intended to be invoked by blueprint as initialization method.
 194      */
 195     public void init() {
 196         // create our writers to the configuration
 197         try {
 198             LOG.debug("{} - starting config shard lookup.", memberName);
 199
 200             // We have to wait for prefix config shards to be up and running
 201             // so we can create datastore clients for them
 202             handleConfigShardLookup().get(SHARD_FUTURE_TIMEOUT_DURATION.length(), SHARD_FUTURE_TIMEOUT_DURATION.unit());
 203         } catch (InterruptedException | ExecutionException | TimeoutException e) {
 204             throw new IllegalStateException("Prefix config shards not found", e);
 205         }
 206
 207         try {
 208             LOG.debug("{}: Prefix configuration shards ready - creating clients", memberName);
 209             configurationShardMap.put(LogicalDatastoreType.CONFIGURATION,
 210                     createDatastoreClient(ClusterUtils.PREFIX_CONFIG_SHARD_ID,
 211                             distributedConfigDatastore.getActorContext()));
 212         } catch (final DOMDataTreeShardCreationFailedException e) {
 213             throw new IllegalStateException(
 214                     "Unable to create datastoreClient for config DS prefix configuration shard.", e);
 215         }
 216
 217         try {
 218             configurationShardMap.put(LogicalDatastoreType.OPERATIONAL,
 219                     createDatastoreClient(ClusterUtils.PREFIX_CONFIG_SHARD_ID,
 220                             distributedOperDatastore.getActorContext()));
 221
 222         } catch (final DOMDataTreeShardCreationFailedException e) {
 223             throw new IllegalStateException(
 224                         "Unable to create datastoreClient for oper DS prefix configuration shard.", e);
 225         }
 226
 227         writerMap.put(LogicalDatastoreType.CONFIGURATION, new PrefixedShardConfigWriter(
 228                 configurationShardMap.get(LogicalDatastoreType.CONFIGURATION).getKey()));
 229
 230         writerMap.put(LogicalDatastoreType.OPERATIONAL, new PrefixedShardConfigWriter(
 231                 configurationShardMap.get(LogicalDatastoreType.OPERATIONAL).getKey()));
 232
 233         updateHandler.initListener(distributedConfigDatastore, LogicalDatastoreType.CONFIGURATION);
 234         updateHandler.initListener(distributedOperDatastore, LogicalDatastoreType.OPERATIONAL);
 235
 236         distributedConfigDatastore.getActorContext().getShardManager().tell(InitConfigListener.INSTANCE, noSender());
 237         distributedOperDatastore.getActorContext().getShardManager().tell(InitConfigListener.INSTANCE, noSender());
 238
 239
 240         //create shard registration for DEFAULT_SHARD
 241         initDefaultShard(LogicalDatastoreType.CONFIGURATION);
 242         initDefaultShard(LogicalDatastoreType.OPERATIONAL);
 243     }
 244
 245     private ListenableFuture<List<Void>> handleConfigShardLookup() {
 246
 247         final ListenableFuture<Void> configFuture = lookupConfigShard(LogicalDatastoreType.CONFIGURATION);
 248         final ListenableFuture<Void> operFuture = lookupConfigShard(LogicalDatastoreType.OPERATIONAL);
 249
 250         return Futures.allAsList(configFuture, operFuture);
 251     }
 252
 253     private ListenableFuture<Void> lookupConfigShard(final LogicalDatastoreType type) {
 254         final SettableFuture<Void> future = SettableFuture.create();
 255
 256         final Future<Object> ask =
 257                 Patterns.ask(shardedDataTreeActor, new StartConfigShardLookup(type), SHARD_FUTURE_TIMEOUT);
 258
 259         ask.onComplete(new OnComplete<Object>() {
 260             @Override
 261             public void onComplete(final Throwable throwable, final Object result) {
 262                 if (throwable != null) {
 263                     future.setException(throwable);
 264                 } else {
 265                     future.set(null);
 266                 }
 267             }
 268         }, actorSystem.dispatcher());
 269
 270         return future;
 271     }
 272
 273     @Nonnull
 274     @Override
 275     public <T extends DOMDataTreeListener> ListenerRegistration<T> registerListener(
 276             final T listener, final Collection<DOMDataTreeIdentifier> subtrees,
 277             final boolean allowRxMerges, final Collection<DOMDataTreeProducer> producers)
 278             throws DOMDataTreeLoopException {
 279         return shardedDOMDataTree.registerListener(listener, subtrees, allowRxMerges, producers);
 280     }
 281
 282     @Override
 283     public ClassToInstanceMap<DOMDataTreeServiceExtension> getExtensions() {
 284         return ImmutableClassToInstanceMap.of();
 285     }
 286
 287     @Nonnull
 288     @Override
 289     public DOMDataTreeProducer createProducer(@Nonnull final Collection<DOMDataTreeIdentifier> subtrees) {
 290         LOG.debug("{} - Creating producer for {}", memberName, subtrees);
 291         final DOMDataTreeProducer producer = shardedDOMDataTree.createProducer(subtrees);
 292
 293         final Object response = distributedConfigDatastore.getActorContext()
 294                 .executeOperation(shardedDataTreeActor, new ProducerCreated(subtrees));
 295         if (response == null) {
 296             LOG.debug("{} - Received success from remote nodes, creating producer:{}", memberName, subtrees);
 297             return new ProxyProducer(producer, subtrees, shardedDataTreeActor,
 298                     distributedConfigDatastore.getActorContext(), shards);
 299         }
 300
 301         closeProducer(producer);
 302
 303         if (response instanceof Throwable) {
 304             Throwables.throwIfUnchecked((Throwable) response);
 305             throw new RuntimeException((Throwable) response);
 306         }
 307         throw new RuntimeException("Unexpected response to create producer received." + response);
 308     }
 309
 310     @Override
 311     public CompletionStage<DistributedShardRegistration> createDistributedShard(
 312             final DOMDataTreeIdentifier prefix, final Collection<MemberName> replicaMembers)
 313             throws DOMDataTreeShardingConflictException {
 314
 315         synchronized (shards) {
 316             final DOMDataTreePrefixTableEntry<DOMDataTreeShardRegistration<DOMDataTreeShard>> lookup =
 317                     shards.lookup(prefix);
 318             if (lookup != null && lookup.getValue().getPrefix().equals(prefix)) {
 319                 throw new DOMDataTreeShardingConflictException(
 320                         "Prefix " + prefix + " is already occupied by another shard.");
 321             }
 322         }
 323
 324         final PrefixedShardConfigWriter writer = writerMap.get(prefix.getDatastoreType());
 325
 326         final ListenableFuture<Void> writeFuture =
 327                 writer.writeConfig(prefix.getRootIdentifier(), replicaMembers);
 328
 329         final Promise<DistributedShardRegistration> shardRegistrationPromise = akka.dispatch.Futures.promise();
 330         Futures.addCallback(writeFuture, new FutureCallback<Void>() {
 331             @Override
 332             public void onSuccess(@Nullable final Void result) {
 333
 334                 final Future<Object> ask =
 335                         Patterns.ask(shardedDataTreeActor, new LookupPrefixShard(prefix), SHARD_FUTURE_TIMEOUT);
 336
 337                 shardRegistrationPromise.completeWith(ask.transform(
 338                         new Mapper<Object, DistributedShardRegistration>() {
 339                             @Override
 340                             public DistributedShardRegistration apply(final Object parameter) {
 341                                 return new DistributedShardRegistrationImpl(
 342                                         prefix, shardedDataTreeActor, DistributedShardedDOMDataTree.this);
 343                             }
 344                         },
 345                         new Mapper<Throwable, Throwable>() {
 346                             @Override
 347                             public Throwable apply(final Throwable throwable) {
 348                                 return new DOMDataTreeShardCreationFailedException(
 349                                         "Unable to create a cds shard.", throwable);
 350                             }
 351                         }, actorSystem.dispatcher()));
 352             }
 353
 354             @Override
 355             public void onFailure(final Throwable throwable) {
 356                 shardRegistrationPromise.failure(
 357                         new DOMDataTreeShardCreationFailedException("Unable to create a cds shard.", throwable));
 358             }
 359         }, MoreExecutors.directExecutor());
 360
 361         return FutureConverters.toJava(shardRegistrationPromise.future());
 362     }
 363
 364     void resolveShardAdditions(final Set<DOMDataTreeIdentifier> additions) {
 365         LOG.debug("{}: Resolving additions : {}", memberName, additions);
 366         final ArrayList<DOMDataTreeIdentifier> list = new ArrayList<>(additions);
 367         // we need to register the shards from top to bottom, so we need to atleast make sure the ordering reflects that
 368         Collections.sort(list, (o1, o2) -> {
 369             if (o1.getRootIdentifier().getPathArguments().size() < o2.getRootIdentifier().getPathArguments().size()) {
 370                 return -1;
 371             } else if (o1.getRootIdentifier().getPathArguments().size()
 372                     == o2.getRootIdentifier().getPathArguments().size()) {
 373                 return 0;
 374             } else {
 375                 return 1;
 376             }
 377         });
 378         list.forEach(this::createShardFrontend);
 379     }
 380
 381     void resolveShardRemovals(final Set<DOMDataTreeIdentifier> removals) {
 382         LOG.debug("{}: Resolving removals : {}", memberName, removals);
 383
 384         // do we need to go from bottom to top?
 385         removals.forEach(this::despawnShardFrontend);
 386     }
 387
 388     private void createShardFrontend(final DOMDataTreeIdentifier prefix) {
 389         LOG.debug("{}: Creating CDS shard for prefix: {}", memberName, prefix);
 390         final String shardName = ClusterUtils.getCleanShardName(prefix.getRootIdentifier());
 391         final AbstractDataStore distributedDataStore =
 392                 prefix.getDatastoreType().equals(org.opendaylight.mdsal.common.api.LogicalDatastoreType.CONFIGURATION)
 393                         ? distributedConfigDatastore : distributedOperDatastore;
 394
 395         try (DOMDataTreeProducer producer = localCreateProducer(Collections.singletonList(prefix))) {
 396             final Entry<DataStoreClient, ActorRef> entry =
 397                     createDatastoreClient(shardName, distributedDataStore.getActorContext());
 398
 399             final DistributedShardFrontend shard =
 400                     new DistributedShardFrontend(distributedDataStore, entry.getKey(), prefix);
 401
 402             final DOMDataTreeShardRegistration<DOMDataTreeShard> reg =
 403                     shardedDOMDataTree.registerDataTreeShard(prefix, shard, producer);
 404
 405             synchronized (shards) {
 406                 shards.store(prefix, reg);
 407             }
 408
 409         } catch (final DOMDataTreeShardingConflictException e) {
 410             LOG.error("{}: Prefix {} is already occupied by another shard",
 411                     distributedConfigDatastore.getActorContext().getClusterWrapper().getCurrentMemberName(), prefix, e);
 412         } catch (DOMDataTreeProducerException e) {
 413             LOG.error("Unable to close producer", e);
 414         } catch (DOMDataTreeShardCreationFailedException e) {
 415             LOG.error("Unable to create datastore client for shard {}", prefix, e);
 416         }
 417     }
 418
 419     private void despawnShardFrontend(final DOMDataTreeIdentifier prefix) {
 420         LOG.debug("{}: Removing CDS shard for prefix: {}", memberName, prefix);
 421         final DOMDataTreePrefixTableEntry<DOMDataTreeShardRegistration<DOMDataTreeShard>> lookup;
 422         synchronized (shards) {
 423             lookup = shards.lookup(prefix);
 424         }
 425
 426         if (lookup == null || !lookup.getValue().getPrefix().equals(prefix)) {
 427             LOG.debug("{}: Received despawn for non-existing CDS shard frontend, prefix: {}, ignoring..",
 428                     memberName, prefix);
 429             return;
 430         }
 431
 432         lookup.getValue().close();
 433         // need to remove from our local table thats used for tracking
 434         synchronized (shards) {
 435             shards.remove(prefix);
 436         }
 437
 438         final PrefixedShardConfigWriter writer = writerMap.get(prefix.getDatastoreType());
 439         final ListenableFuture<Void> future = writer.removeConfig(prefix.getRootIdentifier());
 440
 441         Futures.addCallback(future, new FutureCallback<Void>() {
 442             @Override
 443             public void onSuccess(@Nullable final Void result) {
 444                 LOG.debug("{} - Succesfuly removed shard for {}", memberName, prefix);
 445             }
 446
 447             @Override
 448             public void onFailure(final Throwable throwable) {
 449                 LOG.error("Removal of shard {} from configuration failed.", prefix, throwable);
 450             }
 451         }, MoreExecutors.directExecutor());
 452     }
 453
 454     DOMDataTreePrefixTableEntry<DOMDataTreeShardRegistration<DOMDataTreeShard>> lookupShardFrontend(
 455             final DOMDataTreeIdentifier prefix) {
 456         synchronized (shards) {
 457             return shards.lookup(prefix);
 458         }
 459     }
 460
 461     DOMDataTreeProducer localCreateProducer(final Collection<DOMDataTreeIdentifier> prefix) {
 462         return shardedDOMDataTree.createProducer(prefix);
 463     }
 464
 465     @Nonnull
 466     @Override
 467     public <T extends DOMDataTreeShard> ListenerRegistration<T> registerDataTreeShard(
 468             @Nonnull final DOMDataTreeIdentifier prefix,
 469             @Nonnull final T shard,
 470             @Nonnull final DOMDataTreeProducer producer)
 471             throws DOMDataTreeShardingConflictException {
 472
 473         LOG.debug("Registering shard[{}] at prefix: {}", shard, prefix);
 474
 475         if (producer instanceof ProxyProducer) {
 476             return shardedDOMDataTree.registerDataTreeShard(prefix, shard, ((ProxyProducer) producer).delegate());
 477         }
 478
 479         return shardedDOMDataTree.registerDataTreeShard(prefix, shard, producer);
 480     }
 481
 482     @SuppressWarnings("checkstyle:IllegalCatch")
 483     private Entry<DataStoreClient, ActorRef> createDatastoreClient(
 484             final String shardName, final ActorContext actorContext)
 485             throws DOMDataTreeShardCreationFailedException {
 486
 487         LOG.debug("{}: Creating distributed datastore client for shard {}", memberName, shardName);
 488         final Props distributedDataStoreClientProps =
 489                 SimpleDataStoreClientActor.props(memberName, "Shard-" + shardName, actorContext, shardName);
 490
 491         final ActorRef clientActor = actorSystem.actorOf(distributedDataStoreClientProps);
 492         try {
 493             return new SimpleEntry<>(SimpleDataStoreClientActor
 494                     .getDistributedDataStoreClient(clientActor, 30, TimeUnit.SECONDS), clientActor);
 495         } catch (final Exception e) {
 496             LOG.error("{}: Failed to get actor for {}", distributedDataStoreClientProps, memberName, e);
 497             clientActor.tell(PoisonPill.getInstance(), noSender());
 498             throw new DOMDataTreeShardCreationFailedException(
 499                     "Unable to create datastore client for shard{" + shardName + "}", e);
 500         }
 501     }
 502
 503     @SuppressWarnings("checkstyle:IllegalCatch")
 504     private void initDefaultShard(final LogicalDatastoreType logicalDatastoreType) {
 505
 506         final PrefixedShardConfigWriter writer = writerMap.get(logicalDatastoreType);
 507
 508         if (writer.checkDefaultIsPresent()) {
 509             LOG.debug("{}: Default shard for {} is already present in the config. Possibly saved in snapshot.",
 510                     memberName, logicalDatastoreType);
 511         } else {
 512             try {
 513                 // Currently the default shard configuration is present in the out-of-box modules.conf and is
 514                 // expected to be present. So look up the local default shard here and create the frontend.
 515
 516                 // TODO we don't have to do it for config and operational default shard separately. Just one of them
 517                 // should be enough
 518                 final ActorContext actorContext = logicalDatastoreType == LogicalDatastoreType.CONFIGURATION
 519                         ? distributedConfigDatastore.getActorContext() : distributedOperDatastore.getActorContext();
 520
 521                 final Optional<ActorRef> defaultLocalShardOptional =
 522                         actorContext.findLocalShard(ClusterUtils.getCleanShardName(YangInstanceIdentifier.EMPTY));
 523
 524                 if (defaultLocalShardOptional.isPresent()) {
 525                     LOG.debug("{}: Default shard for {} is already started, creating just frontend", memberName,
 526                             logicalDatastoreType);
 527                     createShardFrontend(new DOMDataTreeIdentifier(logicalDatastoreType, YangInstanceIdentifier.EMPTY));
 528                 }
 529
 530                 // The local shard isn't present - we assume that means the local member isn't in the replica list
 531                 // and will be dynamically created later via an explicit add-shard-replica request. This is the
 532                 // bootstrapping mechanism to add a new node into an existing cluster. The following code to create
 533                 // the default shard as a prefix shard is problematic in this scenario so it is commented out. Since
 534                 // the default shard is a module-based shard by default, it makes sense to always treat it as such,
 535                 // ie bootstrap it in the same manner as the special prefix-configuration and EOS shards.
 536 //                final Collection<MemberName> names = distributedConfigDatastore.getActorContext().getConfiguration()
 537 //                        .getUniqueMemberNamesForAllShards();
 538 //                Await.result(FutureConverters.toScala(createDistributedShard(
 539 //                        new DOMDataTreeIdentifier(logicalDatastoreType, YangInstanceIdentifier.EMPTY), names)),
 540 //                        SHARD_FUTURE_TIMEOUT_DURATION);
 541 //            } catch (DOMDataTreeShardingConflictException e) {
 542 //                LOG.debug("{}: Default shard for {} already registered, possibly due to other node doing it faster",
 543 //                        memberName, logicalDatastoreType);
 544             } catch (Exception e) {
 545                 LOG.error("{}: Default shard initialization for {} failed", memberName, logicalDatastoreType, e);
 546                 throw new RuntimeException(e);
 547             }
 548         }
 549     }
 550
 551     private static void closeProducer(final DOMDataTreeProducer producer) {
 552         try {
 553             producer.close();
 554         } catch (final DOMDataTreeProducerException e) {
 555             LOG.error("Unable to close producer", e);
 556         }
 557     }
 558
 559     @SuppressWarnings("checkstyle:IllegalCatch")
 560     private static ActorRef createShardedDataTreeActor(final ActorSystem actorSystem,
 561                                                        final ShardedDataTreeActorCreator creator,
 562                                                        final String shardDataTreeActorId) {
 563         Exception lastException = null;
 564
 565         for (int i = 0; i < MAX_ACTOR_CREATION_RETRIES; i++) {
 566             try {
 567                 return actorSystem.actorOf(creator.props(), shardDataTreeActorId);
 568             } catch (final Exception e) {
 569                 lastException = e;
 570                 Uninterruptibles.sleepUninterruptibly(ACTOR_RETRY_DELAY, ACTOR_RETRY_TIME_UNIT);
 571                 LOG.debug("Could not create actor {} because of {} -"
 572                                 + " waiting for sometime before retrying (retry count = {})",
 573                         shardDataTreeActorId, e.getMessage(), i);
 574             }
 575         }
 576
 577         throw new IllegalStateException("Failed to create actor for ShardedDOMDataTree", lastException);
 578     }
 579
 580     private class DistributedShardRegistrationImpl implements DistributedShardRegistration {
 581
 582         private final DOMDataTreeIdentifier prefix;
 583         private final ActorRef shardedDataTreeActor;
 584         private final DistributedShardedDOMDataTree distributedShardedDOMDataTree;
 585
 586         DistributedShardRegistrationImpl(final DOMDataTreeIdentifier prefix,
 587                                          final ActorRef shardedDataTreeActor,
 588                                          final DistributedShardedDOMDataTree distributedShardedDOMDataTree) {
 589             this.prefix = prefix;
 590             this.shardedDataTreeActor = shardedDataTreeActor;
 591             this.distributedShardedDOMDataTree = distributedShardedDOMDataTree;
 592         }
 593
 594         @Override
 595         public CompletionStage<Void> close() {
 596             // first despawn on the local node
 597             distributedShardedDOMDataTree.despawnShardFrontend(prefix);
 598             // update the config so the remote nodes are updated
 599             final Future<Object> ask =
 600                     Patterns.ask(shardedDataTreeActor, new PrefixShardRemovalLookup(prefix), SHARD_FUTURE_TIMEOUT);
 601
 602             final Future<Void> closeFuture = ask.transform(
 603                     new Mapper<Object, Void>() {
 604                         @Override
 605                         public Void apply(final Object parameter) {
 606                             return null;
 607                         }
 608                     },
 609                     new Mapper<Throwable, Throwable>() {
 610                         @Override
 611                         public Throwable apply(final Throwable throwable) {
 612                             return throwable;
 613                         }
 614                     }, actorSystem.dispatcher());
 615
 616             return FutureConverters.toJava(closeFuture);
 617         }
 618     }
 619
 620     // TODO what about producers created by this producer?
 621     // They should also be CDSProducers
 622     private static final class ProxyProducer extends ForwardingObject implements CDSDataTreeProducer {
 623
 624         private final DOMDataTreeProducer delegate;
 625         private final Collection<DOMDataTreeIdentifier> subtrees;
 626         private final ActorRef shardDataTreeActor;
 627         private final ActorContext actorContext;
 628         @GuardedBy("shardAccessMap")
 629         private final Map<DOMDataTreeIdentifier, CDSShardAccessImpl> shardAccessMap = new HashMap<>();
 630
 631         // We don't have to guard access to shardTable in ProxyProducer.
 632         // ShardTable's entries relevant to this ProxyProducer shouldn't
 633         // change during producer's lifetime.
 634         private final DOMDataTreePrefixTable<DOMDataTreeShardRegistration<DOMDataTreeShard>> shardTable;
 635
 636         ProxyProducer(final DOMDataTreeProducer delegate,
 637                       final Collection<DOMDataTreeIdentifier> subtrees,
 638                       final ActorRef shardDataTreeActor,
 639                       final ActorContext actorContext,
 640                       final DOMDataTreePrefixTable<DOMDataTreeShardRegistration<DOMDataTreeShard>> shardLayout) {
 641             this.delegate = Preconditions.checkNotNull(delegate);
 642             this.subtrees = Preconditions.checkNotNull(subtrees);
 643             this.shardDataTreeActor = Preconditions.checkNotNull(shardDataTreeActor);
 644             this.actorContext = Preconditions.checkNotNull(actorContext);
 645             this.shardTable = Preconditions.checkNotNull(shardLayout);
 646         }
 647
 648         @Nonnull
 649         @Override
 650         public DOMDataTreeCursorAwareTransaction createTransaction(final boolean isolated) {
 651             return delegate.createTransaction(isolated);
 652         }
 653
 654         @Nonnull
 655         @Override
 656         @SuppressWarnings("checkstyle:hiddenField")
 657         public DOMDataTreeProducer createProducer(@Nonnull final Collection<DOMDataTreeIdentifier> subtrees) {
 658             // TODO we probably don't need to distribute this on the remote nodes since once we have this producer
 659             // open we surely have the rights to all the subtrees.
 660             return delegate.createProducer(subtrees);
 661         }
 662
 663         @Override
 664         @SuppressWarnings("checkstyle:IllegalCatch")
 665         public void close() throws DOMDataTreeProducerException {
 666             delegate.close();
 667
 668             synchronized (shardAccessMap) {
 669                 shardAccessMap.values().forEach(CDSShardAccessImpl::close);
 670             }
 671
 672             final Object o = actorContext.executeOperation(shardDataTreeActor, new ProducerRemoved(subtrees));
 673             if (o instanceof DOMDataTreeProducerException) {
 674                 throw (DOMDataTreeProducerException) o;
 675             } else if (o instanceof Throwable) {
 676                 throw new DOMDataTreeProducerException("Unable to close producer", (Throwable) o);
 677             }
 678         }
 679
 680         @Override
 681         protected DOMDataTreeProducer delegate() {
 682             return delegate;
 683         }
 684
 685         @Nonnull
 686         @Override
 687         public CDSShardAccess getShardAccess(@Nonnull final DOMDataTreeIdentifier subtree) {
 688             Preconditions.checkArgument(
 689                     subtrees.stream().anyMatch(dataTreeIdentifier -> dataTreeIdentifier.contains(subtree)),
 690                     "Subtree %s is not controlled by this producer %s", subtree, this);
 691
 692             final DOMDataTreePrefixTableEntry<DOMDataTreeShardRegistration<DOMDataTreeShard>> lookup =
 693                     shardTable.lookup(subtree);
 694             Preconditions.checkState(lookup != null, "Subtree %s is not contained in any registered shard.", subtree);
 695
 696             final DOMDataTreeIdentifier lookupId = lookup.getValue().getPrefix();
 697
 698             synchronized (shardAccessMap) {
 699                 if (shardAccessMap.get(lookupId) != null) {
 700                     return shardAccessMap.get(lookupId);
 701                 }
 702
 703                 // TODO Maybe we can have static factory method and return the same instance
 704                 // for same subtrees. But maybe it is not needed since there can be only one
 705                 // producer attached to some subtree at a time. And also how we can close ShardAccess
 706                 // then
 707                 final CDSShardAccessImpl shardAccess = new CDSShardAccessImpl(lookupId, actorContext);
 708                 shardAccessMap.put(lookupId, shardAccess);
 709                 return shardAccess;
 710             }
 711         }
 712     }
 713 }