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