Andrea Campanella | e72ac55 | 2016-04-11 10:04:52 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2016-present Open Networking Foundation |
Andrea Campanella | e72ac55 | 2016-04-11 10:04:52 -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 | */ |
Andrea Campanella | 637c807 | 2016-04-12 17:29:17 -0700 | [diff] [blame] | 16 | package org.onosproject.faultmanagement.impl; |
Andrea Campanella | e72ac55 | 2016-04-11 10:04:52 -0700 | [diff] [blame] | 17 | |
| 18 | import org.apache.felix.scr.annotations.Activate; |
| 19 | import org.apache.felix.scr.annotations.Component; |
| 20 | import org.apache.felix.scr.annotations.Deactivate; |
| 21 | import org.apache.felix.scr.annotations.Modified; |
| 22 | import org.apache.felix.scr.annotations.Property; |
| 23 | import org.apache.felix.scr.annotations.Reference; |
| 24 | import org.apache.felix.scr.annotations.ReferenceCardinality; |
fahadnaeemkhan | 8ee2be9 | 2018-02-08 17:42:08 -0800 | [diff] [blame] | 25 | import org.onosproject.cfg.ComponentConfigService; |
Andrea Campanella | e72ac55 | 2016-04-11 10:04:52 -0700 | [diff] [blame] | 26 | import org.onosproject.incubator.net.faultmanagement.alarm.AlarmConsumer; |
| 27 | import org.onosproject.incubator.net.faultmanagement.alarm.AlarmProvider; |
| 28 | import org.onosproject.incubator.net.faultmanagement.alarm.AlarmProviderRegistry; |
| 29 | import org.onosproject.incubator.net.faultmanagement.alarm.AlarmProviderService; |
| 30 | import org.onosproject.mastership.MastershipEvent; |
| 31 | import org.onosproject.mastership.MastershipListener; |
| 32 | import org.onosproject.mastership.MastershipService; |
| 33 | import org.onosproject.net.Device; |
| 34 | import org.onosproject.net.DeviceId; |
| 35 | import org.onosproject.net.device.DeviceEvent; |
| 36 | import org.onosproject.net.device.DeviceListener; |
| 37 | import org.onosproject.net.device.DeviceService; |
| 38 | import org.onosproject.net.provider.AbstractProvider; |
| 39 | import org.onosproject.net.provider.ProviderId; |
| 40 | import org.osgi.service.component.ComponentContext; |
| 41 | import org.slf4j.Logger; |
| 42 | |
| 43 | import java.util.Dictionary; |
| 44 | import java.util.concurrent.ExecutorService; |
| 45 | import java.util.concurrent.Executors; |
| 46 | import java.util.concurrent.ScheduledExecutorService; |
| 47 | import java.util.concurrent.ScheduledFuture; |
| 48 | import java.util.concurrent.TimeUnit; |
| 49 | |
| 50 | import static com.google.common.base.Strings.isNullOrEmpty; |
Yuta HIGUCHI | 1624df1 | 2016-07-21 16:54:33 -0700 | [diff] [blame] | 51 | import static java.util.concurrent.Executors.newScheduledThreadPool; |
Andrea Campanella | e72ac55 | 2016-04-11 10:04:52 -0700 | [diff] [blame] | 52 | import static org.onlab.util.Tools.get; |
| 53 | import static org.onlab.util.Tools.groupedThreads; |
| 54 | import static org.slf4j.LoggerFactory.getLogger; |
| 55 | |
| 56 | /** |
| 57 | * Alarm provider capable of polling the environment using the device driver |
| 58 | * {@link AlarmConsumer} behaviour. |
| 59 | */ |
| 60 | @Component(immediate = true) |
| 61 | public class PollingAlarmProvider extends AbstractProvider implements AlarmProvider { |
| 62 | |
| 63 | private final Logger log = getLogger(getClass()); |
| 64 | |
| 65 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 66 | protected DeviceService deviceService; |
| 67 | |
| 68 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 69 | protected MastershipService mastershipService; |
| 70 | |
| 71 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 72 | protected AlarmProviderRegistry providerRegistry; |
| 73 | |
fahadnaeemkhan | 8ee2be9 | 2018-02-08 17:42:08 -0800 | [diff] [blame] | 74 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 75 | protected ComponentConfigService cfgService; |
| 76 | |
Andrea Campanella | e72ac55 | 2016-04-11 10:04:52 -0700 | [diff] [blame] | 77 | protected AlarmProviderService providerService; |
| 78 | |
| 79 | protected ScheduledExecutorService alarmsExecutor; |
| 80 | |
| 81 | private ScheduledFuture<?> scheduledTask; |
| 82 | |
| 83 | private ExecutorService eventHandlingExecutor; |
| 84 | |
| 85 | protected final MastershipListener mastershipListener = new InternalMastershipListener(); |
| 86 | |
| 87 | protected final DeviceListener deviceListener = new InternalDeviceListener(); |
| 88 | |
| 89 | private static final int CORE_POOL_SIZE = 10; |
| 90 | |
| 91 | private static final int DEFAULT_POLL_FREQUENCY_SECONDS = 60; |
| 92 | @Property(name = "alarmPollFrequencySeconds", intValue = DEFAULT_POLL_FREQUENCY_SECONDS, |
| 93 | label = "Frequency (in seconds) for polling alarm from devices") |
| 94 | protected int alarmPollFrequencySeconds = DEFAULT_POLL_FREQUENCY_SECONDS; |
| 95 | |
| 96 | // TODO implement purging of old alarms. |
| 97 | private static final int DEFAULT_CLEAR_FREQUENCY_SECONDS = 500; |
| 98 | @Property(name = "clearedAlarmPurgeSeconds", intValue = DEFAULT_CLEAR_FREQUENCY_SECONDS, |
| 99 | label = "Frequency (in seconds) for deleting cleared alarms") |
| 100 | private int clearedAlarmPurgeFrequencySeconds = DEFAULT_CLEAR_FREQUENCY_SECONDS; |
| 101 | |
| 102 | public PollingAlarmProvider() { |
| 103 | super(new ProviderId("default", "org.onosproject.core")); |
| 104 | } |
| 105 | |
| 106 | @Activate |
| 107 | public void activate(ComponentContext context) { |
fahadnaeemkhan | 8ee2be9 | 2018-02-08 17:42:08 -0800 | [diff] [blame] | 108 | cfgService.registerProperties(getClass()); |
Yuta HIGUCHI | 1624df1 | 2016-07-21 16:54:33 -0700 | [diff] [blame] | 109 | alarmsExecutor = newScheduledThreadPool(CORE_POOL_SIZE, |
| 110 | groupedThreads("onos/pollingalarmprovider", |
| 111 | "alarm-executor-%d", log)); |
Andrea Campanella | e72ac55 | 2016-04-11 10:04:52 -0700 | [diff] [blame] | 112 | eventHandlingExecutor = |
| 113 | Executors.newFixedThreadPool(CORE_POOL_SIZE, |
| 114 | groupedThreads("onos/pollingalarmprovider", |
| 115 | "device-installer-%d", log)); |
| 116 | |
| 117 | providerService = providerRegistry.register(this); |
| 118 | |
| 119 | deviceService.addListener(deviceListener); |
| 120 | mastershipService.addListener(mastershipListener); |
| 121 | |
| 122 | if (context == null) { |
| 123 | alarmPollFrequencySeconds = DEFAULT_POLL_FREQUENCY_SECONDS; |
| 124 | log.info("No component configuration"); |
| 125 | } else { |
| 126 | Dictionary<?, ?> properties = context.getProperties(); |
| 127 | alarmPollFrequencySeconds = getNewPollFrequency(properties, alarmPollFrequencySeconds); |
| 128 | } |
| 129 | scheduledTask = schedulePolling(); |
| 130 | log.info("Started"); |
| 131 | } |
| 132 | |
| 133 | @Deactivate |
| 134 | public void deactivate() { |
fahadnaeemkhan | 8ee2be9 | 2018-02-08 17:42:08 -0800 | [diff] [blame] | 135 | cfgService.unregisterProperties(getClass(), false); |
Andrea Campanella | e72ac55 | 2016-04-11 10:04:52 -0700 | [diff] [blame] | 136 | providerRegistry.unregister(this); |
| 137 | mastershipService.removeListener(mastershipListener); |
| 138 | deviceService.removeListener(deviceListener); |
| 139 | alarmsExecutor.shutdown(); |
| 140 | providerService = null; |
| 141 | log.info("Stopped"); |
| 142 | } |
| 143 | |
| 144 | @Modified |
| 145 | public void modified(ComponentContext context) { |
| 146 | if (context == null) { |
| 147 | log.info("No component configuration"); |
| 148 | return; |
| 149 | } |
| 150 | |
| 151 | Dictionary<?, ?> properties = context.getProperties(); |
| 152 | int newPollFrequency = getNewPollFrequency(properties, alarmPollFrequencySeconds); |
| 153 | if (newPollFrequency != alarmPollFrequencySeconds) { |
| 154 | alarmPollFrequencySeconds = newPollFrequency; |
| 155 | //stops the old scheduled task |
| 156 | scheduledTask.cancel(true); |
| 157 | //schedules new task at the new polling rate |
| 158 | scheduledTask = schedulePolling(); |
| 159 | } |
| 160 | } |
| 161 | |
| 162 | private ScheduledFuture schedulePolling() { |
| 163 | return alarmsExecutor.scheduleAtFixedRate(this::consumeAlarms, |
| 164 | alarmPollFrequencySeconds / 4, alarmPollFrequencySeconds, |
| 165 | TimeUnit.SECONDS); |
| 166 | } |
| 167 | |
| 168 | private int getNewPollFrequency(Dictionary<?, ?> properties, int pollFrequency) { |
| 169 | int newPollFrequency; |
| 170 | try { |
| 171 | String s = get(properties, "pollFrequency"); |
| 172 | newPollFrequency = isNullOrEmpty(s) ? pollFrequency : Integer.parseInt(s.trim()); |
| 173 | } catch (NumberFormatException | ClassCastException e) { |
| 174 | newPollFrequency = DEFAULT_POLL_FREQUENCY_SECONDS; |
| 175 | } |
| 176 | return newPollFrequency; |
| 177 | } |
| 178 | |
| 179 | @Override |
| 180 | public void triggerProbe(DeviceId deviceId) { |
| 181 | if (mastershipService.isLocalMaster(deviceId)) { |
| 182 | triggerProbe(deviceService.getDevice(deviceId)); |
| 183 | } |
| 184 | } |
| 185 | |
| 186 | private void triggerProbe(Device device) { |
| 187 | alarmsExecutor.submit(() -> consumeAlarms(device)); |
| 188 | } |
| 189 | |
| 190 | private void consumeAlarms() { |
| 191 | deviceService.getAvailableDevices().forEach(device -> { |
| 192 | if (mastershipService.isLocalMaster(device.id())) { |
| 193 | consumeAlarms(device); |
| 194 | } |
| 195 | }); |
| 196 | } |
| 197 | |
| 198 | private void consumeAlarms(Device device) { |
| 199 | if (device.is(AlarmConsumer.class)) { |
| 200 | providerService.updateAlarmList(device.id(), |
| 201 | device.as(AlarmConsumer.class).consumeAlarms()); |
| 202 | } else { |
Michele Santuari | 2cf8429 | 2016-08-12 11:56:48 +0200 | [diff] [blame] | 203 | log.debug("Device {} does not support alarm consumer behaviour", device.id()); |
Andrea Campanella | e72ac55 | 2016-04-11 10:04:52 -0700 | [diff] [blame] | 204 | } |
| 205 | } |
| 206 | |
| 207 | private class InternalMastershipListener implements MastershipListener { |
| 208 | |
| 209 | @Override |
| 210 | public boolean isRelevant(MastershipEvent event) { |
| 211 | return mastershipService.isLocalMaster(event.subject()); |
| 212 | } |
| 213 | |
| 214 | @Override |
| 215 | public void event(MastershipEvent event) { |
| 216 | triggerProbe(event.subject()); |
| 217 | } |
| 218 | } |
| 219 | |
| 220 | /** |
| 221 | * Internal listener for device service events. |
| 222 | */ |
| 223 | private class InternalDeviceListener implements DeviceListener { |
| 224 | |
| 225 | @Override |
| 226 | public boolean isRelevant(DeviceEvent event) { |
| 227 | return event.type().equals(DeviceEvent.Type.DEVICE_AVAILABILITY_CHANGED) |
| 228 | && deviceService.isAvailable(event.subject().id()); |
| 229 | } |
| 230 | |
| 231 | @Override |
| 232 | public void event(DeviceEvent event) { |
| 233 | log.debug("InternalDeviceListener has got event from device-service{} with ", event); |
| 234 | eventHandlingExecutor.execute(() -> triggerProbe(event.subject().id())); |
| 235 | } |
| 236 | |
| 237 | } |
| 238 | } |