X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-distributed-datastore%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fcluster%2Fdatastore%2Fentityownership%2FEntityOwnershipShard.java;h=76a6ac1e8f61beaf362b3851412e612a7cc4d0f8;hb=6313c088fc7db266cc25b691e0cd909300fc8425;hp=e14ae7f5376e8e2f763b24dfe745bb82970d90c1;hpb=e970feb618c5e3793454f7f1a3974797a61c7c17;p=controller.git diff --git a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/entityownership/EntityOwnershipShard.java b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/entityownership/EntityOwnershipShard.java index e14ae7f537..76a6ac1e8f 100644 --- a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/entityownership/EntityOwnershipShard.java +++ b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/entityownership/EntityOwnershipShard.java @@ -7,7 +7,6 @@ */ package org.opendaylight.controller.cluster.datastore.entityownership; -import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.CANDIDATE_NAME_NODE_ID; import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.CANDIDATE_NODE_ID; import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.ENTITY_ID_NODE_ID; import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.ENTITY_ID_QNAME; @@ -25,6 +24,7 @@ import static org.opendaylight.controller.cluster.datastore.entityownership.Enti import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.entityOwnersWithCandidate; import akka.actor.ActorRef; import akka.actor.ActorSelection; +import akka.actor.Cancellable; import akka.pattern.Patterns; import com.google.common.base.Optional; import com.google.common.base.Preconditions; @@ -42,10 +42,11 @@ import org.opendaylight.controller.cluster.datastore.entityownership.messages.Ca import org.opendaylight.controller.cluster.datastore.entityownership.messages.CandidateRemoved; import org.opendaylight.controller.cluster.datastore.entityownership.messages.RegisterCandidateLocal; import org.opendaylight.controller.cluster.datastore.entityownership.messages.RegisterListenerLocal; +import org.opendaylight.controller.cluster.datastore.entityownership.messages.SelectOwner; import org.opendaylight.controller.cluster.datastore.entityownership.messages.UnregisterCandidateLocal; import org.opendaylight.controller.cluster.datastore.entityownership.messages.UnregisterListenerLocal; import org.opendaylight.controller.cluster.datastore.entityownership.selectionstrategy.EntityOwnerSelectionStrategy; -import org.opendaylight.controller.cluster.datastore.entityownership.selectionstrategy.FirstCandidateSelectionStrategy; +import org.opendaylight.controller.cluster.datastore.entityownership.selectionstrategy.EntityOwnerSelectionStrategyConfig; import org.opendaylight.controller.cluster.datastore.identifiers.ShardIdentifier; import org.opendaylight.controller.cluster.datastore.messages.BatchedModifications; import org.opendaylight.controller.cluster.datastore.messages.PeerDown; @@ -56,13 +57,13 @@ import org.opendaylight.controller.cluster.datastore.modification.MergeModificat import org.opendaylight.controller.cluster.datastore.modification.WriteModification; import org.opendaylight.controller.md.sal.common.api.clustering.Entity; import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier; -import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument; import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild; import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode; import org.opendaylight.yangtools.yang.data.api.schema.MapNode; import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode; import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes; import scala.concurrent.Future; +import scala.concurrent.duration.FiniteDuration; /** * Special Shard for EntityOwnership. @@ -70,16 +71,14 @@ import scala.concurrent.Future; * @author Thomas Pantelis */ class EntityOwnershipShard extends Shard { - - private static final EntityOwnerSelectionStrategy DEFAULT_ENTITY_OWNER_SELECTION_STRATEGY - = FirstCandidateSelectionStrategy.INSTANCE; - private final String localMemberName; private final EntityOwnershipShardCommitCoordinator commitCoordinator; private final EntityOwnershipListenerSupport listenerSupport; private final Set downPeerMemberNames = new HashSet<>(); private final Map peerIdToMemberNames = new HashMap<>(); - private final Map ownerSelectionStrategies = new HashMap<>(); + private final EntityOwnerSelectionStrategyConfig strategyConfig; + private final Map entityToScheduledOwnershipTask = new HashMap<>(); + private final EntityOwnershipStatistics entityOwnershipStatistics; private static DatastoreContext noPersistenceDatastoreContext(DatastoreContext datastoreContext) { return DatastoreContext.newBuilderFrom(datastoreContext).persistent(false).build(); @@ -90,6 +89,9 @@ class EntityOwnershipShard extends Shard { this.localMemberName = builder.localMemberName; this.commitCoordinator = new EntityOwnershipShardCommitCoordinator(builder.localMemberName, LOG); this.listenerSupport = new EntityOwnershipListenerSupport(getContext(), persistenceId()); + this.strategyConfig = builder.ownerSelectionStrategyConfig; + this.entityOwnershipStatistics = new EntityOwnershipStatistics(); + this.entityOwnershipStatistics.init(getDataStore()); for(String peerId: getRaftActorContext().getPeerIds()) { ShardIdentifier shardId = ShardIdentifier.builder().fromShardIdString(peerId).build(); @@ -111,9 +113,9 @@ class EntityOwnershipShard extends Shard { } @Override - public void onReceiveCommand(final Object message) throws Exception { + public void handleCommand(final Object message) { if(message instanceof RegisterCandidateLocal) { - onRegisterCandidateLocal((RegisterCandidateLocal)message); + onRegisterCandidateLocal((RegisterCandidateLocal) message); } else if(message instanceof UnregisterCandidateLocal) { onUnregisterCandidateLocal((UnregisterCandidateLocal)message); } else if(message instanceof CandidateAdded){ @@ -124,12 +126,34 @@ class EntityOwnershipShard extends Shard { onPeerDown((PeerDown) message); } else if(message instanceof PeerUp) { onPeerUp((PeerUp) message); - } if(message instanceof RegisterListenerLocal) { + } else if(message instanceof RegisterListenerLocal) { onRegisterListenerLocal((RegisterListenerLocal)message); - } if(message instanceof UnregisterListenerLocal) { - onUnregisterListenerLocal((UnregisterListenerLocal)message); + } else if(message instanceof UnregisterListenerLocal) { + onUnregisterListenerLocal((UnregisterListenerLocal) message); + } else if(message instanceof SelectOwner) { + onSelectOwner((SelectOwner) message); } else if(!commitCoordinator.handleMessage(message, this)) { - super.onReceiveCommand(message); + super.handleCommand(message); + } + } + + private void onSelectOwner(SelectOwner selectOwner) { + LOG.debug("{}: onSelectOwner: {}", persistenceId(), selectOwner); + + String currentOwner = getCurrentOwner(selectOwner.getEntityPath()); + if(Strings.isNullOrEmpty(currentOwner)) { + String entityType = EntityOwnersModel.entityTypeFromEntityPath(selectOwner.getEntityPath()); + writeNewOwner(selectOwner.getEntityPath(), newOwner(currentOwner, selectOwner.getAllCandidates(), + entityOwnershipStatistics.byEntityType(entityType), + selectOwner.getOwnerSelectionStrategy())); + + Cancellable cancellable = entityToScheduledOwnershipTask.get(selectOwner.getEntityPath()); + if(cancellable != null){ + if(!cancellable.isCancelled()){ + cancellable.cancel(); + } + entityToScheduledOwnershipTask.remove(selectOwner.getEntityPath()); + } } } @@ -164,16 +188,29 @@ class EntityOwnershipShard extends Shard { getSender().tell(SuccessReply.INSTANCE, getSelf()); - searchForEntitiesOwnedBy(localMemberName, new EntityWalker() { + searchForEntities(new EntityWalker() { @Override public void onEntity(MapEntryNode entityTypeNode, MapEntryNode entityNode) { - Optional> possibleType = - entityTypeNode.getChild(ENTITY_TYPE_NODE_ID); + Optional> possibleType = entityTypeNode.getChild(ENTITY_TYPE_NODE_ID); String entityType = possibleType.isPresent() ? possibleType.get().getValue().toString() : null; if (registerListener.getEntityType().equals(entityType)) { + final boolean hasOwner; + final boolean isOwner; + + Optional> possibleOwner = entityNode.getChild(ENTITY_OWNER_NODE_ID); + if (possibleOwner.isPresent()) { + isOwner = localMemberName.equals(possibleOwner.get().getValue().toString()); + hasOwner = true; + } else { + isOwner = false; + hasOwner = false; + } + Entity entity = new Entity(entityType, - (YangInstanceIdentifier) entityNode.getChild(ENTITY_ID_NODE_ID).get().getValue()); - listenerSupport.notifyEntityOwnershipListener(entity, false, true, true, registerListener.getListener()); + (YangInstanceIdentifier) entityNode.getChild(ENTITY_ID_NODE_ID).get().getValue()); + + listenerSupport.notifyEntityOwnershipListener(entity, false, isOwner, hasOwner, + registerListener.getListener()); } } }); @@ -220,17 +257,28 @@ class EntityOwnershipShard extends Shard { protected void onStateChanged() { super.onStateChanged(); - commitCoordinator.onStateChanged(this, isLeader()); + boolean isLeader = isLeader(); + if(LOG.isDebugEnabled()) { + LOG.debug("{}: onStateChanged: isLeader: {}, hasLeader: {}", persistenceId(), isLeader, hasLeader()); + } + + commitCoordinator.onStateChanged(this, isLeader); } @Override protected void onLeaderChanged(String oldLeader, String newLeader) { super.onLeaderChanged(oldLeader, newLeader); + boolean isLeader = isLeader(); LOG.debug("{}: onLeaderChanged: oldLeader: {}, newLeader: {}, isLeader: {}", persistenceId(), oldLeader, - newLeader, isLeader()); + newLeader, isLeader); - if(isLeader()) { + if(isLeader) { + + // Clear all existing strategies so that they get re-created when we call createStrategy again + // This allows the strategies to be re-initialized with existing statistics maintained by + // EntityOwnershipStatistics + strategyConfig.clearStrategies(); // We were just elected leader. If the old leader is down, select new owners for the entities // owned by the down leader. @@ -239,8 +287,13 @@ class EntityOwnershipShard extends Shard { LOG.debug("{}: oldLeaderMemberName: {}", persistenceId(), oldLeaderMemberName); if(downPeerMemberNames.contains(oldLeaderMemberName)) { - selectNewOwnerForEntitiesOwnedBy(oldLeaderMemberName); + removeCandidateFromEntities(oldLeaderMemberName); } + } else { + // The leader changed - notify the coordinator to check if pending modifications need to be sent. + // While onStateChanged also does this, this method handles the case where the shard hears from a + // leader and stays in the follower state. In that case no behavior state change occurs. + commitCoordinator.onStateChanged(this, isLeader); } } @@ -249,9 +302,11 @@ class EntityOwnershipShard extends Shard { if(isLeader()) { String currentOwner = getCurrentOwner(message.getEntityPath()); - if(message.getRemovedCandidate().equals(currentOwner)){ - writeNewOwner(message.getEntityPath(), newOwner(message.getRemainingCandidates(), - getEntityOwnerElectionStrategy(message.getEntityPath()))); + if(message.getRemovedCandidate().equals(currentOwner) || message.getRemainingCandidates().size() == 0){ + String entityType = EntityOwnersModel.entityTypeFromEntityPath(message.getEntityPath()); + writeNewOwner(message.getEntityPath(), + newOwner(currentOwner, message.getRemainingCandidates(), entityOwnershipStatistics.byEntityType(entityType), + getEntityOwnerElectionStrategy(message.getEntityPath()))); } } else { // We're not the leader. If the removed candidate is our local member then check if we actually @@ -272,15 +327,8 @@ class EntityOwnershipShard extends Shard { } private EntityOwnerSelectionStrategy getEntityOwnerElectionStrategy(YangInstanceIdentifier entityPath) { - String entityType = EntityOwnersModel.entityTypeFromEntityPath(entityPath); - EntityOwnerSelectionStrategy entityOwnerSelectionStrategy = ownerSelectionStrategies.get(entityType); - - if(entityOwnerSelectionStrategy == null){ - entityOwnerSelectionStrategy = DEFAULT_ENTITY_OWNER_SELECTION_STRATEGY; - ownerSelectionStrategies.put(entityType, entityOwnerSelectionStrategy); - } - - return entityOwnerSelectionStrategy; + final String entityType = EntityOwnersModel.entityTypeFromEntityPath(entityPath); + return strategyConfig.createStrategy(entityType, entityOwnershipStatistics.byEntityType(entityType)); } private void onCandidateAdded(CandidateAdded message) { @@ -294,15 +342,27 @@ class EntityOwnershipShard extends Shard { // remove it from the downPeerMemberNames. downPeerMemberNames.remove(message.getNewCandidate()); - String currentOwner = getCurrentOwner(message.getEntityPath()); + final String currentOwner = getCurrentOwner(message.getEntityPath()); + final EntityOwnerSelectionStrategy strategy = getEntityOwnerElectionStrategy(message.getEntityPath()); + final String entityType = EntityOwnersModel.entityTypeFromEntityPath(message.getEntityPath()); + + // Available members is all the known peers - the number of peers that are down + self + // So if there are 2 peers and 1 is down then availableMembers will be 2 + final int availableMembers = (peerIdToMemberNames.size() - downPeerMemberNames.size()) + 1; + + LOG.debug("{}: Using strategy {} to select owner", persistenceId(), strategy); if(Strings.isNullOrEmpty(currentOwner)){ - EntityOwnerSelectionStrategy entityOwnerSelectionStrategy - = getEntityOwnerElectionStrategy(message.getEntityPath()); - if(entityOwnerSelectionStrategy.selectionDelayInMillis() == 0L) { - writeNewOwner(message.getEntityPath(), newOwner(message.getAllCandidates(), - entityOwnerSelectionStrategy)); + if(strategy.getSelectionDelayInMillis() == 0L) { + writeNewOwner(message.getEntityPath(), newOwner(currentOwner, message.getAllCandidates(), + entityOwnershipStatistics.byEntityType(entityType), strategy)); + } else if(message.getAllCandidates().size() == availableMembers) { + LOG.debug("{}: Received the maximum candidates requests : {} writing new owner", + persistenceId(), availableMembers); + cancelOwnerSelectionTask(message.getEntityPath()); + writeNewOwner(message.getEntityPath(), newOwner(currentOwner, message.getAllCandidates(), + entityOwnershipStatistics.byEntityType(entityType), strategy)); } else { - throw new UnsupportedOperationException("Delayed selection not implemented yet"); + scheduleOwnerSelection(message.getEntityPath(), message.getAllCandidates(), strategy); } } } @@ -322,28 +382,11 @@ class EntityOwnershipShard extends Shard { peerIdToMemberNames.put(peerUp.getPeerId(), peerUp.getMemberName()); downPeerMemberNames.remove(peerUp.getMemberName()); - } - - private void selectNewOwnerForEntitiesOwnedBy(String owner) { - final BatchedModifications modifications = commitCoordinator.newBatchedModifications(); - searchForEntitiesOwnedBy(owner, new EntityWalker() { - @Override - public void onEntity(MapEntryNode entityTypeNode, MapEntryNode entityNode) { - - YangInstanceIdentifier entityPath = YangInstanceIdentifier.builder(ENTITY_TYPES_PATH). - node(entityTypeNode.getIdentifier()).node(ENTITY_NODE_ID).node(entityNode.getIdentifier()). - node(ENTITY_OWNER_NODE_ID).build(); - - Object newOwner = newOwner(getCandidateNames(entityNode), getEntityOwnerElectionStrategy(entityPath)); - - LOG.debug("{}: Found entity {}, writing new owner {}", persistenceId(), entityPath, newOwner); - - modifications.addModification(new WriteModification(entityPath, - ImmutableNodes.leafNode(ENTITY_OWNER_NODE_ID, newOwner))); - } - }); - commitCoordinator.commitModifications(modifications, this); + // Notify the coordinator to check if pending modifications need to be sent. We do this here + // to handle the case where the leader's peer address isn't now yet when a prior state or + // leader change occurred. + commitCoordinator.onStateChanged(this, isLeader()); } private void removeCandidateFromEntities(final String owner) { @@ -351,9 +394,9 @@ class EntityOwnershipShard extends Shard { searchForEntities(new EntityWalker() { @Override public void onEntity(MapEntryNode entityTypeNode, MapEntryNode entityNode) { - if(hasCandidate(entityNode, owner)) { + if (hasCandidate(entityNode, owner)) { YangInstanceIdentifier entityId = - (YangInstanceIdentifier)entityNode.getIdentifier().getKeyValues().get(ENTITY_ID_QNAME); + (YangInstanceIdentifier) entityNode.getIdentifier().getKeyValues().get(ENTITY_ID_QNAME); YangInstanceIdentifier candidatePath = candidatePath( entityTypeNode.getIdentifier().getKeyValues().get(ENTITY_TYPE_QNAME).toString(), entityId, owner); @@ -373,26 +416,6 @@ class EntityOwnershipShard extends Shard { return ((MapNode)entity.getChild(CANDIDATE_NODE_ID).get()).getChild(candidateNodeKey(candidateName)).isPresent(); } - private void searchForEntitiesOwnedBy(final String owner, final EntityWalker walker) { - Optional> possibleEntityTypes = getDataStore().readNode(ENTITY_TYPES_PATH); - if(!possibleEntityTypes.isPresent()) { - return; - } - - LOG.debug("{}: Searching for entities owned by {}", persistenceId(), owner); - - searchForEntities(new EntityWalker() { - @Override - public void onEntity(MapEntryNode entityTypeNode, MapEntryNode entityNode) { - Optional> possibleOwner = - entityNode.getChild(ENTITY_OWNER_NODE_ID); - if(possibleOwner.isPresent() && owner.equals(possibleOwner.get().getValue().toString())) { - walker.onEntity(entityTypeNode, entityNode); - } - } - }); - } - private void searchForEntities(EntityWalker walker) { Optional> possibleEntityTypes = getDataStore().readNode(ENTITY_TYPES_PATH); if(!possibleEntityTypes.isPresent()) { @@ -400,10 +423,10 @@ class EntityOwnershipShard extends Shard { } for(MapEntryNode entityType: ((MapNode) possibleEntityTypes.get()).getValue()) { - Optional> possibleEntities = - entityType.getChild(ENTITY_NODE_ID); + Optional> possibleEntities = entityType.getChild(ENTITY_NODE_ID); if(!possibleEntities.isPresent()) { - continue; // shouldn't happen but handle anyway + // shouldn't happen but handle anyway + continue; } for(MapEntryNode entity: ((MapNode) possibleEntities.get()).getValue()) { @@ -412,16 +435,6 @@ class EntityOwnershipShard extends Shard { } } - private static Collection getCandidateNames(MapEntryNode entity) { - Collection candidates = ((MapNode)entity.getChild(CANDIDATE_NODE_ID).get()).getValue(); - Collection candidateNames = new ArrayList<>(candidates.size()); - for(MapEntryNode candidate: candidates) { - candidateNames.add(candidate.getChild(CANDIDATE_NAME_NODE_ID).get().getValue().toString()); - } - - return candidateNames; - } - private void writeNewOwner(YangInstanceIdentifier entityPath, String newOwner) { LOG.debug("{}: Writing new owner {} for entity {}", persistenceId(), newOwner, entityPath); @@ -429,12 +442,39 @@ class EntityOwnershipShard extends Shard { ImmutableNodes.leafNode(ENTITY_OWNER_NODE_ID, newOwner)), this); } - private String newOwner(Collection candidates, EntityOwnerSelectionStrategy ownerSelectionStrategy) { + /** + * Schedule a new owner selection job. Cancelling any outstanding job if it has not been cancelled. + * + * @param entityPath + * @param allCandidates + */ + public void scheduleOwnerSelection(YangInstanceIdentifier entityPath, Collection allCandidates, + EntityOwnerSelectionStrategy strategy){ + cancelOwnerSelectionTask(entityPath); + + LOG.debug("{}: Scheduling owner selection after {} ms", persistenceId(), strategy.getSelectionDelayInMillis()); + + final Cancellable lastScheduledTask = context().system().scheduler().scheduleOnce( + FiniteDuration.apply(strategy.getSelectionDelayInMillis(), TimeUnit.MILLISECONDS) + , self(), new SelectOwner(entityPath, allCandidates, strategy) + , context().system().dispatcher(), self()); + + entityToScheduledOwnershipTask.put(entityPath, lastScheduledTask); + } + + private void cancelOwnerSelectionTask(YangInstanceIdentifier entityPath){ + final Cancellable lastScheduledTask = entityToScheduledOwnershipTask.get(entityPath); + if(lastScheduledTask != null && !lastScheduledTask.isCancelled()){ + lastScheduledTask.cancel(); + } + } + + private String newOwner(String currentOwner, Collection candidates, Map statistics, EntityOwnerSelectionStrategy ownerSelectionStrategy) { Collection viableCandidates = getViableCandidates(candidates); if(viableCandidates.size() == 0){ return ""; } - return ownerSelectionStrategy.newOwner(viableCandidates); + return ownerSelectionStrategy.newOwner(currentOwner, viableCandidates); } private Collection getViableCandidates(Collection candidates) { @@ -466,6 +506,7 @@ class EntityOwnershipShard extends Shard { static class Builder extends Shard.AbstractBuilder { private String localMemberName; + private EntityOwnerSelectionStrategyConfig ownerSelectionStrategyConfig; protected Builder() { super(EntityOwnershipShard.class); @@ -477,10 +518,17 @@ class EntityOwnershipShard extends Shard { return this; } + Builder ownerSelectionStrategyConfig(EntityOwnerSelectionStrategyConfig ownerSelectionStrategyConfig){ + checkSealed(); + this.ownerSelectionStrategyConfig = ownerSelectionStrategyConfig; + return this; + } + @Override protected void verify() { super.verify(); Preconditions.checkNotNull(localMemberName, "localMemberName should not be null"); + Preconditions.checkNotNull(ownerSelectionStrategyConfig, "ownerSelectionStrategyConfig should not be null"); } } }