| package org.onlab.onos.net.flow.impl; |
| |
| import static com.google.common.base.Preconditions.checkNotNull; |
| import static org.slf4j.LoggerFactory.getLogger; |
| |
| import java.util.Iterator; |
| import java.util.List; |
| |
| import org.apache.felix.scr.annotations.Activate; |
| import org.apache.felix.scr.annotations.Component; |
| import org.apache.felix.scr.annotations.Deactivate; |
| import org.apache.felix.scr.annotations.Reference; |
| import org.apache.felix.scr.annotations.ReferenceCardinality; |
| import org.apache.felix.scr.annotations.Service; |
| import org.onlab.onos.ApplicationId; |
| import org.onlab.onos.event.AbstractListenerRegistry; |
| import org.onlab.onos.event.EventDeliveryService; |
| import org.onlab.onos.net.Device; |
| import org.onlab.onos.net.DeviceId; |
| import org.onlab.onos.net.device.DeviceService; |
| import org.onlab.onos.net.flow.FlowEntry; |
| import org.onlab.onos.net.flow.FlowRule; |
| import org.onlab.onos.net.flow.FlowRuleEvent; |
| import org.onlab.onos.net.flow.FlowRuleListener; |
| import org.onlab.onos.net.flow.FlowRuleProvider; |
| import org.onlab.onos.net.flow.FlowRuleProviderRegistry; |
| import org.onlab.onos.net.flow.FlowRuleProviderService; |
| import org.onlab.onos.net.flow.FlowRuleService; |
| import org.onlab.onos.net.flow.FlowRuleStore; |
| import org.onlab.onos.net.flow.FlowRuleStoreDelegate; |
| import org.onlab.onos.net.provider.AbstractProviderRegistry; |
| import org.onlab.onos.net.provider.AbstractProviderService; |
| import org.slf4j.Logger; |
| |
| import com.google.common.collect.Lists; |
| |
| /** |
| * Provides implementation of the flow NB & SB APIs. |
| */ |
| @Component(immediate = true) |
| @Service |
| public class FlowRuleManager |
| extends AbstractProviderRegistry<FlowRuleProvider, FlowRuleProviderService> |
| implements FlowRuleService, FlowRuleProviderRegistry { |
| |
| public static final String FLOW_RULE_NULL = "FlowRule cannot be null"; |
| private final Logger log = getLogger(getClass()); |
| |
| private final AbstractListenerRegistry<FlowRuleEvent, FlowRuleListener> |
| listenerRegistry = new AbstractListenerRegistry<>(); |
| |
| private final FlowRuleStoreDelegate delegate = new InternalStoreDelegate(); |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| protected FlowRuleStore store; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| protected EventDeliveryService eventDispatcher; |
| |
| @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| protected DeviceService deviceService; |
| |
| @Activate |
| public void activate() { |
| store.setDelegate(delegate); |
| eventDispatcher.addSink(FlowRuleEvent.class, listenerRegistry); |
| log.info("Started"); |
| } |
| |
| @Deactivate |
| public void deactivate() { |
| store.unsetDelegate(delegate); |
| eventDispatcher.removeSink(FlowRuleEvent.class); |
| log.info("Stopped"); |
| } |
| |
| @Override |
| public Iterable<FlowEntry> getFlowEntries(DeviceId deviceId) { |
| return store.getFlowEntries(deviceId); |
| } |
| |
| @Override |
| public void applyFlowRules(FlowRule... flowRules) { |
| for (int i = 0; i < flowRules.length; i++) { |
| FlowRule f = flowRules[i]; |
| final Device device = deviceService.getDevice(f.deviceId()); |
| final FlowRuleProvider frp = getProvider(device.providerId()); |
| store.storeFlowRule(f); |
| frp.applyFlowRule(f); |
| } |
| } |
| |
| @Override |
| public void removeFlowRules(FlowRule... flowRules) { |
| FlowRule f; |
| FlowRuleProvider frp; |
| Device device; |
| for (int i = 0; i < flowRules.length; i++) { |
| f = flowRules[i]; |
| device = deviceService.getDevice(f.deviceId()); |
| frp = getProvider(device.providerId()); |
| store.deleteFlowRule(f); |
| frp.removeFlowRule(f); |
| } |
| } |
| |
| @Override |
| public void removeFlowRulesById(ApplicationId id) { |
| Iterable<FlowRule> rules = getFlowRulesById(id); |
| FlowRuleProvider frp; |
| Device device; |
| |
| for (FlowRule f : rules) { |
| store.deleteFlowRule(f); |
| device = deviceService.getDevice(f.deviceId()); |
| frp = getProvider(device.providerId()); |
| frp.removeRulesById(id, f); |
| } |
| } |
| |
| @Override |
| public Iterable<FlowRule> getFlowRulesById(ApplicationId id) { |
| return store.getFlowRulesByAppId(id); |
| } |
| |
| @Override |
| public void addListener(FlowRuleListener listener) { |
| listenerRegistry.addListener(listener); |
| } |
| |
| @Override |
| public void removeListener(FlowRuleListener listener) { |
| listenerRegistry.removeListener(listener); |
| } |
| |
| @Override |
| protected FlowRuleProviderService createProviderService( |
| FlowRuleProvider provider) { |
| return new InternalFlowRuleProviderService(provider); |
| } |
| |
| private class InternalFlowRuleProviderService |
| extends AbstractProviderService<FlowRuleProvider> |
| implements FlowRuleProviderService { |
| |
| protected InternalFlowRuleProviderService(FlowRuleProvider provider) { |
| super(provider); |
| } |
| |
| @Override |
| public void flowRemoved(FlowEntry flowEntry) { |
| checkNotNull(flowEntry, FLOW_RULE_NULL); |
| checkValidity(); |
| FlowEntry stored = store.getFlowEntry(flowEntry); |
| if (stored == null) { |
| log.info("Rule already evicted from store: {}", flowEntry); |
| return; |
| } |
| Device device = deviceService.getDevice(flowEntry.deviceId()); |
| FlowRuleProvider frp = getProvider(device.providerId()); |
| FlowRuleEvent event = null; |
| switch (stored.state()) { |
| case ADDED: |
| case PENDING_ADD: |
| frp.applyFlowRule(stored); |
| break; |
| case PENDING_REMOVE: |
| case REMOVED: |
| event = store.removeFlowRule(stored); |
| break; |
| default: |
| break; |
| |
| } |
| if (event != null) { |
| log.debug("Flow {} removed", flowEntry); |
| post(event); |
| } |
| } |
| |
| |
| private void flowMissing(FlowEntry flowRule) { |
| checkNotNull(flowRule, FLOW_RULE_NULL); |
| checkValidity(); |
| Device device = deviceService.getDevice(flowRule.deviceId()); |
| FlowRuleProvider frp = getProvider(device.providerId()); |
| FlowRuleEvent event = null; |
| switch (flowRule.state()) { |
| case PENDING_REMOVE: |
| case REMOVED: |
| event = store.removeFlowRule(flowRule); |
| frp.removeFlowRule(flowRule); |
| break; |
| case ADDED: |
| case PENDING_ADD: |
| frp.applyFlowRule(flowRule); |
| break; |
| default: |
| log.debug("Flow {} has not been installed.", flowRule); |
| } |
| |
| if (event != null) { |
| log.debug("Flow {} removed", flowRule); |
| post(event); |
| } |
| |
| } |
| |
| |
| private void extraneousFlow(FlowRule flowRule) { |
| checkNotNull(flowRule, FLOW_RULE_NULL); |
| checkValidity(); |
| removeFlowRules(flowRule); |
| log.debug("Flow {} is on switch but not in store.", flowRule); |
| } |
| |
| |
| private void flowAdded(FlowEntry flowEntry) { |
| checkNotNull(flowEntry, FLOW_RULE_NULL); |
| checkValidity(); |
| |
| if (checkRuleLiveness(flowEntry, store.getFlowEntry(flowEntry))) { |
| |
| FlowRuleEvent event = store.addOrUpdateFlowRule(flowEntry); |
| if (event == null) { |
| log.debug("No flow store event generated."); |
| } else { |
| log.debug("Flow {} {}", flowEntry, event.type()); |
| post(event); |
| } |
| } else { |
| removeFlowRules(flowEntry); |
| } |
| |
| } |
| |
| private boolean checkRuleLiveness(FlowEntry swRule, FlowEntry storedRule) { |
| if (storedRule == null) { |
| return false; |
| } |
| long timeout = storedRule.timeout() * 1000; |
| Long currentTime = System.currentTimeMillis(); |
| if (storedRule.packets() != swRule.packets()) { |
| storedRule.setLastSeen(); |
| return true; |
| } |
| |
| if ((currentTime - storedRule.lastSeen()) <= timeout) { |
| return true; |
| } |
| return false; |
| } |
| |
| // Posts the specified event to the local event dispatcher. |
| private void post(FlowRuleEvent event) { |
| if (event != null) { |
| eventDispatcher.post(event); |
| } |
| } |
| |
| @Override |
| public void pushFlowMetrics(DeviceId deviceId, Iterable<FlowEntry> flowEntries) { |
| List<FlowEntry> storedRules = Lists.newLinkedList(store.getFlowEntries(deviceId)); |
| |
| Iterator<FlowEntry> switchRulesIterator = flowEntries.iterator(); |
| |
| while (switchRulesIterator.hasNext()) { |
| FlowEntry rule = switchRulesIterator.next(); |
| if (storedRules.remove(rule)) { |
| // we both have the rule, let's update some info then. |
| flowAdded(rule); |
| } else { |
| // the device has a rule the store does not have |
| extraneousFlow(rule); |
| } |
| } |
| for (FlowEntry rule : storedRules) { |
| // there are rules in the store that aren't on the switch |
| flowMissing(rule); |
| |
| } |
| } |
| } |
| |
| // Store delegate to re-post events emitted from the store. |
| private class InternalStoreDelegate implements FlowRuleStoreDelegate { |
| @Override |
| public void notify(FlowRuleEvent event) { |
| eventDispatcher.post(event); |
| } |
| } |
| } |