opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/ShardManager.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.ActorPath;
  12 import akka.actor.ActorRef;
  13 import akka.actor.Address;
  14 import akka.actor.Props;
  15 import akka.event.Logging;
  16 import akka.event.LoggingAdapter;
  17 import akka.japi.Creator;
  18 import org.opendaylight.controller.cluster.datastore.messages.FindPrimary;
  19 import org.opendaylight.controller.cluster.datastore.messages.PrimaryFound;
  20 import org.opendaylight.controller.cluster.datastore.messages.PrimaryNotFound;
  21 import org.opendaylight.controller.cluster.datastore.messages.UpdateSchemaContext;
  22
  23 import java.util.HashMap;
  24 import java.util.List;
  25 import java.util.Map;
  26
  27 /**
  28  * The ShardManager has the following jobs,
  29  * <p>
  30  * <li> Create all the local shard replicas that belong on this cluster member
  31  * <li> Find the primary replica for any given shard
  32  * <li> Engage in shard replica elections which decide which replica should be the primary
  33  * </p>
  34  * <p/>
  35  * <h3>>Creation of Shard replicas</h3
  36  * <p>
  37  * When the ShardManager is constructed it reads the cluster configuration to find out which shard replicas
  38  * belong on this member. It finds out the name of the current cluster member from the Akka Clustering Service.
  39  * </p>
  40  * <p/>
  41  * <h3> Replica Elections </h3>
  42  * <p/>
  43  * <p>
  44  * The Shard Manager uses multiple cues to initiate election.
  45  * <li> When a member of the cluster dies
  46  * <li> When a local shard replica dies
  47  * <li> When a local shard replica comes alive
  48  * </p>
  49  */
  50 public class ShardManager extends AbstractUntypedActor {
  51
  52     // Stores a mapping between a shard name and the address of the current primary
  53     private final Map<String, Address> shardNameToPrimaryAddress =
  54         new HashMap<>();
  55
  56     // Stores a mapping between a member name and the address of the member
  57     private final Map<String, Address> memberNameToAddress = new HashMap<>();
  58
  59     // Stores a mapping between the shard name and all the members on which a replica of that shard are available
  60     private final Map<String, List<String>> shardNameToMembers =
  61         new HashMap<>();
  62
  63     private final LoggingAdapter log =
  64         Logging.getLogger(getContext().system(), this);
  65
  66
  67     private final Map<String, ActorPath> localShards = new HashMap<>();
  68
  69
  70     private final ClusterWrapper cluster;
  71
  72     /**
  73      * @param type defines the kind of data that goes into shards created by this shard manager. Examples of type would be
  74      *             configuration or operational
  75      */
  76     private ShardManager(String type, ClusterWrapper cluster, Configuration configuration) {
  77         this.cluster = cluster;
  78         String memberName = cluster.getCurrentMemberName();
  79         List<String> memberShardNames =
  80             configuration.getMemberShardNames(memberName);
  81
  82         for(String shardName : memberShardNames){
  83             ActorRef actor = getContext()
  84                 .actorOf(Shard.props(memberName + "-shard-" + shardName + "-" + type),
  85                     memberName + "-shard-" + shardName + "-" + type);
  86             ActorPath path = actor.path();
  87             localShards.put(shardName, path);
  88         }
  89     }
  90
  91     public static Props props(final String type,
  92         final ClusterWrapper cluster,
  93         final Configuration configuration) {
  94         return Props.create(new Creator<ShardManager>() {
  95
  96             @Override
  97             public ShardManager create() throws Exception {
  98                 return new ShardManager(type, cluster, configuration);
  99             }
 100         });
 101     }
 102
 103     @Override
 104     public void handleReceive(Object message) throws Exception {
 105         if (message instanceof FindPrimary) {
 106             FindPrimary msg = ((FindPrimary) message);
 107             String shardName = msg.getShardName();
 108
 109             if (Shard.DEFAULT_NAME.equals(shardName)) {
 110                 ActorPath defaultShardPath = localShards.get(shardName);
 111                 if(defaultShardPath == null){
 112                     throw new IllegalStateException("local default shard not found");
 113                 }
 114                 getSender().tell(new PrimaryFound(defaultShardPath.toString()),
 115                     getSelf());
 116             } else {
 117                 getSender().tell(new PrimaryNotFound(shardName), getSelf());
 118             }
 119         } else if (message instanceof UpdateSchemaContext) {
 120             for(ActorPath path : localShards.values()){
 121                 getContext().system().actorSelection(path)
 122                     .forward(message,
 123                         getContext());
 124             }
 125         }
 126     }
 127
 128
 129 }