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 | |
Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 18 | import java.util.Map; |
Madan Jampani | 78be249 | 2016-06-03 23:27:07 -0700 | [diff] [blame] | 19 | import java.util.Objects; |
Jon Hall | 7a8bfc6 | 2016-05-26 17:59:04 -0700 | [diff] [blame] | 20 | import java.util.concurrent.ExecutorService; |
| 21 | import java.util.concurrent.Executors; |
Madan Jampani | 78be249 | 2016-06-03 23:27:07 -0700 | [diff] [blame] | 22 | import java.util.function.Consumer; |
Jordan Halterman | 980a8c1 | 2017-09-22 18:01:19 -0700 | [diff] [blame^] | 23 | import java.util.stream.Collectors; |
Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 24 | |
Jon Hall | 7a8bfc6 | 2016-05-26 17:59:04 -0700 | [diff] [blame] | 25 | import com.google.common.collect.Maps; |
Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 26 | import org.apache.felix.scr.annotations.Activate; |
| 27 | import org.apache.felix.scr.annotations.Component; |
| 28 | import org.apache.felix.scr.annotations.Deactivate; |
| 29 | import org.apache.felix.scr.annotations.Reference; |
| 30 | import org.apache.felix.scr.annotations.ReferenceCardinality; |
| 31 | import org.apache.felix.scr.annotations.Service; |
| 32 | import org.onosproject.cluster.ClusterService; |
Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 33 | import org.onosproject.cluster.Leadership; |
| 34 | import org.onosproject.cluster.LeadershipEvent; |
| 35 | import org.onosproject.cluster.LeadershipStore; |
| 36 | import org.onosproject.cluster.LeadershipStoreDelegate; |
| 37 | import org.onosproject.cluster.NodeId; |
Jordan Halterman | 980a8c1 | 2017-09-22 18:01:19 -0700 | [diff] [blame^] | 38 | import org.onosproject.core.Version; |
| 39 | import org.onosproject.core.VersionService; |
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; |
Jordan Halterman | 980a8c1 | 2017-09-22 18:01:19 -0700 | [diff] [blame^] | 43 | import org.onosproject.store.service.CoordinationService; |
Madan Jampani | 78be249 | 2016-06-03 23:27:07 -0700 | [diff] [blame] | 44 | import org.onosproject.store.service.LeaderElector; |
Jordan Halterman | 980a8c1 | 2017-09-22 18:01:19 -0700 | [diff] [blame^] | 45 | import org.onosproject.upgrade.UpgradeEvent; |
| 46 | import org.onosproject.upgrade.UpgradeEventListener; |
| 47 | import org.onosproject.upgrade.UpgradeService; |
Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 48 | import org.slf4j.Logger; |
| 49 | |
Jordan Halterman | 980a8c1 | 2017-09-22 18:01:19 -0700 | [diff] [blame^] | 50 | import static org.onlab.util.Tools.groupedThreads; |
| 51 | import static org.slf4j.LoggerFactory.getLogger; |
| 52 | |
Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 53 | /** |
Madan Jampani | 78be249 | 2016-06-03 23:27:07 -0700 | [diff] [blame] | 54 | * Implementation of {@code LeadershipStore} that makes use of a {@link LeaderElector} |
| 55 | * primitive. |
Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 56 | */ |
| 57 | @Service |
Sho SHIMIZU | 5c396e3 | 2016-08-12 15:19:12 -0700 | [diff] [blame] | 58 | @Component(immediate = true) |
Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 59 | public class DistributedLeadershipStore |
| 60 | extends AbstractStore<LeadershipEvent, LeadershipStoreDelegate> |
| 61 | implements LeadershipStore { |
| 62 | |
Jordan Halterman | 980a8c1 | 2017-09-22 18:01:19 -0700 | [diff] [blame^] | 63 | private static final char VERSION_SEP = '|'; |
| 64 | |
Madan Jampani | 78be249 | 2016-06-03 23:27:07 -0700 | [diff] [blame] | 65 | private final Logger log = getLogger(getClass()); |
Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 66 | |
| 67 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 68 | protected ClusterService clusterService; |
| 69 | |
| 70 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
Jordan Halterman | 980a8c1 | 2017-09-22 18:01:19 -0700 | [diff] [blame^] | 71 | protected CoordinationService storageService; |
| 72 | |
| 73 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 74 | protected VersionService versionService; |
| 75 | |
| 76 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 77 | protected UpgradeService upgradeService; |
Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 78 | |
Jon Hall | 7a8bfc6 | 2016-05-26 17:59:04 -0700 | [diff] [blame] | 79 | private ExecutorService statusChangeHandler; |
Madan Jampani | 78be249 | 2016-06-03 23:27:07 -0700 | [diff] [blame] | 80 | private NodeId localNodeId; |
| 81 | private LeaderElector leaderElector; |
Jon Hall | 7a8bfc6 | 2016-05-26 17:59:04 -0700 | [diff] [blame] | 82 | private final Map<String, Leadership> localLeaderCache = Maps.newConcurrentMap(); |
Jordan Halterman | 980a8c1 | 2017-09-22 18:01:19 -0700 | [diff] [blame^] | 83 | private final UpgradeEventListener upgradeListener = new InternalUpgradeEventListener(); |
Madan Jampani | 72282af | 2016-02-23 14:23:52 -0800 | [diff] [blame] | 84 | |
Madan Jampani | 78be249 | 2016-06-03 23:27:07 -0700 | [diff] [blame] | 85 | private final Consumer<Change<Leadership>> leadershipChangeListener = |
| 86 | change -> { |
| 87 | Leadership oldValue = change.oldValue(); |
| 88 | Leadership newValue = change.newValue(); |
Jordan Halterman | 980a8c1 | 2017-09-22 18:01:19 -0700 | [diff] [blame^] | 89 | |
| 90 | // If the topic is not relevant to this version, skip the event. |
| 91 | if (!isLocalTopic(newValue.topic())) { |
| 92 | return; |
| 93 | } |
| 94 | |
Madan Jampani | 78be249 | 2016-06-03 23:27:07 -0700 | [diff] [blame] | 95 | boolean leaderChanged = !Objects.equals(oldValue.leader(), newValue.leader()); |
| 96 | boolean candidatesChanged = !Objects.equals(oldValue.candidates(), newValue.candidates()); |
Jordan Halterman | 980a8c1 | 2017-09-22 18:01:19 -0700 | [diff] [blame^] | 97 | |
Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 98 | LeadershipEvent.Type eventType = null; |
| 99 | if (leaderChanged && candidatesChanged) { |
| 100 | eventType = LeadershipEvent.Type.LEADER_AND_CANDIDATES_CHANGED; |
| 101 | } |
| 102 | if (leaderChanged && !candidatesChanged) { |
| 103 | eventType = LeadershipEvent.Type.LEADER_CHANGED; |
| 104 | } |
| 105 | if (!leaderChanged && candidatesChanged) { |
| 106 | eventType = LeadershipEvent.Type.CANDIDATES_CHANGED; |
| 107 | } |
Jordan Halterman | 980a8c1 | 2017-09-22 18:01:19 -0700 | [diff] [blame^] | 108 | notifyDelegate(new LeadershipEvent(eventType, new Leadership( |
| 109 | parseTopic(change.newValue().topic()), |
| 110 | change.newValue().leader(), |
| 111 | change.newValue().candidates()))); |
Jon Hall | 7a8bfc6 | 2016-05-26 17:59:04 -0700 | [diff] [blame] | 112 | // Update local cache of currently held leaderships |
| 113 | if (Objects.equals(newValue.leaderNodeId(), localNodeId)) { |
| 114 | localLeaderCache.put(newValue.topic(), newValue); |
| 115 | } else { |
| 116 | localLeaderCache.remove(newValue.topic()); |
| 117 | } |
Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 118 | }; |
| 119 | |
Jon Hall | 7a8bfc6 | 2016-05-26 17:59:04 -0700 | [diff] [blame] | 120 | private final Consumer<Status> clientStatusListener = status -> |
| 121 | statusChangeHandler.execute(() -> handleStatusChange(status)); |
| 122 | |
| 123 | private void handleStatusChange(Status status) { |
| 124 | // Notify mastership Service of disconnect and reconnect |
| 125 | if (status == Status.ACTIVE) { |
| 126 | // Service Restored |
| 127 | localLeaderCache.forEach((topic, leadership) -> leaderElector.run(topic, localNodeId)); |
| 128 | leaderElector.getLeaderships().forEach((topic, leadership) -> |
Jordan Halterman | 980a8c1 | 2017-09-22 18:01:19 -0700 | [diff] [blame^] | 129 | notifyDelegate(new LeadershipEvent( |
| 130 | LeadershipEvent.Type.SERVICE_RESTORED, |
| 131 | new Leadership( |
| 132 | parseTopic(leadership.topic()), |
| 133 | leadership.leader(), |
| 134 | leadership.candidates())))); |
Jon Hall | 7a8bfc6 | 2016-05-26 17:59:04 -0700 | [diff] [blame] | 135 | } else if (status == Status.SUSPENDED) { |
| 136 | // Service Suspended |
| 137 | localLeaderCache.forEach((topic, leadership) -> |
Jordan Halterman | 980a8c1 | 2017-09-22 18:01:19 -0700 | [diff] [blame^] | 138 | notifyDelegate(new LeadershipEvent( |
| 139 | LeadershipEvent.Type.SERVICE_DISRUPTED, |
| 140 | new Leadership( |
| 141 | parseTopic(leadership.topic()), |
| 142 | leadership.leader(), |
| 143 | leadership.candidates())))); |
Jon Hall | 7a8bfc6 | 2016-05-26 17:59:04 -0700 | [diff] [blame] | 144 | } else { |
| 145 | // Should be only inactive state |
| 146 | return; |
| 147 | } |
| 148 | } |
| 149 | |
Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 150 | @Activate |
| 151 | public void activate() { |
Jon Hall | 7a8bfc6 | 2016-05-26 17:59:04 -0700 | [diff] [blame] | 152 | statusChangeHandler = Executors.newSingleThreadExecutor( |
| 153 | groupedThreads("onos/store/dist/cluster/leadership", "status-change-handler", log)); |
Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 154 | localNodeId = clusterService.getLocalNode().id(); |
Madan Jampani | 78be249 | 2016-06-03 23:27:07 -0700 | [diff] [blame] | 155 | leaderElector = storageService.leaderElectorBuilder() |
| 156 | .withName("onos-leadership-elections") |
| 157 | .build() |
| 158 | .asLeaderElector(); |
| 159 | leaderElector.addChangeListener(leadershipChangeListener); |
Jon Hall | 7a8bfc6 | 2016-05-26 17:59:04 -0700 | [diff] [blame] | 160 | leaderElector.addStatusChangeListener(clientStatusListener); |
Jordan Halterman | 980a8c1 | 2017-09-22 18:01:19 -0700 | [diff] [blame^] | 161 | upgradeService.addListener(upgradeListener); |
Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 162 | log.info("Started"); |
| 163 | } |
| 164 | |
| 165 | @Deactivate |
| 166 | public void deactivate() { |
Madan Jampani | 78be249 | 2016-06-03 23:27:07 -0700 | [diff] [blame] | 167 | leaderElector.removeChangeListener(leadershipChangeListener); |
Jon Hall | 7a8bfc6 | 2016-05-26 17:59:04 -0700 | [diff] [blame] | 168 | leaderElector.removeStatusChangeListener(clientStatusListener); |
Jordan Halterman | 980a8c1 | 2017-09-22 18:01:19 -0700 | [diff] [blame^] | 169 | upgradeService.removeListener(upgradeListener); |
Jon Hall | 7a8bfc6 | 2016-05-26 17:59:04 -0700 | [diff] [blame] | 170 | statusChangeHandler.shutdown(); |
Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 171 | log.info("Stopped"); |
| 172 | } |
| 173 | |
| 174 | @Override |
| 175 | public Leadership addRegistration(String topic) { |
Jordan Halterman | 980a8c1 | 2017-09-22 18:01:19 -0700 | [diff] [blame^] | 176 | leaderElector.run(getLocalTopic(topic), localNodeId); |
| 177 | return getLeadership(topic); |
Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 178 | } |
| 179 | |
| 180 | @Override |
| 181 | public void removeRegistration(String topic) { |
Jordan Halterman | 980a8c1 | 2017-09-22 18:01:19 -0700 | [diff] [blame^] | 182 | leaderElector.withdraw(getLocalTopic(topic)); |
Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 183 | } |
| 184 | |
| 185 | @Override |
| 186 | public void removeRegistration(NodeId nodeId) { |
Madan Jampani | 78be249 | 2016-06-03 23:27:07 -0700 | [diff] [blame] | 187 | leaderElector.evict(nodeId); |
Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 188 | } |
| 189 | |
| 190 | @Override |
| 191 | public boolean moveLeadership(String topic, NodeId toNodeId) { |
Jordan Halterman | 980a8c1 | 2017-09-22 18:01:19 -0700 | [diff] [blame^] | 192 | return leaderElector.anoint(getTopicFor(topic, toNodeId), toNodeId); |
Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 193 | } |
| 194 | |
| 195 | @Override |
| 196 | public boolean makeTopCandidate(String topic, NodeId nodeId) { |
Jordan Halterman | 980a8c1 | 2017-09-22 18:01:19 -0700 | [diff] [blame^] | 197 | return leaderElector.promote(getTopicFor(topic, nodeId), nodeId); |
Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 198 | } |
| 199 | |
| 200 | @Override |
| 201 | public Leadership getLeadership(String topic) { |
Jordan Halterman | 980a8c1 | 2017-09-22 18:01:19 -0700 | [diff] [blame^] | 202 | Leadership leadership = leaderElector.getLeadership(getActiveTopic(topic)); |
| 203 | return leadership != null ? new Leadership( |
| 204 | parseTopic(leadership.topic()), |
| 205 | leadership.leader(), |
| 206 | leadership.candidates()) : null; |
Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 207 | } |
| 208 | |
| 209 | @Override |
| 210 | public Map<String, Leadership> getLeaderships() { |
Jordan Halterman | 980a8c1 | 2017-09-22 18:01:19 -0700 | [diff] [blame^] | 211 | Map<String, Leadership> leaderships = leaderElector.getLeaderships(); |
| 212 | return leaderships.entrySet().stream() |
| 213 | .filter(e -> isActiveTopic(e.getKey())) |
| 214 | .collect(Collectors.toMap(e -> parseTopic(e.getKey()), |
| 215 | e -> new Leadership(parseTopic(e.getKey()), e.getValue().leader(), e.getValue().candidates()))); |
| 216 | } |
| 217 | |
| 218 | /** |
| 219 | * Returns a leader elector topic namespaced with the local node's version. |
| 220 | * |
| 221 | * @param topic the base topic |
| 222 | * @return a topic string namespaced with the local node's version |
| 223 | */ |
| 224 | private String getLocalTopic(String topic) { |
| 225 | return topic + VERSION_SEP + versionService.version(); |
| 226 | } |
| 227 | |
| 228 | /** |
| 229 | * Returns a leader elector topic namespaced with the current cluster version. |
| 230 | * |
| 231 | * @param topic the base topic |
| 232 | * @return a topic string namespaced with the current cluster version |
| 233 | */ |
| 234 | private String getActiveTopic(String topic) { |
| 235 | return topic + VERSION_SEP + upgradeService.getVersion(); |
| 236 | } |
| 237 | |
| 238 | /** |
| 239 | * Returns whether the given topic is a topic for the local version. |
| 240 | * |
| 241 | * @param topic the topic to check |
| 242 | * @return whether the given topic is relevant to the local version |
| 243 | */ |
| 244 | private boolean isLocalTopic(String topic) { |
| 245 | return topic.endsWith(versionService.version().toString()); |
| 246 | } |
| 247 | |
| 248 | /** |
| 249 | * Returns whether the given topic is a topic for the current cluster version. |
| 250 | * |
| 251 | * @param topic the topic to check |
| 252 | * @return whether the given topic is relevant to the current cluster version |
| 253 | */ |
| 254 | private boolean isActiveTopic(String topic) { |
| 255 | return topic.endsWith(VERSION_SEP + upgradeService.getVersion().toString()); |
| 256 | } |
| 257 | |
| 258 | /** |
| 259 | * Parses a topic string, returning the base topic. |
| 260 | * |
| 261 | * @param topic the topic string to parse |
| 262 | * @return the base topic string |
| 263 | */ |
| 264 | private String parseTopic(String topic) { |
| 265 | return topic.substring(0, topic.lastIndexOf(VERSION_SEP)); |
| 266 | } |
| 267 | |
| 268 | /** |
| 269 | * Returns the versioned topic for the given node. |
| 270 | * |
| 271 | * @param topic the topic for the given node |
| 272 | * @param nodeId the node for which to return the namespaced topic |
| 273 | * @return the versioned topic for the given node |
| 274 | */ |
| 275 | private String getTopicFor(String topic, NodeId nodeId) { |
| 276 | Version nodeVersion = clusterService.getVersion(nodeId); |
| 277 | return nodeVersion != null ? topic + VERSION_SEP + nodeVersion : topic + VERSION_SEP + versionService.version(); |
| 278 | } |
| 279 | |
| 280 | /** |
| 281 | * Internal upgrade event listener. |
| 282 | */ |
| 283 | private class InternalUpgradeEventListener implements UpgradeEventListener { |
| 284 | @Override |
| 285 | public void event(UpgradeEvent event) { |
| 286 | if (event.type() == UpgradeEvent.Type.UPGRADED || event.type() == UpgradeEvent.Type.ROLLED_BACK) { |
| 287 | // Iterate through all current leaderships for the new version and trigger events. |
| 288 | for (Leadership leadership : getLeaderships().values()) { |
| 289 | notifyDelegate(new LeadershipEvent( |
| 290 | LeadershipEvent.Type.LEADER_AND_CANDIDATES_CHANGED, |
| 291 | leadership)); |
| 292 | } |
| 293 | } |
| 294 | } |
Madan Jampani | 620f70d | 2016-01-30 22:22:47 -0800 | [diff] [blame] | 295 | } |
| 296 | } |