alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2015-present Open Networking Foundation |
alshabib | 77b8848 | 2015-04-07 15:47:50 -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 | */ |
| 16 | package org.onosproject.net.flowobjective.impl; |
| 17 | |
Pier Luigi | 9789311 | 2018-03-05 11:09:42 +0100 | [diff] [blame] | 18 | import com.google.common.collect.ImmutableSet; |
Saurav Das | f14d9ef | 2017-12-05 15:00:23 -0800 | [diff] [blame] | 19 | import com.google.common.collect.Lists; |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 20 | import com.google.common.collect.Maps; |
Thomas Vachuska | d27097c | 2016-06-14 19:10:41 -0700 | [diff] [blame] | 21 | import com.google.common.collect.Sets; |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 22 | import org.onlab.osgi.DefaultServiceDirectory; |
| 23 | import org.onlab.osgi.ServiceDirectory; |
Thomas Vachuska | ca88bb7 | 2015-04-08 19:38:02 -0700 | [diff] [blame] | 24 | import org.onlab.util.ItemNotFoundException; |
Yi Tseng | 374c5f3 | 2017-03-05 22:51:35 -0800 | [diff] [blame] | 25 | import org.onlab.util.Tools; |
| 26 | import org.onosproject.cfg.ComponentConfigService; |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 27 | import org.onosproject.cluster.ClusterService; |
Thomas Vachuska | cfeff19 | 2017-08-23 15:29:34 -0700 | [diff] [blame] | 28 | import org.onosproject.net.Device; |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 29 | import org.onosproject.net.DeviceId; |
Saurav Das | 2443119 | 2016-03-07 19:13:00 -0800 | [diff] [blame] | 30 | import org.onosproject.net.behaviour.NextGroup; |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 31 | import org.onosproject.net.behaviour.Pipeliner; |
Thomas Vachuska | ca88bb7 | 2015-04-08 19:38:02 -0700 | [diff] [blame] | 32 | import org.onosproject.net.behaviour.PipelinerContext; |
alshabib | aebe775 | 2015-04-07 17:45:42 -0700 | [diff] [blame] | 33 | import org.onosproject.net.device.DeviceEvent; |
| 34 | import org.onosproject.net.device.DeviceListener; |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 35 | import org.onosproject.net.device.DeviceService; |
Thomas Vachuska | cfeff19 | 2017-08-23 15:29:34 -0700 | [diff] [blame] | 36 | import org.onosproject.net.driver.DriverEvent; |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 37 | import org.onosproject.net.driver.DriverHandler; |
Thomas Vachuska | cfeff19 | 2017-08-23 15:29:34 -0700 | [diff] [blame] | 38 | import org.onosproject.net.driver.DriverListener; |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 39 | import org.onosproject.net.driver.DriverService; |
Thomas Vachuska | ca88bb7 | 2015-04-08 19:38:02 -0700 | [diff] [blame] | 40 | import org.onosproject.net.flow.FlowRuleService; |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 41 | import org.onosproject.net.flowobjective.FilteringObjective; |
| 42 | import org.onosproject.net.flowobjective.FlowObjectiveService; |
alshabib | 2a441c6 | 2015-04-13 18:39:38 -0700 | [diff] [blame] | 43 | import org.onosproject.net.flowobjective.FlowObjectiveStore; |
| 44 | import org.onosproject.net.flowobjective.FlowObjectiveStoreDelegate; |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 45 | import org.onosproject.net.flowobjective.ForwardingObjective; |
| 46 | import org.onosproject.net.flowobjective.NextObjective; |
alshabib | 910aff1 | 2015-04-09 16:55:57 -0700 | [diff] [blame] | 47 | import org.onosproject.net.flowobjective.Objective; |
Saurav Das | 1547b3f | 2017-05-05 17:01:08 -0700 | [diff] [blame] | 48 | import org.onosproject.net.flowobjective.Objective.Operation; |
Jonathan Hart | 17d0045 | 2015-04-21 17:10:00 -0700 | [diff] [blame] | 49 | import org.onosproject.net.flowobjective.ObjectiveError; |
alshabib | 2a441c6 | 2015-04-13 18:39:38 -0700 | [diff] [blame] | 50 | import org.onosproject.net.flowobjective.ObjectiveEvent; |
Saurav Das | 423fe2b | 2015-12-04 10:52:59 -0800 | [diff] [blame] | 51 | import org.onosproject.net.flowobjective.ObjectiveEvent.Type; |
Thomas Vachuska | ca88bb7 | 2015-04-08 19:38:02 -0700 | [diff] [blame] | 52 | import org.onosproject.net.group.GroupService; |
Yi Tseng | 374c5f3 | 2017-03-05 22:51:35 -0800 | [diff] [blame] | 53 | import org.osgi.service.component.ComponentContext; |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 54 | import org.osgi.service.component.annotations.Activate; |
| 55 | import org.osgi.service.component.annotations.Component; |
| 56 | import org.osgi.service.component.annotations.Deactivate; |
| 57 | import org.osgi.service.component.annotations.Modified; |
| 58 | import org.osgi.service.component.annotations.Reference; |
| 59 | import org.osgi.service.component.annotations.ReferenceCardinality; |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 60 | import org.slf4j.Logger; |
| 61 | import org.slf4j.LoggerFactory; |
| 62 | |
Saurav Das | 2443119 | 2016-03-07 19:13:00 -0800 | [diff] [blame] | 63 | import java.util.ArrayList; |
Saurav Das | 2443119 | 2016-03-07 19:13:00 -0800 | [diff] [blame] | 64 | import java.util.List; |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 65 | import java.util.Map; |
Saurav Das | 8a0732e | 2015-11-20 15:27:53 -0800 | [diff] [blame] | 66 | import java.util.Objects; |
alshabib | 2a441c6 | 2015-04-13 18:39:38 -0700 | [diff] [blame] | 67 | import java.util.Set; |
Jonathan Hart | 17d0045 | 2015-04-21 17:10:00 -0700 | [diff] [blame] | 68 | import java.util.concurrent.ExecutorService; |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 69 | |
Sho SHIMIZU | f45d85d | 2015-07-01 14:39:11 -0700 | [diff] [blame] | 70 | import static com.google.common.base.Preconditions.checkNotNull; |
Yi Tseng | 374c5f3 | 2017-03-05 22:51:35 -0800 | [diff] [blame] | 71 | import static com.google.common.base.Strings.isNullOrEmpty; |
Thomas Vachuska | 866b46a | 2015-04-30 00:26:55 -0700 | [diff] [blame] | 72 | import static java.util.concurrent.Executors.newFixedThreadPool; |
Ruchi Sahota | e4934e1 | 2019-03-01 16:56:07 +0000 | [diff] [blame] | 73 | import static java.util.concurrent.Executors.newSingleThreadScheduledExecutor; |
Jonathan Hart | 17d0045 | 2015-04-21 17:10:00 -0700 | [diff] [blame] | 74 | import static org.onlab.util.Tools.groupedThreads; |
Thomas Vachuska | cfeff19 | 2017-08-23 15:29:34 -0700 | [diff] [blame] | 75 | import static org.onosproject.net.AnnotationKeys.DRIVER; |
Ray Milkey | d04e227 | 2018-10-16 18:20:18 -0700 | [diff] [blame] | 76 | import static org.onosproject.net.OsgiPropertyConstants.FOM_NUM_THREADS; |
| 77 | import static org.onosproject.net.OsgiPropertyConstants.FOM_NUM_THREADS_DEFAULT; |
pier | 8b3aef4 | 2019-03-11 15:14:02 -0700 | [diff] [blame^] | 78 | import static org.onosproject.net.OsgiPropertyConstants.FOM_ACCUMULATOR_MAX_OBJECTIVES; |
| 79 | import static org.onosproject.net.OsgiPropertyConstants.FOM_ACCUMULATOR_MAX_OBJECTIVES_DEFAULT; |
| 80 | import static org.onosproject.net.OsgiPropertyConstants.FOM_ACCUMULATOR_MAX_IDLE_MILLIS; |
| 81 | import static org.onosproject.net.OsgiPropertyConstants.FOM_ACCUMULATOR_MAX_IDLE_MILLIS_DEFAULT; |
| 82 | import static org.onosproject.net.OsgiPropertyConstants.FOM_ACCUMULATOR_MAX_BATCH_MILLIS; |
| 83 | import static org.onosproject.net.OsgiPropertyConstants.FOM_ACCUMULATOR_MAX_BATCH_MILLIS_DEFAULT; |
Changhoon Yoon | 541ef71 | 2015-05-23 17:18:34 +0900 | [diff] [blame] | 84 | import static org.onosproject.security.AppGuard.checkPermission; |
Thomas Vachuska | d27097c | 2016-06-14 19:10:41 -0700 | [diff] [blame] | 85 | import static org.onosproject.security.AppPermission.Type.FLOWRULE_WRITE; |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 86 | |
| 87 | /** |
Thomas Vachuska | ca88bb7 | 2015-04-08 19:38:02 -0700 | [diff] [blame] | 88 | * Provides implementation of the flow objective programming service. |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 89 | */ |
Ray Milkey | d04e227 | 2018-10-16 18:20:18 -0700 | [diff] [blame] | 90 | @Component( |
| 91 | enabled = false, |
| 92 | service = FlowObjectiveService.class, |
| 93 | property = { |
pier | 8b3aef4 | 2019-03-11 15:14:02 -0700 | [diff] [blame^] | 94 | FOM_NUM_THREADS + ":Integer=" + FOM_NUM_THREADS_DEFAULT, |
| 95 | FOM_ACCUMULATOR_MAX_OBJECTIVES + ":Integer=" + FOM_ACCUMULATOR_MAX_OBJECTIVES_DEFAULT, |
| 96 | FOM_ACCUMULATOR_MAX_IDLE_MILLIS + ":Integer=" + FOM_ACCUMULATOR_MAX_IDLE_MILLIS_DEFAULT, |
| 97 | FOM_ACCUMULATOR_MAX_BATCH_MILLIS + ":Integer=" + FOM_ACCUMULATOR_MAX_BATCH_MILLIS_DEFAULT, |
Ray Milkey | d04e227 | 2018-10-16 18:20:18 -0700 | [diff] [blame] | 98 | } |
| 99 | ) |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 100 | public class FlowObjectiveManager implements FlowObjectiveService { |
| 101 | |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 102 | private static final int INSTALL_RETRY_ATTEMPTS = 5; |
| 103 | private static final long INSTALL_RETRY_INTERVAL = 1000; // ms |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 104 | |
Yi Tseng | 374c5f3 | 2017-03-05 22:51:35 -0800 | [diff] [blame] | 105 | private static final String WORKER_PATTERN = "objective-installer-%d"; |
| 106 | private static final String GROUP_THREAD_NAME = "onos/objective-installer"; |
Yi Tseng | 374c5f3 | 2017-03-05 22:51:35 -0800 | [diff] [blame] | 107 | |
Jonathan Hart | 17d0045 | 2015-04-21 17:10:00 -0700 | [diff] [blame] | 108 | private final Logger log = LoggerFactory.getLogger(getClass()); |
Thomas Vachuska | ca88bb7 | 2015-04-08 19:38:02 -0700 | [diff] [blame] | 109 | |
Thomas Vachuska | f566fa2 | 2018-10-30 14:03:36 -0700 | [diff] [blame] | 110 | /** Number of worker threads. */ |
Ray Milkey | d04e227 | 2018-10-16 18:20:18 -0700 | [diff] [blame] | 111 | private int numThreads = FOM_NUM_THREADS_DEFAULT; |
Yi Tseng | 374c5f3 | 2017-03-05 22:51:35 -0800 | [diff] [blame] | 112 | |
pier | 8b3aef4 | 2019-03-11 15:14:02 -0700 | [diff] [blame^] | 113 | // Parameters for the accumulator, each pipeline can implement |
| 114 | // its own accumulation logic. The following parameters are used |
| 115 | // to control the accumulator. |
| 116 | |
| 117 | // Maximum number of objectives to accumulate before processing is triggered |
| 118 | private int accumulatorMaxObjectives = FOM_ACCUMULATOR_MAX_OBJECTIVES_DEFAULT; |
| 119 | // Maximum number of millis between objectives before processing is triggered |
| 120 | private int accumulatorMaxIdleMillis = FOM_ACCUMULATOR_MAX_IDLE_MILLIS_DEFAULT; |
| 121 | // Maximum number of millis allowed since the first objective before processing is triggered |
| 122 | private int accumulatorMaxBatchMillis = FOM_ACCUMULATOR_MAX_BATCH_MILLIS_DEFAULT; |
| 123 | |
| 124 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 125 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 126 | protected DriverService driverService; |
| 127 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 128 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 129 | protected DeviceService deviceService; |
| 130 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 131 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 132 | protected ClusterService clusterService; |
| 133 | |
Thomas Vachuska | ca88bb7 | 2015-04-08 19:38:02 -0700 | [diff] [blame] | 134 | // Note: The following dependencies are added on behalf of the pipeline |
| 135 | // driver behaviours to assure these services are available for their |
| 136 | // initialization. |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 137 | @SuppressWarnings("unused") |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 138 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
Thomas Vachuska | ca88bb7 | 2015-04-08 19:38:02 -0700 | [diff] [blame] | 139 | protected FlowRuleService flowRuleService; |
| 140 | |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 141 | @SuppressWarnings("unused") |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 142 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
Thomas Vachuska | ca88bb7 | 2015-04-08 19:38:02 -0700 | [diff] [blame] | 143 | protected GroupService groupService; |
| 144 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 145 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
alshabib | 2a441c6 | 2015-04-13 18:39:38 -0700 | [diff] [blame] | 146 | protected FlowObjectiveStore flowObjectiveStore; |
| 147 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 148 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
Yi Tseng | 374c5f3 | 2017-03-05 22:51:35 -0800 | [diff] [blame] | 149 | protected ComponentConfigService cfgService; |
| 150 | |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 151 | final FlowObjectiveStoreDelegate delegate = new InternalStoreDelegate(); |
Thomas Vachuska | ca88bb7 | 2015-04-08 19:38:02 -0700 | [diff] [blame] | 152 | |
| 153 | private final Map<DeviceId, DriverHandler> driverHandlers = Maps.newConcurrentMap(); |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 154 | protected final Map<DeviceId, Pipeliner> pipeliners = Maps.newConcurrentMap(); |
Thomas Vachuska | ca88bb7 | 2015-04-08 19:38:02 -0700 | [diff] [blame] | 155 | |
| 156 | private final PipelinerContext context = new InnerPipelineContext(); |
Thomas Vachuska | ca88bb7 | 2015-04-08 19:38:02 -0700 | [diff] [blame] | 157 | private final DeviceListener deviceListener = new InnerDeviceListener(); |
Thomas Vachuska | cfeff19 | 2017-08-23 15:29:34 -0700 | [diff] [blame] | 158 | private final DriverListener driverListener = new InnerDriverListener(); |
Thomas Vachuska | ca88bb7 | 2015-04-08 19:38:02 -0700 | [diff] [blame] | 159 | |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 160 | private ServiceDirectory serviceDirectory = new DefaultServiceDirectory(); |
alshabib | 910aff1 | 2015-04-09 16:55:57 -0700 | [diff] [blame] | 161 | |
Saurav Das | 1547b3f | 2017-05-05 17:01:08 -0700 | [diff] [blame] | 162 | // local stores for queuing fwd and next objectives that are waiting for an |
| 163 | // associated next objective execution to complete. The signal for completed |
| 164 | // execution comes from a pipeline driver, in this or another controller |
| 165 | // instance, via the DistributedFlowObjectiveStore. |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 166 | // TODO Making these cache and timeout the entries |
| 167 | final Map<Integer, Set<PendingFlowObjective>> pendingForwards = Maps.newConcurrentMap(); |
| 168 | final Map<Integer, List<PendingFlowObjective>> pendingNexts = Maps.newConcurrentMap(); |
alshabib | 2a441c6 | 2015-04-13 18:39:38 -0700 | [diff] [blame] | 169 | |
Saurav Das | 2443119 | 2016-03-07 19:13:00 -0800 | [diff] [blame] | 170 | // local store to track which nextObjectives were sent to which device |
| 171 | // for debugging purposes |
| 172 | private Map<Integer, DeviceId> nextToDevice = Maps.newConcurrentMap(); |
| 173 | |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 174 | ExecutorService executorService; |
Ruchi Sahota | e4934e1 | 2019-03-01 16:56:07 +0000 | [diff] [blame] | 175 | protected ExecutorService devEventExecutor; |
alshabib | 2a441c6 | 2015-04-13 18:39:38 -0700 | [diff] [blame] | 176 | |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 177 | @Activate |
pier | 8b3aef4 | 2019-03-11 15:14:02 -0700 | [diff] [blame^] | 178 | protected void activate(ComponentContext context) { |
Ray Milkey | 1f0764a | 2019-03-01 08:40:37 -0800 | [diff] [blame] | 179 | cfgService.registerProperties(FlowObjectiveManager.class); |
Yi Tseng | 374c5f3 | 2017-03-05 22:51:35 -0800 | [diff] [blame] | 180 | executorService = newFixedThreadPool(numThreads, |
| 181 | groupedThreads(GROUP_THREAD_NAME, WORKER_PATTERN, log)); |
pier | 8b3aef4 | 2019-03-11 15:14:02 -0700 | [diff] [blame^] | 182 | modified(context); |
Ruchi Sahota | e4934e1 | 2019-03-01 16:56:07 +0000 | [diff] [blame] | 183 | devEventExecutor = newSingleThreadScheduledExecutor( |
| 184 | groupedThreads("onos/flowobj-dev-events", "events-%d", log)); |
alshabib | 2a441c6 | 2015-04-13 18:39:38 -0700 | [diff] [blame] | 185 | flowObjectiveStore.setDelegate(delegate); |
alshabib | aebe775 | 2015-04-07 17:45:42 -0700 | [diff] [blame] | 186 | deviceService.addListener(deviceListener); |
Thomas Vachuska | cfeff19 | 2017-08-23 15:29:34 -0700 | [diff] [blame] | 187 | driverService.addListener(driverListener); |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 188 | log.info("Started"); |
| 189 | } |
| 190 | |
| 191 | @Deactivate |
| 192 | protected void deactivate() { |
Yi Tseng | 374c5f3 | 2017-03-05 22:51:35 -0800 | [diff] [blame] | 193 | cfgService.unregisterProperties(getClass(), false); |
alshabib | 2a441c6 | 2015-04-13 18:39:38 -0700 | [diff] [blame] | 194 | flowObjectiveStore.unsetDelegate(delegate); |
alshabib | aebe775 | 2015-04-07 17:45:42 -0700 | [diff] [blame] | 195 | deviceService.removeListener(deviceListener); |
Thomas Vachuska | cfeff19 | 2017-08-23 15:29:34 -0700 | [diff] [blame] | 196 | driverService.removeListener(driverListener); |
Thomas Vachuska | 866b46a | 2015-04-30 00:26:55 -0700 | [diff] [blame] | 197 | executorService.shutdown(); |
Ruchi Sahota | e4934e1 | 2019-03-01 16:56:07 +0000 | [diff] [blame] | 198 | devEventExecutor.shutdownNow(); |
| 199 | devEventExecutor = null; |
Thomas Vachuska | 866b46a | 2015-04-30 00:26:55 -0700 | [diff] [blame] | 200 | pipeliners.clear(); |
| 201 | driverHandlers.clear(); |
Saurav Das | 2443119 | 2016-03-07 19:13:00 -0800 | [diff] [blame] | 202 | nextToDevice.clear(); |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 203 | log.info("Stopped"); |
| 204 | } |
| 205 | |
Yi Tseng | 374c5f3 | 2017-03-05 22:51:35 -0800 | [diff] [blame] | 206 | @Modified |
| 207 | protected void modified(ComponentContext context) { |
pier | 8b3aef4 | 2019-03-11 15:14:02 -0700 | [diff] [blame^] | 208 | if (context != null) { |
| 209 | readComponentConfiguration(context); |
| 210 | } |
| 211 | } |
| 212 | |
| 213 | /** |
| 214 | * Extracts properties from the component configuration context. |
| 215 | * |
| 216 | * @param context the component context |
| 217 | */ |
| 218 | private void readComponentConfiguration(ComponentContext context) { |
| 219 | String propertyValue = Tools.get(context.getProperties(), FOM_NUM_THREADS); |
Yi Tseng | 374c5f3 | 2017-03-05 22:51:35 -0800 | [diff] [blame] | 220 | int newNumThreads = isNullOrEmpty(propertyValue) ? numThreads : Integer.parseInt(propertyValue); |
| 221 | |
| 222 | if (newNumThreads != numThreads && newNumThreads > 0) { |
| 223 | numThreads = newNumThreads; |
| 224 | ExecutorService oldWorkerExecutor = executorService; |
| 225 | executorService = newFixedThreadPool(numThreads, |
| 226 | groupedThreads(GROUP_THREAD_NAME, WORKER_PATTERN, log)); |
| 227 | if (oldWorkerExecutor != null) { |
| 228 | oldWorkerExecutor.shutdown(); |
| 229 | } |
| 230 | log.info("Reconfigured number of worker threads to {}", numThreads); |
| 231 | } |
pier | 8b3aef4 | 2019-03-11 15:14:02 -0700 | [diff] [blame^] | 232 | |
| 233 | // Reconfiguration of the accumulator parameters is allowed |
| 234 | // Note: it will affect only pipelines going through init method |
| 235 | propertyValue = Tools.get(context.getProperties(), FOM_ACCUMULATOR_MAX_OBJECTIVES); |
| 236 | int newMaxObjs = isNullOrEmpty(propertyValue) ? |
| 237 | accumulatorMaxObjectives : Integer.parseInt(propertyValue); |
| 238 | if (newMaxObjs != accumulatorMaxObjectives && newMaxObjs > 0) { |
| 239 | accumulatorMaxObjectives = newMaxObjs; |
| 240 | log.info("Reconfigured maximum number of objectives to accumulate to {}", |
| 241 | accumulatorMaxObjectives); |
| 242 | } |
| 243 | |
| 244 | propertyValue = Tools.get(context.getProperties(), FOM_ACCUMULATOR_MAX_IDLE_MILLIS); |
| 245 | int newMaxIdleMS = isNullOrEmpty(propertyValue) ? |
| 246 | accumulatorMaxIdleMillis : Integer.parseInt(propertyValue); |
| 247 | if (newMaxIdleMS != accumulatorMaxIdleMillis && newMaxIdleMS > 0) { |
| 248 | accumulatorMaxIdleMillis = newMaxIdleMS; |
| 249 | log.info("Reconfigured maximum number of millis between objectives to {}", |
| 250 | accumulatorMaxIdleMillis); |
| 251 | } |
| 252 | |
| 253 | propertyValue = Tools.get(context.getProperties(), FOM_ACCUMULATOR_MAX_BATCH_MILLIS); |
| 254 | int newMaxBatchMS = isNullOrEmpty(propertyValue) ? |
| 255 | accumulatorMaxBatchMillis : Integer.parseInt(propertyValue); |
| 256 | if (newMaxBatchMS != accumulatorMaxBatchMillis && newMaxBatchMS > 0) { |
| 257 | accumulatorMaxBatchMillis = newMaxBatchMS; |
| 258 | log.info("Reconfigured maximum number of millis allowed since the first objective to {}", |
| 259 | accumulatorMaxBatchMillis); |
| 260 | } |
| 261 | |
Yi Tseng | 374c5f3 | 2017-03-05 22:51:35 -0800 | [diff] [blame] | 262 | } |
| 263 | |
Jonathan Hart | 17d0045 | 2015-04-21 17:10:00 -0700 | [diff] [blame] | 264 | /** |
| 265 | * Task that passes the flow objective down to the driver. The task will |
| 266 | * make a few attempts to find the appropriate driver, then eventually give |
| 267 | * up and report an error if no suitable driver could be found. |
| 268 | */ |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 269 | class ObjectiveInstaller implements Runnable { |
| 270 | final DeviceId deviceId; |
| 271 | final Objective objective; |
Jonathan Hart | 17d0045 | 2015-04-21 17:10:00 -0700 | [diff] [blame] | 272 | |
Sho SHIMIZU | f45d85d | 2015-07-01 14:39:11 -0700 | [diff] [blame] | 273 | private final int numAttempts; |
Jonathan Hart | 17d0045 | 2015-04-21 17:10:00 -0700 | [diff] [blame] | 274 | |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 275 | ObjectiveInstaller(DeviceId deviceId, Objective objective) { |
Sho SHIMIZU | f45d85d | 2015-07-01 14:39:11 -0700 | [diff] [blame] | 276 | this(deviceId, objective, 1); |
| 277 | } |
| 278 | |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 279 | ObjectiveInstaller(DeviceId deviceId, Objective objective, int attemps) { |
Sho SHIMIZU | f45d85d | 2015-07-01 14:39:11 -0700 | [diff] [blame] | 280 | this.deviceId = checkNotNull(deviceId); |
| 281 | this.objective = checkNotNull(objective); |
Yuta HIGUCHI | fbd9ae9 | 2018-01-24 23:39:06 -0800 | [diff] [blame] | 282 | this.numAttempts = attemps; |
alshabib | 910aff1 | 2015-04-09 16:55:57 -0700 | [diff] [blame] | 283 | } |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 284 | |
Jonathan Hart | 17d0045 | 2015-04-21 17:10:00 -0700 | [diff] [blame] | 285 | @Override |
| 286 | public void run() { |
| 287 | try { |
Jonathan Hart | 17d0045 | 2015-04-21 17:10:00 -0700 | [diff] [blame] | 288 | Pipeliner pipeliner = getDevicePipeliner(deviceId); |
| 289 | |
| 290 | if (pipeliner != null) { |
| 291 | if (objective instanceof NextObjective) { |
Saurav Das | 1547b3f | 2017-05-05 17:01:08 -0700 | [diff] [blame] | 292 | nextToDevice.put(objective.id(), deviceId); |
Jonathan Hart | 17d0045 | 2015-04-21 17:10:00 -0700 | [diff] [blame] | 293 | pipeliner.next((NextObjective) objective); |
| 294 | } else if (objective instanceof ForwardingObjective) { |
| 295 | pipeliner.forward((ForwardingObjective) objective); |
| 296 | } else { |
| 297 | pipeliner.filter((FilteringObjective) objective); |
| 298 | } |
Andrea Campanella | 1f8188d | 2016-02-29 13:24:54 -0800 | [diff] [blame] | 299 | //Attempts to check if pipeliner is null for retry attempts |
Jonathan Hart | 17d0045 | 2015-04-21 17:10:00 -0700 | [diff] [blame] | 300 | } else if (numAttempts < INSTALL_RETRY_ATTEMPTS) { |
Saurav Das | 3d03826 | 2015-04-23 12:36:58 -0700 | [diff] [blame] | 301 | Thread.sleep(INSTALL_RETRY_INTERVAL); |
HIGUCHI Yuta | d9e0105 | 2016-04-14 09:31:42 -0700 | [diff] [blame] | 302 | executorService.execute(new ObjectiveInstaller(deviceId, objective, numAttempts + 1)); |
Jonathan Hart | 17d0045 | 2015-04-21 17:10:00 -0700 | [diff] [blame] | 303 | } else { |
| 304 | // Otherwise we've tried a few times and failed, report an |
| 305 | // error back to the user. |
| 306 | objective.context().ifPresent( |
Andrea Campanella | 1f8188d | 2016-02-29 13:24:54 -0800 | [diff] [blame] | 307 | c -> c.onError(objective, ObjectiveError.NOPIPELINER)); |
Jonathan Hart | 17d0045 | 2015-04-21 17:10:00 -0700 | [diff] [blame] | 308 | } |
Saurav Das | 1547b3f | 2017-05-05 17:01:08 -0700 | [diff] [blame] | 309 | //Exception thrown |
Jonathan Hart | 17d0045 | 2015-04-21 17:10:00 -0700 | [diff] [blame] | 310 | } catch (Exception e) { |
| 311 | log.warn("Exception while installing flow objective", e); |
| 312 | } |
| 313 | } |
| 314 | } |
| 315 | |
| 316 | @Override |
| 317 | public void filter(DeviceId deviceId, FilteringObjective filteringObjective) { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 318 | checkPermission(FLOWRULE_WRITE); |
HIGUCHI Yuta | d9e0105 | 2016-04-14 09:31:42 -0700 | [diff] [blame] | 319 | executorService.execute(new ObjectiveInstaller(deviceId, filteringObjective)); |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 320 | } |
| 321 | |
| 322 | @Override |
Thomas Vachuska | 866b46a | 2015-04-30 00:26:55 -0700 | [diff] [blame] | 323 | public void forward(DeviceId deviceId, ForwardingObjective forwardingObjective) { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 324 | checkPermission(FLOWRULE_WRITE); |
Yi Tseng | 1666b50 | 2017-05-17 11:05:18 -0700 | [diff] [blame] | 325 | if (forwardingObjective.nextId() == null || |
Yi Tseng | 1666b50 | 2017-05-17 11:05:18 -0700 | [diff] [blame] | 326 | flowObjectiveStore.getNextGroup(forwardingObjective.nextId()) != null || |
| 327 | !queueFwdObjective(deviceId, forwardingObjective)) { |
| 328 | // fast path |
| 329 | executorService.execute(new ObjectiveInstaller(deviceId, forwardingObjective)); |
alshabib | 910aff1 | 2015-04-09 16:55:57 -0700 | [diff] [blame] | 330 | } |
Thomas Vachuska | ca88bb7 | 2015-04-08 19:38:02 -0700 | [diff] [blame] | 331 | } |
| 332 | |
alshabib | 2a441c6 | 2015-04-13 18:39:38 -0700 | [diff] [blame] | 333 | @Override |
Jonathan Hart | 17d0045 | 2015-04-21 17:10:00 -0700 | [diff] [blame] | 334 | public void next(DeviceId deviceId, NextObjective nextObjective) { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 335 | checkPermission(FLOWRULE_WRITE); |
Yi Tseng | 1666b50 | 2017-05-17 11:05:18 -0700 | [diff] [blame] | 336 | if (nextObjective.op() == Operation.ADD || |
Charles Chan | b71e1ba | 2018-08-16 21:02:34 -0700 | [diff] [blame] | 337 | nextObjective.op() == Operation.VERIFY || |
Yi Tseng | 1666b50 | 2017-05-17 11:05:18 -0700 | [diff] [blame] | 338 | flowObjectiveStore.getNextGroup(nextObjective.id()) != null || |
| 339 | !queueNextObjective(deviceId, nextObjective)) { |
| 340 | // either group exists or we are trying to create it - let it through |
| 341 | executorService.execute(new ObjectiveInstaller(deviceId, nextObjective)); |
Saurav Das | 1547b3f | 2017-05-05 17:01:08 -0700 | [diff] [blame] | 342 | } |
alshabib | 2a441c6 | 2015-04-13 18:39:38 -0700 | [diff] [blame] | 343 | } |
| 344 | |
alshabib | f6ea9e6 | 2015-04-21 17:08:26 -0700 | [diff] [blame] | 345 | @Override |
| 346 | public int allocateNextId() { |
Changhoon Yoon | b856b81 | 2015-08-10 03:47:19 +0900 | [diff] [blame] | 347 | checkPermission(FLOWRULE_WRITE); |
alshabib | f6ea9e6 | 2015-04-21 17:08:26 -0700 | [diff] [blame] | 348 | return flowObjectiveStore.allocateNextId(); |
| 349 | } |
| 350 | |
Xin Jin | 313708b | 2015-07-09 13:43:04 -0700 | [diff] [blame] | 351 | @Override |
Thomas Vachuska | cfeff19 | 2017-08-23 15:29:34 -0700 | [diff] [blame] | 352 | public void initPolicy(String policy) { |
| 353 | } |
Xin Jin | 313708b | 2015-07-09 13:43:04 -0700 | [diff] [blame] | 354 | |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 355 | boolean queueFwdObjective(DeviceId deviceId, ForwardingObjective fwd) { |
Thomas Vachuska | d27097c | 2016-06-14 19:10:41 -0700 | [diff] [blame] | 356 | boolean queued = false; |
| 357 | synchronized (pendingForwards) { |
| 358 | // double check the flow objective store, because this block could run |
| 359 | // after a notification arrives |
| 360 | if (flowObjectiveStore.getNextGroup(fwd.nextId()) == null) { |
| 361 | pendingForwards.compute(fwd.nextId(), (id, pending) -> { |
Saurav Das | 1547b3f | 2017-05-05 17:01:08 -0700 | [diff] [blame] | 362 | PendingFlowObjective pendfo = new PendingFlowObjective(deviceId, fwd); |
Thomas Vachuska | d27097c | 2016-06-14 19:10:41 -0700 | [diff] [blame] | 363 | if (pending == null) { |
Pier Luigi | 9789311 | 2018-03-05 11:09:42 +0100 | [diff] [blame] | 364 | return Sets.newLinkedHashSet(ImmutableSet.of(pendfo)); |
Thomas Vachuska | d27097c | 2016-06-14 19:10:41 -0700 | [diff] [blame] | 365 | } else { |
Saurav Das | 1547b3f | 2017-05-05 17:01:08 -0700 | [diff] [blame] | 366 | pending.add(pendfo); |
Thomas Vachuska | d27097c | 2016-06-14 19:10:41 -0700 | [diff] [blame] | 367 | return pending; |
| 368 | } |
| 369 | }); |
| 370 | queued = true; |
| 371 | } |
| 372 | } |
| 373 | if (queued) { |
Saurav Das | c568c34 | 2018-01-25 09:49:01 -0800 | [diff] [blame] | 374 | log.debug("Queued forwarding objective {} for nextId {} meant for device {}", |
Thomas Vachuska | d27097c | 2016-06-14 19:10:41 -0700 | [diff] [blame] | 375 | fwd.id(), fwd.nextId(), deviceId); |
| 376 | } |
| 377 | return queued; |
alshabib | 2a441c6 | 2015-04-13 18:39:38 -0700 | [diff] [blame] | 378 | } |
| 379 | |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 380 | boolean queueNextObjective(DeviceId deviceId, NextObjective next) { |
Saurav Das | 1547b3f | 2017-05-05 17:01:08 -0700 | [diff] [blame] | 381 | // we need to hold off on other operations till we get notified that the |
| 382 | // initial group creation has succeeded |
| 383 | boolean queued = false; |
| 384 | synchronized (pendingNexts) { |
| 385 | // double check the flow objective store, because this block could run |
| 386 | // after a notification arrives |
| 387 | if (flowObjectiveStore.getNextGroup(next.id()) == null) { |
| 388 | pendingNexts.compute(next.id(), (id, pending) -> { |
| 389 | PendingFlowObjective pendfo = new PendingFlowObjective(deviceId, next); |
| 390 | if (pending == null) { |
Saurav Das | f14d9ef | 2017-12-05 15:00:23 -0800 | [diff] [blame] | 391 | return Lists.newArrayList(pendfo); |
Saurav Das | 1547b3f | 2017-05-05 17:01:08 -0700 | [diff] [blame] | 392 | } else { |
| 393 | pending.add(pendfo); |
| 394 | return pending; |
| 395 | } |
| 396 | }); |
| 397 | queued = true; |
| 398 | } |
| 399 | } |
| 400 | if (queued) { |
Saurav Das | c568c34 | 2018-01-25 09:49:01 -0800 | [diff] [blame] | 401 | log.debug("Queued next objective {} with operation {} meant for device {}", |
Saurav Das | 1547b3f | 2017-05-05 17:01:08 -0700 | [diff] [blame] | 402 | next.id(), next.op(), deviceId); |
| 403 | } |
| 404 | return queued; |
| 405 | } |
| 406 | |
Pier Ventre | 57a61cd | 2016-09-07 10:55:41 -0700 | [diff] [blame] | 407 | /** |
| 408 | * Retrieves (if it exists) the device pipeline behaviour from the cache. |
| 409 | * Otherwise it warms the caches and triggers the init method of the Pipeline. |
| 410 | * |
| 411 | * @param deviceId the id of the device associated to the pipeline |
| 412 | * @return the implementation of the Pipeliner behaviour |
| 413 | */ |
Thomas Vachuska | ca88bb7 | 2015-04-08 19:38:02 -0700 | [diff] [blame] | 414 | private Pipeliner getDevicePipeliner(DeviceId deviceId) { |
Yuta HIGUCHI | 1fb0a8c | 2016-08-12 10:59:24 -0700 | [diff] [blame] | 415 | return pipeliners.computeIfAbsent(deviceId, this::initPipelineHandler); |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 416 | } |
| 417 | |
Yuta HIGUCHI | 1fb0a8c | 2016-08-12 10:59:24 -0700 | [diff] [blame] | 418 | /** |
Pier Ventre | 57a61cd | 2016-09-07 10:55:41 -0700 | [diff] [blame] | 419 | * Retrieves (if it exists) the device pipeline behaviour from the cache and |
| 420 | * and triggers the init method of the pipeline. Otherwise (DEVICE_ADDED) it warms |
| 421 | * the caches and triggers the init method of the Pipeline. The rationale of this |
| 422 | * method is for managing the scenario of a switch that goes down for a failure |
| 423 | * and goes up after a while. |
| 424 | * |
| 425 | * @param deviceId the id of the device associated to the pipeline |
| 426 | * @return the implementation of the Pipeliner behaviour |
| 427 | */ |
| 428 | private Pipeliner getAndInitDevicePipeliner(DeviceId deviceId) { |
| 429 | return pipeliners.compute(deviceId, (deviceIdValue, pipelinerValue) -> { |
| 430 | if (pipelinerValue != null) { |
| 431 | pipelinerValue.init(deviceId, context); |
| 432 | return pipelinerValue; |
| 433 | } |
| 434 | return this.initPipelineHandler(deviceId); |
| 435 | }); |
| 436 | } |
| 437 | |
| 438 | /** |
Yuta HIGUCHI | 1fb0a8c | 2016-08-12 10:59:24 -0700 | [diff] [blame] | 439 | * Creates and initialize {@link Pipeliner}. |
| 440 | * <p> |
| 441 | * Note: Expected to be called under per-Device lock. |
| 442 | * e.g., {@code pipeliners}' Map#compute family methods |
| 443 | * |
| 444 | * @param deviceId Device to initialize pipeliner |
| 445 | * @return {@link Pipeliner} instance or null |
| 446 | */ |
| 447 | private Pipeliner initPipelineHandler(DeviceId deviceId) { |
| 448 | start = now(); |
Thomas Vachuska | 866b46a | 2015-04-30 00:26:55 -0700 | [diff] [blame] | 449 | |
Jonathan Hart | 17d0045 | 2015-04-21 17:10:00 -0700 | [diff] [blame] | 450 | // Attempt to lookup the handler in the cache |
| 451 | DriverHandler handler = driverHandlers.get(deviceId); |
Thomas Vachuska | b19bffb | 2015-07-22 10:56:16 -0700 | [diff] [blame] | 452 | cTime = now(); |
| 453 | |
Jonathan Hart | 17d0045 | 2015-04-21 17:10:00 -0700 | [diff] [blame] | 454 | if (handler == null) { |
| 455 | try { |
| 456 | // Otherwise create it and if it has pipeline behaviour, cache it |
| 457 | handler = driverService.createHandler(deviceId); |
Thomas Vachuska | b19bffb | 2015-07-22 10:56:16 -0700 | [diff] [blame] | 458 | dTime = now(); |
Jonathan Hart | 17d0045 | 2015-04-21 17:10:00 -0700 | [diff] [blame] | 459 | if (!handler.driver().hasBehaviour(Pipeliner.class)) { |
Yuta HIGUCHI | a2a4f34 | 2017-03-17 11:38:57 -0700 | [diff] [blame] | 460 | log.debug("Pipeline behaviour not supported for device {}", |
Jonathan Hart | 17d0045 | 2015-04-21 17:10:00 -0700 | [diff] [blame] | 461 | deviceId); |
Yuta HIGUCHI | 1fb0a8c | 2016-08-12 10:59:24 -0700 | [diff] [blame] | 462 | return null; |
alshabib | 2a441c6 | 2015-04-13 18:39:38 -0700 | [diff] [blame] | 463 | } |
Jonathan Hart | 17d0045 | 2015-04-21 17:10:00 -0700 | [diff] [blame] | 464 | } catch (ItemNotFoundException e) { |
| 465 | log.warn("No applicable driver for device {}", deviceId); |
Yuta HIGUCHI | 1fb0a8c | 2016-08-12 10:59:24 -0700 | [diff] [blame] | 466 | return null; |
alshabib | 2a441c6 | 2015-04-13 18:39:38 -0700 | [diff] [blame] | 467 | } |
| 468 | |
Jonathan Hart | 17d0045 | 2015-04-21 17:10:00 -0700 | [diff] [blame] | 469 | driverHandlers.put(deviceId, handler); |
Thomas Vachuska | b19bffb | 2015-07-22 10:56:16 -0700 | [diff] [blame] | 470 | eTime = now(); |
alshabib | 2a441c6 | 2015-04-13 18:39:38 -0700 | [diff] [blame] | 471 | } |
Jonathan Hart | 17d0045 | 2015-04-21 17:10:00 -0700 | [diff] [blame] | 472 | |
| 473 | // Always (re)initialize the pipeline behaviour |
| 474 | log.info("Driver {} bound to device {} ... initializing driver", |
| 475 | handler.driver().name(), deviceId); |
Thomas Vachuska | 0121a61 | 2015-07-21 11:18:09 -0700 | [diff] [blame] | 476 | hTime = now(); |
Jonathan Hart | 17d0045 | 2015-04-21 17:10:00 -0700 | [diff] [blame] | 477 | Pipeliner pipeliner = handler.behaviour(Pipeliner.class); |
Thomas Vachuska | 94c3cf4 | 2015-07-20 13:01:12 -0700 | [diff] [blame] | 478 | hbTime = now(); |
Jonathan Hart | 17d0045 | 2015-04-21 17:10:00 -0700 | [diff] [blame] | 479 | pipeliner.init(deviceId, context); |
Yuta HIGUCHI | 1fb0a8c | 2016-08-12 10:59:24 -0700 | [diff] [blame] | 480 | stopWatch(); |
| 481 | return pipeliner; |
alshabib | aebe775 | 2015-04-07 17:45:42 -0700 | [diff] [blame] | 482 | } |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 483 | |
Thomas Vachuska | cfeff19 | 2017-08-23 15:29:34 -0700 | [diff] [blame] | 484 | private void invalidatePipelinerIfNecessary(Device device) { |
| 485 | DriverHandler handler = driverHandlers.get(device.id()); |
| 486 | if (handler != null && |
| 487 | !Objects.equals(handler.driver().name(), |
| 488 | device.annotations().value(DRIVER))) { |
| 489 | invalidatePipeliner(device.id()); |
| 490 | } |
| 491 | } |
| 492 | |
| 493 | private void invalidatePipeliner(DeviceId id) { |
| 494 | log.info("Invalidating cached pipeline behaviour for {}", id); |
| 495 | driverHandlers.remove(id); |
| 496 | pipeliners.remove(id); |
| 497 | if (deviceService.isAvailable(id)) { |
| 498 | getAndInitDevicePipeliner(id); |
| 499 | } |
| 500 | } |
| 501 | |
Thomas Vachuska | ca88bb7 | 2015-04-08 19:38:02 -0700 | [diff] [blame] | 502 | // Triggers driver setup when a device is (re)detected. |
alshabib | aebe775 | 2015-04-07 17:45:42 -0700 | [diff] [blame] | 503 | private class InnerDeviceListener implements DeviceListener { |
| 504 | @Override |
| 505 | public void event(DeviceEvent event) { |
Ruchi Sahota | e4934e1 | 2019-03-01 16:56:07 +0000 | [diff] [blame] | 506 | if (devEventExecutor != null) { |
alshabib | aebe775 | 2015-04-07 17:45:42 -0700 | [diff] [blame] | 507 | switch (event.type()) { |
| 508 | case DEVICE_ADDED: |
| 509 | case DEVICE_AVAILABILITY_CHANGED: |
Madan Jampani | 0174f45 | 2015-05-29 11:52:05 -0700 | [diff] [blame] | 510 | log.debug("Device either added or availability changed {}", |
Thomas Vachuska | 9c9ff7c | 2015-07-20 10:38:59 -0700 | [diff] [blame] | 511 | event.subject().id()); |
Ruchi Sahota | e4934e1 | 2019-03-01 16:56:07 +0000 | [diff] [blame] | 512 | devEventExecutor.execute(() -> { |
| 513 | if (deviceService.isAvailable(event.subject().id())) { |
Madan Jampani | 0174f45 | 2015-05-29 11:52:05 -0700 | [diff] [blame] | 514 | log.debug("Device is now available {}", event.subject().id()); |
Pier Ventre | 57a61cd | 2016-09-07 10:55:41 -0700 | [diff] [blame] | 515 | getAndInitDevicePipeliner(event.subject().id()); |
Ruchi Sahota | e4934e1 | 2019-03-01 16:56:07 +0000 | [diff] [blame] | 516 | } else { |
Yuta HIGUCHI | 1fb0a8c | 2016-08-12 10:59:24 -0700 | [diff] [blame] | 517 | log.debug("Device is no longer available {}", event.subject().id()); |
Ruchi Sahota | e4934e1 | 2019-03-01 16:56:07 +0000 | [diff] [blame] | 518 | } |
| 519 | }); |
alshabib | 4313d10 | 2015-04-08 18:55:08 -0700 | [diff] [blame] | 520 | break; |
| 521 | case DEVICE_UPDATED: |
Thomas Vachuska | cfeff19 | 2017-08-23 15:29:34 -0700 | [diff] [blame] | 522 | // Invalidate pipeliner and handler caches if the driver name |
| 523 | // device annotation changed. |
Ruchi Sahota | e4934e1 | 2019-03-01 16:56:07 +0000 | [diff] [blame] | 524 | devEventExecutor.execute(() -> invalidatePipelinerIfNecessary(event.subject())); |
alshabib | 4313d10 | 2015-04-08 18:55:08 -0700 | [diff] [blame] | 525 | break; |
| 526 | case DEVICE_REMOVED: |
Yuta HIGUCHI | ad0c990 | 2016-08-23 10:37:32 -0700 | [diff] [blame] | 527 | // evict Pipeliner and Handler cache, when |
| 528 | // the Device was administratively removed. |
| 529 | // |
| 530 | // System expect the user to clear all existing flows, |
| 531 | // before removing device, especially if they intend to |
| 532 | // replace driver/pipeliner assigned to the device. |
Ruchi Sahota | e4934e1 | 2019-03-01 16:56:07 +0000 | [diff] [blame] | 533 | devEventExecutor.execute(() -> { |
| 534 | driverHandlers.remove(event.subject().id()); |
| 535 | pipeliners.remove(event.subject().id()); |
| 536 | }); |
alshabib | 4313d10 | 2015-04-08 18:55:08 -0700 | [diff] [blame] | 537 | break; |
Yuta HIGUCHI | ad0c990 | 2016-08-23 10:37:32 -0700 | [diff] [blame] | 538 | case DEVICE_SUSPENDED: |
| 539 | break; |
alshabib | 4313d10 | 2015-04-08 18:55:08 -0700 | [diff] [blame] | 540 | case PORT_ADDED: |
| 541 | break; |
| 542 | case PORT_UPDATED: |
| 543 | break; |
| 544 | case PORT_REMOVED: |
alshabib | aebe775 | 2015-04-07 17:45:42 -0700 | [diff] [blame] | 545 | break; |
| 546 | default: |
Thomas Vachuska | ca88bb7 | 2015-04-08 19:38:02 -0700 | [diff] [blame] | 547 | break; |
alshabib | aebe775 | 2015-04-07 17:45:42 -0700 | [diff] [blame] | 548 | } |
Ruchi Sahota | e4934e1 | 2019-03-01 16:56:07 +0000 | [diff] [blame] | 549 | } |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 550 | } |
| 551 | } |
alshabib | aebe775 | 2015-04-07 17:45:42 -0700 | [diff] [blame] | 552 | |
Thomas Vachuska | cfeff19 | 2017-08-23 15:29:34 -0700 | [diff] [blame] | 553 | // Monitors driver configuration changes and invalidates the pipeliner cache entries. |
| 554 | // Note that this may leave stale entries on the device if the driver changes |
| 555 | // in manner where the new driver does not produce backward compatible flow objectives. |
| 556 | // In such cases, it is the operator's responsibility to force device re-connect. |
| 557 | private class InnerDriverListener implements DriverListener { |
| 558 | @Override |
| 559 | public void event(DriverEvent event) { |
| 560 | String driverName = event.subject().name(); |
| 561 | driverHandlers.entrySet().stream() |
| 562 | .filter(e -> driverName.equals(e.getValue().driver().name())) |
| 563 | .map(Map.Entry::getKey) |
| 564 | .distinct() |
| 565 | .forEach(FlowObjectiveManager.this::invalidatePipeliner); |
| 566 | } |
| 567 | } |
| 568 | |
Thomas Vachuska | 174bb91 | 2015-07-16 21:27:14 -0700 | [diff] [blame] | 569 | // Temporary mechanism to monitor pipeliner setup time-cost; there are |
| 570 | // intermittent time where this takes in excess of 2 seconds. Why? |
Thomas Vachuska | 9c9ff7c | 2015-07-20 10:38:59 -0700 | [diff] [blame] | 571 | private long start = 0, totals = 0, count = 0; |
Thomas Vachuska | b19bffb | 2015-07-22 10:56:16 -0700 | [diff] [blame] | 572 | private long cTime, dTime, eTime, hTime, hbTime; |
Thomas Vachuska | 9c9ff7c | 2015-07-20 10:38:59 -0700 | [diff] [blame] | 573 | private static final long LIMIT = 500; |
Thomas Vachuska | 174bb91 | 2015-07-16 21:27:14 -0700 | [diff] [blame] | 574 | |
Thomas Vachuska | 9c9ff7c | 2015-07-20 10:38:59 -0700 | [diff] [blame] | 575 | private long now() { |
Thomas Vachuska | 174bb91 | 2015-07-16 21:27:14 -0700 | [diff] [blame] | 576 | return System.currentTimeMillis(); |
| 577 | } |
| 578 | |
Thomas Vachuska | 9c9ff7c | 2015-07-20 10:38:59 -0700 | [diff] [blame] | 579 | private void stopWatch() { |
Thomas Vachuska | 174bb91 | 2015-07-16 21:27:14 -0700 | [diff] [blame] | 580 | long duration = System.currentTimeMillis() - start; |
| 581 | totals += duration; |
| 582 | count += 1; |
| 583 | if (duration > LIMIT) { |
Thomas Vachuska | b19bffb | 2015-07-22 10:56:16 -0700 | [diff] [blame] | 584 | log.info("Pipeline setup took {} ms; avg {} ms; cTime={}, dTime={}, eTime={}, hTime={}, hbTime={}", |
| 585 | duration, totals / count, diff(cTime), diff(dTime), diff(eTime), diff(hTime), diff(hbTime)); |
Thomas Vachuska | 174bb91 | 2015-07-16 21:27:14 -0700 | [diff] [blame] | 586 | } |
| 587 | } |
| 588 | |
Thomas Vachuska | 9c9ff7c | 2015-07-20 10:38:59 -0700 | [diff] [blame] | 589 | private long diff(long bTime) { |
Thomas Vachuska | b19bffb | 2015-07-22 10:56:16 -0700 | [diff] [blame] | 590 | long diff = bTime - start; |
| 591 | return diff < 0 ? 0 : diff; |
Thomas Vachuska | 9c9ff7c | 2015-07-20 10:38:59 -0700 | [diff] [blame] | 592 | } |
| 593 | |
Thomas Vachuska | ca88bb7 | 2015-04-08 19:38:02 -0700 | [diff] [blame] | 594 | // Processing context for initializing pipeline driver behaviours. |
| 595 | private class InnerPipelineContext implements PipelinerContext { |
pier | 8b3aef4 | 2019-03-11 15:14:02 -0700 | [diff] [blame^] | 596 | |
Thomas Vachuska | ca88bb7 | 2015-04-08 19:38:02 -0700 | [diff] [blame] | 597 | @Override |
| 598 | public ServiceDirectory directory() { |
| 599 | return serviceDirectory; |
alshabib | aebe775 | 2015-04-07 17:45:42 -0700 | [diff] [blame] | 600 | } |
alshabib | 2a441c6 | 2015-04-13 18:39:38 -0700 | [diff] [blame] | 601 | |
| 602 | @Override |
| 603 | public FlowObjectiveStore store() { |
| 604 | return flowObjectiveStore; |
| 605 | } |
pier | 8b3aef4 | 2019-03-11 15:14:02 -0700 | [diff] [blame^] | 606 | |
| 607 | @Override |
| 608 | public int accumulatorMaxObjectives() { |
| 609 | return accumulatorMaxObjectives; |
| 610 | } |
| 611 | |
| 612 | @Override |
| 613 | public int accumulatorMaxIdleMillis() { |
| 614 | return accumulatorMaxIdleMillis; |
| 615 | } |
| 616 | |
| 617 | @Override |
| 618 | public int accumulatorMaxBatchMillis() { |
| 619 | return accumulatorMaxBatchMillis; |
| 620 | } |
| 621 | |
alshabib | 2a441c6 | 2015-04-13 18:39:38 -0700 | [diff] [blame] | 622 | } |
| 623 | |
| 624 | private class InternalStoreDelegate implements FlowObjectiveStoreDelegate { |
| 625 | @Override |
| 626 | public void notify(ObjectiveEvent event) { |
Saurav Das | 423fe2b | 2015-12-04 10:52:59 -0800 | [diff] [blame] | 627 | if (event.type() == Type.ADD) { |
| 628 | log.debug("Received notification of obj event {}", event); |
Saurav Das | 1547b3f | 2017-05-05 17:01:08 -0700 | [diff] [blame] | 629 | Set<PendingFlowObjective> pending; |
| 630 | |
| 631 | // first send all pending flows |
Thomas Vachuska | d27097c | 2016-06-14 19:10:41 -0700 | [diff] [blame] | 632 | synchronized (pendingForwards) { |
| 633 | // needs to be synchronized for queueObjective lookup |
| 634 | pending = pendingForwards.remove(event.subject()); |
| 635 | } |
Saurav Das | 423fe2b | 2015-12-04 10:52:59 -0800 | [diff] [blame] | 636 | if (pending == null) { |
Saurav Das | 1547b3f | 2017-05-05 17:01:08 -0700 | [diff] [blame] | 637 | log.debug("No forwarding objectives pending for this " |
| 638 | + "obj event {}", event); |
| 639 | } else { |
| 640 | log.debug("Processing {} pending forwarding objectives for nextId {}", |
| 641 | pending.size(), event.subject()); |
| 642 | pending.forEach(p -> getDevicePipeliner(p.deviceId()) |
| 643 | .forward((ForwardingObjective) p.flowObjective())); |
Saurav Das | 423fe2b | 2015-12-04 10:52:59 -0800 | [diff] [blame] | 644 | } |
| 645 | |
Saurav Das | 1547b3f | 2017-05-05 17:01:08 -0700 | [diff] [blame] | 646 | // now check for pending next-objectives |
Saurav Das | f14d9ef | 2017-12-05 15:00:23 -0800 | [diff] [blame] | 647 | List<PendingFlowObjective> pendNexts; |
Saurav Das | 1547b3f | 2017-05-05 17:01:08 -0700 | [diff] [blame] | 648 | synchronized (pendingNexts) { |
| 649 | // needs to be synchronized for queueObjective lookup |
Saurav Das | f14d9ef | 2017-12-05 15:00:23 -0800 | [diff] [blame] | 650 | pendNexts = pendingNexts.remove(event.subject()); |
Saurav Das | 1547b3f | 2017-05-05 17:01:08 -0700 | [diff] [blame] | 651 | } |
Saurav Das | f14d9ef | 2017-12-05 15:00:23 -0800 | [diff] [blame] | 652 | if (pendNexts == null) { |
Saurav Das | 1547b3f | 2017-05-05 17:01:08 -0700 | [diff] [blame] | 653 | log.debug("No next objectives pending for this " |
| 654 | + "obj event {}", event); |
| 655 | } else { |
| 656 | log.debug("Processing {} pending next objectives for nextId {}", |
Saurav Das | f14d9ef | 2017-12-05 15:00:23 -0800 | [diff] [blame] | 657 | pendNexts.size(), event.subject()); |
| 658 | pendNexts.forEach(p -> getDevicePipeliner(p.deviceId()) |
Saurav Das | 1547b3f | 2017-05-05 17:01:08 -0700 | [diff] [blame] | 659 | .next((NextObjective) p.flowObjective())); |
| 660 | } |
alshabib | 2a441c6 | 2015-04-13 18:39:38 -0700 | [diff] [blame] | 661 | } |
alshabib | 2a441c6 | 2015-04-13 18:39:38 -0700 | [diff] [blame] | 662 | } |
| 663 | } |
| 664 | |
| 665 | /** |
Saurav Das | 1547b3f | 2017-05-05 17:01:08 -0700 | [diff] [blame] | 666 | * Data class used to hold a pending flow objective that could not |
alshabib | 2a441c6 | 2015-04-13 18:39:38 -0700 | [diff] [blame] | 667 | * be processed because the associated next object was not present. |
Saurav Das | 1547b3f | 2017-05-05 17:01:08 -0700 | [diff] [blame] | 668 | * Note that this pending flow objective could be a forwarding objective |
| 669 | * waiting for a next objective to complete execution. Or it could a |
| 670 | * next objective (with a different operation - remove, addToExisting, or |
| 671 | * removeFromExisting) waiting for a next objective with the same id to |
| 672 | * complete execution. |
alshabib | 2a441c6 | 2015-04-13 18:39:38 -0700 | [diff] [blame] | 673 | */ |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 674 | protected class PendingFlowObjective { |
alshabib | 2a441c6 | 2015-04-13 18:39:38 -0700 | [diff] [blame] | 675 | private final DeviceId deviceId; |
Saurav Das | 1547b3f | 2017-05-05 17:01:08 -0700 | [diff] [blame] | 676 | private final Objective flowObj; |
alshabib | 2a441c6 | 2015-04-13 18:39:38 -0700 | [diff] [blame] | 677 | |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 678 | PendingFlowObjective(DeviceId deviceId, Objective flowObj) { |
alshabib | 2a441c6 | 2015-04-13 18:39:38 -0700 | [diff] [blame] | 679 | this.deviceId = deviceId; |
Saurav Das | 1547b3f | 2017-05-05 17:01:08 -0700 | [diff] [blame] | 680 | this.flowObj = flowObj; |
alshabib | 2a441c6 | 2015-04-13 18:39:38 -0700 | [diff] [blame] | 681 | } |
| 682 | |
| 683 | public DeviceId deviceId() { |
| 684 | return deviceId; |
| 685 | } |
| 686 | |
Saurav Das | 1547b3f | 2017-05-05 17:01:08 -0700 | [diff] [blame] | 687 | public Objective flowObjective() { |
| 688 | return flowObj; |
alshabib | 2a441c6 | 2015-04-13 18:39:38 -0700 | [diff] [blame] | 689 | } |
Saurav Das | 8a0732e | 2015-11-20 15:27:53 -0800 | [diff] [blame] | 690 | |
| 691 | @Override |
| 692 | public int hashCode() { |
Saurav Das | 1547b3f | 2017-05-05 17:01:08 -0700 | [diff] [blame] | 693 | return Objects.hash(deviceId, flowObj); |
Saurav Das | 8a0732e | 2015-11-20 15:27:53 -0800 | [diff] [blame] | 694 | } |
| 695 | |
| 696 | @Override |
| 697 | public boolean equals(final Object obj) { |
| 698 | if (this == obj) { |
| 699 | return true; |
| 700 | } |
Saurav Das | 1547b3f | 2017-05-05 17:01:08 -0700 | [diff] [blame] | 701 | if (!(obj instanceof PendingFlowObjective)) { |
Saurav Das | 8a0732e | 2015-11-20 15:27:53 -0800 | [diff] [blame] | 702 | return false; |
| 703 | } |
Saurav Das | 1547b3f | 2017-05-05 17:01:08 -0700 | [diff] [blame] | 704 | final PendingFlowObjective other = (PendingFlowObjective) obj; |
Charles Chan | a7903c8 | 2018-03-15 20:14:16 -0700 | [diff] [blame] | 705 | |
| 706 | return this.deviceId.equals(other.deviceId) && |
| 707 | this.flowObj.equals(other.flowObj); |
Saurav Das | 8a0732e | 2015-11-20 15:27:53 -0800 | [diff] [blame] | 708 | } |
alshabib | aebe775 | 2015-04-07 17:45:42 -0700 | [diff] [blame] | 709 | } |
Saurav Das | 2443119 | 2016-03-07 19:13:00 -0800 | [diff] [blame] | 710 | |
| 711 | @Override |
| 712 | public List<String> getNextMappings() { |
| 713 | List<String> mappings = new ArrayList<>(); |
| 714 | Map<Integer, NextGroup> allnexts = flowObjectiveStore.getAllGroups(); |
Saurav Das | 2519081 | 2016-05-27 13:54:07 -0700 | [diff] [blame] | 715 | // XXX if the NextGroup after de-serialization actually stored info of the deviceId |
Saurav Das | 2443119 | 2016-03-07 19:13:00 -0800 | [diff] [blame] | 716 | // then info on any nextObj could be retrieved from one controller instance. |
| 717 | // Right now the drivers on one instance can only fetch for next-ids that came |
| 718 | // to them. |
| 719 | // Also, we still need to send the right next-id to the right driver as potentially |
| 720 | // there can be different drivers for different devices. But on that account, |
| 721 | // no instance should be decoding for another instance's nextIds. |
| 722 | |
| 723 | for (Map.Entry<Integer, NextGroup> e : allnexts.entrySet()) { |
| 724 | // get the device this next Objective was sent to |
| 725 | DeviceId deviceId = nextToDevice.get(e.getKey()); |
| 726 | mappings.add("NextId " + e.getKey() + ": " + |
| 727 | ((deviceId != null) ? deviceId : "nextId not in this onos instance")); |
| 728 | if (deviceId != null) { |
| 729 | // this instance of the controller sent the nextObj to a driver |
| 730 | Pipeliner pipeliner = getDevicePipeliner(deviceId); |
| 731 | List<String> nextMappings = pipeliner.getNextMappings(e.getValue()); |
| 732 | if (nextMappings != null) { |
| 733 | mappings.addAll(nextMappings); |
| 734 | } |
| 735 | } |
| 736 | } |
| 737 | return mappings; |
| 738 | } |
Saurav Das | b5c236e | 2016-06-07 10:08:06 -0700 | [diff] [blame] | 739 | |
| 740 | @Override |
Saurav Das | 1547b3f | 2017-05-05 17:01:08 -0700 | [diff] [blame] | 741 | public List<String> getPendingFlowObjectives() { |
| 742 | List<String> pendingFlowObjectives = new ArrayList<>(); |
Charles Chan | 5473471 | 2017-03-29 11:07:55 -0700 | [diff] [blame] | 743 | |
Saurav Das | 1547b3f | 2017-05-05 17:01:08 -0700 | [diff] [blame] | 744 | for (Integer nextId : pendingForwards.keySet()) { |
| 745 | Set<PendingFlowObjective> pfwd = pendingForwards.get(nextId); |
Sho SHIMIZU | 81470a5 | 2016-08-12 17:24:55 -0700 | [diff] [blame] | 746 | StringBuilder pend = new StringBuilder(); |
Charles Chan | 5473471 | 2017-03-29 11:07:55 -0700 | [diff] [blame] | 747 | pend.append("NextId: ") |
| 748 | .append(nextId); |
Saurav Das | 1547b3f | 2017-05-05 17:01:08 -0700 | [diff] [blame] | 749 | for (PendingFlowObjective pf : pfwd) { |
Charles Chan | 5473471 | 2017-03-29 11:07:55 -0700 | [diff] [blame] | 750 | pend.append("\n FwdId: ") |
Saurav Das | 1547b3f | 2017-05-05 17:01:08 -0700 | [diff] [blame] | 751 | .append(String.format("%11s", pf.flowObjective().id())) |
| 752 | .append(", DeviceId: ") |
| 753 | .append(pf.deviceId()) |
| 754 | .append(", Selector: ") |
| 755 | .append(((ForwardingObjective) pf.flowObjective()) |
| 756 | .selector().criteria()); |
| 757 | } |
| 758 | pendingFlowObjectives.add(pend.toString()); |
| 759 | } |
| 760 | |
| 761 | for (Integer nextId : pendingNexts.keySet()) { |
Saurav Das | f14d9ef | 2017-12-05 15:00:23 -0800 | [diff] [blame] | 762 | List<PendingFlowObjective> pnext = pendingNexts.get(nextId); |
Saurav Das | 1547b3f | 2017-05-05 17:01:08 -0700 | [diff] [blame] | 763 | StringBuilder pend = new StringBuilder(); |
| 764 | pend.append("NextId: ") |
| 765 | .append(nextId); |
| 766 | for (PendingFlowObjective pn : pnext) { |
| 767 | pend.append("\n NextOp: ") |
| 768 | .append(pn.flowObjective().op()) |
Charles Chan | 5473471 | 2017-03-29 11:07:55 -0700 | [diff] [blame] | 769 | .append(", DeviceId: ") |
| 770 | .append(pn.deviceId()) |
Saurav Das | 1547b3f | 2017-05-05 17:01:08 -0700 | [diff] [blame] | 771 | .append(", Treatments: ") |
| 772 | .append(((NextObjective) pn.flowObjective()) |
| 773 | .next()); |
Saurav Das | b5c236e | 2016-06-07 10:08:06 -0700 | [diff] [blame] | 774 | } |
Saurav Das | 1547b3f | 2017-05-05 17:01:08 -0700 | [diff] [blame] | 775 | pendingFlowObjectives.add(pend.toString()); |
Saurav Das | b5c236e | 2016-06-07 10:08:06 -0700 | [diff] [blame] | 776 | } |
Saurav Das | 1547b3f | 2017-05-05 17:01:08 -0700 | [diff] [blame] | 777 | |
| 778 | return pendingFlowObjectives; |
| 779 | } |
alshabib | 77b8848 | 2015-04-07 15:47:50 -0700 | [diff] [blame] | 780 | } |