Freeze upstream versions
[netvirt.git] / fibmanager / impl / src / main / java / org / opendaylight / netvirt / fibmanager / RouterInterfaceVrfEntryHandler.java
1 /*
2  * Copyright © 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 com.google.common.base.Preconditions.checkNotNull;
11 import static org.opendaylight.genius.mdsalutil.NWUtil.isIpv4Address;
12
13 import java.util.Map;
14 import java.util.concurrent.locks.ReentrantLock;
15 import javax.inject.Inject;
16 import javax.inject.Singleton;
17 import org.opendaylight.genius.datastoreutils.listeners.DataTreeEventCallbackRegistrar;
18 import org.opendaylight.genius.mdsalutil.FlowEntity;
19 import org.opendaylight.genius.mdsalutil.NwConstants;
20 import org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager;
21 import org.opendaylight.genius.utils.JvmGlobalLocks;
22 import org.opendaylight.mdsal.binding.api.DataBroker;
23 import org.opendaylight.netvirt.fibmanager.api.FibHelper;
24 import org.opendaylight.netvirt.fibmanager.api.RouteOrigin;
25 import org.opendaylight.serviceutils.upgrade.UpgradeState;
26 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.RouterInterface;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.vrfentries.VrfEntry;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntry;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.VpnToDpnList;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.VpnToDpnListKey;
32 import org.opendaylight.yangtools.yang.common.Uint32;
33 import org.opendaylight.yangtools.yang.common.Uint64;
34 import org.slf4j.Logger;
35 import org.slf4j.LoggerFactory;
36
37 @Singleton
38 public class RouterInterfaceVrfEntryHandler extends BaseVrfEntryHandler {
39     private static final Logger LOG = LoggerFactory.getLogger(RouterInterfaceVrfEntryHandler.class);
40
41     private final IMdsalApiManager mdsalManager;
42     private final IPv6Handler ipv6Handler;
43
44     @Inject
45     public RouterInterfaceVrfEntryHandler(final DataBroker dataBroker, final NexthopManager nexthopManager,
46             final IMdsalApiManager mdsalManager, final IPv6Handler ipv6Handler, final FibUtil fibUtil,
47             final UpgradeState upgradeState, final DataTreeEventCallbackRegistrar eventCallbacks) {
48         super(dataBroker, nexthopManager, mdsalManager, fibUtil, upgradeState, eventCallbacks);
49         this.mdsalManager = mdsalManager;
50         this.ipv6Handler = ipv6Handler;
51     }
52
53     @Override
54     public void close() {
55         LOG.info("{} close", getClass().getSimpleName());
56     }
57
58     void createFlows(VrfEntry vrfEntry, String rd) {
59         RouterInterface routerInt = vrfEntry.augmentation(RouterInterface.class);
60         installRouterFibEntries(vrfEntry, rd, NwConstants.ADD_FLOW, routerInt);
61     }
62
63     void removeFlows(VrfEntry vrfEntry, String rd) {
64         RouterInterface routerInt = vrfEntry.augmentation(RouterInterface.class);
65         installRouterFibEntries(vrfEntry, rd, NwConstants.DEL_FLOW, routerInt);
66     }
67
68     private boolean installRouterFibEntries(VrfEntry vrfEntry, String rd, int addOrRemove,
69             RouterInterface routerInterface) {
70         final VpnInstanceOpDataEntry vpnInstance = getFibUtil().getVpnInstance(rd);
71         checkNotNull(vpnInstance, "Vpn Instance not available %s", rd);
72         checkNotNull(vpnInstance.getVpnId(), "Vpn Instance with rd %s has null vpnId!", vpnInstance.getVrfId());
73
74         // FIXME: separate this out somehow?
75         final ReentrantLock lock = JvmGlobalLocks.getLockForString(vpnInstance.getVpnInstanceName());
76         lock.lock();
77         try {
78             final Map<VpnToDpnListKey, VpnToDpnList> keyVpnToDpnListMap;
79             if (vrfEntry.getParentVpnRd() != null
80                     && FibHelper.isControllerManagedNonSelfImportedRoute(RouteOrigin.value(vrfEntry.getOrigin()))) {
81                 VpnInstanceOpDataEntry parentVpnInstance =
82                         getFibUtil().getVpnInstance(vrfEntry.getParentVpnRd());
83                 keyVpnToDpnListMap = parentVpnInstance != null ? parentVpnInstance.nonnullVpnToDpnList()
84                         : vpnInstance.nonnullVpnToDpnList();
85             } else {
86                 keyVpnToDpnListMap = vpnInstance.nonnullVpnToDpnList();
87             }
88             final Uint32 vpnId = vpnInstance.getVpnId();
89
90             if (keyVpnToDpnListMap != null) {
91                 String routerId = routerInterface.getUuid();
92                 String macAddress = routerInterface.getMacAddress();
93                 String ipValue = routerInterface.getIpAddress();
94                 LOG.trace("createFibEntries - Router augmented vrfentry found for for router uuid:{}, ip:{}, mac:{}",
95                         routerId, ipValue, macAddress);
96                 for (VpnToDpnList vpnDpn : keyVpnToDpnListMap.values()) {
97                     if (vpnDpn.getDpnState() == VpnToDpnList.DpnState.Active) {
98                         installRouterFibEntry(vrfEntry, vpnDpn.getDpnId(), vpnId, ipValue,
99                                 new MacAddress(macAddress), addOrRemove);
100                     }
101                 }
102             }
103         } finally {
104             lock.unlock();
105         }
106         return true;
107     }
108
109     public void installRouterFibEntry(final VrfEntry vrfEntry, Uint64 dpnId, Uint32 vpnId, String routerInternalIp,
110             MacAddress routerMac, int addOrRemove) {
111
112         // First install L3_GW_MAC_TABLE flows as it's common for both IPv4 and IPv6
113         // address families
114         FlowEntity l3GwMacFlowEntity = buildL3vpnGatewayFlow(dpnId, routerMac.getValue(), vpnId);
115         if (addOrRemove == NwConstants.ADD_FLOW) {
116             mdsalManager.syncInstallFlow(l3GwMacFlowEntity, 1);
117         } else {
118             mdsalManager.syncRemoveFlow(l3GwMacFlowEntity, 1);
119         }
120
121         java.util.Optional<Uint32> optionalLabel = FibUtil.getLabelFromRoutePaths(vrfEntry);
122         if (!optionalLabel.isPresent()) {
123             LOG.warn("Routes paths not present. Exiting installRouterFibEntry");
124             return;
125         }
126
127         String[] subSplit = routerInternalIp.split("/");
128         String addRemoveStr = addOrRemove == NwConstants.ADD_FLOW ? "ADD_FLOW" : "DELETE_FLOW";
129         LOG.trace("{}: Building Echo Flow entity for dpid:{}, router_ip:{}, vpnId:{}, subSplit:{} ", addRemoveStr,
130                 dpnId, routerInternalIp, vpnId, subSplit[0]);
131
132         if (isIpv4Address(subSplit[0])) {
133             installPingResponderFlowEntry(dpnId, vpnId, subSplit[0], routerMac, optionalLabel.get(), addOrRemove);
134         } else {
135             ipv6Handler.installPing6ResponderFlowEntry(dpnId, vpnId, routerInternalIp, routerMac, optionalLabel.get(),
136                     addOrRemove);
137         }
138         return;
139     }
140 }