tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 1 | package org.onlab.onos.store.cluster.impl; |
| 2 | |
alshabib | 339a3d9 | 2014-09-26 17:54:32 -0700 | [diff] [blame] | 3 | import static org.onlab.onos.cluster.MastershipEvent.Type.MASTER_CHANGED; |
| 4 | |
| 5 | import java.util.Map; |
alshabib | 339a3d9 | 2014-09-26 17:54:32 -0700 | [diff] [blame] | 6 | import java.util.Set; |
Yuta HIGUCHI | c8e19d4 | 2014-09-24 17:20:52 -0700 | [diff] [blame] | 7 | |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 8 | import org.apache.felix.scr.annotations.Activate; |
| 9 | import org.apache.felix.scr.annotations.Component; |
| 10 | import org.apache.felix.scr.annotations.Deactivate; |
| 11 | import org.apache.felix.scr.annotations.Reference; |
| 12 | import org.apache.felix.scr.annotations.ReferenceCardinality; |
| 13 | import org.apache.felix.scr.annotations.Service; |
| 14 | import org.onlab.onos.cluster.ClusterService; |
| 15 | import org.onlab.onos.cluster.MastershipEvent; |
| 16 | import org.onlab.onos.cluster.MastershipStore; |
tom | 0755a36 | 2014-09-24 11:54:43 -0700 | [diff] [blame] | 17 | import org.onlab.onos.cluster.MastershipStoreDelegate; |
Ayaka Koshibe | b70d34b | 2014-09-25 15:43:01 -0700 | [diff] [blame] | 18 | import org.onlab.onos.cluster.MastershipTerm; |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 19 | import org.onlab.onos.cluster.NodeId; |
| 20 | import org.onlab.onos.net.DeviceId; |
| 21 | import org.onlab.onos.net.MastershipRole; |
Yuta HIGUCHI | b5df76d | 2014-09-27 20:54:00 -0700 | [diff] [blame] | 22 | import org.onlab.onos.store.common.AbstractHazelcastStore; |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 23 | |
alshabib | 339a3d9 | 2014-09-26 17:54:32 -0700 | [diff] [blame] | 24 | import com.google.common.collect.ImmutableSet; |
Ayaka Koshibe | 8583ff3 | 2014-10-02 16:25:30 -0700 | [diff] [blame] | 25 | import com.hazelcast.core.ILock; |
alshabib | 339a3d9 | 2014-09-26 17:54:32 -0700 | [diff] [blame] | 26 | import com.hazelcast.core.IMap; |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 27 | |
| 28 | /** |
| 29 | * Distributed implementation of the cluster nodes store. |
| 30 | */ |
| 31 | @Component(immediate = true) |
| 32 | @Service |
tom | 0755a36 | 2014-09-24 11:54:43 -0700 | [diff] [blame] | 33 | public class DistributedMastershipStore |
Yuta HIGUCHI | 2e96389 | 2014-09-27 13:00:39 -0700 | [diff] [blame] | 34 | extends AbstractHazelcastStore<MastershipEvent, MastershipStoreDelegate> |
alshabib | 339a3d9 | 2014-09-26 17:54:32 -0700 | [diff] [blame] | 35 | implements MastershipStore { |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 36 | |
Ayaka Koshibe | 8583ff3 | 2014-10-02 16:25:30 -0700 | [diff] [blame] | 37 | //arbitrary lock name |
| 38 | private static final String LOCK = "lock"; |
| 39 | //initial term value |
| 40 | private static final Integer INIT = 0; |
| 41 | //placeholder non-null value |
| 42 | private static final Byte NIL = 0x0; |
| 43 | |
| 44 | //devices to masters |
| 45 | protected IMap<byte[], byte[]> rawMasters; |
| 46 | //devices to terms |
| 47 | protected IMap<byte[], Integer> rawTerms; |
| 48 | //collection of nodes. values are ignored, as it's used as a makeshift 'set' |
| 49 | protected IMap<byte[], Byte> backups; |
| 50 | |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 51 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 52 | protected ClusterService clusterService; |
| 53 | |
Ayaka Koshibe | 406d010 | 2014-09-24 16:08:12 -0700 | [diff] [blame] | 54 | @Override |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 55 | @Activate |
| 56 | public void activate() { |
| 57 | super.activate(); |
| 58 | |
| 59 | rawMasters = theInstance.getMap("masters"); |
Ayaka Koshibe | 8583ff3 | 2014-10-02 16:25:30 -0700 | [diff] [blame] | 60 | rawTerms = theInstance.getMap("terms"); |
| 61 | backups = theInstance.getMap("backups"); |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 62 | |
Ayaka Koshibe | 5c0f237 | 2014-10-02 17:59:04 -0700 | [diff] [blame^] | 63 | rawMasters.addEntryListener(new RemoteMasterShipEventHandler(), true); |
Yuta HIGUCHI | c8e19d4 | 2014-09-24 17:20:52 -0700 | [diff] [blame] | 64 | |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 65 | log.info("Started"); |
| 66 | } |
| 67 | |
| 68 | @Deactivate |
| 69 | public void deactivate() { |
| 70 | log.info("Stopped"); |
| 71 | } |
| 72 | |
| 73 | @Override |
Ayaka Koshibe | 406d010 | 2014-09-24 16:08:12 -0700 | [diff] [blame] | 74 | public MastershipEvent setMaster(NodeId nodeId, DeviceId deviceId) { |
Ayaka Koshibe | 8583ff3 | 2014-10-02 16:25:30 -0700 | [diff] [blame] | 75 | byte [] did = serialize(deviceId); |
| 76 | byte [] nid = serialize(nodeId); |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 77 | |
Ayaka Koshibe | 8583ff3 | 2014-10-02 16:25:30 -0700 | [diff] [blame] | 78 | ILock lock = theInstance.getLock(LOCK); |
| 79 | lock.lock(); |
| 80 | try { |
| 81 | MastershipRole role = getRole(nodeId, deviceId); |
| 82 | Integer term = rawTerms.get(did); |
| 83 | switch (role) { |
| 84 | case MASTER: |
| 85 | return null; |
| 86 | case STANDBY: |
| 87 | rawMasters.put(did, nid); |
| 88 | rawTerms.put(did, ++term); |
| 89 | backups.putIfAbsent(nid, NIL); |
| 90 | break; |
| 91 | case NONE: |
| 92 | rawMasters.put(did, nid); |
| 93 | //new switch OR state transition after being orphaned |
| 94 | if (term == null) { |
| 95 | rawTerms.put(did, INIT); |
| 96 | } else { |
| 97 | rawTerms.put(did, ++term); |
| 98 | } |
| 99 | backups.put(nid, NIL); |
| 100 | break; |
| 101 | default: |
| 102 | log.warn("unknown Mastership Role {}", role); |
| 103 | return null; |
| 104 | } |
| 105 | return new MastershipEvent(MASTER_CHANGED, deviceId, nodeId); |
| 106 | } finally { |
| 107 | lock.unlock(); |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 108 | } |
| 109 | } |
| 110 | |
| 111 | @Override |
| 112 | public NodeId getMaster(DeviceId deviceId) { |
Ayaka Koshibe | 8583ff3 | 2014-10-02 16:25:30 -0700 | [diff] [blame] | 113 | return deserialize(rawMasters.get(serialize(deviceId))); |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 114 | } |
| 115 | |
| 116 | @Override |
| 117 | public Set<DeviceId> getDevices(NodeId nodeId) { |
| 118 | ImmutableSet.Builder<DeviceId> builder = ImmutableSet.builder(); |
Ayaka Koshibe | 8583ff3 | 2014-10-02 16:25:30 -0700 | [diff] [blame] | 119 | |
| 120 | for (Map.Entry<byte[], byte[]> entry : rawMasters.entrySet()) { |
| 121 | if (nodeId.equals(deserialize(entry.getValue()))) { |
| 122 | builder.add((DeviceId) deserialize(entry.getKey())); |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 123 | } |
| 124 | } |
Ayaka Koshibe | 8583ff3 | 2014-10-02 16:25:30 -0700 | [diff] [blame] | 125 | |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 126 | return builder.build(); |
| 127 | } |
| 128 | |
| 129 | @Override |
| 130 | public MastershipRole requestRole(DeviceId deviceId) { |
Ayaka Koshibe | 8583ff3 | 2014-10-02 16:25:30 -0700 | [diff] [blame] | 131 | // first to empty slot for device in master map is MASTER |
| 132 | // depending on how backups are organized, might need to trigger election |
| 133 | // so only controller doesn't set itself to backup for another device |
| 134 | byte [] did = serialize(deviceId); |
| 135 | NodeId local = clusterService.getLocalNode().id(); |
| 136 | byte [] lnid = serialize(local); |
| 137 | |
| 138 | ILock lock = theInstance.getLock(LOCK); |
| 139 | lock.lock(); |
| 140 | try { |
| 141 | MastershipRole role = getRole(local, deviceId); |
| 142 | switch (role) { |
| 143 | case MASTER: |
| 144 | break; |
| 145 | case STANDBY: |
| 146 | backups.put(lnid, NIL); |
| 147 | rawTerms.putIfAbsent(did, INIT); |
| 148 | break; |
| 149 | case NONE: |
| 150 | rawMasters.put(did, lnid); |
| 151 | rawTerms.putIfAbsent(did, INIT); |
| 152 | backups.put(lnid, NIL); |
| 153 | role = MastershipRole.MASTER; |
| 154 | break; |
| 155 | default: |
| 156 | log.warn("unknown Mastership Role {}", role); |
| 157 | } |
| 158 | return role; |
| 159 | } finally { |
| 160 | lock.unlock(); |
| 161 | } |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 162 | } |
| 163 | |
| 164 | @Override |
| 165 | public MastershipRole getRole(NodeId nodeId, DeviceId deviceId) { |
Ayaka Koshibe | 8583ff3 | 2014-10-02 16:25:30 -0700 | [diff] [blame] | 166 | byte[] did = serialize(deviceId); |
| 167 | |
| 168 | NodeId current = deserialize(rawMasters.get(did)); |
| 169 | MastershipRole role = null; |
| 170 | |
| 171 | if (current == null) { |
| 172 | //IFF no controllers have claimed mastership over it |
| 173 | role = MastershipRole.NONE; |
| 174 | } else { |
| 175 | if (current.equals(nodeId)) { |
| 176 | role = MastershipRole.MASTER; |
| 177 | } else { |
| 178 | role = MastershipRole.STANDBY; |
| 179 | } |
| 180 | } |
| 181 | |
| 182 | return role; |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 183 | } |
| 184 | |
Ayaka Koshibe | b70d34b | 2014-09-25 15:43:01 -0700 | [diff] [blame] | 185 | @Override |
| 186 | public MastershipTerm getTermFor(DeviceId deviceId) { |
Ayaka Koshibe | 8583ff3 | 2014-10-02 16:25:30 -0700 | [diff] [blame] | 187 | byte[] did = serialize(deviceId); |
| 188 | |
| 189 | if ((rawMasters.get(did) == null) || |
| 190 | (rawTerms.get(did) == null)) { |
| 191 | return null; |
| 192 | } |
| 193 | return MastershipTerm.of( |
| 194 | (NodeId) deserialize(rawMasters.get(did)), rawTerms.get(did)); |
Ayaka Koshibe | b70d34b | 2014-09-25 15:43:01 -0700 | [diff] [blame] | 195 | } |
| 196 | |
Ayaka Koshibe | d9f693e | 2014-09-29 18:04:54 -0700 | [diff] [blame] | 197 | @Override |
| 198 | public MastershipEvent unsetMaster(NodeId nodeId, DeviceId deviceId) { |
Ayaka Koshibe | 8583ff3 | 2014-10-02 16:25:30 -0700 | [diff] [blame] | 199 | byte [] did = serialize(deviceId); |
| 200 | |
| 201 | ILock lock = theInstance.getLock(LOCK); |
| 202 | lock.lock(); |
| 203 | try { |
| 204 | MastershipRole role = getRole(nodeId, deviceId); |
| 205 | switch (role) { |
| 206 | case MASTER: |
| 207 | //hand off device to another |
| 208 | NodeId backup = reelect(nodeId, deviceId); |
| 209 | if (backup == null) { |
| 210 | //goes back to NONE |
| 211 | rawMasters.remove(did); |
| 212 | } else { |
| 213 | //goes to STANDBY for local, MASTER for someone else |
| 214 | Integer term = rawTerms.get(did); |
| 215 | rawMasters.put(did, serialize(backup)); |
| 216 | rawTerms.put(did, ++term); |
| 217 | return new MastershipEvent(MASTER_CHANGED, deviceId, backup); |
| 218 | } |
| 219 | case STANDBY: |
| 220 | case NONE: |
| 221 | break; |
| 222 | default: |
| 223 | log.warn("unknown Mastership Role {}", role); |
| 224 | } |
| 225 | return null; |
| 226 | } finally { |
| 227 | lock.unlock(); |
| 228 | } |
| 229 | } |
| 230 | |
| 231 | //helper for "re-electing" a new master for a given device |
| 232 | private NodeId reelect(NodeId current, DeviceId deviceId) { |
| 233 | for (byte [] node : backups.keySet()) { |
| 234 | NodeId nid = deserialize(node); |
| 235 | if (!current.equals(nid)) { |
| 236 | return nid; |
| 237 | } |
| 238 | } |
Ayaka Koshibe | d9f693e | 2014-09-29 18:04:54 -0700 | [diff] [blame] | 239 | return null; |
| 240 | } |
| 241 | |
Ayaka Koshibe | 8583ff3 | 2014-10-02 16:25:30 -0700 | [diff] [blame] | 242 | //adds node to pool(s) of backup |
| 243 | private void backup(NodeId nodeId, DeviceId deviceId) { |
Ayaka Koshibe | 5c0f237 | 2014-10-02 17:59:04 -0700 | [diff] [blame^] | 244 | //TODO might be useful to isolate out this function and reelect() if we |
| 245 | //get more backup/election schemes |
Ayaka Koshibe | 8583ff3 | 2014-10-02 16:25:30 -0700 | [diff] [blame] | 246 | } |
| 247 | |
Ayaka Koshibe | 5c0f237 | 2014-10-02 17:59:04 -0700 | [diff] [blame^] | 248 | private class RemoteMasterShipEventHandler extends RemoteEventHandler<DeviceId, NodeId> { |
alshabib | 339a3d9 | 2014-09-26 17:54:32 -0700 | [diff] [blame] | 249 | |
| 250 | @Override |
| 251 | protected void onAdd(DeviceId deviceId, NodeId nodeId) { |
Ayaka Koshibe | 5c0f237 | 2014-10-02 17:59:04 -0700 | [diff] [blame^] | 252 | //only addition indicates a change in mastership |
alshabib | 339a3d9 | 2014-09-26 17:54:32 -0700 | [diff] [blame] | 253 | notifyDelegate(new MastershipEvent(MASTER_CHANGED, deviceId, nodeId)); |
| 254 | } |
| 255 | |
| 256 | @Override |
| 257 | protected void onRemove(DeviceId deviceId, NodeId nodeId) { |
Ayaka Koshibe | 5c0f237 | 2014-10-02 17:59:04 -0700 | [diff] [blame^] | 258 | //notifyDelegate(new MastershipEvent(MASTER_CHANGED, deviceId, nodeId)); |
alshabib | 339a3d9 | 2014-09-26 17:54:32 -0700 | [diff] [blame] | 259 | } |
| 260 | |
| 261 | @Override |
| 262 | protected void onUpdate(DeviceId deviceId, NodeId oldNodeId, NodeId nodeId) { |
Ayaka Koshibe | 5c0f237 | 2014-10-02 17:59:04 -0700 | [diff] [blame^] | 263 | //notifyDelegate(new MastershipEvent(MASTER_CHANGED, deviceId, nodeId)); |
alshabib | 339a3d9 | 2014-09-26 17:54:32 -0700 | [diff] [blame] | 264 | } |
| 265 | } |
| 266 | |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 267 | } |