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.cluster.impl; |
Ayaka Koshibe | 1660969 | 2014-09-23 12:46:15 -0700 | [diff] [blame] | 17 | |
Thomas Vachuska | 1e68bdd | 2014-11-29 13:53:10 -0800 | [diff] [blame] | 18 | import com.codahale.metrics.Timer; |
| 19 | import com.codahale.metrics.Timer.Context; |
Madan Jampani | f7536ab | 2015-05-07 23:23:23 -0700 | [diff] [blame] | 20 | |
Ayaka Koshibe | 1660969 | 2014-09-23 12:46:15 -0700 | [diff] [blame] | 21 | import org.apache.felix.scr.annotations.Activate; |
tom | 4a5d171 | 2014-09-23 17:49:39 -0700 | [diff] [blame] | 22 | import org.apache.felix.scr.annotations.Component; |
Ayaka Koshibe | 1660969 | 2014-09-23 12:46:15 -0700 | [diff] [blame] | 23 | import org.apache.felix.scr.annotations.Deactivate; |
| 24 | import org.apache.felix.scr.annotations.Reference; |
| 25 | import org.apache.felix.scr.annotations.ReferenceCardinality; |
tom | 4a5d171 | 2014-09-23 17:49:39 -0700 | [diff] [blame] | 26 | import org.apache.felix.scr.annotations.Service; |
Yuta HIGUCHI | 6a46283 | 2014-11-23 23:56:03 -0800 | [diff] [blame] | 27 | import org.onlab.metrics.MetricsService; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 28 | import org.onosproject.cluster.ClusterService; |
| 29 | import org.onosproject.cluster.ControllerNode; |
| 30 | import org.onosproject.cluster.NodeId; |
| 31 | import org.onosproject.cluster.RoleInfo; |
| 32 | import org.onosproject.core.MetricsHelper; |
Simon Hunt | ff66374 | 2015-05-14 13:33:05 -0700 | [diff] [blame] | 33 | import org.onosproject.event.ListenerRegistry; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 34 | import org.onosproject.event.EventDeliveryService; |
| 35 | import org.onosproject.mastership.MastershipAdminService; |
| 36 | import org.onosproject.mastership.MastershipEvent; |
| 37 | import org.onosproject.mastership.MastershipListener; |
| 38 | import org.onosproject.mastership.MastershipService; |
| 39 | import org.onosproject.mastership.MastershipStore; |
| 40 | import org.onosproject.mastership.MastershipStoreDelegate; |
| 41 | import org.onosproject.mastership.MastershipTerm; |
| 42 | import org.onosproject.mastership.MastershipTermService; |
| 43 | import org.onosproject.net.DeviceId; |
| 44 | import org.onosproject.net.MastershipRole; |
Ayaka Koshibe | 1660969 | 2014-09-23 12:46:15 -0700 | [diff] [blame] | 45 | import org.slf4j.Logger; |
| 46 | |
Thomas Vachuska | 1e68bdd | 2014-11-29 13:53:10 -0800 | [diff] [blame] | 47 | import java.util.Collection; |
Thomas Vachuska | 12dfdc3 | 2014-11-29 16:03:12 -0800 | [diff] [blame] | 48 | import java.util.HashMap; |
| 49 | import java.util.HashSet; |
Thomas Vachuska | 1e68bdd | 2014-11-29 13:53:10 -0800 | [diff] [blame] | 50 | import java.util.Iterator; |
| 51 | import java.util.List; |
Thomas Vachuska | 12dfdc3 | 2014-11-29 16:03:12 -0800 | [diff] [blame] | 52 | import java.util.Map; |
Thomas Vachuska | 1e68bdd | 2014-11-29 13:53:10 -0800 | [diff] [blame] | 53 | import java.util.Set; |
Madan Jampani | f7536ab | 2015-05-07 23:23:23 -0700 | [diff] [blame] | 54 | import java.util.concurrent.CompletableFuture; |
| 55 | |
Thomas Vachuska | 1e68bdd | 2014-11-29 13:53:10 -0800 | [diff] [blame] | 56 | import static com.google.common.base.Preconditions.checkNotNull; |
| 57 | import static com.google.common.collect.Lists.newArrayList; |
| 58 | import static org.onlab.metrics.MetricsUtil.startTimer; |
| 59 | import static org.onlab.metrics.MetricsUtil.stopTimer; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 60 | import static org.onosproject.cluster.ControllerNode.State.ACTIVE; |
| 61 | import static org.onosproject.net.MastershipRole.MASTER; |
Thomas Vachuska | 1e68bdd | 2014-11-29 13:53:10 -0800 | [diff] [blame] | 62 | import static org.slf4j.LoggerFactory.getLogger; |
Yuta HIGUCHI | 6a46283 | 2014-11-23 23:56:03 -0800 | [diff] [blame] | 63 | |
tom | 4a5d171 | 2014-09-23 17:49:39 -0700 | [diff] [blame] | 64 | @Component(immediate = true) |
| 65 | @Service |
Ayaka Koshibe | 3eed2b0 | 2014-09-23 13:28:05 -0700 | [diff] [blame] | 66 | public class MastershipManager |
Yuta HIGUCHI | a22f69f | 2014-11-24 22:25:17 -0800 | [diff] [blame] | 67 | implements MastershipService, MastershipAdminService, MastershipTermService, |
| 68 | MetricsHelper { |
Ayaka Koshibe | 1660969 | 2014-09-23 12:46:15 -0700 | [diff] [blame] | 69 | |
| 70 | private static final String NODE_ID_NULL = "Node ID cannot be null"; |
| 71 | private static final String DEVICE_ID_NULL = "Device ID cannot be null"; |
| 72 | private static final String ROLE_NULL = "Mastership role cannot be null"; |
| 73 | |
| 74 | private final Logger log = getLogger(getClass()); |
| 75 | |
Simon Hunt | ff66374 | 2015-05-14 13:33:05 -0700 | [diff] [blame] | 76 | protected final ListenerRegistry<MastershipEvent, MastershipListener> |
| 77 | listenerRegistry = new ListenerRegistry<>(); |
alshabib | 339a3d9 | 2014-09-26 17:54:32 -0700 | [diff] [blame] | 78 | |
| 79 | private final MastershipStoreDelegate delegate = new InternalDelegate(); |
Ayaka Koshibe | 1660969 | 2014-09-23 12:46:15 -0700 | [diff] [blame] | 80 | |
| 81 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 82 | protected MastershipStore store; |
| 83 | |
| 84 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 85 | protected EventDeliveryService eventDispatcher; |
| 86 | |
| 87 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
tom | 4a5d171 | 2014-09-23 17:49:39 -0700 | [diff] [blame] | 88 | protected ClusterService clusterService; |
Ayaka Koshibe | 1660969 | 2014-09-23 12:46:15 -0700 | [diff] [blame] | 89 | |
Yuta HIGUCHI | 6a46283 | 2014-11-23 23:56:03 -0800 | [diff] [blame] | 90 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 91 | protected MetricsService metricsService; |
| 92 | |
Yuta HIGUCHI | 6a46283 | 2014-11-23 23:56:03 -0800 | [diff] [blame] | 93 | private Timer requestRoleTimer; |
Ayaka Koshibe | 3de43ca | 2014-09-26 16:40:23 -0700 | [diff] [blame] | 94 | |
Ayaka Koshibe | 1660969 | 2014-09-23 12:46:15 -0700 | [diff] [blame] | 95 | @Activate |
| 96 | public void activate() { |
Yuta HIGUCHI | 6a46283 | 2014-11-23 23:56:03 -0800 | [diff] [blame] | 97 | requestRoleTimer = createTimer("Mastership", "requestRole", "responseTime"); |
| 98 | |
Ayaka Koshibe | 1660969 | 2014-09-23 12:46:15 -0700 | [diff] [blame] | 99 | eventDispatcher.addSink(MastershipEvent.class, listenerRegistry); |
alshabib | 339a3d9 | 2014-09-26 17:54:32 -0700 | [diff] [blame] | 100 | store.setDelegate(delegate); |
Ayaka Koshibe | 1660969 | 2014-09-23 12:46:15 -0700 | [diff] [blame] | 101 | log.info("Started"); |
| 102 | } |
| 103 | |
| 104 | @Deactivate |
| 105 | public void deactivate() { |
| 106 | eventDispatcher.removeSink(MastershipEvent.class); |
alshabib | 339a3d9 | 2014-09-26 17:54:32 -0700 | [diff] [blame] | 107 | store.unsetDelegate(delegate); |
Ayaka Koshibe | 1660969 | 2014-09-23 12:46:15 -0700 | [diff] [blame] | 108 | log.info("Stopped"); |
| 109 | } |
| 110 | |
Ayaka Koshibe | 1660969 | 2014-09-23 12:46:15 -0700 | [diff] [blame] | 111 | @Override |
| 112 | public void setRole(NodeId nodeId, DeviceId deviceId, MastershipRole role) { |
| 113 | checkNotNull(nodeId, NODE_ID_NULL); |
| 114 | checkNotNull(deviceId, DEVICE_ID_NULL); |
| 115 | checkNotNull(role, ROLE_NULL); |
Ayaka Koshibe | d9f693e | 2014-09-29 18:04:54 -0700 | [diff] [blame] | 116 | |
Madan Jampani | f7536ab | 2015-05-07 23:23:23 -0700 | [diff] [blame] | 117 | CompletableFuture<MastershipEvent> eventFuture = null; |
Ayaka Koshibe | e60d452 | 2014-10-28 15:07:00 -0700 | [diff] [blame] | 118 | |
| 119 | switch (role) { |
| 120 | case MASTER: |
Madan Jampani | f7536ab | 2015-05-07 23:23:23 -0700 | [diff] [blame] | 121 | eventFuture = store.setMaster(nodeId, deviceId); |
Ayaka Koshibe | e60d452 | 2014-10-28 15:07:00 -0700 | [diff] [blame] | 122 | break; |
| 123 | case STANDBY: |
Madan Jampani | f7536ab | 2015-05-07 23:23:23 -0700 | [diff] [blame] | 124 | eventFuture = store.setStandby(nodeId, deviceId); |
Ayaka Koshibe | e60d452 | 2014-10-28 15:07:00 -0700 | [diff] [blame] | 125 | break; |
| 126 | case NONE: |
Madan Jampani | f7536ab | 2015-05-07 23:23:23 -0700 | [diff] [blame] | 127 | eventFuture = store.relinquishRole(nodeId, deviceId); |
Ayaka Koshibe | e60d452 | 2014-10-28 15:07:00 -0700 | [diff] [blame] | 128 | break; |
| 129 | default: |
| 130 | log.info("Unknown role; ignoring"); |
| 131 | return; |
Ayaka Koshibe | 971a38a | 2014-09-30 11:56:23 -0700 | [diff] [blame] | 132 | } |
Ayaka Koshibe | d9f693e | 2014-09-29 18:04:54 -0700 | [diff] [blame] | 133 | |
Madan Jampani | f7536ab | 2015-05-07 23:23:23 -0700 | [diff] [blame] | 134 | eventFuture.whenComplete((event, error) -> { |
| 135 | if (event != null) { |
| 136 | post(event); |
| 137 | } |
| 138 | }); |
Ayaka Koshibe | 1660969 | 2014-09-23 12:46:15 -0700 | [diff] [blame] | 139 | } |
| 140 | |
| 141 | @Override |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 142 | public MastershipRole getLocalRole(DeviceId deviceId) { |
| 143 | checkNotNull(deviceId, DEVICE_ID_NULL); |
| 144 | return store.getRole(clusterService.getLocalNode().id(), deviceId); |
| 145 | } |
| 146 | |
| 147 | @Override |
| 148 | public void relinquishMastership(DeviceId deviceId) { |
Madan Jampani | f7536ab | 2015-05-07 23:23:23 -0700 | [diff] [blame] | 149 | store.relinquishRole(clusterService.getLocalNode().id(), deviceId) |
| 150 | .whenComplete((event, error) -> { |
| 151 | if (event != null) { |
| 152 | post(event); |
| 153 | } |
| 154 | }); |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 155 | } |
| 156 | |
| 157 | @Override |
| 158 | public MastershipRole requestRoleFor(DeviceId deviceId) { |
| 159 | checkNotNull(deviceId, DEVICE_ID_NULL); |
Yuta HIGUCHI | 6a46283 | 2014-11-23 23:56:03 -0800 | [diff] [blame] | 160 | final Context timer = startTimer(requestRoleTimer); |
| 161 | try { |
| 162 | return store.requestRole(deviceId); |
| 163 | } finally { |
| 164 | stopTimer(timer); |
| 165 | } |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 166 | } |
| 167 | |
| 168 | @Override |
Ayaka Koshibe | 1660969 | 2014-09-23 12:46:15 -0700 | [diff] [blame] | 169 | public NodeId getMasterFor(DeviceId deviceId) { |
| 170 | checkNotNull(deviceId, DEVICE_ID_NULL); |
| 171 | return store.getMaster(deviceId); |
| 172 | } |
| 173 | |
| 174 | @Override |
| 175 | public Set<DeviceId> getDevicesOf(NodeId nodeId) { |
| 176 | checkNotNull(nodeId, NODE_ID_NULL); |
| 177 | return store.getDevices(nodeId); |
| 178 | } |
| 179 | |
Ayaka Koshibe | 45503ce | 2014-10-14 11:26:45 -0700 | [diff] [blame] | 180 | @Override |
Ayaka Koshibe | abedb09 | 2014-10-20 17:01:31 -0700 | [diff] [blame] | 181 | public RoleInfo getNodesFor(DeviceId deviceId) { |
Ayaka Koshibe | 45503ce | 2014-10-14 11:26:45 -0700 | [diff] [blame] | 182 | checkNotNull(deviceId, DEVICE_ID_NULL); |
| 183 | return store.getNodes(deviceId); |
| 184 | } |
Ayaka Koshibe | b70d34b | 2014-09-25 15:43:01 -0700 | [diff] [blame] | 185 | |
| 186 | @Override |
Yuta HIGUCHI | bcac499 | 2014-11-22 19:27:57 -0800 | [diff] [blame] | 187 | public MastershipTerm getMastershipTerm(DeviceId deviceId) { |
| 188 | return store.getTermFor(deviceId); |
Ayaka Koshibe | b70d34b | 2014-09-25 15:43:01 -0700 | [diff] [blame] | 189 | } |
| 190 | |
Ayaka Koshibe | 1660969 | 2014-09-23 12:46:15 -0700 | [diff] [blame] | 191 | @Override |
Ayaka Koshibe | 1660969 | 2014-09-23 12:46:15 -0700 | [diff] [blame] | 192 | public void addListener(MastershipListener listener) { |
| 193 | checkNotNull(listener); |
| 194 | listenerRegistry.addListener(listener); |
| 195 | } |
| 196 | |
| 197 | @Override |
| 198 | public void removeListener(MastershipListener listener) { |
| 199 | checkNotNull(listener); |
| 200 | listenerRegistry.removeListener(listener); |
| 201 | } |
| 202 | |
Yuta HIGUCHI | a22f69f | 2014-11-24 22:25:17 -0800 | [diff] [blame] | 203 | @Override |
| 204 | public MetricsService metricsService() { |
| 205 | return metricsService; |
| 206 | } |
Ayaka Koshibe | 1660969 | 2014-09-23 12:46:15 -0700 | [diff] [blame] | 207 | |
Thomas Vachuska | 1e68bdd | 2014-11-29 13:53:10 -0800 | [diff] [blame] | 208 | @Override |
| 209 | public void balanceRoles() { |
| 210 | List<ControllerNode> nodes = newArrayList(clusterService.getNodes()); |
Thomas Vachuska | 12dfdc3 | 2014-11-29 16:03:12 -0800 | [diff] [blame] | 211 | Map<ControllerNode, Set<DeviceId>> controllerDevices = new HashMap<>(); |
Thomas Vachuska | 1e68bdd | 2014-11-29 13:53:10 -0800 | [diff] [blame] | 212 | int deviceCount = 0; |
| 213 | |
| 214 | // Create buckets reflecting current ownership. |
| 215 | for (ControllerNode node : nodes) { |
Thomas Vachuska | 12dfdc3 | 2014-11-29 16:03:12 -0800 | [diff] [blame] | 216 | if (clusterService.getState(node.id()) == ACTIVE) { |
| 217 | Set<DeviceId> devicesOf = new HashSet<>(getDevicesOf(node.id())); |
| 218 | deviceCount += devicesOf.size(); |
| 219 | controllerDevices.put(node, devicesOf); |
| 220 | log.info("Node {} has {} devices.", node.id(), devicesOf.size()); |
| 221 | } |
Thomas Vachuska | 1e68bdd | 2014-11-29 13:53:10 -0800 | [diff] [blame] | 222 | } |
| 223 | |
Thomas Vachuska | 12dfdc3 | 2014-11-29 16:03:12 -0800 | [diff] [blame] | 224 | // Now re-balance the buckets until they are roughly even. |
| 225 | int rounds = controllerDevices.keySet().size(); |
Thomas Vachuska | 1e68bdd | 2014-11-29 13:53:10 -0800 | [diff] [blame] | 226 | for (int i = 0; i < rounds; i++) { |
| 227 | // Iterate over the buckets and find the smallest and the largest. |
Thomas Vachuska | 12dfdc3 | 2014-11-29 16:03:12 -0800 | [diff] [blame] | 228 | ControllerNode smallest = findBucket(true, controllerDevices); |
| 229 | ControllerNode largest = findBucket(false, controllerDevices); |
Thomas Vachuska | 1e68bdd | 2014-11-29 13:53:10 -0800 | [diff] [blame] | 230 | balanceBuckets(smallest, largest, controllerDevices, deviceCount); |
| 231 | } |
| 232 | } |
| 233 | |
Thomas Vachuska | 12dfdc3 | 2014-11-29 16:03:12 -0800 | [diff] [blame] | 234 | private ControllerNode findBucket(boolean min, |
| 235 | Map<ControllerNode, Set<DeviceId>> controllerDevices) { |
Thomas Vachuska | 1e68bdd | 2014-11-29 13:53:10 -0800 | [diff] [blame] | 236 | int xSize = min ? Integer.MAX_VALUE : -1; |
| 237 | ControllerNode xNode = null; |
Thomas Vachuska | 12dfdc3 | 2014-11-29 16:03:12 -0800 | [diff] [blame] | 238 | for (ControllerNode node : controllerDevices.keySet()) { |
Thomas Vachuska | 1e68bdd | 2014-11-29 13:53:10 -0800 | [diff] [blame] | 239 | int size = controllerDevices.get(node).size(); |
| 240 | if ((min && size < xSize) || (!min && size > xSize)) { |
| 241 | xSize = size; |
| 242 | xNode = node; |
| 243 | } |
| 244 | } |
| 245 | return xNode; |
| 246 | } |
| 247 | |
| 248 | private void balanceBuckets(ControllerNode smallest, ControllerNode largest, |
Thomas Vachuska | 12dfdc3 | 2014-11-29 16:03:12 -0800 | [diff] [blame] | 249 | Map<ControllerNode, Set<DeviceId>> controllerDevices, |
Thomas Vachuska | 1e68bdd | 2014-11-29 13:53:10 -0800 | [diff] [blame] | 250 | int deviceCount) { |
| 251 | Collection<DeviceId> minBucket = controllerDevices.get(smallest); |
| 252 | Collection<DeviceId> maxBucket = controllerDevices.get(largest); |
| 253 | int bucketCount = controllerDevices.keySet().size(); |
| 254 | |
| 255 | int delta = (maxBucket.size() - minBucket.size()) / 2; |
| 256 | delta = Math.min(deviceCount / bucketCount, delta); |
| 257 | |
| 258 | if (delta > 0) { |
| 259 | log.info("Attempting to move {} nodes from {} to {}...", delta, |
| 260 | largest.id(), smallest.id()); |
| 261 | |
| 262 | int i = 0; |
| 263 | Iterator<DeviceId> it = maxBucket.iterator(); |
| 264 | while (it.hasNext() && i < delta) { |
| 265 | DeviceId deviceId = it.next(); |
| 266 | log.info("Setting {} as the master for {}", smallest.id(), deviceId); |
| 267 | setRole(smallest.id(), deviceId, MASTER); |
Thomas Vachuska | 12dfdc3 | 2014-11-29 16:03:12 -0800 | [diff] [blame] | 268 | controllerDevices.get(smallest).add(deviceId); |
Thomas Vachuska | 1e68bdd | 2014-11-29 13:53:10 -0800 | [diff] [blame] | 269 | it.remove(); |
| 270 | i++; |
| 271 | } |
| 272 | } |
| 273 | } |
| 274 | |
| 275 | |
Ayaka Koshibe | 1660969 | 2014-09-23 12:46:15 -0700 | [diff] [blame] | 276 | // Posts the specified event to the local event dispatcher. |
| 277 | private void post(MastershipEvent event) { |
| 278 | if (event != null && eventDispatcher != null) { |
| 279 | eventDispatcher.post(event); |
| 280 | } |
| 281 | } |
Ayaka Koshibe | 3eed2b0 | 2014-09-23 13:28:05 -0700 | [diff] [blame] | 282 | |
alshabib | 339a3d9 | 2014-09-26 17:54:32 -0700 | [diff] [blame] | 283 | public class InternalDelegate implements MastershipStoreDelegate { |
| 284 | |
| 285 | @Override |
| 286 | public void notify(MastershipEvent event) { |
Yuta HIGUCHI | 9e11ac0 | 2014-11-12 10:09:49 -0800 | [diff] [blame] | 287 | log.trace("dispatching mastership event {}", event); |
alshabib | 339a3d9 | 2014-09-26 17:54:32 -0700 | [diff] [blame] | 288 | eventDispatcher.post(event); |
| 289 | } |
| 290 | |
| 291 | } |
| 292 | |
Ayaka Koshibe | 1660969 | 2014-09-23 12:46:15 -0700 | [diff] [blame] | 293 | } |