Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2016-present Open Networking Foundation |
Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | package org.onosproject.store.cluster.impl; |
| 17 | |
Jon Hall | 7a8bfc6 | 2016-05-26 17:59:04 -0700 | [diff] [blame] | 18 | import static org.onlab.util.Tools.groupedThreads; |
Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 19 | import static org.slf4j.LoggerFactory.getLogger; |
| 20 | |
Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 21 | import java.util.Map; |
Madan Jampani | 78be249 | 2016-06-03 23:27:07 -0700 | [diff] [blame] | 22 | import java.util.Objects; |
Jon Hall | 7a8bfc6 | 2016-05-26 17:59:04 -0700 | [diff] [blame] | 23 | import java.util.concurrent.ExecutorService; |
| 24 | import java.util.concurrent.Executors; |
Madan Jampani | 78be249 | 2016-06-03 23:27:07 -0700 | [diff] [blame] | 25 | import java.util.function.Consumer; |
Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 26 | |
Jon Hall | 7a8bfc6 | 2016-05-26 17:59:04 -0700 | [diff] [blame] | 27 | import com.google.common.collect.Maps; |
Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 28 | import org.apache.felix.scr.annotations.Activate; |
| 29 | import org.apache.felix.scr.annotations.Component; |
| 30 | import org.apache.felix.scr.annotations.Deactivate; |
| 31 | import org.apache.felix.scr.annotations.Reference; |
| 32 | import org.apache.felix.scr.annotations.ReferenceCardinality; |
| 33 | import org.apache.felix.scr.annotations.Service; |
| 34 | import org.onosproject.cluster.ClusterService; |
Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 35 | import org.onosproject.cluster.Leadership; |
| 36 | import org.onosproject.cluster.LeadershipEvent; |
| 37 | import org.onosproject.cluster.LeadershipStore; |
| 38 | import org.onosproject.cluster.LeadershipStoreDelegate; |
| 39 | import org.onosproject.cluster.NodeId; |
Madan Jampani | 78be249 | 2016-06-03 23:27:07 -0700 | [diff] [blame] | 40 | import org.onosproject.event.Change; |
Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 41 | import org.onosproject.store.AbstractStore; |
Jon Hall | 7a8bfc6 | 2016-05-26 17:59:04 -0700 | [diff] [blame] | 42 | import org.onosproject.store.service.DistributedPrimitive.Status; |
Madan Jampani | 78be249 | 2016-06-03 23:27:07 -0700 | [diff] [blame] | 43 | import org.onosproject.store.service.LeaderElector; |
Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 44 | import org.onosproject.store.service.StorageService; |
Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 45 | import org.slf4j.Logger; |
| 46 | |
Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 47 | /** |
Madan Jampani | 78be249 | 2016-06-03 23:27:07 -0700 | [diff] [blame] | 48 | * Implementation of {@code LeadershipStore} that makes use of a {@link LeaderElector} |
| 49 | * primitive. |
Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 50 | */ |
| 51 | @Service |
Sho SHIMIZU | 5c396e3 | 2016-08-12 15:19:12 -0700 | [diff] [blame] | 52 | @Component(immediate = true) |
Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 53 | public class DistributedLeadershipStore |
| 54 | extends AbstractStore<LeadershipEvent, LeadershipStoreDelegate> |
| 55 | implements LeadershipStore { |
| 56 | |
Madan Jampani | 78be249 | 2016-06-03 23:27:07 -0700 | [diff] [blame] | 57 | private final Logger log = getLogger(getClass()); |
Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 58 | |
| 59 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 60 | protected ClusterService clusterService; |
| 61 | |
| 62 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 63 | protected StorageService storageService; |
| 64 | |
Jon Hall | 7a8bfc6 | 2016-05-26 17:59:04 -0700 | [diff] [blame] | 65 | private ExecutorService statusChangeHandler; |
Madan Jampani | 78be249 | 2016-06-03 23:27:07 -0700 | [diff] [blame] | 66 | private NodeId localNodeId; |
| 67 | private LeaderElector leaderElector; |
Jon Hall | 7a8bfc6 | 2016-05-26 17:59:04 -0700 | [diff] [blame] | 68 | private final Map<String, Leadership> localLeaderCache = Maps.newConcurrentMap(); |
Madan Jampani | 72282af | 2016-02-23 14:23:52 -0800 | [diff] [blame] | 69 | |
Madan Jampani | 78be249 | 2016-06-03 23:27:07 -0700 | [diff] [blame] | 70 | private final Consumer<Change<Leadership>> leadershipChangeListener = |
| 71 | change -> { |
| 72 | Leadership oldValue = change.oldValue(); |
| 73 | Leadership newValue = change.newValue(); |
| 74 | boolean leaderChanged = !Objects.equals(oldValue.leader(), newValue.leader()); |
| 75 | boolean candidatesChanged = !Objects.equals(oldValue.candidates(), newValue.candidates()); |
Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 76 | LeadershipEvent.Type eventType = null; |
| 77 | if (leaderChanged && candidatesChanged) { |
| 78 | eventType = LeadershipEvent.Type.LEADER_AND_CANDIDATES_CHANGED; |
| 79 | } |
| 80 | if (leaderChanged && !candidatesChanged) { |
| 81 | eventType = LeadershipEvent.Type.LEADER_CHANGED; |
| 82 | } |
| 83 | if (!leaderChanged && candidatesChanged) { |
| 84 | eventType = LeadershipEvent.Type.CANDIDATES_CHANGED; |
| 85 | } |
Madan Jampani | 78be249 | 2016-06-03 23:27:07 -0700 | [diff] [blame] | 86 | notifyDelegate(new LeadershipEvent(eventType, change.newValue())); |
Jon Hall | 7a8bfc6 | 2016-05-26 17:59:04 -0700 | [diff] [blame] | 87 | // Update local cache of currently held leaderships |
| 88 | if (Objects.equals(newValue.leaderNodeId(), localNodeId)) { |
| 89 | localLeaderCache.put(newValue.topic(), newValue); |
| 90 | } else { |
| 91 | localLeaderCache.remove(newValue.topic()); |
| 92 | } |
Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 93 | }; |
| 94 | |
Jon Hall | 7a8bfc6 | 2016-05-26 17:59:04 -0700 | [diff] [blame] | 95 | private final Consumer<Status> clientStatusListener = status -> |
| 96 | statusChangeHandler.execute(() -> handleStatusChange(status)); |
| 97 | |
| 98 | private void handleStatusChange(Status status) { |
| 99 | // Notify mastership Service of disconnect and reconnect |
| 100 | if (status == Status.ACTIVE) { |
| 101 | // Service Restored |
| 102 | localLeaderCache.forEach((topic, leadership) -> leaderElector.run(topic, localNodeId)); |
| 103 | leaderElector.getLeaderships().forEach((topic, leadership) -> |
| 104 | notifyDelegate(new LeadershipEvent(LeadershipEvent.Type.SERVICE_RESTORED, leadership))); |
| 105 | } else if (status == Status.SUSPENDED) { |
| 106 | // Service Suspended |
| 107 | localLeaderCache.forEach((topic, leadership) -> |
| 108 | notifyDelegate(new LeadershipEvent(LeadershipEvent.Type.SERVICE_DISRUPTED, leadership))); |
| 109 | } else { |
| 110 | // Should be only inactive state |
| 111 | return; |
| 112 | } |
| 113 | } |
| 114 | |
| 115 | |
Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 116 | @Activate |
| 117 | public void activate() { |
Jon Hall | 7a8bfc6 | 2016-05-26 17:59:04 -0700 | [diff] [blame] | 118 | statusChangeHandler = Executors.newSingleThreadExecutor( |
| 119 | groupedThreads("onos/store/dist/cluster/leadership", "status-change-handler", log)); |
Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 120 | localNodeId = clusterService.getLocalNode().id(); |
Madan Jampani | 78be249 | 2016-06-03 23:27:07 -0700 | [diff] [blame] | 121 | leaderElector = storageService.leaderElectorBuilder() |
| 122 | .withName("onos-leadership-elections") |
| 123 | .build() |
| 124 | .asLeaderElector(); |
| 125 | leaderElector.addChangeListener(leadershipChangeListener); |
Jon Hall | 7a8bfc6 | 2016-05-26 17:59:04 -0700 | [diff] [blame] | 126 | leaderElector.addStatusChangeListener(clientStatusListener); |
Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 127 | log.info("Started"); |
| 128 | } |
| 129 | |
| 130 | @Deactivate |
| 131 | public void deactivate() { |
Madan Jampani | 78be249 | 2016-06-03 23:27:07 -0700 | [diff] [blame] | 132 | leaderElector.removeChangeListener(leadershipChangeListener); |
Jon Hall | 7a8bfc6 | 2016-05-26 17:59:04 -0700 | [diff] [blame] | 133 | leaderElector.removeStatusChangeListener(clientStatusListener); |
| 134 | statusChangeHandler.shutdown(); |
Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 135 | log.info("Stopped"); |
| 136 | } |
| 137 | |
| 138 | @Override |
| 139 | public Leadership addRegistration(String topic) { |
Madan Jampani | 78be249 | 2016-06-03 23:27:07 -0700 | [diff] [blame] | 140 | return leaderElector.run(topic, localNodeId); |
Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 141 | } |
| 142 | |
| 143 | @Override |
| 144 | public void removeRegistration(String topic) { |
Madan Jampani | 78be249 | 2016-06-03 23:27:07 -0700 | [diff] [blame] | 145 | leaderElector.withdraw(topic); |
Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 146 | } |
| 147 | |
| 148 | @Override |
| 149 | public void removeRegistration(NodeId nodeId) { |
Madan Jampani | 78be249 | 2016-06-03 23:27:07 -0700 | [diff] [blame] | 150 | leaderElector.evict(nodeId); |
Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 151 | } |
| 152 | |
| 153 | @Override |
| 154 | public boolean moveLeadership(String topic, NodeId toNodeId) { |
Madan Jampani | 78be249 | 2016-06-03 23:27:07 -0700 | [diff] [blame] | 155 | return leaderElector.anoint(topic, toNodeId); |
Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 156 | } |
| 157 | |
| 158 | @Override |
| 159 | public boolean makeTopCandidate(String topic, NodeId nodeId) { |
Madan Jampani | 78be249 | 2016-06-03 23:27:07 -0700 | [diff] [blame] | 160 | return leaderElector.promote(topic, nodeId); |
Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 161 | } |
| 162 | |
| 163 | @Override |
| 164 | public Leadership getLeadership(String topic) { |
Madan Jampani | 78be249 | 2016-06-03 23:27:07 -0700 | [diff] [blame] | 165 | return leaderElector.getLeadership(topic); |
Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 166 | } |
| 167 | |
| 168 | @Override |
| 169 | public Map<String, Leadership> getLeaderships() { |
Madan Jampani | 78be249 | 2016-06-03 23:27:07 -0700 | [diff] [blame] | 170 | return leaderElector.getLeaderships(); |
Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 171 | } |
| 172 | } |