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.net.device.impl; |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 17 | |
Thomas Vachuska | 42e8cce | 2015-07-29 19:25:18 -0700 | [diff] [blame] | 18 | import com.google.common.collect.Lists; |
Madan Jampani | 565a66a | 2015-07-25 17:01:13 -0700 | [diff] [blame] | 19 | import com.google.common.util.concurrent.Futures; |
| 20 | |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 21 | import org.apache.felix.scr.annotations.Activate; |
| 22 | import org.apache.felix.scr.annotations.Component; |
| 23 | import org.apache.felix.scr.annotations.Deactivate; |
tom | 5f38b3a | 2014-08-27 23:50:54 -0700 | [diff] [blame] | 24 | import org.apache.felix.scr.annotations.Reference; |
| 25 | import org.apache.felix.scr.annotations.ReferenceCardinality; |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 26 | import org.apache.felix.scr.annotations.Service; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 27 | import org.onosproject.cluster.ClusterService; |
| 28 | import org.onosproject.cluster.NodeId; |
Thomas Vachuska | 42e8cce | 2015-07-29 19:25:18 -0700 | [diff] [blame] | 29 | import org.onosproject.net.provider.AbstractListenerProviderRegistry; |
Changhoon Yoon | 541ef71 | 2015-05-23 17:18:34 +0900 | [diff] [blame] | 30 | import org.onosproject.core.Permission; |
Ray Milkey | a412236 | 2015-08-18 15:19:08 -0700 | [diff] [blame] | 31 | import org.onosproject.net.config.NetworkConfigEvent; |
| 32 | import org.onosproject.net.config.NetworkConfigListener; |
| 33 | import org.onosproject.net.config.NetworkConfigService; |
Sahil Lele | 3a0cdd5 | 2015-07-21 14:16:31 -0700 | [diff] [blame] | 34 | import org.onosproject.incubator.net.config.basics.BasicDeviceConfig; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 35 | import org.onosproject.mastership.MastershipEvent; |
| 36 | import org.onosproject.mastership.MastershipListener; |
| 37 | import org.onosproject.mastership.MastershipService; |
| 38 | import org.onosproject.mastership.MastershipTerm; |
| 39 | import org.onosproject.mastership.MastershipTermService; |
| 40 | import org.onosproject.net.Device; |
samuel | 738dfaf | 2015-07-11 11:08:57 +0800 | [diff] [blame] | 41 | import org.onosproject.net.Device.Type; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 42 | import org.onosproject.net.DeviceId; |
| 43 | import org.onosproject.net.MastershipRole; |
| 44 | import org.onosproject.net.Port; |
| 45 | import org.onosproject.net.PortNumber; |
| 46 | import org.onosproject.net.device.DefaultDeviceDescription; |
| 47 | import org.onosproject.net.device.DefaultPortDescription; |
| 48 | import org.onosproject.net.device.DeviceAdminService; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 49 | import org.onosproject.net.device.DeviceDescription; |
| 50 | import org.onosproject.net.device.DeviceEvent; |
| 51 | import org.onosproject.net.device.DeviceListener; |
| 52 | import org.onosproject.net.device.DeviceProvider; |
| 53 | import org.onosproject.net.device.DeviceProviderRegistry; |
| 54 | import org.onosproject.net.device.DeviceProviderService; |
| 55 | import org.onosproject.net.device.DeviceService; |
| 56 | import org.onosproject.net.device.DeviceStore; |
| 57 | import org.onosproject.net.device.DeviceStoreDelegate; |
| 58 | import org.onosproject.net.device.PortDescription; |
sangho | 538108b | 2015-04-08 14:29:20 -0700 | [diff] [blame] | 59 | import org.onosproject.net.device.PortStatistics; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 60 | import org.onosproject.net.provider.AbstractProviderService; |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 61 | import org.slf4j.Logger; |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 62 | |
Thomas Vachuska | 42e8cce | 2015-07-29 19:25:18 -0700 | [diff] [blame] | 63 | import java.util.Collection; |
| 64 | import java.util.HashSet; |
| 65 | import java.util.List; |
| 66 | import java.util.Objects; |
| 67 | import java.util.Set; |
| 68 | import java.util.concurrent.CompletableFuture; |
| 69 | import java.util.concurrent.ExecutionException; |
| 70 | import java.util.concurrent.ScheduledExecutorService; |
| 71 | import java.util.concurrent.TimeUnit; |
| 72 | |
| 73 | import static com.google.common.base.Preconditions.checkNotNull; |
| 74 | import static com.google.common.base.Preconditions.checkState; |
| 75 | import static java.util.concurrent.Executors.newSingleThreadScheduledExecutor; |
| 76 | import static org.onlab.util.Tools.groupedThreads; |
| 77 | import static org.onosproject.net.MastershipRole.*; |
| 78 | import static org.onosproject.security.AppGuard.checkPermission; |
| 79 | import static org.slf4j.LoggerFactory.getLogger; |
Jonathan Hart | 2f66936 | 2015-02-11 16:19:20 -0800 | [diff] [blame] | 80 | |
samuel | e1fa732 | 2015-07-14 16:35:16 +0800 | [diff] [blame] | 81 | |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 82 | /** |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 83 | * Provides implementation of the device SB & NB APIs. |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 84 | */ |
| 85 | @Component(immediate = true) |
| 86 | @Service |
tom | 41a2c5f | 2014-09-19 09:20:35 -0700 | [diff] [blame] | 87 | public class DeviceManager |
Thomas Vachuska | 42e8cce | 2015-07-29 19:25:18 -0700 | [diff] [blame] | 88 | extends AbstractListenerProviderRegistry<DeviceEvent, DeviceListener, DeviceProvider, DeviceProviderService> |
Thomas Vachuska | d16ce18 | 2014-10-29 17:25:29 -0700 | [diff] [blame] | 89 | implements DeviceService, DeviceAdminService, DeviceProviderRegistry { |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 90 | |
tom | e5ec3fd | 2014-09-04 15:18:06 -0700 | [diff] [blame] | 91 | private static final String DEVICE_ID_NULL = "Device ID cannot be null"; |
| 92 | private static final String PORT_NUMBER_NULL = "Port number cannot be null"; |
| 93 | private static final String DEVICE_DESCRIPTION_NULL = "Device description cannot be null"; |
| 94 | private static final String PORT_DESCRIPTION_NULL = "Port description cannot be null"; |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 95 | |
tom | 5f38b3a | 2014-08-27 23:50:54 -0700 | [diff] [blame] | 96 | private final Logger log = getLogger(getClass()); |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 97 | |
alshabib | 339a3d9 | 2014-09-26 17:54:32 -0700 | [diff] [blame] | 98 | private final DeviceStoreDelegate delegate = new InternalStoreDelegate(); |
tom | f80c972 | 2014-09-24 14:49:18 -0700 | [diff] [blame] | 99 | |
tom | c78acee | 2014-09-24 15:16:55 -0700 | [diff] [blame] | 100 | private final MastershipListener mastershipListener = new InternalMastershipListener(); |
Madan Jampani | de003d9 | 2015-05-11 17:14:20 -0700 | [diff] [blame] | 101 | private NodeId localNodeId; |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 102 | |
Yuta HIGUCHI | 63323fd | 2014-11-11 12:16:58 -0800 | [diff] [blame] | 103 | private ScheduledExecutorService backgroundService; |
| 104 | |
Sahil Lele | 3a0cdd5 | 2015-07-21 14:16:31 -0700 | [diff] [blame] | 105 | private final NetworkConfigListener networkConfigListener = new InternalNetworkConfigListener(); |
| 106 | |
tom | 41a2c5f | 2014-09-19 09:20:35 -0700 | [diff] [blame] | 107 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 108 | protected DeviceStore store; |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 109 | |
tom | 5f38b3a | 2014-08-27 23:50:54 -0700 | [diff] [blame] | 110 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 111 | protected ClusterService clusterService; |
| 112 | |
| 113 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
Ayaka Koshibe | a7f044e | 2014-09-23 16:56:20 -0700 | [diff] [blame] | 114 | protected MastershipService mastershipService; |
| 115 | |
Yuta HIGUCHI | bcac499 | 2014-11-22 19:27:57 -0800 | [diff] [blame] | 116 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
Ayaka Koshibe | 3de43ca | 2014-09-26 16:40:23 -0700 | [diff] [blame] | 117 | protected MastershipTermService termService; |
| 118 | |
Madan Jampani | 61056bc | 2014-09-27 09:07:26 -0700 | [diff] [blame] | 119 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
Sahil Lele | 3a0cdd5 | 2015-07-21 14:16:31 -0700 | [diff] [blame] | 120 | protected NetworkConfigService networkConfigService; |
| 121 | |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 122 | @Activate |
| 123 | public void activate() { |
samuel | e1fa732 | 2015-07-14 16:35:16 +0800 | [diff] [blame] | 124 | backgroundService = newSingleThreadScheduledExecutor(groupedThreads("onos/device", "manager-background")); |
Madan Jampani | de003d9 | 2015-05-11 17:14:20 -0700 | [diff] [blame] | 125 | localNodeId = clusterService.getLocalNode().id(); |
Yuta HIGUCHI | 63323fd | 2014-11-11 12:16:58 -0800 | [diff] [blame] | 126 | |
tom | f80c972 | 2014-09-24 14:49:18 -0700 | [diff] [blame] | 127 | store.setDelegate(delegate); |
tom | 96dfcab | 2014-08-28 09:26:03 -0700 | [diff] [blame] | 128 | eventDispatcher.addSink(DeviceEvent.class, listenerRegistry); |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 129 | mastershipService.addListener(mastershipListener); |
Sahil Lele | 3a0cdd5 | 2015-07-21 14:16:31 -0700 | [diff] [blame] | 130 | networkConfigService.addListener(networkConfigListener); |
Yuta HIGUCHI | 63323fd | 2014-11-11 12:16:58 -0800 | [diff] [blame] | 131 | |
Thomas Vachuska | 42e8cce | 2015-07-29 19:25:18 -0700 | [diff] [blame] | 132 | backgroundService.scheduleWithFixedDelay(() -> { |
| 133 | try { |
| 134 | mastershipCheck(); |
| 135 | } catch (Exception e) { |
| 136 | log.error("Exception thrown during integrity check", e); |
Yuta HIGUCHI | 63323fd | 2014-11-11 12:16:58 -0800 | [diff] [blame] | 137 | } |
| 138 | }, 1, 1, TimeUnit.MINUTES); |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 139 | log.info("Started"); |
| 140 | } |
| 141 | |
| 142 | @Deactivate |
| 143 | public void deactivate() { |
Yuta HIGUCHI | 63323fd | 2014-11-11 12:16:58 -0800 | [diff] [blame] | 144 | backgroundService.shutdown(); |
Sahil Lele | 3a0cdd5 | 2015-07-21 14:16:31 -0700 | [diff] [blame] | 145 | networkConfigService.removeListener(networkConfigListener); |
tom | f80c972 | 2014-09-24 14:49:18 -0700 | [diff] [blame] | 146 | store.unsetDelegate(delegate); |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 147 | mastershipService.removeListener(mastershipListener); |
tom | 5f38b3a | 2014-08-27 23:50:54 -0700 | [diff] [blame] | 148 | eventDispatcher.removeSink(DeviceEvent.class); |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 149 | log.info("Stopped"); |
| 150 | } |
| 151 | |
| 152 | @Override |
tom | ad2d209 | 2014-09-06 23:24:20 -0700 | [diff] [blame] | 153 | public int getDeviceCount() { |
Changhoon Yoon | 541ef71 | 2015-05-23 17:18:34 +0900 | [diff] [blame] | 154 | checkPermission(Permission.DEVICE_READ); |
tom | ad2d209 | 2014-09-06 23:24:20 -0700 | [diff] [blame] | 155 | return store.getDeviceCount(); |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 156 | } |
| 157 | |
| 158 | @Override |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 159 | public Iterable<Device> getDevices() { |
Changhoon Yoon | 541ef71 | 2015-05-23 17:18:34 +0900 | [diff] [blame] | 160 | checkPermission(Permission.DEVICE_READ); |
tom | e5ec3fd | 2014-09-04 15:18:06 -0700 | [diff] [blame] | 161 | return store.getDevices(); |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 162 | } |
| 163 | |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 164 | @Override |
Yuta HIGUCHI | f1f2ac0 | 2014-11-26 14:02:22 -0800 | [diff] [blame] | 165 | public Iterable<Device> getAvailableDevices() { |
Changhoon Yoon | 541ef71 | 2015-05-23 17:18:34 +0900 | [diff] [blame] | 166 | checkPermission(Permission.DEVICE_READ); |
Yuta HIGUCHI | f1f2ac0 | 2014-11-26 14:02:22 -0800 | [diff] [blame] | 167 | return store.getAvailableDevices(); |
| 168 | } |
| 169 | |
| 170 | @Override |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 171 | public Device getDevice(DeviceId deviceId) { |
Changhoon Yoon | 541ef71 | 2015-05-23 17:18:34 +0900 | [diff] [blame] | 172 | checkPermission(Permission.DEVICE_READ); |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 173 | checkNotNull(deviceId, DEVICE_ID_NULL); |
tom | 132b58a | 2014-08-28 16:11:28 -0700 | [diff] [blame] | 174 | return store.getDevice(deviceId); |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 175 | } |
| 176 | |
| 177 | @Override |
tom | ad2d209 | 2014-09-06 23:24:20 -0700 | [diff] [blame] | 178 | public MastershipRole getRole(DeviceId deviceId) { |
Changhoon Yoon | 541ef71 | 2015-05-23 17:18:34 +0900 | [diff] [blame] | 179 | checkPermission(Permission.DEVICE_READ); |
tom | ad2d209 | 2014-09-06 23:24:20 -0700 | [diff] [blame] | 180 | checkNotNull(deviceId, DEVICE_ID_NULL); |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 181 | return mastershipService.getLocalRole(deviceId); |
tom | ad2d209 | 2014-09-06 23:24:20 -0700 | [diff] [blame] | 182 | } |
| 183 | |
| 184 | @Override |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 185 | public List<Port> getPorts(DeviceId deviceId) { |
Changhoon Yoon | 541ef71 | 2015-05-23 17:18:34 +0900 | [diff] [blame] | 186 | checkPermission(Permission.DEVICE_READ); |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 187 | checkNotNull(deviceId, DEVICE_ID_NULL); |
tom | 132b58a | 2014-08-28 16:11:28 -0700 | [diff] [blame] | 188 | return store.getPorts(deviceId); |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 189 | } |
| 190 | |
| 191 | @Override |
sangho | 538108b | 2015-04-08 14:29:20 -0700 | [diff] [blame] | 192 | public List<PortStatistics> getPortStatistics(DeviceId deviceId) { |
Changhoon Yoon | 541ef71 | 2015-05-23 17:18:34 +0900 | [diff] [blame] | 193 | checkPermission(Permission.DEVICE_READ); |
sangho | 538108b | 2015-04-08 14:29:20 -0700 | [diff] [blame] | 194 | checkNotNull(deviceId, DEVICE_ID_NULL); |
| 195 | return store.getPortStatistics(deviceId); |
| 196 | } |
| 197 | |
| 198 | @Override |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 199 | public Port getPort(DeviceId deviceId, PortNumber portNumber) { |
Changhoon Yoon | 541ef71 | 2015-05-23 17:18:34 +0900 | [diff] [blame] | 200 | checkPermission(Permission.DEVICE_READ); |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 201 | checkNotNull(deviceId, DEVICE_ID_NULL); |
| 202 | checkNotNull(portNumber, PORT_NUMBER_NULL); |
tom | 132b58a | 2014-08-28 16:11:28 -0700 | [diff] [blame] | 203 | return store.getPort(deviceId, portNumber); |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 204 | } |
| 205 | |
| 206 | @Override |
tom | ff7eb7c | 2014-09-08 12:49:03 -0700 | [diff] [blame] | 207 | public boolean isAvailable(DeviceId deviceId) { |
Changhoon Yoon | 541ef71 | 2015-05-23 17:18:34 +0900 | [diff] [blame] | 208 | checkPermission(Permission.DEVICE_READ); |
| 209 | |
tom | ff7eb7c | 2014-09-08 12:49:03 -0700 | [diff] [blame] | 210 | checkNotNull(deviceId, DEVICE_ID_NULL); |
| 211 | return store.isAvailable(deviceId); |
| 212 | } |
| 213 | |
Ayaka Koshibe | e60d452 | 2014-10-28 15:07:00 -0700 | [diff] [blame] | 214 | // Check a device for control channel connectivity. |
Yuta HIGUCHI | 5481532 | 2014-10-31 23:17:08 -0700 | [diff] [blame] | 215 | private boolean isReachable(DeviceId deviceId) { |
Ayaka Koshibe | 78bcbc1 | 2014-11-19 14:28:58 -0800 | [diff] [blame] | 216 | if (deviceId == null) { |
| 217 | return false; |
| 218 | } |
Yuta HIGUCHI | 5481532 | 2014-10-31 23:17:08 -0700 | [diff] [blame] | 219 | DeviceProvider provider = getProvider(deviceId); |
| 220 | if (provider != null) { |
| 221 | return provider.isReachable(deviceId); |
| 222 | } else { |
Yuta HIGUCHI | 72669c4 | 2014-11-13 14:48:17 -0800 | [diff] [blame] | 223 | log.debug("Provider not found for {}", deviceId); |
Ayaka Koshibe | e60d452 | 2014-10-28 15:07:00 -0700 | [diff] [blame] | 224 | return false; |
| 225 | } |
Ayaka Koshibe | e8708e3 | 2014-10-22 13:40:18 -0700 | [diff] [blame] | 226 | } |
| 227 | |
tom | e5ec3fd | 2014-09-04 15:18:06 -0700 | [diff] [blame] | 228 | @Override |
| 229 | public void removeDevice(DeviceId deviceId) { |
| 230 | checkNotNull(deviceId, DEVICE_ID_NULL); |
| 231 | DeviceEvent event = store.removeDevice(deviceId); |
tom | 0efbb1d | 2014-09-09 11:54:28 -0700 | [diff] [blame] | 232 | if (event != null) { |
| 233 | log.info("Device {} administratively removed", deviceId); |
| 234 | post(event); |
| 235 | } |
tom | e5ec3fd | 2014-09-04 15:18:06 -0700 | [diff] [blame] | 236 | } |
| 237 | |
tom | 7869ad9 | 2014-09-09 14:32:08 -0700 | [diff] [blame] | 238 | @Override |
samuel | e1fa732 | 2015-07-14 16:35:16 +0800 | [diff] [blame] | 239 | protected DeviceProviderService createProviderService( |
| 240 | DeviceProvider provider) { |
tom | 7869ad9 | 2014-09-09 14:32:08 -0700 | [diff] [blame] | 241 | return new InternalDeviceProviderService(provider); |
| 242 | } |
| 243 | |
Yuta HIGUCHI | 63323fd | 2014-11-11 12:16:58 -0800 | [diff] [blame] | 244 | /** |
| 245 | * Checks if all the reachable devices have a valid mastership role. |
| 246 | */ |
| 247 | private void mastershipCheck() { |
| 248 | log.debug("Checking mastership"); |
| 249 | for (Device device : getDevices()) { |
| 250 | final DeviceId deviceId = device.id(); |
Jonathan Hart | 2f66936 | 2015-02-11 16:19:20 -0800 | [diff] [blame] | 251 | log.trace("Checking device {}", deviceId); |
Yuta HIGUCHI | 63323fd | 2014-11-11 12:16:58 -0800 | [diff] [blame] | 252 | |
| 253 | if (!isReachable(deviceId)) { |
| 254 | continue; |
| 255 | } |
| 256 | |
| 257 | if (mastershipService.getLocalRole(deviceId) != NONE) { |
| 258 | continue; |
| 259 | } |
| 260 | |
Sahil Lele | 3a0cdd5 | 2015-07-21 14:16:31 -0700 | [diff] [blame] | 261 | log.info("{} is reachable but did not have a valid role, reasserting", |
| 262 | deviceId); |
Yuta HIGUCHI | 63323fd | 2014-11-11 12:16:58 -0800 | [diff] [blame] | 263 | |
| 264 | // isReachable but was not MASTER or STANDBY, get a role and apply |
| 265 | // Note: NONE triggers request to MastershipService |
| 266 | reassertRole(deviceId, NONE); |
| 267 | } |
| 268 | } |
| 269 | |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 270 | // Personalized device provider service issued to the supplied provider. |
tom | dc361b6 | 2014-09-09 20:36:52 -0700 | [diff] [blame] | 271 | private class InternalDeviceProviderService |
Thomas Vachuska | d16ce18 | 2014-10-29 17:25:29 -0700 | [diff] [blame] | 272 | extends AbstractProviderService<DeviceProvider> |
| 273 | implements DeviceProviderService { |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 274 | |
tom | cfde062 | 2014-09-09 11:02:42 -0700 | [diff] [blame] | 275 | InternalDeviceProviderService(DeviceProvider provider) { |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 276 | super(provider); |
| 277 | } |
| 278 | |
Yuta HIGUCHI | d26354d | 2014-10-31 14:14:38 -0700 | [diff] [blame] | 279 | /** |
| 280 | * Apply role in reaction to provider event. |
| 281 | * |
Thomas Vachuska | 42e8cce | 2015-07-29 19:25:18 -0700 | [diff] [blame] | 282 | * @param deviceId device identifier |
| 283 | * @param newRole new role to apply to the device |
Yuta HIGUCHI | d26354d | 2014-10-31 14:14:38 -0700 | [diff] [blame] | 284 | * @return true if the request was sent to provider |
| 285 | */ |
| 286 | private boolean applyRole(DeviceId deviceId, MastershipRole newRole) { |
| 287 | |
| 288 | if (newRole.equals(MastershipRole.NONE)) { |
samuel | e1fa732 | 2015-07-14 16:35:16 +0800 | [diff] [blame] | 289 | //no-op |
Yuta HIGUCHI | d26354d | 2014-10-31 14:14:38 -0700 | [diff] [blame] | 290 | return true; |
| 291 | } |
| 292 | |
| 293 | DeviceProvider provider = provider(); |
| 294 | if (provider == null) { |
Sahil Lele | 3a0cdd5 | 2015-07-21 14:16:31 -0700 | [diff] [blame] | 295 | log.warn("Provider for {} was not found. Cannot apply role {}", |
| 296 | deviceId, newRole); |
Yuta HIGUCHI | d26354d | 2014-10-31 14:14:38 -0700 | [diff] [blame] | 297 | return false; |
| 298 | } |
Yuta HIGUCHI | 5481532 | 2014-10-31 23:17:08 -0700 | [diff] [blame] | 299 | provider.roleChanged(deviceId, newRole); |
| 300 | // not triggering probe when triggered by provider service event |
Yuta HIGUCHI | d26354d | 2014-10-31 14:14:38 -0700 | [diff] [blame] | 301 | |
Yuta HIGUCHI | d26354d | 2014-10-31 14:14:38 -0700 | [diff] [blame] | 302 | return true; |
| 303 | } |
| 304 | |
samuel | e1fa732 | 2015-07-14 16:35:16 +0800 | [diff] [blame] | 305 | |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 306 | @Override |
alshabib | b7b4063 | 2014-09-28 21:30:00 -0700 | [diff] [blame] | 307 | public void deviceConnected(DeviceId deviceId, |
Thomas Vachuska | d16ce18 | 2014-10-29 17:25:29 -0700 | [diff] [blame] | 308 | DeviceDescription deviceDescription) { |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 309 | checkNotNull(deviceId, DEVICE_ID_NULL); |
| 310 | checkNotNull(deviceDescription, DEVICE_DESCRIPTION_NULL); |
tom | eadbb46 | 2014-09-07 16:10:19 -0700 | [diff] [blame] | 311 | checkValidity(); |
Sahil Lele | 3a0cdd5 | 2015-07-21 14:16:31 -0700 | [diff] [blame] | 312 | deviceDescription = validateDevice(deviceDescription, deviceId); |
Yuta HIGUCHI | 24b2e2a | 2014-10-07 15:53:57 -0700 | [diff] [blame] | 313 | |
Madan Jampani | 565a66a | 2015-07-25 17:01:13 -0700 | [diff] [blame] | 314 | // Establish my Role |
| 315 | Futures.getUnchecked(mastershipService.requestRoleFor(deviceId) |
| 316 | .thenAccept(role -> { |
| 317 | log.info("Local role is {} for {}", role, deviceId); |
| 318 | applyRole(deviceId, role); |
| 319 | })); |
HIGUCHI Yuta | 11530fb | 2015-05-27 13:10:20 -0700 | [diff] [blame] | 320 | |
Sahil Lele | 3a0cdd5 | 2015-07-21 14:16:31 -0700 | [diff] [blame] | 321 | DeviceEvent event = store.createOrUpdateDevice(provider().id(), deviceId, |
| 322 | deviceDescription); |
tom | 80c0e5e | 2014-09-08 18:08:58 -0700 | [diff] [blame] | 323 | if (event != null) { |
Yuta HIGUCHI | d26354d | 2014-10-31 14:14:38 -0700 | [diff] [blame] | 324 | log.trace("event: {} {}", event.type(), event); |
tom | 568581d | 2014-09-08 20:13:36 -0700 | [diff] [blame] | 325 | post(event); |
tom | 80c0e5e | 2014-09-08 18:08:58 -0700 | [diff] [blame] | 326 | } |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 327 | } |
| 328 | |
Sahil Lele | 3a0cdd5 | 2015-07-21 14:16:31 -0700 | [diff] [blame] | 329 | // returns a DeviceDescription made from the union of the BasicDeviceConfig |
| 330 | // annotations if it exists |
| 331 | private DeviceDescription validateDevice(DeviceDescription deviceDescription, DeviceId deviceId) { |
| 332 | BasicDeviceConfig cfg = networkConfigService.getConfig(deviceId, BasicDeviceConfig.class); |
| 333 | checkState(cfg == null || cfg.isAllowed(), "Device " + deviceId + " is not allowed"); |
| 334 | log.info("Device {} connected", deviceId); |
Ayaka Koshibe | 5373e76 | 2015-08-06 12:31:44 -0700 | [diff] [blame] | 335 | |
| 336 | return BasicDeviceOperator.combine(cfg, deviceDescription); |
Sahil Lele | 3a0cdd5 | 2015-07-21 14:16:31 -0700 | [diff] [blame] | 337 | } |
| 338 | |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 339 | @Override |
| 340 | public void deviceDisconnected(DeviceId deviceId) { |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 341 | checkNotNull(deviceId, DEVICE_ID_NULL); |
tom | eadbb46 | 2014-09-07 16:10:19 -0700 | [diff] [blame] | 342 | checkValidity(); |
Yuta HIGUCHI | cf60390 | 2014-10-07 23:04:32 -0700 | [diff] [blame] | 343 | |
Yuta HIGUCHI | 2d3cd31 | 2014-10-31 11:38:04 -0700 | [diff] [blame] | 344 | log.info("Device {} disconnected from this node", deviceId); |
Ayaka Koshibe | d9f693e | 2014-09-29 18:04:54 -0700 | [diff] [blame] | 345 | |
alshabib | afc514a | 2014-12-01 14:44:05 -0800 | [diff] [blame] | 346 | List<Port> ports = store.getPorts(deviceId); |
| 347 | List<PortDescription> descs = Lists.newArrayList(); |
samuel | e1fa732 | 2015-07-14 16:35:16 +0800 | [diff] [blame] | 348 | ports.forEach(port -> |
Thomas Vachuska | 42e8cce | 2015-07-29 19:25:18 -0700 | [diff] [blame] | 349 | descs.add(new DefaultPortDescription(port.number(), |
| 350 | false, port.type(), |
| 351 | port.portSpeed()))); |
alshabib | afc514a | 2014-12-01 14:44:05 -0800 | [diff] [blame] | 352 | store.updatePorts(this.provider().id(), deviceId, descs); |
Ayaka Koshibe | b5c63a0 | 2014-10-18 18:42:27 -0700 | [diff] [blame] | 353 | try { |
Madan Jampani | 565a66a | 2015-07-25 17:01:13 -0700 | [diff] [blame] | 354 | if (mastershipService.isLocalMaster(deviceId)) { |
Thomas Vachuska | 5f429d6 | 2015-05-28 15:34:36 -0700 | [diff] [blame] | 355 | post(store.markOffline(deviceId)); |
| 356 | } |
Ayaka Koshibe | b5c63a0 | 2014-10-18 18:42:27 -0700 | [diff] [blame] | 357 | } catch (IllegalStateException e) { |
Yuta HIGUCHI | eb24e9d | 2014-10-26 19:34:20 -0700 | [diff] [blame] | 358 | log.warn("Failed to mark {} offline", deviceId); |
| 359 | // only the MASTER should be marking off-line in normal cases, |
samuel | e1fa732 | 2015-07-14 16:35:16 +0800 | [diff] [blame] | 360 | // but if I was the last STANDBY connection, etc. and no one else |
| 361 | // was there to mark the device offline, this instance may need to |
Yuta HIGUCHI | eb24e9d | 2014-10-26 19:34:20 -0700 | [diff] [blame] | 362 | // temporarily request for Master Role and mark offline. |
| 363 | |
samuel | e1fa732 | 2015-07-14 16:35:16 +0800 | [diff] [blame] | 364 | //there are times when this node will correctly have mastership, BUT |
| 365 | //that isn't reflected in the ClockManager before the device disconnects. |
| 366 | //we want to let go of the device anyways, so make sure this happens. |
Yuta HIGUCHI | 0722fb2 | 2014-10-19 01:16:33 -0700 | [diff] [blame] | 367 | |
Yuta HIGUCHI | eb24e9d | 2014-10-26 19:34:20 -0700 | [diff] [blame] | 368 | // FIXME: Store semantics leaking out as IllegalStateException. |
samuel | e1fa732 | 2015-07-14 16:35:16 +0800 | [diff] [blame] | 369 | // Consider revising store API to handle this scenario. |
| 370 | CompletableFuture<MastershipRole> roleFuture = mastershipService.requestRoleFor(deviceId); |
Madan Jampani | de003d9 | 2015-05-11 17:14:20 -0700 | [diff] [blame] | 371 | roleFuture.whenComplete((role, error) -> { |
samuel | e1fa732 | 2015-07-14 16:35:16 +0800 | [diff] [blame] | 372 | MastershipTerm term = termService.getMastershipTerm(deviceId); |
| 373 | // TODO: Move this type of check inside device clock manager, etc. |
| 374 | if (term != null && localNodeId.equals(term.master())) { |
| 375 | log.info("Retry marking {} offline", deviceId); |
samuel | e1fa732 | 2015-07-14 16:35:16 +0800 | [diff] [blame] | 376 | post(store.markOffline(deviceId)); |
| 377 | } else { |
| 378 | log.info("Failed again marking {} offline. {}", deviceId, role); |
| 379 | } |
| 380 | }); |
Ayaka Koshibe | b5c63a0 | 2014-10-18 18:42:27 -0700 | [diff] [blame] | 381 | } finally { |
Madan Jampani | c6e574f | 2015-05-29 13:41:52 -0700 | [diff] [blame] | 382 | try { |
samuel | e1fa732 | 2015-07-14 16:35:16 +0800 | [diff] [blame] | 383 | //relinquish master role and ability to be backup. |
Madan Jampani | c6e574f | 2015-05-29 13:41:52 -0700 | [diff] [blame] | 384 | mastershipService.relinquishMastership(deviceId).get(); |
| 385 | } catch (InterruptedException e) { |
samuel | e1fa732 | 2015-07-14 16:35:16 +0800 | [diff] [blame] | 386 | log.warn("Interrupted while reliquishing role for {}", deviceId); |
Madan Jampani | c6e574f | 2015-05-29 13:41:52 -0700 | [diff] [blame] | 387 | Thread.currentThread().interrupt(); |
| 388 | } catch (ExecutionException e) { |
samuel | e1fa732 | 2015-07-14 16:35:16 +0800 | [diff] [blame] | 389 | log.error("Exception thrown while relinquishing role for {}", deviceId, e); |
Madan Jampani | c6e574f | 2015-05-29 13:41:52 -0700 | [diff] [blame] | 390 | } |
tom | 0efbb1d | 2014-09-09 11:54:28 -0700 | [diff] [blame] | 391 | } |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 392 | } |
| 393 | |
| 394 | @Override |
alshabib | b7b4063 | 2014-09-28 21:30:00 -0700 | [diff] [blame] | 395 | public void updatePorts(DeviceId deviceId, |
Thomas Vachuska | d16ce18 | 2014-10-29 17:25:29 -0700 | [diff] [blame] | 396 | List<PortDescription> portDescriptions) { |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 397 | checkNotNull(deviceId, DEVICE_ID_NULL); |
alshabib | b7b4063 | 2014-09-28 21:30:00 -0700 | [diff] [blame] | 398 | checkNotNull(portDescriptions, |
Thomas Vachuska | 42e8cce | 2015-07-29 19:25:18 -0700 | [diff] [blame] | 399 | "Port descriptions list cannot be null"); |
tom | eadbb46 | 2014-09-07 16:10:19 -0700 | [diff] [blame] | 400 | checkValidity(); |
Madan Jampani | 565a66a | 2015-07-25 17:01:13 -0700 | [diff] [blame] | 401 | if (!mastershipService.isLocalMaster(deviceId)) { |
Yuta HIGUCHI | 13c0b87 | 2014-10-30 18:09:22 -0700 | [diff] [blame] | 402 | // Never been a master for this device |
| 403 | // any update will be ignored. |
samuel | e1fa732 | 2015-07-14 16:35:16 +0800 | [diff] [blame] | 404 | log.trace("Ignoring {} port updates on standby node. {}", deviceId, portDescriptions); |
Yuta HIGUCHI | 13c0b87 | 2014-10-30 18:09:22 -0700 | [diff] [blame] | 405 | return; |
| 406 | } |
| 407 | |
Yuta HIGUCHI | 5f6739c | 2014-10-01 14:04:01 -0700 | [diff] [blame] | 408 | List<DeviceEvent> events = store.updatePorts(this.provider().id(), |
samuel | e1fa732 | 2015-07-14 16:35:16 +0800 | [diff] [blame] | 409 | deviceId, portDescriptions); |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 410 | for (DeviceEvent event : events) { |
| 411 | post(event); |
| 412 | } |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 413 | } |
| 414 | |
| 415 | @Override |
alshabib | b7b4063 | 2014-09-28 21:30:00 -0700 | [diff] [blame] | 416 | public void portStatusChanged(DeviceId deviceId, |
Thomas Vachuska | d16ce18 | 2014-10-29 17:25:29 -0700 | [diff] [blame] | 417 | PortDescription portDescription) { |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 418 | checkNotNull(deviceId, DEVICE_ID_NULL); |
| 419 | checkNotNull(portDescription, PORT_DESCRIPTION_NULL); |
tom | eadbb46 | 2014-09-07 16:10:19 -0700 | [diff] [blame] | 420 | checkValidity(); |
Ayaka Koshibe | b5c63a0 | 2014-10-18 18:42:27 -0700 | [diff] [blame] | 421 | |
Madan Jampani | 565a66a | 2015-07-25 17:01:13 -0700 | [diff] [blame] | 422 | if (!mastershipService.isLocalMaster(deviceId)) { |
Yuta HIGUCHI | 13c0b87 | 2014-10-30 18:09:22 -0700 | [diff] [blame] | 423 | // Never been a master for this device |
| 424 | // any update will be ignored. |
Sahil Lele | 3a0cdd5 | 2015-07-21 14:16:31 -0700 | [diff] [blame] | 425 | log.trace("Ignoring {} port update on standby node. {}", deviceId, |
| 426 | portDescription); |
Yuta HIGUCHI | 13c0b87 | 2014-10-30 18:09:22 -0700 | [diff] [blame] | 427 | return; |
| 428 | } |
| 429 | |
samuel | e1fa732 | 2015-07-14 16:35:16 +0800 | [diff] [blame] | 430 | final DeviceEvent event = store.updatePortStatus(this.provider().id(), |
| 431 | deviceId, portDescription); |
tom | ff7eb7c | 2014-09-08 12:49:03 -0700 | [diff] [blame] | 432 | if (event != null) { |
alshabib | b7b4063 | 2014-09-28 21:30:00 -0700 | [diff] [blame] | 433 | log.info("Device {} port {} status changed", deviceId, event |
| 434 | .port().number()); |
tom | 0efbb1d | 2014-09-09 11:54:28 -0700 | [diff] [blame] | 435 | post(event); |
tom | ff7eb7c | 2014-09-08 12:49:03 -0700 | [diff] [blame] | 436 | } |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 437 | } |
tom | 3f2bbd7 | 2014-09-24 12:07:58 -0700 | [diff] [blame] | 438 | |
| 439 | @Override |
samuel | e1fa732 | 2015-07-14 16:35:16 +0800 | [diff] [blame] | 440 | public void receivedRoleReply(DeviceId deviceId, MastershipRole requested, |
Thomas Vachuska | b17c41f | 2015-05-19 11:16:05 -0700 | [diff] [blame] | 441 | MastershipRole response) { |
Ayaka Koshibe | 3ef2b0d | 2014-10-31 13:58:27 -0700 | [diff] [blame] | 442 | // Several things can happen here: |
| 443 | // 1. request and response match |
| 444 | // 2. request and response don't match |
| 445 | // 3. MastershipRole and requested match (and 1 or 2 are true) |
| 446 | // 4. MastershipRole and requested don't match (and 1 or 2 are true) |
| 447 | // |
| 448 | // 2, 4, and 3 with case 2 are failure modes. |
| 449 | |
tom | 3f2bbd7 | 2014-09-24 12:07:58 -0700 | [diff] [blame] | 450 | // FIXME: implement response to this notification |
Ayaka Koshibe | 3ef2b0d | 2014-10-31 13:58:27 -0700 | [diff] [blame] | 451 | |
Madan Jampani | f2af771 | 2015-05-29 18:43:52 -0700 | [diff] [blame] | 452 | log.debug("got reply to a role request for {}: asked for {}, and got {}", |
Thomas Vachuska | 42e8cce | 2015-07-29 19:25:18 -0700 | [diff] [blame] | 453 | deviceId, requested, response); |
Ayaka Koshibe | 3ef2b0d | 2014-10-31 13:58:27 -0700 | [diff] [blame] | 454 | |
| 455 | if (requested == null && response == null) { |
samuel | e1fa732 | 2015-07-14 16:35:16 +0800 | [diff] [blame] | 456 | // something was off with DeviceProvider, maybe check channel too? |
| 457 | log.warn("Failed to assert role [{}] onto Device {}", requested, deviceId); |
Yuta HIGUCHI | cf60390 | 2014-10-07 23:04:32 -0700 | [diff] [blame] | 458 | mastershipService.relinquishMastership(deviceId); |
Ayaka Koshibe | 3ef2b0d | 2014-10-31 13:58:27 -0700 | [diff] [blame] | 459 | return; |
Yuta HIGUCHI | cf60390 | 2014-10-07 23:04:32 -0700 | [diff] [blame] | 460 | } |
Ayaka Koshibe | 3ef2b0d | 2014-10-31 13:58:27 -0700 | [diff] [blame] | 461 | |
Thomas Vachuska | b17c41f | 2015-05-19 11:16:05 -0700 | [diff] [blame] | 462 | if (Objects.equals(requested, response)) { |
samuel | e1fa732 | 2015-07-14 16:35:16 +0800 | [diff] [blame] | 463 | if (Objects.equals(requested, mastershipService.getLocalRole(deviceId))) { |
Ayaka Koshibe | 3ef2b0d | 2014-10-31 13:58:27 -0700 | [diff] [blame] | 464 | return; |
| 465 | } else { |
| 466 | return; |
samuel | e1fa732 | 2015-07-14 16:35:16 +0800 | [diff] [blame] | 467 | // FIXME roleManager got the device to comply, but doesn't agree with |
Ayaka Koshibe | 3ef2b0d | 2014-10-31 13:58:27 -0700 | [diff] [blame] | 468 | // the store; use the store's view, then try to reassert. |
| 469 | } |
| 470 | } else { |
| 471 | // we didn't get back what we asked for. Reelect someone else. |
samuel | e1fa732 | 2015-07-14 16:35:16 +0800 | [diff] [blame] | 472 | log.warn("Failed to assert role [{}] onto Device {}", response, deviceId); |
Ayaka Koshibe | 3ef2b0d | 2014-10-31 13:58:27 -0700 | [diff] [blame] | 473 | if (response == MastershipRole.MASTER) { |
| 474 | mastershipService.relinquishMastership(deviceId); |
| 475 | // TODO: Shouldn't we be triggering event? |
samuel | e1fa732 | 2015-07-14 16:35:16 +0800 | [diff] [blame] | 476 | //final Device device = getDevice(deviceId); |
| 477 | //post(new DeviceEvent(DEVICE_MASTERSHIP_CHANGED, device)); |
Ayaka Koshibe | 3ef2b0d | 2014-10-31 13:58:27 -0700 | [diff] [blame] | 478 | } |
| 479 | } |
tom | 3f2bbd7 | 2014-09-24 12:07:58 -0700 | [diff] [blame] | 480 | } |
sangho | 538108b | 2015-04-08 14:29:20 -0700 | [diff] [blame] | 481 | |
| 482 | @Override |
samuel | e1fa732 | 2015-07-14 16:35:16 +0800 | [diff] [blame] | 483 | public void updatePortStatistics(DeviceId deviceId, Collection<PortStatistics> portStatistics) { |
sangho | 538108b | 2015-04-08 14:29:20 -0700 | [diff] [blame] | 484 | checkNotNull(deviceId, DEVICE_ID_NULL); |
Thomas Vachuska | b17c41f | 2015-05-19 11:16:05 -0700 | [diff] [blame] | 485 | checkNotNull(portStatistics, "Port statistics list cannot be null"); |
sangho | 538108b | 2015-04-08 14:29:20 -0700 | [diff] [blame] | 486 | checkValidity(); |
| 487 | |
samuel | e1fa732 | 2015-07-14 16:35:16 +0800 | [diff] [blame] | 488 | DeviceEvent event = store.updatePortStatistics(this.provider().id(), |
| 489 | deviceId, portStatistics); |
sangho | 538108b | 2015-04-08 14:29:20 -0700 | [diff] [blame] | 490 | post(event); |
| 491 | } |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 492 | } |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 493 | |
Yuta HIGUCHI | 63323fd | 2014-11-11 12:16:58 -0800 | [diff] [blame] | 494 | // Applies the specified role to the device; ignores NONE |
Thomas Vachuska | 42e8cce | 2015-07-29 19:25:18 -0700 | [diff] [blame] | 495 | |
Yuta HIGUCHI | 63323fd | 2014-11-11 12:16:58 -0800 | [diff] [blame] | 496 | /** |
| 497 | * Apply role to device and send probe if MASTER. |
| 498 | * |
Thomas Vachuska | 42e8cce | 2015-07-29 19:25:18 -0700 | [diff] [blame] | 499 | * @param deviceId device identifier |
| 500 | * @param newRole new role to apply to the device |
Yuta HIGUCHI | 63323fd | 2014-11-11 12:16:58 -0800 | [diff] [blame] | 501 | * @return true if the request was sent to provider |
| 502 | */ |
| 503 | private boolean applyRoleAndProbe(DeviceId deviceId, MastershipRole newRole) { |
| 504 | if (newRole.equals(MastershipRole.NONE)) { |
samuel | e1fa732 | 2015-07-14 16:35:16 +0800 | [diff] [blame] | 505 | //no-op |
Yuta HIGUCHI | d26354d | 2014-10-31 14:14:38 -0700 | [diff] [blame] | 506 | return true; |
| 507 | } |
Ayaka Koshibe | 317245a | 2014-10-29 00:34:43 -0700 | [diff] [blame] | 508 | |
Ayaka Koshibe | 78bcbc1 | 2014-11-19 14:28:58 -0800 | [diff] [blame] | 509 | DeviceProvider provider = getProvider(deviceId); |
Yuta HIGUCHI | 63323fd | 2014-11-11 12:16:58 -0800 | [diff] [blame] | 510 | if (provider == null) { |
samuel | e1fa732 | 2015-07-14 16:35:16 +0800 | [diff] [blame] | 511 | log.warn("Provider for {} was not found. Cannot apply role {}", deviceId, newRole); |
Yuta HIGUCHI | 63323fd | 2014-11-11 12:16:58 -0800 | [diff] [blame] | 512 | return false; |
| 513 | } |
| 514 | provider.roleChanged(deviceId, newRole); |
| 515 | |
| 516 | if (newRole.equals(MastershipRole.MASTER)) { |
| 517 | // only trigger event when request was sent to provider |
Ayaka Koshibe | 78bcbc1 | 2014-11-19 14:28:58 -0800 | [diff] [blame] | 518 | provider.triggerProbe(deviceId); |
Yuta HIGUCHI | 63323fd | 2014-11-11 12:16:58 -0800 | [diff] [blame] | 519 | } |
| 520 | return true; |
| 521 | } |
| 522 | |
| 523 | /** |
| 524 | * Reaasert role for specified device connected to this node. |
| 525 | * |
Thomas Vachuska | 42e8cce | 2015-07-29 19:25:18 -0700 | [diff] [blame] | 526 | * @param did device identifier |
| 527 | * @param nextRole role to apply. If NONE is specified, |
| 528 | * it will ask mastership service for a role and apply it. |
Yuta HIGUCHI | 63323fd | 2014-11-11 12:16:58 -0800 | [diff] [blame] | 529 | */ |
samuel | e1fa732 | 2015-07-14 16:35:16 +0800 | [diff] [blame] | 530 | private void reassertRole(final DeviceId did, |
| 531 | final MastershipRole nextRole) { |
Yuta HIGUCHI | 63323fd | 2014-11-11 12:16:58 -0800 | [diff] [blame] | 532 | |
Yuta HIGUCHI | 63323fd | 2014-11-11 12:16:58 -0800 | [diff] [blame] | 533 | MastershipRole myNextRole = nextRole; |
| 534 | if (myNextRole == NONE) { |
| 535 | mastershipService.requestRoleFor(did); |
| 536 | MastershipTerm term = termService.getMastershipTerm(did); |
Madan Jampani | de003d9 | 2015-05-11 17:14:20 -0700 | [diff] [blame] | 537 | if (term != null && localNodeId.equals(term.master())) { |
Yuta HIGUCHI | 63323fd | 2014-11-11 12:16:58 -0800 | [diff] [blame] | 538 | myNextRole = MASTER; |
| 539 | } else { |
| 540 | myNextRole = STANDBY; |
| 541 | } |
| 542 | } |
| 543 | |
| 544 | switch (myNextRole) { |
Thomas Vachuska | 42e8cce | 2015-07-29 19:25:18 -0700 | [diff] [blame] | 545 | case MASTER: |
| 546 | final Device device = getDevice(did); |
| 547 | if ((device != null) && !isAvailable(did)) { |
| 548 | //flag the device as online. Is there a better way to do this? |
| 549 | DefaultDeviceDescription deviceDescription |
| 550 | = new DefaultDeviceDescription(did.uri(), |
| 551 | device.type(), |
| 552 | device.manufacturer(), |
| 553 | device.hwVersion(), |
| 554 | device.swVersion(), |
| 555 | device.serialNumber(), |
| 556 | device.chassisId()); |
| 557 | DeviceEvent devEvent = |
| 558 | store.createOrUpdateDevice(device.providerId(), did, |
| 559 | deviceDescription); |
| 560 | post(devEvent); |
| 561 | } |
| 562 | // TODO: should apply role only if there is mismatch |
| 563 | log.debug("Applying role {} to {}", myNextRole, did); |
| 564 | if (!applyRoleAndProbe(did, MASTER)) { |
| 565 | log.warn("Unsuccessful applying role {} to {}", myNextRole, did); |
| 566 | // immediately failed to apply role |
| 567 | mastershipService.relinquishMastership(did); |
| 568 | // FIXME disconnect? |
| 569 | } |
| 570 | break; |
| 571 | case STANDBY: |
| 572 | log.debug("Applying role {} to {}", myNextRole, did); |
| 573 | if (!applyRoleAndProbe(did, STANDBY)) { |
| 574 | log.warn("Unsuccessful applying role {} to {}", myNextRole, did); |
| 575 | // immediately failed to apply role |
| 576 | mastershipService.relinquishMastership(did); |
| 577 | // FIXME disconnect? |
| 578 | } |
| 579 | break; |
| 580 | case NONE: |
| 581 | default: |
| 582 | // should never reach here |
| 583 | log.error("You didn't see anything. I did not exist."); |
| 584 | break; |
Yuta HIGUCHI | 63323fd | 2014-11-11 12:16:58 -0800 | [diff] [blame] | 585 | } |
| 586 | } |
| 587 | |
Madan Jampani | 328371d | 2015-05-29 14:06:27 -0700 | [diff] [blame] | 588 | private void handleMastershipEvent(MastershipEvent event) { |
| 589 | if (event.type() != MastershipEvent.Type.MASTER_CHANGED) { |
| 590 | // Don't care if backup list changed. |
| 591 | return; |
| 592 | } |
| 593 | |
| 594 | final DeviceId did = event.subject(); |
| 595 | |
| 596 | // myRole suggested by MastershipService |
| 597 | MastershipRole myNextRole; |
| 598 | if (localNodeId.equals(event.roleInfo().master())) { |
| 599 | // confirm latest info |
| 600 | MastershipTerm term = termService.getMastershipTerm(did); |
samuel | e1fa732 | 2015-07-14 16:35:16 +0800 | [diff] [blame] | 601 | final boolean iHaveControl = term != null && localNodeId.equals(term.master()); |
Madan Jampani | 328371d | 2015-05-29 14:06:27 -0700 | [diff] [blame] | 602 | if (iHaveControl) { |
Madan Jampani | 328371d | 2015-05-29 14:06:27 -0700 | [diff] [blame] | 603 | myNextRole = MASTER; |
| 604 | } else { |
| 605 | myNextRole = STANDBY; |
| 606 | } |
| 607 | } else if (event.roleInfo().backups().contains(localNodeId)) { |
| 608 | myNextRole = STANDBY; |
| 609 | } else { |
| 610 | myNextRole = NONE; |
| 611 | } |
| 612 | |
samuel | e1fa732 | 2015-07-14 16:35:16 +0800 | [diff] [blame] | 613 | |
Madan Jampani | 328371d | 2015-05-29 14:06:27 -0700 | [diff] [blame] | 614 | final boolean isReachable = isReachable(did); |
| 615 | if (!isReachable) { |
| 616 | // device is not connected to this node |
| 617 | if (myNextRole != NONE) { |
| 618 | log.warn("Node was instructed to be {} role for {}, " |
Thomas Vachuska | 42e8cce | 2015-07-29 19:25:18 -0700 | [diff] [blame] | 619 | + "but this node cannot reach the device. " |
| 620 | + "Relinquishing role. ", |
samuel | e1fa732 | 2015-07-14 16:35:16 +0800 | [diff] [blame] | 621 | myNextRole, did); |
Madan Jampani | 328371d | 2015-05-29 14:06:27 -0700 | [diff] [blame] | 622 | mastershipService.relinquishMastership(did); |
| 623 | } |
| 624 | return; |
| 625 | } |
| 626 | |
| 627 | // device is connected to this node: |
| 628 | if (store.getDevice(did) != null) { |
| 629 | reassertRole(did, myNextRole); |
| 630 | } else { |
| 631 | log.debug("Device is not yet/no longer in the store: {}", did); |
| 632 | } |
| 633 | } |
| 634 | |
Yuta HIGUCHI | 63323fd | 2014-11-11 12:16:58 -0800 | [diff] [blame] | 635 | // Intercepts mastership events |
| 636 | private class InternalMastershipListener implements MastershipListener { |
| 637 | |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 638 | @Override |
| 639 | public void event(MastershipEvent event) { |
Madan Jampani | 328371d | 2015-05-29 14:06:27 -0700 | [diff] [blame] | 640 | backgroundService.submit(() -> { |
| 641 | try { |
| 642 | handleMastershipEvent(event); |
| 643 | } catch (Exception e) { |
| 644 | log.warn("Failed to handle {}", event, e); |
Yuta HIGUCHI | d26354d | 2014-10-31 14:14:38 -0700 | [diff] [blame] | 645 | } |
Madan Jampani | 328371d | 2015-05-29 14:06:27 -0700 | [diff] [blame] | 646 | }); |
Ayaka Koshibe | 317245a | 2014-10-29 00:34:43 -0700 | [diff] [blame] | 647 | } |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 648 | } |
tom | f80c972 | 2014-09-24 14:49:18 -0700 | [diff] [blame] | 649 | |
| 650 | // Store delegate to re-post events emitted from the store. |
Thomas Vachuska | b17c41f | 2015-05-19 11:16:05 -0700 | [diff] [blame] | 651 | private class InternalStoreDelegate implements DeviceStoreDelegate { |
tom | f80c972 | 2014-09-24 14:49:18 -0700 | [diff] [blame] | 652 | @Override |
| 653 | public void notify(DeviceEvent event) { |
| 654 | post(event); |
| 655 | } |
| 656 | } |
samuel | 738dfaf | 2015-07-11 11:08:57 +0800 | [diff] [blame] | 657 | |
| 658 | @Override |
| 659 | public Iterable<Device> getDevices(Type type) { |
| 660 | checkPermission(Permission.DEVICE_READ); |
| 661 | Set<Device> results = new HashSet<>(); |
| 662 | Iterable<Device> devices = store.getDevices(); |
| 663 | if (devices != null) { |
| 664 | devices.forEach(d -> { |
| 665 | if (type.equals(d.type())) { |
| 666 | results.add(d); |
| 667 | } |
| 668 | }); |
| 669 | } |
| 670 | return results; |
| 671 | } |
| 672 | |
| 673 | @Override |
| 674 | public Iterable<Device> getAvailableDevices(Type type) { |
| 675 | checkPermission(Permission.DEVICE_READ); |
| 676 | Set<Device> results = new HashSet<>(); |
| 677 | Iterable<Device> availableDevices = store.getAvailableDevices(); |
| 678 | if (availableDevices != null) { |
| 679 | availableDevices.forEach(d -> { |
| 680 | if (type.equals(d.type())) { |
| 681 | results.add(d); |
| 682 | } |
| 683 | }); |
| 684 | } |
| 685 | return results; |
| 686 | } |
Sahil Lele | 3a0cdd5 | 2015-07-21 14:16:31 -0700 | [diff] [blame] | 687 | |
| 688 | private class InternalNetworkConfigListener implements NetworkConfigListener { |
| 689 | @Override |
Thomas Vachuska | 42e8cce | 2015-07-29 19:25:18 -0700 | [diff] [blame] | 690 | public boolean isRelevant(NetworkConfigEvent event) { |
| 691 | return (event.type() == NetworkConfigEvent.Type.CONFIG_ADDED || |
| 692 | event.type() == NetworkConfigEvent.Type.CONFIG_UPDATED) |
| 693 | && event.configClass().equals(BasicDeviceConfig.class); |
| 694 | } |
| 695 | |
| 696 | @Override |
Sahil Lele | 3a0cdd5 | 2015-07-21 14:16:31 -0700 | [diff] [blame] | 697 | public void event(NetworkConfigEvent event) { |
Thomas Vachuska | 42e8cce | 2015-07-29 19:25:18 -0700 | [diff] [blame] | 698 | log.info("Detected Device network config event {}", event.type()); |
| 699 | kickOutBadDevice(((DeviceId) event.subject())); |
Sahil Lele | 3a0cdd5 | 2015-07-21 14:16:31 -0700 | [diff] [blame] | 700 | } |
| 701 | } |
| 702 | |
| 703 | // checks if the specified device is allowed by the BasicDeviceConfig |
| 704 | // and if not, removes it |
| 705 | private void kickOutBadDevice(DeviceId deviceId) { |
| 706 | BasicDeviceConfig cfg = networkConfigService.getConfig(deviceId, BasicDeviceConfig.class); |
| 707 | if (!cfg.isAllowed()) { |
| 708 | Device badDevice = getDevice(deviceId); |
| 709 | if (badDevice != null) { |
| 710 | removeDevice(deviceId); |
Sahil Lele | 3a0cdd5 | 2015-07-21 14:16:31 -0700 | [diff] [blame] | 711 | } |
| 712 | } |
| 713 | } |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 714 | } |