fibmanager/impl/src/main/java/org/opendaylight/netvirt/fibmanager/FibRpcServiceImpl.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.fibmanager;
   9
  10 import com.google.common.util.concurrent.ListenableFuture;
  11 import java.math.BigInteger;
  12 import java.net.InetAddress;
  13 import java.net.UnknownHostException;
  14 import java.util.ArrayList;
  15 import java.util.List;
  16 import javax.inject.Inject;
  17 import javax.inject.Singleton;
  18 import org.apache.commons.lang3.tuple.ImmutablePair;
  19 import org.eclipse.jdt.annotation.Nullable;
  20 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  21 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  22 import org.opendaylight.genius.mdsalutil.MDSALUtil;
  23 import org.opendaylight.genius.mdsalutil.MatchInfo;
  24 import org.opendaylight.genius.mdsalutil.MetaDataUtil;
  25 import org.opendaylight.genius.mdsalutil.NwConstants;
  26 import org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager;
  27 import org.opendaylight.genius.mdsalutil.matches.MatchEthernetType;
  28 import org.opendaylight.genius.mdsalutil.matches.MatchIpv4Destination;
  29 import org.opendaylight.genius.mdsalutil.matches.MatchMetadata;
  30 import org.opendaylight.netvirt.fibmanager.api.IFibManager;
  31 import org.opendaylight.netvirt.vpnmanager.api.IVpnFootprintService;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fib.rpc.rev160121.CleanupDpnForVpnInput;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fib.rpc.rev160121.CleanupDpnForVpnOutput;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fib.rpc.rev160121.CleanupDpnForVpnOutputBuilder;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fib.rpc.rev160121.CreateFibEntryInput;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fib.rpc.rev160121.CreateFibEntryOutput;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fib.rpc.rev160121.CreateFibEntryOutputBuilder;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fib.rpc.rev160121.FibRpcService;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fib.rpc.rev160121.PopulateFibOnDpnInput;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fib.rpc.rev160121.PopulateFibOnDpnOutput;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fib.rpc.rev160121.PopulateFibOnDpnOutputBuilder;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fib.rpc.rev160121.RemoveFibEntryInput;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fib.rpc.rev160121.RemoveFibEntryOutput;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fib.rpc.rev160121.RemoveFibEntryOutputBuilder;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnInstanceToVpnId;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.vpn.to.dpn.list.IpAddresses;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstance;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstanceKey;
  51 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  52 import org.opendaylight.yangtools.yang.common.RpcResult;
  53 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  54 import org.slf4j.Logger;
  55 import org.slf4j.LoggerFactory;
  56
  57 @Singleton
  58 public class FibRpcServiceImpl implements FibRpcService {
  59     private static final Logger LOG = LoggerFactory.getLogger(FibRpcServiceImpl.class);
  60     private final DataBroker dataBroker;
  61     private final IMdsalApiManager mdsalManager;
  62     private final IFibManager fibManager;
  63     private final IVpnFootprintService vpnFootprintService;
  64
  65     @Inject
  66     public FibRpcServiceImpl(final DataBroker dataBroker, final IMdsalApiManager mdsalManager,
  67                              final IFibManager fibManager, final IVpnFootprintService vpnFootprintService) {
  68         this.dataBroker = dataBroker;
  69         this.mdsalManager = mdsalManager;
  70         this.fibManager = fibManager;
  71         this.vpnFootprintService = vpnFootprintService;
  72     }
  73
  74     /**
  75      * To install FIB routes on specified dpn with given instructions.
  76      */
  77     @Override
  78     public ListenableFuture<RpcResult<CreateFibEntryOutput>> createFibEntry(CreateFibEntryInput input) {
  79
  80         BigInteger dpnId = input.getSourceDpid();
  81         String vpnName = input.getVpnName();
  82         long vpnId = getVpnId(dataBroker, vpnName);
  83         String vpnRd = getVpnRd(dataBroker, vpnName);
  84         String ipAddress = input.getIpAddress();
  85         LOG.info("Create custom FIB entry - {} on dpn {} for VPN {} ", ipAddress, dpnId, vpnName);
  86         List<Instruction> instructions = input.getInstruction();
  87         LOG.info("ADD: Adding Custom Fib Entry rd {} prefix {} label {}", vpnRd, ipAddress, input.getServiceId());
  88         makeLocalFibEntry(vpnId, dpnId, ipAddress, instructions);
  89         IpAddresses.IpAddressSource ipAddressSource = IpAddresses.IpAddressSource
  90                 .forValue(input.getIpAddressSource().getIntValue());
  91         vpnFootprintService.updateVpnToDpnMapping(dpnId, vpnName, vpnRd, null /* interfaceName*/,
  92                 new ImmutablePair<>(ipAddressSource, ipAddress), true /*add*/);
  93         LOG.info("ADD: Added Custom Fib Entry rd {} prefix {} label {}", vpnRd, ipAddress, input.getServiceId());
  94         return RpcResultBuilder.success(new CreateFibEntryOutputBuilder().build()).buildFuture();
  95     }
  96
  97     /**
  98      * To remove FIB/LFIB/TST routes from specified dpn.
  99      */
 100     @Override
 101     public ListenableFuture<RpcResult<RemoveFibEntryOutput>> removeFibEntry(RemoveFibEntryInput input) {
 102         BigInteger dpnId = input.getSourceDpid();
 103         String vpnName = input.getVpnName();
 104         long vpnId = getVpnId(dataBroker, vpnName);
 105         String vpnRd = getVpnRd(dataBroker, vpnName);
 106
 107         String ipAddress = input.getIpAddress();
 108
 109         LOG.info("Delete custom FIB entry - {} on dpn {} for VPN {} ", ipAddress, dpnId, vpnName);
 110         LOG.info("REMOVE: Removing Custom Fib Entry rd {} prefix {} label {}", vpnRd, ipAddress, input.getServiceId());
 111         removeLocalFibEntry(dpnId, vpnId, ipAddress);
 112         IpAddresses.IpAddressSource ipAddressSource = IpAddresses.IpAddressSource
 113                 .forValue(input.getIpAddressSource().getIntValue());
 114         vpnFootprintService.updateVpnToDpnMapping(dpnId, vpnName, vpnRd, null /* interfaceName*/,
 115                 new ImmutablePair<>(ipAddressSource, ipAddress), false /*add*/);
 116         LOG.info("REMOVE: Removed Custom Fib Entry rd {} prefix {} label {}", vpnRd, ipAddress, input.getServiceId());
 117         return RpcResultBuilder.success(new RemoveFibEntryOutputBuilder().build()).buildFuture();
 118     }
 119
 120
 121     @Override
 122     public ListenableFuture<RpcResult<PopulateFibOnDpnOutput>> populateFibOnDpn(PopulateFibOnDpnInput input) {
 123         fibManager.populateFibOnNewDpn(input.getDpid(), input.getVpnId(), input.getRd(), null);
 124         return RpcResultBuilder.success(new PopulateFibOnDpnOutputBuilder().build()).buildFuture();
 125     }
 126
 127     @Override
 128     public ListenableFuture<RpcResult<CleanupDpnForVpnOutput>> cleanupDpnForVpn(CleanupDpnForVpnInput input) {
 129         fibManager.cleanUpDpnForVpn(input.getDpid(), input.getVpnId(), input.getRd(), null);
 130         return RpcResultBuilder.success(new CleanupDpnForVpnOutputBuilder().build()).buildFuture();
 131     }
 132
 133     private void removeLocalFibEntry(BigInteger dpnId, long vpnId, String ipPrefix) {
 134         String[] values = ipPrefix.split("/");
 135         String ipAddress = values[0];
 136         int prefixLength = values.length == 1 ? 0 : Integer.parseInt(values[1]);
 137         LOG.debug("Removing route from DPN. ip {} masklen {}", ipAddress, prefixLength);
 138         InetAddress destPrefix = null;
 139         try {
 140             destPrefix = InetAddress.getByName(ipAddress);
 141         } catch (UnknownHostException e) {
 142             LOG.error("UnknowHostException in removeRoute. Failed  to remove Route for ipPrefix {} DPN {} Vpn {}",
 143                     ipAddress, dpnId, vpnId, e);
 144             return;
 145         }
 146         List<MatchInfo> matches = new ArrayList<>();
 147
 148         matches.add(new MatchMetadata(MetaDataUtil.getVpnIdMetadata(vpnId), MetaDataUtil.METADATA_MASK_VRFID));
 149
 150         matches.add(MatchEthernetType.IPV4);
 151
 152         if (prefixLength != 0) {
 153             matches.add(new MatchIpv4Destination(destPrefix.getHostAddress(), Integer.toString(prefixLength)));
 154         }
 155
 156         String flowRef = getFlowRef(dpnId, NwConstants.L3_FIB_TABLE, vpnId, ipAddress);
 157
 158
 159         int priority = FibConstants.DEFAULT_FIB_FLOW_PRIORITY + prefixLength;
 160         Flow flowEntity = MDSALUtil.buildFlowNew(NwConstants.L3_FIB_TABLE, flowRef,
 161             priority, flowRef, 0, 0,
 162             NwConstants.COOKIE_VM_FIB_TABLE, matches, null);
 163
 164         mdsalManager.removeFlow(dpnId, flowEntity);
 165
 166         LOG.info("FIB entry for prefix {} on dpn {} vpn {} removed successfully", ipAddress, dpnId,  vpnId);
 167     }
 168
 169     private void makeLocalFibEntry(long vpnId, BigInteger dpnId, String ipPrefix,
 170                                    List<Instruction> customInstructions) {
 171         String[] values = ipPrefix.split("/");
 172         String ipAddress = values[0];
 173         int prefixLength = values.length == 1 ? 0 : Integer.parseInt(values[1]);
 174         LOG.debug("Adding route to DPN. ip {} masklen {}", ipAddress, prefixLength);
 175         InetAddress destPrefix = null;
 176         try {
 177             destPrefix = InetAddress.getByName(ipAddress);
 178         } catch (UnknownHostException e) {
 179             LOG.error("UnknowHostException in addRoute. Failed  to add Route for ipPrefix {} VpnId {} DPN{}",
 180                     ipAddress, vpnId, dpnId, e);
 181             return;
 182         }
 183         List<MatchInfo> matches = new ArrayList<>();
 184
 185         matches.add(new MatchMetadata(MetaDataUtil.getVpnIdMetadata(vpnId), MetaDataUtil.METADATA_MASK_VRFID));
 186
 187         matches.add(MatchEthernetType.IPV4);
 188
 189         if (prefixLength != 0) {
 190             matches.add(new MatchIpv4Destination(destPrefix.getHostAddress(), Integer.toString(prefixLength)));
 191         }
 192
 193         String flowRef = getFlowRef(dpnId, NwConstants.L3_FIB_TABLE, vpnId, ipAddress);
 194
 195
 196         int priority = FibConstants.DEFAULT_FIB_FLOW_PRIORITY + prefixLength;
 197         Flow flowEntity = MDSALUtil.buildFlowNew(NwConstants.L3_FIB_TABLE, flowRef,
 198             priority, flowRef, 0, 0,
 199             NwConstants.COOKIE_VM_FIB_TABLE, matches, customInstructions);
 200         mdsalManager.installFlow(dpnId, flowEntity);
 201
 202         LOG.debug("FIB entry for route {} on dpn {} installed successfully - flow {}", ipAddress, dpnId, flowEntity);
 203     }
 204
 205     private String getFlowRef(BigInteger dpnId, short tableId, long id, String ipAddress) {
 206         return FibConstants.FLOWID_PREFIX + dpnId + NwConstants.FLOWID_SEPARATOR + tableId
 207                 + NwConstants.FLOWID_SEPARATOR + id + NwConstants.FLOWID_SEPARATOR + ipAddress;
 208     }
 209
 210     //TODO: Below Util methods to be removed once VpnUtil methods are exposed in api bundle
 211     @Nullable
 212     public static String getVpnRd(DataBroker broker, String vpnName) {
 213         InstanceIdentifier<VpnInstance> id = getVpnInstanceToVpnIdIdentifier(vpnName);
 214         return MDSALUtil.read(broker, LogicalDatastoreType.CONFIGURATION, id).toJavaUtil().map(
 215                 VpnInstance::getVrfId).orElse(null);
 216     }
 217
 218     static InstanceIdentifier<VpnInstance> getVpnInstanceToVpnIdIdentifier(String vpnName) {
 219         return InstanceIdentifier.builder(VpnInstanceToVpnId.class)
 220             .child(VpnInstance.class, new VpnInstanceKey(vpnName)).build();
 221     }
 222
 223
 224     static long getVpnId(DataBroker broker, String vpnName) {
 225         InstanceIdentifier<VpnInstance> id = getVpnInstanceToVpnIdIdentifier(vpnName);
 226         return MDSALUtil.read(broker, LogicalDatastoreType.CONFIGURATION, id).toJavaUtil().map(
 227                 VpnInstance::getVpnId).orElse(-1L);
 228     }
 229 }