renderers/vpp/src/main/java/org/opendaylight/controller/config/yang/config/vpp_provider/impl/VppRenderer.java

   1 /*
   2  * Copyright (c) 2016 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.controller.config.yang.config.vpp_provider.impl;
  10
  11 import com.google.common.base.Preconditions;
  12 import com.google.common.collect.ImmutableList;
  13 import com.google.common.eventbus.EventBus;
  14 import com.google.common.util.concurrent.CheckedFuture;
  15 import com.google.common.util.concurrent.FutureCallback;
  16 import com.google.common.util.concurrent.Futures;
  17 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  18 import org.opendaylight.controller.md.sal.binding.api.MountPointService;
  19 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  20 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  21 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  22 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker;
  23 import org.opendaylight.controller.sal.binding.api.BindingAwareProvider;
  24 import org.opendaylight.groupbasedpolicy.renderer.vpp.api.BridgeDomainManager;
  25 import org.opendaylight.groupbasedpolicy.renderer.vpp.iface.InterfaceManager;
  26 import org.opendaylight.groupbasedpolicy.renderer.vpp.listener.RendererPolicyListener;
  27 import org.opendaylight.groupbasedpolicy.renderer.vpp.listener.VppEndpointListener;
  28 import org.opendaylight.groupbasedpolicy.renderer.vpp.listener.VppNodeListener;
  29 import org.opendaylight.groupbasedpolicy.renderer.vpp.manager.VppNodeManager;
  30 import org.opendaylight.groupbasedpolicy.renderer.vpp.nat.NatManager;
  31 import org.opendaylight.groupbasedpolicy.renderer.vpp.policy.BridgeDomainManagerImpl;
  32 import org.opendaylight.groupbasedpolicy.renderer.vpp.policy.ForwardingManager;
  33 import org.opendaylight.groupbasedpolicy.renderer.vpp.policy.VppRendererPolicyManager;
  34 import org.opendaylight.groupbasedpolicy.renderer.vpp.policy.acl.AclManager;
  35 import org.opendaylight.groupbasedpolicy.renderer.vpp.routing.RoutingManager;
  36 import org.opendaylight.groupbasedpolicy.renderer.vpp.sf.AllowAction;
  37 import org.opendaylight.groupbasedpolicy.renderer.vpp.sf.Classifier;
  38 import org.opendaylight.groupbasedpolicy.renderer.vpp.sf.EtherTypeClassifier;
  39 import org.opendaylight.groupbasedpolicy.renderer.vpp.sf.IpProtoClassifier;
  40 import org.opendaylight.groupbasedpolicy.renderer.vpp.sf.L4Classifier;
  41 import org.opendaylight.groupbasedpolicy.renderer.vpp.util.MountedDataBrokerProvider;
  42 import org.opendaylight.groupbasedpolicy.renderer.vpp.util.VppIidFactory;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.RendererName;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.Renderer;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.RendererBuilder;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.RendererKey;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.renderer.CapabilitiesBuilder;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.renderer.RendererNodesBuilder;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.renderer.capabilities.SupportedActionDefinition;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.renderer.capabilities.SupportedActionDefinitionBuilder;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.renderer.capabilities.SupportedClassifierDefinition;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.renderer.capabilities.SupportedClassifierDefinitionBuilder;
  53 import org.slf4j.Logger;
  54 import org.slf4j.LoggerFactory;
  55
  56 import javax.annotation.Nonnull;
  57 import javax.annotation.Nullable;
  58 import java.util.ArrayList;
  59 import java.util.List;
  60
  61 public class VppRenderer implements AutoCloseable, BindingAwareProvider {
  62
  63     public static final RendererName NAME = new RendererName("vpp-renderer");
  64     private static final Logger LOG = LoggerFactory.getLogger(VppRenderer.class);
  65     private final List<SupportedActionDefinition> actionDefinitions =
  66             ImmutableList.of(new SupportedActionDefinitionBuilder().setActionDefinitionId(new AllowAction().getId())
  67                     .setSupportedParameterValues(new AllowAction().getSupportedParameterValues())
  68                     .build());
  69     private final List<SupportedClassifierDefinition> classifierDefinitions;
  70
  71     private final DataBroker dataBroker;
  72     private final String publicInterfaces;
  73     private InterfaceManager interfaceManager;
  74     private MountedDataBrokerProvider mountDataProvider;
  75     private BridgeDomainManager bdManager;
  76     private VppNodeListener vppNodeListener;
  77     private VppEndpointListener vppEndpointListener;
  78     private RendererPolicyListener rendererPolicyListener;
  79
  80     VppRenderer(@Nonnull DataBroker dataBroker, @Nonnull BindingAwareBroker bindingAwareBroker,
  81                        @Nullable String publicInterfaces) {
  82         this.dataBroker = Preconditions.checkNotNull(dataBroker);
  83         this.publicInterfaces = publicInterfaces;
  84         bindingAwareBroker.registerProvider(this);
  85         EtherTypeClassifier etherTypeClassifier = new EtherTypeClassifier(null);
  86         IpProtoClassifier ipProtoClassifier = new IpProtoClassifier(etherTypeClassifier);
  87         classifierDefinitions =
  88                 buildClassifierDefinitions(etherTypeClassifier, ipProtoClassifier, new L4Classifier(ipProtoClassifier));
  89     }
  90
  91     private List<SupportedClassifierDefinition> buildClassifierDefinitions(Classifier... classifs) {
  92         List<SupportedClassifierDefinition> clDefs = new ArrayList<>();
  93         SupportedClassifierDefinitionBuilder clDefBuilder = new SupportedClassifierDefinitionBuilder();
  94         for (Classifier classif : classifs) {
  95             if (classif.getParent() != null) {
  96                 clDefBuilder.setParentClassifierDefinitionId(classif.getParent().getId());
  97             }
  98             clDefs.add(clDefBuilder.setClassifierDefinitionId(classif.getId())
  99                     .setSupportedParameterValues(classif.getSupportedParameterValues())
 100                     .build());
 101         }
 102         return clDefs;
 103     }
 104
 105     @Override
 106     public void close() throws Exception {
 107         LOG.info("Closing Vpp renderer");
 108         if (vppNodeListener != null) {
 109             vppNodeListener.close();
 110         }
 111         if (vppEndpointListener != null) {
 112             vppEndpointListener.close();
 113         }
 114         if (rendererPolicyListener != null) {
 115             rendererPolicyListener.close();
 116         }
 117         if (interfaceManager != null) {
 118             interfaceManager.close();
 119         }
 120         unregisterFromRendererManager();
 121     }
 122
 123     @Override
 124     public void onSessionInitiated(BindingAwareBroker.ProviderContext providerContext) {
 125         LOG.info("starting vpp renderer");
 126
 127         MountPointService mountService =
 128                 Preconditions.checkNotNull(providerContext.getSALService(MountPointService.class));
 129         mountDataProvider = new MountedDataBrokerProvider(mountService, dataBroker);
 130         VppNodeManager vppNodeManager = new VppNodeManager(dataBroker, providerContext, publicInterfaces);
 131
 132         EventBus dtoEventBus = new EventBus((exception, context) -> LOG.error("Could not dispatch event: {} to {}",
 133                 context.getSubscriber(), context.getSubscriberMethod(), exception));
 134         interfaceManager = new InterfaceManager(mountDataProvider, dataBroker);
 135         AclManager aclManager = new AclManager(mountDataProvider);
 136         NatManager natManager = new NatManager(dataBroker, mountDataProvider);
 137         dtoEventBus.register(interfaceManager);
 138         RoutingManager routingManager = new RoutingManager(dataBroker, mountDataProvider);
 139         bdManager = new BridgeDomainManagerImpl(dataBroker);
 140         ForwardingManager fwManager =
 141                 new ForwardingManager(interfaceManager, aclManager, natManager, routingManager, bdManager, dataBroker);
 142         VppRendererPolicyManager vppRendererPolicyManager = new VppRendererPolicyManager(fwManager, aclManager, dataBroker);
 143         dtoEventBus.register(vppRendererPolicyManager);
 144
 145         vppNodeListener = new VppNodeListener(dataBroker, vppNodeManager, dtoEventBus);
 146         vppEndpointListener = new VppEndpointListener(dataBroker, dtoEventBus);
 147         rendererPolicyListener = new RendererPolicyListener(dataBroker, dtoEventBus);
 148         registerToRendererManager();
 149     }
 150
 151     private void registerToRendererManager() {
 152         WriteTransaction writeTransaction = dataBroker.newWriteOnlyTransaction();
 153
 154         Renderer renderer = new RendererBuilder().setName(VppRenderer.NAME)
 155                 .setRendererNodes(new RendererNodesBuilder().build())
 156                 .setCapabilities(new CapabilitiesBuilder().setSupportedActionDefinition(actionDefinitions)
 157                         .setSupportedClassifierDefinition(classifierDefinitions)
 158                         .build())
 159                 .build();
 160
 161         writeTransaction.put(LogicalDatastoreType.OPERATIONAL, VppIidFactory.getRendererIID(renderer.getKey()),
 162                 renderer, true);
 163         CheckedFuture<Void, TransactionCommitFailedException> future = writeTransaction.submit();
 164         Futures.addCallback(future, new FutureCallback<Void>() {
 165
 166             @Override
 167             public void onFailure(@Nonnull Throwable throwable) {
 168                 LOG.error("Could not register renderer {}: {}", renderer, throwable);
 169             }
 170
 171             @Override
 172             public void onSuccess(Void result) {
 173                 LOG.debug("Renderer {} successfully registered.", renderer);
 174             }
 175         });
 176     }
 177
 178     private void unregisterFromRendererManager() {
 179         WriteTransaction writeTransaction = dataBroker.newWriteOnlyTransaction();
 180         writeTransaction.delete(LogicalDatastoreType.OPERATIONAL,
 181                 VppIidFactory.getRendererIID(new RendererKey(VppRenderer.NAME)));
 182
 183         CheckedFuture<Void, TransactionCommitFailedException> future = writeTransaction.submit();
 184         Futures.addCallback(future, new FutureCallback<Void>() {
 185
 186             @Override
 187             public void onFailure(@Nonnull Throwable throwable) {
 188                 LOG.error("Could not unregister renderer {}: {}", VppRenderer.NAME, throwable);
 189             }
 190
 191             @Override
 192             public void onSuccess(Void result) {
 193                 LOG.debug("Renderer {} successfully unregistered.", VppRenderer.NAME);
 194             }
 195         });
 196     }
 197
 198     public MountedDataBrokerProvider getMountedDataBroker() {
 199         return mountDataProvider;
 200     }
 201
 202     public InterfaceManager getInterfaceManager() {
 203         return interfaceManager;
 204     }
 205
 206     public BridgeDomainManager getBridgeDomainManager() {
 207         return bdManager;
 208     }
 209 }