neutronvpn/impl/src/main/java/org/opendaylight/netvirt/neutronvpn/NeutronRouterChangeListener.java

   1 /*
   2  * Copyright © 2016, 2017 Ericsson India Global Services Pvt Ltd. 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 package org.opendaylight.netvirt.neutronvpn;
   9
  10 import com.google.common.base.Optional;
  11 import java.util.ArrayList;
  12 import java.util.HashMap;
  13 import java.util.List;
  14 import javax.annotation.PostConstruct;
  15 import javax.inject.Inject;
  16 import javax.inject.Singleton;
  17 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  18 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  19 import org.opendaylight.genius.datastoreutils.AsyncDataTreeChangeListenerBase;
  20 import org.opendaylight.genius.mdsalutil.NwConstants;
  21 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.l3.attributes.Routes;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.Routers;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.routers.Router;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.routers.router.external_gateway_info.ExternalFixedIps;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.rev150712.Neutron;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.inter.vpn.link.states.InterVpnLinkState;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.inter.vpn.links.InterVpnLink;
  29 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  30 import org.slf4j.Logger;
  31 import org.slf4j.LoggerFactory;
  32
  33 @Singleton
  34 public class NeutronRouterChangeListener extends AsyncDataTreeChangeListenerBase<Router, NeutronRouterChangeListener> {
  35     private static final Logger LOG = LoggerFactory.getLogger(NeutronRouterChangeListener.class);
  36     private final DataBroker dataBroker;
  37     private final NeutronvpnManager nvpnManager;
  38     private final NeutronvpnNatManager nvpnNatManager;
  39     private final NeutronSubnetGwMacResolver gwMacResolver;
  40     private final NeutronvpnUtils neutronvpnUtils;
  41
  42     @Inject
  43     public NeutronRouterChangeListener(final DataBroker dataBroker, final NeutronvpnManager neutronvpnManager,
  44                                        final NeutronvpnNatManager neutronvpnNatManager,
  45                                        final NeutronSubnetGwMacResolver gwMacResolver,
  46                                        final NeutronvpnUtils neutronvpnUtils) {
  47         super(Router.class, NeutronRouterChangeListener.class);
  48         this.dataBroker = dataBroker;
  49         nvpnManager = neutronvpnManager;
  50         nvpnNatManager = neutronvpnNatManager;
  51         this.gwMacResolver = gwMacResolver;
  52         this.neutronvpnUtils = neutronvpnUtils;
  53     }
  54
  55     @Override
  56     @PostConstruct
  57     public void init() {
  58         LOG.info("{} init", getClass().getSimpleName());
  59         registerListener(LogicalDatastoreType.CONFIGURATION, dataBroker);
  60     }
  61
  62     @Override
  63     protected InstanceIdentifier<Router> getWildCardPath() {
  64         return InstanceIdentifier.create(Neutron.class).child(Routers.class).child(Router.class);
  65     }
  66
  67     @Override
  68     protected NeutronRouterChangeListener getDataTreeChangeListener() {
  69         return NeutronRouterChangeListener.this;
  70     }
  71
  72
  73     @Override
  74     protected void add(InstanceIdentifier<Router> identifier, Router input) {
  75         LOG.trace("Adding Router : key: {}, value={}", identifier, input);
  76         neutronvpnUtils.addToRouterCache(input);
  77         // Create internal VPN
  78         nvpnManager.createL3InternalVpn(input.getUuid(), null, null, null, null, null, input.getUuid(), null);
  79         nvpnNatManager.handleExternalNetworkForRouter(null, input);
  80         gwMacResolver.sendArpRequestsToExtGateways(input);
  81     }
  82
  83     @Override
  84     protected void remove(InstanceIdentifier<Router> identifier, Router input) {
  85         LOG.trace("Removing router : key: {}, value={}", identifier, input);
  86         Uuid routerId = input.getUuid();
  87         // Handle router deletion for the NAT service
  88         /*External Router and networks is handled before deleting the internal VPN, as there is dependency
  89         on vpn operational data to release Lport tag in case of L3VPN over VxLAN*/
  90         if (input.getExternalGatewayInfo() != null) {
  91             Uuid extNetId = input.getExternalGatewayInfo().getExternalNetworkId();
  92             List<ExternalFixedIps> externalFixedIps = input.getExternalGatewayInfo().getExternalFixedIps();
  93             nvpnNatManager.removeExternalNetworkFromRouter(extNetId, input, externalFixedIps);
  94         }
  95         //NOTE: Pass an empty routerSubnetIds list, as router interfaces
  96         //will be removed from VPN by invocations from NeutronPortChangeListener
  97         List<Uuid> routerSubnetIds = new ArrayList<>();
  98         nvpnManager.handleNeutronRouterDeleted(routerId, routerSubnetIds);
  99
 100         neutronvpnUtils.removeFromRouterCache(input);
 101     }
 102
 103     @Override
 104     protected void update(InstanceIdentifier<Router> identifier, Router original, Router update) {
 105         LOG.trace("Updating Router : key: {}, original value={}, update value={}", identifier, original, update);
 106         neutronvpnUtils.addToRouterCache(update);
 107         Uuid routerId = update.getUuid();
 108         neutronvpnUtils.addToRouterCache(update);
 109         Uuid vpnId = neutronvpnUtils.getVpnForRouter(routerId, true);
 110         // internal vpn always present in case external vpn not found
 111         if (vpnId == null) {
 112             vpnId = routerId;
 113         }
 114         List<Routes> oldRoutes = original.getRoutes() != null ? original.getRoutes() : new ArrayList<>();
 115         List<Routes> newRoutes = update.getRoutes() != null ? update.getRoutes() : new ArrayList<>();
 116         if (!oldRoutes.equals(newRoutes)) {
 117             newRoutes.removeIf(oldRoutes::remove);
 118
 119             if (!oldRoutes.isEmpty()) {
 120                 handleChangedRoutes(vpnId, oldRoutes, NwConstants.DEL_FLOW);
 121             }
 122
 123             //After initial extra-route configuration using cmd-"neutron router-update RouterA destination=IP-A,
 124             // nexthop=prefix-A",if another update is done using command - "neutron router-update RouterA
 125             // destination=IP-A,nexthop=prefix-B",neutron router listener calls update on prefix-A as well as prefix-B.
 126             // On prefix-A , secondary adj (IP-A) is removed ,where as its added on prefix-B. This back-to-back update
 127             // creates race-condition in Vrf Engine ,leading inconsistencies in l3nexthop, VpnExtraRoute,
 128             // VpnInterfaceOp DS. Hence a temporary fix of 2sec delay is introduced in neutron.
 129             // A better fix/design need to be thought to avoid race condition
 130             try {
 131                 Thread.sleep(2000); // sleep for 2sec
 132             } catch (java.lang.InterruptedException e) {
 133                 LOG.error("Exception while sleeping", e);
 134             }
 135
 136             handleChangedRoutes(vpnId, newRoutes, NwConstants.ADD_FLOW);
 137         }
 138
 139         nvpnNatManager.handleExternalNetworkForRouter(original, update);
 140         gwMacResolver.sendArpRequestsToExtGateways(update);
 141     }
 142
 143     private void handleChangedRoutes(Uuid vpnName, List<Routes> routes, int addedOrRemoved) {
 144         // Some routes may point to an InterVpnLink's endpoint, lets treat them differently
 145         List<Routes> interVpnLinkRoutes = new ArrayList<>();
 146         List<Routes> otherRoutes = new ArrayList<>();
 147         HashMap<String, InterVpnLink> nexthopsXinterVpnLinks = new HashMap<>();
 148         for (Routes route : routes) {
 149             String nextHop = String.valueOf(route.getNexthop().getValue());
 150             // Nexthop is another VPN?
 151             Optional<InterVpnLink> interVpnLink = neutronvpnUtils.getInterVpnLinkByEndpointIp(nextHop);
 152             if (interVpnLink.isPresent()) {
 153                 Optional<InterVpnLinkState> interVpnLinkState =
 154                         neutronvpnUtils.getInterVpnLinkState(interVpnLink.get().getName());
 155                 if (interVpnLinkState.isPresent() && interVpnLinkState.get().getState()
 156                         == InterVpnLinkState.State.Active) {
 157                     interVpnLinkRoutes.add(route);
 158                     nexthopsXinterVpnLinks.put(nextHop, interVpnLink.get());
 159                 } else {
 160                     LOG.error("Failed installing route to {}. Reason: InterVPNLink {} is not Active",
 161                             String.valueOf(route.getDestination().getValue()), interVpnLink.get().getName());
 162                 }
 163             } else {
 164                 otherRoutes.add(route);
 165             }
 166         }
 167
 168         if (addedOrRemoved == NwConstants.ADD_FLOW) {
 169             nvpnManager.addInterVpnRoutes(vpnName, interVpnLinkRoutes, nexthopsXinterVpnLinks);
 170             nvpnManager.updateVpnInterfaceWithExtraRouteAdjacency(vpnName, otherRoutes);
 171         } else {
 172             nvpnManager.removeAdjacencyforExtraRoute(vpnName, otherRoutes);
 173             nvpnManager.removeInterVpnRoutes(vpnName, interVpnLinkRoutes, nexthopsXinterVpnLinks);
 174         }
 175     }
 176 }