2 * Copyright © 2016, 2017 Ericsson India Global Services Pvt Ltd. and others. All rights reserved.
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
8 package org.opendaylight.netvirt.fibmanager;
10 import static org.opendaylight.netvirt.fibmanager.FibConstants.DEFAULT_FIB_FLOW_PRIORITY;
11 import static org.opendaylight.netvirt.fibmanager.FibConstants.FLOWID_PREFIX;
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.eclipse.jdt.annotation.Nullable;
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.VpnInstanceToVpnId;
51 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;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstance;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstanceKey;
54 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
55 import org.opendaylight.yangtools.yang.common.RpcResult;
56 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
57 import org.slf4j.Logger;
58 import org.slf4j.LoggerFactory;
61 public class FibRpcServiceImpl implements FibRpcService {
62 private static final Logger LOG = LoggerFactory.getLogger(FibRpcServiceImpl.class);
63 private final DataBroker dataBroker;
64 private final IMdsalApiManager mdsalManager;
65 private final IFibManager fibManager;
66 private final IVpnFootprintService vpnFootprintService;
69 public FibRpcServiceImpl(final DataBroker dataBroker, final IMdsalApiManager mdsalManager,
70 final IFibManager fibManager, final IVpnFootprintService vpnFootprintService) {
71 this.dataBroker = dataBroker;
72 this.mdsalManager = mdsalManager;
73 this.fibManager = fibManager;
74 this.vpnFootprintService = vpnFootprintService;
78 * To install FIB routes on specified dpn with given instructions.
81 public ListenableFuture<RpcResult<CreateFibEntryOutput>> createFibEntry(CreateFibEntryInput input) {
83 BigInteger dpnId = input.getSourceDpid();
84 String vpnName = input.getVpnName();
85 long vpnId = getVpnId(dataBroker, vpnName);
86 String vpnRd = getVpnRd(dataBroker, vpnName);
87 String ipAddress = input.getIpAddress();
88 LOG.info("Create custom FIB entry - {} on dpn {} for VPN {} ", ipAddress, dpnId, vpnName);
89 List<Instruction> instructions = input.getInstruction();
90 LOG.info("ADD: Adding Custom Fib Entry rd {} prefix {} label {}", vpnRd, ipAddress, input.getServiceId());
91 makeLocalFibEntry(vpnId, dpnId, ipAddress, instructions);
92 IpAddresses.IpAddressSource ipAddressSource = IpAddresses.IpAddressSource
93 .forValue(input.getIpAddressSource().getIntValue());
94 vpnFootprintService.updateVpnToDpnMapping(dpnId, vpnName, vpnRd, null /* interfaceName*/,
95 new ImmutablePair<>(ipAddressSource, ipAddress), true /*add*/);
96 LOG.info("ADD: Added Custom Fib Entry rd {} prefix {} label {}", vpnRd, ipAddress, input.getServiceId());
97 return RpcResultBuilder.success(new CreateFibEntryOutputBuilder().build()).buildFuture();
101 * To remove FIB/LFIB/TST routes from specified dpn.
104 public ListenableFuture<RpcResult<RemoveFibEntryOutput>> removeFibEntry(RemoveFibEntryInput input) {
105 BigInteger dpnId = input.getSourceDpid();
106 String vpnName = input.getVpnName();
107 long vpnId = getVpnId(dataBroker, vpnName);
108 String vpnRd = getVpnRd(dataBroker, vpnName);
110 String ipAddress = input.getIpAddress();
112 LOG.info("Delete custom FIB entry - {} on dpn {} for VPN {} ", ipAddress, dpnId, vpnName);
113 LOG.info("REMOVE: Removing Custom Fib Entry rd {} prefix {} label {}", vpnRd, ipAddress, input.getServiceId());
114 removeLocalFibEntry(dpnId, vpnId, ipAddress);
115 IpAddresses.IpAddressSource ipAddressSource = IpAddresses.IpAddressSource
116 .forValue(input.getIpAddressSource().getIntValue());
117 vpnFootprintService.updateVpnToDpnMapping(dpnId, vpnName, vpnRd, null /* interfaceName*/,
118 new ImmutablePair<>(ipAddressSource, ipAddress), false /*add*/);
119 LOG.info("REMOVE: Removed Custom Fib Entry rd {} prefix {} label {}", vpnRd, ipAddress, input.getServiceId());
120 return RpcResultBuilder.success(new RemoveFibEntryOutputBuilder().build()).buildFuture();
125 public ListenableFuture<RpcResult<PopulateFibOnDpnOutput>> populateFibOnDpn(PopulateFibOnDpnInput input) {
126 fibManager.populateFibOnNewDpn(input.getDpid(), input.getVpnId(), input.getRd(), null);
127 return RpcResultBuilder.success(new PopulateFibOnDpnOutputBuilder().build()).buildFuture();
131 public ListenableFuture<RpcResult<CleanupDpnForVpnOutput>> cleanupDpnForVpn(CleanupDpnForVpnInput input) {
132 fibManager.cleanUpDpnForVpn(input.getDpid(), input.getVpnId(), input.getRd(), null);
133 return RpcResultBuilder.success(new CleanupDpnForVpnOutputBuilder().build()).buildFuture();
136 private void removeLocalFibEntry(BigInteger dpnId, long vpnId, String ipPrefix) {
137 String[] values = ipPrefix.split("/");
138 String ipAddress = values[0];
139 int prefixLength = values.length == 1 ? 0 : Integer.parseInt(values[1]);
140 LOG.debug("Removing route from DPN. ip {} masklen {}", ipAddress, prefixLength);
141 InetAddress destPrefix = null;
143 destPrefix = InetAddress.getByName(ipAddress);
144 } catch (UnknownHostException e) {
145 LOG.error("UnknowHostException in removeRoute. Failed to remove Route for ipPrefix {} DPN {} Vpn {}",
146 ipAddress, dpnId, vpnId, e);
149 List<MatchInfo> matches = new ArrayList<>();
151 matches.add(new MatchMetadata(MetaDataUtil.getVpnIdMetadata(vpnId), MetaDataUtil.METADATA_MASK_VRFID));
153 matches.add(MatchEthernetType.IPV4);
155 if (prefixLength != 0) {
156 matches.add(new MatchIpv4Destination(destPrefix.getHostAddress(), Integer.toString(prefixLength)));
159 String flowRef = getFlowRef(dpnId, NwConstants.L3_FIB_TABLE, vpnId, ipAddress);
162 int priority = DEFAULT_FIB_FLOW_PRIORITY + prefixLength;
163 Flow flowEntity = MDSALUtil.buildFlowNew(NwConstants.L3_FIB_TABLE, flowRef,
164 priority, flowRef, 0, 0,
165 NwConstants.COOKIE_VM_FIB_TABLE, matches, null);
167 mdsalManager.removeFlow(dpnId, flowEntity);
169 LOG.info("FIB entry for prefix {} on dpn {} vpn {} removed successfully", ipAddress, dpnId, vpnId);
172 private void makeLocalFibEntry(long vpnId, BigInteger dpnId, String ipPrefix,
173 List<Instruction> customInstructions) {
174 String[] values = ipPrefix.split("/");
175 String ipAddress = values[0];
176 int prefixLength = values.length == 1 ? 0 : Integer.parseInt(values[1]);
177 LOG.debug("Adding route to DPN. ip {} masklen {}", ipAddress, prefixLength);
178 InetAddress destPrefix = null;
180 destPrefix = InetAddress.getByName(ipAddress);
181 } catch (UnknownHostException e) {
182 LOG.error("UnknowHostException in addRoute. Failed to add Route for ipPrefix {} VpnId {} DPN{}",
183 ipAddress, vpnId, dpnId, e);
186 List<MatchInfo> matches = new ArrayList<>();
188 matches.add(new MatchMetadata(MetaDataUtil.getVpnIdMetadata(vpnId), MetaDataUtil.METADATA_MASK_VRFID));
190 matches.add(MatchEthernetType.IPV4);
192 if (prefixLength != 0) {
193 matches.add(new MatchIpv4Destination(destPrefix.getHostAddress(), Integer.toString(prefixLength)));
196 String flowRef = getFlowRef(dpnId, NwConstants.L3_FIB_TABLE, vpnId, ipAddress);
199 int priority = DEFAULT_FIB_FLOW_PRIORITY + prefixLength;
200 Flow flowEntity = MDSALUtil.buildFlowNew(NwConstants.L3_FIB_TABLE, flowRef,
201 priority, flowRef, 0, 0,
202 NwConstants.COOKIE_VM_FIB_TABLE, matches, customInstructions);
203 mdsalManager.installFlow(dpnId, flowEntity);
205 LOG.debug("FIB entry for route {} on dpn {} installed successfully - flow {}", ipAddress, dpnId, flowEntity);
208 private String getFlowRef(BigInteger dpnId, short tableId, long id, String ipAddress) {
209 return FLOWID_PREFIX + dpnId + NwConstants.FLOWID_SEPARATOR + tableId + NwConstants.FLOWID_SEPARATOR + id
210 + NwConstants.FLOWID_SEPARATOR + ipAddress;
213 //TODO: Below Util methods to be removed once VpnUtil methods are exposed in api bundle
215 public static String getVpnRd(DataBroker broker, String vpnName) {
216 InstanceIdentifier<VpnInstance> id = getVpnInstanceToVpnIdIdentifier(vpnName);
217 return MDSALUtil.read(broker, LogicalDatastoreType.CONFIGURATION, id).toJavaUtil().map(
218 VpnInstance::getVrfId).orElse(null);
221 static InstanceIdentifier<VpnInstance> getVpnInstanceToVpnIdIdentifier(String vpnName) {
222 return InstanceIdentifier.builder(VpnInstanceToVpnId.class)
223 .child(VpnInstance.class, new VpnInstanceKey(vpnName)).build();
227 static long getVpnId(DataBroker broker, String vpnName) {
228 InstanceIdentifier<VpnInstance> id = getVpnInstanceToVpnIdIdentifier(vpnName);
229 return MDSALUtil.read(broker, LogicalDatastoreType.CONFIGURATION, id).toJavaUtil().map(
230 VpnInstance::getVpnId).orElse(-1L);