Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2014 Open Networking Laboratory |
| 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 | */ |
Ayaka Koshibe | 1660969 | 2014-09-23 12:46:15 -0700 | [diff] [blame] | 16 | package org.onlab.onos.cluster.impl; |
| 17 | |
alshabib | 339a3d9 | 2014-09-26 17:54:32 -0700 | [diff] [blame] | 18 | import static com.google.common.base.Preconditions.checkNotNull; |
| 19 | import static org.slf4j.LoggerFactory.getLogger; |
Yuta HIGUCHI | a22f69f | 2014-11-24 22:25:17 -0800 | [diff] [blame^] | 20 | import static org.onlab.metrics.MetricsUtil.*; |
alshabib | 339a3d9 | 2014-09-26 17:54:32 -0700 | [diff] [blame] | 21 | |
| 22 | import java.util.Set; |
Ayaka Koshibe | ea5b4ce | 2014-10-11 14:17:17 -0700 | [diff] [blame] | 23 | import java.util.concurrent.atomic.AtomicInteger; |
alshabib | 339a3d9 | 2014-09-26 17:54:32 -0700 | [diff] [blame] | 24 | |
Ayaka Koshibe | 1660969 | 2014-09-23 12:46:15 -0700 | [diff] [blame] | 25 | import org.apache.felix.scr.annotations.Activate; |
tom | 4a5d171 | 2014-09-23 17:49:39 -0700 | [diff] [blame] | 26 | import org.apache.felix.scr.annotations.Component; |
Ayaka Koshibe | 1660969 | 2014-09-23 12:46:15 -0700 | [diff] [blame] | 27 | import org.apache.felix.scr.annotations.Deactivate; |
| 28 | import org.apache.felix.scr.annotations.Reference; |
| 29 | import org.apache.felix.scr.annotations.ReferenceCardinality; |
tom | 4a5d171 | 2014-09-23 17:49:39 -0700 | [diff] [blame] | 30 | import org.apache.felix.scr.annotations.Service; |
Yuta HIGUCHI | 6a46283 | 2014-11-23 23:56:03 -0800 | [diff] [blame] | 31 | import org.onlab.metrics.MetricsService; |
Ayaka Koshibe | 3de43ca | 2014-09-26 16:40:23 -0700 | [diff] [blame] | 32 | import org.onlab.onos.cluster.ClusterEvent; |
| 33 | import org.onlab.onos.cluster.ClusterEventListener; |
tom | 4a5d171 | 2014-09-23 17:49:39 -0700 | [diff] [blame] | 34 | import org.onlab.onos.cluster.ClusterService; |
Ayaka Koshibe | ea5b4ce | 2014-10-11 14:17:17 -0700 | [diff] [blame] | 35 | import org.onlab.onos.cluster.ControllerNode; |
Ayaka Koshibe | 1660969 | 2014-09-23 12:46:15 -0700 | [diff] [blame] | 36 | import org.onlab.onos.cluster.NodeId; |
Ayaka Koshibe | abedb09 | 2014-10-20 17:01:31 -0700 | [diff] [blame] | 37 | import org.onlab.onos.cluster.RoleInfo; |
Yuta HIGUCHI | a22f69f | 2014-11-24 22:25:17 -0800 | [diff] [blame^] | 38 | import org.onlab.onos.core.MetricsHelper; |
Ayaka Koshibe | 1660969 | 2014-09-23 12:46:15 -0700 | [diff] [blame] | 39 | import org.onlab.onos.event.AbstractListenerRegistry; |
| 40 | import org.onlab.onos.event.EventDeliveryService; |
Yuta HIGUCHI | 80912e6 | 2014-10-12 00:15:47 -0700 | [diff] [blame] | 41 | import org.onlab.onos.mastership.MastershipAdminService; |
| 42 | import org.onlab.onos.mastership.MastershipEvent; |
| 43 | import org.onlab.onos.mastership.MastershipListener; |
| 44 | import org.onlab.onos.mastership.MastershipService; |
| 45 | import org.onlab.onos.mastership.MastershipStore; |
| 46 | import org.onlab.onos.mastership.MastershipStoreDelegate; |
| 47 | import org.onlab.onos.mastership.MastershipTerm; |
| 48 | import org.onlab.onos.mastership.MastershipTermService; |
Ayaka Koshibe | 1660969 | 2014-09-23 12:46:15 -0700 | [diff] [blame] | 49 | import org.onlab.onos.net.DeviceId; |
| 50 | import org.onlab.onos.net.MastershipRole; |
Ayaka Koshibe | 1660969 | 2014-09-23 12:46:15 -0700 | [diff] [blame] | 51 | import org.slf4j.Logger; |
| 52 | |
Yuta HIGUCHI | 6a46283 | 2014-11-23 23:56:03 -0800 | [diff] [blame] | 53 | import com.codahale.metrics.Timer; |
| 54 | import com.codahale.metrics.Timer.Context; |
| 55 | |
tom | 4a5d171 | 2014-09-23 17:49:39 -0700 | [diff] [blame] | 56 | @Component(immediate = true) |
| 57 | @Service |
Ayaka Koshibe | 3eed2b0 | 2014-09-23 13:28:05 -0700 | [diff] [blame] | 58 | public class MastershipManager |
Yuta HIGUCHI | a22f69f | 2014-11-24 22:25:17 -0800 | [diff] [blame^] | 59 | implements MastershipService, MastershipAdminService, MastershipTermService, |
| 60 | MetricsHelper { |
Ayaka Koshibe | 1660969 | 2014-09-23 12:46:15 -0700 | [diff] [blame] | 61 | |
| 62 | private static final String NODE_ID_NULL = "Node ID cannot be null"; |
| 63 | private static final String DEVICE_ID_NULL = "Device ID cannot be null"; |
| 64 | private static final String ROLE_NULL = "Mastership role cannot be null"; |
| 65 | |
| 66 | private final Logger log = getLogger(getClass()); |
| 67 | |
| 68 | protected final AbstractListenerRegistry<MastershipEvent, MastershipListener> |
alshabib | 339a3d9 | 2014-09-26 17:54:32 -0700 | [diff] [blame] | 69 | listenerRegistry = new AbstractListenerRegistry<>(); |
| 70 | |
| 71 | private final MastershipStoreDelegate delegate = new InternalDelegate(); |
Ayaka Koshibe | 1660969 | 2014-09-23 12:46:15 -0700 | [diff] [blame] | 72 | |
| 73 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 74 | protected MastershipStore store; |
| 75 | |
| 76 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 77 | protected EventDeliveryService eventDispatcher; |
| 78 | |
| 79 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
tom | 4a5d171 | 2014-09-23 17:49:39 -0700 | [diff] [blame] | 80 | protected ClusterService clusterService; |
Ayaka Koshibe | 1660969 | 2014-09-23 12:46:15 -0700 | [diff] [blame] | 81 | |
Yuta HIGUCHI | 6a46283 | 2014-11-23 23:56:03 -0800 | [diff] [blame] | 82 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 83 | protected MetricsService metricsService; |
| 84 | |
Ayaka Koshibe | 3de43ca | 2014-09-26 16:40:23 -0700 | [diff] [blame] | 85 | private ClusterEventListener clusterListener = new InternalClusterEventListener(); |
Yuta HIGUCHI | 6a46283 | 2014-11-23 23:56:03 -0800 | [diff] [blame] | 86 | private Timer requestRoleTimer; |
Ayaka Koshibe | 3de43ca | 2014-09-26 16:40:23 -0700 | [diff] [blame] | 87 | |
Ayaka Koshibe | 1660969 | 2014-09-23 12:46:15 -0700 | [diff] [blame] | 88 | @Activate |
| 89 | public void activate() { |
Yuta HIGUCHI | 6a46283 | 2014-11-23 23:56:03 -0800 | [diff] [blame] | 90 | requestRoleTimer = createTimer("Mastership", "requestRole", "responseTime"); |
| 91 | |
Ayaka Koshibe | 1660969 | 2014-09-23 12:46:15 -0700 | [diff] [blame] | 92 | eventDispatcher.addSink(MastershipEvent.class, listenerRegistry); |
Ayaka Koshibe | 3de43ca | 2014-09-26 16:40:23 -0700 | [diff] [blame] | 93 | clusterService.addListener(clusterListener); |
alshabib | 339a3d9 | 2014-09-26 17:54:32 -0700 | [diff] [blame] | 94 | store.setDelegate(delegate); |
Ayaka Koshibe | 1660969 | 2014-09-23 12:46:15 -0700 | [diff] [blame] | 95 | log.info("Started"); |
| 96 | } |
| 97 | |
| 98 | @Deactivate |
| 99 | public void deactivate() { |
| 100 | eventDispatcher.removeSink(MastershipEvent.class); |
Ayaka Koshibe | 3de43ca | 2014-09-26 16:40:23 -0700 | [diff] [blame] | 101 | clusterService.removeListener(clusterListener); |
alshabib | 339a3d9 | 2014-09-26 17:54:32 -0700 | [diff] [blame] | 102 | store.unsetDelegate(delegate); |
Ayaka Koshibe | 1660969 | 2014-09-23 12:46:15 -0700 | [diff] [blame] | 103 | log.info("Stopped"); |
| 104 | } |
| 105 | |
Ayaka Koshibe | 1660969 | 2014-09-23 12:46:15 -0700 | [diff] [blame] | 106 | @Override |
| 107 | public void setRole(NodeId nodeId, DeviceId deviceId, MastershipRole role) { |
| 108 | checkNotNull(nodeId, NODE_ID_NULL); |
| 109 | checkNotNull(deviceId, DEVICE_ID_NULL); |
| 110 | checkNotNull(role, ROLE_NULL); |
Ayaka Koshibe | d9f693e | 2014-09-29 18:04:54 -0700 | [diff] [blame] | 111 | |
Ayaka Koshibe | 971a38a | 2014-09-30 11:56:23 -0700 | [diff] [blame] | 112 | MastershipEvent event = null; |
Ayaka Koshibe | e60d452 | 2014-10-28 15:07:00 -0700 | [diff] [blame] | 113 | |
| 114 | switch (role) { |
| 115 | case MASTER: |
| 116 | event = store.setMaster(nodeId, deviceId); |
| 117 | break; |
| 118 | case STANDBY: |
| 119 | event = store.setStandby(nodeId, deviceId); |
| 120 | break; |
| 121 | case NONE: |
| 122 | event = store.relinquishRole(nodeId, deviceId); |
| 123 | break; |
| 124 | default: |
| 125 | log.info("Unknown role; ignoring"); |
| 126 | return; |
Ayaka Koshibe | 971a38a | 2014-09-30 11:56:23 -0700 | [diff] [blame] | 127 | } |
Ayaka Koshibe | d9f693e | 2014-09-29 18:04:54 -0700 | [diff] [blame] | 128 | |
Ayaka Koshibe | 971a38a | 2014-09-30 11:56:23 -0700 | [diff] [blame] | 129 | if (event != null) { |
| 130 | post(event); |
Ayaka Koshibe | a7f044e | 2014-09-23 16:56:20 -0700 | [diff] [blame] | 131 | } |
Ayaka Koshibe | 1660969 | 2014-09-23 12:46:15 -0700 | [diff] [blame] | 132 | } |
| 133 | |
| 134 | @Override |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 135 | public MastershipRole getLocalRole(DeviceId deviceId) { |
| 136 | checkNotNull(deviceId, DEVICE_ID_NULL); |
| 137 | return store.getRole(clusterService.getLocalNode().id(), deviceId); |
| 138 | } |
| 139 | |
| 140 | @Override |
| 141 | public void relinquishMastership(DeviceId deviceId) { |
Ayaka Koshibe | c404770 | 2014-10-07 14:43:52 -0700 | [diff] [blame] | 142 | MastershipEvent event = null; |
Ayaka Koshibe | 1c292d7 | 2014-10-08 17:46:07 -0700 | [diff] [blame] | 143 | event = store.relinquishRole( |
| 144 | clusterService.getLocalNode().id(), deviceId); |
Ayaka Koshibe | d9f693e | 2014-09-29 18:04:54 -0700 | [diff] [blame] | 145 | if (event != null) { |
| 146 | post(event); |
| 147 | } |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 148 | } |
| 149 | |
| 150 | @Override |
| 151 | public MastershipRole requestRoleFor(DeviceId deviceId) { |
| 152 | checkNotNull(deviceId, DEVICE_ID_NULL); |
Yuta HIGUCHI | 6a46283 | 2014-11-23 23:56:03 -0800 | [diff] [blame] | 153 | final Context timer = startTimer(requestRoleTimer); |
| 154 | try { |
| 155 | return store.requestRole(deviceId); |
| 156 | } finally { |
| 157 | stopTimer(timer); |
| 158 | } |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 159 | } |
| 160 | |
| 161 | @Override |
Ayaka Koshibe | 1660969 | 2014-09-23 12:46:15 -0700 | [diff] [blame] | 162 | public NodeId getMasterFor(DeviceId deviceId) { |
| 163 | checkNotNull(deviceId, DEVICE_ID_NULL); |
| 164 | return store.getMaster(deviceId); |
| 165 | } |
| 166 | |
| 167 | @Override |
| 168 | public Set<DeviceId> getDevicesOf(NodeId nodeId) { |
| 169 | checkNotNull(nodeId, NODE_ID_NULL); |
| 170 | return store.getDevices(nodeId); |
| 171 | } |
| 172 | |
Ayaka Koshibe | 45503ce | 2014-10-14 11:26:45 -0700 | [diff] [blame] | 173 | @Override |
Ayaka Koshibe | abedb09 | 2014-10-20 17:01:31 -0700 | [diff] [blame] | 174 | public RoleInfo getNodesFor(DeviceId deviceId) { |
Ayaka Koshibe | 45503ce | 2014-10-14 11:26:45 -0700 | [diff] [blame] | 175 | checkNotNull(deviceId, DEVICE_ID_NULL); |
| 176 | return store.getNodes(deviceId); |
| 177 | } |
Ayaka Koshibe | b70d34b | 2014-09-25 15:43:01 -0700 | [diff] [blame] | 178 | |
| 179 | @Override |
Yuta HIGUCHI | bcac499 | 2014-11-22 19:27:57 -0800 | [diff] [blame] | 180 | public MastershipTerm getMastershipTerm(DeviceId deviceId) { |
| 181 | return store.getTermFor(deviceId); |
Ayaka Koshibe | b70d34b | 2014-09-25 15:43:01 -0700 | [diff] [blame] | 182 | } |
| 183 | |
Ayaka Koshibe | 1660969 | 2014-09-23 12:46:15 -0700 | [diff] [blame] | 184 | @Override |
Ayaka Koshibe | 1660969 | 2014-09-23 12:46:15 -0700 | [diff] [blame] | 185 | public void addListener(MastershipListener listener) { |
| 186 | checkNotNull(listener); |
| 187 | listenerRegistry.addListener(listener); |
| 188 | } |
| 189 | |
| 190 | @Override |
| 191 | public void removeListener(MastershipListener listener) { |
| 192 | checkNotNull(listener); |
| 193 | listenerRegistry.removeListener(listener); |
| 194 | } |
| 195 | |
Yuta HIGUCHI | a22f69f | 2014-11-24 22:25:17 -0800 | [diff] [blame^] | 196 | @Override |
| 197 | public MetricsService metricsService() { |
| 198 | return metricsService; |
| 199 | } |
Ayaka Koshibe | 1660969 | 2014-09-23 12:46:15 -0700 | [diff] [blame] | 200 | |
| 201 | // Posts the specified event to the local event dispatcher. |
| 202 | private void post(MastershipEvent event) { |
| 203 | if (event != null && eventDispatcher != null) { |
| 204 | eventDispatcher.post(event); |
| 205 | } |
| 206 | } |
Ayaka Koshibe | 3eed2b0 | 2014-09-23 13:28:05 -0700 | [diff] [blame] | 207 | |
Ayaka Koshibe | 3de43ca | 2014-09-26 16:40:23 -0700 | [diff] [blame] | 208 | //callback for reacting to cluster events |
| 209 | private class InternalClusterEventListener implements ClusterEventListener { |
| 210 | |
Ayaka Koshibe | ea5b4ce | 2014-10-11 14:17:17 -0700 | [diff] [blame] | 211 | // A notion of a local maximum cluster size, used to tie-break. |
| 212 | // Think of a better way to do this. |
| 213 | private AtomicInteger clusterSize; |
| 214 | |
| 215 | InternalClusterEventListener() { |
| 216 | clusterSize = new AtomicInteger(0); |
| 217 | } |
| 218 | |
Ayaka Koshibe | 3de43ca | 2014-09-26 16:40:23 -0700 | [diff] [blame] | 219 | @Override |
| 220 | public void event(ClusterEvent event) { |
| 221 | switch (event.type()) { |
| 222 | //FIXME: worry about addition when the time comes |
| 223 | case INSTANCE_ADDED: |
| 224 | case INSTANCE_ACTIVATED: |
Ayaka Koshibe | ea5b4ce | 2014-10-11 14:17:17 -0700 | [diff] [blame] | 225 | clusterSize.incrementAndGet(); |
| 226 | log.info("instance {} added/activated", event.subject()); |
| 227 | break; |
Ayaka Koshibe | 3de43ca | 2014-09-26 16:40:23 -0700 | [diff] [blame] | 228 | case INSTANCE_REMOVED: |
| 229 | case INSTANCE_DEACTIVATED: |
Ayaka Koshibe | ea5b4ce | 2014-10-11 14:17:17 -0700 | [diff] [blame] | 230 | ControllerNode node = event.subject(); |
| 231 | |
| 232 | if (node.equals(clusterService.getLocalNode())) { |
| 233 | //If we are in smaller cluster, relinquish and return |
| 234 | for (DeviceId device : getDevicesOf(node.id())) { |
| 235 | if (!isInMajority()) { |
| 236 | //own DeviceManager should catch event and tell switch |
| 237 | store.relinquishRole(node.id(), device); |
| 238 | } |
| 239 | } |
| 240 | log.info("broke off from cluster, relinquished devices"); |
| 241 | break; |
| 242 | } |
| 243 | |
| 244 | // if we are the larger one and the removed node(s) are brain dead, |
| 245 | // force relinquish on behalf of disabled node. |
| 246 | // check network channel to do this? |
| 247 | for (DeviceId device : getDevicesOf(node.id())) { |
| 248 | //some things to check: |
| 249 | // 1. we didn't break off as well while we're at it |
| 250 | // 2. others don't pile in and try too - maybe a lock |
| 251 | if (isInMajority()) { |
| 252 | store.relinquishRole(node.id(), device); |
| 253 | } |
| 254 | } |
| 255 | clusterSize.decrementAndGet(); |
| 256 | log.info("instance {} removed/deactivated", event.subject()); |
Ayaka Koshibe | 3de43ca | 2014-09-26 16:40:23 -0700 | [diff] [blame] | 257 | break; |
| 258 | default: |
| 259 | log.warn("unknown cluster event {}", event); |
| 260 | } |
| 261 | } |
| 262 | |
Ayaka Koshibe | ea5b4ce | 2014-10-11 14:17:17 -0700 | [diff] [blame] | 263 | private boolean isInMajority() { |
| 264 | if (clusterService.getNodes().size() > (clusterSize.intValue() / 2)) { |
| 265 | return true; |
| 266 | } |
Ayaka Koshibe | a7384a8 | 2014-10-22 18:59:06 -0700 | [diff] [blame] | 267 | // else { |
Ayaka Koshibe | 67af1f4 | 2014-10-20 15:26:37 -0700 | [diff] [blame] | 268 | //FIXME: break tie for equal-sized clusters, by number of |
| 269 | // connected switches, then masters, then nodeId hash |
Ayaka Koshibe | a7384a8 | 2014-10-22 18:59:06 -0700 | [diff] [blame] | 270 | // problem is, how do we get at channel info cleanly here? |
| 271 | // Also, what's the time hit for a distributed store look-up |
| 272 | // versus channel re-negotiation? bet on the latter being worse. |
| 273 | |
| 274 | // } |
Ayaka Koshibe | ea5b4ce | 2014-10-11 14:17:17 -0700 | [diff] [blame] | 275 | return false; |
| 276 | } |
| 277 | |
Ayaka Koshibe | 3de43ca | 2014-09-26 16:40:23 -0700 | [diff] [blame] | 278 | } |
Ayaka Koshibe | 65efaef | 2014-09-29 18:21:56 -0700 | [diff] [blame] | 279 | |
alshabib | 339a3d9 | 2014-09-26 17:54:32 -0700 | [diff] [blame] | 280 | public class InternalDelegate implements MastershipStoreDelegate { |
| 281 | |
| 282 | @Override |
| 283 | public void notify(MastershipEvent event) { |
Yuta HIGUCHI | 9e11ac0 | 2014-11-12 10:09:49 -0800 | [diff] [blame] | 284 | log.trace("dispatching mastership event {}", event); |
alshabib | 339a3d9 | 2014-09-26 17:54:32 -0700 | [diff] [blame] | 285 | eventDispatcher.post(event); |
| 286 | } |
| 287 | |
| 288 | } |
| 289 | |
Ayaka Koshibe | 1660969 | 2014-09-23 12:46:15 -0700 | [diff] [blame] | 290 | } |