alshabib | 1d2bc40 | 2015-07-31 17:04:11 -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 | 1d2bc40 | 2015-07-31 17:04:11 -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 | */ |
Ray Milkey | ebdd485 | 2017-10-18 16:19:28 -0700 | [diff] [blame] | 16 | package org.onosproject.net.meter.impl; |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 17 | |
Gamze Abaka | f57ef60 | 2019-03-11 06:52:48 +0000 | [diff] [blame] | 18 | import org.onlab.util.Tools; |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 19 | import org.onlab.util.TriConsumer; |
Andrea Campanella | e370878 | 2017-10-16 16:00:21 +0200 | [diff] [blame] | 20 | import org.onosproject.cfg.ComponentConfigService; |
| 21 | import org.onosproject.mastership.MastershipService; |
Jian Li | 1932b93 | 2016-01-03 00:35:40 -0800 | [diff] [blame] | 22 | import org.onosproject.net.DeviceId; |
Gamze Abaka | f57ef60 | 2019-03-11 06:52:48 +0000 | [diff] [blame] | 23 | import org.onosproject.net.device.DeviceEvent; |
| 24 | import org.onosproject.net.device.DeviceListener; |
Andrea Campanella | e370878 | 2017-10-16 16:00:21 +0200 | [diff] [blame] | 25 | import org.onosproject.net.device.DeviceService; |
| 26 | import org.onosproject.net.driver.DriverService; |
alshabib | 10c810b | 2015-08-18 16:59:04 -0700 | [diff] [blame] | 27 | import org.onosproject.net.meter.DefaultMeter; |
| 28 | import org.onosproject.net.meter.Meter; |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 29 | import org.onosproject.net.meter.MeterCellId.MeterCellType; |
alshabib | 10c810b | 2015-08-18 16:59:04 -0700 | [diff] [blame] | 30 | import org.onosproject.net.meter.MeterEvent; |
| 31 | import org.onosproject.net.meter.MeterFailReason; |
Jordi Ortiz | aa8de49 | 2016-12-01 00:21:36 +0100 | [diff] [blame] | 32 | import org.onosproject.net.meter.MeterFeatures; |
alshabib | 10c810b | 2015-08-18 16:59:04 -0700 | [diff] [blame] | 33 | import org.onosproject.net.meter.MeterId; |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 34 | import org.onosproject.net.meter.MeterKey; |
alshabib | 10c810b | 2015-08-18 16:59:04 -0700 | [diff] [blame] | 35 | import org.onosproject.net.meter.MeterListener; |
| 36 | import org.onosproject.net.meter.MeterOperation; |
| 37 | import org.onosproject.net.meter.MeterProvider; |
| 38 | import org.onosproject.net.meter.MeterProviderRegistry; |
| 39 | import org.onosproject.net.meter.MeterProviderService; |
alshabib | e1248b6 | 2015-08-20 17:21:55 -0700 | [diff] [blame] | 40 | import org.onosproject.net.meter.MeterRequest; |
alshabib | 10c810b | 2015-08-18 16:59:04 -0700 | [diff] [blame] | 41 | import org.onosproject.net.meter.MeterService; |
| 42 | import org.onosproject.net.meter.MeterState; |
| 43 | import org.onosproject.net.meter.MeterStore; |
| 44 | import org.onosproject.net.meter.MeterStoreDelegate; |
| 45 | import org.onosproject.net.meter.MeterStoreResult; |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 46 | import org.onosproject.net.provider.AbstractListenerProviderRegistry; |
| 47 | import org.onosproject.net.provider.AbstractProviderService; |
Andrea Campanella | e370878 | 2017-10-16 16:00:21 +0200 | [diff] [blame] | 48 | import org.osgi.service.component.ComponentContext; |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 49 | import org.osgi.service.component.annotations.Activate; |
| 50 | import org.osgi.service.component.annotations.Component; |
| 51 | import org.osgi.service.component.annotations.Deactivate; |
| 52 | import org.osgi.service.component.annotations.Modified; |
| 53 | import org.osgi.service.component.annotations.Reference; |
| 54 | import org.osgi.service.component.annotations.ReferenceCardinality; |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 55 | import org.slf4j.Logger; |
| 56 | |
| 57 | import java.util.Collection; |
Andrea Campanella | e370878 | 2017-10-16 16:00:21 +0200 | [diff] [blame] | 58 | import java.util.Dictionary; |
alshabib | 5eb7939 | 2015-08-19 18:09:55 -0700 | [diff] [blame] | 59 | import java.util.Map; |
Jordi Ortiz | 31d4d38 | 2017-07-19 10:52:26 +0200 | [diff] [blame] | 60 | import java.util.concurrent.ExecutorService; |
alshabib | 5eb7939 | 2015-08-19 18:09:55 -0700 | [diff] [blame] | 61 | import java.util.stream.Collectors; |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 62 | |
Jordi Ortiz | 31d4d38 | 2017-07-19 10:52:26 +0200 | [diff] [blame] | 63 | import static com.google.common.base.Preconditions.checkNotNull; |
Andrea Campanella | e370878 | 2017-10-16 16:00:21 +0200 | [diff] [blame] | 64 | import static com.google.common.base.Strings.isNullOrEmpty; |
Jordi Ortiz | 31d4d38 | 2017-07-19 10:52:26 +0200 | [diff] [blame] | 65 | import static java.util.concurrent.Executors.newFixedThreadPool; |
Andrea Campanella | e370878 | 2017-10-16 16:00:21 +0200 | [diff] [blame] | 66 | import static org.onlab.util.Tools.get; |
Jordi Ortiz | 31d4d38 | 2017-07-19 10:52:26 +0200 | [diff] [blame] | 67 | import static org.onlab.util.Tools.groupedThreads; |
Ray Milkey | d04e227 | 2018-10-16 18:20:18 -0700 | [diff] [blame] | 68 | import static org.onosproject.net.OsgiPropertyConstants.MM_FALLBACK_METER_POLL_FREQUENCY; |
| 69 | import static org.onosproject.net.OsgiPropertyConstants.MM_FALLBACK_METER_POLL_FREQUENCY_DEFAULT; |
| 70 | import static org.onosproject.net.OsgiPropertyConstants.MM_NUM_THREADS; |
| 71 | import static org.onosproject.net.OsgiPropertyConstants.MM_NUM_THREADS_DEFAULT; |
Gamze Abaka | f57ef60 | 2019-03-11 06:52:48 +0000 | [diff] [blame] | 72 | import static org.onosproject.net.OsgiPropertyConstants.MM_PURGE_ON_DISCONNECTION; |
| 73 | import static org.onosproject.net.OsgiPropertyConstants.MM_PURGE_ON_DISCONNECTION_DEFAULT; |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 74 | import static org.slf4j.LoggerFactory.getLogger; |
| 75 | |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 76 | /** |
| 77 | * Provides implementation of the meter service APIs. |
| 78 | */ |
Ray Milkey | d04e227 | 2018-10-16 18:20:18 -0700 | [diff] [blame] | 79 | @Component( |
Gamze Abaka | f57ef60 | 2019-03-11 06:52:48 +0000 | [diff] [blame] | 80 | immediate = true, |
| 81 | service = { |
| 82 | MeterService.class, |
| 83 | MeterProviderRegistry.class |
| 84 | }, |
| 85 | property = { |
| 86 | MM_NUM_THREADS + ":Integer=" + MM_NUM_THREADS_DEFAULT, |
| 87 | MM_FALLBACK_METER_POLL_FREQUENCY + ":Integer=" + MM_FALLBACK_METER_POLL_FREQUENCY_DEFAULT, |
| 88 | MM_PURGE_ON_DISCONNECTION + ":Boolean=" + MM_PURGE_ON_DISCONNECTION_DEFAULT, |
| 89 | } |
Ray Milkey | d04e227 | 2018-10-16 18:20:18 -0700 | [diff] [blame] | 90 | ) |
Thomas Vachuska | 11b99fc | 2017-04-27 12:51:04 -0700 | [diff] [blame] | 91 | public class MeterManager |
| 92 | extends AbstractListenerProviderRegistry<MeterEvent, MeterListener, MeterProvider, MeterProviderService> |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 93 | implements MeterService, MeterProviderRegistry { |
| 94 | |
Jordi Ortiz | 31d4d38 | 2017-07-19 10:52:26 +0200 | [diff] [blame] | 95 | private static final String WORKER_PATTERN = "installer-%d"; |
| 96 | private static final String GROUP_THREAD_NAME = "onos/meter"; |
| 97 | |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 98 | private final Logger log = getLogger(getClass()); |
| 99 | private final MeterStoreDelegate delegate = new InternalMeterStoreDelegate(); |
Gamze Abaka | f57ef60 | 2019-03-11 06:52:48 +0000 | [diff] [blame] | 100 | private final DeviceListener deviceListener = new InternalDeviceListener(); |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 101 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 102 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 103 | private MeterStore store; |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 104 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 105 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
Andrea Campanella | e370878 | 2017-10-16 16:00:21 +0200 | [diff] [blame] | 106 | protected DriverService driverService; |
| 107 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 108 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
Andrea Campanella | e370878 | 2017-10-16 16:00:21 +0200 | [diff] [blame] | 109 | protected DeviceService deviceService; |
| 110 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 111 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
Andrea Campanella | e370878 | 2017-10-16 16:00:21 +0200 | [diff] [blame] | 112 | protected ComponentConfigService cfgService; |
| 113 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 114 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
Andrea Campanella | e370878 | 2017-10-16 16:00:21 +0200 | [diff] [blame] | 115 | protected MastershipService mastershipService; |
| 116 | |
Thomas Vachuska | f566fa2 | 2018-10-30 14:03:36 -0700 | [diff] [blame] | 117 | /** Number of worker threads. */ |
| 118 | private int numThreads = MM_NUM_THREADS_DEFAULT; |
| 119 | |
| 120 | /** Frequency (in seconds) for polling meters via fallback provider. */ |
Ray Milkey | d04e227 | 2018-10-16 18:20:18 -0700 | [diff] [blame] | 121 | private int fallbackMeterPollFrequency = MM_FALLBACK_METER_POLL_FREQUENCY_DEFAULT; |
Andrea Campanella | e370878 | 2017-10-16 16:00:21 +0200 | [diff] [blame] | 122 | |
Gamze Abaka | f57ef60 | 2019-03-11 06:52:48 +0000 | [diff] [blame] | 123 | /** Purge entries associated with a device when the device goes offline. */ |
| 124 | private boolean purgeOnDisconnection = MM_PURGE_ON_DISCONNECTION_DEFAULT; |
| 125 | |
alshabib | e1248b6 | 2015-08-20 17:21:55 -0700 | [diff] [blame] | 126 | private TriConsumer<MeterRequest, MeterStoreResult, Throwable> onComplete; |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 127 | |
Jordi Ortiz | 31d4d38 | 2017-07-19 10:52:26 +0200 | [diff] [blame] | 128 | private ExecutorService executorService; |
| 129 | |
Andrea Campanella | e370878 | 2017-10-16 16:00:21 +0200 | [diff] [blame] | 130 | private final MeterDriverProvider defaultProvider = new MeterDriverProvider(); |
| 131 | |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 132 | @Activate |
Andrea Campanella | e370878 | 2017-10-16 16:00:21 +0200 | [diff] [blame] | 133 | public void activate(ComponentContext context) { |
alshabib | 58fe6dc | 2015-08-19 17:16:13 -0700 | [diff] [blame] | 134 | store.setDelegate(delegate); |
Andrea Campanella | e370878 | 2017-10-16 16:00:21 +0200 | [diff] [blame] | 135 | cfgService.registerProperties(getClass()); |
Jordi Ortiz | 3a6f307 | 2016-11-07 10:23:48 +0100 | [diff] [blame] | 136 | eventDispatcher.addSink(MeterEvent.class, listenerRegistry); |
Gamze Abaka | f57ef60 | 2019-03-11 06:52:48 +0000 | [diff] [blame] | 137 | deviceService.addListener(deviceListener); |
alshabib | 58fe6dc | 2015-08-19 17:16:13 -0700 | [diff] [blame] | 138 | |
Jordi Ortiz | 3a6f307 | 2016-11-07 10:23:48 +0100 | [diff] [blame] | 139 | onComplete = (request, result, error) -> { |
alshabib | e1248b6 | 2015-08-20 17:21:55 -0700 | [diff] [blame] | 140 | request.context().ifPresent(c -> { |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 141 | if (error != null) { |
alshabib | e1248b6 | 2015-08-20 17:21:55 -0700 | [diff] [blame] | 142 | c.onError(request, MeterFailReason.UNKNOWN); |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 143 | } else { |
| 144 | if (result.reason().isPresent()) { |
alshabib | e1248b6 | 2015-08-20 17:21:55 -0700 | [diff] [blame] | 145 | c.onError(request, result.reason().get()); |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 146 | } else { |
alshabib | e1248b6 | 2015-08-20 17:21:55 -0700 | [diff] [blame] | 147 | c.onSuccess(request); |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 148 | } |
| 149 | } |
| 150 | }); |
| 151 | |
Frank Wang | d7e3b4b | 2017-09-24 13:37:54 +0900 | [diff] [blame] | 152 | }; |
Jordi Ortiz | 31d4d38 | 2017-07-19 10:52:26 +0200 | [diff] [blame] | 153 | |
Thomas Vachuska | f566fa2 | 2018-10-30 14:03:36 -0700 | [diff] [blame] | 154 | modified(context); |
Jordi Ortiz | 31d4d38 | 2017-07-19 10:52:26 +0200 | [diff] [blame] | 155 | executorService = newFixedThreadPool(numThreads, |
Frank Wang | d7e3b4b | 2017-09-24 13:37:54 +0900 | [diff] [blame] | 156 | groupedThreads(GROUP_THREAD_NAME, WORKER_PATTERN, log)); |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 157 | log.info("Started"); |
| 158 | } |
| 159 | |
Andrea Campanella | e370878 | 2017-10-16 16:00:21 +0200 | [diff] [blame] | 160 | @Modified |
| 161 | public void modified(ComponentContext context) { |
| 162 | if (context != null) { |
| 163 | readComponentConfiguration(context); |
| 164 | } |
| 165 | defaultProvider.init(deviceService, createProviderService(defaultProvider), |
Frank Wang | d7e3b4b | 2017-09-24 13:37:54 +0900 | [diff] [blame] | 166 | mastershipService, fallbackMeterPollFrequency); |
Andrea Campanella | e370878 | 2017-10-16 16:00:21 +0200 | [diff] [blame] | 167 | } |
| 168 | |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 169 | @Deactivate |
| 170 | public void deactivate() { |
Andrea Campanella | e370878 | 2017-10-16 16:00:21 +0200 | [diff] [blame] | 171 | defaultProvider.terminate(); |
alshabib | 58fe6dc | 2015-08-19 17:16:13 -0700 | [diff] [blame] | 172 | store.unsetDelegate(delegate); |
Thomas Vachuska | 11b99fc | 2017-04-27 12:51:04 -0700 | [diff] [blame] | 173 | eventDispatcher.removeSink(MeterEvent.class); |
Gamze Abaka | f57ef60 | 2019-03-11 06:52:48 +0000 | [diff] [blame] | 174 | deviceService.removeListener(deviceListener); |
Andrea Campanella | e370878 | 2017-10-16 16:00:21 +0200 | [diff] [blame] | 175 | cfgService.unregisterProperties(getClass(), false); |
Jordi Ortiz | 31d4d38 | 2017-07-19 10:52:26 +0200 | [diff] [blame] | 176 | executorService.shutdown(); |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 177 | log.info("Stopped"); |
| 178 | } |
| 179 | |
Andrea Campanella | e370878 | 2017-10-16 16:00:21 +0200 | [diff] [blame] | 180 | /** |
| 181 | * Extracts properties from the component configuration context. |
| 182 | * |
| 183 | * @param context the component context |
| 184 | */ |
| 185 | private void readComponentConfiguration(ComponentContext context) { |
| 186 | Dictionary<?, ?> properties = context.getProperties(); |
Gamze Abaka | f57ef60 | 2019-03-11 06:52:48 +0000 | [diff] [blame] | 187 | Boolean flag; |
| 188 | |
| 189 | flag = Tools.isPropertyEnabled(properties, MM_PURGE_ON_DISCONNECTION); |
| 190 | if (flag == null) { |
| 191 | log.info("PurgeOnDisconnection is not configured," + |
| 192 | "using current value of {}", purgeOnDisconnection); |
| 193 | } else { |
| 194 | purgeOnDisconnection = flag; |
| 195 | log.info("Configured. PurgeOnDisconnection is {}", |
| 196 | purgeOnDisconnection ? "enabled" : "disabled"); |
| 197 | } |
Andrea Campanella | e370878 | 2017-10-16 16:00:21 +0200 | [diff] [blame] | 198 | |
Thomas Vachuska | f566fa2 | 2018-10-30 14:03:36 -0700 | [diff] [blame] | 199 | String s = get(properties, MM_FALLBACK_METER_POLL_FREQUENCY); |
Andrea Campanella | e370878 | 2017-10-16 16:00:21 +0200 | [diff] [blame] | 200 | try { |
Ray Milkey | d04e227 | 2018-10-16 18:20:18 -0700 | [diff] [blame] | 201 | fallbackMeterPollFrequency = isNullOrEmpty(s) ? |
| 202 | MM_FALLBACK_METER_POLL_FREQUENCY_DEFAULT : Integer.parseInt(s); |
Andrea Campanella | e370878 | 2017-10-16 16:00:21 +0200 | [diff] [blame] | 203 | } catch (NumberFormatException e) { |
Ray Milkey | d04e227 | 2018-10-16 18:20:18 -0700 | [diff] [blame] | 204 | fallbackMeterPollFrequency = MM_FALLBACK_METER_POLL_FREQUENCY_DEFAULT; |
Andrea Campanella | e370878 | 2017-10-16 16:00:21 +0200 | [diff] [blame] | 205 | } |
Thomas Vachuska | f566fa2 | 2018-10-30 14:03:36 -0700 | [diff] [blame] | 206 | |
| 207 | s = get(properties, MM_NUM_THREADS); |
| 208 | try { |
| 209 | numThreads = isNullOrEmpty(s) ? MM_NUM_THREADS_DEFAULT : Integer.parseInt(s); |
| 210 | } catch (NumberFormatException e) { |
| 211 | numThreads = MM_NUM_THREADS_DEFAULT; |
| 212 | } |
Andrea Campanella | e370878 | 2017-10-16 16:00:21 +0200 | [diff] [blame] | 213 | } |
| 214 | |
| 215 | @Override |
| 216 | protected MeterProvider defaultProvider() { |
| 217 | return defaultProvider; |
| 218 | } |
| 219 | |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 220 | @Override |
| 221 | protected MeterProviderService createProviderService(MeterProvider provider) { |
| 222 | return new InternalMeterProviderService(provider); |
| 223 | } |
| 224 | |
| 225 | @Override |
alshabib | e1248b6 | 2015-08-20 17:21:55 -0700 | [diff] [blame] | 226 | public Meter submit(MeterRequest request) { |
柯志勇10068695 | d709dba | 2018-10-23 18:35:49 +0800 | [diff] [blame] | 227 | checkNotNull(request, "request cannot be null."); |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 228 | MeterId id = allocateMeterId(request.deviceId()); |
| 229 | |
alshabib | e1248b6 | 2015-08-20 17:21:55 -0700 | [diff] [blame] | 230 | Meter.Builder mBuilder = DefaultMeter.builder() |
| 231 | .forDevice(request.deviceId()) |
| 232 | .fromApp(request.appId()) |
| 233 | .withBands(request.bands()) |
Gamze Abaka | 65f27f1 | 2018-07-09 06:40:24 +0000 | [diff] [blame] | 234 | .withCellId(id) |
alshabib | e1248b6 | 2015-08-20 17:21:55 -0700 | [diff] [blame] | 235 | .withUnit(request.unit()); |
| 236 | |
| 237 | if (request.isBurst()) { |
| 238 | mBuilder.burst(); |
| 239 | } |
| 240 | DefaultMeter m = (DefaultMeter) mBuilder.build(); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 241 | m.setState(MeterState.PENDING_ADD); |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 242 | store.storeMeter(m).whenComplete((result, error) -> |
alshabib | e1248b6 | 2015-08-20 17:21:55 -0700 | [diff] [blame] | 243 | onComplete.accept(request, result, error)); |
| 244 | return m; |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 245 | } |
| 246 | |
| 247 | @Override |
alshabib | e1248b6 | 2015-08-20 17:21:55 -0700 | [diff] [blame] | 248 | public void withdraw(MeterRequest request, MeterId meterId) { |
柯志勇10068695 | d709dba | 2018-10-23 18:35:49 +0800 | [diff] [blame] | 249 | checkNotNull(request, "request cannot be null."); |
alshabib | e1248b6 | 2015-08-20 17:21:55 -0700 | [diff] [blame] | 250 | Meter.Builder mBuilder = DefaultMeter.builder() |
| 251 | .forDevice(request.deviceId()) |
| 252 | .fromApp(request.appId()) |
| 253 | .withBands(request.bands()) |
Gamze Abaka | 65f27f1 | 2018-07-09 06:40:24 +0000 | [diff] [blame] | 254 | .withCellId(meterId) |
alshabib | e1248b6 | 2015-08-20 17:21:55 -0700 | [diff] [blame] | 255 | .withUnit(request.unit()); |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 256 | |
alshabib | e1248b6 | 2015-08-20 17:21:55 -0700 | [diff] [blame] | 257 | if (request.isBurst()) { |
| 258 | mBuilder.burst(); |
| 259 | } |
| 260 | |
| 261 | DefaultMeter m = (DefaultMeter) mBuilder.build(); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 262 | m.setState(MeterState.PENDING_REMOVE); |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 263 | store.deleteMeter(m).whenComplete((result, error) -> |
alshabib | e1248b6 | 2015-08-20 17:21:55 -0700 | [diff] [blame] | 264 | onComplete.accept(request, result, error)); |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 265 | } |
| 266 | |
| 267 | @Override |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 268 | public Meter getMeter(DeviceId deviceId, MeterId id) { |
| 269 | MeterKey key = MeterKey.key(deviceId, id); |
| 270 | return store.getMeter(key); |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 271 | } |
| 272 | |
| 273 | @Override |
Jian Li | 1932b93 | 2016-01-03 00:35:40 -0800 | [diff] [blame] | 274 | public Collection<Meter> getMeters(DeviceId deviceId) { |
| 275 | return store.getAllMeters().stream().filter(m -> |
| 276 | m.deviceId().equals(deviceId)).collect(Collectors.toList()); |
| 277 | } |
| 278 | |
| 279 | @Override |
alshabib | 58fe6dc | 2015-08-19 17:16:13 -0700 | [diff] [blame] | 280 | public Collection<Meter> getAllMeters() { |
| 281 | return store.getAllMeters(); |
| 282 | } |
| 283 | |
Pier Luigi | bdcd967 | 2017-10-13 13:54:48 +0200 | [diff] [blame] | 284 | @Override |
| 285 | public MeterId allocateMeterId(DeviceId deviceId) { |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 286 | // We delegate direclty to the store |
| 287 | return store.allocateMeterId(deviceId); |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 288 | } |
| 289 | |
Pier Luigi | bdcd967 | 2017-10-13 13:54:48 +0200 | [diff] [blame] | 290 | @Override |
| 291 | public void freeMeterId(DeviceId deviceId, MeterId meterId) { |
| 292 | // We delegate direclty to the store |
| 293 | store.freeMeterId(deviceId, meterId); |
| 294 | } |
| 295 | |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 296 | private class InternalMeterProviderService |
| 297 | extends AbstractProviderService<MeterProvider> |
| 298 | implements MeterProviderService { |
| 299 | |
| 300 | /** |
| 301 | * Creates a provider service on behalf of the specified provider. |
| 302 | * |
| 303 | * @param provider provider to which this service is being issued |
| 304 | */ |
| 305 | protected InternalMeterProviderService(MeterProvider provider) { |
| 306 | super(provider); |
| 307 | } |
| 308 | |
| 309 | @Override |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 310 | public void meterOperationFailed(MeterOperation operation, |
| 311 | MeterFailReason reason) { |
| 312 | store.failedMeter(operation, reason); |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 313 | } |
| 314 | |
| 315 | @Override |
| 316 | public void pushMeterMetrics(DeviceId deviceId, Collection<Meter> meterEntries) { |
Jordi Ortiz | 9287b63 | 2017-06-22 11:01:37 +0200 | [diff] [blame] | 317 | Collection<Meter> allMeters = store.getAllMeters(deviceId); |
alshabib | 5eb7939 | 2015-08-19 18:09:55 -0700 | [diff] [blame] | 318 | |
Jordi Ortiz | 5889691 | 2017-03-06 14:51:05 +0100 | [diff] [blame] | 319 | Map<MeterId, Meter> meterEntriesMap = meterEntries.stream() |
| 320 | .collect(Collectors.toMap(Meter::id, Meter -> Meter)); |
| 321 | |
Jordi Ortiz | 205af45 | 2017-06-22 14:25:04 +0200 | [diff] [blame] | 322 | // Look for meters defined in onos and missing in the device (restore) |
Jordi Ortiz | 9287b63 | 2017-06-22 11:01:37 +0200 | [diff] [blame] | 323 | allMeters.stream().forEach(m -> { |
| 324 | if ((m.state().equals(MeterState.PENDING_ADD) || |
| 325 | m.state().equals(MeterState.ADDED)) && |
| 326 | !meterEntriesMap.containsKey(m.id())) { |
Jordi Ortiz | 5889691 | 2017-03-06 14:51:05 +0100 | [diff] [blame] | 327 | // The meter is missing in the device. Reinstall! |
Jordi Ortiz | 205af45 | 2017-06-22 14:25:04 +0200 | [diff] [blame] | 328 | log.debug("Adding meter missing in device {} {}", deviceId, m); |
Jordi Ortiz | 5889691 | 2017-03-06 14:51:05 +0100 | [diff] [blame] | 329 | provider().performMeterOperation(deviceId, |
Frank Wang | d7e3b4b | 2017-09-24 13:37:54 +0900 | [diff] [blame] | 330 | new MeterOperation(m, MeterOperation.Type.ADD)); |
Jordi Ortiz | 5889691 | 2017-03-06 14:51:05 +0100 | [diff] [blame] | 331 | } |
Jordi Ortiz | 5889691 | 2017-03-06 14:51:05 +0100 | [diff] [blame] | 332 | }); |
| 333 | |
Jordi Ortiz | 205af45 | 2017-06-22 14:25:04 +0200 | [diff] [blame] | 334 | // Look for meters defined in the device and not in onos (remove) |
| 335 | meterEntriesMap.entrySet().stream() |
| 336 | .filter(md -> !allMeters.stream().anyMatch(m -> m.id().equals(md.getKey()))) |
| 337 | .forEach(mio -> { |
Jordi Ortiz | 205af45 | 2017-06-22 14:25:04 +0200 | [diff] [blame] | 338 | Meter meter = mio.getValue(); |
Frank Wang | d7e3b4b | 2017-09-24 13:37:54 +0900 | [diff] [blame] | 339 | // FIXME: Removing a meter is meaningfull for OpenFlow, but not for P4Runtime. |
| 340 | // In P4Runtime meter cells cannot be removed. For the |
| 341 | // moment, we make the distinction between OpenFlow and |
| 342 | // P4Runtime by looking at the MeterCellType (always |
| 343 | // INDEX for OpenFlow). |
| 344 | if (meter.meterCellId().type() == MeterCellType.INDEX) { |
| 345 | // The meter is missing in onos. Uninstall! |
| 346 | log.debug("Remove meter in device not in onos {} {}", deviceId, mio.getKey()); |
| 347 | provider().performMeterOperation(deviceId, |
| 348 | new MeterOperation(meter, MeterOperation.Type.REMOVE)); |
| 349 | } |
| 350 | }); |
Jordi Ortiz | 205af45 | 2017-06-22 14:25:04 +0200 | [diff] [blame] | 351 | |
alshabib | 5eb7939 | 2015-08-19 18:09:55 -0700 | [diff] [blame] | 352 | meterEntries.stream() |
Jordi Ortiz | 9287b63 | 2017-06-22 11:01:37 +0200 | [diff] [blame] | 353 | .filter(m -> allMeters.stream() |
| 354 | .anyMatch(sm -> sm.deviceId().equals(deviceId) && sm.id().equals(m.id()))) |
alshabib | 5eb7939 | 2015-08-19 18:09:55 -0700 | [diff] [blame] | 355 | .forEach(m -> store.updateMeterState(m)); |
| 356 | |
Jordi Ortiz | 9287b63 | 2017-06-22 11:01:37 +0200 | [diff] [blame] | 357 | allMeters.forEach(m -> { |
alshabib | 5eb7939 | 2015-08-19 18:09:55 -0700 | [diff] [blame] | 358 | if (m.state() == MeterState.PENDING_ADD) { |
| 359 | provider().performMeterOperation(m.deviceId(), |
| 360 | new MeterOperation(m, |
Konstantinos Kanonakis | a45755d | 2016-03-14 11:31:23 -0500 | [diff] [blame] | 361 | MeterOperation.Type.MODIFY)); |
| 362 | } else if (m.state() == MeterState.PENDING_REMOVE) { |
alshabib | 5eb7939 | 2015-08-19 18:09:55 -0700 | [diff] [blame] | 363 | store.deleteMeterNow(m); |
| 364 | } |
| 365 | }); |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 366 | } |
Jordi Ortiz | aa8de49 | 2016-12-01 00:21:36 +0100 | [diff] [blame] | 367 | |
| 368 | @Override |
| 369 | public void pushMeterFeatures(DeviceId deviceId, MeterFeatures meterfeatures) { |
| 370 | store.storeMeterFeatures(meterfeatures); |
| 371 | } |
| 372 | |
| 373 | @Override |
| 374 | public void deleteMeterFeatures(DeviceId deviceId) { |
| 375 | store.deleteMeterFeatures(deviceId); |
| 376 | } |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 377 | } |
| 378 | |
| 379 | private class InternalMeterStoreDelegate implements MeterStoreDelegate { |
| 380 | |
| 381 | @Override |
| 382 | public void notify(MeterEvent event) { |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 383 | DeviceId deviceId = event.subject().deviceId(); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 384 | switch (event.type()) { |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 385 | case METER_ADD_REQ: |
Jordi Ortiz | 31d4d38 | 2017-07-19 10:52:26 +0200 | [diff] [blame] | 386 | executorService.execute(new MeterInstaller(deviceId, event.subject(), |
Frank Wang | d7e3b4b | 2017-09-24 13:37:54 +0900 | [diff] [blame] | 387 | MeterOperation.Type.ADD)); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 388 | break; |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 389 | case METER_REM_REQ: |
Jordi Ortiz | 31d4d38 | 2017-07-19 10:52:26 +0200 | [diff] [blame] | 390 | executorService.execute(new MeterInstaller(deviceId, event.subject(), |
Frank Wang | d7e3b4b | 2017-09-24 13:37:54 +0900 | [diff] [blame] | 391 | MeterOperation.Type.REMOVE)); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 392 | break; |
Jordi Ortiz | df28ecd | 2017-03-25 19:22:36 +0100 | [diff] [blame] | 393 | case METER_ADDED: |
| 394 | log.info("Meter added {}", event.subject()); |
Jordi Ortiz | e165e1d | 2017-07-14 14:46:33 +0200 | [diff] [blame] | 395 | post(new MeterEvent(MeterEvent.Type.METER_ADDED, event.subject())); |
Jordi Ortiz | df28ecd | 2017-03-25 19:22:36 +0100 | [diff] [blame] | 396 | break; |
| 397 | case METER_REMOVED: |
| 398 | log.info("Meter removed {}", event.subject()); |
Jordi Ortiz | e165e1d | 2017-07-14 14:46:33 +0200 | [diff] [blame] | 399 | post(new MeterEvent(MeterEvent.Type.METER_REMOVED, event.subject())); |
Jordi Ortiz | df28ecd | 2017-03-25 19:22:36 +0100 | [diff] [blame] | 400 | break; |
Gamze Abaka | dadae72 | 2018-09-12 10:55:35 +0000 | [diff] [blame] | 401 | case METER_REFERENCE_COUNT_ZERO: |
Gamze Abaka | 6c8a71b | 2018-12-24 13:17:12 +0000 | [diff] [blame] | 402 | log.debug("Meter reference count zero {}", event.subject()); |
Gamze Abaka | dadae72 | 2018-09-12 10:55:35 +0000 | [diff] [blame] | 403 | post(new MeterEvent(MeterEvent.Type.METER_REFERENCE_COUNT_ZERO, event.subject())); |
| 404 | break; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 405 | default: |
| 406 | log.warn("Unknown meter event {}", event.type()); |
| 407 | } |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 408 | |
| 409 | } |
| 410 | } |
Jordi Ortiz | 31d4d38 | 2017-07-19 10:52:26 +0200 | [diff] [blame] | 411 | /** |
| 412 | * Task that passes the meter down to the provider. |
| 413 | */ |
| 414 | private class MeterInstaller implements Runnable { |
| 415 | private final DeviceId deviceId; |
| 416 | private final Meter meter; |
| 417 | private final MeterOperation.Type op; |
| 418 | |
| 419 | public MeterInstaller(DeviceId deviceId, Meter meter, MeterOperation.Type op) { |
| 420 | this.deviceId = checkNotNull(deviceId); |
| 421 | this.meter = checkNotNull(meter); |
| 422 | this.op = checkNotNull(op); |
| 423 | } |
| 424 | |
| 425 | @Override |
| 426 | public void run() { |
| 427 | MeterProvider p = getProvider(this.deviceId); |
| 428 | if (p == null) { |
| 429 | log.error("Unable to recover {}'s provider", deviceId); |
| 430 | return; |
| 431 | } |
| 432 | p.performMeterOperation(deviceId, new MeterOperation(meter, op)); |
| 433 | } |
| 434 | } |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 435 | |
Gamze Abaka | f57ef60 | 2019-03-11 06:52:48 +0000 | [diff] [blame] | 436 | private class InternalDeviceListener implements DeviceListener { |
| 437 | |
| 438 | @Override |
| 439 | public void event(DeviceEvent event) { |
| 440 | switch (event.type()) { |
| 441 | case DEVICE_REMOVED: |
| 442 | case DEVICE_AVAILABILITY_CHANGED: |
| 443 | DeviceId deviceId = event.subject().id(); |
| 444 | if (!deviceService.isAvailable(deviceId)) { |
| 445 | if (purgeOnDisconnection) { |
| 446 | store.purgeMeter(deviceId); |
| 447 | } |
| 448 | } |
| 449 | break; |
| 450 | default: |
| 451 | break; |
| 452 | } |
| 453 | } |
| 454 | } |
| 455 | |
alshabib | 1d2bc40 | 2015-07-31 17:04:11 -0700 | [diff] [blame] | 456 | } |