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.Futures;
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 java.util.concurrent.Future;
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.CreateFibEntryInput;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fib.rpc.rev160121.FibRpcService;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fib.rpc.rev160121.PopulateFibOnDpnInput;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fib.rpc.rev160121.RemoveFibEntryInput;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnInstanceOpData;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnInstanceToVpnId;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntry;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntryBuilder;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntryKey;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.VpnToDpnList;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.VpnToDpnListKey;
49 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;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstance;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstanceKey;
52 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
53 import org.opendaylight.yangtools.yang.common.RpcResult;
54 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
55 import org.slf4j.Logger;
56 import org.slf4j.LoggerFactory;
59 public class FibRpcServiceImpl implements FibRpcService {
60 private static final Logger LOG = LoggerFactory.getLogger(FibRpcServiceImpl.class);
61 private final DataBroker dataBroker;
62 private final IMdsalApiManager mdsalManager;
63 private final IFibManager fibManager;
64 private final IVpnFootprintService vpnFootprintService;
67 public FibRpcServiceImpl(final DataBroker dataBroker, final IMdsalApiManager mdsalManager,
68 final IFibManager fibManager, final IVpnFootprintService vpnFootprintService) {
69 this.dataBroker = dataBroker;
70 this.mdsalManager = mdsalManager;
71 this.fibManager = fibManager;
72 this.vpnFootprintService = vpnFootprintService;
76 * To install FIB routes on specified dpn with given instructions.
79 public Future<RpcResult<Void>> createFibEntry(CreateFibEntryInput input) {
81 BigInteger dpnId = input.getSourceDpid();
82 String vpnName = input.getVpnName();
83 long vpnId = getVpnId(dataBroker, vpnName);
84 String vpnRd = getVpnRd(dataBroker, vpnName);
85 String ipAddress = input.getIpAddress();
86 LOG.info("Create custom FIB entry - {} on dpn {} for VPN {} ", ipAddress, dpnId, vpnName);
87 List<Instruction> instructions = input.getInstruction();
88 LOG.info("ADD: Adding Custom Fib Entry rd {} prefix {} label {}", vpnRd, ipAddress, input.getServiceId());
89 makeLocalFibEntry(vpnId, dpnId, ipAddress, instructions);
90 IpAddresses.IpAddressSource ipAddressSource = IpAddresses.IpAddressSource
91 .forValue(input.getIpAddressSource().getIntValue());
92 vpnFootprintService.updateVpnToDpnMapping(dpnId, vpnName, vpnRd, null /* interfaceName*/,
93 new ImmutablePair<>(ipAddressSource, ipAddress), true /*add*/);
94 LOG.info("ADD: Added Custom Fib Entry rd {} prefix {} label {}", vpnRd, ipAddress, input.getServiceId());
95 return Futures.immediateFuture(RpcResultBuilder.<Void>success().build());
99 * To remove FIB/LFIB/TST routes from specified dpn.
102 public Future<RpcResult<Void>> removeFibEntry(RemoveFibEntryInput input) {
103 BigInteger dpnId = input.getSourceDpid();
104 String vpnName = input.getVpnName();
105 long vpnId = getVpnId(dataBroker, vpnName);
106 String vpnRd = getVpnRd(dataBroker, vpnName);
108 String ipAddress = input.getIpAddress();
110 LOG.info("Delete custom FIB entry - {} on dpn {} for VPN {} ", ipAddress, dpnId, vpnName);
111 LOG.info("REMOVE: Removing Custom Fib Entry rd {} prefix {} label {}", vpnRd, ipAddress, input.getServiceId());
112 removeLocalFibEntry(dpnId, vpnId, ipAddress);
113 IpAddresses.IpAddressSource ipAddressSource = IpAddresses.IpAddressSource
114 .forValue(input.getIpAddressSource().getIntValue());
115 vpnFootprintService.updateVpnToDpnMapping(dpnId, vpnName, vpnRd, null /* interfaceName*/,
116 new ImmutablePair<>(ipAddressSource, ipAddress), false /*add*/);
117 LOG.info("REMOVE: Removed Custom Fib Entry rd {} prefix {} label {}", vpnRd, ipAddress, input.getServiceId());
118 return Futures.immediateFuture(RpcResultBuilder.<Void>success().build());
123 public Future<RpcResult<Void>> populateFibOnDpn(PopulateFibOnDpnInput input) {
124 fibManager.populateFibOnNewDpn(input.getDpid(), input.getVpnId(), input.getRd(), null);
125 return Futures.immediateFuture(RpcResultBuilder.<Void>success().build());
129 public Future<RpcResult<Void>> cleanupDpnForVpn(CleanupDpnForVpnInput input) {
130 fibManager.cleanUpDpnForVpn(input.getDpid(), input.getVpnId(), input.getRd(), null);
131 return Futures.immediateFuture(RpcResultBuilder.<Void>success().build());
134 private void removeLocalFibEntry(BigInteger dpnId, long vpnId, String ipPrefix) {
135 String[] values = ipPrefix.split("/");
136 String ipAddress = values[0];
137 int prefixLength = values.length == 1 ? 0 : Integer.parseInt(values[1]);
138 LOG.debug("Removing route from DPN. ip {} masklen {}", ipAddress, prefixLength);
139 InetAddress destPrefix = null;
141 destPrefix = InetAddress.getByName(ipAddress);
142 } catch (UnknownHostException e) {
143 LOG.error("UnknowHostException in removeRoute. Failed to remove Route for ipPrefix {} DPN {} Vpn {}",
144 ipAddress, dpnId, vpnId, e);
147 List<MatchInfo> matches = new ArrayList<>();
149 matches.add(new MatchMetadata(MetaDataUtil.getVpnIdMetadata(vpnId), MetaDataUtil.METADATA_MASK_VRFID));
151 matches.add(MatchEthernetType.IPV4);
153 if (prefixLength != 0) {
154 matches.add(new MatchIpv4Destination(destPrefix.getHostAddress(), Integer.toString(prefixLength)));
157 String flowRef = getFlowRef(dpnId, NwConstants.L3_FIB_TABLE, vpnId, ipAddress);
160 int priority = DEFAULT_FIB_FLOW_PRIORITY + prefixLength;
161 Flow flowEntity = MDSALUtil.buildFlowNew(NwConstants.L3_FIB_TABLE, flowRef,
162 priority, flowRef, 0, 0,
163 NwConstants.COOKIE_VM_FIB_TABLE, matches, null);
165 mdsalManager.removeFlow(dpnId, flowEntity);
167 LOG.info("FIB entry for prefix {} on dpn {} vpn {} removed successfully", ipAddress, dpnId, vpnId);
170 private void makeLocalFibEntry(long vpnId, BigInteger dpnId, String ipPrefix,
171 List<Instruction> customInstructions) {
172 String[] values = ipPrefix.split("/");
173 String ipAddress = values[0];
174 int prefixLength = values.length == 1 ? 0 : Integer.parseInt(values[1]);
175 LOG.debug("Adding route to DPN. ip {} masklen {}", ipAddress, prefixLength);
176 InetAddress destPrefix = null;
178 destPrefix = InetAddress.getByName(ipAddress);
179 } catch (UnknownHostException e) {
180 LOG.error("UnknowHostException in addRoute. Failed to add Route for ipPrefix {} VpnId {} DPN{}",
181 ipAddress, vpnId, dpnId, e);
184 List<MatchInfo> matches = new ArrayList<>();
186 matches.add(new MatchMetadata(MetaDataUtil.getVpnIdMetadata(vpnId), MetaDataUtil.METADATA_MASK_VRFID));
188 matches.add(MatchEthernetType.IPV4);
190 if (prefixLength != 0) {
191 matches.add(new MatchIpv4Destination(destPrefix.getHostAddress(), Integer.toString(prefixLength)));
194 String flowRef = getFlowRef(dpnId, NwConstants.L3_FIB_TABLE, vpnId, ipAddress);
197 int priority = DEFAULT_FIB_FLOW_PRIORITY + prefixLength;
198 Flow flowEntity = MDSALUtil.buildFlowNew(NwConstants.L3_FIB_TABLE, flowRef,
199 priority, flowRef, 0, 0,
200 NwConstants.COOKIE_VM_FIB_TABLE, matches, customInstructions);
201 mdsalManager.installFlow(dpnId, flowEntity);
203 LOG.debug("FIB entry for route {} on dpn {} installed successfully - flow {}", ipAddress, dpnId, flowEntity);
206 private String getFlowRef(BigInteger dpnId, short tableId, long id, String ipAddress) {
207 return FLOWID_PREFIX + dpnId + NwConstants.FLOWID_SEPARATOR + tableId + NwConstants.FLOWID_SEPARATOR + id
208 + NwConstants.FLOWID_SEPARATOR + ipAddress;
211 //TODO: Below Util methods to be removed once VpnUtil methods are exposed in api bundle
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);
218 static InstanceIdentifier<VpnInstance> getVpnInstanceToVpnIdIdentifier(String vpnName) {
219 return InstanceIdentifier.builder(VpnInstanceToVpnId.class)
220 .child(VpnInstance.class, new VpnInstanceKey(vpnName)).build();
224 static InstanceIdentifier<VpnToDpnList> getVpnToDpnListIdentifier(String rd, BigInteger dpnId) {
225 return InstanceIdentifier.builder(VpnInstanceOpData.class)
226 .child(VpnInstanceOpDataEntry.class, new VpnInstanceOpDataEntryKey(rd))
227 .child(VpnToDpnList.class, new VpnToDpnListKey(dpnId)).build();
230 static InstanceIdentifier<VpnInstanceOpDataEntry> getVpnInstanceOpDataIdentifier(String rd) {
231 return InstanceIdentifier.builder(VpnInstanceOpData.class)
232 .child(VpnInstanceOpDataEntry.class, new VpnInstanceOpDataEntryKey(rd)).build();
235 static VpnInstanceOpDataEntry getVpnInstanceOpData(String rd, long vpnId, String vpnName) {
236 return new VpnInstanceOpDataEntryBuilder().setVrfId(rd).setVpnId(vpnId).setVpnInstanceName(vpnName).build();
239 static long getVpnId(DataBroker broker, String vpnName) {
240 InstanceIdentifier<VpnInstance> id = getVpnInstanceToVpnIdIdentifier(vpnName);
241 return MDSALUtil.read(broker, LogicalDatastoreType.CONFIGURATION, id).toJavaUtil().map(
242 VpnInstance::getVpnId).orElse(-1L);