Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2014-present Open Networking Foundation |
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 | |
Simon Hunt | ffbad3b | 2017-05-16 15:37:51 -0700 | [diff] [blame] | 18 | import com.google.common.collect.ImmutableList; |
Carmelo Cascone | 1da7a4d | 2018-06-27 18:03:11 +0200 | [diff] [blame] | 19 | import com.google.common.collect.Lists; |
Simon Hunt | ffbad3b | 2017-05-16 15:37:51 -0700 | [diff] [blame] | 20 | import com.google.common.collect.Maps; |
| 21 | import com.google.common.collect.Multimap; |
pier | 388ec25 | 2020-04-15 20:53:14 +0200 | [diff] [blame] | 22 | import com.google.common.util.concurrent.Futures; |
Jonghwan Hyun | 6ecf56d | 2017-08-01 16:07:44 -0700 | [diff] [blame] | 23 | import org.onlab.util.KryoNamespace; |
Yuta HIGUCHI | b9af6b7 | 2016-06-10 10:52:58 -0700 | [diff] [blame] | 24 | import org.onlab.util.Tools; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 25 | import org.onosproject.cluster.ClusterService; |
| 26 | import org.onosproject.cluster.NodeId; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 27 | import org.onosproject.mastership.MastershipEvent; |
| 28 | import org.onosproject.mastership.MastershipListener; |
| 29 | import org.onosproject.mastership.MastershipService; |
| 30 | import org.onosproject.mastership.MastershipTerm; |
| 31 | import org.onosproject.mastership.MastershipTermService; |
Ayaka Koshibe | d0ab3c0 | 2015-09-04 15:43:46 -0700 | [diff] [blame] | 32 | import org.onosproject.net.ConnectPoint; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 33 | import org.onosproject.net.Device; |
samuel | 738dfaf | 2015-07-11 11:08:57 +0800 | [diff] [blame] | 34 | import org.onosproject.net.Device.Type; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 35 | import org.onosproject.net.DeviceId; |
| 36 | import org.onosproject.net.MastershipRole; |
| 37 | import org.onosproject.net.Port; |
| 38 | import org.onosproject.net.PortNumber; |
Yuta HIGUCHI | b9af6b7 | 2016-06-10 10:52:58 -0700 | [diff] [blame] | 39 | import org.onosproject.net.config.Config; |
Yafit Hadar | a9a73de | 2015-09-06 13:52:52 +0300 | [diff] [blame] | 40 | import org.onosproject.net.config.NetworkConfigEvent; |
| 41 | import org.onosproject.net.config.NetworkConfigListener; |
| 42 | import org.onosproject.net.config.NetworkConfigService; |
Yuta HIGUCHI | b9af6b7 | 2016-06-10 10:52:58 -0700 | [diff] [blame] | 43 | import org.onosproject.net.config.PortConfigOperator; |
| 44 | import org.onosproject.net.config.PortConfigOperatorRegistry; |
Yafit Hadar | a9a73de | 2015-09-06 13:52:52 +0300 | [diff] [blame] | 45 | import org.onosproject.net.config.basics.BasicDeviceConfig; |
Palash Kala | a06a616 | 2017-11-15 20:42:40 +0900 | [diff] [blame] | 46 | import org.onosproject.net.config.basics.DeviceAnnotationConfig; |
Yuta HIGUCHI | 7438f5a | 2017-02-15 22:09:46 -0800 | [diff] [blame] | 47 | import org.onosproject.net.config.basics.PortAnnotationConfig; |
Carmelo Cascone | 3977ea4 | 2019-02-28 13:43:42 -0800 | [diff] [blame] | 48 | import org.onosproject.net.config.basics.PortDescriptionsConfig; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 49 | import org.onosproject.net.device.DefaultPortDescription; |
| 50 | import org.onosproject.net.device.DeviceAdminService; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 51 | import org.onosproject.net.device.DeviceDescription; |
| 52 | import org.onosproject.net.device.DeviceEvent; |
| 53 | import org.onosproject.net.device.DeviceListener; |
| 54 | import org.onosproject.net.device.DeviceProvider; |
| 55 | import org.onosproject.net.device.DeviceProviderRegistry; |
| 56 | import org.onosproject.net.device.DeviceProviderService; |
| 57 | import org.onosproject.net.device.DeviceService; |
| 58 | import org.onosproject.net.device.DeviceStore; |
| 59 | import org.onosproject.net.device.DeviceStoreDelegate; |
| 60 | import org.onosproject.net.device.PortDescription; |
sangho | 538108b | 2015-04-08 14:29:20 -0700 | [diff] [blame] | 61 | import org.onosproject.net.device.PortStatistics; |
Yafit Hadar | a9a73de | 2015-09-06 13:52:52 +0300 | [diff] [blame] | 62 | import org.onosproject.net.provider.AbstractListenerProviderRegistry; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 63 | import org.onosproject.net.provider.AbstractProviderService; |
Yuta HIGUCHI | 3a2a987 | 2016-11-29 20:24:23 -0800 | [diff] [blame] | 64 | import org.onosproject.net.provider.Provider; |
| 65 | import org.onosproject.net.provider.ProviderId; |
Jonghwan Hyun | 6ecf56d | 2017-08-01 16:07:44 -0700 | [diff] [blame] | 66 | import org.onosproject.store.cluster.messaging.ClusterCommunicationService; |
| 67 | import org.onosproject.store.cluster.messaging.MessageSubject; |
| 68 | import org.onosproject.store.serializers.KryoNamespaces; |
| 69 | import org.onosproject.store.service.Serializer; |
Jordan Halterman | 9416aea | 2017-11-17 12:40:21 -0800 | [diff] [blame] | 70 | import org.onosproject.upgrade.UpgradeService; |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 71 | import org.osgi.service.component.annotations.Activate; |
| 72 | import org.osgi.service.component.annotations.Component; |
| 73 | import org.osgi.service.component.annotations.Deactivate; |
| 74 | import org.osgi.service.component.annotations.Reference; |
| 75 | import org.osgi.service.component.annotations.ReferenceCardinality; |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 76 | import org.slf4j.Logger; |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 77 | |
Yuta HIGUCHI | 0c47d53 | 2017-08-18 23:16:35 -0700 | [diff] [blame] | 78 | import java.time.Instant; |
Simon Hunt | ffbad3b | 2017-05-16 15:37:51 -0700 | [diff] [blame] | 79 | import java.util.Collection; |
| 80 | import java.util.HashSet; |
| 81 | import java.util.List; |
| 82 | import java.util.Map; |
| 83 | import java.util.Objects; |
| 84 | import java.util.Optional; |
| 85 | import java.util.Set; |
| 86 | import java.util.concurrent.CompletableFuture; |
| 87 | import java.util.concurrent.ConcurrentHashMap; |
| 88 | import java.util.concurrent.CopyOnWriteArrayList; |
| 89 | import java.util.concurrent.ExecutionException; |
Jonghwan Hyun | 6ecf56d | 2017-08-01 16:07:44 -0700 | [diff] [blame] | 90 | import java.util.concurrent.ExecutorService; |
Simon Hunt | ffbad3b | 2017-05-16 15:37:51 -0700 | [diff] [blame] | 91 | import java.util.concurrent.ScheduledExecutorService; |
| 92 | import java.util.concurrent.TimeUnit; |
| 93 | import java.util.stream.Collectors; |
Jonathan Hart | 2f66936 | 2015-02-11 16:19:20 -0800 | [diff] [blame] | 94 | |
Ray Milkey | 9ef2223 | 2016-07-14 12:42:37 -0700 | [diff] [blame] | 95 | import static com.google.common.base.Preconditions.checkNotNull; |
Jonghwan Hyun | 6ecf56d | 2017-08-01 16:07:44 -0700 | [diff] [blame] | 96 | import static com.google.common.base.Preconditions.checkState; |
Yuta HIGUCHI | b9af6b7 | 2016-06-10 10:52:58 -0700 | [diff] [blame] | 97 | import static com.google.common.collect.Multimaps.newListMultimap; |
| 98 | import static com.google.common.collect.Multimaps.synchronizedListMultimap; |
Jonghwan Hyun | 6ecf56d | 2017-08-01 16:07:44 -0700 | [diff] [blame] | 99 | import static java.util.concurrent.Executors.newSingleThreadExecutor; |
Ray Milkey | 9ef2223 | 2016-07-14 12:42:37 -0700 | [diff] [blame] | 100 | import static java.util.concurrent.Executors.newSingleThreadScheduledExecutor; |
| 101 | import static org.onlab.util.Tools.groupedThreads; |
| 102 | import static org.onosproject.net.MastershipRole.MASTER; |
| 103 | import static org.onosproject.net.MastershipRole.NONE; |
| 104 | import static org.onosproject.net.MastershipRole.STANDBY; |
Ray Milkey | 9ef2223 | 2016-07-14 12:42:37 -0700 | [diff] [blame] | 105 | import static org.onosproject.security.AppGuard.checkPermission; |
| 106 | import static org.onosproject.security.AppPermission.Type.DEVICE_READ; |
| 107 | import static org.slf4j.LoggerFactory.getLogger; |
| 108 | |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 109 | /** |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 110 | * Provides implementation of the device SB & NB APIs. |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 111 | */ |
Ray Milkey | 86ad7bb | 2018-09-27 12:32:28 -0700 | [diff] [blame] | 112 | @Component(immediate = true, |
| 113 | service = {DeviceService.class, DeviceAdminService.class, |
| 114 | DeviceProviderRegistry.class, PortConfigOperatorRegistry.class }) |
tom | 41a2c5f | 2014-09-19 09:20:35 -0700 | [diff] [blame] | 115 | public class DeviceManager |
Thomas Vachuska | 42e8cce | 2015-07-29 19:25:18 -0700 | [diff] [blame] | 116 | extends AbstractListenerProviderRegistry<DeviceEvent, DeviceListener, DeviceProvider, DeviceProviderService> |
Yuta HIGUCHI | b9af6b7 | 2016-06-10 10:52:58 -0700 | [diff] [blame] | 117 | implements DeviceService, DeviceAdminService, DeviceProviderRegistry, PortConfigOperatorRegistry { |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 118 | |
tom | e5ec3fd | 2014-09-04 15:18:06 -0700 | [diff] [blame] | 119 | private static final String DEVICE_ID_NULL = "Device ID cannot be null"; |
| 120 | private static final String PORT_NUMBER_NULL = "Port number cannot be null"; |
| 121 | private static final String DEVICE_DESCRIPTION_NULL = "Device description cannot be null"; |
| 122 | private static final String PORT_DESCRIPTION_NULL = "Port description cannot be null"; |
Ayaka Koshibe | d0ab3c0 | 2015-09-04 15:43:46 -0700 | [diff] [blame] | 123 | private static final String PORT_DESC_LIST_NULL = "Port description list cannot be null"; |
Jonghwan Hyun | 6ecf56d | 2017-08-01 16:07:44 -0700 | [diff] [blame] | 124 | private static final String EVENT_NON_MASTER = "Non-master node cannot handle this event"; |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 125 | |
tom | 5f38b3a | 2014-08-27 23:50:54 -0700 | [diff] [blame] | 126 | private final Logger log = getLogger(getClass()); |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 127 | |
alshabib | 339a3d9 | 2014-09-26 17:54:32 -0700 | [diff] [blame] | 128 | private final DeviceStoreDelegate delegate = new InternalStoreDelegate(); |
tom | f80c972 | 2014-09-24 14:49:18 -0700 | [diff] [blame] | 129 | |
tom | c78acee | 2014-09-24 15:16:55 -0700 | [diff] [blame] | 130 | private final MastershipListener mastershipListener = new InternalMastershipListener(); |
Madan Jampani | de003d9 | 2015-05-11 17:14:20 -0700 | [diff] [blame] | 131 | private NodeId localNodeId; |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 132 | |
Yuta HIGUCHI | 63323fd | 2014-11-11 12:16:58 -0800 | [diff] [blame] | 133 | private ScheduledExecutorService backgroundService; |
| 134 | |
Sahil Lele | 3a0cdd5 | 2015-07-21 14:16:31 -0700 | [diff] [blame] | 135 | private final NetworkConfigListener networkConfigListener = new InternalNetworkConfigListener(); |
| 136 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 137 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
tom | 41a2c5f | 2014-09-19 09:20:35 -0700 | [diff] [blame] | 138 | protected DeviceStore store; |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 139 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 140 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 141 | protected ClusterService clusterService; |
| 142 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 143 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
Ayaka Koshibe | a7f044e | 2014-09-23 16:56:20 -0700 | [diff] [blame] | 144 | protected MastershipService mastershipService; |
| 145 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 146 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
Ayaka Koshibe | 3de43ca | 2014-09-26 16:40:23 -0700 | [diff] [blame] | 147 | protected MastershipTermService termService; |
| 148 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 149 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
Jordan Halterman | 9416aea | 2017-11-17 12:40:21 -0800 | [diff] [blame] | 150 | protected UpgradeService upgradeService; |
| 151 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 152 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
Sahil Lele | 3a0cdd5 | 2015-07-21 14:16:31 -0700 | [diff] [blame] | 153 | protected NetworkConfigService networkConfigService; |
| 154 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 155 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
Jonghwan Hyun | 6ecf56d | 2017-08-01 16:07:44 -0700 | [diff] [blame] | 156 | protected ClusterCommunicationService communicationService; |
Yuta HIGUCHI | b9af6b7 | 2016-06-10 10:52:58 -0700 | [diff] [blame] | 157 | |
Jonghwan Hyun | 6ecf56d | 2017-08-01 16:07:44 -0700 | [diff] [blame] | 158 | private ExecutorService portReqeustExecutor; |
Yuta HIGUCHI | b9af6b7 | 2016-06-10 10:52:58 -0700 | [diff] [blame] | 159 | /** |
| 160 | * List of all registered PortConfigOperator. |
| 161 | */ |
| 162 | private final List<PortConfigOperator> portOps = new CopyOnWriteArrayList<>(); |
| 163 | |
| 164 | /** |
| 165 | * Index to look up PortConfigOperator from Config each PortConfigOperator uses. |
| 166 | */ |
| 167 | private final Multimap<Class<? extends Config<ConnectPoint>>, PortConfigOperator> portOpsIndex |
Simon Hunt | ffbad3b | 2017-05-16 15:37:51 -0700 | [diff] [blame] | 168 | = synchronizedListMultimap( |
| 169 | newListMultimap(new ConcurrentHashMap<>(), CopyOnWriteArrayList::new)); |
Yuta HIGUCHI | b9af6b7 | 2016-06-10 10:52:58 -0700 | [diff] [blame] | 170 | |
Yuta HIGUCHI | 7438f5a | 2017-02-15 22:09:46 -0800 | [diff] [blame] | 171 | // not part of portOps. must be executed at the end |
| 172 | private PortAnnotationOperator portAnnotationOp; |
Palash Kala | a06a616 | 2017-11-15 20:42:40 +0900 | [diff] [blame] | 173 | private DeviceAnnotationOperator deviceAnnotationOp; |
Yuta HIGUCHI | 7438f5a | 2017-02-15 22:09:46 -0800 | [diff] [blame] | 174 | |
Jonghwan Hyun | 6ecf56d | 2017-08-01 16:07:44 -0700 | [diff] [blame] | 175 | private static final MessageSubject PORT_UPDOWN_SUBJECT = |
| 176 | new MessageSubject("port-updown-req"); |
| 177 | |
| 178 | private static final Serializer SERIALIZER = Serializer.using( |
| 179 | KryoNamespace.newBuilder() |
| 180 | .register(KryoNamespaces.API) |
| 181 | .register(InternalPortUpDownEvent.class) |
| 182 | .nextId(KryoNamespaces.BEGIN_USER_CUSTOM_ID) |
| 183 | .build("DeviceManager")); |
| 184 | |
Saurav Das | d5ec9e9 | 2017-01-17 10:40:18 -0800 | [diff] [blame] | 185 | /** |
| 186 | * Local storage for connectivity status of devices. |
| 187 | */ |
| 188 | private class LocalStatus { |
| 189 | boolean connected; |
Yuta HIGUCHI | 0c47d53 | 2017-08-18 23:16:35 -0700 | [diff] [blame] | 190 | Instant dateTime; |
Saurav Das | d5ec9e9 | 2017-01-17 10:40:18 -0800 | [diff] [blame] | 191 | |
Yuta HIGUCHI | 0c47d53 | 2017-08-18 23:16:35 -0700 | [diff] [blame] | 192 | public LocalStatus(boolean b, Instant now) { |
Saurav Das | d5ec9e9 | 2017-01-17 10:40:18 -0800 | [diff] [blame] | 193 | connected = b; |
| 194 | dateTime = now; |
| 195 | } |
| 196 | } |
Simon Hunt | ffbad3b | 2017-05-16 15:37:51 -0700 | [diff] [blame] | 197 | |
Saurav Das | d5ec9e9 | 2017-01-17 10:40:18 -0800 | [diff] [blame] | 198 | private final Map<DeviceId, LocalStatus> deviceLocalStatus = |
| 199 | Maps.newConcurrentMap(); |
Yuta HIGUCHI | b9af6b7 | 2016-06-10 10:52:58 -0700 | [diff] [blame] | 200 | |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 201 | @Activate |
| 202 | public void activate() { |
Yuta HIGUCHI | 7438f5a | 2017-02-15 22:09:46 -0800 | [diff] [blame] | 203 | portAnnotationOp = new PortAnnotationOperator(networkConfigService); |
Palash Kala | a06a616 | 2017-11-15 20:42:40 +0900 | [diff] [blame] | 204 | deviceAnnotationOp = new DeviceAnnotationOperator(networkConfigService); |
Yuta HIGUCHI | 7438f5a | 2017-02-15 22:09:46 -0800 | [diff] [blame] | 205 | portOpsIndex.put(PortAnnotationConfig.class, portAnnotationOp); |
| 206 | |
HIGUCHI Yuta | 060da9a | 2016-03-11 19:16:35 -0800 | [diff] [blame] | 207 | backgroundService = newSingleThreadScheduledExecutor( |
Simon Hunt | ffbad3b | 2017-05-16 15:37:51 -0700 | [diff] [blame] | 208 | groupedThreads("onos/device", "manager-background", log)); |
Madan Jampani | de003d9 | 2015-05-11 17:14:20 -0700 | [diff] [blame] | 209 | localNodeId = clusterService.getLocalNode().id(); |
Yuta HIGUCHI | 63323fd | 2014-11-11 12:16:58 -0800 | [diff] [blame] | 210 | |
tom | f80c972 | 2014-09-24 14:49:18 -0700 | [diff] [blame] | 211 | store.setDelegate(delegate); |
tom | 96dfcab | 2014-08-28 09:26:03 -0700 | [diff] [blame] | 212 | eventDispatcher.addSink(DeviceEvent.class, listenerRegistry); |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 213 | mastershipService.addListener(mastershipListener); |
Sahil Lele | 3a0cdd5 | 2015-07-21 14:16:31 -0700 | [diff] [blame] | 214 | networkConfigService.addListener(networkConfigListener); |
Yuta HIGUCHI | 63323fd | 2014-11-11 12:16:58 -0800 | [diff] [blame] | 215 | |
Thomas Vachuska | 42e8cce | 2015-07-29 19:25:18 -0700 | [diff] [blame] | 216 | backgroundService.scheduleWithFixedDelay(() -> { |
| 217 | try { |
| 218 | mastershipCheck(); |
| 219 | } catch (Exception e) { |
| 220 | log.error("Exception thrown during integrity check", e); |
Yuta HIGUCHI | 63323fd | 2014-11-11 12:16:58 -0800 | [diff] [blame] | 221 | } |
| 222 | }, 1, 1, TimeUnit.MINUTES); |
Jonghwan Hyun | 6ecf56d | 2017-08-01 16:07:44 -0700 | [diff] [blame] | 223 | |
| 224 | portReqeustExecutor = newSingleThreadExecutor(); |
| 225 | |
| 226 | communicationService.<InternalPortUpDownEvent>addSubscriber( |
| 227 | PORT_UPDOWN_SUBJECT, |
| 228 | SERIALIZER::decode, |
| 229 | this::handlePortRequest, |
| 230 | portReqeustExecutor); |
| 231 | |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 232 | log.info("Started"); |
| 233 | } |
| 234 | |
| 235 | @Deactivate |
| 236 | public void deactivate() { |
Yuta HIGUCHI | 63323fd | 2014-11-11 12:16:58 -0800 | [diff] [blame] | 237 | backgroundService.shutdown(); |
Sahil Lele | 3a0cdd5 | 2015-07-21 14:16:31 -0700 | [diff] [blame] | 238 | networkConfigService.removeListener(networkConfigListener); |
tom | f80c972 | 2014-09-24 14:49:18 -0700 | [diff] [blame] | 239 | store.unsetDelegate(delegate); |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 240 | mastershipService.removeListener(mastershipListener); |
tom | 5f38b3a | 2014-08-27 23:50:54 -0700 | [diff] [blame] | 241 | eventDispatcher.removeSink(DeviceEvent.class); |
Jonghwan Hyun | 6ecf56d | 2017-08-01 16:07:44 -0700 | [diff] [blame] | 242 | communicationService.removeSubscriber(PORT_UPDOWN_SUBJECT); |
| 243 | portReqeustExecutor.shutdown(); |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 244 | log.info("Stopped"); |
| 245 | } |
| 246 | |
| 247 | @Override |
tom | ad2d209 | 2014-09-06 23:24:20 -0700 | [diff] [blame] | 248 | public int getDeviceCount() { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 249 | checkPermission(DEVICE_READ); |
tom | ad2d209 | 2014-09-06 23:24:20 -0700 | [diff] [blame] | 250 | return store.getDeviceCount(); |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 251 | } |
| 252 | |
| 253 | @Override |
mskala | 32000d3 | 2017-07-14 16:27:06 +0200 | [diff] [blame] | 254 | public int getAvailableDeviceCount() { |
| 255 | checkPermission(DEVICE_READ); |
| 256 | return store.getAvailableDeviceCount(); |
| 257 | } |
| 258 | |
| 259 | @Override |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 260 | public Iterable<Device> getDevices() { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 261 | checkPermission(DEVICE_READ); |
tom | e5ec3fd | 2014-09-04 15:18:06 -0700 | [diff] [blame] | 262 | return store.getDevices(); |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 263 | } |
| 264 | |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 265 | @Override |
Yuta HIGUCHI | f1f2ac0 | 2014-11-26 14:02:22 -0800 | [diff] [blame] | 266 | public Iterable<Device> getAvailableDevices() { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 267 | checkPermission(DEVICE_READ); |
Yuta HIGUCHI | f1f2ac0 | 2014-11-26 14:02:22 -0800 | [diff] [blame] | 268 | return store.getAvailableDevices(); |
| 269 | } |
| 270 | |
| 271 | @Override |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 272 | public Device getDevice(DeviceId deviceId) { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 273 | checkPermission(DEVICE_READ); |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 274 | checkNotNull(deviceId, DEVICE_ID_NULL); |
tom | 132b58a | 2014-08-28 16:11:28 -0700 | [diff] [blame] | 275 | return store.getDevice(deviceId); |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 276 | } |
| 277 | |
| 278 | @Override |
tom | ad2d209 | 2014-09-06 23:24:20 -0700 | [diff] [blame] | 279 | public MastershipRole getRole(DeviceId deviceId) { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 280 | checkPermission(DEVICE_READ); |
tom | ad2d209 | 2014-09-06 23:24:20 -0700 | [diff] [blame] | 281 | checkNotNull(deviceId, DEVICE_ID_NULL); |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 282 | return mastershipService.getLocalRole(deviceId); |
tom | ad2d209 | 2014-09-06 23:24:20 -0700 | [diff] [blame] | 283 | } |
| 284 | |
| 285 | @Override |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 286 | public List<Port> getPorts(DeviceId deviceId) { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 287 | checkPermission(DEVICE_READ); |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 288 | checkNotNull(deviceId, DEVICE_ID_NULL); |
tom | 132b58a | 2014-08-28 16:11:28 -0700 | [diff] [blame] | 289 | return store.getPorts(deviceId); |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 290 | } |
| 291 | |
| 292 | @Override |
sangho | 538108b | 2015-04-08 14:29:20 -0700 | [diff] [blame] | 293 | public List<PortStatistics> getPortStatistics(DeviceId deviceId) { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 294 | checkPermission(DEVICE_READ); |
sangho | 538108b | 2015-04-08 14:29:20 -0700 | [diff] [blame] | 295 | checkNotNull(deviceId, DEVICE_ID_NULL); |
| 296 | return store.getPortStatistics(deviceId); |
| 297 | } |
| 298 | |
| 299 | @Override |
Dusan Pajin | 11ff4a8 | 2015-08-20 18:03:05 +0200 | [diff] [blame] | 300 | public List<PortStatistics> getPortDeltaStatistics(DeviceId deviceId) { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 301 | checkPermission(DEVICE_READ); |
Dusan Pajin | 11ff4a8 | 2015-08-20 18:03:05 +0200 | [diff] [blame] | 302 | checkNotNull(deviceId, DEVICE_ID_NULL); |
| 303 | return store.getPortDeltaStatistics(deviceId); |
| 304 | } |
| 305 | |
| 306 | @Override |
Viswanath KSP | 22774cd | 2016-08-20 20:06:30 +0530 | [diff] [blame] | 307 | public PortStatistics getStatisticsForPort(DeviceId deviceId, PortNumber portNumber) { |
| 308 | checkPermission(DEVICE_READ); |
| 309 | checkNotNull(deviceId, DEVICE_ID_NULL); |
| 310 | checkNotNull(portNumber, PORT_NUMBER_NULL); |
| 311 | return store.getStatisticsForPort(deviceId, portNumber); |
| 312 | } |
| 313 | |
| 314 | @Override |
| 315 | public PortStatistics getDeltaStatisticsForPort(DeviceId deviceId, PortNumber portNumber) { |
| 316 | checkPermission(DEVICE_READ); |
| 317 | checkNotNull(deviceId, DEVICE_ID_NULL); |
| 318 | checkNotNull(portNumber, PORT_NUMBER_NULL); |
| 319 | return store.getDeltaStatisticsForPort(deviceId, portNumber); |
| 320 | } |
| 321 | |
| 322 | @Override |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 323 | public Port getPort(DeviceId deviceId, PortNumber portNumber) { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 324 | checkPermission(DEVICE_READ); |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 325 | checkNotNull(deviceId, DEVICE_ID_NULL); |
| 326 | checkNotNull(portNumber, PORT_NUMBER_NULL); |
tom | 132b58a | 2014-08-28 16:11:28 -0700 | [diff] [blame] | 327 | return store.getPort(deviceId, portNumber); |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 328 | } |
| 329 | |
| 330 | @Override |
tom | ff7eb7c | 2014-09-08 12:49:03 -0700 | [diff] [blame] | 331 | public boolean isAvailable(DeviceId deviceId) { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 332 | checkPermission(DEVICE_READ); |
Changhoon Yoon | 541ef71 | 2015-05-23 17:18:34 +0900 | [diff] [blame] | 333 | |
tom | ff7eb7c | 2014-09-08 12:49:03 -0700 | [diff] [blame] | 334 | checkNotNull(deviceId, DEVICE_ID_NULL); |
| 335 | return store.isAvailable(deviceId); |
| 336 | } |
| 337 | |
Saurav Das | d5ec9e9 | 2017-01-17 10:40:18 -0800 | [diff] [blame] | 338 | @Override |
| 339 | public String localStatus(DeviceId deviceId) { |
| 340 | LocalStatus ls = deviceLocalStatus.get(deviceId); |
| 341 | if (ls == null) { |
| 342 | return "No Record"; |
| 343 | } |
Yuta HIGUCHI | 0c47d53 | 2017-08-18 23:16:35 -0700 | [diff] [blame] | 344 | String timeAgo = Tools.timeAgo(ls.dateTime.toEpochMilli()); |
Saurav Das | d5ec9e9 | 2017-01-17 10:40:18 -0800 | [diff] [blame] | 345 | return (ls.connected) ? "connected " + timeAgo : "disconnected " + timeAgo; |
| 346 | } |
| 347 | |
Palash Kala | 0d817b0 | 2018-03-23 18:09:45 +0900 | [diff] [blame] | 348 | private boolean isLocallyConnected(DeviceId deviceId) { |
| 349 | LocalStatus ls = deviceLocalStatus.get(deviceId); |
| 350 | if (ls == null) { |
| 351 | return false; |
| 352 | } |
| 353 | return ls.connected; |
| 354 | } |
| 355 | |
Ray Milkey | 054e23d | 2018-03-22 13:37:11 -0700 | [diff] [blame] | 356 | @Override |
| 357 | public long getLastUpdatedInstant(DeviceId deviceId) { |
| 358 | LocalStatus ls = deviceLocalStatus.get(deviceId); |
| 359 | if (ls == null) { |
| 360 | return 0; |
| 361 | } |
| 362 | return ls.dateTime.toEpochMilli(); |
| 363 | } |
| 364 | |
Palash Kala | 0d817b0 | 2018-03-23 18:09:45 +0900 | [diff] [blame] | 365 | // Check a device for control channel connectivity |
| 366 | // and changes local-status appropriately. |
Yuta HIGUCHI | 5481532 | 2014-10-31 23:17:08 -0700 | [diff] [blame] | 367 | private boolean isReachable(DeviceId deviceId) { |
Ayaka Koshibe | 78bcbc1 | 2014-11-19 14:28:58 -0800 | [diff] [blame] | 368 | if (deviceId == null) { |
| 369 | return false; |
| 370 | } |
Yuta HIGUCHI | 5481532 | 2014-10-31 23:17:08 -0700 | [diff] [blame] | 371 | DeviceProvider provider = getProvider(deviceId); |
| 372 | if (provider != null) { |
Palash Kala | 0d817b0 | 2018-03-23 18:09:45 +0900 | [diff] [blame] | 373 | boolean reachable = provider.isReachable(deviceId); |
| 374 | if (reachable && !isLocallyConnected(deviceId)) { |
| 375 | deviceLocalStatus.put(deviceId, new LocalStatus(true, Instant.now())); |
| 376 | } else if (!reachable && isLocallyConnected(deviceId)) { |
| 377 | deviceLocalStatus.put(deviceId, new LocalStatus(false, Instant.now())); |
| 378 | } |
| 379 | return reachable; |
Yuta HIGUCHI | 5481532 | 2014-10-31 23:17:08 -0700 | [diff] [blame] | 380 | } else { |
Yuta HIGUCHI | 72669c4 | 2014-11-13 14:48:17 -0800 | [diff] [blame] | 381 | log.debug("Provider not found for {}", deviceId); |
Ayaka Koshibe | e60d452 | 2014-10-28 15:07:00 -0700 | [diff] [blame] | 382 | return false; |
| 383 | } |
Ayaka Koshibe | e8708e3 | 2014-10-22 13:40:18 -0700 | [diff] [blame] | 384 | } |
| 385 | |
tom | e5ec3fd | 2014-09-04 15:18:06 -0700 | [diff] [blame] | 386 | @Override |
| 387 | public void removeDevice(DeviceId deviceId) { |
| 388 | checkNotNull(deviceId, DEVICE_ID_NULL); |
| 389 | DeviceEvent event = store.removeDevice(deviceId); |
tom | 0efbb1d | 2014-09-09 11:54:28 -0700 | [diff] [blame] | 390 | if (event != null) { |
| 391 | log.info("Device {} administratively removed", deviceId); |
tom | 0efbb1d | 2014-09-09 11:54:28 -0700 | [diff] [blame] | 392 | } |
tom | e5ec3fd | 2014-09-04 15:18:06 -0700 | [diff] [blame] | 393 | } |
| 394 | |
Thomas Vachuska | 811ea2b | 2020-02-11 10:20:10 -0800 | [diff] [blame] | 395 | @Override |
| 396 | public void removeDevicePorts(DeviceId deviceId) { |
| 397 | checkNotNull(deviceId, DEVICE_ID_NULL); |
| 398 | if (isAvailable(deviceId)) { |
| 399 | log.debug("Cannot remove ports of device {} while it is available.", deviceId); |
| 400 | return; |
| 401 | } |
| 402 | |
| 403 | List<PortDescription> portDescriptions = ImmutableList.of(); |
| 404 | List<DeviceEvent> events = store.updatePorts(getProvider(deviceId).id(), |
| 405 | deviceId, portDescriptions); |
| 406 | if (events != null) { |
| 407 | for (DeviceEvent event : events) { |
| 408 | post(event); |
| 409 | } |
| 410 | } |
| 411 | } |
| 412 | |
Jonghwan Hyun | 6ecf56d | 2017-08-01 16:07:44 -0700 | [diff] [blame] | 413 | private void handlePortRequest(InternalPortUpDownEvent event) { |
| 414 | DeviceId deviceId = event.deviceId(); |
Saurav Das | a2d3750 | 2016-03-25 17:50:40 -0700 | [diff] [blame] | 415 | checkNotNull(deviceId, DEVICE_ID_NULL); |
Sean Condon | 0bd777c | 2021-01-01 14:23:29 +0000 | [diff] [blame] | 416 | checkNotNull(event.portNumber(), PORT_NUMBER_NULL); |
Jonghwan Hyun | 6ecf56d | 2017-08-01 16:07:44 -0700 | [diff] [blame] | 417 | checkState(mastershipService.isLocalMaster(deviceId), EVENT_NON_MASTER); |
| 418 | changePortStateAtMaster(event.deviceId(), event.portNumber(), event.isEnable()); |
| 419 | } |
| 420 | |
| 421 | private void changePortStateAtMaster(DeviceId deviceId, PortNumber portNumber, |
| 422 | boolean enable) { |
Saurav Das | a2d3750 | 2016-03-25 17:50:40 -0700 | [diff] [blame] | 423 | DeviceProvider provider = getProvider(deviceId); |
| 424 | if (provider != null) { |
Jonghwan Hyun | 6ecf56d | 2017-08-01 16:07:44 -0700 | [diff] [blame] | 425 | log.info("Port {} on device {} being administratively brought {}", |
Saurav Das | a2d3750 | 2016-03-25 17:50:40 -0700 | [diff] [blame] | 426 | portNumber, deviceId, |
| 427 | (enable) ? "UP" : "DOWN"); |
| 428 | provider.changePortState(deviceId, portNumber, enable); |
| 429 | } else { |
| 430 | log.warn("Provider not found for {}", deviceId); |
| 431 | } |
| 432 | } |
| 433 | |
| 434 | @Override |
Jonghwan Hyun | 6ecf56d | 2017-08-01 16:07:44 -0700 | [diff] [blame] | 435 | public void changePortState(DeviceId deviceId, PortNumber portNumber, |
| 436 | boolean enable) { |
| 437 | checkNotNull(deviceId, DEVICE_ID_NULL); |
Sean Condon | 0bd777c | 2021-01-01 14:23:29 +0000 | [diff] [blame] | 438 | checkNotNull(portNumber, PORT_NUMBER_NULL); |
Jonghwan Hyun | 6ecf56d | 2017-08-01 16:07:44 -0700 | [diff] [blame] | 439 | NodeId masterId = mastershipService.getMasterFor(deviceId); |
| 440 | |
Ray Milkey | 4ef245e | 2018-05-10 15:41:16 -0700 | [diff] [blame] | 441 | if (masterId == null) { |
| 442 | // No master found; device is offline |
| 443 | log.info("No master found for port state change for {}", deviceId); |
| 444 | return; |
| 445 | } |
| 446 | |
Jonghwan Hyun | 6ecf56d | 2017-08-01 16:07:44 -0700 | [diff] [blame] | 447 | if (!masterId.equals(localNodeId)) { |
| 448 | //Send the request to the master node for the device |
| 449 | log.info("Device {} is managed by {}, forwarding the request to the MASTER", |
| 450 | deviceId, masterId); |
| 451 | communicationService.unicast( |
| 452 | new InternalPortUpDownEvent(deviceId, portNumber, enable), |
| 453 | PORT_UPDOWN_SUBJECT, |
| 454 | SERIALIZER::encode, |
| 455 | masterId).whenComplete((r, error) -> { |
| 456 | if (error != null) { |
| 457 | log.warn("Failed to send packet-updown-req to {}", masterId, error); |
| 458 | } |
| 459 | }); |
| 460 | } else { |
| 461 | changePortStateAtMaster(deviceId, portNumber, enable); |
| 462 | } |
| 463 | } |
| 464 | |
| 465 | @Override |
samuel | e1fa732 | 2015-07-14 16:35:16 +0800 | [diff] [blame] | 466 | protected DeviceProviderService createProviderService( |
| 467 | DeviceProvider provider) { |
tom | 7869ad9 | 2014-09-09 14:32:08 -0700 | [diff] [blame] | 468 | return new InternalDeviceProviderService(provider); |
| 469 | } |
| 470 | |
Yuta HIGUCHI | 63323fd | 2014-11-11 12:16:58 -0800 | [diff] [blame] | 471 | /** |
| 472 | * Checks if all the reachable devices have a valid mastership role. |
| 473 | */ |
| 474 | private void mastershipCheck() { |
| 475 | log.debug("Checking mastership"); |
| 476 | for (Device device : getDevices()) { |
| 477 | final DeviceId deviceId = device.id(); |
Ray Milkey | c710467 | 2016-08-31 12:04:34 -0700 | [diff] [blame] | 478 | MastershipRole myRole = mastershipService.getLocalRole(deviceId); |
| 479 | log.trace("Checking device {}. Current role is {}", deviceId, myRole); |
Yuta HIGUCHI | 63323fd | 2014-11-11 12:16:58 -0800 | [diff] [blame] | 480 | if (!isReachable(deviceId)) { |
Ray Milkey | c710467 | 2016-08-31 12:04:34 -0700 | [diff] [blame] | 481 | if (myRole != NONE) { |
helenyrwu | fd296b6 | 2016-06-22 17:43:02 -0700 | [diff] [blame] | 482 | // can't be master if device is not reachable |
| 483 | try { |
Ray Milkey | c710467 | 2016-08-31 12:04:34 -0700 | [diff] [blame] | 484 | if (myRole == MASTER) { |
Andrea Campanella | e319dc2 | 2018-01-18 12:51:04 +0100 | [diff] [blame] | 485 | log.info("Local Role {}, Marking unreachable device {} offline", MASTER, deviceId); |
Ray Milkey | c710467 | 2016-08-31 12:04:34 -0700 | [diff] [blame] | 486 | post(store.markOffline(deviceId)); |
| 487 | } |
helenyrwu | fd296b6 | 2016-06-22 17:43:02 -0700 | [diff] [blame] | 488 | //relinquish master role and ability to be backup. |
| 489 | mastershipService.relinquishMastership(deviceId).get(); |
| 490 | } catch (InterruptedException e) { |
Thomas Vachuska | 5b38dc0 | 2018-05-10 15:24:40 -0700 | [diff] [blame] | 491 | log.warn("Interrupted while relinquishing role for {}", deviceId); |
helenyrwu | fd296b6 | 2016-06-22 17:43:02 -0700 | [diff] [blame] | 492 | Thread.currentThread().interrupt(); |
| 493 | } catch (ExecutionException e) { |
| 494 | log.error("Exception thrown while relinquishing role for {}", deviceId, e); |
| 495 | } |
Bharath Thiruveedula | 651a7da | 2016-12-13 02:52:50 +0530 | [diff] [blame] | 496 | } else { |
Andrea Campanella | e319dc2 | 2018-01-18 12:51:04 +0100 | [diff] [blame] | 497 | // check if the device has master and is available to the store, if not, mark it offline |
Bharath Thiruveedula | 651a7da | 2016-12-13 02:52:50 +0530 | [diff] [blame] | 498 | // only the nodes which has mastership role can mark any device offline. |
Andrea Campanella | e319dc2 | 2018-01-18 12:51:04 +0100 | [diff] [blame] | 499 | // This condition should never be hit unless in a device removed phase for NONE mastership roles. |
Jordan Halterman | bc0308f | 2017-11-29 15:37:34 -0800 | [diff] [blame] | 500 | NodeId master = mastershipService.getMasterFor(deviceId); |
Andrea Campanella | e319dc2 | 2018-01-18 12:51:04 +0100 | [diff] [blame] | 501 | if (master == null && isAvailable(deviceId)) { |
Jordan Halterman | bc0308f | 2017-11-29 15:37:34 -0800 | [diff] [blame] | 502 | CompletableFuture<MastershipRole> roleFuture = mastershipService.requestRoleFor(deviceId); |
| 503 | roleFuture.thenAccept(role -> { |
| 504 | MastershipTerm term = termService.getMastershipTerm(deviceId); |
| 505 | if (term != null && localNodeId.equals(term.master())) { |
| 506 | log.info("Marking unreachable device {} offline", deviceId); |
| 507 | post(store.markOffline(deviceId)); |
| 508 | } else { |
| 509 | log.info("Failed marking {} offline. {}", deviceId, role); |
| 510 | } |
| 511 | mastershipService.relinquishMastership(deviceId); |
| 512 | }); |
| 513 | } |
helenyrwu | fd296b6 | 2016-06-22 17:43:02 -0700 | [diff] [blame] | 514 | } |
Yuta HIGUCHI | 63323fd | 2014-11-11 12:16:58 -0800 | [diff] [blame] | 515 | continue; |
| 516 | } |
| 517 | |
Jordan Halterman | 368bd3d | 2019-01-04 12:45:57 -0800 | [diff] [blame] | 518 | // If this node is the master, ensure the device is marked online. |
Carmelo Cascone | 3977ea4 | 2019-02-28 13:43:42 -0800 | [diff] [blame] | 519 | if (myRole == MASTER && canMarkOnline(device)) { |
Jordan Halterman | 368bd3d | 2019-01-04 12:45:57 -0800 | [diff] [blame] | 520 | post(store.markOnline(deviceId)); |
| 521 | } |
| 522 | |
Ray Milkey | c710467 | 2016-08-31 12:04:34 -0700 | [diff] [blame] | 523 | if (myRole != NONE) { |
Yuta HIGUCHI | 63323fd | 2014-11-11 12:16:58 -0800 | [diff] [blame] | 524 | continue; |
| 525 | } |
| 526 | |
Ayaka Koshibe | d0ab3c0 | 2015-09-04 15:43:46 -0700 | [diff] [blame] | 527 | log.info("{} is reachable but did not have a valid role, reasserting", deviceId); |
Yuta HIGUCHI | 63323fd | 2014-11-11 12:16:58 -0800 | [diff] [blame] | 528 | |
| 529 | // isReachable but was not MASTER or STANDBY, get a role and apply |
| 530 | // Note: NONE triggers request to MastershipService |
Jordan Halterman | 9416aea | 2017-11-17 12:40:21 -0800 | [diff] [blame] | 531 | reassertRole(deviceId, NONE); |
Yuta HIGUCHI | 63323fd | 2014-11-11 12:16:58 -0800 | [diff] [blame] | 532 | } |
| 533 | } |
| 534 | |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 535 | // Personalized device provider service issued to the supplied provider. |
tom | dc361b6 | 2014-09-09 20:36:52 -0700 | [diff] [blame] | 536 | private class InternalDeviceProviderService |
Thomas Vachuska | d16ce18 | 2014-10-29 17:25:29 -0700 | [diff] [blame] | 537 | extends AbstractProviderService<DeviceProvider> |
| 538 | implements DeviceProviderService { |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 539 | |
tom | cfde062 | 2014-09-09 11:02:42 -0700 | [diff] [blame] | 540 | InternalDeviceProviderService(DeviceProvider provider) { |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 541 | super(provider); |
| 542 | } |
| 543 | |
Ray Milkey | 33306ba | 2018-09-20 13:27:25 -0700 | [diff] [blame] | 544 | /** |
| 545 | * Apply role in reaction to provider event. |
| 546 | * |
| 547 | * @param deviceId device identifier |
| 548 | * @param newRole new role to apply to the device |
| 549 | * @return true if the request was sent to provider |
| 550 | */ |
| 551 | private boolean applyRole(DeviceId deviceId, MastershipRole newRole) { |
| 552 | |
| 553 | if (newRole.equals(MastershipRole.NONE)) { |
| 554 | //no-op |
| 555 | return true; |
| 556 | } |
| 557 | |
| 558 | DeviceProvider provider = provider(); |
| 559 | if (provider == null) { |
| 560 | log.warn("Provider for {} was not found. Cannot apply role {}", |
| 561 | deviceId, newRole); |
| 562 | return false; |
| 563 | } |
| 564 | provider.roleChanged(deviceId, newRole); |
| 565 | // not triggering probe when triggered by provider service event |
| 566 | return true; |
| 567 | } |
| 568 | |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 569 | @Override |
alshabib | b7b4063 | 2014-09-28 21:30:00 -0700 | [diff] [blame] | 570 | public void deviceConnected(DeviceId deviceId, |
Thomas Vachuska | d16ce18 | 2014-10-29 17:25:29 -0700 | [diff] [blame] | 571 | DeviceDescription deviceDescription) { |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 572 | checkNotNull(deviceId, DEVICE_ID_NULL); |
| 573 | checkNotNull(deviceDescription, DEVICE_DESCRIPTION_NULL); |
tom | eadbb46 | 2014-09-07 16:10:19 -0700 | [diff] [blame] | 574 | checkValidity(); |
Yuta HIGUCHI | 24b2e2a | 2014-10-07 15:53:57 -0700 | [diff] [blame] | 575 | |
Yuta HIGUCHI | 0c47d53 | 2017-08-18 23:16:35 -0700 | [diff] [blame] | 576 | deviceLocalStatus.put(deviceId, new LocalStatus(true, Instant.now())); |
Saurav Das | d5ec9e9 | 2017-01-17 10:40:18 -0800 | [diff] [blame] | 577 | |
Ayaka Koshibe | d0ab3c0 | 2015-09-04 15:43:46 -0700 | [diff] [blame] | 578 | BasicDeviceConfig cfg = networkConfigService.getConfig(deviceId, BasicDeviceConfig.class); |
| 579 | if (!isAllowed(cfg)) { |
| 580 | log.warn("Device {} is not allowed", deviceId); |
| 581 | return; |
| 582 | } |
Andrea Campanella | 75ef9f5 | 2017-07-27 20:14:32 +0200 | [diff] [blame] | 583 | PortDescriptionsConfig portConfig = networkConfigService.getConfig(deviceId, PortDescriptionsConfig.class); |
Ayaka Koshibe | d0ab3c0 | 2015-09-04 15:43:46 -0700 | [diff] [blame] | 584 | // Generate updated description and establish my Role |
| 585 | deviceDescription = BasicDeviceOperator.combine(cfg, deviceDescription); |
jaegonkim | 1c1f0c2 | 2018-01-28 22:20:42 +0900 | [diff] [blame] | 586 | DeviceAnnotationConfig annoConfig = networkConfigService.getConfig(deviceId, DeviceAnnotationConfig.class); |
| 587 | if (annoConfig != null) { |
| 588 | deviceDescription = deviceAnnotationOp.combine(deviceId, deviceDescription, Optional.of(annoConfig)); |
| 589 | } |
| 590 | |
pier | 388ec25 | 2020-04-15 20:53:14 +0200 | [diff] [blame] | 591 | // Wait for the end of the election. sync call of requestRoleFor |
| 592 | // wait only 3s and it is not entirely safe since the leadership |
| 593 | // election timer can be higher. |
| 594 | MastershipRole role = Futures.getUnchecked(mastershipService.requestRoleFor(deviceId)); |
jaegonkim | 8eabcec | 2018-07-27 23:40:43 +0900 | [diff] [blame] | 595 | log.info("Local role is {} for {}", role, deviceId); |
pier | 388ec25 | 2020-04-15 20:53:14 +0200 | [diff] [blame] | 596 | store.createOrUpdateDevice(provider().id(), deviceId, deviceDescription); |
Ray Milkey | 33306ba | 2018-09-20 13:27:25 -0700 | [diff] [blame] | 597 | applyRole(deviceId, role); |
HIGUCHI Yuta | 11530fb | 2015-05-27 13:10:20 -0700 | [diff] [blame] | 598 | |
Andrea Campanella | 75ef9f5 | 2017-07-27 20:14:32 +0200 | [diff] [blame] | 599 | if (portConfig != null) { |
| 600 | //updating the ports if configration exists |
| 601 | List<PortDescription> complete = store.getPortDescriptions(provider().id(), deviceId) |
| 602 | .collect(Collectors.toList()); |
| 603 | complete.addAll(portConfig.portDescriptions()); |
| 604 | List<PortDescription> portDescriptions = complete.stream() |
| 605 | .map(e -> applyAllPortOps(deviceId, e)) |
| 606 | .collect(Collectors.toList()); |
| 607 | store.updatePorts(provider().id(), deviceId, portDescriptions); |
| 608 | } |
| 609 | |
helenyrwu | fd296b6 | 2016-06-22 17:43:02 -0700 | [diff] [blame] | 610 | if (deviceDescription.isDefaultAvailable()) { |
| 611 | log.info("Device {} connected", deviceId); |
| 612 | } else { |
| 613 | log.info("Device {} registered", deviceId); |
| 614 | } |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 615 | } |
| 616 | |
Yuta HIGUCHI | 6eb00cc | 2016-06-10 11:55:12 -0700 | [diff] [blame] | 617 | private PortDescription ensurePortEnabledState(PortDescription desc, boolean enabled) { |
| 618 | if (desc.isEnabled() != enabled) { |
Yuta HIGUCHI | 2b1935d | 2018-03-01 21:41:06 -0800 | [diff] [blame] | 619 | return DefaultPortDescription.builder(desc) |
| 620 | .isEnabled(enabled) |
| 621 | .build(); |
Yuta HIGUCHI | 6eb00cc | 2016-06-10 11:55:12 -0700 | [diff] [blame] | 622 | } |
| 623 | return desc; |
| 624 | } |
| 625 | |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 626 | @Override |
| 627 | public void deviceDisconnected(DeviceId deviceId) { |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 628 | checkNotNull(deviceId, DEVICE_ID_NULL); |
tom | eadbb46 | 2014-09-07 16:10:19 -0700 | [diff] [blame] | 629 | checkValidity(); |
Yuta HIGUCHI | 0c47d53 | 2017-08-18 23:16:35 -0700 | [diff] [blame] | 630 | deviceLocalStatus.put(deviceId, new LocalStatus(false, Instant.now())); |
Andrea Campanella | b0b93ac | 2021-09-13 12:37:36 +0200 | [diff] [blame] | 631 | log.info("Device {} disconnected from this node: {}", deviceId, |
| 632 | clusterService.getLocalNode().id()); |
Ayaka Koshibe | d9f693e | 2014-09-29 18:04:54 -0700 | [diff] [blame] | 633 | |
Yuta HIGUCHI | 6eb00cc | 2016-06-10 11:55:12 -0700 | [diff] [blame] | 634 | List<PortDescription> descs = store.getPortDescriptions(provider().id(), deviceId) |
| 635 | .map(desc -> ensurePortEnabledState(desc, false)) |
| 636 | .collect(Collectors.toList()); |
Yafit Hadar | a9a73de | 2015-09-06 13:52:52 +0300 | [diff] [blame] | 637 | |
alshabib | afc514a | 2014-12-01 14:44:05 -0800 | [diff] [blame] | 638 | store.updatePorts(this.provider().id(), deviceId, descs); |
Ayaka Koshibe | b5c63a0 | 2014-10-18 18:42:27 -0700 | [diff] [blame] | 639 | try { |
Madan Jampani | 565a66a | 2015-07-25 17:01:13 -0700 | [diff] [blame] | 640 | if (mastershipService.isLocalMaster(deviceId)) { |
Thomas Vachuska | 5f429d6 | 2015-05-28 15:34:36 -0700 | [diff] [blame] | 641 | post(store.markOffline(deviceId)); |
| 642 | } |
Ayaka Koshibe | b5c63a0 | 2014-10-18 18:42:27 -0700 | [diff] [blame] | 643 | } catch (IllegalStateException e) { |
Yuta HIGUCHI | eb24e9d | 2014-10-26 19:34:20 -0700 | [diff] [blame] | 644 | log.warn("Failed to mark {} offline", deviceId); |
| 645 | // only the MASTER should be marking off-line in normal cases, |
samuel | e1fa732 | 2015-07-14 16:35:16 +0800 | [diff] [blame] | 646 | // but if I was the last STANDBY connection, etc. and no one else |
| 647 | // was there to mark the device offline, this instance may need to |
Yuta HIGUCHI | eb24e9d | 2014-10-26 19:34:20 -0700 | [diff] [blame] | 648 | // temporarily request for Master Role and mark offline. |
| 649 | |
samuel | e1fa732 | 2015-07-14 16:35:16 +0800 | [diff] [blame] | 650 | //there are times when this node will correctly have mastership, BUT |
| 651 | //that isn't reflected in the ClockManager before the device disconnects. |
| 652 | //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] | 653 | |
Yuta HIGUCHI | eb24e9d | 2014-10-26 19:34:20 -0700 | [diff] [blame] | 654 | // FIXME: Store semantics leaking out as IllegalStateException. |
samuel | e1fa732 | 2015-07-14 16:35:16 +0800 | [diff] [blame] | 655 | // Consider revising store API to handle this scenario. |
| 656 | CompletableFuture<MastershipRole> roleFuture = mastershipService.requestRoleFor(deviceId); |
Madan Jampani | de003d9 | 2015-05-11 17:14:20 -0700 | [diff] [blame] | 657 | roleFuture.whenComplete((role, error) -> { |
samuel | e1fa732 | 2015-07-14 16:35:16 +0800 | [diff] [blame] | 658 | MastershipTerm term = termService.getMastershipTerm(deviceId); |
| 659 | // TODO: Move this type of check inside device clock manager, etc. |
| 660 | if (term != null && localNodeId.equals(term.master())) { |
| 661 | log.info("Retry marking {} offline", deviceId); |
samuel | e1fa732 | 2015-07-14 16:35:16 +0800 | [diff] [blame] | 662 | post(store.markOffline(deviceId)); |
| 663 | } else { |
| 664 | log.info("Failed again marking {} offline. {}", deviceId, role); |
| 665 | } |
| 666 | }); |
Ayaka Koshibe | b5c63a0 | 2014-10-18 18:42:27 -0700 | [diff] [blame] | 667 | } finally { |
Madan Jampani | c6e574f | 2015-05-29 13:41:52 -0700 | [diff] [blame] | 668 | try { |
samuel | e1fa732 | 2015-07-14 16:35:16 +0800 | [diff] [blame] | 669 | //relinquish master role and ability to be backup. |
Madan Jampani | c6e574f | 2015-05-29 13:41:52 -0700 | [diff] [blame] | 670 | mastershipService.relinquishMastership(deviceId).get(); |
| 671 | } catch (InterruptedException e) { |
samuel | e1fa732 | 2015-07-14 16:35:16 +0800 | [diff] [blame] | 672 | log.warn("Interrupted while reliquishing role for {}", deviceId); |
Madan Jampani | c6e574f | 2015-05-29 13:41:52 -0700 | [diff] [blame] | 673 | Thread.currentThread().interrupt(); |
| 674 | } catch (ExecutionException e) { |
samuel | e1fa732 | 2015-07-14 16:35:16 +0800 | [diff] [blame] | 675 | log.error("Exception thrown while relinquishing role for {}", deviceId, e); |
Madan Jampani | c6e574f | 2015-05-29 13:41:52 -0700 | [diff] [blame] | 676 | } |
tom | 0efbb1d | 2014-09-09 11:54:28 -0700 | [diff] [blame] | 677 | } |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 678 | } |
| 679 | |
| 680 | @Override |
alshabib | b7b4063 | 2014-09-28 21:30:00 -0700 | [diff] [blame] | 681 | public void updatePorts(DeviceId deviceId, |
Thomas Vachuska | d16ce18 | 2014-10-29 17:25:29 -0700 | [diff] [blame] | 682 | List<PortDescription> portDescriptions) { |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 683 | checkNotNull(deviceId, DEVICE_ID_NULL); |
Ayaka Koshibe | d0ab3c0 | 2015-09-04 15:43:46 -0700 | [diff] [blame] | 684 | checkNotNull(portDescriptions, PORT_DESC_LIST_NULL); |
tom | eadbb46 | 2014-09-07 16:10:19 -0700 | [diff] [blame] | 685 | checkValidity(); |
Madan Jampani | 565a66a | 2015-07-25 17:01:13 -0700 | [diff] [blame] | 686 | if (!mastershipService.isLocalMaster(deviceId)) { |
Yuta HIGUCHI | 13c0b87 | 2014-10-30 18:09:22 -0700 | [diff] [blame] | 687 | // Never been a master for this device |
| 688 | // any update will be ignored. |
samuel | e1fa732 | 2015-07-14 16:35:16 +0800 | [diff] [blame] | 689 | log.trace("Ignoring {} port updates on standby node. {}", deviceId, portDescriptions); |
Yuta HIGUCHI | 13c0b87 | 2014-10-30 18:09:22 -0700 | [diff] [blame] | 690 | return; |
| 691 | } |
Andrea Campanella | 75ef9f5 | 2017-07-27 20:14:32 +0200 | [diff] [blame] | 692 | PortDescriptionsConfig portConfig = networkConfigService.getConfig(deviceId, PortDescriptionsConfig.class); |
| 693 | if (portConfig != null) { |
Carmelo Cascone | 1da7a4d | 2018-06-27 18:03:11 +0200 | [diff] [blame] | 694 | // Updating the ports if configuration exists (on new lists as |
| 695 | // the passed one might be immutable) |
| 696 | portDescriptions = Lists.newArrayList(portDescriptions); |
Andrea Campanella | 75ef9f5 | 2017-07-27 20:14:32 +0200 | [diff] [blame] | 697 | portDescriptions.addAll(portConfig.portDescriptions()); |
| 698 | } |
Ayaka Koshibe | d0ab3c0 | 2015-09-04 15:43:46 -0700 | [diff] [blame] | 699 | portDescriptions = portDescriptions.stream() |
Yuta HIGUCHI | b9af6b7 | 2016-06-10 10:52:58 -0700 | [diff] [blame] | 700 | .map(e -> applyAllPortOps(deviceId, e)) |
Ayaka Koshibe | d0ab3c0 | 2015-09-04 15:43:46 -0700 | [diff] [blame] | 701 | .collect(Collectors.toList()); |
Yuta HIGUCHI | 5f6739c | 2014-10-01 14:04:01 -0700 | [diff] [blame] | 702 | List<DeviceEvent> events = store.updatePorts(this.provider().id(), |
samuel | e1fa732 | 2015-07-14 16:35:16 +0800 | [diff] [blame] | 703 | deviceId, portDescriptions); |
Thomas Vachuska | 5923b9a | 2016-01-26 10:52:57 -0800 | [diff] [blame] | 704 | if (events != null) { |
| 705 | for (DeviceEvent event : events) { |
| 706 | post(event); |
| 707 | } |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 708 | } |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 709 | } |
| 710 | |
| 711 | @Override |
alshabib | b7b4063 | 2014-09-28 21:30:00 -0700 | [diff] [blame] | 712 | public void portStatusChanged(DeviceId deviceId, |
Thomas Vachuska | d16ce18 | 2014-10-29 17:25:29 -0700 | [diff] [blame] | 713 | PortDescription portDescription) { |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 714 | checkNotNull(deviceId, DEVICE_ID_NULL); |
| 715 | checkNotNull(portDescription, PORT_DESCRIPTION_NULL); |
tom | eadbb46 | 2014-09-07 16:10:19 -0700 | [diff] [blame] | 716 | checkValidity(); |
Ayaka Koshibe | b5c63a0 | 2014-10-18 18:42:27 -0700 | [diff] [blame] | 717 | |
Madan Jampani | 565a66a | 2015-07-25 17:01:13 -0700 | [diff] [blame] | 718 | if (!mastershipService.isLocalMaster(deviceId)) { |
Yuta HIGUCHI | 13c0b87 | 2014-10-30 18:09:22 -0700 | [diff] [blame] | 719 | // Never been a master for this device |
| 720 | // any update will be ignored. |
Sahil Lele | 3a0cdd5 | 2015-07-21 14:16:31 -0700 | [diff] [blame] | 721 | log.trace("Ignoring {} port update on standby node. {}", deviceId, |
| 722 | portDescription); |
Yuta HIGUCHI | 13c0b87 | 2014-10-30 18:09:22 -0700 | [diff] [blame] | 723 | return; |
| 724 | } |
Ray Milkey | 9ef2223 | 2016-07-14 12:42:37 -0700 | [diff] [blame] | 725 | Device device = getDevice(deviceId); |
| 726 | if (device == null) { |
| 727 | log.trace("Device not found: {}", deviceId); |
nitinanand | ddfa8c9 | 2017-03-24 16:14:23 +0530 | [diff] [blame] | 728 | return; |
Ray Milkey | 9ef2223 | 2016-07-14 12:42:37 -0700 | [diff] [blame] | 729 | } |
Andrea Campanella | 1c24fb9 | 2018-12-20 16:43:59 +0100 | [diff] [blame] | 730 | if ((Type.ROADM.equals(device.type())) || (Type.OTN.equals(device.type())) || |
| 731 | (Type.OLS.equals(device.type())) || (Type.TERMINAL_DEVICE.equals(device.type()))) { |
HIGUCHI Yuta | 6972ae6 | 2016-05-12 19:57:46 -0700 | [diff] [blame] | 732 | // FIXME This is ignoring all other info in portDescription given as input?? |
Yuta HIGUCHI | 6eb00cc | 2016-06-10 11:55:12 -0700 | [diff] [blame] | 733 | PortDescription storedPortDesc = store.getPortDescription(provider().id(), |
Simon Hunt | ffbad3b | 2017-05-16 15:37:51 -0700 | [diff] [blame] | 734 | deviceId, |
| 735 | portDescription.portNumber()); |
Yuta HIGUCHI | 6eb00cc | 2016-06-10 11:55:12 -0700 | [diff] [blame] | 736 | portDescription = ensurePortEnabledState(storedPortDesc, |
| 737 | portDescription.isEnabled()); |
Yafit Hadar | a9a73de | 2015-09-06 13:52:52 +0300 | [diff] [blame] | 738 | } |
| 739 | |
Yuta HIGUCHI | b9af6b7 | 2016-06-10 10:52:58 -0700 | [diff] [blame] | 740 | portDescription = applyAllPortOps(deviceId, portDescription); |
samuel | e1fa732 | 2015-07-14 16:35:16 +0800 | [diff] [blame] | 741 | final DeviceEvent event = store.updatePortStatus(this.provider().id(), |
HIGUCHI Yuta | 6972ae6 | 2016-05-12 19:57:46 -0700 | [diff] [blame] | 742 | deviceId, |
Yuta HIGUCHI | b9af6b7 | 2016-06-10 10:52:58 -0700 | [diff] [blame] | 743 | portDescription); |
tom | ff7eb7c | 2014-09-08 12:49:03 -0700 | [diff] [blame] | 744 | if (event != null) { |
Carmelo Cascone | ab5d41e | 2019-03-06 18:02:34 -0800 | [diff] [blame] | 745 | log.info("Device {} port {} status changed (enabled={})", |
| 746 | deviceId, event.port().number(), portDescription.isEnabled()); |
tom | 0efbb1d | 2014-09-09 11:54:28 -0700 | [diff] [blame] | 747 | post(event); |
tom | ff7eb7c | 2014-09-08 12:49:03 -0700 | [diff] [blame] | 748 | } |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 749 | } |
tom | 3f2bbd7 | 2014-09-24 12:07:58 -0700 | [diff] [blame] | 750 | |
| 751 | @Override |
Michal Mach | ce77433 | 2017-01-25 11:02:55 +0100 | [diff] [blame] | 752 | public void deletePort(DeviceId deviceId, PortDescription basePortDescription) { |
| 753 | |
| 754 | checkNotNull(deviceId, DEVICE_ID_NULL); |
| 755 | checkNotNull(basePortDescription, PORT_DESCRIPTION_NULL); |
| 756 | checkValidity(); |
| 757 | |
| 758 | if (!mastershipService.isLocalMaster(deviceId)) { |
| 759 | // Never been a master for this device |
| 760 | // any update will be ignored. |
| 761 | log.trace("Ignoring {} port update on standby node. {}", deviceId, |
| 762 | basePortDescription); |
| 763 | return; |
| 764 | } |
| 765 | |
| 766 | Device device = getDevice(deviceId); |
| 767 | if (device == null) { |
| 768 | log.trace("Device not found: {}", deviceId); |
| 769 | } |
| 770 | |
Yuta HIGUCHI | 53e4796 | 2018-03-01 23:50:48 -0800 | [diff] [blame] | 771 | PortDescription newPortDescription = DefaultPortDescription.builder(basePortDescription) |
| 772 | .isRemoved(true) |
| 773 | .build(); |
| 774 | |
Michal Mach | ce77433 | 2017-01-25 11:02:55 +0100 | [diff] [blame] | 775 | final DeviceEvent event = store.updatePortStatus(this.provider().id(), |
| 776 | deviceId, |
| 777 | newPortDescription); |
| 778 | if (event != null) { |
| 779 | log.info("Device {} port {} status changed", deviceId, event.port().number()); |
| 780 | post(event); |
| 781 | } |
| 782 | } |
| 783 | |
| 784 | @Override |
samuel | e1fa732 | 2015-07-14 16:35:16 +0800 | [diff] [blame] | 785 | public void receivedRoleReply(DeviceId deviceId, MastershipRole requested, |
Thomas Vachuska | b17c41f | 2015-05-19 11:16:05 -0700 | [diff] [blame] | 786 | MastershipRole response) { |
Ayaka Koshibe | 3ef2b0d | 2014-10-31 13:58:27 -0700 | [diff] [blame] | 787 | // Several things can happen here: |
| 788 | // 1. request and response match |
| 789 | // 2. request and response don't match |
| 790 | // 3. MastershipRole and requested match (and 1 or 2 are true) |
| 791 | // 4. MastershipRole and requested don't match (and 1 or 2 are true) |
| 792 | // |
| 793 | // 2, 4, and 3 with case 2 are failure modes. |
| 794 | |
tom | 3f2bbd7 | 2014-09-24 12:07:58 -0700 | [diff] [blame] | 795 | // FIXME: implement response to this notification |
Ayaka Koshibe | 3ef2b0d | 2014-10-31 13:58:27 -0700 | [diff] [blame] | 796 | |
Madan Jampani | f2af771 | 2015-05-29 18:43:52 -0700 | [diff] [blame] | 797 | 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] | 798 | deviceId, requested, response); |
Ayaka Koshibe | 3ef2b0d | 2014-10-31 13:58:27 -0700 | [diff] [blame] | 799 | |
| 800 | if (requested == null && response == null) { |
samuel | e1fa732 | 2015-07-14 16:35:16 +0800 | [diff] [blame] | 801 | // something was off with DeviceProvider, maybe check channel too? |
Shashikanth VH | 387a1ca | 2016-02-09 20:35:21 +0530 | [diff] [blame] | 802 | log.warn("Failed to assert role onto Device {}", deviceId); |
Yuta HIGUCHI | cf60390 | 2014-10-07 23:04:32 -0700 | [diff] [blame] | 803 | mastershipService.relinquishMastership(deviceId); |
Ayaka Koshibe | 3ef2b0d | 2014-10-31 13:58:27 -0700 | [diff] [blame] | 804 | return; |
Yuta HIGUCHI | cf60390 | 2014-10-07 23:04:32 -0700 | [diff] [blame] | 805 | } |
Ayaka Koshibe | 3ef2b0d | 2014-10-31 13:58:27 -0700 | [diff] [blame] | 806 | |
Carmelo Cascone | 3977ea4 | 2019-02-28 13:43:42 -0800 | [diff] [blame] | 807 | final MastershipRole expected = mastershipService.getLocalRole(deviceId); |
| 808 | |
| 809 | if (requested == null) { |
| 810 | // Provider is not able to reconcile role responses with |
| 811 | // requests. We assume what was requested is what we expect. |
| 812 | // This will work only if mastership doesn't change too often, |
| 813 | // and devices are left enough time to provide responses before |
| 814 | // a different role is requested. |
| 815 | requested = expected; |
| 816 | } |
| 817 | |
Thomas Vachuska | b17c41f | 2015-05-19 11:16:05 -0700 | [diff] [blame] | 818 | if (Objects.equals(requested, response)) { |
Carmelo Cascone | 3977ea4 | 2019-02-28 13:43:42 -0800 | [diff] [blame] | 819 | if (Objects.equals(requested, expected)) { |
Ayaka Koshibe | 3ef2b0d | 2014-10-31 13:58:27 -0700 | [diff] [blame] | 820 | return; |
| 821 | } else { |
Carmelo Cascone | 3977ea4 | 2019-02-28 13:43:42 -0800 | [diff] [blame] | 822 | log.warn("Role mismatch on {}. Set to {}, but store demands {}", |
| 823 | deviceId, response, expected); |
HIGUCHI Yuta | 1979f55 | 2015-12-28 21:24:26 -0800 | [diff] [blame] | 824 | // roleManager got the device to comply, but doesn't agree with |
Ayaka Koshibe | 3ef2b0d | 2014-10-31 13:58:27 -0700 | [diff] [blame] | 825 | // the store; use the store's view, then try to reassert. |
Carmelo Cascone | 3977ea4 | 2019-02-28 13:43:42 -0800 | [diff] [blame] | 826 | backgroundService.execute(() -> reassertRole(deviceId, expected)); |
HIGUCHI Yuta | 1979f55 | 2015-12-28 21:24:26 -0800 | [diff] [blame] | 827 | return; |
Ayaka Koshibe | 3ef2b0d | 2014-10-31 13:58:27 -0700 | [diff] [blame] | 828 | } |
| 829 | } else { |
| 830 | // we didn't get back what we asked for. Reelect someone else. |
Carmelo Cascone | e5b2872 | 2018-06-22 17:28:28 +0200 | [diff] [blame] | 831 | log.warn("Failed to assert role onto device {}. requested={}, response={}", |
| 832 | deviceId, requested, response); |
Carmelo Cascone | b37bdde | 2018-06-22 17:25:46 +0200 | [diff] [blame] | 833 | if (requested == MastershipRole.MASTER) { |
Ayaka Koshibe | 3ef2b0d | 2014-10-31 13:58:27 -0700 | [diff] [blame] | 834 | mastershipService.relinquishMastership(deviceId); |
| 835 | // TODO: Shouldn't we be triggering event? |
samuel | e1fa732 | 2015-07-14 16:35:16 +0800 | [diff] [blame] | 836 | //final Device device = getDevice(deviceId); |
| 837 | //post(new DeviceEvent(DEVICE_MASTERSHIP_CHANGED, device)); |
Charles Chan | 3855dc1 | 2021-01-06 01:33:03 +0000 | [diff] [blame] | 838 | } else if (requested == MastershipRole.STANDBY) { |
| 839 | // For P4RT devices, the response role will be NONE when this node is expected to be STANDBY |
| 840 | // but the stream channel is not opened correctly. |
| 841 | // Calling reassertRole will trigger the mechanism in GeneralDeviceProvider that |
| 842 | // attempts to re-establish the stream channel |
| 843 | backgroundService.execute(() -> reassertRole(deviceId, expected)); |
| 844 | return; |
Ayaka Koshibe | 3ef2b0d | 2014-10-31 13:58:27 -0700 | [diff] [blame] | 845 | } |
| 846 | } |
tom | 3f2bbd7 | 2014-09-24 12:07:58 -0700 | [diff] [blame] | 847 | } |
sangho | 538108b | 2015-04-08 14:29:20 -0700 | [diff] [blame] | 848 | |
| 849 | @Override |
samuel | e1fa732 | 2015-07-14 16:35:16 +0800 | [diff] [blame] | 850 | public void updatePortStatistics(DeviceId deviceId, Collection<PortStatistics> portStatistics) { |
sangho | 538108b | 2015-04-08 14:29:20 -0700 | [diff] [blame] | 851 | checkNotNull(deviceId, DEVICE_ID_NULL); |
Thomas Vachuska | b17c41f | 2015-05-19 11:16:05 -0700 | [diff] [blame] | 852 | checkNotNull(portStatistics, "Port statistics list cannot be null"); |
sangho | 538108b | 2015-04-08 14:29:20 -0700 | [diff] [blame] | 853 | checkValidity(); |
| 854 | |
samuel | e1fa732 | 2015-07-14 16:35:16 +0800 | [diff] [blame] | 855 | DeviceEvent event = store.updatePortStatistics(this.provider().id(), |
| 856 | deviceId, portStatistics); |
sangho | 538108b | 2015-04-08 14:29:20 -0700 | [diff] [blame] | 857 | post(event); |
| 858 | } |
pierventre | e1f8010 | 2021-10-01 22:01:22 +0200 | [diff] [blame] | 859 | |
| 860 | @Override |
| 861 | public DeviceDescription getDeviceDescription(DeviceId deviceId) { |
| 862 | checkNotNull(deviceId, DEVICE_ID_NULL); |
| 863 | checkValidity(); |
| 864 | |
| 865 | return store.getDeviceDescription(provider().id(), deviceId); |
| 866 | } |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 867 | } |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 868 | |
Ayaka Koshibe | d0ab3c0 | 2015-09-04 15:43:46 -0700 | [diff] [blame] | 869 | // by default allowed, otherwise check flag |
| 870 | private boolean isAllowed(BasicDeviceConfig cfg) { |
| 871 | return (cfg == null || cfg.isAllowed()); |
| 872 | } |
| 873 | |
Carmelo Cascone | 0761cd3 | 2018-08-29 19:22:50 -0700 | [diff] [blame] | 874 | private boolean canMarkOnline(Device device) { |
Carmelo Cascone | 3977ea4 | 2019-02-28 13:43:42 -0800 | [diff] [blame] | 875 | DeviceProvider provider = getProvider(device.id()); |
| 876 | if (provider == null) { |
| 877 | log.warn("Provider for {} was not found. Cannot evaluate availability", device.id()); |
| 878 | return false; |
| 879 | } |
| 880 | return provider.isAvailable(device.id()); |
Carmelo Cascone | 0761cd3 | 2018-08-29 19:22:50 -0700 | [diff] [blame] | 881 | } |
| 882 | |
Yuta HIGUCHI | 63323fd | 2014-11-11 12:16:58 -0800 | [diff] [blame] | 883 | // Applies the specified role to the device; ignores NONE |
Thomas Vachuska | 42e8cce | 2015-07-29 19:25:18 -0700 | [diff] [blame] | 884 | |
Yuta HIGUCHI | 63323fd | 2014-11-11 12:16:58 -0800 | [diff] [blame] | 885 | /** |
| 886 | * Apply role to device and send probe if MASTER. |
| 887 | * |
Thomas Vachuska | 42e8cce | 2015-07-29 19:25:18 -0700 | [diff] [blame] | 888 | * @param deviceId device identifier |
| 889 | * @param newRole new role to apply to the device |
Yuta HIGUCHI | 63323fd | 2014-11-11 12:16:58 -0800 | [diff] [blame] | 890 | * @return true if the request was sent to provider |
| 891 | */ |
| 892 | private boolean applyRoleAndProbe(DeviceId deviceId, MastershipRole newRole) { |
| 893 | if (newRole.equals(MastershipRole.NONE)) { |
samuel | e1fa732 | 2015-07-14 16:35:16 +0800 | [diff] [blame] | 894 | //no-op |
Yuta HIGUCHI | d26354d | 2014-10-31 14:14:38 -0700 | [diff] [blame] | 895 | return true; |
| 896 | } |
Ayaka Koshibe | 317245a | 2014-10-29 00:34:43 -0700 | [diff] [blame] | 897 | |
Ayaka Koshibe | 78bcbc1 | 2014-11-19 14:28:58 -0800 | [diff] [blame] | 898 | DeviceProvider provider = getProvider(deviceId); |
Yuta HIGUCHI | 63323fd | 2014-11-11 12:16:58 -0800 | [diff] [blame] | 899 | if (provider == null) { |
samuel | e1fa732 | 2015-07-14 16:35:16 +0800 | [diff] [blame] | 900 | log.warn("Provider for {} was not found. Cannot apply role {}", deviceId, newRole); |
Yuta HIGUCHI | 63323fd | 2014-11-11 12:16:58 -0800 | [diff] [blame] | 901 | return false; |
| 902 | } |
| 903 | provider.roleChanged(deviceId, newRole); |
| 904 | |
| 905 | if (newRole.equals(MastershipRole.MASTER)) { |
HIGUCHI Yuta | 1979f55 | 2015-12-28 21:24:26 -0800 | [diff] [blame] | 906 | log.debug("sent TriggerProbe({})", deviceId); |
Yuta HIGUCHI | 63323fd | 2014-11-11 12:16:58 -0800 | [diff] [blame] | 907 | // only trigger event when request was sent to provider |
Ayaka Koshibe | 78bcbc1 | 2014-11-19 14:28:58 -0800 | [diff] [blame] | 908 | provider.triggerProbe(deviceId); |
Yuta HIGUCHI | 63323fd | 2014-11-11 12:16:58 -0800 | [diff] [blame] | 909 | } |
| 910 | return true; |
| 911 | } |
| 912 | |
| 913 | /** |
Harold Huang | ff6e1e6 | 2017-11-09 16:25:36 +0800 | [diff] [blame] | 914 | * Reassert role for specified device connected to this node. |
Yuta HIGUCHI | 63323fd | 2014-11-11 12:16:58 -0800 | [diff] [blame] | 915 | * |
Thomas Vachuska | 42e8cce | 2015-07-29 19:25:18 -0700 | [diff] [blame] | 916 | * @param did device identifier |
| 917 | * @param nextRole role to apply. If NONE is specified, |
| 918 | * it will ask mastership service for a role and apply it. |
Yuta HIGUCHI | 63323fd | 2014-11-11 12:16:58 -0800 | [diff] [blame] | 919 | */ |
samuel | e1fa732 | 2015-07-14 16:35:16 +0800 | [diff] [blame] | 920 | private void reassertRole(final DeviceId did, |
| 921 | final MastershipRole nextRole) { |
Yuta HIGUCHI | 63323fd | 2014-11-11 12:16:58 -0800 | [diff] [blame] | 922 | |
Jordan Halterman | 9416aea | 2017-11-17 12:40:21 -0800 | [diff] [blame] | 923 | MastershipRole myNextRole = nextRole; |
| 924 | if (myNextRole == NONE && upgradeService.isLocalActive()) { |
| 925 | try { |
| 926 | mastershipService.requestRoleFor(did).get(); |
| 927 | MastershipTerm term = termService.getMastershipTerm(did); |
| 928 | if (term != null && localNodeId.equals(term.master())) { |
| 929 | myNextRole = MASTER; |
| 930 | } else { |
| 931 | myNextRole = STANDBY; |
| 932 | } |
| 933 | } catch (InterruptedException e) { |
| 934 | Thread.currentThread().interrupt(); |
| 935 | log.error("Interrupted waiting for Mastership", e); |
| 936 | } catch (ExecutionException e) { |
| 937 | log.error("Encountered an error waiting for Mastership", e); |
| 938 | } |
| 939 | } |
| 940 | |
| 941 | switch (myNextRole) { |
Thomas Vachuska | 42e8cce | 2015-07-29 19:25:18 -0700 | [diff] [blame] | 942 | case MASTER: |
| 943 | final Device device = getDevice(did); |
Carmelo Cascone | 0761cd3 | 2018-08-29 19:22:50 -0700 | [diff] [blame] | 944 | if (device != null && !isAvailable(did) && canMarkOnline(device)) { |
Palash Kala | 6c52606 | 2018-04-03 18:25:11 +0900 | [diff] [blame] | 945 | post(store.markOnline(did)); |
Thomas Vachuska | 42e8cce | 2015-07-29 19:25:18 -0700 | [diff] [blame] | 946 | } |
| 947 | // TODO: should apply role only if there is mismatch |
Jordan Halterman | 9416aea | 2017-11-17 12:40:21 -0800 | [diff] [blame] | 948 | log.debug("Applying role {} to {}", myNextRole, did); |
Thomas Vachuska | 42e8cce | 2015-07-29 19:25:18 -0700 | [diff] [blame] | 949 | if (!applyRoleAndProbe(did, MASTER)) { |
Jordan Halterman | 9416aea | 2017-11-17 12:40:21 -0800 | [diff] [blame] | 950 | log.warn("Unsuccessful applying role {} to {}", myNextRole, did); |
Thomas Vachuska | 42e8cce | 2015-07-29 19:25:18 -0700 | [diff] [blame] | 951 | // immediately failed to apply role |
| 952 | mastershipService.relinquishMastership(did); |
| 953 | // FIXME disconnect? |
| 954 | } |
| 955 | break; |
| 956 | case STANDBY: |
Jordan Halterman | 9416aea | 2017-11-17 12:40:21 -0800 | [diff] [blame] | 957 | log.debug("Applying role {} to {}", myNextRole, did); |
Thomas Vachuska | 42e8cce | 2015-07-29 19:25:18 -0700 | [diff] [blame] | 958 | if (!applyRoleAndProbe(did, STANDBY)) { |
Jordan Halterman | 9416aea | 2017-11-17 12:40:21 -0800 | [diff] [blame] | 959 | log.warn("Unsuccessful applying role {} to {}", myNextRole, did); |
Thomas Vachuska | 42e8cce | 2015-07-29 19:25:18 -0700 | [diff] [blame] | 960 | // immediately failed to apply role |
| 961 | mastershipService.relinquishMastership(did); |
| 962 | // FIXME disconnect? |
| 963 | } |
| 964 | break; |
| 965 | case NONE: |
Jordan Halterman | 980a8c1 | 2017-09-22 18:01:19 -0700 | [diff] [blame] | 966 | break; |
Thomas Vachuska | 42e8cce | 2015-07-29 19:25:18 -0700 | [diff] [blame] | 967 | default: |
| 968 | // should never reach here |
| 969 | log.error("You didn't see anything. I did not exist."); |
| 970 | break; |
Yuta HIGUCHI | 63323fd | 2014-11-11 12:16:58 -0800 | [diff] [blame] | 971 | } |
| 972 | } |
| 973 | |
Madan Jampani | 328371d | 2015-05-29 14:06:27 -0700 | [diff] [blame] | 974 | private void handleMastershipEvent(MastershipEvent event) { |
Jon Hall | 7a8bfc6 | 2016-05-26 17:59:04 -0700 | [diff] [blame] | 975 | if (event.type() == MastershipEvent.Type.BACKUPS_CHANGED) { |
Madan Jampani | 328371d | 2015-05-29 14:06:27 -0700 | [diff] [blame] | 976 | // Don't care if backup list changed. |
| 977 | return; |
| 978 | } |
Madan Jampani | 328371d | 2015-05-29 14:06:27 -0700 | [diff] [blame] | 979 | final DeviceId did = event.subject(); |
| 980 | |
| 981 | // myRole suggested by MastershipService |
| 982 | MastershipRole myNextRole; |
Jon Hall | 7a8bfc6 | 2016-05-26 17:59:04 -0700 | [diff] [blame] | 983 | if (event.type() == MastershipEvent.Type.SUSPENDED) { |
| 984 | myNextRole = NONE; // FIXME STANDBY OR NONE? |
| 985 | } else if (localNodeId.equals(event.roleInfo().master())) { |
Madan Jampani | 328371d | 2015-05-29 14:06:27 -0700 | [diff] [blame] | 986 | // confirm latest info |
| 987 | MastershipTerm term = termService.getMastershipTerm(did); |
samuel | e1fa732 | 2015-07-14 16:35:16 +0800 | [diff] [blame] | 988 | final boolean iHaveControl = term != null && localNodeId.equals(term.master()); |
Madan Jampani | 328371d | 2015-05-29 14:06:27 -0700 | [diff] [blame] | 989 | if (iHaveControl) { |
Madan Jampani | 328371d | 2015-05-29 14:06:27 -0700 | [diff] [blame] | 990 | myNextRole = MASTER; |
| 991 | } else { |
| 992 | myNextRole = STANDBY; |
| 993 | } |
| 994 | } else if (event.roleInfo().backups().contains(localNodeId)) { |
| 995 | myNextRole = STANDBY; |
| 996 | } else { |
| 997 | myNextRole = NONE; |
| 998 | } |
| 999 | |
Madan Jampani | 328371d | 2015-05-29 14:06:27 -0700 | [diff] [blame] | 1000 | final boolean isReachable = isReachable(did); |
| 1001 | if (!isReachable) { |
| 1002 | // device is not connected to this node |
Jon Hall | a90c44c | 2017-01-24 16:02:07 -0800 | [diff] [blame] | 1003 | if (mastershipService.getLocalRole(did) == NONE) { |
| 1004 | log.debug("Node was instructed to be {} role for {}, " |
Simon Hunt | ffbad3b | 2017-05-16 15:37:51 -0700 | [diff] [blame] | 1005 | + "but this node cannot reach the device " |
| 1006 | + "and role is already None. Ignoring request.", |
| 1007 | myNextRole, did); |
Jon Hall | a90c44c | 2017-01-24 16:02:07 -0800 | [diff] [blame] | 1008 | } else if (myNextRole != NONE) { |
Madan Jampani | 328371d | 2015-05-29 14:06:27 -0700 | [diff] [blame] | 1009 | log.warn("Node was instructed to be {} role for {}, " |
Thomas Vachuska | 42e8cce | 2015-07-29 19:25:18 -0700 | [diff] [blame] | 1010 | + "but this node cannot reach the device. " |
| 1011 | + "Relinquishing role. ", |
samuel | e1fa732 | 2015-07-14 16:35:16 +0800 | [diff] [blame] | 1012 | myNextRole, did); |
Madan Jampani | 328371d | 2015-05-29 14:06:27 -0700 | [diff] [blame] | 1013 | mastershipService.relinquishMastership(did); |
| 1014 | } |
| 1015 | return; |
| 1016 | } |
| 1017 | |
| 1018 | // device is connected to this node: |
| 1019 | if (store.getDevice(did) != null) { |
| 1020 | reassertRole(did, myNextRole); |
| 1021 | } else { |
| 1022 | log.debug("Device is not yet/no longer in the store: {}", did); |
| 1023 | } |
| 1024 | } |
| 1025 | |
Yuta HIGUCHI | 63323fd | 2014-11-11 12:16:58 -0800 | [diff] [blame] | 1026 | // Intercepts mastership events |
| 1027 | private class InternalMastershipListener implements MastershipListener { |
| 1028 | |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 1029 | @Override |
| 1030 | public void event(MastershipEvent event) { |
HIGUCHI Yuta | 060da9a | 2016-03-11 19:16:35 -0800 | [diff] [blame] | 1031 | backgroundService.execute(() -> { |
Madan Jampani | 328371d | 2015-05-29 14:06:27 -0700 | [diff] [blame] | 1032 | try { |
| 1033 | handleMastershipEvent(event); |
| 1034 | } catch (Exception e) { |
| 1035 | log.warn("Failed to handle {}", event, e); |
Yuta HIGUCHI | d26354d | 2014-10-31 14:14:38 -0700 | [diff] [blame] | 1036 | } |
Madan Jampani | 328371d | 2015-05-29 14:06:27 -0700 | [diff] [blame] | 1037 | }); |
Ayaka Koshibe | 317245a | 2014-10-29 00:34:43 -0700 | [diff] [blame] | 1038 | } |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 1039 | } |
tom | f80c972 | 2014-09-24 14:49:18 -0700 | [diff] [blame] | 1040 | |
| 1041 | // Store delegate to re-post events emitted from the store. |
Thomas Vachuska | b17c41f | 2015-05-19 11:16:05 -0700 | [diff] [blame] | 1042 | private class InternalStoreDelegate implements DeviceStoreDelegate { |
tom | f80c972 | 2014-09-24 14:49:18 -0700 | [diff] [blame] | 1043 | @Override |
| 1044 | public void notify(DeviceEvent event) { |
| 1045 | post(event); |
Rafał Szalecki | 9fb87f6 | 2017-12-06 15:06:09 +0100 | [diff] [blame] | 1046 | if (event.type().equals(DeviceEvent.Type.DEVICE_REMOVED)) { |
Thomas Vachuska | 5b38dc0 | 2018-05-10 15:24:40 -0700 | [diff] [blame] | 1047 | // When device is administratively removed, force disconnect. |
| 1048 | DeviceId deviceId = event.subject().id(); |
| 1049 | deviceLocalStatus.remove(deviceId); |
| 1050 | |
| 1051 | DeviceProvider provider = getProvider(deviceId); |
| 1052 | if (provider != null) { |
| 1053 | log.info("Triggering disconnect for device {}", deviceId); |
| 1054 | try { |
| 1055 | provider.triggerDisconnect(deviceId); |
| 1056 | } catch (UnsupportedOperationException e) { |
| 1057 | log.warn("Unable to trigger disconnect due to {}", e.getMessage()); |
| 1058 | } |
| 1059 | } |
Rafał Szalecki | 9fb87f6 | 2017-12-06 15:06:09 +0100 | [diff] [blame] | 1060 | } |
tom | f80c972 | 2014-09-24 14:49:18 -0700 | [diff] [blame] | 1061 | } |
| 1062 | } |
samuel | 738dfaf | 2015-07-11 11:08:57 +0800 | [diff] [blame] | 1063 | |
| 1064 | @Override |
| 1065 | public Iterable<Device> getDevices(Type type) { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 1066 | checkPermission(DEVICE_READ); |
samuel | 738dfaf | 2015-07-11 11:08:57 +0800 | [diff] [blame] | 1067 | Set<Device> results = new HashSet<>(); |
| 1068 | Iterable<Device> devices = store.getDevices(); |
| 1069 | if (devices != null) { |
| 1070 | devices.forEach(d -> { |
| 1071 | if (type.equals(d.type())) { |
| 1072 | results.add(d); |
| 1073 | } |
| 1074 | }); |
| 1075 | } |
| 1076 | return results; |
| 1077 | } |
| 1078 | |
| 1079 | @Override |
| 1080 | public Iterable<Device> getAvailableDevices(Type type) { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 1081 | checkPermission(DEVICE_READ); |
samuel | 738dfaf | 2015-07-11 11:08:57 +0800 | [diff] [blame] | 1082 | Set<Device> results = new HashSet<>(); |
| 1083 | Iterable<Device> availableDevices = store.getAvailableDevices(); |
| 1084 | if (availableDevices != null) { |
| 1085 | availableDevices.forEach(d -> { |
| 1086 | if (type.equals(d.type())) { |
| 1087 | results.add(d); |
| 1088 | } |
| 1089 | }); |
| 1090 | } |
| 1091 | return results; |
| 1092 | } |
Sahil Lele | 3a0cdd5 | 2015-07-21 14:16:31 -0700 | [diff] [blame] | 1093 | |
| 1094 | private class InternalNetworkConfigListener implements NetworkConfigListener { |
Ray Milkey | 69ca82a | 2019-03-28 09:24:40 -0700 | [diff] [blame] | 1095 | private DeviceId extractDeviceId(NetworkConfigEvent event) { |
| 1096 | DeviceId deviceId = null; |
debmaiti | 9553ed7 | 2019-03-18 14:27:42 +0530 | [diff] [blame] | 1097 | if (event.configClass().equals(PortAnnotationConfig.class)) { |
Ray Milkey | 397caca | 2019-04-01 16:27:50 -0700 | [diff] [blame] | 1098 | if (event.subject().getClass() == ConnectPoint.class) { |
| 1099 | deviceId = ((ConnectPoint) event.subject()).deviceId(); |
| 1100 | } |
Ray Milkey | 69ca82a | 2019-03-28 09:24:40 -0700 | [diff] [blame] | 1101 | } else if (event.subject().getClass() == DeviceId.class) { |
debmaiti | 9553ed7 | 2019-03-18 14:27:42 +0530 | [diff] [blame] | 1102 | deviceId = (DeviceId) event.subject(); |
| 1103 | } |
Ray Milkey | 69ca82a | 2019-03-28 09:24:40 -0700 | [diff] [blame] | 1104 | return deviceId; |
| 1105 | } |
| 1106 | |
| 1107 | @Override |
| 1108 | public boolean isRelevant(NetworkConfigEvent event) { |
| 1109 | DeviceId deviceId = extractDeviceId(event); |
| 1110 | |
Ayaka Koshibe | d0ab3c0 | 2015-09-04 15:43:46 -0700 | [diff] [blame] | 1111 | return (event.type() == NetworkConfigEvent.Type.CONFIG_ADDED |
debmaiti | 9553ed7 | 2019-03-18 14:27:42 +0530 | [diff] [blame] | 1112 | || event.type() == NetworkConfigEvent.Type.CONFIG_UPDATED |
| 1113 | || event.type() == NetworkConfigEvent.Type.CONFIG_REMOVED) |
Ayaka Koshibe | d0ab3c0 | 2015-09-04 15:43:46 -0700 | [diff] [blame] | 1114 | && (event.configClass().equals(BasicDeviceConfig.class) |
Andrea Campanella | 75ef9f5 | 2017-07-27 20:14:32 +0200 | [diff] [blame] | 1115 | || portOpsIndex.containsKey(event.configClass()) |
Palash Kala | a06a616 | 2017-11-15 20:42:40 +0900 | [diff] [blame] | 1116 | || event.configClass().equals(PortDescriptionsConfig.class) |
Thomas Vachuska | f131e59 | 2018-05-07 11:52:14 -0700 | [diff] [blame] | 1117 | || event.configClass().equals(DeviceAnnotationConfig.class)) |
Ray Milkey | 69ca82a | 2019-03-28 09:24:40 -0700 | [diff] [blame] | 1118 | && deviceId != null && mastershipService.isLocalMaster(deviceId); |
Thomas Vachuska | 42e8cce | 2015-07-29 19:25:18 -0700 | [diff] [blame] | 1119 | } |
| 1120 | |
| 1121 | @Override |
Sahil Lele | 3a0cdd5 | 2015-07-21 14:16:31 -0700 | [diff] [blame] | 1122 | public void event(NetworkConfigEvent event) { |
Ayaka Koshibe | d0ab3c0 | 2015-09-04 15:43:46 -0700 | [diff] [blame] | 1123 | DeviceEvent de = null; |
| 1124 | if (event.configClass().equals(BasicDeviceConfig.class)) { |
Thomas Vachuska | 138de8b | 2016-01-11 21:31:38 -0800 | [diff] [blame] | 1125 | log.debug("Detected device network config event {}", event.type()); |
Yuta HIGUCHI | 1d4b3aa | 2017-08-09 15:10:18 -0700 | [diff] [blame] | 1126 | DeviceId did = (DeviceId) event.subject(); |
| 1127 | DeviceProvider dp = getProvider(did); |
Simon Hunt | ffbad3b | 2017-05-16 15:37:51 -0700 | [diff] [blame] | 1128 | BasicDeviceConfig cfg = |
| 1129 | networkConfigService.getConfig(did, BasicDeviceConfig.class); |
Sahil Lele | 3a0cdd5 | 2015-07-21 14:16:31 -0700 | [diff] [blame] | 1130 | |
Ayaka Koshibe | d0ab3c0 | 2015-09-04 15:43:46 -0700 | [diff] [blame] | 1131 | if (!isAllowed(cfg)) { |
| 1132 | kickOutBadDevice(did); |
| 1133 | } else { |
| 1134 | Device dev = getDevice(did); |
Simon Hunt | ffbad3b | 2017-05-16 15:37:51 -0700 | [diff] [blame] | 1135 | DeviceDescription desc = |
| 1136 | (dev == null) ? null : BasicDeviceOperator.descriptionOf(dev); |
Ayaka Koshibe | d0ab3c0 | 2015-09-04 15:43:46 -0700 | [diff] [blame] | 1137 | desc = BasicDeviceOperator.combine(cfg, desc); |
Simon Hunt | ffbad3b | 2017-05-16 15:37:51 -0700 | [diff] [blame] | 1138 | if (desc != null && dp != null) { |
pier | 388ec25 | 2020-04-15 20:53:14 +0200 | [diff] [blame] | 1139 | store.createOrUpdateDevice(dp.id(), did, desc); |
Ayaka Koshibe | d0ab3c0 | 2015-09-04 15:43:46 -0700 | [diff] [blame] | 1140 | } |
| 1141 | } |
Yuta HIGUCHI | 1d4b3aa | 2017-08-09 15:10:18 -0700 | [diff] [blame] | 1142 | } else if (event.configClass().equals(PortDescriptionsConfig.class)) { |
| 1143 | DeviceId did = (DeviceId) event.subject(); |
| 1144 | DeviceProvider dp = getProvider(did); |
| 1145 | if (!event.config().isPresent() || |
| 1146 | getDevice(did) == null || dp == null) { |
| 1147 | // sanity check failed, ignore |
| 1148 | return; |
| 1149 | } |
Andrea Campanella | 75ef9f5 | 2017-07-27 20:14:32 +0200 | [diff] [blame] | 1150 | PortDescriptionsConfig portConfig = (PortDescriptionsConfig) event.config().get(); |
Yuta HIGUCHI | 1d4b3aa | 2017-08-09 15:10:18 -0700 | [diff] [blame] | 1151 | //updating the ports if configuration exists |
Andrea Campanella | 75ef9f5 | 2017-07-27 20:14:32 +0200 | [diff] [blame] | 1152 | List<PortDescription> complete = store.getPortDescriptions(dp.id(), did) |
| 1153 | .collect(Collectors.toList()); |
| 1154 | complete.addAll(portConfig.portDescriptions()); |
| 1155 | store.updatePorts(dp.id(), did, complete); |
Palash Kala | a06a616 | 2017-11-15 20:42:40 +0900 | [diff] [blame] | 1156 | } else if (event.configClass().equals(DeviceAnnotationConfig.class)) { |
| 1157 | DeviceId did = (DeviceId) event.subject(); |
| 1158 | DeviceProvider dp = getProvider(did); |
| 1159 | Device dev = getDevice(did); |
| 1160 | DeviceDescription desc = |
| 1161 | (dev == null) ? null : BasicDeviceOperator.descriptionOf(dev); |
| 1162 | Optional<Config> prevConfig = event.prevConfig(); |
Anurag Chadha | 6194639 | 2020-08-28 15:18:03 +0530 | [diff] [blame] | 1163 | if (desc != null) { // Fix for NPE due to desc being null |
| 1164 | desc = deviceAnnotationOp.combine(did, desc, prevConfig); |
| 1165 | } |
Palash Kala | a06a616 | 2017-11-15 20:42:40 +0900 | [diff] [blame] | 1166 | if (desc != null && dp != null) { |
pier | 388ec25 | 2020-04-15 20:53:14 +0200 | [diff] [blame] | 1167 | store.createOrUpdateDevice(dp.id(), did, desc); |
Palash Kala | a06a616 | 2017-11-15 20:42:40 +0900 | [diff] [blame] | 1168 | } |
Yuta HIGUCHI | 1d4b3aa | 2017-08-09 15:10:18 -0700 | [diff] [blame] | 1169 | } else if (portOpsIndex.containsKey(event.configClass())) { |
Ayaka Koshibe | d0ab3c0 | 2015-09-04 15:43:46 -0700 | [diff] [blame] | 1170 | ConnectPoint cpt = (ConnectPoint) event.subject(); |
Yuta HIGUCHI | 1d4b3aa | 2017-08-09 15:10:18 -0700 | [diff] [blame] | 1171 | DeviceId did = cpt.deviceId(); |
| 1172 | DeviceProvider dp = getProvider(did); |
Ayaka Koshibe | d0ab3c0 | 2015-09-04 15:43:46 -0700 | [diff] [blame] | 1173 | |
Yuta HIGUCHI | b9af6b7 | 2016-06-10 10:52:58 -0700 | [diff] [blame] | 1174 | // Note: assuming PortOperator can modify existing port, |
| 1175 | // but cannot add new port purely from Config. |
Simon Hunt | ffbad3b | 2017-05-16 15:37:51 -0700 | [diff] [blame] | 1176 | de = Optional.ofNullable(dp) |
Yuta HIGUCHI | b9af6b7 | 2016-06-10 10:52:58 -0700 | [diff] [blame] | 1177 | .map(provider -> store.getPortDescription(provider.id(), did, cpt.port())) |
debmaiti | 9553ed7 | 2019-03-18 14:27:42 +0530 | [diff] [blame] | 1178 | .map(desc -> applyAllPortOps(cpt, desc, event.prevConfig())) |
Simon Hunt | ffbad3b | 2017-05-16 15:37:51 -0700 | [diff] [blame] | 1179 | .map(desc -> store.updatePortStatus(dp.id(), did, desc)) |
Yuta HIGUCHI | b9af6b7 | 2016-06-10 10:52:58 -0700 | [diff] [blame] | 1180 | .orElse(null); |
Ayaka Koshibe | d0ab3c0 | 2015-09-04 15:43:46 -0700 | [diff] [blame] | 1181 | } |
| 1182 | |
| 1183 | if (de != null) { |
| 1184 | post(de); |
| 1185 | } |
| 1186 | } |
| 1187 | |
Simon Hunt | 8f60ff8 | 2017-04-24 17:19:30 -0700 | [diff] [blame] | 1188 | // removes the specified device if it exists |
Ayaka Koshibe | d0ab3c0 | 2015-09-04 15:43:46 -0700 | [diff] [blame] | 1189 | private void kickOutBadDevice(DeviceId deviceId) { |
Sahil Lele | 3a0cdd5 | 2015-07-21 14:16:31 -0700 | [diff] [blame] | 1190 | Device badDevice = getDevice(deviceId); |
| 1191 | if (badDevice != null) { |
| 1192 | removeDevice(deviceId); |
Sahil Lele | 3a0cdd5 | 2015-07-21 14:16:31 -0700 | [diff] [blame] | 1193 | } |
| 1194 | } |
| 1195 | } |
Saurav Das | a2d3750 | 2016-03-25 17:50:40 -0700 | [diff] [blame] | 1196 | |
Yuta HIGUCHI | b9af6b7 | 2016-06-10 10:52:58 -0700 | [diff] [blame] | 1197 | @Override |
| 1198 | @SafeVarargs |
| 1199 | public final void registerPortConfigOperator(PortConfigOperator portOp, |
Simon Hunt | ffbad3b | 2017-05-16 15:37:51 -0700 | [diff] [blame] | 1200 | Class<? extends Config<ConnectPoint>>... configs) { |
Yuta HIGUCHI | b9af6b7 | 2016-06-10 10:52:58 -0700 | [diff] [blame] | 1201 | checkNotNull(portOp); |
| 1202 | |
| 1203 | portOp.bindService(networkConfigService); |
| 1204 | |
| 1205 | // update both portOpsIndex and portOps |
| 1206 | synchronized (portOpsIndex) { |
| 1207 | for (Class<? extends Config<ConnectPoint>> config : configs) { |
| 1208 | portOpsIndex.put(config, portOp); |
| 1209 | } |
| 1210 | |
| 1211 | portOps.add(portOp); |
| 1212 | } |
| 1213 | |
| 1214 | // TODO: Should we be applying to all existing Ports? |
| 1215 | Tools.stream(store.getAvailableDevices()) |
Simon Hunt | ffbad3b | 2017-05-16 15:37:51 -0700 | [diff] [blame] | 1216 | .map(Device::id) |
| 1217 | .filter(mastershipService::isLocalMaster) |
| 1218 | // for each locally managed Device, update all port descriptions |
| 1219 | .map(did -> { |
| 1220 | ProviderId pid = Optional.ofNullable(getProvider(did)) |
| 1221 | .map(Provider::id) |
| 1222 | .orElse(null); |
| 1223 | if (pid == null) { |
| 1224 | log.warn("Provider not found for {}", did); |
| 1225 | return ImmutableList.<DeviceEvent>of(); |
| 1226 | } |
| 1227 | List<PortDescription> pds |
| 1228 | = store.getPortDescriptions(pid, did) |
| 1229 | .map(pdesc -> applyAllPortOps(did, pdesc)) |
| 1230 | .collect(Collectors.toList()); |
| 1231 | return store.updatePorts(pid, did, pds); |
Yuta HIGUCHI | b9af6b7 | 2016-06-10 10:52:58 -0700 | [diff] [blame] | 1232 | }) |
Simon Hunt | ffbad3b | 2017-05-16 15:37:51 -0700 | [diff] [blame] | 1233 | // ..and port port update event if necessary |
| 1234 | .forEach(evts -> evts.forEach(this::post)); |
Yuta HIGUCHI | b9af6b7 | 2016-06-10 10:52:58 -0700 | [diff] [blame] | 1235 | } |
| 1236 | |
| 1237 | @Override |
| 1238 | public void unregisterPortConfigOperator(PortConfigOperator portOp) { |
| 1239 | checkNotNull(portOp); |
| 1240 | |
| 1241 | |
| 1242 | // remove all portOp |
| 1243 | synchronized (portOpsIndex) { |
| 1244 | portOps.remove(portOp); |
| 1245 | |
| 1246 | // had to do this since COWArrayList iterator doesn't support remove |
| 1247 | portOpsIndex.keySet().forEach(key -> portOpsIndex.remove(key, portOp)); |
| 1248 | } |
| 1249 | |
| 1250 | } |
| 1251 | |
| 1252 | /** |
| 1253 | * Merges the appropriate PortConfig with the description. |
| 1254 | * |
| 1255 | * @param did ID of the Device where the port is attached |
| 1256 | * @param desc {@link PortDescription} |
| 1257 | * @return merged {@link PortDescription} |
| 1258 | */ |
| 1259 | private PortDescription applyAllPortOps(DeviceId did, PortDescription desc) { |
| 1260 | return applyAllPortOps(new ConnectPoint(did, desc.portNumber()), desc); |
| 1261 | } |
| 1262 | |
| 1263 | /** |
| 1264 | * Merges the appropriate PortConfig with the description. |
| 1265 | * |
Simon Hunt | ffbad3b | 2017-05-16 15:37:51 -0700 | [diff] [blame] | 1266 | * @param cpt ConnectPoint where the port is attached |
| 1267 | * @param desc {@link PortDescription} |
Yuta HIGUCHI | b9af6b7 | 2016-06-10 10:52:58 -0700 | [diff] [blame] | 1268 | * @return merged {@link PortDescription} |
| 1269 | */ |
| 1270 | private PortDescription applyAllPortOps(ConnectPoint cpt, PortDescription desc) { |
| 1271 | PortDescription work = desc; |
| 1272 | for (PortConfigOperator portOp : portOps) { |
| 1273 | work = portOp.combine(cpt, work); |
| 1274 | } |
Yuta HIGUCHI | 7438f5a | 2017-02-15 22:09:46 -0800 | [diff] [blame] | 1275 | return portAnnotationOp.combine(cpt, work); |
Yuta HIGUCHI | b9af6b7 | 2016-06-10 10:52:58 -0700 | [diff] [blame] | 1276 | } |
| 1277 | |
Jonghwan Hyun | 6ecf56d | 2017-08-01 16:07:44 -0700 | [diff] [blame] | 1278 | /** |
debmaiti | 9553ed7 | 2019-03-18 14:27:42 +0530 | [diff] [blame] | 1279 | * Merges the appropriate PortConfig with the description. |
| 1280 | * |
| 1281 | * @param cpt ConnectPoint where the port is attached |
| 1282 | * @param desc {@link PortDescription} |
| 1283 | * @param prevConfig previous configuration |
| 1284 | * @return merged {@link PortDescription} |
| 1285 | */ |
| 1286 | private PortDescription applyAllPortOps(ConnectPoint cpt, PortDescription desc, |
| 1287 | Optional<Config> prevConfig) { |
| 1288 | PortDescription work = desc; |
| 1289 | for (PortConfigOperator portOp : portOps) { |
| 1290 | work = portOp.combine(cpt, work, prevConfig); |
| 1291 | } |
| 1292 | return portAnnotationOp.combine(cpt, work, prevConfig); |
| 1293 | } |
| 1294 | |
| 1295 | /** |
Jonghwan Hyun | 6ecf56d | 2017-08-01 16:07:44 -0700 | [diff] [blame] | 1296 | * Port Enable/Disable message sent to the device's MASTER node. |
| 1297 | */ |
| 1298 | private class InternalPortUpDownEvent { |
| 1299 | private final DeviceId deviceId; |
| 1300 | private final PortNumber portNumber; |
| 1301 | private final boolean enable; |
| 1302 | |
| 1303 | protected InternalPortUpDownEvent( |
| 1304 | DeviceId deviceId, PortNumber portNumber, boolean enable) { |
| 1305 | this.deviceId = deviceId; |
| 1306 | this.portNumber = portNumber; |
| 1307 | this.enable = enable; |
| 1308 | } |
| 1309 | |
| 1310 | public DeviceId deviceId() { |
| 1311 | return deviceId; |
| 1312 | } |
| 1313 | public PortNumber portNumber() { |
| 1314 | return portNumber; |
| 1315 | } |
| 1316 | public boolean isEnable() { |
| 1317 | return enable; |
| 1318 | } |
| 1319 | |
| 1320 | protected InternalPortUpDownEvent() { |
| 1321 | this.deviceId = null; |
| 1322 | this.portNumber = null; |
| 1323 | this.enable = false; |
| 1324 | } |
| 1325 | } |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 1326 | } |