f5baf699c8afdacac163fa65c66e15d6e631584b
[controller.git] / 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.Cancellable;
15 import akka.actor.OneForOneStrategy;
16 import akka.actor.Props;
17 import akka.actor.SupervisorStrategy;
18 import akka.cluster.ClusterEvent;
19 import akka.japi.Creator;
20 import akka.japi.Function;
21 import akka.japi.Procedure;
22 import akka.persistence.RecoveryCompleted;
23 import akka.persistence.RecoveryFailure;
24 import akka.serialization.Serialization;
25 import com.google.common.annotations.VisibleForTesting;
26 import com.google.common.base.Objects;
27 import com.google.common.base.Preconditions;
28 import com.google.common.base.Strings;
29 import com.google.common.base.Supplier;
30 import com.google.common.collect.ImmutableSet;
31 import com.google.common.collect.Sets;
32 import java.io.Serializable;
33 import java.util.ArrayList;
34 import java.util.Collection;
35 import java.util.Collections;
36 import java.util.HashMap;
37 import java.util.HashSet;
38 import java.util.Iterator;
39 import java.util.List;
40 import java.util.Map;
41 import java.util.Set;
42 import java.util.concurrent.CountDownLatch;
43 import org.opendaylight.controller.cluster.DataPersistenceProvider;
44 import org.opendaylight.controller.cluster.NonPersistentDataProvider;
45 import org.opendaylight.controller.cluster.PersistentDataProvider;
46 import org.opendaylight.controller.cluster.common.actor.AbstractUntypedPersistentActorWithMetering;
47 import org.opendaylight.controller.cluster.datastore.exceptions.NoShardLeaderException;
48 import org.opendaylight.controller.cluster.datastore.exceptions.NotInitializedException;
49 import org.opendaylight.controller.cluster.datastore.exceptions.PrimaryNotFoundException;
50 import org.opendaylight.controller.cluster.datastore.identifiers.ShardIdentifier;
51 import org.opendaylight.controller.cluster.datastore.identifiers.ShardManagerIdentifier;
52 import org.opendaylight.controller.cluster.datastore.jmx.mbeans.shardmanager.ShardManagerInfo;
53 import org.opendaylight.controller.cluster.datastore.jmx.mbeans.shardmanager.ShardManagerInfoMBean;
54 import org.opendaylight.controller.cluster.datastore.messages.ActorInitialized;
55 import org.opendaylight.controller.cluster.datastore.messages.FindLocalShard;
56 import org.opendaylight.controller.cluster.datastore.messages.FindPrimary;
57 import org.opendaylight.controller.cluster.datastore.messages.LocalShardFound;
58 import org.opendaylight.controller.cluster.datastore.messages.LocalShardNotFound;
59 import org.opendaylight.controller.cluster.datastore.messages.PeerAddressResolved;
60 import org.opendaylight.controller.cluster.datastore.messages.PrimaryFound;
61 import org.opendaylight.controller.cluster.datastore.messages.UpdateSchemaContext;
62 import org.opendaylight.controller.cluster.datastore.utils.Dispatchers;
63 import org.opendaylight.controller.cluster.notifications.LeaderStateChanged;
64 import org.opendaylight.controller.cluster.notifications.RegisterRoleChangeListener;
65 import org.opendaylight.controller.cluster.notifications.RoleChangeNotification;
66 import org.opendaylight.controller.cluster.raft.RaftState;
67 import org.opendaylight.controller.cluster.raft.base.messages.FollowerInitialSyncUpStatus;
68 import org.opendaylight.yangtools.yang.model.api.ModuleIdentifier;
69 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
70 import org.slf4j.Logger;
71 import org.slf4j.LoggerFactory;
72 import scala.concurrent.duration.Duration;
73
74 /**
75  * The ShardManager has the following jobs,
76  * <ul>
77  * <li> Create all the local shard replicas that belong on this cluster member
78  * <li> Find the address of the local shard
79  * <li> Find the primary replica for any given shard
80  * <li> Monitor the cluster members and store their addresses
81  * <ul>
82  */
83 public class ShardManager extends AbstractUntypedPersistentActorWithMetering {
84
85     private static final Logger LOG = LoggerFactory.getLogger(ShardManager.class);
86
87     // Stores a mapping between a member name and the address of the member
88     // Member names look like "member-1", "member-2" etc and are as specified
89     // in configuration
90     private final Map<String, Address> memberNameToAddress = new HashMap<>();
91
92     // Stores a mapping between a shard name and it's corresponding information
93     // Shard names look like inventory, topology etc and are as specified in
94     // configuration
95     private final Map<String, ShardInformation> localShards = new HashMap<>();
96
97     // The type of a ShardManager reflects the type of the datastore itself
98     // A data store could be of type config/operational
99     private final String type;
100
101     private final String shardManagerIdentifierString;
102
103     private final ClusterWrapper cluster;
104
105     private final Configuration configuration;
106
107     private final String shardDispatcherPath;
108
109     private ShardManagerInfo mBean;
110
111     private DatastoreContext datastoreContext;
112
113     private Collection<String> knownModules = Collections.emptySet();
114
115     private final DataPersistenceProvider dataPersistenceProvider;
116
117     private final CountDownLatch waitTillReadyCountdownLatch;
118
119     /**
120      */
121     protected ShardManager(ClusterWrapper cluster, Configuration configuration,
122             DatastoreContext datastoreContext, CountDownLatch waitTillReadyCountdownLatch) {
123
124         this.cluster = Preconditions.checkNotNull(cluster, "cluster should not be null");
125         this.configuration = Preconditions.checkNotNull(configuration, "configuration should not be null");
126         this.datastoreContext = datastoreContext;
127         this.dataPersistenceProvider = createDataPersistenceProvider(datastoreContext.isPersistent());
128         this.type = datastoreContext.getDataStoreType();
129         this.shardManagerIdentifierString = ShardManagerIdentifier.builder().type(type).build().toString();
130         this.shardDispatcherPath =
131                 new Dispatchers(context().system().dispatchers()).getDispatcherPath(Dispatchers.DispatcherType.Shard);
132         this.waitTillReadyCountdownLatch = waitTillReadyCountdownLatch;
133
134         // Subscribe this actor to cluster member events
135         cluster.subscribeToMemberEvents(getSelf());
136
137         createLocalShards();
138     }
139
140     protected DataPersistenceProvider createDataPersistenceProvider(boolean persistent) {
141         return (persistent) ? new PersistentDataProvider(this) : new NonPersistentDataProvider();
142     }
143
144     public static Props props(
145         final ClusterWrapper cluster,
146         final Configuration configuration,
147         final DatastoreContext datastoreContext,
148         final CountDownLatch waitTillReadyCountdownLatch) {
149
150         Preconditions.checkNotNull(cluster, "cluster should not be null");
151         Preconditions.checkNotNull(configuration, "configuration should not be null");
152         Preconditions.checkNotNull(waitTillReadyCountdownLatch, "waitTillReadyCountdownLatch should not be null");
153
154         return Props.create(new ShardManagerCreator(cluster, configuration, datastoreContext, waitTillReadyCountdownLatch));
155     }
156
157     @Override
158     public void postStop() {
159         LOG.info("Stopping ShardManager");
160
161         mBean.unregisterMBean();
162     }
163
164     @Override
165     public void handleCommand(Object message) throws Exception {
166         if (message  instanceof FindPrimary) {
167             findPrimary((FindPrimary)message);
168         } else if(message instanceof FindLocalShard){
169             findLocalShard((FindLocalShard) message);
170         } else if (message instanceof UpdateSchemaContext) {
171             updateSchemaContext(message);
172         } else if(message instanceof ActorInitialized) {
173             onActorInitialized(message);
174         } else if (message instanceof ClusterEvent.MemberUp){
175             memberUp((ClusterEvent.MemberUp) message);
176         } else if(message instanceof ClusterEvent.MemberRemoved) {
177             memberRemoved((ClusterEvent.MemberRemoved) message);
178         } else if(message instanceof ClusterEvent.UnreachableMember) {
179             ignoreMessage(message);
180         } else if(message instanceof DatastoreContext) {
181             onDatastoreContext((DatastoreContext)message);
182         } else if(message instanceof RoleChangeNotification) {
183             onRoleChangeNotification((RoleChangeNotification) message);
184         } else if(message instanceof FollowerInitialSyncUpStatus){
185             onFollowerInitialSyncStatus((FollowerInitialSyncUpStatus) message);
186         } else if(message instanceof ShardNotInitializedTimeout) {
187             onShardNotInitializedTimeout((ShardNotInitializedTimeout)message);
188         } else if(message instanceof LeaderStateChanged) {
189             onLeaderStateChanged((LeaderStateChanged)message);
190         } else {
191             unknownMessage(message);
192         }
193
194     }
195
196     private void checkReady(){
197         if (isReadyWithLeaderId()) {
198             LOG.info("{}: All Shards are ready - data store {} is ready, available count is {}",
199                     persistenceId(), type, waitTillReadyCountdownLatch.getCount());
200
201             waitTillReadyCountdownLatch.countDown();
202         }
203     }
204
205     private void onLeaderStateChanged(LeaderStateChanged leaderStateChanged) {
206         LOG.info("{}: Received LeaderStateChanged message: {}", persistenceId(), leaderStateChanged);
207
208         ShardInformation shardInformation = findShardInformation(leaderStateChanged.getMemberId());
209         if(shardInformation != null) {
210             shardInformation.setLeaderId(leaderStateChanged.getLeaderId());
211             checkReady();
212         } else {
213             LOG.debug("No shard found with member Id {}", leaderStateChanged.getMemberId());
214         }
215     }
216
217     private void onShardNotInitializedTimeout(ShardNotInitializedTimeout message) {
218         ShardInformation shardInfo = message.getShardInfo();
219
220         LOG.debug("{}: Received ShardNotInitializedTimeout message for shard {}", persistenceId(),
221                 shardInfo.getShardName());
222
223         shardInfo.removeOnShardInitialized(message.getOnShardInitialized());
224
225         if(!shardInfo.isShardInitialized()) {
226             LOG.debug("{}: Returning NotInitializedException for shard {}", persistenceId(), shardInfo.getShardName());
227             message.getSender().tell(createNotInitializedException(shardInfo.shardId), getSelf());
228         } else {
229             LOG.debug("{}: Returning NoShardLeaderException for shard {}", persistenceId(), shardInfo.getShardName());
230             message.getSender().tell(createNoShardLeaderException(shardInfo.shardId), getSelf());
231         }
232     }
233
234     private void onFollowerInitialSyncStatus(FollowerInitialSyncUpStatus status) {
235         LOG.info("{} Received follower initial sync status for {} status sync done {}", persistenceId(),
236                 status.getName(), status.isInitialSyncDone());
237
238         ShardInformation shardInformation = findShardInformation(status.getName());
239
240         if(shardInformation != null) {
241             shardInformation.setFollowerSyncStatus(status.isInitialSyncDone());
242
243             mBean.setSyncStatus(isInSync());
244         }
245
246     }
247
248     private void onRoleChangeNotification(RoleChangeNotification roleChanged) {
249         LOG.info("{}: Received role changed for {} from {} to {}", persistenceId(), roleChanged.getMemberId(),
250                 roleChanged.getOldRole(), roleChanged.getNewRole());
251
252         ShardInformation shardInformation = findShardInformation(roleChanged.getMemberId());
253         if(shardInformation != null) {
254             shardInformation.setRole(roleChanged.getNewRole());
255             checkReady();
256             mBean.setSyncStatus(isInSync());
257         }
258     }
259
260
261     private ShardInformation findShardInformation(String memberId) {
262         for(ShardInformation info : localShards.values()){
263             if(info.getShardId().toString().equals(memberId)){
264                 return info;
265             }
266         }
267
268         return null;
269     }
270
271     private boolean isReadyWithLeaderId() {
272         boolean isReady = true;
273         for (ShardInformation info : localShards.values()) {
274             if(!info.isShardReadyWithLeaderId()){
275                 isReady = false;
276                 break;
277             }
278         }
279         return isReady;
280     }
281
282     private boolean isInSync(){
283         for (ShardInformation info : localShards.values()) {
284             if(!info.isInSync()){
285                 return false;
286             }
287         }
288         return true;
289     }
290
291     private void onActorInitialized(Object message) {
292         final ActorRef sender = getSender();
293
294         if (sender == null) {
295             return; //why is a non-actor sending this message? Just ignore.
296         }
297
298         String actorName = sender.path().name();
299         //find shard name from actor name; actor name is stringified shardId
300         ShardIdentifier shardId = ShardIdentifier.builder().fromShardIdString(actorName).build();
301
302         if (shardId.getShardName() == null) {
303             return;
304         }
305
306         markShardAsInitialized(shardId.getShardName());
307     }
308
309     private void markShardAsInitialized(String shardName) {
310         LOG.debug("{}: Initializing shard [{}]", persistenceId(), shardName);
311
312         ShardInformation shardInformation = localShards.get(shardName);
313         if (shardInformation != null) {
314             shardInformation.setActorInitialized();
315
316             shardInformation.getActor().tell(new RegisterRoleChangeListener(), self());
317         }
318     }
319
320     @Override
321     protected void handleRecover(Object message) throws Exception {
322         if(dataPersistenceProvider.isRecoveryApplicable()) {
323             if (message instanceof SchemaContextModules) {
324                 SchemaContextModules msg = (SchemaContextModules) message;
325                 knownModules = ImmutableSet.copyOf(msg.getModules());
326             } else if (message instanceof RecoveryFailure) {
327                 RecoveryFailure failure = (RecoveryFailure) message;
328                 LOG.error("Recovery failed", failure.cause());
329             } else if (message instanceof RecoveryCompleted) {
330                 LOG.info("Recovery complete : {}", persistenceId());
331
332                 // Delete all the messages from the akka journal except the last one
333                 deleteMessages(lastSequenceNr() - 1);
334             }
335         } else {
336             if (message instanceof RecoveryCompleted) {
337                 LOG.info("Recovery complete : {}", persistenceId());
338
339                 // Delete all the messages from the akka journal
340                 deleteMessages(lastSequenceNr());
341             }
342         }
343     }
344
345     private void findLocalShard(FindLocalShard message) {
346         final ShardInformation shardInformation = localShards.get(message.getShardName());
347
348         if(shardInformation == null){
349             getSender().tell(new LocalShardNotFound(message.getShardName()), getSelf());
350             return;
351         }
352
353         sendResponse(shardInformation, message.isWaitUntilInitialized(), false, new Supplier<Object>() {
354             @Override
355             public Object get() {
356                 return new LocalShardFound(shardInformation.getActor());
357             }
358         });
359     }
360
361     private void sendResponse(ShardInformation shardInformation, boolean doWait,
362             boolean wantShardReady, final Supplier<Object> messageSupplier) {
363         if (!shardInformation.isShardInitialized() || (wantShardReady && !shardInformation.isShardReadyWithLeaderId())) {
364             if(doWait) {
365                 final ActorRef sender = getSender();
366                 final ActorRef self = self();
367
368                 Runnable replyRunnable = new Runnable() {
369                     @Override
370                     public void run() {
371                         sender.tell(messageSupplier.get(), self);
372                     }
373                 };
374
375                 OnShardInitialized onShardInitialized = wantShardReady ? new OnShardReady(replyRunnable) :
376                     new OnShardInitialized(replyRunnable);
377
378                 shardInformation.addOnShardInitialized(onShardInitialized);
379
380                 LOG.debug("{}: Scheduling timer to wait for shard {}", persistenceId(), shardInformation.getShardName());
381
382                 Cancellable timeoutSchedule = getContext().system().scheduler().scheduleOnce(
383                         datastoreContext.getShardInitializationTimeout().duration(), getSelf(),
384                         new ShardNotInitializedTimeout(shardInformation, onShardInitialized, sender),
385                         getContext().dispatcher(), getSelf());
386
387                 onShardInitialized.setTimeoutSchedule(timeoutSchedule);
388
389             } else if (!shardInformation.isShardInitialized()) {
390                 LOG.debug("{}: Returning NotInitializedException for shard {}", persistenceId(),
391                         shardInformation.getShardName());
392                 getSender().tell(createNotInitializedException(shardInformation.shardId), getSelf());
393             } else {
394                 LOG.debug("{}: Returning NoShardLeaderException for shard {}", persistenceId(),
395                         shardInformation.getShardName());
396                 getSender().tell(createNoShardLeaderException(shardInformation.shardId), getSelf());
397             }
398
399             return;
400         }
401
402         getSender().tell(messageSupplier.get(), getSelf());
403     }
404
405     private NoShardLeaderException createNoShardLeaderException(ShardIdentifier shardId) {
406         return new NoShardLeaderException(String.format(
407                 "Could not find a leader for shard %s. This typically happens when the system is coming up or " +
408                 "recovering and a leader is being elected. Try again later.", shardId));
409     }
410
411     private NotInitializedException createNotInitializedException(ShardIdentifier shardId) {
412         return new NotInitializedException(String.format(
413                 "Found primary shard %s but it's not initialized yet. Please try again later", shardId));
414     }
415
416     private void memberRemoved(ClusterEvent.MemberRemoved message) {
417         String memberName = message.member().roles().head();
418
419         LOG.debug("{}: Received MemberRemoved: memberName: {}, address: {}", persistenceId(), memberName,
420                 message.member().address());
421
422         memberNameToAddress.remove(message.member().roles().head());
423     }
424
425     private void memberUp(ClusterEvent.MemberUp message) {
426         String memberName = message.member().roles().head();
427
428         LOG.debug("{}: Received MemberUp: memberName: {}, address: {}", persistenceId(), memberName,
429                 message.member().address());
430
431         memberNameToAddress.put(memberName, message.member().address());
432
433         for(ShardInformation info : localShards.values()){
434             String shardName = info.getShardName();
435             info.updatePeerAddress(getShardIdentifier(memberName, shardName).toString(),
436                 getShardActorPath(shardName, memberName), getSelf());
437         }
438
439         checkReady();
440     }
441
442     private void onDatastoreContext(DatastoreContext context) {
443         datastoreContext = context;
444         for (ShardInformation info : localShards.values()) {
445             if (info.getActor() != null) {
446                 info.getActor().tell(datastoreContext, getSelf());
447             }
448         }
449     }
450
451     /**
452      * Notifies all the local shards of a change in the schema context
453      *
454      * @param message
455      */
456     private void updateSchemaContext(final Object message) {
457         final SchemaContext schemaContext = ((UpdateSchemaContext) message).getSchemaContext();
458
459         Set<ModuleIdentifier> allModuleIdentifiers = schemaContext.getAllModuleIdentifiers();
460         Set<String> newModules = new HashSet<>(128);
461
462         for(ModuleIdentifier moduleIdentifier : allModuleIdentifiers){
463             String s = moduleIdentifier.getNamespace().toString();
464             newModules.add(s);
465         }
466
467         if(newModules.containsAll(knownModules)) {
468
469             LOG.debug("New SchemaContext has a super set of current knownModules - persisting info");
470
471             knownModules = ImmutableSet.copyOf(newModules);
472
473             dataPersistenceProvider.persist(new SchemaContextModules(newModules), new Procedure<SchemaContextModules>() {
474
475                 @Override
476                 public void apply(SchemaContextModules param) throws Exception {
477                     LOG.debug("Sending new SchemaContext to Shards");
478                     for (ShardInformation info : localShards.values()) {
479                         if (info.getActor() == null) {
480                             info.setActor(newShardActor(schemaContext, info));
481                         } else {
482                             info.getActor().tell(message, getSelf());
483                         }
484                     }
485                 }
486
487             });
488         } else {
489             LOG.debug("Rejecting schema context update - not a super set of previously known modules:\nUPDATE: {}\nKNOWN: {}",
490                     newModules, knownModules);
491         }
492
493     }
494
495     @VisibleForTesting
496     protected ClusterWrapper getCluster() {
497         return cluster;
498     }
499
500     @VisibleForTesting
501     protected ActorRef newShardActor(final SchemaContext schemaContext, ShardInformation info) {
502         return getContext().actorOf(Shard.props(info.getShardId(),
503                 info.getPeerAddresses(), datastoreContext, schemaContext)
504                         .withDispatcher(shardDispatcherPath), info.getShardId().toString());
505     }
506
507     private void findPrimary(FindPrimary message) {
508         LOG.debug("{}: In findPrimary: {}", persistenceId(), message);
509
510         final String shardName = message.getShardName();
511
512         // First see if the there is a local replica for the shard
513         final ShardInformation info = localShards.get(shardName);
514         if (info != null) {
515             sendResponse(info, message.isWaitUntilReady(), true, new Supplier<Object>() {
516                 @Override
517                 public Object get() {
518                     Object found = new PrimaryFound(info.getSerializedLeaderActor());
519
520                     if(LOG.isDebugEnabled()) {
521                         LOG.debug("{}: Found primary for {}: {}", persistenceId(), shardName, found);
522                     }
523
524                     return found;
525                 }
526             });
527
528             return;
529         }
530
531         for(Map.Entry<String, Address> entry: memberNameToAddress.entrySet()) {
532             if(!cluster.getCurrentMemberName().equals(entry.getKey())) {
533                 String path = getShardManagerActorPathBuilder(entry.getValue()).toString();
534
535                 LOG.debug("{}: findPrimary for {} forwarding to remote ShardManager {}", persistenceId(),
536                         shardName, path);
537
538                 getContext().actorSelection(path).forward(message, getContext());
539                 return;
540             }
541         }
542
543         LOG.debug("{}: No shard found for {}", persistenceId(), shardName);
544
545         getSender().tell(new PrimaryNotFoundException(
546                 String.format("No primary shard found for %s.", shardName)), getSelf());
547     }
548
549     private StringBuilder getShardManagerActorPathBuilder(Address address) {
550         StringBuilder builder = new StringBuilder();
551         builder.append(address.toString()).append("/user/").append(shardManagerIdentifierString);
552         return builder;
553     }
554
555     private String getShardActorPath(String shardName, String memberName) {
556         Address address = memberNameToAddress.get(memberName);
557         if(address != null) {
558             StringBuilder builder = getShardManagerActorPathBuilder(address);
559             builder.append("/")
560                 .append(getShardIdentifier(memberName, shardName));
561             return builder.toString();
562         }
563         return null;
564     }
565
566     /**
567      * Construct the name of the shard actor given the name of the member on
568      * which the shard resides and the name of the shard
569      *
570      * @param memberName
571      * @param shardName
572      * @return
573      */
574     private ShardIdentifier getShardIdentifier(String memberName, String shardName){
575         return ShardIdentifier.builder().memberName(memberName).shardName(shardName).type(type).build();
576     }
577
578     /**
579      * Create shards that are local to the member on which the ShardManager
580      * runs
581      *
582      */
583     private void createLocalShards() {
584         String memberName = this.cluster.getCurrentMemberName();
585         List<String> memberShardNames =
586             this.configuration.getMemberShardNames(memberName);
587
588         List<String> localShardActorNames = new ArrayList<>();
589         for(String shardName : memberShardNames){
590             ShardIdentifier shardId = getShardIdentifier(memberName, shardName);
591             Map<String, String> peerAddresses = getPeerAddresses(shardName);
592             localShardActorNames.add(shardId.toString());
593             localShards.put(shardName, new ShardInformation(shardName, shardId, peerAddresses));
594         }
595
596         mBean = ShardManagerInfo.createShardManagerMBean("shard-manager-" + this.type,
597                     datastoreContext.getDataStoreMXBeanType(), localShardActorNames);
598     }
599
600     /**
601      * Given the name of the shard find the addresses of all it's peers
602      *
603      * @param shardName
604      * @return
605      */
606     private Map<String, String> getPeerAddresses(String shardName){
607
608         Map<String, String> peerAddresses = new HashMap<>();
609
610         List<String> members = this.configuration.getMembersFromShardName(shardName);
611
612         String currentMemberName = this.cluster.getCurrentMemberName();
613
614         for(String memberName : members){
615             if(!currentMemberName.equals(memberName)){
616                 ShardIdentifier shardId = getShardIdentifier(memberName, shardName);
617                 String path = getShardActorPath(shardName, currentMemberName);
618                 peerAddresses.put(shardId.toString(), path);
619             }
620         }
621         return peerAddresses;
622     }
623
624     @Override
625     public SupervisorStrategy supervisorStrategy() {
626
627         return new OneForOneStrategy(10, Duration.create("1 minute"),
628             new Function<Throwable, SupervisorStrategy.Directive>() {
629                 @Override
630                 public SupervisorStrategy.Directive apply(Throwable t) {
631                     LOG.warn("Supervisor Strategy caught unexpected exception - resuming", t);
632                     return SupervisorStrategy.resume();
633                 }
634             }
635         );
636
637     }
638
639     @Override
640     public String persistenceId() {
641         return "shard-manager-" + type;
642     }
643
644     @VisibleForTesting
645     Collection<String> getKnownModules() {
646         return knownModules;
647     }
648
649     @VisibleForTesting
650     DataPersistenceProvider getDataPersistenceProvider() {
651         return dataPersistenceProvider;
652     }
653
654     @VisibleForTesting
655     ShardManagerInfoMBean getMBean(){
656         return mBean;
657     }
658
659     @VisibleForTesting
660     protected static class ShardInformation {
661         private final ShardIdentifier shardId;
662         private final String shardName;
663         private ActorRef actor;
664         private ActorPath actorPath;
665         private final Map<String, String> peerAddresses;
666
667         // flag that determines if the actor is ready for business
668         private boolean actorInitialized = false;
669
670         private boolean followerSyncStatus = false;
671
672         private final Set<OnShardInitialized> onShardInitializedSet = Sets.newHashSet();
673         private String role ;
674         private String leaderId;
675
676         private ShardInformation(String shardName, ShardIdentifier shardId,
677                 Map<String, String> peerAddresses) {
678             this.shardName = shardName;
679             this.shardId = shardId;
680             this.peerAddresses = peerAddresses;
681         }
682
683         String getShardName() {
684             return shardName;
685         }
686
687         ActorRef getActor(){
688             return actor;
689         }
690
691         ActorPath getActorPath() {
692             return actorPath;
693         }
694
695         void setActor(ActorRef actor) {
696             this.actor = actor;
697             this.actorPath = actor.path();
698         }
699
700         ShardIdentifier getShardId() {
701             return shardId;
702         }
703
704         Map<String, String> getPeerAddresses() {
705             return peerAddresses;
706         }
707
708         void updatePeerAddress(String peerId, String peerAddress, ActorRef sender){
709             LOG.info("updatePeerAddress for peer {} with address {}", peerId,
710                 peerAddress);
711             if(peerAddresses.containsKey(peerId)){
712                 peerAddresses.put(peerId, peerAddress);
713
714                 if(actor != null) {
715                     if(LOG.isDebugEnabled()) {
716                         LOG.debug("Sending PeerAddressResolved for peer {} with address {} to {}",
717                                 peerId, peerAddress, actor.path());
718                     }
719
720                     actor.tell(new PeerAddressResolved(peerId.toString(), peerAddress), sender);
721                 }
722
723                 notifyOnShardInitializedCallbacks();
724             }
725         }
726
727         boolean isShardReady() {
728             return !RaftState.Candidate.name().equals(role) && !Strings.isNullOrEmpty(role);
729         }
730
731         boolean isShardReadyWithLeaderId() {
732             return isShardReady() && (isLeader() || peerAddresses.get(leaderId) != null);
733         }
734
735         boolean isShardInitialized() {
736             return getActor() != null && actorInitialized;
737         }
738
739         boolean isLeader() {
740             return Objects.equal(leaderId, shardId.toString());
741         }
742
743         String getSerializedLeaderActor() {
744             if(isLeader()) {
745                 return Serialization.serializedActorPath(getActor());
746             } else {
747                 return peerAddresses.get(leaderId);
748             }
749         }
750
751         void setActorInitialized() {
752             LOG.debug("Shard {} is initialized", shardId);
753
754             this.actorInitialized = true;
755
756             notifyOnShardInitializedCallbacks();
757         }
758
759         private void notifyOnShardInitializedCallbacks() {
760             if(onShardInitializedSet.isEmpty()) {
761                 return;
762             }
763
764             boolean ready = isShardReadyWithLeaderId();
765
766             if(LOG.isDebugEnabled()) {
767                 LOG.debug("Shard {} is {} - notifying {} OnShardInitialized callbacks", shardId,
768                         ready ? "ready" : "initialized", onShardInitializedSet.size());
769             }
770
771             Iterator<OnShardInitialized> iter = onShardInitializedSet.iterator();
772             while(iter.hasNext()) {
773                 OnShardInitialized onShardInitialized = iter.next();
774                 if(!(onShardInitialized instanceof OnShardReady) || ready) {
775                     iter.remove();
776                     onShardInitialized.getTimeoutSchedule().cancel();
777                     onShardInitialized.getReplyRunnable().run();
778                 }
779             }
780         }
781
782         void addOnShardInitialized(OnShardInitialized onShardInitialized) {
783             onShardInitializedSet.add(onShardInitialized);
784         }
785
786         void removeOnShardInitialized(OnShardInitialized onShardInitialized) {
787             onShardInitializedSet.remove(onShardInitialized);
788         }
789
790         void setRole(String newRole) {
791             this.role = newRole;
792
793             notifyOnShardInitializedCallbacks();
794         }
795
796         void setFollowerSyncStatus(boolean syncStatus){
797             this.followerSyncStatus = syncStatus;
798         }
799
800         boolean isInSync(){
801             if(RaftState.Follower.name().equals(this.role)){
802                 return followerSyncStatus;
803             } else if(RaftState.Leader.name().equals(this.role)){
804                 return true;
805             }
806
807             return false;
808         }
809
810         void setLeaderId(String leaderId) {
811             this.leaderId = leaderId;
812
813             notifyOnShardInitializedCallbacks();
814         }
815     }
816
817     private static class ShardManagerCreator implements Creator<ShardManager> {
818         private static final long serialVersionUID = 1L;
819
820         final ClusterWrapper cluster;
821         final Configuration configuration;
822         final DatastoreContext datastoreContext;
823         private final CountDownLatch waitTillReadyCountdownLatch;
824
825         ShardManagerCreator(ClusterWrapper cluster,
826                             Configuration configuration, DatastoreContext datastoreContext, CountDownLatch waitTillReadyCountdownLatch) {
827             this.cluster = cluster;
828             this.configuration = configuration;
829             this.datastoreContext = datastoreContext;
830             this.waitTillReadyCountdownLatch = waitTillReadyCountdownLatch;
831         }
832
833         @Override
834         public ShardManager create() throws Exception {
835             return new ShardManager(cluster, configuration, datastoreContext, waitTillReadyCountdownLatch);
836         }
837     }
838
839     private static class OnShardInitialized {
840         private final Runnable replyRunnable;
841         private Cancellable timeoutSchedule;
842
843         OnShardInitialized(Runnable replyRunnable) {
844             this.replyRunnable = replyRunnable;
845         }
846
847         Runnable getReplyRunnable() {
848             return replyRunnable;
849         }
850
851         Cancellable getTimeoutSchedule() {
852             return timeoutSchedule;
853         }
854
855         void setTimeoutSchedule(Cancellable timeoutSchedule) {
856             this.timeoutSchedule = timeoutSchedule;
857         }
858     }
859
860     private static class OnShardReady extends OnShardInitialized {
861         OnShardReady(Runnable replyRunnable) {
862             super(replyRunnable);
863         }
864     }
865
866     private static class ShardNotInitializedTimeout {
867         private final ActorRef sender;
868         private final ShardInformation shardInfo;
869         private final OnShardInitialized onShardInitialized;
870
871         ShardNotInitializedTimeout(ShardInformation shardInfo, OnShardInitialized onShardInitialized, ActorRef sender) {
872             this.sender = sender;
873             this.shardInfo = shardInfo;
874             this.onShardInitialized = onShardInitialized;
875         }
876
877         ActorRef getSender() {
878             return sender;
879         }
880
881         ShardInformation getShardInfo() {
882             return shardInfo;
883         }
884
885         OnShardInitialized getOnShardInitialized() {
886             return onShardInitialized;
887         }
888     }
889
890     static class SchemaContextModules implements Serializable {
891         private static final long serialVersionUID = -8884620101025936590L;
892
893         private final Set<String> modules;
894
895         SchemaContextModules(Set<String> modules){
896             this.modules = modules;
897         }
898
899         public Set<String> getModules() {
900             return modules;
901         }
902     }
903 }
904
905
906

©2013 OpenDaylight, A Linux Foundation Collaborative Project. All Rights Reserved.
OpenDaylight is a registered trademark of The OpenDaylight Project, Inc.
Linux Foundation and OpenDaylight are registered trademarks of the Linux Foundation.
Linux is a registered trademark of Linus Torvalds.