Java tutorial
/* * Copyright 2016, 2017 Ericsson India Global Services Pvt Ltd. and others. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Public License v1.0 which accompanies this distribution, * and is available at http://www.eclipse.org/legal/epl-v10.html */ package org.opendaylight.netvirt.fibmanager; import static org.opendaylight.netvirt.fibmanager.FibConstants.COOKIE_TUNNEL; import static org.opendaylight.netvirt.fibmanager.FibConstants.DEFAULT_FIB_FLOW_PRIORITY; import static org.opendaylight.netvirt.fibmanager.FibConstants.FLOWID_PREFIX; import com.google.common.base.Optional; import com.google.common.util.concurrent.Futures; import java.math.BigInteger; import java.net.InetAddress; import java.net.UnknownHostException; import java.util.ArrayList; import java.util.List; import java.util.concurrent.Future; import org.opendaylight.controller.md.sal.binding.api.DataBroker; import org.opendaylight.controller.md.sal.binding.api.WriteTransaction; import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType; import org.opendaylight.genius.mdsalutil.ActionInfo; import org.opendaylight.genius.mdsalutil.MDSALUtil; import org.opendaylight.genius.mdsalutil.MatchInfo; import org.opendaylight.genius.mdsalutil.MetaDataUtil; import org.opendaylight.genius.mdsalutil.NwConstants; import org.opendaylight.genius.mdsalutil.actions.ActionPopMpls; import org.opendaylight.genius.mdsalutil.instructions.InstructionApplyActions; import org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager; import org.opendaylight.genius.mdsalutil.matches.MatchEthernetType; import org.opendaylight.genius.mdsalutil.matches.MatchIpv4Destination; import org.opendaylight.genius.mdsalutil.matches.MatchMetadata; import org.opendaylight.genius.mdsalutil.matches.MatchMplsLabel; import org.opendaylight.genius.mdsalutil.matches.MatchTunnelId; import org.opendaylight.netvirt.fibmanager.api.IFibManager; import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow; import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction; import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fib.rpc.rev160121.CleanupDpnForVpnInput; import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fib.rpc.rev160121.CreateFibEntryInput; import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fib.rpc.rev160121.FibRpcService; import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fib.rpc.rev160121.PopulateFibOnDpnInput; import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fib.rpc.rev160121.RemoveFibEntryInput; import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnInstanceOpData; import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnInstanceToVpnId; import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntry; import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntryBuilder; import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntryKey; import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.VpnToDpnList; import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.VpnToDpnListBuilder; import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.VpnToDpnListKey; import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.vpn.to.dpn.list.IpAddressesBuilder; import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.vpn.to.dpn.list.IpAddressesKey; import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.vpn.to.dpn.list.VpnInterfaces; import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstance; import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstanceKey; import org.opendaylight.yangtools.yang.binding.DataObject; import org.opendaylight.yangtools.yang.binding.InstanceIdentifier; import org.opendaylight.yangtools.yang.common.RpcResult; import org.opendaylight.yangtools.yang.common.RpcResultBuilder; import org.slf4j.Logger; import org.slf4j.LoggerFactory; public class FibRpcServiceImpl implements FibRpcService { private static final Logger LOG = LoggerFactory.getLogger(FibRpcServiceImpl.class); private final DataBroker dataBroker; private final IMdsalApiManager mdsalManager; private final IFibManager fibManager; public FibRpcServiceImpl(final DataBroker dataBroker, final IMdsalApiManager mdsalManager, final IFibManager fibManager) { this.dataBroker = dataBroker; this.mdsalManager = mdsalManager; this.fibManager = fibManager; } /** * To install FIB routes on specified dpn with given instructions. */ @Override public Future<RpcResult<Void>> createFibEntry(CreateFibEntryInput input) { BigInteger dpnId = input.getSourceDpid(); String vpnName = input.getVpnName(); long vpnId = getVpnId(dataBroker, vpnName); String vpnRd = getVpnRd(dataBroker, vpnName); String ipAddress = input.getIpAddress(); LOG.info("Create custom FIB entry - {} on dpn {} for VPN {} ", ipAddress, dpnId, vpnName); List<Instruction> instructions = input.getInstruction(); LOG.info("ADD: Adding Custom Fib Entry rd {} prefix {} label {}", vpnRd, ipAddress, input.getServiceId()); makeLocalFibEntry(vpnId, dpnId, ipAddress, instructions); updateVpnToDpnAssociation(vpnId, dpnId, ipAddress, vpnName); LOG.info("ADD: Added Custom Fib Entry rd {} prefix {} label {}", vpnRd, ipAddress, input.getServiceId()); return Futures.immediateFuture(RpcResultBuilder.<Void>success().build()); } /** * To remove FIB/LFIB/TST routes from specified dpn. */ @Override public Future<RpcResult<Void>> removeFibEntry(RemoveFibEntryInput input) { BigInteger dpnId = input.getSourceDpid(); String vpnName = input.getVpnName(); long vpnId = getVpnId(dataBroker, vpnName); String vpnRd = getVpnRd(dataBroker, vpnName); long serviceId = input.getServiceId(); String ipAddress = input.getIpAddress(); LOG.info("Delete custom FIB entry - {} on dpn {} for VPN {} ", ipAddress, dpnId, vpnName); LOG.info("REMOVE: Removing Custom Fib Entry rd {} prefix {} label {}", vpnRd, ipAddress, input.getServiceId()); removeLocalFibEntry(dpnId, vpnId, ipAddress); //removeLFibTableEntry(dpnId, serviceId); //removeTunnelTableEntry(dpnId, serviceId); removeFromVpnDpnAssociation(vpnId, dpnId, ipAddress, vpnName); LOG.info("REMOVE: Removed Custom Fib Entry rd {} prefix {} label {}", vpnRd, ipAddress, input.getServiceId()); return Futures.immediateFuture(RpcResultBuilder.<Void>success().build()); } @Override public Future<RpcResult<Void>> populateFibOnDpn(PopulateFibOnDpnInput input) { fibManager.populateFibOnNewDpn(input.getDpid(), input.getVpnId(), input.getRd(), null); return Futures.immediateFuture(RpcResultBuilder.<Void>success().build()); } @Override public Future<RpcResult<Void>> cleanupDpnForVpn(CleanupDpnForVpnInput input) { fibManager.cleanUpDpnForVpn(input.getDpid(), input.getVpnId(), input.getRd(), null); return Futures.immediateFuture(RpcResultBuilder.<Void>success().build()); } private void removeLocalFibEntry(BigInteger dpnId, long vpnId, String ipPrefix) { String[] values = ipPrefix.split("/"); String ipAddress = values[0]; int prefixLength = (values.length == 1) ? 0 : Integer.parseInt(values[1]); LOG.debug("Removing route from DPN. ip {} masklen {}", ipAddress, prefixLength); InetAddress destPrefix = null; try { destPrefix = InetAddress.getByName(ipAddress); } catch (UnknownHostException e) { LOG.error("UnknowHostException in removeRoute. Failed to remove Route for ipPrefix {}", ipAddress, e); return; } List<MatchInfo> matches = new ArrayList<>(); matches.add(new MatchMetadata(MetaDataUtil.getVpnIdMetadata(vpnId), MetaDataUtil.METADATA_MASK_VRFID)); matches.add(MatchEthernetType.IPV4); if (prefixLength != 0) { matches.add(new MatchIpv4Destination(destPrefix.getHostAddress(), Integer.toString(prefixLength))); } String flowRef = getFlowRef(dpnId, NwConstants.L3_FIB_TABLE, vpnId, ipAddress); int priority = DEFAULT_FIB_FLOW_PRIORITY + prefixLength; Flow flowEntity = MDSALUtil.buildFlowNew(NwConstants.L3_FIB_TABLE, flowRef, priority, flowRef, 0, 0, NwConstants.COOKIE_VM_FIB_TABLE, matches, null); mdsalManager.removeFlow(dpnId, flowEntity); LOG.debug("FIB entry for route {} on dpn {} removed successfully", ipAddress, dpnId); } private void removeLFibTableEntry(BigInteger dpnId, long serviceId) { List<MatchInfo> matches = new ArrayList<>(); matches.add(MatchEthernetType.MPLS_UNICAST); matches.add(new MatchMplsLabel(serviceId)); String flowRef = getFlowRef(dpnId, NwConstants.L3_LFIB_TABLE, serviceId, ""); LOG.debug("removing LFib entry with flow ref {}", flowRef); Flow flowEntity = MDSALUtil.buildFlowNew(NwConstants.L3_LFIB_TABLE, flowRef, DEFAULT_FIB_FLOW_PRIORITY, flowRef, 0, 0, NwConstants.COOKIE_VM_LFIB_TABLE, matches, null); mdsalManager.removeFlow(dpnId, flowEntity); LOG.debug("LFIB Entry for dpID : {} label : {} removed successfully {}", dpnId, serviceId); } private void removeTunnelTableEntry(BigInteger dpnId, long serviceId) { LOG.info("remove terminatingServiceActions called with DpnId = {} and label = {}", dpnId, serviceId); List<MatchInfo> mkMatches = new ArrayList<>(); // Matching metadata mkMatches.add(new MatchTunnelId(BigInteger.valueOf(serviceId))); Flow flowEntity = MDSALUtil.buildFlowNew(NwConstants.INTERNAL_TUNNEL_TABLE, getFlowRef(dpnId, NwConstants.INTERNAL_TUNNEL_TABLE, serviceId, ""), 5, String.format("%s:%d", "TST Flow Entry ", serviceId), 0, 0, COOKIE_TUNNEL.add(BigInteger.valueOf(serviceId)), mkMatches, null); mdsalManager.removeFlow(dpnId, flowEntity); LOG.debug("Terminating service Entry for dpID {} : label : {} removed successfully {}", dpnId, serviceId); } private void makeTunnelTableEntry(BigInteger dpnId, long serviceId, List<Instruction> customInstructions) { List<MatchInfo> mkMatches = new ArrayList<>(); LOG.info("create terminatingServiceAction on DpnId = {} and serviceId = {} and actions = {}", dpnId, serviceId); mkMatches.add(new MatchTunnelId(BigInteger.valueOf(serviceId))); Flow terminatingServiceTableFlowEntity = MDSALUtil.buildFlowNew(NwConstants.INTERNAL_TUNNEL_TABLE, getFlowRef(dpnId, NwConstants.INTERNAL_TUNNEL_TABLE, serviceId, ""), 5, String.format("%s:%d", "TST Flow Entry ", serviceId), 0, 0, COOKIE_TUNNEL.add(BigInteger.valueOf(serviceId)), mkMatches, customInstructions); mdsalManager.installFlow(dpnId, terminatingServiceTableFlowEntity); } private long getIpAddress(byte[] rawIpAddress) { return (((rawIpAddress[0] & 0xFF) << (3 * 8)) + ((rawIpAddress[1] & 0xFF) << (2 * 8)) + ((rawIpAddress[2] & 0xFF) << (1 * 8)) + (rawIpAddress[3] & 0xFF)) & 0xffffffffL; } private void makeLocalFibEntry(long vpnId, BigInteger dpnId, String ipPrefix, List<Instruction> customInstructions) { String[] values = ipPrefix.split("/"); String ipAddress = values[0]; int prefixLength = (values.length == 1) ? 0 : Integer.parseInt(values[1]); LOG.debug("Adding route to DPN. ip {} masklen {}", ipAddress, prefixLength); InetAddress destPrefix = null; try { destPrefix = InetAddress.getByName(ipAddress); } catch (UnknownHostException e) { LOG.error("UnknowHostException in addRoute. Failed to add Route for ipPrefix {}", ipAddress, e); return; } List<MatchInfo> matches = new ArrayList<>(); matches.add(new MatchMetadata(MetaDataUtil.getVpnIdMetadata(vpnId), MetaDataUtil.METADATA_MASK_VRFID)); matches.add(MatchEthernetType.IPV4); if (prefixLength != 0) { matches.add(new MatchIpv4Destination(destPrefix.getHostAddress(), Integer.toString(prefixLength))); } String flowRef = getFlowRef(dpnId, NwConstants.L3_FIB_TABLE, vpnId, ipAddress); int priority = DEFAULT_FIB_FLOW_PRIORITY + prefixLength; Flow flowEntity = MDSALUtil.buildFlowNew(NwConstants.L3_FIB_TABLE, flowRef, priority, flowRef, 0, 0, NwConstants.COOKIE_VM_FIB_TABLE, matches, customInstructions); mdsalManager.installFlow(dpnId, flowEntity); LOG.debug("FIB entry for route {} on dpn {} installed successfully - flow {}", ipAddress, dpnId, flowEntity); } private void makeLFibTableEntry(BigInteger dpId, long serviceId, List<Instruction> customInstructions) { List<MatchInfo> matches = new ArrayList<>(); matches.add(MatchEthernetType.MPLS_UNICAST); matches.add(new MatchMplsLabel(serviceId)); List<Instruction> instructions = new ArrayList<>(); List<ActionInfo> actionsInfos = new ArrayList<>(); actionsInfos.add(new ActionPopMpls()); Instruction writeInstruction = new InstructionApplyActions(actionsInfos).buildInstruction(0); instructions.add(writeInstruction); instructions.addAll(customInstructions); // Install the flow entry in L3_LFIB_TABLE String flowRef = getFlowRef(dpId, NwConstants.L3_LFIB_TABLE, serviceId, ""); Flow flowEntity = MDSALUtil.buildFlowNew(NwConstants.L3_LFIB_TABLE, flowRef, DEFAULT_FIB_FLOW_PRIORITY, flowRef, 0, 0, NwConstants.COOKIE_VM_LFIB_TABLE, matches, instructions); mdsalManager.installFlow(dpId, flowEntity); LOG.debug("LFIB Entry for dpID {} : label : {} modified successfully {}", dpId, serviceId); } private String getFlowRef(BigInteger dpnId, short tableId, long id, String ipAddress) { return FLOWID_PREFIX + dpnId + NwConstants.FLOWID_SEPARATOR + tableId + NwConstants.FLOWID_SEPARATOR + id + NwConstants.FLOWID_SEPARATOR + ipAddress; } private synchronized void updateVpnToDpnAssociation(long vpnId, BigInteger dpnId, String ipAddr, String vpnName) { LOG.debug("Updating VPN to DPN list for dpn : {} for VPN: {} with ip: {}", dpnId, vpnName, ipAddr); String routeDistinguisher = getVpnRd(dataBroker, vpnName); String rd = (routeDistinguisher == null) ? vpnName : routeDistinguisher; synchronized (vpnName.intern()) { InstanceIdentifier<VpnToDpnList> id = getVpnToDpnListIdentifier(rd, dpnId); Optional<VpnToDpnList> dpnInVpn = MDSALUtil.read(dataBroker, LogicalDatastoreType.OPERATIONAL, id); org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.vpn.to.dpn.list.IpAddresses ipAddress = new IpAddressesBuilder() .setIpAddress(ipAddr).build(); if (dpnInVpn.isPresent()) { MDSALUtil.syncWrite(dataBroker, LogicalDatastoreType.OPERATIONAL, id.child( org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.vpn.to.dpn.list.IpAddresses.class, new IpAddressesKey(ipAddr)), ipAddress); } else { MDSALUtil.syncUpdate(dataBroker, LogicalDatastoreType.OPERATIONAL, getVpnInstanceOpDataIdentifier(rd), getVpnInstanceOpData(rd, vpnId, vpnName)); VpnToDpnListBuilder vpnToDpnList = new VpnToDpnListBuilder().setDpnId(dpnId); List<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.vpn.to.dpn.list.IpAddresses> ipAddresses = new ArrayList<>(); ipAddresses.add(ipAddress); MDSALUtil.syncWrite(dataBroker, LogicalDatastoreType.OPERATIONAL, id, vpnToDpnList.setIpAddresses(ipAddresses).build()); LOG.debug("populate FIB on new dpn {} for VPN {}", dpnId, vpnName); fibManager.populateFibOnNewDpn(dpnId, vpnId, rd, null); } } } private synchronized void removeFromVpnDpnAssociation(long vpnId, BigInteger dpnId, String ipAddr, String vpnName) { LOG.debug("Removing association of VPN to DPN list for dpn : {} for VPN: {} with ip: {}", dpnId, vpnName, ipAddr); String routeDistinguisher = getVpnRd(dataBroker, vpnName); String rd = (routeDistinguisher == null) ? vpnName : routeDistinguisher; synchronized (vpnName.intern()) { InstanceIdentifier<VpnToDpnList> id = getVpnToDpnListIdentifier(rd, dpnId); Optional<VpnToDpnList> dpnInVpn = MDSALUtil.read(dataBroker, LogicalDatastoreType.OPERATIONAL, id); if (dpnInVpn.isPresent()) { List<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.vpn.to.dpn.list.IpAddresses> ipAddresses = dpnInVpn .get().getIpAddresses(); org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.vpn.to.dpn.list.IpAddresses ipAddress = new IpAddressesBuilder() .setIpAddress(ipAddr).build(); if (ipAddresses != null && ipAddresses.remove(ipAddress)) { if (ipAddresses.isEmpty()) { List<VpnInterfaces> vpnInterfaces = dpnInVpn.get().getVpnInterfaces(); if (vpnInterfaces == null || vpnInterfaces.isEmpty()) { //Clean up the dpn LOG.debug("Cleaning up dpn {} from VPN {}", dpnId, vpnName); MDSALUtil.syncDelete(dataBroker, LogicalDatastoreType.OPERATIONAL, id); fibManager.cleanUpDpnForVpn(dpnId, vpnId, rd, null); } } else { delete(dataBroker, LogicalDatastoreType.OPERATIONAL, id.child( org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.vpn.to.dpn.list.IpAddresses.class, new IpAddressesKey(ipAddr))); } } } } } //TODO: Below Util methods to be removed once VpnUtil methods are exposed in api bundle public static String getVpnRd(DataBroker broker, String vpnName) { InstanceIdentifier<VpnInstance> id = getVpnInstanceToVpnIdIdentifier(vpnName); return MDSALUtil.read(broker, LogicalDatastoreType.CONFIGURATION, id).transform(VpnInstance::getVrfId) .orNull(); } static InstanceIdentifier<VpnInstance> getVpnInstanceToVpnIdIdentifier(String vpnName) { return InstanceIdentifier.builder(VpnInstanceToVpnId.class) .child(VpnInstance.class, new VpnInstanceKey(vpnName)).build(); } static InstanceIdentifier<VpnToDpnList> getVpnToDpnListIdentifier(String rd, BigInteger dpnId) { return InstanceIdentifier.builder(VpnInstanceOpData.class) .child(VpnInstanceOpDataEntry.class, new VpnInstanceOpDataEntryKey(rd)) .child(VpnToDpnList.class, new VpnToDpnListKey(dpnId)).build(); } static InstanceIdentifier<VpnInstanceOpDataEntry> getVpnInstanceOpDataIdentifier(String rd) { return InstanceIdentifier.builder(VpnInstanceOpData.class) .child(VpnInstanceOpDataEntry.class, new VpnInstanceOpDataEntryKey(rd)).build(); } static VpnInstanceOpDataEntry getVpnInstanceOpData(String rd, long vpnId, String vpnName) { return new VpnInstanceOpDataEntryBuilder().setVrfId(rd).setVpnId(vpnId).setVpnInstanceName(vpnName).build(); } static <T extends DataObject> void delete(DataBroker broker, LogicalDatastoreType datastoreType, InstanceIdentifier<T> path) { WriteTransaction tx = broker.newWriteOnlyTransaction(); tx.delete(datastoreType, path); tx.submit(); } static long getVpnId(DataBroker broker, String vpnName) { InstanceIdentifier<VpnInstance> id = getVpnInstanceToVpnIdIdentifier(vpnName); return MDSALUtil.read(broker, LogicalDatastoreType.CONFIGURATION, id).transform(VpnInstance::getVpnId) .or(-1L); } }