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