Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 1 | /* |
Ray Milkey | 34c9590 | 2015-04-15 09:47:53 -0700 | [diff] [blame] | 2 | * Copyright 2014-2015 Open Networking Laboratory |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [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 | */ |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 16 | package org.onosproject.store.cluster.impl; |
tom | 2d7c65f | 2014-09-23 01:09:35 -0700 | [diff] [blame] | 17 | |
Jonathan Hart | 4a4d18f | 2015-03-26 12:16:16 -0700 | [diff] [blame] | 18 | import com.google.common.collect.ImmutableSet; |
| 19 | import com.google.common.collect.Maps; |
Madan Jampani | c26eede | 2015-04-16 11:42:16 -0700 | [diff] [blame] | 20 | |
tom | 2d7c65f | 2014-09-23 01:09:35 -0700 | [diff] [blame] | 21 | import org.apache.felix.scr.annotations.Activate; |
| 22 | import org.apache.felix.scr.annotations.Component; |
| 23 | import org.apache.felix.scr.annotations.Deactivate; |
Madan Jampani | afeebbd | 2015-05-19 15:26:01 -0700 | [diff] [blame] | 24 | import org.apache.felix.scr.annotations.Reference; |
| 25 | import org.apache.felix.scr.annotations.ReferenceCardinality; |
tom | 2d7c65f | 2014-09-23 01:09:35 -0700 | [diff] [blame] | 26 | import org.apache.felix.scr.annotations.Service; |
Madan Jampani | 7d2fab2 | 2015-03-18 17:21:57 -0700 | [diff] [blame] | 27 | import org.joda.time.DateTime; |
Ayaka Koshibe | dd91b84 | 2015-03-02 14:48:47 -0800 | [diff] [blame] | 28 | import org.onlab.packet.IpAddress; |
| 29 | import org.onlab.util.KryoNamespace; |
Madan Jampani | afeebbd | 2015-05-19 15:26:01 -0700 | [diff] [blame] | 30 | import org.onosproject.cluster.ClusterDefinitionService; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 31 | import org.onosproject.cluster.ClusterEvent; |
| 32 | import org.onosproject.cluster.ClusterStore; |
| 33 | import org.onosproject.cluster.ClusterStoreDelegate; |
| 34 | import org.onosproject.cluster.ControllerNode; |
Ayaka Koshibe | dd91b84 | 2015-03-02 14:48:47 -0800 | [diff] [blame] | 35 | import org.onosproject.cluster.ControllerNode.State; |
Jonathan Hart | 4a4d18f | 2015-03-26 12:16:16 -0700 | [diff] [blame] | 36 | import org.onosproject.cluster.DefaultControllerNode; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 37 | import org.onosproject.cluster.NodeId; |
Ayaka Koshibe | dd91b84 | 2015-03-02 14:48:47 -0800 | [diff] [blame] | 38 | import org.onosproject.store.AbstractStore; |
Madan Jampani | c26eede | 2015-04-16 11:42:16 -0700 | [diff] [blame] | 39 | import org.onosproject.store.cluster.messaging.Endpoint; |
Madan Jampani | afeebbd | 2015-05-19 15:26:01 -0700 | [diff] [blame] | 40 | import org.onosproject.store.cluster.messaging.MessagingService; |
Ayaka Koshibe | dd91b84 | 2015-03-02 14:48:47 -0800 | [diff] [blame] | 41 | import org.onosproject.store.serializers.KryoNamespaces; |
| 42 | import org.onosproject.store.serializers.KryoSerializer; |
| 43 | import org.slf4j.Logger; |
tom | 2d7c65f | 2014-09-23 01:09:35 -0700 | [diff] [blame] | 44 | |
Jonathan Hart | 4a4d18f | 2015-03-26 12:16:16 -0700 | [diff] [blame] | 45 | import java.util.Map; |
| 46 | import java.util.Set; |
| 47 | import java.util.concurrent.ExecutorService; |
| 48 | import java.util.concurrent.Executors; |
| 49 | import java.util.concurrent.ScheduledExecutorService; |
| 50 | import java.util.concurrent.TimeUnit; |
Madan Jampani | c26eede | 2015-04-16 11:42:16 -0700 | [diff] [blame] | 51 | import java.util.function.Consumer; |
Jonathan Hart | 4a4d18f | 2015-03-26 12:16:16 -0700 | [diff] [blame] | 52 | import java.util.stream.Collectors; |
| 53 | |
Jonathan Hart | 4a4d18f | 2015-03-26 12:16:16 -0700 | [diff] [blame] | 54 | import static com.google.common.base.Preconditions.checkNotNull; |
| 55 | import static org.onlab.util.Tools.groupedThreads; |
| 56 | import static org.slf4j.LoggerFactory.getLogger; |
tom | 2d7c65f | 2014-09-23 01:09:35 -0700 | [diff] [blame] | 57 | |
tom | 2d7c65f | 2014-09-23 01:09:35 -0700 | [diff] [blame] | 58 | @Component(immediate = true) |
| 59 | @Service |
Ayaka Koshibe | dd91b84 | 2015-03-02 14:48:47 -0800 | [diff] [blame] | 60 | /** |
| 61 | * Distributed cluster nodes store that employs an accrual failure |
| 62 | * detector to identify cluster member up/down status. |
| 63 | */ |
tom | 0755a36 | 2014-09-24 11:54:43 -0700 | [diff] [blame] | 64 | public class DistributedClusterStore |
Ayaka Koshibe | dd91b84 | 2015-03-02 14:48:47 -0800 | [diff] [blame] | 65 | extends AbstractStore<ClusterEvent, ClusterStoreDelegate> |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 66 | implements ClusterStore { |
tom | 2d7c65f | 2014-09-23 01:09:35 -0700 | [diff] [blame] | 67 | |
Thomas Vachuska | 8dc1a69 | 2015-03-31 01:01:37 -0700 | [diff] [blame] | 68 | private static final Logger log = getLogger(DistributedClusterStore.class); |
tom | 2d7c65f | 2014-09-23 01:09:35 -0700 | [diff] [blame] | 69 | |
Thomas Vachuska | de563cf | 2015-04-01 00:28:50 -0700 | [diff] [blame] | 70 | public static final String HEARTBEAT_MESSAGE = "onos-cluster-heartbeat"; |
| 71 | |
Ayaka Koshibe | dd91b84 | 2015-03-02 14:48:47 -0800 | [diff] [blame] | 72 | // TODO: make these configurable. |
Ayaka Koshibe | dd91b84 | 2015-03-02 14:48:47 -0800 | [diff] [blame] | 73 | private static final int HEARTBEAT_INTERVAL_MS = 100; |
| 74 | private static final int PHI_FAILURE_THRESHOLD = 10; |
tom | 2d7c65f | 2014-09-23 01:09:35 -0700 | [diff] [blame] | 75 | |
Ayaka Koshibe | dd91b84 | 2015-03-02 14:48:47 -0800 | [diff] [blame] | 76 | private static final KryoSerializer SERIALIZER = new KryoSerializer() { |
| 77 | @Override |
| 78 | protected void setupKryoPool() { |
| 79 | serializerPool = KryoNamespace.newBuilder() |
Thomas Vachuska | 8dc1a69 | 2015-03-31 01:01:37 -0700 | [diff] [blame] | 80 | .register(KryoNamespaces.API) |
| 81 | .register(HeartbeatMessage.class) |
| 82 | .build() |
| 83 | .populate(1); |
Ayaka Koshibe | dd91b84 | 2015-03-02 14:48:47 -0800 | [diff] [blame] | 84 | } |
| 85 | }; |
| 86 | |
| 87 | private static final String INSTANCE_ID_NULL = "Instance ID cannot be null"; |
| 88 | |
Ayaka Koshibe | dd91b84 | 2015-03-02 14:48:47 -0800 | [diff] [blame] | 89 | private final Map<NodeId, ControllerNode> allNodes = Maps.newConcurrentMap(); |
| 90 | private final Map<NodeId, State> nodeStates = Maps.newConcurrentMap(); |
Madan Jampani | 7d2fab2 | 2015-03-18 17:21:57 -0700 | [diff] [blame] | 91 | private final Map<NodeId, DateTime> nodeStateLastUpdatedTimes = Maps.newConcurrentMap(); |
Ayaka Koshibe | dd91b84 | 2015-03-02 14:48:47 -0800 | [diff] [blame] | 92 | private ScheduledExecutorService heartBeatSender = Executors.newSingleThreadScheduledExecutor( |
| 93 | groupedThreads("onos/cluster/membership", "heartbeat-sender")); |
| 94 | private ExecutorService heartBeatMessageHandler = Executors.newSingleThreadExecutor( |
| 95 | groupedThreads("onos/cluster/membership", "heartbeat-receiver")); |
| 96 | |
| 97 | private PhiAccrualFailureDetector failureDetector; |
| 98 | |
| 99 | private ControllerNode localNode; |
| 100 | |
Madan Jampani | afeebbd | 2015-05-19 15:26:01 -0700 | [diff] [blame] | 101 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 102 | protected ClusterDefinitionService clusterDefinitionService; |
| 103 | |
| 104 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 105 | protected MessagingService messagingService; |
| 106 | |
tom | 2d7c65f | 2014-09-23 01:09:35 -0700 | [diff] [blame] | 107 | @Activate |
| 108 | public void activate() { |
Madan Jampani | afeebbd | 2015-05-19 15:26:01 -0700 | [diff] [blame] | 109 | localNode = clusterDefinitionService.localNode(); |
Thomas Vachuska | 8dc1a69 | 2015-03-31 01:01:37 -0700 | [diff] [blame] | 110 | |
Ayaka Koshibe | dd91b84 | 2015-03-02 14:48:47 -0800 | [diff] [blame] | 111 | messagingService.registerHandler(HEARTBEAT_MESSAGE, |
Thomas Vachuska | 8dc1a69 | 2015-03-31 01:01:37 -0700 | [diff] [blame] | 112 | new HeartbeatMessageHandler(), heartBeatMessageHandler); |
Ayaka Koshibe | dd91b84 | 2015-03-02 14:48:47 -0800 | [diff] [blame] | 113 | |
| 114 | failureDetector = new PhiAccrualFailureDetector(); |
| 115 | |
| 116 | heartBeatSender.scheduleWithFixedDelay(this::heartbeat, 0, |
Thomas Vachuska | 8dc1a69 | 2015-03-31 01:01:37 -0700 | [diff] [blame] | 117 | HEARTBEAT_INTERVAL_MS, TimeUnit.MILLISECONDS); |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 118 | |
Madan Jampani | afeebbd | 2015-05-19 15:26:01 -0700 | [diff] [blame] | 119 | addNode(localNode); |
| 120 | updateState(localNode.id(), State.ACTIVE); |
| 121 | |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 122 | log.info("Started"); |
| 123 | } |
| 124 | |
tom | 2d7c65f | 2014-09-23 01:09:35 -0700 | [diff] [blame] | 125 | @Deactivate |
| 126 | public void deactivate() { |
Madan Jampani | afeebbd | 2015-05-19 15:26:01 -0700 | [diff] [blame] | 127 | messagingService.unregisterHandler(HEARTBEAT_MESSAGE); |
Ayaka Koshibe | dd91b84 | 2015-03-02 14:48:47 -0800 | [diff] [blame] | 128 | heartBeatSender.shutdownNow(); |
| 129 | heartBeatMessageHandler.shutdownNow(); |
| 130 | |
tom | 2d7c65f | 2014-09-23 01:09:35 -0700 | [diff] [blame] | 131 | log.info("Stopped"); |
| 132 | } |
| 133 | |
| 134 | @Override |
Ayaka Koshibe | dd91b84 | 2015-03-02 14:48:47 -0800 | [diff] [blame] | 135 | public void setDelegate(ClusterStoreDelegate delegate) { |
| 136 | checkNotNull(delegate, "Delegate cannot be null"); |
| 137 | this.delegate = delegate; |
| 138 | } |
| 139 | |
| 140 | @Override |
| 141 | public void unsetDelegate(ClusterStoreDelegate delegate) { |
| 142 | this.delegate = null; |
| 143 | } |
| 144 | |
| 145 | @Override |
| 146 | public boolean hasDelegate() { |
| 147 | return this.delegate != null; |
| 148 | } |
| 149 | |
| 150 | @Override |
tom | 2d7c65f | 2014-09-23 01:09:35 -0700 | [diff] [blame] | 151 | public ControllerNode getLocalNode() { |
Ayaka Koshibe | dd91b84 | 2015-03-02 14:48:47 -0800 | [diff] [blame] | 152 | return localNode; |
tom | 2d7c65f | 2014-09-23 01:09:35 -0700 | [diff] [blame] | 153 | } |
| 154 | |
| 155 | @Override |
| 156 | public Set<ControllerNode> getNodes() { |
Ayaka Koshibe | dd91b84 | 2015-03-02 14:48:47 -0800 | [diff] [blame] | 157 | return ImmutableSet.copyOf(allNodes.values()); |
tom | 2d7c65f | 2014-09-23 01:09:35 -0700 | [diff] [blame] | 158 | } |
| 159 | |
| 160 | @Override |
| 161 | public ControllerNode getNode(NodeId nodeId) { |
Ayaka Koshibe | dd91b84 | 2015-03-02 14:48:47 -0800 | [diff] [blame] | 162 | checkNotNull(nodeId, INSTANCE_ID_NULL); |
| 163 | return allNodes.get(nodeId); |
tom | 2d7c65f | 2014-09-23 01:09:35 -0700 | [diff] [blame] | 164 | } |
| 165 | |
| 166 | @Override |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 167 | public State getState(NodeId nodeId) { |
Ayaka Koshibe | dd91b84 | 2015-03-02 14:48:47 -0800 | [diff] [blame] | 168 | checkNotNull(nodeId, INSTANCE_ID_NULL); |
| 169 | return nodeStates.get(nodeId); |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 170 | } |
| 171 | |
| 172 | @Override |
Pavlin Radoslavov | 444b519 | 2014-10-28 10:45:19 -0700 | [diff] [blame] | 173 | public ControllerNode addNode(NodeId nodeId, IpAddress ip, int tcpPort) { |
Ayaka Koshibe | dd91b84 | 2015-03-02 14:48:47 -0800 | [diff] [blame] | 174 | ControllerNode node = new DefaultControllerNode(nodeId, ip, tcpPort); |
Madan Jampani | afeebbd | 2015-05-19 15:26:01 -0700 | [diff] [blame] | 175 | addNode(node); |
Ayaka Koshibe | dd91b84 | 2015-03-02 14:48:47 -0800 | [diff] [blame] | 176 | return node; |
tom | ee49c37 | 2014-09-26 15:14:50 -0700 | [diff] [blame] | 177 | } |
| 178 | |
| 179 | @Override |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 180 | public void removeNode(NodeId nodeId) { |
Ayaka Koshibe | dd91b84 | 2015-03-02 14:48:47 -0800 | [diff] [blame] | 181 | checkNotNull(nodeId, INSTANCE_ID_NULL); |
| 182 | ControllerNode node = allNodes.remove(nodeId); |
| 183 | if (node != null) { |
| 184 | nodeStates.remove(nodeId); |
Jonathan Hart | f114126 | 2015-04-23 11:27:07 -0700 | [diff] [blame] | 185 | notifyDelegate(new ClusterEvent(ClusterEvent.Type.INSTANCE_REMOVED, node)); |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 186 | } |
| 187 | } |
| 188 | |
Madan Jampani | afeebbd | 2015-05-19 15:26:01 -0700 | [diff] [blame] | 189 | private void addNode(ControllerNode node) { |
| 190 | allNodes.put(node.id(), node); |
| 191 | updateState(node.id(), State.INACTIVE); |
| 192 | notifyDelegate(new ClusterEvent(ClusterEvent.Type.INSTANCE_ADDED, node)); |
Thomas Vachuska | de563cf | 2015-04-01 00:28:50 -0700 | [diff] [blame] | 193 | } |
| 194 | |
Madan Jampani | 7d2fab2 | 2015-03-18 17:21:57 -0700 | [diff] [blame] | 195 | private void updateState(NodeId nodeId, State newState) { |
| 196 | nodeStates.put(nodeId, newState); |
| 197 | nodeStateLastUpdatedTimes.put(nodeId, DateTime.now()); |
| 198 | } |
| 199 | |
Ayaka Koshibe | dd91b84 | 2015-03-02 14:48:47 -0800 | [diff] [blame] | 200 | private void heartbeat() { |
| 201 | try { |
| 202 | Set<ControllerNode> peers = allNodes.values() |
| 203 | .stream() |
| 204 | .filter(node -> !(node.id().equals(localNode.id()))) |
| 205 | .collect(Collectors.toSet()); |
| 206 | byte[] hbMessagePayload = SERIALIZER.encode(new HeartbeatMessage(localNode, peers)); |
| 207 | peers.forEach((node) -> { |
| 208 | heartbeatToPeer(hbMessagePayload, node); |
| 209 | State currentState = nodeStates.get(node.id()); |
| 210 | double phi = failureDetector.phi(node.id()); |
| 211 | if (phi >= PHI_FAILURE_THRESHOLD) { |
| 212 | if (currentState == State.ACTIVE) { |
Madan Jampani | 7d2fab2 | 2015-03-18 17:21:57 -0700 | [diff] [blame] | 213 | updateState(node.id(), State.INACTIVE); |
Ayaka Koshibe | dd91b84 | 2015-03-02 14:48:47 -0800 | [diff] [blame] | 214 | notifyStateChange(node.id(), State.ACTIVE, State.INACTIVE); |
| 215 | } |
| 216 | } else { |
| 217 | if (currentState == State.INACTIVE) { |
Madan Jampani | 7d2fab2 | 2015-03-18 17:21:57 -0700 | [diff] [blame] | 218 | updateState(node.id(), State.ACTIVE); |
Ayaka Koshibe | dd91b84 | 2015-03-02 14:48:47 -0800 | [diff] [blame] | 219 | notifyStateChange(node.id(), State.INACTIVE, State.ACTIVE); |
| 220 | } |
| 221 | } |
| 222 | }); |
| 223 | } catch (Exception e) { |
| 224 | log.debug("Failed to send heartbeat", e); |
| 225 | } |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 226 | } |
| 227 | |
Ayaka Koshibe | dd91b84 | 2015-03-02 14:48:47 -0800 | [diff] [blame] | 228 | private void notifyStateChange(NodeId nodeId, State oldState, State newState) { |
| 229 | ControllerNode node = allNodes.get(nodeId); |
| 230 | if (newState == State.ACTIVE) { |
Jonathan Hart | f114126 | 2015-04-23 11:27:07 -0700 | [diff] [blame] | 231 | notifyDelegate(new ClusterEvent(ClusterEvent.Type.INSTANCE_ACTIVATED, node)); |
Ayaka Koshibe | dd91b84 | 2015-03-02 14:48:47 -0800 | [diff] [blame] | 232 | } else { |
Jonathan Hart | f114126 | 2015-04-23 11:27:07 -0700 | [diff] [blame] | 233 | notifyDelegate(new ClusterEvent(ClusterEvent.Type.INSTANCE_DEACTIVATED, node)); |
Ayaka Koshibe | dd91b84 | 2015-03-02 14:48:47 -0800 | [diff] [blame] | 234 | } |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 235 | } |
| 236 | |
Ayaka Koshibe | dd91b84 | 2015-03-02 14:48:47 -0800 | [diff] [blame] | 237 | private void heartbeatToPeer(byte[] messagePayload, ControllerNode peer) { |
Madan Jampani | afeebbd | 2015-05-19 15:26:01 -0700 | [diff] [blame] | 238 | Endpoint remoteEp = new Endpoint(peer.ip(), peer.tcpPort()); |
Madan Jampani | 175e8fd | 2015-05-20 14:10:45 -0700 | [diff] [blame^] | 239 | messagingService.sendAsync(remoteEp, HEARTBEAT_MESSAGE, messagePayload).whenComplete((result, error) -> { |
| 240 | if (error != null) { |
| 241 | log.trace("Sending heartbeat to {} failed", remoteEp, error); |
| 242 | } |
| 243 | }); |
Ayaka Koshibe | dd91b84 | 2015-03-02 14:48:47 -0800 | [diff] [blame] | 244 | } |
| 245 | |
Madan Jampani | c26eede | 2015-04-16 11:42:16 -0700 | [diff] [blame] | 246 | private class HeartbeatMessageHandler implements Consumer<byte[]> { |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 247 | @Override |
Madan Jampani | c26eede | 2015-04-16 11:42:16 -0700 | [diff] [blame] | 248 | public void accept(byte[] message) { |
| 249 | HeartbeatMessage hb = SERIALIZER.decode(message); |
Ayaka Koshibe | dd91b84 | 2015-03-02 14:48:47 -0800 | [diff] [blame] | 250 | failureDetector.report(hb.source().id()); |
| 251 | hb.knownPeers().forEach(node -> { |
| 252 | allNodes.put(node.id(), node); |
| 253 | }); |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 254 | } |
tom | 2d7c65f | 2014-09-23 01:09:35 -0700 | [diff] [blame] | 255 | } |
Ayaka Koshibe | dd91b84 | 2015-03-02 14:48:47 -0800 | [diff] [blame] | 256 | |
| 257 | private static class HeartbeatMessage { |
| 258 | private ControllerNode source; |
| 259 | private Set<ControllerNode> knownPeers; |
| 260 | |
| 261 | public HeartbeatMessage(ControllerNode source, Set<ControllerNode> members) { |
| 262 | this.source = source; |
| 263 | this.knownPeers = ImmutableSet.copyOf(members); |
| 264 | } |
| 265 | |
| 266 | public ControllerNode source() { |
| 267 | return source; |
| 268 | } |
| 269 | |
| 270 | public Set<ControllerNode> knownPeers() { |
| 271 | return knownPeers; |
| 272 | } |
| 273 | } |
| 274 | |
Madan Jampani | 7d2fab2 | 2015-03-18 17:21:57 -0700 | [diff] [blame] | 275 | @Override |
| 276 | public DateTime getLastUpdated(NodeId nodeId) { |
| 277 | return nodeStateLastUpdatedTimes.get(nodeId); |
| 278 | } |
Thomas Vachuska | de563cf | 2015-04-01 00:28:50 -0700 | [diff] [blame] | 279 | |
Jonathan Hart | 4a4d18f | 2015-03-26 12:16:16 -0700 | [diff] [blame] | 280 | } |