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