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