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