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