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