Andrea Campanella | 6ee7392 | 2016-02-03 18:00:00 -0800 | [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 | 6ee7392 | 2016-02-03 18:00:00 -0800 | [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 | |
| 17 | package org.onosproject.net.group.impl; |
| 18 | |
Andrea Campanella | 1ea1510 | 2017-09-04 16:00:09 +0200 | [diff] [blame] | 19 | import com.google.common.collect.Sets; |
| 20 | import org.onosproject.mastership.MastershipService; |
Andrea Campanella | e427390 | 2016-02-08 13:43:30 -0800 | [diff] [blame] | 21 | import org.onosproject.net.Device; |
Andrea Campanella | 6ee7392 | 2016-02-03 18:00:00 -0800 | [diff] [blame] | 22 | import org.onosproject.net.DeviceId; |
Andrea Campanella | 1ea1510 | 2017-09-04 16:00:09 +0200 | [diff] [blame] | 23 | import org.onosproject.net.device.DeviceEvent; |
| 24 | import org.onosproject.net.device.DeviceListener; |
Andrea Campanella | 6ee7392 | 2016-02-03 18:00:00 -0800 | [diff] [blame] | 25 | import org.onosproject.net.device.DeviceService; |
Andrea Campanella | 1ea1510 | 2017-09-04 16:00:09 +0200 | [diff] [blame] | 26 | import org.onosproject.net.group.Group; |
Andrea Campanella | 6ee7392 | 2016-02-03 18:00:00 -0800 | [diff] [blame] | 27 | import org.onosproject.net.group.GroupOperations; |
| 28 | import org.onosproject.net.group.GroupProgrammable; |
| 29 | import org.onosproject.net.group.GroupProvider; |
Andrea Campanella | 1ea1510 | 2017-09-04 16:00:09 +0200 | [diff] [blame] | 30 | import org.onosproject.net.group.GroupProviderService; |
Andrea Campanella | 6ee7392 | 2016-02-03 18:00:00 -0800 | [diff] [blame] | 31 | import org.onosproject.net.provider.AbstractProvider; |
| 32 | import org.onosproject.net.provider.ProviderId; |
| 33 | import org.slf4j.Logger; |
| 34 | import org.slf4j.LoggerFactory; |
| 35 | |
Andrea Campanella | 1ea1510 | 2017-09-04 16:00:09 +0200 | [diff] [blame] | 36 | import java.util.Collection; |
| 37 | import java.util.Set; |
| 38 | import java.util.concurrent.ScheduledExecutorService; |
| 39 | import java.util.concurrent.ScheduledFuture; |
| 40 | import java.util.concurrent.TimeUnit; |
| 41 | |
| 42 | import static java.util.concurrent.Executors.newSingleThreadScheduledExecutor; |
| 43 | import static org.onlab.util.Tools.groupedThreads; |
| 44 | import static org.onosproject.net.device.DeviceEvent.Type.DEVICE_ADDED; |
| 45 | import static org.onosproject.net.device.DeviceEvent.Type.DEVICE_AVAILABILITY_CHANGED; |
| 46 | |
Andrea Campanella | 6ee7392 | 2016-02-03 18:00:00 -0800 | [diff] [blame] | 47 | /** |
| 48 | * Driver-based Group rule provider. |
| 49 | */ |
| 50 | public class GroupDriverProvider extends AbstractProvider implements GroupProvider { |
| 51 | |
| 52 | private final Logger log = LoggerFactory.getLogger(getClass()); |
| 53 | |
| 54 | // To be extracted for reuse as we deal with other. |
| 55 | private static final String SCHEME = "default"; |
| 56 | private static final String PROVIDER_NAME = "org.onosproject.provider"; |
Andrea Campanella | 1ea1510 | 2017-09-04 16:00:09 +0200 | [diff] [blame] | 57 | |
| 58 | // potentially positive device event |
| 59 | private static final Set<DeviceEvent.Type> POSITIVE_DEVICE_EVENT = |
| 60 | Sets.immutableEnumSet(DEVICE_ADDED, |
| 61 | DEVICE_AVAILABILITY_CHANGED); |
| 62 | |
Andrea Campanella | 6ee7392 | 2016-02-03 18:00:00 -0800 | [diff] [blame] | 63 | protected DeviceService deviceService; |
Andrea Campanella | 1ea1510 | 2017-09-04 16:00:09 +0200 | [diff] [blame] | 64 | protected GroupProviderService groupProviderService; |
| 65 | protected MastershipService mastershipService; |
| 66 | |
| 67 | private InternalDeviceListener deviceListener = new InternalDeviceListener(); |
| 68 | private ScheduledExecutorService executor |
| 69 | = newSingleThreadScheduledExecutor(groupedThreads("GroupDriverProvider", "%d", log)); |
| 70 | private ScheduledFuture<?> poller = null; |
Andrea Campanella | 6ee7392 | 2016-02-03 18:00:00 -0800 | [diff] [blame] | 71 | |
| 72 | public GroupDriverProvider() { |
| 73 | super(new ProviderId(SCHEME, PROVIDER_NAME)); |
| 74 | } |
| 75 | |
| 76 | /** |
Andrea Campanella | 1ea1510 | 2017-09-04 16:00:09 +0200 | [diff] [blame] | 77 | * Initializes the provider with the necessary device service, group provider service, |
| 78 | * mastership service and poll frequency. |
Andrea Campanella | 6ee7392 | 2016-02-03 18:00:00 -0800 | [diff] [blame] | 79 | * |
Andrea Campanella | 1ea1510 | 2017-09-04 16:00:09 +0200 | [diff] [blame] | 80 | * @param deviceService device service |
| 81 | * @param groupProviderService group provider service |
| 82 | * @param mastershipService mastership service |
| 83 | * @param pollFrequency group entry poll frequency |
Andrea Campanella | 6ee7392 | 2016-02-03 18:00:00 -0800 | [diff] [blame] | 84 | */ |
Andrea Campanella | 1ea1510 | 2017-09-04 16:00:09 +0200 | [diff] [blame] | 85 | void init(DeviceService deviceService, GroupProviderService groupProviderService, |
| 86 | MastershipService mastershipService, int pollFrequency) { |
Andrea Campanella | 6ee7392 | 2016-02-03 18:00:00 -0800 | [diff] [blame] | 87 | this.deviceService = deviceService; |
Andrea Campanella | 1ea1510 | 2017-09-04 16:00:09 +0200 | [diff] [blame] | 88 | this.groupProviderService = groupProviderService; |
| 89 | this.mastershipService = mastershipService; |
| 90 | |
| 91 | deviceService.addListener(deviceListener); |
| 92 | |
| 93 | if (poller != null && !poller.isCancelled()) { |
| 94 | poller.cancel(false); |
| 95 | } |
| 96 | |
| 97 | poller = executor.scheduleAtFixedRate(this::pollGroups, pollFrequency, |
| 98 | pollFrequency, TimeUnit.SECONDS); |
| 99 | |
Andrea Campanella | 6ee7392 | 2016-02-03 18:00:00 -0800 | [diff] [blame] | 100 | } |
| 101 | |
Andrea Campanella | 5a3c09c | 2017-12-01 13:57:48 +0100 | [diff] [blame] | 102 | void terminate() { |
| 103 | deviceService.removeListener(deviceListener); |
| 104 | deviceService = null; |
| 105 | groupProviderService = null; |
| 106 | mastershipService = null; |
| 107 | poller.cancel(true); |
| 108 | executor.shutdown(); |
| 109 | } |
| 110 | |
Andrea Campanella | 6ee7392 | 2016-02-03 18:00:00 -0800 | [diff] [blame] | 111 | @Override |
| 112 | public void performGroupOperation(DeviceId deviceId, GroupOperations groupOps) { |
| 113 | GroupProgrammable programmable = getGroupProgrammable(deviceId); |
| 114 | if (programmable != null) { |
| 115 | programmable.performGroupOperation(deviceId, groupOps); |
| 116 | } |
| 117 | } |
| 118 | |
Andrea Campanella | 1ea1510 | 2017-09-04 16:00:09 +0200 | [diff] [blame] | 119 | private void pollGroups() { |
| 120 | deviceService.getAvailableDevices().forEach(device -> { |
| 121 | if (mastershipService.isLocalMaster(device.id()) && |
| 122 | device.is(GroupProgrammable.class)) { |
| 123 | pollDeviceGroups(device.id()); |
| 124 | } |
| 125 | }); |
| 126 | } |
| 127 | |
| 128 | private void pollDeviceGroups(DeviceId deviceId) { |
| 129 | Collection<Group> groups = getGroupProgrammable(deviceId).getGroups(); |
| 130 | groupProviderService.pushGroupMetrics(deviceId, groups); |
| 131 | } |
| 132 | |
Andrea Campanella | 6ee7392 | 2016-02-03 18:00:00 -0800 | [diff] [blame] | 133 | private GroupProgrammable getGroupProgrammable(DeviceId deviceId) { |
Andrea Campanella | e427390 | 2016-02-08 13:43:30 -0800 | [diff] [blame] | 134 | Device device = deviceService.getDevice(deviceId); |
| 135 | if (device.is(GroupProgrammable.class)) { |
| 136 | return device.as(GroupProgrammable.class); |
| 137 | } else { |
Andrea Campanella | fe1d473 | 2016-02-08 16:45:27 -0800 | [diff] [blame] | 138 | log.debug("Device {} is not group programmable", deviceId); |
Andrea Campanella | e427390 | 2016-02-08 13:43:30 -0800 | [diff] [blame] | 139 | return null; |
Andrea Campanella | 6ee7392 | 2016-02-03 18:00:00 -0800 | [diff] [blame] | 140 | } |
Andrea Campanella | 6ee7392 | 2016-02-03 18:00:00 -0800 | [diff] [blame] | 141 | } |
Andrea Campanella | 1ea1510 | 2017-09-04 16:00:09 +0200 | [diff] [blame] | 142 | |
| 143 | private class InternalDeviceListener implements DeviceListener { |
| 144 | |
| 145 | @Override |
| 146 | public void event(DeviceEvent event) { |
| 147 | executor.execute(() -> handleEvent(event)); |
| 148 | } |
| 149 | |
| 150 | @Override |
| 151 | public boolean isRelevant(DeviceEvent event) { |
| 152 | Device device = event.subject(); |
| 153 | return POSITIVE_DEVICE_EVENT.contains(event.type()) && |
| 154 | device.is(GroupProgrammable.class); |
| 155 | } |
| 156 | |
| 157 | private void handleEvent(DeviceEvent event) { |
| 158 | Device device = event.subject(); |
| 159 | boolean isRelevant = mastershipService.isLocalMaster(device.id()) && |
| 160 | deviceService.isAvailable(device.id()); |
| 161 | |
| 162 | if (isRelevant) { |
| 163 | pollDeviceGroups(device.id()); |
| 164 | } |
| 165 | } |
| 166 | } |
Andrea Campanella | 6ee7392 | 2016-02-03 18:00:00 -0800 | [diff] [blame] | 167 | } |