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