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.collect.Iterators;
15 import com.google.common.net.InetAddresses;
16 import com.google.common.util.concurrent.FutureCallback;
17 import com.google.common.util.concurrent.ListenableFuture;
18 import java.math.BigInteger;
19 import java.net.Inet4Address;
20 import java.net.Inet6Address;
21 import java.net.InetAddress;
22 import java.net.UnknownHostException;
23 import java.text.SimpleDateFormat;
24 import java.util.ArrayList;
25 import java.util.Collection;
26 import java.util.Collections;
27 import java.util.Date;
28 import java.util.HashMap;
29 import java.util.HashSet;
30 import java.util.List;
31 import java.util.Locale;
33 import java.util.Map.Entry;
34 import java.util.Objects;
35 import java.util.Optional;
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.genius.datastoreutils.SingleTransactionDataBroker;
46 import org.opendaylight.genius.infra.Datastore;
47 import org.opendaylight.genius.infra.Datastore.Configuration;
48 import org.opendaylight.genius.infra.Datastore.Operational;
49 import org.opendaylight.genius.infra.ManagedNewTransactionRunner;
50 import org.opendaylight.genius.infra.ManagedNewTransactionRunnerImpl;
51 import org.opendaylight.genius.infra.TypedReadTransaction;
52 import org.opendaylight.genius.infra.TypedReadWriteTransaction;
53 import org.opendaylight.genius.infra.TypedWriteTransaction;
54 import org.opendaylight.genius.interfacemanager.interfaces.IInterfaceManager;
55 import org.opendaylight.genius.mdsalutil.FlowEntity;
56 import org.opendaylight.genius.mdsalutil.FlowEntityBuilder;
57 import org.opendaylight.genius.mdsalutil.InstructionInfo;
58 import org.opendaylight.genius.mdsalutil.MDSALUtil;
59 import org.opendaylight.genius.mdsalutil.MatchInfo;
60 import org.opendaylight.genius.mdsalutil.MetaDataUtil;
61 import org.opendaylight.genius.mdsalutil.NWUtil;
62 import org.opendaylight.genius.mdsalutil.NwConstants;
63 import org.opendaylight.genius.mdsalutil.actions.ActionRegLoad;
64 import org.opendaylight.genius.mdsalutil.instructions.InstructionGotoTable;
65 import org.opendaylight.genius.mdsalutil.instructions.InstructionWriteMetadata;
66 import org.opendaylight.genius.mdsalutil.interfaces.IMdsalApiManager;
67 import org.opendaylight.genius.mdsalutil.matches.MatchEthernetDestination;
68 import org.opendaylight.genius.mdsalutil.matches.MatchEthernetType;
69 import org.opendaylight.genius.mdsalutil.matches.MatchMetadata;
70 import org.opendaylight.genius.utils.JvmGlobalLocks;
71 import org.opendaylight.genius.utils.ServiceIndex;
72 import org.opendaylight.genius.utils.SystemPropertyReader;
73 import org.opendaylight.infrautils.jobcoordinator.JobCoordinator;
74 import org.opendaylight.infrautils.utils.concurrent.LoggingFutures;
75 import org.opendaylight.mdsal.binding.api.DataBroker;
76 import org.opendaylight.mdsal.binding.api.WriteTransaction;
77 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
78 import org.opendaylight.mdsal.common.api.TransactionCommitFailedException;
79 import org.opendaylight.netvirt.bgpmanager.api.IBgpManager;
80 import org.opendaylight.netvirt.elanmanager.api.ElanHelper;
81 import org.opendaylight.netvirt.fibmanager.api.IFibManager;
82 import org.opendaylight.netvirt.fibmanager.api.RouteOrigin;
83 import org.opendaylight.netvirt.neutronvpn.api.enums.IpVersionChoice;
84 import org.opendaylight.netvirt.neutronvpn.interfaces.INeutronVpnManager;
85 import org.opendaylight.netvirt.vpnmanager.api.InterfaceUtils;
86 import org.opendaylight.netvirt.vpnmanager.api.VpnExtraRouteHelper;
87 import org.opendaylight.netvirt.vpnmanager.api.VpnHelper;
88 import org.opendaylight.netvirt.vpnmanager.iplearn.model.MacEntry;
89 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
90 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressBuilder;
91 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address;
92 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.Interfaces;
93 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
94 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
95 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress;
96 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid;
97 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.Action;
98 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction;
99 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdInput;
100 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdInputBuilder;
101 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.AllocateIdOutput;
102 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.IdManagerService;
103 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdInput;
104 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdInputBuilder;
105 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.idmanager.rev160406.ReleaseIdOutput;
106 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.IfIndexesInterfaceMap;
107 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406._if.indexes._interface.map.IfIndexInterface;
108 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406._if.indexes._interface.map.IfIndexInterfaceKey;
109 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.GetInterfaceFromIfIndexInput;
110 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.GetInterfaceFromIfIndexInputBuilder;
111 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.GetInterfaceFromIfIndexOutput;
112 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406.OdlInterfaceRpcService;
113 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.services.info.BoundServices;
114 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.ipv6.nd.util.rev170210.Ipv6NdUtilService;
115 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.ipv6.nd.util.rev170210.SendNeighborSolicitationToOfGroupInput;
116 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.ipv6.nd.util.rev170210.SendNeighborSolicitationToOfGroupInputBuilder;
117 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.ipv6.nd.util.rev170210.SendNeighborSolicitationToOfGroupOutput;
118 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.LockManagerService;
119 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.TimeUnits;
120 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.TryLockInput;
121 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.TryLockInputBuilder;
122 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.TryLockOutput;
123 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.UnlockInput;
124 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.UnlockInputBuilder;
125 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.UnlockOutput;
126 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.ElanDpnInterfaces;
127 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.ElanInterfaces;
128 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.ElanTagNameMap;
129 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.SegmentTypeVlan;
130 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.dpn.interfaces.ElanDpnInterfacesList;
131 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.dpn.interfaces.ElanDpnInterfacesListKey;
132 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.dpn.interfaces.elan.dpn.interfaces.list.DpnInterfaces;
133 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.dpn.interfaces.elan.dpn.interfaces.list.DpnInterfacesBuilder;
134 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.dpn.interfaces.elan.dpn.interfaces.list.DpnInterfacesKey;
135 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.instances.ElanInstance;
136 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.ElanInterface;
137 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.ElanInterfaceKey;
138 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.tag.name.map.ElanTagName;
139 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.tag.name.map.ElanTagNameKey;
140 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.FibEntries;
141 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.VrfEntryBase;
142 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.extraroute.rds.map.extraroute.rds.dest.prefixes.AllocatedRdsBuilder;
143 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.extraroute.rds.map.extraroute.rds.dest.prefixes.AllocatedRdsKey;
144 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.fibentries.VrfTables;
145 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.fibentries.VrfTablesKey;
146 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.vrfentries.VrfEntry;
147 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.vrfentries.VrfEntryKey;
148 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3nexthop.rev150409.L3nexthop;
149 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3nexthop.rev150409.l3nexthop.VpnNexthops;
150 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3nexthop.rev150409.l3nexthop.VpnNexthopsKey;
151 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.AdjacenciesOp;
152 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.AdjacenciesOpBuilder;
153 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.LearntVpnVipToPortData;
154 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.LearntVpnVipToPortEventAction;
155 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.LearntVpnVipToPortEventData;
156 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.PrefixToInterface;
157 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.SubnetOpData;
158 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.SubnetsAssociatedToRouteTargets;
159 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnIdToVpnInstance;
160 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnInstanceOpData;
161 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnInterfaceOpData;
162 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.VpnToExtraroutes;
163 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.data.LearntVpnVipToPort;
164 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.data.LearntVpnVipToPortBuilder;
165 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.data.LearntVpnVipToPortKey;
166 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.event.data.LearntVpnVipToPortEvent;
167 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.event.data.LearntVpnVipToPortEventBuilder;
168 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.learnt.vpn.vip.to.port.event.data.LearntVpnVipToPortEventKey;
169 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.prefix.to._interface.VpnIds;
170 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.prefix.to._interface.VpnIdsKey;
171 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.prefix.to._interface.vpn.ids.Prefixes;
172 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.prefix.to._interface.vpn.ids.PrefixesBuilder;
173 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.prefix.to._interface.vpn.ids.PrefixesKey;
174 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.subnet.op.data.SubnetOpDataEntry;
175 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.subnet.op.data.SubnetOpDataEntryKey;
176 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.subnets.associated.to.route.targets.RouteTarget;
177 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.subnets.associated.to.route.targets.RouteTargetKey;
178 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.subnets.associated.to.route.targets.route.target.AssociatedSubnet;
179 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.subnets.associated.to.route.targets.route.target.AssociatedSubnetKey;
180 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.subnets.associated.to.route.targets.route.target.associated.subnet.AssociatedVpn;
181 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.subnets.associated.to.route.targets.route.target.associated.subnet.AssociatedVpnBuilder;
182 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.subnets.associated.to.route.targets.route.target.associated.subnet.AssociatedVpnKey;
183 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn._interface.op.data.VpnInterfaceOpDataEntry;
184 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn._interface.op.data.VpnInterfaceOpDataEntryBuilder;
185 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn._interface.op.data.VpnInterfaceOpDataEntryKey;
186 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntry;
187 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntryBuilder;
188 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntryKey;
189 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.VpnTargets;
190 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.VpnToDpnList;
191 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.VpnToDpnListKey;
192 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.vpntargets.VpnTarget;
193 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.vpntargets.VpnTargetKey;
194 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstanceBuilder;
195 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.to.extraroutes.Vpn;
196 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.to.extraroutes.VpnKey;
197 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.to.extraroutes.vpn.extra.routes.Routes;
198 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.to.extraroutes.vpn.extra.routes.RoutesBuilder;
199 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ExtRouters;
200 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ExternalNetworks;
201 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ExternalSubnets;
202 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.NaptSwitches;
203 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext.routers.Routers;
204 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext.routers.RoutersKey;
205 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext.routers.routers.ExternalIps;
206 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext.routers.routers.ExternalIpsKey;
207 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.networks.Networks;
208 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.networks.NetworksKey;
209 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets.SubnetsKey;
210 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.napt.switches.RouterToNaptSwitch;
211 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.napt.switches.RouterToNaptSwitchKey;
212 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.Adjacencies;
213 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.AdjacenciesBuilder;
214 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.VpnInstances;
215 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.VpnInterfaces;
216 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.adjacency.list.Adjacency;
217 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.adjacency.list.Adjacency.AdjacencyType;
218 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.adjacency.list.AdjacencyKey;
219 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.vpn.instances.VpnInstance;
220 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.vpn.instances.VpnInstanceKey;
221 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.vpn.interfaces.VpnInterface;
222 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.vpn.interfaces.VpnInterfaceBuilder;
223 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.vpn.interfaces.VpnInterfaceKey;
224 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.vpn.interfaces.vpn._interface.VpnInstanceNames;
225 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.NetworkAttributes.NetworkType;
226 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.NetworkMaps;
227 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.NeutronVpnPortipPortData;
228 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.Subnetmaps;
229 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.networkmaps.NetworkMap;
230 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.networkmaps.NetworkMapKey;
231 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.neutron.vpn.portip.port.data.VpnPortipToPort;
232 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.neutron.vpn.portip.port.data.VpnPortipToPortBuilder;
233 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.neutron.vpn.portip.port.data.VpnPortipToPortKey;
234 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.subnetmaps.Subnetmap;
235 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.subnetmaps.SubnetmapKey;
236 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.constants.rev150712.IpVersionBase;
237 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.constants.rev150712.IpVersionV4;
238 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.ext.rev150712.NetworkL3Extension;
239 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.Network;
240 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.NetworkKey;
241 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.port.attributes.FixedIps;
242 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.ports.rev150712.ports.attributes.ports.Port;
243 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.rev150712.Neutron;
244 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.Subnets;
245 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.Subnet;
246 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.SubnetKey;
247 import org.opendaylight.yangtools.yang.binding.DataObject;
248 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
249 import org.opendaylight.yangtools.yang.common.RpcResult;
250 import org.opendaylight.yangtools.yang.common.Uint32;
251 import org.opendaylight.yangtools.yang.common.Uint64;
252 import org.opendaylight.yangtools.yang.data.api.schema.tree.ModifiedNodeDoesNotExistException;
253 import org.slf4j.Logger;
254 import org.slf4j.LoggerFactory;
257 public final class VpnUtil {
259 private static final Logger LOG = LoggerFactory.getLogger(VpnUtil.class);
261 public static final int SINGLE_TRANSACTION_BROKER_NO_RETRY = 1;
262 private static Boolean arpLearningEnabled = Boolean.TRUE;
264 private final DataBroker dataBroker;
265 private final IdManagerService idManager;
266 private final IFibManager fibManager;
267 private final IBgpManager bgpManager;
268 private final LockManagerService lockManager;
269 private final INeutronVpnManager neutronVpnService;
270 private final IMdsalApiManager mdsalManager;
271 private final IInterfaceManager interfaceManager;
272 private final JobCoordinator jobCoordinator;
273 private final ManagedNewTransactionRunner txRunner;
274 private final OdlInterfaceRpcService ifmRpcService;
277 * Class to generate timestamps with microsecond precision.
278 * For example: MicroTimestamp.INSTANCE.get() = "2012-10-21 19:13:45.267128"
280 public enum MicroTimestamp {
283 private long startDate ;
284 private long startNanoseconds ;
285 private SimpleDateFormat dateFormat ;
288 this.startDate = System.currentTimeMillis() ;
289 this.startNanoseconds = System.nanoTime() ;
290 this.dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss.SSS") ;
293 public String get() {
294 long microSeconds = (System.nanoTime() - this.startNanoseconds) / 1000 ;
295 long date = this.startDate + microSeconds / 1000 ;
296 return this.dateFormat.format(date) + String.format("%03d", microSeconds % 1000) ;
300 public VpnUtil(DataBroker dataBroker, IdManagerService idManager, IFibManager fibManager,
301 IBgpManager bgpManager, LockManagerService lockManager, INeutronVpnManager neutronVpnService,
302 IMdsalApiManager mdsalManager, JobCoordinator jobCoordinator, IInterfaceManager interfaceManager,
303 OdlInterfaceRpcService ifmRpcService) {
304 this.dataBroker = dataBroker;
305 this.idManager = idManager;
306 this.fibManager = fibManager;
307 this.bgpManager = bgpManager;
308 this.lockManager = lockManager;
309 this.neutronVpnService = neutronVpnService;
310 this.mdsalManager = mdsalManager;
311 this.interfaceManager = interfaceManager;
312 this.jobCoordinator = jobCoordinator;
313 this.txRunner = new ManagedNewTransactionRunnerImpl(dataBroker);
314 this.ifmRpcService = ifmRpcService;
317 public static InstanceIdentifier<VpnInterface> getVpnInterfaceIdentifier(String vpnInterfaceName) {
318 return InstanceIdentifier.builder(VpnInterfaces.class)
319 .child(VpnInterface.class, new VpnInterfaceKey(vpnInterfaceName)).build();
322 static InstanceIdentifier<VpnInterfaceOpDataEntry> getVpnInterfaceOpDataEntryIdentifier(String vpnInterfaceName,
324 return InstanceIdentifier.builder(VpnInterfaceOpData.class).child(VpnInterfaceOpDataEntry.class,
325 new VpnInterfaceOpDataEntryKey(vpnInterfaceName, vpnName)).build();
328 static InstanceIdentifier<VpnInstance> getVpnInstanceIdentifier(String vpnName) {
329 return InstanceIdentifier.builder(VpnInstances.class)
330 .child(VpnInstance.class, new VpnInstanceKey(vpnName)).build();
334 VpnInterface getVpnInterface(String vpnInterfaceName) {
335 InstanceIdentifier<VpnInterface> id = getVpnInterfaceIdentifier(vpnInterfaceName);
336 Optional<VpnInterface> vpnInterface = read(LogicalDatastoreType.CONFIGURATION, id);
337 return vpnInterface.isPresent() ? vpnInterface.get() : null;
340 static VpnInterfaceOpDataEntry getVpnInterfaceOpDataEntry(String intfName, String vpnName, AdjacenciesOp aug,
341 Uint64 dpnId, long lportTag,
342 String gwMac, String gwIp) {
343 return new VpnInterfaceOpDataEntryBuilder().withKey(new VpnInterfaceOpDataEntryKey(intfName, vpnName))
344 .setDpnId(dpnId).addAugmentation(AdjacenciesOp.class, aug)
345 .setLportTag(lportTag).setGatewayMacAddress(gwMac).setGatewayIpAddress(gwIp).build();
348 Optional<VpnInterfaceOpDataEntry> getVpnInterfaceOpDataEntry(String vpnInterfaceName, String vpnName) {
349 InstanceIdentifier<VpnInterfaceOpDataEntry> id = getVpnInterfaceOpDataEntryIdentifier(vpnInterfaceName,
351 Optional<VpnInterfaceOpDataEntry> vpnInterfaceOpDataEntry = read(LogicalDatastoreType.OPERATIONAL,
353 return vpnInterfaceOpDataEntry;
356 static InstanceIdentifier<Prefixes> getPrefixToInterfaceIdentifier(Uint32 vpnId, String ipPrefix) {
357 return InstanceIdentifier.builder(PrefixToInterface.class).child(VpnIds.class, new VpnIdsKey(vpnId))
358 .child(Prefixes.class, new PrefixesKey(ipPrefix)).build();
361 static InstanceIdentifier<VpnIds> getPrefixToInterfaceIdentifier(Uint32 vpnId) {
362 return InstanceIdentifier.builder(PrefixToInterface.class).child(VpnIds.class, new VpnIdsKey(vpnId)).build();
365 static Prefixes getPrefixToInterface(Uint64 dpId, String vpnInterfaceName, String ipPrefix,
366 Uuid networkId, NetworkType networkType, Long segmentationId, Prefixes.PrefixCue prefixCue) {
367 return new PrefixesBuilder().setDpnId(dpId).setVpnInterfaceName(
368 vpnInterfaceName).setIpAddress(ipPrefix)//.setSubnetId(subnetId)
369 .setNetworkId(networkId).setNetworkType(networkType).setSegmentationId(segmentationId)
370 .setPrefixCue(prefixCue).build();
373 static Prefixes getPrefixToInterface(Uint64 dpId, String vpnInterfaceName, String ipPrefix,
374 Prefixes.PrefixCue prefixCue) {
375 return new PrefixesBuilder().setDpnId(dpId).setVpnInterfaceName(vpnInterfaceName).setIpAddress(ipPrefix)
376 .setPrefixCue(prefixCue).build();
379 Optional<Prefixes> getPrefixToInterface(Uint32 vpnId, String ipPrefix) {
380 return read(LogicalDatastoreType.OPERATIONAL, getPrefixToInterfaceIdentifier(vpnId, getIpPrefix(ipPrefix)));
384 * Get VRF table given a Route Distinguisher.
386 * @param rd Route-Distinguisher
387 * @return VrfTables that holds the list of VrfEntries of the specified rd
390 VrfTables getVrfTable(String rd) {
391 InstanceIdentifier<VrfTables> id = InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class,
392 new VrfTablesKey(rd)).build();
393 Optional<VrfTables> vrfTable = read(LogicalDatastoreType.CONFIGURATION, id);
394 return vrfTable.isPresent() ? vrfTable.get() : null;
398 * Retrieves the VrfEntries that belong to a given VPN filtered out by
399 * Origin, searching by its Route-Distinguisher.
401 * @param rd Route-distinguisher of the VPN
402 * @param originsToConsider Only entries whose origin is included in this list will be considered
403 * @return the list of VrfEntries
405 public List<VrfEntry> getVrfEntriesByOrigin(String rd, List<RouteOrigin> originsToConsider) {
406 List<VrfEntry> result = new ArrayList<>();
407 List<VrfEntry> allVpnVrfEntries = getAllVrfEntries(rd);
408 for (VrfEntry vrfEntry : allVpnVrfEntries) {
409 if (originsToConsider.contains(RouteOrigin.value(vrfEntry.getOrigin()))) {
410 result.add(vrfEntry);
417 * Retrieves all the VrfEntries that belong to a given VPN searching by its
418 * Route-Distinguisher.
420 * @param rd Route-distinguisher of the VPN
421 * @return the list of VrfEntries
423 public List<VrfEntry> getAllVrfEntries(String rd) {
424 VrfTables vrfTables = getVrfTable(rd);
425 if (vrfTables != null && vrfTables.getVrfEntry() != null) {
426 return new ArrayList<VrfEntry>(vrfTables.getVrfEntry().values());
431 //FIXME: Implement caches for DS reads
433 public VpnInstance getVpnInstance(String vpnInstanceName) {
434 InstanceIdentifier<VpnInstance> id = InstanceIdentifier.builder(VpnInstances.class).child(VpnInstance.class,
435 new VpnInstanceKey(vpnInstanceName)).build();
436 Optional<VpnInstance> vpnInstance = read(LogicalDatastoreType.CONFIGURATION, id);
437 return vpnInstance.isPresent() ? vpnInstance.get() : null;
441 @SuppressWarnings("checkstyle:IllegalCatch")
442 List<VpnInstanceOpDataEntry> getAllVpnInstanceOpData() {
444 InstanceIdentifier<VpnInstanceOpData> id = InstanceIdentifier.builder(VpnInstanceOpData.class).build();
445 Optional<VpnInstanceOpData> vpnInstanceOpDataOptional = read(LogicalDatastoreType.OPERATIONAL, id);
447 vpnInstanceOpDataOptional.isPresent() && vpnInstanceOpDataOptional.get()
448 .getVpnInstanceOpDataEntry() != null
449 ? new ArrayList<VpnInstanceOpDataEntry>(vpnInstanceOpDataOptional.get()
450 .getVpnInstanceOpDataEntry().values()) : emptyList();
451 } catch (Exception e) {
452 LOG.error("getAllVpnInstanceOpData: Could not retrieve all vpn instance op data subtree...", e);
458 List<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data
459 .vpn.instance.op.data.entry.vpn.to.dpn.list.VpnInterfaces> getDpnVpnInterfaces(VpnInstance vpnInstance,
461 String primaryRd = getPrimaryRd(vpnInstance);
462 InstanceIdentifier<VpnToDpnList> dpnToVpnId = VpnHelper.getVpnToDpnListIdentifier(primaryRd, dpnId);
463 Optional<VpnToDpnList> dpnInVpn = read(LogicalDatastoreType.OPERATIONAL, dpnToVpnId);
464 return dpnInVpn.isPresent() && dpnInVpn.get().getVpnInterfaces() != null
465 ? new ArrayList<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op
466 .data.vpn.instance.op.data.entry.vpn.to.dpn.list.VpnInterfaces>(dpnInVpn.get()
467 .getVpnInterfaces().values())
472 static List<String> getListOfRdsFromVpnInstance(VpnInstance vpnInstance) {
473 return vpnInstance.getRouteDistinguisher() != null ? new ArrayList<>(
474 vpnInstance.getRouteDistinguisher()) : new ArrayList<>();
478 VrfEntry getVrfEntry(String rd, String ipPrefix) {
479 VrfTables vrfTable = getVrfTable(rd);
480 // TODO: why check VrfTables if we later go for the specific VrfEntry?
481 if (vrfTable != null) {
482 InstanceIdentifier<VrfEntry> vrfEntryId =
483 InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class, new VrfTablesKey(rd)).child(
484 VrfEntry.class, new VrfEntryKey(ipPrefix)).build();
485 Optional<VrfEntry> vrfEntry = read(LogicalDatastoreType.CONFIGURATION, vrfEntryId);
486 if (vrfEntry.isPresent()) {
487 return vrfEntry.get();
494 public List<Adjacency> getAdjacenciesForVpnInterfaceFromConfig(String intfName) {
495 final InstanceIdentifier<VpnInterface> identifier = getVpnInterfaceIdentifier(intfName);
496 InstanceIdentifier<Adjacencies> path = identifier.augmentation(Adjacencies.class);
497 Optional<Adjacencies> adjacencies = read(LogicalDatastoreType.CONFIGURATION, path);
498 if (adjacencies.isPresent()) {
499 return new ArrayList<Adjacency>(adjacencies.get().nonnullAdjacency().values());
504 static Routes getVpnToExtraroute(String ipPrefix, List<String> nextHopList) {
505 return new RoutesBuilder().setPrefix(ipPrefix).setNexthopIpList(nextHopList).build();
509 String getVpnInterfaceName(Uint64 metadata) throws InterruptedException, ExecutionException {
510 GetInterfaceFromIfIndexInputBuilder ifIndexInputBuilder = new GetInterfaceFromIfIndexInputBuilder();
511 Uint64 lportTag = MetaDataUtil.getLportFromMetadata(metadata);
512 ifIndexInputBuilder.setIfIndex(lportTag.intValue());
513 GetInterfaceFromIfIndexInput input = ifIndexInputBuilder.build();
514 Future<RpcResult<GetInterfaceFromIfIndexOutput>> interfaceFromIfIndex =
515 ifmRpcService.getInterfaceFromIfIndex(input);
516 GetInterfaceFromIfIndexOutput interfaceFromIfIndexOutput;
517 RpcResult<GetInterfaceFromIfIndexOutput> rpcResult = interfaceFromIfIndex.get();
518 if (rpcResult == null) {
521 interfaceFromIfIndexOutput = rpcResult.getResult();
522 return interfaceFromIfIndexOutput.getInterfaceName();
525 static AllocatedRdsBuilder getRdsBuilder(String nexthop, String rd) {
526 return new AllocatedRdsBuilder().withKey(new AllocatedRdsKey(nexthop)).setNexthop(nexthop).setRd(rd);
529 public static Adjacencies getVpnInterfaceAugmentation(List<Adjacency> nextHopList) {
530 return new AdjacenciesBuilder().setAdjacency(nextHopList).build();
533 static AdjacenciesOp getVpnInterfaceOpDataEntryAugmentation(List<Adjacency> nextHopList) {
534 return new AdjacenciesOpBuilder().setAdjacency(nextHopList).build();
537 static InstanceIdentifier<Interface> getInterfaceIdentifier(String interfaceName) {
538 return InstanceIdentifier.builder(Interfaces.class).child(Interface.class,
539 new InterfaceKey(interfaceName)).build();
542 public static Uint64 getCookieL3(int vpnId) {
543 return Uint64.valueOf(VpnConstants.COOKIE_L3_BASE.toJava().add(new BigInteger("0610000", 16))
544 .add(BigInteger.valueOf(vpnId)));
547 public Uint32 getUniqueId(String poolName, String idKey) {
548 AllocateIdInput getIdInput = new AllocateIdInputBuilder().setPoolName(poolName).setIdKey(idKey).build();
550 Future<RpcResult<AllocateIdOutput>> result = idManager.allocateId(getIdInput);
551 RpcResult<AllocateIdOutput> rpcResult = result.get();
552 if (rpcResult.isSuccessful()) {
553 return rpcResult.getResult().getIdValue();
555 LOG.error("getUniqueId: RPC Call to Get Unique Id from pool {} with key {} returned with Errors {}",
556 poolName, idKey, rpcResult.getErrors());
558 } catch (InterruptedException | ExecutionException e) {
559 LOG.error("getUniqueId: Exception when getting Unique Id from pool {} for key {}", poolName, idKey, e);
564 void releaseId(String poolName, String idKey) {
565 ReleaseIdInput idInput = new ReleaseIdInputBuilder().setPoolName(poolName).setIdKey(idKey).build();
567 RpcResult<ReleaseIdOutput> rpcResult = idManager.releaseId(idInput).get();
568 if (!rpcResult.isSuccessful()) {
569 LOG.error("releaseId: RPC Call to release Id for key {} from pool {} returned with Errors {}",
570 idKey, poolName, rpcResult.getErrors());
572 } catch (InterruptedException | ExecutionException e) {
573 LOG.error("releaseId: Exception when releasing Id for key {} from pool {}", idKey, poolName, e);
577 public static String getNextHopLabelKey(String rd, String prefix) {
578 return rd + VpnConstants.SEPARATOR + prefix;
582 * Retrieves the dataplane identifier of a specific VPN, searching by its
585 * @param vpnName Name of the VPN
586 * @return the dataplane identifier of the VPN, the VrfTag.
588 public Uint32 getVpnId(String vpnName) {
589 if (vpnName == null) {
590 return VpnConstants.INVALID_ID;
593 return read(LogicalDatastoreType.CONFIGURATION, VpnOperDsUtils.getVpnInstanceToVpnIdIdentifier(vpnName))
594 .map(org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911
595 .vpn.instance.to.vpn.id.VpnInstance::getVpnId)
596 .orElse(VpnConstants.INVALID_ID);
600 * Retrieves the VPN Route Distinguisher searching by its Vpn instance name.
602 * @param vpnName Name of the VPN
603 * @return the route-distinguisher of the VPN
605 public String getVpnRd(String vpnName) {
606 Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id
607 .VpnInstance> vpnInstance = read(LogicalDatastoreType.CONFIGURATION,
608 VpnOperDsUtils.getVpnInstanceToVpnIdIdentifier(vpnName));
610 if (vpnInstance.isPresent()) {
611 rd = vpnInstance.get().getVrfId();
616 public static String getVpnRd(TypedReadTransaction<Configuration> confTx, String vpnName) {
618 return confTx.read(VpnOperDsUtils.getVpnInstanceToVpnIdIdentifier(vpnName)).get().map(
619 vpnInstance -> vpnInstance.getVrfId()).orElse(null);
620 } catch (InterruptedException | ExecutionException e) {
621 throw new RuntimeException(e);
625 List<String> getVpnRdsFromVpnInstanceConfig(String vpnName) {
626 InstanceIdentifier<VpnInstance> id = InstanceIdentifier.builder(VpnInstances.class)
627 .child(VpnInstance.class, new VpnInstanceKey(vpnName)).build();
628 Optional<VpnInstance> vpnInstance = read(LogicalDatastoreType.CONFIGURATION, id);
629 return vpnInstance.isPresent() ? getListOfRdsFromVpnInstance(vpnInstance.get()) : new ArrayList<>();
633 * Remove from MDSAL all those VrfEntries in a VPN that have an specific RouteOrigin.
635 * @param rd Route Distinguisher
636 * @param origin Origin of the Routes to be removed (see {@link RouteOrigin})
638 public void removeVrfEntriesByOrigin(String rd, RouteOrigin origin) {
639 InstanceIdentifier<VrfTables> vpnVrfTableIid =
640 InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class, new VrfTablesKey(rd)).build();
641 Optional<VrfTables> vrfTablesOpc = read(LogicalDatastoreType.CONFIGURATION, vpnVrfTableIid);
642 if (vrfTablesOpc.isPresent()) {
643 VrfTables vrfTables = vrfTablesOpc.get();
644 LoggingFutures.addErrorLogging(
645 new ManagedNewTransactionRunnerImpl(dataBroker).callWithNewWriteOnlyTransactionAndSubmit(
646 Datastore.CONFIGURATION, tx -> {
647 for (VrfEntry vrfEntry : vrfTables.nonnullVrfEntry().values()) {
648 if (origin == RouteOrigin.value(vrfEntry.getOrigin())) {
649 tx.delete(vpnVrfTableIid.child(VrfEntry.class, vrfEntry.key()));
652 }), LOG, "Error removing VRF entries by origin");
656 public List<VrfEntry> findVrfEntriesByNexthop(String rd, String nexthop) {
657 InstanceIdentifier<VrfTables> vpnVrfTableIid =
658 InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class, new VrfTablesKey(rd)).build();
659 Optional<VrfTables> vrfTablesOpc = read(LogicalDatastoreType.CONFIGURATION, vpnVrfTableIid);
660 List<VrfEntry> matches = new ArrayList<>();
661 if (vrfTablesOpc.isPresent()) {
662 VrfTables vrfTables = vrfTablesOpc.get();
663 for (VrfEntry vrfEntry : vrfTables.nonnullVrfEntry().values()) {
664 vrfEntry.nonnullRoutePaths().values().stream()
665 .filter(routePath -> routePath.getNexthopAddress() != null && routePath.getNexthopAddress()
666 .equals(nexthop)).findFirst().ifPresent(routePath -> matches.add(vrfEntry));
672 public void removeVrfEntries(String rd, List<VrfEntry> vrfEntries) {
673 InstanceIdentifier<VrfTables> vpnVrfTableIid =
674 InstanceIdentifier.builder(FibEntries.class).child(VrfTables.class, new VrfTablesKey(rd)).build();
675 LoggingFutures.addErrorLogging(
676 new ManagedNewTransactionRunnerImpl(dataBroker).callWithNewWriteOnlyTransactionAndSubmit(
677 Datastore.CONFIGURATION, tx -> {
678 for (VrfEntry vrfEntry : vrfEntries) {
679 tx.delete(vpnVrfTableIid.child(VrfEntry.class, vrfEntry.key()));
681 }), LOG, "Error removing VRF entries");
684 // TODO Clean up the exception handling
685 @SuppressWarnings("checkstyle:IllegalCatch")
686 public void withdrawRoutes(String rd, List<VrfEntry> vrfEntries) {
687 vrfEntries.forEach(vrfEntry -> {
689 bgpManager.withdrawPrefix(rd, vrfEntry.getDestPrefix());
690 } catch (Exception e) {
691 LOG.error("withdrawRoutes: Could not withdraw route to {} with route-paths {} in VpnRd {}",
692 vrfEntry.getDestPrefix(), vrfEntry.getRoutePaths(), rd);
697 public boolean removeOrUpdateDSForExtraRoute(String vpnName, String primaryRd, String extraRouteRd,
698 String vpnInterfaceName, String prefix, String nextHop,
699 String nextHopTunnelIp, TypedWriteTransaction<Operational> operTx) {
700 LOG.info("removeOrUpdateDSForExtraRoute: VPN WITHDRAW: Removing Fib Entry rd {} prefix {} nexthop {}",
701 extraRouteRd, prefix, nextHop);
702 boolean areNextHopsClearedForRd = false;
703 Optional<Routes> optVpnExtraRoutes = VpnExtraRouteHelper
704 .getVpnExtraroutes(dataBroker, vpnName, extraRouteRd, prefix);
705 if (optVpnExtraRoutes.isPresent()) {
706 List<String> nhList = optVpnExtraRoutes.get().getNexthopIpList();
707 if (nhList != null && nhList.size() > 1) {
708 // If nhList is more than 1, just update vpntoextraroute and prefixtointerface DS
709 // For other cases, remove the corresponding tep ip from fibentry and withdraw prefix
710 nhList.remove(nextHop);
711 syncWrite(LogicalDatastoreType.OPERATIONAL,
712 VpnExtraRouteHelper.getVpnToExtrarouteVrfIdIdentifier(vpnName, extraRouteRd, prefix),
713 VpnUtil.getVpnToExtraroute(prefix, nhList));
714 MDSALUtil.syncDelete(dataBroker,
715 LogicalDatastoreType.CONFIGURATION, VpnExtraRouteHelper.getUsedRdsIdentifier(getVpnId(vpnName),
717 LOG.info("removeOrUpdateDSForExtraRoute: Removed vpn-to-extraroute with rd {} prefix {} nexthop {}",
718 extraRouteRd, prefix, nextHop);
719 fibManager.refreshVrfEntry(primaryRd, prefix);
720 operTx.delete(VpnUtil.getVpnInterfaceOpDataEntryAdjacencyIdentifier(vpnInterfaceName, vpnName, prefix));
721 LOG.info("VPN WITHDRAW: removeOrUpdateDSForExtraRoute: Removed Fib Entry rd {} prefix {} nexthop {}",
722 extraRouteRd, prefix, nextHopTunnelIp);
723 areNextHopsClearedForRd = true;
726 return areNextHopsClearedForRd;
729 static org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.to.vpn.id.VpnInstance
730 getVpnInstanceToVpnId(String vpnName, Uint32 vpnId, String rd) {
731 return new VpnInstanceBuilder().setVpnId(vpnId).setVpnInstanceName(vpnName).setVrfId(rd).build();
735 static org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance.VpnIds
736 getVpnIdToVpnInstance(Uint32 vpnId, String vpnName, String rd, boolean isExternalVpn) {
737 return new org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance
738 .VpnIdsBuilder().setVpnId(vpnId).setVpnInstanceName(vpnName).setVrfId(rd).setExternalVpn(isExternalVpn)
743 static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to
744 .vpn.instance.VpnIds> getVpnIdToVpnInstanceIdentifier(Uint32 vpnId) {
745 return InstanceIdentifier.builder(VpnIdToVpnInstance.class).child(org.opendaylight.yang.gen.v1.urn
746 .opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance.VpnIds.class,
747 new org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance
748 .VpnIdsKey(vpnId)).build();
752 * Retrieves the Vpn Name searching by its VPN Tag.
754 * @param vpnId Dataplane identifier of the VPN
755 * @return the Vpn instance name
758 String getVpnName(Uint32 vpnId) {
760 InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn
761 .instance.VpnIds> id = getVpnIdToVpnInstanceIdentifier(vpnId);
762 Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance.VpnIds>
764 = read(LogicalDatastoreType.CONFIGURATION, id);
765 String vpnName = null;
766 if (vpnInstance.isPresent()) {
767 vpnName = vpnInstance.get().getVpnInstanceName();
772 public static InstanceIdentifier<VpnInstanceOpDataEntry> getVpnInstanceOpDataIdentifier(String rd) {
773 return InstanceIdentifier.builder(VpnInstanceOpData.class)
774 .child(VpnInstanceOpDataEntry.class, new VpnInstanceOpDataEntryKey(rd)).build();
778 public VpnInstanceOpDataEntry getVpnInstanceOpData(String rd) {
779 return read(LogicalDatastoreType.OPERATIONAL, getVpnInstanceOpDataIdentifier(rd)).orElse(null);
783 VpnInterface getConfiguredVpnInterface(String interfaceName) {
784 InstanceIdentifier<VpnInterface> interfaceId = getVpnInterfaceIdentifier(interfaceName);
785 Optional<VpnInterface> configuredVpnInterface = read(LogicalDatastoreType.CONFIGURATION, interfaceId);
786 if (configuredVpnInterface.isPresent()) {
787 return configuredVpnInterface.get();
792 boolean isVpnInterfaceConfigured(String interfaceName) {
793 InstanceIdentifier<VpnInterface> interfaceId = getVpnInterfaceIdentifier(interfaceName);
794 return read(LogicalDatastoreType.CONFIGURATION, interfaceId).isPresent();
797 public Optional<List<String>> getVpnHandlingIpv4AssociatedWithInterface(String interfaceName) {
798 InstanceIdentifier<VpnInterface> interfaceId = getVpnInterfaceIdentifier(interfaceName);
799 Optional<List<String>> vpnOptional = Optional.empty();
800 Optional<VpnInterface> optConfiguredVpnInterface = read(LogicalDatastoreType.CONFIGURATION, interfaceId);
801 if (optConfiguredVpnInterface.isPresent()) {
802 VpnInterface cfgVpnInterface = optConfiguredVpnInterface.get();
803 java.util.Optional<List<VpnInstanceNames>> optVpnInstanceList =
804 java.util.Optional.ofNullable(
805 new ArrayList<VpnInstanceNames>(cfgVpnInterface.nonnullVpnInstanceNames().values()));
806 if (optVpnInstanceList.isPresent()) {
807 List<String> vpnList = new ArrayList<>();
808 for (VpnInstanceNames vpnInstance : optVpnInstanceList.get()) {
809 vpnList.add(vpnInstance.getVpnName());
811 vpnOptional = Optional.of(vpnList);
817 public static String getIpPrefix(String prefix) {
818 return prefix.indexOf('/') != -1 ? prefix : NWUtil.toIpPrefix(prefix);
821 static final FutureCallback<Void> DEFAULT_CALLBACK =
822 new FutureCallback<Void>() {
824 public void onSuccess(Void result) {
825 LOG.debug("Success in Datastore operation");
829 public void onFailure(Throwable error) {
830 LOG.error("Error in Datastore operation", error);
836 private <T extends DataObject> Optional<T> read(LogicalDatastoreType datastoreType, InstanceIdentifier<T> path) {
838 return SingleTransactionDataBroker.syncReadOptional(dataBroker, datastoreType, path);
839 } catch (InterruptedException | ExecutionException e) {
840 throw new RuntimeException(e);
845 public <T extends DataObject> void syncWrite(LogicalDatastoreType datastoreType, InstanceIdentifier<T> path,
848 SingleTransactionDataBroker.syncWrite(dataBroker, datastoreType, path, data);
849 } catch (TransactionCommitFailedException e) {
850 LOG.error("syncWrite: Error writing to datastore (path, data) : ({}, {})", path, data, e);
851 throw new RuntimeException(e.getMessage(), e);
856 public <T extends DataObject> void syncUpdate(LogicalDatastoreType datastoreType, InstanceIdentifier<T> path,
859 SingleTransactionDataBroker.syncUpdate(dataBroker, datastoreType, path, data);
860 } catch (TransactionCommitFailedException e) {
861 LOG.error("syncUpdate: Error writing to datastore (path, data) : ({}, {})", path, data, e);
862 throw new RuntimeException(e.getMessage(), e);
866 static long getRemoteBCGroup(long elanTag) {
867 return VpnConstants.ELAN_GID_MIN + elanTag % VpnConstants.ELAN_GID_MIN * 2;
870 // interface-index-tag operational container
872 IfIndexInterface getInterfaceInfoByInterfaceTag(long interfaceTag) {
873 InstanceIdentifier<IfIndexInterface> interfaceId = getInterfaceInfoEntriesOperationalDataPath(interfaceTag);
874 Optional<IfIndexInterface> existingInterfaceInfo = read(LogicalDatastoreType.OPERATIONAL, interfaceId);
875 if (existingInterfaceInfo.isPresent()) {
876 return existingInterfaceInfo.get();
881 static InstanceIdentifier<IfIndexInterface> getInterfaceInfoEntriesOperationalDataPath(long interfaceTag) {
882 return InstanceIdentifier.builder(IfIndexesInterfaceMap.class).child(IfIndexInterface.class,
883 new IfIndexInterfaceKey((int) interfaceTag)).build();
887 ElanTagName getElanInfoByElanTag(long elanTag) {
888 InstanceIdentifier<ElanTagName> elanId = getElanInfoEntriesOperationalDataPath(elanTag);
889 Optional<ElanTagName> existingElanInfo = read(LogicalDatastoreType.OPERATIONAL, elanId);
890 if (existingElanInfo.isPresent()) {
891 return existingElanInfo.get();
896 static InstanceIdentifier<ElanTagName> getElanInfoEntriesOperationalDataPath(long elanTag) {
897 return InstanceIdentifier.builder(ElanTagNameMap.class).child(ElanTagName.class,
898 new ElanTagNameKey(elanTag)).build();
901 static void removePrefixToInterfaceForVpnId(Uint32 vpnId, @NonNull TypedWriteTransaction<Operational> operTx) {
902 // Clean up PrefixToInterface Operational DS
903 operTx.delete(InstanceIdentifier.builder(
904 PrefixToInterface.class).child(VpnIds.class, new VpnIdsKey(vpnId)).build());
907 static void removeVpnExtraRouteForVpn(String vpnName, @NonNull TypedWriteTransaction<Operational> operTx) {
908 // Clean up VPNExtraRoutes Operational DS
909 operTx.delete(InstanceIdentifier.builder(VpnToExtraroutes.class).child(Vpn.class, new VpnKey(vpnName)).build());
912 @SuppressWarnings("checkstyle:IllegalCatch")
913 static void removeVpnOpInstance(String vpnName, @NonNull TypedWriteTransaction<Operational> operTx) {
914 // Clean up VPNInstanceOpDataEntry
915 operTx.delete(getVpnInstanceOpDataIdentifier(vpnName));
918 static void removeVpnInstanceToVpnId(String vpnName, @NonNull TypedWriteTransaction<Configuration> confTx) {
919 confTx.delete(VpnOperDsUtils.getVpnInstanceToVpnIdIdentifier(vpnName));
922 static void removeVpnIdToVpnInstance(Uint32 vpnId, @NonNull TypedWriteTransaction<Configuration> confTx) {
923 confTx.delete(getVpnIdToVpnInstanceIdentifier(vpnId));
926 static void removeL3nexthopForVpnId(Uint32 vpnId, @NonNull TypedWriteTransaction<Operational> operTx) {
927 // Clean up L3NextHop Operational DS
928 operTx.delete(InstanceIdentifier.builder(L3nexthop.class).child(
929 VpnNexthops.class, new VpnNexthopsKey(vpnId)).build());
932 void scheduleVpnInterfaceForRemoval(String interfaceName, Uint64 dpnId, String vpnInstanceName,
933 @Nullable TypedWriteTransaction<Operational> writeOperTxn) {
934 InstanceIdentifier<VpnInterfaceOpDataEntry> interfaceId =
935 getVpnInterfaceOpDataEntryIdentifier(interfaceName, vpnInstanceName);
936 VpnInterfaceOpDataEntry interfaceToUpdate =
937 new VpnInterfaceOpDataEntryBuilder().withKey(new VpnInterfaceOpDataEntryKey(interfaceName,
938 vpnInstanceName)).setName(interfaceName).setDpnId(dpnId).setVpnInstanceName(vpnInstanceName)
940 if (writeOperTxn != null) {
941 writeOperTxn.mergeParentStructureMerge(interfaceId, interfaceToUpdate);
943 syncUpdate(LogicalDatastoreType.OPERATIONAL, interfaceId, interfaceToUpdate);
947 public void createLearntVpnVipToPort(String vpnName, String fixedIp, String portName, String macAddress,
948 TypedWriteTransaction<Operational> writeOperTxn) {
949 final InstanceIdentifier<LearntVpnVipToPort> id = buildLearntVpnVipToPortIdentifier(vpnName, fixedIp);
950 final ReentrantLock lock = lockFor(vpnName, fixedIp);
953 LearntVpnVipToPortBuilder builder =
954 new LearntVpnVipToPortBuilder().withKey(new LearntVpnVipToPortKey(fixedIp, vpnName)).setVpnName(
955 vpnName).setPortFixedip(fixedIp).setPortName(portName)
956 .setMacAddress(macAddress.toLowerCase(Locale.getDefault()))
957 .setCreationTime(new SimpleDateFormat("MM/dd/yyyy h:mm:ss a").format(new Date()));
958 if (writeOperTxn != null) {
959 writeOperTxn.mergeParentStructurePut(id, builder.build());
961 syncWrite(LogicalDatastoreType.OPERATIONAL, id, builder.build());
963 LOG.debug("createLearntVpnVipToPort: ARP/NA learned for fixedIp: {}, vpn {}, interface {}, mac {},"
964 + " added to LearntVpnVipToPort DS", fixedIp, vpnName, portName, macAddress);
970 static InstanceIdentifier<LearntVpnVipToPort> buildLearntVpnVipToPortIdentifier(String vpnName,
972 return InstanceIdentifier.builder(LearntVpnVipToPortData.class).child(LearntVpnVipToPort.class,
973 new LearntVpnVipToPortKey(fixedIp, vpnName)).build();
976 public void removeLearntVpnVipToPort(String vpnName, String fixedIp,
977 @Nullable TypedWriteTransaction<Operational> writeOperTxn) {
978 final InstanceIdentifier<LearntVpnVipToPort> id = buildLearntVpnVipToPortIdentifier(vpnName, fixedIp);
979 final ReentrantLock lock = lockFor(vpnName, fixedIp);
982 if (writeOperTxn != null) {
983 writeOperTxn.delete(id);
985 MDSALUtil.syncDelete(dataBroker, LogicalDatastoreType.OPERATIONAL, id);
987 LOG.debug("removeLearntVpnVipToPort: Deleted LearntVpnVipToPort entry for fixedIp: {}, vpn {}",
994 public static void removeVpnPortFixedIpToPort(DataBroker broker, String vpnName, String fixedIp,
995 @Nullable TypedWriteTransaction<Configuration> writeConfigTxn) {
996 final InstanceIdentifier<VpnPortipToPort> id = buildVpnPortipToPortIdentifier(vpnName, fixedIp);
997 final ReentrantLock lock = lockFor(vpnName, fixedIp);
1000 if (writeConfigTxn != null) {
1001 writeConfigTxn.delete(id);
1003 MDSALUtil.syncDelete(broker, LogicalDatastoreType.CONFIGURATION, id);
1005 LOG.debug("removeVpnPortFixedIpToPort: Deleted VpnPortipToPort entry for fixedIp: {}, vpn {}",
1012 public void createLearntVpnVipToPortEvent(String vpnName, String srcIp, String destIP, String portName,
1013 String macAddress, LearntVpnVipToPortEventAction action,
1014 TypedWriteTransaction<Operational> writeOperTxn) {
1015 String eventId = MicroTimestamp.INSTANCE.get();
1017 InstanceIdentifier<LearntVpnVipToPortEvent> id = buildLearntVpnVipToPortEventIdentifier(eventId);
1018 LearntVpnVipToPortEventBuilder builder = new LearntVpnVipToPortEventBuilder().withKey(
1019 new LearntVpnVipToPortEventKey(eventId)).setVpnName(vpnName).setSrcFixedip(srcIp)
1020 .setDestFixedip(destIP).setPortName(portName)
1021 .setMacAddress(macAddress.toLowerCase(Locale.getDefault())).setEventAction(action);
1022 if (writeOperTxn != null) {
1023 writeOperTxn.delete(id);
1025 syncWrite(LogicalDatastoreType.OPERATIONAL, id, builder.build());
1027 LOG.info("createLearntVpnVipToPortEvent: ARP learn event created for fixedIp: {}, vpn {}, interface {},"
1028 + " mac {} action {} eventId {}", srcIp, vpnName, portName, macAddress, action, eventId);
1031 private static InstanceIdentifier<LearntVpnVipToPortEvent> buildLearntVpnVipToPortEventIdentifier(String eventId) {
1032 InstanceIdentifier<LearntVpnVipToPortEvent> id = InstanceIdentifier.builder(LearntVpnVipToPortEventData.class)
1033 .child(LearntVpnVipToPortEvent.class, new LearntVpnVipToPortEventKey(eventId)).build();
1037 public void removeLearntVpnVipToPortEvent(String eventId,
1038 @Nullable TypedWriteTransaction<Operational> writeOperTxn) {
1039 InstanceIdentifier<LearntVpnVipToPortEvent> id = buildLearntVpnVipToPortEventIdentifier(eventId);
1040 if (writeOperTxn != null) {
1041 writeOperTxn.delete(id);
1043 MDSALUtil.syncDelete(dataBroker, LogicalDatastoreType.OPERATIONAL, id);
1045 LOG.info("removeLearntVpnVipToPortEvent: Deleted Event {}", eventId);
1049 // TODO Clean up the exception handling
1050 @SuppressWarnings("checkstyle:IllegalCatch")
1051 public void removeMipAdjAndLearntIp(String vpnName, String vpnInterface, String prefix) {
1052 final ReentrantLock lock = lockFor(vpnName, prefix);
1055 String ip = VpnUtil.getIpPrefix(prefix);
1056 InstanceIdentifier<VpnInterfaceOpDataEntry> vpnInterfaceOpId = VpnUtil
1057 .getVpnInterfaceOpDataEntryIdentifier(vpnInterface, vpnName);
1058 InstanceIdentifier<AdjacenciesOp> path = vpnInterfaceOpId.augmentation(AdjacenciesOp.class);
1059 Optional<AdjacenciesOp> adjacenciesOp = read(LogicalDatastoreType.OPERATIONAL, path);
1060 if (adjacenciesOp.isPresent()) {
1061 InstanceIdentifier<Adjacency> adjacencyIdentifier = InstanceIdentifier.builder(VpnInterfaces.class)
1062 .child(VpnInterface.class, new VpnInterfaceKey(vpnInterface))
1063 .augmentation(Adjacencies.class).child(Adjacency.class, new AdjacencyKey(ip)).build();
1064 MDSALUtil.syncDelete(dataBroker, LogicalDatastoreType.CONFIGURATION, adjacencyIdentifier);
1065 LOG.info("removeMipAdjAndLearntIp: Successfully Deleted Adjacency {} from interface {} vpn {}", ip,
1066 vpnInterface, vpnName);
1068 InstanceIdentifier<LearntVpnVipToPort> id = buildLearntVpnVipToPortIdentifier(vpnName, prefix);
1069 MDSALUtil.syncDelete(dataBroker, LogicalDatastoreType.OPERATIONAL, id);
1070 LOG.info("removeMipAdjAndLearntIp: Delete learned ARP for fixedIp: {}, vpn {} removed from"
1071 + "VpnPortipToPort DS", prefix, vpnName);
1072 } catch (Exception e) {
1073 LOG.error("removeMipAdjAndLearntIp: Exception Deleting learned Ip: {} interface {} vpn {} from "
1074 + "LearntVpnPortipToPort DS", prefix, vpnInterface, vpnName, e);
1078 VpnUtil.removeVpnPortFixedIpToPort(dataBroker, vpnName, prefix, null);
1081 public void removeMipAdjacency(String vpnName, String vpnInterface, String prefix,
1082 TypedWriteTransaction<Configuration> writeConfigTxn) {
1083 String ip = VpnUtil.getIpPrefix(prefix);
1084 LOG.trace("Removing {} adjacency from Old VPN Interface {} ", ip, vpnInterface);
1085 InstanceIdentifier<VpnInterface> vpnIfId = VpnUtil.getVpnInterfaceIdentifier(vpnInterface);
1086 InstanceIdentifier<Adjacencies> path = vpnIfId.augmentation(Adjacencies.class);
1087 //TODO: Remove synchronized?
1089 Optional<Adjacencies> adjacencies = read(LogicalDatastoreType.OPERATIONAL, path);
1090 if (adjacencies.isPresent()) {
1091 InstanceIdentifier<Adjacency> adjacencyIdentifier = getAdjacencyIdentifier(vpnInterface, prefix);
1092 writeConfigTxn.delete(adjacencyIdentifier);
1093 LOG.error("removeMipAdjacency: Successfully Deleted Adjacency {} from interface {} vpn {}", ip,
1094 vpnInterface, vpnName);
1098 public void removeMipAdjacency(String vpnInterface, String ipAddress) {
1099 String prefix = VpnUtil.getIpPrefix(ipAddress);
1100 InstanceIdentifier<Adjacency> adjacencyIdentifier = getAdjacencyIdentifier(vpnInterface, prefix);
1102 SingleTransactionDataBroker.syncDelete(dataBroker, LogicalDatastoreType.CONFIGURATION,
1103 adjacencyIdentifier);
1104 } catch (TransactionCommitFailedException e) {
1105 if (e.getCause() instanceof ModifiedNodeDoesNotExistException) {
1106 LOG.debug("vpnInterface {} is already deleted. prefix={}", vpnInterface, prefix);
1108 LOG.error("Failed to delete adjacency for vpnInterface {}, prefix {}", vpnInterface, prefix, e);
1113 static InstanceIdentifier<NetworkMap> buildNetworkMapIdentifier(Uuid networkId) {
1114 return InstanceIdentifier.builder(NetworkMaps.class).child(NetworkMap.class, new
1115 NetworkMapKey(networkId)).build();
1118 static InstanceIdentifier<SubnetOpDataEntry> buildSubnetOpDataEntryInstanceIdentifier(Uuid subnetId) {
1119 return InstanceIdentifier.builder(SubnetOpData.class)
1120 .child(SubnetOpDataEntry.class, new SubnetOpDataEntryKey(subnetId)).build();
1123 static InstanceIdentifier<VpnPortipToPort> buildVpnPortipToPortIdentifier(String vpnName, String fixedIp) {
1124 return InstanceIdentifier.builder(NeutronVpnPortipPortData.class).child(VpnPortipToPort.class,
1125 new VpnPortipToPortKey(fixedIp, vpnName)).build();
1129 public VpnPortipToPort getNeutronPortFromVpnPortFixedIp(String vpnName, String fixedIp) {
1130 InstanceIdentifier<VpnPortipToPort> id = buildVpnPortipToPortIdentifier(vpnName, fixedIp);
1131 Optional<VpnPortipToPort> vpnPortipToPortData = read(LogicalDatastoreType.CONFIGURATION, id);
1132 if (vpnPortipToPortData.isPresent()) {
1133 return vpnPortipToPortData.get();
1139 public static VpnPortipToPort getNeutronPortFromVpnPortFixedIp(TypedReadTransaction<Configuration> confTx,
1140 String vpnName, String fixedIp) {
1141 InstanceIdentifier<VpnPortipToPort> id = buildVpnPortipToPortIdentifier(vpnName, fixedIp);
1143 return confTx.read(id).get().orElse(null);
1144 } catch (InterruptedException | ExecutionException e) {
1145 throw new RuntimeException(e);
1150 public LearntVpnVipToPort getLearntVpnVipToPort(String vpnName, String fixedIp) {
1151 InstanceIdentifier<LearntVpnVipToPort> id = buildLearntVpnVipToPortIdentifier(vpnName, fixedIp);
1152 Optional<LearntVpnVipToPort> learntVpnVipToPort = read(LogicalDatastoreType.OPERATIONAL, id);
1153 if (learntVpnVipToPort.isPresent()) {
1154 return learntVpnVipToPort.get();
1160 List<Uint64> getDpnsOnVpn(String vpnInstanceName) {
1161 List<Uint64> result = new ArrayList<>();
1162 String rd = getVpnRd(vpnInstanceName);
1164 LOG.debug("getDpnsOnVpn: Could not find Route-Distinguisher for VpnName={}", vpnInstanceName);
1167 VpnInstanceOpDataEntry vpnInstanceOpData = getVpnInstanceOpData(rd);
1168 if (vpnInstanceOpData == null) {
1169 LOG.debug("getDpnsOnVpn: Could not find OpState for VpnName={}", vpnInstanceName);
1172 Map<VpnToDpnListKey, VpnToDpnList> vpnToDpnListKeyVpnToDpnListMap = vpnInstanceOpData.getVpnToDpnList();
1173 if (vpnToDpnListKeyVpnToDpnListMap == null) {
1174 LOG.debug("getDpnsOnVpn: Could not find DPN footprint for VpnName={}", vpnInstanceName);
1177 for (VpnToDpnList vpnToDpn : vpnToDpnListKeyVpnToDpnListMap.values()) {
1178 result.add(vpnToDpn.getDpnId());
1184 String getAssociatedExternalRouter(String extIp) {
1185 InstanceIdentifier<ExtRouters> extRouterInstanceIndentifier =
1186 InstanceIdentifier.builder(ExtRouters.class).build();
1187 Optional<ExtRouters> extRouterData = read(LogicalDatastoreType.CONFIGURATION, extRouterInstanceIndentifier);
1188 if (!extRouterData.isPresent()) {
1192 // We need to find the router associated with the src ip of this packet.
1193 // This case is either SNAT, in which case the src ip is the same as the
1194 // router's external ip, or FIP in which case the src ip is in the router's
1195 // external leg's subnet. We first check the SNAT case because it is much
1196 // cheaper to do so because it does not require (potentially, there is a
1197 // cache) an datastore read of the neutron subnet for each external IP.
1199 String routerName = null;
1201 for (Routers routerData : extRouterData.get().nonnullRouters().values()) {
1202 Map<ExternalIpsKey, ExternalIps> keyExternalIpsMap = routerData.nonnullExternalIps();
1203 for (ExternalIps externalIp : keyExternalIpsMap.values()) {
1204 if (Objects.equals(externalIp.getIpAddress(), extIp)) {
1205 routerName = routerData.getRouterName();
1211 if (routerName != null) {
1215 for (Routers routerData : extRouterData.get().nonnullRouters().values()) {
1216 Map<ExternalIpsKey, ExternalIps> keyExternalIpsMap = routerData.nonnullExternalIps();
1217 for (ExternalIps externalIp : keyExternalIpsMap.values()) {
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), neutronSubnet.getCidr())) {
1225 routerName = routerData.getRouterName();
1235 public String getAssociatedExternalSubnet(String extIp) {
1236 InstanceIdentifier<ExtRouters> extRouterInstanceIndentifier =
1237 InstanceIdentifier.builder(ExtRouters.class).build();
1238 Optional<ExtRouters> extRouterData = read(LogicalDatastoreType.CONFIGURATION, extRouterInstanceIndentifier);
1239 if (!extRouterData.isPresent() || extRouterData.get().getRouters() == null) {
1242 for (Routers routerData : extRouterData.get().getRouters().values()) {
1243 Map<ExternalIpsKey, ExternalIps> keyExternalIpsMap = routerData.getExternalIps();
1244 if (keyExternalIpsMap != null) {
1245 for (ExternalIps externalIp : keyExternalIpsMap.values()) {
1246 Subnet neutronSubnet = neutronVpnService.getNeutronSubnet(externalIp.getSubnetId());
1247 if (neutronSubnet == null) {
1248 LOG.warn("Failed to retrieve subnet {} referenced by router {}",
1249 externalIp.getSubnetId(), routerData);
1252 if (NWUtil.isIpAddressInRange(IpAddressBuilder.getDefaultInstance(extIp),
1253 neutronSubnet.getCidr())) {
1254 return neutronSubnet.getUuid().getValue();
1262 static InstanceIdentifier<Routers> buildRouterIdentifier(String routerId) {
1263 return InstanceIdentifier.builder(ExtRouters.class).child(Routers.class, new RoutersKey(routerId)).build();
1267 Networks getExternalNetwork(Uuid networkId) {
1268 InstanceIdentifier<Networks> netsIdentifier = InstanceIdentifier.builder(ExternalNetworks.class)
1269 .child(Networks.class, new NetworksKey(networkId)).build();
1270 Optional<Networks> optionalNets = read(LogicalDatastoreType.CONFIGURATION, netsIdentifier);
1271 return optionalNets.isPresent() ? optionalNets.get() : null;
1275 Uuid getExternalNetworkVpnId(Uuid networkId) {
1276 Networks extNetwork = getExternalNetwork(networkId);
1277 return extNetwork != null ? extNetwork.getVpnid() : null;
1281 public List<Uuid> getExternalNetworkRouterIds(Uuid networkId) {
1282 Networks extNetwork = getExternalNetwork(networkId);
1283 return extNetwork != null && extNetwork.getRouterIds() != null ? extNetwork.getRouterIds() : emptyList();
1287 Routers getExternalRouter(String routerId) {
1288 InstanceIdentifier<Routers> id = InstanceIdentifier.builder(ExtRouters.class).child(Routers.class,
1289 new RoutersKey(routerId)).build();
1290 Optional<Routers> routerData = read(LogicalDatastoreType.CONFIGURATION, id);
1291 return routerData.isPresent() ? routerData.get() : null;
1295 Routers getExternalRouter(TypedReadTransaction<Configuration> tx, String routerId)
1296 throws ExecutionException, InterruptedException {
1297 InstanceIdentifier<Routers> id = InstanceIdentifier.builder(ExtRouters.class).child(Routers.class,
1298 new RoutersKey(routerId)).build();
1299 return tx.read(id).get().orElse(null);
1302 static InstanceIdentifier<Subnetmaps> buildSubnetMapsWildCardPath() {
1303 return InstanceIdentifier.create(Subnetmaps.class);
1306 FlowEntity buildL3vpnGatewayFlow(Uint64 dpId, String gwMacAddress, Uint32 vpnId,
1307 Uint32 subnetVpnId) {
1308 List<MatchInfo> mkMatches = new ArrayList<>();
1309 Subnetmap smap = null;
1310 mkMatches.add(new MatchMetadata(MetaDataUtil.getVpnIdMetadata(vpnId.longValue()),
1311 MetaDataUtil.METADATA_MASK_VRFID));
1312 mkMatches.add(new MatchEthernetDestination(new MacAddress(gwMacAddress)));
1313 List<InstructionInfo> mkInstructions = new ArrayList<>();
1314 mkInstructions.add(new InstructionGotoTable(NwConstants.L3_FIB_TABLE));
1315 if (!VpnConstants.INVALID_ID.equals(subnetVpnId)) {
1316 String vpnName = getVpnName(subnetVpnId);
1317 if (vpnName != null) {
1318 smap = getSubnetmapFromItsUuid(Uuid.getDefaultInstance(vpnName));
1319 if (smap != null && smap.getSubnetIp() != null) {
1320 IpVersionChoice ipVersionChoice = getIpVersionFromString(smap.getSubnetIp());
1321 if (ipVersionChoice == IpVersionChoice.IPV4) {
1322 mkMatches.add(MatchEthernetType.IPV4);
1324 mkMatches.add(MatchEthernetType.IPV6);
1328 Uint64 subnetIdMetaData = MetaDataUtil.getVpnIdMetadata(subnetVpnId.longValue());
1329 mkInstructions.add(new InstructionWriteMetadata(subnetIdMetaData, MetaDataUtil.METADATA_MASK_VRFID));
1331 String flowId = getL3VpnGatewayFlowRef(NwConstants.L3_GW_MAC_TABLE, dpId, vpnId, gwMacAddress, subnetVpnId);
1332 return MDSALUtil.buildFlowEntity(dpId, NwConstants.L3_GW_MAC_TABLE,
1333 flowId, 20, flowId, 0, 0, NwConstants.COOKIE_L3_GW_MAC_TABLE,
1334 mkMatches, mkInstructions);
1337 static String getL3VpnGatewayFlowRef(short l3GwMacTable, Uint64 dpId, Uint32 vpnId, String gwMacAddress,
1338 Uint32 subnetVpnId) {
1339 return gwMacAddress + NwConstants.FLOWID_SEPARATOR + vpnId + NwConstants.FLOWID_SEPARATOR + dpId
1340 + NwConstants.FLOWID_SEPARATOR + l3GwMacTable + NwConstants.FLOWID_SEPARATOR + subnetVpnId;
1343 void lockSubnet(String subnetId) {
1344 // We set the total wait time for lock to be obtained at 9 seconds since GC pauses can be upto 8 seconds
1346 TryLockInput input =
1347 new TryLockInputBuilder().setLockName(subnetId).setTime(9000L).setTimeUnit(TimeUnits.Milliseconds).build();
1348 Future<RpcResult<TryLockOutput>> result = lockManager.tryLock(input);
1350 if (result != null && result.get().isSuccessful()) {
1351 LOG.debug("lockSubnet: Acquired lock for {}", subnetId);
1353 LOG.error("Unable to get lock for subnet {}", subnetId);
1354 throw new RuntimeException("Unable to get lock for subnet " + subnetId);
1356 } catch (InterruptedException | ExecutionException e) {
1357 LOG.error("Unable to get lock for subnet {}", subnetId, e);
1358 throw new RuntimeException("Unable to get lock for subnet " + subnetId, e);
1362 // We store the cause, which is what we really care about
1363 @SuppressWarnings("checkstyle:AvoidHidingCauseException")
1364 public void unlockSubnet(String subnetId) {
1365 UnlockInput input = new UnlockInputBuilder().setLockName(subnetId).build();
1366 Future<RpcResult<UnlockOutput>> result = lockManager.unlock(input);
1368 if (result != null && result.get().isSuccessful()) {
1369 LOG.debug("unlockSubnet: Unlocked {}", subnetId);
1371 LOG.debug("unlockSubnet: Unable to unlock subnet {}", subnetId);
1373 } catch (InterruptedException | ExecutionException e) {
1374 LOG.error("unlockSubnet: Unable to unlock subnet {}", subnetId);
1375 throw new RuntimeException(String.format("Unable to unlock subnetId %s", subnetId), e.getCause());
1379 public Optional<IpAddress> getGatewayIpAddressFromInterface(MacEntry macEntry) {
1380 Optional<IpAddress> gatewayIp = Optional.empty();
1381 String srcInterface = macEntry.getInterfaceName();
1382 InetAddress hiddenIp = macEntry.getIpAddress();
1383 if (neutronVpnService != null) {
1384 //TODO(Gobinath): Need to fix this as assuming port will belong to only one Subnet would be incorrect"
1385 Port port = neutronVpnService.getNeutronPort(srcInterface);
1386 if (port != null && port.getFixedIps() != null) {
1387 for (FixedIps portIp : port.getFixedIps().values()) {
1388 if (doesInterfaceAndHiddenIpAddressTypeMatch(hiddenIp, portIp)) {
1390 Optional.of(neutronVpnService.getNeutronSubnet(portIp.getSubnetId()).getGatewayIp());
1396 LOG.error("getGatewayIpAddressFromInterface: neutron vpn service is not configured."
1397 + " Failed for interface {}.", srcInterface);
1402 private boolean doesInterfaceAndHiddenIpAddressTypeMatch(InetAddress hiddenIp, FixedIps portIp) {
1403 return hiddenIp instanceof Inet4Address && portIp.getIpAddress().getIpv4Address() != null
1404 || hiddenIp instanceof Inet6Address && portIp.getIpAddress().getIpv6Address() != null;
1407 public Optional<String> getGWMacAddressFromInterface(MacEntry macEntry, IpAddress gatewayIp) {
1408 Optional<String> gatewayMac = Optional.empty();
1409 Uint32 vpnId = getVpnId(macEntry.getVpnName());
1410 InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn
1412 vpnIdsInstanceIdentifier = VpnUtil.getVpnIdToVpnInstanceIdentifier(vpnId);
1413 Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance.VpnIds>
1414 vpnIdsOptional = read(LogicalDatastoreType.CONFIGURATION, vpnIdsInstanceIdentifier);
1415 if (!vpnIdsOptional.isPresent()) {
1416 LOG.error("getGWMacAddressFromInterface: VPN {} not configured", vpnId);
1419 VpnPortipToPort vpnTargetIpToPort =
1420 getNeutronPortFromVpnPortFixedIp(macEntry.getVpnName(), gatewayIp.stringValue());
1421 if (vpnTargetIpToPort != null && vpnTargetIpToPort.isSubnetIp()) {
1422 gatewayMac = Optional.of(vpnTargetIpToPort.getMacAddress());
1424 org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911
1425 .vpn.id.to.vpn.instance.VpnIds vpnIds = vpnIdsOptional.get();
1426 if (vpnIds.isExternalVpn()) {
1427 gatewayMac = InterfaceUtils.getMacAddressForInterface(dataBroker, macEntry.getInterfaceName());
1433 void setupGwMacIfExternalVpn(Uint64 dpnId, String interfaceName, Uint32 vpnId,
1434 TypedReadWriteTransaction<Configuration> writeInvTxn, int addOrRemove, String gwMac)
1435 throws ExecutionException, InterruptedException {
1436 InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance
1437 .VpnIds> vpnIdsInstanceIdentifier = getVpnIdToVpnInstanceIdentifier(vpnId);
1438 Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance
1439 .VpnIds> vpnIdsOptional = writeInvTxn.read(vpnIdsInstanceIdentifier).get();
1440 if (vpnIdsOptional.isPresent() && vpnIdsOptional.get().isExternalVpn()) {
1441 if (gwMac == null) {
1442 LOG.error("setupGwMacIfExternalVpn: Failed to get gwMacAddress for interface {} on dpn {} vpn {}",
1443 interfaceName, dpnId.toString(), vpnIdsOptional.get().getVpnInstanceName());
1446 FlowEntity flowEntity = buildL3vpnGatewayFlow(dpnId, gwMac, vpnId,VpnConstants.INVALID_ID);
1447 if (addOrRemove == NwConstants.ADD_FLOW) {
1448 mdsalManager.addFlow(writeInvTxn, flowEntity);
1449 } else if (addOrRemove == NwConstants.DEL_FLOW) {
1450 mdsalManager.removeFlow(writeInvTxn, flowEntity);
1455 public Optional<String> getVpnSubnetGatewayIp(final Uuid subnetUuid) {
1456 Optional<String> gwIpAddress = Optional.empty();
1457 final SubnetKey subnetkey = new SubnetKey(subnetUuid);
1458 final InstanceIdentifier<Subnet> subnetidentifier = InstanceIdentifier.create(Neutron.class)
1459 .child(Subnets.class)
1460 .child(Subnet.class, subnetkey);
1461 final Optional<Subnet> subnet = read(LogicalDatastoreType.CONFIGURATION, subnetidentifier);
1462 if (subnet.isPresent()) {
1463 Class<? extends IpVersionBase> ipVersionBase = subnet.get().getIpVersion();
1464 if (IpVersionV4.class.equals(ipVersionBase)) {
1465 Subnetmap subnetmap = getSubnetmapFromItsUuid(subnetUuid);
1466 if (subnetmap != null && subnetmap.getRouterInterfaceFixedIp() != null) {
1467 LOG.trace("getVpnSubnetGatewayIp: Obtained subnetMap {} for vpn interface",
1468 subnetmap.getId().getValue());
1469 gwIpAddress = Optional.of(subnetmap.getRouterInterfaceFixedIp());
1471 //For direct L3VPN to network association (no router) continue to use subnet-gateway IP
1472 IpAddress gwIp = subnet.get().getGatewayIp();
1473 if (gwIp != null && gwIp.getIpv4Address() != null) {
1474 gwIpAddress = Optional.of(gwIp.getIpv4Address().getValue());
1477 LOG.trace("getVpnSubnetGatewayIp: Obtained subnet-gw ip {} for vpn interface",
1485 RouterToNaptSwitch getRouterToNaptSwitch(String routerName) {
1486 InstanceIdentifier<RouterToNaptSwitch> id = InstanceIdentifier.builder(NaptSwitches.class)
1487 .child(RouterToNaptSwitch.class, new RouterToNaptSwitchKey(routerName)).build();
1488 Optional<RouterToNaptSwitch> routerToNaptSwitchData = read(LogicalDatastoreType.CONFIGURATION, id);
1489 return routerToNaptSwitchData.isPresent() ? routerToNaptSwitchData.get() : null;
1492 static InstanceIdentifier<Subnetmap> buildSubnetmapIdentifier(Uuid subnetId) {
1493 return InstanceIdentifier.builder(Subnetmaps.class)
1494 .child(Subnetmap.class, new SubnetmapKey(subnetId)).build();
1499 Uint64 getPrimarySwitchForRouter(String routerName) {
1500 RouterToNaptSwitch routerToNaptSwitch = getRouterToNaptSwitch(routerName);
1501 return routerToNaptSwitch != null ? routerToNaptSwitch.getPrimarySwitchId() : null;
1504 static boolean isL3VpnOverVxLan(Uint32 l3Vni) {
1505 return l3Vni != null && l3Vni.longValue() != 0;
1509 * Retrieves the primary rd of a vpn instance
1510 * Primary rd will be the first rd in the list of rds configured for a vpn instance
1511 * If rd list is empty, primary rd will be vpn instance name
1512 * Use this function only during create operation cycles. For other operations, use getVpnRd() method.
1514 * @param vpnName Name of the VPN
1515 * @return the primary rd of the VPN
1517 public String getPrimaryRd(String vpnName) {
1518 // Retrieves the VPN Route Distinguisher by its Vpn instance name
1519 String rd = getVpnRd(vpnName);
1523 InstanceIdentifier<VpnInstance> id = getVpnInstanceIdentifier(vpnName);
1524 Optional<VpnInstance> vpnInstance = read(LogicalDatastoreType.CONFIGURATION, id);
1525 if (vpnInstance.isPresent()) {
1526 return getPrimaryRd(vpnInstance.get());
1532 * Retrieves the primary rd of a vpn instance
1533 * Primary rd will be the first rd in the list of rds configured for a vpn instance
1534 * If rd list is empty, primary rd will be vpn instance name
1535 * Use this function only during create operation cycles. For other operations, use getVpnRd() method.
1537 * @param vpnInstance Config Vpn Instance Object
1538 * @return the primary rd of the VPN
1540 static String getPrimaryRd(VpnInstance vpnInstance) {
1541 List<String> rds = null;
1542 if (vpnInstance != null) {
1543 rds = getListOfRdsFromVpnInstance(vpnInstance);
1545 return rds == null || rds.isEmpty() ? vpnInstance.getVpnInstanceName() : rds.get(0);
1548 static boolean isBgpVpn(String vpnName, String primaryRd) {
1549 return !vpnName.equals(primaryRd);
1552 java.util.Optional<String> allocateRdForExtraRouteAndUpdateUsedRdsMap(Uint32 vpnId, @Nullable Uint32 parentVpnId,
1553 String prefix, String vpnName,
1554 String nextHop, Uint64 dpnId) {
1555 //Check if rd is already allocated for this extraroute behind the same VM. If yes, reuse it.
1556 //This is particularly useful during reboot scenarios.
1557 java.util.Optional<String> allocatedRd = VpnExtraRouteHelper
1558 .getRdAllocatedForExtraRoute(dataBroker, vpnId, prefix, nextHop);
1559 if (allocatedRd.isPresent()) {
1563 //Check if rd is already allocated for this extraroute behind the same CSS. If yes, reuse it
1564 List<String> usedRds = VpnExtraRouteHelper.getUsedRds(dataBroker, vpnId, prefix);
1565 for (String usedRd : usedRds) {
1566 Optional<Routes> vpnExtraRoutes = VpnExtraRouteHelper.getVpnExtraroutes(dataBroker,
1567 vpnName, usedRd, prefix);
1568 if (vpnExtraRoutes.isPresent()) {
1569 String nextHopIp = vpnExtraRoutes.get().getNexthopIpList().get(0);
1570 // In case of VPN importing the routes, the interface is not present in the VPN
1571 // and has to be fetched from the VPN from which it imports
1572 Optional<Prefixes> prefixToInterface =
1573 getPrefixToInterface(parentVpnId != null ? parentVpnId : vpnId, nextHopIp);
1574 if (prefixToInterface.isPresent() && dpnId.equals(prefixToInterface.get().getDpnId())) {
1575 syncUpdate(LogicalDatastoreType.CONFIGURATION,
1576 VpnExtraRouteHelper.getUsedRdsIdentifier(vpnId, prefix, nextHop),
1577 getRdsBuilder(nextHop, usedRd).build());
1578 return java.util.Optional.of(usedRd);
1582 List<String> availableRds = getVpnRdsFromVpnInstanceConfig(vpnName);
1584 if (availableRds.isEmpty()) {
1585 rd = dpnId.toString();
1586 LOG.debug("Internal vpn {} Returning DpnId {} as rd", vpnName, rd);
1588 LOG.trace("Removing used rds {} from available rds {} vpnid {} . prefix is {} , vpname- {}, dpnId- {}",
1589 usedRds, availableRds, vpnId, prefix, vpnName, dpnId);
1590 if (!usedRds.isEmpty()) {
1591 availableRds.removeAll(usedRds);
1593 if (availableRds.isEmpty()) {
1594 LOG.error("No rd available from VpnInstance to allocate for prefix {}", prefix);
1595 return java.util.Optional.empty();
1597 // If rd is not allocated for this prefix or if extra route is behind different OVS, select a new rd.
1598 rd = availableRds.get(0);
1600 syncUpdate(LogicalDatastoreType.CONFIGURATION,
1601 VpnExtraRouteHelper.getUsedRdsIdentifier(vpnId, prefix, nextHop), getRdsBuilder(nextHop, rd).build());
1602 return java.util.Optional.ofNullable(rd);
1605 static String getVpnNamePrefixKey(String vpnName, String prefix) {
1606 return vpnName + VpnConstants.SEPARATOR + prefix;
1609 static InstanceIdentifier<Adjacency> getAdjacencyIdentifier(String vpnInterfaceName, String ipAddress) {
1610 return InstanceIdentifier.builder(VpnInterfaces.class)
1611 .child(VpnInterface.class, new VpnInterfaceKey(vpnInterfaceName))
1612 .augmentation(Adjacencies.class).child(Adjacency.class, new AdjacencyKey(ipAddress)).build();
1615 static InstanceIdentifier<Adjacency> getVpnInterfaceOpDataEntryAdjacencyIdentifier(String intfName,
1618 LOG.debug("getVpnInterfaceOpDataEntryAdjacencyIdentifier intfName {}, vpnName {}, ipAddress {}",
1619 intfName, vpnName, ipAddress);
1620 return InstanceIdentifier.builder(VpnInterfaceOpData.class)
1621 .child(VpnInterfaceOpDataEntry.class, new VpnInterfaceOpDataEntryKey(intfName, vpnName))
1622 .augmentation(AdjacenciesOp.class).child(Adjacency.class, new AdjacencyKey(ipAddress)).build();
1625 public static List<String> getIpsListFromExternalIps(List<ExternalIps> externalIps) {
1626 if (externalIps == null) {
1630 return externalIps.stream().map(ExternalIps::getIpAddress).collect(Collectors.toList());
1633 void bindService(final String vpnInstanceName, final String interfaceName, boolean isTunnelInterface) {
1634 jobCoordinator.enqueueJob(interfaceName,
1635 () -> Collections.singletonList(txRunner.callWithNewReadWriteTransactionAndSubmit(
1636 Datastore.CONFIGURATION, tx -> {
1637 BoundServices serviceInfo = isTunnelInterface
1638 ? VpnUtil.getBoundServicesForTunnelInterface(vpnInstanceName, interfaceName)
1639 : getBoundServicesForVpnInterface(vpnInstanceName, interfaceName);
1640 tx.mergeParentStructurePut(InterfaceUtils.buildServiceId(interfaceName,
1641 ServiceIndex.getIndex(NwConstants.L3VPN_SERVICE_NAME,
1642 NwConstants.L3VPN_SERVICE_INDEX)),
1644 })), SystemPropertyReader.getDataStoreJobCoordinatorMaxRetries());
1647 BoundServices getBoundServicesForVpnInterface(String vpnName, String interfaceName) {
1648 List<Instruction> instructions = new ArrayList<>();
1649 int instructionKey = 0;
1650 final Uint32 vpnId = getVpnId(vpnName);
1651 List<Action> actions = Collections.singletonList(
1652 new ActionRegLoad(0, VpnConstants.VPN_REG_ID, 0, VpnConstants.VPN_ID_LENGTH, vpnId.longValue())
1654 instructions.add(MDSALUtil.buildApplyActionsInstruction(actions, ++instructionKey));
1656 MDSALUtil.buildAndGetWriteMetadaInstruction(MetaDataUtil.getVpnIdMetadata(vpnId.longValue()),
1657 MetaDataUtil.METADATA_MASK_VRFID, ++instructionKey));
1658 instructions.add(MDSALUtil.buildAndGetGotoTableInstruction(NwConstants.L3_GW_MAC_TABLE,
1660 BoundServices serviceInfo = InterfaceUtils.getBoundServices(
1661 String.format("%s.%s.%s", "vpn", vpnName, interfaceName),
1662 ServiceIndex.getIndex(NwConstants.L3VPN_SERVICE_NAME, NwConstants.L3VPN_SERVICE_INDEX),
1663 VpnConstants.DEFAULT_FLOW_PRIORITY, NwConstants.COOKIE_VM_INGRESS_TABLE, instructions);
1667 static BoundServices getBoundServicesForTunnelInterface(String vpnName, String interfaceName) {
1668 int instructionKey = 0;
1669 List<Instruction> instructions = new ArrayList<>();
1670 instructions.add(MDSALUtil.buildAndGetGotoTableInstruction(
1671 NwConstants.L3VNI_EXTERNAL_TUNNEL_DEMUX_TABLE, ++instructionKey));
1672 BoundServices serviceInfo = InterfaceUtils.getBoundServices(String.format("%s.%s.%s", "vpn",
1673 vpnName, interfaceName),
1674 ServiceIndex.getIndex(NwConstants.L3VPN_SERVICE_NAME,
1675 NwConstants.L3VNI_EXTERNAL_TUNNEL_DEMUX_TABLE), VpnConstants.DEFAULT_FLOW_PRIORITY,
1676 NwConstants.COOKIE_VM_INGRESS_TABLE, instructions);
1680 void unbindService(final String vpnInterfaceName, boolean isInterfaceStateDown) {
1681 if (!isInterfaceStateDown) {
1682 jobCoordinator.enqueueJob(vpnInterfaceName,
1683 () -> Collections.singletonList(txRunner.callWithNewWriteOnlyTransactionAndSubmit(
1684 Datastore.CONFIGURATION, tx ->
1685 tx.delete(InterfaceUtils.buildServiceId(vpnInterfaceName,
1686 ServiceIndex.getIndex(NwConstants.L3VPN_SERVICE_NAME,
1687 NwConstants.L3VPN_SERVICE_INDEX))))),
1688 SystemPropertyReader.getDataStoreJobCoordinatorMaxRetries());
1692 static FlowEntity buildFlowEntity(Uint64 dpnId, short tableId, String flowId) {
1693 return new FlowEntityBuilder().setDpnId(dpnId).setTableId(tableId).setFlowId(flowId).build();
1696 static VrfEntryBase.EncapType getEncapType(boolean isVxLan) {
1697 return isVxLan ? VrfEntryBase.EncapType.Vxlan : VrfEntryBase.EncapType.Mplsgre;
1700 org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets.@Nullable Subnets
1701 getExternalSubnet(Uuid subnetId) {
1702 InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets
1703 .Subnets> subnetsIdentifier = InstanceIdentifier.builder(ExternalSubnets.class)
1704 .child(org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets
1705 .Subnets.class, new SubnetsKey(subnetId)).build();
1706 Optional<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.subnets.Subnets>
1707 optionalSubnets = read(LogicalDatastoreType.CONFIGURATION, subnetsIdentifier);
1708 return optionalSubnets.isPresent() ? optionalSubnets.get() : null;
1712 public Uuid getSubnetFromExternalRouterByIp(Uuid routerId, String ip) {
1713 Routers externalRouter = getExternalRouter(routerId.getValue());
1714 if (externalRouter != null && externalRouter.getExternalIps() != null) {
1715 for (ExternalIps externalIp : externalRouter.getExternalIps().values()) {
1716 if (Objects.equals(externalIp.getIpAddress(), ip)) {
1717 return externalIp.getSubnetId();
1724 static boolean isExternalSubnetVpn(String vpnName, String subnetId) {
1725 return vpnName.equals(subnetId);
1728 static Boolean getIsExternal(Network network) {
1729 return network.augmentation(NetworkL3Extension.class) != null
1730 && network.augmentation(NetworkL3Extension.class).isExternal();
1733 @SuppressWarnings("checkstyle:linelength")
1735 Network getNeutronNetwork(Uuid networkId) {
1736 LOG.debug("getNeutronNetwork for {}", networkId.getValue());
1737 InstanceIdentifier<Network> inst = InstanceIdentifier.create(Neutron.class).child(
1738 org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.Networks.class).child(
1739 Network.class, new NetworkKey(networkId));
1740 return read(LogicalDatastoreType.CONFIGURATION, inst).orElse(null);
1743 public static boolean isEligibleForBgp(@Nullable String rd, @Nullable String vpnName, @Nullable Uint64 dpnId,
1744 @Nullable String networkName) {
1746 if (rd.equals(vpnName)) {
1749 if (dpnId != null && rd.equals(dpnId.toString())) {
1752 if (rd.equals(networkName)) {
1760 static String getFibFlowRef(Uint64 dpnId, short tableId, String vpnName, int priority) {
1761 return VpnConstants.FLOWID_PREFIX + dpnId + NwConstants.FLOWID_SEPARATOR + tableId
1762 + NwConstants.FLOWID_SEPARATOR + vpnName + NwConstants.FLOWID_SEPARATOR + priority;
1765 void removeExternalTunnelDemuxFlows(String vpnName) {
1766 LOG.info("Removing external tunnel flows for vpn {}", vpnName);
1768 for (Uint64 dpnId: NWUtil.getOperativeDPNs(dataBroker)) {
1769 LOG.debug("Removing external tunnel flows for vpn {} from dpn {}", vpnName, dpnId);
1770 String flowRef = getFibFlowRef(dpnId, NwConstants.L3VNI_EXTERNAL_TUNNEL_DEMUX_TABLE,
1771 vpnName, VpnConstants.DEFAULT_FLOW_PRIORITY);
1772 FlowEntity flowEntity = VpnUtil.buildFlowEntity(dpnId,
1773 NwConstants.L3VNI_EXTERNAL_TUNNEL_DEMUX_TABLE, flowRef);
1774 mdsalManager.removeFlow(flowEntity);
1776 } catch (ExecutionException | InterruptedException e) {
1777 LOG.error("removeExternalTunnelDemuxFlows: Exception while removing external tunnel flows for vpn {}",
1782 public boolean isVpnPendingDelete(String rd) {
1783 VpnInstanceOpDataEntry vpnInstanceOpData = getVpnInstanceOpData(rd);
1784 boolean isVpnPendingDelete = false;
1785 if (vpnInstanceOpData == null) {
1786 LOG.error("isVpnPendingDelete: unable to read vpn instance op data for vpn with rd {}", rd);
1787 isVpnPendingDelete = true;
1789 else if (vpnInstanceOpData.getVpnState() == VpnInstanceOpDataEntry.VpnState.PendingDelete) {
1790 isVpnPendingDelete = true;
1792 return isVpnPendingDelete;
1795 @SuppressWarnings("checkstyle:IllegalCatch")
1796 public List<VpnInstanceOpDataEntry> getVpnsImportingMyRoute(final String vpnName) {
1797 List<VpnInstanceOpDataEntry> vpnsToImportRoute = new ArrayList<>();
1798 final VpnInstanceOpDataEntry vpnInstanceOpDataEntry;
1799 final String vpnRd = getVpnRd(vpnName);
1800 if (vpnRd == null) {
1801 LOG.error("getVpnsImportingMyRoute: vpn {} not present in config DS.", vpnName);
1802 return vpnsToImportRoute;
1804 if (vpnRd.equals(vpnName)) {
1805 LOG.error("getVpnsImportingMyRoute: Internal vpn {} do not export/import routes", vpnName);
1806 return vpnsToImportRoute;
1809 final VpnInstanceOpDataEntry opDataEntry = getVpnInstanceOpData(vpnRd);
1810 if (opDataEntry == null) {
1811 LOG.error("getVpnsImportingMyRoute: Could not retrieve vpn instance op data for vpn {} rd {}"
1812 + " to check for vpns importing the routes", vpnName, vpnRd);
1813 return vpnsToImportRoute;
1815 vpnInstanceOpDataEntry = opDataEntry;
1816 } catch (Exception e) {
1817 LOG.error("getVpnsImportingMyRoute: DSException when retrieving vpn instance op data for vpn {} rd {}"
1818 + " to check for vpns importing the routes", vpnName, vpnRd);
1819 return vpnsToImportRoute;
1821 Predicate<VpnInstanceOpDataEntry> excludeVpn = input -> {
1822 if (input.getVpnInstanceName() == null) {
1823 LOG.error("getVpnsImportingMyRoute.excludeVpn: Received vpn instance with rd {} without a name.",
1827 return !input.getVpnInstanceName().equals(vpnName);
1829 Predicate<VpnInstanceOpDataEntry> matchRTs = input -> {
1830 Iterable<String> commonRTs =
1831 intersection(getRts(vpnInstanceOpDataEntry, VpnTarget.VrfRTType.ExportExtcommunity),
1832 getRts(input, VpnTarget.VrfRTType.ImportExtcommunity));
1833 return Iterators.size(commonRTs.iterator()) > 0;
1835 vpnsToImportRoute = getAllVpnInstanceOpData().stream().filter(excludeVpn).filter(matchRTs)
1836 .collect(Collectors.toList());
1837 return vpnsToImportRoute;
1840 static List<String> getRts(VpnInstanceOpDataEntry vpnInstance, VpnTarget.VrfRTType rtType) {
1841 String name = vpnInstance.getVpnInstanceName();
1842 List<String> rts = new ArrayList<>();
1843 VpnTargets targets = vpnInstance.getVpnTargets();
1844 if (targets == null) {
1845 LOG.debug("getRts: vpn targets not available for {}", name);
1848 Map<VpnTargetKey, VpnTarget> keyVpnTargetMap = targets.getVpnTarget();
1849 if (keyVpnTargetMap == null) {
1850 LOG.debug("getRts: vpnTarget values not available for {}", name);
1853 for (VpnTarget target : keyVpnTargetMap.values()) {
1854 //TODO: Check for RT type is Both
1855 if (target.getVrfRTType().equals(rtType) || target.getVrfRTType().equals(VpnTarget.VrfRTType.Both)) {
1856 String rtValue = target.getVrfRTValue();
1863 static <T> Iterable<T> intersection(final Collection<T> collection1, final Collection<T> collection2) {
1864 Set<T> intersection = new HashSet<>(collection1);
1865 intersection.retainAll(collection2);
1866 return intersection;
1869 /** Get Subnetmap from its Uuid.
1870 * @param subnetUuid the subnet's Uuid
1871 * @return the Subnetmap of Uuid or null if it is not found
1874 public Subnetmap getSubnetmapFromItsUuid(Uuid subnetUuid) {
1875 InstanceIdentifier<Subnetmap> id = buildSubnetmapIdentifier(subnetUuid);
1876 return read(LogicalDatastoreType.CONFIGURATION, id).orElse(null);
1879 boolean isAdjacencyEligibleToVpnInternet(Adjacency adjacency) {
1880 // returns true if BGPVPN Internet and adjacency is IPv6, false otherwise
1881 boolean adjacencyEligible = false;
1882 IpVersionChoice ipVerChoice = getIpVersionFromString(adjacency.getIpAddress());
1883 if (ipVerChoice.isIpVersionChosen(IpVersionChoice.IPV6)) {
1884 Subnetmap sn = getSubnetmapFromItsUuid(adjacency.getSubnetId());
1885 if (sn != null && sn.getInternetVpnId() != null) {
1886 adjacencyEligible = true;
1889 return adjacencyEligible;
1892 boolean isAdjacencyEligibleToVpn(Adjacency adjacency, String vpnName) {
1893 // returns true if BGPVPN Internet and adjacency is IPv6, false otherwise
1894 boolean adjacencyEligible = true;
1895 // if BGPVPN internet, return false if subnetmap has not internetVpnId() filled in
1896 if (isBgpVpnInternet(vpnName)) {
1897 return isAdjacencyEligibleToVpnInternet(adjacency);
1899 return adjacencyEligible;
1903 String getInternetVpnFromVpnInstanceList(List<VpnInstanceNames> vpnInstanceList) {
1904 for (VpnInstanceNames vpnInstance : vpnInstanceList) {
1905 String vpnName = vpnInstance.getVpnName();
1906 if (isBgpVpnInternet(vpnName)) {
1913 /** Get boolean true if vpn is bgpvpn internet, false otherwise.
1914 * @param vpnName name of the input VPN
1915 * @return true or false
1917 boolean isBgpVpnInternet(String vpnName) {
1918 String primaryRd = getVpnRd(vpnName);
1919 if (primaryRd == null) {
1920 LOG.error("isBgpVpnInternet VPN {}."
1921 + "Primary RD not found", vpnName);
1924 InstanceIdentifier<VpnInstanceOpDataEntry> id = InstanceIdentifier.builder(VpnInstanceOpData.class)
1925 .child(VpnInstanceOpDataEntry.class, new VpnInstanceOpDataEntryKey(primaryRd)).build();
1927 Optional<VpnInstanceOpDataEntry> vpnInstanceOpDataEntryOptional = read(LogicalDatastoreType.OPERATIONAL, id);
1928 if (!vpnInstanceOpDataEntryOptional.isPresent()) {
1929 LOG.error("isBgpVpnInternet VPN {}."
1930 + "VpnInstanceOpDataEntry not found", vpnName);
1933 LOG.debug("isBgpVpnInternet VPN {}."
1934 + "Successfully VpnInstanceOpDataEntry.getBgpvpnType {}",
1935 vpnName, vpnInstanceOpDataEntryOptional.get().getBgpvpnType());
1936 if (vpnInstanceOpDataEntryOptional.get().getBgpvpnType() == VpnInstanceOpDataEntry
1937 .BgpvpnType.BGPVPNInternet) {
1943 /**Get IpVersionChoice from String IP like x.x.x.x or an representation IPv6.
1944 * @param ipAddress String of an representation IP address V4 or V6
1945 * @return the IpVersionChoice of the version or IpVersionChoice.UNDEFINED otherwise
1947 public static IpVersionChoice getIpVersionFromString(String ipAddress) {
1948 int indexIpAddress = ipAddress.indexOf('/');
1949 if (indexIpAddress >= 0) {
1950 ipAddress = ipAddress.substring(0, indexIpAddress);
1953 InetAddress address = InetAddress.getByName(ipAddress);
1954 if (address instanceof Inet4Address) {
1955 return IpVersionChoice.IPV4;
1956 } else if (address instanceof Inet6Address) {
1957 return IpVersionChoice.IPV6;
1959 } catch (UnknownHostException | SecurityException e) {
1960 return IpVersionChoice.UNDEFINED;
1962 return IpVersionChoice.UNDEFINED;
1965 ListenableFuture<Void> unsetScheduledToRemoveForVpnInterface(String interfaceName) {
1966 VpnInterfaceBuilder builder = new VpnInterfaceBuilder().withKey(new VpnInterfaceKey(interfaceName));
1967 return txRunner.callWithNewWriteOnlyTransactionAndSubmit(OPERATIONAL, tx -> tx.mergeParentStructureMerge(
1968 VpnUtil.getVpnInterfaceIdentifier(interfaceName), builder.build()));
1972 * Adds router port for all elan network of type VLAN which is a part of vpnName in the DPN with dpnId.
1973 * This will create the vlan footprint in the DPN's which are member of the VPN.
1975 * @param vpnName the vpnName
1976 * @param dpnId the DPN id
1978 void addRouterPortToElanForVlanInDpn(String vpnName, Uint64 dpnId) {
1979 Map<String,String> elanInstanceRouterPortMap = getElanInstanceRouterPortMap(vpnName);
1980 for (Entry<String, String> elanInstanceRouterEntry : elanInstanceRouterPortMap.entrySet()) {
1981 addRouterPortToElanDpn(elanInstanceRouterEntry.getKey(), elanInstanceRouterEntry.getValue(), dpnId);
1986 * Removes router port for all elan network of type VLAN which is a part of vpnName in the DPN with dpnId.
1987 * This will remove the vlan footprint in all the DPN's which are member of the VPN.
1989 * @param vpnName the vpn name
1990 * @param dpnId the DPN id
1992 void removeRouterPortFromElanForVlanInDpn(String vpnName, Uint64 dpnId) {
1993 Map<String,String> elanInstanceRouterPortMap = getElanInstanceRouterPortMap(vpnName);
1994 for (Entry<String, String> elanInstanceRouterEntry : elanInstanceRouterPortMap.entrySet()) {
1995 removeRouterPortFromElanDpn(elanInstanceRouterEntry.getKey(), elanInstanceRouterEntry.getValue(),
2001 * Adds router port for all elan network of type VLAN which is a part of vpnName in all the DPN which has a port
2002 * This will create the vlan footprint in all the DPN's which are member of the VPN.
2004 * @param vpnName the vpn name
2006 void addRouterPortToElanDpnListForVlaninAllDpn(String vpnName) {
2007 Map<String,String> elanInstanceRouterPortMap = getElanInstanceRouterPortMap(vpnName);
2008 Set<Uint64> dpnList = getDpnInElan(elanInstanceRouterPortMap);
2009 for (Uint64 dpnId : dpnList) {
2010 for (Entry<String, String> elanInstanceRouterEntry : elanInstanceRouterPortMap.entrySet()) {
2011 addRouterPortToElanDpn(elanInstanceRouterEntry.getKey(), elanInstanceRouterEntry.getValue(), dpnId);
2016 /**Removes router port for all elan network of type VLAN which is a part of vpnName in all the DPN which has a port
2017 * This will remove the vlan footprint in all the DPN's which are member of the VPN.
2019 * @param routerInterfacePortId this will add the current subnet router port id to the map for removal
2020 * @param elanInstanceName the current elanstance being removed this will be added to map for removal
2021 * @param vpnName the vpn name
2023 void removeRouterPortFromElanDpnListForVlanInAllDpn(String elanInstanceName,
2024 String routerInterfacePortId, String vpnName) {
2025 Map<String,String> elanInstanceRouterPortMap = getElanInstanceRouterPortMap(vpnName);
2026 elanInstanceRouterPortMap.put(elanInstanceName, routerInterfacePortId);
2027 Set<Uint64> dpnList = getDpnInElan(elanInstanceRouterPortMap);
2028 for (Uint64 dpnId : dpnList) {
2029 for (Entry<String, String> elanInstanceRouterEntry : elanInstanceRouterPortMap.entrySet()) {
2030 removeRouterPortFromElanDpn(elanInstanceRouterEntry.getKey(), elanInstanceRouterEntry.getValue(),
2037 Set<Uint64> getDpnInElan(Map<String,String> elanInstanceRouterPortMap) {
2038 Set<Uint64> dpnIdSet = new HashSet<>();
2039 for (String elanInstanceName : elanInstanceRouterPortMap.keySet()) {
2040 InstanceIdentifier<ElanDpnInterfacesList> elanDpnInterfaceId = getElanDpnOperationalDataPath(
2042 Optional<ElanDpnInterfacesList> dpnInElanInterfaces = read(LogicalDatastoreType.OPERATIONAL,
2043 elanDpnInterfaceId);
2044 if (dpnInElanInterfaces.isPresent()) {
2045 Map<DpnInterfacesKey, DpnInterfaces> dpnInterfacesMap
2046 = dpnInElanInterfaces.get().nonnullDpnInterfaces();
2047 for (DpnInterfaces dpnInterface : dpnInterfacesMap.values()) {
2048 dpnIdSet.add(dpnInterface.getDpId());
2055 void addRouterPortToElanDpn(String elanInstanceName, String routerInterfacePortId, Uint64 dpnId) {
2056 InstanceIdentifier<DpnInterfaces> elanDpnInterfaceId = getElanDpnInterfaceOperationalDataPath(
2057 elanInstanceName,dpnId);
2058 final ReentrantLock lock = JvmGlobalLocks.getLockForString(elanInstanceName);
2061 Optional<DpnInterfaces> dpnInElanInterfaces = read(LogicalDatastoreType.OPERATIONAL, elanDpnInterfaceId);
2062 List<String> elanInterfaceList = new ArrayList<>();
2063 DpnInterfaces dpnInterface;
2064 if (!dpnInElanInterfaces.isPresent()) {
2065 elanInterfaceList = new ArrayList<>();
2067 dpnInterface = dpnInElanInterfaces.get();
2068 elanInterfaceList = (dpnInterface.getInterfaces() != null && !dpnInterface.getInterfaces().isEmpty())
2069 ? new ArrayList<>(dpnInterface.getInterfaces()) : elanInterfaceList;
2071 if (!elanInterfaceList.contains(routerInterfacePortId)) {
2072 elanInterfaceList.add(routerInterfacePortId);
2073 dpnInterface = new DpnInterfacesBuilder().setDpId(dpnId).setInterfaces(elanInterfaceList)
2074 .withKey(new DpnInterfacesKey(dpnId)).build();
2075 syncWrite(LogicalDatastoreType.OPERATIONAL, elanDpnInterfaceId, dpnInterface);
2082 void removeRouterPortFromElanDpn(String elanInstanceName, String routerInterfacePortId,
2083 String vpnName, Uint64 dpnId) {
2084 InstanceIdentifier<DpnInterfaces> elanDpnInterfaceId = getElanDpnInterfaceOperationalDataPath(
2085 elanInstanceName,dpnId);
2086 final ReentrantLock lock = JvmGlobalLocks.getLockForString(elanInstanceName);
2089 Optional<DpnInterfaces> dpnInElanInterfaces = read(LogicalDatastoreType.OPERATIONAL, elanDpnInterfaceId);
2090 List<String> elanInterfaceList = new ArrayList<>();
2091 DpnInterfaces dpnInterface;
2092 if (!dpnInElanInterfaces.isPresent()) {
2093 LOG.info("No interface in any dpn for {}", vpnName);
2096 dpnInterface = dpnInElanInterfaces.get();
2097 elanInterfaceList = (dpnInterface.getInterfaces() != null && !dpnInterface.getInterfaces().isEmpty())
2098 ? new ArrayList<>(dpnInterface.getInterfaces()) : elanInterfaceList;
2100 if (!elanInterfaceList.contains(routerInterfacePortId)) {
2101 LOG.info("Router port not present in DPN {} for VPN {}", dpnId, vpnName);
2104 elanInterfaceList.remove(routerInterfacePortId);
2105 dpnInterface = new DpnInterfacesBuilder().setDpId(dpnId).setInterfaces(elanInterfaceList)
2106 .withKey(new DpnInterfacesKey(dpnId)).build();
2107 syncWrite(LogicalDatastoreType.OPERATIONAL, elanDpnInterfaceId, dpnInterface);
2115 ElanInterface getElanInterfaceByElanInterfaceName(String elanInterfaceName) {
2116 InstanceIdentifier<ElanInterface> elanInterfaceId = getElanInterfaceConfigurationDataPathId(elanInterfaceName);
2117 return read(LogicalDatastoreType.CONFIGURATION, elanInterfaceId).orElse(null);
2120 static InstanceIdentifier<ElanInterface> getElanInterfaceConfigurationDataPathId(String interfaceName) {
2121 return InstanceIdentifier.builder(ElanInterfaces.class)
2122 .child(ElanInterface.class, new ElanInterfaceKey(interfaceName)).build();
2126 DpnInterfaces getElanInterfaceInfoByElanDpn(String elanInstanceName, Uint64 dpId) {
2127 InstanceIdentifier<DpnInterfaces> elanDpnInterfacesId = getElanDpnInterfaceOperationalDataPath(elanInstanceName,
2129 return read(LogicalDatastoreType.OPERATIONAL, elanDpnInterfacesId).orElse(null);
2133 String getExternalElanInterface(String elanInstanceName, Uint64 dpnId) {
2134 DpnInterfaces dpnInterfaces = getElanInterfaceInfoByElanDpn(elanInstanceName, dpnId);
2135 if (dpnInterfaces == null || dpnInterfaces.getInterfaces() == null) {
2136 LOG.info("Elan {} does not have interfaces in DPN {}", elanInstanceName, dpnId);
2140 for (String dpnInterface : dpnInterfaces.getInterfaces()) {
2141 if (interfaceManager.isExternalInterface(dpnInterface)) {
2142 return dpnInterface;
2148 static boolean isVlan(ElanInstance elanInstance) {
2149 return elanInstance != null && elanInstance.getSegmentType() != null
2150 && elanInstance.getSegmentType().isAssignableFrom(SegmentTypeVlan.class)
2151 && elanInstance.getSegmentationId() != null && elanInstance.getSegmentationId().toJava() != 0;
2154 boolean isVlan(String interfaceName) {
2155 ElanInterface elanInterface = getElanInterfaceByElanInterfaceName(interfaceName);
2156 if (elanInterface == null) {
2159 ElanInstance elanInstance = getElanInstanceByName(elanInterface.getElanInstanceName());
2160 return isVlan(elanInstance);
2164 ElanInstance getElanInstanceByName(String elanInstanceName) {
2165 InstanceIdentifier<ElanInstance> elanIdentifierId =
2166 ElanHelper.getElanInstanceConfigurationDataPath(elanInstanceName);
2167 return read(LogicalDatastoreType.CONFIGURATION, elanIdentifierId).orElse(null);
2171 String getVpnNameFromElanIntanceName(String elanInstanceName) {
2172 Optional<Subnetmaps> subnetMapsData = read(LogicalDatastoreType.CONFIGURATION, buildSubnetMapsWildCardPath());
2173 if (subnetMapsData.isPresent()) {
2174 Map<SubnetmapKey, Subnetmap> keySubnetmapMap = subnetMapsData.get().getSubnetmap();
2175 if (keySubnetmapMap != null && !keySubnetmapMap.isEmpty()) {
2176 for (Subnetmap subnet : keySubnetmapMap.values()) {
2177 if (subnet.getNetworkId().getValue().equals(elanInstanceName)) {
2178 if (subnet.getVpnId() != null) {
2179 return subnet.getVpnId().getValue();
2188 Map<String, String> getElanInstanceRouterPortMap(String vpnName) {
2189 Map<String, String> elanInstanceRouterPortMap = new HashMap<>();
2190 Optional<Subnetmaps> subnetMapsData = read(LogicalDatastoreType.CONFIGURATION, buildSubnetMapsWildCardPath());
2191 if (subnetMapsData.isPresent()) {
2192 List<Subnetmap> subnetMapList = new ArrayList<>();
2193 Subnetmaps subnetMaps = subnetMapsData.get();
2194 subnetMapList = (subnetMaps.getSubnetmap() != null && !subnetMaps.getSubnetmap().isEmpty())
2195 ? new ArrayList<>(subnetMaps.getSubnetmap().values()) : subnetMapList;
2197 if (subnetMapList != null && !subnetMapList.isEmpty()) {
2198 for (Subnetmap subnet : subnetMapList) {
2199 if (subnet.getVpnId() != null && subnet.getVpnId().getValue().equals(vpnName)
2200 && NetworkType.VLAN.equals(subnet.getNetworkType())) {
2201 if (subnet.getRouterInterfacePortId() == null || subnet.getNetworkId() == null) {
2202 LOG.warn("The RouterInterfacePortId or NetworkId is null");
2205 String routerInterfacePortUuid = subnet.getRouterInterfacePortId().getValue();
2206 if (routerInterfacePortUuid != null && !routerInterfacePortUuid.isEmpty()) {
2207 elanInstanceRouterPortMap.put(subnet.getNetworkId().getValue(),routerInterfacePortUuid);
2213 return elanInstanceRouterPortMap;
2217 String getRouterPordIdFromElanInstance(String elanInstanceName) {
2218 Optional<Subnetmaps> subnetMapsData = read(LogicalDatastoreType.CONFIGURATION, buildSubnetMapsWildCardPath());
2219 if (subnetMapsData.isPresent()) {
2220 Map<SubnetmapKey, Subnetmap> keySubnetmapMap = subnetMapsData.get().getSubnetmap();
2221 if (keySubnetmapMap != null && !keySubnetmapMap.isEmpty()) {
2222 for (Subnetmap subnet : keySubnetmapMap.values()) {
2223 if (subnet.getNetworkId().getValue().equals(elanInstanceName)) {
2224 if (subnet.getRouterInterfacePortId() != null) {
2225 return subnet.getRouterInterfacePortId().getValue();
2234 boolean shouldPopulateFibForVlan(String vpnName, @Nullable String elanInstanceName, Uint64 dpnId) {
2235 Map<String,String> elanInstanceRouterPortMap = getElanInstanceRouterPortMap(vpnName);
2236 boolean shouldPopulateFibForVlan = false;
2237 if (!elanInstanceRouterPortMap.isEmpty()) {
2238 shouldPopulateFibForVlan = true;
2240 for (Entry<String, String> elanInstanceRouterEntry : elanInstanceRouterPortMap
2242 String currentElanInstance = elanInstanceRouterEntry.getKey();
2243 if (elanInstanceName != null && elanInstanceName.equals(currentElanInstance)) {
2246 String externalinterface = getExternalElanInterface(currentElanInstance ,dpnId);
2247 if (externalinterface == null) {
2248 shouldPopulateFibForVlan = false;
2252 return shouldPopulateFibForVlan;
2255 public static InstanceIdentifier<DpnInterfaces> getElanDpnInterfaceOperationalDataPath(String elanInstanceName,
2257 return InstanceIdentifier.builder(ElanDpnInterfaces.class)
2258 .child(ElanDpnInterfacesList.class, new ElanDpnInterfacesListKey(elanInstanceName))
2259 .child(DpnInterfaces.class, new DpnInterfacesKey(dpId)).build();
2262 public static InstanceIdentifier<ElanDpnInterfacesList> getElanDpnOperationalDataPath(String elanInstanceName) {
2263 return InstanceIdentifier.builder(ElanDpnInterfaces.class)
2264 .child(ElanDpnInterfacesList.class, new ElanDpnInterfacesListKey(elanInstanceName))
2268 public static boolean isMatchedPrefixToInterface(Prefixes prefix, VpnInterfaceOpDataEntry vpnInterface) {
2269 if (prefix != null && vpnInterface != null) {
2270 if (prefix.getDpnId() != null && vpnInterface.getDpnId() != null) {
2271 if (prefix.getVpnInterfaceName() != null && vpnInterface.getName() != null) {
2272 return prefix.getDpnId().equals(vpnInterface.getDpnId())
2273 && prefix.getVpnInterfaceName().equalsIgnoreCase(vpnInterface.getName());
2280 public static void sendNeighborSolicationToOfGroup(Ipv6NdUtilService ipv6NdUtilService, Ipv6Address srcIpv6Address,
2281 MacAddress srcMac, Ipv6Address dstIpv6Address, Long ofGroupId, Uint64 dpId) {
2282 SendNeighborSolicitationToOfGroupInput input = new SendNeighborSolicitationToOfGroupInputBuilder()
2283 .setSourceIpv6(srcIpv6Address).setSourceLlAddress(srcMac).setTargetIpAddress(dstIpv6Address)
2284 .setOfGroupId(ofGroupId).setDpId(dpId).build();
2286 Future<RpcResult<SendNeighborSolicitationToOfGroupOutput>> result = ipv6NdUtilService
2287 .sendNeighborSolicitationToOfGroup(input);
2288 RpcResult<SendNeighborSolicitationToOfGroupOutput> rpcResult = result.get();
2289 if (!rpcResult.isSuccessful()) {
2290 LOG.error("sendNeighborSolicitationToOfGroup: RPC Call failed for input={} and Errors={}", input,
2291 rpcResult.getErrors());
2293 } catch (InterruptedException | ExecutionException e) {
2294 LOG.error("Failed to send NS packet to ELAN group, input={}", input, e);
2298 static Set<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.vpn.instances.vpn
2299 .instance.vpntargets.VpnTarget> getRtListForVpn(DataBroker dataBroker, String vpnName) {
2300 Set<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.vpn.instances.vpn
2301 .instance.vpntargets.VpnTarget> rtList = new HashSet<>();
2303 InstanceIdentifier<VpnInstance> vpnInstanceId = InstanceIdentifier.builder(VpnInstances.class)
2304 .child(VpnInstance.class, new VpnInstanceKey(vpnName)).build();
2305 Optional<VpnInstance> vpnInstanceOptional = SingleTransactionDataBroker.syncReadOptional(dataBroker,
2306 LogicalDatastoreType.CONFIGURATION, vpnInstanceId);
2307 if (vpnInstanceOptional.isPresent()) {
2308 org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.vpn.instances
2309 .vpn.instance.VpnTargets vpnTargets = vpnInstanceOptional.get().getVpnTargets();
2310 if (vpnTargets != null && vpnTargets.getVpnTarget() != null) {
2311 rtList.addAll(vpnTargets.getVpnTarget().values());
2314 LOG.error("getRtListForVpn: Vpn Instance {} not present in config DS", vpnName);
2316 } catch (InterruptedException | ExecutionException e) {
2317 LOG.error("getRtListForVpn: Read failed for Vpn Instance {}", vpnName);
2324 removedFamily = original
2328 } else if (update < original) {
2329 removedFamily = original - update
2330 10 was there 4 removed = 6
2331 10 was there 6 removed = 4
2336 public static int getIpFamilyValueToRemove(VpnInstanceOpDataEntry original, VpnInstanceOpDataEntry update) {
2337 int originalValue = original.getIpAddressFamilyConfigured().getIntValue();
2338 int updatedValue = update.getIpAddressFamilyConfigured().getIntValue();
2340 if (originalValue == updatedValue) {
2344 if (updatedValue == 0) {
2345 removedFamily = originalValue;
2346 } else if (updatedValue < originalValue) {
2347 removedFamily = originalValue - updatedValue;
2351 return removedFamily;
2354 public static int getIpFamilyValueToAdd(VpnInstanceOpDataEntry original, VpnInstanceOpDataEntry update) {
2355 int originalValue = original.getIpAddressFamilyConfigured().getIntValue();
2356 int updatedValue = update.getIpAddressFamilyConfigured().getIntValue();
2358 if (originalValue != updatedValue) {
2359 return updatedValue;
2361 return originalValue;
2365 static InstanceIdentifier<AssociatedVpn> getAssociatedSubnetAndVpnIdentifier(String rt, RouteTarget.RtType rtType,
2366 String cidr, String vpnName) {
2367 return InstanceIdentifier.builder(SubnetsAssociatedToRouteTargets.class).child(RouteTarget.class,
2368 new RouteTargetKey(rt, rtType)).child(AssociatedSubnet.class, new AssociatedSubnetKey(cidr))
2369 .child(AssociatedVpn.class, new AssociatedVpnKey(vpnName)).build();
2372 static InstanceIdentifier<AssociatedSubnet> getAssociatedSubnetIdentifier(String rt, RouteTarget.RtType rtType,
2374 return InstanceIdentifier.builder(SubnetsAssociatedToRouteTargets.class).child(RouteTarget.class,
2375 new RouteTargetKey(rt, rtType)).child(AssociatedSubnet.class, new AssociatedSubnetKey(cidr)).build();
2378 static AssociatedVpn buildAssociatedSubnetAndVpn(String vpnName) {
2379 return new AssociatedVpnBuilder().setName(vpnName).build();
2382 static InstanceIdentifier<RouteTarget> getRouteTargetsIdentifier(String rt, RouteTarget.RtType rtType) {
2383 return InstanceIdentifier.builder(SubnetsAssociatedToRouteTargets.class)
2384 .child(RouteTarget.class, new RouteTargetKey(rt, rtType)).build();
2387 Set<RouteTarget> getRouteTargetSet(Set<org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn
2388 .rev200204.vpn.instances.vpn.instance.vpntargets.VpnTarget> vpnTargets) {
2389 Set<RouteTarget> routeTargetSet = new HashSet<>();
2390 for (org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.vpn.instances.vpn
2391 .instance.vpntargets.VpnTarget rt : vpnTargets) {
2392 String rtValue = rt.getVrfRTValue();
2393 switch (rt.getVrfRTType()) {
2394 case ImportExtcommunity: {
2395 Optional<RouteTarget> exportRouteTargetOptional = read(LogicalDatastoreType.OPERATIONAL,
2396 getRouteTargetsIdentifier(rtValue, RouteTarget.RtType.ERT));
2397 if (exportRouteTargetOptional.isPresent()) {
2398 routeTargetSet.add(exportRouteTargetOptional.get());
2402 case ExportExtcommunity: {
2403 Optional<RouteTarget> importRouteTargetOptional = read(LogicalDatastoreType.OPERATIONAL,
2404 getRouteTargetsIdentifier(rtValue, RouteTarget.RtType.IRT));
2405 if (importRouteTargetOptional.isPresent()) {
2406 routeTargetSet.add(importRouteTargetOptional.get());
2411 Optional<RouteTarget> exportRouteTargetOptional = read(LogicalDatastoreType.OPERATIONAL,
2412 getRouteTargetsIdentifier(rtValue, RouteTarget.RtType.ERT));
2413 if (exportRouteTargetOptional.isPresent()) {
2414 routeTargetSet.add(exportRouteTargetOptional.get());
2416 Optional<RouteTarget> importRouteTargetOptional = read(LogicalDatastoreType.OPERATIONAL,
2417 getRouteTargetsIdentifier(rtValue, RouteTarget.RtType.IRT));
2418 if (importRouteTargetOptional.isPresent()) {
2419 routeTargetSet.add(importRouteTargetOptional.get());
2424 LOG.error("getRouteTargetSet: Invalid rt-type {}", rt.getVrfRTType());
2427 return routeTargetSet;
2431 TODO: (vivek/kiran): Subnet overlap in a VPN detection logic should use subnet allocation pools if available
2432 rather than only CIDR.
2433 Also the Subnet overlap in a VPN detection logic to be addressed for router-based-l3vpns.
2435 static boolean areSubnetsOverlapping(String cidr1, String cidr2) {
2436 final int slash1 = cidr1.indexOf('/');
2437 final int address1 = addressForCidr(cidr1, slash1);
2438 final int cidrPart1 = maskForCidr(cidr1, slash1);
2440 final int slash2 = cidr2.indexOf('/');
2441 final int address2 = addressForCidr(cidr2, slash2);
2442 final int cidrPart2 = maskForCidr(cidr2, slash2);
2444 final int comparedValue = cidrPart1 <= cidrPart2 ? compare(address1, cidrPart1, address2)
2445 : compare(address2, cidrPart2, address1);
2446 return comparedValue == 0;
2449 private static int addressForCidr(String cidr, int slash) {
2450 return InetAddresses.coerceToInteger(InetAddresses.forString(cidr.substring(0, slash)));
2453 private static int maskForCidr(String cidr, int slash) {
2454 return Integer.parseInt(cidr.substring(slash + 1));
2457 private static int compare(int address, int cidrPart, int address2) {
2458 int prefix = address2 & computeNetmask(cidrPart);
2459 return address ^ prefix;
2462 private static int computeNetmask(int cidrPart) {
2464 for (int j = 0; j < cidrPart; ++j) {
2465 netmask |= 1 << 31 - j;
2470 public static String buildIpMonitorJobKey(String ip, String vpnName) {
2471 return VpnConstants.IP_MONITOR_JOB_PREFIX_KEY + "-" + vpnName + "-" + ip;
2474 public static List<String> getVpnListForVpnInterface(VpnInterface vpnInter) {
2475 return vpnInter.nonnullVpnInstanceNames().values().stream()
2476 .map(VpnInstanceNames::getVpnName).collect(Collectors.toList());
2479 public void updateVpnInstanceWithRdList(String vpnName, List<String> updatedRdList) {
2480 String primaryRd = getVpnRd(vpnName);
2481 if (primaryRd == null) {
2482 LOG.warn("updateVpnInstanceWithRdList: Unable to retrieve primary RD for the VPN {}. Skip to process "
2483 + "the updated RD list {} ", vpnName, updatedRdList);
2486 jobCoordinator.enqueueJob("VPN-" + vpnName, () -> {
2487 VpnInstanceOpDataEntryBuilder builder = new VpnInstanceOpDataEntryBuilder().setVrfId(primaryRd);
2488 builder.setRd(updatedRdList);
2489 return Collections.singletonList(txRunner.callWithNewWriteOnlyTransactionAndSubmit(
2490 OPERATIONAL, tx -> {
2491 InstanceIdentifier<VpnInstanceOpDataEntry> id = InstanceIdentifier
2492 .builder(VpnInstanceOpData.class).child(VpnInstanceOpDataEntry.class,
2493 new VpnInstanceOpDataEntryKey(primaryRd)).build();
2494 tx.merge(id, builder.build());
2495 LOG.debug("updateVpnInstanceWithRdList: Successfully updated the VPN {} with list of RDs {}",
2496 vpnName, updatedRdList);
2501 public static RouteOrigin getRouteOrigin(AdjacencyType adjacencyType) {
2502 RouteOrigin origin = RouteOrigin.LOCAL;
2503 switch (adjacencyType) {
2504 case PrimaryAdjacency:
2505 origin = RouteOrigin.LOCAL;
2508 origin = RouteOrigin.STATIC;
2511 origin = RouteOrigin.DYNAMIC;
2514 LOG.warn("Unknown adjacencyType={}", adjacencyType);
2519 public static boolean isDualRouterVpnUpdate(List<String> oldVpnListCopy, List<String> newVpnListCopy) {
2520 return oldVpnListCopy.size() == 2 && newVpnListCopy.size() == 3
2521 || oldVpnListCopy.size() == 3 && newVpnListCopy.size() == 2;
2524 // TODO Clean up the exception handling
2525 @SuppressWarnings("checkstyle:IllegalCatch")
2526 public void createVpnPortFixedIpToPort(String vpnName, String fixedIp,
2527 String portName, boolean isLearntIp, String macAddress,
2528 WriteTransaction writeConfigTxn) {
2529 InstanceIdentifier<VpnPortipToPort> id = buildVpnPortipToPortIdentifier(vpnName, fixedIp);
2530 VpnPortipToPortBuilder builder = new VpnPortipToPortBuilder().withKey(new VpnPortipToPortKey(fixedIp, vpnName))
2531 .setVpnName(vpnName).setPortFixedip(fixedIp).setPortName(portName)
2532 .setLearntIp(isLearntIp).setSubnetIp(false).setMacAddress(macAddress.toLowerCase(Locale.getDefault()));
2534 if (writeConfigTxn != null) {
2535 writeConfigTxn.put(LogicalDatastoreType.CONFIGURATION, id, builder.build());
2537 syncWrite(LogicalDatastoreType.CONFIGURATION, id, builder.build());
2539 LOG.trace("Port with Ip: {}, vpn {}, interface {}, learntIp {} added to VpnPortipToPort DS",
2540 fixedIp, vpnName, portName, isLearntIp);
2541 } catch (Exception e) {
2542 LOG.error("Failure while creating VpnPortIpToPort map for vpn {} learnIp{}", vpnName, fixedIp, e);
2546 protected VpnPortipToPort getVpnPortipToPort(String vpnName, String fixedIp) {
2547 InstanceIdentifier<VpnPortipToPort> id = buildVpnPortipToPortIdentifier(vpnName, fixedIp);
2548 Optional<VpnPortipToPort> vpnPortipToPortData = read(LogicalDatastoreType.CONFIGURATION, id);
2549 if (vpnPortipToPortData.isPresent()) {
2550 return vpnPortipToPortData.get();
2552 LOG.error("getVpnPortipToPort: Failed as vpnPortipToPortData DS is absent for VPN {} and fixed IP {}",
2557 public static void enableArpLearning(Boolean isArpLearningEnabled) {
2558 arpLearningEnabled = isArpLearningEnabled;
2561 public static Boolean isArpLearningEnabled() {
2562 return arpLearningEnabled;
2565 private static ReentrantLock lockFor(String vpnName, String fixedIp) {
2566 // FIXME: is there some identifier we can use? LearntVpnVipToPortKey perhaps?
2567 return JvmGlobalLocks.getLockForString(vpnName + fixedIp);