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