renderers/ofoverlay/src/main/java/org/opendaylight/groupbasedpolicy/renderer/ofoverlay/OFOverlayRenderer.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8
   9 package org.opendaylight.groupbasedpolicy.renderer.ofoverlay;
  10
  11 import java.util.ArrayList;
  12 import java.util.List;
  13 import java.util.Map.Entry;
  14 import java.util.concurrent.ExecutionException;
  15 import java.util.concurrent.Executors;
  16 import java.util.concurrent.ScheduledExecutorService;
  17
  18 import javax.annotation.Nonnull;
  19
  20 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  21 import org.opendaylight.controller.md.sal.binding.api.DataChangeListener;
  22 import org.opendaylight.controller.md.sal.binding.api.NotificationService;
  23 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  24 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  25 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker.DataChangeScope;
  26 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataChangeEvent;
  27 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  28 import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
  29 import org.opendaylight.groupbasedpolicy.api.EpRendererAugmentationRegistry;
  30 import org.opendaylight.groupbasedpolicy.api.PolicyValidatorRegistry;
  31 import org.opendaylight.groupbasedpolicy.api.StatisticsManager;
  32 import org.opendaylight.groupbasedpolicy.renderer.ofoverlay.endpoint.EndpointManager;
  33 import org.opendaylight.groupbasedpolicy.renderer.ofoverlay.endpoint.OfOverlayAug;
  34 import org.opendaylight.groupbasedpolicy.renderer.ofoverlay.endpoint.OfOverlayL3NatAug;
  35 import org.opendaylight.groupbasedpolicy.renderer.ofoverlay.node.SwitchManager;
  36 import org.opendaylight.groupbasedpolicy.renderer.ofoverlay.sf.Action;
  37 import org.opendaylight.groupbasedpolicy.renderer.ofoverlay.sf.ActionDefinitionListener;
  38 import org.opendaylight.groupbasedpolicy.renderer.ofoverlay.sf.ClassifierDefinitionListener;
  39 import org.opendaylight.groupbasedpolicy.renderer.ofoverlay.sf.SubjectFeatures;
  40 import org.opendaylight.groupbasedpolicy.renderer.ofoverlay.statistics.SflowClientSettingsListener;
  41 import org.opendaylight.groupbasedpolicy.util.DataStoreHelper;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.ActionDefinitionId;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.ofoverlay.rev140528.OfOverlayConfig;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.ofoverlay.rev140528.OfOverlayConfigBuilder;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.RendererName;
  46 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  47 import org.opendaylight.yangtools.yang.binding.DataObject;
  48 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  49 import org.slf4j.Logger;
  50 import org.slf4j.LoggerFactory;
  51
  52 import com.google.common.base.Optional;
  53 import com.google.common.util.concurrent.Futures;
  54 import com.google.common.util.concurrent.ListenableFuture;
  55
  56 /**
  57  * Renderer that uses OpenFlow and OVSDB to implement an overlay network
  58  * using Open vSwitch.
  59  */
  60 public class OFOverlayRenderer implements AutoCloseable, DataChangeListener {
  61
  62     private static final Logger LOG =
  63             LoggerFactory.getLogger(OFOverlayRenderer.class);
  64     public static final RendererName RENDERER_NAME = new RendererName("OFOverlay");
  65
  66     private final DataBroker dataBroker;
  67     private final SwitchManager switchManager;
  68     private final EndpointManager endpointManager;
  69     private final PolicyManager policyManager;
  70     private final ClassifierDefinitionListener classifierDefinitionListener;
  71     private final SflowClientSettingsListener sflowClientSettingsListener;
  72     private ActionDefinitionListener actionDefinitionListener;
  73     private final OfOverlayAug ofOverlayAug;
  74     private final OfOverlayL3NatAug ofOverlayL3NatAug;
  75
  76     private final ScheduledExecutorService executor;
  77
  78     private static final InstanceIdentifier<OfOverlayConfig> configIid =
  79             InstanceIdentifier.builder(OfOverlayConfig.class).build();
  80
  81     ListenerRegistration<DataChangeListener> configReg;
  82
  83     public OFOverlayRenderer(final DataBroker dataProvider,
  84             RpcProviderRegistry rpcRegistry,
  85             NotificationService notificationService,
  86             EpRendererAugmentationRegistry epRendererAugmentationRegistry,
  87             PolicyValidatorRegistry policyValidatorRegistry,
  88             StatisticsManager statisticsManager,
  89             final short tableOffset) {
  90         super();
  91         this.dataBroker = dataProvider;
  92         int numCPU = Runtime.getRuntime().availableProcessors();
  93         //TODO: Consider moving to groupbasedpolicy-ofoverlay-config so as to be user configurable in distribution.
  94         executor = Executors.newScheduledThreadPool(numCPU * 2);
  95
  96         switchManager = new SwitchManager(dataProvider);
  97         endpointManager = new EndpointManager(dataProvider, rpcRegistry, notificationService,
  98                 executor, switchManager);
  99
 100         classifierDefinitionListener = new ClassifierDefinitionListener(dataBroker);
 101         actionDefinitionListener = new ActionDefinitionListener(dataProvider);
 102
 103         for (Entry<ActionDefinitionId, Action> entry : SubjectFeatures.getActions().entrySet()) {
 104             policyValidatorRegistry.register(entry.getKey(), entry.getValue());
 105         }
 106
 107         sflowClientSettingsListener = new SflowClientSettingsListener(dataProvider, executor, statisticsManager);
 108
 109         policyManager = new PolicyManager(dataProvider,
 110                 switchManager,
 111                 endpointManager,
 112                 executor,
 113                 tableOffset);
 114         ofOverlayAug = new OfOverlayAug(dataProvider, epRendererAugmentationRegistry);
 115         ofOverlayL3NatAug = new OfOverlayL3NatAug(epRendererAugmentationRegistry);
 116         Optional<OfOverlayConfig> config = readConfig();
 117         OfOverlayConfigBuilder configBuilder = new OfOverlayConfigBuilder();
 118         if (config.isPresent()) {
 119             configBuilder = new OfOverlayConfigBuilder(config.get());
 120         }
 121         registerConfigListener(dataProvider);
 122         if (configBuilder.getGbpOfoverlayTableOffset() == null) {
 123             configBuilder.setGbpOfoverlayTableOffset(tableOffset).build();
 124             writeTableOffset(configBuilder.build());
 125         }
 126
 127     }
 128
 129     public ScheduledExecutorService getExecutor() {
 130         return executor;
 131     }
 132
 133     // *************
 134     // AutoCloseable
 135     // *************
 136
 137     @Override
 138     public void close() throws Exception {
 139         executor.shutdownNow();
 140         if (configReg != null) configReg.close();
 141         if (switchManager != null) switchManager.close();
 142         if (endpointManager != null) endpointManager.close();
 143         if (classifierDefinitionListener != null) classifierDefinitionListener.close();
 144         if (actionDefinitionListener != null) actionDefinitionListener.close();
 145         if (ofOverlayAug != null) ofOverlayAug.close();
 146         if (ofOverlayL3NatAug != null) ofOverlayL3NatAug.close();
 147         if (policyManager != null) policyManager.close();
 148         if (sflowClientSettingsListener != null) sflowClientSettingsListener.close();
 149     }
 150
 151     // ******************
 152     // DataChangeListener
 153     // ******************
 154
 155     @Override
 156     public void onDataChanged(AsyncDataChangeEvent<InstanceIdentifier<?>, DataObject> change) {
 157         OfOverlayConfig config;
 158         try {
 159             for (Entry<InstanceIdentifier<?>, DataObject> entry : change.getCreatedData().entrySet()) {
 160                 if (entry.getValue() instanceof OfOverlayConfig) {
 161                     config = (OfOverlayConfig) entry.getValue();
 162                     applyConfig(config).get();
 163                     LOG.info("OF-Overlay config created: {}", config);
 164                 }
 165             }
 166             for (Entry<InstanceIdentifier<?>, DataObject> entry : change.getUpdatedData().entrySet()) {
 167                 if (entry.getValue() instanceof OfOverlayConfig) {
 168                     config = (OfOverlayConfig) entry.getValue();
 169                     applyConfig(config).get();
 170                     LOG.info("OF-Overlay config updated: {}", config);
 171                 }
 172             }
 173         } catch (InterruptedException | ExecutionException e) {
 174             LOG.error("Error occured while updating config for OF-Overlay Renderer.\n{}", e);
 175         }
 176     }
 177
 178     // **************
 179     // Implementation
 180     // **************
 181
 182     private void registerConfigListener(DataBroker dataProvider) {
 183         configReg =
 184                 dataProvider.registerDataChangeListener(LogicalDatastoreType.CONFIGURATION,
 185                         configIid,
 186                         this,
 187                         DataChangeScope.SUBTREE);
 188     }
 189
 190     private Optional<OfOverlayConfig> readConfig() {
 191         final ReadOnlyTransaction rTx = dataBroker.newReadOnlyTransaction();
 192         Optional<OfOverlayConfig> config =
 193                 DataStoreHelper.readFromDs(LogicalDatastoreType.CONFIGURATION,
 194                         configIid,
 195                         rTx);
 196         rTx.close();
 197         return config;
 198     }
 199
 200     private ListenableFuture<Void> writeTableOffset(OfOverlayConfig ofc) {
 201         WriteTransaction wTx = dataBroker.newWriteOnlyTransaction();
 202         wTx.merge(LogicalDatastoreType.CONFIGURATION, configIid, ofc, true);
 203         return wTx.submit();
 204     }
 205
 206     private ListenableFuture<List<Void>> applyConfig(@Nonnull OfOverlayConfig config) {
 207         List<ListenableFuture<Void>> configFutures = new ArrayList<>();
 208         // TODO add to list when implemented
 209         switchManager.setEncapsulationFormat(config.getEncapsulationFormat());
 210         endpointManager.setLearningMode(config.getLearningMode());
 211         policyManager.setLearningMode(config.getLearningMode());
 212         if (config.getGbpOfoverlayTableOffset() != null) {
 213             configFutures.add(policyManager.changeOpenFlowTableOffset(config.getGbpOfoverlayTableOffset()));
 214         }
 215         return Futures.allAsList(configFutures);
 216     }
 217 }