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 | */ |
tom | ea961ff | 2014-10-01 12:45:15 -0700 | [diff] [blame] | 16 | package org.onlab.onos.store.trivial.impl; |
Ayaka Koshibe | a7f044e | 2014-09-23 16:56:20 -0700 | [diff] [blame] | 17 | |
| 18 | import static org.slf4j.LoggerFactory.getLogger; |
| 19 | |
Ayaka Koshibe | f9b02fc | 2014-10-15 17:07:05 -0700 | [diff] [blame] | 20 | import java.util.ArrayList; |
Ayaka Koshibe | a7f044e | 2014-09-23 16:56:20 -0700 | [diff] [blame] | 21 | import java.util.Collections; |
Ayaka Koshibe | b70d34b | 2014-09-25 15:43:01 -0700 | [diff] [blame] | 22 | import java.util.HashMap; |
Ayaka Koshibe | 406d010 | 2014-09-24 16:08:12 -0700 | [diff] [blame] | 23 | import java.util.HashSet; |
Ayaka Koshibe | 45503ce | 2014-10-14 11:26:45 -0700 | [diff] [blame] | 24 | import java.util.List; |
Ayaka Koshibe | 406d010 | 2014-09-24 16:08:12 -0700 | [diff] [blame] | 25 | import java.util.Map; |
Ayaka Koshibe | a7f044e | 2014-09-23 16:56:20 -0700 | [diff] [blame] | 26 | import java.util.Set; |
Ayaka Koshibe | b70d34b | 2014-09-25 15:43:01 -0700 | [diff] [blame] | 27 | import java.util.concurrent.atomic.AtomicInteger; |
Ayaka Koshibe | a7f044e | 2014-09-23 16:56:20 -0700 | [diff] [blame] | 28 | |
| 29 | import org.apache.felix.scr.annotations.Activate; |
| 30 | import org.apache.felix.scr.annotations.Component; |
| 31 | import org.apache.felix.scr.annotations.Deactivate; |
| 32 | import org.apache.felix.scr.annotations.Service; |
| 33 | import org.onlab.onos.cluster.ControllerNode; |
| 34 | import org.onlab.onos.cluster.DefaultControllerNode; |
Ayaka Koshibe | a7f044e | 2014-09-23 16:56:20 -0700 | [diff] [blame] | 35 | import org.onlab.onos.cluster.NodeId; |
Ayaka Koshibe | abedb09 | 2014-10-20 17:01:31 -0700 | [diff] [blame] | 36 | import org.onlab.onos.cluster.RoleInfo; |
Yuta HIGUCHI | 80912e6 | 2014-10-12 00:15:47 -0700 | [diff] [blame] | 37 | import org.onlab.onos.mastership.MastershipEvent; |
| 38 | import org.onlab.onos.mastership.MastershipStore; |
| 39 | import org.onlab.onos.mastership.MastershipStoreDelegate; |
| 40 | import org.onlab.onos.mastership.MastershipTerm; |
Ayaka Koshibe | a7f044e | 2014-09-23 16:56:20 -0700 | [diff] [blame] | 41 | import org.onlab.onos.net.DeviceId; |
| 42 | import org.onlab.onos.net.MastershipRole; |
tom | f80c972 | 2014-09-24 14:49:18 -0700 | [diff] [blame] | 43 | import org.onlab.onos.store.AbstractStore; |
Pavlin Radoslavov | 444b519 | 2014-10-28 10:45:19 -0700 | [diff] [blame] | 44 | import org.onlab.packet.IpAddress; |
Ayaka Koshibe | a7f044e | 2014-09-23 16:56:20 -0700 | [diff] [blame] | 45 | import org.slf4j.Logger; |
| 46 | |
Ayaka Koshibe | fc981cf | 2014-10-21 12:44:17 -0700 | [diff] [blame] | 47 | import com.google.common.collect.Lists; |
| 48 | |
Yuta HIGUCHI | 80912e6 | 2014-10-12 00:15:47 -0700 | [diff] [blame] | 49 | import static org.onlab.onos.mastership.MastershipEvent.Type.*; |
Ayaka Koshibe | a7f044e | 2014-09-23 16:56:20 -0700 | [diff] [blame] | 50 | |
| 51 | /** |
| 52 | * Manages inventory of controller mastership over devices using |
Ayaka Koshibe | 406d010 | 2014-09-24 16:08:12 -0700 | [diff] [blame] | 53 | * trivial, non-distributed in-memory structures implementation. |
Ayaka Koshibe | a7f044e | 2014-09-23 16:56:20 -0700 | [diff] [blame] | 54 | */ |
| 55 | @Component(immediate = true) |
| 56 | @Service |
tom | f80c972 | 2014-09-24 14:49:18 -0700 | [diff] [blame] | 57 | public class SimpleMastershipStore |
| 58 | extends AbstractStore<MastershipEvent, MastershipStoreDelegate> |
| 59 | implements MastershipStore { |
Ayaka Koshibe | a7f044e | 2014-09-23 16:56:20 -0700 | [diff] [blame] | 60 | |
Ayaka Koshibe | a7f044e | 2014-09-23 16:56:20 -0700 | [diff] [blame] | 61 | private final Logger log = getLogger(getClass()); |
| 62 | |
Pavlin Radoslavov | 444b519 | 2014-10-28 10:45:19 -0700 | [diff] [blame] | 63 | public static final IpAddress LOCALHOST = IpAddress.valueOf("127.0.0.1"); |
Ayaka Koshibe | a7f044e | 2014-09-23 16:56:20 -0700 | [diff] [blame] | 64 | |
Yuta HIGUCHI | dfe6e3b | 2014-10-30 11:31:51 -0700 | [diff] [blame] | 65 | private static final int NOTHING = 0; |
| 66 | private static final int INIT = 1; |
| 67 | |
Ayaka Koshibe | 406d010 | 2014-09-24 16:08:12 -0700 | [diff] [blame] | 68 | private ControllerNode instance = |
| 69 | new DefaultControllerNode(new NodeId("local"), LOCALHOST); |
| 70 | |
| 71 | //devices mapped to their masters, to emulate multiple nodes |
Ayaka Koshibe | 3de43ca | 2014-09-26 16:40:23 -0700 | [diff] [blame] | 72 | protected final Map<DeviceId, NodeId> masterMap = new HashMap<>(); |
Ayaka Koshibe | 971a38a | 2014-09-30 11:56:23 -0700 | [diff] [blame] | 73 | //emulate backups with pile of nodes |
| 74 | protected final Set<NodeId> backups = new HashSet<>(); |
Ayaka Koshibe | d9f693e | 2014-09-29 18:04:54 -0700 | [diff] [blame] | 75 | //terms |
Ayaka Koshibe | b70d34b | 2014-09-25 15:43:01 -0700 | [diff] [blame] | 76 | protected final Map<DeviceId, AtomicInteger> termMap = new HashMap<>(); |
Ayaka Koshibe | a7f044e | 2014-09-23 16:56:20 -0700 | [diff] [blame] | 77 | |
| 78 | @Activate |
| 79 | public void activate() { |
Ayaka Koshibe | a7f044e | 2014-09-23 16:56:20 -0700 | [diff] [blame] | 80 | log.info("Started"); |
| 81 | } |
| 82 | |
| 83 | @Deactivate |
| 84 | public void deactivate() { |
| 85 | log.info("Stopped"); |
| 86 | } |
| 87 | |
| 88 | @Override |
Ayaka Koshibe | 406d010 | 2014-09-24 16:08:12 -0700 | [diff] [blame] | 89 | public MastershipEvent setMaster(NodeId nodeId, DeviceId deviceId) { |
Ayaka Koshibe | 971a38a | 2014-09-30 11:56:23 -0700 | [diff] [blame] | 90 | MastershipRole role = getRole(nodeId, deviceId); |
Ayaka Koshibe | 406d010 | 2014-09-24 16:08:12 -0700 | [diff] [blame] | 91 | |
Ayaka Koshibe | 971a38a | 2014-09-30 11:56:23 -0700 | [diff] [blame] | 92 | synchronized (this) { |
| 93 | switch (role) { |
| 94 | case MASTER: |
| 95 | return null; |
| 96 | case STANDBY: |
Ayaka Koshibe | d9f693e | 2014-09-29 18:04:54 -0700 | [diff] [blame] | 97 | masterMap.put(deviceId, nodeId); |
Ayaka Koshibe | d9f693e | 2014-09-29 18:04:54 -0700 | [diff] [blame] | 98 | termMap.get(deviceId).incrementAndGet(); |
Ayaka Koshibe | 971a38a | 2014-09-30 11:56:23 -0700 | [diff] [blame] | 99 | backups.add(nodeId); |
| 100 | break; |
| 101 | case NONE: |
| 102 | masterMap.put(deviceId, nodeId); |
Yuta HIGUCHI | dfe6e3b | 2014-10-30 11:31:51 -0700 | [diff] [blame] | 103 | termMap.put(deviceId, new AtomicInteger(INIT)); |
Ayaka Koshibe | 971a38a | 2014-09-30 11:56:23 -0700 | [diff] [blame] | 104 | backups.add(nodeId); |
| 105 | break; |
| 106 | default: |
| 107 | log.warn("unknown Mastership Role {}", role); |
| 108 | return null; |
Ayaka Koshibe | d9f693e | 2014-09-29 18:04:54 -0700 | [diff] [blame] | 109 | } |
Ayaka Koshibe | 406d010 | 2014-09-24 16:08:12 -0700 | [diff] [blame] | 110 | } |
Ayaka Koshibe | d9f693e | 2014-09-29 18:04:54 -0700 | [diff] [blame] | 111 | |
Ayaka Koshibe | fc981cf | 2014-10-21 12:44:17 -0700 | [diff] [blame] | 112 | return new MastershipEvent(MASTER_CHANGED, deviceId, |
| 113 | new RoleInfo(nodeId, Lists.newLinkedList(backups))); |
Ayaka Koshibe | a7f044e | 2014-09-23 16:56:20 -0700 | [diff] [blame] | 114 | } |
| 115 | |
| 116 | @Override |
Ayaka Koshibe | a7f044e | 2014-09-23 16:56:20 -0700 | [diff] [blame] | 117 | public NodeId getMaster(DeviceId deviceId) { |
Ayaka Koshibe | 406d010 | 2014-09-24 16:08:12 -0700 | [diff] [blame] | 118 | return masterMap.get(deviceId); |
Ayaka Koshibe | a7f044e | 2014-09-23 16:56:20 -0700 | [diff] [blame] | 119 | } |
| 120 | |
| 121 | @Override |
Ayaka Koshibe | abedb09 | 2014-10-20 17:01:31 -0700 | [diff] [blame] | 122 | public RoleInfo getNodes(DeviceId deviceId) { |
Ayaka Koshibe | f9b02fc | 2014-10-15 17:07:05 -0700 | [diff] [blame] | 123 | List<NodeId> nodes = new ArrayList<>(); |
Ayaka Koshibe | f9b02fc | 2014-10-15 17:07:05 -0700 | [diff] [blame] | 124 | nodes.addAll(backups); |
Ayaka Koshibe | f9b02fc | 2014-10-15 17:07:05 -0700 | [diff] [blame] | 125 | |
Ayaka Koshibe | abedb09 | 2014-10-20 17:01:31 -0700 | [diff] [blame] | 126 | return new RoleInfo(masterMap.get(deviceId), nodes); |
Ayaka Koshibe | 45503ce | 2014-10-14 11:26:45 -0700 | [diff] [blame] | 127 | } |
| 128 | |
| 129 | @Override |
Ayaka Koshibe | a7f044e | 2014-09-23 16:56:20 -0700 | [diff] [blame] | 130 | public Set<DeviceId> getDevices(NodeId nodeId) { |
Ayaka Koshibe | 406d010 | 2014-09-24 16:08:12 -0700 | [diff] [blame] | 131 | Set<DeviceId> ids = new HashSet<>(); |
| 132 | for (Map.Entry<DeviceId, NodeId> d : masterMap.entrySet()) { |
| 133 | if (d.getValue().equals(nodeId)) { |
| 134 | ids.add(d.getKey()); |
| 135 | } |
| 136 | } |
| 137 | return Collections.unmodifiableSet(ids); |
Ayaka Koshibe | a7f044e | 2014-09-23 16:56:20 -0700 | [diff] [blame] | 138 | } |
| 139 | |
| 140 | @Override |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 141 | public MastershipRole requestRole(DeviceId deviceId) { |
Ayaka Koshibe | 971a38a | 2014-09-30 11:56:23 -0700 | [diff] [blame] | 142 | //query+possible reelection |
| 143 | NodeId node = instance.id(); |
| 144 | MastershipRole role = getRole(node, deviceId); |
| 145 | |
| 146 | switch (role) { |
| 147 | case MASTER: |
| 148 | break; |
| 149 | case STANDBY: |
| 150 | synchronized (this) { |
| 151 | //try to "re-elect", since we're really not distributed |
| 152 | NodeId rel = reelect(node); |
| 153 | if (rel == null) { |
| 154 | masterMap.put(deviceId, node); |
Yuta HIGUCHI | dfe6e3b | 2014-10-30 11:31:51 -0700 | [diff] [blame] | 155 | termMap.put(deviceId, new AtomicInteger(INIT)); |
Ayaka Koshibe | 971a38a | 2014-09-30 11:56:23 -0700 | [diff] [blame] | 156 | role = MastershipRole.MASTER; |
| 157 | } |
| 158 | backups.add(node); |
| 159 | } |
| 160 | break; |
| 161 | case NONE: |
| 162 | //first to get to it, say we are master |
| 163 | synchronized (this) { |
| 164 | masterMap.put(deviceId, node); |
Yuta HIGUCHI | dfe6e3b | 2014-10-30 11:31:51 -0700 | [diff] [blame] | 165 | termMap.put(deviceId, new AtomicInteger(INIT)); |
Ayaka Koshibe | 971a38a | 2014-09-30 11:56:23 -0700 | [diff] [blame] | 166 | backups.add(node); |
| 167 | role = MastershipRole.MASTER; |
| 168 | } |
| 169 | break; |
| 170 | default: |
| 171 | log.warn("unknown Mastership Role {}", role); |
| 172 | } |
| 173 | return role; |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 174 | } |
| 175 | |
| 176 | @Override |
Ayaka Koshibe | a7f044e | 2014-09-23 16:56:20 -0700 | [diff] [blame] | 177 | public MastershipRole getRole(NodeId nodeId, DeviceId deviceId) { |
Ayaka Koshibe | 971a38a | 2014-09-30 11:56:23 -0700 | [diff] [blame] | 178 | //just query |
Ayaka Koshibe | d9f693e | 2014-09-29 18:04:54 -0700 | [diff] [blame] | 179 | NodeId current = masterMap.get(deviceId); |
Ayaka Koshibe | 971a38a | 2014-09-30 11:56:23 -0700 | [diff] [blame] | 180 | MastershipRole role; |
Ayaka Koshibe | d9f693e | 2014-09-29 18:04:54 -0700 | [diff] [blame] | 181 | |
| 182 | if (current == null) { |
Ayaka Koshibe | 971a38a | 2014-09-30 11:56:23 -0700 | [diff] [blame] | 183 | if (backups.contains(nodeId)) { |
| 184 | role = MastershipRole.STANDBY; |
| 185 | } else { |
| 186 | role = MastershipRole.NONE; |
Ayaka Koshibe | 406d010 | 2014-09-24 16:08:12 -0700 | [diff] [blame] | 187 | } |
| 188 | } else { |
Ayaka Koshibe | 971a38a | 2014-09-30 11:56:23 -0700 | [diff] [blame] | 189 | if (current.equals(nodeId)) { |
| 190 | role = MastershipRole.MASTER; |
| 191 | } else { |
| 192 | role = MastershipRole.STANDBY; |
Ayaka Koshibe | d9f693e | 2014-09-29 18:04:54 -0700 | [diff] [blame] | 193 | } |
Ayaka Koshibe | a7f044e | 2014-09-23 16:56:20 -0700 | [diff] [blame] | 194 | } |
Ayaka Koshibe | 971a38a | 2014-09-30 11:56:23 -0700 | [diff] [blame] | 195 | return role; |
Ayaka Koshibe | a7f044e | 2014-09-23 16:56:20 -0700 | [diff] [blame] | 196 | } |
| 197 | |
Ayaka Koshibe | b70d34b | 2014-09-25 15:43:01 -0700 | [diff] [blame] | 198 | @Override |
| 199 | public MastershipTerm getTermFor(DeviceId deviceId) { |
Yuta HIGUCHI | dfe6e3b | 2014-10-30 11:31:51 -0700 | [diff] [blame] | 200 | if ((termMap.get(deviceId) == null)) { |
| 201 | return MastershipTerm.of(masterMap.get(deviceId), NOTHING); |
Ayaka Koshibe | b70d34b | 2014-09-25 15:43:01 -0700 | [diff] [blame] | 202 | } |
| 203 | return MastershipTerm.of( |
| 204 | masterMap.get(deviceId), termMap.get(deviceId).get()); |
| 205 | } |
| 206 | |
Ayaka Koshibe | d9f693e | 2014-09-29 18:04:54 -0700 | [diff] [blame] | 207 | @Override |
Ayaka Koshibe | c404770 | 2014-10-07 14:43:52 -0700 | [diff] [blame] | 208 | public MastershipEvent setStandby(NodeId nodeId, DeviceId deviceId) { |
Ayaka Koshibe | 971a38a | 2014-09-30 11:56:23 -0700 | [diff] [blame] | 209 | MastershipRole role = getRole(nodeId, deviceId); |
| 210 | synchronized (this) { |
| 211 | switch (role) { |
| 212 | case MASTER: |
| 213 | NodeId backup = reelect(nodeId); |
| 214 | if (backup == null) { |
| 215 | masterMap.remove(deviceId); |
| 216 | } else { |
| 217 | masterMap.put(deviceId, backup); |
| 218 | termMap.get(deviceId).incrementAndGet(); |
Ayaka Koshibe | fc981cf | 2014-10-21 12:44:17 -0700 | [diff] [blame] | 219 | return new MastershipEvent(MASTER_CHANGED, deviceId, |
| 220 | new RoleInfo(backup, Lists.newLinkedList(backups))); |
Ayaka Koshibe | 971a38a | 2014-09-30 11:56:23 -0700 | [diff] [blame] | 221 | } |
| 222 | case STANDBY: |
| 223 | case NONE: |
| 224 | if (!termMap.containsKey(deviceId)) { |
Yuta HIGUCHI | dfe6e3b | 2014-10-30 11:31:51 -0700 | [diff] [blame] | 225 | termMap.put(deviceId, new AtomicInteger(INIT)); |
Ayaka Koshibe | 971a38a | 2014-09-30 11:56:23 -0700 | [diff] [blame] | 226 | } |
Ayaka Koshibe | d9f693e | 2014-09-29 18:04:54 -0700 | [diff] [blame] | 227 | backups.add(nodeId); |
Ayaka Koshibe | 971a38a | 2014-09-30 11:56:23 -0700 | [diff] [blame] | 228 | break; |
| 229 | default: |
| 230 | log.warn("unknown Mastership Role {}", role); |
Ayaka Koshibe | d9f693e | 2014-09-29 18:04:54 -0700 | [diff] [blame] | 231 | } |
| 232 | } |
| 233 | return null; |
| 234 | } |
| 235 | |
Ayaka Koshibe | 971a38a | 2014-09-30 11:56:23 -0700 | [diff] [blame] | 236 | //dumbly selects next-available node that's not the current one |
| 237 | //emulate leader election |
| 238 | private NodeId reelect(NodeId nodeId) { |
| 239 | NodeId backup = null; |
| 240 | for (NodeId n : backups) { |
| 241 | if (!n.equals(nodeId)) { |
| 242 | backup = n; |
| 243 | break; |
Ayaka Koshibe | d9f693e | 2014-09-29 18:04:54 -0700 | [diff] [blame] | 244 | } |
| 245 | } |
Ayaka Koshibe | b62aab5 | 2014-10-24 13:15:25 -0700 | [diff] [blame] | 246 | backups.remove(backup); |
Ayaka Koshibe | 971a38a | 2014-09-30 11:56:23 -0700 | [diff] [blame] | 247 | return backup; |
Ayaka Koshibe | d9f693e | 2014-09-29 18:04:54 -0700 | [diff] [blame] | 248 | } |
| 249 | |
Ayaka Koshibe | c404770 | 2014-10-07 14:43:52 -0700 | [diff] [blame] | 250 | @Override |
| 251 | public MastershipEvent relinquishRole(NodeId nodeId, DeviceId deviceId) { |
Ayaka Koshibe | b62aab5 | 2014-10-24 13:15:25 -0700 | [diff] [blame] | 252 | MastershipRole role = getRole(nodeId, deviceId); |
| 253 | synchronized (this) { |
| 254 | switch (role) { |
| 255 | case MASTER: |
| 256 | NodeId backup = reelect(nodeId); |
| 257 | backups.remove(nodeId); |
| 258 | if (backup == null) { |
| 259 | masterMap.remove(deviceId); |
| 260 | } else { |
| 261 | masterMap.put(deviceId, backup); |
| 262 | termMap.get(deviceId).incrementAndGet(); |
| 263 | return new MastershipEvent(MASTER_CHANGED, deviceId, |
| 264 | new RoleInfo(backup, Lists.newLinkedList(backups))); |
| 265 | } |
| 266 | case STANDBY: |
| 267 | backups.remove(nodeId); |
| 268 | case NONE: |
| 269 | default: |
| 270 | log.warn("unknown Mastership Role {}", role); |
| 271 | } |
| 272 | } |
| 273 | return null; |
Ayaka Koshibe | c404770 | 2014-10-07 14:43:52 -0700 | [diff] [blame] | 274 | } |
| 275 | |
Ayaka Koshibe | a7f044e | 2014-09-23 16:56:20 -0700 | [diff] [blame] | 276 | } |