| /* |
| * Copyright 2015-present Open Networking Foundation |
| * |
| * Licensed under the Apache License, Version 2.0 (the "License"); |
| * you may not use this file except in compliance with the License. |
| * You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| package org.onosproject.net.group.impl; |
| |
| import com.google.common.collect.Iterables; |
| import org.onlab.util.Tools; |
| import org.onosproject.cfg.ComponentConfigService; |
| import org.onosproject.core.ApplicationId; |
| import org.onosproject.mastership.MastershipService; |
| import org.onosproject.net.DeviceId; |
| import org.onosproject.net.config.NetworkConfigRegistry; |
| import org.onosproject.net.config.basics.BasicDeviceConfig; |
| import org.onosproject.net.device.DeviceEvent; |
| import org.onosproject.net.device.DeviceListener; |
| import org.onosproject.net.device.DeviceService; |
| import org.onosproject.net.driver.DriverService; |
| import org.onosproject.net.group.Group; |
| import org.onosproject.net.group.GroupBuckets; |
| import org.onosproject.net.group.GroupDescription; |
| import org.onosproject.net.group.GroupEvent; |
| import org.onosproject.net.group.GroupKey; |
| import org.onosproject.net.group.GroupListener; |
| import org.onosproject.net.group.GroupOperation; |
| import org.onosproject.net.group.GroupOperations; |
| import org.onosproject.net.group.GroupProvider; |
| import org.onosproject.net.group.GroupProviderRegistry; |
| import org.onosproject.net.group.GroupProviderService; |
| import org.onosproject.net.group.GroupService; |
| import org.onosproject.net.group.GroupStore; |
| import org.onosproject.net.group.GroupStore.UpdateType; |
| import org.onosproject.net.group.GroupStoreDelegate; |
| import org.onosproject.net.provider.AbstractListenerProviderRegistry; |
| import org.onosproject.net.provider.AbstractProviderService; |
| import org.osgi.service.component.ComponentContext; |
| import org.osgi.service.component.annotations.Activate; |
| import org.osgi.service.component.annotations.Component; |
| import org.osgi.service.component.annotations.Deactivate; |
| import org.osgi.service.component.annotations.Modified; |
| import org.osgi.service.component.annotations.Reference; |
| import org.osgi.service.component.annotations.ReferenceCardinality; |
| import org.slf4j.Logger; |
| |
| import java.util.Collection; |
| import java.util.Collections; |
| import java.util.Dictionary; |
| import java.util.Objects; |
| import java.util.concurrent.ExecutorService; |
| import java.util.concurrent.Executors; |
| |
| import static com.google.common.base.Strings.isNullOrEmpty; |
| import static org.onlab.util.Tools.get; |
| import static org.onlab.util.Tools.groupedThreads; |
| import static org.onosproject.net.OsgiPropertyConstants.GM_POLL_FREQUENCY; |
| import static org.onosproject.net.OsgiPropertyConstants.GM_POLL_FREQUENCY_DEFAULT; |
| import static org.onosproject.net.OsgiPropertyConstants.GM_PURGE_ON_DISCONNECTION; |
| import static org.onosproject.net.OsgiPropertyConstants.GM_PURGE_ON_DISCONNECTION_DEFAULT; |
| import static org.onosproject.security.AppGuard.checkPermission; |
| import static org.onosproject.security.AppPermission.Type.GROUP_READ; |
| import static org.onosproject.security.AppPermission.Type.GROUP_WRITE; |
| import static org.slf4j.LoggerFactory.getLogger; |
| |
| /** |
| * Provides implementation of the group service APIs. |
| */ |
| @Component( |
| immediate = true, |
| service = { |
| GroupService.class, |
| GroupProviderRegistry.class |
| }, |
| property = { |
| GM_POLL_FREQUENCY + ":Integer=" + GM_POLL_FREQUENCY_DEFAULT, |
| GM_PURGE_ON_DISCONNECTION + ":Boolean=" + GM_PURGE_ON_DISCONNECTION_DEFAULT |
| } |
| ) |
| public class GroupManager |
| extends AbstractListenerProviderRegistry<GroupEvent, GroupListener, |
| GroupProvider, GroupProviderService> |
| implements GroupService, GroupProviderRegistry { |
| |
| private final Logger log = getLogger(getClass()); |
| |
| private final GroupStoreDelegate delegate = new InternalGroupStoreDelegate(); |
| private final DeviceListener deviceListener = new InternalDeviceListener(); |
| |
| private final GroupDriverProvider defaultProvider = new GroupDriverProvider(); |
| |
| private ExecutorService eventExecutor; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY) |
| protected GroupStore store; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY) |
| protected DeviceService deviceService; |
| |
| // Reference the DriverService to ensure the service is bound prior to initialization of the GroupDriverProvider |
| @Reference(cardinality = ReferenceCardinality.MANDATORY) |
| protected DriverService driverService; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY) |
| protected ComponentConfigService cfgService; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY) |
| protected MastershipService mastershipService; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY) |
| protected NetworkConfigRegistry netCfgService; |
| |
| /** Frequency (in seconds) for polling groups via fallback provider. */ |
| private int fallbackGroupPollFrequency = GM_POLL_FREQUENCY_DEFAULT; |
| |
| /** Purge entries associated with a device when the device goes offline. */ |
| private boolean purgeOnDisconnection = GM_PURGE_ON_DISCONNECTION_DEFAULT; |
| |
| |
| @Activate |
| public void activate(ComponentContext context) { |
| eventExecutor = Executors.newSingleThreadExecutor(groupedThreads("onos/group", "event")); |
| store.setDelegate(delegate); |
| eventDispatcher.addSink(GroupEvent.class, listenerRegistry); |
| deviceService.addListener(deviceListener); |
| cfgService.registerProperties(getClass()); |
| modified(context); |
| log.info("Started"); |
| } |
| |
| @Deactivate |
| public void deactivate() { |
| eventExecutor.shutdown(); |
| defaultProvider.terminate(); |
| deviceService.removeListener(deviceListener); |
| cfgService.unregisterProperties(getClass(), false); |
| store.unsetDelegate(delegate); |
| eventDispatcher.removeSink(GroupEvent.class); |
| log.info("Stopped"); |
| } |
| |
| @Modified |
| public void modified(ComponentContext context) { |
| if (context != null) { |
| readComponentConfiguration(context); |
| } |
| defaultProvider.init(deviceService, new InternalGroupProviderService(defaultProvider), |
| mastershipService, fallbackGroupPollFrequency); |
| } |
| |
| @Override |
| protected GroupProvider defaultProvider() { |
| return defaultProvider; |
| } |
| |
| /** |
| * Extracts properties from the component configuration context. |
| * |
| * @param context the component context |
| */ |
| private void readComponentConfiguration(ComponentContext context) { |
| Dictionary<?, ?> properties = context.getProperties(); |
| Boolean flag; |
| |
| flag = Tools.isPropertyEnabled(properties, GM_PURGE_ON_DISCONNECTION); |
| if (flag == null) { |
| log.info("PurgeOnDisconnection is not configured, " + |
| "using current value of {}", purgeOnDisconnection); |
| } else { |
| purgeOnDisconnection = flag; |
| log.info("Configured. PurgeOnDisconnection is {}", |
| purgeOnDisconnection ? "enabled" : "disabled"); |
| } |
| String s = get(properties, GM_POLL_FREQUENCY); |
| try { |
| fallbackGroupPollFrequency = isNullOrEmpty(s) ? GM_POLL_FREQUENCY_DEFAULT : Integer.parseInt(s); |
| } catch (NumberFormatException e) { |
| fallbackGroupPollFrequency = GM_POLL_FREQUENCY_DEFAULT; |
| } |
| } |
| |
| /** |
| * Create a group in the specified device with the provided parameters. |
| * |
| * @param groupDesc group creation parameters |
| */ |
| @Override |
| public void addGroup(GroupDescription groupDesc) { |
| checkPermission(GROUP_WRITE); |
| store.storeGroupDescription(groupDesc); |
| } |
| |
| /** |
| * Return a group object associated to an application cookie. |
| * <p> |
| * NOTE1: The presence of group object in the system does not |
| * guarantee that the "group" is actually created in device. |
| * GROUP_ADDED notification would confirm the creation of |
| * this group in data plane. |
| * |
| * @param deviceId device identifier |
| * @param appCookie application cookie to be used for lookup |
| * @return group associated with the application cookie or |
| * NULL if Group is not found for the provided cookie |
| */ |
| @Override |
| public Group getGroup(DeviceId deviceId, GroupKey appCookie) { |
| checkPermission(GROUP_READ); |
| return store.getGroup(deviceId, appCookie); |
| } |
| |
| /** |
| * Append buckets to existing group. The caller can optionally |
| * associate a new cookie during this updation. GROUP_UPDATED or |
| * GROUP_UPDATE_FAILED notifications would be provided along with |
| * cookie depending on the result of the operation on the device. |
| * |
| * @param deviceId device identifier |
| * @param oldCookie cookie to be used to retrieve the existing group |
| * @param buckets immutable list of group bucket to be added |
| * @param newCookie immutable cookie to be used post update operation |
| * @param appId Application Id |
| */ |
| @Override |
| public void addBucketsToGroup(DeviceId deviceId, |
| GroupKey oldCookie, |
| GroupBuckets buckets, |
| GroupKey newCookie, |
| ApplicationId appId) { |
| checkPermission(GROUP_WRITE); |
| store.updateGroupDescription(deviceId, |
| oldCookie, |
| UpdateType.ADD, |
| buckets, |
| newCookie); |
| } |
| |
| /** |
| * Remove buckets from existing group. The caller can optionally |
| * associate a new cookie during this updation. GROUP_UPDATED or |
| * GROUP_UPDATE_FAILED notifications would be provided along with |
| * cookie depending on the result of the operation on the device. |
| * |
| * @param deviceId device identifier |
| * @param oldCookie cookie to be used to retrieve the existing group |
| * @param buckets immutable list of group bucket to be removed |
| * @param newCookie immutable cookie to be used post update operation |
| * @param appId Application Id |
| */ |
| @Override |
| public void removeBucketsFromGroup(DeviceId deviceId, |
| GroupKey oldCookie, |
| GroupBuckets buckets, |
| GroupKey newCookie, |
| ApplicationId appId) { |
| checkPermission(GROUP_WRITE); |
| store.updateGroupDescription(deviceId, |
| oldCookie, |
| UpdateType.REMOVE, |
| buckets, |
| newCookie); |
| } |
| |
| /** |
| * Set buckets for an existing group. The caller can optionally |
| * associate a new cookie during this updation. GROUP_UPDATED or |
| * GROUP_UPDATE_FAILED notifications would be provided along with |
| * cookie depending on the result of the operation on the device. |
| * |
| * This operation overwrites the previous group buckets entirely. |
| * |
| * @param deviceId device identifier |
| * @param oldCookie cookie to be used to retrieve the existing group |
| * @param buckets immutable list of group buckets to be set |
| * @param newCookie immutable cookie to be used post update operation |
| * @param appId Application Id |
| */ |
| @Override |
| public void setBucketsForGroup(DeviceId deviceId, |
| GroupKey oldCookie, |
| GroupBuckets buckets, |
| GroupKey newCookie, |
| ApplicationId appId) { |
| checkPermission(GROUP_WRITE); |
| store.updateGroupDescription(deviceId, |
| oldCookie, |
| UpdateType.SET, |
| buckets, |
| newCookie); |
| } |
| |
| @Override |
| public void purgeGroupEntries(DeviceId deviceId) { |
| checkPermission(GROUP_WRITE); |
| store.purgeGroupEntry(deviceId); |
| } |
| |
| @Override |
| public void purgeGroupEntries(DeviceId deviceId, ApplicationId appId) { |
| checkPermission(GROUP_WRITE); |
| store.purgeGroupEntries(deviceId, appId); |
| } |
| |
| @Override |
| public void purgeGroupEntries() { |
| checkPermission(GROUP_WRITE); |
| store.purgeGroupEntries(); |
| } |
| |
| /** |
| * Delete a group associated to an application cookie. |
| * GROUP_DELETED or GROUP_DELETE_FAILED notifications would be |
| * provided along with cookie depending on the result of the |
| * operation on the device. |
| * |
| * @param deviceId device identifier |
| * @param appCookie application cookie to be used for lookup |
| * @param appId Application Id |
| */ |
| @Override |
| public void removeGroup(DeviceId deviceId, |
| GroupKey appCookie, |
| ApplicationId appId) { |
| checkPermission(GROUP_WRITE); |
| store.deleteGroupDescription(deviceId, appCookie); |
| } |
| |
| /** |
| * Retrieve all groups created by an application in the specified device |
| * as seen by current controller instance. |
| * |
| * @param deviceId device identifier |
| * @param appId application id |
| * @return collection of immutable group objects created by the application |
| */ |
| @Override |
| public Iterable<Group> getGroups(DeviceId deviceId, |
| ApplicationId appId) { |
| checkPermission(GROUP_READ); |
| return Iterables.filter( |
| store.getGroups(deviceId), |
| g -> g != null && Objects.equals(g.appId(), appId)); |
| } |
| |
| @Override |
| public Iterable<Group> getGroups(DeviceId deviceId) { |
| checkPermission(GROUP_READ); |
| return store.getGroups(deviceId); |
| } |
| |
| @Override |
| protected GroupProviderService createProviderService(GroupProvider provider) { |
| return new InternalGroupProviderService(provider); |
| } |
| |
| private class InternalGroupStoreDelegate implements GroupStoreDelegate { |
| @Override |
| public void notify(GroupEvent event) { |
| final Group group = event.subject(); |
| GroupProvider groupProvider = |
| getProvider(group.deviceId()); |
| GroupOperations groupOps = null; |
| switch (event.type()) { |
| case GROUP_ADD_REQUESTED: |
| log.debug("GROUP_ADD_REQUESTED for Group {} on device {}", |
| group.id(), group.deviceId()); |
| GroupOperation groupAddOp = GroupOperation. |
| createAddGroupOperation(group.id(), |
| group.type(), |
| group.buckets()); |
| groupOps = new GroupOperations( |
| Collections.singletonList(groupAddOp)); |
| groupProvider.performGroupOperation(group.deviceId(), groupOps); |
| break; |
| |
| case GROUP_UPDATE_REQUESTED: |
| log.debug("GROUP_UPDATE_REQUESTED for Group {} on device {}", |
| group.id(), group.deviceId()); |
| GroupOperation groupModifyOp = GroupOperation. |
| createModifyGroupOperation(group.id(), |
| group.type(), |
| group.buckets()); |
| groupOps = new GroupOperations( |
| Collections.singletonList(groupModifyOp)); |
| groupProvider.performGroupOperation(group.deviceId(), groupOps); |
| break; |
| |
| case GROUP_REMOVE_REQUESTED: |
| log.debug("GROUP_REMOVE_REQUESTED for Group {} on device {}", |
| group.id(), group.deviceId()); |
| GroupOperation groupDeleteOp = GroupOperation. |
| createDeleteGroupOperation(group.id(), |
| group.type()); |
| groupOps = new GroupOperations( |
| Collections.singletonList(groupDeleteOp)); |
| groupProvider.performGroupOperation(group.deviceId(), groupOps); |
| break; |
| |
| case GROUP_ADDED: |
| case GROUP_UPDATED: |
| case GROUP_REMOVED: |
| case GROUP_ADD_FAILED: |
| case GROUP_UPDATE_FAILED: |
| case GROUP_REMOVE_FAILED: |
| case GROUP_BUCKET_FAILOVER: |
| post(event); |
| break; |
| default: |
| break; |
| } |
| } |
| } |
| |
| private class InternalGroupProviderService |
| extends AbstractProviderService<GroupProvider> |
| implements GroupProviderService { |
| |
| protected InternalGroupProviderService(GroupProvider provider) { |
| super(provider); |
| } |
| |
| @Override |
| public void groupOperationFailed(DeviceId deviceId, GroupOperation operation) { |
| store.groupOperationFailed(deviceId, operation); |
| } |
| |
| @Override |
| public void pushGroupMetrics(DeviceId deviceId, |
| Collection<Group> groupEntries) { |
| log.trace("Received group metrics from device {}", deviceId); |
| checkValidity(); |
| store.pushGroupMetrics(deviceId, groupEntries); |
| } |
| |
| @Override |
| public void notifyOfFailovers(Collection<Group> failoverGroups) { |
| store.notifyOfFailovers(failoverGroups); |
| } |
| } |
| |
| private class InternalDeviceListener implements DeviceListener { |
| @Override |
| public void event(DeviceEvent event) { |
| eventExecutor.execute(() -> processEventInternal(event)); |
| } |
| |
| private void processEventInternal(DeviceEvent event) { |
| switch (event.type()) { |
| case DEVICE_REMOVED: |
| case DEVICE_AVAILABILITY_CHANGED: |
| DeviceId deviceId = event.subject().id(); |
| if (!deviceService.isAvailable(deviceId)) { |
| log.debug("Device {} became unavailable for {}; clearing initial audit status", |
| deviceId, event.type()); |
| store.deviceInitialAuditCompleted(deviceId, false); |
| BasicDeviceConfig cfg = netCfgService.getConfig(deviceId, BasicDeviceConfig.class); |
| //if purgeOnDisconnection is set for the device or it's a global configuration |
| // lets remove the groups. |
| boolean purge = cfg != null && cfg.isPurgeOnDisconnectionConfigured() ? |
| cfg.purgeOnDisconnection() : purgeOnDisconnection; |
| if (purge) { |
| log.info("PurgeOnDisconnection is requested for device {}, " + |
| "removing groups", deviceId); |
| store.purgeGroupEntry(deviceId); |
| } |
| } |
| break; |
| default: |
| break; |
| } |
| } |
| } |
| |
| } |