/* * Copyright (c) 2015 Brocade Communications Systems, Inc. and others. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Public License v1.0 which accompanies this distribution, * and is available at http://www.eclipse.org/legal/epl-v10.html */ 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; import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.ENTITY_NODE_ID; import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.ENTITY_OWNERS_PATH; import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.ENTITY_OWNER_NODE_ID; import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.ENTITY_OWNER_QNAME; import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.ENTITY_TYPES_PATH; import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.ENTITY_TYPE_NODE_ID; import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.ENTITY_TYPE_QNAME; import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.candidateMapEntry; import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.candidateNodeKey; import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.candidatePath; import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.createEntity; import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.entityOwnersWithCandidate; import akka.actor.ActorRef; import akka.actor.ActorSelection; import akka.pattern.Patterns; import com.google.common.annotations.VisibleForTesting; import com.google.common.base.Optional; import com.google.common.base.Preconditions; import com.google.common.base.Strings; import java.util.ArrayList; import java.util.Collection; import java.util.HashMap; import java.util.HashSet; import java.util.Map; import java.util.Set; import java.util.concurrent.TimeUnit; import org.opendaylight.controller.cluster.datastore.DatastoreContext; import org.opendaylight.controller.cluster.datastore.Shard; import org.opendaylight.controller.cluster.datastore.entityownership.messages.CandidateAdded; 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.EntityOwnerSelectionStrategyWrapper; import org.opendaylight.controller.cluster.datastore.entityownership.selectionstrategy.FirstCandidateSelectionStrategy; import org.opendaylight.controller.cluster.datastore.identifiers.ShardIdentifier; import org.opendaylight.controller.cluster.datastore.messages.BatchedModifications; import org.opendaylight.controller.cluster.datastore.messages.PeerDown; import org.opendaylight.controller.cluster.datastore.messages.PeerUp; import org.opendaylight.controller.cluster.datastore.messages.SuccessReply; import org.opendaylight.controller.cluster.datastore.modification.DeleteModification; import org.opendaylight.controller.cluster.datastore.modification.MergeModification; 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; /** * Special Shard for EntityOwnership. * * @author Thomas Pantelis */ class EntityOwnershipShard extends Shard { 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 EntityOwnerSelectionStrategyWrapper defaultEntityOwnerSelectionStrategy; private static DatastoreContext noPersistenceDatastoreContext(DatastoreContext datastoreContext) { return DatastoreContext.newBuilderFrom(datastoreContext).persistent(false).build(); } protected EntityOwnershipShard(Builder builder) { super(builder); this.localMemberName = builder.localMemberName; this.commitCoordinator = new EntityOwnershipShardCommitCoordinator(builder.localMemberName, LOG); this.listenerSupport = new EntityOwnershipListenerSupport(getContext(), persistenceId()); this.defaultEntityOwnerSelectionStrategy = createEntityOwnerSelectionStrategyWrapper(FirstCandidateSelectionStrategy.INSTANCE); for(String peerId: getRaftActorContext().getPeerIds()) { ShardIdentifier shardId = ShardIdentifier.builder().fromShardIdString(peerId).build(); peerIdToMemberNames.put(peerId, shardId.getMemberName()); } } @Override protected void onDatastoreContext(DatastoreContext context) { super.onDatastoreContext(noPersistenceDatastoreContext(context)); } @Override protected void onRecoveryComplete() { super.onRecoveryComplete(); new CandidateListChangeListener(getSelf(), persistenceId()).init(getDataStore()); new EntityOwnerChangeListener(localMemberName, listenerSupport).init(getDataStore()); } @Override public void onReceiveCommand(final Object message) throws Exception { if(message instanceof RegisterCandidateLocal) { onRegisterCandidateLocal((RegisterCandidateLocal) message); } else if(message instanceof UnregisterCandidateLocal) { onUnregisterCandidateLocal((UnregisterCandidateLocal)message); } else if(message instanceof CandidateAdded){ onCandidateAdded((CandidateAdded) message); } else if(message instanceof CandidateRemoved){ onCandidateRemoved((CandidateRemoved) message); } else if(message instanceof PeerDown) { onPeerDown((PeerDown) message); } else if(message instanceof PeerUp) { onPeerUp((PeerUp) message); } else if(message instanceof RegisterListenerLocal) { onRegisterListenerLocal((RegisterListenerLocal)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); } } private void onSelectOwner(SelectOwner selectOwner) { String currentOwner = getCurrentOwner(selectOwner.getEntityPath()); if(Strings.isNullOrEmpty(currentOwner)) { writeNewOwner(selectOwner.getEntityPath(), newOwner(selectOwner.getAllCandidates(), selectOwner.getOwnerSelectionStrategy())); } } private void onRegisterCandidateLocal(RegisterCandidateLocal registerCandidate) { LOG.debug("{}: onRegisterCandidateLocal: {}", persistenceId(), registerCandidate); listenerSupport.setHasCandidateForEntity(registerCandidate.getEntity()); NormalizedNode entityOwners = entityOwnersWithCandidate(registerCandidate.getEntity().getType(), registerCandidate.getEntity().getId(), localMemberName); commitCoordinator.commitModification(new MergeModification(ENTITY_OWNERS_PATH, entityOwners), this); getSender().tell(SuccessReply.INSTANCE, getSelf()); } private void onUnregisterCandidateLocal(UnregisterCandidateLocal unregisterCandidate) { LOG.debug("{}: onUnregisterCandidateLocal: {}", persistenceId(), unregisterCandidate); Entity entity = unregisterCandidate.getEntity(); listenerSupport.unsetHasCandidateForEntity(entity); YangInstanceIdentifier candidatePath = candidatePath(entity.getType(), entity.getId(), localMemberName); commitCoordinator.commitModification(new DeleteModification(candidatePath), this); getSender().tell(SuccessReply.INSTANCE, getSelf()); } private void onRegisterListenerLocal(final RegisterListenerLocal registerListener) { LOG.debug("{}: onRegisterListenerLocal: {}", persistenceId(), registerListener); listenerSupport.addEntityOwnershipListener(registerListener.getEntityType(), registerListener.getListener()); getSender().tell(SuccessReply.INSTANCE, getSelf()); searchForEntitiesOwnedBy(localMemberName, new EntityWalker() { @Override public void onEntity(MapEntryNode entityTypeNode, MapEntryNode entityNode) { Optional> possibleType = entityTypeNode.getChild(ENTITY_TYPE_NODE_ID); String entityType = possibleType.isPresent() ? possibleType.get().getValue().toString() : null; if (registerListener.getEntityType().equals(entityType)) { Entity entity = new Entity(entityType, (YangInstanceIdentifier) entityNode.getChild(ENTITY_ID_NODE_ID).get().getValue()); listenerSupport.notifyEntityOwnershipListener(entity, false, true, true, registerListener.getListener()); } } }); } private void onUnregisterListenerLocal(UnregisterListenerLocal unregisterListener) { LOG.debug("{}: onUnregisterListenerLocal: {}", persistenceId(), unregisterListener); listenerSupport.removeEntityOwnershipListener(unregisterListener.getEntityType(), unregisterListener.getListener()); getSender().tell(SuccessReply.INSTANCE, getSelf()); } void tryCommitModifications(final BatchedModifications modifications) { if(isLeader()) { LOG.debug("{}: Committing BatchedModifications {} locally", persistenceId(), modifications.getTransactionID()); // Note that it's possible the commit won't get consensus and will timeout and not be applied // to the state. However we don't need to retry it in that case b/c it will be committed to // the journal first and, once a majority of followers come back on line and it is replicated, // it will be applied at that point. handleBatchedModificationsLocal(modifications, self()); } else { final ActorSelection leader = getLeader(); if (leader != null) { if(LOG.isDebugEnabled()) { LOG.debug("{}: Sending BatchedModifications {} to leader {}", persistenceId(), modifications.getTransactionID(), leader); } Future future = Patterns.ask(leader, modifications, TimeUnit.SECONDS.toMillis( getDatastoreContext().getShardTransactionCommitTimeoutInSeconds())); Patterns.pipe(future, getContext().dispatcher()).pipeTo(getSelf(), ActorRef.noSender()); } } } boolean hasLeader() { return getLeader() != null && !isIsolatedLeader(); } @Override protected void onStateChanged() { super.onStateChanged(); commitCoordinator.onStateChanged(this, isLeader()); } @Override protected void onLeaderChanged(String oldLeader, String newLeader) { super.onLeaderChanged(oldLeader, newLeader); LOG.debug("{}: onLeaderChanged: oldLeader: {}, newLeader: {}, isLeader: {}", persistenceId(), oldLeader, newLeader, isLeader()); if(isLeader()) { // We were just elected leader. If the old leader is down, select new owners for the entities // owned by the down leader. String oldLeaderMemberName = peerIdToMemberNames.get(oldLeader); LOG.debug("{}: oldLeaderMemberName: {}", persistenceId(), oldLeaderMemberName); if(downPeerMemberNames.contains(oldLeaderMemberName)) { selectNewOwnerForEntitiesOwnedBy(oldLeaderMemberName); } } } private void onCandidateRemoved(CandidateRemoved message) { LOG.debug("{}: onCandidateRemoved: {}", persistenceId(), message); if(isLeader()) { String currentOwner = getCurrentOwner(message.getEntityPath()); if(message.getRemovedCandidate().equals(currentOwner)){ writeNewOwner(message.getEntityPath(), newOwner(message.getRemainingCandidates(), getEntityOwnerElectionStrategyWrapper(message.getEntityPath()))); } } else { // We're not the leader. If the removed candidate is our local member then check if we actually // have a local candidate registered. If we do then we must have been partitioned from the leader // and the leader removed our candidate since the leader can't tell the difference between a // temporary network partition and a node's process actually restarted. So, in that case, re-add // our candidate. if(localMemberName.equals(message.getRemovedCandidate()) && listenerSupport.hasCandidateForEntity(createEntity(message.getEntityPath()))) { LOG.debug("Local candidate member was removed but a local candidate is registered for {}" + " - adding back local candidate", message.getEntityPath()); commitCoordinator.commitModification(new MergeModification( candidatePath(message.getEntityPath(), localMemberName), candidateMapEntry(localMemberName)), this); } } } private EntityOwnerSelectionStrategyWrapper getEntityOwnerElectionStrategyWrapper(YangInstanceIdentifier entityPath) { String entityType = EntityOwnersModel.entityTypeFromEntityPath(entityPath); EntityOwnerSelectionStrategyWrapper entityOwnerSelectionStrategy = ownerSelectionStrategies.get(entityType); if(entityOwnerSelectionStrategy == null){ entityOwnerSelectionStrategy = defaultEntityOwnerSelectionStrategy; ownerSelectionStrategies.put(entityType, entityOwnerSelectionStrategy); } return entityOwnerSelectionStrategy; } private void onCandidateAdded(CandidateAdded message) { if(!isLeader()){ return; } LOG.debug("{}: onCandidateAdded: {}", persistenceId(), message); // Since a node's candidate member is only added by the node itself, we can assume the node is up so // remove it from the downPeerMemberNames. downPeerMemberNames.remove(message.getNewCandidate()); String currentOwner = getCurrentOwner(message.getEntityPath()); if(Strings.isNullOrEmpty(currentOwner)){ EntityOwnerSelectionStrategyWrapper strategy = getEntityOwnerElectionStrategyWrapper(message.getEntityPath()); if(strategy.selectionDelayInMillis() == 0L) { writeNewOwner(message.getEntityPath(), newOwner(message.getAllCandidates(), strategy)); } else { strategy.scheduleOwnerSelection(message.getEntityPath(), message.getAllCandidates()); } } } private void onPeerDown(PeerDown peerDown) { LOG.info("{}: onPeerDown: {}", persistenceId(), peerDown); String downMemberName = peerDown.getMemberName(); if(downPeerMemberNames.add(downMemberName) && isLeader()) { // Remove the down peer as a candidate from all entities. removeCandidateFromEntities(downMemberName); } } private void onPeerUp(PeerUp peerUp) { LOG.debug("{}: onPeerUp: {}", persistenceId(), peerUp); 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), getEntityOwnerElectionStrategyWrapper(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); } private void removeCandidateFromEntities(final String owner) { final BatchedModifications modifications = commitCoordinator.newBatchedModifications(); searchForEntities(new EntityWalker() { @Override public void onEntity(MapEntryNode entityTypeNode, MapEntryNode entityNode) { if (hasCandidate(entityNode, owner)) { YangInstanceIdentifier entityId = (YangInstanceIdentifier) entityNode.getIdentifier().getKeyValues().get(ENTITY_ID_QNAME); YangInstanceIdentifier candidatePath = candidatePath( entityTypeNode.getIdentifier().getKeyValues().get(ENTITY_TYPE_QNAME).toString(), entityId, owner); LOG.info("{}: Found entity {}, removing candidate {}, path {}", persistenceId(), entityId, owner, candidatePath); modifications.addModification(new DeleteModification(candidatePath)); } } }); commitCoordinator.commitModifications(modifications, this); } private static boolean hasCandidate(MapEntryNode entity, String candidateName) { 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()) { return; } for(MapEntryNode entityType: ((MapNode) possibleEntityTypes.get()).getValue()) { Optional> possibleEntities = entityType.getChild(ENTITY_NODE_ID); if(!possibleEntities.isPresent()) { continue; // shouldn't happen but handle anyway } for(MapEntryNode entity: ((MapNode) possibleEntities.get()).getValue()) { walker.onEntity(entityType, entity); } } } 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); commitCoordinator.commitModification(new WriteModification(entityPath.node(ENTITY_OWNER_QNAME), ImmutableNodes.leafNode(ENTITY_OWNER_NODE_ID, newOwner)), this); } private String newOwner(Collection candidates, EntityOwnerSelectionStrategy ownerSelectionStrategy) { Collection viableCandidates = getViableCandidates(candidates); if(viableCandidates.size() == 0){ return ""; } return ownerSelectionStrategy.newOwner(viableCandidates); } private Collection getViableCandidates(Collection candidates) { Collection viableCandidates = new ArrayList<>(); for (String candidate : candidates) { if (!downPeerMemberNames.contains(candidate)) { viableCandidates.add(candidate); } } return viableCandidates; } private String getCurrentOwner(YangInstanceIdentifier entityId) { Optional> optionalEntityOwner = getDataStore().readNode(entityId.node(ENTITY_OWNER_QNAME)); if(optionalEntityOwner.isPresent()){ return optionalEntityOwner.get().getValue().toString(); } return null; } private static interface EntityWalker { void onEntity(MapEntryNode entityTypeNode, MapEntryNode entityNode); } private EntityOwnerSelectionStrategyWrapper createEntityOwnerSelectionStrategyWrapper(EntityOwnerSelectionStrategy entityOwnerSelectionStrategy){ return new EntityOwnerSelectionStrategyWrapper(context().system().scheduler(), self(), context().system().dispatcher(), entityOwnerSelectionStrategy); } @VisibleForTesting void addEntityOwnerSelectionStrategy(String entityType, Class ownerSelectionStrategyClass){ try { EntityOwnerSelectionStrategyWrapper strategy = createEntityOwnerSelectionStrategyWrapper(ownerSelectionStrategyClass.newInstance()); ownerSelectionStrategies.put(entityType, strategy); } catch (InstantiationException | IllegalAccessException e) { LOG.error("Exception occurred when adding election strategy", e); } } public static Builder newBuilder() { return new Builder(); } static class Builder extends Shard.AbstractBuilder { private String localMemberName; protected Builder() { super(EntityOwnershipShard.class); } Builder localMemberName(String localMemberName) { checkSealed(); this.localMemberName = localMemberName; return this; } @Override protected void verify() { super.verify(); Preconditions.checkNotNull(localMemberName, "localMemberName should not be null"); } } }