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
9 package org.opendaylight.netvirt.vpnmanager;
11 import static java.util.Collections.emptyList;
12 import static org.opendaylight.genius.infra.Datastore.OPERATIONAL;
14 import com.google.common.base.Optional;
15 import com.google.common.collect.Iterators;
16 import com.google.common.net.InetAddresses;
17 import com.google.common.util.concurrent.FutureCallback;
18 import com.google.common.util.concurrent.ListenableFuture;
19 import java.math.BigInteger;
20 import java.net.Inet4Address;
21 import java.net.Inet6Address;
22 import java.net.InetAddress;
23 import java.net.UnknownHostException;
24 import java.text.SimpleDateFormat;
25 import java.util.ArrayList;
26 import java.util.Collection;
27 import java.util.Collections;
28 import java.util.Date;
29 import java.util.HashMap;
30 import java.util.HashSet;
31 import java.util.List;
32 import java.util.Locale;
34 import java.util.Map.Entry;
35 import java.util.Objects;
37 import java.util.concurrent.ExecutionException;
38 import java.util.concurrent.Future;
39 import java.util.concurrent.locks.ReentrantLock;
40 import java.util.function.Predicate;
41 import java.util.stream.Collectors;
42 import javax.inject.Singleton;
43 import org.eclipse.jdt.annotation.NonNull;
44 import org.eclipse.jdt.annotation.Nullable;
45 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
46 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
47 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
48 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
49 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
50 import org.opendaylight.genius.datastoreutils.SingleTransactionDataBroker;
51 import org.opendaylight.genius.infra.Datastore;
52 import org.opendaylight.genius.infra.Datastore.Configuration;
53 import org.opendaylight.genius.infra.Datastore.Operational;
54 import org.opendaylight.genius.infra.ManagedNewTransactionRunner;
55 import org.opendaylight.genius.infra.ManagedNewTransactionRunnerImpl;
56 import org.opendaylight.genius.infra.TypedReadTransaction;
57 import org.opendaylight.genius.infra.TypedReadWriteTransaction;
58 import org.opendaylight.genius.infra.TypedWriteTransaction;
59 import org.opendaylight.genius.interfacemanager.interfaces.IInterfaceManager;
60 import org.opendaylight.genius.mdsalutil.FlowEntity;
61 import org.opendaylight.genius.mdsalutil.FlowEntityBuilder;
62 import org.opendaylight.genius.mdsalutil.InstructionInfo;
63 import org.opendaylight.genius.mdsalutil.MDSALUtil;
64 import org.opendaylight.genius.mdsalutil.MatchInfo;
65 import org.opendaylight.genius.mdsalutil.MetaDataUtil;
66 import org.opendaylight.genius.mdsalutil.NWUtil;
67 import org.opendaylight.genius.mdsalutil.NwConstants;
68 import org.opendaylight.genius.mdsalutil.actions.ActionRegLoad;
69 import org.opendaylight.genius.mdsalutil.instructions.InstructionGotoTable;
70 import org.opendaylight.genius.mdsalutil.instructions.InstructionWriteMetadata;
71 import org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager;
72 import org.opendaylight.genius.mdsalutil.matches.MatchEthernetDestination;
73 import org.opendaylight.genius.mdsalutil.matches.MatchEthernetType;
74 import org.opendaylight.genius.mdsalutil.matches.MatchMetadata;
75 import org.opendaylight.genius.utils.JvmGlobalLocks;
76 import org.opendaylight.genius.utils.ServiceIndex;
77 import org.opendaylight.genius.utils.SystemPropertyReader;
78 import org.opendaylight.infrautils.jobcoordinator.JobCoordinator;
79 import org.opendaylight.infrautils.utils.concurrent.ListenableFutures;
80 import org.opendaylight.netvirt.bgpmanager.api.IBgpManager;
81 import org.opendaylight.netvirt.elanmanager.api.ElanHelper;
82 import org.opendaylight.netvirt.fibmanager.api.IFibManager;
83 import org.opendaylight.netvirt.fibmanager.api.RouteOrigin;
84 import org.opendaylight.netvirt.neutronvpn.api.enums.IpVersionChoice;
85 import org.opendaylight.netvirt.neutronvpn.interfaces.INeutronVpnManager;
86 import org.opendaylight.netvirt.vpnmanager.api.InterfaceUtils;
87 import org.opendaylight.netvirt.vpnmanager.api.VpnExtraRouteHelper;
88 import org.opendaylight.netvirt.vpnmanager.api.VpnHelper;
89 import org.opendaylight.netvirt.vpnmanager.iplearn.model.MacEntry;
90 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnAfConfig;
91 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnInstances;
92 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnInterfaces;
93 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.instances.VpnInstance;
94 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.instances.VpnInstanceKey;
95 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.VpnInterface;
96 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.VpnInterfaceBuilder;
97 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.VpnInterfaceKey;
98 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.interfaces.vpn._interface.VpnInstanceNames;
99 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
100 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressBuilder;
101 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address;
102 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.Interfaces;
103 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
104 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
105 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress;
106 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid;
107 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.Action;
108 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction;
109 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdInput;
110 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdInputBuilder;
111 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdOutput;
112 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService;
113 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdInput;
114 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdInputBuilder;
115 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdOutput;
116 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.IfIndexesInterfaceMap;
117 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406._if.indexes._interface.map.IfIndexInterface;
118 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406._if.indexes._interface.map.IfIndexInterfaceKey;
119 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.GetInterfaceFromIfIndexInput;
120 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.GetInterfaceFromIfIndexInputBuilder;
121 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.GetInterfaceFromIfIndexOutput;
122 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.OdlInterfaceRpcService;
123 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.services.info.BoundServices;
124 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.ipv6.nd.util.rev170210.Ipv6NdUtilService;
125 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.ipv6.nd.util.rev170210.SendNeighborSolicitationToOfGroupInput;
126 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.ipv6.nd.util.rev170210.SendNeighborSolicitationToOfGroupInputBuilder;
127 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.ipv6.nd.util.rev170210.SendNeighborSolicitationToOfGroupOutput;
128 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.LockManagerService;
129 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.TimeUnits;
130 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.TryLockInput;
131 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.TryLockInputBuilder;
132 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.TryLockOutput;
133 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.UnlockInput;
134 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.UnlockInputBuilder;
135 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.UnlockOutput;
136 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.ElanDpnInterfaces;
137 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.ElanInterfaces;
138 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.ElanTagNameMap;
139 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeVlan;
140 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.dpn.interfaces.ElanDpnInterfacesList;
141 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.dpn.interfaces.ElanDpnInterfacesListKey;
142 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.dpn.interfaces.elan.dpn.interfaces.list.DpnInterfaces;
143 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.dpn.interfaces.elan.dpn.interfaces.list.DpnInterfacesBuilder;
144 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.dpn.interfaces.elan.dpn.interfaces.list.DpnInterfacesKey;
145 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.instances.ElanInstance;
146 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.ElanInterface;
147 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.ElanInterfaceKey;
148 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.tag.name.map.ElanTagName;
149 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.tag.name.map.ElanTagNameKey;
150 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.FibEntries;
151 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.VrfEntryBase;
152 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.extraroute.rds.map.extraroute.rds.dest.prefixes.AllocatedRdsBuilder;
153 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.extraroute.rds.map.extraroute.rds.dest.prefixes.AllocatedRdsKey;
154 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.fibentries.VrfTables;
155 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.fibentries.VrfTablesKey;
156 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.vrfentries.VrfEntry;
157 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.vrfentries.VrfEntryKey;
158 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3nexthop.rev150409.L3nexthop;
159 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3nexthop.rev150409.l3nexthop.VpnNexthops;
160 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3nexthop.rev150409.l3nexthop.VpnNexthopsKey;
161 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.Adjacencies;
162 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.AdjacenciesBuilder;
163 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.AdjacenciesOp;
164 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.AdjacenciesOpBuilder;
165 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.LearntVpnVipToPortData;
166 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.LearntVpnVipToPortEventAction;
167 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.LearntVpnVipToPortEventData;
168 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.PrefixToInterface;
169 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.SubnetOpData;
170 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.SubnetsAssociatedToRouteTargets;
171 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnIdToVpnInstance;
172 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnInstanceOpData;
173 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnInterfaceOpData;
174 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnToExtraroutes;
175 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.adjacency.list.Adjacency;
176 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.adjacency.list.Adjacency.AdjacencyType;
177 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.adjacency.list.AdjacencyKey;
178 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.data.LearntVpnVipToPort;
179 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.data.LearntVpnVipToPortBuilder;
180 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.data.LearntVpnVipToPortKey;
181 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.event.data.LearntVpnVipToPortEvent;
182 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.event.data.LearntVpnVipToPortEventBuilder;
183 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.event.data.LearntVpnVipToPortEventKey;
184 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.prefix.to._interface.VpnIds;
185 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.prefix.to._interface.VpnIdsKey;
186 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.prefix.to._interface.vpn.ids.Prefixes;
187 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.prefix.to._interface.vpn.ids.PrefixesBuilder;
188 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.prefix.to._interface.vpn.ids.PrefixesKey;
189 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.subnet.op.data.SubnetOpDataEntry;
190 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.subnet.op.data.SubnetOpDataEntryKey;
191 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.subnets.associated.to.route.targets.RouteTarget;
192 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.subnets.associated.to.route.targets.RouteTargetKey;
193 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.subnets.associated.to.route.targets.route.target.AssociatedSubnet;
194 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.subnets.associated.to.route.targets.route.target.AssociatedSubnetKey;
195 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.subnets.associated.to.route.targets.route.target.associated.subnet.AssociatedVpn;
196 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.subnets.associated.to.route.targets.route.target.associated.subnet.AssociatedVpnBuilder;
197 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.subnets.associated.to.route.targets.route.target.associated.subnet.AssociatedVpnKey;
198 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn._interface.op.data.VpnInterfaceOpDataEntry;
199 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn._interface.op.data.VpnInterfaceOpDataEntryBuilder;
200 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn._interface.op.data.VpnInterfaceOpDataEntryKey;
201 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntry;
202 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntryBuilder;
203 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntryKey;
204 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.VpnTargets;
205 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.VpnToDpnList;
206 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.vpntargets.VpnTarget;
207 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstanceBuilder;
208 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.to.extraroutes.Vpn;
209 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.to.extraroutes.VpnKey;
210 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.to.extraroutes.vpn.extra.routes.Routes;
211 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.to.extraroutes.vpn.extra.routes.RoutesBuilder;
212 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ExtRouters;
213 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ExternalNetworks;
214 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ExternalSubnets;
215 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.NaptSwitches;
216 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext.routers.Routers;
217 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext.routers.RoutersKey;
218 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext.routers.routers.ExternalIps;
219 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.networks.Networks;
220 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.networks.NetworksKey;
221 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets.SubnetsKey;
222 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.napt.switches.RouterToNaptSwitch;
223 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.napt.switches.RouterToNaptSwitchKey;
224 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.NetworkAttributes.NetworkType;
225 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.NetworkMaps;
226 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.NeutronVpnPortipPortData;
227 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.Subnetmaps;
228 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.networkmaps.NetworkMap;
229 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.networkmaps.NetworkMapKey;
230 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.neutron.vpn.portip.port.data.VpnPortipToPort;
231 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.neutron.vpn.portip.port.data.VpnPortipToPortBuilder;
232 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.neutron.vpn.portip.port.data.VpnPortipToPortKey;
233 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.subnetmaps.Subnetmap;
234 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.subnetmaps.SubnetmapKey;
235 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.constants.rev150712.IpVersionBase;
236 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.constants.rev150712.IpVersionV4;
237 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.ext.rev150712.NetworkL3Extension;
238 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.Network;
239 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.NetworkKey;
240 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes.FixedIps;
241 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.ports.Port;
242 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.rev150712.Neutron;
243 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.Subnets;
244 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.Subnet;
245 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.SubnetKey;
246 import org.opendaylight.yangtools.yang.binding.DataObject;
247 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
248 import org.opendaylight.yangtools.yang.common.RpcResult;
249 import org.opendaylight.yangtools.yang.common.Uint32;
250 import org.opendaylight.yangtools.yang.common.Uint64;
251 import org.opendaylight.yangtools.yang.data.api.schema.tree.ModifiedNodeDoesNotExistException;
252 import org.slf4j.Logger;
253 import org.slf4j.LoggerFactory;
256 public final class VpnUtil {
258 private static final Logger LOG = LoggerFactory.getLogger(VpnUtil.class);
260 public static final int SINGLE_TRANSACTION_BROKER_NO_RETRY = 1;
261 private static Boolean arpLearningEnabled = Boolean.TRUE;
263 private final DataBroker dataBroker;
264 private final IdManagerService idManager;
265 private final IFibManager fibManager;
266 private final IBgpManager bgpManager;
267 private final LockManagerService lockManager;
268 private final INeutronVpnManager neutronVpnService;
269 private final IMdsalApiManager mdsalManager;
270 private final IInterfaceManager interfaceManager;
271 private final JobCoordinator jobCoordinator;
272 private final ManagedNewTransactionRunner txRunner;
273 private final OdlInterfaceRpcService ifmRpcService;
276 * Class to generate timestamps with microsecond precision.
277 * For example: MicroTimestamp.INSTANCE.get() = "2012-10-21 19:13:45.267128"
279 public enum MicroTimestamp {
282 private long startDate ;
283 private long startNanoseconds ;
284 private SimpleDateFormat dateFormat ;
287 this.startDate = System.currentTimeMillis() ;
288 this.startNanoseconds = System.nanoTime() ;
289 this.dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss.SSS") ;
292 public String get() {
293 long microSeconds = (System.nanoTime() - this.startNanoseconds) / 1000 ;
294 long date = this.startDate + microSeconds / 1000 ;
295 return this.dateFormat.format(date) + String.format("%03d", microSeconds % 1000) ;
299 public VpnUtil(DataBroker dataBroker, IdManagerService idManager, IFibManager fibManager,
300 IBgpManager bgpManager, LockManagerService lockManager, INeutronVpnManager neutronVpnService,
301 IMdsalApiManager mdsalManager, JobCoordinator jobCoordinator, IInterfaceManager interfaceManager,
302 OdlInterfaceRpcService ifmRpcService) {
303 this.dataBroker = dataBroker;
304 this.idManager = idManager;
305 this.fibManager = fibManager;
306 this.bgpManager = bgpManager;
307 this.lockManager = lockManager;
308 this.neutronVpnService = neutronVpnService;
309 this.mdsalManager = mdsalManager;
310 this.interfaceManager = interfaceManager;
311 this.jobCoordinator = jobCoordinator;
312 this.txRunner = new ManagedNewTransactionRunnerImpl(dataBroker);
313 this.ifmRpcService = ifmRpcService;
316 public static InstanceIdentifier<VpnInterface> getVpnInterfaceIdentifier(String vpnInterfaceName) {
317 return InstanceIdentifier.builder(VpnInterfaces.class)
318 .child(VpnInterface.class, new VpnInterfaceKey(vpnInterfaceName)).build();
321 static InstanceIdentifier<VpnInterfaceOpDataEntry> getVpnInterfaceOpDataEntryIdentifier(String vpnInterfaceName,
323 return InstanceIdentifier.builder(VpnInterfaceOpData.class).child(VpnInterfaceOpDataEntry.class,
324 new VpnInterfaceOpDataEntryKey(vpnInterfaceName, vpnName)).build();
327 static InstanceIdentifier<VpnInstance> getVpnInstanceIdentifier(String vpnName) {
328 return InstanceIdentifier.builder(VpnInstances.class)
329 .child(VpnInstance.class, new VpnInstanceKey(vpnName)).build();
333 VpnInterface getVpnInterface(String vpnInterfaceName) {
334 InstanceIdentifier<VpnInterface> id = getVpnInterfaceIdentifier(vpnInterfaceName);
335 Optional<VpnInterface> vpnInterface = read(LogicalDatastoreType.CONFIGURATION, id);
336 return vpnInterface.isPresent() ? vpnInterface.get() : null;
339 static VpnInterfaceOpDataEntry getVpnInterfaceOpDataEntry(String intfName, String vpnName, AdjacenciesOp aug,
340 Uint64 dpnId, long lportTag,
342 return new VpnInterfaceOpDataEntryBuilder().withKey(new VpnInterfaceOpDataEntryKey(intfName, vpnName))
343 .setDpnId(dpnId).addAugmentation(AdjacenciesOp.class, aug)
344 .setLportTag(lportTag).setGatewayMacAddress(gwMac).build();
347 Optional<VpnInterfaceOpDataEntry> getVpnInterfaceOpDataEntry(String vpnInterfaceName, String vpnName) {
348 InstanceIdentifier<VpnInterfaceOpDataEntry> id = getVpnInterfaceOpDataEntryIdentifier(vpnInterfaceName,
350 Optional<VpnInterfaceOpDataEntry> vpnInterfaceOpDataEntry = read(LogicalDatastoreType.OPERATIONAL,
352 return vpnInterfaceOpDataEntry;
355 static InstanceIdentifier<Prefixes> getPrefixToInterfaceIdentifier(Uint32 vpnId, String ipPrefix) {
356 return InstanceIdentifier.builder(PrefixToInterface.class).child(VpnIds.class, new VpnIdsKey(vpnId))
357 .child(Prefixes.class, new PrefixesKey(ipPrefix)).build();
360 static InstanceIdentifier<VpnIds> getPrefixToInterfaceIdentifier(Uint32 vpnId) {
361 return InstanceIdentifier.builder(PrefixToInterface.class).child(VpnIds.class, new VpnIdsKey(vpnId)).build();
364 static Prefixes getPrefixToInterface(Uint64 dpId, String vpnInterfaceName, String ipPrefix,
365 Uuid networkId, NetworkType networkType, Long segmentationId, Prefixes.PrefixCue prefixCue) {
366 return new PrefixesBuilder().setDpnId(dpId).setVpnInterfaceName(
367 vpnInterfaceName).setIpAddress(ipPrefix)//.setSubnetId(subnetId)
368 .setNetworkId(networkId).setNetworkType(networkType).setSegmentationId(segmentationId)
369 .setPrefixCue(prefixCue).build();
372 static Prefixes getPrefixToInterface(Uint64 dpId, String vpnInterfaceName, String ipPrefix,
373 Prefixes.PrefixCue prefixCue) {
374 return new PrefixesBuilder().setDpnId(dpId).setVpnInterfaceName(vpnInterfaceName).setIpAddress(ipPrefix)
375 .setPrefixCue(prefixCue).build();
378 Optional<Prefixes> getPrefixToInterface(Uint32 vpnId, String ipPrefix) {
379 return read(LogicalDatastoreType.OPERATIONAL, getPrefixToInterfaceIdentifier(vpnId, getIpPrefix(ipPrefix)));
383 * Get VRF table given a Route Distinguisher.
385 * @param rd Route-Distinguisher
386 * @return VrfTables that holds the list of VrfEntries of the specified rd
389 VrfTables getVrfTable(String rd) {
390 InstanceIdentifier<VrfTables> id = InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class,
391 new VrfTablesKey(rd)).build();
392 Optional<VrfTables> vrfTable = read(LogicalDatastoreType.CONFIGURATION, id);
393 return vrfTable.isPresent() ? vrfTable.get() : null;
397 * Retrieves the VrfEntries that belong to a given VPN filtered out by
398 * Origin, searching by its Route-Distinguisher.
400 * @param rd Route-distinguisher of the VPN
401 * @param originsToConsider Only entries whose origin is included in this list will be considered
402 * @return the list of VrfEntries
404 public List<VrfEntry> getVrfEntriesByOrigin(String rd, List<RouteOrigin> originsToConsider) {
405 List<VrfEntry> result = new ArrayList<>();
406 List<VrfEntry> allVpnVrfEntries = getAllVrfEntries(rd);
407 for (VrfEntry vrfEntry : allVpnVrfEntries) {
408 if (originsToConsider.contains(RouteOrigin.value(vrfEntry.getOrigin()))) {
409 result.add(vrfEntry);
416 * Retrieves all the VrfEntries that belong to a given VPN searching by its
417 * Route-Distinguisher.
419 * @param rd Route-distinguisher of the VPN
420 * @return the list of VrfEntries
422 public List<VrfEntry> getAllVrfEntries(String rd) {
423 VrfTables vrfTables = getVrfTable(rd);
424 if (vrfTables != null && vrfTables.getVrfEntry() != null) {
425 return vrfTables.getVrfEntry();
430 //FIXME: Implement caches for DS reads
432 public VpnInstance getVpnInstance(String vpnInstanceName) {
433 InstanceIdentifier<VpnInstance> id = InstanceIdentifier.builder(VpnInstances.class).child(VpnInstance.class,
434 new VpnInstanceKey(vpnInstanceName)).build();
435 Optional<VpnInstance> vpnInstance = read(LogicalDatastoreType.CONFIGURATION, id);
436 return vpnInstance.isPresent() ? vpnInstance.get() : null;
440 List<VpnInstanceOpDataEntry> getAllVpnInstanceOpData() {
441 InstanceIdentifier<VpnInstanceOpData> id = InstanceIdentifier.builder(VpnInstanceOpData.class).build();
442 Optional<VpnInstanceOpData> vpnInstanceOpDataOptional = read(LogicalDatastoreType.OPERATIONAL, id);
444 vpnInstanceOpDataOptional.isPresent() && vpnInstanceOpDataOptional.get().getVpnInstanceOpDataEntry() != null
445 ? vpnInstanceOpDataOptional.get().getVpnInstanceOpDataEntry()
450 List<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data
451 .vpn.instance.op.data.entry.vpn.to.dpn.list.VpnInterfaces> getDpnVpnInterfaces(VpnInstance vpnInstance,
453 String primaryRd = getPrimaryRd(vpnInstance);
454 InstanceIdentifier<VpnToDpnList> dpnToVpnId = VpnHelper.getVpnToDpnListIdentifier(primaryRd, dpnId);
455 Optional<VpnToDpnList> dpnInVpn = read(LogicalDatastoreType.OPERATIONAL, dpnToVpnId);
456 return dpnInVpn.isPresent() && dpnInVpn.get().getVpnInterfaces() != null ? dpnInVpn.get().getVpnInterfaces()
461 static List<String> getListOfRdsFromVpnInstance(VpnInstance vpnInstance) {
462 VpnAfConfig vpnConfig = vpnInstance.getIpv4Family();
463 LOG.trace("vpnConfig {}", vpnConfig);
464 return vpnConfig.getRouteDistinguisher() != null && vpnConfig.getRouteDistinguisher() != null
465 ? vpnConfig.getRouteDistinguisher() : emptyList();
469 VrfEntry getVrfEntry(String rd, String ipPrefix) {
470 VrfTables vrfTable = getVrfTable(rd);
471 // TODO: why check VrfTables if we later go for the specific VrfEntry?
472 if (vrfTable != null) {
473 InstanceIdentifier<VrfEntry> vrfEntryId =
474 InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class, new VrfTablesKey(rd)).child(
475 VrfEntry.class, new VrfEntryKey(ipPrefix)).build();
476 Optional<VrfEntry> vrfEntry = read(LogicalDatastoreType.CONFIGURATION, vrfEntryId);
477 if (vrfEntry.isPresent()) {
478 return vrfEntry.get();
485 public List<Adjacency> getAdjacenciesForVpnInterfaceFromConfig(String intfName) {
486 final InstanceIdentifier<VpnInterface> identifier = getVpnInterfaceIdentifier(intfName);
487 InstanceIdentifier<Adjacencies> path = identifier.augmentation(Adjacencies.class);
488 Optional<Adjacencies> adjacencies = read(LogicalDatastoreType.CONFIGURATION, path);
489 if (adjacencies.isPresent()) {
490 return adjacencies.get().getAdjacency();
495 static Routes getVpnToExtraroute(String ipPrefix, List<String> nextHopList) {
496 return new RoutesBuilder().setPrefix(ipPrefix).setNexthopIpList(nextHopList).build();
500 String getVpnInterfaceName(Uint64 metadata) throws InterruptedException, ExecutionException {
501 GetInterfaceFromIfIndexInputBuilder ifIndexInputBuilder = new GetInterfaceFromIfIndexInputBuilder();
502 Uint64 lportTag = MetaDataUtil.getLportFromMetadata(metadata);
503 ifIndexInputBuilder.setIfIndex(lportTag.intValue());
504 GetInterfaceFromIfIndexInput input = ifIndexInputBuilder.build();
505 Future<RpcResult<GetInterfaceFromIfIndexOutput>> interfaceFromIfIndex =
506 ifmRpcService.getInterfaceFromIfIndex(input);
507 GetInterfaceFromIfIndexOutput interfaceFromIfIndexOutput;
508 RpcResult<GetInterfaceFromIfIndexOutput> rpcResult = interfaceFromIfIndex.get();
509 if (rpcResult == null) {
512 interfaceFromIfIndexOutput = rpcResult.getResult();
513 return interfaceFromIfIndexOutput.getInterfaceName();
516 static AllocatedRdsBuilder getRdsBuilder(String nexthop, String rd) {
517 return new AllocatedRdsBuilder().withKey(new AllocatedRdsKey(nexthop)).setNexthop(nexthop).setRd(rd);
520 public static Adjacencies getVpnInterfaceAugmentation(List<Adjacency> nextHopList) {
521 return new AdjacenciesBuilder().setAdjacency(nextHopList).build();
524 static AdjacenciesOp getVpnInterfaceOpDataEntryAugmentation(List<Adjacency> nextHopList) {
525 return new AdjacenciesOpBuilder().setAdjacency(nextHopList).build();
528 static InstanceIdentifier<Interface> getInterfaceIdentifier(String interfaceName) {
529 return InstanceIdentifier.builder(Interfaces.class).child(Interface.class,
530 new InterfaceKey(interfaceName)).build();
533 public static Uint64 getCookieL3(int vpnId) {
534 return Uint64.valueOf(VpnConstants.COOKIE_L3_BASE.toJava().add(new BigInteger("0610000", 16))
535 .add(BigInteger.valueOf(vpnId)));
538 public Uint32 getUniqueId(String poolName, String idKey) {
539 AllocateIdInput getIdInput = new AllocateIdInputBuilder().setPoolName(poolName).setIdKey(idKey).build();
541 Future<RpcResult<AllocateIdOutput>> result = idManager.allocateId(getIdInput);
542 RpcResult<AllocateIdOutput> rpcResult = result.get();
543 if (rpcResult.isSuccessful()) {
544 return rpcResult.getResult().getIdValue();
546 LOG.error("getUniqueId: RPC Call to Get Unique Id from pool {} with key {} returned with Errors {}",
547 poolName, idKey, rpcResult.getErrors());
549 } catch (InterruptedException | ExecutionException e) {
550 LOG.error("getUniqueId: Exception when getting Unique Id from pool {} for key {}", poolName, idKey, e);
555 void releaseId(String poolName, String idKey) {
556 ReleaseIdInput idInput = new ReleaseIdInputBuilder().setPoolName(poolName).setIdKey(idKey).build();
558 RpcResult<ReleaseIdOutput> rpcResult = idManager.releaseId(idInput).get();
559 if (!rpcResult.isSuccessful()) {
560 LOG.error("releaseId: RPC Call to release Id for key {} from pool {} returned with Errors {}",
561 idKey, poolName, rpcResult.getErrors());
563 } catch (InterruptedException | ExecutionException e) {
564 LOG.error("releaseId: Exception when releasing Id for key {} from pool {}", idKey, poolName, e);
568 public static String getNextHopLabelKey(String rd, String prefix) {
569 return rd + VpnConstants.SEPARATOR + prefix;
573 * Retrieves the dataplane identifier of a specific VPN, searching by its
576 * @param vpnName Name of the VPN
577 * @return the dataplane identifier of the VPN, the VrfTag.
579 public Uint32 getVpnId(String vpnName) {
580 if (vpnName == null) {
581 return VpnConstants.INVALID_ID;
584 return read(LogicalDatastoreType.CONFIGURATION, VpnOperDsUtils.getVpnInstanceToVpnIdIdentifier(vpnName))
585 .toJavaUtil().map(org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911
586 .vpn.instance.to.vpn.id.VpnInstance::getVpnId)
587 .orElse(VpnConstants.INVALID_ID);
591 * Retrieves the VPN Route Distinguisher searching by its Vpn instance name.
593 * @param vpnName Name of the VPN
594 * @return the route-distinguisher of the VPN
596 public String getVpnRd(String vpnName) {
597 Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id
598 .VpnInstance> vpnInstance = read(LogicalDatastoreType.CONFIGURATION,
599 VpnOperDsUtils.getVpnInstanceToVpnIdIdentifier(vpnName));
601 if (vpnInstance.isPresent()) {
602 rd = vpnInstance.get().getVrfId();
607 public static String getVpnRd(TypedReadTransaction<Configuration> confTx, String vpnName) {
609 return confTx.read(VpnOperDsUtils.getVpnInstanceToVpnIdIdentifier(vpnName)).get().toJavaUtil().map(
610 vpnInstance -> vpnInstance.getVrfId()).orElse(null);
611 } catch (InterruptedException | ExecutionException e) {
612 throw new RuntimeException(e);
616 List<String> getVpnRdsFromVpnInstanceConfig(String vpnName) {
617 InstanceIdentifier<VpnInstance> id = InstanceIdentifier.builder(VpnInstances.class)
618 .child(VpnInstance.class, new VpnInstanceKey(vpnName)).build();
619 Optional<VpnInstance> vpnInstance = read(LogicalDatastoreType.CONFIGURATION, id);
620 return vpnInstance.isPresent() ? getListOfRdsFromVpnInstance(vpnInstance.get()) : new ArrayList<>();
624 * Remove from MDSAL all those VrfEntries in a VPN that have an specific RouteOrigin.
626 * @param rd Route Distinguisher
627 * @param origin Origin of the Routes to be removed (see {@link RouteOrigin})
629 public void removeVrfEntriesByOrigin(String rd, RouteOrigin origin) {
630 InstanceIdentifier<VrfTables> vpnVrfTableIid =
631 InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class, new VrfTablesKey(rd)).build();
632 Optional<VrfTables> vrfTablesOpc = read(LogicalDatastoreType.CONFIGURATION, vpnVrfTableIid);
633 if (vrfTablesOpc.isPresent()) {
634 VrfTables vrfTables = vrfTablesOpc.get();
635 ListenableFutures.addErrorLogging(
636 new ManagedNewTransactionRunnerImpl(dataBroker).callWithNewWriteOnlyTransactionAndSubmit(
637 Datastore.CONFIGURATION, tx -> {
638 for (VrfEntry vrfEntry : vrfTables.nonnullVrfEntry()) {
639 if (origin == RouteOrigin.value(vrfEntry.getOrigin())) {
640 tx.delete(vpnVrfTableIid.child(VrfEntry.class, vrfEntry.key()));
643 }), LOG, "Error removing VRF entries by origin");
647 public List<VrfEntry> findVrfEntriesByNexthop(String rd, String nexthop) {
648 InstanceIdentifier<VrfTables> vpnVrfTableIid =
649 InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class, new VrfTablesKey(rd)).build();
650 Optional<VrfTables> vrfTablesOpc = read(LogicalDatastoreType.CONFIGURATION, vpnVrfTableIid);
651 List<VrfEntry> matches = new ArrayList<>();
652 if (vrfTablesOpc.isPresent()) {
653 VrfTables vrfTables = vrfTablesOpc.get();
654 for (VrfEntry vrfEntry : vrfTables.nonnullVrfEntry()) {
655 vrfEntry.nonnullRoutePaths().stream()
656 .filter(routePath -> routePath.getNexthopAddress() != null && routePath.getNexthopAddress()
657 .equals(nexthop)).findFirst().ifPresent(routePath -> matches.add(vrfEntry));
663 public void removeVrfEntries(String rd, List<VrfEntry> vrfEntries) {
664 InstanceIdentifier<VrfTables> vpnVrfTableIid =
665 InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class, new VrfTablesKey(rd)).build();
666 ListenableFutures.addErrorLogging(
667 new ManagedNewTransactionRunnerImpl(dataBroker).callWithNewWriteOnlyTransactionAndSubmit(
668 Datastore.CONFIGURATION, tx -> {
669 for (VrfEntry vrfEntry : vrfEntries) {
670 tx.delete(vpnVrfTableIid.child(VrfEntry.class, vrfEntry.key()));
672 }), LOG, "Error removing VRF entries");
675 // TODO Clean up the exception handling
676 @SuppressWarnings("checkstyle:IllegalCatch")
677 public void withdrawRoutes(String rd, List<VrfEntry> vrfEntries) {
678 vrfEntries.forEach(vrfEntry -> {
680 bgpManager.withdrawPrefix(rd, vrfEntry.getDestPrefix());
681 } catch (Exception e) {
682 LOG.error("withdrawRoutes: Could not withdraw route to {} with route-paths {} in VpnRd {}",
683 vrfEntry.getDestPrefix(), vrfEntry.getRoutePaths(), rd);
688 public boolean removeOrUpdateDSForExtraRoute(String vpnName, String primaryRd, String extraRouteRd,
689 String vpnInterfaceName, String prefix, String nextHop,
690 String nextHopTunnelIp, TypedWriteTransaction<Operational> operTx) {
691 LOG.info("removeOrUpdateDSForExtraRoute: VPN WITHDRAW: Removing Fib Entry rd {} prefix {} nexthop {}",
692 extraRouteRd, prefix, nextHop);
693 boolean areNextHopsClearedForRd = false;
694 Optional<Routes> optVpnExtraRoutes = VpnExtraRouteHelper
695 .getVpnExtraroutes(dataBroker, vpnName, extraRouteRd, prefix);
696 if (optVpnExtraRoutes.isPresent()) {
697 List<String> nhList = optVpnExtraRoutes.get().getNexthopIpList();
698 if (nhList != null && nhList.size() > 1) {
699 // If nhList is more than 1, just update vpntoextraroute and prefixtointerface DS
700 // For other cases, remove the corresponding tep ip from fibentry and withdraw prefix
701 nhList.remove(nextHop);
702 syncWrite(LogicalDatastoreType.OPERATIONAL,
703 VpnExtraRouteHelper.getVpnToExtrarouteVrfIdIdentifier(vpnName, extraRouteRd, prefix),
704 VpnUtil.getVpnToExtraroute(prefix, nhList));
705 MDSALUtil.syncDelete(dataBroker,
706 LogicalDatastoreType.CONFIGURATION, VpnExtraRouteHelper.getUsedRdsIdentifier(getVpnId(vpnName),
708 LOG.info("removeOrUpdateDSForExtraRoute: Removed vpn-to-extraroute with rd {} prefix {} nexthop {}",
709 extraRouteRd, prefix, nextHop);
710 fibManager.refreshVrfEntry(primaryRd, prefix);
711 operTx.delete(VpnUtil.getVpnInterfaceOpDataEntryAdjacencyIdentifier(vpnInterfaceName, vpnName, prefix));
712 LOG.info("VPN WITHDRAW: removeOrUpdateDSForExtraRoute: Removed Fib Entry rd {} prefix {} nexthop {}",
713 extraRouteRd, prefix, nextHopTunnelIp);
714 areNextHopsClearedForRd = true;
717 return areNextHopsClearedForRd;
720 static org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstance
721 getVpnInstanceToVpnId(String vpnName, Uint32 vpnId, String rd) {
722 return new VpnInstanceBuilder().setVpnId(vpnId).setVpnInstanceName(vpnName).setVrfId(rd).build();
726 static org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance.VpnIds
727 getVpnIdToVpnInstance(Uint32 vpnId, String vpnName, String rd, boolean isExternalVpn) {
728 return new org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance
729 .VpnIdsBuilder().setVpnId(vpnId).setVpnInstanceName(vpnName).setVrfId(rd).setExternalVpn(isExternalVpn)
734 static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to
735 .vpn.instance.VpnIds> getVpnIdToVpnInstanceIdentifier(Uint32 vpnId) {
736 return InstanceIdentifier.builder(VpnIdToVpnInstance.class).child(org.opendaylight.yang.gen.v1.urn
737 .opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance.VpnIds.class,
738 new org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance
739 .VpnIdsKey(vpnId)).build();
743 * Retrieves the Vpn Name searching by its VPN Tag.
745 * @param vpnId Dataplane identifier of the VPN
746 * @return the Vpn instance name
749 String getVpnName(Uint32 vpnId) {
751 InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn
752 .instance.VpnIds> id = getVpnIdToVpnInstanceIdentifier(vpnId);
753 Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance.VpnIds>
755 = read(LogicalDatastoreType.CONFIGURATION, id);
756 String vpnName = null;
757 if (vpnInstance.isPresent()) {
758 vpnName = vpnInstance.get().getVpnInstanceName();
763 public static InstanceIdentifier<VpnInstanceOpDataEntry> getVpnInstanceOpDataIdentifier(String rd) {
764 return InstanceIdentifier.builder(VpnInstanceOpData.class)
765 .child(VpnInstanceOpDataEntry.class, new VpnInstanceOpDataEntryKey(rd)).build();
769 public VpnInstanceOpDataEntry getVpnInstanceOpData(String rd) {
770 return read(LogicalDatastoreType.OPERATIONAL, getVpnInstanceOpDataIdentifier(rd)).orNull();
774 VpnInterface getConfiguredVpnInterface(String interfaceName) {
775 InstanceIdentifier<VpnInterface> interfaceId = getVpnInterfaceIdentifier(interfaceName);
776 Optional<VpnInterface> configuredVpnInterface = read(LogicalDatastoreType.CONFIGURATION, interfaceId);
777 if (configuredVpnInterface.isPresent()) {
778 return configuredVpnInterface.get();
783 boolean isVpnInterfaceConfigured(String interfaceName) {
784 InstanceIdentifier<VpnInterface> interfaceId = getVpnInterfaceIdentifier(interfaceName);
785 return read(LogicalDatastoreType.CONFIGURATION, interfaceId).isPresent();
788 public Optional<List<String>> getVpnHandlingIpv4AssociatedWithInterface(String interfaceName) {
789 InstanceIdentifier<VpnInterface> interfaceId = getVpnInterfaceIdentifier(interfaceName);
790 Optional<List<String>> vpnOptional = Optional.absent();
791 Optional<VpnInterface> optConfiguredVpnInterface = read(LogicalDatastoreType.CONFIGURATION, interfaceId);
792 if (optConfiguredVpnInterface.isPresent()) {
793 VpnInterface cfgVpnInterface = optConfiguredVpnInterface.get();
794 java.util.Optional<List<VpnInstanceNames>> optVpnInstanceList =
795 java.util.Optional.ofNullable(cfgVpnInterface.getVpnInstanceNames());
796 if (optVpnInstanceList.isPresent()) {
797 List<String> vpnList = new ArrayList<>();
798 for (VpnInstanceNames vpnInstance : optVpnInstanceList.get()) {
799 vpnList.add(vpnInstance.getVpnName());
801 vpnOptional = Optional.of(vpnList);
807 public static String getIpPrefix(String prefix) {
808 return prefix.indexOf('/') != -1 ? prefix : NWUtil.toIpPrefix(prefix);
811 static final FutureCallback<Void> DEFAULT_CALLBACK =
812 new FutureCallback<Void>() {
814 public void onSuccess(Void result) {
815 LOG.debug("Success in Datastore operation");
819 public void onFailure(Throwable error) {
820 LOG.error("Error in Datastore operation", error);
826 private <T extends DataObject> Optional<T> read(LogicalDatastoreType datastoreType, InstanceIdentifier<T> path) {
828 return SingleTransactionDataBroker.syncReadOptional(dataBroker, datastoreType, path);
829 } catch (ReadFailedException e) {
830 throw new RuntimeException(e);
835 public <T extends DataObject> void syncWrite(LogicalDatastoreType datastoreType, InstanceIdentifier<T> path,
838 SingleTransactionDataBroker.syncWrite(dataBroker, datastoreType, path, data);
839 } catch (TransactionCommitFailedException e) {
840 LOG.error("syncWrite: Error writing to datastore (path, data) : ({}, {})", path, data, e);
841 throw new RuntimeException(e.getMessage(), e);
846 public <T extends DataObject> void syncUpdate(LogicalDatastoreType datastoreType, InstanceIdentifier<T> path,
849 SingleTransactionDataBroker.syncUpdate(dataBroker, datastoreType, path, data);
850 } catch (TransactionCommitFailedException e) {
851 LOG.error("syncUpdate: Error writing to datastore (path, data) : ({}, {})", path, data, e);
852 throw new RuntimeException(e.getMessage(), e);
856 static long getRemoteBCGroup(long elanTag) {
857 return VpnConstants.ELAN_GID_MIN + elanTag % VpnConstants.ELAN_GID_MIN * 2;
860 // interface-index-tag operational container
862 IfIndexInterface getInterfaceInfoByInterfaceTag(long interfaceTag) {
863 InstanceIdentifier<IfIndexInterface> interfaceId = getInterfaceInfoEntriesOperationalDataPath(interfaceTag);
864 Optional<IfIndexInterface> existingInterfaceInfo = read(LogicalDatastoreType.OPERATIONAL, interfaceId);
865 if (existingInterfaceInfo.isPresent()) {
866 return existingInterfaceInfo.get();
871 static InstanceIdentifier<IfIndexInterface> getInterfaceInfoEntriesOperationalDataPath(long interfaceTag) {
872 return InstanceIdentifier.builder(IfIndexesInterfaceMap.class).child(IfIndexInterface.class,
873 new IfIndexInterfaceKey((int) interfaceTag)).build();
877 ElanTagName getElanInfoByElanTag(long elanTag) {
878 InstanceIdentifier<ElanTagName> elanId = getElanInfoEntriesOperationalDataPath(elanTag);
879 Optional<ElanTagName> existingElanInfo = read(LogicalDatastoreType.OPERATIONAL, elanId);
880 if (existingElanInfo.isPresent()) {
881 return existingElanInfo.get();
886 static InstanceIdentifier<ElanTagName> getElanInfoEntriesOperationalDataPath(long elanTag) {
887 return InstanceIdentifier.builder(ElanTagNameMap.class).child(ElanTagName.class,
888 new ElanTagNameKey(elanTag)).build();
891 static void removePrefixToInterfaceForVpnId(Uint32 vpnId, @NonNull TypedWriteTransaction<Operational> operTx) {
892 // Clean up PrefixToInterface Operational DS
893 operTx.delete(InstanceIdentifier.builder(
894 PrefixToInterface.class).child(VpnIds.class, new VpnIdsKey(vpnId)).build());
897 static void removeVpnExtraRouteForVpn(String vpnName, @NonNull TypedWriteTransaction<Operational> operTx) {
898 // Clean up VPNExtraRoutes Operational DS
899 operTx.delete(InstanceIdentifier.builder(VpnToExtraroutes.class).child(Vpn.class, new VpnKey(vpnName)).build());
902 @SuppressWarnings("checkstyle:IllegalCatch")
903 static void removeVpnOpInstance(String vpnName, @NonNull TypedWriteTransaction<Operational> operTx) {
904 // Clean up VPNInstanceOpDataEntry
905 operTx.delete(getVpnInstanceOpDataIdentifier(vpnName));
908 static void removeVpnInstanceToVpnId(String vpnName, @NonNull TypedWriteTransaction<Configuration> confTx) {
909 confTx.delete(VpnOperDsUtils.getVpnInstanceToVpnIdIdentifier(vpnName));
912 static void removeVpnIdToVpnInstance(Uint32 vpnId, @NonNull TypedWriteTransaction<Configuration> confTx) {
913 confTx.delete(getVpnIdToVpnInstanceIdentifier(vpnId));
916 static void removeL3nexthopForVpnId(Uint32 vpnId, @NonNull TypedWriteTransaction<Operational> operTx) {
917 // Clean up L3NextHop Operational DS
918 operTx.delete(InstanceIdentifier.builder(L3nexthop.class).child(
919 VpnNexthops.class, new VpnNexthopsKey(vpnId)).build());
922 void scheduleVpnInterfaceForRemoval(String interfaceName, Uint64 dpnId, String vpnInstanceName,
923 @Nullable TypedWriteTransaction<Operational> writeOperTxn) {
924 InstanceIdentifier<VpnInterfaceOpDataEntry> interfaceId =
925 getVpnInterfaceOpDataEntryIdentifier(interfaceName, vpnInstanceName);
926 VpnInterfaceOpDataEntry interfaceToUpdate =
927 new VpnInterfaceOpDataEntryBuilder().withKey(new VpnInterfaceOpDataEntryKey(interfaceName,
928 vpnInstanceName)).setName(interfaceName).setDpnId(dpnId).setVpnInstanceName(vpnInstanceName)
930 if (writeOperTxn != null) {
931 writeOperTxn.merge(interfaceId, interfaceToUpdate, true);
933 syncUpdate(LogicalDatastoreType.OPERATIONAL, interfaceId, interfaceToUpdate);
937 public void createLearntVpnVipToPort(String vpnName, String fixedIp, String portName, String macAddress,
938 TypedWriteTransaction<Operational> writeOperTxn) {
939 final InstanceIdentifier<LearntVpnVipToPort> id = buildLearntVpnVipToPortIdentifier(vpnName, fixedIp);
940 final ReentrantLock lock = lockFor(vpnName, fixedIp);
943 LearntVpnVipToPortBuilder builder =
944 new LearntVpnVipToPortBuilder().withKey(new LearntVpnVipToPortKey(fixedIp, vpnName)).setVpnName(
945 vpnName).setPortFixedip(fixedIp).setPortName(portName)
946 .setMacAddress(macAddress.toLowerCase(Locale.getDefault()))
947 .setCreationTime(new SimpleDateFormat("MM/dd/yyyy h:mm:ss a").format(new Date()));
948 if (writeOperTxn != null) {
949 writeOperTxn.put(id, builder.build(), true);
951 syncWrite(LogicalDatastoreType.OPERATIONAL, id, builder.build());
953 LOG.debug("createLearntVpnVipToPort: ARP/NA learned for fixedIp: {}, vpn {}, interface {}, mac {},"
954 + " added to LearntVpnVipToPort DS", fixedIp, vpnName, portName, macAddress);
960 static InstanceIdentifier<LearntVpnVipToPort> buildLearntVpnVipToPortIdentifier(String vpnName,
962 return InstanceIdentifier.builder(LearntVpnVipToPortData.class).child(LearntVpnVipToPort.class,
963 new LearntVpnVipToPortKey(fixedIp, vpnName)).build();
966 void removeLearntVpnVipToPort(String vpnName, String fixedIp,
967 @Nullable TypedWriteTransaction<Operational> writeOperTxn) {
968 final InstanceIdentifier<LearntVpnVipToPort> id = buildLearntVpnVipToPortIdentifier(vpnName, fixedIp);
969 final ReentrantLock lock = lockFor(vpnName, fixedIp);
972 if (writeOperTxn != null) {
973 writeOperTxn.delete(id);
975 MDSALUtil.syncDelete(dataBroker, LogicalDatastoreType.OPERATIONAL, id);
977 LOG.debug("removeLearntVpnVipToPort: Deleted LearntVpnVipToPort entry for fixedIp: {}, vpn {}",
984 protected static void removeVpnPortFixedIpToPort(DataBroker broker, String vpnName, String fixedIp,
985 @Nullable TypedWriteTransaction<Configuration> writeConfigTxn) {
986 final InstanceIdentifier<VpnPortipToPort> id = buildVpnPortipToPortIdentifier(vpnName, fixedIp);
987 final ReentrantLock lock = lockFor(vpnName, fixedIp);
990 if (writeConfigTxn != null) {
991 writeConfigTxn.delete(id);
993 MDSALUtil.syncDelete(broker, LogicalDatastoreType.CONFIGURATION, id);
995 LOG.debug("removeVpnPortFixedIpToPort: Deleted VpnPortipToPort entry for fixedIp: {}, vpn {}",
1002 public void createLearntVpnVipToPortEvent(String vpnName, String srcIp, String destIP, String portName,
1003 String macAddress, LearntVpnVipToPortEventAction action,
1004 TypedWriteTransaction<Operational> writeOperTxn) {
1005 String eventId = MicroTimestamp.INSTANCE.get();
1007 InstanceIdentifier<LearntVpnVipToPortEvent> id = buildLearntVpnVipToPortEventIdentifier(eventId);
1008 LearntVpnVipToPortEventBuilder builder = new LearntVpnVipToPortEventBuilder().withKey(
1009 new LearntVpnVipToPortEventKey(eventId)).setVpnName(vpnName).setSrcFixedip(srcIp)
1010 .setDestFixedip(destIP).setPortName(portName)
1011 .setMacAddress(macAddress.toLowerCase(Locale.getDefault())).setEventAction(action);
1012 if (writeOperTxn != null) {
1013 writeOperTxn.delete(id);
1015 syncWrite(LogicalDatastoreType.OPERATIONAL, id, builder.build());
1017 LOG.info("createLearntVpnVipToPortEvent: ARP learn event created for fixedIp: {}, vpn {}, interface {},"
1018 + " mac {} action {} eventId {}", srcIp, vpnName, portName, macAddress, action, eventId);
1021 private static InstanceIdentifier<LearntVpnVipToPortEvent> buildLearntVpnVipToPortEventIdentifier(String eventId) {
1022 InstanceIdentifier<LearntVpnVipToPortEvent> id = InstanceIdentifier.builder(LearntVpnVipToPortEventData.class)
1023 .child(LearntVpnVipToPortEvent.class, new LearntVpnVipToPortEventKey(eventId)).build();
1027 public void removeLearntVpnVipToPortEvent(String eventId,
1028 @Nullable TypedWriteTransaction<Operational> writeOperTxn) {
1029 InstanceIdentifier<LearntVpnVipToPortEvent> id = buildLearntVpnVipToPortEventIdentifier(eventId);
1030 if (writeOperTxn != null) {
1031 writeOperTxn.delete(id);
1033 MDSALUtil.syncDelete(dataBroker, LogicalDatastoreType.OPERATIONAL, id);
1035 LOG.info("removeLearntVpnVipToPortEvent: Deleted Event {}", eventId);
1039 // TODO Clean up the exception handling
1040 @SuppressWarnings("checkstyle:IllegalCatch")
1041 public void removeMipAdjAndLearntIp(String vpnName, String vpnInterface, String prefix) {
1042 final ReentrantLock lock = lockFor(vpnName, prefix);
1045 String ip = VpnUtil.getIpPrefix(prefix);
1046 InstanceIdentifier<VpnInterfaceOpDataEntry> vpnInterfaceOpId = VpnUtil
1047 .getVpnInterfaceOpDataEntryIdentifier(vpnInterface, vpnName);
1048 InstanceIdentifier<AdjacenciesOp> path = vpnInterfaceOpId.augmentation(AdjacenciesOp.class);
1049 Optional<AdjacenciesOp> adjacenciesOp = read(LogicalDatastoreType.OPERATIONAL, path);
1050 if (adjacenciesOp.isPresent()) {
1051 InstanceIdentifier<Adjacency> adjacencyIdentifier = InstanceIdentifier.builder(VpnInterfaces.class)
1052 .child(VpnInterface.class, new VpnInterfaceKey(vpnInterface))
1053 .augmentation(Adjacencies.class).child(Adjacency.class, new AdjacencyKey(ip)).build();
1054 MDSALUtil.syncDelete(dataBroker, LogicalDatastoreType.CONFIGURATION, adjacencyIdentifier);
1055 LOG.info("removeMipAdjAndLearntIp: Successfully Deleted Adjacency {} from interface {} vpn {}", ip,
1056 vpnInterface, vpnName);
1058 InstanceIdentifier<LearntVpnVipToPort> id = buildLearntVpnVipToPortIdentifier(vpnName, prefix);
1059 MDSALUtil.syncDelete(dataBroker, LogicalDatastoreType.OPERATIONAL, id);
1060 LOG.info("removeMipAdjAndLearntIp: Delete learned ARP for fixedIp: {}, vpn {} removed from"
1061 + "VpnPortipToPort DS", prefix, vpnName);
1062 } catch (Exception e) {
1063 LOG.error("removeMipAdjAndLearntIp: Exception Deleting learned Ip: {} interface {} vpn {} from "
1064 + "LearntVpnPortipToPort DS", prefix, vpnInterface, vpnName, e);
1068 VpnUtil.removeVpnPortFixedIpToPort(dataBroker, vpnName, prefix, null);
1071 public void removeMipAdjacency(String vpnInterface, String ipAddress) {
1072 String prefix = VpnUtil.getIpPrefix(ipAddress);
1073 InstanceIdentifier<Adjacency> adjacencyIdentifier = getAdjacencyIdentifier(vpnInterface, prefix);
1075 SingleTransactionDataBroker.syncDelete(dataBroker, LogicalDatastoreType.CONFIGURATION, adjacencyIdentifier);
1076 } catch (TransactionCommitFailedException e) {
1077 if (e.getCause() instanceof ModifiedNodeDoesNotExistException) {
1078 LOG.debug("vpnInterface {} is already deleted. prefix={}", vpnInterface, prefix);
1080 LOG.error("Failed to delete adjacency for vpnInterface {}, prefix {}", vpnInterface, prefix, e);
1085 static InstanceIdentifier<NetworkMap> buildNetworkMapIdentifier(Uuid networkId) {
1086 return InstanceIdentifier.builder(NetworkMaps.class).child(NetworkMap.class, new
1087 NetworkMapKey(networkId)).build();
1090 static InstanceIdentifier<SubnetOpDataEntry> buildSubnetOpDataEntryInstanceIdentifier(Uuid subnetId) {
1091 return InstanceIdentifier.builder(SubnetOpData.class)
1092 .child(SubnetOpDataEntry.class, new SubnetOpDataEntryKey(subnetId)).build();
1095 static InstanceIdentifier<VpnPortipToPort> buildVpnPortipToPortIdentifier(String vpnName, String fixedIp) {
1096 return InstanceIdentifier.builder(NeutronVpnPortipPortData.class).child(VpnPortipToPort.class,
1097 new VpnPortipToPortKey(fixedIp, vpnName)).build();
1101 public VpnPortipToPort getNeutronPortFromVpnPortFixedIp(String vpnName, String fixedIp) {
1102 InstanceIdentifier<VpnPortipToPort> id = buildVpnPortipToPortIdentifier(vpnName, fixedIp);
1103 Optional<VpnPortipToPort> vpnPortipToPortData = read(LogicalDatastoreType.CONFIGURATION, id);
1104 if (vpnPortipToPortData.isPresent()) {
1105 return vpnPortipToPortData.get();
1111 public static VpnPortipToPort getNeutronPortFromVpnPortFixedIp(TypedReadTransaction<Configuration> confTx,
1112 String vpnName, String fixedIp) {
1113 InstanceIdentifier<VpnPortipToPort> id = buildVpnPortipToPortIdentifier(vpnName, fixedIp);
1115 return confTx.read(id).get().orNull();
1116 } catch (InterruptedException | ExecutionException e) {
1117 throw new RuntimeException(e);
1122 public LearntVpnVipToPort getLearntVpnVipToPort(String vpnName, String fixedIp) {
1123 InstanceIdentifier<LearntVpnVipToPort> id = buildLearntVpnVipToPortIdentifier(vpnName, fixedIp);
1124 Optional<LearntVpnVipToPort> learntVpnVipToPort = read(LogicalDatastoreType.OPERATIONAL, id);
1125 if (learntVpnVipToPort.isPresent()) {
1126 return learntVpnVipToPort.get();
1132 List<Uint64> getDpnsOnVpn(String vpnInstanceName) {
1133 List<Uint64> result = new ArrayList<>();
1134 String rd = getVpnRd(vpnInstanceName);
1136 LOG.debug("getDpnsOnVpn: Could not find Route-Distinguisher for VpnName={}", vpnInstanceName);
1139 VpnInstanceOpDataEntry vpnInstanceOpData = getVpnInstanceOpData(rd);
1140 if (vpnInstanceOpData == null) {
1141 LOG.debug("getDpnsOnVpn: Could not find OpState for VpnName={}", vpnInstanceName);
1144 List<VpnToDpnList> vpnToDpnList = vpnInstanceOpData.getVpnToDpnList();
1145 if (vpnToDpnList == null) {
1146 LOG.debug("getDpnsOnVpn: Could not find DPN footprint for VpnName={}", vpnInstanceName);
1149 for (VpnToDpnList vpnToDpn : vpnToDpnList) {
1150 result.add(vpnToDpn.getDpnId());
1156 String getAssociatedExternalRouter(String extIp) {
1157 InstanceIdentifier<ExtRouters> extRouterInstanceIndentifier =
1158 InstanceIdentifier.builder(ExtRouters.class).build();
1159 Optional<ExtRouters> extRouterData = read(LogicalDatastoreType.CONFIGURATION, extRouterInstanceIndentifier);
1160 if (!extRouterData.isPresent()) {
1164 // We need to find the router associated with the src ip of this packet.
1165 // This case is either SNAT, in which case the src ip is the same as the
1166 // router's external ip, or FIP in which case the src ip is in the router's
1167 // external leg's subnet. We first check the SNAT case because it is much
1168 // cheaper to do so because it does not require (potentially, there is a
1169 // cache) an datastore read of the neutron subnet for each external IP.
1171 String routerName = null;
1173 for (Routers routerData : extRouterData.get().nonnullRouters()) {
1174 List<ExternalIps> externalIps = routerData.nonnullExternalIps();
1175 for (ExternalIps externalIp : externalIps) {
1176 if (Objects.equals(externalIp.getIpAddress(), extIp)) {
1177 routerName = routerData.getRouterName();
1183 if (routerName != null) {
1187 for (Routers routerData : extRouterData.get().nonnullRouters()) {
1188 List<ExternalIps> externalIps = routerData.nonnullExternalIps();
1189 for (ExternalIps externalIp : externalIps) {
1190 Subnet neutronSubnet = neutronVpnService.getNeutronSubnet(externalIp.getSubnetId());
1191 if (neutronSubnet == null) {
1192 LOG.warn("Failed to retrieve subnet {} referenced by router {}",
1193 externalIp.getSubnetId(), routerData);
1196 if (NWUtil.isIpAddressInRange(IpAddressBuilder.getDefaultInstance(extIp), neutronSubnet.getCidr())) {
1197 routerName = routerData.getRouterName();
1207 public String getAssociatedExternalSubnet(String extIp) {
1208 InstanceIdentifier<ExtRouters> extRouterInstanceIndentifier =
1209 InstanceIdentifier.builder(ExtRouters.class).build();
1210 Optional<ExtRouters> extRouterData = read(LogicalDatastoreType.CONFIGURATION, extRouterInstanceIndentifier);
1211 if (!extRouterData.isPresent() || extRouterData.get().getRouters() == null) {
1214 for (Routers routerData : extRouterData.get().getRouters()) {
1215 List<ExternalIps> externalIps = routerData.getExternalIps();
1216 if (externalIps != null) {
1217 for (ExternalIps externalIp : externalIps) {
1218 Subnet neutronSubnet = neutronVpnService.getNeutronSubnet(externalIp.getSubnetId());
1219 if (neutronSubnet == null) {
1220 LOG.warn("Failed to retrieve subnet {} referenced by router {}",
1221 externalIp.getSubnetId(), routerData);
1224 if (NWUtil.isIpAddressInRange(IpAddressBuilder.getDefaultInstance(extIp),
1225 neutronSubnet.getCidr())) {
1226 return neutronSubnet.getUuid().getValue();
1234 static InstanceIdentifier<Routers> buildRouterIdentifier(String routerId) {
1235 return InstanceIdentifier.builder(ExtRouters.class).child(Routers.class, new RoutersKey(routerId)).build();
1239 Networks getExternalNetwork(Uuid networkId) {
1240 InstanceIdentifier<Networks> netsIdentifier = InstanceIdentifier.builder(ExternalNetworks.class)
1241 .child(Networks.class, new NetworksKey(networkId)).build();
1242 Optional<Networks> optionalNets = read(LogicalDatastoreType.CONFIGURATION, netsIdentifier);
1243 return optionalNets.isPresent() ? optionalNets.get() : null;
1247 Uuid getExternalNetworkVpnId(Uuid networkId) {
1248 Networks extNetwork = getExternalNetwork(networkId);
1249 return extNetwork != null ? extNetwork.getVpnid() : null;
1253 public List<Uuid> getExternalNetworkRouterIds(Uuid networkId) {
1254 Networks extNetwork = getExternalNetwork(networkId);
1255 return extNetwork != null && extNetwork.getRouterIds() != null ? extNetwork.getRouterIds() : emptyList();
1259 Routers getExternalRouter(String routerId) {
1260 InstanceIdentifier<Routers> id = InstanceIdentifier.builder(ExtRouters.class).child(Routers.class,
1261 new RoutersKey(routerId)).build();
1262 Optional<Routers> routerData = read(LogicalDatastoreType.CONFIGURATION, id);
1263 return routerData.isPresent() ? routerData.get() : null;
1267 Routers getExternalRouter(TypedReadTransaction<Configuration> tx, String routerId)
1268 throws ExecutionException, InterruptedException {
1269 InstanceIdentifier<Routers> id = InstanceIdentifier.builder(ExtRouters.class).child(Routers.class,
1270 new RoutersKey(routerId)).build();
1271 return tx.read(id).get().orNull();
1274 static InstanceIdentifier<Subnetmaps> buildSubnetMapsWildCardPath() {
1275 return InstanceIdentifier.create(Subnetmaps.class);
1278 FlowEntity buildL3vpnGatewayFlow(Uint64 dpId, String gwMacAddress, Uint32 vpnId,
1279 Uint32 subnetVpnId) {
1280 List<MatchInfo> mkMatches = new ArrayList<>();
1281 Subnetmap smap = null;
1282 mkMatches.add(new MatchMetadata(MetaDataUtil.getVpnIdMetadata(vpnId.longValue()),
1283 MetaDataUtil.METADATA_MASK_VRFID));
1284 mkMatches.add(new MatchEthernetDestination(new MacAddress(gwMacAddress)));
1285 List<InstructionInfo> mkInstructions = new ArrayList<>();
1286 mkInstructions.add(new InstructionGotoTable(NwConstants.L3_FIB_TABLE));
1287 if (!VpnConstants.INVALID_ID.equals(subnetVpnId)) {
1288 String vpnName = getVpnName(subnetVpnId);
1289 if (vpnName != null) {
1290 smap = getSubnetmapFromItsUuid(Uuid.getDefaultInstance(vpnName));
1291 if (smap != null && smap.getSubnetIp() != null) {
1292 IpVersionChoice ipVersionChoice = getIpVersionFromString(smap.getSubnetIp());
1293 if (ipVersionChoice == IpVersionChoice.IPV4) {
1294 mkMatches.add(MatchEthernetType.IPV4);
1296 mkMatches.add(MatchEthernetType.IPV6);
1300 Uint64 subnetIdMetaData = MetaDataUtil.getVpnIdMetadata(subnetVpnId.longValue());
1301 mkInstructions.add(new InstructionWriteMetadata(subnetIdMetaData, MetaDataUtil.METADATA_MASK_VRFID));
1303 String flowId = getL3VpnGatewayFlowRef(NwConstants.L3_GW_MAC_TABLE, dpId, vpnId, gwMacAddress, subnetVpnId);
1304 return MDSALUtil.buildFlowEntity(dpId, NwConstants.L3_GW_MAC_TABLE,
1305 flowId, 20, flowId, 0, 0, NwConstants.COOKIE_L3_GW_MAC_TABLE,
1306 mkMatches, mkInstructions);
1309 static String getL3VpnGatewayFlowRef(short l3GwMacTable, Uint64 dpId, Uint32 vpnId, String gwMacAddress,
1310 Uint32 subnetVpnId) {
1311 return gwMacAddress + NwConstants.FLOWID_SEPARATOR + vpnId + NwConstants.FLOWID_SEPARATOR + dpId
1312 + NwConstants.FLOWID_SEPARATOR + l3GwMacTable + NwConstants.FLOWID_SEPARATOR + subnetVpnId;
1315 void lockSubnet(String subnetId) {
1316 TryLockInput input =
1317 new TryLockInputBuilder().setLockName(subnetId).setTime(3000L).setTimeUnit(TimeUnits.Milliseconds).build();
1318 Future<RpcResult<TryLockOutput>> result = lockManager.tryLock(input);
1320 if (result != null && result.get().isSuccessful()) {
1321 LOG.debug("lockSubnet: Acquired lock for {}", subnetId);
1323 LOG.error("Unable to get lock for subnet {}", subnetId);
1324 throw new RuntimeException("Unable to get lock for subnet " + subnetId);
1326 } catch (InterruptedException | ExecutionException e) {
1327 LOG.error("Unable to get lock for subnet {}", subnetId, e);
1328 throw new RuntimeException("Unable to get lock for subnet " + subnetId, e);
1332 // We store the cause, which is what we really care about
1333 @SuppressWarnings("checkstyle:AvoidHidingCauseException")
1334 public void unlockSubnet(String subnetId) {
1335 UnlockInput input = new UnlockInputBuilder().setLockName(subnetId).build();
1336 Future<RpcResult<UnlockOutput>> result = lockManager.unlock(input);
1338 if (result != null && result.get().isSuccessful()) {
1339 LOG.debug("unlockSubnet: Unlocked {}", subnetId);
1341 LOG.debug("unlockSubnet: Unable to unlock subnet {}", subnetId);
1343 } catch (InterruptedException | ExecutionException e) {
1344 LOG.error("unlockSubnet: Unable to unlock subnet {}", subnetId);
1345 throw new RuntimeException(String.format("Unable to unlock subnetId %s", subnetId), e.getCause());
1349 public Optional<IpAddress> getGatewayIpAddressFromInterface(MacEntry macEntry) {
1350 Optional<IpAddress> gatewayIp = Optional.absent();
1351 String srcInterface = macEntry.getInterfaceName();
1352 InetAddress hiddenIp = macEntry.getIpAddress();
1353 if (neutronVpnService != null) {
1354 //TODO(Gobinath): Need to fix this as assuming port will belong to only one Subnet would be incorrect"
1355 Port port = neutronVpnService.getNeutronPort(srcInterface);
1356 if (port != null && port.getFixedIps() != null) {
1357 for (FixedIps portIp : port.getFixedIps()) {
1358 if (doesInterfaceAndHiddenIpAddressTypeMatch(hiddenIp, portIp)) {
1360 Optional.of(neutronVpnService.getNeutronSubnet(portIp.getSubnetId()).getGatewayIp());
1366 LOG.error("getGatewayIpAddressFromInterface: neutron vpn service is not configured."
1367 + " Failed for interface {}.", srcInterface);
1372 private boolean doesInterfaceAndHiddenIpAddressTypeMatch(InetAddress hiddenIp, FixedIps portIp) {
1373 return hiddenIp instanceof Inet4Address && portIp.getIpAddress().getIpv4Address() != null
1374 || hiddenIp instanceof Inet6Address && portIp.getIpAddress().getIpv6Address() != null;
1377 public Optional<String> getGWMacAddressFromInterface(MacEntry macEntry, IpAddress gatewayIp) {
1378 Optional<String> gatewayMac = Optional.absent();
1379 Uint32 vpnId = getVpnId(macEntry.getVpnName());
1380 InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn
1382 vpnIdsInstanceIdentifier = VpnUtil.getVpnIdToVpnInstanceIdentifier(vpnId);
1383 Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance.VpnIds>
1384 vpnIdsOptional = read(LogicalDatastoreType.CONFIGURATION, vpnIdsInstanceIdentifier);
1385 if (!vpnIdsOptional.isPresent()) {
1386 LOG.error("getGWMacAddressFromInterface: VPN {} not configured", vpnId);
1389 VpnPortipToPort vpnTargetIpToPort =
1390 getNeutronPortFromVpnPortFixedIp(macEntry.getVpnName(), gatewayIp.stringValue());
1391 if (vpnTargetIpToPort != null && vpnTargetIpToPort.isSubnetIp()) {
1392 gatewayMac = Optional.of(vpnTargetIpToPort.getMacAddress());
1394 org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911
1395 .vpn.id.to.vpn.instance.VpnIds vpnIds = vpnIdsOptional.get();
1396 if (vpnIds.isExternalVpn()) {
1397 gatewayMac = InterfaceUtils.getMacAddressForInterface(dataBroker, macEntry.getInterfaceName());
1403 void setupGwMacIfExternalVpn(Uint64 dpnId, String interfaceName, Uint32 vpnId,
1404 TypedReadWriteTransaction<Configuration> writeInvTxn, int addOrRemove, String gwMac)
1405 throws ExecutionException, InterruptedException {
1406 InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance
1407 .VpnIds> vpnIdsInstanceIdentifier = getVpnIdToVpnInstanceIdentifier(vpnId);
1408 Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance
1409 .VpnIds> vpnIdsOptional = writeInvTxn.read(vpnIdsInstanceIdentifier).get();
1410 if (vpnIdsOptional.isPresent() && vpnIdsOptional.get().isExternalVpn()) {
1411 if (gwMac == null) {
1412 LOG.error("setupGwMacIfExternalVpn: Failed to get gwMacAddress for interface {} on dpn {} vpn {}",
1413 interfaceName, dpnId.toString(), vpnIdsOptional.get().getVpnInstanceName());
1416 FlowEntity flowEntity = buildL3vpnGatewayFlow(dpnId, gwMac, vpnId,VpnConstants.INVALID_ID);
1417 if (addOrRemove == NwConstants.ADD_FLOW) {
1418 mdsalManager.addFlow(writeInvTxn, flowEntity);
1419 } else if (addOrRemove == NwConstants.DEL_FLOW) {
1420 mdsalManager.removeFlow(writeInvTxn, flowEntity);
1425 public Optional<String> getVpnSubnetGatewayIp(final Uuid subnetUuid) {
1426 Optional<String> gwIpAddress = Optional.absent();
1427 final SubnetKey subnetkey = new SubnetKey(subnetUuid);
1428 final InstanceIdentifier<Subnet> subnetidentifier = InstanceIdentifier.create(Neutron.class)
1429 .child(Subnets.class)
1430 .child(Subnet.class, subnetkey);
1431 final Optional<Subnet> subnet = read(LogicalDatastoreType.CONFIGURATION, subnetidentifier);
1432 if (subnet.isPresent()) {
1433 Class<? extends IpVersionBase> ipVersionBase = subnet.get().getIpVersion();
1434 if (IpVersionV4.class.equals(ipVersionBase)) {
1435 Subnetmap subnetmap = getSubnetmapFromItsUuid(subnetUuid);
1436 if (subnetmap != null && subnetmap.getRouterInterfaceFixedIp() != null) {
1437 LOG.trace("getVpnSubnetGatewayIp: Obtained subnetMap {} for vpn interface",
1438 subnetmap.getId().getValue());
1439 gwIpAddress = Optional.of(subnetmap.getRouterInterfaceFixedIp());
1441 //For direct L3VPN to network association (no router) continue to use subnet-gateway IP
1442 IpAddress gwIp = subnet.get().getGatewayIp();
1443 if (gwIp != null && gwIp.getIpv4Address() != null) {
1444 gwIpAddress = Optional.of(gwIp.getIpv4Address().getValue());
1447 LOG.trace("getVpnSubnetGatewayIp: Obtained subnet-gw ip {} for vpn interface",
1455 RouterToNaptSwitch getRouterToNaptSwitch(String routerName) {
1456 InstanceIdentifier<RouterToNaptSwitch> id = InstanceIdentifier.builder(NaptSwitches.class)
1457 .child(RouterToNaptSwitch.class, new RouterToNaptSwitchKey(routerName)).build();
1458 Optional<RouterToNaptSwitch> routerToNaptSwitchData = read(LogicalDatastoreType.CONFIGURATION, id);
1459 return routerToNaptSwitchData.isPresent() ? routerToNaptSwitchData.get() : null;
1462 static InstanceIdentifier<Subnetmap> buildSubnetmapIdentifier(Uuid subnetId) {
1463 return InstanceIdentifier.builder(Subnetmaps.class)
1464 .child(Subnetmap.class, new SubnetmapKey(subnetId)).build();
1469 Uint64 getPrimarySwitchForRouter(String routerName) {
1470 RouterToNaptSwitch routerToNaptSwitch = getRouterToNaptSwitch(routerName);
1471 return routerToNaptSwitch != null ? routerToNaptSwitch.getPrimarySwitchId() : null;
1474 static boolean isL3VpnOverVxLan(Uint32 l3Vni) {
1475 return l3Vni != null && l3Vni.longValue() != 0;
1479 * Retrieves the primary rd of a vpn instance
1480 * Primary rd will be the first rd in the list of rds configured for a vpn instance
1481 * If rd list is empty, primary rd will be vpn instance name
1482 * Use this function only during create operation cycles. For other operations, use getVpnRd() method.
1484 * @param vpnName Name of the VPN
1485 * @return the primary rd of the VPN
1487 public String getPrimaryRd(String vpnName) {
1488 // Retrieves the VPN Route Distinguisher by its Vpn instance name
1489 String rd = getVpnRd(vpnName);
1493 InstanceIdentifier<VpnInstance> id = getVpnInstanceIdentifier(vpnName);
1494 Optional<VpnInstance> vpnInstance = read(LogicalDatastoreType.CONFIGURATION, id);
1495 if (vpnInstance.isPresent()) {
1496 return getPrimaryRd(vpnInstance.get());
1502 * Retrieves the primary rd of a vpn instance
1503 * Primary rd will be the first rd in the list of rds configured for a vpn instance
1504 * If rd list is empty, primary rd will be vpn instance name
1505 * Use this function only during create operation cycles. For other operations, use getVpnRd() method.
1507 * @param vpnInstance Config Vpn Instance Object
1508 * @return the primary rd of the VPN
1510 static String getPrimaryRd(VpnInstance vpnInstance) {
1511 List<String> rds = null;
1512 if (vpnInstance != null) {
1513 rds = getListOfRdsFromVpnInstance(vpnInstance);
1515 return rds == null || rds.isEmpty() ? vpnInstance.getVpnInstanceName() : rds.get(0);
1518 static boolean isBgpVpn(String vpnName, String primaryRd) {
1519 return !vpnName.equals(primaryRd);
1522 java.util.Optional<String> allocateRdForExtraRouteAndUpdateUsedRdsMap(Uint32 vpnId, @Nullable Uint32 parentVpnId,
1523 String prefix, String vpnName,
1524 String nextHop, Uint64 dpnId) {
1525 //Check if rd is already allocated for this extraroute behind the same VM. If yes, reuse it.
1526 //This is particularly useful during reboot scenarios.
1527 java.util.Optional<String> allocatedRd = VpnExtraRouteHelper
1528 .getRdAllocatedForExtraRoute(dataBroker, vpnId, prefix, nextHop);
1529 if (allocatedRd.isPresent()) {
1533 //Check if rd is already allocated for this extraroute behind the same CSS. If yes, reuse it
1534 List<String> usedRds = VpnExtraRouteHelper.getUsedRds(dataBroker, vpnId, prefix);
1535 for (String usedRd : usedRds) {
1536 Optional<Routes> vpnExtraRoutes = VpnExtraRouteHelper.getVpnExtraroutes(dataBroker,
1537 vpnName, usedRd, prefix);
1538 if (vpnExtraRoutes.isPresent()) {
1539 String nextHopIp = vpnExtraRoutes.get().getNexthopIpList().get(0);
1540 // In case of VPN importing the routes, the interface is not present in the VPN
1541 // and has to be fetched from the VPN from which it imports
1542 Optional<Prefixes> prefixToInterface =
1543 getPrefixToInterface(parentVpnId != null ? parentVpnId : vpnId, nextHopIp);
1544 if (prefixToInterface.isPresent() && dpnId.equals(prefixToInterface.get().getDpnId())) {
1545 syncUpdate(LogicalDatastoreType.CONFIGURATION,
1546 VpnExtraRouteHelper.getUsedRdsIdentifier(vpnId, prefix, nextHop),
1547 getRdsBuilder(nextHop, usedRd).build());
1548 return java.util.Optional.of(usedRd);
1552 List<String> availableRds = getVpnRdsFromVpnInstanceConfig(vpnName);
1554 if (availableRds.isEmpty()) {
1555 rd = dpnId.toString();
1556 LOG.debug("Internal vpn {} Returning DpnId {} as rd", vpnName, rd);
1558 LOG.trace("Removing used rds {} from available rds {} vpnid {} . prefix is {} , vpname- {}, dpnId- {}",
1559 usedRds, availableRds, vpnId, prefix, vpnName, dpnId);
1560 availableRds.removeAll(usedRds);
1561 if (availableRds.isEmpty()) {
1562 LOG.error("No rd available from VpnInstance to allocate for prefix {}", prefix);
1563 return java.util.Optional.empty();
1565 // If rd is not allocated for this prefix or if extra route is behind different OVS, select a new rd.
1566 rd = availableRds.get(0);
1568 syncUpdate(LogicalDatastoreType.CONFIGURATION,
1569 VpnExtraRouteHelper.getUsedRdsIdentifier(vpnId, prefix, nextHop), getRdsBuilder(nextHop, rd).build());
1570 return java.util.Optional.ofNullable(rd);
1573 static String getVpnNamePrefixKey(String vpnName, String prefix) {
1574 return vpnName + VpnConstants.SEPARATOR + prefix;
1577 static InstanceIdentifier<Adjacency> getAdjacencyIdentifier(String vpnInterfaceName, String ipAddress) {
1578 return InstanceIdentifier.builder(VpnInterfaces.class)
1579 .child(VpnInterface.class, new VpnInterfaceKey(vpnInterfaceName))
1580 .augmentation(Adjacencies.class).child(Adjacency.class, new AdjacencyKey(ipAddress)).build();
1583 static InstanceIdentifier<Adjacency> getVpnInterfaceOpDataEntryAdjacencyIdentifier(String intfName,
1586 LOG.debug("getVpnInterfaceOpDataEntryAdjacencyIdentifier intfName {}, vpnName {}, ipAddress {}",
1587 intfName, vpnName, ipAddress);
1588 return InstanceIdentifier.builder(VpnInterfaceOpData.class)
1589 .child(VpnInterfaceOpDataEntry.class, new VpnInterfaceOpDataEntryKey(intfName, vpnName))
1590 .augmentation(AdjacenciesOp.class).child(Adjacency.class, new AdjacencyKey(ipAddress)).build();
1593 public static List<String> getIpsListFromExternalIps(List<ExternalIps> externalIps) {
1594 if (externalIps == null) {
1598 return externalIps.stream().map(ExternalIps::getIpAddress).collect(Collectors.toList());
1601 void bindService(final String vpnInstanceName, final String interfaceName, boolean isTunnelInterface) {
1602 jobCoordinator.enqueueJob(interfaceName,
1603 () -> Collections.singletonList(txRunner.callWithNewReadWriteTransactionAndSubmit(
1604 Datastore.CONFIGURATION, tx -> {
1605 BoundServices serviceInfo = isTunnelInterface
1606 ? VpnUtil.getBoundServicesForTunnelInterface(vpnInstanceName, interfaceName)
1607 : getBoundServicesForVpnInterface(vpnInstanceName, interfaceName);
1608 tx.put(InterfaceUtils.buildServiceId(interfaceName,
1609 ServiceIndex.getIndex(NwConstants.L3VPN_SERVICE_NAME,
1610 NwConstants.L3VPN_SERVICE_INDEX)),
1611 serviceInfo, WriteTransaction.CREATE_MISSING_PARENTS);
1612 })), SystemPropertyReader.getDataStoreJobCoordinatorMaxRetries());
1615 BoundServices getBoundServicesForVpnInterface(String vpnName, String interfaceName) {
1616 List<Instruction> instructions = new ArrayList<>();
1617 int instructionKey = 0;
1618 final Uint32 vpnId = getVpnId(vpnName);
1619 List<Action> actions = Collections.singletonList(
1620 new ActionRegLoad(0, VpnConstants.VPN_REG_ID, 0, VpnConstants.VPN_ID_LENGTH, vpnId.longValue())
1622 instructions.add(MDSALUtil.buildApplyActionsInstruction(actions, ++instructionKey));
1624 MDSALUtil.buildAndGetWriteMetadaInstruction(MetaDataUtil.getVpnIdMetadata(vpnId.longValue()),
1625 MetaDataUtil.METADATA_MASK_VRFID, ++instructionKey));
1626 instructions.add(MDSALUtil.buildAndGetGotoTableInstruction(NwConstants.L3_GW_MAC_TABLE,
1628 BoundServices serviceInfo = InterfaceUtils.getBoundServices(
1629 String.format("%s.%s.%s", "vpn", vpnName, interfaceName),
1630 ServiceIndex.getIndex(NwConstants.L3VPN_SERVICE_NAME, NwConstants.L3VPN_SERVICE_INDEX),
1631 VpnConstants.DEFAULT_FLOW_PRIORITY, NwConstants.COOKIE_VM_INGRESS_TABLE, instructions);
1635 static BoundServices getBoundServicesForTunnelInterface(String vpnName, String interfaceName) {
1636 int instructionKey = 0;
1637 List<Instruction> instructions = new ArrayList<>();
1638 instructions.add(MDSALUtil.buildAndGetGotoTableInstruction(
1639 NwConstants.L3VNI_EXTERNAL_TUNNEL_DEMUX_TABLE, ++instructionKey));
1640 BoundServices serviceInfo = InterfaceUtils.getBoundServices(String.format("%s.%s.%s", "vpn",
1641 vpnName, interfaceName),
1642 ServiceIndex.getIndex(NwConstants.L3VPN_SERVICE_NAME,
1643 NwConstants.L3VNI_EXTERNAL_TUNNEL_DEMUX_TABLE), VpnConstants.DEFAULT_FLOW_PRIORITY,
1644 NwConstants.COOKIE_VM_INGRESS_TABLE, instructions);
1648 void unbindService(final String vpnInterfaceName, boolean isInterfaceStateDown) {
1649 if (!isInterfaceStateDown) {
1650 jobCoordinator.enqueueJob(vpnInterfaceName,
1651 () -> Collections.singletonList(txRunner.callWithNewWriteOnlyTransactionAndSubmit(
1652 Datastore.CONFIGURATION, tx ->
1653 tx.delete(InterfaceUtils.buildServiceId(vpnInterfaceName,
1654 ServiceIndex.getIndex(NwConstants.L3VPN_SERVICE_NAME,
1655 NwConstants.L3VPN_SERVICE_INDEX))))),
1656 SystemPropertyReader.getDataStoreJobCoordinatorMaxRetries());
1660 static FlowEntity buildFlowEntity(Uint64 dpnId, short tableId, String flowId) {
1661 return new FlowEntityBuilder().setDpnId(dpnId).setTableId(tableId).setFlowId(flowId).build();
1664 static VrfEntryBase.EncapType getEncapType(boolean isVxLan) {
1665 return isVxLan ? VrfEntryBase.EncapType.Vxlan : VrfEntryBase.EncapType.Mplsgre;
1668 org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets.@Nullable Subnets
1669 getExternalSubnet(Uuid subnetId) {
1670 InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets
1671 .Subnets> subnetsIdentifier = InstanceIdentifier.builder(ExternalSubnets.class)
1672 .child(org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets
1673 .Subnets.class, new SubnetsKey(subnetId)).build();
1674 Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets.Subnets>
1675 optionalSubnets = read(LogicalDatastoreType.CONFIGURATION, subnetsIdentifier);
1676 return optionalSubnets.isPresent() ? optionalSubnets.get() : null;
1680 public Uuid getSubnetFromExternalRouterByIp(Uuid routerId, String ip) {
1681 Routers externalRouter = getExternalRouter(routerId.getValue());
1682 if (externalRouter != null && externalRouter.getExternalIps() != null) {
1683 for (ExternalIps externalIp : externalRouter.getExternalIps()) {
1684 if (Objects.equals(externalIp.getIpAddress(), ip)) {
1685 return externalIp.getSubnetId();
1692 static boolean isExternalSubnetVpn(String vpnName, String subnetId) {
1693 return vpnName.equals(subnetId);
1696 static Boolean getIsExternal(Network network) {
1697 return network.augmentation(NetworkL3Extension.class) != null
1698 && network.augmentation(NetworkL3Extension.class).isExternal();
1701 @SuppressWarnings("checkstyle:linelength")
1703 Network getNeutronNetwork(Uuid networkId) {
1704 LOG.debug("getNeutronNetwork for {}", networkId.getValue());
1705 InstanceIdentifier<Network> inst = InstanceIdentifier.create(Neutron.class).child(
1706 org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.Networks.class).child(
1707 Network.class, new NetworkKey(networkId));
1708 return read(LogicalDatastoreType.CONFIGURATION, inst).orNull();
1711 public static boolean isEligibleForBgp(@Nullable String rd, @Nullable String vpnName, @Nullable Uint64 dpnId,
1712 @Nullable String networkName) {
1714 if (rd.equals(vpnName)) {
1717 if (dpnId != null && rd.equals(dpnId.toString())) {
1720 if (rd.equals(networkName)) {
1728 static String getFibFlowRef(Uint64 dpnId, short tableId, String vpnName, int priority) {
1729 return VpnConstants.FLOWID_PREFIX + dpnId + NwConstants.FLOWID_SEPARATOR + tableId
1730 + NwConstants.FLOWID_SEPARATOR + vpnName + NwConstants.FLOWID_SEPARATOR + priority;
1733 void removeExternalTunnelDemuxFlows(String vpnName) {
1734 LOG.info("Removing external tunnel flows for vpn {}", vpnName);
1735 for (Uint64 dpnId: NWUtil.getOperativeDPNs(dataBroker)) {
1736 LOG.debug("Removing external tunnel flows for vpn {} from dpn {}", vpnName, dpnId);
1737 String flowRef = getFibFlowRef(dpnId, NwConstants.L3VNI_EXTERNAL_TUNNEL_DEMUX_TABLE,
1738 vpnName, VpnConstants.DEFAULT_FLOW_PRIORITY);
1739 FlowEntity flowEntity = VpnUtil.buildFlowEntity(dpnId,
1740 NwConstants.L3VNI_EXTERNAL_TUNNEL_DEMUX_TABLE, flowRef);
1741 mdsalManager.removeFlow(flowEntity);
1745 public boolean isVpnPendingDelete(String rd) {
1746 VpnInstanceOpDataEntry vpnInstanceOpData = getVpnInstanceOpData(rd);
1747 boolean isVpnPendingDelete = false;
1748 if (vpnInstanceOpData == null) {
1749 LOG.error("isVpnPendingDelete: unable to read vpn instance op data for vpn with rd {}", rd);
1750 isVpnPendingDelete = true;
1752 else if (vpnInstanceOpData.getVpnState() == VpnInstanceOpDataEntry.VpnState.PendingDelete) {
1753 isVpnPendingDelete = true;
1755 return isVpnPendingDelete;
1758 public List<VpnInstanceOpDataEntry> getVpnsImportingMyRoute(final String vpnName) {
1759 List<VpnInstanceOpDataEntry> vpnsToImportRoute = new ArrayList<>();
1760 final String vpnRd = getVpnRd(vpnName);
1761 if (vpnRd == null) {
1762 LOG.error("getVpnsImportingMyRoute: vpn {} not present in config DS.", vpnName);
1763 return vpnsToImportRoute;
1765 final VpnInstanceOpDataEntry vpnInstanceOpDataEntry = getVpnInstanceOpData(vpnRd);
1766 if (vpnInstanceOpDataEntry == null) {
1767 LOG.error("getVpnsImportingMyRoute: Could not retrieve vpn instance op data for {}"
1768 + " to check for vpns importing the routes", vpnName);
1769 return vpnsToImportRoute;
1771 Predicate<VpnInstanceOpDataEntry> excludeVpn = input -> {
1772 if (input.getVpnInstanceName() == null) {
1773 LOG.error("getVpnsImportingMyRoute.excludeVpn: Received vpn instance with rd {} without a name.",
1777 return !input.getVpnInstanceName().equals(vpnName);
1779 Predicate<VpnInstanceOpDataEntry> matchRTs = input -> {
1780 Iterable<String> commonRTs =
1781 intersection(getRts(vpnInstanceOpDataEntry, VpnTarget.VrfRTType.ExportExtcommunity),
1782 getRts(input, VpnTarget.VrfRTType.ImportExtcommunity));
1783 return Iterators.size(commonRTs.iterator()) > 0;
1785 vpnsToImportRoute = getAllVpnInstanceOpData().stream().filter(excludeVpn).filter(matchRTs)
1786 .collect(Collectors.toList());
1787 return vpnsToImportRoute;
1790 static List<String> getRts(VpnInstanceOpDataEntry vpnInstance, VpnTarget.VrfRTType rtType) {
1791 String name = vpnInstance.getVpnInstanceName();
1792 List<String> rts = new ArrayList<>();
1793 VpnTargets targets = vpnInstance.getVpnTargets();
1794 if (targets == null) {
1795 LOG.debug("getRts: vpn targets not available for {}", name);
1798 List<VpnTarget> vpnTargets = targets.getVpnTarget();
1799 if (vpnTargets == null) {
1800 LOG.debug("getRts: vpnTarget values not available for {}", name);
1803 for (VpnTarget target : vpnTargets) {
1804 //TODO: Check for RT type is Both
1805 if (target.getVrfRTType().equals(rtType) || target.getVrfRTType().equals(VpnTarget.VrfRTType.Both)) {
1806 String rtValue = target.getVrfRTValue();
1813 static <T> Iterable<T> intersection(final Collection<T> collection1, final Collection<T> collection2) {
1814 Set<T> intersection = new HashSet<>(collection1);
1815 intersection.retainAll(collection2);
1816 return intersection;
1819 /** Get Subnetmap from its Uuid.
1820 * @param subnetUuid the subnet's Uuid
1821 * @return the Subnetmap of Uuid or null if it is not found
1824 public Subnetmap getSubnetmapFromItsUuid(Uuid subnetUuid) {
1825 InstanceIdentifier<Subnetmap> id = buildSubnetmapIdentifier(subnetUuid);
1826 return read(LogicalDatastoreType.CONFIGURATION, id).orNull();
1829 boolean isAdjacencyEligibleToVpnInternet(Adjacency adjacency) {
1830 // returns true if BGPVPN Internet and adjacency is IPv6, false otherwise
1831 boolean adjacencyEligible = false;
1832 IpVersionChoice ipVerChoice = getIpVersionFromString(adjacency.getIpAddress());
1833 if (ipVerChoice.isIpVersionChosen(IpVersionChoice.IPV6)) {
1834 Subnetmap sn = getSubnetmapFromItsUuid(adjacency.getSubnetId());
1835 if (sn != null && sn.getInternetVpnId() != null) {
1836 adjacencyEligible = true;
1839 return adjacencyEligible;
1842 boolean isAdjacencyEligibleToVpn(Adjacency adjacency, String vpnName) {
1843 // returns true if BGPVPN Internet and adjacency is IPv6, false otherwise
1844 boolean adjacencyEligible = true;
1845 // if BGPVPN internet, return false if subnetmap has not internetVpnId() filled in
1846 if (isBgpVpnInternet(vpnName)) {
1847 return isAdjacencyEligibleToVpnInternet(adjacency);
1849 return adjacencyEligible;
1853 String getInternetVpnFromVpnInstanceList(List<VpnInstanceNames> vpnInstanceList) {
1854 for (VpnInstanceNames vpnInstance : vpnInstanceList) {
1855 String vpnName = vpnInstance.getVpnName();
1856 if (isBgpVpnInternet(vpnName)) {
1863 /** Get boolean true if vpn is bgpvpn internet, false otherwise.
1864 * @param vpnName name of the input VPN
1865 * @return true or false
1867 boolean isBgpVpnInternet(String vpnName) {
1868 String primaryRd = getVpnRd(vpnName);
1869 if (primaryRd == null) {
1870 LOG.error("isBgpVpnInternet VPN {}."
1871 + "Primary RD not found", vpnName);
1874 InstanceIdentifier<VpnInstanceOpDataEntry> id = InstanceIdentifier.builder(VpnInstanceOpData.class)
1875 .child(VpnInstanceOpDataEntry.class, new VpnInstanceOpDataEntryKey(primaryRd)).build();
1877 Optional<VpnInstanceOpDataEntry> vpnInstanceOpDataEntryOptional = read(LogicalDatastoreType.OPERATIONAL, id);
1878 if (!vpnInstanceOpDataEntryOptional.isPresent()) {
1879 LOG.error("isBgpVpnInternet VPN {}."
1880 + "VpnInstanceOpDataEntry not found", vpnName);
1883 LOG.debug("isBgpVpnInternet VPN {}."
1884 + "Successfully VpnInstanceOpDataEntry.getBgpvpnType {}",
1885 vpnName, vpnInstanceOpDataEntryOptional.get().getBgpvpnType());
1886 if (vpnInstanceOpDataEntryOptional.get().getBgpvpnType() == VpnInstanceOpDataEntry
1887 .BgpvpnType.BGPVPNInternet) {
1893 /**Get IpVersionChoice from String IP like x.x.x.x or an representation IPv6.
1894 * @param ipAddress String of an representation IP address V4 or V6
1895 * @return the IpVersionChoice of the version or IpVersionChoice.UNDEFINED otherwise
1897 public static IpVersionChoice getIpVersionFromString(String ipAddress) {
1898 int indexIpAddress = ipAddress.indexOf('/');
1899 if (indexIpAddress >= 0) {
1900 ipAddress = ipAddress.substring(0, indexIpAddress);
1903 InetAddress address = InetAddress.getByName(ipAddress);
1904 if (address instanceof Inet4Address) {
1905 return IpVersionChoice.IPV4;
1906 } else if (address instanceof Inet6Address) {
1907 return IpVersionChoice.IPV6;
1909 } catch (UnknownHostException | SecurityException e) {
1910 return IpVersionChoice.UNDEFINED;
1912 return IpVersionChoice.UNDEFINED;
1915 ListenableFuture<Void> unsetScheduledToRemoveForVpnInterface(String interfaceName) {
1916 VpnInterfaceBuilder builder = new VpnInterfaceBuilder().withKey(new VpnInterfaceKey(interfaceName));
1917 return txRunner.callWithNewWriteOnlyTransactionAndSubmit(OPERATIONAL, tx -> tx.merge(
1918 VpnUtil.getVpnInterfaceIdentifier(interfaceName), builder.build(),
1919 WriteTransaction.CREATE_MISSING_PARENTS));
1923 * Adds router port for all elan network of type VLAN which is a part of vpnName in the DPN with dpnId.
1924 * This will create the vlan footprint in the DPN's which are member of the VPN.
1926 * @param vpnName the vpnName
1927 * @param dpnId the DPN id
1929 void addRouterPortToElanForVlanInDpn(String vpnName, Uint64 dpnId) {
1930 Map<String,String> elanInstanceRouterPortMap = getElanInstanceRouterPortMap(vpnName);
1931 for (Entry<String, String> elanInstanceRouterEntry : elanInstanceRouterPortMap.entrySet()) {
1932 addRouterPortToElanDpn(elanInstanceRouterEntry.getKey(), elanInstanceRouterEntry.getValue(), dpnId);
1937 * Removes router port for all elan network of type VLAN which is a part of vpnName in the DPN with dpnId.
1938 * This will remove the vlan footprint in all the DPN's which are member of the VPN.
1940 * @param vpnName the vpn name
1941 * @param dpnId the DPN id
1943 void removeRouterPortFromElanForVlanInDpn(String vpnName, Uint64 dpnId) {
1944 Map<String,String> elanInstanceRouterPortMap = getElanInstanceRouterPortMap(vpnName);
1945 for (Entry<String, String> elanInstanceRouterEntry : elanInstanceRouterPortMap.entrySet()) {
1946 removeRouterPortFromElanDpn(elanInstanceRouterEntry.getKey(), elanInstanceRouterEntry.getValue(),
1952 * Adds router port for all elan network of type VLAN which is a part of vpnName in all the DPN which has a port
1953 * This will create the vlan footprint in all the DPN's which are member of the VPN.
1955 * @param vpnName the vpn name
1957 void addRouterPortToElanDpnListForVlaninAllDpn(String vpnName) {
1958 Map<String,String> elanInstanceRouterPortMap = getElanInstanceRouterPortMap(vpnName);
1959 Set<Uint64> dpnList = getDpnInElan(elanInstanceRouterPortMap);
1960 for (Uint64 dpnId : dpnList) {
1961 for (Entry<String, String> elanInstanceRouterEntry : elanInstanceRouterPortMap.entrySet()) {
1962 addRouterPortToElanDpn(elanInstanceRouterEntry.getKey(), elanInstanceRouterEntry.getValue(), dpnId);
1967 /**Removes router port for all elan network of type VLAN which is a part of vpnName in all the DPN which has a port
1968 * This will remove the vlan footprint in all the DPN's which are member of the VPN.
1970 * @param routerInterfacePortId this will add the current subnet router port id to the map for removal
1971 * @param elanInstanceName the current elanstance being removed this will be added to map for removal
1972 * @param vpnName the vpn name
1974 void removeRouterPortFromElanDpnListForVlanInAllDpn(String elanInstanceName,
1975 String routerInterfacePortId, String vpnName) {
1976 Map<String,String> elanInstanceRouterPortMap = getElanInstanceRouterPortMap(vpnName);
1977 elanInstanceRouterPortMap.put(elanInstanceName, routerInterfacePortId);
1978 Set<Uint64> dpnList = getDpnInElan(elanInstanceRouterPortMap);
1979 for (Uint64 dpnId : dpnList) {
1980 for (Entry<String, String> elanInstanceRouterEntry : elanInstanceRouterPortMap.entrySet()) {
1981 removeRouterPortFromElanDpn(elanInstanceRouterEntry.getKey(), elanInstanceRouterEntry.getValue(),
1988 Set<Uint64> getDpnInElan(Map<String,String> elanInstanceRouterPortMap) {
1989 Set<Uint64> dpnIdSet = new HashSet<>();
1990 for (String elanInstanceName : elanInstanceRouterPortMap.keySet()) {
1991 InstanceIdentifier<ElanDpnInterfacesList> elanDpnInterfaceId = getElanDpnOperationalDataPath(
1993 Optional<ElanDpnInterfacesList> dpnInElanInterfaces = read(LogicalDatastoreType.OPERATIONAL,
1994 elanDpnInterfaceId);
1995 if (dpnInElanInterfaces.isPresent()) {
1996 List<DpnInterfaces> dpnInterfaces = dpnInElanInterfaces.get().nonnullDpnInterfaces();
1997 for (DpnInterfaces dpnInterface : dpnInterfaces) {
1998 dpnIdSet.add(dpnInterface.getDpId());
2005 void addRouterPortToElanDpn(String elanInstanceName, String routerInterfacePortId, Uint64 dpnId) {
2006 InstanceIdentifier<DpnInterfaces> elanDpnInterfaceId = getElanDpnInterfaceOperationalDataPath(
2007 elanInstanceName,dpnId);
2008 final ReentrantLock lock = JvmGlobalLocks.getLockForString(elanInstanceName);
2011 Optional<DpnInterfaces> dpnInElanInterfaces = read(LogicalDatastoreType.OPERATIONAL, elanDpnInterfaceId);
2012 List<String> elanInterfaceList = new ArrayList<>();
2013 DpnInterfaces dpnInterface;
2014 if (!dpnInElanInterfaces.isPresent()) {
2015 elanInterfaceList = new ArrayList<>();
2017 dpnInterface = dpnInElanInterfaces.get();
2018 elanInterfaceList = (dpnInterface.getInterfaces() != null && !dpnInterface.getInterfaces().isEmpty())
2019 ? new ArrayList<>(dpnInterface.getInterfaces()) : elanInterfaceList;
2021 if (!elanInterfaceList.contains(routerInterfacePortId)) {
2022 elanInterfaceList.add(routerInterfacePortId);
2023 dpnInterface = new DpnInterfacesBuilder().setDpId(dpnId).setInterfaces(elanInterfaceList)
2024 .withKey(new DpnInterfacesKey(dpnId)).build();
2025 syncWrite(LogicalDatastoreType.OPERATIONAL, elanDpnInterfaceId, dpnInterface);
2032 void removeRouterPortFromElanDpn(String elanInstanceName, String routerInterfacePortId,
2033 String vpnName, Uint64 dpnId) {
2034 InstanceIdentifier<DpnInterfaces> elanDpnInterfaceId = getElanDpnInterfaceOperationalDataPath(
2035 elanInstanceName,dpnId);
2036 final ReentrantLock lock = JvmGlobalLocks.getLockForString(elanInstanceName);
2039 Optional<DpnInterfaces> dpnInElanInterfaces = read(LogicalDatastoreType.OPERATIONAL, elanDpnInterfaceId);
2040 List<String> elanInterfaceList = new ArrayList<>();
2041 DpnInterfaces dpnInterface;
2042 if (!dpnInElanInterfaces.isPresent()) {
2043 LOG.info("No interface in any dpn for {}", vpnName);
2046 dpnInterface = dpnInElanInterfaces.get();
2047 elanInterfaceList = (dpnInterface.getInterfaces() != null && !dpnInterface.getInterfaces().isEmpty())
2048 ? new ArrayList<>(dpnInterface.getInterfaces()) : elanInterfaceList;
2050 if (!elanInterfaceList.contains(routerInterfacePortId)) {
2051 LOG.info("Router port not present in DPN {} for VPN {}", dpnId, vpnName);
2054 elanInterfaceList.remove(routerInterfacePortId);
2055 dpnInterface = new DpnInterfacesBuilder().setDpId(dpnId).setInterfaces(elanInterfaceList)
2056 .withKey(new DpnInterfacesKey(dpnId)).build();
2057 syncWrite(LogicalDatastoreType.OPERATIONAL, elanDpnInterfaceId, dpnInterface);
2065 ElanInterface getElanInterfaceByElanInterfaceName(String elanInterfaceName) {
2066 InstanceIdentifier<ElanInterface> elanInterfaceId = getElanInterfaceConfigurationDataPathId(elanInterfaceName);
2067 return read(LogicalDatastoreType.CONFIGURATION, elanInterfaceId).orNull();
2070 static InstanceIdentifier<ElanInterface> getElanInterfaceConfigurationDataPathId(String interfaceName) {
2071 return InstanceIdentifier.builder(ElanInterfaces.class)
2072 .child(ElanInterface.class, new ElanInterfaceKey(interfaceName)).build();
2076 DpnInterfaces getElanInterfaceInfoByElanDpn(String elanInstanceName, Uint64 dpId) {
2077 InstanceIdentifier<DpnInterfaces> elanDpnInterfacesId = getElanDpnInterfaceOperationalDataPath(elanInstanceName,
2079 return read(LogicalDatastoreType.OPERATIONAL, elanDpnInterfacesId).orNull();
2083 String getExternalElanInterface(String elanInstanceName, Uint64 dpnId) {
2084 DpnInterfaces dpnInterfaces = getElanInterfaceInfoByElanDpn(elanInstanceName, dpnId);
2085 if (dpnInterfaces == null || dpnInterfaces.getInterfaces() == null) {
2086 LOG.info("Elan {} does not have interfaces in DPN {}", elanInstanceName, dpnId);
2090 for (String dpnInterface : dpnInterfaces.getInterfaces()) {
2091 if (interfaceManager.isExternalInterface(dpnInterface)) {
2092 return dpnInterface;
2098 static boolean isVlan(ElanInstance elanInstance) {
2099 return elanInstance != null && elanInstance.getSegmentType() != null
2100 && elanInstance.getSegmentType().isAssignableFrom(SegmentTypeVlan.class)
2101 && elanInstance.getSegmentationId() != null && elanInstance.getSegmentationId().toJava() != 0;
2104 boolean isVlan(String interfaceName) {
2105 ElanInterface elanInterface = getElanInterfaceByElanInterfaceName(interfaceName);
2106 if (elanInterface == null) {
2109 ElanInstance elanInstance = getElanInstanceByName(elanInterface.getElanInstanceName());
2110 return isVlan(elanInstance);
2114 ElanInstance getElanInstanceByName(String elanInstanceName) {
2115 InstanceIdentifier<ElanInstance> elanIdentifierId =
2116 ElanHelper.getElanInstanceConfigurationDataPath(elanInstanceName);
2117 return read(LogicalDatastoreType.CONFIGURATION, elanIdentifierId).orNull();
2121 String getVpnNameFromElanIntanceName(String elanInstanceName) {
2122 Optional<Subnetmaps> subnetMapsData = read(LogicalDatastoreType.CONFIGURATION, buildSubnetMapsWildCardPath());
2123 if (subnetMapsData.isPresent()) {
2124 List<Subnetmap> subnetMapList = subnetMapsData.get().getSubnetmap();
2125 if (subnetMapList != null && !subnetMapList.isEmpty()) {
2126 for (Subnetmap subnet : subnetMapList) {
2127 if (subnet.getNetworkId().getValue().equals(elanInstanceName)) {
2128 if (subnet.getVpnId() != null) {
2129 return subnet.getVpnId().getValue();
2138 Map<String, String> getElanInstanceRouterPortMap(String vpnName) {
2139 Map<String, String> elanInstanceRouterPortMap = new HashMap<>();
2140 Optional<Subnetmaps> subnetMapsData = read(LogicalDatastoreType.CONFIGURATION, buildSubnetMapsWildCardPath());
2141 if (subnetMapsData.isPresent()) {
2142 List<Subnetmap> subnetMapList = new ArrayList<>();
2143 Subnetmaps subnetMaps = subnetMapsData.get();
2144 subnetMapList = (subnetMaps.getSubnetmap() != null && !subnetMaps.getSubnetmap().isEmpty())
2145 ? new ArrayList<>(subnetMaps.getSubnetmap()) : subnetMapList;
2147 if (subnetMapList != null && !subnetMapList.isEmpty()) {
2148 for (Subnetmap subnet : subnetMapList) {
2149 if (subnet.getVpnId() != null && subnet.getVpnId().getValue().equals(vpnName)
2150 && NetworkType.VLAN.equals(subnet.getNetworkType())) {
2151 if (subnet.getRouterInterfacePortId() == null || subnet.getNetworkId() == null) {
2152 LOG.warn("The RouterInterfacePortId or NetworkId is null");
2155 String routerInterfacePortUuid = subnet.getRouterInterfacePortId().getValue();
2156 if (routerInterfacePortUuid != null && !routerInterfacePortUuid.isEmpty()) {
2157 elanInstanceRouterPortMap.put(subnet.getNetworkId().getValue(),routerInterfacePortUuid);
2163 return elanInstanceRouterPortMap;
2167 String getRouterPordIdFromElanInstance(String elanInstanceName) {
2168 Optional<Subnetmaps> subnetMapsData = read(LogicalDatastoreType.CONFIGURATION, buildSubnetMapsWildCardPath());
2169 if (subnetMapsData.isPresent()) {
2170 List<Subnetmap> subnetMapList = subnetMapsData.get().getSubnetmap();
2171 if (subnetMapList != null && !subnetMapList.isEmpty()) {
2172 for (Subnetmap subnet : subnetMapList) {
2173 if (subnet.getNetworkId().getValue().equals(elanInstanceName)) {
2174 if (subnet.getRouterInterfacePortId() != null) {
2175 return subnet.getRouterInterfacePortId().getValue();
2184 boolean shouldPopulateFibForVlan(String vpnName, @Nullable String elanInstanceName, Uint64 dpnId) {
2185 Map<String,String> elanInstanceRouterPortMap = getElanInstanceRouterPortMap(vpnName);
2186 boolean shouldPopulateFibForVlan = false;
2187 if (!elanInstanceRouterPortMap.isEmpty()) {
2188 shouldPopulateFibForVlan = true;
2190 for (Entry<String, String> elanInstanceRouterEntry : elanInstanceRouterPortMap
2192 String currentElanInstance = elanInstanceRouterEntry.getKey();
2193 if (elanInstanceName != null && elanInstanceName.equals(currentElanInstance)) {
2196 String externalinterface = getExternalElanInterface(currentElanInstance ,dpnId);
2197 if (externalinterface == null) {
2198 shouldPopulateFibForVlan = false;
2202 return shouldPopulateFibForVlan;
2205 public static InstanceIdentifier<DpnInterfaces> getElanDpnInterfaceOperationalDataPath(String elanInstanceName,
2207 return InstanceIdentifier.builder(ElanDpnInterfaces.class)
2208 .child(ElanDpnInterfacesList.class, new ElanDpnInterfacesListKey(elanInstanceName))
2209 .child(DpnInterfaces.class, new DpnInterfacesKey(dpId)).build();
2212 public static InstanceIdentifier<ElanDpnInterfacesList> getElanDpnOperationalDataPath(String elanInstanceName) {
2213 return InstanceIdentifier.builder(ElanDpnInterfaces.class)
2214 .child(ElanDpnInterfacesList.class, new ElanDpnInterfacesListKey(elanInstanceName))
2218 public static boolean isMatchedPrefixToInterface(Prefixes prefix, VpnInterfaceOpDataEntry vpnInterface) {
2219 if (prefix != null && vpnInterface != null) {
2220 if (prefix.getDpnId() != null && vpnInterface.getDpnId() != null) {
2221 if (prefix.getVpnInterfaceName() != null && vpnInterface.getName() != null) {
2222 return prefix.getDpnId().equals(vpnInterface.getDpnId())
2223 && prefix.getVpnInterfaceName().equalsIgnoreCase(vpnInterface.getName());
2230 public static void sendNeighborSolicationToOfGroup(Ipv6NdUtilService ipv6NdUtilService, Ipv6Address srcIpv6Address,
2231 MacAddress srcMac, Ipv6Address dstIpv6Address, Long ofGroupId, Uint64 dpId) {
2232 SendNeighborSolicitationToOfGroupInput input = new SendNeighborSolicitationToOfGroupInputBuilder()
2233 .setSourceIpv6(srcIpv6Address).setSourceLlAddress(srcMac).setTargetIpAddress(dstIpv6Address)
2234 .setOfGroupId(ofGroupId).setDpId(dpId).build();
2236 Future<RpcResult<SendNeighborSolicitationToOfGroupOutput>> result = ipv6NdUtilService
2237 .sendNeighborSolicitationToOfGroup(input);
2238 RpcResult<SendNeighborSolicitationToOfGroupOutput> rpcResult = result.get();
2239 if (!rpcResult.isSuccessful()) {
2240 LOG.error("sendNeighborSolicitationToOfGroup: RPC Call failed for input={} and Errors={}", input,
2241 rpcResult.getErrors());
2243 } catch (InterruptedException | ExecutionException e) {
2244 LOG.error("Failed to send NS packet to ELAN group, input={}", input, e);
2248 Set<org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.af.config.vpntargets.VpnTarget>
2249 getRtListForVpn(String vpnName) {
2250 Set<org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.af.config.vpntargets
2251 .VpnTarget> rtList = new HashSet<>();
2252 InstanceIdentifier<VpnInstance> vpnInstanceId = InstanceIdentifier.builder(VpnInstances.class)
2253 .child(VpnInstance.class, new VpnInstanceKey(vpnName)).build();
2254 Optional<VpnInstance> vpnInstanceOptional = read(LogicalDatastoreType.CONFIGURATION, vpnInstanceId);
2255 if (vpnInstanceOptional.isPresent()) {
2256 org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.af.config.VpnTargets
2257 vpnTargets = vpnInstanceOptional.get().getIpv4Family().getVpnTargets();
2258 if (vpnTargets != null && vpnTargets.getVpnTarget() != null) {
2259 rtList.addAll(vpnTargets.getVpnTarget());
2263 LOG.error("getRtListForVpn: Vpn Instance {} not present in config DS", vpnName);
2268 static InstanceIdentifier<AssociatedVpn> getAssociatedSubnetAndVpnIdentifier(String rt, RouteTarget.RtType rtType,
2269 String cidr, String vpnName) {
2270 return InstanceIdentifier.builder(SubnetsAssociatedToRouteTargets.class).child(RouteTarget.class,
2271 new RouteTargetKey(rt, rtType)).child(AssociatedSubnet.class, new AssociatedSubnetKey(cidr))
2272 .child(AssociatedVpn.class, new AssociatedVpnKey(vpnName)).build();
2275 static InstanceIdentifier<AssociatedSubnet> getAssociatedSubnetIdentifier(String rt, RouteTarget.RtType rtType,
2277 return InstanceIdentifier.builder(SubnetsAssociatedToRouteTargets.class).child(RouteTarget.class,
2278 new RouteTargetKey(rt, rtType)).child(AssociatedSubnet.class, new AssociatedSubnetKey(cidr)).build();
2281 static AssociatedVpn buildAssociatedSubnetAndVpn(String vpnName) {
2282 return new AssociatedVpnBuilder().setName(vpnName).build();
2285 static InstanceIdentifier<RouteTarget> getRouteTargetsIdentifier(String rt, RouteTarget.RtType rtType) {
2286 return InstanceIdentifier.builder(SubnetsAssociatedToRouteTargets.class)
2287 .child(RouteTarget.class, new RouteTargetKey(rt, rtType)).build();
2290 Set<RouteTarget> getRouteTargetSet(Set<org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815
2291 .vpn.af.config.vpntargets.VpnTarget> vpnTargets) {
2292 Set<RouteTarget> routeTargetSet = new HashSet<>();
2293 for (org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.af.config.vpntargets
2294 .VpnTarget rt : vpnTargets) {
2295 String rtValue = rt.getVrfRTValue();
2296 switch (rt.getVrfRTType()) {
2297 case ImportExtcommunity: {
2298 Optional<RouteTarget> exportRouteTargetOptional = read(LogicalDatastoreType.OPERATIONAL,
2299 getRouteTargetsIdentifier(rtValue, RouteTarget.RtType.ERT));
2300 if (exportRouteTargetOptional.isPresent()) {
2301 routeTargetSet.add(exportRouteTargetOptional.get());
2305 case ExportExtcommunity: {
2306 Optional<RouteTarget> importRouteTargetOptional = read(LogicalDatastoreType.OPERATIONAL,
2307 getRouteTargetsIdentifier(rtValue, RouteTarget.RtType.IRT));
2308 if (importRouteTargetOptional.isPresent()) {
2309 routeTargetSet.add(importRouteTargetOptional.get());
2314 Optional<RouteTarget> exportRouteTargetOptional = read(LogicalDatastoreType.OPERATIONAL,
2315 getRouteTargetsIdentifier(rtValue, RouteTarget.RtType.ERT));
2316 if (exportRouteTargetOptional.isPresent()) {
2317 routeTargetSet.add(exportRouteTargetOptional.get());
2319 Optional<RouteTarget> importRouteTargetOptional = read(LogicalDatastoreType.OPERATIONAL,
2320 getRouteTargetsIdentifier(rtValue, RouteTarget.RtType.IRT));
2321 if (importRouteTargetOptional.isPresent()) {
2322 routeTargetSet.add(importRouteTargetOptional.get());
2327 LOG.error("getRouteTargetSet: Invalid rt-type {}", rt.getVrfRTType());
2330 return routeTargetSet;
2334 TODO: (vivek/kiran): Subnet overlap in a VPN detection logic should use subnet allocation pools if available
2335 rather than only CIDR.
2336 Also the Subnet overlap in a VPN detection logic to be addressed for router-based-l3vpns.
2338 static boolean areSubnetsOverlapping(String cidr1, String cidr2) {
2339 final int slash1 = cidr1.indexOf('/');
2340 final int address1 = addressForCidr(cidr1, slash1);
2341 final int cidrPart1 = maskForCidr(cidr1, slash1);
2343 final int slash2 = cidr2.indexOf('/');
2344 final int address2 = addressForCidr(cidr2, slash2);
2345 final int cidrPart2 = maskForCidr(cidr2, slash2);
2347 final int comparedValue = cidrPart1 <= cidrPart2 ? compare(address1, cidrPart1, address2)
2348 : compare(address2, cidrPart2, address1);
2349 return comparedValue == 0;
2352 private static int addressForCidr(String cidr, int slash) {
2353 return InetAddresses.coerceToInteger(InetAddresses.forString(cidr.substring(0, slash)));
2356 private static int maskForCidr(String cidr, int slash) {
2357 return Integer.parseInt(cidr.substring(slash + 1));
2360 private static int compare(int address, int cidrPart, int address2) {
2361 int prefix = address2 & computeNetmask(cidrPart);
2362 return address ^ prefix;
2365 private static int computeNetmask(int cidrPart) {
2367 for (int j = 0; j < cidrPart; ++j) {
2368 netmask |= 1 << 31 - j;
2373 public static String buildIpMonitorJobKey(String ip, String vpnName) {
2374 return VpnConstants.IP_MONITOR_JOB_PREFIX_KEY + "-" + vpnName + "-" + ip;
2377 public static List<String> getVpnListForVpnInterface(VpnInterface vpnInter) {
2378 return vpnInter.nonnullVpnInstanceNames().stream()
2379 .map(VpnInstanceNames::getVpnName).collect(Collectors.toList());
2382 public void updateVpnInstanceWithRdList(String vpnName, List<String> updatedRdList) {
2383 String primaryRd = getVpnRd(vpnName);
2384 if (primaryRd == null) {
2385 LOG.warn("updateVpnInstanceWithRdList: Unable to retrieve primary RD for the VPN {}. Skip to process "
2386 + "the updated RD list {} ", vpnName, updatedRdList);
2389 jobCoordinator.enqueueJob("VPN-" + vpnName, () -> {
2390 VpnInstanceOpDataEntryBuilder builder = new VpnInstanceOpDataEntryBuilder().setVrfId(primaryRd);
2391 builder.setRd(updatedRdList);
2392 return Collections.singletonList(txRunner.callWithNewWriteOnlyTransactionAndSubmit(
2393 OPERATIONAL, tx -> {
2394 InstanceIdentifier<VpnInstanceOpDataEntry> id = InstanceIdentifier
2395 .builder(VpnInstanceOpData.class).child(VpnInstanceOpDataEntry.class,
2396 new VpnInstanceOpDataEntryKey(primaryRd)).build();
2397 tx.merge(id, builder.build(), false);
2398 LOG.debug("updateVpnInstanceWithRdList: Successfully updated the VPN {} with list of RDs {}",
2399 vpnName, updatedRdList);
2404 public static RouteOrigin getRouteOrigin(AdjacencyType adjacencyType) {
2405 RouteOrigin origin = RouteOrigin.LOCAL;
2406 switch (adjacencyType) {
2407 case PrimaryAdjacency:
2408 origin = RouteOrigin.LOCAL;
2411 origin = RouteOrigin.STATIC;
2414 origin = RouteOrigin.DYNAMIC;
2417 LOG.warn("Unknown adjacencyType={}", adjacencyType);
2422 public static boolean isDualRouterVpnUpdate(List<String> oldVpnListCopy, List<String> newVpnListCopy) {
2423 return oldVpnListCopy.size() == 2 && newVpnListCopy.size() == 3
2424 || oldVpnListCopy.size() == 3 && newVpnListCopy.size() == 2;
2427 // TODO Clean up the exception handling
2428 @SuppressWarnings("checkstyle:IllegalCatch")
2429 public void createVpnPortFixedIpToPort(String vpnName, String fixedIp,
2430 String portName, boolean isLearntIp, String macAddress,
2431 WriteTransaction writeConfigTxn) {
2432 InstanceIdentifier<VpnPortipToPort> id = buildVpnPortipToPortIdentifier(vpnName, fixedIp);
2433 VpnPortipToPortBuilder builder = new VpnPortipToPortBuilder().withKey(new VpnPortipToPortKey(fixedIp, vpnName))
2434 .setVpnName(vpnName).setPortFixedip(fixedIp).setPortName(portName)
2435 .setLearntIp(isLearntIp).setSubnetIp(false).setMacAddress(macAddress.toLowerCase(Locale.getDefault()));
2437 if (writeConfigTxn != null) {
2438 writeConfigTxn.put(LogicalDatastoreType.CONFIGURATION, id, builder.build());
2440 syncWrite(LogicalDatastoreType.CONFIGURATION, id, builder.build());
2442 LOG.trace("Port with Ip: {}, vpn {}, interface {}, learntIp {} added to VpnPortipToPort DS",
2443 fixedIp, vpnName, portName, isLearntIp);
2444 } catch (Exception e) {
2445 LOG.error("Failure while creating VpnPortIpToPort map for vpn {} learnIp{}", vpnName, fixedIp, e);
2449 protected VpnPortipToPort getVpnPortipToPort(String vpnName, String fixedIp) {
2450 InstanceIdentifier<VpnPortipToPort> id = buildVpnPortipToPortIdentifier(vpnName, fixedIp);
2451 Optional<VpnPortipToPort> vpnPortipToPortData = read(LogicalDatastoreType.CONFIGURATION, id);
2452 if (vpnPortipToPortData.isPresent()) {
2453 return vpnPortipToPortData.get();
2455 LOG.error("getVpnPortipToPort: Failed as vpnPortipToPortData DS is absent for VPN {} and fixed IP {}",
2460 public static void enableArpLearning(Boolean isArpLearningEnabled) {
2461 arpLearningEnabled = isArpLearningEnabled;
2464 public static Boolean isArpLearningEnabled() {
2465 return arpLearningEnabled;
2468 private static ReentrantLock lockFor(String vpnName, String fixedIp) {
2469 // FIXME: is there some identifier we can use? LearntVpnVipToPortKey perhaps?
2470 return JvmGlobalLocks.getLockForString(vpnName + fixedIp);