*/
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 java.util.Map;
import java.util.Set;
import java.util.concurrent.TimeUnit;
+import org.opendaylight.controller.cluster.access.concepts.MemberName;
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.modification.DeleteModification;
import org.opendaylight.controller.cluster.datastore.modification.MergeModification;
import org.opendaylight.controller.cluster.datastore.modification.WriteModification;
+import org.opendaylight.controller.cluster.raft.RaftState;
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;
* @author Thomas Pantelis
*/
class EntityOwnershipShard extends Shard {
- private final String localMemberName;
+ private final MemberName localMemberName;
private final EntityOwnershipShardCommitCoordinator commitCoordinator;
private final EntityOwnershipListenerSupport listenerSupport;
- private final Set<String> downPeerMemberNames = new HashSet<>();
- private final Map<String, String> peerIdToMemberNames = new HashMap<>();
+ private final Set<MemberName> downPeerMemberNames = new HashSet<>();
+ private final Map<String, MemberName> peerIdToMemberNames = new HashMap<>();
private final EntityOwnerSelectionStrategyConfig strategyConfig;
private final Map<YangInstanceIdentifier, Cancellable> entityToScheduledOwnershipTask = new HashMap<>();
private final EntityOwnershipStatistics entityOwnershipStatistics;
}
@Override
- public void onReceiveCommand(final Object message) throws Exception {
+ public void handleNonRaftCommand(final Object message) {
if(message instanceof RegisterCandidateLocal) {
onRegisterCandidateLocal((RegisterCandidateLocal) message);
} else if(message instanceof UnregisterCandidateLocal) {
} else if(message instanceof SelectOwner) {
onSelectOwner((SelectOwner) message);
} else if(!commitCoordinator.handleMessage(message, this)) {
- super.onReceiveCommand(message);
+ super.handleNonRaftCommand(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(selectOwner.getAllCandidates(),
+ writeNewOwner(selectOwner.getEntityPath(), newOwner(currentOwner, selectOwner.getAllCandidates(),
entityOwnershipStatistics.byEntityType(entityType),
selectOwner.getOwnerSelectionStrategy()));
listenerSupport.setHasCandidateForEntity(registerCandidate.getEntity());
NormalizedNode<?, ?> entityOwners = entityOwnersWithCandidate(registerCandidate.getEntity().getType(),
- registerCandidate.getEntity().getId(), localMemberName);
+ registerCandidate.getEntity().getId(), localMemberName.getName());
commitCoordinator.commitModification(new MergeModification(ENTITY_OWNERS_PATH, entityOwners), this);
getSender().tell(SuccessReply.INSTANCE, getSelf());
Entity entity = unregisterCandidate.getEntity();
listenerSupport.unsetHasCandidateForEntity(entity);
- YangInstanceIdentifier candidatePath = candidatePath(entity.getType(), entity.getId(), localMemberName);
+ YangInstanceIdentifier candidatePath = candidatePath(entity.getType(), entity.getId(), localMemberName.getName());
commitCoordinator.commitModification(new DeleteModification(candidatePath), this);
getSender().tell(SuccessReply.INSTANCE, getSelf());
getSender().tell(SuccessReply.INSTANCE, getSelf());
- searchForEntitiesOwnedBy(localMemberName, new EntityWalker() {
- @Override
- public void onEntity(MapEntryNode entityTypeNode, MapEntryNode entityNode) {
- Optional<DataContainerChild<? extends PathArgument, ?>> 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());
+ searchForEntities((entityTypeNode, entityNode) -> {
+ Optional<DataContainerChild<?, ?>> 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<DataContainerChild<?, ?>> possibleOwner = entityNode.getChild(ENTITY_OWNER_NODE_ID);
+ if (possibleOwner.isPresent()) {
+ isOwner = localMemberName.getName().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, isOwner, hasOwner,
+ registerListener.getListener());
}
});
}
return getLeader() != null && !isIsolatedLeader();
}
+ /**
+ * Determine if we are in jeopardy based on observed RAFT state.
+ */
+ private static boolean inJeopardy(final RaftState state) {
+ switch (state) {
+ case Candidate:
+ case Follower:
+ case Leader:
+ return false;
+ case IsolatedLeader:
+ return true;
+ }
+ throw new IllegalStateException("Unsupported RAFT state " + state);
+ }
+
+ private void notifyAllListeners() {
+ searchForEntities((entityTypeNode, entityNode) -> {
+ Optional<DataContainerChild<?, ?>> possibleType = entityTypeNode.getChild(ENTITY_TYPE_NODE_ID);
+ if (possibleType.isPresent()) {
+ final boolean hasOwner;
+ final boolean isOwner;
+
+ Optional<DataContainerChild<?, ?>> possibleOwner = entityNode.getChild(ENTITY_OWNER_NODE_ID);
+ if (possibleOwner.isPresent()) {
+ isOwner = localMemberName.getName().equals(possibleOwner.get().getValue().toString());
+ hasOwner = true;
+ } else {
+ isOwner = false;
+ hasOwner = false;
+ }
+
+ Entity entity = new Entity(possibleType.get().getValue().toString(),
+ (YangInstanceIdentifier) entityNode.getChild(ENTITY_ID_NODE_ID).get().getValue());
+
+ listenerSupport.notifyEntityOwnershipListeners(entity, isOwner, isOwner, hasOwner);
+ }
+ });
+ }
+
@Override
protected void onStateChanged() {
super.onStateChanged();
- commitCoordinator.onStateChanged(this, isLeader());
+ boolean isLeader = isLeader();
+ LOG.debug("{}: onStateChanged: isLeader: {}, hasLeader: {}", persistenceId(), isLeader, hasLeader());
+
+ // Examine current RAFT state to see if we are in jeopardy, potentially notifying all listeners
+ final boolean inJeopardy = inJeopardy(getRaftState());
+ final boolean wasInJeopardy = listenerSupport.setInJeopardy(inJeopardy);
+ if (inJeopardy != wasInJeopardy) {
+ LOG.debug("{}: {} jeopardy state, notifying all listeners", persistenceId(),
+ inJeopardy ? "entered" : "left");
+ notifyAllListeners();
+ }
+
+ 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());
-
- if(isLeader()) {
- // We were just elected leader. If the old leader is down, select new owners for the entities
- // owned by the down leader.
+ newLeader, isLeader);
- String oldLeaderMemberName = peerIdToMemberNames.get(oldLeader);
+ if (isLeader) {
- LOG.debug("{}: oldLeaderMemberName: {}", persistenceId(), oldLeaderMemberName);
+ // 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();
- if(downPeerMemberNames.contains(oldLeaderMemberName)) {
- selectNewOwnerForEntitiesOwnedBy(oldLeaderMemberName);
+ // Remove the candidates for all members that are known to be down. In a cluster which has greater than
+ // 3 nodes it is possible for a some node beside the leader being down when the leadership transitions
+ // it makes sense to use this event to remove all the candidates for those downed nodes
+ for (MemberName downPeerName : downPeerMemberNames) {
+ removeCandidateFromEntities(downPeerName);
}
+ } 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);
}
}
if(message.getRemovedCandidate().equals(currentOwner) || message.getRemainingCandidates().size() == 0){
String entityType = EntityOwnersModel.entityTypeFromEntityPath(message.getEntityPath());
writeNewOwner(message.getEntityPath(),
- newOwner(message.getRemainingCandidates(), entityOwnershipStatistics.byEntityType(entityType),
+ newOwner(currentOwner, message.getRemainingCandidates(), entityOwnershipStatistics.byEntityType(entityType),
getEntityOwnerElectionStrategy(message.getEntityPath())));
}
} else {
// 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()) &&
+ if(localMemberName.getName().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);
+ candidatePath(message.getEntityPath(), localMemberName.getName()),
+ candidateMapEntry(localMemberName.getName())), this);
}
}
}
private EntityOwnerSelectionStrategy getEntityOwnerElectionStrategy(YangInstanceIdentifier entityPath) {
final String entityType = EntityOwnersModel.entityTypeFromEntityPath(entityPath);
- return strategyConfig.createStrategy(entityType);
+ return strategyConfig.createStrategy(entityType, entityOwnershipStatistics.byEntityType(entityType));
}
private void onCandidateAdded(CandidateAdded message) {
// remove it from the downPeerMemberNames.
downPeerMemberNames.remove(message.getNewCandidate());
- String currentOwner = getCurrentOwner(message.getEntityPath());
- EntityOwnerSelectionStrategy strategy = getEntityOwnerElectionStrategy(message.getEntityPath());
- if(Strings.isNullOrEmpty(currentOwner)){
+ 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, currentOwner = {}", persistenceId(), strategy, currentOwner);
+
+ if(!message.getAllCandidates().contains(currentOwner)){
if(strategy.getSelectionDelayInMillis() == 0L) {
- String entityType = EntityOwnersModel.entityTypeFromEntityPath(message.getEntityPath());
- writeNewOwner(message.getEntityPath(), newOwner(message.getAllCandidates(),
+ 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 {
scheduleOwnerSelection(message.getEntityPath(), message.getAllCandidates(), strategy);
private void onPeerDown(PeerDown peerDown) {
LOG.info("{}: onPeerDown: {}", persistenceId(), peerDown);
- String downMemberName = peerDown.getMemberName();
+ MemberName downMemberName = peerDown.getMemberName();
if(downPeerMemberNames.add(downMemberName) && isLeader()) {
// Remove the down peer as a candidate from all entities.
removeCandidateFromEntities(downMemberName);
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();
-
- String entityType = EntityOwnersModel.entityTypeFromEntityPath(entityPath);
-
- Object newOwner = newOwner(getCandidateNames(entityNode),
- entityOwnershipStatistics.byEntityType(entityType),
- 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) {
+ private void removeCandidateFromEntities(final MemberName 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));
- }
+ searchForEntities((entityTypeNode, 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.getName());
+
+ 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<NormalizedNode<?, ?>> 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<DataContainerChild<? extends PathArgument, ?>> possibleOwner =
- entityNode.getChild(ENTITY_OWNER_NODE_ID);
- if (possibleOwner.isPresent() && owner.equals(possibleOwner.get().getValue().toString())) {
- walker.onEntity(entityTypeNode, entityNode);
- }
- }
- });
+ private static boolean hasCandidate(MapEntryNode entity, MemberName candidateName) {
+ return ((MapNode)entity.getChild(CANDIDATE_NODE_ID).get()).getChild(candidateNodeKey(candidateName.getName()))
+ .isPresent();
}
private void searchForEntities(EntityWalker walker) {
}
for(MapEntryNode entityType: ((MapNode) possibleEntityTypes.get()).getValue()) {
- Optional<DataContainerChild<? extends PathArgument, ?>> possibleEntities =
- entityType.getChild(ENTITY_NODE_ID);
+ Optional<DataContainerChild<?, ?>> 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()) {
}
}
- private Collection<String> getCandidateNames(MapEntryNode entity) {
- Collection<MapEntryNode> candidates = ((MapNode) entity.getChild(CANDIDATE_NODE_ID).get()).getValue();
- Collection<String> 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);
*/
public void scheduleOwnerSelection(YangInstanceIdentifier entityPath, Collection<String> allCandidates,
EntityOwnerSelectionStrategy strategy){
- Cancellable lastScheduledTask = entityToScheduledOwnershipTask.get(entityPath);
- if(lastScheduledTask != null && !lastScheduledTask.isCancelled()){
- lastScheduledTask.cancel();
- }
- lastScheduledTask = context().system().scheduler().scheduleOnce(
+ 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 String newOwner(Collection<String> candidates, Map<String, Long> statistics, EntityOwnerSelectionStrategy ownerSelectionStrategy) {
+ private void cancelOwnerSelectionTask(YangInstanceIdentifier entityPath){
+ final Cancellable lastScheduledTask = entityToScheduledOwnershipTask.get(entityPath);
+ if(lastScheduledTask != null && !lastScheduledTask.isCancelled()){
+ lastScheduledTask.cancel();
+ }
+ }
+
+ private String newOwner(String currentOwner, Collection<String> candidates, Map<String, Long> statistics, EntityOwnerSelectionStrategy ownerSelectionStrategy) {
Collection<String> viableCandidates = getViableCandidates(candidates);
if(viableCandidates.size() == 0){
return "";
}
- return ownerSelectionStrategy.newOwner(viableCandidates, statistics);
+ return ownerSelectionStrategy.newOwner(currentOwner, viableCandidates);
}
private Collection<String> getViableCandidates(Collection<String> candidates) {
}
static class Builder extends Shard.AbstractBuilder<Builder, EntityOwnershipShard> {
- private String localMemberName;
+ private MemberName localMemberName;
private EntityOwnerSelectionStrategyConfig ownerSelectionStrategyConfig;
protected Builder() {
super(EntityOwnershipShard.class);
}
- Builder localMemberName(String localMemberName) {
+ Builder localMemberName(MemberName localMemberName) {
checkSealed();
this.localMemberName = localMemberName;
return this;
Code Review / controller.git / blobdiff