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